Add some SSL BIO tests
[openssl.git] / e_os.h
1 /*
2  * Copyright 1995-2016 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the OpenSSL license (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9
10 #ifndef HEADER_E_OS_H
11 # define HEADER_E_OS_H
12
13 # include <openssl/opensslconf.h>
14
15 # include <openssl/e_os2.h>
16 /*
17  * <openssl/e_os2.h> contains what we can justify to make visible to the
18  * outside; this file e_os.h is not part of the exported interface.
19  */
20
21 #ifdef  __cplusplus
22 extern "C" {
23 #endif
24
25 /* Used to checking reference counts, most while doing perl5 stuff :-) */
26 # if defined(OPENSSL_NO_STDIO)
27 #  if defined(REF_PRINT)
28 #   error "REF_PRINT requires stdio"
29 #  endif
30 # endif
31
32 # if !defined(NDEBUG) && !defined(OPENSSL_NO_STDIO)
33 #  define REF_ASSERT_ISNT(test) \
34     (void)((test) ? (OPENSSL_die("refcount error", __FILE__, __LINE__), 1) : 0)
35 # else
36 #  define REF_ASSERT_ISNT(i)
37 # endif
38 # ifdef REF_PRINT
39 #  define REF_PRINT_COUNT(a, b) \
40         fprintf(stderr, "%p:%4d:%s\n", b, b->references, a)
41 # else
42 #  define REF_PRINT_COUNT(a, b)
43 # endif
44
45 # define osslargused(x)      (void)x
46 # define OPENSSL_CONF        "openssl.cnf"
47
48 # ifndef DEVRANDOM
49 /*
50  * set this to a comma-separated list of 'random' device files to try out. My
51  * default, we will try to read at least one of these files
52  */
53 #  define DEVRANDOM "/dev/urandom","/dev/random","/dev/srandom"
54 # endif
55 # if !defined(OPENSSL_NO_EGD) && !defined(DEVRANDOM_EGD)
56 /*
57  * set this to a comma-separated list of 'egd' sockets to try out. These
58  * sockets will be tried in the order listed in case accessing the device
59  * files listed in DEVRANDOM did not return enough entropy.
60  */
61 #  define DEVRANDOM_EGD "/var/run/egd-pool","/dev/egd-pool","/etc/egd-pool","/etc/entropy"
62 # endif
63
64 # if defined(OPENSSL_SYS_VXWORKS)
65 #  define NO_SYS_PARAM_H
66 #  define NO_CHMOD
67 #  define NO_SYSLOG
68 # endif
69
70 /********************************************************************
71  The Microsoft section
72  ********************************************************************/
73 # if defined(OPENSSL_SYS_WIN32) && !defined(WIN32)
74 #  define WIN32
75 # endif
76 # if defined(OPENSSL_SYS_WINDOWS) && !defined(WINDOWS)
77 #  define WINDOWS
78 # endif
79 # if defined(OPENSSL_SYS_MSDOS) && !defined(MSDOS)
80 #  define MSDOS
81 # endif
82
83 # if (defined(MSDOS) || defined(OPENSSL_SYS_UEFI)) && !defined(GETPID_IS_MEANINGLESS)
84 #  define GETPID_IS_MEANINGLESS
85 # endif
86
87 # ifdef WIN32
88 #  define NO_SYS_UN_H
89 #  define get_last_sys_error()    GetLastError()
90 #  define clear_sys_error()       SetLastError(0)
91 #  if !defined(WINNT)
92 #   define WIN_CONSOLE_BUG
93 #  endif
94 # else
95 #  define get_last_sys_error()    errno
96 #  define clear_sys_error()       errno=0
97 # endif
98
99 # if defined(WINDOWS)
100 #  define get_last_socket_error() WSAGetLastError()
101 #  define clear_socket_error()    WSASetLastError(0)
102 #  define readsocket(s,b,n)       recv((s),(b),(n),0)
103 #  define writesocket(s,b,n)      send((s),(b),(n),0)
104 # elif defined(__DJGPP__)
105 #  define WATT32
106 #  define WATT32_NO_OLDIES
107 #  define get_last_socket_error() errno
108 #  define clear_socket_error()    errno=0
109 #  define closesocket(s)          close_s(s)
110 #  define readsocket(s,b,n)       read_s(s,b,n)
111 #  define writesocket(s,b,n)      send(s,b,n,0)
112 # elif defined(OPENSSL_SYS_VMS)
113 #  define get_last_socket_error() errno
114 #  define clear_socket_error()    errno=0
115 #  define ioctlsocket(a,b,c)      ioctl(a,b,c)
116 #  define closesocket(s)          close(s)
117 #  define readsocket(s,b,n)       recv((s),(b),(n),0)
118 #  define writesocket(s,b,n)      send((s),(b),(n),0)
119 # elif defined(OPENSSL_SYS_VXWORKS)
120 #  define get_last_socket_error() errno
121 #  define clear_socket_error()    errno=0
122 #  define ioctlsocket(a,b,c)          ioctl((a),(b),(int)(c))
123 #  define closesocket(s)              close(s)
124 #  define readsocket(s,b,n)           read((s),(b),(n))
125 #  define writesocket(s,b,n)          write((s),(char *)(b),(n))
126 # else
127 #  define get_last_socket_error() errno
128 #  define clear_socket_error()    errno=0
129 #  define ioctlsocket(a,b,c)      ioctl(a,b,c)
130 #  define closesocket(s)          close(s)
131 #  define readsocket(s,b,n)       read((s),(b),(n))
132 #  define writesocket(s,b,n)      write((s),(b),(n))
133 # endif
134
135 # if (defined(WINDOWS) || defined(MSDOS))
136
137 #  ifdef __DJGPP__
138 #   include <unistd.h>
139 #   include <sys/stat.h>
140 #   include <sys/socket.h>
141 #   include <sys/un.h>
142 #   include <tcp.h>
143 #   include <netdb.h>
144 #   define _setmode setmode
145 #   define _O_TEXT O_TEXT
146 #   define _O_BINARY O_BINARY
147 #   define HAS_LFN_SUPPORT(name)  (pathconf((name), _PC_NAME_MAX) > 12)
148 #   undef DEVRANDOM_EGD  /*  Neither MS-DOS nor FreeDOS provide 'egd' sockets.  */
149 #   undef DEVRANDOM
150 #   define DEVRANDOM "/dev/urandom\x24"
151 #  endif                        /* __DJGPP__ */
152
153 #  ifndef S_IFDIR
154 #   define S_IFDIR     _S_IFDIR
155 #  endif
156
157 #  ifndef S_IFMT
158 #   define S_IFMT      _S_IFMT
159 #  endif
160
161 #  if !defined(WINNT) && !defined(__DJGPP__)
162 #   define NO_SYSLOG
163 #  endif
164 #  define NO_DIRENT
165
166 #  ifdef WINDOWS
167 #   if !defined(_WIN32_WCE) && !defined(_WIN32_WINNT)
168        /*
169         * Defining _WIN32_WINNT here in e_os.h implies certain "discipline."
170         * Most notably we ought to check for availability of each specific
171         * routine that was introduced after denoted _WIN32_WINNT with
172         * GetProcAddress(). Normally newer functions are masked with higher
173         * _WIN32_WINNT in SDK headers. So that if you wish to use them in
174         * some module, you'd need to override _WIN32_WINNT definition in
175         * the target module in order to "reach for" prototypes, but replace
176         * calls to new functions with indirect calls. Alternatively it
177         * might be possible to achieve the goal by /DELAYLOAD-ing .DLLs
178         * and check for current OS version instead.
179         */
180 #    define _WIN32_WINNT 0x0501
181 #   endif
182 #   if defined(_WIN32_WINNT) || defined(_WIN32_WCE)
183        /*
184         * Just like defining _WIN32_WINNT including winsock2.h implies
185         * certain "discipline" for maintaining [broad] binary compatibility.
186         * As long as structures are invariant among Winsock versions,
187         * it's sufficient to check for specific Winsock2 API availability
188         * at run-time [DSO_global_lookup is recommended]...
189         */
190 #    include <winsock2.h>
191 #    include <ws2tcpip.h>
192        /* yes, they have to be #included prior to <windows.h> */
193 #   endif
194 #   include <windows.h>
195 #   include <stdio.h>
196 #   include <stddef.h>
197 #   include <errno.h>
198 #   if defined(_WIN32_WCE) && !defined(EACCES)
199 #    define EACCES   13
200 #   endif
201 #   include <string.h>
202 #   ifdef _WIN64
203 #    define strlen(s) _strlen31(s)
204 /* cut strings to 2GB */
205 static __inline unsigned int _strlen31(const char *str)
206 {
207     unsigned int len = 0;
208     while (*str && len < 0x80000000U)
209         str++, len++;
210     return len & 0x7FFFFFFF;
211 }
212 #   endif
213 #   include <malloc.h>
214 #   if defined(_MSC_VER) && _MSC_VER<=1200 && defined(_MT) && defined(isspace)
215        /* compensate for bug in VC6 ctype.h */
216 #    undef isspace
217 #    undef isdigit
218 #    undef isalnum
219 #    undef isupper
220 #    undef isxdigit
221 #   endif
222 #   if defined(_MSC_VER) && !defined(_WIN32_WCE) && !defined(_DLL) && defined(stdin)
223 #    if _MSC_VER>=1300 && _MSC_VER<1600
224 #     undef stdin
225 #     undef stdout
226 #     undef stderr
227 FILE *__iob_func();
228 #     define stdin  (&__iob_func()[0])
229 #     define stdout (&__iob_func()[1])
230 #     define stderr (&__iob_func()[2])
231 #    elif _MSC_VER<1300 && defined(I_CAN_LIVE_WITH_LNK4049)
232 #     undef stdin
233 #     undef stdout
234 #     undef stderr
235          /*
236           * pre-1300 has __p__iob(), but it's available only in msvcrt.lib,
237           * or in other words with /MD. Declaring implicit import, i.e. with
238           * _imp_ prefix, works correctly with all compiler options, but
239           * without /MD results in LINK warning LNK4049: 'locally defined
240           * symbol "__iob" imported'.
241           */
242 extern FILE *_imp___iob;
243 #     define stdin  (&_imp___iob[0])
244 #     define stdout (&_imp___iob[1])
245 #     define stderr (&_imp___iob[2])
246 #    endif
247 #   endif
248 #  endif
249 #  include <io.h>
250 #  include <fcntl.h>
251
252 #  ifdef OPENSSL_SYS_WINCE
253 #   define OPENSSL_NO_POSIX_IO
254 #  endif
255
256 #  define EXIT(n) exit(n)
257 #  define LIST_SEPARATOR_CHAR ';'
258 #  ifndef X_OK
259 #   define X_OK        0
260 #  endif
261 #  ifndef W_OK
262 #   define W_OK        2
263 #  endif
264 #  ifndef R_OK
265 #   define R_OK        4
266 #  endif
267 #  ifdef OPENSSL_SYS_WINCE
268 #   define DEFAULT_HOME  ""
269 #  else
270 #   define DEFAULT_HOME  "C:"
271 #  endif
272
273 /* Avoid Visual Studio 13 GetVersion deprecated problems */
274 #  if defined(_MSC_VER) && _MSC_VER>=1800
275 #   define check_winnt() (1)
276 #   define check_win_minplat(x) (1)
277 #  else
278 #   define check_winnt() (GetVersion() < 0x80000000)
279 #   define check_win_minplat(x) (LOBYTE(LOWORD(GetVersion())) >= (x))
280 #  endif
281
282 # else                          /* The non-microsoft world */
283
284 #  ifdef OPENSSL_SYS_VMS
285 #   define VMS 1
286   /*
287    * some programs don't include stdlib, so exit() and others give implicit
288    * function warnings
289    */
290 #   include <stdlib.h>
291 #   if defined(__DECC)
292 #    include <unistd.h>
293 #   else
294 #    include <unixlib.h>
295 #   endif
296 #   define LIST_SEPARATOR_CHAR ','
297   /* We don't have any well-defined random devices on VMS, yet... */
298 #   undef DEVRANDOM
299   /*-
300      We need to do this since VMS has the following coding on status codes:
301
302      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
303                The important thing to know is that odd numbers are considered
304                good, while even ones are considered errors.
305      Bits 3-15: actual status number
306      Bits 16-27: facility number.  0 is considered "unknown"
307      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
308                  output the message (which, for random codes, just looks ugly)
309
310      So, what we do here is to change 0 to 1 to get the default success status,
311      and everything else is shifted up to fit into the status number field, and
312      the status is tagged as an error, which is what is wanted here.
313
314      Finally, we add the VMS C facility code 0x35a000, because there are some
315      programs, such as Perl, that will reinterpret the code back to something
316      POSIXly.  'man perlvms' explains it further.
317
318      NOTE: the perlvms manual wants to turn all codes 2 to 255 into success
319      codes (status type = 1).  I couldn't disagree more.  Fortunately, the
320      status type doesn't seem to bother Perl.
321      -- Richard Levitte
322   */
323 #   define EXIT(n)  exit((n) ? (((n) << 3) | 2 | 0x10000000 | 0x35a000) : 1)
324
325 #   define NO_SYS_PARAM_H
326 #   define NO_SYS_UN_H
327
328 #   define DEFAULT_HOME "SYS$LOGIN:"
329
330 #  else
331      /* !defined VMS */
332 #   ifdef OPENSSL_UNISTD
333 #    include OPENSSL_UNISTD
334 #   else
335 #    include <unistd.h>
336 #   endif
337 #   ifndef NO_SYS_TYPES_H
338 #    include <sys/types.h>
339 #   endif
340 #   ifdef OPENSSL_SYS_WIN32_CYGWIN
341 #    include <io.h>
342 #    include <fcntl.h>
343 #   endif
344
345 #   define LIST_SEPARATOR_CHAR ':'
346 #   define EXIT(n)             exit(n)
347 #  endif
348
349 # endif
350
351 /*************/
352
353 # ifdef USE_SOCKETS
354 #  ifdef OPENSSL_NO_SOCK
355 #  elif defined(WINDOWS) || defined(MSDOS)
356       /* windows world */
357 #   if !defined(__DJGPP__)
358 #    if defined(_WIN32_WCE) && _WIN32_WCE<410
359 #     define getservbyname _masked_declaration_getservbyname
360 #    endif
361 #    if !defined(IPPROTO_IP)
362          /* winsock[2].h was included already? */
363 #     include <winsock.h>
364 #    endif
365 #    ifdef getservbyname
366 #     undef getservbyname
367          /* this is used to be wcecompat/include/winsock_extras.h */
368 struct servent *PASCAL getservbyname(const char *, const char *);
369 #    endif
370
371 #    ifdef _WIN64
372 /*
373  * Even though sizeof(SOCKET) is 8, it's safe to cast it to int, because
374  * the value constitutes an index in per-process table of limited size
375  * and not a real pointer. And we also depend on fact that all processors
376  * Windows run on happen to be two's-complement, which allows to
377  * interchange INVALID_SOCKET and -1.
378  */
379 #     define socket(d,t,p)   ((int)socket(d,t,p))
380 #     define accept(s,f,l)   ((int)accept(s,f,l))
381 #    endif
382 #   else
383 #   endif
384
385 #  else
386
387 #   ifndef NO_SYS_PARAM_H
388 #    include <sys/param.h>
389 #   endif
390 #   ifdef OPENSSL_SYS_VXWORKS
391 #    include <time.h>
392 #   endif
393
394 #   include <netdb.h>
395 #   if defined(OPENSSL_SYS_VMS_NODECC)
396 #    include <socket.h>
397 #    include <in.h>
398 #    include <inet.h>
399 #   else
400 #    include <sys/socket.h>
401 #    ifndef NO_SYS_UN_H
402 #     ifdef OPENSSL_SYS_VXWORKS
403 #      include <streams/un.h>
404 #     else
405 #      include <sys/un.h>
406 #     endif
407 #     ifndef UNIX_PATH_MAX
408 #      define UNIX_PATH_MAX sizeof(((struct sockaddr_un *)NULL)->sun_path)
409 #     endif
410 #    endif
411 #    ifdef FILIO_H
412 #     include <sys/filio.h> /* FIONBIO in some SVR4, e.g. unixware, solaris */
413 #    endif
414 #    include <netinet/in.h>
415 #    include <arpa/inet.h>
416 #    include <netinet/tcp.h>
417 #   endif
418
419 #   ifdef OPENSSL_SYS_AIX
420 #    include <sys/select.h>
421 #   endif
422
423 #   ifdef __QNX__
424 #    include <sys/select.h>
425 #   endif
426
427 #   ifndef VMS
428 #    include <sys/ioctl.h>
429 #   else
430         /* ioctl is only in VMS > 7.0 and when socketshr is not used */
431 #    if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
432 #     include <sys/ioctl.h>
433 #    endif
434 #   endif
435
436 #   ifdef VMS
437 #    include <unixio.h>
438 #    if defined(TCPIP_TYPE_SOCKETSHR)
439 #     include <socketshr.h>
440 #    endif
441 #   endif
442
443 #   ifndef INVALID_SOCKET
444 #    define INVALID_SOCKET      (-1)
445 #   endif                       /* INVALID_SOCKET */
446 #  endif
447
448 /*
449  * Some IPv6 implementations are broken, disable them in known bad versions.
450  */
451 #  if !defined(OPENSSL_USE_IPV6)
452 #   if defined(AF_INET6) && !defined(NETWARE_CLIB)
453 #    define OPENSSL_USE_IPV6 1
454 #   else
455 #    define OPENSSL_USE_IPV6 0
456 #   endif
457 #  endif
458
459 # endif
460
461 # ifndef OPENSSL_EXIT
462 #  if defined(MONOLITH) && !defined(OPENSSL_C)
463 #   define OPENSSL_EXIT(n) return(n)
464 #  else
465 #   define OPENSSL_EXIT(n) do { EXIT(n); return(n); } while(0)
466 #  endif
467 # endif
468
469 /***********************************************/
470
471 # if defined(OPENSSL_SYS_WINDOWS)
472 #  define strcasecmp _stricmp
473 #  define strncasecmp _strnicmp
474 #  if (_MSC_VER >= 1310)
475 #   define open _open
476 #   define fdopen _fdopen
477 #   define close _close
478 #   ifndef strdup
479 #    define strdup _strdup
480 #   endif
481 #   define unlink _unlink
482 #  endif
483 # else
484 #  include <strings.h>
485 # endif
486
487 /* vxworks */
488 # if defined(OPENSSL_SYS_VXWORKS)
489 #  include <ioLib.h>
490 #  include <tickLib.h>
491 #  include <sysLib.h>
492
493 #  define TTY_STRUCT int
494
495 #  define sleep(a) taskDelay((a) * sysClkRateGet())
496
497 #  include <vxWorks.h>
498 #  include <sockLib.h>
499 #  include <taskLib.h>
500
501 #  define getpid taskIdSelf
502
503 /*
504  * NOTE: these are implemented by helpers in database app! if the database is
505  * not linked, we need to implement them elswhere
506  */
507 struct hostent *gethostbyname(const char *name);
508 struct hostent *gethostbyaddr(const char *addr, int length, int type);
509 struct servent *getservbyname(const char *name, const char *proto);
510
511 # endif
512 /* end vxworks */
513
514 #define OSSL_NELEM(x)    (sizeof(x)/sizeof(x[0]))
515
516 #ifdef  __cplusplus
517 }
518 #endif
519
520 #endif