Coverage Report

Created: 2025-06-16 07:00

/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
53.9k
                  unsigned *have) {
14
53.9k
    int ret;
15
53.9k
    unsigned get, max = ((unsigned)-1 >> 2) + 1;
16
17
53.9k
    *have = 0;
18
107k
    do {
19
107k
        get = len - *have;
20
107k
        if (get > max)
21
0
            get = max;
22
107k
        ret = read(state->fd, buf + *have, get);
23
107k
        if (ret <= 0)
24
53.5k
            break;
25
53.8k
        *have += (unsigned)ret;
26
53.8k
    } while (*have < len);
27
53.9k
    if (ret < 0) {
28
0
        gz_error(state, Z_ERRNO, zstrerror());
29
0
        return -1;
30
0
    }
31
53.9k
    if (ret == 0)
32
53.5k
        state->eof = 1;
33
53.9k
    return 0;
34
53.9k
}
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
91.2k
local int gz_avail(gz_statep state) {
44
91.2k
    unsigned got;
45
91.2k
    z_streamp strm = &(state->strm);
46
47
91.2k
    if (state->err != Z_OK && state->err != Z_BUF_ERROR)
48
0
        return -1;
49
91.2k
    if (state->eof == 0) {
50
53.9k
        if (strm->avail_in) {       /* copy what's there to the start */
51
1
            unsigned char *p = state->in;
52
1
            unsigned const char *q = strm->next_in;
53
1
            unsigned n = strm->avail_in;
54
1
            do {
55
1
                *p++ = *q++;
56
1
            } while (--n);
57
1
        }
58
53.9k
        if (gz_load(state, state->in + strm->avail_in,
59
53.9k
                    state->size - strm->avail_in, &got) == -1)
60
0
            return -1;
61
53.9k
        strm->avail_in += got;
62
53.9k
        strm->next_in = state->in;
63
53.9k
    }
64
91.2k
    return 0;
65
91.2k
}
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
136k
local int gz_look(gz_statep state) {
77
136k
    z_streamp strm = &(state->strm);
78
79
    /* allocate read buffers and inflate memory */
80
136k
    if (state->size == 0) {
81
        /* allocate buffers */
82
49.0k
        state->in = (unsigned char *)malloc(state->want);
83
49.0k
        state->out = (unsigned char *)malloc(state->want << 1);
84
49.0k
        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
49.0k
        state->size = state->want;
91
92
        /* allocate inflate memory */
93
49.0k
        state->strm.zalloc = Z_NULL;
94
49.0k
        state->strm.zfree = Z_NULL;
95
49.0k
        state->strm.opaque = Z_NULL;
96
49.0k
        state->strm.avail_in = 0;
97
49.0k
        state->strm.next_in = Z_NULL;
98
49.0k
        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
49.0k
    }
106
107
    /* get at least the magic bytes in the input buffer */
108
136k
    if (strm->avail_in < 2) {
109
54.1k
        if (gz_avail(state) == -1)
110
0
            return -1;
111
54.1k
        if (strm->avail_in == 0)
112
1
            return 0;
113
54.1k
    }
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
136k
    if (strm->avail_in > 1 &&
123
136k
            strm->next_in[0] == 31 && strm->next_in[1] == 139) {
124
135k
        inflateReset(strm);
125
135k
        state->how = GZIP;
126
135k
        state->direct = 0;
127
135k
        return 0;
128
135k
    }
129
130
    /* no gzip header -- if we were decoding gzip before, then this is trailing
131
       garbage.  Ignore the trailing garbage and finish. */
132
740
    if (state->direct == 0) {
133
740
        strm->avail_in = 0;
134
740
        state->eof = 1;
135
740
        state->x.have = 0;
136
740
        return 0;
137
740
    }
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
740
}
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
314k
local int gz_decomp(gz_statep state) {
157
314k
    int ret = Z_OK;
158
314k
    unsigned had;
159
314k
    z_streamp strm = &(state->strm);
160
161
    /* fill output buffer up to end of deflate stream */
162
314k
    had = strm->avail_out;
163
351k
    do {
164
        /* get more input for inflate() */
165
351k
        if (strm->avail_in == 0 && gz_avail(state) == -1)
166
0
            return -1;
167
351k
        if (strm->avail_in == 0) {
168
37.1k
            gz_error(state, Z_BUF_ERROR, "unexpected end of file");
169
37.1k
            break;
170
37.1k
        }
171
172
        /* decompress and handle errors */
173
314k
        ret = inflate(strm, Z_NO_FLUSH);
174
314k
        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
314k
        if (ret == Z_MEM_ERROR) {
180
0
            gz_error(state, Z_MEM_ERROR, "out of memory");
181
0
            return -1;
182
0
        }
183
314k
        if (ret == Z_DATA_ERROR) {              /* deflate stream invalid */
184
12.3k
            gz_error(state, Z_DATA_ERROR,
185
12.3k
                     strm->msg == NULL ? "compressed data error" : strm->msg);
186
12.3k
            return -1;
187
12.3k
        }
188
314k
    } while (strm->avail_out && ret != Z_STREAM_END);
189
190
    /* update available output */
191
302k
    state->x.have = had - strm->avail_out;
192
302k
    state->x.next = strm->next_out - state->x.have;
193
194
    /* if the gzip stream completed successfully, look for another */
195
302k
    if (ret == Z_STREAM_END)
196
82.7k
        state->how = LOOK;
197
198
    /* good decompression */
199
302k
    return 0;
200
314k
}
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
238k
local int gz_fetch(gz_statep state) {
209
238k
    z_streamp strm = &(state->strm);
210
211
450k
    do {
212
450k
        switch(state->how) {
213
136k
        case LOOK:      /* -> LOOK, COPY (only if never GZIP), or GZIP */
214
136k
            if (gz_look(state) == -1)
215
0
                return -1;
216
136k
            if (state->how == LOOK)
217
741
                return 0;
218
135k
            break;
219
135k
        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
314k
        case GZIP:      /* -> GZIP or LOOK (if end of gzip stream) */
226
314k
            strm->avail_out = state->size << 1;
227
314k
            strm->next_out = state->out;
228
314k
            if (gz_decomp(state) == -1)
229
12.3k
                return -1;
230
450k
        }
231
450k
    } while (state->x.have == 0 && (!state->eof || strm->avail_in));
232
225k
    return 0;
233
238k
}
234
235
/* Skip len uncompressed bytes of output.  Return -1 on error, 0 on success. */
236
3.66k
local int gz_skip(gz_statep state, z_off64_t len) {
237
3.66k
    unsigned n;
238
239
    /* skip over len bytes or reach end-of-file, whichever comes first */
240
44.1k
    while (len)
241
        /* skip over whatever is in output buffer */
242
41.2k
        if (state->x.have) {
243
20.2k
            n = GT_OFF(state->x.have) || (z_off64_t)state->x.have > len ?
244
17.3k
                (unsigned)len : state->x.have;
245
20.2k
            state->x.have -= n;
246
20.2k
            state->x.next += n;
247
20.2k
            state->x.pos += n;
248
20.2k
            len -= n;
249
20.2k
        }
250
251
        /* output buffer empty -- return if we're at the end of the input */
252
21.0k
        else if (state->eof && state->strm.avail_in == 0)
253
797
            break;
254
255
        /* need more data to skip -- load up output buffer */
256
20.2k
        else {
257
            /* get more output, looking for header if required */
258
20.2k
            if (gz_fetch(state) == -1)
259
23
                return -1;
260
20.2k
        }
261
3.64k
    return 0;
262
3.66k
}
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
694k
local z_size_t gz_read(gz_statep state, voidp buf, z_size_t len) {
269
694k
    z_size_t got;
270
694k
    unsigned n;
271
272
    /* if len is zero, avoid unnecessary operations */
273
694k
    if (len == 0)
274
0
        return 0;
275
276
    /* process a skip request */
277
694k
    if (state->seek) {
278
3.66k
        state->seek = 0;
279
3.66k
        if (gz_skip(state, state->skip) == -1)
280
23
            return 0;
281
3.66k
    }
282
283
    /* get len bytes to buf, or less than len if at the end */
284
694k
    got = 0;
285
1.07M
    do {
286
        /* set n to the maximum amount of len that fits in an unsigned int */
287
1.07M
        n = (unsigned)-1;
288
1.07M
        if (n > len)
289
1.07M
            n = (unsigned)len;
290
291
        /* first just try copying data from the output buffer */
292
1.07M
        if (state->x.have) {
293
449k
            if (state->x.have < n)
294
174k
                n = state->x.have;
295
449k
            memcpy(buf, state->x.next, n);
296
449k
            state->x.next += n;
297
449k
            state->x.have -= n;
298
449k
        }
299
300
        /* output buffer empty -- return if we're at the end of the input */
301
624k
        else if (state->eof && state->strm.avail_in == 0) {
302
405k
            state->past = 1;        /* tried to read past end */
303
405k
            break;
304
405k
        }
305
306
        /* need output data -- for small len or new stream load up our output
307
           buffer */
308
218k
        else if (state->how == LOOK || n < (state->size << 1)) {
309
            /* get more output, looking for header if required */
310
218k
            if (gz_fetch(state) == -1)
311
12.3k
                return 0;
312
205k
            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
218k
        }
316
317
        /* large len -- read directly into user buffer */
318
385
        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
385
        else {  /* state->how == GZIP */
325
385
            state->strm.avail_out = n;
326
385
            state->strm.next_out = (unsigned char *)buf;
327
385
            if (gz_decomp(state) == -1)
328
31
                return 0;
329
354
            n = state->x.have;
330
354
            state->x.have = 0;
331
354
        }
332
333
        /* update progress */
334
450k
        len -= n;
335
450k
        buf = (char *)buf + n;
336
450k
        got += n;
337
450k
        state->x.pos += n;
338
656k
    } while (len);
339
340
    /* return number of bytes read into user buffer */
341
681k
    return got;
342
694k
}
343
344
/* -- see zlib.h -- */
345
711k
int ZEXPORT gzread(gzFile file, voidp buf, unsigned len) {
346
711k
    gz_statep state;
347
348
    /* get internal structure */
349
711k
    if (file == NULL)
350
0
        return -1;
351
711k
    state = (gz_statep)file;
352
353
    /* check that we're reading and that there's no (serious) error */
354
711k
    if (state->mode != GZ_READ ||
355
711k
            (state->err != Z_OK && state->err != Z_BUF_ERROR))
356
64.5k
        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
646k
    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
646k
    len = (unsigned)gz_read(state, buf, len);
367
368
    /* check for an error */
369
646k
    if (len == 0 && state->err != Z_OK && state->err != Z_BUF_ERROR)
370
10.2k
        return -1;
371
372
    /* return the number of bytes read (this is assured to fit in an int) */
373
636k
    return (int)len;
374
646k
}
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
51.6k
int ZEXPORT gzgetc(gzFile file) {
410
51.6k
    unsigned char buf[1];
411
51.6k
    gz_statep state;
412
413
    /* get internal structure */
414
51.6k
    if (file == NULL)
415
0
        return -1;
416
51.6k
    state = (gz_statep)file;
417
418
    /* check that we're reading and that there's no (serious) error */
419
51.6k
    if (state->mode != GZ_READ ||
420
51.6k
        (state->err != Z_OK && state->err != Z_BUF_ERROR))
421
4.12k
        return -1;
422
423
    /* try output buffer (no need to check for skip request) */
424
47.4k
    if (state->x.have) {
425
0
        state->x.have--;
426
0
        state->x.pos++;
427
0
        return *(state->x.next)++;
428
0
    }
429
430
    /* nothing there -- try gz_read() */
431
47.4k
    return gz_read(state, buf, 1) < 1 ? -1 : buf[0];
432
47.4k
}
433
434
0
int ZEXPORT gzgetc_(gzFile file) {
435
0
    return gzgetc(file);
436
0
}
437
438
/* -- see zlib.h -- */
439
0
int ZEXPORT gzungetc(int c, gzFile file) {
440
0
    gz_statep state;
441
442
    /* get internal structure */
443
0
    if (file == NULL)
444
0
        return -1;
445
0
    state = (gz_statep)file;
446
447
    /* in case this was just opened, set up the input buffer */
448
0
    if (state->mode == GZ_READ && state->how == LOOK && state->x.have == 0)
449
0
        (void)gz_look(state);
450
451
    /* check that we're reading and that there's no (serious) error */
452
0
    if (state->mode != GZ_READ ||
453
0
        (state->err != Z_OK && state->err != Z_BUF_ERROR))
454
0
        return -1;
455
456
    /* process a skip request */
457
0
    if (state->seek) {
458
0
        state->seek = 0;
459
0
        if (gz_skip(state, state->skip) == -1)
460
0
            return -1;
461
0
    }
462
463
    /* can't push EOF */
464
0
    if (c < 0)
465
0
        return -1;
466
467
    /* if output buffer empty, put byte at end (allows more pushing) */
468
0
    if (state->x.have == 0) {
469
0
        state->x.have = 1;
470
0
        state->x.next = state->out + (state->size << 1) - 1;
471
0
        state->x.next[0] = (unsigned char)c;
472
0
        state->x.pos--;
473
0
        state->past = 0;
474
0
        return c;
475
0
    }
476
477
    /* if no room, give up (must have already done a gzungetc()) */
478
0
    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
0
    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
0
    state->x.have++;
492
0
    state->x.next--;
493
0
    state->x.next[0] = (unsigned char)c;
494
0
    state->x.pos--;
495
0
    state->past = 0;
496
0
    return c;
497
0
}
498
499
/* -- see zlib.h -- */
500
0
char * ZEXPORT gzgets(gzFile file, char *buf, int len) {
501
0
    unsigned left, n;
502
0
    char *str;
503
0
    unsigned char *eol;
504
0
    gz_statep state;
505
506
    /* check parameters and get internal structure */
507
0
    if (file == NULL || buf == NULL || len < 1)
508
0
        return NULL;
509
0
    state = (gz_statep)file;
510
511
    /* check that we're reading and that there's no (serious) error */
512
0
    if (state->mode != GZ_READ ||
513
0
        (state->err != Z_OK && state->err != Z_BUF_ERROR))
514
0
        return NULL;
515
516
    /* process a skip request */
517
0
    if (state->seek) {
518
0
        state->seek = 0;
519
0
        if (gz_skip(state, state->skip) == -1)
520
0
            return NULL;
521
0
    }
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
0
    str = buf;
527
0
    left = (unsigned)len - 1;
528
0
    if (left) do {
529
        /* assure that something is in the output buffer */
530
0
        if (state->x.have == 0 && gz_fetch(state) == -1)
531
0
            return NULL;                /* error */
532
0
        if (state->x.have == 0) {       /* end of file */
533
0
            state->past = 1;            /* read past end */
534
0
            break;                      /* return what we have */
535
0
        }
536
537
        /* look for end-of-line in current output buffer */
538
0
        n = state->x.have > left ? left : state->x.have;
539
0
        eol = (unsigned char *)memchr(state->x.next, '\n', n);
540
0
        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
0
        memcpy(buf, state->x.next, n);
545
0
        state->x.have -= n;
546
0
        state->x.next += n;
547
0
        state->x.pos += n;
548
0
        left -= n;
549
0
        buf += n;
550
0
    } while (left && eol == NULL);
551
552
    /* return terminated string, or if nothing, end of file */
553
0
    if (buf == str)
554
0
        return NULL;
555
0
    buf[0] = 0;
556
0
    return str;
557
0
}
558
559
/* -- see zlib.h -- */
560
0
int ZEXPORT gzdirect(gzFile file) {
561
0
    gz_statep state;
562
563
    /* get internal structure */
564
0
    if (file == NULL)
565
0
        return 0;
566
0
    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
0
    if (state->mode == GZ_READ && state->how == LOOK && state->x.have == 0)
571
0
        (void)gz_look(state);
572
573
    /* return 1 if transparent, 0 if processing a gzip stream */
574
0
    return state->direct;
575
0
}
576
577
/* -- see zlib.h -- */
578
96.5k
int ZEXPORT gzclose_r(gzFile file) {
579
96.5k
    int ret, err;
580
96.5k
    gz_statep state;
581
582
    /* get internal structure */
583
96.5k
    if (file == NULL)
584
0
        return Z_STREAM_ERROR;
585
96.5k
    state = (gz_statep)file;
586
587
    /* check that we're reading */
588
96.5k
    if (state->mode != GZ_READ)
589
0
        return Z_STREAM_ERROR;
590
591
    /* free memory and close file */
592
96.5k
    if (state->size) {
593
49.0k
        inflateEnd(&(state->strm));
594
49.0k
        free(state->out);
595
49.0k
        free(state->in);
596
49.0k
    }
597
96.5k
    err = state->err == Z_BUF_ERROR ? Z_BUF_ERROR : Z_OK;
598
96.5k
    gz_error(state, Z_OK, NULL);
599
96.5k
    free(state->path);
600
96.5k
    ret = close(state->fd);
601
96.5k
    free(state);
602
96.5k
    return ret ? Z_ERRNO : err;
603
96.5k
}