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