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