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