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