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