types.hh revision 7720:65d338a8dba4 
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/** uint64_t constant */
43#define ULL(N)          ((uint64_t)N##ULL)
44/** int64_t constant */
45#define LL(N)           ((int64_t)N##LL)
46
47/** Statistics counter type.  Not much excuse for not using a 64-bit
48 * integer here, but if you're desperate and only run short
49 * simulations you could make this 32 bits.
50 */
51typedef int64_t Counter;
52
53/**
54 * Clock cycle count type.
55 * @note using an unsigned breaks the cache.
56 */
57typedef int64_t Tick;
58typedef uint64_t UTick;
59
60const Tick MaxTick = LL(0x7fffffffffffffff);
61
62/**
63 * Address type
64 * This will probably be moved somewhere else in the near future.
65 * This should be at least as big as the biggest address width in use
66 * in the system, which will probably be 64 bits.
67 */
68typedef uint64_t Addr;
69
70typedef uint16_t MicroPC;
71
72static const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1);
73
74static inline MicroPC
75romMicroPC(MicroPC upc)
76{
77    return upc | MicroPCRomBit;
78}
79
80static inline MicroPC
81normalMicroPC(MicroPC upc)
82{
83    return upc & ~MicroPCRomBit;
84}
85
86static inline bool
87isRomMicroPC(MicroPC upc)
88{
89    return MicroPCRomBit & upc;
90}
91
92const Addr MaxAddr = (Addr)-1;
93
94/**
95 * Thread index/ID type
96 */
97typedef int16_t ThreadID;
98const ThreadID InvalidThreadID = (ThreadID)-1;
99
100class FaultBase;
101template <class T> class RefCountingPtr;
102typedef RefCountingPtr<FaultBase> Fault;
103
104#endif // __BASE_TYPES_HH__
105