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