2 * ppp_deflate.c - interface the zlib procedures for Deflate compression
3 * and decompression (as used by gzip) to the PPP code.
4 * This version is for use with STREAMS under SunOS 4.x, Solaris 2,
5 * SVR4, OSF/1 and AIX 4.x.
7 * Copyright (c) 1994 The Australian National University.
10 * Permission to use, copy, modify, and distribute this software and its
11 * documentation is hereby granted, provided that the above copyright
12 * notice appears in all copies. This software is provided without any
13 * warranty, express or implied. The Australian National University
14 * makes no representations about the suitability of this software for
17 * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
18 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
19 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
20 * THE AUSTRALIAN NATIONAL UNIVERSITY HAS BEEN ADVISED OF THE POSSIBILITY
23 * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
24 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
25 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
26 * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
27 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
30 * $Id: deflate.c,v 1.1.1.4 2003/10/14 08:09:53 sparq Exp $
34 #include <net/net_globals.h>
36 #include <sys/param.h>
37 #include <sys/types.h>
38 #include <sys/stream.h>
39 #include <net/ppp_defs.h>
42 #define PACKETPTR mblk_t *
43 #include <net/ppp-comp.h>
48 #include "../common/zlib.h"
53 #define DEFLATE_DEBUG 1
56 * State for a Deflate (de)compressor.
58 struct deflate_state
{
66 struct compstat stats
;
69 #define DEFLATE_OVHD 2 /* Deflate overhead/packet */
71 static void *z_alloc
__P((void *, u_int items
, u_int size
));
72 static void *z_alloc_init
__P((void *, u_int items
, u_int size
));
73 static void z_free
__P((void *, void *ptr
));
74 static void *z_comp_alloc
__P((u_char
*options
, int opt_len
));
75 static void *z_decomp_alloc
__P((u_char
*options
, int opt_len
));
76 static void z_comp_free
__P((void *state
));
77 static void z_decomp_free
__P((void *state
));
78 static int z_comp_init
__P((void *state
, u_char
*options
, int opt_len
,
79 int unit
, int hdrlen
, int debug
));
80 static int z_decomp_init
__P((void *state
, u_char
*options
, int opt_len
,
81 int unit
, int hdrlen
, int mru
, int debug
));
82 static int z_compress
__P((void *state
, mblk_t
**mret
,
83 mblk_t
*mp
, int slen
, int maxolen
));
84 static void z_incomp
__P((void *state
, mblk_t
*dmsg
));
85 static int z_decompress
__P((void *state
, mblk_t
*cmp
,
87 static void z_comp_reset
__P((void *state
));
88 static void z_decomp_reset
__P((void *state
));
89 static void z_comp_stats
__P((void *state
, struct compstat
*stats
));
92 * Procedures exported to ppp_comp.c.
94 struct compressor ppp_deflate
= {
95 CI_DEFLATE
, /* compress_proto */
96 z_comp_alloc
, /* comp_alloc */
97 z_comp_free
, /* comp_free */
98 z_comp_init
, /* comp_init */
99 z_comp_reset
, /* comp_reset */
100 z_compress
, /* compress */
101 z_comp_stats
, /* comp_stat */
102 z_decomp_alloc
, /* decomp_alloc */
103 z_decomp_free
, /* decomp_free */
104 z_decomp_init
, /* decomp_init */
105 z_decomp_reset
, /* decomp_reset */
106 z_decompress
, /* decompress */
107 z_incomp
, /* incomp */
108 z_comp_stats
, /* decomp_stat */
111 struct compressor ppp_deflate_draft
= {
112 CI_DEFLATE_DRAFT
, /* compress_proto */
113 z_comp_alloc
, /* comp_alloc */
114 z_comp_free
, /* comp_free */
115 z_comp_init
, /* comp_init */
116 z_comp_reset
, /* comp_reset */
117 z_compress
, /* compress */
118 z_comp_stats
, /* comp_stat */
119 z_decomp_alloc
, /* decomp_alloc */
120 z_decomp_free
, /* decomp_free */
121 z_decomp_init
, /* decomp_init */
122 z_decomp_reset
, /* decomp_reset */
123 z_decompress
, /* decompress */
124 z_incomp
, /* incomp */
125 z_comp_stats
, /* decomp_stat */
128 #define DECOMP_CHUNK 512
131 * Space allocation and freeing routines for use by zlib routines.
138 #define GUARD_MAGIC 0x77a6011a
141 z_alloc_init(notused
, items
, size
)
147 size
= items
* size
+ sizeof(struct zchunk
);
149 z
= (struct zchunk
*) ALLOC_SLEEP(size
);
151 z
= (struct zchunk
*) ALLOC_NOSLEEP(size
);
154 z
->guard
= GUARD_MAGIC
;
155 return (void *) (z
+ 1);
159 z_alloc(notused
, items
, size
)
165 size
= items
* size
+ sizeof(struct zchunk
);
166 z
= (struct zchunk
*) ALLOC_NOSLEEP(size
);
168 z
->guard
= GUARD_MAGIC
;
169 return (void *) (z
+ 1);
177 struct zchunk
*z
= ((struct zchunk
*) ptr
) - 1;
179 if (z
->guard
!= GUARD_MAGIC
) {
180 printf("ppp: z_free of corrupted chunk at %x (%x, %x)\n",
181 z
, z
->size
, z
->guard
);
188 * Allocate space for a compressor.
191 z_comp_alloc(options
, opt_len
)
195 struct deflate_state
*state
;
198 if (opt_len
!= CILEN_DEFLATE
199 || (options
[0] != CI_DEFLATE
&& options
[0] != CI_DEFLATE_DRAFT
)
200 || options
[1] != CILEN_DEFLATE
201 || DEFLATE_METHOD(options
[2]) != DEFLATE_METHOD_VAL
202 || options
[3] != DEFLATE_CHK_SEQUENCE
)
204 w_size
= DEFLATE_SIZE(options
[2]);
206 * N.B. the 9 below should be DEFLATE_MIN_SIZE (8), but using
207 * 8 will cause kernel crashes because of a bug in zlib.
209 if (w_size
< 9 || w_size
> DEFLATE_MAX_SIZE
)
214 state
= (struct deflate_state
*) ALLOC_SLEEP(sizeof(*state
));
216 state
= (struct deflate_state
*) ALLOC_NOSLEEP(sizeof(*state
));
222 state
->strm
.next_in
= NULL
;
223 state
->strm
.zalloc
= (alloc_func
) z_alloc_init
;
224 state
->strm
.zfree
= (free_func
) z_free
;
225 if (deflateInit2(&state
->strm
, Z_DEFAULT_COMPRESSION
, DEFLATE_METHOD_VAL
,
226 -w_size
, 8, Z_DEFAULT_STRATEGY
) != Z_OK
) {
227 FREE(state
, sizeof(*state
));
231 state
->strm
.zalloc
= (alloc_func
) z_alloc
;
232 state
->w_size
= w_size
;
233 bzero(&state
->stats
, sizeof(state
->stats
));
234 return (void *) state
;
241 struct deflate_state
*state
= (struct deflate_state
*) arg
;
243 deflateEnd(&state
->strm
);
244 FREE(state
, sizeof(*state
));
248 z_comp_init(arg
, options
, opt_len
, unit
, hdrlen
, debug
)
251 int opt_len
, unit
, hdrlen
, debug
;
253 struct deflate_state
*state
= (struct deflate_state
*) arg
;
255 if (opt_len
< CILEN_DEFLATE
256 || (options
[0] != CI_DEFLATE
&& options
[0] != CI_DEFLATE_DRAFT
)
257 || options
[1] != CILEN_DEFLATE
258 || DEFLATE_METHOD(options
[2]) != DEFLATE_METHOD_VAL
259 || DEFLATE_SIZE(options
[2]) != state
->w_size
260 || options
[3] != DEFLATE_CHK_SEQUENCE
)
265 state
->hdrlen
= hdrlen
;
266 state
->debug
= debug
;
268 deflateReset(&state
->strm
);
277 struct deflate_state
*state
= (struct deflate_state
*) arg
;
280 deflateReset(&state
->strm
);
284 z_compress(arg
, mret
, mp
, orig_len
, maxolen
)
286 mblk_t
**mret
; /* compressed packet (out) */
287 mblk_t
*mp
; /* uncompressed packet (in) */
288 int orig_len
, maxolen
;
290 struct deflate_state
*state
= (struct deflate_state
*) arg
;
292 int proto
, olen
, wspace
, r
, flush
;
296 * Check that the protocol is in the range we handle.
300 if (rptr
+ PPP_HDRLEN
> mp
->b_wptr
) {
301 if (!pullupmsg(mp
, PPP_HDRLEN
))
305 proto
= PPP_PROTOCOL(rptr
);
306 if (proto
> 0x3fff || proto
== 0xfd || proto
== 0xfb)
309 /* Allocate one mblk initially. */
310 if (maxolen
> orig_len
)
312 if (maxolen
<= PPP_HDRLEN
+ 2) {
316 wspace
= maxolen
+ state
->hdrlen
;
319 m
= allocb(wspace
, BPRI_MED
);
323 if (state
->hdrlen
+ PPP_HDRLEN
+ 2 < wspace
) {
324 m
->b_rptr
+= state
->hdrlen
;
325 m
->b_wptr
= m
->b_rptr
;
326 wspace
-= state
->hdrlen
;
331 * Copy over the PPP header and store the 2-byte sequence number.
333 wptr
[0] = PPP_ADDRESS(rptr
);
334 wptr
[1] = PPP_CONTROL(rptr
);
335 wptr
[2] = PPP_COMP
>> 8;
338 wptr
[0] = state
->seqno
>> 8;
339 wptr
[1] = state
->seqno
;
341 state
->strm
.next_out
= wptr
;
342 state
->strm
.avail_out
= wspace
- (PPP_HDRLEN
+ 2);
344 state
->strm
.next_out
= NULL
;
345 state
->strm
.avail_out
= 1000000;
349 rptr
+= (proto
> 0xff)? 2: 3; /* skip 1st proto byte if 0 */
350 state
->strm
.next_in
= rptr
;
351 state
->strm
.avail_in
= mp
->b_wptr
- rptr
;
353 flush
= (mp
== NULL
)? Z_PACKET_FLUSH
: Z_NO_FLUSH
;
356 r
= deflate(&state
->strm
, flush
);
358 printf("z_compress: deflate returned %d (%s)\n",
359 r
, (state
->strm
.msg
? state
->strm
.msg
: ""));
362 if (flush
!= Z_NO_FLUSH
&& state
->strm
.avail_out
!= 0)
363 break; /* all done */
364 if (state
->strm
.avail_in
== 0 && mp
!= NULL
) {
365 state
->strm
.next_in
= mp
->b_rptr
;
366 state
->strm
.avail_in
= mp
->b_wptr
- mp
->b_rptr
;
369 flush
= Z_PACKET_FLUSH
;
371 if (state
->strm
.avail_out
== 0) {
375 wspace
= maxolen
- olen
;
382 else if (wspace
> 4096)
384 m
->b_cont
= allocb(wspace
, BPRI_MED
);
388 state
->strm
.next_out
= m
->b_wptr
;
389 state
->strm
.avail_out
= wspace
;
393 state
->strm
.next_out
= NULL
;
394 state
->strm
.avail_out
= 1000000;
399 m
->b_wptr
+= wspace
- state
->strm
.avail_out
;
400 olen
+= wspace
- state
->strm
.avail_out
;
404 * See if we managed to reduce the size of the packet.
406 if (olen
< orig_len
&& m
!= NULL
) {
407 state
->stats
.comp_bytes
+= olen
;
408 state
->stats
.comp_packets
++;
414 state
->stats
.inc_bytes
+= orig_len
;
415 state
->stats
.inc_packets
++;
418 state
->stats
.unc_bytes
+= orig_len
;
419 state
->stats
.unc_packets
++;
425 z_comp_stats(arg
, stats
)
427 struct compstat
*stats
;
429 struct deflate_state
*state
= (struct deflate_state
*) arg
;
432 *stats
= state
->stats
;
433 stats
->ratio
= stats
->unc_bytes
;
434 out
= stats
->comp_bytes
+ stats
->unc_bytes
;
435 if (stats
->ratio
<= 0x7ffffff)
444 * Allocate space for a decompressor.
447 z_decomp_alloc(options
, opt_len
)
451 struct deflate_state
*state
;
454 if (opt_len
!= CILEN_DEFLATE
455 || (options
[0] != CI_DEFLATE
&& options
[0] != CI_DEFLATE_DRAFT
)
456 || options
[1] != CILEN_DEFLATE
457 || DEFLATE_METHOD(options
[2]) != DEFLATE_METHOD_VAL
458 || options
[3] != DEFLATE_CHK_SEQUENCE
)
460 w_size
= DEFLATE_SIZE(options
[2]);
462 * N.B. the 9 below should be DEFLATE_MIN_SIZE (8), but using
463 * 8 will cause kernel crashes because of a bug in zlib.
465 if (w_size
< 9 || w_size
> DEFLATE_MAX_SIZE
)
469 state
= (struct deflate_state
*) ALLOC_SLEEP(sizeof(*state
));
471 state
= (struct deflate_state
*) ALLOC_NOSLEEP(sizeof(*state
));
476 state
->strm
.next_out
= NULL
;
477 state
->strm
.zalloc
= (alloc_func
) z_alloc_init
;
478 state
->strm
.zfree
= (free_func
) z_free
;
479 if (inflateInit2(&state
->strm
, -w_size
) != Z_OK
) {
480 FREE(state
, sizeof(*state
));
484 state
->strm
.zalloc
= (alloc_func
) z_alloc
;
485 state
->w_size
= w_size
;
486 bzero(&state
->stats
, sizeof(state
->stats
));
487 return (void *) state
;
494 struct deflate_state
*state
= (struct deflate_state
*) arg
;
496 inflateEnd(&state
->strm
);
497 FREE(state
, sizeof(*state
));
501 z_decomp_init(arg
, options
, opt_len
, unit
, hdrlen
, mru
, debug
)
504 int opt_len
, unit
, hdrlen
, mru
, debug
;
506 struct deflate_state
*state
= (struct deflate_state
*) arg
;
508 if (opt_len
< CILEN_DEFLATE
509 || (options
[0] != CI_DEFLATE
&& options
[0] != CI_DEFLATE_DRAFT
)
510 || options
[1] != CILEN_DEFLATE
511 || DEFLATE_METHOD(options
[2]) != DEFLATE_METHOD_VAL
512 || DEFLATE_SIZE(options
[2]) != state
->w_size
513 || options
[3] != DEFLATE_CHK_SEQUENCE
)
518 state
->hdrlen
= hdrlen
;
519 state
->debug
= debug
;
522 inflateReset(&state
->strm
);
531 struct deflate_state
*state
= (struct deflate_state
*) arg
;
534 inflateReset(&state
->strm
);
538 * Decompress a Deflate-compressed packet.
540 * Because of patent problems, we return DECOMP_ERROR for errors
541 * found by inspecting the input data and for system problems, but
542 * DECOMP_FATALERROR for any errors which could possibly be said to
543 * be being detected "after" decompression. For DECOMP_ERROR,
544 * we can issue a CCP reset-request; for DECOMP_FATALERROR, we may be
545 * infringing a patent of Motorola's if we do, so we take CCP down
548 * Given that the frame has the correct sequence number and a good FCS,
549 * errors such as invalid codes in the input most likely indicate a
550 * bug, so we return DECOMP_FATALERROR for them in order to turn off
551 * compression, even though they are detected by inspecting the input.
554 z_decompress(arg
, mi
, mop
)
558 struct deflate_state
*state
= (struct deflate_state
*) arg
;
559 mblk_t
*mo
, *mo_head
;
561 int rlen
, olen
, ospace
;
562 int seq
, i
, flush
, r
, decode_proto
;
563 u_char hdr
[PPP_HDRLEN
+ DEFLATE_OVHD
];
567 for (i
= 0; i
< PPP_HDRLEN
+ DEFLATE_OVHD
; ++i
) {
568 while (rptr
>= mi
->b_wptr
) {
577 /* Check the sequence number. */
578 seq
= (hdr
[PPP_HDRLEN
] << 8) + hdr
[PPP_HDRLEN
+1];
579 if (seq
!= state
->seqno
) {
583 printf("z_decompress%d: bad seq # %d, expected %d\n",
584 state
->unit
, seq
, state
->seqno
);
589 /* Allocate an output message block. */
590 mo
= allocb(DECOMP_CHUNK
+ state
->hdrlen
, BPRI_MED
);
595 mo
->b_rptr
+= state
->hdrlen
;
596 mo
->b_wptr
= wptr
= mo
->b_rptr
;
597 ospace
= DECOMP_CHUNK
;
601 * Fill in the first part of the PPP header. The protocol field
602 * comes from the decompressed data.
604 wptr
[0] = PPP_ADDRESS(hdr
);
605 wptr
[1] = PPP_CONTROL(hdr
);
609 * Set up to call inflate. We set avail_out to 1 initially so we can
610 * look at the first byte of the output and decide whether we have
611 * a 1-byte or 2-byte protocol field.
613 state
->strm
.next_in
= rptr
;
614 state
->strm
.avail_in
= mi
->b_wptr
- rptr
;
616 flush
= (mi
== NULL
)? Z_PACKET_FLUSH
: Z_NO_FLUSH
;
617 rlen
= state
->strm
.avail_in
+ PPP_HDRLEN
+ DEFLATE_OVHD
;
618 state
->strm
.next_out
= wptr
+ 3;
619 state
->strm
.avail_out
= 1;
623 * Call inflate, supplying more input or output as needed.
626 r
= inflate(&state
->strm
, flush
);
631 printf("z_decompress%d: inflate returned %d (%s)\n",
632 state
->unit
, r
, (state
->strm
.msg
? state
->strm
.msg
: ""));
634 return DECOMP_FATALERROR
;
636 if (flush
!= Z_NO_FLUSH
&& state
->strm
.avail_out
!= 0)
637 break; /* all done */
638 if (state
->strm
.avail_in
== 0 && mi
!= NULL
) {
639 state
->strm
.next_in
= mi
->b_rptr
;
640 state
->strm
.avail_in
= mi
->b_wptr
- mi
->b_rptr
;
641 rlen
+= state
->strm
.avail_in
;
644 flush
= Z_PACKET_FLUSH
;
646 if (state
->strm
.avail_out
== 0) {
648 state
->strm
.avail_out
= ospace
- PPP_HDRLEN
;
649 if ((wptr
[3] & 1) == 0) {
650 /* 2-byte protocol field */
652 --state
->strm
.next_out
;
653 ++state
->strm
.avail_out
;
657 mo
->b_wptr
+= ospace
;
659 mo
->b_cont
= allocb(DECOMP_CHUNK
, BPRI_MED
);
665 state
->strm
.next_out
= mo
->b_rptr
;
666 state
->strm
.avail_out
= ospace
= DECOMP_CHUNK
;
674 mo
->b_wptr
+= ospace
- state
->strm
.avail_out
;
675 olen
+= ospace
- state
->strm
.avail_out
;
678 if (olen
> state
->mru
+ PPP_HDRLEN
)
679 printf("ppp_deflate%d: exceeded mru (%d > %d)\n",
680 state
->unit
, olen
, state
->mru
+ PPP_HDRLEN
);
683 state
->stats
.unc_bytes
+= olen
;
684 state
->stats
.unc_packets
++;
685 state
->stats
.comp_bytes
+= rlen
;
686 state
->stats
.comp_packets
++;
693 * Incompressible data has arrived - add it to the history.
700 struct deflate_state
*state
= (struct deflate_state
*) arg
;
705 * Check that the protocol is one we handle.
708 if (rptr
+ PPP_HDRLEN
> mi
->b_wptr
) {
709 if (!pullupmsg(mi
, PPP_HDRLEN
))
713 proto
= PPP_PROTOCOL(rptr
);
714 if (proto
> 0x3fff || proto
== 0xfd || proto
== 0xfb)
720 * Iterate through the message blocks, adding the characters in them
721 * to the decompressor's history. For the first block, we start
722 * at the either the 1st or 2nd byte of the protocol field,
723 * depending on whether the protocol value is compressible.
725 rlen
= mi
->b_wptr
- mi
->b_rptr
;
726 state
->strm
.next_in
= rptr
+ 3;
727 state
->strm
.avail_in
= rlen
- 3;
729 --state
->strm
.next_in
;
730 ++state
->strm
.avail_in
;
733 r
= inflateIncomp(&state
->strm
);
739 printf("z_incomp%d: inflateIncomp returned %d (%s)\n",
740 state
->unit
, r
, (state
->strm
.msg
? state
->strm
.msg
: ""));
746 state
->strm
.next_in
= mi
->b_rptr
;
747 state
->strm
.avail_in
= mi
->b_wptr
- mi
->b_rptr
;
748 rlen
+= state
->strm
.avail_in
;
754 state
->stats
.inc_bytes
+= rlen
;
755 state
->stats
.inc_packets
++;
756 state
->stats
.unc_bytes
+= rlen
;
757 state
->stats
.unc_packets
++;
760 #endif /* DO_DEFLATE */