types.hh revision 11005
12SN/A/* 21762SN/A * Copyright (c) 2003-2005 The Regents of The University of Michigan 32SN/A * All rights reserved. 42SN/A * 52SN/A * Redistribution and use in source and binary forms, with or without 62SN/A * modification, are permitted provided that the following conditions are 72SN/A * met: redistributions of source code must retain the above copyright 82SN/A * notice, this list of conditions and the following disclaimer; 92SN/A * redistributions in binary form must reproduce the above copyright 102SN/A * notice, this list of conditions and the following disclaimer in the 112SN/A * documentation and/or other materials provided with the distribution; 122SN/A * neither the name of the copyright holders nor the names of its 132SN/A * contributors may be used to endorse or promote products derived from 142SN/A * this software without specific prior written permission. 152SN/A * 162SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665SN/A * 282665SN/A * Authors: Nathan Binkert 292SN/A */ 302SN/A 312SN/A/** 322SN/A * @file 336214Snate@binkert.org * Defines global host-dependent types: 342SN/A * Counter, Tick, and (indirectly) {int,uint}{8,16,32,64}_t. 352SN/A */ 362SN/A 376214Snate@binkert.org#ifndef __BASE_TYPES_HH__ 386214Snate@binkert.org#define __BASE_TYPES_HH__ 392SN/A 402SN/A#include <inttypes.h> 412SN/A 429180Sandreas.hansson@arm.com#include <cassert> 4310474Sandreas.hansson@arm.com#include <memory> 449500Snilay@cs.wisc.edu#include <ostream> 4511004SAndreas.Sandberg@ARM.com#include <stdexcept> 469180Sandreas.hansson@arm.com 4710276SAndreas.Sandberg@ARM.com#include "base/refcnt.hh" 4810276SAndreas.Sandberg@ARM.com 492SN/A/** uint64_t constant */ 505543SN/A#define ULL(N) ((uint64_t)N##ULL) 512SN/A/** int64_t constant */ 525543SN/A#define LL(N) ((int64_t)N##LL) 532SN/A 542SN/A/** Statistics counter type. Not much excuse for not using a 64-bit 552SN/A * integer here, but if you're desperate and only run short 562SN/A * simulations you could make this 32 bits. 572SN/A */ 582SN/Atypedef int64_t Counter; 592SN/A 602SN/A/** 619158Sandreas.hansson@arm.com * Tick count type. 622SN/A */ 639158Sandreas.hansson@arm.comtypedef uint64_t Tick; 642SN/A 659158Sandreas.hansson@arm.comconst Tick MaxTick = ULL(0xffffffffffffffff); 662667SN/A 672130SN/A/** 689180Sandreas.hansson@arm.com * Cycles is a wrapper class for representing cycle counts, i.e. a 699180Sandreas.hansson@arm.com * relative difference between two points in time, expressed in a 709180Sandreas.hansson@arm.com * number of clock cycles. 719180Sandreas.hansson@arm.com * 729180Sandreas.hansson@arm.com * The Cycles wrapper class is a type-safe alternative to a 739180Sandreas.hansson@arm.com * typedef, aiming to avoid unintentional mixing of cycles and ticks 749180Sandreas.hansson@arm.com * in the code base. 759180Sandreas.hansson@arm.com * 769180Sandreas.hansson@arm.com * Operators are defined inside an ifndef block to avoid swig touching 779180Sandreas.hansson@arm.com * them. Note that there is no overloading of the bool operator as the 789180Sandreas.hansson@arm.com * compiler is allowed to turn booleans into integers and this causes 799180Sandreas.hansson@arm.com * a whole range of issues in a handful locations. The solution to 809180Sandreas.hansson@arm.com * this problem would be to use the safe bool idiom, but for now we 819180Sandreas.hansson@arm.com * make do without the test and use the more elaborate comparison > 829180Sandreas.hansson@arm.com * Cycles(0). 839180Sandreas.hansson@arm.com */ 849180Sandreas.hansson@arm.comclass Cycles 859180Sandreas.hansson@arm.com{ 869180Sandreas.hansson@arm.com 879180Sandreas.hansson@arm.com private: 889180Sandreas.hansson@arm.com 899180Sandreas.hansson@arm.com /** Member holding the actual value. */ 909180Sandreas.hansson@arm.com uint64_t c; 919180Sandreas.hansson@arm.com 929180Sandreas.hansson@arm.com public: 939180Sandreas.hansson@arm.com 9411004SAndreas.Sandberg@ARM.com#ifndef SWIG // SWIG gets confused by constexpr 959180Sandreas.hansson@arm.com /** Explicit constructor assigning a value. */ 9611004SAndreas.Sandberg@ARM.com explicit constexpr Cycles(uint64_t _c) : c(_c) { } 9711004SAndreas.Sandberg@ARM.com#else 989180Sandreas.hansson@arm.com explicit Cycles(uint64_t _c) : c(_c) { } 9911004SAndreas.Sandberg@ARM.com#endif 1009180Sandreas.hansson@arm.com 1019184Sandreas.hansson@arm.com /** Default constructor for parameter classes. */ 1029184Sandreas.hansson@arm.com Cycles() : c(0) { } 1039184Sandreas.hansson@arm.com 1049180Sandreas.hansson@arm.com#ifndef SWIG // keep the operators away from SWIG 1059180Sandreas.hansson@arm.com 1069180Sandreas.hansson@arm.com /** Converting back to the value type. */ 10711004SAndreas.Sandberg@ARM.com constexpr operator uint64_t() const { return c; } 1089180Sandreas.hansson@arm.com 1099180Sandreas.hansson@arm.com /** Prefix increment operator. */ 1109180Sandreas.hansson@arm.com Cycles& operator++() 1119180Sandreas.hansson@arm.com { ++c; return *this; } 1129180Sandreas.hansson@arm.com 1139180Sandreas.hansson@arm.com /** Prefix decrement operator. Is only temporarily used in the O3 CPU. */ 1149180Sandreas.hansson@arm.com Cycles& operator--() 1159180Sandreas.hansson@arm.com { assert(c != 0); --c; return *this; } 1169180Sandreas.hansson@arm.com 1179180Sandreas.hansson@arm.com /** In-place addition of cycles. */ 11811004SAndreas.Sandberg@ARM.com Cycles& operator+=(const Cycles& cc) 1199180Sandreas.hansson@arm.com { c += cc.c; return *this; } 1209180Sandreas.hansson@arm.com 1219180Sandreas.hansson@arm.com /** Greater than comparison used for > Cycles(0). */ 12211004SAndreas.Sandberg@ARM.com constexpr bool operator>(const Cycles& cc) const 1239180Sandreas.hansson@arm.com { return c > cc.c; } 1249180Sandreas.hansson@arm.com 12511004SAndreas.Sandberg@ARM.com constexpr Cycles operator +(const Cycles& b) const 1269498Snilay@cs.wisc.edu { return Cycles(c + b.c); } 1279498Snilay@cs.wisc.edu 12811004SAndreas.Sandberg@ARM.com constexpr Cycles operator -(const Cycles& b) const 12911004SAndreas.Sandberg@ARM.com { 13011004SAndreas.Sandberg@ARM.com return c >= b.c ? Cycles(c - b.c) : 13111004SAndreas.Sandberg@ARM.com throw std::invalid_argument("RHS cycle value larger than LHS"); 13211004SAndreas.Sandberg@ARM.com } 1339498Snilay@cs.wisc.edu 13411004SAndreas.Sandberg@ARM.com constexpr Cycles operator <<(const int32_t shift) const 1359498Snilay@cs.wisc.edu { return Cycles(c << shift); } 1369498Snilay@cs.wisc.edu 13711004SAndreas.Sandberg@ARM.com constexpr Cycles operator >>(const int32_t shift) const 1389498Snilay@cs.wisc.edu { return Cycles(c >> shift); } 1399498Snilay@cs.wisc.edu 1409500Snilay@cs.wisc.edu friend std::ostream& operator<<(std::ostream &out, const Cycles & cycles); 1419500Snilay@cs.wisc.edu 1429180Sandreas.hansson@arm.com#endif // SWIG not touching operators 1439180Sandreas.hansson@arm.com 1449180Sandreas.hansson@arm.com}; 1459180Sandreas.hansson@arm.com 1469180Sandreas.hansson@arm.com/** 1472130SN/A * Address type 1482130SN/A * This will probably be moved somewhere else in the near future. 1492130SN/A * This should be at least as big as the biggest address width in use 1502130SN/A * in the system, which will probably be 64 bits. 1512130SN/A */ 1522130SN/Atypedef uint64_t Addr; 1532130SN/A 1547720Sgblack@eecs.umich.edutypedef uint16_t MicroPC; 1557720Sgblack@eecs.umich.edu 1567720Sgblack@eecs.umich.edustatic const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1); 1577720Sgblack@eecs.umich.edu 1587720Sgblack@eecs.umich.edustatic inline MicroPC 1597720Sgblack@eecs.umich.eduromMicroPC(MicroPC upc) 1607720Sgblack@eecs.umich.edu{ 1617720Sgblack@eecs.umich.edu return upc | MicroPCRomBit; 1627720Sgblack@eecs.umich.edu} 1637720Sgblack@eecs.umich.edu 1647720Sgblack@eecs.umich.edustatic inline MicroPC 1657720Sgblack@eecs.umich.edunormalMicroPC(MicroPC upc) 1667720Sgblack@eecs.umich.edu{ 1677720Sgblack@eecs.umich.edu return upc & ~MicroPCRomBit; 1687720Sgblack@eecs.umich.edu} 1697720Sgblack@eecs.umich.edu 1707720Sgblack@eecs.umich.edustatic inline bool 1717720Sgblack@eecs.umich.eduisRomMicroPC(MicroPC upc) 1727720Sgblack@eecs.umich.edu{ 1737720Sgblack@eecs.umich.edu return MicroPCRomBit & upc; 1747720Sgblack@eecs.umich.edu} 1757720Sgblack@eecs.umich.edu 1762438SN/Aconst Addr MaxAddr = (Addr)-1; 1772438SN/A 1786221Snate@binkert.org/** 1796221Snate@binkert.org * Thread index/ID type 1806221Snate@binkert.org */ 1816221Snate@binkert.orgtypedef int16_t ThreadID; 1826221Snate@binkert.orgconst ThreadID InvalidThreadID = (ThreadID)-1; 1836221Snate@binkert.org 18411005Sandreas.sandberg@arm.com/** Globally unique thread context ID */ 18511005Sandreas.sandberg@arm.comtypedef int ContextID; 18611005Sandreas.sandberg@arm.comconst ContextID InvalidContextID = (ContextID)-1; 18711005Sandreas.sandberg@arm.com 1889031Sandreas.hansson@arm.com/** 1899031Sandreas.hansson@arm.com * Port index/ID type, and a symbolic name for an invalid port id. 1909031Sandreas.hansson@arm.com */ 1919031Sandreas.hansson@arm.comtypedef int16_t PortID; 1929031Sandreas.hansson@arm.comconst PortID InvalidPortID = (PortID)-1; 1939031Sandreas.hansson@arm.com 1947678Sgblack@eecs.umich.educlass FaultBase; 19510474Sandreas.hansson@arm.comtypedef std::shared_ptr<FaultBase> Fault; 19610474Sandreas.hansson@arm.com 19710474Sandreas.hansson@arm.com#ifndef SWIG // Swig gets really confused by decltype 19810474Sandreas.hansson@arm.com// Rather than creating a shared_ptr instance and assigning it nullptr, 19910474Sandreas.hansson@arm.com// we just create an alias. 20010474Sandreas.hansson@arm.comconstexpr decltype(nullptr) NoFault = nullptr; 20110474Sandreas.hansson@arm.com#endif 2027678Sgblack@eecs.umich.edu 20310839Sandreas.sandberg@arm.comenum ByteOrder { 20410839Sandreas.sandberg@arm.com BigEndianByteOrder, 20510839Sandreas.sandberg@arm.com LittleEndianByteOrder 20610839Sandreas.sandberg@arm.com}; 20710839Sandreas.sandberg@arm.com 2086214Snate@binkert.org#endif // __BASE_TYPES_HH__ 209