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