netifd: GRE tunnel support
[oweals/netifd.git] / interface.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_INTERFACE_H
15 #define __NETIFD_INTERFACE_H
16
17 #include "device.h"
18 #include "config.h"
19
20 struct interface;
21 struct interface_proto_state;
22
23 enum interface_event {
24         IFEV_DOWN,
25         IFEV_UP,
26         IFEV_UPDATE,
27         IFEV_FREE,
28         IFEV_RELOAD,
29 };
30
31 enum interface_state {
32         IFS_SETUP,
33         IFS_UP,
34         IFS_TEARDOWN,
35         IFS_DOWN,
36 };
37
38 enum interface_config_state {
39         IFC_NORMAL,
40         IFC_RELOAD,
41         IFC_REMOVE
42 };
43
44 enum interface_update_flags {
45         IUF_ADDRESS     = (1 << 0),
46         IUF_ROUTE       = (1 << 1),
47         IUF_PREFIX      = (1 << 2),
48         IUF_DATA        = (1 << 3),
49 };
50
51 struct interface_error {
52         struct list_head list;
53
54         const char *subsystem;
55         const char *code;
56         const char *data[];
57 };
58
59 struct interface_user {
60         struct list_head list;
61         struct interface *iface;
62         void (*cb)(struct interface_user *dep, struct interface *iface, enum interface_event ev);
63 };
64
65 struct interface_ip_settings {
66         struct interface *iface;
67         bool enabled;
68         bool no_defaultroute;
69         bool no_dns;
70         bool no_delegation;
71
72         struct vlist_tree addr;
73         struct vlist_tree route;
74         struct vlist_tree prefix;
75
76         struct vlist_simple_tree dns_servers;
77         struct vlist_simple_tree dns_search;
78 };
79
80 struct interface_data {
81         struct avl_node node;
82         struct blob_attr data[];
83 };
84
85 struct interface_assignment_class {
86         struct list_head head;
87         char name[];
88 };
89
90 /*
91  * interface configuration
92  */
93 struct interface {
94         struct vlist_node node;
95         struct list_head hotplug_list;
96         enum interface_event hotplug_ev;
97
98         const char *name;
99         const char *ifname;
100
101         bool available;
102         bool autostart;
103         bool config_autostart;
104         bool device_config;
105         bool enabled;
106         bool link_state;
107         bool force_link;
108         bool dynamic;
109
110         time_t start_time;
111         enum interface_state state;
112         enum interface_config_state config_state;
113         enum interface_update_flags updated;
114
115         struct list_head users;
116
117         const char *parent_ifname;
118         struct interface_user parent_iface;
119
120         /* main interface that the interface is bound to */
121         struct device_user main_dev;
122         struct device_user ext_dev;
123
124         /* interface that layer 3 communication will go through */
125         struct device_user l3_dev;
126
127         struct blob_attr *config;
128
129         /* primary protocol state */
130         const struct proto_handler *proto_handler;
131         struct interface_proto_state *proto;
132
133         struct interface_ip_settings proto_ip;
134         struct interface_ip_settings config_ip;
135         struct vlist_tree host_routes;
136
137         int metric;
138         unsigned int ip4table;
139         unsigned int ip6table;
140
141         /* IPv6 assignment parameters */
142         uint8_t assignment_length;
143         int32_t assignment_hint;
144         struct list_head assignment_classes;
145
146         /* errors/warnings while trying to bring up the interface */
147         struct list_head errors;
148
149         /* extra data provided by protocol handlers or modules */
150         struct avl_tree data;
151
152         struct uloop_timeout remove_timer;
153         struct ubus_object ubus;
154 };
155
156
157 extern struct vlist_tree interfaces;
158 extern const struct uci_blob_param_list interface_attr_list;
159
160 struct interface *interface_alloc(const char *name, struct blob_attr *config);
161
162 void interface_set_dynamic(struct interface *iface);
163
164 void interface_add(struct interface *iface, struct blob_attr *config);
165 bool interface_add_alias(struct interface *iface, struct blob_attr *config);
166
167 void interface_set_proto_state(struct interface *iface, struct interface_proto_state *state);
168
169 void interface_set_available(struct interface *iface, bool new_state);
170 int interface_set_up(struct interface *iface);
171 int interface_set_down(struct interface *iface);
172 void __interface_set_down(struct interface *iface, bool force);
173
174 void interface_set_main_dev(struct interface *iface, struct device *dev);
175 void interface_set_l3_dev(struct interface *iface, struct device *dev);
176
177 void interface_add_user(struct interface_user *dep, struct interface *iface);
178 void interface_remove_user(struct interface_user *dep);
179
180 int interface_remove_link(struct interface *iface, struct device *dev);
181 int interface_handle_link(struct interface *iface, const char *name, bool add, bool link_ext);
182
183 void interface_add_error(struct interface *iface, const char *subsystem,
184                          const char *code, const char **data, int n_data);
185
186 int interface_add_data(struct interface *iface, const struct blob_attr *data);
187
188 void interface_update_start(struct interface *iface);
189 void interface_update_complete(struct interface *iface);
190
191 void interface_start_pending(void);
192
193 #endif