]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
0ef6f454 LP |
2 | #pragma once |
3 | ||
634f0f98 | 4 | #include "sd-netlink.h" |
3be1d7e0 | 5 | |
538f15cf | 6 | #include "conf-parser.h" |
5e20e1e3 | 7 | #include "ether-addr-util.h" |
634f0f98 | 8 | #include "list.h" |
60643448 | 9 | #include "log-link.h" |
737f1405 | 10 | #include "networkd-link.h" |
634f0f98 | 11 | #include "time-util.h" |
fc2f9534 | 12 | |
aaa5ca57 YW |
13 | /* Special hardware address value to suppress generating persistent hardware address for the netdev. */ |
14 | #define HW_ADDR_NONE ((struct hw_addr_data) { .length = 1, }) | |
15 | ||
130b812f ZJS |
16 | #define NETDEV_COMMON_SECTIONS "Match\0NetDev\0" |
17 | /* This is the list of known sections. We need to ignore them in the initial parsing phase. */ | |
18 | #define NETDEV_OTHER_SECTIONS \ | |
e6980c72 | 19 | "-BareUDP\0" \ |
c0267a59 | 20 | "-BatmanAdvanced\0" \ |
130b812f ZJS |
21 | "-Bond\0" \ |
22 | "-Bridge\0" \ | |
23 | "-FooOverUDP\0" \ | |
24 | "-GENEVE\0" \ | |
b90d0f83 | 25 | "-IPoIB\0" \ |
130b812f ZJS |
26 | "-IPVLAN\0" \ |
27 | "-IPVTAP\0" \ | |
28 | "-L2TP\0" \ | |
29 | "-L2TPSession\0" \ | |
30 | "-MACsec\0" \ | |
bc945c2b | 31 | "-MACsecReceiveAssociation\0" \ |
130b812f ZJS |
32 | "-MACsecReceiveChannel\0" \ |
33 | "-MACsecTransmitAssociation\0" \ | |
130b812f | 34 | "-MACVLAN\0" \ |
bc945c2b | 35 | "-MACVTAP\0" \ |
130b812f | 36 | "-Peer\0" \ |
bc945c2b YW |
37 | "-Tap\0" \ |
38 | "-Tun\0" \ | |
39 | "-Tunnel\0" \ | |
130b812f ZJS |
40 | "-VLAN\0" \ |
41 | "-VRF\0" \ | |
42 | "-VXCAN\0" \ | |
43 | "-VXLAN\0" \ | |
ec4954d9 | 44 | "-WLAN\0" \ |
130b812f ZJS |
45 | "-WireGuard\0" \ |
46 | "-WireGuardPeer\0" \ | |
47 | "-Xfrm\0" | |
48 | ||
3be1d7e0 | 49 | typedef enum NetDevKind { |
bc945c2b YW |
50 | NETDEV_KIND_BAREUDP, |
51 | NETDEV_KIND_BATADV, | |
3be1d7e0 | 52 | NETDEV_KIND_BOND, |
bc945c2b YW |
53 | NETDEV_KIND_BRIDGE, |
54 | NETDEV_KIND_DUMMY, | |
55 | NETDEV_KIND_ERSPAN, | |
56 | NETDEV_KIND_FOU, | |
57 | NETDEV_KIND_GENEVE, | |
3be1d7e0 | 58 | NETDEV_KIND_GRE, |
1af2536a | 59 | NETDEV_KIND_GRETAP, |
bc945c2b | 60 | NETDEV_KIND_IFB, |
b16492f8 SS |
61 | NETDEV_KIND_IP6GRE, |
62 | NETDEV_KIND_IP6GRETAP, | |
bc945c2b YW |
63 | NETDEV_KIND_IP6TNL, |
64 | NETDEV_KIND_IPIP, | |
b90d0f83 | 65 | NETDEV_KIND_IPOIB, |
bc945c2b YW |
66 | NETDEV_KIND_IPVLAN, |
67 | NETDEV_KIND_IPVTAP, | |
68 | NETDEV_KIND_L2TP, | |
69 | NETDEV_KIND_MACSEC, | |
70 | NETDEV_KIND_MACVLAN, | |
71 | NETDEV_KIND_MACVTAP, | |
72 | NETDEV_KIND_NETDEVSIM, | |
73 | NETDEV_KIND_NLMON, | |
3be1d7e0 | 74 | NETDEV_KIND_SIT, |
bc945c2b YW |
75 | NETDEV_KIND_TAP, |
76 | NETDEV_KIND_TUN, | |
77 | NETDEV_KIND_VCAN, | |
3be1d7e0 | 78 | NETDEV_KIND_VETH, |
bc945c2b YW |
79 | NETDEV_KIND_VLAN, |
80 | NETDEV_KIND_VRF, | |
3be1d7e0 | 81 | NETDEV_KIND_VTI, |
9011ce77 | 82 | NETDEV_KIND_VTI6, |
d6df583c | 83 | NETDEV_KIND_VXCAN, |
bc945c2b | 84 | NETDEV_KIND_VXLAN, |
e5719363 | 85 | NETDEV_KIND_WIREGUARD, |
dedf2d00 | 86 | NETDEV_KIND_WLAN, |
98d20a17 | 87 | NETDEV_KIND_XFRM, |
3be1d7e0 | 88 | _NETDEV_KIND_MAX, |
cebe1257 | 89 | _NETDEV_KIND_TUNNEL, /* Used by config_parse_stacked_netdev() */ |
2d93c20e | 90 | _NETDEV_KIND_INVALID = -EINVAL, |
3be1d7e0 TG |
91 | } NetDevKind; |
92 | ||
93 | typedef enum NetDevState { | |
f3c33b23 | 94 | NETDEV_STATE_LOADING, |
3be1d7e0 TG |
95 | NETDEV_STATE_FAILED, |
96 | NETDEV_STATE_CREATING, | |
97 | NETDEV_STATE_READY, | |
98 | NETDEV_STATE_LINGER, | |
99 | _NETDEV_STATE_MAX, | |
2d93c20e | 100 | _NETDEV_STATE_INVALID = -EINVAL, |
3be1d7e0 TG |
101 | } NetDevState; |
102 | ||
aa9f1140 TG |
103 | typedef enum NetDevCreateType { |
104 | NETDEV_CREATE_INDEPENDENT, | |
aa9f1140 TG |
105 | NETDEV_CREATE_STACKED, |
106 | _NETDEV_CREATE_MAX, | |
2d93c20e | 107 | _NETDEV_CREATE_INVALID = -EINVAL, |
aa9f1140 TG |
108 | } NetDevCreateType; |
109 | ||
634f0f98 ZJS |
110 | typedef struct Manager Manager; |
111 | typedef struct Condition Condition; | |
112 | ||
113 | typedef struct NetDev { | |
3be1d7e0 TG |
114 | Manager *manager; |
115 | ||
cf4b2f99 | 116 | unsigned n_ref; |
3be1d7e0 TG |
117 | |
118 | char *filename; | |
119 | ||
1beabe08 | 120 | LIST_HEAD(Condition, conditions); |
3be1d7e0 | 121 | |
aa9f1140 TG |
122 | NetDevState state; |
123 | NetDevKind kind; | |
3be1d7e0 TG |
124 | char *description; |
125 | char *ifname; | |
5e20e1e3 | 126 | struct hw_addr_data hw_addr; |
4e964aa0 | 127 | uint32_t mtu; |
3be1d7e0 | 128 | int ifindex; |
634f0f98 | 129 | } NetDev; |
3be1d7e0 | 130 | |
634f0f98 | 131 | typedef struct NetDevVTable { |
aa9f1140 TG |
132 | /* How much memory does an object of this unit type need */ |
133 | size_t object_size; | |
134 | ||
135 | /* Config file sections this netdev kind understands, separated | |
136 | * by NUL chars */ | |
137 | const char *sections; | |
3be1d7e0 | 138 | |
aa9f1140 TG |
139 | /* This should reset all type-specific variables. This should |
140 | * not allocate memory, and is called with zero-initialized | |
141 | * data. It should hence only initialize variables that need | |
142 | * to be set != 0. */ | |
143 | void (*init)(NetDev *n); | |
3be1d7e0 | 144 | |
af7a86b8 YW |
145 | /* This is called when the interface is removed. */ |
146 | void (*drop)(NetDev *n); | |
147 | ||
aa9f1140 TG |
148 | /* This should free all kind-specific variables. It should be |
149 | * idempotent. */ | |
150 | void (*done)(NetDev *n); | |
151 | ||
152 | /* fill in message to create netdev */ | |
1c4baffc | 153 | int (*fill_message_create)(NetDev *netdev, Link *link, sd_netlink_message *message); |
aa9f1140 TG |
154 | |
155 | /* specifies if netdev is independent, or a master device or a stacked device */ | |
156 | NetDevCreateType create_type; | |
3be1d7e0 | 157 | |
562729d7 YW |
158 | /* This is used for stacked netdev. Return true when the underlying link is ready. */ |
159 | int (*is_ready_to_create)(NetDev *netdev, Link *link); | |
160 | ||
3be1d7e0 TG |
161 | /* create netdev, if not done via rtnl */ |
162 | int (*create)(NetDev *netdev); | |
163 | ||
540eb5f0 | 164 | /* perform additional configuration after netdev has been createad */ |
c2b19b8f | 165 | int (*post_create)(NetDev *netdev, Link *link); |
540eb5f0 | 166 | |
3be1d7e0 TG |
167 | /* verify that compulsory configuration options were specified */ |
168 | int (*config_verify)(NetDev *netdev, const char *filename); | |
daf0f8ca | 169 | |
9f0cf80d YW |
170 | /* expected iftype, e.g. ARPHRD_ETHER. */ |
171 | uint16_t iftype; | |
172 | ||
7f0ed7d1 | 173 | /* Generate MAC address when MACAddress= is not specified. */ |
daf0f8ca | 174 | bool generate_mac; |
1d4312d5 YW |
175 | |
176 | /* When assigning ifindex to the netdev, skip to check if the netdev kind matches. */ | |
177 | bool skip_netdev_kind_check; | |
634f0f98 | 178 | } NetDevVTable; |
3be1d7e0 TG |
179 | |
180 | extern const NetDevVTable * const netdev_vtable[_NETDEV_KIND_MAX]; | |
181 | ||
281bb5c1 | 182 | #define NETDEV_VTABLE(n) ((n)->kind != _NETDEV_KIND_INVALID ? netdev_vtable[(n)->kind] : NULL) |
3be1d7e0 | 183 | |
aa9f1140 | 184 | /* For casting a netdev into the various netdev kinds */ |
117843fe ZJS |
185 | #define DEFINE_NETDEV_CAST(UPPERCASE, MixedCase) \ |
186 | static inline MixedCase* UPPERCASE(NetDev *n) { \ | |
187 | assert(n); \ | |
188 | assert(n->kind == NETDEV_KIND_##UPPERCASE); \ | |
189 | assert(n->state < _NETDEV_STATE_MAX); \ | |
190 | \ | |
191 | return (MixedCase*) n; \ | |
aa9f1140 TG |
192 | } |
193 | ||
194 | /* For casting the various netdev kinds into a netdev */ | |
195 | #define NETDEV(n) (&(n)->meta) | |
196 | ||
e272b621 | 197 | int netdev_load(Manager *manager, bool reload); |
e27aac11 | 198 | int netdev_load_one(Manager *manager, const char *filename); |
3be1d7e0 | 199 | void netdev_drop(NetDev *netdev); |
8f65304c | 200 | void netdev_enter_failed(NetDev *netdev); |
3be1d7e0 TG |
201 | |
202 | NetDev *netdev_unref(NetDev *netdev); | |
203 | NetDev *netdev_ref(NetDev *netdev); | |
302a796f | 204 | DEFINE_TRIVIAL_DESTRUCTOR(netdev_destroy_callback, NetDev, netdev_unref); |
3be1d7e0 | 205 | DEFINE_TRIVIAL_CLEANUP_FUNC(NetDev*, netdev_unref); |
3be1d7e0 | 206 | |
9e2bbf99 | 207 | bool netdev_is_managed(NetDev *netdev); |
3be1d7e0 | 208 | int netdev_get(Manager *manager, const char *name, NetDev **ret); |
1c4baffc | 209 | int netdev_set_ifindex(NetDev *netdev, sd_netlink_message *newlink); |
b90d0f83 | 210 | int netdev_generate_hw_addr(NetDev *netdev, Link *link, const char *name, |
a8ee2b8e | 211 | const struct hw_addr_data *hw_addr, struct hw_addr_data *ret); |
3be1d7e0 | 212 | |
b14686ff | 213 | int link_request_stacked_netdev(Link *link, NetDev *netdev); |
71a754f7 | 214 | |
3be1d7e0 TG |
215 | const char *netdev_kind_to_string(NetDevKind d) _const_; |
216 | NetDevKind netdev_kind_from_string(const char *d) _pure_; | |
217 | ||
859e9c04 YW |
218 | static inline NetDevCreateType netdev_get_create_type(NetDev *netdev) { |
219 | assert(netdev); | |
220 | assert(NETDEV_VTABLE(netdev)); | |
221 | ||
222 | return NETDEV_VTABLE(netdev)->create_type; | |
223 | } | |
224 | ||
538f15cf | 225 | CONFIG_PARSER_PROTOTYPE(config_parse_netdev_kind); |
aaa5ca57 | 226 | CONFIG_PARSER_PROTOTYPE(config_parse_netdev_hw_addr); |
3be1d7e0 TG |
227 | |
228 | /* gperf */ | |
c9f7b4d3 | 229 | const struct ConfigPerfItem* network_netdev_gperf_lookup(const char *key, GPERF_LEN_TYPE length); |
3be1d7e0 TG |
230 | |
231 | /* Macros which append INTERFACE= to the message */ | |
232 | ||
60643448 | 233 | #define log_netdev_full_errno_zerook(netdev, level, error, ...) \ |
f2341e0a | 234 | ({ \ |
8dec4a9d | 235 | const NetDev *_n = (netdev); \ |
60643448 | 236 | log_interface_full_errno_zerook(_n ? _n->ifname : NULL, level, error, __VA_ARGS__); \ |
f2341e0a | 237 | }) |
6a7a4e4d | 238 | |
60643448 YW |
239 | #define log_netdev_full_errno(netdev, level, error, ...) \ |
240 | ({ \ | |
241 | int _error = (error); \ | |
242 | ASSERT_NON_ZERO(_error); \ | |
243 | log_netdev_full_errno_zerook(netdev, level, _error, __VA_ARGS__); \ | |
244 | }) | |
245 | ||
246 | #define log_netdev_full(netdev, level, ...) (void) log_netdev_full_errno_zerook(netdev, level, 0, __VA_ARGS__) | |
247 | ||
248 | #define log_netdev_debug(netdev, ...) log_netdev_full(netdev, LOG_DEBUG, __VA_ARGS__) | |
249 | #define log_netdev_info(netdev, ...) log_netdev_full(netdev, LOG_INFO, __VA_ARGS__) | |
250 | #define log_netdev_notice(netdev, ...) log_netdev_full(netdev, LOG_NOTICE, __VA_ARGS__) | |
251 | #define log_netdev_warning(netdev, ...) log_netdev_full(netdev, LOG_WARNING, __VA_ARGS__) | |
252 | #define log_netdev_error(netdev, ...) log_netdev_full(netdev, LOG_ERR, __VA_ARGS__) | |
253 | ||
254 | #define log_netdev_debug_errno(netdev, error, ...) log_netdev_full_errno(netdev, LOG_DEBUG, error, __VA_ARGS__) | |
255 | #define log_netdev_info_errno(netdev, error, ...) log_netdev_full_errno(netdev, LOG_INFO, error, __VA_ARGS__) | |
256 | #define log_netdev_notice_errno(netdev, error, ...) log_netdev_full_errno(netdev, LOG_NOTICE, error, __VA_ARGS__) | |
257 | #define log_netdev_warning_errno(netdev, error, ...) log_netdev_full_errno(netdev, LOG_WARNING, error, __VA_ARGS__) | |
258 | #define log_netdev_error_errno(netdev, error, ...) log_netdev_full_errno(netdev, LOG_ERR, error, __VA_ARGS__) | |
98b32556 | 259 | |
f2341e0a LP |
260 | #define LOG_NETDEV_MESSAGE(netdev, fmt, ...) "MESSAGE=%s: " fmt, (netdev)->ifname, ##__VA_ARGS__ |
261 | #define LOG_NETDEV_INTERFACE(netdev) "INTERFACE=%s", (netdev)->ifname |