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