e6b97fa446aab19729d538bafe1f6fd96cd66ecb
[cascardo/ovs.git] / lib / netdev-vport.c
1 /*
2  * Copyright (c) 2010, 2011, 2012, 2013, 2014 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
19 #include "netdev-vport.h"
20
21 #include <errno.h>
22 #include <fcntl.h>
23 #include <sys/socket.h>
24 #include <net/if.h>
25 #include <sys/ioctl.h>
26
27 #include "byte-order.h"
28 #include "csum.h"
29 #include "daemon.h"
30 #include "dirs.h"
31 #include "dpif.h"
32 #include "dynamic-string.h"
33 #include "flow.h"
34 #include "hash.h"
35 #include "hmap.h"
36 #include "list.h"
37 #include "netdev-provider.h"
38 #include "odp-netlink.h"
39 #include "ofpbuf.h"
40 #include "ovs-router.h"
41 #include "packets.h"
42 #include "packet-dpif.h"
43 #include "poll-loop.h"
44 #include "route-table.h"
45 #include "shash.h"
46 #include "socket-util.h"
47 #include "vlog.h"
48 #include "unaligned.h"
49 #include "unixctl.h"
50 #include "util.h"
51
52 VLOG_DEFINE_THIS_MODULE(netdev_vport);
53 static struct vlog_rate_limit err_rl = VLOG_RATE_LIMIT_INIT(60, 5);
54
55 #define GENEVE_DST_PORT 6081
56 #define VXLAN_DST_PORT 4789
57 #define LISP_DST_PORT 4341
58
59 #define VXLAN_HLEN   (sizeof(struct eth_header) +         \
60                       sizeof(struct ip_header)  +         \
61                       sizeof(struct udp_header) +         \
62                       sizeof(struct vxlanhdr))
63
64 #define DEFAULT_TTL 64
65
66 struct netdev_vport {
67     struct netdev up;
68
69     /* Protects all members below. */
70     struct ovs_mutex mutex;
71
72     uint8_t etheraddr[ETH_ADDR_LEN];
73     struct netdev_stats stats;
74
75     /* Tunnels. */
76     struct netdev_tunnel_config tnl_cfg;
77     char egress_iface[IFNAMSIZ];
78     bool carrier_status;
79
80     /* Patch Ports. */
81     char *peer;
82 };
83
84 struct vport_class {
85     const char *dpif_port;
86     struct netdev_class netdev_class;
87 };
88
89 /* Last read of the route-table's change number. */
90 static uint64_t rt_change_seqno;
91
92 static int netdev_vport_construct(struct netdev *);
93 static int get_patch_config(const struct netdev *netdev, struct smap *args);
94 static int get_tunnel_config(const struct netdev *, struct smap *args);
95 static bool tunnel_check_status_change__(struct netdev_vport *);
96
97 static uint16_t tnl_udp_port_min = 32768;
98 static uint16_t tnl_udp_port_max = 61000;
99
100 static bool
101 is_vport_class(const struct netdev_class *class)
102 {
103     return class->construct == netdev_vport_construct;
104 }
105
106 bool
107 netdev_vport_is_vport_class(const struct netdev_class *class)
108 {
109     return is_vport_class(class);
110 }
111
112 static const struct vport_class *
113 vport_class_cast(const struct netdev_class *class)
114 {
115     ovs_assert(is_vport_class(class));
116     return CONTAINER_OF(class, struct vport_class, netdev_class);
117 }
118
119 static struct netdev_vport *
120 netdev_vport_cast(const struct netdev *netdev)
121 {
122     ovs_assert(is_vport_class(netdev_get_class(netdev)));
123     return CONTAINER_OF(netdev, struct netdev_vport, up);
124 }
125
126 static const struct netdev_tunnel_config *
127 get_netdev_tunnel_config(const struct netdev *netdev)
128 {
129     return &netdev_vport_cast(netdev)->tnl_cfg;
130 }
131
132 bool
133 netdev_vport_is_patch(const struct netdev *netdev)
134 {
135     const struct netdev_class *class = netdev_get_class(netdev);
136
137     return class->get_config == get_patch_config;
138 }
139
140 bool
141 netdev_vport_is_layer3(const struct netdev *dev)
142 {
143     const char *type = netdev_get_type(dev);
144
145     return (!strcmp("lisp", type));
146 }
147
148 static bool
149 netdev_vport_needs_dst_port(const struct netdev *dev)
150 {
151     const struct netdev_class *class = netdev_get_class(dev);
152     const char *type = netdev_get_type(dev);
153
154     return (class->get_config == get_tunnel_config &&
155             (!strcmp("geneve", type) || !strcmp("vxlan", type) ||
156              !strcmp("lisp", type)));
157 }
158
159 const char *
160 netdev_vport_class_get_dpif_port(const struct netdev_class *class)
161 {
162     return is_vport_class(class) ? vport_class_cast(class)->dpif_port : NULL;
163 }
164
165 const char *
166 netdev_vport_get_dpif_port(const struct netdev *netdev,
167                            char namebuf[], size_t bufsize)
168 {
169     const struct netdev_class *class = netdev_get_class(netdev);
170     const char *dpif_port = netdev_vport_class_get_dpif_port(class);
171
172     if (!dpif_port) {
173         return netdev_get_name(netdev);
174     }
175
176     if (netdev_vport_needs_dst_port(netdev)) {
177         const struct netdev_vport *vport = netdev_vport_cast(netdev);
178
179         /*
180          * Note: IFNAMSIZ is 16 bytes long. Implementations should choose
181          * a dpif port name that is short enough to fit including any
182          * port numbers but assert just in case.
183          */
184         BUILD_ASSERT(NETDEV_VPORT_NAME_BUFSIZE >= IFNAMSIZ);
185         ovs_assert(strlen(dpif_port) + 6 < IFNAMSIZ);
186         snprintf(namebuf, bufsize, "%s_%d", dpif_port,
187                  ntohs(vport->tnl_cfg.dst_port));
188         return namebuf;
189     } else {
190         return dpif_port;
191     }
192 }
193
194 char *
195 netdev_vport_get_dpif_port_strdup(const struct netdev *netdev)
196 {
197     char namebuf[NETDEV_VPORT_NAME_BUFSIZE];
198
199     return xstrdup(netdev_vport_get_dpif_port(netdev, namebuf,
200                                               sizeof namebuf));
201 }
202
203 /* Whenever the route-table change number is incremented,
204  * netdev_vport_route_changed() should be called to update
205  * the corresponding tunnel interface status. */
206 static void
207 netdev_vport_route_changed(void)
208 {
209     struct netdev **vports;
210     size_t i, n_vports;
211
212     vports = netdev_get_vports(&n_vports);
213     for (i = 0; i < n_vports; i++) {
214         struct netdev *netdev_ = vports[i];
215         struct netdev_vport *netdev = netdev_vport_cast(netdev_);
216
217         ovs_mutex_lock(&netdev->mutex);
218         /* Finds all tunnel vports. */
219         if (netdev->tnl_cfg.ip_dst) {
220             if (tunnel_check_status_change__(netdev)) {
221                 netdev_change_seq_changed(netdev_);
222             }
223         }
224         ovs_mutex_unlock(&netdev->mutex);
225
226         netdev_close(netdev_);
227     }
228
229     free(vports);
230 }
231
232 static struct netdev *
233 netdev_vport_alloc(void)
234 {
235     struct netdev_vport *netdev = xzalloc(sizeof *netdev);
236     return &netdev->up;
237 }
238
239 static int
240 netdev_vport_construct(struct netdev *netdev_)
241 {
242     struct netdev_vport *dev = netdev_vport_cast(netdev_);
243     const char *type = netdev_get_type(netdev_);
244
245     ovs_mutex_init(&dev->mutex);
246     eth_addr_random(dev->etheraddr);
247
248     /* Add a default destination port for tunnel ports if none specified. */
249     if (!strcmp(type, "geneve")) {
250         dev->tnl_cfg.dst_port = htons(GENEVE_DST_PORT);
251     } else if (!strcmp(type, "vxlan")) {
252         dev->tnl_cfg.dst_port = htons(VXLAN_DST_PORT);
253     } else if (!strcmp(type, "lisp")) {
254         dev->tnl_cfg.dst_port = htons(LISP_DST_PORT);
255     }
256
257     return 0;
258 }
259
260 static void
261 netdev_vport_destruct(struct netdev *netdev_)
262 {
263     struct netdev_vport *netdev = netdev_vport_cast(netdev_);
264
265     free(netdev->peer);
266     ovs_mutex_destroy(&netdev->mutex);
267 }
268
269 static void
270 netdev_vport_dealloc(struct netdev *netdev_)
271 {
272     struct netdev_vport *netdev = netdev_vport_cast(netdev_);
273     free(netdev);
274 }
275
276 static int
277 netdev_vport_set_etheraddr(struct netdev *netdev_,
278                            const uint8_t mac[ETH_ADDR_LEN])
279 {
280     struct netdev_vport *netdev = netdev_vport_cast(netdev_);
281
282     ovs_mutex_lock(&netdev->mutex);
283     memcpy(netdev->etheraddr, mac, ETH_ADDR_LEN);
284     ovs_mutex_unlock(&netdev->mutex);
285     netdev_change_seq_changed(netdev_);
286
287     return 0;
288 }
289
290 static int
291 netdev_vport_get_etheraddr(const struct netdev *netdev_,
292                            uint8_t mac[ETH_ADDR_LEN])
293 {
294     struct netdev_vport *netdev = netdev_vport_cast(netdev_);
295
296     ovs_mutex_lock(&netdev->mutex);
297     memcpy(mac, netdev->etheraddr, ETH_ADDR_LEN);
298     ovs_mutex_unlock(&netdev->mutex);
299
300     return 0;
301 }
302
303 /* Checks if the tunnel status has changed and returns a boolean.
304  * Updates the tunnel status if it has changed. */
305 static bool
306 tunnel_check_status_change__(struct netdev_vport *netdev)
307     OVS_REQUIRES(netdev->mutex)
308 {
309     char iface[IFNAMSIZ];
310     bool status = false;
311     ovs_be32 route;
312     ovs_be32 gw;
313
314     iface[0] = '\0';
315     route = netdev->tnl_cfg.ip_dst;
316     if (ovs_router_lookup(route, iface, &gw)) {
317         struct netdev *egress_netdev;
318
319         if (!netdev_open(iface, "system", &egress_netdev)) {
320             status = netdev_get_carrier(egress_netdev);
321             netdev_close(egress_netdev);
322         }
323     }
324
325     if (strcmp(netdev->egress_iface, iface)
326         || netdev->carrier_status != status) {
327         ovs_strlcpy(netdev->egress_iface, iface, IFNAMSIZ);
328         netdev->carrier_status = status;
329
330         return true;
331     }
332
333     return false;
334 }
335
336 static int
337 tunnel_get_status(const struct netdev *netdev_, struct smap *smap)
338 {
339     struct netdev_vport *netdev = netdev_vport_cast(netdev_);
340
341     if (netdev->egress_iface[0]) {
342         smap_add(smap, "tunnel_egress_iface", netdev->egress_iface);
343
344         smap_add(smap, "tunnel_egress_iface_carrier",
345                  netdev->carrier_status ? "up" : "down");
346     }
347
348     return 0;
349 }
350
351 static int
352 netdev_vport_update_flags(struct netdev *netdev OVS_UNUSED,
353                           enum netdev_flags off,
354                           enum netdev_flags on OVS_UNUSED,
355                           enum netdev_flags *old_flagsp)
356 {
357     if (off & (NETDEV_UP | NETDEV_PROMISC)) {
358         return EOPNOTSUPP;
359     }
360
361     *old_flagsp = NETDEV_UP | NETDEV_PROMISC;
362     return 0;
363 }
364
365 static void
366 netdev_vport_run(void)
367 {
368     uint64_t seq;
369
370     route_table_run();
371     seq = route_table_get_change_seq();
372     if (rt_change_seqno != seq) {
373         rt_change_seqno = seq;
374         netdev_vport_route_changed();
375     }
376 }
377
378 static void
379 netdev_vport_wait(void)
380 {
381     uint64_t seq;
382
383     route_table_wait();
384     seq = route_table_get_change_seq();
385     if (rt_change_seqno != seq) {
386         poll_immediate_wake();
387     }
388 }
389 \f
390 /* Code specific to tunnel types. */
391
392 static ovs_be64
393 parse_key(const struct smap *args, const char *name,
394           bool *present, bool *flow)
395 {
396     const char *s;
397
398     *present = false;
399     *flow = false;
400
401     s = smap_get(args, name);
402     if (!s) {
403         s = smap_get(args, "key");
404         if (!s) {
405             return 0;
406         }
407     }
408
409     *present = true;
410
411     if (!strcmp(s, "flow")) {
412         *flow = true;
413         return 0;
414     } else {
415         return htonll(strtoull(s, NULL, 0));
416     }
417 }
418
419 static int
420 set_tunnel_config(struct netdev *dev_, const struct smap *args)
421 {
422     struct netdev_vport *dev = netdev_vport_cast(dev_);
423     const char *name = netdev_get_name(dev_);
424     const char *type = netdev_get_type(dev_);
425     bool ipsec_mech_set, needs_dst_port, has_csum;
426     struct netdev_tunnel_config tnl_cfg;
427     struct smap_node *node;
428
429     has_csum = strstr(type, "gre");
430     ipsec_mech_set = false;
431     memset(&tnl_cfg, 0, sizeof tnl_cfg);
432
433     /* Add a default destination port for tunnel ports if none specified. */
434     if (!strcmp(type, "geneve")) {
435         tnl_cfg.dst_port = htons(GENEVE_DST_PORT);
436     }
437
438     if (!strcmp(type, "vxlan")) {
439         tnl_cfg.dst_port = htons(VXLAN_DST_PORT);
440     }
441
442     if (!strcmp(type, "lisp")) {
443         tnl_cfg.dst_port = htons(LISP_DST_PORT);
444     }
445
446     needs_dst_port = netdev_vport_needs_dst_port(dev_);
447     tnl_cfg.ipsec = strstr(type, "ipsec");
448     tnl_cfg.dont_fragment = true;
449
450     SMAP_FOR_EACH (node, args) {
451         if (!strcmp(node->key, "remote_ip")) {
452             struct in_addr in_addr;
453             if (!strcmp(node->value, "flow")) {
454                 tnl_cfg.ip_dst_flow = true;
455                 tnl_cfg.ip_dst = htonl(0);
456             } else if (lookup_ip(node->value, &in_addr)) {
457                 VLOG_WARN("%s: bad %s 'remote_ip'", name, type);
458             } else if (ip_is_multicast(in_addr.s_addr)) {
459                 VLOG_WARN("%s: multicast remote_ip="IP_FMT" not allowed",
460                           name, IP_ARGS(in_addr.s_addr));
461                 return EINVAL;
462             } else {
463                 tnl_cfg.ip_dst = in_addr.s_addr;
464             }
465         } else if (!strcmp(node->key, "local_ip")) {
466             struct in_addr in_addr;
467             if (!strcmp(node->value, "flow")) {
468                 tnl_cfg.ip_src_flow = true;
469                 tnl_cfg.ip_src = htonl(0);
470             } else if (lookup_ip(node->value, &in_addr)) {
471                 VLOG_WARN("%s: bad %s 'local_ip'", name, type);
472             } else {
473                 tnl_cfg.ip_src = in_addr.s_addr;
474             }
475         } else if (!strcmp(node->key, "tos")) {
476             if (!strcmp(node->value, "inherit")) {
477                 tnl_cfg.tos_inherit = true;
478             } else {
479                 char *endptr;
480                 int tos;
481                 tos = strtol(node->value, &endptr, 0);
482                 if (*endptr == '\0' && tos == (tos & IP_DSCP_MASK)) {
483                     tnl_cfg.tos = tos;
484                 } else {
485                     VLOG_WARN("%s: invalid TOS %s", name, node->value);
486                 }
487             }
488         } else if (!strcmp(node->key, "ttl")) {
489             if (!strcmp(node->value, "inherit")) {
490                 tnl_cfg.ttl_inherit = true;
491             } else {
492                 tnl_cfg.ttl = atoi(node->value);
493             }
494         } else if (!strcmp(node->key, "dst_port") && needs_dst_port) {
495             tnl_cfg.dst_port = htons(atoi(node->value));
496         } else if (!strcmp(node->key, "csum") && has_csum) {
497             if (!strcmp(node->value, "true")) {
498                 tnl_cfg.csum = true;
499             }
500         } else if (!strcmp(node->key, "df_default")) {
501             if (!strcmp(node->value, "false")) {
502                 tnl_cfg.dont_fragment = false;
503             }
504         } else if (!strcmp(node->key, "peer_cert") && tnl_cfg.ipsec) {
505             if (smap_get(args, "certificate")) {
506                 ipsec_mech_set = true;
507             } else {
508                 const char *use_ssl_cert;
509
510                 /* If the "use_ssl_cert" is true, then "certificate" and
511                  * "private_key" will be pulled from the SSL table.  The
512                  * use of this option is strongly discouraged, since it
513                  * will like be removed when multiple SSL configurations
514                  * are supported by OVS.
515                  */
516                 use_ssl_cert = smap_get(args, "use_ssl_cert");
517                 if (!use_ssl_cert || strcmp(use_ssl_cert, "true")) {
518                     VLOG_ERR("%s: 'peer_cert' requires 'certificate' argument",
519                              name);
520                     return EINVAL;
521                 }
522                 ipsec_mech_set = true;
523             }
524         } else if (!strcmp(node->key, "psk") && tnl_cfg.ipsec) {
525             ipsec_mech_set = true;
526         } else if (tnl_cfg.ipsec
527                 && (!strcmp(node->key, "certificate")
528                     || !strcmp(node->key, "private_key")
529                     || !strcmp(node->key, "use_ssl_cert"))) {
530             /* Ignore options not used by the netdev. */
531         } else if (!strcmp(node->key, "key") ||
532                    !strcmp(node->key, "in_key") ||
533                    !strcmp(node->key, "out_key")) {
534             /* Handled separately below. */
535         } else {
536             VLOG_WARN("%s: unknown %s argument '%s'", name, type, node->key);
537         }
538     }
539
540     if (tnl_cfg.ipsec) {
541         static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
542         static pid_t pid = 0;
543
544 #ifndef _WIN32
545         ovs_mutex_lock(&mutex);
546         if (pid <= 0) {
547             char *file_name = xasprintf("%s/%s", ovs_rundir(),
548                                         "ovs-monitor-ipsec.pid");
549             pid = read_pidfile(file_name);
550             free(file_name);
551         }
552         ovs_mutex_unlock(&mutex);
553 #endif
554
555         if (pid < 0) {
556             VLOG_ERR("%s: IPsec requires the ovs-monitor-ipsec daemon",
557                      name);
558             return EINVAL;
559         }
560
561         if (smap_get(args, "peer_cert") && smap_get(args, "psk")) {
562             VLOG_ERR("%s: cannot define both 'peer_cert' and 'psk'", name);
563             return EINVAL;
564         }
565
566         if (!ipsec_mech_set) {
567             VLOG_ERR("%s: IPsec requires an 'peer_cert' or psk' argument",
568                      name);
569             return EINVAL;
570         }
571     }
572
573     if (!tnl_cfg.ip_dst && !tnl_cfg.ip_dst_flow) {
574         VLOG_ERR("%s: %s type requires valid 'remote_ip' argument",
575                  name, type);
576         return EINVAL;
577     }
578     if (tnl_cfg.ip_src_flow && !tnl_cfg.ip_dst_flow) {
579         VLOG_ERR("%s: %s type requires 'remote_ip=flow' with 'local_ip=flow'",
580                  name, type);
581         return EINVAL;
582     }
583     if (!tnl_cfg.ttl) {
584         tnl_cfg.ttl = DEFAULT_TTL;
585     }
586
587     tnl_cfg.in_key = parse_key(args, "in_key",
588                                &tnl_cfg.in_key_present,
589                                &tnl_cfg.in_key_flow);
590
591     tnl_cfg.out_key = parse_key(args, "out_key",
592                                &tnl_cfg.out_key_present,
593                                &tnl_cfg.out_key_flow);
594
595     ovs_mutex_lock(&dev->mutex);
596     dev->tnl_cfg = tnl_cfg;
597     tunnel_check_status_change__(dev);
598     netdev_change_seq_changed(dev_);
599     ovs_mutex_unlock(&dev->mutex);
600
601     return 0;
602 }
603
604 static int
605 get_tunnel_config(const struct netdev *dev, struct smap *args)
606 {
607     struct netdev_vport *netdev = netdev_vport_cast(dev);
608     struct netdev_tunnel_config tnl_cfg;
609
610     ovs_mutex_lock(&netdev->mutex);
611     tnl_cfg = netdev->tnl_cfg;
612     ovs_mutex_unlock(&netdev->mutex);
613
614     if (tnl_cfg.ip_dst) {
615         smap_add_format(args, "remote_ip", IP_FMT, IP_ARGS(tnl_cfg.ip_dst));
616     } else if (tnl_cfg.ip_dst_flow) {
617         smap_add(args, "remote_ip", "flow");
618     }
619
620     if (tnl_cfg.ip_src) {
621         smap_add_format(args, "local_ip", IP_FMT, IP_ARGS(tnl_cfg.ip_src));
622     } else if (tnl_cfg.ip_src_flow) {
623         smap_add(args, "local_ip", "flow");
624     }
625
626     if (tnl_cfg.in_key_flow && tnl_cfg.out_key_flow) {
627         smap_add(args, "key", "flow");
628     } else if (tnl_cfg.in_key_present && tnl_cfg.out_key_present
629                && tnl_cfg.in_key == tnl_cfg.out_key) {
630         smap_add_format(args, "key", "%"PRIu64, ntohll(tnl_cfg.in_key));
631     } else {
632         if (tnl_cfg.in_key_flow) {
633             smap_add(args, "in_key", "flow");
634         } else if (tnl_cfg.in_key_present) {
635             smap_add_format(args, "in_key", "%"PRIu64,
636                             ntohll(tnl_cfg.in_key));
637         }
638
639         if (tnl_cfg.out_key_flow) {
640             smap_add(args, "out_key", "flow");
641         } else if (tnl_cfg.out_key_present) {
642             smap_add_format(args, "out_key", "%"PRIu64,
643                             ntohll(tnl_cfg.out_key));
644         }
645     }
646
647     if (tnl_cfg.ttl_inherit) {
648         smap_add(args, "ttl", "inherit");
649     } else if (tnl_cfg.ttl != DEFAULT_TTL) {
650         smap_add_format(args, "ttl", "%"PRIu8, tnl_cfg.ttl);
651     }
652
653     if (tnl_cfg.tos_inherit) {
654         smap_add(args, "tos", "inherit");
655     } else if (tnl_cfg.tos) {
656         smap_add_format(args, "tos", "0x%x", tnl_cfg.tos);
657     }
658
659     if (tnl_cfg.dst_port) {
660         uint16_t dst_port = ntohs(tnl_cfg.dst_port);
661         const char *type = netdev_get_type(dev);
662
663         if ((!strcmp("geneve", type) && dst_port != GENEVE_DST_PORT) ||
664             (!strcmp("vxlan", type) && dst_port != VXLAN_DST_PORT) ||
665             (!strcmp("lisp", type) && dst_port != LISP_DST_PORT)) {
666             smap_add_format(args, "dst_port", "%d", dst_port);
667         }
668     }
669
670     if (tnl_cfg.csum) {
671         smap_add(args, "csum", "true");
672     }
673
674     if (!tnl_cfg.dont_fragment) {
675         smap_add(args, "df_default", "false");
676     }
677
678     return 0;
679 }
680 \f
681 /* Code specific to patch ports. */
682
683 /* If 'netdev' is a patch port, returns the name of its peer as a malloc()'d
684  * string that the caller must free.
685  *
686  * If 'netdev' is not a patch port, returns NULL. */
687 char *
688 netdev_vport_patch_peer(const struct netdev *netdev_)
689 {
690     char *peer = NULL;
691
692     if (netdev_vport_is_patch(netdev_)) {
693         struct netdev_vport *netdev = netdev_vport_cast(netdev_);
694
695         ovs_mutex_lock(&netdev->mutex);
696         if (netdev->peer) {
697             peer = xstrdup(netdev->peer);
698         }
699         ovs_mutex_unlock(&netdev->mutex);
700     }
701
702     return peer;
703 }
704
705 void
706 netdev_vport_inc_rx(const struct netdev *netdev,
707                     const struct dpif_flow_stats *stats)
708 {
709     if (is_vport_class(netdev_get_class(netdev))) {
710         struct netdev_vport *dev = netdev_vport_cast(netdev);
711
712         ovs_mutex_lock(&dev->mutex);
713         dev->stats.rx_packets += stats->n_packets;
714         dev->stats.rx_bytes += stats->n_bytes;
715         ovs_mutex_unlock(&dev->mutex);
716     }
717 }
718
719 void
720 netdev_vport_inc_tx(const struct netdev *netdev,
721                     const struct dpif_flow_stats *stats)
722 {
723     if (is_vport_class(netdev_get_class(netdev))) {
724         struct netdev_vport *dev = netdev_vport_cast(netdev);
725
726         ovs_mutex_lock(&dev->mutex);
727         dev->stats.tx_packets += stats->n_packets;
728         dev->stats.tx_bytes += stats->n_bytes;
729         ovs_mutex_unlock(&dev->mutex);
730     }
731 }
732
733 static int
734 get_patch_config(const struct netdev *dev_, struct smap *args)
735 {
736     struct netdev_vport *dev = netdev_vport_cast(dev_);
737
738     ovs_mutex_lock(&dev->mutex);
739     if (dev->peer) {
740         smap_add(args, "peer", dev->peer);
741     }
742     ovs_mutex_unlock(&dev->mutex);
743
744     return 0;
745 }
746
747 static int
748 set_patch_config(struct netdev *dev_, const struct smap *args)
749 {
750     struct netdev_vport *dev = netdev_vport_cast(dev_);
751     const char *name = netdev_get_name(dev_);
752     const char *peer;
753
754     peer = smap_get(args, "peer");
755     if (!peer) {
756         VLOG_ERR("%s: patch type requires valid 'peer' argument", name);
757         return EINVAL;
758     }
759
760     if (smap_count(args) > 1) {
761         VLOG_ERR("%s: patch type takes only a 'peer' argument", name);
762         return EINVAL;
763     }
764
765     if (!strcmp(name, peer)) {
766         VLOG_ERR("%s: patch peer must not be self", name);
767         return EINVAL;
768     }
769
770     ovs_mutex_lock(&dev->mutex);
771     free(dev->peer);
772     dev->peer = xstrdup(peer);
773     netdev_change_seq_changed(dev_);
774     ovs_mutex_unlock(&dev->mutex);
775
776     return 0;
777 }
778
779 static int
780 get_stats(const struct netdev *netdev, struct netdev_stats *stats)
781 {
782     struct netdev_vport *dev = netdev_vport_cast(netdev);
783
784     ovs_mutex_lock(&dev->mutex);
785     *stats = dev->stats;
786     ovs_mutex_unlock(&dev->mutex);
787
788     return 0;
789 }
790
791 \f
792 /* Tunnel push pop ops. */
793
794 static struct ip_header *
795 ip_hdr(void *eth)
796 {
797     return (void *)((char *)eth + sizeof (struct eth_header));
798 }
799
800 static struct gre_base_hdr *
801 gre_hdr(struct ip_header *ip)
802 {
803      return (void *)((char *)ip + sizeof (struct ip_header));
804 }
805
806 static void *
807 ip_extract_tnl_md(struct ofpbuf *packet, struct flow_tnl *tnl)
808 {
809     struct ip_header *nh;
810     void *l4;
811
812     nh = ofpbuf_l3(packet);
813     l4 = ofpbuf_l4(packet);
814
815     if (!nh || !l4) {
816         return NULL;
817     }
818
819     tnl->ip_src = get_16aligned_be32(&nh->ip_src);
820     tnl->ip_dst = get_16aligned_be32(&nh->ip_dst);
821     tnl->ip_tos = nh->ip_tos;
822
823     return l4;
824 }
825
826 /* Pushes the 'size' bytes of 'header' into the headroom of 'packet',
827  * reallocating the packet if necessary.  'header' should contain an Ethernet
828  * header, followed by an IPv4 header (without options), and an L4 header.
829  *
830  * This function sets the IP header's ip_tot_len field (which should be zeroed
831  * as part of 'header') and puts its value into '*ip_tot_size' as well.  Also
832  * updates IP header checksum.
833  *
834  * Return pointer to the L4 header added to 'packet'. */
835 static void *
836 push_ip_header(struct ofpbuf *packet,
837                const void *header, int size, int *ip_tot_size)
838 {
839     struct eth_header *eth;
840     struct ip_header *ip;
841
842     eth = ofpbuf_push_uninit(packet, size);
843     *ip_tot_size = ofpbuf_size(packet) - sizeof (struct eth_header);
844
845     memcpy(eth, header, size);
846     ip = ip_hdr(eth);
847     ip->ip_tot_len = htons(*ip_tot_size);
848
849
850     ip->ip_csum = recalc_csum16(ip->ip_csum, 0, ip->ip_tot_len);
851
852     return ip + 1;
853 }
854
855 static int
856 gre_header_len(ovs_be16 flags)
857 {
858     int hlen = sizeof(struct eth_header) +
859                sizeof(struct ip_header) + 4;
860
861     if (flags & htons(GRE_CSUM)) {
862         hlen += 4;
863     }
864     if (flags & htons(GRE_KEY)) {
865         hlen += 4;
866     }
867     if (flags & htons(GRE_SEQ)) {
868         hlen += 4;
869     }
870     return hlen;
871 }
872
873 static int
874 parse_gre_header(struct ofpbuf *packet,
875                  struct flow_tnl *tnl)
876 {
877     const struct gre_base_hdr *greh;
878     ovs_16aligned_be32 *options;
879     int hlen;
880
881     greh = ip_extract_tnl_md(packet, tnl);
882     if (!greh) {
883         return -EINVAL;
884     }
885
886     if (greh->flags & ~(htons(GRE_CSUM | GRE_KEY | GRE_SEQ))) {
887         return -EINVAL;
888     }
889
890     hlen = gre_header_len(greh->flags);
891     if (hlen > ofpbuf_size(packet)) {
892         return -EINVAL;
893     }
894
895     options = (ovs_16aligned_be32 *)(greh + 1);
896     if (greh->flags & htons(GRE_CSUM)) {
897         ovs_be16 pkt_csum;
898
899         pkt_csum = csum(greh, ofpbuf_size(packet) -
900                               ((const unsigned char *)greh -
901                                (const unsigned char *)ofpbuf_l2(packet)));
902         if (pkt_csum) {
903             return -EINVAL;
904         }
905         tnl->flags = FLOW_TNL_F_CSUM;
906         options++;
907     }
908
909     if (greh->flags & htons(GRE_KEY)) {
910         tnl->tun_id = (OVS_FORCE ovs_be64) ((OVS_FORCE uint64_t)(get_16aligned_be32(options)) << 32);
911         tnl->flags |= FLOW_TNL_F_KEY;
912         options++;
913     }
914
915     if (greh->flags & htons(GRE_SEQ)) {
916         options++;
917     }
918
919     return hlen;
920 }
921
922 static void
923 reset_tnl_md(struct pkt_metadata *md)
924 {
925     memset(&md->tunnel, 0, sizeof(md->tunnel));
926 }
927
928 static void
929 gre_extract_md(struct dpif_packet *dpif_pkt)
930 {
931     struct ofpbuf *packet = &dpif_pkt->ofpbuf;
932     struct pkt_metadata *md = &dpif_pkt->md;
933     struct flow_tnl *tnl = &md->tunnel;
934     int hlen = sizeof(struct eth_header) +
935                sizeof(struct ip_header) + 4;
936
937     memset(md, 0, sizeof *md);
938     if (hlen > ofpbuf_size(packet)) {
939         return;
940     }
941
942     hlen = parse_gre_header(packet, tnl);
943     if (hlen < 0) {
944         reset_tnl_md(md);
945     }
946
947     ofpbuf_reset_packet(packet, hlen);
948 }
949
950 static int
951 netdev_gre_pop_header(struct netdev *netdev_ OVS_UNUSED,
952                       struct dpif_packet **pkt, int cnt)
953 {
954     int i;
955
956     for (i = 0; i < cnt; i++) {
957         gre_extract_md(pkt[i]);
958     }
959     return 0;
960 }
961
962 static void
963 netdev_gre_push_header__(struct ofpbuf *packet,
964                          const void *header, int size)
965 {
966     struct gre_base_hdr *greh;
967     int ip_tot_size;
968
969     greh = push_ip_header(packet, header, size,  &ip_tot_size);
970
971     if (greh->flags & htons(GRE_CSUM)) {
972         ovs_16aligned_be32 *options = (ovs_16aligned_be32 *) (greh + 1);
973
974         put_16aligned_be32(options,
975                            (OVS_FORCE ovs_be32) csum(greh, ip_tot_size - sizeof (struct ip_header)));
976     }
977 }
978
979 static int
980 netdev_gre_push_header(const struct netdev *netdev OVS_UNUSED,
981                        struct dpif_packet **packets, int cnt,
982                        const struct ovs_action_push_tnl *data)
983 {
984     int i;
985
986     for (i = 0; i < cnt; i++) {
987         netdev_gre_push_header__(&packets[i]->ofpbuf,
988                                    data->header, data->header_len);
989         packets[i]->md = PKT_METADATA_INITIALIZER(u32_to_odp(data->out_port));
990     }
991     return 0;
992 }
993
994
995 static int
996 netdev_gre_build_header(const struct netdev *netdev,
997                         struct ovs_action_push_tnl *data)
998 {
999     struct netdev_vport *dev = netdev_vport_cast(netdev);
1000     struct netdev_tunnel_config *tnl_cfg;
1001     struct ip_header *ip;
1002     struct gre_base_hdr *greh;
1003     ovs_16aligned_be32 *options;
1004     int hlen;
1005
1006     /* XXX: RCUfy tnl_cfg. */
1007     ovs_mutex_lock(&dev->mutex);
1008     tnl_cfg = &dev->tnl_cfg;
1009
1010     ip = ip_hdr(data->header);
1011     ip->ip_proto = IPPROTO_GRE;
1012
1013     greh = gre_hdr(ip);
1014     greh->protocol = htons(ETH_TYPE_TEB);
1015     greh->flags = 0;
1016
1017     options = (ovs_16aligned_be32 *) (greh + 1);
1018     if (tnl_cfg->csum) {
1019         greh->flags |= htons(GRE_CSUM);
1020         put_16aligned_be32(options, 0);
1021         options++;
1022     }
1023
1024     if (tnl_cfg->out_key_present) {
1025         greh->flags |= htons(GRE_KEY);
1026         put_16aligned_be32(options, (OVS_FORCE ovs_be32)
1027                                     ((OVS_FORCE uint64_t) tnl_cfg->out_key >> 32));
1028         options++;
1029     }
1030
1031     ovs_mutex_unlock(&dev->mutex);
1032
1033     hlen = (uint8_t *) options - (uint8_t *) greh;
1034
1035     data->header_len = sizeof(struct eth_header) +
1036                        sizeof(struct ip_header)  + hlen;
1037     data->tnl_type = OVS_VPORT_TYPE_GRE;
1038     return 0;
1039 }
1040
1041 static void
1042 vxlan_extract_md(struct dpif_packet *dpif_pkt)
1043 {
1044     struct ofpbuf *packet = &dpif_pkt->ofpbuf;
1045     struct pkt_metadata *md = &dpif_pkt->md;
1046     struct flow_tnl *tnl = &md->tunnel;
1047     struct udp_header *udp;
1048     struct vxlanhdr *vxh;
1049
1050     memset(md, 0, sizeof *md);
1051     if (VXLAN_HLEN > ofpbuf_size(packet)) {
1052         return;
1053     }
1054
1055     udp = ip_extract_tnl_md(packet, tnl);
1056     if (!udp) {
1057         return;
1058     }
1059     vxh = (struct vxlanhdr *) (udp + 1);
1060
1061     if (get_16aligned_be32(&vxh->vx_flags) != htonl(VXLAN_FLAGS) ||
1062        (get_16aligned_be32(&vxh->vx_vni) & htonl(0xff))) {
1063         VLOG_WARN_RL(&err_rl, "invalid vxlan flags=%#x vni=%#x\n",
1064                      ntohl(get_16aligned_be32(&vxh->vx_flags)),
1065                      ntohl(get_16aligned_be32(&vxh->vx_vni)));
1066         reset_tnl_md(md);
1067         return;
1068     }
1069     tnl->tp_src = udp->udp_src;
1070     tnl->tp_dst = udp->udp_dst;
1071     tnl->tun_id = htonll(ntohl(get_16aligned_be32(&vxh->vx_vni)) >> 8);
1072
1073     ofpbuf_reset_packet(packet, VXLAN_HLEN);
1074 }
1075
1076 static int
1077 netdev_vxlan_pop_header(struct netdev *netdev_ OVS_UNUSED,
1078                         struct dpif_packet **pkt, int cnt)
1079 {
1080     int i;
1081
1082     for (i = 0; i < cnt; i++) {
1083         vxlan_extract_md(pkt[i]);
1084     }
1085     return 0;
1086 }
1087
1088 static int
1089 netdev_vxlan_build_header(const struct netdev *netdev,
1090                           struct ovs_action_push_tnl *data)
1091 {
1092     struct netdev_vport *dev = netdev_vport_cast(netdev);
1093     struct netdev_tunnel_config *tnl_cfg;
1094     struct ip_header *ip;
1095     struct udp_header *udp;
1096     struct vxlanhdr *vxh;
1097
1098     /* XXX: RCUfy tnl_cfg. */
1099     ovs_mutex_lock(&dev->mutex);
1100     tnl_cfg = &dev->tnl_cfg;
1101
1102     ip = ip_hdr(data->header);
1103     ip->ip_proto = IPPROTO_UDP;
1104
1105     udp = (struct udp_header *) (ip + 1);
1106     udp->udp_dst = tnl_cfg->dst_port;
1107
1108     vxh = (struct vxlanhdr *) (udp + 1);
1109     put_16aligned_be32(&vxh->vx_flags, htonl(VXLAN_FLAGS));
1110     put_16aligned_be32(&vxh->vx_vni, htonl(ntohll(tnl_cfg->out_key) << 8));
1111
1112     ovs_mutex_unlock(&dev->mutex);
1113     data->header_len = VXLAN_HLEN;
1114     data->tnl_type = OVS_VPORT_TYPE_VXLAN;
1115     return 0;
1116 }
1117
1118 static ovs_be16
1119 get_src_port(struct dpif_packet *packet)
1120 {
1121     uint32_t hash;
1122
1123     hash = dpif_packet_get_dp_hash(packet);
1124
1125     return htons((((uint64_t) hash * (tnl_udp_port_max - tnl_udp_port_min)) >> 32) +
1126                  tnl_udp_port_min);
1127 }
1128
1129 static void
1130 netdev_vxlan_push_header__(struct dpif_packet *packet,
1131                            const void *header, int size)
1132 {
1133     struct udp_header *udp;
1134     int ip_tot_size;
1135
1136     udp = push_ip_header(&packet->ofpbuf, header, size, &ip_tot_size);
1137
1138     /* set udp src port */
1139     udp->udp_src = get_src_port(packet);
1140     udp->udp_len = htons(ip_tot_size - sizeof (struct ip_header));
1141     /* udp_csum is zero */
1142 }
1143
1144 static int
1145 netdev_vxlan_push_header(const struct netdev *netdev OVS_UNUSED,
1146                          struct dpif_packet **packets, int cnt,
1147                          const struct ovs_action_push_tnl *data)
1148 {
1149     int i;
1150
1151     for (i = 0; i < cnt; i++) {
1152         netdev_vxlan_push_header__(packets[i],
1153                                    data->header, VXLAN_HLEN);
1154         packets[i]->md = PKT_METADATA_INITIALIZER(u32_to_odp(data->out_port));
1155     }
1156     return 0;
1157 }
1158
1159 static void
1160 netdev_vport_range(struct unixctl_conn *conn, int argc,
1161                    const char *argv[], void *aux OVS_UNUSED)
1162 {
1163     int val1, val2;
1164
1165     if (argc < 3) {
1166         struct ds ds = DS_EMPTY_INITIALIZER;
1167
1168         ds_put_format(&ds, "Tunnel UDP source port range: %"PRIu16"-%"PRIu16"\n",
1169                             tnl_udp_port_min, tnl_udp_port_max);
1170
1171         unixctl_command_reply(conn, ds_cstr(&ds));
1172         ds_destroy(&ds);
1173         return;
1174     }
1175
1176     if (argc != 3) {
1177         return;
1178     }
1179
1180     val1 = atoi(argv[1]);
1181     if (val1 <= 0 || val1 > UINT16_MAX) {
1182         unixctl_command_reply(conn, "Invalid min.");
1183         return;
1184     }
1185     val2 = atoi(argv[2]);
1186     if (val2 <= 0 || val2 > UINT16_MAX) {
1187         unixctl_command_reply(conn, "Invalid max.");
1188         return;
1189     }
1190
1191     if (val1 > val2) {
1192         tnl_udp_port_min = val2;
1193         tnl_udp_port_max = val1;
1194     } else {
1195         tnl_udp_port_min = val1;
1196         tnl_udp_port_max = val2;
1197     }
1198     seq_change(tnl_conf_seq);
1199
1200     unixctl_command_reply(conn, "OK");
1201 }
1202
1203 \f
1204 #define VPORT_FUNCTIONS(GET_CONFIG, SET_CONFIG,             \
1205                         GET_TUNNEL_CONFIG, GET_STATUS,      \
1206                         BUILD_HEADER,                       \
1207                         PUSH_HEADER, POP_HEADER)            \
1208     NULL,                                                   \
1209     netdev_vport_run,                                       \
1210     netdev_vport_wait,                                      \
1211                                                             \
1212     netdev_vport_alloc,                                     \
1213     netdev_vport_construct,                                 \
1214     netdev_vport_destruct,                                  \
1215     netdev_vport_dealloc,                                   \
1216     GET_CONFIG,                                             \
1217     SET_CONFIG,                                             \
1218     GET_TUNNEL_CONFIG,                                      \
1219     BUILD_HEADER,                                           \
1220     PUSH_HEADER,                                            \
1221     POP_HEADER,                                             \
1222     NULL,                       /* get_numa_id */           \
1223     NULL,                       /* set_multiq */            \
1224                                                             \
1225     NULL,                       /* send */                  \
1226     NULL,                       /* send_wait */             \
1227                                                             \
1228     netdev_vport_set_etheraddr,                             \
1229     netdev_vport_get_etheraddr,                             \
1230     NULL,                       /* get_mtu */               \
1231     NULL,                       /* set_mtu */               \
1232     NULL,                       /* get_ifindex */           \
1233     NULL,                       /* get_carrier */           \
1234     NULL,                       /* get_carrier_resets */    \
1235     NULL,                       /* get_miimon */            \
1236     get_stats,                                              \
1237                                                             \
1238     NULL,                       /* get_features */          \
1239     NULL,                       /* set_advertisements */    \
1240                                                             \
1241     NULL,                       /* set_policing */          \
1242     NULL,                       /* get_qos_types */         \
1243     NULL,                       /* get_qos_capabilities */  \
1244     NULL,                       /* get_qos */               \
1245     NULL,                       /* set_qos */               \
1246     NULL,                       /* get_queue */             \
1247     NULL,                       /* set_queue */             \
1248     NULL,                       /* delete_queue */          \
1249     NULL,                       /* get_queue_stats */       \
1250     NULL,                       /* queue_dump_start */      \
1251     NULL,                       /* queue_dump_next */       \
1252     NULL,                       /* queue_dump_done */       \
1253     NULL,                       /* dump_queue_stats */      \
1254                                                             \
1255     NULL,                       /* get_in4 */               \
1256     NULL,                       /* set_in4 */               \
1257     NULL,                       /* get_in6 */               \
1258     NULL,                       /* add_router */            \
1259     NULL,                       /* get_next_hop */          \
1260     GET_STATUS,                                             \
1261     NULL,                       /* arp_lookup */            \
1262                                                             \
1263     netdev_vport_update_flags,                              \
1264                                                             \
1265     NULL,                   /* rx_alloc */                  \
1266     NULL,                   /* rx_construct */              \
1267     NULL,                   /* rx_destruct */               \
1268     NULL,                   /* rx_dealloc */                \
1269     NULL,                   /* rx_recv */                   \
1270     NULL,                   /* rx_wait */                   \
1271     NULL,                   /* rx_drain */
1272
1273
1274 #define TUNNEL_CLASS(NAME, DPIF_PORT, BUILD_HEADER, PUSH_HEADER, POP_HEADER)   \
1275     { DPIF_PORT,                                                               \
1276         { NAME, VPORT_FUNCTIONS(get_tunnel_config,                             \
1277                                 set_tunnel_config,                             \
1278                                 get_netdev_tunnel_config,                      \
1279                                 tunnel_get_status,                             \
1280                                 BUILD_HEADER, PUSH_HEADER, POP_HEADER) }}
1281
1282 void
1283 netdev_vport_tunnel_register(void)
1284 {
1285     /* The name of the dpif_port should be short enough to accomodate adding
1286      * a port number to the end if one is necessary. */
1287     static const struct vport_class vport_classes[] = {
1288         TUNNEL_CLASS("geneve", "genev_sys", NULL, NULL, NULL),
1289         TUNNEL_CLASS("gre", "gre_sys", netdev_gre_build_header,
1290                                        netdev_gre_push_header,
1291                                        netdev_gre_pop_header),
1292         TUNNEL_CLASS("ipsec_gre", "gre_sys", NULL, NULL, NULL),
1293         TUNNEL_CLASS("gre64", "gre64_sys", NULL,  NULL, NULL),
1294         TUNNEL_CLASS("ipsec_gre64", "gre64_sys", NULL, NULL, NULL),
1295         TUNNEL_CLASS("vxlan", "vxlan_sys", netdev_vxlan_build_header,
1296                                            netdev_vxlan_push_header,
1297                                            netdev_vxlan_pop_header),
1298         TUNNEL_CLASS("lisp", "lisp_sys", NULL, NULL, NULL)
1299     };
1300     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
1301
1302     if (ovsthread_once_start(&once)) {
1303         int i;
1304
1305         for (i = 0; i < ARRAY_SIZE(vport_classes); i++) {
1306             netdev_register_provider(&vport_classes[i].netdev_class);
1307         }
1308
1309         unixctl_command_register("tnl/egress_port_range", "min max", 0, 2,
1310                                  netdev_vport_range, NULL);
1311
1312         ovsthread_once_done(&once);
1313     }
1314 }
1315
1316 void
1317 netdev_vport_patch_register(void)
1318 {
1319     static const struct vport_class patch_class =
1320         { NULL,
1321             { "patch", VPORT_FUNCTIONS(get_patch_config,
1322                                        set_patch_config,
1323                                        NULL,
1324                                        NULL, NULL, NULL, NULL) }};
1325     netdev_register_provider(&patch_class.netdev_class);
1326 }