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 HAVE_NETLINK
  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 fully spelled out name for the given datapath 'type'.
 376  *
 377  * Normalized type string can be compared with strcmp().  Unnormalized type
 378  * string might be the same even if they have different spellings. */
 379 const char *
 380 dpif_normalize_type(const char *type)
 381 {
 382     return type && type[0] ? type : "system";
 383 }
 384
 385 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
 386  * ports.  After calling this function, it does not make sense to pass 'dpif'
 387  * to any functions other than dpif_name() or dpif_close(). */
 388 int
 389 dpif_delete(struct dpif *dpif)
 390 {
 391     int error;
 392
 393     COVERAGE_INC(dpif_destroy);
 394
 395     error = dpif->dpif_class->destroy(dpif);
 396     log_operation(dpif, "delete", error);
 397     return error;
 398 }
 399
 400 /* Retrieves statistics for 'dpif' into 'stats'.  Returns 0 if successful,
 401  * otherwise a positive errno value. */
 402 int
 403 dpif_get_dp_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
 404 {
 405     int error = dpif->dpif_class->get_stats(dpif, stats);
 406     if (error) {
 407         memset(stats, 0, sizeof *stats);
 408     }
 409     log_operation(dpif, "get_stats", error);
 410     return error;
 411 }
 412
 413 /* Attempts to add 'netdev' as a port on 'dpif'.  If 'port_nop' is
 414  * non-null and its value is not UINT16_MAX, then attempts to use the
 415  * value as the port number.
 416  *
 417  * If successful, returns 0 and sets '*port_nop' to the new port's port
 418  * number (if 'port_nop' is non-null).  On failure, returns a positive
 419  * errno value and sets '*port_nop' to UINT16_MAX (if 'port_nop' is
 420  * non-null). */
 421 int
 422 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
 423 {
 424     const char *netdev_name = netdev_get_name(netdev);
 425     uint16_t port_no = UINT16_MAX;
 426     int error;
 427
 428     COVERAGE_INC(dpif_port_add);
 429
 430     if (port_nop) {
 431         port_no = *port_nop;
 432     }
 433
 434     error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
 435     if (!error) {
 436         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
 437                     dpif_name(dpif), netdev_name, port_no);
 438     } else {
 439         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
 440                      dpif_name(dpif), netdev_name, strerror(error));
 441         port_no = UINT16_MAX;
 442     }
 443     if (port_nop) {
 444         *port_nop = port_no;
 445     }
 446     return error;
 447 }
 448
 449 /* Attempts to remove 'dpif''s port number 'port_no'.  Returns 0 if successful,
 450  * otherwise a positive errno value. */
 451 int
 452 dpif_port_del(struct dpif *dpif, uint16_t port_no)
 453 {
 454     int error;
 455
 456     COVERAGE_INC(dpif_port_del);
 457
 458     error = dpif->dpif_class->port_del(dpif, port_no);
 459     if (!error) {
 460         VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
 461                     dpif_name(dpif), port_no);
 462     } else {
 463         log_operation(dpif, "port_del", error);
 464     }
 465     return error;
 466 }
 467
 468 /* Makes a deep copy of 'src' into 'dst'. */
 469 void
 470 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
 471 {
 472     dst->name = xstrdup(src->name);
 473     dst->type = xstrdup(src->type);
 474     dst->port_no = src->port_no;
 475 }
 476
 477 /* Frees memory allocated to members of 'dpif_port'.
 478  *
 479  * Do not call this function on a dpif_port obtained from
 480  * dpif_port_dump_next(): that function retains ownership of the data in the
 481  * dpif_port. */
 482 void
 483 dpif_port_destroy(struct dpif_port *dpif_port)
 484 {
 485     free(dpif_port->name);
 486     free(dpif_port->type);
 487 }
 488
 489 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and
 490  * initializes '*port' appropriately; on failure, returns a positive errno
 491  * value.
 492  *
 493  * The caller owns the data in 'port' and must free it with
 494  * dpif_port_destroy() when it is no longer needed. */
 495 int
 496 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 497                           struct dpif_port *port)
 498 {
 499     int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
 500     if (!error) {
 501         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
 502                     dpif_name(dpif), port_no, port->name);
 503     } else {
 504         memset(port, 0, sizeof *port);
 505         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
 506                      dpif_name(dpif), port_no, strerror(error));
 507     }
 508     return error;
 509 }
 510
 511 /* Looks up port named 'devname' in 'dpif'.  On success, returns 0 and
 512  * initializes '*port' appropriately; on failure, returns a positive errno
 513  * value.
 514  *
 515  * The caller owns the data in 'port' and must free it with
 516  * dpif_port_destroy() when it is no longer needed. */
 517 int
 518 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
 519                         struct dpif_port *port)
 520 {
 521     int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
 522     if (!error) {
 523         VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
 524                     dpif_name(dpif), devname, port->port_no);
 525     } else {
 526         memset(port, 0, sizeof *port);
 527
 528         /* For ENOENT or ENODEV we use DBG level because the caller is probably
 529          * interested in whether 'dpif' actually has a port 'devname', so that
 530          * it's not an issue worth logging if it doesn't.  Other errors are
 531          * uncommon and more likely to indicate a real problem. */
 532         VLOG_RL(&error_rl,
 533                 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
 534                 "%s: failed to query port %s: %s",
 535                 dpif_name(dpif), devname, strerror(error));
 536     }
 537     return error;
 538 }
 539
 540 /* Returns one greater than the maximum port number accepted in flow
 541  * actions. */
 542 int
 543 dpif_get_max_ports(const struct dpif *dpif)
 544 {
 545     return dpif->dpif_class->get_max_ports(dpif);
 546 }
 547
 548 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
 549  * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
 550  * packets arrived on port 'port_no'.
 551  *
 552  * A 'port_no' of UINT16_MAX is a special case: it returns a reserved PID, not
 553  * allocated to any port, that the client may use for special purposes.
 554  *
 555  * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
 556  * the 'dpif''s listen mask.  It is allowed to change when DPIF_UC_ACTION is
 557  * disabled and then re-enabled, so a client that does that must be prepared to
 558  * update all of the flows that it installed that contain
 559  * OVS_ACTION_ATTR_USERSPACE actions. */
 560 uint32_t
 561 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
 562 {
 563     return (dpif->dpif_class->port_get_pid
 564             ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
 565             : 0);
 566 }
 567
 568 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
 569  * the port's name into the 'name_size' bytes in 'name', ensuring that the
 570  * result is null-terminated.  On failure, returns a positive errno value and
 571  * makes 'name' the empty string. */
 572 int
 573 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
 574                    char *name, size_t name_size)
 575 {
 576     struct dpif_port port;
 577     int error;
 578
 579     assert(name_size > 0);
 580
 581     error = dpif_port_query_by_number(dpif, port_no, &port);
 582     if (!error) {
 583         ovs_strlcpy(name, port.name, name_size);
 584         dpif_port_destroy(&port);
 585     } else {
 586         *name = '\0';
 587     }
 588     return error;
 589 }
 590
 591 /* Initializes 'dump' to begin dumping the ports in a dpif.
 592  *
 593  * This function provides no status indication.  An error status for the entire
 594  * dump operation is provided when it is completed by calling
 595  * dpif_port_dump_done().
 596  */
 597 void
 598 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
 599 {
 600     dump->dpif = dpif;
 601     dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
 602     log_operation(dpif, "port_dump_start", dump->error);
 603 }
 604
 605 /* Attempts to retrieve another port from 'dump', which must have been
 606  * initialized with dpif_port_dump_start().  On success, stores a new dpif_port
 607  * into 'port' and returns true.  On failure, returns false.
 608  *
 609  * Failure might indicate an actual error or merely that the last port has been
 610  * dumped.  An error status for the entire dump operation is provided when it
 611  * is completed by calling dpif_port_dump_done().
 612  *
 613  * The dpif owns the data stored in 'port'.  It will remain valid until at
 614  * least the next time 'dump' is passed to dpif_port_dump_next() or
 615  * dpif_port_dump_done(). */
 616 bool
 617 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
 618 {
 619     const struct dpif *dpif = dump->dpif;
 620
 621     if (dump->error) {
 622         return false;
 623     }
 624
 625     dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
 626     if (dump->error == EOF) {
 627         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
 628     } else {
 629         log_operation(dpif, "port_dump_next", dump->error);
 630     }
 631
 632     if (dump->error) {
 633         dpif->dpif_class->port_dump_done(dpif, dump->state);
 634         return false;
 635     }
 636     return true;
 637 }
 638
 639 /* Completes port table dump operation 'dump', which must have been initialized
 640  * with dpif_port_dump_start().  Returns 0 if the dump operation was
 641  * error-free, otherwise a positive errno value describing the problem. */
 642 int
 643 dpif_port_dump_done(struct dpif_port_dump *dump)
 644 {
 645     const struct dpif *dpif = dump->dpif;
 646     if (!dump->error) {
 647         dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
 648         log_operation(dpif, "port_dump_done", dump->error);
 649     }
 650     return dump->error == EOF ? 0 : dump->error;
 651 }
 652
 653 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
 654  * 'dpif' has changed, this function does one of the following:
 655  *
 656  * - Stores the name of the device that was added to or deleted from 'dpif' in
 657  *   '*devnamep' and returns 0.  The caller is responsible for freeing
 658  *   '*devnamep' (with free()) when it no longer needs it.
 659  *
 660  * - Returns ENOBUFS and sets '*devnamep' to NULL.
 661  *
 662  * This function may also return 'false positives', where it returns 0 and
 663  * '*devnamep' names a device that was not actually added or deleted or it
 664  * returns ENOBUFS without any change.
 665  *
 666  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
 667  * return other positive errno values to indicate that something has gone
 668  * wrong. */
 669 int
 670 dpif_port_poll(const struct dpif *dpif, char **devnamep)
 671 {
 672     int error = dpif->dpif_class->port_poll(dpif, devnamep);
 673     if (error) {
 674         *devnamep = NULL;
 675     }
 676     return error;
 677 }
 678
 679 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
 680  * value other than EAGAIN. */
 681 void
 682 dpif_port_poll_wait(const struct dpif *dpif)
 683 {
 684     dpif->dpif_class->port_poll_wait(dpif);
 685 }
 686
 687 /* Extracts the flow stats for a packet.  The 'flow' and 'packet'
 688  * arguments must have been initialized through a call to flow_extract().
 689  * 'used' is stored into stats->used. */
 690 void
 691 dpif_flow_stats_extract(const struct flow *flow, const struct ofpbuf *packet,
 692                         long long int used, struct dpif_flow_stats *stats)
 693 {
 694     stats->tcp_flags = packet_get_tcp_flags(packet, flow);
 695     stats->n_bytes = packet->size;
 696     stats->n_packets = 1;
 697     stats->used = used;
 698 }
 699
 700 /* Appends a human-readable representation of 'stats' to 's'. */
 701 void
 702 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
 703 {
 704     ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
 705                   stats->n_packets, stats->n_bytes);
 706     if (stats->used) {
 707         ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
 708     } else {
 709         ds_put_format(s, "never");
 710     }
 711     if (stats->tcp_flags) {
 712         ds_put_cstr(s, ", flags:");
 713         packet_format_tcp_flags(s, stats->tcp_flags);
 714     }
 715 }
 716
 717 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
 718  * positive errno value.  */
 719 int
 720 dpif_flow_flush(struct dpif *dpif)
 721 {
 722     int error;
 723
 724     COVERAGE_INC(dpif_flow_flush);
 725
 726     error = dpif->dpif_class->flow_flush(dpif);
 727     log_operation(dpif, "flow_flush", error);
 728     return error;
 729 }
 730
 731 /* Queries 'dpif' for a flow entry.  The flow is specified by the Netlink
 732  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
 733  * 'key'.
 734  *
 735  * Returns 0 if successful.  If no flow matches, returns ENOENT.  On other
 736  * failure, returns a positive errno value.
 737  *
 738  * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
 739  * ofpbuf owned by the caller that contains the Netlink attributes for the
 740  * flow's actions.  The caller must free the ofpbuf (with ofpbuf_delete()) when
 741  * it is no longer needed.
 742  *
 743  * If 'stats' is nonnull, then on success it will be updated with the flow's
 744  * statistics. */
 745 int
 746 dpif_flow_get(const struct dpif *dpif,
 747               const struct nlattr *key, size_t key_len,
 748               struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 749 {
 750     int error;
 751
 752     COVERAGE_INC(dpif_flow_get);
 753
 754     error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
 755     if (error) {
 756         if (actionsp) {
 757             *actionsp = NULL;
 758         }
 759         if (stats) {
 760             memset(stats, 0, sizeof *stats);
 761         }
 762     }
 763     if (should_log_flow_message(error)) {
 764         const struct nlattr *actions;
 765         size_t actions_len;
 766
 767         if (!error && actionsp) {
 768             actions = (*actionsp)->data;
 769             actions_len = (*actionsp)->size;
 770         } else {
 771             actions = NULL;
 772             actions_len = 0;
 773         }
 774         log_flow_message(dpif, error, "flow_get", key, key_len, stats,
 775                          actions, actions_len);
 776     }
 777     return error;
 778 }
 779
 780 static int
 781 dpif_flow_put__(struct dpif *dpif, const struct dpif_flow_put *put)
 782 {
 783     int error;
 784
 785     COVERAGE_INC(dpif_flow_put);
 786     assert(!(put->flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY
 787                             | DPIF_FP_ZERO_STATS)));
 788
 789     error = dpif->dpif_class->flow_put(dpif, put);
 790     if (error && put->stats) {
 791         memset(put->stats, 0, sizeof *put->stats);
 792     }
 793     log_flow_put_message(dpif, put, error);
 794     return error;
 795 }
 796
 797 /* Adds or modifies a flow in 'dpif'.  The flow is specified by the Netlink
 798  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
 799  * 'key'.  The associated actions are specified by the Netlink attributes with
 800  * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
 801  *
 802  * - If the flow's key does not exist in 'dpif', then the flow will be added if
 803  *   'flags' includes DPIF_FP_CREATE.  Otherwise the operation will fail with
 804  *   ENOENT.
 805  *
 806  *   If the operation succeeds, then 'stats', if nonnull, will be zeroed.
 807  *
 808  * - If the flow's key does exist in 'dpif', then the flow's actions will be
 809  *   updated if 'flags' includes DPIF_FP_MODIFY.  Otherwise the operation will
 810  *   fail with EEXIST.  If the flow's actions are updated, then its statistics
 811  *   will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
 812  *   otherwise.
 813  *
 814  *   If the operation succeeds, then 'stats', if nonnull, will be set to the
 815  *   flow's statistics before the update.
 816  */
 817 int
 818 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
 819               const struct nlattr *key, size_t key_len,
 820               const struct nlattr *actions, size_t actions_len,
 821               struct dpif_flow_stats *stats)
 822 {
 823     struct dpif_flow_put put;
 824
 825     put.flags = flags;
 826     put.key = key;
 827     put.key_len = key_len;
 828     put.actions = actions;
 829     put.actions_len = actions_len;
 830     put.stats = stats;
 831     return dpif_flow_put__(dpif, &put);
 832 }
 833
 834 static int
 835 dpif_flow_del__(struct dpif *dpif, struct dpif_flow_del *del)
 836 {
 837     int error;
 838
 839     COVERAGE_INC(dpif_flow_del);
 840
 841     error = dpif->dpif_class->flow_del(dpif, del);
 842     if (error && del->stats) {
 843         memset(del->stats, 0, sizeof *del->stats);
 844     }
 845     log_flow_del_message(dpif, del, error);
 846     return error;
 847 }
 848
 849 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
 850  * not contain such a flow.  The flow is specified by the Netlink attributes
 851  * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
 852  *
 853  * If the operation succeeds, then 'stats', if nonnull, will be set to the
 854  * flow's statistics before its deletion. */
 855 int
 856 dpif_flow_del(struct dpif *dpif,
 857               const struct nlattr *key, size_t key_len,
 858               struct dpif_flow_stats *stats)
 859 {
 860     struct dpif_flow_del del;
 861
 862     del.key = key;
 863     del.key_len = key_len;
 864     del.stats = stats;
 865     return dpif_flow_del__(dpif, &del);
 866 }
 867
 868 /* Initializes 'dump' to begin dumping the flows in a dpif.
 869  *
 870  * This function provides no status indication.  An error status for the entire
 871  * dump operation is provided when it is completed by calling
 872  * dpif_flow_dump_done().
 873  */
 874 void
 875 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
 876 {
 877     dump->dpif = dpif;
 878     dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
 879     log_operation(dpif, "flow_dump_start", dump->error);
 880 }
 881
 882 /* Attempts to retrieve another flow from 'dump', which must have been
 883  * initialized with dpif_flow_dump_start().  On success, updates the output
 884  * parameters as described below and returns true.  Otherwise, returns false.
 885  * Failure might indicate an actual error or merely the end of the flow table.
 886  * An error status for the entire dump operation is provided when it is
 887  * completed by calling dpif_flow_dump_done().
 888  *
 889  * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
 890  * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
 891  * dumped flow's key.  If 'actions' and 'actions_len' are nonnull then they are
 892  * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
 893  * dumped flow's actions.  If 'stats' is nonnull then it will be set to the
 894  * dumped flow's statistics.
 895  *
 896  * All of the returned data is owned by 'dpif', not by the caller, and the
 897  * caller must not modify or free it.  'dpif' guarantees that it remains
 898  * accessible and unchanging until at least the next call to 'flow_dump_next'
 899  * or 'flow_dump_done' for 'dump'. */
 900 bool
 901 dpif_flow_dump_next(struct dpif_flow_dump *dump,
 902                     const struct nlattr **key, size_t *key_len,
 903                     const struct nlattr **actions, size_t *actions_len,
 904                     const struct dpif_flow_stats **stats)
 905 {
 906     const struct dpif *dpif = dump->dpif;
 907     int error = dump->error;
 908
 909     if (!error) {
 910         error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
 911                                                  key, key_len,
 912                                                  actions, actions_len,
 913                                                  stats);
 914         if (error) {
 915             dpif->dpif_class->flow_dump_done(dpif, dump->state);
 916         }
 917     }
 918     if (error) {
 919         if (key) {
 920             *key = NULL;
 921             *key_len = 0;
 922         }
 923         if (actions) {
 924             *actions = NULL;
 925             *actions_len = 0;
 926         }
 927         if (stats) {
 928             *stats = NULL;
 929         }
 930     }
 931     if (!dump->error) {
 932         if (error == EOF) {
 933             VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
 934         } else if (should_log_flow_message(error)) {
 935             log_flow_message(dpif, error, "flow_dump",
 936                              key ? *key : NULL, key ? *key_len : 0,
 937                              stats ? *stats : NULL, actions ? *actions : NULL,
 938                              actions ? *actions_len : 0);
 939         }
 940     }
 941     dump->error = error;
 942     return !error;
 943 }
 944
 945 /* Completes flow table dump operation 'dump', which must have been initialized
 946  * with dpif_flow_dump_start().  Returns 0 if the dump operation was
 947  * error-free, otherwise a positive errno value describing the problem. */
 948 int
 949 dpif_flow_dump_done(struct dpif_flow_dump *dump)
 950 {
 951     const struct dpif *dpif = dump->dpif;
 952     if (!dump->error) {
 953         dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
 954         log_operation(dpif, "flow_dump_done", dump->error);
 955     }
 956     return dump->error == EOF ? 0 : dump->error;
 957 }
 958
 959 static int
 960 dpif_execute__(struct dpif *dpif, const struct dpif_execute *execute)
 961 {
 962     int error;
 963
 964     COVERAGE_INC(dpif_execute);
 965     if (execute->actions_len > 0) {
 966         error = dpif->dpif_class->execute(dpif, execute);
 967     } else {
 968         error = 0;
 969     }
 970
 971     log_execute_message(dpif, execute, error);
 972
 973     return error;
 974 }
 975
 976 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
 977  * the Ethernet frame specified in 'packet' taken from the flow specified in
 978  * the 'key_len' bytes of 'key'.  ('key' is mostly redundant with 'packet', but
 979  * it contains some metadata that cannot be recovered from 'packet', such as
 980  * tun_id and in_port.)
 981  *
 982  * Returns 0 if successful, otherwise a positive errno value. */
 983 int
 984 dpif_execute(struct dpif *dpif,
 985              const struct nlattr *key, size_t key_len,
 986              const struct nlattr *actions, size_t actions_len,
 987              const struct ofpbuf *buf)
 988 {
 989     struct dpif_execute execute;
 990
 991     execute.key = key;
 992     execute.key_len = key_len;
 993     execute.actions = actions;
 994     execute.actions_len = actions_len;
 995     execute.packet = buf;
 996     return dpif_execute__(dpif, &execute);
 997 }
 998
 999 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
1000  * which they are specified, placing each operation's results in the "output"
1001  * members documented in comments.
1002  *
1003  * This function exists because some datapaths can perform batched operations
1004  * faster than individual operations. */
1005 void
1006 dpif_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
1007 {
1008     size_t i;
1009
1010     if (dpif->dpif_class->operate) {
1011         dpif->dpif_class->operate(dpif, ops, n_ops);
1012
1013         for (i = 0; i < n_ops; i++) {
1014             struct dpif_op *op = ops[i];
1015
1016             switch (op->type) {
1017             case DPIF_OP_FLOW_PUT:
1018                 log_flow_put_message(dpif, &op->u.flow_put, op->error);
1019                 break;
1020
1021             case DPIF_OP_FLOW_DEL:
1022                 log_flow_del_message(dpif, &op->u.flow_del, op->error);
1023                 break;
1024
1025             case DPIF_OP_EXECUTE:
1026                 log_execute_message(dpif, &op->u.execute, op->error);
1027                 break;
1028             }
1029         }
1030         return;
1031     }
1032
1033     for (i = 0; i < n_ops; i++) {
1034         struct dpif_op *op = ops[i];
1035
1036         switch (op->type) {
1037         case DPIF_OP_FLOW_PUT:
1038             op->error = dpif_flow_put__(dpif, &op->u.flow_put);
1039             break;
1040
1041         case DPIF_OP_FLOW_DEL:
1042             op->error = dpif_flow_del__(dpif, &op->u.flow_del);
1043             break;
1044
1045         case DPIF_OP_EXECUTE:
1046             op->error = dpif_execute__(dpif, &op->u.execute);
1047             break;
1048
1049         default:
1050             NOT_REACHED();
1051         }
1052     }
1053 }
1054
1055
1056 /* Returns a string that represents 'type', for use in log messages. */
1057 const char *
1058 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1059 {
1060     switch (type) {
1061     case DPIF_UC_MISS: return "miss";
1062     case DPIF_UC_ACTION: return "action";
1063     case DPIF_N_UC_TYPES: default: return "<unknown>";
1064     }
1065 }
1066
1067 /* Enables or disables receiving packets with dpif_recv() on 'dpif'.  Returns 0
1068  * if successful, otherwise a positive errno value.
1069  *
1070  * Turning packet receive off and then back on may change the Netlink PID
1071  * assignments returned by dpif_port_get_pid().  If the client does this, it
1072  * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1073  * using the new PID assignment. */
1074 int
1075 dpif_recv_set(struct dpif *dpif, bool enable)
1076 {
1077     int error = dpif->dpif_class->recv_set(dpif, enable);
1078     log_operation(dpif, "recv_set", error);
1079     return error;
1080 }
1081
1082 /* Polls for an upcall from 'dpif'.  If successful, stores the upcall into
1083  * '*upcall', using 'buf' for storage.  Should only be called if
1084  * dpif_recv_set() has been used to enable receiving packets on 'dpif'.
1085  *
1086  * 'upcall->packet' and 'upcall->key' point into data in the caller-provided
1087  * 'buf', so their memory cannot be freed separately from 'buf'.  (This is
1088  * hardly a great way to do things but it works out OK for the dpif providers
1089  * and clients that exist so far.)
1090  *
1091  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
1092  * if no upcall is immediately available. */
1093 int
1094 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall, struct ofpbuf *buf)
1095 {
1096     int error = dpif->dpif_class->recv(dpif, upcall, buf);
1097     if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1098         struct ds flow;
1099         char *packet;
1100
1101         packet = ofp_packet_to_string(upcall->packet->data,
1102                                       upcall->packet->size);
1103
1104         ds_init(&flow);
1105         odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1106
1107         VLOG_DBG("%s: %s upcall:\n%s\n%s",
1108                  dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1109                  ds_cstr(&flow), packet);
1110
1111         ds_destroy(&flow);
1112         free(packet);
1113     } else if (error && error != EAGAIN) {
1114         log_operation(dpif, "recv", error);
1115     }
1116     return error;
1117 }
1118
1119 /* Discards all messages that would otherwise be received by dpif_recv() on
1120  * 'dpif'. */
1121 void
1122 dpif_recv_purge(struct dpif *dpif)
1123 {
1124     COVERAGE_INC(dpif_purge);
1125     if (dpif->dpif_class->recv_purge) {
1126         dpif->dpif_class->recv_purge(dpif);
1127     }
1128 }
1129
1130 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1131  * received with dpif_recv(). */
1132 void
1133 dpif_recv_wait(struct dpif *dpif)
1134 {
1135     dpif->dpif_class->recv_wait(dpif);
1136 }
1137
1138 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1139  * and '*engine_id', respectively. */
1140 void
1141 dpif_get_netflow_ids(const struct dpif *dpif,
1142                      uint8_t *engine_type, uint8_t *engine_id)
1143 {
1144     *engine_type = dpif->netflow_engine_type;
1145     *engine_id = dpif->netflow_engine_id;
1146 }
1147
1148 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1149  * value used for setting packet priority.
1150  * On success, returns 0 and stores the priority into '*priority'.
1151  * On failure, returns a positive errno value and stores 0 into '*priority'. */
1152 int
1153 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1154                        uint32_t *priority)
1155 {
1156     int error = (dpif->dpif_class->queue_to_priority
1157                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1158                                                        priority)
1159                  : EOPNOTSUPP);
1160     if (error) {
1161         *priority = 0;
1162     }
1163     log_operation(dpif, "queue_to_priority", error);
1164     return error;
1165 }
1166 \f
1167 void
1168 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1169           const char *name,
1170           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1171 {
1172     dpif->dpif_class = dpif_class;
1173     dpif->base_name = xstrdup(name);
1174     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1175     dpif->netflow_engine_type = netflow_engine_type;
1176     dpif->netflow_engine_id = netflow_engine_id;
1177 }
1178
1179 /* Undoes the results of initialization.
1180  *
1181  * Normally this function only needs to be called from dpif_close().
1182  * However, it may be called by providers due to an error on opening
1183  * that occurs after initialization.  It this case dpif_close() would
1184  * never be called. */
1185 void
1186 dpif_uninit(struct dpif *dpif, bool close)
1187 {
1188     char *base_name = dpif->base_name;
1189     char *full_name = dpif->full_name;
1190
1191     if (close) {
1192         dpif->dpif_class->close(dpif);
1193     }
1194
1195     free(base_name);
1196     free(full_name);
1197 }
1198 \f
1199 static void
1200 log_operation(const struct dpif *dpif, const char *operation, int error)
1201 {
1202     if (!error) {
1203         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1204     } else if (ofperr_is_valid(error)) {
1205         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1206                      dpif_name(dpif), operation, ofperr_get_name(error));
1207     } else {
1208         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1209                      dpif_name(dpif), operation, strerror(error));
1210     }
1211 }
1212
1213 static enum vlog_level
1214 flow_message_log_level(int error)
1215 {
1216     return error ? VLL_WARN : VLL_DBG;
1217 }
1218
1219 static bool
1220 should_log_flow_message(int error)
1221 {
1222     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1223                              error ? &error_rl : &dpmsg_rl);
1224 }
1225
1226 static void
1227 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1228                  const struct nlattr *key, size_t key_len,
1229                  const struct dpif_flow_stats *stats,
1230                  const struct nlattr *actions, size_t actions_len)
1231 {
1232     struct ds ds = DS_EMPTY_INITIALIZER;
1233     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1234     if (error) {
1235         ds_put_cstr(&ds, "failed to ");
1236     }
1237     ds_put_format(&ds, "%s ", operation);
1238     if (error) {
1239         ds_put_format(&ds, "(%s) ", strerror(error));
1240     }
1241     odp_flow_key_format(key, key_len, &ds);
1242     if (stats) {
1243         ds_put_cstr(&ds, ", ");
1244         dpif_flow_stats_format(stats, &ds);
1245     }
1246     if (actions || actions_len) {
1247         ds_put_cstr(&ds, ", actions:");
1248         format_odp_actions(&ds, actions, actions_len);
1249     }
1250     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1251     ds_destroy(&ds);
1252 }
1253
1254 static void
1255 log_flow_put_message(struct dpif *dpif, const struct dpif_flow_put *put,
1256                      int error)
1257 {
1258     if (should_log_flow_message(error)) {
1259         struct ds s;
1260
1261         ds_init(&s);
1262         ds_put_cstr(&s, "put");
1263         if (put->flags & DPIF_FP_CREATE) {
1264             ds_put_cstr(&s, "[create]");
1265         }
1266         if (put->flags & DPIF_FP_MODIFY) {
1267             ds_put_cstr(&s, "[modify]");
1268         }
1269         if (put->flags & DPIF_FP_ZERO_STATS) {
1270             ds_put_cstr(&s, "[zero]");
1271         }
1272         log_flow_message(dpif, error, ds_cstr(&s),
1273                          put->key, put->key_len, put->stats,
1274                          put->actions, put->actions_len);
1275         ds_destroy(&s);
1276     }
1277 }
1278
1279 static void
1280 log_flow_del_message(struct dpif *dpif, const struct dpif_flow_del *del,
1281                      int error)
1282 {
1283     if (should_log_flow_message(error)) {
1284         log_flow_message(dpif, error, "flow_del", del->key, del->key_len,
1285                          !error ? del->stats : NULL, NULL, 0);
1286     }
1287 }
1288
1289 static void
1290 log_execute_message(struct dpif *dpif, const struct dpif_execute *execute,
1291                     int error)
1292 {
1293     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
1294         struct ds ds = DS_EMPTY_INITIALIZER;
1295         char *packet;
1296
1297         packet = ofp_packet_to_string(execute->packet->data,
1298                                       execute->packet->size);
1299         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
1300         format_odp_actions(&ds, execute->actions, execute->actions_len);
1301         if (error) {
1302             ds_put_format(&ds, " failed (%s)", strerror(error));
1303         }
1304         ds_put_format(&ds, " on packet %s", packet);
1305         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
1306         ds_destroy(&ds);
1307         free(packet);
1308     }
1309 }