2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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>
27 #include "connectivity.h"
30 #include "dynamic-string.h"
31 #include "fatal-signal.h"
34 #include "netdev-provider.h"
35 #include "netdev-vport.h"
37 #include "openflow/openflow.h"
39 #include "poll-loop.h"
47 VLOG_DEFINE_THIS_MODULE(netdev);
49 COVERAGE_DEFINE(netdev_received);
50 COVERAGE_DEFINE(netdev_sent);
51 COVERAGE_DEFINE(netdev_add_router);
52 COVERAGE_DEFINE(netdev_get_stats);
54 struct netdev_saved_flags {
55 struct netdev *netdev;
56 struct list node; /* In struct netdev's saved_flags_list. */
57 enum netdev_flags saved_flags;
58 enum netdev_flags saved_values;
61 /* Protects 'netdev_shash' and the mutable members of struct netdev. */
62 static struct ovs_mutex netdev_mutex = OVS_MUTEX_INITIALIZER;
64 /* All created network devices. */
65 static struct shash netdev_shash OVS_GUARDED_BY(netdev_mutex)
66 = SHASH_INITIALIZER(&netdev_shash);
68 /* Protects 'netdev_classes' against insertions or deletions.
70 * This is not an rwlock for performance reasons but to allow recursive
71 * acquisition when calling into providers. For example, netdev_run() calls
72 * into provider 'run' functions, which might reasonably want to call one of
73 * the netdev functions that takes netdev_class_rwlock read-only. */
74 static struct ovs_rwlock netdev_class_rwlock OVS_ACQ_BEFORE(netdev_mutex)
75 = OVS_RWLOCK_INITIALIZER;
77 /* Contains 'struct netdev_registered_class'es. */
78 static struct hmap netdev_classes OVS_GUARDED_BY(netdev_class_rwlock)
79 = HMAP_INITIALIZER(&netdev_classes);
81 struct netdev_registered_class {
82 struct hmap_node hmap_node; /* In 'netdev_classes', by class->type. */
83 const struct netdev_class *class;
84 atomic_int ref_cnt; /* Number of 'struct netdev's of this class. */
87 /* This is set pretty low because we probably won't learn anything from the
88 * additional log messages. */
89 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
91 static void restore_all_flags(void *aux OVS_UNUSED);
92 void update_device_args(struct netdev *, const struct shash *args);
95 netdev_initialize(void)
96 OVS_EXCLUDED(netdev_class_rwlock, netdev_mutex)
98 static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
100 if (ovsthread_once_start(&once)) {
101 fatal_signal_add_hook(restore_all_flags, NULL, NULL, true);
102 netdev_vport_patch_register();
104 #ifdef LINUX_DATAPATH
105 netdev_register_provider(&netdev_linux_class);
106 netdev_register_provider(&netdev_internal_class);
107 netdev_register_provider(&netdev_tap_class);
108 netdev_vport_tunnel_register();
110 #if defined(__FreeBSD__) || defined(__NetBSD__)
111 netdev_register_provider(&netdev_tap_class);
112 netdev_register_provider(&netdev_bsd_class);
115 ovsthread_once_done(&once);
119 /* Performs periodic work needed by all the various kinds of netdevs.
121 * If your program opens any netdevs, it must call this function within its
125 OVS_EXCLUDED(netdev_class_rwlock, netdev_mutex)
127 struct netdev_registered_class *rc;
129 ovs_rwlock_rdlock(&netdev_class_rwlock);
130 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
131 if (rc->class->run) {
135 ovs_rwlock_unlock(&netdev_class_rwlock);
138 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
140 * If your program opens any netdevs, it must call this function within its
144 OVS_EXCLUDED(netdev_class_rwlock, netdev_mutex)
146 struct netdev_registered_class *rc;
148 ovs_rwlock_rdlock(&netdev_class_rwlock);
149 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
150 if (rc->class->wait) {
154 ovs_rwlock_unlock(&netdev_class_rwlock);
157 static struct netdev_registered_class *
158 netdev_lookup_class(const char *type)
159 OVS_REQ_RDLOCK(netdev_class_rwlock)
161 struct netdev_registered_class *rc;
163 HMAP_FOR_EACH_WITH_HASH (rc, hmap_node, hash_string(type, 0),
165 if (!strcmp(type, rc->class->type)) {
172 /* Initializes and registers a new netdev provider. After successful
173 * registration, new netdevs of that type can be opened using netdev_open(). */
175 netdev_register_provider(const struct netdev_class *new_class)
176 OVS_EXCLUDED(netdev_class_rwlock, netdev_mutex)
180 ovs_rwlock_wrlock(&netdev_class_rwlock);
181 if (netdev_lookup_class(new_class->type)) {
182 VLOG_WARN("attempted to register duplicate netdev provider: %s",
186 error = new_class->init ? new_class->init() : 0;
188 struct netdev_registered_class *rc;
190 rc = xmalloc(sizeof *rc);
191 hmap_insert(&netdev_classes, &rc->hmap_node,
192 hash_string(new_class->type, 0));
193 rc->class = new_class;
194 atomic_init(&rc->ref_cnt, 0);
196 VLOG_ERR("failed to initialize %s network device class: %s",
197 new_class->type, ovs_strerror(error));
200 ovs_rwlock_unlock(&netdev_class_rwlock);
205 /* Unregisters a netdev provider. 'type' must have been previously
206 * registered and not currently be in use by any netdevs. After unregistration
207 * new netdevs of that type cannot be opened using netdev_open(). */
209 netdev_unregister_provider(const char *type)
210 OVS_EXCLUDED(netdev_class_rwlock, netdev_mutex)
212 struct netdev_registered_class *rc;
215 ovs_rwlock_wrlock(&netdev_class_rwlock);
216 rc = netdev_lookup_class(type);
218 VLOG_WARN("attempted to unregister a netdev provider that is not "
219 "registered: %s", type);
220 error = EAFNOSUPPORT;
224 atomic_read(&rc->ref_cnt, &ref_cnt);
226 hmap_remove(&netdev_classes, &rc->hmap_node);
227 atomic_destroy(&rc->ref_cnt);
231 VLOG_WARN("attempted to unregister in use netdev provider: %s",
236 ovs_rwlock_unlock(&netdev_class_rwlock);
241 /* Clears 'types' and enumerates the types of all currently registered netdev
242 * providers into it. The caller must first initialize the sset. */
244 netdev_enumerate_types(struct sset *types)
245 OVS_EXCLUDED(netdev_mutex)
247 struct netdev_registered_class *rc;
252 ovs_rwlock_rdlock(&netdev_class_rwlock);
253 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
254 sset_add(types, rc->class->type);
256 ovs_rwlock_unlock(&netdev_class_rwlock);
259 /* Check that the network device name is not the same as any of the registered
260 * vport providers' dpif_port name (dpif_port is NULL if the vport provider
261 * does not define it) or the datapath internal port name (e.g. ovs-system).
263 * Returns true if there is a name conflict, false otherwise. */
265 netdev_is_reserved_name(const char *name)
266 OVS_EXCLUDED(netdev_mutex)
268 struct netdev_registered_class *rc;
272 ovs_rwlock_rdlock(&netdev_class_rwlock);
273 HMAP_FOR_EACH (rc, hmap_node, &netdev_classes) {
274 const char *dpif_port = netdev_vport_class_get_dpif_port(rc->class);
275 if (dpif_port && !strcmp(dpif_port, name)) {
276 ovs_rwlock_unlock(&netdev_class_rwlock);
280 ovs_rwlock_unlock(&netdev_class_rwlock);
282 if (!strncmp(name, "ovs-", 4)) {
287 dp_enumerate_types(&types);
288 SSET_FOR_EACH (type, &types) {
289 if (!strcmp(name+4, type)) {
290 sset_destroy(&types);
294 sset_destroy(&types);
300 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
301 * (e.g. "system") and returns zero if successful, otherwise a positive errno
302 * value. On success, sets '*netdevp' to the new network device, otherwise to
305 * Some network devices may need to be configured (with netdev_set_config())
306 * before they can be used. */
308 netdev_open(const char *name, const char *type, struct netdev **netdevp)
309 OVS_EXCLUDED(netdev_mutex)
311 struct netdev *netdev;
316 ovs_rwlock_rdlock(&netdev_class_rwlock);
317 ovs_mutex_lock(&netdev_mutex);
318 netdev = shash_find_data(&netdev_shash, name);
320 struct netdev_registered_class *rc;
322 rc = netdev_lookup_class(type && type[0] ? type : "system");
324 netdev = rc->class->alloc();
326 memset(netdev, 0, sizeof *netdev);
327 netdev->netdev_class = rc->class;
328 netdev->name = xstrdup(name);
329 netdev->node = shash_add(&netdev_shash, name, netdev);
330 list_init(&netdev->saved_flags_list);
332 error = rc->class->construct(netdev);
336 atomic_add(&rc->ref_cnt, 1, &old_ref_cnt);
337 seq_change(connectivity_seq_get());
340 ovs_assert(list_is_empty(&netdev->saved_flags_list));
341 shash_delete(&netdev_shash, netdev->node);
342 rc->class->dealloc(netdev);
348 VLOG_WARN("could not create netdev %s of unknown type %s",
350 error = EAFNOSUPPORT;
356 ovs_mutex_unlock(&netdev_mutex);
357 ovs_rwlock_unlock(&netdev_class_rwlock);
368 /* Returns a reference to 'netdev_' for the caller to own. Returns null if
369 * 'netdev_' is null. */
371 netdev_ref(const struct netdev *netdev_)
372 OVS_EXCLUDED(netdev_mutex)
374 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
377 ovs_mutex_lock(&netdev_mutex);
378 ovs_assert(netdev->ref_cnt > 0);
380 ovs_mutex_unlock(&netdev_mutex);
385 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
386 * or NULL if none are needed. */
388 netdev_set_config(struct netdev *netdev, const struct smap *args)
389 OVS_EXCLUDED(netdev_mutex)
391 if (netdev->netdev_class->set_config) {
392 const struct smap no_args = SMAP_INITIALIZER(&no_args);
395 error = netdev->netdev_class->set_config(netdev,
396 args ? args : &no_args);
398 VLOG_WARN("%s: could not set configuration (%s)",
399 netdev_get_name(netdev), ovs_strerror(error));
402 } else if (args && !smap_is_empty(args)) {
403 VLOG_WARN("%s: arguments provided to device that is not configurable",
404 netdev_get_name(netdev));
409 /* Returns the current configuration for 'netdev' in 'args'. The caller must
410 * have already initialized 'args' with smap_init(). Returns 0 on success, in
411 * which case 'args' will be filled with 'netdev''s configuration. On failure
412 * returns a positive errno value, in which case 'args' will be empty.
414 * The caller owns 'args' and its contents and must eventually free them with
417 netdev_get_config(const struct netdev *netdev, struct smap *args)
418 OVS_EXCLUDED(netdev_mutex)
423 if (netdev->netdev_class->get_config) {
424 error = netdev->netdev_class->get_config(netdev, args);
435 const struct netdev_tunnel_config *
436 netdev_get_tunnel_config(const struct netdev *netdev)
437 OVS_EXCLUDED(netdev_mutex)
439 if (netdev->netdev_class->get_tunnel_config) {
440 return netdev->netdev_class->get_tunnel_config(netdev);
447 netdev_unref(struct netdev *dev)
448 OVS_RELEASES(netdev_mutex)
450 ovs_assert(dev->ref_cnt);
451 if (!--dev->ref_cnt) {
452 const struct netdev_class *class = dev->netdev_class;
453 struct netdev_registered_class *rc;
456 dev->netdev_class->destruct(dev);
458 shash_delete(&netdev_shash, dev->node);
460 dev->netdev_class->dealloc(dev);
461 ovs_mutex_unlock(&netdev_mutex);
463 ovs_rwlock_rdlock(&netdev_class_rwlock);
464 rc = netdev_lookup_class(class->type);
465 atomic_sub(&rc->ref_cnt, 1, &old_ref_cnt);
466 ovs_assert(old_ref_cnt > 0);
467 ovs_rwlock_unlock(&netdev_class_rwlock);
469 ovs_mutex_unlock(&netdev_mutex);
473 /* Closes and destroys 'netdev'. */
475 netdev_close(struct netdev *netdev)
476 OVS_EXCLUDED(netdev_mutex)
479 ovs_mutex_lock(&netdev_mutex);
480 netdev_unref(netdev);
484 /* Parses 'netdev_name_', which is of the form [type@]name into its component
485 * pieces. 'name' and 'type' must be freed by the caller. */
487 netdev_parse_name(const char *netdev_name_, char **name, char **type)
489 char *netdev_name = xstrdup(netdev_name_);
492 separator = strchr(netdev_name, '@');
496 *name = xstrdup(separator + 1);
499 *type = xstrdup("system");
504 netdev_rx_open(struct netdev *netdev, struct netdev_rx **rxp)
505 OVS_EXCLUDED(netdev_mutex)
509 if (netdev->netdev_class->rx_alloc) {
510 struct netdev_rx *rx = netdev->netdev_class->rx_alloc();
513 error = netdev->netdev_class->rx_construct(rx);
515 ovs_mutex_lock(&netdev_mutex);
517 ovs_mutex_unlock(&netdev_mutex);
522 netdev->netdev_class->rx_dealloc(rx);
535 netdev_rx_close(struct netdev_rx *rx)
536 OVS_EXCLUDED(netdev_mutex)
539 struct netdev *netdev = rx->netdev;
540 netdev->netdev_class->rx_destruct(rx);
541 netdev->netdev_class->rx_dealloc(rx);
542 netdev_close(netdev);
547 netdev_rx_recv(struct netdev_rx *rx, struct ofpbuf *buffer)
551 ovs_assert(buffer->size == 0);
552 ovs_assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
554 retval = rx->netdev->netdev_class->rx_recv(rx, buffer->data,
555 ofpbuf_tailroom(buffer));
557 COVERAGE_INC(netdev_received);
558 buffer->size += retval;
559 if (buffer->size < ETH_TOTAL_MIN) {
560 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
569 netdev_rx_wait(struct netdev_rx *rx)
571 rx->netdev->netdev_class->rx_wait(rx);
575 netdev_rx_drain(struct netdev_rx *rx)
577 return (rx->netdev->netdev_class->rx_drain
578 ? rx->netdev->netdev_class->rx_drain(rx)
582 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
583 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
584 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
585 * the packet is too big or too small to transmit on the device.
587 * The caller retains ownership of 'buffer' in all cases.
589 * The kernel maintains a packet transmission queue, so the caller is not
590 * expected to do additional queuing of packets.
592 * Some network devices may not implement support for this function. In such
593 * cases this function will always return EOPNOTSUPP. */
595 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
599 error = (netdev->netdev_class->send
600 ? netdev->netdev_class->send(netdev, buffer->data, buffer->size)
603 COVERAGE_INC(netdev_sent);
608 /* Registers with the poll loop to wake up from the next call to poll_block()
609 * when the packet transmission queue has sufficient room to transmit a packet
610 * with netdev_send().
612 * The kernel maintains a packet transmission queue, so the client is not
613 * expected to do additional queuing of packets. Thus, this function is
614 * unlikely to ever be used. It is included for completeness. */
616 netdev_send_wait(struct netdev *netdev)
618 if (netdev->netdev_class->send_wait) {
619 netdev->netdev_class->send_wait(netdev);
623 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
624 * otherwise a positive errno value. */
626 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
628 return netdev->netdev_class->set_etheraddr(netdev, mac);
631 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
632 * the MAC address into 'mac'. On failure, returns a positive errno value and
633 * clears 'mac' to all-zeros. */
635 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
637 return netdev->netdev_class->get_etheraddr(netdev, mac);
640 /* Returns the name of the network device that 'netdev' represents,
641 * e.g. "eth0". The caller must not modify or free the returned string. */
643 netdev_get_name(const struct netdev *netdev)
648 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
649 * (and received) packets, in bytes, not including the hardware header; thus,
650 * this is typically 1500 bytes for Ethernet devices.
652 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
653 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
654 * On other failure, returns a positive errno value. On failure, sets '*mtup'
657 netdev_get_mtu(const struct netdev *netdev, int *mtup)
659 const struct netdev_class *class = netdev->netdev_class;
662 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
665 if (error != EOPNOTSUPP) {
666 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
667 "%s", netdev_get_name(netdev), ovs_strerror(error));
673 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
674 * (and received) packets, in bytes.
676 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
677 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
680 netdev_set_mtu(const struct netdev *netdev, int mtu)
682 const struct netdev_class *class = netdev->netdev_class;
685 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
686 if (error && error != EOPNOTSUPP) {
687 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
688 netdev_get_name(netdev), ovs_strerror(error));
694 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
695 * failure, returns a negative errno value.
697 * The desired semantics of the ifindex value are a combination of those
698 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
699 * value should be unique within a host and remain stable at least until
700 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
701 * but many systems do not follow this rule anyhow.
703 * Some network devices may not implement support for this function. In such
704 * cases this function will always return -EOPNOTSUPP.
707 netdev_get_ifindex(const struct netdev *netdev)
709 int (*get_ifindex)(const struct netdev *);
711 get_ifindex = netdev->netdev_class->get_ifindex;
713 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
716 /* Stores the features supported by 'netdev' into each of '*current',
717 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
718 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
719 * successful, otherwise a positive errno value. On failure, all of the
720 * passed-in values are set to 0.
722 * Some network devices may not implement support for this function. In such
723 * cases this function will always return EOPNOTSUPP. */
725 netdev_get_features(const struct netdev *netdev,
726 enum netdev_features *current,
727 enum netdev_features *advertised,
728 enum netdev_features *supported,
729 enum netdev_features *peer)
731 int (*get_features)(const struct netdev *netdev,
732 enum netdev_features *current,
733 enum netdev_features *advertised,
734 enum netdev_features *supported,
735 enum netdev_features *peer);
736 enum netdev_features dummy[4];
743 advertised = &dummy[1];
746 supported = &dummy[2];
752 get_features = netdev->netdev_class->get_features;
754 ? get_features(netdev, current, advertised, supported,
758 *current = *advertised = *supported = *peer = 0;
763 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
764 * bits in 'features', in bits per second. If no bits that indicate a speed
765 * are set in 'features', returns 'default_bps'. */
767 netdev_features_to_bps(enum netdev_features features,
768 uint64_t default_bps)
771 F_1000000MB = NETDEV_F_1TB_FD,
772 F_100000MB = NETDEV_F_100GB_FD,
773 F_40000MB = NETDEV_F_40GB_FD,
774 F_10000MB = NETDEV_F_10GB_FD,
775 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
776 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
777 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
780 return ( features & F_1000000MB ? UINT64_C(1000000000000)
781 : features & F_100000MB ? UINT64_C(100000000000)
782 : features & F_40000MB ? UINT64_C(40000000000)
783 : features & F_10000MB ? UINT64_C(10000000000)
784 : features & F_1000MB ? UINT64_C(1000000000)
785 : features & F_100MB ? UINT64_C(100000000)
786 : features & F_10MB ? UINT64_C(10000000)
790 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
791 * are set in 'features', otherwise false. */
793 netdev_features_is_full_duplex(enum netdev_features features)
795 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
796 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
797 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
800 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
801 * successful, otherwise a positive errno value. */
803 netdev_set_advertisements(struct netdev *netdev,
804 enum netdev_features advertise)
806 return (netdev->netdev_class->set_advertisements
807 ? netdev->netdev_class->set_advertisements(
812 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
813 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
814 * errno value and sets '*address' to 0 (INADDR_ANY).
816 * The following error values have well-defined meanings:
818 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
820 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
822 * 'address' or 'netmask' or both may be null, in which case the address or
823 * netmask is not reported. */
825 netdev_get_in4(const struct netdev *netdev,
826 struct in_addr *address_, struct in_addr *netmask_)
828 struct in_addr address;
829 struct in_addr netmask;
832 error = (netdev->netdev_class->get_in4
833 ? netdev->netdev_class->get_in4(netdev,
837 address_->s_addr = error ? 0 : address.s_addr;
840 netmask_->s_addr = error ? 0 : netmask.s_addr;
845 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
846 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
847 * positive errno value. */
849 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
851 return (netdev->netdev_class->set_in4
852 ? netdev->netdev_class->set_in4(netdev, addr, mask)
856 /* Obtains ad IPv4 address from device name and save the address in
857 * in4. Returns 0 if successful, otherwise a positive errno value.
860 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
862 struct netdev *netdev;
865 error = netdev_open(device_name, "system", &netdev);
867 in4->s_addr = htonl(0);
871 error = netdev_get_in4(netdev, in4, NULL);
872 netdev_close(netdev);
876 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
879 netdev_add_router(struct netdev *netdev, struct in_addr router)
881 COVERAGE_INC(netdev_add_router);
882 return (netdev->netdev_class->add_router
883 ? netdev->netdev_class->add_router(netdev, router)
887 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
888 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
889 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
890 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
891 * a directly connected network) in '*next_hop' and a copy of the name of the
892 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
893 * responsible for freeing '*netdev_name' (by calling free()). */
895 netdev_get_next_hop(const struct netdev *netdev,
896 const struct in_addr *host, struct in_addr *next_hop,
899 int error = (netdev->netdev_class->get_next_hop
900 ? netdev->netdev_class->get_next_hop(
901 host, next_hop, netdev_name)
904 next_hop->s_addr = 0;
910 /* Populates 'smap' with status information.
912 * Populates 'smap' with 'netdev' specific status information. This
913 * information may be used to populate the status column of the Interface table
914 * as defined in ovs-vswitchd.conf.db(5). */
916 netdev_get_status(const struct netdev *netdev, struct smap *smap)
918 return (netdev->netdev_class->get_status
919 ? netdev->netdev_class->get_status(netdev, smap)
923 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
924 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
925 * all-zero-bits (in6addr_any).
927 * The following error values have well-defined meanings:
929 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
931 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
933 * 'in6' may be null, in which case the address itself is not reported. */
935 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
937 struct in6_addr dummy;
940 error = (netdev->netdev_class->get_in6
941 ? netdev->netdev_class->get_in6(netdev,
945 memset(in6, 0, sizeof *in6);
950 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
951 * 'on'. Returns 0 if successful, otherwise a positive errno value. */
953 do_update_flags(struct netdev *netdev, enum netdev_flags off,
954 enum netdev_flags on, enum netdev_flags *old_flagsp,
955 struct netdev_saved_flags **sfp)
956 OVS_EXCLUDED(netdev_mutex)
958 struct netdev_saved_flags *sf = NULL;
959 enum netdev_flags old_flags;
962 error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
965 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
966 off || on ? "set" : "get", netdev_get_name(netdev),
967 ovs_strerror(error));
969 } else if ((off || on) && sfp) {
970 enum netdev_flags new_flags = (old_flags & ~off) | on;
971 enum netdev_flags changed_flags = old_flags ^ new_flags;
973 ovs_mutex_lock(&netdev_mutex);
974 *sfp = sf = xmalloc(sizeof *sf);
976 list_push_front(&netdev->saved_flags_list, &sf->node);
977 sf->saved_flags = changed_flags;
978 sf->saved_values = changed_flags & new_flags;
981 ovs_mutex_unlock(&netdev_mutex);
986 *old_flagsp = old_flags;
995 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
996 * Returns 0 if successful, otherwise a positive errno value. On failure,
997 * stores 0 into '*flagsp'. */
999 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1001 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1002 return do_update_flags(netdev, 0, 0, flagsp, NULL);
1005 /* Sets the flags for 'netdev' to 'flags'.
1006 * Returns 0 if successful, otherwise a positive errno value. */
1008 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1009 struct netdev_saved_flags **sfp)
1011 return do_update_flags(netdev, -1, flags, NULL, sfp);
1014 /* Turns on the specified 'flags' on 'netdev':
1016 * - On success, returns 0. If 'sfp' is nonnull, sets '*sfp' to a newly
1017 * allocated 'struct netdev_saved_flags *' that may be passed to
1018 * netdev_restore_flags() to restore the original values of 'flags' on
1019 * 'netdev' (this will happen automatically at program termination if
1020 * netdev_restore_flags() is never called) , or to NULL if no flags were
1023 * - On failure, returns a positive errno value. If 'sfp' is nonnull, sets
1024 * '*sfp' to NULL. */
1026 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1027 struct netdev_saved_flags **sfp)
1029 return do_update_flags(netdev, 0, flags, NULL, sfp);
1032 /* Turns off the specified 'flags' on 'netdev'. See netdev_turn_flags_on() for
1033 * details of the interface. */
1035 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1036 struct netdev_saved_flags **sfp)
1038 return do_update_flags(netdev, flags, 0, NULL, sfp);
1041 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1042 * Does nothing if 'sf' is NULL. */
1044 netdev_restore_flags(struct netdev_saved_flags *sf)
1045 OVS_EXCLUDED(netdev_mutex)
1048 struct netdev *netdev = sf->netdev;
1049 enum netdev_flags old_flags;
1051 netdev->netdev_class->update_flags(netdev,
1052 sf->saved_flags & sf->saved_values,
1053 sf->saved_flags & ~sf->saved_values,
1056 ovs_mutex_lock(&netdev_mutex);
1057 list_remove(&sf->node);
1059 netdev_unref(netdev);
1063 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
1064 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1065 * returns 0. Otherwise, it returns a positive errno value; in particular,
1066 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1068 netdev_arp_lookup(const struct netdev *netdev,
1069 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
1071 int error = (netdev->netdev_class->arp_lookup
1072 ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1075 memset(mac, 0, ETH_ADDR_LEN);
1080 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1082 netdev_get_carrier(const struct netdev *netdev)
1085 enum netdev_flags flags;
1088 netdev_get_flags(netdev, &flags);
1089 if (!(flags & NETDEV_UP)) {
1093 if (!netdev->netdev_class->get_carrier) {
1097 error = netdev->netdev_class->get_carrier(netdev, &carrier);
1099 VLOG_DBG("%s: failed to get network device carrier status, assuming "
1100 "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1107 /* Returns the number of times 'netdev''s carrier has changed. */
1109 netdev_get_carrier_resets(const struct netdev *netdev)
1111 return (netdev->netdev_class->get_carrier_resets
1112 ? netdev->netdev_class->get_carrier_resets(netdev)
1116 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1117 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
1118 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
1119 * does not support MII, another method may be used as a fallback. If
1120 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1121 * its normal behavior.
1123 * Returns 0 if successful, otherwise a positive errno value. */
1125 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1127 return (netdev->netdev_class->set_miimon_interval
1128 ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1132 /* Retrieves current device stats for 'netdev'. */
1134 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1138 COVERAGE_INC(netdev_get_stats);
1139 error = (netdev->netdev_class->get_stats
1140 ? netdev->netdev_class->get_stats(netdev, stats)
1143 memset(stats, 0xff, sizeof *stats);
1148 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
1149 * Returns 0 if successful, otherwise a positive errno value.
1151 * This will probably fail for most network devices. Some devices might only
1152 * allow setting their stats to 0. */
1154 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
1156 return (netdev->netdev_class->set_stats
1157 ? netdev->netdev_class->set_stats(netdev, stats)
1161 /* Attempts to set input rate limiting (policing) policy, such that up to
1162 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1163 * size of 'kbits' kb. */
1165 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1166 uint32_t kbits_burst)
1168 return (netdev->netdev_class->set_policing
1169 ? netdev->netdev_class->set_policing(netdev,
1170 kbits_rate, kbits_burst)
1174 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1175 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1176 * be documented as valid for the "type" column in the "QoS" table in
1177 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1179 * Every network device supports disabling QoS with a type of "", but this type
1180 * will not be added to 'types'.
1182 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1183 * this function. The caller is responsible for destroying 'types' (e.g. with
1184 * sset_destroy()) when it is no longer needed.
1186 * Returns 0 if successful, otherwise a positive errno value. */
1188 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1190 const struct netdev_class *class = netdev->netdev_class;
1191 return (class->get_qos_types
1192 ? class->get_qos_types(netdev, types)
1196 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1197 * which should be "" or one of the types returned by netdev_get_qos_types()
1198 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1199 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1200 * 'caps' to all zeros. */
1202 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1203 struct netdev_qos_capabilities *caps)
1205 const struct netdev_class *class = netdev->netdev_class;
1208 int retval = (class->get_qos_capabilities
1209 ? class->get_qos_capabilities(netdev, type, caps)
1212 memset(caps, 0, sizeof *caps);
1216 /* Every netdev supports turning off QoS. */
1217 memset(caps, 0, sizeof *caps);
1222 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1223 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1224 * the number of queues (zero on failure) in '*n_queuesp'.
1226 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1228 netdev_get_n_queues(const struct netdev *netdev,
1229 const char *type, unsigned int *n_queuesp)
1231 struct netdev_qos_capabilities caps;
1234 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1235 *n_queuesp = caps.n_queues;
1239 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1240 * stores the name of the current form of QoS into '*typep', stores any details
1241 * of configuration as string key-value pairs in 'details', and returns 0. On
1242 * failure, sets '*typep' to NULL and returns a positive errno value.
1244 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1246 * The caller must initialize 'details' as an empty smap (e.g. with
1247 * smap_init()) before calling this function. The caller must free 'details'
1248 * when it is no longer needed (e.g. with smap_destroy()).
1250 * The caller must not modify or free '*typep'.
1252 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1253 * 'netdev'. The contents of 'details' should be documented as valid for
1254 * '*typep' in the "other_config" column in the "QoS" table in
1255 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1257 netdev_get_qos(const struct netdev *netdev,
1258 const char **typep, struct smap *details)
1260 const struct netdev_class *class = netdev->netdev_class;
1263 if (class->get_qos) {
1264 retval = class->get_qos(netdev, typep, details);
1267 smap_clear(details);
1271 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1277 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1278 * with details of configuration from 'details'. Returns 0 if successful,
1279 * otherwise a positive errno value. On error, the previous QoS configuration
1282 * When this function changes the type of QoS (not just 'details'), this also
1283 * resets all queue configuration for 'netdev' to their defaults (which depend
1284 * on the specific type of QoS). Otherwise, the queue configuration for
1285 * 'netdev' is unchanged.
1287 * 'type' should be "" (to disable QoS) or one of the types returned by
1288 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1289 * documented as valid for the given 'type' in the "other_config" column in the
1290 * "QoS" table in vswitchd/vswitch.xml (which is built as
1291 * ovs-vswitchd.conf.db(8)).
1293 * NULL may be specified for 'details' if there are no configuration
1296 netdev_set_qos(struct netdev *netdev,
1297 const char *type, const struct smap *details)
1299 const struct netdev_class *class = netdev->netdev_class;
1305 if (class->set_qos) {
1307 static const struct smap empty = SMAP_INITIALIZER(&empty);
1310 return class->set_qos(netdev, type, details);
1312 return *type ? EOPNOTSUPP : 0;
1316 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1317 * successful, adds that information as string key-value pairs to 'details'.
1318 * Returns 0 if successful, otherwise a positive errno value.
1320 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1321 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1323 * The returned contents of 'details' should be documented as valid for the
1324 * given 'type' in the "other_config" column in the "Queue" table in
1325 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1327 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1328 * this function. The caller must free 'details' when it is no longer needed
1329 * (e.g. with smap_destroy()). */
1331 netdev_get_queue(const struct netdev *netdev,
1332 unsigned int queue_id, struct smap *details)
1334 const struct netdev_class *class = netdev->netdev_class;
1337 retval = (class->get_queue
1338 ? class->get_queue(netdev, queue_id, details)
1341 smap_clear(details);
1346 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1347 * string pairs in 'details'. The contents of 'details' should be documented
1348 * as valid for the given 'type' in the "other_config" column in the "Queue"
1349 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1350 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1351 * given queue's configuration should be unmodified.
1353 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1354 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1356 * This function does not modify 'details', and the caller retains ownership of
1359 netdev_set_queue(struct netdev *netdev,
1360 unsigned int queue_id, const struct smap *details)
1362 const struct netdev_class *class = netdev->netdev_class;
1363 return (class->set_queue
1364 ? class->set_queue(netdev, queue_id, details)
1368 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1369 * of QoS may have a fixed set of queues, in which case attempts to delete them
1370 * will fail with EOPNOTSUPP.
1372 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1373 * given queue will be unmodified.
1375 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1376 * the current form of QoS (e.g. as returned by
1377 * netdev_get_n_queues(netdev)). */
1379 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1381 const struct netdev_class *class = netdev->netdev_class;
1382 return (class->delete_queue
1383 ? class->delete_queue(netdev, queue_id)
1387 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1388 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1389 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1390 * positive errno value and fills 'stats' with values indicating unsupported
1393 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1394 struct netdev_queue_stats *stats)
1396 const struct netdev_class *class = netdev->netdev_class;
1399 retval = (class->get_queue_stats
1400 ? class->get_queue_stats(netdev, queue_id, stats)
1403 stats->tx_bytes = UINT64_MAX;
1404 stats->tx_packets = UINT64_MAX;
1405 stats->tx_errors = UINT64_MAX;
1406 stats->created = LLONG_MIN;
1411 /* Initializes 'dump' to begin dumping the queues in a netdev.
1413 * This function provides no status indication. An error status for the entire
1414 * dump operation is provided when it is completed by calling
1415 * netdev_queue_dump_done().
1418 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1419 const struct netdev *netdev)
1421 dump->netdev = netdev_ref(netdev);
1422 if (netdev->netdev_class->queue_dump_start) {
1423 dump->error = netdev->netdev_class->queue_dump_start(netdev,
1426 dump->error = EOPNOTSUPP;
1430 /* Attempts to retrieve another queue from 'dump', which must have been
1431 * initialized with netdev_queue_dump_start(). On success, stores a new queue
1432 * ID into '*queue_id', fills 'details' with configuration details for the
1433 * queue, and returns true. On failure, returns false.
1435 * Queues are not necessarily dumped in increasing order of queue ID (or any
1436 * other predictable order).
1438 * Failure might indicate an actual error or merely that the last queue has
1439 * been dumped. An error status for the entire dump operation is provided when
1440 * it is completed by calling netdev_queue_dump_done().
1442 * The returned contents of 'details' should be documented as valid for the
1443 * given 'type' in the "other_config" column in the "Queue" table in
1444 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1446 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1447 * this function. This function will clear and replace its contents. The
1448 * caller must free 'details' when it is no longer needed (e.g. with
1449 * smap_destroy()). */
1451 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1452 unsigned int *queue_id, struct smap *details)
1454 const struct netdev *netdev = dump->netdev;
1460 dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1464 netdev->netdev_class->queue_dump_done(netdev, dump->state);
1470 /* Completes queue table dump operation 'dump', which must have been
1471 * initialized with netdev_queue_dump_start(). Returns 0 if the dump operation
1472 * was error-free, otherwise a positive errno value describing the problem. */
1474 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1476 const struct netdev *netdev = dump->netdev;
1477 if (!dump->error && netdev->netdev_class->queue_dump_done) {
1478 dump->error = netdev->netdev_class->queue_dump_done(netdev,
1481 netdev_close(dump->netdev);
1482 return dump->error == EOF ? 0 : dump->error;
1485 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1486 * its statistics, and the 'aux' specified by the caller. The order of
1487 * iteration is unspecified, but (when successful) each queue is visited
1490 * Calling this function may be more efficient than calling
1491 * netdev_get_queue_stats() for every queue.
1493 * 'cb' must not modify or free the statistics passed in.
1495 * Returns 0 if successful, otherwise a positive errno value. On error, some
1496 * configured queues may not have been included in the iteration. */
1498 netdev_dump_queue_stats(const struct netdev *netdev,
1499 netdev_dump_queue_stats_cb *cb, void *aux)
1501 const struct netdev_class *class = netdev->netdev_class;
1502 return (class->dump_queue_stats
1503 ? class->dump_queue_stats(netdev, cb, aux)
1508 /* Returns the class type of 'netdev'.
1510 * The caller must not free the returned value. */
1512 netdev_get_type(const struct netdev *netdev)
1514 return netdev->netdev_class->type;
1517 /* Returns the class associated with 'netdev'. */
1518 const struct netdev_class *
1519 netdev_get_class(const struct netdev *netdev)
1521 return netdev->netdev_class;
1524 /* Returns the netdev with 'name' or NULL if there is none.
1526 * The caller must free the returned netdev with netdev_close(). */
1528 netdev_from_name(const char *name)
1529 OVS_EXCLUDED(netdev_mutex)
1531 struct netdev *netdev;
1533 ovs_mutex_lock(&netdev_mutex);
1534 netdev = shash_find_data(&netdev_shash, name);
1538 ovs_mutex_unlock(&netdev_mutex);
1543 /* Fills 'device_list' with devices that match 'netdev_class'.
1545 * The caller is responsible for initializing and destroying 'device_list' and
1546 * must close each device on the list. */
1548 netdev_get_devices(const struct netdev_class *netdev_class,
1549 struct shash *device_list)
1550 OVS_EXCLUDED(netdev_mutex)
1552 struct shash_node *node;
1554 ovs_mutex_lock(&netdev_mutex);
1555 SHASH_FOR_EACH (node, &netdev_shash) {
1556 struct netdev *dev = node->data;
1558 if (dev->netdev_class == netdev_class) {
1560 shash_add(device_list, node->name, node->data);
1563 ovs_mutex_unlock(&netdev_mutex);
1567 netdev_get_type_from_name(const char *name)
1569 struct netdev *dev = netdev_from_name(name);
1570 const char *type = dev ? netdev_get_type(dev) : NULL;
1576 netdev_rx_get_netdev(const struct netdev_rx *rx)
1578 ovs_assert(rx->netdev->ref_cnt > 0);
1583 netdev_rx_get_name(const struct netdev_rx *rx)
1585 return netdev_get_name(netdev_rx_get_netdev(rx));
1589 restore_all_flags(void *aux OVS_UNUSED)
1591 struct shash_node *node;
1593 SHASH_FOR_EACH (node, &netdev_shash) {
1594 struct netdev *netdev = node->data;
1595 const struct netdev_saved_flags *sf;
1596 enum netdev_flags saved_values;
1597 enum netdev_flags saved_flags;
1599 saved_values = saved_flags = 0;
1600 LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1601 saved_flags |= sf->saved_flags;
1602 saved_values &= ~sf->saved_flags;
1603 saved_values |= sf->saved_flags & sf->saved_values;
1606 enum netdev_flags old_flags;
1608 netdev->netdev_class->update_flags(netdev,
1609 saved_flags & saved_values,
1610 saved_flags & ~saved_values,