2 * Copyright (c) 2011-2012 ARM Limited
3 * Copyright (c) 2013 Advanced Micro Devices, Inc.
6 * The license below extends only to copyright in the software and shall
7 * not be construed as granting a license to any other intellectual
8 * property including but not limited to intellectual property relating
9 * to a hardware implementation of the functionality of the software
10 * licensed hereunder. You may use the software subject to the license
11 * terms below provided that you ensure that this notice is replicated
12 * unmodified and in its entirety in all distributions of the software,
13 * modified or unmodified, in source code or in binary form.
15 * Copyright (c) 2006 The Regents of The University of Michigan
16 * All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44 #ifndef __CPU_CHECKER_THREAD_CONTEXT_HH__
45 #define __CPU_CHECKER_THREAD_CONTEXT_HH__
47 #include "arch/types.hh"
48 #include "config/the_isa.hh"
49 #include "cpu/checker/cpu.hh"
50 #include "cpu/simple_thread.hh"
51 #include "cpu/thread_context.hh"
52 #include "debug/Checker.hh"
54 class EndQuiesceEvent;
63 * Derived ThreadContext class for use with the Checker. The template
64 * parameter is the ThreadContext class used by the specific CPU being
65 * verified. This CheckerThreadContext is then used by the main CPU
66 * in place of its usual ThreadContext class. It handles updating the
67 * checker's state any time state is updated externally through the
71 class CheckerThreadContext : public ThreadContext
74 CheckerThreadContext(TC *actual_tc,
75 CheckerCPU *checker_cpu)
76 : actualTC(actual_tc), checkerTC(checker_cpu->thread),
77 checkerCPU(checker_cpu)
81 /** The main CPU's ThreadContext, or class that implements the
82 * ThreadContext interface. */
84 /** The checker's own SimpleThread. Will be updated any time
85 * anything uses this ThreadContext to externally update a
87 SimpleThread *checkerTC;
88 /** Pointer to the checker CPU. */
89 CheckerCPU *checkerCPU;
93 BaseCPU *getCpuPtr() { return actualTC->getCpuPtr(); }
95 uint32_t socketId() const { return actualTC->socketId(); }
97 int cpuId() const { return actualTC->cpuId(); }
99 int contextId() const { return actualTC->contextId(); }
101 void setContextId(int id)
103 actualTC->setContextId(id);
104 checkerTC->setContextId(id);
107 /** Returns this thread's ID number. */
108 int threadId() const { return actualTC->threadId(); }
109 void setThreadId(int id)
111 checkerTC->setThreadId(id);
112 actualTC->setThreadId(id);
115 TheISA::TLB *getITBPtr() { return actualTC->getITBPtr(); }
117 TheISA::TLB *getDTBPtr() { return actualTC->getDTBPtr(); }
119 CheckerCPU *getCheckerCpuPtr()
124 TheISA::Decoder *getDecoderPtr() { return actualTC->getDecoderPtr(); }
126 System *getSystemPtr() { return actualTC->getSystemPtr(); }
128 TheISA::Kernel::Statistics *getKernelStats()
129 { return actualTC->getKernelStats(); }
131 Process *getProcessPtr() { return actualTC->getProcessPtr(); }
133 PortProxy &getPhysProxy() { return actualTC->getPhysProxy(); }
135 FSTranslatingPortProxy &getVirtProxy()
136 { return actualTC->getVirtProxy(); }
138 void initMemProxies(ThreadContext *tc)
139 { actualTC->initMemProxies(tc); }
141 void connectMemPorts(ThreadContext *tc)
143 actualTC->connectMemPorts(tc);
146 SETranslatingPortProxy &getMemProxy() { return actualTC->getMemProxy(); }
148 /** Executes a syscall in SE mode. */
149 void syscall(int64_t callnum)
150 { return actualTC->syscall(callnum); }
152 Status status() const { return actualTC->status(); }
154 void setStatus(Status new_status)
156 actualTC->setStatus(new_status);
157 checkerTC->setStatus(new_status);
160 /// Set the status to Active.
161 void activate() { actualTC->activate(); }
163 /// Set the status to Suspended.
164 void suspend() { actualTC->suspend(); }
166 /// Set the status to Halted.
167 void halt() { actualTC->halt(); }
169 void dumpFuncProfile() { actualTC->dumpFuncProfile(); }
171 void takeOverFrom(ThreadContext *oldContext)
173 actualTC->takeOverFrom(oldContext);
174 checkerTC->copyState(oldContext);
177 void regStats(const std::string &name)
179 actualTC->regStats(name);
180 checkerTC->regStats(name);
183 EndQuiesceEvent *getQuiesceEvent() { return actualTC->getQuiesceEvent(); }
185 Tick readLastActivate() { return actualTC->readLastActivate(); }
186 Tick readLastSuspend() { return actualTC->readLastSuspend(); }
188 void profileClear() { return actualTC->profileClear(); }
189 void profileSample() { return actualTC->profileSample(); }
191 // @todo: Do I need this?
192 void copyArchRegs(ThreadContext *tc)
194 actualTC->copyArchRegs(tc);
195 checkerTC->copyArchRegs(tc);
200 actualTC->clearArchRegs();
201 checkerTC->clearArchRegs();
205 // New accessors for new decoder.
207 uint64_t readIntReg(int reg_idx)
208 { return actualTC->readIntReg(reg_idx); }
210 FloatReg readFloatReg(int reg_idx)
211 { return actualTC->readFloatReg(reg_idx); }
213 FloatRegBits readFloatRegBits(int reg_idx)
214 { return actualTC->readFloatRegBits(reg_idx); }
216 CCReg readCCReg(int reg_idx)
217 { return actualTC->readCCReg(reg_idx); }
219 void setIntReg(int reg_idx, uint64_t val)
221 actualTC->setIntReg(reg_idx, val);
222 checkerTC->setIntReg(reg_idx, val);
225 void setFloatReg(int reg_idx, FloatReg val)
227 actualTC->setFloatReg(reg_idx, val);
228 checkerTC->setFloatReg(reg_idx, val);
231 void setFloatRegBits(int reg_idx, FloatRegBits val)
233 actualTC->setFloatRegBits(reg_idx, val);
234 checkerTC->setFloatRegBits(reg_idx, val);
237 void setCCReg(int reg_idx, CCReg val)
239 actualTC->setCCReg(reg_idx, val);
240 checkerTC->setCCReg(reg_idx, val);
243 /** Reads this thread's PC state. */
244 TheISA::PCState pcState()
245 { return actualTC->pcState(); }
247 /** Sets this thread's PC state. */
248 void pcState(const TheISA::PCState &val)
250 DPRINTF(Checker, "Changing PC to %s, old PC %s\n",
251 val, checkerTC->pcState());
252 checkerTC->pcState(val);
253 checkerCPU->recordPCChange(val);
254 return actualTC->pcState(val);
257 void pcStateNoRecord(const TheISA::PCState &val)
259 return actualTC->pcState(val);
262 /** Reads this thread's PC. */
264 { return actualTC->instAddr(); }
266 /** Reads this thread's next PC. */
268 { return actualTC->nextInstAddr(); }
270 /** Reads this thread's next PC. */
272 { return actualTC->microPC(); }
274 MiscReg readMiscRegNoEffect(int misc_reg) const
275 { return actualTC->readMiscRegNoEffect(misc_reg); }
277 MiscReg readMiscReg(int misc_reg)
278 { return actualTC->readMiscReg(misc_reg); }
280 void setMiscRegNoEffect(int misc_reg, const MiscReg &val)
282 DPRINTF(Checker, "Setting misc reg with no effect: %d to both Checker"
283 " and O3..\n", misc_reg);
284 checkerTC->setMiscRegNoEffect(misc_reg, val);
285 actualTC->setMiscRegNoEffect(misc_reg, val);
288 void setMiscReg(int misc_reg, const MiscReg &val)
290 DPRINTF(Checker, "Setting misc reg with effect: %d to both Checker"
291 " and O3..\n", misc_reg);
292 checkerTC->setMiscReg(misc_reg, val);
293 actualTC->setMiscReg(misc_reg, val);
296 int flattenIntIndex(int reg) { return actualTC->flattenIntIndex(reg); }
297 int flattenFloatIndex(int reg) { return actualTC->flattenFloatIndex(reg); }
298 int flattenCCIndex(int reg) { return actualTC->flattenCCIndex(reg); }
299 int flattenMiscIndex(int reg) { return actualTC->flattenMiscIndex(reg); }
301 unsigned readStCondFailures()
302 { return actualTC->readStCondFailures(); }
304 void setStCondFailures(unsigned sc_failures)
306 actualTC->setStCondFailures(sc_failures);
309 Counter readFuncExeInst() { return actualTC->readFuncExeInst(); }
311 uint64_t readIntRegFlat(int idx)
312 { return actualTC->readIntRegFlat(idx); }
314 void setIntRegFlat(int idx, uint64_t val)
315 { actualTC->setIntRegFlat(idx, val); }
317 FloatReg readFloatRegFlat(int idx)
318 { return actualTC->readFloatRegFlat(idx); }
320 void setFloatRegFlat(int idx, FloatReg val)
321 { actualTC->setFloatRegFlat(idx, val); }
323 FloatRegBits readFloatRegBitsFlat(int idx)
324 { return actualTC->readFloatRegBitsFlat(idx); }
326 void setFloatRegBitsFlat(int idx, FloatRegBits val)
327 { actualTC->setFloatRegBitsFlat(idx, val); }
329 CCReg readCCRegFlat(int idx)
330 { return actualTC->readCCRegFlat(idx); }
332 void setCCRegFlat(int idx, CCReg val)
333 { actualTC->setCCRegFlat(idx, val); }
336 #endif // __CPU_CHECKER_EXEC_CONTEXT_HH__