byteswap.hh revision 12383
12036SN/A/* 22036SN/A * Copyright (c) 2004 The Regents of The University of Michigan 32036SN/A * All rights reserved. 42036SN/A * 52036SN/A * Redistribution and use in source and binary forms, with or without 62036SN/A * modification, are permitted provided that the following conditions are 72036SN/A * met: redistributions of source code must retain the above copyright 82036SN/A * notice, this list of conditions and the following disclaimer; 92036SN/A * redistributions in binary form must reproduce the above copyright 102036SN/A * notice, this list of conditions and the following disclaimer in the 112036SN/A * documentation and/or other materials provided with the distribution; 122036SN/A * neither the name of the copyright holders nor the names of its 132036SN/A * contributors may be used to endorse or promote products derived from 142036SN/A * this software without specific prior written permission. 152036SN/A * 162036SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172036SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182036SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192036SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202036SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212036SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222036SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232036SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242036SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252036SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262036SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665Ssaidi@eecs.umich.edu * 282956Sgblack@eecs.umich.edu * Authors: Gabe Black 292956Sgblack@eecs.umich.edu * Ali Saidi 302772Ssaidi@eecs.umich.edu * Nathan Binkert 312036SN/A */ 322036SN/A 332036SN/A//The purpose of this file is to provide endainness conversion utility 342036SN/A//functions. Depending on the endianness of the guest system, either 352036SN/A//the LittleEndianGuest or BigEndianGuest namespace is used. 362036SN/A 372036SN/A#ifndef __SIM_BYTE_SWAP_HH__ 382036SN/A#define __SIM_BYTE_SWAP_HH__ 392036SN/A 404176Sgblack@eecs.umich.edu#include "base/bigint.hh" 416214Snate@binkert.org#include "base/types.hh" 422036SN/A 432036SN/A// This lets us figure out what the byte order of the host system is 448902Sandreas.hansson@arm.com#if defined(__linux__) 452036SN/A#include <endian.h> 462565SN/A// If this is a linux system, lets used the optimized definitions if they exist. 472565SN/A// If one doesn't exist, we pretty much get what is listed below, so it all 482565SN/A// works out 492565SN/A#include <byteswap.h> 503918Ssaidi@eecs.umich.edu#elif defined (__sun) 513483Ssaidi@eecs.umich.edu#include <sys/isa_defs.h> 522036SN/A#else 532036SN/A#include <machine/endian.h> 542036SN/A#endif 552036SN/A 562778Ssaidi@eecs.umich.edu#if defined(__APPLE__) 572778Ssaidi@eecs.umich.edu#include <libkern/OSByteOrder.h> 582778Ssaidi@eecs.umich.edu#endif 592778Ssaidi@eecs.umich.edu 602036SN/A//These functions actually perform the swapping for parameters 612036SN/A//of various bit lengths 625549Snate@binkert.orginline uint64_t 632036SN/Aswap_byte64(uint64_t x) 642036SN/A{ 658902Sandreas.hansson@arm.com#if defined(__linux__) 662565SN/A return bswap_64(x); 672778Ssaidi@eecs.umich.edu#elif defined(__APPLE__) 682778Ssaidi@eecs.umich.edu return OSSwapInt64(x); 692565SN/A#else 702036SN/A return (uint64_t)((((uint64_t)(x) & 0xff) << 56) | 712036SN/A ((uint64_t)(x) & 0xff00ULL) << 40 | 722036SN/A ((uint64_t)(x) & 0xff0000ULL) << 24 | 732036SN/A ((uint64_t)(x) & 0xff000000ULL) << 8 | 742036SN/A ((uint64_t)(x) & 0xff00000000ULL) >> 8 | 752036SN/A ((uint64_t)(x) & 0xff0000000000ULL) >> 24 | 762036SN/A ((uint64_t)(x) & 0xff000000000000ULL) >> 40 | 772036SN/A ((uint64_t)(x) & 0xff00000000000000ULL) >> 56) ; 782565SN/A#endif 792036SN/A} 802036SN/A 815549Snate@binkert.orginline uint32_t 822036SN/Aswap_byte32(uint32_t x) 832036SN/A{ 848902Sandreas.hansson@arm.com#if defined(__linux__) 852565SN/A return bswap_32(x); 862778Ssaidi@eecs.umich.edu#elif defined(__APPLE__) 872778Ssaidi@eecs.umich.edu return OSSwapInt32(x); 882565SN/A#else 892036SN/A return (uint32_t)(((uint32_t)(x) & 0xff) << 24 | 902036SN/A ((uint32_t)(x) & 0xff00) << 8 | ((uint32_t)(x) & 0xff0000) >> 8 | 912036SN/A ((uint32_t)(x) & 0xff000000) >> 24); 922565SN/A#endif 932036SN/A} 942036SN/A 955549Snate@binkert.orginline uint16_t 962036SN/Aswap_byte16(uint16_t x) 972036SN/A{ 988902Sandreas.hansson@arm.com#if defined(__linux__) 992565SN/A return bswap_16(x); 1002778Ssaidi@eecs.umich.edu#elif defined(__APPLE__) 1012778Ssaidi@eecs.umich.edu return OSSwapInt16(x); 1022565SN/A#else 1032036SN/A return (uint16_t)(((uint16_t)(x) & 0xff) << 8 | 1042036SN/A ((uint16_t)(x) & 0xff00) >> 8); 1052565SN/A#endif 1062036SN/A} 1072036SN/A 1082764Sstever@eecs.umich.edu// This function lets the compiler figure out how to call the 1092764Sstever@eecs.umich.edu// swap_byte functions above for different data types. Since the 1104176Sgblack@eecs.umich.edu// sizeof() values are known at compile time, it should inline to a 1112764Sstever@eecs.umich.edu// direct call to the right swap_byteNN() function. 1122764Sstever@eecs.umich.edutemplate <typename T> 1135549Snate@binkert.orginline T swap_byte(T x) { 1142764Sstever@eecs.umich.edu if (sizeof(T) == 8) 1152764Sstever@eecs.umich.edu return swap_byte64((uint64_t)x); 1162764Sstever@eecs.umich.edu else if (sizeof(T) == 4) 1172764Sstever@eecs.umich.edu return swap_byte32((uint32_t)x); 1182764Sstever@eecs.umich.edu else if (sizeof(T) == 2) 1192764Sstever@eecs.umich.edu return swap_byte16((uint16_t)x); 1202764Sstever@eecs.umich.edu else if (sizeof(T) == 1) 1212764Sstever@eecs.umich.edu return x; 1222764Sstever@eecs.umich.edu else 1232764Sstever@eecs.umich.edu panic("Can't byte-swap values larger than 64 bits"); 1242764Sstever@eecs.umich.edu} 1252036SN/A 1264176Sgblack@eecs.umich.edutemplate<> 1275549Snate@binkert.orginline Twin64_t swap_byte<Twin64_t>(Twin64_t x) 1284176Sgblack@eecs.umich.edu{ 1294176Sgblack@eecs.umich.edu x.a = swap_byte(x.a); 1304176Sgblack@eecs.umich.edu x.b = swap_byte(x.b); 1314176Sgblack@eecs.umich.edu return x; 1324176Sgblack@eecs.umich.edu} 1334176Sgblack@eecs.umich.edu 1344176Sgblack@eecs.umich.edutemplate<> 1355549Snate@binkert.orginline Twin32_t swap_byte<Twin32_t>(Twin32_t x) 1364176Sgblack@eecs.umich.edu{ 1374176Sgblack@eecs.umich.edu x.a = swap_byte(x.a); 1384176Sgblack@eecs.umich.edu x.b = swap_byte(x.b); 1394176Sgblack@eecs.umich.edu return x; 1404176Sgblack@eecs.umich.edu} 1414176Sgblack@eecs.umich.edu 14212383Sgabeblack@google.comtemplate <typename T, size_t N> 14312383Sgabeblack@google.cominline std::array<T, N> 14412383Sgabeblack@google.comswap_byte(std::array<T, N> a) 14512383Sgabeblack@google.com{ 14612383Sgabeblack@google.com for (T &v: a) 14712383Sgabeblack@google.com v = swap_byte(v); 14812383Sgabeblack@google.com return a; 14912383Sgabeblack@google.com} 15012383Sgabeblack@google.com 1512036SN/A//The conversion functions with fixed endianness on both ends don't need to 1522036SN/A//be in a namespace 1535549Snate@binkert.orgtemplate <typename T> inline T betole(T value) {return swap_byte(value);} 1545549Snate@binkert.orgtemplate <typename T> inline T letobe(T value) {return swap_byte(value);} 1552036SN/A 1562036SN/A//For conversions not involving the guest system, we can define the functions 1572036SN/A//conditionally based on the BYTE_ORDER macro and outside of the namespaces 15810776Sbr@bsdpad.com#if (defined(_BIG_ENDIAN) || !defined(_LITTLE_ENDIAN)) && BYTE_ORDER == BIG_ENDIAN 1593799Sgblack@eecs.umich.educonst ByteOrder HostByteOrder = BigEndianByteOrder; 1605549Snate@binkert.orgtemplate <typename T> inline T htole(T value) {return swap_byte(value);} 1615549Snate@binkert.orgtemplate <typename T> inline T letoh(T value) {return swap_byte(value);} 1625549Snate@binkert.orgtemplate <typename T> inline T htobe(T value) {return value;} 1635549Snate@binkert.orgtemplate <typename T> inline T betoh(T value) {return value;} 1643483Ssaidi@eecs.umich.edu#elif defined(_LITTLE_ENDIAN) || BYTE_ORDER == LITTLE_ENDIAN 1653799Sgblack@eecs.umich.educonst ByteOrder HostByteOrder = LittleEndianByteOrder; 1665549Snate@binkert.orgtemplate <typename T> inline T htole(T value) {return value;} 1675549Snate@binkert.orgtemplate <typename T> inline T letoh(T value) {return value;} 1685549Snate@binkert.orgtemplate <typename T> inline T htobe(T value) {return swap_byte(value);} 1695549Snate@binkert.orgtemplate <typename T> inline T betoh(T value) {return swap_byte(value);} 1702036SN/A#else 1712036SN/A #error Invalid Endianess 1722036SN/A#endif 1732036SN/A 1742036SN/Anamespace BigEndianGuest 1752036SN/A{ 1768561Sgblack@eecs.umich.edu const ByteOrder GuestByteOrder = BigEndianByteOrder; 1773799Sgblack@eecs.umich.edu template <typename T> 1785549Snate@binkert.org inline T gtole(T value) {return betole(value);} 1793799Sgblack@eecs.umich.edu template <typename T> 1805549Snate@binkert.org inline T letog(T value) {return letobe(value);} 1813799Sgblack@eecs.umich.edu template <typename T> 1825549Snate@binkert.org inline T gtobe(T value) {return value;} 1833799Sgblack@eecs.umich.edu template <typename T> 1845549Snate@binkert.org inline T betog(T value) {return value;} 1853799Sgblack@eecs.umich.edu template <typename T> 1865549Snate@binkert.org inline T htog(T value) {return htobe(value);} 1873799Sgblack@eecs.umich.edu template <typename T> 1885549Snate@binkert.org inline T gtoh(T value) {return betoh(value);} 1892036SN/A} 1902036SN/A 1912036SN/Anamespace LittleEndianGuest 1922036SN/A{ 1938561Sgblack@eecs.umich.edu const ByteOrder GuestByteOrder = LittleEndianByteOrder; 1943799Sgblack@eecs.umich.edu template <typename T> 1955549Snate@binkert.org inline T gtole(T value) {return value;} 1963799Sgblack@eecs.umich.edu template <typename T> 1975549Snate@binkert.org inline T letog(T value) {return value;} 1983799Sgblack@eecs.umich.edu template <typename T> 1995549Snate@binkert.org inline T gtobe(T value) {return letobe(value);} 2003799Sgblack@eecs.umich.edu template <typename T> 2015549Snate@binkert.org inline T betog(T value) {return betole(value);} 2023799Sgblack@eecs.umich.edu template <typename T> 2035549Snate@binkert.org inline T htog(T value) {return htole(value);} 2043799Sgblack@eecs.umich.edu template <typename T> 2055549Snate@binkert.org inline T gtoh(T value) {return letoh(value);} 2062036SN/A} 2072036SN/A#endif // __SIM_BYTE_SWAP_HH__ 208