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