netifd: GRE tunnel support
[oweals/netifd.git] / device.h
1 /*
2  * netifd - network interface daemon
3  * Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2
7  * as published by the Free Software Foundation
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  */
14 #ifndef __LL_H
15 #define __LL_H
16
17 #include <libubox/avl.h>
18 #include <libubox/safe_list.h>
19 #include <netinet/in.h>
20
21 struct device;
22 struct device_user;
23 struct device_hotplug_ops;
24
25 typedef int (*device_state_cb)(struct device *, bool up);
26
27 enum {
28         DEV_ATTR_TYPE,
29         DEV_ATTR_IFNAME,
30         DEV_ATTR_MTU,
31         DEV_ATTR_MACADDR,
32         DEV_ATTR_TXQUEUELEN,
33         DEV_ATTR_ENABLED,
34         DEV_ATTR_IPV6,
35         __DEV_ATTR_MAX,
36 };
37
38 enum dev_change_type {
39         DEV_CONFIG_NO_CHANGE,
40         DEV_CONFIG_APPLIED,
41         DEV_CONFIG_RESTART,
42         DEV_CONFIG_RECREATE,
43 };
44
45 struct device_type {
46         struct list_head list;
47         const char *name;
48
49         const struct uci_blob_param_list *config_params;
50
51         struct device *(*create)(const char *name, struct blob_attr *attr);
52         void (*config_init)(struct device *);
53         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
54         void (*dump_info)(struct device *, struct blob_buf *buf);
55         void (*dump_stats)(struct device *, struct blob_buf *buf);
56         int (*check_state)(struct device *);
57         void (*free)(struct device *);
58 };
59
60 enum {
61         DEV_OPT_MTU             = (1 << 0),
62         DEV_OPT_MACADDR         = (1 << 1),
63         DEV_OPT_TXQUEUELEN      = (1 << 2),
64         DEV_OPT_IPV6            = (1 << 3),
65 };
66
67 /* events broadcasted to all users of a device */
68 enum device_event {
69         DEV_EVENT_ADD,
70         DEV_EVENT_REMOVE,
71
72         DEV_EVENT_UPDATE_IFNAME,
73         DEV_EVENT_UPDATE_IFINDEX,
74
75         DEV_EVENT_SETUP,
76         DEV_EVENT_TEARDOWN,
77         DEV_EVENT_UP,
78         DEV_EVENT_DOWN,
79
80         DEV_EVENT_LINK_UP,
81         DEV_EVENT_LINK_DOWN,
82
83         /* Topology changed (i.e. bridge member added) */
84         DEV_EVENT_TOPO_CHANGE,
85
86         __DEV_EVENT_MAX
87 };
88
89 /*
90  * device dependency with callbacks
91  */
92 struct device_user {
93         struct safe_list list;
94
95         bool claimed;
96         bool hotplug;
97         bool alias;
98
99         uint8_t ev_idx[__DEV_EVENT_MAX];
100
101         struct device *dev;
102         void (*cb)(struct device_user *, enum device_event);
103 };
104
105 struct device_settings {
106         unsigned int flags;
107         unsigned int mtu;
108         unsigned int txqueuelen;
109         uint8_t macaddr[6];
110         bool ipv6;
111 };
112
113 /*
114  * link layer device. typically represents a linux network device.
115  * can be used to support VLANs as well
116  */
117 struct device {
118         const struct device_type *type;
119
120         struct avl_node avl;
121         struct safe_list users;
122         struct safe_list aliases;
123
124         char ifname[IFNAMSIZ + 1];
125         int ifindex;
126
127         struct blob_attr *config;
128         bool config_pending;
129         bool sys_present;
130         bool present;
131         int active;
132         bool link_active;
133
134         bool external;
135         bool disabled;
136         bool deferred;
137         bool hidden;
138
139         bool current_config;
140         bool default_config;
141         bool wireless;
142
143         /* set interface up or down */
144         device_state_cb set_state;
145
146         const struct device_hotplug_ops *hotplug_ops;
147
148         struct device_user parent;
149
150         struct device_settings orig_settings;
151         struct device_settings settings;
152 };
153
154 struct device_hotplug_ops {
155         int (*prepare)(struct device *dev);
156         int (*add)(struct device *main, struct device *member);
157         int (*del)(struct device *main, struct device *member);
158 };
159
160 extern const struct uci_blob_param_list device_attr_list;
161 extern const struct device_type simple_device_type;
162 extern const struct device_type bridge_device_type;
163 extern const struct device_type tunnel_device_type;
164 extern const struct device_type macvlan_device_type;
165 extern const struct device_type vlandev_device_type;
166
167 void device_lock(void);
168 void device_unlock(void);
169
170 struct device *device_create(const char *name, const struct device_type *type,
171                              struct blob_attr *config);
172 void device_init_settings(struct device *dev, struct blob_attr **tb);
173 void device_init_pending(void);
174
175 enum dev_change_type
176 device_set_config(struct device *dev, const struct device_type *type,
177                   struct blob_attr *attr);
178
179 void device_reset_config(void);
180 void device_reset_old(void);
181
182 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name);
183 int device_init(struct device *iface, const struct device_type *type, const char *ifname);
184 void device_cleanup(struct device *iface);
185 struct device *device_get(const char *name, int create);
186 void device_add_user(struct device_user *dep, struct device *iface);
187 void device_remove_user(struct device_user *dep);
188 void device_broadcast_event(struct device *dev, enum device_event ev);
189
190 void device_set_present(struct device *dev, bool state);
191 void device_set_link(struct device *dev, bool state);
192 void device_set_ifindex(struct device *dev, int ifindex);
193 void device_refresh_present(struct device *dev);
194 int device_claim(struct device_user *dep);
195 void device_release(struct device_user *dep);
196 int device_check_state(struct device *dev);
197 void device_dump_status(struct blob_buf *b, struct device *dev);
198
199 void device_free(struct device *dev);
200 void device_free_unused(struct device *dev);
201
202 struct device *get_vlan_device_chain(const char *ifname, bool create);
203 void alias_notify_device(const char *name, struct device *dev);
204 struct device *device_alias_get(const char *name);
205
206 static inline void
207 device_set_deferred(struct device *dev, bool value)
208 {
209         dev->deferred = value;
210         device_refresh_present(dev);
211 }
212
213 static inline void
214 device_set_disabled(struct device *dev, bool value)
215 {
216         dev->disabled = value;
217         device_refresh_present(dev);
218 }
219
220 #endif