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