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