synchronize with engine branch (some changes were done only
[oweals/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(VXWORKS)
86 #  define NO_SYS_PARAM_H
87 #  define NO_CHMOD
88 #  define NO_SYSLOG
89 #endif
90   
91 #if defined(__MWERKS__) && defined(macintosh)
92 # if macintosh==1
93 #  ifndef MAC_OS_GUSI_SOURCE
94 #    define MAC_OS_pre_X
95 #    define NO_SYS_TYPES_H
96      typedef long ssize_t;
97 #  endif
98 #  define NO_SYS_PARAM_H
99 #  define NO_CHMOD
100 #  define NO_SYSLOG
101 #  undef  DEVRANDOM
102 #  define GETPID_IS_MEANINGLESS
103 # endif
104 #endif
105
106 /********************************************************************
107  The Microsoft section
108  ********************************************************************/
109 /* The following is used becaue of the small stack in some
110  * Microsoft operating systems */
111 #if defined(WIN16) || defined(MSDOS)
112 #  define MS_STATIC     static
113 #else
114 #  define MS_STATIC
115 #endif
116
117 #if defined(_WIN32) && !defined(WIN32) && !defined(__CYGWIN32__)
118 #  define WIN32
119 #endif
120
121 #if (defined(WIN32) || defined(WIN16)) && !defined(__CYGWIN32__)
122 #  ifndef WINDOWS
123 #    define WINDOWS
124 #  endif
125 #  ifndef MSDOS
126 #    define MSDOS
127 #  endif
128 #endif
129
130 #if defined(MSDOS) && !defined(GETPID_IS_MEANINGLESS)
131 #  define GETPID_IS_MEANINGLESS
132 #endif
133
134 #ifdef WIN32
135 #define get_last_sys_error()    GetLastError()
136 #define clear_sys_error()       SetLastError(0)
137 #if !defined(WINNT)
138 #define WIN_CONSOLE_BUG
139 #endif
140 #else
141 #define get_last_sys_error()    errno
142 #define clear_sys_error()       errno=0
143 #endif
144
145 #if defined(WINDOWS) && !defined(__CYGWIN32__)
146 #define get_last_socket_error() WSAGetLastError()
147 #define clear_socket_error()    WSASetLastError(0)
148 #define readsocket(s,b,n)       recv((s),(b),(n),0)
149 #define writesocket(s,b,n)      send((s),(b),(n),0)
150 #define EADDRINUSE              WSAEADDRINUSE
151 #elif defined(MAC_OS_pre_X)
152 #define get_last_socket_error() errno
153 #define clear_socket_error()    errno=0
154 #define closesocket(s)          MacSocket_close(s)
155 #define readsocket(s,b,n)       MacSocket_recv((s),(b),(n),true)
156 #define writesocket(s,b,n)      MacSocket_send((s),(b),(n))
157 #elif defined(VMS)
158 #define get_last_socket_error() errno
159 #define clear_socket_error()    errno=0
160 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
161 #define closesocket(s)          close(s)
162 #define readsocket(s,b,n)       recv((s),(b),(n),0)
163 #define writesocket(s,b,n)      send((s),(b),(n),0)
164 #else
165 #define get_last_socket_error() errno
166 #define clear_socket_error()    errno=0
167 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
168 #define closesocket(s)          close(s)
169 #define readsocket(s,b,n)       read((s),(b),(n))
170 #define writesocket(s,b,n)      write((s),(b),(n))
171 #endif
172
173 #ifdef WIN16
174 #  define NO_FP_API
175 #  define MS_CALLBACK   _far _loadds
176 #  define MS_FAR        _far
177 #else
178 #  define MS_CALLBACK
179 #  define MS_FAR
180 #endif
181
182 #ifdef NO_STDIO
183 #  define NO_FP_API
184 #endif
185
186 #if (defined(WINDOWS) || defined(MSDOS)) && !defined(__CYGWIN32__)
187
188 #  ifndef S_IFDIR
189 #    define S_IFDIR     _S_IFDIR
190 #  endif
191
192 #  ifndef S_IFMT
193 #    define S_IFMT      _S_IFMT
194 #  endif
195
196 #  if !defined(WINNT)
197 #    define NO_SYSLOG
198 #  endif
199 #  define NO_DIRENT
200
201 #  ifdef WINDOWS
202 #    include <windows.h>
203 #    include <stddef.h>
204 #    include <errno.h>
205 #    include <string.h>
206 #    include <malloc.h>
207 #  endif
208 #  include <io.h>
209 #  include <fcntl.h>
210
211 #  define ssize_t long
212
213 #  if defined (__BORLANDC__)
214 #    define _setmode setmode
215 #    define _O_TEXT O_TEXT
216 #    define _O_BINARY O_BINARY
217 #    define _int64 __int64
218 #    define _kbhit kbhit
219 #  endif
220
221 #  if defined(WIN16) && !defined(MONOLITH) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
222 #    define EXIT(n) { if (n == 0) _wsetexit(_WINEXITNOPERSIST); return(n); }
223 #  else
224 #    define EXIT(n)             return(n);
225 #  endif
226 #  define LIST_SEPARATOR_CHAR ';'
227 #  ifndef X_OK
228 #    define X_OK        0
229 #  endif
230 #  ifndef W_OK
231 #    define W_OK        2
232 #  endif
233 #  ifndef R_OK
234 #    define R_OK        4
235 #  endif
236 #  define OPENSSL_CONF  "openssl.cnf"
237 #  define SSLEAY_CONF   OPENSSL_CONF
238 #  define NUL_DEV       "nul"
239 #  define RFILE         ".rnd"
240 #  define DEFAULT_HOME  "C:"
241
242 #else /* The non-microsoft world world */
243
244 #  if defined(__VMS) && !defined(VMS)
245 #  define VMS 1
246 #  endif
247
248 #  ifdef VMS
249   /* some programs don't include stdlib, so exit() and others give implicit 
250      function warnings */
251 #    include <stdlib.h>
252 #    if defined(__DECC)
253 #      include <unistd.h>
254 #    else
255 #      include <unixlib.h>
256 #    endif
257 #    define OPENSSL_CONF        "openssl.cnf"
258 #    define SSLEAY_CONF         OPENSSL_CONF
259 #    define RFILE               ".rnd"
260 #    define LIST_SEPARATOR_CHAR ','
261 #    define NUL_DEV             "NLA0:"
262   /* We need to do this since VMS has the following coding on status codes:
263
264      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
265                The important thing to know is that odd numbers are considered
266                good, while even ones are considered errors.
267      Bits 3-15: actual status number
268      Bits 16-27: facility number.  0 is considered "unknown"
269      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
270                  output the message (which, for random codes, just looks ugly)
271
272      So, what we do here is to change 0 to 1 to get the default success status,
273      and everything else is shifted up to fit into the status number field, and
274      the status is tagged as an error, which I believe is what is wanted here.
275      -- Richard Levitte
276   */
277 #    if !defined(MONOLITH) || defined(OPENSSL_C)
278 #      define EXIT(n)           do { int __VMS_EXIT = n; \
279                                      if (__VMS_EXIT == 0) \
280                                        __VMS_EXIT = 1; \
281                                      else \
282                                        __VMS_EXIT = (n << 3) | 2; \
283                                      __VMS_EXIT |= 0x10000000; \
284                                      exit(__VMS_EXIT); \
285                                      return(__VMS_EXIT); } while(0)
286 #    else
287 #      define EXIT(n)           return(n)
288 #    endif
289 #    define NO_SYS_PARAM_H
290 #  else
291      /* !defined VMS */
292 #    ifdef MPE
293 #      define NO_SYS_PARAM_H
294 #    endif
295 #    ifdef OPENSSL_UNISTD
296 #      include OPENSSL_UNISTD
297 #    else
298 #      include <unistd.h>
299 #    endif
300 #    ifndef NO_SYS_TYPES_H
301 #      include <sys/types.h>
302 #    endif
303 #    if defined(NeXT) || defined(NEWS4)
304 #      define pid_t int /* pid_t is missing on NEXTSTEP/OPENSTEP
305                          * (unless when compiling with -D_POSIX_SOURCE,
306                          * which doesn't work for us) */
307 #      define ssize_t int /* ditto */
308 #    endif
309 #    ifdef NEWS4 /* setvbuf is missing on mips-sony-bsd */
310 #      define setvbuf(a, b, c, d) setbuffer((a), (b), (d))
311        typedef unsigned long clock_t;
312 #    endif
313
314 #    define OPENSSL_CONF        "openssl.cnf"
315 #    define SSLEAY_CONF         OPENSSL_CONF
316 #    define RFILE               ".rnd"
317 #    define LIST_SEPARATOR_CHAR ':'
318 #    define NUL_DEV             "/dev/null"
319 #    ifndef MONOLITH
320 #      define EXIT(n)           exit(n); return(n)
321 #    else
322 #      define EXIT(n)           return(n)
323 #    endif
324 #  endif
325
326 #  define SSLeay_getpid()       getpid()
327
328 #endif
329
330
331 /*************/
332
333 #ifdef USE_SOCKETS
334 #  if defined(WINDOWS) || defined(MSDOS)
335       /* windows world */
336
337 #    ifdef NO_SOCK
338 #      define SSLeay_Write(a,b,c)       (-1)
339 #      define SSLeay_Read(a,b,c)        (-1)
340 #      define SHUTDOWN(fd)              close(fd)
341 #      define SHUTDOWN2(fd)             close(fd)
342 #    else
343 #      include <winsock.h>
344 extern HINSTANCE _hInstance;
345 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
346 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
347 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
348 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
349 #    endif
350
351 #  elif defined(MAC_OS_pre_X)
352
353 #    include "MacSocket.h"
354 #    define SSLeay_Write(a,b,c)         MacSocket_send((a),(b),(c))
355 #    define SSLeay_Read(a,b,c)          MacSocket_recv((a),(b),(c),true)
356 #    define SHUTDOWN(fd)                MacSocket_close(fd)
357 #    define SHUTDOWN2(fd)               MacSocket_close(fd)
358
359 #  else
360
361 #    ifndef NO_SYS_PARAM_H
362 #      include <sys/param.h>
363 #    endif
364 #    ifdef VXWORKS
365 #      include <time.h> 
366 #    elif !defined(MPE)
367 #      include <sys/time.h> /* Needed under linux for FD_XXX */
368 #    endif
369
370 #    include <netdb.h>
371 #    if defined(VMS) && !defined(__DECC)
372 #      include <socket.h>
373 #      include <in.h>
374 #      include <inet.h>
375 #    else
376 #      include <sys/socket.h>
377 #      ifdef FILIO_H
378 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
379 #      endif
380 #      include <netinet/in.h>
381 #      include <arpa/inet.h>
382 #    endif
383
384 #    if defined(NeXT) || defined(_NEXT_SOURCE)
385 #      include <sys/fcntl.h>
386 #      include <sys/types.h>
387 #    endif
388
389 #    ifdef AIX
390 #      include <sys/select.h>
391 #    endif
392
393 #    ifdef __QNX__
394 #      include <sys/select.h>
395 #    endif
396
397 #    if defined(sun)
398 #      include <sys/filio.h>
399 #    else
400 #      ifndef VMS
401 #        include <sys/ioctl.h>
402 #      else
403          /* ioctl is only in VMS > 7.0 and when socketshr is not used */
404 #        if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
405 #          include <sys/ioctl.h>
406 #        endif
407 #      endif
408 #    endif
409
410 #    ifdef VMS
411 #      include <unixio.h>
412 #      if defined(TCPIP_TYPE_SOCKETSHR)
413 #        include <socketshr.h>
414 #      endif
415 #    endif
416
417 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
418 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
419 #    define SHUTDOWN(fd)    { shutdown((fd),0); closesocket((fd)); }
420 #    define SHUTDOWN2(fd)   { shutdown((fd),2); closesocket((fd)); }
421 #    define INVALID_SOCKET      (-1)
422 #  endif
423 #endif
424
425 #if defined(__ultrix)
426 #  ifndef ssize_t
427 #    define ssize_t int 
428 #  endif
429 #endif
430
431 #if defined(sun) && !defined(__svr4__) && !defined(__SVR4)
432   /* include headers first, so our defines don't break it */
433 #include <stdlib.h>
434 #include <string.h>
435   /* bcopy can handle overlapping moves according to SunOS 4.1.4 manpage */
436 # define memmove(s1,s2,n) bcopy((s2),(s1),(n))
437 # define strtoul(s,e,b) ((unsigned long int)strtol((s),(e),(b)))
438 extern char *sys_errlist[]; extern int sys_nerr;
439 # define strerror(errnum) \
440         (((errnum)<0 || (errnum)>=sys_nerr) ? NULL : sys_errlist[errnum])
441 #endif
442
443 /***********************************************/
444
445 /* do we need to do this for getenv.
446  * Just define getenv for use under windows */
447
448 #ifdef WIN16
449 /* How to do this needs to be thought out a bit more.... */
450 /*char *GETENV(char *);
451 #define Getenv  GETENV*/
452 #define Getenv  getenv
453 #else
454 #define Getenv getenv
455 #endif
456
457 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
458
459 #ifdef sgi
460 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
461 #endif
462 #ifdef SNI
463 #define IRIX_CC_BUG     /* CDS++ up to V2.0Bsomething suffered from the same bug.*/
464 #endif
465
466 #ifdef NO_MD2
467 #define MD2_Init MD2Init
468 #define MD2_Update MD2Update
469 #define MD2_Final MD2Final
470 #define MD2_DIGEST_LENGTH 16
471 #endif
472 #ifdef NO_MD5
473 #define MD5_Init MD5Init 
474 #define MD5_Update MD5Update
475 #define MD5_Final MD5Final
476 #define MD5_DIGEST_LENGTH 16
477 #endif
478
479 #ifdef  __cplusplus
480 }
481 #endif
482
483 #endif
484