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;
260 ovs_mutex_lock(&netdev_class_mutex);
261 rc = netdev_lookup_class(type);
263 VLOG_WARN("attempted to unregister a netdev provider that is not "
264 "registered: %s", type);
265 error = EAFNOSUPPORT;
268 hmap_remove(&netdev_classes, &rc->hmap_node);
272 VLOG_WARN("attempted to unregister in use netdev provider: %s",
277 ovs_mutex_unlock(&netdev_class_mutex);
282 /* Clears 'types' and enumerates the types of all currently registered netdev
283 * providers into it. The caller must first initialize the sset. */
285 netdev_enumerate_types(struct sset *types)
286 OVS_EXCLUDED(netdev_mutex)
288 struct netdev_registered_class *rc;
293 ovs_mutex_lock(&netdev_class_mutex);
294 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
295 sset_add(types, rc->class->type);
297 ovs_mutex_unlock(&netdev_class_mutex);
300 /* Check that the network device name is not the same as any of the registered
301 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
302 * does not define it) or the datapath internal port name (e.g. ovs-system).
304 * Returns true if there is a name conflict, false otherwise. */
306 netdev_is_reserved_name(const char *name)
307 OVS_EXCLUDED(netdev_mutex)
309 struct netdev_registered_class *rc;
313 ovs_mutex_lock(&netdev_class_mutex);
314 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
315 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
316 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
317 ovs_mutex_unlock(&netdev_class_mutex);
321 ovs_mutex_unlock(&netdev_class_mutex);
323 if (!strncmp(name, "ovs-", 4)) {
328 dp_enumerate_types(&types);
329 SSET_FOR_EACH (type, &types) {
330 if (!strcmp(name+4, type)) {
331 sset_destroy(&types);
335 sset_destroy(&types);
341 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
342 * (e.g. "system") and returns zero if successful, otherwise a positive errno
343 * value. On success, sets '*netdevp' to the new network device, otherwise to
346 * Some network devices may need to be configured (with netdev_set_config())
347 * before they can be used. */
349 netdev_open(const char *name, const char *type, struct netdev **netdevp)
350 OVS_EXCLUDED(netdev_mutex)
352 struct netdev *netdev;
357 ovs_mutex_lock(&netdev_class_mutex);
358 ovs_mutex_lock(&netdev_mutex);
359 netdev = shash_find_data(&netdev_shash, name);
361 struct netdev_registered_class *rc;
363 rc = netdev_lookup_class(type && type[0] ? type : "system");
365 netdev = rc->class->alloc();
367 memset(netdev, 0, sizeof *netdev);
368 netdev->netdev_class = rc->class;
369 netdev->name = xstrdup(name);
370 netdev->change_seq = 1;
371 netdev->node = shash_add(&netdev_shash, name, netdev);
373 /* By default enable one tx and rx queue per netdev. */
374 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
375 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
377 list_init(&netdev->saved_flags_list);
379 error = rc->class->construct(netdev);
382 netdev_change_seq_changed(netdev);
385 ovs_assert(list_is_empty(&netdev->saved_flags_list));
386 shash_delete(&netdev_shash, netdev->node);
387 rc->class->dealloc(netdev);
393 VLOG_WARN("could not create netdev %s of unknown type %s",
395 error = EAFNOSUPPORT;
407 ovs_mutex_unlock(&netdev_mutex);
408 ovs_mutex_unlock(&netdev_class_mutex);
413 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
414 * 'netdev_' is null. */
416 netdev_ref(const struct netdev *netdev_)
417 OVS_EXCLUDED(netdev_mutex)
419 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
422 ovs_mutex_lock(&netdev_mutex);
423 ovs_assert(netdev->ref_cnt > 0);
425 ovs_mutex_unlock(&netdev_mutex);
430 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
431 * or NULL if none are needed. */
433 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
434 OVS_EXCLUDED(netdev_mutex)
436 if (netdev->netdev_class->set_config) {
437 const struct smap no_args = SMAP_INITIALIZER(&no_args);
440 error = netdev->netdev_class->set_config(netdev,
441 args ? args : &no_args);
443 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
444 netdev_get_name(netdev), ovs_strerror(error));
447 } else if (args && !smap_is_empty(args)) {
448 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
449 netdev_get_name(netdev));
454 /* Returns the current configuration for 'netdev' in 'args'. The caller must
455 * have already initialized 'args' with smap_init(). Returns 0 on success, in
456 * which case 'args' will be filled with 'netdev''s configuration. On failure
457 * returns a positive errno value, in which case 'args' will be empty.
459 * The caller owns 'args' and its contents and must eventually free them with
462 netdev_get_config(const struct netdev *netdev, struct smap *args)
463 OVS_EXCLUDED(netdev_mutex)
468 if (netdev->netdev_class->get_config) {
469 error = netdev->netdev_class->get_config(netdev, args);
480 const struct netdev_tunnel_config *
481 netdev_get_tunnel_config(const struct netdev *netdev)
482 OVS_EXCLUDED(netdev_mutex)
484 if (netdev->netdev_class->get_tunnel_config) {
485 return netdev->netdev_class->get_tunnel_config(netdev);
491 /* Returns the id of the numa node the 'netdev' is on. If the function
492 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
494 netdev_get_numa_id(const struct netdev *netdev)
496 if (netdev->netdev_class->get_numa_id) {
497 return netdev->netdev_class->get_numa_id(netdev);
499 return NETDEV_NUMA_UNSPEC;
504 netdev_unref(struct netdev *dev)
505 OVS_RELEASES(netdev_mutex)
507 ovs_assert(dev->ref_cnt);
508 if (!--dev->ref_cnt) {
509 const struct netdev_class *class = dev->netdev_class;
510 struct netdev_registered_class *rc;
512 dev->netdev_class->destruct(dev);
515 shash_delete(&netdev_shash, dev->node);
518 dev->netdev_class->dealloc(dev);
519 ovs_mutex_unlock(&netdev_mutex);
521 ovs_mutex_lock(&netdev_class_mutex);
522 rc = netdev_lookup_class(class->type);
523 ovs_assert(rc->ref_cnt > 0);
525 ovs_mutex_unlock(&netdev_class_mutex);
527 ovs_mutex_unlock(&netdev_mutex);
531 /* Closes and destroys 'netdev'. */
533 netdev_close(struct netdev *netdev)
534 OVS_EXCLUDED(netdev_mutex)
537 ovs_mutex_lock(&netdev_mutex);
538 netdev_unref(netdev);
542 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
544 * This allows handler and revalidator threads to still retain references
545 * to this netdev while the main thread changes interface configuration.
547 * This function should only be called by the main thread when closing
548 * netdevs during user configuration changes. Otherwise, netdev_close should be
549 * used to close netdevs. */
551 netdev_remove(struct netdev *netdev)
554 ovs_mutex_lock(&netdev_mutex);
556 shash_delete(&netdev_shash, netdev->node);
558 netdev_change_seq_changed(netdev);
560 netdev_unref(netdev);
564 /* Parses 'netdev_name_', which is of the form [type@]name into its component
565 * pieces. 'name' and 'type' must be freed by the caller. */
567 netdev_parse_name(const char *netdev_name_, char **name, char **type)
569 char *netdev_name = xstrdup(netdev_name_);
572 separator = strchr(netdev_name, '@');
576 *name = xstrdup(separator + 1);
579 *type = xstrdup("system");
583 /* Attempts to open a netdev_rxq handle for obtaining packets received on
584 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
585 * '*rxp'. On failure, returns a positive errno value and stores NULL into
588 * Some kinds of network devices might not support receiving packets. This
589 * function returns EOPNOTSUPP in that case.*/
591 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
592 OVS_EXCLUDED(netdev_mutex)
596 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
597 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
601 error = netdev->netdev_class->rxq_construct(rx);
607 netdev->netdev_class->rxq_dealloc(rx);
621 netdev_rxq_close(struct netdev_rxq *rx)
622 OVS_EXCLUDED(netdev_mutex)
625 struct netdev *netdev = rx->netdev;
626 netdev->netdev_class->rxq_destruct(rx);
627 netdev->netdev_class->rxq_dealloc(rx);
628 netdev_close(netdev);
632 /* Attempts to receive batch of packets from 'rx'.
634 * Returns EAGAIN immediately if no packet is ready to be received.
636 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
637 * than 'dp_packet_tailroom(buffer)'.
639 * It is advised that the tailroom of 'buffer' should be
640 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
641 * out-of-band VLAN header to be added to the packet. At the very least,
642 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
644 * This function may be set to null if it would always return EOPNOTSUPP
647 netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet **buffers, int *cnt)
651 retval = rx->netdev->netdev_class->rxq_recv(rx, buffers, cnt);
653 COVERAGE_INC(netdev_received);
658 /* Arranges for poll_block() to wake up when a packet is ready to be received
661 netdev_rxq_wait(struct netdev_rxq *rx)
663 rx->netdev->netdev_class->rxq_wait(rx);
666 /* Discards any packets ready to be received on 'rx'. */
668 netdev_rxq_drain(struct netdev_rxq *rx)
670 return (rx->netdev->netdev_class->rxq_drain
671 ? rx->netdev->netdev_class->rxq_drain(rx)
675 /* Configures the number of tx queues and rx queues of 'netdev'.
676 * Return 0 if successful, otherwise a positive errno value.
678 * 'n_rxq' specifies the maximum number of receive queues to create.
679 * The netdev provider might choose to create less (e.g. if the hardware
680 * supports only a smaller number). The caller can check how many have been
681 * actually created by calling 'netdev_n_rxq()'
683 * 'n_txq' specifies the exact number of transmission queues to create.
684 * If this function returns successfully, the caller can make 'n_txq'
685 * concurrent calls to netdev_send() (each one with a different 'qid' in the
686 * range [0..'n_txq'-1]).
688 * On error, the tx queue and rx queue configuration is indeterminant.
689 * Caller should make decision on whether to restore the previous or
690 * the default configuration. Also, caller must make sure there is no
691 * other thread accessing the queues at the same time. */
693 netdev_set_multiq(struct netdev *netdev, unsigned int n_txq,
698 error = (netdev->netdev_class->set_multiq
699 ? netdev->netdev_class->set_multiq(netdev,
704 if (error && error != EOPNOTSUPP) {
705 VLOG_DBG_RL(&rl, "failed to set tx/rx queue for network device %s:"
706 "%s", netdev_get_name(netdev), ovs_strerror(error));
712 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
713 * otherwise a positive errno value. Returns EAGAIN without blocking if
714 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
715 * if a partial packet was transmitted or if a packet is too big or too small
716 * to transmit on the device.
718 * If the function returns a non-zero value, some of the packets might have
721 * To retain ownership of 'buffer' caller can set may_steal to false.
723 * The network device is expected to maintain one or more packet
724 * transmission queues, so that the caller does not ordinarily have to
725 * do additional queuing of packets. 'qid' specifies the queue to use
726 * and can be ignored if the implementation does not support multiple
729 * Some network devices may not implement support for this function. In such
730 * cases this function will always return EOPNOTSUPP. */
732 netdev_send(struct netdev *netdev, int qid, struct dp_packet **buffers,
733 int cnt, bool may_steal)
737 error = (netdev->netdev_class->send
738 ? netdev->netdev_class->send(netdev, qid, buffers, cnt, may_steal)
741 COVERAGE_INC(netdev_sent);
747 netdev_pop_header(struct netdev *netdev, struct dp_packet **buffers, int cnt)
751 if (!netdev->netdev_class->pop_header) {
755 for (i = 0; i < cnt; i++) {
758 err = netdev->netdev_class->pop_header(buffers[i]);
760 dp_packet_clear(buffers[i]);
768 netdev_build_header(const struct netdev *netdev, struct ovs_action_push_tnl *data,
769 const struct flow *tnl_flow)
771 if (netdev->netdev_class->build_header) {
772 return netdev->netdev_class->build_header(netdev, data, tnl_flow);
778 netdev_push_header(const struct netdev *netdev,
779 struct dp_packet **buffers, int cnt,
780 const struct ovs_action_push_tnl *data)
784 if (!netdev->netdev_class->push_header) {
788 for (i = 0; i < cnt; i++) {
789 netdev->netdev_class->push_header(buffers[i], data);
790 buffers[i]->md = PKT_METADATA_INITIALIZER(u32_to_odp(data->out_port));
796 /* Registers with the poll loop to wake up from the next call to poll_block()
797 * when the packet transmission queue has sufficient room to transmit a packet
798 * with netdev_send().
800 * The network device is expected to maintain one or more packet
801 * transmission queues, so that the caller does not ordinarily have to
802 * do additional queuing of packets. 'qid' specifies the queue to use
803 * and can be ignored if the implementation does not support multiple
806 netdev_send_wait(struct netdev *netdev, int qid)
808 if (netdev->netdev_class->send_wait) {
809 netdev->netdev_class->send_wait(netdev, qid);
813 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
814 * otherwise a positive errno value. */
816 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
818 return netdev->netdev_class->set_etheraddr(netdev, mac);
821 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
822 * the MAC address into 'mac'. On failure, returns a positive errno value and
823 * clears 'mac' to all-zeros. */
825 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
827 return netdev->netdev_class->get_etheraddr(netdev, mac);
830 /* Returns the name of the network device that 'netdev' represents,
831 * e.g. "eth0". The caller must not modify or free the returned string. */
833 netdev_get_name(const struct netdev *netdev)
838 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
839 * (and received) packets, in bytes, not including the hardware header; thus,
840 * this is typically 1500 bytes for Ethernet devices.
842 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
843 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
844 * On other failure, returns a positive errno value. On failure, sets '*mtup'
847 netdev_get_mtu(const struct netdev *netdev, int *mtup)
849 const struct netdev_class *class = netdev->netdev_class;
852 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
855 if (error != EOPNOTSUPP) {
856 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
857 "%s", netdev_get_name(netdev), ovs_strerror(error));
863 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
864 * (and received) packets, in bytes.
866 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
867 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
870 netdev_set_mtu(const struct netdev *netdev, int mtu)
872 const struct netdev_class *class = netdev->netdev_class;
875 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
876 if (error && error != EOPNOTSUPP) {
877 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
878 netdev_get_name(netdev), ovs_strerror(error));
884 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
885 * failure, returns a negative errno value.
887 * The desired semantics of the ifindex value are a combination of those
888 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
889 * value should be unique within a host and remain stable at least until
890 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
891 * but many systems do not follow this rule anyhow.
893 * Some network devices may not implement support for this function. In such
894 * cases this function will always return -EOPNOTSUPP.
897 netdev_get_ifindex(const struct netdev *netdev)
899 int (*get_ifindex)(const struct netdev *);
901 get_ifindex = netdev->netdev_class->get_ifindex;
903 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
906 /* Stores the features supported by 'netdev' into each of '*current',
907 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
908 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
909 * successful, otherwise a positive errno value. On failure, all of the
910 * passed-in values are set to 0.
912 * Some network devices may not implement support for this function. In such
913 * cases this function will always return EOPNOTSUPP. */
915 netdev_get_features(const struct netdev *netdev,
916 enum netdev_features *current,
917 enum netdev_features *advertised,
918 enum netdev_features *supported,
919 enum netdev_features *peer)
921 int (*get_features)(const struct netdev *netdev,
922 enum netdev_features *current,
923 enum netdev_features *advertised,
924 enum netdev_features *supported,
925 enum netdev_features *peer);
926 enum netdev_features dummy[4];
933 advertised = &dummy[1];
936 supported = &dummy[2];
942 get_features = netdev->netdev_class->get_features;
944 ? get_features(netdev, current, advertised, supported,
948 *current = *advertised = *supported = *peer = 0;
953 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
954 * bits in 'features', in bits per second. If no bits that indicate a speed
955 * are set in 'features', returns 'default_bps'. */
957 netdev_features_to_bps(enum netdev_features features,
958 uint64_t default_bps)
961 F_1000000MB = NETDEV_F_1TB_FD,
962 F_100000MB = NETDEV_F_100GB_FD,
963 F_40000MB = NETDEV_F_40GB_FD,
964 F_10000MB = NETDEV_F_10GB_FD,
965 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
966 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
967 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
970 return ( features & F_1000000MB ? UINT64_C(1000000000000)
971 : features & F_100000MB ? UINT64_C(100000000000)
972 : features & F_40000MB ? UINT64_C(40000000000)
973 : features & F_10000MB ? UINT64_C(10000000000)
974 : features & F_1000MB ? UINT64_C(1000000000)
975 : features & F_100MB ? UINT64_C(100000000)
976 : features & F_10MB ? UINT64_C(10000000)
980 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
981 * are set in 'features', otherwise false. */
983 netdev_features_is_full_duplex(enum netdev_features features)
985 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
986 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
987 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
990 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
991 * successful, otherwise a positive errno value. */
993 netdev_set_advertisements(struct netdev *netdev,
994 enum netdev_features advertise)
996 return (netdev->netdev_class->set_advertisements
997 ? netdev->netdev_class->set_advertisements(
1002 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
1003 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
1004 * errno value and sets '*address' to 0 (INADDR_ANY).
1006 * The following error values have well-defined meanings:
1008 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
1010 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
1012 * 'address' or 'netmask' or both may be null, in which case the address or
1013 * netmask is not reported. */
1015 netdev_get_in4(const struct netdev *netdev,
1016 struct in_addr *address_, struct in_addr *netmask_)
1018 struct in_addr address;
1019 struct in_addr netmask;
1022 error = (netdev->netdev_class->get_in4
1023 ? netdev->netdev_class->get_in4(netdev,
1027 address_->s_addr = error ? 0 : address.s_addr;
1030 netmask_->s_addr = error ? 0 : netmask.s_addr;
1035 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
1036 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
1037 * positive errno value. */
1039 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
1041 return (netdev->netdev_class->set_in4
1042 ? netdev->netdev_class->set_in4(netdev, addr, mask)
1046 /* Obtains ad IPv4 address from device name and save the address in
1047 * in4. Returns 0 if successful, otherwise a positive errno value.
1050 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
1052 struct netdev *netdev;
1055 error = netdev_open(device_name, "system", &netdev);
1057 in4->s_addr = htonl(0);
1061 error = netdev_get_in4(netdev, in4, NULL);
1062 netdev_close(netdev);
1066 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1069 netdev_add_router(struct netdev *netdev, struct in_addr router)
1071 COVERAGE_INC(netdev_add_router);
1072 return (netdev->netdev_class->add_router
1073 ? netdev->netdev_class->add_router(netdev, router)
1077 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1078 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1079 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1080 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1081 * a directly connected network) in '*next_hop' and a copy of the name of the
1082 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1083 * responsible for freeing '*netdev_name' (by calling free()). */
1085 netdev_get_next_hop(const struct netdev *netdev,
1086 const struct in_addr *host, struct in_addr *next_hop,
1089 int error = (netdev->netdev_class->get_next_hop
1090 ? netdev->netdev_class->get_next_hop(
1091 host, next_hop, netdev_name)
1094 next_hop->s_addr = 0;
1095 *netdev_name = NULL;
1100 /* Populates 'smap' with status information.
1102 * Populates 'smap' with 'netdev' specific status information. This
1103 * information may be used to populate the status column of the Interface table
1104 * as defined in ovs-vswitchd.conf.db(5). */
1106 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1108 return (netdev->netdev_class->get_status
1109 ? netdev->netdev_class->get_status(netdev, smap)
1113 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1114 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1115 * all-zero-bits (in6addr_any).
1117 * The following error values have well-defined meanings:
1119 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1121 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1123 * 'in6' may be null, in which case the address itself is not reported. */
1125 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
1127 struct in6_addr dummy;
1130 error = (netdev->netdev_class->get_in6
1131 ? netdev->netdev_class->get_in6(netdev,
1135 memset(in6, 0, sizeof *in6);
1140 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1141 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1143 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1144 enum netdev_flags on, enum netdev_flags *old_flagsp,
1145 struct netdev_saved_flags **sfp)
1146 OVS_EXCLUDED(netdev_mutex)
1148 struct netdev_saved_flags *sf = NULL;
1149 enum netdev_flags old_flags;
1152 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1155 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1156 off || on ? "set" : "get", netdev_get_name(netdev),
1157 ovs_strerror(error));
1159 } else if ((off || on) && sfp) {
1160 enum netdev_flags new_flags = (old_flags & ~off) | on;
1161 enum netdev_flags changed_flags = old_flags ^ new_flags;
1162 if (changed_flags) {
1163 ovs_mutex_lock(&netdev_mutex);
1164 *sfp = sf = xmalloc(sizeof *sf);
1165 sf->netdev = netdev;
1166 list_push_front(&netdev->saved_flags_list, &sf->node);
1167 sf->saved_flags = changed_flags;
1168 sf->saved_values = changed_flags & new_flags;
1171 ovs_mutex_unlock(&netdev_mutex);
1176 *old_flagsp = old_flags;
1185 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1186 * Returns 0 if successful, otherwise a positive errno value. On failure,
1187 * stores 0 into '*flagsp'. */
1189 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1191 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1192 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1195 /* Sets the flags for 'netdev' to 'flags'.
1196 * Returns 0 if successful, otherwise a positive errno value. */
1198 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1199 struct netdev_saved_flags **sfp)
1201 return do_update_flags(netdev, -1, flags, NULL, sfp);
1204 /* Turns on the specified 'flags' on 'netdev':
1206 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1207 * allocated 'struct netdev_saved_flags *' that may be passed to
1208 * netdev_restore_flags() to restore the original values of 'flags' on
1209 * 'netdev' (this will happen automatically at program termination if
1210 * netdev_restore_flags() is never called) , or to NULL if no flags were
1213 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1214 * '*sfp' to NULL. */
1216 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1217 struct netdev_saved_flags **sfp)
1219 return do_update_flags(netdev, 0, flags, NULL, sfp);
1222 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1223 * details of the interface. */
1225 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1226 struct netdev_saved_flags **sfp)
1228 return do_update_flags(netdev, flags, 0, NULL, sfp);
1231 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1232 * Does nothing if 'sf' is NULL. */
1234 netdev_restore_flags(struct netdev_saved_flags *sf)
1235 OVS_EXCLUDED(netdev_mutex)
1238 struct netdev *netdev = sf->netdev;
1239 enum netdev_flags old_flags;
1241 netdev->netdev_class->update_flags(netdev,
1242 sf->saved_flags & sf->saved_values,
1243 sf->saved_flags & ~sf->saved_values,
1246 ovs_mutex_lock(&netdev_mutex);
1247 list_remove(&sf->node);
1249 netdev_unref(netdev);
1253 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1254 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1255 * returns 0. Otherwise, it returns a positive errno value; in particular,
1256 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1258 netdev_arp_lookup(const struct netdev *netdev,
1259 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
1261 int error = (netdev->netdev_class->arp_lookup
1262 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1265 memset(mac, 0, ETH_ADDR_LEN);
1270 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1272 netdev_get_carrier(const struct netdev *netdev)
1275 enum netdev_flags flags;
1278 netdev_get_flags(netdev, &flags);
1279 if (!(flags & NETDEV_UP)) {
1283 if (!netdev->netdev_class->get_carrier) {
1287 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1289 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1290 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1297 /* Returns the number of times 'netdev''s carrier has changed. */
1299 netdev_get_carrier_resets(const struct netdev *netdev)
1301 return (netdev->netdev_class->get_carrier_resets
1302 ? netdev->netdev_class->get_carrier_resets(netdev)
1306 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1307 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1308 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1309 * does not support MII, another method may be used as a fallback. If
1310 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1311 * its normal behavior.
1313 * Returns 0 if successful, otherwise a positive errno value. */
1315 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1317 return (netdev->netdev_class->set_miimon_interval
1318 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1322 /* Retrieves current device stats for 'netdev'. */
1324 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1328 COVERAGE_INC(netdev_get_stats);
1329 error = (netdev->netdev_class->get_stats
1330 ? netdev->netdev_class->get_stats(netdev, stats)
1333 memset(stats, 0xff, sizeof *stats);
1338 /* Attempts to set input rate limiting (policing) policy, such that up to
1339 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1340 * size of 'kbits' kb. */
1342 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1343 uint32_t kbits_burst)
1345 return (netdev->netdev_class->set_policing
1346 ? netdev->netdev_class->set_policing(netdev,
1347 kbits_rate, kbits_burst)
1351 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1352 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1353 * be documented as valid for the "type" column in the "QoS" table in
1354 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1356 * Every network device supports disabling QoS with a type of "", but this type
1357 * will not be added to 'types'.
1359 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1360 * this function. The caller is responsible for destroying 'types' (e.g. with
1361 * sset_destroy()) when it is no longer needed.
1363 * Returns 0 if successful, otherwise a positive errno value. */
1365 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1367 const struct netdev_class *class = netdev->netdev_class;
1368 return (class->get_qos_types
1369 ? class->get_qos_types(netdev, types)
1373 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1374 * which should be "" or one of the types returned by netdev_get_qos_types()
1375 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1376 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1377 * 'caps' to all zeros. */
1379 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1380 struct netdev_qos_capabilities *caps)
1382 const struct netdev_class *class = netdev->netdev_class;
1385 int retval = (class->get_qos_capabilities
1386 ? class->get_qos_capabilities(netdev, type, caps)
1389 memset(caps, 0, sizeof *caps);
1393 /* Every netdev supports turning off QoS. */
1394 memset(caps, 0, sizeof *caps);
1399 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1400 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1401 * the number of queues (zero on failure) in '*n_queuesp'.
1403 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1405 netdev_get_n_queues(const struct netdev *netdev,
1406 const char *type, unsigned int *n_queuesp)
1408 struct netdev_qos_capabilities caps;
1411 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1412 *n_queuesp = caps.n_queues;
1416 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1417 * stores the name of the current form of QoS into '*typep', stores any details
1418 * of configuration as string key-value pairs in 'details', and returns 0. On
1419 * failure, sets '*typep' to NULL and returns a positive errno value.
1421 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1423 * The caller must initialize 'details' as an empty smap (e.g. with
1424 * smap_init()) before calling this function. The caller must free 'details'
1425 * when it is no longer needed (e.g. with smap_destroy()).
1427 * The caller must not modify or free '*typep'.
1429 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1430 * 'netdev'. The contents of 'details' should be documented as valid for
1431 * '*typep' in the "other_config" column in the "QoS" table in
1432 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1434 netdev_get_qos(const struct netdev *netdev,
1435 const char **typep, struct smap *details)
1437 const struct netdev_class *class = netdev->netdev_class;
1440 if (class->get_qos) {
1441 retval = class->get_qos(netdev, typep, details);
1444 smap_clear(details);
1448 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1454 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1455 * with details of configuration from 'details'. Returns 0 if successful,
1456 * otherwise a positive errno value. On error, the previous QoS configuration
1459 * When this function changes the type of QoS (not just 'details'), this also
1460 * resets all queue configuration for 'netdev' to their defaults (which depend
1461 * on the specific type of QoS). Otherwise, the queue configuration for
1462 * 'netdev' is unchanged.
1464 * 'type' should be "" (to disable QoS) or one of the types returned by
1465 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1466 * documented as valid for the given 'type' in the "other_config" column in the
1467 * "QoS" table in vswitchd/vswitch.xml (which is built as
1468 * ovs-vswitchd.conf.db(8)).
1470 * NULL may be specified for 'details' if there are no configuration
1473 netdev_set_qos(struct netdev *netdev,
1474 const char *type, const struct smap *details)
1476 const struct netdev_class *class = netdev->netdev_class;
1482 if (class->set_qos) {
1484 static const struct smap empty = SMAP_INITIALIZER(&empty);
1487 return class->set_qos(netdev, type, details);
1489 return *type ? EOPNOTSUPP : 0;
1493 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1494 * successful, adds that information as string key-value pairs to 'details'.
1495 * Returns 0 if successful, otherwise a positive errno value.
1497 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1498 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1500 * The returned contents of 'details' should be documented as valid for the
1501 * given 'type' in the "other_config" column in the "Queue" table in
1502 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1504 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1505 * this function. The caller must free 'details' when it is no longer needed
1506 * (e.g. with smap_destroy()). */
1508 netdev_get_queue(const struct netdev *netdev,
1509 unsigned int queue_id, struct smap *details)
1511 const struct netdev_class *class = netdev->netdev_class;
1514 retval = (class->get_queue
1515 ? class->get_queue(netdev, queue_id, details)
1518 smap_clear(details);
1523 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1524 * string pairs in 'details'. The contents of 'details' should be documented
1525 * as valid for the given 'type' in the "other_config" column in the "Queue"
1526 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1527 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1528 * given queue's configuration should be unmodified.
1530 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1531 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1533 * This function does not modify 'details', and the caller retains ownership of
1536 netdev_set_queue(struct netdev *netdev,
1537 unsigned int queue_id, const struct smap *details)
1539 const struct netdev_class *class = netdev->netdev_class;
1540 return (class->set_queue
1541 ? class->set_queue(netdev, queue_id, details)
1545 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1546 * of QoS may have a fixed set of queues, in which case attempts to delete them
1547 * will fail with EOPNOTSUPP.
1549 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1550 * given queue will be unmodified.
1552 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1553 * the current form of QoS (e.g. as returned by
1554 * netdev_get_n_queues(netdev)). */
1556 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1558 const struct netdev_class *class = netdev->netdev_class;
1559 return (class->delete_queue
1560 ? class->delete_queue(netdev, queue_id)
1564 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1565 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1566 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1567 * positive errno value and fills 'stats' with values indicating unsupported
1570 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1571 struct netdev_queue_stats *stats)
1573 const struct netdev_class *class = netdev->netdev_class;
1576 retval = (class->get_queue_stats
1577 ? class->get_queue_stats(netdev, queue_id, stats)
1580 stats->tx_bytes = UINT64_MAX;
1581 stats->tx_packets = UINT64_MAX;
1582 stats->tx_errors = UINT64_MAX;
1583 stats->created = LLONG_MIN;
1588 /* Initializes 'dump' to begin dumping the queues in a netdev.
1590 * This function provides no status indication. An error status for the entire
1591 * dump operation is provided when it is completed by calling
1592 * netdev_queue_dump_done().
1595 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1596 const struct netdev *netdev)
1598 dump->netdev = netdev_ref(netdev);
1599 if (netdev->netdev_class->queue_dump_start) {
1600 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1603 dump->error = EOPNOTSUPP;
1607 /* Attempts to retrieve another queue from 'dump', which must have been
1608 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1609 * ID into '*queue_id', fills 'details' with configuration details for the
1610 * queue, and returns true. On failure, returns false.
1612 * Queues are not necessarily dumped in increasing order of queue ID (or any
1613 * other predictable order).
1615 * Failure might indicate an actual error or merely that the last queue has
1616 * been dumped. An error status for the entire dump operation is provided when
1617 * it is completed by calling netdev_queue_dump_done().
1619 * The returned contents of 'details' should be documented as valid for the
1620 * given 'type' in the "other_config" column in the "Queue" table in
1621 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1623 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1624 * this function. This function will clear and replace its contents. The
1625 * caller must free 'details' when it is no longer needed (e.g. with
1626 * smap_destroy()). */
1628 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1629 unsigned int *queue_id, struct smap *details)
1631 const struct netdev *netdev = dump->netdev;
1637 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1641 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1647 /* Completes queue table dump operation 'dump', which must have been
1648 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1649 * was error-free, otherwise a positive errno value describing the problem. */
1651 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1653 const struct netdev *netdev = dump->netdev;
1654 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1655 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1658 netdev_close(dump->netdev);
1659 return dump->error == EOF ? 0 : dump->error;
1662 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1663 * its statistics, and the 'aux' specified by the caller. The order of
1664 * iteration is unspecified, but (when successful) each queue is visited
1667 * Calling this function may be more efficient than calling
1668 * netdev_get_queue_stats() for every queue.
1670 * 'cb' must not modify or free the statistics passed in.
1672 * Returns 0 if successful, otherwise a positive errno value. On error, some
1673 * configured queues may not have been included in the iteration. */
1675 netdev_dump_queue_stats(const struct netdev *netdev,
1676 netdev_dump_queue_stats_cb *cb, void *aux)
1678 const struct netdev_class *class = netdev->netdev_class;
1679 return (class->dump_queue_stats
1680 ? class->dump_queue_stats(netdev, cb, aux)
1685 /* Returns the class type of 'netdev'.
1687 * The caller must not free the returned value. */
1689 netdev_get_type(const struct netdev *netdev)
1691 return netdev->netdev_class->type;
1694 /* Returns the class associated with 'netdev'. */
1695 const struct netdev_class *
1696 netdev_get_class(const struct netdev *netdev)
1698 return netdev->netdev_class;
1701 /* Returns the netdev with 'name' or NULL if there is none.
1703 * The caller must free the returned netdev with netdev_close(). */
1705 netdev_from_name(const char *name)
1706 OVS_EXCLUDED(netdev_mutex)
1708 struct netdev *netdev;
1710 ovs_mutex_lock(&netdev_mutex);
1711 netdev = shash_find_data(&netdev_shash, name);
1715 ovs_mutex_unlock(&netdev_mutex);
1720 /* Fills 'device_list' with devices that match 'netdev_class'.
1722 * The caller is responsible for initializing and destroying 'device_list' and
1723 * must close each device on the list. */
1725 netdev_get_devices(const struct netdev_class *netdev_class,
1726 struct shash *device_list)
1727 OVS_EXCLUDED(netdev_mutex)
1729 struct shash_node *node;
1731 ovs_mutex_lock(&netdev_mutex);
1732 SHASH_FOR_EACH (node, &netdev_shash) {
1733 struct netdev *dev = node->data;
1735 if (dev->netdev_class == netdev_class) {
1737 shash_add(device_list, node->name, node->data);
1740 ovs_mutex_unlock(&netdev_mutex);
1743 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1744 * and returns it. Stores the size of the array into '*size'.
1746 * The caller is responsible for freeing 'vports' and must close
1747 * each 'netdev-vport' in the list. */
1749 netdev_get_vports(size_t *size)
1750 OVS_EXCLUDED(netdev_mutex)
1752 struct netdev **vports;
1753 struct shash_node *node;
1760 /* Explicitly allocates big enough chunk of memory. */
1761 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1762 ovs_mutex_lock(&netdev_mutex);
1763 SHASH_FOR_EACH (node, &netdev_shash) {
1764 struct netdev *dev = node->data;
1766 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1772 ovs_mutex_unlock(&netdev_mutex);
1779 netdev_get_type_from_name(const char *name)
1781 struct netdev *dev = netdev_from_name(name);
1782 const char *type = dev ? netdev_get_type(dev) : NULL;
1788 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1790 ovs_assert(rx->netdev->ref_cnt > 0);
1795 netdev_rxq_get_name(const struct netdev_rxq *rx)
1797 return netdev_get_name(netdev_rxq_get_netdev(rx));
1801 restore_all_flags(void *aux OVS_UNUSED)
1803 struct shash_node *node;
1805 SHASH_FOR_EACH (node, &netdev_shash) {
1806 struct netdev *netdev = node->data;
1807 const struct netdev_saved_flags *sf;
1808 enum netdev_flags saved_values;
1809 enum netdev_flags saved_flags;
1811 saved_values = saved_flags = 0;
1812 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1813 saved_flags |= sf->saved_flags;
1814 saved_values &= ~sf->saved_flags;
1815 saved_values |= sf->saved_flags & sf->saved_values;
1818 enum netdev_flags old_flags;
1820 netdev->netdev_class->update_flags(netdev,
1821 saved_flags & saved_values,
1822 saved_flags & ~saved_values,
1829 netdev_get_change_seq(const struct netdev *netdev)
1831 return netdev->change_seq;