programs/platform.h

   1 /*
   2  * Copyright (c) 2016-present, Przemyslaw Skibinski, Yann Collet, Facebook, Inc.
   3  * All rights reserved.
   4  *
   5  * This source code is licensed under both the BSD-style license (found in the
   6  * LICENSE file in the root directory of this source tree) and the GPLv2 (found
   7  * in the COPYING file in the root directory of this source tree).
   8  * You may select, at your option, one of the above-listed licenses.
   9  */
  10
  11 #ifndef PLATFORM_H_MODULE
  12 #define PLATFORM_H_MODULE
  13
  14 #if defined (__cplusplus)
  15 extern "C" {
  16 #endif
  17
  18
  19
  20 /* **************************************
  21 *  Compiler Options
  22 ****************************************/
  23 #if defined(_MSC_VER)
  24 #  define _CRT_SECURE_NO_WARNINGS    /* Disable Visual Studio warning messages for fopen, strncpy, strerror */
  25 #  if (_MSC_VER <= 1800)             /* 1800 == Visual Studio 2013 */
  26 #    define _CRT_SECURE_NO_DEPRECATE /* VS2005 - must be declared before <io.h> and <windows.h> */
  27 #    define snprintf sprintf_s       /* snprintf unsupported by Visual <= 2013 */
  28 #  endif
  29 #  pragma warning(disable : 4127)    /* disable: C4127: conditional expression is constant */
  30 #endif
  31
  32
  33 /* **************************************
  34 *  Detect 64-bit OS
  35 *  http://nadeausoftware.com/articles/2012/02/c_c_tip_how_detect_processor_type_using_compiler_predefined_macros
  36 ****************************************/
  37 #if defined __ia64 || defined _M_IA64                                                                               /* Intel Itanium */ \
  38   || defined __powerpc64__ || defined __ppc64__ || defined __PPC64__                                                /* POWER 64-bit */  \
  39   || (defined __sparc && (defined __sparcv9 || defined __sparc_v9__ || defined __arch64__)) || defined __sparc64__  /* SPARC 64-bit */  \
  40   || defined __x86_64__s || defined _M_X64                                                                          /* x86 64-bit */    \
  41   || defined __arm64__ || defined __aarch64__ || defined __ARM64_ARCH_8__                                           /* ARM 64-bit */    \
  42   || (defined __mips  && (__mips == 64 || __mips == 4 || __mips == 3))                                              /* MIPS 64-bit */   \
  43   || defined _LP64 || defined __LP64__ /* NetBSD, OpenBSD */ || defined __64BIT__ /* AIX */ || defined _ADDR64 /* Cray */               \
  44   || (defined __SIZEOF_POINTER__ && __SIZEOF_POINTER__ == 8) /* gcc */
  45 #  if !defined(__64BIT__)
  46 #    define __64BIT__  1
  47 #  endif
  48 #endif
  49
  50
  51 /* *********************************************************
  52 *  Turn on Large Files support (>4GB) for 32-bit Linux/Unix
  53 ***********************************************************/
  54 #if !defined(__64BIT__) || defined(__MINGW32__)    /* No point defining Large file for 64 bit but MinGW-w64 requires it */
  55 #  if !defined(_FILE_OFFSET_BITS)
  56 #    define _FILE_OFFSET_BITS 64                   /* turn off_t into a 64-bit type for ftello, fseeko */
  57 #  endif
  58 #  if !defined(_LARGEFILE_SOURCE)                  /* obsolete macro, replaced with _FILE_OFFSET_BITS */
  59 #    define _LARGEFILE_SOURCE 1                    /* Large File Support extension (LFS) - fseeko, ftello */
  60 #  endif
  61 #  if defined(_AIX) || defined(__hpux)
  62 #    define _LARGE_FILES                           /* Large file support on 32-bits AIX and HP-UX */
  63 #  endif
  64 #endif
  65
  66
  67 /* ************************************************************
  68 *  Detect POSIX version
  69 *  PLATFORM_POSIX_VERSION = 0 for non-Unix e.g. Windows
  70 *  PLATFORM_POSIX_VERSION = 1 for Unix-like but non-POSIX
  71 *  PLATFORM_POSIX_VERSION > 1 is equal to found _POSIX_VERSION
  72 *  Value of PLATFORM_POSIX_VERSION can be forced on command line
  73 ***************************************************************/
  74 #ifndef PLATFORM_POSIX_VERSION
  75
  76 #  if (defined(__APPLE__) && defined(__MACH__)) || defined(__SVR4) || defined(_AIX) || defined(__hpux) /* POSIX.1-2001 (SUSv3) conformant */ \
  77      || defined(__DragonFly__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)  /* BSD distros */
  78      /* exception rule : force posix version to 200112L,
  79       * note: it's better to use unistd.h's _POSIX_VERSION whenever possible */
  80 #    define PLATFORM_POSIX_VERSION 200112L
  81
  82 /* try to determine posix version through official unistd.h's _POSIX_VERSION (http://pubs.opengroup.org/onlinepubs/7908799/xsh/unistd.h.html).
  83  * note : there is no simple way to know in advance if <unistd.h> is present or not on target system,
  84  * Posix specification mandates its presence and its content, but target system must respect this spec.
  85  * It's necessary to _not_ #include <unistd.h> whenever target OS is not unix-like
  86  * otherwise it will block preprocessing stage.
  87  * The following list of build macros tries to "guess" if target OS is likely unix-like, and therefore can #include <unistd.h>
  88  */
  89 #  elif !defined(_WIN32) \
  90      && (defined(__unix__) || defined(__unix) \
  91      || defined(__midipix__) || defined(__VMS) || defined(__HAIKU__))
  92
  93 #    if defined(__linux__) || defined(__linux)
  94 #      ifndef _POSIX_C_SOURCE
  95 #        define _POSIX_C_SOURCE 200112L  /* feature test macro : https://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html */
  96 #      endif
  97 #    endif
  98 #    include <unistd.h>  /* declares _POSIX_VERSION */
  99 #    if defined(_POSIX_VERSION)  /* POSIX compliant */
 100 #      define PLATFORM_POSIX_VERSION _POSIX_VERSION
 101 #    else
 102 #      define PLATFORM_POSIX_VERSION 1
 103 #    endif
 104
 105 #  else  /* non-unix target platform (like Windows) */
 106 #    define PLATFORM_POSIX_VERSION 0
 107 #  endif
 108
 109 #endif   /* PLATFORM_POSIX_VERSION */
 110
 111 /*-*********************************************
 112 *  Detect if isatty() and fileno() are available
 113 ************************************************/
 114 #if (defined(__linux__) && (PLATFORM_POSIX_VERSION > 1)) \
 115  || (PLATFORM_POSIX_VERSION >= 200112L) \
 116  || defined(__DJGPP__) \
 117  || defined(__MSYS__)
 118 #  include <unistd.h>   /* isatty */
 119 #  define IS_CONSOLE(stdStream) isatty(fileno(stdStream))
 120 #elif defined(MSDOS) || defined(OS2) || defined(__CYGWIN__)
 121 #  include <io.h>       /* _isatty */
 122 #  define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream))
 123 #elif defined(WIN32) || defined(_WIN32)
 124 #  include <io.h>      /* _isatty */
 125 #  include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
 126 #  include <stdio.h>   /* FILE */
 127 static __inline int IS_CONSOLE(FILE* stdStream) {
 128     DWORD dummy;
 129     return _isatty(_fileno(stdStream)) && GetConsoleMode((HANDLE)_get_osfhandle(_fileno(stdStream)), &dummy);
 130 }
 131 #else
 132 #  define IS_CONSOLE(stdStream) 0
 133 #endif
 134
 135
 136 /******************************
 137 *  OS-specific IO behaviors
 138 ******************************/
 139 #if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(_WIN32)
 140 #  include <fcntl.h>   /* _O_BINARY */
 141 #  include <io.h>      /* _setmode, _fileno, _get_osfhandle */
 142 #  if !defined(__DJGPP__)
 143 #    include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
 144 #    include <winioctl.h> /* FSCTL_SET_SPARSE */
 145 #    define SET_BINARY_MODE(file) { int const unused=_setmode(_fileno(file), _O_BINARY); (void)unused; }
 146 #    define SET_SPARSE_FILE_MODE(file) { DWORD dw; DeviceIoControl((HANDLE) _get_osfhandle(_fileno(file)), FSCTL_SET_SPARSE, 0, 0, 0, 0, &dw, 0); }
 147 #  else
 148 #    define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
 149 #    define SET_SPARSE_FILE_MODE(file)
 150 #  endif
 151 #else
 152 #  define SET_BINARY_MODE(file)
 153 #  define SET_SPARSE_FILE_MODE(file)
 154 #endif
 155
 156
 157 #ifndef ZSTD_SPARSE_DEFAULT
 158 #  if (defined(__APPLE__) && defined(__MACH__))
 159 #    define ZSTD_SPARSE_DEFAULT 0
 160 #  else
 161 #    define ZSTD_SPARSE_DEFAULT 1
 162 #  endif
 163 #endif
 164
 165
 166 #ifndef ZSTD_START_SYMBOLLIST_FRAME
 167 #  ifdef __linux__
 168 #    define ZSTD_START_SYMBOLLIST_FRAME 2
 169 #  elif defined __APPLE__
 170 #    define ZSTD_START_SYMBOLLIST_FRAME 4
 171 #  else
 172 #    define ZSTD_START_SYMBOLLIST_FRAME 0
 173 #  endif
 174 #endif
 175
 176
 177 #ifndef ZSTD_SETPRIORITY_SUPPORT
 178    /* mandates presence of <sys/resource.h> and support for setpriority() : http://man7.org/linux/man-pages/man2/setpriority.2.html */
 179 #  define ZSTD_SETPRIORITY_SUPPORT (PLATFORM_POSIX_VERSION >= 200112L)
 180 #endif
 181
 182
 183 #ifndef ZSTD_NANOSLEEP_SUPPORT
 184    /* mandates support of nanosleep() within <time.h> : http://man7.org/linux/man-pages/man2/nanosleep.2.html */
 185 #  if (defined(__linux__) && (PLATFORM_POSIX_VERSION >= 199309L)) \
 186    || (PLATFORM_POSIX_VERSION >= 200112L)
 187 #     define ZSTD_NANOSLEEP_SUPPORT 1
 188 #  else
 189 #     define ZSTD_NANOSLEEP_SUPPORT 0
 190 #  endif
 191 #endif
 192
 193
 194 #if defined (__cplusplus)
 195 }
 196 #endif
 197
 198 #endif /* PLATFORM_H_MODULE */