]>
Commit | Line | Data |
---|---|---|
8b61709d | 1 | /* |
7dbd520e | 2 | * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2016 Nicira, Inc. |
8b61709d BP |
3 | * |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at: | |
7 | * | |
8 | * http://www.apache.org/licenses/LICENSE-2.0 | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | ||
17 | #ifndef NETDEV_PROVIDER_H | |
18 | #define NETDEV_PROVIDER_H 1 | |
19 | ||
20 | /* Generic interface to network devices. */ | |
21 | ||
3e912ffc | 22 | #include "connectivity.h" |
8b61709d | 23 | #include "netdev.h" |
b6cabb8f | 24 | #include "netdev-offload.h" |
b19bab5b | 25 | #include "openvswitch/list.h" |
7dec44fe | 26 | #include "ovs-numa.h" |
5fc5c50f | 27 | #include "ovs-rcu.h" |
3bd0fd39 | 28 | #include "packets.h" |
3e912ffc | 29 | #include "seq.h" |
ee89ea7b | 30 | #include "openvswitch/shash.h" |
79f1cbe9 | 31 | #include "smap.h" |
6c88d577 | 32 | |
6dfd0304 BP |
33 | #ifdef __cplusplus |
34 | extern "C" { | |
35 | #endif | |
36 | ||
4975aa3e | 37 | struct netdev_tnl_build_header_params; |
7dec44fe AW |
38 | #define NETDEV_NUMA_UNSPEC OVS_NUMA_UNSPEC |
39 | ||
29cf9c1b FL |
40 | enum netdev_ol_flags { |
41 | NETDEV_TX_OFFLOAD_IPV4_CKSUM = 1 << 0, | |
42 | NETDEV_TX_OFFLOAD_TCP_CKSUM = 1 << 1, | |
8c5163fe | 43 | NETDEV_TX_OFFLOAD_UDP_CKSUM = 1 << 2, |
35b5586b FL |
44 | NETDEV_TX_OFFLOAD_SCTP_CKSUM = 1 << 3, |
45 | NETDEV_TX_OFFLOAD_TCP_TSO = 1 << 4, | |
29cf9c1b FL |
46 | }; |
47 | ||
149f577a | 48 | /* A network device (e.g. an Ethernet device). |
6c88d577 | 49 | * |
9dc63482 BP |
50 | * Network device implementations may read these members but should not modify |
51 | * them. */ | |
b5d57fc8 | 52 | struct netdev { |
86383816 | 53 | /* The following do not change during the lifetime of a struct netdev. */ |
149f577a | 54 | char *name; /* Name of network device. */ |
d295e8e9 | 55 | const struct netdev_class *netdev_class; /* Functions to control |
a4af0040 | 56 | this device. */ |
86383816 | 57 | |
8c2c225e EC |
58 | /* If this is 'true' the user did not specify a netdev_class when |
59 | * opening this device, and therefore got assigned to the "system" class */ | |
60 | bool auto_classified; | |
61 | ||
29cf9c1b FL |
62 | /* This bitmask of the offloading features enabled by the netdev. */ |
63 | uint64_t ol_flags; | |
64 | ||
85e16a45 BB |
65 | /* If this is 'true', the user explicitly specified an MTU for this |
66 | * netdev. Otherwise, Open vSwitch is allowed to override it. */ | |
67 | bool mtu_user_config; | |
68 | ||
69 | int ref_cnt; /* Times this devices was opened. */ | |
70 | ||
3e912ffc AW |
71 | /* A sequence number which indicates changes in one of 'netdev''s |
72 | * properties. It must be nonzero so that users have a value which | |
73 | * they may use as a reset when tracking 'netdev'. | |
74 | * | |
75 | * Minimally, the sequence number is required to change whenever | |
76 | * 'netdev''s flags, features, ethernet address, or carrier changes. */ | |
3343f8d6 | 77 | atomic_uint64_t change_seq; |
3e912ffc | 78 | |
790fb3b7 DDP |
79 | /* A netdev provider might be unable to change some of the device's |
80 | * parameter (n_rxq, mtu) when the device is in use. In this case | |
81 | * the provider can notify the upper layer by calling | |
82 | * netdev_request_reconfigure(). The upper layer will react by stopping | |
83 | * the operations on the device and calling netdev_reconfigure() to allow | |
84 | * the configuration changes. 'last_reconfigure_seq' remembers the value | |
85 | * of 'reconfigure_seq' when the last reconfiguration happened. */ | |
86 | struct seq *reconfigure_seq; | |
87 | uint64_t last_reconfigure_seq; | |
88 | ||
a14b8947 IM |
89 | /* The core netdev code initializes these at netdev construction and only |
90 | * provide read-only access to its client. Netdev implementations may | |
91 | * modify them. */ | |
f00fa8cb | 92 | int n_txq; |
55c955bd | 93 | int n_rxq; |
149f577a | 94 | struct shash_node *node; /* Pointer to element in global map. */ |
ca6ba700 | 95 | struct ovs_list saved_flags_list; /* Contains "struct netdev_saved_flags". */ |
5fc5c50f IM |
96 | |
97 | /* Functions to control flow offloading. */ | |
98 | OVSRCU_TYPE(const struct netdev_flow_api *) flow_api; | |
738c785f | 99 | struct netdev_hw_info hw_info; /* offload-capable netdev info */ |
6c88d577 JP |
100 | }; |
101 | ||
6b241d64 | 102 | static inline void |
053acb81 | 103 | netdev_change_seq_changed(const struct netdev *netdev_) |
3e912ffc | 104 | { |
3343f8d6 | 105 | uint64_t change_seq; |
053acb81 | 106 | struct netdev *netdev = CONST_CAST(struct netdev *, netdev_); |
3e912ffc | 107 | seq_change(connectivity_seq_get()); |
3343f8d6 YW |
108 | |
109 | atomic_read_relaxed(&netdev->change_seq, &change_seq); | |
110 | change_seq++; | |
111 | if (OVS_UNLIKELY(!change_seq)) { | |
112 | change_seq++; | |
3e912ffc | 113 | } |
3343f8d6 YW |
114 | atomic_store_explicit(&netdev->change_seq, change_seq, |
115 | memory_order_release); | |
3e912ffc AW |
116 | } |
117 | ||
790fb3b7 DDP |
118 | static inline void |
119 | netdev_request_reconfigure(struct netdev *netdev) | |
120 | { | |
121 | seq_change(netdev->reconfigure_seq); | |
122 | } | |
123 | ||
b5d57fc8 BP |
124 | const char *netdev_get_type(const struct netdev *); |
125 | const struct netdev_class *netdev_get_class(const struct netdev *); | |
126 | const char *netdev_get_name(const struct netdev *); | |
127 | struct netdev *netdev_from_name(const char *name); | |
128 | void netdev_get_devices(const struct netdev_class *, | |
129 | struct shash *device_list); | |
41ca1e0a | 130 | struct netdev **netdev_get_vports(size_t *size); |
149f577a | 131 | |
9dc63482 BP |
132 | /* A data structure for capturing packets received by a network device. |
133 | * | |
134 | * Network device implementations may read these members but should not modify | |
135 | * them. | |
136 | * | |
f7791740 PS |
137 | * None of these members change during the lifetime of a struct netdev_rxq. */ |
138 | struct netdev_rxq { | |
9dc63482 | 139 | struct netdev *netdev; /* Owns a reference to the netdev. */ |
55c955bd | 140 | int queue_id; |
9dc63482 BP |
141 | }; |
142 | ||
f7791740 | 143 | struct netdev *netdev_rxq_get_netdev(const struct netdev_rxq *); |
9dc63482 | 144 | |
18ebd48c | 145 | |
8b61709d BP |
146 | /* Network device class structure, to be defined by each implementation of a |
147 | * network device. | |
148 | * | |
149 | * These functions return 0 if successful or a positive errno value on failure, | |
9dc63482 BP |
150 | * except where otherwise noted. |
151 | * | |
152 | * | |
153 | * Data Structures | |
154 | * =============== | |
155 | * | |
156 | * These functions work primarily with two different kinds of data structures: | |
157 | * | |
158 | * - "struct netdev", which represents a network device. | |
159 | * | |
f7791740 | 160 | * - "struct netdev_rxq", which represents a handle for capturing packets |
9dc63482 BP |
161 | * received on a network device |
162 | * | |
163 | * Each of these data structures contains all of the implementation-independent | |
164 | * generic state for the respective concept, called the "base" state. None of | |
165 | * them contains any extra space for implementations to use. Instead, each | |
166 | * implementation is expected to declare its own data structure that contains | |
167 | * an instance of the generic data structure plus additional | |
168 | * implementation-specific members, called the "derived" state. The | |
169 | * implementation can use casts or (preferably) the CONTAINER_OF macro to | |
170 | * obtain access to derived state given only a pointer to the embedded generic | |
171 | * data structure. | |
172 | * | |
173 | * | |
174 | * Life Cycle | |
175 | * ========== | |
176 | * | |
177 | * Four stylized functions accompany each of these data structures: | |
178 | * | |
f7791740 PS |
179 | * "alloc" "construct" "destruct" "dealloc" |
180 | * ------------ ---------------- --------------- -------------- | |
181 | * netdev ->alloc ->construct ->destruct ->dealloc | |
182 | * netdev_rxq ->rxq_alloc ->rxq_construct ->rxq_destruct ->rxq_dealloc | |
9dc63482 BP |
183 | * |
184 | * Any instance of a given data structure goes through the following life | |
185 | * cycle: | |
186 | * | |
187 | * 1. The client calls the "alloc" function to obtain raw memory. If "alloc" | |
188 | * fails, skip all the other steps. | |
189 | * | |
190 | * 2. The client initializes all of the data structure's base state. If this | |
191 | * fails, skip to step 7. | |
192 | * | |
193 | * 3. The client calls the "construct" function. The implementation | |
194 | * initializes derived state. It may refer to the already-initialized | |
195 | * base state. If "construct" fails, skip to step 6. | |
196 | * | |
197 | * 4. The data structure is now initialized and in use. | |
198 | * | |
199 | * 5. When the data structure is no longer needed, the client calls the | |
200 | * "destruct" function. The implementation uninitializes derived state. | |
201 | * The base state has not been uninitialized yet, so the implementation | |
202 | * may still refer to it. | |
203 | * | |
204 | * 6. The client uninitializes all of the data structure's base state. | |
205 | * | |
206 | * 7. The client calls the "dealloc" to free the raw memory. The | |
207 | * implementation must not refer to base or derived state in the data | |
208 | * structure, because it has already been uninitialized. | |
209 | * | |
55c955bd PS |
210 | * If netdev support multi-queue IO then netdev->construct should set initialize |
211 | * netdev->n_rxq to number of queues. | |
212 | * | |
9dc63482 BP |
213 | * Each "alloc" function allocates and returns a new instance of the respective |
214 | * data structure. The "alloc" function is not given any information about the | |
215 | * use of the new data structure, so it cannot perform much initialization. | |
216 | * Its purpose is just to ensure that the new data structure has enough room | |
217 | * for base and derived state. It may return a null pointer if memory is not | |
218 | * available, in which case none of the other functions is called. | |
219 | * | |
220 | * Each "construct" function initializes derived state in its respective data | |
221 | * structure. When "construct" is called, all of the base state has already | |
222 | * been initialized, so the "construct" function may refer to it. The | |
223 | * "construct" function is allowed to fail, in which case the client calls the | |
224 | * "dealloc" function (but not the "destruct" function). | |
225 | * | |
226 | * Each "destruct" function uninitializes and frees derived state in its | |
227 | * respective data structure. When "destruct" is called, the base state has | |
228 | * not yet been uninitialized, so the "destruct" function may refer to it. The | |
229 | * "destruct" function is not allowed to fail. | |
230 | * | |
898dcef1 | 231 | * Each "dealloc" function frees raw memory that was allocated by the |
9dc63482 BP |
232 | * "alloc" function. The memory's base and derived members might not have ever |
233 | * been initialized (but if "construct" returned successfully, then it has been | |
da4a6191 JS |
234 | * "destruct"ed already). The "dealloc" function is not allowed to fail. |
235 | * | |
236 | * | |
237 | * Device Change Notification | |
238 | * ========================== | |
239 | * | |
240 | * Minimally, implementations are required to report changes to netdev flags, | |
241 | * features, ethernet address or carrier through connectivity_seq. Changes to | |
242 | * other properties are allowed to cause notification through this interface, | |
243 | * although implementations should try to avoid this. connectivity_seq_get() | |
244 | * can be used to acquire a reference to the struct seq. The interface is | |
245 | * described in detail in seq.h. */ | |
8b61709d | 246 | struct netdev_class { |
6c88d577 | 247 | /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc. |
8b61709d | 248 | * |
6c88d577 | 249 | * One of the providers should supply a "system" type, since this is |
149f577a JG |
250 | * the type assumed if no type is specified when opening a netdev. |
251 | * The "system" type corresponds to an existing network device on | |
252 | * the system. */ | |
6c88d577 | 253 | const char *type; |
8b61709d | 254 | |
118c77b1 IM |
255 | /* If 'true' then this netdev should be polled by PMD threads. */ |
256 | bool is_pmd; | |
257 | ||
9dc63482 BP |
258 | /* ## ------------------- ## */ |
259 | /* ## Top-Level Functions ## */ | |
260 | /* ## ------------------- ## */ | |
261 | ||
77909859 JG |
262 | /* Called when the netdev provider is registered, typically at program |
263 | * startup. Returning an error from this function will prevent any network | |
264 | * device in this class from being opened. | |
8b61709d BP |
265 | * |
266 | * This function may be set to null if a network device class needs no | |
77909859 | 267 | * initialization at registration time. */ |
8b61709d BP |
268 | int (*init)(void); |
269 | ||
270 | /* Performs periodic work needed by netdevs of this class. May be null if | |
1c33f0c3 DDP |
271 | * no periodic work is necessary. |
272 | * | |
273 | * 'netdev_class' points to the class. It is useful in case the same | |
274 | * function is used to implement different classes. */ | |
275 | void (*run)(const struct netdev_class *netdev_class); | |
8b61709d BP |
276 | |
277 | /* Arranges for poll_block() to wake up if the "run" member function needs | |
ac4d3bcb EJ |
278 | * to be called. Implementations are additionally required to wake |
279 | * whenever something changes in any of its netdevs which would cause their | |
280 | * ->change_seq() function to change its result. May be null if nothing is | |
1c33f0c3 DDP |
281 | * needed here. |
282 | * | |
283 | * 'netdev_class' points to the class. It is useful in case the same | |
284 | * function is used to implement different classes. */ | |
285 | void (*wait)(const struct netdev_class *netdev_class); | |
8b61709d | 286 | |
9dc63482 BP |
287 | /* ## ---------------- ## */ |
288 | /* ## netdev Functions ## */ | |
289 | /* ## ---------------- ## */ | |
149f577a | 290 | |
9dc63482 BP |
291 | /* Life-cycle functions for a netdev. See the large comment above on |
292 | * struct netdev_class. */ | |
293 | struct netdev *(*alloc)(void); | |
294 | int (*construct)(struct netdev *); | |
295 | void (*destruct)(struct netdev *); | |
296 | void (*dealloc)(struct netdev *); | |
6c88d577 | 297 | |
b5d57fc8 | 298 | /* Fetches the device 'netdev''s configuration, storing it in 'args'. |
79f1cbe9 | 299 | * The caller owns 'args' and pre-initializes it to an empty smap. |
6c88d577 | 300 | * |
de5cdb90 BP |
301 | * If this netdev class does not have any configuration options, this may |
302 | * be a null pointer. */ | |
b5d57fc8 | 303 | int (*get_config)(const struct netdev *netdev, struct smap *args); |
6c88d577 | 304 | |
b5d57fc8 | 305 | /* Changes the device 'netdev''s configuration to 'args'. |
aebf4235 | 306 | * |
de5cdb90 | 307 | * If this netdev class does not support configuration, this may be a null |
9fff138e DDP |
308 | * pointer. |
309 | * | |
310 | * If the return value is not zero (meaning that an error occurred), | |
311 | * the provider can allocate a string with an error message in '*errp'. | |
312 | * The caller has to call free on it. */ | |
313 | int (*set_config)(struct netdev *netdev, const struct smap *args, | |
314 | char **errp); | |
aebf4235 | 315 | |
b5d57fc8 | 316 | /* Returns the tunnel configuration of 'netdev'. If 'netdev' is |
f431bf7d EJ |
317 | * not a tunnel, returns null. |
318 | * | |
319 | * If this function would always return null, it may be null instead. */ | |
320 | const struct netdev_tunnel_config * | |
b5d57fc8 | 321 | (*get_tunnel_config)(const struct netdev *netdev); |
7b6b0ef4 | 322 | |
4975aa3e PS |
323 | /* Build Tunnel header. Ethernet and ip header parameters are passed to |
324 | * tunnel implementation to build entire outer header for given flow. */ | |
c876a4bb | 325 | int (*build_header)(const struct netdev *, struct ovs_action_push_tnl *data, |
4975aa3e | 326 | const struct netdev_tnl_build_header_params *params); |
a36de779 PS |
327 | |
328 | /* build_header() can not build entire header for all packets for given | |
329 | * flow. Push header is called for packet to build header specific to | |
330 | * a packet on actual transmit. It uses partial header build by | |
331 | * build_header() which is passed as data. */ | |
754f8acb WT |
332 | void (*push_header)(const struct netdev *, |
333 | struct dp_packet *packet, | |
d625fbd1 | 334 | const struct ovs_action_push_tnl *data); |
a36de779 PS |
335 | |
336 | /* Pop tunnel header from packet, build tunnel metadata and resize packet | |
1c8f98d9 PS |
337 | * for further processing. |
338 | * Returns NULL in case of error or tunnel implementation queued packet for further | |
339 | * processing. */ | |
340 | struct dp_packet * (*pop_header)(struct dp_packet *packet); | |
a36de779 | 341 | |
7dec44fe AW |
342 | /* Returns the id of the numa node the 'netdev' is on. If there is no |
343 | * such info, returns NETDEV_NUMA_UNSPEC. */ | |
344 | int (*get_numa_id)(const struct netdev *netdev); | |
345 | ||
050c60bf DDP |
346 | /* Configures the number of tx queues of 'netdev'. Returns 0 if successful, |
347 | * otherwise a positive errno value. | |
a0cb2d66 DDP |
348 | * |
349 | * 'n_txq' specifies the exact number of transmission queues to create. | |
a0cb2d66 | 350 | * |
050c60bf DDP |
351 | * The caller will call netdev_reconfigure() (if necessary) before using |
352 | * netdev_send() on any of the newly configured queues, giving the provider | |
353 | * a chance to adjust its settings. | |
354 | * | |
355 | * On error, the tx queue configuration is unchanged. */ | |
356 | int (*set_tx_multiq)(struct netdev *netdev, unsigned int n_txq); | |
5496878c | 357 | |
f4fd623c | 358 | /* Sends buffers on 'netdev'. |
f00fa8cb AW |
359 | * Returns 0 if successful (for every buffer), otherwise a positive errno |
360 | * value. Returns EAGAIN without blocking if one or more packets cannot be | |
f4fd623c DDP |
361 | * queued immediately. Returns EMSGSIZE if a partial packet was transmitted |
362 | * or if a packet is too big or too small to transmit on the device. | |
8b61709d | 363 | * |
f4fd623c DDP |
364 | * If the function returns a non-zero value, some of the packets might have |
365 | * been sent anyway. | |
366 | * | |
b30896c9 IM |
367 | * The caller transfers ownership of all the packets to the network |
368 | * device, regardless of success. | |
8b61709d | 369 | * |
324c8374 IM |
370 | * If 'concurrent_txq' is true, the caller may perform concurrent calls |
371 | * to netdev_send() with the same 'qid'. The netdev provider is responsible | |
372 | * for making sure that these concurrent calls do not create a race | |
373 | * condition by using locking or other synchronization if required. | |
374 | * | |
f00fa8cb AW |
375 | * The network device is expected to maintain one or more packet |
376 | * transmission queues, so that the caller does not ordinarily have to | |
377 | * do additional queuing of packets. 'qid' specifies the queue to use | |
378 | * and can be ignored if the implementation does not support multiple | |
379 | * queues. | |
1ac98180 BP |
380 | * |
381 | * May return EOPNOTSUPP if a network device does not implement packet | |
382 | * transmission through this interface. This function may be set to null | |
195c8086 BP |
383 | * if it would always return EOPNOTSUPP anyhow. (This will prevent the |
384 | * network device from being usefully used by the netdev-based "userspace | |
76c308b5 BP |
385 | * datapath". It will also prevent the OVS implementation of bonding from |
386 | * working properly over 'netdev'.) */ | |
64839cf4 | 387 | int (*send)(struct netdev *netdev, int qid, struct dp_packet_batch *batch, |
b30896c9 | 388 | bool concurrent_txq); |
8b61709d BP |
389 | |
390 | /* Registers with the poll loop to wake up from the next call to | |
391 | * poll_block() when the packet transmission queue for 'netdev' has | |
392 | * sufficient room to transmit a packet with netdev_send(). | |
393 | * | |
f00fa8cb AW |
394 | * The network device is expected to maintain one or more packet |
395 | * transmission queues, so that the caller does not ordinarily have to | |
396 | * do additional queuing of packets. 'qid' specifies the queue to use | |
397 | * and can be ignored if the implementation does not support multiple | |
398 | * queues. | |
1ac98180 BP |
399 | * |
400 | * May be null if not needed, such as for a network device that does not | |
401 | * implement packet transmission through the 'send' member function. */ | |
f00fa8cb | 402 | void (*send_wait)(struct netdev *netdev, int qid); |
8b61709d BP |
403 | |
404 | /* Sets 'netdev''s Ethernet address to 'mac' */ | |
74ff3298 | 405 | int (*set_etheraddr)(struct netdev *netdev, const struct eth_addr mac); |
8b61709d | 406 | |
33f1ff84 BP |
407 | /* Retrieves 'netdev''s Ethernet address into 'mac'. |
408 | * | |
409 | * This address will be advertised as 'netdev''s MAC address through the | |
410 | * OpenFlow protocol, among other uses. */ | |
74ff3298 | 411 | int (*get_etheraddr)(const struct netdev *netdev, struct eth_addr *mac); |
8b61709d BP |
412 | |
413 | /* Retrieves 'netdev''s MTU into '*mtup'. | |
414 | * | |
415 | * The MTU is the maximum size of transmitted (and received) packets, in | |
416 | * bytes, not including the hardware header; thus, this is typically 1500 | |
f915f1a8 BP |
417 | * bytes for Ethernet devices. |
418 | * | |
419 | * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then | |
14622f22 BP |
420 | * this function should return EOPNOTSUPP. This function may be set to |
421 | * null if it would always return EOPNOTSUPP. */ | |
149f577a | 422 | int (*get_mtu)(const struct netdev *netdev, int *mtup); |
8b61709d | 423 | |
9b020780 PS |
424 | /* Sets 'netdev''s MTU to 'mtu'. |
425 | * | |
426 | * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then | |
14622f22 BP |
427 | * this function should return EOPNOTSUPP. This function may be set to |
428 | * null if it would always return EOPNOTSUPP. */ | |
4124cb12 | 429 | int (*set_mtu)(struct netdev *netdev, int mtu); |
9b020780 | 430 | |
9ab3d9a3 BP |
431 | /* Returns the ifindex of 'netdev', if successful, as a positive number. |
432 | * On failure, returns a negative errno value. | |
433 | * | |
434 | * The desired semantics of the ifindex value are a combination of those | |
435 | * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An | |
436 | * ifindex value should be unique within a host and remain stable at least | |
437 | * until reboot. SNMP says an ifindex "ranges between 1 and the value of | |
4c0f1780 JG |
438 | * ifNumber" but many systems do not follow this rule anyhow. |
439 | * | |
440 | * This function may be set to null if it would always return -EOPNOTSUPP. | |
441 | */ | |
149f577a | 442 | int (*get_ifindex)(const struct netdev *netdev); |
9ab3d9a3 | 443 | |
8b61709d | 444 | /* Sets 'carrier' to true if carrier is active (link light is on) on |
85da620e JG |
445 | * 'netdev'. |
446 | * | |
447 | * May be null if device does not provide carrier status (will be always | |
448 | * up as long as device is up). | |
449 | */ | |
8b61709d BP |
450 | int (*get_carrier)(const struct netdev *netdev, bool *carrier); |
451 | ||
65c3058c EJ |
452 | /* Returns the number of times 'netdev''s carrier has changed since being |
453 | * initialized. | |
454 | * | |
455 | * If null, callers will assume the number of carrier resets is zero. */ | |
456 | long long int (*get_carrier_resets)(const struct netdev *netdev); | |
457 | ||
1670c579 EJ |
458 | /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status |
459 | * instead of checking 'netdev''s carrier. 'netdev''s MII registers will | |
87df2bfc | 460 | * be polled once every 'interval' milliseconds. If 'netdev' does not |
1670c579 EJ |
461 | * support MII, another method may be used as a fallback. If 'interval' is |
462 | * less than or equal to zero, reverts ->get_carrier() to its normal | |
463 | * behavior. | |
63331829 | 464 | * |
1670c579 EJ |
465 | * Most network devices won't support this feature and will set this |
466 | * function pointer to NULL, which is equivalent to returning EOPNOTSUPP. | |
63331829 | 467 | */ |
1670c579 | 468 | int (*set_miimon_interval)(struct netdev *netdev, long long int interval); |
63331829 | 469 | |
8b61709d BP |
470 | /* Retrieves current device stats for 'netdev' into 'stats'. |
471 | * | |
472 | * A network device that supports some statistics but not others, it should | |
473 | * set the values of the unsupported statistics to all-1-bits | |
474 | * (UINT64_MAX). */ | |
149f577a | 475 | int (*get_stats)(const struct netdev *netdev, struct netdev_stats *); |
8b61709d | 476 | |
971f4b39 MW |
477 | /* Retrieves current device custom stats for 'netdev' into 'custom_stats'. |
478 | * | |
479 | * A network device should return only available statistics (if any). | |
480 | * If there are not statistics available, empty array should be | |
481 | * returned. | |
482 | * | |
483 | * The caller initializes 'custom_stats' before calling this function. | |
484 | * The caller takes ownership over allocated array of counters inside | |
485 | * structure netdev_custom_stats. | |
486 | * */ | |
487 | int (*get_custom_stats)(const struct netdev *netdev, | |
488 | struct netdev_custom_stats *custom_stats); | |
489 | ||
8b61709d BP |
490 | /* Stores the features supported by 'netdev' into each of '*current', |
491 | * '*advertised', '*supported', and '*peer'. Each value is a bitmap of | |
6c038611 | 492 | * NETDEV_F_* bits. |
4c0f1780 JG |
493 | * |
494 | * This function may be set to null if it would always return EOPNOTSUPP. | |
495 | */ | |
6f2f5cce | 496 | int (*get_features)(const struct netdev *netdev, |
6c038611 BP |
497 | enum netdev_features *current, |
498 | enum netdev_features *advertised, | |
499 | enum netdev_features *supported, | |
500 | enum netdev_features *peer); | |
8b61709d BP |
501 | |
502 | /* Set the features advertised by 'netdev' to 'advertise', which is a | |
6c038611 | 503 | * set of NETDEV_F_* bits. |
8b61709d BP |
504 | * |
505 | * This function may be set to null for a network device that does not | |
506 | * support configuring advertisements. */ | |
6c038611 BP |
507 | int (*set_advertisements)(struct netdev *netdev, |
508 | enum netdev_features advertise); | |
8b61709d | 509 | |
875ab130 BP |
510 | /* Returns 'netdev''s configured packet_type mode. |
511 | * | |
512 | * This function may be set to null if it would always return | |
513 | * NETDEV_PT_LEGACY_L2. */ | |
514 | enum netdev_pt_mode (*get_pt_mode)(const struct netdev *netdev); | |
515 | ||
8b61709d BP |
516 | /* Attempts to set input rate limiting (policing) policy, such that up to |
517 | * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative | |
518 | * burst size of 'kbits' kb. | |
519 | * | |
520 | * This function may be set to null if policing is not supported. */ | |
521 | int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate, | |
522 | unsigned int kbits_burst); | |
523 | ||
c1c9c9c4 BP |
524 | /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves |
525 | * it empty if 'netdev' does not support QoS. Any names added to 'types' | |
526 | * should be documented as valid for the "type" column in the "QoS" table | |
527 | * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
528 | * | |
529 | * Every network device must support disabling QoS with a type of "", but | |
530 | * this function must not add "" to 'types'. | |
531 | * | |
532 | * The caller is responsible for initializing 'types' (e.g. with | |
19993ef3 BP |
533 | * sset_init()) before calling this function. The caller retains ownership |
534 | * of 'types'. | |
c1c9c9c4 BP |
535 | * |
536 | * May be NULL if 'netdev' does not support QoS at all. */ | |
19993ef3 | 537 | int (*get_qos_types)(const struct netdev *netdev, struct sset *types); |
c1c9c9c4 BP |
538 | |
539 | /* Queries 'netdev' for its capabilities regarding the specified 'type' of | |
540 | * QoS. On success, initializes 'caps' with the QoS capabilities. | |
541 | * | |
542 | * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be | |
543 | * NULL if 'netdev' does not support QoS at all. */ | |
544 | int (*get_qos_capabilities)(const struct netdev *netdev, | |
545 | const char *type, | |
546 | struct netdev_qos_capabilities *caps); | |
547 | ||
548 | /* Queries 'netdev' about its currently configured form of QoS. If | |
549 | * successful, stores the name of the current form of QoS into '*typep' | |
550 | * and any details of configuration as string key-value pairs in | |
551 | * 'details'. | |
552 | * | |
553 | * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'. | |
554 | * | |
555 | * The caller initializes 'details' before calling this function. The | |
556 | * caller takes ownership of the string key-values pairs added to | |
557 | * 'details'. | |
558 | * | |
559 | * The netdev retains ownership of '*typep'. | |
560 | * | |
561 | * '*typep' will be one of the types returned by netdev_get_qos_types() for | |
562 | * 'netdev'. The contents of 'details' should be documented as valid for | |
563 | * '*typep' in the "other_config" column in the "QoS" table in | |
564 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
565 | * | |
566 | * May be NULL if 'netdev' does not support QoS at all. */ | |
567 | int (*get_qos)(const struct netdev *netdev, | |
79f1cbe9 | 568 | const char **typep, struct smap *details); |
c1c9c9c4 BP |
569 | |
570 | /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to | |
571 | * 'type' with details of configuration from 'details'. | |
572 | * | |
573 | * On error, the previous QoS configuration is retained. | |
574 | * | |
575 | * When this function changes the type of QoS (not just 'details'), this | |
576 | * also resets all queue configuration for 'netdev' to their defaults | |
577 | * (which depend on the specific type of QoS). Otherwise, the queue | |
578 | * configuration for 'netdev' is unchanged. | |
579 | * | |
580 | * 'type' should be "" (to disable QoS) or one of the types returned by | |
581 | * netdev_get_qos_types() for 'netdev'. The contents of 'details' should | |
582 | * be documented as valid for the given 'type' in the "other_config" column | |
583 | * in the "QoS" table in vswitchd/vswitch.xml (which is built as | |
584 | * ovs-vswitchd.conf.db(8)). | |
585 | * | |
586 | * May be NULL if 'netdev' does not support QoS at all. */ | |
587 | int (*set_qos)(struct netdev *netdev, | |
79f1cbe9 | 588 | const char *type, const struct smap *details); |
c1c9c9c4 BP |
589 | |
590 | /* Queries 'netdev' for information about the queue numbered 'queue_id'. | |
591 | * If successful, adds that information as string key-value pairs to | |
592 | * 'details'. Returns 0 if successful, otherwise a positive errno value. | |
593 | * | |
594 | * Should return EINVAL if 'queue_id' is greater than or equal to the | |
595 | * number of supported queues (as reported in the 'n_queues' member of | |
596 | * struct netdev_qos_capabilities by 'get_qos_capabilities'). | |
597 | * | |
598 | * The caller initializes 'details' before calling this function. The | |
599 | * caller takes ownership of the string key-values pairs added to | |
600 | * 'details'. | |
601 | * | |
602 | * The returned contents of 'details' should be documented as valid for the | |
603 | * given 'type' in the "other_config" column in the "Queue" table in | |
604 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
605 | */ | |
606 | int (*get_queue)(const struct netdev *netdev, | |
79f1cbe9 | 607 | unsigned int queue_id, struct smap *details); |
c1c9c9c4 BP |
608 | |
609 | /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value | |
610 | * string pairs in 'details'. The contents of 'details' should be | |
611 | * documented as valid for the given 'type' in the "other_config" column in | |
612 | * the "Queue" table in vswitchd/vswitch.xml (which is built as | |
613 | * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive | |
614 | * errno value. On failure, the given queue's configuration should be | |
615 | * unmodified. | |
616 | * | |
617 | * Should return EINVAL if 'queue_id' is greater than or equal to the | |
618 | * number of supported queues (as reported in the 'n_queues' member of | |
619 | * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if | |
620 | * 'details' is invalid for the type of queue. | |
621 | * | |
622 | * This function does not modify 'details', and the caller retains | |
623 | * ownership of it. | |
624 | * | |
625 | * May be NULL if 'netdev' does not support QoS at all. */ | |
626 | int (*set_queue)(struct netdev *netdev, | |
79f1cbe9 | 627 | unsigned int queue_id, const struct smap *details); |
c1c9c9c4 BP |
628 | |
629 | /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. | |
630 | * | |
631 | * Should return EINVAL if 'queue_id' is greater than or equal to the | |
632 | * number of supported queues (as reported in the 'n_queues' member of | |
633 | * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should | |
634 | * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if | |
635 | * 'netdev' has a fixed set of queues with the current QoS mode). | |
636 | * | |
637 | * May be NULL if 'netdev' does not support QoS at all, or if all of its | |
638 | * QoS modes have fixed sets of queues. */ | |
639 | int (*delete_queue)(struct netdev *netdev, unsigned int queue_id); | |
640 | ||
641 | /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the | |
642 | * queue's statistics. May set individual members of 'stats' to all-1-bits | |
643 | * if the statistic is unavailable. | |
644 | * | |
645 | * May be NULL if 'netdev' does not support QoS at all. */ | |
646 | int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id, | |
647 | struct netdev_queue_stats *stats); | |
648 | ||
89454bf4 BP |
649 | /* Attempts to begin dumping the queues in 'netdev'. On success, returns 0 |
650 | * and initializes '*statep' with any data needed for iteration. On | |
651 | * failure, returns a positive errno value. | |
652 | * | |
653 | * May be NULL if 'netdev' does not support QoS at all. */ | |
654 | int (*queue_dump_start)(const struct netdev *netdev, void **statep); | |
655 | ||
656 | /* Attempts to retrieve another queue from 'netdev' for 'state', which was | |
657 | * initialized by a successful call to the 'queue_dump_start' function for | |
658 | * 'netdev'. On success, stores a queue ID into '*queue_id' and fills | |
659 | * 'details' with the configuration of the queue with that ID. Returns EOF | |
660 | * if the last queue has been dumped, or a positive errno value on error. | |
661 | * This function will not be called again once it returns nonzero once for | |
662 | * a given iteration (but the 'queue_dump_done' function will be called | |
663 | * afterward). | |
664 | * | |
665 | * The caller initializes and clears 'details' before calling this | |
666 | * function. The caller takes ownership of the string key-values pairs | |
667 | * added to 'details'. | |
668 | * | |
669 | * The returned contents of 'details' should be documented as valid for the | |
670 | * given 'type' in the "other_config" column in the "Queue" table in | |
671 | * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). | |
672 | * | |
673 | * May be NULL if 'netdev' does not support QoS at all. */ | |
674 | int (*queue_dump_next)(const struct netdev *netdev, void *state, | |
675 | unsigned int *queue_id, struct smap *details); | |
676 | ||
677 | /* Releases resources from 'netdev' for 'state', which was initialized by a | |
678 | * successful call to the 'queue_dump_start' function for 'netdev'. | |
679 | * | |
680 | * May be NULL if 'netdev' does not support QoS at all. */ | |
681 | int (*queue_dump_done)(const struct netdev *netdev, void *state); | |
c1c9c9c4 BP |
682 | |
683 | /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's | |
684 | * ID, its statistics, and the 'aux' specified by the caller. The order of | |
685 | * iteration is unspecified, but (when successful) each queue must be | |
686 | * visited exactly once. | |
687 | * | |
688 | * 'cb' will not modify or free the statistics passed in. */ | |
689 | int (*dump_queue_stats)(const struct netdev *netdev, | |
690 | void (*cb)(unsigned int queue_id, | |
691 | struct netdev_queue_stats *, | |
692 | void *aux), | |
693 | void *aux); | |
694 | ||
8b61709d BP |
695 | /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If |
696 | * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. | |
697 | * | |
698 | * This function may be set to null if it would always return EOPNOTSUPP | |
699 | * anyhow. */ | |
149f577a JG |
700 | int (*set_in4)(struct netdev *netdev, struct in_addr addr, |
701 | struct in_addr mask); | |
8b61709d | 702 | |
a8704b50 PS |
703 | /* Returns all assigned IP address to 'netdev' and returns 0. |
704 | * API allocates array of address and masks and set it to | |
705 | * '*addr' and '*mask'. | |
706 | * Otherwise, returns a positive errno value and sets '*addr', '*mask | |
707 | * and '*n_addr' to NULL. | |
8b61709d BP |
708 | * |
709 | * The following error values have well-defined meanings: | |
710 | * | |
711 | * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address. | |
712 | * | |
713 | * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'. | |
714 | * | |
a8704b50 PS |
715 | * 'addr' may be null, in which case the address itself is not reported. */ |
716 | int (*get_addr_list)(const struct netdev *netdev, struct in6_addr **in, | |
717 | struct in6_addr **mask, int *n_in6); | |
8b61709d BP |
718 | |
719 | /* Adds 'router' as a default IP gateway for the TCP/IP stack that | |
720 | * corresponds to 'netdev'. | |
721 | * | |
722 | * This function may be set to null if it would always return EOPNOTSUPP | |
723 | * anyhow. */ | |
724 | int (*add_router)(struct netdev *netdev, struct in_addr router); | |
725 | ||
c27fd2f9 BP |
726 | /* Looks up the next hop for 'host' in the host's routing table. If |
727 | * successful, stores the next hop gateway's address (0 if 'host' is on a | |
728 | * directly connected network) in '*next_hop' and a copy of the name of the | |
729 | * device to reach 'host' in '*netdev_name', and returns 0. The caller is | |
730 | * responsible for freeing '*netdev_name' (by calling free()). | |
f1acd62b BP |
731 | * |
732 | * This function may be set to null if it would always return EOPNOTSUPP | |
733 | * anyhow. */ | |
734 | int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop, | |
735 | char **netdev_name); | |
736 | ||
2c2ea5a8 | 737 | /* Retrieves driver information of the device. |
ea763e0e | 738 | * |
275707c3 EJ |
739 | * Populates 'smap' with key-value pairs representing the status of the |
740 | * device. 'smap' is a set of key-value string pairs representing netdev | |
741 | * type specific information. For more information see | |
ea763e0e EJ |
742 | * ovs-vswitchd.conf.db(5). |
743 | * | |
79f1cbe9 | 744 | * The caller is responsible for destroying 'smap' and its data. |
ea763e0e EJ |
745 | * |
746 | * This function may be set to null if it would always return EOPNOTSUPP | |
747 | * anyhow. */ | |
275707c3 | 748 | int (*get_status)(const struct netdev *netdev, struct smap *smap); |
ea83a2fc | 749 | |
8b61709d BP |
750 | /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the |
751 | * corresponding MAC address in 'mac'. A return value of ENXIO, in | |
752 | * particular, indicates that there is no ARP table entry for 'ip' on | |
753 | * 'netdev'. | |
754 | * | |
755 | * This function may be set to null if it would always return EOPNOTSUPP | |
756 | * anyhow. */ | |
dbba996b | 757 | int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip, |
74ff3298 | 758 | struct eth_addr *mac); |
8b61709d | 759 | |
b5d57fc8 | 760 | /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then, |
4b609110 BP |
761 | * turns off the flags that are set to 1 in 'off' and turns on the flags |
762 | * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and | |
763 | * 'on'; that is, off & on == 0.) | |
8b61709d BP |
764 | * |
765 | * This function may be invoked from a signal handler. Therefore, it | |
766 | * should not do anything that is not signal-safe (such as logging). */ | |
b5d57fc8 | 767 | int (*update_flags)(struct netdev *netdev, enum netdev_flags off, |
8b61709d BP |
768 | enum netdev_flags on, enum netdev_flags *old_flags); |
769 | ||
790fb3b7 DDP |
770 | /* If the provider called netdev_request_reconfigure(), the upper layer |
771 | * will eventually call this. The provider can update the device | |
772 | * configuration knowing that the upper layer will not call rxq_recv() or | |
773 | * send() until this function returns. | |
774 | * | |
775 | * On error, the configuration is indeterminant and the device cannot be | |
776 | * used to send and receive packets until a successful configuration is | |
777 | * applied. */ | |
778 | int (*reconfigure)(struct netdev *netdev); | |
f7791740 PS |
779 | /* ## -------------------- ## */ |
780 | /* ## netdev_rxq Functions ## */ | |
781 | /* ## -------------------- ## */ | |
9dc63482 BP |
782 | |
783 | /* If a particular netdev class does not support receiving packets, all these | |
784 | * function pointers must be NULL. */ | |
796223f5 | 785 | |
f7791740 | 786 | /* Life-cycle functions for a netdev_rxq. See the large comment above on |
9dc63482 | 787 | * struct netdev_class. */ |
f7791740 PS |
788 | struct netdev_rxq *(*rxq_alloc)(void); |
789 | int (*rxq_construct)(struct netdev_rxq *); | |
790 | void (*rxq_destruct)(struct netdev_rxq *); | |
791 | void (*rxq_dealloc)(struct netdev_rxq *); | |
796223f5 | 792 | |
35c91567 DM |
793 | /* Retrieves the current state of rx queue. 'false' means that queue won't |
794 | * get traffic in a short term and could be not polled. | |
795 | * | |
796 | * This function may be set to null if it would always return 'true' | |
797 | * anyhow. */ | |
798 | bool (*rxq_enabled)(struct netdev_rxq *); | |
799 | ||
64839cf4 WT |
800 | /* Attempts to receive a batch of packets from 'rx'. In 'batch', the |
801 | * caller supplies 'packets' as the pointer to the beginning of an array | |
c90e4d9c MK |
802 | * of NETDEV_MAX_BURST pointers to dp_packet. If successful, the |
803 | * implementation stores pointers to up to NETDEV_MAX_BURST dp_packets into | |
64839cf4 WT |
804 | * the array, transferring ownership of the packets to the caller, stores |
805 | * the number of received packets into 'count', and returns 0. | |
e175dc83 BP |
806 | * |
807 | * The implementation does not necessarily initialize any non-data members | |
64839cf4 WT |
808 | * of 'packets' in 'batch'. That is, the caller must initialize layer |
809 | * pointers and metadata itself, if desired, e.g. with pkt_metadata_init() | |
810 | * and miniflow_extract(). | |
e175dc83 BP |
811 | * |
812 | * Implementations should allocate buffers with DP_NETDEV_HEADROOM bytes of | |
813 | * headroom. | |
814 | * | |
8492adc2 JS |
815 | * If the caller provides a non-NULL qfill pointer, the implementation |
816 | * should return the number (zero or more) of remaining packets in the | |
817 | * queue after the reception the current batch, if it supports that, | |
818 | * or -ENOTSUP otherwise. | |
819 | * | |
e175dc83 BP |
820 | * Returns EAGAIN immediately if no packet is ready to be received or |
821 | * another positive errno value if an error was encountered. */ | |
8492adc2 JS |
822 | int (*rxq_recv)(struct netdev_rxq *rx, struct dp_packet_batch *batch, |
823 | int *qfill); | |
796223f5 BP |
824 | |
825 | /* Registers with the poll loop to wake up from the next call to | |
e175dc83 BP |
826 | * poll_block() when a packet is ready to be received with |
827 | * netdev_rxq_recv() on 'rx'. */ | |
f7791740 | 828 | void (*rxq_wait)(struct netdev_rxq *rx); |
796223f5 BP |
829 | |
830 | /* Discards all packets waiting to be received from 'rx'. */ | |
f7791740 | 831 | int (*rxq_drain)(struct netdev_rxq *rx); |
18ebd48c | 832 | |
88dcf2aa JH |
833 | /* Get a block_id from the netdev. |
834 | * Returns the block_id or 0 if none exists for netdev. */ | |
835 | uint32_t (*get_block_id)(struct netdev *); | |
796223f5 BP |
836 | }; |
837 | ||
2b9d6589 BP |
838 | int netdev_register_provider(const struct netdev_class *); |
839 | int netdev_unregister_provider(const char *type); | |
840 | ||
666afb55 | 841 | #if defined(__FreeBSD__) || defined(__NetBSD__) |
f6eb6b20 | 842 | extern const struct netdev_class netdev_bsd_class; |
078eedf4 NR |
843 | #elif defined(_WIN32) |
844 | extern const struct netdev_class netdev_windows_class; | |
845 | #else | |
846 | extern const struct netdev_class netdev_linux_class; | |
f6eb6b20 | 847 | #endif |
078eedf4 NR |
848 | extern const struct netdev_class netdev_internal_class; |
849 | extern const struct netdev_class netdev_tap_class; | |
8b61709d | 850 | |
0de1b425 WT |
851 | #ifdef HAVE_AF_XDP |
852 | extern const struct netdev_class netdev_afxdp_class; | |
853 | #endif | |
6dfd0304 BP |
854 | #ifdef __cplusplus |
855 | } | |
856 | #endif | |
857 | ||
8b61709d | 858 | #endif /* netdev.h */ |