Change ExecContext to ThreadContext. This is being renamed to differentiate between...
[gem5.git] / src / arch / mips / isa_traits.hh
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: Gabe Black
29 * Korey Sewell
30 */
31
32 #ifndef __ARCH_MIPS_ISA_TRAITS_HH__
33 #define __ARCH_MIPS_ISA_TRAITS_HH__
34
35 #include "arch/mips/constants.hh"
36 #include "arch/mips/types.hh"
37 #include "arch/mips/regfile/regfile.hh"
38 #include "arch/mips/faults.hh"
39 #include "arch/mips/utility.hh"
40 #include "base/misc.hh"
41 #include "config/full_system.hh"
42 #include "sim/byteswap.hh"
43 #include "sim/host.hh"
44 #include "sim/faults.hh"
45
46 #include <vector>
47
48 class FastCPU;
49 class FullCPU;
50 class Checkpoint;
51 class ThreadContext;
52
53 namespace LittleEndianGuest {};
54
55 #define TARGET_MIPS
56
57 class StaticInst;
58 class StaticInstPtr;
59
60 namespace MIPS34K {
61 int DTB_ASN_ASN(uint64_t reg);
62 int ITB_ASN_ASN(uint64_t reg);
63 };
64
65 #if !FULL_SYSTEM
66 class SyscallReturn {
67 public:
68 template <class T>
69 SyscallReturn(T v, bool s)
70 {
71 retval = (uint32_t)v;
72 success = s;
73 }
74
75 template <class T>
76 SyscallReturn(T v)
77 {
78 success = (v >= 0);
79 retval = (uint32_t)v;
80 }
81
82 ~SyscallReturn() {}
83
84 SyscallReturn& operator=(const SyscallReturn& s) {
85 retval = s.retval;
86 success = s.success;
87 return *this;
88 }
89
90 bool successful() { return success; }
91 uint64_t value() { return retval; }
92
93
94 private:
95 uint64_t retval;
96 bool success;
97 };
98 #endif
99
100 namespace MipsISA
101 {
102 using namespace LittleEndianGuest;
103
104 static inline void setSyscallReturn(SyscallReturn return_value, RegFile *regs)
105 {
106 if (return_value.successful()) {
107 // no error
108 regs->setIntReg(SyscallSuccessReg, 0);
109 regs->setIntReg(ReturnValueReg1, return_value.value());
110 } else {
111 // got an error, return details
112 regs->setIntReg(SyscallSuccessReg, (IntReg) -1);
113 regs->setIntReg(ReturnValueReg1, -return_value.value());
114 }
115 }
116
117 StaticInstPtr decodeInst(ExtMachInst);
118
119 static inline ExtMachInst
120 makeExtMI(MachInst inst, const uint64_t &pc) {
121 #if FULL_SYSTEM
122 ExtMachInst ext_inst = inst;
123 if (pc && 0x1)
124 return ext_inst|=(static_cast<ExtMachInst>(pc & 0x1) << 32);
125 else
126 return ext_inst;
127 #else
128 return ExtMachInst(inst);
129 #endif
130 }
131
132 /**
133 * Function to insure ISA semantics about 0 registers.
134 * @param tc The thread context.
135 */
136 template <class TC>
137 void zeroRegisters(TC *tc);
138
139 const Addr MaxAddr = (Addr)-1;
140
141 void copyRegs(ThreadContext *src, ThreadContext *dest);
142
143 uint64_t fpConvert(double fp_val, ConvertType cvt_type);
144 double roundFP(double val, int digits);
145 double truncFP(double val);
146 bool getFPConditionCode(uint32_t fcsr_reg, int cc);
147 uint32_t makeCCVector(uint32_t fcsr, int num, bool val);
148
149 // Machine operations
150
151 void saveMachineReg(AnyReg &savereg, const RegFile &reg_file,
152 int regnum);
153
154 void restoreMachineReg(RegFile &regs, const AnyReg &reg,
155 int regnum);
156
157 #if 0
158 static void serializeSpecialRegs(const Serializable::Proxy &proxy,
159 const RegFile &regs);
160
161 static void unserializeSpecialRegs(const IniFile *db,
162 const std::string &category,
163 ConfigNode *node,
164 RegFile &regs);
165 #endif
166
167 static inline Addr alignAddress(const Addr &addr,
168 unsigned int nbytes) {
169 return (addr & ~(nbytes - 1));
170 }
171
172 // Instruction address compression hooks
173 static inline Addr realPCToFetchPC(const Addr &addr) {
174 return addr;
175 }
176
177 static inline Addr fetchPCToRealPC(const Addr &addr) {
178 return addr;
179 }
180
181 // the size of "fetched" instructions (not necessarily the size
182 // of real instructions for PISA)
183 static inline size_t fetchInstSize() {
184 return sizeof(MachInst);
185 }
186
187 static inline MachInst makeRegisterCopy(int dest, int src) {
188 panic("makeRegisterCopy not implemented");
189 return 0;
190 }
191
192 };
193
194 #if FULL_SYSTEM
195
196 #include "arch/mips/mips34k.hh"
197
198 #endif
199
200 using namespace MipsISA;
201
202 #endif // __ARCH_MIPS_ISA_TRAITS_HH__