lib/netdev.c

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