blob: e8612ba6654b5d950b2eb570c23ebbb79d4dc035 [file] [log] [blame]
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01001//===- SwapByteOrder.h - Generic and optimized byte swaps -------*- C++ -*-===//
2//
Andrew Walbran16937d02019-10-22 13:54:20 +01003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Andrew Scull5e1ddfa2018-08-14 10:06:54 +01006//
7//===----------------------------------------------------------------------===//
8//
9// This file declares generic and optimized functions to swap the byte order of
10// an integral type.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_SUPPORT_SWAPBYTEORDER_H
15#define LLVM_SUPPORT_SWAPBYTEORDER_H
16
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010017#include <cstddef>
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020018#include <cstdint>
Andrew Walbran3d2c1972020-04-07 12:24:26 +010019#include <type_traits>
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010020#if defined(_MSC_VER) && !defined(_DEBUG)
21#include <stdlib.h>
22#endif
23
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020024#if defined(__linux__) || defined(__GNU__) || defined(__HAIKU__) || \
25 defined(__Fuchsia__) || defined(__EMSCRIPTEN__)
26#include <endian.h>
27#elif defined(_AIX)
28#include <sys/machine.h>
29#elif defined(__sun)
30/* Solaris provides _BIG_ENDIAN/_LITTLE_ENDIAN selector in sys/types.h */
31#include <sys/types.h>
32#define BIG_ENDIAN 4321
33#define LITTLE_ENDIAN 1234
34#if defined(_BIG_ENDIAN)
35#define BYTE_ORDER BIG_ENDIAN
36#else
37#define BYTE_ORDER LITTLE_ENDIAN
38#endif
39#elif defined(__MVS__)
40#define BIG_ENDIAN 4321
41#define LITTLE_ENDIAN 1234
42#define BYTE_ORDER BIG_ENDIAN
43#else
44#if !defined(BYTE_ORDER) && !defined(_WIN32)
45#include <machine/endian.h>
46#endif
47#endif
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010048
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020049namespace llvm {
50
51/// ByteSwap_16 - This function returns a byte-swapped representation of
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010052/// the 16-bit argument.
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020053inline uint16_t ByteSwap_16(uint16_t value) {
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010054#if defined(_MSC_VER) && !defined(_DEBUG)
55 // The DLL version of the runtime lacks these functions (bug!?), but in a
56 // release build they're replaced with BSWAP instructions anyway.
57 return _byteswap_ushort(value);
58#else
59 uint16_t Hi = value << 8;
60 uint16_t Lo = value >> 8;
61 return Hi | Lo;
62#endif
63}
64
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020065/// This function returns a byte-swapped representation of the 32-bit argument.
66inline uint32_t ByteSwap_32(uint32_t value) {
67#if defined(__llvm__) || (defined(__GNUC__) && !defined(__ICC))
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010068 return __builtin_bswap32(value);
69#elif defined(_MSC_VER) && !defined(_DEBUG)
70 return _byteswap_ulong(value);
71#else
72 uint32_t Byte0 = value & 0x000000FF;
73 uint32_t Byte1 = value & 0x0000FF00;
74 uint32_t Byte2 = value & 0x00FF0000;
75 uint32_t Byte3 = value & 0xFF000000;
76 return (Byte0 << 24) | (Byte1 << 8) | (Byte2 >> 8) | (Byte3 >> 24);
77#endif
78}
79
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020080/// This function returns a byte-swapped representation of the 64-bit argument.
81inline uint64_t ByteSwap_64(uint64_t value) {
82#if defined(__llvm__) || (defined(__GNUC__) && !defined(__ICC))
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010083 return __builtin_bswap64(value);
84#elif defined(_MSC_VER) && !defined(_DEBUG)
85 return _byteswap_uint64(value);
86#else
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020087 uint64_t Hi = ByteSwap_32(uint32_t(value));
88 uint32_t Lo = ByteSwap_32(uint32_t(value >> 32));
Andrew Scull5e1ddfa2018-08-14 10:06:54 +010089 return (Hi << 32) | Lo;
90#endif
91}
92
Olivier Deprezf4ef2d02021-04-20 13:36:24 +020093namespace sys {
94
95#if defined(BYTE_ORDER) && defined(BIG_ENDIAN) && BYTE_ORDER == BIG_ENDIAN
96constexpr bool IsBigEndianHost = true;
97#else
98constexpr bool IsBigEndianHost = false;
99#endif
100
101static const bool IsLittleEndianHost = !IsBigEndianHost;
102
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100103inline unsigned char getSwappedBytes(unsigned char C) { return C; }
104inline signed char getSwappedBytes(signed char C) { return C; }
105inline char getSwappedBytes(char C) { return C; }
106
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200107inline unsigned short getSwappedBytes(unsigned short C) { return ByteSwap_16(C); }
108inline signed short getSwappedBytes( signed short C) { return ByteSwap_16(C); }
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100109
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200110inline unsigned int getSwappedBytes(unsigned int C) { return ByteSwap_32(C); }
111inline signed int getSwappedBytes( signed int C) { return ByteSwap_32(C); }
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100112
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200113inline unsigned long getSwappedBytes(unsigned long C) {
114 // Handle LLP64 and LP64 platforms.
115 return sizeof(long) == sizeof(int) ? ByteSwap_32((uint32_t)C)
116 : ByteSwap_64((uint64_t)C);
117}
118inline signed long getSwappedBytes(signed long C) {
119 // Handle LLP64 and LP64 platforms.
120 return sizeof(long) == sizeof(int) ? ByteSwap_32((uint32_t)C)
121 : ByteSwap_64((uint64_t)C);
122}
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100123
124inline unsigned long long getSwappedBytes(unsigned long long C) {
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200125 return ByteSwap_64(C);
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100126}
127inline signed long long getSwappedBytes(signed long long C) {
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200128 return ByteSwap_64(C);
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100129}
130
131inline float getSwappedBytes(float C) {
132 union {
133 uint32_t i;
134 float f;
135 } in, out;
136 in.f = C;
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200137 out.i = ByteSwap_32(in.i);
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100138 return out.f;
139}
140
141inline double getSwappedBytes(double C) {
142 union {
143 uint64_t i;
144 double d;
145 } in, out;
146 in.d = C;
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200147 out.i = ByteSwap_64(in.i);
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100148 return out.d;
149}
150
Andrew Walbran3d2c1972020-04-07 12:24:26 +0100151template <typename T>
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200152inline std::enable_if_t<std::is_enum<T>::value, T> getSwappedBytes(T C) {
Andrew Walbran3d2c1972020-04-07 12:24:26 +0100153 return static_cast<T>(
Olivier Deprezf4ef2d02021-04-20 13:36:24 +0200154 getSwappedBytes(static_cast<std::underlying_type_t<T>>(C)));
Andrew Walbran3d2c1972020-04-07 12:24:26 +0100155}
156
Andrew Scull5e1ddfa2018-08-14 10:06:54 +0100157template<typename T>
158inline void swapByteOrder(T &Value) {
159 Value = getSwappedBytes(Value);
160}
161
162} // end namespace sys
163} // end namespace llvm
164
165#endif