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 dpif_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 /* Attempts to add 'netdev' as a port on 'dpif'.  If successful, returns 0 and
 392  * sets '*port_nop' to the new port's port number (if 'port_nop' is non-null).
 393  * On failure, returns a positive errno value and sets '*port_nop' to
 394  * UINT16_MAX (if 'port_nop' is non-null). */
 395 int
 396 dpif_port_add(struct dpif *dpif, struct netdev *netdev, uint16_t *port_nop)
 397 {
 398     const char *netdev_name = netdev_get_name(netdev);
 399     uint16_t port_no;
 400     int error;
 401
 402     COVERAGE_INC(dpif_port_add);
 403
 404     error = dpif->dpif_class->port_add(dpif, netdev, &port_no);
 405     if (!error) {
 406         VLOG_DBG_RL(&dpmsg_rl, "%s: added %s as port %"PRIu16,
 407                     dpif_name(dpif), netdev_name, port_no);
 408     } else {
 409         VLOG_WARN_RL(&error_rl, "%s: failed to add %s as port: %s",
 410                      dpif_name(dpif), netdev_name, strerror(error));
 411         port_no = UINT16_MAX;
 412     }
 413     if (port_nop) {
 414         *port_nop = port_no;
 415     }
 416     return error;
 417 }
 418
 419 /* Attempts to remove 'dpif''s port number 'port_no'.  Returns 0 if successful,
 420  * otherwise a positive errno value. */
 421 int
 422 dpif_port_del(struct dpif *dpif, uint16_t port_no)
 423 {
 424     int error;
 425
 426     COVERAGE_INC(dpif_port_del);
 427
 428     error = dpif->dpif_class->port_del(dpif, port_no);
 429     if (!error) {
 430         VLOG_DBG_RL(&dpmsg_rl, "%s: port_del(%"PRIu16")",
 431                     dpif_name(dpif), port_no);
 432     } else {
 433         log_operation(dpif, "port_del", error);
 434     }
 435     return error;
 436 }
 437
 438 /* Makes a deep copy of 'src' into 'dst'. */
 439 void
 440 dpif_port_clone(struct dpif_port *dst, const struct dpif_port *src)
 441 {
 442     dst->name = xstrdup(src->name);
 443     dst->type = xstrdup(src->type);
 444     dst->port_no = src->port_no;
 445 }
 446
 447 /* Frees memory allocated to members of 'dpif_port'.
 448  *
 449  * Do not call this function on a dpif_port obtained from
 450  * dpif_port_dump_next(): that function retains ownership of the data in the
 451  * dpif_port. */
 452 void
 453 dpif_port_destroy(struct dpif_port *dpif_port)
 454 {
 455     free(dpif_port->name);
 456     free(dpif_port->type);
 457 }
 458
 459 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and
 460  * initializes '*port' appropriately; on failure, returns a positive errno
 461  * value.
 462  *
 463  * The caller owns the data in 'port' and must free it with
 464  * dpif_port_destroy() when it is no longer needed. */
 465 int
 466 dpif_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
 467                           struct dpif_port *port)
 468 {
 469     int error = dpif->dpif_class->port_query_by_number(dpif, port_no, port);
 470     if (!error) {
 471         VLOG_DBG_RL(&dpmsg_rl, "%s: port %"PRIu16" is device %s",
 472                     dpif_name(dpif), port_no, port->name);
 473     } else {
 474         memset(port, 0, sizeof *port);
 475         VLOG_WARN_RL(&error_rl, "%s: failed to query port %"PRIu16": %s",
 476                      dpif_name(dpif), port_no, strerror(error));
 477     }
 478     return error;
 479 }
 480
 481 /* Looks up port named 'devname' in 'dpif'.  On success, returns 0 and
 482  * initializes '*port' appropriately; on failure, returns a positive errno
 483  * value.
 484  *
 485  * The caller owns the data in 'port' and must free it with
 486  * dpif_port_destroy() when it is no longer needed. */
 487 int
 488 dpif_port_query_by_name(const struct dpif *dpif, const char *devname,
 489                         struct dpif_port *port)
 490 {
 491     int error = dpif->dpif_class->port_query_by_name(dpif, devname, port);
 492     if (!error) {
 493         VLOG_DBG_RL(&dpmsg_rl, "%s: device %s is on port %"PRIu16,
 494                     dpif_name(dpif), devname, port->port_no);
 495     } else {
 496         memset(port, 0, sizeof *port);
 497
 498         /* For ENOENT or ENODEV we use DBG level because the caller is probably
 499          * interested in whether 'dpif' actually has a port 'devname', so that
 500          * it's not an issue worth logging if it doesn't.  Other errors are
 501          * uncommon and more likely to indicate a real problem. */
 502         VLOG_RL(&error_rl,
 503                 error == ENOENT || error == ENODEV ? VLL_DBG : VLL_WARN,
 504                 "%s: failed to query port %s: %s",
 505                 dpif_name(dpif), devname, strerror(error));
 506     }
 507     return error;
 508 }
 509
 510 /* Returns one greater than the maximum port number accepted in flow
 511  * actions. */
 512 int
 513 dpif_get_max_ports(const struct dpif *dpif)
 514 {
 515     return dpif->dpif_class->get_max_ports(dpif);
 516 }
 517
 518 /* Returns the Netlink PID value to supply in OVS_ACTION_ATTR_USERSPACE actions
 519  * as the OVS_USERSPACE_ATTR_PID attribute's value, for use in flows whose
 520  * packets arrived on port 'port_no'.
 521  *
 522  * The return value is only meaningful when DPIF_UC_ACTION has been enabled in
 523  * the 'dpif''s listen mask.  It is allowed to change when DPIF_UC_ACTION is
 524  * disabled and then re-enabled, so a client that does that must be prepared to
 525  * update all of the flows that it installed that contain
 526  * OVS_ACTION_ATTR_USERSPACE actions. */
 527 uint32_t
 528 dpif_port_get_pid(const struct dpif *dpif, uint16_t port_no)
 529 {
 530     return (dpif->dpif_class->port_get_pid
 531             ? (dpif->dpif_class->port_get_pid)(dpif, port_no)
 532             : 0);
 533 }
 534
 535 /* Looks up port number 'port_no' in 'dpif'.  On success, returns 0 and copies
 536  * the port's name into the 'name_size' bytes in 'name', ensuring that the
 537  * result is null-terminated.  On failure, returns a positive errno value and
 538  * makes 'name' the empty string. */
 539 int
 540 dpif_port_get_name(struct dpif *dpif, uint16_t port_no,
 541                    char *name, size_t name_size)
 542 {
 543     struct dpif_port port;
 544     int error;
 545
 546     assert(name_size > 0);
 547
 548     error = dpif_port_query_by_number(dpif, port_no, &port);
 549     if (!error) {
 550         ovs_strlcpy(name, port.name, name_size);
 551         dpif_port_destroy(&port);
 552     } else {
 553         *name = '\0';
 554     }
 555     return error;
 556 }
 557
 558 /* Initializes 'dump' to begin dumping the ports in a dpif.
 559  *
 560  * This function provides no status indication.  An error status for the entire
 561  * dump operation is provided when it is completed by calling
 562  * dpif_port_dump_done().
 563  */
 564 void
 565 dpif_port_dump_start(struct dpif_port_dump *dump, const struct dpif *dpif)
 566 {
 567     dump->dpif = dpif;
 568     dump->error = dpif->dpif_class->port_dump_start(dpif, &dump->state);
 569     log_operation(dpif, "port_dump_start", dump->error);
 570 }
 571
 572 /* Attempts to retrieve another port from 'dump', which must have been
 573  * initialized with dpif_port_dump_start().  On success, stores a new dpif_port
 574  * into 'port' and returns true.  On failure, returns false.
 575  *
 576  * Failure might indicate an actual error or merely that the last port has been
 577  * dumped.  An error status for the entire dump operation is provided when it
 578  * is completed by calling dpif_port_dump_done().
 579  *
 580  * The dpif owns the data stored in 'port'.  It will remain valid until at
 581  * least the next time 'dump' is passed to dpif_port_dump_next() or
 582  * dpif_port_dump_done(). */
 583 bool
 584 dpif_port_dump_next(struct dpif_port_dump *dump, struct dpif_port *port)
 585 {
 586     const struct dpif *dpif = dump->dpif;
 587
 588     if (dump->error) {
 589         return false;
 590     }
 591
 592     dump->error = dpif->dpif_class->port_dump_next(dpif, dump->state, port);
 593     if (dump->error == EOF) {
 594         VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all ports", dpif_name(dpif));
 595     } else {
 596         log_operation(dpif, "port_dump_next", dump->error);
 597     }
 598
 599     if (dump->error) {
 600         dpif->dpif_class->port_dump_done(dpif, dump->state);
 601         return false;
 602     }
 603     return true;
 604 }
 605
 606 /* Completes port table dump operation 'dump', which must have been initialized
 607  * with dpif_port_dump_start().  Returns 0 if the dump operation was
 608  * error-free, otherwise a positive errno value describing the problem. */
 609 int
 610 dpif_port_dump_done(struct dpif_port_dump *dump)
 611 {
 612     const struct dpif *dpif = dump->dpif;
 613     if (!dump->error) {
 614         dump->error = dpif->dpif_class->port_dump_done(dpif, dump->state);
 615         log_operation(dpif, "port_dump_done", dump->error);
 616     }
 617     return dump->error == EOF ? 0 : dump->error;
 618 }
 619
 620 /* Polls for changes in the set of ports in 'dpif'.  If the set of ports in
 621  * 'dpif' has changed, this function does one of the following:
 622  *
 623  * - Stores the name of the device that was added to or deleted from 'dpif' in
 624  *   '*devnamep' and returns 0.  The caller is responsible for freeing
 625  *   '*devnamep' (with free()) when it no longer needs it.
 626  *
 627  * - Returns ENOBUFS and sets '*devnamep' to NULL.
 628  *
 629  * This function may also return 'false positives', where it returns 0 and
 630  * '*devnamep' names a device that was not actually added or deleted or it
 631  * returns ENOBUFS without any change.
 632  *
 633  * Returns EAGAIN if the set of ports in 'dpif' has not changed.  May also
 634  * return other positive errno values to indicate that something has gone
 635  * wrong. */
 636 int
 637 dpif_port_poll(const struct dpif *dpif, char **devnamep)
 638 {
 639     int error = dpif->dpif_class->port_poll(dpif, devnamep);
 640     if (error) {
 641         *devnamep = NULL;
 642     }
 643     return error;
 644 }
 645
 646 /* Arranges for the poll loop to wake up when port_poll(dpif) will return a
 647  * value other than EAGAIN. */
 648 void
 649 dpif_port_poll_wait(const struct dpif *dpif)
 650 {
 651     dpif->dpif_class->port_poll_wait(dpif);
 652 }
 653
 654 /* Extracts the flow stats for a packet.  The 'flow' and 'packet'
 655  * arguments must have been initialized through a call to flow_extract().
 656  */
 657 void
 658 dpif_flow_stats_extract(const struct flow *flow, struct ofpbuf *packet,
 659                         struct dpif_flow_stats *stats)
 660 {
 661     memset(stats, 0, sizeof(*stats));
 662
 663     if ((flow->dl_type == htons(ETH_TYPE_IP)) && packet->l4) {
 664         if ((flow->nw_proto == IPPROTO_TCP) && packet->l7) {
 665             struct tcp_header *tcp = packet->l4;
 666             stats->tcp_flags = TCP_FLAGS(tcp->tcp_ctl);
 667         }
 668     }
 669
 670     stats->n_bytes = packet->size;
 671     stats->n_packets = 1;
 672 }
 673
 674 /* Appends a human-readable representation of 'stats' to 's'. */
 675 void
 676 dpif_flow_stats_format(const struct dpif_flow_stats *stats, struct ds *s)
 677 {
 678     ds_put_format(s, "packets:%"PRIu64", bytes:%"PRIu64", used:",
 679                   stats->n_packets, stats->n_bytes);
 680     if (stats->used) {
 681         ds_put_format(s, "%.3fs", (time_msec() - stats->used) / 1000.0);
 682     } else {
 683         ds_put_format(s, "never");
 684     }
 685     /* XXX tcp_flags? */
 686 }
 687
 688 /* Deletes all flows from 'dpif'.  Returns 0 if successful, otherwise a
 689  * positive errno value.  */
 690 int
 691 dpif_flow_flush(struct dpif *dpif)
 692 {
 693     int error;
 694
 695     COVERAGE_INC(dpif_flow_flush);
 696
 697     error = dpif->dpif_class->flow_flush(dpif);
 698     log_operation(dpif, "flow_flush", error);
 699     return error;
 700 }
 701
 702 /* Queries 'dpif' for a flow entry.  The flow is specified by the Netlink
 703  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
 704  * 'key'.
 705  *
 706  * Returns 0 if successful.  If no flow matches, returns ENOENT.  On other
 707  * failure, returns a positive errno value.
 708  *
 709  * If 'actionsp' is nonnull, then on success '*actionsp' will be set to an
 710  * ofpbuf owned by the caller that contains the Netlink attributes for the
 711  * flow's actions.  The caller must free the ofpbuf (with ofpbuf_delete()) when
 712  * it is no longer needed.
 713  *
 714  * If 'stats' is nonnull, then on success it will be updated with the flow's
 715  * statistics. */
 716 int
 717 dpif_flow_get(const struct dpif *dpif,
 718               const struct nlattr *key, size_t key_len,
 719               struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
 720 {
 721     int error;
 722
 723     COVERAGE_INC(dpif_flow_get);
 724
 725     error = dpif->dpif_class->flow_get(dpif, key, key_len, actionsp, stats);
 726     if (error) {
 727         if (actionsp) {
 728             *actionsp = NULL;
 729         }
 730         if (stats) {
 731             memset(stats, 0, sizeof *stats);
 732         }
 733     }
 734     if (should_log_flow_message(error)) {
 735         const struct nlattr *actions;
 736         size_t actions_len;
 737
 738         if (!error && actionsp) {
 739             actions = (*actionsp)->data;
 740             actions_len = (*actionsp)->size;
 741         } else {
 742             actions = NULL;
 743             actions_len = 0;
 744         }
 745         log_flow_message(dpif, error, "flow_get", key, key_len, stats,
 746                          actions, actions_len);
 747     }
 748     return error;
 749 }
 750
 751 /* Adds or modifies a flow in 'dpif'.  The flow is specified by the Netlink
 752  * attributes with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at
 753  * 'key'.  The associated actions are specified by the Netlink attributes with
 754  * types OVS_ACTION_ATTR_* in the 'actions_len' bytes starting at 'actions'.
 755  *
 756  * - If the flow's key does not exist in 'dpif', then the flow will be added if
 757  *   'flags' includes DPIF_FP_CREATE.  Otherwise the operation will fail with
 758  *   ENOENT.
 759  *
 760  *   If the operation succeeds, then 'stats', if nonnull, will be zeroed.
 761  *
 762  * - If the flow's key does exist in 'dpif', then the flow's actions will be
 763  *   updated if 'flags' includes DPIF_FP_MODIFY.  Otherwise the operation will
 764  *   fail with EEXIST.  If the flow's actions are updated, then its statistics
 765  *   will be zeroed if 'flags' includes DPIF_FP_ZERO_STATS, and left as-is
 766  *   otherwise.
 767  *
 768  *   If the operation succeeds, then 'stats', if nonnull, will be set to the
 769  *   flow's statistics before the update.
 770  */
 771 int
 772 dpif_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
 773               const struct nlattr *key, size_t key_len,
 774               const struct nlattr *actions, size_t actions_len,
 775               struct dpif_flow_stats *stats)
 776 {
 777     int error;
 778
 779     COVERAGE_INC(dpif_flow_put);
 780     assert(!(flags & ~(DPIF_FP_CREATE | DPIF_FP_MODIFY | DPIF_FP_ZERO_STATS)));
 781
 782     error = dpif->dpif_class->flow_put(dpif, flags, key, key_len,
 783                                        actions, actions_len, stats);
 784     if (error && stats) {
 785         memset(stats, 0, sizeof *stats);
 786     }
 787     if (should_log_flow_message(error)) {
 788         struct ds s;
 789
 790         ds_init(&s);
 791         ds_put_cstr(&s, "put");
 792         if (flags & DPIF_FP_CREATE) {
 793             ds_put_cstr(&s, "[create]");
 794         }
 795         if (flags & DPIF_FP_MODIFY) {
 796             ds_put_cstr(&s, "[modify]");
 797         }
 798         if (flags & DPIF_FP_ZERO_STATS) {
 799             ds_put_cstr(&s, "[zero]");
 800         }
 801         log_flow_message(dpif, error, ds_cstr(&s), key, key_len, stats,
 802                          actions, actions_len);
 803         ds_destroy(&s);
 804     }
 805     return error;
 806 }
 807
 808 /* Deletes a flow from 'dpif' and returns 0, or returns ENOENT if 'dpif' does
 809  * not contain such a flow.  The flow is specified by the Netlink attributes
 810  * with types OVS_KEY_ATTR_* in the 'key_len' bytes starting at 'key'.
 811  *
 812  * If the operation succeeds, then 'stats', if nonnull, will be set to the
 813  * flow's statistics before its deletion. */
 814 int
 815 dpif_flow_del(struct dpif *dpif,
 816               const struct nlattr *key, size_t key_len,
 817               struct dpif_flow_stats *stats)
 818 {
 819     int error;
 820
 821     COVERAGE_INC(dpif_flow_del);
 822
 823     error = dpif->dpif_class->flow_del(dpif, key, key_len, stats);
 824     if (error && stats) {
 825         memset(stats, 0, sizeof *stats);
 826     }
 827     if (should_log_flow_message(error)) {
 828         log_flow_message(dpif, error, "flow_del", key, key_len,
 829                          !error ? stats : NULL, NULL, 0);
 830     }
 831     return error;
 832 }
 833
 834 /* Initializes 'dump' to begin dumping the flows in a dpif.
 835  *
 836  * This function provides no status indication.  An error status for the entire
 837  * dump operation is provided when it is completed by calling
 838  * dpif_flow_dump_done().
 839  */
 840 void
 841 dpif_flow_dump_start(struct dpif_flow_dump *dump, const struct dpif *dpif)
 842 {
 843     dump->dpif = dpif;
 844     dump->error = dpif->dpif_class->flow_dump_start(dpif, &dump->state);
 845     log_operation(dpif, "flow_dump_start", dump->error);
 846 }
 847
 848 /* Attempts to retrieve another flow from 'dump', which must have been
 849  * initialized with dpif_flow_dump_start().  On success, updates the output
 850  * parameters as described below and returns true.  Otherwise, returns false.
 851  * Failure might indicate an actual error or merely the end of the flow table.
 852  * An error status for the entire dump operation is provided when it is
 853  * completed by calling dpif_flow_dump_done().
 854  *
 855  * On success, if 'key' and 'key_len' are nonnull then '*key' and '*key_len'
 856  * will be set to Netlink attributes with types OVS_KEY_ATTR_* representing the
 857  * dumped flow's key.  If 'actions' and 'actions_len' are nonnull then they are
 858  * set to Netlink attributes with types OVS_ACTION_ATTR_* representing the
 859  * dumped flow's actions.  If 'stats' is nonnull then it will be set to the
 860  * dumped flow's statistics.
 861  *
 862  * All of the returned data is owned by 'dpif', not by the caller, and the
 863  * caller must not modify or free it.  'dpif' guarantees that it remains
 864  * accessible and unchanging until at least the next call to 'flow_dump_next'
 865  * or 'flow_dump_done' for 'dump'. */
 866 bool
 867 dpif_flow_dump_next(struct dpif_flow_dump *dump,
 868                     const struct nlattr **key, size_t *key_len,
 869                     const struct nlattr **actions, size_t *actions_len,
 870                     const struct dpif_flow_stats **stats)
 871 {
 872     const struct dpif *dpif = dump->dpif;
 873     int error = dump->error;
 874
 875     if (!error) {
 876         error = dpif->dpif_class->flow_dump_next(dpif, dump->state,
 877                                                  key, key_len,
 878                                                  actions, actions_len,
 879                                                  stats);
 880         if (error) {
 881             dpif->dpif_class->flow_dump_done(dpif, dump->state);
 882         }
 883     }
 884     if (error) {
 885         if (key) {
 886             *key = NULL;
 887             *key_len = 0;
 888         }
 889         if (actions) {
 890             *actions = NULL;
 891             *actions_len = 0;
 892         }
 893         if (stats) {
 894             *stats = NULL;
 895         }
 896     }
 897     if (!dump->error) {
 898         if (error == EOF) {
 899             VLOG_DBG_RL(&dpmsg_rl, "%s: dumped all flows", dpif_name(dpif));
 900         } else if (should_log_flow_message(error)) {
 901             log_flow_message(dpif, error, "flow_dump",
 902                              key ? *key : NULL, key ? *key_len : 0,
 903                              stats ? *stats : NULL, actions ? *actions : NULL,
 904                              actions ? *actions_len : 0);
 905         }
 906     }
 907     dump->error = error;
 908     return !error;
 909 }
 910
 911 /* Completes flow table dump operation 'dump', which must have been initialized
 912  * with dpif_flow_dump_start().  Returns 0 if the dump operation was
 913  * error-free, otherwise a positive errno value describing the problem. */
 914 int
 915 dpif_flow_dump_done(struct dpif_flow_dump *dump)
 916 {
 917     const struct dpif *dpif = dump->dpif;
 918     if (!dump->error) {
 919         dump->error = dpif->dpif_class->flow_dump_done(dpif, dump->state);
 920         log_operation(dpif, "flow_dump_done", dump->error);
 921     }
 922     return dump->error == EOF ? 0 : dump->error;
 923 }
 924
 925 /* Causes 'dpif' to perform the 'actions_len' bytes of actions in 'actions' on
 926  * the Ethernet frame specified in 'packet' taken from the flow specified in
 927  * the 'key_len' bytes of 'key'.  ('key' is mostly redundant with 'packet', but
 928  * it contains some metadata that cannot be recovered from 'packet', such as
 929  * tun_id and in_port.)
 930  *
 931  * Returns 0 if successful, otherwise a positive errno value. */
 932 int
 933 dpif_execute(struct dpif *dpif,
 934              const struct nlattr *key, size_t key_len,
 935              const struct nlattr *actions, size_t actions_len,
 936              const struct ofpbuf *buf)
 937 {
 938     int error;
 939
 940     COVERAGE_INC(dpif_execute);
 941     if (actions_len > 0) {
 942         error = dpif->dpif_class->execute(dpif, key, key_len,
 943                                           actions, actions_len, buf);
 944     } else {
 945         error = 0;
 946     }
 947
 948     if (!(error ? VLOG_DROP_WARN(&error_rl) : VLOG_DROP_DBG(&dpmsg_rl))) {
 949         struct ds ds = DS_EMPTY_INITIALIZER;
 950         char *packet = ofp_packet_to_string(buf->data, buf->size, buf->size);
 951         ds_put_format(&ds, "%s: execute ", dpif_name(dpif));
 952         format_odp_actions(&ds, actions, actions_len);
 953         if (error) {
 954             ds_put_format(&ds, " failed (%s)", strerror(error));
 955         }
 956         ds_put_format(&ds, " on packet %s", packet);
 957         vlog(THIS_MODULE, error ? VLL_WARN : VLL_DBG, "%s", ds_cstr(&ds));
 958         ds_destroy(&ds);
 959         free(packet);
 960     }
 961     return error;
 962 }
 963
 964 /* Executes each of the 'n_ops' operations in 'ops' on 'dpif', in the order in
 965  * which they are specified, placing each operation's results in the "output"
 966  * members documented in comments.
 967  *
 968  * This function exists because some datapaths can perform batched operations
 969  * faster than individual operations. */
 970 void
 971 dpif_operate(struct dpif *dpif, union dpif_op **ops, size_t n_ops)
 972 {
 973     size_t i;
 974
 975     if (dpif->dpif_class->operate) {
 976         dpif->dpif_class->operate(dpif, ops, n_ops);
 977         return;
 978     }
 979
 980     for (i = 0; i < n_ops; i++) {
 981         union dpif_op *op = ops[i];
 982         struct dpif_flow_put *put;
 983         struct dpif_execute *execute;
 984
 985         switch (op->type) {
 986         case DPIF_OP_FLOW_PUT:
 987             put = &op->flow_put;
 988             put->error = dpif_flow_put(dpif, put->flags,
 989                                        put->key, put->key_len,
 990                                        put->actions, put->actions_len,
 991                                        put->stats);
 992             break;
 993
 994         case DPIF_OP_EXECUTE:
 995             execute = &op->execute;
 996             execute->error = dpif_execute(dpif, execute->key, execute->key_len,
 997                                           execute->actions,
 998                                           execute->actions_len,
 999                                           execute->packet);
1000             break;
1001
1002         default:
1003             NOT_REACHED();
1004         }
1005     }
1006 }
1007
1008
1009 /* Returns a string that represents 'type', for use in log messages. */
1010 const char *
1011 dpif_upcall_type_to_string(enum dpif_upcall_type type)
1012 {
1013     switch (type) {
1014     case DPIF_UC_MISS: return "miss";
1015     case DPIF_UC_ACTION: return "action";
1016     case DPIF_N_UC_TYPES: default: return "<unknown>";
1017     }
1018 }
1019
1020 static bool OVS_UNUSED
1021 is_valid_listen_mask(int listen_mask)
1022 {
1023     return !(listen_mask & ~((1u << DPIF_UC_MISS) |
1024                              (1u << DPIF_UC_ACTION)));
1025 }
1026
1027 /* Retrieves 'dpif''s "listen mask" into '*listen_mask'.  A 1-bit of value 2**X
1028  * set in '*listen_mask' indicates that dpif_recv() will receive messages of
1029  * the type (from "enum dpif_upcall_type") with value X.  Returns 0 if
1030  * successful, otherwise a positive errno value. */
1031 int
1032 dpif_recv_get_mask(const struct dpif *dpif, int *listen_mask)
1033 {
1034     int error = dpif->dpif_class->recv_get_mask(dpif, listen_mask);
1035     if (error) {
1036         *listen_mask = 0;
1037     }
1038     assert(is_valid_listen_mask(*listen_mask));
1039     log_operation(dpif, "recv_get_mask", error);
1040     return error;
1041 }
1042
1043 /* Sets 'dpif''s "listen mask" to 'listen_mask'.  A 1-bit of value 2**X set in
1044  * '*listen_mask' requests that dpif_recv() will receive messages of the type
1045  * (from "enum dpif_upcall_type") with value X.  Returns 0 if successful,
1046  * otherwise a positive errno value.
1047  *
1048  * Turning DPIF_UC_ACTION off and then back on may change the Netlink PID
1049  * assignments returned by dpif_port_get_pid().  If the client does this, it
1050  * must update all of the flows that have OVS_ACTION_ATTR_USERSPACE actions
1051  * using the new PID assignment. */
1052 int
1053 dpif_recv_set_mask(struct dpif *dpif, int listen_mask)
1054 {
1055     int error;
1056
1057     assert(is_valid_listen_mask(listen_mask));
1058
1059     error = dpif->dpif_class->recv_set_mask(dpif, listen_mask);
1060     log_operation(dpif, "recv_set_mask", error);
1061     return error;
1062 }
1063
1064 /* Polls for an upcall from 'dpif'.  If successful, stores the upcall into
1065  * '*upcall'.  Only upcalls of the types selected with dpif_recv_set_mask()
1066  * member function will ordinarily be received (but if a message type is
1067  * enabled and then later disabled, some stragglers might pop up).
1068  *
1069  * The caller takes ownership of the data that 'upcall' points to.
1070  * 'upcall->key' and 'upcall->actions' (if nonnull) point into data owned by
1071  * 'upcall->packet', so their memory cannot be freed separately.  (This is
1072  * hardly a great way to do things but it works out OK for the dpif providers
1073  * and clients that exist so far.)
1074  *
1075  * Returns 0 if successful, otherwise a positive errno value.  Returns EAGAIN
1076  * if no upcall is immediately available. */
1077 int
1078 dpif_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1079 {
1080     int error = dpif->dpif_class->recv(dpif, upcall);
1081     if (!error && !VLOG_DROP_DBG(&dpmsg_rl)) {
1082         struct ds flow;
1083         char *packet;
1084
1085         packet = ofp_packet_to_string(upcall->packet->data,
1086                                       upcall->packet->size,
1087                                       upcall->packet->size);
1088
1089         ds_init(&flow);
1090         odp_flow_key_format(upcall->key, upcall->key_len, &flow);
1091
1092         VLOG_DBG("%s: %s upcall:\n%s\n%s",
1093                  dpif_name(dpif), dpif_upcall_type_to_string(upcall->type),
1094                  ds_cstr(&flow), packet);
1095
1096         ds_destroy(&flow);
1097         free(packet);
1098     }
1099     return error;
1100 }
1101
1102 /* Discards all messages that would otherwise be received by dpif_recv() on
1103  * 'dpif'. */
1104 void
1105 dpif_recv_purge(struct dpif *dpif)
1106 {
1107     COVERAGE_INC(dpif_purge);
1108     if (dpif->dpif_class->recv_purge) {
1109         dpif->dpif_class->recv_purge(dpif);
1110     }
1111 }
1112
1113 /* Arranges for the poll loop to wake up when 'dpif' has a message queued to be
1114  * received with dpif_recv(). */
1115 void
1116 dpif_recv_wait(struct dpif *dpif)
1117 {
1118     dpif->dpif_class->recv_wait(dpif);
1119 }
1120
1121 /* Obtains the NetFlow engine type and engine ID for 'dpif' into '*engine_type'
1122  * and '*engine_id', respectively. */
1123 void
1124 dpif_get_netflow_ids(const struct dpif *dpif,
1125                      uint8_t *engine_type, uint8_t *engine_id)
1126 {
1127     *engine_type = dpif->netflow_engine_type;
1128     *engine_id = dpif->netflow_engine_id;
1129 }
1130
1131 /* Translates OpenFlow queue ID 'queue_id' (in host byte order) into a priority
1132  * value used for setting packet priority.
1133  * On success, returns 0 and stores the priority into '*priority'.
1134  * On failure, returns a positive errno value and stores 0 into '*priority'. */
1135 int
1136 dpif_queue_to_priority(const struct dpif *dpif, uint32_t queue_id,
1137                        uint32_t *priority)
1138 {
1139     int error = (dpif->dpif_class->queue_to_priority
1140                  ? dpif->dpif_class->queue_to_priority(dpif, queue_id,
1141                                                        priority)
1142                  : EOPNOTSUPP);
1143     if (error) {
1144         *priority = 0;
1145     }
1146     log_operation(dpif, "queue_to_priority", error);
1147     return error;
1148 }
1149 \f
1150 void
1151 dpif_init(struct dpif *dpif, const struct dpif_class *dpif_class,
1152           const char *name,
1153           uint8_t netflow_engine_type, uint8_t netflow_engine_id)
1154 {
1155     dpif->dpif_class = dpif_class;
1156     dpif->base_name = xstrdup(name);
1157     dpif->full_name = xasprintf("%s@%s", dpif_class->type, name);
1158     dpif->netflow_engine_type = netflow_engine_type;
1159     dpif->netflow_engine_id = netflow_engine_id;
1160 }
1161
1162 /* Undoes the results of initialization.
1163  *
1164  * Normally this function only needs to be called from dpif_close().
1165  * However, it may be called by providers due to an error on opening
1166  * that occurs after initialization.  It this case dpif_close() would
1167  * never be called. */
1168 void
1169 dpif_uninit(struct dpif *dpif, bool close)
1170 {
1171     char *base_name = dpif->base_name;
1172     char *full_name = dpif->full_name;
1173
1174     if (close) {
1175         dpif->dpif_class->close(dpif);
1176     }
1177
1178     free(base_name);
1179     free(full_name);
1180 }
1181 \f
1182 static void
1183 log_operation(const struct dpif *dpif, const char *operation, int error)
1184 {
1185     if (!error) {
1186         VLOG_DBG_RL(&dpmsg_rl, "%s: %s success", dpif_name(dpif), operation);
1187     } else if (is_errno(error)) {
1188         VLOG_WARN_RL(&error_rl, "%s: %s failed (%s)",
1189                      dpif_name(dpif), operation, strerror(error));
1190     } else {
1191         VLOG_WARN_RL(&error_rl, "%s: %s failed (%d/%d)",
1192                      dpif_name(dpif), operation,
1193                      get_ofp_err_type(error), get_ofp_err_code(error));
1194     }
1195 }
1196
1197 static enum vlog_level
1198 flow_message_log_level(int error)
1199 {
1200     return error ? VLL_WARN : VLL_DBG;
1201 }
1202
1203 static bool
1204 should_log_flow_message(int error)
1205 {
1206     return !vlog_should_drop(THIS_MODULE, flow_message_log_level(error),
1207                              error ? &error_rl : &dpmsg_rl);
1208 }
1209
1210 static void
1211 log_flow_message(const struct dpif *dpif, int error, const char *operation,
1212                  const struct nlattr *key, size_t key_len,
1213                  const struct dpif_flow_stats *stats,
1214                  const struct nlattr *actions, size_t actions_len)
1215 {
1216     struct ds ds = DS_EMPTY_INITIALIZER;
1217     ds_put_format(&ds, "%s: ", dpif_name(dpif));
1218     if (error) {
1219         ds_put_cstr(&ds, "failed to ");
1220     }
1221     ds_put_format(&ds, "%s ", operation);
1222     if (error) {
1223         ds_put_format(&ds, "(%s) ", strerror(error));
1224     }
1225     odp_flow_key_format(key, key_len, &ds);
1226     if (stats) {
1227         ds_put_cstr(&ds, ", ");
1228         dpif_flow_stats_format(stats, &ds);
1229     }
1230     if (actions || actions_len) {
1231         ds_put_cstr(&ds, ", actions:");
1232         format_odp_actions(&ds, actions, actions_len);
1233     }
1234     vlog(THIS_MODULE, flow_message_log_level(error), "%s", ds_cstr(&ds));
1235     ds_destroy(&ds);
1236 }