ovsdb-idl: Improve check in ovsdb_idl_row_is_orphan().
[openvswitch] / lib / dpif-netdev.c
1 /*
2  * Copyright (c) 2009, 2010 Nicira Networks.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include <config.h>
18 #include "dpif.h"
19
20 #include <assert.h>
21 #include <ctype.h>
22 #include <errno.h>
23 #include <fcntl.h>
24 #include <inttypes.h>
25 #include <netinet/in.h>
26 #include <net/if.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sys/ioctl.h>
30 #include <sys/stat.h>
31 #include <unistd.h>
32
33 #include "csum.h"
34 #include "dpif-provider.h"
35 #include "flow.h"
36 #include "hmap.h"
37 #include "list.h"
38 #include "netdev.h"
39 #include "odp-util.h"
40 #include "ofp-print.h"
41 #include "ofpbuf.h"
42 #include "packets.h"
43 #include "poll-loop.h"
44 #include "queue.h"
45 #include "timeval.h"
46 #include "util.h"
47
48 #include "vlog.h"
49 #define THIS_MODULE VLM_dpif_netdev
50
51 /* Configuration parameters. */
52 enum { N_QUEUES = 2 };          /* Number of queues for dpif_recv(). */
53 enum { MAX_QUEUE_LEN = 100 };   /* Maximum number of packets per queue. */
54 enum { N_GROUPS = 16 };         /* Number of port groups. */
55 enum { MAX_PORTS = 256 };       /* Maximum number of ports. */
56 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
57
58 /* Enough headroom to add a vlan tag, plus an extra 2 bytes to allow IP
59  * headers to be aligned on a 4-byte boundary.  */
60 enum { DP_NETDEV_HEADROOM = 2 + VLAN_HEADER_LEN };
61
62 /* Datapath based on the network device interface from netdev.h. */
63 struct dp_netdev {
64     struct list node;
65     int dp_idx;
66     int open_cnt;
67     bool destroyed;
68
69     bool drop_frags;            /* Drop all IP fragments, if true. */
70     struct ovs_queue queues[N_QUEUES]; /* Messages queued for dpif_recv(). */
71     struct hmap flow_table;     /* Flow table. */
72     struct odp_port_group groups[N_GROUPS];
73
74     /* Statistics. */
75     long long int n_frags;      /* Number of dropped IP fragments. */
76     long long int n_hit;        /* Number of flow table matches. */
77     long long int n_missed;     /* Number of flow table misses. */
78     long long int n_lost;       /* Number of misses not passed to client. */
79
80     /* Ports. */
81     int n_ports;
82     struct dp_netdev_port *ports[MAX_PORTS];
83     struct list port_list;
84     unsigned int serial;
85 };
86
87 /* A port in a netdev-based datapath. */
88 struct dp_netdev_port {
89     int port_no;                /* Index into dp_netdev's 'ports'. */
90     struct list node;           /* Element in dp_netdev's 'port_list'. */
91     struct netdev *netdev;
92     bool internal;              /* Internal port (as ODP_PORT_INTERNAL)? */
93 };
94
95 /* A flow in dp_netdev's 'flow_table'. */
96 struct dp_netdev_flow {
97     struct hmap_node node;      /* Element in dp_netdev's 'flow_table'. */
98     flow_t key;
99
100     /* Statistics. */
101         struct timeval used;        /* Last used time, in milliseconds. */
102         long long int packet_count; /* Number of packets matched. */
103         long long int byte_count;   /* Number of bytes matched. */
104         uint8_t ip_tos;             /* IP TOS value. */
105         uint16_t tcp_ctl;           /* Bitwise-OR of seen tcp_ctl values. */
106
107     /* Actions. */
108     union odp_action *actions;
109     unsigned int n_actions;
110 };
111
112 /* Interface to netdev-based datapath. */
113 struct dpif_netdev {
114     struct dpif dpif;
115     struct dp_netdev *dp;
116     int listen_mask;
117     unsigned int dp_serial;
118 };
119
120 /* All netdev-based datapaths. */
121 static struct dp_netdev *dp_netdevs[256];
122 struct list dp_netdev_list = LIST_INITIALIZER(&dp_netdev_list);
123 enum { N_DP_NETDEVS = ARRAY_SIZE(dp_netdevs) };
124
125 /* Maximum port MTU seen so far. */
126 static int max_mtu = ETH_PAYLOAD_MAX;
127
128 static int get_port_by_number(struct dp_netdev *, uint16_t port_no,
129                               struct dp_netdev_port **portp);
130 static int get_port_by_name(struct dp_netdev *, const char *devname,
131                             struct dp_netdev_port **portp);
132 static void dp_netdev_free(struct dp_netdev *);
133 static void dp_netdev_flow_flush(struct dp_netdev *);
134 static int do_add_port(struct dp_netdev *, const char *devname, uint16_t flags,
135                        uint16_t port_no);
136 static int do_del_port(struct dp_netdev *, uint16_t port_no);
137 static int dp_netdev_output_control(struct dp_netdev *, const struct ofpbuf *,
138                                     int queue_no, int port_no, uint32_t arg);
139 static int dp_netdev_execute_actions(struct dp_netdev *,
140                                      struct ofpbuf *, flow_t *,
141                                      const union odp_action *, int n);
142
143 static struct dpif_netdev *
144 dpif_netdev_cast(const struct dpif *dpif)
145 {
146     dpif_assert_class(dpif, &dpif_netdev_class);
147     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
148 }
149
150 static struct dp_netdev *
151 get_dp_netdev(const struct dpif *dpif)
152 {
153     return dpif_netdev_cast(dpif)->dp;
154 }
155
156 static int
157 name_to_dp_idx(const char *name)
158 {
159     if (!strncmp(name, "dp", 2) && isdigit((unsigned char)name[2])) {
160         int dp_idx = atoi(name + 2);
161         if (dp_idx >= 0 && dp_idx < N_DP_NETDEVS) {
162             return dp_idx;
163         }
164     }
165     return -1;
166 }
167
168 static struct dp_netdev *
169 find_dp_netdev(const char *name)
170 {
171     int dp_idx;
172     size_t i;
173
174     dp_idx = name_to_dp_idx(name);
175     if (dp_idx >= 0) {
176         return dp_netdevs[dp_idx];
177     }
178
179     for (i = 0; i < N_DP_NETDEVS; i++) {
180         struct dp_netdev *dp = dp_netdevs[i];
181         if (dp) {
182             struct dp_netdev_port *port;
183             if (!get_port_by_name(dp, name, &port)) {
184                 return dp;
185             }
186         }
187     }
188     return NULL;
189 }
190
191 static struct dpif *
192 create_dpif_netdev(struct dp_netdev *dp)
193 {
194     struct dpif_netdev *dpif;
195     char *dpname;
196
197     dp->open_cnt++;
198
199     dpname = xasprintf("dp%d", dp->dp_idx);
200     dpif = xmalloc(sizeof *dpif);
201     dpif_init(&dpif->dpif, &dpif_netdev_class, dpname, dp->dp_idx, dp->dp_idx);
202     dpif->dp = dp;
203     dpif->listen_mask = 0;
204     dpif->dp_serial = dp->serial;
205     free(dpname);
206
207     return &dpif->dpif;
208 }
209
210 static int
211 create_dp_netdev(const char *name, int dp_idx, struct dpif **dpifp)
212 {
213     struct dp_netdev *dp;
214     int error;
215     int i;
216
217     if (dp_netdevs[dp_idx]) {
218         return EBUSY;
219     }
220
221     /* Create datapath. */
222     dp_netdevs[dp_idx] = dp = xzalloc(sizeof *dp);
223     list_push_back(&dp_netdev_list, &dp->node);
224     dp->dp_idx = dp_idx;
225     dp->open_cnt = 0;
226     dp->drop_frags = false;
227     for (i = 0; i < N_QUEUES; i++) {
228         queue_init(&dp->queues[i]);
229     }
230     hmap_init(&dp->flow_table);
231     for (i = 0; i < N_GROUPS; i++) {
232         dp->groups[i].ports = NULL;
233         dp->groups[i].n_ports = 0;
234         dp->groups[i].group = i;
235     }
236     list_init(&dp->port_list);
237     error = do_add_port(dp, name, ODP_PORT_INTERNAL, ODPP_LOCAL);
238     if (error) {
239         dp_netdev_free(dp);
240         return ENODEV;
241     }
242
243     *dpifp = create_dpif_netdev(dp);
244     return 0;
245 }
246
247 static int
248 dpif_netdev_open(const char *name, const char *type OVS_UNUSED, bool create,
249                  struct dpif **dpifp)
250 {
251     if (create) {
252         if (find_dp_netdev(name)) {
253             return EEXIST;
254         } else {
255             int dp_idx = name_to_dp_idx(name);
256             if (dp_idx >= 0) {
257                 return create_dp_netdev(name, dp_idx, dpifp);
258             } else {
259                 /* Scan for unused dp_idx number. */
260                 for (dp_idx = 0; dp_idx < N_DP_NETDEVS; dp_idx++) {
261                     int error = create_dp_netdev(name, dp_idx, dpifp);
262                     if (error != EBUSY) {
263                         return error;
264                     }
265                 }
266
267                 /* All datapath numbers in use. */
268                 return ENOBUFS;
269             }
270         }
271     } else {
272         struct dp_netdev *dp = find_dp_netdev(name);
273         if (dp) {
274             *dpifp = create_dpif_netdev(dp);
275             return 0;
276         } else {
277             return ENODEV;
278         }
279     }
280 }
281
282 static void
283 dp_netdev_free(struct dp_netdev *dp)
284 {
285     int i;
286
287     dp_netdev_flow_flush(dp);
288     while (dp->n_ports > 0) {
289         struct dp_netdev_port *port = CONTAINER_OF(
290             dp->port_list.next, struct dp_netdev_port, node);
291         do_del_port(dp, port->port_no);
292     }
293     for (i = 0; i < N_QUEUES; i++) {
294         queue_destroy(&dp->queues[i]);
295     }
296     hmap_destroy(&dp->flow_table);
297     for (i = 0; i < N_GROUPS; i++) {
298         free(dp->groups[i].ports);
299     }
300     dp_netdevs[dp->dp_idx] = NULL;
301     list_remove(&dp->node);
302     free(dp);
303 }
304
305 static void
306 dpif_netdev_close(struct dpif *dpif)
307 {
308     struct dp_netdev *dp = get_dp_netdev(dpif);
309     assert(dp->open_cnt > 0);
310     if (--dp->open_cnt == 0 && dp->destroyed) {
311         dp_netdev_free(dp);
312     }
313     free(dpif);
314 }
315
316 static int
317 dpif_netdev_destroy(struct dpif *dpif)
318 {
319     struct dp_netdev *dp = get_dp_netdev(dpif);
320     dp->destroyed = true;
321     return 0;
322 }
323
324 static int
325 dpif_netdev_get_stats(const struct dpif *dpif, struct odp_stats *stats)
326 {
327     struct dp_netdev *dp = get_dp_netdev(dpif);
328     memset(stats, 0, sizeof *stats);
329     stats->n_flows = hmap_count(&dp->flow_table);
330     stats->cur_capacity = hmap_capacity(&dp->flow_table);
331     stats->max_capacity = MAX_FLOWS;
332     stats->n_ports = dp->n_ports;
333     stats->max_ports = MAX_PORTS;
334     stats->max_groups = N_GROUPS;
335     stats->n_frags = dp->n_frags;
336     stats->n_hit = dp->n_hit;
337     stats->n_missed = dp->n_missed;
338     stats->n_lost = dp->n_lost;
339     stats->max_miss_queue = MAX_QUEUE_LEN;
340     stats->max_action_queue = MAX_QUEUE_LEN;
341     return 0;
342 }
343
344 static int
345 dpif_netdev_get_drop_frags(const struct dpif *dpif, bool *drop_fragsp)
346 {
347     struct dp_netdev *dp = get_dp_netdev(dpif);
348     *drop_fragsp = dp->drop_frags;
349     return 0;
350 }
351
352 static int
353 dpif_netdev_set_drop_frags(struct dpif *dpif, bool drop_frags)
354 {
355     struct dp_netdev *dp = get_dp_netdev(dpif);
356     dp->drop_frags = drop_frags;
357     return 0;
358 }
359
360 static int
361 do_add_port(struct dp_netdev *dp, const char *devname, uint16_t flags,
362             uint16_t port_no)
363 {
364     bool internal = (flags & ODP_PORT_INTERNAL) != 0;
365     struct dp_netdev_port *port;
366     struct netdev_options netdev_options;
367     struct netdev *netdev;
368     int mtu;
369     int error;
370
371     /* XXX reject devices already in some dp_netdev. */
372
373     /* Open and validate network device. */
374     memset(&netdev_options, 0, sizeof netdev_options);
375     netdev_options.name = devname;
376     netdev_options.ethertype = NETDEV_ETH_TYPE_ANY;
377     netdev_options.may_create = true;
378     if (internal) {
379         netdev_options.type = "tap";
380     } else {
381         netdev_options.may_open = true;
382     }
383
384     error = netdev_open(&netdev_options, &netdev);
385     if (error) {
386         return error;
387     }
388     /* XXX reject loopback devices */
389     /* XXX reject non-Ethernet devices */
390
391     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, false);
392     if (error) {
393         netdev_close(netdev);
394         return error;
395     }
396
397     port = xmalloc(sizeof *port);
398     port->port_no = port_no;
399     port->netdev = netdev;
400     port->internal = internal;
401
402     netdev_get_mtu(netdev, &mtu);
403     if (mtu > max_mtu) {
404         max_mtu = mtu;
405     }
406
407     list_push_back(&dp->port_list, &port->node);
408     dp->ports[port_no] = port;
409     dp->n_ports++;
410     dp->serial++;
411
412     return 0;
413 }
414
415 static int
416 dpif_netdev_port_add(struct dpif *dpif, const char *devname, uint16_t flags,
417                      uint16_t *port_nop)
418 {
419     struct dp_netdev *dp = get_dp_netdev(dpif);
420     int port_no;
421
422     for (port_no = 0; port_no < MAX_PORTS; port_no++) {
423         if (!dp->ports[port_no]) {
424             *port_nop = port_no;
425             return do_add_port(dp, devname, flags, port_no);
426         }
427     }
428     return EFBIG;
429 }
430
431 static int
432 dpif_netdev_port_del(struct dpif *dpif, uint16_t port_no)
433 {
434     struct dp_netdev *dp = get_dp_netdev(dpif);
435     return port_no == ODPP_LOCAL ? EINVAL : do_del_port(dp, port_no);
436 }
437
438 static bool
439 is_valid_port_number(uint16_t port_no)
440 {
441     return port_no < MAX_PORTS;
442 }
443
444 static int
445 get_port_by_number(struct dp_netdev *dp,
446                    uint16_t port_no, struct dp_netdev_port **portp)
447 {
448     if (!is_valid_port_number(port_no)) {
449         *portp = NULL;
450         return EINVAL;
451     } else {
452         *portp = dp->ports[port_no];
453         return *portp ? 0 : ENOENT;
454     }
455 }
456
457 static int
458 get_port_by_name(struct dp_netdev *dp,
459                  const char *devname, struct dp_netdev_port **portp)
460 {
461     struct dp_netdev_port *port;
462
463     LIST_FOR_EACH (port, struct dp_netdev_port, node, &dp->port_list) {
464         if (!strcmp(netdev_get_name(port->netdev), devname)) {
465             *portp = port;
466             return 0;
467         }
468     }
469     return ENOENT;
470 }
471
472 static int
473 do_del_port(struct dp_netdev *dp, uint16_t port_no)
474 {
475     struct dp_netdev_port *port;
476     char *name;
477     int error;
478
479     error = get_port_by_number(dp, port_no, &port);
480     if (error) {
481         return error;
482     }
483
484     list_remove(&port->node);
485     dp->ports[port->port_no] = NULL;
486     dp->n_ports--;
487     dp->serial++;
488
489     name = xstrdup(netdev_get_name(port->netdev));
490     netdev_close(port->netdev);
491
492     free(name);
493     free(port);
494
495     return 0;
496 }
497
498 static void
499 answer_port_query(const struct dp_netdev_port *port, struct odp_port *odp_port)
500 {
501     memset(odp_port, 0, sizeof *odp_port);
502     ovs_strlcpy(odp_port->devname, netdev_get_name(port->netdev),
503                 sizeof odp_port->devname);
504     odp_port->port = port->port_no;
505     odp_port->flags = port->internal ? ODP_PORT_INTERNAL : 0;
506 }
507
508 static int
509 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
510                                  struct odp_port *odp_port)
511 {
512     struct dp_netdev *dp = get_dp_netdev(dpif);
513     struct dp_netdev_port *port;
514     int error;
515
516     error = get_port_by_number(dp, port_no, &port);
517     if (!error) {
518         answer_port_query(port, odp_port);
519     }
520     return error;
521 }
522
523 static int
524 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
525                                struct odp_port *odp_port)
526 {
527     struct dp_netdev *dp = get_dp_netdev(dpif);
528     struct dp_netdev_port *port;
529     int error;
530
531     error = get_port_by_name(dp, devname, &port);
532     if (!error) {
533         answer_port_query(port, odp_port);
534     }
535     return error;
536 }
537
538 static void
539 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
540 {
541     hmap_remove(&dp->flow_table, &flow->node);
542     free(flow->actions);
543     free(flow);
544 }
545
546 static void
547 dp_netdev_flow_flush(struct dp_netdev *dp)
548 {
549     struct dp_netdev_flow *flow, *next;
550
551     HMAP_FOR_EACH_SAFE (flow, next, struct dp_netdev_flow, node,
552                         &dp->flow_table) {
553         dp_netdev_free_flow(dp, flow);
554     }
555 }
556
557 static int
558 dpif_netdev_flow_flush(struct dpif *dpif)
559 {
560     struct dp_netdev *dp = get_dp_netdev(dpif);
561     dp_netdev_flow_flush(dp);
562     return 0;
563 }
564
565 static int
566 dpif_netdev_port_list(const struct dpif *dpif, struct odp_port *ports, int n)
567 {
568     struct dp_netdev *dp = get_dp_netdev(dpif);
569     struct dp_netdev_port *port;
570     int i;
571
572     i = 0;
573     LIST_FOR_EACH (port, struct dp_netdev_port, node, &dp->port_list) {
574         struct odp_port *odp_port = &ports[i];
575         if (i >= n) {
576             break;
577         }
578         answer_port_query(port, odp_port);
579         i++;
580     }
581     return dp->n_ports;
582 }
583
584 static int
585 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
586 {
587     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
588     if (dpif->dp_serial != dpif->dp->serial) {
589         dpif->dp_serial = dpif->dp->serial;
590         return ENOBUFS;
591     } else {
592         return EAGAIN;
593     }
594 }
595
596 static void
597 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
598 {
599     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
600     if (dpif->dp_serial != dpif->dp->serial) {
601         poll_immediate_wake();
602     }
603 }
604
605 static int
606 get_port_group(const struct dpif *dpif, int group_no,
607                struct odp_port_group **groupp)
608 {
609     struct dp_netdev *dp = get_dp_netdev(dpif);
610
611     if (group_no >= 0 && group_no < N_GROUPS) {
612         *groupp = &dp->groups[group_no];
613         return 0;
614     } else {
615         *groupp = NULL;
616         return EINVAL;
617     }
618 }
619
620 static int
621 dpif_netdev_port_group_get(const struct dpif *dpif, int group_no,
622                            uint16_t ports[], int n)
623 {
624     struct odp_port_group *group;
625     int error;
626
627     if (n < 0) {
628         return -EINVAL;
629     }
630
631     error = get_port_group(dpif, group_no, &group);
632     if (!error) {
633         memcpy(ports, group->ports, MIN(n, group->n_ports) * sizeof *ports);
634         return group->n_ports;
635     } else {
636         return -error;
637     }
638 }
639
640 static int
641 dpif_netdev_port_group_set(struct dpif *dpif, int group_no,
642                            const uint16_t ports[], int n)
643 {
644     struct odp_port_group *group;
645     int error;
646
647     if (n < 0 || n > MAX_PORTS) {
648         return EINVAL;
649     }
650
651     error = get_port_group(dpif, group_no, &group);
652     if (!error) {
653         free(group->ports);
654         group->ports = xmemdup(ports, n * sizeof *group->ports);
655         group->n_ports = n;
656         group->group = group_no;
657     }
658     return error;
659 }
660
661 static struct dp_netdev_flow *
662 dp_netdev_lookup_flow(const struct dp_netdev *dp, const flow_t *key)
663 {
664     struct dp_netdev_flow *flow;
665
666     assert(!key->reserved[0] && !key->reserved[1] && !key->reserved[2]);
667     HMAP_FOR_EACH_WITH_HASH (flow, struct dp_netdev_flow, node,
668                              flow_hash(key, 0), &dp->flow_table) {
669         if (flow_equal(&flow->key, key)) {
670             return flow;
671         }
672     }
673     return NULL;
674 }
675
676 static void
677 answer_flow_query(struct dp_netdev_flow *flow, uint32_t query_flags,
678                   struct odp_flow *odp_flow)
679 {
680     if (flow) {
681         odp_flow->key = flow->key;
682         odp_flow->stats.n_packets = flow->packet_count;
683         odp_flow->stats.n_bytes = flow->byte_count;
684         odp_flow->stats.used_sec = flow->used.tv_sec;
685         odp_flow->stats.used_nsec = flow->used.tv_usec * 1000;
686         odp_flow->stats.tcp_flags = TCP_FLAGS(flow->tcp_ctl);
687         odp_flow->stats.ip_tos = flow->ip_tos;
688         odp_flow->stats.error = 0;
689         if (odp_flow->n_actions > 0) {
690             unsigned int n = MIN(odp_flow->n_actions, flow->n_actions);
691             memcpy(odp_flow->actions, flow->actions,
692                    n * sizeof *odp_flow->actions);
693             odp_flow->n_actions = flow->n_actions;
694         }
695
696         if (query_flags & ODPFF_ZERO_TCP_FLAGS) {
697             flow->tcp_ctl = 0;
698         }
699
700     } else {
701         odp_flow->stats.error = ENOENT;
702     }
703 }
704
705 static int
706 dpif_netdev_flow_get(const struct dpif *dpif, struct odp_flow flows[], int n)
707 {
708     struct dp_netdev *dp = get_dp_netdev(dpif);
709     int i;
710
711     for (i = 0; i < n; i++) {
712         struct odp_flow *odp_flow = &flows[i];
713         answer_flow_query(dp_netdev_lookup_flow(dp, &odp_flow->key),
714                           odp_flow->flags, odp_flow);
715     }
716     return 0;
717 }
718
719 static int
720 dpif_netdev_validate_actions(const union odp_action *actions, int n_actions,
721                              bool *mutates)
722 {
723         unsigned int i;
724
725     *mutates = false;
726         for (i = 0; i < n_actions; i++) {
727                 const union odp_action *a = &actions[i];
728                 switch (a->type) {
729                 case ODPAT_OUTPUT:
730                         if (a->output.port >= MAX_PORTS) {
731                                 return EINVAL;
732             }
733                         break;
734
735                 case ODPAT_OUTPUT_GROUP:
736             *mutates = true;
737                         if (a->output_group.group >= N_GROUPS) {
738                                 return EINVAL;
739             }
740                         break;
741
742         case ODPAT_CONTROLLER:
743             break;
744
745                 case ODPAT_SET_VLAN_VID:
746             *mutates = true;
747                         if (a->vlan_vid.vlan_vid & htons(~VLAN_VID_MASK)) {
748                                 return EINVAL;
749             }
750                         break;
751
752                 case ODPAT_SET_VLAN_PCP:
753             *mutates = true;
754                         if (a->vlan_pcp.vlan_pcp & ~(VLAN_PCP_MASK >> VLAN_PCP_SHIFT)) {
755                                 return EINVAL;
756             }
757                         break;
758
759         case ODPAT_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 = xzalloc(sizeof *flow);
808     flow->key = odp_flow->key;
809     memset(flow->key.reserved, 0, sizeof flow->key.reserved);
810
811     error = set_flow_actions(flow, odp_flow);
812     if (error) {
813         free(flow);
814         return error;
815     }
816
817     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
818     return 0;
819 }
820
821 static void
822 clear_stats(struct dp_netdev_flow *flow)
823 {
824     flow->used.tv_sec = 0;
825     flow->used.tv_usec = 0;
826     flow->packet_count = 0;
827     flow->byte_count = 0;
828     flow->ip_tos = 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, struct dp_netdev_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, 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_timeval(&flow->used);
1003     flow->packet_count++;
1004     flow->byte_count += packet->size;
1005     if (key->dl_type == htons(ETH_TYPE_IP)) {
1006         struct ip_header *nh = packet->l3;
1007         flow->ip_tos = nh->ip_tos;
1008
1009         if (key->nw_proto == IPPROTO_TCP) {
1010             struct tcp_header *th = packet->l4;
1011             flow->tcp_ctl |= th->tcp_ctl;
1012         }
1013     }
1014 }
1015
1016 static void
1017 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1018                      struct ofpbuf *packet)
1019 {
1020     struct dp_netdev_flow *flow;
1021     flow_t key;
1022
1023     if (flow_extract(packet, 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, flow_t *key,
1094                           uint16_t tci, uint16_t mask)
1095 {
1096     struct vlan_eth_header *veh;
1097
1098     if (key->dl_vlan != htons(ODP_VLAN_NONE)) {
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 eth_header *eh = packet->l2;
1106         struct vlan_eth_header tmp;
1107         memcpy(tmp.veth_dst, eh->eth_dst, ETH_ADDR_LEN);
1108         memcpy(tmp.veth_src, eh->eth_src, ETH_ADDR_LEN);
1109         tmp.veth_type = htons(ETH_TYPE_VLAN);
1110         tmp.veth_tci = htons(tci);
1111         tmp.veth_next_type = eh->eth_type;
1112
1113         veh = ofpbuf_push_uninit(packet, VLAN_HEADER_LEN);
1114         memcpy(veh, &tmp, sizeof tmp);
1115         packet->l2 = (char*)packet->l2 - VLAN_HEADER_LEN;
1116     }
1117
1118     key->dl_vlan = veh->veth_tci & htons(VLAN_VID_MASK);
1119 }
1120
1121 static void
1122 dp_netdev_strip_vlan(struct ofpbuf *packet, flow_t *key)
1123 {
1124     struct vlan_eth_header *veh = packet->l2;
1125     if (veh->veth_type == htons(ETH_TYPE_VLAN)) {
1126         struct eth_header tmp;
1127
1128         memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
1129         memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
1130         tmp.eth_type = veh->veth_next_type;
1131
1132         packet->size -= VLAN_HEADER_LEN;
1133         packet->data = (char*)packet->data + VLAN_HEADER_LEN;
1134         packet->l2 = (char*)packet->l2 + VLAN_HEADER_LEN;
1135         memcpy(packet->data, &tmp, sizeof tmp);
1136
1137         key->dl_vlan = htons(ODP_VLAN_NONE);
1138     }
1139 }
1140
1141 static void
1142 dp_netdev_set_dl_src(struct ofpbuf *packet,
1143                      const uint8_t dl_addr[ETH_ADDR_LEN])
1144 {
1145     struct eth_header *eh = packet->l2;
1146     memcpy(eh->eth_src, dl_addr, sizeof eh->eth_src);
1147 }
1148
1149 static void
1150 dp_netdev_set_dl_dst(struct ofpbuf *packet,
1151                      const uint8_t dl_addr[ETH_ADDR_LEN])
1152 {
1153     struct eth_header *eh = packet->l2;
1154     memcpy(eh->eth_dst, dl_addr, sizeof eh->eth_dst);
1155 }
1156
1157 static void
1158 dp_netdev_set_nw_addr(struct ofpbuf *packet, flow_t *key,
1159                       const struct odp_action_nw_addr *a)
1160 {
1161     if (key->dl_type == htons(ETH_TYPE_IP)) {
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) {
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) {
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, flow_t *key,
1185                      const struct odp_action_nw_tos *a)
1186 {
1187     if (key->dl_type == htons(ETH_TYPE_IP)) {
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 & IP_DSCP_MASK) | (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, flow_t *key,
1202                       const struct odp_action_tp_port *a)
1203 {
1204         if (key->dl_type == htons(ETH_TYPE_IP)) {
1205         uint16_t *field;
1206         if (key->nw_proto == IPPROTO_TCP) {
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) {
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         }
1217     }
1218 }
1219
1220 static void
1221 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1222                       uint16_t out_port)
1223 {
1224         struct dp_netdev_port *p = dp->ports[out_port];
1225     if (p) {
1226         netdev_send(p->netdev, packet);
1227     }
1228 }
1229
1230 static void
1231 dp_netdev_output_group(struct dp_netdev *dp, uint16_t group, uint16_t in_port,
1232                        struct ofpbuf *packet)
1233 {
1234         struct odp_port_group *g = &dp->groups[group];
1235         int i;
1236
1237         for (i = 0; i < g->n_ports; i++) {
1238         uint16_t out_port = g->ports[i];
1239         if (out_port != in_port) {
1240             dp_netdev_output_port(dp, packet, out_port);
1241         }
1242         }
1243 }
1244
1245 static int
1246 dp_netdev_output_control(struct dp_netdev *dp, const struct ofpbuf *packet,
1247                          int queue_no, int port_no, uint32_t arg)
1248 {
1249     struct ovs_queue *q = &dp->queues[queue_no];
1250     struct odp_msg *header;
1251     struct ofpbuf *msg;
1252     size_t msg_size;
1253
1254     if (q->n >= MAX_QUEUE_LEN) {
1255         dp->n_lost++;
1256         return ENOBUFS;
1257     }
1258
1259     msg_size = sizeof *header + packet->size;
1260     msg = ofpbuf_new(msg_size);
1261     header = ofpbuf_put_uninit(msg, sizeof *header);
1262     header->type = queue_no;
1263     header->length = msg_size;
1264     header->port = port_no;
1265     header->arg = arg;
1266     ofpbuf_put(msg, packet->data, packet->size);
1267     queue_push_tail(q, msg);
1268
1269     return 0;
1270 }
1271
1272 static int
1273 dp_netdev_execute_actions(struct dp_netdev *dp,
1274                           struct ofpbuf *packet, flow_t *key,
1275                           const union odp_action *actions, int n_actions)
1276 {
1277     int i;
1278     for (i = 0; i < n_actions; i++) {
1279         const union odp_action *a = &actions[i];
1280
1281                 switch (a->type) {
1282                 case ODPAT_OUTPUT:
1283             dp_netdev_output_port(dp, packet, a->output.port);
1284                         break;
1285
1286                 case ODPAT_OUTPUT_GROUP:
1287                         dp_netdev_output_group(dp, a->output_group.group, key->in_port,
1288                                    packet);
1289                         break;
1290
1291                 case ODPAT_CONTROLLER:
1292             dp_netdev_output_control(dp, packet, _ODPL_ACTION_NR,
1293                                      key->in_port, a->controller.arg);
1294                         break;
1295
1296                 case ODPAT_SET_VLAN_VID:
1297                         dp_netdev_modify_vlan_tci(packet, key, ntohs(a->vlan_vid.vlan_vid),
1298                                       VLAN_VID_MASK);
1299             break;
1300
1301                 case ODPAT_SET_VLAN_PCP:
1302                         dp_netdev_modify_vlan_tci(
1303                 packet, key, a->vlan_pcp.vlan_pcp << VLAN_PCP_SHIFT,
1304                 VLAN_PCP_MASK);
1305             break;
1306
1307                 case ODPAT_STRIP_VLAN:
1308                         dp_netdev_strip_vlan(packet, key);
1309                         break;
1310
1311                 case ODPAT_SET_DL_SRC:
1312             dp_netdev_set_dl_src(packet, a->dl_addr.dl_addr);
1313                         break;
1314
1315                 case ODPAT_SET_DL_DST:
1316             dp_netdev_set_dl_dst(packet, a->dl_addr.dl_addr);
1317                         break;
1318
1319                 case ODPAT_SET_NW_SRC:
1320                 case ODPAT_SET_NW_DST:
1321                         dp_netdev_set_nw_addr(packet, key, &a->nw_addr);
1322                         break;
1323
1324                 case ODPAT_SET_NW_TOS:
1325                         dp_netdev_set_nw_tos(packet, key, &a->nw_tos);
1326                         break;
1327
1328                 case ODPAT_SET_TP_SRC:
1329                 case ODPAT_SET_TP_DST:
1330                         dp_netdev_set_tp_port(packet, key, &a->tp_port);
1331                         break;
1332                 }
1333         }
1334     return 0;
1335 }
1336
1337 const struct dpif_class dpif_netdev_class = {
1338     "netdev",
1339     dp_netdev_run,
1340     dp_netdev_wait,
1341     NULL,                       /* enumerate */
1342     dpif_netdev_open,
1343     dpif_netdev_close,
1344     NULL,                       /* get_all_names */
1345     dpif_netdev_destroy,
1346     dpif_netdev_get_stats,
1347     dpif_netdev_get_drop_frags,
1348     dpif_netdev_set_drop_frags,
1349     dpif_netdev_port_add,
1350     dpif_netdev_port_del,
1351     dpif_netdev_port_query_by_number,
1352     dpif_netdev_port_query_by_name,
1353     dpif_netdev_port_list,
1354     dpif_netdev_port_poll,
1355     dpif_netdev_port_poll_wait,
1356     dpif_netdev_port_group_get,
1357     dpif_netdev_port_group_set,
1358     dpif_netdev_flow_get,
1359     dpif_netdev_flow_put,
1360     dpif_netdev_flow_del,
1361     dpif_netdev_flow_flush,
1362     dpif_netdev_flow_list,
1363     dpif_netdev_execute,
1364     dpif_netdev_recv_get_mask,
1365     dpif_netdev_recv_set_mask,
1366     NULL,                       /* get_sflow_probability */
1367     NULL,                       /* set_sflow_probability */
1368     dpif_netdev_recv,
1369     dpif_netdev_recv_wait,
1370 };