2 * Copyright (c) 2011-2012, 2016-2018 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) 2001-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.
42 #ifndef __CPU_SIMPLE_THREAD_HH__
43 #define __CPU_SIMPLE_THREAD_HH__
47 #include "arch/decoder.hh"
48 #include "arch/generic/tlb.hh"
49 #include "arch/isa.hh"
50 #include "arch/isa_traits.hh"
51 #include "arch/registers.hh"
52 #include "arch/types.hh"
53 #include "base/types.hh"
54 #include "config/the_isa.hh"
55 #include "cpu/thread_context.hh"
56 #include "cpu/thread_state.hh"
57 #include "debug/CCRegs.hh"
58 #include "debug/FloatRegs.hh"
59 #include "debug/IntRegs.hh"
60 #include "debug/VecPredRegs.hh"
61 #include "debug/VecRegs.hh"
62 #include "mem/page_table.hh"
63 #include "mem/request.hh"
64 #include "sim/byteswap.hh"
65 #include "sim/eventq.hh"
66 #include "sim/full_system.hh"
67 #include "sim/process.hh"
68 #include "sim/serialize.hh"
69 #include "sim/system.hh"
74 class FunctionProfile;
78 * The SimpleThread object provides a combination of the ThreadState
79 * object and the ThreadContext interface. It implements the
80 * ThreadContext interface and adds to the ThreadState object by adding all
81 * the objects needed for simple functional execution, including a
82 * simple architectural register file, and pointers to the ITB and DTB
83 * in full system mode. For CPU models that do not need more advanced
84 * ways to hold state (i.e. a separate physical register file, or
85 * separate fetch and commit PC's), this SimpleThread class provides
86 * all the necessary state for full architecture-level functional
87 * simulation. See the AtomicSimpleCPU or TimingSimpleCPU for
91 class SimpleThread : public ThreadState, public ThreadContext
94 typedef TheISA::MachInst MachInst;
95 using VecRegContainer = TheISA::VecRegContainer;
96 using VecElem = TheISA::VecElem;
97 using VecPredRegContainer = TheISA::VecPredRegContainer;
99 typedef ThreadContext::Status Status;
102 std::array<RegVal, TheISA::NumFloatRegs> floatRegs;
103 std::array<RegVal, TheISA::NumIntRegs> intRegs;
104 std::array<VecRegContainer, TheISA::NumVecRegs> vecRegs;
105 std::array<VecPredRegContainer, TheISA::NumVecPredRegs> vecPredRegs;
106 std::array<RegVal, TheISA::NumCCRegs> ccRegs;
107 TheISA::ISA *const isa; // one "instance" of the current ISA.
109 TheISA::PCState _pcState;
111 /** Did this instruction execute or is it predicated false */
114 /** True if the memory access should be skipped for this instruction */
115 bool memAccPredicate;
118 std::string name() const
120 return csprintf("%s.[tid:%i]", baseCpu->name(), threadId());
123 PCEventQueue pcEventQueue;
125 * An instruction-based event queue. Used for scheduling events based on
126 * number of instructions committed.
128 EventQueue comInstEventQueue;
135 TheISA::Decoder decoder;
137 // constructor: initialize SimpleThread from given process structure
139 SimpleThread(BaseCPU *_cpu, int _thread_num, System *_system,
140 BaseTLB *_itb, BaseTLB *_dtb, BaseISA *_isa);
142 SimpleThread(BaseCPU *_cpu, int _thread_num, System *_system,
143 Process *_process, BaseTLB *_itb, BaseTLB *_dtb,
146 virtual ~SimpleThread() {}
148 void takeOverFrom(ThreadContext *oldContext) override;
150 void copyState(ThreadContext *oldContext);
152 void serialize(CheckpointOut &cp) const override;
153 void unserialize(CheckpointIn &cp) override;
155 /***************************************************************
156 * SimpleThread functions to provide CPU with access to various
158 **************************************************************/
160 /** Returns the pointer to this SimpleThread's ThreadContext. Used
161 * when a ThreadContext must be passed to objects outside of the
164 ThreadContext *getTC() { return this; }
166 void demapPage(Addr vaddr, uint64_t asn)
168 itb->demapPage(vaddr, asn);
169 dtb->demapPage(vaddr, asn);
172 void demapInstPage(Addr vaddr, uint64_t asn)
174 itb->demapPage(vaddr, asn);
177 void demapDataPage(Addr vaddr, uint64_t asn)
179 dtb->demapPage(vaddr, asn);
182 void dumpFuncProfile() override;
184 /*******************************************
185 * ThreadContext interface functions.
186 ******************************************/
188 bool schedule(PCEvent *e) override { return pcEventQueue.schedule(e); }
189 bool remove(PCEvent *e) override { return pcEventQueue.remove(e); }
192 scheduleInstCountEvent(Event *event, Tick count) override
194 comInstEventQueue.schedule(event, count);
197 descheduleInstCountEvent(Event *event) override
199 comInstEventQueue.deschedule(event);
202 getCurrentInstCount() override
204 return comInstEventQueue.getCurTick();
207 BaseCPU *getCpuPtr() override { return baseCpu; }
209 int cpuId() const override { return ThreadState::cpuId(); }
210 uint32_t socketId() const override { return ThreadState::socketId(); }
211 int threadId() const override { return ThreadState::threadId(); }
212 void setThreadId(int id) override { ThreadState::setThreadId(id); }
213 ContextID contextId() const override { return ThreadState::contextId(); }
214 void setContextId(ContextID id) override { ThreadState::setContextId(id); }
216 BaseTLB *getITBPtr() override { return itb; }
218 BaseTLB *getDTBPtr() override { return dtb; }
220 CheckerCPU *getCheckerCpuPtr() override { return NULL; }
222 BaseISA *getIsaPtr() override { return isa; }
224 TheISA::Decoder *getDecoderPtr() override { return &decoder; }
226 System *getSystemPtr() override { return system; }
228 PortProxy &getPhysProxy() override { return ThreadState::getPhysProxy(); }
229 PortProxy &getVirtProxy() override { return ThreadState::getVirtProxy(); }
231 void initMemProxies(ThreadContext *tc) override
233 ThreadState::initMemProxies(tc);
236 Process *getProcessPtr() override { return ThreadState::getProcessPtr(); }
237 void setProcessPtr(Process *p) override { ThreadState::setProcessPtr(p); }
239 Status status() const override { return _status; }
241 void setStatus(Status newStatus) override { _status = newStatus; }
243 /// Set the status to Active.
244 void activate() override;
246 /// Set the status to Suspended.
247 void suspend() override;
249 /// Set the status to Halted.
250 void halt() override;
253 readLastActivate() override
255 return ThreadState::readLastActivate();
258 readLastSuspend() override
260 return ThreadState::readLastSuspend();
263 void profileClear() override { ThreadState::profileClear(); }
264 void profileSample() override { ThreadState::profileSample(); }
266 void copyArchRegs(ThreadContext *tc) override;
269 clearArchRegs() override
274 for (auto &vec_reg: vecRegs)
276 for (auto &pred_reg: vecPredRegs)
283 // New accessors for new decoder.
286 readIntReg(RegIndex reg_idx) const override
288 int flatIndex = isa->flattenIntIndex(reg_idx);
289 assert(flatIndex < TheISA::NumIntRegs);
290 uint64_t regVal(readIntRegFlat(flatIndex));
291 DPRINTF(IntRegs, "Reading int reg %d (%d) as %#x.\n",
292 reg_idx, flatIndex, regVal);
297 readFloatReg(RegIndex reg_idx) const override
299 int flatIndex = isa->flattenFloatIndex(reg_idx);
300 assert(flatIndex < TheISA::NumFloatRegs);
301 RegVal regVal(readFloatRegFlat(flatIndex));
302 DPRINTF(FloatRegs, "Reading float reg %d (%d) bits as %#x.\n",
303 reg_idx, flatIndex, regVal);
307 const VecRegContainer&
308 readVecReg(const RegId& reg) const override
310 int flatIndex = isa->flattenVecIndex(reg.index());
311 assert(flatIndex < TheISA::NumVecRegs);
312 const VecRegContainer& regVal = readVecRegFlat(flatIndex);
313 DPRINTF(VecRegs, "Reading vector reg %d (%d) as %s.\n",
314 reg.index(), flatIndex, regVal.print());
319 getWritableVecReg(const RegId& reg) override
321 int flatIndex = isa->flattenVecIndex(reg.index());
322 assert(flatIndex < TheISA::NumVecRegs);
323 VecRegContainer& regVal = getWritableVecRegFlat(flatIndex);
324 DPRINTF(VecRegs, "Reading vector reg %d (%d) as %s for modify.\n",
325 reg.index(), flatIndex, regVal.print());
329 /** Vector Register Lane Interfaces. */
331 /** Reads source vector <T> operand. */
332 template <typename T>
334 readVecLane(const RegId& reg) const
336 int flatIndex = isa->flattenVecIndex(reg.index());
337 assert(flatIndex < TheISA::NumVecRegs);
338 auto regVal = readVecLaneFlat<T>(flatIndex, reg.elemIndex());
339 DPRINTF(VecRegs, "Reading vector lane %d (%d)[%d] as %lx.\n",
340 reg.index(), flatIndex, reg.elemIndex(), regVal);
344 /** Reads source vector 8bit operand. */
345 virtual ConstVecLane8
346 readVec8BitLaneReg(const RegId ®) const override
348 return readVecLane<uint8_t>(reg);
351 /** Reads source vector 16bit operand. */
352 virtual ConstVecLane16
353 readVec16BitLaneReg(const RegId ®) const override
355 return readVecLane<uint16_t>(reg);
358 /** Reads source vector 32bit operand. */
359 virtual ConstVecLane32
360 readVec32BitLaneReg(const RegId ®) const override
362 return readVecLane<uint32_t>(reg);
365 /** Reads source vector 64bit operand. */
366 virtual ConstVecLane64
367 readVec64BitLaneReg(const RegId ®) const override
369 return readVecLane<uint64_t>(reg);
372 /** Write a lane of the destination vector register. */
373 template <typename LD>
375 setVecLaneT(const RegId ®, const LD &val)
377 int flatIndex = isa->flattenVecIndex(reg.index());
378 assert(flatIndex < TheISA::NumVecRegs);
379 setVecLaneFlat(flatIndex, reg.elemIndex(), val);
380 DPRINTF(VecRegs, "Reading vector lane %d (%d)[%d] to %lx.\n",
381 reg.index(), flatIndex, reg.elemIndex(), val);
384 setVecLane(const RegId ®, const LaneData<LaneSize::Byte> &val) override
386 return setVecLaneT(reg, val);
389 setVecLane(const RegId ®,
390 const LaneData<LaneSize::TwoByte> &val) override
392 return setVecLaneT(reg, val);
395 setVecLane(const RegId ®,
396 const LaneData<LaneSize::FourByte> &val) override
398 return setVecLaneT(reg, val);
401 setVecLane(const RegId ®,
402 const LaneData<LaneSize::EightByte> &val) override
404 return setVecLaneT(reg, val);
409 readVecElem(const RegId ®) const override
411 int flatIndex = isa->flattenVecElemIndex(reg.index());
412 assert(flatIndex < TheISA::NumVecRegs);
413 const VecElem& regVal = readVecElemFlat(flatIndex, reg.elemIndex());
414 DPRINTF(VecRegs, "Reading element %d of vector reg %d (%d) as"
415 " %#x.\n", reg.elemIndex(), reg.index(), flatIndex, regVal);
419 const VecPredRegContainer &
420 readVecPredReg(const RegId ®) const override
422 int flatIndex = isa->flattenVecPredIndex(reg.index());
423 assert(flatIndex < TheISA::NumVecPredRegs);
424 const VecPredRegContainer& regVal = readVecPredRegFlat(flatIndex);
425 DPRINTF(VecPredRegs, "Reading predicate reg %d (%d) as %s.\n",
426 reg.index(), flatIndex, regVal.print());
430 VecPredRegContainer &
431 getWritableVecPredReg(const RegId ®) override
433 int flatIndex = isa->flattenVecPredIndex(reg.index());
434 assert(flatIndex < TheISA::NumVecPredRegs);
435 VecPredRegContainer& regVal = getWritableVecPredRegFlat(flatIndex);
437 "Reading predicate reg %d (%d) as %s for modify.\n",
438 reg.index(), flatIndex, regVal.print());
443 readCCReg(RegIndex reg_idx) const override
445 int flatIndex = isa->flattenCCIndex(reg_idx);
446 assert(0 <= flatIndex);
447 assert(flatIndex < TheISA::NumCCRegs);
448 uint64_t regVal(readCCRegFlat(flatIndex));
449 DPRINTF(CCRegs, "Reading CC reg %d (%d) as %#x.\n",
450 reg_idx, flatIndex, regVal);
455 setIntReg(RegIndex reg_idx, RegVal val) override
457 int flatIndex = isa->flattenIntIndex(reg_idx);
458 assert(flatIndex < TheISA::NumIntRegs);
459 DPRINTF(IntRegs, "Setting int reg %d (%d) to %#x.\n",
460 reg_idx, flatIndex, val);
461 setIntRegFlat(flatIndex, val);
465 setFloatReg(RegIndex reg_idx, RegVal val) override
467 int flatIndex = isa->flattenFloatIndex(reg_idx);
468 assert(flatIndex < TheISA::NumFloatRegs);
469 // XXX: Fix array out of bounds compiler error for gem5.fast
470 // when checkercpu enabled
471 if (flatIndex < TheISA::NumFloatRegs)
472 setFloatRegFlat(flatIndex, val);
473 DPRINTF(FloatRegs, "Setting float reg %d (%d) bits to %#x.\n",
474 reg_idx, flatIndex, val);
478 setVecReg(const RegId ®, const VecRegContainer &val) override
480 int flatIndex = isa->flattenVecIndex(reg.index());
481 assert(flatIndex < TheISA::NumVecRegs);
482 setVecRegFlat(flatIndex, val);
483 DPRINTF(VecRegs, "Setting vector reg %d (%d) to %s.\n",
484 reg.index(), flatIndex, val.print());
488 setVecElem(const RegId ®, const VecElem &val) override
490 int flatIndex = isa->flattenVecElemIndex(reg.index());
491 assert(flatIndex < TheISA::NumVecRegs);
492 setVecElemFlat(flatIndex, reg.elemIndex(), val);
493 DPRINTF(VecRegs, "Setting element %d of vector reg %d (%d) to"
494 " %#x.\n", reg.elemIndex(), reg.index(), flatIndex, val);
498 setVecPredReg(const RegId ®, const VecPredRegContainer &val) override
500 int flatIndex = isa->flattenVecPredIndex(reg.index());
501 assert(flatIndex < TheISA::NumVecPredRegs);
502 setVecPredRegFlat(flatIndex, val);
503 DPRINTF(VecPredRegs, "Setting predicate reg %d (%d) to %s.\n",
504 reg.index(), flatIndex, val.print());
508 setCCReg(RegIndex reg_idx, RegVal val) override
510 int flatIndex = isa->flattenCCIndex(reg_idx);
511 assert(flatIndex < TheISA::NumCCRegs);
512 DPRINTF(CCRegs, "Setting CC reg %d (%d) to %#x.\n",
513 reg_idx, flatIndex, val);
514 setCCRegFlat(flatIndex, val);
517 TheISA::PCState pcState() const override { return _pcState; }
518 void pcState(const TheISA::PCState &val) override { _pcState = val; }
521 pcStateNoRecord(const TheISA::PCState &val) override
526 Addr instAddr() const override { return _pcState.instAddr(); }
527 Addr nextInstAddr() const override { return _pcState.nextInstAddr(); }
528 MicroPC microPC() const override { return _pcState.microPC(); }
529 bool readPredicate() const { return predicate; }
530 void setPredicate(bool val) { predicate = val; }
533 readMiscRegNoEffect(RegIndex misc_reg) const override
535 return isa->readMiscRegNoEffect(misc_reg);
539 readMiscReg(RegIndex misc_reg) override
541 return isa->readMiscReg(misc_reg);
545 setMiscRegNoEffect(RegIndex misc_reg, RegVal val) override
547 return isa->setMiscRegNoEffect(misc_reg, val);
551 setMiscReg(RegIndex misc_reg, RegVal val) override
553 return isa->setMiscReg(misc_reg, val);
557 flattenRegId(const RegId& regId) const override
559 return isa->flattenRegId(regId);
562 unsigned readStCondFailures() const override { return storeCondFailures; }
565 readMemAccPredicate()
567 return memAccPredicate;
571 setMemAccPredicate(bool val)
573 memAccPredicate = val;
577 setStCondFailures(unsigned sc_failures) override
579 storeCondFailures = sc_failures;
583 readFuncExeInst() const override
585 return ThreadState::readFuncExeInst();
589 syscall(Fault *fault) override
591 process->syscall(this, fault);
594 RegVal readIntRegFlat(RegIndex idx) const override { return intRegs[idx]; }
596 setIntRegFlat(RegIndex idx, RegVal val) override
602 readFloatRegFlat(RegIndex idx) const override
604 return floatRegs[idx];
607 setFloatRegFlat(RegIndex idx, RegVal val) override
609 floatRegs[idx] = val;
612 const VecRegContainer &
613 readVecRegFlat(RegIndex reg) const override
619 getWritableVecRegFlat(RegIndex reg) override
625 setVecRegFlat(RegIndex reg, const VecRegContainer &val) override
630 template <typename T>
632 readVecLaneFlat(RegIndex reg, int lId) const
634 return vecRegs[reg].laneView<T>(lId);
637 template <typename LD>
639 setVecLaneFlat(RegIndex reg, int lId, const LD &val)
641 vecRegs[reg].laneView<typename LD::UnderlyingType>(lId) = val;
645 readVecElemFlat(RegIndex reg, const ElemIndex &elemIndex) const override
647 return vecRegs[reg].as<TheISA::VecElem>()[elemIndex];
651 setVecElemFlat(RegIndex reg, const ElemIndex &elemIndex,
652 const VecElem &val) override
654 vecRegs[reg].as<TheISA::VecElem>()[elemIndex] = val;
657 const VecPredRegContainer &
658 readVecPredRegFlat(RegIndex reg) const override
660 return vecPredRegs[reg];
663 VecPredRegContainer &
664 getWritableVecPredRegFlat(RegIndex reg) override
666 return vecPredRegs[reg];
670 setVecPredRegFlat(RegIndex reg, const VecPredRegContainer &val) override
672 vecPredRegs[reg] = val;
675 RegVal readCCRegFlat(RegIndex idx) const override { return ccRegs[idx]; }
676 void setCCRegFlat(RegIndex idx, RegVal val) override { ccRegs[idx] = val; }
680 #endif // __CPU_CPU_EXEC_CONTEXT_HH__