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