e_os.h

   1 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   2  * All rights reserved.
   3  *
   4  * This package is an SSL implementation written
   5  * by Eric Young (eay@cryptsoft.com).
   6  * The implementation was written so as to conform with Netscapes SSL.
   7  *
   8  * This library is free for commercial and non-commercial use as long as
   9  * the following conditions are aheared to.  The following conditions
  10  * apply to all code found in this distribution, be it the RC4, RSA,
  11  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  12  * included with this distribution is covered by the same copyright terms
  13  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  14  *
  15  * Copyright remains Eric Young's, and as such any Copyright notices in
  16  * the code are not to be removed.
  17  * If this package is used in a product, Eric Young should be given attribution
  18  * as the author of the parts of the library used.
  19  * This can be in the form of a textual message at program startup or
  20  * in documentation (online or textual) provided with the package.
  21  *
  22  * Redistribution and use in source and binary forms, with or without
  23  * modification, are permitted provided that the following conditions
  24  * are met:
  25  * 1. Redistributions of source code must retain the copyright
  26  *    notice, this list of conditions and the following disclaimer.
  27  * 2. Redistributions in binary form must reproduce the above copyright
  28  *    notice, this list of conditions and the following disclaimer in the
  29  *    documentation and/or other materials provided with the distribution.
  30  * 3. All advertising materials mentioning features or use of this software
  31  *    must display the following acknowledgement:
  32  *    "This product includes cryptographic software written by
  33  *     Eric Young (eay@cryptsoft.com)"
  34  *    The word 'cryptographic' can be left out if the rouines from the library
  35  *    being used are not cryptographic related :-).
  36  * 4. If you include any Windows specific code (or a derivative thereof) from
  37  *    the apps directory (application code) you must include an acknowledgement:
  38  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  41  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  43  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  46  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  48  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  49  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  50  * SUCH DAMAGE.
  51  *
  52  * The licence and distribution terms for any publically available version or
  53  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  54  * copied and put under another distribution licence
  55  * [including the GNU Public Licence.]
  56  */
  57
  58 #ifndef HEADER_E_OS_H
  59 # define HEADER_E_OS_H
  60
  61 # include <openssl/opensslconf.h>
  62
  63 # include <openssl/e_os2.h>
  64 /*
  65  * <openssl/e_os2.h> contains what we can justify to make visible to the
  66  * outside; this file e_os.h is not part of the exported interface.
  67  */
  68
  69 #ifdef  __cplusplus
  70 extern "C" {
  71 #endif
  72
  73 /* Used to checking reference counts, most while doing perl5 stuff :-) */
  74 # if defined(OPENSSL_NO_STDIO)
  75 #  if defined(REF_DEBUG)
  76 #   error "REF_DEBUG requires stdio"
  77 #  endif
  78 #  if defined(REF_PRINT)
  79 #   error "REF_PRINT requires stdio"
  80 #  endif
  81 # endif
  82
  83 # if defined(REF_DEBUG)
  84 #  define REF_ASSERT_ISNT(test) \
  85     (void)((test) ? (OPENSSL_die("refcount error", __FILE__, __LINE__), 1) : 0)
  86 # else
  87 #  define REF_ASSERT_ISNT(i)
  88 # endif
  89 # ifdef REF_PRINT
  90 #  define REF_PRINT_COUNT(a, b) \
  91         fprintf(stderr, "%p:%4d:%s\n", b, b->references, a)
  92 # else
  93 #  define REF_PRINT_COUNT(a, b)
  94 # endif
  95
  96 # define osslargused(x)      (void)x
  97 # define OPENSSL_CONF        "openssl.cnf"
  98
  99 # ifndef DEVRANDOM
 100 /*
 101  * set this to a comma-separated list of 'random' device files to try out. My
 102  * default, we will try to read at least one of these files
 103  */
 104 #  define DEVRANDOM "/dev/urandom","/dev/random","/dev/srandom"
 105 # endif
 106 # if !defined(OPENSSL_NO_EGD) && !defined(DEVRANDOM_EGD)
 107 /*
 108  * set this to a comma-separated list of 'egd' sockets to try out. These
 109  * sockets will be tried in the order listed in case accessing the device
 110  * files listed in DEVRANDOM did not return enough entropy.
 111  */
 112 #  define DEVRANDOM_EGD "/var/run/egd-pool","/dev/egd-pool","/etc/egd-pool","/etc/entropy"
 113 # endif
 114
 115 # if defined(OPENSSL_SYS_VXWORKS)
 116 #  define NO_SYS_PARAM_H
 117 #  define NO_CHMOD
 118 #  define NO_SYSLOG
 119 # endif
 120
 121 /********************************************************************
 122  The Microsoft section
 123  ********************************************************************/
 124 # if defined(OPENSSL_SYS_WIN32) && !defined(WIN32)
 125 #  define WIN32
 126 # endif
 127 # if defined(OPENSSL_SYS_WINDOWS) && !defined(WINDOWS)
 128 #  define WINDOWS
 129 # endif
 130 # if defined(OPENSSL_SYS_MSDOS) && !defined(MSDOS)
 131 #  define MSDOS
 132 # endif
 133
 134 # if (defined(MSDOS) || defined(OPENSSL_SYS_UEFI)) && !defined(GETPID_IS_MEANINGLESS)
 135 #  define GETPID_IS_MEANINGLESS
 136 # endif
 137
 138 # ifdef WIN32
 139 #  define NO_SYS_UN_H
 140 #  define get_last_sys_error()    GetLastError()
 141 #  define clear_sys_error()       SetLastError(0)
 142 #  if !defined(WINNT)
 143 #   define WIN_CONSOLE_BUG
 144 #  endif
 145 # else
 146 #  define get_last_sys_error()    errno
 147 #  define clear_sys_error()       errno=0
 148 # endif
 149
 150 # if defined(WINDOWS)
 151 #  define get_last_socket_error() WSAGetLastError()
 152 #  define clear_socket_error()    WSASetLastError(0)
 153 #  define readsocket(s,b,n)       recv((s),(b),(n),0)
 154 #  define writesocket(s,b,n)      send((s),(b),(n),0)
 155 # elif defined(__DJGPP__)
 156 #  define WATT32
 157 #  define get_last_socket_error() errno
 158 #  define clear_socket_error()    errno=0
 159 #  define closesocket(s)          close_s(s)
 160 #  define readsocket(s,b,n)       read_s(s,b,n)
 161 #  define writesocket(s,b,n)      send(s,b,n,0)
 162 # elif defined(OPENSSL_SYS_VMS)
 163 #  define get_last_socket_error() errno
 164 #  define clear_socket_error()    errno=0
 165 #  define ioctlsocket(a,b,c)      ioctl(a,b,c)
 166 #  define closesocket(s)          close(s)
 167 #  define readsocket(s,b,n)       recv((s),(b),(n),0)
 168 #  define writesocket(s,b,n)      send((s),(b),(n),0)
 169 # elif defined(OPENSSL_SYS_VXWORKS)
 170 #  define get_last_socket_error() errno
 171 #  define clear_socket_error()    errno=0
 172 #  define ioctlsocket(a,b,c)          ioctl((a),(b),(int)(c))
 173 #  define closesocket(s)              close(s)
 174 #  define readsocket(s,b,n)           read((s),(b),(n))
 175 #  define writesocket(s,b,n)          write((s),(char *)(b),(n))
 176 # else
 177 #  define get_last_socket_error() errno
 178 #  define clear_socket_error()    errno=0
 179 #  define ioctlsocket(a,b,c)      ioctl(a,b,c)
 180 #  define closesocket(s)          close(s)
 181 #  define readsocket(s,b,n)       read((s),(b),(n))
 182 #  define writesocket(s,b,n)      write((s),(b),(n))
 183 # endif
 184
 185 # if (defined(WINDOWS) || defined(MSDOS))
 186
 187 #  ifdef __DJGPP__
 188 #   include <unistd.h>
 189 #   include <sys/stat.h>
 190 #   include <sys/socket.h>
 191 #   include <tcp.h>
 192 #   include <netdb.h>
 193 #   define _setmode setmode
 194 #   define _O_TEXT O_TEXT
 195 #   define _O_BINARY O_BINARY
 196 #   undef DEVRANDOM
 197 #   define DEVRANDOM "/dev/urandom\x24"
 198 #  endif                        /* __DJGPP__ */
 199
 200 #  ifndef S_IFDIR
 201 #   define S_IFDIR     _S_IFDIR
 202 #  endif
 203
 204 #  ifndef S_IFMT
 205 #   define S_IFMT      _S_IFMT
 206 #  endif
 207
 208 #  if !defined(WINNT) && !defined(__DJGPP__)
 209 #   define NO_SYSLOG
 210 #  endif
 211 #  define NO_DIRENT
 212
 213 #  ifdef WINDOWS
 214 #   if !defined(_WIN32_WCE) && !defined(_WIN32_WINNT)
 215        /*
 216         * Defining _WIN32_WINNT here in e_os.h implies certain "discipline."
 217         * Most notably we ought to check for availability of each specific
 218         * routine that was introduced after denoted _WIN32_WINNT with
 219         * GetProcAddress(). Normally newer functions are masked with higher
 220         * _WIN32_WINNT in SDK headers. So that if you wish to use them in
 221         * some module, you'd need to override _WIN32_WINNT definition in
 222         * the target module in order to "reach for" prototypes, but replace
 223         * calls to new functions with indirect calls. Alternatively it
 224         * might be possible to achieve the goal by /DELAYLOAD-ing .DLLs
 225         * and check for current OS version instead.
 226         */
 227 #    define _WIN32_WINNT 0x0501
 228 #   endif
 229 #   if !defined(OPENSSL_NO_SOCK) && (defined(_WIN32_WINNT) || defined(_WIN32_WCE))
 230        /*
 231         * Just like defining _WIN32_WINNT including winsock2.h implies
 232         * certain "discipline" for maintaining [broad] binary compatibility.
 233         * As long as structures are invariant among Winsock versions,
 234         * it's sufficient to check for specific Winsock2 API availability
 235         * at run-time [DSO_global_lookup is recommended]...
 236         */
 237 #    include <winsock2.h>
 238 #    include <ws2tcpip.h>
 239        /* yes, they have to be #included prior to <windows.h> */
 240 #   endif
 241 #   include <windows.h>
 242 #   include <stdio.h>
 243 #   include <stddef.h>
 244 #   include <errno.h>
 245 #   if defined(_WIN32_WCE) && !defined(EACCES)
 246 #    define EACCES   13
 247 #   endif
 248 #   include <string.h>
 249 #   ifdef _WIN64
 250 #    define strlen(s) _strlen31(s)
 251 /* cut strings to 2GB */
 252 static __inline unsigned int _strlen31(const char *str)
 253 {
 254     unsigned int len = 0;
 255     while (*str && len < 0x80000000U)
 256         str++, len++;
 257     return len & 0x7FFFFFFF;
 258 }
 259 #   endif
 260 #   include <malloc.h>
 261 #   if defined(_MSC_VER) && _MSC_VER<=1200 && defined(_MT) && defined(isspace)
 262        /* compensate for bug in VC6 ctype.h */
 263 #    undef isspace
 264 #    undef isdigit
 265 #    undef isalnum
 266 #    undef isupper
 267 #    undef isxdigit
 268 #   endif
 269 #   if defined(_MSC_VER) && !defined(_WIN32_WCE) && !defined(_DLL) && defined(stdin)
 270 #    if _MSC_VER>=1300 && _MSC_VER<1600
 271 #     undef stdin
 272 #     undef stdout
 273 #     undef stderr
 274 FILE *__iob_func();
 275 #     define stdin  (&__iob_func()[0])
 276 #     define stdout (&__iob_func()[1])
 277 #     define stderr (&__iob_func()[2])
 278 #    elif _MSC_VER<1300 && defined(I_CAN_LIVE_WITH_LNK4049)
 279 #     undef stdin
 280 #     undef stdout
 281 #     undef stderr
 282          /*
 283           * pre-1300 has __p__iob(), but it's available only in msvcrt.lib,
 284           * or in other words with /MD. Declaring implicit import, i.e. with
 285           * _imp_ prefix, works correctly with all compiler options, but
 286           * without /MD results in LINK warning LNK4049: 'locally defined
 287           * symbol "__iob" imported'.
 288           */
 289 extern FILE *_imp___iob;
 290 #     define stdin  (&_imp___iob[0])
 291 #     define stdout (&_imp___iob[1])
 292 #     define stderr (&_imp___iob[2])
 293 #    endif
 294 #   endif
 295 #  endif
 296 #  include <io.h>
 297 #  include <fcntl.h>
 298
 299 #  ifdef OPENSSL_SYS_WINCE
 300 #   define OPENSSL_NO_POSIX_IO
 301 #  endif
 302
 303 #  define EXIT(n) exit(n)
 304 #  define LIST_SEPARATOR_CHAR ';'
 305 #  ifndef X_OK
 306 #   define X_OK        0
 307 #  endif
 308 #  ifndef W_OK
 309 #   define W_OK        2
 310 #  endif
 311 #  ifndef R_OK
 312 #   define R_OK        4
 313 #  endif
 314 #  ifdef OPENSSL_SYS_WINCE
 315 #   define DEFAULT_HOME  ""
 316 #  else
 317 #   define DEFAULT_HOME  "C:"
 318 #  endif
 319
 320 /* Avoid Visual Studio 13 GetVersion deprecated problems */
 321 #  if defined(_MSC_VER) && _MSC_VER>=1800
 322 #   define check_winnt() (1)
 323 #   define check_win_minplat(x) (1)
 324 #  else
 325 #   define check_winnt() (GetVersion() < 0x80000000)
 326 #   define check_win_minplat(x) (LOBYTE(LOWORD(GetVersion())) >= (x))
 327 #  endif
 328
 329 # else                          /* The non-microsoft world */
 330
 331 #  ifdef OPENSSL_SYS_VMS
 332 #   define VMS 1
 333   /*
 334    * some programs don't include stdlib, so exit() and others give implicit
 335    * function warnings
 336    */
 337 #   include <stdlib.h>
 338 #   if defined(__DECC)
 339 #    include <unistd.h>
 340 #   else
 341 #    include <unixlib.h>
 342 #   endif
 343 #   define LIST_SEPARATOR_CHAR ','
 344   /* We don't have any well-defined random devices on VMS, yet... */
 345 #   undef DEVRANDOM
 346   /*-
 347      We need to do this since VMS has the following coding on status codes:
 348
 349      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
 350                The important thing to know is that odd numbers are considered
 351                good, while even ones are considered errors.
 352      Bits 3-15: actual status number
 353      Bits 16-27: facility number.  0 is considered "unknown"
 354      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
 355                  output the message (which, for random codes, just looks ugly)
 356
 357      So, what we do here is to change 0 to 1 to get the default success status,
 358      and everything else is shifted up to fit into the status number field, and
 359      the status is tagged as an error, which is what is wanted here.
 360
 361      Finally, we add the VMS C facility code 0x35a000, because there are some
 362      programs, such as Perl, that will reinterpret the code back to something
 363      POSIXly.  'man perlvms' explains it further.
 364
 365      NOTE: the perlvms manual wants to turn all codes 2 to 255 into success
 366      codes (status type = 1).  I couldn't disagree more.  Fortunately, the
 367      status type doesn't seem to bother Perl.
 368      -- Richard Levitte
 369   */
 370 #   define EXIT(n)  exit((n) ? (((n) << 3) | 2 | 0x10000000 | 0x35a000) : 1)
 371
 372 #   define NO_SYS_PARAM_H
 373 #   define NO_SYS_UN_H
 374
 375 #  else
 376      /* !defined VMS */
 377 #   ifdef OPENSSL_UNISTD
 378 #    include OPENSSL_UNISTD
 379 #   else
 380 #    include <unistd.h>
 381 #   endif
 382 #   ifndef NO_SYS_TYPES_H
 383 #    include <sys/types.h>
 384 #   endif
 385 #   ifdef OPENSSL_SYS_WIN32_CYGWIN
 386 #    include <io.h>
 387 #    include <fcntl.h>
 388 #   endif
 389
 390 #   define LIST_SEPARATOR_CHAR ':'
 391 #   define EXIT(n)             exit(n)
 392 #  endif
 393
 394 # endif
 395
 396 /*************/
 397
 398 # if defined(OPENSSL_NO_SOCK) && !defined(OPENSSL_NO_DGRAM)
 399 #  define OPENSSL_NO_DGRAM
 400 # endif
 401
 402 # ifdef USE_SOCKETS
 403 #  ifdef OPENSSL_NO_SOCK
 404 #  elif defined(WINDOWS) || defined(MSDOS)
 405       /* windows world */
 406 #   if !defined(__DJGPP__)
 407 #    if defined(_WIN32_WCE) && _WIN32_WCE<410
 408 #     define getservbyname _masked_declaration_getservbyname
 409 #    endif
 410 #    if !defined(IPPROTO_IP)
 411          /* winsock[2].h was included already? */
 412 #     include <winsock.h>
 413 #    endif
 414 #    ifdef getservbyname
 415 #     undef getservbyname
 416          /* this is used to be wcecompat/include/winsock_extras.h */
 417 struct servent *PASCAL getservbyname(const char *, const char *);
 418 #    endif
 419
 420 #    ifdef _WIN64
 421 /*
 422  * Even though sizeof(SOCKET) is 8, it's safe to cast it to int, because
 423  * the value constitutes an index in per-process table of limited size
 424  * and not a real pointer. And we also depend on fact that all processors
 425  * Windows run on happen to be two's-complement, which allows to
 426  * interchange INVALID_SOCKET and -1.
 427  */
 428 #     define socket(d,t,p)   ((int)socket(d,t,p))
 429 #     define accept(s,f,l)   ((int)accept(s,f,l))
 430 #    endif
 431 #   else
 432 #   endif
 433
 434 #  else
 435
 436 #   ifndef NO_SYS_PARAM_H
 437 #    include <sys/param.h>
 438 #   endif
 439 #   ifdef OPENSSL_SYS_VXWORKS
 440 #    include <time.h>
 441 #   endif
 442
 443 #   include <netdb.h>
 444 #   if defined(OPENSSL_SYS_VMS_NODECC)
 445 #    include <socket.h>
 446 #    include <in.h>
 447 #    include <inet.h>
 448 #   else
 449 #    include <sys/socket.h>
 450 #    ifndef NO_SYS_UN_H
 451 #     ifdef OPENSSL_SYS_VXWORKS
 452 #      include <streams/un.h>
 453 #     else
 454 #      include <sys/un.h>
 455 #     endif
 456 #     ifndef UNIX_PATH_MAX
 457 #      define UNIX_PATH_MAX sizeof(((struct sockaddr_un *)NULL)->sun_path)
 458 #     endif
 459 #    endif
 460 #    ifdef FILIO_H
 461 #     include <sys/filio.h> /* FIONBIO in some SVR4, e.g. unixware, solaris */
 462 #    endif
 463 #    include <netinet/in.h>
 464 #    include <arpa/inet.h>
 465 #    include <netinet/tcp.h>
 466 #   endif
 467
 468 #   ifdef OPENSSL_SYS_AIX
 469 #    include <sys/select.h>
 470 #   endif
 471
 472 #   ifdef __QNX__
 473 #    include <sys/select.h>
 474 #   endif
 475
 476 #   ifndef VMS
 477 #    include <sys/ioctl.h>
 478 #   else
 479         /* ioctl is only in VMS > 7.0 and when socketshr is not used */
 480 #    if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
 481 #     include <sys/ioctl.h>
 482 #    endif
 483 #   endif
 484
 485 #   ifdef VMS
 486 #    include <unixio.h>
 487 #    if defined(TCPIP_TYPE_SOCKETSHR)
 488 #     include <socketshr.h>
 489 #    endif
 490 #   endif
 491
 492 #   ifndef INVALID_SOCKET
 493 #    define INVALID_SOCKET      (-1)
 494 #   endif                       /* INVALID_SOCKET */
 495 #  endif
 496
 497 /*
 498  * Some IPv6 implementations are broken, disable them in known bad versions.
 499  */
 500 #  if !defined(OPENSSL_USE_IPV6)
 501 #   if defined(AF_INET6) && !defined(NETWARE_CLIB)
 502 #    define OPENSSL_USE_IPV6 1
 503 #   else
 504 #    define OPENSSL_USE_IPV6 0
 505 #   endif
 506 #  endif
 507
 508 # endif
 509
 510 # ifndef OPENSSL_EXIT
 511 #  if defined(MONOLITH) && !defined(OPENSSL_C)
 512 #   define OPENSSL_EXIT(n) return(n)
 513 #  else
 514 #   define OPENSSL_EXIT(n) do { EXIT(n); return(n); } while(0)
 515 #  endif
 516 # endif
 517
 518 /***********************************************/
 519
 520 # if defined(OPENSSL_SYS_WINDOWS)
 521 #  define strcasecmp _stricmp
 522 #  define strncasecmp _strnicmp
 523 # elif defined(OPENSSL_SYS_VMS)
 524 /* VMS below version 7.0 doesn't have strcasecmp() */
 525 #  include "internal/o_str.h"
 526 #  define strcasecmp OPENSSL_strcasecmp
 527 #  define strncasecmp OPENSSL_strncasecmp
 528 #  define OPENSSL_IMPLEMENTS_strncasecmp
 529 # endif
 530
 531 /* vxworks */
 532 # if defined(OPENSSL_SYS_VXWORKS)
 533 #  include <ioLib.h>
 534 #  include <tickLib.h>
 535 #  include <sysLib.h>
 536
 537 #  define TTY_STRUCT int
 538
 539 #  define sleep(a) taskDelay((a) * sysClkRateGet())
 540
 541 #  include <vxWorks.h>
 542 #  include <sockLib.h>
 543 #  include <taskLib.h>
 544
 545 #  define getpid taskIdSelf
 546
 547 /*
 548  * NOTE: these are implemented by helpers in database app! if the database is
 549  * not linked, we need to implement them elswhere
 550  */
 551 struct hostent *gethostbyname(const char *name);
 552 struct hostent *gethostbyaddr(const char *addr, int length, int type);
 553 struct servent *getservbyname(const char *name, const char *proto);
 554
 555 # endif
 556 /* end vxworks */
 557
 558 #define OSSL_NELEM(x)    (sizeof(x)/sizeof(x[0]))
 559
 560 #ifdef  __cplusplus
 561 }
 562 #endif
 563
 564 #endif