dpif-netdev: Constify key parameter of dp_netdev_action_userspace()
[sliver-openvswitch.git] / lib / dpif-netdev.c
1 /*
2  * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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 <ctype.h>
21 #include <errno.h>
22 #include <fcntl.h>
23 #include <inttypes.h>
24 #include <netinet/in.h>
25 #include <sys/socket.h>
26 #include <net/if.h>
27 #include <stdint.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <sys/ioctl.h>
31 #include <sys/stat.h>
32 #include <unistd.h>
33
34 #include "csum.h"
35 #include "dpif.h"
36 #include "dpif-provider.h"
37 #include "dummy.h"
38 #include "dynamic-string.h"
39 #include "flow.h"
40 #include "hmap.h"
41 #include "list.h"
42 #include "netdev.h"
43 #include "netdev-vport.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 "random.h"
51 #include "shash.h"
52 #include "sset.h"
53 #include "timeval.h"
54 #include "util.h"
55 #include "vlog.h"
56
57 VLOG_DEFINE_THIS_MODULE(dpif_netdev);
58
59 /* Configuration parameters. */
60 enum { MAX_PORTS = 256 };       /* Maximum number of ports. */
61 enum { MAX_FLOWS = 65536 };     /* Maximum number of flows in flow table. */
62
63 /* Enough headroom to add a vlan tag, plus an extra 2 bytes to allow IP
64  * headers to be aligned on a 4-byte boundary.  */
65 enum { DP_NETDEV_HEADROOM = 2 + VLAN_HEADER_LEN };
66
67 /* Queues. */
68 enum { N_QUEUES = 2 };          /* Number of queues for dpif_recv(). */
69 enum { MAX_QUEUE_LEN = 128 };   /* Maximum number of packets per queue. */
70 enum { QUEUE_MASK = MAX_QUEUE_LEN - 1 };
71 BUILD_ASSERT_DECL(IS_POW2(MAX_QUEUE_LEN));
72
73 struct dp_netdev_upcall {
74     struct dpif_upcall upcall;  /* Queued upcall information. */
75     struct ofpbuf buf;          /* ofpbuf instance for upcall.packet. */
76 };
77
78 struct dp_netdev_queue {
79     struct dp_netdev_upcall upcalls[MAX_QUEUE_LEN];
80     unsigned int head, tail;
81 };
82
83 /* Datapath based on the network device interface from netdev.h. */
84 struct dp_netdev {
85     const struct dpif_class *class;
86     char *name;
87     int open_cnt;
88     bool destroyed;
89
90     struct dp_netdev_queue queues[N_QUEUES];
91     struct hmap flow_table;     /* Flow table. */
92
93     /* Statistics. */
94     long long int n_hit;        /* Number of flow table matches. */
95     long long int n_missed;     /* Number of flow table misses. */
96     long long int n_lost;       /* Number of misses not passed to client. */
97
98     /* Ports. */
99     struct dp_netdev_port *ports[MAX_PORTS];
100     struct list port_list;
101     unsigned int serial;
102 };
103
104 /* A port in a netdev-based datapath. */
105 struct dp_netdev_port {
106     int port_no;                /* Index into dp_netdev's 'ports'. */
107     struct list node;           /* Element in dp_netdev's 'port_list'. */
108     struct netdev *netdev;
109     struct netdev_saved_flags *sf;
110     struct netdev_rx *rx;
111     char *type;                 /* Port type as requested by user. */
112 };
113
114 /* A flow in dp_netdev's 'flow_table'. */
115 struct dp_netdev_flow {
116     struct hmap_node node;      /* Element in dp_netdev's 'flow_table'. */
117     struct flow key;
118
119     /* Statistics. */
120     long long int used;         /* Last used time, in monotonic msecs. */
121     long long int packet_count; /* Number of packets matched. */
122     long long int byte_count;   /* Number of bytes matched. */
123     uint8_t tcp_flags;          /* Bitwise-OR of seen tcp_flags values. */
124
125     /* Actions. */
126     struct nlattr *actions;
127     size_t actions_len;
128 };
129
130 /* Interface to netdev-based datapath. */
131 struct dpif_netdev {
132     struct dpif dpif;
133     struct dp_netdev *dp;
134     unsigned int dp_serial;
135 };
136
137 /* All netdev-based datapaths. */
138 static struct shash dp_netdevs = SHASH_INITIALIZER(&dp_netdevs);
139
140 /* Maximum port MTU seen so far. */
141 static int max_mtu = ETH_PAYLOAD_MAX;
142
143 static int get_port_by_number(struct dp_netdev *, uint32_t port_no,
144                               struct dp_netdev_port **portp);
145 static int get_port_by_name(struct dp_netdev *, const char *devname,
146                             struct dp_netdev_port **portp);
147 static void dp_netdev_free(struct dp_netdev *);
148 static void dp_netdev_flow_flush(struct dp_netdev *);
149 static int do_add_port(struct dp_netdev *, const char *devname,
150                        const char *type, uint32_t port_no);
151 static int do_del_port(struct dp_netdev *, uint32_t port_no);
152 static int dpif_netdev_open(const struct dpif_class *, const char *name,
153                             bool create, struct dpif **);
154 static int dp_netdev_output_userspace(struct dp_netdev *, const struct ofpbuf *,
155                                     int queue_no, const struct flow *,
156                                     const struct nlattr *userdata);
157 static void dp_netdev_execute_actions(struct dp_netdev *,
158                                       struct ofpbuf *, struct flow *,
159                                       const struct nlattr *actions,
160                                       size_t actions_len);
161
162 static struct dpif_netdev *
163 dpif_netdev_cast(const struct dpif *dpif)
164 {
165     ovs_assert(dpif->dpif_class->open == dpif_netdev_open);
166     return CONTAINER_OF(dpif, struct dpif_netdev, dpif);
167 }
168
169 static struct dp_netdev *
170 get_dp_netdev(const struct dpif *dpif)
171 {
172     return dpif_netdev_cast(dpif)->dp;
173 }
174
175 static int
176 dpif_netdev_enumerate(struct sset *all_dps)
177 {
178     struct shash_node *node;
179
180     SHASH_FOR_EACH(node, &dp_netdevs) {
181         sset_add(all_dps, node->name);
182     }
183     return 0;
184 }
185
186 static bool
187 dpif_netdev_class_is_dummy(const struct dpif_class *class)
188 {
189     return class != &dpif_netdev_class;
190 }
191
192 static const char *
193 dpif_netdev_port_open_type(const struct dpif_class *class, const char *type)
194 {
195     return strcmp(type, "internal") ? type
196                   : dpif_netdev_class_is_dummy(class) ? "dummy"
197                   : "tap";
198 }
199
200 static struct dpif *
201 create_dpif_netdev(struct dp_netdev *dp)
202 {
203     uint16_t netflow_id = hash_string(dp->name, 0);
204     struct dpif_netdev *dpif;
205
206     dp->open_cnt++;
207
208     dpif = xmalloc(sizeof *dpif);
209     dpif_init(&dpif->dpif, dp->class, dp->name, netflow_id >> 8, netflow_id);
210     dpif->dp = dp;
211     dpif->dp_serial = dp->serial;
212
213     return &dpif->dpif;
214 }
215
216 static int
217 choose_port(struct dp_netdev *dp, const char *name)
218 {
219     int port_no;
220
221     if (dp->class != &dpif_netdev_class) {
222         const char *p;
223         int start_no = 0;
224
225         /* If the port name begins with "br", start the number search at
226          * 100 to make writing tests easier. */
227         if (!strncmp(name, "br", 2)) {
228             start_no = 100;
229         }
230
231         /* If the port name contains a number, try to assign that port number.
232          * This can make writing unit tests easier because port numbers are
233          * predictable. */
234         for (p = name; *p != '\0'; p++) {
235             if (isdigit((unsigned char) *p)) {
236                 port_no = start_no + strtol(p, NULL, 10);
237                 if (port_no > 0 && port_no < MAX_PORTS
238                     && !dp->ports[port_no]) {
239                     return port_no;
240                 }
241                 break;
242             }
243         }
244     }
245
246     for (port_no = 1; port_no < MAX_PORTS; port_no++) {
247         if (!dp->ports[port_no]) {
248             return port_no;
249         }
250     }
251
252     return -1;
253 }
254
255 static int
256 create_dp_netdev(const char *name, const struct dpif_class *class,
257                  struct dp_netdev **dpp)
258 {
259     struct dp_netdev *dp;
260     int error;
261     int i;
262
263     dp = xzalloc(sizeof *dp);
264     dp->class = class;
265     dp->name = xstrdup(name);
266     dp->open_cnt = 0;
267     for (i = 0; i < N_QUEUES; i++) {
268         dp->queues[i].head = dp->queues[i].tail = 0;
269     }
270     hmap_init(&dp->flow_table);
271     list_init(&dp->port_list);
272
273     error = do_add_port(dp, name, "internal", OVSP_LOCAL);
274     if (error) {
275         dp_netdev_free(dp);
276         return error;
277     }
278
279     shash_add(&dp_netdevs, name, dp);
280
281     *dpp = dp;
282     return 0;
283 }
284
285 static int
286 dpif_netdev_open(const struct dpif_class *class, const char *name,
287                  bool create, struct dpif **dpifp)
288 {
289     struct dp_netdev *dp;
290
291     dp = shash_find_data(&dp_netdevs, name);
292     if (!dp) {
293         if (!create) {
294             return ENODEV;
295         } else {
296             int error = create_dp_netdev(name, class, &dp);
297             if (error) {
298                 return error;
299             }
300             ovs_assert(dp != NULL);
301         }
302     } else {
303         if (dp->class != class) {
304             return EINVAL;
305         } else if (create) {
306             return EEXIST;
307         }
308     }
309
310     *dpifp = create_dpif_netdev(dp);
311     return 0;
312 }
313
314 static void
315 dp_netdev_purge_queues(struct dp_netdev *dp)
316 {
317     int i;
318
319     for (i = 0; i < N_QUEUES; i++) {
320         struct dp_netdev_queue *q = &dp->queues[i];
321
322         while (q->tail != q->head) {
323             struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
324             ofpbuf_uninit(&u->buf);
325         }
326     }
327 }
328
329 static void
330 dp_netdev_free(struct dp_netdev *dp)
331 {
332     struct dp_netdev_port *port, *next;
333
334     dp_netdev_flow_flush(dp);
335     LIST_FOR_EACH_SAFE (port, next, node, &dp->port_list) {
336         do_del_port(dp, port->port_no);
337     }
338     dp_netdev_purge_queues(dp);
339     hmap_destroy(&dp->flow_table);
340     free(dp->name);
341     free(dp);
342 }
343
344 static void
345 dpif_netdev_close(struct dpif *dpif)
346 {
347     struct dp_netdev *dp = get_dp_netdev(dpif);
348     ovs_assert(dp->open_cnt > 0);
349     if (--dp->open_cnt == 0 && dp->destroyed) {
350         shash_find_and_delete(&dp_netdevs, dp->name);
351         dp_netdev_free(dp);
352     }
353     free(dpif);
354 }
355
356 static int
357 dpif_netdev_destroy(struct dpif *dpif)
358 {
359     struct dp_netdev *dp = get_dp_netdev(dpif);
360     dp->destroyed = true;
361     return 0;
362 }
363
364 static int
365 dpif_netdev_get_stats(const struct dpif *dpif, struct dpif_dp_stats *stats)
366 {
367     struct dp_netdev *dp = get_dp_netdev(dpif);
368     stats->n_flows = hmap_count(&dp->flow_table);
369     stats->n_hit = dp->n_hit;
370     stats->n_missed = dp->n_missed;
371     stats->n_lost = dp->n_lost;
372     return 0;
373 }
374
375 static int
376 do_add_port(struct dp_netdev *dp, const char *devname, const char *type,
377             uint32_t port_no)
378 {
379     struct netdev_saved_flags *sf;
380     struct dp_netdev_port *port;
381     struct netdev *netdev;
382     struct netdev_rx *rx;
383     const char *open_type;
384     int mtu;
385     int error;
386
387     /* XXX reject devices already in some dp_netdev. */
388
389     /* Open and validate network device. */
390     open_type = dpif_netdev_port_open_type(dp->class, type);
391     error = netdev_open(devname, open_type, &netdev);
392     if (error) {
393         return error;
394     }
395     /* XXX reject loopback devices */
396     /* XXX reject non-Ethernet devices */
397
398     error = netdev_rx_open(netdev, &rx);
399     if (error
400         && !(error == EOPNOTSUPP && dpif_netdev_class_is_dummy(dp->class))) {
401         VLOG_ERR("%s: cannot receive packets on this network device (%s)",
402                  devname, strerror(errno));
403         netdev_close(netdev);
404         return error;
405     }
406
407     error = netdev_turn_flags_on(netdev, NETDEV_PROMISC, &sf);
408     if (error) {
409         netdev_rx_close(rx);
410         netdev_close(netdev);
411         return error;
412     }
413
414     port = xmalloc(sizeof *port);
415     port->port_no = port_no;
416     port->netdev = netdev;
417     port->sf = sf;
418     port->rx = rx;
419     port->type = xstrdup(type);
420
421     error = netdev_get_mtu(netdev, &mtu);
422     if (!error && mtu > max_mtu) {
423         max_mtu = mtu;
424     }
425
426     list_push_back(&dp->port_list, &port->node);
427     dp->ports[port_no] = port;
428     dp->serial++;
429
430     return 0;
431 }
432
433 static int
434 dpif_netdev_port_add(struct dpif *dpif, struct netdev *netdev,
435                      uint32_t *port_nop)
436 {
437     struct dp_netdev *dp = get_dp_netdev(dpif);
438     int port_no;
439
440     if (*port_nop != UINT32_MAX) {
441         if (*port_nop >= MAX_PORTS) {
442             return EFBIG;
443         } else if (dp->ports[*port_nop]) {
444             return EBUSY;
445         }
446         port_no = *port_nop;
447     } else {
448         port_no = choose_port(dp, netdev_vport_get_dpif_port(netdev));
449     }
450     if (port_no >= 0) {
451         *port_nop = port_no;
452         return do_add_port(dp, netdev_vport_get_dpif_port(netdev),
453                            netdev_get_type(netdev), port_no);
454     }
455     return EFBIG;
456 }
457
458 static int
459 dpif_netdev_port_del(struct dpif *dpif, uint32_t port_no)
460 {
461     struct dp_netdev *dp = get_dp_netdev(dpif);
462     return port_no == OVSP_LOCAL ? EINVAL : do_del_port(dp, port_no);
463 }
464
465 static bool
466 is_valid_port_number(uint32_t port_no)
467 {
468     return port_no < MAX_PORTS;
469 }
470
471 static int
472 get_port_by_number(struct dp_netdev *dp,
473                    uint32_t port_no, struct dp_netdev_port **portp)
474 {
475     if (!is_valid_port_number(port_no)) {
476         *portp = NULL;
477         return EINVAL;
478     } else {
479         *portp = dp->ports[port_no];
480         return *portp ? 0 : ENOENT;
481     }
482 }
483
484 static int
485 get_port_by_name(struct dp_netdev *dp,
486                  const char *devname, struct dp_netdev_port **portp)
487 {
488     struct dp_netdev_port *port;
489
490     LIST_FOR_EACH (port, node, &dp->port_list) {
491         if (!strcmp(netdev_vport_get_dpif_port(port->netdev), devname)) {
492             *portp = port;
493             return 0;
494         }
495     }
496     return ENOENT;
497 }
498
499 static int
500 do_del_port(struct dp_netdev *dp, uint32_t port_no)
501 {
502     struct dp_netdev_port *port;
503     int error;
504
505     error = get_port_by_number(dp, port_no, &port);
506     if (error) {
507         return error;
508     }
509
510     list_remove(&port->node);
511     dp->ports[port->port_no] = NULL;
512     dp->serial++;
513
514     netdev_close(port->netdev);
515     netdev_restore_flags(port->sf);
516     netdev_rx_close(port->rx);
517     free(port->type);
518     free(port);
519
520     return 0;
521 }
522
523 static void
524 answer_port_query(const struct dp_netdev_port *port,
525                   struct dpif_port *dpif_port)
526 {
527     dpif_port->name = xstrdup(netdev_vport_get_dpif_port(port->netdev));
528     dpif_port->type = xstrdup(port->type);
529     dpif_port->port_no = port->port_no;
530 }
531
532 static int
533 dpif_netdev_port_query_by_number(const struct dpif *dpif, uint32_t port_no,
534                                  struct dpif_port *dpif_port)
535 {
536     struct dp_netdev *dp = get_dp_netdev(dpif);
537     struct dp_netdev_port *port;
538     int error;
539
540     error = get_port_by_number(dp, port_no, &port);
541     if (!error && dpif_port) {
542         answer_port_query(port, dpif_port);
543     }
544     return error;
545 }
546
547 static int
548 dpif_netdev_port_query_by_name(const struct dpif *dpif, const char *devname,
549                                struct dpif_port *dpif_port)
550 {
551     struct dp_netdev *dp = get_dp_netdev(dpif);
552     struct dp_netdev_port *port;
553     int error;
554
555     error = get_port_by_name(dp, devname, &port);
556     if (!error && dpif_port) {
557         answer_port_query(port, dpif_port);
558     }
559     return error;
560 }
561
562 static int
563 dpif_netdev_get_max_ports(const struct dpif *dpif OVS_UNUSED)
564 {
565     return MAX_PORTS;
566 }
567
568 static void
569 dp_netdev_free_flow(struct dp_netdev *dp, struct dp_netdev_flow *flow)
570 {
571     hmap_remove(&dp->flow_table, &flow->node);
572     free(flow->actions);
573     free(flow);
574 }
575
576 static void
577 dp_netdev_flow_flush(struct dp_netdev *dp)
578 {
579     struct dp_netdev_flow *flow, *next;
580
581     HMAP_FOR_EACH_SAFE (flow, next, node, &dp->flow_table) {
582         dp_netdev_free_flow(dp, flow);
583     }
584 }
585
586 static int
587 dpif_netdev_flow_flush(struct dpif *dpif)
588 {
589     struct dp_netdev *dp = get_dp_netdev(dpif);
590     dp_netdev_flow_flush(dp);
591     return 0;
592 }
593
594 struct dp_netdev_port_state {
595     uint32_t port_no;
596     char *name;
597 };
598
599 static int
600 dpif_netdev_port_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
601 {
602     *statep = xzalloc(sizeof(struct dp_netdev_port_state));
603     return 0;
604 }
605
606 static int
607 dpif_netdev_port_dump_next(const struct dpif *dpif, void *state_,
608                            struct dpif_port *dpif_port)
609 {
610     struct dp_netdev_port_state *state = state_;
611     struct dp_netdev *dp = get_dp_netdev(dpif);
612     uint32_t port_no;
613
614     for (port_no = state->port_no; port_no < MAX_PORTS; port_no++) {
615         struct dp_netdev_port *port = dp->ports[port_no];
616         if (port) {
617             free(state->name);
618             state->name = xstrdup(netdev_vport_get_dpif_port(port->netdev));
619             dpif_port->name = state->name;
620             dpif_port->type = port->type;
621             dpif_port->port_no = port->port_no;
622             state->port_no = port_no + 1;
623             return 0;
624         }
625     }
626     return EOF;
627 }
628
629 static int
630 dpif_netdev_port_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
631 {
632     struct dp_netdev_port_state *state = state_;
633     free(state->name);
634     free(state);
635     return 0;
636 }
637
638 static int
639 dpif_netdev_port_poll(const struct dpif *dpif_, char **devnamep OVS_UNUSED)
640 {
641     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
642     if (dpif->dp_serial != dpif->dp->serial) {
643         dpif->dp_serial = dpif->dp->serial;
644         return ENOBUFS;
645     } else {
646         return EAGAIN;
647     }
648 }
649
650 static void
651 dpif_netdev_port_poll_wait(const struct dpif *dpif_)
652 {
653     struct dpif_netdev *dpif = dpif_netdev_cast(dpif_);
654     if (dpif->dp_serial != dpif->dp->serial) {
655         poll_immediate_wake();
656     }
657 }
658
659 static struct dp_netdev_flow *
660 dp_netdev_lookup_flow(const struct dp_netdev *dp, const struct flow *key)
661 {
662     struct dp_netdev_flow *flow;
663
664     HMAP_FOR_EACH_WITH_HASH (flow, node, flow_hash(key, 0), &dp->flow_table) {
665         if (flow_equal(&flow->key, key)) {
666             return flow;
667         }
668     }
669     return NULL;
670 }
671
672 static void
673 get_dpif_flow_stats(struct dp_netdev_flow *flow, struct dpif_flow_stats *stats)
674 {
675     stats->n_packets = flow->packet_count;
676     stats->n_bytes = flow->byte_count;
677     stats->used = flow->used;
678     stats->tcp_flags = flow->tcp_flags;
679 }
680
681 static int
682 dpif_netdev_flow_from_nlattrs(const struct nlattr *key, uint32_t key_len,
683                               struct flow *flow)
684 {
685     if (odp_flow_key_to_flow(key, key_len, flow) != ODP_FIT_PERFECT) {
686         /* This should not happen: it indicates that odp_flow_key_from_flow()
687          * and odp_flow_key_to_flow() disagree on the acceptable form of a
688          * flow.  Log the problem as an error, with enough details to enable
689          * debugging. */
690         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
691
692         if (!VLOG_DROP_ERR(&rl)) {
693             struct ds s;
694
695             ds_init(&s);
696             odp_flow_key_format(key, key_len, &s);
697             VLOG_ERR("internal error parsing flow key %s", ds_cstr(&s));
698             ds_destroy(&s);
699         }
700
701         return EINVAL;
702     }
703
704     if (flow->in_port < OFPP_MAX
705         ? flow->in_port >= MAX_PORTS
706         : flow->in_port != OFPP_LOCAL && flow->in_port != OFPP_NONE) {
707         return EINVAL;
708     }
709
710     return 0;
711 }
712
713 static int
714 dpif_netdev_flow_get(const struct dpif *dpif,
715                      const struct nlattr *nl_key, size_t nl_key_len,
716                      struct ofpbuf **actionsp, struct dpif_flow_stats *stats)
717 {
718     struct dp_netdev *dp = get_dp_netdev(dpif);
719     struct dp_netdev_flow *flow;
720     struct flow key;
721     int error;
722
723     error = dpif_netdev_flow_from_nlattrs(nl_key, nl_key_len, &key);
724     if (error) {
725         return error;
726     }
727
728     flow = dp_netdev_lookup_flow(dp, &key);
729     if (!flow) {
730         return ENOENT;
731     }
732
733     if (stats) {
734         get_dpif_flow_stats(flow, stats);
735     }
736     if (actionsp) {
737         *actionsp = ofpbuf_clone_data(flow->actions, flow->actions_len);
738     }
739     return 0;
740 }
741
742 static int
743 set_flow_actions(struct dp_netdev_flow *flow,
744                  const struct nlattr *actions, size_t actions_len)
745 {
746     flow->actions = xrealloc(flow->actions, actions_len);
747     flow->actions_len = actions_len;
748     memcpy(flow->actions, actions, actions_len);
749     return 0;
750 }
751
752 static int
753 dp_netdev_flow_add(struct dp_netdev *dp, const struct flow *key,
754                    const struct nlattr *actions, size_t actions_len)
755 {
756     struct dp_netdev_flow *flow;
757     int error;
758
759     flow = xzalloc(sizeof *flow);
760     flow->key = *key;
761
762     error = set_flow_actions(flow, actions, actions_len);
763     if (error) {
764         free(flow);
765         return error;
766     }
767
768     hmap_insert(&dp->flow_table, &flow->node, flow_hash(&flow->key, 0));
769     return 0;
770 }
771
772 static void
773 clear_stats(struct dp_netdev_flow *flow)
774 {
775     flow->used = 0;
776     flow->packet_count = 0;
777     flow->byte_count = 0;
778     flow->tcp_flags = 0;
779 }
780
781 static int
782 dpif_netdev_flow_put(struct dpif *dpif, const struct dpif_flow_put *put)
783 {
784     struct dp_netdev *dp = get_dp_netdev(dpif);
785     struct dp_netdev_flow *flow;
786     struct flow key;
787     int error;
788
789     error = dpif_netdev_flow_from_nlattrs(put->key, put->key_len, &key);
790     if (error) {
791         return error;
792     }
793
794     flow = dp_netdev_lookup_flow(dp, &key);
795     if (!flow) {
796         if (put->flags & DPIF_FP_CREATE) {
797             if (hmap_count(&dp->flow_table) < MAX_FLOWS) {
798                 if (put->stats) {
799                     memset(put->stats, 0, sizeof *put->stats);
800                 }
801                 return dp_netdev_flow_add(dp, &key, put->actions,
802                                           put->actions_len);
803             } else {
804                 return EFBIG;
805             }
806         } else {
807             return ENOENT;
808         }
809     } else {
810         if (put->flags & DPIF_FP_MODIFY) {
811             int error = set_flow_actions(flow, put->actions, put->actions_len);
812             if (!error) {
813                 if (put->stats) {
814                     get_dpif_flow_stats(flow, put->stats);
815                 }
816                 if (put->flags & DPIF_FP_ZERO_STATS) {
817                     clear_stats(flow);
818                 }
819             }
820             return error;
821         } else {
822             return EEXIST;
823         }
824     }
825 }
826
827 static int
828 dpif_netdev_flow_del(struct dpif *dpif, const struct dpif_flow_del *del)
829 {
830     struct dp_netdev *dp = get_dp_netdev(dpif);
831     struct dp_netdev_flow *flow;
832     struct flow key;
833     int error;
834
835     error = dpif_netdev_flow_from_nlattrs(del->key, del->key_len, &key);
836     if (error) {
837         return error;
838     }
839
840     flow = dp_netdev_lookup_flow(dp, &key);
841     if (flow) {
842         if (del->stats) {
843             get_dpif_flow_stats(flow, del->stats);
844         }
845         dp_netdev_free_flow(dp, flow);
846         return 0;
847     } else {
848         return ENOENT;
849     }
850 }
851
852 struct dp_netdev_flow_state {
853     uint32_t bucket;
854     uint32_t offset;
855     struct nlattr *actions;
856     struct odputil_keybuf keybuf;
857     struct dpif_flow_stats stats;
858 };
859
860 static int
861 dpif_netdev_flow_dump_start(const struct dpif *dpif OVS_UNUSED, void **statep)
862 {
863     struct dp_netdev_flow_state *state;
864
865     *statep = state = xmalloc(sizeof *state);
866     state->bucket = 0;
867     state->offset = 0;
868     state->actions = NULL;
869     return 0;
870 }
871
872 static int
873 dpif_netdev_flow_dump_next(const struct dpif *dpif, void *state_,
874                            const struct nlattr **key, size_t *key_len,
875                            const struct nlattr **actions, size_t *actions_len,
876                            const struct dpif_flow_stats **stats)
877 {
878     struct dp_netdev_flow_state *state = state_;
879     struct dp_netdev *dp = get_dp_netdev(dpif);
880     struct dp_netdev_flow *flow;
881     struct hmap_node *node;
882
883     node = hmap_at_position(&dp->flow_table, &state->bucket, &state->offset);
884     if (!node) {
885         return EOF;
886     }
887
888     flow = CONTAINER_OF(node, struct dp_netdev_flow, node);
889
890     if (key) {
891         struct ofpbuf buf;
892
893         ofpbuf_use_stack(&buf, &state->keybuf, sizeof state->keybuf);
894         odp_flow_key_from_flow(&buf, &flow->key, flow->key.in_port);
895
896         *key = buf.data;
897         *key_len = buf.size;
898     }
899
900     if (actions) {
901         free(state->actions);
902         state->actions = xmemdup(flow->actions, flow->actions_len);
903
904         *actions = state->actions;
905         *actions_len = flow->actions_len;
906     }
907
908     if (stats) {
909         get_dpif_flow_stats(flow, &state->stats);
910         *stats = &state->stats;
911     }
912
913     return 0;
914 }
915
916 static int
917 dpif_netdev_flow_dump_done(const struct dpif *dpif OVS_UNUSED, void *state_)
918 {
919     struct dp_netdev_flow_state *state = state_;
920
921     free(state->actions);
922     free(state);
923     return 0;
924 }
925
926 static int
927 dpif_netdev_execute(struct dpif *dpif, const struct dpif_execute *execute)
928 {
929     struct dp_netdev *dp = get_dp_netdev(dpif);
930     struct ofpbuf copy;
931     struct flow key;
932     int error;
933
934     if (execute->packet->size < ETH_HEADER_LEN ||
935         execute->packet->size > UINT16_MAX) {
936         return EINVAL;
937     }
938
939     /* Make a deep copy of 'packet', because we might modify its data. */
940     ofpbuf_init(&copy, DP_NETDEV_HEADROOM + execute->packet->size);
941     ofpbuf_reserve(&copy, DP_NETDEV_HEADROOM);
942     ofpbuf_put(&copy, execute->packet->data, execute->packet->size);
943
944     flow_extract(&copy, 0, 0, NULL, -1, &key);
945     error = dpif_netdev_flow_from_nlattrs(execute->key, execute->key_len,
946                                           &key);
947     if (!error) {
948         dp_netdev_execute_actions(dp, &copy, &key,
949                                   execute->actions, execute->actions_len);
950     }
951
952     ofpbuf_uninit(&copy);
953     return error;
954 }
955
956 static int
957 dpif_netdev_recv_set(struct dpif *dpif OVS_UNUSED, bool enable OVS_UNUSED)
958 {
959     return 0;
960 }
961
962 static int
963 dpif_netdev_queue_to_priority(const struct dpif *dpif OVS_UNUSED,
964                               uint32_t queue_id, uint32_t *priority)
965 {
966     *priority = queue_id;
967     return 0;
968 }
969
970 static struct dp_netdev_queue *
971 find_nonempty_queue(struct dpif *dpif)
972 {
973     struct dp_netdev *dp = get_dp_netdev(dpif);
974     int i;
975
976     for (i = 0; i < N_QUEUES; i++) {
977         struct dp_netdev_queue *q = &dp->queues[i];
978         if (q->head != q->tail) {
979             return q;
980         }
981     }
982     return NULL;
983 }
984
985 static int
986 dpif_netdev_recv(struct dpif *dpif, struct dpif_upcall *upcall,
987                  struct ofpbuf *buf)
988 {
989     struct dp_netdev_queue *q = find_nonempty_queue(dpif);
990     if (q) {
991         struct dp_netdev_upcall *u = &q->upcalls[q->tail++ & QUEUE_MASK];
992
993         *upcall = u->upcall;
994         upcall->packet = buf;
995
996         ofpbuf_uninit(buf);
997         *buf = u->buf;
998
999         return 0;
1000     } else {
1001         return EAGAIN;
1002     }
1003 }
1004
1005 static void
1006 dpif_netdev_recv_wait(struct dpif *dpif)
1007 {
1008     if (find_nonempty_queue(dpif)) {
1009         poll_immediate_wake();
1010     } else {
1011         /* No messages ready to be received, and dp_wait() will ensure that we
1012          * wake up to queue new messages, so there is nothing to do. */
1013     }
1014 }
1015
1016 static void
1017 dpif_netdev_recv_purge(struct dpif *dpif)
1018 {
1019     struct dpif_netdev *dpif_netdev = dpif_netdev_cast(dpif);
1020     dp_netdev_purge_queues(dpif_netdev->dp);
1021 }
1022 \f
1023 static void
1024 dp_netdev_flow_used(struct dp_netdev_flow *flow, const struct ofpbuf *packet)
1025 {
1026     flow->used = time_msec();
1027     flow->packet_count++;
1028     flow->byte_count += packet->size;
1029     flow->tcp_flags |= packet_get_tcp_flags(packet, &flow->key);
1030 }
1031
1032 static void
1033 dp_netdev_port_input(struct dp_netdev *dp, struct dp_netdev_port *port,
1034                      struct ofpbuf *packet)
1035 {
1036     struct dp_netdev_flow *flow;
1037     struct flow key;
1038
1039     if (packet->size < ETH_HEADER_LEN) {
1040         return;
1041     }
1042     flow_extract(packet, 0, 0, NULL, port->port_no, &key);
1043     flow = dp_netdev_lookup_flow(dp, &key);
1044     if (flow) {
1045         dp_netdev_flow_used(flow, packet);
1046         dp_netdev_execute_actions(dp, packet, &key,
1047                                   flow->actions, flow->actions_len);
1048         dp->n_hit++;
1049     } else {
1050         dp->n_missed++;
1051         dp_netdev_output_userspace(dp, packet, DPIF_UC_MISS, &key, NULL);
1052     }
1053 }
1054
1055 static void
1056 dpif_netdev_run(struct dpif *dpif)
1057 {
1058     struct dp_netdev *dp = get_dp_netdev(dpif);
1059     struct dp_netdev_port *port;
1060     struct ofpbuf packet;
1061
1062     ofpbuf_init(&packet, DP_NETDEV_HEADROOM + VLAN_ETH_HEADER_LEN + max_mtu);
1063
1064     LIST_FOR_EACH (port, node, &dp->port_list) {
1065         int error;
1066
1067         /* Reset packet contents. */
1068         ofpbuf_clear(&packet);
1069         ofpbuf_reserve(&packet, DP_NETDEV_HEADROOM);
1070
1071         error = port->rx ? netdev_rx_recv(port->rx, &packet) : EOPNOTSUPP;
1072         if (!error) {
1073             dp_netdev_port_input(dp, port, &packet);
1074         } else if (error != EAGAIN && error != EOPNOTSUPP) {
1075             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1076             VLOG_ERR_RL(&rl, "error receiving data from %s: %s",
1077                         netdev_vport_get_dpif_port(port->netdev),
1078                         strerror(error));
1079         }
1080     }
1081     ofpbuf_uninit(&packet);
1082 }
1083
1084 static void
1085 dpif_netdev_wait(struct dpif *dpif)
1086 {
1087     struct dp_netdev *dp = get_dp_netdev(dpif);
1088     struct dp_netdev_port *port;
1089
1090     LIST_FOR_EACH (port, node, &dp->port_list) {
1091         if (port->rx) {
1092             netdev_rx_wait(port->rx);
1093         }
1094     }
1095 }
1096
1097 static void
1098 dp_netdev_set_dl(struct ofpbuf *packet, const struct ovs_key_ethernet *eth_key)
1099 {
1100     struct eth_header *eh = packet->l2;
1101
1102     memcpy(eh->eth_src, eth_key->eth_src, sizeof eh->eth_src);
1103     memcpy(eh->eth_dst, eth_key->eth_dst, sizeof eh->eth_dst);
1104 }
1105
1106 static void
1107 dp_netdev_output_port(struct dp_netdev *dp, struct ofpbuf *packet,
1108                       uint32_t out_port)
1109 {
1110     struct dp_netdev_port *p = dp->ports[out_port];
1111     if (p) {
1112         netdev_send(p->netdev, packet);
1113     }
1114 }
1115
1116 static int
1117 dp_netdev_output_userspace(struct dp_netdev *dp, const struct ofpbuf *packet,
1118                            int queue_no, const struct flow *flow,
1119                            const struct nlattr *userdata)
1120 {
1121     struct dp_netdev_queue *q = &dp->queues[queue_no];
1122     if (q->head - q->tail < MAX_QUEUE_LEN) {
1123         struct dp_netdev_upcall *u = &q->upcalls[q->head++ & QUEUE_MASK];
1124         struct dpif_upcall *upcall = &u->upcall;
1125         struct ofpbuf *buf = &u->buf;
1126         size_t buf_size;
1127
1128         upcall->type = queue_no;
1129
1130         /* Allocate buffer big enough for everything. */
1131         buf_size = ODPUTIL_FLOW_KEY_BYTES + 2 + packet->size;
1132         if (userdata) {
1133             buf_size += NLA_ALIGN(userdata->nla_len);
1134         }
1135         ofpbuf_init(buf, buf_size);
1136
1137         /* Put ODP flow. */
1138         odp_flow_key_from_flow(buf, flow, flow->in_port);
1139         upcall->key = buf->data;
1140         upcall->key_len = buf->size;
1141
1142         /* Put userdata. */
1143         if (userdata) {
1144             upcall->userdata = ofpbuf_put(buf, userdata,
1145                                           NLA_ALIGN(userdata->nla_len));
1146         }
1147
1148         /* Put packet.
1149          *
1150          * We adjust 'data' and 'size' in 'buf' so that only the packet itself
1151          * is visible in 'upcall->packet'.  The ODP flow and (if present)
1152          * userdata become part of the headroom. */
1153         ofpbuf_put_zeros(buf, 2);
1154         buf->data = ofpbuf_put(buf, packet->data, packet->size);
1155         buf->size = packet->size;
1156         upcall->packet = buf;
1157
1158         return 0;
1159     } else {
1160         dp->n_lost++;
1161         return ENOBUFS;
1162     }
1163 }
1164
1165 static void
1166 dp_netdev_sample(struct dp_netdev *dp,
1167                  struct ofpbuf *packet, struct flow *key,
1168                  const struct nlattr *action)
1169 {
1170     const struct nlattr *subactions = NULL;
1171     const struct nlattr *a;
1172     size_t left;
1173
1174     NL_NESTED_FOR_EACH_UNSAFE (a, left, action) {
1175         int type = nl_attr_type(a);
1176
1177         switch ((enum ovs_sample_attr) type) {
1178         case OVS_SAMPLE_ATTR_PROBABILITY:
1179             if (random_uint32() >= nl_attr_get_u32(a)) {
1180                 return;
1181             }
1182             break;
1183
1184         case OVS_SAMPLE_ATTR_ACTIONS:
1185             subactions = a;
1186             break;
1187
1188         case OVS_SAMPLE_ATTR_UNSPEC:
1189         case __OVS_SAMPLE_ATTR_MAX:
1190         default:
1191             NOT_REACHED();
1192         }
1193     }
1194
1195     dp_netdev_execute_actions(dp, packet, key, nl_attr_get(subactions),
1196                               nl_attr_get_size(subactions));
1197 }
1198
1199 static void
1200 dp_netdev_action_userspace(struct dp_netdev *dp,
1201                           struct ofpbuf *packet, const struct flow *key,
1202                           const struct nlattr *a)
1203 {
1204     const struct nlattr *userdata;
1205
1206     userdata = nl_attr_find_nested(a, OVS_USERSPACE_ATTR_USERDATA);
1207     dp_netdev_output_userspace(dp, packet, DPIF_UC_ACTION, key, userdata);
1208 }
1209
1210 static void
1211 execute_set_action(struct ofpbuf *packet, const struct nlattr *a)
1212 {
1213     enum ovs_key_attr type = nl_attr_type(a);
1214     const struct ovs_key_ipv4 *ipv4_key;
1215     const struct ovs_key_ipv6 *ipv6_key;
1216     const struct ovs_key_tcp *tcp_key;
1217     const struct ovs_key_udp *udp_key;
1218
1219     switch (type) {
1220     case OVS_KEY_ATTR_PRIORITY:
1221     case OVS_KEY_ATTR_SKB_MARK:
1222     case OVS_KEY_ATTR_TUNNEL:
1223         /* not implemented */
1224         break;
1225
1226     case OVS_KEY_ATTR_ETHERNET:
1227         dp_netdev_set_dl(packet,
1228                    nl_attr_get_unspec(a, sizeof(struct ovs_key_ethernet)));
1229         break;
1230
1231     case OVS_KEY_ATTR_IPV4:
1232         ipv4_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_ipv4));
1233         packet_set_ipv4(packet, ipv4_key->ipv4_src, ipv4_key->ipv4_dst,
1234                         ipv4_key->ipv4_tos, ipv4_key->ipv4_ttl);
1235         break;
1236
1237     case OVS_KEY_ATTR_IPV6:
1238         ipv6_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_ipv6));
1239         packet_set_ipv6(packet, ipv6_key->ipv6_proto, ipv6_key->ipv6_src,
1240                         ipv6_key->ipv6_dst, ipv6_key->ipv6_tclass,
1241                         ipv6_key->ipv6_label, ipv6_key->ipv6_hlimit);
1242         break;
1243
1244     case OVS_KEY_ATTR_TCP:
1245         tcp_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_tcp));
1246         packet_set_tcp_port(packet, tcp_key->tcp_src, tcp_key->tcp_dst);
1247         break;
1248
1249      case OVS_KEY_ATTR_UDP:
1250         udp_key = nl_attr_get_unspec(a, sizeof(struct ovs_key_udp));
1251         packet_set_udp_port(packet, udp_key->udp_src, udp_key->udp_dst);
1252         break;
1253
1254      case OVS_KEY_ATTR_MPLS:
1255          set_mpls_lse(packet, nl_attr_get_be32(a));
1256          break;
1257
1258      case OVS_KEY_ATTR_UNSPEC:
1259      case OVS_KEY_ATTR_ENCAP:
1260      case OVS_KEY_ATTR_ETHERTYPE:
1261      case OVS_KEY_ATTR_IN_PORT:
1262      case OVS_KEY_ATTR_VLAN:
1263      case OVS_KEY_ATTR_ICMP:
1264      case OVS_KEY_ATTR_ICMPV6:
1265      case OVS_KEY_ATTR_ARP:
1266      case OVS_KEY_ATTR_ND:
1267      case __OVS_KEY_ATTR_MAX:
1268      default:
1269         NOT_REACHED();
1270     }
1271 }
1272
1273 static void
1274 dp_netdev_execute_actions(struct dp_netdev *dp,
1275                           struct ofpbuf *packet, struct flow *key,
1276                           const struct nlattr *actions,
1277                           size_t actions_len)
1278 {
1279     const struct nlattr *a;
1280     unsigned int left;
1281
1282     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
1283         int type = nl_attr_type(a);
1284
1285         switch ((enum ovs_action_attr) type) {
1286         case OVS_ACTION_ATTR_OUTPUT:
1287             dp_netdev_output_port(dp, packet, nl_attr_get_u32(a));
1288             break;
1289
1290         case OVS_ACTION_ATTR_USERSPACE:
1291             dp_netdev_action_userspace(dp, packet, key, a);
1292             break;
1293
1294         case OVS_ACTION_ATTR_PUSH_VLAN: {
1295             const struct ovs_action_push_vlan *vlan = nl_attr_get(a);
1296             eth_push_vlan(packet, vlan->vlan_tci);
1297             break;
1298         }
1299
1300         case OVS_ACTION_ATTR_POP_VLAN:
1301             eth_pop_vlan(packet);
1302             break;
1303
1304         case OVS_ACTION_ATTR_PUSH_MPLS: {
1305             const struct ovs_action_push_mpls *mpls = nl_attr_get(a);
1306             push_mpls(packet, mpls->mpls_ethertype, mpls->mpls_lse);
1307             break;
1308          }
1309
1310         case OVS_ACTION_ATTR_POP_MPLS:
1311             pop_mpls(packet, nl_attr_get_be16(a));
1312             break;
1313
1314         case OVS_ACTION_ATTR_SET:
1315             execute_set_action(packet, nl_attr_get(a));
1316             break;
1317
1318         case OVS_ACTION_ATTR_SAMPLE:
1319             dp_netdev_sample(dp, packet, key, a);
1320             break;
1321
1322         case OVS_ACTION_ATTR_UNSPEC:
1323         case __OVS_ACTION_ATTR_MAX:
1324             NOT_REACHED();
1325         }
1326     }
1327 }
1328
1329 const struct dpif_class dpif_netdev_class = {
1330     "netdev",
1331     dpif_netdev_enumerate,
1332     dpif_netdev_port_open_type,
1333     dpif_netdev_open,
1334     dpif_netdev_close,
1335     dpif_netdev_destroy,
1336     dpif_netdev_run,
1337     dpif_netdev_wait,
1338     dpif_netdev_get_stats,
1339     dpif_netdev_port_add,
1340     dpif_netdev_port_del,
1341     dpif_netdev_port_query_by_number,
1342     dpif_netdev_port_query_by_name,
1343     dpif_netdev_get_max_ports,
1344     NULL,                       /* port_get_pid */
1345     dpif_netdev_port_dump_start,
1346     dpif_netdev_port_dump_next,
1347     dpif_netdev_port_dump_done,
1348     dpif_netdev_port_poll,
1349     dpif_netdev_port_poll_wait,
1350     dpif_netdev_flow_get,
1351     dpif_netdev_flow_put,
1352     dpif_netdev_flow_del,
1353     dpif_netdev_flow_flush,
1354     dpif_netdev_flow_dump_start,
1355     dpif_netdev_flow_dump_next,
1356     dpif_netdev_flow_dump_done,
1357     dpif_netdev_execute,
1358     NULL,                       /* operate */
1359     dpif_netdev_recv_set,
1360     dpif_netdev_queue_to_priority,
1361     dpif_netdev_recv,
1362     dpif_netdev_recv_wait,
1363     dpif_netdev_recv_purge,
1364 };
1365
1366 static void
1367 dpif_dummy_register__(const char *type)
1368 {
1369     struct dpif_class *class;
1370
1371     class = xmalloc(sizeof *class);
1372     *class = dpif_netdev_class;
1373     class->type = xstrdup(type);
1374     dp_register_provider(class);
1375 }
1376
1377 void
1378 dpif_dummy_register(bool override)
1379 {
1380     if (override) {
1381         struct sset types;
1382         const char *type;
1383
1384         sset_init(&types);
1385         dp_enumerate_types(&types);
1386         SSET_FOR_EACH (type, &types) {
1387             if (!dp_unregister_provider(type)) {
1388                 dpif_dummy_register__(type);
1389             }
1390         }
1391         sset_destroy(&types);
1392     }
1393
1394     dpif_dummy_register__("dummy");
1395 }