xref: /freebsd/sys/contrib/zstd/programs/platform.h (revision 4f52dfbb)
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 #endif
30 
31 
32 /* **************************************
33 *  Detect 64-bit OS
34 *  http://nadeausoftware.com/articles/2012/02/c_c_tip_how_detect_processor_type_using_compiler_predefined_macros
35 ****************************************/
36 #if defined __ia64 || defined _M_IA64                                                                               /* Intel Itanium */ \
37   || defined __powerpc64__ || defined __ppc64__ || defined __PPC64__                                                /* POWER 64-bit */  \
38   || (defined __sparc && (defined __sparcv9 || defined __sparc_v9__ || defined __arch64__)) || defined __sparc64__  /* SPARC 64-bit */  \
39   || defined __x86_64__s || defined _M_X64                                                                          /* x86 64-bit */    \
40   || defined __arm64__ || defined __aarch64__ || defined __ARM64_ARCH_8__                                           /* ARM 64-bit */    \
41   || (defined __mips  && (__mips == 64 || __mips == 4 || __mips == 3))                                              /* MIPS 64-bit */   \
42   || defined _LP64 || defined __LP64__ /* NetBSD, OpenBSD */ || defined __64BIT__ /* AIX */ || defined _ADDR64 /* Cray */               \
43   || (defined __SIZEOF_POINTER__ && __SIZEOF_POINTER__ == 8) /* gcc */
44 #  if !defined(__64BIT__)
45 #    define __64BIT__  1
46 #  endif
47 #endif
48 
49 
50 /* *********************************************************
51 *  Turn on Large Files support (>4GB) for 32-bit Linux/Unix
52 ***********************************************************/
53 #if !defined(__64BIT__) || defined(__MINGW32__)       /* No point defining Large file for 64 bit but MinGW-w64 requires it */
54 #  if !defined(_FILE_OFFSET_BITS)
55 #    define _FILE_OFFSET_BITS 64                      /* turn off_t into a 64-bit type for ftello, fseeko */
56 #  endif
57 #  if !defined(_LARGEFILE_SOURCE)                     /* obsolete macro, replaced with _FILE_OFFSET_BITS */
58 #    define _LARGEFILE_SOURCE 1                       /* Large File Support extension (LFS) - fseeko, ftello */
59 #  endif
60 #  if defined(_AIX) || defined(__hpux)
61 #    define _LARGE_FILES                              /* Large file support on 32-bits AIX and HP-UX */
62 #  endif
63 #endif
64 
65 
66 /* ************************************************************
67 *  Detect POSIX version
68 *  PLATFORM_POSIX_VERSION = -1 for non-Unix e.g. Windows
69 *  PLATFORM_POSIX_VERSION = 0 for Unix-like non-POSIX
70 *  PLATFORM_POSIX_VERSION >= 1 is equal to found _POSIX_VERSION
71 ***************************************************************/
72 #if !defined(_WIN32) && (defined(__unix__) || defined(__unix) || (defined(__APPLE__) && defined(__MACH__)) /* UNIX-like OS */ \
73    || defined(__midipix__) || defined(__VMS))
74 #  if (defined(__APPLE__) && defined(__MACH__)) || defined(__SVR4) || defined(_AIX) || defined(__hpux) /* POSIX.1-2001 (SUSv3) conformant */ \
75      || defined(__DragonFly__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)  /* BSD distros */
76 #    define PLATFORM_POSIX_VERSION 200112L
77 #  else
78 #    if defined(__linux__) || defined(__linux)
79 #      ifndef _POSIX_C_SOURCE
80 #        define _POSIX_C_SOURCE 200112L  /* use feature test macro */
81 #      endif
82 #    endif
83 #    include <unistd.h>  /* declares _POSIX_VERSION */
84 #    if defined(_POSIX_VERSION)  /* POSIX compliant */
85 #      define PLATFORM_POSIX_VERSION _POSIX_VERSION
86 #    else
87 #      define PLATFORM_POSIX_VERSION 0
88 #    endif
89 #  endif
90 #endif
91 #if !defined(PLATFORM_POSIX_VERSION)
92 #  define PLATFORM_POSIX_VERSION -1
93 #endif
94 
95 
96 /*-*********************************************
97 *  Detect if isatty() and fileno() are available
98 ************************************************/
99 #if (defined(__linux__) && (PLATFORM_POSIX_VERSION >= 1)) || (PLATFORM_POSIX_VERSION >= 200112L) || defined(__DJGPP__)
100 #  include <unistd.h>   /* isatty */
101 #  define IS_CONSOLE(stdStream) isatty(fileno(stdStream))
102 #elif defined(MSDOS) || defined(OS2) || defined(__CYGWIN__)
103 #  include <io.h>       /* _isatty */
104 #  define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream))
105 #elif defined(WIN32) || defined(_WIN32)
106 #  include <io.h>      /* _isatty */
107 #  include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
108 #  include <stdio.h>   /* FILE */
109 static __inline int IS_CONSOLE(FILE* stdStream) {
110     DWORD dummy;
111     return _isatty(_fileno(stdStream)) && GetConsoleMode((HANDLE)_get_osfhandle(_fileno(stdStream)), &dummy);
112 }
113 #else
114 #  define IS_CONSOLE(stdStream) 0
115 #endif
116 
117 
118 /******************************
119 *  OS-specific IO behaviors
120 ******************************/
121 #if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(_WIN32)
122 #  include <fcntl.h>   /* _O_BINARY */
123 #  include <io.h>      /* _setmode, _fileno, _get_osfhandle */
124 #  if !defined(__DJGPP__)
125 #    include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
126 #    include <winioctl.h> /* FSCTL_SET_SPARSE */
127 #    define SET_BINARY_MODE(file) { int const unused=_setmode(_fileno(file), _O_BINARY); (void)unused; }
128 #    define SET_SPARSE_FILE_MODE(file) { DWORD dw; DeviceIoControl((HANDLE) _get_osfhandle(_fileno(file)), FSCTL_SET_SPARSE, 0, 0, 0, 0, &dw, 0); }
129 #  else
130 #    define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
131 #    define SET_SPARSE_FILE_MODE(file)
132 #  endif
133 #else
134 #  define SET_BINARY_MODE(file)
135 #  define SET_SPARSE_FILE_MODE(file)
136 #endif
137 
138 
139 #ifndef ZSTD_SPARSE_DEFAULT
140 #  if (defined(__APPLE__) && defined(__MACH__))
141 #    define ZSTD_SPARSE_DEFAULT 0
142 #  else
143 #    define ZSTD_SPARSE_DEFAULT 1
144 #  endif
145 #endif
146 
147 
148 #if defined (__cplusplus)
149 }
150 #endif
151 
152 #endif /* PLATFORM_H_MODULE */
153