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