119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman//===- Endian.h - Utilities for IO with endian specific data ----*- C++ -*-===// 219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// 319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// The LLVM Compiler Infrastructure 419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// 519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// This file is distributed under the University of Illinois Open Source 619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// License. See LICENSE.TXT for details. 719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// 819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman//===----------------------------------------------------------------------===// 919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// 1019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// This file declares generic functions to read and write endian specific data. 1119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// 1219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman//===----------------------------------------------------------------------===// 1319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 1419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#ifndef LLVM_SUPPORT_ENDIAN_H 1519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#define LLVM_SUPPORT_ENDIAN_H 1619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 1719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#include "llvm/Support/Host.h" 1819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#include "llvm/Support/SwapByteOrder.h" 1919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#include "llvm/Support/type_traits.h" 2019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 2119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumannamespace llvm { 2219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumannamespace support { 2319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 2419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanenum endianness {big, little}; 2519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanenum alignment {unaligned, aligned}; 2619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 2719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumannamespace detail { 2819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 2919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type, alignment align> 3019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanstruct alignment_access_helper; 3119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 3219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type> 3319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanstruct alignment_access_helper<value_type, aligned> 3419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman{ 3519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value_type val; 3619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman}; 3719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 3819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman// Provides unaligned loads and stores. 3919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#pragma pack(push) 4019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#pragma pack(1) 4119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type> 4219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanstruct alignment_access_helper<value_type, unaligned> 4319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman{ 4419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value_type val; 4519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman}; 4619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#pragma pack(pop) 4719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 4819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman} // end namespace detail 4919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 5019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumannamespace endian { 5119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman template<typename value_type, alignment align> 5219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman static value_type read_le(const void *memory) { 5319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value_type t = 5419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman reinterpret_cast<const detail::alignment_access_helper 5519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <value_type, align> *>(memory)->val; 5619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman if (sys::isBigEndianHost()) 5719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return sys::SwapByteOrder(t); 5819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return t; 5919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 6019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 6119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman template<typename value_type, alignment align> 6219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman static void write_le(void *memory, value_type value) { 6319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman if (sys::isBigEndianHost()) 6419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value = sys::SwapByteOrder(value); 6519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman reinterpret_cast<detail::alignment_access_helper<value_type, align> *> 6619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman (memory)->val = value; 6719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 6819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 6919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman template<typename value_type, alignment align> 7019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman static value_type read_be(const void *memory) { 7119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value_type t = 7219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman reinterpret_cast<const detail::alignment_access_helper 7319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <value_type, align> *>(memory)->val; 7419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman if (sys::isLittleEndianHost()) 7519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return sys::SwapByteOrder(t); 7619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return t; 7719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 7819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 7919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman template<typename value_type, alignment align> 8019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman static void write_be(void *memory, value_type value) { 8119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman if (sys::isLittleEndianHost()) 8219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value = sys::SwapByteOrder(value); 8319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman reinterpret_cast<detail::alignment_access_helper<value_type, align> *> 8419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman (memory)->val = value; 8519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 8619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman} 8719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 8819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumannamespace detail { 8919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 9019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type, 9119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman endianness endian, 9219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman alignment align> 9319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanclass packed_endian_specific_integral; 9419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 9519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type> 9619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanclass packed_endian_specific_integral<value_type, little, unaligned> { 9719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanpublic: 9819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman operator value_type() const { 9919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return endian::read_le<value_type, unaligned>(Value); 10019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 10119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanprivate: 10219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman uint8_t Value[sizeof(value_type)]; 10319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman}; 10419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 10519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type> 10619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanclass packed_endian_specific_integral<value_type, big, unaligned> { 10719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanpublic: 10819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman operator value_type() const { 10919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return endian::read_be<value_type, unaligned>(Value); 11019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 11119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanprivate: 11219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman uint8_t Value[sizeof(value_type)]; 11319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman}; 11419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 11519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type> 11619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanclass packed_endian_specific_integral<value_type, little, aligned> { 11719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanpublic: 11819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman operator value_type() const { 11919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return endian::read_le<value_type, aligned>(&Value); 12019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 12119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanprivate: 12219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value_type Value; 12319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman}; 12419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 12519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantemplate<typename value_type> 12619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanclass packed_endian_specific_integral<value_type, big, aligned> { 12719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanpublic: 12819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman operator value_type() const { 12919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman return endian::read_be<value_type, aligned>(&Value); 13019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman } 13119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumanprivate: 13219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman value_type Value; 13319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman}; 13419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 13519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman} // end namespace detail 13619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 13719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 13819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint8_t, little, unaligned> ulittle8_t; 13919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 14019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint16_t, little, unaligned> ulittle16_t; 14119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 14219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint32_t, little, unaligned> ulittle32_t; 14319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 14419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint64_t, little, unaligned> ulittle64_t; 14519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 14619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 14719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int8_t, little, unaligned> little8_t; 14819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 14919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int16_t, little, unaligned> little16_t; 15019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 15119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int32_t, little, unaligned> little32_t; 15219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 15319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int64_t, little, unaligned> little64_t; 15419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 15519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 15619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint8_t, little, aligned> aligned_ulittle8_t; 15719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 15819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint16_t, little, aligned> aligned_ulittle16_t; 15919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 16019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint32_t, little, aligned> aligned_ulittle32_t; 16119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 16219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint64_t, little, aligned> aligned_ulittle64_t; 16319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 16419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 16519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int8_t, little, aligned> aligned_little8_t; 16619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 16719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int16_t, little, aligned> aligned_little16_t; 16819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 16919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int32_t, little, aligned> aligned_little32_t; 17019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 17119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int64_t, little, aligned> aligned_little64_t; 17219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 17319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 17419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint8_t, big, unaligned> ubig8_t; 17519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 17619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint16_t, big, unaligned> ubig16_t; 17719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 17819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint32_t, big, unaligned> ubig32_t; 17919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 18019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint64_t, big, unaligned> ubig64_t; 18119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 18219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 18319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int8_t, big, unaligned> big8_t; 18419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 18519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int16_t, big, unaligned> big16_t; 18619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 18719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int32_t, big, unaligned> big32_t; 18819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 18919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int64_t, big, unaligned> big64_t; 19019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 19119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 19219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint8_t, big, aligned> aligned_ubig8_t; 19319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 19419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint16_t, big, aligned> aligned_ubig16_t; 19519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 19619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint32_t, big, aligned> aligned_ubig32_t; 19719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 19819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <uint64_t, big, aligned> aligned_ubig64_t; 19919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 20019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 20119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int8_t, big, aligned> aligned_big8_t; 20219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 20319bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int16_t, big, aligned> aligned_big16_t; 20419bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 20519bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int32_t, big, aligned> aligned_big32_t; 20619bac1e08be200c31efd26f0f5fd144c9b3eefd3John Baumantypedef detail::packed_endian_specific_integral 20719bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman <int64_t, big, aligned> aligned_big64_t; 20819bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 20919bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman} // end namespace llvm 21019bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman} // end namespace support 21119bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman 21219bac1e08be200c31efd26f0f5fd144c9b3eefd3John Bauman#endif 213