types.hh revision 10276:4cbfdcdb2144 
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#include <ostream>
44
45#include "base/refcnt.hh"
46
47/** uint64_t constant */
48#define ULL(N)          ((uint64_t)N##ULL)
49/** int64_t constant */
50#define LL(N)           ((int64_t)N##LL)
51
52/** Statistics counter type.  Not much excuse for not using a 64-bit
53 * integer here, but if you're desperate and only run short
54 * simulations you could make this 32 bits.
55 */
56typedef int64_t Counter;
57
58/**
59 * Tick count type.
60 */
61typedef uint64_t Tick;
62
63const Tick MaxTick = ULL(0xffffffffffffffff);
64
65/**
66 * Cycles is a wrapper class for representing cycle counts, i.e. a
67 * relative difference between two points in time, expressed in a
68 * number of clock cycles.
69 *
70 * The Cycles wrapper class is a type-safe alternative to a
71 * typedef, aiming to avoid unintentional mixing of cycles and ticks
72 * in the code base.
73 *
74 * Operators are defined inside an ifndef block to avoid swig touching
75 * them. Note that there is no overloading of the bool operator as the
76 * compiler is allowed to turn booleans into integers and this causes
77 * a whole range of issues in a handful locations. The solution to
78 * this problem would be to use the safe bool idiom, but for now we
79 * make do without the test and use the more elaborate comparison >
80 * Cycles(0).
81 */
82class Cycles
83{
84
85  private:
86
87    /** Member holding the actual value. */
88    uint64_t c;
89
90  public:
91
92    /** Explicit constructor assigning a value. */
93    explicit Cycles(uint64_t _c) : c(_c) { }
94
95    /** Default constructor for parameter classes. */
96    Cycles() : c(0) { }
97
98#ifndef SWIG // keep the operators away from SWIG
99
100    /** Converting back to the value type. */
101    operator uint64_t() const { return c; }
102
103    /** Prefix increment operator. */
104    Cycles& operator++()
105    { ++c; return *this; }
106
107    /** Prefix decrement operator. Is only temporarily used in the O3 CPU. */
108    Cycles& operator--()
109    { assert(c != 0); --c; return *this; }
110
111    /** In-place addition of cycles. */
112    const Cycles& operator+=(const Cycles& cc)
113    { c += cc.c; return *this; }
114
115    /** Greater than comparison used for > Cycles(0). */
116    bool operator>(const Cycles& cc) const
117    { return c > cc.c; }
118
119    const Cycles operator +(const Cycles& b) const
120    { return Cycles(c + b.c); }
121
122    const Cycles operator -(const Cycles& b) const
123    { assert(c >= b.c); return Cycles(c - b.c); }
124
125    const Cycles operator <<(const int32_t shift)
126    { return Cycles(c << shift); }
127
128    const Cycles operator >>(const int32_t shift)
129    { return Cycles(c >> shift); }
130
131    friend std::ostream& operator<<(std::ostream &out, const Cycles & cycles);
132
133#endif // SWIG not touching operators
134
135};
136
137/**
138 * Address type
139 * This will probably be moved somewhere else in the near future.
140 * This should be at least as big as the biggest address width in use
141 * in the system, which will probably be 64 bits.
142 */
143typedef uint64_t Addr;
144
145typedef uint16_t MicroPC;
146
147static const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1);
148
149static inline MicroPC
150romMicroPC(MicroPC upc)
151{
152    return upc | MicroPCRomBit;
153}
154
155static inline MicroPC
156normalMicroPC(MicroPC upc)
157{
158    return upc & ~MicroPCRomBit;
159}
160
161static inline bool
162isRomMicroPC(MicroPC upc)
163{
164    return MicroPCRomBit & upc;
165}
166
167const Addr MaxAddr = (Addr)-1;
168
169/**
170 * Thread index/ID type
171 */
172typedef int16_t ThreadID;
173const ThreadID InvalidThreadID = (ThreadID)-1;
174
175/**
176 * Port index/ID type, and a symbolic name for an invalid port id.
177 */
178typedef int16_t PortID;
179const PortID InvalidPortID = (PortID)-1;
180
181class FaultBase;
182typedef RefCountingPtr<FaultBase> Fault;
183
184#endif // __BASE_TYPES_HH__
185