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