Avoid shadowing, and a bit of constification while I'm at it.
[openssl.git] / e_os.h
1 /* e_os.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #ifndef HEADER_E_OS_H
60 #define HEADER_E_OS_H
61
62 #ifdef  __cplusplus
63 extern "C" {
64 #endif
65
66 /* Used to checking reference counts, most while doing perl5 stuff :-) */
67 #ifdef REF_PRINT
68 #undef REF_PRINT
69 #define REF_PRINT(a,b)  fprintf(stderr,"%08X:%4d:%s\n",(int)b,b->references,a)
70 #endif
71
72 #ifndef DEVRANDOM
73 /* set this to your 'random' device if you have one.
74  * My default, we will try to read this file */
75 #define DEVRANDOM "/dev/urandom"
76 #endif
77
78 /********************************************************************
79  The Microsoft section
80  ********************************************************************/
81 /* The following is used becaue of the small stack in some
82  * Microsoft operating systems */
83 #if defined(WIN16) || defined(MSDOS)
84 #  define MS_STATIC     static
85 #else
86 #  define MS_STATIC
87 #endif
88
89 #if defined(WIN32) || defined(WIN16)
90 #  ifndef WINDOWS
91 #    define WINDOWS
92 #  endif
93 #  ifndef MSDOS
94 #    define MSDOS
95 #  endif
96 #endif
97
98 #ifdef WIN32
99 #define get_last_sys_error()    GetLastError()
100 #define clear_sys_error()       SetLastError(0)
101 /* These are defined in wincrypt.h and can cause problems */
102 #undef X509_NAME
103 #undef PKCS7_SIGNER_INFO
104 #if !defined(WINNT)
105 #define WIN_CONSOLE_BUG
106 #endif
107 #else
108 #define get_last_sys_error()    errno
109 #define clear_sys_error()       errno=0
110 #endif
111
112 #ifdef WINDOWS
113 #define get_last_socket_error() WSAGetLastError()
114 #define clear_socket_error()    WSASetLastError(0)
115 #define readsocket(s,b,n)       recv((s),(b),(n),0)
116 #define writesocket(s,b,n)      send((s),(b),(n),0)
117 #define EADDRINUSE              WSAEADDRINUSE
118 #else
119 #define get_last_socket_error() errno
120 #define clear_socket_error()    errno=0
121 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
122 #define closesocket(s)          close(s)
123 #define readsocket(s,b,n)       read((s),(b),(n))
124 #define writesocket(s,b,n)      write((s),(b),(n))
125 #endif
126
127 #ifdef WIN16
128 #  define NO_FP_API
129 #  define MS_CALLBACK   _far _loadds
130 #  define MS_FAR        _far
131 #else
132 #  define MS_CALLBACK
133 #  define MS_FAR
134 #endif
135
136 #ifdef NO_STDIO
137 #  define NO_FP_API
138 #endif
139
140 #if defined(WINDOWS) || defined(MSDOS)
141
142 #ifndef S_IFDIR
143 #define S_IFDIR _S_IFDIR
144 #endif
145
146 #ifndef S_IFMT
147 #define S_IFMT  _S_IFMT
148
149 #if !defined(WINNT)
150 #define NO_SYSLOG
151 #endif
152 #define NO_DIRENT
153
154 #endif
155
156 #  ifdef WINDOWS
157 #    include <windows.h>
158 #    include <stddef.h>
159 #    include <errno.h>
160 #    include <string.h>
161 #    include <malloc.h>
162 #  endif
163 #  include <io.h>
164 #  include <fcntl.h>
165
166 #if defined (__BORLANDC__)
167 #define _setmode setmode
168 #define _O_TEXT O_TEXT
169 #define _O_BINARY O_BINARY
170 #define _int64 __int64
171 #endif
172
173 #if defined(WIN16) && !defined(MONOLITH) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
174 #  define EXIT(n) { if (n == 0) _wsetexit(_WINEXITNOPERSIST); return(n); }
175 #else
176 #  define EXIT(n)               return(n);
177 #endif
178 #  define LIST_SEPARATOR_CHAR ';'
179 #ifndef X_OK
180 #  define X_OK  0
181 #endif
182 #ifndef W_OK
183 #  define W_OK  2
184 #endif
185 #ifndef R_OK
186 #  define R_OK  4
187 #endif
188 #  define OPENSSL_CONF  "openssl.cnf"
189 #  define SSLEAY_CONF   OPENSSL_CONF
190 #  define NUL_DEV       "nul"
191 #  define RFILE         ".rnd"
192
193 #else /* The non-microsoft world world */
194
195 #  if defined(__VMS) && !defined(VMS)
196 #  define VMS 1
197 #  endif
198
199 #  ifdef VMS
200   /* some programs don't include stdlib, so exit() and others give implicit 
201      function warnings */
202 #    include <stdlib.h>
203 #    if defined(__DECC)
204 #      include <unistd.h>
205 #    else
206 #      include <unixlib.h>
207 #    endif
208 #    define OPENSSL_CONF        "openssl.cnf"
209 #    define SSLEAY_CONF         OPENSSL_CONF
210 #    define RFILE               ".rnd"
211 #    define LIST_SEPARATOR_CHAR ','
212 #    define NUL_DEV             "NLA0:"
213   /* We need to do this, because DEC C converts exit code 0 to 1, but not 1
214      to 0.  We will convert 1 to 3!  Also, add the inhibit message bit... */
215 #    ifndef MONOLITH
216 #      define EXIT(n)           do { int __VMS_EXIT = n; \
217                                      if (__VMS_EXIT == 1) __VMS_EXIT = 3; \
218                                      __VMS_EXIT |= 0x10000000; \
219                                      exit(n); return(n); } while(0)
220 #    else
221 #      define EXIT(n)           do { int __VMS_EXIT = n; \
222                                      if (__VMS_EXIT == 1) __VMS_EXIT = 3; \
223                                      __VMS_EXIT |= 0x10000000; \
224                                      return(n); } while(0)
225 #    endif
226 #  else
227 #    include <unistd.h>
228
229 #    define OPENSSL_CONF        "openssl.cnf"
230 #    define SSLEAY_CONF         OPENSSL_CONF
231 #    define RFILE               ".rnd"
232 #    define LIST_SEPARATOR_CHAR ':'
233 #    define NUL_DEV             "/dev/null"
234 #    ifndef MONOLITH
235 #      define EXIT(n)           exit(n); return(n)
236 #    else
237 #      define EXIT(n)           return(n)
238 #    endif
239 #  endif
240
241 #  define SSLeay_getpid()       getpid()
242
243 #endif
244
245 /* Definitions of GLOBAL and EXTERN, to define and declare certain global
246    symbols that, with some compilers under VMS, have to be defined and
247    declared explicitely with globaldef and globalref.  On other OS:es,
248    these macros are defined with something sensible. */
249 #if defined(VMS) && !defined(__DECC)
250 #define EXTERN globalref
251 #define GLOBAL globaldef
252 #else
253 #define EXTERN extern
254 #define GLOBAL
255 #endif
256
257 /*************/
258
259 #ifdef USE_SOCKETS
260 #  if defined(WINDOWS) || defined(MSDOS)
261       /* windows world */
262
263 #    ifdef NO_SOCK
264 #      define SSLeay_Write(a,b,c)       (-1)
265 #      define SSLeay_Read(a,b,c)        (-1)
266 #      define SHUTDOWN(fd)              close(fd)
267 #      define SHUTDOWN2(fd)             close(fd)
268 #    else
269 #      include <winsock.h>
270 extern HINSTANCE _hInstance;
271 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
272 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
273 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
274 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
275 #    endif
276
277
278 #  else
279
280 #    include <sys/types.h>
281 #    ifndef VMS
282 #      include <sys/param.h>
283 #    endif
284 #    include <sys/time.h> /* Needed under linux for FD_XXX */
285
286 #    include <netdb.h>
287 #    if defined(VMS) && !defined(__DECC)
288 #      include <socket.h>
289 #      include <in.h>
290 #    else
291 #      include <sys/socket.h>
292 #      ifdef FILIO_H
293 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
294 #      endif
295 #      include <netinet/in.h>
296 #    endif
297
298 #    if defined(NeXT) || defined(_NEXT_SOURCE)
299 #      include <sys/fcntl.h>
300 #      include <sys/types.h>
301 #    endif
302
303 #    ifdef AIX
304 #      include <sys/select.h>
305 #    endif
306
307 #    if defined(sun)
308 #      include <sys/filio.h>
309 #    else
310 #      ifndef VMS
311 #        include <sys/ioctl.h>
312 #      else
313          /* ioctl is only in VMS > 7.0 and when socketshr is not used */
314 #        if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
315 #          include <sys/ioctl.h>
316 #        endif
317 #      endif
318 #    endif
319
320 #    ifdef VMS
321 #      include <unixio.h>
322 #      if defined(TCPIP_TYPE_SOCKETSHR)
323 #        include <socketshr.h>
324 #      endif
325 #    endif
326
327 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
328 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
329 #    define SHUTDOWN(fd)    { shutdown((fd),0); close((fd)); }
330 #    define SHUTDOWN2(fd)   { shutdown((fd),2); close((fd)); }
331 #    define INVALID_SOCKET      (-1)
332 #  endif
333 #endif
334
335 #if defined(THREADS) || defined(sun)
336 #ifndef _REENTRANT
337 #define _REENTRANT
338 #endif
339 #endif
340
341 /***********************************************/
342
343 /* do we need to do this for getenv.
344  * Just define getenv for use under windows */
345
346 #ifdef WIN16
347 /* How to do this needs to be thought out a bit more.... */
348 /*char *GETENV(char *);
349 #define Getenv  GETENV*/
350 #define Getenv  getenv
351 #else
352 #define Getenv getenv
353 #endif
354
355 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
356
357 #ifdef sgi
358 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
359 #endif
360
361 #ifdef NO_MD2
362 #define MD2_Init MD2Init
363 #define MD2_Update MD2Update
364 #define MD2_Final MD2Final
365 #define MD2_DIGEST_LENGTH 16
366 #endif
367 #ifdef NO_MD5
368 #define MD5_Init MD5Init 
369 #define MD5_Update MD5Update
370 #define MD5_Final MD5Final
371 #define MD5_DIGEST_LENGTH 16
372 #endif
373
374 #ifdef  __cplusplus
375 }
376 #endif
377
378 #endif
379