lib/dpif.c

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