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, "dpdkvhostcuse") ||
115 !strcmp(netdev->netdev_class->type, "dpdkvhostuser"));
119 netdev_class_mutex_initialize(void)
120 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
122 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
124 if (ovsthread_once_start(&once)) {
125 ovs_mutex_init_recursive(&netdev_class_mutex);
126 ovsthread_once_done(&once);
131 netdev_initialize(void)
132 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
134 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
136 if (ovsthread_once_start(&once)) {
137 netdev_class_mutex_initialize();
139 fatal_signal_add_hook(restore_all_flags, NULL, NULL, true);
140 netdev_vport_patch_register();
143 netdev_register_provider(&netdev_linux_class);
144 netdev_register_provider(&netdev_internal_class);
145 netdev_register_provider(&netdev_tap_class);
146 netdev_vport_tunnel_register();
148 #if defined(__FreeBSD__) || defined(__NetBSD__)
149 netdev_register_provider(&netdev_tap_class);
150 netdev_register_provider(&netdev_bsd_class);
153 netdev_register_provider(&netdev_windows_class);
154 netdev_register_provider(&netdev_internal_class);
155 netdev_vport_tunnel_register();
157 netdev_dpdk_register();
159 ovsthread_once_done(&once);
163 /* Performs periodic work needed by all the various kinds of netdevs.
165 * If your program opens any netdevs, it must call this function within its
169 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
171 struct netdev_registered_class *rc;
174 ovs_mutex_lock(&netdev_class_mutex);
175 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
176 if (rc->class->run) {
180 ovs_mutex_unlock(&netdev_class_mutex);
183 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
185 * If your program opens any netdevs, it must call this function within its
189 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
191 struct netdev_registered_class *rc;
193 ovs_mutex_lock(&netdev_class_mutex);
194 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
195 if (rc->class->wait) {
199 ovs_mutex_unlock(&netdev_class_mutex);
202 static struct netdev_registered_class *
203 netdev_lookup_class(const char *type)
204 OVS_REQ_RDLOCK(netdev_class_mutex)
206 struct netdev_registered_class *rc;
208 HMAP_FOR_EACH_WITH_HASH (rc, hmap_node, hash_string(type, 0),
210 if (!strcmp(type, rc->class->type)) {
217 /* Initializes and registers a new netdev provider. After successful
218 * registration, new netdevs of that type can be opened using netdev_open(). */
220 netdev_register_provider(const struct netdev_class *new_class)
221 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
225 netdev_class_mutex_initialize();
226 ovs_mutex_lock(&netdev_class_mutex);
227 if (netdev_lookup_class(new_class->type)) {
228 VLOG_WARN("attempted to register duplicate netdev provider: %s",
232 error = new_class->init ? new_class->init() : 0;
234 struct netdev_registered_class *rc;
236 rc = xmalloc(sizeof *rc);
237 hmap_insert(&netdev_classes, &rc->hmap_node,
238 hash_string(new_class->type, 0));
239 rc->class = new_class;
242 VLOG_ERR("failed to initialize %s network device class: %s",
243 new_class->type, ovs_strerror(error));
246 ovs_mutex_unlock(&netdev_class_mutex);
251 /* Unregisters a netdev provider. 'type' must have been previously
252 * registered and not currently be in use by any netdevs. After unregistration
253 * new netdevs of that type cannot be opened using netdev_open(). */
255 netdev_unregister_provider(const char *type)
256 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
258 struct netdev_registered_class *rc;
261 ovs_mutex_lock(&netdev_class_mutex);
262 rc = netdev_lookup_class(type);
264 VLOG_WARN("attempted to unregister a netdev provider that is not "
265 "registered: %s", type);
266 error = EAFNOSUPPORT;
269 hmap_remove(&netdev_classes, &rc->hmap_node);
273 VLOG_WARN("attempted to unregister in use netdev provider: %s",
278 ovs_mutex_unlock(&netdev_class_mutex);
283 /* Clears 'types' and enumerates the types of all currently registered netdev
284 * providers into it. The caller must first initialize the sset. */
286 netdev_enumerate_types(struct sset *types)
287 OVS_EXCLUDED(netdev_mutex)
289 struct netdev_registered_class *rc;
294 ovs_mutex_lock(&netdev_class_mutex);
295 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
296 sset_add(types, rc->class->type);
298 ovs_mutex_unlock(&netdev_class_mutex);
301 /* Check that the network device name is not the same as any of the registered
302 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
303 * does not define it) or the datapath internal port name (e.g. ovs-system).
305 * Returns true if there is a name conflict, false otherwise. */
307 netdev_is_reserved_name(const char *name)
308 OVS_EXCLUDED(netdev_mutex)
310 struct netdev_registered_class *rc;
314 ovs_mutex_lock(&netdev_class_mutex);
315 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
316 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
317 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
318 ovs_mutex_unlock(&netdev_class_mutex);
322 ovs_mutex_unlock(&netdev_class_mutex);
324 if (!strncmp(name, "ovs-", 4)) {
329 dp_enumerate_types(&types);
330 SSET_FOR_EACH (type, &types) {
331 if (!strcmp(name+4, type)) {
332 sset_destroy(&types);
336 sset_destroy(&types);
342 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
343 * (e.g. "system") and returns zero if successful, otherwise a positive errno
344 * value. On success, sets '*netdevp' to the new network device, otherwise to
347 * Some network devices may need to be configured (with netdev_set_config())
348 * before they can be used. */
350 netdev_open(const char *name, const char *type, struct netdev **netdevp)
351 OVS_EXCLUDED(netdev_mutex)
353 struct netdev *netdev;
358 ovs_mutex_lock(&netdev_class_mutex);
359 ovs_mutex_lock(&netdev_mutex);
360 netdev = shash_find_data(&netdev_shash, name);
362 struct netdev_registered_class *rc;
364 rc = netdev_lookup_class(type && type[0] ? type : "system");
366 netdev = rc->class->alloc();
368 memset(netdev, 0, sizeof *netdev);
369 netdev->netdev_class = rc->class;
370 netdev->name = xstrdup(name);
371 netdev->change_seq = 1;
372 netdev->node = shash_add(&netdev_shash, name, netdev);
374 /* By default enable one tx and rx queue per netdev. */
375 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
376 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
378 list_init(&netdev->saved_flags_list);
380 error = rc->class->construct(netdev);
383 netdev_change_seq_changed(netdev);
386 ovs_assert(list_is_empty(&netdev->saved_flags_list));
387 shash_delete(&netdev_shash, netdev->node);
388 rc->class->dealloc(netdev);
394 VLOG_WARN("could not create netdev %s of unknown type %s",
396 error = EAFNOSUPPORT;
408 ovs_mutex_unlock(&netdev_mutex);
409 ovs_mutex_unlock(&netdev_class_mutex);
414 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
415 * 'netdev_' is null. */
417 netdev_ref(const struct netdev *netdev_)
418 OVS_EXCLUDED(netdev_mutex)
420 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
423 ovs_mutex_lock(&netdev_mutex);
424 ovs_assert(netdev->ref_cnt > 0);
426 ovs_mutex_unlock(&netdev_mutex);
431 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
432 * or NULL if none are needed. */
434 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
435 OVS_EXCLUDED(netdev_mutex)
437 if (netdev->netdev_class->set_config) {
438 const struct smap no_args = SMAP_INITIALIZER(&no_args);
441 error = netdev->netdev_class->set_config(netdev,
442 args ? args : &no_args);
444 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
445 netdev_get_name(netdev), ovs_strerror(error));
448 } else if (args && !smap_is_empty(args)) {
449 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
450 netdev_get_name(netdev));
455 /* Returns the current configuration for 'netdev' in 'args'. The caller must
456 * have already initialized 'args' with smap_init(). Returns 0 on success, in
457 * which case 'args' will be filled with 'netdev''s configuration. On failure
458 * returns a positive errno value, in which case 'args' will be empty.
460 * The caller owns 'args' and its contents and must eventually free them with
463 netdev_get_config(const struct netdev *netdev, struct smap *args)
464 OVS_EXCLUDED(netdev_mutex)
469 if (netdev->netdev_class->get_config) {
470 error = netdev->netdev_class->get_config(netdev, args);
481 const struct netdev_tunnel_config *
482 netdev_get_tunnel_config(const struct netdev *netdev)
483 OVS_EXCLUDED(netdev_mutex)
485 if (netdev->netdev_class->get_tunnel_config) {
486 return netdev->netdev_class->get_tunnel_config(netdev);
492 /* Returns the id of the numa node the 'netdev' is on. If the function
493 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
495 netdev_get_numa_id(const struct netdev *netdev)
497 if (netdev->netdev_class->get_numa_id) {
498 return netdev->netdev_class->get_numa_id(netdev);
500 return NETDEV_NUMA_UNSPEC;
505 netdev_unref(struct netdev *dev)
506 OVS_RELEASES(netdev_mutex)
508 ovs_assert(dev->ref_cnt);
509 if (!--dev->ref_cnt) {
510 const struct netdev_class *class = dev->netdev_class;
511 struct netdev_registered_class *rc;
513 dev->netdev_class->destruct(dev);
516 shash_delete(&netdev_shash, dev->node);
519 dev->netdev_class->dealloc(dev);
520 ovs_mutex_unlock(&netdev_mutex);
522 ovs_mutex_lock(&netdev_class_mutex);
523 rc = netdev_lookup_class(class->type);
524 ovs_assert(rc->ref_cnt > 0);
526 ovs_mutex_unlock(&netdev_class_mutex);
528 ovs_mutex_unlock(&netdev_mutex);
532 /* Closes and destroys 'netdev'. */
534 netdev_close(struct netdev *netdev)
535 OVS_EXCLUDED(netdev_mutex)
538 ovs_mutex_lock(&netdev_mutex);
539 netdev_unref(netdev);
543 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
545 * This allows handler and revalidator threads to still retain references
546 * to this netdev while the main thread changes interface configuration.
548 * This function should only be called by the main thread when closing
549 * netdevs during user configuration changes. Otherwise, netdev_close should be
550 * used to close netdevs. */
552 netdev_remove(struct netdev *netdev)
555 ovs_mutex_lock(&netdev_mutex);
557 shash_delete(&netdev_shash, netdev->node);
559 netdev_change_seq_changed(netdev);
561 netdev_unref(netdev);
565 /* Parses 'netdev_name_', which is of the form [type@]name into its component
566 * pieces. 'name' and 'type' must be freed by the caller. */
568 netdev_parse_name(const char *netdev_name_, char **name, char **type)
570 char *netdev_name = xstrdup(netdev_name_);
573 separator = strchr(netdev_name, '@');
577 *name = xstrdup(separator + 1);
580 *type = xstrdup("system");
584 /* Attempts to open a netdev_rxq handle for obtaining packets received on
585 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
586 * '*rxp'. On failure, returns a positive errno value and stores NULL into
589 * Some kinds of network devices might not support receiving packets. This
590 * function returns EOPNOTSUPP in that case.*/
592 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
593 OVS_EXCLUDED(netdev_mutex)
597 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
598 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
602 error = netdev->netdev_class->rxq_construct(rx);
608 netdev->netdev_class->rxq_dealloc(rx);
622 netdev_rxq_close(struct netdev_rxq *rx)
623 OVS_EXCLUDED(netdev_mutex)
626 struct netdev *netdev = rx->netdev;
627 netdev->netdev_class->rxq_destruct(rx);
628 netdev->netdev_class->rxq_dealloc(rx);
629 netdev_close(netdev);
633 /* Attempts to receive batch of packets from 'rx'.
635 * Returns EAGAIN immediately if no packet is ready to be received.
637 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
638 * than 'dp_packet_tailroom(buffer)'.
640 * It is advised that the tailroom of 'buffer' should be
641 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
642 * out-of-band VLAN header to be added to the packet. At the very least,
643 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
645 * This function may be set to null if it would always return EOPNOTSUPP
648 netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet **buffers, int *cnt)
652 retval = rx->netdev->netdev_class->rxq_recv(rx, buffers, cnt);
654 COVERAGE_INC(netdev_received);
659 /* Arranges for poll_block() to wake up when a packet is ready to be received
662 netdev_rxq_wait(struct netdev_rxq *rx)
664 rx->netdev->netdev_class->rxq_wait(rx);
667 /* Discards any packets ready to be received on 'rx'. */
669 netdev_rxq_drain(struct netdev_rxq *rx)
671 return (rx->netdev->netdev_class->rxq_drain
672 ? rx->netdev->netdev_class->rxq_drain(rx)
676 /* Configures the number of tx queues and rx queues of 'netdev'.
677 * Return 0 if successful, otherwise a positive errno value.
679 * 'n_rxq' specifies the maximum number of receive queues to create.
680 * The netdev provider might choose to create less (e.g. if the hardware
681 * supports only a smaller number). The caller can check how many have been
682 * actually created by calling 'netdev_n_rxq()'
684 * 'n_txq' specifies the exact number of transmission queues to create.
685 * If this function returns successfully, the caller can make 'n_txq'
686 * concurrent calls to netdev_send() (each one with a different 'qid' in the
687 * range [0..'n_txq'-1]).
689 * On error, the tx queue and rx queue configuration is indeterminant.
690 * Caller should make decision on whether to restore the previous or
691 * the default configuration. Also, caller must make sure there is no
692 * other thread accessing the queues at the same time. */
694 netdev_set_multiq(struct netdev *netdev, unsigned int n_txq,
699 error = (netdev->netdev_class->set_multiq
700 ? netdev->netdev_class->set_multiq(netdev,
705 if (error && error != EOPNOTSUPP) {
706 VLOG_DBG_RL(&rl, "failed to set tx/rx queue for network device %s:"
707 "%s", netdev_get_name(netdev), ovs_strerror(error));
713 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
714 * otherwise a positive errno value. Returns EAGAIN without blocking if
715 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
716 * if a partial packet was transmitted or if a packet is too big or too small
717 * to transmit on the device.
719 * If the function returns a non-zero value, some of the packets might have
722 * To retain ownership of 'buffer' caller can set may_steal to false.
724 * The network device is expected to maintain one or more packet
725 * transmission queues, so that the caller does not ordinarily have to
726 * do additional queuing of packets. 'qid' specifies the queue to use
727 * and can be ignored if the implementation does not support multiple
730 * Some network devices may not implement support for this function. In such
731 * cases this function will always return EOPNOTSUPP. */
733 netdev_send(struct netdev *netdev, int qid, struct dp_packet **buffers,
734 int cnt, bool may_steal)
738 error = (netdev->netdev_class->send
739 ? netdev->netdev_class->send(netdev, qid, buffers, cnt, may_steal)
742 COVERAGE_INC(netdev_sent);
748 netdev_pop_header(struct netdev *netdev, struct dp_packet **buffers, int cnt)
752 if (!netdev->netdev_class->pop_header) {
756 for (i = 0; i < cnt; i++) {
759 err = netdev->netdev_class->pop_header(buffers[i]);
761 dp_packet_clear(buffers[i]);
769 netdev_build_header(const struct netdev *netdev, struct ovs_action_push_tnl *data,
770 const struct flow *tnl_flow)
772 if (netdev->netdev_class->build_header) {
773 return netdev->netdev_class->build_header(netdev, data, tnl_flow);
779 netdev_push_header(const struct netdev *netdev,
780 struct dp_packet **buffers, int cnt,
781 const struct ovs_action_push_tnl *data)
785 if (!netdev->netdev_class->push_header) {
789 for (i = 0; i < cnt; i++) {
790 netdev->netdev_class->push_header(buffers[i], data);
791 buffers[i]->md = PKT_METADATA_INITIALIZER(u32_to_odp(data->out_port));
797 /* Registers with the poll loop to wake up from the next call to poll_block()
798 * when the packet transmission queue has sufficient room to transmit a packet
799 * with netdev_send().
801 * The network device is expected to maintain one or more packet
802 * transmission queues, so that the caller does not ordinarily have to
803 * do additional queuing of packets. 'qid' specifies the queue to use
804 * and can be ignored if the implementation does not support multiple
807 netdev_send_wait(struct netdev *netdev, int qid)
809 if (netdev->netdev_class->send_wait) {
810 netdev->netdev_class->send_wait(netdev, qid);
814 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
815 * otherwise a positive errno value. */
817 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
819 return netdev->netdev_class->set_etheraddr(netdev, mac);
822 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
823 * the MAC address into 'mac'. On failure, returns a positive errno value and
824 * clears 'mac' to all-zeros. */
826 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
828 return netdev->netdev_class->get_etheraddr(netdev, mac);
831 /* Returns the name of the network device that 'netdev' represents,
832 * e.g. "eth0". The caller must not modify or free the returned string. */
834 netdev_get_name(const struct netdev *netdev)
839 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
840 * (and received) packets, in bytes, not including the hardware header; thus,
841 * this is typically 1500 bytes for Ethernet devices.
843 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
844 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
845 * On other failure, returns a positive errno value. On failure, sets '*mtup'
848 netdev_get_mtu(const struct netdev *netdev, int *mtup)
850 const struct netdev_class *class = netdev->netdev_class;
853 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
856 if (error != EOPNOTSUPP) {
857 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
858 "%s", netdev_get_name(netdev), ovs_strerror(error));
864 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
865 * (and received) packets, in bytes.
867 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
868 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
871 netdev_set_mtu(const struct netdev *netdev, int mtu)
873 const struct netdev_class *class = netdev->netdev_class;
876 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
877 if (error && error != EOPNOTSUPP) {
878 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
879 netdev_get_name(netdev), ovs_strerror(error));
885 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
886 * failure, returns a negative errno value.
888 * The desired semantics of the ifindex value are a combination of those
889 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
890 * value should be unique within a host and remain stable at least until
891 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
892 * but many systems do not follow this rule anyhow.
894 * Some network devices may not implement support for this function. In such
895 * cases this function will always return -EOPNOTSUPP.
898 netdev_get_ifindex(const struct netdev *netdev)
900 int (*get_ifindex)(const struct netdev *);
902 get_ifindex = netdev->netdev_class->get_ifindex;
904 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
907 /* Stores the features supported by 'netdev' into each of '*current',
908 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
909 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
910 * successful, otherwise a positive errno value. On failure, all of the
911 * passed-in values are set to 0.
913 * Some network devices may not implement support for this function. In such
914 * cases this function will always return EOPNOTSUPP. */
916 netdev_get_features(const struct netdev *netdev,
917 enum netdev_features *current,
918 enum netdev_features *advertised,
919 enum netdev_features *supported,
920 enum netdev_features *peer)
922 int (*get_features)(const struct netdev *netdev,
923 enum netdev_features *current,
924 enum netdev_features *advertised,
925 enum netdev_features *supported,
926 enum netdev_features *peer);
927 enum netdev_features dummy[4];
934 advertised = &dummy[1];
937 supported = &dummy[2];
943 get_features = netdev->netdev_class->get_features;
945 ? get_features(netdev, current, advertised, supported,
949 *current = *advertised = *supported = *peer = 0;
954 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
955 * bits in 'features', in bits per second. If no bits that indicate a speed
956 * are set in 'features', returns 'default_bps'. */
958 netdev_features_to_bps(enum netdev_features features,
959 uint64_t default_bps)
962 F_1000000MB = NETDEV_F_1TB_FD,
963 F_100000MB = NETDEV_F_100GB_FD,
964 F_40000MB = NETDEV_F_40GB_FD,
965 F_10000MB = NETDEV_F_10GB_FD,
966 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
967 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
968 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
971 return ( features & F_1000000MB ? UINT64_C(1000000000000)
972 : features & F_100000MB ? UINT64_C(100000000000)
973 : features & F_40000MB ? UINT64_C(40000000000)
974 : features & F_10000MB ? UINT64_C(10000000000)
975 : features & F_1000MB ? UINT64_C(1000000000)
976 : features & F_100MB ? UINT64_C(100000000)
977 : features & F_10MB ? UINT64_C(10000000)
981 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
982 * are set in 'features', otherwise false. */
984 netdev_features_is_full_duplex(enum netdev_features features)
986 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
987 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
988 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
991 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
992 * successful, otherwise a positive errno value. */
994 netdev_set_advertisements(struct netdev *netdev,
995 enum netdev_features advertise)
997 return (netdev->netdev_class->set_advertisements
998 ? netdev->netdev_class->set_advertisements(
1003 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
1004 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
1005 * errno value and sets '*address' to 0 (INADDR_ANY).
1007 * The following error values have well-defined meanings:
1009 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
1011 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
1013 * 'address' or 'netmask' or both may be null, in which case the address or
1014 * netmask is not reported. */
1016 netdev_get_in4(const struct netdev *netdev,
1017 struct in_addr *address_, struct in_addr *netmask_)
1019 struct in_addr address;
1020 struct in_addr netmask;
1023 error = (netdev->netdev_class->get_in4
1024 ? netdev->netdev_class->get_in4(netdev,
1028 address_->s_addr = error ? 0 : address.s_addr;
1031 netmask_->s_addr = error ? 0 : netmask.s_addr;
1036 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
1037 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
1038 * positive errno value. */
1040 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
1042 return (netdev->netdev_class->set_in4
1043 ? netdev->netdev_class->set_in4(netdev, addr, mask)
1047 /* Obtains ad IPv4 address from device name and save the address in
1048 * in4. Returns 0 if successful, otherwise a positive errno value.
1051 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
1053 struct netdev *netdev;
1056 error = netdev_open(device_name, "system", &netdev);
1058 in4->s_addr = htonl(0);
1062 error = netdev_get_in4(netdev, in4, NULL);
1063 netdev_close(netdev);
1067 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1070 netdev_add_router(struct netdev *netdev, struct in_addr router)
1072 COVERAGE_INC(netdev_add_router);
1073 return (netdev->netdev_class->add_router
1074 ? netdev->netdev_class->add_router(netdev, router)
1078 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1079 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1080 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1081 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1082 * a directly connected network) in '*next_hop' and a copy of the name of the
1083 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1084 * responsible for freeing '*netdev_name' (by calling free()). */
1086 netdev_get_next_hop(const struct netdev *netdev,
1087 const struct in_addr *host, struct in_addr *next_hop,
1090 int error = (netdev->netdev_class->get_next_hop
1091 ? netdev->netdev_class->get_next_hop(
1092 host, next_hop, netdev_name)
1095 next_hop->s_addr = 0;
1096 *netdev_name = NULL;
1101 /* Populates 'smap' with status information.
1103 * Populates 'smap' with 'netdev' specific status information. This
1104 * information may be used to populate the status column of the Interface table
1105 * as defined in ovs-vswitchd.conf.db(5). */
1107 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1109 return (netdev->netdev_class->get_status
1110 ? netdev->netdev_class->get_status(netdev, smap)
1114 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1115 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1116 * all-zero-bits (in6addr_any).
1118 * The following error values have well-defined meanings:
1120 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1122 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1124 * 'in6' may be null, in which case the address itself is not reported. */
1126 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
1128 struct in6_addr dummy;
1131 error = (netdev->netdev_class->get_in6
1132 ? netdev->netdev_class->get_in6(netdev,
1136 memset(in6, 0, sizeof *in6);
1141 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1142 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1144 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1145 enum netdev_flags on, enum netdev_flags *old_flagsp,
1146 struct netdev_saved_flags **sfp)
1147 OVS_EXCLUDED(netdev_mutex)
1149 struct netdev_saved_flags *sf = NULL;
1150 enum netdev_flags old_flags;
1153 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1156 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1157 off || on ? "set" : "get", netdev_get_name(netdev),
1158 ovs_strerror(error));
1160 } else if ((off || on) && sfp) {
1161 enum netdev_flags new_flags = (old_flags & ~off) | on;
1162 enum netdev_flags changed_flags = old_flags ^ new_flags;
1163 if (changed_flags) {
1164 ovs_mutex_lock(&netdev_mutex);
1165 *sfp = sf = xmalloc(sizeof *sf);
1166 sf->netdev = netdev;
1167 list_push_front(&netdev->saved_flags_list, &sf->node);
1168 sf->saved_flags = changed_flags;
1169 sf->saved_values = changed_flags & new_flags;
1172 ovs_mutex_unlock(&netdev_mutex);
1177 *old_flagsp = old_flags;
1186 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1187 * Returns 0 if successful, otherwise a positive errno value. On failure,
1188 * stores 0 into '*flagsp'. */
1190 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1192 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1193 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1196 /* Sets the flags for 'netdev' to 'flags'.
1197 * Returns 0 if successful, otherwise a positive errno value. */
1199 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1200 struct netdev_saved_flags **sfp)
1202 return do_update_flags(netdev, -1, flags, NULL, sfp);
1205 /* Turns on the specified 'flags' on 'netdev':
1207 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1208 * allocated 'struct netdev_saved_flags *' that may be passed to
1209 * netdev_restore_flags() to restore the original values of 'flags' on
1210 * 'netdev' (this will happen automatically at program termination if
1211 * netdev_restore_flags() is never called) , or to NULL if no flags were
1214 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1215 * '*sfp' to NULL. */
1217 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1218 struct netdev_saved_flags **sfp)
1220 return do_update_flags(netdev, 0, flags, NULL, sfp);
1223 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1224 * details of the interface. */
1226 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1227 struct netdev_saved_flags **sfp)
1229 return do_update_flags(netdev, flags, 0, NULL, sfp);
1232 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1233 * Does nothing if 'sf' is NULL. */
1235 netdev_restore_flags(struct netdev_saved_flags *sf)
1236 OVS_EXCLUDED(netdev_mutex)
1239 struct netdev *netdev = sf->netdev;
1240 enum netdev_flags old_flags;
1242 netdev->netdev_class->update_flags(netdev,
1243 sf->saved_flags & sf->saved_values,
1244 sf->saved_flags & ~sf->saved_values,
1247 ovs_mutex_lock(&netdev_mutex);
1248 list_remove(&sf->node);
1250 netdev_unref(netdev);
1254 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1255 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1256 * returns 0. Otherwise, it returns a positive errno value; in particular,
1257 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1259 netdev_arp_lookup(const struct netdev *netdev,
1260 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
1262 int error = (netdev->netdev_class->arp_lookup
1263 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1266 memset(mac, 0, ETH_ADDR_LEN);
1271 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1273 netdev_get_carrier(const struct netdev *netdev)
1276 enum netdev_flags flags;
1279 netdev_get_flags(netdev, &flags);
1280 if (!(flags & NETDEV_UP)) {
1284 if (!netdev->netdev_class->get_carrier) {
1288 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1290 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1291 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1298 /* Returns the number of times 'netdev''s carrier has changed. */
1300 netdev_get_carrier_resets(const struct netdev *netdev)
1302 return (netdev->netdev_class->get_carrier_resets
1303 ? netdev->netdev_class->get_carrier_resets(netdev)
1307 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1308 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1309 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1310 * does not support MII, another method may be used as a fallback. If
1311 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1312 * its normal behavior.
1314 * Returns 0 if successful, otherwise a positive errno value. */
1316 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1318 return (netdev->netdev_class->set_miimon_interval
1319 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1323 /* Retrieves current device stats for 'netdev'. */
1325 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1329 COVERAGE_INC(netdev_get_stats);
1330 error = (netdev->netdev_class->get_stats
1331 ? netdev->netdev_class->get_stats(netdev, stats)
1334 memset(stats, 0xff, sizeof *stats);
1339 /* Attempts to set input rate limiting (policing) policy, such that up to
1340 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1341 * size of 'kbits' kb. */
1343 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1344 uint32_t kbits_burst)
1346 return (netdev->netdev_class->set_policing
1347 ? netdev->netdev_class->set_policing(netdev,
1348 kbits_rate, kbits_burst)
1352 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1353 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1354 * be documented as valid for the "type" column in the "QoS" table in
1355 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1357 * Every network device supports disabling QoS with a type of "", but this type
1358 * will not be added to 'types'.
1360 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1361 * this function. The caller is responsible for destroying 'types' (e.g. with
1362 * sset_destroy()) when it is no longer needed.
1364 * Returns 0 if successful, otherwise a positive errno value. */
1366 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1368 const struct netdev_class *class = netdev->netdev_class;
1369 return (class->get_qos_types
1370 ? class->get_qos_types(netdev, types)
1374 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1375 * which should be "" or one of the types returned by netdev_get_qos_types()
1376 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1377 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1378 * 'caps' to all zeros. */
1380 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1381 struct netdev_qos_capabilities *caps)
1383 const struct netdev_class *class = netdev->netdev_class;
1386 int retval = (class->get_qos_capabilities
1387 ? class->get_qos_capabilities(netdev, type, caps)
1390 memset(caps, 0, sizeof *caps);
1394 /* Every netdev supports turning off QoS. */
1395 memset(caps, 0, sizeof *caps);
1400 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1401 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1402 * the number of queues (zero on failure) in '*n_queuesp'.
1404 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1406 netdev_get_n_queues(const struct netdev *netdev,
1407 const char *type, unsigned int *n_queuesp)
1409 struct netdev_qos_capabilities caps;
1412 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1413 *n_queuesp = caps.n_queues;
1417 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1418 * stores the name of the current form of QoS into '*typep', stores any details
1419 * of configuration as string key-value pairs in 'details', and returns 0. On
1420 * failure, sets '*typep' to NULL and returns a positive errno value.
1422 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1424 * The caller must initialize 'details' as an empty smap (e.g. with
1425 * smap_init()) before calling this function. The caller must free 'details'
1426 * when it is no longer needed (e.g. with smap_destroy()).
1428 * The caller must not modify or free '*typep'.
1430 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1431 * 'netdev'. The contents of 'details' should be documented as valid for
1432 * '*typep' in the "other_config" column in the "QoS" table in
1433 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1435 netdev_get_qos(const struct netdev *netdev,
1436 const char **typep, struct smap *details)
1438 const struct netdev_class *class = netdev->netdev_class;
1441 if (class->get_qos) {
1442 retval = class->get_qos(netdev, typep, details);
1445 smap_clear(details);
1449 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1455 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1456 * with details of configuration from 'details'. Returns 0 if successful,
1457 * otherwise a positive errno value. On error, the previous QoS configuration
1460 * When this function changes the type of QoS (not just 'details'), this also
1461 * resets all queue configuration for 'netdev' to their defaults (which depend
1462 * on the specific type of QoS). Otherwise, the queue configuration for
1463 * 'netdev' is unchanged.
1465 * 'type' should be "" (to disable QoS) or one of the types returned by
1466 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1467 * documented as valid for the given 'type' in the "other_config" column in the
1468 * "QoS" table in vswitchd/vswitch.xml (which is built as
1469 * ovs-vswitchd.conf.db(8)).
1471 * NULL may be specified for 'details' if there are no configuration
1474 netdev_set_qos(struct netdev *netdev,
1475 const char *type, const struct smap *details)
1477 const struct netdev_class *class = netdev->netdev_class;
1483 if (class->set_qos) {
1485 static const struct smap empty = SMAP_INITIALIZER(&empty);
1488 return class->set_qos(netdev, type, details);
1490 return *type ? EOPNOTSUPP : 0;
1494 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1495 * successful, adds that information as string key-value pairs to 'details'.
1496 * Returns 0 if successful, otherwise a positive errno value.
1498 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1499 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1501 * The returned contents of 'details' should be documented as valid for the
1502 * given 'type' in the "other_config" column in the "Queue" table in
1503 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1505 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1506 * this function. The caller must free 'details' when it is no longer needed
1507 * (e.g. with smap_destroy()). */
1509 netdev_get_queue(const struct netdev *netdev,
1510 unsigned int queue_id, struct smap *details)
1512 const struct netdev_class *class = netdev->netdev_class;
1515 retval = (class->get_queue
1516 ? class->get_queue(netdev, queue_id, details)
1519 smap_clear(details);
1524 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1525 * string pairs in 'details'. The contents of 'details' should be documented
1526 * as valid for the given 'type' in the "other_config" column in the "Queue"
1527 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1528 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1529 * given queue's configuration should be unmodified.
1531 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1532 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1534 * This function does not modify 'details', and the caller retains ownership of
1537 netdev_set_queue(struct netdev *netdev,
1538 unsigned int queue_id, const struct smap *details)
1540 const struct netdev_class *class = netdev->netdev_class;
1541 return (class->set_queue
1542 ? class->set_queue(netdev, queue_id, details)
1546 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1547 * of QoS may have a fixed set of queues, in which case attempts to delete them
1548 * will fail with EOPNOTSUPP.
1550 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1551 * given queue will be unmodified.
1553 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1554 * the current form of QoS (e.g. as returned by
1555 * netdev_get_n_queues(netdev)). */
1557 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1559 const struct netdev_class *class = netdev->netdev_class;
1560 return (class->delete_queue
1561 ? class->delete_queue(netdev, queue_id)
1565 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1566 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1567 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1568 * positive errno value and fills 'stats' with values indicating unsupported
1571 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1572 struct netdev_queue_stats *stats)
1574 const struct netdev_class *class = netdev->netdev_class;
1577 retval = (class->get_queue_stats
1578 ? class->get_queue_stats(netdev, queue_id, stats)
1581 stats->tx_bytes = UINT64_MAX;
1582 stats->tx_packets = UINT64_MAX;
1583 stats->tx_errors = UINT64_MAX;
1584 stats->created = LLONG_MIN;
1589 /* Initializes 'dump' to begin dumping the queues in a netdev.
1591 * This function provides no status indication. An error status for the entire
1592 * dump operation is provided when it is completed by calling
1593 * netdev_queue_dump_done().
1596 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1597 const struct netdev *netdev)
1599 dump->netdev = netdev_ref(netdev);
1600 if (netdev->netdev_class->queue_dump_start) {
1601 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1604 dump->error = EOPNOTSUPP;
1608 /* Attempts to retrieve another queue from 'dump', which must have been
1609 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1610 * ID into '*queue_id', fills 'details' with configuration details for the
1611 * queue, and returns true. On failure, returns false.
1613 * Queues are not necessarily dumped in increasing order of queue ID (or any
1614 * other predictable order).
1616 * Failure might indicate an actual error or merely that the last queue has
1617 * been dumped. An error status for the entire dump operation is provided when
1618 * it is completed by calling netdev_queue_dump_done().
1620 * The returned contents of 'details' should be documented as valid for the
1621 * given 'type' in the "other_config" column in the "Queue" table in
1622 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1624 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1625 * this function. This function will clear and replace its contents. The
1626 * caller must free 'details' when it is no longer needed (e.g. with
1627 * smap_destroy()). */
1629 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1630 unsigned int *queue_id, struct smap *details)
1632 const struct netdev *netdev = dump->netdev;
1638 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1642 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1648 /* Completes queue table dump operation 'dump', which must have been
1649 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1650 * was error-free, otherwise a positive errno value describing the problem. */
1652 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1654 const struct netdev *netdev = dump->netdev;
1655 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1656 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1659 netdev_close(dump->netdev);
1660 return dump->error == EOF ? 0 : dump->error;
1663 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1664 * its statistics, and the 'aux' specified by the caller. The order of
1665 * iteration is unspecified, but (when successful) each queue is visited
1668 * Calling this function may be more efficient than calling
1669 * netdev_get_queue_stats() for every queue.
1671 * 'cb' must not modify or free the statistics passed in.
1673 * Returns 0 if successful, otherwise a positive errno value. On error, some
1674 * configured queues may not have been included in the iteration. */
1676 netdev_dump_queue_stats(const struct netdev *netdev,
1677 netdev_dump_queue_stats_cb *cb, void *aux)
1679 const struct netdev_class *class = netdev->netdev_class;
1680 return (class->dump_queue_stats
1681 ? class->dump_queue_stats(netdev, cb, aux)
1686 /* Returns the class type of 'netdev'.
1688 * The caller must not free the returned value. */
1690 netdev_get_type(const struct netdev *netdev)
1692 return netdev->netdev_class->type;
1695 /* Returns the class associated with 'netdev'. */
1696 const struct netdev_class *
1697 netdev_get_class(const struct netdev *netdev)
1699 return netdev->netdev_class;
1702 /* Returns the netdev with 'name' or NULL if there is none.
1704 * The caller must free the returned netdev with netdev_close(). */
1706 netdev_from_name(const char *name)
1707 OVS_EXCLUDED(netdev_mutex)
1709 struct netdev *netdev;
1711 ovs_mutex_lock(&netdev_mutex);
1712 netdev = shash_find_data(&netdev_shash, name);
1716 ovs_mutex_unlock(&netdev_mutex);
1721 /* Fills 'device_list' with devices that match 'netdev_class'.
1723 * The caller is responsible for initializing and destroying 'device_list' and
1724 * must close each device on the list. */
1726 netdev_get_devices(const struct netdev_class *netdev_class,
1727 struct shash *device_list)
1728 OVS_EXCLUDED(netdev_mutex)
1730 struct shash_node *node;
1732 ovs_mutex_lock(&netdev_mutex);
1733 SHASH_FOR_EACH (node, &netdev_shash) {
1734 struct netdev *dev = node->data;
1736 if (dev->netdev_class == netdev_class) {
1738 shash_add(device_list, node->name, node->data);
1741 ovs_mutex_unlock(&netdev_mutex);
1744 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1745 * and returns it. Stores the size of the array into '*size'.
1747 * The caller is responsible for freeing 'vports' and must close
1748 * each 'netdev-vport' in the list. */
1750 netdev_get_vports(size_t *size)
1751 OVS_EXCLUDED(netdev_mutex)
1753 struct netdev **vports;
1754 struct shash_node *node;
1761 /* Explicitly allocates big enough chunk of memory. */
1762 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1763 ovs_mutex_lock(&netdev_mutex);
1764 SHASH_FOR_EACH (node, &netdev_shash) {
1765 struct netdev *dev = node->data;
1767 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1773 ovs_mutex_unlock(&netdev_mutex);
1780 netdev_get_type_from_name(const char *name)
1782 struct netdev *dev = netdev_from_name(name);
1783 const char *type = dev ? netdev_get_type(dev) : NULL;
1789 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1791 ovs_assert(rx->netdev->ref_cnt > 0);
1796 netdev_rxq_get_name(const struct netdev_rxq *rx)
1798 return netdev_get_name(netdev_rxq_get_netdev(rx));
1802 restore_all_flags(void *aux OVS_UNUSED)
1804 struct shash_node *node;
1806 SHASH_FOR_EACH (node, &netdev_shash) {
1807 struct netdev *netdev = node->data;
1808 const struct netdev_saved_flags *sf;
1809 enum netdev_flags saved_values;
1810 enum netdev_flags saved_flags;
1812 saved_values = saved_flags = 0;
1813 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1814 saved_flags |= sf->saved_flags;
1815 saved_values &= ~sf->saved_flags;
1816 saved_values |= sf->saved_flags & sf->saved_values;
1819 enum netdev_flags old_flags;
1821 netdev->netdev_class->update_flags(netdev,
1822 saved_flags & saved_values,
1823 saved_flags & ~saved_values,
1830 netdev_get_change_seq(const struct netdev *netdev)
1832 return netdev->change_seq;