lib/netdev.c

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