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/module.h>
17 #include <asm/semaphore.h>
18 #include <linux/crypto.h>
19 #include <linux/err.h>
20 #include <linux/pfkeyv2.h>
21 #include <linux/percpu.h>
22 #include <linux/smp.h>
23 #include <linux/list.h>
24 #include <linux/vmalloc.h>
25 #include <linux/rtnetlink.h>
26 #include <linux/mutex.h>
30 #include <net/ipcomp.h>
31 #include <net/protocol.h>
34 struct list_head list;
35 struct crypto_comp **tfms;
39 static DEFINE_MUTEX(ipcomp_resource_mutex);
40 static void **ipcomp_scratches;
41 static int ipcomp_scratch_users;
42 static LIST_HEAD(ipcomp_tfms_list);
44 static int ipcomp_decompress(struct xfrm_state *x, struct sk_buff *skb)
46 struct ipcomp_data *ipcd = x->data;
47 const int plen = skb->len;
48 int dlen = IPCOMP_SCRATCH_SIZE;
49 const u8 *start = skb->data;
50 const int cpu = get_cpu();
51 u8 *scratch = *per_cpu_ptr(ipcomp_scratches, cpu);
52 struct crypto_comp *tfm = *per_cpu_ptr(ipcd->tfms, cpu);
53 int err = crypto_comp_decompress(tfm, start, plen, scratch, &dlen);
58 if (dlen < (plen + sizeof(struct ip_comp_hdr))) {
63 err = pskb_expand_head(skb, 0, dlen - plen, GFP_ATOMIC);
67 skb->truesize += dlen - plen;
68 __skb_put(skb, dlen - plen);
69 skb_copy_to_linear_data(skb, scratch, dlen);
75 static int ipcomp_input(struct xfrm_state *x, struct sk_buff *skb)
78 struct ip_comp_hdr *ipch;
80 if (skb_linearize_cow(skb))
83 skb->ip_summed = CHECKSUM_NONE;
85 /* Remove ipcomp header and decompress original payload */
86 ipch = (void *)skb->data;
87 skb->transport_header = skb->network_header + sizeof(*ipch);
88 __skb_pull(skb, sizeof(*ipch));
89 err = ipcomp_decompress(x, skb);
99 static int ipcomp_compress(struct xfrm_state *x, struct sk_buff *skb)
101 struct ipcomp_data *ipcd = x->data;
102 const int plen = skb->len;
103 int dlen = IPCOMP_SCRATCH_SIZE;
104 u8 *start = skb->data;
105 const int cpu = get_cpu();
106 u8 *scratch = *per_cpu_ptr(ipcomp_scratches, cpu);
107 struct crypto_comp *tfm = *per_cpu_ptr(ipcd->tfms, cpu);
108 int err = crypto_comp_compress(tfm, start, plen, scratch, &dlen);
113 if ((dlen + sizeof(struct ip_comp_hdr)) >= plen) {
118 memcpy(start + sizeof(struct ip_comp_hdr), scratch, dlen);
121 pskb_trim(skb, dlen + sizeof(struct ip_comp_hdr));
129 static int ipcomp_output(struct xfrm_state *x, struct sk_buff *skb)
132 struct ip_comp_hdr *ipch;
133 struct ipcomp_data *ipcd = x->data;
135 if (skb->len < ipcd->threshold) {
136 /* Don't bother compressing */
140 if (skb_linearize_cow(skb))
143 err = ipcomp_compress(x, skb);
149 /* Install ipcomp header, convert into ipcomp datagram. */
150 ipch = ip_comp_hdr(skb);
151 ipch->nexthdr = *skb_mac_header(skb);
153 ipch->cpi = htons((u16 )ntohl(x->id.spi));
154 *skb_mac_header(skb) = IPPROTO_COMP;
156 skb_push(skb, -skb_network_offset(skb));
160 static void ipcomp4_err(struct sk_buff *skb, u32 info)
163 struct iphdr *iph = (struct iphdr *)skb->data;
164 struct ip_comp_hdr *ipch = (struct ip_comp_hdr *)(skb->data+(iph->ihl<<2));
165 struct xfrm_state *x;
167 if (icmp_hdr(skb)->type != ICMP_DEST_UNREACH ||
168 icmp_hdr(skb)->code != ICMP_FRAG_NEEDED)
171 spi = htonl(ntohs(ipch->cpi));
172 x = xfrm_state_lookup((xfrm_address_t *)&iph->daddr,
173 spi, IPPROTO_COMP, AF_INET);
176 NETDEBUG(KERN_DEBUG "pmtu discovery on SA IPCOMP/%08x/%u.%u.%u.%u\n",
177 spi, NIPQUAD(iph->daddr));
181 /* We always hold one tunnel user reference to indicate a tunnel */
182 static struct xfrm_state *ipcomp_tunnel_create(struct xfrm_state *x)
184 struct xfrm_state *t;
186 t = xfrm_state_alloc();
190 t->id.proto = IPPROTO_IPIP;
191 t->id.spi = x->props.saddr.a4;
192 t->id.daddr.a4 = x->id.daddr.a4;
193 memcpy(&t->sel, &x->sel, sizeof(t->sel));
194 t->props.family = AF_INET;
195 t->props.mode = x->props.mode;
196 t->props.saddr.a4 = x->props.saddr.a4;
197 t->props.flags = x->props.flags;
199 if (xfrm_init_state(t))
202 atomic_set(&t->tunnel_users, 1);
207 t->km.state = XFRM_STATE_DEAD;
214 * Must be protected by xfrm_cfg_mutex. State and tunnel user references are
215 * always incremented on success.
217 static int ipcomp_tunnel_attach(struct xfrm_state *x)
220 struct xfrm_state *t;
222 t = xfrm_state_lookup((xfrm_address_t *)&x->id.daddr.a4,
223 x->props.saddr.a4, IPPROTO_IPIP, AF_INET);
225 t = ipcomp_tunnel_create(x);
230 xfrm_state_insert(t);
234 atomic_inc(&t->tunnel_users);
239 static void ipcomp_free_scratches(void)
244 if (--ipcomp_scratch_users)
247 scratches = ipcomp_scratches;
251 for_each_possible_cpu(i)
252 vfree(*per_cpu_ptr(scratches, i));
254 free_percpu(scratches);
257 static void **ipcomp_alloc_scratches(void)
262 if (ipcomp_scratch_users++)
263 return ipcomp_scratches;
265 scratches = alloc_percpu(void *);
269 ipcomp_scratches = scratches;
271 for_each_possible_cpu(i) {
272 void *scratch = vmalloc(IPCOMP_SCRATCH_SIZE);
275 *per_cpu_ptr(scratches, i) = scratch;
281 static void ipcomp_free_tfms(struct crypto_comp **tfms)
283 struct ipcomp_tfms *pos;
286 list_for_each_entry(pos, &ipcomp_tfms_list, list) {
287 if (pos->tfms == tfms)
296 list_del(&pos->list);
302 for_each_possible_cpu(cpu) {
303 struct crypto_comp *tfm = *per_cpu_ptr(tfms, cpu);
304 crypto_free_comp(tfm);
309 static struct crypto_comp **ipcomp_alloc_tfms(const char *alg_name)
311 struct ipcomp_tfms *pos;
312 struct crypto_comp **tfms;
315 /* This can be any valid CPU ID so we don't need locking. */
316 cpu = raw_smp_processor_id();
318 list_for_each_entry(pos, &ipcomp_tfms_list, list) {
319 struct crypto_comp *tfm;
322 tfm = *per_cpu_ptr(tfms, cpu);
324 if (!strcmp(crypto_comp_name(tfm), alg_name)) {
330 pos = kmalloc(sizeof(*pos), GFP_KERNEL);
335 INIT_LIST_HEAD(&pos->list);
336 list_add(&pos->list, &ipcomp_tfms_list);
338 pos->tfms = tfms = alloc_percpu(struct crypto_comp *);
342 for_each_possible_cpu(cpu) {
343 struct crypto_comp *tfm = crypto_alloc_comp(alg_name, 0,
347 *per_cpu_ptr(tfms, cpu) = tfm;
353 ipcomp_free_tfms(tfms);
357 static void ipcomp_free_data(struct ipcomp_data *ipcd)
360 ipcomp_free_tfms(ipcd->tfms);
361 ipcomp_free_scratches();
364 static void ipcomp_destroy(struct xfrm_state *x)
366 struct ipcomp_data *ipcd = x->data;
369 xfrm_state_delete_tunnel(x);
370 mutex_lock(&ipcomp_resource_mutex);
371 ipcomp_free_data(ipcd);
372 mutex_unlock(&ipcomp_resource_mutex);
376 static int ipcomp_init_state(struct xfrm_state *x)
379 struct ipcomp_data *ipcd;
380 struct xfrm_algo_desc *calg_desc;
389 x->props.header_len = 0;
390 switch (x->props.mode) {
391 case XFRM_MODE_TRANSPORT:
393 case XFRM_MODE_TUNNEL:
394 x->props.header_len += sizeof(struct iphdr);
401 ipcd = kzalloc(sizeof(*ipcd), GFP_KERNEL);
405 mutex_lock(&ipcomp_resource_mutex);
406 if (!ipcomp_alloc_scratches())
409 ipcd->tfms = ipcomp_alloc_tfms(x->calg->alg_name);
412 mutex_unlock(&ipcomp_resource_mutex);
414 if (x->props.mode == XFRM_MODE_TUNNEL) {
415 err = ipcomp_tunnel_attach(x);
420 calg_desc = xfrm_calg_get_byname(x->calg->alg_name, 0);
422 ipcd->threshold = calg_desc->uinfo.comp.threshold;
429 mutex_lock(&ipcomp_resource_mutex);
431 ipcomp_free_data(ipcd);
432 mutex_unlock(&ipcomp_resource_mutex);
437 static struct xfrm_type ipcomp_type = {
438 .description = "IPCOMP4",
439 .owner = THIS_MODULE,
440 .proto = IPPROTO_COMP,
441 .init_state = ipcomp_init_state,
442 .destructor = ipcomp_destroy,
443 .input = ipcomp_input,
444 .output = ipcomp_output
447 static struct net_protocol ipcomp4_protocol = {
448 .handler = xfrm4_rcv,
449 .err_handler = ipcomp4_err,
453 static int __init ipcomp4_init(void)
455 if (xfrm_register_type(&ipcomp_type, AF_INET) < 0) {
456 printk(KERN_INFO "ipcomp init: can't add xfrm type\n");
459 if (inet_add_protocol(&ipcomp4_protocol, IPPROTO_COMP) < 0) {
460 printk(KERN_INFO "ipcomp init: can't add protocol\n");
461 xfrm_unregister_type(&ipcomp_type, AF_INET);
467 static void __exit ipcomp4_fini(void)
469 if (inet_del_protocol(&ipcomp4_protocol, IPPROTO_COMP) < 0)
470 printk(KERN_INFO "ip ipcomp close: can't remove protocol\n");
471 if (xfrm_unregister_type(&ipcomp_type, AF_INET) < 0)
472 printk(KERN_INFO "ip ipcomp close: can't remove xfrm type\n");
475 module_init(ipcomp4_init);
476 module_exit(ipcomp4_fini);
478 MODULE_LICENSE("GPL");
479 MODULE_DESCRIPTION("IP Payload Compression Protocol (IPComp) - RFC3173");
480 MODULE_AUTHOR("James Morris <jmorris@intercode.com.au>");
482 MODULE_ALIAS_XFRM_TYPE(AF_INET, XFRM_PROTO_COMP);