2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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"
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);
78 netdev_register_provider(&netdev_linux_class);
79 netdev_register_provider(&netdev_internal_class);
80 netdev_register_provider(&netdev_tap_class);
81 netdev_vport_register();
86 /* Performs periodic work needed by all the various kinds of netdevs.
88 * If your program opens any netdevs, it must call this function within its
93 struct shash_node *node;
94 SHASH_FOR_EACH(node, &netdev_classes) {
95 const struct netdev_class *netdev_class = node->data;
96 if (netdev_class->run) {
102 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
104 * If your program opens any netdevs, it must call this function within its
109 struct shash_node *node;
110 SHASH_FOR_EACH(node, &netdev_classes) {
111 const struct netdev_class *netdev_class = node->data;
112 if (netdev_class->wait) {
113 netdev_class->wait();
118 /* Initializes and registers a new netdev provider. After successful
119 * registration, new netdevs of that type can be opened using netdev_open(). */
121 netdev_register_provider(const struct netdev_class *new_class)
123 if (shash_find(&netdev_classes, new_class->type)) {
124 VLOG_WARN("attempted to register duplicate netdev provider: %s",
129 if (new_class->init) {
130 int error = new_class->init();
132 VLOG_ERR("failed to initialize %s network device class: %s",
133 new_class->type, strerror(error));
138 shash_add(&netdev_classes, new_class->type, new_class);
143 /* Unregisters a netdev provider. 'type' must have been previously
144 * registered and not currently be in use by any netdevs. After unregistration
145 * new netdevs of that type cannot be opened using netdev_open(). */
147 netdev_unregister_provider(const char *type)
149 struct shash_node *del_node, *netdev_dev_node;
151 del_node = shash_find(&netdev_classes, type);
153 VLOG_WARN("attempted to unregister a netdev provider that is not "
154 "registered: %s", type);
158 SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
159 struct netdev_dev *netdev_dev = netdev_dev_node->data;
160 if (!strcmp(netdev_dev->netdev_class->type, type)) {
161 VLOG_WARN("attempted to unregister in use netdev provider: %s",
167 shash_delete(&netdev_classes, del_node);
172 const struct netdev_class *
173 netdev_lookup_provider(const char *type)
176 return shash_find_data(&netdev_classes, type && type[0] ? type : "system");
179 /* Clears 'types' and enumerates the types of all currently registered netdev
180 * providers into it. The caller must first initialize the sset. */
182 netdev_enumerate_types(struct sset *types)
184 struct shash_node *node;
189 SHASH_FOR_EACH(node, &netdev_classes) {
190 const struct netdev_class *netdev_class = node->data;
191 sset_add(types, netdev_class->type);
195 /* Opens the network device named 'name' (e.g. "eth0") of the specified 'type'
196 * (e.g. "system") and returns zero if successful, otherwise a positive errno
197 * value. On success, sets '*netdevp' to the new network device, otherwise to
200 * Some network devices may need to be configured (with netdev_set_config())
201 * before they can be used. */
203 netdev_open(const char *name, const char *type, struct netdev **netdevp)
205 struct netdev_dev *netdev_dev;
211 netdev_dev = shash_find_data(&netdev_dev_shash, name);
214 const struct netdev_class *class;
216 class = netdev_lookup_provider(type);
218 VLOG_WARN("could not create netdev %s of unknown type %s",
222 error = class->create(class, name, &netdev_dev);
226 assert(netdev_dev->netdev_class == class);
230 error = netdev_dev->netdev_class->open(netdev_dev, netdevp);
233 netdev_dev->ref_cnt++;
235 if (!netdev_dev->ref_cnt) {
236 netdev_dev_uninit(netdev_dev, true);
243 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
244 * or NULL if none are needed. */
246 netdev_set_config(struct netdev *netdev, const struct shash *args)
248 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
250 if (netdev_dev->netdev_class->set_config) {
251 struct shash no_args = SHASH_INITIALIZER(&no_args);
252 return netdev_dev->netdev_class->set_config(netdev_dev,
253 args ? args : &no_args);
254 } else if (args && !shash_is_empty(args)) {
255 VLOG_WARN("%s: arguments provided to device that is not configurable",
256 netdev_get_name(netdev));
262 /* Returns the current configuration for 'netdev' in 'args'. The caller must
263 * have already initialized 'args' with shash_init(). Returns 0 on success, in
264 * which case 'args' will be filled with 'netdev''s configuration. On failure
265 * returns a positive errno value, in which case 'args' will be empty.
267 * The caller owns 'args' and its contents and must eventually free them with
268 * shash_destroy_free_data(). */
270 netdev_get_config(const struct netdev *netdev, struct shash *args)
272 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
275 shash_clear_free_data(args);
276 if (netdev_dev->netdev_class->get_config) {
277 error = netdev_dev->netdev_class->get_config(netdev_dev, args);
279 shash_clear_free_data(args);
288 /* Closes and destroys 'netdev'. */
290 netdev_close(struct netdev *netdev)
293 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
295 assert(netdev_dev->ref_cnt);
296 netdev_dev->ref_cnt--;
297 netdev_uninit(netdev, true);
299 /* If the reference count for the netdev device is zero, destroy it. */
300 if (!netdev_dev->ref_cnt) {
301 netdev_dev_uninit(netdev_dev, true);
306 /* Returns true if a network device named 'name' exists and may be opened,
307 * otherwise false. */
309 netdev_exists(const char *name)
311 struct netdev *netdev;
314 error = netdev_open(name, "system", &netdev);
316 netdev_close(netdev);
319 if (error != ENODEV) {
320 VLOG_WARN("failed to open network device %s: %s",
321 name, strerror(error));
327 /* Returns true if a network device named 'name' is currently opened,
328 * otherwise false. */
330 netdev_is_open(const char *name)
332 return !!shash_find_data(&netdev_dev_shash, name);
335 /* Clears 'sset' and enumerates the names of all known network devices. */
337 netdev_enumerate(struct sset *sset)
339 struct shash_node *node;
345 SHASH_FOR_EACH(node, &netdev_classes) {
346 const struct netdev_class *netdev_class = node->data;
347 if (netdev_class->enumerate) {
348 int retval = netdev_class->enumerate(sset);
350 VLOG_WARN("failed to enumerate %s network devices: %s",
351 netdev_class->type, strerror(retval));
362 /* Parses 'netdev_name_', which is of the form [type@]name into its component
363 * pieces. 'name' and 'type' must be freed by the caller. */
365 netdev_parse_name(const char *netdev_name_, char **name, char **type)
367 char *netdev_name = xstrdup(netdev_name_);
370 separator = strchr(netdev_name, '@');
374 *name = xstrdup(separator + 1);
377 *type = xstrdup("system");
381 /* Attempts to set up 'netdev' for receiving packets with netdev_recv().
382 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
383 * indicates that the network device does not implement packet reception
384 * through this interface. */
386 netdev_listen(struct netdev *netdev)
388 int (*listen)(struct netdev *);
390 listen = netdev_get_dev(netdev)->netdev_class->listen;
391 return listen ? (listen)(netdev) : EOPNOTSUPP;
394 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
395 * must have initialized with sufficient room for the packet. The space
396 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
397 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
398 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
399 * need not be included.)
401 * This function can only be expected to return a packet if ->listen() has
402 * been called successfully.
404 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
405 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
406 * positive errno value. Returns EAGAIN immediately if no packet is ready to
409 * Some network devices may not implement support for this function. In such
410 * cases this function will always return EOPNOTSUPP. */
412 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
414 int (*recv)(struct netdev *, void *, size_t);
417 assert(buffer->size == 0);
418 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
420 recv = netdev_get_dev(netdev)->netdev_class->recv;
422 ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
425 COVERAGE_INC(netdev_received);
426 buffer->size += retval;
427 if (buffer->size < ETH_TOTAL_MIN) {
428 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
436 /* Registers with the poll loop to wake up from the next call to poll_block()
437 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
439 netdev_recv_wait(struct netdev *netdev)
441 void (*recv_wait)(struct netdev *);
443 recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
449 /* Discards all packets waiting to be received from 'netdev'. */
451 netdev_drain(struct netdev *netdev)
453 int (*drain)(struct netdev *);
455 drain = netdev_get_dev(netdev)->netdev_class->drain;
456 return drain ? drain(netdev) : 0;
459 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
460 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
461 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
462 * the packet is too big or too small to transmit on the device.
464 * The caller retains ownership of 'buffer' in all cases.
466 * The kernel maintains a packet transmission queue, so the caller is not
467 * expected to do additional queuing of packets.
469 * Some network devices may not implement support for this function. In such
470 * cases this function will always return EOPNOTSUPP. */
472 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
474 int (*send)(struct netdev *, const void *, size_t);
477 send = netdev_get_dev(netdev)->netdev_class->send;
478 error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
480 COVERAGE_INC(netdev_sent);
485 /* Registers with the poll loop to wake up from the next call to poll_block()
486 * when the packet transmission queue has sufficient room to transmit a packet
487 * with netdev_send().
489 * The kernel maintains a packet transmission queue, so the client is not
490 * expected to do additional queuing of packets. Thus, this function is
491 * unlikely to ever be used. It is included for completeness. */
493 netdev_send_wait(struct netdev *netdev)
495 void (*send_wait)(struct netdev *);
497 send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
503 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
504 * otherwise a positive errno value. */
506 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
508 return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
511 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
512 * the MAC address into 'mac'. On failure, returns a positive errno value and
513 * clears 'mac' to all-zeros. */
515 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
517 return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
520 /* Returns the name of the network device that 'netdev' represents,
521 * e.g. "eth0". The caller must not modify or free the returned string. */
523 netdev_get_name(const struct netdev *netdev)
525 return netdev_get_dev(netdev)->name;
528 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
529 * (and received) packets, in bytes, not including the hardware header; thus,
530 * this is typically 1500 bytes for Ethernet devices.
532 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
533 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
534 * On other failure, returns a positive errno value. */
536 netdev_get_mtu(const struct netdev *netdev, int *mtup)
538 int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup);
539 if (error && error != EOPNOTSUPP) {
540 VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
541 netdev_get_name(netdev), strerror(error));
546 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
547 * (and received) packets, in bytes.
549 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
550 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
553 netdev_set_mtu(const struct netdev *netdev, int mtu)
555 int error = netdev_get_dev(netdev)->netdev_class->set_mtu(netdev, mtu);
557 if (error && error != EOPNOTSUPP) {
558 VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
559 netdev_get_name(netdev), strerror(error));
565 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
566 * failure, returns a negative errno value.
568 * The desired semantics of the ifindex value are a combination of those
569 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
570 * value should be unique within a host and remain stable at least until
571 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
572 * but many systems do not follow this rule anyhow.
574 * Some network devices may not implement support for this function. In such
575 * cases this function will always return -EOPNOTSUPP.
578 netdev_get_ifindex(const struct netdev *netdev)
580 int (*get_ifindex)(const struct netdev *);
582 get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
584 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
587 /* Stores the features supported by 'netdev' into each of '*current',
588 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
589 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
590 * successful, otherwise a positive errno value. On failure, all of the
591 * passed-in values are set to 0.
593 * Some network devices may not implement support for this function. In such
594 * cases this function will always return EOPNOTSUPP. */
596 netdev_get_features(const struct netdev *netdev,
597 uint32_t *current, uint32_t *advertised,
598 uint32_t *supported, uint32_t *peer)
600 int (*get_features)(const struct netdev *netdev,
601 uint32_t *current, uint32_t *advertised,
602 uint32_t *supported, uint32_t *peer);
610 advertised = &dummy[1];
613 supported = &dummy[2];
619 get_features = netdev_get_dev(netdev)->netdev_class->get_features;
621 ? get_features(netdev, current, advertised, supported, peer)
624 *current = *advertised = *supported = *peer = 0;
629 /* Returns the maximum speed of a network connection that has the "enum
630 * ofp_port_features" bits in 'features', in bits per second. If no bits that
631 * indicate a speed are set in 'features', assumes 100Mbps. */
633 netdev_features_to_bps(uint32_t features)
636 F_10000MB = OFPPF_10GB_FD,
637 F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
638 F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
639 F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
642 return ( features & F_10000MB ? UINT64_C(10000000000)
643 : features & F_1000MB ? UINT64_C(1000000000)
644 : features & F_100MB ? UINT64_C(100000000)
645 : features & F_10MB ? UINT64_C(10000000)
646 : UINT64_C(100000000));
649 /* Returns true if any of the "enum ofp_port_features" bits that indicate a
650 * full-duplex link are set in 'features', otherwise false. */
652 netdev_features_is_full_duplex(uint32_t features)
654 return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
655 | OFPPF_10GB_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, uint32_t advertise)
663 return (netdev_get_dev(netdev)->netdev_class->set_advertisements
664 ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
669 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
670 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
671 * errno value and sets '*address' to 0 (INADDR_ANY).
673 * The following error values have well-defined meanings:
675 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
677 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
679 * 'address' or 'netmask' or both may be null, in which case the address or
680 * netmask is not reported. */
682 netdev_get_in4(const struct netdev *netdev,
683 struct in_addr *address_, struct in_addr *netmask_)
685 struct in_addr address;
686 struct in_addr netmask;
689 error = (netdev_get_dev(netdev)->netdev_class->get_in4
690 ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
694 address_->s_addr = error ? 0 : address.s_addr;
697 netmask_->s_addr = error ? 0 : netmask.s_addr;
702 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
703 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
704 * positive errno value. */
706 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
708 return (netdev_get_dev(netdev)->netdev_class->set_in4
709 ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
713 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
716 netdev_add_router(struct netdev *netdev, struct in_addr router)
718 COVERAGE_INC(netdev_add_router);
719 return (netdev_get_dev(netdev)->netdev_class->add_router
720 ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
724 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
725 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
726 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
727 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
728 * a directly connected network) in '*next_hop' and a copy of the name of the
729 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
730 * responsible for freeing '*netdev_name' (by calling free()). */
732 netdev_get_next_hop(const struct netdev *netdev,
733 const struct in_addr *host, struct in_addr *next_hop,
736 int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
737 ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
738 host, next_hop, netdev_name)
741 next_hop->s_addr = 0;
747 /* Populates 'sh' with status information.
749 * Populates 'sh' with 'netdev' specific status information. This information
750 * may be used to populate the status column of the Interface table as defined
751 * in ovs-vswitchd.conf.db(5). */
753 netdev_get_status(const struct netdev *netdev, struct shash *sh)
755 struct netdev_dev *dev = netdev_get_dev(netdev);
757 return (dev->netdev_class->get_status
758 ? dev->netdev_class->get_status(netdev, sh)
762 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
763 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
764 * all-zero-bits (in6addr_any).
766 * The following error values have well-defined meanings:
768 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
770 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
772 * 'in6' may be null, in which case the address itself is not reported. */
774 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
776 struct in6_addr dummy;
779 error = (netdev_get_dev(netdev)->netdev_class->get_in6
780 ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
784 memset(in6, 0, sizeof *in6);
789 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
790 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
791 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
792 * successful, otherwise a positive errno value. */
794 do_update_flags(struct netdev *netdev, enum netdev_flags off,
795 enum netdev_flags on, enum netdev_flags *old_flagsp,
798 enum netdev_flags old_flags;
801 error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
802 off & ~on, on, &old_flags);
804 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
805 off || on ? "set" : "get", netdev_get_name(netdev),
808 } else if ((off || on) && !permanent) {
809 enum netdev_flags new_flags = (old_flags & ~off) | on;
810 enum netdev_flags changed_flags = old_flags ^ new_flags;
812 if (!netdev->changed_flags) {
813 netdev->save_flags = old_flags;
815 netdev->changed_flags |= changed_flags;
819 *old_flagsp = old_flags;
824 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
825 * Returns 0 if successful, otherwise a positive errno value. On failure,
826 * stores 0 into '*flagsp'. */
828 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
830 struct netdev *netdev = (struct netdev *) netdev_;
831 return do_update_flags(netdev, 0, 0, flagsp, false);
834 /* Sets the flags for 'netdev' to 'flags'.
835 * If 'permanent' is true, the changes will persist; otherwise, they
836 * will be reverted when 'netdev' is closed or the program exits.
837 * Returns 0 if successful, otherwise a positive errno value. */
839 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
842 return do_update_flags(netdev, -1, flags, NULL, permanent);
845 /* Turns on the specified 'flags' on 'netdev'.
846 * If 'permanent' is true, the changes will persist; otherwise, they
847 * will be reverted when 'netdev' is closed or the program exits.
848 * Returns 0 if successful, otherwise a positive errno value. */
850 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
853 return do_update_flags(netdev, 0, flags, NULL, permanent);
856 /* Turns off the specified 'flags' on 'netdev'.
857 * If 'permanent' is true, the changes will persist; otherwise, they
858 * will be reverted when 'netdev' is closed or the program exits.
859 * Returns 0 if successful, otherwise a positive errno value. */
861 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
864 return do_update_flags(netdev, flags, 0, NULL, permanent);
867 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
868 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
869 * returns 0. Otherwise, it returns a positive errno value; in particular,
870 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
872 netdev_arp_lookup(const struct netdev *netdev,
873 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
875 int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
876 ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
880 memset(mac, 0, ETH_ADDR_LEN);
885 /* Returns true if carrier is active (link light is on) on 'netdev'. */
887 netdev_get_carrier(const struct netdev *netdev)
890 enum netdev_flags flags;
893 netdev_get_flags(netdev, &flags);
894 if (!(flags & NETDEV_UP)) {
898 if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
902 error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
905 VLOG_DBG("%s: failed to get network device carrier status, assuming "
906 "down: %s", netdev_get_name(netdev), strerror(error));
913 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
914 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
915 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
916 * does not support MII, another method may be used as a fallback. If
917 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
918 * its normal behavior.
920 * Returns 0 if successful, otherwise a positive errno value. */
922 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
924 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
925 return (netdev_dev->netdev_class->set_miimon_interval
926 ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval)
930 /* Retrieves current device stats for 'netdev'. */
932 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
936 COVERAGE_INC(netdev_get_stats);
937 error = (netdev_get_dev(netdev)->netdev_class->get_stats
938 ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
941 memset(stats, 0xff, sizeof *stats);
946 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
947 * Returns 0 if successful, otherwise a positive errno value.
949 * This will probably fail for most network devices. Some devices might only
950 * allow setting their stats to 0. */
952 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
954 return (netdev_get_dev(netdev)->netdev_class->set_stats
955 ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
959 /* Attempts to set input rate limiting (policing) policy, such that up to
960 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
961 * size of 'kbits' kb. */
963 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
964 uint32_t kbits_burst)
966 return (netdev_get_dev(netdev)->netdev_class->set_policing
967 ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
968 kbits_rate, kbits_burst)
972 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
973 * empty if 'netdev' does not support QoS. Any names added to 'types' should
974 * be documented as valid for the "type" column in the "QoS" table in
975 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
977 * Every network device supports disabling QoS with a type of "", but this type
978 * will not be added to 'types'.
980 * The caller must initialize 'types' (e.g. with sset_init()) before calling
981 * this function. The caller is responsible for destroying 'types' (e.g. with
982 * sset_destroy()) when it is no longer needed.
984 * Returns 0 if successful, otherwise a positive errno value. */
986 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
988 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
989 return (class->get_qos_types
990 ? class->get_qos_types(netdev, types)
994 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
995 * which should be "" or one of the types returned by netdev_get_qos_types()
996 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
997 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
998 * 'caps' to all zeros. */
1000 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1001 struct netdev_qos_capabilities *caps)
1003 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1006 int retval = (class->get_qos_capabilities
1007 ? class->get_qos_capabilities(netdev, type, caps)
1010 memset(caps, 0, sizeof *caps);
1014 /* Every netdev supports turning off QoS. */
1015 memset(caps, 0, sizeof *caps);
1020 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1021 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1022 * the number of queues (zero on failure) in '*n_queuesp'.
1024 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1026 netdev_get_n_queues(const struct netdev *netdev,
1027 const char *type, unsigned int *n_queuesp)
1029 struct netdev_qos_capabilities caps;
1032 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1033 *n_queuesp = caps.n_queues;
1037 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1038 * stores the name of the current form of QoS into '*typep', stores any details
1039 * of configuration as string key-value pairs in 'details', and returns 0. On
1040 * failure, sets '*typep' to NULL and returns a positive errno value.
1042 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1044 * The caller must initialize 'details' as an empty shash (e.g. with
1045 * shash_init()) before calling this function. The caller must free 'details',
1046 * including 'data' members, when it is no longer needed (e.g. with
1047 * shash_destroy_free_data()).
1049 * The caller must not modify or free '*typep'.
1051 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1052 * 'netdev'. The contents of 'details' should be documented as valid for
1053 * '*typep' in the "other_config" column in the "QoS" table in
1054 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1056 netdev_get_qos(const struct netdev *netdev,
1057 const char **typep, struct shash *details)
1059 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1062 if (class->get_qos) {
1063 retval = class->get_qos(netdev, typep, details);
1066 shash_clear_free_data(details);
1070 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1076 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1077 * with details of configuration from 'details'. Returns 0 if successful,
1078 * otherwise a positive errno value. On error, the previous QoS configuration
1081 * When this function changes the type of QoS (not just 'details'), this also
1082 * resets all queue configuration for 'netdev' to their defaults (which depend
1083 * on the specific type of QoS). Otherwise, the queue configuration for
1084 * 'netdev' is unchanged.
1086 * 'type' should be "" (to disable QoS) or one of the types returned by
1087 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1088 * documented as valid for the given 'type' in the "other_config" column in the
1089 * "QoS" table in vswitchd/vswitch.xml (which is built as
1090 * ovs-vswitchd.conf.db(8)).
1092 * NULL may be specified for 'details' if there are no configuration
1095 netdev_set_qos(struct netdev *netdev,
1096 const char *type, const struct shash *details)
1098 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1104 if (class->set_qos) {
1106 static struct shash empty = SHASH_INITIALIZER(&empty);
1109 return class->set_qos(netdev, type, details);
1111 return *type ? EOPNOTSUPP : 0;
1115 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1116 * successful, adds that information as string key-value pairs to 'details'.
1117 * Returns 0 if successful, otherwise a positive errno value.
1119 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1120 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1122 * The returned contents of 'details' should be documented as valid for the
1123 * given 'type' in the "other_config" column in the "Queue" table in
1124 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1126 * The caller must initialize 'details' (e.g. with shash_init()) before calling
1127 * this function. The caller must free 'details', including 'data' members,
1128 * when it is no longer needed (e.g. with shash_destroy_free_data()). */
1130 netdev_get_queue(const struct netdev *netdev,
1131 unsigned int queue_id, struct shash *details)
1133 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1136 retval = (class->get_queue
1137 ? class->get_queue(netdev, queue_id, details)
1140 shash_clear_free_data(details);
1145 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1146 * string pairs in 'details'. The contents of 'details' should be documented
1147 * as valid for the given 'type' in the "other_config" column in the "Queue"
1148 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1149 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1150 * given queue's configuration should be unmodified.
1152 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1153 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1155 * This function does not modify 'details', and the caller retains ownership of
1158 netdev_set_queue(struct netdev *netdev,
1159 unsigned int queue_id, const struct shash *details)
1161 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1162 return (class->set_queue
1163 ? class->set_queue(netdev, queue_id, details)
1167 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1168 * of QoS may have a fixed set of queues, in which case attempts to delete them
1169 * will fail with EOPNOTSUPP.
1171 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1172 * given queue will be unmodified.
1174 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1175 * the current form of QoS (e.g. as returned by
1176 * netdev_get_n_queues(netdev)). */
1178 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1180 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1181 return (class->delete_queue
1182 ? class->delete_queue(netdev, queue_id)
1186 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1187 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1188 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1189 * positive errno value and fills 'stats' with all-1-bits. */
1191 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1192 struct netdev_queue_stats *stats)
1194 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1197 retval = (class->get_queue_stats
1198 ? class->get_queue_stats(netdev, queue_id, stats)
1201 memset(stats, 0xff, sizeof *stats);
1206 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1207 * its configuration, and the 'aux' specified by the caller. The order of
1208 * iteration is unspecified, but (when successful) each queue is visited
1211 * Calling this function may be more efficient than calling netdev_get_queue()
1214 * 'cb' must not modify or free the 'details' argument passed in.
1216 * Returns 0 if successful, otherwise a positive errno value. On error, some
1217 * configured queues may not have been included in the iteration. */
1219 netdev_dump_queues(const struct netdev *netdev,
1220 netdev_dump_queues_cb *cb, void *aux)
1222 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1223 return (class->dump_queues
1224 ? class->dump_queues(netdev, cb, aux)
1228 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1229 * its statistics, and the 'aux' specified by the caller. The order of
1230 * iteration is unspecified, but (when successful) each queue is visited
1233 * Calling this function may be more efficient than calling
1234 * netdev_get_queue_stats() for every queue.
1236 * 'cb' must not modify or free the statistics passed in.
1238 * Returns 0 if successful, otherwise a positive errno value. On error, some
1239 * configured queues may not have been included in the iteration. */
1241 netdev_dump_queue_stats(const struct netdev *netdev,
1242 netdev_dump_queue_stats_cb *cb, void *aux)
1244 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1245 return (class->dump_queue_stats
1246 ? class->dump_queue_stats(netdev, cb, aux)
1250 /* Returns a sequence number which indicates changes in one of 'netdev''s
1251 * properties. The returned sequence will be nonzero so that callers have a
1252 * value which they may use as a reset when tracking 'netdev'.
1254 * The returned sequence number will change whenever 'netdev''s flags,
1255 * features, ethernet address, or carrier changes. It may change for other
1256 * reasons as well, or no reason at all. */
1258 netdev_change_seq(const struct netdev *netdev)
1260 return netdev_get_dev(netdev)->netdev_class->change_seq(netdev);
1263 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
1264 * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
1265 * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
1266 * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
1269 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
1271 int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
1272 ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
1281 /* Returns a network device that has 'in4' as its IP address, if one exists,
1282 * otherwise a null pointer. */
1284 netdev_find_dev_by_in4(const struct in_addr *in4)
1286 struct netdev *netdev;
1287 struct sset dev_list = SSET_INITIALIZER(&dev_list);
1290 netdev_enumerate(&dev_list);
1291 SSET_FOR_EACH (name, &dev_list) {
1292 struct in_addr dev_in4;
1294 if (!netdev_open(name, "system", &netdev)
1295 && !netdev_get_in4(netdev, &dev_in4, NULL)
1296 && dev_in4.s_addr == in4->s_addr) {
1299 netdev_close(netdev);
1304 sset_destroy(&dev_list);
1308 /* Initializes 'netdev_dev' as a netdev device named 'name' of the specified
1309 * 'netdev_class'. This function is ordinarily called from a netdev provider's
1310 * 'create' function.
1312 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1313 * very important that 'netdev_dev' only be freed after calling
1314 * the refcount drops to zero. */
1316 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1317 const struct netdev_class *netdev_class)
1319 assert(!shash_find(&netdev_dev_shash, name));
1321 memset(netdev_dev, 0, sizeof *netdev_dev);
1322 netdev_dev->netdev_class = netdev_class;
1323 netdev_dev->name = xstrdup(name);
1324 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1327 /* Undoes the results of initialization.
1329 * Normally this function does not need to be called as netdev_close has
1330 * the same effect when the refcount drops to zero.
1331 * However, it may be called by providers due to an error on creation
1332 * that occurs after initialization. It this case netdev_close() would
1333 * never be called. */
1335 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1337 char *name = netdev_dev->name;
1339 assert(!netdev_dev->ref_cnt);
1341 shash_delete(&netdev_dev_shash, netdev_dev->node);
1344 netdev_dev->netdev_class->destroy(netdev_dev);
1349 /* Returns the class type of 'netdev_dev'.
1351 * The caller must not free the returned value. */
1353 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1355 return netdev_dev->netdev_class->type;
1358 /* Returns the class associated with 'netdev_dev'. */
1359 const struct netdev_class *
1360 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1362 return netdev_dev->netdev_class;
1365 /* Returns the name of 'netdev_dev'.
1367 * The caller must not free the returned value. */
1369 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1371 return netdev_dev->name;
1374 /* Returns the netdev_dev with 'name' or NULL if there is none.
1376 * The caller must not free the returned value. */
1378 netdev_dev_from_name(const char *name)
1380 return shash_find_data(&netdev_dev_shash, name);
1383 /* Fills 'device_list' with devices that match 'netdev_class'.
1385 * The caller is responsible for initializing and destroying 'device_list'
1386 * but the contained netdev_devs must not be freed. */
1388 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1389 struct shash *device_list)
1391 struct shash_node *node;
1392 SHASH_FOR_EACH (node, &netdev_dev_shash) {
1393 struct netdev_dev *dev = node->data;
1395 if (dev->netdev_class == netdev_class) {
1396 shash_add(device_list, node->name, node->data);
1401 /* Initializes 'netdev' as a instance of the netdev_dev.
1403 * This function adds 'netdev' to a netdev-owned linked list, so it is very
1404 * important that 'netdev' only be freed after calling netdev_close(). */
1406 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1408 memset(netdev, 0, sizeof *netdev);
1409 netdev->netdev_dev = netdev_dev;
1410 list_push_back(&netdev_list, &netdev->node);
1413 /* Undoes the results of initialization.
1415 * Normally this function only needs to be called from netdev_close().
1416 * However, it may be called by providers due to an error on opening
1417 * that occurs after initialization. It this case netdev_close() would
1418 * never be called. */
1420 netdev_uninit(struct netdev *netdev, bool close)
1422 /* Restore flags that we changed, if any. */
1423 int error = restore_flags(netdev);
1424 list_remove(&netdev->node);
1426 VLOG_WARN("failed to restore network device flags on %s: %s",
1427 netdev_get_name(netdev), strerror(error));
1431 netdev_get_dev(netdev)->netdev_class->close(netdev);
1436 /* Returns the class type of 'netdev'.
1438 * The caller must not free the returned value. */
1440 netdev_get_type(const struct netdev *netdev)
1442 return netdev_get_dev(netdev)->netdev_class->type;
1446 netdev_get_dev(const struct netdev *netdev)
1448 return netdev->netdev_dev;
1451 /* Restore the network device flags on 'netdev' to those that were active
1452 * before we changed them. Returns 0 if successful, otherwise a positive
1455 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1457 restore_flags(struct netdev *netdev)
1459 if (netdev->changed_flags) {
1460 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1461 enum netdev_flags old_flags;
1462 return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1463 netdev->changed_flags & ~restore,
1464 restore, &old_flags);
1469 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1470 * destroying devices, restoring flags, etc. */
1472 close_all_netdevs(void *aux OVS_UNUSED)
1474 struct netdev *netdev, *next;
1475 LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1476 netdev_close(netdev);