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