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"
28 #include "openvswitch/shash.h"
35 struct netdev_tnl_build_header_params
;
36 #define NETDEV_NUMA_UNSPEC OVS_NUMA_UNSPEC
38 /* A network device (e.g. an Ethernet device).
40 * Network device implementations may read these members but should not modify
43 /* The following do not change during the lifetime of a struct netdev. */
44 char *name
; /* Name of network device. */
45 const struct netdev_class
*netdev_class
; /* Functions to control
48 /* A sequence number which indicates changes in one of 'netdev''s
49 * properties. It must be nonzero so that users have a value which
50 * they may use as a reset when tracking 'netdev'.
52 * Minimally, the sequence number is required to change whenever
53 * 'netdev''s flags, features, ethernet address, or carrier changes. */
56 /* A netdev provider might be unable to change some of the device's
57 * parameter (n_rxq, mtu) when the device is in use. In this case
58 * the provider can notify the upper layer by calling
59 * netdev_request_reconfigure(). The upper layer will react by stopping
60 * the operations on the device and calling netdev_reconfigure() to allow
61 * the configuration changes. 'last_reconfigure_seq' remembers the value
62 * of 'reconfigure_seq' when the last reconfiguration happened. */
63 struct seq
*reconfigure_seq
;
64 uint64_t last_reconfigure_seq
;
66 /* If this is 'true', the user explicitly specified an MTU for this
67 * netdev. Otherwise, Open vSwitch is allowed to override it. */
70 /* The core netdev code initializes these at netdev construction and only
71 * provide read-only access to its client. Netdev implementations may
75 int ref_cnt
; /* Times this devices was opened. */
76 struct shash_node
*node
; /* Pointer to element in global map. */
77 struct ovs_list saved_flags_list
; /* Contains "struct netdev_saved_flags". */
81 netdev_change_seq_changed(const struct netdev
*netdev_
)
83 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
84 seq_change(connectivity_seq_get());
86 if (!netdev
->change_seq
) {
92 netdev_request_reconfigure(struct netdev
*netdev
)
94 seq_change(netdev
->reconfigure_seq
);
97 const char *netdev_get_type(const struct netdev
*);
98 const struct netdev_class
*netdev_get_class(const struct netdev
*);
99 const char *netdev_get_name(const struct netdev
*);
100 struct netdev
*netdev_from_name(const char *name
);
101 void netdev_get_devices(const struct netdev_class
*,
102 struct shash
*device_list
);
103 struct netdev
**netdev_get_vports(size_t *size
);
105 /* A data structure for capturing packets received by a network device.
107 * Network device implementations may read these members but should not modify
110 * None of these members change during the lifetime of a struct netdev_rxq. */
112 struct netdev
*netdev
; /* Owns a reference to the netdev. */
116 struct netdev
*netdev_rxq_get_netdev(const struct netdev_rxq
*);
119 struct netdev_flow_dump
{
120 struct netdev
*netdev
;
122 struct nl_dump
*nl_dump
;
126 /* Network device class structure, to be defined by each implementation of a
129 * These functions return 0 if successful or a positive errno value on failure,
130 * except where otherwise noted.
136 * These functions work primarily with two different kinds of data structures:
138 * - "struct netdev", which represents a network device.
140 * - "struct netdev_rxq", which represents a handle for capturing packets
141 * received on a network device
143 * Each of these data structures contains all of the implementation-independent
144 * generic state for the respective concept, called the "base" state. None of
145 * them contains any extra space for implementations to use. Instead, each
146 * implementation is expected to declare its own data structure that contains
147 * an instance of the generic data structure plus additional
148 * implementation-specific members, called the "derived" state. The
149 * implementation can use casts or (preferably) the CONTAINER_OF macro to
150 * obtain access to derived state given only a pointer to the embedded generic
157 * Four stylized functions accompany each of these data structures:
159 * "alloc" "construct" "destruct" "dealloc"
160 * ------------ ---------------- --------------- --------------
161 * netdev ->alloc ->construct ->destruct ->dealloc
162 * netdev_rxq ->rxq_alloc ->rxq_construct ->rxq_destruct ->rxq_dealloc
164 * Any instance of a given data structure goes through the following life
167 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
168 * fails, skip all the other steps.
170 * 2. The client initializes all of the data structure's base state. If this
171 * fails, skip to step 7.
173 * 3. The client calls the "construct" function. The implementation
174 * initializes derived state. It may refer to the already-initialized
175 * base state. If "construct" fails, skip to step 6.
177 * 4. The data structure is now initialized and in use.
179 * 5. When the data structure is no longer needed, the client calls the
180 * "destruct" function. The implementation uninitializes derived state.
181 * The base state has not been uninitialized yet, so the implementation
182 * may still refer to it.
184 * 6. The client uninitializes all of the data structure's base state.
186 * 7. The client calls the "dealloc" to free the raw memory. The
187 * implementation must not refer to base or derived state in the data
188 * structure, because it has already been uninitialized.
190 * If netdev support multi-queue IO then netdev->construct should set initialize
191 * netdev->n_rxq to number of queues.
193 * Each "alloc" function allocates and returns a new instance of the respective
194 * data structure. The "alloc" function is not given any information about the
195 * use of the new data structure, so it cannot perform much initialization.
196 * Its purpose is just to ensure that the new data structure has enough room
197 * for base and derived state. It may return a null pointer if memory is not
198 * available, in which case none of the other functions is called.
200 * Each "construct" function initializes derived state in its respective data
201 * structure. When "construct" is called, all of the base state has already
202 * been initialized, so the "construct" function may refer to it. The
203 * "construct" function is allowed to fail, in which case the client calls the
204 * "dealloc" function (but not the "destruct" function).
206 * Each "destruct" function uninitializes and frees derived state in its
207 * respective data structure. When "destruct" is called, the base state has
208 * not yet been uninitialized, so the "destruct" function may refer to it. The
209 * "destruct" function is not allowed to fail.
211 * Each "dealloc" function frees raw memory that was allocated by the
212 * "alloc" function. The memory's base and derived members might not have ever
213 * been initialized (but if "construct" returned successfully, then it has been
214 * "destruct"ed already). The "dealloc" function is not allowed to fail.
217 * Device Change Notification
218 * ==========================
220 * Minimally, implementations are required to report changes to netdev flags,
221 * features, ethernet address or carrier through connectivity_seq. Changes to
222 * other properties are allowed to cause notification through this interface,
223 * although implementations should try to avoid this. connectivity_seq_get()
224 * can be used to acquire a reference to the struct seq. The interface is
225 * described in detail in seq.h. */
226 struct netdev_class
{
227 /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
229 * One of the providers should supply a "system" type, since this is
230 * the type assumed if no type is specified when opening a netdev.
231 * The "system" type corresponds to an existing network device on
235 /* If 'true' then this netdev should be polled by PMD threads. */
238 /* ## ------------------- ## */
239 /* ## Top-Level Functions ## */
240 /* ## ------------------- ## */
242 /* Called when the netdev provider is registered, typically at program
243 * startup. Returning an error from this function will prevent any network
244 * device in this class from being opened.
246 * This function may be set to null if a network device class needs no
247 * initialization at registration time. */
250 /* Performs periodic work needed by netdevs of this class. May be null if
251 * no periodic work is necessary.
253 * 'netdev_class' points to the class. It is useful in case the same
254 * function is used to implement different classes. */
255 void (*run
)(const struct netdev_class
*netdev_class
);
257 /* Arranges for poll_block() to wake up if the "run" member function needs
258 * to be called. Implementations are additionally required to wake
259 * whenever something changes in any of its netdevs which would cause their
260 * ->change_seq() function to change its result. May be null if nothing is
263 * 'netdev_class' points to the class. It is useful in case the same
264 * function is used to implement different classes. */
265 void (*wait
)(const struct netdev_class
*netdev_class
);
267 /* ## ---------------- ## */
268 /* ## netdev Functions ## */
269 /* ## ---------------- ## */
271 /* Life-cycle functions for a netdev. See the large comment above on
272 * struct netdev_class. */
273 struct netdev
*(*alloc
)(void);
274 int (*construct
)(struct netdev
*);
275 void (*destruct
)(struct netdev
*);
276 void (*dealloc
)(struct netdev
*);
278 /* Fetches the device 'netdev''s configuration, storing it in 'args'.
279 * The caller owns 'args' and pre-initializes it to an empty smap.
281 * If this netdev class does not have any configuration options, this may
282 * be a null pointer. */
283 int (*get_config
)(const struct netdev
*netdev
, struct smap
*args
);
285 /* Changes the device 'netdev''s configuration to 'args'.
287 * If this netdev class does not support configuration, this may be a null
290 * If the return value is not zero (meaning that an error occurred),
291 * the provider can allocate a string with an error message in '*errp'.
292 * The caller has to call free on it. */
293 int (*set_config
)(struct netdev
*netdev
, const struct smap
*args
,
296 /* Returns the tunnel configuration of 'netdev'. If 'netdev' is
297 * not a tunnel, returns null.
299 * If this function would always return null, it may be null instead. */
300 const struct netdev_tunnel_config
*
301 (*get_tunnel_config
)(const struct netdev
*netdev
);
303 /* Build Tunnel header. Ethernet and ip header parameters are passed to
304 * tunnel implementation to build entire outer header for given flow. */
305 int (*build_header
)(const struct netdev
*, struct ovs_action_push_tnl
*data
,
306 const struct netdev_tnl_build_header_params
*params
);
308 /* build_header() can not build entire header for all packets for given
309 * flow. Push header is called for packet to build header specific to
310 * a packet on actual transmit. It uses partial header build by
311 * build_header() which is passed as data. */
312 void (*push_header
)(struct dp_packet
*packet
,
313 const struct ovs_action_push_tnl
*data
);
315 /* Pop tunnel header from packet, build tunnel metadata and resize packet
316 * for further processing.
317 * Returns NULL in case of error or tunnel implementation queued packet for further
319 struct dp_packet
* (*pop_header
)(struct dp_packet
*packet
);
321 /* Returns the id of the numa node the 'netdev' is on. If there is no
322 * such info, returns NETDEV_NUMA_UNSPEC. */
323 int (*get_numa_id
)(const struct netdev
*netdev
);
325 /* Configures the number of tx queues of 'netdev'. Returns 0 if successful,
326 * otherwise a positive errno value.
328 * 'n_txq' specifies the exact number of transmission queues to create.
330 * The caller will call netdev_reconfigure() (if necessary) before using
331 * netdev_send() on any of the newly configured queues, giving the provider
332 * a chance to adjust its settings.
334 * On error, the tx queue configuration is unchanged. */
335 int (*set_tx_multiq
)(struct netdev
*netdev
, unsigned int n_txq
);
337 /* Sends buffers on 'netdev'.
338 * Returns 0 if successful (for every buffer), otherwise a positive errno
339 * value. Returns EAGAIN without blocking if one or more packets cannot be
340 * queued immediately. Returns EMSGSIZE if a partial packet was transmitted
341 * or if a packet is too big or too small to transmit on the device.
343 * If the function returns a non-zero value, some of the packets might have
346 * If 'may_steal' is false, the caller retains ownership of all the
347 * packets. If 'may_steal' is true, the caller transfers ownership of all
348 * the packets to the network device, regardless of success.
350 * If 'concurrent_txq' is true, the caller may perform concurrent calls
351 * to netdev_send() with the same 'qid'. The netdev provider is responsible
352 * for making sure that these concurrent calls do not create a race
353 * condition by using locking or other synchronization if required.
355 * The network device is expected to maintain one or more packet
356 * transmission queues, so that the caller does not ordinarily have to
357 * do additional queuing of packets. 'qid' specifies the queue to use
358 * and can be ignored if the implementation does not support multiple
361 * May return EOPNOTSUPP if a network device does not implement packet
362 * transmission through this interface. This function may be set to null
363 * if it would always return EOPNOTSUPP anyhow. (This will prevent the
364 * network device from being usefully used by the netdev-based "userspace
365 * datapath". It will also prevent the OVS implementation of bonding from
366 * working properly over 'netdev'.) */
367 int (*send
)(struct netdev
*netdev
, int qid
, struct dp_packet_batch
*batch
,
368 bool may_steal
, bool concurrent_txq
);
370 /* Registers with the poll loop to wake up from the next call to
371 * poll_block() when the packet transmission queue for 'netdev' has
372 * sufficient room to transmit a packet with netdev_send().
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 be null if not needed, such as for a network device that does not
381 * implement packet transmission through the 'send' member function. */
382 void (*send_wait
)(struct netdev
*netdev
, int qid
);
384 /* Sets 'netdev''s Ethernet address to 'mac' */
385 int (*set_etheraddr
)(struct netdev
*netdev
, const struct eth_addr mac
);
387 /* Retrieves 'netdev''s Ethernet address into 'mac'.
389 * This address will be advertised as 'netdev''s MAC address through the
390 * OpenFlow protocol, among other uses. */
391 int (*get_etheraddr
)(const struct netdev
*netdev
, struct eth_addr
*mac
);
393 /* Retrieves 'netdev''s MTU into '*mtup'.
395 * The MTU is the maximum size of transmitted (and received) packets, in
396 * bytes, not including the hardware header; thus, this is typically 1500
397 * bytes for Ethernet devices.
399 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
400 * this function should return EOPNOTSUPP. This function may be set to
401 * null if it would always return EOPNOTSUPP. */
402 int (*get_mtu
)(const struct netdev
*netdev
, int *mtup
);
404 /* Sets 'netdev''s MTU to 'mtu'.
406 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
407 * this function should return EOPNOTSUPP. This function may be set to
408 * null if it would always return EOPNOTSUPP. */
409 int (*set_mtu
)(struct netdev
*netdev
, int mtu
);
411 /* Returns the ifindex of 'netdev', if successful, as a positive number.
412 * On failure, returns a negative errno value.
414 * The desired semantics of the ifindex value are a combination of those
415 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
416 * ifindex value should be unique within a host and remain stable at least
417 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
418 * ifNumber" but many systems do not follow this rule anyhow.
420 * This function may be set to null if it would always return -EOPNOTSUPP.
422 int (*get_ifindex
)(const struct netdev
*netdev
);
424 /* Sets 'carrier' to true if carrier is active (link light is on) on
427 * May be null if device does not provide carrier status (will be always
428 * up as long as device is up).
430 int (*get_carrier
)(const struct netdev
*netdev
, bool *carrier
);
432 /* Returns the number of times 'netdev''s carrier has changed since being
435 * If null, callers will assume the number of carrier resets is zero. */
436 long long int (*get_carrier_resets
)(const struct netdev
*netdev
);
438 /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
439 * instead of checking 'netdev''s carrier. 'netdev''s MII registers will
440 * be polled once every 'interval' milliseconds. If 'netdev' does not
441 * support MII, another method may be used as a fallback. If 'interval' is
442 * less than or equal to zero, reverts ->get_carrier() to its normal
445 * Most network devices won't support this feature and will set this
446 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
448 int (*set_miimon_interval
)(struct netdev
*netdev
, long long int interval
);
450 /* Retrieves current device stats for 'netdev' into 'stats'.
452 * A network device that supports some statistics but not others, it should
453 * set the values of the unsupported statistics to all-1-bits
455 int (*get_stats
)(const struct netdev
*netdev
, struct netdev_stats
*);
457 /* Stores the features supported by 'netdev' into each of '*current',
458 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
461 * This function may be set to null if it would always return EOPNOTSUPP.
463 int (*get_features
)(const struct netdev
*netdev
,
464 enum netdev_features
*current
,
465 enum netdev_features
*advertised
,
466 enum netdev_features
*supported
,
467 enum netdev_features
*peer
);
469 /* Set the features advertised by 'netdev' to 'advertise', which is a
470 * set of NETDEV_F_* bits.
472 * This function may be set to null for a network device that does not
473 * support configuring advertisements. */
474 int (*set_advertisements
)(struct netdev
*netdev
,
475 enum netdev_features advertise
);
477 /* Attempts to set input rate limiting (policing) policy, such that up to
478 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
479 * burst size of 'kbits' kb.
481 * This function may be set to null if policing is not supported. */
482 int (*set_policing
)(struct netdev
*netdev
, unsigned int kbits_rate
,
483 unsigned int kbits_burst
);
485 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
486 * it empty if 'netdev' does not support QoS. Any names added to 'types'
487 * should be documented as valid for the "type" column in the "QoS" table
488 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
490 * Every network device must support disabling QoS with a type of "", but
491 * this function must not add "" to 'types'.
493 * The caller is responsible for initializing 'types' (e.g. with
494 * sset_init()) before calling this function. The caller retains ownership
497 * May be NULL if 'netdev' does not support QoS at all. */
498 int (*get_qos_types
)(const struct netdev
*netdev
, struct sset
*types
);
500 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
501 * QoS. On success, initializes 'caps' with the QoS capabilities.
503 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
504 * NULL if 'netdev' does not support QoS at all. */
505 int (*get_qos_capabilities
)(const struct netdev
*netdev
,
507 struct netdev_qos_capabilities
*caps
);
509 /* Queries 'netdev' about its currently configured form of QoS. If
510 * successful, stores the name of the current form of QoS into '*typep'
511 * and any details of configuration as string key-value pairs in
514 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
516 * The caller initializes 'details' before calling this function. The
517 * caller takes ownership of the string key-values pairs added to
520 * The netdev retains ownership of '*typep'.
522 * '*typep' will be one of the types returned by netdev_get_qos_types() for
523 * 'netdev'. The contents of 'details' should be documented as valid for
524 * '*typep' in the "other_config" column in the "QoS" table in
525 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
527 * May be NULL if 'netdev' does not support QoS at all. */
528 int (*get_qos
)(const struct netdev
*netdev
,
529 const char **typep
, struct smap
*details
);
531 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
532 * 'type' with details of configuration from 'details'.
534 * On error, the previous QoS configuration is retained.
536 * When this function changes the type of QoS (not just 'details'), this
537 * also resets all queue configuration for 'netdev' to their defaults
538 * (which depend on the specific type of QoS). Otherwise, the queue
539 * configuration for 'netdev' is unchanged.
541 * 'type' should be "" (to disable QoS) or one of the types returned by
542 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
543 * be documented as valid for the given 'type' in the "other_config" column
544 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
545 * ovs-vswitchd.conf.db(8)).
547 * May be NULL if 'netdev' does not support QoS at all. */
548 int (*set_qos
)(struct netdev
*netdev
,
549 const char *type
, const struct smap
*details
);
551 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
552 * If successful, adds that information as string key-value pairs to
553 * 'details'. Returns 0 if successful, otherwise a positive errno value.
555 * Should return EINVAL if 'queue_id' is greater than or equal to the
556 * number of supported queues (as reported in the 'n_queues' member of
557 * struct netdev_qos_capabilities by 'get_qos_capabilities').
559 * The caller initializes 'details' before calling this function. The
560 * caller takes ownership of the string key-values pairs added to
563 * The returned contents of 'details' should be documented as valid for the
564 * given 'type' in the "other_config" column in the "Queue" table in
565 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
567 int (*get_queue
)(const struct netdev
*netdev
,
568 unsigned int queue_id
, struct smap
*details
);
570 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
571 * string pairs in 'details'. The contents of 'details' should be
572 * documented as valid for the given 'type' in the "other_config" column in
573 * the "Queue" table in vswitchd/vswitch.xml (which is built as
574 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
575 * errno value. On failure, the given queue's configuration should be
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'), or if
581 * 'details' is invalid for the type of queue.
583 * This function does not modify 'details', and the caller retains
586 * May be NULL if 'netdev' does not support QoS at all. */
587 int (*set_queue
)(struct netdev
*netdev
,
588 unsigned int queue_id
, const struct smap
*details
);
590 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
592 * Should return EINVAL if 'queue_id' is greater than or equal to the
593 * number of supported queues (as reported in the 'n_queues' member of
594 * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should
595 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
596 * 'netdev' has a fixed set of queues with the current QoS mode).
598 * May be NULL if 'netdev' does not support QoS at all, or if all of its
599 * QoS modes have fixed sets of queues. */
600 int (*delete_queue
)(struct netdev
*netdev
, unsigned int queue_id
);
602 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
603 * queue's statistics. May set individual members of 'stats' to all-1-bits
604 * if the statistic is unavailable.
606 * May be NULL if 'netdev' does not support QoS at all. */
607 int (*get_queue_stats
)(const struct netdev
*netdev
, unsigned int queue_id
,
608 struct netdev_queue_stats
*stats
);
610 /* Attempts to begin dumping the queues in 'netdev'. On success, returns 0
611 * and initializes '*statep' with any data needed for iteration. On
612 * failure, returns a positive errno value.
614 * May be NULL if 'netdev' does not support QoS at all. */
615 int (*queue_dump_start
)(const struct netdev
*netdev
, void **statep
);
617 /* Attempts to retrieve another queue from 'netdev' for 'state', which was
618 * initialized by a successful call to the 'queue_dump_start' function for
619 * 'netdev'. On success, stores a queue ID into '*queue_id' and fills
620 * 'details' with the configuration of the queue with that ID. Returns EOF
621 * if the last queue has been dumped, or a positive errno value on error.
622 * This function will not be called again once it returns nonzero once for
623 * a given iteration (but the 'queue_dump_done' function will be called
626 * The caller initializes and clears 'details' before calling this
627 * function. The caller takes ownership of the string key-values pairs
628 * added to 'details'.
630 * The returned contents of 'details' should be documented as valid for the
631 * given 'type' in the "other_config" column in the "Queue" table in
632 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
634 * May be NULL if 'netdev' does not support QoS at all. */
635 int (*queue_dump_next
)(const struct netdev
*netdev
, void *state
,
636 unsigned int *queue_id
, struct smap
*details
);
638 /* Releases resources from 'netdev' for 'state', which was initialized by a
639 * successful call to the 'queue_dump_start' function for 'netdev'.
641 * May be NULL if 'netdev' does not support QoS at all. */
642 int (*queue_dump_done
)(const struct netdev
*netdev
, void *state
);
644 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
645 * ID, its statistics, and the 'aux' specified by the caller. The order of
646 * iteration is unspecified, but (when successful) each queue must be
647 * visited exactly once.
649 * 'cb' will not modify or free the statistics passed in. */
650 int (*dump_queue_stats
)(const struct netdev
*netdev
,
651 void (*cb
)(unsigned int queue_id
,
652 struct netdev_queue_stats
*,
656 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
657 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
659 * This function may be set to null if it would always return EOPNOTSUPP
661 int (*set_in4
)(struct netdev
*netdev
, struct in_addr addr
,
662 struct in_addr mask
);
664 /* Returns all assigned IP address to 'netdev' and returns 0.
665 * API allocates array of address and masks and set it to
666 * '*addr' and '*mask'.
667 * Otherwise, returns a positive errno value and sets '*addr', '*mask
668 * and '*n_addr' to NULL.
670 * The following error values have well-defined meanings:
672 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
674 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
676 * 'addr' may be null, in which case the address itself is not reported. */
677 int (*get_addr_list
)(const struct netdev
*netdev
, struct in6_addr
**in
,
678 struct in6_addr
**mask
, int *n_in6
);
680 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
681 * corresponds to 'netdev'.
683 * This function may be set to null if it would always return EOPNOTSUPP
685 int (*add_router
)(struct netdev
*netdev
, struct in_addr router
);
687 /* Looks up the next hop for 'host' in the host's routing table. If
688 * successful, stores the next hop gateway's address (0 if 'host' is on a
689 * directly connected network) in '*next_hop' and a copy of the name of the
690 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
691 * responsible for freeing '*netdev_name' (by calling free()).
693 * This function may be set to null if it would always return EOPNOTSUPP
695 int (*get_next_hop
)(const struct in_addr
*host
, struct in_addr
*next_hop
,
698 /* Retrieves driver information of the device.
700 * Populates 'smap' with key-value pairs representing the status of the
701 * device. 'smap' is a set of key-value string pairs representing netdev
702 * type specific information. For more information see
703 * ovs-vswitchd.conf.db(5).
705 * The caller is responsible for destroying 'smap' and its data.
707 * This function may be set to null if it would always return EOPNOTSUPP
709 int (*get_status
)(const struct netdev
*netdev
, struct smap
*smap
);
711 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
712 * corresponding MAC address in 'mac'. A return value of ENXIO, in
713 * particular, indicates that there is no ARP table entry for 'ip' on
716 * This function may be set to null if it would always return EOPNOTSUPP
718 int (*arp_lookup
)(const struct netdev
*netdev
, ovs_be32 ip
,
719 struct eth_addr
*mac
);
721 /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then,
722 * turns off the flags that are set to 1 in 'off' and turns on the flags
723 * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and
724 * 'on'; that is, off & on == 0.)
726 * This function may be invoked from a signal handler. Therefore, it
727 * should not do anything that is not signal-safe (such as logging). */
728 int (*update_flags
)(struct netdev
*netdev
, enum netdev_flags off
,
729 enum netdev_flags on
, enum netdev_flags
*old_flags
);
731 /* If the provider called netdev_request_reconfigure(), the upper layer
732 * will eventually call this. The provider can update the device
733 * configuration knowing that the upper layer will not call rxq_recv() or
734 * send() until this function returns.
736 * On error, the configuration is indeterminant and the device cannot be
737 * used to send and receive packets until a successful configuration is
739 int (*reconfigure
)(struct netdev
*netdev
);
740 /* ## -------------------- ## */
741 /* ## netdev_rxq Functions ## */
742 /* ## -------------------- ## */
744 /* If a particular netdev class does not support receiving packets, all these
745 * function pointers must be NULL. */
747 /* Life-cycle functions for a netdev_rxq. See the large comment above on
748 * struct netdev_class. */
749 struct netdev_rxq
*(*rxq_alloc
)(void);
750 int (*rxq_construct
)(struct netdev_rxq
*);
751 void (*rxq_destruct
)(struct netdev_rxq
*);
752 void (*rxq_dealloc
)(struct netdev_rxq
*);
754 /* Attempts to receive a batch of packets from 'rx'. In 'batch', the
755 * caller supplies 'packets' as the pointer to the beginning of an array
756 * of NETDEV_MAX_BURST pointers to dp_packet. If successful, the
757 * implementation stores pointers to up to NETDEV_MAX_BURST dp_packets into
758 * the array, transferring ownership of the packets to the caller, stores
759 * the number of received packets into 'count', and returns 0.
761 * The implementation does not necessarily initialize any non-data members
762 * of 'packets' in 'batch'. That is, the caller must initialize layer
763 * pointers and metadata itself, if desired, e.g. with pkt_metadata_init()
764 * and miniflow_extract().
766 * Implementations should allocate buffers with DP_NETDEV_HEADROOM bytes of
769 * Returns EAGAIN immediately if no packet is ready to be received or
770 * another positive errno value if an error was encountered. */
771 int (*rxq_recv
)(struct netdev_rxq
*rx
, struct dp_packet_batch
*batch
);
773 /* Registers with the poll loop to wake up from the next call to
774 * poll_block() when a packet is ready to be received with
775 * netdev_rxq_recv() on 'rx'. */
776 void (*rxq_wait
)(struct netdev_rxq
*rx
);
778 /* Discards all packets waiting to be received from 'rx'. */
779 int (*rxq_drain
)(struct netdev_rxq
*rx
);
781 /* ## -------------------------------- ## */
782 /* ## netdev flow offloading functions ## */
783 /* ## -------------------------------- ## */
785 /* If a particular netdev class does not support offloading flows,
786 * all these function pointers must be NULL. */
788 /* Flush all offloaded flows from a netdev.
789 * Return 0 if successful, otherwise returns a positive errno value. */
790 int (*flow_flush
)(struct netdev
*);
792 /* Flow dumping interface.
794 * This is the back-end for the flow dumping interface described in
795 * dpif.h. Please read the comments there first, because this code
796 * closely follows it.
798 * On success returns 0 and allocates data, on failure returns
800 int (*flow_dump_create
)(struct netdev
*, struct netdev_flow_dump
**dump
);
801 int (*flow_dump_destroy
)(struct netdev_flow_dump
*);
803 /* Returns true if there are more flows to dump.
804 * 'rbuffer' is used as a temporary buffer and needs to be pre allocated
805 * by the caller. While there are more flows the same 'rbuffer'
806 * should be provided. 'wbuffer' is used to store dumped actions and needs
807 * to be pre allocated by the caller. */
808 bool (*flow_dump_next
)(struct netdev_flow_dump
*, struct match
*,
809 struct nlattr
**actions
,
810 struct dpif_flow_stats
*stats
, ovs_u128
*ufid
,
811 struct ofpbuf
*rbuffer
, struct ofpbuf
*wbuffer
);
813 /* Offload the given flow on netdev.
814 * To modify a flow, use the same ufid.
815 * 'actions' are in netlink format, as with struct dpif_flow_put.
816 * 'info' is extra info needed to offload the flow.
817 * 'stats' is populated according to the rules set out in the description
818 * above 'struct dpif_flow_put'.
819 * Return 0 if successful, otherwise returns a positive errno value. */
820 int (*flow_put
)(struct netdev
*, struct match
*, struct nlattr
*actions
,
821 size_t actions_len
, const ovs_u128
*ufid
,
822 struct offload_info
*info
, struct dpif_flow_stats
*);
824 /* Queries a flow specified by ufid on netdev.
825 * Fills output buffer as 'wbuffer' in flow_dump_next, which
826 * needs to be be pre allocated.
827 * Return 0 if successful, otherwise returns a positive errno value. */
828 int (*flow_get
)(struct netdev
*, struct match
*, struct nlattr
**actions
,
829 const ovs_u128
*ufid
, struct dpif_flow_stats
*,
830 struct ofpbuf
*wbuffer
);
832 /* Delete a flow specified by ufid from netdev.
833 * 'stats' is populated according to the rules set out in the description
834 * above 'struct dpif_flow_del'.
835 * Return 0 if successful, otherwise returns a positive errno value. */
836 int (*flow_del
)(struct netdev
*, const ovs_u128
*ufid
,
837 struct dpif_flow_stats
*);
839 /* Initializies the netdev flow api.
840 * Return 0 if successful, otherwise returns a positive errno value. */
841 int (*init_flow_api
)(struct netdev
*);
844 int netdev_register_provider(const struct netdev_class
*);
845 int netdev_unregister_provider(const char *type
);
847 #if defined(__FreeBSD__) || defined(__NetBSD__)
848 extern const struct netdev_class netdev_bsd_class
;
849 #elif defined(_WIN32)
850 extern const struct netdev_class netdev_windows_class
;
852 extern const struct netdev_class netdev_linux_class
;
854 extern const struct netdev_class netdev_internal_class
;
855 extern const struct netdev_class netdev_tap_class
;
861 #define NO_OFFLOAD_API NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL
863 #endif /* netdev.h */