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