lib/netdev.c

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