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