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