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 #  if defined (__BORLANDC__)
 304 #   define _setmode setmode
 305 #   define _O_TEXT O_TEXT
 306 #   define _O_BINARY O_BINARY
 307 #   define _int64 __int64
 308 #   define _kbhit kbhit
 309 #  endif
 310
 311 #  define EXIT(n) exit(n)
 312 #  define LIST_SEPARATOR_CHAR ';'
 313 #  ifndef X_OK
 314 #   define X_OK        0
 315 #  endif
 316 #  ifndef W_OK
 317 #   define W_OK        2
 318 #  endif
 319 #  ifndef R_OK
 320 #   define R_OK        4
 321 #  endif
 322 #  ifdef OPENSSL_SYS_WINCE
 323 #   define DEFAULT_HOME  ""
 324 #  else
 325 #   define DEFAULT_HOME  "C:"
 326 #  endif
 327
 328 /* Avoid Visual Studio 13 GetVersion deprecated problems */
 329 #  if defined(_MSC_VER) && _MSC_VER>=1800
 330 #   define check_winnt() (1)
 331 #   define check_win_minplat(x) (1)
 332 #  else
 333 #   define check_winnt() (GetVersion() < 0x80000000)
 334 #   define check_win_minplat(x) (LOBYTE(LOWORD(GetVersion())) >= (x))
 335 #  endif
 336
 337 # else                          /* The non-microsoft world */
 338
 339 #  ifdef OPENSSL_SYS_VMS
 340 #   define VMS 1
 341   /*
 342    * some programs don't include stdlib, so exit() and others give implicit
 343    * function warnings
 344    */
 345 #   include <stdlib.h>
 346 #   if defined(__DECC)
 347 #    include <unistd.h>
 348 #   else
 349 #    include <unixlib.h>
 350 #   endif
 351 #   define LIST_SEPARATOR_CHAR ','
 352   /* We don't have any well-defined random devices on VMS, yet... */
 353 #   undef DEVRANDOM
 354   /*-
 355      We need to do this since VMS has the following coding on status codes:
 356
 357      Bits 0-2: status type: 0 = warning, 1 = success, 2 = error, 3 = info ...
 358                The important thing to know is that odd numbers are considered
 359                good, while even ones are considered errors.
 360      Bits 3-15: actual status number
 361      Bits 16-27: facility number.  0 is considered "unknown"
 362      Bits 28-31: control bits.  If bit 28 is set, the shell won't try to
 363                  output the message (which, for random codes, just looks ugly)
 364
 365      So, what we do here is to change 0 to 1 to get the default success status,
 366      and everything else is shifted up to fit into the status number field, and
 367      the status is tagged as an error, which is what is wanted here.
 368
 369      Finally, we add the VMS C facility code 0x35a000, because there are some
 370      programs, such as Perl, that will reinterpret the code back to something
 371      POSIXly.  'man perlvms' explains it further.
 372
 373      NOTE: the perlvms manual wants to turn all codes 2 to 255 into success
 374      codes (status type = 1).  I couldn't disagree more.  Fortunately, the
 375      status type doesn't seem to bother Perl.
 376      -- Richard Levitte
 377   */
 378 #   define EXIT(n)  exit((n) ? (((n) << 3) | 2 | 0x10000000 | 0x35a000) : 1)
 379
 380 #   define NO_SYS_PARAM_H
 381 #   define NO_SYS_UN_H
 382
 383 #  else
 384      /* !defined VMS */
 385 #   ifdef OPENSSL_UNISTD
 386 #    include OPENSSL_UNISTD
 387 #   else
 388 #    include <unistd.h>
 389 #   endif
 390 #   ifndef NO_SYS_TYPES_H
 391 #    include <sys/types.h>
 392 #   endif
 393 #   ifdef OPENSSL_SYS_WIN32_CYGWIN
 394 #    include <io.h>
 395 #    include <fcntl.h>
 396 #   endif
 397
 398 #   define LIST_SEPARATOR_CHAR ':'
 399 #   define EXIT(n)             exit(n)
 400 #  endif
 401
 402 # endif
 403
 404 /*************/
 405
 406 # if defined(OPENSSL_NO_SOCK) && !defined(OPENSSL_NO_DGRAM)
 407 #  define OPENSSL_NO_DGRAM
 408 # endif
 409
 410 # ifdef USE_SOCKETS
 411 #  ifdef OPENSSL_NO_SOCK
 412 #  elif defined(WINDOWS) || defined(MSDOS)
 413       /* windows world */
 414 #   if !defined(__DJGPP__)
 415 #    if defined(_WIN32_WCE) && _WIN32_WCE<410
 416 #     define getservbyname _masked_declaration_getservbyname
 417 #    endif
 418 #    if !defined(IPPROTO_IP)
 419          /* winsock[2].h was included already? */
 420 #     include <winsock.h>
 421 #    endif
 422 #    ifdef getservbyname
 423 #     undef getservbyname
 424          /* this is used to be wcecompat/include/winsock_extras.h */
 425 struct servent *PASCAL getservbyname(const char *, const char *);
 426 #    endif
 427
 428 #    ifdef _WIN64
 429 /*
 430  * Even though sizeof(SOCKET) is 8, it's safe to cast it to int, because
 431  * the value constitutes an index in per-process table of limited size
 432  * and not a real pointer. And we also depend on fact that all processors
 433  * Windows run on happen to be two's-complement, which allows to
 434  * interchange INVALID_SOCKET and -1.
 435  */
 436 #     define socket(d,t,p)   ((int)socket(d,t,p))
 437 #     define accept(s,f,l)   ((int)accept(s,f,l))
 438 #    endif
 439 #   else
 440 #   endif
 441
 442 #  else
 443
 444 #   ifndef NO_SYS_PARAM_H
 445 #    include <sys/param.h>
 446 #   endif
 447 #   ifdef OPENSSL_SYS_VXWORKS
 448 #    include <time.h>
 449 #   endif
 450
 451 #   include <netdb.h>
 452 #   if defined(OPENSSL_SYS_VMS_NODECC)
 453 #    include <socket.h>
 454 #    include <in.h>
 455 #    include <inet.h>
 456 #   else
 457 #    include <sys/socket.h>
 458 #    ifndef NO_SYS_UN_H
 459 #     ifdef OPENSSL_SYS_VXWORKS
 460 #      include <streams/un.h>
 461 #     else
 462 #      include <sys/un.h>
 463 #     endif
 464 #     ifndef UNIX_PATH_MAX
 465 #      define UNIX_PATH_MAX sizeof(((struct sockaddr_un *)NULL)->sun_path)
 466 #     endif
 467 #    endif
 468 #    ifdef FILIO_H
 469 #     include <sys/filio.h> /* FIONBIO in some SVR4, e.g. unixware, solaris */
 470 #    endif
 471 #    include <netinet/in.h>
 472 #    include <arpa/inet.h>
 473 #    include <netinet/tcp.h>
 474 #   endif
 475
 476 #   ifdef OPENSSL_SYS_AIX
 477 #    include <sys/select.h>
 478 #   endif
 479
 480 #   ifdef __QNX__
 481 #    include <sys/select.h>
 482 #   endif
 483
 484 #   ifndef VMS
 485 #    include <sys/ioctl.h>
 486 #   else
 487         /* ioctl is only in VMS > 7.0 and when socketshr is not used */
 488 #    if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
 489 #     include <sys/ioctl.h>
 490 #    endif
 491 #   endif
 492
 493 #   ifdef VMS
 494 #    include <unixio.h>
 495 #    if defined(TCPIP_TYPE_SOCKETSHR)
 496 #     include <socketshr.h>
 497 #    endif
 498 #   endif
 499
 500 #   ifndef INVALID_SOCKET
 501 #    define INVALID_SOCKET      (-1)
 502 #   endif                       /* INVALID_SOCKET */
 503 #  endif
 504
 505 /*
 506  * Some IPv6 implementations are broken, disable them in known bad versions.
 507  */
 508 #  if !defined(OPENSSL_USE_IPV6)
 509 #   if defined(AF_INET6) && !defined(NETWARE_CLIB)
 510 #    define OPENSSL_USE_IPV6 1
 511 #   else
 512 #    define OPENSSL_USE_IPV6 0
 513 #   endif
 514 #  endif
 515
 516 # endif
 517
 518 # ifndef OPENSSL_EXIT
 519 #  if defined(MONOLITH) && !defined(OPENSSL_C)
 520 #   define OPENSSL_EXIT(n) return(n)
 521 #  else
 522 #   define OPENSSL_EXIT(n) do { EXIT(n); return(n); } while(0)
 523 #  endif
 524 # endif
 525
 526 /***********************************************/
 527
 528 # if defined(OPENSSL_SYS_WINDOWS)
 529 #  define strcasecmp _stricmp
 530 #  define strncasecmp _strnicmp
 531 # elif defined(OPENSSL_SYS_VMS)
 532 /* VMS below version 7.0 doesn't have strcasecmp() */
 533 #  include "internal/o_str.h"
 534 #  define strcasecmp OPENSSL_strcasecmp
 535 #  define strncasecmp OPENSSL_strncasecmp
 536 #  define OPENSSL_IMPLEMENTS_strncasecmp
 537 # endif
 538
 539 /* vxworks */
 540 # if defined(OPENSSL_SYS_VXWORKS)
 541 #  include <ioLib.h>
 542 #  include <tickLib.h>
 543 #  include <sysLib.h>
 544
 545 #  define TTY_STRUCT int
 546
 547 #  define sleep(a) taskDelay((a) * sysClkRateGet())
 548
 549 #  include <vxWorks.h>
 550 #  include <sockLib.h>
 551 #  include <taskLib.h>
 552
 553 #  define getpid taskIdSelf
 554
 555 /*
 556  * NOTE: these are implemented by helpers in database app! if the database is
 557  * not linked, we need to implement them elswhere
 558  */
 559 struct hostent *gethostbyname(const char *name);
 560 struct hostent *gethostbyaddr(const char *addr, int length, int type);
 561 struct servent *getservbyname(const char *name, const char *proto);
 562
 563 # endif
 564 /* end vxworks */
 565
 566 #define OSSL_NELEM(x)    (sizeof(x)/sizeof(x[0]))
 567
 568 #ifdef  __cplusplus
 569 }
 570 #endif
 571
 572 #endif