xref: /optee_os/core/lib/zlib/zutil.h (revision b3be2f66b22b7fceaeb67c58f07c18b1b0611191)
1*b3be2f66SJerome Forissier /* zutil.h -- internal interface and configuration of the compression library
2*b3be2f66SJerome Forissier  * Copyright (C) 1995-2016 Jean-loup Gailly, Mark Adler
3*b3be2f66SJerome Forissier  * For conditions of distribution and use, see copyright notice in zlib.h
4*b3be2f66SJerome Forissier  */
5*b3be2f66SJerome Forissier 
6*b3be2f66SJerome Forissier /* WARNING: this file should *not* be used by applications. It is
7*b3be2f66SJerome Forissier    part of the implementation of the compression library and is
8*b3be2f66SJerome Forissier    subject to change. Applications should only use zlib.h.
9*b3be2f66SJerome Forissier  */
10*b3be2f66SJerome Forissier 
11*b3be2f66SJerome Forissier /* @(#) $Id$ */
12*b3be2f66SJerome Forissier 
13*b3be2f66SJerome Forissier #ifndef ZUTIL_H
14*b3be2f66SJerome Forissier #define ZUTIL_H
15*b3be2f66SJerome Forissier 
16*b3be2f66SJerome Forissier #ifdef HAVE_HIDDEN
17*b3be2f66SJerome Forissier #  define ZLIB_INTERNAL __attribute__((visibility ("hidden")))
18*b3be2f66SJerome Forissier #else
19*b3be2f66SJerome Forissier #  define ZLIB_INTERNAL
20*b3be2f66SJerome Forissier #endif
21*b3be2f66SJerome Forissier 
22*b3be2f66SJerome Forissier #include "zlib.h"
23*b3be2f66SJerome Forissier 
24*b3be2f66SJerome Forissier #if defined(STDC) && !defined(Z_SOLO)
25*b3be2f66SJerome Forissier #  if !(defined(_WIN32_WCE) && defined(_MSC_VER))
26*b3be2f66SJerome Forissier #    include <stddef.h>
27*b3be2f66SJerome Forissier #  endif
28*b3be2f66SJerome Forissier #  include <string.h>
29*b3be2f66SJerome Forissier #  include <stdlib.h>
30*b3be2f66SJerome Forissier #endif
31*b3be2f66SJerome Forissier 
32*b3be2f66SJerome Forissier #ifdef Z_SOLO
33*b3be2f66SJerome Forissier    typedef long ptrdiff_t;  /* guess -- will be caught if guess is wrong */
34*b3be2f66SJerome Forissier #endif
35*b3be2f66SJerome Forissier 
36*b3be2f66SJerome Forissier #ifndef local
37*b3be2f66SJerome Forissier #  define local static
38*b3be2f66SJerome Forissier #endif
39*b3be2f66SJerome Forissier /* since "static" is used to mean two completely different things in C, we
40*b3be2f66SJerome Forissier    define "local" for the non-static meaning of "static", for readability
41*b3be2f66SJerome Forissier    (compile with -Dlocal if your debugger can't find static symbols) */
42*b3be2f66SJerome Forissier 
43*b3be2f66SJerome Forissier typedef unsigned char  uch;
44*b3be2f66SJerome Forissier typedef uch FAR uchf;
45*b3be2f66SJerome Forissier typedef unsigned short ush;
46*b3be2f66SJerome Forissier typedef ush FAR ushf;
47*b3be2f66SJerome Forissier typedef unsigned long  ulg;
48*b3be2f66SJerome Forissier 
49*b3be2f66SJerome Forissier extern z_const char * const z_errmsg[10]; /* indexed by 2-zlib_error */
50*b3be2f66SJerome Forissier /* (size given to avoid silly warnings with Visual C++) */
51*b3be2f66SJerome Forissier 
52*b3be2f66SJerome Forissier #define ERR_MSG(err) z_errmsg[Z_NEED_DICT-(err)]
53*b3be2f66SJerome Forissier 
54*b3be2f66SJerome Forissier #define ERR_RETURN(strm,err) \
55*b3be2f66SJerome Forissier   return (strm->msg = ERR_MSG(err), (err))
56*b3be2f66SJerome Forissier /* To be used only when the state is known to be valid */
57*b3be2f66SJerome Forissier 
58*b3be2f66SJerome Forissier         /* common constants */
59*b3be2f66SJerome Forissier 
60*b3be2f66SJerome Forissier #ifndef DEF_WBITS
61*b3be2f66SJerome Forissier #  define DEF_WBITS MAX_WBITS
62*b3be2f66SJerome Forissier #endif
63*b3be2f66SJerome Forissier /* default windowBits for decompression. MAX_WBITS is for compression only */
64*b3be2f66SJerome Forissier 
65*b3be2f66SJerome Forissier #if MAX_MEM_LEVEL >= 8
66*b3be2f66SJerome Forissier #  define DEF_MEM_LEVEL 8
67*b3be2f66SJerome Forissier #else
68*b3be2f66SJerome Forissier #  define DEF_MEM_LEVEL  MAX_MEM_LEVEL
69*b3be2f66SJerome Forissier #endif
70*b3be2f66SJerome Forissier /* default memLevel */
71*b3be2f66SJerome Forissier 
72*b3be2f66SJerome Forissier #define STORED_BLOCK 0
73*b3be2f66SJerome Forissier #define STATIC_TREES 1
74*b3be2f66SJerome Forissier #define DYN_TREES    2
75*b3be2f66SJerome Forissier /* The three kinds of block type */
76*b3be2f66SJerome Forissier 
77*b3be2f66SJerome Forissier #define MIN_MATCH  3
78*b3be2f66SJerome Forissier #define MAX_MATCH  258
79*b3be2f66SJerome Forissier /* The minimum and maximum match lengths */
80*b3be2f66SJerome Forissier 
81*b3be2f66SJerome Forissier #define PRESET_DICT 0x20 /* preset dictionary flag in zlib header */
82*b3be2f66SJerome Forissier 
83*b3be2f66SJerome Forissier         /* target dependencies */
84*b3be2f66SJerome Forissier 
85*b3be2f66SJerome Forissier #if defined(MSDOS) || (defined(WINDOWS) && !defined(WIN32))
86*b3be2f66SJerome Forissier #  define OS_CODE  0x00
87*b3be2f66SJerome Forissier #  ifndef Z_SOLO
88*b3be2f66SJerome Forissier #    if defined(__TURBOC__) || defined(__BORLANDC__)
89*b3be2f66SJerome Forissier #      if (__STDC__ == 1) && (defined(__LARGE__) || defined(__COMPACT__))
90*b3be2f66SJerome Forissier          /* Allow compilation with ANSI keywords only enabled */
91*b3be2f66SJerome Forissier          void _Cdecl farfree( void *block );
92*b3be2f66SJerome Forissier          void *_Cdecl farmalloc( unsigned long nbytes );
93*b3be2f66SJerome Forissier #      else
94*b3be2f66SJerome Forissier #        include <alloc.h>
95*b3be2f66SJerome Forissier #      endif
96*b3be2f66SJerome Forissier #    else /* MSC or DJGPP */
97*b3be2f66SJerome Forissier #      include <malloc.h>
98*b3be2f66SJerome Forissier #    endif
99*b3be2f66SJerome Forissier #  endif
100*b3be2f66SJerome Forissier #endif
101*b3be2f66SJerome Forissier 
102*b3be2f66SJerome Forissier #ifdef AMIGA
103*b3be2f66SJerome Forissier #  define OS_CODE  1
104*b3be2f66SJerome Forissier #endif
105*b3be2f66SJerome Forissier 
106*b3be2f66SJerome Forissier #if defined(VAXC) || defined(VMS)
107*b3be2f66SJerome Forissier #  define OS_CODE  2
108*b3be2f66SJerome Forissier #  define F_OPEN(name, mode) \
109*b3be2f66SJerome Forissier      fopen((name), (mode), "mbc=60", "ctx=stm", "rfm=fix", "mrs=512")
110*b3be2f66SJerome Forissier #endif
111*b3be2f66SJerome Forissier 
112*b3be2f66SJerome Forissier #ifdef __370__
113*b3be2f66SJerome Forissier #  if __TARGET_LIB__ < 0x20000000
114*b3be2f66SJerome Forissier #    define OS_CODE 4
115*b3be2f66SJerome Forissier #  elif __TARGET_LIB__ < 0x40000000
116*b3be2f66SJerome Forissier #    define OS_CODE 11
117*b3be2f66SJerome Forissier #  else
118*b3be2f66SJerome Forissier #    define OS_CODE 8
119*b3be2f66SJerome Forissier #  endif
120*b3be2f66SJerome Forissier #endif
121*b3be2f66SJerome Forissier 
122*b3be2f66SJerome Forissier #if defined(ATARI) || defined(atarist)
123*b3be2f66SJerome Forissier #  define OS_CODE  5
124*b3be2f66SJerome Forissier #endif
125*b3be2f66SJerome Forissier 
126*b3be2f66SJerome Forissier #ifdef OS2
127*b3be2f66SJerome Forissier #  define OS_CODE  6
128*b3be2f66SJerome Forissier #  if defined(M_I86) && !defined(Z_SOLO)
129*b3be2f66SJerome Forissier #    include <malloc.h>
130*b3be2f66SJerome Forissier #  endif
131*b3be2f66SJerome Forissier #endif
132*b3be2f66SJerome Forissier 
133*b3be2f66SJerome Forissier #if defined(MACOS) || defined(TARGET_OS_MAC)
134*b3be2f66SJerome Forissier #  define OS_CODE  7
135*b3be2f66SJerome Forissier #  ifndef Z_SOLO
136*b3be2f66SJerome Forissier #    if defined(__MWERKS__) && __dest_os != __be_os && __dest_os != __win32_os
137*b3be2f66SJerome Forissier #      include <unix.h> /* for fdopen */
138*b3be2f66SJerome Forissier #    else
139*b3be2f66SJerome Forissier #      ifndef fdopen
140*b3be2f66SJerome Forissier #        define fdopen(fd,mode) NULL /* No fdopen() */
141*b3be2f66SJerome Forissier #      endif
142*b3be2f66SJerome Forissier #    endif
143*b3be2f66SJerome Forissier #  endif
144*b3be2f66SJerome Forissier #endif
145*b3be2f66SJerome Forissier 
146*b3be2f66SJerome Forissier #ifdef __acorn
147*b3be2f66SJerome Forissier #  define OS_CODE 13
148*b3be2f66SJerome Forissier #endif
149*b3be2f66SJerome Forissier 
150*b3be2f66SJerome Forissier #if defined(WIN32) && !defined(__CYGWIN__)
151*b3be2f66SJerome Forissier #  define OS_CODE  10
152*b3be2f66SJerome Forissier #endif
153*b3be2f66SJerome Forissier 
154*b3be2f66SJerome Forissier #ifdef _BEOS_
155*b3be2f66SJerome Forissier #  define OS_CODE  16
156*b3be2f66SJerome Forissier #endif
157*b3be2f66SJerome Forissier 
158*b3be2f66SJerome Forissier #ifdef __TOS_OS400__
159*b3be2f66SJerome Forissier #  define OS_CODE 18
160*b3be2f66SJerome Forissier #endif
161*b3be2f66SJerome Forissier 
162*b3be2f66SJerome Forissier #ifdef __APPLE__
163*b3be2f66SJerome Forissier #  define OS_CODE 19
164*b3be2f66SJerome Forissier #endif
165*b3be2f66SJerome Forissier 
166*b3be2f66SJerome Forissier #if defined(_BEOS_) || defined(RISCOS)
167*b3be2f66SJerome Forissier #  define fdopen(fd,mode) NULL /* No fdopen() */
168*b3be2f66SJerome Forissier #endif
169*b3be2f66SJerome Forissier 
170*b3be2f66SJerome Forissier #if (defined(_MSC_VER) && (_MSC_VER > 600)) && !defined __INTERIX
171*b3be2f66SJerome Forissier #  if defined(_WIN32_WCE)
172*b3be2f66SJerome Forissier #    define fdopen(fd,mode) NULL /* No fdopen() */
173*b3be2f66SJerome Forissier #    ifndef _PTRDIFF_T_DEFINED
174*b3be2f66SJerome Forissier        typedef int ptrdiff_t;
175*b3be2f66SJerome Forissier #      define _PTRDIFF_T_DEFINED
176*b3be2f66SJerome Forissier #    endif
177*b3be2f66SJerome Forissier #  else
178*b3be2f66SJerome Forissier #    define fdopen(fd,type)  _fdopen(fd,type)
179*b3be2f66SJerome Forissier #  endif
180*b3be2f66SJerome Forissier #endif
181*b3be2f66SJerome Forissier 
182*b3be2f66SJerome Forissier #if defined(__BORLANDC__) && !defined(MSDOS)
183*b3be2f66SJerome Forissier   #pragma warn -8004
184*b3be2f66SJerome Forissier   #pragma warn -8008
185*b3be2f66SJerome Forissier   #pragma warn -8066
186*b3be2f66SJerome Forissier #endif
187*b3be2f66SJerome Forissier 
188*b3be2f66SJerome Forissier /* provide prototypes for these when building zlib without LFS */
189*b3be2f66SJerome Forissier #if !defined(_WIN32) && \
190*b3be2f66SJerome Forissier     (!defined(_LARGEFILE64_SOURCE) || _LFS64_LARGEFILE-0 == 0)
191*b3be2f66SJerome Forissier     ZEXTERN uLong ZEXPORT adler32_combine64 OF((uLong, uLong, z_off_t));
192*b3be2f66SJerome Forissier     ZEXTERN uLong ZEXPORT crc32_combine64 OF((uLong, uLong, z_off_t));
193*b3be2f66SJerome Forissier #endif
194*b3be2f66SJerome Forissier 
195*b3be2f66SJerome Forissier         /* common defaults */
196*b3be2f66SJerome Forissier 
197*b3be2f66SJerome Forissier #ifndef OS_CODE
198*b3be2f66SJerome Forissier #  define OS_CODE  3     /* assume Unix */
199*b3be2f66SJerome Forissier #endif
200*b3be2f66SJerome Forissier 
201*b3be2f66SJerome Forissier #ifndef F_OPEN
202*b3be2f66SJerome Forissier #  define F_OPEN(name, mode) fopen((name), (mode))
203*b3be2f66SJerome Forissier #endif
204*b3be2f66SJerome Forissier 
205*b3be2f66SJerome Forissier          /* functions */
206*b3be2f66SJerome Forissier 
207*b3be2f66SJerome Forissier #if defined(pyr) || defined(Z_SOLO)
208*b3be2f66SJerome Forissier #  define NO_MEMCPY
209*b3be2f66SJerome Forissier #endif
210*b3be2f66SJerome Forissier #if defined(SMALL_MEDIUM) && !defined(_MSC_VER) && !defined(__SC__)
211*b3be2f66SJerome Forissier  /* Use our own functions for small and medium model with MSC <= 5.0.
212*b3be2f66SJerome Forissier   * You may have to use the same strategy for Borland C (untested).
213*b3be2f66SJerome Forissier   * The __SC__ check is for Symantec.
214*b3be2f66SJerome Forissier   */
215*b3be2f66SJerome Forissier #  define NO_MEMCPY
216*b3be2f66SJerome Forissier #endif
217*b3be2f66SJerome Forissier #if defined(STDC) && !defined(HAVE_MEMCPY) && !defined(NO_MEMCPY)
218*b3be2f66SJerome Forissier #  define HAVE_MEMCPY
219*b3be2f66SJerome Forissier #endif
220*b3be2f66SJerome Forissier #ifdef HAVE_MEMCPY
221*b3be2f66SJerome Forissier #  ifdef SMALL_MEDIUM /* MSDOS small or medium model */
222*b3be2f66SJerome Forissier #    define zmemcpy _fmemcpy
223*b3be2f66SJerome Forissier #    define zmemcmp _fmemcmp
224*b3be2f66SJerome Forissier #    define zmemzero(dest, len) _fmemset(dest, 0, len)
225*b3be2f66SJerome Forissier #  else
226*b3be2f66SJerome Forissier #    define zmemcpy memcpy
227*b3be2f66SJerome Forissier #    define zmemcmp memcmp
228*b3be2f66SJerome Forissier #    define zmemzero(dest, len) memset(dest, 0, len)
229*b3be2f66SJerome Forissier #  endif
230*b3be2f66SJerome Forissier #else
231*b3be2f66SJerome Forissier    void ZLIB_INTERNAL zmemcpy OF((Bytef* dest, const Bytef* source, uInt len));
232*b3be2f66SJerome Forissier    int ZLIB_INTERNAL zmemcmp OF((const Bytef* s1, const Bytef* s2, uInt len));
233*b3be2f66SJerome Forissier    void ZLIB_INTERNAL zmemzero OF((Bytef* dest, uInt len));
234*b3be2f66SJerome Forissier #endif
235*b3be2f66SJerome Forissier 
236*b3be2f66SJerome Forissier /* Diagnostic functions */
237*b3be2f66SJerome Forissier #ifdef ZLIB_DEBUG
238*b3be2f66SJerome Forissier #  include <stdio.h>
239*b3be2f66SJerome Forissier    extern int ZLIB_INTERNAL z_verbose;
240*b3be2f66SJerome Forissier    extern void ZLIB_INTERNAL z_error OF((char *m));
241*b3be2f66SJerome Forissier #  define Assert(cond,msg) {if(!(cond)) z_error(msg);}
242*b3be2f66SJerome Forissier #  define Trace(x) {if (z_verbose>=0) fprintf x ;}
243*b3be2f66SJerome Forissier #  define Tracev(x) {if (z_verbose>0) fprintf x ;}
244*b3be2f66SJerome Forissier #  define Tracevv(x) {if (z_verbose>1) fprintf x ;}
245*b3be2f66SJerome Forissier #  define Tracec(c,x) {if (z_verbose>0 && (c)) fprintf x ;}
246*b3be2f66SJerome Forissier #  define Tracecv(c,x) {if (z_verbose>1 && (c)) fprintf x ;}
247*b3be2f66SJerome Forissier #else
248*b3be2f66SJerome Forissier #  define Assert(cond,msg)
249*b3be2f66SJerome Forissier #  define Trace(x)
250*b3be2f66SJerome Forissier #  define Tracev(x)
251*b3be2f66SJerome Forissier #  define Tracevv(x)
252*b3be2f66SJerome Forissier #  define Tracec(c,x)
253*b3be2f66SJerome Forissier #  define Tracecv(c,x)
254*b3be2f66SJerome Forissier #endif
255*b3be2f66SJerome Forissier 
256*b3be2f66SJerome Forissier #ifndef Z_SOLO
257*b3be2f66SJerome Forissier    voidpf ZLIB_INTERNAL zcalloc OF((voidpf opaque, unsigned items,
258*b3be2f66SJerome Forissier                                     unsigned size));
259*b3be2f66SJerome Forissier    void ZLIB_INTERNAL zcfree  OF((voidpf opaque, voidpf ptr));
260*b3be2f66SJerome Forissier #endif
261*b3be2f66SJerome Forissier 
262*b3be2f66SJerome Forissier #define ZALLOC(strm, items, size) \
263*b3be2f66SJerome Forissier            (*((strm)->zalloc))((strm)->opaque, (items), (size))
264*b3be2f66SJerome Forissier #define ZFREE(strm, addr)  (*((strm)->zfree))((strm)->opaque, (voidpf)(addr))
265*b3be2f66SJerome Forissier #define TRY_FREE(s, p) {if (p) ZFREE(s, p);}
266*b3be2f66SJerome Forissier 
267*b3be2f66SJerome Forissier /* Reverse the bytes in a 32-bit value */
268*b3be2f66SJerome Forissier #define ZSWAP32(q) ((((q) >> 24) & 0xff) + (((q) >> 8) & 0xff00) + \
269*b3be2f66SJerome Forissier                     (((q) & 0xff00) << 8) + (((q) & 0xff) << 24))
270*b3be2f66SJerome Forissier 
271*b3be2f66SJerome Forissier #endif /* ZUTIL_H */
272