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