lib/dpif.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 "dpif-provider.h"
  19
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <inttypes.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25
  26 #include "coverage.h"
  27 #include "dpctl.h"
  28 #include "dp-packet.h"
  29 #include "dpif-netdev.h"
  30 #include "openvswitch/dynamic-string.h"
  31 #include "flow.h"
  32 #include "netdev.h"
  33 #include "netlink.h"
  34 #include "odp-execute.h"
  35 #include "odp-util.h"
  36 #include "openvswitch/ofp-print.h"
  37 #include "openvswitch/ofp-util.h"
  38 #include "openvswitch/ofpbuf.h"
  39 #include "packets.h"
  40 #include "poll-loop.h"
  41 #include "route-table.h"
  42 #include "seq.h"
  43 #include "shash.h"
  44 #include "sset.h"
  45 #include "timeval.h"
  46 #include "tnl-neigh-cache.h"
  47 #include "tnl-ports.h"
  48 #include "util.h"
  49 #include "uuid.h"
  50 #include "valgrind.h"
  51 #include "openvswitch/ofp-errors.h"
  52 #include "openvswitch/vlog.h"
  53
  54 VLOG_DEFINE_THIS_MODULE(dpif);
  55
  56 COVERAGE_DEFINE(dpif_destroy);
  57 COVERAGE_DEFINE(dpif_port_add);
  58 COVERAGE_DEFINE(dpif_port_del);
  59 COVERAGE_DEFINE(dpif_flow_flush);
  60 COVERAGE_DEFINE(dpif_flow_get);
  61 COVERAGE_DEFINE(dpif_flow_put);
  62 COVERAGE_DEFINE(dpif_flow_del);
  63 COVERAGE_DEFINE(dpif_execute);
  64 COVERAGE_DEFINE(dpif_purge);
  65 COVERAGE_DEFINE(dpif_execute_with_help);
  66
  67 static const struct dpif_class *base_dpif_classes[] = {
  68 #if defined(__linux__) || defined(_WIN32)
  69     &dpif_netlink_class,
  70 #endif
  71     &dpif_netdev_class,
  72 };
  73
  74 struct registered_dpif_class {
  75     const struct dpif_class *dpif_class;
  76     int refcount;
  77 };
  78 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
  79 static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist);
  80
  81 /* Protects 'dpif_classes', including the refcount, and 'dpif_blacklist'. */
  82 static struct ovs_mutex dpif_mutex = OVS_MUTEX_INITIALIZER;
  83
  84 /* Rate limit for individual messages going to or from the datapath, output at
  85  * DBG level.  This is very high because, if these are enabled, it is because
  86  * we really need to see them. */
  87 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
  88
  89 /* Not really much point in logging many dpif errors. */
  90 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
  91
  92 static void log_flow_message(const struct dpif *dpif, int error,
  93                              const char *operation,
  94                              const struct nlattr *key, size_t key_len,
  95                              const struct nlattr *mask, size_t mask_len,
  96                              const ovs_u128 *ufid,
  97                              const struct dpif_flow_stats *stats,
  98                              const struct nlattr *actions, size_t actions_len);
  99 static void log_operation(const struct dpif *, const char *operation,
 100                           int error);
 101 static bool should_log_flow_message(int error);
 102 static void log_flow_put_message(struct dpif *, const struct dpif_flow_put *,
 103                                  int error);
 104 static void log_flow_del_message(struct dpif *, const struct dpif_flow_del *,
 105                                  int error);
 106 static void log_execute_message(struct dpif *, const struct dpif_execute *,
 107                                 bool subexecute, int error);
 108 static void log_flow_get_message(const struct dpif *,
 109                                  const struct dpif_flow_get *, int error);
 110
 111 /* Incremented whenever tnl route, arp, etc changes. */
 112 struct seq *tnl_conf_seq;
 113
 114 static void
 115 dp_initialize(void)
 116 {
 117     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 118
 119     if (ovsthread_once_start(&once)) {
 120         int i;
 121
 122         tnl_conf_seq = seq_create();
 123         dpctl_unixctl_register();
 124         tnl_port_map_init();
 125         tnl_neigh_cache_init();
 126         route_table_init();
 127
 128         for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
 129             dp_register_provider(base_dpif_classes[i]);
 130         }
 131
 132         ovsthread_once_done(&once);
 133     }
 134 }
 135
 136 static int
 137 dp_register_provider__(const struct dpif_class *new_class)
 138 {
 139     struct registered_dpif_class *registered_class;
 140     int error;
 141
 142     if (sset_contains(&dpif_blacklist, new_class->type)) {
 143         VLOG_DBG("attempted to register blacklisted provider: %s",
 144                  new_class->type);
 145         return EINVAL;
 146     }
 147
 148     if (shash_find(&dpif_classes, new_class->type)) {
 149         VLOG_WARN("attempted to register duplicate datapath provider: %s",
 150                   new_class->type);
 151         return EEXIST;
 152     }
 153
 154     error = new_class->init ? new_class->init() : 0;
 155     if (error) {
 156         VLOG_WARN("failed to initialize %s datapath class: %s",
 157                   new_class->type, ovs_strerror(error));
 158         return error;
 159     }
 160
 161     registered_class = xmalloc(sizeof *registered_class);
 162     registered_class->dpif_class = new_class;
 163     registered_class->refcount = 0;
 164
 165     shash_add(&dpif_classes, new_class->type, registered_class);
 166
 167     return 0;
 168 }
 169
 170 /* Registers a new datapath provider.  After successful registration, new
 171  * datapaths of that type can be opened using dpif_open(). */
 172 int
 173 dp_register_provider(const struct dpif_class *new_class)
 174 {
 175     int error;
 176
 177     ovs_mutex_lock(&dpif_mutex);
 178     error = dp_register_provider__(new_class);
 179     ovs_mutex_unlock(&dpif_mutex);
 180
 181     return error;
 182 }
 183
 184 /* Unregisters a datapath provider.  'type' must have been previously
 185  * registered and not currently be in use by any dpifs.  After unregistration
 186  * new datapaths of that type cannot be opened using dpif_open(). */
 187 static int
 188 dp_unregister_provider__(const char *type)
 189 {
 190     struct shash_node *node;
 191     struct registered_dpif_class *registered_class;
 192
 193     node = shash_find(&dpif_classes, type);
 194     if (!node) {
 195         return EAFNOSUPPORT;
 196     }
 197
 198     registered_class = node->data;
 199     if (registered_class->refcount) {
 200         VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
 201         return EBUSY;
 202     }
 203
 204     shash_delete(&dpif_classes, node);
 205     free(registered_class);
 206
 207     return 0;
 208 }
 209
 210 /* Unregisters a datapath provider.  'type' must have been previously
 211  * registered and not currently be in use by any dpifs.  After unregistration
 212  * new datapaths of that type cannot be opened using dpif_open(). */
 213 int
 214 dp_unregister_provider(const char *type)
 215 {
 216     int error;
 217
 218     dp_initialize();
 219
 220     ovs_mutex_lock(&dpif_mutex);
 221     error = dp_unregister_provider__(type);
 222     ovs_mutex_unlock(&dpif_mutex);
 223
 224     return error;
 225 }
 226
 227 /* Blacklists a provider.  Causes future calls of dp_register_provider() with
 228  * a dpif_class which implements 'type' to fail. */
 229 void
 230 dp_blacklist_provider(const char *type)
 231 {
 232     ovs_mutex_lock(&dpif_mutex);
 233     sset_add(&dpif_blacklist, type);
 234     ovs_mutex_unlock(&dpif_mutex);
 235 }
 236
 237 /* Adds the types of all currently registered datapath providers to 'types'.
 238  * The caller must first initialize the sset. */
 239 void
 240 dp_enumerate_types(struct sset *types)
 241 {
 242     struct shash_node *node;
 243
 244     dp_initialize();
 245
 246     ovs_mutex_lock(&dpif_mutex);
 247     SHASH_FOR_EACH(node, &dpif_classes) {
 248         const struct registered_dpif_class *registered_class = node->data;
 249         sset_add(types, registered_class->dpif_class->type);
 250     }
 251     ovs_mutex_unlock(&dpif_mutex);
 252 }
 253
 254 static void
 255 dp_class_unref(struct registered_dpif_class *rc)
 256 {
 257     ovs_mutex_lock(&dpif_mutex);
 258     ovs_assert(rc->refcount);
 259     rc->refcount--;
 260     ovs_mutex_unlock(&dpif_mutex);
 261 }
 262
 263 static struct registered_dpif_class *
 264 dp_class_lookup(const char *type)
 265 {
 266     struct registered_dpif_class *rc;
 267
 268     ovs_mutex_lock(&dpif_mutex);
 269     rc = shash_find_data(&dpif_classes, type);
 270     if (rc) {
 271         rc->refcount++;
 272     }
 273     ovs_mutex_unlock(&dpif_mutex);
 274
 275     return rc;
 276 }
 277
 278 /* Clears 'names' and enumerates the names of all known created datapaths with
 279  * the given 'type'.  The caller must first initialize the sset.  Returns 0 if
 280  * successful, otherwise a positive errno value.
 281  *
 282  * Some kinds of datapaths might not be practically enumerable.  This is not
 283  * considered an error. */
 284 int
 285 dp_enumerate_names(const char *type, struct sset *names)
 286 {
 287     struct registered_dpif_class *registered_class;
 288     const struct dpif_class *dpif_class;
 289     int error;
 290
 291     dp_initialize();
 292     sset_clear(names);
 293
 294     registered_class = dp_class_lookup(type);
 295     if (!registered_class) {
 296         VLOG_WARN("could not enumerate unknown type: %s", type);
 297         return EAFNOSUPPORT;
 298     }
 299
 300     dpif_class = registered_class->dpif_class;
 301     error = (dpif_class->enumerate
 302              ? dpif_class->enumerate(names, dpif_class)
 303              : 0);
 304     if (error) {
 305         VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
 306                    ovs_strerror(error));
 307     }
 308     dp_class_unref(registered_class);
 309
 310     return error;
 311 }
 312
 313 /* Parses 'datapath_name_', which is of the form [type@]name into its
 314  * component pieces.  'name' and 'type' must be freed by the caller.
 315  *
 316  * The returned 'type' is normalized, as if by dpif_normalize_type(). */
 317 void
 318 dp_parse_name(const char *datapath_name_, char **name, char **type)
 319 {
 320     char *datapath_name = xstrdup(datapath_name_);
 321     char *separator;
 322
 323     separator = strchr(datapath_name, '@');
 324     if (separator) {
 325         *separator = '\0';
 326         *type = datapath_name;
 327         *name = xstrdup(dpif_normalize_type(separator + 1));
 328     } else {
 329         *name = datapath_name;
 330         *type = xstrdup(dpif_normalize_type(NULL));
 331     }
 332 }
 333
 334 static int
 335 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
 336 {
 337     struct dpif *dpif = NULL;
 338     int error;
 339     struct registered_dpif_class *registered_class;
 340
 341     dp_initialize();
 342
 343     type = dpif_normalize_type(type);
 344     registered_class = dp_class_lookup(type);
 345     if (!registered_class) {
 346         VLOG_WARN("could not create datapath %s of unknown type %s", name,
 347                   type);
 348         error = EAFNOSUPPORT;
 349         goto exit;
 350     }
 351
 352     error = registered_class->dpif_class->open(registered_class->dpif_class,
 353                                                name, create, &dpif);
 354     if (!error) {
 355         ovs_assert(dpif->dpif_class == registered_class->dpif_class);
 356     } else {
 357         dp_class_unref(registered_class);
 358     }
 359
 360 exit:
 361     *dpifp = error ? NULL : dpif;
 362     return error;
 363 }
 364
 365 /* Tries to open an existing datapath named 'name' and type 'type'.  Will fail
 366  * if no datapath with 'name' and 'type' exists.  'type' may be either NULL or
 367  * the empty string to specify the default system type.  Returns 0 if
 368  * successful, otherwise a positive errno value.  On success stores a pointer
 369  * to the datapath in '*dpifp', otherwise a null pointer. */
 370 int
 371 dpif_open(const char *name, const char *type, struct dpif **dpifp)
 372 {
 373     return do_open(name, type, false, dpifp);
 374 }
 375
 376 /* Tries to create and open a new datapath with the given 'name' and 'type'.
 377  * 'type' may be either NULL or the empty string to specify the default system
 378  * type.  Will fail if a datapath with 'name' and 'type' already exists.
 379  * Returns 0 if successful, otherwise a positive errno value.  On success
 380  * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
 381 int
 382 dpif_create(const char *name, const char *type, struct dpif **dpifp)
 383 {
 384     return do_open(name, type, true, dpifp);
 385 }
 386
 387 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
 388  * does not exist.  'type' may be either NULL or the empty string to specify
 389  * the default system type.  Returns 0 if successful, otherwise a positive
 390  * errno value. On success stores a pointer to the datapath in '*dpifp',
 391  * otherwise a null pointer. */
 392 int
 393 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
 394 {
 395     int error;
 396
 397     error = dpif_create(name, type, dpifp);
 398     if (error == EEXIST || error == EBUSY) {
 399         error = dpif_open(name, type, dpifp);
 400         if (error) {
 401             VLOG_WARN("datapath %s already exists but cannot be opened: %s",
 402                       name, ovs_strerror(error));
 403         }
 404     } else if (error) {
 405         VLOG_WARN("failed to create datapath %s: %s",
 406                   name, ovs_strerror(error));
 407     }
 408     return error;
 409 }
 410
 411 /* Closes and frees the connection to 'dpif'.  Does not destroy the datapath
 412  * itself; call dpif_delete() first, instead, if that is desirable. */
 413 void
 414 dpif_close(struct dpif *dpif)
 415 {
 416     if (dpif) {
 417         struct registered_dpif_class *rc;
 418
 419         rc = shash_find_data(&dpif_classes, dpif->dpif_class->type);
 420         dpif_uninit(dpif, true);
 421         dp_class_unref(rc);
 422     }
 423 }
 424
 425 /* Performs periodic work needed by 'dpif'. */
 426 bool
 427 dpif_run(struct dpif *dpif)
 428 {
 429     if (dpif->dpif_class->run) {
 430         return dpif->dpif_class->run(dpif);
 431     }
 432     return false;
 433 }
 434
 435 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
 436  * 'dpif'. */
 437 void
 438 dpif_wait(struct dpif *dpif)
 439 {
 440     if (dpif->dpif_class->wait) {
 441         dpif->dpif_class->wait(dpif);
 442     }
 443 }
 444
 445 /* Returns the name of datapath 'dpif' prefixed with the type
 446  * (for use in log messages). */
 447 const char *
 448 dpif_name(const struct dpif *dpif)
 449 {
 450     return dpif->full_name;
 451 }
 452
 453 /* Returns the name of datapath 'dpif' without the type
 454  * (for use in device names). */
 455 const char *
 456 dpif_base_name(const struct dpif *dpif)
 457 {
 458     return dpif->base_name;
 459 }
 460
 461 /* Returns the type of datapath 'dpif'. */
 462 const char *
 463 dpif_type(const struct dpif *dpif)
 464 {
 465     return dpif->dpif_class->type;
 466 }
 467
 468 /* Returns the fully spelled out name for the given datapath 'type'.
 469  *
 470  * Normalized type string can be compared with strcmp().  Unnormalized type
 471  * string might be the same even if they have different spellings. */
 472 const char *
 473 dpif_normalize_type(const char *type)
 474 {
 475     return type && type[0] ? type : "system";
 476 }
 477
 478 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
 479  * ports.  After calling this function, it does not make sense to pass 'dpif'
 480  * to any functions other than dpif_name() or dpif_close(). */
 481 int
 482 dpif_delete(struct dpif *dpif)
 483 {
 484     int error;
 485
 486     COVERAGE_INC(dpif_destroy);
 487
 488     error = dpif->dpif_class->destroy(dpif);
 489     log_operation(dpif, "delete", error);
 490     return error;
 491 }
 492
 493 /* Retrieves statistics for 'dpif' into 'stats'.  Returns 0 if successful,
 494  * otherwise a positive errno value. */
 495 int
 496 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
 497 {
 498     int error = dpif->dpif_class->get_stats(dpif, stats);
 499     if (error) {
 500         memset(stats, 0, sizeof *stats);
 501     }
 502     log_operation(dpif, "get_stats", error);
 503     return error;
 504 }
 505
 506 const char *
 507 dpif_port_open_type(const char *datapath_type, const char *port_type)
 508 {
 509     struct registered_dpif_class *rc;
 510
 511     datapath_type = dpif_normalize_type(datapath_type);
 512
 513     ovs_mutex_lock(&dpif_mutex);
 514     rc = shash_find_data(&dpif_classes, datapath_type);
 515     if (rc && rc->dpif_class->port_open_type) {
 516         port_type = rc->dpif_class->port_open_type(rc->dpif_class, port_type);
 517     }
 518     ovs_mutex_unlock(&dpif_mutex);
 519
 520     return port_type;
 521 }
 522
 523 /* Attempts to add 'netdev' as a port on 'dpif'.  If 'port_nop' is
 524  * non-null and its value is not ODPP_NONE, then attempts to use the
 525  * value as the port number.
 526  *
 527  * If successful, returns 0 and sets '*port_nop' to the new port's port
 528  * number (if 'port_nop' is non-null).  On failure, returns a positive
 529  * errno value and sets '*port_nop' to ODPP_NONE (if 'port_nop' is
 530  * non-null). */
 531 int
 532 dpif_port_add(struct dpif *dpif, struct netdev *netdev, odp_port_t *port_nop)
 533 {
 534     const char *netdev_name = netdev_get_name(netdev);
 535     odp_port_t port_no = ODPP_NONE;
 536     int error;
 537
 538     COVERAGE_INC(dpif_port_add);
 539
 540     if (port_nop) {
 541         port_no = *port_nop;
 542     }
 543
 544     error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
 545     if (!error) {
 546         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu32,
 547                     dpif_name(dpif), netdev_name, port_no);
 548     } else {
 549         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
 550                      dpif_name(dpif), netdev_name, ovs_strerror(error));
 551         port_no = ODPP_NONE;
 552     }
 553     if (port_nop) {
 554         *port_nop = port_no;
 555     }
 556     return error;
 557 }
 558
 559 /* Attempts to remove 'dpif''s port number 'port_no'.  Returns 0 if successful,
 560  * otherwise a positive errno value. */
 561 int
 562 dpif_port_del(struct dpif *dpif, odp_port_t port_no)
 563 {
 564     int error;
 565
 566     COVERAGE_INC(dpif_port_del);
 567
 568     error = dpif->dpif_class->port_del(dpif, port_no);
 569     if (!error) {
 570         VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu32")",
 571                     dpif_name(dpif), port_no);
 572     } else {
 573         log_operation(dpif, "port_del", error);
 574     }
 575     return error;
 576 }
 577
 578 /* Makes a deep copy of 'src' into 'dst'. */
 579 void
 580 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
 581 {
 582     dst->name = xstrdup(src->name);
 583     dst->type = xstrdup(src->type);
 584     dst->port_no = src->port_no;
 585 }
 586
 587 /* Frees memory allocated to members of 'dpif_port'.
 588  *
 589  * Do not call this function on a dpif_port obtained from
 590  * dpif_port_dump_next(): that function retains ownership of the data in the
 591  * dpif_port. */
 592 void
 593 dpif_port_destroy(struct dpif_port *dpif_port)
 594 {
 595     free(dpif_port->name);
 596     free(dpif_port->type);
 597 }
 598
 599 /* Checks if port named 'devname' exists in 'dpif'.  If so, returns
 600  * true; otherwise, returns false. */
 601 bool
 602 dpif_port_exists(const struct dpif *dpif, const char *devname)
 603 {
 604     int error = dpif->dpif_class->port_query_by_name(dpif, devname, NULL);
 605     if (error != 0 && error != ENOENT && error != ENODEV) {
 606         VLOG_WARN_RL(&error_rl, "%s: failed to query port %s: %s",
 607                      dpif_name(dpif), devname, ovs_strerror(error));
 608     }
 609
 610     return !error;
 611 }
 612
 613 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and
 614  * initializes '*port' appropriately; on failure, returns a positive errno
 615  * value.
 616  *
 617  * The caller owns the data in 'port' and must free it with
 618  * dpif_port_destroy() when it is no longer needed. */
 619 int
 620 dpif_port_query_by_number(const struct dpif *dpif, odp_port_t port_no,
 621                           struct dpif_port *port)
 622 {
 623     int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
 624     if (!error) {
 625         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu32" is device %s",
 626                     dpif_name(dpif), port_no, port->name);
 627     } else {
 628         memset(port, 0, sizeof *port);
 629         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu32": %s",
 630                      dpif_name(dpif), port_no, ovs_strerror(error));
 631     }
 632     return error;
 633 }
 634
 635 /* Looks up port named 'devname' in 'dpif'.  On success, returns 0 and
 636  * initializes '*port' appropriately; on failure, returns a positive errno
 637  * value.
 638  *
 639  * The caller owns the data in 'port' and must free it with
 640  * dpif_port_destroy() when it is no longer needed. */
 641 int
 642 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
 643                         struct dpif_port *port)
 644 {
 645     int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
 646     if (!error) {
 647         VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu32,
 648                     dpif_name(dpif), devname, port->port_no);
 649     } else {
 650         memset(port, 0, sizeof *port);
 651
 652         /* For ENOENT or ENODEV we use DBG level because the caller is probably
 653          * interested in whether 'dpif' actually has a port 'devname', so that
 654          * it's not an issue worth logging if it doesn't.  Other errors are
 655          * uncommon and more likely to indicate a real problem. */
 656         VLOG_RL(&error_rl,
 657                 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
 658                 "%s: failed to query port %s: %s",
 659                 dpif_name(dpif), devname, ovs_strerror(error));
 660     }
 661     return error;
 662 }
 663
 664 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE
 665  * actions as the OVS_USERSPACE_ATTR_PID attribute's value, for use in
 666  * flows whose packets arrived on port 'port_no'.  In the case where the
 667  * provider allocates multiple Netlink PIDs to a single port, it may use
 668  * 'hash' to spread load among them.  The caller need not use a particular
 669  * hash function; a 5-tuple hash is suitable.
 670  *
 671  * (The datapath implementation might use some different hash function for
 672  * distributing packets received via flow misses among PIDs.  This means
 673  * that packets received via flow misses might be reordered relative to
 674  * packets received via userspace actions.  This is not ordinarily a
 675  * problem.)
 676  *
 677  * A 'port_no' of ODPP_NONE is a special case: it returns a reserved PID, not
 678  * allocated to any port, that the client may use for special purposes.
 679  *
 680  * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
 681  * the 'dpif''s listen mask.  It is allowed to change when DPIF_UC_ACTION is
 682  * disabled and then re-enabled, so a client that does that must be prepared to
 683  * update all of the flows that it installed that contain
 684  * OVS_ACTION_ATTR_USERSPACE actions. */
 685 uint32_t
 686 dpif_port_get_pid(const struct dpif *dpif, odp_port_t port_no, uint32_t hash)
 687 {
 688     return (dpif->dpif_class->port_get_pid
 689             ? (dpif->dpif_class->port_get_pid)(dpif, port_no, hash)
 690             : 0);
 691 }
 692
 693 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
 694  * the port's name into the 'name_size' bytes in 'name', ensuring that the
 695  * result is null-terminated.  On failure, returns a positive errno value and
 696  * makes 'name' the empty string. */
 697 int
 698 dpif_port_get_name(struct dpif *dpif, odp_port_t port_no,
 699                    char *name, size_t name_size)
 700 {
 701     struct dpif_port port;
 702     int error;
 703
 704     ovs_assert(name_size > 0);
 705
 706     error = dpif_port_query_by_number(dpif, port_no, &port);
 707     if (!error) {
 708         ovs_strlcpy(name, port.name, name_size);
 709         dpif_port_destroy(&port);
 710     } else {
 711         *name = '\0';
 712     }
 713     return error;
 714 }
 715
 716 /* Initializes 'dump' to begin dumping the ports in a dpif.
 717  *
 718  * This function provides no status indication.  An error status for the entire
 719  * dump operation is provided when it is completed by calling
 720  * dpif_port_dump_done().
 721  */
 722 void
 723 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
 724 {
 725     dump->dpif = dpif;
 726     dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
 727     log_operation(dpif, "port_dump_start", dump->error);
 728 }
 729
 730 /* Attempts to retrieve another port from 'dump', which must have been
 731  * initialized with dpif_port_dump_start().  On success, stores a new dpif_port
 732  * into 'port' and returns true.  On failure, returns false.
 733  *
 734  * Failure might indicate an actual error or merely that the last port has been
 735  * dumped.  An error status for the entire dump operation is provided when it
 736  * is completed by calling dpif_port_dump_done().
 737  *
 738  * The dpif owns the data stored in 'port'.  It will remain valid until at
 739  * least the next time 'dump' is passed to dpif_port_dump_next() or
 740  * dpif_port_dump_done(). */
 741 bool
 742 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
 743 {
 744     const struct dpif *dpif = dump->dpif;
 745
 746     if (dump->error) {
 747         return false;
 748     }
 749
 750     dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
 751     if (dump->error == EOF) {
 752         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
 753     } else {
 754         log_operation(dpif, "port_dump_next", dump->error);
 755     }
 756
 757     if (dump->error) {
 758         dpif->dpif_class->port_dump_done(dpif, dump->state);
 759         return false;
 760     }
 761     return true;
 762 }
 763
 764 /* Completes port table dump operation 'dump', which must have been initialized
 765  * with dpif_port_dump_start().  Returns 0 if the dump operation was
 766  * error-free, otherwise a positive errno value describing the problem. */
 767 int
 768 dpif_port_dump_done(struct dpif_port_dump *dump)
 769 {
 770     const struct dpif *dpif = dump->dpif;
 771     if (!dump->error) {
 772         dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
 773         log_operation(dpif, "port_dump_done", dump->error);
 774     }
 775     return dump->error == EOF ? 0 : dump->error;
 776 }
 777
 778 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
 779  * 'dpif' has changed, this function does one of the following:
 780  *
 781  * - Stores the name of the device that was added to or deleted from 'dpif' in
 782  *   '*devnamep' and returns 0.  The caller is responsible for freeing
 783  *   '*devnamep' (with free()) when it no longer needs it.
 784  *
 785  * - Returns ENOBUFS and sets '*devnamep' to NULL.
 786  *
 787  * This function may also return 'false positives', where it returns 0 and
 788  * '*devnamep' names a device that was not actually added or deleted or it
 789  * returns ENOBUFS without any change.
 790  *
 791  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
 792  * return other positive errno values to indicate that something has gone
 793  * wrong. */
 794 int
 795 dpif_port_poll(const struct dpif *dpif, char **devnamep)
 796 {
 797     int error = dpif->dpif_class->port_poll(dpif, devnamep);
 798     if (error) {
 799         *devnamep = NULL;
 800     }
 801     return error;
 802 }
 803
 804 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
 805  * value other than EAGAIN. */
 806 void
 807 dpif_port_poll_wait(const struct dpif *dpif)
 808 {
 809     dpif->dpif_class->port_poll_wait(dpif);
 810 }
 811
 812 /* Extracts the flow stats for a packet.  The 'flow' and 'packet'
 813  * arguments must have been initialized through a call to flow_extract().
 814  * 'used' is stored into stats->used. */
 815 void
 816 dpif_flow_stats_extract(const struct flow *flow, const struct dp_packet *packet,
 817                         long long int used, struct dpif_flow_stats *stats)
 818 {
 819     stats->tcp_flags = ntohs(flow->tcp_flags);
 820     stats->n_bytes = dp_packet_size(packet);
 821     stats->n_packets = 1;
 822     stats->used = used;
 823 }
 824
 825 /* Appends a human-readable representation of 'stats' to 's'. */
 826 void
 827 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
 828 {
 829     ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
 830                   stats->n_packets, stats->n_bytes);
 831     if (stats->used) {
 832         ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
 833     } else {
 834         ds_put_format(s, "never");
 835     }
 836     if (stats->tcp_flags) {
 837         ds_put_cstr(s, ", flags:");
 838         packet_format_tcp_flags(s, stats->tcp_flags);
 839     }
 840 }
 841
 842 /* Places the hash of the 'key_len' bytes starting at 'key' into '*hash'. */
 843 void
 844 dpif_flow_hash(const struct dpif *dpif OVS_UNUSED,
 845                const void *key, size_t key_len, ovs_u128 *hash)
 846 {
 847     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 848     static uint32_t secret;
 849
 850     if (ovsthread_once_start(&once)) {
 851         secret = random_uint32();
 852         ovsthread_once_done(&once);
 853     }
 854     hash_bytes128(key, key_len, secret, hash);
 855     uuid_set_bits_v4((struct uuid *)hash);
 856 }
 857
 858 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
 859  * positive errno value.  */
 860 int
 861 dpif_flow_flush(struct dpif *dpif)
 862 {
 863     int error;
 864
 865     COVERAGE_INC(dpif_flow_flush);
 866
 867     error = dpif->dpif_class->flow_flush(dpif);
 868     log_operation(dpif, "flow_flush", error);
 869     return error;
 870 }
 871
 872 /* Attempts to install 'key' into the datapath, fetches it, then deletes it.
 873  * Returns true if the datapath supported installing 'flow', false otherwise.
 874  */
 875 bool
 876 dpif_probe_feature(struct dpif *dpif, const char *name,
 877                    const struct ofpbuf *key, const ovs_u128 *ufid)
 878 {
 879     struct dpif_flow flow;
 880     struct ofpbuf reply;
 881     uint64_t stub[DPIF_FLOW_BUFSIZE / 8];
 882     bool enable_feature = false;
 883     int error;
 884
 885     /* Use DPIF_FP_MODIFY to cover the case where ovs-vswitchd is killed (and
 886      * restarted) at just the right time such that feature probes from the
 887      * previous run are still present in the datapath. */
 888     error = dpif_flow_put(dpif, DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_PROBE,
 889                           key->data, key->size, NULL, 0, NULL, 0,
 890                           ufid, PMD_ID_NULL, NULL);
 891     if (error) {
 892         if (error != EINVAL) {
 893             VLOG_WARN("%s: %s flow probe failed (%s)",
 894                       dpif_name(dpif), name, ovs_strerror(error));
 895         }
 896         return false;
 897     }
 898
 899     ofpbuf_use_stack(&reply, &stub, sizeof stub);
 900     error = dpif_flow_get(dpif, key->data, key->size, ufid,
 901                           PMD_ID_NULL, &reply, &flow);
 902     if (!error
 903         && (!ufid || (flow.ufid_present
 904                       && ovs_u128_equals(*ufid, flow.ufid)))) {
 905         enable_feature = true;
 906     }
 907
 908     error = dpif_flow_del(dpif, key->data, key->size, ufid,
 909                           PMD_ID_NULL, NULL);
 910     if (error) {
 911         VLOG_WARN("%s: failed to delete %s feature probe flow",
 912                   dpif_name(dpif), name);
 913     }
 914
 915     return enable_feature;
 916 }
 917
 918 /* A dpif_operate() wrapper for performing a single DPIF_OP_FLOW_GET. */
 919 int
 920 dpif_flow_get(struct dpif *dpif,
 921               const struct nlattr *key, size_t key_len, const ovs_u128 *ufid,
 922               const unsigned pmd_id, struct ofpbuf *buf, struct dpif_flow *flow)
 923 {
 924     struct dpif_op *opp;
 925     struct dpif_op op;
 926
 927     op.type = DPIF_OP_FLOW_GET;
 928     op.u.flow_get.key = key;
 929     op.u.flow_get.key_len = key_len;
 930     op.u.flow_get.ufid = ufid;
 931     op.u.flow_get.pmd_id = pmd_id;
 932     op.u.flow_get.buffer = buf;
 933
 934     memset(flow, 0, sizeof *flow);
 935     op.u.flow_get.flow = flow;
 936     op.u.flow_get.flow->key = key;
 937     op.u.flow_get.flow->key_len = key_len;
 938
 939     opp = &op;
 940     dpif_operate(dpif, &opp, 1);
 941
 942     return op.error;
 943 }
 944
 945 /* A dpif_operate() wrapper for performing a single DPIF_OP_FLOW_PUT. */
 946 int
 947 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
 948               const struct nlattr *key, size_t key_len,
 949               const struct nlattr *mask, size_t mask_len,
 950               const struct nlattr *actions, size_t actions_len,
 951               const ovs_u128 *ufid, const unsigned pmd_id,
 952               struct dpif_flow_stats *stats)
 953 {
 954     struct dpif_op *opp;
 955     struct dpif_op op;
 956
 957     op.type = DPIF_OP_FLOW_PUT;
 958     op.u.flow_put.flags = flags;
 959     op.u.flow_put.key = key;
 960     op.u.flow_put.key_len = key_len;
 961     op.u.flow_put.mask = mask;
 962     op.u.flow_put.mask_len = mask_len;
 963     op.u.flow_put.actions = actions;
 964     op.u.flow_put.actions_len = actions_len;
 965     op.u.flow_put.ufid = ufid;
 966     op.u.flow_put.pmd_id = pmd_id;
 967     op.u.flow_put.stats = stats;
 968
 969     opp = &op;
 970     dpif_operate(dpif, &opp, 1);
 971
 972     return op.error;
 973 }
 974
 975 /* A dpif_operate() wrapper for performing a single DPIF_OP_FLOW_DEL. */
 976 int
 977 dpif_flow_del(struct dpif *dpif,
 978               const struct nlattr *key, size_t key_len, const ovs_u128 *ufid,
 979               const unsigned pmd_id, struct dpif_flow_stats *stats)
 980 {
 981     struct dpif_op *opp;
 982     struct dpif_op op;
 983
 984     op.type = DPIF_OP_FLOW_DEL;
 985     op.u.flow_del.key = key;
 986     op.u.flow_del.key_len = key_len;
 987     op.u.flow_del.ufid = ufid;
 988     op.u.flow_del.pmd_id = pmd_id;
 989     op.u.flow_del.stats = stats;
 990     op.u.flow_del.terse = false;
 991
 992     opp = &op;
 993     dpif_operate(dpif, &opp, 1);
 994
 995     return op.error;
 996 }
 997
 998 /* Creates and returns a new 'struct dpif_flow_dump' for iterating through the
 999  * flows in 'dpif'. If 'terse' is true, then only UFID and statistics will
1000  * be returned in the dump. Otherwise, all fields will be returned.
1001  *
1002  * This function always successfully returns a dpif_flow_dump.  Error
1003  * reporting is deferred to dpif_flow_dump_destroy(). */
1004 struct dpif_flow_dump *
1005 dpif_flow_dump_create(const struct dpif *dpif, bool terse)
1006 {
1007     return dpif->dpif_class->flow_dump_create(dpif, terse);
1008 }
1009
1010 /* Destroys 'dump', which must have been created with dpif_flow_dump_create().
1011  * All dpif_flow_dump_thread structures previously created for 'dump' must
1012  * previously have been destroyed.
1013  *
1014  * Returns 0 if the dump operation was error-free, otherwise a positive errno
1015  * value describing the problem. */
1016 int
1017 dpif_flow_dump_destroy(struct dpif_flow_dump *dump)
1018 {
1019     const struct dpif *dpif = dump->dpif;
1020     int error = dpif->dpif_class->flow_dump_destroy(dump);
1021     log_operation(dpif, "flow_dump_destroy", error);
1022     return error == EOF ? 0 : error;
1023 }
1024
1025 /* Returns new thread-local state for use with dpif_flow_dump_next(). */
1026 struct dpif_flow_dump_thread *
1027 dpif_flow_dump_thread_create(struct dpif_flow_dump *dump)
1028 {
1029     return dump->dpif->dpif_class->flow_dump_thread_create(dump);
1030 }
1031
1032 /* Releases 'thread'. */
1033 void
1034 dpif_flow_dump_thread_destroy(struct dpif_flow_dump_thread *thread)
1035 {
1036     thread->dpif->dpif_class->flow_dump_thread_destroy(thread);
1037 }
1038
1039 /* Attempts to retrieve up to 'max_flows' more flows from 'thread'.  Returns 0
1040  * if and only if no flows remained to be retrieved, otherwise a positive
1041  * number reflecting the number of elements in 'flows[]' that were updated.
1042  * The number of flows returned might be less than 'max_flows' because
1043  * fewer than 'max_flows' remained, because this particular datapath does not
1044  * benefit from batching, or because an error occurred partway through
1045  * retrieval.  Thus, the caller should continue calling until a 0 return value,
1046  * even if intermediate return values are less than 'max_flows'.
1047  *
1048  * No error status is immediately provided.  An error status for the entire
1049  * dump operation is provided when it is completed by calling
1050  * dpif_flow_dump_destroy().
1051  *
1052  * All of the data stored into 'flows' is owned by the datapath, not by the
1053  * caller, and the caller must not modify or free it.  The datapath guarantees
1054  * that it remains accessible and unchanged until the first of:
1055  *  - The next call to dpif_flow_dump_next() for 'thread', or
1056  *  - The next rcu quiescent period. */
1057 int
1058 dpif_flow_dump_next(struct dpif_flow_dump_thread *thread,
1059                     struct dpif_flow *flows, int max_flows)
1060 {
1061     struct dpif *dpif = thread->dpif;
1062     int n;
1063
1064     ovs_assert(max_flows > 0);
1065     n = dpif->dpif_class->flow_dump_next(thread, flows, max_flows);
1066     if (n > 0) {
1067         struct dpif_flow *f;
1068
1069         for (f = flows; f < &flows[n] && should_log_flow_message(0); f++) {
1070             log_flow_message(dpif, 0, "flow_dump",
1071                              f->key, f->key_len, f->mask, f->mask_len,
1072                              &f->ufid, &f->stats, f->actions, f->actions_len);
1073         }
1074     } else {
1075         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
1076     }
1077     return n;
1078 }
1079
1080 struct dpif_execute_helper_aux {
1081     struct dpif *dpif;
1082     const struct flow *flow;
1083     int error;
1084 };
1085
1086 /* This is called for actions that need the context of the datapath to be
1087  * meaningful. */
1088 static void
1089 dpif_execute_helper_cb(void *aux_, struct dp_packet_batch *packets_,
1090                        const struct nlattr *action, bool may_steal OVS_UNUSED)
1091 {
1092     struct dpif_execute_helper_aux *aux = aux_;
1093     int type = nl_attr_type(action);
1094     struct dp_packet *packet = packets_->packets[0];
1095     struct dp_packet *trunc_packet = NULL, *orig_packet;
1096
1097     ovs_assert(packets_->count == 1);
1098
1099     switch ((enum ovs_action_attr)type) {
1100     case OVS_ACTION_ATTR_CT:
1101     case OVS_ACTION_ATTR_OUTPUT:
1102     case OVS_ACTION_ATTR_TUNNEL_PUSH:
1103     case OVS_ACTION_ATTR_TUNNEL_POP:
1104     case OVS_ACTION_ATTR_USERSPACE:
1105     case OVS_ACTION_ATTR_RECIRC: {
1106         struct dpif_execute execute;
1107         struct ofpbuf execute_actions;
1108         uint64_t stub[256 / 8];
1109         struct pkt_metadata *md = &packet->md;
1110         bool dst_set, clone = false;
1111         uint32_t cutlen = dp_packet_get_cutlen(packet);
1112
1113         dst_set = flow_tnl_dst_is_set(&md->tunnel);
1114         if (dst_set) {
1115             /* The Linux kernel datapath throws away the tunnel information
1116              * that we supply as metadata.  We have to use a "set" action to
1117              * supply it. */
1118             ofpbuf_use_stub(&execute_actions, stub, sizeof stub);
1119             odp_put_tunnel_action(&md->tunnel, &execute_actions);
1120             ofpbuf_put(&execute_actions, action, NLA_ALIGN(action->nla_len));
1121
1122             execute.actions = execute_actions.data;
1123             execute.actions_len = execute_actions.size;
1124         } else {
1125             execute.actions = action;
1126             execute.actions_len = NLA_ALIGN(action->nla_len);
1127         }
1128
1129         orig_packet = packet;
1130
1131         if (cutlen > 0 && (type == OVS_ACTION_ATTR_OUTPUT ||
1132             type == OVS_ACTION_ATTR_TUNNEL_PUSH ||
1133             type == OVS_ACTION_ATTR_TUNNEL_POP ||
1134             type == OVS_ACTION_ATTR_USERSPACE)) {
1135             if (!may_steal) {
1136                 trunc_packet = dp_packet_clone(packet);
1137                 packet = trunc_packet;
1138                 clone = true;
1139             }
1140
1141             dp_packet_set_size(packet, dp_packet_size(packet) - cutlen);
1142             dp_packet_reset_cutlen(orig_packet);
1143         }
1144
1145         execute.packet = packet;
1146         execute.flow = aux->flow;
1147         execute.needs_help = false;
1148         execute.probe = false;
1149         execute.mtu = 0;
1150         aux->error = dpif_execute(aux->dpif, &execute);
1151         log_execute_message(aux->dpif, &execute, true, aux->error);
1152
1153         if (dst_set) {
1154             ofpbuf_uninit(&execute_actions);
1155         }
1156
1157         if (clone) {
1158             dp_packet_delete(trunc_packet);
1159         }
1160         break;
1161     }
1162
1163     case OVS_ACTION_ATTR_HASH:
1164     case OVS_ACTION_ATTR_PUSH_VLAN:
1165     case OVS_ACTION_ATTR_POP_VLAN:
1166     case OVS_ACTION_ATTR_PUSH_MPLS:
1167     case OVS_ACTION_ATTR_POP_MPLS:
1168     case OVS_ACTION_ATTR_SET:
1169     case OVS_ACTION_ATTR_SET_MASKED:
1170     case OVS_ACTION_ATTR_SAMPLE:
1171     case OVS_ACTION_ATTR_TRUNC:
1172     case OVS_ACTION_ATTR_UNSPEC:
1173     case __OVS_ACTION_ATTR_MAX:
1174         OVS_NOT_REACHED();
1175     }
1176 }
1177
1178 /* Executes 'execute' by performing most of the actions in userspace and
1179  * passing the fully constructed packets to 'dpif' for output and userspace
1180  * actions.
1181  *
1182  * This helps with actions that a given 'dpif' doesn't implement directly. */
1183 static int
1184 dpif_execute_with_help(struct dpif *dpif, struct dpif_execute *execute)
1185 {
1186     struct dpif_execute_helper_aux aux = {dpif, execute->flow, 0};
1187     struct dp_packet_batch pb;
1188
1189     COVERAGE_INC(dpif_execute_with_help);
1190
1191     packet_batch_init_packet(&pb, execute->packet);
1192     odp_execute_actions(&aux, &pb, false, execute->actions,
1193                         execute->actions_len, dpif_execute_helper_cb);
1194     return aux.error;
1195 }
1196
1197 /* Returns true if the datapath needs help executing 'execute'. */
1198 static bool
1199 dpif_execute_needs_help(const struct dpif_execute *execute)
1200 {
1201     return execute->needs_help || nl_attr_oversized(execute->actions_len);
1202 }
1203
1204 /* A dpif_operate() wrapper for performing a single DPIF_OP_EXECUTE. */
1205 int
1206 dpif_execute(struct dpif *dpif, struct dpif_execute *execute)
1207 {
1208     if (execute->actions_len) {
1209         struct dpif_op *opp;
1210         struct dpif_op op;
1211
1212         op.type = DPIF_OP_EXECUTE;
1213         op.u.execute = *execute;
1214
1215         opp = &op;
1216         dpif_operate(dpif, &opp, 1);
1217
1218         return op.error;
1219     } else {
1220         return 0;
1221     }
1222 }
1223
1224 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1225  * which they are specified.  Places each operation's results in the "output"
1226  * members documented in comments, and 0 in the 'error' member on success or a
1227  * positive errno on failure. */
1228 void
1229 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
1230 {
1231     while (n_ops > 0) {
1232         size_t chunk;
1233
1234         /* Count 'chunk', the number of ops that can be executed without
1235          * needing any help.  Ops that need help should be rare, so we
1236          * expect this to ordinarily be 'n_ops', that is, all the ops. */
1237         for (chunk = 0; chunk < n_ops; chunk++) {
1238             struct dpif_op *op = ops[chunk];
1239
1240             if (op->type == DPIF_OP_EXECUTE
1241                 && dpif_execute_needs_help(&op->u.execute)) {
1242                 break;
1243             }
1244         }
1245
1246         if (chunk) {
1247             /* Execute a chunk full of ops that the dpif provider can
1248              * handle itself, without help. */
1249             size_t i;
1250
1251             dpif->dpif_class->operate(dpif, ops, chunk);
1252
1253             for (i = 0; i < chunk; i++) {
1254                 struct dpif_op *op = ops[i];
1255                 int error = op->error;
1256
1257                 switch (op->type) {
1258                 case DPIF_OP_FLOW_PUT: {
1259                     struct dpif_flow_put *put = &op->u.flow_put;
1260
1261                     COVERAGE_INC(dpif_flow_put);
1262                     log_flow_put_message(dpif, put, error);
1263                     if (error && put->stats) {
1264                         memset(put->stats, 0, sizeof *put->stats);
1265                     }
1266                     break;
1267                 }
1268
1269                 case DPIF_OP_FLOW_GET: {
1270                     struct dpif_flow_get *get = &op->u.flow_get;
1271
1272                     COVERAGE_INC(dpif_flow_get);
1273                     if (error) {
1274                         memset(get->flow, 0, sizeof *get->flow);
1275                     }
1276                     log_flow_get_message(dpif, get, error);
1277
1278                     break;
1279                 }
1280
1281                 case DPIF_OP_FLOW_DEL: {
1282                     struct dpif_flow_del *del = &op->u.flow_del;
1283
1284                     COVERAGE_INC(dpif_flow_del);
1285                     log_flow_del_message(dpif, del, error);
1286                     if (error && del->stats) {
1287                         memset(del->stats, 0, sizeof *del->stats);
1288                     }
1289                     break;
1290                 }
1291
1292                 case DPIF_OP_EXECUTE:
1293                     COVERAGE_INC(dpif_execute);
1294                     log_execute_message(dpif, &op->u.execute, false, error);
1295                     break;
1296                 }
1297             }
1298
1299             ops += chunk;
1300             n_ops -= chunk;
1301         } else {
1302             /* Help the dpif provider to execute one op. */
1303             struct dpif_op *op = ops[0];
1304
1305             COVERAGE_INC(dpif_execute);
1306             op->error = dpif_execute_with_help(dpif, &op->u.execute);
1307             ops++;
1308             n_ops--;
1309         }
1310     }
1311 }
1312
1313 /* Returns a string that represents 'type', for use in log messages. */
1314 const char *
1315 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1316 {
1317     switch (type) {
1318     case DPIF_UC_MISS: return "miss";
1319     case DPIF_UC_ACTION: return "action";
1320     case DPIF_N_UC_TYPES: default: return "<unknown>";
1321     }
1322 }
1323
1324 /* Enables or disables receiving packets with dpif_recv() on 'dpif'.  Returns 0
1325  * if successful, otherwise a positive errno value.
1326  *
1327  * Turning packet receive off and then back on may change the Netlink PID
1328  * assignments returned by dpif_port_get_pid().  If the client does this, it
1329  * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1330  * using the new PID assignment. */
1331 int
1332 dpif_recv_set(struct dpif *dpif, bool enable)
1333 {
1334     int error = 0;
1335
1336     if (dpif->dpif_class->recv_set) {
1337         error = dpif->dpif_class->recv_set(dpif, enable);
1338         log_operation(dpif, "recv_set", error);
1339     }
1340     return error;
1341 }
1342
1343 /* Refreshes the poll loops and Netlink sockets associated to each port,
1344  * when the number of upcall handlers (upcall receiving thread) is changed
1345  * to 'n_handlers' and receiving packets for 'dpif' is enabled by
1346  * recv_set().
1347  *
1348  * Since multiple upcall handlers can read upcalls simultaneously from
1349  * 'dpif', each port can have multiple Netlink sockets, one per upcall
1350  * handler.  So, handlers_set() is responsible for the following tasks:
1351  *
1352  *    When receiving upcall is enabled, extends or creates the
1353  *    configuration to support:
1354  *
1355  *        - 'n_handlers' Netlink sockets for each port.
1356  *
1357  *        - 'n_handlers' poll loops, one for each upcall handler.
1358  *
1359  *        - registering the Netlink sockets for the same upcall handler to
1360  *          the corresponding poll loop.
1361  *
1362  * Returns 0 if successful, otherwise a positive errno value. */
1363 int
1364 dpif_handlers_set(struct dpif *dpif, uint32_t n_handlers)
1365 {
1366     int error = 0;
1367
1368     if (dpif->dpif_class->handlers_set) {
1369         error = dpif->dpif_class->handlers_set(dpif, n_handlers);
1370         log_operation(dpif, "handlers_set", error);
1371     }
1372     return error;
1373 }
1374
1375 void
1376 dpif_register_dp_purge_cb(struct dpif *dpif, dp_purge_callback *cb, void *aux)
1377 {
1378     if (dpif->dpif_class->register_dp_purge_cb) {
1379         dpif->dpif_class->register_dp_purge_cb(dpif, cb, aux);
1380     }
1381 }
1382
1383 void
1384 dpif_register_upcall_cb(struct dpif *dpif, upcall_callback *cb, void *aux)
1385 {
1386     if (dpif->dpif_class->register_upcall_cb) {
1387         dpif->dpif_class->register_upcall_cb(dpif, cb, aux);
1388     }
1389 }
1390
1391 void
1392 dpif_enable_upcall(struct dpif *dpif)
1393 {
1394     if (dpif->dpif_class->enable_upcall) {
1395         dpif->dpif_class->enable_upcall(dpif);
1396     }
1397 }
1398
1399 void
1400 dpif_disable_upcall(struct dpif *dpif)
1401 {
1402     if (dpif->dpif_class->disable_upcall) {
1403         dpif->dpif_class->disable_upcall(dpif);
1404     }
1405 }
1406
1407 void
1408 dpif_print_packet(struct dpif *dpif, struct dpif_upcall *upcall)
1409 {
1410     if (!VLOG_DROP_DBG(&dpmsg_rl)) {
1411         struct ds flow;
1412         char *packet;
1413
1414         packet = ofp_packet_to_string(dp_packet_data(&upcall->packet),
1415                                       dp_packet_size(&upcall->packet));
1416
1417         ds_init(&flow);
1418         odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1419
1420         VLOG_DBG("%s: %s upcall:\n%s\n%s",
1421                  dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1422                  ds_cstr(&flow), packet);
1423
1424         ds_destroy(&flow);
1425         free(packet);
1426     }
1427 }
1428
1429 /* If 'dpif' creates its own I/O polling threads, refreshes poll threads
1430  * configuration. */
1431 int
1432 dpif_poll_threads_set(struct dpif *dpif, const char *cmask)
1433 {
1434     int error = 0;
1435
1436     if (dpif->dpif_class->poll_threads_set) {
1437         error = dpif->dpif_class->poll_threads_set(dpif, cmask);
1438         if (error) {
1439             log_operation(dpif, "poll_threads_set", error);
1440         }
1441     }
1442
1443     return error;
1444 }
1445
1446 /* Polls for an upcall from 'dpif' for an upcall handler.  Since there
1447  * there can be multiple poll loops, 'handler_id' is needed as index to
1448  * identify the corresponding poll loop.  If successful, stores the upcall
1449  * into '*upcall', using 'buf' for storage.  Should only be called if
1450  * 'recv_set' has been used to enable receiving packets from 'dpif'.
1451  *
1452  * 'upcall->key' and 'upcall->userdata' point into data in the caller-provided
1453  * 'buf', so their memory cannot be freed separately from 'buf'.
1454  *
1455  * The caller owns the data of 'upcall->packet' and may modify it.  If
1456  * packet's headroom is exhausted as it is manipulated, 'upcall->packet'
1457  * will be reallocated.  This requires the data of 'upcall->packet' to be
1458  * released with ofpbuf_uninit() before 'upcall' is destroyed.  However,
1459  * when an error is returned, the 'upcall->packet' may be uninitialized
1460  * and should not be released.
1461  *
1462  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
1463  * if no upcall is immediately available. */
1464 int
1465 dpif_recv(struct dpif *dpif, uint32_t handler_id, struct dpif_upcall *upcall,
1466           struct ofpbuf *buf)
1467 {
1468     int error = EAGAIN;
1469
1470     if (dpif->dpif_class->recv) {
1471         error = dpif->dpif_class->recv(dpif, handler_id, upcall, buf);
1472         if (!error) {
1473             dpif_print_packet(dpif, upcall);
1474         } else if (error != EAGAIN) {
1475             log_operation(dpif, "recv", error);
1476         }
1477     }
1478     return error;
1479 }
1480
1481 /* Discards all messages that would otherwise be received by dpif_recv() on
1482  * 'dpif'. */
1483 void
1484 dpif_recv_purge(struct dpif *dpif)
1485 {
1486     COVERAGE_INC(dpif_purge);
1487     if (dpif->dpif_class->recv_purge) {
1488         dpif->dpif_class->recv_purge(dpif);
1489     }
1490 }
1491
1492 /* Arranges for the poll loop for an upcall handler to wake up when 'dpif'
1493  * 'dpif' has a message queued to be received with the recv member
1494  * function.  Since there can be multiple poll loops, 'handler_id' is
1495  * needed as index to identify the corresponding poll loop. */
1496 void
1497 dpif_recv_wait(struct dpif *dpif, uint32_t handler_id)
1498 {
1499     if (dpif->dpif_class->recv_wait) {
1500         dpif->dpif_class->recv_wait(dpif, handler_id);
1501     }
1502 }
1503
1504 /*
1505  * Return the datapath version. Caller is responsible for freeing
1506  * the string.
1507  */
1508 char *
1509 dpif_get_dp_version(const struct dpif *dpif)
1510 {
1511     char *version = NULL;
1512
1513     if (dpif->dpif_class->get_datapath_version) {
1514         version = dpif->dpif_class->get_datapath_version();
1515     }
1516
1517     return version;
1518 }
1519
1520 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1521  * and '*engine_id', respectively. */
1522 void
1523 dpif_get_netflow_ids(const struct dpif *dpif,
1524                      uint8_t *engine_type, uint8_t *engine_id)
1525 {
1526     *engine_type = dpif->netflow_engine_type;
1527     *engine_id = dpif->netflow_engine_id;
1528 }
1529
1530 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1531  * value used for setting packet priority.
1532  * On success, returns 0 and stores the priority into '*priority'.
1533  * On failure, returns a positive errno value and stores 0 into '*priority'. */
1534 int
1535 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1536                        uint32_t *priority)
1537 {
1538     int error = (dpif->dpif_class->queue_to_priority
1539                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1540                                                        priority)
1541                  : EOPNOTSUPP);
1542     if (error) {
1543         *priority = 0;
1544     }
1545     log_operation(dpif, "queue_to_priority", error);
1546     return error;
1547 }
1548 \f
1549 void
1550 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1551           const char *name,
1552           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1553 {
1554     dpif->dpif_class = dpif_class;
1555     dpif->base_name = xstrdup(name);
1556     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1557     dpif->netflow_engine_type = netflow_engine_type;
1558     dpif->netflow_engine_id = netflow_engine_id;
1559 }
1560
1561 /* Undoes the results of initialization.
1562  *
1563  * Normally this function only needs to be called from dpif_close().
1564  * However, it may be called by providers due to an error on opening
1565  * that occurs after initialization.  It this case dpif_close() would
1566  * never be called. */
1567 void
1568 dpif_uninit(struct dpif *dpif, bool close)
1569 {
1570     char *base_name = dpif->base_name;
1571     char *full_name = dpif->full_name;
1572
1573     if (close) {
1574         dpif->dpif_class->close(dpif);
1575     }
1576
1577     free(base_name);
1578     free(full_name);
1579 }
1580 \f
1581 static void
1582 log_operation(const struct dpif *dpif, const char *operation, int error)
1583 {
1584     if (!error) {
1585         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1586     } else if (ofperr_is_valid(error)) {
1587         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1588                      dpif_name(dpif), operation, ofperr_get_name(error));
1589     } else {
1590         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1591                      dpif_name(dpif), operation, ovs_strerror(error));
1592     }
1593 }
1594
1595 static enum vlog_level
1596 flow_message_log_level(int error)
1597 {
1598     /* If flows arrive in a batch, userspace may push down multiple
1599      * unique flow definitions that overlap when wildcards are applied.
1600      * Kernels that support flow wildcarding will reject these flows as
1601      * duplicates (EEXIST), so lower the log level to debug for these
1602      * types of messages. */
1603     return (error && error != EEXIST) ? VLL_WARN : VLL_DBG;
1604 }
1605
1606 static bool
1607 should_log_flow_message(int error)
1608 {
1609     return !vlog_should_drop(&this_module, flow_message_log_level(error),
1610                              error ? &error_rl : &dpmsg_rl);
1611 }
1612
1613 static void
1614 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1615                  const struct nlattr *key, size_t key_len,
1616                  const struct nlattr *mask, size_t mask_len,
1617                  const ovs_u128 *ufid, const struct dpif_flow_stats *stats,
1618                  const struct nlattr *actions, size_t actions_len)
1619 {
1620     struct ds ds = DS_EMPTY_INITIALIZER;
1621     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1622     if (error) {
1623         ds_put_cstr(&ds, "failed to ");
1624     }
1625     ds_put_format(&ds, "%s ", operation);
1626     if (error) {
1627         ds_put_format(&ds, "(%s) ", ovs_strerror(error));
1628     }
1629     if (ufid) {
1630         odp_format_ufid(ufid, &ds);
1631         ds_put_cstr(&ds, " ");
1632     }
1633     odp_flow_format(key, key_len, mask, mask_len, NULL, &ds, true);
1634     if (stats) {
1635         ds_put_cstr(&ds, ", ");
1636         dpif_flow_stats_format(stats, &ds);
1637     }
1638     if (actions || actions_len) {
1639         ds_put_cstr(&ds, ", actions:");
1640         format_odp_actions(&ds, actions, actions_len);
1641     }
1642     vlog(&this_module, flow_message_log_level(error), "%s", ds_cstr(&ds));
1643     ds_destroy(&ds);
1644 }
1645
1646 static void
1647 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1648                      int error)
1649 {
1650     if (should_log_flow_message(error) && !(put->flags & DPIF_FP_PROBE)) {
1651         struct ds s;
1652
1653         ds_init(&s);
1654         ds_put_cstr(&s, "put");
1655         if (put->flags & DPIF_FP_CREATE) {
1656             ds_put_cstr(&s, "[create]");
1657         }
1658         if (put->flags & DPIF_FP_MODIFY) {
1659             ds_put_cstr(&s, "[modify]");
1660         }
1661         if (put->flags & DPIF_FP_ZERO_STATS) {
1662             ds_put_cstr(&s, "[zero]");
1663         }
1664         log_flow_message(dpif, error, ds_cstr(&s),
1665                          put->key, put->key_len, put->mask, put->mask_len,
1666                          put->ufid, put->stats, put->actions,
1667                          put->actions_len);
1668         ds_destroy(&s);
1669     }
1670 }
1671
1672 static void
1673 log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del,
1674                      int error)
1675 {
1676     if (should_log_flow_message(error)) {
1677         log_flow_message(dpif, error, "flow_del", del->key, del->key_len,
1678                          NULL, 0, del->ufid, !error ? del->stats : NULL,
1679                          NULL, 0);
1680     }
1681 }
1682
1683 /* Logs that 'execute' was executed on 'dpif' and completed with errno 'error'
1684  * (0 for success).  'subexecute' should be true if the execution is a result
1685  * of breaking down a larger execution that needed help, false otherwise.
1686  *
1687  *
1688  * XXX In theory, the log message could be deceptive because this function is
1689  * called after the dpif_provider's '->execute' function, which is allowed to
1690  * modify execute->packet and execute->md.  In practice, though:
1691  *
1692  *     - dpif-netlink doesn't modify execute->packet or execute->md.
1693  *
1694  *     - dpif-netdev does modify them but it is less likely to have problems
1695  *       because it is built into ovs-vswitchd and cannot have version skew,
1696  *       etc.
1697  *
1698  * It would still be better to avoid the potential problem.  I don't know of a
1699  * good way to do that, though, that isn't expensive. */
1700 static void
1701 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1702                     bool subexecute, int error)
1703 {
1704     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))
1705         && !execute->probe) {
1706         struct ds ds = DS_EMPTY_INITIALIZER;
1707         char *packet;
1708
1709         packet = ofp_packet_to_string(dp_packet_data(execute->packet),
1710                                       dp_packet_size(execute->packet));
1711         ds_put_format(&ds, "%s: %sexecute ",
1712                       dpif_name(dpif),
1713                       (subexecute ? "sub-"
1714                        : dpif_execute_needs_help(execute) ? "super-"
1715                        : ""));
1716         format_odp_actions(&ds, execute->actions, execute->actions_len);
1717         if (error) {
1718             ds_put_format(&ds, " failed (%s)", ovs_strerror(error));
1719         }
1720         ds_put_format(&ds, " on packet %s", packet);
1721         ds_put_format(&ds, " mtu %d", execute->mtu);
1722         vlog(&this_module, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
1723         ds_destroy(&ds);
1724         free(packet);
1725     }
1726 }
1727
1728 static void
1729 log_flow_get_message(const struct dpif *dpif, const struct dpif_flow_get *get,
1730                      int error)
1731 {
1732     if (should_log_flow_message(error)) {
1733         log_flow_message(dpif, error, "flow_get",
1734                          get->key, get->key_len,
1735                          get->flow->mask, get->flow->mask_len,
1736                          get->ufid, &get->flow->stats,
1737                          get->flow->actions, get->flow->actions_len);
1738     }
1739 }
1740
1741 bool
1742 dpif_supports_tnl_push_pop(const struct dpif *dpif)
1743 {
1744     return dpif_is_netdev(dpif);
1745 }