[ceph.git] / ceph / src / boost / boost / predef / other / endian.h

/*
Copyright Rene Rivera 2013-2015
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
http://www.boost.org/LICENSE_1_0.txt)
*/

#ifndef BOOST_PREDEF_ENDIAN_H
#define BOOST_PREDEF_ENDIAN_H

#include <boost/predef/version_number.h>
#include <boost/predef/make.h>
#include <boost/predef/library/c/gnu.h>
#include <boost/predef/os/macos.h>
#include <boost/predef/os/bsd.h>
#include <boost/predef/platform/android.h>

/* tag::reference[]
= `BOOST_ENDIAN_*`

Detection of endian memory ordering. There are four defined macros
in this header that define the various generally possible endian
memory orderings:

* `BOOST_ENDIAN_BIG_BYTE`, byte-swapped big-endian.
* `BOOST_ENDIAN_BIG_WORD`, word-swapped big-endian.
* `BOOST_ENDIAN_LITTLE_BYTE`, byte-swapped little-endian.
* `BOOST_ENDIAN_LITTLE_WORD`, word-swapped little-endian.

The detection is conservative in that it only identifies endianness
that it knows for certain. In particular bi-endianness is not
indicated as is it not practically possible to determine the
endianness from anything but an operating system provided
header. And the currently known headers do not define that
programatic bi-endianness is available.

This implementation is a compilation of various publicly available
information and acquired knowledge:

. The indispensable documentation of "Pre-defined Compiler Macros"
  http://sourceforge.net/p/predef/wiki/Endianness[Endianness].
. The various endian specifications available in the
  http://wikipedia.org/[Wikipedia] computer architecture pages.
. Generally available searches for headers that define endianness.
*/ // end::reference[]

#define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_NOT_AVAILABLE
#define BOOST_ENDIAN_BIG_WORD BOOST_VERSION_NUMBER_NOT_AVAILABLE
#define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_NOT_AVAILABLE
#define BOOST_ENDIAN_LITTLE_WORD BOOST_VERSION_NUMBER_NOT_AVAILABLE

/* GNU libc provides a header defining __BYTE_ORDER, or _BYTE_ORDER.
 * And some OSs provide some for of endian header also.
 */
#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
    !BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
#   if BOOST_LIB_C_GNU || BOOST_PLAT_ANDROID
#       include <endian.h>
#   else
#       if BOOST_OS_MACOS
#           include <machine/endian.h>
#       else
#           if BOOST_OS_BSD
#               if BOOST_OS_BSD_OPEN
#                   include <machine/endian.h>
#               else
#                   include <sys/endian.h>
#               endif
#           endif
#       endif
#   endif
#   if defined(__BYTE_ORDER)
#       if defined(__BIG_ENDIAN) && (__BYTE_ORDER == __BIG_ENDIAN)
#           undef BOOST_ENDIAN_BIG_BYTE
#           define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#       endif
#       if defined(__LITTLE_ENDIAN) && (__BYTE_ORDER == __LITTLE_ENDIAN)
#           undef BOOST_ENDIAN_LITTLE_BYTE
#           define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#       endif
#       if defined(__PDP_ENDIAN) && (__BYTE_ORDER == __PDP_ENDIAN)
#           undef BOOST_ENDIAN_LITTLE_WORD
#           define BOOST_ENDIAN_LITTLE_WORD BOOST_VERSION_NUMBER_AVAILABLE
#       endif
#   endif
#   if !defined(__BYTE_ORDER) && defined(_BYTE_ORDER)
#       if defined(_BIG_ENDIAN) && (_BYTE_ORDER == _BIG_ENDIAN)
#           undef BOOST_ENDIAN_BIG_BYTE
#           define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#       endif
#       if defined(_LITTLE_ENDIAN) && (_BYTE_ORDER == _LITTLE_ENDIAN)
#           undef BOOST_ENDIAN_LITTLE_BYTE
#           define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#       endif
#       if defined(_PDP_ENDIAN) && (_BYTE_ORDER == _PDP_ENDIAN)
#           undef BOOST_ENDIAN_LITTLE_WORD
#           define BOOST_ENDIAN_LITTLE_WORD BOOST_VERSION_NUMBER_AVAILABLE
#       endif
#   endif
#endif

/* Built-in byte-swpped big-endian macros.
 */
#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
    !BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
#   if (defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)) || \
       (defined(_BIG_ENDIAN) && !defined(_LITTLE_ENDIAN)) || \
        defined(__ARMEB__) || \
        defined(__THUMBEB__) || \
        defined(__AARCH64EB__) || \
        defined(_MIPSEB) || \
        defined(__MIPSEB) || \
        defined(__MIPSEB__)
#       undef BOOST_ENDIAN_BIG_BYTE
#       define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#   endif
#endif

/* Built-in byte-swpped little-endian macros.
 */
#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
    !BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
#   if (defined(__LITTLE_ENDIAN__) && !defined(__BIG_ENDIAN__)) || \
       (defined(_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)) || \
        defined(__ARMEL__) || \
        defined(__THUMBEL__) || \
        defined(__AARCH64EL__) || \
        defined(_MIPSEL) || \
        defined(__MIPSEL) || \
        defined(__MIPSEL__) || \
        defined(__riscv)
#       undef BOOST_ENDIAN_LITTLE_BYTE
#       define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#   endif
#endif

/* Some architectures are strictly one endianess (as opposed
 * the current common bi-endianess).
 */
#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
    !BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
#   include <boost/predef/architecture.h>
#   if BOOST_ARCH_M68K || \
        BOOST_ARCH_PARISC || \
        BOOST_ARCH_SPARC || \
        BOOST_ARCH_SYS370 || \
        BOOST_ARCH_SYS390 || \
        BOOST_ARCH_Z
#       undef BOOST_ENDIAN_BIG_BYTE
#       define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#   endif
#   if BOOST_ARCH_IA64 || \
        BOOST_ARCH_X86 || \
        BOOST_ARCH_BLACKFIN
#       undef BOOST_ENDIAN_LITTLE_BYTE
#       define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#   endif
#endif

/* Windows on ARM, if not otherwise detected/specified, is always
 * byte-swaped little-endian.
 */
#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
    !BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
#   if BOOST_ARCH_ARM
#       include <boost/predef/os/windows.h>
#       if BOOST_OS_WINDOWS
#           undef BOOST_ENDIAN_LITTLE_BYTE
#           define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
#       endif
#   endif
#endif

#if BOOST_ENDIAN_BIG_BYTE
#   define BOOST_ENDIAN_BIG_BYTE_AVAILABLE
#endif
#if BOOST_ENDIAN_BIG_WORD
#   define BOOST_ENDIAN_BIG_WORD_BYTE_AVAILABLE
#endif
#if BOOST_ENDIAN_LITTLE_BYTE
#   define BOOST_ENDIAN_LITTLE_BYTE_AVAILABLE
#endif
#if BOOST_ENDIAN_LITTLE_WORD
#   define BOOST_ENDIAN_LITTLE_WORD_BYTE_AVAILABLE
#endif

#define BOOST_ENDIAN_BIG_BYTE_NAME "Byte-Swapped Big-Endian"
#define BOOST_ENDIAN_BIG_WORD_NAME "Word-Swapped Big-Endian"
#define BOOST_ENDIAN_LITTLE_BYTE_NAME "Byte-Swapped Little-Endian"
#define BOOST_ENDIAN_LITTLE_WORD_NAME "Word-Swapped Little-Endian"

#endif

#include <boost/predef/detail/test.h>
BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_BIG_BYTE,BOOST_ENDIAN_BIG_BYTE_NAME)

#include <boost/predef/detail/test.h>
BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_BIG_WORD,BOOST_ENDIAN_BIG_WORD_NAME)

#include <boost/predef/detail/test.h>
BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_LITTLE_BYTE,BOOST_ENDIAN_LITTLE_BYTE_NAME)

#include <boost/predef/detail/test.h>
BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_LITTLE_WORD,BOOST_ENDIAN_LITTLE_WORD_NAME)
Commit	Line	Data
7c673cae FG	1	/*
	2	Copyright Rene Rivera 2013-2015
	3	Distributed under the Boost Software License, Version 1.0.
	4	(See accompanying file LICENSE_1_0.txt or copy at
	5	http://www.boost.org/LICENSE_1_0.txt)
	6	*/
	7
	8	#ifndef BOOST_PREDEF_ENDIAN_H
	9	#define BOOST_PREDEF_ENDIAN_H
	10
	11	#include <boost/predef/version_number.h>
	12	#include <boost/predef/make.h>
	13	#include <boost/predef/library/c/gnu.h>
	14	#include <boost/predef/os/macos.h>
	15	#include <boost/predef/os/bsd.h>
f67539c2	16	#include <boost/predef/platform/android.h>
7c673cae	17
f67539c2 TL	18	/* tag::reference[]
f67539c2 TL	19	= `BOOST_ENDIAN_*`
7c673cae FG	20
	21	Detection of endian memory ordering. There are four defined macros
	22	in this header that define the various generally possible endian
	23	memory orderings:
	24
	25	* `BOOST_ENDIAN_BIG_BYTE`, byte-swapped big-endian.
	26	* `BOOST_ENDIAN_BIG_WORD`, word-swapped big-endian.
	27	* `BOOST_ENDIAN_LITTLE_BYTE`, byte-swapped little-endian.
	28	* `BOOST_ENDIAN_LITTLE_WORD`, word-swapped little-endian.
	29
	30	The detection is conservative in that it only identifies endianness
	31	that it knows for certain. In particular bi-endianness is not
	32	indicated as is it not practically possible to determine the
	33	endianness from anything but an operating system provided
	34	header. And the currently known headers do not define that
	35	programatic bi-endianness is available.
	36
	37	This implementation is a compilation of various publicly available
	38	information and acquired knowledge:
	39
f67539c2 TL	40	. The indispensable documentation of "Pre-defined Compiler Macros"
	41	http://sourceforge.net/p/predef/wiki/Endianness[Endianness].
	42	. The various endian specifications available in the
	43	http://wikipedia.org/[Wikipedia] computer architecture pages.
	44	. Generally available searches for headers that define endianness.
	45	*/ // end::reference[]
7c673cae FG	46
	47	#define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_NOT_AVAILABLE
	48	#define BOOST_ENDIAN_BIG_WORD BOOST_VERSION_NUMBER_NOT_AVAILABLE
	49	#define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_NOT_AVAILABLE
	50	#define BOOST_ENDIAN_LITTLE_WORD BOOST_VERSION_NUMBER_NOT_AVAILABLE
	51
	52	/* GNU libc provides a header defining __BYTE_ORDER, or _BYTE_ORDER.
	53	* And some OSs provide some for of endian header also.
	54	*/
	55	#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
	56	!BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
f67539c2	57	# if BOOST_LIB_C_GNU \|\| BOOST_PLAT_ANDROID
7c673cae FG	58	# include <endian.h>
	59	# else
	60	# if BOOST_OS_MACOS
	61	# include <machine/endian.h>
	62	# else
	63	# if BOOST_OS_BSD
	64	# if BOOST_OS_BSD_OPEN
	65	# include <machine/endian.h>
	66	# else
	67	# include <sys/endian.h>
	68	# endif
	69	# endif
	70	# endif
	71	# endif
	72	# if defined(__BYTE_ORDER)
	73	# if defined(__BIG_ENDIAN) && (__BYTE_ORDER == __BIG_ENDIAN)
	74	# undef BOOST_ENDIAN_BIG_BYTE
	75	# define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	76	# endif
	77	# if defined(__LITTLE_ENDIAN) && (__BYTE_ORDER == __LITTLE_ENDIAN)
	78	# undef BOOST_ENDIAN_LITTLE_BYTE
	79	# define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	80	# endif
	81	# if defined(__PDP_ENDIAN) && (__BYTE_ORDER == __PDP_ENDIAN)
	82	# undef BOOST_ENDIAN_LITTLE_WORD
	83	# define BOOST_ENDIAN_LITTLE_WORD BOOST_VERSION_NUMBER_AVAILABLE
	84	# endif
	85	# endif
	86	# if !defined(__BYTE_ORDER) && defined(_BYTE_ORDER)
	87	# if defined(_BIG_ENDIAN) && (_BYTE_ORDER == _BIG_ENDIAN)
	88	# undef BOOST_ENDIAN_BIG_BYTE
	89	# define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	90	# endif
	91	# if defined(_LITTLE_ENDIAN) && (_BYTE_ORDER == _LITTLE_ENDIAN)
	92	# undef BOOST_ENDIAN_LITTLE_BYTE
	93	# define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	94	# endif
	95	# if defined(_PDP_ENDIAN) && (_BYTE_ORDER == _PDP_ENDIAN)
	96	# undef BOOST_ENDIAN_LITTLE_WORD
	97	# define BOOST_ENDIAN_LITTLE_WORD BOOST_VERSION_NUMBER_AVAILABLE
	98	# endif
	99	# endif
	100	#endif
	101
	102	/* Built-in byte-swpped big-endian macros.
	103	*/
	104	#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
	105	!BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
	106	# if (defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)) \|\| \
	107	(defined(_BIG_ENDIAN) && !defined(_LITTLE_ENDIAN)) \|\| \
	108	defined(__ARMEB__) \|\| \
	109	defined(__THUMBEB__) \|\| \
	110	defined(__AARCH64EB__) \|\| \
	111	defined(_MIPSEB) \|\| \
	112	defined(__MIPSEB) \|\| \
	113	defined(__MIPSEB__)
	114	# undef BOOST_ENDIAN_BIG_BYTE
	115	# define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	116	# endif
	117	#endif
	118
	119	/* Built-in byte-swpped little-endian macros.
	120	*/
	121	#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
122	!BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
123	# if (defined(__LITTLE_ENDIAN__) && !defined(__BIG_ENDIAN__)) \|\| \
124	(defined(_LITTLE_ENDIAN) && !defined(_BIG_ENDIAN)) \|\| \
125	defined(__ARMEL__) \|\| \
126	defined(__THUMBEL__) \|\| \
127	defined(__AARCH64EL__) \|\| \
128	defined(_MIPSEL) \|\| \
129	defined(__MIPSEL) \|\| \
f67539c2 TL	130	defined(__MIPSEL__) \|\| \
f67539c2 TL	131	defined(__riscv)
7c673cae FG	132	# undef BOOST_ENDIAN_LITTLE_BYTE
	133	# define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	134	# endif
	135	#endif
	136
	137	/* Some architectures are strictly one endianess (as opposed
	138	* the current common bi-endianess).
	139	*/
	140	#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
	141	!BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
	142	# include <boost/predef/architecture.h>
	143	# if BOOST_ARCH_M68K \|\| \
	144	BOOST_ARCH_PARISC \|\| \
	145	BOOST_ARCH_SPARC \|\| \
	146	BOOST_ARCH_SYS370 \|\| \
	147	BOOST_ARCH_SYS390 \|\| \
	148	BOOST_ARCH_Z
	149	# undef BOOST_ENDIAN_BIG_BYTE
	150	# define BOOST_ENDIAN_BIG_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	151	# endif
92f5a8d4	152	# if BOOST_ARCH_IA64 \|\| \
7c673cae FG	153	BOOST_ARCH_X86 \|\| \
	154	BOOST_ARCH_BLACKFIN
	155	# undef BOOST_ENDIAN_LITTLE_BYTE
	156	# define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	157	# endif
	158	#endif
	159
	160	/* Windows on ARM, if not otherwise detected/specified, is always
	161	* byte-swaped little-endian.
	162	*/
	163	#if !BOOST_ENDIAN_BIG_BYTE && !BOOST_ENDIAN_BIG_WORD && \
	164	!BOOST_ENDIAN_LITTLE_BYTE && !BOOST_ENDIAN_LITTLE_WORD
	165	# if BOOST_ARCH_ARM
	166	# include <boost/predef/os/windows.h>
	167	# if BOOST_OS_WINDOWS
	168	# undef BOOST_ENDIAN_LITTLE_BYTE
	169	# define BOOST_ENDIAN_LITTLE_BYTE BOOST_VERSION_NUMBER_AVAILABLE
	170	# endif
	171	# endif
	172	#endif
	173
	174	#if BOOST_ENDIAN_BIG_BYTE
	175	# define BOOST_ENDIAN_BIG_BYTE_AVAILABLE
	176	#endif
	177	#if BOOST_ENDIAN_BIG_WORD
	178	# define BOOST_ENDIAN_BIG_WORD_BYTE_AVAILABLE
	179	#endif
	180	#if BOOST_ENDIAN_LITTLE_BYTE
	181	# define BOOST_ENDIAN_LITTLE_BYTE_AVAILABLE
	182	#endif
	183	#if BOOST_ENDIAN_LITTLE_WORD
	184	# define BOOST_ENDIAN_LITTLE_WORD_BYTE_AVAILABLE
	185	#endif
	186
	187	#define BOOST_ENDIAN_BIG_BYTE_NAME "Byte-Swapped Big-Endian"
	188	#define BOOST_ENDIAN_BIG_WORD_NAME "Word-Swapped Big-Endian"
	189	#define BOOST_ENDIAN_LITTLE_BYTE_NAME "Byte-Swapped Little-Endian"
	190	#define BOOST_ENDIAN_LITTLE_WORD_NAME "Word-Swapped Little-Endian"
	191
	192	#endif
	193
	194	#include <boost/predef/detail/test.h>
	195	BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_BIG_BYTE,BOOST_ENDIAN_BIG_BYTE_NAME)
	196
	197	#include <boost/predef/detail/test.h>
	198	BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_BIG_WORD,BOOST_ENDIAN_BIG_WORD_NAME)
	199
	200	#include <boost/predef/detail/test.h>
	201	BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_LITTLE_BYTE,BOOST_ENDIAN_LITTLE_BYTE_NAME)
	202
	203	#include <boost/predef/detail/test.h>
	204	BOOST_PREDEF_DECLARE_TEST(BOOST_ENDIAN_LITTLE_WORD,BOOST_ENDIAN_LITTLE_WORD_NAME)