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