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;
263 ovs_mutex_lock(&netdev_class_mutex);
264 rc = netdev_lookup_class(type);
266 VLOG_WARN("attempted to unregister a netdev provider that is not "
267 "registered: %s", type);
268 error = EAFNOSUPPORT;
271 hmap_remove(&netdev_classes, &rc->hmap_node);
275 VLOG_WARN("attempted to unregister in use netdev provider: %s",
280 ovs_mutex_unlock(&netdev_class_mutex);
285 /* Clears 'types' and enumerates the types of all currently registered netdev
286 * providers into it. The caller must first initialize the sset. */
288 netdev_enumerate_types(struct sset *types)
289 OVS_EXCLUDED(netdev_mutex)
291 struct netdev_registered_class *rc;
296 ovs_mutex_lock(&netdev_class_mutex);
297 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
298 sset_add(types, rc->class->type);
300 ovs_mutex_unlock(&netdev_class_mutex);
303 /* Check that the network device name is not the same as any of the registered
304 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
305 * does not define it) or the datapath internal port name (e.g. ovs-system).
307 * Returns true if there is a name conflict, false otherwise. */
309 netdev_is_reserved_name(const char *name)
310 OVS_EXCLUDED(netdev_mutex)
312 struct netdev_registered_class *rc;
316 ovs_mutex_lock(&netdev_class_mutex);
317 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
318 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
319 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
320 ovs_mutex_unlock(&netdev_class_mutex);
324 ovs_mutex_unlock(&netdev_class_mutex);
326 if (!strncmp(name, "ovs-", 4)) {
331 dp_enumerate_types(&types);
332 SSET_FOR_EACH (type, &types) {
333 if (!strcmp(name+4, type)) {
334 sset_destroy(&types);
338 sset_destroy(&types);
344 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
345 * (e.g. "system") and returns zero if successful, otherwise a positive errno
346 * value. On success, sets '*netdevp' to the new network device, otherwise to
349 * Some network devices may need to be configured (with netdev_set_config())
350 * before they can be used. */
352 netdev_open(const char *name, const char *type, struct netdev **netdevp)
353 OVS_EXCLUDED(netdev_mutex)
355 struct netdev *netdev;
360 ovs_mutex_lock(&netdev_class_mutex);
361 ovs_mutex_lock(&netdev_mutex);
362 netdev = shash_find_data(&netdev_shash, name);
364 struct netdev_registered_class *rc;
366 rc = netdev_lookup_class(type && type[0] ? type : "system");
368 netdev = rc->class->alloc();
370 memset(netdev, 0, sizeof *netdev);
371 netdev->netdev_class = rc->class;
372 netdev->name = xstrdup(name);
373 netdev->change_seq = 1;
374 netdev->node = shash_add(&netdev_shash, name, netdev);
376 /* By default enable one tx and rx queue per netdev. */
377 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
378 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
380 list_init(&netdev->saved_flags_list);
382 error = rc->class->construct(netdev);
385 netdev_change_seq_changed(netdev);
388 ovs_assert(list_is_empty(&netdev->saved_flags_list));
389 shash_delete(&netdev_shash, netdev->node);
390 rc->class->dealloc(netdev);
396 VLOG_WARN("could not create netdev %s of unknown type %s",
398 error = EAFNOSUPPORT;
410 ovs_mutex_unlock(&netdev_mutex);
411 ovs_mutex_unlock(&netdev_class_mutex);
416 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
417 * 'netdev_' is null. */
419 netdev_ref(const struct netdev *netdev_)
420 OVS_EXCLUDED(netdev_mutex)
422 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
425 ovs_mutex_lock(&netdev_mutex);
426 ovs_assert(netdev->ref_cnt > 0);
428 ovs_mutex_unlock(&netdev_mutex);
433 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
434 * or NULL if none are needed. */
436 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
437 OVS_EXCLUDED(netdev_mutex)
439 if (netdev->netdev_class->set_config) {
440 const struct smap no_args = SMAP_INITIALIZER(&no_args);
443 error = netdev->netdev_class->set_config(netdev,
444 args ? args : &no_args);
446 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
447 netdev_get_name(netdev), ovs_strerror(error));
450 } else if (args && !smap_is_empty(args)) {
451 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
452 netdev_get_name(netdev));
457 /* Returns the current configuration for 'netdev' in 'args'. The caller must
458 * have already initialized 'args' with smap_init(). Returns 0 on success, in
459 * which case 'args' will be filled with 'netdev''s configuration. On failure
460 * returns a positive errno value, in which case 'args' will be empty.
462 * The caller owns 'args' and its contents and must eventually free them with
465 netdev_get_config(const struct netdev *netdev, struct smap *args)
466 OVS_EXCLUDED(netdev_mutex)
471 if (netdev->netdev_class->get_config) {
472 error = netdev->netdev_class->get_config(netdev, args);
483 const struct netdev_tunnel_config *
484 netdev_get_tunnel_config(const struct netdev *netdev)
485 OVS_EXCLUDED(netdev_mutex)
487 if (netdev->netdev_class->get_tunnel_config) {
488 return netdev->netdev_class->get_tunnel_config(netdev);
494 /* Returns the id of the numa node the 'netdev' is on. If the function
495 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
497 netdev_get_numa_id(const struct netdev *netdev)
499 if (netdev->netdev_class->get_numa_id) {
500 return netdev->netdev_class->get_numa_id(netdev);
502 return NETDEV_NUMA_UNSPEC;
507 netdev_unref(struct netdev *dev)
508 OVS_RELEASES(netdev_mutex)
510 ovs_assert(dev->ref_cnt);
511 if (!--dev->ref_cnt) {
512 const struct netdev_class *class = dev->netdev_class;
513 struct netdev_registered_class *rc;
515 dev->netdev_class->destruct(dev);
518 shash_delete(&netdev_shash, dev->node);
521 dev->netdev_class->dealloc(dev);
522 ovs_mutex_unlock(&netdev_mutex);
524 ovs_mutex_lock(&netdev_class_mutex);
525 rc = netdev_lookup_class(class->type);
526 ovs_assert(rc->ref_cnt > 0);
528 ovs_mutex_unlock(&netdev_class_mutex);
530 ovs_mutex_unlock(&netdev_mutex);
534 /* Closes and destroys 'netdev'. */
536 netdev_close(struct netdev *netdev)
537 OVS_EXCLUDED(netdev_mutex)
540 ovs_mutex_lock(&netdev_mutex);
541 netdev_unref(netdev);
545 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
547 * This allows handler and revalidator threads to still retain references
548 * to this netdev while the main thread changes interface configuration.
550 * This function should only be called by the main thread when closing
551 * netdevs during user configuration changes. Otherwise, netdev_close should be
552 * used to close netdevs. */
554 netdev_remove(struct netdev *netdev)
557 ovs_mutex_lock(&netdev_mutex);
559 shash_delete(&netdev_shash, netdev->node);
561 netdev_change_seq_changed(netdev);
563 netdev_unref(netdev);
567 /* Parses 'netdev_name_', which is of the form [type@]name into its component
568 * pieces. 'name' and 'type' must be freed by the caller. */
570 netdev_parse_name(const char *netdev_name_, char **name, char **type)
572 char *netdev_name = xstrdup(netdev_name_);
575 separator = strchr(netdev_name, '@');
579 *name = xstrdup(separator + 1);
582 *type = xstrdup("system");
586 /* Attempts to open a netdev_rxq handle for obtaining packets received on
587 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
588 * '*rxp'. On failure, returns a positive errno value and stores NULL into
591 * Some kinds of network devices might not support receiving packets. This
592 * function returns EOPNOTSUPP in that case.*/
594 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
595 OVS_EXCLUDED(netdev_mutex)
599 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
600 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
604 error = netdev->netdev_class->rxq_construct(rx);
610 netdev->netdev_class->rxq_dealloc(rx);
624 netdev_rxq_close(struct netdev_rxq *rx)
625 OVS_EXCLUDED(netdev_mutex)
628 struct netdev *netdev = rx->netdev;
629 netdev->netdev_class->rxq_destruct(rx);
630 netdev->netdev_class->rxq_dealloc(rx);
631 netdev_close(netdev);
635 /* Attempts to receive batch of packets from 'rx'.
637 * Returns EAGAIN immediately if no packet is ready to be received.
639 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
640 * than 'dp_packet_tailroom(buffer)'.
642 * It is advised that the tailroom of 'buffer' should be
643 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
644 * out-of-band VLAN header to be added to the packet. At the very least,
645 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
647 * This function may be set to null if it would always return EOPNOTSUPP
650 netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet **buffers, int *cnt)
654 retval = rx->netdev->netdev_class->rxq_recv(rx, buffers, cnt);
656 COVERAGE_INC(netdev_received);
661 /* Arranges for poll_block() to wake up when a packet is ready to be received
664 netdev_rxq_wait(struct netdev_rxq *rx)
666 rx->netdev->netdev_class->rxq_wait(rx);
669 /* Discards any packets ready to be received on 'rx'. */
671 netdev_rxq_drain(struct netdev_rxq *rx)
673 return (rx->netdev->netdev_class->rxq_drain
674 ? rx->netdev->netdev_class->rxq_drain(rx)
678 /* Configures the number of tx queues and rx queues of 'netdev'.
679 * Return 0 if successful, otherwise a positive errno value.
681 * 'n_rxq' specifies the maximum number of receive queues to create.
682 * The netdev provider might choose to create less (e.g. if the hardware
683 * supports only a smaller number). The caller can check how many have been
684 * actually created by calling 'netdev_n_rxq()'
686 * 'n_txq' specifies the exact number of transmission queues to create.
687 * If this function returns successfully, the caller can make 'n_txq'
688 * concurrent calls to netdev_send() (each one with a different 'qid' in the
689 * range [0..'n_txq'-1]).
691 * On error, the tx queue and rx queue configuration is indeterminant.
692 * Caller should make decision on whether to restore the previous or
693 * the default configuration. Also, caller must make sure there is no
694 * other thread accessing the queues at the same time. */
696 netdev_set_multiq(struct netdev *netdev, unsigned int n_txq,
701 error = (netdev->netdev_class->set_multiq
702 ? netdev->netdev_class->set_multiq(netdev,
707 if (error && error != EOPNOTSUPP) {
708 VLOG_DBG_RL(&rl, "failed to set tx/rx queue for network device %s:"
709 "%s", netdev_get_name(netdev), ovs_strerror(error));
715 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
716 * otherwise a positive errno value. Returns EAGAIN without blocking if
717 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
718 * if a partial packet was transmitted or if a packet is too big or too small
719 * to transmit on the device.
721 * If the function returns a non-zero value, some of the packets might have
724 * To retain ownership of 'buffer' caller can set may_steal to false.
726 * The network device is expected to maintain one or more packet
727 * transmission queues, so that the caller does not ordinarily have to
728 * do additional queuing of packets. 'qid' specifies the queue to use
729 * and can be ignored if the implementation does not support multiple
732 * Some network devices may not implement support for this function. In such
733 * cases this function will always return EOPNOTSUPP. */
735 netdev_send(struct netdev *netdev, int qid, struct dp_packet **buffers,
736 int cnt, bool may_steal)
740 error = (netdev->netdev_class->send
741 ? netdev->netdev_class->send(netdev, qid, buffers, cnt, may_steal)
744 COVERAGE_INC(netdev_sent);
750 netdev_pop_header(struct netdev *netdev, struct dp_packet **buffers, int cnt)
754 if (!netdev->netdev_class->pop_header) {
758 for (i = 0; i < cnt; i++) {
761 err = netdev->netdev_class->pop_header(buffers[i]);
763 dp_packet_clear(buffers[i]);
771 netdev_build_header(const struct netdev *netdev, struct ovs_action_push_tnl *data,
772 const struct flow *tnl_flow)
774 if (netdev->netdev_class->build_header) {
775 return netdev->netdev_class->build_header(netdev, data, tnl_flow);
781 netdev_push_header(const struct netdev *netdev,
782 struct dp_packet **buffers, int cnt,
783 const struct ovs_action_push_tnl *data)
787 if (!netdev->netdev_class->push_header) {
791 for (i = 0; i < cnt; i++) {
792 netdev->netdev_class->push_header(buffers[i], data);
793 pkt_metadata_init(&buffers[i]->md, u32_to_odp(data->out_port));
799 /* Registers with the poll loop to wake up from the next call to poll_block()
800 * when the packet transmission queue has sufficient room to transmit a packet
801 * with netdev_send().
803 * The network device is expected to maintain one or more packet
804 * transmission queues, so that the caller does not ordinarily have to
805 * do additional queuing of packets. 'qid' specifies the queue to use
806 * and can be ignored if the implementation does not support multiple
809 netdev_send_wait(struct netdev *netdev, int qid)
811 if (netdev->netdev_class->send_wait) {
812 netdev->netdev_class->send_wait(netdev, qid);
816 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
817 * otherwise a positive errno value. */
819 netdev_set_etheraddr(struct netdev *netdev, const struct eth_addr mac)
821 return netdev->netdev_class->set_etheraddr(netdev, mac);
824 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
825 * the MAC address into 'mac'. On failure, returns a positive errno value and
826 * clears 'mac' to all-zeros. */
828 netdev_get_etheraddr(const struct netdev *netdev, struct eth_addr *mac)
830 return netdev->netdev_class->get_etheraddr(netdev, mac);
833 /* Returns the name of the network device that 'netdev' represents,
834 * e.g. "eth0". The caller must not modify or free the returned string. */
836 netdev_get_name(const struct netdev *netdev)
841 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
842 * (and received) packets, in bytes, not including the hardware header; thus,
843 * this is typically 1500 bytes for Ethernet devices.
845 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
846 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
847 * On other failure, returns a positive errno value. On failure, sets '*mtup'
850 netdev_get_mtu(const struct netdev *netdev, int *mtup)
852 const struct netdev_class *class = netdev->netdev_class;
855 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
858 if (error != EOPNOTSUPP) {
859 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
860 "%s", netdev_get_name(netdev), ovs_strerror(error));
866 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
867 * (and received) packets, in bytes.
869 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
870 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
873 netdev_set_mtu(const struct netdev *netdev, int mtu)
875 const struct netdev_class *class = netdev->netdev_class;
878 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
879 if (error && error != EOPNOTSUPP) {
880 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
881 netdev_get_name(netdev), ovs_strerror(error));
887 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
888 * failure, returns a negative errno value.
890 * The desired semantics of the ifindex value are a combination of those
891 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
892 * value should be unique within a host and remain stable at least until
893 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
894 * but many systems do not follow this rule anyhow.
896 * Some network devices may not implement support for this function. In such
897 * cases this function will always return -EOPNOTSUPP.
900 netdev_get_ifindex(const struct netdev *netdev)
902 int (*get_ifindex)(const struct netdev *);
904 get_ifindex = netdev->netdev_class->get_ifindex;
906 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
909 /* Stores the features supported by 'netdev' into each of '*current',
910 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
911 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
912 * successful, otherwise a positive errno value. On failure, all of the
913 * passed-in values are set to 0.
915 * Some network devices may not implement support for this function. In such
916 * cases this function will always return EOPNOTSUPP. */
918 netdev_get_features(const struct netdev *netdev,
919 enum netdev_features *current,
920 enum netdev_features *advertised,
921 enum netdev_features *supported,
922 enum netdev_features *peer)
924 int (*get_features)(const struct netdev *netdev,
925 enum netdev_features *current,
926 enum netdev_features *advertised,
927 enum netdev_features *supported,
928 enum netdev_features *peer);
929 enum netdev_features dummy[4];
936 advertised = &dummy[1];
939 supported = &dummy[2];
945 get_features = netdev->netdev_class->get_features;
947 ? get_features(netdev, current, advertised, supported,
951 *current = *advertised = *supported = *peer = 0;
956 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
957 * bits in 'features', in bits per second. If no bits that indicate a speed
958 * are set in 'features', returns 'default_bps'. */
960 netdev_features_to_bps(enum netdev_features features,
961 uint64_t default_bps)
964 F_1000000MB = NETDEV_F_1TB_FD,
965 F_100000MB = NETDEV_F_100GB_FD,
966 F_40000MB = NETDEV_F_40GB_FD,
967 F_10000MB = NETDEV_F_10GB_FD,
968 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
969 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
970 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
973 return ( features & F_1000000MB ? UINT64_C(1000000000000)
974 : features & F_100000MB ? UINT64_C(100000000000)
975 : features & F_40000MB ? UINT64_C(40000000000)
976 : features & F_10000MB ? UINT64_C(10000000000)
977 : features & F_1000MB ? UINT64_C(1000000000)
978 : features & F_100MB ? UINT64_C(100000000)
979 : features & F_10MB ? UINT64_C(10000000)
983 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
984 * are set in 'features', otherwise false. */
986 netdev_features_is_full_duplex(enum netdev_features features)
988 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
989 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
990 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
993 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
994 * successful, otherwise a positive errno value. */
996 netdev_set_advertisements(struct netdev *netdev,
997 enum netdev_features advertise)
999 return (netdev->netdev_class->set_advertisements
1000 ? netdev->netdev_class->set_advertisements(
1005 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
1006 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
1007 * errno value and sets '*address' to 0 (INADDR_ANY).
1009 * The following error values have well-defined meanings:
1011 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
1013 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
1015 * 'address' or 'netmask' or both may be null, in which case the address or
1016 * netmask is not reported. */
1018 netdev_get_in4(const struct netdev *netdev,
1019 struct in_addr *address_, struct in_addr *netmask_)
1021 struct in_addr address;
1022 struct in_addr netmask;
1025 error = (netdev->netdev_class->get_in4
1026 ? netdev->netdev_class->get_in4(netdev,
1030 address_->s_addr = error ? 0 : address.s_addr;
1033 netmask_->s_addr = error ? 0 : netmask.s_addr;
1038 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
1039 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
1040 * positive errno value. */
1042 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
1044 return (netdev->netdev_class->set_in4
1045 ? netdev->netdev_class->set_in4(netdev, addr, mask)
1049 /* Obtains ad IPv4 address from device name and save the address in
1050 * in4. Returns 0 if successful, otherwise a positive errno value.
1053 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
1055 struct netdev *netdev;
1058 error = netdev_open(device_name, "system", &netdev);
1060 in4->s_addr = htonl(0);
1064 error = netdev_get_in4(netdev, in4, NULL);
1065 netdev_close(netdev);
1069 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1072 netdev_add_router(struct netdev *netdev, struct in_addr router)
1074 COVERAGE_INC(netdev_add_router);
1075 return (netdev->netdev_class->add_router
1076 ? netdev->netdev_class->add_router(netdev, router)
1080 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1081 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1082 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1083 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1084 * a directly connected network) in '*next_hop' and a copy of the name of the
1085 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1086 * responsible for freeing '*netdev_name' (by calling free()). */
1088 netdev_get_next_hop(const struct netdev *netdev,
1089 const struct in_addr *host, struct in_addr *next_hop,
1092 int error = (netdev->netdev_class->get_next_hop
1093 ? netdev->netdev_class->get_next_hop(
1094 host, next_hop, netdev_name)
1097 next_hop->s_addr = 0;
1098 *netdev_name = NULL;
1103 /* Populates 'smap' with status information.
1105 * Populates 'smap' with 'netdev' specific status information. This
1106 * information may be used to populate the status column of the Interface table
1107 * as defined in ovs-vswitchd.conf.db(5). */
1109 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1111 return (netdev->netdev_class->get_status
1112 ? netdev->netdev_class->get_status(netdev, smap)
1116 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1117 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1118 * all-zero-bits (in6addr_any).
1120 * The following error values have well-defined meanings:
1122 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1124 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1126 * 'in6' may be null, in which case the address itself is not reported. */
1128 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
1130 struct in6_addr dummy;
1133 error = (netdev->netdev_class->get_in6
1134 ? netdev->netdev_class->get_in6(netdev,
1138 memset(in6, 0, sizeof *in6);
1143 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1144 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1146 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1147 enum netdev_flags on, enum netdev_flags *old_flagsp,
1148 struct netdev_saved_flags **sfp)
1149 OVS_EXCLUDED(netdev_mutex)
1151 struct netdev_saved_flags *sf = NULL;
1152 enum netdev_flags old_flags;
1155 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1158 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1159 off || on ? "set" : "get", netdev_get_name(netdev),
1160 ovs_strerror(error));
1162 } else if ((off || on) && sfp) {
1163 enum netdev_flags new_flags = (old_flags & ~off) | on;
1164 enum netdev_flags changed_flags = old_flags ^ new_flags;
1165 if (changed_flags) {
1166 ovs_mutex_lock(&netdev_mutex);
1167 *sfp = sf = xmalloc(sizeof *sf);
1168 sf->netdev = netdev;
1169 list_push_front(&netdev->saved_flags_list, &sf->node);
1170 sf->saved_flags = changed_flags;
1171 sf->saved_values = changed_flags & new_flags;
1174 ovs_mutex_unlock(&netdev_mutex);
1179 *old_flagsp = old_flags;
1188 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1189 * Returns 0 if successful, otherwise a positive errno value. On failure,
1190 * stores 0 into '*flagsp'. */
1192 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1194 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1195 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1198 /* Sets the flags for 'netdev' to 'flags'.
1199 * Returns 0 if successful, otherwise a positive errno value. */
1201 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1202 struct netdev_saved_flags **sfp)
1204 return do_update_flags(netdev, -1, flags, NULL, sfp);
1207 /* Turns on the specified 'flags' on 'netdev':
1209 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1210 * allocated 'struct netdev_saved_flags *' that may be passed to
1211 * netdev_restore_flags() to restore the original values of 'flags' on
1212 * 'netdev' (this will happen automatically at program termination if
1213 * netdev_restore_flags() is never called) , or to NULL if no flags were
1216 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1217 * '*sfp' to NULL. */
1219 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1220 struct netdev_saved_flags **sfp)
1222 return do_update_flags(netdev, 0, flags, NULL, sfp);
1225 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1226 * details of the interface. */
1228 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1229 struct netdev_saved_flags **sfp)
1231 return do_update_flags(netdev, flags, 0, NULL, sfp);
1234 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1235 * Does nothing if 'sf' is NULL. */
1237 netdev_restore_flags(struct netdev_saved_flags *sf)
1238 OVS_EXCLUDED(netdev_mutex)
1241 struct netdev *netdev = sf->netdev;
1242 enum netdev_flags old_flags;
1244 netdev->netdev_class->update_flags(netdev,
1245 sf->saved_flags & sf->saved_values,
1246 sf->saved_flags & ~sf->saved_values,
1249 ovs_mutex_lock(&netdev_mutex);
1250 list_remove(&sf->node);
1252 netdev_unref(netdev);
1256 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1257 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1258 * returns 0. Otherwise, it returns a positive errno value; in particular,
1259 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1261 netdev_arp_lookup(const struct netdev *netdev,
1262 ovs_be32 ip, struct eth_addr *mac)
1264 int error = (netdev->netdev_class->arp_lookup
1265 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1268 *mac = eth_addr_zero;
1273 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1275 netdev_get_carrier(const struct netdev *netdev)
1278 enum netdev_flags flags;
1281 netdev_get_flags(netdev, &flags);
1282 if (!(flags & NETDEV_UP)) {
1286 if (!netdev->netdev_class->get_carrier) {
1290 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1292 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1293 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1300 /* Returns the number of times 'netdev''s carrier has changed. */
1302 netdev_get_carrier_resets(const struct netdev *netdev)
1304 return (netdev->netdev_class->get_carrier_resets
1305 ? netdev->netdev_class->get_carrier_resets(netdev)
1309 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1310 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1311 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1312 * does not support MII, another method may be used as a fallback. If
1313 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1314 * its normal behavior.
1316 * Returns 0 if successful, otherwise a positive errno value. */
1318 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1320 return (netdev->netdev_class->set_miimon_interval
1321 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1325 /* Retrieves current device stats for 'netdev'. */
1327 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1331 COVERAGE_INC(netdev_get_stats);
1332 error = (netdev->netdev_class->get_stats
1333 ? netdev->netdev_class->get_stats(netdev, stats)
1336 memset(stats, 0xff, sizeof *stats);
1341 /* Attempts to set input rate limiting (policing) policy, such that up to
1342 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1343 * size of 'kbits' kb. */
1345 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1346 uint32_t kbits_burst)
1348 return (netdev->netdev_class->set_policing
1349 ? netdev->netdev_class->set_policing(netdev,
1350 kbits_rate, kbits_burst)
1354 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1355 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1356 * be documented as valid for the "type" column in the "QoS" table in
1357 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1359 * Every network device supports disabling QoS with a type of "", but this type
1360 * will not be added to 'types'.
1362 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1363 * this function. The caller is responsible for destroying 'types' (e.g. with
1364 * sset_destroy()) when it is no longer needed.
1366 * Returns 0 if successful, otherwise a positive errno value. */
1368 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1370 const struct netdev_class *class = netdev->netdev_class;
1371 return (class->get_qos_types
1372 ? class->get_qos_types(netdev, types)
1376 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1377 * which should be "" or one of the types returned by netdev_get_qos_types()
1378 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1379 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1380 * 'caps' to all zeros. */
1382 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1383 struct netdev_qos_capabilities *caps)
1385 const struct netdev_class *class = netdev->netdev_class;
1388 int retval = (class->get_qos_capabilities
1389 ? class->get_qos_capabilities(netdev, type, caps)
1392 memset(caps, 0, sizeof *caps);
1396 /* Every netdev supports turning off QoS. */
1397 memset(caps, 0, sizeof *caps);
1402 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1403 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1404 * the number of queues (zero on failure) in '*n_queuesp'.
1406 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1408 netdev_get_n_queues(const struct netdev *netdev,
1409 const char *type, unsigned int *n_queuesp)
1411 struct netdev_qos_capabilities caps;
1414 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1415 *n_queuesp = caps.n_queues;
1419 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1420 * stores the name of the current form of QoS into '*typep', stores any details
1421 * of configuration as string key-value pairs in 'details', and returns 0. On
1422 * failure, sets '*typep' to NULL and returns a positive errno value.
1424 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1426 * The caller must initialize 'details' as an empty smap (e.g. with
1427 * smap_init()) before calling this function. The caller must free 'details'
1428 * when it is no longer needed (e.g. with smap_destroy()).
1430 * The caller must not modify or free '*typep'.
1432 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1433 * 'netdev'. The contents of 'details' should be documented as valid for
1434 * '*typep' in the "other_config" column in the "QoS" table in
1435 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1437 netdev_get_qos(const struct netdev *netdev,
1438 const char **typep, struct smap *details)
1440 const struct netdev_class *class = netdev->netdev_class;
1443 if (class->get_qos) {
1444 retval = class->get_qos(netdev, typep, details);
1447 smap_clear(details);
1451 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1457 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1458 * with details of configuration from 'details'. Returns 0 if successful,
1459 * otherwise a positive errno value. On error, the previous QoS configuration
1462 * When this function changes the type of QoS (not just 'details'), this also
1463 * resets all queue configuration for 'netdev' to their defaults (which depend
1464 * on the specific type of QoS). Otherwise, the queue configuration for
1465 * 'netdev' is unchanged.
1467 * 'type' should be "" (to disable QoS) or one of the types returned by
1468 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1469 * documented as valid for the given 'type' in the "other_config" column in the
1470 * "QoS" table in vswitchd/vswitch.xml (which is built as
1471 * ovs-vswitchd.conf.db(8)).
1473 * NULL may be specified for 'details' if there are no configuration
1476 netdev_set_qos(struct netdev *netdev,
1477 const char *type, const struct smap *details)
1479 const struct netdev_class *class = netdev->netdev_class;
1485 if (class->set_qos) {
1487 static const struct smap empty = SMAP_INITIALIZER(&empty);
1490 return class->set_qos(netdev, type, details);
1492 return *type ? EOPNOTSUPP : 0;
1496 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1497 * successful, adds that information as string key-value pairs to 'details'.
1498 * Returns 0 if successful, otherwise a positive errno value.
1500 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1501 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1503 * The returned contents of 'details' should be documented as valid for the
1504 * given 'type' in the "other_config" column in the "Queue" table in
1505 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1507 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1508 * this function. The caller must free 'details' when it is no longer needed
1509 * (e.g. with smap_destroy()). */
1511 netdev_get_queue(const struct netdev *netdev,
1512 unsigned int queue_id, struct smap *details)
1514 const struct netdev_class *class = netdev->netdev_class;
1517 retval = (class->get_queue
1518 ? class->get_queue(netdev, queue_id, details)
1521 smap_clear(details);
1526 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1527 * string pairs in 'details'. The contents of 'details' should be documented
1528 * as valid for the given 'type' in the "other_config" column in the "Queue"
1529 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1530 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1531 * given queue's configuration should be unmodified.
1533 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1534 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1536 * This function does not modify 'details', and the caller retains ownership of
1539 netdev_set_queue(struct netdev *netdev,
1540 unsigned int queue_id, const struct smap *details)
1542 const struct netdev_class *class = netdev->netdev_class;
1543 return (class->set_queue
1544 ? class->set_queue(netdev, queue_id, details)
1548 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1549 * of QoS may have a fixed set of queues, in which case attempts to delete them
1550 * will fail with EOPNOTSUPP.
1552 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1553 * given queue will be unmodified.
1555 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1556 * the current form of QoS (e.g. as returned by
1557 * netdev_get_n_queues(netdev)). */
1559 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1561 const struct netdev_class *class = netdev->netdev_class;
1562 return (class->delete_queue
1563 ? class->delete_queue(netdev, queue_id)
1567 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1568 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1569 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1570 * positive errno value and fills 'stats' with values indicating unsupported
1573 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1574 struct netdev_queue_stats *stats)
1576 const struct netdev_class *class = netdev->netdev_class;
1579 retval = (class->get_queue_stats
1580 ? class->get_queue_stats(netdev, queue_id, stats)
1583 stats->tx_bytes = UINT64_MAX;
1584 stats->tx_packets = UINT64_MAX;
1585 stats->tx_errors = UINT64_MAX;
1586 stats->created = LLONG_MIN;
1591 /* Initializes 'dump' to begin dumping the queues in a netdev.
1593 * This function provides no status indication. An error status for the entire
1594 * dump operation is provided when it is completed by calling
1595 * netdev_queue_dump_done().
1598 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1599 const struct netdev *netdev)
1601 dump->netdev = netdev_ref(netdev);
1602 if (netdev->netdev_class->queue_dump_start) {
1603 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1606 dump->error = EOPNOTSUPP;
1610 /* Attempts to retrieve another queue from 'dump', which must have been
1611 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1612 * ID into '*queue_id', fills 'details' with configuration details for the
1613 * queue, and returns true. On failure, returns false.
1615 * Queues are not necessarily dumped in increasing order of queue ID (or any
1616 * other predictable order).
1618 * Failure might indicate an actual error or merely that the last queue has
1619 * been dumped. An error status for the entire dump operation is provided when
1620 * it is completed by calling netdev_queue_dump_done().
1622 * The returned contents of 'details' should be documented as valid for the
1623 * given 'type' in the "other_config" column in the "Queue" table in
1624 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1626 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1627 * this function. This function will clear and replace its contents. The
1628 * caller must free 'details' when it is no longer needed (e.g. with
1629 * smap_destroy()). */
1631 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1632 unsigned int *queue_id, struct smap *details)
1634 const struct netdev *netdev = dump->netdev;
1640 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1644 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1650 /* Completes queue table dump operation 'dump', which must have been
1651 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1652 * was error-free, otherwise a positive errno value describing the problem. */
1654 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1656 const struct netdev *netdev = dump->netdev;
1657 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1658 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1661 netdev_close(dump->netdev);
1662 return dump->error == EOF ? 0 : dump->error;
1665 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1666 * its statistics, and the 'aux' specified by the caller. The order of
1667 * iteration is unspecified, but (when successful) each queue is visited
1670 * Calling this function may be more efficient than calling
1671 * netdev_get_queue_stats() for every queue.
1673 * 'cb' must not modify or free the statistics passed in.
1675 * Returns 0 if successful, otherwise a positive errno value. On error, some
1676 * configured queues may not have been included in the iteration. */
1678 netdev_dump_queue_stats(const struct netdev *netdev,
1679 netdev_dump_queue_stats_cb *cb, void *aux)
1681 const struct netdev_class *class = netdev->netdev_class;
1682 return (class->dump_queue_stats
1683 ? class->dump_queue_stats(netdev, cb, aux)
1688 /* Returns the class type of 'netdev'.
1690 * The caller must not free the returned value. */
1692 netdev_get_type(const struct netdev *netdev)
1694 return netdev->netdev_class->type;
1697 /* Returns the class associated with 'netdev'. */
1698 const struct netdev_class *
1699 netdev_get_class(const struct netdev *netdev)
1701 return netdev->netdev_class;
1704 /* Returns the netdev with 'name' or NULL if there is none.
1706 * The caller must free the returned netdev with netdev_close(). */
1708 netdev_from_name(const char *name)
1709 OVS_EXCLUDED(netdev_mutex)
1711 struct netdev *netdev;
1713 ovs_mutex_lock(&netdev_mutex);
1714 netdev = shash_find_data(&netdev_shash, name);
1718 ovs_mutex_unlock(&netdev_mutex);
1723 /* Fills 'device_list' with devices that match 'netdev_class'.
1725 * The caller is responsible for initializing and destroying 'device_list' and
1726 * must close each device on the list. */
1728 netdev_get_devices(const struct netdev_class *netdev_class,
1729 struct shash *device_list)
1730 OVS_EXCLUDED(netdev_mutex)
1732 struct shash_node *node;
1734 ovs_mutex_lock(&netdev_mutex);
1735 SHASH_FOR_EACH (node, &netdev_shash) {
1736 struct netdev *dev = node->data;
1738 if (dev->netdev_class == netdev_class) {
1740 shash_add(device_list, node->name, node->data);
1743 ovs_mutex_unlock(&netdev_mutex);
1746 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1747 * and returns it. Stores the size of the array into '*size'.
1749 * The caller is responsible for freeing 'vports' and must close
1750 * each 'netdev-vport' in the list. */
1752 netdev_get_vports(size_t *size)
1753 OVS_EXCLUDED(netdev_mutex)
1755 struct netdev **vports;
1756 struct shash_node *node;
1763 /* Explicitly allocates big enough chunk of memory. */
1764 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1765 ovs_mutex_lock(&netdev_mutex);
1766 SHASH_FOR_EACH (node, &netdev_shash) {
1767 struct netdev *dev = node->data;
1769 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1775 ovs_mutex_unlock(&netdev_mutex);
1782 netdev_get_type_from_name(const char *name)
1784 struct netdev *dev = netdev_from_name(name);
1785 const char *type = dev ? netdev_get_type(dev) : NULL;
1791 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1793 ovs_assert(rx->netdev->ref_cnt > 0);
1798 netdev_rxq_get_name(const struct netdev_rxq *rx)
1800 return netdev_get_name(netdev_rxq_get_netdev(rx));
1804 restore_all_flags(void *aux OVS_UNUSED)
1806 struct shash_node *node;
1808 SHASH_FOR_EACH (node, &netdev_shash) {
1809 struct netdev *netdev = node->data;
1810 const struct netdev_saved_flags *sf;
1811 enum netdev_flags saved_values;
1812 enum netdev_flags saved_flags;
1814 saved_values = saved_flags = 0;
1815 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1816 saved_flags |= sf->saved_flags;
1817 saved_values &= ~sf->saved_flags;
1818 saved_values |= sf->saved_flags & sf->saved_values;
1821 enum netdev_flags old_flags;
1823 netdev->netdev_class->update_flags(netdev,
1824 saved_flags & saved_values,
1825 saved_flags & ~saved_values,
1832 netdev_get_change_seq(const struct netdev *netdev)
1834 return netdev->change_seq;