lib/dpif.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 <assert.h>
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <inttypes.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "coverage.h"
  28 #include "dynamic-string.h"
  29 #include "flow.h"
  30 #include "netdev.h"
  31 #include "netlink.h"
  32 #include "odp-util.h"
  33 #include "ofp-errors.h"
  34 #include "ofp-print.h"
  35 #include "ofp-util.h"
  36 #include "ofpbuf.h"
  37 #include "packets.h"
  38 #include "poll-loop.h"
  39 #include "shash.h"
  40 #include "sset.h"
  41 #include "timeval.h"
  42 #include "util.h"
  43 #include "valgrind.h"
  44 #include "vlog.h"
  45
  46 VLOG_DEFINE_THIS_MODULE(dpif);
  47
  48 COVERAGE_DEFINE(dpif_destroy);
  49 COVERAGE_DEFINE(dpif_port_add);
  50 COVERAGE_DEFINE(dpif_port_del);
  51 COVERAGE_DEFINE(dpif_flow_flush);
  52 COVERAGE_DEFINE(dpif_flow_get);
  53 COVERAGE_DEFINE(dpif_flow_put);
  54 COVERAGE_DEFINE(dpif_flow_del);
  55 COVERAGE_DEFINE(dpif_flow_query_list);
  56 COVERAGE_DEFINE(dpif_flow_query_list_n);
  57 COVERAGE_DEFINE(dpif_execute);
  58 COVERAGE_DEFINE(dpif_purge);
  59
  60 static const struct dpif_class *base_dpif_classes[] = {
  61 #ifdef LINUX_DATAPATH
  62     &dpif_linux_class,
  63 #endif
  64     &dpif_netdev_class,
  65 };
  66
  67 struct registered_dpif_class {
  68     const struct dpif_class *dpif_class;
  69     int refcount;
  70 };
  71 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
  72 static struct sset dpif_blacklist = SSET_INITIALIZER(&dpif_blacklist);
  73
  74 /* Rate limit for individual messages going to or from the datapath, output at
  75  * DBG level.  This is very high because, if these are enabled, it is because
  76  * we really need to see them. */
  77 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
  78
  79 /* Not really much point in logging many dpif errors. */
  80 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
  81
  82 static void log_flow_message(const struct dpif *dpif, int error,
  83                              const char *operation,
  84                              const struct nlattr *key, size_t key_len,
  85                              const struct dpif_flow_stats *stats,
  86                              const struct nlattr *actions, size_t actions_len);
  87 static void log_operation(const struct dpif *, const char *operation,
  88                           int error);
  89 static bool should_log_flow_message(int error);
  90 static void log_flow_put_message(struct dpif *, const struct dpif_flow_put *,
  91                                  int error);
  92 static void log_flow_del_message(struct dpif *, const struct dpif_flow_del *,
  93                                  int error);
  94 static void log_execute_message(struct dpif *, const struct dpif_execute *,
  95                                 int error);
  96
  97 static void
  98 dp_initialize(void)
  99 {
 100     static int status = -1;
 101
 102     if (status < 0) {
 103         int i;
 104
 105         status = 0;
 106         for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
 107             dp_register_provider(base_dpif_classes[i]);
 108         }
 109     }
 110 }
 111
 112 /* Registers a new datapath provider.  After successful registration, new
 113  * datapaths of that type can be opened using dpif_open(). */
 114 int
 115 dp_register_provider(const struct dpif_class *new_class)
 116 {
 117     struct registered_dpif_class *registered_class;
 118
 119     if (sset_contains(&dpif_blacklist, new_class->type)) {
 120         VLOG_DBG("attempted to register blacklisted provider: %s",
 121                  new_class->type);
 122         return EINVAL;
 123     }
 124
 125     if (shash_find(&dpif_classes, new_class->type)) {
 126         VLOG_WARN("attempted to register duplicate datapath provider: %s",
 127                   new_class->type);
 128         return EEXIST;
 129     }
 130
 131     registered_class = xmalloc(sizeof *registered_class);
 132     registered_class->dpif_class = new_class;
 133     registered_class->refcount = 0;
 134
 135     shash_add(&dpif_classes, new_class->type, registered_class);
 136
 137     return 0;
 138 }
 139
 140 /* Unregisters a datapath provider.  'type' must have been previously
 141  * registered and not currently be in use by any dpifs.  After unregistration
 142  * new datapaths of that type cannot be opened using dpif_open(). */
 143 int
 144 dp_unregister_provider(const char *type)
 145 {
 146     struct shash_node *node;
 147     struct registered_dpif_class *registered_class;
 148
 149     node = shash_find(&dpif_classes, type);
 150     if (!node) {
 151         VLOG_WARN("attempted to unregister a datapath provider that is not "
 152                   "registered: %s", type);
 153         return EAFNOSUPPORT;
 154     }
 155
 156     registered_class = node->data;
 157     if (registered_class->refcount) {
 158         VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
 159         return EBUSY;
 160     }
 161
 162     shash_delete(&dpif_classes, node);
 163     free(registered_class);
 164
 165     return 0;
 166 }
 167
 168 /* Blacklists a provider.  Causes future calls of dp_register_provider() with
 169  * a dpif_class which implements 'type' to fail. */
 170 void
 171 dp_blacklist_provider(const char *type)
 172 {
 173     sset_add(&dpif_blacklist, type);
 174 }
 175
 176 /* Clears 'types' and enumerates the types of all currently registered datapath
 177  * providers into it.  The caller must first initialize the sset. */
 178 void
 179 dp_enumerate_types(struct sset *types)
 180 {
 181     struct shash_node *node;
 182
 183     dp_initialize();
 184     sset_clear(types);
 185
 186     SHASH_FOR_EACH(node, &dpif_classes) {
 187         const struct registered_dpif_class *registered_class = node->data;
 188         sset_add(types, registered_class->dpif_class->type);
 189     }
 190 }
 191
 192 /* Clears 'names' and enumerates the names of all known created datapaths with
 193  * the given 'type'.  The caller must first initialize the sset.  Returns 0 if
 194  * successful, otherwise a positive errno value.
 195  *
 196  * Some kinds of datapaths might not be practically enumerable.  This is not
 197  * considered an error. */
 198 int
 199 dp_enumerate_names(const char *type, struct sset *names)
 200 {
 201     const struct registered_dpif_class *registered_class;
 202     const struct dpif_class *dpif_class;
 203     int error;
 204
 205     dp_initialize();
 206     sset_clear(names);
 207
 208     registered_class = shash_find_data(&dpif_classes, type);
 209     if (!registered_class) {
 210         VLOG_WARN("could not enumerate unknown type: %s", type);
 211         return EAFNOSUPPORT;
 212     }
 213
 214     dpif_class = registered_class->dpif_class;
 215     error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
 216
 217     if (error) {
 218         VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
 219                    strerror(error));
 220     }
 221
 222     return error;
 223 }
 224
 225 /* Parses 'datapath_name_', which is of the form [type@]name into its
 226  * component pieces.  'name' and 'type' must be freed by the caller.
 227  *
 228  * The returned 'type' is normalized, as if by dpif_normalize_type(). */
 229 void
 230 dp_parse_name(const char *datapath_name_, char **name, char **type)
 231 {
 232     char *datapath_name = xstrdup(datapath_name_);
 233     char *separator;
 234
 235     separator = strchr(datapath_name, '@');
 236     if (separator) {
 237         *separator = '\0';
 238         *type = datapath_name;
 239         *name = xstrdup(dpif_normalize_type(separator + 1));
 240     } else {
 241         *name = datapath_name;
 242         *type = xstrdup(dpif_normalize_type(NULL));
 243     }
 244 }
 245
 246 static int
 247 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
 248 {
 249     struct dpif *dpif = NULL;
 250     int error;
 251     struct registered_dpif_class *registered_class;
 252
 253     dp_initialize();
 254
 255     type = dpif_normalize_type(type);
 256
 257     registered_class = shash_find_data(&dpif_classes, type);
 258     if (!registered_class) {
 259         VLOG_WARN("could not create datapath %s of unknown type %s", name,
 260                   type);
 261         error = EAFNOSUPPORT;
 262         goto exit;
 263     }
 264
 265     error = registered_class->dpif_class->open(registered_class->dpif_class,
 266                                                name, create, &dpif);
 267     if (!error) {
 268         assert(dpif->dpif_class == registered_class->dpif_class);
 269         registered_class->refcount++;
 270     }
 271
 272 exit:
 273     *dpifp = error ? NULL : dpif;
 274     return error;
 275 }
 276
 277 /* Tries to open an existing datapath named 'name' and type 'type'.  Will fail
 278  * if no datapath with 'name' and 'type' exists.  'type' may be either NULL or
 279  * the empty string to specify the default system type.  Returns 0 if
 280  * successful, otherwise a positive errno value.  On success stores a pointer
 281  * to the datapath in '*dpifp', otherwise a null pointer. */
 282 int
 283 dpif_open(const char *name, const char *type, struct dpif **dpifp)
 284 {
 285     return do_open(name, type, false, dpifp);
 286 }
 287
 288 /* Tries to create and open a new datapath with the given 'name' and 'type'.
 289  * 'type' may be either NULL or the empty string to specify the default system
 290  * type.  Will fail if a datapath with 'name' and 'type' already exists.
 291  * Returns 0 if successful, otherwise a positive errno value.  On success
 292  * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
 293 int
 294 dpif_create(const char *name, const char *type, struct dpif **dpifp)
 295 {
 296     return do_open(name, type, true, dpifp);
 297 }
 298
 299 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
 300  * does not exist.  'type' may be either NULL or the empty string to specify
 301  * the default system type.  Returns 0 if successful, otherwise a positive
 302  * errno value. On success stores a pointer to the datapath in '*dpifp',
 303  * otherwise a null pointer. */
 304 int
 305 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
 306 {
 307     int error;
 308
 309     error = dpif_create(name, type, dpifp);
 310     if (error == EEXIST || error == EBUSY) {
 311         error = dpif_open(name, type, dpifp);
 312         if (error) {
 313             VLOG_WARN("datapath %s already exists but cannot be opened: %s",
 314                       name, strerror(error));
 315         }
 316     } else if (error) {
 317         VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
 318     }
 319     return error;
 320 }
 321
 322 /* Closes and frees the connection to 'dpif'.  Does not destroy the datapath
 323  * itself; call dpif_delete() first, instead, if that is desirable. */
 324 void
 325 dpif_close(struct dpif *dpif)
 326 {
 327     if (dpif) {
 328         struct registered_dpif_class *registered_class;
 329
 330         registered_class = shash_find_data(&dpif_classes,
 331                 dpif->dpif_class->type);
 332         assert(registered_class);
 333         assert(registered_class->refcount);
 334
 335         registered_class->refcount--;
 336         dpif_uninit(dpif, true);
 337     }
 338 }
 339
 340 /* Performs periodic work needed by 'dpif'. */
 341 void
 342 dpif_run(struct dpif *dpif)
 343 {
 344     if (dpif->dpif_class->run) {
 345         dpif->dpif_class->run(dpif);
 346     }
 347 }
 348
 349 /* Arranges for poll_block() to wake up when dp_run() needs to be called for
 350  * 'dpif'. */
 351 void
 352 dpif_wait(struct dpif *dpif)
 353 {
 354     if (dpif->dpif_class->wait) {
 355         dpif->dpif_class->wait(dpif);
 356     }
 357 }
 358
 359 /* Returns the name of datapath 'dpif' prefixed with the type
 360  * (for use in log messages). */
 361 const char *
 362 dpif_name(const struct dpif *dpif)
 363 {
 364     return dpif->full_name;
 365 }
 366
 367 /* Returns the name of datapath 'dpif' without the type
 368  * (for use in device names). */
 369 const char *
 370 dpif_base_name(const struct dpif *dpif)
 371 {
 372     return dpif->base_name;
 373 }
 374
 375 /* Returns the type of datapath 'dpif'. */
 376 const char *
 377 dpif_type(const struct dpif *dpif)
 378 {
 379     return dpif->dpif_class->type;
 380 }
 381
 382 /* Returns the fully spelled out name for the given datapath 'type'.
 383  *
 384  * Normalized type string can be compared with strcmp().  Unnormalized type
 385  * string might be the same even if they have different spellings. */
 386 const char *
 387 dpif_normalize_type(const char *type)
 388 {
 389     return type && type[0] ? type : "system";
 390 }
 391
 392 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
 393  * ports.  After calling this function, it does not make sense to pass 'dpif'
 394  * to any functions other than dpif_name() or dpif_close(). */
 395 int
 396 dpif_delete(struct dpif *dpif)
 397 {
 398     int error;
 399
 400     COVERAGE_INC(dpif_destroy);
 401
 402     error = dpif->dpif_class->destroy(dpif);
 403     log_operation(dpif, "delete", error);
 404     return error;
 405 }
 406
 407 /* Retrieves statistics for 'dpif' into 'stats'.  Returns 0 if successful,
 408  * otherwise a positive errno value. */
 409 int
 410 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
 411 {
 412     int error = dpif->dpif_class->get_stats(dpif, stats);
 413     if (error) {
 414         memset(stats, 0, sizeof *stats);
 415     }
 416     log_operation(dpif, "get_stats", error);
 417     return error;
 418 }
 419
 420 /* Attempts to add 'netdev' as a port on 'dpif'.  If 'port_nop' is
 421  * non-null and its value is not UINT32_MAX, then attempts to use the
 422  * value as the port number.
 423  *
 424  * If successful, returns 0 and sets '*port_nop' to the new port's port
 425  * number (if 'port_nop' is non-null).  On failure, returns a positive
 426  * errno value and sets '*port_nop' to UINT32_MAX (if 'port_nop' is
 427  * non-null). */
 428 int
 429 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint32_t *port_nop)
 430 {
 431     const char *netdev_name = netdev_get_name(netdev);
 432     uint32_t port_no = UINT32_MAX;
 433     int error;
 434
 435     COVERAGE_INC(dpif_port_add);
 436
 437     if (port_nop) {
 438         port_no = *port_nop;
 439     }
 440
 441     error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
 442     if (!error) {
 443         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu32,
 444                     dpif_name(dpif), netdev_name, port_no);
 445     } else {
 446         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
 447                      dpif_name(dpif), netdev_name, strerror(error));
 448         port_no = UINT32_MAX;
 449     }
 450     if (port_nop) {
 451         *port_nop = port_no;
 452     }
 453     return error;
 454 }
 455
 456 /* Attempts to remove 'dpif''s port number 'port_no'.  Returns 0 if successful,
 457  * otherwise a positive errno value. */
 458 int
 459 dpif_port_del(struct dpif *dpif, uint32_t port_no)
 460 {
 461     int error;
 462
 463     COVERAGE_INC(dpif_port_del);
 464
 465     error = dpif->dpif_class->port_del(dpif, port_no);
 466     if (!error) {
 467         VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu32")",
 468                     dpif_name(dpif), port_no);
 469     } else {
 470         log_operation(dpif, "port_del", error);
 471     }
 472     return error;
 473 }
 474
 475 /* Makes a deep copy of 'src' into 'dst'. */
 476 void
 477 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
 478 {
 479     dst->name = xstrdup(src->name);
 480     dst->type = xstrdup(src->type);
 481     dst->port_no = src->port_no;
 482 }
 483
 484 /* Frees memory allocated to members of 'dpif_port'.
 485  *
 486  * Do not call this function on a dpif_port obtained from
 487  * dpif_port_dump_next(): that function retains ownership of the data in the
 488  * dpif_port. */
 489 void
 490 dpif_port_destroy(struct dpif_port *dpif_port)
 491 {
 492     free(dpif_port->name);
 493     free(dpif_port->type);
 494 }
 495
 496 /* Checks if port named 'devname' exists in 'dpif'.  If so, returns
 497  * true; otherwise, returns false. */
 498 bool
 499 dpif_port_exists(const struct dpif *dpif, const char *devname)
 500 {
 501     int error = dpif->dpif_class->port_query_by_name(dpif, devname, NULL);
 502     if (error != 0 && error != ENODEV) {
 503         VLOG_WARN_RL(&error_rl, "%s: failed to query port %s: %s",
 504                      dpif_name(dpif), devname, strerror(error));
 505     }
 506
 507     return !error;
 508 }
 509
 510 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and
 511  * initializes '*port' appropriately; on failure, returns a positive errno
 512  * value.
 513  *
 514  * The caller owns the data in 'port' and must free it with
 515  * dpif_port_destroy() when it is no longer needed. */
 516 int
 517 dpif_port_query_by_number(const struct dpif *dpif, uint32_t port_no,
 518                           struct dpif_port *port)
 519 {
 520     int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
 521     if (!error) {
 522         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu32" is device %s",
 523                     dpif_name(dpif), port_no, port->name);
 524     } else {
 525         memset(port, 0, sizeof *port);
 526         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu32": %s",
 527                      dpif_name(dpif), port_no, strerror(error));
 528     }
 529     return error;
 530 }
 531
 532 /* Looks up port named 'devname' in 'dpif'.  On success, returns 0 and
 533  * initializes '*port' appropriately; on failure, returns a positive errno
 534  * value.
 535  *
 536  * The caller owns the data in 'port' and must free it with
 537  * dpif_port_destroy() when it is no longer needed. */
 538 int
 539 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
 540                         struct dpif_port *port)
 541 {
 542     int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
 543     if (!error) {
 544         VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu32,
 545                     dpif_name(dpif), devname, port->port_no);
 546     } else {
 547         memset(port, 0, sizeof *port);
 548
 549         /* For ENOENT or ENODEV we use DBG level because the caller is probably
 550          * interested in whether 'dpif' actually has a port 'devname', so that
 551          * it's not an issue worth logging if it doesn't.  Other errors are
 552          * uncommon and more likely to indicate a real problem. */
 553         VLOG_RL(&error_rl,
 554                 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
 555                 "%s: failed to query port %s: %s",
 556                 dpif_name(dpif), devname, strerror(error));
 557     }
 558     return error;
 559 }
 560
 561 /* Returns one greater than the maximum port number accepted in flow
 562  * actions. */
 563 int
 564 dpif_get_max_ports(const struct dpif *dpif)
 565 {
 566     return dpif->dpif_class->get_max_ports(dpif);
 567 }
 568
 569 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
 570  * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
 571  * packets arrived on port 'port_no'.
 572  *
 573  * A 'port_no' of UINT32_MAX is a special case: it returns a reserved PID, not
 574  * allocated to any port, that the client may use for special purposes.
 575  *
 576  * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
 577  * the 'dpif''s listen mask.  It is allowed to change when DPIF_UC_ACTION is
 578  * disabled and then re-enabled, so a client that does that must be prepared to
 579  * update all of the flows that it installed that contain
 580  * OVS_ACTION_ATTR_USERSPACE actions. */
 581 uint32_t
 582 dpif_port_get_pid(const struct dpif *dpif, uint32_t port_no)
 583 {
 584     return (dpif->dpif_class->port_get_pid
 585             ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
 586             : 0);
 587 }
 588
 589 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
 590  * the port's name into the 'name_size' bytes in 'name', ensuring that the
 591  * result is null-terminated.  On failure, returns a positive errno value and
 592  * makes 'name' the empty string. */
 593 int
 594 dpif_port_get_name(struct dpif *dpif, uint32_t port_no,
 595                    char *name, size_t name_size)
 596 {
 597     struct dpif_port port;
 598     int error;
 599
 600     assert(name_size > 0);
 601
 602     error = dpif_port_query_by_number(dpif, port_no, &port);
 603     if (!error) {
 604         ovs_strlcpy(name, port.name, name_size);
 605         dpif_port_destroy(&port);
 606     } else {
 607         *name = '\0';
 608     }
 609     return error;
 610 }
 611
 612 /* Initializes 'dump' to begin dumping the ports in a dpif.
 613  *
 614  * This function provides no status indication.  An error status for the entire
 615  * dump operation is provided when it is completed by calling
 616  * dpif_port_dump_done().
 617  */
 618 void
 619 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
 620 {
 621     dump->dpif = dpif;
 622     dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
 623     log_operation(dpif, "port_dump_start", dump->error);
 624 }
 625
 626 /* Attempts to retrieve another port from 'dump', which must have been
 627  * initialized with dpif_port_dump_start().  On success, stores a new dpif_port
 628  * into 'port' and returns true.  On failure, returns false.
 629  *
 630  * Failure might indicate an actual error or merely that the last port has been
 631  * dumped.  An error status for the entire dump operation is provided when it
 632  * is completed by calling dpif_port_dump_done().
 633  *
 634  * The dpif owns the data stored in 'port'.  It will remain valid until at
 635  * least the next time 'dump' is passed to dpif_port_dump_next() or
 636  * dpif_port_dump_done(). */
 637 bool
 638 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
 639 {
 640     const struct dpif *dpif = dump->dpif;
 641
 642     if (dump->error) {
 643         return false;
 644     }
 645
 646     dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
 647     if (dump->error == EOF) {
 648         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
 649     } else {
 650         log_operation(dpif, "port_dump_next", dump->error);
 651     }
 652
 653     if (dump->error) {
 654         dpif->dpif_class->port_dump_done(dpif, dump->state);
 655         return false;
 656     }
 657     return true;
 658 }
 659
 660 /* Completes port table dump operation 'dump', which must have been initialized
 661  * with dpif_port_dump_start().  Returns 0 if the dump operation was
 662  * error-free, otherwise a positive errno value describing the problem. */
 663 int
 664 dpif_port_dump_done(struct dpif_port_dump *dump)
 665 {
 666     const struct dpif *dpif = dump->dpif;
 667     if (!dump->error) {
 668         dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
 669         log_operation(dpif, "port_dump_done", dump->error);
 670     }
 671     return dump->error == EOF ? 0 : dump->error;
 672 }
 673
 674 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
 675  * 'dpif' has changed, this function does one of the following:
 676  *
 677  * - Stores the name of the device that was added to or deleted from 'dpif' in
 678  *   '*devnamep' and returns 0.  The caller is responsible for freeing
 679  *   '*devnamep' (with free()) when it no longer needs it.
 680  *
 681  * - Returns ENOBUFS and sets '*devnamep' to NULL.
 682  *
 683  * This function may also return 'false positives', where it returns 0 and
 684  * '*devnamep' names a device that was not actually added or deleted or it
 685  * returns ENOBUFS without any change.
 686  *
 687  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
 688  * return other positive errno values to indicate that something has gone
 689  * wrong. */
 690 int
 691 dpif_port_poll(const struct dpif *dpif, char **devnamep)
 692 {
 693     int error = dpif->dpif_class->port_poll(dpif, devnamep);
 694     if (error) {
 695         *devnamep = NULL;
 696     }
 697     return error;
 698 }
 699
 700 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
 701  * value other than EAGAIN. */
 702 void
 703 dpif_port_poll_wait(const struct dpif *dpif)
 704 {
 705     dpif->dpif_class->port_poll_wait(dpif);
 706 }
 707
 708 /* Extracts the flow stats for a packet.  The 'flow' and 'packet'
 709  * arguments must have been initialized through a call to flow_extract().
 710  * 'used' is stored into stats->used. */
 711 void
 712 dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet,
 713                         long long int used, struct dpif_flow_stats *stats)
 714 {
 715     stats->tcp_flags = packet_get_tcp_flags(packet, flow);
 716     stats->n_bytes = packet->size;
 717     stats->n_packets = 1;
 718     stats->used = used;
 719 }
 720
 721 /* Appends a human-readable representation of 'stats' to 's'. */
 722 void
 723 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
 724 {
 725     ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
 726                   stats->n_packets, stats->n_bytes);
 727     if (stats->used) {
 728         ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
 729     } else {
 730         ds_put_format(s, "never");
 731     }
 732     if (stats->tcp_flags) {
 733         ds_put_cstr(s, ", flags:");
 734         packet_format_tcp_flags(s, stats->tcp_flags);
 735     }
 736 }
 737
 738 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
 739  * positive errno value.  */
 740 int
 741 dpif_flow_flush(struct dpif *dpif)
 742 {
 743     int error;
 744
 745     COVERAGE_INC(dpif_flow_flush);
 746
 747     error = dpif->dpif_class->flow_flush(dpif);
 748     log_operation(dpif, "flow_flush", error);
 749     return error;
 750 }
 751
 752 /* Queries 'dpif' for a flow entry.  The flow is specified by the Netlink
 753  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
 754  * 'key'.
 755  *
 756  * Returns 0 if successful.  If no flow matches, returns ENOENT.  On other
 757  * failure, returns a positive errno value.
 758  *
 759  * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
 760  * ofpbuf owned by the caller that contains the Netlink attributes for the
 761  * flow's actions.  The caller must free the ofpbuf (with ofpbuf_delete()) when
 762  * it is no longer needed.
 763  *
 764  * If 'stats' is nonnull, then on success it will be updated with the flow's
 765  * statistics. */
 766 int
 767 dpif_flow_get(const struct dpif *dpif,
 768               const struct nlattr *key, size_t key_len,
 769               struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 770 {
 771     int error;
 772
 773     COVERAGE_INC(dpif_flow_get);
 774
 775     error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
 776     if (error) {
 777         if (actionsp) {
 778             *actionsp = NULL;
 779         }
 780         if (stats) {
 781             memset(stats, 0, sizeof *stats);
 782         }
 783     }
 784     if (should_log_flow_message(error)) {
 785         const struct nlattr *actions;
 786         size_t actions_len;
 787
 788         if (!error && actionsp) {
 789             actions = (*actionsp)->data;
 790             actions_len = (*actionsp)->size;
 791         } else {
 792             actions = NULL;
 793             actions_len = 0;
 794         }
 795         log_flow_message(dpif, error, "flow_get", key, key_len, stats,
 796                          actions, actions_len);
 797     }
 798     return error;
 799 }
 800
 801 static int
 802 dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put)
 803 {
 804     int error;
 805
 806     COVERAGE_INC(dpif_flow_put);
 807     assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY
 808                             | DPIF_FP_ZERO_STATS)));
 809
 810     error = dpif->dpif_class->flow_put(dpif, put);
 811     if (error && put->stats) {
 812         memset(put->stats, 0, sizeof *put->stats);
 813     }
 814     log_flow_put_message(dpif, put, error);
 815     return error;
 816 }
 817
 818 /* Adds or modifies a flow in 'dpif'.  The flow is specified by the Netlink
 819  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
 820  * 'key'.  The associated actions are specified by the Netlink attributes with
 821  * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
 822  *
 823  * - If the flow's key does not exist in 'dpif', then the flow will be added if
 824  *   'flags' includes DPIF_FP_CREATE.  Otherwise the operation will fail with
 825  *   ENOENT.
 826  *
 827  *   If the operation succeeds, then 'stats', if nonnull, will be zeroed.
 828  *
 829  * - If the flow's key does exist in 'dpif', then the flow's actions will be
 830  *   updated if 'flags' includes DPIF_FP_MODIFY.  Otherwise the operation will
 831  *   fail with EEXIST.  If the flow's actions are updated, then its statistics
 832  *   will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
 833  *   otherwise.
 834  *
 835  *   If the operation succeeds, then 'stats', if nonnull, will be set to the
 836  *   flow's statistics before the update.
 837  */
 838 int
 839 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
 840               const struct nlattr *key, size_t key_len,
 841               const struct nlattr *actions, size_t actions_len,
 842               struct dpif_flow_stats *stats)
 843 {
 844     struct dpif_flow_put put;
 845
 846     put.flags = flags;
 847     put.key = key;
 848     put.key_len = key_len;
 849     put.actions = actions;
 850     put.actions_len = actions_len;
 851     put.stats = stats;
 852     return dpif_flow_put__(dpif, &put);
 853 }
 854
 855 static int
 856 dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del)
 857 {
 858     int error;
 859
 860     COVERAGE_INC(dpif_flow_del);
 861
 862     error = dpif->dpif_class->flow_del(dpif, del);
 863     if (error && del->stats) {
 864         memset(del->stats, 0, sizeof *del->stats);
 865     }
 866     log_flow_del_message(dpif, del, error);
 867     return error;
 868 }
 869
 870 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
 871  * not contain such a flow.  The flow is specified by the Netlink attributes
 872  * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
 873  *
 874  * If the operation succeeds, then 'stats', if nonnull, will be set to the
 875  * flow's statistics before its deletion. */
 876 int
 877 dpif_flow_del(struct dpif *dpif,
 878               const struct nlattr *key, size_t key_len,
 879               struct dpif_flow_stats *stats)
 880 {
 881     struct dpif_flow_del del;
 882
 883     del.key = key;
 884     del.key_len = key_len;
 885     del.stats = stats;
 886     return dpif_flow_del__(dpif, &del);
 887 }
 888
 889 /* Initializes 'dump' to begin dumping the flows in a dpif.
 890  *
 891  * This function provides no status indication.  An error status for the entire
 892  * dump operation is provided when it is completed by calling
 893  * dpif_flow_dump_done().
 894  */
 895 void
 896 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
 897 {
 898     dump->dpif = dpif;
 899     dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
 900     log_operation(dpif, "flow_dump_start", dump->error);
 901 }
 902
 903 /* Attempts to retrieve another flow from 'dump', which must have been
 904  * initialized with dpif_flow_dump_start().  On success, updates the output
 905  * parameters as described below and returns true.  Otherwise, returns false.
 906  * Failure might indicate an actual error or merely the end of the flow table.
 907  * An error status for the entire dump operation is provided when it is
 908  * completed by calling dpif_flow_dump_done().
 909  *
 910  * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
 911  * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
 912  * dumped flow's key.  If 'actions' and 'actions_len' are nonnull then they are
 913  * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
 914  * dumped flow's actions.  If 'stats' is nonnull then it will be set to the
 915  * dumped flow's statistics.
 916  *
 917  * All of the returned data is owned by 'dpif', not by the caller, and the
 918  * caller must not modify or free it.  'dpif' guarantees that it remains
 919  * accessible and unchanging until at least the next call to 'flow_dump_next'
 920  * or 'flow_dump_done' for 'dump'. */
 921 bool
 922 dpif_flow_dump_next(struct dpif_flow_dump *dump,
 923                     const struct nlattr **key, size_t *key_len,
 924                     const struct nlattr **actions, size_t *actions_len,
 925                     const struct dpif_flow_stats **stats)
 926 {
 927     const struct dpif *dpif = dump->dpif;
 928     int error = dump->error;
 929
 930     if (!error) {
 931         error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
 932                                                  key, key_len,
 933                                                  actions, actions_len,
 934                                                  stats);
 935         if (error) {
 936             dpif->dpif_class->flow_dump_done(dpif, dump->state);
 937         }
 938     }
 939     if (error) {
 940         if (key) {
 941             *key = NULL;
 942             *key_len = 0;
 943         }
 944         if (actions) {
 945             *actions = NULL;
 946             *actions_len = 0;
 947         }
 948         if (stats) {
 949             *stats = NULL;
 950         }
 951     }
 952     if (!dump->error) {
 953         if (error == EOF) {
 954             VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
 955         } else if (should_log_flow_message(error)) {
 956             log_flow_message(dpif, error, "flow_dump",
 957                              key ? *key : NULL, key ? *key_len : 0,
 958                              stats ? *stats : NULL, actions ? *actions : NULL,
 959                              actions ? *actions_len : 0);
 960         }
 961     }
 962     dump->error = error;
 963     return !error;
 964 }
 965
 966 /* Completes flow table dump operation 'dump', which must have been initialized
 967  * with dpif_flow_dump_start().  Returns 0 if the dump operation was
 968  * error-free, otherwise a positive errno value describing the problem. */
 969 int
 970 dpif_flow_dump_done(struct dpif_flow_dump *dump)
 971 {
 972     const struct dpif *dpif = dump->dpif;
 973     if (!dump->error) {
 974         dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
 975         log_operation(dpif, "flow_dump_done", dump->error);
 976     }
 977     return dump->error == EOF ? 0 : dump->error;
 978 }
 979
 980 static int
 981 dpif_execute__(struct dpif *dpif, const struct dpif_execute *execute)
 982 {
 983     int error;
 984
 985     COVERAGE_INC(dpif_execute);
 986     if (execute->actions_len > 0) {
 987         error = dpif->dpif_class->execute(dpif, execute);
 988     } else {
 989         error = 0;
 990     }
 991
 992     log_execute_message(dpif, execute, error);
 993
 994     return error;
 995 }
 996
 997 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
 998  * the Ethernet frame specified in 'packet' taken from the flow specified in
 999  * the 'key_len' bytes of 'key'.  ('key' is mostly redundant with 'packet', but
1000  * it contains some metadata that cannot be recovered from 'packet', such as
1001  * tunnel and in_port.)
1002  *
1003  * Returns 0 if successful, otherwise a positive errno value. */
1004 int
1005 dpif_execute(struct dpif *dpif,
1006              const struct nlattr *key, size_t key_len,
1007              const struct nlattr *actions, size_t actions_len,
1008              const struct ofpbuf *buf)
1009 {
1010     struct dpif_execute execute;
1011
1012     execute.key = key;
1013     execute.key_len = key_len;
1014     execute.actions = actions;
1015     execute.actions_len = actions_len;
1016     execute.packet = buf;
1017     return dpif_execute__(dpif, &execute);
1018 }
1019
1020 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1021  * which they are specified, placing each operation's results in the "output"
1022  * members documented in comments.
1023  *
1024  * This function exists because some datapaths can perform batched operations
1025  * faster than individual operations. */
1026 void
1027 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
1028 {
1029     size_t i;
1030
1031     if (dpif->dpif_class->operate) {
1032         dpif->dpif_class->operate(dpif, ops, n_ops);
1033
1034         for (i = 0; i < n_ops; i++) {
1035             struct dpif_op *op = ops[i];
1036
1037             switch (op->type) {
1038             case DPIF_OP_FLOW_PUT:
1039                 log_flow_put_message(dpif, &op->u.flow_put, op->error);
1040                 break;
1041
1042             case DPIF_OP_FLOW_DEL:
1043                 log_flow_del_message(dpif, &op->u.flow_del, op->error);
1044                 break;
1045
1046             case DPIF_OP_EXECUTE:
1047                 log_execute_message(dpif, &op->u.execute, op->error);
1048                 break;
1049             }
1050         }
1051         return;
1052     }
1053
1054     for (i = 0; i < n_ops; i++) {
1055         struct dpif_op *op = ops[i];
1056
1057         switch (op->type) {
1058         case DPIF_OP_FLOW_PUT:
1059             op->error = dpif_flow_put__(dpif, &op->u.flow_put);
1060             break;
1061
1062         case DPIF_OP_FLOW_DEL:
1063             op->error = dpif_flow_del__(dpif, &op->u.flow_del);
1064             break;
1065
1066         case DPIF_OP_EXECUTE:
1067             op->error = dpif_execute__(dpif, &op->u.execute);
1068             break;
1069
1070         default:
1071             NOT_REACHED();
1072         }
1073     }
1074 }
1075
1076
1077 /* Returns a string that represents 'type', for use in log messages. */
1078 const char *
1079 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1080 {
1081     switch (type) {
1082     case DPIF_UC_MISS: return "miss";
1083     case DPIF_UC_ACTION: return "action";
1084     case DPIF_N_UC_TYPES: default: return "<unknown>";
1085     }
1086 }
1087
1088 /* Enables or disables receiving packets with dpif_recv() on 'dpif'.  Returns 0
1089  * if successful, otherwise a positive errno value.
1090  *
1091  * Turning packet receive off and then back on may change the Netlink PID
1092  * assignments returned by dpif_port_get_pid().  If the client does this, it
1093  * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1094  * using the new PID assignment. */
1095 int
1096 dpif_recv_set(struct dpif *dpif, bool enable)
1097 {
1098     int error = dpif->dpif_class->recv_set(dpif, enable);
1099     log_operation(dpif, "recv_set", error);
1100     return error;
1101 }
1102
1103 /* Polls for an upcall from 'dpif'.  If successful, stores the upcall into
1104  * '*upcall', using 'buf' for storage.  Should only be called if
1105  * dpif_recv_set() has been used to enable receiving packets on 'dpif'.
1106  *
1107  * 'upcall->packet' and 'upcall->key' point into data in the caller-provided
1108  * 'buf', so their memory cannot be freed separately from 'buf'.  (This is
1109  * hardly a great way to do things but it works out OK for the dpif providers
1110  * and clients that exist so far.)
1111  *
1112  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
1113  * if no upcall is immediately available. */
1114 int
1115 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall, struct ofpbuf *buf)
1116 {
1117     int error = dpif->dpif_class->recv(dpif, upcall, buf);
1118     if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1119         struct ds flow;
1120         char *packet;
1121
1122         packet = ofp_packet_to_string(upcall->packet->data,
1123                                       upcall->packet->size);
1124
1125         ds_init(&flow);
1126         odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1127
1128         VLOG_DBG("%s: %s upcall:\n%s\n%s",
1129                  dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1130                  ds_cstr(&flow), packet);
1131
1132         ds_destroy(&flow);
1133         free(packet);
1134     } else if (error && error != EAGAIN) {
1135         log_operation(dpif, "recv", error);
1136     }
1137     return error;
1138 }
1139
1140 /* Discards all messages that would otherwise be received by dpif_recv() on
1141  * 'dpif'. */
1142 void
1143 dpif_recv_purge(struct dpif *dpif)
1144 {
1145     COVERAGE_INC(dpif_purge);
1146     if (dpif->dpif_class->recv_purge) {
1147         dpif->dpif_class->recv_purge(dpif);
1148     }
1149 }
1150
1151 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1152  * received with dpif_recv(). */
1153 void
1154 dpif_recv_wait(struct dpif *dpif)
1155 {
1156     dpif->dpif_class->recv_wait(dpif);
1157 }
1158
1159 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1160  * and '*engine_id', respectively. */
1161 void
1162 dpif_get_netflow_ids(const struct dpif *dpif,
1163                      uint8_t *engine_type, uint8_t *engine_id)
1164 {
1165     *engine_type = dpif->netflow_engine_type;
1166     *engine_id = dpif->netflow_engine_id;
1167 }
1168
1169 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1170  * value used for setting packet priority.
1171  * On success, returns 0 and stores the priority into '*priority'.
1172  * On failure, returns a positive errno value and stores 0 into '*priority'. */
1173 int
1174 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1175                        uint32_t *priority)
1176 {
1177     int error = (dpif->dpif_class->queue_to_priority
1178                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1179                                                        priority)
1180                  : EOPNOTSUPP);
1181     if (error) {
1182         *priority = 0;
1183     }
1184     log_operation(dpif, "queue_to_priority", error);
1185     return error;
1186 }
1187 \f
1188 void
1189 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1190           const char *name,
1191           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1192 {
1193     dpif->dpif_class = dpif_class;
1194     dpif->base_name = xstrdup(name);
1195     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1196     dpif->netflow_engine_type = netflow_engine_type;
1197     dpif->netflow_engine_id = netflow_engine_id;
1198 }
1199
1200 /* Undoes the results of initialization.
1201  *
1202  * Normally this function only needs to be called from dpif_close().
1203  * However, it may be called by providers due to an error on opening
1204  * that occurs after initialization.  It this case dpif_close() would
1205  * never be called. */
1206 void
1207 dpif_uninit(struct dpif *dpif, bool close)
1208 {
1209     char *base_name = dpif->base_name;
1210     char *full_name = dpif->full_name;
1211
1212     if (close) {
1213         dpif->dpif_class->close(dpif);
1214     }
1215
1216     free(base_name);
1217     free(full_name);
1218 }
1219 \f
1220 static void
1221 log_operation(const struct dpif *dpif, const char *operation, int error)
1222 {
1223     if (!error) {
1224         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1225     } else if (ofperr_is_valid(error)) {
1226         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1227                      dpif_name(dpif), operation, ofperr_get_name(error));
1228     } else {
1229         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1230                      dpif_name(dpif), operation, strerror(error));
1231     }
1232 }
1233
1234 static enum vlog_level
1235 flow_message_log_level(int error)
1236 {
1237     return error ? VLL_WARN : VLL_DBG;
1238 }
1239
1240 static bool
1241 should_log_flow_message(int error)
1242 {
1243     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1244                              error ? &error_rl : &dpmsg_rl);
1245 }
1246
1247 static void
1248 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1249                  const struct nlattr *key, size_t key_len,
1250                  const struct dpif_flow_stats *stats,
1251                  const struct nlattr *actions, size_t actions_len)
1252 {
1253     struct ds ds = DS_EMPTY_INITIALIZER;
1254     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1255     if (error) {
1256         ds_put_cstr(&ds, "failed to ");
1257     }
1258     ds_put_format(&ds, "%s ", operation);
1259     if (error) {
1260         ds_put_format(&ds, "(%s) ", strerror(error));
1261     }
1262     odp_flow_key_format(key, key_len, &ds);
1263     if (stats) {
1264         ds_put_cstr(&ds, ", ");
1265         dpif_flow_stats_format(stats, &ds);
1266     }
1267     if (actions || actions_len) {
1268         ds_put_cstr(&ds, ", actions:");
1269         format_odp_actions(&ds, actions, actions_len);
1270     }
1271     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1272     ds_destroy(&ds);
1273 }
1274
1275 static void
1276 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1277                      int error)
1278 {
1279     if (should_log_flow_message(error)) {
1280         struct ds s;
1281
1282         ds_init(&s);
1283         ds_put_cstr(&s, "put");
1284         if (put->flags & DPIF_FP_CREATE) {
1285             ds_put_cstr(&s, "[create]");
1286         }
1287         if (put->flags & DPIF_FP_MODIFY) {
1288             ds_put_cstr(&s, "[modify]");
1289         }
1290         if (put->flags & DPIF_FP_ZERO_STATS) {
1291             ds_put_cstr(&s, "[zero]");
1292         }
1293         log_flow_message(dpif, error, ds_cstr(&s),
1294                          put->key, put->key_len, put->stats,
1295                          put->actions, put->actions_len);
1296         ds_destroy(&s);
1297     }
1298 }
1299
1300 static void
1301 log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del,
1302                      int error)
1303 {
1304     if (should_log_flow_message(error)) {
1305         log_flow_message(dpif, error, "flow_del", del->key, del->key_len,
1306                          !error ? del->stats : NULL, NULL, 0);
1307     }
1308 }
1309
1310 static void
1311 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1312                     int error)
1313 {
1314     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
1315         struct ds ds = DS_EMPTY_INITIALIZER;
1316         char *packet;
1317
1318         packet = ofp_packet_to_string(execute->packet->data,
1319                                       execute->packet->size);
1320         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
1321         format_odp_actions(&ds, execute->actions, execute->actions_len);
1322         if (error) {
1323             ds_put_format(&ds, " failed (%s)", strerror(error));
1324         }
1325         ds_put_format(&ds, " on packet %s", packet);
1326         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
1327         ds_destroy(&ds);
1328         free(packet);
1329     }
1330 }