lib/netdev.c

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