2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014, 2016 Nicira, Inc.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef NETDEV_PROVIDER_H
18 #define NETDEV_PROVIDER_H 1
20 /* Generic interface to network devices. */
22 #include "connectivity.h"
24 #include "netdev-offload.h"
25 #include "openvswitch/list.h"
30 #include "openvswitch/shash.h"
37 struct netdev_tnl_build_header_params
;
38 #define NETDEV_NUMA_UNSPEC OVS_NUMA_UNSPEC
40 /* A network device (e.g. an Ethernet device).
42 * Network device implementations may read these members but should not modify
45 /* The following do not change during the lifetime of a struct netdev. */
46 char *name
; /* Name of network device. */
47 const struct netdev_class
*netdev_class
; /* Functions to control
50 /* If this is 'true' the user did not specify a netdev_class when
51 * opening this device, and therefore got assigned to the "system" class */
54 /* If this is 'true', the user explicitly specified an MTU for this
55 * netdev. Otherwise, Open vSwitch is allowed to override it. */
58 int ref_cnt
; /* Times this devices was opened. */
60 /* A sequence number which indicates changes in one of 'netdev''s
61 * properties. It must be nonzero so that users have a value which
62 * they may use as a reset when tracking 'netdev'.
64 * Minimally, the sequence number is required to change whenever
65 * 'netdev''s flags, features, ethernet address, or carrier changes. */
68 /* A netdev provider might be unable to change some of the device's
69 * parameter (n_rxq, mtu) when the device is in use. In this case
70 * the provider can notify the upper layer by calling
71 * netdev_request_reconfigure(). The upper layer will react by stopping
72 * the operations on the device and calling netdev_reconfigure() to allow
73 * the configuration changes. 'last_reconfigure_seq' remembers the value
74 * of 'reconfigure_seq' when the last reconfiguration happened. */
75 struct seq
*reconfigure_seq
;
76 uint64_t last_reconfigure_seq
;
78 /* The core netdev code initializes these at netdev construction and only
79 * provide read-only access to its client. Netdev implementations may
83 struct shash_node
*node
; /* Pointer to element in global map. */
84 struct ovs_list saved_flags_list
; /* Contains "struct netdev_saved_flags". */
86 /* Functions to control flow offloading. */
87 OVSRCU_TYPE(const struct netdev_flow_api
*) flow_api
;
88 struct netdev_hw_info hw_info
; /* offload-capable netdev info */
92 netdev_change_seq_changed(const struct netdev
*netdev_
)
94 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
95 seq_change(connectivity_seq_get());
97 if (!netdev
->change_seq
) {
103 netdev_request_reconfigure(struct netdev
*netdev
)
105 seq_change(netdev
->reconfigure_seq
);
108 const char *netdev_get_type(const struct netdev
*);
109 const struct netdev_class
*netdev_get_class(const struct netdev
*);
110 const char *netdev_get_name(const struct netdev
*);
111 struct netdev
*netdev_from_name(const char *name
);
112 void netdev_get_devices(const struct netdev_class
*,
113 struct shash
*device_list
);
114 struct netdev
**netdev_get_vports(size_t *size
);
116 /* A data structure for capturing packets received by a network device.
118 * Network device implementations may read these members but should not modify
121 * None of these members change during the lifetime of a struct netdev_rxq. */
123 struct netdev
*netdev
; /* Owns a reference to the netdev. */
127 struct netdev
*netdev_rxq_get_netdev(const struct netdev_rxq
*);
130 /* Network device class structure, to be defined by each implementation of a
133 * These functions return 0 if successful or a positive errno value on failure,
134 * except where otherwise noted.
140 * These functions work primarily with two different kinds of data structures:
142 * - "struct netdev", which represents a network device.
144 * - "struct netdev_rxq", which represents a handle for capturing packets
145 * received on a network device
147 * Each of these data structures contains all of the implementation-independent
148 * generic state for the respective concept, called the "base" state. None of
149 * them contains any extra space for implementations to use. Instead, each
150 * implementation is expected to declare its own data structure that contains
151 * an instance of the generic data structure plus additional
152 * implementation-specific members, called the "derived" state. The
153 * implementation can use casts or (preferably) the CONTAINER_OF macro to
154 * obtain access to derived state given only a pointer to the embedded generic
161 * Four stylized functions accompany each of these data structures:
163 * "alloc" "construct" "destruct" "dealloc"
164 * ------------ ---------------- --------------- --------------
165 * netdev ->alloc ->construct ->destruct ->dealloc
166 * netdev_rxq ->rxq_alloc ->rxq_construct ->rxq_destruct ->rxq_dealloc
168 * Any instance of a given data structure goes through the following life
171 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
172 * fails, skip all the other steps.
174 * 2. The client initializes all of the data structure's base state. If this
175 * fails, skip to step 7.
177 * 3. The client calls the "construct" function. The implementation
178 * initializes derived state. It may refer to the already-initialized
179 * base state. If "construct" fails, skip to step 6.
181 * 4. The data structure is now initialized and in use.
183 * 5. When the data structure is no longer needed, the client calls the
184 * "destruct" function. The implementation uninitializes derived state.
185 * The base state has not been uninitialized yet, so the implementation
186 * may still refer to it.
188 * 6. The client uninitializes all of the data structure's base state.
190 * 7. The client calls the "dealloc" to free the raw memory. The
191 * implementation must not refer to base or derived state in the data
192 * structure, because it has already been uninitialized.
194 * If netdev support multi-queue IO then netdev->construct should set initialize
195 * netdev->n_rxq to number of queues.
197 * Each "alloc" function allocates and returns a new instance of the respective
198 * data structure. The "alloc" function is not given any information about the
199 * use of the new data structure, so it cannot perform much initialization.
200 * Its purpose is just to ensure that the new data structure has enough room
201 * for base and derived state. It may return a null pointer if memory is not
202 * available, in which case none of the other functions is called.
204 * Each "construct" function initializes derived state in its respective data
205 * structure. When "construct" is called, all of the base state has already
206 * been initialized, so the "construct" function may refer to it. The
207 * "construct" function is allowed to fail, in which case the client calls the
208 * "dealloc" function (but not the "destruct" function).
210 * Each "destruct" function uninitializes and frees derived state in its
211 * respective data structure. When "destruct" is called, the base state has
212 * not yet been uninitialized, so the "destruct" function may refer to it. The
213 * "destruct" function is not allowed to fail.
215 * Each "dealloc" function frees raw memory that was allocated by the
216 * "alloc" function. The memory's base and derived members might not have ever
217 * been initialized (but if "construct" returned successfully, then it has been
218 * "destruct"ed already). The "dealloc" function is not allowed to fail.
221 * Device Change Notification
222 * ==========================
224 * Minimally, implementations are required to report changes to netdev flags,
225 * features, ethernet address or carrier through connectivity_seq. Changes to
226 * other properties are allowed to cause notification through this interface,
227 * although implementations should try to avoid this. connectivity_seq_get()
228 * can be used to acquire a reference to the struct seq. The interface is
229 * described in detail in seq.h. */
230 struct netdev_class
{
231 /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
233 * One of the providers should supply a "system" type, since this is
234 * the type assumed if no type is specified when opening a netdev.
235 * The "system" type corresponds to an existing network device on
239 /* If 'true' then this netdev should be polled by PMD threads. */
242 /* ## ------------------- ## */
243 /* ## Top-Level Functions ## */
244 /* ## ------------------- ## */
246 /* Called when the netdev provider is registered, typically at program
247 * startup. Returning an error from this function will prevent any network
248 * device in this class from being opened.
250 * This function may be set to null if a network device class needs no
251 * initialization at registration time. */
254 /* Performs periodic work needed by netdevs of this class. May be null if
255 * no periodic work is necessary.
257 * 'netdev_class' points to the class. It is useful in case the same
258 * function is used to implement different classes. */
259 void (*run
)(const struct netdev_class
*netdev_class
);
261 /* Arranges for poll_block() to wake up if the "run" member function needs
262 * to be called. Implementations are additionally required to wake
263 * whenever something changes in any of its netdevs which would cause their
264 * ->change_seq() function to change its result. May be null if nothing is
267 * 'netdev_class' points to the class. It is useful in case the same
268 * function is used to implement different classes. */
269 void (*wait
)(const struct netdev_class
*netdev_class
);
271 /* ## ---------------- ## */
272 /* ## netdev Functions ## */
273 /* ## ---------------- ## */
275 /* Life-cycle functions for a netdev. See the large comment above on
276 * struct netdev_class. */
277 struct netdev
*(*alloc
)(void);
278 int (*construct
)(struct netdev
*);
279 void (*destruct
)(struct netdev
*);
280 void (*dealloc
)(struct netdev
*);
282 /* Fetches the device 'netdev''s configuration, storing it in 'args'.
283 * The caller owns 'args' and pre-initializes it to an empty smap.
285 * If this netdev class does not have any configuration options, this may
286 * be a null pointer. */
287 int (*get_config
)(const struct netdev
*netdev
, struct smap
*args
);
289 /* Changes the device 'netdev''s configuration to 'args'.
291 * If this netdev class does not support configuration, this may be a null
294 * If the return value is not zero (meaning that an error occurred),
295 * the provider can allocate a string with an error message in '*errp'.
296 * The caller has to call free on it. */
297 int (*set_config
)(struct netdev
*netdev
, const struct smap
*args
,
300 /* Returns the tunnel configuration of 'netdev'. If 'netdev' is
301 * not a tunnel, returns null.
303 * If this function would always return null, it may be null instead. */
304 const struct netdev_tunnel_config
*
305 (*get_tunnel_config
)(const struct netdev
*netdev
);
307 /* Build Tunnel header. Ethernet and ip header parameters are passed to
308 * tunnel implementation to build entire outer header for given flow. */
309 int (*build_header
)(const struct netdev
*, struct ovs_action_push_tnl
*data
,
310 const struct netdev_tnl_build_header_params
*params
);
312 /* build_header() can not build entire header for all packets for given
313 * flow. Push header is called for packet to build header specific to
314 * a packet on actual transmit. It uses partial header build by
315 * build_header() which is passed as data. */
316 void (*push_header
)(const struct netdev
*,
317 struct dp_packet
*packet
,
318 const struct ovs_action_push_tnl
*data
);
320 /* Pop tunnel header from packet, build tunnel metadata and resize packet
321 * for further processing.
322 * Returns NULL in case of error or tunnel implementation queued packet for further
324 struct dp_packet
* (*pop_header
)(struct dp_packet
*packet
);
326 /* Returns the id of the numa node the 'netdev' is on. If there is no
327 * such info, returns NETDEV_NUMA_UNSPEC. */
328 int (*get_numa_id
)(const struct netdev
*netdev
);
330 /* Configures the number of tx queues of 'netdev'. Returns 0 if successful,
331 * otherwise a positive errno value.
333 * 'n_txq' specifies the exact number of transmission queues to create.
335 * The caller will call netdev_reconfigure() (if necessary) before using
336 * netdev_send() on any of the newly configured queues, giving the provider
337 * a chance to adjust its settings.
339 * On error, the tx queue configuration is unchanged. */
340 int (*set_tx_multiq
)(struct netdev
*netdev
, unsigned int n_txq
);
342 /* Sends buffers on 'netdev'.
343 * Returns 0 if successful (for every buffer), otherwise a positive errno
344 * value. Returns EAGAIN without blocking if one or more packets cannot be
345 * queued immediately. Returns EMSGSIZE if a partial packet was transmitted
346 * or if a packet is too big or too small to transmit on the device.
348 * If the function returns a non-zero value, some of the packets might have
351 * The caller transfers ownership of all the packets to the network
352 * device, regardless of success.
354 * If 'concurrent_txq' is true, the caller may perform concurrent calls
355 * to netdev_send() with the same 'qid'. The netdev provider is responsible
356 * for making sure that these concurrent calls do not create a race
357 * condition by using locking or other synchronization if required.
359 * The network device is expected to maintain one or more packet
360 * transmission queues, so that the caller does not ordinarily have to
361 * do additional queuing of packets. 'qid' specifies the queue to use
362 * and can be ignored if the implementation does not support multiple
365 * May return EOPNOTSUPP if a network device does not implement packet
366 * transmission through this interface. This function may be set to null
367 * if it would always return EOPNOTSUPP anyhow. (This will prevent the
368 * network device from being usefully used by the netdev-based "userspace
369 * datapath". It will also prevent the OVS implementation of bonding from
370 * working properly over 'netdev'.) */
371 int (*send
)(struct netdev
*netdev
, int qid
, struct dp_packet_batch
*batch
,
372 bool concurrent_txq
);
374 /* Registers with the poll loop to wake up from the next call to
375 * poll_block() when the packet transmission queue for 'netdev' has
376 * sufficient room to transmit a packet with netdev_send().
378 * The network device is expected to maintain one or more packet
379 * transmission queues, so that the caller does not ordinarily have to
380 * do additional queuing of packets. 'qid' specifies the queue to use
381 * and can be ignored if the implementation does not support multiple
384 * May be null if not needed, such as for a network device that does not
385 * implement packet transmission through the 'send' member function. */
386 void (*send_wait
)(struct netdev
*netdev
, int qid
);
388 /* Sets 'netdev''s Ethernet address to 'mac' */
389 int (*set_etheraddr
)(struct netdev
*netdev
, const struct eth_addr mac
);
391 /* Retrieves 'netdev''s Ethernet address into 'mac'.
393 * This address will be advertised as 'netdev''s MAC address through the
394 * OpenFlow protocol, among other uses. */
395 int (*get_etheraddr
)(const struct netdev
*netdev
, struct eth_addr
*mac
);
397 /* Retrieves 'netdev''s MTU into '*mtup'.
399 * The MTU is the maximum size of transmitted (and received) packets, in
400 * bytes, not including the hardware header; thus, this is typically 1500
401 * bytes for Ethernet devices.
403 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
404 * this function should return EOPNOTSUPP. This function may be set to
405 * null if it would always return EOPNOTSUPP. */
406 int (*get_mtu
)(const struct netdev
*netdev
, int *mtup
);
408 /* Sets 'netdev''s MTU to 'mtu'.
410 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
411 * this function should return EOPNOTSUPP. This function may be set to
412 * null if it would always return EOPNOTSUPP. */
413 int (*set_mtu
)(struct netdev
*netdev
, int mtu
);
415 /* Returns the ifindex of 'netdev', if successful, as a positive number.
416 * On failure, returns a negative errno value.
418 * The desired semantics of the ifindex value are a combination of those
419 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
420 * ifindex value should be unique within a host and remain stable at least
421 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
422 * ifNumber" but many systems do not follow this rule anyhow.
424 * This function may be set to null if it would always return -EOPNOTSUPP.
426 int (*get_ifindex
)(const struct netdev
*netdev
);
428 /* Sets 'carrier' to true if carrier is active (link light is on) on
431 * May be null if device does not provide carrier status (will be always
432 * up as long as device is up).
434 int (*get_carrier
)(const struct netdev
*netdev
, bool *carrier
);
436 /* Returns the number of times 'netdev''s carrier has changed since being
439 * If null, callers will assume the number of carrier resets is zero. */
440 long long int (*get_carrier_resets
)(const struct netdev
*netdev
);
442 /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
443 * instead of checking 'netdev''s carrier. 'netdev''s MII registers will
444 * be polled once every 'interval' milliseconds. If 'netdev' does not
445 * support MII, another method may be used as a fallback. If 'interval' is
446 * less than or equal to zero, reverts ->get_carrier() to its normal
449 * Most network devices won't support this feature and will set this
450 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
452 int (*set_miimon_interval
)(struct netdev
*netdev
, long long int interval
);
454 /* Retrieves current device stats for 'netdev' into 'stats'.
456 * A network device that supports some statistics but not others, it should
457 * set the values of the unsupported statistics to all-1-bits
459 int (*get_stats
)(const struct netdev
*netdev
, struct netdev_stats
*);
461 /* Retrieves current device custom stats for 'netdev' into 'custom_stats'.
463 * A network device should return only available statistics (if any).
464 * If there are not statistics available, empty array should be
467 * The caller initializes 'custom_stats' before calling this function.
468 * The caller takes ownership over allocated array of counters inside
469 * structure netdev_custom_stats.
471 int (*get_custom_stats
)(const struct netdev
*netdev
,
472 struct netdev_custom_stats
*custom_stats
);
474 /* Stores the features supported by 'netdev' into each of '*current',
475 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
478 * This function may be set to null if it would always return EOPNOTSUPP.
480 int (*get_features
)(const struct netdev
*netdev
,
481 enum netdev_features
*current
,
482 enum netdev_features
*advertised
,
483 enum netdev_features
*supported
,
484 enum netdev_features
*peer
);
486 /* Set the features advertised by 'netdev' to 'advertise', which is a
487 * set of NETDEV_F_* bits.
489 * This function may be set to null for a network device that does not
490 * support configuring advertisements. */
491 int (*set_advertisements
)(struct netdev
*netdev
,
492 enum netdev_features advertise
);
494 /* Returns 'netdev''s configured packet_type mode.
496 * This function may be set to null if it would always return
497 * NETDEV_PT_LEGACY_L2. */
498 enum netdev_pt_mode (*get_pt_mode
)(const struct netdev
*netdev
);
500 /* Attempts to set input rate limiting (policing) policy, such that up to
501 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
502 * burst size of 'kbits' kb.
504 * This function may be set to null if policing is not supported. */
505 int (*set_policing
)(struct netdev
*netdev
, unsigned int kbits_rate
,
506 unsigned int kbits_burst
);
508 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
509 * it empty if 'netdev' does not support QoS. Any names added to 'types'
510 * should be documented as valid for the "type" column in the "QoS" table
511 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
513 * Every network device must support disabling QoS with a type of "", but
514 * this function must not add "" to 'types'.
516 * The caller is responsible for initializing 'types' (e.g. with
517 * sset_init()) before calling this function. The caller retains ownership
520 * May be NULL if 'netdev' does not support QoS at all. */
521 int (*get_qos_types
)(const struct netdev
*netdev
, struct sset
*types
);
523 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
524 * QoS. On success, initializes 'caps' with the QoS capabilities.
526 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
527 * NULL if 'netdev' does not support QoS at all. */
528 int (*get_qos_capabilities
)(const struct netdev
*netdev
,
530 struct netdev_qos_capabilities
*caps
);
532 /* Queries 'netdev' about its currently configured form of QoS. If
533 * successful, stores the name of the current form of QoS into '*typep'
534 * and any details of configuration as string key-value pairs in
537 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
539 * The caller initializes 'details' before calling this function. The
540 * caller takes ownership of the string key-values pairs added to
543 * The netdev retains ownership of '*typep'.
545 * '*typep' will be one of the types returned by netdev_get_qos_types() for
546 * 'netdev'. The contents of 'details' should be documented as valid for
547 * '*typep' in the "other_config" column in the "QoS" table in
548 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
550 * May be NULL if 'netdev' does not support QoS at all. */
551 int (*get_qos
)(const struct netdev
*netdev
,
552 const char **typep
, struct smap
*details
);
554 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
555 * 'type' with details of configuration from 'details'.
557 * On error, the previous QoS configuration is retained.
559 * When this function changes the type of QoS (not just 'details'), this
560 * also resets all queue configuration for 'netdev' to their defaults
561 * (which depend on the specific type of QoS). Otherwise, the queue
562 * configuration for 'netdev' is unchanged.
564 * 'type' should be "" (to disable QoS) or one of the types returned by
565 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
566 * be documented as valid for the given 'type' in the "other_config" column
567 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
568 * ovs-vswitchd.conf.db(8)).
570 * May be NULL if 'netdev' does not support QoS at all. */
571 int (*set_qos
)(struct netdev
*netdev
,
572 const char *type
, const struct smap
*details
);
574 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
575 * If successful, adds that information as string key-value pairs to
576 * 'details'. Returns 0 if successful, otherwise a positive errno value.
578 * Should return EINVAL if 'queue_id' is greater than or equal to the
579 * number of supported queues (as reported in the 'n_queues' member of
580 * struct netdev_qos_capabilities by 'get_qos_capabilities').
582 * The caller initializes 'details' before calling this function. The
583 * caller takes ownership of the string key-values pairs added to
586 * The returned contents of 'details' should be documented as valid for the
587 * given 'type' in the "other_config" column in the "Queue" table in
588 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
590 int (*get_queue
)(const struct netdev
*netdev
,
591 unsigned int queue_id
, struct smap
*details
);
593 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
594 * string pairs in 'details'. The contents of 'details' should be
595 * documented as valid for the given 'type' in the "other_config" column in
596 * the "Queue" table in vswitchd/vswitch.xml (which is built as
597 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
598 * errno value. On failure, the given queue's configuration should be
601 * Should return EINVAL if 'queue_id' is greater than or equal to the
602 * number of supported queues (as reported in the 'n_queues' member of
603 * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if
604 * 'details' is invalid for the type of queue.
606 * This function does not modify 'details', and the caller retains
609 * May be NULL if 'netdev' does not support QoS at all. */
610 int (*set_queue
)(struct netdev
*netdev
,
611 unsigned int queue_id
, const struct smap
*details
);
613 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
615 * Should return EINVAL if 'queue_id' is greater than or equal to the
616 * number of supported queues (as reported in the 'n_queues' member of
617 * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should
618 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
619 * 'netdev' has a fixed set of queues with the current QoS mode).
621 * May be NULL if 'netdev' does not support QoS at all, or if all of its
622 * QoS modes have fixed sets of queues. */
623 int (*delete_queue
)(struct netdev
*netdev
, unsigned int queue_id
);
625 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
626 * queue's statistics. May set individual members of 'stats' to all-1-bits
627 * if the statistic is unavailable.
629 * May be NULL if 'netdev' does not support QoS at all. */
630 int (*get_queue_stats
)(const struct netdev
*netdev
, unsigned int queue_id
,
631 struct netdev_queue_stats
*stats
);
633 /* Attempts to begin dumping the queues in 'netdev'. On success, returns 0
634 * and initializes '*statep' with any data needed for iteration. On
635 * failure, returns a positive errno value.
637 * May be NULL if 'netdev' does not support QoS at all. */
638 int (*queue_dump_start
)(const struct netdev
*netdev
, void **statep
);
640 /* Attempts to retrieve another queue from 'netdev' for 'state', which was
641 * initialized by a successful call to the 'queue_dump_start' function for
642 * 'netdev'. On success, stores a queue ID into '*queue_id' and fills
643 * 'details' with the configuration of the queue with that ID. Returns EOF
644 * if the last queue has been dumped, or a positive errno value on error.
645 * This function will not be called again once it returns nonzero once for
646 * a given iteration (but the 'queue_dump_done' function will be called
649 * The caller initializes and clears 'details' before calling this
650 * function. The caller takes ownership of the string key-values pairs
651 * added to 'details'.
653 * The returned contents of 'details' should be documented as valid for the
654 * given 'type' in the "other_config" column in the "Queue" table in
655 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
657 * May be NULL if 'netdev' does not support QoS at all. */
658 int (*queue_dump_next
)(const struct netdev
*netdev
, void *state
,
659 unsigned int *queue_id
, struct smap
*details
);
661 /* Releases resources from 'netdev' for 'state', which was initialized by a
662 * successful call to the 'queue_dump_start' function for 'netdev'.
664 * May be NULL if 'netdev' does not support QoS at all. */
665 int (*queue_dump_done
)(const struct netdev
*netdev
, void *state
);
667 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
668 * ID, its statistics, and the 'aux' specified by the caller. The order of
669 * iteration is unspecified, but (when successful) each queue must be
670 * visited exactly once.
672 * 'cb' will not modify or free the statistics passed in. */
673 int (*dump_queue_stats
)(const struct netdev
*netdev
,
674 void (*cb
)(unsigned int queue_id
,
675 struct netdev_queue_stats
*,
679 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
680 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
682 * This function may be set to null if it would always return EOPNOTSUPP
684 int (*set_in4
)(struct netdev
*netdev
, struct in_addr addr
,
685 struct in_addr mask
);
687 /* Returns all assigned IP address to 'netdev' and returns 0.
688 * API allocates array of address and masks and set it to
689 * '*addr' and '*mask'.
690 * Otherwise, returns a positive errno value and sets '*addr', '*mask
691 * and '*n_addr' to NULL.
693 * The following error values have well-defined meanings:
695 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
697 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
699 * 'addr' may be null, in which case the address itself is not reported. */
700 int (*get_addr_list
)(const struct netdev
*netdev
, struct in6_addr
**in
,
701 struct in6_addr
**mask
, int *n_in6
);
703 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
704 * corresponds to 'netdev'.
706 * This function may be set to null if it would always return EOPNOTSUPP
708 int (*add_router
)(struct netdev
*netdev
, struct in_addr router
);
710 /* Looks up the next hop for 'host' in the host's routing table. If
711 * successful, stores the next hop gateway's address (0 if 'host' is on a
712 * directly connected network) in '*next_hop' and a copy of the name of the
713 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
714 * responsible for freeing '*netdev_name' (by calling free()).
716 * This function may be set to null if it would always return EOPNOTSUPP
718 int (*get_next_hop
)(const struct in_addr
*host
, struct in_addr
*next_hop
,
721 /* Retrieves driver information of the device.
723 * Populates 'smap' with key-value pairs representing the status of the
724 * device. 'smap' is a set of key-value string pairs representing netdev
725 * type specific information. For more information see
726 * ovs-vswitchd.conf.db(5).
728 * The caller is responsible for destroying 'smap' and its data.
730 * This function may be set to null if it would always return EOPNOTSUPP
732 int (*get_status
)(const struct netdev
*netdev
, struct smap
*smap
);
734 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
735 * corresponding MAC address in 'mac'. A return value of ENXIO, in
736 * particular, indicates that there is no ARP table entry for 'ip' on
739 * This function may be set to null if it would always return EOPNOTSUPP
741 int (*arp_lookup
)(const struct netdev
*netdev
, ovs_be32 ip
,
742 struct eth_addr
*mac
);
744 /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then,
745 * turns off the flags that are set to 1 in 'off' and turns on the flags
746 * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and
747 * 'on'; that is, off & on == 0.)
749 * This function may be invoked from a signal handler. Therefore, it
750 * should not do anything that is not signal-safe (such as logging). */
751 int (*update_flags
)(struct netdev
*netdev
, enum netdev_flags off
,
752 enum netdev_flags on
, enum netdev_flags
*old_flags
);
754 /* If the provider called netdev_request_reconfigure(), the upper layer
755 * will eventually call this. The provider can update the device
756 * configuration knowing that the upper layer will not call rxq_recv() or
757 * send() until this function returns.
759 * On error, the configuration is indeterminant and the device cannot be
760 * used to send and receive packets until a successful configuration is
762 int (*reconfigure
)(struct netdev
*netdev
);
763 /* ## -------------------- ## */
764 /* ## netdev_rxq Functions ## */
765 /* ## -------------------- ## */
767 /* If a particular netdev class does not support receiving packets, all these
768 * function pointers must be NULL. */
770 /* Life-cycle functions for a netdev_rxq. See the large comment above on
771 * struct netdev_class. */
772 struct netdev_rxq
*(*rxq_alloc
)(void);
773 int (*rxq_construct
)(struct netdev_rxq
*);
774 void (*rxq_destruct
)(struct netdev_rxq
*);
775 void (*rxq_dealloc
)(struct netdev_rxq
*);
777 /* Retrieves the current state of rx queue. 'false' means that queue won't
778 * get traffic in a short term and could be not polled.
780 * This function may be set to null if it would always return 'true'
782 bool (*rxq_enabled
)(struct netdev_rxq
*);
784 /* Attempts to receive a batch of packets from 'rx'. In 'batch', the
785 * caller supplies 'packets' as the pointer to the beginning of an array
786 * of NETDEV_MAX_BURST pointers to dp_packet. If successful, the
787 * implementation stores pointers to up to NETDEV_MAX_BURST dp_packets into
788 * the array, transferring ownership of the packets to the caller, stores
789 * the number of received packets into 'count', and returns 0.
791 * The implementation does not necessarily initialize any non-data members
792 * of 'packets' in 'batch'. That is, the caller must initialize layer
793 * pointers and metadata itself, if desired, e.g. with pkt_metadata_init()
794 * and miniflow_extract().
796 * Implementations should allocate buffers with DP_NETDEV_HEADROOM bytes of
799 * If the caller provides a non-NULL qfill pointer, the implementation
800 * should return the number (zero or more) of remaining packets in the
801 * queue after the reception the current batch, if it supports that,
802 * or -ENOTSUP otherwise.
804 * Returns EAGAIN immediately if no packet is ready to be received or
805 * another positive errno value if an error was encountered. */
806 int (*rxq_recv
)(struct netdev_rxq
*rx
, struct dp_packet_batch
*batch
,
809 /* Registers with the poll loop to wake up from the next call to
810 * poll_block() when a packet is ready to be received with
811 * netdev_rxq_recv() on 'rx'. */
812 void (*rxq_wait
)(struct netdev_rxq
*rx
);
814 /* Discards all packets waiting to be received from 'rx'. */
815 int (*rxq_drain
)(struct netdev_rxq
*rx
);
817 /* Get a block_id from the netdev.
818 * Returns the block_id or 0 if none exists for netdev. */
819 uint32_t (*get_block_id
)(struct netdev
*);
822 int netdev_register_provider(const struct netdev_class
*);
823 int netdev_unregister_provider(const char *type
);
825 #if defined(__FreeBSD__) || defined(__NetBSD__)
826 extern const struct netdev_class netdev_bsd_class
;
827 #elif defined(_WIN32)
828 extern const struct netdev_class netdev_windows_class
;
830 extern const struct netdev_class netdev_linux_class
;
832 extern const struct netdev_class netdev_internal_class
;
833 extern const struct netdev_class netdev_tap_class
;
839 #endif /* netdev.h */