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