lib/netdev.c

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