lib/dpif.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 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 "sset.h"
  40 #include "timeval.h"
  41 #include "util.h"
  42 #include "valgrind.h"
  43 #include "vlog.h"
  44
  45 VLOG_DEFINE_THIS_MODULE(dpif);
  46
  47 COVERAGE_DEFINE(dpif_destroy);
  48 COVERAGE_DEFINE(dpif_port_add);
  49 COVERAGE_DEFINE(dpif_port_del);
  50 COVERAGE_DEFINE(dpif_flow_flush);
  51 COVERAGE_DEFINE(dpif_flow_get);
  52 COVERAGE_DEFINE(dpif_flow_put);
  53 COVERAGE_DEFINE(dpif_flow_del);
  54 COVERAGE_DEFINE(dpif_flow_query_list);
  55 COVERAGE_DEFINE(dpif_flow_query_list_n);
  56 COVERAGE_DEFINE(dpif_execute);
  57 COVERAGE_DEFINE(dpif_purge);
  58
  59 static const struct dpif_class *base_dpif_classes[] = {
  60 #ifdef HAVE_NETLINK
  61     &dpif_linux_class,
  62 #endif
  63     &dpif_netdev_class,
  64 };
  65
  66 struct registered_dpif_class {
  67     const struct dpif_class *dpif_class;
  68     int refcount;
  69 };
  70 static struct shash dpif_classes = SHASH_INITIALIZER(&dpif_classes);
  71
  72 /* Rate limit for individual messages going to or from the datapath, output at
  73  * DBG level.  This is very high because, if these are enabled, it is because
  74  * we really need to see them. */
  75 static struct vlog_rate_limit dpmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
  76
  77 /* Not really much point in logging many dpif errors. */
  78 static struct vlog_rate_limit error_rl = VLOG_RATE_LIMIT_INIT(60, 5);
  79
  80 static void log_flow_message(const struct dpif *dpif, int error,
  81                              const char *operation,
  82                              const struct nlattr *key, size_t key_len,
  83                              const struct dpif_flow_stats *stats,
  84                              const struct nlattr *actions, size_t actions_len);
  85 static void log_operation(const struct dpif *, const char *operation,
  86                           int error);
  87 static bool should_log_flow_message(int error);
  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 sset. */
 188 void
 189 dp_enumerate_types(struct sset *types)
 190 {
 191     struct shash_node *node;
 192
 193     dp_initialize();
 194     sset_clear(types);
 195
 196     SHASH_FOR_EACH(node, &dpif_classes) {
 197         const struct registered_dpif_class *registered_class = node->data;
 198         sset_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 sset.  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 sset *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     sset_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 /* Destroys the datapath that 'dpif' is connected to, first removing all of its
 367  * ports.  After calling this function, it does not make sense to pass 'dpif'
 368  * to any functions other than dpif_name() or dpif_close(). */
 369 int
 370 dpif_delete(struct dpif *dpif)
 371 {
 372     int error;
 373
 374     COVERAGE_INC(dpif_destroy);
 375
 376     error = dpif->dpif_class->destroy(dpif);
 377     log_operation(dpif, "delete", error);
 378     return error;
 379 }
 380
 381 /* Retrieves statistics for 'dpif' into 'stats'.  Returns 0 if successful,
 382  * otherwise a positive errno value. */
 383 int
 384 dpif_get_dp_stats(const struct dpif *dpif, struct odp_stats *stats)
 385 {
 386     int error = dpif->dpif_class->get_stats(dpif, stats);
 387     if (error) {
 388         memset(stats, 0, sizeof *stats);
 389     }
 390     log_operation(dpif, "get_stats", error);
 391     return error;
 392 }
 393
 394 /* Retrieves the current IP fragment handling policy for 'dpif' into
 395  * '*drop_frags': true indicates that fragments are dropped, false indicates
 396  * that fragments are treated in the same way as other IP packets (except that
 397  * the L4 header cannot be read).  Returns 0 if successful, otherwise a
 398  * positive errno value. */
 399 int
 400 dpif_get_drop_frags(const struct dpif *dpif, bool *drop_frags)
 401 {
 402     int error = dpif->dpif_class->get_drop_frags(dpif, drop_frags);
 403     if (error) {
 404         *drop_frags = false;
 405     }
 406     log_operation(dpif, "get_drop_frags", error);
 407     return error;
 408 }
 409
 410 /* Changes 'dpif''s treatment of IP fragments to 'drop_frags', whose meaning is
 411  * the same as for the get_drop_frags member function.  Returns 0 if
 412  * successful, otherwise a positive errno value. */
 413 int
 414 dpif_set_drop_frags(struct dpif *dpif, bool drop_frags)
 415 {
 416     int error = dpif->dpif_class->set_drop_frags(dpif, drop_frags);
 417     log_operation(dpif, "set_drop_frags", error);
 418     return error;
 419 }
 420
 421 /* Attempts to add 'netdev' as a port on 'dpif'.  If successful, returns 0 and
 422  * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
 423  * On failure, returns a positive errno value and sets '*port_nop' to
 424  * UINT16_MAX (if 'port_nop' is non-null). */
 425 int
 426 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
 427 {
 428     const char *netdev_name = netdev_get_name(netdev);
 429     uint16_t port_no;
 430     int error;
 431
 432     COVERAGE_INC(dpif_port_add);
 433
 434     error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
 435     if (!error) {
 436         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
 437                     dpif_name(dpif), netdev_name, port_no);
 438     } else {
 439         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
 440                      dpif_name(dpif), netdev_name, strerror(error));
 441         port_no = UINT16_MAX;
 442     }
 443     if (port_nop) {
 444         *port_nop = port_no;
 445     }
 446     return error;
 447 }
 448
 449 /* Attempts to remove 'dpif''s port number 'port_no'.  Returns 0 if successful,
 450  * otherwise a positive errno value. */
 451 int
 452 dpif_port_del(struct dpif *dpif, uint16_t port_no)
 453 {
 454     int error;
 455
 456     COVERAGE_INC(dpif_port_del);
 457
 458     error = dpif->dpif_class->port_del(dpif, port_no);
 459     if (!error) {
 460         VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
 461                     dpif_name(dpif), port_no);
 462     } else {
 463         log_operation(dpif, "port_del", error);
 464     }
 465     return error;
 466 }
 467
 468 /* Makes a deep copy of 'src' into 'dst'. */
 469 void
 470 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
 471 {
 472     dst->name = xstrdup(src->name);
 473     dst->type = xstrdup(src->type);
 474     dst->port_no = src->port_no;
 475 }
 476
 477 /* Frees memory allocated to members of 'dpif_port'.
 478  *
 479  * Do not call this function on a dpif_port obtained from
 480  * dpif_port_dump_next(): that function retains ownership of the data in the
 481  * dpif_port. */
 482 void
 483 dpif_port_destroy(struct dpif_port *dpif_port)
 484 {
 485     free(dpif_port->name);
 486     free(dpif_port->type);
 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  *
 493  * The caller owns the data in 'port' and must free it with
 494  * dpif_port_destroy() when it is no longer needed. */
 495 int
 496 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 497                           struct dpif_port *port)
 498 {
 499     int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
 500     if (!error) {
 501         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
 502                     dpif_name(dpif), port_no, port->name);
 503     } else {
 504         memset(port, 0, sizeof *port);
 505         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
 506                      dpif_name(dpif), port_no, strerror(error));
 507     }
 508     return error;
 509 }
 510
 511 /* Looks up port named 'devname' in 'dpif'.  On success, returns 0 and
 512  * initializes '*port' appropriately; on failure, returns a positive errno
 513  * value.
 514  *
 515  * The caller owns the data in 'port' and must free it with
 516  * dpif_port_destroy() when it is no longer needed. */
 517 int
 518 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
 519                         struct dpif_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_no);
 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 /* Returns one greater than the maximum port number accepted in flow
 538  * actions. */
 539 int
 540 dpif_get_max_ports(const struct dpif *dpif)
 541 {
 542     return dpif->dpif_class->get_max_ports(dpif);
 543 }
 544
 545 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
 546  * the port's name into the 'name_size' bytes in 'name', ensuring that the
 547  * result is null-terminated.  On failure, returns a positive errno value and
 548  * makes 'name' the empty string. */
 549 int
 550 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
 551                    char *name, size_t name_size)
 552 {
 553     struct dpif_port port;
 554     int error;
 555
 556     assert(name_size > 0);
 557
 558     error = dpif_port_query_by_number(dpif, port_no, &port);
 559     if (!error) {
 560         ovs_strlcpy(name, port.name, name_size);
 561         dpif_port_destroy(&port);
 562     } else {
 563         *name = '\0';
 564     }
 565     return error;
 566 }
 567
 568 /* Initializes 'dump' to begin dumping the ports in a dpif.
 569  *
 570  * This function provides no status indication.  An error status for the entire
 571  * dump operation is provided when it is completed by calling
 572  * dpif_port_dump_done().
 573  */
 574 void
 575 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
 576 {
 577     dump->dpif = dpif;
 578     dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
 579     log_operation(dpif, "port_dump_start", dump->error);
 580 }
 581
 582 /* Attempts to retrieve another port from 'dump', which must have been
 583  * initialized with dpif_port_dump_start().  On success, stores a new dpif_port
 584  * into 'port' and returns true.  On failure, returns false.
 585  *
 586  * Failure might indicate an actual error or merely that the last port has been
 587  * dumped.  An error status for the entire dump operation is provided when it
 588  * is completed by calling dpif_port_dump_done().
 589  *
 590  * The dpif owns the data stored in 'port'.  It will remain valid until at
 591  * least the next time 'dump' is passed to dpif_port_dump_next() or
 592  * dpif_port_dump_done(). */
 593 bool
 594 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
 595 {
 596     const struct dpif *dpif = dump->dpif;
 597
 598     if (dump->error) {
 599         return false;
 600     }
 601
 602     dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
 603     if (dump->error == EOF) {
 604         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
 605     } else {
 606         log_operation(dpif, "port_dump_next", dump->error);
 607     }
 608
 609     if (dump->error) {
 610         dpif->dpif_class->port_dump_done(dpif, dump->state);
 611         return false;
 612     }
 613     return true;
 614 }
 615
 616 /* Completes port table dump operation 'dump', which must have been initialized
 617  * with dpif_port_dump_start().  Returns 0 if the dump operation was
 618  * error-free, otherwise a positive errno value describing the problem. */
 619 int
 620 dpif_port_dump_done(struct dpif_port_dump *dump)
 621 {
 622     const struct dpif *dpif = dump->dpif;
 623     if (!dump->error) {
 624         dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
 625         log_operation(dpif, "port_dump_done", dump->error);
 626     }
 627     return dump->error == EOF ? 0 : dump->error;
 628 }
 629
 630 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
 631  * 'dpif' has changed, this function does one of the following:
 632  *
 633  * - Stores the name of the device that was added to or deleted from 'dpif' in
 634  *   '*devnamep' and returns 0.  The caller is responsible for freeing
 635  *   '*devnamep' (with free()) when it no longer needs it.
 636  *
 637  * - Returns ENOBUFS and sets '*devnamep' to NULL.
 638  *
 639  * This function may also return 'false positives', where it returns 0 and
 640  * '*devnamep' names a device that was not actually added or deleted or it
 641  * returns ENOBUFS without any change.
 642  *
 643  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
 644  * return other positive errno values to indicate that something has gone
 645  * wrong. */
 646 int
 647 dpif_port_poll(const struct dpif *dpif, char **devnamep)
 648 {
 649     int error = dpif->dpif_class->port_poll(dpif, devnamep);
 650     if (error) {
 651         *devnamep = NULL;
 652     }
 653     return error;
 654 }
 655
 656 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
 657  * value other than EAGAIN. */
 658 void
 659 dpif_port_poll_wait(const struct dpif *dpif)
 660 {
 661     dpif->dpif_class->port_poll_wait(dpif);
 662 }
 663
 664 /* Appends a human-readable representation of 'stats' to 's'. */
 665 void
 666 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
 667 {
 668     ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
 669                   stats->n_packets, stats->n_bytes);
 670     if (stats->used) {
 671         ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
 672     } else {
 673         ds_put_format(s, "never");
 674     }
 675     /* XXX tcp_flags? */
 676 }
 677
 678 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
 679  * positive errno value.  */
 680 int
 681 dpif_flow_flush(struct dpif *dpif)
 682 {
 683     int error;
 684
 685     COVERAGE_INC(dpif_flow_flush);
 686
 687     error = dpif->dpif_class->flow_flush(dpif);
 688     log_operation(dpif, "flow_flush", error);
 689     return error;
 690 }
 691
 692 /* Queries 'dpif' for a flow entry.  The flow is specified by the Netlink
 693  * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
 694  * 'key'.
 695  *
 696  * Returns 0 if successful.  If no flow matches, returns ENOENT.  On other
 697  * failure, returns a positive errno value.
 698  *
 699  * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
 700  * ofpbuf owned by the caller that contains the Netlink attributes for the
 701  * flow's actions.  The caller must free the ofpbuf (with ofpbuf_delete()) when
 702  * it is no longer needed.
 703  *
 704  * If 'stats' is nonnull, then on success it will be updated with the flow's
 705  * statistics. */
 706 int
 707 dpif_flow_get(const struct dpif *dpif,
 708               const struct nlattr *key, size_t key_len,
 709               struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 710 {
 711     int error;
 712
 713     COVERAGE_INC(dpif_flow_get);
 714
 715     error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
 716     if (error) {
 717         if (actionsp) {
 718             *actionsp = NULL;
 719         }
 720         if (stats) {
 721             memset(stats, 0, sizeof *stats);
 722         }
 723     }
 724     if (should_log_flow_message(error)) {
 725         const struct nlattr *actions;
 726         size_t actions_len;
 727
 728         if (!error && actionsp) {
 729             actions = (*actionsp)->data;
 730             actions_len = (*actionsp)->size;
 731         } else {
 732             actions = NULL;
 733             actions_len = 0;
 734         }
 735         log_flow_message(dpif, error, "flow_get", key, key_len, stats,
 736                          actions, actions_len);
 737     }
 738     return error;
 739 }
 740
 741 /* Adds or modifies a flow in 'dpif'.  The flow is specified by the Netlink
 742  * attributes with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at
 743  * 'key'.  The associated actions are specified by the Netlink attributes with
 744  * types ODP_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
 745  *
 746  * - If the flow's key does not exist in 'dpif', then the flow will be added if
 747  *   'flags' includes DPIF_FP_CREATE.  Otherwise the operation will fail with
 748  *   ENOENT.
 749  *
 750  *   If the operation succeeds, then 'stats', if nonnull, will be zeroed.
 751  *
 752  * - If the flow's key does exist in 'dpif', then the flow's actions will be
 753  *   updated if 'flags' includes DPIF_FP_MODIFY.  Otherwise the operation will
 754  *   fail with EEXIST.  If the flow's actions are updated, then its statistics
 755  *   will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
 756  *   otherwise.
 757  *
 758  *   If the operation succeeds, then 'stats', if nonnull, will be set to the
 759  *   flow's statistics before the update.
 760  */
 761 int
 762 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
 763               const struct nlattr *key, size_t key_len,
 764               const struct nlattr *actions, size_t actions_len,
 765               struct dpif_flow_stats *stats)
 766 {
 767     int error;
 768
 769     COVERAGE_INC(dpif_flow_put);
 770     assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
 771
 772     error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
 773                                        actions, actions_len, stats);
 774     if (error && stats) {
 775         memset(stats, 0, sizeof *stats);
 776     }
 777     if (should_log_flow_message(error)) {
 778         struct ds s;
 779
 780         ds_init(&s);
 781         ds_put_cstr(&s, "put");
 782         if (flags & DPIF_FP_CREATE) {
 783             ds_put_cstr(&s, "[create]");
 784         }
 785         if (flags & DPIF_FP_MODIFY) {
 786             ds_put_cstr(&s, "[modify]");
 787         }
 788         if (flags & DPIF_FP_ZERO_STATS) {
 789             ds_put_cstr(&s, "[zero]");
 790         }
 791         log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
 792                          actions, actions_len);
 793         ds_destroy(&s);
 794     }
 795     return error;
 796 }
 797
 798 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
 799  * not contain such a flow.  The flow is specified by the Netlink attributes
 800  * with types ODP_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
 801  *
 802  * If the operation succeeds, then 'stats', if nonnull, will be set to the
 803  * flow's statistics before its deletion. */
 804 int
 805 dpif_flow_del(struct dpif *dpif,
 806               const struct nlattr *key, size_t key_len,
 807               struct dpif_flow_stats *stats)
 808 {
 809     int error;
 810
 811     COVERAGE_INC(dpif_flow_del);
 812
 813     error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
 814     if (error && stats) {
 815         memset(stats, 0, sizeof *stats);
 816     }
 817     if (should_log_flow_message(error)) {
 818         log_flow_message(dpif, error, "flow_del", key, key_len,
 819                          !error ? stats : NULL, NULL, 0);
 820     }
 821     return error;
 822 }
 823
 824 /* Initializes 'dump' to begin dumping the flows in a dpif.
 825  *
 826  * This function provides no status indication.  An error status for the entire
 827  * dump operation is provided when it is completed by calling
 828  * dpif_flow_dump_done().
 829  */
 830 void
 831 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
 832 {
 833     dump->dpif = dpif;
 834     dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
 835     log_operation(dpif, "flow_dump_start", dump->error);
 836 }
 837
 838 /* Attempts to retrieve another flow from 'dump', which must have been
 839  * initialized with dpif_flow_dump_start().  On success, updates the output
 840  * parameters as described below and returns true.  Otherwise, returns false.
 841  * Failure might indicate an actual error or merely the end of the flow table.
 842  * An error status for the entire dump operation is provided when it is
 843  * completed by calling dpif_flow_dump_done().
 844  *
 845  * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
 846  * will be set to Netlink attributes with types ODP_KEY_ATTR_* representing the
 847  * dumped flow's key.  If 'actions' and 'actions_len' are nonnull then they are
 848  * set to Netlink attributes with types ODP_ACTION_ATTR_* representing the
 849  * dumped flow's actions.  If 'stats' is nonnull then it will be set to the
 850  * dumped flow's statistics.
 851  *
 852  * All of the returned data is owned by 'dpif', not by the caller, and the
 853  * caller must not modify or free it.  'dpif' guarantees that it remains
 854  * accessible and unchanging until at least the next call to 'flow_dump_next'
 855  * or 'flow_dump_done' for 'dump'. */
 856 bool
 857 dpif_flow_dump_next(struct dpif_flow_dump *dump,
 858                     const struct nlattr **key, size_t *key_len,
 859                     const struct nlattr **actions, size_t *actions_len,
 860                     const struct dpif_flow_stats **stats)
 861 {
 862     const struct dpif *dpif = dump->dpif;
 863     int error = dump->error;
 864
 865     if (!error) {
 866         error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
 867                                                  key, key_len,
 868                                                  actions, actions_len,
 869                                                  stats);
 870         if (error) {
 871             dpif->dpif_class->flow_dump_done(dpif, dump->state);
 872         }
 873     }
 874     if (error) {
 875         if (key) {
 876             *key = NULL;
 877             *key_len = 0;
 878         }
 879         if (actions) {
 880             *actions = NULL;
 881             *actions_len = 0;
 882         }
 883         if (stats) {
 884             *stats = NULL;
 885         }
 886     }
 887     if (!dump->error) {
 888         if (error == EOF) {
 889             VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
 890         } else if (should_log_flow_message(error)) {
 891             log_flow_message(dpif, error, "flow_dump",
 892                              key ? *key : NULL, key ? *key_len : 0,
 893                              stats ? *stats : NULL, actions ? *actions : NULL,
 894                              actions ? *actions_len : 0);
 895         }
 896     }
 897     dump->error = error;
 898     return !error;
 899 }
 900
 901 /* Completes flow table dump operation 'dump', which must have been initialized
 902  * with dpif_flow_dump_start().  Returns 0 if the dump operation was
 903  * error-free, otherwise a positive errno value describing the problem. */
 904 int
 905 dpif_flow_dump_done(struct dpif_flow_dump *dump)
 906 {
 907     const struct dpif *dpif = dump->dpif;
 908     if (!dump->error) {
 909         dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
 910         log_operation(dpif, "flow_dump_done", dump->error);
 911     }
 912     return dump->error == EOF ? 0 : dump->error;
 913 }
 914
 915 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
 916  * the Ethernet frame specified in 'packet'.
 917  *
 918  * Returns 0 if successful, otherwise a positive errno value. */
 919 int
 920 dpif_execute(struct dpif *dpif,
 921              const struct nlattr *actions, size_t actions_len,
 922              const struct ofpbuf *buf)
 923 {
 924     int error;
 925
 926     COVERAGE_INC(dpif_execute);
 927     if (actions_len > 0) {
 928         error = dpif->dpif_class->execute(dpif, actions, actions_len, buf);
 929     } else {
 930         error = 0;
 931     }
 932
 933     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
 934         struct ds ds = DS_EMPTY_INITIALIZER;
 935         char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
 936         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
 937         format_odp_actions(&ds, actions, actions_len);
 938         if (error) {
 939             ds_put_format(&ds, " failed (%s)", strerror(error));
 940         }
 941         ds_put_format(&ds, " on packet %s", packet);
 942         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
 943         ds_destroy(&ds);
 944         free(packet);
 945     }
 946     return error;
 947 }
 948
 949 static bool OVS_UNUSED
 950 is_valid_listen_mask(int listen_mask)
 951 {
 952     return !(listen_mask & ~((1u << DPIF_UC_MISS) |
 953                              (1u << DPIF_UC_ACTION) |
 954                              (1u << DPIF_UC_SAMPLE)));
 955 }
 956
 957 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'.  A 1-bit of value 2**X
 958  * set in '*listen_mask' indicates that dpif_recv() will receive messages of
 959  * the type (from "enum dpif_upcall_type") with value X.  Returns 0 if
 960  * successful, otherwise a positive errno value. */
 961 int
 962 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
 963 {
 964     int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
 965     if (error) {
 966         *listen_mask = 0;
 967     }
 968     assert(is_valid_listen_mask(*listen_mask));
 969     log_operation(dpif, "recv_get_mask", error);
 970     return error;
 971 }
 972
 973 /* Sets 'dpif''s "listen mask" to 'listen_mask'.  A 1-bit of value 2**X set in
 974  * '*listen_mask' requests that dpif_recv() will receive messages of the type
 975  * (from "enum dpif_upcall_type") with value X.  Returns 0 if successful,
 976  * otherwise a positive errno value. */
 977 int
 978 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
 979 {
 980     int error;
 981
 982     assert(is_valid_listen_mask(listen_mask));
 983
 984     error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
 985     log_operation(dpif, "recv_set_mask", error);
 986     return error;
 987 }
 988
 989 /* Retrieve the sFlow sampling probability.  '*probability' is expressed as the
 990  * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
 991  * the probability of sampling a given packet.
 992  *
 993  * Returns 0 if successful, otherwise a positive errno value.  EOPNOTSUPP
 994  * indicates that 'dpif' does not support sFlow sampling. */
 995 int
 996 dpif_get_sflow_probability(const struct dpif *dpif, uint32_t *probability)
 997 {
 998     int error = (dpif->dpif_class->get_sflow_probability
 999                  ? dpif->dpif_class->get_sflow_probability(dpif, probability)
1000                  : EOPNOTSUPP);
1001     if (error) {
1002         *probability = 0;
1003     }
1004     log_operation(dpif, "get_sflow_probability", error);
1005     return error;
1006 }
1007
1008 /* Set the sFlow sampling probability.  'probability' is expressed as the
1009  * number of packets out of UINT_MAX to sample, e.g. probability/UINT_MAX is
1010  * the probability of sampling a given packet.
1011  *
1012  * Returns 0 if successful, otherwise a positive errno value.  EOPNOTSUPP
1013  * indicates that 'dpif' does not support sFlow sampling. */
1014 int
1015 dpif_set_sflow_probability(struct dpif *dpif, uint32_t probability)
1016 {
1017     int error = (dpif->dpif_class->set_sflow_probability
1018                  ? dpif->dpif_class->set_sflow_probability(dpif, probability)
1019                  : EOPNOTSUPP);
1020     log_operation(dpif, "set_sflow_probability", error);
1021     return error;
1022 }
1023
1024 /* Polls for an upcall from 'dpif'.  If successful, stores the upcall into
1025  * '*upcall'.  Only upcalls of the types selected with dpif_recv_set_mask()
1026  * member function will ordinarily be received (but if a message type is
1027  * enabled and then later disabled, some stragglers might pop up).
1028  *
1029  * The caller takes ownership of the data that 'upcall' points to.
1030  * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1031  * 'upcall->packet', so their memory cannot be freed separately.  (This is
1032  * hardly a great way to do things but it works out OK for the dpif providers
1033  * and clients that exist so far.)
1034  *
1035  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
1036  * if no upcall is immediately available. */
1037 int
1038 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1039 {
1040     int error = dpif->dpif_class->recv(dpif, upcall);
1041     if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1042         struct flow flow;
1043         char *s;
1044
1045         s = ofp_packet_to_string(upcall->packet->data,
1046                                  upcall->packet->size, upcall->packet->size);
1047         odp_flow_key_to_flow(upcall->key, upcall->key_len, &flow);
1048
1049         VLOG_DBG("%s: %s upcall on port %"PRIu16": %s", dpif_name(dpif),
1050                  (upcall->type == DPIF_UC_MISS ? "miss"
1051                   : upcall->type == DPIF_UC_ACTION ? "action"
1052                   : upcall->type == DPIF_UC_SAMPLE ? "sample"
1053                   : "<unknown>"),
1054                  flow.in_port, s);
1055         free(s);
1056     }
1057     return error;
1058 }
1059
1060 /* Discards all messages that would otherwise be received by dpif_recv() on
1061  * 'dpif'. */
1062 void
1063 dpif_recv_purge(struct dpif *dpif)
1064 {
1065     COVERAGE_INC(dpif_purge);
1066     if (dpif->dpif_class->recv_purge) {
1067         dpif->dpif_class->recv_purge(dpif);
1068     }
1069 }
1070
1071 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1072  * received with dpif_recv(). */
1073 void
1074 dpif_recv_wait(struct dpif *dpif)
1075 {
1076     dpif->dpif_class->recv_wait(dpif);
1077 }
1078
1079 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1080  * and '*engine_id', respectively. */
1081 void
1082 dpif_get_netflow_ids(const struct dpif *dpif,
1083                      uint8_t *engine_type, uint8_t *engine_id)
1084 {
1085     *engine_type = dpif->netflow_engine_type;
1086     *engine_id = dpif->netflow_engine_id;
1087 }
1088
1089 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1090  * value for use in the ODP_ACTION_ATTR_SET_PRIORITY action.  On success,
1091  * returns 0 and stores the priority into '*priority'.  On failure, returns a
1092  * positive errno value and stores 0 into '*priority'. */
1093 int
1094 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1095                        uint32_t *priority)
1096 {
1097     int error = (dpif->dpif_class->queue_to_priority
1098                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1099                                                        priority)
1100                  : EOPNOTSUPP);
1101     if (error) {
1102         *priority = 0;
1103     }
1104     log_operation(dpif, "queue_to_priority", error);
1105     return error;
1106 }
1107 \f
1108 void
1109 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1110           const char *name,
1111           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1112 {
1113     dpif->dpif_class = dpif_class;
1114     dpif->base_name = xstrdup(name);
1115     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1116     dpif->netflow_engine_type = netflow_engine_type;
1117     dpif->netflow_engine_id = netflow_engine_id;
1118 }
1119
1120 /* Undoes the results of initialization.
1121  *
1122  * Normally this function only needs to be called from dpif_close().
1123  * However, it may be called by providers due to an error on opening
1124  * that occurs after initialization.  It this case dpif_close() would
1125  * never be called. */
1126 void
1127 dpif_uninit(struct dpif *dpif, bool close)
1128 {
1129     char *base_name = dpif->base_name;
1130     char *full_name = dpif->full_name;
1131
1132     if (close) {
1133         dpif->dpif_class->close(dpif);
1134     }
1135
1136     free(base_name);
1137     free(full_name);
1138 }
1139 \f
1140 static void
1141 log_operation(const struct dpif *dpif, const char *operation, int error)
1142 {
1143     if (!error) {
1144         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1145     } else if (is_errno(error)) {
1146         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1147                      dpif_name(dpif), operation, strerror(error));
1148     } else {
1149         VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1150                      dpif_name(dpif), operation,
1151                      get_ofp_err_type(error), get_ofp_err_code(error));
1152     }
1153 }
1154
1155 static enum vlog_level
1156 flow_message_log_level(int error)
1157 {
1158     return error ? VLL_WARN : VLL_DBG;
1159 }
1160
1161 static bool
1162 should_log_flow_message(int error)
1163 {
1164     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1165                              error ? &error_rl : &dpmsg_rl);
1166 }
1167
1168 static void
1169 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1170                  const struct nlattr *key, size_t key_len,
1171                  const struct dpif_flow_stats *stats,
1172                  const struct nlattr *actions, size_t actions_len)
1173 {
1174     struct ds ds = DS_EMPTY_INITIALIZER;
1175     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1176     if (error) {
1177         ds_put_cstr(&ds, "failed to ");
1178     }
1179     ds_put_format(&ds, "%s ", operation);
1180     if (error) {
1181         ds_put_format(&ds, "(%s) ", strerror(error));
1182     }
1183     odp_flow_key_format(key, key_len, &ds);
1184     if (stats) {
1185         ds_put_cstr(&ds, ", ");
1186         dpif_flow_stats_format(stats, &ds);
1187     }
1188     if (actions || actions_len) {
1189         ds_put_cstr(&ds, ", actions:");
1190         format_odp_actions(&ds, actions, actions_len);
1191     }
1192     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1193     ds_destroy(&ds);
1194 }