2 * Copyright (c) 2008, 2009, 2010 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"
36 #include "poll-loop.h"
40 #define THIS_MODULE VLM_netdev
43 static const struct netdev_class *netdev_classes[] = {
48 static int n_netdev_classes = ARRAY_SIZE(netdev_classes);
50 /* All created network devices. */
51 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
53 /* All open network devices. */
54 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
56 /* This is set pretty low because we probably won't learn anything from the
57 * additional log messages. */
58 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
60 static void restore_all_flags(void *aux);
61 static int restore_flags(struct netdev *netdev);
63 /* Attempts to initialize the netdev module. Returns 0 if successful,
64 * otherwise a positive errno value.
66 * Calling this function is optional. If not called explicitly, it will
67 * automatically be called upon the first attempt to open or create a
70 netdev_initialize(void)
72 static int status = -1;
76 fatal_signal_add_hook(restore_all_flags, NULL, true);
79 for (i = j = 0; i < n_netdev_classes; i++) {
80 const struct netdev_class *class = netdev_classes[i];
82 int retval = class->init();
84 netdev_classes[j++] = class;
86 VLOG_ERR("failed to initialize %s network device "
87 "class: %s", class->type, strerror(retval));
93 netdev_classes[j++] = class;
101 /* Performs periodic work needed by all the various kinds of netdevs.
103 * If your program opens any netdevs, it must call this function within its
109 for (i = 0; i < n_netdev_classes; i++) {
110 const struct netdev_class *class = netdev_classes[i];
117 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
119 * If your program opens any netdevs, it must call this function within its
125 for (i = 0; i < n_netdev_classes; i++) {
126 const struct netdev_class *class = netdev_classes[i];
134 create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
138 if (!options->may_create) {
139 VLOG_WARN("attempted to create a device that may not be created: %s",
144 if (!options->type || strlen(options->type) == 0) {
145 /* Default to system. */
146 options->type = "system";
149 for (i = 0; i < n_netdev_classes; i++) {
150 const struct netdev_class *class = netdev_classes[i];
152 if (!strcmp(options->type, class->type)) {
153 return class->create(options->name, options->type, options->args,
158 VLOG_WARN("could not create netdev %s of unknown type %s", options->name,
164 shash_hash(const struct shash *shash)
167 struct shash_node *node;
170 SHASH_FOR_EACH(node, shash) {
171 entry_hash = hash_string(node->name, 0);
172 entry_hash ^= hash_string(node->data, 10);
173 hash ^= hash_int(entry_hash, 0);
179 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
180 * successful, otherwise a positive errno value. On success, sets '*netdevp'
181 * to the new network device, otherwise to null.
183 * If this is the first time the device has been opened, then create is called
184 * before opening. The device is created using the given type and arguments.
186 * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
187 * capture frames of that type received on the device. It may also be one of
188 * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
191 * If the 'may_create' flag is set then this is allowed to be the first time
192 * the device is opened (i.e. the refcount will be 1 after this call). It
193 * may be set to false if the device should have already been created.
195 * If the 'may_open' flag is set then the call will succeed even if another
196 * caller has already opened it. It may be to false if the device should not
197 * currently be open. */
200 netdev_open(struct netdev_options *options, struct netdev **netdevp)
202 struct shash empty_args = SHASH_INITIALIZER(&empty_args);
203 struct netdev_dev *netdev_dev;
209 if (!options->args) {
210 options->args = &empty_args;
213 netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
216 error = create_device(options, &netdev_dev);
221 netdev_dev->args_hash = shash_hash(options->args);
223 } else if (options->may_open) {
224 if (!shash_is_empty(options->args)) {
225 uint32_t args_hash = shash_hash(options->args);
227 if (args_hash != netdev_dev->args_hash) {
228 VLOG_WARN("attempted to open already created netdev with "
229 "different arguments: %s", options->name);
234 VLOG_WARN("attempted to create a netdev device with bound name: %s",
239 error = netdev_dev->class->open(netdev_dev, options->ethertype, netdevp);
242 netdev_dev->ref_cnt++;
244 if (!netdev_dev->ref_cnt) {
245 netdev_dev_uninit(netdev_dev, true);
253 netdev_open_default(const char *name, struct netdev **netdevp)
255 struct netdev_options options;
257 memset(&options, 0, sizeof options);
260 options.ethertype = NETDEV_ETH_TYPE_NONE;
261 options.may_create = true;
262 options.may_open = true;
264 return netdev_open(&options, netdevp);
267 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
268 * or NULL if none are needed. */
270 netdev_reconfigure(struct netdev *netdev, const struct shash *args)
272 struct shash empty_args = SHASH_INITIALIZER(&empty_args);
273 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
279 if (netdev_dev->class->reconfigure) {
280 uint32_t args_hash = shash_hash(args);
282 if (netdev_dev->args_hash != args_hash) {
283 netdev_dev->args_hash = args_hash;
284 return netdev_dev->class->reconfigure(netdev_dev, args);
291 /* Closes and destroys 'netdev'. */
293 netdev_close(struct netdev *netdev)
296 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
298 assert(netdev_dev->ref_cnt);
299 netdev_dev->ref_cnt--;
300 netdev_uninit(netdev, true);
302 /* If the reference count for the netdev device is zero, destroy it. */
303 if (!netdev_dev->ref_cnt) {
304 netdev_dev_uninit(netdev_dev, true);
309 /* Returns true if a network device named 'name' exists and may be opened,
310 * otherwise false. */
312 netdev_exists(const char *name)
314 struct netdev *netdev;
317 error = netdev_open_default(name, &netdev);
319 netdev_close(netdev);
322 if (error != ENODEV) {
323 VLOG_WARN("failed to open network device %s: %s",
324 name, strerror(error));
330 /* Initializes 'svec' with a list of the names of all known network devices. */
332 netdev_enumerate(struct svec *svec)
342 for (i = 0; i < n_netdev_classes; i++) {
343 const struct netdev_class *class = netdev_classes[i];
344 if (class->enumerate) {
345 int retval = class->enumerate(svec);
347 VLOG_WARN("failed to enumerate %s network devices: %s",
348 class->type, strerror(retval));
358 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
359 * must have initialized with sufficient room for the packet. The space
360 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
361 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
362 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
363 * need not be included.)
365 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
366 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
367 * positive errno value. Returns EAGAIN immediately if no packet is ready to
371 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
375 assert(buffer->size == 0);
376 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
378 retval = netdev_get_dev(netdev)->class->recv(netdev, buffer->data,
379 ofpbuf_tailroom(buffer));
381 COVERAGE_INC(netdev_received);
382 buffer->size += retval;
383 if (buffer->size < ETH_TOTAL_MIN) {
384 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
392 /* Registers with the poll loop to wake up from the next call to poll_block()
393 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
395 netdev_recv_wait(struct netdev *netdev)
397 netdev_get_dev(netdev)->class->recv_wait(netdev);
400 /* Discards all packets waiting to be received from 'netdev'. */
402 netdev_drain(struct netdev *netdev)
404 return netdev_get_dev(netdev)->class->drain(netdev);
407 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
408 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
409 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
410 * the packet is too big or too small to transmit on the device.
412 * The caller retains ownership of 'buffer' in all cases.
414 * The kernel maintains a packet transmission queue, so the caller is not
415 * expected to do additional queuing of packets. */
417 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
419 int error = netdev_get_dev(netdev)->class->send(netdev, buffer->data,
422 COVERAGE_INC(netdev_sent);
427 /* Registers with the poll loop to wake up from the next call to poll_block()
428 * when the packet transmission queue has sufficient room to transmit a packet
429 * with netdev_send().
431 * The kernel maintains a packet transmission queue, so the client is not
432 * expected to do additional queuing of packets. Thus, this function is
433 * unlikely to ever be used. It is included for completeness. */
435 netdev_send_wait(struct netdev *netdev)
437 return netdev_get_dev(netdev)->class->send_wait(netdev);
440 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
441 * otherwise a positive errno value. */
443 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
445 return netdev_get_dev(netdev)->class->set_etheraddr(netdev, mac);
448 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
449 * the MAC address into 'mac'. On failure, returns a positive errno value and
450 * clears 'mac' to all-zeros. */
452 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
454 return netdev_get_dev(netdev)->class->get_etheraddr(netdev, mac);
457 /* Returns the name of the network device that 'netdev' represents,
458 * e.g. "eth0". The caller must not modify or free the returned string. */
460 netdev_get_name(const struct netdev *netdev)
462 return netdev_get_dev(netdev)->name;
465 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
466 * (and received) packets, in bytes, not including the hardware header; thus,
467 * this is typically 1500 bytes for Ethernet devices.
469 * If successful, returns 0 and stores the MTU size in '*mtup'. On failure,
470 * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
473 netdev_get_mtu(const struct netdev *netdev, int *mtup)
475 int error = netdev_get_dev(netdev)->class->get_mtu(netdev, mtup);
477 VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
478 netdev_get_name(netdev), strerror(error));
479 *mtup = ETH_PAYLOAD_MAX;
484 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
485 * failure, returns a negative errno value.
487 * The desired semantics of the ifindex value are a combination of those
488 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
489 * value should be unique within a host and remain stable at least until
490 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
491 * but many systems do not follow this rule anyhow.
494 netdev_get_ifindex(const struct netdev *netdev)
496 return netdev_get_dev(netdev)->class->get_ifindex(netdev);
499 /* Stores the features supported by 'netdev' into each of '*current',
500 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
501 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
502 * successful, otherwise a positive errno value. On failure, all of the
503 * passed-in values are set to 0. */
505 netdev_get_features(struct netdev *netdev,
506 uint32_t *current, uint32_t *advertised,
507 uint32_t *supported, uint32_t *peer)
516 advertised = &dummy[1];
519 supported = &dummy[2];
525 error = netdev_get_dev(netdev)->class->get_features(netdev, current,
526 advertised, supported,
529 *current = *advertised = *supported = *peer = 0;
534 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
535 * successful, otherwise a positive errno value. */
537 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
539 return (netdev_get_dev(netdev)->class->set_advertisements
540 ? netdev_get_dev(netdev)->class->set_advertisements(netdev,
545 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
546 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
547 * errno value and sets '*address' to 0 (INADDR_ANY).
549 * The following error values have well-defined meanings:
551 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
553 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
555 * 'address' or 'netmask' or both may be null, in which case the address or netmask
556 * is not reported. */
558 netdev_get_in4(const struct netdev *netdev,
559 struct in_addr *address_, struct in_addr *netmask_)
561 struct in_addr address;
562 struct in_addr netmask;
565 error = (netdev_get_dev(netdev)->class->get_in4
566 ? netdev_get_dev(netdev)->class->get_in4(netdev, &address,
570 address_->s_addr = error ? 0 : address.s_addr;
573 netmask_->s_addr = error ? 0 : netmask.s_addr;
578 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
579 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
580 * positive errno value. */
582 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
584 return (netdev_get_dev(netdev)->class->set_in4
585 ? netdev_get_dev(netdev)->class->set_in4(netdev, addr, mask)
589 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
592 netdev_add_router(struct netdev *netdev, struct in_addr router)
594 COVERAGE_INC(netdev_add_router);
595 return (netdev_get_dev(netdev)->class->add_router
596 ? netdev_get_dev(netdev)->class->add_router(netdev, router)
600 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
601 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
602 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
603 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
604 * a directly connected network) in '*next_hop' and a copy of the name of the
605 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
606 * responsible for freeing '*netdev_name' (by calling free()). */
608 netdev_get_next_hop(const struct netdev *netdev,
609 const struct in_addr *host, struct in_addr *next_hop,
612 int error = (netdev_get_dev(netdev)->class->get_next_hop
613 ? netdev_get_dev(netdev)->class->get_next_hop(host, next_hop,
617 next_hop->s_addr = 0;
623 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
624 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
625 * all-zero-bits (in6addr_any).
627 * The following error values have well-defined meanings:
629 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
631 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
633 * 'in6' may be null, in which case the address itself is not reported. */
635 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
637 struct in6_addr dummy;
640 error = (netdev_get_dev(netdev)->class->get_in6
641 ? netdev_get_dev(netdev)->class->get_in6(netdev, in6 ? in6
645 memset(in6, 0, sizeof *in6);
650 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
651 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
652 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
653 * successful, otherwise a positive errno value. */
655 do_update_flags(struct netdev *netdev, enum netdev_flags off,
656 enum netdev_flags on, enum netdev_flags *old_flagsp,
659 enum netdev_flags old_flags;
662 error = netdev_get_dev(netdev)->class->update_flags(netdev, off & ~on, on,
665 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
666 off || on ? "set" : "get", netdev_get_name(netdev),
669 } else if ((off || on) && !permanent) {
670 enum netdev_flags new_flags = (old_flags & ~off) | on;
671 enum netdev_flags changed_flags = old_flags ^ new_flags;
673 if (!netdev->changed_flags) {
674 netdev->save_flags = old_flags;
676 netdev->changed_flags |= changed_flags;
680 *old_flagsp = old_flags;
685 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
686 * Returns 0 if successful, otherwise a positive errno value. On failure,
687 * stores 0 into '*flagsp'. */
689 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
691 struct netdev *netdev = (struct netdev *) netdev_;
692 return do_update_flags(netdev, 0, 0, flagsp, false);
695 /* Sets the flags for 'netdev' to 'flags'.
696 * If 'permanent' is true, the changes will persist; otherwise, they
697 * will be reverted when 'netdev' is closed or the program exits.
698 * Returns 0 if successful, otherwise a positive errno value. */
700 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
703 return do_update_flags(netdev, -1, flags, NULL, permanent);
706 /* Turns on the specified 'flags' on 'netdev'.
707 * If 'permanent' is true, the changes will persist; otherwise, they
708 * will be reverted when 'netdev' is closed or the program exits.
709 * Returns 0 if successful, otherwise a positive errno value. */
711 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
714 return do_update_flags(netdev, 0, flags, NULL, permanent);
717 /* Turns off the specified 'flags' on 'netdev'.
718 * If 'permanent' is true, the changes will persist; otherwise, they
719 * will be reverted when 'netdev' is closed or the program exits.
720 * Returns 0 if successful, otherwise a positive errno value. */
722 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
725 return do_update_flags(netdev, flags, 0, NULL, permanent);
728 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
729 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
730 * returns 0. Otherwise, it returns a positive errno value; in particular,
731 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
733 netdev_arp_lookup(const struct netdev *netdev,
734 uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
736 int error = (netdev_get_dev(netdev)->class->arp_lookup
737 ? netdev_get_dev(netdev)->class->arp_lookup(netdev, ip, mac)
740 memset(mac, 0, ETH_ADDR_LEN);
745 /* Sets 'carrier' to true if carrier is active (link light is on) on
748 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
750 int error = (netdev_get_dev(netdev)->class->get_carrier
751 ? netdev_get_dev(netdev)->class->get_carrier(netdev, carrier)
759 /* Retrieves current device stats for 'netdev'. */
761 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
765 COVERAGE_INC(netdev_get_stats);
766 error = (netdev_get_dev(netdev)->class->get_stats
767 ? netdev_get_dev(netdev)->class->get_stats(netdev, stats)
770 memset(stats, 0xff, sizeof *stats);
775 /* Attempts to set input rate limiting (policing) policy, such that up to
776 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
777 * size of 'kbits' kb. */
779 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
780 uint32_t kbits_burst)
782 return (netdev_get_dev(netdev)->class->set_policing
783 ? netdev_get_dev(netdev)->class->set_policing(netdev, kbits_rate,
788 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
789 * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
790 * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
791 * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
794 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
796 int error = (netdev_get_dev(netdev)->class->get_vlan_vid
797 ? netdev_get_dev(netdev)->class->get_vlan_vid(netdev, vlan_vid)
805 /* Returns a network device that has 'in4' as its IP address, if one exists,
806 * otherwise a null pointer. */
808 netdev_find_dev_by_in4(const struct in_addr *in4)
810 struct netdev *netdev;
811 struct svec dev_list;
814 netdev_enumerate(&dev_list);
815 for (i = 0; i < dev_list.n; i++) {
816 const char *name = dev_list.names[i];
817 struct in_addr dev_in4;
819 if (!netdev_open_default(name, &netdev)
820 && !netdev_get_in4(netdev, &dev_in4, NULL)
821 && dev_in4.s_addr == in4->s_addr) {
824 netdev_close(netdev);
829 svec_destroy(&dev_list);
833 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
836 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
837 * very important that 'netdev_dev' only be freed after calling
838 * the refcount drops to zero. */
840 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
841 const struct netdev_class *class)
843 assert(!shash_find(&netdev_dev_shash, name));
845 netdev_dev->class = class;
846 netdev_dev->ref_cnt = 0;
847 netdev_dev->name = xstrdup(name);
848 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
851 /* Undoes the results of initialization.
853 * Normally this function does not need to be called as netdev_close has
854 * the same effect when the refcount drops to zero.
855 * However, it may be called by providers due to an error on creation
856 * that occurs after initialization. It this case netdev_close() would
857 * never be called. */
859 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
861 char *name = netdev_dev->name;
863 assert(!netdev_dev->ref_cnt);
865 shash_delete(&netdev_dev_shash, netdev_dev->node);
868 netdev_dev->class->destroy(netdev_dev);
873 /* Returns the class type of 'netdev_dev'.
875 * The caller must not free the returned value. */
877 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
879 return netdev_dev->class->type;
882 /* Returns the name of 'netdev_dev'.
884 * The caller must not free the returned value. */
886 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
888 return netdev_dev->name;
891 /* Initializes 'netdev' as a instance of the netdev_dev.
893 * This function adds 'netdev' to a netdev-owned linked list, so it is very
894 * important that 'netdev' only be freed after calling netdev_close(). */
896 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
898 netdev->netdev_dev = netdev_dev;
899 netdev->save_flags = 0;
900 netdev->changed_flags = 0;
901 list_push_back(&netdev_list, &netdev->node);
904 /* Undoes the results of initialization.
906 * Normally this function only needs to be called from netdev_close().
907 * However, it may be called by providers due to an error on opening
908 * that occurs after initialization. It this case netdev_close() would
909 * never be called. */
911 netdev_uninit(struct netdev *netdev, bool close)
913 /* Restore flags that we changed, if any. */
914 int error = restore_flags(netdev);
915 list_remove(&netdev->node);
917 VLOG_WARN("failed to restore network device flags on %s: %s",
918 netdev_get_name(netdev), strerror(error));
922 netdev_get_dev(netdev)->class->close(netdev);
927 /* Returns the class type of 'netdev'.
929 * The caller must not free the returned value. */
931 netdev_get_type(const struct netdev *netdev)
933 return netdev_get_dev(netdev)->class->type;
937 netdev_get_dev(const struct netdev *netdev)
939 return netdev->netdev_dev;
942 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
943 * notification will consist of calling 'cb', with auxiliary data 'aux'. */
945 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
946 void (*cb)(struct netdev_notifier *), void *aux)
948 notifier->netdev = netdev;
953 /* Tracks changes in the status of a set of network devices. */
954 struct netdev_monitor {
955 struct shash polled_netdevs;
956 struct shash changed_netdevs;
959 /* Creates and returns a new structure for monitor changes in the status of
960 * network devices. */
961 struct netdev_monitor *
962 netdev_monitor_create(void)
964 struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
965 shash_init(&monitor->polled_netdevs);
966 shash_init(&monitor->changed_netdevs);
970 /* Destroys 'monitor'. */
972 netdev_monitor_destroy(struct netdev_monitor *monitor)
975 struct shash_node *node;
977 SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
978 struct netdev_notifier *notifier = node->data;
979 netdev_get_dev(notifier->netdev)->class->poll_remove(notifier);
982 shash_destroy(&monitor->polled_netdevs);
983 shash_destroy(&monitor->changed_netdevs);
989 netdev_monitor_cb(struct netdev_notifier *notifier)
991 struct netdev_monitor *monitor = notifier->aux;
992 const char *name = netdev_get_name(notifier->netdev);
993 if (!shash_find(&monitor->changed_netdevs, name)) {
994 shash_add(&monitor->changed_netdevs, name, NULL);
998 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'. Returns 0 if
999 * successful, otherwise a positive errno value.
1001 * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1004 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1006 const char *netdev_name = netdev_get_name(netdev);
1008 if (!shash_find(&monitor->polled_netdevs, netdev_name)
1009 && netdev_get_dev(netdev)->class->poll_add)
1011 struct netdev_notifier *notifier;
1012 error = netdev_get_dev(netdev)->class->poll_add(netdev,
1014 monitor, ¬ifier);
1016 assert(notifier->netdev == netdev);
1017 shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1023 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'. (This has
1024 * no effect if 'netdev' is not in the set of devices monitored by
1027 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1029 const char *netdev_name = netdev_get_name(netdev);
1030 struct shash_node *node;
1032 node = shash_find(&monitor->polled_netdevs, netdev_name);
1034 /* Cancel future notifications. */
1035 struct netdev_notifier *notifier = node->data;
1036 netdev_get_dev(netdev)->class->poll_remove(notifier);
1037 shash_delete(&monitor->polled_netdevs, node);
1039 /* Drop any pending notification. */
1040 node = shash_find(&monitor->changed_netdevs, netdev_name);
1042 shash_delete(&monitor->changed_netdevs, node);
1047 /* Checks for changes to netdevs in the set monitored by 'monitor'. If any of
1048 * the attributes (Ethernet address, carrier status, speed or peer-advertised
1049 * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1050 * sets '*devnamep' to the name of a device that has changed and returns 0.
1051 * The caller is responsible for freeing '*devnamep' (with free()).
1053 * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
1056 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1058 struct shash_node *node = shash_first(&monitor->changed_netdevs);
1063 *devnamep = xstrdup(node->name);
1064 shash_delete(&monitor->changed_netdevs, node);
1069 /* Registers with the poll loop to wake up from the next call to poll_block()
1070 * when netdev_monitor_poll(monitor) would indicate that a device has
1073 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1075 if (!shash_is_empty(&monitor->changed_netdevs)) {
1076 poll_immediate_wake();
1078 /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1079 * classes need help. */
1083 /* Restore the network device flags on 'netdev' to those that were active
1084 * before we changed them. Returns 0 if successful, otherwise a positive
1087 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1089 restore_flags(struct netdev *netdev)
1091 if (netdev->changed_flags) {
1092 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1093 enum netdev_flags old_flags;
1094 return netdev_get_dev(netdev)->class->update_flags(netdev,
1095 netdev->changed_flags & ~restore,
1096 restore, &old_flags);
1101 /* Retores all the flags on all network devices that we modified. Called from
1102 * a signal handler, so it does not attempt to report error conditions. */
1104 restore_all_flags(void *aux UNUSED)
1106 struct netdev *netdev;
1107 LIST_FOR_EACH (netdev, struct netdev, node, &netdev_list) {
1108 restore_flags(netdev);