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 static struct shash netdev_classes = SHASH_INITIALIZER(&netdev_classes);
  46
  47 /* All created network devices. */
  48 static struct shash netdev_dev_shash = SHASH_INITIALIZER(&netdev_dev_shash);
  49
  50 /* All open network devices. */
  51 static struct list netdev_list = LIST_INITIALIZER(&netdev_list);
  52
  53 /* This is set pretty low because we probably won't learn anything from the
  54  * additional log messages. */
  55 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
  56
  57 static void close_all_netdevs(void *aux OVS_UNUSED);
  58 static int restore_flags(struct netdev *netdev);
  59 void update_device_args(struct netdev_dev *, const struct shash *args);
  60
  61 static void
  62 netdev_initialize(void)
  63 {
  64     static bool inited;
  65
  66     if (!inited) {
  67         inited = true;
  68
  69         fatal_signal_add_hook(close_all_netdevs, NULL, NULL, true);
  70
  71 #ifdef HAVE_NETLINK
  72         netdev_register_provider(&netdev_linux_class);
  73         netdev_register_provider(&netdev_tap_class);
  74         netdev_vport_register();
  75 #endif
  76     }
  77 }
  78
  79 /* Performs periodic work needed by all the various kinds of netdevs.
  80  *
  81  * If your program opens any netdevs, it must call this function within its
  82  * main poll loop. */
  83 void
  84 netdev_run(void)
  85 {
  86     struct shash_node *node;
  87     SHASH_FOR_EACH(node, &netdev_classes) {
  88         const struct netdev_class *netdev_class = node->data;
  89         if (netdev_class->run) {
  90             netdev_class->run();
  91         }
  92     }
  93 }
  94
  95 /* Arranges for poll_block() to wake up when netdev_run() needs to be called.
  96  *
  97  * If your program opens any netdevs, it must call this function within its
  98  * main poll loop. */
  99 void
 100 netdev_wait(void)
 101 {
 102     struct shash_node *node;
 103     SHASH_FOR_EACH(node, &netdev_classes) {
 104         const struct netdev_class *netdev_class = node->data;
 105         if (netdev_class->wait) {
 106             netdev_class->wait();
 107         }
 108     }
 109 }
 110
 111 /* Initializes and registers a new netdev provider.  After successful
 112  * registration, new netdevs of that type can be opened using netdev_open(). */
 113 int
 114 netdev_register_provider(const struct netdev_class *new_class)
 115 {
 116     if (shash_find(&netdev_classes, new_class->type)) {
 117         VLOG_WARN("attempted to register duplicate netdev provider: %s",
 118                    new_class->type);
 119         return EEXIST;
 120     }
 121
 122     if (new_class->init) {
 123         int error = new_class->init();
 124         if (error) {
 125             VLOG_ERR("failed to initialize %s network device class: %s",
 126                      new_class->type, strerror(error));
 127             return error;
 128         }
 129     }
 130
 131     shash_add(&netdev_classes, new_class->type, new_class);
 132
 133     return 0;
 134 }
 135
 136 /* Unregisters a netdev provider.  'type' must have been previously
 137  * registered and not currently be in use by any netdevs.  After unregistration
 138  * new netdevs of that type cannot be opened using netdev_open(). */
 139 int
 140 netdev_unregister_provider(const char *type)
 141 {
 142     struct shash_node *del_node, *netdev_dev_node;
 143
 144     del_node = shash_find(&netdev_classes, type);
 145     if (!del_node) {
 146         VLOG_WARN("attempted to unregister a netdev provider that is not "
 147                   "registered: %s", type);
 148         return EAFNOSUPPORT;
 149     }
 150
 151     SHASH_FOR_EACH(netdev_dev_node, &netdev_dev_shash) {
 152         struct netdev_dev *netdev_dev = netdev_dev_node->data;
 153         if (!strcmp(netdev_dev->netdev_class->type, type)) {
 154             VLOG_WARN("attempted to unregister in use netdev provider: %s",
 155                       type);
 156             return EBUSY;
 157         }
 158     }
 159
 160     shash_delete(&netdev_classes, del_node);
 161
 162     return 0;
 163 }
 164
 165 /* Clears 'types' and enumerates the types of all currently registered netdev
 166  * providers into it.  The caller must first initialize the svec. */
 167 void
 168 netdev_enumerate_types(struct svec *types)
 169 {
 170     struct shash_node *node;
 171
 172     netdev_initialize();
 173     svec_clear(types);
 174
 175     SHASH_FOR_EACH(node, &netdev_classes) {
 176         const struct netdev_class *netdev_class = node->data;
 177         svec_add(types, netdev_class->type);
 178     }
 179 }
 180
 181 /* Compares 'args' to those used to those used by 'dev'.  Returns true
 182  * if the arguments are the same, false otherwise.  Does not update the
 183  * values stored in 'dev'. */
 184 static bool
 185 compare_device_args(const struct netdev_dev *dev, const struct shash *args)
 186 {
 187     const struct shash_node **new_args;
 188     bool result = true;
 189     int i;
 190
 191     if (shash_count(args) != dev->n_args) {
 192         return false;
 193     }
 194
 195     new_args = shash_sort(args);
 196     for (i = 0; i < dev->n_args; i++) {
 197         if (strcmp(dev->args[i].key, new_args[i]->name) ||
 198             strcmp(dev->args[i].value, new_args[i]->data)) {
 199             result = false;
 200             goto finish;
 201         }
 202     }
 203
 204 finish:
 205     free(new_args);
 206     return result;
 207 }
 208
 209 static int
 210 compare_args(const void *a_, const void *b_)
 211 {
 212     const struct arg *a = a_;
 213     const struct arg *b = b_;
 214     return strcmp(a->key, b->key);
 215 }
 216
 217 void
 218 update_device_args(struct netdev_dev *dev, const struct shash *args)
 219 {
 220     struct shash_node *node;
 221     int i;
 222
 223     if (dev->n_args) {
 224         for (i = 0; i < dev->n_args; i++) {
 225             free(dev->args[i].key);
 226             free(dev->args[i].value);
 227         }
 228
 229         free(dev->args);
 230         dev->n_args = 0;
 231     }
 232
 233     if (!args || shash_is_empty(args)) {
 234         return;
 235     }
 236
 237     dev->n_args = shash_count(args);
 238     dev->args = xmalloc(dev->n_args * sizeof *dev->args);
 239
 240     i = 0;
 241     SHASH_FOR_EACH(node, args) {
 242         dev->args[i].key = xstrdup(node->name);
 243         dev->args[i].value = xstrdup(node->data);
 244         i++;
 245     }
 246
 247     qsort(dev->args, dev->n_args, sizeof *dev->args, compare_args);
 248 }
 249
 250 static int
 251 create_device(struct netdev_options *options, struct netdev_dev **netdev_devp)
 252 {
 253     struct netdev_class *netdev_class;
 254
 255     if (!options->type || strlen(options->type) == 0) {
 256         /* Default to system. */
 257         options->type = "system";
 258     }
 259
 260     netdev_class = shash_find_data(&netdev_classes, options->type);
 261     if (!netdev_class) {
 262         return EAFNOSUPPORT;
 263     }
 264
 265     return netdev_class->create(netdev_class, options->name, options->args,
 266                                 netdev_devp);
 267 }
 268
 269 /* Opens the network device named 'name' (e.g. "eth0") and returns zero if
 270  * successful, otherwise a positive errno value.  On success, sets '*netdevp'
 271  * to the new network device, otherwise to null.
 272  *
 273  * If this is the first time the device has been opened, then create is called
 274  * before opening.  The device is created using the given type and arguments.
 275  *
 276  * 'ethertype' may be a 16-bit Ethernet protocol value in host byte order to
 277  * capture frames of that type received on the device.  It may also be one of
 278  * the 'enum netdev_pseudo_ethertype' values to receive frames in one of those
 279  * categories. */
 280 int
 281 netdev_open(struct netdev_options *options, struct netdev **netdevp)
 282 {
 283     struct shash empty_args = SHASH_INITIALIZER(&empty_args);
 284     struct netdev_dev *netdev_dev;
 285     int error;
 286
 287     *netdevp = NULL;
 288     netdev_initialize();
 289
 290     if (!options->args) {
 291         options->args = &empty_args;
 292     }
 293
 294     netdev_dev = shash_find_data(&netdev_dev_shash, options->name);
 295
 296     if (!netdev_dev) {
 297         error = create_device(options, &netdev_dev);
 298         if (error) {
 299             if (error == EAFNOSUPPORT) {
 300                 VLOG_WARN("could not create netdev %s of unknown type %s",
 301                           options->name, options->type);
 302             }
 303             return error;
 304         }
 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 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
 773  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
 774  * all-zero-bits (in6addr_any).
 775  *
 776  * The following error values have well-defined meanings:
 777  *
 778  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 779  *
 780  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 781  *
 782  * 'in6' may be null, in which case the address itself is not reported. */
 783 int
 784 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
 785 {
 786     struct in6_addr dummy;
 787     int error;
 788
 789     error = (netdev_get_dev(netdev)->netdev_class->get_in6
 790              ? netdev_get_dev(netdev)->netdev_class->get_in6(netdev,
 791                     in6 ? in6 : &dummy)
 792              : EOPNOTSUPP);
 793     if (error && in6) {
 794         memset(in6, 0, sizeof *in6);
 795     }
 796     return error;
 797 }
 798
 799 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
 800  * 'on'.  If 'permanent' is true, the changes will persist; otherwise, they
 801  * will be reverted when 'netdev' is closed or the program exits.  Returns 0 if
 802  * successful, otherwise a positive errno value. */
 803 static int
 804 do_update_flags(struct netdev *netdev, enum netdev_flags off,
 805                 enum netdev_flags on, enum netdev_flags *old_flagsp,
 806                 bool permanent)
 807 {
 808     enum netdev_flags old_flags;
 809     int error;
 810
 811     error = netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
 812                 off & ~on, on, &old_flags);
 813     if (error) {
 814         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
 815                      off || on ? "set" : "get", netdev_get_name(netdev),
 816                      strerror(error));
 817         old_flags = 0;
 818     } else if ((off || on) && !permanent) {
 819         enum netdev_flags new_flags = (old_flags & ~off) | on;
 820         enum netdev_flags changed_flags = old_flags ^ new_flags;
 821         if (changed_flags) {
 822             if (!netdev->changed_flags) {
 823                 netdev->save_flags = old_flags;
 824             }
 825             netdev->changed_flags |= changed_flags;
 826         }
 827     }
 828     if (old_flagsp) {
 829         *old_flagsp = old_flags;
 830     }
 831     return error;
 832 }
 833
 834 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
 835  * Returns 0 if successful, otherwise a positive errno value.  On failure,
 836  * stores 0 into '*flagsp'. */
 837 int
 838 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
 839 {
 840     struct netdev *netdev = (struct netdev *) netdev_;
 841     return do_update_flags(netdev, 0, 0, flagsp, false);
 842 }
 843
 844 /* Sets the flags for 'netdev' to 'flags'.
 845  * If 'permanent' is true, the changes will persist; otherwise, they
 846  * will be reverted when 'netdev' is closed or the program exits.
 847  * Returns 0 if successful, otherwise a positive errno value. */
 848 int
 849 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
 850                  bool permanent)
 851 {
 852     return do_update_flags(netdev, -1, flags, NULL, permanent);
 853 }
 854
 855 /* Turns on the specified 'flags' on 'netdev'.
 856  * If 'permanent' is true, the changes will persist; otherwise, they
 857  * will be reverted when 'netdev' is closed or the program exits.
 858  * Returns 0 if successful, otherwise a positive errno value. */
 859 int
 860 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
 861                      bool permanent)
 862 {
 863     return do_update_flags(netdev, 0, flags, NULL, permanent);
 864 }
 865
 866 /* Turns off the specified 'flags' on 'netdev'.
 867  * If 'permanent' is true, the changes will persist; otherwise, they
 868  * will be reverted when 'netdev' is closed or the program exits.
 869  * Returns 0 if successful, otherwise a positive errno value. */
 870 int
 871 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
 872                       bool permanent)
 873 {
 874     return do_update_flags(netdev, flags, 0, NULL, permanent);
 875 }
 876
 877 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
 878  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
 879  * returns 0.  Otherwise, it returns a positive errno value; in particular,
 880  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
 881 int
 882 netdev_arp_lookup(const struct netdev *netdev,
 883                   uint32_t ip, uint8_t mac[ETH_ADDR_LEN])
 884 {
 885     int error = (netdev_get_dev(netdev)->netdev_class->arp_lookup
 886                  ? netdev_get_dev(netdev)->netdev_class->arp_lookup(netdev,
 887                         ip, mac)
 888                  : EOPNOTSUPP);
 889     if (error) {
 890         memset(mac, 0, ETH_ADDR_LEN);
 891     }
 892     return error;
 893 }
 894
 895 /* Returns true if carrier is active (link light is on) on 'netdev'. */
 896 bool
 897 netdev_get_carrier(const struct netdev *netdev)
 898 {
 899     int error;
 900     enum netdev_flags flags;
 901     bool carrier;
 902
 903     netdev_get_flags(netdev, &flags);
 904     if (!(flags & NETDEV_UP)) {
 905         return false;
 906     }
 907
 908     if (!netdev_get_dev(netdev)->netdev_class->get_carrier) {
 909         return true;
 910     }
 911
 912     error = netdev_get_dev(netdev)->netdev_class->get_carrier(netdev,
 913                                                               &carrier);
 914     if (error) {
 915         VLOG_DBG("%s: failed to get network device carrier status, assuming "
 916                  "down: %s", netdev_get_name(netdev), strerror(error));
 917         carrier = false;
 918     }
 919
 920     return carrier;
 921 }
 922
 923 /* Retrieves current device stats for 'netdev'. */
 924 int
 925 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
 926 {
 927     int error;
 928
 929     COVERAGE_INC(netdev_get_stats);
 930     error = (netdev_get_dev(netdev)->netdev_class->get_stats
 931              ? netdev_get_dev(netdev)->netdev_class->get_stats(netdev, stats)
 932              : EOPNOTSUPP);
 933     if (error) {
 934         memset(stats, 0xff, sizeof *stats);
 935     }
 936     return error;
 937 }
 938
 939 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
 940  * Returns 0 if successful, otherwise a positive errno value.
 941  *
 942  * This will probably fail for most network devices.  Some devices might only
 943  * allow setting their stats to 0. */
 944 int
 945 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
 946 {
 947     return (netdev_get_dev(netdev)->netdev_class->set_stats
 948              ? netdev_get_dev(netdev)->netdev_class->set_stats(netdev, stats)
 949              : EOPNOTSUPP);
 950 }
 951
 952 /* Attempts to set input rate limiting (policing) policy, such that up to
 953  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
 954  * size of 'kbits' kb. */
 955 int
 956 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
 957                     uint32_t kbits_burst)
 958 {
 959     return (netdev_get_dev(netdev)->netdev_class->set_policing
 960             ? netdev_get_dev(netdev)->netdev_class->set_policing(netdev,
 961                     kbits_rate, kbits_burst)
 962             : EOPNOTSUPP);
 963 }
 964
 965 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
 966  * empty if 'netdev' does not support QoS.  Any names added to 'types' should
 967  * be documented as valid for the "type" column in the "QoS" table in
 968  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
 969  *
 970  * Every network device supports disabling QoS with a type of "", but this type
 971  * will not be added to 'types'.
 972  *
 973  * The caller must initialize 'types' (e.g. with svec_init()) before calling
 974  * this function.  The caller is responsible for destroying 'types' (e.g. with
 975  * svec_destroy()) when it is no longer needed.
 976  *
 977  * Returns 0 if successful, otherwise a positive errno value. */
 978 int
 979 netdev_get_qos_types(const struct netdev *netdev, struct svec *types)
 980 {
 981     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
 982     return (class->get_qos_types
 983             ? class->get_qos_types(netdev, types)
 984             : 0);
 985 }
 986
 987 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
 988  * which should be "" or one of the types returned by netdev_get_qos_types()
 989  * for 'netdev'.  Returns 0 if successful, otherwise a positive errno value.
 990  * On success, initializes 'caps' with the QoS capabilities; on failure, clears
 991  * 'caps' to all zeros. */
 992 int
 993 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
 994                             struct netdev_qos_capabilities *caps)
 995 {
 996     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
 997
 998     if (*type) {
 999         int retval = (class->get_qos_capabilities
1000                       ? class->get_qos_capabilities(netdev, type, caps)
1001                       : EOPNOTSUPP);
1002         if (retval) {
1003             memset(caps, 0, sizeof *caps);
1004         }
1005         return retval;
1006     } else {
1007         /* Every netdev supports turning off QoS. */
1008         memset(caps, 0, sizeof *caps);
1009         return 0;
1010     }
1011 }
1012
1013 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1014  * of QoS.  Returns 0 if successful, otherwise a positive errno value.  Stores
1015  * the number of queues (zero on failure) in '*n_queuesp'.
1016  *
1017  * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1018 int
1019 netdev_get_n_queues(const struct netdev *netdev,
1020                     const char *type, unsigned int *n_queuesp)
1021 {
1022     struct netdev_qos_capabilities caps;
1023     int retval;
1024
1025     retval = netdev_get_qos_capabilities(netdev, type, &caps);
1026     *n_queuesp = caps.n_queues;
1027     return retval;
1028 }
1029
1030 /* Queries 'netdev' about its currently configured form of QoS.  If successful,
1031  * stores the name of the current form of QoS into '*typep', stores any details
1032  * of configuration as string key-value pairs in 'details', and returns 0.  On
1033  * failure, sets '*typep' to NULL and returns a positive errno value.
1034  *
1035  * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1036  *
1037  * The caller must initialize 'details' as an empty shash (e.g. with
1038  * shash_init()) before calling this function.  The caller must free 'details',
1039  * including 'data' members, when it is no longer needed (e.g. with
1040  * shash_destroy_free_data()).
1041  *
1042  * The caller must not modify or free '*typep'.
1043  *
1044  * '*typep' will be one of the types returned by netdev_get_qos_types() for
1045  * 'netdev'.  The contents of 'details' should be documented as valid for
1046  * '*typep' in the "other_config" column in the "QoS" table in
1047  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1048 int
1049 netdev_get_qos(const struct netdev *netdev,
1050                const char **typep, struct shash *details)
1051 {
1052     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1053     int retval;
1054
1055     if (class->get_qos) {
1056         retval = class->get_qos(netdev, typep, details);
1057         if (retval) {
1058             *typep = NULL;
1059             shash_clear_free_data(details);
1060         }
1061         return retval;
1062     } else {
1063         /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1064         *typep = "";
1065         return 0;
1066     }
1067 }
1068
1069 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1070  * with details of configuration from 'details'.  Returns 0 if successful,
1071  * otherwise a positive errno value.  On error, the previous QoS configuration
1072  * is retained.
1073  *
1074  * When this function changes the type of QoS (not just 'details'), this also
1075  * resets all queue configuration for 'netdev' to their defaults (which depend
1076  * on the specific type of QoS).  Otherwise, the queue configuration for
1077  * 'netdev' is unchanged.
1078  *
1079  * 'type' should be "" (to disable QoS) or one of the types returned by
1080  * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should be
1081  * documented as valid for the given 'type' in the "other_config" column in the
1082  * "QoS" table in vswitchd/vswitch.xml (which is built as
1083  * ovs-vswitchd.conf.db(8)).
1084  *
1085  * NULL may be specified for 'details' if there are no configuration
1086  * details. */
1087 int
1088 netdev_set_qos(struct netdev *netdev,
1089                const char *type, const struct shash *details)
1090 {
1091     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1092
1093     if (!type) {
1094         type = "";
1095     }
1096
1097     if (class->set_qos) {
1098         if (!details) {
1099             static struct shash empty = SHASH_INITIALIZER(&empty);
1100             details = &empty;
1101         }
1102         return class->set_qos(netdev, type, details);
1103     } else {
1104         return *type ? EOPNOTSUPP : 0;
1105     }
1106 }
1107
1108 /* Queries 'netdev' for information about the queue numbered 'queue_id'.  If
1109  * successful, adds that information as string key-value pairs to 'details'.
1110  * Returns 0 if successful, otherwise a positive errno value.
1111  *
1112  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1113  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1114  *
1115  * The returned contents of 'details' should be documented as valid for the
1116  * given 'type' in the "other_config" column in the "Queue" table in
1117  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1118  *
1119  * The caller must initialize 'details' (e.g. with shash_init()) before calling
1120  * this function.  The caller must free 'details', including 'data' members,
1121  * when it is no longer needed (e.g. with shash_destroy_free_data()). */
1122 int
1123 netdev_get_queue(const struct netdev *netdev,
1124                  unsigned int queue_id, struct shash *details)
1125 {
1126     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1127     int retval;
1128
1129     retval = (class->get_queue
1130               ? class->get_queue(netdev, queue_id, details)
1131               : EOPNOTSUPP);
1132     if (retval) {
1133         shash_clear_free_data(details);
1134     }
1135     return retval;
1136 }
1137
1138 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1139  * string pairs in 'details'.  The contents of 'details' should be documented
1140  * as valid for the given 'type' in the "other_config" column in the "Queue"
1141  * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1142  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1143  * given queue's configuration should be unmodified.
1144  *
1145  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1146  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1147  *
1148  * This function does not modify 'details', and the caller retains ownership of
1149  * it. */
1150 int
1151 netdev_set_queue(struct netdev *netdev,
1152                  unsigned int queue_id, const struct shash *details)
1153 {
1154     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1155     return (class->set_queue
1156             ? class->set_queue(netdev, queue_id, details)
1157             : EOPNOTSUPP);
1158 }
1159
1160 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.  Some kinds
1161  * of QoS may have a fixed set of queues, in which case attempts to delete them
1162  * will fail with EOPNOTSUPP.
1163  *
1164  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1165  * given queue will be unmodified.
1166  *
1167  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1168  * the current form of QoS (e.g. as returned by
1169  * netdev_get_n_queues(netdev)). */
1170 int
1171 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1172 {
1173     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1174     return (class->delete_queue
1175             ? class->delete_queue(netdev, queue_id)
1176             : EOPNOTSUPP);
1177 }
1178
1179 /* Obtains statistics about 'queue_id' on 'netdev'.  On success, returns 0 and
1180  * fills 'stats' with the queue's statistics; individual members of 'stats' may
1181  * be set to all-1-bits if the statistic is unavailable.  On failure, returns a
1182  * positive errno value and fills 'stats' with all-1-bits. */
1183 int
1184 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1185                        struct netdev_queue_stats *stats)
1186 {
1187     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1188     int retval;
1189
1190     retval = (class->get_queue_stats
1191               ? class->get_queue_stats(netdev, queue_id, stats)
1192               : EOPNOTSUPP);
1193     if (retval) {
1194         memset(stats, 0xff, sizeof *stats);
1195     }
1196     return retval;
1197 }
1198
1199 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1200  * its configuration, and the 'aux' specified by the caller.  The order of
1201  * iteration is unspecified, but (when successful) each queue is visited
1202  * exactly once.
1203  *
1204  * Calling this function may be more efficient than calling netdev_get_queue()
1205  * for every queue.
1206  *
1207  * 'cb' must not modify or free the 'details' argument passed in.
1208  *
1209  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1210  * configured queues may not have been included in the iteration. */
1211 int
1212 netdev_dump_queues(const struct netdev *netdev,
1213                    netdev_dump_queues_cb *cb, void *aux)
1214 {
1215     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1216     return (class->dump_queues
1217             ? class->dump_queues(netdev, cb, aux)
1218             : EOPNOTSUPP);
1219 }
1220
1221 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1222  * its statistics, and the 'aux' specified by the caller.  The order of
1223  * iteration is unspecified, but (when successful) each queue is visited
1224  * exactly once.
1225  *
1226  * Calling this function may be more efficient than calling
1227  * netdev_get_queue_stats() for every queue.
1228  *
1229  * 'cb' must not modify or free the statistics passed in.
1230  *
1231  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1232  * configured queues may not have been included in the iteration. */
1233 int
1234 netdev_dump_queue_stats(const struct netdev *netdev,
1235                         netdev_dump_queue_stats_cb *cb, void *aux)
1236 {
1237     const struct netdev_class *class = netdev_get_dev(netdev)->netdev_class;
1238     return (class->dump_queue_stats
1239             ? class->dump_queue_stats(netdev, cb, aux)
1240             : EOPNOTSUPP);
1241 }
1242
1243 /* If 'netdev' is a VLAN network device (e.g. one created with vconfig(8)),
1244  * sets '*vlan_vid' to the VLAN VID associated with that device and returns 0.
1245  * Otherwise returns a errno value (specifically ENOENT if 'netdev_name' is the
1246  * name of a network device that is not a VLAN device) and sets '*vlan_vid' to
1247  * -1. */
1248 int
1249 netdev_get_vlan_vid(const struct netdev *netdev, int *vlan_vid)
1250 {
1251     int error = (netdev_get_dev(netdev)->netdev_class->get_vlan_vid
1252                  ? netdev_get_dev(netdev)->netdev_class->get_vlan_vid(netdev,
1253                         vlan_vid)
1254                  : ENOENT);
1255     if (error) {
1256         *vlan_vid = 0;
1257     }
1258     return error;
1259 }
1260
1261 /* Returns a network device that has 'in4' as its IP address, if one exists,
1262  * otherwise a null pointer. */
1263 struct netdev *
1264 netdev_find_dev_by_in4(const struct in_addr *in4)
1265 {
1266     struct netdev *netdev;
1267     struct svec dev_list = SVEC_EMPTY_INITIALIZER;
1268     size_t i;
1269
1270     netdev_enumerate(&dev_list);
1271     for (i = 0; i < dev_list.n; i++) {
1272         const char *name = dev_list.names[i];
1273         struct in_addr dev_in4;
1274
1275         if (!netdev_open_default(name, &netdev)
1276             && !netdev_get_in4(netdev, &dev_in4, NULL)
1277             && dev_in4.s_addr == in4->s_addr) {
1278             goto exit;
1279         }
1280         netdev_close(netdev);
1281     }
1282     netdev = NULL;
1283
1284 exit:
1285     svec_destroy(&dev_list);
1286     return netdev;
1287 }
1288 \f
1289 /* Initializes 'netdev_dev' as a netdev device named 'name' of the
1290  * specified 'netdev_class'.
1291  *
1292  * This function adds 'netdev_dev' to a netdev-owned shash, so it is
1293  * very important that 'netdev_dev' only be freed after calling
1294  * the refcount drops to zero.  */
1295 void
1296 netdev_dev_init(struct netdev_dev *netdev_dev, const char *name,
1297                 const struct netdev_class *netdev_class)
1298 {
1299     assert(!shash_find(&netdev_dev_shash, name));
1300
1301     memset(netdev_dev, 0, sizeof *netdev_dev);
1302     netdev_dev->netdev_class = netdev_class;
1303     netdev_dev->name = xstrdup(name);
1304     netdev_dev->node = shash_add(&netdev_dev_shash, name, netdev_dev);
1305 }
1306
1307 /* Undoes the results of initialization.
1308  *
1309  * Normally this function does not need to be called as netdev_close has
1310  * the same effect when the refcount drops to zero.
1311  * However, it may be called by providers due to an error on creation
1312  * that occurs after initialization.  It this case netdev_close() would
1313  * never be called. */
1314 void
1315 netdev_dev_uninit(struct netdev_dev *netdev_dev, bool destroy)
1316 {
1317     char *name = netdev_dev->name;
1318
1319     assert(!netdev_dev->ref_cnt);
1320
1321     shash_delete(&netdev_dev_shash, netdev_dev->node);
1322     update_device_args(netdev_dev, NULL);
1323
1324     if (destroy) {
1325         netdev_dev->netdev_class->destroy(netdev_dev);
1326     }
1327     free(name);
1328 }
1329
1330 /* Returns the class type of 'netdev_dev'.
1331  *
1332  * The caller must not free the returned value. */
1333 const char *
1334 netdev_dev_get_type(const struct netdev_dev *netdev_dev)
1335 {
1336     return netdev_dev->netdev_class->type;
1337 }
1338
1339 /* Returns the class associated with 'netdev_dev'. */
1340 const struct netdev_class *
1341 netdev_dev_get_class(const struct netdev_dev *netdev_dev)
1342 {
1343     return netdev_dev->netdev_class;
1344 }
1345
1346 /* Returns the name of 'netdev_dev'.
1347  *
1348  * The caller must not free the returned value. */
1349 const char *
1350 netdev_dev_get_name(const struct netdev_dev *netdev_dev)
1351 {
1352     return netdev_dev->name;
1353 }
1354
1355 /* Returns the netdev_dev with 'name' or NULL if there is none.
1356  *
1357  * The caller must not free the returned value. */
1358 struct netdev_dev *
1359 netdev_dev_from_name(const char *name)
1360 {
1361     return shash_find_data(&netdev_dev_shash, name);
1362 }
1363
1364 /* Fills 'device_list' with devices that match 'netdev_class'.
1365  *
1366  * The caller is responsible for initializing and destroying 'device_list'
1367  * but the contained netdev_devs must not be freed. */
1368 void
1369 netdev_dev_get_devices(const struct netdev_class *netdev_class,
1370                        struct shash *device_list)
1371 {
1372     struct shash_node *node;
1373     SHASH_FOR_EACH (node, &netdev_dev_shash) {
1374         struct netdev_dev *dev = node->data;
1375
1376         if (dev->netdev_class == netdev_class) {
1377             shash_add(device_list, node->name, node->data);
1378         }
1379     }
1380 }
1381
1382 /* Initializes 'netdev' as a instance of the netdev_dev.
1383  *
1384  * This function adds 'netdev' to a netdev-owned linked list, so it is very
1385  * important that 'netdev' only be freed after calling netdev_close(). */
1386 void
1387 netdev_init(struct netdev *netdev, struct netdev_dev *netdev_dev)
1388 {
1389     memset(netdev, 0, sizeof *netdev);
1390     netdev->netdev_dev = netdev_dev;
1391     list_push_back(&netdev_list, &netdev->node);
1392 }
1393
1394 /* Undoes the results of initialization.
1395  *
1396  * Normally this function only needs to be called from netdev_close().
1397  * However, it may be called by providers due to an error on opening
1398  * that occurs after initialization.  It this case netdev_close() would
1399  * never be called. */
1400 void
1401 netdev_uninit(struct netdev *netdev, bool close)
1402 {
1403     /* Restore flags that we changed, if any. */
1404     int error = restore_flags(netdev);
1405     list_remove(&netdev->node);
1406     if (error) {
1407         VLOG_WARN("failed to restore network device flags on %s: %s",
1408                   netdev_get_name(netdev), strerror(error));
1409     }
1410
1411     if (close) {
1412         netdev_get_dev(netdev)->netdev_class->close(netdev);
1413     }
1414 }
1415
1416
1417 /* Returns the class type of 'netdev'.
1418  *
1419  * The caller must not free the returned value. */
1420 const char *
1421 netdev_get_type(const struct netdev *netdev)
1422 {
1423     return netdev_get_dev(netdev)->netdev_class->type;
1424 }
1425
1426 struct netdev_dev *
1427 netdev_get_dev(const struct netdev *netdev)
1428 {
1429     return netdev->netdev_dev;
1430 }
1431
1432 /* Initializes 'notifier' as a netdev notifier for 'netdev', for which
1433  * notification will consist of calling 'cb', with auxiliary data 'aux'. */
1434 void
1435 netdev_notifier_init(struct netdev_notifier *notifier, struct netdev *netdev,
1436                      void (*cb)(struct netdev_notifier *), void *aux)
1437 {
1438     notifier->netdev = netdev;
1439     notifier->cb = cb;
1440     notifier->aux = aux;
1441 }
1442 \f
1443 /* Tracks changes in the status of a set of network devices. */
1444 struct netdev_monitor {
1445     struct shash polled_netdevs;
1446     struct shash changed_netdevs;
1447 };
1448
1449 /* Creates and returns a new structure for monitor changes in the status of
1450  * network devices. */
1451 struct netdev_monitor *
1452 netdev_monitor_create(void)
1453 {
1454     struct netdev_monitor *monitor = xmalloc(sizeof *monitor);
1455     shash_init(&monitor->polled_netdevs);
1456     shash_init(&monitor->changed_netdevs);
1457     return monitor;
1458 }
1459
1460 /* Destroys 'monitor'. */
1461 void
1462 netdev_monitor_destroy(struct netdev_monitor *monitor)
1463 {
1464     if (monitor) {
1465         struct shash_node *node;
1466
1467         SHASH_FOR_EACH (node, &monitor->polled_netdevs) {
1468             struct netdev_notifier *notifier = node->data;
1469             netdev_get_dev(notifier->netdev)->netdev_class->poll_remove(
1470                     notifier);
1471         }
1472
1473         shash_destroy(&monitor->polled_netdevs);
1474         shash_destroy(&monitor->changed_netdevs);
1475         free(monitor);
1476     }
1477 }
1478
1479 static void
1480 netdev_monitor_cb(struct netdev_notifier *notifier)
1481 {
1482     struct netdev_monitor *monitor = notifier->aux;
1483     const char *name = netdev_get_name(notifier->netdev);
1484     shash_add_once(&monitor->changed_netdevs, name, NULL);
1485 }
1486
1487 /* Attempts to add 'netdev' as a netdev monitored by 'monitor'.  Returns 0 if
1488  * successful, otherwise a positive errno value.
1489  *
1490  * Adding a given 'netdev' to a monitor multiple times is equivalent to adding
1491  * it once. */
1492 int
1493 netdev_monitor_add(struct netdev_monitor *monitor, struct netdev *netdev)
1494 {
1495     const char *netdev_name = netdev_get_name(netdev);
1496     int error = 0;
1497     if (!shash_find(&monitor->polled_netdevs, netdev_name)
1498             && netdev_get_dev(netdev)->netdev_class->poll_add)
1499     {
1500         struct netdev_notifier *notifier;
1501         error = netdev_get_dev(netdev)->netdev_class->poll_add(netdev,
1502                     netdev_monitor_cb, monitor, &notifier);
1503         if (!error) {
1504             assert(notifier->netdev == netdev);
1505             shash_add(&monitor->polled_netdevs, netdev_name, notifier);
1506         }
1507     }
1508     return error;
1509 }
1510
1511 /* Removes 'netdev' from the set of netdevs monitored by 'monitor'.  (This has
1512  * no effect if 'netdev' is not in the set of devices monitored by
1513  * 'monitor'.) */
1514 void
1515 netdev_monitor_remove(struct netdev_monitor *monitor, struct netdev *netdev)
1516 {
1517     const char *netdev_name = netdev_get_name(netdev);
1518     struct shash_node *node;
1519
1520     node = shash_find(&monitor->polled_netdevs, netdev_name);
1521     if (node) {
1522         /* Cancel future notifications. */
1523         struct netdev_notifier *notifier = node->data;
1524         netdev_get_dev(netdev)->netdev_class->poll_remove(notifier);
1525         shash_delete(&monitor->polled_netdevs, node);
1526
1527         /* Drop any pending notification. */
1528         node = shash_find(&monitor->changed_netdevs, netdev_name);
1529         if (node) {
1530             shash_delete(&monitor->changed_netdevs, node);
1531         }
1532     }
1533 }
1534
1535 /* Checks for changes to netdevs in the set monitored by 'monitor'.  If any of
1536  * the attributes (Ethernet address, carrier status, speed or peer-advertised
1537  * speed, flags, etc.) of a network device monitored by 'monitor' has changed,
1538  * sets '*devnamep' to the name of a device that has changed and returns 0.
1539  * The caller is responsible for freeing '*devnamep' (with free()).
1540  *
1541  * If no devices have changed, sets '*devnamep' to NULL and returns EAGAIN. */
1542 int
1543 netdev_monitor_poll(struct netdev_monitor *monitor, char **devnamep)
1544 {
1545     struct shash_node *node = shash_first(&monitor->changed_netdevs);
1546     if (!node) {
1547         *devnamep = NULL;
1548         return EAGAIN;
1549     } else {
1550         *devnamep = shash_steal(&monitor->changed_netdevs, node);
1551         return 0;
1552     }
1553 }
1554
1555 /* Registers with the poll loop to wake up from the next call to poll_block()
1556  * when netdev_monitor_poll(monitor) would indicate that a device has
1557  * changed. */
1558 void
1559 netdev_monitor_poll_wait(const struct netdev_monitor *monitor)
1560 {
1561     if (!shash_is_empty(&monitor->changed_netdevs)) {
1562         poll_immediate_wake();
1563     } else {
1564         /* XXX Nothing needed here for netdev_linux, but maybe other netdev
1565          * classes need help. */
1566     }
1567 }
1568 \f
1569 /* Restore the network device flags on 'netdev' to those that were active
1570  * before we changed them.  Returns 0 if successful, otherwise a positive
1571  * errno value.
1572  *
1573  * To avoid reentry, the caller must ensure that fatal signals are blocked. */
1574 static int
1575 restore_flags(struct netdev *netdev)
1576 {
1577     if (netdev->changed_flags) {
1578         enum netdev_flags restore = netdev->save_flags & netdev->changed_flags;
1579         enum netdev_flags old_flags;
1580         return netdev_get_dev(netdev)->netdev_class->update_flags(netdev,
1581                                            netdev->changed_flags & ~restore,
1582                                            restore, &old_flags);
1583     }
1584     return 0;
1585 }
1586
1587 /* Close all netdevs on shutdown so they can do any needed cleanup such as
1588  * destroying devices, restoring flags, etc. */
1589 static void
1590 close_all_netdevs(void *aux OVS_UNUSED)
1591 {
1592     struct netdev *netdev, *next;
1593     LIST_FOR_EACH_SAFE(netdev, next, node, &netdev_list) {
1594         netdev_close(netdev);
1595     }
1596 }