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