]>
git.saurik.com Git - apple/xnu.git/blob - bsd/net/slcompress.c
2 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
23 * @APPLE_LICENSE_HEADER_END@
26 * Copyright (c) 1989, 1993, 1994
27 * The Regents of the University of California. All rights reserved.
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
32 * 1. Redistributions of source code must retain the above copyright
33 * notice, this list of conditions and the following disclaimer.
34 * 2. Redistributions in binary form must reproduce the above copyright
35 * notice, this list of conditions and the following disclaimer in the
36 * documentation and/or other materials provided with the distribution.
37 * 3. All advertising materials mentioning features or use of this software
38 * must display the following acknowledgement:
39 * This product includes software developed by the University of
40 * California, Berkeley and its contributors.
41 * 4. Neither the name of the University nor the names of its contributors
42 * may be used to endorse or promote products derived from this software
43 * without specific prior written permission.
45 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
57 * @(#)slcompress.c 8.2 (Berkeley) 4/16/94
58 * $FreeBSD: src/sys/net/slcompress.c,v 1.16 1999/12/29 04:38:37 peter Exp $
62 * Routines to compress and uncompess tcp packets (for transmission
63 * over low speed serial lines.
65 * Van Jacobson (van@helios.ee.lbl.gov), Dec 31, 1989:
66 * - Initial distribution.
70 #include <sys/param.h>
72 #include <sys/systm.h>
74 #include <netinet/in.h>
75 #include <netinet/in_systm.h>
76 #include <netinet/ip.h>
77 #include <netinet/tcp.h>
79 #include <net/slcompress.h>
82 #define INCR(counter) ++comp->counter;
87 #define BCMP(p1, p2, n) bcmp((char *)(p1), (char *)(p2), (int)(n))
88 #define BCOPY(p1, p2, n) bcopy((char *)(p1), (char *)(p2), (int)(n))
94 sl_compress_init(comp
, max_state
)
95 struct slcompress
*comp
;
99 register struct cstate
*tstate
= comp
->tstate
;
101 if (max_state
== -1) {
102 max_state
= MAX_STATES
- 1;
103 bzero((char *)comp
, sizeof(*comp
));
105 /* Don't reset statistics */
106 bzero((char *)comp
->tstate
, sizeof(comp
->tstate
));
107 bzero((char *)comp
->rstate
, sizeof(comp
->rstate
));
109 for (i
= max_state
; i
> 0; --i
) {
111 tstate
[i
].cs_next
= &tstate
[i
- 1];
113 tstate
[0].cs_next
= &tstate
[max_state
];
115 comp
->last_cs
= &tstate
[0];
116 comp
->last_recv
= 255;
117 comp
->last_xmit
= 255;
118 comp
->flags
= SLF_TOSS
;
122 /* ENCODE encodes a number that is known to be non-zero. ENCODEZ
123 * checks for zero (since zero has to be encoded in the long, 3 byte
126 #define ENCODE(n) { \
127 if ((u_int16_t)(n) >= 256) { \
136 #define ENCODEZ(n) { \
137 if ((u_int16_t)(n) >= 256 || (u_int16_t)(n) == 0) { \
147 #define DECODEL(f) { \
149 (f) = htonl(ntohl(f) + ((cp[1] << 8) | cp[2])); \
152 (f) = htonl(ntohl(f) + (u_int32_t)*cp++); \
156 #define DECODES(f) { \
158 (f) = htons(ntohs(f) + ((cp[1] << 8) | cp[2])); \
161 (f) = htons(ntohs(f) + (u_int32_t)*cp++); \
165 #define DECODEU(f) { \
167 (f) = htons((cp[1] << 8) | cp[2]); \
170 (f) = htons((u_int32_t)*cp++); \
175 * Attempt to compress an outgoing TCP packet and return the type of
176 * the result. The caller must have already verified that the protocol
177 * is TCP. The first mbuf must contain the complete IP and TCP headers,
178 * and "ip" must be == mtod(m, struct ip *). "comp" supplies the
179 * compression state, and "compress_cid" tells us whether it is OK
180 * to leave out the CID field when feasible.
182 * The caller is responsible for adjusting m->m_pkthdr.len upon return,
183 * if m is an M_PKTHDR mbuf.
186 sl_compress_tcp(m
, ip
, comp
, compress_cid
)
188 register struct ip
*ip
;
189 struct slcompress
*comp
;
192 register struct cstate
*cs
= comp
->last_cs
->cs_next
;
193 register u_int hlen
= ip
->ip_hl
;
194 register struct tcphdr
*oth
;
195 register struct tcphdr
*th
;
196 register u_int deltaS
, deltaA
;
197 register u_int changes
= 0;
199 register u_char
*cp
= new_seq
;
202 * Bail if this is an IP fragment or if the TCP packet isn't
203 * `compressible' (i.e., ACK isn't set or some other control bit is
204 * set). (We assume that the caller has already made sure the
205 * packet is IP proto TCP).
207 if ((ip
->ip_off
& htons(0x3fff)) || m
->m_len
< 40)
210 th
= (struct tcphdr
*)&((int32_t *)ip
)[hlen
];
211 if ((th
->th_flags
& (TH_SYN
|TH_FIN
|TH_RST
|TH_ACK
)) != TH_ACK
)
214 * Packet is compressible -- we're going to send either a
215 * COMPRESSED_TCP or UNCOMPRESSED_TCP packet. Either way we need
216 * to locate (or create) the connection state. Special case the
217 * most recently used connection since it's most likely to be used
218 * again & we don't have to do any reordering if it's used.
221 if (ip
->ip_src
.s_addr
!= cs
->cs_ip
.ip_src
.s_addr
||
222 ip
->ip_dst
.s_addr
!= cs
->cs_ip
.ip_dst
.s_addr
||
223 *(int32_t *)th
!= ((int32_t *)&cs
->cs_ip
)[cs
->cs_ip
.ip_hl
]) {
225 * Wasn't the first -- search for it.
227 * States are kept in a circularly linked list with
228 * last_cs pointing to the end of the list. The
229 * list is kept in lru order by moving a state to the
230 * head of the list whenever it is referenced. Since
231 * the list is short and, empirically, the connection
232 * we want is almost always near the front, we locate
233 * states via linear search. If we don't find a state
234 * for the datagram, the oldest state is (re-)used.
236 register struct cstate
*lcs
;
237 register struct cstate
*lastcs
= comp
->last_cs
;
240 lcs
= cs
; cs
= cs
->cs_next
;
242 if (ip
->ip_src
.s_addr
== cs
->cs_ip
.ip_src
.s_addr
243 && ip
->ip_dst
.s_addr
== cs
->cs_ip
.ip_dst
.s_addr
245 ((int32_t *)&cs
->cs_ip
)[cs
->cs_ip
.ip_hl
])
247 } while (cs
!= lastcs
);
250 * Didn't find it -- re-use oldest cstate. Send an
251 * uncompressed packet that tells the other side what
252 * connection number we're using for this conversation.
253 * Note that since the state list is circular, the oldest
254 * state points to the newest and we only need to set
255 * last_cs to update the lru linkage.
267 * Found it -- move to the front on the connection list.
272 lcs
->cs_next
= cs
->cs_next
;
273 cs
->cs_next
= lastcs
->cs_next
;
274 lastcs
->cs_next
= cs
;
279 * Make sure that only what we expect to change changed. The first
280 * line of the `if' checks the IP protocol version, header length &
281 * type of service. The 2nd line checks the "Don't fragment" bit.
282 * The 3rd line checks the time-to-live and protocol (the protocol
283 * check is unnecessary but costless). The 4th line checks the TCP
284 * header length. The 5th line checks IP options, if any. The 6th
285 * line checks TCP options, if any. If any of these things are
286 * different between the previous & current datagram, we send the
287 * current datagram `uncompressed'.
289 oth
= (struct tcphdr
*)&((int32_t *)&cs
->cs_ip
)[hlen
];
296 if (((u_int16_t
*)ip
)[0] != ((u_int16_t
*)&cs
->cs_ip
)[0] ||
297 ((u_int16_t
*)ip
)[3] != ((u_int16_t
*)&cs
->cs_ip
)[3] ||
298 ((u_int16_t
*)ip
)[4] != ((u_int16_t
*)&cs
->cs_ip
)[4] ||
299 th
->th_off
!= oth
->th_off
||
301 BCMP(ip
+ 1, &cs
->cs_ip
+ 1, (deltaS
- 5) << 2)) ||
303 BCMP(th
+ 1, oth
+ 1, (th
->th_off
- 5) << 2)))
307 * Figure out which of the changing fields changed. The
308 * receiver expects changes in the order: urgent, window,
309 * ack, seq (the order minimizes the number of temporaries
310 * needed in this section of code).
312 if (th
->th_flags
& TH_URG
) {
313 deltaS
= ntohs(th
->th_urp
);
316 } else if (th
->th_urp
!= oth
->th_urp
)
317 /* argh! URG not set but urp changed -- a sensible
318 * implementation should never do this but RFC793
319 * doesn't prohibit the change so we have to deal
323 deltaS
= (u_int16_t
)(ntohs(th
->th_win
) - ntohs(oth
->th_win
));
329 deltaA
= ntohl(th
->th_ack
) - ntohl(oth
->th_ack
);
337 deltaS
= ntohl(th
->th_seq
) - ntohl(oth
->th_seq
);
349 * Nothing changed. If this packet contains data and the
350 * last one didn't, this is probably a data packet following
351 * an ack (normal on an interactive connection) and we send
352 * it compressed. Otherwise it's probably a retransmit,
353 * retransmitted ack or window probe. Send it uncompressed
354 * in case the other side missed the compressed version.
356 if (ip
->ip_len
!= cs
->cs_ip
.ip_len
&&
357 ntohs(cs
->cs_ip
.ip_len
) == hlen
)
365 * actual changes match one of our special case encodings --
366 * send packet uncompressed.
371 if (deltaS
== deltaA
&&
372 deltaS
== ntohs(cs
->cs_ip
.ip_len
) - hlen
) {
373 /* special case for echoed terminal traffic */
380 if (deltaS
== ntohs(cs
->cs_ip
.ip_len
) - hlen
) {
381 /* special case for data xfer */
388 deltaS
= ntohs(ip
->ip_id
) - ntohs(cs
->cs_ip
.ip_id
);
393 if (th
->th_flags
& TH_PUSH
)
394 changes
|= TCP_PUSH_BIT
;
396 * Grab the cksum before we overwrite it below. Then update our
397 * state with this packet's header.
399 deltaA
= ntohs(th
->th_sum
);
400 BCOPY(ip
, &cs
->cs_ip
, hlen
);
403 * We want to use the original packet as our compressed packet.
404 * (cp - new_seq) is the number of bytes we need for compressed
405 * sequence numbers. In addition we need one byte for the change
406 * mask, one for the connection id and two for the tcp checksum.
407 * So, (cp - new_seq) + 4 bytes of header are needed. hlen is how
408 * many bytes of the original packet to toss so subtract the two to
409 * get the new packet size.
411 deltaS
= cp
- new_seq
;
413 if (compress_cid
== 0 || comp
->last_xmit
!= cs
->cs_id
) {
414 comp
->last_xmit
= cs
->cs_id
;
417 *cp
++ = changes
| NEW_C
;
428 BCOPY(new_seq
, cp
, deltaS
);
430 return (TYPE_COMPRESSED_TCP
);
433 * Update connection state cs & send uncompressed packet ('uncompressed'
434 * means a regular ip/tcp packet but with the 'conversation id' we hope
435 * to use on future compressed packets in the protocol field).
438 BCOPY(ip
, &cs
->cs_ip
, hlen
);
439 ip
->ip_p
= cs
->cs_id
;
440 comp
->last_xmit
= cs
->cs_id
;
441 return (TYPE_UNCOMPRESSED_TCP
);
446 sl_uncompress_tcp(bufp
, len
, type
, comp
)
450 struct slcompress
*comp
;
455 cp
= bufp
? *bufp
: NULL
;
456 vjlen
= sl_uncompress_tcp_core(cp
, len
, len
, type
, comp
, &hdr
, &hlen
);
458 return (0); /* error */
460 return (len
); /* was uncompressed already */
466 * At this point, cp points to the first byte of data in the
467 * packet. If we're not aligned on a 4-byte boundary, copy the
468 * data down so the ip & tcp headers will be aligned. Then back up
469 * cp by the tcp/ip header length to make room for the reconstructed
470 * header (we assume the packet we were handed has enough space to
471 * prepend 128 bytes of header).
473 if ((intptr_t)cp
& 3) {
475 (void) ovbcopy(cp
, (caddr_t
)((intptr_t)cp
&~ 3), len
);
476 cp
= (u_char
*)((intptr_t)cp
&~ 3);
480 BCOPY(hdr
, cp
, hlen
);
487 * Uncompress a packet of total length total_len. The first buflen
488 * bytes are at buf; this must include the entire (compressed or
489 * uncompressed) TCP/IP header. This procedure returns the length
490 * of the VJ header, with a pointer to the uncompressed IP header
491 * in *hdrp and its length in *hlenp.
494 sl_uncompress_tcp_core(buf
, buflen
, total_len
, type
, comp
, hdrp
, hlenp
)
496 int buflen
, total_len
;
498 struct slcompress
*comp
;
503 register u_int hlen
, changes
;
504 register struct tcphdr
*th
;
505 register struct cstate
*cs
;
506 register struct ip
*ip
;
507 register u_int16_t
*bp
;
508 register u_int vjlen
;
512 case TYPE_UNCOMPRESSED_TCP
:
513 ip
= (struct ip
*) buf
;
514 if (ip
->ip_p
>= MAX_STATES
)
516 cs
= &comp
->rstate
[comp
->last_recv
= ip
->ip_p
];
517 comp
->flags
&=~ SLF_TOSS
;
518 ip
->ip_p
= IPPROTO_TCP
;
520 * Calculate the size of the TCP/IP header and make sure that
521 * we don't overflow the space we have available for it.
523 hlen
= ip
->ip_hl
<< 2;
524 if (hlen
+ sizeof(struct tcphdr
) > buflen
)
526 hlen
+= ((struct tcphdr
*)&((char *)ip
)[hlen
])->th_off
<< 2;
527 if (hlen
> MAX_HDR
|| hlen
> buflen
)
529 BCOPY(ip
, &cs
->cs_ip
, hlen
);
531 INCR(sls_uncompressedin
)
532 *hdrp
= (u_char
*) &cs
->cs_ip
;
539 case TYPE_COMPRESSED_TCP
:
542 /* We've got a compressed packet. */
543 INCR(sls_compressedin
)
546 if (changes
& NEW_C
) {
547 /* Make sure the state index is in range, then grab the state.
548 * If we have a good state index, clear the 'discard' flag. */
549 if (*cp
>= MAX_STATES
)
552 comp
->flags
&=~ SLF_TOSS
;
553 comp
->last_recv
= *cp
++;
555 /* this packet has an implicit state index. If we've
556 * had a line error since the last time we got an
557 * explicit state index, we have to toss the packet. */
558 if (comp
->flags
& SLF_TOSS
) {
563 cs
= &comp
->rstate
[comp
->last_recv
];
564 hlen
= cs
->cs_ip
.ip_hl
<< 2;
565 th
= (struct tcphdr
*)&((u_char
*)&cs
->cs_ip
)[hlen
];
566 th
->th_sum
= htons((*cp
<< 8) | cp
[1]);
568 if (changes
& TCP_PUSH_BIT
)
569 th
->th_flags
|= TH_PUSH
;
571 th
->th_flags
&=~ TH_PUSH
;
573 switch (changes
& SPECIALS_MASK
) {
576 register u_int i
= ntohs(cs
->cs_ip
.ip_len
) - cs
->cs_hlen
;
577 th
->th_ack
= htonl(ntohl(th
->th_ack
) + i
);
578 th
->th_seq
= htonl(ntohl(th
->th_seq
) + i
);
583 th
->th_seq
= htonl(ntohl(th
->th_seq
) + ntohs(cs
->cs_ip
.ip_len
)
588 if (changes
& NEW_U
) {
589 th
->th_flags
|= TH_URG
;
592 th
->th_flags
&=~ TH_URG
;
601 if (changes
& NEW_I
) {
602 DECODES(cs
->cs_ip
.ip_id
)
604 cs
->cs_ip
.ip_id
= htons(ntohs(cs
->cs_ip
.ip_id
) + 1);
607 * At this point, cp points to the first byte of data in the
608 * packet. Fill in the IP total length and update the IP
614 /* we must have dropped some characters (crc should detect
615 * this but the old slip framing won't) */
618 total_len
+= cs
->cs_hlen
- vjlen
;
619 cs
->cs_ip
.ip_len
= htons(total_len
);
621 /* recompute the ip header checksum */
622 bp
= (u_int16_t
*) &cs
->cs_ip
;
623 cs
->cs_ip
.ip_sum
= 0;
624 for (changes
= 0; hlen
> 0; hlen
-= 2)
626 changes
= (changes
& 0xffff) + (changes
>> 16);
627 changes
= (changes
& 0xffff) + (changes
>> 16);
628 cs
->cs_ip
.ip_sum
= ~ changes
;
630 *hdrp
= (u_char
*) &cs
->cs_ip
;
631 *hlenp
= cs
->cs_hlen
;
635 comp
->flags
|= SLF_TOSS
;