thread_context.hh revision 3225 
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_CHECKER_THREAD_CONTEXT_HH__
32#define __CPU_CHECKER_THREAD_CONTEXT_HH__
33
34#include "arch/types.hh"
35#include "cpu/checker/cpu.hh"
36#include "cpu/simple_thread.hh"
37#include "cpu/thread_context.hh"
38
39class EndQuiesceEvent;
40namespace Kernel {
41    class Statistics;
42};
43
44/**
45 * Derived ThreadContext class for use with the Checker.  The template
46 * parameter is the ThreadContext class used by the specific CPU being
47 * verified.  This CheckerThreadContext is then used by the main CPU
48 * in place of its usual ThreadContext class.  It handles updating the
49 * checker's state any time state is updated externally through the
50 * ThreadContext.
51 */
52template <class TC>
53class CheckerThreadContext : public ThreadContext
54{
55  public:
56    CheckerThreadContext(TC *actual_tc,
57                         CheckerCPU *checker_cpu)
58        : actualTC(actual_tc), checkerTC(checker_cpu->thread),
59          checkerCPU(checker_cpu)
60    { }
61
62  private:
63    /** The main CPU's ThreadContext, or class that implements the
64     * ThreadContext interface. */
65    TC *actualTC;
66    /** The checker's own SimpleThread. Will be updated any time
67     * anything uses this ThreadContext to externally update a
68     * thread's state. */
69    SimpleThread *checkerTC;
70    /** Pointer to the checker CPU. */
71    CheckerCPU *checkerCPU;
72
73  public:
74
75    BaseCPU *getCpuPtr() { return actualTC->getCpuPtr(); }
76
77    void setCpuId(int id)
78    {
79        actualTC->setCpuId(id);
80        checkerTC->setCpuId(id);
81    }
82
83    int readCpuId() { return actualTC->readCpuId(); }
84
85#if FULL_SYSTEM
86    System *getSystemPtr() { return actualTC->getSystemPtr(); }
87
88    PhysicalMemory *getPhysMemPtr() { return actualTC->getPhysMemPtr(); }
89
90    AlphaITB *getITBPtr() { return actualTC->getITBPtr(); }
91
92    AlphaDTB *getDTBPtr() { return actualTC->getDTBPtr(); }
93
94    Kernel::Statistics *getKernelStats() { return actualTC->getKernelStats(); }
95
96    FunctionalPort *getPhysPort() { return actualTC->getPhysPort(); }
97
98    VirtualPort *getVirtPort(ThreadContext *tc = NULL)
99    { return actualTC->getVirtPort(); }
100
101    void delVirtPort(VirtualPort *vp) { actualTC->delVirtPort(vp); }
102#else
103    TranslatingPort *getMemPort() { return actualTC->getMemPort(); }
104
105    Process *getProcessPtr() { return actualTC->getProcessPtr(); }
106#endif
107
108    Status status() const { return actualTC->status(); }
109
110    void setStatus(Status new_status)
111    {
112        actualTC->setStatus(new_status);
113        checkerTC->setStatus(new_status);
114    }
115
116    /// Set the status to Active.  Optional delay indicates number of
117    /// cycles to wait before beginning execution.
118    void activate(int delay = 1) { actualTC->activate(delay); }
119
120    /// Set the status to Suspended.
121    void suspend() { actualTC->suspend(); }
122
123    /// Set the status to Unallocated.
124    void deallocate(int delay = 0) { actualTC->deallocate(delay); }
125
126    /// Set the status to Halted.
127    void halt() { actualTC->halt(); }
128
129#if FULL_SYSTEM
130    void dumpFuncProfile() { actualTC->dumpFuncProfile(); }
131#endif
132
133    void takeOverFrom(ThreadContext *oldContext)
134    {
135        actualTC->takeOverFrom(oldContext);
136        checkerTC->copyState(oldContext);
137    }
138
139    void regStats(const std::string &name) { actualTC->regStats(name); }
140
141    void serialize(std::ostream &os) { actualTC->serialize(os); }
142    void unserialize(Checkpoint *cp, const std::string &section)
143    { actualTC->unserialize(cp, section); }
144
145#if FULL_SYSTEM
146    EndQuiesceEvent *getQuiesceEvent() { return actualTC->getQuiesceEvent(); }
147
148    Tick readLastActivate() { return actualTC->readLastActivate(); }
149    Tick readLastSuspend() { return actualTC->readLastSuspend(); }
150
151    void profileClear() { return actualTC->profileClear(); }
152    void profileSample() { return actualTC->profileSample(); }
153#endif
154
155    int getThreadNum() { return actualTC->getThreadNum(); }
156
157    // @todo: Do I need this?
158    MachInst getInst() { return actualTC->getInst(); }
159
160    // @todo: Do I need this?
161    void copyArchRegs(ThreadContext *tc)
162    {
163        actualTC->copyArchRegs(tc);
164        checkerTC->copyArchRegs(tc);
165    }
166
167    void clearArchRegs()
168    {
169        actualTC->clearArchRegs();
170        checkerTC->clearArchRegs();
171    }
172
173    //
174    // New accessors for new decoder.
175    //
176    uint64_t readIntReg(int reg_idx)
177    { return actualTC->readIntReg(reg_idx); }
178
179    FloatReg readFloatReg(int reg_idx, int width)
180    { return actualTC->readFloatReg(reg_idx, width); }
181
182    FloatReg readFloatReg(int reg_idx)
183    { return actualTC->readFloatReg(reg_idx); }
184
185    FloatRegBits readFloatRegBits(int reg_idx, int width)
186    { return actualTC->readFloatRegBits(reg_idx, width); }
187
188    FloatRegBits readFloatRegBits(int reg_idx)
189    { return actualTC->readFloatRegBits(reg_idx); }
190
191    void setIntReg(int reg_idx, uint64_t val)
192    {
193        actualTC->setIntReg(reg_idx, val);
194        checkerTC->setIntReg(reg_idx, val);
195    }
196
197    void setFloatReg(int reg_idx, FloatReg val, int width)
198    {
199        actualTC->setFloatReg(reg_idx, val, width);
200        checkerTC->setFloatReg(reg_idx, val, width);
201    }
202
203    void setFloatReg(int reg_idx, FloatReg val)
204    {
205        actualTC->setFloatReg(reg_idx, val);
206        checkerTC->setFloatReg(reg_idx, val);
207    }
208
209    void setFloatRegBits(int reg_idx, FloatRegBits val, int width)
210    {
211        actualTC->setFloatRegBits(reg_idx, val, width);
212        checkerTC->setFloatRegBits(reg_idx, val, width);
213    }
214
215    void setFloatRegBits(int reg_idx, FloatRegBits val)
216    {
217        actualTC->setFloatRegBits(reg_idx, val);
218        checkerTC->setFloatRegBits(reg_idx, val);
219    }
220
221    uint64_t readPC() { return actualTC->readPC(); }
222
223    void setPC(uint64_t val)
224    {
225        actualTC->setPC(val);
226        checkerTC->setPC(val);
227        checkerCPU->recordPCChange(val);
228    }
229
230    uint64_t readNextPC() { return actualTC->readNextPC(); }
231
232    void setNextPC(uint64_t val)
233    {
234        actualTC->setNextPC(val);
235        checkerTC->setNextPC(val);
236        checkerCPU->recordNextPCChange(val);
237    }
238
239    uint64_t readNextNPC() { return actualTC->readNextNPC(); }
240
241    void setNextNPC(uint64_t val)
242    {
243        actualTC->setNextNPC(val);
244        checkerTC->setNextNPC(val);
245        checkerCPU->recordNextPCChange(val);
246    }
247
248    MiscReg readMiscReg(int misc_reg)
249    { return actualTC->readMiscReg(misc_reg); }
250
251    MiscReg readMiscRegWithEffect(int misc_reg, Fault &fault)
252    { return actualTC->readMiscRegWithEffect(misc_reg, fault); }
253
254    Fault setMiscReg(int misc_reg, const MiscReg &val)
255    {
256        checkerTC->setMiscReg(misc_reg, val);
257        return actualTC->setMiscReg(misc_reg, val);
258    }
259
260    Fault setMiscRegWithEffect(int misc_reg, const MiscReg &val)
261    {
262        checkerTC->setMiscRegWithEffect(misc_reg, val);
263        return actualTC->setMiscRegWithEffect(misc_reg, val);
264    }
265
266    unsigned readStCondFailures()
267    { return actualTC->readStCondFailures(); }
268
269    void setStCondFailures(unsigned sc_failures)
270    {
271        checkerTC->setStCondFailures(sc_failures);
272        actualTC->setStCondFailures(sc_failures);
273    }
274#if FULL_SYSTEM
275    bool inPalMode() { return actualTC->inPalMode(); }
276#endif
277
278    // @todo: Fix this!
279    bool misspeculating() { return actualTC->misspeculating(); }
280
281#if !FULL_SYSTEM
282    IntReg getSyscallArg(int i) { return actualTC->getSyscallArg(i); }
283
284    // used to shift args for indirect syscall
285    void setSyscallArg(int i, IntReg val)
286    {
287        checkerTC->setSyscallArg(i, val);
288        actualTC->setSyscallArg(i, val);
289    }
290
291    void setSyscallReturn(SyscallReturn return_value)
292    {
293        checkerTC->setSyscallReturn(return_value);
294        actualTC->setSyscallReturn(return_value);
295    }
296
297    Counter readFuncExeInst() { return actualTC->readFuncExeInst(); }
298#endif
299    void changeRegFileContext(TheISA::RegContextParam param,
300            TheISA::RegContextVal val)
301    {
302        actualTC->changeRegFileContext(param, val);
303        checkerTC->changeRegFileContext(param, val);
304    }
305};
306
307#endif // __CPU_CHECKER_EXEC_CONTEXT_HH__
308