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