1/*
2 * Copyright (c) 2011 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder. You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2001-2006 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Steve Reinhardt
41 * Nathan Binkert
42 */
43
44#ifndef __CPU_SIMPLE_THREAD_HH__
45#define __CPU_SIMPLE_THREAD_HH__
46
47#include "arch/isa.hh"
48#include "arch/isa_traits.hh"
49#include "arch/registers.hh"
50#include "arch/tlb.hh"
51#include "arch/types.hh"
52#include "base/types.hh"
53#include "config/the_isa.hh"
54#include "config/use_checker.hh"
55#include "cpu/decode.hh"
56#include "cpu/thread_context.hh"
57#include "cpu/thread_state.hh"
58#include "debug/FloatRegs.hh"
59#include "debug/IntRegs.hh"
60#include "mem/page_table.hh"
61#include "mem/request.hh"
62#include "sim/byteswap.hh"
63#include "sim/eventq.hh"
64#include "sim/process.hh"
65#include "sim/serialize.hh"
66#include "sim/system.hh"
67
68class BaseCPU;
69
70
71class FunctionProfile;
72class ProfileNode;
73
74namespace TheISA {
75 namespace Kernel {
76 class Statistics;
77 };
78};
79
80/**
81 * The SimpleThread object provides a combination of the ThreadState
82 * object and the ThreadContext interface. It implements the
83 * ThreadContext interface so that a ProxyThreadContext class can be
84 * made using SimpleThread as the template parameter (see
85 * thread_context.hh). It adds to the ThreadState object by adding all
86 * the objects needed for simple functional execution, including a
87 * simple architectural register file, and pointers to the ITB and DTB
88 * in full system mode. For CPU models that do not need more advanced
89 * ways to hold state (i.e. a separate physical register file, or
90 * separate fetch and commit PC's), this SimpleThread class provides
91 * all the necessary state for full architecture-level functional
92 * simulation. See the AtomicSimpleCPU or TimingSimpleCPU for
93 * examples.
94 */
95
96class SimpleThread : public ThreadState
97{
98 protected:
99 typedef TheISA::MachInst MachInst;
100 typedef TheISA::MiscReg MiscReg;
101 typedef TheISA::FloatReg FloatReg;
102 typedef TheISA::FloatRegBits FloatRegBits;
103 public:
104 typedef ThreadContext::Status Status;
105
106 protected:
107 union {
108 FloatReg f[TheISA::NumFloatRegs];
109 FloatRegBits i[TheISA::NumFloatRegs];
110 } floatRegs;
111 TheISA::IntReg intRegs[TheISA::NumIntRegs];
112 TheISA::ISA isa; // one "instance" of the current ISA.
113
114 TheISA::PCState _pcState;
115
116 /** Did this instruction execute or is it predicated false */
117 bool predicate;
118
119 public:
120 std::string name() const
121 {
122 return csprintf("%s.[tid:%i]", baseCpu->name(), tc->threadId());
123 }
124
125 ProxyThreadContext<SimpleThread> *tc;
126
127 System *system;
128
129 TheISA::TLB *itb;
130 TheISA::TLB *dtb;
131
132 Decoder decoder;
133
134 // constructor: initialize SimpleThread from given process structure
135 // FS
136 SimpleThread(BaseCPU *_cpu, int _thread_num, System *_system,
137 TheISA::TLB *_itb, TheISA::TLB *_dtb,
138 bool use_kernel_stats = true);
139 // SE
140 SimpleThread(BaseCPU *_cpu, int _thread_num, System *_system,
141 Process *_process, TheISA::TLB *_itb, TheISA::TLB *_dtb);
142
143 SimpleThread();
144
145 virtual ~SimpleThread();
146
147 virtual void takeOverFrom(ThreadContext *oldContext);
148
149 void regStats(const std::string &name);
150
151 void copyTC(ThreadContext *context);
152
153 void copyState(ThreadContext *oldContext);
154
155 void serialize(std::ostream &os);
156 void unserialize(Checkpoint *cp, const std::string &section);
157
158 /***************************************************************
159 * SimpleThread functions to provide CPU with access to various
160 * state.
161 **************************************************************/
162
163 /** Returns the pointer to this SimpleThread's ThreadContext. Used
164 * when a ThreadContext must be passed to objects outside of the
165 * CPU.
166 */
167 ThreadContext *getTC() { return tc; }
168
169 void demapPage(Addr vaddr, uint64_t asn)
170 {
171 itb->demapPage(vaddr, asn);
172 dtb->demapPage(vaddr, asn);
173 }
174
175 void demapInstPage(Addr vaddr, uint64_t asn)
176 {
177 itb->demapPage(vaddr, asn);
178 }
179
180 void demapDataPage(Addr vaddr, uint64_t asn)
181 {
182 dtb->demapPage(vaddr, asn);
183 }
184
185 void dumpFuncProfile();
186
187 Fault hwrei();
188
189 bool simPalCheck(int palFunc);
190
191 /*******************************************
192 * ThreadContext interface functions.
193 ******************************************/
194
195 BaseCPU *getCpuPtr() { return baseCpu; }
196
197 TheISA::TLB *getITBPtr() { return itb; }
198
199 TheISA::TLB *getDTBPtr() { return dtb; }
200
201#if USE_CHECKER
202 BaseCPU *getCheckerCpuPtr() { return NULL; }
203#endif
204
205 Decoder *getDecoderPtr() { return &decoder; }
206
207 System *getSystemPtr() { return system; }
208
209 Status status() const { return _status; }
210
211 void setStatus(Status newStatus) { _status = newStatus; }
212
213 /// Set the status to Active. Optional delay indicates number of
214 /// cycles to wait before beginning execution.
215 void activate(int delay = 1);
216
217 /// Set the status to Suspended.
218 void suspend();
219
220 /// Set the status to Halted.
221 void halt();
222
223 virtual bool misspeculating();
224
225 void copyArchRegs(ThreadContext *tc);
226
227 void clearArchRegs()
228 {
229 _pcState = 0;
230 memset(intRegs, 0, sizeof(intRegs));
231 memset(floatRegs.i, 0, sizeof(floatRegs.i));
232 isa.clear();
233 }
234
235 //
236 // New accessors for new decoder.
237 //
238 uint64_t readIntReg(int reg_idx)
239 {
240 int flatIndex = isa.flattenIntIndex(reg_idx);
241 assert(flatIndex < TheISA::NumIntRegs);
242 uint64_t regVal = intRegs[flatIndex];
243 DPRINTF(IntRegs, "Reading int reg %d (%d) as %#x.\n",
244 reg_idx, flatIndex, regVal);
245 return regVal;
246 }
247
248 FloatReg readFloatReg(int reg_idx)
249 {
250 int flatIndex = isa.flattenFloatIndex(reg_idx);
251 assert(flatIndex < TheISA::NumFloatRegs);
252 FloatReg regVal = floatRegs.f[flatIndex];
253 DPRINTF(FloatRegs, "Reading float reg %d (%d) as %f, %#x.\n",
254 reg_idx, flatIndex, regVal, floatRegs.i[flatIndex]);
255 return regVal;
256 }
257
258 FloatRegBits readFloatRegBits(int reg_idx)
259 {
260 int flatIndex = isa.flattenFloatIndex(reg_idx);
261 assert(flatIndex < TheISA::NumFloatRegs);
262 FloatRegBits regVal = floatRegs.i[flatIndex];
263 DPRINTF(FloatRegs, "Reading float reg %d (%d) bits as %#x, %f.\n",
264 reg_idx, flatIndex, regVal, floatRegs.f[flatIndex]);
265 return regVal;
266 }
267
268 void setIntReg(int reg_idx, uint64_t val)
269 {
270 int flatIndex = isa.flattenIntIndex(reg_idx);
271 assert(flatIndex < TheISA::NumIntRegs);
272 DPRINTF(IntRegs, "Setting int reg %d (%d) to %#x.\n",
273 reg_idx, flatIndex, val);
274 intRegs[flatIndex] = val;
275 }
276
277 void setFloatReg(int reg_idx, FloatReg val)
278 {
279 int flatIndex = isa.flattenFloatIndex(reg_idx);
280 assert(flatIndex < TheISA::NumFloatRegs);
281 floatRegs.f[flatIndex] = val;
282 DPRINTF(FloatRegs, "Setting float reg %d (%d) to %f, %#x.\n",
283 reg_idx, flatIndex, val, floatRegs.i[flatIndex]);
284 }
285
286 void setFloatRegBits(int reg_idx, FloatRegBits val)
287 {
288 int flatIndex = isa.flattenFloatIndex(reg_idx);
289 assert(flatIndex < TheISA::NumFloatRegs);
290 // XXX: Fix array out of bounds compiler error for gem5.fast
291 // when checkercpu enabled
292 if (flatIndex < TheISA::NumFloatRegs)
293 floatRegs.i[flatIndex] = val;
294 DPRINTF(FloatRegs, "Setting float reg %d (%d) bits to %#x, %#f.\n",
295 reg_idx, flatIndex, val, floatRegs.f[flatIndex]);
296 }
297
298 TheISA::PCState
299 pcState()
300 {
301 return _pcState;
302 }
303
304 void
305 pcState(const TheISA::PCState &val)
306 {
307 _pcState = val;
308 }
309
310#if USE_CHECKER
311 void
312 pcStateNoRecord(const TheISA::PCState &val)
313 {
314 _pcState = val;
315 }
316#endif
317
318 Addr
319 instAddr()
320 {
321 return _pcState.instAddr();
322 }
323
324 Addr
325 nextInstAddr()
326 {
327 return _pcState.nextInstAddr();
328 }
329
330 MicroPC
331 microPC()
332 {
333 return _pcState.microPC();
334 }
335
336 bool readPredicate()
337 {
338 return predicate;
339 }
340
341 void setPredicate(bool val)
342 {
343 predicate = val;
344 }
345
346 MiscReg
347 readMiscRegNoEffect(int misc_reg, ThreadID tid = 0)
348 {
349 return isa.readMiscRegNoEffect(misc_reg);
350 }
351
352 MiscReg
353 readMiscReg(int misc_reg, ThreadID tid = 0)
354 {
355 return isa.readMiscReg(misc_reg, tc);
356 }
357
358 void
359 setMiscRegNoEffect(int misc_reg, const MiscReg &val, ThreadID tid = 0)
360 {
361 return isa.setMiscRegNoEffect(misc_reg, val);
362 }
363
364 void
365 setMiscReg(int misc_reg, const MiscReg &val, ThreadID tid = 0)
366 {
367 return isa.setMiscReg(misc_reg, val, tc);
368 }
369
370 int
371 flattenIntIndex(int reg)
372 {
373 return isa.flattenIntIndex(reg);
374 }
375
376 int
377 flattenFloatIndex(int reg)
378 {
379 return isa.flattenFloatIndex(reg);
380 }
381
382 unsigned readStCondFailures() { return storeCondFailures; }
383
384 void setStCondFailures(unsigned sc_failures)
385 { storeCondFailures = sc_failures; }
386
387 void syscall(int64_t callnum)
388 {
389 process->syscall(callnum, tc);
390 }
391};
392
393
394// for non-speculative execution context, spec_mode is always false
395inline bool
396SimpleThread::misspeculating()
397{
398 return false;
399}
400
401#endif // __CPU_CPU_EXEC_CONTEXT_HH__