Chris@43: /* enough.c -- determine the maximum size of inflate's Huffman code tables over
Chris@43:  * all possible valid and complete Huffman codes, subject to a length limit.
Chris@43:  * Copyright (C) 2007, 2008, 2012 Mark Adler
Chris@43:  * Version 1.4  18 August 2012  Mark Adler
Chris@43:  */
Chris@43: 
Chris@43: /* Version history:
Chris@43:    1.0   3 Jan 2007  First version (derived from codecount.c version 1.4)
Chris@43:    1.1   4 Jan 2007  Use faster incremental table usage computation
Chris@43:                      Prune examine() search on previously visited states
Chris@43:    1.2   5 Jan 2007  Comments clean up
Chris@43:                      As inflate does, decrease root for short codes
Chris@43:                      Refuse cases where inflate would increase root
Chris@43:    1.3  17 Feb 2008  Add argument for initial root table size
Chris@43:                      Fix bug for initial root table size == max - 1
Chris@43:                      Use a macro to compute the history index
Chris@43:    1.4  18 Aug 2012  Avoid shifts more than bits in type (caused endless loop!)
Chris@43:                      Clean up comparisons of different types
Chris@43:                      Clean up code indentation
Chris@43:  */
Chris@43: 
Chris@43: /*
Chris@43:    Examine all possible Huffman codes for a given number of symbols and a
Chris@43:    maximum code length in bits to determine the maximum table size for zilb's
Chris@43:    inflate.  Only complete Huffman codes are counted.
Chris@43: 
Chris@43:    Two codes are considered distinct if the vectors of the number of codes per
Chris@43:    length are not identical.  So permutations of the symbol assignments result
Chris@43:    in the same code for the counting, as do permutations of the assignments of
Chris@43:    the bit values to the codes (i.e. only canonical codes are counted).
Chris@43: 
Chris@43:    We build a code from shorter to longer lengths, determining how many symbols
Chris@43:    are coded at each length.  At each step, we have how many symbols remain to
Chris@43:    be coded, what the last code length used was, and how many bit patterns of
Chris@43:    that length remain unused. Then we add one to the code length and double the
Chris@43:    number of unused patterns to graduate to the next code length.  We then
Chris@43:    assign all portions of the remaining symbols to that code length that
Chris@43:    preserve the properties of a correct and eventually complete code.  Those
Chris@43:    properties are: we cannot use more bit patterns than are available; and when
Chris@43:    all the symbols are used, there are exactly zero possible bit patterns
Chris@43:    remaining.
Chris@43: 
Chris@43:    The inflate Huffman decoding algorithm uses two-level lookup tables for
Chris@43:    speed.  There is a single first-level table to decode codes up to root bits
Chris@43:    in length (root == 9 in the current inflate implementation).  The table
Chris@43:    has 1 << root entries and is indexed by the next root bits of input.  Codes
Chris@43:    shorter than root bits have replicated table entries, so that the correct
Chris@43:    entry is pointed to regardless of the bits that follow the short code.  If
Chris@43:    the code is longer than root bits, then the table entry points to a second-
Chris@43:    level table.  The size of that table is determined by the longest code with
Chris@43:    that root-bit prefix.  If that longest code has length len, then the table
Chris@43:    has size 1 << (len - root), to index the remaining bits in that set of
Chris@43:    codes.  Each subsequent root-bit prefix then has its own sub-table.  The
Chris@43:    total number of table entries required by the code is calculated
Chris@43:    incrementally as the number of codes at each bit length is populated.  When
Chris@43:    all of the codes are shorter than root bits, then root is reduced to the
Chris@43:    longest code length, resulting in a single, smaller, one-level table.
Chris@43: 
Chris@43:    The inflate algorithm also provides for small values of root (relative to
Chris@43:    the log2 of the number of symbols), where the shortest code has more bits
Chris@43:    than root.  In that case, root is increased to the length of the shortest
Chris@43:    code.  This program, by design, does not handle that case, so it is verified
Chris@43:    that the number of symbols is less than 2^(root + 1).
Chris@43: 
Chris@43:    In order to speed up the examination (by about ten orders of magnitude for
Chris@43:    the default arguments), the intermediate states in the build-up of a code
Chris@43:    are remembered and previously visited branches are pruned.  The memory
Chris@43:    required for this will increase rapidly with the total number of symbols and
Chris@43:    the maximum code length in bits.  However this is a very small price to pay
Chris@43:    for the vast speedup.
Chris@43: 
Chris@43:    First, all of the possible Huffman codes are counted, and reachable
Chris@43:    intermediate states are noted by a non-zero count in a saved-results array.
Chris@43:    Second, the intermediate states that lead to (root + 1) bit or longer codes
Chris@43:    are used to look at all sub-codes from those junctures for their inflate
Chris@43:    memory usage.  (The amount of memory used is not affected by the number of
Chris@43:    codes of root bits or less in length.)  Third, the visited states in the
Chris@43:    construction of those sub-codes and the associated calculation of the table
Chris@43:    size is recalled in order to avoid recalculating from the same juncture.
Chris@43:    Beginning the code examination at (root + 1) bit codes, which is enabled by
Chris@43:    identifying the reachable nodes, accounts for about six of the orders of
Chris@43:    magnitude of improvement for the default arguments.  About another four
Chris@43:    orders of magnitude come from not revisiting previous states.  Out of
Chris@43:    approximately 2x10^16 possible Huffman codes, only about 2x10^6 sub-codes
Chris@43:    need to be examined to cover all of the possible table memory usage cases
Chris@43:    for the default arguments of 286 symbols limited to 15-bit codes.
Chris@43: 
Chris@43:    Note that an unsigned long long type is used for counting.  It is quite easy
Chris@43:    to exceed the capacity of an eight-byte integer with a large number of
Chris@43:    symbols and a large maximum code length, so multiple-precision arithmetic
Chris@43:    would need to replace the unsigned long long arithmetic in that case.  This
Chris@43:    program will abort if an overflow occurs.  The big_t type identifies where
Chris@43:    the counting takes place.
Chris@43: 
Chris@43:    An unsigned long long type is also used for calculating the number of
Chris@43:    possible codes remaining at the maximum length.  This limits the maximum
Chris@43:    code length to the number of bits in a long long minus the number of bits
Chris@43:    needed to represent the symbols in a flat code.  The code_t type identifies
Chris@43:    where the bit pattern counting takes place.
Chris@43:  */
Chris@43: 
Chris@43: #include <stdio.h>
Chris@43: #include <stdlib.h>
Chris@43: #include <string.h>
Chris@43: #include <assert.h>
Chris@43: 
Chris@43: #define local static
Chris@43: 
Chris@43: /* special data types */
Chris@43: typedef unsigned long long big_t;   /* type for code counting */
Chris@43: typedef unsigned long long code_t;  /* type for bit pattern counting */
Chris@43: struct tab {                        /* type for been here check */
Chris@43:     size_t len;         /* length of bit vector in char's */
Chris@43:     char *vec;          /* allocated bit vector */
Chris@43: };
Chris@43: 
Chris@43: /* The array for saving results, num[], is indexed with this triplet:
Chris@43: 
Chris@43:       syms: number of symbols remaining to code
Chris@43:       left: number of available bit patterns at length len
Chris@43:       len: number of bits in the codes currently being assigned
Chris@43: 
Chris@43:    Those indices are constrained thusly when saving results:
Chris@43: 
Chris@43:       syms: 3..totsym (totsym == total symbols to code)
Chris@43:       left: 2..syms - 1, but only the evens (so syms == 8 -> 2, 4, 6)
Chris@43:       len: 1..max - 1 (max == maximum code length in bits)
Chris@43: 
Chris@43:    syms == 2 is not saved since that immediately leads to a single code.  left
Chris@43:    must be even, since it represents the number of available bit patterns at
Chris@43:    the current length, which is double the number at the previous length.
Chris@43:    left ends at syms-1 since left == syms immediately results in a single code.
Chris@43:    (left > sym is not allowed since that would result in an incomplete code.)
Chris@43:    len is less than max, since the code completes immediately when len == max.
Chris@43: 
Chris@43:    The offset into the array is calculated for the three indices with the
Chris@43:    first one (syms) being outermost, and the last one (len) being innermost.
Chris@43:    We build the array with length max-1 lists for the len index, with syms-3
Chris@43:    of those for each symbol.  There are totsym-2 of those, with each one
Chris@43:    varying in length as a function of sym.  See the calculation of index in
Chris@43:    count() for the index, and the calculation of size in main() for the size
Chris@43:    of the array.
Chris@43: 
Chris@43:    For the deflate example of 286 symbols limited to 15-bit codes, the array
Chris@43:    has 284,284 entries, taking up 2.17 MB for an 8-byte big_t.  More than
Chris@43:    half of the space allocated for saved results is actually used -- not all
Chris@43:    possible triplets are reached in the generation of valid Huffman codes.
Chris@43:  */
Chris@43: 
Chris@43: /* The array for tracking visited states, done[], is itself indexed identically
Chris@43:    to the num[] array as described above for the (syms, left, len) triplet.
Chris@43:    Each element in the array is further indexed by the (mem, rem) doublet,
Chris@43:    where mem is the amount of inflate table space used so far, and rem is the
Chris@43:    remaining unused entries in the current inflate sub-table.  Each indexed
Chris@43:    element is simply one bit indicating whether the state has been visited or
Chris@43:    not.  Since the ranges for mem and rem are not known a priori, each bit
Chris@43:    vector is of a variable size, and grows as needed to accommodate the visited
Chris@43:    states.  mem and rem are used to calculate a single index in a triangular
Chris@43:    array.  Since the range of mem is expected in the default case to be about
Chris@43:    ten times larger than the range of rem, the array is skewed to reduce the
Chris@43:    memory usage, with eight times the range for mem than for rem.  See the
Chris@43:    calculations for offset and bit in beenhere() for the details.
Chris@43: 
Chris@43:    For the deflate example of 286 symbols limited to 15-bit codes, the bit
Chris@43:    vectors grow to total approximately 21 MB, in addition to the 4.3 MB done[]
Chris@43:    array itself.
Chris@43:  */
Chris@43: 
Chris@43: /* Globals to avoid propagating constants or constant pointers recursively */
Chris@43: local int max;          /* maximum allowed bit length for the codes */
Chris@43: local int root;         /* size of base code table in bits */
Chris@43: local int large;        /* largest code table so far */
Chris@43: local size_t size;      /* number of elements in num and done */
Chris@43: local int *code;        /* number of symbols assigned to each bit length */
Chris@43: local big_t *num;       /* saved results array for code counting */
Chris@43: local struct tab *done; /* states already evaluated array */
Chris@43: 
Chris@43: /* Index function for num[] and done[] */
Chris@43: #define INDEX(i,j,k) (((size_t)((i-1)>>1)*((i-2)>>1)+(j>>1)-1)*(max-1)+k-1)
Chris@43: 
Chris@43: /* Free allocated space.  Uses globals code, num, and done. */
Chris@43: local void cleanup(void)
Chris@43: {
Chris@43:     size_t n;
Chris@43: 
Chris@43:     if (done != NULL) {
Chris@43:         for (n = 0; n < size; n++)
Chris@43:             if (done[n].len)
Chris@43:                 free(done[n].vec);
Chris@43:         free(done);
Chris@43:     }
Chris@43:     if (num != NULL)
Chris@43:         free(num);
Chris@43:     if (code != NULL)
Chris@43:         free(code);
Chris@43: }
Chris@43: 
Chris@43: /* Return the number of possible Huffman codes using bit patterns of lengths
Chris@43:    len through max inclusive, coding syms symbols, with left bit patterns of
Chris@43:    length len unused -- return -1 if there is an overflow in the counting.
Chris@43:    Keep a record of previous results in num to prevent repeating the same
Chris@43:    calculation.  Uses the globals max and num. */
Chris@43: local big_t count(int syms, int len, int left)
Chris@43: {
Chris@43:     big_t sum;          /* number of possible codes from this juncture */
Chris@43:     big_t got;          /* value returned from count() */
Chris@43:     int least;          /* least number of syms to use at this juncture */
Chris@43:     int most;           /* most number of syms to use at this juncture */
Chris@43:     int use;            /* number of bit patterns to use in next call */
Chris@43:     size_t index;       /* index of this case in *num */
Chris@43: 
Chris@43:     /* see if only one possible code */
Chris@43:     if (syms == left)
Chris@43:         return 1;
Chris@43: 
Chris@43:     /* note and verify the expected state */
Chris@43:     assert(syms > left && left > 0 && len < max);
Chris@43: 
Chris@43:     /* see if we've done this one already */
Chris@43:     index = INDEX(syms, left, len);
Chris@43:     got = num[index];
Chris@43:     if (got)
Chris@43:         return got;         /* we have -- return the saved result */
Chris@43: 
Chris@43:     /* we need to use at least this many bit patterns so that the code won't be
Chris@43:        incomplete at the next length (more bit patterns than symbols) */
Chris@43:     least = (left << 1) - syms;
Chris@43:     if (least < 0)
Chris@43:         least = 0;
Chris@43: 
Chris@43:     /* we can use at most this many bit patterns, lest there not be enough
Chris@43:        available for the remaining symbols at the maximum length (if there were
Chris@43:        no limit to the code length, this would become: most = left - 1) */
Chris@43:     most = (((code_t)left << (max - len)) - syms) /
Chris@43:             (((code_t)1 << (max - len)) - 1);
Chris@43: 
Chris@43:     /* count all possible codes from this juncture and add them up */
Chris@43:     sum = 0;
Chris@43:     for (use = least; use <= most; use++) {
Chris@43:         got = count(syms - use, len + 1, (left - use) << 1);
Chris@43:         sum += got;
Chris@43:         if (got == (big_t)0 - 1 || sum < got)   /* overflow */
Chris@43:             return (big_t)0 - 1;
Chris@43:     }
Chris@43: 
Chris@43:     /* verify that all recursive calls are productive */
Chris@43:     assert(sum != 0);
Chris@43: 
Chris@43:     /* save the result and return it */
Chris@43:     num[index] = sum;
Chris@43:     return sum;
Chris@43: }
Chris@43: 
Chris@43: /* Return true if we've been here before, set to true if not.  Set a bit in a
Chris@43:    bit vector to indicate visiting this state.  Each (syms,len,left) state
Chris@43:    has a variable size bit vector indexed by (mem,rem).  The bit vector is
Chris@43:    lengthened if needed to allow setting the (mem,rem) bit. */
Chris@43: local int beenhere(int syms, int len, int left, int mem, int rem)
Chris@43: {
Chris@43:     size_t index;       /* index for this state's bit vector */
Chris@43:     size_t offset;      /* offset in this state's bit vector */
Chris@43:     int bit;            /* mask for this state's bit */
Chris@43:     size_t length;      /* length of the bit vector in bytes */
Chris@43:     char *vector;       /* new or enlarged bit vector */
Chris@43: 
Chris@43:     /* point to vector for (syms,left,len), bit in vector for (mem,rem) */
Chris@43:     index = INDEX(syms, left, len);
Chris@43:     mem -= 1 << root;
Chris@43:     offset = (mem >> 3) + rem;
Chris@43:     offset = ((offset * (offset + 1)) >> 1) + rem;
Chris@43:     bit = 1 << (mem & 7);
Chris@43: 
Chris@43:     /* see if we've been here */
Chris@43:     length = done[index].len;
Chris@43:     if (offset < length && (done[index].vec[offset] & bit) != 0)
Chris@43:         return 1;       /* done this! */
Chris@43: 
Chris@43:     /* we haven't been here before -- set the bit to show we have now */
Chris@43: 
Chris@43:     /* see if we need to lengthen the vector in order to set the bit */
Chris@43:     if (length <= offset) {
Chris@43:         /* if we have one already, enlarge it, zero out the appended space */
Chris@43:         if (length) {
Chris@43:             do {
Chris@43:                 length <<= 1;
Chris@43:             } while (length <= offset);
Chris@43:             vector = realloc(done[index].vec, length);
Chris@43:             if (vector != NULL)
Chris@43:                 memset(vector + done[index].len, 0, length - done[index].len);
Chris@43:         }
Chris@43: 
Chris@43:         /* otherwise we need to make a new vector and zero it out */
Chris@43:         else {
Chris@43:             length = 1 << (len - root);
Chris@43:             while (length <= offset)
Chris@43:                 length <<= 1;
Chris@43:             vector = calloc(length, sizeof(char));
Chris@43:         }
Chris@43: 
Chris@43:         /* in either case, bail if we can't get the memory */
Chris@43:         if (vector == NULL) {
Chris@43:             fputs("abort: unable to allocate enough memory\n", stderr);
Chris@43:             cleanup();
Chris@43:             exit(1);
Chris@43:         }
Chris@43: 
Chris@43:         /* install the new vector */
Chris@43:         done[index].len = length;
Chris@43:         done[index].vec = vector;
Chris@43:     }
Chris@43: 
Chris@43:     /* set the bit */
Chris@43:     done[index].vec[offset] |= bit;
Chris@43:     return 0;
Chris@43: }
Chris@43: 
Chris@43: /* Examine all possible codes from the given node (syms, len, left).  Compute
Chris@43:    the amount of memory required to build inflate's decoding tables, where the
Chris@43:    number of code structures used so far is mem, and the number remaining in
Chris@43:    the current sub-table is rem.  Uses the globals max, code, root, large, and
Chris@43:    done. */
Chris@43: local void examine(int syms, int len, int left, int mem, int rem)
Chris@43: {
Chris@43:     int least;          /* least number of syms to use at this juncture */
Chris@43:     int most;           /* most number of syms to use at this juncture */
Chris@43:     int use;            /* number of bit patterns to use in next call */
Chris@43: 
Chris@43:     /* see if we have a complete code */
Chris@43:     if (syms == left) {
Chris@43:         /* set the last code entry */
Chris@43:         code[len] = left;
Chris@43: 
Chris@43:         /* complete computation of memory used by this code */
Chris@43:         while (rem < left) {
Chris@43:             left -= rem;
Chris@43:             rem = 1 << (len - root);
Chris@43:             mem += rem;
Chris@43:         }
Chris@43:         assert(rem == left);
Chris@43: 
Chris@43:         /* if this is a new maximum, show the entries used and the sub-code */
Chris@43:         if (mem > large) {
Chris@43:             large = mem;
Chris@43:             printf("max %d: ", mem);
Chris@43:             for (use = root + 1; use <= max; use++)
Chris@43:                 if (code[use])
Chris@43:                     printf("%d[%d] ", code[use], use);
Chris@43:             putchar('\n');
Chris@43:             fflush(stdout);
Chris@43:         }
Chris@43: 
Chris@43:         /* remove entries as we drop back down in the recursion */
Chris@43:         code[len] = 0;
Chris@43:         return;
Chris@43:     }
Chris@43: 
Chris@43:     /* prune the tree if we can */
Chris@43:     if (beenhere(syms, len, left, mem, rem))
Chris@43:         return;
Chris@43: 
Chris@43:     /* we need to use at least this many bit patterns so that the code won't be
Chris@43:        incomplete at the next length (more bit patterns than symbols) */
Chris@43:     least = (left << 1) - syms;
Chris@43:     if (least < 0)
Chris@43:         least = 0;
Chris@43: 
Chris@43:     /* we can use at most this many bit patterns, lest there not be enough
Chris@43:        available for the remaining symbols at the maximum length (if there were
Chris@43:        no limit to the code length, this would become: most = left - 1) */
Chris@43:     most = (((code_t)left << (max - len)) - syms) /
Chris@43:             (((code_t)1 << (max - len)) - 1);
Chris@43: 
Chris@43:     /* occupy least table spaces, creating new sub-tables as needed */
Chris@43:     use = least;
Chris@43:     while (rem < use) {
Chris@43:         use -= rem;
Chris@43:         rem = 1 << (len - root);
Chris@43:         mem += rem;
Chris@43:     }
Chris@43:     rem -= use;
Chris@43: 
Chris@43:     /* examine codes from here, updating table space as we go */
Chris@43:     for (use = least; use <= most; use++) {
Chris@43:         code[len] = use;
Chris@43:         examine(syms - use, len + 1, (left - use) << 1,
Chris@43:                 mem + (rem ? 1 << (len - root) : 0), rem << 1);
Chris@43:         if (rem == 0) {
Chris@43:             rem = 1 << (len - root);
Chris@43:             mem += rem;
Chris@43:         }
Chris@43:         rem--;
Chris@43:     }
Chris@43: 
Chris@43:     /* remove entries as we drop back down in the recursion */
Chris@43:     code[len] = 0;
Chris@43: }
Chris@43: 
Chris@43: /* Look at all sub-codes starting with root + 1 bits.  Look at only the valid
Chris@43:    intermediate code states (syms, left, len).  For each completed code,
Chris@43:    calculate the amount of memory required by inflate to build the decoding
Chris@43:    tables. Find the maximum amount of memory required and show the code that
Chris@43:    requires that maximum.  Uses the globals max, root, and num. */
Chris@43: local void enough(int syms)
Chris@43: {
Chris@43:     int n;              /* number of remaing symbols for this node */
Chris@43:     int left;           /* number of unused bit patterns at this length */
Chris@43:     size_t index;       /* index of this case in *num */
Chris@43: 
Chris@43:     /* clear code */
Chris@43:     for (n = 0; n <= max; n++)
Chris@43:         code[n] = 0;
Chris@43: 
Chris@43:     /* look at all (root + 1) bit and longer codes */
Chris@43:     large = 1 << root;              /* base table */
Chris@43:     if (root < max)                 /* otherwise, there's only a base table */
Chris@43:         for (n = 3; n <= syms; n++)
Chris@43:             for (left = 2; left < n; left += 2)
Chris@43:             {
Chris@43:                 /* look at all reachable (root + 1) bit nodes, and the
Chris@43:                    resulting codes (complete at root + 2 or more) */
Chris@43:                 index = INDEX(n, left, root + 1);
Chris@43:                 if (root + 1 < max && num[index])       /* reachable node */
Chris@43:                     examine(n, root + 1, left, 1 << root, 0);
Chris@43: 
Chris@43:                 /* also look at root bit codes with completions at root + 1
Chris@43:                    bits (not saved in num, since complete), just in case */
Chris@43:                 if (num[index - 1] && n <= left << 1)
Chris@43:                     examine((n - left) << 1, root + 1, (n - left) << 1,
Chris@43:                             1 << root, 0);
Chris@43:             }
Chris@43: 
Chris@43:     /* done */
Chris@43:     printf("done: maximum of %d table entries\n", large);
Chris@43: }
Chris@43: 
Chris@43: /*
Chris@43:    Examine and show the total number of possible Huffman codes for a given
Chris@43:    maximum number of symbols, initial root table size, and maximum code length
Chris@43:    in bits -- those are the command arguments in that order.  The default
Chris@43:    values are 286, 9, and 15 respectively, for the deflate literal/length code.
Chris@43:    The possible codes are counted for each number of coded symbols from two to
Chris@43:    the maximum.  The counts for each of those and the total number of codes are
Chris@43:    shown.  The maximum number of inflate table entires is then calculated
Chris@43:    across all possible codes.  Each new maximum number of table entries and the
Chris@43:    associated sub-code (starting at root + 1 == 10 bits) is shown.
Chris@43: 
Chris@43:    To count and examine Huffman codes that are not length-limited, provide a
Chris@43:    maximum length equal to the number of symbols minus one.
Chris@43: 
Chris@43:    For the deflate literal/length code, use "enough".  For the deflate distance
Chris@43:    code, use "enough 30 6".
Chris@43: 
Chris@43:    This uses the %llu printf format to print big_t numbers, which assumes that
Chris@43:    big_t is an unsigned long long.  If the big_t type is changed (for example
Chris@43:    to a multiple precision type), the method of printing will also need to be
Chris@43:    updated.
Chris@43:  */
Chris@43: int main(int argc, char **argv)
Chris@43: {
Chris@43:     int syms;           /* total number of symbols to code */
Chris@43:     int n;              /* number of symbols to code for this run */
Chris@43:     big_t got;          /* return value of count() */
Chris@43:     big_t sum;          /* accumulated number of codes over n */
Chris@43:     code_t word;        /* for counting bits in code_t */
Chris@43: 
Chris@43:     /* set up globals for cleanup() */
Chris@43:     code = NULL;
Chris@43:     num = NULL;
Chris@43:     done = NULL;
Chris@43: 
Chris@43:     /* get arguments -- default to the deflate literal/length code */
Chris@43:     syms = 286;
Chris@43:     root = 9;
Chris@43:     max = 15;
Chris@43:     if (argc > 1) {
Chris@43:         syms = atoi(argv[1]);
Chris@43:         if (argc > 2) {
Chris@43:             root = atoi(argv[2]);
Chris@43:             if (argc > 3)
Chris@43:                 max = atoi(argv[3]);
Chris@43:         }
Chris@43:     }
Chris@43:     if (argc > 4 || syms < 2 || root < 1 || max < 1) {
Chris@43:         fputs("invalid arguments, need: [sym >= 2 [root >= 1 [max >= 1]]]\n",
Chris@43:               stderr);
Chris@43:         return 1;
Chris@43:     }
Chris@43: 
Chris@43:     /* if not restricting the code length, the longest is syms - 1 */
Chris@43:     if (max > syms - 1)
Chris@43:         max = syms - 1;
Chris@43: 
Chris@43:     /* determine the number of bits in a code_t */
Chris@43:     for (n = 0, word = 1; word; n++, word <<= 1)
Chris@43:         ;
Chris@43: 
Chris@43:     /* make sure that the calculation of most will not overflow */
Chris@43:     if (max > n || (code_t)(syms - 2) >= (((code_t)0 - 1) >> (max - 1))) {
Chris@43:         fputs("abort: code length too long for internal types\n", stderr);
Chris@43:         return 1;
Chris@43:     }
Chris@43: 
Chris@43:     /* reject impossible code requests */
Chris@43:     if ((code_t)(syms - 1) > ((code_t)1 << max) - 1) {
Chris@43:         fprintf(stderr, "%d symbols cannot be coded in %d bits\n",
Chris@43:                 syms, max);
Chris@43:         return 1;
Chris@43:     }
Chris@43: 
Chris@43:     /* allocate code vector */
Chris@43:     code = calloc(max + 1, sizeof(int));
Chris@43:     if (code == NULL) {
Chris@43:         fputs("abort: unable to allocate enough memory\n", stderr);
Chris@43:         return 1;
Chris@43:     }
Chris@43: 
Chris@43:     /* determine size of saved results array, checking for overflows,
Chris@43:        allocate and clear the array (set all to zero with calloc()) */
Chris@43:     if (syms == 2)              /* iff max == 1 */
Chris@43:         num = NULL;             /* won't be saving any results */
Chris@43:     else {
Chris@43:         size = syms >> 1;
Chris@43:         if (size > ((size_t)0 - 1) / (n = (syms - 1) >> 1) ||
Chris@43:                 (size *= n, size > ((size_t)0 - 1) / (n = max - 1)) ||
Chris@43:                 (size *= n, size > ((size_t)0 - 1) / sizeof(big_t)) ||
Chris@43:                 (num = calloc(size, sizeof(big_t))) == NULL) {
Chris@43:             fputs("abort: unable to allocate enough memory\n", stderr);
Chris@43:             cleanup();
Chris@43:             return 1;
Chris@43:         }
Chris@43:     }
Chris@43: 
Chris@43:     /* count possible codes for all numbers of symbols, add up counts */
Chris@43:     sum = 0;
Chris@43:     for (n = 2; n <= syms; n++) {
Chris@43:         got = count(n, 1, 2);
Chris@43:         sum += got;
Chris@43:         if (got == (big_t)0 - 1 || sum < got) {     /* overflow */
Chris@43:             fputs("abort: can't count that high!\n", stderr);
Chris@43:             cleanup();
Chris@43:             return 1;
Chris@43:         }
Chris@43:         printf("%llu %d-codes\n", got, n);
Chris@43:     }
Chris@43:     printf("%llu total codes for 2 to %d symbols", sum, syms);
Chris@43:     if (max < syms - 1)
Chris@43:         printf(" (%d-bit length limit)\n", max);
Chris@43:     else
Chris@43:         puts(" (no length limit)");
Chris@43: 
Chris@43:     /* allocate and clear done array for beenhere() */
Chris@43:     if (syms == 2)
Chris@43:         done = NULL;
Chris@43:     else if (size > ((size_t)0 - 1) / sizeof(struct tab) ||
Chris@43:              (done = calloc(size, sizeof(struct tab))) == NULL) {
Chris@43:         fputs("abort: unable to allocate enough memory\n", stderr);
Chris@43:         cleanup();
Chris@43:         return 1;
Chris@43:     }
Chris@43: 
Chris@43:     /* find and show maximum inflate table usage */
Chris@43:     if (root > max)                 /* reduce root to max length */
Chris@43:         root = max;
Chris@43:     if ((code_t)syms < ((code_t)1 << (root + 1)))
Chris@43:         enough(syms);
Chris@43:     else
Chris@43:         puts("cannot handle minimum code lengths > root");
Chris@43: 
Chris@43:     /* done */
Chris@43:     cleanup();
Chris@43:     return 0;
Chris@43: }