dpif-netdev: Fix use-after-free in port_unref().
[cascardo/ovs.git] / lib / dpif-netdev.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "dpif.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 "classifier.h"
35 #include "csum.h"
36 #include "dpif.h"
37 #include "dpif-provider.h"
38 #include "dummy.h"
39 #include "dynamic-string.h"
40 #include "flow.h"
41 #include "hmap.h"
42 #include "latch.h"
43 #include "list.h"
44 #include "meta-flow.h"
45 #include "netdev.h"
46 #include "netdev-dpdk.h"
47 #include "netdev-vport.h"
48 #include "netlink.h"
49 #include "odp-execute.h"
50 #include "odp-util.h"
51 #include "ofp-print.h"
52 #include "ofpbuf.h"
53 #include "ovs-rcu.h"
54 #include "packets.h"
55 #include "poll-loop.h"
56 #include "random.h"
57 #include "seq.h"
58 #include "shash.h"
59 #include "sset.h"
60 #include "timeval.h"
61 #include "unixctl.h"
62 #include "util.h"
63 #include "vlog.h"
64
65 VLOG_DEFINE_THIS_MODULE(dpif_netdev);
66
67 /* By default, choose a priority in the middle. */
68 #define NETDEV_RULE_PRIORITY 0x8000
69
70 #define NR_THREADS 1
71 /* Use per thread recirc_depth to prevent recirculation loop. */
72 #define MAX_RECIRC_DEPTH 5
73 DEFINE_STATIC_PER_THREAD_DATA(uint32_t, recirc_depth, 0)
74
75 /* Configuration parameters. */
76 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
77
78 /* Queues. */
79 enum { MAX_QUEUE_LEN = 128 };   /* Maximum number of packets per queue. */
80 enum { QUEUE_MASK = MAX_QUEUE_LEN - 1 };
81 BUILD_ASSERT_DECL(IS_POW2(MAX_QUEUE_LEN));
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 struct dp_netdev_upcall {
91     struct dpif_upcall upcall;  /* Queued upcall information. */
92     struct ofpbuf buf;          /* ofpbuf instance for upcall.packet. */
93 };
94
95 /* A queue passing packets from a struct dp_netdev to its clients (handlers).
96  *
97  *
98  * Thread-safety
99  * =============
100  *
101  * Any access at all requires the owning 'dp_netdev''s queue_rwlock and
102  * its own mutex. */
103 struct dp_netdev_queue {
104     struct ovs_mutex mutex;
105     struct seq *seq;      /* Incremented whenever a packet is queued. */
106     struct dp_netdev_upcall upcalls[MAX_QUEUE_LEN] OVS_GUARDED;
107     unsigned int head OVS_GUARDED;
108     unsigned int tail OVS_GUARDED;
109 };
110
111 /* Datapath based on the network device interface from netdev.h.
112  *
113  *
114  * Thread-safety
115  * =============
116  *
117  * Some members, marked 'const', are immutable.  Accessing other members
118  * requires synchronization, as noted in more detail below.
119  *
120  * Acquisition order is, from outermost to innermost:
121  *
122  *    dp_netdev_mutex (global)
123  *    port_rwlock
124  *    flow_mutex
125  *    cls.rwlock
126  *    queue_rwlock
127  */
128 struct dp_netdev {
129     const struct dpif_class *const class;
130     const char *const name;
131     struct ovs_refcount ref_cnt;
132     atomic_flag destroyed;
133
134     /* Flows.
135      *
136      * Readers of 'cls' and 'flow_table' must take a 'cls->rwlock' read lock.
137      *
138      * Writers of 'cls' and 'flow_table' must take the 'flow_mutex' and then
139      * the 'cls->rwlock' write lock.  (The outer 'flow_mutex' allows writers to
140      * atomically perform multiple operations on 'cls' and 'flow_table'.)
141      */
142     struct ovs_mutex flow_mutex;
143     struct classifier cls;      /* Classifier.  Protected by cls.rwlock. */
144     struct hmap flow_table OVS_GUARDED; /* Flow table. */
145
146     /* Queues.
147      *
148      * 'queue_rwlock' protects the modification of 'handler_queues' and
149      * 'n_handlers'.  The queue elements are protected by its
150      * 'handler_queues''s mutex. */
151     struct fat_rwlock queue_rwlock;
152     struct dp_netdev_queue *handler_queues;
153     uint32_t n_handlers;
154
155     /* Statistics.
156      *
157      * ovsthread_stats is internally synchronized. */
158     struct ovsthread_stats stats; /* Contains 'struct dp_netdev_stats *'. */
159
160     /* Ports.
161      *
162      * Any lookup into 'ports' or any access to the dp_netdev_ports found
163      * through 'ports' requires taking 'port_rwlock'. */
164     struct ovs_rwlock port_rwlock;
165     struct hmap ports OVS_GUARDED;
166     struct seq *port_seq;       /* Incremented whenever a port changes. */
167
168     /* Forwarding threads. */
169     struct latch exit_latch;
170     struct pmd_thread *pmd_threads;
171     size_t n_pmd_threads;
172     int pmd_count;
173 };
174
175 static struct dp_netdev_port *dp_netdev_lookup_port(const struct dp_netdev *dp,
176                                                     odp_port_t)
177     OVS_REQ_RDLOCK(dp->port_rwlock);
178
179 enum dp_stat_type {
180     DP_STAT_HIT,                /* Packets that matched in the flow table. */
181     DP_STAT_MISS,               /* Packets that did not match. */
182     DP_STAT_LOST,               /* Packets not passed up to the client. */
183     DP_N_STATS
184 };
185
186 /* Contained by struct dp_netdev's 'stats' member.  */
187 struct dp_netdev_stats {
188     struct ovs_mutex mutex;          /* Protects 'n'. */
189
190     /* Indexed by DP_STAT_*, protected by 'mutex'. */
191     unsigned long long int n[DP_N_STATS] OVS_GUARDED;
192 };
193
194
195 /* A port in a netdev-based datapath. */
196 struct dp_netdev_port {
197     struct hmap_node node;      /* Node in dp_netdev's 'ports'. */
198     odp_port_t port_no;
199     struct netdev *netdev;
200     struct netdev_saved_flags *sf;
201     struct netdev_rxq **rxq;
202     struct ovs_refcount ref_cnt;
203     char *type;                 /* Port type as requested by user. */
204 };
205
206 /* A flow in dp_netdev's 'flow_table'.
207  *
208  *
209  * Thread-safety
210  * =============
211  *
212  * Except near the beginning or ending of its lifespan, rule 'rule' belongs to
213  * its dp_netdev's classifier.  The text below calls this classifier 'cls'.
214  *
215  * Motivation
216  * ----------
217  *
218  * The thread safety rules described here for "struct dp_netdev_flow" are
219  * motivated by two goals:
220  *
221  *    - Prevent threads that read members of "struct dp_netdev_flow" from
222  *      reading bad data due to changes by some thread concurrently modifying
223  *      those members.
224  *
225  *    - Prevent two threads making changes to members of a given "struct
226  *      dp_netdev_flow" from interfering with each other.
227  *
228  *
229  * Rules
230  * -----
231  *
232  * A flow 'flow' may be accessed without a risk of being freed by code that
233  * holds a read-lock or write-lock on 'cls->rwlock' or that owns a reference to
234  * 'flow->ref_cnt' (or both).  Code that needs to hold onto a flow for a while
235  * should take 'cls->rwlock', find the flow it needs, increment 'flow->ref_cnt'
236  * with dpif_netdev_flow_ref(), and drop 'cls->rwlock'.
237  *
238  * 'flow->ref_cnt' protects 'flow' from being freed.  It doesn't protect the
239  * flow from being deleted from 'cls' (that's 'cls->rwlock') and it doesn't
240  * protect members of 'flow' from modification.
241  *
242  * Some members, marked 'const', are immutable.  Accessing other members
243  * requires synchronization, as noted in more detail below.
244  */
245 struct dp_netdev_flow {
246     /* Packet classification. */
247     const struct cls_rule cr;   /* In owning dp_netdev's 'cls'. */
248
249     /* Hash table index by unmasked flow. */
250     const struct hmap_node node; /* In owning dp_netdev's 'flow_table'. */
251     const struct flow flow;      /* The flow that created this entry. */
252
253     /* Statistics.
254      *
255      * Reading or writing these members requires 'mutex'. */
256     struct ovsthread_stats stats; /* Contains "struct dp_netdev_flow_stats". */
257
258     /* Actions. */
259     OVSRCU_TYPE(struct dp_netdev_actions *) actions;
260 };
261
262 static void dp_netdev_flow_free(struct dp_netdev_flow *);
263
264 /* Contained by struct dp_netdev_flow's 'stats' member.  */
265 struct dp_netdev_flow_stats {
266     struct ovs_mutex mutex;         /* Guards all the other members. */
267
268     long long int used OVS_GUARDED; /* Last used time, in monotonic msecs. */
269     long long int packet_count OVS_GUARDED; /* Number of packets matched. */
270     long long int byte_count OVS_GUARDED;   /* Number of bytes matched. */
271     uint16_t tcp_flags OVS_GUARDED; /* Bitwise-OR of seen tcp_flags values. */
272 };
273
274 /* A set of datapath actions within a "struct dp_netdev_flow".
275  *
276  *
277  * Thread-safety
278  * =============
279  *
280  * A struct dp_netdev_actions 'actions' is protected with RCU. */
281 struct dp_netdev_actions {
282     /* These members are immutable: they do not change during the struct's
283      * lifetime.  */
284     struct nlattr *actions;     /* Sequence of OVS_ACTION_ATTR_* attributes. */
285     unsigned int size;          /* Size of 'actions', in bytes. */
286 };
287
288 struct dp_netdev_actions *dp_netdev_actions_create(const struct nlattr *,
289                                                    size_t);
290 struct dp_netdev_actions *dp_netdev_flow_get_actions(
291     const struct dp_netdev_flow *);
292 static void dp_netdev_actions_free(struct dp_netdev_actions *);
293
294 /* PMD: Poll modes drivers.  PMD accesses devices via polling to eliminate
295  * the performance overhead of interrupt processing.  Therefore netdev can
296  * not implement rx-wait for these devices.  dpif-netdev needs to poll
297  * these device to check for recv buffer.  pmd-thread does polling for
298  * devices assigned to itself thread.
299  *
300  * DPDK used PMD for accessing NIC.
301  *
302  * A thread that receives packets from PMD ports, looks them up in the flow
303  * table, and executes the actions it finds.
304  **/
305 struct pmd_thread {
306     struct dp_netdev *dp;
307     pthread_t thread;
308     int id;
309     atomic_uint change_seq;
310 };
311
312 /* Interface to netdev-based datapath. */
313 struct dpif_netdev {
314     struct dpif dpif;
315     struct dp_netdev *dp;
316     uint64_t last_port_seq;
317 };
318
319 static int get_port_by_number(struct dp_netdev *dp, odp_port_t port_no,
320                               struct dp_netdev_port **portp)
321     OVS_REQ_RDLOCK(dp->port_rwlock);
322 static int get_port_by_name(struct dp_netdev *dp, const char *devname,
323                             struct dp_netdev_port **portp)
324     OVS_REQ_RDLOCK(dp->port_rwlock);
325 static void dp_netdev_free(struct dp_netdev *)
326     OVS_REQUIRES(dp_netdev_mutex);
327 static void dp_netdev_flow_flush(struct dp_netdev *);
328 static int do_add_port(struct dp_netdev *dp, const char *devname,
329                        const char *type, odp_port_t port_no)
330     OVS_REQ_WRLOCK(dp->port_rwlock);
331 static int do_del_port(struct dp_netdev *dp, odp_port_t port_no)
332     OVS_REQ_WRLOCK(dp->port_rwlock);
333 static void dp_netdev_destroy_all_queues(struct dp_netdev *dp)
334     OVS_REQ_WRLOCK(dp->queue_rwlock);
335 static int dpif_netdev_open(const struct dpif_class *, const char *name,
336                             bool create, struct dpif **);
337 static int dp_netdev_output_userspace(struct dp_netdev *dp, struct ofpbuf *,
338                                       int queue_no, int type,
339                                       const struct miniflow *,
340                                       const struct nlattr *userdata);
341 static void dp_netdev_execute_actions(struct dp_netdev *dp,
342                                       const struct miniflow *,
343                                       struct ofpbuf *, bool may_steal,
344                                       struct pkt_metadata *,
345                                       const struct nlattr *actions,
346                                       size_t actions_len);
347 static void dp_netdev_port_input(struct dp_netdev *dp, struct ofpbuf *packet,
348                                  struct pkt_metadata *);
349
350 static void dp_netdev_set_pmd_threads(struct dp_netdev *, int n);
351
352 static struct dpif_netdev *
353 dpif_netdev_cast(const struct dpif *dpif)
354 {
355     ovs_assert(dpif->dpif_class->open == dpif_netdev_open);
356     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
357 }
358
359 static struct dp_netdev *
360 get_dp_netdev(const struct dpif *dpif)
361 {
362     return dpif_netdev_cast(dpif)->dp;
363 }
364
365 static int
366 dpif_netdev_enumerate(struct sset *all_dps)
367 {
368     struct shash_node *node;
369
370     ovs_mutex_lock(&dp_netdev_mutex);
371     SHASH_FOR_EACH(node, &dp_netdevs) {
372         sset_add(all_dps, node->name);
373     }
374     ovs_mutex_unlock(&dp_netdev_mutex);
375
376     return 0;
377 }
378
379 static bool
380 dpif_netdev_class_is_dummy(const struct dpif_class *class)
381 {
382     return class != &dpif_netdev_class;
383 }
384
385 static const char *
386 dpif_netdev_port_open_type(const struct dpif_class *class, const char *type)
387 {
388     return strcmp(type, "internal") ? type
389                   : dpif_netdev_class_is_dummy(class) ? "dummy"
390                   : "tap";
391 }
392
393 static struct dpif *
394 create_dpif_netdev(struct dp_netdev *dp)
395 {
396     uint16_t netflow_id = hash_string(dp->name, 0);
397     struct dpif_netdev *dpif;
398
399     ovs_refcount_ref(&dp->ref_cnt);
400
401     dpif = xmalloc(sizeof *dpif);
402     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
403     dpif->dp = dp;
404     dpif->last_port_seq = seq_read(dp->port_seq);
405
406     return &dpif->dpif;
407 }
408
409 /* Choose an unused, non-zero port number and return it on success.
410  * Return ODPP_NONE on failure. */
411 static odp_port_t
412 choose_port(struct dp_netdev *dp, const char *name)
413     OVS_REQ_RDLOCK(dp->port_rwlock)
414 {
415     uint32_t port_no;
416
417     if (dp->class != &dpif_netdev_class) {
418         const char *p;
419         int start_no = 0;
420
421         /* If the port name begins with "br", start the number search at
422          * 100 to make writing tests easier. */
423         if (!strncmp(name, "br", 2)) {
424             start_no = 100;
425         }
426
427         /* If the port name contains a number, try to assign that port number.
428          * This can make writing unit tests easier because port numbers are
429          * predictable. */
430         for (p = name; *p != '\0'; p++) {
431             if (isdigit((unsigned char) *p)) {
432                 port_no = start_no + strtol(p, NULL, 10);
433                 if (port_no > 0 && port_no != odp_to_u32(ODPP_NONE)
434                     && !dp_netdev_lookup_port(dp, u32_to_odp(port_no))) {
435                     return u32_to_odp(port_no);
436                 }
437                 break;
438             }
439         }
440     }
441
442     for (port_no = 1; port_no <= UINT16_MAX; port_no++) {
443         if (!dp_netdev_lookup_port(dp, u32_to_odp(port_no))) {
444             return u32_to_odp(port_no);
445         }
446     }
447
448     return ODPP_NONE;
449 }
450
451 static int
452 create_dp_netdev(const char *name, const struct dpif_class *class,
453                  struct dp_netdev **dpp)
454     OVS_REQUIRES(dp_netdev_mutex)
455 {
456     struct dp_netdev *dp;
457     int error;
458
459     dp = xzalloc(sizeof *dp);
460     shash_add(&dp_netdevs, name, dp);
461
462     *CONST_CAST(const struct dpif_class **, &dp->class) = class;
463     *CONST_CAST(const char **, &dp->name) = xstrdup(name);
464     ovs_refcount_init(&dp->ref_cnt);
465     atomic_flag_clear(&dp->destroyed);
466
467     ovs_mutex_init(&dp->flow_mutex);
468     classifier_init(&dp->cls, NULL);
469     hmap_init(&dp->flow_table);
470
471     fat_rwlock_init(&dp->queue_rwlock);
472
473     ovsthread_stats_init(&dp->stats);
474
475     ovs_rwlock_init(&dp->port_rwlock);
476     hmap_init(&dp->ports);
477     dp->port_seq = seq_create();
478     latch_init(&dp->exit_latch);
479
480     ovs_rwlock_wrlock(&dp->port_rwlock);
481     error = do_add_port(dp, name, "internal", ODPP_LOCAL);
482     ovs_rwlock_unlock(&dp->port_rwlock);
483     if (error) {
484         dp_netdev_free(dp);
485         return error;
486     }
487
488     *dpp = dp;
489     return 0;
490 }
491
492 static int
493 dpif_netdev_open(const struct dpif_class *class, const char *name,
494                  bool create, struct dpif **dpifp)
495 {
496     struct dp_netdev *dp;
497     int error;
498
499     ovs_mutex_lock(&dp_netdev_mutex);
500     dp = shash_find_data(&dp_netdevs, name);
501     if (!dp) {
502         error = create ? create_dp_netdev(name, class, &dp) : ENODEV;
503     } else {
504         error = (dp->class != class ? EINVAL
505                  : create ? EEXIST
506                  : 0);
507     }
508     if (!error) {
509         *dpifp = create_dpif_netdev(dp);
510     }
511     ovs_mutex_unlock(&dp_netdev_mutex);
512
513     return error;
514 }
515
516 static void
517 dp_netdev_purge_queues(struct dp_netdev *dp)
518     OVS_REQ_WRLOCK(dp->queue_rwlock)
519 {
520     int i;
521
522     for (i = 0; i < dp->n_handlers; i++) {
523         struct dp_netdev_queue *q = &dp->handler_queues[i];
524
525         ovs_mutex_lock(&q->mutex);
526         while (q->tail != q->head) {
527             struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
528             ofpbuf_uninit(&u->upcall.packet);
529             ofpbuf_uninit(&u->buf);
530         }
531         ovs_mutex_unlock(&q->mutex);
532     }
533 }
534
535 /* Requires dp_netdev_mutex so that we can't get a new reference to 'dp'
536  * through the 'dp_netdevs' shash while freeing 'dp'. */
537 static void
538 dp_netdev_free(struct dp_netdev *dp)
539     OVS_REQUIRES(dp_netdev_mutex)
540 {
541     struct dp_netdev_port *port, *next;
542     struct dp_netdev_stats *bucket;
543     int i;
544
545     shash_find_and_delete(&dp_netdevs, dp->name);
546
547     dp_netdev_set_pmd_threads(dp, 0);
548     free(dp->pmd_threads);
549
550     dp_netdev_flow_flush(dp);
551     ovs_rwlock_wrlock(&dp->port_rwlock);
552     HMAP_FOR_EACH_SAFE (port, next, node, &dp->ports) {
553         do_del_port(dp, port->port_no);
554     }
555     ovs_rwlock_unlock(&dp->port_rwlock);
556
557     OVSTHREAD_STATS_FOR_EACH_BUCKET (bucket, i, &dp->stats) {
558         ovs_mutex_destroy(&bucket->mutex);
559         free_cacheline(bucket);
560     }
561     ovsthread_stats_destroy(&dp->stats);
562
563     fat_rwlock_wrlock(&dp->queue_rwlock);
564     dp_netdev_destroy_all_queues(dp);
565     fat_rwlock_unlock(&dp->queue_rwlock);
566
567     fat_rwlock_destroy(&dp->queue_rwlock);
568
569     classifier_destroy(&dp->cls);
570     hmap_destroy(&dp->flow_table);
571     ovs_mutex_destroy(&dp->flow_mutex);
572     seq_destroy(dp->port_seq);
573     hmap_destroy(&dp->ports);
574     latch_destroy(&dp->exit_latch);
575     free(CONST_CAST(char *, dp->name));
576     free(dp);
577 }
578
579 static void
580 dp_netdev_unref(struct dp_netdev *dp)
581 {
582     if (dp) {
583         /* Take dp_netdev_mutex so that, if dp->ref_cnt falls to zero, we can't
584          * get a new reference to 'dp' through the 'dp_netdevs' shash. */
585         ovs_mutex_lock(&dp_netdev_mutex);
586         if (ovs_refcount_unref(&dp->ref_cnt) == 1) {
587             dp_netdev_free(dp);
588         }
589         ovs_mutex_unlock(&dp_netdev_mutex);
590     }
591 }
592
593 static void
594 dpif_netdev_close(struct dpif *dpif)
595 {
596     struct dp_netdev *dp = get_dp_netdev(dpif);
597
598     dp_netdev_unref(dp);
599     free(dpif);
600 }
601
602 static int
603 dpif_netdev_destroy(struct dpif *dpif)
604 {
605     struct dp_netdev *dp = get_dp_netdev(dpif);
606
607     if (!atomic_flag_test_and_set(&dp->destroyed)) {
608         if (ovs_refcount_unref(&dp->ref_cnt) == 1) {
609             /* Can't happen: 'dpif' still owns a reference to 'dp'. */
610             OVS_NOT_REACHED();
611         }
612     }
613
614     return 0;
615 }
616
617 static int
618 dpif_netdev_get_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
619 {
620     struct dp_netdev *dp = get_dp_netdev(dpif);
621     struct dp_netdev_stats *bucket;
622     size_t i;
623
624     fat_rwlock_rdlock(&dp->cls.rwlock);
625     stats->n_flows = hmap_count(&dp->flow_table);
626     fat_rwlock_unlock(&dp->cls.rwlock);
627
628     stats->n_hit = stats->n_missed = stats->n_lost = 0;
629     OVSTHREAD_STATS_FOR_EACH_BUCKET (bucket, i, &dp->stats) {
630         ovs_mutex_lock(&bucket->mutex);
631         stats->n_hit += bucket->n[DP_STAT_HIT];
632         stats->n_missed += bucket->n[DP_STAT_MISS];
633         stats->n_lost += bucket->n[DP_STAT_LOST];
634         ovs_mutex_unlock(&bucket->mutex);
635     }
636     stats->n_masks = UINT32_MAX;
637     stats->n_mask_hit = UINT64_MAX;
638
639     return 0;
640 }
641
642 static void
643 dp_netdev_reload_pmd_threads(struct dp_netdev *dp)
644 {
645     int i;
646
647     for (i = 0; i < dp->n_pmd_threads; i++) {
648         struct pmd_thread *f = &dp->pmd_threads[i];
649         int id;
650
651         atomic_add(&f->change_seq, 1, &id);
652    }
653 }
654
655 static int
656 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
657             odp_port_t port_no)
658     OVS_REQ_WRLOCK(dp->port_rwlock)
659 {
660     struct netdev_saved_flags *sf;
661     struct dp_netdev_port *port;
662     struct netdev *netdev;
663     enum netdev_flags flags;
664     const char *open_type;
665     int error;
666     int i;
667
668     /* XXX reject devices already in some dp_netdev. */
669
670     /* Open and validate network device. */
671     open_type = dpif_netdev_port_open_type(dp->class, type);
672     error = netdev_open(devname, open_type, &netdev);
673     if (error) {
674         return error;
675     }
676     /* XXX reject non-Ethernet devices */
677
678     netdev_get_flags(netdev, &flags);
679     if (flags & NETDEV_LOOPBACK) {
680         VLOG_ERR("%s: cannot add a loopback device", devname);
681         netdev_close(netdev);
682         return EINVAL;
683     }
684
685     port = xzalloc(sizeof *port);
686     port->port_no = port_no;
687     port->netdev = netdev;
688     port->rxq = xmalloc(sizeof *port->rxq * netdev_n_rxq(netdev));
689     port->type = xstrdup(type);
690     for (i = 0; i < netdev_n_rxq(netdev); i++) {
691         error = netdev_rxq_open(netdev, &port->rxq[i], i);
692         if (error
693             && !(error == EOPNOTSUPP && dpif_netdev_class_is_dummy(dp->class))) {
694             VLOG_ERR("%s: cannot receive packets on this network device (%s)",
695                      devname, ovs_strerror(errno));
696             netdev_close(netdev);
697             return error;
698         }
699     }
700
701     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, &sf);
702     if (error) {
703         for (i = 0; i < netdev_n_rxq(netdev); i++) {
704             netdev_rxq_close(port->rxq[i]);
705         }
706         netdev_close(netdev);
707         free(port->rxq);
708         free(port);
709         return error;
710     }
711     port->sf = sf;
712
713     if (netdev_is_pmd(netdev)) {
714         dp->pmd_count++;
715         dp_netdev_set_pmd_threads(dp, NR_THREADS);
716         dp_netdev_reload_pmd_threads(dp);
717     }
718     ovs_refcount_init(&port->ref_cnt);
719
720     hmap_insert(&dp->ports, &port->node, hash_int(odp_to_u32(port_no), 0));
721     seq_change(dp->port_seq);
722
723     return 0;
724 }
725
726 static int
727 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
728                      odp_port_t *port_nop)
729 {
730     struct dp_netdev *dp = get_dp_netdev(dpif);
731     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
732     const char *dpif_port;
733     odp_port_t port_no;
734     int error;
735
736     ovs_rwlock_wrlock(&dp->port_rwlock);
737     dpif_port = netdev_vport_get_dpif_port(netdev, namebuf, sizeof namebuf);
738     if (*port_nop != ODPP_NONE) {
739         port_no = *port_nop;
740         error = dp_netdev_lookup_port(dp, *port_nop) ? EBUSY : 0;
741     } else {
742         port_no = choose_port(dp, dpif_port);
743         error = port_no == ODPP_NONE ? EFBIG : 0;
744     }
745     if (!error) {
746         *port_nop = port_no;
747         error = do_add_port(dp, dpif_port, netdev_get_type(netdev), port_no);
748     }
749     ovs_rwlock_unlock(&dp->port_rwlock);
750
751     return error;
752 }
753
754 static int
755 dpif_netdev_port_del(struct dpif *dpif, odp_port_t port_no)
756 {
757     struct dp_netdev *dp = get_dp_netdev(dpif);
758     int error;
759
760     ovs_rwlock_wrlock(&dp->port_rwlock);
761     error = port_no == ODPP_LOCAL ? EINVAL : do_del_port(dp, port_no);
762     ovs_rwlock_unlock(&dp->port_rwlock);
763
764     return error;
765 }
766
767 static bool
768 is_valid_port_number(odp_port_t port_no)
769 {
770     return port_no != ODPP_NONE;
771 }
772
773 static struct dp_netdev_port *
774 dp_netdev_lookup_port(const struct dp_netdev *dp, odp_port_t port_no)
775     OVS_REQ_RDLOCK(dp->port_rwlock)
776 {
777     struct dp_netdev_port *port;
778
779     HMAP_FOR_EACH_IN_BUCKET (port, node, hash_int(odp_to_u32(port_no), 0),
780                              &dp->ports) {
781         if (port->port_no == port_no) {
782             return port;
783         }
784     }
785     return NULL;
786 }
787
788 static int
789 get_port_by_number(struct dp_netdev *dp,
790                    odp_port_t port_no, struct dp_netdev_port **portp)
791     OVS_REQ_RDLOCK(dp->port_rwlock)
792 {
793     if (!is_valid_port_number(port_no)) {
794         *portp = NULL;
795         return EINVAL;
796     } else {
797         *portp = dp_netdev_lookup_port(dp, port_no);
798         return *portp ? 0 : ENOENT;
799     }
800 }
801
802 static void
803 port_ref(struct dp_netdev_port *port)
804 {
805     if (port) {
806         ovs_refcount_ref(&port->ref_cnt);
807     }
808 }
809
810 static void
811 port_unref(struct dp_netdev_port *port)
812 {
813     if (port && ovs_refcount_unref(&port->ref_cnt) == 1) {
814         int n_rxq;
815         int i;
816
817         netdev_close(port->netdev);
818         netdev_restore_flags(port->sf);
819
820         n_rxq = netdev_n_rxq(port->netdev);
821         for (i = 0; i < n_rxq; i++) {
822             netdev_rxq_close(port->rxq[i]);
823         }
824         free(port->type);
825         free(port);
826     }
827 }
828
829 static int
830 get_port_by_name(struct dp_netdev *dp,
831                  const char *devname, struct dp_netdev_port **portp)
832     OVS_REQ_RDLOCK(dp->port_rwlock)
833 {
834     struct dp_netdev_port *port;
835
836     HMAP_FOR_EACH (port, node, &dp->ports) {
837         if (!strcmp(netdev_get_name(port->netdev), devname)) {
838             *portp = port;
839             return 0;
840         }
841     }
842     return ENOENT;
843 }
844
845 static int
846 do_del_port(struct dp_netdev *dp, odp_port_t port_no)
847     OVS_REQ_WRLOCK(dp->port_rwlock)
848 {
849     struct dp_netdev_port *port;
850     int error;
851
852     error = get_port_by_number(dp, port_no, &port);
853     if (error) {
854         return error;
855     }
856
857     hmap_remove(&dp->ports, &port->node);
858     seq_change(dp->port_seq);
859     if (netdev_is_pmd(port->netdev)) {
860         dp_netdev_reload_pmd_threads(dp);
861     }
862
863     port_unref(port);
864     return 0;
865 }
866
867 static void
868 answer_port_query(const struct dp_netdev_port *port,
869                   struct dpif_port *dpif_port)
870 {
871     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
872     dpif_port->type = xstrdup(port->type);
873     dpif_port->port_no = port->port_no;
874 }
875
876 static int
877 dpif_netdev_port_query_by_number(const struct dpif *dpif, odp_port_t port_no,
878                                  struct dpif_port *dpif_port)
879 {
880     struct dp_netdev *dp = get_dp_netdev(dpif);
881     struct dp_netdev_port *port;
882     int error;
883
884     ovs_rwlock_rdlock(&dp->port_rwlock);
885     error = get_port_by_number(dp, port_no, &port);
886     if (!error && dpif_port) {
887         answer_port_query(port, dpif_port);
888     }
889     ovs_rwlock_unlock(&dp->port_rwlock);
890
891     return error;
892 }
893
894 static int
895 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
896                                struct dpif_port *dpif_port)
897 {
898     struct dp_netdev *dp = get_dp_netdev(dpif);
899     struct dp_netdev_port *port;
900     int error;
901
902     ovs_rwlock_rdlock(&dp->port_rwlock);
903     error = get_port_by_name(dp, devname, &port);
904     if (!error && dpif_port) {
905         answer_port_query(port, dpif_port);
906     }
907     ovs_rwlock_unlock(&dp->port_rwlock);
908
909     return error;
910 }
911
912 static void
913 dp_netdev_flow_free(struct dp_netdev_flow *flow)
914 {
915     struct dp_netdev_flow_stats *bucket;
916     size_t i;
917
918     OVSTHREAD_STATS_FOR_EACH_BUCKET (bucket, i, &flow->stats) {
919         ovs_mutex_destroy(&bucket->mutex);
920         free_cacheline(bucket);
921     }
922     ovsthread_stats_destroy(&flow->stats);
923
924     cls_rule_destroy(CONST_CAST(struct cls_rule *, &flow->cr));
925     dp_netdev_actions_free(dp_netdev_flow_get_actions(flow));
926     free(flow);
927 }
928
929 static void
930 dp_netdev_remove_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
931     OVS_REQ_WRLOCK(dp->cls.rwlock)
932     OVS_REQUIRES(dp->flow_mutex)
933 {
934     struct cls_rule *cr = CONST_CAST(struct cls_rule *, &flow->cr);
935     struct hmap_node *node = CONST_CAST(struct hmap_node *, &flow->node);
936
937     classifier_remove(&dp->cls, cr);
938     hmap_remove(&dp->flow_table, node);
939     ovsrcu_postpone(dp_netdev_flow_free, flow);
940 }
941
942 static void
943 dp_netdev_flow_flush(struct dp_netdev *dp)
944 {
945     struct dp_netdev_flow *netdev_flow, *next;
946
947     ovs_mutex_lock(&dp->flow_mutex);
948     fat_rwlock_wrlock(&dp->cls.rwlock);
949     HMAP_FOR_EACH_SAFE (netdev_flow, next, node, &dp->flow_table) {
950         dp_netdev_remove_flow(dp, netdev_flow);
951     }
952     fat_rwlock_unlock(&dp->cls.rwlock);
953     ovs_mutex_unlock(&dp->flow_mutex);
954 }
955
956 static int
957 dpif_netdev_flow_flush(struct dpif *dpif)
958 {
959     struct dp_netdev *dp = get_dp_netdev(dpif);
960
961     dp_netdev_flow_flush(dp);
962     return 0;
963 }
964
965 struct dp_netdev_port_state {
966     uint32_t bucket;
967     uint32_t offset;
968     char *name;
969 };
970
971 static int
972 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
973 {
974     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
975     return 0;
976 }
977
978 static int
979 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
980                            struct dpif_port *dpif_port)
981 {
982     struct dp_netdev_port_state *state = state_;
983     struct dp_netdev *dp = get_dp_netdev(dpif);
984     struct hmap_node *node;
985     int retval;
986
987     ovs_rwlock_rdlock(&dp->port_rwlock);
988     node = hmap_at_position(&dp->ports, &state->bucket, &state->offset);
989     if (node) {
990         struct dp_netdev_port *port;
991
992         port = CONTAINER_OF(node, struct dp_netdev_port, node);
993
994         free(state->name);
995         state->name = xstrdup(netdev_get_name(port->netdev));
996         dpif_port->name = state->name;
997         dpif_port->type = port->type;
998         dpif_port->port_no = port->port_no;
999
1000         retval = 0;
1001     } else {
1002         retval = EOF;
1003     }
1004     ovs_rwlock_unlock(&dp->port_rwlock);
1005
1006     return retval;
1007 }
1008
1009 static int
1010 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
1011 {
1012     struct dp_netdev_port_state *state = state_;
1013     free(state->name);
1014     free(state);
1015     return 0;
1016 }
1017
1018 static int
1019 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
1020 {
1021     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
1022     uint64_t new_port_seq;
1023     int error;
1024
1025     new_port_seq = seq_read(dpif->dp->port_seq);
1026     if (dpif->last_port_seq != new_port_seq) {
1027         dpif->last_port_seq = new_port_seq;
1028         error = ENOBUFS;
1029     } else {
1030         error = EAGAIN;
1031     }
1032
1033     return error;
1034 }
1035
1036 static void
1037 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
1038 {
1039     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
1040
1041     seq_wait(dpif->dp->port_seq, dpif->last_port_seq);
1042 }
1043
1044 static struct dp_netdev_flow *
1045 dp_netdev_flow_cast(const struct cls_rule *cr)
1046 {
1047     return cr ? CONTAINER_OF(cr, struct dp_netdev_flow, cr) : NULL;
1048 }
1049
1050 static struct dp_netdev_flow *
1051 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct miniflow *key)
1052     OVS_EXCLUDED(dp->cls.rwlock)
1053 {
1054     struct dp_netdev_flow *netdev_flow;
1055     struct cls_rule *rule;
1056
1057     fat_rwlock_rdlock(&dp->cls.rwlock);
1058     rule = classifier_lookup_miniflow_first(&dp->cls, key);
1059     netdev_flow = dp_netdev_flow_cast(rule);
1060     fat_rwlock_unlock(&dp->cls.rwlock);
1061
1062     return netdev_flow;
1063 }
1064
1065 static struct dp_netdev_flow *
1066 dp_netdev_find_flow(const struct dp_netdev *dp, const struct flow *flow)
1067     OVS_REQ_RDLOCK(dp->cls.rwlock)
1068 {
1069     struct dp_netdev_flow *netdev_flow;
1070
1071     HMAP_FOR_EACH_WITH_HASH (netdev_flow, node, flow_hash(flow, 0),
1072                              &dp->flow_table) {
1073         if (flow_equal(&netdev_flow->flow, flow)) {
1074             return netdev_flow;
1075         }
1076     }
1077
1078     return NULL;
1079 }
1080
1081 static void
1082 get_dpif_flow_stats(struct dp_netdev_flow *netdev_flow,
1083                     struct dpif_flow_stats *stats)
1084 {
1085     struct dp_netdev_flow_stats *bucket;
1086     size_t i;
1087
1088     memset(stats, 0, sizeof *stats);
1089     OVSTHREAD_STATS_FOR_EACH_BUCKET (bucket, i, &netdev_flow->stats) {
1090         ovs_mutex_lock(&bucket->mutex);
1091         stats->n_packets += bucket->packet_count;
1092         stats->n_bytes += bucket->byte_count;
1093         stats->used = MAX(stats->used, bucket->used);
1094         stats->tcp_flags |= bucket->tcp_flags;
1095         ovs_mutex_unlock(&bucket->mutex);
1096     }
1097 }
1098
1099 static int
1100 dpif_netdev_mask_from_nlattrs(const struct nlattr *key, uint32_t key_len,
1101                               const struct nlattr *mask_key,
1102                               uint32_t mask_key_len, const struct flow *flow,
1103                               struct flow *mask)
1104 {
1105     if (mask_key_len) {
1106         enum odp_key_fitness fitness;
1107
1108         fitness = odp_flow_key_to_mask(mask_key, mask_key_len, mask, flow);
1109         if (fitness) {
1110             /* This should not happen: it indicates that
1111              * odp_flow_key_from_mask() and odp_flow_key_to_mask()
1112              * disagree on the acceptable form of a mask.  Log the problem
1113              * as an error, with enough details to enable debugging. */
1114             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1115
1116             if (!VLOG_DROP_ERR(&rl)) {
1117                 struct ds s;
1118
1119                 ds_init(&s);
1120                 odp_flow_format(key, key_len, mask_key, mask_key_len, NULL, &s,
1121                                 true);
1122                 VLOG_ERR("internal error parsing flow mask %s (%s)",
1123                          ds_cstr(&s), odp_key_fitness_to_string(fitness));
1124                 ds_destroy(&s);
1125             }
1126
1127             return EINVAL;
1128         }
1129     } else {
1130         enum mf_field_id id;
1131         /* No mask key, unwildcard everything except fields whose
1132          * prerequisities are not met. */
1133         memset(mask, 0x0, sizeof *mask);
1134
1135         for (id = 0; id < MFF_N_IDS; ++id) {
1136             /* Skip registers and metadata. */
1137             if (!(id >= MFF_REG0 && id < MFF_REG0 + FLOW_N_REGS)
1138                 && id != MFF_METADATA) {
1139                 const struct mf_field *mf = mf_from_id(id);
1140                 if (mf_are_prereqs_ok(mf, flow)) {
1141                     mf_mask_field(mf, mask);
1142                 }
1143             }
1144         }
1145     }
1146
1147     /* Force unwildcard the in_port.
1148      *
1149      * We need to do this even in the case where we unwildcard "everything"
1150      * above because "everything" only includes the 16-bit OpenFlow port number
1151      * mask->in_port.ofp_port, which only covers half of the 32-bit datapath
1152      * port number mask->in_port.odp_port. */
1153     mask->in_port.odp_port = u32_to_odp(UINT32_MAX);
1154
1155     return 0;
1156 }
1157
1158 static int
1159 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
1160                               struct flow *flow)
1161 {
1162     odp_port_t in_port;
1163
1164     if (odp_flow_key_to_flow(key, key_len, flow)) {
1165         /* This should not happen: it indicates that odp_flow_key_from_flow()
1166          * and odp_flow_key_to_flow() disagree on the acceptable form of a
1167          * flow.  Log the problem as an error, with enough details to enable
1168          * debugging. */
1169         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1170
1171         if (!VLOG_DROP_ERR(&rl)) {
1172             struct ds s;
1173
1174             ds_init(&s);
1175             odp_flow_format(key, key_len, NULL, 0, NULL, &s, true);
1176             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
1177             ds_destroy(&s);
1178         }
1179
1180         return EINVAL;
1181     }
1182
1183     in_port = flow->in_port.odp_port;
1184     if (!is_valid_port_number(in_port) && in_port != ODPP_NONE) {
1185         return EINVAL;
1186     }
1187
1188     return 0;
1189 }
1190
1191 static int
1192 dpif_netdev_flow_get(const struct dpif *dpif,
1193                      const struct nlattr *nl_key, size_t nl_key_len,
1194                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
1195 {
1196     struct dp_netdev *dp = get_dp_netdev(dpif);
1197     struct dp_netdev_flow *netdev_flow;
1198     struct flow key;
1199     int error;
1200
1201     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
1202     if (error) {
1203         return error;
1204     }
1205
1206     fat_rwlock_rdlock(&dp->cls.rwlock);
1207     netdev_flow = dp_netdev_find_flow(dp, &key);
1208     fat_rwlock_unlock(&dp->cls.rwlock);
1209
1210     if (netdev_flow) {
1211         if (stats) {
1212             get_dpif_flow_stats(netdev_flow, stats);
1213         }
1214
1215         if (actionsp) {
1216             struct dp_netdev_actions *actions;
1217
1218             actions = dp_netdev_flow_get_actions(netdev_flow);
1219             *actionsp = ofpbuf_clone_data(actions->actions, actions->size);
1220         }
1221      } else {
1222         error = ENOENT;
1223     }
1224
1225     return error;
1226 }
1227
1228 static int
1229 dp_netdev_flow_add(struct dp_netdev *dp, const struct flow *flow,
1230                    const struct flow_wildcards *wc,
1231                    const struct nlattr *actions,
1232                    size_t actions_len)
1233     OVS_REQUIRES(dp->flow_mutex)
1234 {
1235     struct dp_netdev_flow *netdev_flow;
1236     struct match match;
1237
1238     netdev_flow = xzalloc(sizeof *netdev_flow);
1239     *CONST_CAST(struct flow *, &netdev_flow->flow) = *flow;
1240
1241     ovsthread_stats_init(&netdev_flow->stats);
1242
1243     ovsrcu_set(&netdev_flow->actions,
1244                dp_netdev_actions_create(actions, actions_len));
1245
1246     match_init(&match, flow, wc);
1247     cls_rule_init(CONST_CAST(struct cls_rule *, &netdev_flow->cr),
1248                   &match, NETDEV_RULE_PRIORITY);
1249     fat_rwlock_wrlock(&dp->cls.rwlock);
1250     classifier_insert(&dp->cls,
1251                       CONST_CAST(struct cls_rule *, &netdev_flow->cr));
1252     hmap_insert(&dp->flow_table,
1253                 CONST_CAST(struct hmap_node *, &netdev_flow->node),
1254                 flow_hash(flow, 0));
1255     fat_rwlock_unlock(&dp->cls.rwlock);
1256
1257     return 0;
1258 }
1259
1260 static void
1261 clear_stats(struct dp_netdev_flow *netdev_flow)
1262 {
1263     struct dp_netdev_flow_stats *bucket;
1264     size_t i;
1265
1266     OVSTHREAD_STATS_FOR_EACH_BUCKET (bucket, i, &netdev_flow->stats) {
1267         ovs_mutex_lock(&bucket->mutex);
1268         bucket->used = 0;
1269         bucket->packet_count = 0;
1270         bucket->byte_count = 0;
1271         bucket->tcp_flags = 0;
1272         ovs_mutex_unlock(&bucket->mutex);
1273     }
1274 }
1275
1276 static int
1277 dpif_netdev_flow_put(struct dpif *dpif, const struct dpif_flow_put *put)
1278 {
1279     struct dp_netdev *dp = get_dp_netdev(dpif);
1280     struct dp_netdev_flow *netdev_flow;
1281     struct flow flow;
1282     struct miniflow miniflow;
1283     struct flow_wildcards wc;
1284     int error;
1285
1286     error = dpif_netdev_flow_from_nlattrs(put->key, put->key_len, &flow);
1287     if (error) {
1288         return error;
1289     }
1290     error = dpif_netdev_mask_from_nlattrs(put->key, put->key_len,
1291                                           put->mask, put->mask_len,
1292                                           &flow, &wc.masks);
1293     if (error) {
1294         return error;
1295     }
1296     miniflow_init(&miniflow, &flow);
1297
1298     ovs_mutex_lock(&dp->flow_mutex);
1299     netdev_flow = dp_netdev_lookup_flow(dp, &miniflow);
1300     if (!netdev_flow) {
1301         if (put->flags & DPIF_FP_CREATE) {
1302             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
1303                 if (put->stats) {
1304                     memset(put->stats, 0, sizeof *put->stats);
1305                 }
1306                 error = dp_netdev_flow_add(dp, &flow, &wc, put->actions,
1307                                            put->actions_len);
1308             } else {
1309                 error = EFBIG;
1310             }
1311         } else {
1312             error = ENOENT;
1313         }
1314     } else {
1315         if (put->flags & DPIF_FP_MODIFY
1316             && flow_equal(&flow, &netdev_flow->flow)) {
1317             struct dp_netdev_actions *new_actions;
1318             struct dp_netdev_actions *old_actions;
1319
1320             new_actions = dp_netdev_actions_create(put->actions,
1321                                                    put->actions_len);
1322
1323             old_actions = dp_netdev_flow_get_actions(netdev_flow);
1324             ovsrcu_set(&netdev_flow->actions, new_actions);
1325
1326             if (put->stats) {
1327                 get_dpif_flow_stats(netdev_flow, put->stats);
1328             }
1329             if (put->flags & DPIF_FP_ZERO_STATS) {
1330                 clear_stats(netdev_flow);
1331             }
1332
1333             ovsrcu_postpone(dp_netdev_actions_free, old_actions);
1334         } else if (put->flags & DPIF_FP_CREATE) {
1335             error = EEXIST;
1336         } else {
1337             /* Overlapping flow. */
1338             error = EINVAL;
1339         }
1340     }
1341     ovs_mutex_unlock(&dp->flow_mutex);
1342
1343     return error;
1344 }
1345
1346 static int
1347 dpif_netdev_flow_del(struct dpif *dpif, const struct dpif_flow_del *del)
1348 {
1349     struct dp_netdev *dp = get_dp_netdev(dpif);
1350     struct dp_netdev_flow *netdev_flow;
1351     struct flow key;
1352     int error;
1353
1354     error = dpif_netdev_flow_from_nlattrs(del->key, del->key_len, &key);
1355     if (error) {
1356         return error;
1357     }
1358
1359     ovs_mutex_lock(&dp->flow_mutex);
1360     fat_rwlock_wrlock(&dp->cls.rwlock);
1361     netdev_flow = dp_netdev_find_flow(dp, &key);
1362     if (netdev_flow) {
1363         if (del->stats) {
1364             get_dpif_flow_stats(netdev_flow, del->stats);
1365         }
1366         dp_netdev_remove_flow(dp, netdev_flow);
1367     } else {
1368         error = ENOENT;
1369     }
1370     fat_rwlock_unlock(&dp->cls.rwlock);
1371     ovs_mutex_unlock(&dp->flow_mutex);
1372
1373     return error;
1374 }
1375
1376 struct dp_netdev_flow_state {
1377     struct odputil_keybuf keybuf;
1378     struct odputil_keybuf maskbuf;
1379     struct dpif_flow_stats stats;
1380 };
1381
1382 struct dp_netdev_flow_iter {
1383     uint32_t bucket;
1384     uint32_t offset;
1385     int status;
1386     struct ovs_mutex mutex;
1387 };
1388
1389 static void
1390 dpif_netdev_flow_dump_state_init(void **statep)
1391 {
1392     struct dp_netdev_flow_state *state;
1393
1394     *statep = state = xmalloc(sizeof *state);
1395 }
1396
1397 static void
1398 dpif_netdev_flow_dump_state_uninit(void *state_)
1399 {
1400     struct dp_netdev_flow_state *state = state_;
1401
1402     free(state);
1403 }
1404
1405 static int
1406 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **iterp)
1407 {
1408     struct dp_netdev_flow_iter *iter;
1409
1410     *iterp = iter = xmalloc(sizeof *iter);
1411     iter->bucket = 0;
1412     iter->offset = 0;
1413     iter->status = 0;
1414     ovs_mutex_init(&iter->mutex);
1415     return 0;
1416 }
1417
1418 /* XXX the caller must use 'actions' without quiescing */
1419 static int
1420 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *iter_, void *state_,
1421                            const struct nlattr **key, size_t *key_len,
1422                            const struct nlattr **mask, size_t *mask_len,
1423                            const struct nlattr **actions, size_t *actions_len,
1424                            const struct dpif_flow_stats **stats)
1425 {
1426     struct dp_netdev_flow_iter *iter = iter_;
1427     struct dp_netdev_flow_state *state = state_;
1428     struct dp_netdev *dp = get_dp_netdev(dpif);
1429     struct dp_netdev_flow *netdev_flow;
1430     struct flow_wildcards wc;
1431     int error;
1432
1433     ovs_mutex_lock(&iter->mutex);
1434     error = iter->status;
1435     if (!error) {
1436         struct hmap_node *node;
1437
1438         fat_rwlock_rdlock(&dp->cls.rwlock);
1439         node = hmap_at_position(&dp->flow_table, &iter->bucket, &iter->offset);
1440         if (node) {
1441             netdev_flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
1442         }
1443         fat_rwlock_unlock(&dp->cls.rwlock);
1444         if (!node) {
1445             iter->status = error = EOF;
1446         }
1447     }
1448     ovs_mutex_unlock(&iter->mutex);
1449     if (error) {
1450         return error;
1451     }
1452
1453     minimask_expand(&netdev_flow->cr.match.mask, &wc);
1454
1455     if (key) {
1456         struct ofpbuf buf;
1457
1458         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
1459         odp_flow_key_from_flow(&buf, &netdev_flow->flow, &wc.masks,
1460                                netdev_flow->flow.in_port.odp_port);
1461
1462         *key = ofpbuf_data(&buf);
1463         *key_len = ofpbuf_size(&buf);
1464     }
1465
1466     if (key && mask) {
1467         struct ofpbuf buf;
1468
1469         ofpbuf_use_stack(&buf, &state->maskbuf, sizeof state->maskbuf);
1470         odp_flow_key_from_mask(&buf, &wc.masks, &netdev_flow->flow,
1471                                odp_to_u32(wc.masks.in_port.odp_port),
1472                                SIZE_MAX);
1473
1474         *mask = ofpbuf_data(&buf);
1475         *mask_len = ofpbuf_size(&buf);
1476     }
1477
1478     if (actions || stats) {
1479         if (actions) {
1480             struct dp_netdev_actions *dp_actions =
1481                 dp_netdev_flow_get_actions(netdev_flow);
1482
1483             *actions = dp_actions->actions;
1484             *actions_len = dp_actions->size;
1485         }
1486
1487         if (stats) {
1488             get_dpif_flow_stats(netdev_flow, &state->stats);
1489             *stats = &state->stats;
1490         }
1491     }
1492
1493     return 0;
1494 }
1495
1496 static int
1497 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *iter_)
1498 {
1499     struct dp_netdev_flow_iter *iter = iter_;
1500
1501     ovs_mutex_destroy(&iter->mutex);
1502     free(iter);
1503     return 0;
1504 }
1505
1506 static int
1507 dpif_netdev_execute(struct dpif *dpif, struct dpif_execute *execute)
1508 {
1509     struct dp_netdev *dp = get_dp_netdev(dpif);
1510     struct pkt_metadata *md = &execute->md;
1511     struct {
1512         struct miniflow flow;
1513         uint32_t buf[FLOW_U32S];
1514     } key;
1515
1516     if (ofpbuf_size(execute->packet) < ETH_HEADER_LEN ||
1517         ofpbuf_size(execute->packet) > UINT16_MAX) {
1518         return EINVAL;
1519     }
1520
1521     /* Extract flow key. */
1522     miniflow_initialize(&key.flow, key.buf);
1523     miniflow_extract(execute->packet, md, &key.flow);
1524
1525     ovs_rwlock_rdlock(&dp->port_rwlock);
1526     dp_netdev_execute_actions(dp, &key.flow, execute->packet, false, md,
1527                               execute->actions, execute->actions_len);
1528     ovs_rwlock_unlock(&dp->port_rwlock);
1529
1530     return 0;
1531 }
1532
1533 static void
1534 dp_netdev_destroy_all_queues(struct dp_netdev *dp)
1535     OVS_REQ_WRLOCK(dp->queue_rwlock)
1536 {
1537     size_t i;
1538
1539     dp_netdev_purge_queues(dp);
1540
1541     for (i = 0; i < dp->n_handlers; i++) {
1542         struct dp_netdev_queue *q = &dp->handler_queues[i];
1543
1544         ovs_mutex_destroy(&q->mutex);
1545         seq_destroy(q->seq);
1546     }
1547     free(dp->handler_queues);
1548     dp->handler_queues = NULL;
1549     dp->n_handlers = 0;
1550 }
1551
1552 static void
1553 dp_netdev_refresh_queues(struct dp_netdev *dp, uint32_t n_handlers)
1554     OVS_REQ_WRLOCK(dp->queue_rwlock)
1555 {
1556     if (dp->n_handlers != n_handlers) {
1557         size_t i;
1558
1559         dp_netdev_destroy_all_queues(dp);
1560
1561         dp->n_handlers = n_handlers;
1562         dp->handler_queues = xzalloc(n_handlers * sizeof *dp->handler_queues);
1563
1564         for (i = 0; i < n_handlers; i++) {
1565             struct dp_netdev_queue *q = &dp->handler_queues[i];
1566
1567             ovs_mutex_init(&q->mutex);
1568             q->seq = seq_create();
1569         }
1570     }
1571 }
1572
1573 static int
1574 dpif_netdev_recv_set(struct dpif *dpif, bool enable)
1575 {
1576     struct dp_netdev *dp = get_dp_netdev(dpif);
1577
1578     if ((dp->handler_queues != NULL) == enable) {
1579         return 0;
1580     }
1581
1582     fat_rwlock_wrlock(&dp->queue_rwlock);
1583     if (!enable) {
1584         dp_netdev_destroy_all_queues(dp);
1585     } else {
1586         dp_netdev_refresh_queues(dp, 1);
1587     }
1588     fat_rwlock_unlock(&dp->queue_rwlock);
1589
1590     return 0;
1591 }
1592
1593 static int
1594 dpif_netdev_handlers_set(struct dpif *dpif, uint32_t n_handlers)
1595 {
1596     struct dp_netdev *dp = get_dp_netdev(dpif);
1597
1598     fat_rwlock_wrlock(&dp->queue_rwlock);
1599     if (dp->handler_queues) {
1600         dp_netdev_refresh_queues(dp, n_handlers);
1601     }
1602     fat_rwlock_unlock(&dp->queue_rwlock);
1603
1604     return 0;
1605 }
1606
1607 static int
1608 dpif_netdev_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
1609                               uint32_t queue_id, uint32_t *priority)
1610 {
1611     *priority = queue_id;
1612     return 0;
1613 }
1614
1615 static bool
1616 dp_netdev_recv_check(const struct dp_netdev *dp, const uint32_t handler_id)
1617     OVS_REQ_RDLOCK(dp->queue_rwlock)
1618 {
1619     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1620
1621     if (!dp->handler_queues) {
1622         VLOG_WARN_RL(&rl, "receiving upcall disabled");
1623         return false;
1624     }
1625
1626     if (handler_id >= dp->n_handlers) {
1627         VLOG_WARN_RL(&rl, "handler index out of bound");
1628         return false;
1629     }
1630
1631     return true;
1632 }
1633
1634 static int
1635 dpif_netdev_recv(struct dpif *dpif, uint32_t handler_id,
1636                  struct dpif_upcall *upcall, struct ofpbuf *buf)
1637 {
1638     struct dp_netdev *dp = get_dp_netdev(dpif);
1639     struct dp_netdev_queue *q;
1640     int error = 0;
1641
1642     fat_rwlock_rdlock(&dp->queue_rwlock);
1643
1644     if (!dp_netdev_recv_check(dp, handler_id)) {
1645         error = EAGAIN;
1646         goto out;
1647     }
1648
1649     q = &dp->handler_queues[handler_id];
1650     ovs_mutex_lock(&q->mutex);
1651     if (q->head != q->tail) {
1652         struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
1653
1654         *upcall = u->upcall;
1655
1656         ofpbuf_uninit(buf);
1657         *buf = u->buf;
1658     } else {
1659         error = EAGAIN;
1660     }
1661     ovs_mutex_unlock(&q->mutex);
1662
1663 out:
1664     fat_rwlock_unlock(&dp->queue_rwlock);
1665
1666     return error;
1667 }
1668
1669 static void
1670 dpif_netdev_recv_wait(struct dpif *dpif, uint32_t handler_id)
1671 {
1672     struct dp_netdev *dp = get_dp_netdev(dpif);
1673     struct dp_netdev_queue *q;
1674     uint64_t seq;
1675
1676     fat_rwlock_rdlock(&dp->queue_rwlock);
1677
1678     if (!dp_netdev_recv_check(dp, handler_id)) {
1679         goto out;
1680     }
1681
1682     q = &dp->handler_queues[handler_id];
1683     ovs_mutex_lock(&q->mutex);
1684     seq = seq_read(q->seq);
1685     if (q->head != q->tail) {
1686         poll_immediate_wake();
1687     } else {
1688         seq_wait(q->seq, seq);
1689     }
1690
1691     ovs_mutex_unlock(&q->mutex);
1692
1693 out:
1694     fat_rwlock_unlock(&dp->queue_rwlock);
1695 }
1696
1697 static void
1698 dpif_netdev_recv_purge(struct dpif *dpif)
1699 {
1700     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1701
1702     fat_rwlock_wrlock(&dpif_netdev->dp->queue_rwlock);
1703     dp_netdev_purge_queues(dpif_netdev->dp);
1704     fat_rwlock_unlock(&dpif_netdev->dp->queue_rwlock);
1705 }
1706 \f
1707 /* Creates and returns a new 'struct dp_netdev_actions', with a reference count
1708  * of 1, whose actions are a copy of from the 'ofpacts_len' bytes of
1709  * 'ofpacts'. */
1710 struct dp_netdev_actions *
1711 dp_netdev_actions_create(const struct nlattr *actions, size_t size)
1712 {
1713     struct dp_netdev_actions *netdev_actions;
1714
1715     netdev_actions = xmalloc(sizeof *netdev_actions);
1716     netdev_actions->actions = xmemdup(actions, size);
1717     netdev_actions->size = size;
1718
1719     return netdev_actions;
1720 }
1721
1722 struct dp_netdev_actions *
1723 dp_netdev_flow_get_actions(const struct dp_netdev_flow *flow)
1724 {
1725     return ovsrcu_get(struct dp_netdev_actions *, &flow->actions);
1726 }
1727
1728 static void
1729 dp_netdev_actions_free(struct dp_netdev_actions *actions)
1730 {
1731     free(actions->actions);
1732     free(actions);
1733 }
1734 \f
1735
1736 static void
1737 dp_netdev_process_rxq_port(struct dp_netdev *dp,
1738                           struct dp_netdev_port *port,
1739                           struct netdev_rxq *rxq)
1740 {
1741     struct ofpbuf *packet[NETDEV_MAX_RX_BATCH];
1742     int error, c;
1743
1744     error = netdev_rxq_recv(rxq, packet, &c);
1745     if (!error) {
1746         struct pkt_metadata md = PKT_METADATA_INITIALIZER(port->port_no);
1747         int i;
1748
1749         for (i = 0; i < c; i++) {
1750             dp_netdev_port_input(dp, packet[i], &md);
1751         }
1752     } else if (error != EAGAIN && error != EOPNOTSUPP) {
1753         static struct vlog_rate_limit rl
1754             = VLOG_RATE_LIMIT_INIT(1, 5);
1755
1756         VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1757                     netdev_get_name(port->netdev),
1758                     ovs_strerror(error));
1759     }
1760 }
1761
1762 static void
1763 dpif_netdev_run(struct dpif *dpif)
1764 {
1765     struct dp_netdev_port *port;
1766     struct dp_netdev *dp = get_dp_netdev(dpif);
1767
1768     ovs_rwlock_rdlock(&dp->port_rwlock);
1769
1770     HMAP_FOR_EACH (port, node, &dp->ports) {
1771         if (!netdev_is_pmd(port->netdev)) {
1772             int i;
1773
1774             for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
1775                 dp_netdev_process_rxq_port(dp, port, port->rxq[i]);
1776             }
1777         }
1778     }
1779
1780     ovs_rwlock_unlock(&dp->port_rwlock);
1781 }
1782
1783 static void
1784 dpif_netdev_wait(struct dpif *dpif)
1785 {
1786     struct dp_netdev_port *port;
1787     struct dp_netdev *dp = get_dp_netdev(dpif);
1788
1789     ovs_rwlock_rdlock(&dp->port_rwlock);
1790
1791     HMAP_FOR_EACH (port, node, &dp->ports) {
1792         if (!netdev_is_pmd(port->netdev)) {
1793             int i;
1794
1795             for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
1796                 netdev_rxq_wait(port->rxq[i]);
1797             }
1798         }
1799     }
1800     ovs_rwlock_unlock(&dp->port_rwlock);
1801 }
1802
1803 struct rxq_poll {
1804     struct dp_netdev_port *port;
1805     struct netdev_rxq *rx;
1806 };
1807
1808 static int
1809 pmd_load_queues(struct pmd_thread *f,
1810                 struct rxq_poll **ppoll_list, int poll_cnt)
1811 {
1812     struct dp_netdev *dp = f->dp;
1813     struct rxq_poll *poll_list = *ppoll_list;
1814     struct dp_netdev_port *port;
1815     int id = f->id;
1816     int index;
1817     int i;
1818
1819     /* Simple scheduler for netdev rx polling. */
1820     ovs_rwlock_rdlock(&dp->port_rwlock);
1821     for (i = 0; i < poll_cnt; i++) {
1822          port_unref(poll_list[i].port);
1823     }
1824
1825     poll_cnt = 0;
1826     index = 0;
1827
1828     HMAP_FOR_EACH (port, node, &f->dp->ports) {
1829         if (netdev_is_pmd(port->netdev)) {
1830             int i;
1831
1832             for (i = 0; i < netdev_n_rxq(port->netdev); i++) {
1833                 if ((index % dp->n_pmd_threads) == id) {
1834                     poll_list = xrealloc(poll_list, sizeof *poll_list * (poll_cnt + 1));
1835
1836                     port_ref(port);
1837                     poll_list[poll_cnt].port = port;
1838                     poll_list[poll_cnt].rx = port->rxq[i];
1839                     poll_cnt++;
1840                 }
1841                 index++;
1842             }
1843         }
1844     }
1845
1846     ovs_rwlock_unlock(&dp->port_rwlock);
1847     *ppoll_list = poll_list;
1848     return poll_cnt;
1849 }
1850
1851 static void *
1852 pmd_thread_main(void *f_)
1853 {
1854     struct pmd_thread *f = f_;
1855     struct dp_netdev *dp = f->dp;
1856     unsigned int lc = 0;
1857     struct rxq_poll *poll_list;
1858     unsigned int port_seq;
1859     int poll_cnt;
1860     int i;
1861
1862     poll_cnt = 0;
1863     poll_list = NULL;
1864
1865     pmd_thread_setaffinity_cpu(f->id);
1866 reload:
1867     poll_cnt = pmd_load_queues(f, &poll_list, poll_cnt);
1868     atomic_read(&f->change_seq, &port_seq);
1869
1870     for (;;) {
1871         unsigned int c_port_seq;
1872         int i;
1873
1874         for (i = 0; i < poll_cnt; i++) {
1875             dp_netdev_process_rxq_port(dp,  poll_list[i].port, poll_list[i].rx);
1876         }
1877
1878         if (lc++ > 1024) {
1879             ovsrcu_quiesce();
1880
1881             /* TODO: need completely userspace based signaling method.
1882              * to keep this thread entirely in userspace.
1883              * For now using atomic counter. */
1884             lc = 0;
1885             atomic_read_explicit(&f->change_seq, &c_port_seq, memory_order_consume);
1886             if (c_port_seq != port_seq) {
1887                 break;
1888             }
1889         }
1890     }
1891
1892     if (!latch_is_set(&f->dp->exit_latch)){
1893         goto reload;
1894     }
1895
1896     for (i = 0; i < poll_cnt; i++) {
1897          port_unref(poll_list[i].port);
1898     }
1899
1900     free(poll_list);
1901     return NULL;
1902 }
1903
1904 static void
1905 dp_netdev_set_pmd_threads(struct dp_netdev *dp, int n)
1906 {
1907     int i;
1908
1909     if (n == dp->n_pmd_threads) {
1910         return;
1911     }
1912
1913     /* Stop existing threads. */
1914     latch_set(&dp->exit_latch);
1915     dp_netdev_reload_pmd_threads(dp);
1916     for (i = 0; i < dp->n_pmd_threads; i++) {
1917         struct pmd_thread *f = &dp->pmd_threads[i];
1918
1919         xpthread_join(f->thread, NULL);
1920     }
1921     latch_poll(&dp->exit_latch);
1922     free(dp->pmd_threads);
1923
1924     /* Start new threads. */
1925     dp->pmd_threads = xmalloc(n * sizeof *dp->pmd_threads);
1926     dp->n_pmd_threads = n;
1927
1928     for (i = 0; i < n; i++) {
1929         struct pmd_thread *f = &dp->pmd_threads[i];
1930
1931         f->dp = dp;
1932         f->id = i;
1933         atomic_store(&f->change_seq, 1);
1934
1935         /* Each thread will distribute all devices rx-queues among
1936          * themselves. */
1937         f->thread = ovs_thread_create("pmd", pmd_thread_main, f);
1938     }
1939 }
1940
1941 \f
1942 static void *
1943 dp_netdev_flow_stats_new_cb(void)
1944 {
1945     struct dp_netdev_flow_stats *bucket = xzalloc_cacheline(sizeof *bucket);
1946     ovs_mutex_init(&bucket->mutex);
1947     return bucket;
1948 }
1949
1950 static void
1951 dp_netdev_flow_used(struct dp_netdev_flow *netdev_flow,
1952                     const struct ofpbuf *packet,
1953                     const struct miniflow *key)
1954 {
1955     uint16_t tcp_flags = miniflow_get_tcp_flags(key);
1956     long long int now = time_msec();
1957     struct dp_netdev_flow_stats *bucket;
1958
1959     bucket = ovsthread_stats_bucket_get(&netdev_flow->stats,
1960                                         dp_netdev_flow_stats_new_cb);
1961
1962     ovs_mutex_lock(&bucket->mutex);
1963     bucket->used = MAX(now, bucket->used);
1964     bucket->packet_count++;
1965     bucket->byte_count += ofpbuf_size(packet);
1966     bucket->tcp_flags |= tcp_flags;
1967     ovs_mutex_unlock(&bucket->mutex);
1968 }
1969
1970 static void *
1971 dp_netdev_stats_new_cb(void)
1972 {
1973     struct dp_netdev_stats *bucket = xzalloc_cacheline(sizeof *bucket);
1974     ovs_mutex_init(&bucket->mutex);
1975     return bucket;
1976 }
1977
1978 static void
1979 dp_netdev_count_packet(struct dp_netdev *dp, enum dp_stat_type type)
1980 {
1981     struct dp_netdev_stats *bucket;
1982
1983     bucket = ovsthread_stats_bucket_get(&dp->stats, dp_netdev_stats_new_cb);
1984     ovs_mutex_lock(&bucket->mutex);
1985     bucket->n[type]++;
1986     ovs_mutex_unlock(&bucket->mutex);
1987 }
1988
1989 static void
1990 dp_netdev_input(struct dp_netdev *dp, struct ofpbuf *packet,
1991                 struct pkt_metadata *md)
1992     OVS_REQ_RDLOCK(dp->port_rwlock)
1993 {
1994     struct dp_netdev_flow *netdev_flow;
1995     struct {
1996         struct miniflow flow;
1997         uint32_t buf[FLOW_U32S];
1998     } key;
1999
2000     if (ofpbuf_size(packet) < ETH_HEADER_LEN) {
2001         ofpbuf_delete(packet);
2002         return;
2003     }
2004     miniflow_initialize(&key.flow, key.buf);
2005     miniflow_extract(packet, md, &key.flow);
2006
2007     netdev_flow = dp_netdev_lookup_flow(dp, &key.flow);
2008     if (netdev_flow) {
2009         struct dp_netdev_actions *actions;
2010
2011         dp_netdev_flow_used(netdev_flow, packet, &key.flow);
2012
2013         actions = dp_netdev_flow_get_actions(netdev_flow);
2014         dp_netdev_execute_actions(dp, &key.flow, packet, true, md,
2015                                   actions->actions, actions->size);
2016         dp_netdev_count_packet(dp, DP_STAT_HIT);
2017     } else if (dp->handler_queues) {
2018         dp_netdev_count_packet(dp, DP_STAT_MISS);
2019         dp_netdev_output_userspace(dp, packet,
2020                                    miniflow_hash_5tuple(&key.flow, 0)
2021                                    % dp->n_handlers,
2022                                    DPIF_UC_MISS, &key.flow, NULL);
2023         ofpbuf_delete(packet);
2024     }
2025 }
2026
2027 static void
2028 dp_netdev_port_input(struct dp_netdev *dp, struct ofpbuf *packet,
2029                      struct pkt_metadata *md)
2030     OVS_REQ_RDLOCK(dp->port_rwlock)
2031 {
2032     uint32_t *recirc_depth = recirc_depth_get();
2033
2034     *recirc_depth = 0;
2035     dp_netdev_input(dp, packet, md);
2036 }
2037
2038 static int
2039 dp_netdev_output_userspace(struct dp_netdev *dp, struct ofpbuf *packet,
2040                            int queue_no, int type, const struct miniflow *key,
2041                            const struct nlattr *userdata)
2042 {
2043     struct dp_netdev_queue *q;
2044     int error;
2045
2046     fat_rwlock_rdlock(&dp->queue_rwlock);
2047     q = &dp->handler_queues[queue_no];
2048     ovs_mutex_lock(&q->mutex);
2049     if (q->head - q->tail < MAX_QUEUE_LEN) {
2050         struct dp_netdev_upcall *u = &q->upcalls[q->head++ & QUEUE_MASK];
2051         struct dpif_upcall *upcall = &u->upcall;
2052         struct ofpbuf *buf = &u->buf;
2053         size_t buf_size;
2054         struct flow flow;
2055
2056         upcall->type = type;
2057
2058         /* Allocate buffer big enough for everything. */
2059         buf_size = ODPUTIL_FLOW_KEY_BYTES;
2060         if (userdata) {
2061             buf_size += NLA_ALIGN(userdata->nla_len);
2062         }
2063         buf_size += ofpbuf_size(packet);
2064         ofpbuf_init(buf, buf_size);
2065
2066         /* Put ODP flow. */
2067         miniflow_expand(key, &flow);
2068         odp_flow_key_from_flow(buf, &flow, NULL, flow.in_port.odp_port);
2069         upcall->key = ofpbuf_data(buf);
2070         upcall->key_len = ofpbuf_size(buf);
2071
2072         /* Put userdata. */
2073         if (userdata) {
2074             upcall->userdata = ofpbuf_put(buf, userdata,
2075                                           NLA_ALIGN(userdata->nla_len));
2076         }
2077
2078         ofpbuf_set_data(&upcall->packet,
2079                         ofpbuf_put(buf, ofpbuf_data(packet), ofpbuf_size(packet)));
2080         ofpbuf_set_size(&upcall->packet, ofpbuf_size(packet));
2081
2082         seq_change(q->seq);
2083
2084         error = 0;
2085     } else {
2086         dp_netdev_count_packet(dp, DP_STAT_LOST);
2087         error = ENOBUFS;
2088     }
2089     ovs_mutex_unlock(&q->mutex);
2090     fat_rwlock_unlock(&dp->queue_rwlock);
2091
2092     return error;
2093 }
2094
2095 struct dp_netdev_execute_aux {
2096     struct dp_netdev *dp;
2097     const struct miniflow *key;
2098 };
2099
2100 static void
2101 dp_execute_cb(void *aux_, struct ofpbuf *packet,
2102               struct pkt_metadata *md,
2103               const struct nlattr *a, bool may_steal)
2104     OVS_NO_THREAD_SAFETY_ANALYSIS
2105 {
2106     struct dp_netdev_execute_aux *aux = aux_;
2107     int type = nl_attr_type(a);
2108     struct dp_netdev_port *p;
2109     uint32_t *depth = recirc_depth_get();
2110
2111     switch ((enum ovs_action_attr)type) {
2112     case OVS_ACTION_ATTR_OUTPUT:
2113         p = dp_netdev_lookup_port(aux->dp, u32_to_odp(nl_attr_get_u32(a)));
2114         if (p) {
2115             netdev_send(p->netdev, packet, may_steal);
2116         }
2117         break;
2118
2119     case OVS_ACTION_ATTR_USERSPACE: {
2120         const struct nlattr *userdata;
2121
2122         userdata = nl_attr_find_nested(a, OVS_USERSPACE_ATTR_USERDATA);
2123
2124         dp_netdev_output_userspace(aux->dp, packet,
2125                                    miniflow_hash_5tuple(aux->key, 0)
2126                                        % aux->dp->n_handlers,
2127                                    DPIF_UC_ACTION, aux->key,
2128                                    userdata);
2129
2130         if (may_steal) {
2131             ofpbuf_delete(packet);
2132         }
2133         break;
2134     }
2135
2136     case OVS_ACTION_ATTR_HASH: {
2137         const struct ovs_action_hash *hash_act;
2138         uint32_t hash;
2139
2140         hash_act = nl_attr_get(a);
2141         if (hash_act->hash_alg == OVS_HASH_ALG_L4) {
2142             /* Hash need not be symmetric, nor does it need to include
2143              * L2 fields. */
2144             hash = miniflow_hash_5tuple(aux->key, hash_act->hash_basis);
2145             if (!hash) {
2146                 hash = 1; /* 0 is not valid */
2147             }
2148
2149         } else {
2150             VLOG_WARN("Unknown hash algorithm specified for the hash action.");
2151             hash = 2;
2152         }
2153
2154         md->dp_hash = hash;
2155         break;
2156     }
2157
2158     case OVS_ACTION_ATTR_RECIRC:
2159         if (*depth < MAX_RECIRC_DEPTH) {
2160             struct pkt_metadata recirc_md = *md;
2161             struct ofpbuf *recirc_packet;
2162
2163             recirc_packet = may_steal ? packet : ofpbuf_clone(packet);
2164             recirc_md.recirc_id = nl_attr_get_u32(a);
2165
2166             (*depth)++;
2167             dp_netdev_input(aux->dp, recirc_packet, &recirc_md);
2168             (*depth)--;
2169
2170             break;
2171         } else {
2172             VLOG_WARN("Packet dropped. Max recirculation depth exceeded.");
2173         }
2174         break;
2175
2176     case OVS_ACTION_ATTR_PUSH_VLAN:
2177     case OVS_ACTION_ATTR_POP_VLAN:
2178     case OVS_ACTION_ATTR_PUSH_MPLS:
2179     case OVS_ACTION_ATTR_POP_MPLS:
2180     case OVS_ACTION_ATTR_SET:
2181     case OVS_ACTION_ATTR_SAMPLE:
2182     case OVS_ACTION_ATTR_UNSPEC:
2183     case __OVS_ACTION_ATTR_MAX:
2184         OVS_NOT_REACHED();
2185     }
2186 }
2187
2188 static void
2189 dp_netdev_execute_actions(struct dp_netdev *dp, const struct miniflow *key,
2190                           struct ofpbuf *packet, bool may_steal,
2191                           struct pkt_metadata *md,
2192                           const struct nlattr *actions, size_t actions_len)
2193 {
2194     struct dp_netdev_execute_aux aux = {dp, key};
2195
2196     odp_execute_actions(&aux, packet, may_steal, md,
2197                         actions, actions_len, dp_execute_cb);
2198 }
2199
2200 const struct dpif_class dpif_netdev_class = {
2201     "netdev",
2202     dpif_netdev_enumerate,
2203     dpif_netdev_port_open_type,
2204     dpif_netdev_open,
2205     dpif_netdev_close,
2206     dpif_netdev_destroy,
2207     dpif_netdev_run,
2208     dpif_netdev_wait,
2209     dpif_netdev_get_stats,
2210     dpif_netdev_port_add,
2211     dpif_netdev_port_del,
2212     dpif_netdev_port_query_by_number,
2213     dpif_netdev_port_query_by_name,
2214     NULL,                       /* port_get_pid */
2215     dpif_netdev_port_dump_start,
2216     dpif_netdev_port_dump_next,
2217     dpif_netdev_port_dump_done,
2218     dpif_netdev_port_poll,
2219     dpif_netdev_port_poll_wait,
2220     dpif_netdev_flow_get,
2221     dpif_netdev_flow_put,
2222     dpif_netdev_flow_del,
2223     dpif_netdev_flow_flush,
2224     dpif_netdev_flow_dump_state_init,
2225     dpif_netdev_flow_dump_start,
2226     dpif_netdev_flow_dump_next,
2227     NULL,
2228     dpif_netdev_flow_dump_done,
2229     dpif_netdev_flow_dump_state_uninit,
2230     dpif_netdev_execute,
2231     NULL,                       /* operate */
2232     dpif_netdev_recv_set,
2233     dpif_netdev_handlers_set,
2234     dpif_netdev_queue_to_priority,
2235     dpif_netdev_recv,
2236     dpif_netdev_recv_wait,
2237     dpif_netdev_recv_purge,
2238 };
2239
2240 static void
2241 dpif_dummy_change_port_number(struct unixctl_conn *conn, int argc OVS_UNUSED,
2242                               const char *argv[], void *aux OVS_UNUSED)
2243 {
2244     struct dp_netdev_port *port;
2245     struct dp_netdev *dp;
2246     odp_port_t port_no;
2247
2248     ovs_mutex_lock(&dp_netdev_mutex);
2249     dp = shash_find_data(&dp_netdevs, argv[1]);
2250     if (!dp || !dpif_netdev_class_is_dummy(dp->class)) {
2251         ovs_mutex_unlock(&dp_netdev_mutex);
2252         unixctl_command_reply_error(conn, "unknown datapath or not a dummy");
2253         return;
2254     }
2255     ovs_refcount_ref(&dp->ref_cnt);
2256     ovs_mutex_unlock(&dp_netdev_mutex);
2257
2258     ovs_rwlock_wrlock(&dp->port_rwlock);
2259     if (get_port_by_name(dp, argv[2], &port)) {
2260         unixctl_command_reply_error(conn, "unknown port");
2261         goto exit;
2262     }
2263
2264     port_no = u32_to_odp(atoi(argv[3]));
2265     if (!port_no || port_no == ODPP_NONE) {
2266         unixctl_command_reply_error(conn, "bad port number");
2267         goto exit;
2268     }
2269     if (dp_netdev_lookup_port(dp, port_no)) {
2270         unixctl_command_reply_error(conn, "port number already in use");
2271         goto exit;
2272     }
2273     hmap_remove(&dp->ports, &port->node);
2274     port->port_no = port_no;
2275     hmap_insert(&dp->ports, &port->node, hash_int(odp_to_u32(port_no), 0));
2276     seq_change(dp->port_seq);
2277     unixctl_command_reply(conn, NULL);
2278
2279 exit:
2280     ovs_rwlock_unlock(&dp->port_rwlock);
2281     dp_netdev_unref(dp);
2282 }
2283
2284 static void
2285 dpif_dummy_register__(const char *type)
2286 {
2287     struct dpif_class *class;
2288
2289     class = xmalloc(sizeof *class);
2290     *class = dpif_netdev_class;
2291     class->type = xstrdup(type);
2292     dp_register_provider(class);
2293 }
2294
2295 void
2296 dpif_dummy_register(bool override)
2297 {
2298     if (override) {
2299         struct sset types;
2300         const char *type;
2301
2302         sset_init(&types);
2303         dp_enumerate_types(&types);
2304         SSET_FOR_EACH (type, &types) {
2305             if (!dp_unregister_provider(type)) {
2306                 dpif_dummy_register__(type);
2307             }
2308         }
2309         sset_destroy(&types);
2310     }
2311
2312     dpif_dummy_register__("dummy");
2313
2314     unixctl_command_register("dpif-dummy/change-port-number",
2315                              "DP PORT NEW-NUMBER",
2316                              3, 3, dpif_dummy_change_port_number, NULL);
2317 }