2 * IP Payload Compression Protocol (IPComp) - RFC3173.
4 * Copyright (c) 2003 James Morris <jmorris@intercode.com.au>
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; either version 2 of the License, or (at your option)
12 * - Tunable compression parameters.
13 * - Compression stats.
14 * - Adaptive compression.
16 #include <linux/config.h>
17 #include <linux/module.h>
18 #include <asm/scatterlist.h>
19 #include <asm/semaphore.h>
20 #include <linux/crypto.h>
21 #include <linux/pfkeyv2.h>
22 #include <linux/percpu.h>
23 #include <linux/smp.h>
24 #include <linux/list.h>
25 #include <linux/vmalloc.h>
26 #include <linux/rtnetlink.h>
27 #include <linux/mutex.h>
31 #include <net/ipcomp.h>
32 #include <net/protocol.h>
35 struct list_head list;
36 struct crypto_tfm **tfms;
40 static DEFINE_MUTEX(ipcomp_resource_mutex);
41 static void **ipcomp_scratches;
42 static int ipcomp_scratch_users;
43 static LIST_HEAD(ipcomp_tfms_list);
45 static int ipcomp_decompress(struct xfrm_state *x, struct sk_buff *skb)
49 struct ipcomp_data *ipcd = x->data;
51 struct crypto_tfm *tfm;
55 dlen = IPCOMP_SCRATCH_SIZE;
59 scratch = *per_cpu_ptr(ipcomp_scratches, cpu);
60 tfm = *per_cpu_ptr(ipcd->tfms, cpu);
62 err = crypto_comp_decompress(tfm, start, plen, scratch, &dlen);
66 if (dlen < (plen + sizeof(struct ip_comp_hdr))) {
71 err = pskb_expand_head(skb, 0, dlen - plen, GFP_ATOMIC);
75 skb_put(skb, dlen - plen);
76 memcpy(skb->data, scratch, dlen);
78 iph->tot_len = htons(dlen + iph->ihl * 4);
84 static int ipcomp_input(struct xfrm_state *x,
85 struct xfrm_decap_state *decap, struct sk_buff *skb)
96 if ((skb_is_nonlinear(skb) || skb_cloned(skb)) &&
97 skb_linearize(skb, GFP_ATOMIC) != 0) {
102 skb->ip_summed = CHECKSUM_NONE;
104 /* Remove ipcomp header and decompress original payload */
106 memcpy(&tmp_iph, iph, iph->ihl * 4);
107 nexthdr = *(u8 *)skb->data;
108 skb_pull(skb, sizeof(struct ip_comp_hdr));
109 skb->nh.raw += sizeof(struct ip_comp_hdr);
110 memcpy(skb->nh.raw, &tmp_iph, tmp_iph.iph.ihl * 4);
112 iph->tot_len = htons(ntohs(iph->tot_len) - sizeof(struct ip_comp_hdr));
113 iph->protocol = nexthdr;
114 skb->h.raw = skb->data;
115 err = ipcomp_decompress(x, skb);
121 static int ipcomp_compress(struct xfrm_state *x, struct sk_buff *skb)
123 int err, plen, dlen, ihlen;
124 struct iphdr *iph = skb->nh.iph;
125 struct ipcomp_data *ipcd = x->data;
127 struct crypto_tfm *tfm;
130 ihlen = iph->ihl * 4;
131 plen = skb->len - ihlen;
132 dlen = IPCOMP_SCRATCH_SIZE;
133 start = skb->data + ihlen;
136 scratch = *per_cpu_ptr(ipcomp_scratches, cpu);
137 tfm = *per_cpu_ptr(ipcd->tfms, cpu);
139 err = crypto_comp_compress(tfm, start, plen, scratch, &dlen);
143 if ((dlen + sizeof(struct ip_comp_hdr)) >= plen) {
148 memcpy(start + sizeof(struct ip_comp_hdr), scratch, dlen);
151 pskb_trim(skb, ihlen + dlen + sizeof(struct ip_comp_hdr));
159 static int ipcomp_output(struct xfrm_state *x, struct sk_buff *skb)
163 struct ip_comp_hdr *ipch;
164 struct ipcomp_data *ipcd = x->data;
168 iph->tot_len = htons(skb->len);
169 hdr_len = iph->ihl * 4;
170 if ((skb->len - hdr_len) < ipcd->threshold) {
171 /* Don't bother compressing */
175 if ((skb_is_nonlinear(skb) || skb_cloned(skb)) &&
176 skb_linearize(skb, GFP_ATOMIC) != 0) {
180 err = ipcomp_compress(x, skb);
187 /* Install ipcomp header, convert into ipcomp datagram. */
188 iph->tot_len = htons(skb->len);
189 ipch = (struct ip_comp_hdr *)((char *)iph + iph->ihl * 4);
190 ipch->nexthdr = iph->protocol;
192 ipch->cpi = htons((u16 )ntohl(x->id.spi));
193 iph->protocol = IPPROTO_COMP;
203 static void ipcomp4_err(struct sk_buff *skb, u32 info)
206 struct iphdr *iph = (struct iphdr *)skb->data;
207 struct ip_comp_hdr *ipch = (struct ip_comp_hdr *)(skb->data+(iph->ihl<<2));
208 struct xfrm_state *x;
210 if (skb->h.icmph->type != ICMP_DEST_UNREACH ||
211 skb->h.icmph->code != ICMP_FRAG_NEEDED)
214 spi = ntohl(ntohs(ipch->cpi));
215 x = xfrm_state_lookup((xfrm_address_t *)&iph->daddr,
216 spi, IPPROTO_COMP, AF_INET);
219 NETDEBUG(KERN_DEBUG "pmtu discovery on SA IPCOMP/%08x/%u.%u.%u.%u\n",
220 spi, NIPQUAD(iph->daddr));
224 /* We always hold one tunnel user reference to indicate a tunnel */
225 static struct xfrm_state *ipcomp_tunnel_create(struct xfrm_state *x)
227 struct xfrm_state *t;
229 t = xfrm_state_alloc();
233 t->id.proto = IPPROTO_IPIP;
234 t->id.spi = x->props.saddr.a4;
235 t->id.daddr.a4 = x->id.daddr.a4;
236 memcpy(&t->sel, &x->sel, sizeof(t->sel));
237 t->props.family = AF_INET;
239 t->props.saddr.a4 = x->props.saddr.a4;
240 t->props.flags = x->props.flags;
242 if (xfrm_init_state(t))
245 atomic_set(&t->tunnel_users, 1);
250 t->km.state = XFRM_STATE_DEAD;
257 * Must be protected by xfrm_cfg_mutex. State and tunnel user references are
258 * always incremented on success.
260 static int ipcomp_tunnel_attach(struct xfrm_state *x)
263 struct xfrm_state *t;
265 t = xfrm_state_lookup((xfrm_address_t *)&x->id.daddr.a4,
266 x->props.saddr.a4, IPPROTO_IPIP, AF_INET);
268 t = ipcomp_tunnel_create(x);
273 xfrm_state_insert(t);
277 atomic_inc(&t->tunnel_users);
282 static void ipcomp_free_scratches(void)
287 if (--ipcomp_scratch_users)
290 scratches = ipcomp_scratches;
295 void *scratch = *per_cpu_ptr(scratches, i);
300 free_percpu(scratches);
303 static void **ipcomp_alloc_scratches(void)
308 if (ipcomp_scratch_users++)
309 return ipcomp_scratches;
311 scratches = alloc_percpu(void *);
315 ipcomp_scratches = scratches;
318 void *scratch = vmalloc(IPCOMP_SCRATCH_SIZE);
321 *per_cpu_ptr(scratches, i) = scratch;
327 static void ipcomp_free_tfms(struct crypto_tfm **tfms)
329 struct ipcomp_tfms *pos;
332 list_for_each_entry(pos, &ipcomp_tfms_list, list) {
333 if (pos->tfms == tfms)
342 list_del(&pos->list);
349 struct crypto_tfm *tfm = *per_cpu_ptr(tfms, cpu);
350 crypto_free_tfm(tfm);
355 static struct crypto_tfm **ipcomp_alloc_tfms(const char *alg_name)
357 struct ipcomp_tfms *pos;
358 struct crypto_tfm **tfms;
361 /* This can be any valid CPU ID so we don't need locking. */
362 cpu = raw_smp_processor_id();
364 list_for_each_entry(pos, &ipcomp_tfms_list, list) {
365 struct crypto_tfm *tfm;
368 tfm = *per_cpu_ptr(tfms, cpu);
370 if (!strcmp(crypto_tfm_alg_name(tfm), alg_name)) {
376 pos = kmalloc(sizeof(*pos), GFP_KERNEL);
381 INIT_LIST_HEAD(&pos->list);
382 list_add(&pos->list, &ipcomp_tfms_list);
384 pos->tfms = tfms = alloc_percpu(struct crypto_tfm *);
389 struct crypto_tfm *tfm = crypto_alloc_tfm(alg_name, 0);
392 *per_cpu_ptr(tfms, cpu) = tfm;
398 ipcomp_free_tfms(tfms);
402 static void ipcomp_free_data(struct ipcomp_data *ipcd)
405 ipcomp_free_tfms(ipcd->tfms);
406 ipcomp_free_scratches();
409 static void ipcomp_destroy(struct xfrm_state *x)
411 struct ipcomp_data *ipcd = x->data;
414 xfrm_state_delete_tunnel(x);
415 mutex_lock(&ipcomp_resource_mutex);
416 ipcomp_free_data(ipcd);
417 mutex_unlock(&ipcomp_resource_mutex);
421 static int ipcomp_init_state(struct xfrm_state *x)
424 struct ipcomp_data *ipcd;
425 struct xfrm_algo_desc *calg_desc;
435 ipcd = kmalloc(sizeof(*ipcd), GFP_KERNEL);
439 memset(ipcd, 0, sizeof(*ipcd));
440 x->props.header_len = 0;
442 x->props.header_len += sizeof(struct iphdr);
444 mutex_lock(&ipcomp_resource_mutex);
445 if (!ipcomp_alloc_scratches())
448 ipcd->tfms = ipcomp_alloc_tfms(x->calg->alg_name);
451 mutex_unlock(&ipcomp_resource_mutex);
454 err = ipcomp_tunnel_attach(x);
459 calg_desc = xfrm_calg_get_byname(x->calg->alg_name, 0);
461 ipcd->threshold = calg_desc->uinfo.comp.threshold;
468 mutex_lock(&ipcomp_resource_mutex);
470 ipcomp_free_data(ipcd);
471 mutex_unlock(&ipcomp_resource_mutex);
476 static struct xfrm_type ipcomp_type = {
477 .description = "IPCOMP4",
478 .owner = THIS_MODULE,
479 .proto = IPPROTO_COMP,
480 .init_state = ipcomp_init_state,
481 .destructor = ipcomp_destroy,
482 .input = ipcomp_input,
483 .output = ipcomp_output
486 static struct net_protocol ipcomp4_protocol = {
487 .handler = xfrm4_rcv,
488 .err_handler = ipcomp4_err,
492 static int __init ipcomp4_init(void)
494 if (xfrm_register_type(&ipcomp_type, AF_INET) < 0) {
495 printk(KERN_INFO "ipcomp init: can't add xfrm type\n");
498 if (inet_add_protocol(&ipcomp4_protocol, IPPROTO_COMP) < 0) {
499 printk(KERN_INFO "ipcomp init: can't add protocol\n");
500 xfrm_unregister_type(&ipcomp_type, AF_INET);
506 static void __exit ipcomp4_fini(void)
508 if (inet_del_protocol(&ipcomp4_protocol, IPPROTO_COMP) < 0)
509 printk(KERN_INFO "ip ipcomp close: can't remove protocol\n");
510 if (xfrm_unregister_type(&ipcomp_type, AF_INET) < 0)
511 printk(KERN_INFO "ip ipcomp close: can't remove xfrm type\n");
514 module_init(ipcomp4_init);
515 module_exit(ipcomp4_fini);
517 MODULE_LICENSE("GPL");
518 MODULE_DESCRIPTION("IP Payload Compression Protocol (IPComp) - RFC3173");
519 MODULE_AUTHOR("James Morris <jmorris@intercode.com.au>");