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