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