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