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