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 close_all_netdevs(void *aux UNUSED);
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;
77 fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
80 for (i = j = 0; i < n_netdev_classes; i++) {
81 const struct netdev_class *class = netdev_classes[i];
83 int retval = class->init();
85 netdev_classes[j++] = class;
87 VLOG_ERR("failed to initialize %s network device "
88 "class: %s", class->type, strerror(retval));
94 netdev_classes[j++] = class;
102 /* Performs periodic work needed by all the various kinds of netdevs.
104 * If your program opens any netdevs, it must call this function within its
110 for (i = 0; i < n_netdev_classes; i++) {
111 const struct netdev_class *class = netdev_classes[i];
118 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
120 * If your program opens any netdevs, it must call this function within its
126 for (i = 0; i < n_netdev_classes; i++) {
127 const struct netdev_class *class = netdev_classes[i];
135 create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
139 if (!options->may_create) {
140 VLOG_WARN("attempted to create a device that may not be created: %s",
145 if (!options->type || strlen(options->type) == 0) {
146 /* Default to system. */
147 options->type = "system";
150 for (i = 0; i < n_netdev_classes; i++) {
151 const struct netdev_class *class = netdev_classes[i];
153 if (!strcmp(options->type, class->type)) {
154 return class->create(options->name, options->type, options->args,
159 VLOG_WARN("could not create netdev %s of unknown type %s", options->name,
165 shash_hash(const struct shash *shash)
168 struct shash_node *node;
171 SHASH_FOR_EACH(node, shash) {
172 entry_hash = hash_string(node->name, 0);
173 entry_hash ^= hash_string(node->data, 10);
174 hash ^= hash_int(entry_hash, 0);
180 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
181 * successful, otherwise a positive errno value. On success, sets '*netdevp'
182 * to the new network device, otherwise to null.
184 * If this is the first time the device has been opened, then create is called
185 * before opening. The device is created using the given type and arguments.
187 * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
188 * capture frames of that type received on the device. It may also be one of
189 * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
192 * If the 'may_create' flag is set then this is allowed to be the first time
193 * the device is opened (i.e. the refcount will be 1 after this call). It
194 * may be set to false if the device should have already been created.
196 * If the 'may_open' flag is set then the call will succeed even if another
197 * caller has already opened it. It may be to false if the device should not
198 * currently be open. */
201 netdev_open(struct netdev_options *options, struct netdev **netdevp)
203 struct shash empty_args = SHASH_INITIALIZER(&empty_args);
204 struct netdev_dev *netdev_dev;
210 if (!options->args) {
211 options->args = &empty_args;
214 netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
217 error = create_device(options, &netdev_dev);
222 netdev_dev->args_hash = shash_hash(options->args);
224 } else if (options->may_open) {
225 if (!shash_is_empty(options->args)) {
226 uint32_t args_hash = shash_hash(options->args);
228 if (args_hash != netdev_dev->args_hash) {
229 VLOG_WARN("attempted to open already created netdev with "
230 "different arguments: %s", options->name);
235 VLOG_WARN("attempted to create a netdev device with bound name: %s",
240 error = netdev_dev->class->open(netdev_dev, options->ethertype, netdevp);
243 netdev_dev->ref_cnt++;
245 if (!netdev_dev->ref_cnt) {
246 netdev_dev_uninit(netdev_dev, true);
254 netdev_open_default(const char *name, struct netdev **netdevp)
256 struct netdev_options options;
258 memset(&options, 0, sizeof options);
261 options.ethertype = NETDEV_ETH_TYPE_NONE;
262 options.may_create = true;
263 options.may_open = true;
265 return netdev_open(&options, netdevp);
268 /* Reconfigures the device 'netdev' with 'args'. 'args' may be empty
269 * or NULL if none are needed. */
271 netdev_reconfigure(struct netdev *netdev, const struct shash *args)
273 struct shash empty_args = SHASH_INITIALIZER(&empty_args);
274 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
280 if (netdev_dev->class->reconfigure) {
281 uint32_t args_hash = shash_hash(args);
283 if (netdev_dev->args_hash != args_hash) {
284 netdev_dev->args_hash = args_hash;
285 return netdev_dev->class->reconfigure(netdev_dev, args);
292 /* Closes and destroys 'netdev'. */
294 netdev_close(struct netdev *netdev)
297 struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
299 assert(netdev_dev->ref_cnt);
300 netdev_dev->ref_cnt--;
301 netdev_uninit(netdev, true);
303 /* If the reference count for the netdev device is zero, destroy it. */
304 if (!netdev_dev->ref_cnt) {
305 netdev_dev_uninit(netdev_dev, true);
310 /* Returns true if a network device named 'name' exists and may be opened,
311 * otherwise false. */
313 netdev_exists(const char *name)
315 struct netdev *netdev;
318 error = netdev_open_default(name, &netdev);
320 netdev_close(netdev);
323 if (error != ENODEV) {
324 VLOG_WARN("failed to open network device %s: %s",
325 name, strerror(error));
331 /* Initializes 'svec' with a list of the names of all known network devices. */
333 netdev_enumerate(struct svec *svec)
343 for (i = 0; i < n_netdev_classes; i++) {
344 const struct netdev_class *class = netdev_classes[i];
345 if (class->enumerate) {
346 int retval = class->enumerate(svec);
348 VLOG_WARN("failed to enumerate %s network devices: %s",
349 class->type, strerror(retval));
359 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
360 * must have initialized with sufficient room for the packet. The space
361 * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
362 * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
363 * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
364 * need not be included.)
366 * If a packet is successfully retrieved, returns 0. In this case 'buffer' is
367 * guaranteed to contain at least ETH_TOTAL_MIN bytes. Otherwise, returns a
368 * positive errno value. Returns EAGAIN immediately if no packet is ready to
372 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
376 assert(buffer->size == 0);
377 assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
379 retval = netdev_get_dev(netdev)->class->recv(netdev, buffer->data,
380 ofpbuf_tailroom(buffer));
382 COVERAGE_INC(netdev_received);
383 buffer->size += retval;
384 if (buffer->size < ETH_TOTAL_MIN) {
385 ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
393 /* Registers with the poll loop to wake up from the next call to poll_block()
394 * when a packet is ready to be received with netdev_recv() on 'netdev'. */
396 netdev_recv_wait(struct netdev *netdev)
398 netdev_get_dev(netdev)->class->recv_wait(netdev);
401 /* Discards all packets waiting to be received from 'netdev'. */
403 netdev_drain(struct netdev *netdev)
405 return netdev_get_dev(netdev)->class->drain(netdev);
408 /* Sends 'buffer' on 'netdev'. Returns 0 if successful, otherwise a positive
409 * errno value. Returns EAGAIN without blocking if the packet cannot be queued
410 * immediately. Returns EMSGSIZE if a partial packet was transmitted or if
411 * the packet is too big or too small to transmit on the device.
413 * The caller retains ownership of 'buffer' in all cases.
415 * The kernel maintains a packet transmission queue, so the caller is not
416 * expected to do additional queuing of packets. */
418 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
420 int error = netdev_get_dev(netdev)->class->send(netdev, buffer->data,
423 COVERAGE_INC(netdev_sent);
428 /* Registers with the poll loop to wake up from the next call to poll_block()
429 * when the packet transmission queue has sufficient room to transmit a packet
430 * with netdev_send().
432 * The kernel maintains a packet transmission queue, so the client is not
433 * expected to do additional queuing of packets. Thus, this function is
434 * unlikely to ever be used. It is included for completeness. */
436 netdev_send_wait(struct netdev *netdev)
438 return netdev_get_dev(netdev)->class->send_wait(netdev);
441 /* Attempts to set 'netdev''s MAC address to 'mac'. Returns 0 if successful,
442 * otherwise a positive errno value. */
444 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
446 return netdev_get_dev(netdev)->class->set_etheraddr(netdev, mac);
449 /* Retrieves 'netdev''s MAC address. If successful, returns 0 and copies the
450 * the MAC address into 'mac'. On failure, returns a positive errno value and
451 * clears 'mac' to all-zeros. */
453 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
455 return netdev_get_dev(netdev)->class->get_etheraddr(netdev, mac);
458 /* Returns the name of the network device that 'netdev' represents,
459 * e.g. "eth0". The caller must not modify or free the returned string. */
461 netdev_get_name(const struct netdev *netdev)
463 return netdev_get_dev(netdev)->name;
466 /* Retrieves the MTU of 'netdev'. The MTU is the maximum size of transmitted
467 * (and received) packets, in bytes, not including the hardware header; thus,
468 * this is typically 1500 bytes for Ethernet devices.
470 * If successful, returns 0 and stores the MTU size in '*mtup'. On failure,
471 * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
474 netdev_get_mtu(const struct netdev *netdev, int *mtup)
476 int error = netdev_get_dev(netdev)->class->get_mtu(netdev, mtup);
478 VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
479 netdev_get_name(netdev), strerror(error));
480 *mtup = ETH_PAYLOAD_MAX;
485 /* Returns the ifindex of 'netdev', if successful, as a positive number. On
486 * failure, returns a negative errno value.
488 * The desired semantics of the ifindex value are a combination of those
489 * specified by POSIX for if_nametoindex() and by SNMP for ifIndex. An ifindex
490 * value should be unique within a host and remain stable at least until
491 * reboot. SNMP says an ifindex "ranges between 1 and the value of ifNumber"
492 * but many systems do not follow this rule anyhow.
495 netdev_get_ifindex(const struct netdev *netdev)
497 return netdev_get_dev(netdev)->class->get_ifindex(netdev);
500 /* Stores the features supported by 'netdev' into each of '*current',
501 * '*advertised', '*supported', and '*peer' that are non-null. Each value is a
502 * bitmap of "enum ofp_port_features" bits, in host byte order. Returns 0 if
503 * successful, otherwise a positive errno value. On failure, all of the
504 * passed-in values are set to 0. */
506 netdev_get_features(struct netdev *netdev,
507 uint32_t *current, uint32_t *advertised,
508 uint32_t *supported, uint32_t *peer)
517 advertised = &dummy[1];
520 supported = &dummy[2];
526 error = netdev_get_dev(netdev)->class->get_features(netdev, current,
527 advertised, supported,
530 *current = *advertised = *supported = *peer = 0;
535 /* Set the features advertised by 'netdev' to 'advertise'. Returns 0 if
536 * successful, otherwise a positive errno value. */
538 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
540 return (netdev_get_dev(netdev)->class->set_advertisements
541 ? netdev_get_dev(netdev)->class->set_advertisements(netdev,
546 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
547 * and '*netmask' to its netmask and returns 0. Otherwise, returns a positive
548 * errno value and sets '*address' to 0 (INADDR_ANY).
550 * The following error values have well-defined meanings:
552 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
554 * - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
556 * 'address' or 'netmask' or both may be null, in which case the address or netmask
557 * is not reported. */
559 netdev_get_in4(const struct netdev *netdev,
560 struct in_addr *address_, struct in_addr *netmask_)
562 struct in_addr address;
563 struct in_addr netmask;
566 error = (netdev_get_dev(netdev)->class->get_in4
567 ? netdev_get_dev(netdev)->class->get_in4(netdev, &address,
571 address_->s_addr = error ? 0 : address.s_addr;
574 netmask_->s_addr = error ? 0 : netmask.s_addr;
579 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask. If
580 * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared. Returns a
581 * positive errno value. */
583 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
585 return (netdev_get_dev(netdev)->class->set_in4
586 ? netdev_get_dev(netdev)->class->set_in4(netdev, addr, mask)
590 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
593 netdev_add_router(struct netdev *netdev, struct in_addr router)
595 COVERAGE_INC(netdev_add_router);
596 return (netdev_get_dev(netdev)->class->add_router
597 ? netdev_get_dev(netdev)->class->add_router(netdev, router)
601 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
602 * 'netdev'. If a route cannot not be determined, sets '*next_hop' to 0,
603 * '*netdev_name' to null, and returns a positive errno value. Otherwise, if a
604 * next hop is found, stores the next hop gateway's address (0 if 'host' is on
605 * a directly connected network) in '*next_hop' and a copy of the name of the
606 * device to reach 'host' in '*netdev_name', and returns 0. The caller is
607 * responsible for freeing '*netdev_name' (by calling free()). */
609 netdev_get_next_hop(const struct netdev *netdev,
610 const struct in_addr *host, struct in_addr *next_hop,
613 int error = (netdev_get_dev(netdev)->class->get_next_hop
614 ? netdev_get_dev(netdev)->class->get_next_hop(host, next_hop,
618 next_hop->s_addr = 0;
624 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
625 * returns 0. Otherwise, returns a positive errno value and sets '*in6' to
626 * all-zero-bits (in6addr_any).
628 * The following error values have well-defined meanings:
630 * - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
632 * - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
634 * 'in6' may be null, in which case the address itself is not reported. */
636 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
638 struct in6_addr dummy;
641 error = (netdev_get_dev(netdev)->class->get_in6
642 ? netdev_get_dev(netdev)->class->get_in6(netdev, in6 ? in6
646 memset(in6, 0, sizeof *in6);
651 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
652 * 'on'. If 'permanent' is true, the changes will persist; otherwise, they
653 * will be reverted when 'netdev' is closed or the program exits. Returns 0 if
654 * successful, otherwise a positive errno value. */
656 do_update_flags(struct netdev *netdev, enum netdev_flags off,
657 enum netdev_flags on, enum netdev_flags *old_flagsp,
660 enum netdev_flags old_flags;
663 error = netdev_get_dev(netdev)->class->update_flags(netdev, off & ~on, on,
666 VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
667 off || on ? "set" : "get", netdev_get_name(netdev),
670 } else if ((off || on) && !permanent) {
671 enum netdev_flags new_flags = (old_flags & ~off) | on;
672 enum netdev_flags changed_flags = old_flags ^ new_flags;
674 if (!netdev->changed_flags) {
675 netdev->save_flags = old_flags;
677 netdev->changed_flags |= changed_flags;
681 *old_flagsp = old_flags;
686 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
687 * Returns 0 if successful, otherwise a positive errno value. On failure,
688 * stores 0 into '*flagsp'. */
690 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
692 struct netdev *netdev = (struct netdev *) netdev_;
693 return do_update_flags(netdev, 0, 0, flagsp, false);
696 /* Sets the flags for 'netdev' to 'flags'.
697 * If 'permanent' is true, the changes will persist; otherwise, they
698 * will be reverted when 'netdev' is closed or the program exits.
699 * Returns 0 if successful, otherwise a positive errno value. */
701 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
704 return do_update_flags(netdev, -1, flags, NULL, permanent);
707 /* Turns on the specified 'flags' on 'netdev'.
708 * If 'permanent' is true, the changes will persist; otherwise, they
709 * will be reverted when 'netdev' is closed or the program exits.
710 * Returns 0 if successful, otherwise a positive errno value. */
712 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
715 return do_update_flags(netdev, 0, flags, NULL, permanent);
718 /* Turns off the specified 'flags' on 'netdev'.
719 * If 'permanent' is true, the changes will persist; otherwise, they
720 * will be reverted when 'netdev' is closed or the program exits.
721 * Returns 0 if successful, otherwise a positive errno value. */
723 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
726 return do_update_flags(netdev, flags, 0, NULL, permanent);
729 /* Looks up the ARP table entry for 'ip' on 'netdev'. If one exists and can be
730 * successfully retrieved, it stores the corresponding MAC address in 'mac' and
731 * returns 0. Otherwise, it returns a positive errno value; in particular,
732 * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
734 netdev_arp_lookup(const struct netdev *netdev,
735 uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
737 int error = (netdev_get_dev(netdev)->class->arp_lookup
738 ? netdev_get_dev(netdev)->class->arp_lookup(netdev, ip, mac)
741 memset(mac, 0, ETH_ADDR_LEN);
746 /* Sets 'carrier' to true if carrier is active (link light is on) on
749 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
751 int error = (netdev_get_dev(netdev)->class->get_carrier
752 ? netdev_get_dev(netdev)->class->get_carrier(netdev, carrier)
760 /* Retrieves current device stats for 'netdev'. */
762 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
766 COVERAGE_INC(netdev_get_stats);
767 error = (netdev_get_dev(netdev)->class->get_stats
768 ? netdev_get_dev(netdev)->class->get_stats(netdev, stats)
771 memset(stats, 0xff, sizeof *stats);
776 /* Attempts to set input rate limiting (policing) policy, such that up to
777 * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
778 * size of 'kbits' kb. */
780 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
781 uint32_t kbits_burst)
783 return (netdev_get_dev(netdev)->class->set_policing
784 ? netdev_get_dev(netdev)->class->set_policing(netdev, kbits_rate,
789 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
790 * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
791 * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
792 * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
795 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
797 int error = (netdev_get_dev(netdev)->class->get_vlan_vid
798 ? netdev_get_dev(netdev)->class->get_vlan_vid(netdev, vlan_vid)
806 /* Returns a network device that has 'in4' as its IP address, if one exists,
807 * otherwise a null pointer. */
809 netdev_find_dev_by_in4(const struct in_addr *in4)
811 struct netdev *netdev;
812 struct svec dev_list;
815 netdev_enumerate(&dev_list);
816 for (i = 0; i < dev_list.n; i++) {
817 const char *name = dev_list.names[i];
818 struct in_addr dev_in4;
820 if (!netdev_open_default(name, &netdev)
821 && !netdev_get_in4(netdev, &dev_in4, NULL)
822 && dev_in4.s_addr == in4->s_addr) {
825 netdev_close(netdev);
830 svec_destroy(&dev_list);
834 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
837 * This function adds 'netdev_dev' to a netdev-owned shash, so it is
838 * very important that 'netdev_dev' only be freed after calling
839 * the refcount drops to zero. */
841 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
842 const struct netdev_class *class)
844 assert(!shash_find(&netdev_dev_shash, name));
846 netdev_dev->class = class;
847 netdev_dev->ref_cnt = 0;
848 netdev_dev->name = xstrdup(name);
849 netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
852 /* Undoes the results of initialization.
854 * Normally this function does not need to be called as netdev_close has
855 * the same effect when the refcount drops to zero.
856 * However, it may be called by providers due to an error on creation
857 * that occurs after initialization. It this case netdev_close() would
858 * never be called. */
860 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
862 char *name = netdev_dev->name;
864 assert(!netdev_dev->ref_cnt);
866 shash_delete(&netdev_dev_shash, netdev_dev->node);
869 netdev_dev->class->destroy(netdev_dev);
874 /* Returns the class type of 'netdev_dev'.
876 * The caller must not free the returned value. */
878 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
880 return netdev_dev->class->type;
883 /* Returns the name of 'netdev_dev'.
885 * The caller must not free the returned value. */
887 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
889 return netdev_dev->name;
892 /* Initializes 'netdev' as a instance of the netdev_dev.
894 * This function adds 'netdev' to a netdev-owned linked list, so it is very
895 * important that 'netdev' only be freed after calling netdev_close(). */
897 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
899 netdev->netdev_dev = netdev_dev;
900 netdev->save_flags = 0;
901 netdev->changed_flags = 0;
902 list_push_back(&netdev_list, &netdev->node);
905 /* Undoes the results of initialization.
907 * Normally this function only needs to be called from netdev_close().
908 * However, it may be called by providers due to an error on opening
909 * that occurs after initialization. It this case netdev_close() would
910 * never be called. */
912 netdev_uninit(struct netdev *netdev, bool close)
914 /* Restore flags that we changed, if any. */
915 int error = restore_flags(netdev);
916 list_remove(&netdev->node);
918 VLOG_WARN("failed to restore network device flags on %s: %s",
919 netdev_get_name(netdev), strerror(error));
923 netdev_get_dev(netdev)->class->close(netdev);
928 /* Returns the class type of 'netdev'.
930 * The caller must not free the returned value. */
932 netdev_get_type(const struct netdev *netdev)
934 return netdev_get_dev(netdev)->class->type;
938 netdev_get_dev(const struct netdev *netdev)
940 return netdev->netdev_dev;
943 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
944 * notification will consist of calling 'cb', with auxiliary data 'aux'. */
946 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
947 void (*cb)(struct netdev_notifier *), void *aux)
949 notifier->netdev = netdev;
954 /* Tracks changes in the status of a set of network devices. */
955 struct netdev_monitor {
956 struct shash polled_netdevs;
957 struct shash changed_netdevs;
960 /* Creates and returns a new structure for monitor changes in the status of
961 * network devices. */
962 struct netdev_monitor *
963 netdev_monitor_create(void)
965 struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
966 shash_init(&monitor->polled_netdevs);
967 shash_init(&monitor->changed_netdevs);
971 /* Destroys 'monitor'. */
973 netdev_monitor_destroy(struct netdev_monitor *monitor)
976 struct shash_node *node;
978 SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
979 struct netdev_notifier *notifier = node->data;
980 netdev_get_dev(notifier->netdev)->class->poll_remove(notifier);
983 shash_destroy(&monitor->polled_netdevs);
984 shash_destroy(&monitor->changed_netdevs);
990 netdev_monitor_cb(struct netdev_notifier *notifier)
992 struct netdev_monitor *monitor = notifier->aux;
993 const char *name = netdev_get_name(notifier->netdev);
994 if (!shash_find(&monitor->changed_netdevs, name)) {
995 shash_add(&monitor->changed_netdevs, name, NULL);
999 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'. Returns 0 if
1000 * successful, otherwise a positive errno value.
1002 * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1005 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1007 const char *netdev_name = netdev_get_name(netdev);
1009 if (!shash_find(&monitor->polled_netdevs, netdev_name)
1010 && netdev_get_dev(netdev)->class->poll_add)
1012 struct netdev_notifier *notifier;
1013 error = netdev_get_dev(netdev)->class->poll_add(netdev,
1015 monitor, ¬ifier);
1017 assert(notifier->netdev == netdev);
1018 shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1024 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'. (This has
1025 * no effect if 'netdev' is not in the set of devices monitored by
1028 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1030 const char *netdev_name = netdev_get_name(netdev);
1031 struct shash_node *node;
1033 node = shash_find(&monitor->polled_netdevs, netdev_name);
1035 /* Cancel future notifications. */
1036 struct netdev_notifier *notifier = node->data;
1037 netdev_get_dev(netdev)->class->poll_remove(notifier);
1038 shash_delete(&monitor->polled_netdevs, node);
1040 /* Drop any pending notification. */
1041 node = shash_find(&monitor->changed_netdevs, netdev_name);
1043 shash_delete(&monitor->changed_netdevs, node);
1048 /* Checks for changes to netdevs in the set monitored by 'monitor'. If any of
1049 * the attributes (Ethernet address, carrier status, speed or peer-advertised
1050 * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1051 * sets '*devnamep' to the name of a device that has changed and returns 0.
1052 * The caller is responsible for freeing '*devnamep' (with free()).
1054 * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
1057 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1059 struct shash_node *node = shash_first(&monitor->changed_netdevs);
1064 *devnamep = xstrdup(node->name);
1065 shash_delete(&monitor->changed_netdevs, node);
1070 /* Registers with the poll loop to wake up from the next call to poll_block()
1071 * when netdev_monitor_poll(monitor) would indicate that a device has
1074 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1076 if (!shash_is_empty(&monitor->changed_netdevs)) {
1077 poll_immediate_wake();
1079 /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1080 * classes need help. */
1084 /* Restore the network device flags on 'netdev' to those that were active
1085 * before we changed them. Returns 0 if successful, otherwise a positive
1088 * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1090 restore_flags(struct netdev *netdev)
1092 if (netdev->changed_flags) {
1093 enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1094 enum netdev_flags old_flags;
1095 return netdev_get_dev(netdev)->class->update_flags(netdev,
1096 netdev->changed_flags & ~restore,
1097 restore, &old_flags);
1102 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1103 * destroying devices, restoring flags, etc. */
1105 close_all_netdevs(void *aux UNUSED)
1107 struct netdev *netdev, *next;
1108 LIST_FOR_EACH_SAFE(netdev, next, struct netdev, node, &netdev_list) {
1109 netdev_close(netdev);