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