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