2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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.
23 #include <netinet/in.h>
29 #include "dynamic-string.h"
30 #include "fatal-signal.h"
33 #include "netdev-provider.h"
34 #include "netdev-vport.h"
36 #include "openflow/openflow.h"
38 #include "poll-loop.h"
45 VLOG_DEFINE_THIS_MODULE(netdev);
47 COVERAGE_DEFINE(netdev_received);
48 COVERAGE_DEFINE(netdev_sent);
49 COVERAGE_DEFINE(netdev_add_router);
50 COVERAGE_DEFINE(netdev_get_stats);
52 static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
54 /* All created network devices. */
55 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
57 /* All open network devices. */
58 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
60 /* This is set pretty low because we probably won't learn anything from the
61 * additional log messages. */
62 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
64 static void close_all_netdevs(void *aux OVS_UNUSED);
65 static int restore_flags(struct netdev *netdev);
66 void update_device_args(struct netdev_dev *, const struct shash *args);
69 netdev_initialize(void)
76 fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
79 netdev_register_provider(&netdev_linux_class);
80 netdev_register_provider(&netdev_internal_class);
81 netdev_register_provider(&netdev_tap_class);
82 netdev_vport_register();
87 /* Performs periodic work needed by all the various kinds of netdevs.
89 * If your program opens any netdevs, it must call this function within its
94 struct shash_node *node;
95 SHASH_FOR_EACH(node, &netdev_classes) {
96 const struct netdev_class *netdev_class = node->data;
97 if (netdev_class->run) {
103 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
105 * If your program opens any netdevs, it must call this function within its
110 struct shash_node *node;
111 SHASH_FOR_EACH(node, &netdev_classes) {
112 const struct netdev_class *netdev_class = node->data;
113 if (netdev_class->wait) {
114 netdev_class->wait();
119 /* Initializes and registers a new netdev provider. After successful
120 * registration, new netdevs of that type can be opened using netdev_open(). */
122 netdev_register_provider(const struct netdev_class *new_class)
124 if (shash_find(&netdev_classes, new_class->type)) {
125 VLOG_WARN("attempted to register duplicate netdev provider: %s",
130 if (new_class->init) {
131 int error = new_class->init();
133 VLOG_ERR("failed to initialize %s network device class: %s",
134 new_class->type, strerror(error));
139 shash_add(&netdev_classes, new_class->type, new_class);
144 /* Unregisters a netdev provider. 'type' must have been previously
145 * registered and not currently be in use by any netdevs. After unregistration
146 * new netdevs of that type cannot be opened using netdev_open(). */
148 netdev_unregister_provider(const char *type)
150 struct shash_node *del_node, *netdev_dev_node;
152 del_node = shash_find(&netdev_classes, type);
154 VLOG_WARN("attempted to unregister a netdev provider that is not "
155 "registered: %s", type);
159 SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
160 struct netdev_dev *netdev_dev = netdev_dev_node->data;
161 if (!strcmp(netdev_dev->netdev_class->type, type)) {
162 VLOG_WARN("attempted to unregister in use netdev provider: %s",
168 shash_delete(&netdev_classes, del_node);
173 const struct netdev_class *
174 netdev_lookup_provider(const char *type)
177 return shash_find_data(&netdev_classes, type && type[0] ? type : "system");
180 /* Clears 'types' and enumerates the types of all currently registered netdev
181 * providers into it. The caller must first initialize the sset. */
183 netdev_enumerate_types(struct sset *types)
185 struct shash_node *node;
190 SHASH_FOR_EACH(node, &netdev_classes) {
191 const struct netdev_class *netdev_class = node->data;
192 sset_add(types, netdev_class->type);
196 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
197 * (e.g. "system") and returns zero if successful, otherwise a positive errno
198 * value. On success, sets '*netdevp' to the new network device, otherwise to
201 * Some network devices may need to be configured (with netdev_set_config())
202 * before they can be used. */
204 netdev_open(const char *name, const char *type, struct netdev **netdevp)
206 struct netdev_dev *netdev_dev;
212 netdev_dev = shash_find_data(&netdev_dev_shash, name);
215 const struct netdev_class *class;
217 class = netdev_lookup_provider(type);
219 VLOG_WARN("could not create netdev %s of unknown type %s",
223 error = class->create(class, name, &netdev_dev);
227 assert(netdev_dev->netdev_class == class);
231 error = netdev_dev->netdev_class->open(netdev_dev, netdevp);
234 netdev_dev->ref_cnt++;
236 if (!netdev_dev->ref_cnt) {
237 netdev_dev_uninit(netdev_dev, true);
244 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
245 * or NULL if none are needed. */
247 netdev_set_config(struct netdev *netdev, const struct smap *args)
249 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
251 if (netdev_dev->netdev_class->set_config) {
252 struct smap no_args = SMAP_INITIALIZER(&no_args);
253 return netdev_dev->netdev_class->set_config(netdev_dev,
254 args ? args : &no_args);
255 } else if (args && !smap_is_empty(args)) {
256 VLOG_WARN("%s: arguments provided to device that is not configurable",
257 netdev_get_name(netdev));
263 /* Returns the current configuration for 'netdev' in 'args'. The caller must
264 * have already initialized 'args' with smap_init(). Returns 0 on success, in
265 * which case 'args' will be filled with 'netdev''s configuration. On failure
266 * returns a positive errno value, in which case 'args' will be empty.
268 * The caller owns 'args' and its contents and must eventually free them with
271 netdev_get_config(const struct netdev *netdev, struct smap *args)
273 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
277 if (netdev_dev->netdev_class->get_config) {
278 error = netdev_dev->netdev_class->get_config(netdev_dev, args);
289 /* Closes and destroys 'netdev'. */
291 netdev_close(struct netdev *netdev)
294 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
296 assert(netdev_dev->ref_cnt);
297 netdev_dev->ref_cnt--;
298 netdev_uninit(netdev, true);
300 /* If the reference count for the netdev device is zero, destroy it. */
301 if (!netdev_dev->ref_cnt) {
302 netdev_dev_uninit(netdev_dev, true);
307 /* Returns true if a network device named 'name' exists and may be opened,
308 * otherwise false. */
310 netdev_exists(const char *name)
312 struct netdev *netdev;
315 error = netdev_open(name, "system", &netdev);
317 netdev_close(netdev);
320 if (error != ENODEV) {
321 VLOG_WARN("failed to open network device %s: %s",
322 name, strerror(error));
328 /* Returns true if a network device named 'name' is currently opened,
329 * otherwise false. */
331 netdev_is_open(const char *name)
333 return !!shash_find_data(&netdev_dev_shash, name);
336 /* Parses 'netdev_name_', which is of the form [type@]name into its component
337 * pieces. 'name' and 'type' must be freed by the caller. */
339 netdev_parse_name(const char *netdev_name_, char **name, char **type)
341 char *netdev_name = xstrdup(netdev_name_);
344 separator = strchr(netdev_name, '@');
348 *name = xstrdup(separator + 1);
351 *type = xstrdup("system");
355 /* Attempts to set up 'netdev' for receiving packets with netdev_recv().
356 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
357 * indicates that the network device does not implement packet reception
358 * through this interface. */
360 netdev_listen(struct netdev *netdev)
362 int (*listen)(struct netdev *);
364 listen = netdev_get_dev(netdev)->netdev_class->listen;
365 return listen ? (listen)(netdev) : EOPNOTSUPP;
368 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
369 * must have initialized with sufficient room for the packet. The space
370 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
371 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
372 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
373 * need not be included.)
375 * This function can only be expected to return a packet if ->listen() has
376 * been called successfully.
378 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
379 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
380 * positive errno value. Returns EAGAIN immediately if no packet is ready to
383 * Some network devices may not implement support for this function. In such
384 * cases this function will always return EOPNOTSUPP. */
386 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
388 int (*recv)(struct netdev *, void *, size_t);
391 assert(buffer->size == 0);
392 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
394 recv = netdev_get_dev(netdev)->netdev_class->recv;
396 ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
399 COVERAGE_INC(netdev_received);
400 buffer->size += retval;
401 if (buffer->size < ETH_TOTAL_MIN) {
402 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
410 /* Registers with the poll loop to wake up from the next call to poll_block()
411 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
413 netdev_recv_wait(struct netdev *netdev)
415 void (*recv_wait)(struct netdev *);
417 recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
423 /* Discards all packets waiting to be received from 'netdev'. */
425 netdev_drain(struct netdev *netdev)
427 int (*drain)(struct netdev *);
429 drain = netdev_get_dev(netdev)->netdev_class->drain;
430 return drain ? drain(netdev) : 0;
433 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
434 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
435 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
436 * the packet is too big or too small to transmit on the device.
438 * The caller retains ownership of 'buffer' in all cases.
440 * The kernel maintains a packet transmission queue, so the caller is not
441 * expected to do additional queuing of packets.
443 * Some network devices may not implement support for this function. In such
444 * cases this function will always return EOPNOTSUPP. */
446 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
448 int (*send)(struct netdev *, const void *, size_t);
451 send = netdev_get_dev(netdev)->netdev_class->send;
452 error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
454 COVERAGE_INC(netdev_sent);
459 /* Registers with the poll loop to wake up from the next call to poll_block()
460 * when the packet transmission queue has sufficient room to transmit a packet
461 * with netdev_send().
463 * The kernel maintains a packet transmission queue, so the client is not
464 * expected to do additional queuing of packets. Thus, this function is
465 * unlikely to ever be used. It is included for completeness. */
467 netdev_send_wait(struct netdev *netdev)
469 void (*send_wait)(struct netdev *);
471 send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
477 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
478 * otherwise a positive errno value. */
480 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
482 return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
485 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
486 * the MAC address into 'mac'. On failure, returns a positive errno value and
487 * clears 'mac' to all-zeros. */
489 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
491 return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
494 /* Returns the name of the network device that 'netdev' represents,
495 * e.g. "eth0". The caller must not modify or free the returned string. */
497 netdev_get_name(const struct netdev *netdev)
499 return netdev_get_dev(netdev)->name;
502 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
503 * (and received) packets, in bytes, not including the hardware header; thus,
504 * this is typically 1500 bytes for Ethernet devices.
506 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
507 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
508 * On other failure, returns a positive errno value. On failure, sets '*mtup'
511 netdev_get_mtu(const struct netdev *netdev, int *mtup)
513 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
516 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
519 if (error != EOPNOTSUPP) {
520 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
521 "%s", netdev_get_name(netdev), strerror(error));
527 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
528 * (and received) packets, in bytes.
530 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
531 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
534 netdev_set_mtu(const struct netdev *netdev, int mtu)
536 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
539 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
540 if (error && error != EOPNOTSUPP) {
541 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
542 netdev_get_name(netdev), strerror(error));
548 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
549 * failure, returns a negative errno value.
551 * The desired semantics of the ifindex value are a combination of those
552 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
553 * value should be unique within a host and remain stable at least until
554 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
555 * but many systems do not follow this rule anyhow.
557 * Some network devices may not implement support for this function. In such
558 * cases this function will always return -EOPNOTSUPP.
561 netdev_get_ifindex(const struct netdev *netdev)
563 int (*get_ifindex)(const struct netdev *);
565 get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
567 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
570 /* Stores the features supported by 'netdev' into each of '*current',
571 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
572 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
573 * successful, otherwise a positive errno value. On failure, all of the
574 * passed-in values are set to 0.
576 * Some network devices may not implement support for this function. In such
577 * cases this function will always return EOPNOTSUPP. */
579 netdev_get_features(const struct netdev *netdev,
580 enum netdev_features *current,
581 enum netdev_features *advertised,
582 enum netdev_features *supported,
583 enum netdev_features *peer)
585 int (*get_features)(const struct netdev *netdev,
586 enum netdev_features *current,
587 enum netdev_features *advertised,
588 enum netdev_features *supported,
589 enum netdev_features *peer);
590 enum netdev_features dummy[4];
597 advertised = &dummy[1];
600 supported = &dummy[2];
606 get_features = netdev_get_dev(netdev)->netdev_class->get_features;
608 ? get_features(netdev, current, advertised, supported,
612 *current = *advertised = *supported = *peer = 0;
617 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
618 * bits in 'features', in bits per second. If no bits that indicate a speed
619 * are set in 'features', assumes 100Mbps. */
621 netdev_features_to_bps(enum netdev_features features)
624 F_1000000MB = NETDEV_F_1TB_FD,
625 F_100000MB = NETDEV_F_100GB_FD,
626 F_40000MB = NETDEV_F_40GB_FD,
627 F_10000MB = NETDEV_F_10GB_FD,
628 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
629 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
630 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
633 return ( features & F_1000000MB ? UINT64_C(1000000000000)
634 : features & F_100000MB ? UINT64_C(100000000000)
635 : features & F_40000MB ? UINT64_C(40000000000)
636 : features & F_10000MB ? UINT64_C(10000000000)
637 : features & F_1000MB ? UINT64_C(1000000000)
638 : features & F_100MB ? UINT64_C(100000000)
639 : features & F_10MB ? UINT64_C(10000000)
640 : UINT64_C(100000000));
643 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
644 * are set in 'features', otherwise false. */
646 netdev_features_is_full_duplex(enum netdev_features features)
648 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
649 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
650 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
653 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
654 * successful, otherwise a positive errno value. */
656 netdev_set_advertisements(struct netdev *netdev,
657 enum netdev_features advertise)
659 return (netdev_get_dev(netdev)->netdev_class->set_advertisements
660 ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
665 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
666 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
667 * errno value and sets '*address' to 0 (INADDR_ANY).
669 * The following error values have well-defined meanings:
671 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
673 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
675 * 'address' or 'netmask' or both may be null, in which case the address or
676 * netmask is not reported. */
678 netdev_get_in4(const struct netdev *netdev,
679 struct in_addr *address_, struct in_addr *netmask_)
681 struct in_addr address;
682 struct in_addr netmask;
685 error = (netdev_get_dev(netdev)->netdev_class->get_in4
686 ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
690 address_->s_addr = error ? 0 : address.s_addr;
693 netmask_->s_addr = error ? 0 : netmask.s_addr;
698 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
699 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
700 * positive errno value. */
702 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
704 return (netdev_get_dev(netdev)->netdev_class->set_in4
705 ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
709 /* Obtains ad IPv4 address from device name and save the address in
710 * in4. Returns 0 if successful, otherwise a positive errno value.
713 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
715 struct netdev *netdev;
718 error = netdev_open(device_name, "system", &netdev);
720 in4->s_addr = htonl(0);
724 error = netdev_get_in4(netdev, in4, NULL);
725 netdev_close(netdev);
729 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
732 netdev_add_router(struct netdev *netdev, struct in_addr router)
734 COVERAGE_INC(netdev_add_router);
735 return (netdev_get_dev(netdev)->netdev_class->add_router
736 ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
740 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
741 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
742 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
743 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
744 * a directly connected network) in '*next_hop' and a copy of the name of the
745 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
746 * responsible for freeing '*netdev_name' (by calling free()). */
748 netdev_get_next_hop(const struct netdev *netdev,
749 const struct in_addr *host, struct in_addr *next_hop,
752 int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
753 ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
754 host, next_hop, netdev_name)
757 next_hop->s_addr = 0;
763 /* Populates 'smap' with status information.
765 * Populates 'smap' with 'netdev' specific status information. This
766 * information may be used to populate the status column of the Interface table
767 * as defined in ovs-vswitchd.conf.db(5). */
769 netdev_get_drv_info(const struct netdev *netdev, struct smap *smap)
771 struct netdev_dev *dev = netdev_get_dev(netdev);
773 return (dev->netdev_class->get_drv_info
774 ? dev->netdev_class->get_drv_info(netdev, smap)
778 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
779 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
780 * all-zero-bits (in6addr_any).
782 * The following error values have well-defined meanings:
784 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
786 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
788 * 'in6' may be null, in which case the address itself is not reported. */
790 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
792 struct in6_addr dummy;
795 error = (netdev_get_dev(netdev)->netdev_class->get_in6
796 ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
800 memset(in6, 0, sizeof *in6);
805 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
806 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
807 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
808 * successful, otherwise a positive errno value. */
810 do_update_flags(struct netdev *netdev, enum netdev_flags off,
811 enum netdev_flags on, enum netdev_flags *old_flagsp,
814 enum netdev_flags old_flags;
817 error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
818 off & ~on, on, &old_flags);
820 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
821 off || on ? "set" : "get", netdev_get_name(netdev),
824 } else if ((off || on) && !permanent) {
825 enum netdev_flags new_flags = (old_flags & ~off) | on;
826 enum netdev_flags changed_flags = old_flags ^ new_flags;
828 if (!netdev->changed_flags) {
829 netdev->save_flags = old_flags;
831 netdev->changed_flags |= changed_flags;
835 *old_flagsp = old_flags;
840 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
841 * Returns 0 if successful, otherwise a positive errno value. On failure,
842 * stores 0 into '*flagsp'. */
844 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
846 struct netdev *netdev = (struct netdev *) netdev_;
847 return do_update_flags(netdev, 0, 0, flagsp, false);
850 /* Sets the flags for 'netdev' to 'flags'.
851 * If 'permanent' is true, the changes will persist; otherwise, they
852 * will be reverted when 'netdev' is closed or the program exits.
853 * Returns 0 if successful, otherwise a positive errno value. */
855 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
858 return do_update_flags(netdev, -1, flags, NULL, permanent);
861 /* Turns on the specified 'flags' on 'netdev'.
862 * If 'permanent' is true, the changes will persist; otherwise, they
863 * will be reverted when 'netdev' is closed or the program exits.
864 * Returns 0 if successful, otherwise a positive errno value. */
866 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
869 return do_update_flags(netdev, 0, flags, NULL, permanent);
872 /* Turns off the specified 'flags' on 'netdev'.
873 * If 'permanent' is true, the changes will persist; otherwise, they
874 * will be reverted when 'netdev' is closed or the program exits.
875 * Returns 0 if successful, otherwise a positive errno value. */
877 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
880 return do_update_flags(netdev, flags, 0, NULL, permanent);
883 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
884 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
885 * returns 0. Otherwise, it returns a positive errno value; in particular,
886 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
888 netdev_arp_lookup(const struct netdev *netdev,
889 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
891 int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
892 ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
896 memset(mac, 0, ETH_ADDR_LEN);
901 /* Returns true if carrier is active (link light is on) on 'netdev'. */
903 netdev_get_carrier(const struct netdev *netdev)
906 enum netdev_flags flags;
909 netdev_get_flags(netdev, &flags);
910 if (!(flags & NETDEV_UP)) {
914 if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
918 error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
921 VLOG_DBG("%s: failed to get network device carrier status, assuming "
922 "down: %s", netdev_get_name(netdev), strerror(error));
929 /* Returns the number of times 'netdev''s carrier has changed. */
931 netdev_get_carrier_resets(const struct netdev *netdev)
933 return (netdev_get_dev(netdev)->netdev_class->get_carrier_resets
934 ? netdev_get_dev(netdev)->netdev_class->get_carrier_resets(netdev)
938 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
939 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
940 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
941 * does not support MII, another method may be used as a fallback. If
942 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
943 * its normal behavior.
945 * Returns 0 if successful, otherwise a positive errno value. */
947 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
949 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
950 return (netdev_dev->netdev_class->set_miimon_interval
951 ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval)
955 /* Retrieves current device stats for 'netdev'. */
957 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
961 COVERAGE_INC(netdev_get_stats);
962 error = (netdev_get_dev(netdev)->netdev_class->get_stats
963 ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
966 memset(stats, 0xff, sizeof *stats);
971 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
972 * Returns 0 if successful, otherwise a positive errno value.
974 * This will probably fail for most network devices. Some devices might only
975 * allow setting their stats to 0. */
977 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
979 return (netdev_get_dev(netdev)->netdev_class->set_stats
980 ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
984 /* Attempts to set input rate limiting (policing) policy, such that up to
985 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
986 * size of 'kbits' kb. */
988 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
989 uint32_t kbits_burst)
991 return (netdev_get_dev(netdev)->netdev_class->set_policing
992 ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
993 kbits_rate, kbits_burst)
997 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
998 * empty if 'netdev' does not support QoS. Any names added to 'types' should
999 * be documented as valid for the "type" column in the "QoS" table in
1000 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1002 * Every network device supports disabling QoS with a type of "", but this type
1003 * will not be added to 'types'.
1005 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1006 * this function. The caller is responsible for destroying 'types' (e.g. with
1007 * sset_destroy()) when it is no longer needed.
1009 * Returns 0 if successful, otherwise a positive errno value. */
1011 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1013 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1014 return (class->get_qos_types
1015 ? class->get_qos_types(netdev, types)
1019 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1020 * which should be "" or one of the types returned by netdev_get_qos_types()
1021 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1022 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1023 * 'caps' to all zeros. */
1025 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1026 struct netdev_qos_capabilities *caps)
1028 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1031 int retval = (class->get_qos_capabilities
1032 ? class->get_qos_capabilities(netdev, type, caps)
1035 memset(caps, 0, sizeof *caps);
1039 /* Every netdev supports turning off QoS. */
1040 memset(caps, 0, sizeof *caps);
1045 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1046 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1047 * the number of queues (zero on failure) in '*n_queuesp'.
1049 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1051 netdev_get_n_queues(const struct netdev *netdev,
1052 const char *type, unsigned int *n_queuesp)
1054 struct netdev_qos_capabilities caps;
1057 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1058 *n_queuesp = caps.n_queues;
1062 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1063 * stores the name of the current form of QoS into '*typep', stores any details
1064 * of configuration as string key-value pairs in 'details', and returns 0. On
1065 * failure, sets '*typep' to NULL and returns a positive errno value.
1067 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1069 * The caller must initialize 'details' as an empty smap (e.g. with
1070 * smap_init()) before calling this function. The caller must free 'details'
1071 * when it is no longer needed (e.g. with smap_destroy()).
1073 * The caller must not modify or free '*typep'.
1075 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1076 * 'netdev'. The contents of 'details' should be documented as valid for
1077 * '*typep' in the "other_config" column in the "QoS" table in
1078 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1080 netdev_get_qos(const struct netdev *netdev,
1081 const char **typep, struct smap *details)
1083 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1086 if (class->get_qos) {
1087 retval = class->get_qos(netdev, typep, details);
1090 smap_clear(details);
1094 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1100 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1101 * with details of configuration from 'details'. Returns 0 if successful,
1102 * otherwise a positive errno value. On error, the previous QoS configuration
1105 * When this function changes the type of QoS (not just 'details'), this also
1106 * resets all queue configuration for 'netdev' to their defaults (which depend
1107 * on the specific type of QoS). Otherwise, the queue configuration for
1108 * 'netdev' is unchanged.
1110 * 'type' should be "" (to disable QoS) or one of the types returned by
1111 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1112 * documented as valid for the given 'type' in the "other_config" column in the
1113 * "QoS" table in vswitchd/vswitch.xml (which is built as
1114 * ovs-vswitchd.conf.db(8)).
1116 * NULL may be specified for 'details' if there are no configuration
1119 netdev_set_qos(struct netdev *netdev,
1120 const char *type, const struct smap *details)
1122 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1128 if (class->set_qos) {
1130 static struct smap empty = SMAP_INITIALIZER(&empty);
1133 return class->set_qos(netdev, type, details);
1135 return *type ? EOPNOTSUPP : 0;
1139 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1140 * successful, adds that information as string key-value pairs to 'details'.
1141 * Returns 0 if successful, otherwise a positive errno value.
1143 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1144 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1146 * The returned contents of 'details' should be documented as valid for the
1147 * given 'type' in the "other_config" column in the "Queue" table in
1148 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1150 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1151 * this function. The caller must free 'details' when it is no longer needed
1152 * (e.g. with smap_destroy()). */
1154 netdev_get_queue(const struct netdev *netdev,
1155 unsigned int queue_id, struct smap *details)
1157 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1160 retval = (class->get_queue
1161 ? class->get_queue(netdev, queue_id, details)
1164 smap_clear(details);
1169 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1170 * string pairs in 'details'. The contents of 'details' should be documented
1171 * as valid for the given 'type' in the "other_config" column in the "Queue"
1172 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1173 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1174 * given queue's configuration should be unmodified.
1176 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1177 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1179 * This function does not modify 'details', and the caller retains ownership of
1182 netdev_set_queue(struct netdev *netdev,
1183 unsigned int queue_id, const struct smap *details)
1185 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1186 return (class->set_queue
1187 ? class->set_queue(netdev, queue_id, details)
1191 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1192 * of QoS may have a fixed set of queues, in which case attempts to delete them
1193 * will fail with EOPNOTSUPP.
1195 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1196 * given queue will be unmodified.
1198 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1199 * the current form of QoS (e.g. as returned by
1200 * netdev_get_n_queues(netdev)). */
1202 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1204 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1205 return (class->delete_queue
1206 ? class->delete_queue(netdev, queue_id)
1210 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1211 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1212 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1213 * positive errno value and fills 'stats' with all-1-bits. */
1215 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1216 struct netdev_queue_stats *stats)
1218 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1221 retval = (class->get_queue_stats
1222 ? class->get_queue_stats(netdev, queue_id, stats)
1225 memset(stats, 0xff, sizeof *stats);
1230 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1231 * its configuration, and the 'aux' specified by the caller. The order of
1232 * iteration is unspecified, but (when successful) each queue is visited
1235 * Calling this function may be more efficient than calling netdev_get_queue()
1238 * 'cb' must not modify or free the 'details' argument passed in. It may
1239 * delete or modify the queue passed in as its 'queue_id' argument. It may
1240 * modify but must not delete any other queue within 'netdev'. 'cb' should not
1241 * add new queues because this may cause some queues to be visited twice or not
1244 * Returns 0 if successful, otherwise a positive errno value. On error, some
1245 * configured queues may not have been included in the iteration. */
1247 netdev_dump_queues(const struct netdev *netdev,
1248 netdev_dump_queues_cb *cb, void *aux)
1250 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1251 return (class->dump_queues
1252 ? class->dump_queues(netdev, cb, aux)
1256 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1257 * its statistics, and the 'aux' specified by the caller. The order of
1258 * iteration is unspecified, but (when successful) each queue is visited
1261 * Calling this function may be more efficient than calling
1262 * netdev_get_queue_stats() for every queue.
1264 * 'cb' must not modify or free the statistics passed in.
1266 * Returns 0 if successful, otherwise a positive errno value. On error, some
1267 * configured queues may not have been included in the iteration. */
1269 netdev_dump_queue_stats(const struct netdev *netdev,
1270 netdev_dump_queue_stats_cb *cb, void *aux)
1272 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1273 return (class->dump_queue_stats
1274 ? class->dump_queue_stats(netdev, cb, aux)
1278 /* Returns a sequence number which indicates changes in one of 'netdev''s
1279 * properties. The returned sequence will be nonzero so that callers have a
1280 * value which they may use as a reset when tracking 'netdev'.
1282 * The returned sequence number will change whenever 'netdev''s flags,
1283 * features, ethernet address, or carrier changes. It may change for other
1284 * reasons as well, or no reason at all. */
1286 netdev_change_seq(const struct netdev *netdev)
1288 return netdev_get_dev(netdev)->netdev_class->change_seq(netdev);
1291 /* Initializes 'netdev_dev' as a netdev device named 'name' of the specified
1292 * 'netdev_class'. This function is ordinarily called from a netdev provider's
1293 * 'create' function.
1295 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1296 * very important that 'netdev_dev' only be freed after calling
1297 * the refcount drops to zero. */
1299 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1300 const struct netdev_class *netdev_class)
1302 assert(!shash_find(&netdev_dev_shash, name));
1304 memset(netdev_dev, 0, sizeof *netdev_dev);
1305 netdev_dev->netdev_class = netdev_class;
1306 netdev_dev->name = xstrdup(name);
1307 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1310 /* Undoes the results of initialization.
1312 * Normally this function does not need to be called as netdev_close has
1313 * the same effect when the refcount drops to zero.
1314 * However, it may be called by providers due to an error on creation
1315 * that occurs after initialization. It this case netdev_close() would
1316 * never be called. */
1318 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1320 char *name = netdev_dev->name;
1322 assert(!netdev_dev->ref_cnt);
1324 shash_delete(&netdev_dev_shash, netdev_dev->node);
1327 netdev_dev->netdev_class->destroy(netdev_dev);
1332 /* Returns the class type of 'netdev_dev'.
1334 * The caller must not free the returned value. */
1336 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1338 return netdev_dev->netdev_class->type;
1341 /* Returns the class associated with 'netdev_dev'. */
1342 const struct netdev_class *
1343 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1345 return netdev_dev->netdev_class;
1348 /* Returns the name of 'netdev_dev'.
1350 * The caller must not free the returned value. */
1352 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1354 return netdev_dev->name;
1357 /* Returns the netdev_dev with 'name' or NULL if there is none.
1359 * The caller must not free the returned value. */
1361 netdev_dev_from_name(const char *name)
1363 return shash_find_data(&netdev_dev_shash, name);
1366 /* Fills 'device_list' with devices that match 'netdev_class'.
1368 * The caller is responsible for initializing and destroying 'device_list'
1369 * but the contained netdev_devs must not be freed. */
1371 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1372 struct shash *device_list)
1374 struct shash_node *node;
1375 SHASH_FOR_EACH (node, &netdev_dev_shash) {
1376 struct netdev_dev *dev = node->data;
1378 if (dev->netdev_class == netdev_class) {
1379 shash_add(device_list, node->name, node->data);
1384 /* Initializes 'netdev' as a instance of the netdev_dev.
1386 * This function adds 'netdev' to a netdev-owned linked list, so it is very
1387 * important that 'netdev' only be freed after calling netdev_close(). */
1389 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1391 memset(netdev, 0, sizeof *netdev);
1392 netdev->netdev_dev = netdev_dev;
1393 list_push_back(&netdev_list, &netdev->node);
1396 /* Undoes the results of initialization.
1398 * Normally this function only needs to be called from netdev_close().
1399 * However, it may be called by providers due to an error on opening
1400 * that occurs after initialization. It this case netdev_close() would
1401 * never be called. */
1403 netdev_uninit(struct netdev *netdev, bool close)
1405 /* Restore flags that we changed, if any. */
1406 int error = restore_flags(netdev);
1407 list_remove(&netdev->node);
1409 VLOG_WARN("failed to restore network device flags on %s: %s",
1410 netdev_get_name(netdev), strerror(error));
1414 netdev_get_dev(netdev)->netdev_class->close(netdev);
1419 /* Returns the class type of 'netdev'.
1421 * The caller must not free the returned value. */
1423 netdev_get_type(const struct netdev *netdev)
1425 return netdev_get_dev(netdev)->netdev_class->type;
1429 netdev_get_dev(const struct netdev *netdev)
1431 return netdev->netdev_dev;
1434 /* Restore the network device flags on 'netdev' to those that were active
1435 * before we changed them. Returns 0 if successful, otherwise a positive
1438 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1440 restore_flags(struct netdev *netdev)
1442 if (netdev->changed_flags) {
1443 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1444 enum netdev_flags old_flags;
1445 return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1446 netdev->changed_flags & ~restore,
1447 restore, &old_flags);
1452 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1453 * destroying devices, restoring flags, etc. */
1455 close_all_netdevs(void *aux OVS_UNUSED)
1457 struct netdev *netdev, *next;
1458 LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1459 netdev_close(netdev);