types.hh revision 10474
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> 459180Sandreas.hansson@arm.com 4610276SAndreas.Sandberg@ARM.com#include "base/refcnt.hh" 4710276SAndreas.Sandberg@ARM.com 482SN/A/** uint64_t constant */ 495543SN/A#define ULL(N) ((uint64_t)N##ULL) 502SN/A/** int64_t constant */ 515543SN/A#define LL(N) ((int64_t)N##LL) 522SN/A 532SN/A/** Statistics counter type. Not much excuse for not using a 64-bit 542SN/A * integer here, but if you're desperate and only run short 552SN/A * simulations you could make this 32 bits. 562SN/A */ 572SN/Atypedef int64_t Counter; 582SN/A 592SN/A/** 609158Sandreas.hansson@arm.com * Tick count type. 612SN/A */ 629158Sandreas.hansson@arm.comtypedef uint64_t Tick; 632SN/A 649158Sandreas.hansson@arm.comconst Tick MaxTick = ULL(0xffffffffffffffff); 652667SN/A 662130SN/A/** 679180Sandreas.hansson@arm.com * Cycles is a wrapper class for representing cycle counts, i.e. a 689180Sandreas.hansson@arm.com * relative difference between two points in time, expressed in a 699180Sandreas.hansson@arm.com * number of clock cycles. 709180Sandreas.hansson@arm.com * 719180Sandreas.hansson@arm.com * The Cycles wrapper class is a type-safe alternative to a 729180Sandreas.hansson@arm.com * typedef, aiming to avoid unintentional mixing of cycles and ticks 739180Sandreas.hansson@arm.com * in the code base. 749180Sandreas.hansson@arm.com * 759180Sandreas.hansson@arm.com * Operators are defined inside an ifndef block to avoid swig touching 769180Sandreas.hansson@arm.com * them. Note that there is no overloading of the bool operator as the 779180Sandreas.hansson@arm.com * compiler is allowed to turn booleans into integers and this causes 789180Sandreas.hansson@arm.com * a whole range of issues in a handful locations. The solution to 799180Sandreas.hansson@arm.com * this problem would be to use the safe bool idiom, but for now we 809180Sandreas.hansson@arm.com * make do without the test and use the more elaborate comparison > 819180Sandreas.hansson@arm.com * Cycles(0). 829180Sandreas.hansson@arm.com */ 839180Sandreas.hansson@arm.comclass Cycles 849180Sandreas.hansson@arm.com{ 859180Sandreas.hansson@arm.com 869180Sandreas.hansson@arm.com private: 879180Sandreas.hansson@arm.com 889180Sandreas.hansson@arm.com /** Member holding the actual value. */ 899180Sandreas.hansson@arm.com uint64_t c; 909180Sandreas.hansson@arm.com 919180Sandreas.hansson@arm.com public: 929180Sandreas.hansson@arm.com 939180Sandreas.hansson@arm.com /** Explicit constructor assigning a value. */ 949180Sandreas.hansson@arm.com explicit Cycles(uint64_t _c) : c(_c) { } 959180Sandreas.hansson@arm.com 969184Sandreas.hansson@arm.com /** Default constructor for parameter classes. */ 979184Sandreas.hansson@arm.com Cycles() : c(0) { } 989184Sandreas.hansson@arm.com 999180Sandreas.hansson@arm.com#ifndef SWIG // keep the operators away from SWIG 1009180Sandreas.hansson@arm.com 1019180Sandreas.hansson@arm.com /** Converting back to the value type. */ 1029180Sandreas.hansson@arm.com operator uint64_t() const { return c; } 1039180Sandreas.hansson@arm.com 1049180Sandreas.hansson@arm.com /** Prefix increment operator. */ 1059180Sandreas.hansson@arm.com Cycles& operator++() 1069180Sandreas.hansson@arm.com { ++c; return *this; } 1079180Sandreas.hansson@arm.com 1089180Sandreas.hansson@arm.com /** Prefix decrement operator. Is only temporarily used in the O3 CPU. */ 1099180Sandreas.hansson@arm.com Cycles& operator--() 1109180Sandreas.hansson@arm.com { assert(c != 0); --c; return *this; } 1119180Sandreas.hansson@arm.com 1129180Sandreas.hansson@arm.com /** In-place addition of cycles. */ 1139180Sandreas.hansson@arm.com const Cycles& operator+=(const Cycles& cc) 1149180Sandreas.hansson@arm.com { c += cc.c; return *this; } 1159180Sandreas.hansson@arm.com 1169180Sandreas.hansson@arm.com /** Greater than comparison used for > Cycles(0). */ 1179180Sandreas.hansson@arm.com bool operator>(const Cycles& cc) const 1189180Sandreas.hansson@arm.com { return c > cc.c; } 1199180Sandreas.hansson@arm.com 1209498Snilay@cs.wisc.edu const Cycles operator +(const Cycles& b) const 1219498Snilay@cs.wisc.edu { return Cycles(c + b.c); } 1229498Snilay@cs.wisc.edu 1239498Snilay@cs.wisc.edu const Cycles operator -(const Cycles& b) const 1249498Snilay@cs.wisc.edu { assert(c >= b.c); return Cycles(c - b.c); } 1259498Snilay@cs.wisc.edu 1269498Snilay@cs.wisc.edu const Cycles operator <<(const int32_t shift) 1279498Snilay@cs.wisc.edu { return Cycles(c << shift); } 1289498Snilay@cs.wisc.edu 1299498Snilay@cs.wisc.edu const Cycles operator >>(const int32_t shift) 1309498Snilay@cs.wisc.edu { return Cycles(c >> shift); } 1319498Snilay@cs.wisc.edu 1329500Snilay@cs.wisc.edu friend std::ostream& operator<<(std::ostream &out, const Cycles & cycles); 1339500Snilay@cs.wisc.edu 1349180Sandreas.hansson@arm.com#endif // SWIG not touching operators 1359180Sandreas.hansson@arm.com 1369180Sandreas.hansson@arm.com}; 1379180Sandreas.hansson@arm.com 1389180Sandreas.hansson@arm.com/** 1392130SN/A * Address type 1402130SN/A * This will probably be moved somewhere else in the near future. 1412130SN/A * This should be at least as big as the biggest address width in use 1422130SN/A * in the system, which will probably be 64 bits. 1432130SN/A */ 1442130SN/Atypedef uint64_t Addr; 1452130SN/A 1467720Sgblack@eecs.umich.edutypedef uint16_t MicroPC; 1477720Sgblack@eecs.umich.edu 1487720Sgblack@eecs.umich.edustatic const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1); 1497720Sgblack@eecs.umich.edu 1507720Sgblack@eecs.umich.edustatic inline MicroPC 1517720Sgblack@eecs.umich.eduromMicroPC(MicroPC upc) 1527720Sgblack@eecs.umich.edu{ 1537720Sgblack@eecs.umich.edu return upc | MicroPCRomBit; 1547720Sgblack@eecs.umich.edu} 1557720Sgblack@eecs.umich.edu 1567720Sgblack@eecs.umich.edustatic inline MicroPC 1577720Sgblack@eecs.umich.edunormalMicroPC(MicroPC upc) 1587720Sgblack@eecs.umich.edu{ 1597720Sgblack@eecs.umich.edu return upc & ~MicroPCRomBit; 1607720Sgblack@eecs.umich.edu} 1617720Sgblack@eecs.umich.edu 1627720Sgblack@eecs.umich.edustatic inline bool 1637720Sgblack@eecs.umich.eduisRomMicroPC(MicroPC upc) 1647720Sgblack@eecs.umich.edu{ 1657720Sgblack@eecs.umich.edu return MicroPCRomBit & upc; 1667720Sgblack@eecs.umich.edu} 1677720Sgblack@eecs.umich.edu 1682438SN/Aconst Addr MaxAddr = (Addr)-1; 1692438SN/A 1706221Snate@binkert.org/** 1716221Snate@binkert.org * Thread index/ID type 1726221Snate@binkert.org */ 1736221Snate@binkert.orgtypedef int16_t ThreadID; 1746221Snate@binkert.orgconst ThreadID InvalidThreadID = (ThreadID)-1; 1756221Snate@binkert.org 1769031Sandreas.hansson@arm.com/** 1779031Sandreas.hansson@arm.com * Port index/ID type, and a symbolic name for an invalid port id. 1789031Sandreas.hansson@arm.com */ 1799031Sandreas.hansson@arm.comtypedef int16_t PortID; 1809031Sandreas.hansson@arm.comconst PortID InvalidPortID = (PortID)-1; 1819031Sandreas.hansson@arm.com 1827678Sgblack@eecs.umich.educlass FaultBase; 18310474Sandreas.hansson@arm.comtypedef std::shared_ptr<FaultBase> Fault; 18410474Sandreas.hansson@arm.com 18510474Sandreas.hansson@arm.com#ifndef SWIG // Swig gets really confused by decltype 18610474Sandreas.hansson@arm.com// Rather than creating a shared_ptr instance and assigning it nullptr, 18710474Sandreas.hansson@arm.com// we just create an alias. 18810474Sandreas.hansson@arm.comconstexpr decltype(nullptr) NoFault = nullptr; 18910474Sandreas.hansson@arm.com#endif 1907678Sgblack@eecs.umich.edu 1916214Snate@binkert.org#endif // __BASE_TYPES_HH__ 192