dpif-netdev: Also allow "dummy" netdevs in a dpif-netdev.
[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     struct dp_netdev_port *ports[MAX_PORTS];
95     struct list port_list;
96     unsigned int serial;
97 };
98
99 /* A port in a netdev-based datapath. */
100 struct dp_netdev_port {
101     int port_no;                /* Index into dp_netdev's 'ports'. */
102     struct list node;           /* Element in dp_netdev's 'port_list'. */
103     struct netdev *netdev;
104     bool internal;              /* Internal port? */
105 };
106
107 /* A flow in dp_netdev's 'flow_table'. */
108 struct dp_netdev_flow {
109     struct hmap_node node;      /* Element in dp_netdev's 'flow_table'. */
110     struct flow key;
111
112     /* Statistics. */
113     long long int used;         /* Last used time, in monotonic msecs. */
114     long long int packet_count; /* Number of packets matched. */
115     long long int byte_count;   /* Number of bytes matched. */
116     ovs_be16 tcp_ctl;           /* Bitwise-OR of seen tcp_ctl values. */
117
118     /* Actions. */
119     struct nlattr *actions;
120     size_t actions_len;
121 };
122
123 /* Interface to netdev-based datapath. */
124 struct dpif_netdev {
125     struct dpif dpif;
126     struct dp_netdev *dp;
127     int listen_mask;
128     unsigned int dp_serial;
129 };
130
131 /* All netdev-based datapaths. */
132 static struct shash dp_netdevs = SHASH_INITIALIZER(&dp_netdevs);
133
134 /* Maximum port MTU seen so far. */
135 static int max_mtu = ETH_PAYLOAD_MAX;
136
137 static int get_port_by_number(struct dp_netdev *, uint16_t port_no,
138                               struct dp_netdev_port **portp);
139 static int get_port_by_name(struct dp_netdev *, const char *devname,
140                             struct dp_netdev_port **portp);
141 static void dp_netdev_free(struct dp_netdev *);
142 static void dp_netdev_flow_flush(struct dp_netdev *);
143 static int do_add_port(struct dp_netdev *, const char *devname,
144                        const char *type, uint16_t port_no);
145 static int do_del_port(struct dp_netdev *, uint16_t port_no);
146 static int dpif_netdev_open(const struct dpif_class *, const char *name,
147                             bool create, struct dpif **);
148 static int dp_netdev_output_userspace(struct dp_netdev *, const struct ofpbuf *,
149                                     int queue_no, const struct flow *,
150                                     uint64_t arg);
151 static int dp_netdev_execute_actions(struct dp_netdev *,
152                                      struct ofpbuf *, struct flow *,
153                                      const struct nlattr *actions,
154                                      size_t actions_len);
155
156 static struct dpif_class dpif_dummy_class;
157
158 static struct dpif_netdev *
159 dpif_netdev_cast(const struct dpif *dpif)
160 {
161     assert(dpif->dpif_class->open == dpif_netdev_open);
162     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
163 }
164
165 static struct dp_netdev *
166 get_dp_netdev(const struct dpif *dpif)
167 {
168     return dpif_netdev_cast(dpif)->dp;
169 }
170
171 static struct dpif *
172 create_dpif_netdev(struct dp_netdev *dp)
173 {
174     uint16_t netflow_id = hash_string(dp->name, 0);
175     struct dpif_netdev *dpif;
176
177     dp->open_cnt++;
178
179     dpif = xmalloc(sizeof *dpif);
180     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
181     dpif->dp = dp;
182     dpif->listen_mask = 0;
183     dpif->dp_serial = dp->serial;
184
185     return &dpif->dpif;
186 }
187
188 static int
189 create_dp_netdev(const char *name, const struct dpif_class *class,
190                  struct dp_netdev **dpp)
191 {
192     struct dp_netdev *dp;
193     int error;
194     int i;
195
196     dp = xzalloc(sizeof *dp);
197     dp->class = class;
198     dp->name = xstrdup(name);
199     dp->open_cnt = 0;
200     dp->drop_frags = false;
201     for (i = 0; i < N_QUEUES; i++) {
202         dp->queues[i].head = dp->queues[i].tail = 0;
203     }
204     hmap_init(&dp->flow_table);
205     list_init(&dp->port_list);
206     error = do_add_port(dp, name, "internal", OVSP_LOCAL);
207     if (error) {
208         dp_netdev_free(dp);
209         return error;
210     }
211
212     shash_add(&dp_netdevs, name, dp);
213
214     *dpp = dp;
215     return 0;
216 }
217
218 static int
219 dpif_netdev_open(const struct dpif_class *class, const char *name,
220                  bool create, struct dpif **dpifp)
221 {
222     struct dp_netdev *dp;
223
224     dp = shash_find_data(&dp_netdevs, name);
225     if (!dp) {
226         if (!create) {
227             return ENODEV;
228         } else {
229             int error = create_dp_netdev(name, class, &dp);
230             if (error) {
231                 return error;
232             }
233             assert(dp != NULL);
234         }
235     } else {
236         if (dp->class != class) {
237             return EINVAL;
238         } else if (create) {
239             return EEXIST;
240         }
241     }
242
243     *dpifp = create_dpif_netdev(dp);
244     return 0;
245 }
246
247 static void
248 dp_netdev_purge_queues(struct dp_netdev *dp)
249 {
250     int i;
251
252     for (i = 0; i < N_QUEUES; i++) {
253         struct dp_netdev_queue *q = &dp->queues[i];
254
255         while (q->tail != q->head) {
256             struct dpif_upcall *upcall = q->upcalls[q->tail++ & QUEUE_MASK];
257
258             ofpbuf_delete(upcall->packet);
259             free(upcall);
260         }
261     }
262 }
263
264 static void
265 dp_netdev_free(struct dp_netdev *dp)
266 {
267     struct dp_netdev_port *port, *next;
268
269     dp_netdev_flow_flush(dp);
270     LIST_FOR_EACH_SAFE (port, next, node, &dp->port_list) {
271         do_del_port(dp, port->port_no);
272     }
273     dp_netdev_purge_queues(dp);
274     hmap_destroy(&dp->flow_table);
275     free(dp->name);
276     free(dp);
277 }
278
279 static void
280 dpif_netdev_close(struct dpif *dpif)
281 {
282     struct dp_netdev *dp = get_dp_netdev(dpif);
283     assert(dp->open_cnt > 0);
284     if (--dp->open_cnt == 0 && dp->destroyed) {
285         shash_find_and_delete(&dp_netdevs, dp->name);
286         dp_netdev_free(dp);
287     }
288     free(dpif);
289 }
290
291 static int
292 dpif_netdev_destroy(struct dpif *dpif)
293 {
294     struct dp_netdev *dp = get_dp_netdev(dpif);
295     dp->destroyed = true;
296     return 0;
297 }
298
299 static int
300 dpif_netdev_get_stats(const struct dpif *dpif, struct ovs_dp_stats *stats)
301 {
302     struct dp_netdev *dp = get_dp_netdev(dpif);
303     memset(stats, 0, sizeof *stats);
304     stats->n_flows = hmap_count(&dp->flow_table);
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 *netdev;
334     bool internal;
335     int mtu;
336     int error;
337
338     /* XXX reject devices already in some dp_netdev. */
339     if (type[0] == '\0' || !strcmp(type, "system") || !strcmp(type, "dummy")) {
340         internal = false;
341     } else if (!strcmp(type, "internal")) {
342         internal = true;
343     } else {
344         VLOG_WARN("%s: unsupported port type %s", devname, type);
345         return EINVAL;
346     }
347
348     /* Open and validate network device. */
349     if (dp->class == &dpif_dummy_class) {
350         type = "dummy";
351     } else if (internal) {
352         type = "tap";
353     }
354
355     error = netdev_open(devname, type, &netdev);
356     if (error) {
357         return error;
358     }
359     /* XXX reject loopback devices */
360     /* XXX reject non-Ethernet devices */
361
362     error = netdev_listen(netdev);
363     if (error) {
364         VLOG_ERR("%s: cannot receive packets on this network device (%s)",
365                  devname, strerror(errno));
366         netdev_close(netdev);
367         return error;
368     }
369
370     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, false);
371     if (error) {
372         netdev_close(netdev);
373         return error;
374     }
375
376     port = xmalloc(sizeof *port);
377     port->port_no = port_no;
378     port->netdev = netdev;
379     port->internal = internal;
380
381     error = netdev_get_mtu(netdev, &mtu);
382     if (!error) {
383         max_mtu = mtu;
384     }
385
386     list_push_back(&dp->port_list, &port->node);
387     dp->ports[port_no] = port;
388     dp->serial++;
389
390     return 0;
391 }
392
393 static int
394 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
395                      uint16_t *port_nop)
396 {
397     struct dp_netdev *dp = get_dp_netdev(dpif);
398     int port_no;
399
400     for (port_no = 0; port_no < MAX_PORTS; port_no++) {
401         if (!dp->ports[port_no]) {
402             *port_nop = port_no;
403             return do_add_port(dp, netdev_get_name(netdev),
404                                netdev_get_type(netdev), port_no);
405         }
406     }
407     return EFBIG;
408 }
409
410 static int
411 dpif_netdev_port_del(struct dpif *dpif, uint16_t port_no)
412 {
413     struct dp_netdev *dp = get_dp_netdev(dpif);
414     return port_no == OVSP_LOCAL ? EINVAL : do_del_port(dp, port_no);
415 }
416
417 static bool
418 is_valid_port_number(uint16_t port_no)
419 {
420     return port_no < MAX_PORTS;
421 }
422
423 static int
424 get_port_by_number(struct dp_netdev *dp,
425                    uint16_t port_no, struct dp_netdev_port **portp)
426 {
427     if (!is_valid_port_number(port_no)) {
428         *portp = NULL;
429         return EINVAL;
430     } else {
431         *portp = dp->ports[port_no];
432         return *portp ? 0 : ENOENT;
433     }
434 }
435
436 static int
437 get_port_by_name(struct dp_netdev *dp,
438                  const char *devname, struct dp_netdev_port **portp)
439 {
440     struct dp_netdev_port *port;
441
442     LIST_FOR_EACH (port, node, &dp->port_list) {
443         if (!strcmp(netdev_get_name(port->netdev), devname)) {
444             *portp = port;
445             return 0;
446         }
447     }
448     return ENOENT;
449 }
450
451 static int
452 do_del_port(struct dp_netdev *dp, uint16_t port_no)
453 {
454     struct dp_netdev_port *port;
455     char *name;
456     int error;
457
458     error = get_port_by_number(dp, port_no, &port);
459     if (error) {
460         return error;
461     }
462
463     list_remove(&port->node);
464     dp->ports[port->port_no] = NULL;
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,
478                   struct dpif_port *dpif_port)
479 {
480     dpif_port->name = xstrdup(netdev_get_name(port->netdev));
481     dpif_port->type = xstrdup(port->internal ? "internal" : "system");
482     dpif_port->port_no = port->port_no;
483 }
484
485 static int
486 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint16_t port_no,
487                                  struct dpif_port *dpif_port)
488 {
489     struct dp_netdev *dp = get_dp_netdev(dpif);
490     struct dp_netdev_port *port;
491     int error;
492
493     error = get_port_by_number(dp, port_no, &port);
494     if (!error) {
495         answer_port_query(port, dpif_port);
496     }
497     return error;
498 }
499
500 static int
501 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
502                                struct dpif_port *dpif_port)
503 {
504     struct dp_netdev *dp = get_dp_netdev(dpif);
505     struct dp_netdev_port *port;
506     int error;
507
508     error = get_port_by_name(dp, devname, &port);
509     if (!error) {
510         answer_port_query(port, dpif_port);
511     }
512     return error;
513 }
514
515 static int
516 dpif_netdev_get_max_ports(const struct dpif *dpif OVS_UNUSED)
517 {
518     return MAX_PORTS;
519 }
520
521 static void
522 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
523 {
524     hmap_remove(&dp->flow_table, &flow->node);
525     free(flow->actions);
526     free(flow);
527 }
528
529 static void
530 dp_netdev_flow_flush(struct dp_netdev *dp)
531 {
532     struct dp_netdev_flow *flow, *next;
533
534     HMAP_FOR_EACH_SAFE (flow, next, node, &dp->flow_table) {
535         dp_netdev_free_flow(dp, flow);
536     }
537 }
538
539 static int
540 dpif_netdev_flow_flush(struct dpif *dpif)
541 {
542     struct dp_netdev *dp = get_dp_netdev(dpif);
543     dp_netdev_flow_flush(dp);
544     return 0;
545 }
546
547 struct dp_netdev_port_state {
548     uint32_t port_no;
549     char *name;
550 };
551
552 static int
553 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
554 {
555     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
556     return 0;
557 }
558
559 static int
560 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
561                            struct dpif_port *dpif_port)
562 {
563     struct dp_netdev_port_state *state = state_;
564     struct dp_netdev *dp = get_dp_netdev(dpif);
565     uint32_t port_no;
566
567     for (port_no = state->port_no; port_no < MAX_PORTS; port_no++) {
568         struct dp_netdev_port *port = dp->ports[port_no];
569         if (port) {
570             free(state->name);
571             state->name = xstrdup(netdev_get_name(port->netdev));
572             dpif_port->name = state->name;
573             dpif_port->type = port->internal ? "internal" : "system";
574             dpif_port->port_no = port->port_no;
575             state->port_no = port_no + 1;
576             return 0;
577         }
578     }
579     return EOF;
580 }
581
582 static int
583 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
584 {
585     struct dp_netdev_port_state *state = state_;
586     free(state->name);
587     free(state);
588     return 0;
589 }
590
591 static int
592 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
593 {
594     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
595     if (dpif->dp_serial != dpif->dp->serial) {
596         dpif->dp_serial = dpif->dp->serial;
597         return ENOBUFS;
598     } else {
599         return EAGAIN;
600     }
601 }
602
603 static void
604 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
605 {
606     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
607     if (dpif->dp_serial != dpif->dp->serial) {
608         poll_immediate_wake();
609     }
610 }
611
612 static struct dp_netdev_flow *
613 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct flow *key)
614 {
615     struct dp_netdev_flow *flow;
616
617     HMAP_FOR_EACH_WITH_HASH (flow, node, flow_hash(key, 0), &dp->flow_table) {
618         if (flow_equal(&flow->key, key)) {
619             return flow;
620         }
621     }
622     return NULL;
623 }
624
625 static void
626 get_dpif_flow_stats(struct dp_netdev_flow *flow, struct dpif_flow_stats *stats)
627 {
628     stats->n_packets = flow->packet_count;
629     stats->n_bytes = flow->byte_count;
630     stats->used = flow->used;
631     stats->tcp_flags = TCP_FLAGS(flow->tcp_ctl);
632 }
633
634 static int
635 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
636                               struct flow *flow)
637 {
638     if (odp_flow_key_to_flow(key, key_len, flow)) {
639         /* This should not happen: it indicates that odp_flow_key_from_flow()
640          * and odp_flow_key_to_flow() disagree on the acceptable form of a
641          * flow.  Log the problem as an error, with enough details to enable
642          * debugging. */
643         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
644
645         if (!VLOG_DROP_ERR(&rl)) {
646             struct ds s;
647
648             ds_init(&s);
649             odp_flow_key_format(key, key_len, &s);
650             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
651             ds_destroy(&s);
652         }
653
654         return EINVAL;
655     }
656
657     if (flow->in_port < OFPP_MAX
658         ? flow->in_port >= MAX_PORTS
659         : flow->in_port != OFPP_LOCAL && flow->in_port != OFPP_NONE) {
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 OVS_ACTION_ATTR_OUTPUT:
713             if (nl_attr_get_u32(a) >= MAX_PORTS) {
714                 return EINVAL;
715             }
716             break;
717
718         case OVS_ACTION_ATTR_USERSPACE:
719             break;
720
721         case OVS_ACTION_ATTR_PUSH_VLAN:
722             *mutates = true;
723             if (nl_attr_get_be16(a) & htons(VLAN_CFI)) {
724                 return EINVAL;
725             }
726             break;
727
728         case OVS_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 OVS_ACTION_ATTR_POP_VLAN:
736         case OVS_ACTION_ATTR_SET_DL_SRC:
737         case OVS_ACTION_ATTR_SET_DL_DST:
738         case OVS_ACTION_ATTR_SET_NW_SRC:
739         case OVS_ACTION_ATTR_SET_NW_DST:
740         case OVS_ACTION_ATTR_SET_TP_SRC:
741         case OVS_ACTION_ATTR_SET_TP_DST:
742             *mutates = true;
743             break;
744
745         case OVS_ACTION_ATTR_SET_TUNNEL:
746         case OVS_ACTION_ATTR_SET_PRIORITY:
747         case OVS_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     error = dpif_netdev_flow_from_nlattrs(key_attrs, key_len, &key);
989     if (!error) {
990         error = dp_netdev_execute_actions(dp, &copy, &key,
991                                           actions, actions_len);
992     }
993     if (mutates) {
994         ofpbuf_uninit(&copy);
995     }
996     return error;
997 }
998
999 static int
1000 dpif_netdev_recv_get_mask(const struct dpif *dpif, int *listen_mask)
1001 {
1002     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1003     *listen_mask = dpif_netdev->listen_mask;
1004     return 0;
1005 }
1006
1007 static int
1008 dpif_netdev_recv_set_mask(struct dpif *dpif, int listen_mask)
1009 {
1010     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1011     dpif_netdev->listen_mask = listen_mask;
1012     return 0;
1013 }
1014
1015 static struct dp_netdev_queue *
1016 find_nonempty_queue(struct dpif *dpif)
1017 {
1018     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1019     struct dp_netdev *dp = get_dp_netdev(dpif);
1020     int mask = dpif_netdev->listen_mask;
1021     int i;
1022
1023     for (i = 0; i < N_QUEUES; i++) {
1024         struct dp_netdev_queue *q = &dp->queues[i];
1025         if (q->head != q->tail && mask & (1u << i)) {
1026             return q;
1027         }
1028     }
1029     return NULL;
1030 }
1031
1032 static int
1033 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1034 {
1035     struct dp_netdev_queue *q = find_nonempty_queue(dpif);
1036     if (q) {
1037         struct dpif_upcall *u = q->upcalls[q->tail++ & QUEUE_MASK];
1038         *upcall = *u;
1039         free(u);
1040
1041         return 0;
1042     } else {
1043         return EAGAIN;
1044     }
1045 }
1046
1047 static void
1048 dpif_netdev_recv_wait(struct dpif *dpif)
1049 {
1050     if (find_nonempty_queue(dpif)) {
1051         poll_immediate_wake();
1052     } else {
1053         /* No messages ready to be received, and dp_wait() will ensure that we
1054          * wake up to queue new messages, so there is nothing to do. */
1055     }
1056 }
1057
1058 static void
1059 dpif_netdev_recv_purge(struct dpif *dpif)
1060 {
1061     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1062     dp_netdev_purge_queues(dpif_netdev->dp);
1063 }
1064 \f
1065 static void
1066 dp_netdev_flow_used(struct dp_netdev_flow *flow, struct flow *key,
1067                     const struct ofpbuf *packet)
1068 {
1069     flow->used = time_msec();
1070     flow->packet_count++;
1071     flow->byte_count += packet->size;
1072     if (key->dl_type == htons(ETH_TYPE_IP) && key->nw_proto == IPPROTO_TCP) {
1073         struct tcp_header *th = packet->l4;
1074         flow->tcp_ctl |= th->tcp_ctl;
1075     }
1076 }
1077
1078 static void
1079 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1080                      struct ofpbuf *packet)
1081 {
1082     struct dp_netdev_flow *flow;
1083     struct flow key;
1084
1085     if (packet->size < ETH_HEADER_LEN) {
1086         return;
1087     }
1088     if (flow_extract(packet, 0, port->port_no, &key) && dp->drop_frags) {
1089         dp->n_frags++;
1090         return;
1091     }
1092
1093     flow = dp_netdev_lookup_flow(dp, &key);
1094     if (flow) {
1095         dp_netdev_flow_used(flow, &key, packet);
1096         dp_netdev_execute_actions(dp, packet, &key,
1097                                   flow->actions, flow->actions_len);
1098         dp->n_hit++;
1099     } else {
1100         dp->n_missed++;
1101         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, 0);
1102     }
1103 }
1104
1105 static void
1106 dpif_netdev_run(struct dpif *dpif)
1107 {
1108     struct dp_netdev *dp = get_dp_netdev(dpif);
1109     struct dp_netdev_port *port;
1110     struct ofpbuf packet;
1111
1112     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + max_mtu);
1113
1114     LIST_FOR_EACH (port, node, &dp->port_list) {
1115         int error;
1116
1117         /* Reset packet contents. */
1118         ofpbuf_clear(&packet);
1119         ofpbuf_reserve(&packet, DP_NETDEV_HEADROOM);
1120
1121         error = netdev_recv(port->netdev, &packet);
1122         if (!error) {
1123             dp_netdev_port_input(dp, port, &packet);
1124         } else if (error != EAGAIN && error != EOPNOTSUPP) {
1125             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1126             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1127                         netdev_get_name(port->netdev), strerror(error));
1128         }
1129     }
1130     ofpbuf_uninit(&packet);
1131 }
1132
1133 static void
1134 dpif_netdev_wait(struct dpif *dpif)
1135 {
1136     struct dp_netdev *dp = get_dp_netdev(dpif);
1137     struct dp_netdev_port *port;
1138
1139     LIST_FOR_EACH (port, node, &dp->port_list) {
1140         netdev_recv_wait(port->netdev);
1141     }
1142 }
1143
1144 static void
1145 dp_netdev_pop_vlan(struct ofpbuf *packet)
1146 {
1147     struct vlan_eth_header *veh = packet->l2;
1148     if (packet->size >= sizeof *veh
1149         && veh->veth_type == htons(ETH_TYPE_VLAN)) {
1150         struct eth_header tmp;
1151
1152         memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
1153         memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
1154         tmp.eth_type = veh->veth_next_type;
1155
1156         ofpbuf_pull(packet, VLAN_HEADER_LEN);
1157         packet->l2 = (char*)packet->l2 + VLAN_HEADER_LEN;
1158         memcpy(packet->data, &tmp, sizeof tmp);
1159     }
1160 }
1161
1162 static void
1163 dp_netdev_set_dl_src(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1164 {
1165     struct eth_header *eh = packet->l2;
1166     memcpy(eh->eth_src, dl_addr, sizeof eh->eth_src);
1167 }
1168
1169 static void
1170 dp_netdev_set_dl_dst(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1171 {
1172     struct eth_header *eh = packet->l2;
1173     memcpy(eh->eth_dst, dl_addr, sizeof eh->eth_dst);
1174 }
1175
1176 static bool
1177 is_ip(const struct ofpbuf *packet, const struct flow *key)
1178 {
1179     return key->dl_type == htons(ETH_TYPE_IP) && packet->l4;
1180 }
1181
1182 static void
1183 dp_netdev_set_nw_addr(struct ofpbuf *packet, const struct flow *key,
1184                       const struct nlattr *a)
1185 {
1186     if (is_ip(packet, key)) {
1187         struct ip_header *nh = packet->l3;
1188         ovs_be32 ip = nl_attr_get_be32(a);
1189         uint16_t type = nl_attr_type(a);
1190         ovs_be32 *field;
1191
1192         field = type == OVS_ACTION_ATTR_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
1193         if (key->nw_proto == IPPROTO_TCP && packet->l7) {
1194             struct tcp_header *th = packet->l4;
1195             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, ip);
1196         } else if (key->nw_proto == IPPROTO_UDP && packet->l7) {
1197             struct udp_header *uh = packet->l4;
1198             if (uh->udp_csum) {
1199                 uh->udp_csum = recalc_csum32(uh->udp_csum, *field, ip);
1200                 if (!uh->udp_csum) {
1201                     uh->udp_csum = htons(0xffff);
1202                 }
1203             }
1204         }
1205         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, ip);
1206         *field = ip;
1207     }
1208 }
1209
1210 static void
1211 dp_netdev_set_nw_tos(struct ofpbuf *packet, const struct flow *key,
1212                      uint8_t nw_tos)
1213 {
1214     if (is_ip(packet, key)) {
1215         struct ip_header *nh = packet->l3;
1216         uint8_t *field = &nh->ip_tos;
1217
1218         /* Set the DSCP bits and preserve the ECN bits. */
1219         uint8_t new = nw_tos | (nh->ip_tos & IP_ECN_MASK);
1220
1221         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t)*field),
1222                 htons((uint16_t) new));
1223         *field = new;
1224     }
1225 }
1226
1227 static void
1228 dp_netdev_set_tp_port(struct ofpbuf *packet, const struct flow *key,
1229                       const struct nlattr *a)
1230 {
1231         if (is_ip(packet, key)) {
1232         uint16_t type = nl_attr_type(a);
1233         ovs_be16 port = nl_attr_get_be16(a);
1234         ovs_be16 *field;
1235
1236         if (key->nw_proto == IPPROTO_TCP && packet->l7) {
1237             struct tcp_header *th = packet->l4;
1238             field = (type == OVS_ACTION_ATTR_SET_TP_SRC
1239                      ? &th->tcp_src : &th->tcp_dst);
1240             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, port);
1241             *field = port;
1242         } else if (key->nw_proto == IPPROTO_UDP && packet->l7) {
1243             struct udp_header *uh = packet->l4;
1244             field = (type == OVS_ACTION_ATTR_SET_TP_SRC
1245                      ? &uh->udp_src : &uh->udp_dst);
1246             uh->udp_csum = recalc_csum16(uh->udp_csum, *field, port);
1247             *field = port;
1248         } else {
1249             return;
1250         }
1251     }
1252 }
1253
1254 static void
1255 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1256                       uint16_t out_port)
1257 {
1258     struct dp_netdev_port *p = dp->ports[out_port];
1259     if (p) {
1260         netdev_send(p->netdev, packet);
1261     }
1262 }
1263
1264 static int
1265 dp_netdev_output_userspace(struct dp_netdev *dp, const struct ofpbuf *packet,
1266                          int queue_no, const struct flow *flow, uint64_t arg)
1267 {
1268     struct dp_netdev_queue *q = &dp->queues[queue_no];
1269     struct dpif_upcall *upcall;
1270     struct ofpbuf *buf;
1271     size_t key_len;
1272
1273     if (q->head - q->tail >= MAX_QUEUE_LEN) {
1274         dp->n_lost++;
1275         return ENOBUFS;
1276     }
1277
1278     buf = ofpbuf_new(ODPUTIL_FLOW_KEY_BYTES + 2 + packet->size);
1279     odp_flow_key_from_flow(buf, flow);
1280     key_len = buf->size;
1281     ofpbuf_pull(buf, key_len);
1282     ofpbuf_reserve(buf, 2);
1283     ofpbuf_put(buf, packet->data, packet->size);
1284
1285     upcall = xzalloc(sizeof *upcall);
1286     upcall->type = queue_no;
1287     upcall->packet = buf;
1288     upcall->key = buf->base;
1289     upcall->key_len = key_len;
1290     upcall->userdata = arg;
1291
1292     q->upcalls[q->head++ & QUEUE_MASK] = upcall;
1293
1294     return 0;
1295 }
1296
1297 static int
1298 dp_netdev_execute_actions(struct dp_netdev *dp,
1299                           struct ofpbuf *packet, struct flow *key,
1300                           const struct nlattr *actions,
1301                           size_t actions_len)
1302 {
1303     const struct nlattr *a;
1304     unsigned int left;
1305
1306     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
1307         switch (nl_attr_type(a)) {
1308         case OVS_ACTION_ATTR_OUTPUT:
1309             dp_netdev_output_port(dp, packet, nl_attr_get_u32(a));
1310             break;
1311
1312         case OVS_ACTION_ATTR_USERSPACE:
1313             dp_netdev_output_userspace(dp, packet, DPIF_UC_ACTION,
1314                                      key, nl_attr_get_u64(a));
1315             break;
1316
1317         case OVS_ACTION_ATTR_PUSH_VLAN:
1318             eth_push_vlan(packet, nl_attr_get_be16(a));
1319             break;
1320
1321         case OVS_ACTION_ATTR_POP_VLAN:
1322             dp_netdev_pop_vlan(packet);
1323             break;
1324
1325         case OVS_ACTION_ATTR_SET_DL_SRC:
1326             dp_netdev_set_dl_src(packet, nl_attr_get_unspec(a, ETH_ADDR_LEN));
1327             break;
1328
1329         case OVS_ACTION_ATTR_SET_DL_DST:
1330             dp_netdev_set_dl_dst(packet, nl_attr_get_unspec(a, ETH_ADDR_LEN));
1331             break;
1332
1333         case OVS_ACTION_ATTR_SET_NW_SRC:
1334         case OVS_ACTION_ATTR_SET_NW_DST:
1335             dp_netdev_set_nw_addr(packet, key, a);
1336             break;
1337
1338         case OVS_ACTION_ATTR_SET_NW_TOS:
1339             dp_netdev_set_nw_tos(packet, key, nl_attr_get_u8(a));
1340             break;
1341
1342         case OVS_ACTION_ATTR_SET_TP_SRC:
1343         case OVS_ACTION_ATTR_SET_TP_DST:
1344             dp_netdev_set_tp_port(packet, key, a);
1345             break;
1346         }
1347     }
1348     return 0;
1349 }
1350
1351 const struct dpif_class dpif_netdev_class = {
1352     "netdev",
1353     NULL,                       /* enumerate */
1354     dpif_netdev_open,
1355     dpif_netdev_close,
1356     dpif_netdev_destroy,
1357     dpif_netdev_run,
1358     dpif_netdev_wait,
1359     dpif_netdev_get_stats,
1360     dpif_netdev_get_drop_frags,
1361     dpif_netdev_set_drop_frags,
1362     dpif_netdev_port_add,
1363     dpif_netdev_port_del,
1364     dpif_netdev_port_query_by_number,
1365     dpif_netdev_port_query_by_name,
1366     dpif_netdev_get_max_ports,
1367     dpif_netdev_port_dump_start,
1368     dpif_netdev_port_dump_next,
1369     dpif_netdev_port_dump_done,
1370     dpif_netdev_port_poll,
1371     dpif_netdev_port_poll_wait,
1372     dpif_netdev_flow_get,
1373     dpif_netdev_flow_put,
1374     dpif_netdev_flow_del,
1375     dpif_netdev_flow_flush,
1376     dpif_netdev_flow_dump_start,
1377     dpif_netdev_flow_dump_next,
1378     dpif_netdev_flow_dump_done,
1379     dpif_netdev_execute,
1380     dpif_netdev_recv_get_mask,
1381     dpif_netdev_recv_set_mask,
1382     NULL,                       /* get_sflow_probability */
1383     NULL,                       /* set_sflow_probability */
1384     NULL,                       /* queue_to_priority */
1385     dpif_netdev_recv,
1386     dpif_netdev_recv_wait,
1387     dpif_netdev_recv_purge,
1388 };
1389
1390 void
1391 dpif_dummy_register(void)
1392 {
1393     if (!dpif_dummy_class.type) {
1394         dpif_dummy_class = dpif_netdev_class;
1395         dpif_dummy_class.type = "dummy";
1396         dp_register_provider(&dpif_dummy_class);
1397     }
1398 }