modules/bsd-comp.c

   1 /* Because this code is derived from the 4.3BSD compress source:
   2  *
   3  *
   4  * Copyright (c) 1985, 1986 The Regents of the University of California.
   5  * All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * James A. Woods, derived from original work by Spencer Thomas
   9  * and Joseph Orost.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  */
  39
  40 /*
  41  * This version is for use with STREAMS under SunOS 4.x,
  42  * DEC Alpha OSF/1, AIX 4.x, and SVR4 systems including Solaris 2.
  43  *
  44  * $Id: bsd-comp.c,v 1.18 1996/01/18 03:12:53 paulus Exp $
  45  */
  46
  47 #ifdef AIX4
  48 #include <net/net_globals.h>
  49 #endif
  50 #include <sys/param.h>
  51 #include <sys/types.h>
  52 #include <sys/stream.h>
  53 #include <net/ppp_defs.h>
  54 #include "ppp_mod.h"
  55
  56 #ifdef SVR4
  57 #include <sys/byteorder.h>
  58 #ifndef _BIG_ENDIAN
  59 #define BSD_LITTLE_ENDIAN
  60 #endif
  61 #endif
  62
  63 #ifdef OSF1
  64 #undef FIRST
  65 #undef LAST
  66 #define BSD_LITTLE_ENDIAN
  67 #endif
  68
  69 #define PACKETPTR       mblk_t *
  70 #include <net/ppp-comp.h>
  71
  72 #if DO_BSD_COMPRESS
  73
  74 /*
  75  * PPP "BSD compress" compression
  76  *  The differences between this compression and the classic BSD LZW
  77  *  source are obvious from the requirement that the classic code worked
  78  *  with files while this handles arbitrarily long streams that
  79  *  are broken into packets.  They are:
  80  *
  81  *      When the code size expands, a block of junk is not emitted by
  82  *          the compressor and not expected by the decompressor.
  83  *
  84  *      New codes are not necessarily assigned every time an old
  85  *          code is output by the compressor.  This is because a packet
  86  *          end forces a code to be emitted, but does not imply that a
  87  *          new sequence has been seen.
  88  *
  89  *      The compression ratio is checked at the first end of a packet
  90  *          after the appropriate gap.  Besides simplifying and speeding
  91  *          things up, this makes it more likely that the transmitter
  92  *          and receiver will agree when the dictionary is cleared when
  93  *          compression is not going well.
  94  */
  95
  96 /*
  97  * A dictionary for doing BSD compress.
  98  */
  99 struct bsd_db {
 100     int     totlen;                     /* length of this structure */
 101     u_int   hsize;                      /* size of the hash table */
 102     u_char  hshift;                     /* used in hash function */
 103     u_char  n_bits;                     /* current bits/code */
 104     u_char  maxbits;
 105     u_char  debug;
 106     u_char  unit;
 107     u_short seqno;                      /* sequence number of next packet */
 108     u_int   hdrlen;                     /* header length to preallocate */
 109     u_int   mru;
 110     u_int   maxmaxcode;                 /* largest valid code */
 111     u_int   max_ent;                    /* largest code in use */
 112     u_int   in_count;                   /* uncompressed bytes, aged */
 113     u_int   bytes_out;                  /* compressed bytes, aged */
 114     u_int   ratio;                      /* recent compression ratio */
 115     u_int   checkpoint;                 /* when to next check the ratio */
 116     u_int   clear_count;                /* times dictionary cleared */
 117     u_int   incomp_count;               /* incompressible packets */
 118     u_int   incomp_bytes;               /* incompressible bytes */
 119     u_int   uncomp_count;               /* uncompressed packets */
 120     u_int   uncomp_bytes;               /* uncompressed bytes */
 121     u_int   comp_count;                 /* compressed packets */
 122     u_int   comp_bytes;                 /* compressed bytes */
 123     u_short *lens;                      /* array of lengths of codes */
 124     struct bsd_dict {
 125         union {                         /* hash value */
 126             u_int32_t   fcode;
 127             struct {
 128 #ifdef BSD_LITTLE_ENDIAN
 129                 u_short prefix;         /* preceding code */
 130                 u_char  suffix;         /* last character of new code */
 131                 u_char  pad;
 132 #else
 133                 u_char  pad;
 134                 u_char  suffix;         /* last character of new code */
 135                 u_short prefix;         /* preceding code */
 136 #endif
 137             } hs;
 138         } f;
 139         u_short codem1;                 /* output of hash table -1 */
 140         u_short cptr;                   /* map code to hash table entry */
 141     } dict[1];
 142 };
 143
 144 #define BSD_OVHD        2               /* BSD compress overhead/packet */
 145 #define BSD_INIT_BITS   BSD_MIN_BITS
 146
 147 static void     *bsd_comp_alloc __P((u_char *options, int opt_len));
 148 static void     *bsd_decomp_alloc __P((u_char *options, int opt_len));
 149 static void     bsd_free __P((void *state));
 150 static int      bsd_comp_init __P((void *state, u_char *options, int opt_len,
 151                                    int unit, int hdrlen, int debug));
 152 static int      bsd_decomp_init __P((void *state, u_char *options, int opt_len,
 153                                      int unit, int hdrlen, int mru, int debug));
 154 static int      bsd_compress __P((void *state, mblk_t **mret,
 155                                   mblk_t *mp, int slen, int maxolen));
 156 static void     bsd_incomp __P((void *state, mblk_t *dmsg));
 157 static int      bsd_decompress __P((void *state, mblk_t *cmp, mblk_t **dmpp));
 158 static void     bsd_reset __P((void *state));
 159 static void     bsd_comp_stats __P((void *state, struct compstat *stats));
 160
 161 /*
 162  * Procedures exported to ppp_comp.c.
 163  */
 164 struct compressor ppp_bsd_compress = {
 165     CI_BSD_COMPRESS,            /* compress_proto */
 166     bsd_comp_alloc,             /* comp_alloc */
 167     bsd_free,                   /* comp_free */
 168     bsd_comp_init,              /* comp_init */
 169     bsd_reset,                  /* comp_reset */
 170     bsd_compress,               /* compress */
 171     bsd_comp_stats,             /* comp_stat */
 172     bsd_decomp_alloc,           /* decomp_alloc */
 173     bsd_free,                   /* decomp_free */
 174     bsd_decomp_init,            /* decomp_init */
 175     bsd_reset,                  /* decomp_reset */
 176     bsd_decompress,             /* decompress */
 177     bsd_incomp,                 /* incomp */
 178     bsd_comp_stats,             /* decomp_stat */
 179 };
 180
 181 /*
 182  * the next two codes should not be changed lightly, as they must not
 183  * lie within the contiguous general code space.
 184  */
 185 #define CLEAR   256                     /* table clear output code */
 186 #define FIRST   257                     /* first free entry */
 187 #define LAST    255
 188
 189 #define MAXCODE(b)      ((1 << (b)) - 1)
 190 #define BADCODEM1       MAXCODE(BSD_MAX_BITS)
 191
 192 #define BSD_HASH(prefix,suffix,hshift)  ((((u_int32_t)(suffix)) << (hshift)) \
 193                                          ^ (u_int32_t)(prefix))
 194 #define BSD_KEY(prefix,suffix)          ((((u_int32_t)(suffix)) << 16) \
 195                                          + (u_int32_t)(prefix))
 196
 197 #define CHECK_GAP       10000           /* Ratio check interval */
 198
 199 #define RATIO_SCALE_LOG 8
 200 #define RATIO_SCALE     (1<<RATIO_SCALE_LOG)
 201 #define RATIO_MAX       (0x7fffffff>>RATIO_SCALE_LOG)
 202
 203 #define DECOMP_CHUNK    256
 204
 205 /*
 206  * clear the dictionary
 207  */
 208 static void
 209 bsd_clear(db)
 210     struct bsd_db *db;
 211 {
 212     db->clear_count++;
 213     db->max_ent = FIRST-1;
 214     db->n_bits = BSD_INIT_BITS;
 215     db->ratio = 0;
 216     db->bytes_out = 0;
 217     db->in_count = 0;
 218     db->incomp_count = 0;
 219     db->checkpoint = CHECK_GAP;
 220 }
 221
 222 /*
 223  * If the dictionary is full, then see if it is time to reset it.
 224  *
 225  * Compute the compression ratio using fixed-point arithmetic
 226  * with 8 fractional bits.
 227  *
 228  * Since we have an infinite stream instead of a single file,
 229  * watch only the local compression ratio.
 230  *
 231  * Since both peers must reset the dictionary at the same time even in
 232  * the absence of CLEAR codes (while packets are incompressible), they
 233  * must compute the same ratio.
 234  */
 235 static int                              /* 1=output CLEAR */
 236 bsd_check(db)
 237     struct bsd_db *db;
 238 {
 239     u_int new_ratio;
 240
 241     if (db->in_count >= db->checkpoint) {
 242         /* age the ratio by limiting the size of the counts */
 243         if (db->in_count >= RATIO_MAX
 244             || db->bytes_out >= RATIO_MAX) {
 245             db->in_count -= db->in_count/4;
 246             db->bytes_out -= db->bytes_out/4;
 247         }
 248
 249         db->checkpoint = db->in_count + CHECK_GAP;
 250
 251         if (db->max_ent >= db->maxmaxcode) {
 252             /* Reset the dictionary only if the ratio is worse,
 253              * or if it looks as if it has been poisoned
 254              * by incompressible data.
 255              *
 256              * This does not overflow, because
 257              *  db->in_count <= RATIO_MAX.
 258              */
 259             new_ratio = db->in_count << RATIO_SCALE_LOG;
 260             if (db->bytes_out != 0)
 261                 new_ratio /= db->bytes_out;
 262
 263             if (new_ratio < db->ratio || new_ratio < 1 * RATIO_SCALE) {
 264                 bsd_clear(db);
 265                 return 1;
 266             }
 267             db->ratio = new_ratio;
 268         }
 269     }
 270     return 0;
 271 }
 272
 273 /*
 274  * Return statistics.
 275  */
 276 static void
 277 bsd_comp_stats(state, stats)
 278     void *state;
 279     struct compstat *stats;
 280 {
 281     struct bsd_db *db = (struct bsd_db *) state;
 282     u_int out;
 283
 284     stats->unc_bytes = db->uncomp_bytes;
 285     stats->unc_packets = db->uncomp_count;
 286     stats->comp_bytes = db->comp_bytes;
 287     stats->comp_packets = db->comp_count;
 288     stats->inc_bytes = db->incomp_bytes;
 289     stats->inc_packets = db->incomp_count;
 290     stats->ratio = db->in_count;
 291     out = db->bytes_out;
 292     if (stats->ratio <= 0x7fffff)
 293         stats->ratio <<= 8;
 294     else
 295         out >>= 8;
 296     if (out != 0)
 297         stats->ratio /= out;
 298 }
 299
 300 /*
 301  * Reset state, as on a CCP ResetReq.
 302  */
 303 static void
 304 bsd_reset(state)
 305     void *state;
 306 {
 307     struct bsd_db *db = (struct bsd_db *) state;
 308
 309     db->seqno = 0;
 310     bsd_clear(db);
 311     db->clear_count = 0;
 312 }
 313
 314 /*
 315  * Allocate space for a (de) compressor.
 316  */
 317 static void *
 318 bsd_alloc(options, opt_len, decomp)
 319     u_char *options;
 320     int opt_len, decomp;
 321 {
 322     int bits;
 323     u_int newlen, hsize, hshift, maxmaxcode;
 324     struct bsd_db *db;
 325
 326     if (opt_len != 3 || options[0] != CI_BSD_COMPRESS || options[1] != 3
 327         || BSD_VERSION(options[2]) != BSD_CURRENT_VERSION)
 328         return NULL;
 329     bits = BSD_NBITS(options[2]);
 330     switch (bits) {
 331     case 9:                     /* needs 82152 for both directions */
 332     case 10:                    /* needs 84144 */
 333     case 11:                    /* needs 88240 */
 334     case 12:                    /* needs 96432 */
 335         hsize = 5003;
 336         hshift = 4;
 337         break;
 338     case 13:                    /* needs 176784 */
 339         hsize = 9001;
 340         hshift = 5;
 341         break;
 342     case 14:                    /* needs 353744 */
 343         hsize = 18013;
 344         hshift = 6;
 345         break;
 346     case 15:                    /* needs 691440 */
 347         hsize = 35023;
 348         hshift = 7;
 349         break;
 350     case 16:                    /* needs 1366160--far too much, */
 351         /* hsize = 69001; */    /* and 69001 is too big for cptr */
 352         /* hshift = 8; */       /* in struct bsd_db */
 353         /* break; */
 354     default:
 355         return NULL;
 356     }
 357
 358     maxmaxcode = MAXCODE(bits);
 359     newlen = sizeof(*db) + (hsize-1) * (sizeof(db->dict[0]));
 360     db = (struct bsd_db *) ALLOC_NOSLEEP(newlen);
 361     if (!db)
 362         return NULL;
 363     bzero(db, sizeof(*db) - sizeof(db->dict));
 364
 365     if (!decomp) {
 366         db->lens = NULL;
 367     } else {
 368         db->lens = (u_short *) ALLOC_NOSLEEP((maxmaxcode+1) * sizeof(db->lens[0]));
 369         if (!db->lens) {
 370             FREE(db, newlen);
 371             return NULL;
 372         }
 373     }
 374
 375     db->totlen = newlen;
 376     db->hsize = hsize;
 377     db->hshift = hshift;
 378     db->maxmaxcode = maxmaxcode;
 379     db->maxbits = bits;
 380
 381     return (void *) db;
 382 }
 383
 384 static void
 385 bsd_free(state)
 386     void *state;
 387 {
 388     struct bsd_db *db = (struct bsd_db *) state;
 389
 390     if (db->lens)
 391         FREE(db->lens, (db->maxmaxcode+1) * sizeof(db->lens[0]));
 392     FREE(db, db->totlen);
 393 }
 394
 395 static void *
 396 bsd_comp_alloc(options, opt_len)
 397     u_char *options;
 398     int opt_len;
 399 {
 400     return bsd_alloc(options, opt_len, 0);
 401 }
 402
 403 static void *
 404 bsd_decomp_alloc(options, opt_len)
 405     u_char *options;
 406     int opt_len;
 407 {
 408     return bsd_alloc(options, opt_len, 1);
 409 }
 410
 411 /*
 412  * Initialize the database.
 413  */
 414 static int
 415 bsd_init(db, options, opt_len, unit, hdrlen, mru, debug, decomp)
 416     struct bsd_db *db;
 417     u_char *options;
 418     int opt_len, unit, hdrlen, mru, debug, decomp;
 419 {
 420     int i;
 421
 422     if (opt_len < CILEN_BSD_COMPRESS
 423         || options[0] != CI_BSD_COMPRESS || options[1] != CILEN_BSD_COMPRESS
 424         || BSD_VERSION(options[2]) != BSD_CURRENT_VERSION
 425         || BSD_NBITS(options[2]) != db->maxbits
 426         || decomp && db->lens == NULL)
 427         return 0;
 428
 429     if (decomp) {
 430         i = LAST+1;
 431         while (i != 0)
 432             db->lens[--i] = 1;
 433     }
 434     i = db->hsize;
 435     while (i != 0) {
 436         db->dict[--i].codem1 = BADCODEM1;
 437         db->dict[i].cptr = 0;
 438     }
 439
 440     db->unit = unit;
 441     db->hdrlen = hdrlen;
 442     db->mru = mru;
 443     if (debug)
 444         db->debug = 1;
 445
 446     bsd_reset(db);
 447
 448     return 1;
 449 }
 450
 451 static int
 452 bsd_comp_init(state, options, opt_len, unit, hdrlen, debug)
 453     void *state;
 454     u_char *options;
 455     int opt_len, unit, hdrlen, debug;
 456 {
 457     return bsd_init((struct bsd_db *) state, options, opt_len,
 458                     unit, hdrlen, 0, debug, 0);
 459 }
 460
 461 static int
 462 bsd_decomp_init(state, options, opt_len, unit, hdrlen, mru, debug)
 463     void *state;
 464     u_char *options;
 465     int opt_len, unit, hdrlen, mru, debug;
 466 {
 467     return bsd_init((struct bsd_db *) state, options, opt_len,
 468                     unit, hdrlen, mru, debug, 1);
 469 }
 470
 471
 472 /*
 473  * compress a packet
 474  *      One change from the BSD compress command is that when the
 475  *      code size expands, we do not output a bunch of padding.
 476  *
 477  * N.B. at present, we ignore the hdrlen specified in the comp_init call.
 478  */
 479 static int                      /* new slen */
 480 bsd_compress(state, mretp, mp, slen, maxolen)
 481     void *state;
 482     mblk_t **mretp;             /* return compressed mbuf chain here */
 483     mblk_t *mp;                 /* from here */
 484     int slen;                   /* uncompressed length */
 485     int maxolen;                /* max compressed length */
 486 {
 487     struct bsd_db *db = (struct bsd_db *) state;
 488     int hshift = db->hshift;
 489     u_int max_ent = db->max_ent;
 490     u_int n_bits = db->n_bits;
 491     u_int bitno = 32;
 492     u_int32_t accm = 0, fcode;
 493     struct bsd_dict *dictp;
 494     u_char c;
 495     int hval, disp, ent, ilen;
 496     mblk_t *np, *mret;
 497     u_char *rptr, *wptr;
 498     u_char *cp_end;
 499     int olen;
 500     mblk_t *m, **mnp;
 501
 502 #define PUTBYTE(v) {                                    \
 503     if (wptr) {                                         \
 504         *wptr++ = (v);                                  \
 505         if (wptr >= cp_end) {                           \
 506             m->b_wptr = wptr;                           \
 507             m = m->b_cont;                              \
 508             if (m) {                                    \
 509                 wptr = m->b_wptr;                       \
 510                 cp_end = m->b_datap->db_lim;            \
 511             } else                                      \
 512                 wptr = NULL;                            \
 513         }                                               \
 514     }                                                   \
 515     ++olen;                                             \
 516 }
 517
 518 #define OUTPUT(ent) {                                   \
 519     bitno -= n_bits;                                    \
 520     accm |= ((ent) << bitno);                           \
 521     do {                                                \
 522         PUTBYTE(accm >> 24);                            \
 523         accm <<= 8;                                     \
 524         bitno += 8;                                     \
 525     } while (bitno <= 24);                              \
 526 }
 527
 528     /*
 529      * First get the protocol and check that we're
 530      * interested in this packet.
 531      */
 532     *mretp = NULL;
 533     rptr = mp->b_rptr;
 534     if (rptr + PPP_HDRLEN > mp->b_wptr) {
 535         if (!pullupmsg(mp, PPP_HDRLEN))
 536             return 0;
 537         rptr = mp->b_rptr;
 538     }
 539     ent = PPP_PROTOCOL(rptr);           /* get the protocol */
 540     if (ent < 0x21 || ent > 0xf9)
 541         return 0;
 542
 543     /* Don't generate compressed packets which are larger than
 544        the uncompressed packet. */
 545     if (maxolen > slen)
 546         maxolen = slen;
 547
 548     /* Allocate enough message blocks to give maxolen total space. */
 549     mnp = &mret;
 550     for (olen = maxolen; olen > 0; ) {
 551         m = allocb((olen < 4096? olen: 4096), BPRI_MED);
 552         *mnp = m;
 553         if (m == NULL) {
 554             if (mret != NULL) {
 555                 freemsg(mret);
 556                 mnp = &mret;
 557             }
 558             break;
 559         }
 560         mnp = &m->b_cont;
 561         olen -= m->b_datap->db_lim - m->b_wptr;
 562     }
 563     *mnp = NULL;
 564
 565     if ((m = mret) != NULL) {
 566         wptr = m->b_wptr;
 567         cp_end = m->b_datap->db_lim;
 568     } else
 569         wptr = cp_end = NULL;
 570     olen = 0;
 571
 572     /*
 573      * Copy the PPP header over, changing the protocol,
 574      * and install the 2-byte sequence number.
 575      */
 576     if (wptr) {
 577         wptr[0] = PPP_ADDRESS(rptr);
 578         wptr[1] = PPP_CONTROL(rptr);
 579         wptr[2] = 0;            /* change the protocol */
 580         wptr[3] = PPP_COMP;
 581         wptr[4] = db->seqno >> 8;
 582         wptr[5] = db->seqno;
 583         wptr += PPP_HDRLEN + BSD_OVHD;
 584     }
 585     ++db->seqno;
 586     rptr += PPP_HDRLEN;
 587
 588     slen = mp->b_wptr - rptr;
 589     ilen = slen + 1;
 590     np = mp->b_cont;
 591     for (;;) {
 592         if (slen <= 0) {
 593             if (!np)
 594                 break;
 595             rptr = np->b_rptr;
 596             slen = np->b_wptr - rptr;
 597             np = np->b_cont;
 598             if (!slen)
 599                 continue;   /* handle 0-length buffers */
 600             ilen += slen;
 601         }
 602
 603         slen--;
 604         c = *rptr++;
 605         fcode = BSD_KEY(ent, c);
 606         hval = BSD_HASH(ent, c, hshift);
 607         dictp = &db->dict[hval];
 608
 609         /* Validate and then check the entry. */
 610         if (dictp->codem1 >= max_ent)
 611             goto nomatch;
 612         if (dictp->f.fcode == fcode) {
 613             ent = dictp->codem1+1;
 614             continue;   /* found (prefix,suffix) */
 615         }
 616
 617         /* continue probing until a match or invalid entry */
 618         disp = (hval == 0) ? 1 : hval;
 619         do {
 620             hval += disp;
 621             if (hval >= db->hsize)
 622                 hval -= db->hsize;
 623             dictp = &db->dict[hval];
 624             if (dictp->codem1 >= max_ent)
 625                 goto nomatch;
 626         } while (dictp->f.fcode != fcode);
 627         ent = dictp->codem1 + 1;        /* finally found (prefix,suffix) */
 628         continue;
 629
 630     nomatch:
 631         OUTPUT(ent);            /* output the prefix */
 632
 633         /* code -> hashtable */
 634         if (max_ent < db->maxmaxcode) {
 635             struct bsd_dict *dictp2;
 636             /* expand code size if needed */
 637             if (max_ent >= MAXCODE(n_bits))
 638                 db->n_bits = ++n_bits;
 639
 640             /* Invalidate old hash table entry using
 641              * this code, and then take it over.
 642              */
 643             dictp2 = &db->dict[max_ent+1];
 644             if (db->dict[dictp2->cptr].codem1 == max_ent)
 645                 db->dict[dictp2->cptr].codem1 = BADCODEM1;
 646             dictp2->cptr = hval;
 647             dictp->codem1 = max_ent;
 648             dictp->f.fcode = fcode;
 649
 650             db->max_ent = ++max_ent;
 651         }
 652         ent = c;
 653     }
 654
 655     OUTPUT(ent);                /* output the last code */
 656     db->bytes_out += olen;
 657     db->in_count += ilen;
 658     if (bitno < 32)
 659         ++db->bytes_out;        /* count complete bytes */
 660
 661     if (bsd_check(db))
 662         OUTPUT(CLEAR);          /* do not count the CLEAR */
 663
 664     /*
 665      * Pad dribble bits of last code with ones.
 666      * Do not emit a completely useless byte of ones.
 667      */
 668     if (bitno != 32)
 669         PUTBYTE((accm | (0xff << (bitno-8))) >> 24);
 670
 671     /*
 672      * Increase code size if we would have without the packet
 673      * boundary and as the decompressor will.
 674      */
 675     if (max_ent >= MAXCODE(n_bits) && max_ent < db->maxmaxcode)
 676         db->n_bits++;
 677
 678     db->uncomp_bytes += ilen;
 679     ++db->uncomp_count;
 680     if (olen + PPP_HDRLEN + BSD_OVHD > maxolen && mret != NULL) {
 681         /* throw away the compressed stuff if it is longer than uncompressed */
 682         freemsg(mret);
 683         mret = NULL;
 684         ++db->incomp_count;
 685         db->incomp_bytes += ilen;
 686     } else if (wptr != NULL) {
 687         m->b_wptr = wptr;
 688         if (m->b_cont) {
 689             freemsg(m->b_cont);
 690             m->b_cont = NULL;
 691         }
 692         ++db->comp_count;
 693         db->comp_bytes += olen + BSD_OVHD;
 694     }
 695
 696     *mretp = mret;
 697     return olen + PPP_HDRLEN + BSD_OVHD;
 698 #undef OUTPUT
 699 #undef PUTBYTE
 700 }
 701
 702
 703 /*
 704  * Update the "BSD Compress" dictionary on the receiver for
 705  * incompressible data by pretending to compress the incoming data.
 706  */
 707 static void
 708 bsd_incomp(state, dmsg)
 709     void *state;
 710     mblk_t *dmsg;
 711 {
 712     struct bsd_db *db = (struct bsd_db *) state;
 713     u_int hshift = db->hshift;
 714     u_int max_ent = db->max_ent;
 715     u_int n_bits = db->n_bits;
 716     struct bsd_dict *dictp;
 717     u_int32_t fcode;
 718     u_char c;
 719     long hval, disp;
 720     int slen, ilen;
 721     u_int bitno = 7;
 722     u_char *rptr;
 723     u_int ent;
 724
 725     rptr = dmsg->b_rptr;
 726     if (rptr + PPP_HDRLEN > dmsg->b_wptr) {
 727         if (!pullupmsg(dmsg, PPP_HDRLEN))
 728             return;
 729         rptr = dmsg->b_rptr;
 730     }
 731     ent = PPP_PROTOCOL(rptr);           /* get the protocol */
 732     if (ent < 0x21 || ent > 0xf9)
 733         return;
 734
 735     db->incomp_count++;
 736     db->seqno++;
 737     ilen = 1;           /* count the protocol as 1 byte */
 738     rptr += PPP_HDRLEN;
 739     for (;;) {
 740         slen = dmsg->b_wptr - rptr;
 741         if (slen <= 0) {
 742             dmsg = dmsg->b_cont;
 743             if (!dmsg)
 744                 break;
 745             rptr = dmsg->b_rptr;
 746             continue;           /* skip zero-length buffers */
 747         }
 748         ilen += slen;
 749
 750         do {
 751             c = *rptr++;
 752             fcode = BSD_KEY(ent, c);
 753             hval = BSD_HASH(ent, c, hshift);
 754             dictp = &db->dict[hval];
 755
 756             /* validate and then check the entry */
 757             if (dictp->codem1 >= max_ent)
 758                 goto nomatch;
 759             if (dictp->f.fcode == fcode) {
 760                 ent = dictp->codem1+1;
 761                 continue;   /* found (prefix,suffix) */
 762             }
 763
 764             /* continue probing until a match or invalid entry */
 765             disp = (hval == 0) ? 1 : hval;
 766             do {
 767                 hval += disp;
 768                 if (hval >= db->hsize)
 769                     hval -= db->hsize;
 770                 dictp = &db->dict[hval];
 771                 if (dictp->codem1 >= max_ent)
 772                     goto nomatch;
 773             } while (dictp->f.fcode != fcode);
 774             ent = dictp->codem1+1;
 775             continue;   /* finally found (prefix,suffix) */
 776
 777         nomatch:                /* output (count) the prefix */
 778             bitno += n_bits;
 779
 780             /* code -> hashtable */
 781             if (max_ent < db->maxmaxcode) {
 782                 struct bsd_dict *dictp2;
 783                 /* expand code size if needed */
 784                 if (max_ent >= MAXCODE(n_bits))
 785                     db->n_bits = ++n_bits;
 786
 787                 /* Invalidate previous hash table entry
 788                  * assigned this code, and then take it over.
 789                  */
 790                 dictp2 = &db->dict[max_ent+1];
 791                 if (db->dict[dictp2->cptr].codem1 == max_ent)
 792                     db->dict[dictp2->cptr].codem1 = BADCODEM1;
 793                 dictp2->cptr = hval;
 794                 dictp->codem1 = max_ent;
 795                 dictp->f.fcode = fcode;
 796
 797                 db->max_ent = ++max_ent;
 798                 db->lens[max_ent] = db->lens[ent]+1;
 799             }
 800             ent = c;
 801         } while (--slen != 0);
 802     }
 803     bitno += n_bits;            /* output (count) the last code */
 804     db->bytes_out += bitno/8;
 805     db->in_count += ilen;
 806     (void)bsd_check(db);
 807
 808     ++db->incomp_count;
 809     db->incomp_bytes += ilen;
 810     ++db->uncomp_count;
 811     db->uncomp_bytes += ilen;
 812
 813     /* Increase code size if we would have without the packet
 814      * boundary and as the decompressor will.
 815      */
 816     if (max_ent >= MAXCODE(n_bits) && max_ent < db->maxmaxcode)
 817         db->n_bits++;
 818 }
 819
 820
 821 /*
 822  * Decompress "BSD Compress"
 823  *
 824  * Because of patent problems, we return DECOMP_ERROR for errors
 825  * found by inspecting the input data and for system problems, but
 826  * DECOMP_FATALERROR for any errors which could possibly be said to
 827  * be being detected "after" decompression.  For DECOMP_ERROR,
 828  * we can issue a CCP reset-request; for DECOMP_FATALERROR, we may be
 829  * infringing a patent of Motorola's if we do, so we take CCP down
 830  * instead.
 831  *
 832  * Given that the frame has the correct sequence number and a good FCS,
 833  * errors such as invalid codes in the input most likely indicate a
 834  * bug, so we return DECOMP_FATALERROR for them in order to turn off
 835  * compression, even though they are detected by inspecting the input.
 836  */
 837 static int
 838 bsd_decompress(state, cmsg, dmpp)
 839     void *state;
 840     mblk_t *cmsg, **dmpp;
 841 {
 842     struct bsd_db *db = (struct bsd_db *) state;
 843     u_int max_ent = db->max_ent;
 844     u_int32_t accm = 0;
 845     u_int bitno = 32;           /* 1st valid bit in accm */
 846     u_int n_bits = db->n_bits;
 847     u_int tgtbitno = 32-n_bits; /* bitno when we have a code */
 848     struct bsd_dict *dictp;
 849     int explen, i, seq, len;
 850     u_int incode, oldcode, finchar;
 851     u_char *p, *rptr, *wptr;
 852     mblk_t *dmsg, *mret;
 853     int adrs, ctrl, ilen;
 854     int dlen, space, codelen, extra;
 855
 856     /*
 857      * Get at least the BSD Compress header in the first buffer
 858      */
 859     rptr = cmsg->b_rptr;
 860     if (rptr + PPP_HDRLEN + BSD_OVHD >= cmsg->b_wptr) {
 861         if (!pullupmsg(cmsg, PPP_HDRLEN + BSD_OVHD + 1)) {
 862             if (db->debug)
 863                 printf("bsd_decomp%d: failed to pullup\n", db->unit);
 864             return DECOMP_ERROR;
 865         }
 866         rptr = cmsg->b_rptr;
 867     }
 868
 869     /*
 870      * Save the address/control from the PPP header
 871      * and then get the sequence number.
 872      */
 873     adrs = PPP_ADDRESS(rptr);
 874     ctrl = PPP_CONTROL(rptr);
 875     rptr += PPP_HDRLEN;
 876     seq = (rptr[0] << 8) + rptr[1];
 877     rptr += BSD_OVHD;
 878     ilen = len = cmsg->b_wptr - rptr;
 879
 880     /*
 881      * Check the sequence number and give up if it is not what we expect.
 882      */
 883     if (seq != db->seqno++) {
 884         if (db->debug)
 885             printf("bsd_decomp%d: bad sequence # %d, expected %d\n",
 886                    db->unit, seq, db->seqno - 1);
 887         return DECOMP_ERROR;
 888     }
 889
 890     /*
 891      * Allocate one message block to start with.
 892      */
 893     if ((dmsg = allocb(DECOMP_CHUNK + db->hdrlen, BPRI_MED)) == NULL)
 894         return DECOMP_ERROR;
 895     mret = dmsg;
 896     dmsg->b_wptr += db->hdrlen;
 897     dmsg->b_rptr = wptr = dmsg->b_wptr;
 898
 899     /* Fill in the ppp header, but not the last byte of the protocol
 900        (that comes from the decompressed data). */
 901     wptr[0] = adrs;
 902     wptr[1] = ctrl;
 903     wptr[2] = 0;
 904     wptr += PPP_HDRLEN - 1;
 905     space = dmsg->b_datap->db_lim - wptr;
 906
 907     oldcode = CLEAR;
 908     explen = 0;
 909     for (;;) {
 910         if (len == 0) {
 911             cmsg = cmsg->b_cont;
 912             if (!cmsg)          /* quit at end of message */
 913                 break;
 914             rptr = cmsg->b_rptr;
 915             len = cmsg->b_wptr - rptr;
 916             ilen += len;
 917             continue;           /* handle 0-length buffers */
 918         }
 919
 920         /*
 921          * Accumulate bytes until we have a complete code.
 922          * Then get the next code, relying on the 32-bit,
 923          * unsigned accm to mask the result.
 924          */
 925         bitno -= 8;
 926         accm |= *rptr++ << bitno;
 927         --len;
 928         if (tgtbitno < bitno)
 929             continue;
 930         incode = accm >> tgtbitno;
 931         accm <<= n_bits;
 932         bitno += n_bits;
 933
 934         if (incode == CLEAR) {
 935             /*
 936              * The dictionary must only be cleared at
 937              * the end of a packet.  But there could be an
 938              * empty message block at the end.
 939              */
 940             if (len > 0 || cmsg->b_cont != 0) {
 941                 if (cmsg->b_cont)
 942                     len += msgdsize(cmsg->b_cont);
 943                 if (len > 0) {
 944                     freemsg(dmsg);
 945                     if (db->debug)
 946                         printf("bsd_decomp%d: bad CLEAR\n", db->unit);
 947                     return DECOMP_FATALERROR;
 948                 }
 949             }
 950             bsd_clear(db);
 951             explen = ilen = 0;
 952             break;
 953         }
 954
 955         if (incode > max_ent + 2 || incode > db->maxmaxcode
 956             || incode > max_ent && oldcode == CLEAR) {
 957             freemsg(dmsg);
 958             if (db->debug) {
 959                 printf("bsd_decomp%d: bad code 0x%x oldcode=0x%x ",
 960                        db->unit, incode, oldcode);
 961                 printf("max_ent=0x%x dlen=%d seqno=%d\n",
 962                        max_ent, dlen, db->seqno);
 963             }
 964             return DECOMP_FATALERROR;   /* probably a bug */
 965         }
 966
 967         /* Special case for KwKwK string. */
 968         if (incode > max_ent) {
 969             finchar = oldcode;
 970             extra = 1;
 971         } else {
 972             finchar = incode;
 973             extra = 0;
 974         }
 975
 976         codelen = db->lens[finchar];
 977         explen += codelen + extra;
 978         if (explen > db->mru + 1) {
 979             freemsg(dmsg);
 980             if (db->debug)
 981                 printf("bsd_decomp%d: ran out of mru\n", db->unit);
 982             return DECOMP_FATALERROR;
 983         }
 984
 985         /*
 986          * Decode this code and install it in the decompressed buffer.
 987          */
 988         space -= codelen + extra;
 989         if (space < 0) {
 990             /* Allocate another message block. */
 991             dmsg->b_wptr = wptr;
 992             dlen = codelen + extra;
 993             if (dlen < DECOMP_CHUNK)
 994                 dlen = DECOMP_CHUNK;
 995             if ((dmsg->b_cont = allocb(dlen, BPRI_MED)) == NULL) {
 996                 freemsg(dmsg);
 997                 return DECOMP_ERROR;
 998             }
 999             dmsg = dmsg->b_cont;
1000             wptr = dmsg->b_wptr;
1001             space = dmsg->b_datap->db_lim - wptr - codelen - extra;
1002         }
1003         p = (wptr += codelen);
1004         while (finchar > LAST) {
1005             dictp = &db->dict[db->dict[finchar].cptr];
1006 #ifdef DEBUG
1007             --codelen;
1008             if (codelen <= 0) {
1009                 freemsg(dmsg);
1010                 printf("bsd_decomp%d: fell off end of chain ", db->unit);
1011                 printf("0x%x at 0x%x by 0x%x, max_ent=0x%x\n",
1012                        incode, finchar, db->dict[finchar].cptr, max_ent);
1013                 return DECOMP_FATALERROR;
1014             }
1015             if (dictp->codem1 != finchar-1) {
1016                 freemsg(dmsg);
1017                 printf("bsd_decomp%d: bad code chain 0x%x finchar=0x%x ",
1018                        db->unit, incode, finchar);
1019                 printf("oldcode=0x%x cptr=0x%x codem1=0x%x\n", oldcode,
1020                        db->dict[finchar].cptr, dictp->codem1);
1021                 return DECOMP_FATALERROR;
1022             }
1023 #endif
1024             *--p = dictp->f.hs.suffix;
1025             finchar = dictp->f.hs.prefix;
1026         }
1027         *--p = finchar;
1028
1029 #ifdef DEBUG
1030         if (--codelen != 0)
1031             printf("bsd_decomp%d: short by %d after code 0x%x, max_ent=0x%x\n",
1032                    db->unit, codelen, incode, max_ent);
1033 #endif
1034
1035         if (extra)              /* the KwKwK case again */
1036             *wptr++ = finchar;
1037
1038         /*
1039          * If not first code in a packet, and
1040          * if not out of code space, then allocate a new code.
1041          *
1042          * Keep the hash table correct so it can be used
1043          * with uncompressed packets.
1044          */
1045         if (oldcode != CLEAR && max_ent < db->maxmaxcode) {
1046             struct bsd_dict *dictp2;
1047             u_int32_t fcode;
1048             int hval, disp;
1049
1050             fcode = BSD_KEY(oldcode,finchar);
1051             hval = BSD_HASH(oldcode,finchar,db->hshift);
1052             dictp = &db->dict[hval];
1053
1054             /* look for a free hash table entry */
1055             if (dictp->codem1 < max_ent) {
1056                 disp = (hval == 0) ? 1 : hval;
1057                 do {
1058                     hval += disp;
1059                     if (hval >= db->hsize)
1060                         hval -= db->hsize;
1061                     dictp = &db->dict[hval];
1062                 } while (dictp->codem1 < max_ent);
1063             }
1064
1065             /*
1066              * Invalidate previous hash table entry
1067              * assigned this code, and then take it over
1068              */
1069             dictp2 = &db->dict[max_ent+1];
1070             if (db->dict[dictp2->cptr].codem1 == max_ent) {
1071                 db->dict[dictp2->cptr].codem1 = BADCODEM1;
1072             }
1073             dictp2->cptr = hval;
1074             dictp->codem1 = max_ent;
1075             dictp->f.fcode = fcode;
1076
1077             db->max_ent = ++max_ent;
1078             db->lens[max_ent] = db->lens[oldcode]+1;
1079
1080             /* Expand code size if needed. */
1081             if (max_ent >= MAXCODE(n_bits) && max_ent < db->maxmaxcode) {
1082                 db->n_bits = ++n_bits;
1083                 tgtbitno = 32-n_bits;
1084             }
1085         }
1086         oldcode = incode;
1087     }
1088     dmsg->b_wptr = wptr;
1089
1090     /*
1091      * Keep the checkpoint right so that incompressible packets
1092      * clear the dictionary at the right times.
1093      */
1094     db->bytes_out += ilen;
1095     db->in_count += explen;
1096     if (bsd_check(db) && db->debug) {
1097         printf("bsd_decomp%d: peer should have cleared dictionary\n",
1098                db->unit);
1099     }
1100
1101     ++db->comp_count;
1102     db->comp_bytes += ilen + BSD_OVHD;
1103     ++db->uncomp_count;
1104     db->uncomp_bytes += explen;
1105
1106     *dmpp = mret;
1107     return DECOMP_OK;
1108 }
1109 #endif /* DO_BSD_COMPRESS */