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