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