1 /* $Id: ppp-deflate.c,v 1.4 1997/11/27 06:06:33 paulus Exp $ */
4 * ppp_deflate.c - interface the zlib procedures for Deflate compression
5 * and decompression (as used by gzip) to the PPP code.
6 * This version is for use with mbufs on BSD-derived systems.
8 * Copyright (c) 1994 The Australian National University.
11 * Permission to use, copy, modify, and distribute this software and its
12 * documentation is hereby granted, provided that the above copyright
13 * notice appears in all copies. This software is provided without any
14 * warranty, express or implied. The Australian National University
15 * makes no representations about the suitability of this software for
18 * IN NO EVENT SHALL THE AUSTRALIAN NATIONAL UNIVERSITY BE LIABLE TO ANY
19 * PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
20 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
21 * THE AUSTRALIAN NATIONAL UNIVERSITY HAS BEEN ADVISED OF THE POSSIBILITY
24 * THE AUSTRALIAN NATIONAL UNIVERSITY SPECIFICALLY DISCLAIMS ANY WARRANTIES,
25 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
26 * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
27 * ON AN "AS IS" BASIS, AND THE AUSTRALIAN NATIONAL UNIVERSITY HAS NO
28 * OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS,
32 #include "../h/param.h"
33 #include "../h/types.h"
34 #include "../h/mbuf.h"
35 #include "../h/socket.h"
36 #include "../net/net/if.h"
40 #define PACKETPTR struct mbuf *
46 * State for a Deflate (de)compressor.
48 struct deflate_state {
56 struct compstat stats;
59 #define DEFLATE_OVHD 2 /* Deflate overhead/packet */
61 static void *zalloc __P((void *, u_int items, u_int size));
62 static void zfree __P((void *, void *ptr));
63 static void *z_comp_alloc __P((u_char *options, int opt_len));
64 static void *z_decomp_alloc __P((u_char *options, int opt_len));
65 static void z_comp_free __P((void *state));
66 static void z_decomp_free __P((void *state));
67 static int z_comp_init __P((void *state, u_char *options, int opt_len,
68 int unit, int hdrlen, int debug));
69 static int z_decomp_init __P((void *state, u_char *options, int opt_len,
70 int unit, int hdrlen, int mru, int debug));
71 static int z_compress __P((void *state, struct mbuf **mret,
72 struct mbuf *mp, int slen, int maxolen));
73 static void z_incomp __P((void *state, struct mbuf *dmsg));
74 static int z_decompress __P((void *state, struct mbuf *cmp,
76 static void z_comp_reset __P((void *state));
77 static void z_decomp_reset __P((void *state));
78 static void z_comp_stats __P((void *state, struct compstat *stats));
81 * Procedures exported to if_ppp.c.
83 struct compressor ppp_deflate = {
84 CI_DEFLATE, /* compress_proto */
85 z_comp_alloc, /* comp_alloc */
86 z_comp_free, /* comp_free */
87 z_comp_init, /* comp_init */
88 z_comp_reset, /* comp_reset */
89 z_compress, /* compress */
90 z_comp_stats, /* comp_stat */
91 z_decomp_alloc, /* decomp_alloc */
92 z_decomp_free, /* decomp_free */
93 z_decomp_init, /* decomp_init */
94 z_decomp_reset, /* decomp_reset */
95 z_decompress, /* decompress */
96 z_incomp, /* incomp */
97 z_comp_stats, /* decomp_stat */
101 * Some useful mbuf macros not in mbuf.h.
103 #define M_IS_CLUSTER(m) ((m)->m_off > MMAXOFF)
105 #define M_TRAILINGSPACE(m) \
106 ((M_IS_CLUSTER(m) ? (u_int)(m)->m_clptr + M_CLUSTERSZ : MSIZE) \
107 - ((m)->m_off + (m)->m_len))
110 * Space allocation and freeing routines for use by zlib routines.
113 zalloc(notused, items, size)
119 KM_ALLOC(ptr, void *, items * size, KM_DEVBUF, KM_NOARG);
128 KM_FREE(ptr, KM_DEVBUF);
132 * Allocate space for a compressor.
135 z_comp_alloc(options, opt_len)
139 struct deflate_state *state;
142 if (opt_len != CILEN_DEFLATE || options[0] != CI_DEFLATE
143 || options[1] != CILEN_DEFLATE
144 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
145 || options[3] != DEFLATE_CHK_SEQUENCE)
147 w_size = DEFLATE_SIZE(options[2]);
148 if (w_size < DEFLATE_MIN_SIZE || w_size > DEFLATE_MAX_SIZE)
151 KM_ALLOC(state, struct deflate_state *, sizeof(struct deflate_state),
152 KM_DEVBUF, KM_NOARG);
155 bzero(state, sizeof(struct deflate_state));
157 state->strm.next_in = NULL;
158 state->strm.zalloc = (alloc_func) zalloc;
159 state->strm.zfree = (free_func) zfree;
160 if (deflateInit2(&state->strm, Z_DEFAULT_COMPRESSION, DEFLATE_METHOD_VAL,
161 -w_size, 8, Z_DEFAULT_STRATEGY) != Z_OK) {
162 KM_FREE(state, KM_DEVBUF);
166 state->w_size = w_size;
167 bzero(&state->stats, sizeof(state->stats));
168 return (void *) state;
175 struct deflate_state *state = (struct deflate_state *) arg;
177 deflateEnd(&state->strm);
178 KM_FREE(state, KM_DEVBUF);
182 z_comp_init(arg, options, opt_len, unit, hdrlen, debug)
185 int opt_len, unit, hdrlen, debug;
187 struct deflate_state *state = (struct deflate_state *) arg;
189 if (opt_len < CILEN_DEFLATE || options[0] != CI_DEFLATE
190 || options[1] != CILEN_DEFLATE
191 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
192 || DEFLATE_SIZE(options[2]) != state->w_size
193 || options[3] != DEFLATE_CHK_SEQUENCE)
198 state->hdrlen = hdrlen;
199 state->debug = debug;
201 deflateReset(&state->strm);
210 struct deflate_state *state = (struct deflate_state *) arg;
213 deflateReset(&state->strm);
217 z_compress(arg, mret, mp, orig_len, maxolen)
219 struct mbuf **mret; /* compressed packet (out) */
220 struct mbuf *mp; /* uncompressed packet (in) */
221 int orig_len, maxolen;
223 struct deflate_state *state = (struct deflate_state *) arg;
225 int proto, olen, wspace, r, flush;
226 struct mbuf *m, *clp;
229 * Check that the protocol is in the range we handle.
231 rptr = mtod(mp, u_char *);
232 proto = PPP_PROTOCOL(rptr);
233 if (proto > 0x3fff || proto == 0xfd || proto == 0xfb) {
238 /* Allocate one mbuf initially. */
239 if (maxolen > orig_len)
241 MGET(m, M_DONTWAIT, MT_DATA);
244 if (maxolen + state->hdrlen > MLEN) {
245 /* MCLGET is not a single statement!!! */
249 wspace = M_TRAILINGSPACE(m);
250 if (state->hdrlen > 0 && state->hdrlen + PPP_HDRLEN + 2 < wspace) {
251 m->m_off += state->hdrlen;
252 wspace -= state->hdrlen;
254 wptr = mtod(m, u_char *);
257 * Copy over the PPP header and store the 2-byte sequence number.
259 wptr[0] = PPP_ADDRESS(rptr);
260 wptr[1] = PPP_CONTROL(rptr);
261 wptr[2] = PPP_COMP >> 8;
264 wptr[0] = state->seqno >> 8;
265 wptr[1] = state->seqno;
267 state->strm.next_out = wptr;
268 state->strm.avail_out = wspace - (PPP_HDRLEN + 2);
270 state->strm.next_out = NULL;
271 state->strm.avail_out = 1000000;
277 rptr += (proto > 0xff)? 2: 3; /* skip 1st proto byte if 0 */
278 state->strm.next_in = rptr;
279 state->strm.avail_in = mtod(mp, u_char *) + mp->m_len - rptr;
281 flush = (mp == NULL)? Z_PACKET_FLUSH: Z_NO_FLUSH;
284 r = deflate(&state->strm, flush);
286 printf("z_compress: deflate returned %d (%s)\n",
287 r, (state->strm.msg? state->strm.msg: ""));
290 if (flush != Z_NO_FLUSH && state->strm.avail_out != 0)
291 break; /* all done */
292 if (state->strm.avail_in == 0 && mp != NULL) {
293 state->strm.next_in = mtod(mp, u_char *);
294 state->strm.avail_in = mp->m_len;
297 flush = Z_PACKET_FLUSH;
299 if (state->strm.avail_out == 0) {
303 MGET(m->m_next, M_DONTWAIT, MT_DATA);
306 if (maxolen - olen > MLEN) {
310 state->strm.next_out = mtod(m, u_char *);
311 state->strm.avail_out = wspace = M_TRAILINGSPACE(m);
315 state->strm.next_out = NULL;
316 state->strm.avail_out = 1000000;
321 olen += (m->m_len = wspace - state->strm.avail_out);
324 * See if we managed to reduce the size of the packet.
325 * If the compressor just gave us a single zero byte, it means
326 * the packet was incompressible.
328 if (m != NULL && olen < orig_len
329 && !(olen == PPP_HDRLEN + 3 && *wptr == 0)) {
330 state->stats.comp_bytes += olen;
331 state->stats.comp_packets++;
337 state->stats.inc_bytes += orig_len;
338 state->stats.inc_packets++;
341 state->stats.unc_bytes += orig_len;
342 state->stats.unc_packets++;
348 z_comp_stats(arg, stats)
350 struct compstat *stats;
352 struct deflate_state *state = (struct deflate_state *) arg;
355 *stats = state->stats;
356 stats->ratio = stats->unc_bytes;
357 out = stats->comp_bytes + stats->inc_bytes;
358 if (stats->ratio <= 0x7ffffff)
367 * Allocate space for a decompressor.
370 z_decomp_alloc(options, opt_len)
374 struct deflate_state *state;
377 if (opt_len != CILEN_DEFLATE || options[0] != CI_DEFLATE
378 || options[1] != CILEN_DEFLATE
379 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
380 || options[3] != DEFLATE_CHK_SEQUENCE)
382 w_size = DEFLATE_SIZE(options[2]);
383 if (w_size < DEFLATE_MIN_SIZE || w_size > DEFLATE_MAX_SIZE)
386 KM_ALLOC(state, struct deflate_state *, sizeof(struct deflate_state),
387 KM_DEVBUF, KM_NOARG);
390 bzero(state, sizeof(struct deflate_state));
392 state->strm.next_out = NULL;
393 state->strm.zalloc = (alloc_func) zalloc;
394 state->strm.zfree = (free_func) zfree;
395 if (inflateInit2(&state->strm, -w_size) != Z_OK) {
396 KM_FREE(state, KM_DEVBUF);
400 state->w_size = w_size;
401 bzero(&state->stats, sizeof(state->stats));
402 return (void *) state;
409 struct deflate_state *state = (struct deflate_state *) arg;
411 inflateEnd(&state->strm);
412 KM_FREE(state, KM_DEVBUF);
416 z_decomp_init(arg, options, opt_len, unit, hdrlen, mru, debug)
419 int opt_len, unit, hdrlen, mru, debug;
421 struct deflate_state *state = (struct deflate_state *) arg;
423 if (opt_len < CILEN_DEFLATE || options[0] != CI_DEFLATE
424 || options[1] != CILEN_DEFLATE
425 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
426 || DEFLATE_SIZE(options[2]) != state->w_size
427 || options[3] != DEFLATE_CHK_SEQUENCE)
432 state->hdrlen = hdrlen;
433 state->debug = debug;
436 inflateReset(&state->strm);
445 struct deflate_state *state = (struct deflate_state *) arg;
448 inflateReset(&state->strm);
452 * Decompress a Deflate-compressed packet.
454 * Because of patent problems, we return DECOMP_ERROR for errors
455 * found by inspecting the input data and for system problems, but
456 * DECOMP_FATALERROR for any errors which could possibly be said to
457 * be being detected "after" decompression. For DECOMP_ERROR,
458 * we can issue a CCP reset-request; for DECOMP_FATALERROR, we may be
459 * infringing a patent of Motorola's if we do, so we take CCP down
462 * Given that the frame has the correct sequence number and a good FCS,
463 * errors such as invalid codes in the input most likely indicate a
464 * bug, so we return DECOMP_FATALERROR for them in order to turn off
465 * compression, even though they are detected by inspecting the input.
468 z_decompress(arg, mi, mop)
470 struct mbuf *mi, **mop;
472 struct deflate_state *state = (struct deflate_state *) arg;
473 struct mbuf *mo, *mo_head, *clp;
475 int rlen, olen, ospace;
476 int seq, i, flush, r, decode_proto;
477 u_char hdr[PPP_HDRLEN + DEFLATE_OVHD];
480 rptr = mtod(mi, u_char *);
482 for (i = 0; i < PPP_HDRLEN + DEFLATE_OVHD; ++i) {
487 rptr = mtod(mi, u_char *);
494 /* Check the sequence number. */
495 seq = (hdr[PPP_HDRLEN] << 8) + hdr[PPP_HDRLEN+1];
496 if (seq != state->seqno) {
498 printf("z_decompress%d: bad seq # %d, expected %d\n",
499 state->unit, seq, state->seqno);
504 /* Allocate an output mbuf. */
505 MGET(mo, M_DONTWAIT, MT_DATA);
512 ospace = M_TRAILINGSPACE(mo);
513 if (state->hdrlen > 0 && state->hdrlen + PPP_HDRLEN < ospace) {
514 mo->m_off += state->hdrlen;
515 ospace -= state->hdrlen;
519 * Fill in the first part of the PPP header. The protocol field
520 * comes from the decompressed data.
522 wptr = mtod(mo, u_char *);
523 wptr[0] = PPP_ADDRESS(hdr);
524 wptr[1] = PPP_CONTROL(hdr);
528 * Set up to call inflate. We set avail_out to 1 initially so we can
529 * look at the first byte of the output and decide whether we have
530 * a 1-byte or 2-byte protocol field.
532 state->strm.next_in = rptr;
533 state->strm.avail_in = rlen;
535 flush = (mi == NULL)? Z_PACKET_FLUSH: Z_NO_FLUSH;
536 rlen += PPP_HDRLEN + DEFLATE_OVHD;
537 state->strm.next_out = wptr + 3;
538 state->strm.avail_out = 1;
543 * Call inflate, supplying more input or output as needed.
546 r = inflate(&state->strm, flush);
549 printf("z_decompress%d: inflate returned %d (%s)\n",
550 state->unit, r, (state->strm.msg? state->strm.msg: ""));
552 return DECOMP_FATALERROR;
554 if (flush != Z_NO_FLUSH && state->strm.avail_out != 0)
555 break; /* all done */
556 if (state->strm.avail_in == 0 && mi != NULL) {
557 state->strm.next_in = mtod(mi, u_char *);
558 state->strm.avail_in = mi->m_len;
562 flush = Z_PACKET_FLUSH;
564 if (state->strm.avail_out == 0) {
566 state->strm.avail_out = ospace - PPP_HDRLEN;
567 if ((wptr[3] & 1) == 0) {
568 /* 2-byte protocol field */
570 --state->strm.next_out;
571 ++state->strm.avail_out;
578 MGET(mo->m_next, M_DONTWAIT, MT_DATA);
586 state->strm.next_out = mtod(mo, u_char *);
587 state->strm.avail_out = ospace = M_TRAILINGSPACE(mo);
595 olen += (mo->m_len = ospace - state->strm.avail_out);
597 state->stats.unc_bytes += olen;
598 state->stats.unc_packets++;
599 state->stats.comp_bytes += rlen;
600 state->stats.comp_packets++;
607 * Incompressible data has arrived - add it to the history.
614 struct deflate_state *state = (struct deflate_state *) arg;
619 * Check that the protocol is one we handle.
621 rptr = mtod(mi, u_char *);
622 proto = PPP_PROTOCOL(rptr);
623 if (proto > 0x3fff || proto == 0xfd || proto == 0xfb)
629 * Iterate through the mbufs, adding the characters in them
630 * to the decompressor's history. For the first mbuf, we start
631 * at the either the 1st or 2nd byte of the protocol field,
632 * depending on whether the protocol value is compressible.
635 state->strm.next_in = rptr + 3;
636 state->strm.avail_in = rlen - 3;
638 --state->strm.next_in;
639 ++state->strm.avail_in;
642 r = inflateIncomp(&state->strm);
646 printf("z_incomp%d: inflateIncomp returned %d (%s)\n",
647 state->unit, r, (state->strm.msg? state->strm.msg: ""));
654 state->strm.next_in = mtod(mi, u_char *);
655 state->strm.avail_in = mi->m_len;
662 state->stats.inc_bytes += rlen;
663 state->stats.inc_packets++;
664 state->stats.unc_bytes += rlen;
665 state->stats.unc_packets++;
668 #endif /* DO_DEFLATE */