60094073e56ca8bf104475aaf2f0c650a94aacdf
[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 #include "vlog.h"
49
50 VLOG_DEFINE_THIS_MODULE(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 timespec used;       /* Last used time. */
103     long long int packet_count; /* Number of packets matched. */
104     long long int byte_count;   /* Number of bytes matched. */
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 *, const 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     if (internal) {
378         netdev_options.type = "tap";
379     }
380
381     error = netdev_open(&netdev_options, &netdev);
382     if (error) {
383         return error;
384     }
385     /* XXX reject loopback devices */
386     /* XXX reject non-Ethernet devices */
387
388     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, false);
389     if (error) {
390         netdev_close(netdev);
391         return error;
392     }
393
394     port = xmalloc(sizeof *port);
395     port->port_no = port_no;
396     port->netdev = netdev;
397     port->internal = internal;
398
399     netdev_get_mtu(netdev, &mtu);
400     if (mtu > max_mtu) {
401         max_mtu = mtu;
402     }
403
404     list_push_back(&dp->port_list, &port->node);
405     dp->ports[port_no] = port;
406     dp->n_ports++;
407     dp->serial++;
408
409     return 0;
410 }
411
412 static int
413 dpif_netdev_port_add(struct dpif *dpif, const char *devname, uint16_t flags,
414                      uint16_t *port_nop)
415 {
416     struct dp_netdev *dp = get_dp_netdev(dpif);
417     int port_no;
418
419     for (port_no = 0; port_no < MAX_PORTS; port_no++) {
420         if (!dp->ports[port_no]) {
421             *port_nop = port_no;
422             return do_add_port(dp, devname, flags, port_no);
423         }
424     }
425     return EFBIG;
426 }
427
428 static int
429 dpif_netdev_port_del(struct dpif *dpif, uint16_t port_no)
430 {
431     struct dp_netdev *dp = get_dp_netdev(dpif);
432     return port_no == ODPP_LOCAL ? EINVAL : do_del_port(dp, port_no);
433 }
434
435 static bool
436 is_valid_port_number(uint16_t port_no)
437 {
438     return port_no < MAX_PORTS;
439 }
440
441 static int
442 get_port_by_number(struct dp_netdev *dp,
443                    uint16_t port_no, struct dp_netdev_port **portp)
444 {
445     if (!is_valid_port_number(port_no)) {
446         *portp = NULL;
447         return EINVAL;
448     } else {
449         *portp = dp->ports[port_no];
450         return *portp ? 0 : ENOENT;
451     }
452 }
453
454 static int
455 get_port_by_name(struct dp_netdev *dp,
456                  const char *devname, struct dp_netdev_port **portp)
457 {
458     struct dp_netdev_port *port;
459
460     LIST_FOR_EACH (port, node, &dp->port_list) {
461         if (!strcmp(netdev_get_name(port->netdev), devname)) {
462             *portp = port;
463             return 0;
464         }
465     }
466     return ENOENT;
467 }
468
469 static int
470 do_del_port(struct dp_netdev *dp, uint16_t port_no)
471 {
472     struct dp_netdev_port *port;
473     char *name;
474     int error;
475
476     error = get_port_by_number(dp, port_no, &port);
477     if (error) {
478         return error;
479     }
480
481     list_remove(&port->node);
482     dp->ports[port->port_no] = NULL;
483     dp->n_ports--;
484     dp->serial++;
485
486     name = xstrdup(netdev_get_name(port->netdev));
487     netdev_close(port->netdev);
488
489     free(name);
490     free(port);
491
492     return 0;
493 }
494
495 static void
496 answer_port_query(const struct dp_netdev_port *port, struct odp_port *odp_port)
497 {
498     memset(odp_port, 0, sizeof *odp_port);
499     ovs_strlcpy(odp_port->devname, netdev_get_name(port->netdev),
500                 sizeof odp_port->devname);
501     odp_port->port = port->port_no;
502     odp_port->flags = port->internal ? ODP_PORT_INTERNAL : 0;
503 }
504
505 static int
506 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
507                                  struct odp_port *odp_port)
508 {
509     struct dp_netdev *dp = get_dp_netdev(dpif);
510     struct dp_netdev_port *port;
511     int error;
512
513     error = get_port_by_number(dp, port_no, &port);
514     if (!error) {
515         answer_port_query(port, odp_port);
516     }
517     return error;
518 }
519
520 static int
521 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
522                                struct odp_port *odp_port)
523 {
524     struct dp_netdev *dp = get_dp_netdev(dpif);
525     struct dp_netdev_port *port;
526     int error;
527
528     error = get_port_by_name(dp, devname, &port);
529     if (!error) {
530         answer_port_query(port, odp_port);
531     }
532     return error;
533 }
534
535 static void
536 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
537 {
538     hmap_remove(&dp->flow_table, &flow->node);
539     free(flow->actions);
540     free(flow);
541 }
542
543 static void
544 dp_netdev_flow_flush(struct dp_netdev *dp)
545 {
546     struct dp_netdev_flow *flow, *next;
547
548     HMAP_FOR_EACH_SAFE (flow, next, node, &dp->flow_table) {
549         dp_netdev_free_flow(dp, flow);
550     }
551 }
552
553 static int
554 dpif_netdev_flow_flush(struct dpif *dpif)
555 {
556     struct dp_netdev *dp = get_dp_netdev(dpif);
557     dp_netdev_flow_flush(dp);
558     return 0;
559 }
560
561 static int
562 dpif_netdev_port_list(const struct dpif *dpif, struct odp_port *ports, int n)
563 {
564     struct dp_netdev *dp = get_dp_netdev(dpif);
565     struct dp_netdev_port *port;
566     int i;
567
568     i = 0;
569     LIST_FOR_EACH (port, node, &dp->port_list) {
570         struct odp_port *odp_port = &ports[i];
571         if (i >= n) {
572             break;
573         }
574         answer_port_query(port, odp_port);
575         i++;
576     }
577     return dp->n_ports;
578 }
579
580 static int
581 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
582 {
583     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
584     if (dpif->dp_serial != dpif->dp->serial) {
585         dpif->dp_serial = dpif->dp->serial;
586         return ENOBUFS;
587     } else {
588         return EAGAIN;
589     }
590 }
591
592 static void
593 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
594 {
595     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
596     if (dpif->dp_serial != dpif->dp->serial) {
597         poll_immediate_wake();
598     }
599 }
600
601 static int
602 get_port_group(const struct dpif *dpif, int group_no,
603                struct odp_port_group **groupp)
604 {
605     struct dp_netdev *dp = get_dp_netdev(dpif);
606
607     if (group_no >= 0 && group_no < N_GROUPS) {
608         *groupp = &dp->groups[group_no];
609         return 0;
610     } else {
611         *groupp = NULL;
612         return EINVAL;
613     }
614 }
615
616 static int
617 dpif_netdev_port_group_get(const struct dpif *dpif, int group_no,
618                            uint16_t ports[], int n)
619 {
620     struct odp_port_group *group;
621     int error;
622
623     if (n < 0) {
624         return -EINVAL;
625     }
626
627     error = get_port_group(dpif, group_no, &group);
628     if (!error) {
629         memcpy(ports, group->ports, MIN(n, group->n_ports) * sizeof *ports);
630         return group->n_ports;
631     } else {
632         return -error;
633     }
634 }
635
636 static int
637 dpif_netdev_port_group_set(struct dpif *dpif, int group_no,
638                            const uint16_t ports[], int n)
639 {
640     struct odp_port_group *group;
641     int error;
642
643     if (n < 0 || n > MAX_PORTS) {
644         return EINVAL;
645     }
646
647     error = get_port_group(dpif, group_no, &group);
648     if (!error) {
649         free(group->ports);
650         group->ports = xmemdup(ports, n * sizeof *group->ports);
651         group->n_ports = n;
652         group->group = group_no;
653     }
654     return error;
655 }
656
657 static struct dp_netdev_flow *
658 dp_netdev_lookup_flow(const struct dp_netdev *dp, const flow_t *key)
659 {
660     struct dp_netdev_flow *flow;
661
662     assert(!key->reserved[0] && !key->reserved[1] && !key->reserved[2]);
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 answer_flow_query(struct dp_netdev_flow *flow, uint32_t query_flags,
673                   struct odp_flow *odp_flow)
674 {
675     if (flow) {
676         odp_flow->key = flow->key;
677         odp_flow->stats.n_packets = flow->packet_count;
678         odp_flow->stats.n_bytes = flow->byte_count;
679         odp_flow->stats.used_sec = flow->used.tv_sec;
680         odp_flow->stats.used_nsec = flow->used.tv_nsec;
681         odp_flow->stats.tcp_flags = TCP_FLAGS(flow->tcp_ctl);
682         odp_flow->stats.reserved = 0;
683         odp_flow->stats.error = 0;
684         if (odp_flow->n_actions > 0) {
685             unsigned int n = MIN(odp_flow->n_actions, flow->n_actions);
686             memcpy(odp_flow->actions, flow->actions,
687                    n * sizeof *odp_flow->actions);
688             odp_flow->n_actions = flow->n_actions;
689         }
690
691         if (query_flags & ODPFF_ZERO_TCP_FLAGS) {
692             flow->tcp_ctl = 0;
693         }
694
695     } else {
696         odp_flow->stats.error = ENOENT;
697     }
698 }
699
700 static int
701 dpif_netdev_flow_get(const struct dpif *dpif, struct odp_flow flows[], int n)
702 {
703     struct dp_netdev *dp = get_dp_netdev(dpif);
704     int i;
705
706     for (i = 0; i < n; i++) {
707         struct odp_flow *odp_flow = &flows[i];
708         answer_flow_query(dp_netdev_lookup_flow(dp, &odp_flow->key),
709                           odp_flow->flags, odp_flow);
710     }
711     return 0;
712 }
713
714 static int
715 dpif_netdev_validate_actions(const union odp_action *actions, int n_actions,
716                              bool *mutates)
717 {
718     unsigned int i;
719
720     *mutates = false;
721     for (i = 0; i < n_actions; i++) {
722         const union odp_action *a = &actions[i];
723         switch (a->type) {
724         case ODPAT_OUTPUT:
725             if (a->output.port >= MAX_PORTS) {
726                 return EINVAL;
727             }
728             break;
729
730         case ODPAT_OUTPUT_GROUP:
731             *mutates = true;
732             if (a->output_group.group >= N_GROUPS) {
733                 return EINVAL;
734             }
735             break;
736
737         case ODPAT_CONTROLLER:
738             break;
739
740         case ODPAT_SET_VLAN_VID:
741             *mutates = true;
742             if (a->vlan_vid.vlan_vid & htons(~VLAN_VID_MASK)) {
743                 return EINVAL;
744             }
745             break;
746
747         case ODPAT_SET_VLAN_PCP:
748             *mutates = true;
749             if (a->vlan_pcp.vlan_pcp & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
750                 return EINVAL;
751             }
752             break;
753
754         case ODPAT_SET_NW_TOS:
755             *mutates = true;
756             if (a->nw_tos.nw_tos & IP_ECN_MASK) {
757                 return EINVAL;
758             }
759             break;
760
761         case ODPAT_STRIP_VLAN:
762         case ODPAT_SET_DL_SRC:
763         case ODPAT_SET_DL_DST:
764         case ODPAT_SET_NW_SRC:
765         case ODPAT_SET_NW_DST:
766         case ODPAT_SET_TP_SRC:
767         case ODPAT_SET_TP_DST:
768             *mutates = true;
769             break;
770
771         default:
772             return EOPNOTSUPP;
773         }
774     }
775     return 0;
776 }
777
778 static int
779 set_flow_actions(struct dp_netdev_flow *flow, struct odp_flow *odp_flow)
780 {
781     size_t n_bytes;
782     bool mutates;
783     int error;
784
785     if (odp_flow->n_actions >= 4096 / sizeof *odp_flow->actions) {
786         return EINVAL;
787     }
788     error = dpif_netdev_validate_actions(odp_flow->actions,
789                                          odp_flow->n_actions, &mutates);
790     if (error) {
791         return error;
792     }
793
794     n_bytes = odp_flow->n_actions * sizeof *flow->actions;
795     flow->actions = xrealloc(flow->actions, n_bytes);
796     flow->n_actions = odp_flow->n_actions;
797     memcpy(flow->actions, odp_flow->actions, n_bytes);
798     return 0;
799 }
800
801 static int
802 add_flow(struct dpif *dpif, struct odp_flow *odp_flow)
803 {
804     struct dp_netdev *dp = get_dp_netdev(dpif);
805     struct dp_netdev_flow *flow;
806     int error;
807
808     flow = xzalloc(sizeof *flow);
809     flow->key = odp_flow->key;
810     memset(flow->key.reserved, 0, sizeof flow->key.reserved);
811
812     error = set_flow_actions(flow, odp_flow);
813     if (error) {
814         free(flow);
815         return error;
816     }
817
818     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
819     return 0;
820 }
821
822 static void
823 clear_stats(struct dp_netdev_flow *flow)
824 {
825     flow->used.tv_sec = 0;
826     flow->used.tv_nsec = 0;
827     flow->packet_count = 0;
828     flow->byte_count = 0;
829     flow->tcp_ctl = 0;
830 }
831
832 static int
833 dpif_netdev_flow_put(struct dpif *dpif, struct odp_flow_put *put)
834 {
835     struct dp_netdev *dp = get_dp_netdev(dpif);
836     struct dp_netdev_flow *flow;
837
838     flow = dp_netdev_lookup_flow(dp, &put->flow.key);
839     if (!flow) {
840         if (put->flags & ODPPF_CREATE) {
841             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
842                 return add_flow(dpif, &put->flow);
843             } else {
844                 return EFBIG;
845             }
846         } else {
847             return ENOENT;
848         }
849     } else {
850         if (put->flags & ODPPF_MODIFY) {
851             int error = set_flow_actions(flow, &put->flow);
852             if (!error && put->flags & ODPPF_ZERO_STATS) {
853                 clear_stats(flow);
854             }
855             return error;
856         } else {
857             return EEXIST;
858         }
859     }
860 }
861
862
863 static int
864 dpif_netdev_flow_del(struct dpif *dpif, struct odp_flow *odp_flow)
865 {
866     struct dp_netdev *dp = get_dp_netdev(dpif);
867     struct dp_netdev_flow *flow;
868
869     flow = dp_netdev_lookup_flow(dp, &odp_flow->key);
870     if (flow) {
871         answer_flow_query(flow, 0, odp_flow);
872         dp_netdev_free_flow(dp, flow);
873         return 0;
874     } else {
875         return ENOENT;
876     }
877 }
878
879 static int
880 dpif_netdev_flow_list(const struct dpif *dpif, struct odp_flow flows[], int n)
881 {
882     struct dp_netdev *dp = get_dp_netdev(dpif);
883     struct dp_netdev_flow *flow;
884     int i;
885
886     i = 0;
887     HMAP_FOR_EACH (flow, node, &dp->flow_table) {
888         if (i >= n) {
889             break;
890         }
891         answer_flow_query(flow, 0, &flows[i++]);
892     }
893     return hmap_count(&dp->flow_table);
894 }
895
896 static int
897 dpif_netdev_execute(struct dpif *dpif, uint16_t in_port,
898                     const union odp_action actions[], int n_actions,
899                     const struct ofpbuf *packet)
900 {
901     struct dp_netdev *dp = get_dp_netdev(dpif);
902     struct ofpbuf copy;
903     bool mutates;
904     flow_t flow;
905     int error;
906
907     if (packet->size < ETH_HEADER_LEN || packet->size > UINT16_MAX) {
908         return EINVAL;
909     }
910
911     error = dpif_netdev_validate_actions(actions, n_actions, &mutates);
912     if (error) {
913         return error;
914     }
915
916     if (mutates) {
917         /* We need a deep copy of 'packet' since we're going to modify its
918          * data. */
919         ofpbuf_init(&copy, DP_NETDEV_HEADROOM + packet->size);
920         copy.data = (char*)copy.base + DP_NETDEV_HEADROOM;
921         ofpbuf_put(&copy, packet->data, packet->size);
922     } else {
923         /* We still need a shallow copy of 'packet', even though we won't
924          * modify its data, because flow_extract() modifies packet->l2, etc.
925          * We could probably get away with modifying those but it's more polite
926          * if we don't. */
927         copy = *packet;
928     }
929     flow_extract(&copy, 0, in_port, &flow);
930     error = dp_netdev_execute_actions(dp, &copy, &flow, actions, n_actions);
931     if (mutates) {
932         ofpbuf_uninit(&copy);
933     }
934     return error;
935 }
936
937 static int
938 dpif_netdev_recv_get_mask(const struct dpif *dpif, int *listen_mask)
939 {
940     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
941     *listen_mask = dpif_netdev->listen_mask;
942     return 0;
943 }
944
945 static int
946 dpif_netdev_recv_set_mask(struct dpif *dpif, int listen_mask)
947 {
948     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
949     if (!(listen_mask & ~ODPL_ALL)) {
950         dpif_netdev->listen_mask = listen_mask;
951         return 0;
952     } else {
953         return EINVAL;
954     }
955 }
956
957 static struct ovs_queue *
958 find_nonempty_queue(struct dpif *dpif)
959 {
960     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
961     struct dp_netdev *dp = get_dp_netdev(dpif);
962     int mask = dpif_netdev->listen_mask;
963     int i;
964
965     for (i = 0; i < N_QUEUES; i++) {
966         struct ovs_queue *q = &dp->queues[i];
967         if (q->n && mask & (1u << i)) {
968             return q;
969         }
970     }
971     return NULL;
972 }
973
974 static int
975 dpif_netdev_recv(struct dpif *dpif, struct ofpbuf **bufp)
976 {
977     struct ovs_queue *q = find_nonempty_queue(dpif);
978     if (q) {
979         *bufp = queue_pop_head(q);
980         return 0;
981     } else {
982         return EAGAIN;
983     }
984 }
985
986 static void
987 dpif_netdev_recv_wait(struct dpif *dpif)
988 {
989     struct ovs_queue *q = find_nonempty_queue(dpif);
990     if (q) {
991         poll_immediate_wake();
992     } else {
993         /* No messages ready to be received, and dp_wait() will ensure that we
994          * wake up to queue new messages, so there is nothing to do. */
995     }
996 }
997 \f
998 static void
999 dp_netdev_flow_used(struct dp_netdev_flow *flow, const flow_t *key,
1000                     const struct ofpbuf *packet)
1001 {
1002     time_timespec(&flow->used);
1003     flow->packet_count++;
1004     flow->byte_count += packet->size;
1005     if (key->dl_type == htons(ETH_TYPE_IP) && key->nw_proto == IPPROTO_TCP) {
1006         struct tcp_header *th = packet->l4;
1007         flow->tcp_ctl |= th->tcp_ctl;
1008     }
1009 }
1010
1011 static void
1012 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1013                      struct ofpbuf *packet)
1014 {
1015     struct dp_netdev_flow *flow;
1016     flow_t key;
1017
1018     if (packet->size < ETH_HEADER_LEN) {
1019         return;
1020     }
1021     if (flow_extract(packet, 0, port->port_no, &key) && dp->drop_frags) {
1022         dp->n_frags++;
1023         return;
1024     }
1025
1026     flow = dp_netdev_lookup_flow(dp, &key);
1027     if (flow) {
1028         dp_netdev_flow_used(flow, &key, packet);
1029         dp_netdev_execute_actions(dp, packet, &key,
1030                                   flow->actions, flow->n_actions);
1031         dp->n_hit++;
1032     } else {
1033         dp->n_missed++;
1034         dp_netdev_output_control(dp, packet, _ODPL_MISS_NR, port->port_no, 0);
1035     }
1036 }
1037
1038 static void
1039 dp_netdev_run(void)
1040 {
1041     struct ofpbuf packet;
1042     struct dp_netdev *dp;
1043
1044     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + max_mtu);
1045     LIST_FOR_EACH (dp, node, &dp_netdev_list) {
1046         struct dp_netdev_port *port;
1047
1048         LIST_FOR_EACH (port, node, &dp->port_list) {
1049             int error;
1050
1051             /* Reset packet contents. */
1052             packet.data = (char*)packet.base + DP_NETDEV_HEADROOM;
1053             packet.size = 0;
1054
1055             error = netdev_recv(port->netdev, &packet);
1056             if (!error) {
1057                 dp_netdev_port_input(dp, port, &packet);
1058             } else if (error != EAGAIN) {
1059                 struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1060                 VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1061                             netdev_get_name(port->netdev), strerror(error));
1062             }
1063         }
1064     }
1065     ofpbuf_uninit(&packet);
1066 }
1067
1068 static void
1069 dp_netdev_wait(void)
1070 {
1071     struct dp_netdev *dp;
1072
1073     LIST_FOR_EACH (dp, node, &dp_netdev_list) {
1074         struct dp_netdev_port *port;
1075         LIST_FOR_EACH (port, node, &dp->port_list) {
1076             netdev_recv_wait(port->netdev);
1077         }
1078     }
1079 }
1080
1081
1082 /* Modify the TCI field of 'packet'.  If a VLAN tag is not present, one
1083  * is added with the TCI field set to 'tci'.  If a VLAN tag is present,
1084  * then 'mask' bits are cleared before 'tci' is logically OR'd into the
1085  * TCI field.
1086  *
1087  * Note that the function does not ensure that 'tci' does not affect
1088  * bits outside of 'mask'.
1089  */
1090 static void
1091 dp_netdev_modify_vlan_tci(struct ofpbuf *packet, uint16_t tci, uint16_t mask)
1092 {
1093     struct vlan_eth_header *veh;
1094     struct eth_header *eh;
1095
1096     eh = packet->l2;
1097     if (packet->size >= sizeof(struct vlan_eth_header)
1098         && eh->eth_type == htons(ETH_TYPE_VLAN)) {
1099         /* Clear 'mask' bits, but maintain other TCI bits. */
1100         veh = packet->l2;
1101         veh->veth_tci &= ~htons(mask);
1102         veh->veth_tci |= htons(tci);
1103     } else {
1104         /* Insert new 802.1Q header. */
1105         struct vlan_eth_header tmp;
1106         memcpy(tmp.veth_dst, eh->eth_dst, ETH_ADDR_LEN);
1107         memcpy(tmp.veth_src, eh->eth_src, ETH_ADDR_LEN);
1108         tmp.veth_type = htons(ETH_TYPE_VLAN);
1109         tmp.veth_tci = htons(tci);
1110         tmp.veth_next_type = eh->eth_type;
1111
1112         veh = ofpbuf_push_uninit(packet, VLAN_HEADER_LEN);
1113         memcpy(veh, &tmp, sizeof tmp);
1114         packet->l2 = (char*)packet->l2 - VLAN_HEADER_LEN;
1115     }
1116 }
1117
1118 static void
1119 dp_netdev_strip_vlan(struct ofpbuf *packet)
1120 {
1121     struct vlan_eth_header *veh = packet->l2;
1122     if (packet->size >= sizeof *veh
1123         && veh->veth_type == htons(ETH_TYPE_VLAN)) {
1124         struct eth_header tmp;
1125
1126         memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
1127         memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
1128         tmp.eth_type = veh->veth_next_type;
1129
1130         packet->size -= VLAN_HEADER_LEN;
1131         packet->data = (char*)packet->data + VLAN_HEADER_LEN;
1132         packet->l2 = (char*)packet->l2 + VLAN_HEADER_LEN;
1133         memcpy(packet->data, &tmp, sizeof tmp);
1134     }
1135 }
1136
1137 static void
1138 dp_netdev_set_dl_src(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1139 {
1140     struct eth_header *eh = packet->l2;
1141     memcpy(eh->eth_src, dl_addr, sizeof eh->eth_src);
1142 }
1143
1144 static void
1145 dp_netdev_set_dl_dst(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1146 {
1147     struct eth_header *eh = packet->l2;
1148     memcpy(eh->eth_dst, dl_addr, sizeof eh->eth_dst);
1149 }
1150
1151 static bool
1152 is_ip(const struct ofpbuf *packet, const flow_t *key)
1153 {
1154     return key->dl_type == htons(ETH_TYPE_IP) && packet->l4;
1155 }
1156
1157 static void
1158 dp_netdev_set_nw_addr(struct ofpbuf *packet, const flow_t *key,
1159                       const struct odp_action_nw_addr *a)
1160 {
1161     if (is_ip(packet, key)) {
1162         struct ip_header *nh = packet->l3;
1163         uint32_t *field;
1164
1165         field = a->type == ODPAT_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
1166         if (key->nw_proto == IP_TYPE_TCP && packet->l7) {
1167             struct tcp_header *th = packet->l4;
1168             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, a->nw_addr);
1169         } else if (key->nw_proto == IP_TYPE_UDP && packet->l7) {
1170             struct udp_header *uh = packet->l4;
1171             if (uh->udp_csum) {
1172                 uh->udp_csum = recalc_csum32(uh->udp_csum, *field, a->nw_addr);
1173                 if (!uh->udp_csum) {
1174                     uh->udp_csum = 0xffff;
1175                 }
1176             }
1177         }
1178         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, a->nw_addr);
1179         *field = a->nw_addr;
1180     }
1181 }
1182
1183 static void
1184 dp_netdev_set_nw_tos(struct ofpbuf *packet, const flow_t *key,
1185                      const struct odp_action_nw_tos *a)
1186 {
1187     if (is_ip(packet, key)) {
1188         struct ip_header *nh = packet->l3;
1189         uint8_t *field = &nh->ip_tos;
1190
1191         /* Set the DSCP bits and preserve the ECN bits. */
1192         uint8_t new = a->nw_tos | (nh->ip_tos & IP_ECN_MASK);
1193
1194         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t)*field),
1195                 htons((uint16_t)a->nw_tos));
1196         *field = new;
1197     }
1198 }
1199
1200 static void
1201 dp_netdev_set_tp_port(struct ofpbuf *packet, const flow_t *key,
1202                       const struct odp_action_tp_port *a)
1203 {
1204         if (is_ip(packet, key)) {
1205         uint16_t *field;
1206         if (key->nw_proto == IPPROTO_TCP && packet->l7) {
1207             struct tcp_header *th = packet->l4;
1208             field = a->type == ODPAT_SET_TP_SRC ? &th->tcp_src : &th->tcp_dst;
1209             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, a->tp_port);
1210             *field = a->tp_port;
1211         } else if (key->nw_proto == IPPROTO_UDP && packet->l7) {
1212             struct udp_header *uh = packet->l4;
1213             field = a->type == ODPAT_SET_TP_SRC ? &uh->udp_src : &uh->udp_dst;
1214             uh->udp_csum = recalc_csum16(uh->udp_csum, *field, a->tp_port);
1215             *field = a->tp_port;
1216         } else {
1217             return;
1218         }
1219     }
1220 }
1221
1222 static void
1223 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1224                       uint16_t out_port)
1225 {
1226     struct dp_netdev_port *p = dp->ports[out_port];
1227     if (p) {
1228         netdev_send(p->netdev, packet);
1229     }
1230 }
1231
1232 static void
1233 dp_netdev_output_group(struct dp_netdev *dp, uint16_t group, uint16_t in_port,
1234                        struct ofpbuf *packet)
1235 {
1236     struct odp_port_group *g = &dp->groups[group];
1237     int i;
1238
1239     for (i = 0; i < g->n_ports; i++) {
1240         uint16_t out_port = g->ports[i];
1241         if (out_port != in_port) {
1242             dp_netdev_output_port(dp, packet, out_port);
1243         }
1244     }
1245 }
1246
1247 static int
1248 dp_netdev_output_control(struct dp_netdev *dp, const struct ofpbuf *packet,
1249                          int queue_no, int port_no, uint32_t arg)
1250 {
1251     struct ovs_queue *q = &dp->queues[queue_no];
1252     struct odp_msg *header;
1253     struct ofpbuf *msg;
1254     size_t msg_size;
1255
1256     if (q->n >= MAX_QUEUE_LEN) {
1257         dp->n_lost++;
1258         return ENOBUFS;
1259     }
1260
1261     msg_size = sizeof *header + packet->size;
1262     msg = ofpbuf_new_with_headroom(msg_size, DPIF_RECV_MSG_PADDING);
1263     header = ofpbuf_put_uninit(msg, sizeof *header);
1264     header->type = queue_no;
1265     header->length = msg_size;
1266     header->port = port_no;
1267     header->arg = arg;
1268     ofpbuf_put(msg, packet->data, packet->size);
1269     queue_push_tail(q, msg);
1270
1271     return 0;
1272 }
1273
1274 /* Returns true if 'packet' is an invalid Ethernet+IPv4 ARP packet: one with
1275  * screwy or truncated header fields or one whose inner and outer Ethernet
1276  * address differ. */
1277 static bool
1278 dp_netdev_is_spoofed_arp(struct ofpbuf *packet, const struct odp_flow_key *key)
1279 {
1280     struct arp_eth_header *arp;
1281     struct eth_header *eth;
1282     ptrdiff_t l3_size;
1283
1284     if (key->dl_type != htons(ETH_TYPE_ARP)) {
1285         return false;
1286     }
1287
1288     l3_size = (char *) ofpbuf_end(packet) - (char *) packet->l3;
1289     if (l3_size < sizeof(struct arp_eth_header)) {
1290         return true;
1291     }
1292
1293     eth = packet->l2;
1294     arp = packet->l3;
1295     return (arp->ar_hrd != htons(ARP_HRD_ETHERNET)
1296             || arp->ar_pro != htons(ARP_PRO_IP)
1297             || arp->ar_hln != ETH_HEADER_LEN
1298             || arp->ar_pln != 4
1299             || !eth_addr_equals(arp->ar_sha, eth->eth_src));
1300 }
1301
1302 static int
1303 dp_netdev_execute_actions(struct dp_netdev *dp,
1304                           struct ofpbuf *packet, const flow_t *key,
1305                           const union odp_action *actions, int n_actions)
1306 {
1307     int i;
1308     for (i = 0; i < n_actions; i++) {
1309         const union odp_action *a = &actions[i];
1310
1311         switch (a->type) {
1312         case ODPAT_OUTPUT:
1313             dp_netdev_output_port(dp, packet, a->output.port);
1314             break;
1315
1316         case ODPAT_OUTPUT_GROUP:
1317             dp_netdev_output_group(dp, a->output_group.group, key->in_port,
1318                                    packet);
1319             break;
1320
1321         case ODPAT_CONTROLLER:
1322             dp_netdev_output_control(dp, packet, _ODPL_ACTION_NR,
1323                                      key->in_port, a->controller.arg);
1324             break;
1325
1326         case ODPAT_SET_VLAN_VID:
1327             dp_netdev_modify_vlan_tci(packet, ntohs(a->vlan_vid.vlan_vid),
1328                                       VLAN_VID_MASK);
1329             break;
1330
1331         case ODPAT_SET_VLAN_PCP:
1332             dp_netdev_modify_vlan_tci(packet,
1333                                       a->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT,
1334                                       VLAN_PCP_MASK);
1335             break;
1336
1337         case ODPAT_STRIP_VLAN:
1338             dp_netdev_strip_vlan(packet);
1339             break;
1340
1341         case ODPAT_SET_DL_SRC:
1342             dp_netdev_set_dl_src(packet, a->dl_addr.dl_addr);
1343             break;
1344
1345         case ODPAT_SET_DL_DST:
1346             dp_netdev_set_dl_dst(packet, a->dl_addr.dl_addr);
1347             break;
1348
1349         case ODPAT_SET_NW_SRC:
1350         case ODPAT_SET_NW_DST:
1351             dp_netdev_set_nw_addr(packet, key, &a->nw_addr);
1352             break;
1353
1354         case ODPAT_SET_NW_TOS:
1355             dp_netdev_set_nw_tos(packet, key, &a->nw_tos);
1356             break;
1357
1358         case ODPAT_SET_TP_SRC:
1359         case ODPAT_SET_TP_DST:
1360             dp_netdev_set_tp_port(packet, key, &a->tp_port);
1361             break;
1362
1363         case ODPAT_DROP_SPOOFED_ARP:
1364             if (dp_netdev_is_spoofed_arp(packet, key)) {
1365                 return 0;
1366             }
1367         }
1368     }
1369     return 0;
1370 }
1371
1372 const struct dpif_class dpif_netdev_class = {
1373     "netdev",
1374     dp_netdev_run,
1375     dp_netdev_wait,
1376     NULL,                       /* enumerate */
1377     dpif_netdev_open,
1378     dpif_netdev_close,
1379     NULL,                       /* get_all_names */
1380     dpif_netdev_destroy,
1381     dpif_netdev_get_stats,
1382     dpif_netdev_get_drop_frags,
1383     dpif_netdev_set_drop_frags,
1384     dpif_netdev_port_add,
1385     dpif_netdev_port_del,
1386     dpif_netdev_port_query_by_number,
1387     dpif_netdev_port_query_by_name,
1388     dpif_netdev_port_list,
1389     dpif_netdev_port_poll,
1390     dpif_netdev_port_poll_wait,
1391     dpif_netdev_port_group_get,
1392     dpif_netdev_port_group_set,
1393     dpif_netdev_flow_get,
1394     dpif_netdev_flow_put,
1395     dpif_netdev_flow_del,
1396     dpif_netdev_flow_flush,
1397     dpif_netdev_flow_list,
1398     dpif_netdev_execute,
1399     dpif_netdev_recv_get_mask,
1400     dpif_netdev_recv_set_mask,
1401     NULL,                       /* get_sflow_probability */
1402     NULL,                       /* set_sflow_probability */
1403     NULL,                       /* queue_to_priority */
1404     dpif_netdev_recv,
1405     dpif_netdev_recv_wait,
1406 };