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