Move the definition of DEVRANDOM for DJGPP from Configure to e_os.h.
[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(__DJGPP__)
158 #define WATT32
159 #define get_last_socket_error() errno
160 #define clear_socket_error()    errno=0
161 #define closesocket(s)          close_s(s)
162 #define readsocket(s,b,n)       read_s(s,b,n)
163 #define writesocket(s,b,n)      send(s,b,n,0)
164 #elif defined(MAC_OS_pre_X)
165 #define get_last_socket_error() errno
166 #define clear_socket_error()    errno=0
167 #define closesocket(s)          MacSocket_close(s)
168 #define readsocket(s,b,n)       MacSocket_recv((s),(b),(n),true)
169 #define writesocket(s,b,n)      MacSocket_send((s),(b),(n))
170 #elif defined(OPENSSL_SYS_VMS)
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)       recv((s),(b),(n),0)
176 #define writesocket(s,b,n)      send((s),(b),(n),0)
177 #elif defined(OPENSSL_SYS_VXWORKS)
178 #define get_last_socket_error() errno
179 #define clear_socket_error()    errno=0
180 #define ioctlsocket(a,b,c)          ioctl((a),(b),(int)(c))
181 #define closesocket(s)              close(s)
182 #define readsocket(s,b,n)           read((s),(b),(n))
183 #define writesocket(s,b,n)          write((s),(char *)(b),(n))
184 #else
185 #define get_last_socket_error() errno
186 #define clear_socket_error()    errno=0
187 #define ioctlsocket(a,b,c)      ioctl(a,b,c)
188 #define closesocket(s)          close(s)
189 #define readsocket(s,b,n)       read((s),(b),(n))
190 #define writesocket(s,b,n)      write((s),(b),(n))
191 #endif
192
193 #ifdef WIN16
194 #  define OPENSSL_NO_FP_API
195 #  define MS_CALLBACK   _far _loadds
196 #  define MS_FAR        _far
197 #else
198 #  define MS_CALLBACK
199 #  define MS_FAR
200 #endif
201
202 #ifdef OPENSSL_NO_STDIO
203 #  define OPENSSL_NO_FP_API
204 #endif
205
206 #if (defined(WINDOWS) || defined(MSDOS))
207
208 #  ifdef __DJGPP__
209 #    include <unistd.h>
210 #    include <sys/stat.h>
211 #    include <sys/socket.h>
212 #    include <tcp.h>
213 #    include <netdb.h>
214 #    define _setmode setmode
215 #    define _O_TEXT O_TEXT
216 #    define _O_BINARY O_BINARY
217 #    define DEVRANDOM "/dev/urandom\x24"
218 #  endif /* __DJGPP__ */
219
220 #  ifndef S_IFDIR
221 #    define S_IFDIR     _S_IFDIR
222 #  endif
223
224 #  ifndef S_IFMT
225 #    define S_IFMT      _S_IFMT
226 #  endif
227
228 #  if !defined(WINNT) && !defined(__DJGPP__)
229 #    define NO_SYSLOG
230 #  endif
231 #  define NO_DIRENT
232
233 #  ifdef WINDOWS
234 #    include <windows.h>
235 #    include <stddef.h>
236 #    include <errno.h>
237 #    include <string.h>
238 #    include <malloc.h>
239 #  endif
240 #  include <io.h>
241 #  include <fcntl.h>
242
243 #  ifdef OPENSSL_SYS_WINCE
244 #    include <winsock_extras.h>
245 #  endif
246
247 #  define ssize_t long
248
249 #  if defined (__BORLANDC__)
250 #    define _setmode setmode
251 #    define _O_TEXT O_TEXT
252 #    define _O_BINARY O_BINARY
253 #    define _int64 __int64
254 #    define _kbhit kbhit
255 #  endif
256
257 #  if defined(WIN16) && defined(SSLEAY) && defined(_WINEXITNOPERSIST)
258 #    define EXIT(n) _wsetexit(_WINEXITNOPERSIST)
259 #    define OPENSSL_EXIT(n) do { if (n == 0) EXIT(n); return(n); } while(0)
260 #  else
261 #    define EXIT(n) exit(n)
262 #  endif
263 #  define LIST_SEPARATOR_CHAR ';'
264 #  ifndef X_OK
265 #    define X_OK        0
266 #  endif
267 #  ifndef W_OK
268 #    define W_OK        2
269 #  endif
270 #  ifndef R_OK
271 #    define R_OK        4
272 #  endif
273 #  define OPENSSL_CONF  "openssl.cnf"
274 #  define SSLEAY_CONF   OPENSSL_CONF
275 #  define NUL_DEV       "nul"
276 #  define RFILE         ".rnd"
277 #  ifdef OPENSSL_SYS_WINCE
278 #    define DEFAULT_HOME  ""
279 #  else
280 #    define DEFAULT_HOME  "C:"
281 #  endif
282
283 #else /* The non-microsoft world world */
284
285 #  ifdef OPENSSL_SYS_VMS
286 #    define VMS 1
287   /* some programs don't include stdlib, so exit() and others give implicit 
288      function warnings */
289 #    include <stdlib.h>
290 #    if defined(__DECC)
291 #      include <unistd.h>
292 #    else
293 #      include <unixlib.h>
294 #    endif
295 #    define OPENSSL_CONF        "openssl.cnf"
296 #    define SSLEAY_CONF         OPENSSL_CONF
297 #    define RFILE               ".rnd"
298 #    define LIST_SEPARATOR_CHAR ','
299 #    define NUL_DEV             "NLA0:"
300   /* We don't have any well-defined random devices on VMS, yet... */
301 #    undef DEVRANDOM
302   /* We need to do this since VMS has the following coding on status codes:
303
304      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
305                The important thing to know is that odd numbers are considered
306                good, while even ones are considered errors.
307      Bits 3-15: actual status number
308      Bits 16-27: facility number.  0 is considered "unknown"
309      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
310                  output the message (which, for random codes, just looks ugly)
311
312      So, what we do here is to change 0 to 1 to get the default success status,
313      and everything else is shifted up to fit into the status number field, and
314      the status is tagged as an error, which I believe is what is wanted here.
315      -- Richard Levitte
316   */
317 #    define EXIT(n)             do { int __VMS_EXIT = n; \
318                                      if (__VMS_EXIT == 0) \
319                                        __VMS_EXIT = 1; \
320                                      else \
321                                        __VMS_EXIT = (n << 3) | 2; \
322                                      __VMS_EXIT |= 0x10000000; \
323                                      exit(__VMS_EXIT); } while(0)
324 #    define NO_SYS_PARAM_H
325 #  else
326      /* !defined VMS */
327 #    ifdef OPENSSL_SYS_MPE
328 #      define NO_SYS_PARAM_H
329 #    endif
330 #    ifdef OPENSSL_UNISTD
331 #      include OPENSSL_UNISTD
332 #    else
333 #      include <unistd.h>
334 #    endif
335 #    ifndef NO_SYS_TYPES_H
336 #      include <sys/types.h>
337 #    endif
338 #    if defined(NeXT) || defined(OPENSSL_SYS_NEWS4)
339 #      define pid_t int /* pid_t is missing on NEXTSTEP/OPENSTEP
340                          * (unless when compiling with -D_POSIX_SOURCE,
341                          * which doesn't work for us) */
342 #    endif
343 #    if defined(NeXT) || defined(OPENSSL_SYS_NEWS4) || defined(OPENSSL_SYS_SUNOS)
344 #      define ssize_t int /* ditto */
345 #    endif
346 #    ifdef OPENSSL_SYS_NEWS4 /* setvbuf is missing on mips-sony-bsd */
347 #      define setvbuf(a, b, c, d) setbuffer((a), (b), (d))
348        typedef unsigned long clock_t;
349 #    endif
350
351 #    define OPENSSL_CONF        "openssl.cnf"
352 #    define SSLEAY_CONF         OPENSSL_CONF
353 #    define RFILE               ".rnd"
354 #    define LIST_SEPARATOR_CHAR ':'
355 #    define NUL_DEV             "/dev/null"
356 #    define EXIT(n)             exit(n)
357 #  endif
358
359 #  define SSLeay_getpid()       getpid()
360
361 #endif
362
363
364 /*************/
365
366 #ifdef USE_SOCKETS
367 #  if defined(WINDOWS) || defined(MSDOS)
368       /* windows world */
369
370 #    ifdef OPENSSL_NO_SOCK
371 #      define SSLeay_Write(a,b,c)       (-1)
372 #      define SSLeay_Read(a,b,c)        (-1)
373 #      define SHUTDOWN(fd)              close(fd)
374 #      define SHUTDOWN2(fd)             close(fd)
375 #    elif !defined(__DJGPP__)
376 #      include <winsock.h>
377 extern HINSTANCE _hInstance;
378 #      define SSLeay_Write(a,b,c)       send((a),(b),(c),0)
379 #      define SSLeay_Read(a,b,c)        recv((a),(b),(c),0)
380 #      define SHUTDOWN(fd)              { shutdown((fd),0); closesocket(fd); }
381 #      define SHUTDOWN2(fd)             { shutdown((fd),2); closesocket(fd); }
382 #    else
383 #      define SSLeay_Write(a,b,c)       write_s(a,b,c,0)
384 #      define SSLeay_Read(a,b,c)        read_s(a,b,c)
385 #      define SHUTDOWN(fd)              close_s(fd)
386 #      define SHUTDOWN2(fd)             close_s(fd)
387 #    endif
388
389 #  elif defined(MAC_OS_pre_X)
390
391 #    include "MacSocket.h"
392 #    define SSLeay_Write(a,b,c)         MacSocket_send((a),(b),(c))
393 #    define SSLeay_Read(a,b,c)          MacSocket_recv((a),(b),(c),true)
394 #    define SHUTDOWN(fd)                MacSocket_close(fd)
395 #    define SHUTDOWN2(fd)               MacSocket_close(fd)
396
397 #  else
398
399 #    ifndef NO_SYS_PARAM_H
400 #      include <sys/param.h>
401 #    endif
402 #    ifdef OPENSSL_SYS_VXWORKS
403 #      include <time.h> 
404 #    elif !defined(OPENSSL_SYS_MPE)
405 #      include <sys/time.h> /* Needed under linux for FD_XXX */
406 #    endif
407
408 #    include <netdb.h>
409 #    if defined(OPENSSL_SYS_VMS_NODECC)
410 #      include <socket.h>
411 #      include <in.h>
412 #      include <inet.h>
413 #    else
414 #      include <sys/socket.h>
415 #      ifdef FILIO_H
416 #        include <sys/filio.h> /* Added for FIONBIO under unixware */
417 #      endif
418 #      include <netinet/in.h>
419 #      include <arpa/inet.h>
420 #    endif
421
422 #    if defined(NeXT) || defined(_NEXT_SOURCE)
423 #      include <sys/fcntl.h>
424 #      include <sys/types.h>
425 #    endif
426
427 #    ifdef OPENSSL_SYS_AIX
428 #      include <sys/select.h>
429 #    endif
430
431 #    ifdef __QNX__
432 #      include <sys/select.h>
433 #    endif
434
435 #    if defined(sun)
436 #      include <sys/filio.h>
437 #    else
438 #      ifndef VMS
439 #        include <sys/ioctl.h>
440 #      else
441          /* ioctl is only in VMS > 7.0 and when socketshr is not used */
442 #        if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
443 #          include <sys/ioctl.h>
444 #        endif
445 #      endif
446 #    endif
447
448 #    ifdef VMS
449 #      include <unixio.h>
450 #      if defined(TCPIP_TYPE_SOCKETSHR)
451 #        include <socketshr.h>
452 #      endif
453 #    endif
454
455 #    define SSLeay_Read(a,b,c)     read((a),(b),(c))
456 #    define SSLeay_Write(a,b,c)    write((a),(b),(c))
457 #    define SHUTDOWN(fd)    { shutdown((fd),0); closesocket((fd)); }
458 #    define SHUTDOWN2(fd)   { shutdown((fd),2); closesocket((fd)); }
459 #    ifndef INVALID_SOCKET
460 #    define INVALID_SOCKET      (-1)
461 #    endif /* INVALID_SOCKET */
462 #  endif
463 #endif
464
465 #if defined(__ultrix)
466 #  ifndef ssize_t
467 #    define ssize_t int 
468 #  endif
469 #endif
470
471 #if defined(sun) && !defined(__svr4__) && !defined(__SVR4)
472   /* include headers first, so our defines don't break it */
473 #include <stdlib.h>
474 #include <string.h>
475   /* bcopy can handle overlapping moves according to SunOS 4.1.4 manpage */
476 # define memmove(s1,s2,n) bcopy((s2),(s1),(n))
477 # define strtoul(s,e,b) ((unsigned long int)strtol((s),(e),(b)))
478 extern char *sys_errlist[]; extern int sys_nerr;
479 # define strerror(errnum) \
480         (((errnum)<0 || (errnum)>=sys_nerr) ? NULL : sys_errlist[errnum])
481 #endif
482
483 #ifndef OPENSSL_EXIT
484 # if defined(MONOLITH) && !defined(OPENSSL_C)
485 #  define OPENSSL_EXIT(n) return(n)
486 # else
487 #  define OPENSSL_EXIT(n) do { EXIT(n); return(n); } while(0)
488 # endif
489 #endif
490
491 /***********************************************/
492
493 /* do we need to do this for getenv.
494  * Just define getenv for use under windows */
495
496 #ifdef WIN16
497 /* How to do this needs to be thought out a bit more.... */
498 /*char *GETENV(char *);
499 #define Getenv  GETENV*/
500 #define Getenv  getenv
501 #else
502 #define Getenv getenv
503 #endif
504
505 #define DG_GCC_BUG      /* gcc < 2.6.3 on DGUX */
506
507 #ifdef sgi
508 #define IRIX_CC_BUG     /* all version of IRIX I've tested (4.* 5.*) */
509 #endif
510 #ifdef OPENSSL_SYS_SNI
511 #define IRIX_CC_BUG     /* CDS++ up to V2.0Bsomething suffered from the same bug.*/
512 #endif
513
514 #if defined(OPENSSL_SYS_WINDOWS)
515 #  define strcasecmp _stricmp
516 #  define strncasecmp _strnicmp
517 #elif defined(OPENSSL_SYS_VMS)
518 /* VMS below version 7.0 doesn't have strcasecmp() */
519 #  include "o_str.h"
520 #  define strcasecmp OPENSSL_strcasecmp
521 #  define strncasecmp OPENSSL_strncasecmp
522 #  define OPENSSL_IMPLEMENTS_strncasecmp
523 #elif defined(OPENSSL_SYS_OS2) && defined(__EMX__)
524 #  define strcasecmp stricmp
525 #  define strncasecmp strnicmp
526 #else
527 #  ifdef NO_STRINGS_H
528     int strcasecmp();
529     int strncasecmp();
530 #  else
531 #    include <strings.h>
532 #  endif /* NO_STRINGS_H */
533 #endif
534
535 #if defined(OPENSSL_SYS_OS2) && defined(__EMX__)
536 # include <io.h>
537 # include <fcntl.h>
538 # define NO_SYSLOG
539 #endif
540
541 /* vxworks */
542 #if defined(OPENSSL_SYS_VXWORKS)
543 #include <ioLib.h>
544 #include <tickLib.h>
545 #include <sysLib.h>
546
547 #define TTY_STRUCT int
548
549 #define sleep(a) taskDelay((a) * sysClkRateGet())
550
551 #include <vxWorks.h>
552 #include <sockLib.h>
553 #include <taskLib.h>
554
555 #define getpid taskIdSelf
556
557 /* NOTE: these are implemented by helpers in database app!
558  * if the database is not linked, we need to implement them
559  * elswhere */
560 struct hostent *gethostbyname(const char *name);
561 struct hostent *gethostbyaddr(const char *addr, int length, int type);
562 struct servent *getservbyname(const char *name, const char *proto);
563
564 #endif
565 /* end vxworks */
566
567 #ifdef  __cplusplus
568 }
569 #endif
570
571 #endif
572