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