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();
85 netdev_register_provider(&netdev_tap_class);
86 netdev_register_provider(&netdev_bsd_class);
91 /* Performs periodic work needed by all the various kinds of netdevs.
93 * If your program opens any netdevs, it must call this function within its
98 struct shash_node *node;
99 SHASH_FOR_EACH(node, &netdev_classes) {
100 const struct netdev_class *netdev_class = node->data;
101 if (netdev_class->run) {
107 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
109 * If your program opens any netdevs, it must call this function within its
114 struct shash_node *node;
115 SHASH_FOR_EACH(node, &netdev_classes) {
116 const struct netdev_class *netdev_class = node->data;
117 if (netdev_class->wait) {
118 netdev_class->wait();
123 /* Initializes and registers a new netdev provider. After successful
124 * registration, new netdevs of that type can be opened using netdev_open(). */
126 netdev_register_provider(const struct netdev_class *new_class)
128 if (shash_find(&netdev_classes, new_class->type)) {
129 VLOG_WARN("attempted to register duplicate netdev provider: %s",
134 if (new_class->init) {
135 int error = new_class->init();
137 VLOG_ERR("failed to initialize %s network device class: %s",
138 new_class->type, strerror(error));
143 shash_add(&netdev_classes, new_class->type, new_class);
148 /* Unregisters a netdev provider. 'type' must have been previously
149 * registered and not currently be in use by any netdevs. After unregistration
150 * new netdevs of that type cannot be opened using netdev_open(). */
152 netdev_unregister_provider(const char *type)
154 struct shash_node *del_node, *netdev_dev_node;
156 del_node = shash_find(&netdev_classes, type);
158 VLOG_WARN("attempted to unregister a netdev provider that is not "
159 "registered: %s", type);
163 SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
164 struct netdev_dev *netdev_dev = netdev_dev_node->data;
165 if (!strcmp(netdev_dev->netdev_class->type, type)) {
166 VLOG_WARN("attempted to unregister in use netdev provider: %s",
172 shash_delete(&netdev_classes, del_node);
177 const struct netdev_class *
178 netdev_lookup_provider(const char *type)
181 return shash_find_data(&netdev_classes, type && type[0] ? type : "system");
184 /* Clears 'types' and enumerates the types of all currently registered netdev
185 * providers into it. The caller must first initialize the sset. */
187 netdev_enumerate_types(struct sset *types)
189 struct shash_node *node;
194 SHASH_FOR_EACH(node, &netdev_classes) {
195 const struct netdev_class *netdev_class = node->data;
196 sset_add(types, netdev_class->type);
200 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
201 * (e.g. "system") and returns zero if successful, otherwise a positive errno
202 * value. On success, sets '*netdevp' to the new network device, otherwise to
205 * Some network devices may need to be configured (with netdev_set_config())
206 * before they can be used. */
208 netdev_open(const char *name, const char *type, struct netdev **netdevp)
210 struct netdev_dev *netdev_dev;
216 netdev_dev = shash_find_data(&netdev_dev_shash, name);
219 const struct netdev_class *class;
221 class = netdev_lookup_provider(type);
223 VLOG_WARN("could not create netdev %s of unknown type %s",
227 error = class->create(class, name, &netdev_dev);
231 assert(netdev_dev->netdev_class == class);
235 error = netdev_dev->netdev_class->open(netdev_dev, netdevp);
238 netdev_dev->ref_cnt++;
240 if (!netdev_dev->ref_cnt) {
241 netdev_dev_uninit(netdev_dev, true);
248 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
249 * or NULL if none are needed. */
251 netdev_set_config(struct netdev *netdev, const struct smap *args)
253 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
255 if (netdev_dev->netdev_class->set_config) {
256 struct smap no_args = SMAP_INITIALIZER(&no_args);
257 return netdev_dev->netdev_class->set_config(netdev_dev,
258 args ? args : &no_args);
259 } else if (args && !smap_is_empty(args)) {
260 VLOG_WARN("%s: arguments provided to device that is not configurable",
261 netdev_get_name(netdev));
267 /* Returns the current configuration for 'netdev' in 'args'. The caller must
268 * have already initialized 'args' with smap_init(). Returns 0 on success, in
269 * which case 'args' will be filled with 'netdev''s configuration. On failure
270 * returns a positive errno value, in which case 'args' will be empty.
272 * The caller owns 'args' and its contents and must eventually free them with
275 netdev_get_config(const struct netdev *netdev, struct smap *args)
277 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
281 if (netdev_dev->netdev_class->get_config) {
282 error = netdev_dev->netdev_class->get_config(netdev_dev, args);
293 /* Closes and destroys 'netdev'. */
295 netdev_close(struct netdev *netdev)
298 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
300 assert(netdev_dev->ref_cnt);
301 netdev_dev->ref_cnt--;
302 netdev_uninit(netdev, true);
304 /* If the reference count for the netdev device is zero, destroy it. */
305 if (!netdev_dev->ref_cnt) {
306 netdev_dev_uninit(netdev_dev, true);
311 /* Returns true if a network device named 'name' exists and may be opened,
312 * otherwise false. */
314 netdev_exists(const char *name)
316 struct netdev *netdev;
319 error = netdev_open(name, "system", &netdev);
321 netdev_close(netdev);
324 if (error != ENODEV) {
325 VLOG_WARN("failed to open network device %s: %s",
326 name, strerror(error));
332 /* Returns true if a network device named 'name' is currently opened,
333 * otherwise false. */
335 netdev_is_open(const char *name)
337 return !!shash_find_data(&netdev_dev_shash, name);
340 /* Parses 'netdev_name_', which is of the form [type@]name into its component
341 * pieces. 'name' and 'type' must be freed by the caller. */
343 netdev_parse_name(const char *netdev_name_, char **name, char **type)
345 char *netdev_name = xstrdup(netdev_name_);
348 separator = strchr(netdev_name, '@');
352 *name = xstrdup(separator + 1);
355 *type = xstrdup("system");
359 /* Attempts to set up 'netdev' for receiving packets with netdev_recv().
360 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
361 * indicates that the network device does not implement packet reception
362 * through this interface. */
364 netdev_listen(struct netdev *netdev)
366 int (*listen)(struct netdev *);
368 listen = netdev_get_dev(netdev)->netdev_class->listen;
369 return listen ? (listen)(netdev) : EOPNOTSUPP;
372 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
373 * must have initialized with sufficient room for the packet. The space
374 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
375 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
376 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
377 * need not be included.)
379 * This function can only be expected to return a packet if ->listen() has
380 * been called successfully.
382 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
383 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
384 * positive errno value. Returns EAGAIN immediately if no packet is ready to
387 * Some network devices may not implement support for this function. In such
388 * cases this function will always return EOPNOTSUPP. */
390 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
392 int (*recv)(struct netdev *, void *, size_t);
395 assert(buffer->size == 0);
396 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
398 recv = netdev_get_dev(netdev)->netdev_class->recv;
400 ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
403 COVERAGE_INC(netdev_received);
404 buffer->size += retval;
405 if (buffer->size < ETH_TOTAL_MIN) {
406 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
414 /* Registers with the poll loop to wake up from the next call to poll_block()
415 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
417 netdev_recv_wait(struct netdev *netdev)
419 void (*recv_wait)(struct netdev *);
421 recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
427 /* Discards all packets waiting to be received from 'netdev'. */
429 netdev_drain(struct netdev *netdev)
431 int (*drain)(struct netdev *);
433 drain = netdev_get_dev(netdev)->netdev_class->drain;
434 return drain ? drain(netdev) : 0;
437 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
438 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
439 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
440 * the packet is too big or too small to transmit on the device.
442 * The caller retains ownership of 'buffer' in all cases.
444 * The kernel maintains a packet transmission queue, so the caller is not
445 * expected to do additional queuing of packets.
447 * Some network devices may not implement support for this function. In such
448 * cases this function will always return EOPNOTSUPP. */
450 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
452 int (*send)(struct netdev *, const void *, size_t);
455 send = netdev_get_dev(netdev)->netdev_class->send;
456 error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
458 COVERAGE_INC(netdev_sent);
463 /* Registers with the poll loop to wake up from the next call to poll_block()
464 * when the packet transmission queue has sufficient room to transmit a packet
465 * with netdev_send().
467 * The kernel maintains a packet transmission queue, so the client is not
468 * expected to do additional queuing of packets. Thus, this function is
469 * unlikely to ever be used. It is included for completeness. */
471 netdev_send_wait(struct netdev *netdev)
473 void (*send_wait)(struct netdev *);
475 send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
481 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
482 * otherwise a positive errno value. */
484 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
486 return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
489 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
490 * the MAC address into 'mac'. On failure, returns a positive errno value and
491 * clears 'mac' to all-zeros. */
493 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
495 return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
498 /* Returns the name of the network device that 'netdev' represents,
499 * e.g. "eth0". The caller must not modify or free the returned string. */
501 netdev_get_name(const struct netdev *netdev)
503 return netdev_get_dev(netdev)->name;
506 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
507 * (and received) packets, in bytes, not including the hardware header; thus,
508 * this is typically 1500 bytes for Ethernet devices.
510 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
511 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
512 * On other failure, returns a positive errno value. On failure, sets '*mtup'
515 netdev_get_mtu(const struct netdev *netdev, int *mtup)
517 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
520 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
523 if (error != EOPNOTSUPP) {
524 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
525 "%s", netdev_get_name(netdev), strerror(error));
531 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
532 * (and received) packets, in bytes.
534 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
535 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
538 netdev_set_mtu(const struct netdev *netdev, int mtu)
540 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
543 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
544 if (error && error != EOPNOTSUPP) {
545 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
546 netdev_get_name(netdev), strerror(error));
552 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
553 * failure, returns a negative errno value.
555 * The desired semantics of the ifindex value are a combination of those
556 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
557 * value should be unique within a host and remain stable at least until
558 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
559 * but many systems do not follow this rule anyhow.
561 * Some network devices may not implement support for this function. In such
562 * cases this function will always return -EOPNOTSUPP.
565 netdev_get_ifindex(const struct netdev *netdev)
567 int (*get_ifindex)(const struct netdev *);
569 get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
571 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
574 /* Stores the features supported by 'netdev' into each of '*current',
575 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
576 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
577 * successful, otherwise a positive errno value. On failure, all of the
578 * passed-in values are set to 0.
580 * Some network devices may not implement support for this function. In such
581 * cases this function will always return EOPNOTSUPP. */
583 netdev_get_features(const struct netdev *netdev,
584 enum netdev_features *current,
585 enum netdev_features *advertised,
586 enum netdev_features *supported,
587 enum netdev_features *peer)
589 int (*get_features)(const struct netdev *netdev,
590 enum netdev_features *current,
591 enum netdev_features *advertised,
592 enum netdev_features *supported,
593 enum netdev_features *peer);
594 enum netdev_features dummy[4];
601 advertised = &dummy[1];
604 supported = &dummy[2];
610 get_features = netdev_get_dev(netdev)->netdev_class->get_features;
612 ? get_features(netdev, current, advertised, supported,
616 *current = *advertised = *supported = *peer = 0;
621 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
622 * bits in 'features', in bits per second. If no bits that indicate a speed
623 * are set in 'features', returns 'default_bps'. */
625 netdev_features_to_bps(enum netdev_features features,
626 uint64_t default_bps)
629 F_1000000MB = NETDEV_F_1TB_FD,
630 F_100000MB = NETDEV_F_100GB_FD,
631 F_40000MB = NETDEV_F_40GB_FD,
632 F_10000MB = NETDEV_F_10GB_FD,
633 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
634 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
635 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
638 return ( features & F_1000000MB ? UINT64_C(1000000000000)
639 : features & F_100000MB ? UINT64_C(100000000000)
640 : features & F_40000MB ? UINT64_C(40000000000)
641 : features & F_10000MB ? UINT64_C(10000000000)
642 : features & F_1000MB ? UINT64_C(1000000000)
643 : features & F_100MB ? UINT64_C(100000000)
644 : features & F_10MB ? UINT64_C(10000000)
648 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
649 * are set in 'features', otherwise false. */
651 netdev_features_is_full_duplex(enum netdev_features features)
653 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
654 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
655 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
658 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
659 * successful, otherwise a positive errno value. */
661 netdev_set_advertisements(struct netdev *netdev,
662 enum netdev_features advertise)
664 return (netdev_get_dev(netdev)->netdev_class->set_advertisements
665 ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
670 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
671 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
672 * errno value and sets '*address' to 0 (INADDR_ANY).
674 * The following error values have well-defined meanings:
676 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
678 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
680 * 'address' or 'netmask' or both may be null, in which case the address or
681 * netmask is not reported. */
683 netdev_get_in4(const struct netdev *netdev,
684 struct in_addr *address_, struct in_addr *netmask_)
686 struct in_addr address;
687 struct in_addr netmask;
690 error = (netdev_get_dev(netdev)->netdev_class->get_in4
691 ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
695 address_->s_addr = error ? 0 : address.s_addr;
698 netmask_->s_addr = error ? 0 : netmask.s_addr;
703 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
704 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
705 * positive errno value. */
707 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
709 return (netdev_get_dev(netdev)->netdev_class->set_in4
710 ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
714 /* Obtains ad IPv4 address from device name and save the address in
715 * in4. Returns 0 if successful, otherwise a positive errno value.
718 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
720 struct netdev *netdev;
723 error = netdev_open(device_name, "system", &netdev);
725 in4->s_addr = htonl(0);
729 error = netdev_get_in4(netdev, in4, NULL);
730 netdev_close(netdev);
734 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
737 netdev_add_router(struct netdev *netdev, struct in_addr router)
739 COVERAGE_INC(netdev_add_router);
740 return (netdev_get_dev(netdev)->netdev_class->add_router
741 ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
745 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
746 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
747 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
748 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
749 * a directly connected network) in '*next_hop' and a copy of the name of the
750 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
751 * responsible for freeing '*netdev_name' (by calling free()). */
753 netdev_get_next_hop(const struct netdev *netdev,
754 const struct in_addr *host, struct in_addr *next_hop,
757 int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
758 ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
759 host, next_hop, netdev_name)
762 next_hop->s_addr = 0;
768 /* Populates 'smap' with status information.
770 * Populates 'smap' with 'netdev' specific status information. This
771 * information may be used to populate the status column of the Interface table
772 * as defined in ovs-vswitchd.conf.db(5). */
774 netdev_get_drv_info(const struct netdev *netdev, struct smap *smap)
776 struct netdev_dev *dev = netdev_get_dev(netdev);
778 return (dev->netdev_class->get_drv_info
779 ? dev->netdev_class->get_drv_info(netdev, smap)
783 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
784 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
785 * all-zero-bits (in6addr_any).
787 * The following error values have well-defined meanings:
789 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
791 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
793 * 'in6' may be null, in which case the address itself is not reported. */
795 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
797 struct in6_addr dummy;
800 error = (netdev_get_dev(netdev)->netdev_class->get_in6
801 ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
805 memset(in6, 0, sizeof *in6);
810 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
811 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
812 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
813 * successful, otherwise a positive errno value. */
815 do_update_flags(struct netdev *netdev, enum netdev_flags off,
816 enum netdev_flags on, enum netdev_flags *old_flagsp,
819 enum netdev_flags old_flags;
822 error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
823 off & ~on, on, &old_flags);
825 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
826 off || on ? "set" : "get", netdev_get_name(netdev),
829 } else if ((off || on) && !permanent) {
830 enum netdev_flags new_flags = (old_flags & ~off) | on;
831 enum netdev_flags changed_flags = old_flags ^ new_flags;
833 if (!netdev->changed_flags) {
834 netdev->save_flags = old_flags;
836 netdev->changed_flags |= changed_flags;
840 *old_flagsp = old_flags;
845 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
846 * Returns 0 if successful, otherwise a positive errno value. On failure,
847 * stores 0 into '*flagsp'. */
849 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
851 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
852 return do_update_flags(netdev, 0, 0, flagsp, false);
855 /* Sets the flags for 'netdev' to 'flags'.
856 * If 'permanent' is true, the changes will persist; otherwise, they
857 * will be reverted when 'netdev' is closed or the program exits.
858 * Returns 0 if successful, otherwise a positive errno value. */
860 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
863 return do_update_flags(netdev, -1, flags, NULL, permanent);
866 /* Turns on the specified 'flags' on 'netdev'.
867 * If 'permanent' is true, the changes will persist; otherwise, they
868 * will be reverted when 'netdev' is closed or the program exits.
869 * Returns 0 if successful, otherwise a positive errno value. */
871 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
874 return do_update_flags(netdev, 0, flags, NULL, permanent);
877 /* Turns off the specified 'flags' on 'netdev'.
878 * If 'permanent' is true, the changes will persist; otherwise, they
879 * will be reverted when 'netdev' is closed or the program exits.
880 * Returns 0 if successful, otherwise a positive errno value. */
882 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
885 return do_update_flags(netdev, flags, 0, NULL, permanent);
888 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
889 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
890 * returns 0. Otherwise, it returns a positive errno value; in particular,
891 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
893 netdev_arp_lookup(const struct netdev *netdev,
894 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
896 int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
897 ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
901 memset(mac, 0, ETH_ADDR_LEN);
906 /* Returns true if carrier is active (link light is on) on 'netdev'. */
908 netdev_get_carrier(const struct netdev *netdev)
911 enum netdev_flags flags;
914 netdev_get_flags(netdev, &flags);
915 if (!(flags & NETDEV_UP)) {
919 if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
923 error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
926 VLOG_DBG("%s: failed to get network device carrier status, assuming "
927 "down: %s", netdev_get_name(netdev), strerror(error));
934 /* Returns the number of times 'netdev''s carrier has changed. */
936 netdev_get_carrier_resets(const struct netdev *netdev)
938 return (netdev_get_dev(netdev)->netdev_class->get_carrier_resets
939 ? netdev_get_dev(netdev)->netdev_class->get_carrier_resets(netdev)
943 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
944 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
945 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
946 * does not support MII, another method may be used as a fallback. If
947 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
948 * its normal behavior.
950 * Returns 0 if successful, otherwise a positive errno value. */
952 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
954 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
955 return (netdev_dev->netdev_class->set_miimon_interval
956 ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval)
960 /* Retrieves current device stats for 'netdev'. */
962 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
966 COVERAGE_INC(netdev_get_stats);
967 error = (netdev_get_dev(netdev)->netdev_class->get_stats
968 ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
971 memset(stats, 0xff, sizeof *stats);
976 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
977 * Returns 0 if successful, otherwise a positive errno value.
979 * This will probably fail for most network devices. Some devices might only
980 * allow setting their stats to 0. */
982 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
984 return (netdev_get_dev(netdev)->netdev_class->set_stats
985 ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
989 /* Attempts to set input rate limiting (policing) policy, such that up to
990 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
991 * size of 'kbits' kb. */
993 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
994 uint32_t kbits_burst)
996 return (netdev_get_dev(netdev)->netdev_class->set_policing
997 ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
998 kbits_rate, kbits_burst)
1002 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1003 * empty if 'netdev' does not support QoS. Any names added to 'types' should
1004 * be documented as valid for the "type" column in the "QoS" table in
1005 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1007 * Every network device supports disabling QoS with a type of "", but this type
1008 * will not be added to 'types'.
1010 * The caller must initialize 'types' (e.g. with sset_init()) before calling
1011 * this function. The caller is responsible for destroying 'types' (e.g. with
1012 * sset_destroy()) when it is no longer needed.
1014 * Returns 0 if successful, otherwise a positive errno value. */
1016 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1018 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1019 return (class->get_qos_types
1020 ? class->get_qos_types(netdev, types)
1024 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1025 * which should be "" or one of the types returned by netdev_get_qos_types()
1026 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1027 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1028 * 'caps' to all zeros. */
1030 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1031 struct netdev_qos_capabilities *caps)
1033 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1036 int retval = (class->get_qos_capabilities
1037 ? class->get_qos_capabilities(netdev, type, caps)
1040 memset(caps, 0, sizeof *caps);
1044 /* Every netdev supports turning off QoS. */
1045 memset(caps, 0, sizeof *caps);
1050 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1051 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1052 * the number of queues (zero on failure) in '*n_queuesp'.
1054 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1056 netdev_get_n_queues(const struct netdev *netdev,
1057 const char *type, unsigned int *n_queuesp)
1059 struct netdev_qos_capabilities caps;
1062 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1063 *n_queuesp = caps.n_queues;
1067 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1068 * stores the name of the current form of QoS into '*typep', stores any details
1069 * of configuration as string key-value pairs in 'details', and returns 0. On
1070 * failure, sets '*typep' to NULL and returns a positive errno value.
1072 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1074 * The caller must initialize 'details' as an empty smap (e.g. with
1075 * smap_init()) before calling this function. The caller must free 'details'
1076 * when it is no longer needed (e.g. with smap_destroy()).
1078 * The caller must not modify or free '*typep'.
1080 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1081 * 'netdev'. The contents of 'details' should be documented as valid for
1082 * '*typep' in the "other_config" column in the "QoS" table in
1083 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1085 netdev_get_qos(const struct netdev *netdev,
1086 const char **typep, struct smap *details)
1088 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1091 if (class->get_qos) {
1092 retval = class->get_qos(netdev, typep, details);
1095 smap_clear(details);
1099 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1105 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1106 * with details of configuration from 'details'. Returns 0 if successful,
1107 * otherwise a positive errno value. On error, the previous QoS configuration
1110 * When this function changes the type of QoS (not just 'details'), this also
1111 * resets all queue configuration for 'netdev' to their defaults (which depend
1112 * on the specific type of QoS). Otherwise, the queue configuration for
1113 * 'netdev' is unchanged.
1115 * 'type' should be "" (to disable QoS) or one of the types returned by
1116 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1117 * documented as valid for the given 'type' in the "other_config" column in the
1118 * "QoS" table in vswitchd/vswitch.xml (which is built as
1119 * ovs-vswitchd.conf.db(8)).
1121 * NULL may be specified for 'details' if there are no configuration
1124 netdev_set_qos(struct netdev *netdev,
1125 const char *type, const struct smap *details)
1127 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1133 if (class->set_qos) {
1135 static struct smap empty = SMAP_INITIALIZER(&empty);
1138 return class->set_qos(netdev, type, details);
1140 return *type ? EOPNOTSUPP : 0;
1144 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1145 * successful, adds that information as string key-value pairs to 'details'.
1146 * Returns 0 if successful, otherwise a positive errno value.
1148 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1149 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1151 * The returned contents of 'details' should be documented as valid for the
1152 * given 'type' in the "other_config" column in the "Queue" table in
1153 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1155 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1156 * this function. The caller must free 'details' when it is no longer needed
1157 * (e.g. with smap_destroy()). */
1159 netdev_get_queue(const struct netdev *netdev,
1160 unsigned int queue_id, struct smap *details)
1162 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1165 retval = (class->get_queue
1166 ? class->get_queue(netdev, queue_id, details)
1169 smap_clear(details);
1174 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1175 * string pairs in 'details'. The contents of 'details' should be documented
1176 * as valid for the given 'type' in the "other_config" column in the "Queue"
1177 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1178 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1179 * given queue's configuration should be unmodified.
1181 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1182 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1184 * This function does not modify 'details', and the caller retains ownership of
1187 netdev_set_queue(struct netdev *netdev,
1188 unsigned int queue_id, const struct smap *details)
1190 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1191 return (class->set_queue
1192 ? class->set_queue(netdev, queue_id, details)
1196 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1197 * of QoS may have a fixed set of queues, in which case attempts to delete them
1198 * will fail with EOPNOTSUPP.
1200 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1201 * given queue will be unmodified.
1203 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1204 * the current form of QoS (e.g. as returned by
1205 * netdev_get_n_queues(netdev)). */
1207 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1209 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1210 return (class->delete_queue
1211 ? class->delete_queue(netdev, queue_id)
1215 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1216 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1217 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1218 * positive errno value and fills 'stats' with all-1-bits. */
1220 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1221 struct netdev_queue_stats *stats)
1223 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1226 retval = (class->get_queue_stats
1227 ? class->get_queue_stats(netdev, queue_id, stats)
1230 memset(stats, 0xff, sizeof *stats);
1235 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1236 * its configuration, and the 'aux' specified by the caller. The order of
1237 * iteration is unspecified, but (when successful) each queue is visited
1240 * Calling this function may be more efficient than calling netdev_get_queue()
1243 * 'cb' must not modify or free the 'details' argument passed in. It may
1244 * delete or modify the queue passed in as its 'queue_id' argument. It may
1245 * modify but must not delete any other queue within 'netdev'. 'cb' should not
1246 * add new queues because this may cause some queues to be visited twice or not
1249 * Returns 0 if successful, otherwise a positive errno value. On error, some
1250 * configured queues may not have been included in the iteration. */
1252 netdev_dump_queues(const struct netdev *netdev,
1253 netdev_dump_queues_cb *cb, void *aux)
1255 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1256 return (class->dump_queues
1257 ? class->dump_queues(netdev, cb, aux)
1261 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1262 * its statistics, and the 'aux' specified by the caller. The order of
1263 * iteration is unspecified, but (when successful) each queue is visited
1266 * Calling this function may be more efficient than calling
1267 * netdev_get_queue_stats() for every queue.
1269 * 'cb' must not modify or free the statistics passed in.
1271 * Returns 0 if successful, otherwise a positive errno value. On error, some
1272 * configured queues may not have been included in the iteration. */
1274 netdev_dump_queue_stats(const struct netdev *netdev,
1275 netdev_dump_queue_stats_cb *cb, void *aux)
1277 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1278 return (class->dump_queue_stats
1279 ? class->dump_queue_stats(netdev, cb, aux)
1283 /* Returns a sequence number which indicates changes in one of 'netdev''s
1284 * properties. The returned sequence will be nonzero so that callers have a
1285 * value which they may use as a reset when tracking 'netdev'.
1287 * The returned sequence number will change whenever 'netdev''s flags,
1288 * features, ethernet address, or carrier changes. It may change for other
1289 * reasons as well, or no reason at all. */
1291 netdev_change_seq(const struct netdev *netdev)
1293 return netdev_get_dev(netdev)->netdev_class->change_seq(netdev);
1296 /* Initializes 'netdev_dev' as a netdev device named 'name' of the specified
1297 * 'netdev_class'. This function is ordinarily called from a netdev provider's
1298 * 'create' function.
1300 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1301 * very important that 'netdev_dev' only be freed after calling
1302 * the refcount drops to zero. */
1304 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1305 const struct netdev_class *netdev_class)
1307 assert(!shash_find(&netdev_dev_shash, name));
1309 memset(netdev_dev, 0, sizeof *netdev_dev);
1310 netdev_dev->netdev_class = netdev_class;
1311 netdev_dev->name = xstrdup(name);
1312 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1315 /* Undoes the results of initialization.
1317 * Normally this function does not need to be called as netdev_close has
1318 * the same effect when the refcount drops to zero.
1319 * However, it may be called by providers due to an error on creation
1320 * that occurs after initialization. It this case netdev_close() would
1321 * never be called. */
1323 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1325 char *name = netdev_dev->name;
1327 assert(!netdev_dev->ref_cnt);
1329 shash_delete(&netdev_dev_shash, netdev_dev->node);
1332 netdev_dev->netdev_class->destroy(netdev_dev);
1337 /* Returns the class type of 'netdev_dev'.
1339 * The caller must not free the returned value. */
1341 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1343 return netdev_dev->netdev_class->type;
1346 /* Returns the class associated with 'netdev_dev'. */
1347 const struct netdev_class *
1348 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1350 return netdev_dev->netdev_class;
1353 /* Returns the name of 'netdev_dev'.
1355 * The caller must not free the returned value. */
1357 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1359 return netdev_dev->name;
1362 /* Returns the netdev_dev with 'name' or NULL if there is none.
1364 * The caller must not free the returned value. */
1366 netdev_dev_from_name(const char *name)
1368 return shash_find_data(&netdev_dev_shash, name);
1371 /* Fills 'device_list' with devices that match 'netdev_class'.
1373 * The caller is responsible for initializing and destroying 'device_list'
1374 * but the contained netdev_devs must not be freed. */
1376 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1377 struct shash *device_list)
1379 struct shash_node *node;
1380 SHASH_FOR_EACH (node, &netdev_dev_shash) {
1381 struct netdev_dev *dev = node->data;
1383 if (dev->netdev_class == netdev_class) {
1384 shash_add(device_list, node->name, node->data);
1389 /* Initializes 'netdev' as a instance of the netdev_dev.
1391 * This function adds 'netdev' to a netdev-owned linked list, so it is very
1392 * important that 'netdev' only be freed after calling netdev_close(). */
1394 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1396 memset(netdev, 0, sizeof *netdev);
1397 netdev->netdev_dev = netdev_dev;
1398 list_push_back(&netdev_list, &netdev->node);
1401 /* Undoes the results of initialization.
1403 * Normally this function only needs to be called from netdev_close().
1404 * However, it may be called by providers due to an error on opening
1405 * that occurs after initialization. It this case netdev_close() would
1406 * never be called. */
1408 netdev_uninit(struct netdev *netdev, bool close)
1410 /* Restore flags that we changed, if any. */
1411 int error = restore_flags(netdev);
1412 list_remove(&netdev->node);
1414 VLOG_WARN("failed to restore network device flags on %s: %s",
1415 netdev_get_name(netdev), strerror(error));
1419 netdev_get_dev(netdev)->netdev_class->close(netdev);
1424 /* Returns the class type of 'netdev'.
1426 * The caller must not free the returned value. */
1428 netdev_get_type(const struct netdev *netdev)
1430 return netdev_get_dev(netdev)->netdev_class->type;
1434 netdev_get_dev(const struct netdev *netdev)
1436 return netdev->netdev_dev;
1439 /* Restore the network device flags on 'netdev' to those that were active
1440 * before we changed them. Returns 0 if successful, otherwise a positive
1443 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1445 restore_flags(struct netdev *netdev)
1447 if (netdev->changed_flags) {
1448 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1449 enum netdev_flags old_flags;
1450 return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1451 netdev->changed_flags & ~restore,
1452 restore, &old_flags);
1457 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1458 * destroying devices, restoring flags, etc. */
1460 close_all_netdevs(void *aux OVS_UNUSED)
1462 struct netdev *netdev, *next;
1463 LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1464 netdev_close(netdev);