2 * IP Payload Compression Protocol (IPComp) for IPv6 - RFC3173
4 * Copyright (C)2003 USAGI/WIDE Project
6 * Author Mitsuru KANDA <mk@linux-ipv6.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
26 * The compression of IP datagram MUST be done before AH/ESP processing,
27 * fragmentation, and the addition of Hop-by-Hop/Routing header.
30 * The decompression of IP datagram MUST be done after the reassembly,
33 #include <linux/config.h>
34 #include <linux/module.h>
37 #include <net/ipcomp.h>
38 #include <asm/scatterlist.h>
39 #include <asm/semaphore.h>
40 #include <linux/crypto.h>
41 #include <linux/pfkeyv2.h>
42 #include <linux/random.h>
43 #include <linux/percpu.h>
44 #include <linux/smp.h>
45 #include <linux/list.h>
46 #include <linux/vmalloc.h>
47 #include <linux/rtnetlink.h>
50 #include <net/protocol.h>
51 #include <linux/ipv6.h>
52 #include <linux/icmpv6.h>
53 #include <linux/mutex.h>
56 struct list_head list;
57 struct crypto_tfm **tfms;
61 static DEFINE_MUTEX(ipcomp6_resource_mutex);
62 static void **ipcomp6_scratches;
63 static int ipcomp6_scratch_users;
64 static LIST_HEAD(ipcomp6_tfms_list);
66 static int ipcomp6_input(struct xfrm_state *x, struct xfrm_decap_state *decap, struct sk_buff *skb)
70 int hdr_len = skb->h.raw - skb->nh.raw;
71 unsigned char *tmp_hdr = NULL;
74 struct ipcomp_data *ipcd = x->data;
76 struct crypto_tfm *tfm;
79 if ((skb_is_nonlinear(skb) || skb_cloned(skb)) &&
80 skb_linearize(skb, GFP_ATOMIC) != 0) {
85 skb->ip_summed = CHECKSUM_NONE;
87 /* Remove ipcomp header and decompress original payload */
89 tmp_hdr = kmalloc(hdr_len, GFP_ATOMIC);
92 memcpy(tmp_hdr, iph, hdr_len);
93 nexthdr = *(u8 *)skb->data;
94 skb_pull(skb, sizeof(struct ipv6_comp_hdr));
95 skb->nh.raw += sizeof(struct ipv6_comp_hdr);
96 memcpy(skb->nh.raw, tmp_hdr, hdr_len);
98 iph->payload_len = htons(ntohs(iph->payload_len) - sizeof(struct ipv6_comp_hdr));
99 skb->h.raw = skb->data;
103 dlen = IPCOMP_SCRATCH_SIZE;
107 scratch = *per_cpu_ptr(ipcomp6_scratches, cpu);
108 tfm = *per_cpu_ptr(ipcd->tfms, cpu);
110 err = crypto_comp_decompress(tfm, start, plen, scratch, &dlen);
116 if (dlen < (plen + sizeof(struct ipv6_comp_hdr))) {
121 err = pskb_expand_head(skb, 0, dlen - plen, GFP_ATOMIC);
126 skb_put(skb, dlen - plen);
127 memcpy(skb->data, scratch, dlen);
130 iph->payload_len = htons(skb->len);
143 static int ipcomp6_output(struct xfrm_state *x, struct sk_buff *skb)
146 struct ipv6hdr *top_iph;
148 struct ipv6_comp_hdr *ipch;
149 struct ipcomp_data *ipcd = x->data;
152 struct crypto_tfm *tfm;
155 hdr_len = skb->h.raw - skb->data;
157 /* check whether datagram len is larger than threshold */
158 if ((skb->len - hdr_len) < ipcd->threshold) {
162 if ((skb_is_nonlinear(skb) || skb_cloned(skb)) &&
163 skb_linearize(skb, GFP_ATOMIC) != 0) {
168 plen = skb->len - hdr_len;
169 dlen = IPCOMP_SCRATCH_SIZE;
173 scratch = *per_cpu_ptr(ipcomp6_scratches, cpu);
174 tfm = *per_cpu_ptr(ipcd->tfms, cpu);
176 err = crypto_comp_compress(tfm, start, plen, scratch, &dlen);
177 if (err || (dlen + sizeof(struct ipv6_comp_hdr)) >= plen) {
181 memcpy(start + sizeof(struct ip_comp_hdr), scratch, dlen);
183 pskb_trim(skb, hdr_len + dlen + sizeof(struct ip_comp_hdr));
185 /* insert ipcomp header and replace datagram */
186 top_iph = (struct ipv6hdr *)skb->data;
188 top_iph->payload_len = htons(skb->len - sizeof(struct ipv6hdr));
190 ipch = (struct ipv6_comp_hdr *)start;
191 ipch->nexthdr = *skb->nh.raw;
193 ipch->cpi = htons((u16 )ntohl(x->id.spi));
194 *skb->nh.raw = IPPROTO_COMP;
200 static void ipcomp6_err(struct sk_buff *skb, struct inet6_skb_parm *opt,
201 int type, int code, int offset, __u32 info)
204 struct ipv6hdr *iph = (struct ipv6hdr*)skb->data;
205 struct ipv6_comp_hdr *ipcomph = (struct ipv6_comp_hdr*)(skb->data+offset);
206 struct xfrm_state *x;
208 if (type != ICMPV6_DEST_UNREACH && type != ICMPV6_PKT_TOOBIG)
211 spi = ntohl(ntohs(ipcomph->cpi));
212 x = xfrm_state_lookup((xfrm_address_t *)&iph->daddr, spi, IPPROTO_COMP, AF_INET6);
216 printk(KERN_DEBUG "pmtu discovery on SA IPCOMP/%08x/" NIP6_FMT "\n",
217 spi, NIP6(iph->daddr));
221 static struct xfrm_state *ipcomp6_tunnel_create(struct xfrm_state *x)
223 struct xfrm_state *t = NULL;
225 t = xfrm_state_alloc();
229 t->id.proto = IPPROTO_IPV6;
230 t->id.spi = xfrm6_tunnel_alloc_spi((xfrm_address_t *)&x->props.saddr);
234 memcpy(t->id.daddr.a6, x->id.daddr.a6, sizeof(struct in6_addr));
235 memcpy(&t->sel, &x->sel, sizeof(t->sel));
236 t->props.family = AF_INET6;
238 memcpy(t->props.saddr.a6, x->props.saddr.a6, sizeof(struct in6_addr));
240 if (xfrm_init_state(t))
243 atomic_set(&t->tunnel_users, 1);
249 t->km.state = XFRM_STATE_DEAD;
255 static int ipcomp6_tunnel_attach(struct xfrm_state *x)
258 struct xfrm_state *t = NULL;
261 spi = xfrm6_tunnel_spi_lookup((xfrm_address_t *)&x->props.saddr);
263 t = xfrm_state_lookup((xfrm_address_t *)&x->id.daddr,
264 spi, IPPROTO_IPV6, AF_INET6);
266 t = ipcomp6_tunnel_create(x);
271 xfrm_state_insert(t);
275 atomic_inc(&t->tunnel_users);
281 static void ipcomp6_free_scratches(void)
286 if (--ipcomp6_scratch_users)
289 scratches = ipcomp6_scratches;
294 void *scratch = *per_cpu_ptr(scratches, i);
299 free_percpu(scratches);
302 static void **ipcomp6_alloc_scratches(void)
307 if (ipcomp6_scratch_users++)
308 return ipcomp6_scratches;
310 scratches = alloc_percpu(void *);
314 ipcomp6_scratches = scratches;
317 void *scratch = vmalloc(IPCOMP_SCRATCH_SIZE);
320 *per_cpu_ptr(scratches, i) = scratch;
326 static void ipcomp6_free_tfms(struct crypto_tfm **tfms)
328 struct ipcomp6_tfms *pos;
331 list_for_each_entry(pos, &ipcomp6_tfms_list, list) {
332 if (pos->tfms == tfms)
341 list_del(&pos->list);
348 struct crypto_tfm *tfm = *per_cpu_ptr(tfms, cpu);
349 crypto_free_tfm(tfm);
354 static struct crypto_tfm **ipcomp6_alloc_tfms(const char *alg_name)
356 struct ipcomp6_tfms *pos;
357 struct crypto_tfm **tfms;
360 /* This can be any valid CPU ID so we don't need locking. */
361 cpu = raw_smp_processor_id();
363 list_for_each_entry(pos, &ipcomp6_tfms_list, list) {
364 struct crypto_tfm *tfm;
367 tfm = *per_cpu_ptr(tfms, cpu);
369 if (!strcmp(crypto_tfm_alg_name(tfm), alg_name)) {
375 pos = kmalloc(sizeof(*pos), GFP_KERNEL);
380 INIT_LIST_HEAD(&pos->list);
381 list_add(&pos->list, &ipcomp6_tfms_list);
383 pos->tfms = tfms = alloc_percpu(struct crypto_tfm *);
388 struct crypto_tfm *tfm = crypto_alloc_tfm(alg_name, 0);
391 *per_cpu_ptr(tfms, cpu) = tfm;
397 ipcomp6_free_tfms(tfms);
401 static void ipcomp6_free_data(struct ipcomp_data *ipcd)
404 ipcomp6_free_tfms(ipcd->tfms);
405 ipcomp6_free_scratches();
408 static void ipcomp6_destroy(struct xfrm_state *x)
410 struct ipcomp_data *ipcd = x->data;
413 xfrm_state_delete_tunnel(x);
414 mutex_lock(&ipcomp6_resource_mutex);
415 ipcomp6_free_data(ipcd);
416 mutex_unlock(&ipcomp6_resource_mutex);
419 xfrm6_tunnel_free_spi((xfrm_address_t *)&x->props.saddr);
422 static int ipcomp6_init_state(struct xfrm_state *x)
425 struct ipcomp_data *ipcd;
426 struct xfrm_algo_desc *calg_desc;
436 ipcd = kzalloc(sizeof(*ipcd), GFP_KERNEL);
440 x->props.header_len = 0;
442 x->props.header_len += sizeof(struct ipv6hdr);
444 mutex_lock(&ipcomp6_resource_mutex);
445 if (!ipcomp6_alloc_scratches())
448 ipcd->tfms = ipcomp6_alloc_tfms(x->calg->alg_name);
451 mutex_unlock(&ipcomp6_resource_mutex);
454 err = ipcomp6_tunnel_attach(x);
459 calg_desc = xfrm_calg_get_byname(x->calg->alg_name, 0);
461 ipcd->threshold = calg_desc->uinfo.comp.threshold;
467 mutex_lock(&ipcomp6_resource_mutex);
469 ipcomp6_free_data(ipcd);
470 mutex_unlock(&ipcomp6_resource_mutex);
476 static struct xfrm_type ipcomp6_type =
478 .description = "IPCOMP6",
479 .owner = THIS_MODULE,
480 .proto = IPPROTO_COMP,
481 .init_state = ipcomp6_init_state,
482 .destructor = ipcomp6_destroy,
483 .input = ipcomp6_input,
484 .output = ipcomp6_output,
487 static struct inet6_protocol ipcomp6_protocol =
489 .handler = xfrm6_rcv,
490 .err_handler = ipcomp6_err,
491 .flags = INET6_PROTO_NOPOLICY,
494 static int __init ipcomp6_init(void)
496 if (xfrm_register_type(&ipcomp6_type, AF_INET6) < 0) {
497 printk(KERN_INFO "ipcomp6 init: can't add xfrm type\n");
500 if (inet6_add_protocol(&ipcomp6_protocol, IPPROTO_COMP) < 0) {
501 printk(KERN_INFO "ipcomp6 init: can't add protocol\n");
502 xfrm_unregister_type(&ipcomp6_type, AF_INET6);
508 static void __exit ipcomp6_fini(void)
510 if (inet6_del_protocol(&ipcomp6_protocol, IPPROTO_COMP) < 0)
511 printk(KERN_INFO "ipv6 ipcomp close: can't remove protocol\n");
512 if (xfrm_unregister_type(&ipcomp6_type, AF_INET6) < 0)
513 printk(KERN_INFO "ipv6 ipcomp close: can't remove xfrm type\n");
516 module_init(ipcomp6_init);
517 module_exit(ipcomp6_fini);
518 MODULE_LICENSE("GPL");
519 MODULE_DESCRIPTION("IP Payload Compression Protocol (IPComp) for IPv6 - RFC3173");
520 MODULE_AUTHOR("Mitsuru KANDA <mk@linux-ipv6.org>");