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