2 * Copyright (c) 2008, 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.
22 #include <netinet/in.h>
29 #include "dp-packet.h"
30 #include "dynamic-string.h"
31 #include "fatal-signal.h"
34 #include "netdev-dpdk.h"
35 #include "netdev-provider.h"
36 #include "netdev-vport.h"
37 #include "odp-netlink.h"
38 #include "openflow/openflow.h"
40 #include "poll-loop.h"
46 #include "openvswitch/vlog.h"
49 VLOG_DEFINE_THIS_MODULE(netdev);
51 COVERAGE_DEFINE(netdev_received);
52 COVERAGE_DEFINE(netdev_sent);
53 COVERAGE_DEFINE(netdev_add_router);
54 COVERAGE_DEFINE(netdev_get_stats);
56 struct netdev_saved_flags {
57 struct netdev *netdev;
58 struct ovs_list node; /* In struct netdev's saved_flags_list. */
59 enum netdev_flags saved_flags;
60 enum netdev_flags saved_values;
63 /* Protects 'netdev_shash' and the mutable members of struct netdev. */
64 static struct ovs_mutex netdev_mutex = OVS_MUTEX_INITIALIZER;
66 /* All created network devices. */
67 static struct shash netdev_shash OVS_GUARDED_BY(netdev_mutex)
68 = SHASH_INITIALIZER(&netdev_shash);
70 /* Protects 'netdev_classes' against insertions or deletions.
72 * This is a recursive mutex to allow recursive acquisition when calling into
73 * providers. For example, netdev_run() calls into provider 'run' functions,
74 * which might reasonably want to call one of the netdev functions that takes
75 * netdev_class_mutex. */
76 static struct ovs_mutex netdev_class_mutex OVS_ACQ_BEFORE(netdev_mutex);
78 /* Contains 'struct netdev_registered_class'es. */
79 static struct hmap netdev_classes OVS_GUARDED_BY(netdev_class_mutex)
80 = HMAP_INITIALIZER(&netdev_classes);
82 struct netdev_registered_class {
83 /* In 'netdev_classes', by class->type. */
84 struct hmap_node hmap_node OVS_GUARDED_BY(netdev_class_mutex);
85 const struct netdev_class *class OVS_GUARDED_BY(netdev_class_mutex);
86 /* Number of 'struct netdev's of this class. */
87 int ref_cnt OVS_GUARDED_BY(netdev_class_mutex);
90 /* This is set pretty low because we probably won't learn anything from the
91 * additional log messages. */
92 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
94 static void restore_all_flags(void *aux OVS_UNUSED);
95 void update_device_args(struct netdev *, const struct shash *args);
98 netdev_n_txq(const struct netdev *netdev)
100 return netdev->n_txq;
104 netdev_n_rxq(const struct netdev *netdev)
106 return netdev->n_rxq;
110 netdev_is_pmd(const struct netdev *netdev)
112 return (!strcmp(netdev->netdev_class->type, "dpdk") ||
113 !strcmp(netdev->netdev_class->type, "dpdkr") ||
114 !strcmp(netdev->netdev_class->type, "dpdkvhost"));
118 netdev_class_mutex_initialize(void)
119 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
121 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
123 if (ovsthread_once_start(&once)) {
124 ovs_mutex_init_recursive(&netdev_class_mutex);
125 ovsthread_once_done(&once);
130 netdev_initialize(void)
131 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
133 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
135 if (ovsthread_once_start(&once)) {
136 netdev_class_mutex_initialize();
138 fatal_signal_add_hook(restore_all_flags, NULL, NULL, true);
139 netdev_vport_patch_register();
142 netdev_register_provider(&netdev_linux_class);
143 netdev_register_provider(&netdev_internal_class);
144 netdev_register_provider(&netdev_tap_class);
145 netdev_vport_tunnel_register();
147 #if defined(__FreeBSD__) || defined(__NetBSD__)
148 netdev_register_provider(&netdev_tap_class);
149 netdev_register_provider(&netdev_bsd_class);
152 netdev_register_provider(&netdev_windows_class);
153 netdev_register_provider(&netdev_internal_class);
154 netdev_vport_tunnel_register();
156 netdev_dpdk_register();
158 ovsthread_once_done(&once);
162 /* Performs periodic work needed by all the various kinds of netdevs.
164 * If your program opens any netdevs, it must call this function within its
168 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
170 struct netdev_registered_class *rc;
173 ovs_mutex_lock(&netdev_class_mutex);
174 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
175 if (rc->class->run) {
179 ovs_mutex_unlock(&netdev_class_mutex);
182 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
184 * If your program opens any netdevs, it must call this function within its
188 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
190 struct netdev_registered_class *rc;
192 ovs_mutex_lock(&netdev_class_mutex);
193 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
194 if (rc->class->wait) {
198 ovs_mutex_unlock(&netdev_class_mutex);
201 static struct netdev_registered_class *
202 netdev_lookup_class(const char *type)
203 OVS_REQ_RDLOCK(netdev_class_mutex)
205 struct netdev_registered_class *rc;
207 HMAP_FOR_EACH_WITH_HASH (rc, hmap_node, hash_string(type, 0),
209 if (!strcmp(type, rc->class->type)) {
216 /* Initializes and registers a new netdev provider. After successful
217 * registration, new netdevs of that type can be opened using netdev_open(). */
219 netdev_register_provider(const struct netdev_class *new_class)
220 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
224 netdev_class_mutex_initialize();
225 ovs_mutex_lock(&netdev_class_mutex);
226 if (netdev_lookup_class(new_class->type)) {
227 VLOG_WARN("attempted to register duplicate netdev provider: %s",
231 error = new_class->init ? new_class->init() : 0;
233 struct netdev_registered_class *rc;
235 rc = xmalloc(sizeof *rc);
236 hmap_insert(&netdev_classes, &rc->hmap_node,
237 hash_string(new_class->type, 0));
238 rc->class = new_class;
241 VLOG_ERR("failed to initialize %s network device class: %s",
242 new_class->type, ovs_strerror(error));
245 ovs_mutex_unlock(&netdev_class_mutex);
250 /* Unregisters a netdev provider. 'type' must have been previously
251 * registered and not currently be in use by any netdevs. After unregistration
252 * new netdevs of that type cannot be opened using netdev_open(). */
254 netdev_unregister_provider(const char *type)
255 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
257 struct netdev_registered_class *rc;
262 ovs_mutex_lock(&netdev_class_mutex);
263 rc = netdev_lookup_class(type);
265 VLOG_WARN("attempted to unregister a netdev provider that is not "
266 "registered: %s", type);
267 error = EAFNOSUPPORT;
270 hmap_remove(&netdev_classes, &rc->hmap_node);
274 VLOG_WARN("attempted to unregister in use netdev provider: %s",
279 ovs_mutex_unlock(&netdev_class_mutex);
284 /* Clears 'types' and enumerates the types of all currently registered netdev
285 * providers into it. The caller must first initialize the sset. */
287 netdev_enumerate_types(struct sset *types)
288 OVS_EXCLUDED(netdev_mutex)
290 struct netdev_registered_class *rc;
295 ovs_mutex_lock(&netdev_class_mutex);
296 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
297 sset_add(types, rc->class->type);
299 ovs_mutex_unlock(&netdev_class_mutex);
302 /* Check that the network device name is not the same as any of the registered
303 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
304 * does not define it) or the datapath internal port name (e.g. ovs-system).
306 * Returns true if there is a name conflict, false otherwise. */
308 netdev_is_reserved_name(const char *name)
309 OVS_EXCLUDED(netdev_mutex)
311 struct netdev_registered_class *rc;
315 ovs_mutex_lock(&netdev_class_mutex);
316 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
317 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
318 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
319 ovs_mutex_unlock(&netdev_class_mutex);
323 ovs_mutex_unlock(&netdev_class_mutex);
325 if (!strncmp(name, "ovs-", 4)) {
330 dp_enumerate_types(&types);
331 SSET_FOR_EACH (type, &types) {
332 if (!strcmp(name+4, type)) {
333 sset_destroy(&types);
337 sset_destroy(&types);
343 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
344 * (e.g. "system") and returns zero if successful, otherwise a positive errno
345 * value. On success, sets '*netdevp' to the new network device, otherwise to
348 * Some network devices may need to be configured (with netdev_set_config())
349 * before they can be used. */
351 netdev_open(const char *name, const char *type, struct netdev **netdevp)
352 OVS_EXCLUDED(netdev_mutex)
354 struct netdev *netdev;
359 ovs_mutex_lock(&netdev_class_mutex);
360 ovs_mutex_lock(&netdev_mutex);
361 netdev = shash_find_data(&netdev_shash, name);
363 struct netdev_registered_class *rc;
365 rc = netdev_lookup_class(type && type[0] ? type : "system");
367 netdev = rc->class->alloc();
369 memset(netdev, 0, sizeof *netdev);
370 netdev->netdev_class = rc->class;
371 netdev->name = xstrdup(name);
372 netdev->change_seq = 1;
373 netdev->node = shash_add(&netdev_shash, name, netdev);
375 /* By default enable one tx and rx queue per netdev. */
376 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
377 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
379 list_init(&netdev->saved_flags_list);
381 error = rc->class->construct(netdev);
384 netdev_change_seq_changed(netdev);
387 ovs_assert(list_is_empty(&netdev->saved_flags_list));
388 shash_delete(&netdev_shash, netdev->node);
389 rc->class->dealloc(netdev);
395 VLOG_WARN("could not create netdev %s of unknown type %s",
397 error = EAFNOSUPPORT;
409 ovs_mutex_unlock(&netdev_mutex);
410 ovs_mutex_unlock(&netdev_class_mutex);
415 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
416 * 'netdev_' is null. */
418 netdev_ref(const struct netdev *netdev_)
419 OVS_EXCLUDED(netdev_mutex)
421 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
424 ovs_mutex_lock(&netdev_mutex);
425 ovs_assert(netdev->ref_cnt > 0);
427 ovs_mutex_unlock(&netdev_mutex);
432 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
433 * or NULL if none are needed. */
435 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
436 OVS_EXCLUDED(netdev_mutex)
438 if (netdev->netdev_class->set_config) {
439 const struct smap no_args = SMAP_INITIALIZER(&no_args);
442 error = netdev->netdev_class->set_config(netdev,
443 args ? args : &no_args);
445 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
446 netdev_get_name(netdev), ovs_strerror(error));
449 } else if (args && !smap_is_empty(args)) {
450 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
451 netdev_get_name(netdev));
456 /* Returns the current configuration for 'netdev' in 'args'. The caller must
457 * have already initialized 'args' with smap_init(). Returns 0 on success, in
458 * which case 'args' will be filled with 'netdev''s configuration. On failure
459 * returns a positive errno value, in which case 'args' will be empty.
461 * The caller owns 'args' and its contents and must eventually free them with
464 netdev_get_config(const struct netdev *netdev, struct smap *args)
465 OVS_EXCLUDED(netdev_mutex)
470 if (netdev->netdev_class->get_config) {
471 error = netdev->netdev_class->get_config(netdev, args);
482 const struct netdev_tunnel_config *
483 netdev_get_tunnel_config(const struct netdev *netdev)
484 OVS_EXCLUDED(netdev_mutex)
486 if (netdev->netdev_class->get_tunnel_config) {
487 return netdev->netdev_class->get_tunnel_config(netdev);
493 /* Returns the id of the numa node the 'netdev' is on. If the function
494 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
496 netdev_get_numa_id(const struct netdev *netdev)
498 if (netdev->netdev_class->get_numa_id) {
499 return netdev->netdev_class->get_numa_id(netdev);
501 return NETDEV_NUMA_UNSPEC;
506 netdev_unref(struct netdev *dev)
507 OVS_RELEASES(netdev_mutex)
509 ovs_assert(dev->ref_cnt);
510 if (!--dev->ref_cnt) {
511 const struct netdev_class *class = dev->netdev_class;
512 struct netdev_registered_class *rc;
514 dev->netdev_class->destruct(dev);
517 shash_delete(&netdev_shash, dev->node);
520 dev->netdev_class->dealloc(dev);
521 ovs_mutex_unlock(&netdev_mutex);
523 ovs_mutex_lock(&netdev_class_mutex);
524 rc = netdev_lookup_class(class->type);
525 ovs_assert(rc->ref_cnt > 0);
527 ovs_mutex_unlock(&netdev_class_mutex);
529 ovs_mutex_unlock(&netdev_mutex);
533 /* Closes and destroys 'netdev'. */
535 netdev_close(struct netdev *netdev)
536 OVS_EXCLUDED(netdev_mutex)
539 ovs_mutex_lock(&netdev_mutex);
540 netdev_unref(netdev);
544 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
546 * This allows handler and revalidator threads to still retain references
547 * to this netdev while the main thread changes interface configuration.
549 * This function should only be called by the main thread when closing
550 * netdevs during user configuration changes. Otherwise, netdev_close should be
551 * used to close netdevs. */
553 netdev_remove(struct netdev *netdev)
556 ovs_mutex_lock(&netdev_mutex);
558 shash_delete(&netdev_shash, netdev->node);
560 netdev_change_seq_changed(netdev);
562 netdev_unref(netdev);
566 /* Parses 'netdev_name_', which is of the form [type@]name into its component
567 * pieces. 'name' and 'type' must be freed by the caller. */
569 netdev_parse_name(const char *netdev_name_, char **name, char **type)
571 char *netdev_name = xstrdup(netdev_name_);
574 separator = strchr(netdev_name, '@');
578 *name = xstrdup(separator + 1);
581 *type = xstrdup("system");
585 /* Attempts to open a netdev_rxq handle for obtaining packets received on
586 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
587 * '*rxp'. On failure, returns a positive errno value and stores NULL into
590 * Some kinds of network devices might not support receiving packets. This
591 * function returns EOPNOTSUPP in that case.*/
593 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
594 OVS_EXCLUDED(netdev_mutex)
598 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
599 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
603 error = netdev->netdev_class->rxq_construct(rx);
609 netdev->netdev_class->rxq_dealloc(rx);
623 netdev_rxq_close(struct netdev_rxq *rx)
624 OVS_EXCLUDED(netdev_mutex)
627 struct netdev *netdev = rx->netdev;
628 netdev->netdev_class->rxq_destruct(rx);
629 netdev->netdev_class->rxq_dealloc(rx);
630 netdev_close(netdev);
634 /* Attempts to receive batch of packets from 'rx'.
636 * Returns EAGAIN immediately if no packet is ready to be received.
638 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
639 * than 'dp_packet_tailroom(buffer)'.
641 * It is advised that the tailroom of 'buffer' should be
642 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
643 * out-of-band VLAN header to be added to the packet. At the very least,
644 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
646 * This function may be set to null if it would always return EOPNOTSUPP
649 netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet **buffers, int *cnt)
653 retval = rx->netdev->netdev_class->rxq_recv(rx, buffers, cnt);
655 COVERAGE_INC(netdev_received);
660 /* Arranges for poll_block() to wake up when a packet is ready to be received
663 netdev_rxq_wait(struct netdev_rxq *rx)
665 rx->netdev->netdev_class->rxq_wait(rx);
668 /* Discards any packets ready to be received on 'rx'. */
670 netdev_rxq_drain(struct netdev_rxq *rx)
672 return (rx->netdev->netdev_class->rxq_drain
673 ? rx->netdev->netdev_class->rxq_drain(rx)
677 /* Configures the number of tx queues and rx queues of 'netdev'.
678 * Return 0 if successful, otherwise a positive errno value.
680 * 'n_rxq' specifies the maximum number of receive queues to create.
681 * The netdev provider might choose to create less (e.g. if the hardware
682 * supports only a smaller number). The caller can check how many have been
683 * actually created by calling 'netdev_n_rxq()'
685 * 'n_txq' specifies the exact number of transmission queues to create.
686 * If this function returns successfully, the caller can make 'n_txq'
687 * concurrent calls to netdev_send() (each one with a different 'qid' in the
688 * range [0..'n_txq'-1]).
690 * On error, the tx queue and rx queue configuration is indeterminant.
691 * Caller should make decision on whether to restore the previous or
692 * the default configuration. Also, caller must make sure there is no
693 * other thread accessing the queues at the same time. */
695 netdev_set_multiq(struct netdev *netdev, unsigned int n_txq,
700 error = (netdev->netdev_class->set_multiq
701 ? netdev->netdev_class->set_multiq(netdev,
706 if (error && error != EOPNOTSUPP) {
707 VLOG_DBG_RL(&rl, "failed to set tx/rx queue for network device %s:"
708 "%s", netdev_get_name(netdev), ovs_strerror(error));
714 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
715 * otherwise a positive errno value. Returns EAGAIN without blocking if
716 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
717 * if a partial packet was transmitted or if a packet is too big or too small
718 * to transmit on the device.
720 * If the function returns a non-zero value, some of the packets might have
723 * To retain ownership of 'buffer' caller can set may_steal to false.
725 * The network device is expected to maintain one or more packet
726 * transmission queues, so that the caller does not ordinarily have to
727 * do additional queuing of packets. 'qid' specifies the queue to use
728 * and can be ignored if the implementation does not support multiple
731 * Some network devices may not implement support for this function. In such
732 * cases this function will always return EOPNOTSUPP. */
734 netdev_send(struct netdev *netdev, int qid, struct dp_packet **buffers,
735 int cnt, bool may_steal)
739 error = (netdev->netdev_class->send
740 ? netdev->netdev_class->send(netdev, qid, buffers, cnt, may_steal)
743 COVERAGE_INC(netdev_sent);
749 netdev_pop_header(struct netdev *netdev, struct dp_packet **buffers, int cnt)
753 if (!netdev->netdev_class->pop_header) {
757 for (i = 0; i < cnt; i++) {
760 err = netdev->netdev_class->pop_header(buffers[i]);
762 dp_packet_clear(buffers[i]);
770 netdev_build_header(const struct netdev *netdev, struct ovs_action_push_tnl *data,
771 const struct flow *tnl_flow)
773 if (netdev->netdev_class->build_header) {
774 return netdev->netdev_class->build_header(netdev, data, tnl_flow);
780 netdev_push_header(const struct netdev *netdev,
781 struct dp_packet **buffers, int cnt,
782 const struct ovs_action_push_tnl *data)
786 if (!netdev->netdev_class->push_header) {
790 for (i = 0; i < cnt; i++) {
791 netdev->netdev_class->push_header(buffers[i], data);
792 buffers[i]->md = PKT_METADATA_INITIALIZER(u32_to_odp(data->out_port));
798 /* Registers with the poll loop to wake up from the next call to poll_block()
799 * when the packet transmission queue has sufficient room to transmit a packet
800 * with netdev_send().
802 * The network device is expected to maintain one or more packet
803 * transmission queues, so that the caller does not ordinarily have to
804 * do additional queuing of packets. 'qid' specifies the queue to use
805 * and can be ignored if the implementation does not support multiple
808 netdev_send_wait(struct netdev *netdev, int qid)
810 if (netdev->netdev_class->send_wait) {
811 netdev->netdev_class->send_wait(netdev, qid);
815 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
816 * otherwise a positive errno value. */
818 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
820 return netdev->netdev_class->set_etheraddr(netdev, mac);
823 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
824 * the MAC address into 'mac'. On failure, returns a positive errno value and
825 * clears 'mac' to all-zeros. */
827 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
829 return netdev->netdev_class->get_etheraddr(netdev, mac);
832 /* Returns the name of the network device that 'netdev' represents,
833 * e.g. "eth0". The caller must not modify or free the returned string. */
835 netdev_get_name(const struct netdev *netdev)
840 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
841 * (and received) packets, in bytes, not including the hardware header; thus,
842 * this is typically 1500 bytes for Ethernet devices.
844 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
845 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
846 * On other failure, returns a positive errno value. On failure, sets '*mtup'
849 netdev_get_mtu(const struct netdev *netdev, int *mtup)
851 const struct netdev_class *class = netdev->netdev_class;
854 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
857 if (error != EOPNOTSUPP) {
858 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
859 "%s", netdev_get_name(netdev), ovs_strerror(error));
865 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
866 * (and received) packets, in bytes.
868 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
869 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
872 netdev_set_mtu(const struct netdev *netdev, int mtu)
874 const struct netdev_class *class = netdev->netdev_class;
877 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
878 if (error && error != EOPNOTSUPP) {
879 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
880 netdev_get_name(netdev), ovs_strerror(error));
886 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
887 * failure, returns a negative errno value.
889 * The desired semantics of the ifindex value are a combination of those
890 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
891 * value should be unique within a host and remain stable at least until
892 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
893 * but many systems do not follow this rule anyhow.
895 * Some network devices may not implement support for this function. In such
896 * cases this function will always return -EOPNOTSUPP.
899 netdev_get_ifindex(const struct netdev *netdev)
901 int (*get_ifindex)(const struct netdev *);
903 get_ifindex = netdev->netdev_class->get_ifindex;
905 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
908 /* Stores the features supported by 'netdev' into each of '*current',
909 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
910 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
911 * successful, otherwise a positive errno value. On failure, all of the
912 * passed-in values are set to 0.
914 * Some network devices may not implement support for this function. In such
915 * cases this function will always return EOPNOTSUPP. */
917 netdev_get_features(const struct netdev *netdev,
918 enum netdev_features *current,
919 enum netdev_features *advertised,
920 enum netdev_features *supported,
921 enum netdev_features *peer)
923 int (*get_features)(const struct netdev *netdev,
924 enum netdev_features *current,
925 enum netdev_features *advertised,
926 enum netdev_features *supported,
927 enum netdev_features *peer);
928 enum netdev_features dummy[4];
935 advertised = &dummy[1];
938 supported = &dummy[2];
944 get_features = netdev->netdev_class->get_features;
946 ? get_features(netdev, current, advertised, supported,
950 *current = *advertised = *supported = *peer = 0;
955 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
956 * bits in 'features', in bits per second. If no bits that indicate a speed
957 * are set in 'features', returns 'default_bps'. */
959 netdev_features_to_bps(enum netdev_features features,
960 uint64_t default_bps)
963 F_1000000MB = NETDEV_F_1TB_FD,
964 F_100000MB = NETDEV_F_100GB_FD,
965 F_40000MB = NETDEV_F_40GB_FD,
966 F_10000MB = NETDEV_F_10GB_FD,
967 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
968 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
969 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
972 return ( features & F_1000000MB ? UINT64_C(1000000000000)
973 : features & F_100000MB ? UINT64_C(100000000000)
974 : features & F_40000MB ? UINT64_C(40000000000)
975 : features & F_10000MB ? UINT64_C(10000000000)
976 : features & F_1000MB ? UINT64_C(1000000000)
977 : features & F_100MB ? UINT64_C(100000000)
978 : features & F_10MB ? UINT64_C(10000000)
982 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
983 * are set in 'features', otherwise false. */
985 netdev_features_is_full_duplex(enum netdev_features features)
987 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
988 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
989 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
992 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
993 * successful, otherwise a positive errno value. */
995 netdev_set_advertisements(struct netdev *netdev,
996 enum netdev_features advertise)
998 return (netdev->netdev_class->set_advertisements
999 ? netdev->netdev_class->set_advertisements(
1004 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
1005 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
1006 * errno value and sets '*address' to 0 (INADDR_ANY).
1008 * The following error values have well-defined meanings:
1010 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
1012 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
1014 * 'address' or 'netmask' or both may be null, in which case the address or
1015 * netmask is not reported. */
1017 netdev_get_in4(const struct netdev *netdev,
1018 struct in_addr *address_, struct in_addr *netmask_)
1020 struct in_addr address;
1021 struct in_addr netmask;
1024 error = (netdev->netdev_class->get_in4
1025 ? netdev->netdev_class->get_in4(netdev,
1029 address_->s_addr = error ? 0 : address.s_addr;
1032 netmask_->s_addr = error ? 0 : netmask.s_addr;
1037 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
1038 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
1039 * positive errno value. */
1041 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
1043 return (netdev->netdev_class->set_in4
1044 ? netdev->netdev_class->set_in4(netdev, addr, mask)
1048 /* Obtains ad IPv4 address from device name and save the address in
1049 * in4. Returns 0 if successful, otherwise a positive errno value.
1052 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
1054 struct netdev *netdev;
1057 error = netdev_open(device_name, "system", &netdev);
1059 in4->s_addr = htonl(0);
1063 error = netdev_get_in4(netdev, in4, NULL);
1064 netdev_close(netdev);
1068 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1071 netdev_add_router(struct netdev *netdev, struct in_addr router)
1073 COVERAGE_INC(netdev_add_router);
1074 return (netdev->netdev_class->add_router
1075 ? netdev->netdev_class->add_router(netdev, router)
1079 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1080 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1081 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1082 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1083 * a directly connected network) in '*next_hop' and a copy of the name of the
1084 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1085 * responsible for freeing '*netdev_name' (by calling free()). */
1087 netdev_get_next_hop(const struct netdev *netdev,
1088 const struct in_addr *host, struct in_addr *next_hop,
1091 int error = (netdev->netdev_class->get_next_hop
1092 ? netdev->netdev_class->get_next_hop(
1093 host, next_hop, netdev_name)
1096 next_hop->s_addr = 0;
1097 *netdev_name = NULL;
1102 /* Populates 'smap' with status information.
1104 * Populates 'smap' with 'netdev' specific status information. This
1105 * information may be used to populate the status column of the Interface table
1106 * as defined in ovs-vswitchd.conf.db(5). */
1108 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1110 return (netdev->netdev_class->get_status
1111 ? netdev->netdev_class->get_status(netdev, smap)
1115 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1116 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1117 * all-zero-bits (in6addr_any).
1119 * The following error values have well-defined meanings:
1121 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1123 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1125 * 'in6' may be null, in which case the address itself is not reported. */
1127 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
1129 struct in6_addr dummy;
1132 error = (netdev->netdev_class->get_in6
1133 ? netdev->netdev_class->get_in6(netdev,
1137 memset(in6, 0, sizeof *in6);
1142 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1143 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1145 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1146 enum netdev_flags on, enum netdev_flags *old_flagsp,
1147 struct netdev_saved_flags **sfp)
1148 OVS_EXCLUDED(netdev_mutex)
1150 struct netdev_saved_flags *sf = NULL;
1151 enum netdev_flags old_flags;
1154 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1157 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1158 off || on ? "set" : "get", netdev_get_name(netdev),
1159 ovs_strerror(error));
1161 } else if ((off || on) && sfp) {
1162 enum netdev_flags new_flags = (old_flags & ~off) | on;
1163 enum netdev_flags changed_flags = old_flags ^ new_flags;
1164 if (changed_flags) {
1165 ovs_mutex_lock(&netdev_mutex);
1166 *sfp = sf = xmalloc(sizeof *sf);
1167 sf->netdev = netdev;
1168 list_push_front(&netdev->saved_flags_list, &sf->node);
1169 sf->saved_flags = changed_flags;
1170 sf->saved_values = changed_flags & new_flags;
1173 ovs_mutex_unlock(&netdev_mutex);
1178 *old_flagsp = old_flags;
1187 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1188 * Returns 0 if successful, otherwise a positive errno value. On failure,
1189 * stores 0 into '*flagsp'. */
1191 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1193 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1194 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1197 /* Sets the flags for 'netdev' to 'flags'.
1198 * Returns 0 if successful, otherwise a positive errno value. */
1200 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1201 struct netdev_saved_flags **sfp)
1203 return do_update_flags(netdev, -1, flags, NULL, sfp);
1206 /* Turns on the specified 'flags' on 'netdev':
1208 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1209 * allocated 'struct netdev_saved_flags *' that may be passed to
1210 * netdev_restore_flags() to restore the original values of 'flags' on
1211 * 'netdev' (this will happen automatically at program termination if
1212 * netdev_restore_flags() is never called) , or to NULL if no flags were
1215 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1216 * '*sfp' to NULL. */
1218 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1219 struct netdev_saved_flags **sfp)
1221 return do_update_flags(netdev, 0, flags, NULL, sfp);
1224 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1225 * details of the interface. */
1227 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1228 struct netdev_saved_flags **sfp)
1230 return do_update_flags(netdev, flags, 0, NULL, sfp);
1233 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1234 * Does nothing if 'sf' is NULL. */
1236 netdev_restore_flags(struct netdev_saved_flags *sf)
1237 OVS_EXCLUDED(netdev_mutex)
1240 struct netdev *netdev = sf->netdev;
1241 enum netdev_flags old_flags;
1243 netdev->netdev_class->update_flags(netdev,
1244 sf->saved_flags & sf->saved_values,
1245 sf->saved_flags & ~sf->saved_values,
1248 ovs_mutex_lock(&netdev_mutex);
1249 list_remove(&sf->node);
1251 netdev_unref(netdev);
1255 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1256 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1257 * returns 0. Otherwise, it returns a positive errno value; in particular,
1258 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1260 netdev_arp_lookup(const struct netdev *netdev,
1261 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
1263 int error = (netdev->netdev_class->arp_lookup
1264 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1267 memset(mac, 0, ETH_ADDR_LEN);
1272 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1274 netdev_get_carrier(const struct netdev *netdev)
1277 enum netdev_flags flags;
1280 netdev_get_flags(netdev, &flags);
1281 if (!(flags & NETDEV_UP)) {
1285 if (!netdev->netdev_class->get_carrier) {
1289 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1291 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1292 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1299 /* Returns the number of times 'netdev''s carrier has changed. */
1301 netdev_get_carrier_resets(const struct netdev *netdev)
1303 return (netdev->netdev_class->get_carrier_resets
1304 ? netdev->netdev_class->get_carrier_resets(netdev)
1308 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1309 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1310 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1311 * does not support MII, another method may be used as a fallback. If
1312 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1313 * its normal behavior.
1315 * Returns 0 if successful, otherwise a positive errno value. */
1317 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1319 return (netdev->netdev_class->set_miimon_interval
1320 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1324 /* Retrieves current device stats for 'netdev'. */
1326 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1330 COVERAGE_INC(netdev_get_stats);
1331 error = (netdev->netdev_class->get_stats
1332 ? netdev->netdev_class->get_stats(netdev, stats)
1335 memset(stats, 0xff, sizeof *stats);
1340 /* Attempts to set input rate limiting (policing) policy, such that up to
1341 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1342 * size of 'kbits' kb. */
1344 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1345 uint32_t kbits_burst)
1347 return (netdev->netdev_class->set_policing
1348 ? netdev->netdev_class->set_policing(netdev,
1349 kbits_rate, kbits_burst)
1353 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1354 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1355 * be documented as valid for the "type" column in the "QoS" table in
1356 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1358 * Every network device supports disabling QoS with a type of "", but this type
1359 * will not be added to 'types'.
1361 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1362 * this function. The caller is responsible for destroying 'types' (e.g. with
1363 * sset_destroy()) when it is no longer needed.
1365 * Returns 0 if successful, otherwise a positive errno value. */
1367 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1369 const struct netdev_class *class = netdev->netdev_class;
1370 return (class->get_qos_types
1371 ? class->get_qos_types(netdev, types)
1375 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1376 * which should be "" or one of the types returned by netdev_get_qos_types()
1377 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1378 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1379 * 'caps' to all zeros. */
1381 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1382 struct netdev_qos_capabilities *caps)
1384 const struct netdev_class *class = netdev->netdev_class;
1387 int retval = (class->get_qos_capabilities
1388 ? class->get_qos_capabilities(netdev, type, caps)
1391 memset(caps, 0, sizeof *caps);
1395 /* Every netdev supports turning off QoS. */
1396 memset(caps, 0, sizeof *caps);
1401 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1402 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1403 * the number of queues (zero on failure) in '*n_queuesp'.
1405 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1407 netdev_get_n_queues(const struct netdev *netdev,
1408 const char *type, unsigned int *n_queuesp)
1410 struct netdev_qos_capabilities caps;
1413 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1414 *n_queuesp = caps.n_queues;
1418 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1419 * stores the name of the current form of QoS into '*typep', stores any details
1420 * of configuration as string key-value pairs in 'details', and returns 0. On
1421 * failure, sets '*typep' to NULL and returns a positive errno value.
1423 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1425 * The caller must initialize 'details' as an empty smap (e.g. with
1426 * smap_init()) before calling this function. The caller must free 'details'
1427 * when it is no longer needed (e.g. with smap_destroy()).
1429 * The caller must not modify or free '*typep'.
1431 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1432 * 'netdev'. The contents of 'details' should be documented as valid for
1433 * '*typep' in the "other_config" column in the "QoS" table in
1434 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1436 netdev_get_qos(const struct netdev *netdev,
1437 const char **typep, struct smap *details)
1439 const struct netdev_class *class = netdev->netdev_class;
1442 if (class->get_qos) {
1443 retval = class->get_qos(netdev, typep, details);
1446 smap_clear(details);
1450 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1456 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1457 * with details of configuration from 'details'. Returns 0 if successful,
1458 * otherwise a positive errno value. On error, the previous QoS configuration
1461 * When this function changes the type of QoS (not just 'details'), this also
1462 * resets all queue configuration for 'netdev' to their defaults (which depend
1463 * on the specific type of QoS). Otherwise, the queue configuration for
1464 * 'netdev' is unchanged.
1466 * 'type' should be "" (to disable QoS) or one of the types returned by
1467 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1468 * documented as valid for the given 'type' in the "other_config" column in the
1469 * "QoS" table in vswitchd/vswitch.xml (which is built as
1470 * ovs-vswitchd.conf.db(8)).
1472 * NULL may be specified for 'details' if there are no configuration
1475 netdev_set_qos(struct netdev *netdev,
1476 const char *type, const struct smap *details)
1478 const struct netdev_class *class = netdev->netdev_class;
1484 if (class->set_qos) {
1486 static const struct smap empty = SMAP_INITIALIZER(&empty);
1489 return class->set_qos(netdev, type, details);
1491 return *type ? EOPNOTSUPP : 0;
1495 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1496 * successful, adds that information as string key-value pairs to 'details'.
1497 * Returns 0 if successful, otherwise a positive errno value.
1499 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1500 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1502 * The returned contents of 'details' should be documented as valid for the
1503 * given 'type' in the "other_config" column in the "Queue" table in
1504 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1506 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1507 * this function. The caller must free 'details' when it is no longer needed
1508 * (e.g. with smap_destroy()). */
1510 netdev_get_queue(const struct netdev *netdev,
1511 unsigned int queue_id, struct smap *details)
1513 const struct netdev_class *class = netdev->netdev_class;
1516 retval = (class->get_queue
1517 ? class->get_queue(netdev, queue_id, details)
1520 smap_clear(details);
1525 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1526 * string pairs in 'details'. The contents of 'details' should be documented
1527 * as valid for the given 'type' in the "other_config" column in the "Queue"
1528 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1529 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1530 * given queue's configuration should be unmodified.
1532 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1533 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1535 * This function does not modify 'details', and the caller retains ownership of
1538 netdev_set_queue(struct netdev *netdev,
1539 unsigned int queue_id, const struct smap *details)
1541 const struct netdev_class *class = netdev->netdev_class;
1542 return (class->set_queue
1543 ? class->set_queue(netdev, queue_id, details)
1547 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1548 * of QoS may have a fixed set of queues, in which case attempts to delete them
1549 * will fail with EOPNOTSUPP.
1551 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1552 * given queue will be unmodified.
1554 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1555 * the current form of QoS (e.g. as returned by
1556 * netdev_get_n_queues(netdev)). */
1558 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1560 const struct netdev_class *class = netdev->netdev_class;
1561 return (class->delete_queue
1562 ? class->delete_queue(netdev, queue_id)
1566 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1567 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1568 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1569 * positive errno value and fills 'stats' with values indicating unsupported
1572 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1573 struct netdev_queue_stats *stats)
1575 const struct netdev_class *class = netdev->netdev_class;
1578 retval = (class->get_queue_stats
1579 ? class->get_queue_stats(netdev, queue_id, stats)
1582 stats->tx_bytes = UINT64_MAX;
1583 stats->tx_packets = UINT64_MAX;
1584 stats->tx_errors = UINT64_MAX;
1585 stats->created = LLONG_MIN;
1590 /* Initializes 'dump' to begin dumping the queues in a netdev.
1592 * This function provides no status indication. An error status for the entire
1593 * dump operation is provided when it is completed by calling
1594 * netdev_queue_dump_done().
1597 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1598 const struct netdev *netdev)
1600 dump->netdev = netdev_ref(netdev);
1601 if (netdev->netdev_class->queue_dump_start) {
1602 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1605 dump->error = EOPNOTSUPP;
1609 /* Attempts to retrieve another queue from 'dump', which must have been
1610 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1611 * ID into '*queue_id', fills 'details' with configuration details for the
1612 * queue, and returns true. On failure, returns false.
1614 * Queues are not necessarily dumped in increasing order of queue ID (or any
1615 * other predictable order).
1617 * Failure might indicate an actual error or merely that the last queue has
1618 * been dumped. An error status for the entire dump operation is provided when
1619 * it is completed by calling netdev_queue_dump_done().
1621 * The returned contents of 'details' should be documented as valid for the
1622 * given 'type' in the "other_config" column in the "Queue" table in
1623 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1625 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1626 * this function. This function will clear and replace its contents. The
1627 * caller must free 'details' when it is no longer needed (e.g. with
1628 * smap_destroy()). */
1630 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1631 unsigned int *queue_id, struct smap *details)
1633 const struct netdev *netdev = dump->netdev;
1639 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1643 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1649 /* Completes queue table dump operation 'dump', which must have been
1650 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1651 * was error-free, otherwise a positive errno value describing the problem. */
1653 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1655 const struct netdev *netdev = dump->netdev;
1656 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1657 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1660 netdev_close(dump->netdev);
1661 return dump->error == EOF ? 0 : dump->error;
1664 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1665 * its statistics, and the 'aux' specified by the caller. The order of
1666 * iteration is unspecified, but (when successful) each queue is visited
1669 * Calling this function may be more efficient than calling
1670 * netdev_get_queue_stats() for every queue.
1672 * 'cb' must not modify or free the statistics passed in.
1674 * Returns 0 if successful, otherwise a positive errno value. On error, some
1675 * configured queues may not have been included in the iteration. */
1677 netdev_dump_queue_stats(const struct netdev *netdev,
1678 netdev_dump_queue_stats_cb *cb, void *aux)
1680 const struct netdev_class *class = netdev->netdev_class;
1681 return (class->dump_queue_stats
1682 ? class->dump_queue_stats(netdev, cb, aux)
1687 /* Returns the class type of 'netdev'.
1689 * The caller must not free the returned value. */
1691 netdev_get_type(const struct netdev *netdev)
1693 return netdev->netdev_class->type;
1696 /* Returns the class associated with 'netdev'. */
1697 const struct netdev_class *
1698 netdev_get_class(const struct netdev *netdev)
1700 return netdev->netdev_class;
1703 /* Returns the netdev with 'name' or NULL if there is none.
1705 * The caller must free the returned netdev with netdev_close(). */
1707 netdev_from_name(const char *name)
1708 OVS_EXCLUDED(netdev_mutex)
1710 struct netdev *netdev;
1712 ovs_mutex_lock(&netdev_mutex);
1713 netdev = shash_find_data(&netdev_shash, name);
1717 ovs_mutex_unlock(&netdev_mutex);
1722 /* Fills 'device_list' with devices that match 'netdev_class'.
1724 * The caller is responsible for initializing and destroying 'device_list' and
1725 * must close each device on the list. */
1727 netdev_get_devices(const struct netdev_class *netdev_class,
1728 struct shash *device_list)
1729 OVS_EXCLUDED(netdev_mutex)
1731 struct shash_node *node;
1733 ovs_mutex_lock(&netdev_mutex);
1734 SHASH_FOR_EACH (node, &netdev_shash) {
1735 struct netdev *dev = node->data;
1737 if (dev->netdev_class == netdev_class) {
1739 shash_add(device_list, node->name, node->data);
1742 ovs_mutex_unlock(&netdev_mutex);
1745 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1746 * and returns it. Stores the size of the array into '*size'.
1748 * The caller is responsible for freeing 'vports' and must close
1749 * each 'netdev-vport' in the list. */
1751 netdev_get_vports(size_t *size)
1752 OVS_EXCLUDED(netdev_mutex)
1754 struct netdev **vports;
1755 struct shash_node *node;
1762 /* Explicitly allocates big enough chunk of memory. */
1763 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1764 ovs_mutex_lock(&netdev_mutex);
1765 SHASH_FOR_EACH (node, &netdev_shash) {
1766 struct netdev *dev = node->data;
1768 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1774 ovs_mutex_unlock(&netdev_mutex);
1781 netdev_get_type_from_name(const char *name)
1783 struct netdev *dev = netdev_from_name(name);
1784 const char *type = dev ? netdev_get_type(dev) : NULL;
1790 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1792 ovs_assert(rx->netdev->ref_cnt > 0);
1797 netdev_rxq_get_name(const struct netdev_rxq *rx)
1799 return netdev_get_name(netdev_rxq_get_netdev(rx));
1803 restore_all_flags(void *aux OVS_UNUSED)
1805 struct shash_node *node;
1807 SHASH_FOR_EACH (node, &netdev_shash) {
1808 struct netdev *netdev = node->data;
1809 const struct netdev_saved_flags *sf;
1810 enum netdev_flags saved_values;
1811 enum netdev_flags saved_flags;
1813 saved_values = saved_flags = 0;
1814 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1815 saved_flags |= sf->saved_flags;
1816 saved_values &= ~sf->saved_flags;
1817 saved_values |= sf->saved_flags & sf->saved_values;
1820 enum netdev_flags old_flags;
1822 netdev->netdev_class->update_flags(netdev,
1823 saved_flags & saved_values,
1824 saved_flags & ~saved_values,
1831 netdev_get_change_seq(const struct netdev *netdev)
1833 return netdev->change_seq;