e_os.h

   1 /*
   2  * Copyright 1995-2021 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (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 OSSL_E_OS_H
  11 # define OSSL_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 # if defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_UEFI)
  26 #  define NO_CHMOD
  27 #  define NO_SYSLOG
  28 # endif
  29
  30 # define get_last_sys_error()    errno
  31 # define clear_sys_error()       errno=0
  32 # define set_sys_error(e)        errno=(e)
  33
  34 /********************************************************************
  35  The Microsoft section
  36  ********************************************************************/
  37 # if defined(OPENSSL_SYS_WIN32) && !defined(WIN32)
  38 #  define WIN32
  39 # endif
  40 # if defined(OPENSSL_SYS_WINDOWS) && !defined(WINDOWS)
  41 #  define WINDOWS
  42 # endif
  43 # if defined(OPENSSL_SYS_MSDOS) && !defined(MSDOS)
  44 #  define MSDOS
  45 # endif
  46
  47 # ifdef WIN32
  48 #  undef get_last_sys_error
  49 #  undef clear_sys_error
  50 #  undef set_sys_error
  51 #  define get_last_sys_error()    GetLastError()
  52 #  define clear_sys_error()       SetLastError(0)
  53 #  define set_sys_error(e)        SetLastError(e)
  54 #  if !defined(WINNT)
  55 #   define WIN_CONSOLE_BUG
  56 #  endif
  57 # else
  58 # endif
  59
  60 # if (defined(WINDOWS) || defined(MSDOS))
  61
  62 #  ifdef __DJGPP__
  63 #   include <unistd.h>
  64 #   include <sys/stat.h>
  65 #   define _setmode setmode
  66 #   define _O_TEXT O_TEXT
  67 #   define _O_BINARY O_BINARY
  68 #   undef DEVRANDOM_EGD  /*  Neither MS-DOS nor FreeDOS provide 'egd' sockets.  */
  69 #   undef DEVRANDOM
  70 #   define DEVRANDOM "/dev/urandom\x24"
  71 #  endif                        /* __DJGPP__ */
  72
  73 #  ifndef S_IFDIR
  74 #   define S_IFDIR     _S_IFDIR
  75 #  endif
  76
  77 #  ifndef S_IFMT
  78 #   define S_IFMT      _S_IFMT
  79 #  endif
  80
  81 #  if !defined(WINNT) && !defined(__DJGPP__)
  82 #   define NO_SYSLOG
  83 #  endif
  84
  85 #  ifdef WINDOWS
  86 #   if !defined(_WIN32_WCE) && !defined(_WIN32_WINNT)
  87        /*
  88         * Defining _WIN32_WINNT here in e_os.h implies certain "discipline."
  89         * Most notably we ought to check for availability of each specific
  90         * routine that was introduced after denoted _WIN32_WINNT with
  91         * GetProcAddress(). Normally newer functions are masked with higher
  92         * _WIN32_WINNT in SDK headers. So that if you wish to use them in
  93         * some module, you'd need to override _WIN32_WINNT definition in
  94         * the target module in order to "reach for" prototypes, but replace
  95         * calls to new functions with indirect calls. Alternatively it
  96         * might be possible to achieve the goal by /DELAYLOAD-ing .DLLs
  97         * and check for current OS version instead.
  98         */
  99 #    define _WIN32_WINNT 0x0501
 100 #   endif
 101 #   if defined(_WIN32_WINNT) || defined(_WIN32_WCE)
 102        /*
 103         * Just like defining _WIN32_WINNT including winsock2.h implies
 104         * certain "discipline" for maintaining [broad] binary compatibility.
 105         * As long as structures are invariant among Winsock versions,
 106         * it's sufficient to check for specific Winsock2 API availability
 107         * at run-time [DSO_global_lookup is recommended]...
 108         */
 109 #    include <winsock2.h>
 110 #    include <ws2tcpip.h>
 111        /*
 112         * Clang-based C++Builder 10.3.3 toolchains cannot find C inline
 113         * definitions at link-time.  This header defines WspiapiLoad() as an
 114         * __inline function.  https://quality.embarcadero.com/browse/RSP-33806
 115         */
 116 #    if !defined(__BORLANDC__) || !defined(__clang__)
 117 #     include <wspiapi.h>
 118 #    endif
 119        /* yes, they have to be #included prior to <windows.h> */
 120 #   endif
 121 #   include <windows.h>
 122 #   include <stdio.h>
 123 #   include <stddef.h>
 124 #   include <errno.h>
 125 #   if defined(_WIN32_WCE) && !defined(EACCES)
 126 #    define EACCES   13
 127 #   endif
 128 #   include <string.h>
 129 #   ifdef _WIN64
 130 #    define strlen(s) _strlen31(s)
 131 /* cut strings to 2GB */
 132 static __inline unsigned int _strlen31(const char *str)
 133 {
 134     unsigned int len = 0;
 135     while (*str && len < 0x80000000U)
 136         str++, len++;
 137     return len & 0x7FFFFFFF;
 138 }
 139 #   endif
 140 #   include <malloc.h>
 141 #   if defined(_MSC_VER) && !defined(_WIN32_WCE) && !defined(_DLL) && defined(stdin)
 142 #    if _MSC_VER>=1300 && _MSC_VER<1600
 143 #     undef stdin
 144 #     undef stdout
 145 #     undef stderr
 146 FILE *__iob_func();
 147 #     define stdin  (&__iob_func()[0])
 148 #     define stdout (&__iob_func()[1])
 149 #     define stderr (&__iob_func()[2])
 150 #    elif _MSC_VER<1300 && defined(I_CAN_LIVE_WITH_LNK4049)
 151 #     undef stdin
 152 #     undef stdout
 153 #     undef stderr
 154          /*
 155           * pre-1300 has __p__iob(), but it's available only in msvcrt.lib,
 156           * or in other words with /MD. Declaring implicit import, i.e. with
 157           * _imp_ prefix, works correctly with all compiler options, but
 158           * without /MD results in LINK warning LNK4049: 'locally defined
 159           * symbol "__iob" imported'.
 160           */
 161 extern FILE *_imp___iob;
 162 #     define stdin  (&_imp___iob[0])
 163 #     define stdout (&_imp___iob[1])
 164 #     define stderr (&_imp___iob[2])
 165 #    endif
 166 #   endif
 167 #  endif
 168 #  include <io.h>
 169 #  include <fcntl.h>
 170
 171 #  ifdef OPENSSL_SYS_WINCE
 172 #   define OPENSSL_NO_POSIX_IO
 173 #  endif
 174
 175 #  define EXIT(n) exit(n)
 176 #  define LIST_SEPARATOR_CHAR ';'
 177 #  ifndef W_OK
 178 #   define W_OK        2
 179 #  endif
 180 #  ifndef R_OK
 181 #   define R_OK        4
 182 #  endif
 183 #  ifdef OPENSSL_SYS_WINCE
 184 #   define DEFAULT_HOME  ""
 185 #  else
 186 #   define DEFAULT_HOME  "C:"
 187 #  endif
 188
 189 /* Avoid Visual Studio 13 GetVersion deprecated problems */
 190 #  if defined(_MSC_VER) && _MSC_VER>=1800
 191 #   define check_winnt() (1)
 192 #   define check_win_minplat(x) (1)
 193 #  else
 194 #   define check_winnt() (GetVersion() < 0x80000000)
 195 #   define check_win_minplat(x) (LOBYTE(LOWORD(GetVersion())) >= (x))
 196 #  endif
 197
 198 # else                          /* The non-microsoft world */
 199
 200 #  if defined(OPENSSL_SYS_VXWORKS)
 201 #   include <time.h>
 202 #  else
 203 #   include <sys/time.h>
 204 #  endif
 205
 206 #  ifdef OPENSSL_SYS_VMS
 207 #   define VMS 1
 208   /*
 209    * some programs don't include stdlib, so exit() and others give implicit
 210    * function warnings
 211    */
 212 #   include <stdlib.h>
 213 #   if defined(__DECC)
 214 #    include <unistd.h>
 215 #   else
 216 #    include <unixlib.h>
 217 #   endif
 218 #   define LIST_SEPARATOR_CHAR ','
 219   /* We don't have any well-defined random devices on VMS, yet... */
 220 #   undef DEVRANDOM
 221   /*-
 222      We need to do this since VMS has the following coding on status codes:
 223
 224      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
 225                The important thing to know is that odd numbers are considered
 226                good, while even ones are considered errors.
 227      Bits 3-15: actual status number
 228      Bits 16-27: facility number.  0 is considered "unknown"
 229      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
 230                  output the message (which, for random codes, just looks ugly)
 231
 232      So, what we do here is to change 0 to 1 to get the default success status,
 233      and everything else is shifted up to fit into the status number field, and
 234      the status is tagged as an error, which is what is wanted here.
 235
 236      Finally, we add the VMS C facility code 0x35a000, because there are some
 237      programs, such as Perl, that will reinterpret the code back to something
 238      POSIX.  'man perlvms' explains it further.
 239
 240      NOTE: the perlvms manual wants to turn all codes 2 to 255 into success
 241      codes (status type = 1).  I couldn't disagree more.  Fortunately, the
 242      status type doesn't seem to bother Perl.
 243      -- Richard Levitte
 244   */
 245 #   define EXIT(n)  exit((n) ? (((n) << 3) | 2 | 0x10000000 | 0x35a000) : 1)
 246
 247 #   define DEFAULT_HOME "SYS$LOGIN:"
 248
 249 #  else
 250      /* !defined VMS */
 251 #   include <unistd.h>
 252 #   include <sys/types.h>
 253 #   ifdef OPENSSL_SYS_WIN32_CYGWIN
 254 #    include <io.h>
 255 #    include <fcntl.h>
 256 #   endif
 257
 258 #   define LIST_SEPARATOR_CHAR ':'
 259 #   define EXIT(n)             exit(n)
 260 #  endif
 261
 262 # endif
 263
 264 /***********************************************/
 265
 266 # if defined(OPENSSL_SYS_WINDOWS)
 267 #  define strcasecmp _stricmp
 268 #  define strncasecmp _strnicmp
 269 #  if (_MSC_VER >= 1310) && !defined(_WIN32_WCE)
 270 #   define open _open
 271 #   define fdopen _fdopen
 272 #   define close _close
 273 #   ifndef strdup
 274 #    define strdup _strdup
 275 #   endif
 276 #   define unlink _unlink
 277 #   define fileno _fileno
 278 #  endif
 279 # else
 280 #  include <strings.h>
 281 # endif
 282
 283 /* vxworks */
 284 # if defined(OPENSSL_SYS_VXWORKS)
 285 #  include <ioLib.h>
 286 #  include <tickLib.h>
 287 #  include <sysLib.h>
 288 #  include <vxWorks.h>
 289 #  include <sockLib.h>
 290 #  include <taskLib.h>
 291
 292 #  define TTY_STRUCT int
 293 #  define sleep(a) taskDelay((a) * sysClkRateGet())
 294
 295 /*
 296  * NOTE: these are implemented by helpers in database app! if the database is
 297  * not linked, we need to implement them elsewhere
 298  */
 299 struct hostent *gethostbyname(const char *name);
 300 struct hostent *gethostbyaddr(const char *addr, int length, int type);
 301 struct servent *getservbyname(const char *name, const char *proto);
 302
 303 # endif
 304 /* end vxworks */
 305
 306 /* ----------------------------- HP NonStop -------------------------------- */
 307 /* Required to support platform variant without getpid() and pid_t. */
 308 # if defined(__TANDEM) && defined(_GUARDIAN_TARGET)
 309 #  include <strings.h>
 310 #  include <netdb.h>
 311 #  define getservbyname(name,proto)          getservbyname((char*)name,proto)
 312 #  define gethostbyname(name)                gethostbyname((char*)name)
 313 #  define ioctlsocket(a,b,c)    ioctl(a,b,c)
 314 #  ifdef NO_GETPID
 315 inline int nssgetpid();
 316 #   ifndef NSSGETPID_MACRO
 317 #    define NSSGETPID_MACRO
 318 #    include <cextdecs.h(PROCESSHANDLE_GETMINE_)>
 319 #    include <cextdecs.h(PROCESSHANDLE_DECOMPOSE_)>
 320        inline int nssgetpid()
 321        {
 322          short phandle[10]={0};
 323          union pseudo_pid {
 324           struct {
 325            short cpu;
 326            short pin;
 327          } cpu_pin ;
 328          int ppid;
 329         } ppid = { 0 };
 330         PROCESSHANDLE_GETMINE_(phandle);
 331         PROCESSHANDLE_DECOMPOSE_(phandle, &ppid.cpu_pin.cpu, &ppid.cpu_pin.pin);
 332         return ppid.ppid;
 333        }
 334 #    define getpid(a) nssgetpid(a)
 335 #   endif /* NSSGETPID_MACRO */
 336 #  endif /* NO_GETPID */
 337 /*#  define setsockopt(a,b,c,d,f) setsockopt(a,b,c,(char*)d,f)*/
 338 /*#  define getsockopt(a,b,c,d,f) getsockopt(a,b,c,(char*)d,f)*/
 339 /*#  define connect(a,b,c) connect(a,(struct sockaddr *)b,c)*/
 340 /*#  define bind(a,b,c) bind(a,(struct sockaddr *)b,c)*/
 341 /*#  define sendto(a,b,c,d,e,f) sendto(a,(char*)b,c,d,(struct sockaddr *)e,f)*/
 342 #  if defined(OPENSSL_THREADS) && !defined(_PUT_MODEL_)
 343   /*
 344    * HPNS SPT threads
 345    */
 346 #   define  SPT_THREAD_SIGNAL 1
 347 #   define  SPT_THREAD_AWARE 1
 348 #   include <spthread.h>
 349 #   undef close
 350 #   define close spt_close
 351 /*
 352 #   define get_last_socket_error()      errno
 353 #   define clear_socket_error() errno=0
 354 #   define ioctlsocket(a,b,c)   ioctl(a,b,c)
 355 #   define closesocket(s)               close(s)
 356 #   define readsocket(s,b,n)    read((s),(char*)(b),(n))
 357 #   define writesocket(s,b,n)   write((s),(char*)(b),(n)
 358 */
 359 #   define accept(a,b,c)        accept(a,(struct sockaddr *)b,c)
 360 #   define recvfrom(a,b,c,d,e,f) recvfrom(a,b,(socklen_t)c,d,e,f)
 361 #  endif
 362 # endif
 363
 364 # ifdef FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION
 365 #  define CRYPTO_memcmp memcmp
 366 # endif
 367
 368 # ifndef OPENSSL_NO_SECURE_MEMORY
 369    /* unistd.h defines _POSIX_VERSION */
 370 #  if (defined(OPENSSL_SYS_UNIX) \
 371         && ( (defined(_POSIX_VERSION) && _POSIX_VERSION >= 200112L)      \
 372              || defined(__sun) || defined(__hpux) || defined(__sgi)      \
 373              || defined(__osf__) )) \
 374       || defined(_WIN32)
 375       /* secure memory is implemented */
 376 #   else
 377 #     define OPENSSL_NO_SECURE_MEMORY
 378 #   endif
 379 # endif
 380
 381 #endif