lib/dpif-netdev.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "dpif-netdev.h"
  19
  20 #include <ctype.h>
  21 #include <errno.h>
  22 #include <fcntl.h>
  23 #include <inttypes.h>
  24 #include <netinet/in.h>
  25 #include <sys/socket.h>
  26 #include <net/if.h>
  27 #include <stdint.h>
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #include <sys/ioctl.h>
  31 #include <sys/stat.h>
  32 #include <unistd.h>
  33
  34 #include "cmap.h"
  35 #include "csum.h"
  36 #include "dpif.h"
  37 #include "dpif-provider.h"
  38 #include "dummy.h"
  39 #include "dynamic-string.h"
  40 #include "fat-rwlock.h"
  41 #include "flow.h"
  42 #include "cmap.h"
  43 #include "latch.h"
  44 #include "list.h"
  45 #include "match.h"
  46 #include "meta-flow.h"
  47 #include "netdev.h"
  48 #include "netdev-dpdk.h"
  49 #include "netdev-vport.h"
  50 #include "netlink.h"
  51 #include "odp-execute.h"
  52 #include "odp-util.h"
  53 #include "ofp-print.h"
  54 #include "ofpbuf.h"
  55 #include "ovs-numa.h"
  56 #include "ovs-rcu.h"
  57 #include "packet-dpif.h"
  58 #include "packets.h"
  59 #include "poll-loop.h"
  60 #include "pvector.h"
  61 #include "random.h"
  62 #include "seq.h"
  63 #include "shash.h"
  64 #include "sset.h"
  65 #include "timeval.h"
  66 #include "tnl-arp-cache.h"
  67 #include "unixctl.h"
  68 #include "util.h"
  69 #include "openvswitch/vlog.h"
  70
  71 VLOG_DEFINE_THIS_MODULE(dpif_netdev);
  72
  73 #define FLOW_DUMP_MAX_BATCH 50
  74 /* Use per thread recirc_depth to prevent recirculation loop. */
  75 #define MAX_RECIRC_DEPTH 5
  76 DEFINE_STATIC_PER_THREAD_DATA(uint32_t, recirc_depth, 0)
  77
  78 /* Configuration parameters. */
  79 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
  80
  81 /* Protects against changes to 'dp_netdevs'. */
  82 static struct ovs_mutex dp_netdev_mutex = OVS_MUTEX_INITIALIZER;
  83
  84 /* Contains all 'struct dp_netdev's. */
  85 static struct shash dp_netdevs OVS_GUARDED_BY(dp_netdev_mutex)
  86     = SHASH_INITIALIZER(&dp_netdevs);
  87
  88 static struct vlog_rate_limit upcall_rl = VLOG_RATE_LIMIT_INIT(600, 600);
  89
  90 /* Stores a miniflow with inline values */
  91
  92 struct netdev_flow_key {
  93     uint32_t hash;       /* Hash function differs for different users. */
  94     uint32_t len;        /* Length of the following miniflow (incl. map). */
  95     struct miniflow mf;
  96     uint32_t buf[FLOW_MAX_PACKET_U32S - MINI_N_INLINE];
  97 };
  98
  99 /* Exact match cache for frequently used flows
 100  *
 101  * The cache uses a 32-bit hash of the packet (which can be the RSS hash) to
 102  * search its entries for a miniflow that matches exactly the miniflow of the
 103  * packet. It stores the 'dpcls_rule' (rule) that matches the miniflow.
 104  *
 105  * A cache entry holds a reference to its 'dp_netdev_flow'.
 106  *
 107  * A miniflow with a given hash can be in one of EM_FLOW_HASH_SEGS different
 108  * entries. The 32-bit hash is split into EM_FLOW_HASH_SEGS values (each of
 109  * them is EM_FLOW_HASH_SHIFT bits wide and the remainder is thrown away). Each
 110  * value is the index of a cache entry where the miniflow could be.
 111  *
 112  *
 113  * Thread-safety
 114  * =============
 115  *
 116  * Each pmd_thread has its own private exact match cache.
 117  * If dp_netdev_input is not called from a pmd thread, a mutex is used.
 118  */
 119
 120 #define EM_FLOW_HASH_SHIFT 10
 121 #define EM_FLOW_HASH_ENTRIES (1u << EM_FLOW_HASH_SHIFT)
 122 #define EM_FLOW_HASH_MASK (EM_FLOW_HASH_ENTRIES - 1)
 123 #define EM_FLOW_HASH_SEGS 2
 124
 125 struct emc_entry {
 126     struct dp_netdev_flow *flow;
 127     struct netdev_flow_key key;   /* key.hash used for emc hash value. */
 128 };
 129
 130 struct emc_cache {
 131     struct emc_entry entries[EM_FLOW_HASH_ENTRIES];
 132     int sweep_idx;                /* For emc_cache_slow_sweep(). */
 133 };
 134
 135 /* Iterate in the exact match cache through every entry that might contain a
 136  * miniflow with hash 'HASH'. */
 137 #define EMC_FOR_EACH_POS_WITH_HASH(EMC, CURRENT_ENTRY, HASH)                 \
 138     for (uint32_t i__ = 0, srch_hash__ = (HASH);                             \
 139          (CURRENT_ENTRY) = &(EMC)->entries[srch_hash__ & EM_FLOW_HASH_MASK], \
 140          i__ < EM_FLOW_HASH_SEGS;                                            \
 141          i__++, srch_hash__ >>= EM_FLOW_HASH_SHIFT)
 142 \f
 143 /* Simple non-wildcarding single-priority classifier. */
 144
 145 struct dpcls {
 146     struct cmap subtables_map;
 147     struct pvector subtables;
 148 };
 149
 150 /* A rule to be inserted to the classifier. */
 151 struct dpcls_rule {
 152     struct cmap_node cmap_node;   /* Within struct dpcls_subtable 'rules'. */
 153     struct netdev_flow_key *mask; /* Subtable's mask. */
 154     struct netdev_flow_key flow;  /* Matching key. */
 155     /* 'flow' must be the last field, additional space is allocated here. */
 156 };
 157
 158 static void dpcls_init(struct dpcls *);
 159 static void dpcls_destroy(struct dpcls *);
 160 static void dpcls_insert(struct dpcls *, struct dpcls_rule *,
 161                          const struct netdev_flow_key *mask);
 162 static void dpcls_remove(struct dpcls *, struct dpcls_rule *);
 163 static bool dpcls_lookup(const struct dpcls *cls,
 164                          const struct netdev_flow_key keys[],
 165                          struct dpcls_rule **rules, size_t cnt);
 166 \f
 167 /* Datapath based on the network device interface from netdev.h.
 168  *
 169  *
 170  * Thread-safety
 171  * =============
 172  *
 173  * Some members, marked 'const', are immutable.  Accessing other members
 174  * requires synchronization, as noted in more detail below.
 175  *
 176  * Acquisition order is, from outermost to innermost:
 177  *
 178  *    dp_netdev_mutex (global)
 179  *    port_mutex
 180  */
 181 struct dp_netdev {
 182     const struct dpif_class *const class;
 183     const char *const name;
 184     struct dpif *dpif;
 185     struct ovs_refcount ref_cnt;
 186     atomic_flag destroyed;
 187
 188     /* Ports.
 189      *
 190      * Protected by RCU.  Take the mutex to add or remove ports. */
 191     struct ovs_mutex port_mutex;
 192     struct cmap ports;
 193     struct seq *port_seq;       /* Incremented whenever a port changes. */
 194
 195     /* Protects access to ofproto-dpif-upcall interface during revalidator
 196      * thread synchronization. */
 197     struct fat_rwlock upcall_rwlock;
 198     upcall_callback *upcall_cb;  /* Callback function for executing upcalls. */
 199     void *upcall_aux;
 200
 201     /* Stores all 'struct dp_netdev_pmd_thread's. */
 202     struct cmap poll_threads;
 203
 204     /* Protects the access of the 'struct dp_netdev_pmd_thread'
 205      * instance for non-pmd thread. */
 206     struct ovs_mutex non_pmd_mutex;
 207
 208     /* Each pmd thread will store its pointer to
 209      * 'struct dp_netdev_pmd_thread' in 'per_pmd_key'. */
 210     ovsthread_key_t per_pmd_key;
 211
 212     /* Number of rx queues for each dpdk interface and the cpu mask
 213      * for pin of pmd threads. */
 214     size_t n_dpdk_rxqs;
 215     char *pmd_cmask;
 216     uint64_t last_tnl_conf_seq;
 217 };
 218
 219 static struct dp_netdev_port *dp_netdev_lookup_port(const struct dp_netdev *dp,
 220                                                     odp_port_t);
 221
 222 enum dp_stat_type {
 223     DP_STAT_HIT,                /* Packets that matched in the flow table. */
 224     DP_STAT_MISS,               /* Packets that did not match. */
 225     DP_STAT_LOST,               /* Packets not passed up to the client. */
 226     DP_N_STATS
 227 };
 228
 229 /* A port in a netdev-based datapath. */
 230 struct dp_netdev_port {
 231     struct cmap_node node;      /* Node in dp_netdev's 'ports'. */
 232     odp_port_t port_no;
 233     struct netdev *netdev;
 234     struct netdev_saved_flags *sf;
 235     struct netdev_rxq **rxq;
 236     struct ovs_refcount ref_cnt;
 237     char *type;                 /* Port type as requested by user. */
 238 };
 239
 240 /* Contained by struct dp_netdev_flow's 'stats' member.  */
 241 struct dp_netdev_flow_stats {
 242     long long int used;             /* Last used time, in monotonic msecs. */
 243     long long int packet_count;     /* Number of packets matched. */
 244     long long int byte_count;       /* Number of bytes matched. */
 245     uint16_t tcp_flags;             /* Bitwise-OR of seen tcp_flags values. */
 246 };
 247
 248 /* A flow in 'dp_netdev_pmd_thread's 'flow_table'.
 249  *
 250  *
 251  * Thread-safety
 252  * =============
 253  *
 254  * Except near the beginning or ending of its lifespan, rule 'rule' belongs to
 255  * its pmd thread's classifier.  The text below calls this classifier 'cls'.
 256  *
 257  * Motivation
 258  * ----------
 259  *
 260  * The thread safety rules described here for "struct dp_netdev_flow" are
 261  * motivated by two goals:
 262  *
 263  *    - Prevent threads that read members of "struct dp_netdev_flow" from
 264  *      reading bad data due to changes by some thread concurrently modifying
 265  *      those members.
 266  *
 267  *    - Prevent two threads making changes to members of a given "struct
 268  *      dp_netdev_flow" from interfering with each other.
 269  *
 270  *
 271  * Rules
 272  * -----
 273  *
 274  * A flow 'flow' may be accessed without a risk of being freed during an RCU
 275  * grace period.  Code that needs to hold onto a flow for a while
 276  * should try incrementing 'flow->ref_cnt' with dp_netdev_flow_ref().
 277  *
 278  * 'flow->ref_cnt' protects 'flow' from being freed.  It doesn't protect the
 279  * flow from being deleted from 'cls' and it doesn't protect members of 'flow'
 280  * from modification.
 281  *
 282  * Some members, marked 'const', are immutable.  Accessing other members
 283  * requires synchronization, as noted in more detail below.
 284  */
 285 struct dp_netdev_flow {
 286     bool dead;
 287
 288     /* Hash table index by unmasked flow. */
 289     const struct cmap_node node; /* In owning dp_netdev_pmd_thread's */
 290                                  /* 'flow_table'. */
 291     const ovs_u128 ufid;         /* Unique flow identifier. */
 292     const struct flow flow;      /* Unmasked flow that created this entry. */
 293     const int pmd_id;            /* The 'core_id' of pmd thread owning this */
 294                                  /* flow. */
 295
 296     /* Number of references.
 297      * The classifier owns one reference.
 298      * Any thread trying to keep a rule from being freed should hold its own
 299      * reference. */
 300     struct ovs_refcount ref_cnt;
 301
 302     /* Statistics. */
 303     struct dp_netdev_flow_stats stats;
 304
 305     /* Actions. */
 306     OVSRCU_TYPE(struct dp_netdev_actions *) actions;
 307
 308     /* Packet classification. */
 309     struct dpcls_rule cr;        /* In owning dp_netdev's 'cls'. */
 310     /* 'cr' must be the last member. */
 311 };
 312
 313 static void dp_netdev_flow_unref(struct dp_netdev_flow *);
 314 static bool dp_netdev_flow_ref(struct dp_netdev_flow *);
 315 static int dpif_netdev_flow_from_nlattrs(const struct nlattr *, uint32_t,
 316                                          struct flow *);
 317
 318 /* A set of datapath actions within a "struct dp_netdev_flow".
 319  *
 320  *
 321  * Thread-safety
 322  * =============
 323  *
 324  * A struct dp_netdev_actions 'actions' is protected with RCU. */
 325 struct dp_netdev_actions {
 326     /* These members are immutable: they do not change during the struct's
 327      * lifetime.  */
 328     struct nlattr *actions;     /* Sequence of OVS_ACTION_ATTR_* attributes. */
 329     unsigned int size;          /* Size of 'actions', in bytes. */
 330 };
 331
 332 struct dp_netdev_actions *dp_netdev_actions_create(const struct nlattr *,
 333                                                    size_t);
 334 struct dp_netdev_actions *dp_netdev_flow_get_actions(
 335     const struct dp_netdev_flow *);
 336 static void dp_netdev_actions_free(struct dp_netdev_actions *);
 337
 338 /* Contained by struct dp_netdev_pmd_thread's 'stats' member.  */
 339 struct dp_netdev_pmd_stats {
 340     /* Indexed by DP_STAT_*. */
 341     unsigned long long int n[DP_N_STATS];
 342 };
 343
 344 /* PMD: Poll modes drivers.  PMD accesses devices via polling to eliminate
 345  * the performance overhead of interrupt processing.  Therefore netdev can
 346  * not implement rx-wait for these devices.  dpif-netdev needs to poll
 347  * these device to check for recv buffer.  pmd-thread does polling for
 348  * devices assigned to itself.
 349  *
 350  * DPDK used PMD for accessing NIC.
 351  *
 352  * Note, instance with cpu core id NON_PMD_CORE_ID will be reserved for
 353  * I/O of all non-pmd threads.  There will be no actual thread created
 354  * for the instance.
 355  *
 356  * Each struct has its own flow table and classifier.  Packets received
 357  * from managed ports are looked up in the corresponding pmd thread's
 358  * flow table, and are executed with the found actions.
 359  * */
 360 struct dp_netdev_pmd_thread {
 361     struct dp_netdev *dp;
 362     struct ovs_refcount ref_cnt;    /* Every reference must be refcount'ed. */
 363     struct cmap_node node;          /* In 'dp->poll_threads'. */
 364
 365     pthread_cond_t cond;            /* For synchronizing pmd thread reload. */
 366     struct ovs_mutex cond_mutex;    /* Mutex for condition variable. */
 367
 368     /* Per thread exact-match cache.  Note, the instance for cpu core
 369      * NON_PMD_CORE_ID can be accessed by multiple threads, and thusly
 370      * need to be protected (e.g. by 'dp_netdev_mutex').  All other
 371      * instances will only be accessed by its own pmd thread. */
 372     struct emc_cache flow_cache;
 373
 374     /* Classifier and Flow-Table.
 375      *
 376      * Writers of 'flow_table' must take the 'flow_mutex'.  Corresponding
 377      * changes to 'cls' must be made while still holding the 'flow_mutex'.
 378      */
 379     struct ovs_mutex flow_mutex;
 380     struct dpcls cls;
 381     struct cmap flow_table OVS_GUARDED; /* Flow table. */
 382
 383     /* Statistics. */
 384     struct dp_netdev_pmd_stats stats;
 385
 386     struct latch exit_latch;        /* For terminating the pmd thread. */
 387     atomic_uint change_seq;         /* For reloading pmd ports. */
 388     pthread_t thread;
 389     int index;                      /* Idx of this pmd thread among pmd*/
 390                                     /* threads on same numa node. */
 391     int core_id;                    /* CPU core id of this pmd thread. */
 392     int numa_id;                    /* numa node id of this pmd thread. */
 393 };
 394
 395 #define PMD_INITIAL_SEQ 1
 396
 397 /* Interface to netdev-based datapath. */
 398 struct dpif_netdev {
 399     struct dpif dpif;
 400     struct dp_netdev *dp;
 401     uint64_t last_port_seq;
 402 };
 403
 404 static int get_port_by_number(struct dp_netdev *dp, odp_port_t port_no,
 405                               struct dp_netdev_port **portp);
 406 static int get_port_by_name(struct dp_netdev *dp, const char *devname,
 407                             struct dp_netdev_port **portp);
 408 static void dp_netdev_free(struct dp_netdev *)
 409     OVS_REQUIRES(dp_netdev_mutex);
 410 static int do_add_port(struct dp_netdev *dp, const char *devname,
 411                        const char *type, odp_port_t port_no)
 412     OVS_REQUIRES(dp->port_mutex);
 413 static void do_del_port(struct dp_netdev *dp, struct dp_netdev_port *)
 414     OVS_REQUIRES(dp->port_mutex);
 415 static int dpif_netdev_open(const struct dpif_class *, const char *name,
 416                             bool create, struct dpif **);
 417 static void dp_netdev_execute_actions(struct dp_netdev_pmd_thread *pmd,
 418                                       struct dpif_packet **, int c,
 419                                       bool may_steal,
 420                                       const struct nlattr *actions,
 421                                       size_t actions_len);
 422 static void dp_netdev_input(struct dp_netdev_pmd_thread *,
 423                             struct dpif_packet **, int cnt);
 424
 425 static void dp_netdev_disable_upcall(struct dp_netdev *);
 426 void dp_netdev_pmd_reload_done(struct dp_netdev_pmd_thread *pmd);
 427 static void dp_netdev_configure_pmd(struct dp_netdev_pmd_thread *pmd,
 428                                     struct dp_netdev *dp, int index,
 429                                     int core_id, int numa_id);
 430 static void dp_netdev_destroy_pmd(struct dp_netdev_pmd_thread *pmd);
 431 static void dp_netdev_set_nonpmd(struct dp_netdev *dp);
 432 static struct dp_netdev_pmd_thread *dp_netdev_get_pmd(struct dp_netdev *dp,
 433                                                       int core_id);
 434 static struct dp_netdev_pmd_thread *
 435 dp_netdev_pmd_get_next(struct dp_netdev *dp, struct cmap_position *pos);
 436 static void dp_netdev_destroy_all_pmds(struct dp_netdev *dp);
 437 static void dp_netdev_del_pmds_on_numa(struct dp_netdev *dp, int numa_id);
 438 static void dp_netdev_set_pmds_on_numa(struct dp_netdev *dp, int numa_id);
 439 static void dp_netdev_reset_pmd_threads(struct dp_netdev *dp);
 440 static bool dp_netdev_pmd_try_ref(struct dp_netdev_pmd_thread *pmd);
 441 static void dp_netdev_pmd_unref(struct dp_netdev_pmd_thread *pmd);
 442 static void dp_netdev_pmd_flow_flush(struct dp_netdev_pmd_thread *pmd);
 443
 444 static inline bool emc_entry_alive(struct emc_entry *ce);
 445 static void emc_clear_entry(struct emc_entry *ce);
 446
 447 static void
 448 emc_cache_init(struct emc_cache *flow_cache)
 449 {
 450     int i;
 451
 452     BUILD_ASSERT(offsetof(struct miniflow, inline_values) == sizeof(uint64_t));
 453
 454     flow_cache->sweep_idx = 0;
 455     for (i = 0; i < ARRAY_SIZE(flow_cache->entries); i++) {
 456         flow_cache->entries[i].flow = NULL;
 457         flow_cache->entries[i].key.hash = 0;
 458         flow_cache->entries[i].key.len
 459             = offsetof(struct miniflow, inline_values);
 460         miniflow_initialize(&flow_cache->entries[i].key.mf,
 461                             flow_cache->entries[i].key.buf);
 462     }
 463 }
 464
 465 static void
 466 emc_cache_uninit(struct emc_cache *flow_cache)
 467 {
 468     int i;
 469
 470     for (i = 0; i < ARRAY_SIZE(flow_cache->entries); i++) {
 471         emc_clear_entry(&flow_cache->entries[i]);
 472     }
 473 }
 474
 475 /* Check and clear dead flow references slowly (one entry at each
 476  * invocation).  */
 477 static void
 478 emc_cache_slow_sweep(struct emc_cache *flow_cache)
 479 {
 480     struct emc_entry *entry = &flow_cache->entries[flow_cache->sweep_idx];
 481
 482     if (!emc_entry_alive(entry)) {
 483         emc_clear_entry(entry);
 484     }
 485     flow_cache->sweep_idx = (flow_cache->sweep_idx + 1) & EM_FLOW_HASH_MASK;
 486 }
 487
 488 static struct dpif_netdev *
 489 dpif_netdev_cast(const struct dpif *dpif)
 490 {
 491     ovs_assert(dpif->dpif_class->open == dpif_netdev_open);
 492     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
 493 }
 494
 495 static struct dp_netdev *
 496 get_dp_netdev(const struct dpif *dpif)
 497 {
 498     return dpif_netdev_cast(dpif)->dp;
 499 }
 500
 501 static int
 502 dpif_netdev_enumerate(struct sset *all_dps,
 503                       const struct dpif_class *dpif_class)
 504 {
 505     struct shash_node *node;
 506
 507     ovs_mutex_lock(&dp_netdev_mutex);
 508     SHASH_FOR_EACH(node, &dp_netdevs) {
 509         struct dp_netdev *dp = node->data;
 510         if (dpif_class != dp->class) {
 511             /* 'dp_netdevs' contains both "netdev" and "dummy" dpifs.
 512              * If the class doesn't match, skip this dpif. */
 513              continue;
 514         }
 515         sset_add(all_dps, node->name);
 516     }
 517     ovs_mutex_unlock(&dp_netdev_mutex);
 518
 519     return 0;
 520 }
 521
 522 static bool
 523 dpif_netdev_class_is_dummy(const struct dpif_class *class)
 524 {
 525     return class != &dpif_netdev_class;
 526 }
 527
 528 static const char *
 529 dpif_netdev_port_open_type(const struct dpif_class *class, const char *type)
 530 {
 531     return strcmp(type, "internal") ? type
 532                   : dpif_netdev_class_is_dummy(class) ? "dummy"
 533                   : "tap";
 534 }
 535
 536 static struct dpif *
 537 create_dpif_netdev(struct dp_netdev *dp)
 538 {
 539     uint16_t netflow_id = hash_string(dp->name, 0);
 540     struct dpif_netdev *dpif;
 541
 542     ovs_refcount_ref(&dp->ref_cnt);
 543
 544     dpif = xmalloc(sizeof *dpif);
 545     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
 546     dpif->dp = dp;
 547     dpif->last_port_seq = seq_read(dp->port_seq);
 548
 549     return &dpif->dpif;
 550 }
 551
 552 /* Choose an unused, non-zero port number and return it on success.
 553  * Return ODPP_NONE on failure. */
 554 static odp_port_t
 555 choose_port(struct dp_netdev *dp, const char *name)
 556     OVS_REQUIRES(dp->port_mutex)
 557 {
 558     uint32_t port_no;
 559
 560     if (dp->class != &dpif_netdev_class) {
 561         const char *p;
 562         int start_no = 0;
 563
 564         /* If the port name begins with "br", start the number search at
 565          * 100 to make writing tests easier. */
 566         if (!strncmp(name, "br", 2)) {
 567             start_no = 100;
 568         }
 569
 570         /* If the port name contains a number, try to assign that port number.
 571          * This can make writing unit tests easier because port numbers are
 572          * predictable. */
 573         for (p = name; *p != '\0'; p++) {
 574             if (isdigit((unsigned char) *p)) {
 575                 port_no = start_no + strtol(p, NULL, 10);
 576                 if (port_no > 0 && port_no != odp_to_u32(ODPP_NONE)
 577                     && !dp_netdev_lookup_port(dp, u32_to_odp(port_no))) {
 578                     return u32_to_odp(port_no);
 579                 }
 580                 break;
 581             }
 582         }
 583     }
 584
 585     for (port_no = 1; port_no <= UINT16_MAX; port_no++) {
 586         if (!dp_netdev_lookup_port(dp, u32_to_odp(port_no))) {
 587             return u32_to_odp(port_no);
 588         }
 589     }
 590
 591     return ODPP_NONE;
 592 }
 593
 594 static int
 595 create_dp_netdev(const char *name, const struct dpif_class *class,
 596                  struct dp_netdev **dpp)
 597     OVS_REQUIRES(dp_netdev_mutex)
 598 {
 599     struct dp_netdev *dp;
 600     int error;
 601
 602     dp = xzalloc(sizeof *dp);
 603     shash_add(&dp_netdevs, name, dp);
 604
 605     *CONST_CAST(const struct dpif_class **, &dp->class) = class;
 606     *CONST_CAST(const char **, &dp->name) = xstrdup(name);
 607     ovs_refcount_init(&dp->ref_cnt);
 608     atomic_flag_clear(&dp->destroyed);
 609
 610     ovs_mutex_init(&dp->port_mutex);
 611     cmap_init(&dp->ports);
 612     dp->port_seq = seq_create();
 613     fat_rwlock_init(&dp->upcall_rwlock);
 614
 615     /* Disable upcalls by default. */
 616     dp_netdev_disable_upcall(dp);
 617     dp->upcall_aux = NULL;
 618     dp->upcall_cb = NULL;
 619
 620     cmap_init(&dp->poll_threads);
 621     ovs_mutex_init_recursive(&dp->non_pmd_mutex);
 622     ovsthread_key_create(&dp->per_pmd_key, NULL);
 623
 624     /* Reserves the core NON_PMD_CORE_ID for all non-pmd threads. */
 625     ovs_numa_try_pin_core_specific(NON_PMD_CORE_ID);
 626     dp_netdev_set_nonpmd(dp);
 627     dp->n_dpdk_rxqs = NR_QUEUE;
 628
 629     ovs_mutex_lock(&dp->port_mutex);
 630     error = do_add_port(dp, name, "internal", ODPP_LOCAL);
 631     ovs_mutex_unlock(&dp->port_mutex);
 632     if (error) {
 633         dp_netdev_free(dp);
 634         return error;
 635     }
 636
 637     dp->last_tnl_conf_seq = seq_read(tnl_conf_seq);
 638     *dpp = dp;
 639     return 0;
 640 }
 641
 642 static int
 643 dpif_netdev_open(const struct dpif_class *class, const char *name,
 644                  bool create, struct dpif **dpifp)
 645 {
 646     struct dp_netdev *dp;
 647     int error;
 648
 649     ovs_mutex_lock(&dp_netdev_mutex);
 650     dp = shash_find_data(&dp_netdevs, name);
 651     if (!dp) {
 652         error = create ? create_dp_netdev(name, class, &dp) : ENODEV;
 653     } else {
 654         error = (dp->class != class ? EINVAL
 655                  : create ? EEXIST
 656                  : 0);
 657     }
 658     if (!error) {
 659         *dpifp = create_dpif_netdev(dp);
 660         dp->dpif = *dpifp;
 661     }
 662     ovs_mutex_unlock(&dp_netdev_mutex);
 663
 664     return error;
 665 }
 666
 667 static void
 668 dp_netdev_destroy_upcall_lock(struct dp_netdev *dp)
 669     OVS_NO_THREAD_SAFETY_ANALYSIS
 670 {
 671     /* Check that upcalls are disabled, i.e. that the rwlock is taken */
 672     ovs_assert(fat_rwlock_tryrdlock(&dp->upcall_rwlock));
 673
 674     /* Before freeing a lock we should release it */
 675     fat_rwlock_unlock(&dp->upcall_rwlock);
 676     fat_rwlock_destroy(&dp->upcall_rwlock);
 677 }
 678
 679 /* Requires dp_netdev_mutex so that we can't get a new reference to 'dp'
 680  * through the 'dp_netdevs' shash while freeing 'dp'. */
 681 static void
 682 dp_netdev_free(struct dp_netdev *dp)
 683     OVS_REQUIRES(dp_netdev_mutex)
 684 {
 685     struct dp_netdev_port *port;
 686
 687     shash_find_and_delete(&dp_netdevs, dp->name);
 688
 689     dp_netdev_destroy_all_pmds(dp);
 690     cmap_destroy(&dp->poll_threads);
 691     ovs_mutex_destroy(&dp->non_pmd_mutex);
 692     ovsthread_key_delete(dp->per_pmd_key);
 693
 694     ovs_mutex_lock(&dp->port_mutex);
 695     CMAP_FOR_EACH (port, node, &dp->ports) {
 696         do_del_port(dp, port);
 697     }
 698     ovs_mutex_unlock(&dp->port_mutex);
 699
 700     seq_destroy(dp->port_seq);
 701     cmap_destroy(&dp->ports);
 702
 703     /* Upcalls must be disabled at this point */
 704     dp_netdev_destroy_upcall_lock(dp);
 705
 706     free(dp->pmd_cmask);
 707     free(CONST_CAST(char *, dp->name));
 708     free(dp);
 709 }
 710
 711 static void
 712 dp_netdev_unref(struct dp_netdev *dp)
 713 {
 714     if (dp) {
 715         /* Take dp_netdev_mutex so that, if dp->ref_cnt falls to zero, we can't
 716          * get a new reference to 'dp' through the 'dp_netdevs' shash. */
 717         ovs_mutex_lock(&dp_netdev_mutex);
 718         if (ovs_refcount_unref_relaxed(&dp->ref_cnt) == 1) {
 719             dp_netdev_free(dp);
 720         }
 721         ovs_mutex_unlock(&dp_netdev_mutex);
 722     }
 723 }
 724
 725 static void
 726 dpif_netdev_close(struct dpif *dpif)
 727 {
 728     struct dp_netdev *dp = get_dp_netdev(dpif);
 729
 730     dp_netdev_unref(dp);
 731     free(dpif);
 732 }
 733
 734 static int
 735 dpif_netdev_destroy(struct dpif *dpif)
 736 {
 737     struct dp_netdev *dp = get_dp_netdev(dpif);
 738
 739     if (!atomic_flag_test_and_set(&dp->destroyed)) {
 740         if (ovs_refcount_unref_relaxed(&dp->ref_cnt) == 1) {
 741             /* Can't happen: 'dpif' still owns a reference to 'dp'. */
 742             OVS_NOT_REACHED();
 743         }
 744     }
 745
 746     return 0;
 747 }
 748
 749 static int
 750 dpif_netdev_get_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
 751 {
 752     struct dp_netdev *dp = get_dp_netdev(dpif);
 753     struct dp_netdev_pmd_thread *pmd;
 754
 755     stats->n_flows = stats->n_hit = stats->n_missed = stats->n_lost = 0;
 756     CMAP_FOR_EACH (pmd, node, &dp->poll_threads) {
 757         stats->n_flows += cmap_count(&pmd->flow_table);
 758         stats->n_hit += pmd->stats.n[DP_STAT_HIT];
 759         stats->n_missed += pmd->stats.n[DP_STAT_MISS];
 760         stats->n_lost += pmd->stats.n[DP_STAT_LOST];
 761     }
 762     stats->n_masks = UINT32_MAX;
 763     stats->n_mask_hit = UINT64_MAX;
 764
 765     return 0;
 766 }
 767
 768 static void
 769 dp_netdev_reload_pmd__(struct dp_netdev_pmd_thread *pmd)
 770 {
 771     int old_seq;
 772
 773     if (pmd->core_id == NON_PMD_CORE_ID) {
 774         return;
 775     }
 776
 777     ovs_mutex_lock(&pmd->cond_mutex);
 778     atomic_add_relaxed(&pmd->change_seq, 1, &old_seq);
 779     ovs_mutex_cond_wait(&pmd->cond, &pmd->cond_mutex);
 780     ovs_mutex_unlock(&pmd->cond_mutex);
 781 }
 782
 783 /* Causes all pmd threads to reload its tx/rx devices.
 784  * Must be called after adding/removing ports. */
 785 static void
 786 dp_netdev_reload_pmds(struct dp_netdev *dp)
 787 {
 788     struct dp_netdev_pmd_thread *pmd;
 789
 790     CMAP_FOR_EACH (pmd, node, &dp->poll_threads) {
 791         dp_netdev_reload_pmd__(pmd);
 792     }
 793 }
 794
 795 static uint32_t
 796 hash_port_no(odp_port_t port_no)
 797 {
 798     return hash_int(odp_to_u32(port_no), 0);
 799 }
 800
 801 static int
 802 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
 803             odp_port_t port_no)
 804     OVS_REQUIRES(dp->port_mutex)
 805 {
 806     struct netdev_saved_flags *sf;
 807     struct dp_netdev_port *port;
 808     struct netdev *netdev;
 809     enum netdev_flags flags;
 810     const char *open_type;
 811     int error;
 812     int i;
 813
 814     /* XXX reject devices already in some dp_netdev. */
 815
 816     /* Open and validate network device. */
 817     open_type = dpif_netdev_port_open_type(dp->class, type);
 818     error = netdev_open(devname, open_type, &netdev);
 819     if (error) {
 820         return error;
 821     }
 822     /* XXX reject non-Ethernet devices */
 823
 824     netdev_get_flags(netdev, &flags);
 825     if (flags & NETDEV_LOOPBACK) {
 826         VLOG_ERR("%s: cannot add a loopback device", devname);
 827         netdev_close(netdev);
 828         return EINVAL;
 829     }
 830
 831     if (netdev_is_pmd(netdev)) {
 832         int n_cores = ovs_numa_get_n_cores();
 833
 834         if (n_cores == OVS_CORE_UNSPEC) {
 835             VLOG_ERR("%s, cannot get cpu core info", devname);
 836             return ENOENT;
 837         }
 838         /* There can only be ovs_numa_get_n_cores() pmd threads,
 839          * so creates a txq for each. */
 840         error = netdev_set_multiq(netdev, n_cores, dp->n_dpdk_rxqs);
 841         if (error && (error != EOPNOTSUPP)) {
 842             VLOG_ERR("%s, cannot set multiq", devname);
 843             return errno;
 844         }
 845     }
 846     port = xzalloc(sizeof *port);
 847     port->port_no = port_no;
 848     port->netdev = netdev;
 849     port->rxq = xmalloc(sizeof *port->rxq * netdev_n_rxq(netdev));
 850     port->type = xstrdup(type);
 851     for (i = 0; i < netdev_n_rxq(netdev); i++) {
 852         error = netdev_rxq_open(netdev, &port->rxq[i], i);
 853         if (error
 854             && !(error == EOPNOTSUPP && dpif_netdev_class_is_dummy(dp->class))) {
 855             VLOG_ERR("%s: cannot receive packets on this network device (%s)",
 856                      devname, ovs_strerror(errno));
 857             netdev_close(netdev);
 858             free(port->type);
 859             free(port->rxq);
 860             free(port);
 861             return error;
 862         }
 863     }
 864
 865     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, &sf);
 866     if (error) {
 867         for (i = 0; i < netdev_n_rxq(netdev); i++) {
 868             netdev_rxq_close(port->rxq[i]);
 869         }
 870         netdev_close(netdev);
 871         free(port->type);
 872         free(port->rxq);
 873         free(port);
 874         return error;
 875     }
 876     port->sf = sf;
 877
 878     ovs_refcount_init(&port->ref_cnt);
 879     cmap_insert(&dp->ports, &port->node, hash_port_no(port_no));
 880
 881     if (netdev_is_pmd(netdev)) {
 882         dp_netdev_set_pmds_on_numa(dp, netdev_get_numa_id(netdev));
 883         dp_netdev_reload_pmds(dp);
 884     }
 885     seq_change(dp->port_seq);
 886
 887     return 0;
 888 }
 889
 890 static int
 891 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
 892                      odp_port_t *port_nop)
 893 {
 894     struct dp_netdev *dp = get_dp_netdev(dpif);
 895     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
 896     const char *dpif_port;
 897     odp_port_t port_no;
 898     int error;
 899
 900     ovs_mutex_lock(&dp->port_mutex);
 901     dpif_port = netdev_vport_get_dpif_port(netdev, namebuf, sizeof namebuf);
 902     if (*port_nop != ODPP_NONE) {
 903         port_no = *port_nop;
 904         error = dp_netdev_lookup_port(dp, *port_nop) ? EBUSY : 0;
 905     } else {
 906         port_no = choose_port(dp, dpif_port);
 907         error = port_no == ODPP_NONE ? EFBIG : 0;
 908     }
 909     if (!error) {
 910         *port_nop = port_no;
 911         error = do_add_port(dp, dpif_port, netdev_get_type(netdev), port_no);
 912     }
 913     ovs_mutex_unlock(&dp->port_mutex);
 914
 915     return error;
 916 }
 917
 918 static int
 919 dpif_netdev_port_del(struct dpif *dpif, odp_port_t port_no)
 920 {
 921     struct dp_netdev *dp = get_dp_netdev(dpif);
 922     int error;
 923
 924     ovs_mutex_lock(&dp->port_mutex);
 925     if (port_no == ODPP_LOCAL) {
 926         error = EINVAL;
 927     } else {
 928         struct dp_netdev_port *port;
 929
 930         error = get_port_by_number(dp, port_no, &port);
 931         if (!error) {
 932             do_del_port(dp, port);
 933         }
 934     }
 935     ovs_mutex_unlock(&dp->port_mutex);
 936
 937     return error;
 938 }
 939
 940 static bool
 941 is_valid_port_number(odp_port_t port_no)
 942 {
 943     return port_no != ODPP_NONE;
 944 }
 945
 946 static struct dp_netdev_port *
 947 dp_netdev_lookup_port(const struct dp_netdev *dp, odp_port_t port_no)
 948 {
 949     struct dp_netdev_port *port;
 950
 951     CMAP_FOR_EACH_WITH_HASH (port, node, hash_port_no(port_no), &dp->ports) {
 952         if (port->port_no == port_no) {
 953             return port;
 954         }
 955     }
 956     return NULL;
 957 }
 958
 959 static int
 960 get_port_by_number(struct dp_netdev *dp,
 961                    odp_port_t port_no, struct dp_netdev_port **portp)
 962 {
 963     if (!is_valid_port_number(port_no)) {
 964         *portp = NULL;
 965         return EINVAL;
 966     } else {
 967         *portp = dp_netdev_lookup_port(dp, port_no);
 968         return *portp ? 0 : ENOENT;
 969     }
 970 }
 971
 972 static void
 973 port_ref(struct dp_netdev_port *port)
 974 {
 975     if (port) {
 976         ovs_refcount_ref(&port->ref_cnt);
 977     }
 978 }
 979
 980 static bool
 981 port_try_ref(struct dp_netdev_port *port)
 982 {
 983     if (port) {
 984         return ovs_refcount_try_ref_rcu(&port->ref_cnt);
 985     }
 986
 987     return false;
 988 }
 989
 990 static void
 991 port_unref(struct dp_netdev_port *port)
 992 {
 993     if (port && ovs_refcount_unref_relaxed(&port->ref_cnt) == 1) {
 994         int n_rxq = netdev_n_rxq(port->netdev);
 995         int i;
 996
 997         netdev_close(port->netdev);
 998         netdev_restore_flags(port->sf);
 999
1000         for (i = 0; i < n_rxq; i++) {
1001             netdev_rxq_close(port->rxq[i]);
1002         }
1003         free(port->rxq);
1004         free(port->type);
1005         free(port);
1006     }
1007 }
1008
1009 static int
1010 get_port_by_name(struct dp_netdev *dp,
1011                  const char *devname, struct dp_netdev_port **portp)
1012     OVS_REQUIRES(dp->port_mutex)
1013 {
1014     struct dp_netdev_port *port;
1015
1016     CMAP_FOR_EACH (port, node, &dp->ports) {
1017         if (!strcmp(netdev_get_name(port->netdev), devname)) {
1018             *portp = port;
1019             return 0;
1020         }
1021     }
1022     return ENOENT;
1023 }
1024
1025 static int
1026 get_n_pmd_threads_on_numa(struct dp_netdev *dp, int numa_id)
1027 {
1028     struct dp_netdev_pmd_thread *pmd;
1029     int n_pmds = 0;
1030
1031     CMAP_FOR_EACH (pmd, node, &dp->poll_threads) {
1032         if (pmd->numa_id == numa_id) {
1033             n_pmds++;
1034         }
1035     }
1036
1037     return n_pmds;
1038 }
1039
1040 /* Returns 'true' if there is a port with pmd netdev and the netdev
1041  * is on numa node 'numa_id'. */
1042 static bool
1043 has_pmd_port_for_numa(struct dp_netdev *dp, int numa_id)
1044 {
1045     struct dp_netdev_port *port;
1046
1047     CMAP_FOR_EACH (port, node, &dp->ports) {
1048         if (netdev_is_pmd(port->netdev)
1049             && netdev_get_numa_id(port->netdev) == numa_id) {
1050             return true;
1051         }
1052     }
1053
1054     return false;
1055 }
1056
1057
1058 static void
1059 do_del_port(struct dp_netdev *dp, struct dp_netdev_port *port)
1060     OVS_REQUIRES(dp->port_mutex)
1061 {
1062     cmap_remove(&dp->ports, &port->node, hash_odp_port(port->port_no));
1063     seq_change(dp->port_seq);
1064     if (netdev_is_pmd(port->netdev)) {
1065         int numa_id = netdev_get_numa_id(port->netdev);
1066
1067         /* If there is no netdev on the numa node, deletes the pmd threads
1068          * for that numa.  Else, just reloads the queues.  */
1069         if (!has_pmd_port_for_numa(dp, numa_id)) {
1070             dp_netdev_del_pmds_on_numa(dp, numa_id);
1071         }
1072         dp_netdev_reload_pmds(dp);
1073     }
1074
1075     port_unref(port);
1076 }
1077
1078 static void
1079 answer_port_query(const struct dp_netdev_port *port,
1080                   struct dpif_port *dpif_port)
1081 {
1082     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
1083     dpif_port->type = xstrdup(port->type);
1084     dpif_port->port_no = port->port_no;
1085 }
1086
1087 static int
1088 dpif_netdev_port_query_by_number(const struct dpif *dpif, odp_port_t port_no,
1089                                  struct dpif_port *dpif_port)
1090 {
1091     struct dp_netdev *dp = get_dp_netdev(dpif);
1092     struct dp_netdev_port *port;
1093     int error;
1094
1095     error = get_port_by_number(dp, port_no, &port);
1096     if (!error && dpif_port) {
1097         answer_port_query(port, dpif_port);
1098     }
1099
1100     return error;
1101 }
1102
1103 static int
1104 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
1105                                struct dpif_port *dpif_port)
1106 {
1107     struct dp_netdev *dp = get_dp_netdev(dpif);
1108     struct dp_netdev_port *port;
1109     int error;
1110
1111     ovs_mutex_lock(&dp->port_mutex);
1112     error = get_port_by_name(dp, devname, &port);
1113     if (!error && dpif_port) {
1114         answer_port_query(port, dpif_port);
1115     }
1116     ovs_mutex_unlock(&dp->port_mutex);
1117
1118     return error;
1119 }
1120
1121 static void
1122 dp_netdev_flow_free(struct dp_netdev_flow *flow)
1123 {
1124     dp_netdev_actions_free(dp_netdev_flow_get_actions(flow));
1125     free(flow);
1126 }
1127
1128 static void dp_netdev_flow_unref(struct dp_netdev_flow *flow)
1129 {
1130     if (ovs_refcount_unref_relaxed(&flow->ref_cnt) == 1) {
1131         ovsrcu_postpone(dp_netdev_flow_free, flow);
1132     }
1133 }
1134
1135 static uint32_t
1136 dp_netdev_flow_hash(const ovs_u128 *ufid)
1137 {
1138     return ufid->u32[0];
1139 }
1140
1141 static void
1142 dp_netdev_pmd_remove_flow(struct dp_netdev_pmd_thread *pmd,
1143                           struct dp_netdev_flow *flow)
1144     OVS_REQUIRES(pmd->flow_mutex)
1145 {
1146     struct cmap_node *node = CONST_CAST(struct cmap_node *, &flow->node);
1147
1148     dpcls_remove(&pmd->cls, &flow->cr);
1149     cmap_remove(&pmd->flow_table, node, dp_netdev_flow_hash(&flow->ufid));
1150     flow->dead = true;
1151
1152     dp_netdev_flow_unref(flow);
1153 }
1154
1155 static void
1156 dp_netdev_pmd_flow_flush(struct dp_netdev_pmd_thread *pmd)
1157 {
1158     struct dp_netdev_flow *netdev_flow;
1159
1160     ovs_mutex_lock(&pmd->flow_mutex);
1161     CMAP_FOR_EACH (netdev_flow, node, &pmd->flow_table) {
1162         dp_netdev_pmd_remove_flow(pmd, netdev_flow);
1163     }
1164     ovs_mutex_unlock(&pmd->flow_mutex);
1165 }
1166
1167 static int
1168 dpif_netdev_flow_flush(struct dpif *dpif)
1169 {
1170     struct dp_netdev *dp = get_dp_netdev(dpif);
1171     struct dp_netdev_pmd_thread *pmd;
1172
1173     CMAP_FOR_EACH (pmd, node, &dp->poll_threads) {
1174         dp_netdev_pmd_flow_flush(pmd);
1175     }
1176
1177     return 0;
1178 }
1179
1180 struct dp_netdev_port_state {
1181     struct cmap_position position;
1182     char *name;
1183 };
1184
1185 static int
1186 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
1187 {
1188     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
1189     return 0;
1190 }
1191
1192 static int
1193 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
1194                            struct dpif_port *dpif_port)
1195 {
1196     struct dp_netdev_port_state *state = state_;
1197     struct dp_netdev *dp = get_dp_netdev(dpif);
1198     struct cmap_node *node;
1199     int retval;
1200
1201     node = cmap_next_position(&dp->ports, &state->position);
1202     if (node) {
1203         struct dp_netdev_port *port;
1204
1205         port = CONTAINER_OF(node, struct dp_netdev_port, node);
1206
1207         free(state->name);
1208         state->name = xstrdup(netdev_get_name(port->netdev));
1209         dpif_port->name = state->name;
1210         dpif_port->type = port->type;
1211         dpif_port->port_no = port->port_no;
1212
1213         retval = 0;
1214     } else {
1215         retval = EOF;
1216     }
1217
1218     return retval;
1219 }
1220
1221 static int
1222 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
1223 {
1224     struct dp_netdev_port_state *state = state_;
1225     free(state->name);
1226     free(state);
1227     return 0;
1228 }
1229
1230 static int
1231 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
1232 {
1233     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
1234     uint64_t new_port_seq;
1235     int error;
1236
1237     new_port_seq = seq_read(dpif->dp->port_seq);
1238     if (dpif->last_port_seq != new_port_seq) {
1239         dpif->last_port_seq = new_port_seq;
1240         error = ENOBUFS;
1241     } else {
1242         error = EAGAIN;
1243     }
1244
1245     return error;
1246 }
1247
1248 static void
1249 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
1250 {
1251     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
1252
1253     seq_wait(dpif->dp->port_seq, dpif->last_port_seq);
1254 }
1255
1256 static struct dp_netdev_flow *
1257 dp_netdev_flow_cast(const struct dpcls_rule *cr)
1258 {
1259     return cr ? CONTAINER_OF(cr, struct dp_netdev_flow, cr) : NULL;
1260 }
1261
1262 static bool dp_netdev_flow_ref(struct dp_netdev_flow *flow)
1263 {
1264     return ovs_refcount_try_ref_rcu(&flow->ref_cnt);
1265 }
1266
1267 /* netdev_flow_key utilities.
1268  *
1269  * netdev_flow_key is basically a miniflow.  We use these functions
1270  * (netdev_flow_key_clone, netdev_flow_key_equal, ...) instead of the miniflow
1271  * functions (miniflow_clone_inline, miniflow_equal, ...), because:
1272  *
1273  * - Since we are dealing exclusively with miniflows created by
1274  *   miniflow_extract(), if the map is different the miniflow is different.
1275  *   Therefore we can be faster by comparing the map and the miniflow in a
1276  *   single memcmp().
1277  * _ netdev_flow_key's miniflow has always inline values.
1278  * - These functions can be inlined by the compiler.
1279  *
1280  * The following assertions make sure that what we're doing with miniflow is
1281  * safe
1282  */
1283 BUILD_ASSERT_DECL(offsetof(struct miniflow, inline_values)
1284                   == sizeof(uint64_t));
1285
1286 /* Given the number of bits set in the miniflow map, returns the size of the
1287  * 'netdev_flow_key.mf' */
1288 static inline uint32_t
1289 netdev_flow_key_size(uint32_t flow_u32s)
1290 {
1291     return offsetof(struct miniflow, inline_values) +
1292         MINIFLOW_VALUES_SIZE(flow_u32s);
1293 }
1294
1295 static inline bool
1296 netdev_flow_key_equal(const struct netdev_flow_key *a,
1297                       const struct netdev_flow_key *b)
1298 {
1299     /* 'b->len' may be not set yet. */
1300     return a->hash == b->hash && !memcmp(&a->mf, &b->mf, a->len);
1301 }
1302
1303 /* Used to compare 'netdev_flow_key' in the exact match cache to a miniflow.
1304  * The maps are compared bitwise, so both 'key->mf' 'mf' must have been
1305  * generated by miniflow_extract. */
1306 static inline bool
1307 netdev_flow_key_equal_mf(const struct netdev_flow_key *key,
1308                          const struct miniflow *mf)
1309 {
1310     return !memcmp(&key->mf, mf, key->len);
1311 }
1312
1313 static inline void
1314 netdev_flow_key_clone(struct netdev_flow_key *dst,
1315                       const struct netdev_flow_key *src)
1316 {
1317     memcpy(dst, src,
1318            offsetof(struct netdev_flow_key, mf) + src->len);
1319 }
1320
1321 /* Slow. */
1322 static void
1323 netdev_flow_key_from_flow(struct netdev_flow_key *dst,
1324                           const struct flow *src)
1325 {
1326     struct ofpbuf packet;
1327     uint64_t buf_stub[512 / 8];
1328     struct pkt_metadata md = pkt_metadata_from_flow(src);
1329
1330     miniflow_initialize(&dst->mf, dst->buf);
1331
1332     ofpbuf_use_stub(&packet, buf_stub, sizeof buf_stub);
1333     flow_compose(&packet, src);
1334     miniflow_extract(&packet, &md, &dst->mf);
1335     ofpbuf_uninit(&packet);
1336
1337     dst->len = netdev_flow_key_size(count_1bits(dst->mf.map));
1338     dst->hash = 0; /* Not computed yet. */
1339 }
1340
1341 /* Initialize a netdev_flow_key 'mask' from 'match'. */
1342 static inline void
1343 netdev_flow_mask_init(struct netdev_flow_key *mask,
1344                       const struct match *match)
1345 {
1346     const uint32_t *mask_u32 = (const uint32_t *) &match->wc.masks;
1347     uint32_t *dst = mask->mf.inline_values;
1348     uint64_t map, mask_map = 0;
1349     uint32_t hash = 0;
1350     int n;
1351
1352     /* Only check masks that make sense for the flow. */
1353     map = flow_wc_map(&match->flow);
1354
1355     while (map) {
1356         uint64_t rm1bit = rightmost_1bit(map);
1357         int i = raw_ctz(map);
1358
1359         if (mask_u32[i]) {
1360             mask_map |= rm1bit;
1361             *dst++ = mask_u32[i];
1362             hash = hash_add(hash, mask_u32[i]);
1363         }
1364         map -= rm1bit;
1365     }
1366
1367     mask->mf.values_inline = true;
1368     mask->mf.map = mask_map;
1369
1370     hash = hash_add64(hash, mask_map);
1371
1372     n = dst - mask->mf.inline_values;
1373
1374     mask->hash = hash_finish(hash, n * 4);
1375     mask->len = netdev_flow_key_size(n);
1376 }
1377
1378 /* Initializes 'dst' as a copy of 'src' masked with 'mask'. */
1379 static inline void
1380 netdev_flow_key_init_masked(struct netdev_flow_key *dst,
1381                             const struct flow *flow,
1382                             const struct netdev_flow_key *mask)
1383 {
1384     uint32_t *dst_u32 = dst->mf.inline_values;
1385     const uint32_t *mask_u32 = mask->mf.inline_values;
1386     uint32_t hash = 0;
1387     uint32_t value;
1388
1389     dst->len = mask->len;
1390     dst->mf.values_inline = true;
1391     dst->mf.map = mask->mf.map;
1392
1393     FLOW_FOR_EACH_IN_MAP(value, flow, mask->mf.map) {
1394         *dst_u32 = value & *mask_u32++;
1395         hash = hash_add(hash, *dst_u32++);
1396     }
1397     dst->hash = hash_finish(hash, (dst_u32 - dst->mf.inline_values) * 4);
1398 }
1399
1400 /* Iterate through all netdev_flow_key u32 values specified by 'MAP' */
1401 #define NETDEV_FLOW_KEY_FOR_EACH_IN_MAP(VALUE, KEY, MAP)           \
1402     for (struct mf_for_each_in_map_aux aux__                       \
1403              = { (KEY)->mf.inline_values, (KEY)->mf.map, MAP };    \
1404          mf_get_next_in_map(&aux__, &(VALUE));                     \
1405         )
1406
1407 /* Returns a hash value for the bits of 'key' where there are 1-bits in
1408  * 'mask'. */
1409 static inline uint32_t
1410 netdev_flow_key_hash_in_mask(const struct netdev_flow_key *key,
1411                              const struct netdev_flow_key *mask)
1412 {
1413     const uint32_t *p = mask->mf.inline_values;
1414     uint32_t hash = 0;
1415     uint32_t key_u32;
1416
1417     NETDEV_FLOW_KEY_FOR_EACH_IN_MAP(key_u32, key, mask->mf.map) {
1418         hash = hash_add(hash, key_u32 & *p++);
1419     }
1420
1421     return hash_finish(hash, (p - mask->mf.inline_values) * 4);
1422 }
1423
1424 static inline bool
1425 emc_entry_alive(struct emc_entry *ce)
1426 {
1427     return ce->flow && !ce->flow->dead;
1428 }
1429
1430 static void
1431 emc_clear_entry(struct emc_entry *ce)
1432 {
1433     if (ce->flow) {
1434         dp_netdev_flow_unref(ce->flow);
1435         ce->flow = NULL;
1436     }
1437 }
1438
1439 static inline void
1440 emc_change_entry(struct emc_entry *ce, struct dp_netdev_flow *flow,
1441                  const struct netdev_flow_key *key)
1442 {
1443     if (ce->flow != flow) {
1444         if (ce->flow) {
1445             dp_netdev_flow_unref(ce->flow);
1446         }
1447
1448         if (dp_netdev_flow_ref(flow)) {
1449             ce->flow = flow;
1450         } else {
1451             ce->flow = NULL;
1452         }
1453     }
1454     if (key) {
1455         netdev_flow_key_clone(&ce->key, key);
1456     }
1457 }
1458
1459 static inline void
1460 emc_insert(struct emc_cache *cache, const struct netdev_flow_key *key,
1461            struct dp_netdev_flow *flow)
1462 {
1463     struct emc_entry *to_be_replaced = NULL;
1464     struct emc_entry *current_entry;
1465
1466     EMC_FOR_EACH_POS_WITH_HASH(cache, current_entry, key->hash) {
1467         if (netdev_flow_key_equal(&current_entry->key, key)) {
1468             /* We found the entry with the 'mf' miniflow */
1469             emc_change_entry(current_entry, flow, NULL);
1470             return;
1471         }
1472
1473         /* Replacement policy: put the flow in an empty (not alive) entry, or
1474          * in the first entry where it can be */
1475         if (!to_be_replaced
1476             || (emc_entry_alive(to_be_replaced)
1477                 && !emc_entry_alive(current_entry))
1478             || current_entry->key.hash < to_be_replaced->key.hash) {
1479             to_be_replaced = current_entry;
1480         }
1481     }
1482     /* We didn't find the miniflow in the cache.
1483      * The 'to_be_replaced' entry is where the new flow will be stored */
1484
1485     emc_change_entry(to_be_replaced, flow, key);
1486 }
1487
1488 static inline struct dp_netdev_flow *
1489 emc_lookup(struct emc_cache *cache, const struct netdev_flow_key *key)
1490 {
1491     struct emc_entry *current_entry;
1492
1493     EMC_FOR_EACH_POS_WITH_HASH(cache, current_entry, key->hash) {
1494         if (current_entry->key.hash == key->hash
1495             && emc_entry_alive(current_entry)
1496             && netdev_flow_key_equal_mf(&current_entry->key, &key->mf)) {
1497
1498             /* We found the entry with the 'key->mf' miniflow */
1499             return current_entry->flow;
1500         }
1501     }
1502
1503     return NULL;
1504 }
1505
1506 static struct dp_netdev_flow *
1507 dp_netdev_pmd_lookup_flow(const struct dp_netdev_pmd_thread *pmd,
1508                           const struct netdev_flow_key *key)
1509 {
1510     struct dp_netdev_flow *netdev_flow;
1511     struct dpcls_rule *rule;
1512
1513     dpcls_lookup(&pmd->cls, key, &rule, 1);
1514     netdev_flow = dp_netdev_flow_cast(rule);
1515
1516     return netdev_flow;
1517 }
1518
1519 static struct dp_netdev_flow *
1520 dp_netdev_pmd_find_flow(const struct dp_netdev_pmd_thread *pmd,
1521                         const ovs_u128 *ufidp, const struct nlattr *key,
1522                         size_t key_len)
1523 {
1524     struct dp_netdev_flow *netdev_flow;
1525     struct flow flow;
1526     ovs_u128 ufid;
1527
1528     /* If a UFID is not provided, determine one based on the key. */
1529     if (!ufidp && key && key_len
1530         && !dpif_netdev_flow_from_nlattrs(key, key_len, &flow)) {
1531         dpif_flow_hash(pmd->dp->dpif, &flow, sizeof flow, &ufid);
1532         ufidp = &ufid;
1533     }
1534
1535     if (ufidp) {
1536         CMAP_FOR_EACH_WITH_HASH (netdev_flow, node, dp_netdev_flow_hash(ufidp),
1537                                  &pmd->flow_table) {
1538             if (ovs_u128_equal(&netdev_flow->ufid, ufidp)) {
1539                 return netdev_flow;
1540             }
1541         }
1542     }
1543
1544     return NULL;
1545 }
1546
1547 static void
1548 get_dpif_flow_stats(const struct dp_netdev_flow *netdev_flow,
1549                     struct dpif_flow_stats *stats)
1550 {
1551     stats->n_packets = netdev_flow->stats.packet_count;
1552     stats->n_bytes = netdev_flow->stats.byte_count;
1553     stats->used = netdev_flow->stats.used;
1554     stats->tcp_flags = netdev_flow->stats.tcp_flags;
1555 }
1556
1557 /* Converts to the dpif_flow format, using 'key_buf' and 'mask_buf' for
1558  * storing the netlink-formatted key/mask. 'key_buf' may be the same as
1559  * 'mask_buf'. Actions will be returned without copying, by relying on RCU to
1560  * protect them. */
1561 static void
1562 dp_netdev_flow_to_dpif_flow(const struct dp_netdev_flow *netdev_flow,
1563                             struct ofpbuf *key_buf, struct ofpbuf *mask_buf,
1564                             struct dpif_flow *flow, bool terse)
1565 {
1566     if (terse) {
1567         memset(flow, 0, sizeof *flow);
1568     } else {
1569         struct flow_wildcards wc;
1570         struct dp_netdev_actions *actions;
1571         size_t offset;
1572
1573         miniflow_expand(&netdev_flow->cr.mask->mf, &wc.masks);
1574
1575         /* Key */
1576         offset = ofpbuf_size(key_buf);
1577         flow->key = ofpbuf_tail(key_buf);
1578         odp_flow_key_from_flow(key_buf, &netdev_flow->flow, &wc.masks,
1579                                netdev_flow->flow.in_port.odp_port, true);
1580         flow->key_len = ofpbuf_size(key_buf) - offset;
1581
1582         /* Mask */
1583         offset = ofpbuf_size(mask_buf);
1584         flow->mask = ofpbuf_tail(mask_buf);
1585         odp_flow_key_from_mask(mask_buf, &wc.masks, &netdev_flow->flow,
1586                                odp_to_u32(wc.masks.in_port.odp_port),
1587                                SIZE_MAX, true);
1588         flow->mask_len = ofpbuf_size(mask_buf) - offset;
1589
1590         /* Actions */
1591         actions = dp_netdev_flow_get_actions(netdev_flow);
1592         flow->actions = actions->actions;
1593         flow->actions_len = actions->size;
1594     }
1595
1596     flow->ufid = netdev_flow->ufid;
1597     flow->ufid_present = true;
1598     flow->pmd_id = netdev_flow->pmd_id;
1599     get_dpif_flow_stats(netdev_flow, &flow->stats);
1600 }
1601
1602 static int
1603 dpif_netdev_mask_from_nlattrs(const struct nlattr *key, uint32_t key_len,
1604                               const struct nlattr *mask_key,
1605                               uint32_t mask_key_len, const struct flow *flow,
1606                               struct flow *mask)
1607 {
1608     if (mask_key_len) {
1609         enum odp_key_fitness fitness;
1610
1611         fitness = odp_flow_key_to_mask(mask_key, mask_key_len, mask, flow);
1612         if (fitness) {
1613             /* This should not happen: it indicates that
1614              * odp_flow_key_from_mask() and odp_flow_key_to_mask()
1615              * disagree on the acceptable form of a mask.  Log the problem
1616              * as an error, with enough details to enable debugging. */
1617             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1618
1619             if (!VLOG_DROP_ERR(&rl)) {
1620                 struct ds s;
1621
1622                 ds_init(&s);
1623                 odp_flow_format(key, key_len, mask_key, mask_key_len, NULL, &s,
1624                                 true);
1625                 VLOG_ERR("internal error parsing flow mask %s (%s)",
1626                          ds_cstr(&s), odp_key_fitness_to_string(fitness));
1627                 ds_destroy(&s);
1628             }
1629
1630             return EINVAL;
1631         }
1632     } else {
1633         enum mf_field_id id;
1634         /* No mask key, unwildcard everything except fields whose
1635          * prerequisities are not met. */
1636         memset(mask, 0x0, sizeof *mask);
1637
1638         for (id = 0; id < MFF_N_IDS; ++id) {
1639             /* Skip registers and metadata. */
1640             if (!(id >= MFF_REG0 && id < MFF_REG0 + FLOW_N_REGS)
1641                 && id != MFF_METADATA) {
1642                 const struct mf_field *mf = mf_from_id(id);
1643                 if (mf_are_prereqs_ok(mf, flow)) {
1644                     mf_mask_field(mf, mask);
1645                 }
1646             }
1647         }
1648     }
1649
1650     /* Force unwildcard the in_port.
1651      *
1652      * We need to do this even in the case where we unwildcard "everything"
1653      * above because "everything" only includes the 16-bit OpenFlow port number
1654      * mask->in_port.ofp_port, which only covers half of the 32-bit datapath
1655      * port number mask->in_port.odp_port. */
1656     mask->in_port.odp_port = u32_to_odp(UINT32_MAX);
1657
1658     return 0;
1659 }
1660
1661 static int
1662 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
1663                               struct flow *flow)
1664 {
1665     odp_port_t in_port;
1666
1667     if (odp_flow_key_to_flow(key, key_len, flow)) {
1668         /* This should not happen: it indicates that odp_flow_key_from_flow()
1669          * and odp_flow_key_to_flow() disagree on the acceptable form of a
1670          * flow.  Log the problem as an error, with enough details to enable
1671          * debugging. */
1672         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1673
1674         if (!VLOG_DROP_ERR(&rl)) {
1675             struct ds s;
1676
1677             ds_init(&s);
1678             odp_flow_format(key, key_len, NULL, 0, NULL, &s, true);
1679             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
1680             ds_destroy(&s);
1681         }
1682
1683         return EINVAL;
1684     }
1685
1686     in_port = flow->in_port.odp_port;
1687     if (!is_valid_port_number(in_port) && in_port != ODPP_NONE) {
1688         return EINVAL;
1689     }
1690
1691     return 0;
1692 }
1693
1694 static int
1695 dpif_netdev_flow_get(const struct dpif *dpif, const struct dpif_flow_get *get)
1696 {
1697     struct dp_netdev *dp = get_dp_netdev(dpif);
1698     struct dp_netdev_flow *netdev_flow;
1699     struct dp_netdev_pmd_thread *pmd;
1700     int pmd_id = get->pmd_id == PMD_ID_NULL ? NON_PMD_CORE_ID : get->pmd_id;
1701     int error = 0;
1702
1703     pmd = dp_netdev_get_pmd(dp, pmd_id);
1704     if (!pmd) {
1705         return EINVAL;
1706     }
1707
1708     netdev_flow = dp_netdev_pmd_find_flow(pmd, get->ufid, get->key,
1709                                           get->key_len);
1710     if (netdev_flow) {
1711         dp_netdev_flow_to_dpif_flow(netdev_flow, get->buffer, get->buffer,
1712                                     get->flow, false);
1713     } else {
1714         error = ENOENT;
1715     }
1716     dp_netdev_pmd_unref(pmd);
1717
1718
1719     return error;
1720 }
1721
1722 static struct dp_netdev_flow *
1723 dp_netdev_flow_add(struct dp_netdev_pmd_thread *pmd,
1724                    struct match *match, const ovs_u128 *ufid,
1725                    const struct nlattr *actions, size_t actions_len)
1726     OVS_REQUIRES(pmd->flow_mutex)
1727 {
1728     struct dp_netdev_flow *flow;
1729     struct netdev_flow_key mask;
1730
1731     netdev_flow_mask_init(&mask, match);
1732     /* Make sure wc does not have metadata. */
1733     ovs_assert(!(mask.mf.map & (MINIFLOW_MAP(metadata) | MINIFLOW_MAP(regs))));
1734
1735     /* Do not allocate extra space. */
1736     flow = xmalloc(sizeof *flow - sizeof flow->cr.flow.mf + mask.len);
1737     memset(&flow->stats, 0, sizeof flow->stats);
1738     flow->dead = false;
1739     *CONST_CAST(int *, &flow->pmd_id) = pmd->core_id;
1740     *CONST_CAST(struct flow *, &flow->flow) = match->flow;
1741     *CONST_CAST(ovs_u128 *, &flow->ufid) = *ufid;
1742     ovs_refcount_init(&flow->ref_cnt);
1743     ovsrcu_set(&flow->actions, dp_netdev_actions_create(actions, actions_len));
1744
1745     cmap_insert(&pmd->flow_table,
1746                 CONST_CAST(struct cmap_node *, &flow->node),
1747                 dp_netdev_flow_hash(&flow->ufid));
1748     netdev_flow_key_init_masked(&flow->cr.flow, &match->flow, &mask);
1749     dpcls_insert(&pmd->cls, &flow->cr, &mask);
1750
1751     if (OVS_UNLIKELY(VLOG_IS_DBG_ENABLED())) {
1752         struct match match;
1753         struct ds ds = DS_EMPTY_INITIALIZER;
1754
1755         match.flow = flow->flow;
1756         miniflow_expand(&flow->cr.mask->mf, &match.wc.masks);
1757
1758         ds_put_cstr(&ds, "flow_add: ");
1759         odp_format_ufid(ufid, &ds);
1760         ds_put_cstr(&ds, " ");
1761         match_format(&match, &ds, OFP_DEFAULT_PRIORITY);
1762         ds_put_cstr(&ds, ", actions:");
1763         format_odp_actions(&ds, actions, actions_len);
1764
1765         VLOG_DBG_RL(&upcall_rl, "%s", ds_cstr(&ds));
1766
1767         ds_destroy(&ds);
1768     }
1769
1770     return flow;
1771 }
1772
1773 static int
1774 dpif_netdev_flow_put(struct dpif *dpif, const struct dpif_flow_put *put)
1775 {
1776     struct dp_netdev *dp = get_dp_netdev(dpif);
1777     struct dp_netdev_flow *netdev_flow;
1778     struct netdev_flow_key key;
1779     struct dp_netdev_pmd_thread *pmd;
1780     struct match match;
1781     ovs_u128 ufid;
1782     int pmd_id = put->pmd_id == PMD_ID_NULL ? NON_PMD_CORE_ID : put->pmd_id;
1783     int error;
1784
1785     error = dpif_netdev_flow_from_nlattrs(put->key, put->key_len, &match.flow);
1786     if (error) {
1787         return error;
1788     }
1789     error = dpif_netdev_mask_from_nlattrs(put->key, put->key_len,
1790                                           put->mask, put->mask_len,
1791                                           &match.flow, &match.wc.masks);
1792     if (error) {
1793         return error;
1794     }
1795
1796     pmd = dp_netdev_get_pmd(dp, pmd_id);
1797     if (!pmd) {
1798         return EINVAL;
1799     }
1800
1801     /* Must produce a netdev_flow_key for lookup.
1802      * This interface is no longer performance critical, since it is not used
1803      * for upcall processing any more. */
1804     netdev_flow_key_from_flow(&key, &match.flow);
1805
1806     if (put->ufid) {
1807         ufid = *put->ufid;
1808     } else {
1809         dpif_flow_hash(dpif, &match.flow, sizeof match.flow, &ufid);
1810     }
1811
1812     ovs_mutex_lock(&pmd->flow_mutex);
1813     netdev_flow = dp_netdev_pmd_lookup_flow(pmd, &key);
1814     if (!netdev_flow) {
1815         if (put->flags & DPIF_FP_CREATE) {
1816             if (cmap_count(&pmd->flow_table) < MAX_FLOWS) {
1817                 if (put->stats) {
1818                     memset(put->stats, 0, sizeof *put->stats);
1819                 }
1820                 dp_netdev_flow_add(pmd, &match, &ufid, put->actions,
1821                                    put->actions_len);
1822                 error = 0;
1823             } else {
1824                 error = EFBIG;
1825             }
1826         } else {
1827             error = ENOENT;
1828         }
1829     } else {
1830         if (put->flags & DPIF_FP_MODIFY
1831             && flow_equal(&match.flow, &netdev_flow->flow)) {
1832             struct dp_netdev_actions *new_actions;
1833             struct dp_netdev_actions *old_actions;
1834
1835             new_actions = dp_netdev_actions_create(put->actions,
1836                                                    put->actions_len);
1837
1838             old_actions = dp_netdev_flow_get_actions(netdev_flow);
1839             ovsrcu_set(&netdev_flow->actions, new_actions);
1840
1841             if (put->stats) {
1842                 get_dpif_flow_stats(netdev_flow, put->stats);
1843             }
1844             if (put->flags & DPIF_FP_ZERO_STATS) {
1845                 memset(&netdev_flow->stats, 0, sizeof netdev_flow->stats);
1846             }
1847
1848             ovsrcu_postpone(dp_netdev_actions_free, old_actions);
1849         } else if (put->flags & DPIF_FP_CREATE) {
1850             error = EEXIST;
1851         } else {
1852             /* Overlapping flow. */
1853             error = EINVAL;
1854         }
1855     }
1856     ovs_mutex_unlock(&pmd->flow_mutex);
1857     dp_netdev_pmd_unref(pmd);
1858
1859     return error;
1860 }
1861
1862 static int
1863 dpif_netdev_flow_del(struct dpif *dpif, const struct dpif_flow_del *del)
1864 {
1865     struct dp_netdev *dp = get_dp_netdev(dpif);
1866     struct dp_netdev_flow *netdev_flow;
1867     struct dp_netdev_pmd_thread *pmd;
1868     int pmd_id = del->pmd_id == PMD_ID_NULL ? NON_PMD_CORE_ID : del->pmd_id;
1869     int error = 0;
1870
1871     pmd = dp_netdev_get_pmd(dp, pmd_id);
1872     if (!pmd) {
1873         return EINVAL;
1874     }
1875
1876     ovs_mutex_lock(&pmd->flow_mutex);
1877     netdev_flow = dp_netdev_pmd_find_flow(pmd, del->ufid, del->key,
1878                                           del->key_len);
1879     if (netdev_flow) {
1880         if (del->stats) {
1881             get_dpif_flow_stats(netdev_flow, del->stats);
1882         }
1883         dp_netdev_pmd_remove_flow(pmd, netdev_flow);
1884     } else {
1885         error = ENOENT;
1886     }
1887     ovs_mutex_unlock(&pmd->flow_mutex);
1888     dp_netdev_pmd_unref(pmd);
1889
1890     return error;
1891 }
1892
1893 struct dpif_netdev_flow_dump {
1894     struct dpif_flow_dump up;
1895     struct cmap_position poll_thread_pos;
1896     struct cmap_position flow_pos;
1897     struct dp_netdev_pmd_thread *cur_pmd;
1898     int status;
1899     struct ovs_mutex mutex;
1900 };
1901
1902 static struct dpif_netdev_flow_dump *
1903 dpif_netdev_flow_dump_cast(struct dpif_flow_dump *dump)
1904 {
1905     return CONTAINER_OF(dump, struct dpif_netdev_flow_dump, up);
1906 }
1907
1908 static struct dpif_flow_dump *
1909 dpif_netdev_flow_dump_create(const struct dpif *dpif_, bool terse)
1910 {
1911     struct dpif_netdev_flow_dump *dump;
1912
1913     dump = xzalloc(sizeof *dump);
1914     dpif_flow_dump_init(&dump->up, dpif_);
1915     dump->up.terse = terse;
1916     ovs_mutex_init(&dump->mutex);
1917
1918     return &dump->up;
1919 }
1920
1921 static int
1922 dpif_netdev_flow_dump_destroy(struct dpif_flow_dump *dump_)
1923 {
1924     struct dpif_netdev_flow_dump *dump = dpif_netdev_flow_dump_cast(dump_);
1925
1926     ovs_mutex_destroy(&dump->mutex);
1927     free(dump);
1928     return 0;
1929 }
1930
1931 struct dpif_netdev_flow_dump_thread {
1932     struct dpif_flow_dump_thread up;
1933     struct dpif_netdev_flow_dump *dump;
1934     struct odputil_keybuf keybuf[FLOW_DUMP_MAX_BATCH];
1935     struct odputil_keybuf maskbuf[FLOW_DUMP_MAX_BATCH];
1936 };
1937
1938 static struct dpif_netdev_flow_dump_thread *
1939 dpif_netdev_flow_dump_thread_cast(struct dpif_flow_dump_thread *thread)
1940 {
1941     return CONTAINER_OF(thread, struct dpif_netdev_flow_dump_thread, up);
1942 }
1943
1944 static struct dpif_flow_dump_thread *
1945 dpif_netdev_flow_dump_thread_create(struct dpif_flow_dump *dump_)
1946 {
1947     struct dpif_netdev_flow_dump *dump = dpif_netdev_flow_dump_cast(dump_);
1948     struct dpif_netdev_flow_dump_thread *thread;
1949
1950     thread = xmalloc(sizeof *thread);
1951     dpif_flow_dump_thread_init(&thread->up, &dump->up);
1952     thread->dump = dump;
1953     return &thread->up;
1954 }
1955
1956 static void
1957 dpif_netdev_flow_dump_thread_destroy(struct dpif_flow_dump_thread *thread_)
1958 {
1959     struct dpif_netdev_flow_dump_thread *thread
1960         = dpif_netdev_flow_dump_thread_cast(thread_);
1961
1962     free(thread);
1963 }
1964
1965 static int
1966 dpif_netdev_flow_dump_next(struct dpif_flow_dump_thread *thread_,
1967                            struct dpif_flow *flows, int max_flows)
1968 {
1969     struct dpif_netdev_flow_dump_thread *thread
1970         = dpif_netdev_flow_dump_thread_cast(thread_);
1971     struct dpif_netdev_flow_dump *dump = thread->dump;
1972     struct dp_netdev_flow *netdev_flows[FLOW_DUMP_MAX_BATCH];
1973     int n_flows = 0;
1974     int i;
1975
1976     ovs_mutex_lock(&dump->mutex);
1977     if (!dump->status) {
1978         struct dpif_netdev *dpif = dpif_netdev_cast(thread->up.dpif);
1979         struct dp_netdev *dp = get_dp_netdev(&dpif->dpif);
1980         struct dp_netdev_pmd_thread *pmd = dump->cur_pmd;
1981         int flow_limit = MIN(max_flows, FLOW_DUMP_MAX_BATCH);
1982
1983         /* First call to dump_next(), extracts the first pmd thread.
1984          * If there is no pmd thread, returns immediately. */
1985         if (!pmd) {
1986             pmd = dp_netdev_pmd_get_next(dp, &dump->poll_thread_pos);
1987             if (!pmd) {
1988                 ovs_mutex_unlock(&dump->mutex);
1989                 return n_flows;
1990
1991             }
1992         }
1993
1994         do {
1995             for (n_flows = 0; n_flows < flow_limit; n_flows++) {
1996                 struct cmap_node *node;
1997
1998                 node = cmap_next_position(&pmd->flow_table, &dump->flow_pos);
1999                 if (!node) {
2000                     break;
2001                 }
2002                 netdev_flows[n_flows] = CONTAINER_OF(node,
2003                                                      struct dp_netdev_flow,
2004                                                      node);
2005             }
2006             /* When finishing dumping the current pmd thread, moves to
2007              * the next. */
2008             if (n_flows < flow_limit) {
2009                 memset(&dump->flow_pos, 0, sizeof dump->flow_pos);
2010                 dp_netdev_pmd_unref(pmd);
2011                 pmd = dp_netdev_pmd_get_next(dp, &dump->poll_thread_pos);
2012                 if (!pmd) {
2013                     dump->status = EOF;
2014                     break;
2015                 }
2016             }
2017             /* Keeps the reference to next caller. */
2018             dump->cur_pmd = pmd;
2019
2020             /* If the current dump is empty, do not exit the loop, since the
2021              * remaining pmds could have flows to be dumped.  Just dumps again
2022              * on the new 'pmd'. */
2023         } while (!n_flows);
2024     }
2025     ovs_mutex_unlock(&dump->mutex);
2026
2027     for (i = 0; i < n_flows; i++) {
2028         struct odputil_keybuf *maskbuf = &thread->maskbuf[i];
2029         struct odputil_keybuf *keybuf = &thread->keybuf[i];
2030         struct dp_netdev_flow *netdev_flow = netdev_flows[i];
2031         struct dpif_flow *f = &flows[i];
2032         struct ofpbuf key, mask;
2033
2034         ofpbuf_use_stack(&key, keybuf, sizeof *keybuf);
2035         ofpbuf_use_stack(&mask, maskbuf, sizeof *maskbuf);
2036         dp_netdev_flow_to_dpif_flow(netdev_flow, &key, &mask, f,
2037                                     dump->up.terse);
2038     }
2039
2040     return n_flows;
2041 }
2042
2043 static int
2044 dpif_netdev_execute(struct dpif *dpif, struct dpif_execute *execute)
2045     OVS_NO_THREAD_SAFETY_ANALYSIS
2046 {
2047     struct dp_netdev *dp = get_dp_netdev(dpif);
2048     struct dp_netdev_pmd_thread *pmd;
2049     struct dpif_packet packet, *pp;
2050
2051     if (ofpbuf_size(execute->packet) < ETH_HEADER_LEN ||
2052         ofpbuf_size(execute->packet) > UINT16_MAX) {
2053         return EINVAL;
2054     }
2055
2056     packet.ofpbuf = *execute->packet;
2057     packet.md = execute->md;
2058     pp = &packet;
2059
2060     /* Tries finding the 'pmd'.  If NULL is returned, that means
2061      * the current thread is a non-pmd thread and should use
2062      * dp_netdev_get_pmd(dp, NON_PMD_CORE_ID). */
2063     pmd = ovsthread_getspecific(dp->per_pmd_key);
2064     if (!pmd) {
2065         pmd = dp_netdev_get_pmd(dp, NON_PMD_CORE_ID);
2066     }
2067
2068     /* If the current thread is non-pmd thread, acquires
2069      * the 'non_pmd_mutex'. */
2070     if (pmd->core_id == NON_PMD_CORE_ID) {
2071         ovs_mutex_lock(&dp->non_pmd_mutex);
2072         ovs_mutex_lock(&dp->port_mutex);
2073     }
2074
2075     dp_netdev_execute_actions(pmd, &pp, 1, false, execute->actions,
2076                               execute->actions_len);
2077     if (pmd->core_id == NON_PMD_CORE_ID) {
2078         dp_netdev_pmd_unref(pmd);
2079         ovs_mutex_unlock(&dp->port_mutex);
2080         ovs_mutex_unlock(&dp->non_pmd_mutex);
2081     }
2082
2083     /* Even though may_steal is set to false, some actions could modify or
2084      * reallocate the ofpbuf memory. We need to pass those changes to the
2085      * caller */
2086     *execute->packet = packet.ofpbuf;
2087     execute->md = packet.md;
2088     return 0;
2089 }
2090
2091 static void
2092 dpif_netdev_operate(struct dpif *dpif, struct dpif_op **ops, size_t n_ops)
2093 {
2094     size_t i;
2095
2096     for (i = 0; i < n_ops; i++) {
2097         struct dpif_op *op = ops[i];
2098
2099         switch (op->type) {
2100         case DPIF_OP_FLOW_PUT:
2101             op->error = dpif_netdev_flow_put(dpif, &op->u.flow_put);
2102             break;
2103
2104         case DPIF_OP_FLOW_DEL:
2105             op->error = dpif_netdev_flow_del(dpif, &op->u.flow_del);
2106             break;
2107
2108         case DPIF_OP_EXECUTE:
2109             op->error = dpif_netdev_execute(dpif, &op->u.execute);
2110             break;
2111
2112         case DPIF_OP_FLOW_GET:
2113             op->error = dpif_netdev_flow_get(dpif, &op->u.flow_get);
2114             break;
2115         }
2116     }
2117 }
2118
2119 /* Returns true if the configuration for rx queues or cpu mask
2120  * is changed. */
2121 static bool
2122 pmd_config_changed(const struct dp_netdev *dp, size_t rxqs, const char *cmask)
2123 {
2124     if (dp->n_dpdk_rxqs != rxqs) {
2125         return true;
2126     } else {
2127         if (dp->pmd_cmask != NULL && cmask != NULL) {
2128             return strcmp(dp->pmd_cmask, cmask);
2129         } else {
2130             return (dp->pmd_cmask != NULL || cmask != NULL);
2131         }
2132     }
2133 }
2134
2135 /* Resets pmd threads if the configuration for 'rxq's or cpu mask changes. */
2136 static int
2137 dpif_netdev_pmd_set(struct dpif *dpif, unsigned int n_rxqs, const char *cmask)
2138 {
2139     struct dp_netdev *dp = get_dp_netdev(dpif);
2140
2141     if (pmd_config_changed(dp, n_rxqs, cmask)) {
2142         struct dp_netdev_port *port;
2143
2144         dp_netdev_destroy_all_pmds(dp);
2145
2146         CMAP_FOR_EACH (port, node, &dp->ports) {
2147             if (netdev_is_pmd(port->netdev)) {
2148                 int i, err;
2149
2150                 /* Closes the existing 'rxq's. */
2151                 for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
2152                     netdev_rxq_close(port->rxq[i]);
2153                     port->rxq[i] = NULL;
2154                 }
2155
2156                 /* Sets the new rx queue config.  */
2157                 err = netdev_set_multiq(port->netdev, ovs_numa_get_n_cores(),
2158                                         n_rxqs);
2159                 if (err && (err != EOPNOTSUPP)) {
2160                     VLOG_ERR("Failed to set dpdk interface %s rx_queue to:"
2161                              " %u", netdev_get_name(port->netdev),
2162                              n_rxqs);
2163                     return err;
2164                 }
2165
2166                 /* If the set_multiq() above succeeds, reopens the 'rxq's. */
2167                 port->rxq = xrealloc(port->rxq, sizeof *port->rxq
2168                                      * netdev_n_rxq(port->netdev));
2169                 for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
2170                     netdev_rxq_open(port->netdev, &port->rxq[i], i);
2171                 }
2172             }
2173         }
2174         dp->n_dpdk_rxqs = n_rxqs;
2175
2176         /* Reconfigures the cpu mask. */
2177         ovs_numa_set_cpu_mask(cmask);
2178         free(dp->pmd_cmask);
2179         dp->pmd_cmask = cmask ? xstrdup(cmask) : NULL;
2180
2181         /* Restores the non-pmd. */
2182         dp_netdev_set_nonpmd(dp);
2183         /* Restores all pmd threads. */
2184         dp_netdev_reset_pmd_threads(dp);
2185     }
2186
2187     return 0;
2188 }
2189
2190 static int
2191 dpif_netdev_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
2192                               uint32_t queue_id, uint32_t *priority)
2193 {
2194     *priority = queue_id;
2195     return 0;
2196 }
2197
2198 \f
2199 /* Creates and returns a new 'struct dp_netdev_actions', with a reference count
2200  * of 1, whose actions are a copy of from the 'ofpacts_len' bytes of
2201  * 'ofpacts'. */
2202 struct dp_netdev_actions *
2203 dp_netdev_actions_create(const struct nlattr *actions, size_t size)
2204 {
2205     struct dp_netdev_actions *netdev_actions;
2206
2207     netdev_actions = xmalloc(sizeof *netdev_actions);
2208     netdev_actions->actions = xmemdup(actions, size);
2209     netdev_actions->size = size;
2210
2211     return netdev_actions;
2212 }
2213
2214 struct dp_netdev_actions *
2215 dp_netdev_flow_get_actions(const struct dp_netdev_flow *flow)
2216 {
2217     return ovsrcu_get(struct dp_netdev_actions *, &flow->actions);
2218 }
2219
2220 static void
2221 dp_netdev_actions_free(struct dp_netdev_actions *actions)
2222 {
2223     free(actions->actions);
2224     free(actions);
2225 }
2226 \f
2227
2228 static void
2229 dp_netdev_process_rxq_port(struct dp_netdev_pmd_thread *pmd,
2230                            struct dp_netdev_port *port,
2231                            struct netdev_rxq *rxq)
2232 {
2233     struct dpif_packet *packets[NETDEV_MAX_RX_BATCH];
2234     int error, cnt;
2235
2236     error = netdev_rxq_recv(rxq, packets, &cnt);
2237     if (!error) {
2238         int i;
2239
2240         *recirc_depth_get() = 0;
2241
2242         /* XXX: initialize md in netdev implementation. */
2243         for (i = 0; i < cnt; i++) {
2244             packets[i]->md = PKT_METADATA_INITIALIZER(port->port_no);
2245         }
2246         dp_netdev_input(pmd, packets, cnt);
2247     } else if (error != EAGAIN && error != EOPNOTSUPP) {
2248         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2249
2250         VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
2251                     netdev_get_name(port->netdev), ovs_strerror(error));
2252     }
2253 }
2254
2255 /* Return true if needs to revalidate datapath flows. */
2256 static bool
2257 dpif_netdev_run(struct dpif *dpif)
2258 {
2259     struct dp_netdev_port *port;
2260     struct dp_netdev *dp = get_dp_netdev(dpif);
2261     struct dp_netdev_pmd_thread *non_pmd = dp_netdev_get_pmd(dp,
2262                                                              NON_PMD_CORE_ID);
2263     uint64_t new_tnl_seq;
2264
2265     ovs_mutex_lock(&dp->non_pmd_mutex);
2266     CMAP_FOR_EACH (port, node, &dp->ports) {
2267         if (!netdev_is_pmd(port->netdev)) {
2268             int i;
2269
2270             for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
2271                 dp_netdev_process_rxq_port(non_pmd, port, port->rxq[i]);
2272             }
2273         }
2274     }
2275     ovs_mutex_unlock(&dp->non_pmd_mutex);
2276     dp_netdev_pmd_unref(non_pmd);
2277
2278     tnl_arp_cache_run();
2279     new_tnl_seq = seq_read(tnl_conf_seq);
2280
2281     if (dp->last_tnl_conf_seq != new_tnl_seq) {
2282         dp->last_tnl_conf_seq = new_tnl_seq;
2283         return true;
2284     }
2285     return false;
2286 }
2287
2288 static void
2289 dpif_netdev_wait(struct dpif *dpif)
2290 {
2291     struct dp_netdev_port *port;
2292     struct dp_netdev *dp = get_dp_netdev(dpif);
2293
2294     ovs_mutex_lock(&dp_netdev_mutex);
2295     CMAP_FOR_EACH (port, node, &dp->ports) {
2296         if (!netdev_is_pmd(port->netdev)) {
2297             int i;
2298
2299             for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
2300                 netdev_rxq_wait(port->rxq[i]);
2301             }
2302         }
2303     }
2304     ovs_mutex_unlock(&dp_netdev_mutex);
2305     seq_wait(tnl_conf_seq, dp->last_tnl_conf_seq);
2306 }
2307
2308 struct rxq_poll {
2309     struct dp_netdev_port *port;
2310     struct netdev_rxq *rx;
2311 };
2312
2313 static int
2314 pmd_load_queues(struct dp_netdev_pmd_thread *pmd,
2315                 struct rxq_poll **ppoll_list, int poll_cnt)
2316 {
2317     struct rxq_poll *poll_list = *ppoll_list;
2318     struct dp_netdev_port *port;
2319     int n_pmds_on_numa, index, i;
2320
2321     /* Simple scheduler for netdev rx polling. */
2322     for (i = 0; i < poll_cnt; i++) {
2323         port_unref(poll_list[i].port);
2324     }
2325
2326     poll_cnt = 0;
2327     n_pmds_on_numa = get_n_pmd_threads_on_numa(pmd->dp, pmd->numa_id);
2328     index = 0;
2329
2330     CMAP_FOR_EACH (port, node, &pmd->dp->ports) {
2331         /* Calls port_try_ref() to prevent the main thread
2332          * from deleting the port. */
2333         if (port_try_ref(port)) {
2334             if (netdev_is_pmd(port->netdev)
2335                 && netdev_get_numa_id(port->netdev) == pmd->numa_id) {
2336                 int i;
2337
2338                 for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
2339                     if ((index % n_pmds_on_numa) == pmd->index) {
2340                         poll_list = xrealloc(poll_list,
2341                                         sizeof *poll_list * (poll_cnt + 1));
2342
2343                         port_ref(port);
2344                         poll_list[poll_cnt].port = port;
2345                         poll_list[poll_cnt].rx = port->rxq[i];
2346                         poll_cnt++;
2347                     }
2348                     index++;
2349                 }
2350             }
2351             /* Unrefs the port_try_ref(). */
2352             port_unref(port);
2353         }
2354     }
2355
2356     *ppoll_list = poll_list;
2357     return poll_cnt;
2358 }
2359
2360 static void *
2361 pmd_thread_main(void *f_)
2362 {
2363     struct dp_netdev_pmd_thread *pmd = f_;
2364     unsigned int lc = 0;
2365     struct rxq_poll *poll_list;
2366     unsigned int port_seq = PMD_INITIAL_SEQ;
2367     int poll_cnt;
2368     int i;
2369
2370     poll_cnt = 0;
2371     poll_list = NULL;
2372
2373     /* Stores the pmd thread's 'pmd' to 'per_pmd_key'. */
2374     ovsthread_setspecific(pmd->dp->per_pmd_key, pmd);
2375     pmd_thread_setaffinity_cpu(pmd->core_id);
2376 reload:
2377     emc_cache_init(&pmd->flow_cache);
2378     poll_cnt = pmd_load_queues(pmd, &poll_list, poll_cnt);
2379
2380     /* Signal here to make sure the pmd finishes
2381      * reloading the updated configuration. */
2382     dp_netdev_pmd_reload_done(pmd);
2383
2384     for (;;) {
2385         int i;
2386
2387         for (i = 0; i < poll_cnt; i++) {
2388             dp_netdev_process_rxq_port(pmd, poll_list[i].port, poll_list[i].rx);
2389         }
2390
2391         if (lc++ > 1024) {
2392             unsigned int seq;
2393
2394             lc = 0;
2395
2396             emc_cache_slow_sweep(&pmd->flow_cache);
2397             ovsrcu_quiesce();
2398
2399             atomic_read_relaxed(&pmd->change_seq, &seq);
2400             if (seq != port_seq) {
2401                 port_seq = seq;
2402                 break;
2403             }
2404         }
2405     }
2406
2407     emc_cache_uninit(&pmd->flow_cache);
2408
2409     if (!latch_is_set(&pmd->exit_latch)){
2410         goto reload;
2411     }
2412
2413     for (i = 0; i < poll_cnt; i++) {
2414          port_unref(poll_list[i].port);
2415     }
2416
2417     dp_netdev_pmd_reload_done(pmd);
2418
2419     free(poll_list);
2420     return NULL;
2421 }
2422
2423 static void
2424 dp_netdev_disable_upcall(struct dp_netdev *dp)
2425     OVS_ACQUIRES(dp->upcall_rwlock)
2426 {
2427     fat_rwlock_wrlock(&dp->upcall_rwlock);
2428 }
2429
2430 static void
2431 dpif_netdev_disable_upcall(struct dpif *dpif)
2432     OVS_NO_THREAD_SAFETY_ANALYSIS
2433 {
2434     struct dp_netdev *dp = get_dp_netdev(dpif);
2435     dp_netdev_disable_upcall(dp);
2436 }
2437
2438 static void
2439 dp_netdev_enable_upcall(struct dp_netdev *dp)
2440     OVS_RELEASES(dp->upcall_rwlock)
2441 {
2442     fat_rwlock_unlock(&dp->upcall_rwlock);
2443 }
2444
2445 static void
2446 dpif_netdev_enable_upcall(struct dpif *dpif)
2447     OVS_NO_THREAD_SAFETY_ANALYSIS
2448 {
2449     struct dp_netdev *dp = get_dp_netdev(dpif);
2450     dp_netdev_enable_upcall(dp);
2451 }
2452
2453 void
2454 dp_netdev_pmd_reload_done(struct dp_netdev_pmd_thread *pmd)
2455 {
2456     ovs_mutex_lock(&pmd->cond_mutex);
2457     xpthread_cond_signal(&pmd->cond);
2458     ovs_mutex_unlock(&pmd->cond_mutex);
2459 }
2460
2461 /* Finds and refs the dp_netdev_pmd_thread on core 'core_id'.  Returns
2462  * the pointer if succeeds, otherwise, NULL.
2463  *
2464  * Caller must unrefs the returned reference.  */
2465 static struct dp_netdev_pmd_thread *
2466 dp_netdev_get_pmd(struct dp_netdev *dp, int core_id)
2467 {
2468     struct dp_netdev_pmd_thread *pmd;
2469     const struct cmap_node *pnode;
2470
2471     pnode = cmap_find(&dp->poll_threads, hash_int(core_id, 0));
2472     if (!pnode) {
2473         return NULL;
2474     }
2475     pmd = CONTAINER_OF(pnode, struct dp_netdev_pmd_thread, node);
2476
2477     return dp_netdev_pmd_try_ref(pmd) ? pmd : NULL;
2478 }
2479
2480 /* Sets the 'struct dp_netdev_pmd_thread' for non-pmd threads. */
2481 static void
2482 dp_netdev_set_nonpmd(struct dp_netdev *dp)
2483 {
2484     struct dp_netdev_pmd_thread *non_pmd;
2485
2486     non_pmd = xzalloc(sizeof *non_pmd);
2487     dp_netdev_configure_pmd(non_pmd, dp, 0, NON_PMD_CORE_ID,
2488                             OVS_NUMA_UNSPEC);
2489 }
2490
2491 /* Caller must have valid pointer to 'pmd'. */
2492 static bool
2493 dp_netdev_pmd_try_ref(struct dp_netdev_pmd_thread *pmd)
2494 {
2495     return ovs_refcount_try_ref_rcu(&pmd->ref_cnt);
2496 }
2497
2498 static void
2499 dp_netdev_pmd_unref(struct dp_netdev_pmd_thread *pmd)
2500 {
2501     if (pmd && ovs_refcount_unref(&pmd->ref_cnt) == 1) {
2502         ovsrcu_postpone(dp_netdev_destroy_pmd, pmd);
2503     }
2504 }
2505
2506 /* Given cmap position 'pos', tries to ref the next node.  If try_ref()
2507  * fails, keeps checking for next node until reaching the end of cmap.
2508  *
2509  * Caller must unrefs the returned reference. */
2510 static struct dp_netdev_pmd_thread *
2511 dp_netdev_pmd_get_next(struct dp_netdev *dp, struct cmap_position *pos)
2512 {
2513     struct dp_netdev_pmd_thread *next;
2514
2515     do {
2516         struct cmap_node *node;
2517
2518         node = cmap_next_position(&dp->poll_threads, pos);
2519         next = node ? CONTAINER_OF(node, struct dp_netdev_pmd_thread, node)
2520             : NULL;
2521     } while (next && !dp_netdev_pmd_try_ref(next));
2522
2523     return next;
2524 }
2525
2526 /* Configures the 'pmd' based on the input argument. */
2527 static void
2528 dp_netdev_configure_pmd(struct dp_netdev_pmd_thread *pmd, struct dp_netdev *dp,
2529                         int index, int core_id, int numa_id)
2530 {
2531     pmd->dp = dp;
2532     pmd->index = index;
2533     pmd->core_id = core_id;
2534     pmd->numa_id = numa_id;
2535
2536     ovs_refcount_init(&pmd->ref_cnt);
2537     latch_init(&pmd->exit_latch);
2538     atomic_init(&pmd->change_seq, PMD_INITIAL_SEQ);
2539     xpthread_cond_init(&pmd->cond, NULL);
2540     ovs_mutex_init(&pmd->cond_mutex);
2541     ovs_mutex_init(&pmd->flow_mutex);
2542     dpcls_init(&pmd->cls);
2543     cmap_init(&pmd->flow_table);
2544     /* init the 'flow_cache' since there is no
2545      * actual thread created for NON_PMD_CORE_ID. */
2546     if (core_id == NON_PMD_CORE_ID) {
2547         emc_cache_init(&pmd->flow_cache);
2548     }
2549     cmap_insert(&dp->poll_threads, CONST_CAST(struct cmap_node *, &pmd->node),
2550                 hash_int(core_id, 0));
2551 }
2552
2553 static void
2554 dp_netdev_destroy_pmd(struct dp_netdev_pmd_thread *pmd)
2555 {
2556     dp_netdev_pmd_flow_flush(pmd);
2557     dpcls_destroy(&pmd->cls);
2558     cmap_destroy(&pmd->flow_table);
2559     ovs_mutex_destroy(&pmd->flow_mutex);
2560     latch_destroy(&pmd->exit_latch);
2561     xpthread_cond_destroy(&pmd->cond);
2562     ovs_mutex_destroy(&pmd->cond_mutex);
2563     free(pmd);
2564 }
2565
2566 /* Stops the pmd thread, removes it from the 'dp->poll_threads',
2567  * and unrefs the struct. */
2568 static void
2569 dp_netdev_del_pmd(struct dp_netdev_pmd_thread *pmd)
2570 {
2571     /* Uninit the 'flow_cache' since there is
2572      * no actual thread uninit it for NON_PMD_CORE_ID. */
2573     if (pmd->core_id == NON_PMD_CORE_ID) {
2574         emc_cache_uninit(&pmd->flow_cache);
2575     } else {
2576         latch_set(&pmd->exit_latch);
2577         dp_netdev_reload_pmd__(pmd);
2578         ovs_numa_unpin_core(pmd->core_id);
2579         xpthread_join(pmd->thread, NULL);
2580     }
2581     cmap_remove(&pmd->dp->poll_threads, &pmd->node, hash_int(pmd->core_id, 0));
2582     dp_netdev_pmd_unref(pmd);
2583 }
2584
2585 /* Destroys all pmd threads. */
2586 static void
2587 dp_netdev_destroy_all_pmds(struct dp_netdev *dp)
2588 {
2589     struct dp_netdev_pmd_thread *pmd;
2590
2591     CMAP_FOR_EACH (pmd, node, &dp->poll_threads) {
2592         dp_netdev_del_pmd(pmd);
2593     }
2594 }
2595
2596 /* Deletes all pmd threads on numa node 'numa_id'. */
2597 static void
2598 dp_netdev_del_pmds_on_numa(struct dp_netdev *dp, int numa_id)
2599 {
2600     struct dp_netdev_pmd_thread *pmd;
2601
2602     CMAP_FOR_EACH (pmd, node, &dp->poll_threads) {
2603         if (pmd->numa_id == numa_id) {
2604             dp_netdev_del_pmd(pmd);
2605         }
2606     }
2607 }
2608
2609 /* Checks the numa node id of 'netdev' and starts pmd threads for
2610  * the numa node. */
2611 static void
2612 dp_netdev_set_pmds_on_numa(struct dp_netdev *dp, int numa_id)
2613 {
2614     int n_pmds;
2615
2616     if (!ovs_numa_numa_id_is_valid(numa_id)) {
2617         VLOG_ERR("Cannot create pmd threads due to numa id (%d)"
2618                  "invalid", numa_id);
2619         return ;
2620     }
2621
2622     n_pmds = get_n_pmd_threads_on_numa(dp, numa_id);
2623
2624     /* If there are already pmd threads created for the numa node
2625      * in which 'netdev' is on, do nothing.  Else, creates the
2626      * pmd threads for the numa node. */
2627     if (!n_pmds) {
2628         int can_have, n_unpinned, i;
2629
2630         n_unpinned = ovs_numa_get_n_unpinned_cores_on_numa(numa_id);
2631         if (!n_unpinned) {
2632             VLOG_ERR("Cannot create pmd threads due to out of unpinned "
2633                      "cores on numa node");
2634             return;
2635         }
2636
2637         /* If cpu mask is specified, uses all unpinned cores, otherwise
2638          * tries creating NR_PMD_THREADS pmd threads. */
2639         can_have = dp->pmd_cmask ? n_unpinned : MIN(n_unpinned, NR_PMD_THREADS);
2640         for (i = 0; i < can_have; i++) {
2641             struct dp_netdev_pmd_thread *pmd = xzalloc(sizeof *pmd);
2642             int core_id = ovs_numa_get_unpinned_core_on_numa(numa_id);
2643
2644             dp_netdev_configure_pmd(pmd, dp, i, core_id, numa_id);
2645             /* Each thread will distribute all devices rx-queues among
2646              * themselves. */
2647             pmd->thread = ovs_thread_create("pmd", pmd_thread_main, pmd);
2648         }
2649         VLOG_INFO("Created %d pmd threads on numa node %d", can_have, numa_id);
2650     }
2651 }
2652
2653 \f
2654 /* Called after pmd threads config change.  Restarts pmd threads with
2655  * new configuration. */
2656 static void
2657 dp_netdev_reset_pmd_threads(struct dp_netdev *dp)
2658 {
2659     struct dp_netdev_port *port;
2660
2661     CMAP_FOR_EACH (port, node, &dp->ports) {
2662         if (netdev_is_pmd(port->netdev)) {
2663             int numa_id = netdev_get_numa_id(port->netdev);
2664
2665             dp_netdev_set_pmds_on_numa(dp, numa_id);
2666         }
2667     }
2668 }
2669
2670 static char *
2671 dpif_netdev_get_datapath_version(void)
2672 {
2673      return xstrdup("<built-in>");
2674 }
2675
2676 static void
2677 dp_netdev_flow_used(struct dp_netdev_flow *netdev_flow, int cnt, int size,
2678                     uint16_t tcp_flags)
2679 {
2680     long long int now = time_msec();
2681
2682     netdev_flow->stats.used = MAX(now, netdev_flow->stats.used);
2683     netdev_flow->stats.packet_count += cnt;
2684     netdev_flow->stats.byte_count += size;
2685     netdev_flow->stats.tcp_flags |= tcp_flags;
2686 }
2687
2688 static void
2689 dp_netdev_count_packet(struct dp_netdev_pmd_thread *pmd,
2690                        enum dp_stat_type type, int cnt)
2691 {
2692     pmd->stats.n[type] += cnt;
2693 }
2694
2695 static int
2696 dp_netdev_upcall(struct dp_netdev_pmd_thread *pmd, struct dpif_packet *packet_,
2697                  struct flow *flow, struct flow_wildcards *wc, ovs_u128 *ufid,
2698                  enum dpif_upcall_type type, const struct nlattr *userdata,
2699                  struct ofpbuf *actions, struct ofpbuf *put_actions)
2700 {
2701     struct dp_netdev *dp = pmd->dp;
2702     struct ofpbuf *packet = &packet_->ofpbuf;
2703
2704     if (type == DPIF_UC_MISS) {
2705         dp_netdev_count_packet(pmd, DP_STAT_MISS, 1);
2706     }
2707
2708     if (OVS_UNLIKELY(!dp->upcall_cb)) {
2709         return ENODEV;
2710     }
2711
2712     if (OVS_UNLIKELY(!VLOG_DROP_DBG(&upcall_rl))) {
2713         struct ds ds = DS_EMPTY_INITIALIZER;
2714         struct ofpbuf key;
2715         char *packet_str;
2716
2717         ofpbuf_init(&key, 0);
2718         odp_flow_key_from_flow(&key, flow, &wc->masks, flow->in_port.odp_port,
2719                                true);
2720
2721         packet_str = ofp_packet_to_string(ofpbuf_data(packet),
2722                                           ofpbuf_size(packet));
2723
2724         odp_flow_key_format(ofpbuf_data(&key), ofpbuf_size(&key), &ds);
2725
2726         VLOG_DBG("%s: %s upcall:\n%s\n%s", dp->name,
2727                  dpif_upcall_type_to_string(type), ds_cstr(&ds), packet_str);
2728
2729         ofpbuf_uninit(&key);
2730         free(packet_str);
2731         ds_destroy(&ds);
2732     }
2733
2734     return dp->upcall_cb(packet, flow, ufid, pmd->core_id, type, userdata,
2735                          actions, wc, put_actions, dp->upcall_aux);
2736 }
2737
2738 static inline uint32_t
2739 dpif_netdev_packet_get_dp_hash(struct dpif_packet *packet,
2740                                const struct miniflow *mf)
2741 {
2742     uint32_t hash;
2743
2744     hash = dpif_packet_get_dp_hash(packet);
2745     if (OVS_UNLIKELY(!hash)) {
2746         hash = miniflow_hash_5tuple(mf, 0);
2747         dpif_packet_set_dp_hash(packet, hash);
2748     }
2749     return hash;
2750 }
2751
2752 struct packet_batch {
2753     unsigned int packet_count;
2754     unsigned int byte_count;
2755     uint16_t tcp_flags;
2756
2757     struct dp_netdev_flow *flow;
2758
2759     struct dpif_packet *packets[NETDEV_MAX_RX_BATCH];
2760 };
2761
2762 static inline void
2763 packet_batch_update(struct packet_batch *batch, struct dpif_packet *packet,
2764                     const struct miniflow *mf)
2765 {
2766     batch->tcp_flags |= miniflow_get_tcp_flags(mf);
2767     batch->packets[batch->packet_count++] = packet;
2768     batch->byte_count += ofpbuf_size(&packet->ofpbuf);
2769 }
2770
2771 static inline void
2772 packet_batch_init(struct packet_batch *batch, struct dp_netdev_flow *flow)
2773 {
2774     batch->flow = flow;
2775
2776     batch->packet_count = 0;
2777     batch->byte_count = 0;
2778     batch->tcp_flags = 0;
2779 }
2780
2781 static inline void
2782 packet_batch_execute(struct packet_batch *batch,
2783                      struct dp_netdev_pmd_thread *pmd)
2784 {
2785     struct dp_netdev_actions *actions;
2786     struct dp_netdev_flow *flow = batch->flow;
2787
2788     dp_netdev_flow_used(batch->flow, batch->packet_count, batch->byte_count,
2789                         batch->tcp_flags);
2790
2791     actions = dp_netdev_flow_get_actions(flow);
2792
2793     dp_netdev_execute_actions(pmd, batch->packets, batch->packet_count, true,
2794                               actions->actions, actions->size);
2795
2796     dp_netdev_count_packet(pmd, DP_STAT_HIT, batch->packet_count);
2797 }
2798
2799 static inline bool
2800 dp_netdev_queue_batches(struct dpif_packet *pkt,
2801                         struct dp_netdev_flow *flow, const struct miniflow *mf,
2802                         struct packet_batch *batches, size_t *n_batches,
2803                         size_t max_batches)
2804 {
2805     struct packet_batch *batch = NULL;
2806     int j;
2807
2808     if (OVS_UNLIKELY(!flow)) {
2809         return false;
2810     }
2811     /* XXX: This O(n^2) algortihm makes sense if we're operating under the
2812      * assumption that the number of distinct flows (and therefore the
2813      * number of distinct batches) is quite small.  If this turns out not
2814      * to be the case, it may make sense to pre sort based on the
2815      * netdev_flow pointer.  That done we can get the appropriate batching
2816      * in O(n * log(n)) instead. */
2817     for (j = *n_batches - 1; j >= 0; j--) {
2818         if (batches[j].flow == flow) {
2819             batch = &batches[j];
2820             packet_batch_update(batch, pkt, mf);
2821             return true;
2822         }
2823     }
2824     if (OVS_UNLIKELY(*n_batches >= max_batches)) {
2825         return false;
2826     }
2827
2828     batch = &batches[(*n_batches)++];
2829     packet_batch_init(batch, flow);
2830     packet_batch_update(batch, pkt, mf);
2831     return true;
2832 }
2833
2834 static inline void
2835 dpif_packet_swap(struct dpif_packet **a, struct dpif_packet **b)
2836 {
2837     struct dpif_packet *tmp = *a;
2838     *a = *b;
2839     *b = tmp;
2840 }
2841
2842 /* Try to process all ('cnt') the 'packets' using only the exact match cache
2843  * 'flow_cache'. If a flow is not found for a packet 'packets[i]', or if there
2844  * is no matching batch for a packet's flow, the miniflow is copied into 'keys'
2845  * and the packet pointer is moved at the beginning of the 'packets' array.
2846  *
2847  * The function returns the number of packets that needs to be processed in the
2848  * 'packets' array (they have been moved to the beginning of the vector).
2849  */
2850 static inline size_t
2851 emc_processing(struct dp_netdev_pmd_thread *pmd, struct dpif_packet **packets,
2852                size_t cnt, struct netdev_flow_key *keys)
2853 {
2854     struct netdev_flow_key key;
2855     struct packet_batch batches[4];
2856     struct emc_cache *flow_cache = &pmd->flow_cache;
2857     size_t n_batches, i;
2858     size_t notfound_cnt = 0;
2859
2860     n_batches = 0;
2861     miniflow_initialize(&key.mf, key.buf);
2862     for (i = 0; i < cnt; i++) {
2863         struct dp_netdev_flow *flow;
2864
2865         if (OVS_UNLIKELY(ofpbuf_size(&packets[i]->ofpbuf) < ETH_HEADER_LEN)) {
2866             dpif_packet_delete(packets[i]);
2867             continue;
2868         }
2869
2870         miniflow_extract(&packets[i]->ofpbuf, &packets[i]->md, &key.mf);
2871         key.len = 0; /* Not computed yet. */
2872         key.hash = dpif_netdev_packet_get_dp_hash(packets[i], &key.mf);
2873
2874         flow = emc_lookup(flow_cache, &key);
2875         if (OVS_UNLIKELY(!dp_netdev_queue_batches(packets[i], flow, &key.mf,
2876                                                   batches, &n_batches,
2877                                                   ARRAY_SIZE(batches)))) {
2878             if (i != notfound_cnt) {
2879                 dpif_packet_swap(&packets[i], &packets[notfound_cnt]);
2880             }
2881
2882             keys[notfound_cnt++] = key;
2883         }
2884     }
2885
2886     for (i = 0; i < n_batches; i++) {
2887         packet_batch_execute(&batches[i], pmd);
2888     }
2889
2890     return notfound_cnt;
2891 }
2892
2893 static inline void
2894 fast_path_processing(struct dp_netdev_pmd_thread *pmd,
2895                      struct dpif_packet **packets, size_t cnt,
2896                      struct netdev_flow_key *keys)
2897 {
2898 #if !defined(__CHECKER__) && !defined(_WIN32)
2899     const size_t PKT_ARRAY_SIZE = cnt;
2900 #else
2901     /* Sparse or MSVC doesn't like variable length array. */
2902     enum { PKT_ARRAY_SIZE = NETDEV_MAX_RX_BATCH };
2903 #endif
2904     struct packet_batch batches[PKT_ARRAY_SIZE];
2905     struct dpcls_rule *rules[PKT_ARRAY_SIZE];
2906     struct dp_netdev *dp = pmd->dp;
2907     struct emc_cache *flow_cache = &pmd->flow_cache;
2908     size_t n_batches, i;
2909     bool any_miss;
2910
2911     for (i = 0; i < cnt; i++) {
2912         /* Key length is needed in all the cases, hash computed on demand. */
2913         keys[i].len = netdev_flow_key_size(count_1bits(keys[i].mf.map));
2914     }
2915     any_miss = !dpcls_lookup(&pmd->cls, keys, rules, cnt);
2916     if (OVS_UNLIKELY(any_miss) && !fat_rwlock_tryrdlock(&dp->upcall_rwlock)) {
2917         uint64_t actions_stub[512 / 8], slow_stub[512 / 8];
2918         struct ofpbuf actions, put_actions;
2919         ovs_u128 ufid;
2920
2921         ofpbuf_use_stub(&actions, actions_stub, sizeof actions_stub);
2922         ofpbuf_use_stub(&put_actions, slow_stub, sizeof slow_stub);
2923
2924         for (i = 0; i < cnt; i++) {
2925             struct dp_netdev_flow *netdev_flow;
2926             struct ofpbuf *add_actions;
2927             struct match match;
2928             int error;
2929
2930             if (OVS_LIKELY(rules[i])) {
2931                 continue;
2932             }
2933
2934             /* It's possible that an earlier slow path execution installed
2935              * a rule covering this flow.  In this case, it's a lot cheaper
2936              * to catch it here than execute a miss. */
2937             netdev_flow = dp_netdev_pmd_lookup_flow(pmd, &keys[i]);
2938             if (netdev_flow) {
2939                 rules[i] = &netdev_flow->cr;
2940                 continue;
2941             }
2942
2943             miniflow_expand(&keys[i].mf, &match.flow);
2944
2945             ofpbuf_clear(&actions);
2946             ofpbuf_clear(&put_actions);
2947
2948             dpif_flow_hash(dp->dpif, &match.flow, sizeof match.flow, &ufid);
2949             error = dp_netdev_upcall(pmd, packets[i], &match.flow, &match.wc,
2950                                      &ufid, DPIF_UC_MISS, NULL, &actions,
2951                                      &put_actions);
2952             if (OVS_UNLIKELY(error && error != ENOSPC)) {
2953                 continue;
2954             }
2955
2956             /* We can't allow the packet batching in the next loop to execute
2957              * the actions.  Otherwise, if there are any slow path actions,
2958              * we'll send the packet up twice. */
2959             dp_netdev_execute_actions(pmd, &packets[i], 1, true,
2960                                       ofpbuf_data(&actions),
2961                                       ofpbuf_size(&actions));
2962
2963             add_actions = ofpbuf_size(&put_actions)
2964                 ? &put_actions
2965                 : &actions;
2966
2967             if (OVS_LIKELY(error != ENOSPC)) {
2968                 /* XXX: There's a race window where a flow covering this packet
2969                  * could have already been installed since we last did the flow
2970                  * lookup before upcall.  This could be solved by moving the
2971                  * mutex lock outside the loop, but that's an awful long time
2972                  * to be locking everyone out of making flow installs.  If we
2973                  * move to a per-core classifier, it would be reasonable. */
2974                 ovs_mutex_lock(&pmd->flow_mutex);
2975                 netdev_flow = dp_netdev_pmd_lookup_flow(pmd, &keys[i]);
2976                 if (OVS_LIKELY(!netdev_flow)) {
2977                     netdev_flow = dp_netdev_flow_add(pmd, &match, &ufid,
2978                                                      ofpbuf_data(add_actions),
2979                                                      ofpbuf_size(add_actions));
2980                 }
2981                 ovs_mutex_unlock(&pmd->flow_mutex);
2982
2983                 emc_insert(flow_cache, &keys[i], netdev_flow);
2984             }
2985         }
2986
2987         ofpbuf_uninit(&actions);
2988         ofpbuf_uninit(&put_actions);
2989         fat_rwlock_unlock(&dp->upcall_rwlock);
2990     } else if (OVS_UNLIKELY(any_miss)) {
2991         int dropped_cnt = 0;
2992
2993         for (i = 0; i < cnt; i++) {
2994             if (OVS_UNLIKELY(!rules[i])) {
2995                 dpif_packet_delete(packets[i]);
2996                 dropped_cnt++;
2997             }
2998         }
2999
3000         dp_netdev_count_packet(pmd, DP_STAT_LOST, dropped_cnt);
3001     }
3002
3003     n_batches = 0;
3004     for (i = 0; i < cnt; i++) {
3005         struct dpif_packet *packet = packets[i];
3006         struct dp_netdev_flow *flow;
3007
3008         if (OVS_UNLIKELY(!rules[i])) {
3009             continue;
3010         }
3011
3012         flow = dp_netdev_flow_cast(rules[i]);
3013
3014         emc_insert(flow_cache, &keys[i], flow);
3015         dp_netdev_queue_batches(packet, flow, &keys[i].mf, batches,
3016                                 &n_batches, ARRAY_SIZE(batches));
3017     }
3018
3019     for (i = 0; i < n_batches; i++) {
3020         packet_batch_execute(&batches[i], pmd);
3021     }
3022 }
3023
3024 static void
3025 dp_netdev_input(struct dp_netdev_pmd_thread *pmd,
3026                 struct dpif_packet **packets, int cnt)
3027 {
3028 #if !defined(__CHECKER__) && !defined(_WIN32)
3029     const size_t PKT_ARRAY_SIZE = cnt;
3030 #else
3031     /* Sparse or MSVC doesn't like variable length array. */
3032     enum { PKT_ARRAY_SIZE = NETDEV_MAX_RX_BATCH };
3033 #endif
3034     struct netdev_flow_key keys[PKT_ARRAY_SIZE];
3035     size_t newcnt;
3036
3037     newcnt = emc_processing(pmd, packets, cnt, keys);
3038     if (OVS_UNLIKELY(newcnt)) {
3039         fast_path_processing(pmd, packets, newcnt, keys);
3040     }
3041 }
3042
3043 struct dp_netdev_execute_aux {
3044     struct dp_netdev_pmd_thread *pmd;
3045 };
3046
3047 static void
3048 dpif_netdev_register_upcall_cb(struct dpif *dpif, upcall_callback *cb,
3049                                void *aux)
3050 {
3051     struct dp_netdev *dp = get_dp_netdev(dpif);
3052     dp->upcall_aux = aux;
3053     dp->upcall_cb = cb;
3054 }
3055
3056 static void
3057 dp_netdev_drop_packets(struct dpif_packet ** packets, int cnt, bool may_steal)
3058 {
3059     if (may_steal) {
3060         int i;
3061
3062         for (i = 0; i < cnt; i++) {
3063             dpif_packet_delete(packets[i]);
3064         }
3065     }
3066 }
3067
3068 static int
3069 push_tnl_action(const struct dp_netdev *dp,
3070                    const struct nlattr *attr,
3071                    struct dpif_packet **packets, int cnt)
3072 {
3073     struct dp_netdev_port *tun_port;
3074     const struct ovs_action_push_tnl *data;
3075
3076     data = nl_attr_get(attr);
3077
3078     tun_port = dp_netdev_lookup_port(dp, u32_to_odp(data->tnl_port));
3079     if (!tun_port) {
3080         return -EINVAL;
3081     }
3082     netdev_push_header(tun_port->netdev, packets, cnt, data);
3083
3084     return 0;
3085 }
3086
3087 static void
3088 dp_netdev_clone_pkt_batch(struct dpif_packet **tnl_pkt,
3089                           struct dpif_packet **packets, int cnt)
3090 {
3091     int i;
3092
3093     for (i = 0; i < cnt; i++) {
3094         tnl_pkt[i] = dpif_packet_clone(packets[i]);
3095     }
3096 }
3097
3098 static void
3099 dp_execute_cb(void *aux_, struct dpif_packet **packets, int cnt,
3100               const struct nlattr *a, bool may_steal)
3101     OVS_NO_THREAD_SAFETY_ANALYSIS
3102 {
3103     struct dp_netdev_execute_aux *aux = aux_;
3104     uint32_t *depth = recirc_depth_get();
3105     struct dp_netdev_pmd_thread *pmd= aux->pmd;
3106     struct dp_netdev *dp= pmd->dp;
3107     int type = nl_attr_type(a);
3108     struct dp_netdev_port *p;
3109     int i;
3110
3111     switch ((enum ovs_action_attr)type) {
3112     case OVS_ACTION_ATTR_OUTPUT:
3113         p = dp_netdev_lookup_port(dp, u32_to_odp(nl_attr_get_u32(a)));
3114         if (OVS_LIKELY(p)) {
3115             netdev_send(p->netdev, pmd->core_id, packets, cnt, may_steal);
3116             return;
3117         }
3118         break;
3119
3120     case OVS_ACTION_ATTR_TUNNEL_PUSH:
3121         if (*depth < MAX_RECIRC_DEPTH) {
3122             struct dpif_packet *tnl_pkt[NETDEV_MAX_RX_BATCH];
3123             int err;
3124
3125             if (!may_steal) {
3126                 dp_netdev_clone_pkt_batch(tnl_pkt, packets, cnt);
3127                 packets = tnl_pkt;
3128             }
3129
3130             err = push_tnl_action(dp, a, packets, cnt);
3131             if (!err) {
3132                 (*depth)++;
3133                 dp_netdev_input(pmd, packets, cnt);
3134                 (*depth)--;
3135             } else {
3136                 dp_netdev_drop_packets(tnl_pkt, cnt, !may_steal);
3137             }
3138             return;
3139         }
3140         break;
3141
3142     case OVS_ACTION_ATTR_TUNNEL_POP:
3143         if (*depth < MAX_RECIRC_DEPTH) {
3144             odp_port_t portno = u32_to_odp(nl_attr_get_u32(a));
3145
3146             p = dp_netdev_lookup_port(dp, portno);
3147             if (p) {
3148                 struct dpif_packet *tnl_pkt[NETDEV_MAX_RX_BATCH];
3149                 int err;
3150
3151                 if (!may_steal) {
3152                    dp_netdev_clone_pkt_batch(tnl_pkt, packets, cnt);
3153                    packets = tnl_pkt;
3154                 }
3155
3156                 err = netdev_pop_header(p->netdev, packets, cnt);
3157                 if (!err) {
3158
3159                     for (i = 0; i < cnt; i++) {
3160                         packets[i]->md.in_port.odp_port = portno;
3161                     }
3162
3163                     (*depth)++;
3164                     dp_netdev_input(pmd, packets, cnt);
3165                     (*depth)--;
3166                 } else {
3167                     dp_netdev_drop_packets(tnl_pkt, cnt, !may_steal);
3168                 }
3169                 return;
3170             }
3171         }
3172         break;
3173
3174     case OVS_ACTION_ATTR_USERSPACE:
3175         if (!fat_rwlock_tryrdlock(&dp->upcall_rwlock)) {
3176             const struct nlattr *userdata;
3177             struct ofpbuf actions;
3178             struct flow flow;
3179             ovs_u128 ufid;
3180
3181             userdata = nl_attr_find_nested(a, OVS_USERSPACE_ATTR_USERDATA);
3182             ofpbuf_init(&actions, 0);
3183
3184             for (i = 0; i < cnt; i++) {
3185                 int error;
3186
3187                 ofpbuf_clear(&actions);
3188
3189                 flow_extract(&packets[i]->ofpbuf, &packets[i]->md, &flow);
3190                 dpif_flow_hash(dp->dpif, &flow, sizeof flow, &ufid);
3191                 error = dp_netdev_upcall(pmd, packets[i], &flow, NULL, &ufid,
3192                                          DPIF_UC_ACTION, userdata,&actions,
3193                                          NULL);
3194                 if (!error || error == ENOSPC) {
3195                     dp_netdev_execute_actions(pmd, &packets[i], 1, may_steal,
3196                                               ofpbuf_data(&actions),
3197                                               ofpbuf_size(&actions));
3198                 } else if (may_steal) {
3199                     dpif_packet_delete(packets[i]);
3200                 }
3201             }
3202             ofpbuf_uninit(&actions);
3203             fat_rwlock_unlock(&dp->upcall_rwlock);
3204
3205             return;
3206         }
3207         break;
3208
3209     case OVS_ACTION_ATTR_RECIRC:
3210         if (*depth < MAX_RECIRC_DEPTH) {
3211
3212             (*depth)++;
3213             for (i = 0; i < cnt; i++) {
3214                 struct dpif_packet *recirc_pkt;
3215
3216                 recirc_pkt = (may_steal) ? packets[i]
3217                                     : dpif_packet_clone(packets[i]);
3218
3219                 recirc_pkt->md.recirc_id = nl_attr_get_u32(a);
3220
3221                 /* Hash is private to each packet */
3222                 recirc_pkt->md.dp_hash = dpif_packet_get_dp_hash(packets[i]);
3223
3224                 dp_netdev_input(pmd, &recirc_pkt, 1);
3225             }
3226             (*depth)--;
3227
3228             return;
3229         }
3230
3231         VLOG_WARN("Packet dropped. Max recirculation depth exceeded.");
3232         break;
3233
3234     case OVS_ACTION_ATTR_PUSH_VLAN:
3235     case OVS_ACTION_ATTR_POP_VLAN:
3236     case OVS_ACTION_ATTR_PUSH_MPLS:
3237     case OVS_ACTION_ATTR_POP_MPLS:
3238     case OVS_ACTION_ATTR_SET:
3239     case OVS_ACTION_ATTR_SET_MASKED:
3240     case OVS_ACTION_ATTR_SAMPLE:
3241     case OVS_ACTION_ATTR_HASH:
3242     case OVS_ACTION_ATTR_UNSPEC:
3243     case __OVS_ACTION_ATTR_MAX:
3244         OVS_NOT_REACHED();
3245     }
3246
3247     dp_netdev_drop_packets(packets, cnt, may_steal);
3248 }
3249
3250 static void
3251 dp_netdev_execute_actions(struct dp_netdev_pmd_thread *pmd,
3252                           struct dpif_packet **packets, int cnt,
3253                           bool may_steal,
3254                           const struct nlattr *actions, size_t actions_len)
3255 {
3256     struct dp_netdev_execute_aux aux = { pmd };
3257
3258     odp_execute_actions(&aux, packets, cnt, may_steal, actions,
3259                         actions_len, dp_execute_cb);
3260 }
3261
3262 const struct dpif_class dpif_netdev_class = {
3263     "netdev",
3264     dpif_netdev_enumerate,
3265     dpif_netdev_port_open_type,
3266     dpif_netdev_open,
3267     dpif_netdev_close,
3268     dpif_netdev_destroy,
3269     dpif_netdev_run,
3270     dpif_netdev_wait,
3271     dpif_netdev_get_stats,
3272     dpif_netdev_port_add,
3273     dpif_netdev_port_del,
3274     dpif_netdev_port_query_by_number,
3275     dpif_netdev_port_query_by_name,
3276     NULL,                       /* port_get_pid */
3277     dpif_netdev_port_dump_start,
3278     dpif_netdev_port_dump_next,
3279     dpif_netdev_port_dump_done,
3280     dpif_netdev_port_poll,
3281     dpif_netdev_port_poll_wait,
3282     dpif_netdev_flow_flush,
3283     dpif_netdev_flow_dump_create,
3284     dpif_netdev_flow_dump_destroy,
3285     dpif_netdev_flow_dump_thread_create,
3286     dpif_netdev_flow_dump_thread_destroy,
3287     dpif_netdev_flow_dump_next,
3288     dpif_netdev_operate,
3289     NULL,                       /* recv_set */
3290     NULL,                       /* handlers_set */
3291     dpif_netdev_pmd_set,
3292     dpif_netdev_queue_to_priority,
3293     NULL,                       /* recv */
3294     NULL,                       /* recv_wait */
3295     NULL,                       /* recv_purge */
3296     dpif_netdev_register_upcall_cb,
3297     dpif_netdev_enable_upcall,
3298     dpif_netdev_disable_upcall,
3299     dpif_netdev_get_datapath_version,
3300 };
3301
3302 static void
3303 dpif_dummy_change_port_number(struct unixctl_conn *conn, int argc OVS_UNUSED,
3304                               const char *argv[], void *aux OVS_UNUSED)
3305 {
3306     struct dp_netdev_port *old_port;
3307     struct dp_netdev_port *new_port;
3308     struct dp_netdev *dp;
3309     odp_port_t port_no;
3310
3311     ovs_mutex_lock(&dp_netdev_mutex);
3312     dp = shash_find_data(&dp_netdevs, argv[1]);
3313     if (!dp || !dpif_netdev_class_is_dummy(dp->class)) {
3314         ovs_mutex_unlock(&dp_netdev_mutex);
3315         unixctl_command_reply_error(conn, "unknown datapath or not a dummy");
3316         return;
3317     }
3318     ovs_refcount_ref(&dp->ref_cnt);
3319     ovs_mutex_unlock(&dp_netdev_mutex);
3320
3321     ovs_mutex_lock(&dp->port_mutex);
3322     if (get_port_by_name(dp, argv[2], &old_port)) {
3323         unixctl_command_reply_error(conn, "unknown port");
3324         goto exit;
3325     }
3326
3327     port_no = u32_to_odp(atoi(argv[3]));
3328     if (!port_no || port_no == ODPP_NONE) {
3329         unixctl_command_reply_error(conn, "bad port number");
3330         goto exit;
3331     }
3332     if (dp_netdev_lookup_port(dp, port_no)) {
3333         unixctl_command_reply_error(conn, "port number already in use");
3334         goto exit;
3335     }
3336
3337     /* Remove old port. */
3338     cmap_remove(&dp->ports, &old_port->node, hash_port_no(old_port->port_no));
3339     ovsrcu_postpone(free, old_port);
3340
3341     /* Insert new port (cmap semantics mean we cannot re-insert 'old_port'). */
3342     new_port = xmemdup(old_port, sizeof *old_port);
3343     new_port->port_no = port_no;
3344     cmap_insert(&dp->ports, &new_port->node, hash_port_no(port_no));
3345
3346     seq_change(dp->port_seq);
3347     unixctl_command_reply(conn, NULL);
3348
3349 exit:
3350     ovs_mutex_unlock(&dp->port_mutex);
3351     dp_netdev_unref(dp);
3352 }
3353
3354 static void
3355 dpif_dummy_delete_port(struct unixctl_conn *conn, int argc OVS_UNUSED,
3356                        const char *argv[], void *aux OVS_UNUSED)
3357 {
3358     struct dp_netdev_port *port;
3359     struct dp_netdev *dp;
3360
3361     ovs_mutex_lock(&dp_netdev_mutex);
3362     dp = shash_find_data(&dp_netdevs, argv[1]);
3363     if (!dp || !dpif_netdev_class_is_dummy(dp->class)) {
3364         ovs_mutex_unlock(&dp_netdev_mutex);
3365         unixctl_command_reply_error(conn, "unknown datapath or not a dummy");
3366         return;
3367     }
3368     ovs_refcount_ref(&dp->ref_cnt);
3369     ovs_mutex_unlock(&dp_netdev_mutex);
3370
3371     ovs_mutex_lock(&dp->port_mutex);
3372     if (get_port_by_name(dp, argv[2], &port)) {
3373         unixctl_command_reply_error(conn, "unknown port");
3374     } else if (port->port_no == ODPP_LOCAL) {
3375         unixctl_command_reply_error(conn, "can't delete local port");
3376     } else {
3377         do_del_port(dp, port);
3378         unixctl_command_reply(conn, NULL);
3379     }
3380     ovs_mutex_unlock(&dp->port_mutex);
3381
3382     dp_netdev_unref(dp);
3383 }
3384
3385 static void
3386 dpif_dummy_register__(const char *type)
3387 {
3388     struct dpif_class *class;
3389
3390     class = xmalloc(sizeof *class);
3391     *class = dpif_netdev_class;
3392     class->type = xstrdup(type);
3393     dp_register_provider(class);
3394 }
3395
3396 void
3397 dpif_dummy_register(bool override)
3398 {
3399     if (override) {
3400         struct sset types;
3401         const char *type;
3402
3403         sset_init(&types);
3404         dp_enumerate_types(&types);
3405         SSET_FOR_EACH (type, &types) {
3406             if (!dp_unregister_provider(type)) {
3407                 dpif_dummy_register__(type);
3408             }
3409         }
3410         sset_destroy(&types);
3411     }
3412
3413     dpif_dummy_register__("dummy");
3414
3415     unixctl_command_register("dpif-dummy/change-port-number",
3416                              "dp port new-number",
3417                              3, 3, dpif_dummy_change_port_number, NULL);
3418     unixctl_command_register("dpif-dummy/delete-port", "dp port",
3419                              2, 2, dpif_dummy_delete_port, NULL);
3420 }
3421 \f
3422 /* Datapath Classifier. */
3423
3424 /* A set of rules that all have the same fields wildcarded. */
3425 struct dpcls_subtable {
3426     /* The fields are only used by writers. */
3427     struct cmap_node cmap_node OVS_GUARDED; /* Within dpcls 'subtables_map'. */
3428
3429     /* These fields are accessed by readers. */
3430     struct cmap rules;           /* Contains "struct dpcls_rule"s. */
3431     struct netdev_flow_key mask; /* Wildcards for fields (const). */
3432     /* 'mask' must be the last field, additional space is allocated here. */
3433 };
3434
3435 /* Initializes 'cls' as a classifier that initially contains no classification
3436  * rules. */
3437 static void
3438 dpcls_init(struct dpcls *cls)
3439 {
3440     cmap_init(&cls->subtables_map);
3441     pvector_init(&cls->subtables);
3442 }
3443
3444 static void
3445 dpcls_destroy_subtable(struct dpcls *cls, struct dpcls_subtable *subtable)
3446 {
3447     pvector_remove(&cls->subtables, subtable);
3448     cmap_remove(&cls->subtables_map, &subtable->cmap_node,
3449                 subtable->mask.hash);
3450     cmap_destroy(&subtable->rules);
3451     ovsrcu_postpone(free, subtable);
3452 }
3453
3454 /* Destroys 'cls'.  Rules within 'cls', if any, are not freed; this is the
3455  * caller's responsibility.
3456  * May only be called after all the readers have been terminated. */
3457 static void
3458 dpcls_destroy(struct dpcls *cls)
3459 {
3460     if (cls) {
3461         struct dpcls_subtable *subtable;
3462
3463         CMAP_FOR_EACH (subtable, cmap_node, &cls->subtables_map) {
3464             dpcls_destroy_subtable(cls, subtable);
3465         }
3466         cmap_destroy(&cls->subtables_map);
3467         pvector_destroy(&cls->subtables);
3468     }
3469 }
3470
3471 static struct dpcls_subtable *
3472 dpcls_create_subtable(struct dpcls *cls, const struct netdev_flow_key *mask)
3473 {
3474     struct dpcls_subtable *subtable;
3475
3476     /* Need to add one. */
3477     subtable = xmalloc(sizeof *subtable
3478                        - sizeof subtable->mask.mf + mask->len);
3479     cmap_init(&subtable->rules);
3480     netdev_flow_key_clone(&subtable->mask, mask);
3481     cmap_insert(&cls->subtables_map, &subtable->cmap_node, mask->hash);
3482     pvector_insert(&cls->subtables, subtable, 0);
3483     pvector_publish(&cls->subtables);
3484
3485     return subtable;
3486 }
3487
3488 static inline struct dpcls_subtable *
3489 dpcls_find_subtable(struct dpcls *cls, const struct netdev_flow_key *mask)
3490 {
3491     struct dpcls_subtable *subtable;
3492
3493     CMAP_FOR_EACH_WITH_HASH (subtable, cmap_node, mask->hash,
3494                              &cls->subtables_map) {
3495         if (netdev_flow_key_equal(&subtable->mask, mask)) {
3496             return subtable;
3497         }
3498     }
3499     return dpcls_create_subtable(cls, mask);
3500 }
3501
3502 /* Insert 'rule' into 'cls'. */
3503 static void
3504 dpcls_insert(struct dpcls *cls, struct dpcls_rule *rule,
3505              const struct netdev_flow_key *mask)
3506 {
3507     struct dpcls_subtable *subtable = dpcls_find_subtable(cls, mask);
3508
3509     rule->mask = &subtable->mask;
3510     cmap_insert(&subtable->rules, &rule->cmap_node, rule->flow.hash);
3511 }
3512
3513 /* Removes 'rule' from 'cls', also destructing the 'rule'. */
3514 static void
3515 dpcls_remove(struct dpcls *cls, struct dpcls_rule *rule)
3516 {
3517     struct dpcls_subtable *subtable;
3518
3519     ovs_assert(rule->mask);
3520
3521     INIT_CONTAINER(subtable, rule->mask, mask);
3522
3523     if (cmap_remove(&subtable->rules, &rule->cmap_node, rule->flow.hash)
3524         == 0) {
3525         dpcls_destroy_subtable(cls, subtable);
3526         pvector_publish(&cls->subtables);
3527     }
3528 }
3529
3530 /* Returns true if 'target' satisifies 'key' in 'mask', that is, if each 1-bit
3531  * in 'mask' the values in 'key' and 'target' are the same.
3532  *
3533  * Note: 'key' and 'mask' have the same mask, and 'key' is already masked. */
3534 static inline bool
3535 dpcls_rule_matches_key(const struct dpcls_rule *rule,
3536                        const struct netdev_flow_key *target)
3537 {
3538     const uint32_t *keyp = rule->flow.mf.inline_values;
3539     const uint32_t *maskp = rule->mask->mf.inline_values;
3540     uint32_t target_u32;
3541
3542     NETDEV_FLOW_KEY_FOR_EACH_IN_MAP(target_u32, target, rule->flow.mf.map) {
3543         if (OVS_UNLIKELY((target_u32 & *maskp++) != *keyp++)) {
3544             return false;
3545         }
3546     }
3547     return true;
3548 }
3549
3550 /* For each miniflow in 'flows' performs a classifier lookup writing the result
3551  * into the corresponding slot in 'rules'.  If a particular entry in 'flows' is
3552  * NULL it is skipped.
3553  *
3554  * This function is optimized for use in the userspace datapath and therefore
3555  * does not implement a lot of features available in the standard
3556  * classifier_lookup() function.  Specifically, it does not implement
3557  * priorities, instead returning any rule which matches the flow.
3558  *
3559  * Returns true if all flows found a corresponding rule. */
3560 static bool
3561 dpcls_lookup(const struct dpcls *cls, const struct netdev_flow_key keys[],
3562              struct dpcls_rule **rules, const size_t cnt)
3563 {
3564     /* The batch size 16 was experimentally found faster than 8 or 32. */
3565     typedef uint16_t map_type;
3566 #define MAP_BITS (sizeof(map_type) * CHAR_BIT)
3567
3568 #if !defined(__CHECKER__) && !defined(_WIN32)
3569     const int N_MAPS = DIV_ROUND_UP(cnt, MAP_BITS);
3570 #else
3571     enum { N_MAPS = DIV_ROUND_UP(NETDEV_MAX_RX_BATCH, MAP_BITS) };
3572 #endif
3573     map_type maps[N_MAPS];
3574     struct dpcls_subtable *subtable;
3575
3576     memset(maps, 0xff, sizeof maps);
3577     if (cnt % MAP_BITS) {
3578         maps[N_MAPS - 1] >>= MAP_BITS - cnt % MAP_BITS; /* Clear extra bits. */
3579     }
3580     memset(rules, 0, cnt * sizeof *rules);
3581
3582     PVECTOR_FOR_EACH (subtable, &cls->subtables) {
3583         const struct netdev_flow_key *mkeys = keys;
3584         struct dpcls_rule **mrules = rules;
3585         map_type remains = 0;
3586         int m;
3587
3588         BUILD_ASSERT_DECL(sizeof remains == sizeof *maps);
3589
3590         for (m = 0; m < N_MAPS; m++, mkeys += MAP_BITS, mrules += MAP_BITS) {
3591             uint32_t hashes[MAP_BITS];
3592             const struct cmap_node *nodes[MAP_BITS];
3593             unsigned long map = maps[m];
3594             int i;
3595
3596             if (!map) {
3597                 continue; /* Skip empty maps. */
3598             }
3599
3600             /* Compute hashes for the remaining keys. */
3601             ULONG_FOR_EACH_1(i, map) {
3602                 hashes[i] = netdev_flow_key_hash_in_mask(&mkeys[i],
3603                                                          &subtable->mask);
3604             }
3605             /* Lookup. */
3606             map = cmap_find_batch(&subtable->rules, map, hashes, nodes);
3607             /* Check results. */
3608             ULONG_FOR_EACH_1(i, map) {
3609                 struct dpcls_rule *rule;
3610
3611                 CMAP_NODE_FOR_EACH (rule, cmap_node, nodes[i]) {
3612                     if (OVS_LIKELY(dpcls_rule_matches_key(rule, &mkeys[i]))) {
3613                         mrules[i] = rule;
3614                         goto next;
3615                     }
3616                 }
3617                 ULONG_SET0(map, i);   /* Did not match. */
3618             next:
3619                 ;                     /* Keep Sparse happy. */
3620             }
3621             maps[m] &= ~map;          /* Clear the found rules. */
3622             remains |= maps[m];
3623         }
3624         if (!remains) {
3625             return true;              /* All found. */
3626         }
3627     }
3628     return false;                     /* Some misses. */
3629 }