platform.h 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  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. #ifndef PLATFORM_H_MODULE
  11. #define PLATFORM_H_MODULE
  12. /* **************************************
  13. * Compiler Options
  14. ****************************************/
  15. #if defined(_MSC_VER)
  16. # define _CRT_SECURE_NO_WARNINGS /* Disable Visual Studio warning messages for fopen, strncpy, strerror */
  17. # define _CRT_NONSTDC_NO_WARNINGS /* Disable C4996 complaining about posix function names */
  18. # if (_MSC_VER <= 1800) /* 1800 == Visual Studio 2013 */
  19. # define _CRT_SECURE_NO_DEPRECATE /* VS2005 - must be declared before <io.h> and <windows.h> */
  20. # define snprintf sprintf_s /* snprintf unsupported by Visual <= 2013 */
  21. # endif
  22. # pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
  23. #endif
  24. /* **************************************
  25. * Detect 64-bit OS
  26. * https://nadeausoftware.com/articles/2012/02/c_c_tip_how_detect_processor_type_using_compiler_predefined_macros
  27. ****************************************/
  28. #if defined __ia64 || defined _M_IA64 /* Intel Itanium */ \
  29. || defined __powerpc64__ || defined __ppc64__ || defined __PPC64__ /* POWER 64-bit */ \
  30. || (defined __sparc && (defined __sparcv9 || defined __sparc_v9__ || defined __arch64__)) || defined __sparc64__ /* SPARC 64-bit */ \
  31. || defined __x86_64__ || defined _M_X64 /* x86 64-bit */ \
  32. || defined __arm64__ || defined __aarch64__ || defined __ARM64_ARCH_8__ /* ARM 64-bit */ \
  33. || (defined __mips && (__mips == 64 || __mips == 4 || __mips == 3)) /* MIPS 64-bit */ \
  34. || defined _LP64 || defined __LP64__ /* NetBSD, OpenBSD */ || defined __64BIT__ /* AIX */ || defined _ADDR64 /* Cray */ \
  35. || (defined __SIZEOF_POINTER__ && __SIZEOF_POINTER__ == 8) /* gcc */
  36. # if !defined(__64BIT__)
  37. # define __64BIT__ 1
  38. # endif
  39. #endif
  40. /* *********************************************************
  41. * Turn on Large Files support (>4GB) for 32-bit Linux/Unix
  42. ***********************************************************/
  43. #if !defined(__64BIT__) || defined(__MINGW32__) /* No point defining Large file for 64 bit but MinGW-w64 requires it */
  44. # if !defined(_FILE_OFFSET_BITS)
  45. # define _FILE_OFFSET_BITS 64 /* turn off_t into a 64-bit type for ftello, fseeko */
  46. # endif
  47. # if !defined(_LARGEFILE_SOURCE) /* obsolete macro, replaced with _FILE_OFFSET_BITS */
  48. # define _LARGEFILE_SOURCE 1 /* Large File Support extension (LFS) - fseeko, ftello */
  49. # endif
  50. # if defined(_AIX) || defined(__hpux)
  51. # define _LARGE_FILES /* Large file support on 32-bits AIX and HP-UX */
  52. # endif
  53. #endif
  54. /* ************************************************************
  55. * Detect POSIX version
  56. * PLATFORM_POSIX_VERSION = 0 for non-Unix e.g. Windows
  57. * PLATFORM_POSIX_VERSION = 1 for Unix-like but non-POSIX
  58. * PLATFORM_POSIX_VERSION > 1 is equal to found _POSIX_VERSION
  59. * Value of PLATFORM_POSIX_VERSION can be forced on command line
  60. ***************************************************************/
  61. #ifndef PLATFORM_POSIX_VERSION
  62. # if (defined(__APPLE__) && defined(__MACH__)) || defined(__SVR4) || defined(_AIX) || defined(__hpux) /* POSIX.1-2001 (SUSv3) conformant */
  63. /* exception rule : force posix version to 200112L,
  64. * note: it's better to use unistd.h's _POSIX_VERSION whenever possible */
  65. # define PLATFORM_POSIX_VERSION 200112L
  66. /* try to determine posix version through official unistd.h's _POSIX_VERSION (https://pubs.opengroup.org/onlinepubs/7908799/xsh/unistd.h.html).
  67. * note : there is no simple way to know in advance if <unistd.h> is present or not on target system,
  68. * Posix specification mandates its presence and its content, but target system must respect this spec.
  69. * It's necessary to _not_ #include <unistd.h> whenever target OS is not unix-like
  70. * otherwise it will block preprocessing stage.
  71. * The following list of build macros tries to "guess" if target OS is likely unix-like, and therefore can #include <unistd.h>
  72. */
  73. # elif !defined(_WIN32) \
  74. && ( defined(__unix__) || defined(__unix) \
  75. || defined(_QNX_SOURCE) || defined(__midipix__) || defined(__VMS) || defined(__HAIKU__) )
  76. # if defined(__linux__) || defined(__linux) || defined(__CYGWIN__)
  77. # ifndef _POSIX_C_SOURCE
  78. # define _POSIX_C_SOURCE 200809L /* feature test macro : https://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html */
  79. # endif
  80. # endif
  81. # include <unistd.h> /* declares _POSIX_VERSION */
  82. # if defined(_POSIX_VERSION) /* POSIX compliant */
  83. # define PLATFORM_POSIX_VERSION _POSIX_VERSION
  84. # else
  85. # define PLATFORM_POSIX_VERSION 1
  86. # endif
  87. # ifdef __UCLIBC__
  88. # ifndef __USE_MISC
  89. # define __USE_MISC /* enable st_mtim on uclibc */
  90. # endif
  91. # endif
  92. # else /* non-unix target platform (like Windows) */
  93. # define PLATFORM_POSIX_VERSION 0
  94. # endif
  95. #endif /* PLATFORM_POSIX_VERSION */
  96. #if PLATFORM_POSIX_VERSION > 1
  97. /* glibc < 2.26 may not expose struct timespec def without this.
  98. * See issue #1920. */
  99. # ifndef _ATFILE_SOURCE
  100. # define _ATFILE_SOURCE
  101. # endif
  102. #endif
  103. /*-*********************************************
  104. * Detect if isatty() and fileno() are available
  105. *
  106. * Note: Use UTIL_isConsole() for the zstd CLI
  107. * instead, as it allows faking is console for
  108. * testing.
  109. ************************************************/
  110. #if (defined(__linux__) && (PLATFORM_POSIX_VERSION > 1)) \
  111. || (PLATFORM_POSIX_VERSION >= 200112L) \
  112. || defined(__DJGPP__)
  113. # include <unistd.h> /* isatty */
  114. # include <stdio.h> /* fileno */
  115. # define IS_CONSOLE(stdStream) isatty(fileno(stdStream))
  116. #elif defined(MSDOS) || defined(OS2)
  117. # include <io.h> /* _isatty */
  118. # define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream))
  119. #elif defined(_WIN32)
  120. # include <io.h> /* _isatty */
  121. # include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
  122. # include <stdio.h> /* FILE */
  123. #if defined (__cplusplus)
  124. extern "C" {
  125. #endif
  126. static __inline int IS_CONSOLE(FILE* stdStream) {
  127. DWORD dummy;
  128. return _isatty(_fileno(stdStream)) && GetConsoleMode((HANDLE)_get_osfhandle(_fileno(stdStream)), &dummy);
  129. }
  130. #if defined (__cplusplus)
  131. }
  132. #endif
  133. #else
  134. # define IS_CONSOLE(stdStream) 0
  135. #endif
  136. /******************************
  137. * OS-specific IO behaviors
  138. ******************************/
  139. #if defined(MSDOS) || defined(OS2) || 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. #ifndef ZSTD_SPARSE_DEFAULT
  156. # if (defined(__APPLE__) && defined(__MACH__))
  157. # define ZSTD_SPARSE_DEFAULT 0
  158. # else
  159. # define ZSTD_SPARSE_DEFAULT 1
  160. # endif
  161. #endif
  162. #ifndef ZSTD_START_SYMBOLLIST_FRAME
  163. # ifdef __linux__
  164. # define ZSTD_START_SYMBOLLIST_FRAME 2
  165. # elif defined __APPLE__
  166. # define ZSTD_START_SYMBOLLIST_FRAME 4
  167. # else
  168. # define ZSTD_START_SYMBOLLIST_FRAME 0
  169. # endif
  170. #endif
  171. #ifndef ZSTD_SETPRIORITY_SUPPORT
  172. /* mandates presence of <sys/resource.h> and support for setpriority() : https://man7.org/linux/man-pages/man2/setpriority.2.html */
  173. # define ZSTD_SETPRIORITY_SUPPORT (PLATFORM_POSIX_VERSION >= 200112L)
  174. #endif
  175. #ifndef ZSTD_NANOSLEEP_SUPPORT
  176. /* mandates support of nanosleep() within <time.h> : https://man7.org/linux/man-pages/man2/nanosleep.2.html */
  177. # if (defined(__linux__) && (PLATFORM_POSIX_VERSION >= 199309L)) \
  178. || (PLATFORM_POSIX_VERSION >= 200112L)
  179. # define ZSTD_NANOSLEEP_SUPPORT 1
  180. # else
  181. # define ZSTD_NANOSLEEP_SUPPORT 0
  182. # endif
  183. #endif
  184. #endif /* PLATFORM_H_MODULE */