lib/netdev.c

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