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 "openvswitch/list.h"
35 #define NETDEV_NUMA_UNSPEC OVS_NUMA_UNSPEC
37 /* A network device (e.g. an Ethernet device).
39 * Network device implementations may read these members but should not modify
42 /* The following do not change during the lifetime of a struct netdev. */
43 char *name
; /* Name of network device. */
44 const struct netdev_class
*netdev_class
; /* Functions to control
47 /* A sequence number which indicates changes in one of 'netdev''s
48 * properties. It must be nonzero so that users have a value which
49 * they may use as a reset when tracking 'netdev'.
51 * Minimally, the sequence number is required to change whenever
52 * 'netdev''s flags, features, ethernet address, or carrier changes. */
55 /* A netdev provider might be unable to change some of the device's
56 * parameter (n_rxq, mtu) when the device is in use. In this case
57 * the provider can notify the upper layer by calling
58 * netdev_request_reconfigure(). The upper layer will react by stopping
59 * the operations on the device and calling netdev_reconfigure() to allow
60 * the configuration changes. 'last_reconfigure_seq' remembers the value
61 * of 'reconfigure_seq' when the last reconfiguration happened. */
62 struct seq
*reconfigure_seq
;
63 uint64_t last_reconfigure_seq
;
65 /* The core netdev code initializes these at netdev construction and only
66 * provide read-only access to its client. Netdev implementations may
70 /* Number of rx queues requested by user. */
72 int ref_cnt
; /* Times this devices was opened. */
73 struct shash_node
*node
; /* Pointer to element in global map. */
74 struct ovs_list saved_flags_list
; /* Contains "struct netdev_saved_flags". */
78 netdev_change_seq_changed(const struct netdev
*netdev_
)
80 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
81 seq_change(connectivity_seq_get());
83 if (!netdev
->change_seq
) {
89 netdev_request_reconfigure(struct netdev
*netdev
)
91 seq_change(netdev
->reconfigure_seq
);
94 const char *netdev_get_type(const struct netdev
*);
95 const struct netdev_class
*netdev_get_class(const struct netdev
*);
96 const char *netdev_get_name(const struct netdev
*);
97 struct netdev
*netdev_from_name(const char *name
);
98 void netdev_get_devices(const struct netdev_class
*,
99 struct shash
*device_list
);
100 struct netdev
**netdev_get_vports(size_t *size
);
102 /* A data structure for capturing packets received by a network device.
104 * Network device implementations may read these members but should not modify
107 * None of these members change during the lifetime of a struct netdev_rxq. */
109 struct netdev
*netdev
; /* Owns a reference to the netdev. */
113 struct netdev
*netdev_rxq_get_netdev(const struct netdev_rxq
*);
115 /* Network device class structure, to be defined by each implementation of a
118 * These functions return 0 if successful or a positive errno value on failure,
119 * except where otherwise noted.
125 * These functions work primarily with two different kinds of data structures:
127 * - "struct netdev", which represents a network device.
129 * - "struct netdev_rxq", which represents a handle for capturing packets
130 * received on a network device
132 * Each of these data structures contains all of the implementation-independent
133 * generic state for the respective concept, called the "base" state. None of
134 * them contains any extra space for implementations to use. Instead, each
135 * implementation is expected to declare its own data structure that contains
136 * an instance of the generic data structure plus additional
137 * implementation-specific members, called the "derived" state. The
138 * implementation can use casts or (preferably) the CONTAINER_OF macro to
139 * obtain access to derived state given only a pointer to the embedded generic
146 * Four stylized functions accompany each of these data structures:
148 * "alloc" "construct" "destruct" "dealloc"
149 * ------------ ---------------- --------------- --------------
150 * netdev ->alloc ->construct ->destruct ->dealloc
151 * netdev_rxq ->rxq_alloc ->rxq_construct ->rxq_destruct ->rxq_dealloc
153 * Any instance of a given data structure goes through the following life
156 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
157 * fails, skip all the other steps.
159 * 2. The client initializes all of the data structure's base state. If this
160 * fails, skip to step 7.
162 * 3. The client calls the "construct" function. The implementation
163 * initializes derived state. It may refer to the already-initialized
164 * base state. If "construct" fails, skip to step 6.
166 * 4. The data structure is now initialized and in use.
168 * 5. When the data structure is no longer needed, the client calls the
169 * "destruct" function. The implementation uninitializes derived state.
170 * The base state has not been uninitialized yet, so the implementation
171 * may still refer to it.
173 * 6. The client uninitializes all of the data structure's base state.
175 * 7. The client calls the "dealloc" to free the raw memory. The
176 * implementation must not refer to base or derived state in the data
177 * structure, because it has already been uninitialized.
179 * If netdev support multi-queue IO then netdev->construct should set initialize
180 * netdev->n_rxq to number of queues.
182 * Each "alloc" function allocates and returns a new instance of the respective
183 * data structure. The "alloc" function is not given any information about the
184 * use of the new data structure, so it cannot perform much initialization.
185 * Its purpose is just to ensure that the new data structure has enough room
186 * for base and derived state. It may return a null pointer if memory is not
187 * available, in which case none of the other functions is called.
189 * Each "construct" function initializes derived state in its respective data
190 * structure. When "construct" is called, all of the base state has already
191 * been initialized, so the "construct" function may refer to it. The
192 * "construct" function is allowed to fail, in which case the client calls the
193 * "dealloc" function (but not the "destruct" function).
195 * Each "destruct" function uninitializes and frees derived state in its
196 * respective data structure. When "destruct" is called, the base state has
197 * not yet been uninitialized, so the "destruct" function may refer to it. The
198 * "destruct" function is not allowed to fail.
200 * Each "dealloc" function frees raw memory that was allocated by the
201 * "alloc" function. The memory's base and derived members might not have ever
202 * been initialized (but if "construct" returned successfully, then it has been
203 * "destruct"ed already). The "dealloc" function is not allowed to fail.
206 * Device Change Notification
207 * ==========================
209 * Minimally, implementations are required to report changes to netdev flags,
210 * features, ethernet address or carrier through connectivity_seq. Changes to
211 * other properties are allowed to cause notification through this interface,
212 * although implementations should try to avoid this. connectivity_seq_get()
213 * can be used to acquire a reference to the struct seq. The interface is
214 * described in detail in seq.h. */
215 struct netdev_class
{
216 /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
218 * One of the providers should supply a "system" type, since this is
219 * the type assumed if no type is specified when opening a netdev.
220 * The "system" type corresponds to an existing network device on
224 /* If 'true' then this netdev should be polled by PMD threads. */
227 /* ## ------------------- ## */
228 /* ## Top-Level Functions ## */
229 /* ## ------------------- ## */
231 /* Called when the netdev provider is registered, typically at program
232 * startup. Returning an error from this function will prevent any network
233 * device in this class from being opened.
235 * This function may be set to null if a network device class needs no
236 * initialization at registration time. */
239 /* Performs periodic work needed by netdevs of this class. May be null if
240 * no periodic work is necessary. */
243 /* Arranges for poll_block() to wake up if the "run" member function needs
244 * to be called. Implementations are additionally required to wake
245 * whenever something changes in any of its netdevs which would cause their
246 * ->change_seq() function to change its result. May be null if nothing is
250 /* ## ---------------- ## */
251 /* ## netdev Functions ## */
252 /* ## ---------------- ## */
254 /* Life-cycle functions for a netdev. See the large comment above on
255 * struct netdev_class. */
256 struct netdev
*(*alloc
)(void);
257 int (*construct
)(struct netdev
*);
258 void (*destruct
)(struct netdev
*);
259 void (*dealloc
)(struct netdev
*);
261 /* Fetches the device 'netdev''s configuration, storing it in 'args'.
262 * The caller owns 'args' and pre-initializes it to an empty smap.
264 * If this netdev class does not have any configuration options, this may
265 * be a null pointer. */
266 int (*get_config
)(const struct netdev
*netdev
, struct smap
*args
);
268 /* Changes the device 'netdev''s configuration to 'args'.
270 * If this netdev class does not support configuration, this may be a null
272 int (*set_config
)(struct netdev
*netdev
, const struct smap
*args
);
274 /* Returns the tunnel configuration of 'netdev'. If 'netdev' is
275 * not a tunnel, returns null.
277 * If this function would always return null, it may be null instead. */
278 const struct netdev_tunnel_config
*
279 (*get_tunnel_config
)(const struct netdev
*netdev
);
281 /* Build Partial Tunnel header. Ethernet and ip header is already built,
282 * build_header() is suppose build protocol specific part of header. */
283 int (*build_header
)(const struct netdev
*, struct ovs_action_push_tnl
*data
,
284 const struct flow
*tnl_flow
);
286 /* build_header() can not build entire header for all packets for given
287 * flow. Push header is called for packet to build header specific to
288 * a packet on actual transmit. It uses partial header build by
289 * build_header() which is passed as data. */
290 void (*push_header
)(struct dp_packet
*packet
,
291 const struct ovs_action_push_tnl
*data
);
293 /* Pop tunnel header from packet, build tunnel metadata and resize packet
294 * for further processing.
295 * Returns NULL in case of error or tunnel implementation queued packet for further
297 struct dp_packet
* (*pop_header
)(struct dp_packet
*packet
);
299 /* Returns the id of the numa node the 'netdev' is on. If there is no
300 * such info, returns NETDEV_NUMA_UNSPEC. */
301 int (*get_numa_id
)(const struct netdev
*netdev
);
303 /* Configures the number of tx queues and rx queues of 'netdev'.
304 * Return 0 if successful, otherwise a positive errno value.
306 * 'n_rxq' specifies the maximum number of receive queues to create.
307 * The netdev provider might choose to create less (e.g. if the hardware
308 * supports only a smaller number). The actual number of queues created
309 * is stored in the 'netdev->n_rxq' field.
311 * 'n_txq' specifies the exact number of transmission queues to create.
312 * The caller will call netdev_send() concurrently from 'n_txq' different
313 * threads (with different qid). The netdev provider is responsible for
314 * making sure that these concurrent calls do not create a race condition
315 * by using multiple hw queues or locking.
317 * On error, the tx queue and rx queue configuration is indeterminant.
318 * Caller should make decision on whether to restore the previous or
319 * the default configuration. Also, caller must make sure there is no
320 * other thread accessing the queues at the same time. */
321 int (*set_multiq
)(struct netdev
*netdev
, unsigned int n_txq
,
324 /* Sends buffers on 'netdev'.
325 * Returns 0 if successful (for every buffer), otherwise a positive errno
326 * value. Returns EAGAIN without blocking if one or more packets cannot be
327 * queued immediately. Returns EMSGSIZE if a partial packet was transmitted
328 * or if a packet is too big or too small to transmit on the device.
330 * If the function returns a non-zero value, some of the packets might have
333 * If 'may_steal' is false, the caller retains ownership of all the
334 * packets. If 'may_steal' is true, the caller transfers ownership of all
335 * the packets to the network device, regardless of success.
337 * The network device is expected to maintain one or more packet
338 * transmission queues, so that the caller does not ordinarily have to
339 * do additional queuing of packets. 'qid' specifies the queue to use
340 * and can be ignored if the implementation does not support multiple
343 * May return EOPNOTSUPP if a network device does not implement packet
344 * transmission through this interface. This function may be set to null
345 * if it would always return EOPNOTSUPP anyhow. (This will prevent the
346 * network device from being usefully used by the netdev-based "userspace
347 * datapath". It will also prevent the OVS implementation of bonding from
348 * working properly over 'netdev'.) */
349 int (*send
)(struct netdev
*netdev
, int qid
, struct dp_packet
**buffers
,
350 int cnt
, bool may_steal
);
352 /* Registers with the poll loop to wake up from the next call to
353 * poll_block() when the packet transmission queue for 'netdev' has
354 * sufficient room to transmit a packet with netdev_send().
356 * The network device is expected to maintain one or more packet
357 * transmission queues, so that the caller does not ordinarily have to
358 * do additional queuing of packets. 'qid' specifies the queue to use
359 * and can be ignored if the implementation does not support multiple
362 * May be null if not needed, such as for a network device that does not
363 * implement packet transmission through the 'send' member function. */
364 void (*send_wait
)(struct netdev
*netdev
, int qid
);
366 /* Sets 'netdev''s Ethernet address to 'mac' */
367 int (*set_etheraddr
)(struct netdev
*netdev
, const struct eth_addr mac
);
369 /* Retrieves 'netdev''s Ethernet address into 'mac'.
371 * This address will be advertised as 'netdev''s MAC address through the
372 * OpenFlow protocol, among other uses. */
373 int (*get_etheraddr
)(const struct netdev
*netdev
, struct eth_addr
*mac
);
375 /* Retrieves 'netdev''s MTU into '*mtup'.
377 * The MTU is the maximum size of transmitted (and received) packets, in
378 * bytes, not including the hardware header; thus, this is typically 1500
379 * bytes for Ethernet devices.
381 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
382 * this function should return EOPNOTSUPP. This function may be set to
383 * null if it would always return EOPNOTSUPP. */
384 int (*get_mtu
)(const struct netdev
*netdev
, int *mtup
);
386 /* Sets 'netdev''s MTU to 'mtu'.
388 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
389 * this function should return EOPNOTSUPP. This function may be set to
390 * null if it would always return EOPNOTSUPP. */
391 int (*set_mtu
)(const struct netdev
*netdev
, int mtu
);
393 /* Returns the ifindex of 'netdev', if successful, as a positive number.
394 * On failure, returns a negative errno value.
396 * The desired semantics of the ifindex value are a combination of those
397 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
398 * ifindex value should be unique within a host and remain stable at least
399 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
400 * ifNumber" but many systems do not follow this rule anyhow.
402 * This function may be set to null if it would always return -EOPNOTSUPP.
404 int (*get_ifindex
)(const struct netdev
*netdev
);
406 /* Sets 'carrier' to true if carrier is active (link light is on) on
409 * May be null if device does not provide carrier status (will be always
410 * up as long as device is up).
412 int (*get_carrier
)(const struct netdev
*netdev
, bool *carrier
);
414 /* Returns the number of times 'netdev''s carrier has changed since being
417 * If null, callers will assume the number of carrier resets is zero. */
418 long long int (*get_carrier_resets
)(const struct netdev
*netdev
);
420 /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
421 * instead of checking 'netdev''s carrier. 'netdev''s MII registers will
422 * be polled once every 'interval' milliseconds. If 'netdev' does not
423 * support MII, another method may be used as a fallback. If 'interval' is
424 * less than or equal to zero, reverts ->get_carrier() to its normal
427 * Most network devices won't support this feature and will set this
428 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
430 int (*set_miimon_interval
)(struct netdev
*netdev
, long long int interval
);
432 /* Retrieves current device stats for 'netdev' into 'stats'.
434 * A network device that supports some statistics but not others, it should
435 * set the values of the unsupported statistics to all-1-bits
437 int (*get_stats
)(const struct netdev
*netdev
, struct netdev_stats
*);
439 /* Stores the features supported by 'netdev' into each of '*current',
440 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
443 * This function may be set to null if it would always return EOPNOTSUPP.
445 int (*get_features
)(const struct netdev
*netdev
,
446 enum netdev_features
*current
,
447 enum netdev_features
*advertised
,
448 enum netdev_features
*supported
,
449 enum netdev_features
*peer
);
451 /* Set the features advertised by 'netdev' to 'advertise', which is a
452 * set of NETDEV_F_* bits.
454 * This function may be set to null for a network device that does not
455 * support configuring advertisements. */
456 int (*set_advertisements
)(struct netdev
*netdev
,
457 enum netdev_features advertise
);
459 /* Attempts to set input rate limiting (policing) policy, such that up to
460 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
461 * burst size of 'kbits' kb.
463 * This function may be set to null if policing is not supported. */
464 int (*set_policing
)(struct netdev
*netdev
, unsigned int kbits_rate
,
465 unsigned int kbits_burst
);
467 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
468 * it empty if 'netdev' does not support QoS. Any names added to 'types'
469 * should be documented as valid for the "type" column in the "QoS" table
470 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
472 * Every network device must support disabling QoS with a type of "", but
473 * this function must not add "" to 'types'.
475 * The caller is responsible for initializing 'types' (e.g. with
476 * sset_init()) before calling this function. The caller retains ownership
479 * May be NULL if 'netdev' does not support QoS at all. */
480 int (*get_qos_types
)(const struct netdev
*netdev
, struct sset
*types
);
482 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
483 * QoS. On success, initializes 'caps' with the QoS capabilities.
485 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
486 * NULL if 'netdev' does not support QoS at all. */
487 int (*get_qos_capabilities
)(const struct netdev
*netdev
,
489 struct netdev_qos_capabilities
*caps
);
491 /* Queries 'netdev' about its currently configured form of QoS. If
492 * successful, stores the name of the current form of QoS into '*typep'
493 * and any details of configuration as string key-value pairs in
496 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
498 * The caller initializes 'details' before calling this function. The
499 * caller takes ownership of the string key-values pairs added to
502 * The netdev retains ownership of '*typep'.
504 * '*typep' will be one of the types returned by netdev_get_qos_types() for
505 * 'netdev'. The contents of 'details' should be documented as valid for
506 * '*typep' in the "other_config" column in the "QoS" table in
507 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
509 * May be NULL if 'netdev' does not support QoS at all. */
510 int (*get_qos
)(const struct netdev
*netdev
,
511 const char **typep
, struct smap
*details
);
513 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
514 * 'type' with details of configuration from 'details'.
516 * On error, the previous QoS configuration is retained.
518 * When this function changes the type of QoS (not just 'details'), this
519 * also resets all queue configuration for 'netdev' to their defaults
520 * (which depend on the specific type of QoS). Otherwise, the queue
521 * configuration for 'netdev' is unchanged.
523 * 'type' should be "" (to disable QoS) or one of the types returned by
524 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
525 * be documented as valid for the given 'type' in the "other_config" column
526 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
527 * ovs-vswitchd.conf.db(8)).
529 * May be NULL if 'netdev' does not support QoS at all. */
530 int (*set_qos
)(struct netdev
*netdev
,
531 const char *type
, const struct smap
*details
);
533 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
534 * If successful, adds that information as string key-value pairs to
535 * 'details'. Returns 0 if successful, otherwise a positive errno value.
537 * Should return EINVAL if 'queue_id' is greater than or equal to the
538 * number of supported queues (as reported in the 'n_queues' member of
539 * struct netdev_qos_capabilities by 'get_qos_capabilities').
541 * The caller initializes 'details' before calling this function. The
542 * caller takes ownership of the string key-values pairs added to
545 * The returned contents of 'details' should be documented as valid for the
546 * given 'type' in the "other_config" column in the "Queue" table in
547 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
549 int (*get_queue
)(const struct netdev
*netdev
,
550 unsigned int queue_id
, struct smap
*details
);
552 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
553 * string pairs in 'details'. The contents of 'details' should be
554 * documented as valid for the given 'type' in the "other_config" column in
555 * the "Queue" table in vswitchd/vswitch.xml (which is built as
556 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
557 * errno value. On failure, the given queue's configuration should be
560 * Should return EINVAL if 'queue_id' is greater than or equal to the
561 * number of supported queues (as reported in the 'n_queues' member of
562 * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if
563 * 'details' is invalid for the type of queue.
565 * This function does not modify 'details', and the caller retains
568 * May be NULL if 'netdev' does not support QoS at all. */
569 int (*set_queue
)(struct netdev
*netdev
,
570 unsigned int queue_id
, const struct smap
*details
);
572 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
574 * Should return EINVAL if 'queue_id' is greater than or equal to the
575 * number of supported queues (as reported in the 'n_queues' member of
576 * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should
577 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
578 * 'netdev' has a fixed set of queues with the current QoS mode).
580 * May be NULL if 'netdev' does not support QoS at all, or if all of its
581 * QoS modes have fixed sets of queues. */
582 int (*delete_queue
)(struct netdev
*netdev
, unsigned int queue_id
);
584 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
585 * queue's statistics. May set individual members of 'stats' to all-1-bits
586 * if the statistic is unavailable.
588 * May be NULL if 'netdev' does not support QoS at all. */
589 int (*get_queue_stats
)(const struct netdev
*netdev
, unsigned int queue_id
,
590 struct netdev_queue_stats
*stats
);
592 /* Attempts to begin dumping the queues in 'netdev'. On success, returns 0
593 * and initializes '*statep' with any data needed for iteration. On
594 * failure, returns a positive errno value.
596 * May be NULL if 'netdev' does not support QoS at all. */
597 int (*queue_dump_start
)(const struct netdev
*netdev
, void **statep
);
599 /* Attempts to retrieve another queue from 'netdev' for 'state', which was
600 * initialized by a successful call to the 'queue_dump_start' function for
601 * 'netdev'. On success, stores a queue ID into '*queue_id' and fills
602 * 'details' with the configuration of the queue with that ID. Returns EOF
603 * if the last queue has been dumped, or a positive errno value on error.
604 * This function will not be called again once it returns nonzero once for
605 * a given iteration (but the 'queue_dump_done' function will be called
608 * The caller initializes and clears 'details' before calling this
609 * function. The caller takes ownership of the string key-values pairs
610 * added to 'details'.
612 * The returned contents of 'details' should be documented as valid for the
613 * given 'type' in the "other_config" column in the "Queue" table in
614 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
616 * May be NULL if 'netdev' does not support QoS at all. */
617 int (*queue_dump_next
)(const struct netdev
*netdev
, void *state
,
618 unsigned int *queue_id
, struct smap
*details
);
620 /* Releases resources from 'netdev' for 'state', which was initialized by a
621 * successful call to the 'queue_dump_start' function for 'netdev'.
623 * May be NULL if 'netdev' does not support QoS at all. */
624 int (*queue_dump_done
)(const struct netdev
*netdev
, void *state
);
626 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
627 * ID, its statistics, and the 'aux' specified by the caller. The order of
628 * iteration is unspecified, but (when successful) each queue must be
629 * visited exactly once.
631 * 'cb' will not modify or free the statistics passed in. */
632 int (*dump_queue_stats
)(const struct netdev
*netdev
,
633 void (*cb
)(unsigned int queue_id
,
634 struct netdev_queue_stats
*,
638 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
639 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
641 * This function may be set to null if it would always return EOPNOTSUPP
643 int (*set_in4
)(struct netdev
*netdev
, struct in_addr addr
,
644 struct in_addr mask
);
646 /* Returns all assigned IP address to 'netdev' and returns 0.
647 * API allocates array of address and masks and set it to
648 * '*addr' and '*mask'.
649 * Otherwise, returns a positive errno value and sets '*addr', '*mask
650 * and '*n_addr' to NULL.
652 * The following error values have well-defined meanings:
654 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
656 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
658 * 'addr' may be null, in which case the address itself is not reported. */
659 int (*get_addr_list
)(const struct netdev
*netdev
, struct in6_addr
**in
,
660 struct in6_addr
**mask
, int *n_in6
);
662 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
663 * corresponds to 'netdev'.
665 * This function may be set to null if it would always return EOPNOTSUPP
667 int (*add_router
)(struct netdev
*netdev
, struct in_addr router
);
669 /* Looks up the next hop for 'host' in the host's routing table. If
670 * successful, stores the next hop gateway's address (0 if 'host' is on a
671 * directly connected network) in '*next_hop' and a copy of the name of the
672 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
673 * responsible for freeing '*netdev_name' (by calling free()).
675 * This function may be set to null if it would always return EOPNOTSUPP
677 int (*get_next_hop
)(const struct in_addr
*host
, struct in_addr
*next_hop
,
680 /* Retrieves driver information of the device.
682 * Populates 'smap' with key-value pairs representing the status of the
683 * device. 'smap' is a set of key-value string pairs representing netdev
684 * type specific information. For more information see
685 * ovs-vswitchd.conf.db(5).
687 * The caller is responsible for destroying 'smap' and its data.
689 * This function may be set to null if it would always return EOPNOTSUPP
691 int (*get_status
)(const struct netdev
*netdev
, struct smap
*smap
);
693 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
694 * corresponding MAC address in 'mac'. A return value of ENXIO, in
695 * particular, indicates that there is no ARP table entry for 'ip' on
698 * This function may be set to null if it would always return EOPNOTSUPP
700 int (*arp_lookup
)(const struct netdev
*netdev
, ovs_be32 ip
,
701 struct eth_addr
*mac
);
703 /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then,
704 * turns off the flags that are set to 1 in 'off' and turns on the flags
705 * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and
706 * 'on'; that is, off & on == 0.)
708 * This function may be invoked from a signal handler. Therefore, it
709 * should not do anything that is not signal-safe (such as logging). */
710 int (*update_flags
)(struct netdev
*netdev
, enum netdev_flags off
,
711 enum netdev_flags on
, enum netdev_flags
*old_flags
);
713 /* If the provider called netdev_request_reconfigure(), the upper layer
714 * will eventually call this. The provider can update the device
715 * configuration knowing that the upper layer will not call rxq_recv() or
716 * send() until this function returns.
718 * On error, the configuration is indeterminant and the device cannot be
719 * used to send and receive packets until a successful configuration is
721 int (*reconfigure
)(struct netdev
*netdev
);
722 /* ## -------------------- ## */
723 /* ## netdev_rxq Functions ## */
724 /* ## -------------------- ## */
726 /* If a particular netdev class does not support receiving packets, all these
727 * function pointers must be NULL. */
729 /* Life-cycle functions for a netdev_rxq. See the large comment above on
730 * struct netdev_class. */
731 struct netdev_rxq
*(*rxq_alloc
)(void);
732 int (*rxq_construct
)(struct netdev_rxq
*);
733 void (*rxq_destruct
)(struct netdev_rxq
*);
734 void (*rxq_dealloc
)(struct netdev_rxq
*);
736 /* Attempts to receive a batch of packets from 'rx'. The caller supplies
737 * 'pkts' as the pointer to the beginning of an array of MAX_RX_BATCH
738 * pointers to dp_packet. If successful, the implementation stores
739 * pointers to up to MAX_RX_BATCH dp_packets into the array, transferring
740 * ownership of the packets to the caller, stores the number of received
741 * packets into '*cnt', and returns 0.
743 * The implementation does not necessarily initialize any non-data members
744 * of 'pkts'. That is, the caller must initialize layer pointers and
745 * metadata itself, if desired, e.g. with pkt_metadata_init() and
746 * miniflow_extract().
748 * Implementations should allocate buffers with DP_NETDEV_HEADROOM bytes of
751 * Returns EAGAIN immediately if no packet is ready to be received or
752 * another positive errno value if an error was encountered. */
753 int (*rxq_recv
)(struct netdev_rxq
*rx
, struct dp_packet
**pkts
,
756 /* Registers with the poll loop to wake up from the next call to
757 * poll_block() when a packet is ready to be received with
758 * netdev_rxq_recv() on 'rx'. */
759 void (*rxq_wait
)(struct netdev_rxq
*rx
);
761 /* Discards all packets waiting to be received from 'rx'. */
762 int (*rxq_drain
)(struct netdev_rxq
*rx
);
765 int netdev_register_provider(const struct netdev_class
*);
766 int netdev_unregister_provider(const char *type
);
768 #if defined(__FreeBSD__) || defined(__NetBSD__)
769 extern const struct netdev_class netdev_bsd_class
;
770 #elif defined(_WIN32)
771 extern const struct netdev_class netdev_windows_class
;
773 extern const struct netdev_class netdev_linux_class
;
775 extern const struct netdev_class netdev_internal_class
;
776 extern const struct netdev_class netdev_tap_class
;
782 #endif /* netdev.h */