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>
28 #include "dynamic-string.h"
29 #include "fatal-signal.h"
32 #include "netdev-provider.h"
33 #include "netdev-vport.h"
35 #include "openflow/openflow.h"
37 #include "poll-loop.h"
44 VLOG_DEFINE_THIS_MODULE(netdev);
46 COVERAGE_DEFINE(netdev_received);
47 COVERAGE_DEFINE(netdev_sent);
48 COVERAGE_DEFINE(netdev_add_router);
49 COVERAGE_DEFINE(netdev_get_stats);
51 static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
53 /* All created network devices. */
54 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
56 /* All open network devices. */
57 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
59 /* This is set pretty low because we probably won't learn anything from the
60 * additional log messages. */
61 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
63 static void close_all_netdevs(void *aux OVS_UNUSED);
64 static int restore_flags(struct netdev *netdev);
65 void update_device_args(struct netdev_dev *, const struct shash *args);
68 netdev_initialize(void)
75 fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
76 netdev_vport_patch_register();
79 netdev_register_provider(&netdev_linux_class);
80 netdev_register_provider(&netdev_internal_class);
81 netdev_register_provider(&netdev_tap_class);
82 netdev_vport_tunnel_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 ovs_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 const struct netdev_tunnel_config *
294 netdev_get_tunnel_config(const struct netdev *netdev)
296 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
298 if (netdev_dev->netdev_class->get_tunnel_config) {
299 return netdev_dev->netdev_class->get_tunnel_config(netdev_dev);
305 /* Closes and destroys 'netdev'. */
307 netdev_close(struct netdev *netdev)
310 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
312 ovs_assert(netdev_dev->ref_cnt);
313 netdev_dev->ref_cnt--;
314 netdev_uninit(netdev, true);
316 /* If the reference count for the netdev device is zero, destroy it. */
317 if (!netdev_dev->ref_cnt) {
318 netdev_dev_uninit(netdev_dev, true);
323 /* Parses 'netdev_name_', which is of the form [type@]name into its component
324 * pieces. 'name' and 'type' must be freed by the caller. */
326 netdev_parse_name(const char *netdev_name_, char **name, char **type)
328 char *netdev_name = xstrdup(netdev_name_);
331 separator = strchr(netdev_name, '@');
335 *name = xstrdup(separator + 1);
338 *type = xstrdup("system");
342 /* Attempts to set up 'netdev' for receiving packets with netdev_recv().
343 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
344 * indicates that the network device does not implement packet reception
345 * through this interface. */
347 netdev_listen(struct netdev *netdev)
349 int (*listen)(struct netdev *);
351 listen = netdev_get_dev(netdev)->netdev_class->listen;
352 return listen ? (listen)(netdev) : EOPNOTSUPP;
355 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
356 * must have initialized with sufficient room for the packet. The space
357 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
358 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
359 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
360 * need not be included.)
362 * This function can only be expected to return a packet if ->listen() has
363 * been called successfully.
365 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
366 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
367 * positive errno value. Returns EAGAIN immediately if no packet is ready to
370 * Some network devices may not implement support for this function. In such
371 * cases this function will always return EOPNOTSUPP. */
373 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
375 int (*recv)(struct netdev *, void *, size_t);
378 ovs_assert(buffer->size == 0);
379 ovs_assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
381 recv = netdev_get_dev(netdev)->netdev_class->recv;
383 ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
386 COVERAGE_INC(netdev_received);
387 buffer->size += retval;
388 if (buffer->size < ETH_TOTAL_MIN) {
389 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
397 /* Registers with the poll loop to wake up from the next call to poll_block()
398 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
400 netdev_recv_wait(struct netdev *netdev)
402 void (*recv_wait)(struct netdev *);
404 recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
410 /* Discards all packets waiting to be received from 'netdev'. */
412 netdev_drain(struct netdev *netdev)
414 int (*drain)(struct netdev *);
416 drain = netdev_get_dev(netdev)->netdev_class->drain;
417 return drain ? drain(netdev) : 0;
420 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
421 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
422 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
423 * the packet is too big or too small to transmit on the device.
425 * The caller retains ownership of 'buffer' in all cases.
427 * The kernel maintains a packet transmission queue, so the caller is not
428 * expected to do additional queuing of packets.
430 * Some network devices may not implement support for this function. In such
431 * cases this function will always return EOPNOTSUPP. */
433 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
435 int (*send)(struct netdev *, const void *, size_t);
438 send = netdev_get_dev(netdev)->netdev_class->send;
439 error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
441 COVERAGE_INC(netdev_sent);
446 /* Registers with the poll loop to wake up from the next call to poll_block()
447 * when the packet transmission queue has sufficient room to transmit a packet
448 * with netdev_send().
450 * The kernel maintains a packet transmission queue, so the client is not
451 * expected to do additional queuing of packets. Thus, this function is
452 * unlikely to ever be used. It is included for completeness. */
454 netdev_send_wait(struct netdev *netdev)
456 void (*send_wait)(struct netdev *);
458 send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
464 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
465 * otherwise a positive errno value. */
467 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
469 return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
472 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
473 * the MAC address into 'mac'. On failure, returns a positive errno value and
474 * clears 'mac' to all-zeros. */
476 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
478 return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
481 /* Returns the name of the network device that 'netdev' represents,
482 * e.g. "eth0". The caller must not modify or free the returned string. */
484 netdev_get_name(const struct netdev *netdev)
486 return netdev_get_dev(netdev)->name;
489 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
490 * (and received) packets, in bytes, not including the hardware header; thus,
491 * this is typically 1500 bytes for Ethernet devices.
493 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
494 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
495 * On other failure, returns a positive errno value. On failure, sets '*mtup'
498 netdev_get_mtu(const struct netdev *netdev, int *mtup)
500 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
503 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
506 if (error != EOPNOTSUPP) {
507 VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
508 "%s", netdev_get_name(netdev), strerror(error));
514 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
515 * (and received) packets, in bytes.
517 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
518 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
521 netdev_set_mtu(const struct netdev *netdev, int mtu)
523 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
526 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
527 if (error && error != EOPNOTSUPP) {
528 VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
529 netdev_get_name(netdev), strerror(error));
535 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
536 * failure, returns a negative errno value.
538 * The desired semantics of the ifindex value are a combination of those
539 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
540 * value should be unique within a host and remain stable at least until
541 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
542 * but many systems do not follow this rule anyhow.
544 * Some network devices may not implement support for this function. In such
545 * cases this function will always return -EOPNOTSUPP.
548 netdev_get_ifindex(const struct netdev *netdev)
550 int (*get_ifindex)(const struct netdev *);
552 get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
554 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
557 /* Stores the features supported by 'netdev' into each of '*current',
558 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
559 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
560 * successful, otherwise a positive errno value. On failure, all of the
561 * passed-in values are set to 0.
563 * Some network devices may not implement support for this function. In such
564 * cases this function will always return EOPNOTSUPP. */
566 netdev_get_features(const struct netdev *netdev,
567 enum netdev_features *current,
568 enum netdev_features *advertised,
569 enum netdev_features *supported,
570 enum netdev_features *peer)
572 int (*get_features)(const struct netdev *netdev,
573 enum netdev_features *current,
574 enum netdev_features *advertised,
575 enum netdev_features *supported,
576 enum netdev_features *peer);
577 enum netdev_features dummy[4];
584 advertised = &dummy[1];
587 supported = &dummy[2];
593 get_features = netdev_get_dev(netdev)->netdev_class->get_features;
595 ? get_features(netdev, current, advertised, supported,
599 *current = *advertised = *supported = *peer = 0;
604 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
605 * bits in 'features', in bits per second. If no bits that indicate a speed
606 * are set in 'features', returns 'default_bps'. */
608 netdev_features_to_bps(enum netdev_features features,
609 uint64_t default_bps)
612 F_1000000MB = NETDEV_F_1TB_FD,
613 F_100000MB = NETDEV_F_100GB_FD,
614 F_40000MB = NETDEV_F_40GB_FD,
615 F_10000MB = NETDEV_F_10GB_FD,
616 F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
617 F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
618 F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
621 return ( features & F_1000000MB ? UINT64_C(1000000000000)
622 : features & F_100000MB ? UINT64_C(100000000000)
623 : features & F_40000MB ? UINT64_C(40000000000)
624 : features & F_10000MB ? UINT64_C(10000000000)
625 : features & F_1000MB ? UINT64_C(1000000000)
626 : features & F_100MB ? UINT64_C(100000000)
627 : features & F_10MB ? UINT64_C(10000000)
631 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
632 * are set in 'features', otherwise false. */
634 netdev_features_is_full_duplex(enum netdev_features features)
636 return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
637 | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
638 | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
641 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
642 * successful, otherwise a positive errno value. */
644 netdev_set_advertisements(struct netdev *netdev,
645 enum netdev_features advertise)
647 return (netdev_get_dev(netdev)->netdev_class->set_advertisements
648 ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
653 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
654 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
655 * errno value and sets '*address' to 0 (INADDR_ANY).
657 * The following error values have well-defined meanings:
659 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
661 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
663 * 'address' or 'netmask' or both may be null, in which case the address or
664 * netmask is not reported. */
666 netdev_get_in4(const struct netdev *netdev,
667 struct in_addr *address_, struct in_addr *netmask_)
669 struct in_addr address;
670 struct in_addr netmask;
673 error = (netdev_get_dev(netdev)->netdev_class->get_in4
674 ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
678 address_->s_addr = error ? 0 : address.s_addr;
681 netmask_->s_addr = error ? 0 : netmask.s_addr;
686 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
687 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
688 * positive errno value. */
690 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
692 return (netdev_get_dev(netdev)->netdev_class->set_in4
693 ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
697 /* Obtains ad IPv4 address from device name and save the address in
698 * in4. Returns 0 if successful, otherwise a positive errno value.
701 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
703 struct netdev *netdev;
706 error = netdev_open(device_name, "system", &netdev);
708 in4->s_addr = htonl(0);
712 error = netdev_get_in4(netdev, in4, NULL);
713 netdev_close(netdev);
717 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
720 netdev_add_router(struct netdev *netdev, struct in_addr router)
722 COVERAGE_INC(netdev_add_router);
723 return (netdev_get_dev(netdev)->netdev_class->add_router
724 ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
728 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
729 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
730 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
731 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
732 * a directly connected network) in '*next_hop' and a copy of the name of the
733 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
734 * responsible for freeing '*netdev_name' (by calling free()). */
736 netdev_get_next_hop(const struct netdev *netdev,
737 const struct in_addr *host, struct in_addr *next_hop,
740 int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
741 ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
742 host, next_hop, netdev_name)
745 next_hop->s_addr = 0;
751 /* Populates 'smap' with status information.
753 * Populates 'smap' with 'netdev' specific status information. This
754 * information may be used to populate the status column of the Interface table
755 * as defined in ovs-vswitchd.conf.db(5). */
757 netdev_get_status(const struct netdev *netdev, struct smap *smap)
759 struct netdev_dev *dev = netdev_get_dev(netdev);
761 return (dev->netdev_class->get_status
762 ? dev->netdev_class->get_status(netdev, smap)
766 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
767 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
768 * all-zero-bits (in6addr_any).
770 * The following error values have well-defined meanings:
772 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
774 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
776 * 'in6' may be null, in which case the address itself is not reported. */
778 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
780 struct in6_addr dummy;
783 error = (netdev_get_dev(netdev)->netdev_class->get_in6
784 ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
788 memset(in6, 0, sizeof *in6);
793 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
794 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
795 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
796 * successful, otherwise a positive errno value. */
798 do_update_flags(struct netdev *netdev, enum netdev_flags off,
799 enum netdev_flags on, enum netdev_flags *old_flagsp,
802 enum netdev_flags old_flags;
805 error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
806 off & ~on, on, &old_flags);
808 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
809 off || on ? "set" : "get", netdev_get_name(netdev),
812 } else if ((off || on) && !permanent) {
813 enum netdev_flags new_flags = (old_flags & ~off) | on;
814 enum netdev_flags changed_flags = old_flags ^ new_flags;
816 if (!netdev->changed_flags) {
817 netdev->save_flags = old_flags;
819 netdev->changed_flags |= changed_flags;
823 *old_flagsp = old_flags;
828 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
829 * Returns 0 if successful, otherwise a positive errno value. On failure,
830 * stores 0 into '*flagsp'. */
832 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
834 struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
835 return do_update_flags(netdev, 0, 0, flagsp, false);
838 /* Sets the flags for 'netdev' to 'flags'.
839 * If 'permanent' is true, the changes will persist; otherwise, they
840 * will be reverted when 'netdev' is closed or the program exits.
841 * Returns 0 if successful, otherwise a positive errno value. */
843 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
846 return do_update_flags(netdev, -1, flags, NULL, permanent);
849 /* Turns on the specified 'flags' on 'netdev'.
850 * If 'permanent' is true, the changes will persist; otherwise, they
851 * will be reverted when 'netdev' is closed or the program exits.
852 * Returns 0 if successful, otherwise a positive errno value. */
854 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
857 return do_update_flags(netdev, 0, flags, NULL, permanent);
860 /* Turns off the specified 'flags' on 'netdev'.
861 * If 'permanent' is true, the changes will persist; otherwise, they
862 * will be reverted when 'netdev' is closed or the program exits.
863 * Returns 0 if successful, otherwise a positive errno value. */
865 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
868 return do_update_flags(netdev, flags, 0, NULL, permanent);
871 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
872 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
873 * returns 0. Otherwise, it returns a positive errno value; in particular,
874 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
876 netdev_arp_lookup(const struct netdev *netdev,
877 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
879 int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
880 ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
884 memset(mac, 0, ETH_ADDR_LEN);
889 /* Returns true if carrier is active (link light is on) on 'netdev'. */
891 netdev_get_carrier(const struct netdev *netdev)
894 enum netdev_flags flags;
897 netdev_get_flags(netdev, &flags);
898 if (!(flags & NETDEV_UP)) {
902 if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
906 error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
909 VLOG_DBG("%s: failed to get network device carrier status, assuming "
910 "down: %s", netdev_get_name(netdev), strerror(error));
917 /* Returns the number of times 'netdev''s carrier has changed. */
919 netdev_get_carrier_resets(const struct netdev *netdev)
921 return (netdev_get_dev(netdev)->netdev_class->get_carrier_resets
922 ? netdev_get_dev(netdev)->netdev_class->get_carrier_resets(netdev)
926 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
927 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
928 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
929 * does not support MII, another method may be used as a fallback. If
930 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
931 * its normal behavior.
933 * Returns 0 if successful, otherwise a positive errno value. */
935 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
937 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
938 return (netdev_dev->netdev_class->set_miimon_interval
939 ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval)
943 /* Retrieves current device stats for 'netdev'. */
945 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
949 COVERAGE_INC(netdev_get_stats);
950 error = (netdev_get_dev(netdev)->netdev_class->get_stats
951 ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
954 memset(stats, 0xff, sizeof *stats);
959 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
960 * Returns 0 if successful, otherwise a positive errno value.
962 * This will probably fail for most network devices. Some devices might only
963 * allow setting their stats to 0. */
965 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
967 return (netdev_get_dev(netdev)->netdev_class->set_stats
968 ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
972 /* Attempts to set input rate limiting (policing) policy, such that up to
973 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
974 * size of 'kbits' kb. */
976 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
977 uint32_t kbits_burst)
979 return (netdev_get_dev(netdev)->netdev_class->set_policing
980 ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
981 kbits_rate, kbits_burst)
985 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
986 * empty if 'netdev' does not support QoS. Any names added to 'types' should
987 * be documented as valid for the "type" column in the "QoS" table in
988 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
990 * Every network device supports disabling QoS with a type of "", but this type
991 * will not be added to 'types'.
993 * The caller must initialize 'types' (e.g. with sset_init()) before calling
994 * this function. The caller is responsible for destroying 'types' (e.g. with
995 * sset_destroy()) when it is no longer needed.
997 * Returns 0 if successful, otherwise a positive errno value. */
999 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1001 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1002 return (class->get_qos_types
1003 ? class->get_qos_types(netdev, types)
1007 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1008 * which should be "" or one of the types returned by netdev_get_qos_types()
1009 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1010 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1011 * 'caps' to all zeros. */
1013 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1014 struct netdev_qos_capabilities *caps)
1016 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1019 int retval = (class->get_qos_capabilities
1020 ? class->get_qos_capabilities(netdev, type, caps)
1023 memset(caps, 0, sizeof *caps);
1027 /* Every netdev supports turning off QoS. */
1028 memset(caps, 0, sizeof *caps);
1033 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1034 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1035 * the number of queues (zero on failure) in '*n_queuesp'.
1037 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1039 netdev_get_n_queues(const struct netdev *netdev,
1040 const char *type, unsigned int *n_queuesp)
1042 struct netdev_qos_capabilities caps;
1045 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1046 *n_queuesp = caps.n_queues;
1050 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1051 * stores the name of the current form of QoS into '*typep', stores any details
1052 * of configuration as string key-value pairs in 'details', and returns 0. On
1053 * failure, sets '*typep' to NULL and returns a positive errno value.
1055 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1057 * The caller must initialize 'details' as an empty smap (e.g. with
1058 * smap_init()) before calling this function. The caller must free 'details'
1059 * when it is no longer needed (e.g. with smap_destroy()).
1061 * The caller must not modify or free '*typep'.
1063 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1064 * 'netdev'. The contents of 'details' should be documented as valid for
1065 * '*typep' in the "other_config" column in the "QoS" table in
1066 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1068 netdev_get_qos(const struct netdev *netdev,
1069 const char **typep, struct smap *details)
1071 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1074 if (class->get_qos) {
1075 retval = class->get_qos(netdev, typep, details);
1078 smap_clear(details);
1082 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1088 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1089 * with details of configuration from 'details'. Returns 0 if successful,
1090 * otherwise a positive errno value. On error, the previous QoS configuration
1093 * When this function changes the type of QoS (not just 'details'), this also
1094 * resets all queue configuration for 'netdev' to their defaults (which depend
1095 * on the specific type of QoS). Otherwise, the queue configuration for
1096 * 'netdev' is unchanged.
1098 * 'type' should be "" (to disable QoS) or one of the types returned by
1099 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1100 * documented as valid for the given 'type' in the "other_config" column in the
1101 * "QoS" table in vswitchd/vswitch.xml (which is built as
1102 * ovs-vswitchd.conf.db(8)).
1104 * NULL may be specified for 'details' if there are no configuration
1107 netdev_set_qos(struct netdev *netdev,
1108 const char *type, const struct smap *details)
1110 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1116 if (class->set_qos) {
1118 static struct smap empty = SMAP_INITIALIZER(&empty);
1121 return class->set_qos(netdev, type, details);
1123 return *type ? EOPNOTSUPP : 0;
1127 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1128 * successful, adds that information as string key-value pairs to 'details'.
1129 * Returns 0 if successful, otherwise a positive errno value.
1131 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1132 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1134 * The returned contents of 'details' should be documented as valid for the
1135 * given 'type' in the "other_config" column in the "Queue" table in
1136 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1138 * The caller must initialize 'details' (e.g. with smap_init()) before calling
1139 * this function. The caller must free 'details' when it is no longer needed
1140 * (e.g. with smap_destroy()). */
1142 netdev_get_queue(const struct netdev *netdev,
1143 unsigned int queue_id, struct smap *details)
1145 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1148 retval = (class->get_queue
1149 ? class->get_queue(netdev, queue_id, details)
1152 smap_clear(details);
1157 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1158 * string pairs in 'details'. The contents of 'details' should be documented
1159 * as valid for the given 'type' in the "other_config" column in the "Queue"
1160 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1161 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1162 * given queue's configuration should be unmodified.
1164 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1165 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1167 * This function does not modify 'details', and the caller retains ownership of
1170 netdev_set_queue(struct netdev *netdev,
1171 unsigned int queue_id, const struct smap *details)
1173 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1174 return (class->set_queue
1175 ? class->set_queue(netdev, queue_id, details)
1179 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1180 * of QoS may have a fixed set of queues, in which case attempts to delete them
1181 * will fail with EOPNOTSUPP.
1183 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1184 * given queue will be unmodified.
1186 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1187 * the current form of QoS (e.g. as returned by
1188 * netdev_get_n_queues(netdev)). */
1190 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1192 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1193 return (class->delete_queue
1194 ? class->delete_queue(netdev, queue_id)
1198 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1199 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1200 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1201 * positive errno value and fills 'stats' with all-1-bits. */
1203 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1204 struct netdev_queue_stats *stats)
1206 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1209 retval = (class->get_queue_stats
1210 ? class->get_queue_stats(netdev, queue_id, stats)
1213 memset(stats, 0xff, sizeof *stats);
1218 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1219 * its configuration, and the 'aux' specified by the caller. The order of
1220 * iteration is unspecified, but (when successful) each queue is visited
1223 * Calling this function may be more efficient than calling netdev_get_queue()
1226 * 'cb' must not modify or free the 'details' argument passed in. It may
1227 * delete or modify the queue passed in as its 'queue_id' argument. It may
1228 * modify but must not delete any other queue within 'netdev'. 'cb' should not
1229 * add new queues because this may cause some queues to be visited twice or not
1232 * Returns 0 if successful, otherwise a positive errno value. On error, some
1233 * configured queues may not have been included in the iteration. */
1235 netdev_dump_queues(const struct netdev *netdev,
1236 netdev_dump_queues_cb *cb, void *aux)
1238 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1239 return (class->dump_queues
1240 ? class->dump_queues(netdev, cb, aux)
1244 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1245 * its statistics, and the 'aux' specified by the caller. The order of
1246 * iteration is unspecified, but (when successful) each queue is visited
1249 * Calling this function may be more efficient than calling
1250 * netdev_get_queue_stats() for every queue.
1252 * 'cb' must not modify or free the statistics passed in.
1254 * Returns 0 if successful, otherwise a positive errno value. On error, some
1255 * configured queues may not have been included in the iteration. */
1257 netdev_dump_queue_stats(const struct netdev *netdev,
1258 netdev_dump_queue_stats_cb *cb, void *aux)
1260 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1261 return (class->dump_queue_stats
1262 ? class->dump_queue_stats(netdev, cb, aux)
1266 /* Returns a sequence number which indicates changes in one of 'netdev''s
1267 * properties. The returned sequence will be nonzero so that callers have a
1268 * value which they may use as a reset when tracking 'netdev'.
1270 * The returned sequence number will change whenever 'netdev''s flags,
1271 * features, ethernet address, or carrier changes. It may change for other
1272 * reasons as well, or no reason at all. */
1274 netdev_change_seq(const struct netdev *netdev)
1276 return netdev_get_dev(netdev)->netdev_class->change_seq(netdev);
1279 /* Initializes 'netdev_dev' as a netdev device named 'name' of the specified
1280 * 'netdev_class'. This function is ordinarily called from a netdev provider's
1281 * 'create' function.
1283 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1284 * very important that 'netdev_dev' only be freed after calling
1285 * the refcount drops to zero. */
1287 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1288 const struct netdev_class *netdev_class)
1290 ovs_assert(!shash_find(&netdev_dev_shash, name));
1292 memset(netdev_dev, 0, sizeof *netdev_dev);
1293 netdev_dev->netdev_class = netdev_class;
1294 netdev_dev->name = xstrdup(name);
1295 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1298 /* Undoes the results of initialization.
1300 * Normally this function does not need to be called as netdev_close has
1301 * the same effect when the refcount drops to zero.
1302 * However, it may be called by providers due to an error on creation
1303 * that occurs after initialization. It this case netdev_close() would
1304 * never be called. */
1306 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1308 char *name = netdev_dev->name;
1310 ovs_assert(!netdev_dev->ref_cnt);
1312 shash_delete(&netdev_dev_shash, netdev_dev->node);
1315 netdev_dev->netdev_class->destroy(netdev_dev);
1320 /* Returns the class type of 'netdev_dev'.
1322 * The caller must not free the returned value. */
1324 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1326 return netdev_dev->netdev_class->type;
1329 /* Returns the class associated with 'netdev_dev'. */
1330 const struct netdev_class *
1331 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1333 return netdev_dev->netdev_class;
1336 /* Returns the name of 'netdev_dev'.
1338 * The caller must not free the returned value. */
1340 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1342 return netdev_dev->name;
1345 /* Returns the netdev_dev with 'name' or NULL if there is none.
1347 * The caller must not free the returned value. */
1349 netdev_dev_from_name(const char *name)
1351 return shash_find_data(&netdev_dev_shash, name);
1354 /* Fills 'device_list' with devices that match 'netdev_class'.
1356 * The caller is responsible for initializing and destroying 'device_list'
1357 * but the contained netdev_devs must not be freed. */
1359 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1360 struct shash *device_list)
1362 struct shash_node *node;
1363 SHASH_FOR_EACH (node, &netdev_dev_shash) {
1364 struct netdev_dev *dev = node->data;
1366 if (dev->netdev_class == netdev_class) {
1367 shash_add(device_list, node->name, node->data);
1372 /* Initializes 'netdev' as a instance of the netdev_dev.
1374 * This function adds 'netdev' to a netdev-owned linked list, so it is very
1375 * important that 'netdev' only be freed after calling netdev_close(). */
1377 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1379 memset(netdev, 0, sizeof *netdev);
1380 netdev->netdev_dev = netdev_dev;
1381 list_push_back(&netdev_list, &netdev->node);
1384 /* Undoes the results of initialization.
1386 * Normally this function only needs to be called from netdev_close().
1387 * However, it may be called by providers due to an error on opening
1388 * that occurs after initialization. It this case netdev_close() would
1389 * never be called. */
1391 netdev_uninit(struct netdev *netdev, bool close)
1393 /* Restore flags that we changed, if any. */
1394 int error = restore_flags(netdev);
1395 list_remove(&netdev->node);
1397 VLOG_WARN("failed to restore network device flags on %s: %s",
1398 netdev_get_name(netdev), strerror(error));
1402 netdev_get_dev(netdev)->netdev_class->close(netdev);
1407 /* Returns the class type of 'netdev'.
1409 * The caller must not free the returned value. */
1411 netdev_get_type(const struct netdev *netdev)
1413 return netdev_get_dev(netdev)->netdev_class->type;
1418 netdev_get_type_from_name(const char *name)
1420 const struct netdev_dev *dev = netdev_dev_from_name(name);
1421 return dev ? netdev_dev_get_type(dev) : NULL;
1425 netdev_get_dev(const struct netdev *netdev)
1427 return netdev->netdev_dev;
1430 /* Restore the network device flags on 'netdev' to those that were active
1431 * before we changed them. Returns 0 if successful, otherwise a positive
1434 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1436 restore_flags(struct netdev *netdev)
1438 if (netdev->changed_flags) {
1439 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1440 enum netdev_flags old_flags;
1441 return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1442 netdev->changed_flags & ~restore,
1443 restore, &old_flags);
1448 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1449 * destroying devices, restoring flags, etc. */
1451 close_all_netdevs(void *aux OVS_UNUSED)
1453 struct netdev *netdev, *next;
1454 LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1455 netdev_close(netdev);