datapath: Use additional common UDP functions for LISP.
[cascardo/ovs.git] / datapath / vport-lisp.c
1 /*
2  * Copyright (c) 2011 Nicira, Inc.
3  * Copyright (c) 2013 Cisco Systems, Inc.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of version 2 of the GNU General Public
7  * License as published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA
18  */
19
20 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21
22 #include <linux/version.h>
23
24 #include <linux/in.h>
25 #include <linux/ip.h>
26 #include <linux/net.h>
27 #include <linux/rculist.h>
28 #include <linux/udp.h>
29
30 #include <net/icmp.h>
31 #include <net/ip.h>
32 #include <net/route.h>
33 #include <net/udp.h>
34 #include <net/udp_tunnel.h>
35 #include <net/xfrm.h>
36
37 #include "datapath.h"
38 #include "gso.h"
39 #include "vport.h"
40
41 /*
42  *  LISP encapsulation header:
43  *
44  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
45  *  |N|L|E|V|I|flags|            Nonce/Map-Version                  |
46  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
47  *  |                 Instance ID/Locator Status Bits               |
48  *  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
49  *
50  */
51
52 /**
53  * struct lisphdr - LISP header
54  * @nonce_present: Flag indicating the presence of a 24 bit nonce value.
55  * @locator_status_bits_present: Flag indicating the presence of Locator Status
56  *                               Bits (LSB).
57  * @solicit_echo_nonce: Flag indicating the use of the echo noncing mechanism.
58  * @map_version_present: Flag indicating the use of mapping versioning.
59  * @instance_id_present: Flag indicating the presence of a 24 bit Instance ID.
60  * @reserved_flags: 3 bits reserved for future flags.
61  * @nonce: 24 bit nonce value.
62  * @map_version: 24 bit mapping version.
63  * @locator_status_bits: Locator Status Bits: 32 bits when instance_id_present
64  *                       is not set, 8 bits when it is.
65  * @instance_id: 24 bit Instance ID
66  */
67 struct lisphdr {
68 #ifdef __LITTLE_ENDIAN_BITFIELD
69         __u8 reserved_flags:3;
70         __u8 instance_id_present:1;
71         __u8 map_version_present:1;
72         __u8 solicit_echo_nonce:1;
73         __u8 locator_status_bits_present:1;
74         __u8 nonce_present:1;
75 #else
76         __u8 nonce_present:1;
77         __u8 locator_status_bits_present:1;
78         __u8 solicit_echo_nonce:1;
79         __u8 map_version_present:1;
80         __u8 instance_id_present:1;
81         __u8 reserved_flags:3;
82 #endif
83         union {
84                 __u8 nonce[3];
85                 __u8 map_version[3];
86         } u1;
87         union {
88                 __be32 locator_status_bits;
89                 struct {
90                         __u8 instance_id[3];
91                         __u8 locator_status_bits;
92                 } word2;
93         } u2;
94 };
95
96 #define LISP_HLEN (sizeof(struct udphdr) + sizeof(struct lisphdr))
97
98 /**
99  * struct lisp_port - Keeps track of open UDP ports
100  * @dst_port: lisp UDP port no.
101  * @list: list element in @lisp_ports.
102  * @lisp_rcv_socket: The socket created for this port number.
103  * @name: vport name.
104  */
105 struct lisp_port {
106         __be16 dst_port;
107         struct list_head list;
108         struct socket *lisp_rcv_socket;
109         char name[IFNAMSIZ];
110 };
111
112 static LIST_HEAD(lisp_ports);
113
114 static inline struct lisp_port *lisp_vport(const struct vport *vport)
115 {
116         return vport_priv(vport);
117 }
118
119 static struct lisp_port *lisp_find_port(struct net *net, __be16 port)
120 {
121         struct lisp_port *lisp_port;
122
123         list_for_each_entry_rcu(lisp_port, &lisp_ports, list) {
124                 if (lisp_port->dst_port == port &&
125                         net_eq(sock_net(lisp_port->lisp_rcv_socket->sk), net))
126                         return lisp_port;
127         }
128
129         return NULL;
130 }
131
132 static inline struct lisphdr *lisp_hdr(const struct sk_buff *skb)
133 {
134         return (struct lisphdr *)(udp_hdr(skb) + 1);
135 }
136
137 /* Convert 64 bit tunnel ID to 24 bit Instance ID. */
138 static void tunnel_id_to_instance_id(__be64 tun_id, __u8 *iid)
139 {
140
141 #ifdef __BIG_ENDIAN
142         iid[0] = (__force __u8)(tun_id >> 16);
143         iid[1] = (__force __u8)(tun_id >> 8);
144         iid[2] = (__force __u8)tun_id;
145 #else
146         iid[0] = (__force __u8)((__force u64)tun_id >> 40);
147         iid[1] = (__force __u8)((__force u64)tun_id >> 48);
148         iid[2] = (__force __u8)((__force u64)tun_id >> 56);
149 #endif
150 }
151
152 /* Convert 24 bit Instance ID to 64 bit tunnel ID. */
153 static __be64 instance_id_to_tunnel_id(__u8 *iid)
154 {
155 #ifdef __BIG_ENDIAN
156         return (iid[0] << 16) | (iid[1] << 8) | iid[2];
157 #else
158         return (__force __be64)(((__force u64)iid[0] << 40) |
159                                 ((__force u64)iid[1] << 48) |
160                                 ((__force u64)iid[2] << 56));
161 #endif
162 }
163
164 /* Compute source UDP port for outgoing packet.
165  * Currently we use the flow hash.
166  */
167 static u16 get_src_port(struct net *net, struct sk_buff *skb)
168 {
169         u32 hash = skb_get_hash(skb);
170         unsigned int range;
171         int high;
172         int low;
173
174         if (!hash) {
175                 if (skb->protocol == htons(ETH_P_IP)) {
176                         struct iphdr *iph;
177                         int size = (sizeof(iph->saddr) * 2) / sizeof(u32);
178
179                         iph = (struct iphdr *) skb_network_header(skb);
180                         hash = jhash2((const u32 *)&iph->saddr, size, 0);
181                 } else if (skb->protocol == htons(ETH_P_IPV6)) {
182                         struct ipv6hdr *ipv6hdr;
183
184                         ipv6hdr = (struct ipv6hdr *) skb_network_header(skb);
185                         hash = jhash2((const u32 *)&ipv6hdr->saddr,
186                                       (sizeof(struct in6_addr) * 2) / sizeof(u32), 0);
187                 } else {
188                         pr_warn_once("LISP inner protocol is not IP when "
189                                      "calculating hash.\n");
190                 }
191         }
192
193         inet_get_local_port_range(net, &low, &high);
194         range = (high - low) + 1;
195         return (((u64) hash * range) >> 32) + low;
196 }
197
198 static void lisp_build_header(struct sk_buff *skb)
199 {
200         struct lisphdr *lisph;
201         const struct ovs_key_ipv4_tunnel *tun_key;
202
203         tun_key = &OVS_CB(skb)->egress_tun_info->tunnel;
204
205         lisph = (struct lisphdr *)__skb_push(skb, sizeof(struct lisphdr));
206         lisph->nonce_present = 0;       /* We don't support echo nonce algorithm */
207         lisph->locator_status_bits_present = 1; /* Set LSB */
208         lisph->solicit_echo_nonce = 0;  /* No echo noncing */
209         lisph->map_version_present = 0; /* No mapping versioning, nonce instead */
210         lisph->instance_id_present = 1; /* Store the tun_id as Instance ID  */
211         lisph->reserved_flags = 0;      /* Reserved flags, set to 0  */
212
213         lisph->u1.nonce[0] = 0;
214         lisph->u1.nonce[1] = 0;
215         lisph->u1.nonce[2] = 0;
216
217         tunnel_id_to_instance_id(tun_key->tun_id, &lisph->u2.word2.instance_id[0]);
218         lisph->u2.word2.locator_status_bits = 1;
219 }
220
221 /* Called with rcu_read_lock and BH disabled. */
222 static int lisp_rcv(struct sock *sk, struct sk_buff *skb)
223 {
224         struct lisp_port *lisp_port;
225         struct lisphdr *lisph;
226         struct iphdr *iph, *inner_iph;
227         struct ovs_tunnel_info tun_info;
228         __be64 key;
229         struct ethhdr *ethh;
230         __be16 protocol;
231
232         lisp_port = rcu_dereference_sk_user_data(sk);
233         if (unlikely(!lisp_port))
234                 goto error;
235
236         if (iptunnel_pull_header(skb, LISP_HLEN, 0))
237                 goto error;
238
239         lisph = lisp_hdr(skb);
240
241         if (lisph->instance_id_present != 1)
242                 key = 0;
243         else
244                 key = instance_id_to_tunnel_id(&lisph->u2.word2.instance_id[0]);
245
246         /* Save outer tunnel values */
247         iph = ip_hdr(skb);
248         ovs_flow_tun_info_init(&tun_info, iph,
249                                udp_hdr(skb)->source, udp_hdr(skb)->dest,
250                                key, TUNNEL_KEY, NULL, 0);
251
252         /* Drop non-IP inner packets */
253         inner_iph = (struct iphdr *)(lisph + 1);
254         switch (inner_iph->version) {
255         case 4:
256                 protocol = htons(ETH_P_IP);
257                 break;
258         case 6:
259                 protocol = htons(ETH_P_IPV6);
260                 break;
261         default:
262                 goto error;
263         }
264         skb->protocol = protocol;
265
266         /* Add Ethernet header */
267         ethh = (struct ethhdr *)skb_push(skb, ETH_HLEN);
268         memset(ethh, 0, ETH_HLEN);
269         ethh->h_dest[0] = 0x02;
270         ethh->h_source[0] = 0x02;
271         ethh->h_proto = protocol;
272
273         ovs_skb_postpush_rcsum(skb, skb->data, ETH_HLEN);
274
275         ovs_vport_receive(vport_from_priv(lisp_port), skb, &tun_info);
276         goto out;
277
278 error:
279         kfree_skb(skb);
280 out:
281         return 0;
282 }
283
284 static int lisp_socket_init(struct lisp_port *lisp_port, struct net *net)
285 {
286         struct udp_port_cfg udp_conf;
287         struct udp_tunnel_sock_cfg tunnel_cfg;
288         int err;
289
290         memset(&udp_conf, 0, sizeof(udp_conf));
291
292         udp_conf.family = AF_INET;
293         udp_conf.local_ip.s_addr = htonl(INADDR_ANY);
294         udp_conf.local_udp_port = lisp_port->dst_port;
295
296         err = udp_sock_create(net, &udp_conf, &lisp_port->lisp_rcv_socket);
297         if (err < 0) {
298                 pr_warn("cannot register lisp protocol handler: %d\n", err);
299                 return err;
300         }
301
302         tunnel_cfg.sk_user_data = lisp_port;
303         tunnel_cfg.encap_type = 1;
304         tunnel_cfg.encap_rcv = lisp_rcv;
305         tunnel_cfg.encap_destroy = NULL;
306
307         setup_udp_tunnel_sock(net, lisp_port->lisp_rcv_socket, &tunnel_cfg);
308
309         return 0;
310 }
311
312 static int lisp_get_options(const struct vport *vport, struct sk_buff *skb)
313 {
314         struct lisp_port *lisp_port = lisp_vport(vport);
315
316         if (nla_put_u16(skb, OVS_TUNNEL_ATTR_DST_PORT, ntohs(lisp_port->dst_port)))
317                 return -EMSGSIZE;
318         return 0;
319 }
320
321 static void lisp_tnl_destroy(struct vport *vport)
322 {
323         struct lisp_port *lisp_port = lisp_vport(vport);
324
325         list_del_rcu(&lisp_port->list);
326         udp_tunnel_sock_release(lisp_port->lisp_rcv_socket);
327         ovs_vport_deferred_free(vport);
328 }
329
330 static struct vport *lisp_tnl_create(const struct vport_parms *parms)
331 {
332         struct net *net = ovs_dp_get_net(parms->dp);
333         struct nlattr *options = parms->options;
334         struct lisp_port *lisp_port;
335         struct vport *vport;
336         struct nlattr *a;
337         int err;
338         u16 dst_port;
339
340         if (!options) {
341                 err = -EINVAL;
342                 goto error;
343         }
344
345         a = nla_find_nested(options, OVS_TUNNEL_ATTR_DST_PORT);
346         if (a && nla_len(a) == sizeof(u16)) {
347                 dst_port = nla_get_u16(a);
348         } else {
349                 /* Require destination port from userspace. */
350                 err = -EINVAL;
351                 goto error;
352         }
353
354         /* Verify if we already have a socket created for this port */
355         if (lisp_find_port(net, htons(dst_port))) {
356                 err = -EEXIST;
357                 goto error;
358         }
359
360         vport = ovs_vport_alloc(sizeof(struct lisp_port),
361                                 &ovs_lisp_vport_ops, parms);
362         if (IS_ERR(vport))
363                 return vport;
364
365         lisp_port = lisp_vport(vport);
366         lisp_port->dst_port = htons(dst_port);
367         strncpy(lisp_port->name, parms->name, IFNAMSIZ);
368
369         err = lisp_socket_init(lisp_port, net);
370         if (err)
371                 goto error_free;
372
373         list_add_tail_rcu(&lisp_port->list, &lisp_ports);
374         return vport;
375
376 error_free:
377         ovs_vport_free(vport);
378 error:
379         return ERR_PTR(err);
380 }
381
382 static int lisp_send(struct vport *vport, struct sk_buff *skb)
383 {
384         struct ovs_key_ipv4_tunnel *tun_key;
385         struct lisp_port *lisp_port = lisp_vport(vport);
386         struct net *net = ovs_dp_get_net(vport->dp);
387         int network_offset = skb_network_offset(skb);
388         struct rtable *rt;
389         int min_headroom;
390         __be32 saddr;
391         __be16 src_port, dst_port;
392         __be16 df;
393         int sent_len;
394         int err;
395
396         if (unlikely(!OVS_CB(skb)->egress_tun_info)) {
397                 err = -EINVAL;
398                 goto error;
399         }
400
401         tun_key = &OVS_CB(skb)->egress_tun_info->tunnel;
402
403         if (skb->protocol != htons(ETH_P_IP) &&
404             skb->protocol != htons(ETH_P_IPV6)) {
405                 err = 0;
406                 goto error;
407         }
408
409         /* Route lookup */
410         saddr = tun_key->ipv4_src;
411         rt = find_route(ovs_dp_get_net(vport->dp),
412                         &saddr, tun_key->ipv4_dst,
413                         IPPROTO_UDP, tun_key->ipv4_tos,
414                         skb->mark);
415         if (IS_ERR(rt)) {
416                 err = PTR_ERR(rt);
417                 goto error;
418         }
419
420         min_headroom = LL_RESERVED_SPACE(rt_dst(rt).dev) + rt_dst(rt).header_len
421                         + sizeof(struct iphdr) + LISP_HLEN;
422
423         if (skb_headroom(skb) < min_headroom || skb_header_cloned(skb)) {
424                 int head_delta = SKB_DATA_ALIGN(min_headroom -
425                                                 skb_headroom(skb) +
426                                                 16);
427
428                 err = pskb_expand_head(skb, max_t(int, head_delta, 0),
429                                         0, GFP_ATOMIC);
430                 if (unlikely(err))
431                         goto err_free_rt;
432         }
433
434         /* Reset l2 headers. */
435         skb_pull(skb, network_offset);
436         skb_reset_mac_header(skb);
437         vlan_set_tci(skb, 0);
438
439         skb = udp_tunnel_handle_offloads(skb, false, false);
440         if (IS_ERR(skb)) {
441                 err = PTR_ERR(skb);
442                 skb = NULL;
443                 goto err_free_rt;
444         }
445
446         src_port = htons(get_src_port(net, skb));
447         dst_port = lisp_port->dst_port;
448
449         lisp_build_header(skb);
450
451         skb->ignore_df = 1;
452
453         ovs_skb_set_inner_protocol(skb, skb->protocol);
454
455         df = tun_key->tun_flags & TUNNEL_DONT_FRAGMENT ? htons(IP_DF) : 0;
456         sent_len = udp_tunnel_xmit_skb(lisp_port->lisp_rcv_socket, rt, skb,
457                                        saddr, tun_key->ipv4_dst,
458                                        tun_key->ipv4_tos, tun_key->ipv4_ttl,
459                                        df, src_port, dst_port, false);
460
461         return sent_len > 0 ? sent_len + network_offset : sent_len;
462
463 err_free_rt:
464         ip_rt_put(rt);
465 error:
466         kfree_skb(skb);
467         return err;
468 }
469
470 static const char *lisp_get_name(const struct vport *vport)
471 {
472         struct lisp_port *lisp_port = lisp_vport(vport);
473         return lisp_port->name;
474 }
475
476 static int lisp_get_egress_tun_info(struct vport *vport, struct sk_buff *skb,
477                                     struct ovs_tunnel_info *egress_tun_info)
478 {
479         struct net *net = ovs_dp_get_net(vport->dp);
480         struct lisp_port *lisp_port = lisp_vport(vport);
481
482         if (skb->protocol != htons(ETH_P_IP) &&
483             skb->protocol != htons(ETH_P_IPV6)) {
484                 return -EINVAL;
485         }
486
487         /*
488          * Get tp_src and tp_dst, refert to lisp_build_header().
489          */
490         return ovs_tunnel_get_egress_info(egress_tun_info, net,
491                                           OVS_CB(skb)->egress_tun_info,
492                                           IPPROTO_UDP, skb->mark,
493                                           htons(get_src_port(net, skb)),
494                                           lisp_port->dst_port);
495 }
496
497 const struct vport_ops ovs_lisp_vport_ops = {
498         .type                   = OVS_VPORT_TYPE_LISP,
499         .create                 = lisp_tnl_create,
500         .destroy                = lisp_tnl_destroy,
501         .get_name               = lisp_get_name,
502         .get_options            = lisp_get_options,
503         .send                   = lisp_send,
504         .get_egress_tun_info    = lisp_get_egress_tun_info,
505 };