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