]> git.ipfire.org Git - thirdparty/openssl.git/blame - e_os.h
e_os.h: add prandom and hwrng to the list of random devices on s390x.
[thirdparty/openssl.git] / e_os.h
CommitLineData
b6cff313 1/*
b99fe5f4 2 * Copyright 1995-2017 The OpenSSL Project Authors. All Rights Reserved.
0f113f3e 3 *
b6cff313
RS
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
d02b48c6
RE
8 */
9
10#ifndef HEADER_E_OS_H
0f113f3e 11# define HEADER_E_OS_H
d02b48c6 12
07016a8a 13# include <limits.h>
0f113f3e 14# include <openssl/opensslconf.h>
06018c46 15
0f113f3e 16# include <openssl/e_os2.h>
98d132cf 17# include <openssl/crypto.h>
176db6dc 18# include "internal/nelem.h"
b99fe5f4 19
0f113f3e
MC
20/*
21 * <openssl/e_os2.h> contains what we can justify to make visible to the
22 * outside; this file e_os.h is not part of the exported interface.
23 */
fa470a84 24
d02b48c6
RE
25#ifdef __cplusplus
26extern "C" {
27#endif
28
43708c15 29/*
5f584013
AP
30 * Format specifier for printing size_t. Original conundrum was to
31 * get it working with -Wformat [-Werror], which can be considered
a303e9a6 32 * overzealous, especially in multi-platform context, but it's
5f584013 33 * conscious choice...
43708c15 34 */
5f584013
AP
35# if defined(_WIN64)
36# define OSSLzu "I64u" /* One would expect _WIN{64|32} cases after
37 * __STDC_VERSION__, but there are corner
38 * cases of MinGW compilers that link with
39 * non-compliant MSVCRT.DLL... */
40# elif defined(_WIN32)
41# define OSSLzu "u"
42# elif defined(__VMS)
43# define OSSLzu "u" /* VMS suffers from similar problem as MinGW,
44 * i.e. C RTL falling behind compiler. Recall
45 * that sizeof(size_t)==4 even in LP64 case. */
46# elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
43708c15 47# define OSSLzu "zu"
5f584013
AP
48# elif defined(__SIZEOF_SIZE_T__) && __SIZEOF_SIZE_T__==4
49# define OSSLzu "u" /* 'lu' should have worked, but when generating
50 * 32-bit code gcc still complains :-( */
43708c15 51# else
5f584013
AP
52# define OSSLzu "lu" /* To see that is works recall what does L
53 * stand for in ILP32 and LP64 */
43708c15
RS
54# endif
55
0f113f3e
MC
56# ifndef DEVRANDOM
57/*
f367ac2b 58 * set this to a comma-separated list of 'random' device files to try out. By
0f113f3e
MC
59 * default, we will try to read at least one of these files
60 */
fb9163ba
PS
61# if defined(__s390__)
62# define DEVRANDOM "/dev/prandom","/dev/urandom","/dev/hwrng","/dev/random"
63# else
64# define DEVRANDOM "/dev/urandom","/dev/random","/dev/srandom"
65# endif
0f113f3e 66# endif
0423f812 67# if !defined(OPENSSL_NO_EGD) && !defined(DEVRANDOM_EGD)
0f113f3e
MC
68/*
69 * set this to a comma-separated list of 'egd' sockets to try out. These
70 * sockets will be tried in the order listed in case accessing the device
f367ac2b 71 * files listed in DEVRANDOM did not return enough randomness.
0f113f3e
MC
72 */
73# define DEVRANDOM_EGD "/var/run/egd-pool","/dev/egd-pool","/etc/egd-pool","/etc/entropy"
74# endif
d02b48c6 75
cff55b90 76# if defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_UEFI)
3e83e686
RL
77# define NO_CHMOD
78# define NO_SYSLOG
0f113f3e
MC
79# endif
80
0e97f1e1
RS
81# define get_last_sys_error() errno
82# define clear_sys_error() errno=0
83
d02b48c6
RE
84/********************************************************************
85 The Microsoft section
86 ********************************************************************/
0f113f3e 87# if defined(OPENSSL_SYS_WIN32) && !defined(WIN32)
b8384651 88# define WIN32
0f113f3e
MC
89# endif
90# if defined(OPENSSL_SYS_WINDOWS) && !defined(WINDOWS)
cf1b7d96 91# define WINDOWS
0f113f3e
MC
92# endif
93# if defined(OPENSSL_SYS_MSDOS) && !defined(MSDOS)
cf1b7d96 94# define MSDOS
0f113f3e 95# endif
d02b48c6 96
0f113f3e 97# ifdef WIN32
0e97f1e1
RS
98# undef get_last_sys_error
99# undef clear_sys_error
0f113f3e
MC
100# define get_last_sys_error() GetLastError()
101# define clear_sys_error() SetLastError(0)
102# if !defined(WINNT)
103# define WIN_CONSOLE_BUG
104# endif
105# else
0f113f3e 106# endif
58964a49 107
0f113f3e 108# if (defined(WINDOWS) || defined(MSDOS))
d02b48c6 109
f642ebc1 110# ifdef __DJGPP__
0f113f3e
MC
111# include <unistd.h>
112# include <sys/stat.h>
0f113f3e
MC
113# define _setmode setmode
114# define _O_TEXT O_TEXT
115# define _O_BINARY O_BINARY
2c25ebd1
RL
116# define HAS_LFN_SUPPORT(name) (pathconf((name), _PC_NAME_MAX) > 12)
117# undef DEVRANDOM_EGD /* Neither MS-DOS nor FreeDOS provide 'egd' sockets. */
0f113f3e
MC
118# undef DEVRANDOM
119# define DEVRANDOM "/dev/urandom\x24"
120# endif /* __DJGPP__ */
f642ebc1 121
0056ef5d 122# ifndef S_IFDIR
0f113f3e 123# define S_IFDIR _S_IFDIR
0056ef5d 124# endif
6e064240 125
0056ef5d 126# ifndef S_IFMT
0f113f3e 127# define S_IFMT _S_IFMT
0056ef5d 128# endif
6e064240 129
f642ebc1 130# if !defined(WINNT) && !defined(__DJGPP__)
0f113f3e 131# define NO_SYSLOG
0056ef5d 132# endif
d02b48c6 133
d02b48c6 134# ifdef WINDOWS
0f113f3e 135# if !defined(_WIN32_WCE) && !defined(_WIN32_WINNT)
e476f942 136 /*
0f113f3e
MC
137 * Defining _WIN32_WINNT here in e_os.h implies certain "discipline."
138 * Most notably we ought to check for availability of each specific
0ee05b73
AP
139 * routine that was introduced after denoted _WIN32_WINNT with
140 * GetProcAddress(). Normally newer functions are masked with higher
141 * _WIN32_WINNT in SDK headers. So that if you wish to use them in
142 * some module, you'd need to override _WIN32_WINNT definition in
143 * the target module in order to "reach for" prototypes, but replace
144 * calls to new functions with indirect calls. Alternatively it
145 * might be possible to achieve the goal by /DELAYLOAD-ing .DLLs
146 * and check for current OS version instead.
0f113f3e 147 */
0ee05b73 148# define _WIN32_WINNT 0x0501
0f113f3e 149# endif
2469e76b 150# if defined(_WIN32_WINNT) || defined(_WIN32_WCE)
61aa2134
AP
151 /*
152 * Just like defining _WIN32_WINNT including winsock2.h implies
8711efb4 153 * certain "discipline" for maintaining [broad] binary compatibility.
61aa2134
AP
154 * As long as structures are invariant among Winsock versions,
155 * it's sufficient to check for specific Winsock2 API availability
156 * at run-time [DSO_global_lookup is recommended]...
157 */
0f113f3e
MC
158# include <winsock2.h>
159# include <ws2tcpip.h>
8711efb4 160 /* yes, they have to be #included prior to <windows.h> */
0f113f3e
MC
161# endif
162# include <windows.h>
163# include <stdio.h>
164# include <stddef.h>
165# include <errno.h>
166# if defined(_WIN32_WCE) && !defined(EACCES)
167# define EACCES 13
168# endif
169# include <string.h>
170# ifdef _WIN64
171# define strlen(s) _strlen31(s)
1875e6db 172/* cut strings to 2GB */
55c7a4cf 173static __inline unsigned int _strlen31(const char *str)
0f113f3e
MC
174{
175 unsigned int len = 0;
176 while (*str && len < 0x80000000U)
177 str++, len++;
178 return len & 0x7FFFFFFF;
179}
180# endif
181# include <malloc.h>
0f113f3e
MC
182# if defined(_MSC_VER) && !defined(_WIN32_WCE) && !defined(_DLL) && defined(stdin)
183# if _MSC_VER>=1300 && _MSC_VER<1600
184# undef stdin
185# undef stdout
186# undef stderr
187FILE *__iob_func();
188# define stdin (&__iob_func()[0])
189# define stdout (&__iob_func()[1])
190# define stderr (&__iob_func()[2])
191# elif _MSC_VER<1300 && defined(I_CAN_LIVE_WITH_LNK4049)
192# undef stdin
193# undef stdout
194# undef stderr
195 /*
196 * pre-1300 has __p__iob(), but it's available only in msvcrt.lib,
197 * or in other words with /MD. Declaring implicit import, i.e. with
198 * _imp_ prefix, works correctly with all compiler options, but
199 * without /MD results in LINK warning LNK4049: 'locally defined
200 * symbol "__iob" imported'.
e527201f 201 */
0f113f3e
MC
202extern FILE *_imp___iob;
203# define stdin (&_imp___iob[0])
204# define stdout (&_imp___iob[1])
205# define stderr (&_imp___iob[2])
e527201f 206# endif
0f113f3e 207# endif
d02b48c6 208# endif
0f113f3e
MC
209# include <io.h>
210# include <fcntl.h>
d02b48c6 211
0bf23d9b 212# ifdef OPENSSL_SYS_WINCE
0f113f3e 213# define OPENSSL_NO_POSIX_IO
0bf23d9b
RL
214# endif
215
be7b4458 216# define EXIT(n) exit(n)
d02b48c6 217# define LIST_SEPARATOR_CHAR ';'
0056ef5d 218# ifndef W_OK
0f113f3e 219# define W_OK 2
0056ef5d
RL
220# endif
221# ifndef R_OK
0f113f3e 222# define R_OK 4
0056ef5d 223# endif
0bf23d9b 224# ifdef OPENSSL_SYS_WINCE
0f113f3e 225# define DEFAULT_HOME ""
0bf23d9b 226# else
0f113f3e 227# define DEFAULT_HOME "C:"
0bf23d9b 228# endif
d02b48c6 229
86d21d0b 230/* Avoid Visual Studio 13 GetVersion deprecated problems */
0f113f3e
MC
231# if defined(_MSC_VER) && _MSC_VER>=1800
232# define check_winnt() (1)
233# define check_win_minplat(x) (1)
234# else
235# define check_winnt() (GetVersion() < 0x80000000)
236# define check_win_minplat(x) (LOBYTE(LOWORD(GetVersion())) >= (x))
237# endif
f511b25a 238
0f113f3e 239# else /* The non-microsoft world */
d02b48c6 240
4cff10dc
P
241# if defined(OPENSSL_SYS_VXWORKS)
242# include <sys/times.h>
243# else
244# include <sys/time.h>
245# endif
246
cf1b7d96 247# ifdef OPENSSL_SYS_VMS
0f113f3e
MC
248# define VMS 1
249 /*
250 * some programs don't include stdlib, so exit() and others give implicit
251 * function warnings
252 */
253# include <stdlib.h>
254# if defined(__DECC)
255# include <unistd.h>
256# else
257# include <unixlib.h>
258# endif
0f113f3e 259# define LIST_SEPARATOR_CHAR ','
0c61e299 260 /* We don't have any well-defined random devices on VMS, yet... */
0f113f3e 261# undef DEVRANDOM
1d97c843
TH
262 /*-
263 We need to do this since VMS has the following coding on status codes:
511e596b
RL
264
265 Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
266 The important thing to know is that odd numbers are considered
0f113f3e 267 good, while even ones are considered errors.
511e596b
RL
268 Bits 3-15: actual status number
269 Bits 16-27: facility number. 0 is considered "unknown"
270 Bits 28-31: control bits. If bit 28 is set, the shell won't try to
271 output the message (which, for random codes, just looks ugly)
272
273 So, what we do here is to change 0 to 1 to get the default success status,
274 and everything else is shifted up to fit into the status number field, and
f625d383 275 the status is tagged as an error, which is what is wanted here.
c3944a99
RL
276
277 Finally, we add the VMS C facility code 0x35a000, because there are some
278 programs, such as Perl, that will reinterpret the code back to something
279 POSIXly. 'man perlvms' explains it further.
f625d383 280
c3944a99
RL
281 NOTE: the perlvms manual wants to turn all codes 2 to 255 into success
282 codes (status type = 1). I couldn't disagree more. Fortunately, the
283 status type doesn't seem to bother Perl.
511e596b
RL
284 -- Richard Levitte
285 */
f625d383
RL
286# define EXIT(n) exit((n) ? (((n) << 3) | 2 | 0x10000000 | 0x35a000) : 1)
287
b8f304f7
RL
288# define DEFAULT_HOME "SYS$LOGIN:"
289
d02b48c6 290# else
06018c46 291 /* !defined VMS */
0f113f3e
MC
292# ifdef OPENSSL_UNISTD
293# include OPENSSL_UNISTD
294# else
295# include <unistd.h>
296# endif
b379fe6c 297# include <sys/types.h>
0f113f3e
MC
298# ifdef OPENSSL_SYS_WIN32_CYGWIN
299# include <io.h>
300# include <fcntl.h>
301# endif
302
0f113f3e 303# define LIST_SEPARATOR_CHAR ':'
0f113f3e 304# define EXIT(n) exit(n)
d02b48c6 305# endif
d02b48c6 306
0f113f3e 307# endif
7d7d2cbc 308
d02b48c6
RE
309/***********************************************/
310
0f113f3e 311# if defined(OPENSSL_SYS_WINDOWS)
e6fa67fa
RL
312# define strcasecmp _stricmp
313# define strncasecmp _strnicmp
dc6b5c7b
RL
314# if (_MSC_VER >= 1310)
315# define open _open
316# define fdopen _fdopen
317# define close _close
8d95ca36
M
318# ifndef strdup
319# define strdup _strdup
320# endif
dc6b5c7b 321# define unlink _unlink
2e38091c 322# define fileno _fileno
dc6b5c7b 323# endif
7233bea2
RL
324# else
325# include <strings.h>
0f113f3e 326# endif
3bfd99bf 327
6a89a25c 328/* vxworks */
0f113f3e
MC
329# if defined(OPENSSL_SYS_VXWORKS)
330# include <ioLib.h>
331# include <tickLib.h>
332# include <sysLib.h>
0f113f3e
MC
333# include <vxWorks.h>
334# include <sockLib.h>
335# include <taskLib.h>
6a89a25c 336
0e97f1e1
RS
337# define TTY_STRUCT int
338# define sleep(a) taskDelay((a) * sysClkRateGet())
6a89a25c 339
0f113f3e
MC
340/*
341 * NOTE: these are implemented by helpers in database app! if the database is
a303e9a6 342 * not linked, we need to implement them elsewhere
0f113f3e 343 */
6a89a25c
RL
344struct hostent *gethostbyname(const char *name);
345struct hostent *gethostbyaddr(const char *addr, int length, int type);
346struct servent *getservbyname(const char *name, const char *proto);
347
0f113f3e 348# endif
6a89a25c
RL
349/* end vxworks */
350
43c56417
KR
351#ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
352# define CRYPTO_memcmp memcmp
353#endif
354
d02b48c6
RE
355#ifdef __cplusplus
356}
357#endif
358
359#endif