make update
[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 #  ifdef __MINGW32__
198 #    define ssize_t long
199 #  endif
200
201 #  if defined (__BORLANDC__)
202 #    define _setmode setmode
203 #    define _O_TEXT O_TEXT
204 #    define _O_BINARY O_BINARY
205 #    define _int64 __int64
206 #    define _kbhit kbhit
207 #  endif
208
209 #  if defined(WIN16) && !defined(MONOLITH) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
210 #    define EXIT(n) { if (n == 0) _wsetexit(_WINEXITNOPERSIST); return(n); }
211 #  else
212 #    define EXIT(n)             return(n);
213 #  endif
214 #  define LIST_SEPARATOR_CHAR ';'
215 #  ifndef X_OK
216 #    define X_OK        0
217 #  endif
218 #  ifndef W_OK
219 #    define W_OK        2
220 #  endif
221 #  ifndef R_OK
222 #    define R_OK        4
223 #  endif
224 #  define OPENSSL_CONF  "openssl.cnf"
225 #  define SSLEAY_CONF   OPENSSL_CONF
226 #  define NUL_DEV       "nul"
227 #  define RFILE         ".rnd"
228
229 #else /* The non-microsoft world world */
230
231 #  if defined(__VMS) && !defined(VMS)
232 #  define VMS 1
233 #  endif
234
235 #  ifdef VMS
236   /* some programs don't include stdlib, so exit() and others give implicit 
237      function warnings */
238 #    include <stdlib.h>
239 #    if defined(__DECC)
240 #      include <unistd.h>
241 #    else
242 #      include <unixlib.h>
243 #    endif
244 #    define OPENSSL_CONF        "openssl.cnf"
245 #    define SSLEAY_CONF         OPENSSL_CONF
246 #    define RFILE               ".rnd"
247 #    define LIST_SEPARATOR_CHAR ','
248 #    define NUL_DEV             "NLA0:"
249   /* We need to do this since VMS has the following coding on status codes:
250
251      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
252                The important thing to know is that odd numbers are considered
253                good, while even ones are considered errors.
254      Bits 3-15: actual status number
255      Bits 16-27: facility number.  0 is considered "unknown"
256      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
257                  output the message (which, for random codes, just looks ugly)
258
259      So, what we do here is to change 0 to 1 to get the default success status,
260      and everything else is shifted up to fit into the status number field, and
261      the status is tagged as an error, which I believe is what is wanted here.
262      -- Richard Levitte
263   */
264 #    if !defined(MONOLITH) || defined(OPENSSL_C)
265 #      define EXIT(n)           do { int __VMS_EXIT = n; \
266                                      if (__VMS_EXIT == 0) \
267                                        __VMS_EXIT = 1; \
268                                      else \
269                                        __VMS_EXIT = (n << 3) | 2; \
270                                      __VMS_EXIT |= 0x10000000; \
271                                      exit(__VMS_EXIT); \
272                                      return(__VMS_EXIT); } while(0)
273 #    else
274 #      define EXIT(n)           return(n)
275 #    endif
276 #    define NO_SYS_PARAM_H
277 #  else
278      /* !defined VMS */
279 #    ifdef OPENSSL_UNISTD
280 #      include OPENSSL_UNISTD
281 #    else
282 #      include <unistd.h>
283 #    endif
284 #    ifndef NO_SYS_TYPES_H
285 #      include <sys/types.h>
286 #    endif
287 #    ifdef NeXT
288 #      define pid_t int /* pid_t is missing on NEXTSTEP/OPENSTEP
289                          * (unless when compiling with -D_POSIX_SOURCE,
290                          * which doesn't work for us) */
291 #      define ssize_t int /* ditto */
292 #    endif
293
294 #    define OPENSSL_CONF        "openssl.cnf"
295 #    define SSLEAY_CONF         OPENSSL_CONF
296 #    define RFILE               ".rnd"
297 #    define LIST_SEPARATOR_CHAR ':'
298 #    define NUL_DEV             "/dev/null"
299 #    ifndef MONOLITH
300 #      define EXIT(n)           exit(n); return(n)
301 #    else
302 #      define EXIT(n)           return(n)
303 #    endif
304 #  endif
305
306 #  define SSLeay_getpid()       getpid()
307
308 #endif
309
310
311 /*************/
312
313 #ifdef USE_SOCKETS
314 #  if defined(WINDOWS) || defined(MSDOS)
315       /* windows world */
316
317 #    ifdef NO_SOCK
318 #      define SSLeay_Write(a,b,c)       (-1)
319 #      define SSLeay_Read(a,b,c)        (-1)
320 #      define SHUTDOWN(fd)              close(fd)
321 #      define SHUTDOWN2(fd)             close(fd)
322 #    else
323 #      include <winsock.h>
324 extern HINSTANCE _hInstance;
325 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
326 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
327 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
328 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
329 #    endif
330
331 #  elif defined(MAC_OS_pre_X)
332
333 #    include "MacSocket.h"
334 #    define SSLeay_Write(a,b,c)         MacSocket_send((a),(b),(c))
335 #    define SSLeay_Read(a,b,c)          MacSocket_recv((a),(b),(c),true)
336 #    define SHUTDOWN(fd)                MacSocket_close(fd)
337 #    define SHUTDOWN2(fd)               MacSocket_close(fd)
338
339 #  else
340
341 #    ifndef NO_SYS_PARAM_H
342 #      include <sys/param.h>
343 #    endif
344 #    include <sys/time.h> /* Needed under linux for FD_XXX */
345
346 #    include <netdb.h>
347 #    if defined(VMS) && !defined(__DECC)
348 #      include <socket.h>
349 #      include <in.h>
350 #    else
351 #      include <sys/socket.h>
352 #      ifdef FILIO_H
353 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
354 #      endif
355 #      include <netinet/in.h>
356 #    endif
357
358 #    if defined(NeXT) || defined(_NEXT_SOURCE)
359 #      include <sys/fcntl.h>
360 #      include <sys/types.h>
361 #    endif
362
363 #    ifdef AIX
364 #      include <sys/select.h>
365 #    endif
366
367 #    if defined(sun)
368 #      include <sys/filio.h>
369 #    else
370 #      ifndef VMS
371 #        include <sys/ioctl.h>
372 #      else
373          /* ioctl is only in VMS > 7.0 and when socketshr is not used */
374 #        if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
375 #          include <sys/ioctl.h>
376 #        endif
377 #      endif
378 #    endif
379
380 #    ifdef VMS
381 #      include <unixio.h>
382 #      if defined(TCPIP_TYPE_SOCKETSHR)
383 #        include <socketshr.h>
384 #      endif
385 #    endif
386
387 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
388 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
389 #    define SHUTDOWN(fd)    { shutdown((fd),0); closesocket((fd)); }
390 #    define SHUTDOWN2(fd)   { shutdown((fd),2); closesocket((fd)); }
391 #    define INVALID_SOCKET      (-1)
392 #  endif
393 #endif
394
395 #if defined(THREADS) || defined(sun)
396 #ifndef _REENTRANT
397 #define _REENTRANT
398 #endif
399 #endif
400
401 /***********************************************/
402
403 /* do we need to do this for getenv.
404  * Just define getenv for use under windows */
405
406 #ifdef WIN16
407 /* How to do this needs to be thought out a bit more.... */
408 /*char *GETENV(char *);
409 #define Getenv  GETENV*/
410 #define Getenv  getenv
411 #else
412 #define Getenv getenv
413 #endif
414
415 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
416
417 #ifdef sgi
418 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
419 #endif
420 #ifdef SNI
421 #define IRIX_CC_BUG     /* CDS++ up to V2.0Bsomething suffered from the same bug.*/
422 #endif
423
424 #ifdef NO_MD2
425 #define MD2_Init MD2Init
426 #define MD2_Update MD2Update
427 #define MD2_Final MD2Final
428 #define MD2_DIGEST_LENGTH 16
429 #endif
430 #ifdef NO_MD5
431 #define MD5_Init MD5Init 
432 #define MD5_Update MD5Update
433 #define MD5_Final MD5Final
434 #define MD5_DIGEST_LENGTH 16
435 #endif
436
437 #ifdef  __cplusplus
438 }
439 #endif
440
441 #endif
442