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