xref: /aosp_15_r20/external/zlib/gzguts.h (revision 86ee64e75fa5f8bce2c8c356138035642429cd05)
1*86ee64e7SAndroid Build Coastguard Worker /* gzguts.h -- zlib internal header definitions for gz* operations
2*86ee64e7SAndroid Build Coastguard Worker  * Copyright (C) 2004-2019 Mark Adler
3*86ee64e7SAndroid Build Coastguard Worker  * For conditions of distribution and use, see copyright notice in zlib.h
4*86ee64e7SAndroid Build Coastguard Worker  */
5*86ee64e7SAndroid Build Coastguard Worker 
6*86ee64e7SAndroid Build Coastguard Worker #ifdef _LARGEFILE64_SOURCE
7*86ee64e7SAndroid Build Coastguard Worker #  ifndef _LARGEFILE_SOURCE
8*86ee64e7SAndroid Build Coastguard Worker #    define _LARGEFILE_SOURCE 1
9*86ee64e7SAndroid Build Coastguard Worker #  endif
10*86ee64e7SAndroid Build Coastguard Worker #  undef _FILE_OFFSET_BITS
11*86ee64e7SAndroid Build Coastguard Worker #  undef _TIME_BITS
12*86ee64e7SAndroid Build Coastguard Worker #endif
13*86ee64e7SAndroid Build Coastguard Worker 
14*86ee64e7SAndroid Build Coastguard Worker #ifdef HAVE_HIDDEN
15*86ee64e7SAndroid Build Coastguard Worker #  define ZLIB_INTERNAL __attribute__((visibility ("hidden")))
16*86ee64e7SAndroid Build Coastguard Worker #else
17*86ee64e7SAndroid Build Coastguard Worker #  define ZLIB_INTERNAL
18*86ee64e7SAndroid Build Coastguard Worker #endif
19*86ee64e7SAndroid Build Coastguard Worker 
20*86ee64e7SAndroid Build Coastguard Worker #include <stdio.h>
21*86ee64e7SAndroid Build Coastguard Worker #include "zlib.h"
22*86ee64e7SAndroid Build Coastguard Worker #ifdef STDC
23*86ee64e7SAndroid Build Coastguard Worker #  include <string.h>
24*86ee64e7SAndroid Build Coastguard Worker #  include <stdlib.h>
25*86ee64e7SAndroid Build Coastguard Worker #  include <limits.h>
26*86ee64e7SAndroid Build Coastguard Worker #endif
27*86ee64e7SAndroid Build Coastguard Worker 
28*86ee64e7SAndroid Build Coastguard Worker #ifndef _POSIX_SOURCE
29*86ee64e7SAndroid Build Coastguard Worker #  define _POSIX_SOURCE
30*86ee64e7SAndroid Build Coastguard Worker #endif
31*86ee64e7SAndroid Build Coastguard Worker #include <fcntl.h>
32*86ee64e7SAndroid Build Coastguard Worker 
33*86ee64e7SAndroid Build Coastguard Worker #ifdef _WIN32
34*86ee64e7SAndroid Build Coastguard Worker #  include <stddef.h>
35*86ee64e7SAndroid Build Coastguard Worker #endif
36*86ee64e7SAndroid Build Coastguard Worker 
37*86ee64e7SAndroid Build Coastguard Worker #if defined(__TURBOC__) || defined(_MSC_VER) || defined(_WIN32)
38*86ee64e7SAndroid Build Coastguard Worker #  include <io.h>
39*86ee64e7SAndroid Build Coastguard Worker #endif
40*86ee64e7SAndroid Build Coastguard Worker 
41*86ee64e7SAndroid Build Coastguard Worker #if defined(_WIN32)
42*86ee64e7SAndroid Build Coastguard Worker #  define WIDECHAR
43*86ee64e7SAndroid Build Coastguard Worker #endif
44*86ee64e7SAndroid Build Coastguard Worker 
45*86ee64e7SAndroid Build Coastguard Worker #ifdef WINAPI_FAMILY
46*86ee64e7SAndroid Build Coastguard Worker #  define open _open
47*86ee64e7SAndroid Build Coastguard Worker #  define read _read
48*86ee64e7SAndroid Build Coastguard Worker #  define write _write
49*86ee64e7SAndroid Build Coastguard Worker #  define close _close
50*86ee64e7SAndroid Build Coastguard Worker #endif
51*86ee64e7SAndroid Build Coastguard Worker 
52*86ee64e7SAndroid Build Coastguard Worker #ifdef NO_DEFLATE       /* for compatibility with old definition */
53*86ee64e7SAndroid Build Coastguard Worker #  define NO_GZCOMPRESS
54*86ee64e7SAndroid Build Coastguard Worker #endif
55*86ee64e7SAndroid Build Coastguard Worker 
56*86ee64e7SAndroid Build Coastguard Worker #if defined(STDC99) || (defined(__TURBOC__) && __TURBOC__ >= 0x550)
57*86ee64e7SAndroid Build Coastguard Worker #  ifndef HAVE_VSNPRINTF
58*86ee64e7SAndroid Build Coastguard Worker #    define HAVE_VSNPRINTF
59*86ee64e7SAndroid Build Coastguard Worker #  endif
60*86ee64e7SAndroid Build Coastguard Worker #endif
61*86ee64e7SAndroid Build Coastguard Worker 
62*86ee64e7SAndroid Build Coastguard Worker #if defined(__CYGWIN__)
63*86ee64e7SAndroid Build Coastguard Worker #  ifndef HAVE_VSNPRINTF
64*86ee64e7SAndroid Build Coastguard Worker #    define HAVE_VSNPRINTF
65*86ee64e7SAndroid Build Coastguard Worker #  endif
66*86ee64e7SAndroid Build Coastguard Worker #endif
67*86ee64e7SAndroid Build Coastguard Worker 
68*86ee64e7SAndroid Build Coastguard Worker #if defined(MSDOS) && defined(__BORLANDC__) && (BORLANDC > 0x410)
69*86ee64e7SAndroid Build Coastguard Worker #  ifndef HAVE_VSNPRINTF
70*86ee64e7SAndroid Build Coastguard Worker #    define HAVE_VSNPRINTF
71*86ee64e7SAndroid Build Coastguard Worker #  endif
72*86ee64e7SAndroid Build Coastguard Worker #endif
73*86ee64e7SAndroid Build Coastguard Worker 
74*86ee64e7SAndroid Build Coastguard Worker #ifndef HAVE_VSNPRINTF
75*86ee64e7SAndroid Build Coastguard Worker #  ifdef MSDOS
76*86ee64e7SAndroid Build Coastguard Worker /* vsnprintf may exist on some MS-DOS compilers (DJGPP?),
77*86ee64e7SAndroid Build Coastguard Worker    but for now we just assume it doesn't. */
78*86ee64e7SAndroid Build Coastguard Worker #    define NO_vsnprintf
79*86ee64e7SAndroid Build Coastguard Worker #  endif
80*86ee64e7SAndroid Build Coastguard Worker #  ifdef __TURBOC__
81*86ee64e7SAndroid Build Coastguard Worker #    define NO_vsnprintf
82*86ee64e7SAndroid Build Coastguard Worker #  endif
83*86ee64e7SAndroid Build Coastguard Worker #  ifdef WIN32
84*86ee64e7SAndroid Build Coastguard Worker /* In Win32, vsnprintf is available as the "non-ANSI" _vsnprintf. */
85*86ee64e7SAndroid Build Coastguard Worker #    if !defined(vsnprintf) && !defined(NO_vsnprintf)
86*86ee64e7SAndroid Build Coastguard Worker #      if !defined(_MSC_VER) || ( defined(_MSC_VER) && _MSC_VER < 1500 )
87*86ee64e7SAndroid Build Coastguard Worker #         define vsnprintf _vsnprintf
88*86ee64e7SAndroid Build Coastguard Worker #      endif
89*86ee64e7SAndroid Build Coastguard Worker #    endif
90*86ee64e7SAndroid Build Coastguard Worker #  endif
91*86ee64e7SAndroid Build Coastguard Worker #  ifdef __SASC
92*86ee64e7SAndroid Build Coastguard Worker #    define NO_vsnprintf
93*86ee64e7SAndroid Build Coastguard Worker #  endif
94*86ee64e7SAndroid Build Coastguard Worker #  ifdef VMS
95*86ee64e7SAndroid Build Coastguard Worker #    define NO_vsnprintf
96*86ee64e7SAndroid Build Coastguard Worker #  endif
97*86ee64e7SAndroid Build Coastguard Worker #  ifdef __OS400__
98*86ee64e7SAndroid Build Coastguard Worker #    define NO_vsnprintf
99*86ee64e7SAndroid Build Coastguard Worker #  endif
100*86ee64e7SAndroid Build Coastguard Worker #  ifdef __MVS__
101*86ee64e7SAndroid Build Coastguard Worker #    define NO_vsnprintf
102*86ee64e7SAndroid Build Coastguard Worker #  endif
103*86ee64e7SAndroid Build Coastguard Worker #endif
104*86ee64e7SAndroid Build Coastguard Worker 
105*86ee64e7SAndroid Build Coastguard Worker /* unlike snprintf (which is required in C99), _snprintf does not guarantee
106*86ee64e7SAndroid Build Coastguard Worker    null termination of the result -- however this is only used in gzlib.c where
107*86ee64e7SAndroid Build Coastguard Worker    the result is assured to fit in the space provided */
108*86ee64e7SAndroid Build Coastguard Worker #if defined(_MSC_VER) && _MSC_VER < 1900
109*86ee64e7SAndroid Build Coastguard Worker #  define snprintf _snprintf
110*86ee64e7SAndroid Build Coastguard Worker #endif
111*86ee64e7SAndroid Build Coastguard Worker 
112*86ee64e7SAndroid Build Coastguard Worker #ifndef local
113*86ee64e7SAndroid Build Coastguard Worker #  define local static
114*86ee64e7SAndroid Build Coastguard Worker #endif
115*86ee64e7SAndroid Build Coastguard Worker /* since "static" is used to mean two completely different things in C, we
116*86ee64e7SAndroid Build Coastguard Worker    define "local" for the non-static meaning of "static", for readability
117*86ee64e7SAndroid Build Coastguard Worker    (compile with -Dlocal if your debugger can't find static symbols) */
118*86ee64e7SAndroid Build Coastguard Worker 
119*86ee64e7SAndroid Build Coastguard Worker /* gz* functions always use library allocation functions */
120*86ee64e7SAndroid Build Coastguard Worker #ifndef STDC
121*86ee64e7SAndroid Build Coastguard Worker   extern voidp  malloc(uInt size);
122*86ee64e7SAndroid Build Coastguard Worker   extern void   free(voidpf ptr);
123*86ee64e7SAndroid Build Coastguard Worker #endif
124*86ee64e7SAndroid Build Coastguard Worker 
125*86ee64e7SAndroid Build Coastguard Worker /* get errno and strerror definition */
126*86ee64e7SAndroid Build Coastguard Worker #if defined UNDER_CE
127*86ee64e7SAndroid Build Coastguard Worker #  include <windows.h>
128*86ee64e7SAndroid Build Coastguard Worker #  define zstrerror() gz_strwinerror((DWORD)GetLastError())
129*86ee64e7SAndroid Build Coastguard Worker #else
130*86ee64e7SAndroid Build Coastguard Worker #  ifndef NO_STRERROR
131*86ee64e7SAndroid Build Coastguard Worker #    include <errno.h>
132*86ee64e7SAndroid Build Coastguard Worker #    define zstrerror() strerror(errno)
133*86ee64e7SAndroid Build Coastguard Worker #  else
134*86ee64e7SAndroid Build Coastguard Worker #    define zstrerror() "stdio error (consult errno)"
135*86ee64e7SAndroid Build Coastguard Worker #  endif
136*86ee64e7SAndroid Build Coastguard Worker #endif
137*86ee64e7SAndroid Build Coastguard Worker 
138*86ee64e7SAndroid Build Coastguard Worker /* provide prototypes for these when building zlib without LFS */
139*86ee64e7SAndroid Build Coastguard Worker #if !defined(_LARGEFILE64_SOURCE) || _LFS64_LARGEFILE-0 == 0
140*86ee64e7SAndroid Build Coastguard Worker     ZEXTERN gzFile ZEXPORT gzopen64(const char *, const char *);
141*86ee64e7SAndroid Build Coastguard Worker     ZEXTERN z_off64_t ZEXPORT gzseek64(gzFile, z_off64_t, int);
142*86ee64e7SAndroid Build Coastguard Worker     ZEXTERN z_off64_t ZEXPORT gztell64(gzFile);
143*86ee64e7SAndroid Build Coastguard Worker     ZEXTERN z_off64_t ZEXPORT gzoffset64(gzFile);
144*86ee64e7SAndroid Build Coastguard Worker #endif
145*86ee64e7SAndroid Build Coastguard Worker 
146*86ee64e7SAndroid Build Coastguard Worker /* default memLevel */
147*86ee64e7SAndroid Build Coastguard Worker #if MAX_MEM_LEVEL >= 8
148*86ee64e7SAndroid Build Coastguard Worker #  define DEF_MEM_LEVEL 8
149*86ee64e7SAndroid Build Coastguard Worker #else
150*86ee64e7SAndroid Build Coastguard Worker #  define DEF_MEM_LEVEL  MAX_MEM_LEVEL
151*86ee64e7SAndroid Build Coastguard Worker #endif
152*86ee64e7SAndroid Build Coastguard Worker 
153*86ee64e7SAndroid Build Coastguard Worker /* default i/o buffer size -- double this for output when reading (this and
154*86ee64e7SAndroid Build Coastguard Worker    twice this must be able to fit in an unsigned type) */
155*86ee64e7SAndroid Build Coastguard Worker #define GZBUFSIZE 8192
156*86ee64e7SAndroid Build Coastguard Worker 
157*86ee64e7SAndroid Build Coastguard Worker /* gzip modes, also provide a little integrity check on the passed structure */
158*86ee64e7SAndroid Build Coastguard Worker #define GZ_NONE 0
159*86ee64e7SAndroid Build Coastguard Worker #define GZ_READ 7247
160*86ee64e7SAndroid Build Coastguard Worker #define GZ_WRITE 31153
161*86ee64e7SAndroid Build Coastguard Worker #define GZ_APPEND 1     /* mode set to GZ_WRITE after the file is opened */
162*86ee64e7SAndroid Build Coastguard Worker 
163*86ee64e7SAndroid Build Coastguard Worker /* values for gz_state how */
164*86ee64e7SAndroid Build Coastguard Worker #define LOOK 0      /* look for a gzip header */
165*86ee64e7SAndroid Build Coastguard Worker #define COPY 1      /* copy input directly */
166*86ee64e7SAndroid Build Coastguard Worker #define GZIP 2      /* decompress a gzip stream */
167*86ee64e7SAndroid Build Coastguard Worker 
168*86ee64e7SAndroid Build Coastguard Worker /* internal gzip file state data structure */
169*86ee64e7SAndroid Build Coastguard Worker typedef struct {
170*86ee64e7SAndroid Build Coastguard Worker         /* exposed contents for gzgetc() macro */
171*86ee64e7SAndroid Build Coastguard Worker     struct gzFile_s x;      /* "x" for exposed */
172*86ee64e7SAndroid Build Coastguard Worker                             /* x.have: number of bytes available at x.next */
173*86ee64e7SAndroid Build Coastguard Worker                             /* x.next: next output data to deliver or write */
174*86ee64e7SAndroid Build Coastguard Worker                             /* x.pos: current position in uncompressed data */
175*86ee64e7SAndroid Build Coastguard Worker         /* used for both reading and writing */
176*86ee64e7SAndroid Build Coastguard Worker     int mode;               /* see gzip modes above */
177*86ee64e7SAndroid Build Coastguard Worker     int fd;                 /* file descriptor */
178*86ee64e7SAndroid Build Coastguard Worker     char *path;             /* path or fd for error messages */
179*86ee64e7SAndroid Build Coastguard Worker     unsigned size;          /* buffer size, zero if not allocated yet */
180*86ee64e7SAndroid Build Coastguard Worker     unsigned want;          /* requested buffer size, default is GZBUFSIZE */
181*86ee64e7SAndroid Build Coastguard Worker     unsigned char *in;      /* input buffer (double-sized when writing) */
182*86ee64e7SAndroid Build Coastguard Worker     unsigned char *out;     /* output buffer (double-sized when reading) */
183*86ee64e7SAndroid Build Coastguard Worker     int direct;             /* 0 if processing gzip, 1 if transparent */
184*86ee64e7SAndroid Build Coastguard Worker         /* just for reading */
185*86ee64e7SAndroid Build Coastguard Worker     int how;                /* 0: get header, 1: copy, 2: decompress */
186*86ee64e7SAndroid Build Coastguard Worker     z_off64_t start;        /* where the gzip data started, for rewinding */
187*86ee64e7SAndroid Build Coastguard Worker     int eof;                /* true if end of input file reached */
188*86ee64e7SAndroid Build Coastguard Worker     int past;               /* true if read requested past end */
189*86ee64e7SAndroid Build Coastguard Worker         /* just for writing */
190*86ee64e7SAndroid Build Coastguard Worker     int level;              /* compression level */
191*86ee64e7SAndroid Build Coastguard Worker     int strategy;           /* compression strategy */
192*86ee64e7SAndroid Build Coastguard Worker     int reset;              /* true if a reset is pending after a Z_FINISH */
193*86ee64e7SAndroid Build Coastguard Worker         /* seek request */
194*86ee64e7SAndroid Build Coastguard Worker     z_off64_t skip;         /* amount to skip (already rewound if backwards) */
195*86ee64e7SAndroid Build Coastguard Worker     int seek;               /* true if seek request pending */
196*86ee64e7SAndroid Build Coastguard Worker         /* error information */
197*86ee64e7SAndroid Build Coastguard Worker     int err;                /* error code */
198*86ee64e7SAndroid Build Coastguard Worker     char *msg;              /* error message */
199*86ee64e7SAndroid Build Coastguard Worker         /* zlib inflate or deflate stream */
200*86ee64e7SAndroid Build Coastguard Worker     z_stream strm;          /* stream structure in-place (not a pointer) */
201*86ee64e7SAndroid Build Coastguard Worker } gz_state;
202*86ee64e7SAndroid Build Coastguard Worker typedef gz_state FAR *gz_statep;
203*86ee64e7SAndroid Build Coastguard Worker 
204*86ee64e7SAndroid Build Coastguard Worker /* shared functions */
205*86ee64e7SAndroid Build Coastguard Worker void ZLIB_INTERNAL gz_error(gz_statep, int, const char *);
206*86ee64e7SAndroid Build Coastguard Worker #if defined UNDER_CE
207*86ee64e7SAndroid Build Coastguard Worker char ZLIB_INTERNAL *gz_strwinerror(DWORD error);
208*86ee64e7SAndroid Build Coastguard Worker #endif
209*86ee64e7SAndroid Build Coastguard Worker 
210*86ee64e7SAndroid Build Coastguard Worker /* GT_OFF(x), where x is an unsigned value, is true if x > maximum z_off64_t
211*86ee64e7SAndroid Build Coastguard Worker    value -- needed when comparing unsigned to z_off64_t, which is signed
212*86ee64e7SAndroid Build Coastguard Worker    (possible z_off64_t types off_t, off64_t, and long are all signed) */
213*86ee64e7SAndroid Build Coastguard Worker #ifdef INT_MAX
214*86ee64e7SAndroid Build Coastguard Worker #  define GT_OFF(x) (sizeof(int) == sizeof(z_off64_t) && (x) > INT_MAX)
215*86ee64e7SAndroid Build Coastguard Worker #else
216*86ee64e7SAndroid Build Coastguard Worker unsigned ZLIB_INTERNAL gz_intmax(void);
217*86ee64e7SAndroid Build Coastguard Worker #  define GT_OFF(x) (sizeof(int) == sizeof(z_off64_t) && (x) > gz_intmax())
218*86ee64e7SAndroid Build Coastguard Worker #endif
219