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