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