split alias support into a separate source file for better readability
[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 __LL_H
15 #define __LL_H
16
17 #include <libubox/avl.h>
18 #include <netinet/in.h>
19
20 struct device;
21 struct device_user;
22 struct device_hotplug_ops;
23
24 typedef int (*device_state_cb)(struct device *, bool up);
25
26 enum {
27         DEV_ATTR_TYPE,
28         DEV_ATTR_IFNAME,
29         DEV_ATTR_MTU,
30         DEV_ATTR_MACADDR,
31         DEV_ATTR_TXQUEUELEN,
32         DEV_ATTR_ENABLED,
33         __DEV_ATTR_MAX,
34 };
35
36 enum dev_change_type {
37         DEV_CONFIG_NO_CHANGE,
38         DEV_CONFIG_APPLIED,
39         DEV_CONFIG_RESTART,
40         DEV_CONFIG_RECREATE,
41 };
42
43 struct device_type {
44         struct list_head list;
45         const char *name;
46
47         const struct config_param_list *config_params;
48
49         struct device *(*create)(const char *name, struct blob_attr *attr);
50         void (*config_init)(struct device *);
51         enum dev_change_type (*reload)(struct device *, struct blob_attr *);
52         void (*dump_info)(struct device *, struct blob_buf *buf);
53         void (*dump_stats)(struct device *, struct blob_buf *buf);
54         int (*check_state)(struct device *);
55         void (*free)(struct device *);
56 };
57
58 enum {
59         DEV_OPT_MTU             = (1 << 0),
60         DEV_OPT_MACADDR         = (1 << 1),
61         DEV_OPT_TXQUEUELEN      = (1 << 2)
62 };
63
64 /* events broadcasted to all users of a device */
65 enum device_event {
66         DEV_EVENT_ADD,
67         DEV_EVENT_REMOVE,
68
69         DEV_EVENT_UPDATE_IFNAME,
70
71         DEV_EVENT_SETUP,
72         DEV_EVENT_TEARDOWN,
73         DEV_EVENT_UP,
74         DEV_EVENT_DOWN,
75
76         DEV_EVENT_LINK_UP,
77         DEV_EVENT_LINK_DOWN,
78 };
79
80 /*
81  * device dependency with callbacks
82  */
83 struct device_user {
84         struct list_head list;
85
86         bool claimed;
87         bool hotplug;
88
89         struct device *dev;
90         void (*cb)(struct device_user *, enum device_event);
91 };
92
93 struct device_settings {
94         unsigned int flags;
95         unsigned int mtu;
96         unsigned int txqueuelen;
97         uint8_t macaddr[6];
98 };
99
100 /* 
101  * link layer device. typically represents a linux network device.
102  * can be used to support VLANs as well
103  */
104 struct device {
105         const struct device_type *type;
106
107         struct avl_node avl;
108         struct list_head users;
109
110         char ifname[IFNAMSIZ + 1];
111         int ifindex;
112
113         struct blob_attr *config;
114         bool config_pending;
115         bool sys_present;
116         bool present;
117         int active;
118
119         bool external;
120         bool disabled;
121         bool deferred;
122         bool hidden;
123
124         bool current_config;
125         bool default_config;
126
127         /* set interface up or down */
128         device_state_cb set_state;
129
130         const struct device_hotplug_ops *hotplug_ops;
131
132         struct device_user parent;
133
134         struct device_settings orig_settings;
135         struct device_settings settings;
136 };
137
138 struct device_hotplug_ops {
139         int (*prepare)(struct device *dev);
140         int (*add)(struct device *main, struct device *member);
141         int (*del)(struct device *main, struct device *member);
142 };
143
144 extern const struct config_param_list device_attr_list;
145 extern const struct device_type simple_device_type;
146 extern const struct device_type bridge_device_type;
147 extern const struct device_type tunnel_device_type;
148
149 void device_lock(void);
150 void device_unlock(void);
151
152 struct device *device_create(const char *name, const struct device_type *type,
153                              struct blob_attr *config);
154 void device_init_settings(struct device *dev, struct blob_attr **tb);
155 void device_init_pending(void);
156
157 enum dev_change_type
158 device_set_config(struct device *dev, const struct device_type *type,
159                   struct blob_attr *attr);
160
161 void device_reset_config(void);
162 void device_reset_old(void);
163
164 void device_init_virtual(struct device *dev, const struct device_type *type, const char *name);
165 int device_init(struct device *iface, const struct device_type *type, const char *ifname);
166 void device_cleanup(struct device *iface);
167 struct device *device_get(const char *name, int create);
168 void device_add_user(struct device_user *dep, struct device *iface);
169 void device_remove_user(struct device_user *dep);
170 void device_broadcast_event(struct device *dev, enum device_event ev);
171
172 void device_set_present(struct device *dev, bool state);
173 void device_refresh_present(struct device *dev);
174 int device_claim(struct device_user *dep);
175 void device_release(struct device_user *dep);
176 int device_check_state(struct device *dev);
177 void device_dump_status(struct blob_buf *b, struct device *dev);
178
179 void device_free(struct device *dev);
180 void device_free_unused(struct device *dev);
181
182 struct device *get_vlan_device_chain(const char *ifname, bool create);
183 void alias_notify_device(const char *name, struct device *dev);
184 struct device *device_alias_get(const char *name);
185
186 static inline void
187 device_set_deferred(struct device *dev, bool value)
188 {
189         dev->deferred = value;
190         device_refresh_present(dev);
191 }
192
193 static inline void
194 device_set_disabled(struct device *dev, bool value)
195 {
196         dev->disabled = value;
197         device_refresh_present(dev);
198 }
199
200 #endif