lib/dpif.c

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