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