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"
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 /* The core netdev code initializes these at netdev construction and only
56 * provide read-only access to its client. Netdev implementations may
60 /* Number of rx queues requested by user. */
62 int ref_cnt
; /* Times this devices was opened. */
63 struct shash_node
*node
; /* Pointer to element in global map. */
64 struct ovs_list saved_flags_list
; /* Contains "struct netdev_saved_flags". */
68 netdev_change_seq_changed(const struct netdev
*netdev_
)
70 struct netdev
*netdev
= CONST_CAST(struct netdev
*, netdev_
);
71 seq_change(connectivity_seq_get());
73 if (!netdev
->change_seq
) {
78 const char *netdev_get_type(const struct netdev
*);
79 const struct netdev_class
*netdev_get_class(const struct netdev
*);
80 const char *netdev_get_name(const struct netdev
*);
81 struct netdev
*netdev_from_name(const char *name
);
82 void netdev_get_devices(const struct netdev_class
*,
83 struct shash
*device_list
);
84 struct netdev
**netdev_get_vports(size_t *size
);
86 /* A data structure for capturing packets received by a network device.
88 * Network device implementations may read these members but should not modify
91 * None of these members change during the lifetime of a struct netdev_rxq. */
93 struct netdev
*netdev
; /* Owns a reference to the netdev. */
97 struct netdev
*netdev_rxq_get_netdev(const struct netdev_rxq
*);
99 /* Network device class structure, to be defined by each implementation of a
102 * These functions return 0 if successful or a positive errno value on failure,
103 * except where otherwise noted.
109 * These functions work primarily with two different kinds of data structures:
111 * - "struct netdev", which represents a network device.
113 * - "struct netdev_rxq", which represents a handle for capturing packets
114 * received on a network device
116 * Each of these data structures contains all of the implementation-independent
117 * generic state for the respective concept, called the "base" state. None of
118 * them contains any extra space for implementations to use. Instead, each
119 * implementation is expected to declare its own data structure that contains
120 * an instance of the generic data structure plus additional
121 * implementation-specific members, called the "derived" state. The
122 * implementation can use casts or (preferably) the CONTAINER_OF macro to
123 * obtain access to derived state given only a pointer to the embedded generic
130 * Four stylized functions accompany each of these data structures:
132 * "alloc" "construct" "destruct" "dealloc"
133 * ------------ ---------------- --------------- --------------
134 * netdev ->alloc ->construct ->destruct ->dealloc
135 * netdev_rxq ->rxq_alloc ->rxq_construct ->rxq_destruct ->rxq_dealloc
137 * Any instance of a given data structure goes through the following life
140 * 1. The client calls the "alloc" function to obtain raw memory. If "alloc"
141 * fails, skip all the other steps.
143 * 2. The client initializes all of the data structure's base state. If this
144 * fails, skip to step 7.
146 * 3. The client calls the "construct" function. The implementation
147 * initializes derived state. It may refer to the already-initialized
148 * base state. If "construct" fails, skip to step 6.
150 * 4. The data structure is now initialized and in use.
152 * 5. When the data structure is no longer needed, the client calls the
153 * "destruct" function. The implementation uninitializes derived state.
154 * The base state has not been uninitialized yet, so the implementation
155 * may still refer to it.
157 * 6. The client uninitializes all of the data structure's base state.
159 * 7. The client calls the "dealloc" to free the raw memory. The
160 * implementation must not refer to base or derived state in the data
161 * structure, because it has already been uninitialized.
163 * If netdev support multi-queue IO then netdev->construct should set initialize
164 * netdev->n_rxq to number of queues.
166 * Each "alloc" function allocates and returns a new instance of the respective
167 * data structure. The "alloc" function is not given any information about the
168 * use of the new data structure, so it cannot perform much initialization.
169 * Its purpose is just to ensure that the new data structure has enough room
170 * for base and derived state. It may return a null pointer if memory is not
171 * available, in which case none of the other functions is called.
173 * Each "construct" function initializes derived state in its respective data
174 * structure. When "construct" is called, all of the base state has already
175 * been initialized, so the "construct" function may refer to it. The
176 * "construct" function is allowed to fail, in which case the client calls the
177 * "dealloc" function (but not the "destruct" function).
179 * Each "destruct" function uninitializes and frees derived state in its
180 * respective data structure. When "destruct" is called, the base state has
181 * not yet been uninitialized, so the "destruct" function may refer to it. The
182 * "destruct" function is not allowed to fail.
184 * Each "dealloc" function frees raw memory that was allocated by the
185 * "alloc" function. The memory's base and derived members might not have ever
186 * been initialized (but if "construct" returned successfully, then it has been
187 * "destruct"ed already). The "dealloc" function is not allowed to fail.
190 * Device Change Notification
191 * ==========================
193 * Minimally, implementations are required to report changes to netdev flags,
194 * features, ethernet address or carrier through connectivity_seq. Changes to
195 * other properties are allowed to cause notification through this interface,
196 * although implementations should try to avoid this. connectivity_seq_get()
197 * can be used to acquire a reference to the struct seq. The interface is
198 * described in detail in seq.h. */
199 struct netdev_class
{
200 /* Type of netdevs in this class, e.g. "system", "tap", "gre", etc.
202 * One of the providers should supply a "system" type, since this is
203 * the type assumed if no type is specified when opening a netdev.
204 * The "system" type corresponds to an existing network device on
208 /* If 'true' then this netdev should be polled by PMD threads. */
211 /* ## ------------------- ## */
212 /* ## Top-Level Functions ## */
213 /* ## ------------------- ## */
215 /* Called when the netdev provider is registered, typically at program
216 * startup. Returning an error from this function will prevent any network
217 * device in this class from being opened.
219 * This function may be set to null if a network device class needs no
220 * initialization at registration time. */
223 /* Performs periodic work needed by netdevs of this class. May be null if
224 * no periodic work is necessary. */
227 /* Arranges for poll_block() to wake up if the "run" member function needs
228 * to be called. Implementations are additionally required to wake
229 * whenever something changes in any of its netdevs which would cause their
230 * ->change_seq() function to change its result. May be null if nothing is
234 /* ## ---------------- ## */
235 /* ## netdev Functions ## */
236 /* ## ---------------- ## */
238 /* Life-cycle functions for a netdev. See the large comment above on
239 * struct netdev_class. */
240 struct netdev
*(*alloc
)(void);
241 int (*construct
)(struct netdev
*);
242 void (*destruct
)(struct netdev
*);
243 void (*dealloc
)(struct netdev
*);
245 /* Fetches the device 'netdev''s configuration, storing it in 'args'.
246 * The caller owns 'args' and pre-initializes it to an empty smap.
248 * If this netdev class does not have any configuration options, this may
249 * be a null pointer. */
250 int (*get_config
)(const struct netdev
*netdev
, struct smap
*args
);
252 /* Changes the device 'netdev''s configuration to 'args'.
254 * If this netdev class does not support configuration, this may be a null
256 int (*set_config
)(struct netdev
*netdev
, const struct smap
*args
);
258 /* Returns the tunnel configuration of 'netdev'. If 'netdev' is
259 * not a tunnel, returns null.
261 * If this function would always return null, it may be null instead. */
262 const struct netdev_tunnel_config
*
263 (*get_tunnel_config
)(const struct netdev
*netdev
);
265 /* Build Partial Tunnel header. Ethernet and ip header is already built,
266 * build_header() is suppose build protocol specific part of header. */
267 int (*build_header
)(const struct netdev
*, struct ovs_action_push_tnl
*data
,
268 const struct flow
*tnl_flow
);
270 /* build_header() can not build entire header for all packets for given
271 * flow. Push header is called for packet to build header specific to
272 * a packet on actual transmit. It uses partial header build by
273 * build_header() which is passed as data. */
274 void (*push_header
)(struct dp_packet
*packet
,
275 const struct ovs_action_push_tnl
*data
);
277 /* Pop tunnel header from packet, build tunnel metadata and resize packet
278 * for further processing. */
279 int (*pop_header
)(struct dp_packet
*packet
);
281 /* Returns the id of the numa node the 'netdev' is on. If there is no
282 * such info, returns NETDEV_NUMA_UNSPEC. */
283 int (*get_numa_id
)(const struct netdev
*netdev
);
285 /* Configures the number of tx queues and rx queues of 'netdev'.
286 * Return 0 if successful, otherwise a positive errno value.
288 * 'n_rxq' specifies the maximum number of receive queues to create.
289 * The netdev provider might choose to create less (e.g. if the hardware
290 * supports only a smaller number). The actual number of queues created
291 * is stored in the 'netdev->n_rxq' field.
293 * 'n_txq' specifies the exact number of transmission queues to create.
294 * The caller will call netdev_send() concurrently from 'n_txq' different
295 * threads (with different qid). The netdev provider is responsible for
296 * making sure that these concurrent calls do not create a race condition
297 * by using multiple hw queues or locking.
299 * On error, the tx queue and rx queue configuration is indeterminant.
300 * Caller should make decision on whether to restore the previous or
301 * the default configuration. Also, caller must make sure there is no
302 * other thread accessing the queues at the same time. */
303 int (*set_multiq
)(struct netdev
*netdev
, unsigned int n_txq
,
306 /* Sends buffers on 'netdev'.
307 * Returns 0 if successful (for every buffer), otherwise a positive errno
308 * value. Returns EAGAIN without blocking if one or more packets cannot be
309 * queued immediately. Returns EMSGSIZE if a partial packet was transmitted
310 * or if a packet is too big or too small to transmit on the device.
312 * If the function returns a non-zero value, some of the packets might have
315 * If 'may_steal' is false, the caller retains ownership of all the
316 * packets. If 'may_steal' is true, the caller transfers ownership of all
317 * the packets to the network device, regardless of success.
319 * The network device is expected to maintain one or more packet
320 * transmission queues, so that the caller does not ordinarily have to
321 * do additional queuing of packets. 'qid' specifies the queue to use
322 * and can be ignored if the implementation does not support multiple
325 * May return EOPNOTSUPP if a network device does not implement packet
326 * transmission through this interface. This function may be set to null
327 * if it would always return EOPNOTSUPP anyhow. (This will prevent the
328 * network device from being usefully used by the netdev-based "userspace
329 * datapath". It will also prevent the OVS implementation of bonding from
330 * working properly over 'netdev'.) */
331 int (*send
)(struct netdev
*netdev
, int qid
, struct dp_packet
**buffers
,
332 int cnt
, bool may_steal
);
334 /* Registers with the poll loop to wake up from the next call to
335 * poll_block() when the packet transmission queue for 'netdev' has
336 * sufficient room to transmit a packet with netdev_send().
338 * The network device is expected to maintain one or more packet
339 * transmission queues, so that the caller does not ordinarily have to
340 * do additional queuing of packets. 'qid' specifies the queue to use
341 * and can be ignored if the implementation does not support multiple
344 * May be null if not needed, such as for a network device that does not
345 * implement packet transmission through the 'send' member function. */
346 void (*send_wait
)(struct netdev
*netdev
, int qid
);
348 /* Sets 'netdev''s Ethernet address to 'mac' */
349 int (*set_etheraddr
)(struct netdev
*netdev
, const struct eth_addr mac
);
351 /* Retrieves 'netdev''s Ethernet address into 'mac'.
353 * This address will be advertised as 'netdev''s MAC address through the
354 * OpenFlow protocol, among other uses. */
355 int (*get_etheraddr
)(const struct netdev
*netdev
, struct eth_addr
*mac
);
357 /* Retrieves 'netdev''s MTU into '*mtup'.
359 * The MTU is the maximum size of transmitted (and received) packets, in
360 * bytes, not including the hardware header; thus, this is typically 1500
361 * bytes for Ethernet devices.
363 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
364 * this function should return EOPNOTSUPP. This function may be set to
365 * null if it would always return EOPNOTSUPP. */
366 int (*get_mtu
)(const struct netdev
*netdev
, int *mtup
);
368 /* Sets 'netdev''s MTU to 'mtu'.
370 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
371 * this function should return EOPNOTSUPP. This function may be set to
372 * null if it would always return EOPNOTSUPP. */
373 int (*set_mtu
)(const struct netdev
*netdev
, int mtu
);
375 /* Returns the ifindex of 'netdev', if successful, as a positive number.
376 * On failure, returns a negative errno value.
378 * The desired semantics of the ifindex value are a combination of those
379 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
380 * ifindex value should be unique within a host and remain stable at least
381 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
382 * ifNumber" but many systems do not follow this rule anyhow.
384 * This function may be set to null if it would always return -EOPNOTSUPP.
386 int (*get_ifindex
)(const struct netdev
*netdev
);
388 /* Sets 'carrier' to true if carrier is active (link light is on) on
391 * May be null if device does not provide carrier status (will be always
392 * up as long as device is up).
394 int (*get_carrier
)(const struct netdev
*netdev
, bool *carrier
);
396 /* Returns the number of times 'netdev''s carrier has changed since being
399 * If null, callers will assume the number of carrier resets is zero. */
400 long long int (*get_carrier_resets
)(const struct netdev
*netdev
);
402 /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
403 * instead of checking 'netdev''s carrier. 'netdev''s MII registers will
404 * be polled once every 'interval' milliseconds. If 'netdev' does not
405 * support MII, another method may be used as a fallback. If 'interval' is
406 * less than or equal to zero, reverts ->get_carrier() to its normal
409 * Most network devices won't support this feature and will set this
410 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
412 int (*set_miimon_interval
)(struct netdev
*netdev
, long long int interval
);
414 /* Retrieves current device stats for 'netdev' into 'stats'.
416 * A network device that supports some statistics but not others, it should
417 * set the values of the unsupported statistics to all-1-bits
419 int (*get_stats
)(const struct netdev
*netdev
, struct netdev_stats
*);
421 /* Stores the features supported by 'netdev' into each of '*current',
422 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
425 * This function may be set to null if it would always return EOPNOTSUPP.
427 int (*get_features
)(const struct netdev
*netdev
,
428 enum netdev_features
*current
,
429 enum netdev_features
*advertised
,
430 enum netdev_features
*supported
,
431 enum netdev_features
*peer
);
433 /* Set the features advertised by 'netdev' to 'advertise', which is a
434 * set of NETDEV_F_* bits.
436 * This function may be set to null for a network device that does not
437 * support configuring advertisements. */
438 int (*set_advertisements
)(struct netdev
*netdev
,
439 enum netdev_features advertise
);
441 /* Attempts to set input rate limiting (policing) policy, such that up to
442 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
443 * burst size of 'kbits' kb.
445 * This function may be set to null if policing is not supported. */
446 int (*set_policing
)(struct netdev
*netdev
, unsigned int kbits_rate
,
447 unsigned int kbits_burst
);
449 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
450 * it empty if 'netdev' does not support QoS. Any names added to 'types'
451 * should be documented as valid for the "type" column in the "QoS" table
452 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
454 * Every network device must support disabling QoS with a type of "", but
455 * this function must not add "" to 'types'.
457 * The caller is responsible for initializing 'types' (e.g. with
458 * sset_init()) before calling this function. The caller retains ownership
461 * May be NULL if 'netdev' does not support QoS at all. */
462 int (*get_qos_types
)(const struct netdev
*netdev
, struct sset
*types
);
464 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
465 * QoS. On success, initializes 'caps' with the QoS capabilities.
467 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
468 * NULL if 'netdev' does not support QoS at all. */
469 int (*get_qos_capabilities
)(const struct netdev
*netdev
,
471 struct netdev_qos_capabilities
*caps
);
473 /* Queries 'netdev' about its currently configured form of QoS. If
474 * successful, stores the name of the current form of QoS into '*typep'
475 * and any details of configuration as string key-value pairs in
478 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
480 * The caller initializes 'details' before calling this function. The
481 * caller takes ownership of the string key-values pairs added to
484 * The netdev retains ownership of '*typep'.
486 * '*typep' will be one of the types returned by netdev_get_qos_types() for
487 * 'netdev'. The contents of 'details' should be documented as valid for
488 * '*typep' in the "other_config" column in the "QoS" table in
489 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
491 * May be NULL if 'netdev' does not support QoS at all. */
492 int (*get_qos
)(const struct netdev
*netdev
,
493 const char **typep
, struct smap
*details
);
495 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
496 * 'type' with details of configuration from 'details'.
498 * On error, the previous QoS configuration is retained.
500 * When this function changes the type of QoS (not just 'details'), this
501 * also resets all queue configuration for 'netdev' to their defaults
502 * (which depend on the specific type of QoS). Otherwise, the queue
503 * configuration for 'netdev' is unchanged.
505 * 'type' should be "" (to disable QoS) or one of the types returned by
506 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
507 * be documented as valid for the given 'type' in the "other_config" column
508 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
509 * ovs-vswitchd.conf.db(8)).
511 * May be NULL if 'netdev' does not support QoS at all. */
512 int (*set_qos
)(struct netdev
*netdev
,
513 const char *type
, const struct smap
*details
);
515 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
516 * If successful, adds that information as string key-value pairs to
517 * 'details'. Returns 0 if successful, otherwise a positive errno value.
519 * Should return EINVAL if 'queue_id' is greater than or equal to the
520 * number of supported queues (as reported in the 'n_queues' member of
521 * struct netdev_qos_capabilities by 'get_qos_capabilities').
523 * The caller initializes 'details' before calling this function. The
524 * caller takes ownership of the string key-values pairs added to
527 * The returned contents of 'details' should be documented as valid for the
528 * given 'type' in the "other_config" column in the "Queue" table in
529 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
531 int (*get_queue
)(const struct netdev
*netdev
,
532 unsigned int queue_id
, struct smap
*details
);
534 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
535 * string pairs in 'details'. The contents of 'details' should be
536 * documented as valid for the given 'type' in the "other_config" column in
537 * the "Queue" table in vswitchd/vswitch.xml (which is built as
538 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
539 * errno value. On failure, the given queue's configuration should be
542 * Should return EINVAL if 'queue_id' is greater than or equal to the
543 * number of supported queues (as reported in the 'n_queues' member of
544 * struct netdev_qos_capabilities by 'get_qos_capabilities'), or if
545 * 'details' is invalid for the type of queue.
547 * This function does not modify 'details', and the caller retains
550 * May be NULL if 'netdev' does not support QoS at all. */
551 int (*set_queue
)(struct netdev
*netdev
,
552 unsigned int queue_id
, const struct smap
*details
);
554 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
556 * Should return EINVAL if 'queue_id' is greater than or equal to the
557 * number of supported queues (as reported in the 'n_queues' member of
558 * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should
559 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
560 * 'netdev' has a fixed set of queues with the current QoS mode).
562 * May be NULL if 'netdev' does not support QoS at all, or if all of its
563 * QoS modes have fixed sets of queues. */
564 int (*delete_queue
)(struct netdev
*netdev
, unsigned int queue_id
);
566 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
567 * queue's statistics. May set individual members of 'stats' to all-1-bits
568 * if the statistic is unavailable.
570 * May be NULL if 'netdev' does not support QoS at all. */
571 int (*get_queue_stats
)(const struct netdev
*netdev
, unsigned int queue_id
,
572 struct netdev_queue_stats
*stats
);
574 /* Attempts to begin dumping the queues in 'netdev'. On success, returns 0
575 * and initializes '*statep' with any data needed for iteration. On
576 * failure, returns a positive errno value.
578 * May be NULL if 'netdev' does not support QoS at all. */
579 int (*queue_dump_start
)(const struct netdev
*netdev
, void **statep
);
581 /* Attempts to retrieve another queue from 'netdev' for 'state', which was
582 * initialized by a successful call to the 'queue_dump_start' function for
583 * 'netdev'. On success, stores a queue ID into '*queue_id' and fills
584 * 'details' with the configuration of the queue with that ID. Returns EOF
585 * if the last queue has been dumped, or a positive errno value on error.
586 * This function will not be called again once it returns nonzero once for
587 * a given iteration (but the 'queue_dump_done' function will be called
590 * The caller initializes and clears 'details' before calling this
591 * function. The caller takes ownership of the string key-values pairs
592 * added to 'details'.
594 * The returned contents of 'details' should be documented as valid for the
595 * given 'type' in the "other_config" column in the "Queue" table in
596 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
598 * May be NULL if 'netdev' does not support QoS at all. */
599 int (*queue_dump_next
)(const struct netdev
*netdev
, void *state
,
600 unsigned int *queue_id
, struct smap
*details
);
602 /* Releases resources from 'netdev' for 'state', which was initialized by a
603 * successful call to the 'queue_dump_start' function for 'netdev'.
605 * May be NULL if 'netdev' does not support QoS at all. */
606 int (*queue_dump_done
)(const struct netdev
*netdev
, void *state
);
608 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
609 * ID, its statistics, and the 'aux' specified by the caller. The order of
610 * iteration is unspecified, but (when successful) each queue must be
611 * visited exactly once.
613 * 'cb' will not modify or free the statistics passed in. */
614 int (*dump_queue_stats
)(const struct netdev
*netdev
,
615 void (*cb
)(unsigned int queue_id
,
616 struct netdev_queue_stats
*,
620 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
621 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
623 * This function may be set to null if it would always return EOPNOTSUPP
625 int (*set_in4
)(struct netdev
*netdev
, struct in_addr addr
,
626 struct in_addr mask
);
628 /* Returns all assigned IP address to 'netdev' and returns 0.
629 * API allocates array of address and masks and set it to
630 * '*addr' and '*mask'.
631 * Otherwise, returns a positive errno value and sets '*addr', '*mask
632 * and '*n_addr' to NULL.
634 * The following error values have well-defined meanings:
636 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
638 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
640 * 'addr' may be null, in which case the address itself is not reported. */
641 int (*get_addr_list
)(const struct netdev
*netdev
, struct in6_addr
**in
,
642 struct in6_addr
**mask
, int *n_in6
);
644 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
645 * corresponds to 'netdev'.
647 * This function may be set to null if it would always return EOPNOTSUPP
649 int (*add_router
)(struct netdev
*netdev
, struct in_addr router
);
651 /* Looks up the next hop for 'host' in the host's routing table. If
652 * successful, stores the next hop gateway's address (0 if 'host' is on a
653 * directly connected network) in '*next_hop' and a copy of the name of the
654 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
655 * responsible for freeing '*netdev_name' (by calling free()).
657 * This function may be set to null if it would always return EOPNOTSUPP
659 int (*get_next_hop
)(const struct in_addr
*host
, struct in_addr
*next_hop
,
662 /* Retrieves driver information of the device.
664 * Populates 'smap' with key-value pairs representing the status of the
665 * device. 'smap' is a set of key-value string pairs representing netdev
666 * type specific information. For more information see
667 * ovs-vswitchd.conf.db(5).
669 * The caller is responsible for destroying 'smap' and its data.
671 * This function may be set to null if it would always return EOPNOTSUPP
673 int (*get_status
)(const struct netdev
*netdev
, struct smap
*smap
);
675 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
676 * corresponding MAC address in 'mac'. A return value of ENXIO, in
677 * particular, indicates that there is no ARP table entry for 'ip' on
680 * This function may be set to null if it would always return EOPNOTSUPP
682 int (*arp_lookup
)(const struct netdev
*netdev
, ovs_be32 ip
,
683 struct eth_addr
*mac
);
685 /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then,
686 * turns off the flags that are set to 1 in 'off' and turns on the flags
687 * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and
688 * 'on'; that is, off & on == 0.)
690 * This function may be invoked from a signal handler. Therefore, it
691 * should not do anything that is not signal-safe (such as logging). */
692 int (*update_flags
)(struct netdev
*netdev
, enum netdev_flags off
,
693 enum netdev_flags on
, enum netdev_flags
*old_flags
);
695 /* ## -------------------- ## */
696 /* ## netdev_rxq Functions ## */
697 /* ## -------------------- ## */
699 /* If a particular netdev class does not support receiving packets, all these
700 * function pointers must be NULL. */
702 /* Life-cycle functions for a netdev_rxq. See the large comment above on
703 * struct netdev_class. */
704 struct netdev_rxq
*(*rxq_alloc
)(void);
705 int (*rxq_construct
)(struct netdev_rxq
*);
706 void (*rxq_destruct
)(struct netdev_rxq
*);
707 void (*rxq_dealloc
)(struct netdev_rxq
*);
709 /* Attempts to receive a batch of packets from 'rx'. The caller supplies
710 * 'pkts' as the pointer to the beginning of an array of MAX_RX_BATCH
711 * pointers to dp_packet. If successful, the implementation stores
712 * pointers to up to MAX_RX_BATCH dp_packets into the array, transferring
713 * ownership of the packets to the caller, stores the number of received
714 * packets into '*cnt', and returns 0.
716 * The implementation does not necessarily initialize any non-data members
717 * of 'pkts'. That is, the caller must initialize layer pointers and
718 * metadata itself, if desired, e.g. with pkt_metadata_init() and
719 * miniflow_extract().
721 * Implementations should allocate buffers with DP_NETDEV_HEADROOM bytes of
724 * Returns EAGAIN immediately if no packet is ready to be received or
725 * another positive errno value if an error was encountered. */
726 int (*rxq_recv
)(struct netdev_rxq
*rx
, struct dp_packet
**pkts
,
729 /* Registers with the poll loop to wake up from the next call to
730 * poll_block() when a packet is ready to be received with
731 * netdev_rxq_recv() on 'rx'. */
732 void (*rxq_wait
)(struct netdev_rxq
*rx
);
734 /* Discards all packets waiting to be received from 'rx'. */
735 int (*rxq_drain
)(struct netdev_rxq
*rx
);
738 int netdev_register_provider(const struct netdev_class
*);
739 int netdev_unregister_provider(const char *type
);
741 #if defined(__FreeBSD__) || defined(__NetBSD__)
742 extern const struct netdev_class netdev_bsd_class
;
743 #elif defined(_WIN32)
744 extern const struct netdev_class netdev_windows_class
;
746 extern const struct netdev_class netdev_linux_class
;
748 extern const struct netdev_class netdev_internal_class
;
749 extern const struct netdev_class netdev_tap_class
;
755 #endif /* netdev.h */