lib/netdev.c

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