c4cc6e98357f594124f7ba14199da3f7a3c58c5b
[sliver-openvswitch.git] / lib / dpif-netdev.c
1 /*
2  * Copyright (c) 2009, 2010 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 <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-provider.h"
36 #include "flow.h"
37 #include "hmap.h"
38 #include "list.h"
39 #include "netdev.h"
40 #include "odp-util.h"
41 #include "ofp-print.h"
42 #include "ofpbuf.h"
43 #include "packets.h"
44 #include "poll-loop.h"
45 #include "queue.h"
46 #include "timeval.h"
47 #include "util.h"
48
49 #include "vlog.h"
50 #define THIS_MODULE VLM_dpif_netdev
51
52 /* Configuration parameters. */
53 enum { N_QUEUES = 2 };          /* Number of queues for dpif_recv(). */
54 enum { MAX_QUEUE_LEN = 100 };   /* Maximum number of packets per queue. */
55 enum { N_GROUPS = 16 };         /* Number of port groups. */
56 enum { MAX_PORTS = 256 };       /* Maximum number of ports. */
57 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
58
59 /* Enough headroom to add a vlan tag, plus an extra 2 bytes to allow IP
60  * headers to be aligned on a 4-byte boundary.  */
61 enum { DP_NETDEV_HEADROOM = 2 + VLAN_HEADER_LEN };
62
63 /* Datapath based on the network device interface from netdev.h. */
64 struct dp_netdev {
65     struct list node;
66     int dp_idx;
67     int open_cnt;
68     bool destroyed;
69
70     bool drop_frags;            /* Drop all IP fragments, if true. */
71     struct ovs_queue queues[N_QUEUES]; /* Messages queued for dpif_recv(). */
72     struct hmap flow_table;     /* Flow table. */
73     struct odp_port_group groups[N_GROUPS];
74
75     /* Statistics. */
76     long long int n_frags;      /* Number of dropped IP fragments. */
77     long long int n_hit;        /* Number of flow table matches. */
78     long long int n_missed;     /* Number of flow table misses. */
79     long long int n_lost;       /* Number of misses not passed to client. */
80
81     /* Ports. */
82     int n_ports;
83     struct dp_netdev_port *ports[MAX_PORTS];
84     struct list port_list;
85     unsigned int serial;
86 };
87
88 /* A port in a netdev-based datapath. */
89 struct dp_netdev_port {
90     int port_no;                /* Index into dp_netdev's 'ports'. */
91     struct list node;           /* Element in dp_netdev's 'port_list'. */
92     struct netdev *netdev;
93     bool internal;              /* Internal port (as ODP_PORT_INTERNAL)? */
94 };
95
96 /* A flow in dp_netdev's 'flow_table'. */
97 struct dp_netdev_flow {
98     struct hmap_node node;      /* Element in dp_netdev's 'flow_table'. */
99     flow_t key;
100
101     /* Statistics. */
102         struct timeval used;        /* Last used time, in milliseconds. */
103         long long int packet_count; /* Number of packets matched. */
104         long long int byte_count;   /* Number of bytes matched. */
105         uint8_t ip_tos;             /* IP TOS value. */
106         uint16_t tcp_ctl;           /* Bitwise-OR of seen tcp_ctl values. */
107
108     /* Actions. */
109     union odp_action *actions;
110     unsigned int n_actions;
111 };
112
113 /* Interface to netdev-based datapath. */
114 struct dpif_netdev {
115     struct dpif dpif;
116     struct dp_netdev *dp;
117     int listen_mask;
118     unsigned int dp_serial;
119 };
120
121 /* All netdev-based datapaths. */
122 static struct dp_netdev *dp_netdevs[256];
123 struct list dp_netdev_list = LIST_INITIALIZER(&dp_netdev_list);
124 enum { N_DP_NETDEVS = ARRAY_SIZE(dp_netdevs) };
125
126 /* Maximum port MTU seen so far. */
127 static int max_mtu = ETH_PAYLOAD_MAX;
128
129 static int get_port_by_number(struct dp_netdev *, uint16_t port_no,
130                               struct dp_netdev_port **portp);
131 static int get_port_by_name(struct dp_netdev *, const char *devname,
132                             struct dp_netdev_port **portp);
133 static void dp_netdev_free(struct dp_netdev *);
134 static void dp_netdev_flow_flush(struct dp_netdev *);
135 static int do_add_port(struct dp_netdev *, const char *devname, uint16_t flags,
136                        uint16_t port_no);
137 static int do_del_port(struct dp_netdev *, uint16_t port_no);
138 static int dp_netdev_output_control(struct dp_netdev *, const struct ofpbuf *,
139                                     int queue_no, int port_no, uint32_t arg);
140 static int dp_netdev_execute_actions(struct dp_netdev *,
141                                      struct ofpbuf *, flow_t *,
142                                      const union odp_action *, int n);
143
144 static struct dpif_netdev *
145 dpif_netdev_cast(const struct dpif *dpif)
146 {
147     dpif_assert_class(dpif, &dpif_netdev_class);
148     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
149 }
150
151 static struct dp_netdev *
152 get_dp_netdev(const struct dpif *dpif)
153 {
154     return dpif_netdev_cast(dpif)->dp;
155 }
156
157 static int
158 name_to_dp_idx(const char *name)
159 {
160     if (!strncmp(name, "dp", 2) && isdigit((unsigned char)name[2])) {
161         int dp_idx = atoi(name + 2);
162         if (dp_idx >= 0 && dp_idx < N_DP_NETDEVS) {
163             return dp_idx;
164         }
165     }
166     return -1;
167 }
168
169 static struct dp_netdev *
170 find_dp_netdev(const char *name)
171 {
172     int dp_idx;
173     size_t i;
174
175     dp_idx = name_to_dp_idx(name);
176     if (dp_idx >= 0) {
177         return dp_netdevs[dp_idx];
178     }
179
180     for (i = 0; i < N_DP_NETDEVS; i++) {
181         struct dp_netdev *dp = dp_netdevs[i];
182         if (dp) {
183             struct dp_netdev_port *port;
184             if (!get_port_by_name(dp, name, &port)) {
185                 return dp;
186             }
187         }
188     }
189     return NULL;
190 }
191
192 static struct dpif *
193 create_dpif_netdev(struct dp_netdev *dp)
194 {
195     struct dpif_netdev *dpif;
196     char *dpname;
197
198     dp->open_cnt++;
199
200     dpname = xasprintf("dp%d", dp->dp_idx);
201     dpif = xmalloc(sizeof *dpif);
202     dpif_init(&dpif->dpif, &dpif_netdev_class, dpname, dp->dp_idx, dp->dp_idx);
203     dpif->dp = dp;
204     dpif->listen_mask = 0;
205     dpif->dp_serial = dp->serial;
206     free(dpname);
207
208     return &dpif->dpif;
209 }
210
211 static int
212 create_dp_netdev(const char *name, int dp_idx, struct dpif **dpifp)
213 {
214     struct dp_netdev *dp;
215     int error;
216     int i;
217
218     if (dp_netdevs[dp_idx]) {
219         return EBUSY;
220     }
221
222     /* Create datapath. */
223     dp_netdevs[dp_idx] = dp = xzalloc(sizeof *dp);
224     list_push_back(&dp_netdev_list, &dp->node);
225     dp->dp_idx = dp_idx;
226     dp->open_cnt = 0;
227     dp->drop_frags = false;
228     for (i = 0; i < N_QUEUES; i++) {
229         queue_init(&dp->queues[i]);
230     }
231     hmap_init(&dp->flow_table);
232     for (i = 0; i < N_GROUPS; i++) {
233         dp->groups[i].ports = NULL;
234         dp->groups[i].n_ports = 0;
235         dp->groups[i].group = i;
236     }
237     list_init(&dp->port_list);
238     error = do_add_port(dp, name, ODP_PORT_INTERNAL, ODPP_LOCAL);
239     if (error) {
240         dp_netdev_free(dp);
241         return ENODEV;
242     }
243
244     *dpifp = create_dpif_netdev(dp);
245     return 0;
246 }
247
248 static int
249 dpif_netdev_open(const char *name, const char *type OVS_UNUSED, bool create,
250                  struct dpif **dpifp)
251 {
252     if (create) {
253         if (find_dp_netdev(name)) {
254             return EEXIST;
255         } else {
256             int dp_idx = name_to_dp_idx(name);
257             if (dp_idx >= 0) {
258                 return create_dp_netdev(name, dp_idx, dpifp);
259             } else {
260                 /* Scan for unused dp_idx number. */
261                 for (dp_idx = 0; dp_idx < N_DP_NETDEVS; dp_idx++) {
262                     int error = create_dp_netdev(name, dp_idx, dpifp);
263                     if (error != EBUSY) {
264                         return error;
265                     }
266                 }
267
268                 /* All datapath numbers in use. */
269                 return ENOBUFS;
270             }
271         }
272     } else {
273         struct dp_netdev *dp = find_dp_netdev(name);
274         if (dp) {
275             *dpifp = create_dpif_netdev(dp);
276             return 0;
277         } else {
278             return ENODEV;
279         }
280     }
281 }
282
283 static void
284 dp_netdev_free(struct dp_netdev *dp)
285 {
286     int i;
287
288     dp_netdev_flow_flush(dp);
289     while (dp->n_ports > 0) {
290         struct dp_netdev_port *port = CONTAINER_OF(
291             dp->port_list.next, struct dp_netdev_port, node);
292         do_del_port(dp, port->port_no);
293     }
294     for (i = 0; i < N_QUEUES; i++) {
295         queue_destroy(&dp->queues[i]);
296     }
297     hmap_destroy(&dp->flow_table);
298     for (i = 0; i < N_GROUPS; i++) {
299         free(dp->groups[i].ports);
300     }
301     dp_netdevs[dp->dp_idx] = NULL;
302     list_remove(&dp->node);
303     free(dp);
304 }
305
306 static void
307 dpif_netdev_close(struct dpif *dpif)
308 {
309     struct dp_netdev *dp = get_dp_netdev(dpif);
310     assert(dp->open_cnt > 0);
311     if (--dp->open_cnt == 0 && dp->destroyed) {
312         dp_netdev_free(dp);
313     }
314     free(dpif);
315 }
316
317 static int
318 dpif_netdev_destroy(struct dpif *dpif)
319 {
320     struct dp_netdev *dp = get_dp_netdev(dpif);
321     dp->destroyed = true;
322     return 0;
323 }
324
325 static int
326 dpif_netdev_get_stats(const struct dpif *dpif, struct odp_stats *stats)
327 {
328     struct dp_netdev *dp = get_dp_netdev(dpif);
329     memset(stats, 0, sizeof *stats);
330     stats->n_flows = hmap_count(&dp->flow_table);
331     stats->cur_capacity = hmap_capacity(&dp->flow_table);
332     stats->max_capacity = MAX_FLOWS;
333     stats->n_ports = dp->n_ports;
334     stats->max_ports = MAX_PORTS;
335     stats->max_groups = N_GROUPS;
336     stats->n_frags = dp->n_frags;
337     stats->n_hit = dp->n_hit;
338     stats->n_missed = dp->n_missed;
339     stats->n_lost = dp->n_lost;
340     stats->max_miss_queue = MAX_QUEUE_LEN;
341     stats->max_action_queue = MAX_QUEUE_LEN;
342     return 0;
343 }
344
345 static int
346 dpif_netdev_get_drop_frags(const struct dpif *dpif, bool *drop_fragsp)
347 {
348     struct dp_netdev *dp = get_dp_netdev(dpif);
349     *drop_fragsp = dp->drop_frags;
350     return 0;
351 }
352
353 static int
354 dpif_netdev_set_drop_frags(struct dpif *dpif, bool drop_frags)
355 {
356     struct dp_netdev *dp = get_dp_netdev(dpif);
357     dp->drop_frags = drop_frags;
358     return 0;
359 }
360
361 static int
362 do_add_port(struct dp_netdev *dp, const char *devname, uint16_t flags,
363             uint16_t port_no)
364 {
365     bool internal = (flags & ODP_PORT_INTERNAL) != 0;
366     struct dp_netdev_port *port;
367     struct netdev_options netdev_options;
368     struct netdev *netdev;
369     int mtu;
370     int error;
371
372     /* XXX reject devices already in some dp_netdev. */
373
374     /* Open and validate network device. */
375     memset(&netdev_options, 0, sizeof netdev_options);
376     netdev_options.name = devname;
377     netdev_options.ethertype = NETDEV_ETH_TYPE_ANY;
378     netdev_options.may_create = true;
379     if (internal) {
380         netdev_options.type = "tap";
381     } else {
382         netdev_options.may_open = true;
383     }
384
385     error = netdev_open(&netdev_options, &netdev);
386     if (error) {
387         return error;
388     }
389     /* XXX reject loopback devices */
390     /* XXX reject non-Ethernet devices */
391
392     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, false);
393     if (error) {
394         netdev_close(netdev);
395         return error;
396     }
397
398     port = xmalloc(sizeof *port);
399     port->port_no = port_no;
400     port->netdev = netdev;
401     port->internal = internal;
402
403     netdev_get_mtu(netdev, &mtu);
404     if (mtu > max_mtu) {
405         max_mtu = mtu;
406     }
407
408     list_push_back(&dp->port_list, &port->node);
409     dp->ports[port_no] = port;
410     dp->n_ports++;
411     dp->serial++;
412
413     return 0;
414 }
415
416 static int
417 dpif_netdev_port_add(struct dpif *dpif, const char *devname, uint16_t flags,
418                      uint16_t *port_nop)
419 {
420     struct dp_netdev *dp = get_dp_netdev(dpif);
421     int port_no;
422
423     for (port_no = 0; port_no < MAX_PORTS; port_no++) {
424         if (!dp->ports[port_no]) {
425             *port_nop = port_no;
426             return do_add_port(dp, devname, flags, port_no);
427         }
428     }
429     return EFBIG;
430 }
431
432 static int
433 dpif_netdev_port_del(struct dpif *dpif, uint16_t port_no)
434 {
435     struct dp_netdev *dp = get_dp_netdev(dpif);
436     return port_no == ODPP_LOCAL ? EINVAL : do_del_port(dp, port_no);
437 }
438
439 static bool
440 is_valid_port_number(uint16_t port_no)
441 {
442     return port_no < MAX_PORTS;
443 }
444
445 static int
446 get_port_by_number(struct dp_netdev *dp,
447                    uint16_t port_no, struct dp_netdev_port **portp)
448 {
449     if (!is_valid_port_number(port_no)) {
450         *portp = NULL;
451         return EINVAL;
452     } else {
453         *portp = dp->ports[port_no];
454         return *portp ? 0 : ENOENT;
455     }
456 }
457
458 static int
459 get_port_by_name(struct dp_netdev *dp,
460                  const char *devname, struct dp_netdev_port **portp)
461 {
462     struct dp_netdev_port *port;
463
464     LIST_FOR_EACH (port, struct dp_netdev_port, node, &dp->port_list) {
465         if (!strcmp(netdev_get_name(port->netdev), devname)) {
466             *portp = port;
467             return 0;
468         }
469     }
470     return ENOENT;
471 }
472
473 static int
474 do_del_port(struct dp_netdev *dp, uint16_t port_no)
475 {
476     struct dp_netdev_port *port;
477     char *name;
478     int error;
479
480     error = get_port_by_number(dp, port_no, &port);
481     if (error) {
482         return error;
483     }
484
485     list_remove(&port->node);
486     dp->ports[port->port_no] = NULL;
487     dp->n_ports--;
488     dp->serial++;
489
490     name = xstrdup(netdev_get_name(port->netdev));
491     netdev_close(port->netdev);
492
493     free(name);
494     free(port);
495
496     return 0;
497 }
498
499 static void
500 answer_port_query(const struct dp_netdev_port *port, struct odp_port *odp_port)
501 {
502     memset(odp_port, 0, sizeof *odp_port);
503     ovs_strlcpy(odp_port->devname, netdev_get_name(port->netdev),
504                 sizeof odp_port->devname);
505     odp_port->port = port->port_no;
506     odp_port->flags = port->internal ? ODP_PORT_INTERNAL : 0;
507 }
508
509 static int
510 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
511                                  struct odp_port *odp_port)
512 {
513     struct dp_netdev *dp = get_dp_netdev(dpif);
514     struct dp_netdev_port *port;
515     int error;
516
517     error = get_port_by_number(dp, port_no, &port);
518     if (!error) {
519         answer_port_query(port, odp_port);
520     }
521     return error;
522 }
523
524 static int
525 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
526                                struct odp_port *odp_port)
527 {
528     struct dp_netdev *dp = get_dp_netdev(dpif);
529     struct dp_netdev_port *port;
530     int error;
531
532     error = get_port_by_name(dp, devname, &port);
533     if (!error) {
534         answer_port_query(port, odp_port);
535     }
536     return error;
537 }
538
539 static void
540 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
541 {
542     hmap_remove(&dp->flow_table, &flow->node);
543     free(flow->actions);
544     free(flow);
545 }
546
547 static void
548 dp_netdev_flow_flush(struct dp_netdev *dp)
549 {
550     struct dp_netdev_flow *flow, *next;
551
552     HMAP_FOR_EACH_SAFE (flow, next, struct dp_netdev_flow, node,
553                         &dp->flow_table) {
554         dp_netdev_free_flow(dp, flow);
555     }
556 }
557
558 static int
559 dpif_netdev_flow_flush(struct dpif *dpif)
560 {
561     struct dp_netdev *dp = get_dp_netdev(dpif);
562     dp_netdev_flow_flush(dp);
563     return 0;
564 }
565
566 static int
567 dpif_netdev_port_list(const struct dpif *dpif, struct odp_port *ports, int n)
568 {
569     struct dp_netdev *dp = get_dp_netdev(dpif);
570     struct dp_netdev_port *port;
571     int i;
572
573     i = 0;
574     LIST_FOR_EACH (port, struct dp_netdev_port, node, &dp->port_list) {
575         struct odp_port *odp_port = &ports[i];
576         if (i >= n) {
577             break;
578         }
579         answer_port_query(port, odp_port);
580         i++;
581     }
582     return dp->n_ports;
583 }
584
585 static int
586 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
587 {
588     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
589     if (dpif->dp_serial != dpif->dp->serial) {
590         dpif->dp_serial = dpif->dp->serial;
591         return ENOBUFS;
592     } else {
593         return EAGAIN;
594     }
595 }
596
597 static void
598 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
599 {
600     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
601     if (dpif->dp_serial != dpif->dp->serial) {
602         poll_immediate_wake();
603     }
604 }
605
606 static int
607 get_port_group(const struct dpif *dpif, int group_no,
608                struct odp_port_group **groupp)
609 {
610     struct dp_netdev *dp = get_dp_netdev(dpif);
611
612     if (group_no >= 0 && group_no < N_GROUPS) {
613         *groupp = &dp->groups[group_no];
614         return 0;
615     } else {
616         *groupp = NULL;
617         return EINVAL;
618     }
619 }
620
621 static int
622 dpif_netdev_port_group_get(const struct dpif *dpif, int group_no,
623                            uint16_t ports[], int n)
624 {
625     struct odp_port_group *group;
626     int error;
627
628     if (n < 0) {
629         return -EINVAL;
630     }
631
632     error = get_port_group(dpif, group_no, &group);
633     if (!error) {
634         memcpy(ports, group->ports, MIN(n, group->n_ports) * sizeof *ports);
635         return group->n_ports;
636     } else {
637         return -error;
638     }
639 }
640
641 static int
642 dpif_netdev_port_group_set(struct dpif *dpif, int group_no,
643                            const uint16_t ports[], int n)
644 {
645     struct odp_port_group *group;
646     int error;
647
648     if (n < 0 || n > MAX_PORTS) {
649         return EINVAL;
650     }
651
652     error = get_port_group(dpif, group_no, &group);
653     if (!error) {
654         free(group->ports);
655         group->ports = xmemdup(ports, n * sizeof *group->ports);
656         group->n_ports = n;
657         group->group = group_no;
658     }
659     return error;
660 }
661
662 static struct dp_netdev_flow *
663 dp_netdev_lookup_flow(const struct dp_netdev *dp, const flow_t *key)
664 {
665     struct dp_netdev_flow *flow;
666
667     assert(!key->reserved[0] && !key->reserved[1] && !key->reserved[2]);
668     HMAP_FOR_EACH_WITH_HASH (flow, struct dp_netdev_flow, node,
669                              flow_hash(key, 0), &dp->flow_table) {
670         if (flow_equal(&flow->key, key)) {
671             return flow;
672         }
673     }
674     return NULL;
675 }
676
677 static void
678 answer_flow_query(struct dp_netdev_flow *flow, uint32_t query_flags,
679                   struct odp_flow *odp_flow)
680 {
681     if (flow) {
682         odp_flow->key = flow->key;
683         odp_flow->stats.n_packets = flow->packet_count;
684         odp_flow->stats.n_bytes = flow->byte_count;
685         odp_flow->stats.used_sec = flow->used.tv_sec;
686         odp_flow->stats.used_nsec = flow->used.tv_usec * 1000;
687         odp_flow->stats.tcp_flags = TCP_FLAGS(flow->tcp_ctl);
688         odp_flow->stats.ip_tos = flow->ip_tos;
689         odp_flow->stats.error = 0;
690         if (odp_flow->n_actions > 0) {
691             unsigned int n = MIN(odp_flow->n_actions, flow->n_actions);
692             memcpy(odp_flow->actions, flow->actions,
693                    n * sizeof *odp_flow->actions);
694             odp_flow->n_actions = flow->n_actions;
695         }
696
697         if (query_flags & ODPFF_ZERO_TCP_FLAGS) {
698             flow->tcp_ctl = 0;
699         }
700
701     } else {
702         odp_flow->stats.error = ENOENT;
703     }
704 }
705
706 static int
707 dpif_netdev_flow_get(const struct dpif *dpif, struct odp_flow flows[], int n)
708 {
709     struct dp_netdev *dp = get_dp_netdev(dpif);
710     int i;
711
712     for (i = 0; i < n; i++) {
713         struct odp_flow *odp_flow = &flows[i];
714         answer_flow_query(dp_netdev_lookup_flow(dp, &odp_flow->key),
715                           odp_flow->flags, odp_flow);
716     }
717     return 0;
718 }
719
720 static int
721 dpif_netdev_validate_actions(const union odp_action *actions, int n_actions,
722                              bool *mutates)
723 {
724     unsigned int i;
725
726     *mutates = false;
727     for (i = 0; i < n_actions; i++) {
728         const union odp_action *a = &actions[i];
729         switch (a->type) {
730         case ODPAT_OUTPUT:
731             if (a->output.port >= MAX_PORTS) {
732                 return EINVAL;
733             }
734             break;
735
736         case ODPAT_OUTPUT_GROUP:
737             *mutates = true;
738             if (a->output_group.group >= N_GROUPS) {
739                 return EINVAL;
740             }
741             break;
742
743         case ODPAT_CONTROLLER:
744             break;
745
746         case ODPAT_SET_VLAN_VID:
747             *mutates = true;
748             if (a->vlan_vid.vlan_vid & htons(~VLAN_VID_MASK)) {
749                 return EINVAL;
750             }
751             break;
752
753         case ODPAT_SET_VLAN_PCP:
754             *mutates = true;
755             if (a->vlan_pcp.vlan_pcp & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
756                 return EINVAL;
757             }
758             break;
759
760         case ODPAT_SET_NW_TOS:
761             *mutates = true;
762             if (a->nw_tos.nw_tos & IP_ECN_MASK) {
763                 return EINVAL;
764             }
765             break;
766
767         case ODPAT_STRIP_VLAN:
768         case ODPAT_SET_DL_SRC:
769         case ODPAT_SET_DL_DST:
770         case ODPAT_SET_NW_SRC:
771         case ODPAT_SET_NW_DST:
772         case ODPAT_SET_TP_SRC:
773         case ODPAT_SET_TP_DST:
774             *mutates = true;
775             break;
776
777         default:
778             return EOPNOTSUPP;
779         }
780     }
781     return 0;
782 }
783
784 static int
785 set_flow_actions(struct dp_netdev_flow *flow, struct odp_flow *odp_flow)
786 {
787     size_t n_bytes;
788     bool mutates;
789     int error;
790
791     if (odp_flow->n_actions >= 4096 / sizeof *odp_flow->actions) {
792         return EINVAL;
793     }
794     error = dpif_netdev_validate_actions(odp_flow->actions,
795                                          odp_flow->n_actions, &mutates);
796     if (error) {
797         return error;
798     }
799
800     n_bytes = odp_flow->n_actions * sizeof *flow->actions;
801     flow->actions = xrealloc(flow->actions, n_bytes);
802     flow->n_actions = odp_flow->n_actions;
803     memcpy(flow->actions, odp_flow->actions, n_bytes);
804     return 0;
805 }
806
807 static int
808 add_flow(struct dpif *dpif, struct odp_flow *odp_flow)
809 {
810     struct dp_netdev *dp = get_dp_netdev(dpif);
811     struct dp_netdev_flow *flow;
812     int error;
813
814     flow = xzalloc(sizeof *flow);
815     flow->key = odp_flow->key;
816     memset(flow->key.reserved, 0, sizeof flow->key.reserved);
817
818     error = set_flow_actions(flow, odp_flow);
819     if (error) {
820         free(flow);
821         return error;
822     }
823
824     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
825     return 0;
826 }
827
828 static void
829 clear_stats(struct dp_netdev_flow *flow)
830 {
831     flow->used.tv_sec = 0;
832     flow->used.tv_usec = 0;
833     flow->packet_count = 0;
834     flow->byte_count = 0;
835     flow->ip_tos = 0;
836     flow->tcp_ctl = 0;
837 }
838
839 static int
840 dpif_netdev_flow_put(struct dpif *dpif, struct odp_flow_put *put)
841 {
842     struct dp_netdev *dp = get_dp_netdev(dpif);
843     struct dp_netdev_flow *flow;
844
845     flow = dp_netdev_lookup_flow(dp, &put->flow.key);
846     if (!flow) {
847         if (put->flags & ODPPF_CREATE) {
848             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
849                 return add_flow(dpif, &put->flow);
850             } else {
851                 return EFBIG;
852             }
853         } else {
854             return ENOENT;
855         }
856     } else {
857         if (put->flags & ODPPF_MODIFY) {
858             int error = set_flow_actions(flow, &put->flow);
859             if (!error && put->flags & ODPPF_ZERO_STATS) {
860                 clear_stats(flow);
861             }
862             return error;
863         } else {
864             return EEXIST;
865         }
866     }
867 }
868
869
870 static int
871 dpif_netdev_flow_del(struct dpif *dpif, struct odp_flow *odp_flow)
872 {
873     struct dp_netdev *dp = get_dp_netdev(dpif);
874     struct dp_netdev_flow *flow;
875
876     flow = dp_netdev_lookup_flow(dp, &odp_flow->key);
877     if (flow) {
878         answer_flow_query(flow, 0, odp_flow);
879         dp_netdev_free_flow(dp, flow);
880         return 0;
881     } else {
882         return ENOENT;
883     }
884 }
885
886 static int
887 dpif_netdev_flow_list(const struct dpif *dpif, struct odp_flow flows[], int n)
888 {
889     struct dp_netdev *dp = get_dp_netdev(dpif);
890     struct dp_netdev_flow *flow;
891     int i;
892
893     i = 0;
894     HMAP_FOR_EACH (flow, struct dp_netdev_flow, node, &dp->flow_table) {
895         if (i >= n) {
896             break;
897         }
898         answer_flow_query(flow, 0, &flows[i++]);
899     }
900     return hmap_count(&dp->flow_table);
901 }
902
903 static int
904 dpif_netdev_execute(struct dpif *dpif, uint16_t in_port,
905                     const union odp_action actions[], int n_actions,
906                     const struct ofpbuf *packet)
907 {
908     struct dp_netdev *dp = get_dp_netdev(dpif);
909     struct ofpbuf copy;
910     bool mutates;
911     flow_t flow;
912     int error;
913
914     if (packet->size < ETH_HEADER_LEN || packet->size > UINT16_MAX) {
915         return EINVAL;
916     }
917
918     error = dpif_netdev_validate_actions(actions, n_actions, &mutates);
919     if (error) {
920         return error;
921     }
922
923     if (mutates) {
924         /* We need a deep copy of 'packet' since we're going to modify its
925          * data. */
926         ofpbuf_init(&copy, DP_NETDEV_HEADROOM + packet->size);
927         copy.data = (char*)copy.base + DP_NETDEV_HEADROOM;
928         ofpbuf_put(&copy, packet->data, packet->size);
929     } else {
930         /* We still need a shallow copy of 'packet', even though we won't
931          * modify its data, because flow_extract() modifies packet->l2, etc.
932          * We could probably get away with modifying those but it's more polite
933          * if we don't. */
934         copy = *packet;
935     }
936     flow_extract(&copy, 0, in_port, &flow);
937     error = dp_netdev_execute_actions(dp, &copy, &flow, actions, n_actions);
938     if (mutates) {
939         ofpbuf_uninit(&copy);
940     }
941     return error;
942 }
943
944 static int
945 dpif_netdev_recv_get_mask(const struct dpif *dpif, int *listen_mask)
946 {
947     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
948     *listen_mask = dpif_netdev->listen_mask;
949     return 0;
950 }
951
952 static int
953 dpif_netdev_recv_set_mask(struct dpif *dpif, int listen_mask)
954 {
955     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
956     if (!(listen_mask & ~ODPL_ALL)) {
957         dpif_netdev->listen_mask = listen_mask;
958         return 0;
959     } else {
960         return EINVAL;
961     }
962 }
963
964 static struct ovs_queue *
965 find_nonempty_queue(struct dpif *dpif)
966 {
967     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
968     struct dp_netdev *dp = get_dp_netdev(dpif);
969     int mask = dpif_netdev->listen_mask;
970     int i;
971
972     for (i = 0; i < N_QUEUES; i++) {
973         struct ovs_queue *q = &dp->queues[i];
974         if (q->n && mask & (1u << i)) {
975             return q;
976         }
977     }
978     return NULL;
979 }
980
981 static int
982 dpif_netdev_recv(struct dpif *dpif, struct ofpbuf **bufp)
983 {
984     struct ovs_queue *q = find_nonempty_queue(dpif);
985     if (q) {
986         *bufp = queue_pop_head(q);
987         return 0;
988     } else {
989         return EAGAIN;
990     }
991 }
992
993 static void
994 dpif_netdev_recv_wait(struct dpif *dpif)
995 {
996     struct ovs_queue *q = find_nonempty_queue(dpif);
997     if (q) {
998         poll_immediate_wake();
999     } else {
1000         /* No messages ready to be received, and dp_wait() will ensure that we
1001          * wake up to queue new messages, so there is nothing to do. */
1002     }
1003 }
1004 \f
1005 static void
1006 dp_netdev_flow_used(struct dp_netdev_flow *flow, const flow_t *key,
1007                     const struct ofpbuf *packet)
1008 {
1009     time_timeval(&flow->used);
1010     flow->packet_count++;
1011     flow->byte_count += packet->size;
1012     if (key->dl_type == htons(ETH_TYPE_IP)) {
1013         struct ip_header *nh = packet->l3;
1014         flow->ip_tos = nh->ip_tos;
1015
1016         if (key->nw_proto == IPPROTO_TCP) {
1017             struct tcp_header *th = packet->l4;
1018             flow->tcp_ctl |= th->tcp_ctl;
1019         }
1020     }
1021 }
1022
1023 static void
1024 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1025                      struct ofpbuf *packet)
1026 {
1027     struct dp_netdev_flow *flow;
1028     flow_t key;
1029
1030     if (flow_extract(packet, 0, port->port_no, &key) && dp->drop_frags) {
1031         dp->n_frags++;
1032         return;
1033     }
1034
1035     flow = dp_netdev_lookup_flow(dp, &key);
1036     if (flow) {
1037         dp_netdev_flow_used(flow, &key, packet);
1038         dp_netdev_execute_actions(dp, packet, &key,
1039                                   flow->actions, flow->n_actions);
1040         dp->n_hit++;
1041     } else {
1042         dp->n_missed++;
1043         dp_netdev_output_control(dp, packet, _ODPL_MISS_NR, port->port_no, 0);
1044     }
1045 }
1046
1047 static void
1048 dp_netdev_run(void)
1049 {
1050     struct ofpbuf packet;
1051     struct dp_netdev *dp;
1052
1053     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + max_mtu);
1054     LIST_FOR_EACH (dp, struct dp_netdev, node, &dp_netdev_list) {
1055         struct dp_netdev_port *port;
1056
1057         LIST_FOR_EACH (port, struct dp_netdev_port, node, &dp->port_list) {
1058             int error;
1059
1060             /* Reset packet contents. */
1061             packet.data = (char*)packet.base + DP_NETDEV_HEADROOM;
1062             packet.size = 0;
1063
1064             error = netdev_recv(port->netdev, &packet);
1065             if (!error) {
1066                 dp_netdev_port_input(dp, port, &packet);
1067             } else if (error != EAGAIN) {
1068                 struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1069                 VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1070                             netdev_get_name(port->netdev), strerror(error));
1071             }
1072         }
1073     }
1074     ofpbuf_uninit(&packet);
1075 }
1076
1077 static void
1078 dp_netdev_wait(void)
1079 {
1080     struct dp_netdev *dp;
1081
1082     LIST_FOR_EACH (dp, struct dp_netdev, node, &dp_netdev_list) {
1083         struct dp_netdev_port *port;
1084         LIST_FOR_EACH (port, struct dp_netdev_port, node, &dp->port_list) {
1085             netdev_recv_wait(port->netdev);
1086         }
1087     }
1088 }
1089
1090
1091 /* Modify the TCI field of 'packet'.  If a VLAN tag is not present, one
1092  * is added with the TCI field set to 'tci'.  If a VLAN tag is present, 
1093  * then 'mask' bits are cleared before 'tci' is logically OR'd into the
1094  * TCI field.
1095  *
1096  * Note that the function does not ensure that 'tci' does not affect
1097  * bits outside of 'mask'.
1098  */
1099 static void
1100 dp_netdev_modify_vlan_tci(struct ofpbuf *packet, flow_t *key,
1101                           uint16_t tci, uint16_t mask)
1102 {
1103     struct vlan_eth_header *veh;
1104
1105     if (key->dl_vlan != htons(ODP_VLAN_NONE)) {
1106         /* Clear 'mask' bits, but maintain other TCI bits. */
1107         veh = packet->l2;
1108         veh->veth_tci &= ~htons(mask);
1109         veh->veth_tci |= htons(tci);
1110     } else {
1111         /* Insert new 802.1Q header. */
1112         struct eth_header *eh = packet->l2;
1113         struct vlan_eth_header tmp;
1114         memcpy(tmp.veth_dst, eh->eth_dst, ETH_ADDR_LEN);
1115         memcpy(tmp.veth_src, eh->eth_src, ETH_ADDR_LEN);
1116         tmp.veth_type = htons(ETH_TYPE_VLAN);
1117         tmp.veth_tci = htons(tci);
1118         tmp.veth_next_type = eh->eth_type;
1119
1120         veh = ofpbuf_push_uninit(packet, VLAN_HEADER_LEN);
1121         memcpy(veh, &tmp, sizeof tmp);
1122         packet->l2 = (char*)packet->l2 - VLAN_HEADER_LEN;
1123     }
1124
1125     key->dl_vlan = veh->veth_tci & htons(VLAN_VID_MASK);
1126 }
1127
1128 static void
1129 dp_netdev_strip_vlan(struct ofpbuf *packet, flow_t *key)
1130 {
1131     struct vlan_eth_header *veh = packet->l2;
1132     if (veh->veth_type == htons(ETH_TYPE_VLAN)) {
1133         struct eth_header tmp;
1134
1135         memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
1136         memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
1137         tmp.eth_type = veh->veth_next_type;
1138
1139         packet->size -= VLAN_HEADER_LEN;
1140         packet->data = (char*)packet->data + VLAN_HEADER_LEN;
1141         packet->l2 = (char*)packet->l2 + VLAN_HEADER_LEN;
1142         memcpy(packet->data, &tmp, sizeof tmp);
1143
1144         key->dl_vlan = htons(ODP_VLAN_NONE);
1145     }
1146 }
1147
1148 static void
1149 dp_netdev_set_dl_src(struct ofpbuf *packet, flow_t *key,
1150                      const uint8_t dl_addr[ETH_ADDR_LEN])
1151 {
1152     struct eth_header *eh = packet->l2;
1153     memcpy(eh->eth_src, dl_addr, sizeof eh->eth_src);
1154     memcpy(key->dl_src, dl_addr, sizeof key->dl_src);
1155 }
1156
1157 static void
1158 dp_netdev_set_dl_dst(struct ofpbuf *packet, flow_t *key,
1159                      const uint8_t dl_addr[ETH_ADDR_LEN])
1160 {
1161     struct eth_header *eh = packet->l2;
1162     memcpy(eh->eth_dst, dl_addr, sizeof eh->eth_dst);
1163     memcpy(key->dl_dst, dl_addr, sizeof key->dl_dst);
1164 }
1165
1166 static void
1167 dp_netdev_set_nw_addr(struct ofpbuf *packet, flow_t *key,
1168                       const struct odp_action_nw_addr *a)
1169 {
1170     if (key->dl_type == htons(ETH_TYPE_IP)) {
1171         struct ip_header *nh = packet->l3;
1172         uint32_t *field;
1173
1174         field = a->type == ODPAT_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
1175         if (key->nw_proto == IP_TYPE_TCP) {
1176             struct tcp_header *th = packet->l4;
1177             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, a->nw_addr);
1178         } else if (key->nw_proto == IP_TYPE_UDP) {
1179             struct udp_header *uh = packet->l4;
1180             if (uh->udp_csum) {
1181                 uh->udp_csum = recalc_csum32(uh->udp_csum, *field, a->nw_addr);
1182                 if (!uh->udp_csum) {
1183                     uh->udp_csum = 0xffff;
1184                 }
1185             }
1186         }
1187         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, a->nw_addr);
1188         *field = a->nw_addr;
1189
1190         if (a->type == ODPAT_SET_NW_SRC) {
1191             key->nw_src = a->type;
1192         } else {
1193             key->nw_dst = a->type;
1194         }
1195     }
1196 }
1197
1198 static void
1199 dp_netdev_set_nw_tos(struct ofpbuf *packet, flow_t *key,
1200                      const struct odp_action_nw_tos *a)
1201 {
1202     if (key->dl_type == htons(ETH_TYPE_IP)) {
1203         struct ip_header *nh = packet->l3;
1204         uint8_t *field = &nh->ip_tos;
1205
1206         /* Set the DSCP bits and preserve the ECN bits. */
1207         uint8_t new = a->nw_tos | (nh->ip_tos & IP_ECN_MASK);
1208
1209         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t)*field),
1210                 htons((uint16_t)a->nw_tos));
1211         *field = new;
1212         key->nw_tos = a->nw_tos;
1213     }
1214 }
1215
1216 static void
1217 dp_netdev_set_tp_port(struct ofpbuf *packet, flow_t *key,
1218                       const struct odp_action_tp_port *a)
1219 {
1220         if (key->dl_type == htons(ETH_TYPE_IP)) {
1221         uint16_t *field;
1222         if (key->nw_proto == IPPROTO_TCP) {
1223             struct tcp_header *th = packet->l4;
1224             field = a->type == ODPAT_SET_TP_SRC ? &th->tcp_src : &th->tcp_dst;
1225             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, a->tp_port);
1226             *field = a->tp_port;
1227         } else if (key->nw_proto == IPPROTO_UDP) {
1228             struct udp_header *uh = packet->l4;
1229             field = a->type == ODPAT_SET_TP_SRC ? &uh->udp_src : &uh->udp_dst;
1230             uh->udp_csum = recalc_csum16(uh->udp_csum, *field, a->tp_port);
1231             *field = a->tp_port;
1232         } else {
1233             return;
1234         }
1235
1236         if (a->type == ODPAT_SET_TP_SRC) {
1237             key->tp_src = a->tp_port;
1238         } else {
1239             key->tp_dst = a->tp_port;
1240         }
1241     }
1242 }
1243
1244 static void
1245 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1246                       uint16_t out_port)
1247 {
1248         struct dp_netdev_port *p = dp->ports[out_port];
1249     if (p) {
1250         netdev_send(p->netdev, packet);
1251     }
1252 }
1253
1254 static void
1255 dp_netdev_output_group(struct dp_netdev *dp, uint16_t group, uint16_t in_port,
1256                        struct ofpbuf *packet)
1257 {
1258         struct odp_port_group *g = &dp->groups[group];
1259         int i;
1260
1261         for (i = 0; i < g->n_ports; i++) {
1262         uint16_t out_port = g->ports[i];
1263         if (out_port != in_port) {
1264             dp_netdev_output_port(dp, packet, out_port);
1265         }
1266         }
1267 }
1268
1269 static int
1270 dp_netdev_output_control(struct dp_netdev *dp, const struct ofpbuf *packet,
1271                          int queue_no, int port_no, uint32_t arg)
1272 {
1273     struct ovs_queue *q = &dp->queues[queue_no];
1274     struct odp_msg *header;
1275     struct ofpbuf *msg;
1276     size_t msg_size;
1277
1278     if (q->n >= MAX_QUEUE_LEN) {
1279         dp->n_lost++;
1280         return ENOBUFS;
1281     }
1282
1283     msg_size = sizeof *header + packet->size;
1284     msg = ofpbuf_new(msg_size + DPIF_RECV_MSG_PADDING);
1285     ofpbuf_reserve(msg, DPIF_RECV_MSG_PADDING);
1286     header = ofpbuf_put_uninit(msg, sizeof *header);
1287     header->type = queue_no;
1288     header->length = msg_size;
1289     header->port = port_no;
1290     header->arg = arg;
1291     ofpbuf_put(msg, packet->data, packet->size);
1292     queue_push_tail(q, msg);
1293
1294     return 0;
1295 }
1296
1297 static int
1298 dp_netdev_execute_actions(struct dp_netdev *dp,
1299                           struct ofpbuf *packet, flow_t *key,
1300                           const union odp_action *actions, int n_actions)
1301 {
1302     int i;
1303     for (i = 0; i < n_actions; i++) {
1304         const union odp_action *a = &actions[i];
1305
1306                 switch (a->type) {
1307                 case ODPAT_OUTPUT:
1308             dp_netdev_output_port(dp, packet, a->output.port);
1309                         break;
1310
1311                 case ODPAT_OUTPUT_GROUP:
1312                         dp_netdev_output_group(dp, a->output_group.group, key->in_port,
1313                                    packet);
1314                         break;
1315
1316                 case ODPAT_CONTROLLER:
1317             dp_netdev_output_control(dp, packet, _ODPL_ACTION_NR,
1318                                      key->in_port, a->controller.arg);
1319                         break;
1320
1321                 case ODPAT_SET_VLAN_VID:
1322                         dp_netdev_modify_vlan_tci(packet, key, ntohs(a->vlan_vid.vlan_vid),
1323                                       VLAN_VID_MASK);
1324             break;
1325
1326                 case ODPAT_SET_VLAN_PCP:
1327                         dp_netdev_modify_vlan_tci(
1328                 packet, key, a->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT,
1329                 VLAN_PCP_MASK);
1330             break;
1331
1332                 case ODPAT_STRIP_VLAN:
1333                         dp_netdev_strip_vlan(packet, key);
1334                         break;
1335
1336                 case ODPAT_SET_DL_SRC:
1337             dp_netdev_set_dl_src(packet, key, a->dl_addr.dl_addr);
1338                         break;
1339
1340                 case ODPAT_SET_DL_DST:
1341             dp_netdev_set_dl_dst(packet, key, a->dl_addr.dl_addr);
1342                         break;
1343
1344                 case ODPAT_SET_NW_SRC:
1345                 case ODPAT_SET_NW_DST:
1346                         dp_netdev_set_nw_addr(packet, key, &a->nw_addr);
1347                         break;
1348
1349                 case ODPAT_SET_NW_TOS:
1350                         dp_netdev_set_nw_tos(packet, key, &a->nw_tos);
1351                         break;
1352
1353                 case ODPAT_SET_TP_SRC:
1354                 case ODPAT_SET_TP_DST:
1355                         dp_netdev_set_tp_port(packet, key, &a->tp_port);
1356                         break;
1357                 }
1358         }
1359     return 0;
1360 }
1361
1362 const struct dpif_class dpif_netdev_class = {
1363     "netdev",
1364     dp_netdev_run,
1365     dp_netdev_wait,
1366     NULL,                       /* enumerate */
1367     dpif_netdev_open,
1368     dpif_netdev_close,
1369     NULL,                       /* get_all_names */
1370     dpif_netdev_destroy,
1371     dpif_netdev_get_stats,
1372     dpif_netdev_get_drop_frags,
1373     dpif_netdev_set_drop_frags,
1374     dpif_netdev_port_add,
1375     dpif_netdev_port_del,
1376     dpif_netdev_port_query_by_number,
1377     dpif_netdev_port_query_by_name,
1378     dpif_netdev_port_list,
1379     dpif_netdev_port_poll,
1380     dpif_netdev_port_poll_wait,
1381     dpif_netdev_port_group_get,
1382     dpif_netdev_port_group_set,
1383     dpif_netdev_flow_get,
1384     dpif_netdev_flow_put,
1385     dpif_netdev_flow_del,
1386     dpif_netdev_flow_flush,
1387     dpif_netdev_flow_list,
1388     dpif_netdev_execute,
1389     dpif_netdev_recv_get_mask,
1390     dpif_netdev_recv_set_mask,
1391     NULL,                       /* get_sflow_probability */
1392     NULL,                       /* set_sflow_probability */
1393     dpif_netdev_recv,
1394     dpif_netdev_recv_wait,
1395 };