Don't make links in INSTALL doc - also, work first time!
[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 #if defined(NOCONST)
79 #define const
80 #endif
81
82 /********************************************************************
83  The Microsoft section
84  ********************************************************************/
85 /* The following is used becaue of the small stack in some
86  * Microsoft operating systems */
87 #if defined(WIN16) || defined(MSDOS)
88 #  define MS_STATIC     static
89 #else
90 #  define MS_STATIC
91 #endif
92
93 #if defined(WIN32) || defined(WIN16)
94 #  ifndef WINDOWS
95 #    define WINDOWS
96 #  endif
97 #  ifndef MSDOS
98 #    define MSDOS
99 #  endif
100 #endif
101
102 #ifdef WIN32
103 #define get_last_sys_error()    GetLastError()
104 #define clear_sys_error()       SetLastError(0)
105 #else
106 #define get_last_sys_error()    errno
107 #define clear_sys_error()       errno=0
108 #endif
109
110 #ifdef WINDOWS
111 #define get_last_socket_error() WSAGetLastError()
112 #define clear_socket_error()    WSASetLastError(0)
113 #define readsocket(s,b,n)       recv((s),(b),(n),0)
114 #define writesocket(s,b,n)      send((s),(b),(n),0)
115 #define EADDRINUSE              WSAEADDRINUSE
116 #else
117 #define get_last_socket_error() errno
118 #define clear_socket_error()    errno=0
119 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
120 #define closesocket(s)          close(s)
121 #define readsocket(s,b,n)       read((s),(b),(n))
122 #define writesocket(s,b,n)      write((s),(b),(n))
123 #endif
124
125 #ifdef WIN16
126 #  define NO_FP_API
127 #  define MS_CALLBACK   _far _loadds
128 #  define MS_FAR        _far
129 #else
130 #  define MS_CALLBACK
131 #  define MS_FAR
132 #endif
133
134 #ifdef NO_STDIO
135 #  define NO_FP_API
136 #endif
137
138 #if defined(WINDOWS) || defined(MSDOS)
139
140 #ifndef S_IFDIR
141 #define S_IFDIR _S_IFDIR
142 #endif
143
144 #ifndef S_IFMT
145 #define S_IFMT  _S_IFMT
146 #endif
147
148 #define strncasecmp(a,b,c)      strnicmp((a),(b),(c))
149
150 #  ifdef WINDOWS
151 #    include <windows.h>
152 #    include <stddef.h>
153 #    include <errno.h>
154 #    include <string.h>
155 #    include <malloc.h>
156 #  endif
157 #  include <io.h>
158 #  include <fcntl.h>
159
160 #if defined(WIN16) && !defined(MONOLITH) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
161 #  define EXIT(n) { if (n == 0) _wsetexit(_WINEXITNOPERSIST); return(n); }
162 #else
163 #  define EXIT(n)               return(n);
164 #endif
165 #  define LIST_SEPARATOR_CHAR ';'
166 #ifndef X_OK
167 #  define X_OK  0
168 #endif
169 #ifndef W_OK
170 #  define W_OK  2
171 #endif
172 #ifndef R_OK
173 #  define R_OK  4
174 #endif
175 #  define OPENSSL_CONF  "openssl.cnf"
176 #  define SSLEAY_CONF   OPENSSL_CONF
177 #  define NUL_DEV       "nul"
178 #  define RFILE         ".rnd"
179
180 #else /* The non-microsoft world world */
181
182 #  ifdef VMS
183 #    include <unixlib.h>
184 #  else
185 #    include <unistd.h>
186 #  endif
187
188 #  define OPENSSL_CONF  "openssl.cnf"
189 #  define SSLEAY_CONF   OPENSSL_CONF
190 #  define RFILE         ".rnd"
191 #  define LIST_SEPARATOR_CHAR ':'
192 #  ifndef MONOLITH
193 #    define EXIT(n)             exit(n); return(n)
194 #  else
195 #    define EXIT(n)             return(n)
196 #  endif
197 #  define NUL_DEV               "/dev/null"
198
199 #  define SSLeay_getpid()       getpid()
200
201 #endif
202
203 /*************/
204
205 #ifdef USE_SOCKETS
206 #  if defined(WINDOWS) || defined(MSDOS)
207       /* windows world */
208
209 #    ifdef NO_SOCK
210 #      define SSLeay_Write(a,b,c)       (-1)
211 #      define SSLeay_Read(a,b,c)        (-1)
212 #      define SHUTDOWN(fd)              close(fd)
213 #      define SHUTDOWN2(fd)             close(fd)
214 #    else
215 #      include <winsock.h>
216 extern HINSTANCE _hInstance;
217 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
218 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
219 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
220 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
221 #    endif
222
223
224 #  else
225
226 #    ifndef VMS
227       /* unix world */
228 #      include <netdb.h>
229 #      include <sys/types.h>
230 #      include <sys/socket.h>
231 #      ifdef FILIO_H
232 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
233 #      endif
234 #      include <sys/param.h>
235 #      include <sys/time.h> /* Needed under linux for FD_XXX */
236 #      include <netinet/in.h>
237 #    endif
238
239 #    if defined(NeXT) || defined(_NEXT_SOURCE)
240 #      include <sys/fcntl.h>
241 #      include <sys/types.h>
242 #    endif
243
244 #    ifdef AIX
245 #      include <sys/select.h>
246 #    endif
247
248 #    if defined(sun)
249 #      include <sys/filio.h>
250 #    else
251 #      include <sys/ioctl.h>
252 #    endif
253
254 #    ifdef VMS
255 #      include <unixio.h>
256 #    endif
257
258 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
259 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
260 #    define SHUTDOWN(fd)    { shutdown((fd),0); close((fd)); }
261 #    define SHUTDOWN2(fd)   { shutdown((fd),2); close((fd)); }
262 #    define INVALID_SOCKET      (-1)
263 #  endif
264 #endif
265
266 #if defined(THREADS) || defined(sun)
267 #ifndef _REENTRANT
268 #define _REENTRANT
269 #endif
270 #endif
271
272 /***********************************************/
273
274 #ifndef NOPROTO
275 #define P_CC_CC const void *,const void *
276 #define P_I_I           int,int 
277 #define P_I_I_P         int,int,char *
278 #define P_I_I_P_I       int,int,char *,int
279 #define P_IP_I_I_P_I    int *,int,int,char *,int
280 #define P_V             void 
281 #else
282 #define P_CC_CC
283 #define P_I_I
284 #define P_I_I_P
285 #define P_IP_I_I_P_I
286 #define P_I_I_P_I
287 #define P_V
288 #endif
289
290 /* not used yet */
291 #define CS_BEGIN
292 #define CS_END
293
294 /* do we need to do this for getenv.
295  * Just define getenv for use under windows */
296
297 #ifdef WIN16
298 /* How to do this needs to be thought out a bit more.... */
299 /*char *GETENV(char *);
300 #define Getenv  GETENV*/
301 #define Getenv  getenv
302 #else
303 #define Getenv getenv
304 #endif
305
306 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
307
308 #ifdef sgi
309 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
310 #endif
311
312 #ifdef NO_MD2
313 #define MD2_Init MD2Init
314 #define MD2_Update MD2Update
315 #define MD2_Final MD2Final
316 #define MD2_DIGEST_LENGTH 16
317 #endif
318 #ifdef NO_MD5
319 #define MD5_Init MD5Init 
320 #define MD5_Update MD5Update
321 #define MD5_Final MD5Final
322 #define MD5_DIGEST_LENGTH 16
323 #endif
324
325 #ifdef  __cplusplus
326 }
327 #endif
328
329 #endif
330