chiark / gitweb /
networkd: introduce refcounting for Links and NetDevs
[elogind.git] / src / network / networkd.h
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 /***
4   This file is part of systemd.
5
6   Copyright 2013 Tom Gundersen <teg@jklm.no>
7
8   systemd is free software; you can redistribute it and/or modify it
9   under the terms of the GNU Lesser General Public License as published by
10   the Free Software Foundation; either version 2.1 of the License, or
11   (at your option) any later version.
12
13   systemd is distributed in the hope that it will be useful, but
14   WITHOUT ANY WARRANTY; without even the implied warranty of
15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16   Lesser General Public License for more details.
17
18   You should have received a copy of the GNU Lesser General Public License
19   along with systemd; If not, see <http://www.gnu.org/licenses/>.
20 ***/
21
22 #pragma once
23
24 #include <arpa/inet.h>
25
26 #include "sd-event.h"
27 #include "sd-rtnl.h"
28 #include "sd-bus.h"
29 #include "sd-dhcp-client.h"
30 #include "sd-ipv4ll.h"
31 #include "udev.h"
32
33 #include "rtnl-util.h"
34 #include "hashmap.h"
35 #include "list.h"
36 #include "set.h"
37 #include "condition-util.h"
38
39 #define CACHE_INFO_INFINITY_LIFE_TIME 0xFFFFFFFFU
40
41 typedef struct NetDev NetDev;
42 typedef struct Network Network;
43 typedef struct Link Link;
44 typedef struct Address Address;
45 typedef struct Route Route;
46 typedef struct Manager Manager;
47
48 typedef struct netdev_enslave_callback netdev_enslave_callback;
49
50 struct netdev_enslave_callback {
51         sd_rtnl_message_handler_t callback;
52         Link *link;
53
54         LIST_FIELDS(netdev_enslave_callback, callbacks);
55 };
56
57 typedef enum MacVlanMode {
58         NETDEV_MACVLAN_MODE_PRIVATE = MACVLAN_MODE_PRIVATE,
59         NETDEV_MACVLAN_MODE_VEPA = MACVLAN_MODE_VEPA,
60         NETDEV_MACVLAN_MODE_BRIDGE = MACVLAN_MODE_BRIDGE,
61         NETDEV_MACVLAN_MODE_PASSTHRU = MACVLAN_MODE_PASSTHRU,
62         _NETDEV_MACVLAN_MODE_MAX,
63         _NETDEV_MACVLAN_MODE_INVALID = -1
64 } MacVlanMode;
65
66 typedef enum NetDevKind {
67         NETDEV_KIND_BRIDGE,
68         NETDEV_KIND_BOND,
69         NETDEV_KIND_VLAN,
70         NETDEV_KIND_MACVLAN,
71         _NETDEV_KIND_MAX,
72         _NETDEV_KIND_INVALID = -1
73 } NetDevKind;
74
75 typedef enum NetDevState {
76         NETDEV_STATE_FAILED,
77         NETDEV_STATE_CREATING,
78         NETDEV_STATE_READY,
79         _NETDEV_STATE_MAX,
80         _NETDEV_STATE_INVALID = -1,
81 } NetDevState;
82
83 struct NetDev {
84         Manager *manager;
85
86         int n_ref;
87
88         char *filename;
89
90         Condition *match_host;
91         Condition *match_virt;
92         Condition *match_kernel;
93         Condition *match_arch;
94
95         char *description;
96         char *name;
97         NetDevKind kind;
98
99         uint64_t vlanid;
100         int32_t macvlan_mode;
101
102         int ifindex;
103         NetDevState state;
104
105         LIST_HEAD(netdev_enslave_callback, callbacks);
106 };
107
108 struct Network {
109         Manager *manager;
110
111         char *filename;
112
113         struct ether_addr *match_mac;
114         char *match_path;
115         char *match_driver;
116         char *match_type;
117         char *match_name;
118         Condition *match_host;
119         Condition *match_virt;
120         Condition *match_kernel;
121         Condition *match_arch;
122
123         char *description;
124         NetDev *bridge;
125         NetDev *bond;
126         Hashmap *vlans;
127         Hashmap *macvlans;
128         bool dhcp;
129         bool dhcp_dns;
130         bool dhcp_mtu;
131         bool dhcp_hostname;
132         bool dhcp_domainname;
133         bool dhcp_critical;
134         bool ipv4ll;
135
136         LIST_HEAD(Address, static_addresses);
137         LIST_HEAD(Route, static_routes);
138
139         Hashmap *addresses_by_section;
140         Hashmap *routes_by_section;
141
142         Set *dns;
143
144         LIST_FIELDS(Network, networks);
145 };
146
147 struct Address {
148         Network *network;
149         uint64_t section;
150
151         unsigned char family;
152         unsigned char prefixlen;
153         unsigned char scope;
154         char *label;
155
156         struct in_addr broadcast;
157         struct ifa_cacheinfo cinfo;
158
159         union {
160                 struct in_addr in;
161                 struct in6_addr in6;
162         } in_addr;
163
164         LIST_FIELDS(Address, static_addresses);
165 };
166
167 struct Route {
168         Network *network;
169         uint64_t section;
170
171         unsigned char family;
172         unsigned char dst_prefixlen;
173         unsigned char scope;
174         uint32_t metrics;
175
176         union {
177                 struct in_addr in;
178                 struct in6_addr in6;
179         } in_addr;
180
181         union {
182                 struct in_addr in;
183                 struct in6_addr in6;
184         } dst_addr;
185
186         LIST_FIELDS(Route, static_routes);
187 };
188
189 typedef enum LinkState {
190         LINK_STATE_INITIALIZING,
191         LINK_STATE_ENSLAVING,
192         LINK_STATE_SETTING_ADDRESSES,
193         LINK_STATE_SETTING_ROUTES,
194         LINK_STATE_CONFIGURED,
195         LINK_STATE_UNMANAGED,
196         LINK_STATE_FAILED,
197         _LINK_STATE_MAX,
198         _LINK_STATE_INVALID = -1
199 } LinkState;
200
201 struct Link {
202         Manager *manager;
203
204         int n_ref;
205
206         uint64_t ifindex;
207         char *ifname;
208         char *state_file;
209         struct ether_addr mac;
210         struct udev_device *udev_device;
211
212         unsigned flags;
213         uint8_t operstate;
214
215         Network *network;
216
217         LinkState state;
218
219         unsigned addr_messages;
220         unsigned route_messages;
221         unsigned enslaving;
222
223         sd_dhcp_client *dhcp_client;
224         sd_dhcp_lease *dhcp_lease;
225         char *lease_file;
226         uint16_t original_mtu;
227         sd_ipv4ll *ipv4ll;
228 };
229
230 struct Manager {
231         sd_rtnl *rtnl;
232         sd_event *event;
233         sd_bus *bus;
234         struct udev *udev;
235         struct udev_monitor *udev_monitor;
236         sd_event_source *udev_event_source;
237         sd_event_source *sigterm_event_source;
238         sd_event_source *sigint_event_source;
239
240         char *state_file;
241
242         Hashmap *links;
243         Hashmap *netdevs;
244         LIST_HEAD(Network, networks);
245
246         usec_t network_dirs_ts_usec;
247 };
248
249 extern const char* const network_dirs[];
250
251 /* Manager */
252
253 int manager_new(Manager **ret);
254 void manager_free(Manager *m);
255
256 int manager_load_config(Manager *m);
257 bool manager_should_reload(Manager *m);
258
259 int manager_rtnl_enumerate_links(Manager *m);
260
261 int manager_rtnl_listen(Manager *m);
262 int manager_udev_listen(Manager *m);
263 int manager_bus_listen(Manager *m);
264
265 int manager_update_resolv_conf(Manager *m);
266 int manager_save(Manager *m);
267
268 DEFINE_TRIVIAL_CLEANUP_FUNC(Manager*, manager_free);
269 #define _cleanup_manager_free_ _cleanup_(manager_freep)
270
271 /* NetDev */
272
273 int netdev_load(Manager *manager);
274
275 NetDev *netdev_unref(NetDev *netdev);
276 NetDev *netdev_ref(NetDev *netdev);
277
278 DEFINE_TRIVIAL_CLEANUP_FUNC(NetDev*, netdev_unref);
279 #define _cleanup_netdev_unref_ _cleanup_(netdev_unrefp)
280
281 int netdev_get(Manager *manager, const char *name, NetDev **ret);
282 int netdev_set_ifindex(NetDev *netdev, sd_rtnl_message *newlink);
283 int netdev_enslave(NetDev *netdev, Link *link, sd_rtnl_message_handler_t cb);
284
285 const char *netdev_kind_to_string(NetDevKind d) _const_;
286 NetDevKind netdev_kind_from_string(const char *d) _pure_;
287
288 const char *macvlan_mode_to_string(MacVlanMode d) _const_;
289 MacVlanMode macvlan_mode_from_string(const char *d) _pure_;
290
291 int config_parse_netdev_kind(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
292
293 int config_parse_macvlan_mode(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
294
295 /* gperf */
296 const struct ConfigPerfItem* network_netdev_gperf_lookup(const char *key, unsigned length);
297
298 /* Network */
299
300 int network_load(Manager *manager);
301
302 void network_free(Network *network);
303
304 DEFINE_TRIVIAL_CLEANUP_FUNC(Network*, network_free);
305 #define _cleanup_network_free_ _cleanup_(network_freep)
306
307 int network_get(Manager *manager, struct udev_device *device,
308                 const char *ifname, const struct ether_addr *mac,
309                 Network **ret);
310 int network_apply(Manager *manager, Network *network, Link *link);
311
312 int config_parse_bridge(const char *unit, const char *filename, unsigned line,
313                         const char *section, unsigned section_line, const char *lvalue,
314                         int ltype, const char *rvalue, void *data, void *userdata);
315
316 int config_parse_bond(const char *unit, const char *filename, unsigned line,
317                       const char *section, unsigned section_line, const char *lvalue,
318                       int ltype, const char *rvalue, void *data, void *userdata);
319
320 int config_parse_vlan(const char *unit, const char *filename, unsigned line,
321                       const char *section, unsigned section_line, const char *lvalue,
322                       int ltype, const char *rvalue, void *data, void *userdata);
323
324 int config_parse_macvlan(const char *unit, const char *filename, unsigned line,
325                          const char *section, unsigned section_line, const char *lvalue,
326                          int ltype, const char *rvalue, void *data, void *userdata);
327
328 /* gperf */
329 const struct ConfigPerfItem* network_network_gperf_lookup(const char *key, unsigned length);
330
331 /* Route */
332 int route_new_static(Network *network, unsigned section, Route **ret);
333 int route_new_dynamic(Route **ret);
334 void route_free(Route *route);
335 int route_configure(Route *route, Link *link, sd_rtnl_message_handler_t callback);
336 int route_drop(Route *route, Link *link, sd_rtnl_message_handler_t callback);
337
338
339 DEFINE_TRIVIAL_CLEANUP_FUNC(Route*, route_free);
340 #define _cleanup_route_free_ _cleanup_(route_freep)
341
342 int config_parse_gateway(const char *unit, const char *filename, unsigned line,
343                          const char *section, unsigned section_line, const char *lvalue,
344                          int ltype, const char *rvalue, void *data, void *userdata);
345
346 int config_parse_destination(const char *unit, const char *filename, unsigned line,
347                              const char *section, unsigned section_line, const char *lvalue,
348                              int ltype, const char *rvalue, void *data, void *userdata);
349
350 /* Address */
351 int address_new_static(Network *network, unsigned section, Address **ret);
352 int address_new_dynamic(Address **ret);
353 void address_free(Address *address);
354 int address_configure(Address *address, Link *link, sd_rtnl_message_handler_t callback);
355 int address_update(Address *address, Link *link, sd_rtnl_message_handler_t callback);
356 int address_drop(Address *address, Link *link, sd_rtnl_message_handler_t callback);
357
358 DEFINE_TRIVIAL_CLEANUP_FUNC(Address*, address_free);
359 #define _cleanup_address_free_ _cleanup_(address_freep)
360
361 int config_parse_dns(const char *unit, const char *filename, unsigned line,
362                      const char *section, unsigned section_line, const char *lvalue,
363                      int ltype, const char *rvalue, void *data, void *userdata);
364
365 int config_parse_address(const char *unit, const char *filename, unsigned line,
366                          const char *section, unsigned section_line, const char *lvalue,
367                          int ltype, const char *rvalue, void *data, void *userdata);
368
369 int config_parse_broadcast(const char *unit, const char *filename, unsigned line,
370                            const char *section, unsigned section_line, const char *lvalue,
371                            int ltype, const char *rvalue, void *data, void *userdata);
372
373 int config_parse_label(const char *unit, const char *filename, unsigned line,
374                        const char *section, unsigned section_line, const char *lvalue,
375                        int ltype, const char *rvalue, void *data, void *userdata);
376
377 /* Link */
378
379 Link *link_unref(Link *link);
380 Link *link_ref(Link *link);
381 int link_get(Manager *m, int ifindex, Link **ret);
382 int link_add(Manager *manager, sd_rtnl_message *message, Link **ret);
383
384 int link_update(Link *link, sd_rtnl_message *message);
385
386 int link_initialized(Link *link, struct udev_device *device);
387
388 int link_save(Link *link);
389
390 bool link_has_carrier(unsigned flags, uint8_t operstate);
391
392 const char* link_state_to_string(LinkState s) _const_;
393 LinkState link_state_from_string(const char *s) _pure_;
394
395 DEFINE_TRIVIAL_CLEANUP_FUNC(Link*, link_unref);
396 #define _cleanup_link_unref_ _cleanup_(link_unrefp)
397
398 /* Macros which append INTERFACE= to the message */
399
400 #define log_full_link(level, link, fmt, ...) log_meta_object(level, __FILE__, __LINE__, __func__, "INTERFACE=", link->ifname, "%s: " fmt, link->ifname, ##__VA_ARGS__)
401 #define log_debug_link(link, ...)       log_full_link(LOG_DEBUG, link, ##__VA_ARGS__)
402 #define log_info_link(link, ...)        log_full_link(LOG_INFO, link, ##__VA_ARGS__)
403 #define log_notice_link(link, ...)      log_full_link(LOG_NOTICE, link, ##__VA_ARGS__)
404 #define log_warning_link(link, ...)     log_full_link(LOG_WARNING, link, ##__VA_ARGS__)
405 #define log_error_link(link, ...)       log_full_link(LOG_ERR, link, ##__VA_ARGS__)
406
407 #define log_struct_link(level, link, ...) log_struct(level, "INTERFACE=%s", link->ifname, __VA_ARGS__)
408
409 /* More macros which append INTERFACE= to the message */
410
411 #define log_full_netdev(level, netdev, fmt, ...) log_meta_object(level, __FILE__, __LINE__, __func__, "INTERFACE=", netdev->name, "%s: " fmt, netdev->name, ##__VA_ARGS__)
412 #define log_debug_netdev(netdev, ...)       log_full_netdev(LOG_DEBUG, netdev, ##__VA_ARGS__)
413 #define log_info_netdev(netdev, ...)        log_full_netdev(LOG_INFO, netdev, ##__VA_ARGS__)
414 #define log_notice_netdev(netdev, ...)      log_full_netdev(LOG_NOTICE, netdev, ##__VA_ARGS__)
415 #define log_warning_netdev(netdev, ...)     log_full_netdev(LOG_WARNING, netdev,## __VA_ARGS__)
416 #define log_error_netdev(netdev, ...)       log_full_netdev(LOG_ERR, netdev, ##__VA_ARGS__)
417
418 #define log_struct_netdev(level, netdev, ...) log_struct(level, "INTERFACE=%s", netdev->name, __VA_ARGS__)
419
420 #define NETDEV(netdev) "INTERFACE=%s", netdev->name
421 #define ADDRESS_FMT_VAL(address)            \
422         (address).s_addr & 0xFF,            \
423         ((address).s_addr >> 8) & 0xFF,     \
424         ((address).s_addr >> 16) & 0xFF,    \
425         (address).s_addr >> 24