lib/netdev.c

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