73eb99d16c31f80e3af1e2aea18b61b9129da93c
[sliver-openvswitch.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-vport.h"
47 #include "netlink.h"
48 #include "odp-execute.h"
49 #include "odp-util.h"
50 #include "ofp-print.h"
51 #include "ofpbuf.h"
52 #include "packets.h"
53 #include "poll-loop.h"
54 #include "random.h"
55 #include "seq.h"
56 #include "shash.h"
57 #include "sset.h"
58 #include "timeval.h"
59 #include "unixctl.h"
60 #include "util.h"
61 #include "vlog.h"
62
63 VLOG_DEFINE_THIS_MODULE(dpif_netdev);
64
65 /* By default, choose a priority in the middle. */
66 #define NETDEV_RULE_PRIORITY 0x8000
67
68 /* Configuration parameters. */
69 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
70
71 /* Enough headroom to add a vlan tag, plus an extra 2 bytes to allow IP
72  * headers to be aligned on a 4-byte boundary.  */
73 enum { DP_NETDEV_HEADROOM = 2 + VLAN_HEADER_LEN };
74
75 /* Queues. */
76 enum { N_QUEUES = 2 };          /* Number of queues for dpif_recv(). */
77 enum { MAX_QUEUE_LEN = 128 };   /* Maximum number of packets per queue. */
78 enum { QUEUE_MASK = MAX_QUEUE_LEN - 1 };
79 BUILD_ASSERT_DECL(IS_POW2(MAX_QUEUE_LEN));
80
81 /* Protects against changes to 'dp_netdevs'. */
82 static struct ovs_mutex dp_netdev_mutex = OVS_MUTEX_INITIALIZER;
83
84 /* Contains all 'struct dp_netdev's. */
85 static struct shash dp_netdevs OVS_GUARDED_BY(dp_netdev_mutex)
86     = SHASH_INITIALIZER(&dp_netdevs);
87
88 struct dp_netdev_upcall {
89     struct dpif_upcall upcall;  /* Queued upcall information. */
90     struct ofpbuf buf;          /* ofpbuf instance for upcall.packet. */
91 };
92
93 /* A queue passing packets from a struct dp_netdev to its clients.
94  *
95  *
96  * Thread-safety
97  * =============
98  *
99  * Any access at all requires the owning 'dp_netdev''s queue_mutex. */
100 struct dp_netdev_queue {
101     struct dp_netdev_upcall upcalls[MAX_QUEUE_LEN] OVS_GUARDED;
102     unsigned int head OVS_GUARDED;
103     unsigned int tail OVS_GUARDED;
104 };
105
106 /* Datapath based on the network device interface from netdev.h.
107  *
108  *
109  * Thread-safety
110  * =============
111  *
112  * Some members, marked 'const', are immutable.  Accessing other members
113  * requires synchronization, as noted in more detail below.
114  *
115  * Acquisition order is, from outermost to innermost:
116  *
117  *    dp_netdev_mutex (global)
118  *    port_rwlock
119  *    flow_mutex
120  *    cls.rwlock
121  *    queue_mutex
122  */
123 struct dp_netdev {
124     const struct dpif_class *const class;
125     const char *const name;
126     struct ovs_refcount ref_cnt;
127     atomic_flag destroyed;
128
129     /* Flows.
130      *
131      * Readers of 'cls' and 'flow_table' must take a 'cls->rwlock' read lock.
132      *
133      * Writers of 'cls' and 'flow_table' must take the 'flow_mutex' and then
134      * the 'cls->rwlock' write lock.  (The outer 'flow_mutex' allows writers to
135      * atomically perform multiple operations on 'cls' and 'flow_table'.)
136      */
137     struct ovs_mutex flow_mutex;
138     struct classifier cls;      /* Classifier.  Protected by cls.rwlock. */
139     struct hmap flow_table OVS_GUARDED; /* Flow table. */
140
141     /* Queues.
142      *
143      * Everything in 'queues' is protected by 'queue_mutex'. */
144     struct ovs_mutex queue_mutex;
145     struct dp_netdev_queue queues[N_QUEUES];
146     struct seq *queue_seq;      /* Incremented whenever a packet is queued. */
147
148     /* Statistics.
149      *
150      * ovsthread_counter is internally synchronized. */
151     struct ovsthread_counter *n_hit;    /* Number of flow table matches. */
152     struct ovsthread_counter *n_missed; /* Number of flow table misses. */
153     struct ovsthread_counter *n_lost;   /* Number of misses not passed up. */
154
155     /* Ports.
156      *
157      * Any lookup into 'ports' or any access to the dp_netdev_ports found
158      * through 'ports' requires taking 'port_rwlock'. */
159     struct ovs_rwlock port_rwlock;
160     struct hmap ports OVS_GUARDED;
161     struct seq *port_seq;       /* Incremented whenever a port changes. */
162
163     /* Forwarding threads. */
164     struct latch exit_latch;
165     struct dp_forwarder *forwarders;
166     size_t n_forwarders;
167 };
168
169 static struct dp_netdev_port *dp_netdev_lookup_port(const struct dp_netdev *dp,
170                                                     odp_port_t)
171     OVS_REQ_RDLOCK(dp->port_rwlock);
172
173 /* A port in a netdev-based datapath. */
174 struct dp_netdev_port {
175     struct hmap_node node;      /* Node in dp_netdev's 'ports'. */
176     odp_port_t port_no;
177     struct netdev *netdev;
178     struct netdev_saved_flags *sf;
179     struct netdev_rx *rx;
180     char *type;                 /* Port type as requested by user. */
181 };
182
183 /* A flow in dp_netdev's 'flow_table'.
184  *
185  *
186  * Thread-safety
187  * =============
188  *
189  * Except near the beginning or ending of its lifespan, rule 'rule' belongs to
190  * its dp_netdev's classifier.  The text below calls this classifier 'cls'.
191  *
192  * Motivation
193  * ----------
194  *
195  * The thread safety rules described here for "struct dp_netdev_flow" are
196  * motivated by two goals:
197  *
198  *    - Prevent threads that read members of "struct dp_netdev_flow" from
199  *      reading bad data due to changes by some thread concurrently modifying
200  *      those members.
201  *
202  *    - Prevent two threads making changes to members of a given "struct
203  *      dp_netdev_flow" from interfering with each other.
204  *
205  *
206  * Rules
207  * -----
208  *
209  * A flow 'flow' may be accessed without a risk of being freed by code that
210  * holds a read-lock or write-lock on 'cls->rwlock' or that owns a reference to
211  * 'flow->ref_cnt' (or both).  Code that needs to hold onto a flow for a while
212  * should take 'cls->rwlock', find the flow it needs, increment 'flow->ref_cnt'
213  * with dpif_netdev_flow_ref(), and drop 'cls->rwlock'.
214  *
215  * 'flow->ref_cnt' protects 'flow' from being freed.  It doesn't protect the
216  * flow from being deleted from 'cls' (that's 'cls->rwlock') and it doesn't
217  * protect members of 'flow' from modification (that's 'flow->mutex').
218  *
219  * 'flow->mutex' protects the members of 'flow' from modification.  It doesn't
220  * protect the flow from being deleted from 'cls' (that's 'cls->rwlock') and it
221  * doesn't prevent the flow from being freed (that's 'flow->ref_cnt').
222  *
223  * Some members, marked 'const', are immutable.  Accessing other members
224  * requires synchronization, as noted in more detail below.
225  */
226 struct dp_netdev_flow {
227     /* Packet classification. */
228     const struct cls_rule cr;   /* In owning dp_netdev's 'cls'. */
229
230     /* Hash table index by unmasked flow. */
231     const struct hmap_node node; /* In owning dp_netdev's 'flow_table'. */
232     const struct flow flow;      /* The flow that created this entry. */
233
234     /* Number of references.
235      * The classifier owns one reference.
236      * Any thread trying to keep a rule from being freed should hold its own
237      * reference. */
238     struct ovs_refcount ref_cnt;
239
240     /* Protects members marked OVS_GUARDED.
241      *
242      * Acquire after datapath's flow_mutex. */
243     struct ovs_mutex mutex OVS_ACQ_AFTER(dp_netdev_mutex);
244
245     /* Statistics.
246      *
247      * Reading or writing these members requires 'mutex'. */
248     long long int used OVS_GUARDED; /* Last used time, in monotonic msecs. */
249     long long int packet_count OVS_GUARDED; /* Number of packets matched. */
250     long long int byte_count OVS_GUARDED;   /* Number of bytes matched. */
251     uint16_t tcp_flags OVS_GUARDED; /* Bitwise-OR of seen tcp_flags values. */
252
253     /* Actions.
254      *
255      * Reading 'actions' requires 'mutex'.
256      * Writing 'actions' requires 'mutex' and (to allow for transactions) the
257      * datapath's flow_mutex. */
258     struct dp_netdev_actions *actions OVS_GUARDED;
259 };
260
261 static struct dp_netdev_flow *dp_netdev_flow_ref(
262     const struct dp_netdev_flow *);
263 static void dp_netdev_flow_unref(struct dp_netdev_flow *);
264
265 /* A set of datapath actions within a "struct dp_netdev_flow".
266  *
267  *
268  * Thread-safety
269  * =============
270  *
271  * A struct dp_netdev_actions 'actions' may be accessed without a risk of being
272  * freed by code that holds a read-lock or write-lock on 'flow->mutex' (where
273  * 'flow' is the dp_netdev_flow for which 'flow->actions == actions') or that
274  * owns a reference to 'actions->ref_cnt' (or both). */
275 struct dp_netdev_actions {
276     struct ovs_refcount ref_cnt;
277
278     /* These members are immutable: they do not change during the struct's
279      * lifetime.  */
280     struct nlattr *actions;     /* Sequence of OVS_ACTION_ATTR_* attributes. */
281     unsigned int size;          /* Size of 'actions', in bytes. */
282 };
283
284 struct dp_netdev_actions *dp_netdev_actions_create(const struct nlattr *,
285                                                    size_t);
286 struct dp_netdev_actions *dp_netdev_actions_ref(
287     const struct dp_netdev_actions *);
288 void dp_netdev_actions_unref(struct dp_netdev_actions *);
289
290 /* A thread that receives packets from some ports, looks them up in the flow
291  * table, and executes the actions it finds. */
292 struct dp_forwarder {
293     struct dp_netdev *dp;
294     pthread_t thread;
295     char *name;
296     uint32_t min_hash, max_hash;
297 };
298
299 /* Interface to netdev-based datapath. */
300 struct dpif_netdev {
301     struct dpif dpif;
302     struct dp_netdev *dp;
303     uint64_t last_port_seq;
304 };
305
306 static int get_port_by_number(struct dp_netdev *dp, odp_port_t port_no,
307                               struct dp_netdev_port **portp)
308     OVS_REQ_RDLOCK(dp->port_rwlock);
309 static int get_port_by_name(struct dp_netdev *dp, const char *devname,
310                             struct dp_netdev_port **portp)
311     OVS_REQ_RDLOCK(dp->port_rwlock);
312 static void dp_netdev_free(struct dp_netdev *)
313     OVS_REQUIRES(dp_netdev_mutex);
314 static void dp_netdev_flow_flush(struct dp_netdev *);
315 static int do_add_port(struct dp_netdev *dp, const char *devname,
316                        const char *type, odp_port_t port_no)
317     OVS_REQ_WRLOCK(dp->port_rwlock);
318 static int do_del_port(struct dp_netdev *dp, odp_port_t port_no)
319     OVS_REQ_WRLOCK(dp->port_rwlock);
320 static int dpif_netdev_open(const struct dpif_class *, const char *name,
321                             bool create, struct dpif **);
322 static int dp_netdev_output_userspace(struct dp_netdev *dp, struct ofpbuf *,
323                                     int queue_no, const struct flow *,
324                                     const struct nlattr *userdata)
325     OVS_EXCLUDED(dp->queue_mutex);
326 static void dp_netdev_execute_actions(struct dp_netdev *dp,
327                                       const struct flow *, struct ofpbuf *,
328                                       struct pkt_metadata *,
329                                       const struct nlattr *actions,
330                                       size_t actions_len)
331     OVS_REQ_RDLOCK(dp->port_rwlock);
332 static void dp_netdev_port_input(struct dp_netdev *dp, struct ofpbuf *packet,
333                                  struct pkt_metadata *)
334     OVS_REQ_RDLOCK(dp->port_rwlock);
335 static void dp_netdev_set_threads(struct dp_netdev *, int n);
336
337 static struct dpif_netdev *
338 dpif_netdev_cast(const struct dpif *dpif)
339 {
340     ovs_assert(dpif->dpif_class->open == dpif_netdev_open);
341     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
342 }
343
344 static struct dp_netdev *
345 get_dp_netdev(const struct dpif *dpif)
346 {
347     return dpif_netdev_cast(dpif)->dp;
348 }
349
350 static int
351 dpif_netdev_enumerate(struct sset *all_dps)
352 {
353     struct shash_node *node;
354
355     ovs_mutex_lock(&dp_netdev_mutex);
356     SHASH_FOR_EACH(node, &dp_netdevs) {
357         sset_add(all_dps, node->name);
358     }
359     ovs_mutex_unlock(&dp_netdev_mutex);
360
361     return 0;
362 }
363
364 static bool
365 dpif_netdev_class_is_dummy(const struct dpif_class *class)
366 {
367     return class != &dpif_netdev_class;
368 }
369
370 static const char *
371 dpif_netdev_port_open_type(const struct dpif_class *class, const char *type)
372 {
373     return strcmp(type, "internal") ? type
374                   : dpif_netdev_class_is_dummy(class) ? "dummy"
375                   : "tap";
376 }
377
378 static struct dpif *
379 create_dpif_netdev(struct dp_netdev *dp)
380 {
381     uint16_t netflow_id = hash_string(dp->name, 0);
382     struct dpif_netdev *dpif;
383
384     ovs_refcount_ref(&dp->ref_cnt);
385
386     dpif = xmalloc(sizeof *dpif);
387     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
388     dpif->dp = dp;
389     dpif->last_port_seq = seq_read(dp->port_seq);
390
391     return &dpif->dpif;
392 }
393
394 /* Choose an unused, non-zero port number and return it on success.
395  * Return ODPP_NONE on failure. */
396 static odp_port_t
397 choose_port(struct dp_netdev *dp, const char *name)
398     OVS_REQ_RDLOCK(dp->port_rwlock)
399 {
400     uint32_t port_no;
401
402     if (dp->class != &dpif_netdev_class) {
403         const char *p;
404         int start_no = 0;
405
406         /* If the port name begins with "br", start the number search at
407          * 100 to make writing tests easier. */
408         if (!strncmp(name, "br", 2)) {
409             start_no = 100;
410         }
411
412         /* If the port name contains a number, try to assign that port number.
413          * This can make writing unit tests easier because port numbers are
414          * predictable. */
415         for (p = name; *p != '\0'; p++) {
416             if (isdigit((unsigned char) *p)) {
417                 port_no = start_no + strtol(p, NULL, 10);
418                 if (port_no > 0 && port_no != odp_to_u32(ODPP_NONE)
419                     && !dp_netdev_lookup_port(dp, u32_to_odp(port_no))) {
420                     return u32_to_odp(port_no);
421                 }
422                 break;
423             }
424         }
425     }
426
427     for (port_no = 1; port_no <= UINT16_MAX; port_no++) {
428         if (!dp_netdev_lookup_port(dp, u32_to_odp(port_no))) {
429             return u32_to_odp(port_no);
430         }
431     }
432
433     return ODPP_NONE;
434 }
435
436 static int
437 create_dp_netdev(const char *name, const struct dpif_class *class,
438                  struct dp_netdev **dpp)
439     OVS_REQUIRES(dp_netdev_mutex)
440 {
441     struct dp_netdev *dp;
442     int error;
443     int i;
444
445     dp = xzalloc(sizeof *dp);
446     shash_add(&dp_netdevs, name, dp);
447
448     *CONST_CAST(const struct dpif_class **, &dp->class) = class;
449     *CONST_CAST(const char **, &dp->name) = xstrdup(name);
450     ovs_refcount_init(&dp->ref_cnt);
451     atomic_flag_init(&dp->destroyed);
452
453     ovs_mutex_init(&dp->flow_mutex);
454     classifier_init(&dp->cls, NULL);
455     hmap_init(&dp->flow_table);
456
457     ovs_mutex_init(&dp->queue_mutex);
458     ovs_mutex_lock(&dp->queue_mutex);
459     for (i = 0; i < N_QUEUES; i++) {
460         dp->queues[i].head = dp->queues[i].tail = 0;
461     }
462     ovs_mutex_unlock(&dp->queue_mutex);
463     dp->queue_seq = seq_create();
464
465     dp->n_hit = ovsthread_counter_create();
466     dp->n_missed = ovsthread_counter_create();
467     dp->n_lost = ovsthread_counter_create();
468
469     ovs_rwlock_init(&dp->port_rwlock);
470     hmap_init(&dp->ports);
471     dp->port_seq = seq_create();
472     latch_init(&dp->exit_latch);
473
474     ovs_rwlock_wrlock(&dp->port_rwlock);
475     error = do_add_port(dp, name, "internal", ODPP_LOCAL);
476     ovs_rwlock_unlock(&dp->port_rwlock);
477     if (error) {
478         dp_netdev_free(dp);
479         return error;
480     }
481     dp_netdev_set_threads(dp, 2);
482
483     *dpp = dp;
484     return 0;
485 }
486
487 static int
488 dpif_netdev_open(const struct dpif_class *class, const char *name,
489                  bool create, struct dpif **dpifp)
490 {
491     struct dp_netdev *dp;
492     int error;
493
494     ovs_mutex_lock(&dp_netdev_mutex);
495     dp = shash_find_data(&dp_netdevs, name);
496     if (!dp) {
497         error = create ? create_dp_netdev(name, class, &dp) : ENODEV;
498     } else {
499         error = (dp->class != class ? EINVAL
500                  : create ? EEXIST
501                  : 0);
502     }
503     if (!error) {
504         *dpifp = create_dpif_netdev(dp);
505     }
506     ovs_mutex_unlock(&dp_netdev_mutex);
507
508     return error;
509 }
510
511 static void
512 dp_netdev_purge_queues(struct dp_netdev *dp)
513 {
514     int i;
515
516     ovs_mutex_lock(&dp->queue_mutex);
517     for (i = 0; i < N_QUEUES; i++) {
518         struct dp_netdev_queue *q = &dp->queues[i];
519
520         while (q->tail != q->head) {
521             struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
522             ofpbuf_uninit(&u->upcall.packet);
523             ofpbuf_uninit(&u->buf);
524         }
525     }
526     ovs_mutex_unlock(&dp->queue_mutex);
527 }
528
529 /* Requires dp_netdev_mutex so that we can't get a new reference to 'dp'
530  * through the 'dp_netdevs' shash while freeing 'dp'. */
531 static void
532 dp_netdev_free(struct dp_netdev *dp)
533     OVS_REQUIRES(dp_netdev_mutex)
534 {
535     struct dp_netdev_port *port, *next;
536
537     shash_find_and_delete(&dp_netdevs, dp->name);
538
539     dp_netdev_set_threads(dp, 0);
540     free(dp->forwarders);
541
542     dp_netdev_flow_flush(dp);
543     ovs_rwlock_wrlock(&dp->port_rwlock);
544     HMAP_FOR_EACH_SAFE (port, next, node, &dp->ports) {
545         do_del_port(dp, port->port_no);
546     }
547     ovs_rwlock_unlock(&dp->port_rwlock);
548     ovsthread_counter_destroy(dp->n_hit);
549     ovsthread_counter_destroy(dp->n_missed);
550     ovsthread_counter_destroy(dp->n_lost);
551
552     dp_netdev_purge_queues(dp);
553     seq_destroy(dp->queue_seq);
554     ovs_mutex_destroy(&dp->queue_mutex);
555
556     classifier_destroy(&dp->cls);
557     hmap_destroy(&dp->flow_table);
558     ovs_mutex_destroy(&dp->flow_mutex);
559     seq_destroy(dp->port_seq);
560     hmap_destroy(&dp->ports);
561     atomic_flag_destroy(&dp->destroyed);
562     ovs_refcount_destroy(&dp->ref_cnt);
563     latch_destroy(&dp->exit_latch);
564     free(CONST_CAST(char *, dp->name));
565     free(dp);
566 }
567
568 static void
569 dp_netdev_unref(struct dp_netdev *dp)
570 {
571     if (dp) {
572         /* Take dp_netdev_mutex so that, if dp->ref_cnt falls to zero, we can't
573          * get a new reference to 'dp' through the 'dp_netdevs' shash. */
574         ovs_mutex_lock(&dp_netdev_mutex);
575         if (ovs_refcount_unref(&dp->ref_cnt) == 1) {
576             dp_netdev_free(dp);
577         }
578         ovs_mutex_unlock(&dp_netdev_mutex);
579     }
580 }
581
582 static void
583 dpif_netdev_close(struct dpif *dpif)
584 {
585     struct dp_netdev *dp = get_dp_netdev(dpif);
586
587     dp_netdev_unref(dp);
588     free(dpif);
589 }
590
591 static int
592 dpif_netdev_destroy(struct dpif *dpif)
593 {
594     struct dp_netdev *dp = get_dp_netdev(dpif);
595
596     if (!atomic_flag_test_and_set(&dp->destroyed)) {
597         if (ovs_refcount_unref(&dp->ref_cnt) == 1) {
598             /* Can't happen: 'dpif' still owns a reference to 'dp'. */
599             OVS_NOT_REACHED();
600         }
601     }
602
603     return 0;
604 }
605
606 static int
607 dpif_netdev_get_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
608 {
609     struct dp_netdev *dp = get_dp_netdev(dpif);
610
611     fat_rwlock_rdlock(&dp->cls.rwlock);
612     stats->n_flows = hmap_count(&dp->flow_table);
613     fat_rwlock_unlock(&dp->cls.rwlock);
614
615     stats->n_hit = ovsthread_counter_read(dp->n_hit);
616     stats->n_missed = ovsthread_counter_read(dp->n_missed);
617     stats->n_lost = ovsthread_counter_read(dp->n_lost);
618     stats->n_masks = UINT32_MAX;
619     stats->n_mask_hit = UINT64_MAX;
620
621     return 0;
622 }
623
624 static int
625 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
626             odp_port_t port_no)
627     OVS_REQ_WRLOCK(dp->port_rwlock)
628 {
629     struct netdev_saved_flags *sf;
630     struct dp_netdev_port *port;
631     struct netdev *netdev;
632     struct netdev_rx *rx;
633     enum netdev_flags flags;
634     const char *open_type;
635     int error;
636
637     /* XXX reject devices already in some dp_netdev. */
638
639     /* Open and validate network device. */
640     open_type = dpif_netdev_port_open_type(dp->class, type);
641     error = netdev_open(devname, open_type, &netdev);
642     if (error) {
643         return error;
644     }
645     /* XXX reject non-Ethernet devices */
646
647     netdev_get_flags(netdev, &flags);
648     if (flags & NETDEV_LOOPBACK) {
649         VLOG_ERR("%s: cannot add a loopback device", devname);
650         netdev_close(netdev);
651         return EINVAL;
652     }
653
654     error = netdev_rx_open(netdev, &rx);
655     if (error
656         && !(error == EOPNOTSUPP && dpif_netdev_class_is_dummy(dp->class))) {
657         VLOG_ERR("%s: cannot receive packets on this network device (%s)",
658                  devname, ovs_strerror(errno));
659         netdev_close(netdev);
660         return error;
661     }
662
663     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, &sf);
664     if (error) {
665         netdev_rx_close(rx);
666         netdev_close(netdev);
667         return error;
668     }
669
670     port = xmalloc(sizeof *port);
671     port->port_no = port_no;
672     port->netdev = netdev;
673     port->sf = sf;
674     port->rx = rx;
675     port->type = xstrdup(type);
676
677     hmap_insert(&dp->ports, &port->node, hash_int(odp_to_u32(port_no), 0));
678     seq_change(dp->port_seq);
679
680     return 0;
681 }
682
683 static int
684 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
685                      odp_port_t *port_nop)
686 {
687     struct dp_netdev *dp = get_dp_netdev(dpif);
688     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
689     const char *dpif_port;
690     odp_port_t port_no;
691     int error;
692
693     ovs_rwlock_wrlock(&dp->port_rwlock);
694     dpif_port = netdev_vport_get_dpif_port(netdev, namebuf, sizeof namebuf);
695     if (*port_nop != ODPP_NONE) {
696         port_no = *port_nop;
697         error = dp_netdev_lookup_port(dp, *port_nop) ? EBUSY : 0;
698     } else {
699         port_no = choose_port(dp, dpif_port);
700         error = port_no == ODPP_NONE ? EFBIG : 0;
701     }
702     if (!error) {
703         *port_nop = port_no;
704         error = do_add_port(dp, dpif_port, netdev_get_type(netdev), port_no);
705     }
706     ovs_rwlock_unlock(&dp->port_rwlock);
707
708     return error;
709 }
710
711 static int
712 dpif_netdev_port_del(struct dpif *dpif, odp_port_t port_no)
713 {
714     struct dp_netdev *dp = get_dp_netdev(dpif);
715     int error;
716
717     ovs_rwlock_wrlock(&dp->port_rwlock);
718     error = port_no == ODPP_LOCAL ? EINVAL : do_del_port(dp, port_no);
719     ovs_rwlock_unlock(&dp->port_rwlock);
720
721     return error;
722 }
723
724 static bool
725 is_valid_port_number(odp_port_t port_no)
726 {
727     return port_no != ODPP_NONE;
728 }
729
730 static struct dp_netdev_port *
731 dp_netdev_lookup_port(const struct dp_netdev *dp, odp_port_t port_no)
732     OVS_REQ_RDLOCK(dp->port_rwlock)
733 {
734     struct dp_netdev_port *port;
735
736     HMAP_FOR_EACH_IN_BUCKET (port, node, hash_int(odp_to_u32(port_no), 0),
737                              &dp->ports) {
738         if (port->port_no == port_no) {
739             return port;
740         }
741     }
742     return NULL;
743 }
744
745 static int
746 get_port_by_number(struct dp_netdev *dp,
747                    odp_port_t port_no, struct dp_netdev_port **portp)
748     OVS_REQ_RDLOCK(dp->port_rwlock)
749 {
750     if (!is_valid_port_number(port_no)) {
751         *portp = NULL;
752         return EINVAL;
753     } else {
754         *portp = dp_netdev_lookup_port(dp, port_no);
755         return *portp ? 0 : ENOENT;
756     }
757 }
758
759 static int
760 get_port_by_name(struct dp_netdev *dp,
761                  const char *devname, struct dp_netdev_port **portp)
762     OVS_REQ_RDLOCK(dp->port_rwlock)
763 {
764     struct dp_netdev_port *port;
765
766     HMAP_FOR_EACH (port, node, &dp->ports) {
767         if (!strcmp(netdev_get_name(port->netdev), devname)) {
768             *portp = port;
769             return 0;
770         }
771     }
772     return ENOENT;
773 }
774
775 static int
776 do_del_port(struct dp_netdev *dp, odp_port_t port_no)
777     OVS_REQ_WRLOCK(dp->port_rwlock)
778 {
779     struct dp_netdev_port *port;
780     int error;
781
782     error = get_port_by_number(dp, port_no, &port);
783     if (error) {
784         return error;
785     }
786
787     hmap_remove(&dp->ports, &port->node);
788     seq_change(dp->port_seq);
789
790     netdev_close(port->netdev);
791     netdev_restore_flags(port->sf);
792     netdev_rx_close(port->rx);
793     free(port->type);
794     free(port);
795
796     return 0;
797 }
798
799 static void
800 answer_port_query(const struct dp_netdev_port *port,
801                   struct dpif_port *dpif_port)
802 {
803     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
804     dpif_port->type = xstrdup(port->type);
805     dpif_port->port_no = port->port_no;
806 }
807
808 static int
809 dpif_netdev_port_query_by_number(const struct dpif *dpif, odp_port_t port_no,
810                                  struct dpif_port *dpif_port)
811 {
812     struct dp_netdev *dp = get_dp_netdev(dpif);
813     struct dp_netdev_port *port;
814     int error;
815
816     ovs_rwlock_rdlock(&dp->port_rwlock);
817     error = get_port_by_number(dp, port_no, &port);
818     if (!error && dpif_port) {
819         answer_port_query(port, dpif_port);
820     }
821     ovs_rwlock_unlock(&dp->port_rwlock);
822
823     return error;
824 }
825
826 static int
827 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
828                                struct dpif_port *dpif_port)
829 {
830     struct dp_netdev *dp = get_dp_netdev(dpif);
831     struct dp_netdev_port *port;
832     int error;
833
834     ovs_rwlock_rdlock(&dp->port_rwlock);
835     error = get_port_by_name(dp, devname, &port);
836     if (!error && dpif_port) {
837         answer_port_query(port, dpif_port);
838     }
839     ovs_rwlock_unlock(&dp->port_rwlock);
840
841     return error;
842 }
843
844 static void
845 dp_netdev_remove_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
846     OVS_REQ_WRLOCK(dp->cls.rwlock)
847     OVS_REQUIRES(dp->flow_mutex)
848 {
849     struct cls_rule *cr = CONST_CAST(struct cls_rule *, &flow->cr);
850     struct hmap_node *node = CONST_CAST(struct hmap_node *, &flow->node);
851
852     classifier_remove(&dp->cls, cr);
853     hmap_remove(&dp->flow_table, node);
854     dp_netdev_flow_unref(flow);
855 }
856
857 static struct dp_netdev_flow *
858 dp_netdev_flow_ref(const struct dp_netdev_flow *flow_)
859 {
860     struct dp_netdev_flow *flow = CONST_CAST(struct dp_netdev_flow *, flow_);
861     if (flow) {
862         ovs_refcount_ref(&flow->ref_cnt);
863     }
864     return flow;
865 }
866
867 static void
868 dp_netdev_flow_unref(struct dp_netdev_flow *flow)
869 {
870     if (flow && ovs_refcount_unref(&flow->ref_cnt) == 1) {
871         cls_rule_destroy(CONST_CAST(struct cls_rule *, &flow->cr));
872         ovs_mutex_lock(&flow->mutex);
873         dp_netdev_actions_unref(flow->actions);
874         ovs_mutex_unlock(&flow->mutex);
875         ovs_mutex_destroy(&flow->mutex);
876         free(flow);
877     }
878 }
879
880 static void
881 dp_netdev_flow_flush(struct dp_netdev *dp)
882 {
883     struct dp_netdev_flow *netdev_flow, *next;
884
885     ovs_mutex_lock(&dp->flow_mutex);
886     fat_rwlock_wrlock(&dp->cls.rwlock);
887     HMAP_FOR_EACH_SAFE (netdev_flow, next, node, &dp->flow_table) {
888         dp_netdev_remove_flow(dp, netdev_flow);
889     }
890     fat_rwlock_unlock(&dp->cls.rwlock);
891     ovs_mutex_unlock(&dp->flow_mutex);
892 }
893
894 static int
895 dpif_netdev_flow_flush(struct dpif *dpif)
896 {
897     struct dp_netdev *dp = get_dp_netdev(dpif);
898
899     dp_netdev_flow_flush(dp);
900     return 0;
901 }
902
903 struct dp_netdev_port_state {
904     uint32_t bucket;
905     uint32_t offset;
906     char *name;
907 };
908
909 static int
910 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
911 {
912     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
913     return 0;
914 }
915
916 static int
917 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
918                            struct dpif_port *dpif_port)
919 {
920     struct dp_netdev_port_state *state = state_;
921     struct dp_netdev *dp = get_dp_netdev(dpif);
922     struct hmap_node *node;
923     int retval;
924
925     ovs_rwlock_rdlock(&dp->port_rwlock);
926     node = hmap_at_position(&dp->ports, &state->bucket, &state->offset);
927     if (node) {
928         struct dp_netdev_port *port;
929
930         port = CONTAINER_OF(node, struct dp_netdev_port, node);
931
932         free(state->name);
933         state->name = xstrdup(netdev_get_name(port->netdev));
934         dpif_port->name = state->name;
935         dpif_port->type = port->type;
936         dpif_port->port_no = port->port_no;
937
938         retval = 0;
939     } else {
940         retval = EOF;
941     }
942     ovs_rwlock_unlock(&dp->port_rwlock);
943
944     return retval;
945 }
946
947 static int
948 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
949 {
950     struct dp_netdev_port_state *state = state_;
951     free(state->name);
952     free(state);
953     return 0;
954 }
955
956 static int
957 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
958 {
959     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
960     uint64_t new_port_seq;
961     int error;
962
963     new_port_seq = seq_read(dpif->dp->port_seq);
964     if (dpif->last_port_seq != new_port_seq) {
965         dpif->last_port_seq = new_port_seq;
966         error = ENOBUFS;
967     } else {
968         error = EAGAIN;
969     }
970
971     return error;
972 }
973
974 static void
975 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
976 {
977     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
978
979     seq_wait(dpif->dp->port_seq, dpif->last_port_seq);
980 }
981
982 static struct dp_netdev_flow *
983 dp_netdev_flow_cast(const struct cls_rule *cr)
984 {
985     return cr ? CONTAINER_OF(cr, struct dp_netdev_flow, cr) : NULL;
986 }
987
988 static struct dp_netdev_flow *
989 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct flow *flow)
990     OVS_EXCLUDED(dp->cls.rwlock)
991 {
992     struct dp_netdev_flow *netdev_flow;
993
994     fat_rwlock_rdlock(&dp->cls.rwlock);
995     netdev_flow = dp_netdev_flow_cast(classifier_lookup(&dp->cls, flow, NULL));
996     dp_netdev_flow_ref(netdev_flow);
997     fat_rwlock_unlock(&dp->cls.rwlock);
998
999     return netdev_flow;
1000 }
1001
1002 static struct dp_netdev_flow *
1003 dp_netdev_find_flow(const struct dp_netdev *dp, const struct flow *flow)
1004     OVS_REQ_RDLOCK(dp->cls.rwlock)
1005 {
1006     struct dp_netdev_flow *netdev_flow;
1007
1008     HMAP_FOR_EACH_WITH_HASH (netdev_flow, node, flow_hash(flow, 0),
1009                              &dp->flow_table) {
1010         if (flow_equal(&netdev_flow->flow, flow)) {
1011             return dp_netdev_flow_ref(netdev_flow);
1012         }
1013     }
1014
1015     return NULL;
1016 }
1017
1018 static void
1019 get_dpif_flow_stats(struct dp_netdev_flow *netdev_flow,
1020                     struct dpif_flow_stats *stats)
1021     OVS_REQ_RDLOCK(netdev_flow->mutex)
1022 {
1023     stats->n_packets = netdev_flow->packet_count;
1024     stats->n_bytes = netdev_flow->byte_count;
1025     stats->used = netdev_flow->used;
1026     stats->tcp_flags = netdev_flow->tcp_flags;
1027 }
1028
1029 static int
1030 dpif_netdev_mask_from_nlattrs(const struct nlattr *key, uint32_t key_len,
1031                               const struct nlattr *mask_key,
1032                               uint32_t mask_key_len, const struct flow *flow,
1033                               struct flow *mask)
1034 {
1035     if (mask_key_len) {
1036         enum odp_key_fitness fitness;
1037
1038         fitness = odp_flow_key_to_mask(mask_key, mask_key_len, mask, flow);
1039         if (fitness) {
1040             /* This should not happen: it indicates that
1041              * odp_flow_key_from_mask() and odp_flow_key_to_mask()
1042              * disagree on the acceptable form of a mask.  Log the problem
1043              * as an error, with enough details to enable debugging. */
1044             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1045
1046             if (!VLOG_DROP_ERR(&rl)) {
1047                 struct ds s;
1048
1049                 ds_init(&s);
1050                 odp_flow_format(key, key_len, mask_key, mask_key_len, NULL, &s,
1051                                 true);
1052                 VLOG_ERR("internal error parsing flow mask %s (%s)",
1053                          ds_cstr(&s), odp_key_fitness_to_string(fitness));
1054                 ds_destroy(&s);
1055             }
1056
1057             return EINVAL;
1058         }
1059         /* Force unwildcard the in_port. */
1060         mask->in_port.odp_port = u32_to_odp(UINT32_MAX);
1061     } else {
1062         enum mf_field_id id;
1063         /* No mask key, unwildcard everything except fields whose
1064          * prerequisities are not met. */
1065         memset(mask, 0x0, sizeof *mask);
1066
1067         for (id = 0; id < MFF_N_IDS; ++id) {
1068             /* Skip registers and metadata. */
1069             if (!(id >= MFF_REG0 && id < MFF_REG0 + FLOW_N_REGS)
1070                 && id != MFF_METADATA) {
1071                 const struct mf_field *mf = mf_from_id(id);
1072                 if (mf_are_prereqs_ok(mf, flow)) {
1073                     mf_mask_field(mf, mask);
1074                 }
1075             }
1076         }
1077     }
1078
1079     return 0;
1080 }
1081
1082 static int
1083 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
1084                               struct flow *flow)
1085 {
1086     odp_port_t in_port;
1087
1088     if (odp_flow_key_to_flow(key, key_len, flow)) {
1089         /* This should not happen: it indicates that odp_flow_key_from_flow()
1090          * and odp_flow_key_to_flow() disagree on the acceptable form of a
1091          * flow.  Log the problem as an error, with enough details to enable
1092          * debugging. */
1093         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1094
1095         if (!VLOG_DROP_ERR(&rl)) {
1096             struct ds s;
1097
1098             ds_init(&s);
1099             odp_flow_format(key, key_len, NULL, 0, NULL, &s, true);
1100             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
1101             ds_destroy(&s);
1102         }
1103
1104         return EINVAL;
1105     }
1106
1107     in_port = flow->in_port.odp_port;
1108     if (!is_valid_port_number(in_port) && in_port != ODPP_NONE) {
1109         return EINVAL;
1110     }
1111
1112     return 0;
1113 }
1114
1115 static int
1116 dpif_netdev_flow_get(const struct dpif *dpif,
1117                      const struct nlattr *nl_key, size_t nl_key_len,
1118                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
1119 {
1120     struct dp_netdev *dp = get_dp_netdev(dpif);
1121     struct dp_netdev_flow *netdev_flow;
1122     struct flow key;
1123     int error;
1124
1125     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
1126     if (error) {
1127         return error;
1128     }
1129
1130     fat_rwlock_rdlock(&dp->cls.rwlock);
1131     netdev_flow = dp_netdev_find_flow(dp, &key);
1132     fat_rwlock_unlock(&dp->cls.rwlock);
1133
1134     if (netdev_flow) {
1135         struct dp_netdev_actions *actions = NULL;
1136
1137         ovs_mutex_lock(&netdev_flow->mutex);
1138         if (stats) {
1139             get_dpif_flow_stats(netdev_flow, stats);
1140         }
1141         if (actionsp) {
1142             actions = dp_netdev_actions_ref(netdev_flow->actions);
1143         }
1144         ovs_mutex_unlock(&netdev_flow->mutex);
1145
1146         dp_netdev_flow_unref(netdev_flow);
1147
1148         if (actionsp) {
1149             *actionsp = ofpbuf_clone_data(actions->actions, actions->size);
1150             dp_netdev_actions_unref(actions);
1151         }
1152     } else {
1153         error = ENOENT;
1154     }
1155
1156     return error;
1157 }
1158
1159 static int
1160 dp_netdev_flow_add(struct dp_netdev *dp, const struct flow *flow,
1161                    const struct flow_wildcards *wc,
1162                    const struct nlattr *actions,
1163                    size_t actions_len)
1164     OVS_REQUIRES(dp->flow_mutex)
1165 {
1166     struct dp_netdev_flow *netdev_flow;
1167     struct match match;
1168
1169     netdev_flow = xzalloc(sizeof *netdev_flow);
1170     *CONST_CAST(struct flow *, &netdev_flow->flow) = *flow;
1171     ovs_refcount_init(&netdev_flow->ref_cnt);
1172
1173     ovs_mutex_init(&netdev_flow->mutex);
1174     ovs_mutex_lock(&netdev_flow->mutex);
1175
1176     netdev_flow->actions = dp_netdev_actions_create(actions, actions_len);
1177
1178     match_init(&match, flow, wc);
1179     cls_rule_init(CONST_CAST(struct cls_rule *, &netdev_flow->cr),
1180                   &match, NETDEV_RULE_PRIORITY);
1181     fat_rwlock_wrlock(&dp->cls.rwlock);
1182     classifier_insert(&dp->cls,
1183                       CONST_CAST(struct cls_rule *, &netdev_flow->cr));
1184     hmap_insert(&dp->flow_table,
1185                 CONST_CAST(struct hmap_node *, &netdev_flow->node),
1186                 flow_hash(flow, 0));
1187     fat_rwlock_unlock(&dp->cls.rwlock);
1188
1189     ovs_mutex_unlock(&netdev_flow->mutex);
1190
1191     return 0;
1192 }
1193
1194 static void
1195 clear_stats(struct dp_netdev_flow *netdev_flow)
1196     OVS_REQUIRES(netdev_flow->mutex)
1197 {
1198     netdev_flow->used = 0;
1199     netdev_flow->packet_count = 0;
1200     netdev_flow->byte_count = 0;
1201     netdev_flow->tcp_flags = 0;
1202 }
1203
1204 static int
1205 dpif_netdev_flow_put(struct dpif *dpif, const struct dpif_flow_put *put)
1206 {
1207     struct dp_netdev *dp = get_dp_netdev(dpif);
1208     struct dp_netdev_flow *netdev_flow;
1209     struct flow flow;
1210     struct flow_wildcards wc;
1211     int error;
1212
1213     error = dpif_netdev_flow_from_nlattrs(put->key, put->key_len, &flow);
1214     if (error) {
1215         return error;
1216     }
1217     error = dpif_netdev_mask_from_nlattrs(put->key, put->key_len,
1218                                           put->mask, put->mask_len,
1219                                           &flow, &wc.masks);
1220     if (error) {
1221         return error;
1222     }
1223
1224     ovs_mutex_lock(&dp->flow_mutex);
1225     netdev_flow = dp_netdev_lookup_flow(dp, &flow);
1226     if (!netdev_flow) {
1227         if (put->flags & DPIF_FP_CREATE) {
1228             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
1229                 if (put->stats) {
1230                     memset(put->stats, 0, sizeof *put->stats);
1231                 }
1232                 error = dp_netdev_flow_add(dp, &flow, &wc, put->actions,
1233                                            put->actions_len);
1234             } else {
1235                 error = EFBIG;
1236             }
1237         } else {
1238             error = ENOENT;
1239         }
1240     } else {
1241         if (put->flags & DPIF_FP_MODIFY
1242             && flow_equal(&flow, &netdev_flow->flow)) {
1243             struct dp_netdev_actions *new_actions;
1244             struct dp_netdev_actions *old_actions;
1245
1246             new_actions = dp_netdev_actions_create(put->actions,
1247                                                    put->actions_len);
1248
1249             ovs_mutex_lock(&netdev_flow->mutex);
1250             old_actions = netdev_flow->actions;
1251             netdev_flow->actions = new_actions;
1252             if (put->stats) {
1253                 get_dpif_flow_stats(netdev_flow, put->stats);
1254             }
1255             if (put->flags & DPIF_FP_ZERO_STATS) {
1256                 clear_stats(netdev_flow);
1257             }
1258             ovs_mutex_unlock(&netdev_flow->mutex);
1259
1260             dp_netdev_actions_unref(old_actions);
1261         } else if (put->flags & DPIF_FP_CREATE) {
1262             error = EEXIST;
1263         } else {
1264             /* Overlapping flow. */
1265             error = EINVAL;
1266         }
1267         dp_netdev_flow_unref(netdev_flow);
1268     }
1269     ovs_mutex_unlock(&dp->flow_mutex);
1270
1271     return error;
1272 }
1273
1274 static int
1275 dpif_netdev_flow_del(struct dpif *dpif, const struct dpif_flow_del *del)
1276 {
1277     struct dp_netdev *dp = get_dp_netdev(dpif);
1278     struct dp_netdev_flow *netdev_flow;
1279     struct flow key;
1280     int error;
1281
1282     error = dpif_netdev_flow_from_nlattrs(del->key, del->key_len, &key);
1283     if (error) {
1284         return error;
1285     }
1286
1287     ovs_mutex_lock(&dp->flow_mutex);
1288     fat_rwlock_wrlock(&dp->cls.rwlock);
1289     netdev_flow = dp_netdev_find_flow(dp, &key);
1290     if (netdev_flow) {
1291         if (del->stats) {
1292             ovs_mutex_lock(&netdev_flow->mutex);
1293             get_dpif_flow_stats(netdev_flow, del->stats);
1294             ovs_mutex_unlock(&netdev_flow->mutex);
1295         }
1296         dp_netdev_remove_flow(dp, netdev_flow);
1297     } else {
1298         error = ENOENT;
1299     }
1300     fat_rwlock_unlock(&dp->cls.rwlock);
1301     ovs_mutex_unlock(&dp->flow_mutex);
1302
1303     return error;
1304 }
1305
1306 struct dp_netdev_flow_state {
1307     uint32_t bucket;
1308     uint32_t offset;
1309     struct dp_netdev_actions *actions;
1310     struct odputil_keybuf keybuf;
1311     struct odputil_keybuf maskbuf;
1312     struct dpif_flow_stats stats;
1313 };
1314
1315 static int
1316 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
1317 {
1318     struct dp_netdev_flow_state *state;
1319
1320     *statep = state = xmalloc(sizeof *state);
1321     state->bucket = 0;
1322     state->offset = 0;
1323     state->actions = NULL;
1324     return 0;
1325 }
1326
1327 static int
1328 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *state_,
1329                            const struct nlattr **key, size_t *key_len,
1330                            const struct nlattr **mask, size_t *mask_len,
1331                            const struct nlattr **actions, size_t *actions_len,
1332                            const struct dpif_flow_stats **stats)
1333 {
1334     struct dp_netdev_flow_state *state = state_;
1335     struct dp_netdev *dp = get_dp_netdev(dpif);
1336     struct dp_netdev_flow *netdev_flow;
1337     struct hmap_node *node;
1338
1339     fat_rwlock_rdlock(&dp->cls.rwlock);
1340     node = hmap_at_position(&dp->flow_table, &state->bucket, &state->offset);
1341     if (node) {
1342         netdev_flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
1343         dp_netdev_flow_ref(netdev_flow);
1344     }
1345     fat_rwlock_unlock(&dp->cls.rwlock);
1346     if (!node) {
1347         return EOF;
1348     }
1349
1350     if (key) {
1351         struct ofpbuf buf;
1352
1353         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
1354         odp_flow_key_from_flow(&buf, &netdev_flow->flow,
1355                                netdev_flow->flow.in_port.odp_port);
1356
1357         *key = buf.data;
1358         *key_len = buf.size;
1359     }
1360
1361     if (key && mask) {
1362         struct ofpbuf buf;
1363         struct flow_wildcards wc;
1364
1365         ofpbuf_use_stack(&buf, &state->maskbuf, sizeof state->maskbuf);
1366         minimask_expand(&netdev_flow->cr.match.mask, &wc);
1367         odp_flow_key_from_mask(&buf, &wc.masks, &netdev_flow->flow,
1368                                odp_to_u32(wc.masks.in_port.odp_port),
1369                                SIZE_MAX);
1370
1371         *mask = buf.data;
1372         *mask_len = buf.size;
1373     }
1374
1375     if (actions || stats) {
1376         dp_netdev_actions_unref(state->actions);
1377         state->actions = NULL;
1378
1379         ovs_mutex_lock(&netdev_flow->mutex);
1380         if (actions) {
1381             state->actions = dp_netdev_actions_ref(netdev_flow->actions);
1382             *actions = state->actions->actions;
1383             *actions_len = state->actions->size;
1384         }
1385         if (stats) {
1386             get_dpif_flow_stats(netdev_flow, &state->stats);
1387             *stats = &state->stats;
1388         }
1389         ovs_mutex_unlock(&netdev_flow->mutex);
1390     }
1391
1392     dp_netdev_flow_unref(netdev_flow);
1393
1394     return 0;
1395 }
1396
1397 static int
1398 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
1399 {
1400     struct dp_netdev_flow_state *state = state_;
1401
1402     dp_netdev_actions_unref(state->actions);
1403     free(state);
1404     return 0;
1405 }
1406
1407 static int
1408 dpif_netdev_execute(struct dpif *dpif, struct dpif_execute *execute)
1409 {
1410     struct dp_netdev *dp = get_dp_netdev(dpif);
1411     struct pkt_metadata *md = &execute->md;
1412     struct flow key;
1413
1414     if (execute->packet->size < ETH_HEADER_LEN ||
1415         execute->packet->size > UINT16_MAX) {
1416         return EINVAL;
1417     }
1418
1419     /* Extract flow key. */
1420     flow_extract(execute->packet, md->skb_priority, md->pkt_mark, &md->tunnel,
1421                  (union flow_in_port *)&md->in_port, &key);
1422
1423     ovs_rwlock_rdlock(&dp->port_rwlock);
1424     dp_netdev_execute_actions(dp, &key, execute->packet, md, execute->actions,
1425                               execute->actions_len);
1426     ovs_rwlock_unlock(&dp->port_rwlock);
1427
1428     return 0;
1429 }
1430
1431 static int
1432 dpif_netdev_recv_set(struct dpif *dpif OVS_UNUSED, bool enable OVS_UNUSED)
1433 {
1434     return 0;
1435 }
1436
1437 static int
1438 dpif_netdev_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
1439                               uint32_t queue_id, uint32_t *priority)
1440 {
1441     *priority = queue_id;
1442     return 0;
1443 }
1444
1445 static struct dp_netdev_queue *
1446 find_nonempty_queue(struct dp_netdev *dp)
1447     OVS_REQUIRES(dp->queue_mutex)
1448 {
1449     int i;
1450
1451     for (i = 0; i < N_QUEUES; i++) {
1452         struct dp_netdev_queue *q = &dp->queues[i];
1453         if (q->head != q->tail) {
1454             return q;
1455         }
1456     }
1457     return NULL;
1458 }
1459
1460 static int
1461 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall,
1462                  struct ofpbuf *buf)
1463 {
1464     struct dp_netdev *dp = get_dp_netdev(dpif);
1465     struct dp_netdev_queue *q;
1466     int error;
1467
1468     ovs_mutex_lock(&dp->queue_mutex);
1469     q = find_nonempty_queue(dp);
1470     if (q) {
1471         struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
1472
1473         *upcall = u->upcall;
1474
1475         ofpbuf_uninit(buf);
1476         *buf = u->buf;
1477
1478         error = 0;
1479     } else {
1480         error = EAGAIN;
1481     }
1482     ovs_mutex_unlock(&dp->queue_mutex);
1483
1484     return error;
1485 }
1486
1487 static void
1488 dpif_netdev_recv_wait(struct dpif *dpif)
1489 {
1490     struct dp_netdev *dp = get_dp_netdev(dpif);
1491     uint64_t seq;
1492
1493     ovs_mutex_lock(&dp->queue_mutex);
1494     seq = seq_read(dp->queue_seq);
1495     if (find_nonempty_queue(dp)) {
1496         poll_immediate_wake();
1497     } else {
1498         seq_wait(dp->queue_seq, seq);
1499     }
1500     ovs_mutex_unlock(&dp->queue_mutex);
1501 }
1502
1503 static void
1504 dpif_netdev_recv_purge(struct dpif *dpif)
1505 {
1506     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1507
1508     dp_netdev_purge_queues(dpif_netdev->dp);
1509 }
1510 \f
1511 /* Creates and returns a new 'struct dp_netdev_actions', with a reference count
1512  * of 1, whose actions are a copy of from the 'ofpacts_len' bytes of
1513  * 'ofpacts'. */
1514 struct dp_netdev_actions *
1515 dp_netdev_actions_create(const struct nlattr *actions, size_t size)
1516 {
1517     struct dp_netdev_actions *netdev_actions;
1518
1519     netdev_actions = xmalloc(sizeof *netdev_actions);
1520     ovs_refcount_init(&netdev_actions->ref_cnt);
1521     netdev_actions->actions = xmemdup(actions, size);
1522     netdev_actions->size = size;
1523
1524     return netdev_actions;
1525 }
1526
1527 /* Increments 'actions''s refcount. */
1528 struct dp_netdev_actions *
1529 dp_netdev_actions_ref(const struct dp_netdev_actions *actions_)
1530 {
1531     struct dp_netdev_actions *actions;
1532
1533     actions = CONST_CAST(struct dp_netdev_actions *, actions_);
1534     if (actions) {
1535         ovs_refcount_ref(&actions->ref_cnt);
1536     }
1537     return actions;
1538 }
1539
1540 /* Decrements 'actions''s refcount and frees 'actions' if the refcount reaches
1541  * 0. */
1542 void
1543 dp_netdev_actions_unref(struct dp_netdev_actions *actions)
1544 {
1545     if (actions && ovs_refcount_unref(&actions->ref_cnt) == 1) {
1546         free(actions->actions);
1547         free(actions);
1548     }
1549 }
1550 \f
1551 static void *
1552 dp_forwarder_main(void *f_)
1553 {
1554     struct dp_forwarder *f = f_;
1555     struct dp_netdev *dp = f->dp;
1556     struct ofpbuf packet;
1557
1558     f->name = xasprintf("forwarder_%u", ovsthread_id_self());
1559     set_subprogram_name("%s", f->name);
1560
1561     ofpbuf_init(&packet, 0);
1562     while (!latch_is_set(&dp->exit_latch)) {
1563         bool received_anything;
1564         int i;
1565
1566         ovs_rwlock_rdlock(&dp->port_rwlock);
1567         for (i = 0; i < 50; i++) {
1568             struct dp_netdev_port *port;
1569
1570             received_anything = false;
1571             HMAP_FOR_EACH (port, node, &f->dp->ports) {
1572                 if (port->rx
1573                     && port->node.hash >= f->min_hash
1574                     && port->node.hash <= f->max_hash) {
1575                     int buf_size;
1576                     int error;
1577                     int mtu;
1578
1579                     if (netdev_get_mtu(port->netdev, &mtu)) {
1580                         mtu = ETH_PAYLOAD_MAX;
1581                     }
1582                     buf_size = DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + mtu;
1583
1584                     ofpbuf_clear(&packet);
1585                     ofpbuf_reserve_with_tailroom(&packet, DP_NETDEV_HEADROOM,
1586                                                  buf_size);
1587
1588                     error = netdev_rx_recv(port->rx, &packet);
1589                     if (!error) {
1590                         struct pkt_metadata md
1591                             = PKT_METADATA_INITIALIZER(port->port_no);
1592                         dp_netdev_port_input(dp, &packet, &md);
1593
1594                         received_anything = true;
1595                     } else if (error != EAGAIN && error != EOPNOTSUPP) {
1596                         static struct vlog_rate_limit rl
1597                             = VLOG_RATE_LIMIT_INIT(1, 5);
1598
1599                         VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1600                                     netdev_get_name(port->netdev),
1601                                     ovs_strerror(error));
1602                     }
1603                 }
1604             }
1605
1606             if (!received_anything) {
1607                 break;
1608             }
1609         }
1610
1611         if (received_anything) {
1612             poll_immediate_wake();
1613         } else {
1614             struct dp_netdev_port *port;
1615
1616             HMAP_FOR_EACH (port, node, &f->dp->ports)
1617                 if (port->rx
1618                     && port->node.hash >= f->min_hash
1619                     && port->node.hash <= f->max_hash) {
1620                     netdev_rx_wait(port->rx);
1621                 }
1622             seq_wait(dp->port_seq, seq_read(dp->port_seq));
1623             latch_wait(&dp->exit_latch);
1624         }
1625         ovs_rwlock_unlock(&dp->port_rwlock);
1626
1627         poll_block();
1628     }
1629     ofpbuf_uninit(&packet);
1630
1631     free(f->name);
1632
1633     return NULL;
1634 }
1635
1636 static void
1637 dp_netdev_set_threads(struct dp_netdev *dp, int n)
1638 {
1639     int i;
1640
1641     if (n == dp->n_forwarders) {
1642         return;
1643     }
1644
1645     /* Stop existing threads. */
1646     latch_set(&dp->exit_latch);
1647     for (i = 0; i < dp->n_forwarders; i++) {
1648         struct dp_forwarder *f = &dp->forwarders[i];
1649
1650         xpthread_join(f->thread, NULL);
1651     }
1652     latch_poll(&dp->exit_latch);
1653     free(dp->forwarders);
1654
1655     /* Start new threads. */
1656     dp->forwarders = xmalloc(n * sizeof *dp->forwarders);
1657     dp->n_forwarders = n;
1658     for (i = 0; i < n; i++) {
1659         struct dp_forwarder *f = &dp->forwarders[i];
1660
1661         f->dp = dp;
1662         f->min_hash = UINT32_MAX / n * i;
1663         f->max_hash = UINT32_MAX / n * (i + 1) - 1;
1664         if (i == n - 1) {
1665             f->max_hash = UINT32_MAX;
1666         }
1667         xpthread_create(&f->thread, NULL, dp_forwarder_main, f);
1668     }
1669 }
1670 \f
1671 static void
1672 dp_netdev_flow_used(struct dp_netdev_flow *netdev_flow,
1673                     const struct ofpbuf *packet)
1674     OVS_REQUIRES(netdev_flow->mutex)
1675 {
1676     netdev_flow->used = time_msec();
1677     netdev_flow->packet_count++;
1678     netdev_flow->byte_count += packet->size;
1679     netdev_flow->tcp_flags |= packet_get_tcp_flags(packet, &netdev_flow->flow);
1680 }
1681
1682 static void
1683 dp_netdev_port_input(struct dp_netdev *dp, struct ofpbuf *packet,
1684                      struct pkt_metadata *md)
1685     OVS_REQ_RDLOCK(dp->port_rwlock)
1686 {
1687     struct dp_netdev_flow *netdev_flow;
1688     struct flow key;
1689
1690     if (packet->size < ETH_HEADER_LEN) {
1691         return;
1692     }
1693     flow_extract(packet, md->skb_priority, md->pkt_mark, &md->tunnel,
1694                  (union flow_in_port *)&md->in_port, &key);
1695     netdev_flow = dp_netdev_lookup_flow(dp, &key);
1696     if (netdev_flow) {
1697         struct dp_netdev_actions *actions;
1698
1699         ovs_mutex_lock(&netdev_flow->mutex);
1700         dp_netdev_flow_used(netdev_flow, packet);
1701         actions = dp_netdev_actions_ref(netdev_flow->actions);
1702         ovs_mutex_unlock(&netdev_flow->mutex);
1703
1704         dp_netdev_execute_actions(dp, &key, packet, md,
1705                                   actions->actions, actions->size);
1706         dp_netdev_actions_unref(actions);
1707         ovsthread_counter_inc(dp->n_hit, 1);
1708     } else {
1709         ovsthread_counter_inc(dp->n_missed, 1);
1710         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, NULL);
1711     }
1712 }
1713
1714 static int
1715 dp_netdev_output_userspace(struct dp_netdev *dp, struct ofpbuf *packet,
1716                            int queue_no, const struct flow *flow,
1717                            const struct nlattr *userdata)
1718     OVS_EXCLUDED(dp->queue_mutex)
1719 {
1720     struct dp_netdev_queue *q = &dp->queues[queue_no];
1721     int error;
1722
1723     ovs_mutex_lock(&dp->queue_mutex);
1724     if (q->head - q->tail < MAX_QUEUE_LEN) {
1725         struct dp_netdev_upcall *u = &q->upcalls[q->head++ & QUEUE_MASK];
1726         struct dpif_upcall *upcall = &u->upcall;
1727         struct ofpbuf *buf = &u->buf;
1728         size_t buf_size;
1729
1730         upcall->type = queue_no;
1731
1732         /* Allocate buffer big enough for everything. */
1733         buf_size = ODPUTIL_FLOW_KEY_BYTES;
1734         if (userdata) {
1735             buf_size += NLA_ALIGN(userdata->nla_len);
1736         }
1737         ofpbuf_init(buf, buf_size);
1738
1739         /* Put ODP flow. */
1740         odp_flow_key_from_flow(buf, flow, flow->in_port.odp_port);
1741         upcall->key = buf->data;
1742         upcall->key_len = buf->size;
1743
1744         /* Put userdata. */
1745         if (userdata) {
1746             upcall->userdata = ofpbuf_put(buf, userdata,
1747                                           NLA_ALIGN(userdata->nla_len));
1748         }
1749
1750         /* Steal packet data. */
1751         ovs_assert(packet->source == OFPBUF_MALLOC);
1752         upcall->packet = *packet;
1753         ofpbuf_use(packet, NULL, 0);
1754
1755         seq_change(dp->queue_seq);
1756
1757         error = 0;
1758     } else {
1759         ovsthread_counter_inc(dp->n_lost, 1);
1760         error = ENOBUFS;
1761     }
1762     ovs_mutex_unlock(&dp->queue_mutex);
1763
1764     return error;
1765 }
1766
1767 struct dp_netdev_execute_aux {
1768     struct dp_netdev *dp;
1769     const struct flow *key;
1770 };
1771
1772 static void
1773 dp_execute_cb(void *aux_, struct ofpbuf *packet,
1774               const struct pkt_metadata *md OVS_UNUSED,
1775               const struct nlattr *a, bool may_steal)
1776     OVS_NO_THREAD_SAFETY_ANALYSIS
1777 {
1778     struct dp_netdev_execute_aux *aux = aux_;
1779     int type = nl_attr_type(a);
1780     struct dp_netdev_port *p;
1781
1782     switch ((enum ovs_action_attr)type) {
1783     case OVS_ACTION_ATTR_OUTPUT:
1784         p = dp_netdev_lookup_port(aux->dp, u32_to_odp(nl_attr_get_u32(a)));
1785         if (p) {
1786             netdev_send(p->netdev, packet);
1787         }
1788         break;
1789
1790     case OVS_ACTION_ATTR_USERSPACE: {
1791         const struct nlattr *userdata;
1792
1793         userdata = nl_attr_find_nested(a, OVS_USERSPACE_ATTR_USERDATA);
1794
1795         /* Make a copy if we are not allowed to steal the packet's data. */
1796         if (!may_steal) {
1797             packet = ofpbuf_clone_with_headroom(packet, DP_NETDEV_HEADROOM);
1798         }
1799         dp_netdev_output_userspace(aux->dp, packet, DPIF_UC_ACTION, aux->key,
1800                                    userdata);
1801         if (!may_steal) {
1802             ofpbuf_uninit(packet);
1803         }
1804         break;
1805     }
1806     case OVS_ACTION_ATTR_PUSH_VLAN:
1807     case OVS_ACTION_ATTR_POP_VLAN:
1808     case OVS_ACTION_ATTR_PUSH_MPLS:
1809     case OVS_ACTION_ATTR_POP_MPLS:
1810     case OVS_ACTION_ATTR_SET:
1811     case OVS_ACTION_ATTR_SAMPLE:
1812     case OVS_ACTION_ATTR_UNSPEC:
1813     case __OVS_ACTION_ATTR_MAX:
1814         OVS_NOT_REACHED();
1815     }
1816 }
1817
1818 static void
1819 dp_netdev_execute_actions(struct dp_netdev *dp, const struct flow *key,
1820                           struct ofpbuf *packet, struct pkt_metadata *md,
1821                           const struct nlattr *actions, size_t actions_len)
1822     OVS_REQ_RDLOCK(dp->port_rwlock)
1823 {
1824     struct dp_netdev_execute_aux aux = {dp, key};
1825
1826     odp_execute_actions(&aux, packet, md, actions, actions_len, dp_execute_cb);
1827 }
1828
1829 const struct dpif_class dpif_netdev_class = {
1830     "netdev",
1831     dpif_netdev_enumerate,
1832     dpif_netdev_port_open_type,
1833     dpif_netdev_open,
1834     dpif_netdev_close,
1835     dpif_netdev_destroy,
1836     NULL,                       /* run */
1837     NULL,                       /* wait */
1838     dpif_netdev_get_stats,
1839     dpif_netdev_port_add,
1840     dpif_netdev_port_del,
1841     dpif_netdev_port_query_by_number,
1842     dpif_netdev_port_query_by_name,
1843     NULL,                       /* port_get_pid */
1844     dpif_netdev_port_dump_start,
1845     dpif_netdev_port_dump_next,
1846     dpif_netdev_port_dump_done,
1847     dpif_netdev_port_poll,
1848     dpif_netdev_port_poll_wait,
1849     dpif_netdev_flow_get,
1850     dpif_netdev_flow_put,
1851     dpif_netdev_flow_del,
1852     dpif_netdev_flow_flush,
1853     dpif_netdev_flow_dump_start,
1854     dpif_netdev_flow_dump_next,
1855     dpif_netdev_flow_dump_done,
1856     dpif_netdev_execute,
1857     NULL,                       /* operate */
1858     dpif_netdev_recv_set,
1859     dpif_netdev_queue_to_priority,
1860     dpif_netdev_recv,
1861     dpif_netdev_recv_wait,
1862     dpif_netdev_recv_purge,
1863 };
1864
1865 static void
1866 dpif_dummy_change_port_number(struct unixctl_conn *conn, int argc OVS_UNUSED,
1867                               const char *argv[], void *aux OVS_UNUSED)
1868 {
1869     struct dp_netdev_port *port;
1870     struct dp_netdev *dp;
1871     odp_port_t port_no;
1872
1873     ovs_mutex_lock(&dp_netdev_mutex);
1874     dp = shash_find_data(&dp_netdevs, argv[1]);
1875     if (!dp || !dpif_netdev_class_is_dummy(dp->class)) {
1876         ovs_mutex_unlock(&dp_netdev_mutex);
1877         unixctl_command_reply_error(conn, "unknown datapath or not a dummy");
1878         return;
1879     }
1880     ovs_refcount_ref(&dp->ref_cnt);
1881     ovs_mutex_unlock(&dp_netdev_mutex);
1882
1883     ovs_rwlock_wrlock(&dp->port_rwlock);
1884     if (get_port_by_name(dp, argv[2], &port)) {
1885         unixctl_command_reply_error(conn, "unknown port");
1886         goto exit;
1887     }
1888
1889     port_no = u32_to_odp(atoi(argv[3]));
1890     if (!port_no || port_no == ODPP_NONE) {
1891         unixctl_command_reply_error(conn, "bad port number");
1892         goto exit;
1893     }
1894     if (dp_netdev_lookup_port(dp, port_no)) {
1895         unixctl_command_reply_error(conn, "port number already in use");
1896         goto exit;
1897     }
1898     hmap_remove(&dp->ports, &port->node);
1899     port->port_no = port_no;
1900     hmap_insert(&dp->ports, &port->node, hash_int(odp_to_u32(port_no), 0));
1901     seq_change(dp->port_seq);
1902     unixctl_command_reply(conn, NULL);
1903
1904 exit:
1905     ovs_rwlock_unlock(&dp->port_rwlock);
1906     dp_netdev_unref(dp);
1907 }
1908
1909 static void
1910 dpif_dummy_register__(const char *type)
1911 {
1912     struct dpif_class *class;
1913
1914     class = xmalloc(sizeof *class);
1915     *class = dpif_netdev_class;
1916     class->type = xstrdup(type);
1917     dp_register_provider(class);
1918 }
1919
1920 void
1921 dpif_dummy_register(bool override)
1922 {
1923     if (override) {
1924         struct sset types;
1925         const char *type;
1926
1927         sset_init(&types);
1928         dp_enumerate_types(&types);
1929         SSET_FOR_EACH (type, &types) {
1930             if (!dp_unregister_provider(type)) {
1931                 dpif_dummy_register__(type);
1932             }
1933         }
1934         sset_destroy(&types);
1935     }
1936
1937     dpif_dummy_register__("dummy");
1938
1939     unixctl_command_register("dpif-dummy/change-port-number",
1940                              "DP PORT NEW-NUMBER",
1941                              3, 3, dpif_dummy_change_port_number, NULL);
1942 }