bd2234277475917e6a73f2206356f482e5050104
[ppp.git] / linux / ppp_deflate.c
1 /*
2  *  ==FILEVERSION 971001==
3  *
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 Linux kernel 1.3.X.
7  *
8  * Copyright (c) 1994 The Australian National University.
9  * All rights reserved.
10  *
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
16  * any purpose.
17  *
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
22  * OF SUCH DAMAGE.
23  *
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,
29  * OR MODIFICATIONS.
30  *
31  * From: deflate.c,v 1.1 1996/01/18 03:17:48 paulus Exp
32  */
33
34 #include <linux/module.h>
35 #include <linux/version.h>
36 #include <linux/kernel.h>
37 #include <linux/sched.h>
38 #include <linux/types.h>
39 #include <linux/fcntl.h>
40 #include <linux/interrupt.h>
41 #include <linux/ptrace.h>
42 #include <linux/ioport.h>
43 #include <linux/in.h>
44 #include <linux/malloc.h>
45
46 #undef VERSION
47 /* a nice define to generate linux version numbers */
48 #define VERSION(major,minor,patch) (((((major)<<8)+(minor))<<8)+(patch))
49
50 #if LINUX_VERSION_CODE >= VERSION(2,1,4)
51 #include <linux/vmalloc.h>
52 #endif
53
54 #include <linux/errno.h>
55 #include <linux/sched.h>        /* to get the struct task_struct */
56 #include <linux/string.h>       /* used in new tty drivers */
57 #include <linux/signal.h>       /* used in new tty drivers */
58
59 #include <asm/system.h>
60
61 #include <linux/netdevice.h>
62 #include <linux/skbuff.h>
63 #include <linux/inet.h>
64 #include <linux/ioctl.h>
65
66 #include <linux/ppp_defs.h>
67 #include <linux/ppp-comp.h>
68
69 #include "zlib.c"
70
71 /*
72  * State for a Deflate (de)compressor.
73  */
74 struct ppp_deflate_state {
75     int         seqno;
76     int         w_size;
77     int         unit;
78     int         mru;
79     int         debug;
80     z_stream    strm;
81     struct compstat stats;
82 };
83
84 #define DEFLATE_OVHD    2               /* Deflate overhead/packet */
85
86 static void     *zalloc __P((void *, unsigned int items, unsigned int size));
87 static void     *zalloc_init __P((void *, unsigned int items,
88                                   unsigned int size));
89 static void     zfree __P((void *, void *ptr));
90 static void     *z_comp_alloc __P((unsigned char *options, int opt_len));
91 static void     *z_decomp_alloc __P((unsigned char *options, int opt_len));
92 static void     z_comp_free __P((void *state));
93 static void     z_decomp_free __P((void *state));
94 static int      z_comp_init __P((void *state, unsigned char *options,
95                                  int opt_len,
96                                  int unit, int hdrlen, int debug));
97 static int      z_decomp_init __P((void *state, unsigned char *options,
98                                    int opt_len,
99                                    int unit, int hdrlen, int mru, int debug));
100 static int      z_compress __P((void *state, unsigned char *rptr,
101                                 unsigned char *obuf,
102                                 int isize, int osize));
103 static void     z_incomp __P((void *state, unsigned char *ibuf, int icnt));
104 static int      z_decompress __P((void *state, unsigned char *ibuf,
105                                 int isize, unsigned char *obuf, int osize));
106 static void     z_comp_reset __P((void *state));
107 static void     z_decomp_reset __P((void *state));
108 static void     z_comp_stats __P((void *state, struct compstat *stats));
109
110 struct chunk_header {
111         int valloced;           /* allocated with valloc, not kmalloc */
112         int guard;              /* check for overwritten header */
113 };
114
115 #define GUARD_MAGIC     0x77a8011a
116 #define MIN_VMALLOC     2048    /* use kmalloc for blocks < this */
117
118 /*
119  * Space allocation and freeing routines for use by zlib routines.
120  */
121 void
122 zfree(arg, ptr)
123     void *arg;
124     void *ptr;
125 {
126         struct chunk_header *hdr = ((struct chunk_header *)ptr) - 1;
127
128         if (hdr->guard != GUARD_MAGIC) {
129                 printk(KERN_WARNING "zfree: header corrupted (%x %x) at %p\n",
130                        hdr->valloced, hdr->guard, hdr);
131                 return;
132         }
133         if (hdr->valloced)
134                 vfree(hdr);
135         else
136                 kfree(hdr);
137 }
138
139 void *
140 zalloc(arg, items, size)
141     void *arg;
142     unsigned int items, size;
143 {
144         struct chunk_header *hdr;
145         unsigned nbytes;
146
147         nbytes = items * size + sizeof(*hdr);
148         hdr = kmalloc(nbytes, GFP_ATOMIC);
149         if (hdr == 0)
150                 return 0;
151         hdr->valloced = 0;
152         hdr->guard = GUARD_MAGIC;
153         return (void *) (hdr + 1);
154 }
155
156 void *
157 zalloc_init(arg, items, size)
158     void *arg;
159     unsigned int items, size;
160 {
161         struct chunk_header *hdr;
162         unsigned nbytes;
163
164         nbytes = items * size + sizeof(*hdr);
165         if (nbytes >= MIN_VMALLOC)
166                 hdr = vmalloc(nbytes);
167         else
168                 hdr = kmalloc(nbytes, GFP_KERNEL);
169         if (hdr == 0)
170                 return 0;
171         hdr->valloced = nbytes >= MIN_VMALLOC;
172         hdr->guard = GUARD_MAGIC;
173         return (void *) (hdr + 1);
174 }
175
176 static void
177 z_comp_free(arg)
178     void *arg;
179 {
180         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
181
182         if (state) {
183                 deflateEnd(&state->strm);
184                 kfree(state);
185                 MOD_DEC_USE_COUNT;
186         }
187 }
188
189 /*
190  * Allocate space for a compressor.
191  */
192 static void *
193 z_comp_alloc(options, opt_len)
194     unsigned char *options;
195     int opt_len;
196 {
197         struct ppp_deflate_state *state;
198         int w_size;
199
200         if (opt_len != CILEN_DEFLATE || options[0] != CI_DEFLATE
201             || options[1] != CILEN_DEFLATE
202             || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
203             || options[3] != DEFLATE_CHK_SEQUENCE)
204                 return NULL;
205         w_size = DEFLATE_SIZE(options[2]);
206         if (w_size < DEFLATE_MIN_SIZE || w_size > DEFLATE_MAX_SIZE)
207                 return NULL;
208
209         state = (struct ppp_deflate_state *) kmalloc(sizeof(*state), GFP_KERNEL);
210         if (state == NULL)
211                 return NULL;
212
213         MOD_INC_USE_COUNT;
214         memset (state, 0, sizeof (struct ppp_deflate_state));
215         state->strm.next_in = NULL;
216         state->strm.zalloc  = zalloc_init;
217         state->strm.zfree   = zfree;
218         state->w_size       = w_size;
219
220         if (deflateInit2(&state->strm, Z_DEFAULT_COMPRESSION,
221                          DEFLATE_METHOD_VAL, -w_size, 8, Z_DEFAULT_STRATEGY)
222             != Z_OK) {
223                 z_comp_free(state);
224                 return NULL;
225         }
226
227         state->strm.zalloc = zalloc;
228         return (void *) state;
229 }
230
231 static int
232 z_comp_init(arg, options, opt_len, unit, hdrlen, debug)
233     void *arg;
234     unsigned char *options;
235     int opt_len, unit, hdrlen, debug;
236 {
237         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
238
239         if (opt_len < CILEN_DEFLATE || options[0] != CI_DEFLATE
240             || options[1] != CILEN_DEFLATE
241             || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
242             || DEFLATE_SIZE(options[2]) != state->w_size
243             || options[3] != DEFLATE_CHK_SEQUENCE)
244                 return 0;
245
246         state->seqno = 0;
247         state->unit  = unit;
248         state->debug = debug;
249
250         deflateReset(&state->strm);
251
252         return 1;
253 }
254
255 static void
256 z_comp_reset(arg)
257     void *arg;
258 {
259         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
260
261         state->seqno = 0;
262         deflateReset(&state->strm);
263 }
264
265 int
266 z_compress(arg, rptr, obuf, isize, osize)
267     void *arg;
268     unsigned char *rptr;        /* uncompressed packet (in) */
269     unsigned char *obuf;        /* compressed packet (out) */
270     int isize, osize;
271 {
272         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
273         int r, proto, off, olen;
274         unsigned char *wptr;
275
276         /*
277          * Check that the protocol is in the range we handle.
278          */
279         proto = PPP_PROTOCOL(rptr);
280         if (proto > 0x3fff || proto == 0xfd || proto == 0xfb)
281                 return 0;
282
283         /* Don't generate compressed packets which are larger than
284            the uncompressed packet. */
285         if (osize > isize)
286                 osize = isize;
287
288         wptr = obuf;
289
290         /*
291          * Copy over the PPP header and store the 2-byte sequence number.
292          */
293         wptr[0] = PPP_ADDRESS(rptr);
294         wptr[1] = PPP_CONTROL(rptr);
295         wptr[2] = PPP_COMP >> 8;
296         wptr[3] = PPP_COMP;
297         wptr += PPP_HDRLEN;
298         wptr[0] = state->seqno >> 8;
299         wptr[1] = state->seqno;
300         wptr += 2;
301         state->strm.next_out = wptr;
302         state->strm.avail_out = osize - (PPP_HDRLEN + 2);
303         ++state->seqno;
304
305         off = (proto > 0xff) ? 2 : 3;   /* skip 1st proto byte if 0 */
306         rptr += off;
307         state->strm.next_in = rptr;
308         state->strm.avail_in = (isize - off);
309
310         olen = 0;
311         for (;;) {
312                 r = deflate(&state->strm, Z_PACKET_FLUSH);
313                 if (r != Z_OK) {
314                         if (state->debug)
315                                 printk(KERN_DEBUG "z_compress: deflate returned %d (%s)\n",
316                                        r, (state->strm.msg? state->strm.msg: ""));
317                         break;
318                 }
319                 if (state->strm.avail_out == 0) {
320                         olen += osize;
321                         state->strm.next_out = NULL;
322                         state->strm.avail_out = 1000000;
323                 } else {
324                         break;          /* all done */
325                 }
326         }
327         if (olen < osize)
328                 olen += osize - state->strm.avail_out;
329
330         /*
331          * See if we managed to reduce the size of the packet.
332          */
333         if (olen < isize) {
334                 state->stats.comp_bytes += olen;
335                 state->stats.comp_packets++;
336         } else {
337                 state->stats.inc_bytes += isize;
338                 state->stats.inc_packets++;
339                 olen = 0;
340         }
341         state->stats.unc_bytes += isize;
342         state->stats.unc_packets++;
343
344         return olen;
345 }
346
347 static void
348 z_comp_stats(arg, stats)
349     void *arg;
350     struct compstat *stats;
351 {
352         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
353
354         *stats = state->stats;
355 }
356
357 static void
358 z_decomp_free(arg)
359     void *arg;
360 {
361         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
362
363         if (state) {
364                 inflateEnd(&state->strm);
365                 kfree(state);
366                 MOD_DEC_USE_COUNT;
367         }
368 }
369
370 /*
371  * Allocate space for a decompressor.
372  */
373 static void *
374 z_decomp_alloc(options, opt_len)
375     unsigned char *options;
376     int opt_len;
377 {
378         struct ppp_deflate_state *state;
379         int w_size;
380
381         if (opt_len != CILEN_DEFLATE || options[0] != CI_DEFLATE
382             || options[1] != CILEN_DEFLATE
383             || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
384             || options[3] != DEFLATE_CHK_SEQUENCE)
385                 return NULL;
386         w_size = DEFLATE_SIZE(options[2]);
387         if (w_size < DEFLATE_MIN_SIZE || w_size > DEFLATE_MAX_SIZE)
388                 return NULL;
389
390         state = (struct ppp_deflate_state *) kmalloc(sizeof(*state), GFP_KERNEL);
391         if (state == NULL)
392                 return NULL;
393
394         MOD_INC_USE_COUNT;
395         memset (state, 0, sizeof (struct ppp_deflate_state));
396         state->w_size        = w_size;
397         state->strm.next_out = NULL;
398         state->strm.zalloc   = zalloc_init;
399         state->strm.zfree    = zfree;
400
401         if (inflateInit2(&state->strm, -w_size) != Z_OK) {
402                 z_decomp_free(state);
403                 return NULL;
404         }
405
406         state->strm.zalloc = zalloc;
407         return (void *) state;
408 }
409
410 static int
411 z_decomp_init(arg, options, opt_len, unit, hdrlen, mru, debug)
412     void *arg;
413     unsigned char *options;
414     int opt_len, unit, hdrlen, mru, debug;
415 {
416         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
417
418         if (opt_len < CILEN_DEFLATE || options[0] != CI_DEFLATE
419             || options[1] != CILEN_DEFLATE
420             || DEFLATE_METHOD(options[2]) != DEFLATE_METHOD_VAL
421             || DEFLATE_SIZE(options[2]) != state->w_size
422             || options[3] != DEFLATE_CHK_SEQUENCE)
423                 return 0;
424
425         state->seqno = 0;
426         state->unit  = unit;
427         state->debug = debug;
428         state->mru   = mru;
429
430         inflateReset(&state->strm);
431
432         return 1;
433 }
434
435 static void
436 z_decomp_reset(arg)
437     void *arg;
438 {
439         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
440
441         state->seqno = 0;
442         inflateReset(&state->strm);
443 }
444
445 /*
446  * Decompress a Deflate-compressed packet.
447  *
448  * Because of patent problems, we return DECOMP_ERROR for errors
449  * found by inspecting the input data and for system problems, but
450  * DECOMP_FATALERROR for any errors which could possibly be said to
451  * be being detected "after" decompression.  For DECOMP_ERROR,
452  * we can issue a CCP reset-request; for DECOMP_FATALERROR, we may be
453  * infringing a patent of Motorola's if we do, so we take CCP down
454  * instead.
455  *
456  * Given that the frame has the correct sequence number and a good FCS,
457  * errors such as invalid codes in the input most likely indicate a
458  * bug, so we return DECOMP_FATALERROR for them in order to turn off
459  * compression, even though they are detected by inspecting the input.
460  */
461 int
462 z_decompress(arg, ibuf, isize, obuf, osize)
463     void *arg;
464     unsigned char *ibuf;
465     int isize;
466     unsigned char *obuf;
467     int osize;
468 {
469         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
470         int olen, seq, r;
471         int decode_proto, overflow;
472         unsigned char overflow_buf[1];
473
474         if (isize <= PPP_HDRLEN + DEFLATE_OVHD) {
475                 if (state->debug)
476                         printk(KERN_DEBUG "z_decompress%d: short pkt (%d)\n",
477                                state->unit, isize);
478                 return DECOMP_ERROR;
479         }
480
481         /* Check the sequence number. */
482         seq = (ibuf[PPP_HDRLEN] << 8) + ibuf[PPP_HDRLEN+1];
483         if (seq != state->seqno) {
484                 if (state->debug)
485                         printk(KERN_DEBUG "z_decompress%d: bad seq # %d, expected %d\n",
486                                state->unit, seq, state->seqno);
487                 return DECOMP_ERROR;
488         }
489         ++state->seqno;
490
491         /*
492          * Fill in the first part of the PPP header.  The protocol field
493          * comes from the decompressed data.
494          */
495         obuf[0] = PPP_ADDRESS(ibuf);
496         obuf[1] = PPP_CONTROL(ibuf);
497         obuf[2] = 0;
498
499         /*
500          * Set up to call inflate.  We set avail_out to 1 initially so we can
501          * look at the first byte of the output and decide whether we have
502          * a 1-byte or 2-byte protocol field.
503          */
504         state->strm.next_in = ibuf + PPP_HDRLEN + DEFLATE_OVHD;
505         state->strm.avail_in = isize - (PPP_HDRLEN + DEFLATE_OVHD);
506         state->strm.next_out = obuf + 3;
507         state->strm.avail_out = 1;
508         decode_proto = 1;
509         overflow = 0;
510
511         /*
512          * Call inflate, supplying more input or output as needed.
513          */
514         for (;;) {
515                 r = inflate(&state->strm, Z_PACKET_FLUSH);
516                 if (r != Z_OK) {
517                         if (state->debug)
518                                 printk(KERN_DEBUG "z_decompress%d: inflate returned %d (%s)\n",
519                                        state->unit, r, (state->strm.msg? state->strm.msg: ""));
520                         return DECOMP_FATALERROR;
521                 }
522                 if (state->strm.avail_out != 0)
523                         break;          /* all done */
524                 if (decode_proto) {
525                         state->strm.avail_out = osize - PPP_HDRLEN;
526                         if ((obuf[3] & 1) == 0) {
527                                 /* 2-byte protocol field */
528                                 obuf[2] = obuf[3];
529                                 --state->strm.next_out;
530                                 ++state->strm.avail_out;
531                         }
532                         decode_proto = 0;
533                 } else if (!overflow) {
534                         /*
535                          * We've filled up the output buffer; the only way to
536                          * find out whether inflate has any more characters
537                          * left is to give it another byte of output space.
538                          */
539                         state->strm.next_out = overflow_buf;
540                         state->strm.avail_out = 1;
541                         overflow = 1;
542                 } else {
543                         if (state->debug)
544                                 printk(KERN_DEBUG "z_decompress%d: ran out of mru\n",
545                                        state->unit);
546                         return DECOMP_FATALERROR;
547                 }
548         }
549
550         if (decode_proto)
551                 return DECOMP_ERROR;
552
553         olen = osize + overflow - state->strm.avail_out;
554         state->stats.unc_bytes += olen;
555         state->stats.unc_packets++;
556         state->stats.comp_bytes += isize;
557         state->stats.comp_packets++;
558
559         return olen;
560 }
561
562 /*
563  * Incompressible data has arrived - add it to the history.
564  */
565 static void
566 z_incomp(arg, ibuf, icnt)
567     void *arg;
568     unsigned char *ibuf;
569     int icnt;
570 {
571         struct ppp_deflate_state *state = (struct ppp_deflate_state *) arg;
572         int proto, r;
573
574         /*
575          * Check that the protocol is one we handle.
576          */
577         proto = PPP_PROTOCOL(ibuf);
578         if (proto > 0x3fff || proto == 0xfd || proto == 0xfb)
579                 return;
580
581         ++state->seqno;
582
583         /*
584          * We start at the either the 1st or 2nd byte of the protocol field,
585          * depending on whether the protocol value is compressible.
586          */
587         state->strm.next_in = ibuf + 3;
588         state->strm.avail_in = icnt - 3;
589         if (proto > 0xff) {
590                 --state->strm.next_in;
591                 ++state->strm.avail_in;
592         }
593
594         r = inflateIncomp(&state->strm);
595         if (r != Z_OK) {
596                 /* gak! */
597                 if (state->debug) {
598                         printk(KERN_DEBUG "z_incomp%d: inflateIncomp returned %d (%s)\n",
599                                state->unit, r, (state->strm.msg? state->strm.msg: ""));
600                 }
601                 return;
602         }
603
604         /*
605          * Update stats.
606          */
607         state->stats.inc_bytes += icnt;
608         state->stats.inc_packets++;
609         state->stats.unc_bytes += icnt;
610         state->stats.unc_packets++;
611 }
612
613 /*************************************************************
614  * Module interface table
615  *************************************************************/
616
617 /* These are in ppp.c */
618 extern int  ppp_register_compressor   (struct compressor *cp);
619 extern void ppp_unregister_compressor (struct compressor *cp);
620
621 /*
622  * Procedures exported to if_ppp.c.
623  */
624 struct compressor ppp_deflate = {
625         CI_DEFLATE,             /* compress_proto */
626         z_comp_alloc,           /* comp_alloc */
627         z_comp_free,            /* comp_free */
628         z_comp_init,            /* comp_init */
629         z_comp_reset,           /* comp_reset */
630         z_compress,             /* compress */
631         z_comp_stats,           /* comp_stat */
632         z_decomp_alloc,         /* decomp_alloc */
633         z_decomp_free,          /* decomp_free */
634         z_decomp_init,          /* decomp_init */
635         z_decomp_reset,         /* decomp_reset */
636         z_decompress,           /* decompress */
637         z_incomp,               /* incomp */
638         z_comp_stats,           /* decomp_stat */
639 };
640
641 #ifdef MODULE
642 /*************************************************************
643  * Module support routines
644  *************************************************************/
645
646 int
647 init_module(void)
648 {  
649         int answer = ppp_register_compressor (&ppp_deflate);
650         if (answer == 0)
651                 printk (KERN_INFO
652                         "PPP Deflate Compression module registered\n");
653         return answer;
654 }
655      
656 void
657 cleanup_module(void)
658 {
659         if (MOD_IN_USE)
660                 printk (KERN_INFO
661                         "Deflate Compression module busy, remove delayed\n");
662         else
663                 ppp_unregister_compressor (&ppp_deflate);
664 }
665 #endif