2 * Copyright (c) 2006 The Regents of The University of Michigan
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.
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.
31 #ifndef __CPU_THREAD_CONTEXT_HH__
32 #define __CPU_THREAD_CONTEXT_HH__
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"
44 // @todo: Figure out a more architecture independent way to obtain the ITB and
52 class EndQuiesceEvent;
54 class TranslatingPort;
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.
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.
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;
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.
100 /// Running. Instructions should be executed only when
101 /// the context is in this state.
104 /// Temporarily inactive. Entered while waiting for
105 /// synchronization, etc.
108 /// Permanently shut down. Entered when target executes
109 /// m5exit pseudo-instruction. When all contexts enter
110 /// this state, the simulation will terminate.
114 virtual ~ThreadContext() { };
116 virtual BaseCPU *getCpuPtr() = 0;
118 virtual int cpuId() = 0;
120 virtual TheISA::ITB *getITBPtr() = 0;
122 virtual TheISA::DTB *getDTBPtr() = 0;
125 virtual System *getSystemPtr() = 0;
127 virtual TheISA::Kernel::Statistics *getKernelStats() = 0;
129 virtual FunctionalPort *getPhysPort() = 0;
131 virtual VirtualPort *getVirtPort() = 0;
133 virtual void connectMemPorts(ThreadContext *tc) = 0;
135 virtual TranslatingPort *getMemPort() = 0;
137 virtual Process *getProcessPtr() = 0;
140 virtual Status status() const = 0;
142 virtual void setStatus(Status new_status) = 0;
144 /// Set the status to Active. Optional delay indicates number of
145 /// cycles to wait before beginning execution.
146 virtual void activate(int delay = 1) = 0;
148 /// Set the status to Suspended.
149 virtual void suspend(int delay = 0) = 0;
151 /// Set the status to Unallocated.
152 virtual void deallocate(int delay = 0) = 0;
154 /// Set the status to Halted.
155 virtual void halt(int delay = 0) = 0;
158 virtual void dumpFuncProfile() = 0;
161 virtual void takeOverFrom(ThreadContext *old_context) = 0;
163 virtual void regStats(const std::string &name) = 0;
165 virtual void serialize(std::ostream &os) = 0;
166 virtual void unserialize(Checkpoint *cp, const std::string §ion) = 0;
169 virtual EndQuiesceEvent *getQuiesceEvent() = 0;
171 // Not necessarily the best location for these...
172 // Having an extra function just to read these is obnoxious
173 virtual Tick readLastActivate() = 0;
174 virtual Tick readLastSuspend() = 0;
176 virtual void profileClear() = 0;
177 virtual void profileSample() = 0;
180 virtual int getThreadNum() = 0;
182 // Also somewhat obnoxious. Really only used for the TLB fault.
183 // However, may be quite useful in SPARC.
184 virtual TheISA::MachInst getInst() = 0;
186 virtual void copyArchRegs(ThreadContext *tc) = 0;
188 virtual void clearArchRegs() = 0;
191 // New accessors for new decoder.
193 virtual uint64_t readIntReg(int reg_idx) = 0;
195 virtual FloatReg readFloatReg(int reg_idx, int width) = 0;
197 virtual FloatReg readFloatReg(int reg_idx) = 0;
199 virtual FloatRegBits readFloatRegBits(int reg_idx, int width) = 0;
201 virtual FloatRegBits readFloatRegBits(int reg_idx) = 0;
203 virtual void setIntReg(int reg_idx, uint64_t val) = 0;
205 virtual void setFloatReg(int reg_idx, FloatReg val, int width) = 0;
207 virtual void setFloatReg(int reg_idx, FloatReg val) = 0;
209 virtual void setFloatRegBits(int reg_idx, FloatRegBits val) = 0;
211 virtual void setFloatRegBits(int reg_idx, FloatRegBits val, int width) = 0;
213 virtual uint64_t readPC() = 0;
215 virtual void setPC(uint64_t val) = 0;
217 virtual uint64_t readNextPC() = 0;
219 virtual void setNextPC(uint64_t val) = 0;
221 virtual uint64_t readNextNPC() = 0;
223 virtual void setNextNPC(uint64_t val) = 0;
225 virtual uint64_t readMicroPC() = 0;
227 virtual void setMicroPC(uint64_t val) = 0;
229 virtual uint64_t readNextMicroPC() = 0;
231 virtual void setNextMicroPC(uint64_t val) = 0;
233 virtual MiscReg readMiscRegNoEffect(int misc_reg) = 0;
235 virtual MiscReg readMiscReg(int misc_reg) = 0;
237 virtual void setMiscRegNoEffect(int misc_reg, const MiscReg &val) = 0;
239 virtual void setMiscReg(int misc_reg, const MiscReg &val) = 0;
241 virtual uint64_t readRegOtherThread(int misc_reg, unsigned tid) { return 0; }
243 virtual void setRegOtherThread(int misc_reg, const MiscReg &val, unsigned tid) { };
245 // Also not necessarily the best location for these two. Hopefully will go
246 // away once we decide upon where st cond failures goes.
247 virtual unsigned readStCondFailures() = 0;
249 virtual void setStCondFailures(unsigned sc_failures) = 0;
251 // Only really makes sense for old CPU model. Still could be useful though.
252 virtual bool misspeculating() = 0;
255 virtual IntReg getSyscallArg(int i) = 0;
257 // used to shift args for indirect syscall
258 virtual void setSyscallArg(int i, IntReg val) = 0;
260 virtual void setSyscallReturn(SyscallReturn return_value) = 0;
262 // Same with st cond failures.
263 virtual Counter readFuncExeInst() = 0;
265 virtual void syscall(int64_t callnum) = 0;
267 // This function exits the thread context in the CPU and returns
268 // 1 if the CPU has no more active threads (meaning it's OK to exit);
269 // Used in syscall-emulation mode when a thread calls the exit syscall.
270 virtual int exit() { return 1; };
273 /** function to compare two thread contexts (for debugging) */
274 static void compare(ThreadContext *one, ThreadContext *two);
278 * ProxyThreadContext class that provides a way to implement a
279 * ThreadContext without having to derive from it. ThreadContext is an
280 * abstract class, so anything that derives from it and uses its
281 * interface will pay the overhead of virtual function calls. This
282 * class is created to enable a user-defined Thread object to be used
283 * wherever ThreadContexts are used, without paying the overhead of
284 * virtual function calls when it is used by itself. See
285 * simple_thread.hh for an example of this.
288 class ProxyThreadContext : public ThreadContext
291 ProxyThreadContext(TC *actual_tc)
292 { actualTC = actual_tc; }
299 BaseCPU *getCpuPtr() { return actualTC->getCpuPtr(); }
301 int cpuId() { return actualTC->cpuId(); }
303 TheISA::ITB *getITBPtr() { return actualTC->getITBPtr(); }
305 TheISA::DTB *getDTBPtr() { return actualTC->getDTBPtr(); }
308 System *getSystemPtr() { return actualTC->getSystemPtr(); }
310 TheISA::Kernel::Statistics *getKernelStats()
311 { return actualTC->getKernelStats(); }
313 FunctionalPort *getPhysPort() { return actualTC->getPhysPort(); }
315 VirtualPort *getVirtPort() { return actualTC->getVirtPort(); }
317 void connectMemPorts(ThreadContext *tc) { actualTC->connectMemPorts(tc); }
319 TranslatingPort *getMemPort() { return actualTC->getMemPort(); }
321 Process *getProcessPtr() { return actualTC->getProcessPtr(); }
324 Status status() const { return actualTC->status(); }
326 void setStatus(Status new_status) { actualTC->setStatus(new_status); }
328 /// Set the status to Active. Optional delay indicates number of
329 /// cycles to wait before beginning execution.
330 void activate(int delay = 1) { actualTC->activate(delay); }
332 /// Set the status to Suspended.
333 void suspend(int delay = 0) { actualTC->suspend(); }
335 /// Set the status to Unallocated.
336 void deallocate(int delay = 0) { actualTC->deallocate(); }
338 /// Set the status to Halted.
339 void halt(int delay = 0) { actualTC->halt(); }
342 void dumpFuncProfile() { actualTC->dumpFuncProfile(); }
345 void takeOverFrom(ThreadContext *oldContext)
346 { actualTC->takeOverFrom(oldContext); }
348 void regStats(const std::string &name) { actualTC->regStats(name); }
350 void serialize(std::ostream &os) { actualTC->serialize(os); }
351 void unserialize(Checkpoint *cp, const std::string §ion)
352 { actualTC->unserialize(cp, section); }
355 EndQuiesceEvent *getQuiesceEvent() { return actualTC->getQuiesceEvent(); }
357 Tick readLastActivate() { return actualTC->readLastActivate(); }
358 Tick readLastSuspend() { return actualTC->readLastSuspend(); }
360 void profileClear() { return actualTC->profileClear(); }
361 void profileSample() { return actualTC->profileSample(); }
364 int getThreadNum() { return actualTC->getThreadNum(); }
366 // @todo: Do I need this?
367 MachInst getInst() { return actualTC->getInst(); }
369 // @todo: Do I need this?
370 void copyArchRegs(ThreadContext *tc) { actualTC->copyArchRegs(tc); }
372 void clearArchRegs() { actualTC->clearArchRegs(); }
375 // New accessors for new decoder.
377 uint64_t readIntReg(int reg_idx)
378 { return actualTC->readIntReg(reg_idx); }
380 FloatReg readFloatReg(int reg_idx, int width)
381 { return actualTC->readFloatReg(reg_idx, width); }
383 FloatReg readFloatReg(int reg_idx)
384 { return actualTC->readFloatReg(reg_idx); }
386 FloatRegBits readFloatRegBits(int reg_idx, int width)
387 { return actualTC->readFloatRegBits(reg_idx, width); }
389 FloatRegBits readFloatRegBits(int reg_idx)
390 { return actualTC->readFloatRegBits(reg_idx); }
392 void setIntReg(int reg_idx, uint64_t val)
393 { actualTC->setIntReg(reg_idx, val); }
395 void setFloatReg(int reg_idx, FloatReg val, int width)
396 { actualTC->setFloatReg(reg_idx, val, width); }
398 void setFloatReg(int reg_idx, FloatReg val)
399 { actualTC->setFloatReg(reg_idx, val); }
401 void setFloatRegBits(int reg_idx, FloatRegBits val, int width)
402 { actualTC->setFloatRegBits(reg_idx, val, width); }
404 void setFloatRegBits(int reg_idx, FloatRegBits val)
405 { actualTC->setFloatRegBits(reg_idx, val); }
407 uint64_t readPC() { return actualTC->readPC(); }
409 void setPC(uint64_t val) { actualTC->setPC(val); }
411 uint64_t readNextPC() { return actualTC->readNextPC(); }
413 void setNextPC(uint64_t val) { actualTC->setNextPC(val); }
415 uint64_t readNextNPC() { return actualTC->readNextNPC(); }
417 void setNextNPC(uint64_t val) { actualTC->setNextNPC(val); }
419 uint64_t readMicroPC() { return actualTC->readMicroPC(); }
421 void setMicroPC(uint64_t val) { actualTC->setMicroPC(val); }
423 uint64_t readNextMicroPC() { return actualTC->readMicroPC(); }
425 void setNextMicroPC(uint64_t val) { actualTC->setNextMicroPC(val); }
427 MiscReg readMiscRegNoEffect(int misc_reg)
428 { return actualTC->readMiscRegNoEffect(misc_reg); }
430 MiscReg readMiscReg(int misc_reg)
431 { return actualTC->readMiscReg(misc_reg); }
433 void setMiscRegNoEffect(int misc_reg, const MiscReg &val)
434 { return actualTC->setMiscRegNoEffect(misc_reg, val); }
436 void setMiscReg(int misc_reg, const MiscReg &val)
437 { return actualTC->setMiscReg(misc_reg, val); }
439 unsigned readStCondFailures()
440 { return actualTC->readStCondFailures(); }
442 void setStCondFailures(unsigned sc_failures)
443 { actualTC->setStCondFailures(sc_failures); }
446 bool misspeculating() { return actualTC->misspeculating(); }
449 IntReg getSyscallArg(int i) { return actualTC->getSyscallArg(i); }
451 // used to shift args for indirect syscall
452 void setSyscallArg(int i, IntReg val)
453 { actualTC->setSyscallArg(i, val); }
455 void setSyscallReturn(SyscallReturn return_value)
456 { actualTC->setSyscallReturn(return_value); }
458 void syscall(int64_t callnum)
459 { actualTC->syscall(callnum); }
461 Counter readFuncExeInst() { return actualTC->readFuncExeInst(); }