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