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