dpif-netdev: Avoid pointlessly maintaining a port count.
[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", ODPP_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 odp_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")) {
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     netdev_get_mtu(netdev, &mtu);
382     if (mtu != INT_MAX && mtu > max_mtu) {
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 == ODPP_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     return 0;
658 }
659
660 static int
661 dpif_netdev_flow_get(const struct dpif *dpif,
662                      const struct nlattr *nl_key, size_t nl_key_len,
663                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
664 {
665     struct dp_netdev *dp = get_dp_netdev(dpif);
666     struct dp_netdev_flow *flow;
667     struct flow key;
668     int error;
669
670     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
671     if (error) {
672         return error;
673     }
674
675     flow = dp_netdev_lookup_flow(dp, &key);
676     if (!flow) {
677         return ENOENT;
678     }
679
680     if (stats) {
681         get_dpif_flow_stats(flow, stats);
682     }
683     if (actionsp) {
684         *actionsp = ofpbuf_clone_data(flow->actions, flow->actions_len);
685     }
686     return 0;
687 }
688
689 static int
690 dpif_netdev_validate_actions(const struct nlattr *actions,
691                              size_t actions_len, bool *mutates)
692 {
693     const struct nlattr *a;
694     unsigned int left;
695
696     *mutates = false;
697     NL_ATTR_FOR_EACH (a, left, actions, actions_len) {
698         uint16_t type = nl_attr_type(a);
699         int len = odp_action_len(type);
700
701         if (len != nl_attr_get_size(a)) {
702             return EINVAL;
703         }
704
705         switch (type) {
706         case ODP_ACTION_ATTR_OUTPUT:
707             if (nl_attr_get_u32(a) >= MAX_PORTS) {
708                 return EINVAL;
709             }
710             break;
711
712         case ODP_ACTION_ATTR_USERSPACE:
713             break;
714
715         case ODP_ACTION_ATTR_SET_DL_TCI:
716             *mutates = true;
717             if (nl_attr_get_be16(a) & htons(VLAN_CFI)) {
718                 return EINVAL;
719             }
720             break;
721
722         case ODP_ACTION_ATTR_SET_NW_TOS:
723             *mutates = true;
724             if (nl_attr_get_u8(a) & IP_ECN_MASK) {
725                 return EINVAL;
726             }
727             break;
728
729         case ODP_ACTION_ATTR_STRIP_VLAN:
730         case ODP_ACTION_ATTR_SET_DL_SRC:
731         case ODP_ACTION_ATTR_SET_DL_DST:
732         case ODP_ACTION_ATTR_SET_NW_SRC:
733         case ODP_ACTION_ATTR_SET_NW_DST:
734         case ODP_ACTION_ATTR_SET_TP_SRC:
735         case ODP_ACTION_ATTR_SET_TP_DST:
736             *mutates = true;
737             break;
738
739         case ODP_ACTION_ATTR_SET_TUNNEL:
740         case ODP_ACTION_ATTR_SET_PRIORITY:
741         case ODP_ACTION_ATTR_POP_PRIORITY:
742         default:
743             return EOPNOTSUPP;
744         }
745     }
746     return 0;
747 }
748
749 static int
750 set_flow_actions(struct dp_netdev_flow *flow,
751                  const struct nlattr *actions, size_t actions_len)
752 {
753     bool mutates;
754     int error;
755
756     error = dpif_netdev_validate_actions(actions, actions_len, &mutates);
757     if (error) {
758         return error;
759     }
760
761     flow->actions = xrealloc(flow->actions, actions_len);
762     flow->actions_len = actions_len;
763     memcpy(flow->actions, actions, actions_len);
764     return 0;
765 }
766
767 static int
768 add_flow(struct dpif *dpif, const struct flow *key,
769          const struct nlattr *actions, size_t actions_len)
770 {
771     struct dp_netdev *dp = get_dp_netdev(dpif);
772     struct dp_netdev_flow *flow;
773     int error;
774
775     flow = xzalloc(sizeof *flow);
776     flow->key = *key;
777
778     error = set_flow_actions(flow, actions, actions_len);
779     if (error) {
780         free(flow);
781         return error;
782     }
783
784     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
785     return 0;
786 }
787
788 static void
789 clear_stats(struct dp_netdev_flow *flow)
790 {
791     flow->used = 0;
792     flow->packet_count = 0;
793     flow->byte_count = 0;
794     flow->tcp_ctl = 0;
795 }
796
797 static int
798 dpif_netdev_flow_put(struct dpif *dpif, enum dpif_flow_put_flags flags,
799                     const struct nlattr *nl_key, size_t nl_key_len,
800                     const struct nlattr *actions, size_t actions_len,
801                     struct dpif_flow_stats *stats)
802 {
803     struct dp_netdev *dp = get_dp_netdev(dpif);
804     struct dp_netdev_flow *flow;
805     struct flow key;
806     int error;
807
808     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
809     if (error) {
810         return error;
811     }
812
813     flow = dp_netdev_lookup_flow(dp, &key);
814     if (!flow) {
815         if (flags & DPIF_FP_CREATE) {
816             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
817                 if (stats) {
818                     memset(stats, 0, sizeof *stats);
819                 }
820                 return add_flow(dpif, &key, actions, actions_len);
821             } else {
822                 return EFBIG;
823             }
824         } else {
825             return ENOENT;
826         }
827     } else {
828         if (flags & DPIF_FP_MODIFY) {
829             int error = set_flow_actions(flow, actions, actions_len);
830             if (!error) {
831                 if (stats) {
832                     get_dpif_flow_stats(flow, stats);
833                 }
834                 if (flags & DPIF_FP_ZERO_STATS) {
835                     clear_stats(flow);
836                 }
837             }
838             return error;
839         } else {
840             return EEXIST;
841         }
842     }
843 }
844
845 static int
846 dpif_netdev_flow_del(struct dpif *dpif,
847                      const struct nlattr *nl_key, size_t nl_key_len,
848                      struct dpif_flow_stats *stats)
849 {
850     struct dp_netdev *dp = get_dp_netdev(dpif);
851     struct dp_netdev_flow *flow;
852     struct flow key;
853     int error;
854
855     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
856     if (error) {
857         return error;
858     }
859
860     flow = dp_netdev_lookup_flow(dp, &key);
861     if (flow) {
862         if (stats) {
863             get_dpif_flow_stats(flow, stats);
864         }
865         dp_netdev_free_flow(dp, flow);
866         return 0;
867     } else {
868         return ENOENT;
869     }
870 }
871
872 struct dp_netdev_flow_state {
873     uint32_t bucket;
874     uint32_t offset;
875     struct nlattr *actions;
876     struct odputil_keybuf keybuf;
877     struct dpif_flow_stats stats;
878 };
879
880 static int
881 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
882 {
883     struct dp_netdev_flow_state *state;
884
885     *statep = state = xmalloc(sizeof *state);
886     state->bucket = 0;
887     state->offset = 0;
888     state->actions = NULL;
889     return 0;
890 }
891
892 static int
893 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *state_,
894                            const struct nlattr **key, size_t *key_len,
895                            const struct nlattr **actions, size_t *actions_len,
896                            const struct dpif_flow_stats **stats)
897 {
898     struct dp_netdev_flow_state *state = state_;
899     struct dp_netdev *dp = get_dp_netdev(dpif);
900     struct dp_netdev_flow *flow;
901     struct hmap_node *node;
902
903     node = hmap_at_position(&dp->flow_table, &state->bucket, &state->offset);
904     if (!node) {
905         return EOF;
906     }
907
908     flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
909
910     if (key) {
911         struct ofpbuf buf;
912
913         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
914         odp_flow_key_from_flow(&buf, &flow->key);
915
916         *key = buf.data;
917         *key_len = buf.size;
918     }
919
920     if (actions) {
921         free(state->actions);
922         state->actions = xmemdup(flow->actions, flow->actions_len);
923
924         *actions = state->actions;
925         *actions_len = flow->actions_len;
926     }
927
928     if (stats) {
929         get_dpif_flow_stats(flow, &state->stats);
930         *stats = &state->stats;
931     }
932
933     return 0;
934 }
935
936 static int
937 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
938 {
939     struct dp_netdev_flow_state *state = state_;
940
941     free(state->actions);
942     free(state);
943     return 0;
944 }
945
946 static int
947 dpif_netdev_execute(struct dpif *dpif,
948                     const struct nlattr *key_attrs, size_t key_len,
949                     const struct nlattr *actions, size_t actions_len,
950                     const struct ofpbuf *packet)
951 {
952     struct dp_netdev *dp = get_dp_netdev(dpif);
953     struct ofpbuf copy;
954     bool mutates;
955     struct flow key;
956     int error;
957
958     if (packet->size < ETH_HEADER_LEN || packet->size > UINT16_MAX) {
959         return EINVAL;
960     }
961
962     error = dpif_netdev_validate_actions(actions, actions_len, &mutates);
963     if (error) {
964         return error;
965     }
966
967     if (mutates) {
968         /* We need a deep copy of 'packet' since we're going to modify its
969          * data. */
970         ofpbuf_init(&copy, DP_NETDEV_HEADROOM + packet->size);
971         ofpbuf_reserve(&copy, DP_NETDEV_HEADROOM);
972         ofpbuf_put(&copy, packet->data, packet->size);
973     } else {
974         /* We still need a shallow copy of 'packet', even though we won't
975          * modify its data, because flow_extract() modifies packet->l2, etc.
976          * We could probably get away with modifying those but it's more polite
977          * if we don't. */
978         copy = *packet;
979     }
980
981     flow_extract(&copy, 0, -1, &key);
982     dpif_netdev_flow_from_nlattrs(key_attrs, key_len, &key);
983
984     error = dp_netdev_execute_actions(dp, &copy, &key, actions, actions_len);
985     if (mutates) {
986         ofpbuf_uninit(&copy);
987     }
988     return error;
989 }
990
991 static int
992 dpif_netdev_recv_get_mask(const struct dpif *dpif, int *listen_mask)
993 {
994     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
995     *listen_mask = dpif_netdev->listen_mask;
996     return 0;
997 }
998
999 static int
1000 dpif_netdev_recv_set_mask(struct dpif *dpif, int listen_mask)
1001 {
1002     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1003     dpif_netdev->listen_mask = listen_mask;
1004     return 0;
1005 }
1006
1007 static struct dp_netdev_queue *
1008 find_nonempty_queue(struct dpif *dpif)
1009 {
1010     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1011     struct dp_netdev *dp = get_dp_netdev(dpif);
1012     int mask = dpif_netdev->listen_mask;
1013     int i;
1014
1015     for (i = 0; i < N_QUEUES; i++) {
1016         struct dp_netdev_queue *q = &dp->queues[i];
1017         if (q->head != q->tail && mask & (1u << i)) {
1018             return q;
1019         }
1020     }
1021     return NULL;
1022 }
1023
1024 static int
1025 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall)
1026 {
1027     struct dp_netdev_queue *q = find_nonempty_queue(dpif);
1028     if (q) {
1029         struct dpif_upcall *u = q->upcalls[q->tail++ & QUEUE_MASK];
1030         *upcall = *u;
1031         free(u);
1032
1033         return 0;
1034     } else {
1035         return EAGAIN;
1036     }
1037 }
1038
1039 static void
1040 dpif_netdev_recv_wait(struct dpif *dpif)
1041 {
1042     if (find_nonempty_queue(dpif)) {
1043         poll_immediate_wake();
1044     } else {
1045         /* No messages ready to be received, and dp_wait() will ensure that we
1046          * wake up to queue new messages, so there is nothing to do. */
1047     }
1048 }
1049
1050 static void
1051 dpif_netdev_recv_purge(struct dpif *dpif)
1052 {
1053     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1054     dp_netdev_purge_queues(dpif_netdev->dp);
1055 }
1056 \f
1057 static void
1058 dp_netdev_flow_used(struct dp_netdev_flow *flow, struct flow *key,
1059                     const struct ofpbuf *packet)
1060 {
1061     flow->used = time_msec();
1062     flow->packet_count++;
1063     flow->byte_count += packet->size;
1064     if (key->dl_type == htons(ETH_TYPE_IP) && key->nw_proto == IPPROTO_TCP) {
1065         struct tcp_header *th = packet->l4;
1066         flow->tcp_ctl |= th->tcp_ctl;
1067     }
1068 }
1069
1070 static void
1071 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1072                      struct ofpbuf *packet)
1073 {
1074     struct dp_netdev_flow *flow;
1075     struct flow key;
1076
1077     if (packet->size < ETH_HEADER_LEN) {
1078         return;
1079     }
1080     if (flow_extract(packet, 0, port->port_no, &key) && dp->drop_frags) {
1081         dp->n_frags++;
1082         return;
1083     }
1084
1085     flow = dp_netdev_lookup_flow(dp, &key);
1086     if (flow) {
1087         dp_netdev_flow_used(flow, &key, packet);
1088         dp_netdev_execute_actions(dp, packet, &key,
1089                                   flow->actions, flow->actions_len);
1090         dp->n_hit++;
1091     } else {
1092         dp->n_missed++;
1093         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, 0);
1094     }
1095 }
1096
1097 static void
1098 dpif_netdev_run(struct dpif *dpif)
1099 {
1100     struct dp_netdev *dp = get_dp_netdev(dpif);
1101     struct dp_netdev_port *port;
1102     struct ofpbuf packet;
1103
1104     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + max_mtu);
1105
1106     LIST_FOR_EACH (port, node, &dp->port_list) {
1107         int error;
1108
1109         /* Reset packet contents. */
1110         ofpbuf_clear(&packet);
1111         ofpbuf_reserve(&packet, DP_NETDEV_HEADROOM);
1112
1113         error = netdev_recv(port->netdev, &packet);
1114         if (!error) {
1115             dp_netdev_port_input(dp, port, &packet);
1116         } else if (error != EAGAIN && error != EOPNOTSUPP) {
1117             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1118             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1119                         netdev_get_name(port->netdev), strerror(error));
1120         }
1121     }
1122     ofpbuf_uninit(&packet);
1123 }
1124
1125 static void
1126 dpif_netdev_wait(struct dpif *dpif)
1127 {
1128     struct dp_netdev *dp = get_dp_netdev(dpif);
1129     struct dp_netdev_port *port;
1130
1131     LIST_FOR_EACH (port, node, &dp->port_list) {
1132         netdev_recv_wait(port->netdev);
1133     }
1134 }
1135
1136 static void
1137 dp_netdev_strip_vlan(struct ofpbuf *packet)
1138 {
1139     struct vlan_eth_header *veh = packet->l2;
1140     if (packet->size >= sizeof *veh
1141         && veh->veth_type == htons(ETH_TYPE_VLAN)) {
1142         struct eth_header tmp;
1143
1144         memcpy(tmp.eth_dst, veh->veth_dst, ETH_ADDR_LEN);
1145         memcpy(tmp.eth_src, veh->veth_src, ETH_ADDR_LEN);
1146         tmp.eth_type = veh->veth_next_type;
1147
1148         ofpbuf_pull(packet, VLAN_HEADER_LEN);
1149         packet->l2 = (char*)packet->l2 + VLAN_HEADER_LEN;
1150         memcpy(packet->data, &tmp, sizeof tmp);
1151     }
1152 }
1153
1154 static void
1155 dp_netdev_set_dl_src(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1156 {
1157     struct eth_header *eh = packet->l2;
1158     memcpy(eh->eth_src, dl_addr, sizeof eh->eth_src);
1159 }
1160
1161 static void
1162 dp_netdev_set_dl_dst(struct ofpbuf *packet, const uint8_t dl_addr[ETH_ADDR_LEN])
1163 {
1164     struct eth_header *eh = packet->l2;
1165     memcpy(eh->eth_dst, dl_addr, sizeof eh->eth_dst);
1166 }
1167
1168 static bool
1169 is_ip(const struct ofpbuf *packet, const struct flow *key)
1170 {
1171     return key->dl_type == htons(ETH_TYPE_IP) && packet->l4;
1172 }
1173
1174 static void
1175 dp_netdev_set_nw_addr(struct ofpbuf *packet, const struct flow *key,
1176                       const struct nlattr *a)
1177 {
1178     if (is_ip(packet, key)) {
1179         struct ip_header *nh = packet->l3;
1180         ovs_be32 ip = nl_attr_get_be32(a);
1181         uint16_t type = nl_attr_type(a);
1182         ovs_be32 *field;
1183
1184         field = type == ODP_ACTION_ATTR_SET_NW_SRC ? &nh->ip_src : &nh->ip_dst;
1185         if (key->nw_proto == IPPROTO_TCP && packet->l7) {
1186             struct tcp_header *th = packet->l4;
1187             th->tcp_csum = recalc_csum32(th->tcp_csum, *field, ip);
1188         } else if (key->nw_proto == IPPROTO_UDP && packet->l7) {
1189             struct udp_header *uh = packet->l4;
1190             if (uh->udp_csum) {
1191                 uh->udp_csum = recalc_csum32(uh->udp_csum, *field, ip);
1192                 if (!uh->udp_csum) {
1193                     uh->udp_csum = htons(0xffff);
1194                 }
1195             }
1196         }
1197         nh->ip_csum = recalc_csum32(nh->ip_csum, *field, ip);
1198         *field = ip;
1199     }
1200 }
1201
1202 static void
1203 dp_netdev_set_nw_tos(struct ofpbuf *packet, const struct flow *key,
1204                      uint8_t nw_tos)
1205 {
1206     if (is_ip(packet, key)) {
1207         struct ip_header *nh = packet->l3;
1208         uint8_t *field = &nh->ip_tos;
1209
1210         /* Set the DSCP bits and preserve the ECN bits. */
1211         uint8_t new = nw_tos | (nh->ip_tos & IP_ECN_MASK);
1212
1213         nh->ip_csum = recalc_csum16(nh->ip_csum, htons((uint16_t)*field),
1214                 htons((uint16_t) new));
1215         *field = new;
1216     }
1217 }
1218
1219 static void
1220 dp_netdev_set_tp_port(struct ofpbuf *packet, const struct flow *key,
1221                       const struct nlattr *a)
1222 {
1223         if (is_ip(packet, key)) {
1224         uint16_t type = nl_attr_type(a);
1225         ovs_be16 port = nl_attr_get_be16(a);
1226         ovs_be16 *field;
1227
1228         if (key->nw_proto == IPPROTO_TCP && packet->l7) {
1229             struct tcp_header *th = packet->l4;
1230             field = (type == ODP_ACTION_ATTR_SET_TP_SRC
1231                      ? &th->tcp_src : &th->tcp_dst);
1232             th->tcp_csum = recalc_csum16(th->tcp_csum, *field, port);
1233             *field = port;
1234         } else if (key->nw_proto == IPPROTO_UDP && packet->l7) {
1235             struct udp_header *uh = packet->l4;
1236             field = (type == ODP_ACTION_ATTR_SET_TP_SRC
1237                      ? &uh->udp_src : &uh->udp_dst);
1238             uh->udp_csum = recalc_csum16(uh->udp_csum, *field, port);
1239             *field = port;
1240         } else {
1241             return;
1242         }
1243     }
1244 }
1245
1246 static void
1247 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1248                       uint16_t out_port)
1249 {
1250     struct dp_netdev_port *p = dp->ports[out_port];
1251     if (p) {
1252         netdev_send(p->netdev, packet);
1253     }
1254 }
1255
1256 static int
1257 dp_netdev_output_userspace(struct dp_netdev *dp, const struct ofpbuf *packet,
1258                          int queue_no, const struct flow *flow, uint64_t arg)
1259 {
1260     struct dp_netdev_queue *q = &dp->queues[queue_no];
1261     struct dpif_upcall *upcall;
1262     struct ofpbuf *buf;
1263     size_t key_len;
1264
1265     if (q->head - q->tail >= MAX_QUEUE_LEN) {
1266         dp->n_lost++;
1267         return ENOBUFS;
1268     }
1269
1270     buf = ofpbuf_new(ODPUTIL_FLOW_KEY_BYTES + 2 + packet->size);
1271     odp_flow_key_from_flow(buf, flow);
1272     key_len = buf->size;
1273     ofpbuf_pull(buf, key_len);
1274     ofpbuf_reserve(buf, 2);
1275     ofpbuf_put(buf, packet->data, packet->size);
1276
1277     upcall = xzalloc(sizeof *upcall);
1278     upcall->type = queue_no;
1279     upcall->packet = buf;
1280     upcall->key = buf->base;
1281     upcall->key_len = key_len;
1282     upcall->userdata = arg;
1283
1284     q->upcalls[q->head++ & QUEUE_MASK] = upcall;
1285
1286     return 0;
1287 }
1288
1289 static int
1290 dp_netdev_execute_actions(struct dp_netdev *dp,
1291                           struct ofpbuf *packet, struct flow *key,
1292                           const struct nlattr *actions,
1293                           size_t actions_len)
1294 {
1295     const struct nlattr *a;
1296     unsigned int left;
1297
1298     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
1299         switch (nl_attr_type(a)) {
1300         case ODP_ACTION_ATTR_OUTPUT:
1301             dp_netdev_output_port(dp, packet, nl_attr_get_u32(a));
1302             break;
1303
1304         case ODP_ACTION_ATTR_USERSPACE:
1305             dp_netdev_output_userspace(dp, packet, DPIF_UC_ACTION,
1306                                      key, nl_attr_get_u64(a));
1307             break;
1308
1309         case ODP_ACTION_ATTR_SET_DL_TCI:
1310             eth_set_vlan_tci(packet, nl_attr_get_be16(a));
1311             break;
1312
1313         case ODP_ACTION_ATTR_STRIP_VLAN:
1314             dp_netdev_strip_vlan(packet);
1315             break;
1316
1317         case ODP_ACTION_ATTR_SET_DL_SRC:
1318             dp_netdev_set_dl_src(packet, nl_attr_get_unspec(a, ETH_ADDR_LEN));
1319             break;
1320
1321         case ODP_ACTION_ATTR_SET_DL_DST:
1322             dp_netdev_set_dl_dst(packet, nl_attr_get_unspec(a, ETH_ADDR_LEN));
1323             break;
1324
1325         case ODP_ACTION_ATTR_SET_NW_SRC:
1326         case ODP_ACTION_ATTR_SET_NW_DST:
1327             dp_netdev_set_nw_addr(packet, key, a);
1328             break;
1329
1330         case ODP_ACTION_ATTR_SET_NW_TOS:
1331             dp_netdev_set_nw_tos(packet, key, nl_attr_get_u8(a));
1332             break;
1333
1334         case ODP_ACTION_ATTR_SET_TP_SRC:
1335         case ODP_ACTION_ATTR_SET_TP_DST:
1336             dp_netdev_set_tp_port(packet, key, a);
1337             break;
1338         }
1339     }
1340     return 0;
1341 }
1342
1343 const struct dpif_class dpif_netdev_class = {
1344     "netdev",
1345     NULL,                       /* enumerate */
1346     dpif_netdev_open,
1347     dpif_netdev_close,
1348     dpif_netdev_destroy,
1349     dpif_netdev_run,
1350     dpif_netdev_wait,
1351     dpif_netdev_get_stats,
1352     dpif_netdev_get_drop_frags,
1353     dpif_netdev_set_drop_frags,
1354     dpif_netdev_port_add,
1355     dpif_netdev_port_del,
1356     dpif_netdev_port_query_by_number,
1357     dpif_netdev_port_query_by_name,
1358     dpif_netdev_get_max_ports,
1359     dpif_netdev_port_dump_start,
1360     dpif_netdev_port_dump_next,
1361     dpif_netdev_port_dump_done,
1362     dpif_netdev_port_poll,
1363     dpif_netdev_port_poll_wait,
1364     dpif_netdev_flow_get,
1365     dpif_netdev_flow_put,
1366     dpif_netdev_flow_del,
1367     dpif_netdev_flow_flush,
1368     dpif_netdev_flow_dump_start,
1369     dpif_netdev_flow_dump_next,
1370     dpif_netdev_flow_dump_done,
1371     dpif_netdev_execute,
1372     dpif_netdev_recv_get_mask,
1373     dpif_netdev_recv_set_mask,
1374     NULL,                       /* get_sflow_probability */
1375     NULL,                       /* set_sflow_probability */
1376     NULL,                       /* queue_to_priority */
1377     dpif_netdev_recv,
1378     dpif_netdev_recv_wait,
1379     dpif_netdev_recv_purge,
1380 };
1381
1382 void
1383 dpif_dummy_register(void)
1384 {
1385     if (!dpif_dummy_class.type) {
1386         dpif_dummy_class = dpif_netdev_class;
1387         dpif_dummy_class.type = "dummy";
1388         dp_register_provider(&dpif_dummy_class);
1389     }
1390 }