device: add device handler list
[project/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 __NETIFD_DEVICE_H
15 #define __NETIFD_DEVICE_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_type;
23 struct device_user;
24 struct device_hotplug_ops;
25 struct interface;
26
27 typedef int (*device_state_cb)(struct device *, bool up);
28
29 enum {
30 DEV_ATTR_TYPE,
31 DEV_ATTR_MTU,
32 DEV_ATTR_MTU6,
33 DEV_ATTR_MACADDR,
34 DEV_ATTR_TXQUEUELEN,
35 DEV_ATTR_ENABLED,
36 DEV_ATTR_IPV6,
37 DEV_ATTR_PROMISC,
38 DEV_ATTR_RPFILTER,
39 DEV_ATTR_ACCEPTLOCAL,
40 DEV_ATTR_IGMPVERSION,
41 DEV_ATTR_MLDVERSION,
42 DEV_ATTR_NEIGHREACHABLETIME,
43 DEV_ATTR_RPS,
44 DEV_ATTR_XPS,
45 DEV_ATTR_DADTRANSMITS,
46 DEV_ATTR_MULTICAST_TO_UNICAST,
47 DEV_ATTR_MULTICAST_ROUTER,
48 DEV_ATTR_MULTICAST,
49 DEV_ATTR_LEARNING,
50 DEV_ATTR_UNICAST_FLOOD,
51 DEV_ATTR_NEIGHGCSTALETIME,
52 __DEV_ATTR_MAX,
53 };
54
55 enum dev_change_type {
56 DEV_CONFIG_NO_CHANGE,
57 DEV_CONFIG_APPLIED,
58 DEV_CONFIG_RESTART,
59 DEV_CONFIG_RECREATE,
60 };
61
62 struct device_type {
63 struct list_head list;
64 const char *name;
65
66 bool bridge_capability;
67 const char *name_prefix;
68
69 const struct uci_blob_param_list *config_params;
70
71 struct device *(*create)(const char *name, struct device_type *devtype,
72 struct blob_attr *attr);
73 void (*config_init)(struct device *);
74 enum dev_change_type (*reload)(struct device *, struct blob_attr *);
75 void (*dump_info)(struct device *, struct blob_buf *buf);
76 void (*dump_stats)(struct device *, struct blob_buf *buf);
77 int (*check_state)(struct device *);
78 void (*free)(struct device *);
79 };
80
81 enum {
82 DEV_OPT_MTU = (1 << 0),
83 DEV_OPT_MACADDR = (1 << 1),
84 DEV_OPT_TXQUEUELEN = (1 << 2),
85 DEV_OPT_IPV6 = (1 << 3),
86 DEV_OPT_PROMISC = (1 << 4),
87 DEV_OPT_RPFILTER = (1 << 5),
88 DEV_OPT_ACCEPTLOCAL = (1 << 6),
89 DEV_OPT_IGMPVERSION = (1 << 7),
90 DEV_OPT_MLDVERSION = (1 << 8),
91 DEV_OPT_NEIGHREACHABLETIME = (1 << 9),
92 DEV_OPT_RPS = (1 << 10),
93 DEV_OPT_XPS = (1 << 11),
94 DEV_OPT_MTU6 = (1 << 12),
95 DEV_OPT_DADTRANSMITS = (1 << 13),
96 DEV_OPT_MULTICAST_TO_UNICAST = (1 << 14),
97 DEV_OPT_MULTICAST_ROUTER = (1 << 15),
98 DEV_OPT_MULTICAST = (1 << 16),
99 DEV_OPT_LEARNING = (1 << 17),
100 DEV_OPT_UNICAST_FLOOD = (1 << 18),
101 DEV_OPT_NEIGHGCSTALETIME = (1 << 19),
102 };
103
104 /* events broadcasted to all users of a device */
105 enum device_event {
106 DEV_EVENT_ADD,
107 DEV_EVENT_REMOVE,
108
109 DEV_EVENT_UPDATE_IFNAME,
110 DEV_EVENT_UPDATE_IFINDEX,
111
112 DEV_EVENT_SETUP,
113 DEV_EVENT_TEARDOWN,
114 DEV_EVENT_UP,
115 DEV_EVENT_DOWN,
116
117 DEV_EVENT_LINK_UP,
118 DEV_EVENT_LINK_DOWN,
119
120 /* Topology changed (i.e. bridge member added) */
121 DEV_EVENT_TOPO_CHANGE,
122
123 __DEV_EVENT_MAX
124 };
125
126 /*
127 * device dependency with callbacks
128 */
129 struct device_user {
130 struct safe_list list;
131
132 bool claimed;
133 bool hotplug;
134 bool alias;
135
136 uint8_t ev_idx[__DEV_EVENT_MAX];
137
138 struct device *dev;
139 void (*cb)(struct device_user *, enum device_event);
140 };
141
142 struct device_settings {
143 unsigned int flags;
144 unsigned int valid_flags;
145 unsigned int mtu;
146 unsigned int mtu6;
147 unsigned int txqueuelen;
148 uint8_t macaddr[6];
149 bool ipv6;
150 bool promisc;
151 unsigned int rpfilter;
152 bool acceptlocal;
153 unsigned int igmpversion;
154 unsigned int mldversion;
155 unsigned int neigh4reachabletime;
156 unsigned int neigh6reachabletime;
157 unsigned int neigh4gcstaletime;
158 unsigned int neigh6gcstaletime;
159 bool rps;
160 bool xps;
161 unsigned int dadtransmits;
162 bool multicast_to_unicast;
163 unsigned int multicast_router;
164 bool multicast;
165 bool learning;
166 bool unicast_flood;
167 };
168
169 /*
170 * link layer device. typically represents a linux network device.
171 * can be used to support VLANs as well
172 */
173 struct device {
174 struct device_type *type;
175
176 struct avl_node avl;
177 struct safe_list users;
178 struct safe_list aliases;
179
180 char ifname[IFNAMSIZ + 1];
181 int ifindex;
182
183 struct blob_attr *config;
184 bool config_pending;
185 bool sys_present;
186 /* DEV_EVENT_ADD */
187 bool present;
188 /* DEV_EVENT_UP */
189 int active;
190 /* DEV_EVENT_LINK_UP */
191 bool link_active;
192
193 bool external;
194 bool disabled;
195 bool deferred;
196 bool hidden;
197
198 bool current_config;
199 bool iface_config;
200 bool default_config;
201 bool wireless;
202 bool wireless_ap;
203 bool wireless_isolate;
204
205 struct interface *config_iface;
206
207 /* set interface up or down */
208 device_state_cb set_state;
209
210 const struct device_hotplug_ops *hotplug_ops;
211
212 struct device_user parent;
213
214 struct device_settings orig_settings;
215 struct device_settings settings;
216 };
217
218 struct device_hotplug_ops {
219 int (*prepare)(struct device *dev);
220 int (*add)(struct device *main, struct device *member);
221 int (*del)(struct device *main, struct device *member);
222 };
223
224 extern const struct uci_blob_param_list device_attr_list;
225 extern struct device_type simple_device_type;
226 extern struct device_type bridge_device_type;
227 extern struct device_type tunnel_device_type;
228 extern struct device_type macvlan_device_type;
229 extern struct device_type vlandev_device_type;
230
231 void device_lock(void);
232 void device_unlock(void);
233
234 int device_type_add(struct device_type *devtype);
235 struct device_type *device_type_get(const char *tname);
236 struct device *device_create(const char *name, struct device_type *type,
237 struct blob_attr *config);
238 void device_init_settings(struct device *dev, struct blob_attr **tb);
239 void device_init_pending(void);
240
241 enum dev_change_type
242 device_apply_config(struct device *dev, struct device_type *type,
243 struct blob_attr *config);
244
245 void device_reset_config(void);
246 void device_reset_old(void);
247 void device_set_default_ps(bool state);
248
249 void device_init_virtual(struct device *dev, struct device_type *type, const char *name);
250 int device_init(struct device *iface, struct device_type *type, const char *ifname);
251 void device_cleanup(struct device *dev);
252 struct device *device_find(const char *name);
253 struct device *device_get(const char *name, int create);
254 void device_add_user(struct device_user *dep, struct device *iface);
255 void device_remove_user(struct device_user *dep);
256 void device_broadcast_event(struct device *dev, enum device_event ev);
257
258 void device_set_present(struct device *dev, bool state);
259 void device_set_link(struct device *dev, bool state);
260 void device_set_ifindex(struct device *dev, int ifindex);
261 int device_set_ifname(struct device *dev, const char *name);
262 void device_refresh_present(struct device *dev);
263 int device_claim(struct device_user *dep);
264 void device_release(struct device_user *dep);
265 int device_check_state(struct device *dev);
266 void device_dump_status(struct blob_buf *b, struct device *dev);
267
268 void device_free(struct device *dev);
269 void device_free_unused(struct device *dev);
270
271 struct device *get_vlan_device_chain(const char *ifname, bool create);
272 void alias_notify_device(const char *name, struct device *dev);
273 struct device *device_alias_get(const char *name);
274
275 static inline void
276 device_set_deferred(struct device *dev, bool value)
277 {
278 dev->deferred = value;
279 device_refresh_present(dev);
280 }
281
282 static inline void
283 device_set_disabled(struct device *dev, bool value)
284 {
285 dev->disabled = value;
286 device_refresh_present(dev);
287 }
288
289 #endif