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