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