1/*
2 * Copyright (c) 2006 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: Kevin Lim
29 */
30
31#ifndef __CPU_THREAD_CONTEXT_HH__
32#define __CPU_THREAD_CONTEXT_HH__
33
34#include "arch/regfile.hh"
35#include "arch/types.hh"
36#include "config/full_system.hh"
37#include "mem/request.hh"
38#include "sim/faults.hh"
39#include "sim/host.hh"
40#include "sim/serialize.hh"
41#include "sim/syscallreturn.hh"
42#include "sim/byteswap.hh"
43
44// @todo: Figure out a more architecture independent way to obtain the ITB and
45// DTB pointers.
46namespace TheISA
47{
48 class DTB;
49 class ITB;
50}
51class BaseCPU;
52class EndQuiesceEvent;
53class Event;
54class TranslatingPort;
55class FunctionalPort;
56class VirtualPort;
57class Process;
58class System;
59namespace TheISA {
60 namespace Kernel {
61 class Statistics;
62 };
63};
64
65/**
66 * ThreadContext is the external interface to all thread state for
67 * anything outside of the CPU. It provides all accessor methods to
68 * state that might be needed by external objects, ranging from
69 * register values to things such as kernel stats. It is an abstract
70 * base class; the CPU can create its own ThreadContext by either
71 * deriving from it, or using the templated ProxyThreadContext.
72 *
73 * The ThreadContext is slightly different than the ExecContext. The
74 * ThreadContext provides access to an individual thread's state; an
75 * ExecContext provides ISA access to the CPU (meaning it is
76 * implicitly multithreaded on SMT systems). Additionally the
77 * ThreadState is an abstract class that exactly defines the
78 * interface; the ExecContext is a more implicit interface that must
79 * be implemented so that the ISA can access whatever state it needs.
80 */
81class ThreadContext
82{
83 protected:
84 typedef TheISA::RegFile RegFile;
85 typedef TheISA::MachInst MachInst;
86 typedef TheISA::IntReg IntReg;
87 typedef TheISA::FloatReg FloatReg;
88 typedef TheISA::FloatRegBits FloatRegBits;
89 typedef TheISA::MiscRegFile MiscRegFile;
90 typedef TheISA::MiscReg MiscReg;
91 public:
92 enum Status
93 {
94 /// Initialized but not running yet. All CPUs start in
95 /// this state, but most transition to Active on cycle 1.
96 /// In MP or SMT systems, non-primary contexts will stay
97 /// in this state until a thread is assigned to them.
98 Unallocated,
99
100 /// Running. Instructions should be executed only when
101 /// the context is in this state.
102 Active,
103
104 /// Temporarily inactive. Entered while waiting for
105 /// synchronization, etc.
106 Suspended,
107
108 /// Permanently shut down. Entered when target executes
109 /// m5exit pseudo-instruction. When all contexts enter
110 /// this state, the simulation will terminate.
111 Halted
112 };
113
114 virtual ~ThreadContext() { };
115
116 virtual BaseCPU *getCpuPtr() = 0;
117
118 virtual void setCpuId(int id) = 0;
119
120 virtual int readCpuId() = 0;
121
122 virtual TheISA::ITB *getITBPtr() = 0;
123
124 virtual TheISA::DTB *getDTBPtr() = 0;
125
126#if FULL_SYSTEM
127 virtual System *getSystemPtr() = 0;
128
129 virtual TheISA::Kernel::Statistics *getKernelStats() = 0;
130
131 virtual FunctionalPort *getPhysPort() = 0;
132
133 virtual VirtualPort *getVirtPort() = 0;
134
135 virtual void connectMemPorts(ThreadContext *tc) = 0;
136#else
137 virtual TranslatingPort *getMemPort() = 0;
138
139 virtual Process *getProcessPtr() = 0;
140#endif
141
142 virtual Status status() const = 0;
143
144 virtual void setStatus(Status new_status) = 0;
145
146 /// Set the status to Active. Optional delay indicates number of
147 /// cycles to wait before beginning execution.
148 virtual void activate(int delay = 1) = 0;
149
150 /// Set the status to Suspended.
151 virtual void suspend(int delay = 0) = 0;
152
153 /// Set the status to Unallocated.
154 virtual void deallocate(int delay = 0) = 0;
155
156 /// Set the status to Halted.
157 virtual void halt(int delay = 0) = 0;
158
159#if FULL_SYSTEM
160 virtual void dumpFuncProfile() = 0;
161#endif
162
163 virtual void takeOverFrom(ThreadContext *old_context) = 0;
164
165 virtual void regStats(const std::string &name) = 0;
166
167 virtual void serialize(std::ostream &os) = 0;
168 virtual void unserialize(Checkpoint *cp, const std::string &section) = 0;
169
170#if FULL_SYSTEM
171 virtual EndQuiesceEvent *getQuiesceEvent() = 0;
172
173 // Not necessarily the best location for these...
174 // Having an extra function just to read these is obnoxious
175 virtual Tick readLastActivate() = 0;
176 virtual Tick readLastSuspend() = 0;
177
178 virtual void profileClear() = 0;
179 virtual void profileSample() = 0;
180#endif
181
182 virtual int getThreadNum() = 0;
183
184 // Also somewhat obnoxious. Really only used for the TLB fault.
185 // However, may be quite useful in SPARC.
186 virtual TheISA::MachInst getInst() = 0;
187
188 virtual void copyArchRegs(ThreadContext *tc) = 0;
189
190 virtual void clearArchRegs() = 0;
191
192 //
193 // New accessors for new decoder.
194 //
195 virtual uint64_t readIntReg(int reg_idx) = 0;
196
197 virtual FloatReg readFloatReg(int reg_idx, int width) = 0;
198
199 virtual FloatReg readFloatReg(int reg_idx) = 0;
200
201 virtual FloatRegBits readFloatRegBits(int reg_idx, int width) = 0;
202
203 virtual FloatRegBits readFloatRegBits(int reg_idx) = 0;
204
205 virtual void setIntReg(int reg_idx, uint64_t val) = 0;
206
207 virtual void setFloatReg(int reg_idx, FloatReg val, int width) = 0;
208
209 virtual void setFloatReg(int reg_idx, FloatReg val) = 0;
210
211 virtual void setFloatRegBits(int reg_idx, FloatRegBits val) = 0;
212
213 virtual void setFloatRegBits(int reg_idx, FloatRegBits val, int width) = 0;
214
215 virtual uint64_t readPC() = 0;
216
217 virtual void setPC(uint64_t val) = 0;
218
219 virtual uint64_t readNextPC() = 0;
220
221 virtual void setNextPC(uint64_t val) = 0;
222
223 virtual uint64_t readNextNPC() = 0;
224
225 virtual void setNextNPC(uint64_t val) = 0;
226
227 virtual uint64_t readMicroPC() = 0;
228
229 virtual void setMicroPC(uint64_t val) = 0;
230
231 virtual uint64_t readNextMicroPC() = 0;
232
233 virtual void setNextMicroPC(uint64_t val) = 0;
234
235 virtual MiscReg readMiscRegNoEffect(int misc_reg) = 0;
236
237 virtual MiscReg readMiscReg(int misc_reg) = 0;
238
239 virtual void setMiscRegNoEffect(int misc_reg, const MiscReg &val) = 0;
240
241 virtual void setMiscReg(int misc_reg, const MiscReg &val) = 0;
242
243 virtual uint64_t readRegOtherThread(int misc_reg, unsigned tid) { return 0; }
244
245 virtual void setRegOtherThread(int misc_reg, const MiscReg &val, unsigned tid) { };
246
247 // Also not necessarily the best location for these two. Hopefully will go
248 // away once we decide upon where st cond failures goes.
249 virtual unsigned readStCondFailures() = 0;
250
251 virtual void setStCondFailures(unsigned sc_failures) = 0;
252
253 // Only really makes sense for old CPU model. Still could be useful though.
254 virtual bool misspeculating() = 0;
255
256#if !FULL_SYSTEM
257 virtual IntReg getSyscallArg(int i) = 0;
258
259 // used to shift args for indirect syscall
260 virtual void setSyscallArg(int i, IntReg val) = 0;
261
262 virtual void setSyscallReturn(SyscallReturn return_value) = 0;
263
264 // Same with st cond failures.
265 virtual Counter readFuncExeInst() = 0;
266
267 virtual void syscall(int64_t callnum) = 0;
268
269 // This function exits the thread context in the CPU and returns
270 // 1 if the CPU has no more active threads (meaning it's OK to exit);
271 // Used in syscall-emulation mode when a thread calls the exit syscall.
272 virtual int exit() { return 1; };
273#endif
274
275 /** function to compare two thread contexts (for debugging) */
276 static void compare(ThreadContext *one, ThreadContext *two);
277};
278
279/**
280 * ProxyThreadContext class that provides a way to implement a
281 * ThreadContext without having to derive from it. ThreadContext is an
282 * abstract class, so anything that derives from it and uses its
283 * interface will pay the overhead of virtual function calls. This
284 * class is created to enable a user-defined Thread object to be used
285 * wherever ThreadContexts are used, without paying the overhead of
286 * virtual function calls when it is used by itself. See
287 * simple_thread.hh for an example of this.
288 */
289template <class TC>
290class ProxyThreadContext : public ThreadContext
291{
292 public:
293 ProxyThreadContext(TC *actual_tc)
294 { actualTC = actual_tc; }
295
296 private:
297 TC *actualTC;
298
299 public:
300
301 BaseCPU *getCpuPtr() { return actualTC->getCpuPtr(); }
302
303 void setCpuId(int id) { actualTC->setCpuId(id); }
304
305 int readCpuId() { return actualTC->readCpuId(); }
306
307 TheISA::ITB *getITBPtr() { return actualTC->getITBPtr(); }
308
309 TheISA::DTB *getDTBPtr() { return actualTC->getDTBPtr(); }
310
311#if FULL_SYSTEM
312 System *getSystemPtr() { return actualTC->getSystemPtr(); }
313
314 TheISA::Kernel::Statistics *getKernelStats()
315 { return actualTC->getKernelStats(); }
316
317 FunctionalPort *getPhysPort() { return actualTC->getPhysPort(); }
318
319 VirtualPort *getVirtPort() { return actualTC->getVirtPort(); }
320
321 void connectMemPorts(ThreadContext *tc) { actualTC->connectMemPorts(tc); }
322#else
323 TranslatingPort *getMemPort() { return actualTC->getMemPort(); }
324
325 Process *getProcessPtr() { return actualTC->getProcessPtr(); }
326#endif
327
328 Status status() const { return actualTC->status(); }
329
330 void setStatus(Status new_status) { actualTC->setStatus(new_status); }
331
332 /// Set the status to Active. Optional delay indicates number of
333 /// cycles to wait before beginning execution.
334 void activate(int delay = 1) { actualTC->activate(delay); }
335
336 /// Set the status to Suspended.
337 void suspend(int delay = 0) { actualTC->suspend(); }
338
339 /// Set the status to Unallocated.
340 void deallocate(int delay = 0) { actualTC->deallocate(); }
341
342 /// Set the status to Halted.
343 void halt(int delay = 0) { actualTC->halt(); }
344
345#if FULL_SYSTEM
346 void dumpFuncProfile() { actualTC->dumpFuncProfile(); }
347#endif
348
349 void takeOverFrom(ThreadContext *oldContext)
350 { actualTC->takeOverFrom(oldContext); }
351
352 void regStats(const std::string &name) { actualTC->regStats(name); }
353
354 void serialize(std::ostream &os) { actualTC->serialize(os); }
355 void unserialize(Checkpoint *cp, const std::string &section)
356 { actualTC->unserialize(cp, section); }
357
358#if FULL_SYSTEM
359 EndQuiesceEvent *getQuiesceEvent() { return actualTC->getQuiesceEvent(); }
360
361 Tick readLastActivate() { return actualTC->readLastActivate(); }
362 Tick readLastSuspend() { return actualTC->readLastSuspend(); }
363
364 void profileClear() { return actualTC->profileClear(); }
365 void profileSample() { return actualTC->profileSample(); }
366#endif
367
368 int getThreadNum() { return actualTC->getThreadNum(); }
369
370 // @todo: Do I need this?
371 MachInst getInst() { return actualTC->getInst(); }
372
373 // @todo: Do I need this?
374 void copyArchRegs(ThreadContext *tc) { actualTC->copyArchRegs(tc); }
375
376 void clearArchRegs() { actualTC->clearArchRegs(); }
377
378 //
379 // New accessors for new decoder.
380 //
381 uint64_t readIntReg(int reg_idx)
382 { return actualTC->readIntReg(reg_idx); }
383
384 FloatReg readFloatReg(int reg_idx, int width)
385 { return actualTC->readFloatReg(reg_idx, width); }
386
387 FloatReg readFloatReg(int reg_idx)
388 { return actualTC->readFloatReg(reg_idx); }
389
390 FloatRegBits readFloatRegBits(int reg_idx, int width)
391 { return actualTC->readFloatRegBits(reg_idx, width); }
392
393 FloatRegBits readFloatRegBits(int reg_idx)
394 { return actualTC->readFloatRegBits(reg_idx); }
395
396 void setIntReg(int reg_idx, uint64_t val)
397 { actualTC->setIntReg(reg_idx, val); }
398
399 void setFloatReg(int reg_idx, FloatReg val, int width)
400 { actualTC->setFloatReg(reg_idx, val, width); }
401
402 void setFloatReg(int reg_idx, FloatReg val)
403 { actualTC->setFloatReg(reg_idx, val); }
404
405 void setFloatRegBits(int reg_idx, FloatRegBits val, int width)
406 { actualTC->setFloatRegBits(reg_idx, val, width); }
407
408 void setFloatRegBits(int reg_idx, FloatRegBits val)
409 { actualTC->setFloatRegBits(reg_idx, val); }
410
411 uint64_t readPC() { return actualTC->readPC(); }
412
413 void setPC(uint64_t val) { actualTC->setPC(val); }
414
415 uint64_t readNextPC() { return actualTC->readNextPC(); }
416
417 void setNextPC(uint64_t val) { actualTC->setNextPC(val); }
418
419 uint64_t readNextNPC() { return actualTC->readNextNPC(); }
420
421 void setNextNPC(uint64_t val) { actualTC->setNextNPC(val); }
422
423 uint64_t readMicroPC() { return actualTC->readMicroPC(); }
424
425 void setMicroPC(uint64_t val) { actualTC->setMicroPC(val); }
426
427 uint64_t readNextMicroPC() { return actualTC->readMicroPC(); }
428
429 void setNextMicroPC(uint64_t val) { actualTC->setNextMicroPC(val); }
430
431 MiscReg readMiscRegNoEffect(int misc_reg)
432 { return actualTC->readMiscRegNoEffect(misc_reg); }
433
434 MiscReg readMiscReg(int misc_reg)
435 { return actualTC->readMiscReg(misc_reg); }
436
437 void setMiscRegNoEffect(int misc_reg, const MiscReg &val)
438 { return actualTC->setMiscRegNoEffect(misc_reg, val); }
439
440 void setMiscReg(int misc_reg, const MiscReg &val)
441 { return actualTC->setMiscReg(misc_reg, val); }
442
443 unsigned readStCondFailures()
444 { return actualTC->readStCondFailures(); }
445
446 void setStCondFailures(unsigned sc_failures)
447 { actualTC->setStCondFailures(sc_failures); }
448
449 // @todo: Fix this!
450 bool misspeculating() { return actualTC->misspeculating(); }
451
452#if !FULL_SYSTEM
453 IntReg getSyscallArg(int i) { return actualTC->getSyscallArg(i); }
454
455 // used to shift args for indirect syscall
456 void setSyscallArg(int i, IntReg val)
457 { actualTC->setSyscallArg(i, val); }
458
459 void setSyscallReturn(SyscallReturn return_value)
460 { actualTC->setSyscallReturn(return_value); }
461
462 void syscall(int64_t callnum)
463 { actualTC->syscall(callnum); }
464
465 Counter readFuncExeInst() { return actualTC->readFuncExeInst(); }
466#endif
467};
468
469#endif