1 /* 2 * Copyright (c) Meta Platforms, Inc. and affiliates. 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 # define _CRT_NONSTDC_NO_WARNINGS /* Disable C4996 complaining about posix function names */ 26 # if (_MSC_VER <= 1800) /* 1800 == Visual Studio 2013 */ 27 # define _CRT_SECURE_NO_DEPRECATE /* VS2005 - must be declared before <io.h> and <windows.h> */ 28 # define snprintf sprintf_s /* snprintf unsupported by Visual <= 2013 */ 29 # endif 30 # pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */ 31 #endif 32 33 34 /* ************************************** 35 * Detect 64-bit OS 36 * https://nadeausoftware.com/articles/2012/02/c_c_tip_how_detect_processor_type_using_compiler_predefined_macros 37 ****************************************/ 38 #if defined __ia64 || defined _M_IA64 /* Intel Itanium */ \ 39 || defined __powerpc64__ || defined __ppc64__ || defined __PPC64__ /* POWER 64-bit */ \ 40 || (defined __sparc && (defined __sparcv9 || defined __sparc_v9__ || defined __arch64__)) || defined __sparc64__ /* SPARC 64-bit */ \ 41 || defined __x86_64__s || defined _M_X64 /* x86 64-bit */ \ 42 || defined __arm64__ || defined __aarch64__ || defined __ARM64_ARCH_8__ /* ARM 64-bit */ \ 43 || (defined __mips && (__mips == 64 || __mips == 4 || __mips == 3)) /* MIPS 64-bit */ \ 44 || defined _LP64 || defined __LP64__ /* NetBSD, OpenBSD */ || defined __64BIT__ /* AIX */ || defined _ADDR64 /* Cray */ \ 45 || (defined __SIZEOF_POINTER__ && __SIZEOF_POINTER__ == 8) /* gcc */ 46 # if !defined(__64BIT__) 47 # define __64BIT__ 1 48 # endif 49 #endif 50 51 52 /* ********************************************************* 53 * Turn on Large Files support (>4GB) for 32-bit Linux/Unix 54 ***********************************************************/ 55 #if !defined(__64BIT__) || defined(__MINGW32__) /* No point defining Large file for 64 bit but MinGW-w64 requires it */ 56 # if !defined(_FILE_OFFSET_BITS) 57 # define _FILE_OFFSET_BITS 64 /* turn off_t into a 64-bit type for ftello, fseeko */ 58 # endif 59 # if !defined(_LARGEFILE_SOURCE) /* obsolete macro, replaced with _FILE_OFFSET_BITS */ 60 # define _LARGEFILE_SOURCE 1 /* Large File Support extension (LFS) - fseeko, ftello */ 61 # endif 62 # if defined(_AIX) || defined(__hpux) 63 # define _LARGE_FILES /* Large file support on 32-bits AIX and HP-UX */ 64 # endif 65 #endif 66 67 68 /* ************************************************************ 69 * Detect POSIX version 70 * PLATFORM_POSIX_VERSION = 0 for non-Unix e.g. Windows 71 * PLATFORM_POSIX_VERSION = 1 for Unix-like but non-POSIX 72 * PLATFORM_POSIX_VERSION > 1 is equal to found _POSIX_VERSION 73 * Value of PLATFORM_POSIX_VERSION can be forced on command line 74 ***************************************************************/ 75 #ifndef PLATFORM_POSIX_VERSION 76 77 # if (defined(__APPLE__) && defined(__MACH__)) || defined(__SVR4) || defined(_AIX) || defined(__hpux) /* POSIX.1-2001 (SUSv3) conformant */ 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 (https://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(_QNX_SOURCE) || defined(__midipix__) || defined(__VMS) || defined(__HAIKU__) ) 92 93 # if defined(__linux__) || defined(__linux) || defined(__CYGWIN__) 94 # ifndef _POSIX_C_SOURCE 95 # define _POSIX_C_SOURCE 200809L /* 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 # ifdef __UCLIBC__ 106 # ifndef __USE_MISC 107 # define __USE_MISC /* enable st_mtim on uclibc */ 108 # endif 109 # endif 110 111 # else /* non-unix target platform (like Windows) */ 112 # define PLATFORM_POSIX_VERSION 0 113 # endif 114 115 #endif /* PLATFORM_POSIX_VERSION */ 116 117 118 #if PLATFORM_POSIX_VERSION > 1 119 /* glibc < 2.26 may not expose struct timespec def without this. 120 * See issue #1920. */ 121 # ifndef _ATFILE_SOURCE 122 # define _ATFILE_SOURCE 123 # endif 124 #endif 125 126 127 /*-********************************************* 128 * Detect if isatty() and fileno() are available 129 * 130 * Note: Use UTIL_isConsole() for the zstd CLI 131 * instead, as it allows faking is console for 132 * testing. 133 ************************************************/ 134 #if (defined(__linux__) && (PLATFORM_POSIX_VERSION > 1)) \ 135 || (PLATFORM_POSIX_VERSION >= 200112L) \ 136 || defined(__DJGPP__) 137 # include <unistd.h> /* isatty */ 138 # include <stdio.h> /* fileno */ 139 # define IS_CONSOLE(stdStream) isatty(fileno(stdStream)) 140 #elif defined(MSDOS) || defined(OS2) 141 # include <io.h> /* _isatty */ 142 # define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream)) 143 #elif defined(_WIN32) 144 # include <io.h> /* _isatty */ 145 # include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */ 146 # include <stdio.h> /* FILE */ 147 static __inline int IS_CONSOLE(FILE* stdStream) { 148 DWORD dummy; 149 return _isatty(_fileno(stdStream)) && GetConsoleMode((HANDLE)_get_osfhandle(_fileno(stdStream)), &dummy); 150 } 151 #else 152 # define IS_CONSOLE(stdStream) 0 153 #endif 154 155 156 /****************************** 157 * OS-specific IO behaviors 158 ******************************/ 159 #if defined(MSDOS) || defined(OS2) || defined(_WIN32) 160 # include <fcntl.h> /* _O_BINARY */ 161 # include <io.h> /* _setmode, _fileno, _get_osfhandle */ 162 # if !defined(__DJGPP__) 163 # include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */ 164 # include <winioctl.h> /* FSCTL_SET_SPARSE */ 165 # define SET_BINARY_MODE(file) { int const unused=_setmode(_fileno(file), _O_BINARY); (void)unused; } 166 # define SET_SPARSE_FILE_MODE(file) { DWORD dw; DeviceIoControl((HANDLE) _get_osfhandle(_fileno(file)), FSCTL_SET_SPARSE, 0, 0, 0, 0, &dw, 0); } 167 # else 168 # define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY) 169 # define SET_SPARSE_FILE_MODE(file) 170 # endif 171 #else 172 # define SET_BINARY_MODE(file) 173 # define SET_SPARSE_FILE_MODE(file) 174 #endif 175 176 177 #ifndef ZSTD_SPARSE_DEFAULT 178 # if (defined(__APPLE__) && defined(__MACH__)) 179 # define ZSTD_SPARSE_DEFAULT 0 180 # else 181 # define ZSTD_SPARSE_DEFAULT 1 182 # endif 183 #endif 184 185 186 #ifndef ZSTD_START_SYMBOLLIST_FRAME 187 # ifdef __linux__ 188 # define ZSTD_START_SYMBOLLIST_FRAME 2 189 # elif defined __APPLE__ 190 # define ZSTD_START_SYMBOLLIST_FRAME 4 191 # else 192 # define ZSTD_START_SYMBOLLIST_FRAME 0 193 # endif 194 #endif 195 196 197 #ifndef ZSTD_SETPRIORITY_SUPPORT 198 /* mandates presence of <sys/resource.h> and support for setpriority() : https://man7.org/linux/man-pages/man2/setpriority.2.html */ 199 # define ZSTD_SETPRIORITY_SUPPORT (PLATFORM_POSIX_VERSION >= 200112L) 200 #endif 201 202 203 #ifndef ZSTD_NANOSLEEP_SUPPORT 204 /* mandates support of nanosleep() within <time.h> : https://man7.org/linux/man-pages/man2/nanosleep.2.html */ 205 # if (defined(__linux__) && (PLATFORM_POSIX_VERSION >= 199309L)) \ 206 || (PLATFORM_POSIX_VERSION >= 200112L) 207 # define ZSTD_NANOSLEEP_SUPPORT 1 208 # else 209 # define ZSTD_NANOSLEEP_SUPPORT 0 210 # endif 211 #endif 212 213 214 #if defined (__cplusplus) 215 } 216 #endif 217 218 #endif /* PLATFORM_H_MODULE */ 219