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