2 * Copyright (c) 2001-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.
28 * Authors: Steve Reinhardt
32 #ifndef __CPU_SIMPLE_THREAD_HH__
33 #define __CPU_SIMPLE_THREAD_HH__
35 #include "arch/isa_traits.hh"
36 #include "config/full_system.hh"
37 #include "cpu/thread_context.hh"
38 #include "cpu/thread_state.hh"
39 #include "mem/physical.hh"
40 #include "mem/request.hh"
41 #include "sim/byteswap.hh"
42 #include "sim/eventq.hh"
43 #include "sim/host.hh"
44 #include "sim/serialize.hh"
50 #include "sim/system.hh"
51 #include "arch/tlb.hh"
53 class FunctionProfile;
66 #include "sim/process.hh"
67 #include "mem/page_table.hh"
68 class TranslatingPort;
73 * The SimpleThread object provides a combination of the ThreadState
74 * object and the ThreadContext interface. It implements the
75 * ThreadContext interface so that a ProxyThreadContext class can be
76 * made using SimpleThread as the template parameter (see
77 * thread_context.hh). It adds to the ThreadState object by adding all
78 * the objects needed for simple functional execution, including a
79 * simple architectural register file, and pointers to the ITB and DTB
80 * in full system mode. For CPU models that do not need more advanced
81 * ways to hold state (i.e. a separate physical register file, or
82 * separate fetch and commit PC's), this SimpleThread class provides
83 * all the necessary state for full architecture-level functional
84 * simulation. See the AtomicSimpleCPU or TimingSimpleCPU for
88 class SimpleThread : public ThreadState
91 typedef TheISA::RegFile RegFile;
92 typedef TheISA::MachInst MachInst;
93 typedef TheISA::MiscRegFile MiscRegFile;
94 typedef TheISA::MiscReg MiscReg;
95 typedef TheISA::FloatReg FloatReg;
96 typedef TheISA::FloatRegBits FloatRegBits;
98 typedef ThreadContext::Status Status;
101 RegFile regs; // correct-path register context
104 // pointer to CPU associated with this SimpleThread
107 ProxyThreadContext<SimpleThread> *tc;
116 // constructor: initialize SimpleThread from given process structure
118 SimpleThread(BaseCPU *_cpu, int _thread_num, System *_system,
119 TheISA::ITB *_itb, TheISA::DTB *_dtb,
120 bool use_kernel_stats = true);
122 SimpleThread(BaseCPU *_cpu, int _thread_num, Process *_process, int _asid);
127 virtual ~SimpleThread();
129 virtual void takeOverFrom(ThreadContext *oldContext);
131 void regStats(const std::string &name);
133 void copyTC(ThreadContext *context);
135 void copyState(ThreadContext *oldContext);
137 void serialize(std::ostream &os);
138 void unserialize(Checkpoint *cp, const std::string §ion);
140 /***************************************************************
141 * SimpleThread functions to provide CPU with access to various
142 * state, and to provide address translation methods.
143 **************************************************************/
145 /** Returns the pointer to this SimpleThread's ThreadContext. Used
146 * when a ThreadContext must be passed to objects outside of the
149 ThreadContext *getTC() { return tc; }
152 int getInstAsid() { return regs.instAsid(); }
153 int getDataAsid() { return regs.dataAsid(); }
155 Fault translateInstReq(RequestPtr &req)
157 return itb->translate(req, tc);
160 Fault translateDataReadReq(RequestPtr &req)
162 return dtb->translate(req, tc, false);
165 Fault translateDataWriteReq(RequestPtr &req)
167 return dtb->translate(req, tc, true);
170 void dumpFuncProfile();
174 bool simPalCheck(int palFunc);
177 Fault translateInstReq(RequestPtr &req)
179 return process->pTable->translate(req);
182 Fault translateDataReadReq(RequestPtr &req)
184 return process->pTable->translate(req);
187 Fault translateDataWriteReq(RequestPtr &req)
189 return process->pTable->translate(req);
193 /*******************************************
194 * ThreadContext interface functions.
195 ******************************************/
197 BaseCPU *getCpuPtr() { return cpu; }
199 int getThreadNum() { return tid; }
202 System *getSystemPtr() { return system; }
204 TheISA::ITB *getITBPtr() { return itb; }
206 TheISA::DTB *getDTBPtr() { return dtb; }
208 FunctionalPort *getPhysPort() { return physPort; }
210 /** Return a virtual port. If no thread context is specified then a static
211 * port is returned. Otherwise a port is created and returned. It must be
212 * deleted by deleteVirtPort(). */
213 VirtualPort *getVirtPort(ThreadContext *tc);
215 void delVirtPort(VirtualPort *vp);
218 Status status() const { return _status; }
220 void setStatus(Status newStatus) { _status = newStatus; }
222 /// Set the status to Active. Optional delay indicates number of
223 /// cycles to wait before beginning execution.
224 void activate(int delay = 1);
226 /// Set the status to Suspended.
229 /// Set the status to Unallocated.
232 /// Set the status to Halted.
237 Fault read(RequestPtr &req, T &data)
239 #if FULL_SYSTEM && THE_ISA == ALPHA_ISA
240 if (req->isLocked()) {
241 req->xc->setMiscReg(TheISA::Lock_Addr_DepTag, req->paddr);
242 req->xc->setMiscReg(TheISA::Lock_Flag_DepTag, true);
247 error = mem->prot_read(req->paddr, data, req->size);
248 data = LittleEndianGuest::gtoh(data);
253 Fault write(RequestPtr &req, T &data)
255 #if FULL_SYSTEM && THE_ISA == ALPHA_ISA
258 // If this is a store conditional, act appropriately
259 if (req->isLocked()) {
262 if (req->isUncacheable()) {
263 // Don't update result register (see stq_c in isa_desc)
265 xc->setStCondFailures(0);//Needed? [RGD]
267 bool lock_flag = xc->readMiscReg(TheISA::Lock_Flag_DepTag);
268 Addr lock_addr = xc->readMiscReg(TheISA::Lock_Addr_DepTag);
269 req->result = lock_flag;
271 ((lock_addr & ~0xf) != (req->paddr & ~0xf))) {
272 xc->setMiscReg(TheISA::Lock_Flag_DepTag, false);
273 xc->setStCondFailures(xc->readStCondFailures() + 1);
274 if (((xc->readStCondFailures()) % 100000) == 0) {
275 std::cerr << "Warning: "
276 << xc->readStCondFailures()
277 << " consecutive store conditional failures "
278 << "on cpu " << req->xc->readCpuId()
283 else xc->setStCondFailures(0);
287 // Need to clear any locked flags on other proccessors for
288 // this address. Only do this for succsful Store Conditionals
289 // and all other stores (WH64?). Unsuccessful Store
290 // Conditionals would have returned above, and wouldn't fall
292 for (int i = 0; i < system->execContexts.size(); i++){
293 xc = system->execContexts[i];
294 if ((xc->readMiscReg(TheISA::Lock_Addr_DepTag) & ~0xf) ==
295 (req->paddr & ~0xf)) {
296 xc->setMiscReg(TheISA::Lock_Flag_DepTag, false);
301 return mem->prot_write(req->paddr, (T)htog(data), req->size);
304 virtual bool misspeculating();
306 Fault instRead(RequestPtr &req)
308 panic("instRead not implemented");
309 // return funcPhysMem->read(req, inst);
313 void copyArchRegs(ThreadContext *tc);
315 void clearArchRegs() { regs.clear(); }
318 // New accessors for new decoder.
320 uint64_t readIntReg(int reg_idx)
322 return regs.readIntReg(reg_idx);
325 FloatReg readFloatReg(int reg_idx, int width)
327 return regs.readFloatReg(reg_idx, width);
330 FloatReg readFloatReg(int reg_idx)
332 return regs.readFloatReg(reg_idx);
335 FloatRegBits readFloatRegBits(int reg_idx, int width)
337 return regs.readFloatRegBits(reg_idx, width);
340 FloatRegBits readFloatRegBits(int reg_idx)
342 return regs.readFloatRegBits(reg_idx);
345 void setIntReg(int reg_idx, uint64_t val)
347 regs.setIntReg(reg_idx, val);
350 void setFloatReg(int reg_idx, FloatReg val, int width)
352 regs.setFloatReg(reg_idx, val, width);
355 void setFloatReg(int reg_idx, FloatReg val)
357 regs.setFloatReg(reg_idx, val);
360 void setFloatRegBits(int reg_idx, FloatRegBits val, int width)
362 regs.setFloatRegBits(reg_idx, val, width);
365 void setFloatRegBits(int reg_idx, FloatRegBits val)
367 regs.setFloatRegBits(reg_idx, val);
372 return regs.readPC();
375 void setPC(uint64_t val)
380 uint64_t readMicroPC()
385 void setMicroPC(uint64_t val)
390 uint64_t readNextPC()
392 return regs.readNextPC();
395 void setNextPC(uint64_t val)
400 uint64_t readNextMicroPC()
405 void setNextMicroPC(uint64_t val)
410 uint64_t readNextNPC()
412 return regs.readNextNPC();
415 void setNextNPC(uint64_t val)
417 regs.setNextNPC(val);
420 MiscReg readMiscReg(int misc_reg)
422 return regs.readMiscReg(misc_reg);
425 MiscReg readMiscRegWithEffect(int misc_reg)
427 return regs.readMiscRegWithEffect(misc_reg, tc);
430 void setMiscReg(int misc_reg, const MiscReg &val)
432 return regs.setMiscReg(misc_reg, val);
435 void setMiscRegWithEffect(int misc_reg, const MiscReg &val)
437 return regs.setMiscRegWithEffect(misc_reg, val, tc);
440 unsigned readStCondFailures() { return storeCondFailures; }
442 void setStCondFailures(unsigned sc_failures)
443 { storeCondFailures = sc_failures; }
446 TheISA::IntReg getSyscallArg(int i)
448 return regs.readIntReg(TheISA::ArgumentReg0 + i);
451 // used to shift args for indirect syscall
452 void setSyscallArg(int i, TheISA::IntReg val)
454 regs.setIntReg(TheISA::ArgumentReg0 + i, val);
457 void setSyscallReturn(SyscallReturn return_value)
459 TheISA::setSyscallReturn(return_value, ®s);
462 void syscall(int64_t callnum)
464 process->syscall(callnum, tc);
468 void changeRegFileContext(TheISA::RegContextParam param,
469 TheISA::RegContextVal val)
471 regs.changeContext(param, val);
476 // for non-speculative execution context, spec_mode is always false
478 SimpleThread::misspeculating()
483 #endif // __CPU_CPU_EXEC_CONTEXT_HH__