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/module.h>
36 #include <net/ipcomp.h>
37 #include <asm/scatterlist.h>
38 #include <asm/semaphore.h>
39 #include <linux/crypto.h>
40 #include <linux/pfkeyv2.h>
41 #include <linux/random.h>
42 #include <linux/percpu.h>
43 #include <linux/smp.h>
44 #include <linux/list.h>
45 #include <linux/vmalloc.h>
46 #include <linux/rtnetlink.h>
49 #include <net/protocol.h>
50 #include <linux/ipv6.h>
51 #include <linux/icmpv6.h>
52 #include <linux/mutex.h>
55 struct list_head list;
56 struct crypto_comp **tfms;
60 static DEFINE_MUTEX(ipcomp6_resource_mutex);
61 static void **ipcomp6_scratches;
62 static int ipcomp6_scratch_users;
63 static LIST_HEAD(ipcomp6_tfms_list);
65 static int ipcomp6_input(struct xfrm_state *x, struct sk_buff *skb)
68 struct ipv6_comp_hdr *ipch;
70 struct ipcomp_data *ipcd = x->data;
72 struct crypto_comp *tfm;
75 if (skb_linearize_cow(skb))
78 skb->ip_summed = CHECKSUM_NONE;
80 /* Remove ipcomp header and decompress original payload */
81 ipch = (void *)skb->data;
82 skb->transport_header = skb->network_header + sizeof(*ipch);
83 __skb_pull(skb, sizeof(*ipch));
87 dlen = IPCOMP_SCRATCH_SIZE;
91 scratch = *per_cpu_ptr(ipcomp6_scratches, cpu);
92 tfm = *per_cpu_ptr(ipcd->tfms, cpu);
94 err = crypto_comp_decompress(tfm, start, plen, scratch, &dlen);
100 if (dlen < (plen + sizeof(struct ipv6_comp_hdr))) {
105 err = pskb_expand_head(skb, 0, dlen - plen, GFP_ATOMIC);
110 skb->truesize += dlen - plen;
111 __skb_put(skb, dlen - plen);
112 skb_copy_to_linear_data(skb, scratch, dlen);
121 static int ipcomp6_output(struct xfrm_state *x, struct sk_buff *skb)
124 struct ipv6hdr *top_iph;
125 struct ipv6_comp_hdr *ipch;
126 struct ipcomp_data *ipcd = x->data;
129 struct crypto_comp *tfm;
133 skb_push(skb, -skb_network_offset(skb));
134 hdr_len = skb_transport_offset(skb);
136 /* check whether datagram len is larger than threshold */
137 if ((skb->len - hdr_len) < ipcd->threshold) {
141 if (skb_linearize_cow(skb))
145 plen = skb->len - hdr_len;
146 dlen = IPCOMP_SCRATCH_SIZE;
147 start = skb_transport_header(skb);
150 scratch = *per_cpu_ptr(ipcomp6_scratches, cpu);
151 tfm = *per_cpu_ptr(ipcd->tfms, cpu);
153 err = crypto_comp_compress(tfm, start, plen, scratch, &dlen);
154 if (err || (dlen + sizeof(struct ipv6_comp_hdr)) >= plen) {
158 memcpy(start + sizeof(struct ip_comp_hdr), scratch, dlen);
160 pskb_trim(skb, hdr_len + dlen + sizeof(struct ip_comp_hdr));
162 /* insert ipcomp header and replace datagram */
163 top_iph = ipv6_hdr(skb);
165 top_iph->payload_len = htons(skb->len - sizeof(struct ipv6hdr));
167 ipch = (struct ipv6_comp_hdr *)start;
168 ipch->nexthdr = *skb_mac_header(skb);
170 ipch->cpi = htons((u16 )ntohl(x->id.spi));
171 *skb_mac_header(skb) = IPPROTO_COMP;
177 static void ipcomp6_err(struct sk_buff *skb, struct inet6_skb_parm *opt,
178 int type, int code, int offset, __be32 info)
181 struct ipv6hdr *iph = (struct ipv6hdr*)skb->data;
182 struct ipv6_comp_hdr *ipcomph = (struct ipv6_comp_hdr*)(skb->data+offset);
183 struct xfrm_state *x;
185 if (type != ICMPV6_DEST_UNREACH && type != ICMPV6_PKT_TOOBIG)
188 spi = htonl(ntohs(ipcomph->cpi));
189 x = xfrm_state_lookup((xfrm_address_t *)&iph->daddr, spi, IPPROTO_COMP, AF_INET6);
193 printk(KERN_DEBUG "pmtu discovery on SA IPCOMP/%08x/" NIP6_FMT "\n",
194 spi, NIP6(iph->daddr));
198 static struct xfrm_state *ipcomp6_tunnel_create(struct xfrm_state *x)
200 struct xfrm_state *t = NULL;
201 u8 mode = XFRM_MODE_TUNNEL;
203 t = xfrm_state_alloc();
207 t->id.proto = IPPROTO_IPV6;
208 t->id.spi = xfrm6_tunnel_alloc_spi((xfrm_address_t *)&x->props.saddr);
212 memcpy(t->id.daddr.a6, x->id.daddr.a6, sizeof(struct in6_addr));
213 memcpy(&t->sel, &x->sel, sizeof(t->sel));
214 t->props.family = AF_INET6;
215 if (x->props.mode == XFRM_MODE_BEET)
216 mode = x->props.mode;
217 t->props.mode = mode;
218 memcpy(t->props.saddr.a6, x->props.saddr.a6, sizeof(struct in6_addr));
220 if (xfrm_init_state(t))
223 atomic_set(&t->tunnel_users, 1);
229 t->km.state = XFRM_STATE_DEAD;
235 static int ipcomp6_tunnel_attach(struct xfrm_state *x)
238 struct xfrm_state *t = NULL;
241 spi = xfrm6_tunnel_spi_lookup((xfrm_address_t *)&x->props.saddr);
243 t = xfrm_state_lookup((xfrm_address_t *)&x->id.daddr,
244 spi, IPPROTO_IPV6, AF_INET6);
246 t = ipcomp6_tunnel_create(x);
251 xfrm_state_insert(t);
255 atomic_inc(&t->tunnel_users);
261 static void ipcomp6_free_scratches(void)
266 if (--ipcomp6_scratch_users)
269 scratches = ipcomp6_scratches;
273 for_each_possible_cpu(i) {
274 void *scratch = *per_cpu_ptr(scratches, i);
279 free_percpu(scratches);
282 static void **ipcomp6_alloc_scratches(void)
287 if (ipcomp6_scratch_users++)
288 return ipcomp6_scratches;
290 scratches = alloc_percpu(void *);
294 ipcomp6_scratches = scratches;
296 for_each_possible_cpu(i) {
297 void *scratch = vmalloc(IPCOMP_SCRATCH_SIZE);
300 *per_cpu_ptr(scratches, i) = scratch;
306 static void ipcomp6_free_tfms(struct crypto_comp **tfms)
308 struct ipcomp6_tfms *pos;
311 list_for_each_entry(pos, &ipcomp6_tfms_list, list) {
312 if (pos->tfms == tfms)
321 list_del(&pos->list);
327 for_each_possible_cpu(cpu) {
328 struct crypto_comp *tfm = *per_cpu_ptr(tfms, cpu);
329 crypto_free_comp(tfm);
334 static struct crypto_comp **ipcomp6_alloc_tfms(const char *alg_name)
336 struct ipcomp6_tfms *pos;
337 struct crypto_comp **tfms;
340 /* This can be any valid CPU ID so we don't need locking. */
341 cpu = raw_smp_processor_id();
343 list_for_each_entry(pos, &ipcomp6_tfms_list, list) {
344 struct crypto_comp *tfm;
347 tfm = *per_cpu_ptr(tfms, cpu);
349 if (!strcmp(crypto_comp_name(tfm), alg_name)) {
355 pos = kmalloc(sizeof(*pos), GFP_KERNEL);
360 INIT_LIST_HEAD(&pos->list);
361 list_add(&pos->list, &ipcomp6_tfms_list);
363 pos->tfms = tfms = alloc_percpu(struct crypto_comp *);
367 for_each_possible_cpu(cpu) {
368 struct crypto_comp *tfm = crypto_alloc_comp(alg_name, 0,
372 *per_cpu_ptr(tfms, cpu) = tfm;
378 ipcomp6_free_tfms(tfms);
382 static void ipcomp6_free_data(struct ipcomp_data *ipcd)
385 ipcomp6_free_tfms(ipcd->tfms);
386 ipcomp6_free_scratches();
389 static void ipcomp6_destroy(struct xfrm_state *x)
391 struct ipcomp_data *ipcd = x->data;
394 xfrm_state_delete_tunnel(x);
395 mutex_lock(&ipcomp6_resource_mutex);
396 ipcomp6_free_data(ipcd);
397 mutex_unlock(&ipcomp6_resource_mutex);
400 xfrm6_tunnel_free_spi((xfrm_address_t *)&x->props.saddr);
403 static int ipcomp6_init_state(struct xfrm_state *x)
406 struct ipcomp_data *ipcd;
407 struct xfrm_algo_desc *calg_desc;
417 ipcd = kzalloc(sizeof(*ipcd), GFP_KERNEL);
421 x->props.header_len = 0;
422 if (x->props.mode == XFRM_MODE_TUNNEL)
423 x->props.header_len += sizeof(struct ipv6hdr);
425 mutex_lock(&ipcomp6_resource_mutex);
426 if (!ipcomp6_alloc_scratches())
429 ipcd->tfms = ipcomp6_alloc_tfms(x->calg->alg_name);
432 mutex_unlock(&ipcomp6_resource_mutex);
434 if (x->props.mode == XFRM_MODE_TUNNEL) {
435 err = ipcomp6_tunnel_attach(x);
440 calg_desc = xfrm_calg_get_byname(x->calg->alg_name, 0);
442 ipcd->threshold = calg_desc->uinfo.comp.threshold;
448 mutex_lock(&ipcomp6_resource_mutex);
450 ipcomp6_free_data(ipcd);
451 mutex_unlock(&ipcomp6_resource_mutex);
457 static struct xfrm_type ipcomp6_type =
459 .description = "IPCOMP6",
460 .owner = THIS_MODULE,
461 .proto = IPPROTO_COMP,
462 .init_state = ipcomp6_init_state,
463 .destructor = ipcomp6_destroy,
464 .input = ipcomp6_input,
465 .output = ipcomp6_output,
466 .hdr_offset = xfrm6_find_1stfragopt,
469 static struct inet6_protocol ipcomp6_protocol =
471 .handler = xfrm6_rcv,
472 .err_handler = ipcomp6_err,
473 .flags = INET6_PROTO_NOPOLICY,
476 static int __init ipcomp6_init(void)
478 if (xfrm_register_type(&ipcomp6_type, AF_INET6) < 0) {
479 printk(KERN_INFO "ipcomp6 init: can't add xfrm type\n");
482 if (inet6_add_protocol(&ipcomp6_protocol, IPPROTO_COMP) < 0) {
483 printk(KERN_INFO "ipcomp6 init: can't add protocol\n");
484 xfrm_unregister_type(&ipcomp6_type, AF_INET6);
490 static void __exit ipcomp6_fini(void)
492 if (inet6_del_protocol(&ipcomp6_protocol, IPPROTO_COMP) < 0)
493 printk(KERN_INFO "ipv6 ipcomp close: can't remove protocol\n");
494 if (xfrm_unregister_type(&ipcomp6_type, AF_INET6) < 0)
495 printk(KERN_INFO "ipv6 ipcomp close: can't remove xfrm type\n");
498 module_init(ipcomp6_init);
499 module_exit(ipcomp6_fini);
500 MODULE_LICENSE("GPL");
501 MODULE_DESCRIPTION("IP Payload Compression Protocol (IPComp) for IPv6 - RFC3173");
502 MODULE_AUTHOR("Mitsuru KANDA <mk@linux-ipv6.org>");
504 MODULE_ALIAS_XFRM_TYPE(AF_INET6, XFRM_PROTO_COMP);