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