Coverage Report

Created: 2025-04-11 06:12

/src/zlib/gzread.c
Line
Count
Source (jump to first uncovered line)
1
/* gzread.c -- zlib functions for reading gzip files
2
 * Copyright (C) 2004-2017 Mark Adler
3
 * For conditions of distribution and use, see copyright notice in zlib.h
4
 */
5
6
#include "gzguts.h"
7
8
/* Use read() to load a buffer -- return -1 on error, otherwise 0.  Read from
9
   state->fd, and update state->eof, state->err, and state->msg as appropriate.
10
   This function needs to loop on read(), since read() is not guaranteed to
11
   read the number of bytes requested, depending on the type of descriptor. */
12
local int gz_load(gz_statep state, unsigned char *buf, unsigned len,
13
20.7k
                  unsigned *have) {
14
20.7k
    int ret;
15
20.7k
    unsigned get, max = ((unsigned)-1 >> 2) + 1;
16
17
20.7k
    *have = 0;
18
24.5k
    do {
19
24.5k
        get = len - *have;
20
24.5k
        if (get > max)
21
0
            get = max;
22
24.5k
        ret = read(state->fd, buf + *have, get);
23
24.5k
        if (ret <= 0)
24
3.92k
            break;
25
20.6k
        *have += (unsigned)ret;
26
20.6k
    } while (*have < len);
27
20.7k
    if (ret < 0) {
28
0
        gz_error(state, Z_ERRNO, zstrerror());
29
0
        return -1;
30
0
    }
31
20.7k
    if (ret == 0)
32
3.92k
        state->eof = 1;
33
20.7k
    return 0;
34
20.7k
}
35
36
/* Load up input buffer and set eof flag if last data loaded -- return -1 on
37
   error, 0 otherwise.  Note that the eof flag is set when the end of the input
38
   file is reached, even though there may be unused data in the buffer.  Once
39
   that data has been used, no more attempts will be made to read the file.
40
   If strm->avail_in != 0, then the current data is moved to the beginning of
41
   the input buffer, and then the remainder of the buffer is loaded with the
42
   available data from the input file. */
43
20.7k
local int gz_avail(gz_statep state) {
44
20.7k
    unsigned got;
45
20.7k
    z_streamp strm = &(state->strm);
46
47
20.7k
    if (state->err != Z_OK && state->err != Z_BUF_ERROR)
48
0
        return -1;
49
20.7k
    if (state->eof == 0) {
50
20.7k
        if (strm->avail_in) {       /* copy what's there to the start */
51
0
            unsigned char *p = state->in;
52
0
            unsigned const char *q = strm->next_in;
53
0
            unsigned n = strm->avail_in;
54
0
            do {
55
0
                *p++ = *q++;
56
0
            } while (--n);
57
0
        }
58
20.7k
        if (gz_load(state, state->in + strm->avail_in,
59
20.7k
                    state->size - strm->avail_in, &got) == -1)
60
0
            return -1;
61
20.7k
        strm->avail_in += got;
62
20.7k
        strm->next_in = state->in;
63
20.7k
    }
64
20.7k
    return 0;
65
20.7k
}
66
67
/* Look for gzip header, set up for inflate or copy.  state->x.have must be 0.
68
   If this is the first time in, allocate required memory.  state->how will be
69
   left unchanged if there is no more input data available, will be set to COPY
70
   if there is no gzip header and direct copying will be performed, or it will
71
   be set to GZIP for decompression.  If direct copying, then leftover input
72
   data from the input buffer will be copied to the output buffer.  In that
73
   case, all further file reads will be directly to either the output buffer or
74
   a user buffer.  If decompressing, the inflate state will be initialized.
75
   gz_look() will return 0 on success or -1 on failure. */
76
3.95k
local int gz_look(gz_statep state) {
77
3.95k
    z_streamp strm = &(state->strm);
78
79
    /* allocate read buffers and inflate memory */
80
3.95k
    if (state->size == 0) {
81
        /* allocate buffers */
82
3.92k
        state->in = (unsigned char *)malloc(state->want);
83
3.92k
        state->out = (unsigned char *)malloc(state->want << 1);
84
3.92k
        if (state->in == NULL || state->out == NULL) {
85
0
            free(state->out);
86
0
            free(state->in);
87
0
            gz_error(state, Z_MEM_ERROR, "out of memory");
88
0
            return -1;
89
0
        }
90
3.92k
        state->size = state->want;
91
92
        /* allocate inflate memory */
93
3.92k
        state->strm.zalloc = Z_NULL;
94
3.92k
        state->strm.zfree = Z_NULL;
95
3.92k
        state->strm.opaque = Z_NULL;
96
3.92k
        state->strm.avail_in = 0;
97
3.92k
        state->strm.next_in = Z_NULL;
98
3.92k
        if (inflateInit2(&(state->strm), 15 + 16) != Z_OK) {    /* gunzip */
99
0
            free(state->out);
100
0
            free(state->in);
101
0
            state->size = 0;
102
0
            gz_error(state, Z_MEM_ERROR, "out of memory");
103
0
            return -1;
104
0
        }
105
3.92k
    }
106
107
    /* get at least the magic bytes in the input buffer */
108
3.95k
    if (strm->avail_in < 2) {
109
3.95k
        if (gz_avail(state) == -1)
110
0
            return -1;
111
3.95k
        if (strm->avail_in == 0)
112
99
            return 0;
113
3.95k
    }
114
115
    /* look for gzip magic bytes -- if there, do gzip decoding (note: there is
116
       a logical dilemma here when considering the case of a partially written
117
       gzip file, to wit, if a single 31 byte is written, then we cannot tell
118
       whether this is a single-byte file, or just a partially written gzip
119
       file -- for here we assume that if a gzip file is being written, then
120
       the header will be written in a single operation, so that reading a
121
       single byte is sufficient indication that it is not a gzip file) */
122
3.86k
    if (strm->avail_in > 1 &&
123
3.86k
            strm->next_in[0] == 31 && strm->next_in[1] == 139) {
124
3.86k
        inflateReset(strm);
125
3.86k
        state->how = GZIP;
126
3.86k
        state->direct = 0;
127
3.86k
        return 0;
128
3.86k
    }
129
130
    /* no gzip header -- if we were decoding gzip before, then this is trailing
131
       garbage.  Ignore the trailing garbage and finish. */
132
0
    if (state->direct == 0) {
133
0
        strm->avail_in = 0;
134
0
        state->eof = 1;
135
0
        state->x.have = 0;
136
0
        return 0;
137
0
    }
138
139
    /* doing raw i/o, copy any leftover input to output -- this assumes that
140
       the output buffer is larger than the input buffer, which also assures
141
       space for gzungetc() */
142
0
    state->x.next = state->out;
143
0
    memcpy(state->x.next, strm->next_in, strm->avail_in);
144
0
    state->x.have = strm->avail_in;
145
0
    strm->avail_in = 0;
146
0
    state->how = COPY;
147
0
    state->direct = 1;
148
0
    return 0;
149
0
}
150
151
/* Decompress from input to the provided next_out and avail_out in the state.
152
   On return, state->x.have and state->x.next point to the just decompressed
153
   data.  If the gzip stream completes, state->how is reset to LOOK to look for
154
   the next gzip stream or raw data, once state->x.have is depleted.  Returns 0
155
   on success, -1 on failure. */
156
9.00k
local int gz_decomp(gz_statep state) {
157
9.00k
    int ret = Z_OK;
158
9.00k
    unsigned had;
159
9.00k
    z_streamp strm = &(state->strm);
160
161
    /* fill output buffer up to end of deflate stream */
162
9.00k
    had = strm->avail_out;
163
25.7k
    do {
164
        /* get more input for inflate() */
165
25.7k
        if (strm->avail_in == 0 && gz_avail(state) == -1)
166
0
            return -1;
167
25.7k
        if (strm->avail_in == 0) {
168
0
            gz_error(state, Z_BUF_ERROR, "unexpected end of file");
169
0
            break;
170
0
        }
171
172
        /* decompress and handle errors */
173
25.7k
        ret = inflate(strm, Z_NO_FLUSH);
174
25.7k
        if (ret == Z_STREAM_ERROR || ret == Z_NEED_DICT) {
175
0
            gz_error(state, Z_STREAM_ERROR,
176
0
                     "internal error: inflate stream corrupt");
177
0
            return -1;
178
0
        }
179
25.7k
        if (ret == Z_MEM_ERROR) {
180
0
            gz_error(state, Z_MEM_ERROR, "out of memory");
181
0
            return -1;
182
0
        }
183
25.7k
        if (ret == Z_DATA_ERROR) {              /* deflate stream invalid */
184
0
            gz_error(state, Z_DATA_ERROR,
185
0
                     strm->msg == NULL ? "compressed data error" : strm->msg);
186
0
            return -1;
187
0
        }
188
25.7k
    } while (strm->avail_out && ret != Z_STREAM_END);
189
190
    /* update available output */
191
9.00k
    state->x.have = had - strm->avail_out;
192
9.00k
    state->x.next = strm->next_out - state->x.have;
193
194
    /* if the gzip stream completed successfully, look for another */
195
9.00k
    if (ret == Z_STREAM_END)
196
3.86k
        state->how = LOOK;
197
198
    /* good decompression */
199
9.00k
    return 0;
200
9.00k
}
201
202
/* Fetch data and put it in the output buffer.  Assumes state->x.have is 0.
203
   Data is either copied from the input file or decompressed from the input
204
   file depending on state->how.  If state->how is LOOK, then a gzip header is
205
   looked for to determine whether to copy or decompress.  Returns -1 on error,
206
   otherwise 0.  gz_fetch() will leave state->how as COPY or GZIP unless the
207
   end of the input file has been reached and all data has been processed.  */
208
3.93k
local int gz_fetch(gz_statep state) {
209
3.93k
    z_streamp strm = &(state->strm);
210
211
7.79k
    do {
212
7.79k
        switch(state->how) {
213
3.93k
        case LOOK:      /* -> LOOK, COPY (only if never GZIP), or GZIP */
214
3.93k
            if (gz_look(state) == -1)
215
0
                return -1;
216
3.93k
            if (state->how == LOOK)
217
70
                return 0;
218
3.86k
            break;
219
3.86k
        case COPY:      /* -> COPY */
220
0
            if (gz_load(state, state->out, state->size << 1, &(state->x.have))
221
0
                    == -1)
222
0
                return -1;
223
0
            state->x.next = state->out;
224
0
            return 0;
225
3.86k
        case GZIP:      /* -> GZIP or LOOK (if end of gzip stream) */
226
3.86k
            strm->avail_out = state->size << 1;
227
3.86k
            strm->next_out = state->out;
228
3.86k
            if (gz_decomp(state) == -1)
229
0
                return -1;
230
7.79k
        }
231
7.79k
    } while (state->x.have == 0 && (!state->eof || strm->avail_in));
232
3.86k
    return 0;
233
3.93k
}
234
235
/* Skip len uncompressed bytes of output.  Return -1 on error, 0 on success. */
236
8
local int gz_skip(gz_statep state, z_off64_t len) {
237
8
    unsigned n;
238
239
    /* skip over len bytes or reach end-of-file, whichever comes first */
240
15
    while (len)
241
        /* skip over whatever is in output buffer */
242
15
        if (state->x.have) {
243
0
            n = GT_OFF(state->x.have) || (z_off64_t)state->x.have > len ?
244
0
                (unsigned)len : state->x.have;
245
0
            state->x.have -= n;
246
0
            state->x.next += n;
247
0
            state->x.pos += n;
248
0
            len -= n;
249
0
        }
250
251
        /* output buffer empty -- return if we're at the end of the input */
252
15
        else if (state->eof && state->strm.avail_in == 0)
253
8
            break;
254
255
        /* need more data to skip -- load up output buffer */
256
7
        else {
257
            /* get more output, looking for header if required */
258
7
            if (gz_fetch(state) == -1)
259
0
                return -1;
260
7
        }
261
8
    return 0;
262
8
}
263
264
/* Read len bytes into buf from file, or less than len up to the end of the
265
   input.  Return the number of bytes read.  If zero is returned, either the
266
   end of file was reached, or there was an error.  state->err must be
267
   consulted in that case to determine which. */
268
11.5k
local z_size_t gz_read(gz_statep state, voidp buf, z_size_t len) {
269
11.5k
    z_size_t got;
270
11.5k
    unsigned n;
271
272
    /* if len is zero, avoid unnecessary operations */
273
11.5k
    if (len == 0)
274
0
        return 0;
275
276
    /* process a skip request */
277
11.5k
    if (state->seek) {
278
4
        state->seek = 0;
279
4
        if (gz_skip(state, state->skip) == -1)
280
0
            return 0;
281
4
    }
282
283
    /* get len bytes to buf, or less than len if at the end */
284
11.5k
    got = 0;
285
20.6k
    do {
286
        /* set n to the maximum amount of len that fits in an unsigned int */
287
20.6k
        n = (unsigned)-1;
288
20.6k
        if (n > len)
289
20.6k
            n = (unsigned)len;
290
291
        /* first just try copying data from the output buffer */
292
20.6k
        if (state->x.have) {
293
3.86k
            if (state->x.have < n)
294
3.86k
                n = state->x.have;
295
3.86k
            memcpy(buf, state->x.next, n);
296
3.86k
            state->x.next += n;
297
3.86k
            state->x.have -= n;
298
3.86k
        }
299
300
        /* output buffer empty -- return if we're at the end of the input */
301
16.8k
        else if (state->eof && state->strm.avail_in == 0) {
302
7.75k
            state->past = 1;        /* tried to read past end */
303
7.75k
            break;
304
7.75k
        }
305
306
        /* need output data -- for small len or new stream load up our output
307
           buffer */
308
9.05k
        else if (state->how == LOOK || n < (state->size << 1)) {
309
            /* get more output, looking for header if required */
310
3.91k
            if (gz_fetch(state) == -1)
311
0
                return 0;
312
3.91k
            continue;       /* no progress yet -- go back to copy above */
313
            /* the copy above assures that we will leave with space in the
314
               output buffer, allowing at least one gzungetc() to succeed */
315
3.91k
        }
316
317
        /* large len -- read directly into user buffer */
318
5.14k
        else if (state->how == COPY) {      /* read directly */
319
0
            if (gz_load(state, (unsigned char *)buf, n, &n) == -1)
320
0
                return 0;
321
0
        }
322
323
        /* large len -- decompress directly into user buffer */
324
5.14k
        else {  /* state->how == GZIP */
325
5.14k
            state->strm.avail_out = n;
326
5.14k
            state->strm.next_out = (unsigned char *)buf;
327
5.14k
            if (gz_decomp(state) == -1)
328
0
                return 0;
329
5.14k
            n = state->x.have;
330
5.14k
            state->x.have = 0;
331
5.14k
        }
332
333
        /* update progress */
334
9.01k
        len -= n;
335
9.01k
        buf = (char *)buf + n;
336
9.01k
        got += n;
337
9.01k
        state->x.pos += n;
338
12.9k
    } while (len);
339
340
    /* return number of bytes read into user buffer */
341
11.5k
    return got;
342
11.5k
}
343
344
/* -- see zlib.h -- */
345
11.5k
int ZEXPORT gzread(gzFile file, voidp buf, unsigned len) {
346
11.5k
    gz_statep state;
347
348
    /* get internal structure */
349
11.5k
    if (file == NULL)
350
9
        return -1;
351
11.5k
    state = (gz_statep)file;
352
353
    /* check that we're reading and that there's no (serious) error */
354
11.5k
    if (state->mode != GZ_READ ||
355
11.5k
            (state->err != Z_OK && state->err != Z_BUF_ERROR))
356
6
        return -1;
357
358
    /* since an int is returned, make sure len fits in one, otherwise return
359
       with an error (this avoids a flaw in the interface) */
360
11.5k
    if ((int)len < 0) {
361
0
        gz_error(state, Z_STREAM_ERROR, "request does not fit in an int");
362
0
        return -1;
363
0
    }
364
365
    /* read len or fewer bytes to buf */
366
11.5k
    len = (unsigned)gz_read(state, buf, len);
367
368
    /* check for an error */
369
11.5k
    if (len == 0 && state->err != Z_OK && state->err != Z_BUF_ERROR)
370
0
        return -1;
371
372
    /* return the number of bytes read (this is assured to fit in an int) */
373
11.5k
    return (int)len;
374
11.5k
}
375
376
/* -- see zlib.h -- */
377
z_size_t ZEXPORT gzfread(voidp buf, z_size_t size, z_size_t nitems,
378
0
                         gzFile file) {
379
0
    z_size_t len;
380
0
    gz_statep state;
381
382
    /* get internal structure */
383
0
    if (file == NULL)
384
0
        return 0;
385
0
    state = (gz_statep)file;
386
387
    /* check that we're reading and that there's no (serious) error */
388
0
    if (state->mode != GZ_READ ||
389
0
            (state->err != Z_OK && state->err != Z_BUF_ERROR))
390
0
        return 0;
391
392
    /* compute bytes to read -- error on overflow */
393
0
    len = nitems * size;
394
0
    if (size && len / size != nitems) {
395
0
        gz_error(state, Z_STREAM_ERROR, "request does not fit in a size_t");
396
0
        return 0;
397
0
    }
398
399
    /* read len or fewer bytes to buf, return the number of full items read */
400
0
    return len ? gz_read(state, buf, len) / size : 0;
401
0
}
402
403
/* -- see zlib.h -- */
404
#ifdef Z_PREFIX_SET
405
#  undef z_gzgetc
406
#else
407
#  undef gzgetc
408
#endif
409
74
int ZEXPORT gzgetc(gzFile file) {
410
74
    unsigned char buf[1];
411
74
    gz_statep state;
412
413
    /* get internal structure */
414
74
    if (file == NULL)
415
36
        return -1;
416
38
    state = (gz_statep)file;
417
418
    /* check that we're reading and that there's no (serious) error */
419
38
    if (state->mode != GZ_READ ||
420
38
        (state->err != Z_OK && state->err != Z_BUF_ERROR))
421
32
        return -1;
422
423
    /* try output buffer (no need to check for skip request) */
424
6
    if (state->x.have) {
425
1
        state->x.have--;
426
1
        state->x.pos++;
427
1
        return *(state->x.next)++;
428
1
    }
429
430
    /* nothing there -- try gz_read() */
431
5
    return gz_read(state, buf, 1) < 1 ? -1 : buf[0];
432
6
}
433
434
0
int ZEXPORT gzgetc_(gzFile file) {
435
0
    return gzgetc(file);
436
0
}
437
438
/* -- see zlib.h -- */
439
54
int ZEXPORT gzungetc(int c, gzFile file) {
440
54
    gz_statep state;
441
442
    /* get internal structure */
443
54
    if (file == NULL)
444
19
        return -1;
445
35
    state = (gz_statep)file;
446
447
    /* in case this was just opened, set up the input buffer */
448
35
    if (state->mode == GZ_READ && state->how == LOOK && state->x.have == 0)
449
25
        (void)gz_look(state);
450
451
    /* check that we're reading and that there's no (serious) error */
452
35
    if (state->mode != GZ_READ ||
453
35
        (state->err != Z_OK && state->err != Z_BUF_ERROR))
454
4
        return -1;
455
456
    /* process a skip request */
457
31
    if (state->seek) {
458
1
        state->seek = 0;
459
1
        if (gz_skip(state, state->skip) == -1)
460
0
            return -1;
461
1
    }
462
463
    /* can't push EOF */
464
31
    if (c < 0)
465
5
        return -1;
466
467
    /* if output buffer empty, put byte at end (allows more pushing) */
468
26
    if (state->x.have == 0) {
469
23
        state->x.have = 1;
470
23
        state->x.next = state->out + (state->size << 1) - 1;
471
23
        state->x.next[0] = (unsigned char)c;
472
23
        state->x.pos--;
473
23
        state->past = 0;
474
23
        return c;
475
23
    }
476
477
    /* if no room, give up (must have already done a gzungetc()) */
478
3
    if (state->x.have == (state->size << 1)) {
479
0
        gz_error(state, Z_DATA_ERROR, "out of room to push characters");
480
0
        return -1;
481
0
    }
482
483
    /* slide output data if needed and insert byte before existing data */
484
3
    if (state->x.next == state->out) {
485
0
        unsigned char *src = state->out + state->x.have;
486
0
        unsigned char *dest = state->out + (state->size << 1);
487
0
        while (src > state->out)
488
0
            *--dest = *--src;
489
0
        state->x.next = dest;
490
0
    }
491
3
    state->x.have++;
492
3
    state->x.next--;
493
3
    state->x.next[0] = (unsigned char)c;
494
3
    state->x.pos--;
495
3
    state->past = 0;
496
3
    return c;
497
3
}
498
499
/* -- see zlib.h -- */
500
99
char * ZEXPORT gzgets(gzFile file, char *buf, int len) {
501
99
    unsigned left, n;
502
99
    char *str;
503
99
    unsigned char *eol;
504
99
    gz_statep state;
505
506
    /* check parameters and get internal structure */
507
99
    if (file == NULL || buf == NULL || len < 1)
508
68
        return NULL;
509
31
    state = (gz_statep)file;
510
511
    /* check that we're reading and that there's no (serious) error */
512
31
    if (state->mode != GZ_READ ||
513
31
        (state->err != Z_OK && state->err != Z_BUF_ERROR))
514
21
        return NULL;
515
516
    /* process a skip request */
517
10
    if (state->seek) {
518
3
        state->seek = 0;
519
3
        if (gz_skip(state, state->skip) == -1)
520
0
            return NULL;
521
3
    }
522
523
    /* copy output bytes up to new line or len - 1, whichever comes first --
524
       append a terminating zero to the string (we don't check for a zero in
525
       the contents, let the user worry about that) */
526
10
    str = buf;
527
10
    left = (unsigned)len - 1;
528
11
    if (left) do {
529
        /* assure that something is in the output buffer */
530
11
        if (state->x.have == 0 && gz_fetch(state) == -1)
531
0
            return NULL;                /* error */
532
11
        if (state->x.have == 0) {       /* end of file */
533
10
            state->past = 1;            /* read past end */
534
10
            break;                      /* return what we have */
535
10
        }
536
537
        /* look for end-of-line in current output buffer */
538
1
        n = state->x.have > left ? left : state->x.have;
539
1
        eol = (unsigned char *)memchr(state->x.next, '\n', n);
540
1
        if (eol != NULL)
541
0
            n = (unsigned)(eol - state->x.next) + 1;
542
543
        /* copy through end-of-line, or remainder if not found */
544
1
        memcpy(buf, state->x.next, n);
545
1
        state->x.have -= n;
546
1
        state->x.next += n;
547
1
        state->x.pos += n;
548
1
        left -= n;
549
1
        buf += n;
550
1
    } while (left && eol == NULL);
551
552
    /* return terminated string, or if nothing, end of file */
553
10
    if (buf == str)
554
9
        return NULL;
555
1
    buf[0] = 0;
556
1
    return str;
557
10
}
558
559
/* -- see zlib.h -- */
560
25
int ZEXPORT gzdirect(gzFile file) {
561
25
    gz_statep state;
562
563
    /* get internal structure */
564
25
    if (file == NULL)
565
9
        return 0;
566
16
    state = (gz_statep)file;
567
568
    /* if the state is not known, but we can find out, then do so (this is
569
       mainly for right after a gzopen() or gzdopen()) */
570
16
    if (state->mode == GZ_READ && state->how == LOOK && state->x.have == 0)
571
4
        (void)gz_look(state);
572
573
    /* return 1 if transparent, 0 if processing a gzip stream */
574
16
    return state->direct;
575
25
}
576
577
/* -- see zlib.h -- */
578
3.95k
int ZEXPORT gzclose_r(gzFile file) {
579
3.95k
    int ret, err;
580
3.95k
    gz_statep state;
581
582
    /* get internal structure */
583
3.95k
    if (file == NULL)
584
0
        return Z_STREAM_ERROR;
585
3.95k
    state = (gz_statep)file;
586
587
    /* check that we're reading */
588
3.95k
    if (state->mode != GZ_READ)
589
0
        return Z_STREAM_ERROR;
590
591
    /* free memory and close file */
592
3.95k
    if (state->size) {
593
3.92k
        inflateEnd(&(state->strm));
594
3.92k
        free(state->out);
595
3.92k
        free(state->in);
596
3.92k
    }
597
3.95k
    err = state->err == Z_BUF_ERROR ? Z_BUF_ERROR : Z_OK;
598
3.95k
    gz_error(state, Z_OK, NULL);
599
3.95k
    free(state->path);
600
3.95k
    ret = close(state->fd);
601
3.95k
    free(state);
602
3.95k
    return ret ? Z_ERRNO : err;
603
3.95k
}