1 /* $Id: ppp-deflate.c,v 1.1 1996/07/01 01:00:30 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 <sys/param.h>
33 #include <sys/types.h>
34 #include <sys/systm.h>
36 #include <net/ppp_defs.h>
39 #define PACKETPTR struct mbuf *
40 #include <net/ppp-comp.h>
45 * State for a Deflate (de)compressor.
47 struct deflate_state {
55 struct compstat stats;
58 #define DEFLATE_OVHD 2 /* Deflate overhead/packet */
60 static void *zalloc __P((void *, u_int items, u_int size));
61 static void zfree __P((void *, void *ptr, u_int nb));
62 static void *z_comp_alloc __P((u_char *options, int opt_len));
63 static void *z_decomp_alloc __P((u_char *options, int opt_len));
64 static void z_comp_free __P((void *state));
65 static void z_decomp_free __P((void *state));
66 static int z_comp_init __P((void *state, u_char *options, int opt_len,
67 int unit, int hdrlen, int debug));
68 static int z_decomp_init __P((void *state, u_char *options, int opt_len,
69 int unit, int hdrlen, int mru, int debug));
70 static int z_compress __P((void *state, struct mbuf **mret,
71 struct mbuf *mp, int slen, int maxolen));
72 static void z_incomp __P((void *state, struct mbuf *dmsg));
73 static int z_decompress __P((void *state, struct mbuf *cmp,
75 static void z_comp_reset __P((void *state));
76 static void z_decomp_reset __P((void *state));
77 static void z_comp_stats __P((void *state, struct compstat *stats));
80 * Procedures exported to if_ppp.c.
82 struct compressor ppp_deflate = {
83 CI_DEFLATE, /* compress_proto */
84 z_comp_alloc, /* comp_alloc */
85 z_comp_free, /* comp_free */
86 z_comp_init, /* comp_init */
87 z_comp_reset, /* comp_reset */
88 z_compress, /* compress */
89 z_comp_stats, /* comp_stat */
90 z_decomp_alloc, /* decomp_alloc */
91 z_decomp_free, /* decomp_free */
92 z_decomp_init, /* decomp_init */
93 z_decomp_reset, /* decomp_reset */
94 z_decompress, /* decompress */
95 z_incomp, /* incomp */
96 z_comp_stats, /* decomp_stat */
100 * Space allocation and freeing routines for use by zlib routines.
103 zalloc(notused, items, size)
109 MALLOC(ptr, void *, items * size, M_DEVBUF, M_NOWAIT);
114 zfree(notused, ptr, nbytes)
123 * Allocate space for a compressor.
126 z_comp_alloc(options, opt_len)
130 struct deflate_state *state;
133 if (opt_len != CILEN_DEFLATE || options[0] != CI_DEFLATE
134 || options[1] != CILEN_DEFLATE
135 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
136 || options[3] != DEFLATE_CHK_SEQUENCE)
138 w_size = DEFLATE_SIZE(options[2]);
139 if (w_size < DEFLATE_MIN_SIZE || w_size > DEFLATE_MAX_SIZE)
142 MALLOC(state, struct deflate_state *, sizeof(struct deflate_state),
147 state->strm.next_in = NULL;
148 state->strm.zalloc = zalloc;
149 state->strm.zfree = zfree;
150 if (deflateInit2(&state->strm, Z_DEFAULT_COMPRESSION, DEFLATE_METHOD_VAL,
151 -w_size, 8, Z_DEFAULT_STRATEGY, DEFLATE_OVHD+2) != Z_OK) {
152 FREE(state, M_DEVBUF);
156 state->w_size = w_size;
157 bzero(&state->stats, sizeof(state->stats));
158 return (void *) state;
165 struct deflate_state *state = (struct deflate_state *) arg;
167 deflateEnd(&state->strm);
168 FREE(state, M_DEVBUF);
172 z_comp_init(arg, options, opt_len, unit, hdrlen, debug)
175 int opt_len, unit, hdrlen, debug;
177 struct deflate_state *state = (struct deflate_state *) arg;
179 if (opt_len < CILEN_DEFLATE || options[0] != CI_DEFLATE
180 || options[1] != CILEN_DEFLATE
181 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
182 || DEFLATE_SIZE(options[2]) != state->w_size
183 || options[3] != DEFLATE_CHK_SEQUENCE)
188 state->hdrlen = hdrlen;
189 state->debug = debug;
191 deflateReset(&state->strm);
200 struct deflate_state *state = (struct deflate_state *) arg;
203 deflateReset(&state->strm);
207 z_compress(arg, mret, mp, orig_len, maxolen)
209 struct mbuf **mret; /* compressed packet (out) */
210 struct mbuf *mp; /* uncompressed packet (in) */
211 int orig_len, maxolen;
213 struct deflate_state *state = (struct deflate_state *) arg;
215 int proto, olen, wspace, r, flush;
219 * Check that the protocol is in the range we handle.
221 rptr = mtod(mp, u_char *);
222 proto = PPP_PROTOCOL(rptr);
223 if (proto > 0x3fff || proto == 0xfd || proto == 0xfb) {
228 /* Allocate one mbuf initially. */
229 if (maxolen > orig_len)
231 MGET(m, M_DONTWAIT, MT_DATA);
235 if (maxolen + state->hdrlen > MLEN)
236 MCLGET(m, M_DONTWAIT);
237 wspace = M_TRAILINGSPACE(m);
238 if (state->hdrlen + PPP_HDRLEN + 2 < wspace) {
239 m->m_data += state->hdrlen;
240 wspace -= state->hdrlen;
242 wptr = mtod(m, u_char *);
245 * Copy over the PPP header and store the 2-byte sequence number.
247 wptr[0] = PPP_ADDRESS(rptr);
248 wptr[1] = PPP_CONTROL(rptr);
249 wptr[2] = PPP_COMP >> 8;
252 wptr[0] = state->seqno >> 8;
253 wptr[1] = state->seqno;
255 state->strm.next_out = wptr;
256 state->strm.avail_out = wspace - (PPP_HDRLEN + 2);
258 state->strm.next_out = NULL;
259 state->strm.avail_out = 1000000;
265 rptr += (proto > 0xff)? 2: 3; /* skip 1st proto byte if 0 */
266 state->strm.next_in = rptr;
267 state->strm.avail_in = mtod(mp, u_char *) + mp->m_len - rptr;
269 flush = (mp == NULL)? Z_PACKET_FLUSH: Z_NO_FLUSH;
272 r = deflate(&state->strm, flush);
274 printf("z_compress: deflate returned %d (%s)\n",
275 r, (state->strm.msg? state->strm.msg: ""));
278 if (flush != Z_NO_FLUSH && state->strm.avail_out != 0)
279 break; /* all done */
280 if (state->strm.avail_in == 0 && mp != NULL) {
281 state->strm.next_in = mtod(mp, u_char *);
282 state->strm.avail_in = mp->m_len;
285 flush = Z_PACKET_FLUSH;
287 if (state->strm.avail_out == 0) {
291 MGET(m->m_next, M_DONTWAIT, MT_DATA);
295 if (maxolen - olen > MLEN)
296 MCLGET(m, M_DONTWAIT);
297 state->strm.next_out = mtod(m, u_char *);
298 state->strm.avail_out = wspace = M_TRAILINGSPACE(m);
302 state->strm.next_out = NULL;
303 state->strm.avail_out = 1000000;
308 olen += (m->m_len = wspace - state->strm.avail_out);
311 * See if we managed to reduce the size of the packet.
312 * If the compressor just gave us a single zero byte, it means
313 * the packet was incompressible.
315 if (m != NULL && olen < orig_len
316 && !(olen == PPP_HDRLEN + 3 && *wptr == 0)) {
317 state->stats.comp_bytes += olen;
318 state->stats.comp_packets++;
324 state->stats.inc_bytes += orig_len;
325 state->stats.inc_packets++;
328 state->stats.unc_bytes += orig_len;
329 state->stats.unc_packets++;
335 z_comp_stats(arg, stats)
337 struct compstat *stats;
339 struct deflate_state *state = (struct deflate_state *) arg;
342 *stats = state->stats;
343 stats->ratio = stats->unc_bytes;
344 out = stats->comp_bytes + stats->inc_bytes;
345 if (stats->ratio <= 0x7ffffff)
354 * Allocate space for a decompressor.
357 z_decomp_alloc(options, opt_len)
361 struct deflate_state *state;
364 if (opt_len != CILEN_DEFLATE || options[0] != CI_DEFLATE
365 || options[1] != CILEN_DEFLATE
366 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
367 || options[3] != DEFLATE_CHK_SEQUENCE)
369 w_size = DEFLATE_SIZE(options[2]);
370 if (w_size < DEFLATE_MIN_SIZE || w_size > DEFLATE_MAX_SIZE)
373 MALLOC(state, struct deflate_state *, sizeof(struct deflate_state),
378 state->strm.next_out = NULL;
379 state->strm.zalloc = zalloc;
380 state->strm.zfree = zfree;
381 if (inflateInit2(&state->strm, -w_size) != Z_OK) {
382 FREE(state, M_DEVBUF);
386 state->w_size = w_size;
387 bzero(&state->stats, sizeof(state->stats));
388 return (void *) state;
395 struct deflate_state *state = (struct deflate_state *) arg;
397 inflateEnd(&state->strm);
398 FREE(state, M_DEVBUF);
402 z_decomp_init(arg, options, opt_len, unit, hdrlen, mru, debug)
405 int opt_len, unit, hdrlen, mru, debug;
407 struct deflate_state *state = (struct deflate_state *) arg;
409 if (opt_len < CILEN_DEFLATE || options[0] != CI_DEFLATE
410 || options[1] != CILEN_DEFLATE
411 || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
412 || DEFLATE_SIZE(options[2]) != state->w_size
413 || options[3] != DEFLATE_CHK_SEQUENCE)
418 state->hdrlen = hdrlen;
419 state->debug = debug;
422 inflateReset(&state->strm);
431 struct deflate_state *state = (struct deflate_state *) arg;
434 inflateReset(&state->strm);
438 * Decompress a Deflate-compressed packet.
440 * Because of patent problems, we return DECOMP_ERROR for errors
441 * found by inspecting the input data and for system problems, but
442 * DECOMP_FATALERROR for any errors which could possibly be said to
443 * be being detected "after" decompression. For DECOMP_ERROR,
444 * we can issue a CCP reset-request; for DECOMP_FATALERROR, we may be
445 * infringing a patent of Motorola's if we do, so we take CCP down
448 * Given that the frame has the correct sequence number and a good FCS,
449 * errors such as invalid codes in the input most likely indicate a
450 * bug, so we return DECOMP_FATALERROR for them in order to turn off
451 * compression, even though they are detected by inspecting the input.
454 z_decompress(arg, mi, mop)
456 struct mbuf *mi, **mop;
458 struct deflate_state *state = (struct deflate_state *) arg;
459 struct mbuf *mo, *mo_head;
461 int rlen, olen, ospace;
462 int seq, i, flush, r, decode_proto;
463 u_char hdr[PPP_HDRLEN + DEFLATE_OVHD];
466 rptr = mtod(mi, u_char *);
468 for (i = 0; i < PPP_HDRLEN + DEFLATE_OVHD; ++i) {
473 rptr = mtod(mi, u_char *);
480 /* Check the sequence number. */
481 seq = (hdr[PPP_HDRLEN] << 8) + hdr[PPP_HDRLEN+1];
482 if (seq != state->seqno) {
484 printf("z_decompress%d: bad seq # %d, expected %d\n",
485 state->unit, seq, state->seqno);
490 /* Allocate an output mbuf. */
491 MGETHDR(mo, M_DONTWAIT, MT_DATA);
497 MCLGET(mo, M_DONTWAIT);
498 ospace = M_TRAILINGSPACE(mo);
499 if (state->hdrlen + PPP_HDRLEN < ospace) {
500 mo->m_data += state->hdrlen;
501 ospace -= state->hdrlen;
505 * Fill in the first part of the PPP header. The protocol field
506 * comes from the decompressed data.
508 wptr = mtod(mo, u_char *);
509 wptr[0] = PPP_ADDRESS(hdr);
510 wptr[1] = PPP_CONTROL(hdr);
514 * Set up to call inflate. We set avail_out to 1 initially so we can
515 * look at the first byte of the output and decide whether we have
516 * a 1-byte or 2-byte protocol field.
518 state->strm.next_in = rptr;
519 state->strm.avail_in = rlen;
521 flush = (mi == NULL)? Z_PACKET_FLUSH: Z_NO_FLUSH;
522 rlen += PPP_HDRLEN + DEFLATE_OVHD;
523 state->strm.next_out = wptr + 3;
524 state->strm.avail_out = 1;
529 * Call inflate, supplying more input or output as needed.
532 r = inflate(&state->strm, flush);
535 printf("z_decompress%d: inflate returned %d (%s)\n",
536 state->unit, r, (state->strm.msg? state->strm.msg: ""));
538 return DECOMP_FATALERROR;
540 if (flush != Z_NO_FLUSH && state->strm.avail_out != 0)
541 break; /* all done */
542 if (state->strm.avail_in == 0 && mi != NULL) {
543 state->strm.next_in = mtod(mi, u_char *);
544 state->strm.avail_in = mi->m_len;
548 flush = Z_PACKET_FLUSH;
550 if (state->strm.avail_out == 0) {
552 state->strm.avail_out = ospace - PPP_HDRLEN;
553 if ((wptr[3] & 1) == 0) {
554 /* 2-byte protocol field */
556 --state->strm.next_out;
557 ++state->strm.avail_out;
564 MGET(mo->m_next, M_DONTWAIT, MT_DATA);
570 MCLGET(mo, M_DONTWAIT);
571 state->strm.next_out = mtod(mo, u_char *);
572 state->strm.avail_out = ospace = M_TRAILINGSPACE(mo);
580 olen += (mo->m_len = ospace - state->strm.avail_out);
582 state->stats.unc_bytes += olen;
583 state->stats.unc_packets++;
584 state->stats.comp_bytes += rlen;
585 state->stats.comp_packets++;
592 * Incompressible data has arrived - add it to the history.
599 struct deflate_state *state = (struct deflate_state *) arg;
604 * Check that the protocol is one we handle.
606 rptr = mtod(mi, u_char *);
607 proto = PPP_PROTOCOL(rptr);
608 if (proto > 0x3fff || proto == 0xfd || proto == 0xfb)
614 * Iterate through the mbufs, adding the characters in them
615 * to the decompressor's history. For the first mbuf, we start
616 * at the either the 1st or 2nd byte of the protocol field,
617 * depending on whether the protocol value is compressible.
620 state->strm.next_in = rptr + 3;
621 state->strm.avail_in = rlen - 3;
623 --state->strm.next_in;
624 ++state->strm.avail_in;
627 r = inflateIncomp(&state->strm);
631 printf("z_incomp%d: inflateIncomp returned %d (%s)\n",
632 state->unit, r, (state->strm.msg? state->strm.msg: ""));
639 state->strm.next_in = mtod(mi, u_char *);
640 state->strm.avail_in = mi->m_len;
647 state->stats.inc_bytes += rlen;
648 state->stats.inc_packets++;
649 state->stats.unc_bytes += rlen;
650 state->stats.unc_packets++;
653 #endif /* DO_DEFLATE */