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