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