5 * Copyright (c) 1996-1999 Whistle Communications, Inc.
8 * Subject to the following obligations and disclaimer of warranty, use and
9 * redistribution of this software, in source or object code forms, with or
10 * without modifications are expressly permitted by Whistle Communications;
11 * provided, however, that:
12 * 1. Any and all reproductions of the source or object code must include the
13 * copyright notice above and the following disclaimer of warranties; and
14 * 2. No rights are granted, in any manner or form, to use Whistle
15 * Communications, Inc. trademarks, including the mark "WHISTLE
16 * COMMUNICATIONS" on advertising, endorsements, or otherwise except as
17 * such appears in the above copyright notice or in the software.
19 * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
20 * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
21 * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
22 * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
24 * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
25 * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
26 * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
27 * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
28 * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
29 * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
30 * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
34 * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
37 * Author: Archie Cobbs <archie@freebsd.org>
39 * $FreeBSD: src/sys/netgraph/ng_vjc.c,v 1.9.2.5 2002/07/02 23:44:03 archie Exp $
40 * $DragonFly: src/sys/netgraph/vjc/ng_vjc.c,v 1.8 2008/01/05 14:02:40 swildner Exp $
41 * $Whistle: ng_vjc.c,v 1.17 1999/11/01 09:24:52 julian Exp $
45 * This node performs Van Jacobson IP header (de)compression.
46 * You must have included net/slcompress.c in your kernel compilation.
49 #include <sys/param.h>
50 #include <sys/systm.h>
51 #include <sys/errno.h>
52 #include <sys/kernel.h>
54 #include <sys/malloc.h>
55 #include <sys/errno.h>
57 #include <netgraph/ng_message.h>
58 #include <netgraph/netgraph.h>
59 #include <netgraph/ng_parse.h>
62 #include <netinet/in.h>
63 #include <netinet/in_systm.h>
64 #include <netinet/ip.h>
65 #include <netinet/tcp.h>
67 #include <net/slcompress.h>
69 /* Check agreement with slcompress.c */
70 #if MAX_STATES != NG_VJC_MAX_CHANNELS
71 #error NG_VJC_MAX_CHANNELS must be the same as MAX_STATES
74 /* Maximum length of a compressed TCP VJ header */
75 #define MAX_VJHEADER 19
77 /* Node private data */
78 struct ng_vjc_private
{
79 struct ngm_vjc_config conf
;
80 struct slcompress slc
;
86 typedef struct ng_vjc_private
*priv_p
;
88 #define ERROUT(x) do { error = (x); goto done; } while (0)
90 /* Netgraph node methods */
91 static ng_constructor_t ng_vjc_constructor
;
92 static ng_rcvmsg_t ng_vjc_rcvmsg
;
93 static ng_shutdown_t ng_vjc_rmnode
;
94 static ng_newhook_t ng_vjc_newhook
;
95 static ng_rcvdata_t ng_vjc_rcvdata
;
96 static ng_disconnect_t ng_vjc_disconnect
;
99 static struct mbuf
*ng_vjc_pulluphdrs(struct mbuf
*m
, int knownTCP
);
101 /* Parse type for struct ngm_vjc_config */
102 static const struct ng_parse_struct_field ng_vjc_config_type_fields
[]
103 = NG_VJC_CONFIG_TYPE_INFO
;
104 static const struct ng_parse_type ng_vjc_config_type
= {
105 &ng_parse_struct_type
,
106 &ng_vjc_config_type_fields
109 /* Parse type for the 'last_cs' and 'cs_next' fields in struct slcompress,
110 which are pointers converted to integer indices, so parse them that way. */
111 #if _MACHINE_ARCH == i386
112 #define NG_VJC_TSTATE_PTR_TYPE &ng_parse_uint32_type
114 #error Unsupported _MACHINE_ARCH
117 /* Parse type for the 'cs_hdr' field in a struct cstate. Ideally we would
118 like to use a 'struct ip' type instead of a simple array of bytes. */
119 static const struct ng_parse_fixedarray_info ng_vjc_cs_hdr_type_info
= {
120 &ng_parse_hint8_type
,
123 static const struct ng_parse_type ng_vjc_cs_hdr_type
= {
124 &ng_parse_fixedarray_type
,
125 &ng_vjc_cs_hdr_type_info
128 /* Parse type for a struct cstate */
129 static const struct ng_parse_struct_field ng_vjc_cstate_type_fields
[] = {
130 { "cs_next", NG_VJC_TSTATE_PTR_TYPE
},
131 { "cs_hlen", &ng_parse_uint16_type
},
132 { "cs_id", &ng_parse_uint8_type
},
133 { "cs_filler", &ng_parse_uint8_type
},
134 { "cs_hdr", &ng_vjc_cs_hdr_type
},
137 static const struct ng_parse_type ng_vjc_cstate_type
= {
138 &ng_parse_struct_type
,
139 &ng_vjc_cstate_type_fields
142 /* Parse type for an array of MAX_STATES struct cstate's, ie, tstate & rstate */
143 static const struct ng_parse_fixedarray_info ng_vjc_cstatearray_type_info
= {
147 static const struct ng_parse_type ng_vjc_cstatearray_type
= {
148 &ng_parse_fixedarray_type
,
149 &ng_vjc_cstatearray_type_info
152 /* Parse type for struct slcompress. Keep this in sync with the
153 definition of struct slcompress defined in <net/slcompress.h> */
154 static const struct ng_parse_struct_field ng_vjc_slcompress_type_fields
[] = {
155 { "last_cs", NG_VJC_TSTATE_PTR_TYPE
},
156 { "last_recv", &ng_parse_uint8_type
},
157 { "last_xmit", &ng_parse_uint8_type
},
158 { "flags", &ng_parse_hint16_type
},
160 { "sls_packets", &ng_parse_uint32_type
},
161 { "sls_compressed", &ng_parse_uint32_type
},
162 { "sls_searches", &ng_parse_uint32_type
},
163 { "sls_misses", &ng_parse_uint32_type
},
164 { "sls_uncompressedin", &ng_parse_uint32_type
},
165 { "sls_compressedin", &ng_parse_uint32_type
},
166 { "sls_errorin", &ng_parse_uint32_type
},
167 { "sls_tossed", &ng_parse_uint32_type
},
169 { "tstate", &ng_vjc_cstatearray_type
},
170 { "rstate", &ng_vjc_cstatearray_type
},
173 static const struct ng_parse_type ng_vjc_slcompress_type
= {
174 &ng_parse_struct_type
,
175 &ng_vjc_slcompress_type_fields
178 /* List of commands and how to convert arguments to/from ASCII */
179 static const struct ng_cmdlist ng_vjc_cmds
[] = {
199 &ng_vjc_slcompress_type
,
218 /* Node type descriptor */
219 static struct ng_type ng_vjc_typestruct
= {
234 NETGRAPH_INIT(vjc
, &ng_vjc_typestruct
);
236 /************************************************************************
237 NETGRAPH NODE METHODS
238 ************************************************************************/
244 ng_vjc_constructor(node_p
*nodep
)
249 /* Allocate private structure */
250 MALLOC(priv
, priv_p
, sizeof(*priv
), M_NETGRAPH
, M_NOWAIT
| M_ZERO
);
254 /* Call generic node constructor */
255 if ((error
= ng_make_node_common(&ng_vjc_typestruct
, nodep
))) {
256 FREE(priv
, M_NETGRAPH
);
259 (*nodep
)->private = priv
;
269 ng_vjc_newhook(node_p node
, hook_p hook
, const char *name
)
271 const priv_p priv
= (priv_p
) node
->private;
275 if (strcmp(name
, NG_VJC_HOOK_IP
) == 0)
277 else if (strcmp(name
, NG_VJC_HOOK_VJCOMP
) == 0)
278 hookp
= &priv
->vjcomp
;
279 else if (strcmp(name
, NG_VJC_HOOK_VJUNCOMP
) == 0)
280 hookp
= &priv
->vjuncomp
;
281 else if (strcmp(name
, NG_VJC_HOOK_VJIP
) == 0)
286 /* See if already connected */
296 * Receive a control message
299 ng_vjc_rcvmsg(node_p node
, struct ng_mesg
*msg
,
300 const char *raddr
, struct ng_mesg
**rptr
)
302 const priv_p priv
= (priv_p
) node
->private;
303 struct ng_mesg
*resp
= NULL
;
306 /* Check type cookie */
307 switch (msg
->header
.typecookie
) {
309 switch (msg
->header
.cmd
) {
310 case NGM_VJC_SET_CONFIG
:
312 struct ngm_vjc_config
*const c
=
313 (struct ngm_vjc_config
*) msg
->data
;
315 if (msg
->header
.arglen
!= sizeof(*c
))
317 if ((priv
->conf
.enableComp
|| priv
->conf
.enableDecomp
)
318 && (c
->enableComp
|| c
->enableDecomp
))
321 if (c
->maxChannel
> NG_VJC_MAX_CHANNELS
- 1
322 || c
->maxChannel
< NG_VJC_MIN_CHANNELS
- 1)
325 c
->maxChannel
= NG_VJC_MAX_CHANNELS
- 1;
326 if (c
->enableComp
!= 0 || c
->enableDecomp
!= 0) {
327 bzero(&priv
->slc
, sizeof(priv
->slc
));
328 sl_compress_init(&priv
->slc
, c
->maxChannel
);
333 case NGM_VJC_GET_CONFIG
:
335 struct ngm_vjc_config
*conf
;
337 NG_MKRESPONSE(resp
, msg
, sizeof(*conf
), M_NOWAIT
);
340 conf
= (struct ngm_vjc_config
*)resp
->data
;
344 case NGM_VJC_GET_STATE
:
346 const struct slcompress
*const sl0
= &priv
->slc
;
347 struct slcompress
*sl
;
351 /* Get response structure */
352 NG_MKRESPONSE(resp
, msg
, sizeof(*sl
), M_NOWAIT
);
355 sl
= (struct slcompress
*)resp
->data
;
358 /* Replace pointers with integer indicies */
359 if (sl
->last_cs
!= NULL
) {
360 index
= sl0
->last_cs
- sl0
->tstate
;
361 bzero(&sl
->last_cs
, sizeof(sl
->last_cs
));
362 *((u_int16_t
*)&sl
->last_cs
) = index
;
364 for (i
= 0; i
< MAX_STATES
; i
++) {
365 struct cstate
*const cs
= &sl
->tstate
[i
];
367 index
= sl0
->tstate
[i
].cs_next
- sl0
->tstate
;
368 bzero(&cs
->cs_next
, sizeof(cs
->cs_next
));
369 *((u_int16_t
*)&cs
->cs_next
) = index
;
373 case NGM_VJC_CLR_STATS
:
374 priv
->slc
.sls_packets
= 0;
375 priv
->slc
.sls_compressed
= 0;
376 priv
->slc
.sls_searches
= 0;
377 priv
->slc
.sls_misses
= 0;
378 priv
->slc
.sls_uncompressedin
= 0;
379 priv
->slc
.sls_compressedin
= 0;
380 priv
->slc
.sls_errorin
= 0;
381 priv
->slc
.sls_tossed
= 0;
383 case NGM_VJC_RECV_ERROR
:
384 sl_uncompress_tcp(NULL
, 0, TYPE_ERROR
, &priv
->slc
);
398 FREE(resp
, M_NETGRAPH
);
401 FREE(msg
, M_NETGRAPH
);
409 ng_vjc_rcvdata(hook_p hook
, struct mbuf
*m
, meta_p meta
)
411 const node_p node
= hook
->node
;
412 const priv_p priv
= (priv_p
) node
->private;
415 if (hook
== priv
->ip
) { /* outgoing packet */
416 u_int type
= TYPE_IP
;
418 /* Compress packet if enabled and proto is TCP */
419 if (priv
->conf
.enableComp
) {
422 if ((m
= ng_vjc_pulluphdrs(m
, 0)) == NULL
) {
426 ip
= mtod(m
, struct ip
*);
427 if (ip
->ip_p
== IPPROTO_TCP
) {
428 const int origLen
= m
->m_len
;
430 type
= sl_compress_tcp(m
, ip
,
431 &priv
->slc
, priv
->conf
.compressCID
);
432 m
->m_pkthdr
.len
+= m
->m_len
- origLen
;
436 /* Dispatch to the appropriate outgoing hook */
441 case TYPE_UNCOMPRESSED_TCP
:
442 hook
= priv
->vjuncomp
;
444 case TYPE_COMPRESSED_TCP
:
448 panic("%s: type=%d", __func__
, type
);
450 } else if (hook
== priv
->vjcomp
) { /* incoming compressed packet */
451 int vjlen
, need2pullup
;
456 /* Are we decompressing? */
457 if (!priv
->conf
.enableDecomp
) {
458 NG_FREE_DATA(m
, meta
);
462 /* Pull up the necessary amount from the mbuf */
463 need2pullup
= MAX_VJHEADER
;
464 if (need2pullup
> m
->m_pkthdr
.len
)
465 need2pullup
= m
->m_pkthdr
.len
;
466 if (m
->m_len
< need2pullup
467 && (m
= m_pullup(m
, need2pullup
)) == NULL
) {
468 priv
->slc
.sls_errorin
++;
473 /* Uncompress packet to reconstruct TCP/IP header */
474 vjlen
= sl_uncompress_tcp_core(mtod(m
, u_char
*),
475 m
->m_len
, m
->m_pkthdr
.len
, TYPE_COMPRESSED_TCP
,
476 &priv
->slc
, &hdr
, &hlen
);
478 NG_FREE_DATA(m
, meta
);
483 /* Copy the reconstructed TCP/IP headers into a new mbuf */
484 MGETHDR(hm
, MB_DONTWAIT
, MT_DATA
);
486 priv
->slc
.sls_errorin
++;
487 NG_FREE_DATA(m
, meta
);
491 hm
->m_pkthdr
.rcvif
= NULL
;
492 if (hlen
> MHLEN
) { /* unlikely, but can happen */
493 MCLGET(hm
, MB_DONTWAIT
);
494 if ((hm
->m_flags
& M_EXT
) == 0) {
496 priv
->slc
.sls_errorin
++;
497 NG_FREE_DATA(m
, meta
);
501 bcopy(hdr
, mtod(hm
, u_char
*), hlen
);
504 /* Glue TCP/IP headers and rest of packet together */
506 hm
->m_pkthdr
.len
= hlen
+ m
->m_pkthdr
.len
;
509 } else if (hook
== priv
->vjuncomp
) { /* incoming uncompressed pkt */
513 /* Are we decompressing? */
514 if (!priv
->conf
.enableDecomp
) {
515 NG_FREE_DATA(m
, meta
);
519 /* Pull up IP+TCP headers */
520 if ((m
= ng_vjc_pulluphdrs(m
, 1)) == NULL
) {
525 /* Run packet through uncompressor */
526 if (sl_uncompress_tcp_core(mtod(m
, u_char
*),
527 m
->m_len
, m
->m_pkthdr
.len
, TYPE_UNCOMPRESSED_TCP
,
528 &priv
->slc
, &hdr
, &hlen
) < 0) {
529 NG_FREE_DATA(m
, meta
);
533 } else if (hook
== priv
->vjip
) /* incoming regular packet (bypass) */
536 panic("%s: unknown hook", __func__
);
538 /* Send result back out */
539 NG_SEND_DATA(error
, hook
, m
, meta
);
547 ng_vjc_rmnode(node_p node
)
549 const priv_p priv
= (priv_p
) node
->private;
551 node
->flags
|= NG_INVALID
;
554 bzero(priv
, sizeof(*priv
));
555 FREE(priv
, M_NETGRAPH
);
556 node
->private = NULL
;
565 ng_vjc_disconnect(hook_p hook
)
567 const node_p node
= hook
->node
;
568 const priv_p priv
= node
->private;
570 /* Zero out hook pointer */
571 if (hook
== priv
->ip
)
573 else if (hook
== priv
->vjcomp
)
575 else if (hook
== priv
->vjuncomp
)
576 priv
->vjuncomp
= NULL
;
577 else if (hook
== priv
->vjip
)
580 panic("%s: unknown hook", __func__
);
582 /* Go away if no hooks left */
583 if (node
->numhooks
== 0)
588 /************************************************************************
590 ************************************************************************/
593 * Pull up the full IP and TCP headers of a packet. If packet is not
594 * a TCP packet, just pull up the IP header.
597 ng_vjc_pulluphdrs(struct mbuf
*m
, int knownTCP
)
603 if (m
->m_len
< sizeof(*ip
) && (m
= m_pullup(m
, sizeof(*ip
))) == NULL
)
605 ip
= mtod(m
, struct ip
*);
606 if (!knownTCP
&& ip
->ip_p
!= IPPROTO_TCP
)
608 ihlen
= ip
->ip_hl
<< 2;
609 if (m
->m_len
< ihlen
+ sizeof(*tcp
)) {
610 if ((m
= m_pullup(m
, ihlen
+ sizeof(*tcp
))) == NULL
)
612 ip
= mtod(m
, struct ip
*);
614 tcp
= (struct tcphdr
*)((u_char
*)ip
+ ihlen
);
615 thlen
= tcp
->th_off
<< 2;
616 if (m
->m_len
< ihlen
+ thlen
)
617 m
= m_pullup(m
, ihlen
+ thlen
);