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