lib/netdev.c

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