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