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 enum netdev_ol_flags
{
41 NETDEV_TX_OFFLOAD_IPV4_CKSUM
= 1 << 0,
42 NETDEV_TX_OFFLOAD_TCP_CKSUM
= 1 << 1,
43 NETDEV_TX_OFFLOAD_UDP_CKSUM
= 1 << 2,
44 NETDEV_TX_OFFLOAD_TCP_TSO
= 1 << 3,
47 /* A network device (e.g. an Ethernet device).
49 * Network device implementations may read these members but should not modify
52 /* The following do not change during the lifetime of a struct netdev. */
53 char *name
; /* Name of network device. */
54 const struct netdev_class
*netdev_class
; /* Functions to control
57 /* If this is 'true' the user did not specify a netdev_class when
58 * opening this device, and therefore got assigned to the "system" class */
61 /* This bitmask of the offloading features enabled by the netdev. */
64 /* If this is 'true', the user explicitly specified an MTU for this
65 * netdev. Otherwise, Open vSwitch is allowed to override it. */
68 int ref_cnt
; /* Times this devices was opened. */
70 /* A sequence number which indicates changes in one of 'netdev''s
71 * properties. It must be nonzero so that users have a value which
72 * they may use as a reset when tracking 'netdev'.
74 * Minimally, the sequence number is required to change whenever
75 * 'netdev''s flags, features, ethernet address, or carrier changes. */
76 atomic_uint64_t change_seq
;
78 /* A netdev provider might be unable to change some of the device's
79 * parameter (n_rxq, mtu) when the device is in use. In this case
80 * the provider can notify the upper layer by calling
81 * netdev_request_reconfigure(). The upper layer will react by stopping
82 * the operations on the device and calling netdev_reconfigure() to allow
83 * the configuration changes. 'last_reconfigure_seq' remembers the value
84 * of 'reconfigure_seq' when the last reconfiguration happened. */
85 struct seq
*reconfigure_seq
;
86 uint64_t last_reconfigure_seq
;
88 /* The core netdev code initializes these at netdev construction and only
89 * provide read-only access to its client. Netdev implementations may
93 struct shash_node
*node
; /* Pointer to element in global map. */
94 struct ovs_list saved_flags_list
; /* Contains "struct netdev_saved_flags". */
96 /* Functions to control flow offloading. */
97 OVSRCU_TYPE(const struct netdev_flow_api
*) flow_api
;
98 struct netdev_hw_info hw_info
; /* offload-capable netdev info */
102 netdev_change_seq_changed(const struct netdev
*netdev_
)
105 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
106 seq_change(connectivity_seq_get());
108 atomic_read_relaxed(&netdev
->change_seq
, &change_seq
);
110 if (OVS_UNLIKELY(!change_seq
)) {
113 atomic_store_explicit(&netdev
->change_seq
, change_seq
,
114 memory_order_release
);
118 netdev_request_reconfigure(struct netdev
*netdev
)
120 seq_change(netdev
->reconfigure_seq
);
123 const char *netdev_get_type(const struct netdev
*);
124 const struct netdev_class
*netdev_get_class(const struct netdev
*);
125 const char *netdev_get_name(const struct netdev
*);
126 struct netdev
*netdev_from_name(const char *name
);
127 void netdev_get_devices(const struct netdev_class
*,
128 struct shash
*device_list
);
129 struct netdev
**netdev_get_vports(size_t *size
);
131 /* A data structure for capturing packets received by a network device.
133 * Network device implementations may read these members but should not modify
136 * None of these members change during the lifetime of a struct netdev_rxq. */
138 struct netdev
*netdev
; /* Owns a reference to the netdev. */
142 struct netdev
*netdev_rxq_get_netdev(const struct netdev_rxq
*);
145 /* Network device class structure, to be defined by each implementation of a
148 * These functions return 0 if successful or a positive errno value on failure,
149 * except where otherwise noted.
155 * These functions work primarily with two different kinds of data structures:
157 * - "struct netdev", which represents a network device.
159 * - "struct netdev_rxq", which represents a handle for capturing packets
160 * received on a network device
162 * Each of these data structures contains all of the implementation-independent
163 * generic state for the respective concept, called the "base" state. None of
164 * them contains any extra space for implementations to use. Instead, each
165 * implementation is expected to declare its own data structure that contains
166 * an instance of the generic data structure plus additional
167 * implementation-specific members, called the "derived" state. The
168 * implementation can use casts or (preferably) the CONTAINER_OF macro to
169 * obtain access to derived state given only a pointer to the embedded generic
176 * Four stylized functions accompany each of these data structures:
178 * "alloc" "construct" "destruct" "dealloc"
179 * ------------ ---------------- --------------- --------------
180 * netdev ->alloc ->construct ->destruct ->dealloc
181 * netdev_rxq ->rxq_alloc ->rxq_construct ->rxq_destruct ->rxq_dealloc
183 * Any instance of a given data structure goes through the following life
186 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
187 * fails, skip all the other steps.
189 * 2. The client initializes all of the data structure's base state. If this
190 * fails, skip to step 7.
192 * 3. The client calls the "construct" function. The implementation
193 * initializes derived state. It may refer to the already-initialized
194 * base state. If "construct" fails, skip to step 6.
196 * 4. The data structure is now initialized and in use.
198 * 5. When the data structure is no longer needed, the client calls the
199 * "destruct" function. The implementation uninitializes derived state.
200 * The base state has not been uninitialized yet, so the implementation
201 * may still refer to it.
203 * 6. The client uninitializes all of the data structure's base state.
205 * 7. The client calls the "dealloc" to free the raw memory. The
206 * implementation must not refer to base or derived state in the data
207 * structure, because it has already been uninitialized.
209 * If netdev support multi-queue IO then netdev->construct should set initialize
210 * netdev->n_rxq to number of queues.
212 * Each "alloc" function allocates and returns a new instance of the respective
213 * data structure. The "alloc" function is not given any information about the
214 * use of the new data structure, so it cannot perform much initialization.
215 * Its purpose is just to ensure that the new data structure has enough room
216 * for base and derived state. It may return a null pointer if memory is not
217 * available, in which case none of the other functions is called.
219 * Each "construct" function initializes derived state in its respective data
220 * structure. When "construct" is called, all of the base state has already
221 * been initialized, so the "construct" function may refer to it. The
222 * "construct" function is allowed to fail, in which case the client calls the
223 * "dealloc" function (but not the "destruct" function).
225 * Each "destruct" function uninitializes and frees derived state in its
226 * respective data structure. When "destruct" is called, the base state has
227 * not yet been uninitialized, so the "destruct" function may refer to it. The
228 * "destruct" function is not allowed to fail.
230 * Each "dealloc" function frees raw memory that was allocated by the
231 * "alloc" function. The memory's base and derived members might not have ever
232 * been initialized (but if "construct" returned successfully, then it has been
233 * "destruct"ed already). The "dealloc" function is not allowed to fail.
236 * Device Change Notification
237 * ==========================
239 * Minimally, implementations are required to report changes to netdev flags,
240 * features, ethernet address or carrier through connectivity_seq. Changes to
241 * other properties are allowed to cause notification through this interface,
242 * although implementations should try to avoid this. connectivity_seq_get()
243 * can be used to acquire a reference to the struct seq. The interface is
244 * described in detail in seq.h. */
245 struct netdev_class
{
246 /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
248 * One of the providers should supply a "system" type, since this is
249 * the type assumed if no type is specified when opening a netdev.
250 * The "system" type corresponds to an existing network device on
254 /* If 'true' then this netdev should be polled by PMD threads. */
257 /* ## ------------------- ## */
258 /* ## Top-Level Functions ## */
259 /* ## ------------------- ## */
261 /* Called when the netdev provider is registered, typically at program
262 * startup. Returning an error from this function will prevent any network
263 * device in this class from being opened.
265 * This function may be set to null if a network device class needs no
266 * initialization at registration time. */
269 /* Performs periodic work needed by netdevs of this class. May be null if
270 * no periodic work is necessary.
272 * 'netdev_class' points to the class. It is useful in case the same
273 * function is used to implement different classes. */
274 void (*run
)(const struct netdev_class
*netdev_class
);
276 /* Arranges for poll_block() to wake up if the "run" member function needs
277 * to be called. Implementations are additionally required to wake
278 * whenever something changes in any of its netdevs which would cause their
279 * ->change_seq() function to change its result. May be null if nothing is
282 * 'netdev_class' points to the class. It is useful in case the same
283 * function is used to implement different classes. */
284 void (*wait
)(const struct netdev_class
*netdev_class
);
286 /* ## ---------------- ## */
287 /* ## netdev Functions ## */
288 /* ## ---------------- ## */
290 /* Life-cycle functions for a netdev. See the large comment above on
291 * struct netdev_class. */
292 struct netdev
*(*alloc
)(void);
293 int (*construct
)(struct netdev
*);
294 void (*destruct
)(struct netdev
*);
295 void (*dealloc
)(struct netdev
*);
297 /* Fetches the device 'netdev''s configuration, storing it in 'args'.
298 * The caller owns 'args' and pre-initializes it to an empty smap.
300 * If this netdev class does not have any configuration options, this may
301 * be a null pointer. */
302 int (*get_config
)(const struct netdev
*netdev
, struct smap
*args
);
304 /* Changes the device 'netdev''s configuration to 'args'.
306 * If this netdev class does not support configuration, this may be a null
309 * If the return value is not zero (meaning that an error occurred),
310 * the provider can allocate a string with an error message in '*errp'.
311 * The caller has to call free on it. */
312 int (*set_config
)(struct netdev
*netdev
, const struct smap
*args
,
315 /* Returns the tunnel configuration of 'netdev'. If 'netdev' is
316 * not a tunnel, returns null.
318 * If this function would always return null, it may be null instead. */
319 const struct netdev_tunnel_config
*
320 (*get_tunnel_config
)(const struct netdev
*netdev
);
322 /* Build Tunnel header. Ethernet and ip header parameters are passed to
323 * tunnel implementation to build entire outer header for given flow. */
324 int (*build_header
)(const struct netdev
*, struct ovs_action_push_tnl
*data
,
325 const struct netdev_tnl_build_header_params
*params
);
327 /* build_header() can not build entire header for all packets for given
328 * flow. Push header is called for packet to build header specific to
329 * a packet on actual transmit. It uses partial header build by
330 * build_header() which is passed as data. */
331 void (*push_header
)(const struct netdev
*,
332 struct dp_packet
*packet
,
333 const struct ovs_action_push_tnl
*data
);
335 /* Pop tunnel header from packet, build tunnel metadata and resize packet
336 * for further processing.
337 * Returns NULL in case of error or tunnel implementation queued packet for further
339 struct dp_packet
* (*pop_header
)(struct dp_packet
*packet
);
341 /* Returns the id of the numa node the 'netdev' is on. If there is no
342 * such info, returns NETDEV_NUMA_UNSPEC. */
343 int (*get_numa_id
)(const struct netdev
*netdev
);
345 /* Configures the number of tx queues of 'netdev'. Returns 0 if successful,
346 * otherwise a positive errno value.
348 * 'n_txq' specifies the exact number of transmission queues to create.
350 * The caller will call netdev_reconfigure() (if necessary) before using
351 * netdev_send() on any of the newly configured queues, giving the provider
352 * a chance to adjust its settings.
354 * On error, the tx queue configuration is unchanged. */
355 int (*set_tx_multiq
)(struct netdev
*netdev
, unsigned int n_txq
);
357 /* Sends buffers on 'netdev'.
358 * Returns 0 if successful (for every buffer), otherwise a positive errno
359 * value. Returns EAGAIN without blocking if one or more packets cannot be
360 * queued immediately. Returns EMSGSIZE if a partial packet was transmitted
361 * or if a packet is too big or too small to transmit on the device.
363 * If the function returns a non-zero value, some of the packets might have
366 * The caller transfers ownership of all the packets to the network
367 * device, regardless of success.
369 * If 'concurrent_txq' is true, the caller may perform concurrent calls
370 * to netdev_send() with the same 'qid'. The netdev provider is responsible
371 * for making sure that these concurrent calls do not create a race
372 * condition by using locking or other synchronization if required.
374 * The network device is expected to maintain one or more packet
375 * transmission queues, so that the caller does not ordinarily have to
376 * do additional queuing of packets. 'qid' specifies the queue to use
377 * and can be ignored if the implementation does not support multiple
380 * May return EOPNOTSUPP if a network device does not implement packet
381 * transmission through this interface. This function may be set to null
382 * if it would always return EOPNOTSUPP anyhow. (This will prevent the
383 * network device from being usefully used by the netdev-based "userspace
384 * datapath". It will also prevent the OVS implementation of bonding from
385 * working properly over 'netdev'.) */
386 int (*send
)(struct netdev
*netdev
, int qid
, struct dp_packet_batch
*batch
,
387 bool concurrent_txq
);
389 /* Registers with the poll loop to wake up from the next call to
390 * poll_block() when the packet transmission queue for 'netdev' has
391 * sufficient room to transmit a packet with netdev_send().
393 * The network device is expected to maintain one or more packet
394 * transmission queues, so that the caller does not ordinarily have to
395 * do additional queuing of packets. 'qid' specifies the queue to use
396 * and can be ignored if the implementation does not support multiple
399 * May be null if not needed, such as for a network device that does not
400 * implement packet transmission through the 'send' member function. */
401 void (*send_wait
)(struct netdev
*netdev
, int qid
);
403 /* Sets 'netdev''s Ethernet address to 'mac' */
404 int (*set_etheraddr
)(struct netdev
*netdev
, const struct eth_addr mac
);
406 /* Retrieves 'netdev''s Ethernet address into 'mac'.
408 * This address will be advertised as 'netdev''s MAC address through the
409 * OpenFlow protocol, among other uses. */
410 int (*get_etheraddr
)(const struct netdev
*netdev
, struct eth_addr
*mac
);
412 /* Retrieves 'netdev''s MTU into '*mtup'.
414 * The MTU is the maximum size of transmitted (and received) packets, in
415 * bytes, not including the hardware header; thus, this is typically 1500
416 * bytes for Ethernet devices.
418 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
419 * this function should return EOPNOTSUPP. This function may be set to
420 * null if it would always return EOPNOTSUPP. */
421 int (*get_mtu
)(const struct netdev
*netdev
, int *mtup
);
423 /* Sets 'netdev''s MTU to 'mtu'.
425 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
426 * this function should return EOPNOTSUPP. This function may be set to
427 * null if it would always return EOPNOTSUPP. */
428 int (*set_mtu
)(struct netdev
*netdev
, int mtu
);
430 /* Returns the ifindex of 'netdev', if successful, as a positive number.
431 * On failure, returns a negative errno value.
433 * The desired semantics of the ifindex value are a combination of those
434 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
435 * ifindex value should be unique within a host and remain stable at least
436 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
437 * ifNumber" but many systems do not follow this rule anyhow.
439 * This function may be set to null if it would always return -EOPNOTSUPP.
441 int (*get_ifindex
)(const struct netdev
*netdev
);
443 /* Sets 'carrier' to true if carrier is active (link light is on) on
446 * May be null if device does not provide carrier status (will be always
447 * up as long as device is up).
449 int (*get_carrier
)(const struct netdev
*netdev
, bool *carrier
);
451 /* Returns the number of times 'netdev''s carrier has changed since being
454 * If null, callers will assume the number of carrier resets is zero. */
455 long long int (*get_carrier_resets
)(const struct netdev
*netdev
);
457 /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
458 * instead of checking 'netdev''s carrier. 'netdev''s MII registers will
459 * be polled once every 'interval' milliseconds. If 'netdev' does not
460 * support MII, another method may be used as a fallback. If 'interval' is
461 * less than or equal to zero, reverts ->get_carrier() to its normal
464 * Most network devices won't support this feature and will set this
465 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
467 int (*set_miimon_interval
)(struct netdev
*netdev
, long long int interval
);
469 /* Retrieves current device stats for 'netdev' into 'stats'.
471 * A network device that supports some statistics but not others, it should
472 * set the values of the unsupported statistics to all-1-bits
474 int (*get_stats
)(const struct netdev
*netdev
, struct netdev_stats
*);
476 /* Retrieves current device custom stats for 'netdev' into 'custom_stats'.
478 * A network device should return only available statistics (if any).
479 * If there are not statistics available, empty array should be
482 * The caller initializes 'custom_stats' before calling this function.
483 * The caller takes ownership over allocated array of counters inside
484 * structure netdev_custom_stats.
486 int (*get_custom_stats
)(const struct netdev
*netdev
,
487 struct netdev_custom_stats
*custom_stats
);
489 /* Stores the features supported by 'netdev' into each of '*current',
490 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
493 * This function may be set to null if it would always return EOPNOTSUPP.
495 int (*get_features
)(const struct netdev
*netdev
,
496 enum netdev_features
*current
,
497 enum netdev_features
*advertised
,
498 enum netdev_features
*supported
,
499 enum netdev_features
*peer
);
501 /* Set the features advertised by 'netdev' to 'advertise', which is a
502 * set of NETDEV_F_* bits.
504 * This function may be set to null for a network device that does not
505 * support configuring advertisements. */
506 int (*set_advertisements
)(struct netdev
*netdev
,
507 enum netdev_features advertise
);
509 /* Returns 'netdev''s configured packet_type mode.
511 * This function may be set to null if it would always return
512 * NETDEV_PT_LEGACY_L2. */
513 enum netdev_pt_mode (*get_pt_mode
)(const struct netdev
*netdev
);
515 /* Attempts to set input rate limiting (policing) policy, such that up to
516 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
517 * burst size of 'kbits' kb.
519 * This function may be set to null if policing is not supported. */
520 int (*set_policing
)(struct netdev
*netdev
, unsigned int kbits_rate
,
521 unsigned int kbits_burst
);
523 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
524 * it empty if 'netdev' does not support QoS. Any names added to 'types'
525 * should be documented as valid for the "type" column in the "QoS" table
526 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
528 * Every network device must support disabling QoS with a type of "", but
529 * this function must not add "" to 'types'.
531 * The caller is responsible for initializing 'types' (e.g. with
532 * sset_init()) before calling this function. The caller retains ownership
535 * May be NULL if 'netdev' does not support QoS at all. */
536 int (*get_qos_types
)(const struct netdev
*netdev
, struct sset
*types
);
538 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
539 * QoS. On success, initializes 'caps' with the QoS capabilities.
541 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
542 * NULL if 'netdev' does not support QoS at all. */
543 int (*get_qos_capabilities
)(const struct netdev
*netdev
,
545 struct netdev_qos_capabilities
*caps
);
547 /* Queries 'netdev' about its currently configured form of QoS. If
548 * successful, stores the name of the current form of QoS into '*typep'
549 * and any details of configuration as string key-value pairs in
552 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
554 * The caller initializes 'details' before calling this function. The
555 * caller takes ownership of the string key-values pairs added to
558 * The netdev retains ownership of '*typep'.
560 * '*typep' will be one of the types returned by netdev_get_qos_types() for
561 * 'netdev'. The contents of 'details' should be documented as valid for
562 * '*typep' in the "other_config" column in the "QoS" table in
563 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
565 * May be NULL if 'netdev' does not support QoS at all. */
566 int (*get_qos
)(const struct netdev
*netdev
,
567 const char **typep
, struct smap
*details
);
569 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
570 * 'type' with details of configuration from 'details'.
572 * On error, the previous QoS configuration is retained.
574 * When this function changes the type of QoS (not just 'details'), this
575 * also resets all queue configuration for 'netdev' to their defaults
576 * (which depend on the specific type of QoS). Otherwise, the queue
577 * configuration for 'netdev' is unchanged.
579 * 'type' should be "" (to disable QoS) or one of the types returned by
580 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
581 * be documented as valid for the given 'type' in the "other_config" column
582 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
583 * ovs-vswitchd.conf.db(8)).
585 * May be NULL if 'netdev' does not support QoS at all. */
586 int (*set_qos
)(struct netdev
*netdev
,
587 const char *type
, const struct smap
*details
);
589 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
590 * If successful, adds that information as string key-value pairs to
591 * 'details'. Returns 0 if successful, otherwise a positive errno value.
593 * Should return EINVAL if 'queue_id' is greater than or equal to the
594 * number of supported queues (as reported in the 'n_queues' member of
595 * struct netdev_qos_capabilities by 'get_qos_capabilities').
597 * The caller initializes 'details' before calling this function. The
598 * caller takes ownership of the string key-values pairs added to
601 * The returned contents of 'details' should be documented as valid for the
602 * given 'type' in the "other_config" column in the "Queue" table in
603 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
605 int (*get_queue
)(const struct netdev
*netdev
,
606 unsigned int queue_id
, struct smap
*details
);
608 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
609 * string pairs in 'details'. The contents of 'details' should be
610 * documented as valid for the given 'type' in the "other_config" column in
611 * the "Queue" table in vswitchd/vswitch.xml (which is built as
612 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
613 * errno value. On failure, the given queue's configuration should be
616 * Should return EINVAL if 'queue_id' is greater than or equal to the
617 * number of supported queues (as reported in the 'n_queues' member of
618 * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if
619 * 'details' is invalid for the type of queue.
621 * This function does not modify 'details', and the caller retains
624 * May be NULL if 'netdev' does not support QoS at all. */
625 int (*set_queue
)(struct netdev
*netdev
,
626 unsigned int queue_id
, const struct smap
*details
);
628 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
630 * Should return EINVAL if 'queue_id' is greater than or equal to the
631 * number of supported queues (as reported in the 'n_queues' member of
632 * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should
633 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
634 * 'netdev' has a fixed set of queues with the current QoS mode).
636 * May be NULL if 'netdev' does not support QoS at all, or if all of its
637 * QoS modes have fixed sets of queues. */
638 int (*delete_queue
)(struct netdev
*netdev
, unsigned int queue_id
);
640 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
641 * queue's statistics. May set individual members of 'stats' to all-1-bits
642 * if the statistic is unavailable.
644 * May be NULL if 'netdev' does not support QoS at all. */
645 int (*get_queue_stats
)(const struct netdev
*netdev
, unsigned int queue_id
,
646 struct netdev_queue_stats
*stats
);
648 /* Attempts to begin dumping the queues in 'netdev'. On success, returns 0
649 * and initializes '*statep' with any data needed for iteration. On
650 * failure, returns a positive errno value.
652 * May be NULL if 'netdev' does not support QoS at all. */
653 int (*queue_dump_start
)(const struct netdev
*netdev
, void **statep
);
655 /* Attempts to retrieve another queue from 'netdev' for 'state', which was
656 * initialized by a successful call to the 'queue_dump_start' function for
657 * 'netdev'. On success, stores a queue ID into '*queue_id' and fills
658 * 'details' with the configuration of the queue with that ID. Returns EOF
659 * if the last queue has been dumped, or a positive errno value on error.
660 * This function will not be called again once it returns nonzero once for
661 * a given iteration (but the 'queue_dump_done' function will be called
664 * The caller initializes and clears 'details' before calling this
665 * function. The caller takes ownership of the string key-values pairs
666 * added to 'details'.
668 * The returned contents of 'details' should be documented as valid for the
669 * given 'type' in the "other_config" column in the "Queue" table in
670 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
672 * May be NULL if 'netdev' does not support QoS at all. */
673 int (*queue_dump_next
)(const struct netdev
*netdev
, void *state
,
674 unsigned int *queue_id
, struct smap
*details
);
676 /* Releases resources from 'netdev' for 'state', which was initialized by a
677 * successful call to the 'queue_dump_start' function for 'netdev'.
679 * May be NULL if 'netdev' does not support QoS at all. */
680 int (*queue_dump_done
)(const struct netdev
*netdev
, void *state
);
682 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
683 * ID, its statistics, and the 'aux' specified by the caller. The order of
684 * iteration is unspecified, but (when successful) each queue must be
685 * visited exactly once.
687 * 'cb' will not modify or free the statistics passed in. */
688 int (*dump_queue_stats
)(const struct netdev
*netdev
,
689 void (*cb
)(unsigned int queue_id
,
690 struct netdev_queue_stats
*,
694 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
695 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
697 * This function may be set to null if it would always return EOPNOTSUPP
699 int (*set_in4
)(struct netdev
*netdev
, struct in_addr addr
,
700 struct in_addr mask
);
702 /* Returns all assigned IP address to 'netdev' and returns 0.
703 * API allocates array of address and masks and set it to
704 * '*addr' and '*mask'.
705 * Otherwise, returns a positive errno value and sets '*addr', '*mask
706 * and '*n_addr' to NULL.
708 * The following error values have well-defined meanings:
710 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
712 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
714 * 'addr' may be null, in which case the address itself is not reported. */
715 int (*get_addr_list
)(const struct netdev
*netdev
, struct in6_addr
**in
,
716 struct in6_addr
**mask
, int *n_in6
);
718 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
719 * corresponds to 'netdev'.
721 * This function may be set to null if it would always return EOPNOTSUPP
723 int (*add_router
)(struct netdev
*netdev
, struct in_addr router
);
725 /* Looks up the next hop for 'host' in the host's routing table. If
726 * successful, stores the next hop gateway's address (0 if 'host' is on a
727 * directly connected network) in '*next_hop' and a copy of the name of the
728 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
729 * responsible for freeing '*netdev_name' (by calling free()).
731 * This function may be set to null if it would always return EOPNOTSUPP
733 int (*get_next_hop
)(const struct in_addr
*host
, struct in_addr
*next_hop
,
736 /* Retrieves driver information of the device.
738 * Populates 'smap' with key-value pairs representing the status of the
739 * device. 'smap' is a set of key-value string pairs representing netdev
740 * type specific information. For more information see
741 * ovs-vswitchd.conf.db(5).
743 * The caller is responsible for destroying 'smap' and its data.
745 * This function may be set to null if it would always return EOPNOTSUPP
747 int (*get_status
)(const struct netdev
*netdev
, struct smap
*smap
);
749 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
750 * corresponding MAC address in 'mac'. A return value of ENXIO, in
751 * particular, indicates that there is no ARP table entry for 'ip' on
754 * This function may be set to null if it would always return EOPNOTSUPP
756 int (*arp_lookup
)(const struct netdev
*netdev
, ovs_be32 ip
,
757 struct eth_addr
*mac
);
759 /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then,
760 * turns off the flags that are set to 1 in 'off' and turns on the flags
761 * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and
762 * 'on'; that is, off & on == 0.)
764 * This function may be invoked from a signal handler. Therefore, it
765 * should not do anything that is not signal-safe (such as logging). */
766 int (*update_flags
)(struct netdev
*netdev
, enum netdev_flags off
,
767 enum netdev_flags on
, enum netdev_flags
*old_flags
);
769 /* If the provider called netdev_request_reconfigure(), the upper layer
770 * will eventually call this. The provider can update the device
771 * configuration knowing that the upper layer will not call rxq_recv() or
772 * send() until this function returns.
774 * On error, the configuration is indeterminant and the device cannot be
775 * used to send and receive packets until a successful configuration is
777 int (*reconfigure
)(struct netdev
*netdev
);
778 /* ## -------------------- ## */
779 /* ## netdev_rxq Functions ## */
780 /* ## -------------------- ## */
782 /* If a particular netdev class does not support receiving packets, all these
783 * function pointers must be NULL. */
785 /* Life-cycle functions for a netdev_rxq. See the large comment above on
786 * struct netdev_class. */
787 struct netdev_rxq
*(*rxq_alloc
)(void);
788 int (*rxq_construct
)(struct netdev_rxq
*);
789 void (*rxq_destruct
)(struct netdev_rxq
*);
790 void (*rxq_dealloc
)(struct netdev_rxq
*);
792 /* Retrieves the current state of rx queue. 'false' means that queue won't
793 * get traffic in a short term and could be not polled.
795 * This function may be set to null if it would always return 'true'
797 bool (*rxq_enabled
)(struct netdev_rxq
*);
799 /* Attempts to receive a batch of packets from 'rx'. In 'batch', the
800 * caller supplies 'packets' as the pointer to the beginning of an array
801 * of NETDEV_MAX_BURST pointers to dp_packet. If successful, the
802 * implementation stores pointers to up to NETDEV_MAX_BURST dp_packets into
803 * the array, transferring ownership of the packets to the caller, stores
804 * the number of received packets into 'count', and returns 0.
806 * The implementation does not necessarily initialize any non-data members
807 * of 'packets' in 'batch'. That is, the caller must initialize layer
808 * pointers and metadata itself, if desired, e.g. with pkt_metadata_init()
809 * and miniflow_extract().
811 * Implementations should allocate buffers with DP_NETDEV_HEADROOM bytes of
814 * If the caller provides a non-NULL qfill pointer, the implementation
815 * should return the number (zero or more) of remaining packets in the
816 * queue after the reception the current batch, if it supports that,
817 * or -ENOTSUP otherwise.
819 * Returns EAGAIN immediately if no packet is ready to be received or
820 * another positive errno value if an error was encountered. */
821 int (*rxq_recv
)(struct netdev_rxq
*rx
, struct dp_packet_batch
*batch
,
824 /* Registers with the poll loop to wake up from the next call to
825 * poll_block() when a packet is ready to be received with
826 * netdev_rxq_recv() on 'rx'. */
827 void (*rxq_wait
)(struct netdev_rxq
*rx
);
829 /* Discards all packets waiting to be received from 'rx'. */
830 int (*rxq_drain
)(struct netdev_rxq
*rx
);
832 /* Get a block_id from the netdev.
833 * Returns the block_id or 0 if none exists for netdev. */
834 uint32_t (*get_block_id
)(struct netdev
*);
837 int netdev_register_provider(const struct netdev_class
*);
838 int netdev_unregister_provider(const char *type
);
840 #if defined(__FreeBSD__) || defined(__NetBSD__)
841 extern const struct netdev_class netdev_bsd_class
;
842 #elif defined(_WIN32)
843 extern const struct netdev_class netdev_windows_class
;
845 extern const struct netdev_class netdev_linux_class
;
847 extern const struct netdev_class netdev_internal_class
;
848 extern const struct netdev_class netdev_tap_class
;
851 extern const struct netdev_class netdev_afxdp_class
;
857 #endif /* netdev.h */