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