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/semaphore.h>
38 #include <linux/crypto.h>
39 #include <linux/err.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
)
69 struct ip_comp_hdr
*ipch
;
71 struct ipcomp_data
*ipcd
= x
->data
;
73 struct crypto_comp
*tfm
;
76 if (skb_linearize_cow(skb
))
79 skb
->ip_summed
= CHECKSUM_NONE
;
81 /* Remove ipcomp header and decompress original payload */
82 ipch
= (void *)skb
->data
;
83 nexthdr
= ipch
->nexthdr
;
85 skb
->transport_header
= skb
->network_header
+ sizeof(*ipch
);
86 __skb_pull(skb
, sizeof(*ipch
));
90 dlen
= IPCOMP_SCRATCH_SIZE
;
94 scratch
= *per_cpu_ptr(ipcomp6_scratches
, cpu
);
95 tfm
= *per_cpu_ptr(ipcd
->tfms
, cpu
);
97 err
= crypto_comp_decompress(tfm
, start
, plen
, scratch
, &dlen
);
101 if (dlen
< (plen
+ sizeof(*ipch
))) {
106 err
= pskb_expand_head(skb
, 0, dlen
- plen
, GFP_ATOMIC
);
111 skb
->truesize
+= dlen
- plen
;
112 __skb_put(skb
, dlen
- plen
);
113 skb_copy_to_linear_data(skb
, scratch
, dlen
);
122 static int ipcomp6_output(struct xfrm_state
*x
, struct sk_buff
*skb
)
125 struct ip_comp_hdr
*ipch
;
126 struct ipcomp_data
*ipcd
= x
->data
;
129 struct crypto_comp
*tfm
;
132 /* check whether datagram len is larger than threshold */
133 if (skb
->len
< ipcd
->threshold
) {
137 if (skb_linearize_cow(skb
))
142 dlen
= IPCOMP_SCRATCH_SIZE
;
146 scratch
= *per_cpu_ptr(ipcomp6_scratches
, cpu
);
147 tfm
= *per_cpu_ptr(ipcd
->tfms
, cpu
);
150 err
= crypto_comp_compress(tfm
, start
, plen
, scratch
, &dlen
);
152 if (err
|| (dlen
+ sizeof(*ipch
)) >= plen
) {
156 memcpy(start
+ sizeof(struct ip_comp_hdr
), scratch
, dlen
);
158 pskb_trim(skb
, dlen
+ sizeof(struct ip_comp_hdr
));
160 /* insert ipcomp header and replace datagram */
161 ipch
= ip_comp_hdr(skb
);
162 ipch
->nexthdr
= *skb_mac_header(skb
);
164 ipch
->cpi
= htons((u16
)ntohl(x
->id
.spi
));
165 *skb_mac_header(skb
) = IPPROTO_COMP
;
168 skb_push(skb
, -skb_network_offset(skb
));
173 static void ipcomp6_err(struct sk_buff
*skb
, struct inet6_skb_parm
*opt
,
174 int type
, int code
, int offset
, __be32 info
)
177 struct ipv6hdr
*iph
= (struct ipv6hdr
*)skb
->data
;
178 struct ip_comp_hdr
*ipcomph
=
179 (struct ip_comp_hdr
*)(skb
->data
+ offset
);
180 struct xfrm_state
*x
;
182 if (type
!= ICMPV6_DEST_UNREACH
&& type
!= ICMPV6_PKT_TOOBIG
)
185 spi
= htonl(ntohs(ipcomph
->cpi
));
186 x
= xfrm_state_lookup((xfrm_address_t
*)&iph
->daddr
, spi
, IPPROTO_COMP
, AF_INET6
);
190 printk(KERN_DEBUG
"pmtu discovery on SA IPCOMP/%08x/" NIP6_FMT
"\n",
191 spi
, NIP6(iph
->daddr
));
195 static struct xfrm_state
*ipcomp6_tunnel_create(struct xfrm_state
*x
)
197 struct xfrm_state
*t
= NULL
;
199 t
= xfrm_state_alloc();
203 t
->id
.proto
= IPPROTO_IPV6
;
204 t
->id
.spi
= xfrm6_tunnel_alloc_spi((xfrm_address_t
*)&x
->props
.saddr
);
208 memcpy(t
->id
.daddr
.a6
, x
->id
.daddr
.a6
, sizeof(struct in6_addr
));
209 memcpy(&t
->sel
, &x
->sel
, sizeof(t
->sel
));
210 t
->props
.family
= AF_INET6
;
211 t
->props
.mode
= x
->props
.mode
;
212 memcpy(t
->props
.saddr
.a6
, x
->props
.saddr
.a6
, sizeof(struct in6_addr
));
214 if (xfrm_init_state(t
))
217 atomic_set(&t
->tunnel_users
, 1);
223 t
->km
.state
= XFRM_STATE_DEAD
;
229 static int ipcomp6_tunnel_attach(struct xfrm_state
*x
)
232 struct xfrm_state
*t
= NULL
;
235 spi
= xfrm6_tunnel_spi_lookup((xfrm_address_t
*)&x
->props
.saddr
);
237 t
= xfrm_state_lookup((xfrm_address_t
*)&x
->id
.daddr
,
238 spi
, IPPROTO_IPV6
, AF_INET6
);
240 t
= ipcomp6_tunnel_create(x
);
245 xfrm_state_insert(t
);
249 atomic_inc(&t
->tunnel_users
);
255 static void ipcomp6_free_scratches(void)
260 if (--ipcomp6_scratch_users
)
263 scratches
= ipcomp6_scratches
;
267 for_each_possible_cpu(i
) {
268 void *scratch
= *per_cpu_ptr(scratches
, i
);
273 free_percpu(scratches
);
276 static void **ipcomp6_alloc_scratches(void)
281 if (ipcomp6_scratch_users
++)
282 return ipcomp6_scratches
;
284 scratches
= alloc_percpu(void *);
288 ipcomp6_scratches
= scratches
;
290 for_each_possible_cpu(i
) {
291 void *scratch
= vmalloc(IPCOMP_SCRATCH_SIZE
);
294 *per_cpu_ptr(scratches
, i
) = scratch
;
300 static void ipcomp6_free_tfms(struct crypto_comp
**tfms
)
302 struct ipcomp6_tfms
*pos
;
305 list_for_each_entry(pos
, &ipcomp6_tfms_list
, list
) {
306 if (pos
->tfms
== tfms
)
315 list_del(&pos
->list
);
321 for_each_possible_cpu(cpu
) {
322 struct crypto_comp
*tfm
= *per_cpu_ptr(tfms
, cpu
);
323 crypto_free_comp(tfm
);
328 static struct crypto_comp
**ipcomp6_alloc_tfms(const char *alg_name
)
330 struct ipcomp6_tfms
*pos
;
331 struct crypto_comp
**tfms
;
334 /* This can be any valid CPU ID so we don't need locking. */
335 cpu
= raw_smp_processor_id();
337 list_for_each_entry(pos
, &ipcomp6_tfms_list
, list
) {
338 struct crypto_comp
*tfm
;
341 tfm
= *per_cpu_ptr(tfms
, cpu
);
343 if (!strcmp(crypto_comp_name(tfm
), alg_name
)) {
349 pos
= kmalloc(sizeof(*pos
), GFP_KERNEL
);
354 INIT_LIST_HEAD(&pos
->list
);
355 list_add(&pos
->list
, &ipcomp6_tfms_list
);
357 pos
->tfms
= tfms
= alloc_percpu(struct crypto_comp
*);
361 for_each_possible_cpu(cpu
) {
362 struct crypto_comp
*tfm
= crypto_alloc_comp(alg_name
, 0,
366 *per_cpu_ptr(tfms
, cpu
) = tfm
;
372 ipcomp6_free_tfms(tfms
);
376 static void ipcomp6_free_data(struct ipcomp_data
*ipcd
)
379 ipcomp6_free_tfms(ipcd
->tfms
);
380 ipcomp6_free_scratches();
383 static void ipcomp6_destroy(struct xfrm_state
*x
)
385 struct ipcomp_data
*ipcd
= x
->data
;
388 xfrm_state_delete_tunnel(x
);
389 mutex_lock(&ipcomp6_resource_mutex
);
390 ipcomp6_free_data(ipcd
);
391 mutex_unlock(&ipcomp6_resource_mutex
);
394 xfrm6_tunnel_free_spi((xfrm_address_t
*)&x
->props
.saddr
);
397 static int ipcomp6_init_state(struct xfrm_state
*x
)
400 struct ipcomp_data
*ipcd
;
401 struct xfrm_algo_desc
*calg_desc
;
410 x
->props
.header_len
= 0;
411 switch (x
->props
.mode
) {
412 case XFRM_MODE_TRANSPORT
:
414 case XFRM_MODE_TUNNEL
:
415 x
->props
.header_len
+= sizeof(struct ipv6hdr
);
422 ipcd
= kzalloc(sizeof(*ipcd
), GFP_KERNEL
);
426 mutex_lock(&ipcomp6_resource_mutex
);
427 if (!ipcomp6_alloc_scratches())
430 ipcd
->tfms
= ipcomp6_alloc_tfms(x
->calg
->alg_name
);
433 mutex_unlock(&ipcomp6_resource_mutex
);
435 if (x
->props
.mode
== XFRM_MODE_TUNNEL
) {
436 err
= ipcomp6_tunnel_attach(x
);
441 calg_desc
= xfrm_calg_get_byname(x
->calg
->alg_name
, 0);
443 ipcd
->threshold
= calg_desc
->uinfo
.comp
.threshold
;
449 mutex_lock(&ipcomp6_resource_mutex
);
451 ipcomp6_free_data(ipcd
);
452 mutex_unlock(&ipcomp6_resource_mutex
);
458 static const struct xfrm_type ipcomp6_type
=
460 .description
= "IPCOMP6",
461 .owner
= THIS_MODULE
,
462 .proto
= IPPROTO_COMP
,
463 .init_state
= ipcomp6_init_state
,
464 .destructor
= ipcomp6_destroy
,
465 .input
= ipcomp6_input
,
466 .output
= ipcomp6_output
,
467 .hdr_offset
= xfrm6_find_1stfragopt
,
470 static struct inet6_protocol ipcomp6_protocol
=
472 .handler
= xfrm6_rcv
,
473 .err_handler
= ipcomp6_err
,
474 .flags
= INET6_PROTO_NOPOLICY
,
477 static int __init
ipcomp6_init(void)
479 if (xfrm_register_type(&ipcomp6_type
, AF_INET6
) < 0) {
480 printk(KERN_INFO
"ipcomp6 init: can't add xfrm type\n");
483 if (inet6_add_protocol(&ipcomp6_protocol
, IPPROTO_COMP
) < 0) {
484 printk(KERN_INFO
"ipcomp6 init: can't add protocol\n");
485 xfrm_unregister_type(&ipcomp6_type
, AF_INET6
);
491 static void __exit
ipcomp6_fini(void)
493 if (inet6_del_protocol(&ipcomp6_protocol
, IPPROTO_COMP
) < 0)
494 printk(KERN_INFO
"ipv6 ipcomp close: can't remove protocol\n");
495 if (xfrm_unregister_type(&ipcomp6_type
, AF_INET6
) < 0)
496 printk(KERN_INFO
"ipv6 ipcomp close: can't remove xfrm type\n");
499 module_init(ipcomp6_init
);
500 module_exit(ipcomp6_fini
);
501 MODULE_LICENSE("GPL");
502 MODULE_DESCRIPTION("IP Payload Compression Protocol (IPComp) for IPv6 - RFC3173");
503 MODULE_AUTHOR("Mitsuru KANDA <mk@linux-ipv6.org>");
505 MODULE_ALIAS_XFRM_TYPE(AF_INET6
, XFRM_PROTO_COMP
);