Coverage Report

Created: 2025-08-26 06:25

/src/zlib/gzlib.c
Line
Count
Source (jump to first uncovered line)
1
/* gzlib.c -- zlib functions common to reading and writing gzip files
2
 * Copyright (C) 2004-2024 Mark Adler
3
 * For conditions of distribution and use, see copyright notice in zlib.h
4
 */
5
6
#include "gzguts.h"
7
8
#if defined(__DJGPP__)
9
#  define LSEEK llseek
10
#elif defined(_WIN32) && !defined(__BORLANDC__) && !defined(UNDER_CE)
11
#  define LSEEK _lseeki64
12
#elif defined(_LARGEFILE64_SOURCE) && _LFS64_LARGEFILE-0
13
294
#  define LSEEK lseek64
14
#else
15
#  define LSEEK lseek
16
#endif
17
18
#if defined UNDER_CE
19
20
/* Map the Windows error number in ERROR to a locale-dependent error message
21
   string and return a pointer to it.  Typically, the values for ERROR come
22
   from GetLastError.
23
24
   The string pointed to shall not be modified by the application, but may be
25
   overwritten by a subsequent call to gz_strwinerror
26
27
   The gz_strwinerror function does not change the current setting of
28
   GetLastError. */
29
char ZLIB_INTERNAL *gz_strwinerror(DWORD error) {
30
    static char buf[1024];
31
32
    wchar_t *msgbuf;
33
    DWORD lasterr = GetLastError();
34
    DWORD chars = FormatMessage(FORMAT_MESSAGE_FROM_SYSTEM
35
        | FORMAT_MESSAGE_ALLOCATE_BUFFER,
36
        NULL,
37
        error,
38
        0, /* Default language */
39
        (LPVOID)&msgbuf,
40
        0,
41
        NULL);
42
    if (chars != 0) {
43
        /* If there is an \r\n appended, zap it.  */
44
        if (chars >= 2
45
            && msgbuf[chars - 2] == '\r' && msgbuf[chars - 1] == '\n') {
46
            chars -= 2;
47
            msgbuf[chars] = 0;
48
        }
49
50
        if (chars > sizeof (buf) - 1) {
51
            chars = sizeof (buf) - 1;
52
            msgbuf[chars] = 0;
53
        }
54
55
        wcstombs(buf, msgbuf, chars + 1);       // assumes buf is big enough
56
        LocalFree(msgbuf);
57
    }
58
    else {
59
        sprintf(buf, "unknown win32 error (%ld)", error);
60
    }
61
62
    SetLastError(lasterr);
63
    return buf;
64
}
65
66
#endif /* UNDER_CE */
67
68
/* Reset gzip file state */
69
433
local void gz_reset(gz_statep state) {
70
433
    state->x.have = 0;              /* no output data available */
71
433
    if (state->mode == GZ_READ) {   /* for reading ... */
72
65
        state->eof = 0;             /* not at end of file */
73
65
        state->past = 0;            /* have not read past end yet */
74
65
        state->how = LOOK;          /* look for gzip header */
75
65
    }
76
368
    else                            /* for writing ... */
77
368
        state->reset = 0;           /* no deflateReset pending */
78
433
    state->seek = 0;                /* no seek request pending */
79
433
    gz_error(state, Z_OK, NULL);    /* clear error */
80
433
    state->x.pos = 0;               /* no uncompressed data yet */
81
433
    state->strm.avail_in = 0;       /* no input data yet */
82
433
}
83
84
/* Open a gzip file either by name or file descriptor. */
85
676
local gzFile gz_open(const void *path, int fd, const char *mode) {
86
676
    gz_statep state;
87
676
    z_size_t len;
88
676
    int oflag;
89
676
#ifdef O_CLOEXEC
90
676
    int cloexec = 0;
91
676
#endif
92
676
#ifdef O_EXCL
93
676
    int exclusive = 0;
94
676
#endif
95
96
    /* check input */
97
676
    if (path == NULL)
98
0
        return NULL;
99
100
    /* allocate gzFile structure to return */
101
676
    state = (gz_statep)malloc(sizeof(gz_state));
102
676
    if (state == NULL)
103
0
        return NULL;
104
676
    state->size = 0;            /* no buffers allocated yet */
105
676
    state->want = GZBUFSIZE;    /* requested buffer size */
106
676
    state->msg = NULL;          /* no error message yet */
107
108
    /* interpret mode */
109
676
    state->mode = GZ_NONE;
110
676
    state->level = Z_DEFAULT_COMPRESSION;
111
676
    state->strategy = Z_DEFAULT_STRATEGY;
112
676
    state->direct = 0;
113
4.11k
    while (*mode) {
114
3.44k
        if (*mode >= '0' && *mode <= '9')
115
191
            state->level = *mode - '0';
116
3.25k
        else
117
3.25k
            switch (*mode) {
118
86
            case 'r':
119
86
                state->mode = GZ_READ;
120
86
                break;
121
0
#ifndef NO_GZCOMPRESS
122
185
            case 'w':
123
185
                state->mode = GZ_WRITE;
124
185
                break;
125
323
            case 'a':
126
323
                state->mode = GZ_APPEND;
127
323
                break;
128
0
#endif
129
3
            case '+':       /* can't read and write at the same time */
130
3
                free(state);
131
3
                return NULL;
132
1
            case 'b':       /* ignore -- will request binary anyway */
133
1
                break;
134
0
#ifdef O_CLOEXEC
135
53
            case 'e':
136
53
                cloexec = 1;
137
53
                break;
138
0
#endif
139
0
#ifdef O_EXCL
140
25
            case 'x':
141
25
                exclusive = 1;
142
25
                break;
143
0
#endif
144
34
            case 'f':
145
34
                state->strategy = Z_FILTERED;
146
34
                break;
147
61
            case 'h':
148
61
                state->strategy = Z_HUFFMAN_ONLY;
149
61
                break;
150
76
            case 'R':
151
76
                state->strategy = Z_RLE;
152
76
                break;
153
27
            case 'F':
154
27
                state->strategy = Z_FIXED;
155
27
                break;
156
25
            case 'T':
157
25
                state->direct = 1;
158
25
                break;
159
2.35k
            default:        /* could consider as an error, but just ignore */
160
2.35k
                ;
161
3.25k
            }
162
3.44k
        mode++;
163
3.44k
    }
164
165
    /* must provide an "r", "w", or "a" */
166
673
    if (state->mode == GZ_NONE) {
167
240
        free(state);
168
240
        return NULL;
169
240
    }
170
171
    /* can't force transparent read */
172
433
    if (state->mode == GZ_READ) {
173
62
        if (state->direct) {
174
0
            free(state);
175
0
            return NULL;
176
0
        }
177
62
        state->direct = 1;      /* for empty file */
178
62
    }
179
180
    /* save the path name for error messages */
181
#ifdef WIDECHAR
182
    if (fd == -2)
183
        len = wcstombs(NULL, path, 0);
184
    else
185
#endif
186
433
        len = strlen((const char *)path);
187
433
    state->path = (char *)malloc(len + 1);
188
433
    if (state->path == NULL) {
189
0
        free(state);
190
0
        return NULL;
191
0
    }
192
#ifdef WIDECHAR
193
    if (fd == -2) {
194
        if (len)
195
            wcstombs(state->path, path, len + 1);
196
        else
197
            *(state->path) = 0;
198
    }
199
    else
200
#endif
201
433
    {
202
433
#if !defined(NO_snprintf) && !defined(NO_vsnprintf)
203
433
        (void)snprintf(state->path, len + 1, "%s", (const char *)path);
204
#else
205
        strcpy(state->path, path);
206
#endif
207
433
    }
208
209
    /* compute the flags for open() */
210
433
    oflag =
211
433
#ifdef O_LARGEFILE
212
433
        O_LARGEFILE |
213
433
#endif
214
#ifdef O_BINARY
215
        O_BINARY |
216
#endif
217
433
#ifdef O_CLOEXEC
218
433
        (cloexec ? O_CLOEXEC : 0) |
219
433
#endif
220
433
        (state->mode == GZ_READ ?
221
62
         O_RDONLY :
222
433
         (O_WRONLY | O_CREAT |
223
371
#ifdef O_EXCL
224
371
          (exclusive ? O_EXCL : 0) |
225
371
#endif
226
371
          (state->mode == GZ_WRITE ?
227
150
           O_TRUNC :
228
371
           O_APPEND)));
229
230
    /* open the file with the appropriate flags (or just use fd) */
231
433
    if (fd == -1)
232
433
        state->fd = open((const char *)path, oflag, 0666);
233
#ifdef WIDECHAR
234
    else if (fd == -2)
235
        state->fd = _wopen(path, oflag, _S_IREAD | _S_IWRITE);
236
#endif
237
0
    else
238
0
        state->fd = fd;
239
433
    if (state->fd == -1) {
240
3
        free(state->path);
241
3
        free(state);
242
3
        return NULL;
243
3
    }
244
430
    if (state->mode == GZ_APPEND) {
245
218
        LSEEK(state->fd, 0, SEEK_END);  /* so gzoffset() is correct */
246
218
        state->mode = GZ_WRITE;         /* simplify later checks */
247
218
    }
248
249
    /* save the current position for rewinding (only if reading) */
250
430
    if (state->mode == GZ_READ) {
251
62
        state->start = LSEEK(state->fd, 0, SEEK_CUR);
252
62
        if (state->start == -1) state->start = 0;
253
62
    }
254
255
    /* initialize stream */
256
430
    gz_reset(state);
257
258
    /* return stream */
259
430
    return (gzFile)state;
260
433
}
261
262
/* -- see zlib.h -- */
263
676
gzFile ZEXPORT gzopen(const char *path, const char *mode) {
264
676
    return gz_open(path, -1, mode);
265
676
}
266
267
/* -- see zlib.h -- */
268
0
gzFile ZEXPORT gzopen64(const char *path, const char *mode) {
269
0
    return gz_open(path, -1, mode);
270
0
}
271
272
/* -- see zlib.h -- */
273
0
gzFile ZEXPORT gzdopen(int fd, const char *mode) {
274
0
    char *path;         /* identifier for error messages */
275
0
    gzFile gz;
276
277
0
    if (fd == -1 || (path = (char *)malloc(7 + 3 * sizeof(int))) == NULL)
278
0
        return NULL;
279
0
#if !defined(NO_snprintf) && !defined(NO_vsnprintf)
280
0
    (void)snprintf(path, 7 + 3 * sizeof(int), "<fd:%d>", fd);
281
#else
282
    sprintf(path, "<fd:%d>", fd);   /* for debugging */
283
#endif
284
0
    gz = gz_open(path, fd, mode);
285
0
    free(path);
286
0
    return gz;
287
0
}
288
289
/* -- see zlib.h -- */
290
#ifdef WIDECHAR
291
gzFile ZEXPORT gzopen_w(const wchar_t *path, const char *mode) {
292
    return gz_open(path, -2, mode);
293
}
294
#endif
295
296
/* -- see zlib.h -- */
297
76
int ZEXPORT gzbuffer(gzFile file, unsigned size) {
298
76
    gz_statep state;
299
300
    /* get internal structure and check integrity */
301
76
    if (file == NULL)
302
14
        return -1;
303
62
    state = (gz_statep)file;
304
62
    if (state->mode != GZ_READ && state->mode != GZ_WRITE)
305
0
        return -1;
306
307
    /* make sure we haven't already allocated memory */
308
62
    if (state->size != 0)
309
4
        return -1;
310
311
    /* check and set requested size */
312
58
    if ((size << 1) < size)
313
0
        return -1;              /* need to be able to double it */
314
58
    if (size < 8)
315
0
        size = 8;               /* needed to behave well with flushing */
316
58
    state->want = size;
317
58
    return 0;
318
58
}
319
320
/* -- see zlib.h -- */
321
11
int ZEXPORT gzrewind(gzFile file) {
322
11
    gz_statep state;
323
324
    /* get internal structure */
325
11
    if (file == NULL)
326
3
        return -1;
327
8
    state = (gz_statep)file;
328
329
    /* check that we're reading and that there's no error */
330
8
    if (state->mode != GZ_READ ||
331
8
            (state->err != Z_OK && state->err != Z_BUF_ERROR))
332
5
        return -1;
333
334
    /* back up and start over */
335
3
    if (LSEEK(state->fd, state->start, SEEK_SET) == -1)
336
0
        return -1;
337
3
    gz_reset(state);
338
3
    return 0;
339
3
}
340
341
/* -- see zlib.h -- */
342
53
z_off64_t ZEXPORT gzseek64(gzFile file, z_off64_t offset, int whence) {
343
53
    unsigned n;
344
53
    z_off64_t ret;
345
53
    gz_statep state;
346
347
    /* get internal structure and check integrity */
348
53
    if (file == NULL)
349
19
        return -1;
350
34
    state = (gz_statep)file;
351
34
    if (state->mode != GZ_READ && state->mode != GZ_WRITE)
352
0
        return -1;
353
354
    /* check that there's no error */
355
34
    if (state->err != Z_OK && state->err != Z_BUF_ERROR)
356
0
        return -1;
357
358
    /* can only seek from start or relative to current position */
359
34
    if (whence != SEEK_SET && whence != SEEK_CUR)
360
1
        return -1;
361
362
    /* normalize offset to a SEEK_CUR specification */
363
33
    if (whence == SEEK_SET)
364
17
        offset -= state->x.pos;
365
16
    else if (state->seek)
366
1
        offset += state->skip;
367
33
    state->seek = 0;
368
369
    /* if within raw area while reading, just go there */
370
33
    if (state->mode == GZ_READ && state->how == COPY &&
371
33
            state->x.pos + offset >= 0) {
372
0
        ret = LSEEK(state->fd, offset - (z_off64_t)state->x.have, SEEK_CUR);
373
0
        if (ret == -1)
374
0
            return -1;
375
0
        state->x.have = 0;
376
0
        state->eof = 0;
377
0
        state->past = 0;
378
0
        state->seek = 0;
379
0
        gz_error(state, Z_OK, NULL);
380
0
        state->strm.avail_in = 0;
381
0
        state->x.pos += offset;
382
0
        return state->x.pos;
383
0
    }
384
385
    /* calculate skip amount, rewinding if needed for back seek when reading */
386
33
    if (offset < 0) {
387
1
        if (state->mode != GZ_READ)         /* writing -- can't go backwards */
388
1
            return -1;
389
0
        offset += state->x.pos;
390
0
        if (offset < 0)                     /* before start of file! */
391
0
            return -1;
392
0
        if (gzrewind(file) == -1)           /* rewind, then skip to offset */
393
0
            return -1;
394
0
    }
395
396
    /* if reading, skip what's in output buffer (one less gzgetc() check) */
397
32
    if (state->mode == GZ_READ) {
398
4
        n = GT_OFF(state->x.have) || (z_off64_t)state->x.have > offset ?
399
4
            (unsigned)offset : state->x.have;
400
4
        state->x.have -= n;
401
4
        state->x.next += n;
402
4
        state->x.pos += n;
403
4
        offset -= n;
404
4
    }
405
406
    /* request skip (if not zero) */
407
32
    if (offset) {
408
31
        state->seek = 1;
409
31
        state->skip = offset;
410
31
    }
411
32
    return state->x.pos + offset;
412
33
}
413
414
/* -- see zlib.h -- */
415
53
z_off_t ZEXPORT gzseek(gzFile file, z_off_t offset, int whence) {
416
53
    z_off64_t ret;
417
418
53
    ret = gzseek64(file, (z_off64_t)offset, whence);
419
53
    return ret == (z_off_t)ret ? (z_off_t)ret : -1;
420
53
}
421
422
/* -- see zlib.h -- */
423
23
z_off64_t ZEXPORT gztell64(gzFile file) {
424
23
    gz_statep state;
425
426
    /* get internal structure and check integrity */
427
23
    if (file == NULL)
428
12
        return -1;
429
11
    state = (gz_statep)file;
430
11
    if (state->mode != GZ_READ && state->mode != GZ_WRITE)
431
0
        return -1;
432
433
    /* return position */
434
11
    return state->x.pos + (state->seek ? state->skip : 0);
435
11
}
436
437
/* -- see zlib.h -- */
438
23
z_off_t ZEXPORT gztell(gzFile file) {
439
23
    z_off64_t ret;
440
441
23
    ret = gztell64(file);
442
23
    return ret == (z_off_t)ret ? (z_off_t)ret : -1;
443
23
}
444
445
/* -- see zlib.h -- */
446
19
z_off64_t ZEXPORT gzoffset64(gzFile file) {
447
19
    z_off64_t offset;
448
19
    gz_statep state;
449
450
    /* get internal structure and check integrity */
451
19
    if (file == NULL)
452
8
        return -1;
453
11
    state = (gz_statep)file;
454
11
    if (state->mode != GZ_READ && state->mode != GZ_WRITE)
455
0
        return -1;
456
457
    /* compute and return effective offset in file */
458
11
    offset = LSEEK(state->fd, 0, SEEK_CUR);
459
11
    if (offset == -1)
460
0
        return -1;
461
11
    if (state->mode == GZ_READ)             /* reading */
462
3
        offset -= state->strm.avail_in;     /* don't count buffered input */
463
11
    return offset;
464
11
}
465
466
/* -- see zlib.h -- */
467
19
z_off_t ZEXPORT gzoffset(gzFile file) {
468
19
    z_off64_t ret;
469
470
19
    ret = gzoffset64(file);
471
19
    return ret == (z_off_t)ret ? (z_off_t)ret : -1;
472
19
}
473
474
/* -- see zlib.h -- */
475
17
int ZEXPORT gzeof(gzFile file) {
476
17
    gz_statep state;
477
478
    /* get internal structure and check integrity */
479
17
    if (file == NULL)
480
7
        return 0;
481
10
    state = (gz_statep)file;
482
10
    if (state->mode != GZ_READ && state->mode != GZ_WRITE)
483
0
        return 0;
484
485
    /* return end-of-file state */
486
10
    return state->mode == GZ_READ ? state->past : 0;
487
10
}
488
489
/* -- see zlib.h -- */
490
20
const char * ZEXPORT gzerror(gzFile file, int *errnum) {
491
20
    gz_statep state;
492
493
    /* get internal structure and check integrity */
494
20
    if (file == NULL)
495
6
        return NULL;
496
14
    state = (gz_statep)file;
497
14
    if (state->mode != GZ_READ && state->mode != GZ_WRITE)
498
0
        return NULL;
499
500
    /* return error information */
501
14
    if (errnum != NULL)
502
14
        *errnum = state->err;
503
14
    return state->err == Z_MEM_ERROR ? "out of memory" :
504
14
                                       (state->msg == NULL ? "" : state->msg);
505
14
}
506
507
/* -- see zlib.h -- */
508
27
void ZEXPORT gzclearerr(gzFile file) {
509
27
    gz_statep state;
510
511
    /* get internal structure and check integrity */
512
27
    if (file == NULL)
513
14
        return;
514
13
    state = (gz_statep)file;
515
13
    if (state->mode != GZ_READ && state->mode != GZ_WRITE)
516
0
        return;
517
518
    /* clear error and end-of-file */
519
13
    if (state->mode == GZ_READ) {
520
4
        state->eof = 0;
521
4
        state->past = 0;
522
4
    }
523
13
    gz_error(state, Z_OK, NULL);
524
13
}
525
526
/* Create an error message in allocated memory and set state->err and
527
   state->msg accordingly.  Free any previous error message already there.  Do
528
   not try to free or allocate space if the error is Z_MEM_ERROR (out of
529
   memory).  Simply save the error message as a static string.  If there is an
530
   allocation failure constructing the error message, then convert the error to
531
   out of memory. */
532
906
void ZLIB_INTERNAL gz_error(gz_statep state, int err, const char *msg) {
533
    /* free previously allocated message and clear */
534
906
    if (state->msg != NULL) {
535
0
        if (state->err != Z_MEM_ERROR)
536
0
            free(state->msg);
537
0
        state->msg = NULL;
538
0
    }
539
540
    /* if fatal, set state->x.have to 0 so that the gzgetc() macro fails */
541
906
    if (err != Z_OK && err != Z_BUF_ERROR)
542
38
        state->x.have = 0;
543
544
    /* set error code, and if no message, then done */
545
906
    state->err = err;
546
906
    if (msg == NULL)
547
868
        return;
548
549
    /* for an out of memory error, return literal string when requested */
550
38
    if (err == Z_MEM_ERROR)
551
38
        return;
552
553
    /* construct error message with path */
554
0
    if ((state->msg = (char *)malloc(strlen(state->path) + strlen(msg) + 3)) ==
555
0
            NULL) {
556
0
        state->err = Z_MEM_ERROR;
557
0
        return;
558
0
    }
559
0
#if !defined(NO_snprintf) && !defined(NO_vsnprintf)
560
0
    (void)snprintf(state->msg, strlen(state->path) + strlen(msg) + 3,
561
0
                   "%s%s%s", state->path, ": ", msg);
562
#else
563
    strcpy(state->msg, state->path);
564
    strcat(state->msg, ": ");
565
    strcat(state->msg, msg);
566
#endif
567
0
}
568
569
/* portably return maximum value for an int (when limits.h presumed not
570
   available) -- we need to do this to cover cases where 2's complement not
571
   used, since C standard permits 1's complement and sign-bit representations,
572
   otherwise we could just use ((unsigned)-1) >> 1 */
573
0
unsigned ZLIB_INTERNAL gz_intmax(void) {
574
0
#ifdef INT_MAX
575
0
    return INT_MAX;
576
#else
577
    unsigned p = 1, q;
578
    do {
579
        q = p;
580
        p <<= 1;
581
        p++;
582
    } while (p > q);
583
    return q >> 1;
584
#endif
585
0
}