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 const char *
 773 netdev_get_tnl_iface(const struct netdev *netdev)
 774 {
 775     struct netdev_dev *dev = netdev_get_dev(netdev);
 776
 777     return (dev->netdev_class->get_tnl_iface
 778             ? dev->netdev_class->get_tnl_iface(netdev)
 779             : NULL);
 780 }
 781
 782 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
 783  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
 784  * all-zero-bits (in6addr_any).
 785  *
 786  * The following error values have well-defined meanings:
 787  *
 788  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 789  *
 790  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 791  *
 792  * 'in6' may be null, in which case the address itself is not reported. */
 793 int
 794 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
 795 {
 796     struct in6_addr dummy;
 797     int error;
 798
 799     error = (netdev_get_dev(netdev)->netdev_class->get_in6
 800              ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
 801                     in6 ? in6 : &dummy)
 802              : EOPNOTSUPP);
 803     if (error && in6) {
 804         memset(in6, 0, sizeof *in6);
 805     }
 806     return error;
 807 }
 808
 809 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
 810  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
 811  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
 812  * successful, otherwise a positive errno value. */
 813 static int
 814 do_update_flags(struct netdev *netdev, enum netdev_flags off,
 815                 enum netdev_flags on, enum netdev_flags *old_flagsp,
 816                 bool permanent)
 817 {
 818     enum netdev_flags old_flags;
 819     int error;
 820
 821     error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
 822                 off & ~on, on, &old_flags);
 823     if (error) {
 824         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
 825                      off || on ? "set" : "get", netdev_get_name(netdev),
 826                      strerror(error));
 827         old_flags = 0;
 828     } else if ((off || on) && !permanent) {
 829         enum netdev_flags new_flags = (old_flags & ~off) | on;
 830         enum netdev_flags changed_flags = old_flags ^ new_flags;
 831         if (changed_flags) {
 832             if (!netdev->changed_flags) {
 833                 netdev->save_flags = old_flags;
 834             }
 835             netdev->changed_flags |= changed_flags;
 836         }
 837     }
 838     if (old_flagsp) {
 839         *old_flagsp = old_flags;
 840     }
 841     return error;
 842 }
 843
 844 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
 845  * Returns 0 if successful, otherwise a positive errno value.  On failure,
 846  * stores 0 into '*flagsp'. */
 847 int
 848 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
 849 {
 850     struct netdev *netdev = (struct netdev *) netdev_;
 851     return do_update_flags(netdev, 0, 0, flagsp, false);
 852 }
 853
 854 /* Sets the flags for 'netdev' to 'flags'.
 855  * If 'permanent' is true, the changes will persist; otherwise, they
 856  * will be reverted when 'netdev' is closed or the program exits.
 857  * Returns 0 if successful, otherwise a positive errno value. */
 858 int
 859 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
 860                  bool permanent)
 861 {
 862     return do_update_flags(netdev, -1, flags, NULL, permanent);
 863 }
 864
 865 /* Turns on the specified 'flags' on 'netdev'.
 866  * If 'permanent' is true, the changes will persist; otherwise, they
 867  * will be reverted when 'netdev' is closed or the program exits.
 868  * Returns 0 if successful, otherwise a positive errno value. */
 869 int
 870 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
 871                      bool permanent)
 872 {
 873     return do_update_flags(netdev, 0, flags, NULL, permanent);
 874 }
 875
 876 /* Turns off the specified 'flags' on 'netdev'.
 877  * If 'permanent' is true, the changes will persist; otherwise, they
 878  * will be reverted when 'netdev' is closed or the program exits.
 879  * Returns 0 if successful, otherwise a positive errno value. */
 880 int
 881 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
 882                       bool permanent)
 883 {
 884     return do_update_flags(netdev, flags, 0, NULL, permanent);
 885 }
 886
 887 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
 888  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
 889  * returns 0.  Otherwise, it returns a positive errno value; in particular,
 890  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
 891 int
 892 netdev_arp_lookup(const struct netdev *netdev,
 893                   uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
 894 {
 895     int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
 896                  ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
 897                         ip, mac)
 898                  : EOPNOTSUPP);
 899     if (error) {
 900         memset(mac, 0, ETH_ADDR_LEN);
 901     }
 902     return error;
 903 }
 904
 905 /* Returns true if carrier is active (link light is on) on 'netdev'. */
 906 bool
 907 netdev_get_carrier(const struct netdev *netdev)
 908 {
 909     int error;
 910     enum netdev_flags flags;
 911     bool carrier;
 912
 913     netdev_get_flags(netdev, &flags);
 914     if (!(flags & NETDEV_UP)) {
 915         return false;
 916     }
 917
 918     if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
 919         return true;
 920     }
 921
 922     error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
 923                                                               &carrier);
 924     if (error) {
 925         VLOG_DBG("%s: failed to get network device carrier status, assuming "
 926                  "down: %s", netdev_get_name(netdev), strerror(error));
 927         carrier = false;
 928     }
 929
 930     return carrier;
 931 }
 932
 933 /* Retrieves current device stats for 'netdev'. */
 934 int
 935 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
 936 {
 937     int error;
 938
 939     COVERAGE_INC(netdev_get_stats);
 940     error = (netdev_get_dev(netdev)->netdev_class->get_stats
 941              ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
 942              : EOPNOTSUPP);
 943     if (error) {
 944         memset(stats, 0xff, sizeof *stats);
 945     }
 946     return error;
 947 }
 948
 949 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
 950  * Returns 0 if successful, otherwise a positive errno value.
 951  *
 952  * This will probably fail for most network devices.  Some devices might only
 953  * allow setting their stats to 0. */
 954 int
 955 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
 956 {
 957     return (netdev_get_dev(netdev)->netdev_class->set_stats
 958              ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
 959              : EOPNOTSUPP);
 960 }
 961
 962 /* Attempts to set input rate limiting (policing) policy, such that up to
 963  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
 964  * size of 'kbits' kb. */
 965 int
 966 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
 967                     uint32_t kbits_burst)
 968 {
 969     return (netdev_get_dev(netdev)->netdev_class->set_policing
 970             ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
 971                     kbits_rate, kbits_burst)
 972             : EOPNOTSUPP);
 973 }
 974
 975 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
 976  * empty if 'netdev' does not support QoS.  Any names added to 'types' should
 977  * be documented as valid for the "type" column in the "QoS" table in
 978  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 979  *
 980  * Every network device supports disabling QoS with a type of "", but this type
 981  * will not be added to 'types'.
 982  *
 983  * The caller must initialize 'types' (e.g. with svec_init()) before calling
 984  * this function.  The caller is responsible for destroying 'types' (e.g. with
 985  * svec_destroy()) when it is no longer needed.
 986  *
 987  * Returns 0 if successful, otherwise a positive errno value. */
 988 int
 989 netdev_get_qos_types(const struct netdev *netdev, struct svec *types)
 990 {
 991     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
 992     return (class->get_qos_types
 993             ? class->get_qos_types(netdev, types)
 994             : 0);
 995 }
 996
 997 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
 998  * which should be "" or one of the types returned by netdev_get_qos_types()
 999  * for 'netdev'.  Returns 0 if successful, otherwise a positive errno value.
1000  * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1001  * 'caps' to all zeros. */
1002 int
1003 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1004                             struct netdev_qos_capabilities *caps)
1005 {
1006     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1007
1008     if (*type) {
1009         int retval = (class->get_qos_capabilities
1010                       ? class->get_qos_capabilities(netdev, type, caps)
1011                       : EOPNOTSUPP);
1012         if (retval) {
1013             memset(caps, 0, sizeof *caps);
1014         }
1015         return retval;
1016     } else {
1017         /* Every netdev supports turning off QoS. */
1018         memset(caps, 0, sizeof *caps);
1019         return 0;
1020     }
1021 }
1022
1023 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1024  * of QoS.  Returns 0 if successful, otherwise a positive errno value.  Stores
1025  * the number of queues (zero on failure) in '*n_queuesp'.
1026  *
1027  * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1028 int
1029 netdev_get_n_queues(const struct netdev *netdev,
1030                     const char *type, unsigned int *n_queuesp)
1031 {
1032     struct netdev_qos_capabilities caps;
1033     int retval;
1034
1035     retval = netdev_get_qos_capabilities(netdev, type, &caps);
1036     *n_queuesp = caps.n_queues;
1037     return retval;
1038 }
1039
1040 /* Queries 'netdev' about its currently configured form of QoS.  If successful,
1041  * stores the name of the current form of QoS into '*typep', stores any details
1042  * of configuration as string key-value pairs in 'details', and returns 0.  On
1043  * failure, sets '*typep' to NULL and returns a positive errno value.
1044  *
1045  * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1046  *
1047  * The caller must initialize 'details' as an empty shash (e.g. with
1048  * shash_init()) before calling this function.  The caller must free 'details',
1049  * including 'data' members, when it is no longer needed (e.g. with
1050  * shash_destroy_free_data()).
1051  *
1052  * The caller must not modify or free '*typep'.
1053  *
1054  * '*typep' will be one of the types returned by netdev_get_qos_types() for
1055  * 'netdev'.  The contents of 'details' should be documented as valid for
1056  * '*typep' in the "other_config" column in the "QoS" table in
1057  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1058 int
1059 netdev_get_qos(const struct netdev *netdev,
1060                const char **typep, struct shash *details)
1061 {
1062     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1063     int retval;
1064
1065     if (class->get_qos) {
1066         retval = class->get_qos(netdev, typep, details);
1067         if (retval) {
1068             *typep = NULL;
1069             shash_clear_free_data(details);
1070         }
1071         return retval;
1072     } else {
1073         /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1074         *typep = "";
1075         return 0;
1076     }
1077 }
1078
1079 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1080  * with details of configuration from 'details'.  Returns 0 if successful,
1081  * otherwise a positive errno value.  On error, the previous QoS configuration
1082  * is retained.
1083  *
1084  * When this function changes the type of QoS (not just 'details'), this also
1085  * resets all queue configuration for 'netdev' to their defaults (which depend
1086  * on the specific type of QoS).  Otherwise, the queue configuration for
1087  * 'netdev' is unchanged.
1088  *
1089  * 'type' should be "" (to disable QoS) or one of the types returned by
1090  * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should be
1091  * documented as valid for the given 'type' in the "other_config" column in the
1092  * "QoS" table in vswitchd/vswitch.xml (which is built as
1093  * ovs-vswitchd.conf.db(8)).
1094  *
1095  * NULL may be specified for 'details' if there are no configuration
1096  * details. */
1097 int
1098 netdev_set_qos(struct netdev *netdev,
1099                const char *type, const struct shash *details)
1100 {
1101     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1102
1103     if (!type) {
1104         type = "";
1105     }
1106
1107     if (class->set_qos) {
1108         if (!details) {
1109             static struct shash empty = SHASH_INITIALIZER(&empty);
1110             details = &empty;
1111         }
1112         return class->set_qos(netdev, type, details);
1113     } else {
1114         return *type ? EOPNOTSUPP : 0;
1115     }
1116 }
1117
1118 /* Queries 'netdev' for information about the queue numbered 'queue_id'.  If
1119  * successful, adds that information as string key-value pairs to 'details'.
1120  * Returns 0 if successful, otherwise a positive errno value.
1121  *
1122  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1123  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1124  *
1125  * The returned contents of 'details' should be documented as valid for the
1126  * given 'type' in the "other_config" column in the "Queue" table in
1127  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1128  *
1129  * The caller must initialize 'details' (e.g. with shash_init()) before calling
1130  * this function.  The caller must free 'details', including 'data' members,
1131  * when it is no longer needed (e.g. with shash_destroy_free_data()). */
1132 int
1133 netdev_get_queue(const struct netdev *netdev,
1134                  unsigned int queue_id, struct shash *details)
1135 {
1136     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1137     int retval;
1138
1139     retval = (class->get_queue
1140               ? class->get_queue(netdev, queue_id, details)
1141               : EOPNOTSUPP);
1142     if (retval) {
1143         shash_clear_free_data(details);
1144     }
1145     return retval;
1146 }
1147
1148 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1149  * string pairs in 'details'.  The contents of 'details' should be documented
1150  * as valid for the given 'type' in the "other_config" column in the "Queue"
1151  * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1152  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1153  * given queue's configuration should be unmodified.
1154  *
1155  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1156  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1157  *
1158  * This function does not modify 'details', and the caller retains ownership of
1159  * it. */
1160 int
1161 netdev_set_queue(struct netdev *netdev,
1162                  unsigned int queue_id, const struct shash *details)
1163 {
1164     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1165     return (class->set_queue
1166             ? class->set_queue(netdev, queue_id, details)
1167             : EOPNOTSUPP);
1168 }
1169
1170 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.  Some kinds
1171  * of QoS may have a fixed set of queues, in which case attempts to delete them
1172  * will fail with EOPNOTSUPP.
1173  *
1174  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1175  * given queue will be unmodified.
1176  *
1177  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1178  * the current form of QoS (e.g. as returned by
1179  * netdev_get_n_queues(netdev)). */
1180 int
1181 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1182 {
1183     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1184     return (class->delete_queue
1185             ? class->delete_queue(netdev, queue_id)
1186             : EOPNOTSUPP);
1187 }
1188
1189 /* Obtains statistics about 'queue_id' on 'netdev'.  On success, returns 0 and
1190  * fills 'stats' with the queue's statistics; individual members of 'stats' may
1191  * be set to all-1-bits if the statistic is unavailable.  On failure, returns a
1192  * positive errno value and fills 'stats' with all-1-bits. */
1193 int
1194 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1195                        struct netdev_queue_stats *stats)
1196 {
1197     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1198     int retval;
1199
1200     retval = (class->get_queue_stats
1201               ? class->get_queue_stats(netdev, queue_id, stats)
1202               : EOPNOTSUPP);
1203     if (retval) {
1204         memset(stats, 0xff, sizeof *stats);
1205     }
1206     return retval;
1207 }
1208
1209 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1210  * its configuration, and the 'aux' specified by the caller.  The order of
1211  * iteration is unspecified, but (when successful) each queue is visited
1212  * exactly once.
1213  *
1214  * Calling this function may be more efficient than calling netdev_get_queue()
1215  * for every queue.
1216  *
1217  * 'cb' must not modify or free the 'details' argument passed in.
1218  *
1219  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1220  * configured queues may not have been included in the iteration. */
1221 int
1222 netdev_dump_queues(const struct netdev *netdev,
1223                    netdev_dump_queues_cb *cb, void *aux)
1224 {
1225     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1226     return (class->dump_queues
1227             ? class->dump_queues(netdev, cb, aux)
1228             : EOPNOTSUPP);
1229 }
1230
1231 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1232  * its statistics, and the 'aux' specified by the caller.  The order of
1233  * iteration is unspecified, but (when successful) each queue is visited
1234  * exactly once.
1235  *
1236  * Calling this function may be more efficient than calling
1237  * netdev_get_queue_stats() for every queue.
1238  *
1239  * 'cb' must not modify or free the statistics passed in.
1240  *
1241  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1242  * configured queues may not have been included in the iteration. */
1243 int
1244 netdev_dump_queue_stats(const struct netdev *netdev,
1245                         netdev_dump_queue_stats_cb *cb, void *aux)
1246 {
1247     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1248     return (class->dump_queue_stats
1249             ? class->dump_queue_stats(netdev, cb, aux)
1250             : EOPNOTSUPP);
1251 }
1252
1253 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
1254  * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
1255  * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
1256  * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
1257  * -1. */
1258 int
1259 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
1260 {
1261     int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
1262                  ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
1263                         vlan_vid)
1264                  : ENOENT);
1265     if (error) {
1266         *vlan_vid = 0;
1267     }
1268     return error;
1269 }
1270
1271 /* Returns a network device that has 'in4' as its IP address, if one exists,
1272  * otherwise a null pointer. */
1273 struct netdev *
1274 netdev_find_dev_by_in4(const struct in_addr *in4)
1275 {
1276     struct netdev *netdev;
1277     struct svec dev_list = SVEC_EMPTY_INITIALIZER;
1278     size_t i;
1279
1280     netdev_enumerate(&dev_list);
1281     for (i = 0; i < dev_list.n; i++) {
1282         const char *name = dev_list.names[i];
1283         struct in_addr dev_in4;
1284
1285         if (!netdev_open_default(name, &netdev)
1286             && !netdev_get_in4(netdev, &dev_in4, NULL)
1287             && dev_in4.s_addr == in4->s_addr) {
1288             goto exit;
1289         }
1290         netdev_close(netdev);
1291     }
1292     netdev = NULL;
1293
1294 exit:
1295     svec_destroy(&dev_list);
1296     return netdev;
1297 }
1298 \f
1299 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
1300  * specified 'netdev_class'.
1301  *
1302  * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1303  * very important that 'netdev_dev' only be freed after calling
1304  * the refcount drops to zero.  */
1305 void
1306 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1307                 const struct netdev_class *netdev_class)
1308 {
1309     assert(!shash_find(&netdev_dev_shash, name));
1310
1311     memset(netdev_dev, 0, sizeof *netdev_dev);
1312     netdev_dev->netdev_class = netdev_class;
1313     netdev_dev->name = xstrdup(name);
1314     netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1315 }
1316
1317 /* Undoes the results of initialization.
1318  *
1319  * Normally this function does not need to be called as netdev_close has
1320  * the same effect when the refcount drops to zero.
1321  * However, it may be called by providers due to an error on creation
1322  * that occurs after initialization.  It this case netdev_close() would
1323  * never be called. */
1324 void
1325 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1326 {
1327     char *name = netdev_dev->name;
1328
1329     assert(!netdev_dev->ref_cnt);
1330
1331     shash_delete(&netdev_dev_shash, netdev_dev->node);
1332     update_device_args(netdev_dev, NULL);
1333
1334     if (destroy) {
1335         netdev_dev->netdev_class->destroy(netdev_dev);
1336     }
1337     free(name);
1338 }
1339
1340 /* Returns the class type of 'netdev_dev'.
1341  *
1342  * The caller must not free the returned value. */
1343 const char *
1344 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1345 {
1346     return netdev_dev->netdev_class->type;
1347 }
1348
1349 /* Returns the class associated with 'netdev_dev'. */
1350 const struct netdev_class *
1351 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1352 {
1353     return netdev_dev->netdev_class;
1354 }
1355
1356 /* Returns the name of 'netdev_dev'.
1357  *
1358  * The caller must not free the returned value. */
1359 const char *
1360 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1361 {
1362     return netdev_dev->name;
1363 }
1364
1365 /* Returns the netdev_dev with 'name' or NULL if there is none.
1366  *
1367  * The caller must not free the returned value. */
1368 struct netdev_dev *
1369 netdev_dev_from_name(const char *name)
1370 {
1371     return shash_find_data(&netdev_dev_shash, name);
1372 }
1373
1374 /* Fills 'device_list' with devices that match 'netdev_class'.
1375  *
1376  * The caller is responsible for initializing and destroying 'device_list'
1377  * but the contained netdev_devs must not be freed. */
1378 void
1379 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1380                        struct shash *device_list)
1381 {
1382     struct shash_node *node;
1383     SHASH_FOR_EACH (node, &netdev_dev_shash) {
1384         struct netdev_dev *dev = node->data;
1385
1386         if (dev->netdev_class == netdev_class) {
1387             shash_add(device_list, node->name, node->data);
1388         }
1389     }
1390 }
1391
1392 /* Initializes 'netdev' as a instance of the netdev_dev.
1393  *
1394  * This function adds 'netdev' to a netdev-owned linked list, so it is very
1395  * important that 'netdev' only be freed after calling netdev_close(). */
1396 void
1397 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1398 {
1399     memset(netdev, 0, sizeof *netdev);
1400     netdev->netdev_dev = netdev_dev;
1401     list_push_back(&netdev_list, &netdev->node);
1402 }
1403
1404 /* Undoes the results of initialization.
1405  *
1406  * Normally this function only needs to be called from netdev_close().
1407  * However, it may be called by providers due to an error on opening
1408  * that occurs after initialization.  It this case netdev_close() would
1409  * never be called. */
1410 void
1411 netdev_uninit(struct netdev *netdev, bool close)
1412 {
1413     /* Restore flags that we changed, if any. */
1414     int error = restore_flags(netdev);
1415     list_remove(&netdev->node);
1416     if (error) {
1417         VLOG_WARN("failed to restore network device flags on %s: %s",
1418                   netdev_get_name(netdev), strerror(error));
1419     }
1420
1421     if (close) {
1422         netdev_get_dev(netdev)->netdev_class->close(netdev);
1423     }
1424 }
1425
1426
1427 /* Returns the class type of 'netdev'.
1428  *
1429  * The caller must not free the returned value. */
1430 const char *
1431 netdev_get_type(const struct netdev *netdev)
1432 {
1433     return netdev_get_dev(netdev)->netdev_class->type;
1434 }
1435
1436 struct netdev_dev *
1437 netdev_get_dev(const struct netdev *netdev)
1438 {
1439     return netdev->netdev_dev;
1440 }
1441
1442 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
1443  * notification will consist of calling 'cb', with auxiliary data 'aux'. */
1444 void
1445 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
1446                      void (*cb)(struct netdev_notifier *), void *aux)
1447 {
1448     notifier->netdev = netdev;
1449     notifier->cb = cb;
1450     notifier->aux = aux;
1451 }
1452 \f
1453 /* Tracks changes in the status of a set of network devices. */
1454 struct netdev_monitor {
1455     struct shash polled_netdevs;
1456     struct shash changed_netdevs;
1457 };
1458
1459 /* Creates and returns a new structure for monitor changes in the status of
1460  * network devices. */
1461 struct netdev_monitor *
1462 netdev_monitor_create(void)
1463 {
1464     struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
1465     shash_init(&monitor->polled_netdevs);
1466     shash_init(&monitor->changed_netdevs);
1467     return monitor;
1468 }
1469
1470 /* Destroys 'monitor'. */
1471 void
1472 netdev_monitor_destroy(struct netdev_monitor *monitor)
1473 {
1474     if (monitor) {
1475         struct shash_node *node;
1476
1477         SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
1478             struct netdev_notifier *notifier = node->data;
1479             netdev_get_dev(notifier->netdev)->netdev_class->poll_remove(
1480                     notifier);
1481         }
1482
1483         shash_destroy(&monitor->polled_netdevs);
1484         shash_destroy(&monitor->changed_netdevs);
1485         free(monitor);
1486     }
1487 }
1488
1489 static void
1490 netdev_monitor_cb(struct netdev_notifier *notifier)
1491 {
1492     struct netdev_monitor *monitor = notifier->aux;
1493     const char *name = netdev_get_name(notifier->netdev);
1494     shash_add_once(&monitor->changed_netdevs, name, NULL);
1495 }
1496
1497 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'.  Returns 0 if
1498  * successful, otherwise a positive errno value.
1499  *
1500  * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1501  * it once. */
1502 int
1503 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1504 {
1505     const char *netdev_name = netdev_get_name(netdev);
1506     int error = 0;
1507     if (!shash_find(&monitor->polled_netdevs, netdev_name)
1508             && netdev_get_dev(netdev)->netdev_class->poll_add)
1509     {
1510         struct netdev_notifier *notifier;
1511         error = netdev_get_dev(netdev)->netdev_class->poll_add(netdev,
1512                     netdev_monitor_cb, monitor, &notifier);
1513         if (!error) {
1514             assert(notifier->netdev == netdev);
1515             shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1516         }
1517     }
1518     return error;
1519 }
1520
1521 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'.  (This has
1522  * no effect if 'netdev' is not in the set of devices monitored by
1523  * 'monitor'.) */
1524 void
1525 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1526 {
1527     const char *netdev_name = netdev_get_name(netdev);
1528     struct shash_node *node;
1529
1530     node = shash_find(&monitor->polled_netdevs, netdev_name);
1531     if (node) {
1532         /* Cancel future notifications. */
1533         struct netdev_notifier *notifier = node->data;
1534         netdev_get_dev(netdev)->netdev_class->poll_remove(notifier);
1535         shash_delete(&monitor->polled_netdevs, node);
1536
1537         /* Drop any pending notification. */
1538         node = shash_find(&monitor->changed_netdevs, netdev_name);
1539         if (node) {
1540             shash_delete(&monitor->changed_netdevs, node);
1541         }
1542     }
1543 }
1544
1545 /* Checks for changes to netdevs in the set monitored by 'monitor'.  If any of
1546  * the attributes (Ethernet address, carrier status, speed or peer-advertised
1547  * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1548  * sets '*devnamep' to the name of a device that has changed and returns 0.
1549  * The caller is responsible for freeing '*devnamep' (with free()).
1550  *
1551  * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN. */
1552 int
1553 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1554 {
1555     struct shash_node *node = shash_first(&monitor->changed_netdevs);
1556     if (!node) {
1557         *devnamep = NULL;
1558         return EAGAIN;
1559     } else {
1560         *devnamep = shash_steal(&monitor->changed_netdevs, node);
1561         return 0;
1562     }
1563 }
1564
1565 /* Registers with the poll loop to wake up from the next call to poll_block()
1566  * when netdev_monitor_poll(monitor) would indicate that a device has
1567  * changed. */
1568 void
1569 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1570 {
1571     if (!shash_is_empty(&monitor->changed_netdevs)) {
1572         poll_immediate_wake();
1573     } else {
1574         /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1575          * classes need help. */
1576     }
1577 }
1578 \f
1579 /* Restore the network device flags on 'netdev' to those that were active
1580  * before we changed them.  Returns 0 if successful, otherwise a positive
1581  * errno value.
1582  *
1583  * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1584 static int
1585 restore_flags(struct netdev *netdev)
1586 {
1587     if (netdev->changed_flags) {
1588         enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1589         enum netdev_flags old_flags;
1590         return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1591                                            netdev->changed_flags & ~restore,
1592                                            restore, &old_flags);
1593     }
1594     return 0;
1595 }
1596
1597 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1598  * destroying devices, restoring flags, etc. */
1599 static void
1600 close_all_netdevs(void *aux OVS_UNUSED)
1601 {
1602     struct netdev *netdev, *next;
1603     LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1604         netdev_close(netdev);
1605     }
1606 }