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