lib/netdev.c

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