lib/dpif.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "dpif-provider.h"
  19
  20 #include <assert.h>
  21 #include <ctype.h>
  22 #include <errno.h>
  23 #include <inttypes.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "coverage.h"
  28 #include "dynamic-string.h"
  29 #include "flow.h"
  30 #include "netdev.h"
  31 #include "netlink.h"
  32 #include "odp-util.h"
  33 #include "ofp-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 "svec.h"
  40 #include "util.h"
  41 #include "valgrind.h"
  42 #include "vlog.h"
  43
  44 VLOG_DEFINE_THIS_MODULE(dpif);
  45
  46 COVERAGE_DEFINE(dpif_destroy);
  47 COVERAGE_DEFINE(dpif_port_add);
  48 COVERAGE_DEFINE(dpif_port_del);
  49 COVERAGE_DEFINE(dpif_flow_flush);
  50 COVERAGE_DEFINE(dpif_flow_get);
  51 COVERAGE_DEFINE(dpif_flow_put);
  52 COVERAGE_DEFINE(dpif_flow_del);
  53 COVERAGE_DEFINE(dpif_flow_query_list);
  54 COVERAGE_DEFINE(dpif_flow_query_list_n);
  55 COVERAGE_DEFINE(dpif_execute);
  56 COVERAGE_DEFINE(dpif_purge);
  57
  58 static const struct dpif_class *base_dpif_classes[] = {
  59 #ifdef HAVE_NETLINK
  60     &dpif_linux_class,
  61 #endif
  62     &dpif_netdev_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
  71 /* Rate limit for individual messages going to or from the datapath, output at
  72  * DBG level.  This is very high because, if these are enabled, it is because
  73  * we really need to see them. */
  74 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
  75
  76 /* Not really much point in logging many dpif errors. */
  77 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
  78
  79 static void log_operation(const struct dpif *, const char *operation,
  80                           int error);
  81 static void log_flow_operation(const struct dpif *, const char *operation,
  82                                int error, struct odp_flow *flow);
  83 static void log_flow_put(struct dpif *, int error,
  84                          const struct odp_flow_put *);
  85 static bool should_log_flow_message(int error);
  86 static void check_rw_odp_flow(struct odp_flow *);
  87
  88 static void
  89 dp_initialize(void)
  90 {
  91     static int status = -1;
  92
  93     if (status < 0) {
  94         int i;
  95
  96         status = 0;
  97         for (i = 0; i < ARRAY_SIZE(base_dpif_classes); i++) {
  98             dp_register_provider(base_dpif_classes[i]);
  99         }
 100     }
 101 }
 102
 103 /* Performs periodic work needed by all the various kinds of dpifs.
 104  *
 105  * If your program opens any dpifs, it must call both this function and
 106  * netdev_run() within its main poll loop. */
 107 void
 108 dp_run(void)
 109 {
 110     struct shash_node *node;
 111     SHASH_FOR_EACH(node, &dpif_classes) {
 112         const struct registered_dpif_class *registered_class = node->data;
 113         if (registered_class->dpif_class->run) {
 114             registered_class->dpif_class->run();
 115         }
 116     }
 117 }
 118
 119 /* Arranges for poll_block() to wake up when dp_run() needs to be called.
 120  *
 121  * If your program opens any dpifs, it must call both this function and
 122  * netdev_wait() within its main poll loop. */
 123 void
 124 dp_wait(void)
 125 {
 126     struct shash_node *node;
 127     SHASH_FOR_EACH(node, &dpif_classes) {
 128         const struct registered_dpif_class *registered_class = node->data;
 129         if (registered_class->dpif_class->wait) {
 130             registered_class->dpif_class->wait();
 131         }
 132     }
 133 }
 134
 135 /* Registers a new datapath provider.  After successful registration, new
 136  * datapaths of that type can be opened using dpif_open(). */
 137 int
 138 dp_register_provider(const struct dpif_class *new_class)
 139 {
 140     struct registered_dpif_class *registered_class;
 141
 142     if (shash_find(&dpif_classes, new_class->type)) {
 143         VLOG_WARN("attempted to register duplicate datapath provider: %s",
 144                   new_class->type);
 145         return EEXIST;
 146     }
 147
 148     registered_class = xmalloc(sizeof *registered_class);
 149     registered_class->dpif_class = new_class;
 150     registered_class->refcount = 0;
 151
 152     shash_add(&dpif_classes, new_class->type, registered_class);
 153
 154     return 0;
 155 }
 156
 157 /* Unregisters a datapath provider.  'type' must have been previously
 158  * registered and not currently be in use by any dpifs.  After unregistration
 159  * new datapaths of that type cannot be opened using dpif_open(). */
 160 int
 161 dp_unregister_provider(const char *type)
 162 {
 163     struct shash_node *node;
 164     struct registered_dpif_class *registered_class;
 165
 166     node = shash_find(&dpif_classes, type);
 167     if (!node) {
 168         VLOG_WARN("attempted to unregister a datapath provider that is not "
 169                   "registered: %s", type);
 170         return EAFNOSUPPORT;
 171     }
 172
 173     registered_class = node->data;
 174     if (registered_class->refcount) {
 175         VLOG_WARN("attempted to unregister in use datapath provider: %s", type);
 176         return EBUSY;
 177     }
 178
 179     shash_delete(&dpif_classes, node);
 180     free(registered_class);
 181
 182     return 0;
 183 }
 184
 185 /* Clears 'types' and enumerates the types of all currently registered datapath
 186  * providers into it.  The caller must first initialize the svec. */
 187 void
 188 dp_enumerate_types(struct svec *types)
 189 {
 190     struct shash_node *node;
 191
 192     dp_initialize();
 193     svec_clear(types);
 194
 195     SHASH_FOR_EACH(node, &dpif_classes) {
 196         const struct registered_dpif_class *registered_class = node->data;
 197         svec_add(types, registered_class->dpif_class->type);
 198     }
 199 }
 200
 201 /* Clears 'names' and enumerates the names of all known created datapaths with
 202  * the given 'type'.  The caller must first initialize the svec. Returns 0 if
 203  * successful, otherwise a positive errno value.
 204  *
 205  * Some kinds of datapaths might not be practically enumerable.  This is not
 206  * considered an error. */
 207 int
 208 dp_enumerate_names(const char *type, struct svec *names)
 209 {
 210     const struct registered_dpif_class *registered_class;
 211     const struct dpif_class *dpif_class;
 212     int error;
 213
 214     dp_initialize();
 215     svec_clear(names);
 216
 217     registered_class = shash_find_data(&dpif_classes, type);
 218     if (!registered_class) {
 219         VLOG_WARN("could not enumerate unknown type: %s", type);
 220         return EAFNOSUPPORT;
 221     }
 222
 223     dpif_class = registered_class->dpif_class;
 224     error = dpif_class->enumerate ? dpif_class->enumerate(names) : 0;
 225
 226     if (error) {
 227         VLOG_WARN("failed to enumerate %s datapaths: %s", dpif_class->type,
 228                    strerror(error));
 229     }
 230
 231     return error;
 232 }
 233
 234 /* Parses 'datapath name', which is of the form type@name into its
 235  * component pieces.  'name' and 'type' must be freed by the caller. */
 236 void
 237 dp_parse_name(const char *datapath_name_, char **name, char **type)
 238 {
 239     char *datapath_name = xstrdup(datapath_name_);
 240     char *separator;
 241
 242     separator = strchr(datapath_name, '@');
 243     if (separator) {
 244         *separator = '\0';
 245         *type = datapath_name;
 246         *name = xstrdup(separator + 1);
 247     } else {
 248         *name = datapath_name;
 249         *type = NULL;
 250     }
 251 }
 252
 253 static int
 254 do_open(const char *name, const char *type, bool create, struct dpif **dpifp)
 255 {
 256     struct dpif *dpif = NULL;
 257     int error;
 258     struct registered_dpif_class *registered_class;
 259
 260     dp_initialize();
 261
 262     if (!type || *type == '\0') {
 263         type = "system";
 264     }
 265
 266     registered_class = shash_find_data(&dpif_classes, type);
 267     if (!registered_class) {
 268         VLOG_WARN("could not create datapath %s of unknown type %s", name,
 269                   type);
 270         error = EAFNOSUPPORT;
 271         goto exit;
 272     }
 273
 274     error = registered_class->dpif_class->open(registered_class->dpif_class,
 275                                                name, create, &dpif);
 276     if (!error) {
 277         assert(dpif->dpif_class == registered_class->dpif_class);
 278         registered_class->refcount++;
 279     }
 280
 281 exit:
 282     *dpifp = error ? NULL : dpif;
 283     return error;
 284 }
 285
 286 /* Tries to open an existing datapath named 'name' and type 'type'.  Will fail
 287  * if no datapath with 'name' and 'type' exists.  'type' may be either NULL or
 288  * the empty string to specify the default system type.  Returns 0 if
 289  * successful, otherwise a positive errno value.  On success stores a pointer
 290  * to the datapath in '*dpifp', otherwise a null pointer. */
 291 int
 292 dpif_open(const char *name, const char *type, struct dpif **dpifp)
 293 {
 294     return do_open(name, type, false, dpifp);
 295 }
 296
 297 /* Tries to create and open a new datapath with the given 'name' and 'type'.
 298  * 'type' may be either NULL or the empty string to specify the default system
 299  * type.  Will fail if a datapath with 'name' and 'type' already exists.
 300  * Returns 0 if successful, otherwise a positive errno value.  On success
 301  * stores a pointer to the datapath in '*dpifp', otherwise a null pointer. */
 302 int
 303 dpif_create(const char *name, const char *type, struct dpif **dpifp)
 304 {
 305     return do_open(name, type, true, dpifp);
 306 }
 307
 308 /* Tries to open a datapath with the given 'name' and 'type', creating it if it
 309  * does not exist.  'type' may be either NULL or the empty string to specify
 310  * the default system type.  Returns 0 if successful, otherwise a positive
 311  * errno value. On success stores a pointer to the datapath in '*dpifp',
 312  * otherwise a null pointer. */
 313 int
 314 dpif_create_and_open(const char *name, const char *type, struct dpif **dpifp)
 315 {
 316     int error;
 317
 318     error = dpif_create(name, type, dpifp);
 319     if (error == EEXIST || error == EBUSY) {
 320         error = dpif_open(name, type, dpifp);
 321         if (error) {
 322             VLOG_WARN("datapath %s already exists but cannot be opened: %s",
 323                       name, strerror(error));
 324         }
 325     } else if (error) {
 326         VLOG_WARN("failed to create datapath %s: %s", name, strerror(error));
 327     }
 328     return error;
 329 }
 330
 331 /* Closes and frees the connection to 'dpif'.  Does not destroy the datapath
 332  * itself; call dpif_delete() first, instead, if that is desirable. */
 333 void
 334 dpif_close(struct dpif *dpif)
 335 {
 336     if (dpif) {
 337         struct registered_dpif_class *registered_class;
 338
 339         registered_class = shash_find_data(&dpif_classes,
 340                 dpif->dpif_class->type);
 341         assert(registered_class);
 342         assert(registered_class->refcount);
 343
 344         registered_class->refcount--;
 345         dpif_uninit(dpif, true);
 346     }
 347 }
 348
 349 /* Returns the name of datapath 'dpif' prefixed with the type
 350  * (for use in log messages). */
 351 const char *
 352 dpif_name(const struct dpif *dpif)
 353 {
 354     return dpif->full_name;
 355 }
 356
 357 /* Returns the name of datapath 'dpif' without the type
 358  * (for use in device names). */
 359 const char *
 360 dpif_base_name(const struct dpif *dpif)
 361 {
 362     return dpif->base_name;
 363 }
 364
 365 /* Enumerates all names that may be used to open 'dpif' into 'all_names'.  The
 366  * Linux datapath, for example, supports opening a datapath both by number,
 367  * e.g. "dp0", and by the name of the datapath's local port.  For some
 368  * datapaths, this might be an infinite set (e.g. in a file name, slashes may
 369  * be duplicated any number of times), in which case only the names most likely
 370  * to be used will be enumerated.
 371  *
 372  * The caller must already have initialized 'all_names'.  Any existing names in
 373  * 'all_names' will not be disturbed. */
 374 int
 375 dpif_get_all_names(const struct dpif *dpif, struct svec *all_names)
 376 {
 377     if (dpif->dpif_class->get_all_names) {
 378         int error = dpif->dpif_class->get_all_names(dpif, all_names);
 379         if (error) {
 380             VLOG_WARN_RL(&error_rl,
 381                          "failed to retrieve names for datpath %s: %s",
 382                          dpif_name(dpif), strerror(error));
 383         }
 384         return error;
 385     } else {
 386         svec_add(all_names, dpif_base_name(dpif));
 387         return 0;
 388     }
 389 }
 390
 391
 392 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
 393  * ports.  After calling this function, it does not make sense to pass 'dpif'
 394  * to any functions other than dpif_name() or dpif_close(). */
 395 int
 396 dpif_delete(struct dpif *dpif)
 397 {
 398     int error;
 399
 400     COVERAGE_INC(dpif_destroy);
 401
 402     error = dpif->dpif_class->destroy(dpif);
 403     log_operation(dpif, "delete", error);
 404     return error;
 405 }
 406
 407 /* Retrieves statistics for 'dpif' into 'stats'.  Returns 0 if successful,
 408  * otherwise a positive errno value. */
 409 int
 410 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
 411 {
 412     int error = dpif->dpif_class->get_stats(dpif, stats);
 413     if (error) {
 414         memset(stats, 0, sizeof *stats);
 415     }
 416     log_operation(dpif, "get_stats", error);
 417     return error;
 418 }
 419
 420 /* Retrieves the current IP fragment handling policy for 'dpif' into
 421  * '*drop_frags': true indicates that fragments are dropped, false indicates
 422  * that fragments are treated in the same way as other IP packets (except that
 423  * the L4 header cannot be read).  Returns 0 if successful, otherwise a
 424  * positive errno value. */
 425 int
 426 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
 427 {
 428     int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
 429     if (error) {
 430         *drop_frags = false;
 431     }
 432     log_operation(dpif, "get_drop_frags", error);
 433     return error;
 434 }
 435
 436 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
 437  * the same as for the get_drop_frags member function.  Returns 0 if
 438  * successful, otherwise a positive errno value. */
 439 int
 440 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
 441 {
 442     int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
 443     log_operation(dpif, "set_drop_frags", error);
 444     return error;
 445 }
 446
 447 /* Attempts to add 'netdev' as a port on 'dpif'.  If successful, returns 0 and
 448  * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
 449  * On failure, returns a positive errno value and sets '*port_nop' to
 450  * UINT16_MAX (if 'port_nop' is non-null). */
 451 int
 452 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
 453 {
 454     const char *netdev_name = netdev_get_name(netdev);
 455     uint16_t port_no;
 456     int error;
 457
 458     COVERAGE_INC(dpif_port_add);
 459
 460     error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
 461     if (!error) {
 462         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
 463                     dpif_name(dpif), netdev_name, port_no);
 464     } else {
 465         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
 466                      dpif_name(dpif), netdev_name, strerror(error));
 467         port_no = UINT16_MAX;
 468     }
 469     if (port_nop) {
 470         *port_nop = port_no;
 471     }
 472     return error;
 473 }
 474
 475 /* Attempts to remove 'dpif''s port number 'port_no'.  Returns 0 if successful,
 476  * otherwise a positive errno value. */
 477 int
 478 dpif_port_del(struct dpif *dpif, uint16_t port_no)
 479 {
 480     int error;
 481
 482     COVERAGE_INC(dpif_port_del);
 483
 484     error = dpif->dpif_class->port_del(dpif, port_no);
 485     log_operation(dpif, "port_del", error);
 486     return error;
 487 }
 488
 489 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and
 490  * initializes '*port' appropriately; on failure, returns a positive errno
 491  * value. */
 492 int
 493 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 494                           struct odp_port *port)
 495 {
 496     int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
 497     if (!error) {
 498         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
 499                     dpif_name(dpif), port_no, port->devname);
 500     } else {
 501         memset(port, 0, sizeof *port);
 502         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
 503                      dpif_name(dpif), port_no, strerror(error));
 504     }
 505     return error;
 506 }
 507
 508 /* Looks up port named 'devname' in 'dpif'.  On success, returns 0 and
 509  * initializes '*port' appropriately; on failure, returns a positive errno
 510  * value. */
 511 int
 512 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
 513                         struct odp_port *port)
 514 {
 515     int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
 516     if (!error) {
 517         VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
 518                     dpif_name(dpif), devname, port->port);
 519     } else {
 520         memset(port, 0, sizeof *port);
 521
 522         /* Log level is DBG here because all the current callers are interested
 523          * in whether 'dpif' actually has a port 'devname', so that it's not an
 524          * issue worth logging if it doesn't. */
 525         VLOG_DBG_RL(&error_rl, "%s: failed to query port %s: %s",
 526                     dpif_name(dpif), devname, strerror(error));
 527     }
 528     return error;
 529 }
 530
 531 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
 532  * the port's name into the 'name_size' bytes in 'name', ensuring that the
 533  * result is null-terminated.  On failure, returns a positive errno value and
 534  * makes 'name' the empty string. */
 535 int
 536 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
 537                    char *name, size_t name_size)
 538 {
 539     struct odp_port port;
 540     int error;
 541
 542     assert(name_size > 0);
 543
 544     error = dpif_port_query_by_number(dpif, port_no, &port);
 545     if (!error) {
 546         ovs_strlcpy(name, port.devname, name_size);
 547     } else {
 548         *name = '\0';
 549     }
 550     return error;
 551 }
 552
 553 /* Obtains a list of all the ports in 'dpif'.
 554  *
 555  * If successful, returns 0 and sets '*portsp' to point to an array of
 556  * appropriately initialized port structures and '*n_portsp' to the number of
 557  * ports in the array.  The caller is responsible for freeing '*portp' by
 558  * calling free().
 559  *
 560  * On failure, returns a positive errno value and sets '*portsp' to NULL and
 561  * '*n_portsp' to 0. */
 562 int
 563 dpif_port_list(const struct dpif *dpif,
 564                struct odp_port **portsp, size_t *n_portsp)
 565 {
 566     struct odp_port *ports;
 567     size_t n_ports = 0;
 568     int error;
 569
 570     for (;;) {
 571         struct odp_stats stats;
 572         int retval;
 573
 574         error = dpif_get_dp_stats(dpif, &stats);
 575         if (error) {
 576             goto exit;
 577         }
 578
 579         ports = xcalloc(stats.n_ports, sizeof *ports);
 580         retval = dpif->dpif_class->port_list(dpif, ports, stats.n_ports);
 581         if (retval < 0) {
 582             /* Hard error. */
 583             error = -retval;
 584             free(ports);
 585             goto exit;
 586         } else if (retval <= stats.n_ports) {
 587             /* Success. */
 588             error = 0;
 589             n_ports = retval;
 590             goto exit;
 591         } else {
 592             /* Soft error: port count increased behind our back.  Try again. */
 593             free(ports);
 594         }
 595     }
 596
 597 exit:
 598     if (error) {
 599         *portsp = NULL;
 600         *n_portsp = 0;
 601     } else {
 602         *portsp = ports;
 603         *n_portsp = n_ports;
 604     }
 605     log_operation(dpif, "port_list", error);
 606     return error;
 607 }
 608
 609 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
 610  * 'dpif' has changed, this function does one of the following:
 611  *
 612  * - Stores the name of the device that was added to or deleted from 'dpif' in
 613  *   '*devnamep' and returns 0.  The caller is responsible for freeing
 614  *   '*devnamep' (with free()) when it no longer needs it.
 615  *
 616  * - Returns ENOBUFS and sets '*devnamep' to NULL.
 617  *
 618  * This function may also return 'false positives', where it returns 0 and
 619  * '*devnamep' names a device that was not actually added or deleted or it
 620  * returns ENOBUFS without any change.
 621  *
 622  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
 623  * return other positive errno values to indicate that something has gone
 624  * wrong. */
 625 int
 626 dpif_port_poll(const struct dpif *dpif, char **devnamep)
 627 {
 628     int error = dpif->dpif_class->port_poll(dpif, devnamep);
 629     if (error) {
 630         *devnamep = NULL;
 631     }
 632     return error;
 633 }
 634
 635 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
 636  * value other than EAGAIN. */
 637 void
 638 dpif_port_poll_wait(const struct dpif *dpif)
 639 {
 640     dpif->dpif_class->port_poll_wait(dpif);
 641 }
 642
 643 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
 644  * positive errno value.  */
 645 int
 646 dpif_flow_flush(struct dpif *dpif)
 647 {
 648     int error;
 649
 650     COVERAGE_INC(dpif_flow_flush);
 651
 652     error = dpif->dpif_class->flow_flush(dpif);
 653     log_operation(dpif, "flow_flush", error);
 654     return error;
 655 }
 656
 657 /* Queries 'dpif' for a flow entry matching 'flow->key'.
 658  *
 659  * If a flow matching 'flow->key' exists in 'dpif', stores statistics for the
 660  * flow into 'flow->stats'.  If 'flow->n_actions' is zero, then 'flow->actions'
 661  * is ignored.  If 'flow->n_actions' is nonzero, then 'flow->actions' should
 662  * point to an array of the specified number of actions.  At most that many of
 663  * the flow's actions will be copied into that array.  'flow->n_actions' will
 664  * be updated to the number of actions actually present in the flow, which may
 665  * be greater than the number stored if the flow has more actions than space
 666  * available in the array.
 667  *
 668  * If no flow matching 'flow->key' exists in 'dpif', returns ENOENT.  On other
 669  * failure, returns a positive errno value. */
 670 int
 671 dpif_flow_get(const struct dpif *dpif, struct odp_flow *flow)
 672 {
 673     int error;
 674
 675     COVERAGE_INC(dpif_flow_get);
 676
 677     check_rw_odp_flow(flow);
 678     error = dpif->dpif_class->flow_get(dpif, flow, 1);
 679     if (!error) {
 680         error = flow->stats.error;
 681     }
 682     if (error) {
 683         /* Make the results predictable on error. */
 684         memset(&flow->stats, 0, sizeof flow->stats);
 685         flow->n_actions = 0;
 686     }
 687     if (should_log_flow_message(error)) {
 688         log_flow_operation(dpif, "flow_get", error, flow);
 689     }
 690     return error;
 691 }
 692
 693 /* For each flow 'flow' in the 'n' flows in 'flows':
 694  *
 695  * - If a flow matching 'flow->key' exists in 'dpif':
 696  *
 697  *     Stores 0 into 'flow->stats.error' and stores statistics for the flow
 698  *     into 'flow->stats'.
 699  *
 700  *     If 'flow->n_actions' is zero, then 'flow->actions' is ignored.  If
 701  *     'flow->n_actions' is nonzero, then 'flow->actions' should point to an
 702  *     array of the specified number of actions.  At most that many of the
 703  *     flow's actions will be copied into that array.  'flow->n_actions' will
 704  *     be updated to the number of actions actually present in the flow, which
 705  *     may be greater than the number stored if the flow has more actions than
 706  *     space available in the array.
 707  *
 708  * - Flow-specific errors are indicated by a positive errno value in
 709  *   'flow->stats.error'.  In particular, ENOENT indicates that no flow
 710  *   matching 'flow->key' exists in 'dpif'.  When an error value is stored, the
 711  *   contents of 'flow->key' are preserved but other members of 'flow' should
 712  *   be treated as indeterminate.
 713  *
 714  * Returns 0 if all 'n' flows in 'flows' were updated (whether they were
 715  * individually successful or not is indicated by 'flow->stats.error',
 716  * however).  Returns a positive errno value if an error that prevented this
 717  * update occurred, in which the caller must not depend on any elements in
 718  * 'flows' being updated or not updated.
 719  */
 720 int
 721 dpif_flow_get_multiple(const struct dpif *dpif,
 722                        struct odp_flow flows[], size_t n)
 723 {
 724     int error;
 725     size_t i;
 726
 727     COVERAGE_ADD(dpif_flow_get, n);
 728
 729     for (i = 0; i < n; i++) {
 730         check_rw_odp_flow(&flows[i]);
 731     }
 732
 733     error = dpif->dpif_class->flow_get(dpif, flows, n);
 734     log_operation(dpif, "flow_get_multiple", error);
 735     return error;
 736 }
 737
 738 /* Adds or modifies a flow in 'dpif' as specified in 'put':
 739  *
 740  * - If the flow specified in 'put->flow' does not exist in 'dpif', then
 741  *   behavior depends on whether ODPPF_CREATE is specified in 'put->flags': if
 742  *   it is, the flow will be added, otherwise the operation will fail with
 743  *   ENOENT.
 744  *
 745  * - Otherwise, the flow specified in 'put->flow' does exist in 'dpif'.
 746  *   Behavior in this case depends on whether ODPPF_MODIFY is specified in
 747  *   'put->flags': if it is, the flow's actions will be updated, otherwise the
 748  *   operation will fail with EEXIST.  If the flow's actions are updated, then
 749  *   its statistics will be zeroed if ODPPF_ZERO_STATS is set in 'put->flags',
 750  *   left as-is otherwise.
 751  *
 752  * Returns 0 if successful, otherwise a positive errno value.
 753  */
 754 int
 755 dpif_flow_put(struct dpif *dpif, struct odp_flow_put *put)
 756 {
 757     int error;
 758
 759     COVERAGE_INC(dpif_flow_put);
 760
 761     error = dpif->dpif_class->flow_put(dpif, put);
 762     if (should_log_flow_message(error)) {
 763         log_flow_put(dpif, error, put);
 764     }
 765     return error;
 766 }
 767
 768 /* Deletes a flow matching 'flow->key' from 'dpif' or returns ENOENT if 'dpif'
 769  * does not contain such a flow.
 770  *
 771  * If successful, updates 'flow->stats', 'flow->n_actions', and 'flow->actions'
 772  * as described for dpif_flow_get(). */
 773 int
 774 dpif_flow_del(struct dpif *dpif, struct odp_flow *flow)
 775 {
 776     int error;
 777
 778     COVERAGE_INC(dpif_flow_del);
 779
 780     check_rw_odp_flow(flow);
 781     memset(&flow->stats, 0, sizeof flow->stats);
 782
 783     error = dpif->dpif_class->flow_del(dpif, flow);
 784     if (should_log_flow_message(error)) {
 785         log_flow_operation(dpif, "delete flow", error, flow);
 786     }
 787     return error;
 788 }
 789
 790 /* Stores up to 'n' flows in 'dpif' into 'flows', including their statistics
 791  * but not including any information about their actions.  If successful,
 792  * returns 0 and sets '*n_out' to the number of flows actually present in
 793  * 'dpif', which might be greater than the number stored (if 'dpif' has more
 794  * than 'n' flows).  On failure, returns a negative errno value and sets
 795  * '*n_out' to 0. */
 796 int
 797 dpif_flow_list(const struct dpif *dpif, struct odp_flow flows[], size_t n,
 798                size_t *n_out)
 799 {
 800     uint32_t i;
 801     int retval;
 802
 803     COVERAGE_INC(dpif_flow_query_list);
 804     if (RUNNING_ON_VALGRIND) {
 805         memset(flows, 0, n * sizeof *flows);
 806     } else {
 807         for (i = 0; i < n; i++) {
 808             flows[i].actions = NULL;
 809             flows[i].n_actions = 0;
 810         }
 811     }
 812     retval = dpif->dpif_class->flow_list(dpif, flows, n);
 813     if (retval < 0) {
 814         *n_out = 0;
 815         VLOG_WARN_RL(&error_rl, "%s: flow list failed (%s)",
 816                      dpif_name(dpif), strerror(-retval));
 817         return -retval;
 818     } else {
 819         COVERAGE_ADD(dpif_flow_query_list_n, retval);
 820         *n_out = MIN(n, retval);
 821         VLOG_DBG_RL(&dpmsg_rl, "%s: listed %zu flows (of %d)",
 822                     dpif_name(dpif), *n_out, retval);
 823         return 0;
 824     }
 825 }
 826
 827 /* Retrieves all of the flows in 'dpif'.
 828  *
 829  * If successful, returns 0 and stores in '*flowsp' a pointer to a newly
 830  * allocated array of flows, including their statistics but not including any
 831  * information about their actions, and sets '*np' to the number of flows in
 832  * '*flowsp'.  The caller is responsible for freeing '*flowsp' by calling
 833  * free().
 834  *
 835  * On failure, returns a positive errno value and sets '*flowsp' to NULL and
 836  * '*np' to 0. */
 837 int
 838 dpif_flow_list_all(const struct dpif *dpif,
 839                    struct odp_flow **flowsp, size_t *np)
 840 {
 841     struct odp_stats stats;
 842     struct odp_flow *flows;
 843     size_t n_flows;
 844     int error;
 845
 846     *flowsp = NULL;
 847     *np = 0;
 848
 849     error = dpif_get_dp_stats(dpif, &stats);
 850     if (error) {
 851         return error;
 852     }
 853
 854     flows = xmalloc(sizeof *flows * stats.n_flows);
 855     error = dpif_flow_list(dpif, flows, stats.n_flows, &n_flows);
 856     if (error) {
 857         free(flows);
 858         return error;
 859     }
 860
 861     if (stats.n_flows != n_flows) {
 862         VLOG_WARN_RL(&error_rl, "%s: datapath stats reported %"PRIu32" "
 863                      "flows but flow listing reported %zu",
 864                      dpif_name(dpif), stats.n_flows, n_flows);
 865     }
 866     *flowsp = flows;
 867     *np = n_flows;
 868     return 0;
 869 }
 870
 871 /* Causes 'dpif' to perform the 'n_actions' actions in 'actions' on the
 872  * Ethernet frame specified in 'packet'.
 873  *
 874  * Returns 0 if successful, otherwise a positive errno value. */
 875 int
 876 dpif_execute(struct dpif *dpif,
 877              const union odp_action actions[], size_t n_actions,
 878              const struct ofpbuf *buf)
 879 {
 880     int error;
 881
 882     COVERAGE_INC(dpif_execute);
 883     if (n_actions > 0) {
 884         error = dpif->dpif_class->execute(dpif, actions, n_actions, buf);
 885     } else {
 886         error = 0;
 887     }
 888
 889     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
 890         struct ds ds = DS_EMPTY_INITIALIZER;
 891         char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
 892         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
 893         format_odp_actions(&ds, actions, n_actions);
 894         if (error) {
 895             ds_put_format(&ds, " failed (%s)", strerror(error));
 896         }
 897         ds_put_format(&ds, " on packet %s", packet);
 898         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
 899         ds_destroy(&ds);
 900         free(packet);
 901     }
 902     return error;
 903 }
 904
 905 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'.  Each ODPL_* bit set
 906  * in '*listen_mask' indicates that dpif_recv() will receive messages of that
 907  * type.  Returns 0 if successful, otherwise a positive errno value. */
 908 int
 909 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
 910 {
 911     int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
 912     if (error) {
 913         *listen_mask = 0;
 914     }
 915     log_operation(dpif, "recv_get_mask", error);
 916     return error;
 917 }
 918
 919 /* Sets 'dpif''s "listen mask" to 'listen_mask'.  Each ODPL_* bit set in
 920  * '*listen_mask' requests that dpif_recv() receive messages of that type.
 921  * Returns 0 if successful, otherwise a positive errno value. */
 922 int
 923 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
 924 {
 925     int error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
 926     log_operation(dpif, "recv_set_mask", error);
 927     return error;
 928 }
 929
 930 /* Retrieve the sFlow sampling probability.  '*probability' is expressed as the
 931  * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
 932  * the probability of sampling a given packet.
 933  *
 934  * Returns 0 if successful, otherwise a positive errno value.  EOPNOTSUPP
 935  * indicates that 'dpif' does not support sFlow sampling. */
 936 int
 937 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
 938 {
 939     int error = (dpif->dpif_class->get_sflow_probability
 940                  ? dpif->dpif_class->get_sflow_probability(dpif, probability)
 941                  : EOPNOTSUPP);
 942     if (error) {
 943         *probability = 0;
 944     }
 945     log_operation(dpif, "get_sflow_probability", error);
 946     return error;
 947 }
 948
 949 /* Set the sFlow sampling probability.  'probability' is expressed as the
 950  * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
 951  * the probability of sampling a given packet.
 952  *
 953  * Returns 0 if successful, otherwise a positive errno value.  EOPNOTSUPP
 954  * indicates that 'dpif' does not support sFlow sampling. */
 955 int
 956 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
 957 {
 958     int error = (dpif->dpif_class->set_sflow_probability
 959                  ? dpif->dpif_class->set_sflow_probability(dpif, probability)
 960                  : EOPNOTSUPP);
 961     log_operation(dpif, "set_sflow_probability", error);
 962     return error;
 963 }
 964
 965 /* Attempts to receive a message from 'dpif'.  If successful, stores the
 966  * message into '*packetp'.  The message, if one is received, will begin with
 967  * 'struct odp_msg' as a header, and will have at least DPIF_RECV_MSG_PADDING
 968  * bytes of headroom.  Only messages of the types selected with
 969  * dpif_set_listen_mask() will ordinarily be received (but if a message type is
 970  * enabled and then later disabled, some stragglers might pop up).
 971  *
 972  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
 973  * if no message is immediately available. */
 974 int
 975 dpif_recv(struct dpif *dpif, struct ofpbuf **packetp)
 976 {
 977     int error = dpif->dpif_class->recv(dpif, packetp);
 978     if (!error) {
 979         struct ofpbuf *buf = *packetp;
 980
 981         assert(ofpbuf_headroom(buf) >= DPIF_RECV_MSG_PADDING);
 982         if (VLOG_IS_DBG_ENABLED()) {
 983             struct odp_msg *msg = buf->data;
 984             void *payload = msg + 1;
 985             size_t payload_len = buf->size - sizeof *msg;
 986             char *s = ofp_packet_to_string(payload, payload_len, payload_len);
 987             VLOG_DBG_RL(&dpmsg_rl, "%s: received %s message of length "
 988                         "%zu on port %"PRIu16": %s", dpif_name(dpif),
 989                         (msg->type == _ODPL_MISS_NR ? "miss"
 990                          : msg->type == _ODPL_ACTION_NR ? "action"
 991                          : msg->type == _ODPL_SFLOW_NR ? "sFlow"
 992                          : "<unknown>"),
 993                         payload_len, msg->port, s);
 994             free(s);
 995         }
 996     } else {
 997         *packetp = NULL;
 998     }
 999     return error;
1000 }
1001
1002 /* Discards all messages that would otherwise be received by dpif_recv() on
1003  * 'dpif'.  Returns 0 if successful, otherwise a positive errno value. */
1004 int
1005 dpif_recv_purge(struct dpif *dpif)
1006 {
1007     struct odp_stats stats;
1008     unsigned int i;
1009     int error;
1010
1011     COVERAGE_INC(dpif_purge);
1012
1013     error = dpif_get_dp_stats(dpif, &stats);
1014     if (error) {
1015         return error;
1016     }
1017
1018     for (i = 0; i < stats.max_miss_queue + stats.max_action_queue + stats.max_sflow_queue; i++) {
1019         struct ofpbuf *buf;
1020         error = dpif_recv(dpif, &buf);
1021         if (error) {
1022             return error == EAGAIN ? 0 : error;
1023         }
1024         ofpbuf_delete(buf);
1025     }
1026     return 0;
1027 }
1028
1029 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1030  * received with dpif_recv(). */
1031 void
1032 dpif_recv_wait(struct dpif *dpif)
1033 {
1034     dpif->dpif_class->recv_wait(dpif);
1035 }
1036
1037 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1038  * and '*engine_id', respectively. */
1039 void
1040 dpif_get_netflow_ids(const struct dpif *dpif,
1041                      uint8_t *engine_type, uint8_t *engine_id)
1042 {
1043     *engine_type = dpif->netflow_engine_type;
1044     *engine_id = dpif->netflow_engine_id;
1045 }
1046
1047 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1048  * value for use in the ODPAT_SET_PRIORITY action.  On success, returns 0 and
1049  * stores the priority into '*priority'.  On failure, returns a positive errno
1050  * value and stores 0 into '*priority'. */
1051 int
1052 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1053                        uint32_t *priority)
1054 {
1055     int error = (dpif->dpif_class->queue_to_priority
1056                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1057                                                        priority)
1058                  : EOPNOTSUPP);
1059     if (error) {
1060         *priority = 0;
1061     }
1062     log_operation(dpif, "queue_to_priority", error);
1063     return error;
1064 }
1065 \f
1066 void
1067 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1068           const char *name,
1069           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1070 {
1071     dpif->dpif_class = dpif_class;
1072     dpif->base_name = xstrdup(name);
1073     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1074     dpif->netflow_engine_type = netflow_engine_type;
1075     dpif->netflow_engine_id = netflow_engine_id;
1076 }
1077
1078 /* Undoes the results of initialization.
1079  *
1080  * Normally this function only needs to be called from dpif_close().
1081  * However, it may be called by providers due to an error on opening
1082  * that occurs after initialization.  It this case dpif_close() would
1083  * never be called. */
1084 void
1085 dpif_uninit(struct dpif *dpif, bool close)
1086 {
1087     char *base_name = dpif->base_name;
1088     char *full_name = dpif->full_name;
1089
1090     if (close) {
1091         dpif->dpif_class->close(dpif);
1092     }
1093
1094     free(base_name);
1095     free(full_name);
1096 }
1097 \f
1098 static void
1099 log_operation(const struct dpif *dpif, const char *operation, int error)
1100 {
1101     if (!error) {
1102         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1103     } else if (is_errno(error)) {
1104         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1105                      dpif_name(dpif), operation, strerror(error));
1106     } else {
1107         VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1108                      dpif_name(dpif), operation,
1109                      get_ofp_err_type(error), get_ofp_err_code(error));
1110     }
1111 }
1112
1113 static enum vlog_level
1114 flow_message_log_level(int error)
1115 {
1116     return error ? VLL_WARN : VLL_DBG;
1117 }
1118
1119 static bool
1120 should_log_flow_message(int error)
1121 {
1122     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1123                              error ? &error_rl : &dpmsg_rl);
1124 }
1125
1126 static void
1127 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1128                  const struct odp_flow_key *flow,
1129                  const struct odp_flow_stats *stats,
1130                  const union odp_action *actions, size_t n_actions)
1131 {
1132     struct ds ds = DS_EMPTY_INITIALIZER;
1133     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1134     if (error) {
1135         ds_put_cstr(&ds, "failed to ");
1136     }
1137     ds_put_format(&ds, "%s ", operation);
1138     if (error) {
1139         ds_put_format(&ds, "(%s) ", strerror(error));
1140     }
1141     format_odp_flow_key(&ds, flow);
1142     if (stats) {
1143         ds_put_cstr(&ds, ", ");
1144         format_odp_flow_stats(&ds, stats);
1145     }
1146     if (actions || n_actions) {
1147         ds_put_cstr(&ds, ", actions:");
1148         format_odp_actions(&ds, actions, n_actions);
1149     }
1150     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1151     ds_destroy(&ds);
1152 }
1153
1154 static void
1155 log_flow_operation(const struct dpif *dpif, const char *operation, int error,
1156                    struct odp_flow *flow)
1157 {
1158     if (error) {
1159         flow->n_actions = 0;
1160     }
1161     log_flow_message(dpif, error, operation, &flow->key,
1162                      !error ? &flow->stats : NULL,
1163                      flow->actions, flow->n_actions);
1164 }
1165
1166 static void
1167 log_flow_put(struct dpif *dpif, int error, const struct odp_flow_put *put)
1168 {
1169     enum { ODPPF_ALL = ODPPF_CREATE | ODPPF_MODIFY | ODPPF_ZERO_STATS };
1170     struct ds s;
1171
1172     ds_init(&s);
1173     ds_put_cstr(&s, "put");
1174     if (put->flags & ODPPF_CREATE) {
1175         ds_put_cstr(&s, "[create]");
1176     }
1177     if (put->flags & ODPPF_MODIFY) {
1178         ds_put_cstr(&s, "[modify]");
1179     }
1180     if (put->flags & ODPPF_ZERO_STATS) {
1181         ds_put_cstr(&s, "[zero]");
1182     }
1183     if (put->flags & ~ODPPF_ALL) {
1184         ds_put_format(&s, "[%x]", put->flags & ~ODPPF_ALL);
1185     }
1186     log_flow_message(dpif, error, ds_cstr(&s), &put->flow.key,
1187                      !error ? &put->flow.stats : NULL,
1188                      put->flow.actions, put->flow.n_actions);
1189     ds_destroy(&s);
1190 }
1191
1192 /* There is a tendency to construct odp_flow objects on the stack and to
1193  * forget to properly initialize their "actions" and "n_actions" members.
1194  * When this happens, we get memory corruption because the kernel
1195  * writes through the random pointer that is in the "actions" member.
1196  *
1197  * This function attempts to combat the problem by:
1198  *
1199  *      - Forcing a segfault if "actions" points to an invalid region (instead
1200  *        of just getting back EFAULT, which can be easily missed in the log).
1201  *
1202  *      - Storing a distinctive value that is likely to cause an
1203  *        easy-to-identify error later if it is dereferenced, etc.
1204  *
1205  *      - Triggering a warning on uninitialized memory from Valgrind if
1206  *        "actions" or "n_actions" was not initialized.
1207  */
1208 static void
1209 check_rw_odp_flow(struct odp_flow *flow)
1210 {
1211     if (flow->n_actions) {
1212         memset(&flow->actions[0], 0xcc, sizeof flow->actions[0]);
1213     }
1214 }