Coverage Report

Created: 2024-07-27 06:28

/src/zlib/inftrees.c
Line
Count
Source (jump to first uncovered line)
1
/* inftrees.c -- generate Huffman trees for efficient decoding
2
 * Copyright (C) 1995-2024 Mark Adler
3
 * For conditions of distribution and use, see copyright notice in zlib.h
4
 */
5
6
#include "zutil.h"
7
#include "inftrees.h"
8
9
5.96M
#define MAXBITS 15
10
11
const char inflate_copyright[] =
12
   " inflate 1.3.1.1 Copyright 1995-2024 Mark Adler ";
13
/*
14
  If you use the zlib library in a product, an acknowledgment is welcome
15
  in the documentation of your product. If for some reason you cannot
16
  include such an acknowledgment, I would appreciate that you keep this
17
  copyright string in the executable of your product.
18
 */
19
20
/*
21
   Build a set of tables to decode the provided canonical Huffman code.
22
   The code lengths are lens[0..codes-1].  The result starts at *table,
23
   whose indices are 0..2^bits-1.  work is a writable array of at least
24
   lens shorts, which is used as a work area.  type is the type of code
25
   to be generated, CODES, LENS, or DISTS.  On return, zero is success,
26
   -1 is an invalid code, and +1 means that ENOUGH isn't enough.  table
27
   on return points to the next available entry's address.  bits is the
28
   requested root table index bits, and on return it is the actual root
29
   table index bits.  It will differ if the request is greater than the
30
   longest code or if it is less than the shortest code.
31
 */
32
int ZLIB_INTERNAL inflate_table(codetype type, unsigned short FAR *lens,
33
                                unsigned codes, code FAR * FAR *table,
34
122k
                                unsigned FAR *bits, unsigned short FAR *work) {
35
122k
    unsigned len;               /* a code's length in bits */
36
122k
    unsigned sym;               /* index of code symbols */
37
122k
    unsigned min, max;          /* minimum and maximum code lengths */
38
122k
    unsigned root;              /* number of index bits for root table */
39
122k
    unsigned curr;              /* number of index bits for current table */
40
122k
    unsigned drop;              /* code bits to drop for sub-table */
41
122k
    int left;                   /* number of prefix codes available */
42
122k
    unsigned used;              /* code entries in table used */
43
122k
    unsigned huff;              /* Huffman code */
44
122k
    unsigned incr;              /* for incrementing code, index */
45
122k
    unsigned fill;              /* index for replicating entries */
46
122k
    unsigned low;               /* low bits for current root entry */
47
122k
    unsigned mask;              /* mask for low root bits */
48
122k
    code here;                  /* table entry for duplication */
49
122k
    code FAR *next;             /* next available space in table */
50
122k
    const unsigned short FAR *base;     /* base value table to use */
51
122k
    const unsigned short FAR *extra;    /* extra bits table to use */
52
122k
    unsigned match;             /* use base and extra for symbol >= match */
53
122k
    unsigned short count[MAXBITS+1];    /* number of codes of each length */
54
122k
    unsigned short offs[MAXBITS+1];     /* offsets in table for each length */
55
122k
    static const unsigned short lbase[31] = { /* Length codes 257..285 base */
56
122k
        3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 15, 17, 19, 23, 27, 31,
57
122k
        35, 43, 51, 59, 67, 83, 99, 115, 131, 163, 195, 227, 258, 0, 0};
58
122k
    static const unsigned short lext[31] = { /* Length codes 257..285 extra */
59
122k
        16, 16, 16, 16, 16, 16, 16, 16, 17, 17, 17, 17, 18, 18, 18, 18,
60
122k
        19, 19, 19, 19, 20, 20, 20, 20, 21, 21, 21, 21, 16, 73, 200};
61
122k
    static const unsigned short dbase[32] = { /* Distance codes 0..29 base */
62
122k
        1, 2, 3, 4, 5, 7, 9, 13, 17, 25, 33, 49, 65, 97, 129, 193,
63
122k
        257, 385, 513, 769, 1025, 1537, 2049, 3073, 4097, 6145,
64
122k
        8193, 12289, 16385, 24577, 0, 0};
65
122k
    static const unsigned short dext[32] = { /* Distance codes 0..29 extra */
66
122k
        16, 16, 16, 16, 17, 17, 18, 18, 19, 19, 20, 20, 21, 21, 22, 22,
67
122k
        23, 23, 24, 24, 25, 25, 26, 26, 27, 27,
68
122k
        28, 28, 29, 29, 64, 64};
69
70
    /*
71
       Process a set of code lengths to create a canonical Huffman code.  The
72
       code lengths are lens[0..codes-1].  Each length corresponds to the
73
       symbols 0..codes-1.  The Huffman code is generated by first sorting the
74
       symbols by length from short to long, and retaining the symbol order
75
       for codes with equal lengths.  Then the code starts with all zero bits
76
       for the first code of the shortest length, and the codes are integer
77
       increments for the same length, and zeros are appended as the length
78
       increases.  For the deflate format, these bits are stored backwards
79
       from their more natural integer increment ordering, and so when the
80
       decoding tables are built in the large loop below, the integer codes
81
       are incremented backwards.
82
83
       This routine assumes, but does not check, that all of the entries in
84
       lens[] are in the range 0..MAXBITS.  The caller must assure this.
85
       1..MAXBITS is interpreted as that code length.  zero means that that
86
       symbol does not occur in this code.
87
88
       The codes are sorted by computing a count of codes for each length,
89
       creating from that a table of starting indices for each length in the
90
       sorted table, and then entering the symbols in order in the sorted
91
       table.  The sorted table is work[], with that space being provided by
92
       the caller.
93
94
       The length counts are used for other purposes as well, i.e. finding
95
       the minimum and maximum length codes, determining if there are any
96
       codes at all, checking for a valid set of lengths, and looking ahead
97
       at length counts to determine sub-table sizes when building the
98
       decoding tables.
99
     */
100
101
    /* accumulate lengths for codes (assumes lens[] all in 0..MAXBITS) */
102
2.07M
    for (len = 0; len <= MAXBITS; len++)
103
1.95M
        count[len] = 0;
104
12.6M
    for (sym = 0; sym < codes; sym++)
105
12.5M
        count[lens[sym]]++;
106
107
    /* bound code lengths, force root to be within code lengths */
108
122k
    root = *bits;
109
1.24M
    for (max = MAXBITS; max >= 1; max--)
110
1.24M
        if (count[max] != 0) break;
111
122k
    if (root > max) root = max;
112
122k
    if (max == 0) {                     /* no symbols to code at all */
113
27
        here.op = (unsigned char)64;    /* invalid code marker */
114
27
        here.bits = (unsigned char)1;
115
27
        here.val = (unsigned short)0;
116
27
        *(*table)++ = here;             /* make a table to force an error */
117
27
        *(*table)++ = here;
118
27
        *bits = 1;
119
27
        return 0;     /* no symbols, but wait for decoding to report error */
120
27
    }
121
265k
    for (min = 1; min < max; min++)
122
264k
        if (count[min] != 0) break;
123
122k
    if (root < min) root = min;
124
125
    /* check for an over-subscribed or incomplete set of lengths */
126
122k
    left = 1;
127
1.94M
    for (len = 1; len <= MAXBITS; len++) {
128
1.82M
        left <<= 1;
129
1.82M
        left -= count[len];
130
1.82M
        if (left < 0) return -1;        /* over-subscribed */
131
1.82M
    }
132
121k
    if (left > 0 && (type == CODES || max != 1))
133
440
        return -1;                      /* incomplete set */
134
135
    /* generate offsets into symbol table for each length for sorting */
136
121k
    offs[1] = 0;
137
1.81M
    for (len = 1; len < MAXBITS; len++)
138
1.69M
        offs[len + 1] = offs[len] + count[len];
139
140
    /* sort symbols by length, by symbol order within each length */
141
12.5M
    for (sym = 0; sym < codes; sym++)
142
12.4M
        if (lens[sym] != 0) work[offs[lens[sym]]++] = (unsigned short)sym;
143
144
    /*
145
       Create and fill in decoding tables.  In this loop, the table being
146
       filled is at next and has curr index bits.  The code being used is huff
147
       with length len.  That code is converted to an index by dropping drop
148
       bits off of the bottom.  For codes where len is less than drop + curr,
149
       those top drop + curr - len bits are incremented through all values to
150
       fill the table with replicated entries.
151
152
       root is the number of index bits for the root table.  When len exceeds
153
       root, sub-tables are created pointed to by the root entry with an index
154
       of the low root bits of huff.  This is saved in low to check for when a
155
       new sub-table should be started.  drop is zero when the root table is
156
       being filled, and drop is root when sub-tables are being filled.
157
158
       When a new sub-table is needed, it is necessary to look ahead in the
159
       code lengths to determine what size sub-table is needed.  The length
160
       counts are used for this, and so count[] is decremented as codes are
161
       entered in the tables.
162
163
       used keeps track of how many table entries have been allocated from the
164
       provided *table space.  It is checked for LENS and DIST tables against
165
       the constants ENOUGH_LENS and ENOUGH_DISTS to guard against changes in
166
       the initial root table size constants.  See the comments in inftrees.h
167
       for more information.
168
169
       sym increments through all symbols, and the loop terminates when
170
       all codes of length max, i.e. all codes, have been processed.  This
171
       routine permits incomplete codes, so another loop after this one fills
172
       in the rest of the decoding tables with invalid code markers.
173
     */
174
175
    /* set up for code type */
176
121k
    switch (type) {
177
41.2k
    case CODES:
178
41.2k
        base = extra = work;    /* dummy value--not used */
179
41.2k
        match = 20;
180
41.2k
        break;
181
40.1k
    case LENS:
182
40.1k
        base = lbase;
183
40.1k
        extra = lext;
184
40.1k
        match = 257;
185
40.1k
        break;
186
39.9k
    default:    /* DISTS */
187
39.9k
        base = dbase;
188
39.9k
        extra = dext;
189
39.9k
        match = 0;
190
121k
    }
191
192
    /* initialize state for loop */
193
121k
    huff = 0;                   /* starting code */
194
121k
    sym = 0;                    /* starting code symbol */
195
121k
    len = min;                  /* starting code length */
196
121k
    next = *table;              /* current table to fill in */
197
121k
    curr = root;                /* current table index bits */
198
121k
    drop = 0;                   /* current bits to drop from code for index */
199
121k
    low = (unsigned)(-1);       /* trigger new sub-table when len > root */
200
121k
    used = 1U << root;          /* use root table entries */
201
121k
    mask = used - 1;            /* mask for comparing low */
202
203
    /* check available table space */
204
121k
    if ((type == LENS && used > ENOUGH_LENS) ||
205
121k
        (type == DISTS && used > ENOUGH_DISTS))
206
0
        return 1;
207
208
    /* process all codes and make table entries */
209
2.71M
    for (;;) {
210
        /* create table entry */
211
2.71M
        here.bits = (unsigned char)(len - drop);
212
2.71M
        if (work[sym] + 1U < match) {
213
1.94M
            here.op = (unsigned char)0;
214
1.94M
            here.val = work[sym];
215
1.94M
        }
216
778k
        else if (work[sym] >= match) {
217
738k
            here.op = (unsigned char)(extra[work[sym] - match]);
218
738k
            here.val = base[work[sym] - match];
219
738k
        }
220
40.1k
        else {
221
40.1k
            here.op = (unsigned char)(32 + 64);         /* end of block */
222
40.1k
            here.val = 0;
223
40.1k
        }
224
225
        /* replicate for those indices with low len bits equal to huff */
226
2.71M
        incr = 1U << (len - drop);
227
2.71M
        fill = 1U << curr;
228
2.71M
        min = fill;                 /* save offset to next table */
229
10.9M
        do {
230
10.9M
            fill -= incr;
231
10.9M
            next[(huff >> drop) + fill] = here;
232
10.9M
        } while (fill != 0);
233
234
        /* backwards increment the len-bit code huff */
235
2.71M
        incr = 1U << (len - 1);
236
5.31M
        while (huff & incr)
237
2.59M
            incr >>= 1;
238
2.71M
        if (incr != 0) {
239
2.59M
            huff &= incr - 1;
240
2.59M
            huff += incr;
241
2.59M
        }
242
121k
        else
243
121k
            huff = 0;
244
245
        /* go to next symbol, update count, len */
246
2.71M
        sym++;
247
2.71M
        if (--(count[len]) == 0) {
248
518k
            if (len == max) break;
249
397k
            len = lens[work[sym]];
250
397k
        }
251
252
        /* create new sub-table if needed */
253
2.59M
        if (len > root && (huff & mask) != low) {
254
            /* if first time, transition to sub-tables */
255
70.9k
            if (drop == 0)
256
11.7k
                drop = root;
257
258
            /* increment past last table */
259
70.9k
            next += min;            /* here min is 1 << curr */
260
261
            /* determine length of next table */
262
70.9k
            curr = len - drop;
263
70.9k
            left = (int)(1 << curr);
264
72.8k
            while (curr + drop < max) {
265
3.03k
                left -= count[curr + drop];
266
3.03k
                if (left <= 0) break;
267
1.92k
                curr++;
268
1.92k
                left <<= 1;
269
1.92k
            }
270
271
            /* check for enough space */
272
70.9k
            used += 1U << curr;
273
70.9k
            if ((type == LENS && used > ENOUGH_LENS) ||
274
70.9k
                (type == DISTS && used > ENOUGH_DISTS))
275
0
                return 1;
276
277
            /* point entry in root table to sub-table */
278
70.9k
            low = huff & mask;
279
70.9k
            (*table)[low].op = (unsigned char)curr;
280
70.9k
            (*table)[low].bits = (unsigned char)root;
281
70.9k
            (*table)[low].val = (unsigned short)(next - *table);
282
70.9k
        }
283
2.59M
    }
284
285
    /* fill in remaining table entry if code is incomplete (guaranteed to have
286
       at most one remaining entry, since if the code is incomplete, the
287
       maximum code length that was allowed to get this far is one bit) */
288
121k
    if (huff != 0) {
289
14
        here.op = (unsigned char)64;            /* invalid code marker */
290
14
        here.bits = (unsigned char)(len - drop);
291
14
        here.val = (unsigned short)0;
292
14
        next[huff] = here;
293
14
    }
294
295
    /* set return parameters */
296
121k
    *table += used;
297
121k
    *bits = root;
298
121k
    return 0;
299
121k
}