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