xref: /freebsd/sys/contrib/zstd/programs/platform.h (revision 8ddb146abcdf061be9f2c0db7e391697dafad85c)
1 /*
2  * Copyright (c) 2016-2020, 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) || 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 #if (defined(__linux__) && (PLATFORM_POSIX_VERSION > 1)) \
131  || (PLATFORM_POSIX_VERSION >= 200112L) \
132  || defined(__DJGPP__)
133 #  include <unistd.h>   /* isatty */
134 #  include <stdio.h>    /* fileno */
135 #  define IS_CONSOLE(stdStream) isatty(fileno(stdStream))
136 #elif defined(MSDOS) || defined(OS2)
137 #  include <io.h>       /* _isatty */
138 #  define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream))
139 #elif defined(WIN32) || defined(_WIN32)
140 #  include <io.h>      /* _isatty */
141 #  include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
142 #  include <stdio.h>   /* FILE */
143 static __inline int IS_CONSOLE(FILE* stdStream) {
144     DWORD dummy;
145     return _isatty(_fileno(stdStream)) && GetConsoleMode((HANDLE)_get_osfhandle(_fileno(stdStream)), &dummy);
146 }
147 #else
148 #  define IS_CONSOLE(stdStream) 0
149 #endif
150 
151 
152 /******************************
153 *  OS-specific IO behaviors
154 ******************************/
155 #if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(_WIN32)
156 #  include <fcntl.h>   /* _O_BINARY */
157 #  include <io.h>      /* _setmode, _fileno, _get_osfhandle */
158 #  if !defined(__DJGPP__)
159 #    include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
160 #    include <winioctl.h> /* FSCTL_SET_SPARSE */
161 #    define SET_BINARY_MODE(file) { int const unused=_setmode(_fileno(file), _O_BINARY); (void)unused; }
162 #    define SET_SPARSE_FILE_MODE(file) { DWORD dw; DeviceIoControl((HANDLE) _get_osfhandle(_fileno(file)), FSCTL_SET_SPARSE, 0, 0, 0, 0, &dw, 0); }
163 #  else
164 #    define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
165 #    define SET_SPARSE_FILE_MODE(file)
166 #  endif
167 #else
168 #  define SET_BINARY_MODE(file)
169 #  define SET_SPARSE_FILE_MODE(file)
170 #endif
171 
172 
173 #ifndef ZSTD_SPARSE_DEFAULT
174 #  if (defined(__APPLE__) && defined(__MACH__))
175 #    define ZSTD_SPARSE_DEFAULT 0
176 #  else
177 #    define ZSTD_SPARSE_DEFAULT 1
178 #  endif
179 #endif
180 
181 
182 #ifndef ZSTD_START_SYMBOLLIST_FRAME
183 #  ifdef __linux__
184 #    define ZSTD_START_SYMBOLLIST_FRAME 2
185 #  elif defined __APPLE__
186 #    define ZSTD_START_SYMBOLLIST_FRAME 4
187 #  else
188 #    define ZSTD_START_SYMBOLLIST_FRAME 0
189 #  endif
190 #endif
191 
192 
193 #ifndef ZSTD_SETPRIORITY_SUPPORT
194    /* mandates presence of <sys/resource.h> and support for setpriority() : http://man7.org/linux/man-pages/man2/setpriority.2.html */
195 #  define ZSTD_SETPRIORITY_SUPPORT (PLATFORM_POSIX_VERSION >= 200112L)
196 #endif
197 
198 
199 #ifndef ZSTD_NANOSLEEP_SUPPORT
200    /* mandates support of nanosleep() within <time.h> : http://man7.org/linux/man-pages/man2/nanosleep.2.html */
201 #  if (defined(__linux__) && (PLATFORM_POSIX_VERSION >= 199309L)) \
202    || (PLATFORM_POSIX_VERSION >= 200112L)
203 #     define ZSTD_NANOSLEEP_SUPPORT 1
204 #  else
205 #     define ZSTD_NANOSLEEP_SUPPORT 0
206 #  endif
207 #endif
208 
209 
210 #if defined (__cplusplus)
211 }
212 #endif
213 
214 #endif /* PLATFORM_H_MODULE */
215