[ceph.git] / ceph / src / zstd / programs / platform.h

/*
 * Copyright (c) 2016-present, Przemyslaw Skibinski, Yann Collet, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under both the BSD-style license (found in the
 * LICENSE file in the root directory of this source tree) and the GPLv2 (found
 * in the COPYING file in the root directory of this source tree).
 * You may select, at your option, one of the above-listed licenses.
 */

#ifndef PLATFORM_H_MODULE
#define PLATFORM_H_MODULE

#if defined (__cplusplus)
extern "C" {
#endif


/* **************************************
*  Compiler Options
****************************************/
#if defined(_MSC_VER)
#  define _CRT_SECURE_NO_WARNINGS    /* Disable Visual Studio warning messages for fopen, strncpy, strerror */
#  if (_MSC_VER <= 1800)             /* 1800 == Visual Studio 2013 */
#    define _CRT_SECURE_NO_DEPRECATE /* VS2005 - must be declared before <io.h> and <windows.h> */
#    define snprintf sprintf_s       /* snprintf unsupported by Visual <= 2013 */
#  endif
#  pragma warning(disable : 4127)    /* disable: C4127: conditional expression is constant */
#endif


/* **************************************
*  Detect 64-bit OS
*  http://nadeausoftware.com/articles/2012/02/c_c_tip_how_detect_processor_type_using_compiler_predefined_macros
****************************************/
#if defined __ia64 || defined _M_IA64                                                                               /* Intel Itanium */ \
  || defined __powerpc64__ || defined __ppc64__ || defined __PPC64__                                                /* POWER 64-bit */  \
  || (defined __sparc && (defined __sparcv9 || defined __sparc_v9__ || defined __arch64__)) || defined __sparc64__  /* SPARC 64-bit */  \
  || defined __x86_64__s || defined _M_X64                                                                          /* x86 64-bit */    \
  || defined __arm64__ || defined __aarch64__ || defined __ARM64_ARCH_8__                                           /* ARM 64-bit */    \
  || (defined __mips  && (__mips == 64 || __mips == 4 || __mips == 3))                                              /* MIPS 64-bit */   \
  || defined _LP64 || defined __LP64__ /* NetBSD, OpenBSD */ || defined __64BIT__ /* AIX */ || defined _ADDR64 /* Cray */               \
  || (defined __SIZEOF_POINTER__ && __SIZEOF_POINTER__ == 8) /* gcc */
#  if !defined(__64BIT__)
#    define __64BIT__  1
#  endif
#endif


/* *********************************************************
*  Turn on Large Files support (>4GB) for 32-bit Linux/Unix
***********************************************************/
#if !defined(__64BIT__) || defined(__MINGW32__)    /* No point defining Large file for 64 bit but MinGW-w64 requires it */
#  if !defined(_FILE_OFFSET_BITS)
#    define _FILE_OFFSET_BITS 64                   /* turn off_t into a 64-bit type for ftello, fseeko */
#  endif
#  if !defined(_LARGEFILE_SOURCE)                  /* obsolete macro, replaced with _FILE_OFFSET_BITS */
#    define _LARGEFILE_SOURCE 1                    /* Large File Support extension (LFS) - fseeko, ftello */
#  endif
#  if defined(_AIX) || defined(__hpux)
#    define _LARGE_FILES                           /* Large file support on 32-bits AIX and HP-UX */
#  endif
#endif


/* ************************************************************
*  Detect POSIX version
*  PLATFORM_POSIX_VERSION = 0 for non-Unix e.g. Windows
*  PLATFORM_POSIX_VERSION = 1 for Unix-like but non-POSIX
*  PLATFORM_POSIX_VERSION > 1 is equal to found _POSIX_VERSION
*  Value of PLATFORM_POSIX_VERSION can be forced on command line
***************************************************************/
#ifndef PLATFORM_POSIX_VERSION

#  if (defined(__APPLE__) && defined(__MACH__)) || defined(__SVR4) || defined(_AIX) || defined(__hpux) /* POSIX.1-2001 (SUSv3) conformant */ \
     || defined(__DragonFly__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__OpenBSD__)  /* BSD distros */
     /* exception rule : force posix version to 200112L,
      * note: it's better to use unistd.h's _POSIX_VERSION whenever possible */
#    define PLATFORM_POSIX_VERSION 200112L

/* try to determine posix version through official unistd.h's _POSIX_VERSION (http://pubs.opengroup.org/onlinepubs/7908799/xsh/unistd.h.html).
 * note : there is no simple way to know in advance if <unistd.h> is present or not on target system,
 * Posix specification mandates its presence and its content, but target system must respect this spec.
 * It's necessary to _not_ #include <unistd.h> whenever target OS is not unix-like
 * otherwise it will block preprocessing stage.
 * The following list of build macros tries to "guess" if target OS is likely unix-like, and therefore can #include <unistd.h>
 */
#  elif !defined(_WIN32) \
     && ( defined(__unix__) || defined(__unix) \
       || defined(__midipix__) || defined(__VMS) || defined(__HAIKU__) )

#    if defined(__linux__) || defined(__linux)
#      ifndef _POSIX_C_SOURCE
#        define _POSIX_C_SOURCE 200112L  /* feature test macro : https://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html */
#      endif
#    endif
#    include <unistd.h>  /* declares _POSIX_VERSION */
#    if defined(_POSIX_VERSION)  /* POSIX compliant */
#      define PLATFORM_POSIX_VERSION _POSIX_VERSION
#    else
#      define PLATFORM_POSIX_VERSION 1
#    endif

#  else  /* non-unix target platform (like Windows) */
#    define PLATFORM_POSIX_VERSION 0
#  endif

#endif   /* PLATFORM_POSIX_VERSION */


/*-*********************************************
*  Detect if isatty() and fileno() are available
************************************************/
#if (defined(__linux__) && (PLATFORM_POSIX_VERSION > 1)) \
 || (PLATFORM_POSIX_VERSION >= 200112L) \
 || defined(__DJGPP__) \
 || defined(__MSYS__)
#  include <unistd.h>   /* isatty */
#  define IS_CONSOLE(stdStream) isatty(fileno(stdStream))
#elif defined(MSDOS) || defined(OS2) || defined(__CYGWIN__)
#  include <io.h>       /* _isatty */
#  define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream))
#elif defined(WIN32) || defined(_WIN32)
#  include <io.h>      /* _isatty */
#  include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
#  include <stdio.h>   /* FILE */
static __inline int IS_CONSOLE(FILE* stdStream) {
    DWORD dummy;
    return _isatty(_fileno(stdStream)) && GetConsoleMode((HANDLE)_get_osfhandle(_fileno(stdStream)), &dummy);
}
#else
#  define IS_CONSOLE(stdStream) 0
#endif


/******************************
*  OS-specific IO behaviors
******************************/
#if defined(MSDOS) || defined(OS2) || defined(WIN32) || defined(_WIN32)
#  include <fcntl.h>   /* _O_BINARY */
#  include <io.h>      /* _setmode, _fileno, _get_osfhandle */
#  if !defined(__DJGPP__)
#    include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
#    include <winioctl.h> /* FSCTL_SET_SPARSE */
#    define SET_BINARY_MODE(file) { int const unused=_setmode(_fileno(file), _O_BINARY); (void)unused; }
#    define SET_SPARSE_FILE_MODE(file) { DWORD dw; DeviceIoControl((HANDLE) _get_osfhandle(_fileno(file)), FSCTL_SET_SPARSE, 0, 0, 0, 0, &dw, 0); }
#  else
#    define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
#    define SET_SPARSE_FILE_MODE(file)
#  endif
#else
#  define SET_BINARY_MODE(file)
#  define SET_SPARSE_FILE_MODE(file)
#endif


#ifndef ZSTD_SPARSE_DEFAULT
#  if (defined(__APPLE__) && defined(__MACH__))
#    define ZSTD_SPARSE_DEFAULT 0
#  else
#    define ZSTD_SPARSE_DEFAULT 1
#  endif
#endif


#ifndef ZSTD_START_SYMBOLLIST_FRAME
#  ifdef __linux__
#    define ZSTD_START_SYMBOLLIST_FRAME 2
#  elif defined __APPLE__
#    define ZSTD_START_SYMBOLLIST_FRAME 4
#  else
#    define ZSTD_START_SYMBOLLIST_FRAME 0
#  endif
#endif


#ifndef ZSTD_SETPRIORITY_SUPPORT
   /* mandates presence of <sys/resource.h> and support for setpriority() : http://man7.org/linux/man-pages/man2/setpriority.2.html */
#  define ZSTD_SETPRIORITY_SUPPORT (PLATFORM_POSIX_VERSION >= 200112L)
#endif


#ifndef ZSTD_NANOSLEEP_SUPPORT
   /* mandates support of nanosleep() within <time.h> : http://man7.org/linux/man-pages/man2/nanosleep.2.html */
#  if (defined(__linux__) && (PLATFORM_POSIX_VERSION >= 199309L)) \
   || (PLATFORM_POSIX_VERSION >= 200112L)
#     define ZSTD_NANOSLEEP_SUPPORT 1
#  else
#     define ZSTD_NANOSLEEP_SUPPORT 0
#  endif
#endif


#if defined (__cplusplus)
}
#endif

#endif /* PLATFORM_H_MODULE */
Commit	Line	Data
11fdf7f2 TL	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)
9f95a23c TL	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 */
11fdf7f2	28	# endif
9f95a23c	29	# pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
11fdf7f2 TL	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	***********************************************************/
9f95a23c	54	#if !defined(__64BIT__) \|\| defined(__MINGW32__) /* No point defining Large file for 64 bit but MinGW-w64 requires it */
11fdf7f2	55	# if !defined(_FILE_OFFSET_BITS)
9f95a23c	56	# define _FILE_OFFSET_BITS 64 /* turn off_t into a 64-bit type for ftello, fseeko */
11fdf7f2	57	# endif
9f95a23c TL	58	# if !defined(_LARGEFILE_SOURCE) /* obsolete macro, replaced with _FILE_OFFSET_BITS */
9f95a23c TL	59	# define _LARGEFILE_SOURCE 1 /* Large File Support extension (LFS) - fseeko, ftello */
11fdf7f2 TL	60	# endif
11fdf7f2 TL	61	# if defined(_AIX) \|\| defined(__hpux)
9f95a23c	62	# define _LARGE_FILES /* Large file support on 32-bits AIX and HP-UX */
11fdf7f2 TL	63	# endif
	64	#endif
	65
	66
	67	/* ************************************************************
	68	* Detect POSIX version
9f95a23c TL	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
11fdf7f2	73	***************************************************************/
9f95a23c TL	74	#ifndef PLATFORM_POSIX_VERSION
	75
	76	# if (defined(__APPLE__) && defined(__MACH__)) \|\| defined(__SVR4) \|\| defined(_AIX) \|\| defined(__hpux) /* POSIX.1-2001 (SUSv3) conformant */ \
11fdf7f2	77	\|\| defined(__DragonFly__) \|\| defined(__FreeBSD__) \|\| defined(__NetBSD__) \|\| defined(__OpenBSD__) /* BSD distros */
9f95a23c TL	78	/* exception rule : force posix version to 200112L,
9f95a23c TL	79	* note: it's better to use unistd.h's _POSIX_VERSION whenever possible */
11fdf7f2	80	# define PLATFORM_POSIX_VERSION 200112L
9f95a23c TL	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
11fdf7f2 TL	93	# if defined(__linux__) \|\| defined(__linux)
11fdf7f2 TL	94	# ifndef _POSIX_C_SOURCE
9f95a23c	95	# define _POSIX_C_SOURCE 200112L /* feature test macro : https://www.gnu.org/software/libc/manual/html_node/Feature-Test-Macros.html */
11fdf7f2 TL	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
9f95a23c	102	# define PLATFORM_POSIX_VERSION 1
11fdf7f2	103	# endif
9f95a23c TL	104
	105	# else /* non-unix target platform (like Windows) */
	106	# define PLATFORM_POSIX_VERSION 0
11fdf7f2	107	# endif
9f95a23c TL	108
9f95a23c TL	109	#endif /* PLATFORM_POSIX_VERSION */
11fdf7f2 TL	110
	111
	112	/-********************************************
	113	* Detect if isatty() and fileno() are available
	114	************************************************/
9f95a23c TL	115	#if (defined(__linux__) && (PLATFORM_POSIX_VERSION > 1)) \
	116	\|\| (PLATFORM_POSIX_VERSION >= 200112L) \
	117	\|\| defined(__DJGPP__) \
	118	\|\| defined(__MSYS__)
11fdf7f2 TL	119	# include <unistd.h> /* isatty */
	120	# define IS_CONSOLE(stdStream) isatty(fileno(stdStream))
	121	#elif defined(MSDOS) \|\| defined(OS2) \|\| defined(__CYGWIN__)
	122	# include <io.h> /* _isatty */
	123	# define IS_CONSOLE(stdStream) _isatty(_fileno(stdStream))
	124	#elif defined(WIN32) \|\| defined(_WIN32)
	125	# include <io.h> /* _isatty */
	126	# include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
	127	# include <stdio.h> /* FILE */
9f95a23c	128	static __inline int IS_CONSOLE(FILE* stdStream) {
11fdf7f2 TL	129	DWORD dummy;
	130	return _isatty(_fileno(stdStream)) && GetConsoleMode((HANDLE)_get_osfhandle(_fileno(stdStream)), &dummy);
	131	}
	132	#else
	133	# define IS_CONSOLE(stdStream) 0
	134	#endif
	135
	136
	137	/******************************
9f95a23c	138	* OS-specific IO behaviors
11fdf7f2 TL	139	******************************/
	140	#if defined(MSDOS) \|\| defined(OS2) \|\| defined(WIN32) \|\| defined(_WIN32)
	141	# include <fcntl.h> /* _O_BINARY */
	142	# include <io.h> /* _setmode, _fileno, _get_osfhandle */
	143	# if !defined(__DJGPP__)
	144	# include <windows.h> /* DeviceIoControl, HANDLE, FSCTL_SET_SPARSE */
	145	# include <winioctl.h> /* FSCTL_SET_SPARSE */
9f95a23c	146	# define SET_BINARY_MODE(file) { int const unused=_setmode(_fileno(file), _O_BINARY); (void)unused; }
11fdf7f2 TL	147	# define SET_SPARSE_FILE_MODE(file) { DWORD dw; DeviceIoControl((HANDLE) _get_osfhandle(_fileno(file)), FSCTL_SET_SPARSE, 0, 0, 0, 0, &dw, 0); }
	148	# else
	149	# define SET_BINARY_MODE(file) setmode(fileno(file), O_BINARY)
	150	# define SET_SPARSE_FILE_MODE(file)
	151	# endif
	152	#else
	153	# define SET_BINARY_MODE(file)
	154	# define SET_SPARSE_FILE_MODE(file)
	155	#endif
	156
	157
	158	#ifndef ZSTD_SPARSE_DEFAULT
	159	# if (defined(__APPLE__) && defined(__MACH__))
	160	# define ZSTD_SPARSE_DEFAULT 0
	161	# else
	162	# define ZSTD_SPARSE_DEFAULT 1
	163	# endif
	164	#endif
	165
	166
9f95a23c TL	167	#ifndef ZSTD_START_SYMBOLLIST_FRAME
	168	# ifdef __linux__
	169	# define ZSTD_START_SYMBOLLIST_FRAME 2
	170	# elif defined __APPLE__
	171	# define ZSTD_START_SYMBOLLIST_FRAME 4
	172	# else
	173	# define ZSTD_START_SYMBOLLIST_FRAME 0
	174	# endif
	175	#endif
	176
	177
	178	#ifndef ZSTD_SETPRIORITY_SUPPORT
	179	/* mandates presence of <sys/resource.h> and support for setpriority() : http://man7.org/linux/man-pages/man2/setpriority.2.html */
	180	# define ZSTD_SETPRIORITY_SUPPORT (PLATFORM_POSIX_VERSION >= 200112L)
	181	#endif
	182
	183
	184	#ifndef ZSTD_NANOSLEEP_SUPPORT
	185	/* mandates support of nanosleep() within <time.h> : http://man7.org/linux/man-pages/man2/nanosleep.2.html */
	186	# if (defined(__linux__) && (PLATFORM_POSIX_VERSION >= 199309L)) \
	187	\|\| (PLATFORM_POSIX_VERSION >= 200112L)
	188	# define ZSTD_NANOSLEEP_SUPPORT 1
	189	# else
	190	# define ZSTD_NANOSLEEP_SUPPORT 0
	191	# endif
	192	#endif
	193
	194
11fdf7f2 TL	195	#if defined (__cplusplus)
	196	}
	197	#endif
	198
	199	#endif /* PLATFORM_H_MODULE */