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