lib/netdev.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "netdev.h"
  19
  20 #include <assert.h>
  21 #include <errno.h>
  22 #include <inttypes.h>
  23 #include <netinet/in.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27
  28 #include "coverage.h"
  29 #include "dynamic-string.h"
  30 #include "fatal-signal.h"
  31 #include "hash.h"
  32 #include "list.h"
  33 #include "netdev-provider.h"
  34 #include "ofpbuf.h"
  35 #include "openflow/openflow.h"
  36 #include "packets.h"
  37 #include "poll-loop.h"
  38 #include "shash.h"
  39 #include "svec.h"
  40
  41 #define THIS_MODULE VLM_netdev
  42 #include "vlog.h"
  43
  44 static const struct netdev_class *base_netdev_classes[] = {
  45 #ifdef HAVE_NETLINK
  46     &netdev_linux_class,
  47     &netdev_tap_class,
  48     &netdev_patch_class,
  49     &netdev_gre_class,
  50 #endif
  51 };
  52
  53 static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
  54
  55 /* All created network devices. */
  56 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
  57
  58 /* All open network devices. */
  59 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
  60
  61 /* This is set pretty low because we probably won't learn anything from the
  62  * additional log messages. */
  63 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
  64
  65 static void close_all_netdevs(void *aux OVS_UNUSED);
  66 static int restore_flags(struct netdev *netdev);
  67 void update_device_args(struct netdev_dev *, const struct shash *args);
  68
  69 static void
  70 netdev_initialize(void)
  71 {
  72     static int status = -1;
  73
  74     if (status < 0) {
  75         int i;
  76
  77         fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
  78
  79         status = 0;
  80         for (i = 0; i < ARRAY_SIZE(base_netdev_classes); i++) {
  81             netdev_register_provider(base_netdev_classes[i]);
  82         }
  83     }
  84 }
  85
  86 /* Performs periodic work needed by all the various kinds of netdevs.
  87  *
  88  * If your program opens any netdevs, it must call this function within its
  89  * main poll loop. */
  90 void
  91 netdev_run(void)
  92 {
  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) {
  97             netdev_class->run();
  98         }
  99     }
 100 }
 101
 102 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
 103  *
 104  * If your program opens any netdevs, it must call this function within its
 105  * main poll loop. */
 106 void
 107 netdev_wait(void)
 108 {
 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();
 114         }
 115     }
 116 }
 117
 118 /* Initializes and registers a new netdev provider.  After successful
 119  * registration, new netdevs of that type can be opened using netdev_open(). */
 120 int
 121 netdev_register_provider(const struct netdev_class *new_class)
 122 {
 123     struct netdev_class *new_provider;
 124
 125     if (shash_find(&netdev_classes, new_class->type)) {
 126         VLOG_WARN("attempted to register duplicate netdev provider: %s",
 127                    new_class->type);
 128         return EEXIST;
 129     }
 130
 131     if (new_class->init) {
 132         int error = new_class->init();
 133         if (error) {
 134             VLOG_ERR("failed to initialize %s network device class: %s",
 135                      new_class->type, strerror(error));
 136             return error;
 137         }
 138     }
 139
 140     new_provider = xmalloc(sizeof *new_provider);
 141     memcpy(new_provider, new_class, sizeof *new_provider);
 142
 143     shash_add(&netdev_classes, new_class->type, new_provider);
 144
 145     return 0;
 146 }
 147
 148 /* Unregisters a netdev provider.  'type' must have been previously
 149  * registered and not currently be in use by any netdevs.  After unregistration
 150  * new netdevs of that type cannot be opened using netdev_open(). */
 151 int
 152 netdev_unregister_provider(const char *type)
 153 {
 154     struct shash_node *del_node, *netdev_dev_node;
 155
 156     del_node = shash_find(&netdev_classes, type);
 157     if (!del_node) {
 158         VLOG_WARN("attempted to unregister a netdev provider that is not "
 159                   "registered: %s", type);
 160         return EAFNOSUPPORT;
 161     }
 162
 163     SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
 164         struct netdev_dev *netdev_dev = netdev_dev_node->data;
 165         if (!strcmp(netdev_dev->netdev_class->type, type)) {
 166             VLOG_WARN("attempted to unregister in use netdev provider: %s",
 167                       type);
 168             return EBUSY;
 169         }
 170     }
 171
 172     shash_delete(&netdev_classes, del_node);
 173     free(del_node->data);
 174
 175     return 0;
 176 }
 177
 178 /* Clears 'types' and enumerates the types of all currently registered netdev
 179  * providers into it.  The caller must first initialize the svec. */
 180 void
 181 netdev_enumerate_types(struct svec *types)
 182 {
 183     struct shash_node *node;
 184
 185     netdev_initialize();
 186     svec_clear(types);
 187
 188     SHASH_FOR_EACH(node, &netdev_classes) {
 189         const struct netdev_class *netdev_class = node->data;
 190         svec_add(types, netdev_class->type);
 191     }
 192 }
 193
 194 /* Compares 'args' to those used to those used by 'dev'.  Returns true
 195  * if the arguments are the same, false otherwise.  Does not update the
 196  * values stored in 'dev'. */
 197 static bool
 198 compare_device_args(const struct netdev_dev *dev, const struct shash *args)
 199 {
 200     const struct shash_node **new_args;
 201     bool result = true;
 202     int i;
 203
 204     if (shash_count(args) != dev->n_args) {
 205         return false;
 206     }
 207
 208     new_args = shash_sort(args);
 209     for (i = 0; i < dev->n_args; i++) {
 210         if (strcmp(dev->args[i].key, new_args[i]->name) ||
 211             strcmp(dev->args[i].value, new_args[i]->data)) {
 212             result = false;
 213             goto finish;
 214         }
 215     }
 216
 217 finish:
 218     free(new_args);
 219     return result;
 220 }
 221
 222 static int
 223 compare_args(const void *a_, const void *b_)
 224 {
 225     const struct arg *a = a_;
 226     const struct arg *b = b_;
 227     return strcmp(a->key, b->key);
 228 }
 229
 230 void
 231 update_device_args(struct netdev_dev *dev, const struct shash *args)
 232 {
 233     struct shash_node *node;
 234     int i;
 235
 236     if (dev->n_args) {
 237         for (i = 0; i < dev->n_args; i++) {
 238             free(dev->args[i].key);
 239             free(dev->args[i].value);
 240         }
 241
 242         free(dev->args);
 243         dev->n_args = 0;
 244     }
 245
 246     if (!args || shash_is_empty(args)) {
 247         return;
 248     }
 249
 250     dev->n_args = shash_count(args);
 251     dev->args = xmalloc(dev->n_args * sizeof *dev->args);
 252
 253     i = 0;
 254     SHASH_FOR_EACH(node, args) {
 255         dev->args[i].key = xstrdup(node->name);
 256         dev->args[i].value = xstrdup(node->data);
 257         i++;
 258     }
 259
 260     qsort(dev->args, dev->n_args, sizeof *dev->args, compare_args);
 261 }
 262
 263 static int
 264 create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
 265 {
 266     struct netdev_class *netdev_class;
 267
 268     if (!options->may_create) {
 269         VLOG_WARN("attempted to create a device that may not be created: %s",
 270                   options->name);
 271         return ENODEV;
 272     }
 273
 274     if (!options->type || strlen(options->type) == 0) {
 275         /* Default to system. */
 276         options->type = "system";
 277     }
 278
 279     netdev_class = shash_find_data(&netdev_classes, options->type);
 280     if (!netdev_class) {
 281         VLOG_WARN("could not create netdev %s of unknown type %s",
 282                   options->name, options->type);
 283         return EAFNOSUPPORT;
 284     }
 285
 286     return netdev_class->create(options->name, options->type, options->args,
 287                                 netdev_devp);
 288 }
 289
 290 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
 291  * successful, otherwise a positive errno value.  On success, sets '*netdevp'
 292  * to the new network device, otherwise to null.
 293  *
 294  * If this is the first time the device has been opened, then create is called
 295  * before opening.  The device is  created using the given type and arguments.
 296  *
 297  * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
 298  * capture frames of that type received on the device.  It may also be one of
 299  * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
 300  * categories.
 301  *
 302  * If the 'may_create' flag is set then this is allowed to be the first time
 303  * the device is opened (i.e. the refcount will be 1 after this call).  It
 304  * may be set to false if the device should have already been created.
 305  *
 306  * If the 'may_open' flag is set then the call will succeed even if another
 307  * caller has already opened it.  It may be to false if the device should not
 308  * currently be open. */
 309 int
 310 netdev_open(struct netdev_options *options, struct netdev **netdevp)
 311 {
 312     struct shash empty_args = SHASH_INITIALIZER(&empty_args);
 313     struct netdev_dev *netdev_dev;
 314     int error;
 315
 316     *netdevp = NULL;
 317     netdev_initialize();
 318
 319     if (!options->args) {
 320         options->args = &empty_args;
 321     }
 322
 323     netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
 324
 325     if (!netdev_dev) {
 326         error = create_device(options, &netdev_dev);
 327         if (error) {
 328             return error;
 329         }
 330         update_device_args(netdev_dev, options->args);
 331
 332     } else if (options->may_open) {
 333         if (!shash_is_empty(options->args) &&
 334             !compare_device_args(netdev_dev, options->args)) {
 335
 336             VLOG_WARN("%s: attempted to open already created netdev with "
 337                       "different arguments", options->name);
 338             return EINVAL;
 339         }
 340     } else {
 341         VLOG_WARN("%s: attempted to create a netdev device with bound name",
 342                   options->name);
 343         return EEXIST;
 344     }
 345
 346     error = netdev_dev->netdev_class->open(netdev_dev, options->ethertype,
 347                 netdevp);
 348
 349     if (!error) {
 350         netdev_dev->ref_cnt++;
 351     } else {
 352         if (!netdev_dev->ref_cnt) {
 353             netdev_dev_uninit(netdev_dev, true);
 354         }
 355     }
 356
 357     return error;
 358 }
 359
 360 int
 361 netdev_open_default(const char *name, struct netdev **netdevp)
 362 {
 363     struct netdev_options options;
 364
 365     memset(&options, 0, sizeof options);
 366
 367     options.name = name;
 368     options.ethertype = NETDEV_ETH_TYPE_NONE;
 369     options.may_create = true;
 370     options.may_open = true;
 371
 372     return netdev_open(&options, netdevp);
 373 }
 374
 375 /* Increments the reference count on 'netdev'.  Returns 'netdev'. */
 376 struct netdev *
 377 netdev_reopen(struct netdev *netdev)
 378 {
 379     netdev->ref_cnt++;
 380     return netdev;
 381 }
 382
 383 /* Reconfigures the device 'netdev' with 'args'.  'args' may be empty
 384  * or NULL if none are needed. */
 385 int
 386 netdev_reconfigure(struct netdev *netdev, const struct shash *args)
 387 {
 388     struct shash empty_args = SHASH_INITIALIZER(&empty_args);
 389     struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
 390
 391     if (!args) {
 392         args = &empty_args;
 393     }
 394
 395     if (netdev_dev->netdev_class->reconfigure) {
 396         if (!compare_device_args(netdev_dev, args)) {
 397             update_device_args(netdev_dev, args);
 398             return netdev_dev->netdev_class->reconfigure(netdev_dev, args);
 399         }
 400     } else if (!shash_is_empty(args)) {
 401         VLOG_WARN("%s: arguments provided to device that does not have a "
 402                   "reconfigure function", netdev_get_name(netdev));
 403     }
 404
 405     return 0;
 406 }
 407
 408 /* Decrements the reference count on 'netdev'.  If the reference count reaches
 409  * zero, closes and destroys 'netdev'. */
 410 void
 411 netdev_close(struct netdev *netdev)
 412 {
 413     assert(!netdev || netdev->ref_cnt > 0);
 414     if (netdev && !--netdev->ref_cnt) {
 415         struct netdev_dev *netdev_dev = netdev_get_dev(netdev);
 416
 417         assert(netdev_dev->ref_cnt);
 418         netdev_dev->ref_cnt--;
 419         netdev_uninit(netdev, true);
 420
 421         /* If the reference count for the netdev device is zero, destroy it. */
 422         if (!netdev_dev->ref_cnt) {
 423             netdev_dev_uninit(netdev_dev, true);
 424         }
 425     }
 426 }
 427
 428 /* Returns true if a network device named 'name' exists and may be opened,
 429  * otherwise false. */
 430 bool
 431 netdev_exists(const char *name)
 432 {
 433     struct netdev *netdev;
 434     int error;
 435
 436     error = netdev_open_default(name, &netdev);
 437     if (!error) {
 438         netdev_close(netdev);
 439         return true;
 440     } else {
 441         if (error != ENODEV) {
 442             VLOG_WARN("failed to open network device %s: %s",
 443                       name, strerror(error));
 444         }
 445         return false;
 446     }
 447 }
 448
 449 /* Returns true if a network device named 'name' is currently opened,
 450  * otherwise false. */
 451 bool
 452 netdev_is_open(const char *name)
 453 {
 454     return !!shash_find_data(&netdev_dev_shash, name);
 455 }
 456
 457 /*  Clears 'svec' and enumerates the names of all known network devices. */
 458 int
 459 netdev_enumerate(struct svec *svec)
 460 {
 461     struct shash_node *node;
 462     int error = 0;
 463
 464     netdev_initialize();
 465     svec_clear(svec);
 466
 467     SHASH_FOR_EACH(node, &netdev_classes) {
 468         const struct netdev_class *netdev_class = node->data;
 469         if (netdev_class->enumerate) {
 470             int retval = netdev_class->enumerate(svec);
 471             if (retval) {
 472                 VLOG_WARN("failed to enumerate %s network devices: %s",
 473                           netdev_class->type, strerror(retval));
 474                 if (!error) {
 475                     error = retval;
 476                 }
 477             }
 478         }
 479     }
 480
 481     return error;
 482 }
 483
 484 /* Attempts to receive a packet from 'netdev' into 'buffer', which the caller
 485  * must have initialized with sufficient room for the packet.  The space
 486  * required to receive any packet is ETH_HEADER_LEN bytes, plus VLAN_HEADER_LEN
 487  * bytes, plus the device's MTU (which may be retrieved via netdev_get_mtu()).
 488  * (Some devices do not allow for a VLAN header, in which case VLAN_HEADER_LEN
 489  * need not be included.)
 490  *
 491  * If a packet is successfully retrieved, returns 0.  In this case 'buffer' is
 492  * guaranteed to contain at least ETH_TOTAL_MIN bytes.  Otherwise, returns a
 493  * positive errno value.  Returns EAGAIN immediately if no packet is ready to
 494  * be returned.
 495  *
 496  * Some network devices may not implement support for this function.  In such
 497  * cases this function will always return EOPNOTSUPP.
 498  */
 499 int
 500 netdev_recv(struct netdev *netdev, struct ofpbuf *buffer)
 501 {
 502     int (*recv)(struct netdev *, void *, size_t);
 503     int retval;
 504
 505     assert(buffer->size == 0);
 506     assert(ofpbuf_tailroom(buffer) >= ETH_TOTAL_MIN);
 507
 508     recv = netdev_get_dev(netdev)->netdev_class->recv;
 509     retval = (recv
 510               ? (recv)(netdev, buffer->data, ofpbuf_tailroom(buffer))
 511               : -EOPNOTSUPP);
 512     if (retval >= 0) {
 513         COVERAGE_INC(netdev_received);
 514         buffer->size += retval;
 515         if (buffer->size < ETH_TOTAL_MIN) {
 516             ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
 517         }
 518         return 0;
 519     } else {
 520         return -retval;
 521     }
 522 }
 523
 524 /* Registers with the poll loop to wake up from the next call to poll_block()
 525  * when a packet is ready to be received with netdev_recv() on 'netdev'. */
 526 void
 527 netdev_recv_wait(struct netdev *netdev)
 528 {
 529     void (*recv_wait)(struct netdev *);
 530
 531     recv_wait = netdev_get_dev(netdev)->netdev_class->recv_wait;
 532     if (recv_wait) {
 533         recv_wait(netdev);
 534     }
 535 }
 536
 537 /* Discards all packets waiting to be received from 'netdev'. */
 538 int
 539 netdev_drain(struct netdev *netdev)
 540 {
 541     int (*drain)(struct netdev *);
 542
 543     drain = netdev_get_dev(netdev)->netdev_class->drain;
 544     return drain ? drain(netdev) : 0;
 545 }
 546
 547 /* Sends 'buffer' on 'netdev'.  Returns 0 if successful, otherwise a positive
 548  * errno value.  Returns EAGAIN without blocking if the packet cannot be queued
 549  * immediately.  Returns EMSGSIZE if a partial packet was transmitted or if
 550  * the packet is too big or too small to transmit on the device.
 551  *
 552  * The caller retains ownership of 'buffer' in all cases.
 553  *
 554  * The kernel maintains a packet transmission queue, so the caller is not
 555  * expected to do additional queuing of packets.
 556  *
 557  * Some network devices may not implement support for this function.  In such
 558  * cases this function will always return EOPNOTSUPP. */
 559 int
 560 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
 561 {
 562     int (*send)(struct netdev *, const void *, size_t);
 563     int error;
 564
 565     send = netdev_get_dev(netdev)->netdev_class->send;
 566     error = send ? (send)(netdev, buffer->data, buffer->size) : EOPNOTSUPP;
 567     if (!error) {
 568         COVERAGE_INC(netdev_sent);
 569     }
 570     return error;
 571 }
 572
 573 /* Registers with the poll loop to wake up from the next call to poll_block()
 574  * when the packet transmission queue has sufficient room to transmit a packet
 575  * with netdev_send().
 576  *
 577  * The kernel maintains a packet transmission queue, so the client is not
 578  * expected to do additional queuing of packets.  Thus, this function is
 579  * unlikely to ever be used.  It is included for completeness. */
 580 void
 581 netdev_send_wait(struct netdev *netdev)
 582 {
 583     void (*send_wait)(struct netdev *);
 584
 585     send_wait = netdev_get_dev(netdev)->netdev_class->send_wait;
 586     if (send_wait) {
 587         send_wait(netdev);
 588     }
 589 }
 590
 591 /* Attempts to set 'netdev''s MAC address to 'mac'.  Returns 0 if successful,
 592  * otherwise a positive errno value. */
 593 int
 594 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
 595 {
 596     return netdev_get_dev(netdev)->netdev_class->set_etheraddr(netdev, mac);
 597 }
 598
 599 /* Retrieves 'netdev''s MAC address.  If successful, returns 0 and copies the
 600  * the MAC address into 'mac'.  On failure, returns a positive errno value and
 601  * clears 'mac' to all-zeros. */
 602 int
 603 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
 604 {
 605     return netdev_get_dev(netdev)->netdev_class->get_etheraddr(netdev, mac);
 606 }
 607
 608 /* Returns the name of the network device that 'netdev' represents,
 609  * e.g. "eth0".  The caller must not modify or free the returned string. */
 610 const char *
 611 netdev_get_name(const struct netdev *netdev)
 612 {
 613     return netdev_get_dev(netdev)->name;
 614 }
 615
 616 /* Retrieves the MTU of 'netdev'.  The MTU is the maximum size of transmitted
 617  * (and received) packets, in bytes, not including the hardware header; thus,
 618  * this is typically 1500 bytes for Ethernet devices.
 619  *
 620  * If successful, returns 0 and stores the MTU size in '*mtup'.  On failure,
 621  * returns a positive errno value and stores ETH_PAYLOAD_MAX (1500) in
 622  * '*mtup'. */
 623 int
 624 netdev_get_mtu(const struct netdev *netdev, int *mtup)
 625 {
 626     int error = netdev_get_dev(netdev)->netdev_class->get_mtu(netdev, mtup);
 627     if (error) {
 628         VLOG_WARN_RL(&rl, "failed to retrieve MTU for network device %s: %s",
 629                      netdev_get_name(netdev), strerror(error));
 630         *mtup = ETH_PAYLOAD_MAX;
 631     }
 632     return error;
 633 }
 634
 635 /* Returns the ifindex of 'netdev', if successful, as a positive number.  On
 636  * failure, returns a negative errno value.
 637  *
 638  * The desired semantics of the ifindex value are a combination of those
 639  * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An ifindex
 640  * value should be unique within a host and remain stable at least until
 641  * reboot.  SNMP says an ifindex "ranges between 1 and the value of ifNumber"
 642  * but many systems do not follow this rule anyhow.
 643  *
 644  * Some network devices may not implement support for this function.  In such
 645  * cases this function will always return -EOPNOTSUPP.
 646  */
 647 int
 648 netdev_get_ifindex(const struct netdev *netdev)
 649 {
 650     int (*get_ifindex)(const struct netdev *);
 651
 652     get_ifindex = netdev_get_dev(netdev)->netdev_class->get_ifindex;
 653
 654     return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
 655 }
 656
 657 /* Stores the features supported by 'netdev' into each of '*current',
 658  * '*advertised', '*supported', and '*peer' that are non-null.  Each value is a
 659  * bitmap of "enum ofp_port_features" bits, in host byte order.  Returns 0 if
 660  * successful, otherwise a positive errno value.  On failure, all of the
 661  * passed-in values are set to 0.
 662  *
 663  * Some network devices may not implement support for this function.  In such
 664  * cases this function will always return EOPNOTSUPP.
 665  */
 666 int
 667 netdev_get_features(struct netdev *netdev,
 668                     uint32_t *current, uint32_t *advertised,
 669                     uint32_t *supported, uint32_t *peer)
 670 {
 671     int (*get_features)(struct netdev *netdev,
 672                         uint32_t *current, uint32_t *advertised,
 673                         uint32_t *supported, uint32_t *peer);
 674     uint32_t dummy[4];
 675     int error;
 676
 677     if (!current) {
 678         current = &dummy[0];
 679     }
 680     if (!advertised) {
 681         advertised = &dummy[1];
 682     }
 683     if (!supported) {
 684         supported = &dummy[2];
 685     }
 686     if (!peer) {
 687         peer = &dummy[3];
 688     }
 689
 690     get_features = netdev_get_dev(netdev)->netdev_class->get_features;
 691     error = get_features
 692                     ? get_features(netdev, current, advertised, supported, peer)
 693                     : EOPNOTSUPP;
 694     if (error) {
 695         *current = *advertised = *supported = *peer = 0;
 696     }
 697     return error;
 698 }
 699
 700 /* Returns the maximum speed of a network connection that has the "enum
 701  * ofp_port_features" bits in 'features', in bits per second.  If no bits that
 702  * indicate a speed are set in 'features', assumes 100Mbps. */
 703 uint64_t
 704 netdev_features_to_bps(uint32_t features)
 705 {
 706     enum {
 707         F_10000MB = OFPPF_10GB_FD,
 708         F_1000MB = OFPPF_1GB_HD | OFPPF_1GB_FD,
 709         F_100MB = OFPPF_100MB_HD | OFPPF_100MB_FD,
 710         F_10MB = OFPPF_10MB_HD | OFPPF_10MB_FD
 711     };
 712
 713     return (  features & F_10000MB  ? UINT64_C(10000000000)
 714             : features & F_1000MB   ? UINT64_C(1000000000)
 715             : features & F_100MB    ? UINT64_C(100000000)
 716             : features & F_10MB     ? UINT64_C(10000000)
 717                                     : UINT64_C(100000000));
 718 }
 719
 720 /* Returns true if any of the "enum ofp_port_features" bits that indicate a
 721  * full-duplex link are set in 'features', otherwise false. */
 722 bool
 723 netdev_features_is_full_duplex(uint32_t features)
 724 {
 725     return (features & (OFPPF_10MB_FD | OFPPF_100MB_FD | OFPPF_1GB_FD
 726                         | OFPPF_10GB_FD)) != 0;
 727 }
 728
 729 /* Set the features advertised by 'netdev' to 'advertise'.  Returns 0 if
 730  * successful, otherwise a positive errno value. */
 731 int
 732 netdev_set_advertisements(struct netdev *netdev, uint32_t advertise)
 733 {
 734     return (netdev_get_dev(netdev)->netdev_class->set_advertisements
 735             ? netdev_get_dev(netdev)->netdev_class->set_advertisements(
 736                     netdev, advertise)
 737             : EOPNOTSUPP);
 738 }
 739
 740 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
 741  * and '*netmask' to its netmask and returns 0.  Otherwise, returns a positive
 742  * errno value and sets '*address' to 0 (INADDR_ANY).
 743  *
 744  * The following error values have well-defined meanings:
 745  *
 746  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 747  *
 748  *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 749  *
 750  * 'address' or 'netmask' or both may be null, in which case the address or netmask
 751  * is not reported. */
 752 int
 753 netdev_get_in4(const struct netdev *netdev,
 754                struct in_addr *address_, struct in_addr *netmask_)
 755 {
 756     struct in_addr address;
 757     struct in_addr netmask;
 758     int error;
 759
 760     error = (netdev_get_dev(netdev)->netdev_class->get_in4
 761              ? netdev_get_dev(netdev)->netdev_class->get_in4(netdev,
 762                     &address, &netmask)
 763              : EOPNOTSUPP);
 764     if (address_) {
 765         address_->s_addr = error ? 0 : address.s_addr;
 766     }
 767     if (netmask_) {
 768         netmask_->s_addr = error ? 0 : netmask.s_addr;
 769     }
 770     return error;
 771 }
 772
 773 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 774  * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.  Returns a
 775  * positive errno value. */
 776 int
 777 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
 778 {
 779     return (netdev_get_dev(netdev)->netdev_class->set_in4
 780             ? netdev_get_dev(netdev)->netdev_class->set_in4(netdev, addr, mask)
 781             : EOPNOTSUPP);
 782 }
 783
 784 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
 785  * to 'netdev'. */
 786 int
 787 netdev_add_router(struct netdev *netdev, struct in_addr router)
 788 {
 789     COVERAGE_INC(netdev_add_router);
 790     return (netdev_get_dev(netdev)->netdev_class->add_router
 791             ? netdev_get_dev(netdev)->netdev_class->add_router(netdev, router)
 792             : EOPNOTSUPP);
 793 }
 794
 795 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
 796  * 'netdev'.  If a route cannot not be determined, sets '*next_hop' to 0,
 797  * '*netdev_name' to null, and returns a positive errno value.  Otherwise, if a
 798  * next hop is found, stores the next hop gateway's address (0 if 'host' is on
 799  * a directly connected network) in '*next_hop' and a copy of the name of the
 800  * device to reach 'host' in '*netdev_name', and returns 0.  The caller is
 801  * responsible for freeing '*netdev_name' (by calling free()). */
 802 int
 803 netdev_get_next_hop(const struct netdev *netdev,
 804                     const struct in_addr *host, struct in_addr *next_hop,
 805                     char **netdev_name)
 806 {
 807     int error = (netdev_get_dev(netdev)->netdev_class->get_next_hop
 808                  ? netdev_get_dev(netdev)->netdev_class->get_next_hop(
 809                         host, next_hop, netdev_name)
 810                  : EOPNOTSUPP);
 811     if (error) {
 812         next_hop->s_addr = 0;
 813         *netdev_name = NULL;
 814     }
 815     return error;
 816 }
 817
 818 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
 819  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
 820  * all-zero-bits (in6addr_any).
 821  *
 822  * The following error values have well-defined meanings:
 823  *
 824  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 825  *
 826  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 827  *
 828  * 'in6' may be null, in which case the address itself is not reported. */
 829 int
 830 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
 831 {
 832     struct in6_addr dummy;
 833     int error;
 834
 835     error = (netdev_get_dev(netdev)->netdev_class->get_in6
 836              ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
 837                     in6 ? in6 : &dummy)
 838              : EOPNOTSUPP);
 839     if (error && in6) {
 840         memset(in6, 0, sizeof *in6);
 841     }
 842     return error;
 843 }
 844
 845 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
 846  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
 847  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
 848  * successful, otherwise a positive errno value. */
 849 static int
 850 do_update_flags(struct netdev *netdev, enum netdev_flags off,
 851                 enum netdev_flags on, enum netdev_flags *old_flagsp,
 852                 bool permanent)
 853 {
 854     enum netdev_flags old_flags;
 855     int error;
 856
 857     error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
 858                 off & ~on, on, &old_flags);
 859     if (error) {
 860         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
 861                      off || on ? "set" : "get", netdev_get_name(netdev),
 862                      strerror(error));
 863         old_flags = 0;
 864     } else if ((off || on) && !permanent) {
 865         enum netdev_flags new_flags = (old_flags & ~off) | on;
 866         enum netdev_flags changed_flags = old_flags ^ new_flags;
 867         if (changed_flags) {
 868             if (!netdev->changed_flags) {
 869                 netdev->save_flags = old_flags;
 870             }
 871             netdev->changed_flags |= changed_flags;
 872         }
 873     }
 874     if (old_flagsp) {
 875         *old_flagsp = old_flags;
 876     }
 877     return error;
 878 }
 879
 880 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
 881  * Returns 0 if successful, otherwise a positive errno value.  On failure,
 882  * stores 0 into '*flagsp'. */
 883 int
 884 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
 885 {
 886     struct netdev *netdev = (struct netdev *) netdev_;
 887     return do_update_flags(netdev, 0, 0, flagsp, false);
 888 }
 889
 890 /* Sets the flags for 'netdev' to 'flags'.
 891  * If 'permanent' is true, the changes will persist; otherwise, they
 892  * will be reverted when 'netdev' is closed or the program exits.
 893  * Returns 0 if successful, otherwise a positive errno value. */
 894 int
 895 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
 896                  bool permanent)
 897 {
 898     return do_update_flags(netdev, -1, flags, NULL, permanent);
 899 }
 900
 901 /* Turns on the specified 'flags' on 'netdev'.
 902  * If 'permanent' is true, the changes will persist; otherwise, they
 903  * will be reverted when 'netdev' is closed or the program exits.
 904  * Returns 0 if successful, otherwise a positive errno value. */
 905 int
 906 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
 907                      bool permanent)
 908 {
 909     return do_update_flags(netdev, 0, flags, NULL, permanent);
 910 }
 911
 912 /* Turns off the specified 'flags' on 'netdev'.
 913  * If 'permanent' is true, the changes will persist; otherwise, they
 914  * will be reverted when 'netdev' is closed or the program exits.
 915  * Returns 0 if successful, otherwise a positive errno value. */
 916 int
 917 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
 918                       bool permanent)
 919 {
 920     return do_update_flags(netdev, flags, 0, NULL, permanent);
 921 }
 922
 923 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
 924  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
 925  * returns 0.  Otherwise, it returns a positive errno value; in particular,
 926  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
 927 int
 928 netdev_arp_lookup(const struct netdev *netdev,
 929                   uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
 930 {
 931     int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
 932                  ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
 933                         ip, mac)
 934                  : EOPNOTSUPP);
 935     if (error) {
 936         memset(mac, 0, ETH_ADDR_LEN);
 937     }
 938     return error;
 939 }
 940
 941 /* Sets 'carrier' to true if carrier is active (link light is on) on
 942  * 'netdev'. */
 943 int
 944 netdev_get_carrier(const struct netdev *netdev, bool *carrier)
 945 {
 946     int error = (netdev_get_dev(netdev)->netdev_class->get_carrier
 947                  ? netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
 948                         carrier)
 949                  : EOPNOTSUPP);
 950     if (error) {
 951         *carrier = false;
 952     }
 953     return error;
 954 }
 955
 956 /* Retrieves current device stats for 'netdev'. */
 957 int
 958 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
 959 {
 960     int error;
 961
 962     COVERAGE_INC(netdev_get_stats);
 963     error = (netdev_get_dev(netdev)->netdev_class->get_stats
 964              ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
 965              : EOPNOTSUPP);
 966     if (error) {
 967         memset(stats, 0xff, sizeof *stats);
 968     }
 969     return error;
 970 }
 971
 972 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
 973  * Returns 0 if successful, otherwise a positive errno value.
 974  *
 975  * This will probably fail for most network devices.  Some devices might only
 976  * allow setting their stats to 0. */
 977 int
 978 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
 979 {
 980     return (netdev_get_dev(netdev)->netdev_class->set_stats
 981              ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
 982              : EOPNOTSUPP);
 983 }
 984
 985 /* Attempts to set input rate limiting (policing) policy, such that up to
 986  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
 987  * size of 'kbits' kb. */
 988 int
 989 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
 990                     uint32_t kbits_burst)
 991 {
 992     return (netdev_get_dev(netdev)->netdev_class->set_policing
 993             ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
 994                     kbits_rate, kbits_burst)
 995             : EOPNOTSUPP);
 996 }
 997
 998 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
 999  * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
1000  * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
1001  * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
1002  * -1. */
1003 int
1004 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
1005 {
1006     int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
1007                  ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
1008                         vlan_vid)
1009                  : ENOENT);
1010     if (error) {
1011         *vlan_vid = 0;
1012     }
1013     return error;
1014 }
1015
1016 /* Returns a network device that has 'in4' as its IP address, if one exists,
1017  * otherwise a null pointer. */
1018 struct netdev *
1019 netdev_find_dev_by_in4(const struct in_addr *in4)
1020 {
1021     struct netdev *netdev;
1022     struct svec dev_list = SVEC_EMPTY_INITIALIZER;
1023     size_t i;
1024
1025     netdev_enumerate(&dev_list);
1026     for (i = 0; i < dev_list.n; i++) {
1027         const char *name = dev_list.names[i];
1028         struct in_addr dev_in4;
1029
1030         if (!netdev_open_default(name, &netdev)
1031             && !netdev_get_in4(netdev, &dev_in4, NULL)
1032             && dev_in4.s_addr == in4->s_addr) {
1033             goto exit;
1034         }
1035         netdev_close(netdev);
1036     }
1037     netdev = NULL;
1038
1039 exit:
1040     svec_destroy(&dev_list);
1041     return netdev;
1042 }
1043 \f
1044 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
1045  * specified 'netdev_class'.
1046  *
1047  * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1048  * very important that 'netdev_dev' only be freed after calling
1049  * the refcount drops to zero.  */
1050 void
1051 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1052                 const struct netdev_class *netdev_class)
1053 {
1054     assert(!shash_find(&netdev_dev_shash, name));
1055
1056     memset(netdev_dev, 0, sizeof *netdev_dev);
1057     netdev_dev->netdev_class = netdev_class;
1058     netdev_dev->name = xstrdup(name);
1059     netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1060 }
1061
1062 /* Undoes the results of initialization.
1063  *
1064  * Normally this function does not need to be called as netdev_close has
1065  * the same effect when the refcount drops to zero.
1066  * However, it may be called by providers due to an error on creation
1067  * that occurs after initialization.  It this case netdev_close() would
1068  * never be called. */
1069 void
1070 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1071 {
1072     char *name = netdev_dev->name;
1073
1074     assert(!netdev_dev->ref_cnt);
1075
1076     shash_delete(&netdev_dev_shash, netdev_dev->node);
1077     update_device_args(netdev_dev, NULL);
1078
1079     if (destroy) {
1080         netdev_dev->netdev_class->destroy(netdev_dev);
1081     }
1082     free(name);
1083 }
1084
1085 /* Returns the class type of 'netdev_dev'.
1086  *
1087  * The caller must not free the returned value. */
1088 const char *
1089 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1090 {
1091     return netdev_dev->netdev_class->type;
1092 }
1093
1094 /* Returns the class associated with 'netdev_dev'. */
1095 const struct netdev_class *
1096 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1097 {
1098     return netdev_dev->netdev_class;
1099 }
1100
1101 /* Returns the name of 'netdev_dev'.
1102  *
1103  * The caller must not free the returned value. */
1104 const char *
1105 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1106 {
1107     return netdev_dev->name;
1108 }
1109
1110 /* Returns the netdev_dev with 'name' or NULL if there is none.
1111  *
1112  * The caller must not free the returned value. */
1113 struct netdev_dev *
1114 netdev_dev_from_name(const char *name)
1115 {
1116     return shash_find_data(&netdev_dev_shash, name);
1117 }
1118
1119 /* Fills 'device_list' with devices that match 'netdev_class'.
1120  *
1121  * The caller is responsible for initializing and destroying 'device_list'
1122  * but the contained netdev_devs must not be freed. */
1123 void
1124 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1125                        struct shash *device_list)
1126 {
1127     struct shash_node *node;
1128     SHASH_FOR_EACH (node, &netdev_dev_shash) {
1129         struct netdev_dev *dev = node->data;
1130
1131         if (dev->netdev_class == netdev_class) {
1132             shash_add(device_list, node->name, node->data);
1133         }
1134     }
1135 }
1136
1137 /* Initializes 'netdev' as a instance of the netdev_dev.
1138  *
1139  * This function adds 'netdev' to a netdev-owned linked list, so it is very
1140  * important that 'netdev' only be freed after calling netdev_close(). */
1141 void
1142 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1143 {
1144     memset(netdev, 0, sizeof *netdev);
1145     netdev->netdev_dev = netdev_dev;
1146     netdev->ref_cnt = 1;
1147     list_push_back(&netdev_list, &netdev->node);
1148 }
1149
1150 /* Undoes the results of initialization.
1151  *
1152  * Normally this function only needs to be called from netdev_close().
1153  * However, it may be called by providers due to an error on opening
1154  * that occurs after initialization.  In this case netdev_close() would
1155  * never be called. */
1156 void
1157 netdev_uninit(struct netdev *netdev, bool close)
1158 {
1159     /* Restore flags that we changed, if any. */
1160     int error = restore_flags(netdev);
1161     list_remove(&netdev->node);
1162     if (error) {
1163         VLOG_WARN("failed to restore network device flags on %s: %s",
1164                   netdev_get_name(netdev), strerror(error));
1165     }
1166
1167     if (close) {
1168         netdev_get_dev(netdev)->netdev_class->close(netdev);
1169     }
1170 }
1171
1172
1173 /* Returns the class type of 'netdev'.
1174  *
1175  * The caller must not free the returned value. */
1176 const char *
1177 netdev_get_type(const struct netdev *netdev)
1178 {
1179     return netdev_get_dev(netdev)->netdev_class->type;
1180 }
1181
1182 struct netdev_dev *
1183 netdev_get_dev(const struct netdev *netdev)
1184 {
1185     return netdev->netdev_dev;
1186 }
1187
1188 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
1189  * notification will consist of calling 'cb', with auxiliary data 'aux'. */
1190 void
1191 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
1192                      void (*cb)(struct netdev_notifier *), void *aux)
1193 {
1194     notifier->netdev = netdev;
1195     notifier->cb = cb;
1196     notifier->aux = aux;
1197 }
1198 \f
1199 /* Tracks changes in the status of a set of network devices. */
1200 struct netdev_monitor {
1201     struct shash polled_netdevs;
1202     struct shash changed_netdevs;
1203 };
1204
1205 /* Creates and returns a new structure for monitor changes in the status of
1206  * network devices. */
1207 struct netdev_monitor *
1208 netdev_monitor_create(void)
1209 {
1210     struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
1211     shash_init(&monitor->polled_netdevs);
1212     shash_init(&monitor->changed_netdevs);
1213     return monitor;
1214 }
1215
1216 /* Destroys 'monitor'. */
1217 void
1218 netdev_monitor_destroy(struct netdev_monitor *monitor)
1219 {
1220     if (monitor) {
1221         struct shash_node *node;
1222
1223         SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
1224             struct netdev_notifier *notifier = node->data;
1225             netdev_get_dev(notifier->netdev)->netdev_class->poll_remove(
1226                     notifier);
1227         }
1228
1229         shash_destroy(&monitor->polled_netdevs);
1230         shash_destroy(&monitor->changed_netdevs);
1231         free(monitor);
1232     }
1233 }
1234
1235 static void
1236 netdev_monitor_cb(struct netdev_notifier *notifier)
1237 {
1238     struct netdev_monitor *monitor = notifier->aux;
1239     const char *name = netdev_get_name(notifier->netdev);
1240     if (!shash_find(&monitor->changed_netdevs, name)) {
1241         shash_add(&monitor->changed_netdevs, name, NULL);
1242     }
1243 }
1244
1245 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'.  Returns 0 if
1246  * successful, otherwise a positive errno value.
1247  *
1248  * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1249  * it once. */
1250 int
1251 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1252 {
1253     const char *netdev_name = netdev_get_name(netdev);
1254     int error = 0;
1255     if (!shash_find(&monitor->polled_netdevs, netdev_name)
1256             && netdev_get_dev(netdev)->netdev_class->poll_add)
1257     {
1258         struct netdev_notifier *notifier;
1259         error = netdev_get_dev(netdev)->netdev_class->poll_add(netdev,
1260                     netdev_monitor_cb, monitor, &notifier);
1261         if (!error) {
1262             assert(notifier->netdev == netdev);
1263             shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1264         }
1265     }
1266     return error;
1267 }
1268
1269 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'.  (This has
1270  * no effect if 'netdev' is not in the set of devices monitored by
1271  * 'monitor'.) */
1272 void
1273 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1274 {
1275     const char *netdev_name = netdev_get_name(netdev);
1276     struct shash_node *node;
1277
1278     node = shash_find(&monitor->polled_netdevs, netdev_name);
1279     if (node) {
1280         /* Cancel future notifications. */
1281         struct netdev_notifier *notifier = node->data;
1282         netdev_get_dev(netdev)->netdev_class->poll_remove(notifier);
1283         shash_delete(&monitor->polled_netdevs, node);
1284
1285         /* Drop any pending notification. */
1286         node = shash_find(&monitor->changed_netdevs, netdev_name);
1287         if (node) {
1288             shash_delete(&monitor->changed_netdevs, node);
1289         }
1290     }
1291 }
1292
1293 /* Checks for changes to netdevs in the set monitored by 'monitor'.  If any of
1294  * the attributes (Ethernet address, carrier status, speed or peer-advertised
1295  * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1296  * sets '*devnamep' to the name of a device that has changed and returns 0.
1297  * The caller is responsible for freeing '*devnamep' (with free()).
1298  *
1299  * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN.
1300  */
1301 int
1302 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1303 {
1304     struct shash_node *node = shash_first(&monitor->changed_netdevs);
1305     if (!node) {
1306         *devnamep = NULL;
1307         return EAGAIN;
1308     } else {
1309         *devnamep = xstrdup(node->name);
1310         shash_delete(&monitor->changed_netdevs, node);
1311         return 0;
1312     }
1313 }
1314
1315 /* Registers with the poll loop to wake up from the next call to poll_block()
1316  * when netdev_monitor_poll(monitor) would indicate that a device has
1317  * changed. */
1318 void
1319 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1320 {
1321     if (!shash_is_empty(&monitor->changed_netdevs)) {
1322         poll_immediate_wake();
1323     } else {
1324         /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1325          * classes need help. */
1326     }
1327 }
1328 \f
1329 /* Restore the network device flags on 'netdev' to those that were active
1330  * before we changed them.  Returns 0 if successful, otherwise a positive
1331  * errno value.
1332  *
1333  * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1334 static int
1335 restore_flags(struct netdev *netdev)
1336 {
1337     if (netdev->changed_flags) {
1338         enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1339         enum netdev_flags old_flags;
1340         return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1341                                            netdev->changed_flags & ~restore,
1342                                            restore, &old_flags);
1343     }
1344     return 0;
1345 }
1346
1347 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1348  * destroying devices, restoring flags, etc. */
1349 static void
1350 close_all_netdevs(void *aux OVS_UNUSED)
1351 {
1352     struct netdev *netdev, *next;
1353     LIST_FOR_EACH_SAFE(netdev, next, struct netdev, node, &netdev_list) {
1354         netdev_close(netdev);
1355     }
1356 }