2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2016 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
22 #include <netinet/in.h>
29 #include "dp-packet.h"
30 #include "dynamic-string.h"
31 #include "fatal-signal.h"
34 #include "netdev-dpdk.h"
35 #include "netdev-provider.h"
36 #include "netdev-vport.h"
37 #include "odp-netlink.h"
38 #include "openflow/openflow.h"
40 #include "poll-loop.h"
46 #include "openvswitch/vlog.h"
49 VLOG_DEFINE_THIS_MODULE(netdev);
51 COVERAGE_DEFINE(netdev_received);
52 COVERAGE_DEFINE(netdev_sent);
53 COVERAGE_DEFINE(netdev_add_router);
54 COVERAGE_DEFINE(netdev_get_stats);
56 struct netdev_saved_flags {
57 struct netdev *netdev;
58 struct ovs_list node; /* In struct netdev's saved_flags_list. */
59 enum netdev_flags saved_flags;
60 enum netdev_flags saved_values;
63 /* Protects 'netdev_shash' and the mutable members of struct netdev. */
64 static struct ovs_mutex netdev_mutex = OVS_MUTEX_INITIALIZER;
66 /* All created network devices. */
67 static struct shash netdev_shash OVS_GUARDED_BY(netdev_mutex)
68 = SHASH_INITIALIZER(&netdev_shash);
70 /* Protects 'netdev_classes' against insertions or deletions.
72 * This is a recursive mutex to allow recursive acquisition when calling into
73 * providers. For example, netdev_run() calls into provider 'run' functions,
74 * which might reasonably want to call one of the netdev functions that takes
75 * netdev_class_mutex. */
76 static struct ovs_mutex netdev_class_mutex OVS_ACQ_BEFORE(netdev_mutex);
78 /* Contains 'struct netdev_registered_class'es. */
79 static struct hmap netdev_classes OVS_GUARDED_BY(netdev_class_mutex)
80 = HMAP_INITIALIZER(&netdev_classes);
82 struct netdev_registered_class {
83 /* In 'netdev_classes', by class->type. */
84 struct hmap_node hmap_node OVS_GUARDED_BY(netdev_class_mutex);
85 const struct netdev_class *class OVS_GUARDED_BY(netdev_class_mutex);
86 /* Number of 'struct netdev's of this class. */
87 int ref_cnt OVS_GUARDED_BY(netdev_class_mutex);
90 /* This is set pretty low because we probably won't learn anything from the
91 * additional log messages. */
92 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
94 static void restore_all_flags(void *aux OVS_UNUSED);
95 void update_device_args(struct netdev *, const struct shash *args);
98 netdev_n_txq(const struct netdev *netdev)
100 return netdev->n_txq;
104 netdev_n_rxq(const struct netdev *netdev)
106 return netdev->n_rxq;
110 netdev_requested_n_rxq(const struct netdev *netdev)
112 return netdev->requested_n_rxq;
116 netdev_is_pmd(const struct netdev *netdev)
118 return (!strcmp(netdev->netdev_class->type, "dpdk") ||
119 !strcmp(netdev->netdev_class->type, "dpdkr") ||
120 !strcmp(netdev->netdev_class->type, "dpdkvhostcuse") ||
121 !strcmp(netdev->netdev_class->type, "dpdkvhostuser"));
125 netdev_class_mutex_initialize(void)
126 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
128 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
130 if (ovsthread_once_start(&once)) {
131 ovs_mutex_init_recursive(&netdev_class_mutex);
132 ovsthread_once_done(&once);
137 netdev_initialize(void)
138 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
140 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
142 if (ovsthread_once_start(&once)) {
143 netdev_class_mutex_initialize();
145 fatal_signal_add_hook(restore_all_flags, NULL, NULL, true);
146 netdev_vport_patch_register();
149 netdev_register_provider(&netdev_linux_class);
150 netdev_register_provider(&netdev_internal_class);
151 netdev_register_provider(&netdev_tap_class);
152 netdev_vport_tunnel_register();
154 #if defined(__FreeBSD__) || defined(__NetBSD__)
155 netdev_register_provider(&netdev_tap_class);
156 netdev_register_provider(&netdev_bsd_class);
159 netdev_register_provider(&netdev_windows_class);
160 netdev_register_provider(&netdev_internal_class);
161 netdev_vport_tunnel_register();
163 netdev_dpdk_register();
165 ovsthread_once_done(&once);
169 /* Performs periodic work needed by all the various kinds of netdevs.
171 * If your program opens any netdevs, it must call this function within its
175 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
177 struct netdev_registered_class *rc;
180 ovs_mutex_lock(&netdev_class_mutex);
181 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
182 if (rc->class->run) {
186 ovs_mutex_unlock(&netdev_class_mutex);
189 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
191 * If your program opens any netdevs, it must call this function within its
195 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
197 struct netdev_registered_class *rc;
199 ovs_mutex_lock(&netdev_class_mutex);
200 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
201 if (rc->class->wait) {
205 ovs_mutex_unlock(&netdev_class_mutex);
208 static struct netdev_registered_class *
209 netdev_lookup_class(const char *type)
210 OVS_REQ_RDLOCK(netdev_class_mutex)
212 struct netdev_registered_class *rc;
214 HMAP_FOR_EACH_WITH_HASH (rc, hmap_node, hash_string(type, 0),
216 if (!strcmp(type, rc->class->type)) {
223 /* Initializes and registers a new netdev provider. After successful
224 * registration, new netdevs of that type can be opened using netdev_open(). */
226 netdev_register_provider(const struct netdev_class *new_class)
227 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
231 netdev_class_mutex_initialize();
232 ovs_mutex_lock(&netdev_class_mutex);
233 if (netdev_lookup_class(new_class->type)) {
234 VLOG_WARN("attempted to register duplicate netdev provider: %s",
238 error = new_class->init ? new_class->init() : 0;
240 struct netdev_registered_class *rc;
242 rc = xmalloc(sizeof *rc);
243 hmap_insert(&netdev_classes, &rc->hmap_node,
244 hash_string(new_class->type, 0));
245 rc->class = new_class;
248 VLOG_ERR("failed to initialize %s network device class: %s",
249 new_class->type, ovs_strerror(error));
252 ovs_mutex_unlock(&netdev_class_mutex);
257 /* Unregisters a netdev provider. 'type' must have been previously
258 * registered and not currently be in use by any netdevs. After unregistration
259 * new netdevs of that type cannot be opened using netdev_open(). */
261 netdev_unregister_provider(const char *type)
262 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
264 struct netdev_registered_class *rc;
269 ovs_mutex_lock(&netdev_class_mutex);
270 rc = netdev_lookup_class(type);
272 VLOG_WARN("attempted to unregister a netdev provider that is not "
273 "registered: %s", type);
274 error = EAFNOSUPPORT;
277 hmap_remove(&netdev_classes, &rc->hmap_node);
281 VLOG_WARN("attempted to unregister in use netdev provider: %s",
286 ovs_mutex_unlock(&netdev_class_mutex);
291 /* Clears 'types' and enumerates the types of all currently registered netdev
292 * providers into it. The caller must first initialize the sset. */
294 netdev_enumerate_types(struct sset *types)
295 OVS_EXCLUDED(netdev_mutex)
297 struct netdev_registered_class *rc;
302 ovs_mutex_lock(&netdev_class_mutex);
303 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
304 sset_add(types, rc->class->type);
306 ovs_mutex_unlock(&netdev_class_mutex);
309 /* Check that the network device name is not the same as any of the registered
310 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
311 * does not define it) or the datapath internal port name (e.g. ovs-system).
313 * Returns true if there is a name conflict, false otherwise. */
315 netdev_is_reserved_name(const char *name)
316 OVS_EXCLUDED(netdev_mutex)
318 struct netdev_registered_class *rc;
322 ovs_mutex_lock(&netdev_class_mutex);
323 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
324 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
325 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
326 ovs_mutex_unlock(&netdev_class_mutex);
330 ovs_mutex_unlock(&netdev_class_mutex);
332 if (!strncmp(name, "ovs-", 4)) {
337 dp_enumerate_types(&types);
338 SSET_FOR_EACH (type, &types) {
339 if (!strcmp(name+4, type)) {
340 sset_destroy(&types);
344 sset_destroy(&types);
350 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
351 * (e.g. "system") and returns zero if successful, otherwise a positive errno
352 * value. On success, sets '*netdevp' to the new network device, otherwise to
355 * Some network devices may need to be configured (with netdev_set_config())
356 * before they can be used. */
358 netdev_open(const char *name, const char *type, struct netdev **netdevp)
359 OVS_EXCLUDED(netdev_mutex)
361 struct netdev *netdev;
366 ovs_mutex_lock(&netdev_class_mutex);
367 ovs_mutex_lock(&netdev_mutex);
368 netdev = shash_find_data(&netdev_shash, name);
370 struct netdev_registered_class *rc;
372 rc = netdev_lookup_class(type && type[0] ? type : "system");
374 netdev = rc->class->alloc();
376 memset(netdev, 0, sizeof *netdev);
377 netdev->netdev_class = rc->class;
378 netdev->name = xstrdup(name);
379 netdev->change_seq = 1;
380 netdev->node = shash_add(&netdev_shash, name, netdev);
382 /* By default enable one tx and rx queue per netdev. */
383 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
384 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
385 netdev->requested_n_rxq = netdev->n_rxq;
387 list_init(&netdev->saved_flags_list);
389 error = rc->class->construct(netdev);
392 netdev_change_seq_changed(netdev);
395 ovs_assert(list_is_empty(&netdev->saved_flags_list));
396 shash_delete(&netdev_shash, netdev->node);
397 rc->class->dealloc(netdev);
403 VLOG_WARN("could not create netdev %s of unknown type %s",
405 error = EAFNOSUPPORT;
417 ovs_mutex_unlock(&netdev_mutex);
418 ovs_mutex_unlock(&netdev_class_mutex);
423 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
424 * 'netdev_' is null. */
426 netdev_ref(const struct netdev *netdev_)
427 OVS_EXCLUDED(netdev_mutex)
429 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
432 ovs_mutex_lock(&netdev_mutex);
433 ovs_assert(netdev->ref_cnt > 0);
435 ovs_mutex_unlock(&netdev_mutex);
440 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
441 * or NULL if none are needed. */
443 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
444 OVS_EXCLUDED(netdev_mutex)
446 if (netdev->netdev_class->set_config) {
447 const struct smap no_args = SMAP_INITIALIZER(&no_args);
450 error = netdev->netdev_class->set_config(netdev,
451 args ? args : &no_args);
453 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
454 netdev_get_name(netdev), ovs_strerror(error));
457 } else if (args && !smap_is_empty(args)) {
458 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
459 netdev_get_name(netdev));
464 /* Returns the current configuration for 'netdev' in 'args'. The caller must
465 * have already initialized 'args' with smap_init(). Returns 0 on success, in
466 * which case 'args' will be filled with 'netdev''s configuration. On failure
467 * returns a positive errno value, in which case 'args' will be empty.
469 * The caller owns 'args' and its contents and must eventually free them with
472 netdev_get_config(const struct netdev *netdev, struct smap *args)
473 OVS_EXCLUDED(netdev_mutex)
478 if (netdev->netdev_class->get_config) {
479 error = netdev->netdev_class->get_config(netdev, args);
490 const struct netdev_tunnel_config *
491 netdev_get_tunnel_config(const struct netdev *netdev)
492 OVS_EXCLUDED(netdev_mutex)
494 if (netdev->netdev_class->get_tunnel_config) {
495 return netdev->netdev_class->get_tunnel_config(netdev);
501 /* Returns the id of the numa node the 'netdev' is on. If the function
502 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
504 netdev_get_numa_id(const struct netdev *netdev)
506 if (netdev->netdev_class->get_numa_id) {
507 return netdev->netdev_class->get_numa_id(netdev);
509 return NETDEV_NUMA_UNSPEC;
514 netdev_unref(struct netdev *dev)
515 OVS_RELEASES(netdev_mutex)
517 ovs_assert(dev->ref_cnt);
518 if (!--dev->ref_cnt) {
519 const struct netdev_class *class = dev->netdev_class;
520 struct netdev_registered_class *rc;
522 dev->netdev_class->destruct(dev);
525 shash_delete(&netdev_shash, dev->node);
528 dev->netdev_class->dealloc(dev);
529 ovs_mutex_unlock(&netdev_mutex);
531 ovs_mutex_lock(&netdev_class_mutex);
532 rc = netdev_lookup_class(class->type);
533 ovs_assert(rc->ref_cnt > 0);
535 ovs_mutex_unlock(&netdev_class_mutex);
537 ovs_mutex_unlock(&netdev_mutex);
541 /* Closes and destroys 'netdev'. */
543 netdev_close(struct netdev *netdev)
544 OVS_EXCLUDED(netdev_mutex)
547 ovs_mutex_lock(&netdev_mutex);
548 netdev_unref(netdev);
552 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
554 * This allows handler and revalidator threads to still retain references
555 * to this netdev while the main thread changes interface configuration.
557 * This function should only be called by the main thread when closing
558 * netdevs during user configuration changes. Otherwise, netdev_close should be
559 * used to close netdevs. */
561 netdev_remove(struct netdev *netdev)
564 ovs_mutex_lock(&netdev_mutex);
566 shash_delete(&netdev_shash, netdev->node);
568 netdev_change_seq_changed(netdev);
570 netdev_unref(netdev);
574 /* Parses 'netdev_name_', which is of the form [type@]name into its component
575 * pieces. 'name' and 'type' must be freed by the caller. */
577 netdev_parse_name(const char *netdev_name_, char **name, char **type)
579 char *netdev_name = xstrdup(netdev_name_);
582 separator = strchr(netdev_name, '@');
586 *name = xstrdup(separator + 1);
589 *type = xstrdup("system");
593 /* Attempts to open a netdev_rxq handle for obtaining packets received on
594 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
595 * '*rxp'. On failure, returns a positive errno value and stores NULL into
598 * Some kinds of network devices might not support receiving packets. This
599 * function returns EOPNOTSUPP in that case.*/
601 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
602 OVS_EXCLUDED(netdev_mutex)
606 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
607 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
611 error = netdev->netdev_class->rxq_construct(rx);
617 netdev->netdev_class->rxq_dealloc(rx);
631 netdev_rxq_close(struct netdev_rxq *rx)
632 OVS_EXCLUDED(netdev_mutex)
635 struct netdev *netdev = rx->netdev;
636 netdev->netdev_class->rxq_destruct(rx);
637 netdev->netdev_class->rxq_dealloc(rx);
638 netdev_close(netdev);
642 /* Attempts to receive batch of packets from 'rx'.
644 * Returns EAGAIN immediately if no packet is ready to be received.
646 * Returns EMSGSIZE, and discards the packet, if the received packet is longer
647 * than 'dp_packet_tailroom(buffer)'.
649 * It is advised that the tailroom of 'buffer' should be
650 * VLAN_HEADER_LEN bytes longer than the MTU to allow space for an
651 * out-of-band VLAN header to be added to the packet. At the very least,
652 * 'buffer' must have at least ETH_TOTAL_MIN bytes of tailroom.
654 * This function may be set to null if it would always return EOPNOTSUPP
657 netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet **buffers, int *cnt)
661 retval = rx->netdev->netdev_class->rxq_recv(rx, buffers, cnt);
663 COVERAGE_INC(netdev_received);
668 /* Arranges for poll_block() to wake up when a packet is ready to be received
671 netdev_rxq_wait(struct netdev_rxq *rx)
673 rx->netdev->netdev_class->rxq_wait(rx);
676 /* Discards any packets ready to be received on 'rx'. */
678 netdev_rxq_drain(struct netdev_rxq *rx)
680 return (rx->netdev->netdev_class->rxq_drain
681 ? rx->netdev->netdev_class->rxq_drain(rx)
685 /* Configures the number of tx queues and rx queues of 'netdev'.
686 * Return 0 if successful, otherwise a positive errno value.
688 * 'n_rxq' specifies the maximum number of receive queues to create.
689 * The netdev provider might choose to create less (e.g. if the hardware
690 * supports only a smaller number). The caller can check how many have been
691 * actually created by calling 'netdev_n_rxq()'
693 * 'n_txq' specifies the exact number of transmission queues to create.
694 * If this function returns successfully, the caller can make 'n_txq'
695 * concurrent calls to netdev_send() (each one with a different 'qid' in the
696 * range [0..'n_txq'-1]).
698 * On error, the tx queue and rx queue configuration is indeterminant.
699 * Caller should make decision on whether to restore the previous or
700 * the default configuration. Also, caller must make sure there is no
701 * other thread accessing the queues at the same time. */
703 netdev_set_multiq(struct netdev *netdev, unsigned int n_txq,
708 error = (netdev->netdev_class->set_multiq
709 ? netdev->netdev_class->set_multiq(netdev,
714 if (error && error != EOPNOTSUPP) {
715 VLOG_DBG_RL(&rl, "failed to set tx/rx queue for network device %s:"
716 "%s", netdev_get_name(netdev), ovs_strerror(error));
722 /* Sends 'buffers' on 'netdev'. Returns 0 if successful (for every packet),
723 * otherwise a positive errno value. Returns EAGAIN without blocking if
724 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
725 * if a partial packet was transmitted or if a packet is too big or too small
726 * to transmit on the device.
728 * If the function returns a non-zero value, some of the packets might have
731 * If 'may_steal' is false, the caller retains ownership of all the packets.
732 * If 'may_steal' is true, the caller transfers ownership of all the packets
733 * to the network device, regardless of success.
735 * The network device is expected to maintain one or more packet
736 * transmission queues, so that the caller does not ordinarily have to
737 * do additional queuing of packets. 'qid' specifies the queue to use
738 * and can be ignored if the implementation does not support multiple
741 * Some network devices may not implement support for this function. In such
742 * cases this function will always return EOPNOTSUPP. */
744 netdev_send(struct netdev *netdev, int qid, struct dp_packet **buffers,
745 int cnt, bool may_steal)
747 if (!netdev->netdev_class->send) {
749 for (int i = 0; i < cnt; i++) {
750 dp_packet_delete(buffers[i]);
756 int error = netdev->netdev_class->send(netdev, qid, buffers, cnt,
759 COVERAGE_INC(netdev_sent);
765 netdev_pop_header(struct netdev *netdev, struct dp_packet **buffers, int cnt)
769 if (!netdev->netdev_class->pop_header) {
773 for (i = 0; i < cnt; i++) {
776 err = netdev->netdev_class->pop_header(buffers[i]);
778 dp_packet_clear(buffers[i]);
786 netdev_build_header(const struct netdev *netdev, struct ovs_action_push_tnl *data,
787 const struct flow *tnl_flow)
789 if (netdev->netdev_class->build_header) {
790 return netdev->netdev_class->build_header(netdev, data, tnl_flow);
796 netdev_push_header(const struct netdev *netdev,
797 struct dp_packet **buffers, int cnt,
798 const struct ovs_action_push_tnl *data)
802 if (!netdev->netdev_class->push_header) {
806 for (i = 0; i < cnt; i++) {
807 netdev->netdev_class->push_header(buffers[i], data);
808 pkt_metadata_init(&buffers[i]->md, u32_to_odp(data->out_port));
814 /* Registers with the poll loop to wake up from the next call to poll_block()
815 * when the packet transmission queue has sufficient room to transmit a packet
816 * with netdev_send().
818 * The network device is expected to maintain one or more packet
819 * transmission queues, so that the caller does not ordinarily have to
820 * do additional queuing of packets. 'qid' specifies the queue to use
821 * and can be ignored if the implementation does not support multiple
824 netdev_send_wait(struct netdev *netdev, int qid)
826 if (netdev->netdev_class->send_wait) {
827 netdev->netdev_class->send_wait(netdev, qid);
831 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
832 * otherwise a positive errno value. */
834 netdev_set_etheraddr(struct netdev *netdev, const struct eth_addr mac)
836 return netdev->netdev_class->set_etheraddr(netdev, mac);
839 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
840 * the MAC address into 'mac'. On failure, returns a positive errno value and
841 * clears 'mac' to all-zeros. */
843 netdev_get_etheraddr(const struct netdev *netdev, struct eth_addr *mac)
845 return netdev->netdev_class->get_etheraddr(netdev, mac);
848 /* Returns the name of the network device that 'netdev' represents,
849 * e.g. "eth0". The caller must not modify or free the returned string. */
851 netdev_get_name(const struct netdev *netdev)
856 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
857 * (and received) packets, in bytes, not including the hardware header; thus,
858 * this is typically 1500 bytes for Ethernet devices.
860 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
861 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
862 * On other failure, returns a positive errno value. On failure, sets '*mtup'
865 netdev_get_mtu(const struct netdev *netdev, int *mtup)
867 const struct netdev_class *class = netdev->netdev_class;
870 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
873 if (error != EOPNOTSUPP) {
874 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
875 "%s", netdev_get_name(netdev), ovs_strerror(error));
881 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
882 * (and received) packets, in bytes.
884 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
885 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
888 netdev_set_mtu(const struct netdev *netdev, int mtu)
890 const struct netdev_class *class = netdev->netdev_class;
893 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
894 if (error && error != EOPNOTSUPP) {
895 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
896 netdev_get_name(netdev), ovs_strerror(error));
902 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
903 * failure, returns a negative errno value.
905 * The desired semantics of the ifindex value are a combination of those
906 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
907 * value should be unique within a host and remain stable at least until
908 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
909 * but many systems do not follow this rule anyhow.
911 * Some network devices may not implement support for this function. In such
912 * cases this function will always return -EOPNOTSUPP.
915 netdev_get_ifindex(const struct netdev *netdev)
917 int (*get_ifindex)(const struct netdev *);
919 get_ifindex = netdev->netdev_class->get_ifindex;
921 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
924 /* Stores the features supported by 'netdev' into each of '*current',
925 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
926 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
927 * successful, otherwise a positive errno value. On failure, all of the
928 * passed-in values are set to 0.
930 * Some network devices may not implement support for this function. In such
931 * cases this function will always return EOPNOTSUPP. */
933 netdev_get_features(const struct netdev *netdev,
934 enum netdev_features *current,
935 enum netdev_features *advertised,
936 enum netdev_features *supported,
937 enum netdev_features *peer)
939 int (*get_features)(const struct netdev *netdev,
940 enum netdev_features *current,
941 enum netdev_features *advertised,
942 enum netdev_features *supported,
943 enum netdev_features *peer);
944 enum netdev_features dummy[4];
951 advertised = &dummy[1];
954 supported = &dummy[2];
960 get_features = netdev->netdev_class->get_features;
962 ? get_features(netdev, current, advertised, supported,
966 *current = *advertised = *supported = *peer = 0;
971 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
972 * bits in 'features', in bits per second. If no bits that indicate a speed
973 * are set in 'features', returns 'default_bps'. */
975 netdev_features_to_bps(enum netdev_features features,
976 uint64_t default_bps)
979 F_1000000MB = NETDEV_F_1TB_FD,
980 F_100000MB = NETDEV_F_100GB_FD,
981 F_40000MB = NETDEV_F_40GB_FD,
982 F_10000MB = NETDEV_F_10GB_FD,
983 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
984 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
985 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
988 return ( features & F_1000000MB ? UINT64_C(1000000000000)
989 : features & F_100000MB ? UINT64_C(100000000000)
990 : features & F_40000MB ? UINT64_C(40000000000)
991 : features & F_10000MB ? UINT64_C(10000000000)
992 : features & F_1000MB ? UINT64_C(1000000000)
993 : features & F_100MB ? UINT64_C(100000000)
994 : features & F_10MB ? UINT64_C(10000000)
998 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
999 * are set in 'features', otherwise false. */
1001 netdev_features_is_full_duplex(enum netdev_features features)
1003 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
1004 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
1005 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
1008 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
1009 * successful, otherwise a positive errno value. */
1011 netdev_set_advertisements(struct netdev *netdev,
1012 enum netdev_features advertise)
1014 return (netdev->netdev_class->set_advertisements
1015 ? netdev->netdev_class->set_advertisements(
1020 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
1021 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
1022 * errno value and sets '*address' to 0 (INADDR_ANY).
1024 * The following error values have well-defined meanings:
1026 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
1028 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
1030 * 'address' or 'netmask' or both may be null, in which case the address or
1031 * netmask is not reported. */
1033 netdev_get_in4(const struct netdev *netdev,
1034 struct in_addr *address_, struct in_addr *netmask_)
1036 struct in_addr address;
1037 struct in_addr netmask;
1040 error = (netdev->netdev_class->get_in4
1041 ? netdev->netdev_class->get_in4(netdev,
1045 address_->s_addr = error ? 0 : address.s_addr;
1048 netmask_->s_addr = error ? 0 : netmask.s_addr;
1053 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
1054 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
1055 * positive errno value. */
1057 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
1059 return (netdev->netdev_class->set_in4
1060 ? netdev->netdev_class->set_in4(netdev, addr, mask)
1064 /* Obtains ad IPv4 address from device name and save the address in
1065 * in4. Returns 0 if successful, otherwise a positive errno value.
1068 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
1070 struct netdev *netdev;
1073 error = netdev_open(device_name, "system", &netdev);
1075 in4->s_addr = htonl(0);
1079 error = netdev_get_in4(netdev, in4, NULL);
1080 netdev_close(netdev);
1084 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1087 netdev_add_router(struct netdev *netdev, struct in_addr router)
1089 COVERAGE_INC(netdev_add_router);
1090 return (netdev->netdev_class->add_router
1091 ? netdev->netdev_class->add_router(netdev, router)
1095 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1096 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1097 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1098 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1099 * a directly connected network) in '*next_hop' and a copy of the name of the
1100 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1101 * responsible for freeing '*netdev_name' (by calling free()). */
1103 netdev_get_next_hop(const struct netdev *netdev,
1104 const struct in_addr *host, struct in_addr *next_hop,
1107 int error = (netdev->netdev_class->get_next_hop
1108 ? netdev->netdev_class->get_next_hop(
1109 host, next_hop, netdev_name)
1112 next_hop->s_addr = 0;
1113 *netdev_name = NULL;
1118 /* Populates 'smap' with status information.
1120 * Populates 'smap' with 'netdev' specific status information. This
1121 * information may be used to populate the status column of the Interface table
1122 * as defined in ovs-vswitchd.conf.db(5). */
1124 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1126 return (netdev->netdev_class->get_status
1127 ? netdev->netdev_class->get_status(netdev, smap)
1131 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
1132 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
1133 * all-zero-bits (in6addr_any).
1135 * The following error values have well-defined meanings:
1137 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1139 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1141 * 'in6' may be null, in which case the address itself is not reported. */
1143 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
1145 struct in6_addr dummy;
1148 error = (netdev->netdev_class->get_in6
1149 ? netdev->netdev_class->get_in6(netdev,
1153 memset(in6, 0, sizeof *in6);
1158 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1159 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1161 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1162 enum netdev_flags on, enum netdev_flags *old_flagsp,
1163 struct netdev_saved_flags **sfp)
1164 OVS_EXCLUDED(netdev_mutex)
1166 struct netdev_saved_flags *sf = NULL;
1167 enum netdev_flags old_flags;
1170 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1173 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1174 off || on ? "set" : "get", netdev_get_name(netdev),
1175 ovs_strerror(error));
1177 } else if ((off || on) && sfp) {
1178 enum netdev_flags new_flags = (old_flags & ~off) | on;
1179 enum netdev_flags changed_flags = old_flags ^ new_flags;
1180 if (changed_flags) {
1181 ovs_mutex_lock(&netdev_mutex);
1182 *sfp = sf = xmalloc(sizeof *sf);
1183 sf->netdev = netdev;
1184 list_push_front(&netdev->saved_flags_list, &sf->node);
1185 sf->saved_flags = changed_flags;
1186 sf->saved_values = changed_flags & new_flags;
1189 ovs_mutex_unlock(&netdev_mutex);
1194 *old_flagsp = old_flags;
1203 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1204 * Returns 0 if successful, otherwise a positive errno value. On failure,
1205 * stores 0 into '*flagsp'. */
1207 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1209 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1210 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1213 /* Sets the flags for 'netdev' to 'flags'.
1214 * Returns 0 if successful, otherwise a positive errno value. */
1216 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1217 struct netdev_saved_flags **sfp)
1219 return do_update_flags(netdev, -1, flags, NULL, sfp);
1222 /* Turns on the specified 'flags' on 'netdev':
1224 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1225 * allocated 'struct netdev_saved_flags *' that may be passed to
1226 * netdev_restore_flags() to restore the original values of 'flags' on
1227 * 'netdev' (this will happen automatically at program termination if
1228 * netdev_restore_flags() is never called) , or to NULL if no flags were
1231 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1232 * '*sfp' to NULL. */
1234 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1235 struct netdev_saved_flags **sfp)
1237 return do_update_flags(netdev, 0, flags, NULL, sfp);
1240 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1241 * details of the interface. */
1243 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1244 struct netdev_saved_flags **sfp)
1246 return do_update_flags(netdev, flags, 0, NULL, sfp);
1249 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1250 * Does nothing if 'sf' is NULL. */
1252 netdev_restore_flags(struct netdev_saved_flags *sf)
1253 OVS_EXCLUDED(netdev_mutex)
1256 struct netdev *netdev = sf->netdev;
1257 enum netdev_flags old_flags;
1259 netdev->netdev_class->update_flags(netdev,
1260 sf->saved_flags & sf->saved_values,
1261 sf->saved_flags & ~sf->saved_values,
1264 ovs_mutex_lock(&netdev_mutex);
1265 list_remove(&sf->node);
1267 netdev_unref(netdev);
1271 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1272 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1273 * returns 0. Otherwise, it returns a positive errno value; in particular,
1274 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1276 netdev_arp_lookup(const struct netdev *netdev,
1277 ovs_be32 ip, struct eth_addr *mac)
1279 int error = (netdev->netdev_class->arp_lookup
1280 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1283 *mac = eth_addr_zero;
1288 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1290 netdev_get_carrier(const struct netdev *netdev)
1293 enum netdev_flags flags;
1296 netdev_get_flags(netdev, &flags);
1297 if (!(flags & NETDEV_UP)) {
1301 if (!netdev->netdev_class->get_carrier) {
1305 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1307 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1308 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1315 /* Returns the number of times 'netdev''s carrier has changed. */
1317 netdev_get_carrier_resets(const struct netdev *netdev)
1319 return (netdev->netdev_class->get_carrier_resets
1320 ? netdev->netdev_class->get_carrier_resets(netdev)
1324 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1325 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1326 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1327 * does not support MII, another method may be used as a fallback. If
1328 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1329 * its normal behavior.
1331 * Returns 0 if successful, otherwise a positive errno value. */
1333 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1335 return (netdev->netdev_class->set_miimon_interval
1336 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1340 /* Retrieves current device stats for 'netdev'. */
1342 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1346 COVERAGE_INC(netdev_get_stats);
1347 error = (netdev->netdev_class->get_stats
1348 ? netdev->netdev_class->get_stats(netdev, stats)
1351 memset(stats, 0xff, sizeof *stats);
1356 /* Attempts to set input rate limiting (policing) policy, such that up to
1357 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1358 * size of 'kbits' kb. */
1360 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1361 uint32_t kbits_burst)
1363 return (netdev->netdev_class->set_policing
1364 ? netdev->netdev_class->set_policing(netdev,
1365 kbits_rate, kbits_burst)
1369 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1370 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1371 * be documented as valid for the "type" column in the "QoS" table in
1372 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1374 * Every network device supports disabling QoS with a type of "", but this type
1375 * will not be added to 'types'.
1377 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1378 * this function. The caller is responsible for destroying 'types' (e.g. with
1379 * sset_destroy()) when it is no longer needed.
1381 * Returns 0 if successful, otherwise a positive errno value. */
1383 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1385 const struct netdev_class *class = netdev->netdev_class;
1386 return (class->get_qos_types
1387 ? class->get_qos_types(netdev, types)
1391 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1392 * which should be "" or one of the types returned by netdev_get_qos_types()
1393 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1394 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1395 * 'caps' to all zeros. */
1397 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1398 struct netdev_qos_capabilities *caps)
1400 const struct netdev_class *class = netdev->netdev_class;
1403 int retval = (class->get_qos_capabilities
1404 ? class->get_qos_capabilities(netdev, type, caps)
1407 memset(caps, 0, sizeof *caps);
1411 /* Every netdev supports turning off QoS. */
1412 memset(caps, 0, sizeof *caps);
1417 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1418 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1419 * the number of queues (zero on failure) in '*n_queuesp'.
1421 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1423 netdev_get_n_queues(const struct netdev *netdev,
1424 const char *type, unsigned int *n_queuesp)
1426 struct netdev_qos_capabilities caps;
1429 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1430 *n_queuesp = caps.n_queues;
1434 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1435 * stores the name of the current form of QoS into '*typep', stores any details
1436 * of configuration as string key-value pairs in 'details', and returns 0. On
1437 * failure, sets '*typep' to NULL and returns a positive errno value.
1439 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1441 * The caller must initialize 'details' as an empty smap (e.g. with
1442 * smap_init()) before calling this function. The caller must free 'details'
1443 * when it is no longer needed (e.g. with smap_destroy()).
1445 * The caller must not modify or free '*typep'.
1447 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1448 * 'netdev'. The contents of 'details' should be documented as valid for
1449 * '*typep' in the "other_config" column in the "QoS" table in
1450 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1452 netdev_get_qos(const struct netdev *netdev,
1453 const char **typep, struct smap *details)
1455 const struct netdev_class *class = netdev->netdev_class;
1458 if (class->get_qos) {
1459 retval = class->get_qos(netdev, typep, details);
1462 smap_clear(details);
1466 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1472 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1473 * with details of configuration from 'details'. Returns 0 if successful,
1474 * otherwise a positive errno value. On error, the previous QoS configuration
1477 * When this function changes the type of QoS (not just 'details'), this also
1478 * resets all queue configuration for 'netdev' to their defaults (which depend
1479 * on the specific type of QoS). Otherwise, the queue configuration for
1480 * 'netdev' is unchanged.
1482 * 'type' should be "" (to disable QoS) or one of the types returned by
1483 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1484 * documented as valid for the given 'type' in the "other_config" column in the
1485 * "QoS" table in vswitchd/vswitch.xml (which is built as
1486 * ovs-vswitchd.conf.db(8)).
1488 * NULL may be specified for 'details' if there are no configuration
1491 netdev_set_qos(struct netdev *netdev,
1492 const char *type, const struct smap *details)
1494 const struct netdev_class *class = netdev->netdev_class;
1500 if (class->set_qos) {
1502 static const struct smap empty = SMAP_INITIALIZER(&empty);
1505 return class->set_qos(netdev, type, details);
1507 return *type ? EOPNOTSUPP : 0;
1511 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1512 * successful, adds that information as string key-value pairs to 'details'.
1513 * Returns 0 if successful, otherwise a positive errno value.
1515 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1516 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1518 * The returned contents of 'details' should be documented as valid for the
1519 * given 'type' in the "other_config" column in the "Queue" table in
1520 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1522 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1523 * this function. The caller must free 'details' when it is no longer needed
1524 * (e.g. with smap_destroy()). */
1526 netdev_get_queue(const struct netdev *netdev,
1527 unsigned int queue_id, struct smap *details)
1529 const struct netdev_class *class = netdev->netdev_class;
1532 retval = (class->get_queue
1533 ? class->get_queue(netdev, queue_id, details)
1536 smap_clear(details);
1541 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1542 * string pairs in 'details'. The contents of 'details' should be documented
1543 * as valid for the given 'type' in the "other_config" column in the "Queue"
1544 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1545 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1546 * given queue's configuration should be unmodified.
1548 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1549 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1551 * This function does not modify 'details', and the caller retains ownership of
1554 netdev_set_queue(struct netdev *netdev,
1555 unsigned int queue_id, const struct smap *details)
1557 const struct netdev_class *class = netdev->netdev_class;
1558 return (class->set_queue
1559 ? class->set_queue(netdev, queue_id, details)
1563 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1564 * of QoS may have a fixed set of queues, in which case attempts to delete them
1565 * will fail with EOPNOTSUPP.
1567 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1568 * given queue will be unmodified.
1570 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1571 * the current form of QoS (e.g. as returned by
1572 * netdev_get_n_queues(netdev)). */
1574 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1576 const struct netdev_class *class = netdev->netdev_class;
1577 return (class->delete_queue
1578 ? class->delete_queue(netdev, queue_id)
1582 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1583 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1584 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1585 * positive errno value and fills 'stats' with values indicating unsupported
1588 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1589 struct netdev_queue_stats *stats)
1591 const struct netdev_class *class = netdev->netdev_class;
1594 retval = (class->get_queue_stats
1595 ? class->get_queue_stats(netdev, queue_id, stats)
1598 stats->tx_bytes = UINT64_MAX;
1599 stats->tx_packets = UINT64_MAX;
1600 stats->tx_errors = UINT64_MAX;
1601 stats->created = LLONG_MIN;
1606 /* Initializes 'dump' to begin dumping the queues in a netdev.
1608 * This function provides no status indication. An error status for the entire
1609 * dump operation is provided when it is completed by calling
1610 * netdev_queue_dump_done().
1613 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1614 const struct netdev *netdev)
1616 dump->netdev = netdev_ref(netdev);
1617 if (netdev->netdev_class->queue_dump_start) {
1618 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1621 dump->error = EOPNOTSUPP;
1625 /* Attempts to retrieve another queue from 'dump', which must have been
1626 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1627 * ID into '*queue_id', fills 'details' with configuration details for the
1628 * queue, and returns true. On failure, returns false.
1630 * Queues are not necessarily dumped in increasing order of queue ID (or any
1631 * other predictable order).
1633 * Failure might indicate an actual error or merely that the last queue has
1634 * been dumped. An error status for the entire dump operation is provided when
1635 * it is completed by calling netdev_queue_dump_done().
1637 * The returned contents of 'details' should be documented as valid for the
1638 * given 'type' in the "other_config" column in the "Queue" table in
1639 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1641 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1642 * this function. This function will clear and replace its contents. The
1643 * caller must free 'details' when it is no longer needed (e.g. with
1644 * smap_destroy()). */
1646 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1647 unsigned int *queue_id, struct smap *details)
1649 const struct netdev *netdev = dump->netdev;
1655 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1659 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1665 /* Completes queue table dump operation 'dump', which must have been
1666 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1667 * was error-free, otherwise a positive errno value describing the problem. */
1669 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1671 const struct netdev *netdev = dump->netdev;
1672 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1673 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1676 netdev_close(dump->netdev);
1677 return dump->error == EOF ? 0 : dump->error;
1680 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1681 * its statistics, and the 'aux' specified by the caller. The order of
1682 * iteration is unspecified, but (when successful) each queue is visited
1685 * Calling this function may be more efficient than calling
1686 * netdev_get_queue_stats() for every queue.
1688 * 'cb' must not modify or free the statistics passed in.
1690 * Returns 0 if successful, otherwise a positive errno value. On error, some
1691 * configured queues may not have been included in the iteration. */
1693 netdev_dump_queue_stats(const struct netdev *netdev,
1694 netdev_dump_queue_stats_cb *cb, void *aux)
1696 const struct netdev_class *class = netdev->netdev_class;
1697 return (class->dump_queue_stats
1698 ? class->dump_queue_stats(netdev, cb, aux)
1703 /* Returns the class type of 'netdev'.
1705 * The caller must not free the returned value. */
1707 netdev_get_type(const struct netdev *netdev)
1709 return netdev->netdev_class->type;
1712 /* Returns the class associated with 'netdev'. */
1713 const struct netdev_class *
1714 netdev_get_class(const struct netdev *netdev)
1716 return netdev->netdev_class;
1719 /* Returns the netdev with 'name' or NULL if there is none.
1721 * The caller must free the returned netdev with netdev_close(). */
1723 netdev_from_name(const char *name)
1724 OVS_EXCLUDED(netdev_mutex)
1726 struct netdev *netdev;
1728 ovs_mutex_lock(&netdev_mutex);
1729 netdev = shash_find_data(&netdev_shash, name);
1733 ovs_mutex_unlock(&netdev_mutex);
1738 /* Fills 'device_list' with devices that match 'netdev_class'.
1740 * The caller is responsible for initializing and destroying 'device_list' and
1741 * must close each device on the list. */
1743 netdev_get_devices(const struct netdev_class *netdev_class,
1744 struct shash *device_list)
1745 OVS_EXCLUDED(netdev_mutex)
1747 struct shash_node *node;
1749 ovs_mutex_lock(&netdev_mutex);
1750 SHASH_FOR_EACH (node, &netdev_shash) {
1751 struct netdev *dev = node->data;
1753 if (dev->netdev_class == netdev_class) {
1755 shash_add(device_list, node->name, node->data);
1758 ovs_mutex_unlock(&netdev_mutex);
1761 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1762 * and returns it. Stores the size of the array into '*size'.
1764 * The caller is responsible for freeing 'vports' and must close
1765 * each 'netdev-vport' in the list. */
1767 netdev_get_vports(size_t *size)
1768 OVS_EXCLUDED(netdev_mutex)
1770 struct netdev **vports;
1771 struct shash_node *node;
1778 /* Explicitly allocates big enough chunk of memory. */
1779 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1780 ovs_mutex_lock(&netdev_mutex);
1781 SHASH_FOR_EACH (node, &netdev_shash) {
1782 struct netdev *dev = node->data;
1784 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1790 ovs_mutex_unlock(&netdev_mutex);
1797 netdev_get_type_from_name(const char *name)
1799 struct netdev *dev = netdev_from_name(name);
1800 const char *type = dev ? netdev_get_type(dev) : NULL;
1806 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1808 ovs_assert(rx->netdev->ref_cnt > 0);
1813 netdev_rxq_get_name(const struct netdev_rxq *rx)
1815 return netdev_get_name(netdev_rxq_get_netdev(rx));
1819 netdev_rxq_get_queue_id(const struct netdev_rxq *rx)
1821 return rx->queue_id;
1825 restore_all_flags(void *aux OVS_UNUSED)
1827 struct shash_node *node;
1829 SHASH_FOR_EACH (node, &netdev_shash) {
1830 struct netdev *netdev = node->data;
1831 const struct netdev_saved_flags *sf;
1832 enum netdev_flags saved_values;
1833 enum netdev_flags saved_flags;
1835 saved_values = saved_flags = 0;
1836 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1837 saved_flags |= sf->saved_flags;
1838 saved_values &= ~sf->saved_flags;
1839 saved_values |= sf->saved_flags & sf->saved_values;
1842 enum netdev_flags old_flags;
1844 netdev->netdev_class->update_flags(netdev,
1845 saved_flags & saved_values,
1846 saved_flags & ~saved_values,
1853 netdev_get_change_seq(const struct netdev *netdev)
1855 return netdev->change_seq;