ofproto/ofproto-dpif-upcall.c

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.  */
  14
  15 #include <config.h>
  16 #include "ofproto-dpif-upcall.h"
  17
  18 #include <errno.h>
  19 #include <stdbool.h>
  20 #include <inttypes.h>
  21
  22 #include "connmgr.h"
  23 #include "coverage.h"
  24 #include "dpif.h"
  25 #include "dynamic-string.h"
  26 #include "fail-open.h"
  27 #include "guarded-list.h"
  28 #include "latch.h"
  29 #include "list.h"
  30 #include "netlink.h"
  31 #include "ofpbuf.h"
  32 #include "ofproto-dpif-ipfix.h"
  33 #include "ofproto-dpif-sflow.h"
  34 #include "ofproto-dpif-xlate.h"
  35 #include "ovs-rcu.h"
  36 #include "packets.h"
  37 #include "poll-loop.h"
  38 #include "seq.h"
  39 #include "unixctl.h"
  40 #include "vlog.h"
  41
  42 #define MAX_QUEUE_LENGTH 512
  43 #define UPCALL_MAX_BATCH 64
  44 #define REVALIDATE_MAX_BATCH 50
  45
  46 VLOG_DEFINE_THIS_MODULE(ofproto_dpif_upcall);
  47
  48 COVERAGE_DEFINE(dumped_duplicate_flow);
  49 COVERAGE_DEFINE(dumped_new_flow);
  50 COVERAGE_DEFINE(revalidate_missed_dp_flow);
  51
  52 /* A thread that reads upcalls from dpif, forwards each upcall's packet,
  53  * and possibly sets up a kernel flow as a cache. */
  54 struct handler {
  55     struct udpif *udpif;               /* Parent udpif. */
  56     pthread_t thread;                  /* Thread ID. */
  57     uint32_t handler_id;               /* Handler id. */
  58 };
  59
  60 /* A thread that processes datapath flows, updates OpenFlow statistics, and
  61  * updates or removes them if necessary. */
  62 struct revalidator {
  63     struct udpif *udpif;               /* Parent udpif. */
  64     pthread_t thread;                  /* Thread ID. */
  65     unsigned int id;                   /* ovsthread_id_self(). */
  66     struct hmap *ukeys;                /* Points into udpif->ukeys for this
  67                                           revalidator. Used for GC phase. */
  68 };
  69
  70 /* An upcall handler for ofproto_dpif.
  71  *
  72  * udpif keeps records of two kind of logically separate units:
  73  *
  74  * upcall handling
  75  * ---------------
  76  *
  77  *    - An array of 'struct handler's for upcall handling and flow
  78  *      installation.
  79  *
  80  * flow revalidation
  81  * -----------------
  82  *
  83  *    - Revalidation threads which read the datapath flow table and maintains
  84  *      them.
  85  */
  86 struct udpif {
  87     struct list list_node;             /* In all_udpifs list. */
  88
  89     struct dpif *dpif;                 /* Datapath handle. */
  90     struct dpif_backer *backer;        /* Opaque dpif_backer pointer. */
  91
  92     uint32_t secret;                   /* Random seed for upcall hash. */
  93
  94     struct handler *handlers;          /* Upcall handlers. */
  95     size_t n_handlers;
  96
  97     struct revalidator *revalidators;  /* Flow revalidators. */
  98     size_t n_revalidators;
  99
 100     struct latch exit_latch;           /* Tells child threads to exit. */
 101
 102     /* Revalidation. */
 103     struct seq *reval_seq;             /* Incremented to force revalidation. */
 104     bool need_revalidate;              /* As indicated by 'reval_seq'. */
 105     bool reval_exit;                   /* Set by leader on 'exit_latch. */
 106     struct ovs_barrier reval_barrier;  /* Barrier used by revalidators. */
 107     struct dpif_flow_dump *dump;       /* DPIF flow dump state. */
 108     long long int dump_duration;       /* Duration of the last flow dump. */
 109     struct seq *dump_seq;              /* Increments each dump iteration. */
 110
 111     /* There are 'n_revalidators' ukey hmaps. Each revalidator retains a
 112      * reference to one of these for garbage collection.
 113      *
 114      * During the flow dump phase, revalidators insert into these with a random
 115      * distribution. During the garbage collection phase, each revalidator
 116      * takes care of garbage collecting one of these hmaps. */
 117     struct {
 118         struct ovs_mutex mutex;        /* Guards the following. */
 119         struct hmap hmap OVS_GUARDED;  /* Datapath flow keys. */
 120     } *ukeys;
 121
 122     /* Datapath flow statistics. */
 123     unsigned int max_n_flows;
 124     unsigned int avg_n_flows;
 125
 126     /* Following fields are accessed and modified by different threads. */
 127     atomic_uint flow_limit;            /* Datapath flow hard limit. */
 128
 129     /* n_flows_mutex prevents multiple threads updating these concurrently. */
 130     atomic_uint n_flows;               /* Number of flows in the datapath. */
 131     atomic_llong n_flows_timestamp;    /* Last time n_flows was updated. */
 132     struct ovs_mutex n_flows_mutex;
 133
 134     /* Following fields are accessed and modified only from the main thread. */
 135     struct unixctl_conn **conns;       /* Connections waiting on dump_seq. */
 136     uint64_t conn_seq;                 /* Corresponds to 'dump_seq' when
 137                                           conns[n_conns-1] was stored. */
 138     size_t n_conns;                    /* Number of connections waiting. */
 139 };
 140
 141 enum upcall_type {
 142     BAD_UPCALL,                 /* Some kind of bug somewhere. */
 143     MISS_UPCALL,                /* A flow miss.  */
 144     SFLOW_UPCALL,               /* sFlow sample. */
 145     FLOW_SAMPLE_UPCALL,         /* Per-flow sampling. */
 146     IPFIX_UPCALL                /* Per-bridge sampling. */
 147 };
 148
 149 struct upcall {
 150     struct ofproto_dpif *ofproto;  /* Parent ofproto. */
 151
 152     /* The flow and packet are only required to be constant when using
 153      * dpif-netdev.  If a modification is absolutely necessary, a const cast
 154      * may be used with other datapaths. */
 155     const struct flow *flow;       /* Parsed representation of the packet. */
 156     const struct ofpbuf *packet;   /* Packet associated with this upcall. */
 157     ofp_port_t in_port;            /* OpenFlow in port, or OFPP_NONE. */
 158
 159     enum dpif_upcall_type type;    /* Datapath type of the upcall. */
 160     const struct nlattr *userdata; /* Userdata for DPIF_UC_ACTION Upcalls. */
 161
 162     bool xout_initialized;         /* True if 'xout' must be uninitialized. */
 163     struct xlate_out xout;         /* Result of xlate_actions(). */
 164     struct ofpbuf put_actions;     /* Actions 'put' in the fastapath. */
 165
 166     struct dpif_ipfix *ipfix;      /* IPFIX pointer or NULL. */
 167     struct dpif_sflow *sflow;      /* SFlow pointer or NULL. */
 168
 169     bool vsp_adjusted;             /* 'packet' and 'flow' were adjusted for
 170                                       VLAN splinters if true. */
 171
 172     /* Not used by the upcall callback interface. */
 173     const struct nlattr *key;      /* Datapath flow key. */
 174     size_t key_len;                /* Datapath flow key length. */
 175     const struct nlattr *out_tun_key;  /* Datapath output tunnel key. */
 176 };
 177
 178 /* 'udpif_key's are responsible for tracking the little bit of state udpif
 179  * needs to do flow expiration which can't be pulled directly from the
 180  * datapath.  They may be created or maintained by any revalidator during
 181  * the dump phase, but are owned by a single revalidator, and are destroyed
 182  * by that revalidator during the garbage-collection phase.
 183  *
 184  * While some elements of a udpif_key are protected by a mutex, the ukey itself
 185  * is not.  Therefore it is not safe to destroy a udpif_key except when all
 186  * revalidators are in garbage collection phase, or they aren't running. */
 187 struct udpif_key {
 188     struct hmap_node hmap_node;     /* In parent revalidator 'ukeys' map. */
 189
 190     /* These elements are read only once created, and therefore aren't
 191      * protected by a mutex. */
 192     const struct nlattr *key;      /* Datapath flow key. */
 193     size_t key_len;                /* Length of 'key'. */
 194
 195     struct ovs_mutex mutex;                   /* Guards the following. */
 196     struct dpif_flow_stats stats OVS_GUARDED; /* Last known stats.*/
 197     long long int created OVS_GUARDED;        /* Estimate of creation time. */
 198     uint64_t dump_seq OVS_GUARDED;            /* Tracks udpif->dump_seq. */
 199     bool flow_exists OVS_GUARDED;             /* Ensures flows are only deleted
 200                                                  once. */
 201
 202     struct xlate_cache *xcache OVS_GUARDED;   /* Cache for xlate entries that
 203                                                * are affected by this ukey.
 204                                                * Used for stats and learning.*/
 205     union {
 206         struct odputil_keybuf key_buf;        /* Memory for 'key'. */
 207         struct nlattr key_buf_nla;
 208     };
 209 };
 210
 211 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 212 static struct list all_udpifs = LIST_INITIALIZER(&all_udpifs);
 213
 214 static size_t recv_upcalls(struct handler *);
 215 static int process_upcall(struct udpif *, struct upcall *,
 216                           struct ofpbuf *odp_actions);
 217 static void handle_upcalls(struct udpif *, struct upcall *, size_t n_upcalls);
 218 static void udpif_stop_threads(struct udpif *);
 219 static void udpif_start_threads(struct udpif *, size_t n_handlers,
 220                                 size_t n_revalidators);
 221 static void *udpif_upcall_handler(void *);
 222 static void *udpif_revalidator(void *);
 223 static unsigned long udpif_get_n_flows(struct udpif *);
 224 static void revalidate(struct revalidator *);
 225 static void revalidator_sweep(struct revalidator *);
 226 static void revalidator_purge(struct revalidator *);
 227 static void upcall_unixctl_show(struct unixctl_conn *conn, int argc,
 228                                 const char *argv[], void *aux);
 229 static void upcall_unixctl_disable_megaflows(struct unixctl_conn *, int argc,
 230                                              const char *argv[], void *aux);
 231 static void upcall_unixctl_enable_megaflows(struct unixctl_conn *, int argc,
 232                                             const char *argv[], void *aux);
 233 static void upcall_unixctl_set_flow_limit(struct unixctl_conn *conn, int argc,
 234                                             const char *argv[], void *aux);
 235 static void upcall_unixctl_dump_wait(struct unixctl_conn *conn, int argc,
 236                                      const char *argv[], void *aux);
 237
 238 static struct udpif_key *ukey_create(const struct nlattr *key, size_t key_len,
 239                                      long long int used);
 240 static struct udpif_key *ukey_lookup(struct udpif *udpif,
 241                                      const struct nlattr *key, size_t key_len,
 242                                      uint32_t hash);
 243 static bool ukey_acquire(struct udpif *udpif, const struct nlattr *key,
 244                          size_t key_len, long long int used,
 245                          struct udpif_key **result);
 246 static void ukey_delete(struct revalidator *, struct udpif_key *);
 247 static enum upcall_type classify_upcall(enum dpif_upcall_type type,
 248                                         const struct nlattr *userdata);
 249
 250 static int upcall_receive(struct upcall *, const struct dpif_backer *,
 251                           const struct ofpbuf *packet, enum dpif_upcall_type,
 252                           const struct nlattr *userdata, const struct flow *);
 253 static void upcall_uninit(struct upcall *);
 254
 255 static upcall_callback upcall_cb;
 256
 257 static atomic_bool enable_megaflows = ATOMIC_VAR_INIT(true);
 258
 259 struct udpif *
 260 udpif_create(struct dpif_backer *backer, struct dpif *dpif)
 261 {
 262     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 263     struct udpif *udpif = xzalloc(sizeof *udpif);
 264
 265     if (ovsthread_once_start(&once)) {
 266         unixctl_command_register("upcall/show", "", 0, 0, upcall_unixctl_show,
 267                                  NULL);
 268         unixctl_command_register("upcall/disable-megaflows", "", 0, 0,
 269                                  upcall_unixctl_disable_megaflows, NULL);
 270         unixctl_command_register("upcall/enable-megaflows", "", 0, 0,
 271                                  upcall_unixctl_enable_megaflows, NULL);
 272         unixctl_command_register("upcall/set-flow-limit", "", 1, 1,
 273                                  upcall_unixctl_set_flow_limit, NULL);
 274         unixctl_command_register("revalidator/wait", "", 0, 0,
 275                                  upcall_unixctl_dump_wait, NULL);
 276         ovsthread_once_done(&once);
 277     }
 278
 279     udpif->dpif = dpif;
 280     udpif->backer = backer;
 281     atomic_init(&udpif->flow_limit, MIN(ofproto_flow_limit, 10000));
 282     udpif->secret = random_uint32();
 283     udpif->reval_seq = seq_create();
 284     udpif->dump_seq = seq_create();
 285     latch_init(&udpif->exit_latch);
 286     list_push_back(&all_udpifs, &udpif->list_node);
 287     atomic_init(&udpif->n_flows, 0);
 288     atomic_init(&udpif->n_flows_timestamp, LLONG_MIN);
 289     ovs_mutex_init(&udpif->n_flows_mutex);
 290
 291     dpif_register_upcall_cb(dpif, upcall_cb, udpif);
 292
 293     return udpif;
 294 }
 295
 296 void
 297 udpif_run(struct udpif *udpif)
 298 {
 299     if (udpif->conns && udpif->conn_seq != seq_read(udpif->dump_seq)) {
 300         int i;
 301
 302         for (i = 0; i < udpif->n_conns; i++) {
 303             unixctl_command_reply(udpif->conns[i], NULL);
 304         }
 305         free(udpif->conns);
 306         udpif->conns = NULL;
 307         udpif->n_conns = 0;
 308     }
 309 }
 310
 311 void
 312 udpif_destroy(struct udpif *udpif)
 313 {
 314     udpif_stop_threads(udpif);
 315
 316     list_remove(&udpif->list_node);
 317     latch_destroy(&udpif->exit_latch);
 318     seq_destroy(udpif->reval_seq);
 319     seq_destroy(udpif->dump_seq);
 320     ovs_mutex_destroy(&udpif->n_flows_mutex);
 321     free(udpif);
 322 }
 323
 324 /* Stops the handler and revalidator threads, must be enclosed in
 325  * ovsrcu quiescent state unless when destroying udpif. */
 326 static void
 327 udpif_stop_threads(struct udpif *udpif)
 328 {
 329     if (udpif && (udpif->n_handlers != 0 || udpif->n_revalidators != 0)) {
 330         size_t i;
 331
 332         latch_set(&udpif->exit_latch);
 333
 334         for (i = 0; i < udpif->n_handlers; i++) {
 335             struct handler *handler = &udpif->handlers[i];
 336
 337             xpthread_join(handler->thread, NULL);
 338         }
 339
 340         for (i = 0; i < udpif->n_revalidators; i++) {
 341             xpthread_join(udpif->revalidators[i].thread, NULL);
 342         }
 343
 344         dpif_disable_upcall(udpif->dpif);
 345
 346         for (i = 0; i < udpif->n_revalidators; i++) {
 347             struct revalidator *revalidator = &udpif->revalidators[i];
 348
 349             /* Delete ukeys, and delete all flows from the datapath to prevent
 350              * double-counting stats. */
 351             revalidator_purge(revalidator);
 352
 353             hmap_destroy(&udpif->ukeys[i].hmap);
 354             ovs_mutex_destroy(&udpif->ukeys[i].mutex);
 355         }
 356
 357         latch_poll(&udpif->exit_latch);
 358
 359         ovs_barrier_destroy(&udpif->reval_barrier);
 360
 361         free(udpif->revalidators);
 362         udpif->revalidators = NULL;
 363         udpif->n_revalidators = 0;
 364
 365         free(udpif->handlers);
 366         udpif->handlers = NULL;
 367         udpif->n_handlers = 0;
 368
 369         free(udpif->ukeys);
 370         udpif->ukeys = NULL;
 371     }
 372 }
 373
 374 /* Starts the handler and revalidator threads, must be enclosed in
 375  * ovsrcu quiescent state. */
 376 static void
 377 udpif_start_threads(struct udpif *udpif, size_t n_handlers,
 378                     size_t n_revalidators)
 379 {
 380     if (udpif && n_handlers && n_revalidators) {
 381         size_t i;
 382
 383         udpif->n_handlers = n_handlers;
 384         udpif->n_revalidators = n_revalidators;
 385
 386         udpif->handlers = xzalloc(udpif->n_handlers * sizeof *udpif->handlers);
 387         for (i = 0; i < udpif->n_handlers; i++) {
 388             struct handler *handler = &udpif->handlers[i];
 389
 390             handler->udpif = udpif;
 391             handler->handler_id = i;
 392             handler->thread = ovs_thread_create(
 393                 "handler", udpif_upcall_handler, handler);
 394         }
 395
 396         dpif_enable_upcall(udpif->dpif);
 397
 398         ovs_barrier_init(&udpif->reval_barrier, udpif->n_revalidators);
 399         udpif->reval_exit = false;
 400         udpif->revalidators = xzalloc(udpif->n_revalidators
 401                                       * sizeof *udpif->revalidators);
 402         udpif->ukeys = xmalloc(sizeof *udpif->ukeys * n_revalidators);
 403         for (i = 0; i < udpif->n_revalidators; i++) {
 404             struct revalidator *revalidator = &udpif->revalidators[i];
 405
 406             revalidator->udpif = udpif;
 407             hmap_init(&udpif->ukeys[i].hmap);
 408             ovs_mutex_init(&udpif->ukeys[i].mutex);
 409             revalidator->ukeys = &udpif->ukeys[i].hmap;
 410             revalidator->thread = ovs_thread_create(
 411                 "revalidator", udpif_revalidator, revalidator);
 412         }
 413     }
 414 }
 415
 416 /* Tells 'udpif' how many threads it should use to handle upcalls.
 417  * 'n_handlers' and 'n_revalidators' can never be zero.  'udpif''s
 418  * datapath handle must have packet reception enabled before starting
 419  * threads. */
 420 void
 421 udpif_set_threads(struct udpif *udpif, size_t n_handlers,
 422                   size_t n_revalidators)
 423 {
 424     ovs_assert(udpif);
 425     ovs_assert(n_handlers && n_revalidators);
 426
 427     ovsrcu_quiesce_start();
 428     if (udpif->n_handlers != n_handlers
 429         || udpif->n_revalidators != n_revalidators) {
 430         udpif_stop_threads(udpif);
 431     }
 432
 433     if (!udpif->handlers && !udpif->revalidators) {
 434         int error;
 435
 436         error = dpif_handlers_set(udpif->dpif, n_handlers);
 437         if (error) {
 438             VLOG_ERR("failed to configure handlers in dpif %s: %s",
 439                      dpif_name(udpif->dpif), ovs_strerror(error));
 440             return;
 441         }
 442
 443         udpif_start_threads(udpif, n_handlers, n_revalidators);
 444     }
 445     ovsrcu_quiesce_end();
 446 }
 447
 448 /* Waits for all ongoing upcall translations to complete.  This ensures that
 449  * there are no transient references to any removed ofprotos (or other
 450  * objects).  In particular, this should be called after an ofproto is removed
 451  * (e.g. via xlate_remove_ofproto()) but before it is destroyed. */
 452 void
 453 udpif_synchronize(struct udpif *udpif)
 454 {
 455     /* This is stronger than necessary.  It would be sufficient to ensure
 456      * (somehow) that each handler and revalidator thread had passed through
 457      * its main loop once. */
 458     size_t n_handlers = udpif->n_handlers;
 459     size_t n_revalidators = udpif->n_revalidators;
 460
 461     ovsrcu_quiesce_start();
 462     udpif_stop_threads(udpif);
 463     udpif_start_threads(udpif, n_handlers, n_revalidators);
 464     ovsrcu_quiesce_end();
 465 }
 466
 467 /* Notifies 'udpif' that something changed which may render previous
 468  * xlate_actions() results invalid. */
 469 void
 470 udpif_revalidate(struct udpif *udpif)
 471 {
 472     seq_change(udpif->reval_seq);
 473 }
 474
 475 /* Returns a seq which increments every time 'udpif' pulls stats from the
 476  * datapath.  Callers can use this to get a sense of when might be a good time
 477  * to do periodic work which relies on relatively up to date statistics. */
 478 struct seq *
 479 udpif_dump_seq(struct udpif *udpif)
 480 {
 481     return udpif->dump_seq;
 482 }
 483
 484 void
 485 udpif_get_memory_usage(struct udpif *udpif, struct simap *usage)
 486 {
 487     size_t i;
 488
 489     simap_increase(usage, "handlers", udpif->n_handlers);
 490
 491     simap_increase(usage, "revalidators", udpif->n_revalidators);
 492     for (i = 0; i < udpif->n_revalidators; i++) {
 493         ovs_mutex_lock(&udpif->ukeys[i].mutex);
 494         simap_increase(usage, "udpif keys", hmap_count(&udpif->ukeys[i].hmap));
 495         ovs_mutex_unlock(&udpif->ukeys[i].mutex);
 496     }
 497 }
 498
 499 /* Remove flows from a single datapath. */
 500 void
 501 udpif_flush(struct udpif *udpif)
 502 {
 503     size_t n_handlers, n_revalidators;
 504
 505     n_handlers = udpif->n_handlers;
 506     n_revalidators = udpif->n_revalidators;
 507
 508     ovsrcu_quiesce_start();
 509
 510     udpif_stop_threads(udpif);
 511     dpif_flow_flush(udpif->dpif);
 512     udpif_start_threads(udpif, n_handlers, n_revalidators);
 513
 514     ovsrcu_quiesce_end();
 515 }
 516
 517 /* Removes all flows from all datapaths. */
 518 static void
 519 udpif_flush_all_datapaths(void)
 520 {
 521     struct udpif *udpif;
 522
 523     LIST_FOR_EACH (udpif, list_node, &all_udpifs) {
 524         udpif_flush(udpif);
 525     }
 526 }
 527
 528 \f
 529 static unsigned long
 530 udpif_get_n_flows(struct udpif *udpif)
 531 {
 532     long long int time, now;
 533     unsigned long flow_count;
 534
 535     now = time_msec();
 536     atomic_read_relaxed(&udpif->n_flows_timestamp, &time);
 537     if (time < now - 100 && !ovs_mutex_trylock(&udpif->n_flows_mutex)) {
 538         struct dpif_dp_stats stats;
 539
 540         atomic_store_relaxed(&udpif->n_flows_timestamp, now);
 541         dpif_get_dp_stats(udpif->dpif, &stats);
 542         flow_count = stats.n_flows;
 543         atomic_store_relaxed(&udpif->n_flows, flow_count);
 544         ovs_mutex_unlock(&udpif->n_flows_mutex);
 545     } else {
 546         atomic_read_relaxed(&udpif->n_flows, &flow_count);
 547     }
 548     return flow_count;
 549 }
 550
 551 /* The upcall handler thread tries to read a batch of UPCALL_MAX_BATCH
 552  * upcalls from dpif, processes the batch and installs corresponding flows
 553  * in dpif. */
 554 static void *
 555 udpif_upcall_handler(void *arg)
 556 {
 557     struct handler *handler = arg;
 558     struct udpif *udpif = handler->udpif;
 559
 560     while (!latch_is_set(&handler->udpif->exit_latch)) {
 561         if (!recv_upcalls(handler)) {
 562             dpif_recv_wait(udpif->dpif, handler->handler_id);
 563             latch_wait(&udpif->exit_latch);
 564             poll_block();
 565         }
 566         coverage_clear();
 567     }
 568
 569     return NULL;
 570 }
 571
 572 static size_t
 573 recv_upcalls(struct handler *handler)
 574 {
 575     struct udpif *udpif = handler->udpif;
 576     uint64_t recv_stubs[UPCALL_MAX_BATCH][512 / 8];
 577     struct ofpbuf recv_bufs[UPCALL_MAX_BATCH];
 578     struct dpif_upcall dupcalls[UPCALL_MAX_BATCH];
 579     struct upcall upcalls[UPCALL_MAX_BATCH];
 580     struct flow flows[UPCALL_MAX_BATCH];
 581     size_t n_upcalls, i;
 582
 583     n_upcalls = 0;
 584     while (n_upcalls < UPCALL_MAX_BATCH) {
 585         struct ofpbuf *recv_buf = &recv_bufs[n_upcalls];
 586         struct dpif_upcall *dupcall = &dupcalls[n_upcalls];
 587         struct upcall *upcall = &upcalls[n_upcalls];
 588         struct flow *flow = &flows[n_upcalls];
 589         struct pkt_metadata md;
 590         int error;
 591
 592         ofpbuf_use_stub(recv_buf, recv_stubs[n_upcalls],
 593                         sizeof recv_stubs[n_upcalls]);
 594         if (dpif_recv(udpif->dpif, handler->handler_id, dupcall, recv_buf)) {
 595             ofpbuf_uninit(recv_buf);
 596             break;
 597         }
 598
 599         if (odp_flow_key_to_flow(dupcall->key, dupcall->key_len, flow)
 600             == ODP_FIT_ERROR) {
 601             goto free_dupcall;
 602         }
 603
 604         error = upcall_receive(upcall, udpif->backer, &dupcall->packet,
 605                                dupcall->type, dupcall->userdata, flow);
 606         if (error) {
 607             if (error == ENODEV) {
 608                 /* Received packet on datapath port for which we couldn't
 609                  * associate an ofproto.  This can happen if a port is removed
 610                  * while traffic is being received.  Print a rate-limited
 611                  * message in case it happens frequently. */
 612                 dpif_flow_put(udpif->dpif, DPIF_FP_CREATE, dupcall->key,
 613                               dupcall->key_len, NULL, 0, NULL, 0, NULL);
 614                 VLOG_INFO_RL(&rl, "received packet on unassociated datapath "
 615                              "port %"PRIu32, flow->in_port.odp_port);
 616             }
 617             goto free_dupcall;
 618         }
 619
 620         upcall->key = dupcall->key;
 621         upcall->key_len = dupcall->key_len;
 622
 623         upcall->out_tun_key = dupcall->out_tun_key;
 624
 625         if (vsp_adjust_flow(upcall->ofproto, flow, &dupcall->packet)) {
 626             upcall->vsp_adjusted = true;
 627         }
 628
 629         md = pkt_metadata_from_flow(flow);
 630         flow_extract(&dupcall->packet, &md, flow);
 631
 632         error = process_upcall(udpif, upcall, NULL);
 633         if (error) {
 634             goto cleanup;
 635         }
 636
 637         n_upcalls++;
 638         continue;
 639
 640 cleanup:
 641         upcall_uninit(upcall);
 642 free_dupcall:
 643         ofpbuf_uninit(&dupcall->packet);
 644         ofpbuf_uninit(recv_buf);
 645     }
 646
 647     if (n_upcalls) {
 648         handle_upcalls(handler->udpif, upcalls, n_upcalls);
 649         for (i = 0; i < n_upcalls; i++) {
 650             ofpbuf_uninit(&dupcalls[i].packet);
 651             ofpbuf_uninit(&recv_bufs[i]);
 652             upcall_uninit(&upcalls[i]);
 653         }
 654     }
 655
 656     return n_upcalls;
 657 }
 658
 659 static void *
 660 udpif_revalidator(void *arg)
 661 {
 662     /* Used by all revalidators. */
 663     struct revalidator *revalidator = arg;
 664     struct udpif *udpif = revalidator->udpif;
 665     bool leader = revalidator == &udpif->revalidators[0];
 666
 667     /* Used only by the leader. */
 668     long long int start_time = 0;
 669     uint64_t last_reval_seq = 0;
 670     size_t n_flows = 0;
 671
 672     revalidator->id = ovsthread_id_self();
 673     for (;;) {
 674         if (leader) {
 675             uint64_t reval_seq;
 676
 677             reval_seq = seq_read(udpif->reval_seq);
 678             udpif->need_revalidate = last_reval_seq != reval_seq;
 679             last_reval_seq = reval_seq;
 680
 681             n_flows = udpif_get_n_flows(udpif);
 682             udpif->max_n_flows = MAX(n_flows, udpif->max_n_flows);
 683             udpif->avg_n_flows = (udpif->avg_n_flows + n_flows) / 2;
 684
 685             /* Only the leader checks the exit latch to prevent a race where
 686              * some threads think it's true and exit and others think it's
 687              * false and block indefinitely on the reval_barrier */
 688             udpif->reval_exit = latch_is_set(&udpif->exit_latch);
 689
 690             start_time = time_msec();
 691             if (!udpif->reval_exit) {
 692                 udpif->dump = dpif_flow_dump_create(udpif->dpif);
 693             }
 694         }
 695
 696         /* Wait for the leader to start the flow dump. */
 697         ovs_barrier_block(&udpif->reval_barrier);
 698         if (udpif->reval_exit) {
 699             break;
 700         }
 701         revalidate(revalidator);
 702
 703         /* Wait for all flows to have been dumped before we garbage collect. */
 704         ovs_barrier_block(&udpif->reval_barrier);
 705         revalidator_sweep(revalidator);
 706
 707         /* Wait for all revalidators to finish garbage collection. */
 708         ovs_barrier_block(&udpif->reval_barrier);
 709
 710         if (leader) {
 711             unsigned int flow_limit;
 712             long long int duration;
 713
 714             atomic_read_relaxed(&udpif->flow_limit, &flow_limit);
 715
 716             dpif_flow_dump_destroy(udpif->dump);
 717             seq_change(udpif->dump_seq);
 718
 719             duration = MAX(time_msec() - start_time, 1);
 720             udpif->dump_duration = duration;
 721             if (duration > 2000) {
 722                 flow_limit /= duration / 1000;
 723             } else if (duration > 1300) {
 724                 flow_limit = flow_limit * 3 / 4;
 725             } else if (duration < 1000 && n_flows > 2000
 726                        && flow_limit < n_flows * 1000 / duration) {
 727                 flow_limit += 1000;
 728             }
 729             flow_limit = MIN(ofproto_flow_limit, MAX(flow_limit, 1000));
 730             atomic_store_relaxed(&udpif->flow_limit, flow_limit);
 731
 732             if (duration > 2000) {
 733                 VLOG_INFO("Spent an unreasonably long %lldms dumping flows",
 734                           duration);
 735             }
 736
 737             poll_timer_wait_until(start_time + MIN(ofproto_max_idle, 500));
 738             seq_wait(udpif->reval_seq, last_reval_seq);
 739             latch_wait(&udpif->exit_latch);
 740             poll_block();
 741         }
 742     }
 743
 744     return NULL;
 745 }
 746 \f
 747 static enum upcall_type
 748 classify_upcall(enum dpif_upcall_type type, const struct nlattr *userdata)
 749 {
 750     union user_action_cookie cookie;
 751     size_t userdata_len;
 752
 753     /* First look at the upcall type. */
 754     switch (type) {
 755     case DPIF_UC_ACTION:
 756         break;
 757
 758     case DPIF_UC_MISS:
 759         return MISS_UPCALL;
 760
 761     case DPIF_N_UC_TYPES:
 762     default:
 763         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32, type);
 764         return BAD_UPCALL;
 765     }
 766
 767     /* "action" upcalls need a closer look. */
 768     if (!userdata) {
 769         VLOG_WARN_RL(&rl, "action upcall missing cookie");
 770         return BAD_UPCALL;
 771     }
 772     userdata_len = nl_attr_get_size(userdata);
 773     if (userdata_len < sizeof cookie.type
 774         || userdata_len > sizeof cookie) {
 775         VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %"PRIuSIZE,
 776                      userdata_len);
 777         return BAD_UPCALL;
 778     }
 779     memset(&cookie, 0, sizeof cookie);
 780     memcpy(&cookie, nl_attr_get(userdata), userdata_len);
 781     if (userdata_len == MAX(8, sizeof cookie.sflow)
 782         && cookie.type == USER_ACTION_COOKIE_SFLOW) {
 783         return SFLOW_UPCALL;
 784     } else if (userdata_len == MAX(8, sizeof cookie.slow_path)
 785                && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
 786         return MISS_UPCALL;
 787     } else if (userdata_len == MAX(8, sizeof cookie.flow_sample)
 788                && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
 789         return FLOW_SAMPLE_UPCALL;
 790     } else if (userdata_len == MAX(8, sizeof cookie.ipfix)
 791                && cookie.type == USER_ACTION_COOKIE_IPFIX) {
 792         return IPFIX_UPCALL;
 793     } else {
 794         VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
 795                      " and size %"PRIuSIZE, cookie.type, userdata_len);
 796         return BAD_UPCALL;
 797     }
 798 }
 799
 800 /* Calculates slow path actions for 'xout'.  'buf' must statically be
 801  * initialized with at least 128 bytes of space. */
 802 static void
 803 compose_slow_path(struct udpif *udpif, struct xlate_out *xout,
 804                   const struct flow *flow, odp_port_t odp_in_port,
 805                   struct ofpbuf *buf)
 806 {
 807     union user_action_cookie cookie;
 808     odp_port_t port;
 809     uint32_t pid;
 810
 811     cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
 812     cookie.slow_path.unused = 0;
 813     cookie.slow_path.reason = xout->slow;
 814
 815     port = xout->slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)
 816         ? ODPP_NONE
 817         : odp_in_port;
 818     pid = dpif_port_get_pid(udpif->dpif, port, flow_hash_5tuple(flow, 0));
 819     odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path, ODPP_NONE,
 820                              buf);
 821 }
 822
 823 /* If there is no error, the upcall must be destroyed with upcall_uninit()
 824  * before quiescing, as the referred objects are guaranteed to exist only
 825  * until the calling thread quiesces.  Otherwise, do not call upcall_uninit()
 826  * since the 'upcall->put_actions' remains uninitialized. */
 827 static int
 828 upcall_receive(struct upcall *upcall, const struct dpif_backer *backer,
 829                const struct ofpbuf *packet, enum dpif_upcall_type type,
 830                const struct nlattr *userdata, const struct flow *flow)
 831 {
 832     int error;
 833
 834     error = xlate_lookup(backer, flow, &upcall->ofproto, &upcall->ipfix,
 835                          &upcall->sflow, NULL, &upcall->in_port);
 836     if (error) {
 837         return error;
 838     }
 839
 840     upcall->flow = flow;
 841     upcall->packet = packet;
 842     upcall->type = type;
 843     upcall->userdata = userdata;
 844     ofpbuf_init(&upcall->put_actions, 0);
 845
 846     upcall->xout_initialized = false;
 847     upcall->vsp_adjusted = false;
 848
 849     upcall->key = NULL;
 850     upcall->key_len = 0;
 851
 852     upcall->out_tun_key = NULL;
 853
 854     return 0;
 855 }
 856
 857 static void
 858 upcall_xlate(struct udpif *udpif, struct upcall *upcall,
 859              struct ofpbuf *odp_actions)
 860 {
 861     struct dpif_flow_stats stats;
 862     struct xlate_in xin;
 863
 864     stats.n_packets = 1;
 865     stats.n_bytes = ofpbuf_size(upcall->packet);
 866     stats.used = time_msec();
 867     stats.tcp_flags = ntohs(upcall->flow->tcp_flags);
 868
 869     xlate_in_init(&xin, upcall->ofproto, upcall->flow, upcall->in_port, NULL,
 870                   stats.tcp_flags, upcall->packet);
 871     xin.odp_actions = odp_actions;
 872
 873     if (upcall->type == DPIF_UC_MISS) {
 874         xin.resubmit_stats = &stats;
 875     } else {
 876         /* For non-miss upcalls, there's a flow in the datapath which this
 877          * packet was accounted to.  Presumably the revalidators will deal
 878          * with pushing its stats eventually. */
 879     }
 880
 881     xlate_actions(&xin, &upcall->xout);
 882     upcall->xout_initialized = true;
 883
 884     /* Special case for fail-open mode.
 885      *
 886      * If we are in fail-open mode, but we are connected to a controller too,
 887      * then we should send the packet up to the controller in the hope that it
 888      * will try to set up a flow and thereby allow us to exit fail-open.
 889      *
 890      * See the top-level comment in fail-open.c for more information.
 891      *
 892      * Copy packets before they are modified by execution. */
 893     if (upcall->xout.fail_open) {
 894         const struct ofpbuf *packet = upcall->packet;
 895         struct ofproto_packet_in *pin;
 896
 897         pin = xmalloc(sizeof *pin);
 898         pin->up.packet = xmemdup(ofpbuf_data(packet), ofpbuf_size(packet));
 899         pin->up.packet_len = ofpbuf_size(packet);
 900         pin->up.reason = OFPR_NO_MATCH;
 901         pin->up.table_id = 0;
 902         pin->up.cookie = OVS_BE64_MAX;
 903         flow_get_metadata(upcall->flow, &pin->up.fmd);
 904         pin->send_len = 0; /* Not used for flow table misses. */
 905         pin->miss_type = OFPROTO_PACKET_IN_NO_MISS;
 906         ofproto_dpif_send_packet_in(upcall->ofproto, pin);
 907     }
 908
 909     if (!upcall->xout.slow) {
 910         ofpbuf_use_const(&upcall->put_actions,
 911                          ofpbuf_data(upcall->xout.odp_actions),
 912                          ofpbuf_size(upcall->xout.odp_actions));
 913     } else {
 914         ofpbuf_init(&upcall->put_actions, 0);
 915         compose_slow_path(udpif, &upcall->xout, upcall->flow,
 916                           upcall->flow->in_port.odp_port,
 917                           &upcall->put_actions);
 918     }
 919 }
 920
 921 static void
 922 upcall_uninit(struct upcall *upcall)
 923 {
 924     if (upcall) {
 925         if (upcall->xout_initialized) {
 926             xlate_out_uninit(&upcall->xout);
 927         }
 928         ofpbuf_uninit(&upcall->put_actions);
 929     }
 930 }
 931
 932 static int
 933 upcall_cb(const struct ofpbuf *packet, const struct flow *flow,
 934           enum dpif_upcall_type type, const struct nlattr *userdata,
 935           struct ofpbuf *actions, struct flow_wildcards *wc,
 936           struct ofpbuf *put_actions, void *aux)
 937 {
 938     struct udpif *udpif = aux;
 939     unsigned int flow_limit;
 940     struct upcall upcall;
 941     bool megaflow;
 942     int error;
 943
 944     atomic_read_relaxed(&enable_megaflows, &megaflow);
 945     atomic_read_relaxed(&udpif->flow_limit, &flow_limit);
 946
 947     error = upcall_receive(&upcall, udpif->backer, packet, type, userdata,
 948                            flow);
 949     if (error) {
 950         return error;
 951     }
 952
 953     error = process_upcall(udpif, &upcall, actions);
 954     if (error) {
 955         goto out;
 956     }
 957
 958     if (upcall.xout.slow && put_actions) {
 959         ofpbuf_put(put_actions, ofpbuf_data(&upcall.put_actions),
 960                    ofpbuf_size(&upcall.put_actions));
 961     }
 962
 963     if (OVS_LIKELY(wc)) {
 964         if (megaflow) {
 965             /* XXX: This could be avoided with sufficient API changes. */
 966             *wc = upcall.xout.wc;
 967         } else {
 968             flow_wildcards_init_for_packet(wc, flow);
 969         }
 970     }
 971
 972     if (udpif_get_n_flows(udpif) >= flow_limit) {
 973         error = ENOSPC;
 974     }
 975
 976 out:
 977     upcall_uninit(&upcall);
 978     return error;
 979 }
 980
 981 static int
 982 process_upcall(struct udpif *udpif, struct upcall *upcall,
 983                struct ofpbuf *odp_actions)
 984 {
 985     const struct nlattr *userdata = upcall->userdata;
 986     const struct ofpbuf *packet = upcall->packet;
 987     const struct flow *flow = upcall->flow;
 988
 989     switch (classify_upcall(upcall->type, userdata)) {
 990     case MISS_UPCALL:
 991         upcall_xlate(udpif, upcall, odp_actions);
 992         return 0;
 993
 994     case SFLOW_UPCALL:
 995         if (upcall->sflow) {
 996             union user_action_cookie cookie;
 997
 998             memset(&cookie, 0, sizeof cookie);
 999             memcpy(&cookie, nl_attr_get(userdata), sizeof cookie.sflow);
1000             dpif_sflow_received(upcall->sflow, packet, flow,
1001                                 flow->in_port.odp_port, &cookie);
1002         }
1003         break;
1004
1005     case IPFIX_UPCALL:
1006         if (upcall->ipfix) {
1007             union user_action_cookie cookie;
1008             struct flow_tnl output_tunnel_key;
1009
1010             memset(&cookie, 0, sizeof cookie);
1011             memcpy(&cookie, nl_attr_get(userdata), sizeof cookie.ipfix);
1012
1013             if (upcall->out_tun_key) {
1014                 memset(&output_tunnel_key, 0, sizeof output_tunnel_key);
1015                 odp_tun_key_from_attr(upcall->out_tun_key,
1016                                       &output_tunnel_key);
1017             }
1018             dpif_ipfix_bridge_sample(upcall->ipfix, packet, flow,
1019                                      flow->in_port.odp_port,
1020                                      cookie.ipfix.output_odp_port,
1021                                      upcall->out_tun_key ?
1022                                          &output_tunnel_key : NULL);
1023         }
1024         break;
1025
1026     case FLOW_SAMPLE_UPCALL:
1027         if (upcall->ipfix) {
1028             union user_action_cookie cookie;
1029
1030             memset(&cookie, 0, sizeof cookie);
1031             memcpy(&cookie, nl_attr_get(userdata), sizeof cookie.flow_sample);
1032
1033             /* The flow reflects exactly the contents of the packet.
1034              * Sample the packet using it. */
1035             dpif_ipfix_flow_sample(upcall->ipfix, packet, flow,
1036                                    cookie.flow_sample.collector_set_id,
1037                                    cookie.flow_sample.probability,
1038                                    cookie.flow_sample.obs_domain_id,
1039                                    cookie.flow_sample.obs_point_id);
1040         }
1041         break;
1042
1043     case BAD_UPCALL:
1044         break;
1045     }
1046
1047     return EAGAIN;
1048 }
1049
1050 static void
1051 handle_upcalls(struct udpif *udpif, struct upcall *upcalls,
1052                size_t n_upcalls)
1053 {
1054     struct odputil_keybuf mask_bufs[UPCALL_MAX_BATCH];
1055     struct dpif_op *opsp[UPCALL_MAX_BATCH * 2];
1056     struct dpif_op ops[UPCALL_MAX_BATCH * 2];
1057     unsigned int flow_limit;
1058     size_t n_ops, i;
1059     bool may_put;
1060     bool megaflow;
1061
1062     atomic_read_relaxed(&udpif->flow_limit, &flow_limit);
1063     atomic_read_relaxed(&enable_megaflows, &megaflow);
1064
1065     may_put = udpif_get_n_flows(udpif) < flow_limit;
1066
1067     /* Handle the packets individually in order of arrival.
1068      *
1069      *   - For SLOW_CFM, SLOW_LACP, SLOW_STP, and SLOW_BFD, translation is what
1070      *     processes received packets for these protocols.
1071      *
1072      *   - For SLOW_CONTROLLER, translation sends the packet to the OpenFlow
1073      *     controller.
1074      *
1075      * The loop fills 'ops' with an array of operations to execute in the
1076      * datapath. */
1077     n_ops = 0;
1078     for (i = 0; i < n_upcalls; i++) {
1079         struct upcall *upcall = &upcalls[i];
1080         const struct ofpbuf *packet = upcall->packet;
1081         struct dpif_op *op;
1082
1083         if (upcall->vsp_adjusted) {
1084             /* This packet was received on a VLAN splinter port.  We added a
1085              * VLAN to the packet to make the packet resemble the flow, but the
1086              * actions were composed assuming that the packet contained no
1087              * VLAN.  So, we must remove the VLAN header from the packet before
1088              * trying to execute the actions. */
1089             if (ofpbuf_size(upcall->xout.odp_actions)) {
1090                 eth_pop_vlan(CONST_CAST(struct ofpbuf *, upcall->packet));
1091             }
1092
1093             /* Remove the flow vlan tags inserted by vlan splinter logic
1094              * to ensure megaflow masks generated match the data path flow. */
1095             CONST_CAST(struct flow *, upcall->flow)->vlan_tci = 0;
1096         }
1097
1098         /* Do not install a flow into the datapath if:
1099          *
1100          *    - The datapath already has too many flows.
1101          *
1102          *    - We received this packet via some flow installed in the kernel
1103          *      already. */
1104         if (may_put && upcall->type == DPIF_UC_MISS) {
1105             struct ofpbuf mask;
1106
1107             ofpbuf_use_stack(&mask, &mask_bufs[i], sizeof mask_bufs[i]);
1108
1109             if (megaflow) {
1110                 size_t max_mpls;
1111                 bool recirc;
1112
1113                 recirc = ofproto_dpif_get_enable_recirc(upcall->ofproto);
1114                 max_mpls = ofproto_dpif_get_max_mpls_depth(upcall->ofproto);
1115                 odp_flow_key_from_mask(&mask, &upcall->xout.wc.masks,
1116                                        upcall->flow, UINT32_MAX, max_mpls,
1117                                        recirc);
1118             }
1119
1120             op = &ops[n_ops++];
1121             op->type = DPIF_OP_FLOW_PUT;
1122             op->u.flow_put.flags = DPIF_FP_CREATE;
1123             op->u.flow_put.key = upcall->key;
1124             op->u.flow_put.key_len = upcall->key_len;
1125             op->u.flow_put.mask = ofpbuf_data(&mask);
1126             op->u.flow_put.mask_len = ofpbuf_size(&mask);
1127             op->u.flow_put.stats = NULL;
1128             op->u.flow_put.actions = ofpbuf_data(&upcall->put_actions);
1129             op->u.flow_put.actions_len = ofpbuf_size(&upcall->put_actions);
1130         }
1131
1132         if (ofpbuf_size(upcall->xout.odp_actions)) {
1133             op = &ops[n_ops++];
1134             op->type = DPIF_OP_EXECUTE;
1135             op->u.execute.packet = CONST_CAST(struct ofpbuf *, packet);
1136             odp_key_to_pkt_metadata(upcall->key, upcall->key_len,
1137                                     &op->u.execute.md);
1138             op->u.execute.actions = ofpbuf_data(upcall->xout.odp_actions);
1139             op->u.execute.actions_len = ofpbuf_size(upcall->xout.odp_actions);
1140             op->u.execute.needs_help = (upcall->xout.slow & SLOW_ACTION) != 0;
1141             op->u.execute.probe = false;
1142         }
1143     }
1144
1145     /* Execute batch. */
1146     for (i = 0; i < n_ops; i++) {
1147         opsp[i] = &ops[i];
1148     }
1149     dpif_operate(udpif->dpif, opsp, n_ops);
1150 }
1151
1152 /* Must be called with udpif->ukeys[hash % udpif->n_revalidators].mutex. */
1153 static struct udpif_key *
1154 ukey_lookup(struct udpif *udpif, const struct nlattr *key, size_t key_len,
1155             uint32_t hash)
1156     OVS_REQUIRES(udpif->ukeys->mutex)
1157 {
1158     struct udpif_key *ukey;
1159     struct hmap *hmap = &udpif->ukeys[hash % udpif->n_revalidators].hmap;
1160
1161     HMAP_FOR_EACH_WITH_HASH (ukey, hmap_node, hash, hmap) {
1162         if (ukey->key_len == key_len && !memcmp(ukey->key, key, key_len)) {
1163             return ukey;
1164         }
1165     }
1166     return NULL;
1167 }
1168
1169 /* Creates a ukey for 'key' and 'key_len', returning it with ukey->mutex in
1170  * a locked state. */
1171 static struct udpif_key *
1172 ukey_create(const struct nlattr *key, size_t key_len, long long int used)
1173     OVS_NO_THREAD_SAFETY_ANALYSIS
1174 {
1175     struct udpif_key *ukey = xmalloc(sizeof *ukey);
1176
1177     ovs_mutex_init(&ukey->mutex);
1178     ukey->key = &ukey->key_buf_nla;
1179     memcpy(&ukey->key_buf, key, key_len);
1180     ukey->key_len = key_len;
1181
1182     ovs_mutex_lock(&ukey->mutex);
1183     ukey->dump_seq = 0;
1184     ukey->flow_exists = true;
1185     ukey->created = used ? used : time_msec();
1186     memset(&ukey->stats, 0, sizeof ukey->stats);
1187     ukey->xcache = NULL;
1188
1189     return ukey;
1190 }
1191
1192 /* Searches for a ukey in 'udpif->ukeys' that matches 'key' and 'key_len' and
1193  * attempts to lock the ukey. If the ukey does not exist, create it.
1194  *
1195  * Returns true on success, setting *result to the matching ukey and returning
1196  * it in a locked state. Otherwise, returns false and clears *result. */
1197 static bool
1198 ukey_acquire(struct udpif *udpif, const struct nlattr *key, size_t key_len,
1199              long long int used, struct udpif_key **result)
1200     OVS_TRY_LOCK(true, (*result)->mutex)
1201 {
1202     struct udpif_key *ukey;
1203     uint32_t hash, idx;
1204     bool locked = false;
1205
1206     hash = hash_bytes(key, key_len, udpif->secret);
1207     idx = hash % udpif->n_revalidators;
1208
1209     ovs_mutex_lock(&udpif->ukeys[idx].mutex);
1210     ukey = ukey_lookup(udpif, key, key_len, hash);
1211     if (!ukey) {
1212         ukey = ukey_create(key, key_len, used);
1213         hmap_insert(&udpif->ukeys[idx].hmap, &ukey->hmap_node, hash);
1214         locked = true;
1215     } else if (!ovs_mutex_trylock(&ukey->mutex)) {
1216         locked = true;
1217     }
1218     ovs_mutex_unlock(&udpif->ukeys[idx].mutex);
1219
1220     if (locked) {
1221         *result = ukey;
1222     } else {
1223         *result = NULL;
1224     }
1225     return locked;
1226 }
1227
1228 static void
1229 ukey_delete(struct revalidator *revalidator, struct udpif_key *ukey)
1230     OVS_NO_THREAD_SAFETY_ANALYSIS
1231 {
1232     if (revalidator) {
1233         hmap_remove(revalidator->ukeys, &ukey->hmap_node);
1234     }
1235     xlate_cache_delete(ukey->xcache);
1236     ovs_mutex_destroy(&ukey->mutex);
1237     free(ukey);
1238 }
1239
1240 static bool
1241 should_revalidate(const struct udpif *udpif, uint64_t packets,
1242                   long long int used)
1243 {
1244     long long int metric, now, duration;
1245
1246     if (udpif->dump_duration < 200) {
1247         /* We are likely to handle full revalidation for the flows. */
1248         return true;
1249     }
1250
1251     /* Calculate the mean time between seeing these packets. If this
1252      * exceeds the threshold, then delete the flow rather than performing
1253      * costly revalidation for flows that aren't being hit frequently.
1254      *
1255      * This is targeted at situations where the dump_duration is high (~1s),
1256      * and revalidation is triggered by a call to udpif_revalidate(). In
1257      * these situations, revalidation of all flows causes fluctuations in the
1258      * flow_limit due to the interaction with the dump_duration and max_idle.
1259      * This tends to result in deletion of low-throughput flows anyway, so
1260      * skip the revalidation and just delete those flows. */
1261     packets = MAX(packets, 1);
1262     now = MAX(used, time_msec());
1263     duration = now - used;
1264     metric = duration / packets;
1265
1266     if (metric < 200) {
1267         /* The flow is receiving more than ~5pps, so keep it. */
1268         return true;
1269     }
1270     return false;
1271 }
1272
1273 static bool
1274 revalidate_ukey(struct udpif *udpif, struct udpif_key *ukey,
1275                 const struct dpif_flow *f)
1276     OVS_REQUIRES(ukey->mutex)
1277 {
1278     uint64_t slow_path_buf[128 / 8];
1279     struct xlate_out xout, *xoutp;
1280     struct netflow *netflow;
1281     struct ofproto_dpif *ofproto;
1282     struct dpif_flow_stats push;
1283     struct ofpbuf xout_actions;
1284     struct flow flow, dp_mask;
1285     uint32_t *dp32, *xout32;
1286     ofp_port_t ofp_in_port;
1287     struct xlate_in xin;
1288     long long int last_used;
1289     int error;
1290     size_t i;
1291     bool ok;
1292
1293     ok = false;
1294     xoutp = NULL;
1295     netflow = NULL;
1296
1297     last_used = ukey->stats.used;
1298     push.used = f->stats.used;
1299     push.tcp_flags = f->stats.tcp_flags;
1300     push.n_packets = (f->stats.n_packets > ukey->stats.n_packets
1301                       ? f->stats.n_packets - ukey->stats.n_packets
1302                       : 0);
1303     push.n_bytes = (f->stats.n_bytes > ukey->stats.n_bytes
1304                     ? f->stats.n_bytes - ukey->stats.n_bytes
1305                     : 0);
1306
1307     if (udpif->need_revalidate && last_used
1308         && !should_revalidate(udpif, push.n_packets, last_used)) {
1309         ok = false;
1310         goto exit;
1311     }
1312
1313     /* We will push the stats, so update the ukey stats cache. */
1314     ukey->stats = f->stats;
1315     if (!push.n_packets && !udpif->need_revalidate) {
1316         ok = true;
1317         goto exit;
1318     }
1319
1320     if (ukey->xcache && !udpif->need_revalidate) {
1321         xlate_push_stats(ukey->xcache, &push);
1322         ok = true;
1323         goto exit;
1324     }
1325
1326     if (odp_flow_key_to_flow(ukey->key, ukey->key_len, &flow)
1327         == ODP_FIT_ERROR) {
1328         goto exit;
1329     }
1330
1331     error = xlate_lookup(udpif->backer, &flow, &ofproto, NULL, NULL, &netflow,
1332                          &ofp_in_port);
1333     if (error) {
1334         goto exit;
1335     }
1336
1337     if (udpif->need_revalidate) {
1338         xlate_cache_clear(ukey->xcache);
1339     }
1340     if (!ukey->xcache) {
1341         ukey->xcache = xlate_cache_new();
1342     }
1343
1344     xlate_in_init(&xin, ofproto, &flow, ofp_in_port, NULL, push.tcp_flags,
1345                   NULL);
1346     if (push.n_packets) {
1347         xin.resubmit_stats = &push;
1348         xin.may_learn = true;
1349     }
1350     xin.xcache = ukey->xcache;
1351     xin.skip_wildcards = !udpif->need_revalidate;
1352     xlate_actions(&xin, &xout);
1353     xoutp = &xout;
1354
1355     if (!udpif->need_revalidate) {
1356         ok = true;
1357         goto exit;
1358     }
1359
1360     if (!xout.slow) {
1361         ofpbuf_use_const(&xout_actions, ofpbuf_data(xout.odp_actions),
1362                          ofpbuf_size(xout.odp_actions));
1363     } else {
1364         ofpbuf_use_stack(&xout_actions, slow_path_buf, sizeof slow_path_buf);
1365         compose_slow_path(udpif, &xout, &flow, flow.in_port.odp_port,
1366                           &xout_actions);
1367     }
1368
1369     if (f->actions_len != ofpbuf_size(&xout_actions)
1370         || memcmp(ofpbuf_data(&xout_actions), f->actions, f->actions_len)) {
1371         goto exit;
1372     }
1373
1374     if (odp_flow_key_to_mask(f->mask, f->mask_len, &dp_mask, &flow)
1375         == ODP_FIT_ERROR) {
1376         goto exit;
1377     }
1378
1379     /* Since the kernel is free to ignore wildcarded bits in the mask, we can't
1380      * directly check that the masks are the same.  Instead we check that the
1381      * mask in the kernel is more specific i.e. less wildcarded, than what
1382      * we've calculated here.  This guarantees we don't catch any packets we
1383      * shouldn't with the megaflow. */
1384     dp32 = (uint32_t *) &dp_mask;
1385     xout32 = (uint32_t *) &xout.wc.masks;
1386     for (i = 0; i < FLOW_U32S; i++) {
1387         if ((dp32[i] | xout32[i]) != dp32[i]) {
1388             goto exit;
1389         }
1390     }
1391     ok = true;
1392
1393 exit:
1394     if (netflow && !ok) {
1395         netflow_flow_clear(netflow, &flow);
1396     }
1397     xlate_out_uninit(xoutp);
1398     return ok;
1399 }
1400
1401 struct dump_op {
1402     struct udpif_key *ukey;
1403     struct dpif_flow_stats stats; /* Stats for 'op'. */
1404     struct dpif_op op;            /* Flow del operation. */
1405 };
1406
1407 static void
1408 dump_op_init(struct dump_op *op, const struct nlattr *key, size_t key_len,
1409              struct udpif_key *ukey)
1410 {
1411     op->ukey = ukey;
1412     op->op.type = DPIF_OP_FLOW_DEL;
1413     op->op.u.flow_del.key = key;
1414     op->op.u.flow_del.key_len = key_len;
1415     op->op.u.flow_del.stats = &op->stats;
1416 }
1417
1418 static void
1419 push_dump_ops__(struct udpif *udpif, struct dump_op *ops, size_t n_ops)
1420 {
1421     struct dpif_op *opsp[REVALIDATE_MAX_BATCH];
1422     size_t i;
1423
1424     ovs_assert(n_ops <= REVALIDATE_MAX_BATCH);
1425     for (i = 0; i < n_ops; i++) {
1426         opsp[i] = &ops[i].op;
1427     }
1428     dpif_operate(udpif->dpif, opsp, n_ops);
1429
1430     for (i = 0; i < n_ops; i++) {
1431         struct dump_op *op = &ops[i];
1432         struct dpif_flow_stats *push, *stats, push_buf;
1433
1434         stats = op->op.u.flow_del.stats;
1435         push = &push_buf;
1436
1437         ovs_mutex_lock(&op->ukey->mutex);
1438         push->used = MAX(stats->used, op->ukey->stats.used);
1439         push->tcp_flags = stats->tcp_flags | op->ukey->stats.tcp_flags;
1440         push->n_packets = stats->n_packets - op->ukey->stats.n_packets;
1441         push->n_bytes = stats->n_bytes - op->ukey->stats.n_bytes;
1442         ovs_mutex_unlock(&op->ukey->mutex);
1443
1444         if (push->n_packets || netflow_exists()) {
1445             struct ofproto_dpif *ofproto;
1446             struct netflow *netflow;
1447             ofp_port_t ofp_in_port;
1448             struct flow flow;
1449             int error;
1450
1451             ovs_mutex_lock(&op->ukey->mutex);
1452             if (op->ukey->xcache) {
1453                 xlate_push_stats(op->ukey->xcache, push);
1454                 ovs_mutex_unlock(&op->ukey->mutex);
1455                 continue;
1456             }
1457             ovs_mutex_unlock(&op->ukey->mutex);
1458
1459             if (odp_flow_key_to_flow(op->op.u.flow_del.key,
1460                                      op->op.u.flow_del.key_len, &flow)
1461                 == ODP_FIT_ERROR) {
1462                 continue;
1463             }
1464
1465             error = xlate_lookup(udpif->backer, &flow, &ofproto,
1466                                  NULL, NULL, &netflow, &ofp_in_port);
1467             if (!error) {
1468                 struct xlate_in xin;
1469
1470                 xlate_in_init(&xin, ofproto, &flow, ofp_in_port, NULL,
1471                               push->tcp_flags, NULL);
1472                 xin.resubmit_stats = push->n_packets ? push : NULL;
1473                 xin.may_learn = push->n_packets > 0;
1474                 xin.skip_wildcards = true;
1475                 xlate_actions_for_side_effects(&xin);
1476
1477                 if (netflow) {
1478                     netflow_flow_clear(netflow, &flow);
1479                 }
1480             }
1481         }
1482     }
1483 }
1484
1485 static void
1486 push_dump_ops(struct revalidator *revalidator,
1487               struct dump_op *ops, size_t n_ops)
1488 {
1489     int i;
1490
1491     push_dump_ops__(revalidator->udpif, ops, n_ops);
1492     for (i = 0; i < n_ops; i++) {
1493         ukey_delete(revalidator, ops[i].ukey);
1494     }
1495 }
1496
1497 static void
1498 revalidate(struct revalidator *revalidator)
1499 {
1500     struct udpif *udpif = revalidator->udpif;
1501     struct dpif_flow_dump_thread *dump_thread;
1502     uint64_t dump_seq;
1503     unsigned int flow_limit;
1504
1505     dump_seq = seq_read(udpif->dump_seq);
1506     atomic_read_relaxed(&udpif->flow_limit, &flow_limit);
1507     dump_thread = dpif_flow_dump_thread_create(udpif->dump);
1508     for (;;) {
1509         struct dump_op ops[REVALIDATE_MAX_BATCH];
1510         int n_ops = 0;
1511
1512         struct dpif_flow flows[REVALIDATE_MAX_BATCH];
1513         const struct dpif_flow *f;
1514         int n_dumped;
1515
1516         long long int max_idle;
1517         long long int now;
1518         size_t n_dp_flows;
1519         bool kill_them_all;
1520
1521         n_dumped = dpif_flow_dump_next(dump_thread, flows, ARRAY_SIZE(flows));
1522         if (!n_dumped) {
1523             break;
1524         }
1525
1526         now = time_msec();
1527
1528         /* In normal operation we want to keep flows around until they have
1529          * been idle for 'ofproto_max_idle' milliseconds.  However:
1530          *
1531          *     - If the number of datapath flows climbs above 'flow_limit',
1532          *       drop that down to 100 ms to try to bring the flows down to
1533          *       the limit.
1534          *
1535          *     - If the number of datapath flows climbs above twice
1536          *       'flow_limit', delete all the datapath flows as an emergency
1537          *       measure.  (We reassess this condition for the next batch of
1538          *       datapath flows, so we will recover before all the flows are
1539          *       gone.) */
1540         n_dp_flows = udpif_get_n_flows(udpif);
1541         kill_them_all = n_dp_flows > flow_limit * 2;
1542         max_idle = n_dp_flows > flow_limit ? 100 : ofproto_max_idle;
1543
1544         for (f = flows; f < &flows[n_dumped]; f++) {
1545             long long int used = f->stats.used;
1546             struct udpif_key *ukey;
1547             bool already_dumped, keep;
1548
1549             if (!ukey_acquire(udpif, f->key, f->key_len, used, &ukey)) {
1550                 /* We couldn't acquire the ukey. This means that
1551                  * another revalidator is processing this flow
1552                  * concurrently, so don't bother processing it. */
1553                 COVERAGE_INC(dumped_duplicate_flow);
1554                 continue;
1555             }
1556
1557             already_dumped = ukey->dump_seq == dump_seq;
1558             if (already_dumped) {
1559                 /* The flow has already been handled during this flow dump
1560                  * operation. Skip it. */
1561                 if (ukey->xcache) {
1562                     COVERAGE_INC(dumped_duplicate_flow);
1563                 } else {
1564                     COVERAGE_INC(dumped_new_flow);
1565                 }
1566                 ovs_mutex_unlock(&ukey->mutex);
1567                 continue;
1568             }
1569
1570             if (!used) {
1571                 used = ukey->created;
1572             }
1573             if (kill_them_all || (used && used < now - max_idle)) {
1574                 keep = false;
1575             } else {
1576                 keep = revalidate_ukey(udpif, ukey, f);
1577             }
1578             ukey->dump_seq = dump_seq;
1579             ukey->flow_exists = keep;
1580
1581             if (!keep) {
1582                 dump_op_init(&ops[n_ops++], f->key, f->key_len, ukey);
1583             }
1584             ovs_mutex_unlock(&ukey->mutex);
1585         }
1586
1587         if (n_ops) {
1588             push_dump_ops__(udpif, ops, n_ops);
1589         }
1590     }
1591     dpif_flow_dump_thread_destroy(dump_thread);
1592 }
1593
1594 /* Called with exclusive access to 'revalidator' and 'ukey'. */
1595 static bool
1596 handle_missed_revalidation(struct revalidator *revalidator,
1597                            struct udpif_key *ukey)
1598     OVS_NO_THREAD_SAFETY_ANALYSIS
1599 {
1600     struct udpif *udpif = revalidator->udpif;
1601     struct dpif_flow flow;
1602     struct ofpbuf buf;
1603     uint64_t stub[DPIF_FLOW_BUFSIZE / 8];
1604     bool keep = false;
1605
1606     COVERAGE_INC(revalidate_missed_dp_flow);
1607
1608     ofpbuf_use_stub(&buf, &stub, sizeof stub);
1609     if (!dpif_flow_get(udpif->dpif, ukey->key, ukey->key_len, &buf, &flow)) {
1610         keep = revalidate_ukey(udpif, ukey, &flow);
1611     }
1612     ofpbuf_uninit(&buf);
1613
1614     return keep;
1615 }
1616
1617 static void
1618 revalidator_sweep__(struct revalidator *revalidator, bool purge)
1619     OVS_NO_THREAD_SAFETY_ANALYSIS
1620 {
1621     struct dump_op ops[REVALIDATE_MAX_BATCH];
1622     struct udpif_key *ukey, *next;
1623     size_t n_ops;
1624     uint64_t dump_seq;
1625
1626     n_ops = 0;
1627     dump_seq = seq_read(revalidator->udpif->dump_seq);
1628
1629     /* During garbage collection, this revalidator completely owns its ukeys
1630      * map, and therefore doesn't need to do any locking. */
1631     HMAP_FOR_EACH_SAFE (ukey, next, hmap_node, revalidator->ukeys) {
1632         if (ukey->flow_exists
1633             && (purge
1634                 || (ukey->dump_seq != dump_seq
1635                     && revalidator->udpif->need_revalidate
1636                     && !handle_missed_revalidation(revalidator, ukey)))) {
1637             struct dump_op *op = &ops[n_ops++];
1638
1639             dump_op_init(op, ukey->key, ukey->key_len, ukey);
1640             if (n_ops == REVALIDATE_MAX_BATCH) {
1641                 push_dump_ops(revalidator, ops, n_ops);
1642                 n_ops = 0;
1643             }
1644         } else if (!ukey->flow_exists) {
1645             ukey_delete(revalidator, ukey);
1646         }
1647     }
1648
1649     if (n_ops) {
1650         push_dump_ops(revalidator, ops, n_ops);
1651     }
1652 }
1653
1654 static void
1655 revalidator_sweep(struct revalidator *revalidator)
1656 {
1657     revalidator_sweep__(revalidator, false);
1658 }
1659
1660 static void
1661 revalidator_purge(struct revalidator *revalidator)
1662 {
1663     revalidator_sweep__(revalidator, true);
1664 }
1665 \f
1666 static void
1667 upcall_unixctl_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
1668                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
1669 {
1670     struct ds ds = DS_EMPTY_INITIALIZER;
1671     struct udpif *udpif;
1672
1673     LIST_FOR_EACH (udpif, list_node, &all_udpifs) {
1674         unsigned int flow_limit;
1675         size_t i;
1676
1677         atomic_read_relaxed(&udpif->flow_limit, &flow_limit);
1678
1679         ds_put_format(&ds, "%s:\n", dpif_name(udpif->dpif));
1680         ds_put_format(&ds, "\tflows         : (current %lu)"
1681             " (avg %u) (max %u) (limit %u)\n", udpif_get_n_flows(udpif),
1682             udpif->avg_n_flows, udpif->max_n_flows, flow_limit);
1683         ds_put_format(&ds, "\tdump duration : %lldms\n", udpif->dump_duration);
1684
1685         ds_put_char(&ds, '\n');
1686         for (i = 0; i < n_revalidators; i++) {
1687             struct revalidator *revalidator = &udpif->revalidators[i];
1688
1689             ovs_mutex_lock(&udpif->ukeys[i].mutex);
1690             ds_put_format(&ds, "\t%u: (keys %"PRIuSIZE")\n",
1691                           revalidator->id, hmap_count(&udpif->ukeys[i].hmap));
1692             ovs_mutex_unlock(&udpif->ukeys[i].mutex);
1693         }
1694     }
1695
1696     unixctl_command_reply(conn, ds_cstr(&ds));
1697     ds_destroy(&ds);
1698 }
1699
1700 /* Disable using the megaflows.
1701  *
1702  * This command is only needed for advanced debugging, so it's not
1703  * documented in the man page. */
1704 static void
1705 upcall_unixctl_disable_megaflows(struct unixctl_conn *conn,
1706                                  int argc OVS_UNUSED,
1707                                  const char *argv[] OVS_UNUSED,
1708                                  void *aux OVS_UNUSED)
1709 {
1710     atomic_store_relaxed(&enable_megaflows, false);
1711     udpif_flush_all_datapaths();
1712     unixctl_command_reply(conn, "megaflows disabled");
1713 }
1714
1715 /* Re-enable using megaflows.
1716  *
1717  * This command is only needed for advanced debugging, so it's not
1718  * documented in the man page. */
1719 static void
1720 upcall_unixctl_enable_megaflows(struct unixctl_conn *conn,
1721                                 int argc OVS_UNUSED,
1722                                 const char *argv[] OVS_UNUSED,
1723                                 void *aux OVS_UNUSED)
1724 {
1725     atomic_store_relaxed(&enable_megaflows, true);
1726     udpif_flush_all_datapaths();
1727     unixctl_command_reply(conn, "megaflows enabled");
1728 }
1729
1730 /* Set the flow limit.
1731  *
1732  * This command is only needed for advanced debugging, so it's not
1733  * documented in the man page. */
1734 static void
1735 upcall_unixctl_set_flow_limit(struct unixctl_conn *conn,
1736                               int argc OVS_UNUSED,
1737                               const char *argv[] OVS_UNUSED,
1738                               void *aux OVS_UNUSED)
1739 {
1740     struct ds ds = DS_EMPTY_INITIALIZER;
1741     struct udpif *udpif;
1742     unsigned int flow_limit = atoi(argv[1]);
1743
1744     LIST_FOR_EACH (udpif, list_node, &all_udpifs) {
1745         atomic_store_relaxed(&udpif->flow_limit, flow_limit);
1746     }
1747     ds_put_format(&ds, "set flow_limit to %u\n", flow_limit);
1748     unixctl_command_reply(conn, ds_cstr(&ds));
1749     ds_destroy(&ds);
1750 }
1751
1752 static void
1753 upcall_unixctl_dump_wait(struct unixctl_conn *conn,
1754                          int argc OVS_UNUSED,
1755                          const char *argv[] OVS_UNUSED,
1756                          void *aux OVS_UNUSED)
1757 {
1758     if (list_is_singleton(&all_udpifs)) {
1759         struct udpif *udpif = NULL;
1760         size_t len;
1761
1762         udpif = OBJECT_CONTAINING(list_front(&all_udpifs), udpif, list_node);
1763         len = (udpif->n_conns + 1) * sizeof *udpif->conns;
1764         udpif->conn_seq = seq_read(udpif->dump_seq);
1765         udpif->conns = xrealloc(udpif->conns, len);
1766         udpif->conns[udpif->n_conns++] = conn;
1767     } else {
1768         unixctl_command_reply_error(conn, "can't wait on multiple udpifs.");
1769     }
1770 }