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->data,
 555                                                ofpbuf_tailroom(buffer));
 556     if (retval >= 0) {
 557         COVERAGE_INC(netdev_received);
 558         buffer->size += retval;
 559         if (buffer->size < ETH_TOTAL_MIN) {
 560             ofpbuf_put_zeros(buffer, ETH_TOTAL_MIN - buffer->size);
 561         }
 562         return 0;
 563     } else {
 564         return -retval;
 565     }
 566 }
 567
 568 void
 569 netdev_rx_wait(struct netdev_rx *rx)
 570 {
 571     rx->netdev->netdev_class->rx_wait(rx);
 572 }
 573
 574 int
 575 netdev_rx_drain(struct netdev_rx *rx)
 576 {
 577     return (rx->netdev->netdev_class->rx_drain
 578             ? rx->netdev->netdev_class->rx_drain(rx)
 579             : 0);
 580 }
 581
 582 /* Sends 'buffer' on 'netdev'.  Returns 0 if successful, otherwise a positive
 583  * errno value.  Returns EAGAIN without blocking if the packet cannot be queued
 584  * immediately.  Returns EMSGSIZE if a partial packet was transmitted or if
 585  * the packet is too big or too small to transmit on the device.
 586  *
 587  * The caller retains ownership of 'buffer' in all cases.
 588  *
 589  * The kernel maintains a packet transmission queue, so the caller is not
 590  * expected to do additional queuing of packets.
 591  *
 592  * Some network devices may not implement support for this function.  In such
 593  * cases this function will always return EOPNOTSUPP. */
 594 int
 595 netdev_send(struct netdev *netdev, const struct ofpbuf *buffer)
 596 {
 597     int error;
 598
 599     error = (netdev->netdev_class->send
 600              ? netdev->netdev_class->send(netdev, buffer->data, buffer->size)
 601              : EOPNOTSUPP);
 602     if (!error) {
 603         COVERAGE_INC(netdev_sent);
 604     }
 605     return error;
 606 }
 607
 608 /* Registers with the poll loop to wake up from the next call to poll_block()
 609  * when the packet transmission queue has sufficient room to transmit a packet
 610  * with netdev_send().
 611  *
 612  * The kernel maintains a packet transmission queue, so the client is not
 613  * expected to do additional queuing of packets.  Thus, this function is
 614  * unlikely to ever be used.  It is included for completeness. */
 615 void
 616 netdev_send_wait(struct netdev *netdev)
 617 {
 618     if (netdev->netdev_class->send_wait) {
 619         netdev->netdev_class->send_wait(netdev);
 620     }
 621 }
 622
 623 /* Attempts to set 'netdev''s MAC address to 'mac'.  Returns 0 if successful,
 624  * otherwise a positive errno value. */
 625 int
 626 netdev_set_etheraddr(struct netdev *netdev, const uint8_t mac[ETH_ADDR_LEN])
 627 {
 628     return netdev->netdev_class->set_etheraddr(netdev, mac);
 629 }
 630
 631 /* Retrieves 'netdev''s MAC address.  If successful, returns 0 and copies the
 632  * the MAC address into 'mac'.  On failure, returns a positive errno value and
 633  * clears 'mac' to all-zeros. */
 634 int
 635 netdev_get_etheraddr(const struct netdev *netdev, uint8_t mac[ETH_ADDR_LEN])
 636 {
 637     return netdev->netdev_class->get_etheraddr(netdev, mac);
 638 }
 639
 640 /* Returns the name of the network device that 'netdev' represents,
 641  * e.g. "eth0".  The caller must not modify or free the returned string. */
 642 const char *
 643 netdev_get_name(const struct netdev *netdev)
 644 {
 645     return netdev->name;
 646 }
 647
 648 /* Retrieves the MTU of 'netdev'.  The MTU is the maximum size of transmitted
 649  * (and received) packets, in bytes, not including the hardware header; thus,
 650  * this is typically 1500 bytes for Ethernet devices.
 651  *
 652  * If successful, returns 0 and stores the MTU size in '*mtup'.  Returns
 653  * EOPNOTSUPP if 'netdev' does not have an MTU (as e.g. some tunnels do not).
 654  * On other failure, returns a positive errno value.  On failure, sets '*mtup'
 655  * to 0. */
 656 int
 657 netdev_get_mtu(const struct netdev *netdev, int *mtup)
 658 {
 659     const struct netdev_class *class = netdev->netdev_class;
 660     int error;
 661
 662     error = class->get_mtu ? class->get_mtu(netdev, mtup) : EOPNOTSUPP;
 663     if (error) {
 664         *mtup = 0;
 665         if (error != EOPNOTSUPP) {
 666             VLOG_DBG_RL(&rl, "failed to retrieve MTU for network device %s: "
 667                          "%s", netdev_get_name(netdev), ovs_strerror(error));
 668         }
 669     }
 670     return error;
 671 }
 672
 673 /* Sets the MTU of 'netdev'.  The MTU is the maximum size of transmitted
 674  * (and received) packets, in bytes.
 675  *
 676  * If successful, returns 0.  Returns EOPNOTSUPP if 'netdev' does not have an
 677  * MTU (as e.g. some tunnels do not).  On other failure, returns a positive
 678  * errno value. */
 679 int
 680 netdev_set_mtu(const struct netdev *netdev, int mtu)
 681 {
 682     const struct netdev_class *class = netdev->netdev_class;
 683     int error;
 684
 685     error = class->set_mtu ? class->set_mtu(netdev, mtu) : EOPNOTSUPP;
 686     if (error && error != EOPNOTSUPP) {
 687         VLOG_DBG_RL(&rl, "failed to set MTU for network device %s: %s",
 688                      netdev_get_name(netdev), ovs_strerror(error));
 689     }
 690
 691     return error;
 692 }
 693
 694 /* Returns the ifindex of 'netdev', if successful, as a positive number.  On
 695  * failure, returns a negative errno value.
 696  *
 697  * The desired semantics of the ifindex value are a combination of those
 698  * specified by POSIX for if_nametoindex() and by SNMP for ifIndex.  An ifindex
 699  * value should be unique within a host and remain stable at least until
 700  * reboot.  SNMP says an ifindex "ranges between 1 and the value of ifNumber"
 701  * but many systems do not follow this rule anyhow.
 702  *
 703  * Some network devices may not implement support for this function.  In such
 704  * cases this function will always return -EOPNOTSUPP.
 705  */
 706 int
 707 netdev_get_ifindex(const struct netdev *netdev)
 708 {
 709     int (*get_ifindex)(const struct netdev *);
 710
 711     get_ifindex = netdev->netdev_class->get_ifindex;
 712
 713     return get_ifindex ? get_ifindex(netdev) : -EOPNOTSUPP;
 714 }
 715
 716 /* Stores the features supported by 'netdev' into each of '*current',
 717  * '*advertised', '*supported', and '*peer' that are non-null.  Each value is a
 718  * bitmap of "enum ofp_port_features" bits, in host byte order.  Returns 0 if
 719  * successful, otherwise a positive errno value.  On failure, all of the
 720  * passed-in values are set to 0.
 721  *
 722  * Some network devices may not implement support for this function.  In such
 723  * cases this function will always return EOPNOTSUPP. */
 724 int
 725 netdev_get_features(const struct netdev *netdev,
 726                     enum netdev_features *current,
 727                     enum netdev_features *advertised,
 728                     enum netdev_features *supported,
 729                     enum netdev_features *peer)
 730 {
 731     int (*get_features)(const struct netdev *netdev,
 732                         enum netdev_features *current,
 733                         enum netdev_features *advertised,
 734                         enum netdev_features *supported,
 735                         enum netdev_features *peer);
 736     enum netdev_features dummy[4];
 737     int error;
 738
 739     if (!current) {
 740         current = &dummy[0];
 741     }
 742     if (!advertised) {
 743         advertised = &dummy[1];
 744     }
 745     if (!supported) {
 746         supported = &dummy[2];
 747     }
 748     if (!peer) {
 749         peer = &dummy[3];
 750     }
 751
 752     get_features = netdev->netdev_class->get_features;
 753     error = get_features
 754                     ? get_features(netdev, current, advertised, supported,
 755                                    peer)
 756                     : EOPNOTSUPP;
 757     if (error) {
 758         *current = *advertised = *supported = *peer = 0;
 759     }
 760     return error;
 761 }
 762
 763 /* Returns the maximum speed of a network connection that has the NETDEV_F_*
 764  * bits in 'features', in bits per second.  If no bits that indicate a speed
 765  * are set in 'features', returns 'default_bps'. */
 766 uint64_t
 767 netdev_features_to_bps(enum netdev_features features,
 768                        uint64_t default_bps)
 769 {
 770     enum {
 771         F_1000000MB = NETDEV_F_1TB_FD,
 772         F_100000MB = NETDEV_F_100GB_FD,
 773         F_40000MB = NETDEV_F_40GB_FD,
 774         F_10000MB = NETDEV_F_10GB_FD,
 775         F_1000MB = NETDEV_F_1GB_HD | NETDEV_F_1GB_FD,
 776         F_100MB = NETDEV_F_100MB_HD | NETDEV_F_100MB_FD,
 777         F_10MB = NETDEV_F_10MB_HD | NETDEV_F_10MB_FD
 778     };
 779
 780     return (  features & F_1000000MB ? UINT64_C(1000000000000)
 781             : features & F_100000MB  ? UINT64_C(100000000000)
 782             : features & F_40000MB   ? UINT64_C(40000000000)
 783             : features & F_10000MB   ? UINT64_C(10000000000)
 784             : features & F_1000MB    ? UINT64_C(1000000000)
 785             : features & F_100MB     ? UINT64_C(100000000)
 786             : features & F_10MB      ? UINT64_C(10000000)
 787                                      : default_bps);
 788 }
 789
 790 /* Returns true if any of the NETDEV_F_* bits that indicate a full-duplex link
 791  * are set in 'features', otherwise false. */
 792 bool
 793 netdev_features_is_full_duplex(enum netdev_features features)
 794 {
 795     return (features & (NETDEV_F_10MB_FD | NETDEV_F_100MB_FD | NETDEV_F_1GB_FD
 796                         | NETDEV_F_10GB_FD | NETDEV_F_40GB_FD
 797                         | NETDEV_F_100GB_FD | NETDEV_F_1TB_FD)) != 0;
 798 }
 799
 800 /* Set the features advertised by 'netdev' to 'advertise'.  Returns 0 if
 801  * successful, otherwise a positive errno value. */
 802 int
 803 netdev_set_advertisements(struct netdev *netdev,
 804                           enum netdev_features advertise)
 805 {
 806     return (netdev->netdev_class->set_advertisements
 807             ? netdev->netdev_class->set_advertisements(
 808                     netdev, advertise)
 809             : EOPNOTSUPP);
 810 }
 811
 812 /* If 'netdev' has an assigned IPv4 address, sets '*address' to that address
 813  * and '*netmask' to its netmask and returns 0.  Otherwise, returns a positive
 814  * errno value and sets '*address' to 0 (INADDR_ANY).
 815  *
 816  * The following error values have well-defined meanings:
 817  *
 818  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv4 address.
 819  *
 820  *   - EOPNOTSUPP: No IPv4 network stack attached to 'netdev'.
 821  *
 822  * 'address' or 'netmask' or both may be null, in which case the address or
 823  * netmask is not reported. */
 824 int
 825 netdev_get_in4(const struct netdev *netdev,
 826                struct in_addr *address_, struct in_addr *netmask_)
 827 {
 828     struct in_addr address;
 829     struct in_addr netmask;
 830     int error;
 831
 832     error = (netdev->netdev_class->get_in4
 833              ? netdev->netdev_class->get_in4(netdev,
 834                     &address, &netmask)
 835              : EOPNOTSUPP);
 836     if (address_) {
 837         address_->s_addr = error ? 0 : address.s_addr;
 838     }
 839     if (netmask_) {
 840         netmask_->s_addr = error ? 0 : netmask.s_addr;
 841     }
 842     return error;
 843 }
 844
 845 /* Assigns 'addr' as 'netdev''s IPv4 address and 'mask' as its netmask.  If
 846  * 'addr' is INADDR_ANY, 'netdev''s IPv4 address is cleared.  Returns a
 847  * positive errno value. */
 848 int
 849 netdev_set_in4(struct netdev *netdev, struct in_addr addr, struct in_addr mask)
 850 {
 851     return (netdev->netdev_class->set_in4
 852             ? netdev->netdev_class->set_in4(netdev, addr, mask)
 853             : EOPNOTSUPP);
 854 }
 855
 856 /* Obtains ad IPv4 address from device name and save the address in
 857  * in4.  Returns 0 if successful, otherwise a positive errno value.
 858  */
 859 int
 860 netdev_get_in4_by_name(const char *device_name, struct in_addr *in4)
 861 {
 862     struct netdev *netdev;
 863     int error;
 864
 865     error = netdev_open(device_name, "system", &netdev);
 866     if (error) {
 867         in4->s_addr = htonl(0);
 868         return error;
 869     }
 870
 871     error = netdev_get_in4(netdev, in4, NULL);
 872     netdev_close(netdev);
 873     return error;
 874 }
 875
 876 /* Adds 'router' as a default IP gateway for the TCP/IP stack that corresponds
 877  * to 'netdev'. */
 878 int
 879 netdev_add_router(struct netdev *netdev, struct in_addr router)
 880 {
 881     COVERAGE_INC(netdev_add_router);
 882     return (netdev->netdev_class->add_router
 883             ? netdev->netdev_class->add_router(netdev, router)
 884             : EOPNOTSUPP);
 885 }
 886
 887 /* Looks up the next hop for 'host' for the TCP/IP stack that corresponds to
 888  * 'netdev'.  If a route cannot not be determined, sets '*next_hop' to 0,
 889  * '*netdev_name' to null, and returns a positive errno value.  Otherwise, if a
 890  * next hop is found, stores the next hop gateway's address (0 if 'host' is on
 891  * a directly connected network) in '*next_hop' and a copy of the name of the
 892  * device to reach 'host' in '*netdev_name', and returns 0.  The caller is
 893  * responsible for freeing '*netdev_name' (by calling free()). */
 894 int
 895 netdev_get_next_hop(const struct netdev *netdev,
 896                     const struct in_addr *host, struct in_addr *next_hop,
 897                     char **netdev_name)
 898 {
 899     int error = (netdev->netdev_class->get_next_hop
 900                  ? netdev->netdev_class->get_next_hop(
 901                         host, next_hop, netdev_name)
 902                  : EOPNOTSUPP);
 903     if (error) {
 904         next_hop->s_addr = 0;
 905         *netdev_name = NULL;
 906     }
 907     return error;
 908 }
 909
 910 /* Populates 'smap' with status information.
 911  *
 912  * Populates 'smap' with 'netdev' specific status information.  This
 913  * information may be used to populate the status column of the Interface table
 914  * as defined in ovs-vswitchd.conf.db(5). */
 915 int
 916 netdev_get_status(const struct netdev *netdev, struct smap *smap)
 917 {
 918     return (netdev->netdev_class->get_status
 919             ? netdev->netdev_class->get_status(netdev, smap)
 920             : EOPNOTSUPP);
 921 }
 922
 923 /* If 'netdev' has an assigned IPv6 address, sets '*in6' to that address and
 924  * returns 0.  Otherwise, returns a positive errno value and sets '*in6' to
 925  * all-zero-bits (in6addr_any).
 926  *
 927  * The following error values have well-defined meanings:
 928  *
 929  *   - EADDRNOTAVAIL: 'netdev' has no assigned IPv6 address.
 930  *
 931  *   - EOPNOTSUPP: No IPv6 network stack attached to 'netdev'.
 932  *
 933  * 'in6' may be null, in which case the address itself is not reported. */
 934 int
 935 netdev_get_in6(const struct netdev *netdev, struct in6_addr *in6)
 936 {
 937     struct in6_addr dummy;
 938     int error;
 939
 940     error = (netdev->netdev_class->get_in6
 941              ? netdev->netdev_class->get_in6(netdev,
 942                     in6 ? in6 : &dummy)
 943              : EOPNOTSUPP);
 944     if (error && in6) {
 945         memset(in6, 0, sizeof *in6);
 946     }
 947     return error;
 948 }
 949
 950 /* On 'netdev', turns off the flags in 'off' and then turns on the flags in
 951  * 'on'.  Returns 0 if successful, otherwise a positive errno value. */
 952 static int
 953 do_update_flags(struct netdev *netdev, enum netdev_flags off,
 954                 enum netdev_flags on, enum netdev_flags *old_flagsp,
 955                 struct netdev_saved_flags **sfp)
 956     OVS_EXCLUDED(netdev_mutex)
 957 {
 958     struct netdev_saved_flags *sf = NULL;
 959     enum netdev_flags old_flags;
 960     int error;
 961
 962     error = netdev->netdev_class->update_flags(netdev, off & ~on, on,
 963                                                &old_flags);
 964     if (error) {
 965         VLOG_WARN_RL(&rl, "failed to %s flags for network device %s: %s",
 966                      off || on ? "set" : "get", netdev_get_name(netdev),
 967                      ovs_strerror(error));
 968         old_flags = 0;
 969     } else if ((off || on) && sfp) {
 970         enum netdev_flags new_flags = (old_flags & ~off) | on;
 971         enum netdev_flags changed_flags = old_flags ^ new_flags;
 972         if (changed_flags) {
 973             ovs_mutex_lock(&netdev_mutex);
 974             *sfp = sf = xmalloc(sizeof *sf);
 975             sf->netdev = netdev;
 976             list_push_front(&netdev->saved_flags_list, &sf->node);
 977             sf->saved_flags = changed_flags;
 978             sf->saved_values = changed_flags & new_flags;
 979
 980             netdev->ref_cnt++;
 981             ovs_mutex_unlock(&netdev_mutex);
 982         }
 983     }
 984
 985     if (old_flagsp) {
 986         *old_flagsp = old_flags;
 987     }
 988     if (sfp) {
 989         *sfp = sf;
 990     }
 991
 992     return error;
 993 }
 994
 995 /* Obtains the current flags for 'netdev' and stores them into '*flagsp'.
 996  * Returns 0 if successful, otherwise a positive errno value.  On failure,
 997  * stores 0 into '*flagsp'. */
 998 int
 999 netdev_get_flags(const struct netdev *netdev_, enum netdev_flags *flagsp)
1000 {
1001     struct netdev *netdev = CONST_CAST(struct netdev *, netdev_);
1002     return do_update_flags(netdev, 0, 0, flagsp, NULL);
1003 }
1004
1005 /* Sets the flags for 'netdev' to 'flags'.
1006  * Returns 0 if successful, otherwise a positive errno value. */
1007 int
1008 netdev_set_flags(struct netdev *netdev, enum netdev_flags flags,
1009                  struct netdev_saved_flags **sfp)
1010 {
1011     return do_update_flags(netdev, -1, flags, NULL, sfp);
1012 }
1013
1014 /* Turns on the specified 'flags' on 'netdev':
1015  *
1016  *    - On success, returns 0.  If 'sfp' is nonnull, sets '*sfp' to a newly
1017  *      allocated 'struct netdev_saved_flags *' that may be passed to
1018  *      netdev_restore_flags() to restore the original values of 'flags' on
1019  *      'netdev' (this will happen automatically at program termination if
1020  *      netdev_restore_flags() is never called) , or to NULL if no flags were
1021  *      actually changed.
1022  *
1023  *    - On failure, returns a positive errno value.  If 'sfp' is nonnull, sets
1024  *      '*sfp' to NULL. */
1025 int
1026 netdev_turn_flags_on(struct netdev *netdev, enum netdev_flags flags,
1027                      struct netdev_saved_flags **sfp)
1028 {
1029     return do_update_flags(netdev, 0, flags, NULL, sfp);
1030 }
1031
1032 /* Turns off the specified 'flags' on 'netdev'.  See netdev_turn_flags_on() for
1033  * details of the interface. */
1034 int
1035 netdev_turn_flags_off(struct netdev *netdev, enum netdev_flags flags,
1036                       struct netdev_saved_flags **sfp)
1037 {
1038     return do_update_flags(netdev, flags, 0, NULL, sfp);
1039 }
1040
1041 /* Restores the flags that were saved in 'sf', and destroys 'sf'.
1042  * Does nothing if 'sf' is NULL. */
1043 void
1044 netdev_restore_flags(struct netdev_saved_flags *sf)
1045     OVS_EXCLUDED(netdev_mutex)
1046 {
1047     if (sf) {
1048         struct netdev *netdev = sf->netdev;
1049         enum netdev_flags old_flags;
1050
1051         netdev->netdev_class->update_flags(netdev,
1052                                            sf->saved_flags & sf->saved_values,
1053                                            sf->saved_flags & ~sf->saved_values,
1054                                            &old_flags);
1055
1056         ovs_mutex_lock(&netdev_mutex);
1057         list_remove(&sf->node);
1058         free(sf);
1059         netdev_unref(netdev);
1060     }
1061 }
1062
1063 /* Looks up the ARP table entry for 'ip' on 'netdev'.  If one exists and can be
1064  * successfully retrieved, it stores the corresponding MAC address in 'mac' and
1065  * returns 0.  Otherwise, it returns a positive errno value; in particular,
1066  * ENXIO indicates that there is no ARP table entry for 'ip' on 'netdev'. */
1067 int
1068 netdev_arp_lookup(const struct netdev *netdev,
1069                   ovs_be32 ip, uint8_t mac[ETH_ADDR_LEN])
1070 {
1071     int error = (netdev->netdev_class->arp_lookup
1072                  ? netdev->netdev_class->arp_lookup(netdev, ip, mac)
1073                  : EOPNOTSUPP);
1074     if (error) {
1075         memset(mac, 0, ETH_ADDR_LEN);
1076     }
1077     return error;
1078 }
1079
1080 /* Returns true if carrier is active (link light is on) on 'netdev'. */
1081 bool
1082 netdev_get_carrier(const struct netdev *netdev)
1083 {
1084     int error;
1085     enum netdev_flags flags;
1086     bool carrier;
1087
1088     netdev_get_flags(netdev, &flags);
1089     if (!(flags & NETDEV_UP)) {
1090         return false;
1091     }
1092
1093     if (!netdev->netdev_class->get_carrier) {
1094         return true;
1095     }
1096
1097     error = netdev->netdev_class->get_carrier(netdev, &carrier);
1098     if (error) {
1099         VLOG_DBG("%s: failed to get network device carrier status, assuming "
1100                  "down: %s", netdev_get_name(netdev), ovs_strerror(error));
1101         carrier = false;
1102     }
1103
1104     return carrier;
1105 }
1106
1107 /* Returns the number of times 'netdev''s carrier has changed. */
1108 long long int
1109 netdev_get_carrier_resets(const struct netdev *netdev)
1110 {
1111     return (netdev->netdev_class->get_carrier_resets
1112             ? netdev->netdev_class->get_carrier_resets(netdev)
1113             : 0);
1114 }
1115
1116 /* Attempts to force netdev_get_carrier() to poll 'netdev''s MII registers for
1117  * link status instead of checking 'netdev''s carrier.  'netdev''s MII
1118  * registers will be polled once ever 'interval' milliseconds.  If 'netdev'
1119  * does not support MII, another method may be used as a fallback.  If
1120  * 'interval' is less than or equal to zero, reverts netdev_get_carrier() to
1121  * its normal behavior.
1122  *
1123  * Returns 0 if successful, otherwise a positive errno value. */
1124 int
1125 netdev_set_miimon_interval(struct netdev *netdev, long long int interval)
1126 {
1127     return (netdev->netdev_class->set_miimon_interval
1128             ? netdev->netdev_class->set_miimon_interval(netdev, interval)
1129             : EOPNOTSUPP);
1130 }
1131
1132 /* Retrieves current device stats for 'netdev'. */
1133 int
1134 netdev_get_stats(const struct netdev *netdev, struct netdev_stats *stats)
1135 {
1136     int error;
1137
1138     COVERAGE_INC(netdev_get_stats);
1139     error = (netdev->netdev_class->get_stats
1140              ? netdev->netdev_class->get_stats(netdev, stats)
1141              : EOPNOTSUPP);
1142     if (error) {
1143         memset(stats, 0xff, sizeof *stats);
1144     }
1145     return error;
1146 }
1147
1148 /* Attempts to change the stats for 'netdev' to those provided in 'stats'.
1149  * Returns 0 if successful, otherwise a positive errno value.
1150  *
1151  * This will probably fail for most network devices.  Some devices might only
1152  * allow setting their stats to 0. */
1153 int
1154 netdev_set_stats(struct netdev *netdev, const struct netdev_stats *stats)
1155 {
1156     return (netdev->netdev_class->set_stats
1157              ? netdev->netdev_class->set_stats(netdev, stats)
1158              : EOPNOTSUPP);
1159 }
1160
1161 /* Attempts to set input rate limiting (policing) policy, such that up to
1162  * 'kbits_rate' kbps of traffic is accepted, with a maximum accumulative burst
1163  * size of 'kbits' kb. */
1164 int
1165 netdev_set_policing(struct netdev *netdev, uint32_t kbits_rate,
1166                     uint32_t kbits_burst)
1167 {
1168     return (netdev->netdev_class->set_policing
1169             ? netdev->netdev_class->set_policing(netdev,
1170                     kbits_rate, kbits_burst)
1171             : EOPNOTSUPP);
1172 }
1173
1174 /* Adds to 'types' all of the forms of QoS supported by 'netdev', or leaves it
1175  * empty if 'netdev' does not support QoS.  Any names added to 'types' should
1176  * be documented as valid for the "type" column in the "QoS" table in
1177  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1178  *
1179  * Every network device supports disabling QoS with a type of "", but this type
1180  * will not be added to 'types'.
1181  *
1182  * The caller must initialize 'types' (e.g. with sset_init()) before calling
1183  * this function.  The caller is responsible for destroying 'types' (e.g. with
1184  * sset_destroy()) when it is no longer needed.
1185  *
1186  * Returns 0 if successful, otherwise a positive errno value. */
1187 int
1188 netdev_get_qos_types(const struct netdev *netdev, struct sset *types)
1189 {
1190     const struct netdev_class *class = netdev->netdev_class;
1191     return (class->get_qos_types
1192             ? class->get_qos_types(netdev, types)
1193             : 0);
1194 }
1195
1196 /* Queries 'netdev' for its capabilities regarding the specified 'type' of QoS,
1197  * which should be "" or one of the types returned by netdev_get_qos_types()
1198  * for 'netdev'.  Returns 0 if successful, otherwise a positive errno value.
1199  * On success, initializes 'caps' with the QoS capabilities; on failure, clears
1200  * 'caps' to all zeros. */
1201 int
1202 netdev_get_qos_capabilities(const struct netdev *netdev, const char *type,
1203                             struct netdev_qos_capabilities *caps)
1204 {
1205     const struct netdev_class *class = netdev->netdev_class;
1206
1207     if (*type) {
1208         int retval = (class->get_qos_capabilities
1209                       ? class->get_qos_capabilities(netdev, type, caps)
1210                       : EOPNOTSUPP);
1211         if (retval) {
1212             memset(caps, 0, sizeof *caps);
1213         }
1214         return retval;
1215     } else {
1216         /* Every netdev supports turning off QoS. */
1217         memset(caps, 0, sizeof *caps);
1218         return 0;
1219     }
1220 }
1221
1222 /* Obtains the number of queues supported by 'netdev' for the specified 'type'
1223  * of QoS.  Returns 0 if successful, otherwise a positive errno value.  Stores
1224  * the number of queues (zero on failure) in '*n_queuesp'.
1225  *
1226  * This is just a simple wrapper around netdev_get_qos_capabilities(). */
1227 int
1228 netdev_get_n_queues(const struct netdev *netdev,
1229                     const char *type, unsigned int *n_queuesp)
1230 {
1231     struct netdev_qos_capabilities caps;
1232     int retval;
1233
1234     retval = netdev_get_qos_capabilities(netdev, type, &caps);
1235     *n_queuesp = caps.n_queues;
1236     return retval;
1237 }
1238
1239 /* Queries 'netdev' about its currently configured form of QoS.  If successful,
1240  * stores the name of the current form of QoS into '*typep', stores any details
1241  * of configuration as string key-value pairs in 'details', and returns 0.  On
1242  * failure, sets '*typep' to NULL and returns a positive errno value.
1243  *
1244  * A '*typep' of "" indicates that QoS is currently disabled on 'netdev'.
1245  *
1246  * The caller must initialize 'details' as an empty smap (e.g. with
1247  * smap_init()) before calling this function.  The caller must free 'details'
1248  * when it is no longer needed (e.g. with smap_destroy()).
1249  *
1250  * The caller must not modify or free '*typep'.
1251  *
1252  * '*typep' will be one of the types returned by netdev_get_qos_types() for
1253  * 'netdev'.  The contents of 'details' should be documented as valid for
1254  * '*typep' in the "other_config" column in the "QoS" table in
1255  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)). */
1256 int
1257 netdev_get_qos(const struct netdev *netdev,
1258                const char **typep, struct smap *details)
1259 {
1260     const struct netdev_class *class = netdev->netdev_class;
1261     int retval;
1262
1263     if (class->get_qos) {
1264         retval = class->get_qos(netdev, typep, details);
1265         if (retval) {
1266             *typep = NULL;
1267             smap_clear(details);
1268         }
1269         return retval;
1270     } else {
1271         /* 'netdev' doesn't support QoS, so report that QoS is disabled. */
1272         *typep = "";
1273         return 0;
1274     }
1275 }
1276
1277 /* Attempts to reconfigure QoS on 'netdev', changing the form of QoS to 'type'
1278  * with details of configuration from 'details'.  Returns 0 if successful,
1279  * otherwise a positive errno value.  On error, the previous QoS configuration
1280  * is retained.
1281  *
1282  * When this function changes the type of QoS (not just 'details'), this also
1283  * resets all queue configuration for 'netdev' to their defaults (which depend
1284  * on the specific type of QoS).  Otherwise, the queue configuration for
1285  * 'netdev' is unchanged.
1286  *
1287  * 'type' should be "" (to disable QoS) or one of the types returned by
1288  * netdev_get_qos_types() for 'netdev'.  The contents of 'details' should be
1289  * documented as valid for the given 'type' in the "other_config" column in the
1290  * "QoS" table in vswitchd/vswitch.xml (which is built as
1291  * ovs-vswitchd.conf.db(8)).
1292  *
1293  * NULL may be specified for 'details' if there are no configuration
1294  * details. */
1295 int
1296 netdev_set_qos(struct netdev *netdev,
1297                const char *type, const struct smap *details)
1298 {
1299     const struct netdev_class *class = netdev->netdev_class;
1300
1301     if (!type) {
1302         type = "";
1303     }
1304
1305     if (class->set_qos) {
1306         if (!details) {
1307             static const struct smap empty = SMAP_INITIALIZER(&empty);
1308             details = &empty;
1309         }
1310         return class->set_qos(netdev, type, details);
1311     } else {
1312         return *type ? EOPNOTSUPP : 0;
1313     }
1314 }
1315
1316 /* Queries 'netdev' for information about the queue numbered 'queue_id'.  If
1317  * successful, adds that information as string key-value pairs to 'details'.
1318  * Returns 0 if successful, otherwise a positive errno value.
1319  *
1320  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1321  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1322  *
1323  * The returned contents of 'details' should be documented as valid for the
1324  * given 'type' in the "other_config" column in the "Queue" table in
1325  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1326  *
1327  * The caller must initialize 'details' (e.g. with smap_init()) before calling
1328  * this function.  The caller must free 'details' when it is no longer needed
1329  * (e.g. with smap_destroy()). */
1330 int
1331 netdev_get_queue(const struct netdev *netdev,
1332                  unsigned int queue_id, struct smap *details)
1333 {
1334     const struct netdev_class *class = netdev->netdev_class;
1335     int retval;
1336
1337     retval = (class->get_queue
1338               ? class->get_queue(netdev, queue_id, details)
1339               : EOPNOTSUPP);
1340     if (retval) {
1341         smap_clear(details);
1342     }
1343     return retval;
1344 }
1345
1346 /* Configures the queue numbered 'queue_id' on 'netdev' with the key-value
1347  * string pairs in 'details'.  The contents of 'details' should be documented
1348  * as valid for the given 'type' in the "other_config" column in the "Queue"
1349  * table in vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1350  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1351  * given queue's configuration should be unmodified.
1352  *
1353  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1354  * the current form of QoS (e.g. as returned by netdev_get_n_queues(netdev)).
1355  *
1356  * This function does not modify 'details', and the caller retains ownership of
1357  * it. */
1358 int
1359 netdev_set_queue(struct netdev *netdev,
1360                  unsigned int queue_id, const struct smap *details)
1361 {
1362     const struct netdev_class *class = netdev->netdev_class;
1363     return (class->set_queue
1364             ? class->set_queue(netdev, queue_id, details)
1365             : EOPNOTSUPP);
1366 }
1367
1368 /* Attempts to delete the queue numbered 'queue_id' from 'netdev'.  Some kinds
1369  * of QoS may have a fixed set of queues, in which case attempts to delete them
1370  * will fail with EOPNOTSUPP.
1371  *
1372  * Returns 0 if successful, otherwise a positive errno value.  On failure, the
1373  * given queue will be unmodified.
1374  *
1375  * 'queue_id' must be less than the number of queues supported by 'netdev' for
1376  * the current form of QoS (e.g. as returned by
1377  * netdev_get_n_queues(netdev)). */
1378 int
1379 netdev_delete_queue(struct netdev *netdev, unsigned int queue_id)
1380 {
1381     const struct netdev_class *class = netdev->netdev_class;
1382     return (class->delete_queue
1383             ? class->delete_queue(netdev, queue_id)
1384             : EOPNOTSUPP);
1385 }
1386
1387 /* Obtains statistics about 'queue_id' on 'netdev'.  On success, returns 0 and
1388  * fills 'stats' with the queue's statistics; individual members of 'stats' may
1389  * be set to all-1-bits if the statistic is unavailable.  On failure, returns a
1390  * positive errno value and fills 'stats' with values indicating unsupported
1391  * statistics. */
1392 int
1393 netdev_get_queue_stats(const struct netdev *netdev, unsigned int queue_id,
1394                        struct netdev_queue_stats *stats)
1395 {
1396     const struct netdev_class *class = netdev->netdev_class;
1397     int retval;
1398
1399     retval = (class->get_queue_stats
1400               ? class->get_queue_stats(netdev, queue_id, stats)
1401               : EOPNOTSUPP);
1402     if (retval) {
1403         stats->tx_bytes = UINT64_MAX;
1404         stats->tx_packets = UINT64_MAX;
1405         stats->tx_errors = UINT64_MAX;
1406         stats->created = LLONG_MIN;
1407     }
1408     return retval;
1409 }
1410
1411 /* Initializes 'dump' to begin dumping the queues in a netdev.
1412  *
1413  * This function provides no status indication.  An error status for the entire
1414  * dump operation is provided when it is completed by calling
1415  * netdev_queue_dump_done().
1416  */
1417 void
1418 netdev_queue_dump_start(struct netdev_queue_dump *dump,
1419                         const struct netdev *netdev)
1420 {
1421     dump->netdev = netdev_ref(netdev);
1422     if (netdev->netdev_class->queue_dump_start) {
1423         dump->error = netdev->netdev_class->queue_dump_start(netdev,
1424                                                              &dump->state);
1425     } else {
1426         dump->error = EOPNOTSUPP;
1427     }
1428 }
1429
1430 /* Attempts to retrieve another queue from 'dump', which must have been
1431  * initialized with netdev_queue_dump_start().  On success, stores a new queue
1432  * ID into '*queue_id', fills 'details' with configuration details for the
1433  * queue, and returns true.  On failure, returns false.
1434  *
1435  * Queues are not necessarily dumped in increasing order of queue ID (or any
1436  * other predictable order).
1437  *
1438  * Failure might indicate an actual error or merely that the last queue has
1439  * been dumped.  An error status for the entire dump operation is provided when
1440  * it is completed by calling netdev_queue_dump_done().
1441  *
1442  * The returned contents of 'details' should be documented as valid for the
1443  * given 'type' in the "other_config" column in the "Queue" table in
1444  * vswitchd/vswitch.xml (which is built as ovs-vswitchd.conf.db(8)).
1445  *
1446  * The caller must initialize 'details' (e.g. with smap_init()) before calling
1447  * this function.  This function will clear and replace its contents.  The
1448  * caller must free 'details' when it is no longer needed (e.g. with
1449  * smap_destroy()). */
1450 bool
1451 netdev_queue_dump_next(struct netdev_queue_dump *dump,
1452                        unsigned int *queue_id, struct smap *details)
1453 {
1454     const struct netdev *netdev = dump->netdev;
1455
1456     if (dump->error) {
1457         return false;
1458     }
1459
1460     dump->error = netdev->netdev_class->queue_dump_next(netdev, dump->state,
1461                                                         queue_id, details);
1462
1463     if (dump->error) {
1464         netdev->netdev_class->queue_dump_done(netdev, dump->state);
1465         return false;
1466     }
1467     return true;
1468 }
1469
1470 /* Completes queue table dump operation 'dump', which must have been
1471  * initialized with netdev_queue_dump_start().  Returns 0 if the dump operation
1472  * was error-free, otherwise a positive errno value describing the problem. */
1473 int
1474 netdev_queue_dump_done(struct netdev_queue_dump *dump)
1475 {
1476     const struct netdev *netdev = dump->netdev;
1477     if (!dump->error && netdev->netdev_class->queue_dump_done) {
1478         dump->error = netdev->netdev_class->queue_dump_done(netdev,
1479                                                             dump->state);
1480     }
1481     netdev_close(dump->netdev);
1482     return dump->error == EOF ? 0 : dump->error;
1483 }
1484
1485 /* Iterates over all of 'netdev''s queues, calling 'cb' with the queue's ID,
1486  * its statistics, and the 'aux' specified by the caller.  The order of
1487  * iteration is unspecified, but (when successful) each queue is visited
1488  * exactly once.
1489  *
1490  * Calling this function may be more efficient than calling
1491  * netdev_get_queue_stats() for every queue.
1492  *
1493  * 'cb' must not modify or free the statistics passed in.
1494  *
1495  * Returns 0 if successful, otherwise a positive errno value.  On error, some
1496  * configured queues may not have been included in the iteration. */
1497 int
1498 netdev_dump_queue_stats(const struct netdev *netdev,
1499                         netdev_dump_queue_stats_cb *cb, void *aux)
1500 {
1501     const struct netdev_class *class = netdev->netdev_class;
1502     return (class->dump_queue_stats
1503             ? class->dump_queue_stats(netdev, cb, aux)
1504             : EOPNOTSUPP);
1505 }
1506
1507 \f
1508 /* Returns the class type of 'netdev'.
1509  *
1510  * The caller must not free the returned value. */
1511 const char *
1512 netdev_get_type(const struct netdev *netdev)
1513 {
1514     return netdev->netdev_class->type;
1515 }
1516
1517 /* Returns the class associated with 'netdev'. */
1518 const struct netdev_class *
1519 netdev_get_class(const struct netdev *netdev)
1520 {
1521     return netdev->netdev_class;
1522 }
1523
1524 /* Returns the netdev with 'name' or NULL if there is none.
1525  *
1526  * The caller must free the returned netdev with netdev_close(). */
1527 struct netdev *
1528 netdev_from_name(const char *name)
1529     OVS_EXCLUDED(netdev_mutex)
1530 {
1531     struct netdev *netdev;
1532
1533     ovs_mutex_lock(&netdev_mutex);
1534     netdev = shash_find_data(&netdev_shash, name);
1535     if (netdev) {
1536         netdev->ref_cnt++;
1537     }
1538     ovs_mutex_unlock(&netdev_mutex);
1539
1540     return netdev;
1541 }
1542
1543 /* Fills 'device_list' with devices that match 'netdev_class'.
1544  *
1545  * The caller is responsible for initializing and destroying 'device_list' and
1546  * must close each device on the list. */
1547 void
1548 netdev_get_devices(const struct netdev_class *netdev_class,
1549                    struct shash *device_list)
1550     OVS_EXCLUDED(netdev_mutex)
1551 {
1552     struct shash_node *node;
1553
1554     ovs_mutex_lock(&netdev_mutex);
1555     SHASH_FOR_EACH (node, &netdev_shash) {
1556         struct netdev *dev = node->data;
1557
1558         if (dev->netdev_class == netdev_class) {
1559             dev->ref_cnt++;
1560             shash_add(device_list, node->name, node->data);
1561         }
1562     }
1563     ovs_mutex_unlock(&netdev_mutex);
1564 }
1565
1566 const char *
1567 netdev_get_type_from_name(const char *name)
1568 {
1569     struct netdev *dev = netdev_from_name(name);
1570     const char *type = dev ? netdev_get_type(dev) : NULL;
1571     netdev_close(dev);
1572     return type;
1573 }
1574 \f
1575 struct netdev *
1576 netdev_rx_get_netdev(const struct netdev_rx *rx)
1577 {
1578     ovs_assert(rx->netdev->ref_cnt > 0);
1579     return rx->netdev;
1580 }
1581
1582 const char *
1583 netdev_rx_get_name(const struct netdev_rx *rx)
1584 {
1585     return netdev_get_name(netdev_rx_get_netdev(rx));
1586 }
1587
1588 static void
1589 restore_all_flags(void *aux OVS_UNUSED)
1590 {
1591     struct shash_node *node;
1592
1593     SHASH_FOR_EACH (node, &netdev_shash) {
1594         struct netdev *netdev = node->data;
1595         const struct netdev_saved_flags *sf;
1596         enum netdev_flags saved_values;
1597         enum netdev_flags saved_flags;
1598
1599         saved_values = saved_flags = 0;
1600         LIST_FOR_EACH (sf, node, &netdev->saved_flags_list) {
1601             saved_flags |= sf->saved_flags;
1602             saved_values &= ~sf->saved_flags;
1603             saved_values |= sf->saved_flags & sf->saved_values;
1604         }
1605         if (saved_flags) {
1606             enum netdev_flags old_flags;
1607
1608             netdev->netdev_class->update_flags(netdev,
1609                                                saved_flags & saved_values,
1610                                                saved_flags & ~saved_values,
1611                                                &old_flags);
1612         }
1613     }
1614 }