1 //===- Endian.h - Utilities for IO with endian specific data ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file declares generic functions to read and write endian specific data.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_SUPPORT_ENDIAN_H
15 #define LLVM_SUPPORT_ENDIAN_H
17 #include "llvm/Support/AlignOf.h"
18 #include "llvm/Support/Host.h"
19 #include "llvm/Support/SwapByteOrder.h"
23 enum endianness {big, little, native};
25 // These are named values for common alignments.
26 enum {aligned = 0, unaligned = 1};
29 /// \brief ::value is either alignment, or alignof(T) if alignment is 0.
30 template<class T, int alignment>
31 struct PickAlignment {
32 enum {value = alignment == 0 ? AlignOf<T>::Alignment : alignment};
34 } // end namespace detail
37 /// Swap the bytes of value to match the given endianness.
38 template<typename value_type, endianness endian>
39 inline value_type byte_swap(value_type value) {
40 if (endian != native && sys::IsBigEndianHost != (endian == big))
41 sys::swapByteOrder(value);
45 /// Read a value of a particular endianness from memory.
46 template<typename value_type,
48 std::size_t alignment>
49 inline value_type read(const void *memory) {
53 LLVM_ASSUME_ALIGNED(memory,
54 (detail::PickAlignment<value_type, alignment>::value)),
56 return byte_swap<value_type, endian>(ret);
59 /// Read a value of a particular endianness from a buffer, and increment the
60 /// buffer past that value.
61 template<typename value_type, endianness endian, std::size_t alignment,
63 inline value_type readNext(const CharT *&memory) {
64 value_type ret = read<value_type, endian, alignment>(memory);
65 memory += sizeof(value_type);
69 /// Write a value to memory with a particular endianness.
70 template<typename value_type,
72 std::size_t alignment>
73 inline void write(void *memory, value_type value) {
74 value = byte_swap<value_type, endian>(value);
75 memcpy(LLVM_ASSUME_ALIGNED(memory,
76 (detail::PickAlignment<value_type, alignment>::value)),
81 template <typename value_type>
82 using make_unsigned_t = typename std::make_unsigned<value_type>::type;
84 /// Read a value of a particular endianness from memory, for a location
85 /// that starts at the given bit offset within the first byte.
86 template <typename value_type, endianness endian, std::size_t alignment>
87 inline value_type readAtBitAlignment(const void *memory, uint64_t startBit) {
90 return read<value_type, endian, alignment>(memory);
92 // Read two values and compose the result from them.
96 memory, (detail::PickAlignment<value_type, alignment>::value)),
97 sizeof(value_type) * 2);
98 val[0] = byte_swap<value_type, endian>(val[0]);
99 val[1] = byte_swap<value_type, endian>(val[1]);
101 // Shift bits from the lower value into place.
102 make_unsigned_t<value_type> lowerVal = val[0] >> startBit;
103 // Mask off upper bits after right shift in case of signed type.
104 make_unsigned_t<value_type> numBitsFirstVal =
105 (sizeof(value_type) * 8) - startBit;
106 lowerVal &= ((make_unsigned_t<value_type>)1 << numBitsFirstVal) - 1;
108 // Get the bits from the upper value.
109 make_unsigned_t<value_type> upperVal =
110 val[1] & (((make_unsigned_t<value_type>)1 << startBit) - 1);
111 // Shift them in to place.
112 upperVal <<= numBitsFirstVal;
114 return lowerVal | upperVal;
118 /// Write a value to memory with a particular endianness, for a location
119 /// that starts at the given bit offset within the first byte.
120 template <typename value_type, endianness endian, std::size_t alignment>
121 inline void writeAtBitAlignment(void *memory, value_type value,
123 assert(startBit < 8);
125 write<value_type, endian, alignment>(memory, value);
127 // Read two values and shift the result into them.
131 memory, (detail::PickAlignment<value_type, alignment>::value)),
132 sizeof(value_type) * 2);
133 val[0] = byte_swap<value_type, endian>(val[0]);
134 val[1] = byte_swap<value_type, endian>(val[1]);
136 // Mask off any existing bits in the upper part of the lower value that
137 // we want to replace.
138 val[0] &= ((make_unsigned_t<value_type>)1 << startBit) - 1;
139 make_unsigned_t<value_type> numBitsFirstVal =
140 (sizeof(value_type) * 8) - startBit;
141 make_unsigned_t<value_type> lowerVal = value;
143 // Mask off the upper bits in the new value that are not going to go into
144 // the lower value. This avoids a left shift of a negative value, which
145 // is undefined behavior.
146 lowerVal &= (((make_unsigned_t<value_type>)1 << numBitsFirstVal) - 1);
147 // Now shift the new bits into place
148 lowerVal <<= startBit;
152 // Mask off any existing bits in the lower part of the upper value that
153 // we want to replace.
154 val[1] &= ~(((make_unsigned_t<value_type>)1 << startBit) - 1);
155 // Next shift the bits that go into the upper value into position.
156 make_unsigned_t<value_type> upperVal = value >> numBitsFirstVal;
157 // Mask off upper bits after right shift in case of signed type.
158 upperVal &= ((make_unsigned_t<value_type>)1 << startBit) - 1;
161 // Finally, rewrite values.
162 val[0] = byte_swap<value_type, endian>(val[0]);
163 val[1] = byte_swap<value_type, endian>(val[1]);
164 memcpy(LLVM_ASSUME_ALIGNED(
165 memory, (detail::PickAlignment<value_type, alignment>::value)),
166 &val[0], sizeof(value_type) * 2);
169 } // end namespace endian
172 template<typename value_type,
174 std::size_t alignment>
175 struct packed_endian_specific_integral {
176 operator value_type() const {
177 return endian::read<value_type, endian, alignment>(
178 (const void*)Value.buffer);
181 void operator=(value_type newValue) {
182 endian::write<value_type, endian, alignment>(
183 (void*)Value.buffer, newValue);
186 packed_endian_specific_integral &operator+=(value_type newValue) {
187 *this = *this + newValue;
191 packed_endian_specific_integral &operator-=(value_type newValue) {
192 *this = *this - newValue;
196 packed_endian_specific_integral &operator|=(value_type newValue) {
197 *this = *this | newValue;
201 packed_endian_specific_integral &operator&=(value_type newValue) {
202 *this = *this & newValue;
207 AlignedCharArray<PickAlignment<value_type, alignment>::value,
208 sizeof(value_type)> Value;
212 explicit ref(void *Ptr) : Ptr(Ptr) {}
214 operator value_type() const {
215 return endian::read<value_type, endian, alignment>(Ptr);
218 void operator=(value_type NewValue) {
219 endian::write<value_type, endian, alignment>(Ptr, NewValue);
227 } // end namespace detail
229 typedef detail::packed_endian_specific_integral
230 <uint16_t, little, unaligned> ulittle16_t;
231 typedef detail::packed_endian_specific_integral
232 <uint32_t, little, unaligned> ulittle32_t;
233 typedef detail::packed_endian_specific_integral
234 <uint64_t, little, unaligned> ulittle64_t;
236 typedef detail::packed_endian_specific_integral
237 <int16_t, little, unaligned> little16_t;
238 typedef detail::packed_endian_specific_integral
239 <int32_t, little, unaligned> little32_t;
240 typedef detail::packed_endian_specific_integral
241 <int64_t, little, unaligned> little64_t;
243 typedef detail::packed_endian_specific_integral
244 <uint16_t, little, aligned> aligned_ulittle16_t;
245 typedef detail::packed_endian_specific_integral
246 <uint32_t, little, aligned> aligned_ulittle32_t;
247 typedef detail::packed_endian_specific_integral
248 <uint64_t, little, aligned> aligned_ulittle64_t;
250 typedef detail::packed_endian_specific_integral
251 <int16_t, little, aligned> aligned_little16_t;
252 typedef detail::packed_endian_specific_integral
253 <int32_t, little, aligned> aligned_little32_t;
254 typedef detail::packed_endian_specific_integral
255 <int64_t, little, aligned> aligned_little64_t;
257 typedef detail::packed_endian_specific_integral
258 <uint16_t, big, unaligned> ubig16_t;
259 typedef detail::packed_endian_specific_integral
260 <uint32_t, big, unaligned> ubig32_t;
261 typedef detail::packed_endian_specific_integral
262 <uint64_t, big, unaligned> ubig64_t;
264 typedef detail::packed_endian_specific_integral
265 <int16_t, big, unaligned> big16_t;
266 typedef detail::packed_endian_specific_integral
267 <int32_t, big, unaligned> big32_t;
268 typedef detail::packed_endian_specific_integral
269 <int64_t, big, unaligned> big64_t;
271 typedef detail::packed_endian_specific_integral
272 <uint16_t, big, aligned> aligned_ubig16_t;
273 typedef detail::packed_endian_specific_integral
274 <uint32_t, big, aligned> aligned_ubig32_t;
275 typedef detail::packed_endian_specific_integral
276 <uint64_t, big, aligned> aligned_ubig64_t;
278 typedef detail::packed_endian_specific_integral
279 <int16_t, big, aligned> aligned_big16_t;
280 typedef detail::packed_endian_specific_integral
281 <int32_t, big, aligned> aligned_big32_t;
282 typedef detail::packed_endian_specific_integral
283 <int64_t, big, aligned> aligned_big64_t;
285 typedef detail::packed_endian_specific_integral
286 <uint16_t, native, unaligned> unaligned_uint16_t;
287 typedef detail::packed_endian_specific_integral
288 <uint32_t, native, unaligned> unaligned_uint32_t;
289 typedef detail::packed_endian_specific_integral
290 <uint64_t, native, unaligned> unaligned_uint64_t;
292 typedef detail::packed_endian_specific_integral
293 <int16_t, native, unaligned> unaligned_int16_t;
294 typedef detail::packed_endian_specific_integral
295 <int32_t, native, unaligned> unaligned_int32_t;
296 typedef detail::packed_endian_specific_integral
297 <int64_t, native, unaligned> unaligned_int64_t;
300 inline uint16_t read16le(const void *p) { return *(const ulittle16_t *)p; }
301 inline uint32_t read32le(const void *p) { return *(const ulittle32_t *)p; }
302 inline uint64_t read64le(const void *p) { return *(const ulittle64_t *)p; }
303 inline uint16_t read16be(const void *p) { return *(const ubig16_t *)p; }
304 inline uint32_t read32be(const void *p) { return *(const ubig32_t *)p; }
305 inline uint64_t read64be(const void *p) { return *(const ubig64_t *)p; }
307 inline void write16le(void *p, uint16_t v) { *(ulittle16_t *)p = v; }
308 inline void write32le(void *p, uint32_t v) { *(ulittle32_t *)p = v; }
309 inline void write64le(void *p, uint64_t v) { *(ulittle64_t *)p = v; }
310 inline void write16be(void *p, uint16_t v) { *(ubig16_t *)p = v; }
311 inline void write32be(void *p, uint32_t v) { *(ubig32_t *)p = v; }
312 inline void write64be(void *p, uint64_t v) { *(ubig64_t *)p = v; }
313 } // end namespace endian
314 } // end namespace support
315 } // end namespace llvm