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 "coverage.h"
  23 #include "dynamic-string.h"
  24 #include "dpif.h"
  25 #include "fail-open.h"
  26 #include "guarded-list.h"
  27 #include "latch.h"
  28 #include "seq.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.h"
  35 #include "packets.h"
  36 #include "poll-loop.h"
  37 #include "vlog.h"
  38
  39 #define MAX_QUEUE_LENGTH 512
  40
  41 VLOG_DEFINE_THIS_MODULE(ofproto_dpif_upcall);
  42
  43 COVERAGE_DEFINE(drop_queue_overflow);
  44 COVERAGE_DEFINE(upcall_queue_overflow);
  45 COVERAGE_DEFINE(fmb_queue_overflow);
  46 COVERAGE_DEFINE(fmb_queue_revalidated);
  47
  48 /* A thread that processes each upcall handed to it by the dispatcher thread,
  49  * forwards the upcall's packet, and then queues it to the main ofproto_dpif
  50  * to possibly set up a kernel flow as a cache. */
  51 struct handler {
  52     struct udpif *udpif;               /* Parent udpif. */
  53     pthread_t thread;                  /* Thread ID. */
  54
  55     struct ovs_mutex mutex;            /* Mutex guarding the following. */
  56
  57     /* Atomic queue of unprocessed upcalls. */
  58     struct list upcalls OVS_GUARDED;
  59     size_t n_upcalls OVS_GUARDED;
  60
  61     size_t n_new_upcalls;              /* Only changed by the dispatcher. */
  62
  63     pthread_cond_t wake_cond;          /* Wakes 'thread' while holding
  64                                           'mutex'. */
  65 };
  66
  67 /* An upcall handler for ofproto_dpif.
  68  *
  69  * udpif is implemented as a "dispatcher" thread that reads upcalls from the
  70  * kernel.  It processes each upcall just enough to figure out its next
  71  * destination.  For a "miss" upcall (MISS_UPCALL), this is one of several
  72  * "handler" threads (see struct handler).  Other upcalls are queued to the
  73  * main ofproto_dpif. */
  74 struct udpif {
  75     struct dpif *dpif;                 /* Datapath handle. */
  76     struct dpif_backer *backer;        /* Opaque dpif_backer pointer. */
  77
  78     uint32_t secret;                   /* Random seed for upcall hash. */
  79
  80     pthread_t dispatcher;              /* Dispatcher thread ID. */
  81
  82     struct handler *handlers;          /* Upcall handlers. */
  83     size_t n_handlers;
  84
  85     /* Queues to pass up to ofproto-dpif. */
  86     struct guarded_list drop_keys; /* "struct drop key"s. */
  87     struct guarded_list fmbs;      /* "struct flow_miss_batch"es. */
  88
  89     /* Number of times udpif_revalidate() has been called. */
  90     atomic_uint reval_seq;
  91
  92     struct seq *wait_seq;
  93
  94     struct latch exit_latch; /* Tells child threads to exit. */
  95 };
  96
  97 enum upcall_type {
  98     BAD_UPCALL,                 /* Some kind of bug somewhere. */
  99     MISS_UPCALL,                /* A flow miss.  */
 100     SFLOW_UPCALL,               /* sFlow sample. */
 101     FLOW_SAMPLE_UPCALL,         /* Per-flow sampling. */
 102     IPFIX_UPCALL                /* Per-bridge sampling. */
 103 };
 104
 105 struct upcall {
 106     struct list list_node;          /* For queuing upcalls. */
 107     struct flow_miss *flow_miss;    /* This upcall's flow_miss. */
 108
 109     /* Raw upcall plus data for keeping track of the memory backing it. */
 110     struct dpif_upcall dpif_upcall; /* As returned by dpif_recv() */
 111     struct ofpbuf upcall_buf;       /* Owns some data in 'dpif_upcall'. */
 112     uint64_t upcall_stub[512 / 8];  /* Buffer to reduce need for malloc(). */
 113 };
 114
 115 static void upcall_destroy(struct upcall *);
 116
 117 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
 118
 119 static void recv_upcalls(struct udpif *);
 120 static void handle_upcalls(struct udpif *, struct list *upcalls);
 121 static void miss_destroy(struct flow_miss *);
 122 static void *udpif_dispatcher(void *);
 123 static void *udpif_upcall_handler(void *);
 124
 125 struct udpif *
 126 udpif_create(struct dpif_backer *backer, struct dpif *dpif)
 127 {
 128     struct udpif *udpif = xzalloc(sizeof *udpif);
 129
 130     udpif->dpif = dpif;
 131     udpif->backer = backer;
 132     udpif->secret = random_uint32();
 133     udpif->wait_seq = seq_create();
 134     latch_init(&udpif->exit_latch);
 135     guarded_list_init(&udpif->drop_keys);
 136     guarded_list_init(&udpif->fmbs);
 137     atomic_init(&udpif->reval_seq, 0);
 138
 139     return udpif;
 140 }
 141
 142 void
 143 udpif_destroy(struct udpif *udpif)
 144 {
 145     struct flow_miss_batch *fmb;
 146     struct drop_key *drop_key;
 147
 148     udpif_recv_set(udpif, 0, false);
 149
 150     while ((drop_key = drop_key_next(udpif))) {
 151         drop_key_destroy(drop_key);
 152     }
 153
 154     while ((fmb = flow_miss_batch_next(udpif))) {
 155         flow_miss_batch_destroy(fmb);
 156     }
 157
 158     guarded_list_destroy(&udpif->drop_keys);
 159     guarded_list_destroy(&udpif->fmbs);
 160     latch_destroy(&udpif->exit_latch);
 161     seq_destroy(udpif->wait_seq);
 162     free(udpif);
 163 }
 164
 165 /* Tells 'udpif' to begin or stop handling flow misses depending on the value
 166  * of 'enable'.  'n_handlers' is the number of upcall_handler threads to
 167  * create.  Passing 'n_handlers' as zero is equivalent to passing 'enable' as
 168  * false. */
 169 void
 170 udpif_recv_set(struct udpif *udpif, size_t n_handlers, bool enable)
 171 {
 172     n_handlers = enable ? n_handlers : 0;
 173     n_handlers = MIN(n_handlers, 64);
 174
 175     /* Stop the old threads (if any). */
 176     if (udpif->handlers && udpif->n_handlers != n_handlers) {
 177         size_t i;
 178
 179         latch_set(&udpif->exit_latch);
 180
 181         /* Wake the handlers so they can exit. */
 182         for (i = 0; i < udpif->n_handlers; i++) {
 183             struct handler *handler = &udpif->handlers[i];
 184
 185             ovs_mutex_lock(&handler->mutex);
 186             xpthread_cond_signal(&handler->wake_cond);
 187             ovs_mutex_unlock(&handler->mutex);
 188         }
 189
 190         xpthread_join(udpif->dispatcher, NULL);
 191         for (i = 0; i < udpif->n_handlers; i++) {
 192             struct handler *handler = &udpif->handlers[i];
 193             struct upcall *miss, *next;
 194
 195             xpthread_join(handler->thread, NULL);
 196
 197             ovs_mutex_lock(&handler->mutex);
 198             LIST_FOR_EACH_SAFE (miss, next, list_node, &handler->upcalls) {
 199                 list_remove(&miss->list_node);
 200                 upcall_destroy(miss);
 201             }
 202             ovs_mutex_unlock(&handler->mutex);
 203             ovs_mutex_destroy(&handler->mutex);
 204
 205             xpthread_cond_destroy(&handler->wake_cond);
 206         }
 207         latch_poll(&udpif->exit_latch);
 208
 209         free(udpif->handlers);
 210         udpif->handlers = NULL;
 211         udpif->n_handlers = 0;
 212     }
 213
 214     /* Start new threads (if necessary). */
 215     if (!udpif->handlers && n_handlers) {
 216         size_t i;
 217
 218         udpif->n_handlers = n_handlers;
 219         udpif->handlers = xzalloc(udpif->n_handlers * sizeof *udpif->handlers);
 220         for (i = 0; i < udpif->n_handlers; i++) {
 221             struct handler *handler = &udpif->handlers[i];
 222
 223             handler->udpif = udpif;
 224             list_init(&handler->upcalls);
 225             xpthread_cond_init(&handler->wake_cond, NULL);
 226             ovs_mutex_init(&handler->mutex);
 227             xpthread_create(&handler->thread, NULL, udpif_upcall_handler,
 228                             handler);
 229         }
 230         xpthread_create(&udpif->dispatcher, NULL, udpif_dispatcher, udpif);
 231     }
 232 }
 233
 234 void
 235 udpif_wait(struct udpif *udpif)
 236 {
 237     uint64_t seq = seq_read(udpif->wait_seq);
 238     if (!guarded_list_is_empty(&udpif->drop_keys) ||
 239         !guarded_list_is_empty(&udpif->fmbs)) {
 240         poll_immediate_wake();
 241     } else {
 242         seq_wait(udpif->wait_seq, seq);
 243     }
 244 }
 245
 246 /* Notifies 'udpif' that something changed which may render previous
 247  * xlate_actions() results invalid. */
 248 void
 249 udpif_revalidate(struct udpif *udpif)
 250 {
 251     struct flow_miss_batch *fmb, *next_fmb;
 252     unsigned int junk;
 253     struct list fmbs;
 254
 255     /* Since we remove each miss on revalidation, their statistics won't be
 256      * accounted to the appropriate 'facet's in the upper layer.  In most
 257      * cases, this is alright because we've already pushed the stats to the
 258      * relevant rules.  However, NetFlow requires absolute packet counts on
 259      * 'facet's which could now be incorrect. */
 260     atomic_add(&udpif->reval_seq, 1, &junk);
 261
 262     guarded_list_pop_all(&udpif->fmbs, &fmbs);
 263     LIST_FOR_EACH_SAFE (fmb, next_fmb, list_node, &fmbs) {
 264         list_remove(&fmb->list_node);
 265         flow_miss_batch_destroy(fmb);
 266     }
 267
 268     udpif_drop_key_clear(udpif);
 269 }
 270
 271 /* Destroys and deallocates 'upcall'. */
 272 static void
 273 upcall_destroy(struct upcall *upcall)
 274 {
 275     if (upcall) {
 276         ofpbuf_uninit(&upcall->upcall_buf);
 277         free(upcall);
 278     }
 279 }
 280
 281 /* Retrieves the next batch of processed flow misses for 'udpif' to install.
 282  * The caller is responsible for destroying it with flow_miss_batch_destroy().
 283  */
 284 struct flow_miss_batch *
 285 flow_miss_batch_next(struct udpif *udpif)
 286 {
 287     int i;
 288
 289     for (i = 0; i < 50; i++) {
 290         struct flow_miss_batch *next;
 291         unsigned int reval_seq;
 292         struct list *next_node;
 293
 294         next_node = guarded_list_pop_front(&udpif->fmbs);
 295         if (!next_node) {
 296             break;
 297         }
 298
 299         next = CONTAINER_OF(next_node, struct flow_miss_batch, list_node);
 300         atomic_read(&udpif->reval_seq, &reval_seq);
 301         if (next->reval_seq == reval_seq) {
 302             return next;
 303         }
 304
 305         flow_miss_batch_destroy(next);
 306     }
 307
 308     return NULL;
 309 }
 310
 311 /* Destroys and deallocates 'fmb'. */
 312 void
 313 flow_miss_batch_destroy(struct flow_miss_batch *fmb)
 314 {
 315     struct flow_miss *miss, *next;
 316     struct upcall *upcall, *next_upcall;
 317
 318     if (!fmb) {
 319         return;
 320     }
 321
 322     HMAP_FOR_EACH_SAFE (miss, next, hmap_node, &fmb->misses) {
 323         hmap_remove(&fmb->misses, &miss->hmap_node);
 324         miss_destroy(miss);
 325     }
 326
 327     LIST_FOR_EACH_SAFE (upcall, next_upcall, list_node, &fmb->upcalls) {
 328         list_remove(&upcall->list_node);
 329         upcall_destroy(upcall);
 330     }
 331
 332     hmap_destroy(&fmb->misses);
 333     free(fmb);
 334 }
 335
 336 /* Retrieves the next drop key which ofproto-dpif needs to process.  The caller
 337  * is responsible for destroying it with drop_key_destroy(). */
 338 struct drop_key *
 339 drop_key_next(struct udpif *udpif)
 340 {
 341     struct list *next = guarded_list_pop_front(&udpif->drop_keys);
 342     return next ? CONTAINER_OF(next, struct drop_key, list_node) : NULL;
 343 }
 344
 345 /* Destroys and deallocates 'drop_key'. */
 346 void
 347 drop_key_destroy(struct drop_key *drop_key)
 348 {
 349     if (drop_key) {
 350         free(drop_key->key);
 351         free(drop_key);
 352     }
 353 }
 354
 355 /* Clears all drop keys waiting to be processed by drop_key_next(). */
 356 void
 357 udpif_drop_key_clear(struct udpif *udpif)
 358 {
 359     struct drop_key *drop_key, *next;
 360     struct list list;
 361
 362     guarded_list_pop_all(&udpif->drop_keys, &list);
 363     LIST_FOR_EACH_SAFE (drop_key, next, list_node, &list) {
 364         list_remove(&drop_key->list_node);
 365         drop_key_destroy(drop_key);
 366     }
 367 }
 368 \f
 369 /* The dispatcher thread is responsible for receiving upcalls from the kernel,
 370  * assigning them to a upcall_handler thread. */
 371 static void *
 372 udpif_dispatcher(void *arg)
 373 {
 374     struct udpif *udpif = arg;
 375
 376     set_subprogram_name("dispatcher");
 377     while (!latch_is_set(&udpif->exit_latch)) {
 378         recv_upcalls(udpif);
 379         dpif_recv_wait(udpif->dpif);
 380         latch_wait(&udpif->exit_latch);
 381         poll_block();
 382     }
 383
 384     return NULL;
 385 }
 386
 387 /* The miss handler thread is responsible for processing miss upcalls retrieved
 388  * by the dispatcher thread.  Once finished it passes the processed miss
 389  * upcalls to ofproto-dpif where they're installed in the datapath. */
 390 static void *
 391 udpif_upcall_handler(void *arg)
 392 {
 393     struct handler *handler = arg;
 394
 395     set_subprogram_name("upcall_handler");
 396     for (;;) {
 397         struct list misses = LIST_INITIALIZER(&misses);
 398         size_t i;
 399
 400         ovs_mutex_lock(&handler->mutex);
 401
 402         if (latch_is_set(&handler->udpif->exit_latch)) {
 403             ovs_mutex_unlock(&handler->mutex);
 404             return NULL;
 405         }
 406
 407         if (!handler->n_upcalls) {
 408             ovs_mutex_cond_wait(&handler->wake_cond, &handler->mutex);
 409         }
 410
 411         for (i = 0; i < FLOW_MISS_MAX_BATCH; i++) {
 412             if (handler->n_upcalls) {
 413                 handler->n_upcalls--;
 414                 list_push_back(&misses, list_pop_front(&handler->upcalls));
 415             } else {
 416                 break;
 417             }
 418         }
 419         ovs_mutex_unlock(&handler->mutex);
 420
 421         handle_upcalls(handler->udpif, &misses);
 422     }
 423 }
 424 \f
 425 static void
 426 miss_destroy(struct flow_miss *miss)
 427 {
 428     xlate_out_uninit(&miss->xout);
 429 }
 430
 431 static enum upcall_type
 432 classify_upcall(const struct upcall *upcall)
 433 {
 434     const struct dpif_upcall *dpif_upcall = &upcall->dpif_upcall;
 435     union user_action_cookie cookie;
 436     size_t userdata_len;
 437
 438     /* First look at the upcall type. */
 439     switch (dpif_upcall->type) {
 440     case DPIF_UC_ACTION:
 441         break;
 442
 443     case DPIF_UC_MISS:
 444         return MISS_UPCALL;
 445
 446     case DPIF_N_UC_TYPES:
 447     default:
 448         VLOG_WARN_RL(&rl, "upcall has unexpected type %"PRIu32,
 449                      dpif_upcall->type);
 450         return BAD_UPCALL;
 451     }
 452
 453     /* "action" upcalls need a closer look. */
 454     if (!dpif_upcall->userdata) {
 455         VLOG_WARN_RL(&rl, "action upcall missing cookie");
 456         return BAD_UPCALL;
 457     }
 458     userdata_len = nl_attr_get_size(dpif_upcall->userdata);
 459     if (userdata_len < sizeof cookie.type
 460         || userdata_len > sizeof cookie) {
 461         VLOG_WARN_RL(&rl, "action upcall cookie has unexpected size %zu",
 462                      userdata_len);
 463         return BAD_UPCALL;
 464     }
 465     memset(&cookie, 0, sizeof cookie);
 466     memcpy(&cookie, nl_attr_get(dpif_upcall->userdata), userdata_len);
 467     if (userdata_len == sizeof cookie.sflow
 468         && cookie.type == USER_ACTION_COOKIE_SFLOW) {
 469         return SFLOW_UPCALL;
 470     } else if (userdata_len == sizeof cookie.slow_path
 471                && cookie.type == USER_ACTION_COOKIE_SLOW_PATH) {
 472         return MISS_UPCALL;
 473     } else if (userdata_len == sizeof cookie.flow_sample
 474                && cookie.type == USER_ACTION_COOKIE_FLOW_SAMPLE) {
 475         return FLOW_SAMPLE_UPCALL;
 476     } else if (userdata_len == sizeof cookie.ipfix
 477                && cookie.type == USER_ACTION_COOKIE_IPFIX) {
 478         return IPFIX_UPCALL;
 479     } else {
 480         VLOG_WARN_RL(&rl, "invalid user cookie of type %"PRIu16
 481                      " and size %zu", cookie.type, userdata_len);
 482         return BAD_UPCALL;
 483     }
 484 }
 485
 486 static void
 487 recv_upcalls(struct udpif *udpif)
 488 {
 489     size_t n_udpif_new_upcalls = 0;
 490     int n;
 491
 492     for (;;) {
 493         uint32_t hash = udpif->secret;
 494         struct handler *handler;
 495         struct upcall *upcall;
 496         size_t n_bytes, left;
 497         struct nlattr *nla;
 498         int error;
 499
 500         upcall = xmalloc(sizeof *upcall);
 501         ofpbuf_use_stub(&upcall->upcall_buf, upcall->upcall_stub,
 502                         sizeof upcall->upcall_stub);
 503         error = dpif_recv(udpif->dpif, &upcall->dpif_upcall,
 504                           &upcall->upcall_buf);
 505         if (error) {
 506             upcall_destroy(upcall);
 507             break;
 508         }
 509
 510         n_bytes = 0;
 511         NL_ATTR_FOR_EACH (nla, left, upcall->dpif_upcall.key,
 512                           upcall->dpif_upcall.key_len) {
 513             enum ovs_key_attr type = nl_attr_type(nla);
 514             if (type == OVS_KEY_ATTR_IN_PORT
 515                 || type == OVS_KEY_ATTR_TCP
 516                 || type == OVS_KEY_ATTR_UDP) {
 517                 if (nl_attr_get_size(nla) == 4) {
 518                     hash = mhash_add(hash, nl_attr_get_be32(nla));
 519                     n_bytes += 4;
 520                 } else {
 521                     VLOG_WARN_RL(&rl,
 522                                  "Netlink attribute with incorrect size.");
 523                 }
 524             }
 525         }
 526         hash =  mhash_finish(hash, n_bytes);
 527
 528         handler = &udpif->handlers[hash % udpif->n_handlers];
 529
 530         ovs_mutex_lock(&handler->mutex);
 531         if (handler->n_upcalls < MAX_QUEUE_LENGTH) {
 532             list_push_back(&handler->upcalls, &upcall->list_node);
 533             handler->n_new_upcalls = ++handler->n_upcalls;
 534
 535             if (handler->n_new_upcalls >= FLOW_MISS_MAX_BATCH) {
 536                 xpthread_cond_signal(&handler->wake_cond);
 537             }
 538             ovs_mutex_unlock(&handler->mutex);
 539             if (!VLOG_DROP_DBG(&rl)) {
 540                 struct ds ds = DS_EMPTY_INITIALIZER;
 541
 542                 odp_flow_key_format(upcall->dpif_upcall.key,
 543                                     upcall->dpif_upcall.key_len,
 544                                     &ds);
 545                 VLOG_DBG("dispatcher: enqueue (%s)", ds_cstr(&ds));
 546                 ds_destroy(&ds);
 547             }
 548         } else {
 549             ovs_mutex_unlock(&handler->mutex);
 550             COVERAGE_INC(upcall_queue_overflow);
 551             upcall_destroy(upcall);
 552         }
 553     }
 554
 555     for (n = 0; n < udpif->n_handlers; ++n) {
 556         struct handler *handler = &udpif->handlers[n];
 557
 558         if (handler->n_new_upcalls) {
 559             handler->n_new_upcalls = 0;
 560             ovs_mutex_lock(&handler->mutex);
 561             xpthread_cond_signal(&handler->wake_cond);
 562             ovs_mutex_unlock(&handler->mutex);
 563         }
 564     }
 565     if (n_udpif_new_upcalls) {
 566         seq_change(udpif->wait_seq);
 567     }
 568 }
 569
 570 static struct flow_miss *
 571 flow_miss_find(struct hmap *todo, const struct ofproto_dpif *ofproto,
 572                const struct flow *flow, uint32_t hash)
 573 {
 574     struct flow_miss *miss;
 575
 576     HMAP_FOR_EACH_WITH_HASH (miss, hmap_node, hash, todo) {
 577         if (miss->ofproto == ofproto && flow_equal(&miss->flow, flow)) {
 578             return miss;
 579         }
 580     }
 581
 582     return NULL;
 583 }
 584
 585 static void
 586 handle_upcalls(struct udpif *udpif, struct list *upcalls)
 587 {
 588     struct dpif_op *opsp[FLOW_MISS_MAX_BATCH];
 589     struct dpif_op ops[FLOW_MISS_MAX_BATCH];
 590     struct upcall *upcall, *next;
 591     struct flow_miss_batch *fmb;
 592     size_t n_misses, n_ops, i;
 593     struct flow_miss *miss;
 594     unsigned int reval_seq;
 595     enum upcall_type type;
 596     bool fail_open;
 597
 598     /* Extract the flow from each upcall.  Construct in fmb->misses a hash
 599      * table that maps each unique flow to a 'struct flow_miss'.
 600      *
 601      * Most commonly there is a single packet per flow_miss, but there are
 602      * several reasons why there might be more than one, e.g.:
 603      *
 604      *   - The dpif packet interface does not support TSO (or UFO, etc.), so a
 605      *     large packet sent to userspace is split into a sequence of smaller
 606      *     ones.
 607      *
 608      *   - A stream of quickly arriving packets in an established "slow-pathed"
 609      *     flow.
 610      *
 611      *   - Rarely, a stream of quickly arriving packets in a flow not yet
 612      *     established.  (This is rare because most protocols do not send
 613      *     multiple back-to-back packets before receiving a reply from the
 614      *     other end of the connection, which gives OVS a chance to set up a
 615      *     datapath flow.)
 616      */
 617     fmb = xmalloc(sizeof *fmb);
 618     atomic_read(&udpif->reval_seq, &fmb->reval_seq);
 619     hmap_init(&fmb->misses);
 620     list_init(&fmb->upcalls);
 621     n_misses = 0;
 622     LIST_FOR_EACH_SAFE (upcall, next, list_node, upcalls) {
 623         struct dpif_upcall *dupcall = &upcall->dpif_upcall;
 624         struct ofpbuf *packet = dupcall->packet;
 625         struct flow_miss *miss = &fmb->miss_buf[n_misses];
 626         struct flow_miss *existing_miss;
 627         struct ofproto_dpif *ofproto;
 628         struct dpif_sflow *sflow;
 629         struct dpif_ipfix *ipfix;
 630         odp_port_t odp_in_port;
 631         struct flow flow;
 632         int error;
 633
 634         error = xlate_receive(udpif->backer, packet, dupcall->key,
 635                               dupcall->key_len, &flow, &miss->key_fitness,
 636                               &ofproto, &odp_in_port);
 637         if (error) {
 638             if (error == ENODEV) {
 639                 struct drop_key *drop_key;
 640
 641                 /* Received packet on datapath port for which we couldn't
 642                  * associate an ofproto.  This can happen if a port is removed
 643                  * while traffic is being received.  Print a rate-limited
 644                  * message in case it happens frequently.  Install a drop flow
 645                  * so that future packets of the flow are inexpensively dropped
 646                  * in the kernel. */
 647                 VLOG_INFO_RL(&rl, "received packet on unassociated datapath "
 648                              "port %"PRIu32, odp_in_port);
 649
 650                 drop_key = xmalloc(sizeof *drop_key);
 651                 drop_key->key = xmemdup(dupcall->key, dupcall->key_len);
 652                 drop_key->key_len = dupcall->key_len;
 653
 654                 if (guarded_list_push_back(&udpif->drop_keys,
 655                                            &drop_key->list_node,
 656                                            MAX_QUEUE_LENGTH)) {
 657                     seq_change(udpif->wait_seq);
 658                 } else {
 659                     COVERAGE_INC(drop_queue_overflow);
 660                     drop_key_destroy(drop_key);
 661                 }
 662             }
 663             list_remove(&upcall->list_node);
 664             upcall_destroy(upcall);
 665             continue;
 666         }
 667
 668         type = classify_upcall(upcall);
 669         if (type == MISS_UPCALL) {
 670             uint32_t hash;
 671
 672             flow_extract(packet, flow.skb_priority, flow.pkt_mark,
 673                          &flow.tunnel, &flow.in_port, &miss->flow);
 674
 675             hash = flow_hash(&miss->flow, 0);
 676             existing_miss = flow_miss_find(&fmb->misses, ofproto, &miss->flow,
 677                                            hash);
 678             if (!existing_miss) {
 679                 hmap_insert(&fmb->misses, &miss->hmap_node, hash);
 680                 miss->ofproto = ofproto;
 681                 miss->key = dupcall->key;
 682                 miss->key_len = dupcall->key_len;
 683                 miss->upcall_type = dupcall->type;
 684                 miss->stats.n_packets = 0;
 685                 miss->stats.n_bytes = 0;
 686                 miss->stats.used = time_msec();
 687                 miss->stats.tcp_flags = 0;
 688
 689                 n_misses++;
 690             } else {
 691                 miss = existing_miss;
 692             }
 693             miss->stats.tcp_flags |= packet_get_tcp_flags(packet, &miss->flow);
 694             miss->stats.n_bytes += packet->size;
 695             miss->stats.n_packets++;
 696
 697             upcall->flow_miss = miss;
 698             continue;
 699         }
 700
 701         switch (type) {
 702         case SFLOW_UPCALL:
 703             sflow = xlate_get_sflow(ofproto);
 704             if (sflow) {
 705                 union user_action_cookie cookie;
 706
 707                 memset(&cookie, 0, sizeof cookie);
 708                 memcpy(&cookie, nl_attr_get(dupcall->userdata),
 709                        sizeof cookie.sflow);
 710                 dpif_sflow_received(sflow, dupcall->packet, &flow, odp_in_port,
 711                                     &cookie);
 712                 dpif_sflow_unref(sflow);
 713             }
 714             break;
 715         case IPFIX_UPCALL:
 716             ipfix = xlate_get_ipfix(ofproto);
 717             if (ipfix) {
 718                 dpif_ipfix_bridge_sample(ipfix, dupcall->packet, &flow);
 719                 dpif_ipfix_unref(ipfix);
 720             }
 721             break;
 722         case FLOW_SAMPLE_UPCALL:
 723             ipfix = xlate_get_ipfix(ofproto);
 724             if (ipfix) {
 725                 union user_action_cookie cookie;
 726
 727                 memset(&cookie, 0, sizeof cookie);
 728                 memcpy(&cookie, nl_attr_get(dupcall->userdata),
 729                        sizeof cookie.flow_sample);
 730
 731                 /* The flow reflects exactly the contents of the packet.
 732                  * Sample the packet using it. */
 733                 dpif_ipfix_flow_sample(ipfix, dupcall->packet, &flow,
 734                                        cookie.flow_sample.collector_set_id,
 735                                        cookie.flow_sample.probability,
 736                                        cookie.flow_sample.obs_domain_id,
 737                                        cookie.flow_sample.obs_point_id);
 738                 dpif_ipfix_unref(ipfix);
 739             }
 740             break;
 741         case BAD_UPCALL:
 742             break;
 743         case MISS_UPCALL:
 744             NOT_REACHED();
 745         }
 746
 747         list_remove(&upcall->list_node);
 748         upcall_destroy(upcall);
 749     }
 750
 751     /* Initialize each 'struct flow_miss's ->xout.
 752      *
 753      * We do this per-flow_miss rather than per-packet because, most commonly,
 754      * all the packets in a flow can use the same translation.
 755      *
 756      * We can't do this in the previous loop because we need the TCP flags for
 757      * all the packets in each miss. */
 758     fail_open = false;
 759     HMAP_FOR_EACH (miss, hmap_node, &fmb->misses) {
 760         struct flow_wildcards wc;
 761         struct rule_dpif *rule;
 762         struct xlate_in xin;
 763
 764         flow_wildcards_init_catchall(&wc);
 765         rule_dpif_lookup(miss->ofproto, &miss->flow, &wc, &rule);
 766         if (rule_dpif_fail_open(rule)) {
 767             fail_open = true;
 768         }
 769         rule_dpif_credit_stats(rule, &miss->stats);
 770         xlate_in_init(&xin, miss->ofproto, &miss->flow, rule,
 771                       miss->stats.tcp_flags, NULL);
 772         xin.may_learn = true;
 773         xin.resubmit_stats = &miss->stats;
 774         xlate_actions(&xin, &miss->xout);
 775         flow_wildcards_or(&miss->xout.wc, &miss->xout.wc, &wc);
 776         rule_dpif_unref(rule);
 777     }
 778
 779     /* Now handle the packets individually in order of arrival.  In the common
 780      * case each packet of a miss can share the same actions, but slow-pathed
 781      * packets need to be translated individually:
 782      *
 783      *   - For SLOW_CFM, SLOW_LACP, SLOW_STP, and SLOW_BFD, translation is what
 784      *     processes received packets for these protocols.
 785      *
 786      *   - For SLOW_CONTROLLER, translation sends the packet to the OpenFlow
 787      *     controller.
 788      *
 789      * The loop fills 'ops' with an array of operations to execute in the
 790      * datapath. */
 791     n_ops = 0;
 792     LIST_FOR_EACH (upcall, list_node, upcalls) {
 793         struct flow_miss *miss = upcall->flow_miss;
 794         struct ofpbuf *packet = upcall->dpif_upcall.packet;
 795
 796         if (miss->xout.slow) {
 797             struct rule_dpif *rule;
 798             struct xlate_in xin;
 799
 800             rule_dpif_lookup(miss->ofproto, &miss->flow, NULL, &rule);
 801             xlate_in_init(&xin, miss->ofproto, &miss->flow, rule, 0, packet);
 802             xlate_actions_for_side_effects(&xin);
 803             rule_dpif_unref(rule);
 804         }
 805
 806         if (miss->xout.odp_actions.size) {
 807             struct dpif_op *op;
 808
 809             if (miss->flow.in_port.ofp_port
 810                 != vsp_realdev_to_vlandev(miss->ofproto,
 811                                           miss->flow.in_port.ofp_port,
 812                                           miss->flow.vlan_tci)) {
 813                 /* This packet was received on a VLAN splinter port.  We
 814                  * added a VLAN to the packet to make the packet resemble
 815                  * the flow, but the actions were composed assuming that
 816                  * the packet contained no VLAN.  So, we must remove the
 817                  * VLAN header from the packet before trying to execute the
 818                  * actions. */
 819                 eth_pop_vlan(packet);
 820             }
 821
 822             op = &ops[n_ops++];
 823             op->type = DPIF_OP_EXECUTE;
 824             op->u.execute.key = miss->key;
 825             op->u.execute.key_len = miss->key_len;
 826             op->u.execute.packet = packet;
 827             op->u.execute.actions = miss->xout.odp_actions.data;
 828             op->u.execute.actions_len = miss->xout.odp_actions.size;
 829         }
 830     }
 831
 832     /* Execute batch. */
 833     for (i = 0; i < n_ops; i++) {
 834         opsp[i] = &ops[i];
 835     }
 836     dpif_operate(udpif->dpif, opsp, n_ops);
 837
 838     /* Special case for fail-open mode.
 839      *
 840      * If we are in fail-open mode, but we are connected to a controller too,
 841      * then we should send the packet up to the controller in the hope that it
 842      * will try to set up a flow and thereby allow us to exit fail-open.
 843      *
 844      * See the top-level comment in fail-open.c for more information. */
 845     if (fail_open) {
 846         LIST_FOR_EACH (upcall, list_node, upcalls) {
 847             struct flow_miss *miss = upcall->flow_miss;
 848             struct ofpbuf *packet = upcall->dpif_upcall.packet;
 849             struct ofputil_packet_in *pin;
 850
 851             pin = xmalloc(sizeof *pin);
 852             pin->packet = xmemdup(packet->data, packet->size);
 853             pin->packet_len = packet->size;
 854             pin->reason = OFPR_NO_MATCH;
 855             pin->controller_id = 0;
 856             pin->table_id = 0;
 857             pin->cookie = 0;
 858             pin->send_len = 0; /* Not used for flow table misses. */
 859             flow_get_metadata(&miss->flow, &pin->fmd);
 860             ofproto_dpif_send_packet_in(miss->ofproto, pin);
 861         }
 862     }
 863
 864     list_move(&fmb->upcalls, upcalls);
 865
 866     atomic_read(&udpif->reval_seq, &reval_seq);
 867     if (reval_seq != fmb->reval_seq) {
 868         COVERAGE_INC(fmb_queue_revalidated);
 869         flow_miss_batch_destroy(fmb);
 870     } else if (!guarded_list_push_back(&udpif->fmbs, &fmb->list_node,
 871                                        MAX_QUEUE_LENGTH)) {
 872         COVERAGE_INC(fmb_queue_overflow);
 873         flow_miss_batch_destroy(fmb);
 874     } else {
 875         seq_change(udpif->wait_seq);
 876     }
 877 }