look for __sym__ as well as sym
[ppp.git] / modules / bsd-comp.c
index 85d3e54c76ec973d45a87e9c204e9e5b45f86aa7..58b067f4606c95c31f5a1f3737b5c6cc24500e93 100644 (file)
  */
 
 /*
- * This version is for use with STREAMS under SunOS 4.x.
+ * This version is for use with STREAMS under SunOS 4.x,
+ * DEC Alpha OSF/1, AIX 4.x, and SVR4 systems including Solaris 2.
  *
- * $Id: bsd-comp.c,v 1.5 1994/10/21 06:30:15 paulus Exp $
+ * $Id: bsd-comp.c,v 1.16 1995/10/27 03:35:49 paulus Exp $
  */
 
+#if defined(aix4) || defined(__aix4__)
+#include <net/net_globals.h>
+#endif
 #include <sys/param.h>
 #include <sys/types.h>
 #include <sys/stream.h>
-#include <sys/kmem_alloc.h>
 #include <sys/socket.h>
 #include <net/if.h>
 #include <net/ppp_defs.h>
 #include <net/ppp_str.h>
 
+#if defined(svr4) || defined(__svr4__)         /* SVR4, including SunOS 5.x */
+# include <sys/kmem.h>
+# define ALLOCATE(n)   kmem_alloc((n), KM_NOSLEEP)
+# define FREE(p, n)    kmem_free((p), (n))
+#else                          /* SunOS 4.x */
+# if defined(sun) || defined(__sun__)
+#  include <sys/kmem_alloc.h>
+#  define ALLOCATE(n)  kmem_alloc((n), KMEM_NOSLEEP)
+#  define FREE(p, n)   kmem_free((p), (n))
+# endif
+#endif
+
+#if defined(osf) || defined(__osf__)
+#include <kern/kalloc.h>
+#ifdef FIRST
+#undef FIRST
+#undef LAST
+#endif
+#ifdef FREE
+#undef FREE
+#endif
+#define ALLOCATE(n)    kalloc((n))
+#define FREE(p, n)     kfree((p), (n))
+#define BSD_LITTLE_ENDIAN
+#endif
+
+#if defined(aix4) || defined(__aix4__)
+#define ALLOCATE(n)    xmalloc((n), 0, pinned_heap)
+#define FREE(p, n)     xmfree((p), pinned_heap)
+#endif
+
 #define PACKETPTR      mblk_t *
 #include <net/ppp-comp.h>
 
+#if DO_BSD_COMPRESS
+
 /*
  * PPP "BSD compress" compression
  *  The differences between this compression and the classic BSD LZW
  *         compression is not going well.
  */
 
-/*
- * Macros to extract protocol version and number of bits
- * from the third byte of the BSD Compress CCP configuration option.
- */
-#define BSD_VERSION(x) ((x) >> 5)
-#define BSD_NBITS(x)   ((x) & 0x1F)
-
-#define BSD_CURRENT_VERSION    1
-
 /*
  * A dictionary for doing BSD compress.
  */
@@ -97,8 +124,9 @@ struct bsd_db {
     u_char  maxbits;
     u_char  debug;
     u_char  unit;
-    u_short mru;
     u_short seqno;                     /* sequence number of next packet */
+    u_int   hdrlen;                    /* header length to preallocate */
+    u_int   mru;
     u_int   maxmaxcode;                        /* largest valid code */
     u_int   max_ent;                   /* largest code in use */
     u_int   in_count;                  /* uncompressed bytes, aged */
@@ -134,17 +162,15 @@ struct bsd_db {
 };
 
 #define BSD_OVHD       2               /* BSD compress overhead/packet */
-#define MIN_BSD_BITS   9
-#define BSD_INIT_BITS  MIN_BSD_BITS
-#define MAX_BSD_BITS   15
+#define BSD_INIT_BITS  BSD_MIN_BITS
 
 static void    *bsd_comp_alloc __P((u_char *options, int opt_len));
 static void    *bsd_decomp_alloc __P((u_char *options, int opt_len));
 static void    bsd_free __P((void *state));
 static int     bsd_comp_init __P((void *state, u_char *options, int opt_len,
-                                  int unit, int debug));
+                                  int unit, int hdrlen, int debug));
 static int     bsd_decomp_init __P((void *state, u_char *options, int opt_len,
-                                    int unit, int mru, int debug));
+                                    int unit, int hdrlen, int mru, int debug));
 static int     bsd_compress __P((void *state, mblk_t **mret,
                                  mblk_t *mp, int slen, int maxolen));
 static void    bsd_incomp __P((void *state, mblk_t *dmsg));
@@ -156,7 +182,7 @@ static void bsd_comp_stats __P((void *state, struct compstat *stats));
  * Procedures exported to ppp_comp.c.
  */
 struct compressor ppp_bsd_compress = {
-    0x21,                      /* compress_proto */
+    CI_BSD_COMPRESS,           /* compress_proto */
     bsd_comp_alloc,            /* comp_alloc */
     bsd_free,                  /* comp_free */
     bsd_comp_init,             /* comp_init */
@@ -181,7 +207,7 @@ struct compressor ppp_bsd_compress = {
 #define LAST   255
 
 #define MAXCODE(b)     ((1 << (b)) - 1)
-#define BADCODEM1      MAXCODE(MAX_BSD_BITS);
+#define BADCODEM1      MAXCODE(BSD_MAX_BITS)
 
 #define BSD_HASH(prefix,suffix,hshift) ((((u_int32_t)(suffix)) << (hshift)) \
                                         ^ (u_int32_t)(prefix))
@@ -273,6 +299,7 @@ bsd_comp_stats(state, stats)
     struct compstat *stats;
 {
     struct bsd_db *db = (struct bsd_db *) state;
+    u_int out;
 
     stats->unc_bytes = db->uncomp_bytes;
     stats->unc_packets = db->uncomp_count;
@@ -280,9 +307,14 @@ bsd_comp_stats(state, stats)
     stats->comp_packets = db->comp_count;
     stats->inc_bytes = db->incomp_bytes;
     stats->inc_packets = db->incomp_count;
-    stats->ratio = (double) db->in_count;
-    if (db->bytes_out != 0)
-       stats->ratio /= db->bytes_out;
+    stats->ratio = db->in_count;
+    out = db->bytes_out;
+    if (stats->ratio <= 0x7fffff)
+       stats->ratio <<= 8;
+    else
+       out >>= 8;
+    if (out != 0)
+       stats->ratio /= out;
 }
 
 /*
@@ -311,7 +343,7 @@ bsd_alloc(options, opt_len, decomp)
     u_int newlen, hsize, hshift, maxmaxcode;
     struct bsd_db *db;
 
-    if (opt_len != 3 || options[0] != 0x21 || options[1] != 3
+    if (opt_len != 3 || options[0] != CI_BSD_COMPRESS || options[1] != 3
        || BSD_VERSION(options[2]) != BSD_CURRENT_VERSION)
        return NULL;
     bits = BSD_NBITS(options[2]);
@@ -345,7 +377,7 @@ bsd_alloc(options, opt_len, decomp)
 
     maxmaxcode = MAXCODE(bits);
     newlen = sizeof(*db) + (hsize-1) * (sizeof(db->dict[0]));
-    db = (struct bsd_db *) kmem_alloc(newlen, KMEM_NOSLEEP);
+    db = (struct bsd_db *) ALLOCATE(newlen);
     if (!db)
        return NULL;
     bzero(db, sizeof(*db) - sizeof(db->dict));
@@ -353,10 +385,9 @@ bsd_alloc(options, opt_len, decomp)
     if (!decomp) {
        db->lens = NULL;
     } else {
-       db->lens = (u_short *) kmem_alloc((maxmaxcode+1) * sizeof(db->lens[0]),
-                                         KMEM_NOSLEEP);
+       db->lens = (u_short *) ALLOCATE((maxmaxcode+1) * sizeof(db->lens[0]));
        if (!db->lens) {
-           kmem_free(db, newlen);
+           FREE(db, newlen);
            return NULL;
        }
     }
@@ -377,8 +408,8 @@ bsd_free(state)
     struct bsd_db *db = (struct bsd_db *) state;
 
     if (db->lens)
-       kmem_free(db->lens, (db->maxmaxcode+1) * sizeof(db->lens[0]));
-    kmem_free(db, db->totlen);
+       FREE(db->lens, (db->maxmaxcode+1) * sizeof(db->lens[0]));
+    FREE(db, db->totlen);
 }
 
 static void *
@@ -401,14 +432,14 @@ bsd_decomp_alloc(options, opt_len)
  * Initialize the database.
  */
 static int
-bsd_init(db, options, opt_len, unit, mru, debug, decomp)
+bsd_init(db, options, opt_len, unit, hdrlen, mru, debug, decomp)
     struct bsd_db *db;
     u_char *options;
-    int opt_len, unit, mru, debug, decomp;
+    int opt_len, unit, hdrlen, mru, debug, decomp;
 {
     int i;
 
-    if (opt_len != 3 || options[0] != 0x21 || options[1] != 3
+    if (opt_len != 3 || options[0] != CI_BSD_COMPRESS || options[1] != 3
        || BSD_VERSION(options[2]) != BSD_CURRENT_VERSION
        || BSD_NBITS(options[2]) != db->maxbits
        || decomp && db->lens == NULL)
@@ -426,42 +457,43 @@ bsd_init(db, options, opt_len, unit, mru, debug, decomp)
     }
 
     db->unit = unit;
+    db->hdrlen = hdrlen;
     db->mru = mru;
-    db->clear_count = -1;
     if (debug)
        db->debug = 1;
 
-    bsd_clear(db);
+    bsd_reset(db);
 
     return 1;
 }
 
 static int
-bsd_comp_init(state, options, opt_len, unit, debug)
+bsd_comp_init(state, options, opt_len, unit, hdrlen, debug)
     void *state;
     u_char *options;
-    int opt_len, unit, debug;
+    int opt_len, unit, hdrlen, debug;
 {
     return bsd_init((struct bsd_db *) state, options, opt_len,
-                   unit, 0, debug, 0);
+                   unit, hdrlen, 0, debug, 0);
 }
 
 static int
-bsd_decomp_init(state, options, opt_len, unit, mru, debug)
+bsd_decomp_init(state, options, opt_len, unit, hdrlen, mru, debug)
     void *state;
     u_char *options;
-    int opt_len, unit, mru, debug;
+    int opt_len, unit, hdrlen, mru, debug;
 {
     return bsd_init((struct bsd_db *) state, options, opt_len,
-                   unit, mru, debug, 1);
+                   unit, hdrlen, mru, debug, 1);
 }
 
 
-
 /*
  * compress a packet
  *     One change from the BSD compress command is that when the
  *     code size expands, we do not output a bunch of padding.
+ *
+ * N.B. at present, we ignore the hdrlen specified in the comp_init call.
  */
 static int                     /* new slen */
 bsd_compress(state, mretp, mp, slen, maxolen)
@@ -611,7 +643,7 @@ bsd_compress(state, mretp, mp, slen, maxolen)
            if (dictp->codem1 >= max_ent)
                goto nomatch;
        } while (dictp->f.fcode != fcode);
-       ent = dictp->codem1+1;          /* finally found (prefix,suffix) */
+       ent = dictp->codem1 + 1;        /* finally found (prefix,suffix) */
        continue;
 
     nomatch:
@@ -638,12 +670,15 @@ bsd_compress(state, mretp, mp, slen, maxolen)
        }
        ent = c;
     }
-    OUTPUT(ent);                       /* output the last code */
 
+    OUTPUT(ent);               /* output the last code */
     db->bytes_out += olen;
     db->in_count += ilen;
+    if (bitno < 32)
+       ++db->bytes_out;        /* count complete bytes */
+
     if (bsd_check(db))
-       OUTPUT(CLEAR);                  /* do not count the CLEAR */
+       OUTPUT(CLEAR);          /* do not count the CLEAR */
 
     /*
      * Pad dribble bits of last code with ones.
@@ -789,10 +824,10 @@ bsd_incomp(state, dmsg)
     db->in_count += ilen;
     (void)bsd_check(db);
 
-    ++db->comp_count;
-    db->comp_bytes += bitno / 8;
     ++db->incomp_count;
     db->incomp_bytes += ilen;
+    ++db->uncomp_count;
+    db->uncomp_bytes += ilen;
 
     /* Increase code size if we would have without the packet
      * boundary and as the decompressor will.
@@ -804,6 +839,19 @@ bsd_incomp(state, dmsg)
 
 /*
  * Decompress "BSD Compress"
+ *
+ * Because of patent problems, we return DECOMP_ERROR for errors
+ * found by inspecting the input data and for system problems, but
+ * DECOMP_FATALERROR for any errors which could possibly be said to
+ * be being detected "after" decompression.  For DECOMP_ERROR,
+ * we can issue a CCP reset-request; for DECOMP_FATALERROR, we may be
+ * infringing a patent of Motorola's if we do, so we take CCP down
+ * instead.
+ *
+ * Given that the frame has the correct sequence number and a good FCS,
+ * errors such as invalid codes in the input most likely indicate a
+ * bug, so we return DECOMP_FATALERROR for them in order to turn off
+ * compression, even though they are detected by inspecting the input.
  */
 static int
 bsd_decompress(state, cmsg, dmpp)
@@ -861,9 +909,10 @@ bsd_decompress(state, cmsg, dmpp)
     /*
      * Allocate one message block to start with.
      */
-    if ((dmsg = allocb(DECOMP_CHUNK, BPRI_MED)) == NULL)
+    if ((dmsg = allocb(DECOMP_CHUNK + db->hdrlen, BPRI_MED)) == NULL)
        return DECOMP_ERROR;
     mret = dmsg;
+    dmsg->b_wptr += db->hdrlen;
     dmsg->b_rptr = wptr = dmsg->b_wptr;
 
     /* Fill in the ppp header, but not the last byte of the protocol
@@ -883,6 +932,7 @@ bsd_decompress(state, cmsg, dmpp)
                break;
            rptr = cmsg->b_rptr;
            len = cmsg->b_wptr - rptr;
+           ilen += len;
            continue;           /* handle 0-length buffers */
        }
 
@@ -917,11 +967,11 @@ bsd_decompress(state, cmsg, dmpp)
                }
            }
            bsd_clear(db);
-           explen = 0;
+           explen = ilen = 0;
            break;
        }
 
-       if (incode > max_ent+2 || incode > db->maxmaxcode
+       if (incode > max_ent + 2 || incode > db->maxmaxcode
            || incode > max_ent && oldcode == CLEAR) {
            freemsg(dmsg);
            if (db->debug) {
@@ -930,7 +980,7 @@ bsd_decompress(state, cmsg, dmpp)
                printf("max_ent=0x%x dlen=%d seqno=%d\n",
                       max_ent, dlen, db->seqno);
            }
-           return DECOMP_FATALERROR;
+           return DECOMP_FATALERROR;   /* probably a bug */
        }
 
        /* Special case for KwKwK string. */
@@ -1075,3 +1125,4 @@ bsd_decompress(state, cmsg, dmpp)
     *dmpp = mret;
     return DECOMP_OK;
 }
+#endif /* DO_BSD_COMPRESS */