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