ofproto/ofproto-dpif-upcall.c

   1 /* Copyright (c) 2009, 2010, 2011, 2012, 2013 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 "packets.h"
  36 #include "poll-loop.h"
  37 #include "seq.h"
  38 #include "unixctl.h"
  39 #include "vlog.h"
  40
  41 #define MAX_QUEUE_LENGTH 512
  42 #define FLOW_MISS_MAX_BATCH 50
  43 #define REVALIDATE_MAX_BATCH 50
  44
  45 VLOG_DEFINE_THIS_MODULE(ofproto_dpif_upcall);
  46
  47 COVERAGE_DEFINE(upcall_queue_overflow);
  48
  49 /* A thread that processes each upcall handed to it by the dispatcher thread,
  50  * forwards the upcall's packet, and possibly sets up a kernel flow as a
  51  * cache. */
  52 struct handler {
  53     struct udpif *udpif;               /* Parent udpif. */
  54     pthread_t thread;                  /* Thread ID. */
  55     char *name;                        /* Thread name. */
  56
  57     struct ovs_mutex mutex;            /* Mutex guarding the following. */
  58
  59     /* Atomic queue of unprocessed upcalls. */
  60     struct list upcalls OVS_GUARDED;
  61     size_t n_upcalls OVS_GUARDED;
  62
  63     bool need_signal;                  /* Only changed by the dispatcher. */
  64
  65     pthread_cond_t wake_cond;          /* Wakes 'thread' while holding
  66                                           'mutex'. */
  67 };
  68
  69 /* A thread that processes each kernel flow handed to it by the flow_dumper
  70  * thread, updates OpenFlow statistics, and updates or removes the kernel flow
  71  * as necessary. */
  72 struct revalidator {
  73     struct udpif *udpif;               /* Parent udpif. */
  74     char *name;                        /* Thread name. */
  75
  76     pthread_t thread;                  /* Thread ID. */
  77     struct hmap ukeys;                 /* Datapath flow keys. */
  78
  79     uint64_t dump_seq;
  80
  81     struct ovs_mutex mutex;            /* Mutex guarding the following. */
  82     pthread_cond_t wake_cond;
  83     struct list udumps OVS_GUARDED;    /* Unprocessed udumps. */
  84     size_t n_udumps OVS_GUARDED;       /* Number of unprocessed udumps. */
  85 };
  86
  87 /* An upcall handler for ofproto_dpif.
  88  *
  89  * udpif has two logically separate pieces:
  90  *
  91  *    - A "dispatcher" thread that reads upcalls from the kernel and dispatches
  92  *      them to one of several "handler" threads (see struct handler).
  93  *
  94  *    - A "flow_dumper" thread that reads the kernel flow table and dispatches
  95  *      flows to one of several "revalidator" threads (see struct
  96  *      revalidator). */
  97 struct udpif {
  98     struct list list_node;             /* In all_udpifs list. */
  99
 100     struct dpif *dpif;                 /* Datapath handle. */
 101     struct dpif_backer *backer;        /* Opaque dpif_backer pointer. */
 102
 103     uint32_t secret;                   /* Random seed for upcall hash. */
 104
 105     pthread_t dispatcher;              /* Dispatcher thread ID. */
 106     pthread_t flow_dumper;             /* Flow dumper thread ID. */
 107
 108     struct handler *handlers;          /* Upcall handlers. */
 109     size_t n_handlers;
 110
 111     struct revalidator *revalidators;  /* Flow revalidators. */
 112     size_t n_revalidators;
 113
 114     uint64_t last_reval_seq;           /* 'reval_seq' at last revalidation. */
 115     struct seq *reval_seq;             /* Incremented to force revalidation. */
 116
 117     struct seq *dump_seq;              /* Increments each dump iteration. */
 118
 119     struct latch exit_latch;           /* Tells child threads to exit. */
 120
 121     long long int dump_duration;       /* Duration of the last flow dump. */
 122
 123     /* Datapath flow statistics. */
 124     unsigned int max_n_flows;
 125     unsigned int avg_n_flows;
 126
 127     /* Following fields are accessed and modified by different threads. */
 128     atomic_llong max_idle;             /* Maximum datapath flow idle time. */
 129     atomic_uint flow_limit;            /* Datapath flow hard limit. */
 130 };
 131
 132 enum upcall_type {
 133     BAD_UPCALL,                 /* Some kind of bug somewhere. */
 134     MISS_UPCALL,                /* A flow miss.  */
 135     SFLOW_UPCALL,               /* sFlow sample. */
 136     FLOW_SAMPLE_UPCALL,         /* Per-flow sampling. */
 137     IPFIX_UPCALL                /* Per-bridge sampling. */
 138 };
 139
 140 struct upcall {
 141     struct list list_node;          /* For queuing upcalls. */
 142     struct flow_miss *flow_miss;    /* This upcall's flow_miss. */
 143
 144     /* Raw upcall plus data for keeping track of the memory backing it. */
 145     struct dpif_upcall dpif_upcall; /* As returned by dpif_recv() */
 146     struct ofpbuf upcall_buf;       /* Owns some data in 'dpif_upcall'. */
 147     uint64_t upcall_stub[512 / 8];  /* Buffer to reduce need for malloc(). */
 148 };
 149
 150 /* 'udpif_key's are responsible for tracking the little bit of state udpif
 151  * needs to do flow expiration which can't be pulled directly from the
 152  * datapath.  They are owned, created by, maintained, and destroyed by a single
 153  * revalidator making them easy to efficiently handle with multiple threads. */
 154 struct udpif_key {
 155     struct hmap_node hmap_node;     /* In parent revalidator 'ukeys' map. */
 156
 157     struct nlattr *key;            /* Datapath flow key. */
 158     size_t key_len;                /* Length of 'key'. */
 159
 160     struct dpif_flow_stats stats;  /* Stats at most recent flow dump. */
 161     long long int created;         /* Estimation of creation time. */
 162
 163     bool mark;                     /* Used by mark and sweep GC algorithm. */
 164
 165     struct odputil_keybuf key_buf; /* Memory for 'key'. */
 166 };
 167
 168 /* 'udpif_flow_dump's hold the state associated with one iteration in a flow
 169  * dump operation.  This is created by the flow_dumper thread and handed to the
 170  * appropriate revalidator thread to be processed. */
 171 struct udpif_flow_dump {
 172     struct list list_node;
 173
 174     struct nlattr *key;            /* Datapath flow key. */
 175     size_t key_len;                /* Length of 'key'. */
 176     uint32_t key_hash;             /* Hash of 'key'. */
 177
 178     struct odputil_keybuf mask_buf;
 179     struct nlattr *mask;           /* Datapath mask for 'key'. */
 180     size_t mask_len;               /* Length of 'mask'. */
 181
 182     struct dpif_flow_stats stats;  /* Stats pulled from the datapath. */
 183
 184     bool need_revalidate;          /* Key needs revalidation? */
 185
 186     struct odputil_keybuf key_buf;
 187 };
 188
 189 /* Flow miss batching.
 190  *
 191  * Some dpifs implement operations faster when you hand them off in a batch.
 192  * To allow batching, "struct flow_miss" queues the dpif-related work needed
 193  * for a given flow.  Each "struct flow_miss" corresponds to sending one or
 194  * more packets, plus possibly installing the flow in the dpif. */
 195 struct flow_miss {
 196     struct hmap_node hmap_node;
 197     struct ofproto_dpif *ofproto;
 198
 199     struct flow flow;
 200     enum odp_key_fitness key_fitness;
 201     const struct nlattr *key;
 202     size_t key_len;
 203     enum dpif_upcall_type upcall_type;
 204     struct dpif_flow_stats stats;
 205     odp_port_t odp_in_port;
 206
 207     uint64_t slow_path_buf[128 / 8];
 208     struct odputil_keybuf mask_buf;
 209
 210     struct xlate_out xout;
 211 };
 212
 213 static void upcall_destroy(struct upcall *);
 214
 215 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 216 static struct list all_udpifs = LIST_INITIALIZER(&all_udpifs);
 217
 218 static void recv_upcalls(struct udpif *);
 219 static void handle_upcalls(struct handler *handler, struct list *upcalls);
 220 static void *udpif_flow_dumper(void *);
 221 static void *udpif_dispatcher(void *);
 222 static void *udpif_upcall_handler(void *);
 223 static void *udpif_revalidator(void *);
 224 static uint64_t udpif_get_n_flows(const struct udpif *);
 225 static void revalidate_udumps(struct revalidator *, struct list *udumps);
 226 static void revalidator_sweep(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 ukey_delete(struct revalidator *, struct udpif_key *);
 234
 235 static atomic_bool enable_megaflows = ATOMIC_VAR_INIT(true);
 236
 237 struct udpif *
 238 udpif_create(struct dpif_backer *backer, struct dpif *dpif)
 239 {
 240     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 241     struct udpif *udpif = xzalloc(sizeof *udpif);
 242
 243     if (ovsthread_once_start(&once)) {
 244         unixctl_command_register("upcall/show", "", 0, 0, upcall_unixctl_show,
 245                                  NULL);
 246         unixctl_command_register("upcall/disable-megaflows", "", 0, 0,
 247                                  upcall_unixctl_disable_megaflows, NULL);
 248         unixctl_command_register("upcall/enable-megaflows", "", 0, 0,
 249                                  upcall_unixctl_enable_megaflows, NULL);
 250         ovsthread_once_done(&once);
 251     }
 252
 253     udpif->dpif = dpif;
 254     udpif->backer = backer;
 255     atomic_init(&udpif->max_idle, 5000);
 256     atomic_init(&udpif->flow_limit, MIN(ofproto_flow_limit, 10000));
 257     udpif->secret = random_uint32();
 258     udpif->reval_seq = seq_create();
 259     udpif->dump_seq = seq_create();
 260     latch_init(&udpif->exit_latch);
 261     list_push_back(&all_udpifs, &udpif->list_node);
 262
 263     return udpif;
 264 }
 265
 266 void
 267 udpif_destroy(struct udpif *udpif)
 268 {
 269     udpif_set_threads(udpif, 0, 0);
 270     udpif_flush();
 271
 272     list_remove(&udpif->list_node);
 273     latch_destroy(&udpif->exit_latch);
 274     seq_destroy(udpif->reval_seq);
 275     seq_destroy(udpif->dump_seq);
 276     atomic_destroy(&udpif->max_idle);
 277     atomic_destroy(&udpif->flow_limit);
 278     free(udpif);
 279 }
 280
 281 /* Tells 'udpif' how many threads it should use to handle upcalls.  Disables
 282  * all threads if 'n_handlers' and 'n_revalidators' is zero.  'udpif''s
 283  * datapath handle must have packet reception enabled before starting threads.
 284  */
 285 void
 286 udpif_set_threads(struct udpif *udpif, size_t n_handlers,
 287                   size_t n_revalidators)
 288 {
 289     /* Stop the old threads (if any). */
 290     if (udpif->handlers &&
 291         (udpif->n_handlers != n_handlers
 292          || udpif->n_revalidators != n_revalidators)) {
 293         size_t i;
 294
 295         latch_set(&udpif->exit_latch);
 296
 297         for (i = 0; i < udpif->n_handlers; i++) {
 298             struct handler *handler = &udpif->handlers[i];
 299
 300             ovs_mutex_lock(&handler->mutex);
 301             xpthread_cond_signal(&handler->wake_cond);
 302             ovs_mutex_unlock(&handler->mutex);
 303             xpthread_join(handler->thread, NULL);
 304         }
 305
 306         for (i = 0; i < udpif->n_revalidators; i++) {
 307             struct revalidator *revalidator = &udpif->revalidators[i];
 308
 309             ovs_mutex_lock(&revalidator->mutex);
 310             xpthread_cond_signal(&revalidator->wake_cond);
 311             ovs_mutex_unlock(&revalidator->mutex);
 312             xpthread_join(revalidator->thread, NULL);
 313         }
 314
 315         xpthread_join(udpif->flow_dumper, NULL);
 316         xpthread_join(udpif->dispatcher, NULL);
 317
 318         for (i = 0; i < udpif->n_revalidators; i++) {
 319             struct revalidator *revalidator = &udpif->revalidators[i];
 320             struct udpif_flow_dump *udump, *next_udump;
 321             struct udpif_key *ukey, *next_ukey;
 322
 323             LIST_FOR_EACH_SAFE (udump, next_udump, list_node,
 324                                 &revalidator->udumps) {
 325                 list_remove(&udump->list_node);
 326                 free(udump);
 327             }
 328
 329             HMAP_FOR_EACH_SAFE (ukey, next_ukey, hmap_node,
 330                                 &revalidator->ukeys) {
 331                 ukey_delete(revalidator, ukey);
 332             }
 333             hmap_destroy(&revalidator->ukeys);
 334             ovs_mutex_destroy(&revalidator->mutex);
 335
 336             free(revalidator->name);
 337         }
 338
 339         for (i = 0; i < udpif->n_handlers; i++) {
 340             struct handler *handler = &udpif->handlers[i];
 341             struct upcall *miss, *next;
 342
 343             LIST_FOR_EACH_SAFE (miss, next, list_node, &handler->upcalls) {
 344                 list_remove(&miss->list_node);
 345                 upcall_destroy(miss);
 346             }
 347             ovs_mutex_destroy(&handler->mutex);
 348
 349             xpthread_cond_destroy(&handler->wake_cond);
 350             free(handler->name);
 351         }
 352         latch_poll(&udpif->exit_latch);
 353
 354         free(udpif->revalidators);
 355         udpif->revalidators = NULL;
 356         udpif->n_revalidators = 0;
 357
 358         free(udpif->handlers);
 359         udpif->handlers = NULL;
 360         udpif->n_handlers = 0;
 361     }
 362
 363     /* Start new threads (if necessary). */
 364     if (!udpif->handlers && n_handlers) {
 365         size_t i;
 366
 367         udpif->n_handlers = n_handlers;
 368         udpif->n_revalidators = n_revalidators;
 369
 370         udpif->handlers = xzalloc(udpif->n_handlers * sizeof *udpif->handlers);
 371         for (i = 0; i < udpif->n_handlers; i++) {
 372             struct handler *handler = &udpif->handlers[i];
 373
 374             handler->udpif = udpif;
 375             list_init(&handler->upcalls);
 376             handler->need_signal = false;
 377             xpthread_cond_init(&handler->wake_cond, NULL);
 378             ovs_mutex_init(&handler->mutex);
 379             xpthread_create(&handler->thread, NULL, udpif_upcall_handler,
 380                             handler);
 381         }
 382
 383         udpif->revalidators = xzalloc(udpif->n_revalidators
 384                                       * sizeof *udpif->revalidators);
 385         for (i = 0; i < udpif->n_revalidators; i++) {
 386             struct revalidator *revalidator = &udpif->revalidators[i];
 387
 388             revalidator->udpif = udpif;
 389             list_init(&revalidator->udumps);
 390             hmap_init(&revalidator->ukeys);
 391             ovs_mutex_init(&revalidator->mutex);
 392             xpthread_cond_init(&revalidator->wake_cond, NULL);
 393             xpthread_create(&revalidator->thread, NULL, udpif_revalidator,
 394                             revalidator);
 395         }
 396         xpthread_create(&udpif->dispatcher, NULL, udpif_dispatcher, udpif);
 397         xpthread_create(&udpif->flow_dumper, NULL, udpif_flow_dumper, udpif);
 398     }
 399 }
 400
 401 /* Notifies 'udpif' that something changed which may render previous
 402  * xlate_actions() results invalid. */
 403 void
 404 udpif_revalidate(struct udpif *udpif)
 405 {
 406     seq_change(udpif->reval_seq);
 407 }
 408
 409 /* Returns a seq which increments every time 'udpif' pulls stats from the
 410  * datapath.  Callers can use this to get a sense of when might be a good time
 411  * to do periodic work which relies on relatively up to date statistics. */
 412 struct seq *
 413 udpif_dump_seq(struct udpif *udpif)
 414 {
 415     return udpif->dump_seq;
 416 }
 417
 418 void
 419 udpif_get_memory_usage(struct udpif *udpif, struct simap *usage)
 420 {
 421     size_t i;
 422
 423     simap_increase(usage, "dispatchers", 1);
 424     simap_increase(usage, "flow_dumpers", 1);
 425
 426     simap_increase(usage, "handlers", udpif->n_handlers);
 427     for (i = 0; i < udpif->n_handlers; i++) {
 428         struct handler *handler = &udpif->handlers[i];
 429         ovs_mutex_lock(&handler->mutex);
 430         simap_increase(usage, "handler upcalls",  handler->n_upcalls);
 431         ovs_mutex_unlock(&handler->mutex);
 432     }
 433
 434     simap_increase(usage, "revalidators", udpif->n_revalidators);
 435     for (i = 0; i < udpif->n_revalidators; i++) {
 436         struct revalidator *revalidator = &udpif->revalidators[i];
 437         ovs_mutex_lock(&revalidator->mutex);
 438         simap_increase(usage, "revalidator dumps", revalidator->n_udumps);
 439
 440         /* XXX: This isn't technically thread safe because the revalidator
 441          * ukeys maps isn't protected by a mutex since it's per thread. */
 442         simap_increase(usage, "revalidator keys",
 443                        hmap_count(&revalidator->ukeys));
 444         ovs_mutex_unlock(&revalidator->mutex);
 445     }
 446 }
 447
 448 /* Removes all flows from all datapaths. */
 449 void
 450 udpif_flush(void)
 451 {
 452     struct udpif *udpif;
 453
 454     LIST_FOR_EACH (udpif, list_node, &all_udpifs) {
 455         dpif_flow_flush(udpif->dpif);
 456     }
 457 }
 458 \f
 459 /* Destroys and deallocates 'upcall'. */
 460 static void
 461 upcall_destroy(struct upcall *upcall)
 462 {
 463     if (upcall) {
 464         ofpbuf_uninit(&upcall->dpif_upcall.packet);
 465         ofpbuf_uninit(&upcall->upcall_buf);
 466         free(upcall);
 467     }
 468 }
 469
 470 static uint64_t
 471 udpif_get_n_flows(const struct udpif *udpif)
 472 {
 473     struct dpif_dp_stats stats;
 474
 475     dpif_get_dp_stats(udpif->dpif, &stats);
 476     return stats.n_flows;
 477 }
 478
 479 /* The dispatcher thread is responsible for receiving upcalls from the kernel,
 480  * assigning them to a upcall_handler thread. */
 481 static void *
 482 udpif_dispatcher(void *arg)
 483 {
 484     struct udpif *udpif = arg;
 485
 486     set_subprogram_name("dispatcher");
 487     while (!latch_is_set(&udpif->exit_latch)) {
 488         recv_upcalls(udpif);
 489         dpif_recv_wait(udpif->dpif);
 490         latch_wait(&udpif->exit_latch);
 491         poll_block();
 492     }
 493
 494     return NULL;
 495 }
 496
 497 static void *
 498 udpif_flow_dumper(void *arg)
 499 {
 500     struct udpif *udpif = arg;
 501
 502     set_subprogram_name("flow_dumper");
 503     while (!latch_is_set(&udpif->exit_latch)) {
 504         const struct dpif_flow_stats *stats;
 505         long long int start_time, duration;
 506         const struct nlattr *key, *mask;
 507         struct dpif_flow_dump dump;
 508         size_t key_len, mask_len;
 509         unsigned int flow_limit;
 510         long long int max_idle;
 511         bool need_revalidate;
 512         uint64_t reval_seq;
 513         size_t n_flows, i;
 514
 515         reval_seq = seq_read(udpif->reval_seq);
 516         need_revalidate = udpif->last_reval_seq != reval_seq;
 517         udpif->last_reval_seq = reval_seq;
 518
 519         n_flows = udpif_get_n_flows(udpif);
 520         udpif->max_n_flows = MAX(n_flows, udpif->max_n_flows);
 521         udpif->avg_n_flows = (udpif->avg_n_flows + n_flows) / 2;
 522
 523         atomic_read(&udpif->flow_limit, &flow_limit);
 524         if (n_flows < flow_limit / 8) {
 525             max_idle = 5000;
 526         } else if (n_flows < flow_limit / 4) {
 527             max_idle = 2000;
 528         } else if (n_flows < flow_limit / 2) {
 529             max_idle = 1000;
 530         } else {
 531             max_idle = 500;
 532         }
 533         atomic_store(&udpif->max_idle, max_idle);
 534
 535         start_time = time_msec();
 536         dpif_flow_dump_start(&dump, udpif->dpif);
 537         while (dpif_flow_dump_next(&dump, &key, &key_len, &mask, &mask_len,
 538                                    NULL, NULL, &stats)
 539                && !latch_is_set(&udpif->exit_latch)) {
 540             struct udpif_flow_dump *udump = xmalloc(sizeof *udump);
 541             struct revalidator *revalidator;
 542
 543             udump->key_hash = hash_bytes(key, key_len, udpif->secret);
 544             memcpy(&udump->key_buf, key, key_len);
 545             udump->key = (struct nlattr *) &udump->key_buf;
 546             udump->key_len = key_len;
 547
 548             memcpy(&udump->mask_buf, mask, mask_len);
 549             udump->mask = (struct nlattr *) &udump->mask_buf;
 550             udump->mask_len = mask_len;
 551
 552             udump->stats = *stats;
 553             udump->need_revalidate = need_revalidate;
 554
 555             revalidator = &udpif->revalidators[udump->key_hash
 556                 % udpif->n_revalidators];
 557
 558             ovs_mutex_lock(&revalidator->mutex);
 559             while (revalidator->n_udumps >= REVALIDATE_MAX_BATCH * 3
 560                    && !latch_is_set(&udpif->exit_latch)) {
 561                 ovs_mutex_cond_wait(&revalidator->wake_cond,
 562                                     &revalidator->mutex);
 563             }
 564             list_push_back(&revalidator->udumps, &udump->list_node);
 565             revalidator->n_udumps++;
 566             xpthread_cond_signal(&revalidator->wake_cond);
 567             ovs_mutex_unlock(&revalidator->mutex);
 568         }
 569         dpif_flow_dump_done(&dump);
 570
 571         /* Let all the revalidators finish and garbage collect. */
 572         seq_change(udpif->dump_seq);
 573         for (i = 0; i < udpif->n_revalidators; i++) {
 574             struct revalidator *revalidator = &udpif->revalidators[i];
 575             ovs_mutex_lock(&revalidator->mutex);
 576             xpthread_cond_signal(&revalidator->wake_cond);
 577             ovs_mutex_unlock(&revalidator->mutex);
 578         }
 579
 580         for (i = 0; i < udpif->n_revalidators; i++) {
 581             struct revalidator *revalidator = &udpif->revalidators[i];
 582
 583             ovs_mutex_lock(&revalidator->mutex);
 584             while (revalidator->dump_seq != seq_read(udpif->dump_seq)
 585                    && !latch_is_set(&udpif->exit_latch)) {
 586                 ovs_mutex_cond_wait(&revalidator->wake_cond,
 587                                     &revalidator->mutex);
 588             }
 589             ovs_mutex_unlock(&revalidator->mutex);
 590         }
 591
 592         duration = time_msec() - start_time;
 593         udpif->dump_duration = duration;
 594         if (duration > 2000) {
 595             flow_limit /= duration / 1000;
 596         } else if (duration > 1300) {
 597             flow_limit = flow_limit * 3 / 4;
 598         } else if (duration < 1000 && n_flows > 2000
 599                    && flow_limit < n_flows * 1000 / duration) {
 600             flow_limit += 1000;
 601         }
 602         flow_limit = MIN(ofproto_flow_limit, MAX(flow_limit, 1000));
 603         atomic_store(&udpif->flow_limit, flow_limit);
 604
 605         if (duration > 2000) {
 606             VLOG_INFO("Spent an unreasonably long %lldms dumping flows",
 607                       duration);
 608         }
 609
 610         poll_timer_wait_until(start_time + MIN(max_idle, 500));
 611         seq_wait(udpif->reval_seq, udpif->last_reval_seq);
 612         latch_wait(&udpif->exit_latch);
 613         poll_block();
 614     }
 615
 616     return NULL;
 617 }
 618
 619 /* The miss handler thread is responsible for processing miss upcalls retrieved
 620  * by the dispatcher thread.  Once finished it passes the processed miss
 621  * upcalls to ofproto-dpif where they're installed in the datapath. */
 622 static void *
 623 udpif_upcall_handler(void *arg)
 624 {
 625     struct handler *handler = arg;
 626
 627     handler->name = xasprintf("handler_%u", ovsthread_id_self());
 628     set_subprogram_name("%s", handler->name);
 629
 630     while (!latch_is_set(&handler->udpif->exit_latch)) {
 631         struct list misses = LIST_INITIALIZER(&misses);
 632         size_t i;
 633
 634         ovs_mutex_lock(&handler->mutex);
 635         if (!handler->n_upcalls) {
 636             ovs_mutex_cond_wait(&handler->wake_cond, &handler->mutex);
 637         }
 638
 639         for (i = 0; i < FLOW_MISS_MAX_BATCH; i++) {
 640             if (handler->n_upcalls) {
 641                 handler->n_upcalls--;
 642                 list_push_back(&misses, list_pop_front(&handler->upcalls));
 643             } else {
 644                 break;
 645             }
 646         }
 647         ovs_mutex_unlock(&handler->mutex);
 648
 649         handle_upcalls(handler, &misses);
 650
 651         coverage_clear();
 652     }
 653
 654     return NULL;
 655 }
 656
 657 static void *
 658 udpif_revalidator(void *arg)
 659 {
 660     struct revalidator *revalidator = arg;
 661
 662     revalidator->name = xasprintf("revalidator_%u", ovsthread_id_self());
 663     set_subprogram_name("%s", revalidator->name);
 664     for (;;) {
 665         struct list udumps = LIST_INITIALIZER(&udumps);
 666         struct udpif *udpif = revalidator->udpif;
 667         size_t i;
 668
 669         ovs_mutex_lock(&revalidator->mutex);
 670         if (latch_is_set(&udpif->exit_latch)) {
 671             ovs_mutex_unlock(&revalidator->mutex);
 672             return NULL;
 673         }
 674
 675         if (!revalidator->n_udumps) {
 676             if (revalidator->dump_seq != seq_read(udpif->dump_seq)) {
 677                 revalidator->dump_seq = seq_read(udpif->dump_seq);
 678                 revalidator_sweep(revalidator);
 679             } else {
 680                 ovs_mutex_cond_wait(&revalidator->wake_cond,
 681                                     &revalidator->mutex);
 682             }
 683         }
 684
 685         for (i = 0; i < REVALIDATE_MAX_BATCH && revalidator->n_udumps; i++) {
 686             list_push_back(&udumps, list_pop_front(&revalidator->udumps));
 687             revalidator->n_udumps--;
 688         }
 689
 690         /* Wake up the flow dumper. */
 691         xpthread_cond_signal(&revalidator->wake_cond);
 692         ovs_mutex_unlock(&revalidator->mutex);
 693
 694         if (!list_is_empty(&udumps)) {
 695             revalidate_udumps(revalidator, &udumps);
 696         }
 697     }
 698
 699     return NULL;
 700 }
 701 \f
 702 static enum upcall_type
 703 classify_upcall(const struct upcall *upcall)
 704 {
 705     const struct dpif_upcall *dpif_upcall = &upcall->dpif_upcall;
 706     union user_action_cookie cookie;
 707     size_t userdata_len;
 708
 709     /* First look at the upcall type. */
 710     switch (dpif_upcall->type) {
 711     case DPIF_UC_ACTION:
 712         break;
 713
 714     case DPIF_UC_MISS:
 715         return MISS_UPCALL;
 716
 717     case DPIF_N_UC_TYPES:
 718     default:
 719         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32,
 720                      dpif_upcall->type);
 721         return BAD_UPCALL;
 722     }
 723
 724     /* "action" upcalls need a closer look. */
 725     if (!dpif_upcall->userdata) {
 726         VLOG_WARN_RL(&rl, "action upcall missing cookie");
 727         return BAD_UPCALL;
 728     }
 729     userdata_len = nl_attr_get_size(dpif_upcall->userdata);
 730     if (userdata_len < sizeof cookie.type
 731         || userdata_len > sizeof cookie) {
 732         VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %"PRIuSIZE,
 733                      userdata_len);
 734         return BAD_UPCALL;
 735     }
 736     memset(&cookie, 0, sizeof cookie);
 737     memcpy(&cookie, nl_attr_get(dpif_upcall->userdata), userdata_len);
 738     if (userdata_len == sizeof cookie.sflow
 739         && cookie.type == USER_ACTION_COOKIE_SFLOW) {
 740         return SFLOW_UPCALL;
 741     } else if (userdata_len == sizeof cookie.slow_path
 742                && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
 743         return MISS_UPCALL;
 744     } else if (userdata_len == sizeof cookie.flow_sample
 745                && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
 746         return FLOW_SAMPLE_UPCALL;
 747     } else if (userdata_len == sizeof cookie.ipfix
 748                && cookie.type == USER_ACTION_COOKIE_IPFIX) {
 749         return IPFIX_UPCALL;
 750     } else {
 751         VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
 752                      " and size %"PRIuSIZE, cookie.type, userdata_len);
 753         return BAD_UPCALL;
 754     }
 755 }
 756
 757 static void
 758 recv_upcalls(struct udpif *udpif)
 759 {
 760     int n;
 761
 762     for (;;) {
 763         uint32_t hash = udpif->secret;
 764         struct handler *handler;
 765         struct upcall *upcall;
 766         size_t n_bytes, left;
 767         struct nlattr *nla;
 768         int error;
 769
 770         upcall = xmalloc(sizeof *upcall);
 771         ofpbuf_use_stub(&upcall->upcall_buf, upcall->upcall_stub,
 772                         sizeof upcall->upcall_stub);
 773         error = dpif_recv(udpif->dpif, &upcall->dpif_upcall,
 774                           &upcall->upcall_buf);
 775         if (error) {
 776             /* upcall_destroy() can only be called on successfully received
 777              * upcalls. */
 778             ofpbuf_uninit(&upcall->upcall_buf);
 779             free(upcall);
 780             break;
 781         }
 782
 783         n_bytes = 0;
 784         NL_ATTR_FOR_EACH (nla, left, upcall->dpif_upcall.key,
 785                           upcall->dpif_upcall.key_len) {
 786             enum ovs_key_attr type = nl_attr_type(nla);
 787             if (type == OVS_KEY_ATTR_IN_PORT
 788                 || type == OVS_KEY_ATTR_TCP
 789                 || type == OVS_KEY_ATTR_UDP) {
 790                 if (nl_attr_get_size(nla) == 4) {
 791                     hash = mhash_add(hash, nl_attr_get_u32(nla));
 792                     n_bytes += 4;
 793                 } else {
 794                     VLOG_WARN_RL(&rl,
 795                                  "Netlink attribute with incorrect size.");
 796                 }
 797             }
 798         }
 799         hash =  mhash_finish(hash, n_bytes);
 800
 801         handler = &udpif->handlers[hash % udpif->n_handlers];
 802
 803         ovs_mutex_lock(&handler->mutex);
 804         if (handler->n_upcalls < MAX_QUEUE_LENGTH) {
 805             list_push_back(&handler->upcalls, &upcall->list_node);
 806             if (handler->n_upcalls == 0) {
 807                 handler->need_signal = true;
 808             }
 809             handler->n_upcalls++;
 810             if (handler->need_signal &&
 811                 handler->n_upcalls >= FLOW_MISS_MAX_BATCH) {
 812                 handler->need_signal = false;
 813                 xpthread_cond_signal(&handler->wake_cond);
 814             }
 815             ovs_mutex_unlock(&handler->mutex);
 816             if (!VLOG_DROP_DBG(&rl)) {
 817                 struct ds ds = DS_EMPTY_INITIALIZER;
 818
 819                 odp_flow_key_format(upcall->dpif_upcall.key,
 820                                     upcall->dpif_upcall.key_len,
 821                                     &ds);
 822                 VLOG_DBG("dispatcher: enqueue (%s)", ds_cstr(&ds));
 823                 ds_destroy(&ds);
 824             }
 825         } else {
 826             ovs_mutex_unlock(&handler->mutex);
 827             COVERAGE_INC(upcall_queue_overflow);
 828             upcall_destroy(upcall);
 829         }
 830     }
 831
 832     for (n = 0; n < udpif->n_handlers; ++n) {
 833         struct handler *handler = &udpif->handlers[n];
 834
 835         if (handler->need_signal) {
 836             handler->need_signal = false;
 837             ovs_mutex_lock(&handler->mutex);
 838             xpthread_cond_signal(&handler->wake_cond);
 839             ovs_mutex_unlock(&handler->mutex);
 840         }
 841     }
 842 }
 843
 844 /* Calculates slow path actions for 'xout'.  'buf' must statically be
 845  * initialized with at least 128 bytes of space. */
 846 static void
 847 compose_slow_path(struct udpif *udpif, struct xlate_out *xout,
 848                   odp_port_t odp_in_port, struct ofpbuf *buf)
 849 {
 850     union user_action_cookie cookie;
 851     odp_port_t port;
 852     uint32_t pid;
 853
 854     cookie.type = USER_ACTION_COOKIE_SLOW_PATH;
 855     cookie.slow_path.unused = 0;
 856     cookie.slow_path.reason = xout->slow;
 857
 858     port = xout->slow & (SLOW_CFM | SLOW_BFD | SLOW_LACP | SLOW_STP)
 859         ? ODPP_NONE
 860         : odp_in_port;
 861     pid = dpif_port_get_pid(udpif->dpif, port);
 862     odp_put_userspace_action(pid, &cookie, sizeof cookie.slow_path, buf);
 863 }
 864
 865 static struct flow_miss *
 866 flow_miss_find(struct hmap *todo, const struct ofproto_dpif *ofproto,
 867                const struct flow *flow, uint32_t hash)
 868 {
 869     struct flow_miss *miss;
 870
 871     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
 872         if (miss->ofproto == ofproto && flow_equal(&miss->flow, flow)) {
 873             return miss;
 874         }
 875     }
 876
 877     return NULL;
 878 }
 879
 880 static void
 881 handle_upcalls(struct handler *handler, struct list *upcalls)
 882 {
 883     struct hmap misses = HMAP_INITIALIZER(&misses);
 884     struct udpif *udpif = handler->udpif;
 885
 886     struct flow_miss miss_buf[FLOW_MISS_MAX_BATCH];
 887     struct dpif_op *opsp[FLOW_MISS_MAX_BATCH * 2];
 888     struct dpif_op ops[FLOW_MISS_MAX_BATCH * 2];
 889     struct flow_miss *miss, *next_miss;
 890     struct upcall *upcall, *next;
 891     size_t n_misses, n_ops, i;
 892     unsigned int flow_limit;
 893     bool fail_open, may_put;
 894     enum upcall_type type;
 895
 896     atomic_read(&udpif->flow_limit, &flow_limit);
 897     may_put = udpif_get_n_flows(udpif) < flow_limit;
 898
 899     /* Extract the flow from each upcall.  Construct in 'misses' a hash table
 900      * that maps each unique flow to a 'struct flow_miss'.
 901      *
 902      * Most commonly there is a single packet per flow_miss, but there are
 903      * several reasons why there might be more than one, e.g.:
 904      *
 905      *   - The dpif packet interface does not support TSO (or UFO, etc.), so a
 906      *     large packet sent to userspace is split into a sequence of smaller
 907      *     ones.
 908      *
 909      *   - A stream of quickly arriving packets in an established "slow-pathed"
 910      *     flow.
 911      *
 912      *   - Rarely, a stream of quickly arriving packets in a flow not yet
 913      *     established.  (This is rare because most protocols do not send
 914      *     multiple back-to-back packets before receiving a reply from the
 915      *     other end of the connection, which gives OVS a chance to set up a
 916      *     datapath flow.)
 917      */
 918     n_misses = 0;
 919     LIST_FOR_EACH_SAFE (upcall, next, list_node, upcalls) {
 920         struct dpif_upcall *dupcall = &upcall->dpif_upcall;
 921         struct flow_miss *miss = &miss_buf[n_misses];
 922         struct ofpbuf *packet = &dupcall->packet;
 923         struct flow_miss *existing_miss;
 924         struct ofproto_dpif *ofproto;
 925         struct dpif_sflow *sflow;
 926         struct dpif_ipfix *ipfix;
 927         odp_port_t odp_in_port;
 928         struct flow flow;
 929         int error;
 930
 931         error = xlate_receive(udpif->backer, packet, dupcall->key,
 932                               dupcall->key_len, &flow, &miss->key_fitness,
 933                               &ofproto, &ipfix, &sflow, NULL, &odp_in_port);
 934         if (error) {
 935             if (error == ENODEV) {
 936                 /* Received packet on datapath port for which we couldn't
 937                  * associate an ofproto.  This can happen if a port is removed
 938                  * while traffic is being received.  Print a rate-limited
 939                  * message in case it happens frequently.  Install a drop flow
 940                  * so that future packets of the flow are inexpensively dropped
 941                  * in the kernel. */
 942                 VLOG_INFO_RL(&rl, "received packet on unassociated datapath "
 943                              "port %"PRIu32, odp_in_port);
 944                 dpif_flow_put(udpif->dpif, DPIF_FP_CREATE | DPIF_FP_MODIFY,
 945                               dupcall->key, dupcall->key_len, NULL, 0, NULL, 0,
 946                               NULL);
 947             }
 948             list_remove(&upcall->list_node);
 949             upcall_destroy(upcall);
 950             continue;
 951         }
 952
 953         type = classify_upcall(upcall);
 954         if (type == MISS_UPCALL) {
 955             uint32_t hash;
 956
 957             flow_extract(packet, flow.skb_priority, flow.pkt_mark,
 958                          &flow.tunnel, &flow.in_port, &miss->flow);
 959
 960             hash = flow_hash(&miss->flow, 0);
 961             existing_miss = flow_miss_find(&misses, ofproto, &miss->flow,
 962                                            hash);
 963             if (!existing_miss) {
 964                 hmap_insert(&misses, &miss->hmap_node, hash);
 965                 miss->ofproto = ofproto;
 966                 miss->key = dupcall->key;
 967                 miss->key_len = dupcall->key_len;
 968                 miss->upcall_type = dupcall->type;
 969                 miss->stats.n_packets = 0;
 970                 miss->stats.n_bytes = 0;
 971                 miss->stats.used = time_msec();
 972                 miss->stats.tcp_flags = 0;
 973                 miss->odp_in_port = odp_in_port;
 974
 975                 n_misses++;
 976             } else {
 977                 miss = existing_miss;
 978             }
 979             miss->stats.tcp_flags |= packet_get_tcp_flags(packet, &miss->flow);
 980             miss->stats.n_bytes += packet->size;
 981             miss->stats.n_packets++;
 982
 983             upcall->flow_miss = miss;
 984             continue;
 985         }
 986
 987         switch (type) {
 988         case SFLOW_UPCALL:
 989             if (sflow) {
 990                 union user_action_cookie cookie;
 991
 992                 memset(&cookie, 0, sizeof cookie);
 993                 memcpy(&cookie, nl_attr_get(dupcall->userdata),
 994                        sizeof cookie.sflow);
 995                 dpif_sflow_received(sflow, packet, &flow, odp_in_port,
 996                                     &cookie);
 997             }
 998             break;
 999         case IPFIX_UPCALL:
1000             if (ipfix) {
1001                 dpif_ipfix_bridge_sample(ipfix, packet, &flow);
1002             }
1003             break;
1004         case FLOW_SAMPLE_UPCALL:
1005             if (ipfix) {
1006                 union user_action_cookie cookie;
1007
1008                 memset(&cookie, 0, sizeof cookie);
1009                 memcpy(&cookie, nl_attr_get(dupcall->userdata),
1010                        sizeof cookie.flow_sample);
1011
1012                 /* The flow reflects exactly the contents of the packet.
1013                  * Sample the packet using it. */
1014                 dpif_ipfix_flow_sample(ipfix, packet, &flow,
1015                                        cookie.flow_sample.collector_set_id,
1016                                        cookie.flow_sample.probability,
1017                                        cookie.flow_sample.obs_domain_id,
1018                                        cookie.flow_sample.obs_point_id);
1019             }
1020             break;
1021         case BAD_UPCALL:
1022             break;
1023         case MISS_UPCALL:
1024             OVS_NOT_REACHED();
1025         }
1026
1027         dpif_ipfix_unref(ipfix);
1028         dpif_sflow_unref(sflow);
1029
1030         list_remove(&upcall->list_node);
1031         upcall_destroy(upcall);
1032     }
1033
1034     /* Initialize each 'struct flow_miss's ->xout.
1035      *
1036      * We do this per-flow_miss rather than per-packet because, most commonly,
1037      * all the packets in a flow can use the same translation.
1038      *
1039      * We can't do this in the previous loop because we need the TCP flags for
1040      * all the packets in each miss. */
1041     fail_open = false;
1042     HMAP_FOR_EACH (miss, hmap_node, &misses) {
1043         struct xlate_in xin;
1044
1045         xlate_in_init(&xin, miss->ofproto, &miss->flow, NULL,
1046                       miss->stats.tcp_flags, NULL);
1047         xin.may_learn = true;
1048
1049         if (miss->upcall_type == DPIF_UC_MISS) {
1050             xin.resubmit_stats = &miss->stats;
1051         } else {
1052             /* For non-miss upcalls, there's a flow in the datapath which this
1053              * packet was accounted to.  Presumably the revalidators will deal
1054              * with pushing its stats eventually. */
1055         }
1056
1057         xlate_actions(&xin, &miss->xout);
1058         fail_open = fail_open || miss->xout.fail_open;
1059     }
1060
1061     /* Now handle the packets individually in order of arrival.  In the common
1062      * case each packet of a miss can share the same actions, but slow-pathed
1063      * packets need to be translated individually:
1064      *
1065      *   - For SLOW_CFM, SLOW_LACP, SLOW_STP, and SLOW_BFD, translation is what
1066      *     processes received packets for these protocols.
1067      *
1068      *   - For SLOW_CONTROLLER, translation sends the packet to the OpenFlow
1069      *     controller.
1070      *
1071      * The loop fills 'ops' with an array of operations to execute in the
1072      * datapath. */
1073     n_ops = 0;
1074     LIST_FOR_EACH (upcall, list_node, upcalls) {
1075         struct flow_miss *miss = upcall->flow_miss;
1076         struct ofpbuf *packet = &upcall->dpif_upcall.packet;
1077         struct dpif_op *op;
1078         ovs_be16 flow_vlan_tci;
1079
1080         /* Save a copy of flow.vlan_tci in case it is changed to
1081          * generate proper mega flow masks for VLAN splinter flows. */
1082         flow_vlan_tci = miss->flow.vlan_tci;
1083
1084         if (miss->xout.slow) {
1085             struct xlate_in xin;
1086
1087             xlate_in_init(&xin, miss->ofproto, &miss->flow, NULL, 0, packet);
1088             xlate_actions_for_side_effects(&xin);
1089         }
1090
1091         if (miss->flow.in_port.ofp_port
1092             != vsp_realdev_to_vlandev(miss->ofproto,
1093                                       miss->flow.in_port.ofp_port,
1094                                       miss->flow.vlan_tci)) {
1095             /* This packet was received on a VLAN splinter port.  We
1096              * added a VLAN to the packet to make the packet resemble
1097              * the flow, but the actions were composed assuming that
1098              * the packet contained no VLAN.  So, we must remove the
1099              * VLAN header from the packet before trying to execute the
1100              * actions. */
1101             if (miss->xout.odp_actions.size) {
1102                 eth_pop_vlan(packet);
1103             }
1104
1105             /* Remove the flow vlan tags inserted by vlan splinter logic
1106              * to ensure megaflow masks generated match the data path flow. */
1107             miss->flow.vlan_tci = 0;
1108         }
1109
1110         if (may_put) {
1111             struct ofpbuf mask;
1112             bool megaflow;
1113
1114             atomic_read(&enable_megaflows, &megaflow);
1115             ofpbuf_use_stack(&mask, &miss->mask_buf, sizeof miss->mask_buf);
1116             if (megaflow) {
1117                 odp_flow_key_from_mask(&mask, &miss->xout.wc.masks,
1118                                        &miss->flow, UINT32_MAX);
1119             }
1120
1121             op = &ops[n_ops++];
1122             op->type = DPIF_OP_FLOW_PUT;
1123             op->u.flow_put.flags = DPIF_FP_CREATE | DPIF_FP_MODIFY;
1124             op->u.flow_put.key = miss->key;
1125             op->u.flow_put.key_len = miss->key_len;
1126             op->u.flow_put.mask = mask.data;
1127             op->u.flow_put.mask_len = mask.size;
1128             op->u.flow_put.stats = NULL;
1129
1130             if (!miss->xout.slow) {
1131                 op->u.flow_put.actions = miss->xout.odp_actions.data;
1132                 op->u.flow_put.actions_len = miss->xout.odp_actions.size;
1133             } else {
1134                 struct ofpbuf buf;
1135
1136                 ofpbuf_use_stack(&buf, miss->slow_path_buf,
1137                                  sizeof miss->slow_path_buf);
1138                 compose_slow_path(udpif, &miss->xout, miss->odp_in_port, &buf);
1139                 op->u.flow_put.actions = buf.data;
1140                 op->u.flow_put.actions_len = buf.size;
1141             }
1142         }
1143
1144         /*
1145          * The 'miss' may be shared by multiple upcalls. Restore
1146          * the saved flow vlan_tci field before processing the next
1147          * upcall. */
1148         miss->flow.vlan_tci = flow_vlan_tci;
1149
1150         if (miss->xout.odp_actions.size) {
1151
1152             op = &ops[n_ops++];
1153             op->type = DPIF_OP_EXECUTE;
1154             op->u.execute.packet = packet;
1155             odp_key_to_pkt_metadata(miss->key, miss->key_len,
1156                                     &op->u.execute.md);
1157             op->u.execute.actions = miss->xout.odp_actions.data;
1158             op->u.execute.actions_len = miss->xout.odp_actions.size;
1159             op->u.execute.needs_help = (miss->xout.slow & SLOW_ACTION) != 0;
1160         }
1161     }
1162
1163     /* Special case for fail-open mode.
1164      *
1165      * If we are in fail-open mode, but we are connected to a controller too,
1166      * then we should send the packet up to the controller in the hope that it
1167      * will try to set up a flow and thereby allow us to exit fail-open.
1168      *
1169      * See the top-level comment in fail-open.c for more information.
1170      *
1171      * Copy packets before they are modified by execution. */
1172     if (fail_open) {
1173         LIST_FOR_EACH (upcall, list_node, upcalls) {
1174             struct flow_miss *miss = upcall->flow_miss;
1175             struct ofpbuf *packet = &upcall->dpif_upcall.packet;
1176             struct ofproto_packet_in *pin;
1177
1178             pin = xmalloc(sizeof *pin);
1179             pin->up.packet = xmemdup(packet->data, packet->size);
1180             pin->up.packet_len = packet->size;
1181             pin->up.reason = OFPR_NO_MATCH;
1182             pin->up.table_id = 0;
1183             pin->up.cookie = OVS_BE64_MAX;
1184             flow_get_metadata(&miss->flow, &pin->up.fmd);
1185             pin->send_len = 0; /* Not used for flow table misses. */
1186             pin->generated_by_table_miss = false;
1187             ofproto_dpif_send_packet_in(miss->ofproto, pin);
1188         }
1189     }
1190
1191     /* Execute batch. */
1192     for (i = 0; i < n_ops; i++) {
1193         opsp[i] = &ops[i];
1194     }
1195     dpif_operate(udpif->dpif, opsp, n_ops);
1196
1197     HMAP_FOR_EACH_SAFE (miss, next_miss, hmap_node, &misses) {
1198         hmap_remove(&misses, &miss->hmap_node);
1199         xlate_out_uninit(&miss->xout);
1200     }
1201     hmap_destroy(&misses);
1202
1203     LIST_FOR_EACH_SAFE (upcall, next, list_node, upcalls) {
1204         list_remove(&upcall->list_node);
1205         upcall_destroy(upcall);
1206     }
1207 }
1208
1209 static struct udpif_key *
1210 ukey_lookup(struct revalidator *revalidator, struct udpif_flow_dump *udump)
1211 {
1212     struct udpif_key *ukey;
1213
1214     HMAP_FOR_EACH_WITH_HASH (ukey, hmap_node, udump->key_hash,
1215                              &revalidator->ukeys) {
1216         if (ukey->key_len == udump->key_len
1217             && !memcmp(ukey->key, udump->key, udump->key_len)) {
1218             return ukey;
1219         }
1220     }
1221     return NULL;
1222 }
1223
1224 static void
1225 ukey_delete(struct revalidator *revalidator, struct udpif_key *ukey)
1226 {
1227     hmap_remove(&revalidator->ukeys, &ukey->hmap_node);
1228     free(ukey);
1229 }
1230
1231 static bool
1232 revalidate_ukey(struct udpif *udpif, struct udpif_flow_dump *udump,
1233                 struct udpif_key *ukey)
1234 {
1235     struct ofpbuf xout_actions, *actions;
1236     uint64_t slow_path_buf[128 / 8];
1237     struct xlate_out xout, *xoutp;
1238     struct flow flow, udump_mask;
1239     struct ofproto_dpif *ofproto;
1240     struct dpif_flow_stats push;
1241     uint32_t *udump32, *xout32;
1242     odp_port_t odp_in_port;
1243     struct xlate_in xin;
1244     int error;
1245     size_t i;
1246     bool ok;
1247
1248     ok = false;
1249     xoutp = NULL;
1250     actions = NULL;
1251
1252     /* If we don't need to revalidate, we can simply push the stats contained
1253      * in the udump, otherwise we'll have to get the actions so we can check
1254      * them. */
1255     if (udump->need_revalidate) {
1256         if (dpif_flow_get(udpif->dpif, ukey->key, ukey->key_len, &actions,
1257                           &udump->stats)) {
1258             goto exit;
1259         }
1260     }
1261
1262     push.used = udump->stats.used;
1263     push.tcp_flags = udump->stats.tcp_flags;
1264     push.n_packets = udump->stats.n_packets > ukey->stats.n_packets
1265         ? udump->stats.n_packets - ukey->stats.n_packets
1266         : 0;
1267     push.n_bytes = udump->stats.n_bytes > ukey->stats.n_bytes
1268         ? udump->stats.n_bytes - ukey->stats.n_bytes
1269         : 0;
1270     ukey->stats = udump->stats;
1271
1272     if (!push.n_packets && !udump->need_revalidate) {
1273         ok = true;
1274         goto exit;
1275     }
1276
1277     error = xlate_receive(udpif->backer, NULL, ukey->key, ukey->key_len, &flow,
1278                           NULL, &ofproto, NULL, NULL, NULL, &odp_in_port);
1279     if (error) {
1280         goto exit;
1281     }
1282
1283     xlate_in_init(&xin, ofproto, &flow, NULL, push.tcp_flags, NULL);
1284     xin.resubmit_stats = push.n_packets ? &push : NULL;
1285     xin.may_learn = push.n_packets > 0;
1286     xin.skip_wildcards = !udump->need_revalidate;
1287     xlate_actions(&xin, &xout);
1288     xoutp = &xout;
1289
1290     if (!udump->need_revalidate) {
1291         ok = true;
1292         goto exit;
1293     }
1294
1295     if (!xout.slow) {
1296         ofpbuf_use_const(&xout_actions, xout.odp_actions.data,
1297                          xout.odp_actions.size);
1298     } else {
1299         ofpbuf_use_stack(&xout_actions, slow_path_buf, sizeof slow_path_buf);
1300         compose_slow_path(udpif, &xout, odp_in_port, &xout_actions);
1301     }
1302
1303     if (!ofpbuf_equal(&xout_actions, actions)) {
1304         goto exit;
1305     }
1306
1307     if (odp_flow_key_to_mask(udump->mask, udump->mask_len, &udump_mask, &flow)
1308         == ODP_FIT_ERROR) {
1309         goto exit;
1310     }
1311
1312     /* Since the kernel is free to ignore wildcarded bits in the mask, we can't
1313      * directly check that the masks are the same.  Instead we check that the
1314      * mask in the kernel is more specific i.e. less wildcarded, than what
1315      * we've calculated here.  This guarantees we don't catch any packets we
1316      * shouldn't with the megaflow. */
1317     udump32 = (uint32_t *) &udump_mask;
1318     xout32 = (uint32_t *) &xout.wc.masks;
1319     for (i = 0; i < FLOW_U32S; i++) {
1320         if ((udump32[i] | xout32[i]) != udump32[i]) {
1321             goto exit;
1322         }
1323     }
1324     ok = true;
1325
1326 exit:
1327     ofpbuf_delete(actions);
1328     xlate_out_uninit(xoutp);
1329     return ok;
1330 }
1331
1332 static void
1333 revalidate_udumps(struct revalidator *revalidator, struct list *udumps)
1334 {
1335     struct udpif *udpif = revalidator->udpif;
1336
1337     struct {
1338         struct dpif_flow_stats ukey_stats;    /* Stats stored in the ukey. */
1339         struct dpif_flow_stats stats;         /* Stats for 'op'. */
1340         struct dpif_op op;                    /* Flow del operation. */
1341     } ops[REVALIDATE_MAX_BATCH];
1342
1343     struct dpif_op *opsp[REVALIDATE_MAX_BATCH];
1344     struct udpif_flow_dump *udump, *next_udump;
1345     size_t n_ops, i, n_flows;
1346     unsigned int flow_limit;
1347     long long int max_idle;
1348     bool must_del;
1349
1350     atomic_read(&udpif->max_idle, &max_idle);
1351     atomic_read(&udpif->flow_limit, &flow_limit);
1352
1353     n_flows = udpif_get_n_flows(udpif);
1354
1355     must_del = false;
1356     if (n_flows > flow_limit) {
1357         must_del = n_flows > 2 * flow_limit;
1358         max_idle = 100;
1359     }
1360
1361     n_ops = 0;
1362     LIST_FOR_EACH_SAFE (udump, next_udump, list_node, udumps) {
1363         long long int used, now;
1364         struct udpif_key *ukey;
1365
1366         now = time_msec();
1367         ukey = ukey_lookup(revalidator, udump);
1368
1369         used = udump->stats.used;
1370         if (!used && ukey) {
1371             used = ukey->created;
1372         }
1373
1374         if (must_del || (used && used < now - max_idle)) {
1375             struct dpif_flow_stats *ukey_stats = &ops[n_ops].ukey_stats;
1376             struct dpif_op *op = &ops[n_ops].op;
1377
1378             op->type = DPIF_OP_FLOW_DEL;
1379             op->u.flow_del.key = udump->key;
1380             op->u.flow_del.key_len = udump->key_len;
1381             op->u.flow_del.stats = &ops[n_ops].stats;
1382             n_ops++;
1383
1384             if (ukey) {
1385                 *ukey_stats = ukey->stats;
1386                 ukey_delete(revalidator, ukey);
1387             } else {
1388                 memset(ukey_stats, 0, sizeof *ukey_stats);
1389             }
1390
1391             continue;
1392         }
1393
1394         if (!ukey) {
1395             ukey = xmalloc(sizeof *ukey);
1396
1397             ukey->key = (struct nlattr *) &ukey->key_buf;
1398             memcpy(ukey->key, udump->key, udump->key_len);
1399             ukey->key_len = udump->key_len;
1400
1401             ukey->created = used ? used : now;
1402             memset(&ukey->stats, 0, sizeof ukey->stats);
1403
1404             ukey->mark = false;
1405
1406             hmap_insert(&revalidator->ukeys, &ukey->hmap_node,
1407                         udump->key_hash);
1408         }
1409         ukey->mark = true;
1410
1411         if (!revalidate_ukey(udpif, udump, ukey)) {
1412             dpif_flow_del(udpif->dpif, udump->key, udump->key_len, NULL);
1413             ukey_delete(revalidator, ukey);
1414         }
1415
1416         list_remove(&udump->list_node);
1417         free(udump);
1418     }
1419
1420     for (i = 0; i < n_ops; i++) {
1421         opsp[i] = &ops[i].op;
1422     }
1423     dpif_operate(udpif->dpif, opsp, n_ops);
1424
1425     for (i = 0; i < n_ops; i++) {
1426         struct dpif_flow_stats push, *stats, *ukey_stats;
1427
1428         ukey_stats  = &ops[i].ukey_stats;
1429         stats = ops[i].op.u.flow_del.stats;
1430         push.used = MAX(stats->used, ukey_stats->used);
1431         push.tcp_flags = stats->tcp_flags | ukey_stats->tcp_flags;
1432         push.n_packets = stats->n_packets - ukey_stats->n_packets;
1433         push.n_bytes = stats->n_bytes - ukey_stats->n_bytes;
1434
1435         if (push.n_packets || netflow_exists()) {
1436             struct ofproto_dpif *ofproto;
1437             struct netflow *netflow;
1438             struct flow flow;
1439
1440             if (!xlate_receive(udpif->backer, NULL, ops[i].op.u.flow_del.key,
1441                                ops[i].op.u.flow_del.key_len, &flow, NULL,
1442                                &ofproto, NULL, NULL, &netflow, NULL)) {
1443                 struct xlate_in xin;
1444
1445                 xlate_in_init(&xin, ofproto, &flow, NULL, push.tcp_flags,
1446                               NULL);
1447                 xin.resubmit_stats = push.n_packets ? &push : NULL;
1448                 xin.may_learn = push.n_packets > 0;
1449                 xin.skip_wildcards = true;
1450                 xlate_actions_for_side_effects(&xin);
1451
1452                 if (netflow) {
1453                     netflow_expire(netflow, &flow);
1454                     netflow_flow_clear(netflow, &flow);
1455                     netflow_unref(netflow);
1456                 }
1457             }
1458         }
1459     }
1460
1461     LIST_FOR_EACH_SAFE (udump, next_udump, list_node, udumps) {
1462         list_remove(&udump->list_node);
1463         free(udump);
1464     }
1465 }
1466
1467 static void
1468 revalidator_sweep(struct revalidator *revalidator)
1469 {
1470     struct udpif_key *ukey, *next;
1471
1472     HMAP_FOR_EACH_SAFE (ukey, next, hmap_node, &revalidator->ukeys) {
1473         if (ukey->mark) {
1474             ukey->mark = false;
1475         } else {
1476             ukey_delete(revalidator, ukey);
1477         }
1478     }
1479 }
1480 \f
1481 static void
1482 upcall_unixctl_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
1483                     const char *argv[] OVS_UNUSED, void *aux OVS_UNUSED)
1484 {
1485     struct ds ds = DS_EMPTY_INITIALIZER;
1486     struct udpif *udpif;
1487
1488     LIST_FOR_EACH (udpif, list_node, &all_udpifs) {
1489         unsigned int flow_limit;
1490         long long int max_idle;
1491         size_t i;
1492
1493         atomic_read(&udpif->flow_limit, &flow_limit);
1494         atomic_read(&udpif->max_idle, &max_idle);
1495
1496         ds_put_format(&ds, "%s:\n", dpif_name(udpif->dpif));
1497         ds_put_format(&ds, "\tflows         : (current %"PRIu64")"
1498             " (avg %u) (max %u) (limit %u)\n", udpif_get_n_flows(udpif),
1499             udpif->avg_n_flows, udpif->max_n_flows, flow_limit);
1500         ds_put_format(&ds, "\tmax idle      : %lldms\n", max_idle);
1501         ds_put_format(&ds, "\tdump duration : %lldms\n", udpif->dump_duration);
1502
1503         ds_put_char(&ds, '\n');
1504         for (i = 0; i < udpif->n_handlers; i++) {
1505             struct handler *handler = &udpif->handlers[i];
1506
1507             ovs_mutex_lock(&handler->mutex);
1508             ds_put_format(&ds, "\t%s: (upcall queue %"PRIuSIZE")\n",
1509                           handler->name, handler->n_upcalls);
1510             ovs_mutex_unlock(&handler->mutex);
1511         }
1512
1513         ds_put_char(&ds, '\n');
1514         for (i = 0; i < n_revalidators; i++) {
1515             struct revalidator *revalidator = &udpif->revalidators[i];
1516
1517             /* XXX: The result of hmap_count(&revalidator->ukeys) may not be
1518              * accurate because it's not protected by the revalidator mutex. */
1519             ovs_mutex_lock(&revalidator->mutex);
1520             ds_put_format(&ds, "\t%s: (dump queue %"PRIuSIZE") (keys %"PRIuSIZE
1521                           ")\n", revalidator->name, revalidator->n_udumps,
1522                           hmap_count(&revalidator->ukeys));
1523             ovs_mutex_unlock(&revalidator->mutex);
1524         }
1525     }
1526
1527     unixctl_command_reply(conn, ds_cstr(&ds));
1528     ds_destroy(&ds);
1529 }
1530
1531 /* Disable using the megaflows.
1532  *
1533  * This command is only needed for advanced debugging, so it's not
1534  * documented in the man page. */
1535 static void
1536 upcall_unixctl_disable_megaflows(struct unixctl_conn *conn,
1537                                  int argc OVS_UNUSED,
1538                                  const char *argv[] OVS_UNUSED,
1539                                  void *aux OVS_UNUSED)
1540 {
1541     atomic_store(&enable_megaflows, false);
1542     udpif_flush();
1543     unixctl_command_reply(conn, "megaflows disabled");
1544 }
1545
1546 /* Re-enable using megaflows.
1547  *
1548  * This command is only needed for advanced debugging, so it's not
1549  * documented in the man page. */
1550 static void
1551 upcall_unixctl_enable_megaflows(struct unixctl_conn *conn,
1552                                 int argc OVS_UNUSED,
1553                                 const char *argv[] OVS_UNUSED,
1554                                 void *aux OVS_UNUSED)
1555 {
1556     atomic_store(&enable_megaflows, true);
1557     udpif_flush();
1558     unixctl_command_reply(conn, "megaflows enabled");
1559 }