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