2 * Copyright (c) 2008, 2009 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"
32 #include "netdev-provider.h"
35 #include "poll-loop.h"
39 #define THIS_MODULE VLM_netdev
42 static const struct netdev_class *netdev_classes[] = {
46 static int n_netdev_classes = ARRAY_SIZE(netdev_classes);
48 /* All open network devices. */
49 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
51 /* This is set pretty low because we probably won't learn anything from the
52 * additional log messages. */
53 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
55 static void restore_all_flags(void *aux);
56 static int restore_flags(struct netdev *netdev);
58 /* Attempts to initialize the netdev module. Returns 0 if successful,
59 * otherwise a positive errno value.
61 * Calling this function is optional. If not called explicitly, it will
62 * automatically be called upon the first attempt to open a network device. */
64 netdev_initialize(void)
66 static int status = -1;
70 fatal_signal_add_hook(restore_all_flags, NULL, true);
73 for (i = j = 0; i < n_netdev_classes; i++) {
74 const struct netdev_class *class = netdev_classes[i];
76 int retval = class->init();
78 netdev_classes[j++] = class;
80 VLOG_ERR("failed to initialize %s network device "
81 "class: %s", class->name, strerror(retval));
93 /* Performs periodic work needed by all the various kinds of netdevs.
95 * If your program opens any netdevs, it must call this function within its
101 for (i = 0; i < n_netdev_classes; i++) {
102 const struct netdev_class *class = netdev_classes[i];
109 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
111 * If your program opens any netdevs, it must call this function within its
117 for (i = 0; i < n_netdev_classes; i++) {
118 const struct netdev_class *class = netdev_classes[i];
125 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
126 * successful, otherwise a positive errno value. On success, sets '*netdevp'
127 * to the new network device, otherwise to null.
129 * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
130 * capture frames of that type received on the device. It may also be one of
131 * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
134 netdev_open(const char *name_, int ethertype, struct netdev **netdevp)
136 char *name = xstrdup(name_);
137 char *prefix, *suffix, *colon;
138 struct netdev *netdev = NULL;
143 colon = strchr(name, ':');
153 for (i = 0; i < n_netdev_classes; i++) {
154 const struct netdev_class *class = netdev_classes[i];
155 if (!strcmp(prefix, class->prefix)) {
156 error = class->open(name_, suffix, ethertype, &netdev);
160 error = EAFNOSUPPORT;
163 *netdevp = error ? NULL : netdev;
167 /* Closes and destroys 'netdev'. */
169 netdev_close(struct netdev *netdev)
175 /* Restore flags that we changed, if any. */
176 fatal_signal_block();
177 error = restore_flags(netdev);
178 list_remove(&netdev->node);
179 fatal_signal_unblock();
181 VLOG_WARN("failed to restore network device flags on %s: %s",
182 netdev->name, strerror(error));
187 netdev->class->close(netdev);
192 /* Returns true if a network device named 'name' exists and may be opened,
193 * otherwise false. */
195 netdev_exists(const char *name)
197 struct netdev *netdev;
200 error = netdev_open(name, NETDEV_ETH_TYPE_NONE, &netdev);
202 netdev_close(netdev);
205 if (error != ENODEV) {
206 VLOG_WARN("failed to open network device %s: %s",
207 name, strerror(error));
213 /* Initializes 'svec' with a list of the names of all known network devices. */
215 netdev_enumerate(struct svec *svec)
225 for (i = 0; i < n_netdev_classes; i++) {
226 const struct netdev_class *class = netdev_classes[i];
227 if (class->enumerate) {
228 int retval = class->enumerate(svec);
230 VLOG_WARN("failed to enumerate %s network devices: %s",
231 class->name, strerror(retval));
241 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
242 * must have initialized with sufficient room for the packet. The space
243 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
244 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
245 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
246 * need not be included.)
248 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
249 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
250 * positive errno value. Returns EAGAIN immediately if no packet is ready to
254 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
258 assert(buffer->size == 0);
259 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
261 retval = netdev->class->recv(netdev,
262 buffer->data, ofpbuf_tailroom(buffer));
264 COVERAGE_INC(netdev_received);
265 buffer->size += retval;
266 if (buffer->size < ETH_TOTAL_MIN) {
267 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
275 /* Registers with the poll loop to wake up from the next call to poll_block()
276 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
278 netdev_recv_wait(struct netdev *netdev)
280 netdev->class->recv_wait(netdev);
283 /* Discards all packets waiting to be received from 'netdev'. */
285 netdev_drain(struct netdev *netdev)
287 return netdev->class->drain(netdev);
290 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
291 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
292 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
293 * the packet is too big or too small to transmit on the device.
295 * The caller retains ownership of 'buffer' in all cases.
297 * The kernel maintains a packet transmission queue, so the caller is not
298 * expected to do additional queuing of packets. */
300 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
302 int error = netdev->class->send(netdev, buffer->data, buffer->size);
304 COVERAGE_INC(netdev_sent);
309 /* Registers with the poll loop to wake up from the next call to poll_block()
310 * when the packet transmission queue has sufficient room to transmit a packet
311 * with netdev_send().
313 * The kernel maintains a packet transmission queue, so the client is not
314 * expected to do additional queuing of packets. Thus, this function is
315 * unlikely to ever be used. It is included for completeness. */
317 netdev_send_wait(struct netdev *netdev)
319 return netdev->class->send_wait(netdev);
322 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
323 * otherwise a positive errno value. */
325 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
327 return netdev->class->set_etheraddr(netdev, mac);
330 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
331 * the MAC address into 'mac'. On failure, returns a positive errno value and
332 * clears 'mac' to all-zeros. */
334 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
336 return netdev->class->get_etheraddr(netdev, mac);
339 /* Returns the name of the network device that 'netdev' represents,
340 * e.g. "eth0". The caller must not modify or free the returned string. */
342 netdev_get_name(const struct netdev *netdev)
347 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
348 * (and received) packets, in bytes, not including the hardware header; thus,
349 * this is typically 1500 bytes for Ethernet devices.
351 * If successful, returns 0 and stores the MTU size in '*mtup'. On failure,
352 * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
355 netdev_get_mtu(const struct netdev *netdev, int *mtup)
357 int error = netdev->class->get_mtu(netdev, mtup);
359 VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
360 netdev_get_name(netdev), strerror(error));
361 *mtup = ETH_PAYLOAD_MAX;
366 /* Stores the features supported by 'netdev' into each of '*current',
367 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
368 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
369 * successful, otherwise a positive errno value. On failure, all of the
370 * passed-in values are set to 0. */
372 netdev_get_features(struct netdev *netdev,
373 uint32_t *current, uint32_t *advertised,
374 uint32_t *supported, uint32_t *peer)
377 return netdev->class->get_features(netdev,
378 current ? current : &dummy[0],
379 advertised ? advertised : &dummy[1],
380 supported ? supported : &dummy[2],
381 peer ? peer : &dummy[3]);
384 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
385 * successful, otherwise a positive errno value. */
387 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
389 return (netdev->class->set_advertisements
390 ? netdev->class->set_advertisements(netdev, advertise)
394 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
395 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
396 * errno value and sets '*address' to 0 (INADDR_ANY).
398 * The following error values have well-defined meanings:
400 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
402 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
404 * 'address' or 'netmask' or both may be null, in which case the address or netmask
405 * is not reported. */
407 netdev_get_in4(const struct netdev *netdev,
408 struct in_addr *address_, struct in_addr *netmask_)
410 struct in_addr address;
411 struct in_addr netmask;
414 error = (netdev->class->get_in4
415 ? netdev->class->get_in4(netdev, &address, &netmask)
418 address_->s_addr = error ? 0 : address.s_addr;
421 netmask_->s_addr = error ? 0 : netmask.s_addr;
426 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
427 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
428 * positive errno value. */
430 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
432 return (netdev->class->set_in4
433 ? netdev->class->set_in4(netdev, addr, mask)
437 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
440 netdev_add_router(struct netdev *netdev, struct in_addr router)
442 COVERAGE_INC(netdev_add_router);
443 return (netdev->class->add_router
444 ? netdev->class->add_router(netdev, router)
448 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
449 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
450 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
451 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
452 * a directly connected network) in '*next_hop' and a copy of the name of the
453 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
454 * responsible for freeing '*netdev_name' (by calling free()). */
456 netdev_get_next_hop(const struct netdev *netdev,
457 const struct in_addr *host, struct in_addr *next_hop,
460 int error = (netdev->class->get_next_hop
461 ? netdev->class->get_next_hop(host, next_hop, netdev_name)
464 next_hop->s_addr = 0;
470 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
471 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
472 * all-zero-bits (in6addr_any).
474 * The following error values have well-defined meanings:
476 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
478 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
480 * 'in6' may be null, in which case the address itself is not reported. */
482 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
484 struct in6_addr dummy;
487 error = (netdev->class->get_in6
488 ? netdev->class->get_in6(netdev, in6 ? in6 : &dummy)
491 memset(in6, 0, sizeof *in6);
496 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
497 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
498 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
499 * successful, otherwise a positive errno value. */
501 do_update_flags(struct netdev *netdev, enum netdev_flags off,
502 enum netdev_flags on, enum netdev_flags *old_flagsp,
505 enum netdev_flags old_flags;
508 error = netdev->class->update_flags(netdev, off & ~on, on, &old_flags);
510 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
511 off || on ? "set" : "get", netdev_get_name(netdev),
514 } else if ((off || on) && !permanent) {
515 enum netdev_flags new_flags = (old_flags & ~off) | on;
516 enum netdev_flags changed_flags = old_flags ^ new_flags;
518 if (!netdev->changed_flags) {
519 netdev->save_flags = old_flags;
521 netdev->changed_flags |= changed_flags;
525 *old_flagsp = old_flags;
530 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
531 * Returns 0 if successful, otherwise a positive errno value. On failure,
532 * stores 0 into '*flagsp'. */
534 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
536 struct netdev *netdev = (struct netdev *) netdev_;
537 return do_update_flags(netdev, 0, 0, flagsp, false);
540 /* Sets the flags for 'netdev' to 'flags'.
541 * If 'permanent' is true, the changes will persist; otherwise, they
542 * will be reverted when 'netdev' is closed or the program exits.
543 * Returns 0 if successful, otherwise a positive errno value. */
545 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
548 return do_update_flags(netdev, -1, flags, NULL, permanent);
551 /* Turns on the specified 'flags' on 'netdev'.
552 * If 'permanent' is true, the changes will persist; otherwise, they
553 * will be reverted when 'netdev' is closed or the program exits.
554 * Returns 0 if successful, otherwise a positive errno value. */
556 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
559 return do_update_flags(netdev, 0, flags, NULL, permanent);
562 /* Turns off the specified 'flags' on 'netdev'.
563 * If 'permanent' is true, the changes will persist; otherwise, they
564 * will be reverted when 'netdev' is closed or the program exits.
565 * Returns 0 if successful, otherwise a positive errno value. */
567 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
570 return do_update_flags(netdev, flags, 0, NULL, permanent);
573 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
574 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
575 * returns 0. Otherwise, it returns a positive errno value; in particular,
576 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
578 netdev_arp_lookup(const struct netdev *netdev,
579 uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
581 int error = (netdev->class->arp_lookup
582 ? netdev->class->arp_lookup(netdev, ip, mac)
585 memset(mac, 0, ETH_ADDR_LEN);
590 /* Sets 'carrier' to true if carrier is active (link light is on) on
593 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
595 int error = (netdev->class->get_carrier
596 ? netdev->class->get_carrier(netdev, carrier)
604 /* Retrieves current device stats for 'netdev'. */
606 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
610 COVERAGE_INC(netdev_get_stats);
611 error = (netdev->class->get_stats
612 ? netdev->class->get_stats(netdev, stats)
615 memset(stats, 0xff, sizeof *stats);
620 /* Attempts to set input rate limiting (policing) policy, such that up to
621 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
622 * size of 'kbits' kb. */
624 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
625 uint32_t kbits_burst)
627 return (netdev->class->set_policing
628 ? netdev->class->set_policing(netdev, kbits_rate, kbits_burst)
632 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
633 * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
634 * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
635 * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
638 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
640 int error = (netdev->class->get_vlan_vid
641 ? netdev->class->get_vlan_vid(netdev, vlan_vid)
649 /* Returns a network device that has 'in4' as its IP address, if one exists,
650 * otherwise a null pointer. */
652 netdev_find_dev_by_in4(const struct in_addr *in4)
654 struct netdev *netdev;
655 struct svec dev_list;
658 netdev_enumerate(&dev_list);
659 for (i = 0; i < dev_list.n; i++) {
660 const char *name = dev_list.names[i];
661 struct in_addr dev_in4;
663 if (!netdev_open(name, NETDEV_ETH_TYPE_NONE, &netdev)
664 && !netdev_get_in4(netdev, &dev_in4, NULL)
665 && dev_in4.s_addr == in4->s_addr) {
668 netdev_close(netdev);
673 svec_destroy(&dev_list);
677 /* Initializes 'netdev' as a netdev named 'name' of the specified 'class'.
679 * This function adds 'netdev' to a netdev-owned linked list, so it is very
680 * important that 'netdev' only be freed after calling netdev_close(). */
682 netdev_init(struct netdev *netdev, const char *name,
683 const struct netdev_class *class)
685 netdev->class = class;
686 netdev->name = xstrdup(name);
687 netdev->save_flags = 0;
688 netdev->changed_flags = 0;
689 list_push_back(&netdev_list, &netdev->node);
692 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
693 * notification will consist of calling 'cb', with auxiliary data 'aux'. */
695 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
696 void (*cb)(struct netdev_notifier *), void *aux)
698 notifier->netdev = netdev;
703 /* Tracks changes in the status of a set of network devices. */
704 struct netdev_monitor {
705 struct shash polled_netdevs;
706 struct shash changed_netdevs;
709 /* Creates and returns a new structure for monitor changes in the status of
710 * network devices. */
711 struct netdev_monitor *
712 netdev_monitor_create(void)
714 struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
715 shash_init(&monitor->polled_netdevs);
716 shash_init(&monitor->changed_netdevs);
720 /* Destroys 'monitor'. */
722 netdev_monitor_destroy(struct netdev_monitor *monitor)
725 struct shash_node *node;
727 SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
728 struct netdev_notifier *notifier = node->data;
729 notifier->netdev->class->poll_remove(notifier);
732 shash_destroy(&monitor->polled_netdevs);
733 shash_destroy(&monitor->changed_netdevs);
739 netdev_monitor_cb(struct netdev_notifier *notifier)
741 struct netdev_monitor *monitor = notifier->aux;
742 const char *name = netdev_get_name(notifier->netdev);
743 if (!shash_find(&monitor->changed_netdevs, name)) {
744 shash_add(&monitor->changed_netdevs, name, NULL);
748 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'. Returns 0 if
749 * successful, otherwise a positive errno value.
751 * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
754 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
756 const char *netdev_name = netdev_get_name(netdev);
758 if (!shash_find(&monitor->polled_netdevs, netdev_name)
759 && netdev->class->poll_add)
761 struct netdev_notifier *notifier;
762 error = netdev->class->poll_add(netdev, netdev_monitor_cb, monitor,
765 assert(notifier->netdev == netdev);
766 shash_add(&monitor->polled_netdevs, netdev_name, notifier);
772 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'. (This has
773 * no effect if 'netdev' is not in the set of devices monitored by
776 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
778 const char *netdev_name = netdev_get_name(netdev);
779 struct shash_node *node;
781 node = shash_find(&monitor->polled_netdevs, netdev_name);
783 /* Cancel future notifications. */
784 struct netdev_notifier *notifier = node->data;
785 netdev->class->poll_remove(notifier);
786 shash_delete(&monitor->polled_netdevs, node);
788 /* Drop any pending notification. */
789 node = shash_find(&monitor->changed_netdevs, netdev_name);
791 shash_delete(&monitor->changed_netdevs, node);
796 /* Checks for changes to netdevs in the set monitored by 'monitor'. If any of
797 * the attributes (Ethernet address, carrier status, speed or peer-advertised
798 * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
799 * sets '*devnamep' to the name of a device that has changed and returns 0.
800 * The caller is responsible for freeing '*devnamep' (with free()).
802 * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
805 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
807 struct shash_node *node = shash_first(&monitor->changed_netdevs);
812 *devnamep = xstrdup(node->name);
813 shash_delete(&monitor->changed_netdevs, node);
818 /* Registers with the poll loop to wake up from the next call to poll_block()
819 * when netdev_monitor_poll(monitor) would indicate that a device has
822 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
824 if (!shash_is_empty(&monitor->changed_netdevs)) {
825 poll_immediate_wake();
827 /* XXX Nothing needed here for netdev_linux, but maybe other netdev
828 * classes need help. */
832 /* Restore the network device flags on 'netdev' to those that were active
833 * before we changed them. Returns 0 if successful, otherwise a positive
836 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
838 restore_flags(struct netdev *netdev)
840 if (netdev->changed_flags) {
841 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
842 enum netdev_flags old_flags;
843 return netdev->class->update_flags(netdev,
844 netdev->changed_flags & ~restore,
845 restore, &old_flags);
850 /* Retores all the flags on all network devices that we modified. Called from
851 * a signal handler, so it does not attempt to report error conditions. */
853 restore_all_flags(void *aux UNUSED)
855 struct netdev *netdev;
856 LIST_FOR_EACH (netdev, struct netdev, node, &netdev_list) {
857 restore_flags(netdev);