blob: d07c370ab514d0ebe00d5c97ae632e467474ac6a [file] [log] [blame]
Steve Raasch92638f92003-10-07 10:41:54 -04001/*
Steve Reinhardtad8b9632005-06-05 05:16:00 -04002 * Copyright (c) 2003-2005 The Regents of The University of Michigan
Steve Raasch92638f92003-10-07 10:41:54 -04003 * 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 Saidicb0cf2d2006-05-31 19:26:56 -040027 *
28 * Authors: Nathan Binkert
Steve Raasch92638f92003-10-07 10:41:54 -040029 */
30
31/**
32 * @file
Nathan Binkerteef3a2e2009-05-17 14:34:50 -070033 * Defines global host-dependent types:
Steve Raasch92638f92003-10-07 10:41:54 -040034 * Counter, Tick, and (indirectly) {int,uint}{8,16,32,64}_t.
35 */
36
Nathan Binkerteef3a2e2009-05-17 14:34:50 -070037#ifndef __BASE_TYPES_HH__
38#define __BASE_TYPES_HH__
Steve Raasch92638f92003-10-07 10:41:54 -040039
40#include <inttypes.h>
41
Andreas Hansson0cacf7e2012-08-28 14:30:33 -040042#include <cassert>
Andreas Hanssona2d246b2014-10-16 05:49:51 -040043#include <memory>
Nilay Vaish78624782013-02-10 21:26:24 -060044#include <ostream>
Andreas Sandberg3e267562015-08-07 09:59:12 +010045#include <stdexcept>
Andreas Hansson0cacf7e2012-08-28 14:30:33 -040046
Andreas Sandberg25f5a672014-08-13 06:57:26 -040047#include "base/refcnt.hh"
48
Steve Raasch92638f92003-10-07 10:41:54 -040049/** uint64_t constant */
Ali Saidi3a3e3562008-09-10 14:26:15 -040050#define ULL(N) ((uint64_t)N##ULL)
Steve Raasch92638f92003-10-07 10:41:54 -040051/** int64_t constant */
Ali Saidi3a3e3562008-09-10 14:26:15 -040052#define LL(N) ((int64_t)N##LL)
Steve Raasch92638f92003-10-07 10:41:54 -040053
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 */
58typedef int64_t Counter;
59
60/**
Andreas Hansson016593f2012-08-21 05:49:09 -040061 * Tick count type.
Steve Raasch92638f92003-10-07 10:41:54 -040062 */
Andreas Hansson016593f2012-08-21 05:49:09 -040063typedef uint64_t Tick;
Steve Raasch92638f92003-10-07 10:41:54 -040064
Andreas Hansson016593f2012-08-21 05:49:09 -040065const Tick MaxTick = ULL(0xffffffffffffffff);
Steve Reinhardt29e34a72006-06-09 23:01:31 -040066
Gabe Black3f7979c2006-02-21 03:38:21 -050067/**
Andreas Hansson0cacf7e2012-08-28 14:30:33 -040068 * 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 Sandbergb046be62017-01-30 12:00:05 +000076 * Note that there is no overloading of the bool operator as the
Andreas Hansson0cacf7e2012-08-28 14:30:33 -040077 * 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 */
83class 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 Sandberg3e267562015-08-07 09:59:12 +010094 explicit constexpr Cycles(uint64_t _c) : c(_c) { }
Andreas Hansson0cacf7e2012-08-28 14:30:33 -040095
Andreas Hansson287ea1a2012-09-07 12:34:38 -040096 /** Default constructor for parameter classes. */
97 Cycles() : c(0) { }
98
Andreas Hansson0cacf7e2012-08-28 14:30:33 -040099 /** Converting back to the value type. */
Andreas Sandberg3e267562015-08-07 09:59:12 +0100100 constexpr operator uint64_t() const { return c; }
Andreas Hansson0cacf7e2012-08-28 14:30:33 -0400101
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 Sandberg3e267562015-08-07 09:59:12 +0100111 Cycles& operator+=(const Cycles& cc)
Andreas Hansson0cacf7e2012-08-28 14:30:33 -0400112 { c += cc.c; return *this; }
113
114 /** Greater than comparison used for > Cycles(0). */
Andreas Sandberg3e267562015-08-07 09:59:12 +0100115 constexpr bool operator>(const Cycles& cc) const
Andreas Hansson0cacf7e2012-08-28 14:30:33 -0400116 { return c > cc.c; }
117
Andreas Sandberg3e267562015-08-07 09:59:12 +0100118 constexpr Cycles operator +(const Cycles& b) const
Nilay Vaishaffd77e2013-02-10 21:26:23 -0600119 { return Cycles(c + b.c); }
120
Andreas Sandberg3e267562015-08-07 09:59:12 +0100121 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 Vaishaffd77e2013-02-10 21:26:23 -0600126
Andreas Sandberg3e267562015-08-07 09:59:12 +0100127 constexpr Cycles operator <<(const int32_t shift) const
Nilay Vaishaffd77e2013-02-10 21:26:23 -0600128 { return Cycles(c << shift); }
129
Andreas Sandberg3e267562015-08-07 09:59:12 +0100130 constexpr Cycles operator >>(const int32_t shift) const
Nilay Vaishaffd77e2013-02-10 21:26:23 -0600131 { return Cycles(c >> shift); }
132
Nilay Vaish78624782013-02-10 21:26:24 -0600133 friend std::ostream& operator<<(std::ostream &out, const Cycles & cycles);
Andreas Hansson0cacf7e2012-08-28 14:30:33 -0400134};
135
136/**
Gabe Black3f7979c2006-02-21 03:38:21 -0500137 * 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 */
142typedef uint64_t Addr;
143
Gabe Black6f4bd2c2010-10-31 00:07:20 -0700144typedef uint16_t MicroPC;
145
146static const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1);
147
148static inline MicroPC
149romMicroPC(MicroPC upc)
150{
151 return upc | MicroPCRomBit;
152}
153
154static inline MicroPC
155normalMicroPC(MicroPC upc)
156{
157 return upc & ~MicroPCRomBit;
158}
159
160static inline bool
161isRomMicroPC(MicroPC upc)
162{
163 return MicroPCRomBit & upc;
164}
165
Gabe Blacke3651fd2006-03-10 18:26:12 -0500166const Addr MaxAddr = (Addr)-1;
167
Nathan Binkert47877cf2009-05-26 09:23:13 -0700168/**
169 * Thread index/ID type
170 */
171typedef int16_t ThreadID;
172const ThreadID InvalidThreadID = (ThreadID)-1;
173
Andreas Sandberg53e777d2015-08-07 09:59:13 +0100174/** Globally unique thread context ID */
175typedef int ContextID;
176const ContextID InvalidContextID = (ContextID)-1;
177
Andreas Hanssoncad80272012-05-30 05:29:42 -0400178/**
179 * Port index/ID type, and a symbolic name for an invalid port id.
180 */
181typedef int16_t PortID;
182const PortID InvalidPortID = (PortID)-1;
183
Gabe Black6833ca72010-09-13 19:26:03 -0700184class FaultBase;
Andreas Hanssona2d246b2014-10-16 05:49:51 -0400185typedef std::shared_ptr<FaultBase> Fault;
186
Andreas Hanssona2d246b2014-10-16 05:49:51 -0400187// Rather than creating a shared_ptr instance and assigning it nullptr,
188// we just create an alias.
189constexpr decltype(nullptr) NoFault = nullptr;
Gabe Black6833ca72010-09-13 19:26:03 -0700190
Tony Gutierrezd658b6e2016-01-19 13:57:50 -0500191struct AtomicOpFunctor
192{
193 virtual void operator()(uint8_t *p) = 0;
Tuan Ta7bab1d02018-01-22 12:54:14 -0500194 virtual AtomicOpFunctor* clone() = 0;
Tony Gutierrezd658b6e2016-01-19 13:57:50 -0500195 virtual ~AtomicOpFunctor() {}
196};
197
198template <class T>
199struct TypedAtomicOpFunctor : public AtomicOpFunctor
200{
201 void operator()(uint8_t *p) { execute((T *)p); }
Tuan Ta7bab1d02018-01-22 12:54:14 -0500202 virtual AtomicOpFunctor* clone() = 0;
Tony Gutierrezd658b6e2016-01-19 13:57:50 -0500203 virtual void execute(T * p) = 0;
204};
205
Andreas Sandbergdb5c9a52015-05-23 13:37:03 +0100206enum ByteOrder {
207 BigEndianByteOrder,
208 LittleEndianByteOrder
209};
210
Nathan Binkerteef3a2e2009-05-17 14:34:50 -0700211#endif // __BASE_TYPES_HH__