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