xref: /openbsd-src/gnu/llvm/compiler-rt/lib/orc/endianness.h (revision d89ec533011f513df1010f142a111086a0785f09)
1*d89ec533Spatrick //===- endian.h - Endianness support ----------------------------*- C++ -*-===//
2*d89ec533Spatrick //
3*d89ec533Spatrick // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*d89ec533Spatrick // See https://llvm.org/LICENSE.txt for license information.
5*d89ec533Spatrick // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*d89ec533Spatrick //
7*d89ec533Spatrick //===----------------------------------------------------------------------===//
8*d89ec533Spatrick //
9*d89ec533Spatrick // This file declares generic and optimized functions to swap the byte order of
10*d89ec533Spatrick // an integral type.
11*d89ec533Spatrick //
12*d89ec533Spatrick //===----------------------------------------------------------------------===//
13*d89ec533Spatrick 
14*d89ec533Spatrick #ifndef ORC_RT_ENDIAN_H
15*d89ec533Spatrick #define ORC_RT_ENDIAN_H
16*d89ec533Spatrick 
17*d89ec533Spatrick #include <cstddef>
18*d89ec533Spatrick #include <cstdint>
19*d89ec533Spatrick #include <type_traits>
20*d89ec533Spatrick #if defined(_MSC_VER) && !defined(_DEBUG)
21*d89ec533Spatrick #include <stdlib.h>
22*d89ec533Spatrick #endif
23*d89ec533Spatrick 
24*d89ec533Spatrick #if defined(__linux__) || defined(__GNU__) || defined(__HAIKU__) ||            \
25*d89ec533Spatrick     defined(__Fuchsia__) || defined(__EMSCRIPTEN__)
26*d89ec533Spatrick #include <endian.h>
27*d89ec533Spatrick #elif defined(_AIX)
28*d89ec533Spatrick #include <sys/machine.h>
29*d89ec533Spatrick #elif defined(__sun)
30*d89ec533Spatrick /* Solaris provides _BIG_ENDIAN/_LITTLE_ENDIAN selector in sys/types.h */
31*d89ec533Spatrick #include <sys/types.h>
32*d89ec533Spatrick #define BIG_ENDIAN 4321
33*d89ec533Spatrick #define LITTLE_ENDIAN 1234
34*d89ec533Spatrick #if defined(_BIG_ENDIAN)
35*d89ec533Spatrick #define BYTE_ORDER BIG_ENDIAN
36*d89ec533Spatrick #else
37*d89ec533Spatrick #define BYTE_ORDER LITTLE_ENDIAN
38*d89ec533Spatrick #endif
39*d89ec533Spatrick #elif defined(__MVS__)
40*d89ec533Spatrick #define BIG_ENDIAN 4321
41*d89ec533Spatrick #define LITTLE_ENDIAN 1234
42*d89ec533Spatrick #define BYTE_ORDER BIG_ENDIAN
43*d89ec533Spatrick #else
44*d89ec533Spatrick #if !defined(BYTE_ORDER) && !defined(_WIN32)
45*d89ec533Spatrick #include <machine/endian.h>
46*d89ec533Spatrick #endif
47*d89ec533Spatrick #endif
48*d89ec533Spatrick 
49*d89ec533Spatrick namespace __orc_rt {
50*d89ec533Spatrick 
51*d89ec533Spatrick /// ByteSwap_16 - This function returns a byte-swapped representation of
52*d89ec533Spatrick /// the 16-bit argument.
ByteSwap_16(uint16_t value)53*d89ec533Spatrick inline uint16_t ByteSwap_16(uint16_t value) {
54*d89ec533Spatrick #if defined(_MSC_VER) && !defined(_DEBUG)
55*d89ec533Spatrick   // The DLL version of the runtime lacks these functions (bug!?), but in a
56*d89ec533Spatrick   // release build they're replaced with BSWAP instructions anyway.
57*d89ec533Spatrick   return _byteswap_ushort(value);
58*d89ec533Spatrick #else
59*d89ec533Spatrick   uint16_t Hi = value << 8;
60*d89ec533Spatrick   uint16_t Lo = value >> 8;
61*d89ec533Spatrick   return Hi | Lo;
62*d89ec533Spatrick #endif
63*d89ec533Spatrick }
64*d89ec533Spatrick 
65*d89ec533Spatrick /// This function returns a byte-swapped representation of the 32-bit argument.
ByteSwap_32(uint32_t value)66*d89ec533Spatrick inline uint32_t ByteSwap_32(uint32_t value) {
67*d89ec533Spatrick #if defined(__llvm__) || (defined(__GNUC__) && !defined(__ICC))
68*d89ec533Spatrick   return __builtin_bswap32(value);
69*d89ec533Spatrick #elif defined(_MSC_VER) && !defined(_DEBUG)
70*d89ec533Spatrick   return _byteswap_ulong(value);
71*d89ec533Spatrick #else
72*d89ec533Spatrick   uint32_t Byte0 = value & 0x000000FF;
73*d89ec533Spatrick   uint32_t Byte1 = value & 0x0000FF00;
74*d89ec533Spatrick   uint32_t Byte2 = value & 0x00FF0000;
75*d89ec533Spatrick   uint32_t Byte3 = value & 0xFF000000;
76*d89ec533Spatrick   return (Byte0 << 24) | (Byte1 << 8) | (Byte2 >> 8) | (Byte3 >> 24);
77*d89ec533Spatrick #endif
78*d89ec533Spatrick }
79*d89ec533Spatrick 
80*d89ec533Spatrick /// This function returns a byte-swapped representation of the 64-bit argument.
ByteSwap_64(uint64_t value)81*d89ec533Spatrick inline uint64_t ByteSwap_64(uint64_t value) {
82*d89ec533Spatrick #if defined(__llvm__) || (defined(__GNUC__) && !defined(__ICC))
83*d89ec533Spatrick   return __builtin_bswap64(value);
84*d89ec533Spatrick #elif defined(_MSC_VER) && !defined(_DEBUG)
85*d89ec533Spatrick   return _byteswap_uint64(value);
86*d89ec533Spatrick #else
87*d89ec533Spatrick   uint64_t Hi = ByteSwap_32(uint32_t(value));
88*d89ec533Spatrick   uint32_t Lo = ByteSwap_32(uint32_t(value >> 32));
89*d89ec533Spatrick   return (Hi << 32) | Lo;
90*d89ec533Spatrick #endif
91*d89ec533Spatrick }
92*d89ec533Spatrick 
93*d89ec533Spatrick #if defined(BYTE_ORDER) && defined(BIG_ENDIAN) && BYTE_ORDER == BIG_ENDIAN
94*d89ec533Spatrick constexpr bool IsBigEndianHost = true;
95*d89ec533Spatrick #else
96*d89ec533Spatrick constexpr bool IsBigEndianHost = false;
97*d89ec533Spatrick #endif
98*d89ec533Spatrick 
99*d89ec533Spatrick static const bool IsLittleEndianHost = !IsBigEndianHost;
100*d89ec533Spatrick 
getSwappedBytes(unsigned char C)101*d89ec533Spatrick inline unsigned char getSwappedBytes(unsigned char C) { return C; }
getSwappedBytes(signed char C)102*d89ec533Spatrick inline signed char getSwappedBytes(signed char C) { return C; }
getSwappedBytes(char C)103*d89ec533Spatrick inline char getSwappedBytes(char C) { return C; }
104*d89ec533Spatrick 
getSwappedBytes(unsigned short C)105*d89ec533Spatrick inline unsigned short getSwappedBytes(unsigned short C) {
106*d89ec533Spatrick   return ByteSwap_16(C);
107*d89ec533Spatrick }
getSwappedBytes(signed short C)108*d89ec533Spatrick inline signed short getSwappedBytes(signed short C) { return ByteSwap_16(C); }
109*d89ec533Spatrick 
getSwappedBytes(unsigned int C)110*d89ec533Spatrick inline unsigned int getSwappedBytes(unsigned int C) { return ByteSwap_32(C); }
getSwappedBytes(signed int C)111*d89ec533Spatrick inline signed int getSwappedBytes(signed int C) { return ByteSwap_32(C); }
112*d89ec533Spatrick 
getSwappedBytes(unsigned long C)113*d89ec533Spatrick inline unsigned long getSwappedBytes(unsigned long C) {
114*d89ec533Spatrick   // Handle LLP64 and LP64 platforms.
115*d89ec533Spatrick   return sizeof(long) == sizeof(int) ? ByteSwap_32((uint32_t)C)
116*d89ec533Spatrick                                      : ByteSwap_64((uint64_t)C);
117*d89ec533Spatrick }
getSwappedBytes(signed long C)118*d89ec533Spatrick inline signed long getSwappedBytes(signed long C) {
119*d89ec533Spatrick   // Handle LLP64 and LP64 platforms.
120*d89ec533Spatrick   return sizeof(long) == sizeof(int) ? ByteSwap_32((uint32_t)C)
121*d89ec533Spatrick                                      : ByteSwap_64((uint64_t)C);
122*d89ec533Spatrick }
123*d89ec533Spatrick 
getSwappedBytes(unsigned long long C)124*d89ec533Spatrick inline unsigned long long getSwappedBytes(unsigned long long C) {
125*d89ec533Spatrick   return ByteSwap_64(C);
126*d89ec533Spatrick }
getSwappedBytes(signed long long C)127*d89ec533Spatrick inline signed long long getSwappedBytes(signed long long C) {
128*d89ec533Spatrick   return ByteSwap_64(C);
129*d89ec533Spatrick }
130*d89ec533Spatrick 
131*d89ec533Spatrick template <typename T>
getSwappedBytes(T C)132*d89ec533Spatrick inline std::enable_if_t<std::is_enum<T>::value, T> getSwappedBytes(T C) {
133*d89ec533Spatrick   return static_cast<T>(
134*d89ec533Spatrick       getSwappedBytes(static_cast<std::underlying_type_t<T>>(C)));
135*d89ec533Spatrick }
136*d89ec533Spatrick 
swapByteOrder(T & Value)137*d89ec533Spatrick template <typename T> inline void swapByteOrder(T &Value) {
138*d89ec533Spatrick   Value = getSwappedBytes(Value);
139*d89ec533Spatrick }
140*d89ec533Spatrick 
141*d89ec533Spatrick } // end namespace __orc_rt
142*d89ec533Spatrick 
143*d89ec533Spatrick #endif // ORC_RT_ENDIAN_H
144