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