]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/network/netdev/netdev.h
Merge pull request #8776 from poettering/mtu-cleanup
[thirdparty/systemd.git] / src / network / netdev / netdev.h
1 /* SPDX-License-Identifier: LGPL-2.1+ */
2 #pragma once
3
4 /***
5 This file is part of systemd.
6
7 Copyright 2013 Tom Gundersen <teg@jklm.no>
8 ***/
9
10 #include "sd-netlink.h"
11
12 #include "list.h"
13 #include "time-util.h"
14
15 typedef struct netdev_join_callback netdev_join_callback;
16 typedef struct Link Link;
17
18 struct netdev_join_callback {
19 sd_netlink_message_handler_t callback;
20 Link *link;
21
22 LIST_FIELDS(netdev_join_callback, callbacks);
23 };
24
25 typedef enum NetDevKind {
26 NETDEV_KIND_BRIDGE,
27 NETDEV_KIND_BOND,
28 NETDEV_KIND_VLAN,
29 NETDEV_KIND_MACVLAN,
30 NETDEV_KIND_MACVTAP,
31 NETDEV_KIND_IPVLAN,
32 NETDEV_KIND_VXLAN,
33 NETDEV_KIND_IPIP,
34 NETDEV_KIND_GRE,
35 NETDEV_KIND_GRETAP,
36 NETDEV_KIND_IP6GRE,
37 NETDEV_KIND_IP6GRETAP,
38 NETDEV_KIND_SIT,
39 NETDEV_KIND_VETH,
40 NETDEV_KIND_VTI,
41 NETDEV_KIND_VTI6,
42 NETDEV_KIND_IP6TNL,
43 NETDEV_KIND_DUMMY,
44 NETDEV_KIND_TUN,
45 NETDEV_KIND_TAP,
46 NETDEV_KIND_VRF,
47 NETDEV_KIND_VCAN,
48 NETDEV_KIND_GENEVE,
49 NETDEV_KIND_VXCAN,
50 NETDEV_KIND_WIREGUARD,
51 _NETDEV_KIND_MAX,
52 _NETDEV_KIND_INVALID = -1
53 } NetDevKind;
54
55 typedef enum NetDevState {
56 NETDEV_STATE_LOADING,
57 NETDEV_STATE_FAILED,
58 NETDEV_STATE_CREATING,
59 NETDEV_STATE_READY,
60 NETDEV_STATE_LINGER,
61 _NETDEV_STATE_MAX,
62 _NETDEV_STATE_INVALID = -1,
63 } NetDevState;
64
65 typedef enum NetDevCreateType {
66 NETDEV_CREATE_INDEPENDENT,
67 NETDEV_CREATE_MASTER,
68 NETDEV_CREATE_STACKED,
69 _NETDEV_CREATE_MAX,
70 _NETDEV_CREATE_INVALID = -1,
71 } NetDevCreateType;
72
73 typedef struct Manager Manager;
74 typedef struct Condition Condition;
75
76 typedef struct NetDev {
77 Manager *manager;
78
79 int n_ref;
80
81 char *filename;
82
83 Condition *match_host;
84 Condition *match_virt;
85 Condition *match_kernel_cmdline;
86 Condition *match_kernel_version;
87 Condition *match_arch;
88
89 NetDevState state;
90 NetDevKind kind;
91 char *description;
92 char *ifname;
93 struct ether_addr *mac;
94 uint32_t mtu;
95 int ifindex;
96
97 LIST_HEAD(netdev_join_callback, callbacks);
98 } NetDev;
99
100 typedef struct NetDevVTable {
101 /* How much memory does an object of this unit type need */
102 size_t object_size;
103
104 /* Config file sections this netdev kind understands, separated
105 * by NUL chars */
106 const char *sections;
107
108 /* This should reset all type-specific variables. This should
109 * not allocate memory, and is called with zero-initialized
110 * data. It should hence only initialize variables that need
111 * to be set != 0. */
112 void (*init)(NetDev *n);
113
114 /* This should free all kind-specific variables. It should be
115 * idempotent. */
116 void (*done)(NetDev *n);
117
118 /* fill in message to create netdev */
119 int (*fill_message_create)(NetDev *netdev, Link *link, sd_netlink_message *message);
120
121 /* specifies if netdev is independent, or a master device or a stacked device */
122 NetDevCreateType create_type;
123
124 /* create netdev, if not done via rtnl */
125 int (*create)(NetDev *netdev);
126
127 /* perform additional configuration after netdev has been createad */
128 int (*post_create)(NetDev *netdev, Link *link, sd_netlink_message *message);
129
130 /* verify that compulsory configuration options were specified */
131 int (*config_verify)(NetDev *netdev, const char *filename);
132 } NetDevVTable;
133
134 extern const NetDevVTable * const netdev_vtable[_NETDEV_KIND_MAX];
135
136 #define NETDEV_VTABLE(n) ((n)->kind != _NETDEV_KIND_INVALID ? netdev_vtable[(n)->kind] : NULL)
137
138 /* For casting a netdev into the various netdev kinds */
139 #define DEFINE_NETDEV_CAST(UPPERCASE, MixedCase) \
140 static inline MixedCase* UPPERCASE(NetDev *n) { \
141 if (_unlikely_(!n || \
142 n->kind != NETDEV_KIND_##UPPERCASE) || \
143 n->state == _NETDEV_STATE_INVALID) \
144 return NULL; \
145 \
146 return (MixedCase*) n; \
147 }
148
149 /* For casting the various netdev kinds into a netdev */
150 #define NETDEV(n) (&(n)->meta)
151
152 int netdev_load(Manager *manager);
153 void netdev_drop(NetDev *netdev);
154
155 NetDev *netdev_unref(NetDev *netdev);
156 NetDev *netdev_ref(NetDev *netdev);
157
158 DEFINE_TRIVIAL_CLEANUP_FUNC(NetDev*, netdev_unref);
159
160 int netdev_get(Manager *manager, const char *name, NetDev **ret);
161 int netdev_set_ifindex(NetDev *netdev, sd_netlink_message *newlink);
162 int netdev_enslave(NetDev *netdev, Link *link, sd_netlink_message_handler_t callback);
163 int netdev_get_mac(const char *ifname, struct ether_addr **ret);
164 int netdev_join(NetDev *netdev, Link *link, sd_netlink_message_handler_t cb);
165
166 const char *netdev_kind_to_string(NetDevKind d) _const_;
167 NetDevKind netdev_kind_from_string(const char *d) _pure_;
168
169 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);
170
171 /* gperf */
172 const struct ConfigPerfItem* network_netdev_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
173
174 /* Macros which append INTERFACE= to the message */
175
176 #define log_netdev_full(netdev, level, error, ...) \
177 ({ \
178 const NetDev *_n = (netdev); \
179 _n ? log_object_internal(level, error, __FILE__, __LINE__, __func__, "INTERFACE=", _n->ifname, NULL, NULL, ##__VA_ARGS__) : \
180 log_internal(level, error, __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
181 })
182
183 #define log_netdev_debug(netdev, ...) log_netdev_full(netdev, LOG_DEBUG, 0, ##__VA_ARGS__)
184 #define log_netdev_info(netdev, ...) log_netdev_full(netdev, LOG_INFO, 0, ##__VA_ARGS__)
185 #define log_netdev_notice(netdev, ...) log_netdev_full(netdev, LOG_NOTICE, 0, ##__VA_ARGS__)
186 #define log_netdev_warning(netdev, ...) log_netdev_full(netdev, LOG_WARNING, 0, ## __VA_ARGS__)
187 #define log_netdev_error(netdev, ...) log_netdev_full(netdev, LOG_ERR, 0, ##__VA_ARGS__)
188
189 #define log_netdev_debug_errno(netdev, error, ...) log_netdev_full(netdev, LOG_DEBUG, error, ##__VA_ARGS__)
190 #define log_netdev_info_errno(netdev, error, ...) log_netdev_full(netdev, LOG_INFO, error, ##__VA_ARGS__)
191 #define log_netdev_notice_errno(netdev, error, ...) log_netdev_full(netdev, LOG_NOTICE, error, ##__VA_ARGS__)
192 #define log_netdev_warning_errno(netdev, error, ...) log_netdev_full(netdev, LOG_WARNING, error, ##__VA_ARGS__)
193 #define log_netdev_error_errno(netdev, error, ...) log_netdev_full(netdev, LOG_ERR, error, ##__VA_ARGS__)
194
195 #define LOG_NETDEV_MESSAGE(netdev, fmt, ...) "MESSAGE=%s: " fmt, (netdev)->ifname, ##__VA_ARGS__
196 #define LOG_NETDEV_INTERFACE(netdev) "INTERFACE=%s", (netdev)->ifname