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