/src/zlib/gzguts.h

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