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 "dynamic-string.h"
30 #include "fatal-signal.h"
33 #include "netdev-dpdk.h"
34 #include "netdev-provider.h"
35 #include "netdev-vport.h"
37 #include "openflow/openflow.h"
39 #include "poll-loop.h"
46 VLOG_DEFINE_THIS_MODULE(netdev);
48 COVERAGE_DEFINE(netdev_received);
49 COVERAGE_DEFINE(netdev_sent);
50 COVERAGE_DEFINE(netdev_add_router);
51 COVERAGE_DEFINE(netdev_get_stats);
53 struct netdev_saved_flags {
54 struct netdev *netdev;
55 struct list node; /* In struct netdev's saved_flags_list. */
56 enum netdev_flags saved_flags;
57 enum netdev_flags saved_values;
60 /* Protects 'netdev_shash' and the mutable members of struct netdev. */
61 static struct ovs_mutex netdev_mutex = OVS_MUTEX_INITIALIZER;
63 /* All created network devices. */
64 static struct shash netdev_shash OVS_GUARDED_BY(netdev_mutex)
65 = SHASH_INITIALIZER(&netdev_shash);
67 /* Protects 'netdev_classes' against insertions or deletions.
69 * This is a recursive mutex to allow recursive acquisition when calling into
70 * providers. For example, netdev_run() calls into provider 'run' functions,
71 * which might reasonably want to call one of the netdev functions that takes
72 * netdev_class_mutex. */
73 static struct ovs_mutex netdev_class_mutex OVS_ACQ_BEFORE(netdev_mutex);
75 /* Contains 'struct netdev_registered_class'es. */
76 static struct hmap netdev_classes OVS_GUARDED_BY(netdev_class_mutex)
77 = HMAP_INITIALIZER(&netdev_classes);
79 struct netdev_registered_class {
80 /* In 'netdev_classes', by class->type. */
81 struct hmap_node hmap_node OVS_GUARDED_BY(netdev_class_mutex);
82 const struct netdev_class *class OVS_GUARDED_BY(netdev_class_mutex);
83 /* Number of 'struct netdev's of this class. */
84 int ref_cnt OVS_GUARDED_BY(netdev_class_mutex);
87 /* This is set pretty low because we probably won't learn anything from the
88 * additional log messages. */
89 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
91 static void restore_all_flags(void *aux OVS_UNUSED);
92 void update_device_args(struct netdev *, const struct shash *args);
95 netdev_n_txq(const struct netdev *netdev)
101 netdev_n_rxq(const struct netdev *netdev)
103 return netdev->n_rxq;
107 netdev_is_pmd(const struct netdev *netdev)
109 return (!strcmp(netdev->netdev_class->type, "dpdk") ||
110 !strcmp(netdev->netdev_class->type, "dpdkr"));
114 netdev_class_mutex_initialize(void)
115 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
117 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
119 if (ovsthread_once_start(&once)) {
120 ovs_mutex_init_recursive(&netdev_class_mutex);
121 ovsthread_once_done(&once);
126 netdev_initialize(void)
127 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
129 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
131 if (ovsthread_once_start(&once)) {
132 netdev_class_mutex_initialize();
134 fatal_signal_add_hook(restore_all_flags, NULL, NULL, true);
135 netdev_vport_patch_register();
138 netdev_register_provider(&netdev_linux_class);
139 netdev_register_provider(&netdev_internal_class);
140 netdev_register_provider(&netdev_tap_class);
141 netdev_vport_tunnel_register();
143 #if defined(__FreeBSD__) || defined(__NetBSD__)
144 netdev_register_provider(&netdev_tap_class);
145 netdev_register_provider(&netdev_bsd_class);
148 netdev_register_provider(&netdev_windows_class);
149 netdev_register_provider(&netdev_internal_class);
150 netdev_vport_tunnel_register();
152 netdev_dpdk_register();
154 ovsthread_once_done(&once);
158 /* Performs periodic work needed by all the various kinds of netdevs.
160 * If your program opens any netdevs, it must call this function within its
164 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
166 struct netdev_registered_class *rc;
169 ovs_mutex_lock(&netdev_class_mutex);
170 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
171 if (rc->class->run) {
175 ovs_mutex_unlock(&netdev_class_mutex);
178 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
180 * If your program opens any netdevs, it must call this function within its
184 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
186 struct netdev_registered_class *rc;
188 ovs_mutex_lock(&netdev_class_mutex);
189 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
190 if (rc->class->wait) {
194 ovs_mutex_unlock(&netdev_class_mutex);
197 static struct netdev_registered_class *
198 netdev_lookup_class(const char *type)
199 OVS_REQ_RDLOCK(netdev_class_mutex)
201 struct netdev_registered_class *rc;
203 HMAP_FOR_EACH_WITH_HASH (rc, hmap_node, hash_string(type, 0),
205 if (!strcmp(type, rc->class->type)) {
212 /* Initializes and registers a new netdev provider. After successful
213 * registration, new netdevs of that type can be opened using netdev_open(). */
215 netdev_register_provider(const struct netdev_class *new_class)
216 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
220 netdev_class_mutex_initialize();
221 ovs_mutex_lock(&netdev_class_mutex);
222 if (netdev_lookup_class(new_class->type)) {
223 VLOG_WARN("attempted to register duplicate netdev provider: %s",
227 error = new_class->init ? new_class->init() : 0;
229 struct netdev_registered_class *rc;
231 rc = xmalloc(sizeof *rc);
232 hmap_insert(&netdev_classes, &rc->hmap_node,
233 hash_string(new_class->type, 0));
234 rc->class = new_class;
237 VLOG_ERR("failed to initialize %s network device class: %s",
238 new_class->type, ovs_strerror(error));
241 ovs_mutex_unlock(&netdev_class_mutex);
246 /* Unregisters a netdev provider. 'type' must have been previously
247 * registered and not currently be in use by any netdevs. After unregistration
248 * new netdevs of that type cannot be opened using netdev_open(). */
250 netdev_unregister_provider(const char *type)
251 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
253 struct netdev_registered_class *rc;
256 ovs_mutex_lock(&netdev_class_mutex);
257 rc = netdev_lookup_class(type);
259 VLOG_WARN("attempted to unregister a netdev provider that is not "
260 "registered: %s", type);
261 error = EAFNOSUPPORT;
264 hmap_remove(&netdev_classes, &rc->hmap_node);
268 VLOG_WARN("attempted to unregister in use netdev provider: %s",
273 ovs_mutex_unlock(&netdev_class_mutex);
278 /* Clears 'types' and enumerates the types of all currently registered netdev
279 * providers into it. The caller must first initialize the sset. */
281 netdev_enumerate_types(struct sset *types)
282 OVS_EXCLUDED(netdev_mutex)
284 struct netdev_registered_class *rc;
289 ovs_mutex_lock(&netdev_class_mutex);
290 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
291 sset_add(types, rc->class->type);
293 ovs_mutex_unlock(&netdev_class_mutex);
296 /* Check that the network device name is not the same as any of the registered
297 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
298 * does not define it) or the datapath internal port name (e.g. ovs-system).
300 * Returns true if there is a name conflict, false otherwise. */
302 netdev_is_reserved_name(const char *name)
303 OVS_EXCLUDED(netdev_mutex)
305 struct netdev_registered_class *rc;
309 ovs_mutex_lock(&netdev_class_mutex);
310 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
311 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
312 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
313 ovs_mutex_unlock(&netdev_class_mutex);
317 ovs_mutex_unlock(&netdev_class_mutex);
319 if (!strncmp(name, "ovs-", 4)) {
324 dp_enumerate_types(&types);
325 SSET_FOR_EACH (type, &types) {
326 if (!strcmp(name+4, type)) {
327 sset_destroy(&types);
331 sset_destroy(&types);
337 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
338 * (e.g. "system") and returns zero if successful, otherwise a positive errno
339 * value. On success, sets '*netdevp' to the new network device, otherwise to
342 * Some network devices may need to be configured (with netdev_set_config())
343 * before they can be used. */
345 netdev_open(const char *name, const char *type, struct netdev **netdevp)
346 OVS_EXCLUDED(netdev_mutex)
348 struct netdev *netdev;
353 ovs_mutex_lock(&netdev_class_mutex);
354 ovs_mutex_lock(&netdev_mutex);
355 netdev = shash_find_data(&netdev_shash, name);
357 struct netdev_registered_class *rc;
359 rc = netdev_lookup_class(type && type[0] ? type : "system");
361 netdev = rc->class->alloc();
363 memset(netdev, 0, sizeof *netdev);
364 netdev->netdev_class = rc->class;
365 netdev->name = xstrdup(name);
366 netdev->change_seq = 1;
367 netdev->node = shash_add(&netdev_shash, name, netdev);
369 /* By default enable one tx and rx queue per netdev. */
370 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
371 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
373 list_init(&netdev->saved_flags_list);
375 error = rc->class->construct(netdev);
378 netdev_change_seq_changed(netdev);
381 ovs_assert(list_is_empty(&netdev->saved_flags_list));
382 shash_delete(&netdev_shash, netdev->node);
383 rc->class->dealloc(netdev);
389 VLOG_WARN("could not create netdev %s of unknown type %s",
391 error = EAFNOSUPPORT;
403 ovs_mutex_unlock(&netdev_mutex);
404 ovs_mutex_unlock(&netdev_class_mutex);
409 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
410 * 'netdev_' is null. */
412 netdev_ref(const struct netdev *netdev_)
413 OVS_EXCLUDED(netdev_mutex)
415 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
418 ovs_mutex_lock(&netdev_mutex);
419 ovs_assert(netdev->ref_cnt > 0);
421 ovs_mutex_unlock(&netdev_mutex);
426 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
427 * or NULL if none are needed. */
429 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
430 OVS_EXCLUDED(netdev_mutex)
432 if (netdev->netdev_class->set_config) {
433 const struct smap no_args = SMAP_INITIALIZER(&no_args);
436 error = netdev->netdev_class->set_config(netdev,
437 args ? args : &no_args);
439 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
440 netdev_get_name(netdev), ovs_strerror(error));
443 } else if (args && !smap_is_empty(args)) {
444 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
445 netdev_get_name(netdev));
450 /* Returns the current configuration for 'netdev' in 'args'. The caller must
451 * have already initialized 'args' with smap_init(). Returns 0 on success, in
452 * which case 'args' will be filled with 'netdev''s configuration. On failure
453 * returns a positive errno value, in which case 'args' will be empty.
455 * The caller owns 'args' and its contents and must eventually free them with
458 netdev_get_config(const struct netdev *netdev, struct smap *args)
459 OVS_EXCLUDED(netdev_mutex)
464 if (netdev->netdev_class->get_config) {
465 error = netdev->netdev_class->get_config(netdev, args);
476 const struct netdev_tunnel_config *
477 netdev_get_tunnel_config(const struct netdev *netdev)
478 OVS_EXCLUDED(netdev_mutex)
480 if (netdev->netdev_class->get_tunnel_config) {
481 return netdev->netdev_class->get_tunnel_config(netdev);
487 /* Returns the id of the numa node the 'netdev' is on. If the function
488 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
490 netdev_get_numa_id(const struct netdev *netdev)
492 if (netdev->netdev_class->get_numa_id) {
493 return netdev->netdev_class->get_numa_id(netdev);
495 return NETDEV_NUMA_UNSPEC;
500 netdev_unref(struct netdev *dev)
501 OVS_RELEASES(netdev_mutex)
503 ovs_assert(dev->ref_cnt);
504 if (!--dev->ref_cnt) {
505 const struct netdev_class *class = dev->netdev_class;
506 struct netdev_registered_class *rc;
508 dev->netdev_class->destruct(dev);
511 shash_delete(&netdev_shash, dev->node);
514 dev->netdev_class->dealloc(dev);
515 ovs_mutex_unlock(&netdev_mutex);
517 ovs_mutex_lock(&netdev_class_mutex);
518 rc = netdev_lookup_class(class->type);
519 ovs_assert(rc->ref_cnt > 0);
521 ovs_mutex_unlock(&netdev_class_mutex);
523 ovs_mutex_unlock(&netdev_mutex);
527 /* Closes and destroys 'netdev'. */
529 netdev_close(struct netdev *netdev)
530 OVS_EXCLUDED(netdev_mutex)
533 ovs_mutex_lock(&netdev_mutex);
534 netdev_unref(netdev);
538 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
540 * This allows handler and revalidator threads to still retain references
541 * to this netdev while the main thread changes interface configuration.
543 * This function should only be called by the main thread when closing
544 * netdevs during user configuration changes. Otherwise, netdev_close should be
545 * used to close netdevs. */
547 netdev_remove(struct netdev *netdev)
550 ovs_mutex_lock(&netdev_mutex);
552 shash_delete(&netdev_shash, netdev->node);
554 netdev_change_seq_changed(netdev);
556 netdev_unref(netdev);
560 /* Parses 'netdev_name_', which is of the form [type@]name into its component
561 * pieces. 'name' and 'type' must be freed by the caller. */
563 netdev_parse_name(const char *netdev_name_, char **name, char **type)
565 char *netdev_name = xstrdup(netdev_name_);
568 separator = strchr(netdev_name, '@');
572 *name = xstrdup(separator + 1);
575 *type = xstrdup("system");
579 /* Attempts to open a netdev_rxq handle for obtaining packets received on
580 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
581 * '*rxp'. On failure, returns a positive errno value and stores NULL into
584 * Some kinds of network devices might not support receiving packets. This
585 * function returns EOPNOTSUPP in that case.*/
587 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
588 OVS_EXCLUDED(netdev_mutex)
592 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
593 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
597 error = netdev->netdev_class->rxq_construct(rx);
603 netdev->netdev_class->rxq_dealloc(rx);
617 netdev_rxq_close(struct netdev_rxq *rx)
618 OVS_EXCLUDED(netdev_mutex)
621 struct netdev *netdev = rx->netdev;
622 netdev->netdev_class->rxq_destruct(rx);
623 netdev->netdev_class->rxq_dealloc(rx);
624 netdev_close(netdev);
628 /* Attempts to receive batch of packets from 'rx'.
630 * Returns EAGAIN immediately if no packet is ready to be received.
632 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
633 * than 'ofpbuf_tailroom(buffer)'.
635 * It is advised that the tailroom of 'buffer' should be
636 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
637 * out-of-band VLAN header to be added to the packet. At the very least,
638 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
640 * This function may be set to null if it would always return EOPNOTSUPP
643 netdev_rxq_recv(struct netdev_rxq *rx, struct dpif_packet **buffers, int *cnt)
647 retval = rx->netdev->netdev_class->rxq_recv(rx, buffers, cnt);
649 COVERAGE_INC(netdev_received);
654 /* Arranges for poll_block() to wake up when a packet is ready to be received
657 netdev_rxq_wait(struct netdev_rxq *rx)
659 rx->netdev->netdev_class->rxq_wait(rx);
662 /* Discards any packets ready to be received on 'rx'. */
664 netdev_rxq_drain(struct netdev_rxq *rx)
666 return (rx->netdev->netdev_class->rxq_drain
667 ? rx->netdev->netdev_class->rxq_drain(rx)
671 /* Configures the number of tx queues and rx queues of 'netdev'.
672 * Return 0 if successful, otherwise a positive errno value.
674 * On error, the tx queue and rx queue configuration is indeterminant.
675 * Caller should make decision on whether to restore the previous or
676 * the default configuration. Also, caller must make sure there is no
677 * other thread accessing the queues at the same time. */
679 netdev_set_multiq(struct netdev *netdev, unsigned int n_txq,
684 error = (netdev->netdev_class->set_multiq
685 ? netdev->netdev_class->set_multiq(netdev,
690 if (error && error != EOPNOTSUPP) {
691 VLOG_DBG_RL(&rl, "failed to set tx/rx queue for network device %s:"
692 "%s", netdev_get_name(netdev), ovs_strerror(error));
698 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
699 * otherwise a positive errno value. Returns EAGAIN without blocking if
700 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
701 * if a partial packet was transmitted or if a packet is too big or too small
702 * to transmit on the device.
704 * If the function returns a non-zero value, some of the packets might have
707 * To retain ownership of 'buffer' caller can set may_steal to false.
709 * The network device is expected to maintain one or more packet
710 * transmission queues, so that the caller does not ordinarily have to
711 * do additional queuing of packets. 'qid' specifies the queue to use
712 * and can be ignored if the implementation does not support multiple
715 * Some network devices may not implement support for this function. In such
716 * cases this function will always return EOPNOTSUPP. */
718 netdev_send(struct netdev *netdev, int qid, struct dpif_packet **buffers,
719 int cnt, bool may_steal)
723 error = (netdev->netdev_class->send
724 ? netdev->netdev_class->send(netdev, qid, buffers, cnt, may_steal)
727 COVERAGE_INC(netdev_sent);
732 /* Registers with the poll loop to wake up from the next call to poll_block()
733 * when the packet transmission queue has sufficient room to transmit a packet
734 * with netdev_send().
736 * The network device is expected to maintain one or more packet
737 * transmission queues, so that the caller does not ordinarily have to
738 * do additional queuing of packets. 'qid' specifies the queue to use
739 * and can be ignored if the implementation does not support multiple
742 netdev_send_wait(struct netdev *netdev, int qid)
744 if (netdev->netdev_class->send_wait) {
745 netdev->netdev_class->send_wait(netdev, qid);
749 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
750 * otherwise a positive errno value. */
752 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
754 return netdev->netdev_class->set_etheraddr(netdev, mac);
757 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
758 * the MAC address into 'mac'. On failure, returns a positive errno value and
759 * clears 'mac' to all-zeros. */
761 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
763 return netdev->netdev_class->get_etheraddr(netdev, mac);
766 /* Returns the name of the network device that 'netdev' represents,
767 * e.g. "eth0". The caller must not modify or free the returned string. */
769 netdev_get_name(const struct netdev *netdev)
774 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
775 * (and received) packets, in bytes, not including the hardware header; thus,
776 * this is typically 1500 bytes for Ethernet devices.
778 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
779 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
780 * On other failure, returns a positive errno value. On failure, sets '*mtup'
783 netdev_get_mtu(const struct netdev *netdev, int *mtup)
785 const struct netdev_class *class = netdev->netdev_class;
788 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
791 if (error != EOPNOTSUPP) {
792 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
793 "%s", netdev_get_name(netdev), ovs_strerror(error));
799 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
800 * (and received) packets, in bytes.
802 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
803 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
806 netdev_set_mtu(const struct netdev *netdev, int mtu)
808 const struct netdev_class *class = netdev->netdev_class;
811 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
812 if (error && error != EOPNOTSUPP) {
813 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
814 netdev_get_name(netdev), ovs_strerror(error));
820 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
821 * failure, returns a negative errno value.
823 * The desired semantics of the ifindex value are a combination of those
824 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
825 * value should be unique within a host and remain stable at least until
826 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
827 * but many systems do not follow this rule anyhow.
829 * Some network devices may not implement support for this function. In such
830 * cases this function will always return -EOPNOTSUPP.
833 netdev_get_ifindex(const struct netdev *netdev)
835 int (*get_ifindex)(const struct netdev *);
837 get_ifindex = netdev->netdev_class->get_ifindex;
839 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
842 /* Stores the features supported by 'netdev' into each of '*current',
843 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
844 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
845 * successful, otherwise a positive errno value. On failure, all of the
846 * passed-in values are set to 0.
848 * Some network devices may not implement support for this function. In such
849 * cases this function will always return EOPNOTSUPP. */
851 netdev_get_features(const struct netdev *netdev,
852 enum netdev_features *current,
853 enum netdev_features *advertised,
854 enum netdev_features *supported,
855 enum netdev_features *peer)
857 int (*get_features)(const struct netdev *netdev,
858 enum netdev_features *current,
859 enum netdev_features *advertised,
860 enum netdev_features *supported,
861 enum netdev_features *peer);
862 enum netdev_features dummy[4];
869 advertised = &dummy[1];
872 supported = &dummy[2];
878 get_features = netdev->netdev_class->get_features;
880 ? get_features(netdev, current, advertised, supported,
884 *current = *advertised = *supported = *peer = 0;
889 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
890 * bits in 'features', in bits per second. If no bits that indicate a speed
891 * are set in 'features', returns 'default_bps'. */
893 netdev_features_to_bps(enum netdev_features features,
894 uint64_t default_bps)
897 F_1000000MB = NETDEV_F_1TB_FD,
898 F_100000MB = NETDEV_F_100GB_FD,
899 F_40000MB = NETDEV_F_40GB_FD,
900 F_10000MB = NETDEV_F_10GB_FD,
901 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
902 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
903 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
906 return ( features & F_1000000MB ? UINT64_C(1000000000000)
907 : features & F_100000MB ? UINT64_C(100000000000)
908 : features & F_40000MB ? UINT64_C(40000000000)
909 : features & F_10000MB ? UINT64_C(10000000000)
910 : features & F_1000MB ? UINT64_C(1000000000)
911 : features & F_100MB ? UINT64_C(100000000)
912 : features & F_10MB ? UINT64_C(10000000)
916 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
917 * are set in 'features', otherwise false. */
919 netdev_features_is_full_duplex(enum netdev_features features)
921 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
922 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
923 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
926 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
927 * successful, otherwise a positive errno value. */
929 netdev_set_advertisements(struct netdev *netdev,
930 enum netdev_features advertise)
932 return (netdev->netdev_class->set_advertisements
933 ? netdev->netdev_class->set_advertisements(
938 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
939 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
940 * errno value and sets '*address' to 0 (INADDR_ANY).
942 * The following error values have well-defined meanings:
944 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
946 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
948 * 'address' or 'netmask' or both may be null, in which case the address or
949 * netmask is not reported. */
951 netdev_get_in4(const struct netdev *netdev,
952 struct in_addr *address_, struct in_addr *netmask_)
954 struct in_addr address;
955 struct in_addr netmask;
958 error = (netdev->netdev_class->get_in4
959 ? netdev->netdev_class->get_in4(netdev,
963 address_->s_addr = error ? 0 : address.s_addr;
966 netmask_->s_addr = error ? 0 : netmask.s_addr;
971 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
972 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
973 * positive errno value. */
975 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
977 return (netdev->netdev_class->set_in4
978 ? netdev->netdev_class->set_in4(netdev, addr, mask)
982 /* Obtains ad IPv4 address from device name and save the address in
983 * in4. Returns 0 if successful, otherwise a positive errno value.
986 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
988 struct netdev *netdev;
991 error = netdev_open(device_name, "system", &netdev);
993 in4->s_addr = htonl(0);
997 error = netdev_get_in4(netdev, in4, NULL);
998 netdev_close(netdev);
1002 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1005 netdev_add_router(struct netdev *netdev, struct in_addr router)
1007 COVERAGE_INC(netdev_add_router);
1008 return (netdev->netdev_class->add_router
1009 ? netdev->netdev_class->add_router(netdev, router)
1013 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1014 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1015 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1016 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1017 * a directly connected network) in '*next_hop' and a copy of the name of the
1018 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1019 * responsible for freeing '*netdev_name' (by calling free()). */
1021 netdev_get_next_hop(const struct netdev *netdev,
1022 const struct in_addr *host, struct in_addr *next_hop,
1025 int error = (netdev->netdev_class->get_next_hop
1026 ? netdev->netdev_class->get_next_hop(
1027 host, next_hop, netdev_name)
1030 next_hop->s_addr = 0;
1031 *netdev_name = NULL;
1036 /* Populates 'smap' with status information.
1038 * Populates 'smap' with 'netdev' specific status information. This
1039 * information may be used to populate the status column of the Interface table
1040 * as defined in ovs-vswitchd.conf.db(5). */
1042 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1044 return (netdev->netdev_class->get_status
1045 ? netdev->netdev_class->get_status(netdev, smap)
1049 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1050 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1051 * all-zero-bits (in6addr_any).
1053 * The following error values have well-defined meanings:
1055 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1057 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1059 * 'in6' may be null, in which case the address itself is not reported. */
1061 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
1063 struct in6_addr dummy;
1066 error = (netdev->netdev_class->get_in6
1067 ? netdev->netdev_class->get_in6(netdev,
1071 memset(in6, 0, sizeof *in6);
1076 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1077 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1079 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1080 enum netdev_flags on, enum netdev_flags *old_flagsp,
1081 struct netdev_saved_flags **sfp)
1082 OVS_EXCLUDED(netdev_mutex)
1084 struct netdev_saved_flags *sf = NULL;
1085 enum netdev_flags old_flags;
1088 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1091 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1092 off || on ? "set" : "get", netdev_get_name(netdev),
1093 ovs_strerror(error));
1095 } else if ((off || on) && sfp) {
1096 enum netdev_flags new_flags = (old_flags & ~off) | on;
1097 enum netdev_flags changed_flags = old_flags ^ new_flags;
1098 if (changed_flags) {
1099 ovs_mutex_lock(&netdev_mutex);
1100 *sfp = sf = xmalloc(sizeof *sf);
1101 sf->netdev = netdev;
1102 list_push_front(&netdev->saved_flags_list, &sf->node);
1103 sf->saved_flags = changed_flags;
1104 sf->saved_values = changed_flags & new_flags;
1107 ovs_mutex_unlock(&netdev_mutex);
1112 *old_flagsp = old_flags;
1121 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1122 * Returns 0 if successful, otherwise a positive errno value. On failure,
1123 * stores 0 into '*flagsp'. */
1125 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1127 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1128 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1131 /* Sets the flags for 'netdev' to 'flags'.
1132 * Returns 0 if successful, otherwise a positive errno value. */
1134 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1135 struct netdev_saved_flags **sfp)
1137 return do_update_flags(netdev, -1, flags, NULL, sfp);
1140 /* Turns on the specified 'flags' on 'netdev':
1142 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1143 * allocated 'struct netdev_saved_flags *' that may be passed to
1144 * netdev_restore_flags() to restore the original values of 'flags' on
1145 * 'netdev' (this will happen automatically at program termination if
1146 * netdev_restore_flags() is never called) , or to NULL if no flags were
1149 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1150 * '*sfp' to NULL. */
1152 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1153 struct netdev_saved_flags **sfp)
1155 return do_update_flags(netdev, 0, flags, NULL, sfp);
1158 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1159 * details of the interface. */
1161 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1162 struct netdev_saved_flags **sfp)
1164 return do_update_flags(netdev, flags, 0, NULL, sfp);
1167 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1168 * Does nothing if 'sf' is NULL. */
1170 netdev_restore_flags(struct netdev_saved_flags *sf)
1171 OVS_EXCLUDED(netdev_mutex)
1174 struct netdev *netdev = sf->netdev;
1175 enum netdev_flags old_flags;
1177 netdev->netdev_class->update_flags(netdev,
1178 sf->saved_flags & sf->saved_values,
1179 sf->saved_flags & ~sf->saved_values,
1182 ovs_mutex_lock(&netdev_mutex);
1183 list_remove(&sf->node);
1185 netdev_unref(netdev);
1189 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1190 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1191 * returns 0. Otherwise, it returns a positive errno value; in particular,
1192 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1194 netdev_arp_lookup(const struct netdev *netdev,
1195 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
1197 int error = (netdev->netdev_class->arp_lookup
1198 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1201 memset(mac, 0, ETH_ADDR_LEN);
1206 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1208 netdev_get_carrier(const struct netdev *netdev)
1211 enum netdev_flags flags;
1214 netdev_get_flags(netdev, &flags);
1215 if (!(flags & NETDEV_UP)) {
1219 if (!netdev->netdev_class->get_carrier) {
1223 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1225 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1226 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1233 /* Returns the number of times 'netdev''s carrier has changed. */
1235 netdev_get_carrier_resets(const struct netdev *netdev)
1237 return (netdev->netdev_class->get_carrier_resets
1238 ? netdev->netdev_class->get_carrier_resets(netdev)
1242 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1243 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1244 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1245 * does not support MII, another method may be used as a fallback. If
1246 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1247 * its normal behavior.
1249 * Returns 0 if successful, otherwise a positive errno value. */
1251 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1253 return (netdev->netdev_class->set_miimon_interval
1254 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1258 /* Retrieves current device stats for 'netdev'. */
1260 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1264 COVERAGE_INC(netdev_get_stats);
1265 error = (netdev->netdev_class->get_stats
1266 ? netdev->netdev_class->get_stats(netdev, stats)
1269 memset(stats, 0xff, sizeof *stats);
1274 /* Attempts to set input rate limiting (policing) policy, such that up to
1275 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1276 * size of 'kbits' kb. */
1278 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1279 uint32_t kbits_burst)
1281 return (netdev->netdev_class->set_policing
1282 ? netdev->netdev_class->set_policing(netdev,
1283 kbits_rate, kbits_burst)
1287 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1288 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1289 * be documented as valid for the "type" column in the "QoS" table in
1290 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1292 * Every network device supports disabling QoS with a type of "", but this type
1293 * will not be added to 'types'.
1295 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1296 * this function. The caller is responsible for destroying 'types' (e.g. with
1297 * sset_destroy()) when it is no longer needed.
1299 * Returns 0 if successful, otherwise a positive errno value. */
1301 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1303 const struct netdev_class *class = netdev->netdev_class;
1304 return (class->get_qos_types
1305 ? class->get_qos_types(netdev, types)
1309 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1310 * which should be "" or one of the types returned by netdev_get_qos_types()
1311 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1312 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1313 * 'caps' to all zeros. */
1315 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1316 struct netdev_qos_capabilities *caps)
1318 const struct netdev_class *class = netdev->netdev_class;
1321 int retval = (class->get_qos_capabilities
1322 ? class->get_qos_capabilities(netdev, type, caps)
1325 memset(caps, 0, sizeof *caps);
1329 /* Every netdev supports turning off QoS. */
1330 memset(caps, 0, sizeof *caps);
1335 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1336 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1337 * the number of queues (zero on failure) in '*n_queuesp'.
1339 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1341 netdev_get_n_queues(const struct netdev *netdev,
1342 const char *type, unsigned int *n_queuesp)
1344 struct netdev_qos_capabilities caps;
1347 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1348 *n_queuesp = caps.n_queues;
1352 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1353 * stores the name of the current form of QoS into '*typep', stores any details
1354 * of configuration as string key-value pairs in 'details', and returns 0. On
1355 * failure, sets '*typep' to NULL and returns a positive errno value.
1357 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1359 * The caller must initialize 'details' as an empty smap (e.g. with
1360 * smap_init()) before calling this function. The caller must free 'details'
1361 * when it is no longer needed (e.g. with smap_destroy()).
1363 * The caller must not modify or free '*typep'.
1365 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1366 * 'netdev'. The contents of 'details' should be documented as valid for
1367 * '*typep' in the "other_config" column in the "QoS" table in
1368 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1370 netdev_get_qos(const struct netdev *netdev,
1371 const char **typep, struct smap *details)
1373 const struct netdev_class *class = netdev->netdev_class;
1376 if (class->get_qos) {
1377 retval = class->get_qos(netdev, typep, details);
1380 smap_clear(details);
1384 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1390 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1391 * with details of configuration from 'details'. Returns 0 if successful,
1392 * otherwise a positive errno value. On error, the previous QoS configuration
1395 * When this function changes the type of QoS (not just 'details'), this also
1396 * resets all queue configuration for 'netdev' to their defaults (which depend
1397 * on the specific type of QoS). Otherwise, the queue configuration for
1398 * 'netdev' is unchanged.
1400 * 'type' should be "" (to disable QoS) or one of the types returned by
1401 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1402 * documented as valid for the given 'type' in the "other_config" column in the
1403 * "QoS" table in vswitchd/vswitch.xml (which is built as
1404 * ovs-vswitchd.conf.db(8)).
1406 * NULL may be specified for 'details' if there are no configuration
1409 netdev_set_qos(struct netdev *netdev,
1410 const char *type, const struct smap *details)
1412 const struct netdev_class *class = netdev->netdev_class;
1418 if (class->set_qos) {
1420 static const struct smap empty = SMAP_INITIALIZER(&empty);
1423 return class->set_qos(netdev, type, details);
1425 return *type ? EOPNOTSUPP : 0;
1429 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1430 * successful, adds that information as string key-value pairs to 'details'.
1431 * Returns 0 if successful, otherwise a positive errno value.
1433 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1434 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1436 * The returned contents of 'details' should be documented as valid for the
1437 * given 'type' in the "other_config" column in the "Queue" table in
1438 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1440 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1441 * this function. The caller must free 'details' when it is no longer needed
1442 * (e.g. with smap_destroy()). */
1444 netdev_get_queue(const struct netdev *netdev,
1445 unsigned int queue_id, struct smap *details)
1447 const struct netdev_class *class = netdev->netdev_class;
1450 retval = (class->get_queue
1451 ? class->get_queue(netdev, queue_id, details)
1454 smap_clear(details);
1459 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1460 * string pairs in 'details'. The contents of 'details' should be documented
1461 * as valid for the given 'type' in the "other_config" column in the "Queue"
1462 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1463 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1464 * given queue's configuration should be unmodified.
1466 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1467 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1469 * This function does not modify 'details', and the caller retains ownership of
1472 netdev_set_queue(struct netdev *netdev,
1473 unsigned int queue_id, const struct smap *details)
1475 const struct netdev_class *class = netdev->netdev_class;
1476 return (class->set_queue
1477 ? class->set_queue(netdev, queue_id, details)
1481 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1482 * of QoS may have a fixed set of queues, in which case attempts to delete them
1483 * will fail with EOPNOTSUPP.
1485 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1486 * given queue will be unmodified.
1488 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1489 * the current form of QoS (e.g. as returned by
1490 * netdev_get_n_queues(netdev)). */
1492 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1494 const struct netdev_class *class = netdev->netdev_class;
1495 return (class->delete_queue
1496 ? class->delete_queue(netdev, queue_id)
1500 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1501 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1502 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1503 * positive errno value and fills 'stats' with values indicating unsupported
1506 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1507 struct netdev_queue_stats *stats)
1509 const struct netdev_class *class = netdev->netdev_class;
1512 retval = (class->get_queue_stats
1513 ? class->get_queue_stats(netdev, queue_id, stats)
1516 stats->tx_bytes = UINT64_MAX;
1517 stats->tx_packets = UINT64_MAX;
1518 stats->tx_errors = UINT64_MAX;
1519 stats->created = LLONG_MIN;
1524 /* Initializes 'dump' to begin dumping the queues in a netdev.
1526 * This function provides no status indication. An error status for the entire
1527 * dump operation is provided when it is completed by calling
1528 * netdev_queue_dump_done().
1531 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1532 const struct netdev *netdev)
1534 dump->netdev = netdev_ref(netdev);
1535 if (netdev->netdev_class->queue_dump_start) {
1536 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1539 dump->error = EOPNOTSUPP;
1543 /* Attempts to retrieve another queue from 'dump', which must have been
1544 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1545 * ID into '*queue_id', fills 'details' with configuration details for the
1546 * queue, and returns true. On failure, returns false.
1548 * Queues are not necessarily dumped in increasing order of queue ID (or any
1549 * other predictable order).
1551 * Failure might indicate an actual error or merely that the last queue has
1552 * been dumped. An error status for the entire dump operation is provided when
1553 * it is completed by calling netdev_queue_dump_done().
1555 * The returned contents of 'details' should be documented as valid for the
1556 * given 'type' in the "other_config" column in the "Queue" table in
1557 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1559 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1560 * this function. This function will clear and replace its contents. The
1561 * caller must free 'details' when it is no longer needed (e.g. with
1562 * smap_destroy()). */
1564 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1565 unsigned int *queue_id, struct smap *details)
1567 const struct netdev *netdev = dump->netdev;
1573 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1577 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1583 /* Completes queue table dump operation 'dump', which must have been
1584 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1585 * was error-free, otherwise a positive errno value describing the problem. */
1587 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1589 const struct netdev *netdev = dump->netdev;
1590 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1591 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1594 netdev_close(dump->netdev);
1595 return dump->error == EOF ? 0 : dump->error;
1598 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1599 * its statistics, and the 'aux' specified by the caller. The order of
1600 * iteration is unspecified, but (when successful) each queue is visited
1603 * Calling this function may be more efficient than calling
1604 * netdev_get_queue_stats() for every queue.
1606 * 'cb' must not modify or free the statistics passed in.
1608 * Returns 0 if successful, otherwise a positive errno value. On error, some
1609 * configured queues may not have been included in the iteration. */
1611 netdev_dump_queue_stats(const struct netdev *netdev,
1612 netdev_dump_queue_stats_cb *cb, void *aux)
1614 const struct netdev_class *class = netdev->netdev_class;
1615 return (class->dump_queue_stats
1616 ? class->dump_queue_stats(netdev, cb, aux)
1621 /* Returns the class type of 'netdev'.
1623 * The caller must not free the returned value. */
1625 netdev_get_type(const struct netdev *netdev)
1627 return netdev->netdev_class->type;
1630 /* Returns the class associated with 'netdev'. */
1631 const struct netdev_class *
1632 netdev_get_class(const struct netdev *netdev)
1634 return netdev->netdev_class;
1637 /* Returns the netdev with 'name' or NULL if there is none.
1639 * The caller must free the returned netdev with netdev_close(). */
1641 netdev_from_name(const char *name)
1642 OVS_EXCLUDED(netdev_mutex)
1644 struct netdev *netdev;
1646 ovs_mutex_lock(&netdev_mutex);
1647 netdev = shash_find_data(&netdev_shash, name);
1651 ovs_mutex_unlock(&netdev_mutex);
1656 /* Fills 'device_list' with devices that match 'netdev_class'.
1658 * The caller is responsible for initializing and destroying 'device_list' and
1659 * must close each device on the list. */
1661 netdev_get_devices(const struct netdev_class *netdev_class,
1662 struct shash *device_list)
1663 OVS_EXCLUDED(netdev_mutex)
1665 struct shash_node *node;
1667 ovs_mutex_lock(&netdev_mutex);
1668 SHASH_FOR_EACH (node, &netdev_shash) {
1669 struct netdev *dev = node->data;
1671 if (dev->netdev_class == netdev_class) {
1673 shash_add(device_list, node->name, node->data);
1676 ovs_mutex_unlock(&netdev_mutex);
1679 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1680 * and returns it. Stores the size of the array into '*size'.
1682 * The caller is responsible for freeing 'vports' and must close
1683 * each 'netdev-vport' in the list. */
1685 netdev_get_vports(size_t *size)
1686 OVS_EXCLUDED(netdev_mutex)
1688 struct netdev **vports;
1689 struct shash_node *node;
1696 /* Explicitly allocates big enough chunk of memory. */
1697 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1698 ovs_mutex_lock(&netdev_mutex);
1699 SHASH_FOR_EACH (node, &netdev_shash) {
1700 struct netdev *dev = node->data;
1702 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1708 ovs_mutex_unlock(&netdev_mutex);
1715 netdev_get_type_from_name(const char *name)
1717 struct netdev *dev = netdev_from_name(name);
1718 const char *type = dev ? netdev_get_type(dev) : NULL;
1724 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1726 ovs_assert(rx->netdev->ref_cnt > 0);
1731 netdev_rxq_get_name(const struct netdev_rxq *rx)
1733 return netdev_get_name(netdev_rxq_get_netdev(rx));
1737 restore_all_flags(void *aux OVS_UNUSED)
1739 struct shash_node *node;
1741 SHASH_FOR_EACH (node, &netdev_shash) {
1742 struct netdev *netdev = node->data;
1743 const struct netdev_saved_flags *sf;
1744 enum netdev_flags saved_values;
1745 enum netdev_flags saved_flags;
1747 saved_values = saved_flags = 0;
1748 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1749 saved_flags |= sf->saved_flags;
1750 saved_values &= ~sf->saved_flags;
1751 saved_values |= sf->saved_flags & sf->saved_values;
1754 enum netdev_flags old_flags;
1756 netdev->netdev_class->update_flags(netdev,
1757 saved_flags & saved_values,
1758 saved_flags & ~saved_values,
1765 netdev_get_change_seq(const struct netdev *netdev)
1767 return netdev->change_seq;