1e06e0a2fe50eec3b6c39ca952ac6e9920c21993
[oweals/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 #include <openssl/opensslconf.h>
63
64 #include <openssl/e_os2.h>
65 /* <openssl/e_os2.h> contains what we can justify to make visible
66  * to the outside; this file e_os.h is not part of the exported
67  * interface. */
68
69 #ifdef  __cplusplus
70 extern "C" {
71 #endif
72
73 /* Used to checking reference counts, most while doing perl5 stuff :-) */
74 #ifdef REF_PRINT
75 #undef REF_PRINT
76 #define REF_PRINT(a,b)  fprintf(stderr,"%08X:%4d:%s\n",(int)b,b->references,a)
77 #endif
78
79 #ifndef DEVRANDOM
80 /* set this to your 'random' device if you have one.
81  * My default, we will try to read this file */
82 #define DEVRANDOM "/dev/urandom"
83 #endif
84
85 #if defined(__MWERKS__) && defined(macintosh)
86 # if macintosh==1
87 #  ifndef MAC_OS_GUSI_SOURCE
88 #    define MAC_OS_pre_X
89 #    define NO_SYS_TYPES_H
90 #  endif
91 #  define NO_SYS_PARAM_H
92 #  define NO_CHMOD
93 #  define NO_SYSLOG
94 #  undef  DEVRANDOM
95 #  define GETPID_IS_MEANINGLESS
96 # endif
97 #endif
98
99 /********************************************************************
100  The Microsoft section
101  ********************************************************************/
102 /* The following is used becaue of the small stack in some
103  * Microsoft operating systems */
104 #if defined(WIN16) || defined(MSDOS)
105 #  define MS_STATIC     static
106 #else
107 #  define MS_STATIC
108 #endif
109
110 #if defined(_WIN32) && !defined(WIN32)
111 #  define WIN32
112 #endif
113
114 #if defined(WIN32) || defined(WIN16)
115 #  ifndef WINDOWS
116 #    define WINDOWS
117 #  endif
118 #  ifndef MSDOS
119 #    define MSDOS
120 #  endif
121 #endif
122
123 #if defined(MSDOS) && !defined(GETPID_IS_MEANINGLESS)
124 #  define GETPID_IS_MEANINGLESS
125 #endif
126
127 #ifdef WIN32
128 #define get_last_sys_error()    GetLastError()
129 #define clear_sys_error()       SetLastError(0)
130 #if !defined(WINNT)
131 #define WIN_CONSOLE_BUG
132 #endif
133 #else
134 #define get_last_sys_error()    errno
135 #define clear_sys_error()       errno=0
136 #endif
137
138 #ifdef WINDOWS
139 #define get_last_socket_error() WSAGetLastError()
140 #define clear_socket_error()    WSASetLastError(0)
141 #define readsocket(s,b,n)       recv((s),(b),(n),0)
142 #define writesocket(s,b,n)      send((s),(b),(n),0)
143 #define EADDRINUSE              WSAEADDRINUSE
144 #elif defined(MAC_OS_pre_X)
145 #define get_last_socket_error() errno
146 #define clear_socket_error()    errno=0
147 #define closesocket(s)          MacSocket_close(s)
148 #define readsocket(s,b,n)       MacSocket_recv((s),(b),(n),true)
149 #define writesocket(s,b,n)      MacSocket_send((s),(b),(n))
150 #else
151 #define get_last_socket_error() errno
152 #define clear_socket_error()    errno=0
153 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
154 #define closesocket(s)          close(s)
155 #define readsocket(s,b,n)       read((s),(b),(n))
156 #define writesocket(s,b,n)      write((s),(b),(n))
157 #endif
158
159 #ifdef WIN16
160 #  define NO_FP_API
161 #  define MS_CALLBACK   _far _loadds
162 #  define MS_FAR        _far
163 #else
164 #  define MS_CALLBACK
165 #  define MS_FAR
166 #endif
167
168 #ifdef NO_STDIO
169 #  define NO_FP_API
170 #endif
171
172 #if defined(WINDOWS) || defined(MSDOS)
173
174 #  ifndef S_IFDIR
175 #    define S_IFDIR     _S_IFDIR
176 #  endif
177
178 #  ifndef S_IFMT
179 #    define S_IFMT      _S_IFMT
180 #  endif
181
182 #  if !defined(WINNT)
183 #    define NO_SYSLOG
184 #  endif
185 #  define NO_DIRENT
186
187 #  ifdef WINDOWS
188 #    include <windows.h>
189 #    include <stddef.h>
190 #    include <errno.h>
191 #    include <string.h>
192 #    include <malloc.h>
193 #  endif
194 #  include <io.h>
195 #  include <fcntl.h>
196
197 #  if defined (__BORLANDC__)
198 #    define _setmode setmode
199 #    define _O_TEXT O_TEXT
200 #    define _O_BINARY O_BINARY
201 #    define _int64 __int64
202 #    define _kbhit kbhit
203 #  endif
204
205 #  if defined(WIN16) && !defined(MONOLITH) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
206 #    define EXIT(n) { if (n == 0) _wsetexit(_WINEXITNOPERSIST); return(n); }
207 #  else
208 #    define EXIT(n)             return(n);
209 #  endif
210 #  define LIST_SEPARATOR_CHAR ';'
211 #  ifndef X_OK
212 #    define X_OK        0
213 #  endif
214 #  ifndef W_OK
215 #    define W_OK        2
216 #  endif
217 #  ifndef R_OK
218 #    define R_OK        4
219 #  endif
220 #  define OPENSSL_CONF  "openssl.cnf"
221 #  define SSLEAY_CONF   OPENSSL_CONF
222 #  define NUL_DEV       "nul"
223 #  define RFILE         ".rnd"
224
225 #else /* The non-microsoft world world */
226
227 #  if defined(__VMS) && !defined(VMS)
228 #  define VMS 1
229 #  endif
230
231 #  ifdef VMS
232   /* some programs don't include stdlib, so exit() and others give implicit 
233      function warnings */
234 #    include <stdlib.h>
235 #    if defined(__DECC)
236 #      include <unistd.h>
237 #    else
238 #      include <unixlib.h>
239 #    endif
240 #    define OPENSSL_CONF        "openssl.cnf"
241 #    define SSLEAY_CONF         OPENSSL_CONF
242 #    define RFILE               ".rnd"
243 #    define LIST_SEPARATOR_CHAR ','
244 #    define NUL_DEV             "NLA0:"
245   /* We need to do this, because DEC C converts exit code 0 to 1, but not 1
246      to 0.  We will convert 1 to 3!  Also, add the inhibit message bit... */
247 #    ifndef MONOLITH
248 #      define EXIT(n)           do { int __VMS_EXIT = n; \
249                                      if (__VMS_EXIT == 1) __VMS_EXIT = 3; \
250                                      __VMS_EXIT |= 0x10000000; \
251                                      exit(n); return(n); } while(0)
252 #    else
253 #      define EXIT(n)           do { int __VMS_EXIT = n; \
254                                      if (__VMS_EXIT == 1) __VMS_EXIT = 3; \
255                                      __VMS_EXIT |= 0x10000000; \
256                                      return(n); } while(0)
257 #    endif
258 #    define NO_SYS_PARAM_H
259 #  else
260      /* !defined VMS */
261 #    ifdef OPENSSL_UNISTD
262 #      include OPENSSL_UNISTD
263 #    else
264 #      include <unistd.h>
265 #    endif
266 #    ifndef NO_SYS_TYPES_H
267 #      include <sys/types.h>
268 #    endif
269 #    ifdef NeXT
270 #      define pid_t int /* pid_t is missing on NEXTSTEP/OPENSTEP */
271 #    endif
272
273 #    define OPENSSL_CONF        "openssl.cnf"
274 #    define SSLEAY_CONF         OPENSSL_CONF
275 #    define RFILE               ".rnd"
276 #    define LIST_SEPARATOR_CHAR ':'
277 #    define NUL_DEV             "/dev/null"
278 #    ifndef MONOLITH
279 #      define EXIT(n)           exit(n); return(n)
280 #    else
281 #      define EXIT(n)           return(n)
282 #    endif
283 #  endif
284
285 #  define SSLeay_getpid()       getpid()
286
287 #endif
288
289
290 /*************/
291
292 #ifdef USE_SOCKETS
293 #  if defined(WINDOWS) || defined(MSDOS)
294       /* windows world */
295
296 #    ifdef NO_SOCK
297 #      define SSLeay_Write(a,b,c)       (-1)
298 #      define SSLeay_Read(a,b,c)        (-1)
299 #      define SHUTDOWN(fd)              close(fd)
300 #      define SHUTDOWN2(fd)             close(fd)
301 #    else
302 #      include <winsock.h>
303 extern HINSTANCE _hInstance;
304 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
305 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
306 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
307 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
308 #    endif
309
310 #  elif defined(MAC_OS_pre_X)
311
312 #    include "MacSocket.h"
313 #    define SSLeay_Write(a,b,c)         MacSocket_send((a),(b),(c))
314 #    define SSLeay_Read(a,b,c)          MacSocket_recv((a),(b),(c),true)
315 #    define SHUTDOWN(fd)                MacSocket_close(fd)
316 #    define SHUTDOWN2(fd)               MacSocket_close(fd)
317
318 #  else
319
320 #    ifndef NO_SYS_PARAM_H
321 #      include <sys/param.h>
322 #    endif
323 #    include <sys/time.h> /* Needed under linux for FD_XXX */
324
325 #    include <netdb.h>
326 #    if defined(VMS) && !defined(__DECC)
327 #      include <socket.h>
328 #      include <in.h>
329 #    else
330 #      include <sys/socket.h>
331 #      ifdef FILIO_H
332 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
333 #      endif
334 #      include <netinet/in.h>
335 #    endif
336
337 #    if defined(NeXT) || defined(_NEXT_SOURCE)
338 #      include <sys/fcntl.h>
339 #      include <sys/types.h>
340 #    endif
341
342 #    ifdef AIX
343 #      include <sys/select.h>
344 #    endif
345
346 #    if defined(sun)
347 #      include <sys/filio.h>
348 #    else
349 #      ifndef VMS
350 #        include <sys/ioctl.h>
351 #      else
352          /* ioctl is only in VMS > 7.0 and when socketshr is not used */
353 #        if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
354 #          include <sys/ioctl.h>
355 #        endif
356 #      endif
357 #    endif
358
359 #    ifdef VMS
360 #      include <unixio.h>
361 #      if defined(TCPIP_TYPE_SOCKETSHR)
362 #        include <socketshr.h>
363 #      endif
364 #    endif
365
366 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
367 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
368 #    define SHUTDOWN(fd)    { shutdown((fd),0); closesocket((fd)); }
369 #    define SHUTDOWN2(fd)   { shutdown((fd),2); closesocket((fd)); }
370 #    define INVALID_SOCKET      (-1)
371 #  endif
372 #endif
373
374 #if defined(THREADS) || defined(sun)
375 #ifndef _REENTRANT
376 #define _REENTRANT
377 #endif
378 #endif
379
380 /***********************************************/
381
382 /* do we need to do this for getenv.
383  * Just define getenv for use under windows */
384
385 #ifdef WIN16
386 /* How to do this needs to be thought out a bit more.... */
387 /*char *GETENV(char *);
388 #define Getenv  GETENV*/
389 #define Getenv  getenv
390 #else
391 #define Getenv getenv
392 #endif
393
394 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
395
396 #ifdef sgi
397 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
398 #endif
399 #ifdef SNI
400 #define IRIX_CC_BUG     /* CDS++ up to V2.0Bsomething suffered from the same bug.*/
401 #endif
402
403 #ifdef NO_MD2
404 #define MD2_Init MD2Init
405 #define MD2_Update MD2Update
406 #define MD2_Final MD2Final
407 #define MD2_DIGEST_LENGTH 16
408 #endif
409 #ifdef NO_MD5
410 #define MD5_Init MD5Init 
411 #define MD5_Update MD5Update
412 #define MD5_Final MD5Final
413 #define MD5_DIGEST_LENGTH 16
414 #endif
415
416 #ifdef  __cplusplus
417 }
418 #endif
419
420 #endif
421