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