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