flow: Rename skb_mark to pkt_mark.
[sliver-openvswitch.git] / lib / dpif-netdev.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 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 "csum.h"
35 #include "dpif.h"
36 #include "dpif-provider.h"
37 #include "dummy.h"
38 #include "dynamic-string.h"
39 #include "flow.h"
40 #include "hmap.h"
41 #include "list.h"
42 #include "netdev.h"
43 #include "netdev-vport.h"
44 #include "netlink.h"
45 #include "odp-execute.h"
46 #include "odp-util.h"
47 #include "ofp-print.h"
48 #include "ofpbuf.h"
49 #include "packets.h"
50 #include "poll-loop.h"
51 #include "random.h"
52 #include "seq.h"
53 #include "shash.h"
54 #include "sset.h"
55 #include "timeval.h"
56 #include "unixctl.h"
57 #include "util.h"
58 #include "vlog.h"
59
60 VLOG_DEFINE_THIS_MODULE(dpif_netdev);
61
62 /* Configuration parameters. */
63 enum { MAX_PORTS = 256 };       /* Maximum number of ports. */
64 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
65
66 /* Enough headroom to add a vlan tag, plus an extra 2 bytes to allow IP
67  * headers to be aligned on a 4-byte boundary.  */
68 enum { DP_NETDEV_HEADROOM = 2 + VLAN_HEADER_LEN };
69
70 /* Queues. */
71 enum { N_QUEUES = 2 };          /* Number of queues for dpif_recv(). */
72 enum { MAX_QUEUE_LEN = 128 };   /* Maximum number of packets per queue. */
73 enum { QUEUE_MASK = MAX_QUEUE_LEN - 1 };
74 BUILD_ASSERT_DECL(IS_POW2(MAX_QUEUE_LEN));
75
76 struct dp_netdev_upcall {
77     struct dpif_upcall upcall;  /* Queued upcall information. */
78     struct ofpbuf buf;          /* ofpbuf instance for upcall.packet. */
79 };
80
81 struct dp_netdev_queue {
82     struct dp_netdev_upcall upcalls[MAX_QUEUE_LEN];
83     unsigned int head, tail;
84 };
85
86 /* Datapath based on the network device interface from netdev.h. */
87 struct dp_netdev {
88     const struct dpif_class *class;
89     char *name;
90     int open_cnt;
91     bool destroyed;
92     int max_mtu;                /* Maximum MTU of any port added so far. */
93
94     struct dp_netdev_queue queues[N_QUEUES];
95     struct hmap flow_table;     /* Flow table. */
96     struct seq *queue_seq;      /* Incremented whenever a packet is queued. */
97
98     /* Statistics. */
99     long long int n_hit;        /* Number of flow table matches. */
100     long long int n_missed;     /* Number of flow table misses. */
101     long long int n_lost;       /* Number of misses not passed to client. */
102
103     /* Ports. */
104     struct dp_netdev_port *ports[MAX_PORTS];
105     struct list port_list;
106     struct seq *port_seq;       /* Incremented whenever a port changes. */
107 };
108
109 /* A port in a netdev-based datapath. */
110 struct dp_netdev_port {
111     odp_port_t port_no;         /* Index into dp_netdev's 'ports'. */
112     struct list node;           /* Element in dp_netdev's 'port_list'. */
113     struct netdev *netdev;
114     struct netdev_saved_flags *sf;
115     struct netdev_rx *rx;
116     char *type;                 /* Port type as requested by user. */
117 };
118
119 /* A flow in dp_netdev's 'flow_table'. */
120 struct dp_netdev_flow {
121     struct hmap_node node;      /* Element in dp_netdev's 'flow_table'. */
122     struct flow key;
123
124     /* Statistics. */
125     long long int used;         /* Last used time, in monotonic msecs. */
126     long long int packet_count; /* Number of packets matched. */
127     long long int byte_count;   /* Number of bytes matched. */
128     uint8_t tcp_flags;          /* Bitwise-OR of seen tcp_flags values. */
129
130     /* Actions. */
131     struct nlattr *actions;
132     size_t actions_len;
133 };
134
135 /* Interface to netdev-based datapath. */
136 struct dpif_netdev {
137     struct dpif dpif;
138     struct dp_netdev *dp;
139     uint64_t last_port_seq;
140 };
141
142 /* All netdev-based datapaths. */
143 static struct shash dp_netdevs = SHASH_INITIALIZER(&dp_netdevs);
144
145 /* Global lock for all data. */
146 static struct ovs_mutex dp_netdev_mutex = OVS_MUTEX_INITIALIZER;
147
148 static int get_port_by_number(struct dp_netdev *, odp_port_t port_no,
149                               struct dp_netdev_port **portp);
150 static int get_port_by_name(struct dp_netdev *, const char *devname,
151                             struct dp_netdev_port **portp);
152 static void dp_netdev_free(struct dp_netdev *);
153 static void dp_netdev_flow_flush(struct dp_netdev *);
154 static int do_add_port(struct dp_netdev *, const char *devname,
155                        const char *type, odp_port_t port_no);
156 static int do_del_port(struct dp_netdev *, odp_port_t port_no);
157 static int dpif_netdev_open(const struct dpif_class *, const char *name,
158                             bool create, struct dpif **);
159 static int dp_netdev_output_userspace(struct dp_netdev *, const struct ofpbuf *,
160                                     int queue_no, const struct flow *,
161                                     const struct nlattr *userdata);
162 static void dp_netdev_execute_actions(struct dp_netdev *,
163                                       struct ofpbuf *, struct flow *,
164                                       const struct nlattr *actions,
165                                       size_t actions_len);
166 static void dp_netdev_port_input(struct dp_netdev *dp,
167                                  struct dp_netdev_port *port,
168                                  struct ofpbuf *packet, uint32_t skb_priority,
169                                  uint32_t pkt_mark, const struct flow_tnl *tnl);
170
171 static struct dpif_netdev *
172 dpif_netdev_cast(const struct dpif *dpif)
173 {
174     ovs_assert(dpif->dpif_class->open == dpif_netdev_open);
175     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
176 }
177
178 static struct dp_netdev *
179 get_dp_netdev(const struct dpif *dpif)
180 {
181     return dpif_netdev_cast(dpif)->dp;
182 }
183
184 static int
185 dpif_netdev_enumerate(struct sset *all_dps)
186 {
187     struct shash_node *node;
188
189     ovs_mutex_lock(&dp_netdev_mutex);
190     SHASH_FOR_EACH(node, &dp_netdevs) {
191         sset_add(all_dps, node->name);
192     }
193     ovs_mutex_unlock(&dp_netdev_mutex);
194
195     return 0;
196 }
197
198 static bool
199 dpif_netdev_class_is_dummy(const struct dpif_class *class)
200 {
201     return class != &dpif_netdev_class;
202 }
203
204 static const char *
205 dpif_netdev_port_open_type(const struct dpif_class *class, const char *type)
206 {
207     return strcmp(type, "internal") ? type
208                   : dpif_netdev_class_is_dummy(class) ? "dummy"
209                   : "tap";
210 }
211
212 static struct dpif *
213 create_dpif_netdev(struct dp_netdev *dp)
214 {
215     uint16_t netflow_id = hash_string(dp->name, 0);
216     struct dpif_netdev *dpif;
217
218     dp->open_cnt++;
219
220     dpif = xmalloc(sizeof *dpif);
221     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
222     dpif->dp = dp;
223     dpif->last_port_seq = seq_read(dp->port_seq);
224
225     return &dpif->dpif;
226 }
227
228 /* Choose an unused, non-zero port number and return it on success.
229  * Return ODPP_NONE on failure. */
230 static odp_port_t
231 choose_port(struct dp_netdev *dp, const char *name)
232 {
233     uint32_t port_no;
234
235     if (dp->class != &dpif_netdev_class) {
236         const char *p;
237         int start_no = 0;
238
239         /* If the port name begins with "br", start the number search at
240          * 100 to make writing tests easier. */
241         if (!strncmp(name, "br", 2)) {
242             start_no = 100;
243         }
244
245         /* If the port name contains a number, try to assign that port number.
246          * This can make writing unit tests easier because port numbers are
247          * predictable. */
248         for (p = name; *p != '\0'; p++) {
249             if (isdigit((unsigned char) *p)) {
250                 port_no = start_no + strtol(p, NULL, 10);
251                 if (port_no > 0 && port_no < MAX_PORTS
252                     && !dp->ports[port_no]) {
253                     return u32_to_odp(port_no);
254                 }
255                 break;
256             }
257         }
258     }
259
260     for (port_no = 1; port_no < MAX_PORTS; port_no++) {
261         if (!dp->ports[port_no]) {
262             return u32_to_odp(port_no);
263         }
264     }
265
266     return ODPP_NONE;
267 }
268
269 static int
270 create_dp_netdev(const char *name, const struct dpif_class *class,
271                  struct dp_netdev **dpp)
272 {
273     struct dp_netdev *dp;
274     int error;
275     int i;
276
277     dp = xzalloc(sizeof *dp);
278     dp->class = class;
279     dp->name = xstrdup(name);
280     dp->open_cnt = 0;
281     dp->max_mtu = ETH_PAYLOAD_MAX;
282     for (i = 0; i < N_QUEUES; i++) {
283         dp->queues[i].head = dp->queues[i].tail = 0;
284     }
285     dp->queue_seq = seq_create();
286     hmap_init(&dp->flow_table);
287     list_init(&dp->port_list);
288     dp->port_seq = seq_create();
289
290     error = do_add_port(dp, name, "internal", ODPP_LOCAL);
291     if (error) {
292         dp_netdev_free(dp);
293         return error;
294     }
295
296     shash_add(&dp_netdevs, name, dp);
297
298     *dpp = dp;
299     return 0;
300 }
301
302 static int
303 dpif_netdev_open(const struct dpif_class *class, const char *name,
304                  bool create, struct dpif **dpifp)
305 {
306     struct dp_netdev *dp;
307     int error;
308
309     ovs_mutex_lock(&dp_netdev_mutex);
310     dp = shash_find_data(&dp_netdevs, name);
311     if (!dp) {
312         error = create ? create_dp_netdev(name, class, &dp) : ENODEV;
313     } else {
314         error = (dp->class != class ? EINVAL
315                  : create ? EEXIST
316                  : 0);
317     }
318     if (!error) {
319         *dpifp = create_dpif_netdev(dp);
320     }
321     ovs_mutex_unlock(&dp_netdev_mutex);
322
323     return error;
324 }
325
326 static void
327 dp_netdev_purge_queues(struct dp_netdev *dp)
328 {
329     int i;
330
331     for (i = 0; i < N_QUEUES; i++) {
332         struct dp_netdev_queue *q = &dp->queues[i];
333
334         while (q->tail != q->head) {
335             struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
336             ofpbuf_uninit(&u->buf);
337         }
338     }
339 }
340
341 static void
342 dp_netdev_free(struct dp_netdev *dp)
343 {
344     struct dp_netdev_port *port, *next;
345
346     dp_netdev_flow_flush(dp);
347     LIST_FOR_EACH_SAFE (port, next, node, &dp->port_list) {
348         do_del_port(dp, port->port_no);
349     }
350     dp_netdev_purge_queues(dp);
351     seq_destroy(dp->queue_seq);
352     hmap_destroy(&dp->flow_table);
353     seq_destroy(dp->port_seq);
354     free(dp->name);
355     free(dp);
356 }
357
358 static void
359 dpif_netdev_close(struct dpif *dpif)
360 {
361     struct dp_netdev *dp = get_dp_netdev(dpif);
362
363     ovs_mutex_lock(&dp_netdev_mutex);
364
365     ovs_assert(dp->open_cnt > 0);
366     if (--dp->open_cnt == 0 && dp->destroyed) {
367         shash_find_and_delete(&dp_netdevs, dp->name);
368         dp_netdev_free(dp);
369     }
370     free(dpif);
371
372     ovs_mutex_unlock(&dp_netdev_mutex);
373 }
374
375 static int
376 dpif_netdev_destroy(struct dpif *dpif)
377 {
378     struct dp_netdev *dp = get_dp_netdev(dpif);
379
380     ovs_mutex_lock(&dp_netdev_mutex);
381     dp->destroyed = true;
382     ovs_mutex_unlock(&dp_netdev_mutex);
383
384     return 0;
385 }
386
387 static int
388 dpif_netdev_get_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
389 {
390     struct dp_netdev *dp = get_dp_netdev(dpif);
391
392     ovs_mutex_lock(&dp_netdev_mutex);
393     stats->n_flows = hmap_count(&dp->flow_table);
394     stats->n_hit = dp->n_hit;
395     stats->n_missed = dp->n_missed;
396     stats->n_lost = dp->n_lost;
397     ovs_mutex_unlock(&dp_netdev_mutex);
398
399     return 0;
400 }
401
402 static int
403 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
404             odp_port_t port_no)
405 {
406     struct netdev_saved_flags *sf;
407     struct dp_netdev_port *port;
408     struct netdev *netdev;
409     struct netdev_rx *rx;
410     const char *open_type;
411     int mtu;
412     int error;
413
414     /* XXX reject devices already in some dp_netdev. */
415
416     /* Open and validate network device. */
417     open_type = dpif_netdev_port_open_type(dp->class, type);
418     error = netdev_open(devname, open_type, &netdev);
419     if (error) {
420         return error;
421     }
422     /* XXX reject loopback devices */
423     /* XXX reject non-Ethernet devices */
424
425     error = netdev_rx_open(netdev, &rx);
426     if (error
427         && !(error == EOPNOTSUPP && dpif_netdev_class_is_dummy(dp->class))) {
428         VLOG_ERR("%s: cannot receive packets on this network device (%s)",
429                  devname, ovs_strerror(errno));
430         netdev_close(netdev);
431         return error;
432     }
433
434     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, &sf);
435     if (error) {
436         netdev_rx_close(rx);
437         netdev_close(netdev);
438         return error;
439     }
440
441     port = xmalloc(sizeof *port);
442     port->port_no = port_no;
443     port->netdev = netdev;
444     port->sf = sf;
445     port->rx = rx;
446     port->type = xstrdup(type);
447
448     error = netdev_get_mtu(netdev, &mtu);
449     if (!error && mtu > dp->max_mtu) {
450         dp->max_mtu = mtu;
451     }
452
453     list_push_back(&dp->port_list, &port->node);
454     dp->ports[odp_to_u32(port_no)] = port;
455     seq_change(dp->port_seq);
456
457     return 0;
458 }
459
460 static int
461 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
462                      odp_port_t *port_nop)
463 {
464     struct dp_netdev *dp = get_dp_netdev(dpif);
465     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
466     const char *dpif_port;
467     odp_port_t port_no;
468     int error;
469
470     ovs_mutex_lock(&dp_netdev_mutex);
471     dpif_port = netdev_vport_get_dpif_port(netdev, namebuf, sizeof namebuf);
472     if (*port_nop != ODPP_NONE) {
473         uint32_t port_idx = odp_to_u32(*port_nop);
474         if (port_idx >= MAX_PORTS) {
475             error = EFBIG;
476         } else if (dp->ports[port_idx]) {
477             error = EBUSY;
478         } else {
479             error = 0;
480             port_no = *port_nop;
481         }
482     } else {
483         port_no = choose_port(dp, dpif_port);
484         error = port_no == ODPP_NONE ? EFBIG : 0;
485     }
486     if (!error) {
487         *port_nop = port_no;
488         error = do_add_port(dp, dpif_port, netdev_get_type(netdev), port_no);
489     }
490     ovs_mutex_unlock(&dp_netdev_mutex);
491
492     return error;
493 }
494
495 static int
496 dpif_netdev_port_del(struct dpif *dpif, odp_port_t port_no)
497 {
498     struct dp_netdev *dp = get_dp_netdev(dpif);
499     int error;
500
501     ovs_mutex_lock(&dp_netdev_mutex);
502     error = port_no == ODPP_LOCAL ? EINVAL : do_del_port(dp, port_no);
503     ovs_mutex_unlock(&dp_netdev_mutex);
504
505     return error;
506 }
507
508 static bool
509 is_valid_port_number(odp_port_t port_no)
510 {
511     return odp_to_u32(port_no) < MAX_PORTS;
512 }
513
514 static int
515 get_port_by_number(struct dp_netdev *dp,
516                    odp_port_t port_no, struct dp_netdev_port **portp)
517 {
518     if (!is_valid_port_number(port_no)) {
519         *portp = NULL;
520         return EINVAL;
521     } else {
522         *portp = dp->ports[odp_to_u32(port_no)];
523         return *portp ? 0 : ENOENT;
524     }
525 }
526
527 static int
528 get_port_by_name(struct dp_netdev *dp,
529                  const char *devname, struct dp_netdev_port **portp)
530 {
531     struct dp_netdev_port *port;
532
533     LIST_FOR_EACH (port, node, &dp->port_list) {
534         if (!strcmp(netdev_get_name(port->netdev), devname)) {
535             *portp = port;
536             return 0;
537         }
538     }
539     return ENOENT;
540 }
541
542 static int
543 do_del_port(struct dp_netdev *dp, odp_port_t port_no)
544 {
545     struct dp_netdev_port *port;
546     int error;
547
548     error = get_port_by_number(dp, port_no, &port);
549     if (error) {
550         return error;
551     }
552
553     list_remove(&port->node);
554     dp->ports[odp_to_u32(port_no)] = NULL;
555     seq_change(dp->port_seq);
556
557     netdev_close(port->netdev);
558     netdev_restore_flags(port->sf);
559     netdev_rx_close(port->rx);
560     free(port->type);
561     free(port);
562
563     return 0;
564 }
565
566 static void
567 answer_port_query(const struct dp_netdev_port *port,
568                   struct dpif_port *dpif_port)
569 {
570     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
571     dpif_port->type = xstrdup(port->type);
572     dpif_port->port_no = port->port_no;
573 }
574
575 static int
576 dpif_netdev_port_query_by_number(const struct dpif *dpif, odp_port_t port_no,
577                                  struct dpif_port *dpif_port)
578 {
579     struct dp_netdev *dp = get_dp_netdev(dpif);
580     struct dp_netdev_port *port;
581     int error;
582
583     ovs_mutex_lock(&dp_netdev_mutex);
584     error = get_port_by_number(dp, port_no, &port);
585     if (!error && dpif_port) {
586         answer_port_query(port, dpif_port);
587     }
588     ovs_mutex_unlock(&dp_netdev_mutex);
589
590     return error;
591 }
592
593 static int
594 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
595                                struct dpif_port *dpif_port)
596 {
597     struct dp_netdev *dp = get_dp_netdev(dpif);
598     struct dp_netdev_port *port;
599     int error;
600
601     ovs_mutex_lock(&dp_netdev_mutex);
602     error = get_port_by_name(dp, devname, &port);
603     if (!error && dpif_port) {
604         answer_port_query(port, dpif_port);
605     }
606     ovs_mutex_unlock(&dp_netdev_mutex);
607
608     return error;
609 }
610
611 static odp_port_t
612 dpif_netdev_get_max_ports(const struct dpif *dpif OVS_UNUSED)
613 {
614     return u32_to_odp(MAX_PORTS);
615 }
616
617 static void
618 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
619 {
620     hmap_remove(&dp->flow_table, &flow->node);
621     free(flow->actions);
622     free(flow);
623 }
624
625 static void
626 dp_netdev_flow_flush(struct dp_netdev *dp)
627 {
628     struct dp_netdev_flow *flow, *next;
629
630     HMAP_FOR_EACH_SAFE (flow, next, node, &dp->flow_table) {
631         dp_netdev_free_flow(dp, flow);
632     }
633 }
634
635 static int
636 dpif_netdev_flow_flush(struct dpif *dpif)
637 {
638     struct dp_netdev *dp = get_dp_netdev(dpif);
639
640     ovs_mutex_lock(&dp_netdev_mutex);
641     dp_netdev_flow_flush(dp);
642     ovs_mutex_unlock(&dp_netdev_mutex);
643
644     return 0;
645 }
646
647 struct dp_netdev_port_state {
648     odp_port_t port_no;
649     char *name;
650 };
651
652 static int
653 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
654 {
655     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
656     return 0;
657 }
658
659 static int
660 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
661                            struct dpif_port *dpif_port)
662 {
663     struct dp_netdev_port_state *state = state_;
664     struct dp_netdev *dp = get_dp_netdev(dpif);
665     uint32_t port_idx;
666
667     ovs_mutex_lock(&dp_netdev_mutex);
668     for (port_idx = odp_to_u32(state->port_no);
669          port_idx < MAX_PORTS; port_idx++) {
670         struct dp_netdev_port *port = dp->ports[port_idx];
671         if (port) {
672             free(state->name);
673             state->name = xstrdup(netdev_get_name(port->netdev));
674             dpif_port->name = state->name;
675             dpif_port->type = port->type;
676             dpif_port->port_no = port->port_no;
677             state->port_no = u32_to_odp(port_idx + 1);
678             ovs_mutex_unlock(&dp_netdev_mutex);
679
680             return 0;
681         }
682     }
683     ovs_mutex_unlock(&dp_netdev_mutex);
684
685     return EOF;
686 }
687
688 static int
689 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
690 {
691     struct dp_netdev_port_state *state = state_;
692     free(state->name);
693     free(state);
694     return 0;
695 }
696
697 static int
698 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
699 {
700     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
701     uint64_t new_port_seq;
702     int error;
703
704     ovs_mutex_lock(&dp_netdev_mutex);
705     new_port_seq = seq_read(dpif->dp->port_seq);
706     if (dpif->last_port_seq != new_port_seq) {
707         dpif->last_port_seq = new_port_seq;
708         error = ENOBUFS;
709     } else {
710         error = EAGAIN;
711     }
712     ovs_mutex_unlock(&dp_netdev_mutex);
713
714     return error;
715 }
716
717 static void
718 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
719 {
720     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
721
722     ovs_mutex_lock(&dp_netdev_mutex);
723     seq_wait(dpif->dp->port_seq, dpif->last_port_seq);
724     ovs_mutex_unlock(&dp_netdev_mutex);
725 }
726
727 static struct dp_netdev_flow *
728 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct flow *key)
729 {
730     struct dp_netdev_flow *flow;
731
732     HMAP_FOR_EACH_WITH_HASH (flow, node, flow_hash(key, 0), &dp->flow_table) {
733         if (flow_equal(&flow->key, key)) {
734             return flow;
735         }
736     }
737     return NULL;
738 }
739
740 static void
741 get_dpif_flow_stats(struct dp_netdev_flow *flow, struct dpif_flow_stats *stats)
742 {
743     stats->n_packets = flow->packet_count;
744     stats->n_bytes = flow->byte_count;
745     stats->used = flow->used;
746     stats->tcp_flags = flow->tcp_flags;
747 }
748
749 static int
750 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
751                               struct flow *flow)
752 {
753     odp_port_t in_port;
754
755     if (odp_flow_key_to_flow(key, key_len, flow) != ODP_FIT_PERFECT) {
756         /* This should not happen: it indicates that odp_flow_key_from_flow()
757          * and odp_flow_key_to_flow() disagree on the acceptable form of a
758          * flow.  Log the problem as an error, with enough details to enable
759          * debugging. */
760         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
761
762         if (!VLOG_DROP_ERR(&rl)) {
763             struct ds s;
764
765             ds_init(&s);
766             odp_flow_key_format(key, key_len, &s);
767             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
768             ds_destroy(&s);
769         }
770
771         return EINVAL;
772     }
773
774     in_port = flow->in_port.odp_port;
775     if (!is_valid_port_number(in_port) && in_port != ODPP_NONE) {
776         return EINVAL;
777     }
778
779     return 0;
780 }
781
782 static int
783 dpif_netdev_flow_get(const struct dpif *dpif,
784                      const struct nlattr *nl_key, size_t nl_key_len,
785                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
786 {
787     struct dp_netdev *dp = get_dp_netdev(dpif);
788     struct dp_netdev_flow *flow;
789     struct flow key;
790     int error;
791
792     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
793     if (error) {
794         return error;
795     }
796
797     ovs_mutex_lock(&dp_netdev_mutex);
798     flow = dp_netdev_lookup_flow(dp, &key);
799     if (flow) {
800         if (stats) {
801             get_dpif_flow_stats(flow, stats);
802         }
803         if (actionsp) {
804             *actionsp = ofpbuf_clone_data(flow->actions, flow->actions_len);
805         }
806     } else {
807         error = ENOENT;
808     }
809     ovs_mutex_unlock(&dp_netdev_mutex);
810
811     return error;
812 }
813
814 static int
815 set_flow_actions(struct dp_netdev_flow *flow,
816                  const struct nlattr *actions, size_t actions_len)
817 {
818     flow->actions = xrealloc(flow->actions, actions_len);
819     flow->actions_len = actions_len;
820     memcpy(flow->actions, actions, actions_len);
821     return 0;
822 }
823
824 static int
825 dp_netdev_flow_add(struct dp_netdev *dp, const struct flow *key,
826                    const struct nlattr *actions, size_t actions_len)
827 {
828     struct dp_netdev_flow *flow;
829     int error;
830
831     flow = xzalloc(sizeof *flow);
832     flow->key = *key;
833
834     error = set_flow_actions(flow, actions, actions_len);
835     if (error) {
836         free(flow);
837         return error;
838     }
839
840     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
841     return 0;
842 }
843
844 static void
845 clear_stats(struct dp_netdev_flow *flow)
846 {
847     flow->used = 0;
848     flow->packet_count = 0;
849     flow->byte_count = 0;
850     flow->tcp_flags = 0;
851 }
852
853 static int
854 dpif_netdev_flow_put(struct dpif *dpif, const struct dpif_flow_put *put)
855 {
856     struct dp_netdev *dp = get_dp_netdev(dpif);
857     struct dp_netdev_flow *flow;
858     struct flow key;
859     int error;
860
861     error = dpif_netdev_flow_from_nlattrs(put->key, put->key_len, &key);
862     if (error) {
863         return error;
864     }
865
866     ovs_mutex_lock(&dp_netdev_mutex);
867     flow = dp_netdev_lookup_flow(dp, &key);
868     if (!flow) {
869         if (put->flags & DPIF_FP_CREATE) {
870             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
871                 if (put->stats) {
872                     memset(put->stats, 0, sizeof *put->stats);
873                 }
874                 error = dp_netdev_flow_add(dp, &key, put->actions,
875                                            put->actions_len);
876             } else {
877                 error = EFBIG;
878             }
879         } else {
880             error = ENOENT;
881         }
882     } else {
883         if (put->flags & DPIF_FP_MODIFY) {
884             error = set_flow_actions(flow, put->actions, put->actions_len);
885             if (!error) {
886                 if (put->stats) {
887                     get_dpif_flow_stats(flow, put->stats);
888                 }
889                 if (put->flags & DPIF_FP_ZERO_STATS) {
890                     clear_stats(flow);
891                 }
892             }
893         } else {
894             error = EEXIST;
895         }
896     }
897     ovs_mutex_unlock(&dp_netdev_mutex);
898
899     return error;
900 }
901
902 static int
903 dpif_netdev_flow_del(struct dpif *dpif, const struct dpif_flow_del *del)
904 {
905     struct dp_netdev *dp = get_dp_netdev(dpif);
906     struct dp_netdev_flow *flow;
907     struct flow key;
908     int error;
909
910     error = dpif_netdev_flow_from_nlattrs(del->key, del->key_len, &key);
911     if (error) {
912         return error;
913     }
914
915     ovs_mutex_lock(&dp_netdev_mutex);
916     flow = dp_netdev_lookup_flow(dp, &key);
917     if (flow) {
918         if (del->stats) {
919             get_dpif_flow_stats(flow, del->stats);
920         }
921         dp_netdev_free_flow(dp, flow);
922     } else {
923         error = ENOENT;
924     }
925     ovs_mutex_unlock(&dp_netdev_mutex);
926
927     return error;
928 }
929
930 struct dp_netdev_flow_state {
931     uint32_t bucket;
932     uint32_t offset;
933     struct nlattr *actions;
934     struct odputil_keybuf keybuf;
935     struct dpif_flow_stats stats;
936 };
937
938 static int
939 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
940 {
941     struct dp_netdev_flow_state *state;
942
943     *statep = state = xmalloc(sizeof *state);
944     state->bucket = 0;
945     state->offset = 0;
946     state->actions = NULL;
947     return 0;
948 }
949
950 static int
951 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *state_,
952                            const struct nlattr **key, size_t *key_len,
953                            const struct nlattr **mask, size_t *mask_len,
954                            const struct nlattr **actions, size_t *actions_len,
955                            const struct dpif_flow_stats **stats)
956 {
957     struct dp_netdev_flow_state *state = state_;
958     struct dp_netdev *dp = get_dp_netdev(dpif);
959     struct dp_netdev_flow *flow;
960     struct hmap_node *node;
961
962     ovs_mutex_lock(&dp_netdev_mutex);
963     node = hmap_at_position(&dp->flow_table, &state->bucket, &state->offset);
964     if (!node) {
965         ovs_mutex_unlock(&dp_netdev_mutex);
966         return EOF;
967     }
968
969     flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
970
971     if (key) {
972         struct ofpbuf buf;
973
974         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
975         odp_flow_key_from_flow(&buf, &flow->key, flow->key.in_port.odp_port);
976
977         *key = buf.data;
978         *key_len = buf.size;
979     }
980
981     if (mask) {
982         *mask = NULL;
983         *mask_len = 0;
984     }
985
986     if (actions) {
987         free(state->actions);
988         state->actions = xmemdup(flow->actions, flow->actions_len);
989
990         *actions = state->actions;
991         *actions_len = flow->actions_len;
992     }
993
994     if (stats) {
995         get_dpif_flow_stats(flow, &state->stats);
996         *stats = &state->stats;
997     }
998
999     ovs_mutex_unlock(&dp_netdev_mutex);
1000     return 0;
1001 }
1002
1003 static int
1004 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
1005 {
1006     struct dp_netdev_flow_state *state = state_;
1007
1008     free(state->actions);
1009     free(state);
1010     return 0;
1011 }
1012
1013 static int
1014 dpif_netdev_execute(struct dpif *dpif, const struct dpif_execute *execute)
1015 {
1016     struct dp_netdev *dp = get_dp_netdev(dpif);
1017     struct ofpbuf copy;
1018     struct flow key;
1019     int error;
1020
1021     if (execute->packet->size < ETH_HEADER_LEN ||
1022         execute->packet->size > UINT16_MAX) {
1023         return EINVAL;
1024     }
1025
1026     /* Make a deep copy of 'packet', because we might modify its data. */
1027     ofpbuf_init(&copy, DP_NETDEV_HEADROOM + execute->packet->size);
1028     ofpbuf_reserve(&copy, DP_NETDEV_HEADROOM);
1029     ofpbuf_put(&copy, execute->packet->data, execute->packet->size);
1030
1031     flow_extract(&copy, 0, 0, NULL, NULL, &key);
1032     error = dpif_netdev_flow_from_nlattrs(execute->key, execute->key_len,
1033                                           &key);
1034     if (!error) {
1035         ovs_mutex_lock(&dp_netdev_mutex);
1036         dp_netdev_execute_actions(dp, &copy, &key,
1037                                   execute->actions, execute->actions_len);
1038         ovs_mutex_unlock(&dp_netdev_mutex);
1039     }
1040
1041     ofpbuf_uninit(&copy);
1042     return error;
1043 }
1044
1045 static int
1046 dpif_netdev_recv_set(struct dpif *dpif OVS_UNUSED, bool enable OVS_UNUSED)
1047 {
1048     return 0;
1049 }
1050
1051 static int
1052 dpif_netdev_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
1053                               uint32_t queue_id, uint32_t *priority)
1054 {
1055     *priority = queue_id;
1056     return 0;
1057 }
1058
1059 static struct dp_netdev_queue *
1060 find_nonempty_queue(struct dpif *dpif)
1061 {
1062     struct dp_netdev *dp = get_dp_netdev(dpif);
1063     int i;
1064
1065     for (i = 0; i < N_QUEUES; i++) {
1066         struct dp_netdev_queue *q = &dp->queues[i];
1067         if (q->head != q->tail) {
1068             return q;
1069         }
1070     }
1071     return NULL;
1072 }
1073
1074 static int
1075 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall,
1076                  struct ofpbuf *buf)
1077 {
1078     struct dp_netdev_queue *q;
1079     int error;
1080
1081     ovs_mutex_lock(&dp_netdev_mutex);
1082     q = find_nonempty_queue(dpif);
1083     if (q) {
1084         struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
1085
1086         *upcall = u->upcall;
1087         upcall->packet = buf;
1088
1089         ofpbuf_uninit(buf);
1090         *buf = u->buf;
1091
1092         error = 0;
1093     } else {
1094         error = EAGAIN;
1095     }
1096     ovs_mutex_unlock(&dp_netdev_mutex);
1097
1098     return error;
1099 }
1100
1101 static void
1102 dpif_netdev_recv_wait(struct dpif *dpif)
1103 {
1104     struct dp_netdev *dp = get_dp_netdev(dpif);
1105     uint64_t seq;
1106
1107     ovs_mutex_lock(&dp_netdev_mutex);
1108     seq = seq_read(dp->queue_seq);
1109     if (find_nonempty_queue(dpif)) {
1110         poll_immediate_wake();
1111     } else {
1112         seq_wait(dp->queue_seq, seq);
1113     }
1114     ovs_mutex_unlock(&dp_netdev_mutex);
1115 }
1116
1117 static void
1118 dpif_netdev_recv_purge(struct dpif *dpif)
1119 {
1120     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1121     ovs_mutex_lock(&dp_netdev_mutex);
1122     dp_netdev_purge_queues(dpif_netdev->dp);
1123     ovs_mutex_unlock(&dp_netdev_mutex);
1124 }
1125 \f
1126 static void
1127 dp_netdev_flow_used(struct dp_netdev_flow *flow, const struct ofpbuf *packet)
1128 {
1129     flow->used = time_msec();
1130     flow->packet_count++;
1131     flow->byte_count += packet->size;
1132     flow->tcp_flags |= packet_get_tcp_flags(packet, &flow->key);
1133 }
1134
1135 static void
1136 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1137                      struct ofpbuf *packet, uint32_t skb_priority,
1138                      uint32_t pkt_mark, const struct flow_tnl *tnl)
1139 {
1140     struct dp_netdev_flow *flow;
1141     struct flow key;
1142     union flow_in_port in_port_;
1143
1144     if (packet->size < ETH_HEADER_LEN) {
1145         return;
1146     }
1147     in_port_.odp_port = port->port_no;
1148     flow_extract(packet, skb_priority, pkt_mark, tnl, &in_port_, &key);
1149     flow = dp_netdev_lookup_flow(dp, &key);
1150     if (flow) {
1151         dp_netdev_flow_used(flow, packet);
1152         dp_netdev_execute_actions(dp, packet, &key,
1153                                   flow->actions, flow->actions_len);
1154         dp->n_hit++;
1155     } else {
1156         dp->n_missed++;
1157         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, NULL);
1158     }
1159 }
1160
1161 static void
1162 dpif_netdev_run(struct dpif *dpif)
1163 {
1164     struct dp_netdev_port *port;
1165     struct dp_netdev *dp;
1166     struct ofpbuf packet;
1167
1168     ovs_mutex_lock(&dp_netdev_mutex);
1169     dp = get_dp_netdev(dpif);
1170     ofpbuf_init(&packet,
1171                 DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + dp->max_mtu);
1172
1173     LIST_FOR_EACH (port, node, &dp->port_list) {
1174         int error;
1175
1176         /* Reset packet contents. */
1177         ofpbuf_clear(&packet);
1178         ofpbuf_reserve(&packet, DP_NETDEV_HEADROOM);
1179
1180         error = port->rx ? netdev_rx_recv(port->rx, &packet) : EOPNOTSUPP;
1181         if (!error) {
1182             dp_netdev_port_input(dp, port, &packet, 0, 0, NULL);
1183         } else if (error != EAGAIN && error != EOPNOTSUPP) {
1184             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1185
1186             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1187                         netdev_get_name(port->netdev), ovs_strerror(error));
1188         }
1189     }
1190     ofpbuf_uninit(&packet);
1191     ovs_mutex_unlock(&dp_netdev_mutex);
1192 }
1193
1194 static void
1195 dpif_netdev_wait(struct dpif *dpif)
1196 {
1197     struct dp_netdev_port *port;
1198
1199     /* There is a race here, if thread A calls dpif_netdev_wait(dpif) and
1200      * thread B calls dpif_port_add(dpif) or dpif_port_remove(dpif) before
1201      * A makes it to poll_block().
1202      *
1203      * But I think it doesn't matter:
1204      *
1205      *     - In the dpif_port_add() case, A will not wake up when a packet
1206      *       arrives on the new port, but this would also happen if the
1207      *       ordering were reversed.
1208      *
1209      *     - In the dpif_port_remove() case, A might wake up spuriously, but
1210      *       that is harmless. */
1211
1212     ovs_mutex_lock(&dp_netdev_mutex);
1213     LIST_FOR_EACH (port, node, &get_dp_netdev(dpif)->port_list) {
1214         if (port->rx) {
1215             netdev_rx_wait(port->rx);
1216         }
1217     }
1218     ovs_mutex_unlock(&dp_netdev_mutex);
1219 }
1220
1221 static void
1222 dp_netdev_output_port(void *dp_, struct ofpbuf *packet, uint32_t out_port)
1223 {
1224     struct dp_netdev *dp = dp_;
1225     struct dp_netdev_port *p = dp->ports[out_port];
1226     if (p) {
1227         netdev_send(p->netdev, packet);
1228     }
1229 }
1230
1231 static int
1232 dp_netdev_output_userspace(struct dp_netdev *dp, const struct ofpbuf *packet,
1233                            int queue_no, const struct flow *flow,
1234                            const struct nlattr *userdata)
1235 {
1236     struct dp_netdev_queue *q = &dp->queues[queue_no];
1237     if (q->head - q->tail < MAX_QUEUE_LEN) {
1238         struct dp_netdev_upcall *u = &q->upcalls[q->head++ & QUEUE_MASK];
1239         struct dpif_upcall *upcall = &u->upcall;
1240         struct ofpbuf *buf = &u->buf;
1241         size_t buf_size;
1242
1243         upcall->type = queue_no;
1244
1245         /* Allocate buffer big enough for everything. */
1246         buf_size = ODPUTIL_FLOW_KEY_BYTES + 2 + packet->size;
1247         if (userdata) {
1248             buf_size += NLA_ALIGN(userdata->nla_len);
1249         }
1250         ofpbuf_init(buf, buf_size);
1251
1252         /* Put ODP flow. */
1253         odp_flow_key_from_flow(buf, flow, flow->in_port.odp_port);
1254         upcall->key = buf->data;
1255         upcall->key_len = buf->size;
1256
1257         /* Put userdata. */
1258         if (userdata) {
1259             upcall->userdata = ofpbuf_put(buf, userdata,
1260                                           NLA_ALIGN(userdata->nla_len));
1261         }
1262
1263         /* Put packet.
1264          *
1265          * We adjust 'data' and 'size' in 'buf' so that only the packet itself
1266          * is visible in 'upcall->packet'.  The ODP flow and (if present)
1267          * userdata become part of the headroom. */
1268         ofpbuf_put_zeros(buf, 2);
1269         buf->data = ofpbuf_put(buf, packet->data, packet->size);
1270         buf->size = packet->size;
1271         upcall->packet = buf;
1272
1273         seq_change(dp->queue_seq);
1274
1275         return 0;
1276     } else {
1277         dp->n_lost++;
1278         return ENOBUFS;
1279     }
1280 }
1281
1282 static void
1283 dp_netdev_action_userspace(void *dp, struct ofpbuf *packet,
1284                            const struct flow *key,
1285                            const struct nlattr *userdata)
1286 {
1287     dp_netdev_output_userspace(dp, packet, DPIF_UC_ACTION, key, userdata);
1288 }
1289
1290 static void
1291 dp_netdev_execute_actions(struct dp_netdev *dp,
1292                           struct ofpbuf *packet, struct flow *key,
1293                           const struct nlattr *actions,
1294                           size_t actions_len)
1295 {
1296     odp_execute_actions(dp, packet, key, actions, actions_len,
1297                         dp_netdev_output_port, dp_netdev_action_userspace);
1298 }
1299
1300 const struct dpif_class dpif_netdev_class = {
1301     "netdev",
1302     dpif_netdev_enumerate,
1303     dpif_netdev_port_open_type,
1304     dpif_netdev_open,
1305     dpif_netdev_close,
1306     dpif_netdev_destroy,
1307     dpif_netdev_run,
1308     dpif_netdev_wait,
1309     dpif_netdev_get_stats,
1310     dpif_netdev_port_add,
1311     dpif_netdev_port_del,
1312     dpif_netdev_port_query_by_number,
1313     dpif_netdev_port_query_by_name,
1314     dpif_netdev_get_max_ports,
1315     NULL,                       /* port_get_pid */
1316     dpif_netdev_port_dump_start,
1317     dpif_netdev_port_dump_next,
1318     dpif_netdev_port_dump_done,
1319     dpif_netdev_port_poll,
1320     dpif_netdev_port_poll_wait,
1321     dpif_netdev_flow_get,
1322     dpif_netdev_flow_put,
1323     dpif_netdev_flow_del,
1324     dpif_netdev_flow_flush,
1325     dpif_netdev_flow_dump_start,
1326     dpif_netdev_flow_dump_next,
1327     dpif_netdev_flow_dump_done,
1328     dpif_netdev_execute,
1329     NULL,                       /* operate */
1330     dpif_netdev_recv_set,
1331     dpif_netdev_queue_to_priority,
1332     dpif_netdev_recv,
1333     dpif_netdev_recv_wait,
1334     dpif_netdev_recv_purge,
1335 };
1336
1337 static void
1338 dpif_dummy_change_port_number(struct unixctl_conn *conn, int argc OVS_UNUSED,
1339                               const char *argv[], void *aux OVS_UNUSED)
1340 {
1341     struct dp_netdev_port *port;
1342     struct dp_netdev *dp;
1343     int port_no;
1344
1345     dp = shash_find_data(&dp_netdevs, argv[1]);
1346     if (!dp || !dpif_netdev_class_is_dummy(dp->class)) {
1347         unixctl_command_reply_error(conn, "unknown datapath or not a dummy");
1348         return;
1349     }
1350
1351     if (get_port_by_name(dp, argv[2], &port)) {
1352         unixctl_command_reply_error(conn, "unknown port");
1353         return;
1354     }
1355
1356     port_no = atoi(argv[3]);
1357     if (port_no <= 0 || port_no >= MAX_PORTS) {
1358         unixctl_command_reply_error(conn, "bad port number");
1359         return;
1360     }
1361     if (dp->ports[port_no]) {
1362         unixctl_command_reply_error(conn, "port number already in use");
1363         return;
1364     }
1365     dp->ports[odp_to_u32(port->port_no)] = NULL;
1366     dp->ports[port_no] = port;
1367     port->port_no = u32_to_odp(port_no);
1368     seq_change(dp->port_seq);
1369     unixctl_command_reply(conn, NULL);
1370 }
1371
1372 static void
1373 dpif_dummy_register__(const char *type)
1374 {
1375     struct dpif_class *class;
1376
1377     class = xmalloc(sizeof *class);
1378     *class = dpif_netdev_class;
1379     class->type = xstrdup(type);
1380     dp_register_provider(class);
1381 }
1382
1383 void
1384 dpif_dummy_register(bool override)
1385 {
1386     if (override) {
1387         struct sset types;
1388         const char *type;
1389
1390         sset_init(&types);
1391         dp_enumerate_types(&types);
1392         SSET_FOR_EACH (type, &types) {
1393             if (!dp_unregister_provider(type)) {
1394                 dpif_dummy_register__(type);
1395             }
1396         }
1397         sset_destroy(&types);
1398     }
1399
1400     dpif_dummy_register__("dummy");
1401
1402     unixctl_command_register("dpif-dummy/change-port-number",
1403                              "DP PORT NEW-NUMBER",
1404                              3, 3, dpif_dummy_change_port_number, NULL);
1405 }