Move random-related defines from e_os.h to rand_unix.c
[openssl.git] / e_os.h
1 /*
2  * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (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 OSSL_E_OS_H
11 # define OSSL_E_OS_H
12
13 # include <limits.h>
14 # include <openssl/opensslconf.h>
15
16 # include <openssl/e_os2.h>
17 # include <openssl/crypto.h>
18 # include "internal/nelem.h"
19
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  */
24
25 # if defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_UEFI)
26 #  define NO_CHMOD
27 #  define NO_SYSLOG
28 # endif
29
30 # define get_last_sys_error()    errno
31 # define clear_sys_error()       errno=0
32 # define set_sys_error(e)        errno=(e)
33
34 /********************************************************************
35  The Microsoft section
36  ********************************************************************/
37 # if defined(OPENSSL_SYS_WIN32) && !defined(WIN32)
38 #  define WIN32
39 # endif
40 # if defined(OPENSSL_SYS_WINDOWS) && !defined(WINDOWS)
41 #  define WINDOWS
42 # endif
43 # if defined(OPENSSL_SYS_MSDOS) && !defined(MSDOS)
44 #  define MSDOS
45 # endif
46
47 # ifdef WIN32
48 #  undef get_last_sys_error
49 #  undef clear_sys_error
50 #  undef set_sys_error
51 #  define get_last_sys_error()    GetLastError()
52 #  define clear_sys_error()       SetLastError(0)
53 #  define set_sys_error(e)        SetLastError(e)
54 #  if !defined(WINNT)
55 #   define WIN_CONSOLE_BUG
56 #  endif
57 # else
58 # endif
59
60 # if (defined(WINDOWS) || defined(MSDOS))
61
62 #  ifdef __DJGPP__
63 #   include <unistd.h>
64 #   include <sys/stat.h>
65 #   define _setmode setmode
66 #   define _O_TEXT O_TEXT
67 #   define _O_BINARY O_BINARY
68 #   define HAS_LFN_SUPPORT(name)  (pathconf((name), _PC_NAME_MAX) > 12)
69 #   undef DEVRANDOM_EGD  /*  Neither MS-DOS nor FreeDOS provide 'egd' sockets.  */
70 #   undef DEVRANDOM
71 #   define DEVRANDOM "/dev/urandom\x24"
72 #  endif                        /* __DJGPP__ */
73
74 #  ifndef S_IFDIR
75 #   define S_IFDIR     _S_IFDIR
76 #  endif
77
78 #  ifndef S_IFMT
79 #   define S_IFMT      _S_IFMT
80 #  endif
81
82 #  if !defined(WINNT) && !defined(__DJGPP__)
83 #   define NO_SYSLOG
84 #  endif
85
86 #  ifdef WINDOWS
87 #   if !defined(_WIN32_WCE) && !defined(_WIN32_WINNT)
88        /*
89         * Defining _WIN32_WINNT here in e_os.h implies certain "discipline."
90         * Most notably we ought to check for availability of each specific
91         * routine that was introduced after denoted _WIN32_WINNT with
92         * GetProcAddress(). Normally newer functions are masked with higher
93         * _WIN32_WINNT in SDK headers. So that if you wish to use them in
94         * some module, you'd need to override _WIN32_WINNT definition in
95         * the target module in order to "reach for" prototypes, but replace
96         * calls to new functions with indirect calls. Alternatively it
97         * might be possible to achieve the goal by /DELAYLOAD-ing .DLLs
98         * and check for current OS version instead.
99         */
100 #    define _WIN32_WINNT 0x0501
101 #   endif
102 #   if defined(_WIN32_WINNT) || defined(_WIN32_WCE)
103        /*
104         * Just like defining _WIN32_WINNT including winsock2.h implies
105         * certain "discipline" for maintaining [broad] binary compatibility.
106         * As long as structures are invariant among Winsock versions,
107         * it's sufficient to check for specific Winsock2 API availability
108         * at run-time [DSO_global_lookup is recommended]...
109         */
110 #    include <winsock2.h>
111 #    include <ws2tcpip.h>
112        /* yes, they have to be #included prior to <windows.h> */
113 #   endif
114 #   include <windows.h>
115 #   include <stdio.h>
116 #   include <stddef.h>
117 #   include <errno.h>
118 #   if defined(_WIN32_WCE) && !defined(EACCES)
119 #    define EACCES   13
120 #   endif
121 #   include <string.h>
122 #   ifdef _WIN64
123 #    define strlen(s) _strlen31(s)
124 /* cut strings to 2GB */
125 static __inline unsigned int _strlen31(const char *str)
126 {
127     unsigned int len = 0;
128     while (*str && len < 0x80000000U)
129         str++, len++;
130     return len & 0x7FFFFFFF;
131 }
132 #   endif
133 #   include <malloc.h>
134 #   if defined(_MSC_VER) && !defined(_WIN32_WCE) && !defined(_DLL) && defined(stdin)
135 #    if _MSC_VER>=1300 && _MSC_VER<1600
136 #     undef stdin
137 #     undef stdout
138 #     undef stderr
139 FILE *__iob_func();
140 #     define stdin  (&__iob_func()[0])
141 #     define stdout (&__iob_func()[1])
142 #     define stderr (&__iob_func()[2])
143 #    elif _MSC_VER<1300 && defined(I_CAN_LIVE_WITH_LNK4049)
144 #     undef stdin
145 #     undef stdout
146 #     undef stderr
147          /*
148           * pre-1300 has __p__iob(), but it's available only in msvcrt.lib,
149           * or in other words with /MD. Declaring implicit import, i.e. with
150           * _imp_ prefix, works correctly with all compiler options, but
151           * without /MD results in LINK warning LNK4049: 'locally defined
152           * symbol "__iob" imported'.
153           */
154 extern FILE *_imp___iob;
155 #     define stdin  (&_imp___iob[0])
156 #     define stdout (&_imp___iob[1])
157 #     define stderr (&_imp___iob[2])
158 #    endif
159 #   endif
160 #  endif
161 #  include <io.h>
162 #  include <fcntl.h>
163
164 #  ifdef OPENSSL_SYS_WINCE
165 #   define OPENSSL_NO_POSIX_IO
166 #  endif
167
168 #  define EXIT(n) exit(n)
169 #  define LIST_SEPARATOR_CHAR ';'
170 #  ifndef W_OK
171 #   define W_OK        2
172 #  endif
173 #  ifndef R_OK
174 #   define R_OK        4
175 #  endif
176 #  ifdef OPENSSL_SYS_WINCE
177 #   define DEFAULT_HOME  ""
178 #  else
179 #   define DEFAULT_HOME  "C:"
180 #  endif
181
182 /* Avoid Visual Studio 13 GetVersion deprecated problems */
183 #  if defined(_MSC_VER) && _MSC_VER>=1800
184 #   define check_winnt() (1)
185 #   define check_win_minplat(x) (1)
186 #  else
187 #   define check_winnt() (GetVersion() < 0x80000000)
188 #   define check_win_minplat(x) (LOBYTE(LOWORD(GetVersion())) >= (x))
189 #  endif
190
191 # else                          /* The non-microsoft world */
192
193 #  if defined(OPENSSL_SYS_VXWORKS)
194 #   include <time.h>
195 #  else
196 #   include <sys/time.h>
197 #  endif
198
199 #  ifdef OPENSSL_SYS_VMS
200 #   define VMS 1
201   /*
202    * some programs don't include stdlib, so exit() and others give implicit
203    * function warnings
204    */
205 #   include <stdlib.h>
206 #   if defined(__DECC)
207 #    include <unistd.h>
208 #   else
209 #    include <unixlib.h>
210 #   endif
211 #   define LIST_SEPARATOR_CHAR ','
212   /* We don't have any well-defined random devices on VMS, yet... */
213 #   undef DEVRANDOM
214   /*-
215      We need to do this since VMS has the following coding on status codes:
216
217      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
218                The important thing to know is that odd numbers are considered
219                good, while even ones are considered errors.
220      Bits 3-15: actual status number
221      Bits 16-27: facility number.  0 is considered "unknown"
222      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
223                  output the message (which, for random codes, just looks ugly)
224
225      So, what we do here is to change 0 to 1 to get the default success status,
226      and everything else is shifted up to fit into the status number field, and
227      the status is tagged as an error, which is what is wanted here.
228
229      Finally, we add the VMS C facility code 0x35a000, because there are some
230      programs, such as Perl, that will reinterpret the code back to something
231      POSIX.  'man perlvms' explains it further.
232
233      NOTE: the perlvms manual wants to turn all codes 2 to 255 into success
234      codes (status type = 1).  I couldn't disagree more.  Fortunately, the
235      status type doesn't seem to bother Perl.
236      -- Richard Levitte
237   */
238 #   define EXIT(n)  exit((n) ? (((n) << 3) | 2 | 0x10000000 | 0x35a000) : 1)
239
240 #   define DEFAULT_HOME "SYS$LOGIN:"
241
242 #  else
243      /* !defined VMS */
244 #   include <unistd.h>
245 #   include <sys/types.h>
246 #   ifdef OPENSSL_SYS_WIN32_CYGWIN
247 #    include <io.h>
248 #    include <fcntl.h>
249 #   endif
250
251 #   define LIST_SEPARATOR_CHAR ':'
252 #   define EXIT(n)             exit(n)
253 #  endif
254
255 # endif
256
257 /***********************************************/
258
259 # if defined(OPENSSL_SYS_WINDOWS)
260 #  define strcasecmp _stricmp
261 #  define strncasecmp _strnicmp
262 #  if (_MSC_VER >= 1310)
263 #   define open _open
264 #   define fdopen _fdopen
265 #   define close _close
266 #   ifndef strdup
267 #    define strdup _strdup
268 #   endif
269 #   define unlink _unlink
270 #   define fileno _fileno
271 #  endif
272 # else
273 #  include <strings.h>
274 # endif
275
276 /* vxworks */
277 # if defined(OPENSSL_SYS_VXWORKS)
278 #  include <ioLib.h>
279 #  include <tickLib.h>
280 #  include <sysLib.h>
281 #  include <vxWorks.h>
282 #  include <sockLib.h>
283 #  include <taskLib.h>
284
285 #  define TTY_STRUCT int
286 #  define sleep(a) taskDelay((a) * sysClkRateGet())
287
288 /*
289  * NOTE: these are implemented by helpers in database app! if the database is
290  * not linked, we need to implement them elsewhere
291  */
292 struct hostent *gethostbyname(const char *name);
293 struct hostent *gethostbyaddr(const char *addr, int length, int type);
294 struct servent *getservbyname(const char *name, const char *proto);
295
296 # endif
297 /* end vxworks */
298
299 # ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
300 #  define CRYPTO_memcmp memcmp
301 # endif
302
303 /* unistd.h defines _POSIX_VERSION */
304 # if !defined(OPENSSL_NO_SECURE_MEMORY) && defined(OPENSSL_SYS_UNIX) \
305      && ( (defined(_POSIX_VERSION) && _POSIX_VERSION >= 200112L)      \
306           || defined(__sun) || defined(__hpux) || defined(__sgi)      \
307           || defined(__osf__) )
308 #  define OPENSSL_SECURE_MEMORY  /* secure memory is implemented */
309 # endif
310 #endif