2 * Copyright (c) 2007 MIPS Technologies, Inc.
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: Korey Sewell
32 #ifndef __CPU_INORDER_CPU_HH__
33 #define __CPU_INORDER_CPU_HH__
41 #include "arch/isa_traits.hh"
42 #include "base/statistics.hh"
43 #include "base/timebuf.hh"
44 #include "config/full_system.hh"
45 #include "cpu/activity.hh"
46 #include "cpu/base.hh"
47 #include "cpu/simple_thread.hh"
48 #include "cpu/inorder/inorder_dyn_inst.hh"
49 #include "cpu/inorder/pipeline_traits.hh"
50 #include "cpu/inorder/pipeline_stage.hh"
51 #include "cpu/inorder/thread_state.hh"
52 #include "cpu/inorder/reg_dep_map.hh"
53 #include "cpu/o3/dep_graph.hh"
54 #include "cpu/o3/rename_map.hh"
55 #include "mem/packet.hh"
56 #include "mem/port.hh"
57 #include "mem/request.hh"
58 #include "sim/eventq.hh"
59 #include "sim/process.hh"
67 class InOrderCPU : public BaseCPU
71 typedef ThePipeline::Params Params;
72 typedef InOrderThreadState Thread;
75 typedef TheISA::IntReg IntReg;
76 typedef TheISA::FloatReg FloatReg;
77 typedef TheISA::FloatRegBits FloatRegBits;
78 typedef TheISA::MiscReg MiscReg;
79 typedef TheISA::RegFile RegFile;
82 typedef ThePipeline::DynInstPtr DynInstPtr;
83 typedef std::list<DynInstPtr>::iterator ListIt;
86 typedef TimeBuffer<InterStageStruct> StageQueue;
88 friend class Resource;
91 /** Constructs a CPU with the given parameters. */
92 InOrderCPU(Params *params);
97 /** Type of core that this is */
100 int readCpuId() { return cpu_id; }
102 void setCpuId(int val) { cpu_id = val; }
118 /** Overall CPU status. */
122 /** Define TickEvent for the CPU */
123 class TickEvent : public Event
126 /** Pointer to the CPU. */
130 /** Constructs a tick event. */
131 TickEvent(InOrderCPU *c);
133 /** Processes a tick event, calling tick() on the CPU. */
136 /** Returns the description of the tick event. */
137 const char *description();
140 /** The tick event used for scheduling CPU ticks. */
143 /** Schedule tick event, regardless of its current state. */
144 void scheduleTickEvent(int delay)
146 if (tickEvent.squashed())
147 mainEventQueue.reschedule(&tickEvent, nextCycle(curTick + ticks(delay)));
148 else if (!tickEvent.scheduled())
149 mainEventQueue.schedule(&tickEvent, nextCycle(curTick + ticks(delay)));
152 /** Unschedule tick event, regardless of its current state. */
153 void unscheduleTickEvent()
155 if (tickEvent.scheduled())
160 // List of Events That can be scheduled from
162 // NOTE(1): The Resource Pool also uses this event list
163 // to schedule events broadcast to all resources interfaces
164 // NOTE(2): CPU Events usually need to schedule a corresponding resource
181 /** Define CPU Event */
182 class CPUEvent : public Event
188 CPUEventType cpuEventType;
194 /** Constructs a CPU event. */
195 CPUEvent(InOrderCPU *_cpu, CPUEventType e_type, Fault fault,
196 unsigned _tid, unsigned _vpe);
198 /** Set Type of Event To Be Scheduled */
199 void setEvent(CPUEventType e_type, Fault _fault, unsigned _tid, unsigned _vpe)
202 cpuEventType = e_type;
207 /** Processes a resource event. */
208 virtual void process();
210 /** Returns the description of the resource event. */
211 const char *description();
213 /** Schedule Event */
214 void scheduleEvent(int delay);
216 /** Unschedule This Event */
217 void unscheduleEvent();
220 /** Schedule a CPU Event */
221 void scheduleCpuEvent(CPUEventType cpu_event, Fault fault, unsigned tid,
222 unsigned vpe, unsigned delay = 0);
225 /** Interface between the CPU and CPU resources. */
226 ResourcePool *resPool;
228 /** Instruction used to signify that there is no *real* instruction in buffer slot */
229 DynInstPtr dummyBufferInst;
231 /** Used by resources to signify a denied access to a resource. */
232 ResourceRequest *dummyReq;
234 /** Identifies the resource id that identifies a fetch
237 unsigned fetchPortIdx;
239 /** Identifies the resource id that identifies a data
242 unsigned dataPortIdx;
244 /** The Pipeline Stages for the CPU */
245 PipelineStage *pipelineStage[ThePipeline::NumStages];
247 TheISA::IntReg PC[ThePipeline::MaxThreads];
248 TheISA::IntReg nextPC[ThePipeline::MaxThreads];
249 TheISA::IntReg nextNPC[ThePipeline::MaxThreads];
251 /** The Register File for the CPU */
252 /** @TODO: This regFile wont be a sufficient solution for out-of-order, add register
253 * files as a resource in order to handle ths problem
255 TheISA::IntRegFile intRegFile[ThePipeline::MaxThreads];;
256 TheISA::FloatRegFile floatRegFile[ThePipeline::MaxThreads];;
257 TheISA::MiscRegFile miscRegFile;
259 /** Dependency Tracker for Integer & Floating Point Regs */
260 RegDepMap archRegDepMap[ThePipeline::MaxThreads];
262 /** Global communication structure */
263 TimeBuffer<TimeStruct> timeBuffer;
265 /** Communication structure that sits in between pipeline stages */
266 StageQueue *stageQueue[ThePipeline::NumStages-1];
270 /** Registers statistics. */
273 /** Ticks CPU, calling tick() on each stage, and checking the overall
274 * activity to see if the CPU should deschedule itself.
278 /** Initialize the CPU */
281 /** Reset State in the CPU */
284 /** Get a Memory Port */
285 Port* getPort(const std::string &if_name, int idx = 0);
287 /** trap() - sets up a trap event on the cpuTraps to handle given fault.
288 * trapCPU() - Traps to handle given fault
290 void trap(Fault fault, unsigned tid, int delay = 0);
291 void trapCPU(Fault fault, unsigned tid);
293 /** Setup CPU to insert a thread's context */
294 void insertThread(unsigned tid);
296 /** Remove all of a thread's context from CPU */
297 void removeThread(unsigned tid);
299 /** Add Thread to Active Threads List. */
300 void activateContext(unsigned tid, int delay = 0);
301 void activateThread(unsigned tid);
303 /** Remove Thread from Active Threads List */
304 void suspendContext(unsigned tid, int delay = 0);
305 void suspendThread(unsigned tid);
307 /** Remove Thread from Active Threads List &&
308 * Remove Thread Context from CPU.
310 void deallocateContext(unsigned tid, int delay = 0);
311 void deallocateThread(unsigned tid);
312 void deactivateThread(unsigned tid);
317 hack_once("return a bogus context id");
321 /** Remove Thread from Active Threads List &&
322 * Remove Thread Context from CPU.
324 void haltContext(unsigned tid, int delay = 0);
326 void removePipelineStalls(unsigned tid);
328 void squashThreadInPipeline(unsigned tid);
330 /// Notify the CPU to enable a virtual processor element.
331 virtual void enableVirtProcElement(unsigned vpe);
332 void enableVPEs(unsigned vpe);
334 /// Notify the CPU to disable a virtual processor element.
335 virtual void disableVirtProcElement(unsigned tid, unsigned vpe);
336 void disableVPEs(unsigned tid, unsigned vpe);
338 /// Notify the CPU that multithreading is enabled.
339 virtual void enableMultiThreading(unsigned vpe);
340 void enableThreads(unsigned vpe);
342 /// Notify the CPU that multithreading is disabled.
343 virtual void disableMultiThreading(unsigned tid, unsigned vpe);
344 void disableThreads(unsigned tid, unsigned vpe);
346 // Sets a thread-rescheduling condition.
347 void setThreadRescheduleCondition(uint32_t tid)
349 //@TODO: IMPLEMENT ME
352 /** Activate a Thread When CPU Resources are Available. */
353 void activateWhenReady(int tid);
355 /** Add or Remove a Thread Context in the CPU. */
356 void doContextSwitch();
358 /** Update The Order In Which We Process Threads. */
359 void updateThreadPriority();
361 /** Switches a Pipeline Stage to Active. (Unused currently) */
362 void switchToActive(int stage_idx)
363 { /*pipelineStage[stage_idx]->switchToActive();*/ }
365 /** Switches out this CPU. (Unused currently) */
366 //void switchOut(Sampler *sampler);
368 /** Signals to this CPU that a stage has completed switching out. (Unused currently)*/
369 void signalSwitched();
371 /** Takes over from another CPU. (Unused currently)*/
372 void takeOverFrom(BaseCPU *oldCPU);
374 /** Get the current instruction sequence number, and increment it. */
375 InstSeqNum getAndIncrementInstSeq(unsigned tid)
376 { return globalSeqNum[tid]++; }
378 /** Get the current instruction sequence number, and increment it. */
379 InstSeqNum nextInstSeqNum(unsigned tid)
380 { return globalSeqNum[tid]; }
382 /** Increment Instruction Sequence Number */
383 void incrInstSeqNum(unsigned tid)
384 { globalSeqNum[tid]++; }
386 /** Set Instruction Sequence Number */
387 void setInstSeqNum(unsigned tid, InstSeqNum seq_num)
389 globalSeqNum[tid] = seq_num;
392 InstSeqNum getNextEventNum()
394 return cpuEventNum++;
397 /** Get instruction asid. */
398 int getInstAsid(unsigned tid)
399 { return thread[tid]->getInstAsid(); }
401 /** Get data asid. */
402 int getDataAsid(unsigned tid)
403 { return thread[tid]->getDataAsid(); }
405 /** Register file accessors */
406 uint64_t readIntReg(int reg_idx, unsigned tid);
408 FloatReg readFloatReg(int reg_idx, unsigned tid,
409 int width = TheISA::SingleWidth);
411 FloatRegBits readFloatRegBits(int reg_idx, unsigned tid,
412 int width = TheISA::SingleWidth);
414 void setIntReg(int reg_idx, uint64_t val, unsigned tid);
416 void setFloatReg(int reg_idx, FloatReg val, unsigned tid,
417 int width = TheISA::SingleWidth);
419 void setFloatRegBits(int reg_idx, FloatRegBits val, unsigned tid,
420 int width = TheISA::SingleWidth);
422 /** Reads a miscellaneous register. */
423 MiscReg readMiscRegNoEffect(int misc_reg, unsigned tid = 0);
425 /** Reads a misc. register, including any side effects the read
426 * might have as defined by the architecture.
428 MiscReg readMiscReg(int misc_reg, unsigned tid = 0);
430 /** Sets a miscellaneous register. */
431 void setMiscRegNoEffect(int misc_reg, const MiscReg &val, unsigned tid = 0);
433 /** Sets a misc. register, including any side effects the write
434 * might have as defined by the architecture.
436 void setMiscReg(int misc_reg, const MiscReg &val, unsigned tid = 0);
438 /** Reads a int/fp/misc reg. from another thread depending on ISA-defined
441 uint64_t readRegOtherThread(unsigned misc_reg, unsigned tid = -1);
443 /** Sets a int/fp/misc reg. from another thread depending on an ISA-defined
446 void setRegOtherThread(unsigned misc_reg, const MiscReg &val, unsigned tid);
448 /** Reads the commit PC of a specific thread. */
449 uint64_t readPC(unsigned tid);
451 /** Sets the commit PC of a specific thread. */
452 void setPC(Addr new_PC, unsigned tid);
454 /** Reads the next PC of a specific thread. */
455 uint64_t readNextPC(unsigned tid);
457 /** Sets the next PC of a specific thread. */
458 void setNextPC(uint64_t val, unsigned tid);
460 /** Reads the next NPC of a specific thread. */
461 uint64_t readNextNPC(unsigned tid);
463 /** Sets the next NPC of a specific thread. */
464 void setNextNPC(uint64_t val, unsigned tid);
466 /** Add Destination Register To Dependency Maps */
467 //void addToRegDepMap(DynInstPtr &inst);
469 /** Function to add instruction onto the head of the list of the
470 * instructions. Used when new instructions are fetched.
472 ListIt addInst(DynInstPtr &inst);
474 /** Function to tell the CPU that an instruction has completed. */
475 void instDone(DynInstPtr inst, unsigned tid);
477 /** Add Instructions to the CPU Remove List*/
478 void addToRemoveList(DynInstPtr &inst);
480 /** Remove an instruction from CPU */
481 void removeInst(DynInstPtr &inst);
483 /** Remove all instructions younger than the given sequence number. */
484 void removeInstsUntil(const InstSeqNum &seq_num,unsigned tid);
486 /** Removes the instruction pointed to by the iterator. */
487 inline void squashInstIt(const ListIt &instIt, const unsigned &tid);
489 /** Cleans up all instructions on the instruction remove list. */
490 void cleanUpRemovedInsts();
492 /** Cleans up all instructions on the request remove list. */
493 void cleanUpRemovedReqs();
495 /** Cleans up all instructions on the CPU event remove list. */
496 void cleanUpRemovedEvents();
498 /** Debug function to print all instructions on the list. */
501 /** Forwards an instruction read to the appropriate data
502 * resource (indexes into Resource Pool thru "dataPortIdx")
504 Fault read(DynInstPtr inst);
506 /** Forwards an instruction write. to the appropriate data
507 * resource (indexes into Resource Pool thru "dataPortIdx")
509 Fault write(DynInstPtr inst);
511 /** Executes a syscall.*/
512 void syscall(int64_t callnum, int tid);
514 /** Gets a syscall argument. */
515 IntReg getSyscallArg(int i, int tid);
517 /** Used to shift args for indirect syscall. */
518 void setSyscallArg(int i, IntReg val, int tid);
520 /** Sets the return value of a syscall. */
521 void setSyscallReturn(SyscallReturn return_value, int tid);
524 /** Per-Thread List of all the instructions in flight. */
525 std::list<DynInstPtr> instList[ThePipeline::MaxThreads];
527 /** List of all the instructions that will be removed at the end of this
530 std::queue<ListIt> removeList;
532 /** List of all the resource requests that will be removed at the end of this
535 std::queue<ResourceRequest*> reqRemoveList;
537 /** List of all the cpu event requests that will be removed at the end of
540 std::queue<Event*> cpuEventRemoveList;
543 /** Debug structure to keep track of the sequence numbers still in
546 std::set<InstSeqNum> snList;
549 /** Records if instructions need to be removed this cycle due to
550 * being retired or squashed.
552 bool removeInstsThisCycle;
554 /** True if there is non-speculative Inst Active In Pipeline. Lets any
555 * execution unit know, NOT to execute while the instruction is active.
557 bool nonSpecInstActive[ThePipeline::MaxThreads];
559 /** Instruction Seq. Num of current non-speculative instruction. */
560 InstSeqNum nonSpecSeqNum[ThePipeline::MaxThreads];
562 /** Instruction Seq. Num of last instruction squashed in pipeline */
563 InstSeqNum squashSeqNum[ThePipeline::MaxThreads];
565 /** Last Cycle that the CPU squashed instruction end. */
566 Tick lastSquashCycle[ThePipeline::MaxThreads];
568 std::list<unsigned> fetchPriorityList;
571 /** Active Threads List */
572 std::list<unsigned> activeThreads;
574 /** Current Threads List */
575 std::list<unsigned> currentThreads;
577 /** Suspended Threads List */
578 std::list<unsigned> suspendedThreads;
580 /** Thread Status Functions (Unused Currently) */
581 bool isThreadInCPU(unsigned tid);
582 bool isThreadActive(unsigned tid);
583 bool isThreadSuspended(unsigned tid);
584 void addToCurrentThreads(unsigned tid);
585 void removeFromCurrentThreads(unsigned tid);
588 /** The activity recorder; used to tell if the CPU has any
589 * activity remaining or if it can go to idle and deschedule
592 ActivityRecorder activityRec;
595 void readFunctional(Addr addr, uint32_t &buffer);
597 /** Number of Active Threads in the CPU */
598 int numActiveThreads() { return activeThreads.size(); }
600 /** Records that there was time buffer activity this cycle. */
601 void activityThisCycle() { activityRec.activity(); }
603 /** Changes a stage's status to active within the activity recorder. */
604 void activateStage(const int idx)
605 { activityRec.activateStage(idx); }
607 /** Changes a stage's status to inactive within the activity recorder. */
608 void deactivateStage(const int idx)
609 { activityRec.deactivateStage(idx); }
611 /** Wakes the CPU, rescheduling the CPU if it's not already active. */
614 /** Gets a free thread id. Use if thread ids change across system. */
617 // LL/SC debug functionality
618 unsigned stCondFails;
619 unsigned readStCondFailures() { return stCondFails; }
620 unsigned setStCondFailures(unsigned st_fails) { return stCondFails = st_fails; }
623 /** Returns a pointer to a thread context. */
624 ThreadContext *tcBase(unsigned tid = 0)
626 return thread[tid]->getTC();
629 /** The global sequence number counter. */
630 InstSeqNum globalSeqNum[ThePipeline::MaxThreads];
632 /** The global event number counter. */
633 InstSeqNum cpuEventNum;
635 /** Counter of how many stages have completed switching out. */
638 /** Pointers to all of the threads in the CPU. */
639 std::vector<Thread *> thread;
641 /** Pointer to the icache interface. */
642 MemInterface *icacheInterface;
643 /** Pointer to the dcache interface. */
644 MemInterface *dcacheInterface;
646 /** Whether or not the CPU should defer its registration. */
647 bool deferRegistration;
649 /** Per-Stage Instruction Tracing */
652 /** Is there a context switch pending? */
655 /** Threads Scheduled to Enter CPU */
656 std::list<int> cpuWaitList;
658 /** The cycle that the CPU was last running, used for statistics. */
659 Tick lastRunningCycle;
661 /** Number of Threads the CPU can process */
664 /** Number of Virtual Processors the CPU can process */
665 unsigned numVirtProcs;
667 /** Update Thread , used for statistic purposes*/
668 inline void tickThreadStats();
670 /** Per-Thread Tick */
671 Stats::Vector<> threadCycles;
674 Stats::Scalar<> smtCycles;
676 /** Stat for total number of times the CPU is descheduled. */
677 Stats::Scalar<> timesIdled;
679 /** Stat for total number of cycles the CPU spends descheduled. */
680 Stats::Scalar<> idleCycles;
682 /** Stat for the number of committed instructions per thread. */
683 Stats::Vector<> committedInsts;
685 /** Stat for the number of committed instructions per thread. */
686 Stats::Vector<> smtCommittedInsts;
688 /** Stat for the total number of committed instructions. */
689 Stats::Scalar<> totalCommittedInsts;
691 /** Stat for the CPI per thread. */
694 /** Stat for the SMT-CPI per thread. */
695 Stats::Formula smtCpi;
697 /** Stat for the total CPI. */
698 Stats::Formula totalCpi;
700 /** Stat for the IPC per thread. */
703 /** Stat for the total IPC. */
704 Stats::Formula smtIpc;
706 /** Stat for the total IPC. */
707 Stats::Formula totalIpc;
710 #endif // __CPU_O3_CPU_HH__