types.hh revision 9158:d152d34a4adf 
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 * Tick count type.
55 */
56typedef uint64_t Tick;
57
58const Tick MaxTick = ULL(0xffffffffffffffff);
59
60/**
61 * Address type
62 * This will probably be moved somewhere else in the near future.
63 * This should be at least as big as the biggest address width in use
64 * in the system, which will probably be 64 bits.
65 */
66typedef uint64_t Addr;
67
68typedef uint16_t MicroPC;
69
70static const MicroPC MicroPCRomBit = 1 << (sizeof(MicroPC) * 8 - 1);
71
72static inline MicroPC
73romMicroPC(MicroPC upc)
74{
75    return upc | MicroPCRomBit;
76}
77
78static inline MicroPC
79normalMicroPC(MicroPC upc)
80{
81    return upc & ~MicroPCRomBit;
82}
83
84static inline bool
85isRomMicroPC(MicroPC upc)
86{
87    return MicroPCRomBit & upc;
88}
89
90const Addr MaxAddr = (Addr)-1;
91
92/**
93 * Thread index/ID type
94 */
95typedef int16_t ThreadID;
96const ThreadID InvalidThreadID = (ThreadID)-1;
97
98/**
99 * Port index/ID type, and a symbolic name for an invalid port id.
100 */
101typedef int16_t PortID;
102const PortID InvalidPortID = (PortID)-1;
103
104class FaultBase;
105template <class T> class RefCountingPtr;
106typedef RefCountingPtr<FaultBase> Fault;
107
108#endif // __BASE_TYPES_HH__
109