lib/netdev.c

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