2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 /* Parses 'netdev_name_', which is of the form [type@]name into its component
336 * pieces. 'name' and 'type' must be freed by the caller. */
338 netdev_parse_name(const char *netdev_name_, char **name, char **type)
340 char *netdev_name = xstrdup(netdev_name_);
343 separator = strchr(netdev_name, '@');
347 *name = xstrdup(separator + 1);
350 *type = xstrdup("system");
354 /* Attempts to set up 'netdev' for receiving packets with netdev_recv().
355 * Returns 0 if successful, otherwise a positive errno value. EOPNOTSUPP
356 * indicates that the network device does not implement packet reception
357 * through this interface. */
359 netdev_listen(struct netdev *netdev)
361 int (*listen)(struct netdev *);
363 listen = netdev_get_dev(netdev)->netdev_class->listen;
364 return listen ? (listen)(netdev) : EOPNOTSUPP;
367 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
368 * must have initialized with sufficient room for the packet. The space
369 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
370 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
371 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
372 * need not be included.)
374 * This function can only be expected to return a packet if ->listen() has
375 * been called successfully.
377 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
378 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
379 * positive errno value. Returns EAGAIN immediately if no packet is ready to
382 * Some network devices may not implement support for this function. In such
383 * cases this function will always return EOPNOTSUPP. */
385 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
387 int (*recv)(struct netdev *, void *, size_t);
390 assert(buffer->size == 0);
391 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
393 recv = netdev_get_dev(netdev)->netdev_class->recv;
395 ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
398 COVERAGE_INC(netdev_received);
399 buffer->size += retval;
400 if (buffer->size < ETH_TOTAL_MIN) {
401 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
409 /* Registers with the poll loop to wake up from the next call to poll_block()
410 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
412 netdev_recv_wait(struct netdev *netdev)
414 void (*recv_wait)(struct netdev *);
416 recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
422 /* Discards all packets waiting to be received from 'netdev'. */
424 netdev_drain(struct netdev *netdev)
426 int (*drain)(struct netdev *);
428 drain = netdev_get_dev(netdev)->netdev_class->drain;
429 return drain ? drain(netdev) : 0;
432 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
433 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
434 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
435 * the packet is too big or too small to transmit on the device.
437 * The caller retains ownership of 'buffer' in all cases.
439 * The kernel maintains a packet transmission queue, so the caller is not
440 * expected to do additional queuing of packets.
442 * Some network devices may not implement support for this function. In such
443 * cases this function will always return EOPNOTSUPP. */
445 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
447 int (*send)(struct netdev *, const void *, size_t);
450 send = netdev_get_dev(netdev)->netdev_class->send;
451 error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
453 COVERAGE_INC(netdev_sent);
458 /* Registers with the poll loop to wake up from the next call to poll_block()
459 * when the packet transmission queue has sufficient room to transmit a packet
460 * with netdev_send().
462 * The kernel maintains a packet transmission queue, so the client is not
463 * expected to do additional queuing of packets. Thus, this function is
464 * unlikely to ever be used. It is included for completeness. */
466 netdev_send_wait(struct netdev *netdev)
468 void (*send_wait)(struct netdev *);
470 send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
476 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
477 * otherwise a positive errno value. */
479 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
481 return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
484 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
485 * the MAC address into 'mac'. On failure, returns a positive errno value and
486 * clears 'mac' to all-zeros. */
488 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
490 return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
493 /* Returns the name of the network device that 'netdev' represents,
494 * e.g. "eth0". The caller must not modify or free the returned string. */
496 netdev_get_name(const struct netdev *netdev)
498 return netdev_get_dev(netdev)->name;
501 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
502 * (and received) packets, in bytes, not including the hardware header; thus,
503 * this is typically 1500 bytes for Ethernet devices.
505 * If successful, returns 0 and stores the MTU size in '*mtup'. Returns
506 * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
507 * On other failure, returns a positive errno value. On failure, sets '*mtup'
510 netdev_get_mtu(const struct netdev *netdev, int *mtup)
512 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
515 error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
518 if (error != EOPNOTSUPP) {
519 VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: "
520 "%s", netdev_get_name(netdev), strerror(error));
526 /* Sets the MTU of 'netdev'. The MTU is the maximum size of transmitted
527 * (and received) packets, in bytes.
529 * If successful, returns 0. Returns EOPNOTSUPP if 'netdev' does not have an
530 * MTU (as e.g. some tunnels do not). On other failure, returns a positive
533 netdev_set_mtu(const struct netdev *netdev, int mtu)
535 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
538 error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
539 if (error && error != EOPNOTSUPP) {
540 VLOG_WARN_RL(&rl, "failed to set MTU for network device %s: %s",
541 netdev_get_name(netdev), strerror(error));
547 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
548 * failure, returns a negative errno value.
550 * The desired semantics of the ifindex value are a combination of those
551 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
552 * value should be unique within a host and remain stable at least until
553 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
554 * but many systems do not follow this rule anyhow.
556 * Some network devices may not implement support for this function. In such
557 * cases this function will always return -EOPNOTSUPP.
560 netdev_get_ifindex(const struct netdev *netdev)
562 int (*get_ifindex)(const struct netdev *);
564 get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
566 return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
569 /* Stores the features supported by 'netdev' into each of '*current',
570 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
571 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
572 * successful, otherwise a positive errno value. On failure, all of the
573 * passed-in values are set to 0.
575 * Some network devices may not implement support for this function. In such
576 * cases this function will always return EOPNOTSUPP. */
578 netdev_get_features(const struct netdev *netdev,
579 uint32_t *current, uint32_t *advertised,
580 uint32_t *supported, uint32_t *peer)
582 int (*get_features)(const struct netdev *netdev,
583 uint32_t *current, uint32_t *advertised,
584 uint32_t *supported, uint32_t *peer);
592 advertised = &dummy[1];
595 supported = &dummy[2];
601 get_features = netdev_get_dev(netdev)->netdev_class->get_features;
603 ? get_features(netdev, current, advertised, supported, peer)
606 *current = *advertised = *supported = *peer = 0;
611 /* Returns the maximum speed of a network connection that has the "enum
612 * ofp_port_features" bits in 'features', in bits per second. If no bits that
613 * indicate a speed are set in 'features', assumes 100Mbps. */
615 netdev_features_to_bps(uint32_t features)
618 F_10000MB = OFPPF_10GB_FD,
619 F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
620 F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
621 F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
624 return ( 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)
628 : UINT64_C(100000000));
631 /* Returns true if any of the "enum ofp_port_features" bits that indicate a
632 * full-duplex link are set in 'features', otherwise false. */
634 netdev_features_is_full_duplex(uint32_t features)
636 return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
637 | OFPPF_10GB_FD)) != 0;
640 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
641 * successful, otherwise a positive errno value. */
643 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
645 return (netdev_get_dev(netdev)->netdev_class->set_advertisements
646 ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
651 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
652 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
653 * errno value and sets '*address' to 0 (INADDR_ANY).
655 * The following error values have well-defined meanings:
657 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
659 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
661 * 'address' or 'netmask' or both may be null, in which case the address or
662 * netmask is not reported. */
664 netdev_get_in4(const struct netdev *netdev,
665 struct in_addr *address_, struct in_addr *netmask_)
667 struct in_addr address;
668 struct in_addr netmask;
671 error = (netdev_get_dev(netdev)->netdev_class->get_in4
672 ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
676 address_->s_addr = error ? 0 : address.s_addr;
679 netmask_->s_addr = error ? 0 : netmask.s_addr;
684 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
685 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
686 * positive errno value. */
688 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
690 return (netdev_get_dev(netdev)->netdev_class->set_in4
691 ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
695 /* Obtains ad IPv4 address from device name and save the address in
696 * in4. Returns 0 if successful, otherwise a positive errno value.
699 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
701 struct netdev *netdev;
704 error = netdev_open(device_name, "system", &netdev);
706 in4->s_addr = htonl(0);
710 error = netdev_get_in4(netdev, in4, NULL);
711 netdev_close(netdev);
715 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
718 netdev_add_router(struct netdev *netdev, struct in_addr router)
720 COVERAGE_INC(netdev_add_router);
721 return (netdev_get_dev(netdev)->netdev_class->add_router
722 ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
726 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
727 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
728 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
729 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
730 * a directly connected network) in '*next_hop' and a copy of the name of the
731 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
732 * responsible for freeing '*netdev_name' (by calling free()). */
734 netdev_get_next_hop(const struct netdev *netdev,
735 const struct in_addr *host, struct in_addr *next_hop,
738 int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
739 ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
740 host, next_hop, netdev_name)
743 next_hop->s_addr = 0;
749 /* Populates 'sh' with status information.
751 * Populates 'sh' with 'netdev' specific status information. This information
752 * may be used to populate the status column of the Interface table as defined
753 * in ovs-vswitchd.conf.db(5). */
755 netdev_get_status(const struct netdev *netdev, struct shash *sh)
757 struct netdev_dev *dev = netdev_get_dev(netdev);
759 return (dev->netdev_class->get_status
760 ? dev->netdev_class->get_status(netdev, sh)
764 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
765 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
766 * all-zero-bits (in6addr_any).
768 * The following error values have well-defined meanings:
770 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
772 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
774 * 'in6' may be null, in which case the address itself is not reported. */
776 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
778 struct in6_addr dummy;
781 error = (netdev_get_dev(netdev)->netdev_class->get_in6
782 ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
786 memset(in6, 0, sizeof *in6);
791 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
792 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
793 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
794 * successful, otherwise a positive errno value. */
796 do_update_flags(struct netdev *netdev, enum netdev_flags off,
797 enum netdev_flags on, enum netdev_flags *old_flagsp,
800 enum netdev_flags old_flags;
803 error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
804 off & ~on, on, &old_flags);
806 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
807 off || on ? "set" : "get", netdev_get_name(netdev),
810 } else if ((off || on) && !permanent) {
811 enum netdev_flags new_flags = (old_flags & ~off) | on;
812 enum netdev_flags changed_flags = old_flags ^ new_flags;
814 if (!netdev->changed_flags) {
815 netdev->save_flags = old_flags;
817 netdev->changed_flags |= changed_flags;
821 *old_flagsp = old_flags;
826 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
827 * Returns 0 if successful, otherwise a positive errno value. On failure,
828 * stores 0 into '*flagsp'. */
830 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
832 struct netdev *netdev = (struct netdev *) netdev_;
833 return do_update_flags(netdev, 0, 0, flagsp, false);
836 /* Sets the flags for 'netdev' to 'flags'.
837 * If 'permanent' is true, the changes will persist; otherwise, they
838 * will be reverted when 'netdev' is closed or the program exits.
839 * Returns 0 if successful, otherwise a positive errno value. */
841 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
844 return do_update_flags(netdev, -1, flags, NULL, permanent);
847 /* Turns on the specified 'flags' on 'netdev'.
848 * If 'permanent' is true, the changes will persist; otherwise, they
849 * will be reverted when 'netdev' is closed or the program exits.
850 * Returns 0 if successful, otherwise a positive errno value. */
852 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
855 return do_update_flags(netdev, 0, flags, NULL, permanent);
858 /* Turns off the specified 'flags' on 'netdev'.
859 * If 'permanent' is true, the changes will persist; otherwise, they
860 * will be reverted when 'netdev' is closed or the program exits.
861 * Returns 0 if successful, otherwise a positive errno value. */
863 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
866 return do_update_flags(netdev, flags, 0, NULL, permanent);
869 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
870 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
871 * returns 0. Otherwise, it returns a positive errno value; in particular,
872 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
874 netdev_arp_lookup(const struct netdev *netdev,
875 ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
877 int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
878 ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
882 memset(mac, 0, ETH_ADDR_LEN);
887 /* Returns true if carrier is active (link light is on) on 'netdev'. */
889 netdev_get_carrier(const struct netdev *netdev)
892 enum netdev_flags flags;
895 netdev_get_flags(netdev, &flags);
896 if (!(flags & NETDEV_UP)) {
900 if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
904 error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
907 VLOG_DBG("%s: failed to get network device carrier status, assuming "
908 "down: %s", netdev_get_name(netdev), strerror(error));
915 /* Returns the number of times 'netdev''s carrier has changed. */
917 netdev_get_carrier_resets(const struct netdev *netdev)
919 return (netdev_get_dev(netdev)->netdev_class->get_carrier_resets
920 ? netdev_get_dev(netdev)->netdev_class->get_carrier_resets(netdev)
924 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
925 * link status instead of checking 'netdev''s carrier. 'netdev''s MII
926 * registers will be polled once ever 'interval' milliseconds. If 'netdev'
927 * does not support MII, another method may be used as a fallback. If
928 * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
929 * its normal behavior.
931 * Returns 0 if successful, otherwise a positive errno value. */
933 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
935 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
936 return (netdev_dev->netdev_class->set_miimon_interval
937 ? netdev_dev->netdev_class->set_miimon_interval(netdev, interval)
941 /* Retrieves current device stats for 'netdev'. */
943 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
947 COVERAGE_INC(netdev_get_stats);
948 error = (netdev_get_dev(netdev)->netdev_class->get_stats
949 ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
952 memset(stats, 0xff, sizeof *stats);
957 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
958 * Returns 0 if successful, otherwise a positive errno value.
960 * This will probably fail for most network devices. Some devices might only
961 * allow setting their stats to 0. */
963 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
965 return (netdev_get_dev(netdev)->netdev_class->set_stats
966 ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
970 /* Attempts to set input rate limiting (policing) policy, such that up to
971 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
972 * size of 'kbits' kb. */
974 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
975 uint32_t kbits_burst)
977 return (netdev_get_dev(netdev)->netdev_class->set_policing
978 ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
979 kbits_rate, kbits_burst)
983 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
984 * empty if 'netdev' does not support QoS. Any names added to 'types' should
985 * be documented as valid for the "type" column in the "QoS" table in
986 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
988 * Every network device supports disabling QoS with a type of "", but this type
989 * will not be added to 'types'.
991 * The caller must initialize 'types' (e.g. with sset_init()) before calling
992 * this function. The caller is responsible for destroying 'types' (e.g. with
993 * sset_destroy()) when it is no longer needed.
995 * Returns 0 if successful, otherwise a positive errno value. */
997 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
999 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1000 return (class->get_qos_types
1001 ? class->get_qos_types(netdev, types)
1005 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1006 * which should be "" or one of the types returned by netdev_get_qos_types()
1007 * for 'netdev'. Returns 0 if successful, otherwise a positive errno value.
1008 * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1009 * 'caps' to all zeros. */
1011 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1012 struct netdev_qos_capabilities *caps)
1014 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1017 int retval = (class->get_qos_capabilities
1018 ? class->get_qos_capabilities(netdev, type, caps)
1021 memset(caps, 0, sizeof *caps);
1025 /* Every netdev supports turning off QoS. */
1026 memset(caps, 0, sizeof *caps);
1031 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1032 * of QoS. Returns 0 if successful, otherwise a positive errno value. Stores
1033 * the number of queues (zero on failure) in '*n_queuesp'.
1035 * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1037 netdev_get_n_queues(const struct netdev *netdev,
1038 const char *type, unsigned int *n_queuesp)
1040 struct netdev_qos_capabilities caps;
1043 retval = netdev_get_qos_capabilities(netdev, type, &caps);
1044 *n_queuesp = caps.n_queues;
1048 /* Queries 'netdev' about its currently configured form of QoS. If successful,
1049 * stores the name of the current form of QoS into '*typep', stores any details
1050 * of configuration as string key-value pairs in 'details', and returns 0. On
1051 * failure, sets '*typep' to NULL and returns a positive errno value.
1053 * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1055 * The caller must initialize 'details' as an empty shash (e.g. with
1056 * shash_init()) before calling this function. The caller must free 'details',
1057 * including 'data' members, when it is no longer needed (e.g. with
1058 * shash_destroy_free_data()).
1060 * The caller must not modify or free '*typep'.
1062 * '*typep' will be one of the types returned by netdev_get_qos_types() for
1063 * 'netdev'. The contents of 'details' should be documented as valid for
1064 * '*typep' in the "other_config" column in the "QoS" table in
1065 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1067 netdev_get_qos(const struct netdev *netdev,
1068 const char **typep, struct shash *details)
1070 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1073 if (class->get_qos) {
1074 retval = class->get_qos(netdev, typep, details);
1077 shash_clear_free_data(details);
1081 /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1087 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1088 * with details of configuration from 'details'. Returns 0 if successful,
1089 * otherwise a positive errno value. On error, the previous QoS configuration
1092 * When this function changes the type of QoS (not just 'details'), this also
1093 * resets all queue configuration for 'netdev' to their defaults (which depend
1094 * on the specific type of QoS). Otherwise, the queue configuration for
1095 * 'netdev' is unchanged.
1097 * 'type' should be "" (to disable QoS) or one of the types returned by
1098 * netdev_get_qos_types() for 'netdev'. The contents of 'details' should be
1099 * documented as valid for the given 'type' in the "other_config" column in the
1100 * "QoS" table in vswitchd/vswitch.xml (which is built as
1101 * ovs-vswitchd.conf.db(8)).
1103 * NULL may be specified for 'details' if there are no configuration
1106 netdev_set_qos(struct netdev *netdev,
1107 const char *type, const struct shash *details)
1109 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1115 if (class->set_qos) {
1117 static struct shash empty = SHASH_INITIALIZER(&empty);
1120 return class->set_qos(netdev, type, details);
1122 return *type ? EOPNOTSUPP : 0;
1126 /* Queries 'netdev' for information about the queue numbered 'queue_id'. If
1127 * successful, adds that information as string key-value pairs to 'details'.
1128 * Returns 0 if successful, otherwise a positive errno value.
1130 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1131 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1133 * The returned contents of 'details' should be documented as valid for the
1134 * given 'type' in the "other_config" column in the "Queue" table in
1135 * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1137 * The caller must initialize 'details' (e.g. with shash_init()) before calling
1138 * this function. The caller must free 'details', including 'data' members,
1139 * when it is no longer needed (e.g. with shash_destroy_free_data()). */
1141 netdev_get_queue(const struct netdev *netdev,
1142 unsigned int queue_id, struct shash *details)
1144 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1147 retval = (class->get_queue
1148 ? class->get_queue(netdev, queue_id, details)
1151 shash_clear_free_data(details);
1156 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1157 * string pairs in 'details'. The contents of 'details' should be documented
1158 * as valid for the given 'type' in the "other_config" column in the "Queue"
1159 * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1160 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1161 * given queue's configuration should be unmodified.
1163 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1164 * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1166 * This function does not modify 'details', and the caller retains ownership of
1169 netdev_set_queue(struct netdev *netdev,
1170 unsigned int queue_id, const struct shash *details)
1172 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1173 return (class->set_queue
1174 ? class->set_queue(netdev, queue_id, details)
1178 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'. Some kinds
1179 * of QoS may have a fixed set of queues, in which case attempts to delete them
1180 * will fail with EOPNOTSUPP.
1182 * Returns 0 if successful, otherwise a positive errno value. On failure, the
1183 * given queue will be unmodified.
1185 * 'queue_id' must be less than the number of queues supported by 'netdev' for
1186 * the current form of QoS (e.g. as returned by
1187 * netdev_get_n_queues(netdev)). */
1189 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1191 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1192 return (class->delete_queue
1193 ? class->delete_queue(netdev, queue_id)
1197 /* Obtains statistics about 'queue_id' on 'netdev'. On success, returns 0 and
1198 * fills 'stats' with the queue's statistics; individual members of 'stats' may
1199 * be set to all-1-bits if the statistic is unavailable. On failure, returns a
1200 * positive errno value and fills 'stats' with all-1-bits. */
1202 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1203 struct netdev_queue_stats *stats)
1205 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1208 retval = (class->get_queue_stats
1209 ? class->get_queue_stats(netdev, queue_id, stats)
1212 memset(stats, 0xff, sizeof *stats);
1217 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1218 * its configuration, and the 'aux' specified by the caller. The order of
1219 * iteration is unspecified, but (when successful) each queue is visited
1222 * Calling this function may be more efficient than calling netdev_get_queue()
1225 * 'cb' must not modify or free the 'details' argument passed in.
1227 * Returns 0 if successful, otherwise a positive errno value. On error, some
1228 * configured queues may not have been included in the iteration. */
1230 netdev_dump_queues(const struct netdev *netdev,
1231 netdev_dump_queues_cb *cb, void *aux)
1233 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1234 return (class->dump_queues
1235 ? class->dump_queues(netdev, cb, aux)
1239 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1240 * its statistics, and the 'aux' specified by the caller. The order of
1241 * iteration is unspecified, but (when successful) each queue is visited
1244 * Calling this function may be more efficient than calling
1245 * netdev_get_queue_stats() for every queue.
1247 * 'cb' must not modify or free the statistics passed in.
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_queue_stats(const struct netdev *netdev,
1253 netdev_dump_queue_stats_cb *cb, void *aux)
1255 const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1256 return (class->dump_queue_stats
1257 ? class->dump_queue_stats(netdev, cb, aux)
1261 /* Returns a sequence number which indicates changes in one of 'netdev''s
1262 * properties. The returned sequence will be nonzero so that callers have a
1263 * value which they may use as a reset when tracking 'netdev'.
1265 * The returned sequence number will change whenever 'netdev''s flags,
1266 * features, ethernet address, or carrier changes. It may change for other
1267 * reasons as well, or no reason at all. */
1269 netdev_change_seq(const struct netdev *netdev)
1271 return netdev_get_dev(netdev)->netdev_class->change_seq(netdev);
1274 /* Initializes 'netdev_dev' as a netdev device named 'name' of the specified
1275 * 'netdev_class'. This function is ordinarily called from a netdev provider's
1276 * 'create' function.
1278 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1279 * very important that 'netdev_dev' only be freed after calling
1280 * the refcount drops to zero. */
1282 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1283 const struct netdev_class *netdev_class)
1285 assert(!shash_find(&netdev_dev_shash, name));
1287 memset(netdev_dev, 0, sizeof *netdev_dev);
1288 netdev_dev->netdev_class = netdev_class;
1289 netdev_dev->name = xstrdup(name);
1290 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1293 /* Undoes the results of initialization.
1295 * Normally this function does not need to be called as netdev_close has
1296 * the same effect when the refcount drops to zero.
1297 * However, it may be called by providers due to an error on creation
1298 * that occurs after initialization. It this case netdev_close() would
1299 * never be called. */
1301 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1303 char *name = netdev_dev->name;
1305 assert(!netdev_dev->ref_cnt);
1307 shash_delete(&netdev_dev_shash, netdev_dev->node);
1310 netdev_dev->netdev_class->destroy(netdev_dev);
1315 /* Returns the class type of 'netdev_dev'.
1317 * The caller must not free the returned value. */
1319 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1321 return netdev_dev->netdev_class->type;
1324 /* Returns the class associated with 'netdev_dev'. */
1325 const struct netdev_class *
1326 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1328 return netdev_dev->netdev_class;
1331 /* Returns the name of 'netdev_dev'.
1333 * The caller must not free the returned value. */
1335 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1337 return netdev_dev->name;
1340 /* Returns the netdev_dev with 'name' or NULL if there is none.
1342 * The caller must not free the returned value. */
1344 netdev_dev_from_name(const char *name)
1346 return shash_find_data(&netdev_dev_shash, name);
1349 /* Fills 'device_list' with devices that match 'netdev_class'.
1351 * The caller is responsible for initializing and destroying 'device_list'
1352 * but the contained netdev_devs must not be freed. */
1354 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1355 struct shash *device_list)
1357 struct shash_node *node;
1358 SHASH_FOR_EACH (node, &netdev_dev_shash) {
1359 struct netdev_dev *dev = node->data;
1361 if (dev->netdev_class == netdev_class) {
1362 shash_add(device_list, node->name, node->data);
1367 /* Initializes 'netdev' as a instance of the netdev_dev.
1369 * This function adds 'netdev' to a netdev-owned linked list, so it is very
1370 * important that 'netdev' only be freed after calling netdev_close(). */
1372 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1374 memset(netdev, 0, sizeof *netdev);
1375 netdev->netdev_dev = netdev_dev;
1376 list_push_back(&netdev_list, &netdev->node);
1379 /* Undoes the results of initialization.
1381 * Normally this function only needs to be called from netdev_close().
1382 * However, it may be called by providers due to an error on opening
1383 * that occurs after initialization. It this case netdev_close() would
1384 * never be called. */
1386 netdev_uninit(struct netdev *netdev, bool close)
1388 /* Restore flags that we changed, if any. */
1389 int error = restore_flags(netdev);
1390 list_remove(&netdev->node);
1392 VLOG_WARN("failed to restore network device flags on %s: %s",
1393 netdev_get_name(netdev), strerror(error));
1397 netdev_get_dev(netdev)->netdev_class->close(netdev);
1402 /* Returns the class type of 'netdev'.
1404 * The caller must not free the returned value. */
1406 netdev_get_type(const struct netdev *netdev)
1408 return netdev_get_dev(netdev)->netdev_class->type;
1412 netdev_get_dev(const struct netdev *netdev)
1414 return netdev->netdev_dev;
1417 /* Restore the network device flags on 'netdev' to those that were active
1418 * before we changed them. Returns 0 if successful, otherwise a positive
1421 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1423 restore_flags(struct netdev *netdev)
1425 if (netdev->changed_flags) {
1426 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1427 enum netdev_flags old_flags;
1428 return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1429 netdev->changed_flags & ~restore,
1430 restore, &old_flags);
1435 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1436 * destroying devices, restoring flags, etc. */
1438 close_all_netdevs(void *aux OVS_UNUSED)
1440 struct netdev *netdev, *next;
1441 LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1442 netdev_close(netdev);