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