Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 1 | /* |
Steve Reinhardt | ad8b963 | 2005-06-05 05:16:00 -0400 | [diff] [blame] | 2 | * Copyright (c) 2003-2005 The Regents of The University of Michigan |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 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. |
Ali Saidi | cb0cf2d | 2006-05-31 19:26:56 -0400 | [diff] [blame] | 27 | * |
| 28 | * Authors: Nathan Binkert |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 29 | */ |
| 30 | |
| 31 | /** |
| 32 | * @file |
Nathan Binkert | eef3a2e | 2009-05-17 14:34:50 -0700 | [diff] [blame] | 33 | * Defines global host-dependent types: |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 34 | * Counter, Tick, and (indirectly) {int,uint}{8,16,32,64}_t. |
| 35 | */ |
| 36 | |
Nathan Binkert | eef3a2e | 2009-05-17 14:34:50 -0700 | [diff] [blame] | 37 | #ifndef __BASE_TYPES_HH__ |
| 38 | #define __BASE_TYPES_HH__ |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 39 | |
| 40 | #include <inttypes.h> |
| 41 | |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 42 | #include <cassert> |
Andreas Hansson | a2d246b | 2014-10-16 05:49:51 -0400 | [diff] [blame] | 43 | #include <memory> |
Nilay Vaish | 7862478 | 2013-02-10 21:26:24 -0600 | [diff] [blame] | 44 | #include <ostream> |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 45 | #include <stdexcept> |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 46 | |
Andreas Sandberg | 25f5a67 | 2014-08-13 06:57:26 -0400 | [diff] [blame] | 47 | #include "base/refcnt.hh" |
| 48 | |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 49 | /** uint64_t constant */ |
Ali Saidi | 3a3e356 | 2008-09-10 14:26:15 -0400 | [diff] [blame] | 50 | #define ULL(N) ((uint64_t)N##ULL) |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 51 | /** int64_t constant */ |
Ali Saidi | 3a3e356 | 2008-09-10 14:26:15 -0400 | [diff] [blame] | 52 | #define LL(N) ((int64_t)N##LL) |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 53 | |
| 54 | /** Statistics counter type. Not much excuse for not using a 64-bit |
| 55 | * integer here, but if you're desperate and only run short |
| 56 | * simulations you could make this 32 bits. |
| 57 | */ |
| 58 | typedef int64_t Counter; |
| 59 | |
| 60 | /** |
Andreas Hansson | 016593f | 2012-08-21 05:49:09 -0400 | [diff] [blame] | 61 | * Tick count type. |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 62 | */ |
Andreas Hansson | 016593f | 2012-08-21 05:49:09 -0400 | [diff] [blame] | 63 | typedef uint64_t Tick; |
Steve Raasch | 92638f9 | 2003-10-07 10:41:54 -0400 | [diff] [blame] | 64 | |
Andreas Hansson | 016593f | 2012-08-21 05:49:09 -0400 | [diff] [blame] | 65 | const Tick MaxTick = ULL(0xffffffffffffffff); |
Steve Reinhardt | 29e34a7 | 2006-06-09 23:01:31 -0400 | [diff] [blame] | 66 | |
Gabe Black | 3f7979c | 2006-02-21 03:38:21 -0500 | [diff] [blame] | 67 | /** |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 68 | * Cycles is a wrapper class for representing cycle counts, i.e. a |
| 69 | * relative difference between two points in time, expressed in a |
| 70 | * number of clock cycles. |
| 71 | * |
| 72 | * The Cycles wrapper class is a type-safe alternative to a |
| 73 | * typedef, aiming to avoid unintentional mixing of cycles and ticks |
| 74 | * in the code base. |
| 75 | * |
Andreas Sandberg | b046be6 | 2017-01-30 12:00:05 +0000 | [diff] [blame] | 76 | * Note that there is no overloading of the bool operator as the |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 77 | * compiler is allowed to turn booleans into integers and this causes |
| 78 | * a whole range of issues in a handful locations. The solution to |
| 79 | * this problem would be to use the safe bool idiom, but for now we |
| 80 | * make do without the test and use the more elaborate comparison > |
| 81 | * Cycles(0). |
| 82 | */ |
| 83 | class Cycles |
| 84 | { |
| 85 | |
| 86 | private: |
| 87 | |
| 88 | /** Member holding the actual value. */ |
| 89 | uint64_t c; |
| 90 | |
| 91 | public: |
| 92 | |
| 93 | /** Explicit constructor assigning a value. */ |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 94 | explicit constexpr Cycles(uint64_t _c) : c(_c) { } |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 95 | |
Andreas Hansson | 287ea1a | 2012-09-07 12:34:38 -0400 | [diff] [blame] | 96 | /** Default constructor for parameter classes. */ |
| 97 | Cycles() : c(0) { } |
| 98 | |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 99 | /** Converting back to the value type. */ |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 100 | constexpr operator uint64_t() const { return c; } |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 101 | |
| 102 | /** Prefix increment operator. */ |
| 103 | Cycles& operator++() |
| 104 | { ++c; return *this; } |
| 105 | |
| 106 | /** Prefix decrement operator. Is only temporarily used in the O3 CPU. */ |
| 107 | Cycles& operator--() |
| 108 | { assert(c != 0); --c; return *this; } |
| 109 | |
| 110 | /** In-place addition of cycles. */ |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 111 | Cycles& operator+=(const Cycles& cc) |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 112 | { c += cc.c; return *this; } |
| 113 | |
| 114 | /** Greater than comparison used for > Cycles(0). */ |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 115 | constexpr bool operator>(const Cycles& cc) const |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 116 | { return c > cc.c; } |
| 117 | |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 118 | constexpr Cycles operator +(const Cycles& b) const |
Nilay Vaish | affd77e | 2013-02-10 21:26:23 -0600 | [diff] [blame] | 119 | { return Cycles(c + b.c); } |
| 120 | |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 121 | constexpr Cycles operator -(const Cycles& b) const |
| 122 | { |
| 123 | return c >= b.c ? Cycles(c - b.c) : |
| 124 | throw std::invalid_argument("RHS cycle value larger than LHS"); |
| 125 | } |
Nilay Vaish | affd77e | 2013-02-10 21:26:23 -0600 | [diff] [blame] | 126 | |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 127 | constexpr Cycles operator <<(const int32_t shift) const |
Nilay Vaish | affd77e | 2013-02-10 21:26:23 -0600 | [diff] [blame] | 128 | { return Cycles(c << shift); } |
| 129 | |
Andreas Sandberg | 3e26756 | 2015-08-07 09:59:12 +0100 | [diff] [blame] | 130 | constexpr Cycles operator >>(const int32_t shift) const |
Nilay Vaish | affd77e | 2013-02-10 21:26:23 -0600 | [diff] [blame] | 131 | { return Cycles(c >> shift); } |
| 132 | |
Nilay Vaish | 7862478 | 2013-02-10 21:26:24 -0600 | [diff] [blame] | 133 | friend std::ostream& operator<<(std::ostream &out, const Cycles & cycles); |
Andreas Hansson | 0cacf7e | 2012-08-28 14:30:33 -0400 | [diff] [blame] | 134 | }; |
| 135 | |
| 136 | /** |
Gabe Black | 3f7979c | 2006-02-21 03:38:21 -0500 | [diff] [blame] | 137 | * Address type |
| 138 | * This will probably be moved somewhere else in the near future. |
| 139 | * This should be at least as big as the biggest address width in use |
| 140 | * in the system, which will probably be 64 bits. |
| 141 | */ |
| 142 | typedef uint64_t Addr; |
| 143 | |
Gabe Black | 6f4bd2c | 2010-10-31 00:07:20 -0700 | [diff] [blame] | 144 | typedef uint16_t MicroPC; |
| 145 | |
| 146 | static const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1); |
| 147 | |
| 148 | static inline MicroPC |
| 149 | romMicroPC(MicroPC upc) |
| 150 | { |
| 151 | return upc | MicroPCRomBit; |
| 152 | } |
| 153 | |
| 154 | static inline MicroPC |
| 155 | normalMicroPC(MicroPC upc) |
| 156 | { |
| 157 | return upc & ~MicroPCRomBit; |
| 158 | } |
| 159 | |
| 160 | static inline bool |
| 161 | isRomMicroPC(MicroPC upc) |
| 162 | { |
| 163 | return MicroPCRomBit & upc; |
| 164 | } |
| 165 | |
Gabe Black | e3651fd | 2006-03-10 18:26:12 -0500 | [diff] [blame] | 166 | const Addr MaxAddr = (Addr)-1; |
| 167 | |
Nathan Binkert | 47877cf | 2009-05-26 09:23:13 -0700 | [diff] [blame] | 168 | /** |
| 169 | * Thread index/ID type |
| 170 | */ |
| 171 | typedef int16_t ThreadID; |
| 172 | const ThreadID InvalidThreadID = (ThreadID)-1; |
| 173 | |
Andreas Sandberg | 53e777d | 2015-08-07 09:59:13 +0100 | [diff] [blame] | 174 | /** Globally unique thread context ID */ |
| 175 | typedef int ContextID; |
| 176 | const ContextID InvalidContextID = (ContextID)-1; |
| 177 | |
Andreas Hansson | cad8027 | 2012-05-30 05:29:42 -0400 | [diff] [blame] | 178 | /** |
| 179 | * Port index/ID type, and a symbolic name for an invalid port id. |
| 180 | */ |
| 181 | typedef int16_t PortID; |
| 182 | const PortID InvalidPortID = (PortID)-1; |
| 183 | |
Gabe Black | 6833ca7 | 2010-09-13 19:26:03 -0700 | [diff] [blame] | 184 | class FaultBase; |
Andreas Hansson | a2d246b | 2014-10-16 05:49:51 -0400 | [diff] [blame] | 185 | typedef std::shared_ptr<FaultBase> Fault; |
| 186 | |
Andreas Hansson | a2d246b | 2014-10-16 05:49:51 -0400 | [diff] [blame] | 187 | // Rather than creating a shared_ptr instance and assigning it nullptr, |
| 188 | // we just create an alias. |
| 189 | constexpr decltype(nullptr) NoFault = nullptr; |
Gabe Black | 6833ca7 | 2010-09-13 19:26:03 -0700 | [diff] [blame] | 190 | |
Tony Gutierrez | d658b6e | 2016-01-19 13:57:50 -0500 | [diff] [blame] | 191 | struct AtomicOpFunctor |
| 192 | { |
| 193 | virtual void operator()(uint8_t *p) = 0; |
Tuan Ta | 7bab1d0 | 2018-01-22 12:54:14 -0500 | [diff] [blame] | 194 | virtual AtomicOpFunctor* clone() = 0; |
Tony Gutierrez | d658b6e | 2016-01-19 13:57:50 -0500 | [diff] [blame] | 195 | virtual ~AtomicOpFunctor() {} |
| 196 | }; |
| 197 | |
| 198 | template <class T> |
| 199 | struct TypedAtomicOpFunctor : public AtomicOpFunctor |
| 200 | { |
| 201 | void operator()(uint8_t *p) { execute((T *)p); } |
Tuan Ta | 7bab1d0 | 2018-01-22 12:54:14 -0500 | [diff] [blame] | 202 | virtual AtomicOpFunctor* clone() = 0; |
Tony Gutierrez | d658b6e | 2016-01-19 13:57:50 -0500 | [diff] [blame] | 203 | virtual void execute(T * p) = 0; |
| 204 | }; |
| 205 | |
Andreas Sandberg | db5c9a5 | 2015-05-23 13:37:03 +0100 | [diff] [blame] | 206 | enum ByteOrder { |
| 207 | BigEndianByteOrder, |
| 208 | LittleEndianByteOrder |
| 209 | }; |
| 210 | |
Nathan Binkert | eef3a2e | 2009-05-17 14:34:50 -0700 | [diff] [blame] | 211 | #endif // __BASE_TYPES_HH__ |