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