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>
30 #include <sys/ioctl.h>
31 #include <sys/types.h>
37 #include "dp-packet.h"
38 #include "openvswitch/dynamic-string.h"
39 #include "fatal-signal.h"
41 #include "openvswitch/list.h"
42 #include "netdev-dpdk.h"
43 #include "netdev-provider.h"
44 #include "netdev-vport.h"
45 #include "odp-netlink.h"
46 #include "openflow/openflow.h"
48 #include "poll-loop.h"
50 #include "openvswitch/shash.h"
54 #include "openvswitch/vlog.h"
58 VLOG_DEFINE_THIS_MODULE(netdev);
60 COVERAGE_DEFINE(netdev_received);
61 COVERAGE_DEFINE(netdev_sent);
62 COVERAGE_DEFINE(netdev_add_router);
63 COVERAGE_DEFINE(netdev_get_stats);
65 struct netdev_saved_flags {
66 struct netdev *netdev;
67 struct ovs_list node; /* In struct netdev's saved_flags_list. */
68 enum netdev_flags saved_flags;
69 enum netdev_flags saved_values;
72 /* Protects 'netdev_shash' and the mutable members of struct netdev. */
73 static struct ovs_mutex netdev_mutex = OVS_MUTEX_INITIALIZER;
75 /* All created network devices. */
76 static struct shash netdev_shash OVS_GUARDED_BY(netdev_mutex)
77 = SHASH_INITIALIZER(&netdev_shash);
79 /* Mutual exclusion of */
80 static struct ovs_mutex netdev_class_mutex OVS_ACQ_BEFORE(netdev_mutex)
81 = OVS_MUTEX_INITIALIZER;
83 /* Contains 'struct netdev_registered_class'es. */
84 static struct cmap netdev_classes = CMAP_INITIALIZER;
86 struct netdev_registered_class {
87 struct cmap_node cmap_node; /* In 'netdev_classes', by class->type. */
88 const struct netdev_class *class;
90 /* Number of references: one for the class itself and one for every
91 * instance of the class. */
92 struct ovs_refcount refcnt;
95 /* This is set pretty low because we probably won't learn anything from the
96 * additional log messages. */
97 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
99 static void restore_all_flags(void *aux OVS_UNUSED);
100 void update_device_args(struct netdev *, const struct shash *args);
103 netdev_n_txq(const struct netdev *netdev)
105 return netdev->n_txq;
109 netdev_n_rxq(const struct netdev *netdev)
111 return netdev->n_rxq;
115 netdev_is_pmd(const struct netdev *netdev)
117 return netdev->netdev_class->is_pmd;
121 netdev_initialize(void)
122 OVS_EXCLUDED(netdev_mutex)
124 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
126 if (ovsthread_once_start(&once)) {
127 fatal_signal_add_hook(restore_all_flags, NULL, NULL, true);
129 netdev_vport_patch_register();
132 netdev_register_provider(&netdev_linux_class);
133 netdev_register_provider(&netdev_internal_class);
134 netdev_register_provider(&netdev_tap_class);
135 netdev_vport_tunnel_register();
137 #if defined(__FreeBSD__) || defined(__NetBSD__)
138 netdev_register_provider(&netdev_tap_class);
139 netdev_register_provider(&netdev_bsd_class);
142 netdev_register_provider(&netdev_windows_class);
143 netdev_register_provider(&netdev_internal_class);
144 netdev_vport_tunnel_register();
146 ovsthread_once_done(&once);
150 /* Performs periodic work needed by all the various kinds of netdevs.
152 * If your program opens any netdevs, it must call this function within its
156 OVS_EXCLUDED(netdev_mutex)
160 struct netdev_registered_class *rc;
161 CMAP_FOR_EACH (rc, cmap_node, &netdev_classes) {
162 if (rc->class->run) {
168 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
170 * If your program opens any netdevs, it must call this function within its
174 OVS_EXCLUDED(netdev_mutex)
178 struct netdev_registered_class *rc;
179 CMAP_FOR_EACH (rc, cmap_node, &netdev_classes) {
180 if (rc->class->wait) {
186 static struct netdev_registered_class *
187 netdev_lookup_class(const char *type)
189 struct netdev_registered_class *rc;
190 CMAP_FOR_EACH_WITH_HASH (rc, cmap_node, hash_string(type, 0),
192 if (!strcmp(type, rc->class->type)) {
199 /* Initializes and registers a new netdev provider. After successful
200 * registration, new netdevs of that type can be opened using netdev_open(). */
202 netdev_register_provider(const struct netdev_class *new_class)
203 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
207 ovs_mutex_lock(&netdev_class_mutex);
208 if (netdev_lookup_class(new_class->type)) {
209 VLOG_WARN("attempted to register duplicate netdev provider: %s",
213 error = new_class->init ? new_class->init() : 0;
215 struct netdev_registered_class *rc;
217 rc = xmalloc(sizeof *rc);
218 cmap_insert(&netdev_classes, &rc->cmap_node,
219 hash_string(new_class->type, 0));
220 rc->class = new_class;
221 ovs_refcount_init(&rc->refcnt);
223 VLOG_ERR("failed to initialize %s network device class: %s",
224 new_class->type, ovs_strerror(error));
227 ovs_mutex_unlock(&netdev_class_mutex);
232 /* Unregisters a netdev provider. 'type' must have been previously registered
233 * and not currently be in use by any netdevs. After unregistration new
234 * netdevs of that type cannot be opened using netdev_open(). (However, the
235 * provider may still be accessible from other threads until the next RCU grace
236 * period, so the caller must not free or re-register the same netdev_class
237 * until that has passed.) */
239 netdev_unregister_provider(const char *type)
240 OVS_EXCLUDED(netdev_class_mutex, netdev_mutex)
242 struct netdev_registered_class *rc;
247 ovs_mutex_lock(&netdev_class_mutex);
248 rc = netdev_lookup_class(type);
250 VLOG_WARN("attempted to unregister a netdev provider that is not "
251 "registered: %s", type);
252 error = EAFNOSUPPORT;
253 } else if (ovs_refcount_unref(&rc->refcnt) != 1) {
254 ovs_refcount_ref(&rc->refcnt);
255 VLOG_WARN("attempted to unregister in use netdev provider: %s",
259 cmap_remove(&netdev_classes, &rc->cmap_node,
260 hash_string(rc->class->type, 0));
261 ovsrcu_postpone(free, rc);
264 ovs_mutex_unlock(&netdev_class_mutex);
269 /* Clears 'types' and enumerates the types of all currently registered netdev
270 * providers into it. The caller must first initialize the sset. */
272 netdev_enumerate_types(struct sset *types)
273 OVS_EXCLUDED(netdev_mutex)
278 struct netdev_registered_class *rc;
279 CMAP_FOR_EACH (rc, cmap_node, &netdev_classes) {
280 sset_add(types, rc->class->type);
284 /* Check that the network device name is not the same as any of the registered
285 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
286 * does not define it) or the datapath internal port name (e.g. ovs-system).
288 * Returns true if there is a name conflict, false otherwise. */
290 netdev_is_reserved_name(const char *name)
291 OVS_EXCLUDED(netdev_mutex)
295 struct netdev_registered_class *rc;
296 CMAP_FOR_EACH (rc, cmap_node, &netdev_classes) {
297 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
298 if (dpif_port && !strncmp(name, dpif_port, strlen(dpif_port))) {
303 if (!strncmp(name, "ovs-", 4)) {
308 dp_enumerate_types(&types);
309 SSET_FOR_EACH (type, &types) {
310 if (!strcmp(name+4, type)) {
311 sset_destroy(&types);
315 sset_destroy(&types);
321 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
322 * (e.g. "system") and returns zero if successful, otherwise a positive errno
323 * value. On success, sets '*netdevp' to the new network device, otherwise to
326 * Some network devices may need to be configured (with netdev_set_config())
327 * before they can be used. */
329 netdev_open(const char *name, const char *type, struct netdev **netdevp)
330 OVS_EXCLUDED(netdev_mutex)
332 struct netdev *netdev;
337 ovs_mutex_lock(&netdev_mutex);
338 netdev = shash_find_data(&netdev_shash, name);
340 struct netdev_registered_class *rc;
342 rc = netdev_lookup_class(type && type[0] ? type : "system");
343 if (rc && ovs_refcount_try_ref_rcu(&rc->refcnt)) {
344 netdev = rc->class->alloc();
346 memset(netdev, 0, sizeof *netdev);
347 netdev->netdev_class = rc->class;
348 netdev->name = xstrdup(name);
349 netdev->change_seq = 1;
350 netdev->reconfigure_seq = seq_create();
351 netdev->last_reconfigure_seq =
352 seq_read(netdev->reconfigure_seq);
353 netdev->node = shash_add(&netdev_shash, name, netdev);
355 /* By default enable one tx and rx queue per netdev. */
356 netdev->n_txq = netdev->netdev_class->send ? 1 : 0;
357 netdev->n_rxq = netdev->netdev_class->rxq_alloc ? 1 : 0;
359 ovs_list_init(&netdev->saved_flags_list);
361 error = rc->class->construct(netdev);
363 netdev_change_seq_changed(netdev);
365 ovs_refcount_unref(&rc->refcnt);
367 ovs_assert(ovs_list_is_empty(&netdev->saved_flags_list));
368 shash_delete(&netdev_shash, netdev->node);
369 rc->class->dealloc(netdev);
375 VLOG_WARN("could not create netdev %s of unknown type %s",
377 error = EAFNOSUPPORT;
389 ovs_mutex_unlock(&netdev_mutex);
394 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
395 * 'netdev_' is null. */
397 netdev_ref(const struct netdev *netdev_)
398 OVS_EXCLUDED(netdev_mutex)
400 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
403 ovs_mutex_lock(&netdev_mutex);
404 ovs_assert(netdev->ref_cnt > 0);
406 ovs_mutex_unlock(&netdev_mutex);
411 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
412 * or NULL if none are needed. */
414 netdev_set_config(struct netdev *netdev, const struct smap *args, char **errp)
415 OVS_EXCLUDED(netdev_mutex)
417 if (netdev->netdev_class->set_config) {
418 const struct smap no_args = SMAP_INITIALIZER(&no_args);
421 error = netdev->netdev_class->set_config(netdev,
422 args ? args : &no_args);
424 VLOG_WARN_BUF(errp, "%s: could not set configuration (%s)",
425 netdev_get_name(netdev), ovs_strerror(error));
428 } else if (args && !smap_is_empty(args)) {
429 VLOG_WARN_BUF(errp, "%s: arguments provided to device that is not configurable",
430 netdev_get_name(netdev));
435 /* Returns the current configuration for 'netdev' in 'args'. The caller must
436 * have already initialized 'args' with smap_init(). Returns 0 on success, in
437 * which case 'args' will be filled with 'netdev''s configuration. On failure
438 * returns a positive errno value, in which case 'args' will be empty.
440 * The caller owns 'args' and its contents and must eventually free them with
443 netdev_get_config(const struct netdev *netdev, struct smap *args)
444 OVS_EXCLUDED(netdev_mutex)
449 if (netdev->netdev_class->get_config) {
450 error = netdev->netdev_class->get_config(netdev, args);
461 const struct netdev_tunnel_config *
462 netdev_get_tunnel_config(const struct netdev *netdev)
463 OVS_EXCLUDED(netdev_mutex)
465 if (netdev->netdev_class->get_tunnel_config) {
466 return netdev->netdev_class->get_tunnel_config(netdev);
472 /* Returns the id of the numa node the 'netdev' is on. If the function
473 * is not implemented, returns NETDEV_NUMA_UNSPEC. */
475 netdev_get_numa_id(const struct netdev *netdev)
477 if (netdev->netdev_class->get_numa_id) {
478 return netdev->netdev_class->get_numa_id(netdev);
480 return NETDEV_NUMA_UNSPEC;
485 netdev_unref(struct netdev *dev)
486 OVS_RELEASES(netdev_mutex)
488 ovs_assert(dev->ref_cnt);
489 if (!--dev->ref_cnt) {
490 const struct netdev_class *class = dev->netdev_class;
491 struct netdev_registered_class *rc;
493 dev->netdev_class->destruct(dev);
496 shash_delete(&netdev_shash, dev->node);
499 seq_destroy(dev->reconfigure_seq);
500 dev->netdev_class->dealloc(dev);
501 ovs_mutex_unlock(&netdev_mutex);
503 rc = netdev_lookup_class(class->type);
504 ovs_refcount_unref(&rc->refcnt);
506 ovs_mutex_unlock(&netdev_mutex);
510 /* Closes and destroys 'netdev'. */
512 netdev_close(struct netdev *netdev)
513 OVS_EXCLUDED(netdev_mutex)
516 ovs_mutex_lock(&netdev_mutex);
517 netdev_unref(netdev);
521 /* Removes 'netdev' from the global shash and unrefs 'netdev'.
523 * This allows handler and revalidator threads to still retain references
524 * to this netdev while the main thread changes interface configuration.
526 * This function should only be called by the main thread when closing
527 * netdevs during user configuration changes. Otherwise, netdev_close should be
528 * used to close netdevs. */
530 netdev_remove(struct netdev *netdev)
533 ovs_mutex_lock(&netdev_mutex);
535 shash_delete(&netdev_shash, netdev->node);
537 netdev_change_seq_changed(netdev);
539 netdev_unref(netdev);
543 /* Parses 'netdev_name_', which is of the form [type@]name into its component
544 * pieces. 'name' and 'type' must be freed by the caller. */
546 netdev_parse_name(const char *netdev_name_, char **name, char **type)
548 char *netdev_name = xstrdup(netdev_name_);
551 separator = strchr(netdev_name, '@');
555 *name = xstrdup(separator + 1);
558 *type = xstrdup("system");
562 /* Attempts to open a netdev_rxq handle for obtaining packets received on
563 * 'netdev'. On success, returns 0 and stores a nonnull 'netdev_rxq *' into
564 * '*rxp'. On failure, returns a positive errno value and stores NULL into
567 * Some kinds of network devices might not support receiving packets. This
568 * function returns EOPNOTSUPP in that case.*/
570 netdev_rxq_open(struct netdev *netdev, struct netdev_rxq **rxp, int id)
571 OVS_EXCLUDED(netdev_mutex)
575 if (netdev->netdev_class->rxq_alloc && id < netdev->n_rxq) {
576 struct netdev_rxq *rx = netdev->netdev_class->rxq_alloc();
580 error = netdev->netdev_class->rxq_construct(rx);
586 netdev->netdev_class->rxq_dealloc(rx);
600 netdev_rxq_close(struct netdev_rxq *rx)
601 OVS_EXCLUDED(netdev_mutex)
604 struct netdev *netdev = rx->netdev;
605 netdev->netdev_class->rxq_destruct(rx);
606 netdev->netdev_class->rxq_dealloc(rx);
607 netdev_close(netdev);
611 /* Attempts to receive a batch of packets from 'rx'. 'pkts' should point to
612 * the beginning of an array of MAX_RX_BATCH pointers to dp_packet. If
613 * successful, this function stores pointers to up to MAX_RX_BATCH dp_packets
614 * into the array, transferring ownership of the packets to the caller, stores
615 * the number of received packets into '*cnt', and returns 0.
617 * The implementation does not necessarily initialize any non-data members of
618 * 'pkts'. That is, the caller must initialize layer pointers and metadata
619 * itself, if desired, e.g. with pkt_metadata_init() and miniflow_extract().
621 * Returns EAGAIN immediately if no packet is ready to be received or another
622 * positive errno value if an error was encountered. */
624 netdev_rxq_recv(struct netdev_rxq *rx, struct dp_packet_batch *batch)
628 retval = rx->netdev->netdev_class->rxq_recv(rx, batch);
630 COVERAGE_INC(netdev_received);
637 /* Arranges for poll_block() to wake up when a packet is ready to be received
640 netdev_rxq_wait(struct netdev_rxq *rx)
642 rx->netdev->netdev_class->rxq_wait(rx);
645 /* Discards any packets ready to be received on 'rx'. */
647 netdev_rxq_drain(struct netdev_rxq *rx)
649 return (rx->netdev->netdev_class->rxq_drain
650 ? rx->netdev->netdev_class->rxq_drain(rx)
654 /* Configures the number of tx queues of 'netdev'. Returns 0 if successful,
655 * otherwise a positive errno value.
657 * 'n_txq' specifies the exact number of transmission queues to create.
658 * If this function returns successfully, the caller can make 'n_txq'
659 * concurrent calls to netdev_send() (each one with a different 'qid' in the
660 * range [0..'n_txq'-1]).
662 * The change might not effective immediately. The caller must check if a
663 * reconfiguration is required with netdev_is_reconf_required() and eventually
664 * call netdev_reconfigure() before using the new queues.
666 * On error, the tx queue configuration is unchanged */
668 netdev_set_tx_multiq(struct netdev *netdev, unsigned int n_txq)
672 error = (netdev->netdev_class->set_tx_multiq
673 ? netdev->netdev_class->set_tx_multiq(netdev, MAX(n_txq, 1))
676 if (error && error != EOPNOTSUPP) {
677 VLOG_DBG_RL(&rl, "failed to set tx queue for network device %s:"
678 "%s", netdev_get_name(netdev), ovs_strerror(error));
684 /* Sends 'batch' on 'netdev'. Returns 0 if successful (for every packet),
685 * otherwise a positive errno value. Returns EAGAIN without blocking if
686 * at least one the packets cannot be queued immediately. Returns EMSGSIZE
687 * if a partial packet was transmitted or if a packet is too big or too small
688 * to transmit on the device.
690 * If the function returns a non-zero value, some of the packets might have
693 * If 'may_steal' is false, the caller retains ownership of all the packets.
694 * If 'may_steal' is true, the caller transfers ownership of all the packets
695 * to the network device, regardless of success.
697 * The network device is expected to maintain one or more packet
698 * transmission queues, so that the caller does not ordinarily have to
699 * do additional queuing of packets. 'qid' specifies the queue to use
700 * and can be ignored if the implementation does not support multiple
703 * Some network devices may not implement support for this function. In such
704 * cases this function will always return EOPNOTSUPP. */
706 netdev_send(struct netdev *netdev, int qid, struct dp_packet_batch *batch,
709 if (!netdev->netdev_class->send) {
710 dp_packet_delete_batch(batch, may_steal);
714 int error = netdev->netdev_class->send(netdev, qid, batch, may_steal);
716 COVERAGE_INC(netdev_sent);
718 dp_packet_batch_reset_cutlen(batch);
725 netdev_pop_header(struct netdev *netdev, struct dp_packet_batch *batch)
728 struct dp_packet **buffers = batch->packets;
730 if (!netdev->netdev_class->pop_header) {
731 dp_packet_delete_batch(batch, true);
736 for (i = 0; i < batch->count; i++) {
737 buffers[i] = netdev->netdev_class->pop_header(buffers[i]);
739 buffers[n_cnt++] = buffers[i];
742 batch->count = n_cnt;
746 netdev_init_tnl_build_header_params(struct netdev_tnl_build_header_params *params,
747 const struct flow *tnl_flow,
748 const struct in6_addr *src,
749 struct eth_addr dmac,
750 struct eth_addr smac)
752 params->flow = tnl_flow;
756 params->is_ipv6 = !IN6_IS_ADDR_V4MAPPED(src);
759 int netdev_build_header(const struct netdev *netdev,
760 struct ovs_action_push_tnl *data,
761 const struct netdev_tnl_build_header_params *params)
763 if (netdev->netdev_class->build_header) {
764 return netdev->netdev_class->build_header(netdev, data, params);
770 netdev_push_header(const struct netdev *netdev,
771 struct dp_packet_batch *batch,
772 const struct ovs_action_push_tnl *data)
776 if (!netdev->netdev_class->push_header) {
780 for (i = 0; i < batch->count; i++) {
781 netdev->netdev_class->push_header(batch->packets[i], data);
782 pkt_metadata_init(&batch->packets[i]->md, u32_to_odp(data->out_port));
788 /* Registers with the poll loop to wake up from the next call to poll_block()
789 * when the packet transmission queue has sufficient room to transmit a packet
790 * with netdev_send().
792 * The network device is expected to maintain one or more packet
793 * transmission queues, so that the caller does not ordinarily have to
794 * do additional queuing of packets. 'qid' specifies the queue to use
795 * and can be ignored if the implementation does not support multiple
798 netdev_send_wait(struct netdev *netdev, int qid)
800 if (netdev->netdev_class->send_wait) {
801 netdev->netdev_class->send_wait(netdev, qid);
805 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
806 * otherwise a positive errno value. */
808 netdev_set_etheraddr(struct netdev *netdev, const struct eth_addr mac)
810 return netdev->netdev_class->set_etheraddr(netdev, mac);
813 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
814 * the MAC address into 'mac'. On failure, returns a positive errno value and
815 * clears 'mac' to all-zeros. */
817 netdev_get_etheraddr(const struct netdev *netdev, struct eth_addr *mac)
819 return netdev->netdev_class->get_etheraddr(netdev, mac);
822 /* Returns the name of the network device that 'netdev' represents,
823 * e.g. "eth0". The caller must not modify or free the returned string. */
825 netdev_get_name(const struct netdev *netdev)
830 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
831 * (and received) packets, in bytes, not including the hardware header; thus,
832 * this is typically 1500 bytes for Ethernet devices.
834 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
835 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
836 * On other failure, returns a positive errno value. On failure, sets '*mtup'
839 netdev_get_mtu(const struct netdev *netdev, int *mtup)
841 const struct netdev_class *class = netdev->netdev_class;
844 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
847 if (error != EOPNOTSUPP) {
848 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
849 "%s", netdev_get_name(netdev), ovs_strerror(error));
855 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
856 * (and received) packets, in bytes.
858 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
859 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
862 netdev_set_mtu(const struct netdev *netdev, int mtu)
864 const struct netdev_class *class = netdev->netdev_class;
867 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
868 if (error && error != EOPNOTSUPP) {
869 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
870 netdev_get_name(netdev), ovs_strerror(error));
876 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
877 * failure, returns a negative errno value.
879 * The desired semantics of the ifindex value are a combination of those
880 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
881 * value should be unique within a host and remain stable at least until
882 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
883 * but many systems do not follow this rule anyhow.
885 * Some network devices may not implement support for this function. In such
886 * cases this function will always return -EOPNOTSUPP.
889 netdev_get_ifindex(const struct netdev *netdev)
891 int (*get_ifindex)(const struct netdev *);
893 get_ifindex = netdev->netdev_class->get_ifindex;
895 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
898 /* Stores the features supported by 'netdev' into each of '*current',
899 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
900 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
901 * successful, otherwise a positive errno value. On failure, all of the
902 * passed-in values are set to 0.
904 * Some network devices may not implement support for this function. In such
905 * cases this function will always return EOPNOTSUPP. */
907 netdev_get_features(const struct netdev *netdev,
908 enum netdev_features *current,
909 enum netdev_features *advertised,
910 enum netdev_features *supported,
911 enum netdev_features *peer)
913 int (*get_features)(const struct netdev *netdev,
914 enum netdev_features *current,
915 enum netdev_features *advertised,
916 enum netdev_features *supported,
917 enum netdev_features *peer);
918 enum netdev_features dummy[4];
925 advertised = &dummy[1];
928 supported = &dummy[2];
934 get_features = netdev->netdev_class->get_features;
936 ? get_features(netdev, current, advertised, supported,
940 *current = *advertised = *supported = *peer = 0;
945 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
946 * bits in 'features', in bits per second. If no bits that indicate a speed
947 * are set in 'features', returns 'default_bps'. */
949 netdev_features_to_bps(enum netdev_features features,
950 uint64_t default_bps)
953 F_1000000MB = NETDEV_F_1TB_FD,
954 F_100000MB = NETDEV_F_100GB_FD,
955 F_40000MB = NETDEV_F_40GB_FD,
956 F_10000MB = NETDEV_F_10GB_FD,
957 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
958 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
959 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
962 return ( features & F_1000000MB ? UINT64_C(1000000000000)
963 : features & F_100000MB ? UINT64_C(100000000000)
964 : features & F_40000MB ? UINT64_C(40000000000)
965 : features & F_10000MB ? UINT64_C(10000000000)
966 : features & F_1000MB ? UINT64_C(1000000000)
967 : features & F_100MB ? UINT64_C(100000000)
968 : features & F_10MB ? UINT64_C(10000000)
972 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
973 * are set in 'features', otherwise false. */
975 netdev_features_is_full_duplex(enum netdev_features features)
977 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
978 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
979 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
982 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
983 * successful, otherwise a positive errno value. */
985 netdev_set_advertisements(struct netdev *netdev,
986 enum netdev_features advertise)
988 return (netdev->netdev_class->set_advertisements
989 ? netdev->netdev_class->set_advertisements(
994 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
995 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
996 * positive errno value. */
998 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
1000 return (netdev->netdev_class->set_in4
1001 ? netdev->netdev_class->set_in4(netdev, addr, mask)
1005 /* Obtains ad IPv4 address from device name and save the address in
1006 * in4. Returns 0 if successful, otherwise a positive errno value.
1009 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
1011 struct in6_addr *mask, *addr6;
1015 err = netdev_open(device_name, NULL, &dev);
1020 err = netdev_get_addr_list(dev, &addr6, &mask, &n_in6);
1025 for (i = 0; i < n_in6; i++) {
1026 if (IN6_IS_ADDR_V4MAPPED(&addr6[i])) {
1027 in4->s_addr = in6_addr_get_mapped_ipv4(&addr6[i]);
1040 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
1043 netdev_add_router(struct netdev *netdev, struct in_addr router)
1045 COVERAGE_INC(netdev_add_router);
1046 return (netdev->netdev_class->add_router
1047 ? netdev->netdev_class->add_router(netdev, router)
1051 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
1052 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
1053 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
1054 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
1055 * a directly connected network) in '*next_hop' and a copy of the name of the
1056 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
1057 * responsible for freeing '*netdev_name' (by calling free()). */
1059 netdev_get_next_hop(const struct netdev *netdev,
1060 const struct in_addr *host, struct in_addr *next_hop,
1063 int error = (netdev->netdev_class->get_next_hop
1064 ? netdev->netdev_class->get_next_hop(
1065 host, next_hop, netdev_name)
1068 next_hop->s_addr = 0;
1069 *netdev_name = NULL;
1074 /* Populates 'smap' with status information.
1076 * Populates 'smap' with 'netdev' specific status information. This
1077 * information may be used to populate the status column of the Interface table
1078 * as defined in ovs-vswitchd.conf.db(5). */
1080 netdev_get_status(const struct netdev *netdev, struct smap *smap)
1082 return (netdev->netdev_class->get_status
1083 ? netdev->netdev_class->get_status(netdev, smap)
1087 /* Returns all assigned IP address to 'netdev' and returns 0.
1088 * API allocates array of address and masks and set it to
1089 * '*addr' and '*mask'.
1090 * Otherwise, returns a positive errno value and sets '*addr', '*mask
1091 * and '*n_addr' to NULL.
1093 * The following error values have well-defined meanings:
1095 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
1097 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
1099 * 'addr' may be null, in which case the address itself is not reported. */
1101 netdev_get_addr_list(const struct netdev *netdev, struct in6_addr **addr,
1102 struct in6_addr **mask, int *n_addr)
1106 error = (netdev->netdev_class->get_addr_list
1107 ? netdev->netdev_class->get_addr_list(netdev, addr, mask, n_addr): EOPNOTSUPP);
1108 if (error && addr) {
1117 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
1118 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
1120 do_update_flags(struct netdev *netdev, enum netdev_flags off,
1121 enum netdev_flags on, enum netdev_flags *old_flagsp,
1122 struct netdev_saved_flags **sfp)
1123 OVS_EXCLUDED(netdev_mutex)
1125 struct netdev_saved_flags *sf = NULL;
1126 enum netdev_flags old_flags;
1129 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
1132 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
1133 off || on ? "set" : "get", netdev_get_name(netdev),
1134 ovs_strerror(error));
1136 } else if ((off || on) && sfp) {
1137 enum netdev_flags new_flags = (old_flags & ~off) | on;
1138 enum netdev_flags changed_flags = old_flags ^ new_flags;
1139 if (changed_flags) {
1140 ovs_mutex_lock(&netdev_mutex);
1141 *sfp = sf = xmalloc(sizeof *sf);
1142 sf->netdev = netdev;
1143 ovs_list_push_front(&netdev->saved_flags_list, &sf->node);
1144 sf->saved_flags = changed_flags;
1145 sf->saved_values = changed_flags & new_flags;
1148 ovs_mutex_unlock(&netdev_mutex);
1153 *old_flagsp = old_flags;
1162 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
1163 * Returns 0 if successful, otherwise a positive errno value. On failure,
1164 * stores 0 into '*flagsp'. */
1166 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1168 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1169 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1172 /* Sets the flags for 'netdev' to 'flags'.
1173 * Returns 0 if successful, otherwise a positive errno value. */
1175 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1176 struct netdev_saved_flags **sfp)
1178 return do_update_flags(netdev, -1, flags, NULL, sfp);
1181 /* Turns on the specified 'flags' on 'netdev':
1183 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1184 * allocated 'struct netdev_saved_flags *' that may be passed to
1185 * netdev_restore_flags() to restore the original values of 'flags' on
1186 * 'netdev' (this will happen automatically at program termination if
1187 * netdev_restore_flags() is never called) , or to NULL if no flags were
1190 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1191 * '*sfp' to NULL. */
1193 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1194 struct netdev_saved_flags **sfp)
1196 return do_update_flags(netdev, 0, flags, NULL, sfp);
1199 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1200 * details of the interface. */
1202 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1203 struct netdev_saved_flags **sfp)
1205 return do_update_flags(netdev, flags, 0, NULL, sfp);
1208 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1209 * Does nothing if 'sf' is NULL. */
1211 netdev_restore_flags(struct netdev_saved_flags *sf)
1212 OVS_EXCLUDED(netdev_mutex)
1215 struct netdev *netdev = sf->netdev;
1216 enum netdev_flags old_flags;
1218 netdev->netdev_class->update_flags(netdev,
1219 sf->saved_flags & sf->saved_values,
1220 sf->saved_flags & ~sf->saved_values,
1223 ovs_mutex_lock(&netdev_mutex);
1224 ovs_list_remove(&sf->node);
1226 netdev_unref(netdev);
1230 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1231 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1232 * returns 0. Otherwise, it returns a positive errno value; in particular,
1233 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1235 netdev_arp_lookup(const struct netdev *netdev,
1236 ovs_be32 ip, struct eth_addr *mac)
1238 int error = (netdev->netdev_class->arp_lookup
1239 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1242 *mac = eth_addr_zero;
1247 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1249 netdev_get_carrier(const struct netdev *netdev)
1252 enum netdev_flags flags;
1255 netdev_get_flags(netdev, &flags);
1256 if (!(flags & NETDEV_UP)) {
1260 if (!netdev->netdev_class->get_carrier) {
1264 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1266 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1267 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1274 /* Returns the number of times 'netdev''s carrier has changed. */
1276 netdev_get_carrier_resets(const struct netdev *netdev)
1278 return (netdev->netdev_class->get_carrier_resets
1279 ? netdev->netdev_class->get_carrier_resets(netdev)
1283 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1284 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1285 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1286 * does not support MII, another method may be used as a fallback. If
1287 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1288 * its normal behavior.
1290 * Returns 0 if successful, otherwise a positive errno value. */
1292 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1294 return (netdev->netdev_class->set_miimon_interval
1295 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1299 /* Retrieves current device stats for 'netdev'. */
1301 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1305 /* Statistics are initialized before passing it to particular device
1306 * implementation so all values are filtered out by default. */
1307 memset(stats, 0xFF, sizeof *stats);
1309 COVERAGE_INC(netdev_get_stats);
1310 error = (netdev->netdev_class->get_stats
1311 ? netdev->netdev_class->get_stats(netdev, stats)
1314 /* In case of error all statistics are filtered out */
1315 memset(stats, 0xff, sizeof *stats);
1320 /* Attempts to set input rate limiting (policing) policy, such that up to
1321 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1322 * size of 'kbits' kb. */
1324 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1325 uint32_t kbits_burst)
1327 return (netdev->netdev_class->set_policing
1328 ? netdev->netdev_class->set_policing(netdev,
1329 kbits_rate, kbits_burst)
1333 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1334 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1335 * be documented as valid for the "type" column in the "QoS" table in
1336 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1338 * Every network device supports disabling QoS with a type of "", but this type
1339 * will not be added to 'types'.
1341 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1342 * this function. The caller is responsible for destroying 'types' (e.g. with
1343 * sset_destroy()) when it is no longer needed.
1345 * Returns 0 if successful, otherwise a positive errno value. */
1347 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1349 const struct netdev_class *class = netdev->netdev_class;
1350 return (class->get_qos_types
1351 ? class->get_qos_types(netdev, types)
1355 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1356 * which should be "" or one of the types returned by netdev_get_qos_types()
1357 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1358 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1359 * 'caps' to all zeros. */
1361 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1362 struct netdev_qos_capabilities *caps)
1364 const struct netdev_class *class = netdev->netdev_class;
1367 int retval = (class->get_qos_capabilities
1368 ? class->get_qos_capabilities(netdev, type, caps)
1371 memset(caps, 0, sizeof *caps);
1375 /* Every netdev supports turning off QoS. */
1376 memset(caps, 0, sizeof *caps);
1381 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1382 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1383 * the number of queues (zero on failure) in '*n_queuesp'.
1385 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1387 netdev_get_n_queues(const struct netdev *netdev,
1388 const char *type, unsigned int *n_queuesp)
1390 struct netdev_qos_capabilities caps;
1393 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1394 *n_queuesp = caps.n_queues;
1398 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1399 * stores the name of the current form of QoS into '*typep', stores any details
1400 * of configuration as string key-value pairs in 'details', and returns 0. On
1401 * failure, sets '*typep' to NULL and returns a positive errno value.
1403 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1405 * The caller must initialize 'details' as an empty smap (e.g. with
1406 * smap_init()) before calling this function. The caller must free 'details'
1407 * when it is no longer needed (e.g. with smap_destroy()).
1409 * The caller must not modify or free '*typep'.
1411 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1412 * 'netdev'. The contents of 'details' should be documented as valid for
1413 * '*typep' in the "other_config" column in the "QoS" table in
1414 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1416 netdev_get_qos(const struct netdev *netdev,
1417 const char **typep, struct smap *details)
1419 const struct netdev_class *class = netdev->netdev_class;
1422 if (class->get_qos) {
1423 retval = class->get_qos(netdev, typep, details);
1426 smap_clear(details);
1430 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1436 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1437 * with details of configuration from 'details'. Returns 0 if successful,
1438 * otherwise a positive errno value. On error, the previous QoS configuration
1441 * When this function changes the type of QoS (not just 'details'), this also
1442 * resets all queue configuration for 'netdev' to their defaults (which depend
1443 * on the specific type of QoS). Otherwise, the queue configuration for
1444 * 'netdev' is unchanged.
1446 * 'type' should be "" (to disable QoS) or one of the types returned by
1447 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1448 * documented as valid for the given 'type' in the "other_config" column in the
1449 * "QoS" table in vswitchd/vswitch.xml (which is built as
1450 * ovs-vswitchd.conf.db(8)).
1452 * NULL may be specified for 'details' if there are no configuration
1455 netdev_set_qos(struct netdev *netdev,
1456 const char *type, const struct smap *details)
1458 const struct netdev_class *class = netdev->netdev_class;
1464 if (class->set_qos) {
1466 static const struct smap empty = SMAP_INITIALIZER(&empty);
1469 return class->set_qos(netdev, type, details);
1471 return *type ? EOPNOTSUPP : 0;
1475 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1476 * successful, adds that information as string key-value pairs to 'details'.
1477 * Returns 0 if successful, otherwise a positive errno value.
1479 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1480 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1482 * The returned contents of 'details' should be documented as valid for the
1483 * given 'type' in the "other_config" column in the "Queue" table in
1484 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1486 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1487 * this function. The caller must free 'details' when it is no longer needed
1488 * (e.g. with smap_destroy()). */
1490 netdev_get_queue(const struct netdev *netdev,
1491 unsigned int queue_id, struct smap *details)
1493 const struct netdev_class *class = netdev->netdev_class;
1496 retval = (class->get_queue
1497 ? class->get_queue(netdev, queue_id, details)
1500 smap_clear(details);
1505 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1506 * string pairs in 'details'. The contents of 'details' should be documented
1507 * as valid for the given 'type' in the "other_config" column in the "Queue"
1508 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1509 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1510 * given queue's configuration should be unmodified.
1512 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1513 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1515 * This function does not modify 'details', and the caller retains ownership of
1518 netdev_set_queue(struct netdev *netdev,
1519 unsigned int queue_id, const struct smap *details)
1521 const struct netdev_class *class = netdev->netdev_class;
1522 return (class->set_queue
1523 ? class->set_queue(netdev, queue_id, details)
1527 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1528 * of QoS may have a fixed set of queues, in which case attempts to delete them
1529 * will fail with EOPNOTSUPP.
1531 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1532 * given queue will be unmodified.
1534 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1535 * the current form of QoS (e.g. as returned by
1536 * netdev_get_n_queues(netdev)). */
1538 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1540 const struct netdev_class *class = netdev->netdev_class;
1541 return (class->delete_queue
1542 ? class->delete_queue(netdev, queue_id)
1546 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1547 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1548 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1549 * positive errno value and fills 'stats' with values indicating unsupported
1552 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1553 struct netdev_queue_stats *stats)
1555 const struct netdev_class *class = netdev->netdev_class;
1558 retval = (class->get_queue_stats
1559 ? class->get_queue_stats(netdev, queue_id, stats)
1562 stats->tx_bytes = UINT64_MAX;
1563 stats->tx_packets = UINT64_MAX;
1564 stats->tx_errors = UINT64_MAX;
1565 stats->created = LLONG_MIN;
1570 /* Initializes 'dump' to begin dumping the queues in a netdev.
1572 * This function provides no status indication. An error status for the entire
1573 * dump operation is provided when it is completed by calling
1574 * netdev_queue_dump_done().
1577 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1578 const struct netdev *netdev)
1580 dump->netdev = netdev_ref(netdev);
1581 if (netdev->netdev_class->queue_dump_start) {
1582 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1585 dump->error = EOPNOTSUPP;
1589 /* Attempts to retrieve another queue from 'dump', which must have been
1590 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1591 * ID into '*queue_id', fills 'details' with configuration details for the
1592 * queue, and returns true. On failure, returns false.
1594 * Queues are not necessarily dumped in increasing order of queue ID (or any
1595 * other predictable order).
1597 * Failure might indicate an actual error or merely that the last queue has
1598 * been dumped. An error status for the entire dump operation is provided when
1599 * it is completed by calling netdev_queue_dump_done().
1601 * The returned contents of 'details' should be documented as valid for the
1602 * given 'type' in the "other_config" column in the "Queue" table in
1603 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1605 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1606 * this function. This function will clear and replace its contents. The
1607 * caller must free 'details' when it is no longer needed (e.g. with
1608 * smap_destroy()). */
1610 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1611 unsigned int *queue_id, struct smap *details)
1613 const struct netdev *netdev = dump->netdev;
1619 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1623 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1629 /* Completes queue table dump operation 'dump', which must have been
1630 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1631 * was error-free, otherwise a positive errno value describing the problem. */
1633 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1635 const struct netdev *netdev = dump->netdev;
1636 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1637 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1640 netdev_close(dump->netdev);
1641 return dump->error == EOF ? 0 : dump->error;
1644 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1645 * its statistics, and the 'aux' specified by the caller. The order of
1646 * iteration is unspecified, but (when successful) each queue is visited
1649 * Calling this function may be more efficient than calling
1650 * netdev_get_queue_stats() for every queue.
1652 * 'cb' must not modify or free the statistics passed in.
1654 * Returns 0 if successful, otherwise a positive errno value. On error, some
1655 * configured queues may not have been included in the iteration. */
1657 netdev_dump_queue_stats(const struct netdev *netdev,
1658 netdev_dump_queue_stats_cb *cb, void *aux)
1660 const struct netdev_class *class = netdev->netdev_class;
1661 return (class->dump_queue_stats
1662 ? class->dump_queue_stats(netdev, cb, aux)
1667 /* Returns the class type of 'netdev'.
1669 * The caller must not free the returned value. */
1671 netdev_get_type(const struct netdev *netdev)
1673 return netdev->netdev_class->type;
1676 /* Returns the class associated with 'netdev'. */
1677 const struct netdev_class *
1678 netdev_get_class(const struct netdev *netdev)
1680 return netdev->netdev_class;
1683 /* Returns the netdev with 'name' or NULL if there is none.
1685 * The caller must free the returned netdev with netdev_close(). */
1687 netdev_from_name(const char *name)
1688 OVS_EXCLUDED(netdev_mutex)
1690 struct netdev *netdev;
1692 ovs_mutex_lock(&netdev_mutex);
1693 netdev = shash_find_data(&netdev_shash, name);
1697 ovs_mutex_unlock(&netdev_mutex);
1702 /* Fills 'device_list' with devices that match 'netdev_class'.
1704 * The caller is responsible for initializing and destroying 'device_list' and
1705 * must close each device on the list. */
1707 netdev_get_devices(const struct netdev_class *netdev_class,
1708 struct shash *device_list)
1709 OVS_EXCLUDED(netdev_mutex)
1711 struct shash_node *node;
1713 ovs_mutex_lock(&netdev_mutex);
1714 SHASH_FOR_EACH (node, &netdev_shash) {
1715 struct netdev *dev = node->data;
1717 if (dev->netdev_class == netdev_class) {
1719 shash_add(device_list, node->name, node->data);
1722 ovs_mutex_unlock(&netdev_mutex);
1725 /* Extracts pointers to all 'netdev-vports' into an array 'vports'
1726 * and returns it. Stores the size of the array into '*size'.
1728 * The caller is responsible for freeing 'vports' and must close
1729 * each 'netdev-vport' in the list. */
1731 netdev_get_vports(size_t *size)
1732 OVS_EXCLUDED(netdev_mutex)
1734 struct netdev **vports;
1735 struct shash_node *node;
1742 /* Explicitly allocates big enough chunk of memory. */
1743 vports = xmalloc(shash_count(&netdev_shash) * sizeof *vports);
1744 ovs_mutex_lock(&netdev_mutex);
1745 SHASH_FOR_EACH (node, &netdev_shash) {
1746 struct netdev *dev = node->data;
1748 if (netdev_vport_is_vport_class(dev->netdev_class)) {
1754 ovs_mutex_unlock(&netdev_mutex);
1761 netdev_get_type_from_name(const char *name)
1763 struct netdev *dev = netdev_from_name(name);
1764 const char *type = dev ? netdev_get_type(dev) : NULL;
1770 netdev_rxq_get_netdev(const struct netdev_rxq *rx)
1772 ovs_assert(rx->netdev->ref_cnt > 0);
1777 netdev_rxq_get_name(const struct netdev_rxq *rx)
1779 return netdev_get_name(netdev_rxq_get_netdev(rx));
1783 netdev_rxq_get_queue_id(const struct netdev_rxq *rx)
1785 return rx->queue_id;
1789 restore_all_flags(void *aux OVS_UNUSED)
1791 struct shash_node *node;
1793 SHASH_FOR_EACH (node, &netdev_shash) {
1794 struct netdev *netdev = node->data;
1795 const struct netdev_saved_flags *sf;
1796 enum netdev_flags saved_values;
1797 enum netdev_flags saved_flags;
1799 saved_values = saved_flags = 0;
1800 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1801 saved_flags |= sf->saved_flags;
1802 saved_values &= ~sf->saved_flags;
1803 saved_values |= sf->saved_flags & sf->saved_values;
1806 enum netdev_flags old_flags;
1808 netdev->netdev_class->update_flags(netdev,
1809 saved_flags & saved_values,
1810 saved_flags & ~saved_values,
1817 netdev_get_change_seq(const struct netdev *netdev)
1819 return netdev->change_seq;
1823 /* This implementation is shared by Linux and BSD. */
1825 static struct ifaddrs *if_addr_list;
1826 static struct ovs_mutex if_addr_list_lock = OVS_MUTEX_INITIALIZER;
1829 netdev_get_addrs_list_flush(void)
1831 ovs_mutex_lock(&if_addr_list_lock);
1833 freeifaddrs(if_addr_list);
1834 if_addr_list = NULL;
1836 ovs_mutex_unlock(&if_addr_list_lock);
1840 netdev_get_addrs(const char dev[], struct in6_addr **paddr,
1841 struct in6_addr **pmask, int *n_in)
1843 struct in6_addr *addr_array, *mask_array;
1844 const struct ifaddrs *ifa;
1847 ovs_mutex_lock(&if_addr_list_lock);
1848 if (!if_addr_list) {
1851 err = getifaddrs(&if_addr_list);
1853 ovs_mutex_unlock(&if_addr_list_lock);
1858 for (ifa = if_addr_list; ifa; ifa = ifa->ifa_next) {
1859 if (ifa->ifa_addr != NULL) {
1862 family = ifa->ifa_addr->sa_family;
1863 if (family == AF_INET || family == AF_INET6) {
1864 if (!strncmp(ifa->ifa_name, dev, IFNAMSIZ)) {
1872 ovs_mutex_unlock(&if_addr_list_lock);
1873 return EADDRNOTAVAIL;
1875 addr_array = xzalloc(sizeof *addr_array * cnt);
1876 mask_array = xzalloc(sizeof *mask_array * cnt);
1877 for (ifa = if_addr_list; ifa; ifa = ifa->ifa_next) {
1880 if (strncmp(ifa->ifa_name, dev, IFNAMSIZ) || ifa->ifa_addr == NULL) {
1884 family = ifa->ifa_addr->sa_family;
1885 if (family == AF_INET) {
1886 const struct sockaddr_in *sin;
1888 sin = ALIGNED_CAST(const struct sockaddr_in *, ifa->ifa_addr);
1889 in6_addr_set_mapped_ipv4(&addr_array[i], sin->sin_addr.s_addr);
1890 sin = (struct sockaddr_in *) &ifa->ifa_netmask;
1891 in6_addr_set_mapped_ipv4(&mask_array[i], sin->sin_addr.s_addr);
1893 } else if (family == AF_INET6) {
1894 const struct sockaddr_in6 *sin6;
1896 sin6 = ALIGNED_CAST(const struct sockaddr_in6 *, ifa->ifa_addr);
1897 memcpy(&addr_array[i], &sin6->sin6_addr, sizeof *addr_array);
1898 sin6 = (struct sockaddr_in6 *) &ifa->ifa_netmask;
1899 memcpy(&mask_array[i], &sin6->sin6_addr, sizeof *mask_array);
1903 ovs_mutex_unlock(&if_addr_list_lock);
1906 *paddr = addr_array;
1907 *pmask = mask_array;
1917 netdev_wait_reconf_required(struct netdev *netdev)
1919 seq_wait(netdev->reconfigure_seq, netdev->last_reconfigure_seq);
1923 netdev_is_reconf_required(struct netdev *netdev)
1925 return seq_read(netdev->reconfigure_seq) != netdev->last_reconfigure_seq;
1928 /* Give a chance to 'netdev' to reconfigure some of its parameters.
1930 * If a module uses netdev_send() and netdev_rxq_recv(), it must call this
1931 * function when netdev_is_reconf_required() returns true.
1933 * Return 0 if successful, otherwise a positive errno value. If the
1934 * reconfiguration fails the netdev will not be able to send or receive
1937 * When this function is called, no call to netdev_rxq_recv() or netdev_send()
1938 * must be issued. */
1940 netdev_reconfigure(struct netdev *netdev)
1942 const struct netdev_class *class = netdev->netdev_class;
1944 netdev->last_reconfigure_seq = seq_read(netdev->reconfigure_seq);
1946 return (class->reconfigure
1947 ? class->reconfigure(netdev)