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