types.hh revision 9498
1/* 2 * Copyright (c) 2003-2005 The Regents of The University of Michigan 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer; 9 * redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution; 12 * neither the name of the copyright holders nor the names of its 13 * contributors may be used to endorse or promote products derived from 14 * this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * Authors: Nathan Binkert 29 */ 30 31/** 32 * @file 33 * Defines global host-dependent types: 34 * Counter, Tick, and (indirectly) {int,uint}{8,16,32,64}_t. 35 */ 36 37#ifndef __BASE_TYPES_HH__ 38#define __BASE_TYPES_HH__ 39 40#include <inttypes.h> 41 42#include <cassert> 43 44/** uint64_t constant */ 45#define ULL(N) ((uint64_t)N##ULL) 46/** int64_t constant */ 47#define LL(N) ((int64_t)N##LL) 48 49/** Statistics counter type. Not much excuse for not using a 64-bit 50 * integer here, but if you're desperate and only run short 51 * simulations you could make this 32 bits. 52 */ 53typedef int64_t Counter; 54 55/** 56 * Tick count type. 57 */ 58typedef uint64_t Tick; 59 60const Tick MaxTick = ULL(0xffffffffffffffff); 61 62/** 63 * Cycles is a wrapper class for representing cycle counts, i.e. a 64 * relative difference between two points in time, expressed in a 65 * number of clock cycles. 66 * 67 * The Cycles wrapper class is a type-safe alternative to a 68 * typedef, aiming to avoid unintentional mixing of cycles and ticks 69 * in the code base. 70 * 71 * Operators are defined inside an ifndef block to avoid swig touching 72 * them. Note that there is no overloading of the bool operator as the 73 * compiler is allowed to turn booleans into integers and this causes 74 * a whole range of issues in a handful locations. The solution to 75 * this problem would be to use the safe bool idiom, but for now we 76 * make do without the test and use the more elaborate comparison > 77 * Cycles(0). 78 */ 79class Cycles 80{ 81 82 private: 83 84 /** Member holding the actual value. */ 85 uint64_t c; 86 87 public: 88 89 /** Explicit constructor assigning a value. */ 90 explicit Cycles(uint64_t _c) : c(_c) { } 91 92 /** Default constructor for parameter classes. */ 93 Cycles() : c(0) { } 94 95#ifndef SWIG // keep the operators away from SWIG 96 97 /** Converting back to the value type. */ 98 operator uint64_t() const { return c; } 99 100 /** Prefix increment operator. */ 101 Cycles& operator++() 102 { ++c; return *this; } 103 104 /** Prefix decrement operator. Is only temporarily used in the O3 CPU. */ 105 Cycles& operator--() 106 { assert(c != 0); --c; return *this; } 107 108 /** In-place addition of cycles. */ 109 const Cycles& operator+=(const Cycles& cc) 110 { c += cc.c; return *this; } 111 112 /** Greater than comparison used for > Cycles(0). */ 113 bool operator>(const Cycles& cc) const 114 { return c > cc.c; } 115 116 const Cycles operator +(const Cycles& b) const 117 { return Cycles(c + b.c); } 118 119 const Cycles operator -(const Cycles& b) const 120 { assert(c >= b.c); return Cycles(c - b.c); } 121 122 const Cycles operator <<(const int32_t shift) 123 { return Cycles(c << shift); } 124 125 const Cycles operator >>(const int32_t shift) 126 { return Cycles(c >> shift); } 127 128#endif // SWIG not touching operators 129 130}; 131 132/** 133 * Address type 134 * This will probably be moved somewhere else in the near future. 135 * This should be at least as big as the biggest address width in use 136 * in the system, which will probably be 64 bits. 137 */ 138typedef uint64_t Addr; 139 140typedef uint16_t MicroPC; 141 142static const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1); 143 144static inline MicroPC 145romMicroPC(MicroPC upc) 146{ 147 return upc | MicroPCRomBit; 148} 149 150static inline MicroPC 151normalMicroPC(MicroPC upc) 152{ 153 return upc & ~MicroPCRomBit; 154} 155 156static inline bool 157isRomMicroPC(MicroPC upc) 158{ 159 return MicroPCRomBit & upc; 160} 161 162const Addr MaxAddr = (Addr)-1; 163 164/** 165 * Thread index/ID type 166 */ 167typedef int16_t ThreadID; 168const ThreadID InvalidThreadID = (ThreadID)-1; 169 170/** 171 * Port index/ID type, and a symbolic name for an invalid port id. 172 */ 173typedef int16_t PortID; 174const PortID InvalidPortID = (PortID)-1; 175 176class FaultBase; 177template <class T> class RefCountingPtr; 178typedef RefCountingPtr<FaultBase> Fault; 179 180#endif // __BASE_TYPES_HH__ 181