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