2 * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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 /* ## ------------------- ## */
209 /* ## Top-Level Functions ## */
210 /* ## ------------------- ## */
212 /* Called when the netdev provider is registered, typically at program
213 * startup. Returning an error from this function will prevent any network
214 * device in this class from being opened.
216 * This function may be set to null if a network device class needs no
217 * initialization at registration time. */
220 /* Performs periodic work needed by netdevs of this class. May be null if
221 * no periodic work is necessary. */
224 /* Arranges for poll_block() to wake up if the "run" member function needs
225 * to be called. Implementations are additionally required to wake
226 * whenever something changes in any of its netdevs which would cause their
227 * ->change_seq() function to change its result. May be null if nothing is
231 /* ## ---------------- ## */
232 /* ## netdev Functions ## */
233 /* ## ---------------- ## */
235 /* Life-cycle functions for a netdev. See the large comment above on
236 * struct netdev_class. */
237 struct netdev *(*alloc)(void);
238 int (*construct)(struct netdev *);
239 void (*destruct)(struct netdev *);
240 void (*dealloc)(struct netdev *);
242 /* Fetches the device 'netdev''s configuration, storing it in 'args'.
243 * The caller owns 'args' and pre-initializes it to an empty smap.
245 * If this netdev class does not have any configuration options, this may
246 * be a null pointer. */
247 int (*get_config)(const struct netdev *netdev, struct smap *args);
249 /* Changes the device 'netdev''s configuration to 'args'.
251 * If this netdev class does not support configuration, this may be a null
253 int (*set_config)(struct netdev *netdev, const struct smap *args);
255 /* Returns the tunnel configuration of 'netdev'. If 'netdev' is
256 * not a tunnel, returns null.
258 * If this function would always return null, it may be null instead. */
259 const struct netdev_tunnel_config *
260 (*get_tunnel_config)(const struct netdev *netdev);
262 /* Build Partial Tunnel header. Ethernet and ip header is already built,
263 * build_header() is suppose build protocol specific part of header. */
264 int (*build_header)(const struct netdev *, struct ovs_action_push_tnl *data,
265 const struct flow *tnl_flow);
267 /* build_header() can not build entire header for all packets for given
268 * flow. Push header is called for packet to build header specific to
269 * a packet on actual transmit. It uses partial header build by
270 * build_header() which is passed as data. */
271 void (*push_header)(struct dp_packet *packet,
272 const struct ovs_action_push_tnl *data);
274 /* Pop tunnel header from packet, build tunnel metadata and resize packet
275 * for further processing. */
276 int (*pop_header)(struct dp_packet *packet);
278 /* Returns the id of the numa node the 'netdev' is on. If there is no
279 * such info, returns NETDEV_NUMA_UNSPEC. */
280 int (*get_numa_id)(const struct netdev *netdev);
282 /* Configures the number of tx queues and rx queues of 'netdev'.
283 * Return 0 if successful, otherwise a positive errno value.
285 * 'n_rxq' specifies the maximum number of receive queues to create.
286 * The netdev provider might choose to create less (e.g. if the hardware
287 * supports only a smaller number). The actual number of queues created
288 * is stored in the 'netdev->n_rxq' field.
290 * 'n_txq' specifies the exact number of transmission queues to create.
291 * The caller will call netdev_send() concurrently from 'n_txq' different
292 * threads (with different qid). The netdev provider is responsible for
293 * making sure that these concurrent calls do not create a race condition
294 * by using multiple hw queues or locking.
296 * On error, the tx queue and rx queue configuration is indeterminant.
297 * Caller should make decision on whether to restore the previous or
298 * the default configuration. Also, caller must make sure there is no
299 * other thread accessing the queues at the same time. */
300 int (*set_multiq)(struct netdev *netdev, unsigned int n_txq,
303 /* Sends buffers on 'netdev'.
304 * Returns 0 if successful (for every buffer), otherwise a positive errno
305 * value. Returns EAGAIN without blocking if one or more packets cannot be
306 * queued immediately. Returns EMSGSIZE if a partial packet was transmitted
307 * or if a packet is too big or too small to transmit on the device.
309 * If the function returns a non-zero value, some of the packets might have
312 * To retain ownership of 'buffers' caller can set may_steal to false.
314 * The network device is expected to maintain one or more packet
315 * transmission queues, so that the caller does not ordinarily have to
316 * do additional queuing of packets. 'qid' specifies the queue to use
317 * and can be ignored if the implementation does not support multiple
320 * May return EOPNOTSUPP if a network device does not implement packet
321 * transmission through this interface. This function may be set to null
322 * if it would always return EOPNOTSUPP anyhow. (This will prevent the
323 * network device from being usefully used by the netdev-based "userspace
324 * datapath". It will also prevent the OVS implementation of bonding from
325 * working properly over 'netdev'.) */
326 int (*send)(struct netdev *netdev, int qid, struct dp_packet **buffers,
327 int cnt, bool may_steal);
329 /* Registers with the poll loop to wake up from the next call to
330 * poll_block() when the packet transmission queue for 'netdev' has
331 * sufficient room to transmit a packet with netdev_send().
333 * The network device is expected to maintain one or more packet
334 * transmission queues, so that the caller does not ordinarily have to
335 * do additional queuing of packets. 'qid' specifies the queue to use
336 * and can be ignored if the implementation does not support multiple
339 * May be null if not needed, such as for a network device that does not
340 * implement packet transmission through the 'send' member function. */
341 void (*send_wait)(struct netdev *netdev, int qid);
343 /* Sets 'netdev''s Ethernet address to 'mac' */
344 int (*set_etheraddr)(struct netdev *netdev, const struct eth_addr mac);
346 /* Retrieves 'netdev''s Ethernet address into 'mac'.
348 * This address will be advertised as 'netdev''s MAC address through the
349 * OpenFlow protocol, among other uses. */
350 int (*get_etheraddr)(const struct netdev *netdev, struct eth_addr *mac);
352 /* Retrieves 'netdev''s MTU into '*mtup'.
354 * The MTU is the maximum size of transmitted (and received) packets, in
355 * bytes, not including the hardware header; thus, this is typically 1500
356 * bytes for Ethernet devices.
358 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
359 * this function should return EOPNOTSUPP. This function may be set to
360 * null if it would always return EOPNOTSUPP. */
361 int (*get_mtu)(const struct netdev *netdev, int *mtup);
363 /* Sets 'netdev''s MTU to 'mtu'.
365 * If 'netdev' does not have an MTU (e.g. as some tunnels do not), then
366 * this function should return EOPNOTSUPP. This function may be set to
367 * null if it would always return EOPNOTSUPP. */
368 int (*set_mtu)(const struct netdev *netdev, int mtu);
370 /* Returns the ifindex of 'netdev', if successful, as a positive number.
371 * On failure, returns a negative errno value.
373 * The desired semantics of the ifindex value are a combination of those
374 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An
375 * ifindex value should be unique within a host and remain stable at least
376 * until reboot. SNMP says an ifindex "ranges between 1 and the value of
377 * ifNumber" but many systems do not follow this rule anyhow.
379 * This function may be set to null if it would always return -EOPNOTSUPP.
381 int (*get_ifindex)(const struct netdev *netdev);
383 /* Sets 'carrier' to true if carrier is active (link light is on) on
386 * May be null if device does not provide carrier status (will be always
387 * up as long as device is up).
389 int (*get_carrier)(const struct netdev *netdev, bool *carrier);
391 /* Returns the number of times 'netdev''s carrier has changed since being
394 * If null, callers will assume the number of carrier resets is zero. */
395 long long int (*get_carrier_resets)(const struct netdev *netdev);
397 /* Forces ->get_carrier() to poll 'netdev''s MII registers for link status
398 * instead of checking 'netdev''s carrier. 'netdev''s MII registers will
399 * be polled once every 'interval' milliseconds. If 'netdev' does not
400 * support MII, another method may be used as a fallback. If 'interval' is
401 * less than or equal to zero, reverts ->get_carrier() to its normal
404 * Most network devices won't support this feature and will set this
405 * function pointer to NULL, which is equivalent to returning EOPNOTSUPP.
407 int (*set_miimon_interval)(struct netdev *netdev, long long int interval);
409 /* Retrieves current device stats for 'netdev' into 'stats'.
411 * A network device that supports some statistics but not others, it should
412 * set the values of the unsupported statistics to all-1-bits
414 int (*get_stats)(const struct netdev *netdev, struct netdev_stats *);
416 /* Stores the features supported by 'netdev' into each of '*current',
417 * '*advertised', '*supported', and '*peer'. Each value is a bitmap of
420 * This function may be set to null if it would always return EOPNOTSUPP.
422 int (*get_features)(const struct netdev *netdev,
423 enum netdev_features *current,
424 enum netdev_features *advertised,
425 enum netdev_features *supported,
426 enum netdev_features *peer);
428 /* Set the features advertised by 'netdev' to 'advertise', which is a
429 * set of NETDEV_F_* bits.
431 * This function may be set to null for a network device that does not
432 * support configuring advertisements. */
433 int (*set_advertisements)(struct netdev *netdev,
434 enum netdev_features advertise);
436 /* Attempts to set input rate limiting (policing) policy, such that up to
437 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative
438 * burst size of 'kbits' kb.
440 * This function may be set to null if policing is not supported. */
441 int (*set_policing)(struct netdev *netdev, unsigned int kbits_rate,
442 unsigned int kbits_burst);
444 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves
445 * it empty if 'netdev' does not support QoS. Any names added to 'types'
446 * should be documented as valid for the "type" column in the "QoS" table
447 * in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
449 * Every network device must support disabling QoS with a type of "", but
450 * this function must not add "" to 'types'.
452 * The caller is responsible for initializing 'types' (e.g. with
453 * sset_init()) before calling this function. The caller retains ownership
456 * May be NULL if 'netdev' does not support QoS at all. */
457 int (*get_qos_types)(const struct netdev *netdev, struct sset *types);
459 /* Queries 'netdev' for its capabilities regarding the specified 'type' of
460 * QoS. On success, initializes 'caps' with the QoS capabilities.
462 * Should return EOPNOTSUPP if 'netdev' does not support 'type'. May be
463 * NULL if 'netdev' does not support QoS at all. */
464 int (*get_qos_capabilities)(const struct netdev *netdev,
466 struct netdev_qos_capabilities *caps);
468 /* Queries 'netdev' about its currently configured form of QoS. If
469 * successful, stores the name of the current form of QoS into '*typep'
470 * and any details of configuration as string key-value pairs in
473 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
475 * The caller initializes 'details' before calling this function. The
476 * caller takes ownership of the string key-values pairs added to
479 * The netdev retains ownership of '*typep'.
481 * '*typep' will be one of the types returned by netdev_get_qos_types() for
482 * 'netdev'. The contents of 'details' should be documented as valid for
483 * '*typep' in the "other_config" column in the "QoS" table in
484 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
486 * May be NULL if 'netdev' does not support QoS at all. */
487 int (*get_qos)(const struct netdev *netdev,
488 const char **typep, struct smap *details);
490 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to
491 * 'type' with details of configuration from 'details'.
493 * On error, the previous QoS configuration is retained.
495 * When this function changes the type of QoS (not just 'details'), this
496 * also resets all queue configuration for 'netdev' to their defaults
497 * (which depend on the specific type of QoS). Otherwise, the queue
498 * configuration for 'netdev' is unchanged.
500 * 'type' should be "" (to disable QoS) or one of the types returned by
501 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should
502 * be documented as valid for the given 'type' in the "other_config" column
503 * in the "QoS" table in vswitchd/vswitch.xml (which is built as
504 * ovs-vswitchd.conf.db(8)).
506 * May be NULL if 'netdev' does not support QoS at all. */
507 int (*set_qos)(struct netdev *netdev,
508 const char *type, const struct smap *details);
510 /* Queries 'netdev' for information about the queue numbered 'queue_id'.
511 * If successful, adds that information as string key-value pairs to
512 * 'details'. Returns 0 if successful, otherwise a positive errno value.
514 * Should return EINVAL if 'queue_id' is greater than or equal to the
515 * number of supported queues (as reported in the 'n_queues' member of
516 * struct netdev_qos_capabilities by 'get_qos_capabilities').
518 * The caller initializes 'details' before calling this function. The
519 * caller takes ownership of the string key-values pairs added to
522 * The returned contents of 'details' should be documented as valid for the
523 * given 'type' in the "other_config" column in the "Queue" table in
524 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
526 int (*get_queue)(const struct netdev *netdev,
527 unsigned int queue_id, struct smap *details);
529 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
530 * string pairs in 'details'. The contents of 'details' should be
531 * documented as valid for the given 'type' in the "other_config" column in
532 * the "Queue" table in vswitchd/vswitch.xml (which is built as
533 * ovs-vswitchd.conf.db(8)). Returns 0 if successful, otherwise a positive
534 * errno value. On failure, the given queue's configuration should be
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'), or if
540 * 'details' is invalid for the type of queue.
542 * This function does not modify 'details', and the caller retains
545 * May be NULL if 'netdev' does not support QoS at all. */
546 int (*set_queue)(struct netdev *netdev,
547 unsigned int queue_id, const struct smap *details);
549 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.
551 * Should return EINVAL if 'queue_id' is greater than or equal to the
552 * number of supported queues (as reported in the 'n_queues' member of
553 * struct netdev_qos_capabilities by 'get_qos_capabilities'). Should
554 * return EOPNOTSUPP if 'queue_id' is valid but may not be deleted (e.g. if
555 * 'netdev' has a fixed set of queues with the current QoS mode).
557 * May be NULL if 'netdev' does not support QoS at all, or if all of its
558 * QoS modes have fixed sets of queues. */
559 int (*delete_queue)(struct netdev *netdev, unsigned int queue_id);
561 /* Obtains statistics about 'queue_id' on 'netdev'. Fills 'stats' with the
562 * queue's statistics. May set individual members of 'stats' to all-1-bits
563 * if the statistic is unavailable.
565 * May be NULL if 'netdev' does not support QoS at all. */
566 int (*get_queue_stats)(const struct netdev *netdev, unsigned int queue_id,
567 struct netdev_queue_stats *stats);
569 /* Attempts to begin dumping the queues in 'netdev'. On success, returns 0
570 * and initializes '*statep' with any data needed for iteration. On
571 * failure, returns a positive errno value.
573 * May be NULL if 'netdev' does not support QoS at all. */
574 int (*queue_dump_start)(const struct netdev *netdev, void **statep);
576 /* Attempts to retrieve another queue from 'netdev' for 'state', which was
577 * initialized by a successful call to the 'queue_dump_start' function for
578 * 'netdev'. On success, stores a queue ID into '*queue_id' and fills
579 * 'details' with the configuration of the queue with that ID. Returns EOF
580 * if the last queue has been dumped, or a positive errno value on error.
581 * This function will not be called again once it returns nonzero once for
582 * a given iteration (but the 'queue_dump_done' function will be called
585 * The caller initializes and clears 'details' before calling this
586 * function. The caller takes ownership of the string key-values pairs
587 * added to 'details'.
589 * The returned contents of 'details' should be documented as valid for the
590 * given 'type' in the "other_config" column in the "Queue" table in
591 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
593 * May be NULL if 'netdev' does not support QoS at all. */
594 int (*queue_dump_next)(const struct netdev *netdev, void *state,
595 unsigned int *queue_id, struct smap *details);
597 /* Releases resources from 'netdev' for 'state', which was initialized by a
598 * successful call to the 'queue_dump_start' function for 'netdev'.
600 * May be NULL if 'netdev' does not support QoS at all. */
601 int (*queue_dump_done)(const struct netdev *netdev, void *state);
603 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's
604 * ID, its statistics, and the 'aux' specified by the caller. The order of
605 * iteration is unspecified, but (when successful) each queue must be
606 * visited exactly once.
608 * 'cb' will not modify or free the statistics passed in. */
609 int (*dump_queue_stats)(const struct netdev *netdev,
610 void (*cb)(unsigned int queue_id,
611 struct netdev_queue_stats *,
615 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that
616 * address and '*netmask' to the associated netmask.
618 * The following error values have well-defined meanings:
620 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
622 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
624 * This function may be set to null if it would always return EOPNOTSUPP
626 int (*get_in4)(const struct netdev *netdev, struct in_addr *address,
627 struct in_addr *netmask);
629 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
630 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.
632 * This function may be set to null if it would always return EOPNOTSUPP
634 int (*set_in4)(struct netdev *netdev, struct in_addr addr,
635 struct in_addr mask);
637 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address.
639 * The following error values have well-defined meanings:
641 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
643 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
645 * This function may be set to null if it would always return EOPNOTSUPP
647 int (*get_in6)(const struct netdev *netdev, struct in6_addr *in6);
649 /* Adds 'router' as a default IP gateway for the TCP/IP stack that
650 * corresponds to 'netdev'.
652 * This function may be set to null if it would always return EOPNOTSUPP
654 int (*add_router)(struct netdev *netdev, struct in_addr router);
656 /* Looks up the next hop for 'host' in the host's routing table. If
657 * successful, stores the next hop gateway's address (0 if 'host' is on a
658 * directly connected network) in '*next_hop' and a copy of the name of the
659 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
660 * responsible for freeing '*netdev_name' (by calling free()).
662 * This function may be set to null if it would always return EOPNOTSUPP
664 int (*get_next_hop)(const struct in_addr *host, struct in_addr *next_hop,
667 /* Retrieves driver information of the device.
669 * Populates 'smap' with key-value pairs representing the status of the
670 * device. 'smap' is a set of key-value string pairs representing netdev
671 * type specific information. For more information see
672 * ovs-vswitchd.conf.db(5).
674 * The caller is responsible for destroying 'smap' and its data.
676 * This function may be set to null if it would always return EOPNOTSUPP
678 int (*get_status)(const struct netdev *netdev, struct smap *smap);
680 /* Looks up the ARP table entry for 'ip' on 'netdev' and stores the
681 * corresponding MAC address in 'mac'. A return value of ENXIO, in
682 * particular, indicates that there is no ARP table entry for 'ip' on
685 * This function may be set to null if it would always return EOPNOTSUPP
687 int (*arp_lookup)(const struct netdev *netdev, ovs_be32 ip,
688 struct eth_addr *mac);
690 /* Retrieves the current set of flags on 'netdev' into '*old_flags'. Then,
691 * turns off the flags that are set to 1 in 'off' and turns on the flags
692 * that are set to 1 in 'on'. (No bit will be set to 1 in both 'off' and
693 * 'on'; that is, off & on == 0.)
695 * This function may be invoked from a signal handler. Therefore, it
696 * should not do anything that is not signal-safe (such as logging). */
697 int (*update_flags)(struct netdev *netdev, enum netdev_flags off,
698 enum netdev_flags on, enum netdev_flags *old_flags);
700 /* ## -------------------- ## */
701 /* ## netdev_rxq Functions ## */
702 /* ## -------------------- ## */
704 /* If a particular netdev class does not support receiving packets, all these
705 * function pointers must be NULL. */
707 /* Life-cycle functions for a netdev_rxq. See the large comment above on
708 * struct netdev_class. */
709 struct netdev_rxq *(*rxq_alloc)(void);
710 int (*rxq_construct)(struct netdev_rxq *);
711 void (*rxq_destruct)(struct netdev_rxq *);
712 void (*rxq_dealloc)(struct netdev_rxq *);
714 /* Attempts to receive batch of packets from 'rx' and place array of
715 * pointers into '*pkts'. netdev is responsible for allocating buffers.
716 * '*cnt' points to packet count for given batch. Once packets are returned
717 * to caller, netdev should give up ownership of ofpbuf data.
719 * Implementations should allocate buffer with DP_NETDEV_HEADROOM headroom
720 * and add a VLAN header which is obtained out-of-band to the packet.
722 * Caller is expected to pass array of size MAX_RX_BATCH.
723 * This function may be set to null if it would always return EOPNOTSUPP
725 int (*rxq_recv)(struct netdev_rxq *rx, struct dp_packet **pkts,
728 /* Registers with the poll loop to wake up from the next call to
729 * poll_block() when a packet is ready to be received with netdev_rxq_recv()
731 void (*rxq_wait)(struct netdev_rxq *rx);
733 /* Discards all packets waiting to be received from 'rx'. */
734 int (*rxq_drain)(struct netdev_rxq *rx);
737 int netdev_register_provider(const struct netdev_class *);
738 int netdev_unregister_provider(const char *type);
740 #if defined(__FreeBSD__) || defined(__NetBSD__)
741 extern const struct netdev_class netdev_bsd_class;
742 #elif defined(_WIN32)
743 extern const struct netdev_class netdev_windows_class;
745 extern const struct netdev_class netdev_linux_class;
747 extern const struct netdev_class netdev_internal_class;
748 extern const struct netdev_class netdev_tap_class;
754 #endif /* netdev.h */