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);
147 netdev_dpdk_register();
149 ovsthread_once_done(&once);
153 /* Performs periodic work needed by all the various kinds of netdevs.
155 * If your program opens any netdevs, it must call this function within its
159 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
161 struct netdev_registered_class *rc;
164 ovs_mutex_lock(&netdev_class_mutex);
165 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
166 if (rc->class->run) {
170 ovs_mutex_unlock(&netdev_class_mutex);
173 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
175 * If your program opens any netdevs, it must call this function within its
179 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
181 struct netdev_registered_class *rc;
183 ovs_mutex_lock(&netdev_class_mutex);
184 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
185 if (rc->class->wait) {
189 ovs_mutex_unlock(&netdev_class_mutex);
192 static struct netdev_registered_class *
193 netdev_lookup_class(const char *type)
194 OVS_REQ_RDLOCK(netdev_class_mutex)
196 struct netdev_registered_class *rc;
198 HMAP_FOR_EACH_WITH_HASH (rc, hmap_node, hash_string(type, 0),
200 if (!strcmp(type, rc->class->type)) {
207 /* Initializes and registers a new netdev provider. After successful
208 * registration, new netdevs of that type can be opened using netdev_open(). */
210 netdev_register_provider(const struct netdev_class *new_class)
211 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
215 netdev_class_mutex_initialize();
216 ovs_mutex_lock(&netdev_class_mutex);
217 if (netdev_lookup_class(new_class->type)) {
218 VLOG_WARN("attempted to register duplicate netdev provider: %s",
222 error = new_class->init ? new_class->init() : 0;
224 struct netdev_registered_class *rc;
226 rc = xmalloc(sizeof *rc);
227 hmap_insert(&netdev_classes, &rc->hmap_node,
228 hash_string(new_class->type, 0));
229 rc->class = new_class;
232 VLOG_ERR("failed to initialize %s network device class: %s",
233 new_class->type, ovs_strerror(error));
236 ovs_mutex_unlock(&netdev_class_mutex);
241 /* Unregisters a netdev provider. 'type' must have been previously
242 * registered and not currently be in use by any netdevs. After unregistration
243 * new netdevs of that type cannot be opened using netdev_open(). */
245 netdev_unregister_provider(const char *type)
246 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
248 struct netdev_registered_class *rc;
251 ovs_mutex_lock(&netdev_class_mutex);
252 rc = netdev_lookup_class(type);
254 VLOG_WARN("attempted to unregister a netdev provider that is not "
255 "registered: %s", type);
256 error = EAFNOSUPPORT;
259 hmap_remove(&netdev_classes, &rc->hmap_node);
263 VLOG_WARN("attempted to unregister in use netdev provider: %s",
268 ovs_mutex_unlock(&netdev_class_mutex);
273 /* Clears 'types' and enumerates the types of all currently registered netdev
274 * providers into it. The caller must first initialize the sset. */
276 netdev_enumerate_types(struct sset *types)
277 OVS_EXCLUDED(netdev_mutex)
279 struct netdev_registered_class *rc;
284 ovs_mutex_lock(&netdev_class_mutex);
285 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
286 sset_add(types, rc->class->type);
288 ovs_mutex_unlock(&netdev_class_mutex);
291 /* Check that the network device name is not the same as any of the registered
292 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
293 * does not define it) or the datapath internal port name (e.g. ovs-system).
295 * Returns true if there is a name conflict, false otherwise. */
297 netdev_is_reserved_name(const char *name)
298 OVS_EXCLUDED(netdev_mutex)
300 struct netdev_registered_class *rc;
304 ovs_mutex_lock(&netdev_class_mutex);
305 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
306 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
307 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
308 ovs_mutex_unlock(&netdev_class_mutex);
312 ovs_mutex_unlock(&netdev_class_mutex);
314 if (!strncmp(name, "ovs-", 4)) {
319 dp_enumerate_types(&types);
320 SSET_FOR_EACH (type, &types) {
321 if (!strcmp(name+4, type)) {
322 sset_destroy(&types);
326 sset_destroy(&types);
332 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
333 * (e.g. "system") and returns zero if successful, otherwise a positive errno
334 * value. On success, sets '*netdevp' to the new network device, otherwise to
337 * Some network devices may need to be configured (with netdev_set_config())
338 * before they can be used. */
340 netdev_open(const char *name, const char *type, struct netdev **netdevp)
341 OVS_EXCLUDED(netdev_mutex)
343 struct netdev *netdev;
348 ovs_mutex_lock(&netdev_class_mutex);
349 ovs_mutex_lock(&netdev_mutex);
350 netdev = shash_find_data(&netdev_shash, name);
352 struct netdev_registered_class *rc;
354 rc = netdev_lookup_class(type && type[0] ? type : "system");
356 netdev = rc->class->alloc();
358 memset(netdev, 0, sizeof *netdev);
359 netdev->netdev_class = rc->class;
360 netdev->name = xstrdup(name);
361 netdev->change_seq = 1;
362 netdev->node = shash_add(&netdev_shash, name, netdev);
364 /* By default enable one tx and rx queue per netdev. */
365 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
366 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
368 list_init(&netdev->saved_flags_list);
370 error = rc->class->construct(netdev);
373 netdev_change_seq_changed(netdev);
376 ovs_assert(list_is_empty(&netdev->saved_flags_list));
377 shash_delete(&netdev_shash, netdev->node);
378 rc->class->dealloc(netdev);
384 VLOG_WARN("could not create netdev %s of unknown type %s",
386 error = EAFNOSUPPORT;
398 ovs_mutex_unlock(&netdev_mutex);
399 ovs_mutex_unlock(&netdev_class_mutex);
404 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
405 * 'netdev_' is null. */
407 netdev_ref(const struct netdev *netdev_)
408 OVS_EXCLUDED(netdev_mutex)
410 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
413 ovs_mutex_lock(&netdev_mutex);
414 ovs_assert(netdev->ref_cnt > 0);
416 ovs_mutex_unlock(&netdev_mutex);
421 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
422 * or NULL if none are needed. */
424 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
425 OVS_EXCLUDED(netdev_mutex)
427 if (netdev->netdev_class->set_config) {
428 const struct smap no_args = SMAP_INITIALIZER(&no_args);
431 error = netdev->netdev_class->set_config(netdev,
432 args ? args : &no_args);
434 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
435 netdev_get_name(netdev), ovs_strerror(error));
438 } else if (args && !smap_is_empty(args)) {
439 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
440 netdev_get_name(netdev));
445 /* Returns the current configuration for 'netdev' in 'args'. The caller must
446 * have already initialized 'args' with smap_init(). Returns 0 on success, in
447 * which case 'args' will be filled with 'netdev''s configuration. On failure
448 * returns a positive errno value, in which case 'args' will be empty.
450 * The caller owns 'args' and its contents and must eventually free them with
453 netdev_get_config(const struct netdev *netdev, struct smap *args)
454 OVS_EXCLUDED(netdev_mutex)
459 if (netdev->netdev_class->get_config) {
460 error = netdev->netdev_class->get_config(netdev, args);
471 const struct netdev_tunnel_config *
472 netdev_get_tunnel_config(const struct netdev *netdev)
473 OVS_EXCLUDED(netdev_mutex)
475 if (netdev->netdev_class->get_tunnel_config) {
476 return netdev->netdev_class->get_tunnel_config(netdev);
482 /* Returns the id of the numa node the 'netdev' is on. If the function
483 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
485 netdev_get_numa_id(const struct netdev *netdev)
487 if (netdev->netdev_class->get_numa_id) {
488 return netdev->netdev_class->get_numa_id(netdev);
490 return NETDEV_NUMA_UNSPEC;
495 netdev_unref(struct netdev *dev)
496 OVS_RELEASES(netdev_mutex)
498 ovs_assert(dev->ref_cnt);
499 if (!--dev->ref_cnt) {
500 const struct netdev_class *class = dev->netdev_class;
501 struct netdev_registered_class *rc;
503 dev->netdev_class->destruct(dev);
506 shash_delete(&netdev_shash, dev->node);
509 dev->netdev_class->dealloc(dev);
510 ovs_mutex_unlock(&netdev_mutex);
512 ovs_mutex_lock(&netdev_class_mutex);
513 rc = netdev_lookup_class(class->type);
514 ovs_assert(rc->ref_cnt > 0);
516 ovs_mutex_unlock(&netdev_class_mutex);
518 ovs_mutex_unlock(&netdev_mutex);
522 /* Closes and destroys 'netdev'. */
524 netdev_close(struct netdev *netdev)
525 OVS_EXCLUDED(netdev_mutex)
528 ovs_mutex_lock(&netdev_mutex);
529 netdev_unref(netdev);
533 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
535 * This allows handler and revalidator threads to still retain references
536 * to this netdev while the main thread changes interface configuration.
538 * This function should only be called by the main thread when closing
539 * netdevs during user configuration changes. Otherwise, netdev_close should be
540 * used to close netdevs. */
542 netdev_remove(struct netdev *netdev)
545 ovs_mutex_lock(&netdev_mutex);
547 shash_delete(&netdev_shash, netdev->node);
549 netdev_change_seq_changed(netdev);
551 netdev_unref(netdev);
555 /* Parses 'netdev_name_', which is of the form [type@]name into its component
556 * pieces. 'name' and 'type' must be freed by the caller. */
558 netdev_parse_name(const char *netdev_name_, char **name, char **type)
560 char *netdev_name = xstrdup(netdev_name_);
563 separator = strchr(netdev_name, '@');
567 *name = xstrdup(separator + 1);
570 *type = xstrdup("system");
574 /* Attempts to open a netdev_rxq handle for obtaining packets received on
575 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
576 * '*rxp'. On failure, returns a positive errno value and stores NULL into
579 * Some kinds of network devices might not support receiving packets. This
580 * function returns EOPNOTSUPP in that case.*/
582 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
583 OVS_EXCLUDED(netdev_mutex)
587 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
588 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
592 error = netdev->netdev_class->rxq_construct(rx);
598 netdev->netdev_class->rxq_dealloc(rx);
612 netdev_rxq_close(struct netdev_rxq *rx)
613 OVS_EXCLUDED(netdev_mutex)
616 struct netdev *netdev = rx->netdev;
617 netdev->netdev_class->rxq_destruct(rx);
618 netdev->netdev_class->rxq_dealloc(rx);
619 netdev_close(netdev);
623 /* Attempts to receive batch of packets from 'rx'.
625 * Returns EAGAIN immediately if no packet is ready to be received.
627 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
628 * than 'ofpbuf_tailroom(buffer)'.
630 * It is advised that the tailroom of 'buffer' should be
631 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
632 * out-of-band VLAN header to be added to the packet. At the very least,
633 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
635 * This function may be set to null if it would always return EOPNOTSUPP
638 netdev_rxq_recv(struct netdev_rxq *rx, struct dpif_packet **buffers, int *cnt)
642 retval = rx->netdev->netdev_class->rxq_recv(rx, buffers, cnt);
644 COVERAGE_INC(netdev_received);
649 /* Arranges for poll_block() to wake up when a packet is ready to be received
652 netdev_rxq_wait(struct netdev_rxq *rx)
654 rx->netdev->netdev_class->rxq_wait(rx);
657 /* Discards any packets ready to be received on 'rx'. */
659 netdev_rxq_drain(struct netdev_rxq *rx)
661 return (rx->netdev->netdev_class->rxq_drain
662 ? rx->netdev->netdev_class->rxq_drain(rx)
666 /* Configures the number of tx queues and rx queues of 'netdev'.
667 * Return 0 if successful, otherwise a positive errno value.
669 * On error, the tx queue and rx queue configuration is indeterminant.
670 * Caller should make decision on whether to restore the previous or
671 * the default configuration. Also, caller must make sure there is no
672 * other thread accessing the queues at the same time. */
674 netdev_set_multiq(struct netdev *netdev, unsigned int n_txq,
679 error = (netdev->netdev_class->set_multiq
680 ? netdev->netdev_class->set_multiq(netdev,
685 if (error != EOPNOTSUPP) {
686 VLOG_DBG_RL(&rl, "failed to set tx/rx queue for network device %s:"
687 "%s", netdev_get_name(netdev), ovs_strerror(error));
693 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
694 * otherwise a positive errno value. Returns EAGAIN without blocking if
695 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
696 * if a partial packet was transmitted or if a packet is too big or too small
697 * to transmit on the device.
699 * If the function returns a non-zero value, some of the packets might have
702 * To retain ownership of 'buffer' caller can set may_steal to false.
704 * The network device is expected to maintain one or more packet
705 * transmission queues, so that the caller does not ordinarily have to
706 * do additional queuing of packets. 'qid' specifies the queue to use
707 * and can be ignored if the implementation does not support multiple
710 * Some network devices may not implement support for this function. In such
711 * cases this function will always return EOPNOTSUPP. */
713 netdev_send(struct netdev *netdev, int qid, struct dpif_packet **buffers,
714 int cnt, bool may_steal)
718 error = (netdev->netdev_class->send
719 ? netdev->netdev_class->send(netdev, qid, buffers, cnt, may_steal)
722 COVERAGE_INC(netdev_sent);
727 /* Registers with the poll loop to wake up from the next call to poll_block()
728 * when the packet transmission queue has sufficient room to transmit a packet
729 * with netdev_send().
731 * The network device is expected to maintain one or more packet
732 * transmission queues, so that the caller does not ordinarily have to
733 * do additional queuing of packets. 'qid' specifies the queue to use
734 * and can be ignored if the implementation does not support multiple
737 netdev_send_wait(struct netdev *netdev, int qid)
739 if (netdev->netdev_class->send_wait) {
740 netdev->netdev_class->send_wait(netdev, qid);
744 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
745 * otherwise a positive errno value. */
747 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
749 return netdev->netdev_class->set_etheraddr(netdev, mac);
752 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
753 * the MAC address into 'mac'. On failure, returns a positive errno value and
754 * clears 'mac' to all-zeros. */
756 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
758 return netdev->netdev_class->get_etheraddr(netdev, mac);
761 /* Returns the name of the network device that 'netdev' represents,
762 * e.g. "eth0". The caller must not modify or free the returned string. */
764 netdev_get_name(const struct netdev *netdev)
769 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
770 * (and received) packets, in bytes, not including the hardware header; thus,
771 * this is typically 1500 bytes for Ethernet devices.
773 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
774 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
775 * On other failure, returns a positive errno value. On failure, sets '*mtup'
778 netdev_get_mtu(const struct netdev *netdev, int *mtup)
780 const struct netdev_class *class = netdev->netdev_class;
783 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
786 if (error != EOPNOTSUPP) {
787 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
788 "%s", netdev_get_name(netdev), ovs_strerror(error));
794 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
795 * (and received) packets, in bytes.
797 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
798 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
801 netdev_set_mtu(const struct netdev *netdev, int mtu)
803 const struct netdev_class *class = netdev->netdev_class;
806 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
807 if (error && error != EOPNOTSUPP) {
808 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
809 netdev_get_name(netdev), ovs_strerror(error));
815 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
816 * failure, returns a negative errno value.
818 * The desired semantics of the ifindex value are a combination of those
819 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
820 * value should be unique within a host and remain stable at least until
821 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
822 * but many systems do not follow this rule anyhow.
824 * Some network devices may not implement support for this function. In such
825 * cases this function will always return -EOPNOTSUPP.
828 netdev_get_ifindex(const struct netdev *netdev)
830 int (*get_ifindex)(const struct netdev *);
832 get_ifindex = netdev->netdev_class->get_ifindex;
834 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
837 /* Stores the features supported by 'netdev' into each of '*current',
838 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
839 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
840 * successful, otherwise a positive errno value. On failure, all of the
841 * passed-in values are set to 0.
843 * Some network devices may not implement support for this function. In such
844 * cases this function will always return EOPNOTSUPP. */
846 netdev_get_features(const struct netdev *netdev,
847 enum netdev_features *current,
848 enum netdev_features *advertised,
849 enum netdev_features *supported,
850 enum netdev_features *peer)
852 int (*get_features)(const struct netdev *netdev,
853 enum netdev_features *current,
854 enum netdev_features *advertised,
855 enum netdev_features *supported,
856 enum netdev_features *peer);
857 enum netdev_features dummy[4];
864 advertised = &dummy[1];
867 supported = &dummy[2];
873 get_features = netdev->netdev_class->get_features;
875 ? get_features(netdev, current, advertised, supported,
879 *current = *advertised = *supported = *peer = 0;
884 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
885 * bits in 'features', in bits per second. If no bits that indicate a speed
886 * are set in 'features', returns 'default_bps'. */
888 netdev_features_to_bps(enum netdev_features features,
889 uint64_t default_bps)
892 F_1000000MB = NETDEV_F_1TB_FD,
893 F_100000MB = NETDEV_F_100GB_FD,
894 F_40000MB = NETDEV_F_40GB_FD,
895 F_10000MB = NETDEV_F_10GB_FD,
896 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
897 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
898 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
901 return ( features & F_1000000MB ? UINT64_C(1000000000000)
902 : features & F_100000MB ? UINT64_C(100000000000)
903 : features & F_40000MB ? UINT64_C(40000000000)
904 : features & F_10000MB ? UINT64_C(10000000000)
905 : features & F_1000MB ? UINT64_C(1000000000)
906 : features & F_100MB ? UINT64_C(100000000)
907 : features & F_10MB ? UINT64_C(10000000)
911 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
912 * are set in 'features', otherwise false. */
914 netdev_features_is_full_duplex(enum netdev_features features)
916 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
917 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
918 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
921 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
922 * successful, otherwise a positive errno value. */
924 netdev_set_advertisements(struct netdev *netdev,
925 enum netdev_features advertise)
927 return (netdev->netdev_class->set_advertisements
928 ? netdev->netdev_class->set_advertisements(
933 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
934 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
935 * errno value and sets '*address' to 0 (INADDR_ANY).
937 * The following error values have well-defined meanings:
939 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
941 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
943 * 'address' or 'netmask' or both may be null, in which case the address or
944 * netmask is not reported. */
946 netdev_get_in4(const struct netdev *netdev,
947 struct in_addr *address_, struct in_addr *netmask_)
949 struct in_addr address;
950 struct in_addr netmask;
953 error = (netdev->netdev_class->get_in4
954 ? netdev->netdev_class->get_in4(netdev,
958 address_->s_addr = error ? 0 : address.s_addr;
961 netmask_->s_addr = error ? 0 : netmask.s_addr;
966 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
967 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
968 * positive errno value. */
970 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
972 return (netdev->netdev_class->set_in4
973 ? netdev->netdev_class->set_in4(netdev, addr, mask)
977 /* Obtains ad IPv4 address from device name and save the address in
978 * in4. Returns 0 if successful, otherwise a positive errno value.
981 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
983 struct netdev *netdev;
986 error = netdev_open(device_name, "system", &netdev);
988 in4->s_addr = htonl(0);
992 error = netdev_get_in4(netdev, in4, NULL);
993 netdev_close(netdev);
997 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1000 netdev_add_router(struct netdev *netdev, struct in_addr router)
1002 COVERAGE_INC(netdev_add_router);
1003 return (netdev->netdev_class->add_router
1004 ? netdev->netdev_class->add_router(netdev, router)
1008 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1009 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1010 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1011 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1012 * a directly connected network) in '*next_hop' and a copy of the name of the
1013 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1014 * responsible for freeing '*netdev_name' (by calling free()). */
1016 netdev_get_next_hop(const struct netdev *netdev,
1017 const struct in_addr *host, struct in_addr *next_hop,
1020 int error = (netdev->netdev_class->get_next_hop
1021 ? netdev->netdev_class->get_next_hop(
1022 host, next_hop, netdev_name)
1025 next_hop->s_addr = 0;
1026 *netdev_name = NULL;
1031 /* Populates 'smap' with status information.
1033 * Populates 'smap' with 'netdev' specific status information. This
1034 * information may be used to populate the status column of the Interface table
1035 * as defined in ovs-vswitchd.conf.db(5). */
1037 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1039 return (netdev->netdev_class->get_status
1040 ? netdev->netdev_class->get_status(netdev, smap)
1044 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1045 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1046 * all-zero-bits (in6addr_any).
1048 * The following error values have well-defined meanings:
1050 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1052 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1054 * 'in6' may be null, in which case the address itself is not reported. */
1056 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
1058 struct in6_addr dummy;
1061 error = (netdev->netdev_class->get_in6
1062 ? netdev->netdev_class->get_in6(netdev,
1066 memset(in6, 0, sizeof *in6);
1071 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1072 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1074 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1075 enum netdev_flags on, enum netdev_flags *old_flagsp,
1076 struct netdev_saved_flags **sfp)
1077 OVS_EXCLUDED(netdev_mutex)
1079 struct netdev_saved_flags *sf = NULL;
1080 enum netdev_flags old_flags;
1083 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1086 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1087 off || on ? "set" : "get", netdev_get_name(netdev),
1088 ovs_strerror(error));
1090 } else if ((off || on) && sfp) {
1091 enum netdev_flags new_flags = (old_flags & ~off) | on;
1092 enum netdev_flags changed_flags = old_flags ^ new_flags;
1093 if (changed_flags) {
1094 ovs_mutex_lock(&netdev_mutex);
1095 *sfp = sf = xmalloc(sizeof *sf);
1096 sf->netdev = netdev;
1097 list_push_front(&netdev->saved_flags_list, &sf->node);
1098 sf->saved_flags = changed_flags;
1099 sf->saved_values = changed_flags & new_flags;
1102 ovs_mutex_unlock(&netdev_mutex);
1107 *old_flagsp = old_flags;
1116 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1117 * Returns 0 if successful, otherwise a positive errno value. On failure,
1118 * stores 0 into '*flagsp'. */
1120 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1122 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1123 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1126 /* Sets the flags for 'netdev' to 'flags'.
1127 * Returns 0 if successful, otherwise a positive errno value. */
1129 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1130 struct netdev_saved_flags **sfp)
1132 return do_update_flags(netdev, -1, flags, NULL, sfp);
1135 /* Turns on the specified 'flags' on 'netdev':
1137 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1138 * allocated 'struct netdev_saved_flags *' that may be passed to
1139 * netdev_restore_flags() to restore the original values of 'flags' on
1140 * 'netdev' (this will happen automatically at program termination if
1141 * netdev_restore_flags() is never called) , or to NULL if no flags were
1144 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1145 * '*sfp' to NULL. */
1147 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1148 struct netdev_saved_flags **sfp)
1150 return do_update_flags(netdev, 0, flags, NULL, sfp);
1153 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1154 * details of the interface. */
1156 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1157 struct netdev_saved_flags **sfp)
1159 return do_update_flags(netdev, flags, 0, NULL, sfp);
1162 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1163 * Does nothing if 'sf' is NULL. */
1165 netdev_restore_flags(struct netdev_saved_flags *sf)
1166 OVS_EXCLUDED(netdev_mutex)
1169 struct netdev *netdev = sf->netdev;
1170 enum netdev_flags old_flags;
1172 netdev->netdev_class->update_flags(netdev,
1173 sf->saved_flags & sf->saved_values,
1174 sf->saved_flags & ~sf->saved_values,
1177 ovs_mutex_lock(&netdev_mutex);
1178 list_remove(&sf->node);
1180 netdev_unref(netdev);
1184 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1185 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1186 * returns 0. Otherwise, it returns a positive errno value; in particular,
1187 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1189 netdev_arp_lookup(const struct netdev *netdev,
1190 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
1192 int error = (netdev->netdev_class->arp_lookup
1193 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1196 memset(mac, 0, ETH_ADDR_LEN);
1201 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1203 netdev_get_carrier(const struct netdev *netdev)
1206 enum netdev_flags flags;
1209 netdev_get_flags(netdev, &flags);
1210 if (!(flags & NETDEV_UP)) {
1214 if (!netdev->netdev_class->get_carrier) {
1218 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1220 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1221 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1228 /* Returns the number of times 'netdev''s carrier has changed. */
1230 netdev_get_carrier_resets(const struct netdev *netdev)
1232 return (netdev->netdev_class->get_carrier_resets
1233 ? netdev->netdev_class->get_carrier_resets(netdev)
1237 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1238 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1239 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1240 * does not support MII, another method may be used as a fallback. If
1241 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1242 * its normal behavior.
1244 * Returns 0 if successful, otherwise a positive errno value. */
1246 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1248 return (netdev->netdev_class->set_miimon_interval
1249 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1253 /* Retrieves current device stats for 'netdev'. */
1255 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1259 COVERAGE_INC(netdev_get_stats);
1260 error = (netdev->netdev_class->get_stats
1261 ? netdev->netdev_class->get_stats(netdev, stats)
1264 memset(stats, 0xff, sizeof *stats);
1269 /* Attempts to set input rate limiting (policing) policy, such that up to
1270 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1271 * size of 'kbits' kb. */
1273 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1274 uint32_t kbits_burst)
1276 return (netdev->netdev_class->set_policing
1277 ? netdev->netdev_class->set_policing(netdev,
1278 kbits_rate, kbits_burst)
1282 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1283 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1284 * be documented as valid for the "type" column in the "QoS" table in
1285 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1287 * Every network device supports disabling QoS with a type of "", but this type
1288 * will not be added to 'types'.
1290 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1291 * this function. The caller is responsible for destroying 'types' (e.g. with
1292 * sset_destroy()) when it is no longer needed.
1294 * Returns 0 if successful, otherwise a positive errno value. */
1296 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1298 const struct netdev_class *class = netdev->netdev_class;
1299 return (class->get_qos_types
1300 ? class->get_qos_types(netdev, types)
1304 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1305 * which should be "" or one of the types returned by netdev_get_qos_types()
1306 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1307 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1308 * 'caps' to all zeros. */
1310 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1311 struct netdev_qos_capabilities *caps)
1313 const struct netdev_class *class = netdev->netdev_class;
1316 int retval = (class->get_qos_capabilities
1317 ? class->get_qos_capabilities(netdev, type, caps)
1320 memset(caps, 0, sizeof *caps);
1324 /* Every netdev supports turning off QoS. */
1325 memset(caps, 0, sizeof *caps);
1330 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1331 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1332 * the number of queues (zero on failure) in '*n_queuesp'.
1334 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1336 netdev_get_n_queues(const struct netdev *netdev,
1337 const char *type, unsigned int *n_queuesp)
1339 struct netdev_qos_capabilities caps;
1342 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1343 *n_queuesp = caps.n_queues;
1347 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1348 * stores the name of the current form of QoS into '*typep', stores any details
1349 * of configuration as string key-value pairs in 'details', and returns 0. On
1350 * failure, sets '*typep' to NULL and returns a positive errno value.
1352 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1354 * The caller must initialize 'details' as an empty smap (e.g. with
1355 * smap_init()) before calling this function. The caller must free 'details'
1356 * when it is no longer needed (e.g. with smap_destroy()).
1358 * The caller must not modify or free '*typep'.
1360 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1361 * 'netdev'. The contents of 'details' should be documented as valid for
1362 * '*typep' in the "other_config" column in the "QoS" table in
1363 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1365 netdev_get_qos(const struct netdev *netdev,
1366 const char **typep, struct smap *details)
1368 const struct netdev_class *class = netdev->netdev_class;
1371 if (class->get_qos) {
1372 retval = class->get_qos(netdev, typep, details);
1375 smap_clear(details);
1379 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1385 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1386 * with details of configuration from 'details'. Returns 0 if successful,
1387 * otherwise a positive errno value. On error, the previous QoS configuration
1390 * When this function changes the type of QoS (not just 'details'), this also
1391 * resets all queue configuration for 'netdev' to their defaults (which depend
1392 * on the specific type of QoS). Otherwise, the queue configuration for
1393 * 'netdev' is unchanged.
1395 * 'type' should be "" (to disable QoS) or one of the types returned by
1396 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1397 * documented as valid for the given 'type' in the "other_config" column in the
1398 * "QoS" table in vswitchd/vswitch.xml (which is built as
1399 * ovs-vswitchd.conf.db(8)).
1401 * NULL may be specified for 'details' if there are no configuration
1404 netdev_set_qos(struct netdev *netdev,
1405 const char *type, const struct smap *details)
1407 const struct netdev_class *class = netdev->netdev_class;
1413 if (class->set_qos) {
1415 static const struct smap empty = SMAP_INITIALIZER(&empty);
1418 return class->set_qos(netdev, type, details);
1420 return *type ? EOPNOTSUPP : 0;
1424 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1425 * successful, adds that information as string key-value pairs to 'details'.
1426 * Returns 0 if successful, otherwise a positive errno value.
1428 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1429 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1431 * The returned contents of 'details' should be documented as valid for the
1432 * given 'type' in the "other_config" column in the "Queue" table in
1433 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1435 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1436 * this function. The caller must free 'details' when it is no longer needed
1437 * (e.g. with smap_destroy()). */
1439 netdev_get_queue(const struct netdev *netdev,
1440 unsigned int queue_id, struct smap *details)
1442 const struct netdev_class *class = netdev->netdev_class;
1445 retval = (class->get_queue
1446 ? class->get_queue(netdev, queue_id, details)
1449 smap_clear(details);
1454 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1455 * string pairs in 'details'. The contents of 'details' should be documented
1456 * as valid for the given 'type' in the "other_config" column in the "Queue"
1457 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1458 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1459 * given queue's configuration should be unmodified.
1461 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1462 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1464 * This function does not modify 'details', and the caller retains ownership of
1467 netdev_set_queue(struct netdev *netdev,
1468 unsigned int queue_id, const struct smap *details)
1470 const struct netdev_class *class = netdev->netdev_class;
1471 return (class->set_queue
1472 ? class->set_queue(netdev, queue_id, details)
1476 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1477 * of QoS may have a fixed set of queues, in which case attempts to delete them
1478 * will fail with EOPNOTSUPP.
1480 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1481 * given queue will be unmodified.
1483 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1484 * the current form of QoS (e.g. as returned by
1485 * netdev_get_n_queues(netdev)). */
1487 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1489 const struct netdev_class *class = netdev->netdev_class;
1490 return (class->delete_queue
1491 ? class->delete_queue(netdev, queue_id)
1495 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1496 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1497 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1498 * positive errno value and fills 'stats' with values indicating unsupported
1501 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1502 struct netdev_queue_stats *stats)
1504 const struct netdev_class *class = netdev->netdev_class;
1507 retval = (class->get_queue_stats
1508 ? class->get_queue_stats(netdev, queue_id, stats)
1511 stats->tx_bytes = UINT64_MAX;
1512 stats->tx_packets = UINT64_MAX;
1513 stats->tx_errors = UINT64_MAX;
1514 stats->created = LLONG_MIN;
1519 /* Initializes 'dump' to begin dumping the queues in a netdev.
1521 * This function provides no status indication. An error status for the entire
1522 * dump operation is provided when it is completed by calling
1523 * netdev_queue_dump_done().
1526 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1527 const struct netdev *netdev)
1529 dump->netdev = netdev_ref(netdev);
1530 if (netdev->netdev_class->queue_dump_start) {
1531 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1534 dump->error = EOPNOTSUPP;
1538 /* Attempts to retrieve another queue from 'dump', which must have been
1539 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1540 * ID into '*queue_id', fills 'details' with configuration details for the
1541 * queue, and returns true. On failure, returns false.
1543 * Queues are not necessarily dumped in increasing order of queue ID (or any
1544 * other predictable order).
1546 * Failure might indicate an actual error or merely that the last queue has
1547 * been dumped. An error status for the entire dump operation is provided when
1548 * it is completed by calling netdev_queue_dump_done().
1550 * The returned contents of 'details' should be documented as valid for the
1551 * given 'type' in the "other_config" column in the "Queue" table in
1552 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1554 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1555 * this function. This function will clear and replace its contents. The
1556 * caller must free 'details' when it is no longer needed (e.g. with
1557 * smap_destroy()). */
1559 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1560 unsigned int *queue_id, struct smap *details)
1562 const struct netdev *netdev = dump->netdev;
1568 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1572 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1578 /* Completes queue table dump operation 'dump', which must have been
1579 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1580 * was error-free, otherwise a positive errno value describing the problem. */
1582 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1584 const struct netdev *netdev = dump->netdev;
1585 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1586 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1589 netdev_close(dump->netdev);
1590 return dump->error == EOF ? 0 : dump->error;
1593 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1594 * its statistics, and the 'aux' specified by the caller. The order of
1595 * iteration is unspecified, but (when successful) each queue is visited
1598 * Calling this function may be more efficient than calling
1599 * netdev_get_queue_stats() for every queue.
1601 * 'cb' must not modify or free the statistics passed in.
1603 * Returns 0 if successful, otherwise a positive errno value. On error, some
1604 * configured queues may not have been included in the iteration. */
1606 netdev_dump_queue_stats(const struct netdev *netdev,
1607 netdev_dump_queue_stats_cb *cb, void *aux)
1609 const struct netdev_class *class = netdev->netdev_class;
1610 return (class->dump_queue_stats
1611 ? class->dump_queue_stats(netdev, cb, aux)
1616 /* Returns the class type of 'netdev'.
1618 * The caller must not free the returned value. */
1620 netdev_get_type(const struct netdev *netdev)
1622 return netdev->netdev_class->type;
1625 /* Returns the class associated with 'netdev'. */
1626 const struct netdev_class *
1627 netdev_get_class(const struct netdev *netdev)
1629 return netdev->netdev_class;
1632 /* Returns the netdev with 'name' or NULL if there is none.
1634 * The caller must free the returned netdev with netdev_close(). */
1636 netdev_from_name(const char *name)
1637 OVS_EXCLUDED(netdev_mutex)
1639 struct netdev *netdev;
1641 ovs_mutex_lock(&netdev_mutex);
1642 netdev = shash_find_data(&netdev_shash, name);
1646 ovs_mutex_unlock(&netdev_mutex);
1651 /* Fills 'device_list' with devices that match 'netdev_class'.
1653 * The caller is responsible for initializing and destroying 'device_list' and
1654 * must close each device on the list. */
1656 netdev_get_devices(const struct netdev_class *netdev_class,
1657 struct shash *device_list)
1658 OVS_EXCLUDED(netdev_mutex)
1660 struct shash_node *node;
1662 ovs_mutex_lock(&netdev_mutex);
1663 SHASH_FOR_EACH (node, &netdev_shash) {
1664 struct netdev *dev = node->data;
1666 if (dev->netdev_class == netdev_class) {
1668 shash_add(device_list, node->name, node->data);
1671 ovs_mutex_unlock(&netdev_mutex);
1674 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1675 * and returns it. Stores the size of the array into '*size'.
1677 * The caller is responsible for freeing 'vports' and must close
1678 * each 'netdev-vport' in the list. */
1680 netdev_get_vports(size_t *size)
1681 OVS_EXCLUDED(netdev_mutex)
1683 struct netdev **vports;
1684 struct shash_node *node;
1691 /* Explicitly allocates big enough chunk of memory. */
1692 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1693 ovs_mutex_lock(&netdev_mutex);
1694 SHASH_FOR_EACH (node, &netdev_shash) {
1695 struct netdev *dev = node->data;
1697 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1703 ovs_mutex_unlock(&netdev_mutex);
1710 netdev_get_type_from_name(const char *name)
1712 struct netdev *dev = netdev_from_name(name);
1713 const char *type = dev ? netdev_get_type(dev) : NULL;
1719 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1721 ovs_assert(rx->netdev->ref_cnt > 0);
1726 netdev_rxq_get_name(const struct netdev_rxq *rx)
1728 return netdev_get_name(netdev_rxq_get_netdev(rx));
1732 restore_all_flags(void *aux OVS_UNUSED)
1734 struct shash_node *node;
1736 SHASH_FOR_EACH (node, &netdev_shash) {
1737 struct netdev *netdev = node->data;
1738 const struct netdev_saved_flags *sf;
1739 enum netdev_flags saved_values;
1740 enum netdev_flags saved_flags;
1742 saved_values = saved_flags = 0;
1743 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1744 saved_flags |= sf->saved_flags;
1745 saved_values &= ~sf->saved_flags;
1746 saved_values |= sf->saved_flags & sf->saved_values;
1749 enum netdev_flags old_flags;
1751 netdev->netdev_class->update_flags(netdev,
1752 saved_flags & saved_values,
1753 saved_flags & ~saved_values,
1760 netdev_get_change_seq(const struct netdev *netdev)
1762 return netdev->change_seq;