fetch.hh revision 8462:80492ae5148e 
1/*
2 * Copyright (c) 2010 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2004-2006 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Kevin Lim
41 *          Korey Sewell
42 */
43
44#ifndef __CPU_O3_FETCH_HH__
45#define __CPU_O3_FETCH_HH__
46
47#include "arch/predecoder.hh"
48#include "arch/utility.hh"
49#include "base/statistics.hh"
50#include "config/the_isa.hh"
51#include "cpu/pc_event.hh"
52#include "cpu/timebuf.hh"
53#include "cpu/translation.hh"
54#include "mem/packet.hh"
55#include "mem/port.hh"
56#include "sim/eventq.hh"
57
58class DerivO3CPUParams;
59
60/**
61 * DefaultFetch class handles both single threaded and SMT fetch. Its
62 * width is specified by the parameters; each cycle it tries to fetch
63 * that many instructions. It supports using a branch predictor to
64 * predict direction and targets.
65 * It supports the idling functionality of the CPU by indicating to
66 * the CPU when it is active and inactive.
67 */
68template <class Impl>
69class DefaultFetch
70{
71  public:
72    /** Typedefs from Impl. */
73    typedef typename Impl::CPUPol CPUPol;
74    typedef typename Impl::DynInst DynInst;
75    typedef typename Impl::DynInstPtr DynInstPtr;
76    typedef typename Impl::O3CPU O3CPU;
77
78    /** Typedefs from the CPU policy. */
79    typedef typename CPUPol::BPredUnit BPredUnit;
80    typedef typename CPUPol::FetchStruct FetchStruct;
81    typedef typename CPUPol::TimeStruct TimeStruct;
82
83    /** Typedefs from ISA. */
84    typedef TheISA::MachInst MachInst;
85    typedef TheISA::ExtMachInst ExtMachInst;
86
87    /** IcachePort class for DefaultFetch.  Handles doing the
88     * communication with the cache/memory.
89     */
90    class IcachePort : public Port
91    {
92      protected:
93        /** Pointer to fetch. */
94        DefaultFetch<Impl> *fetch;
95
96      public:
97        /** Default constructor. */
98        IcachePort(DefaultFetch<Impl> *_fetch)
99            : Port(_fetch->name() + "-iport", _fetch->cpu), fetch(_fetch)
100        { }
101
102        bool snoopRangeSent;
103
104        virtual void setPeer(Port *port);
105
106      protected:
107        /** Atomic version of receive.  Panics. */
108        virtual Tick recvAtomic(PacketPtr pkt);
109
110        /** Functional version of receive.  Panics. */
111        virtual void recvFunctional(PacketPtr pkt);
112
113        /** Receives status change.  Other than range changing, panics. */
114        virtual void recvStatusChange(Status status);
115
116        /** Returns the address ranges of this device. */
117        virtual void getDeviceAddressRanges(AddrRangeList &resp,
118                                            bool &snoop)
119        { resp.clear(); snoop = true; }
120
121        /** Timing version of receive.  Handles setting fetch to the
122         * proper status to start fetching. */
123        virtual bool recvTiming(PacketPtr pkt);
124
125        /** Handles doing a retry of a failed fetch. */
126        virtual void recvRetry();
127    };
128
129    class FetchTranslation : public BaseTLB::Translation
130    {
131      protected:
132        DefaultFetch<Impl> *fetch;
133
134      public:
135        FetchTranslation(DefaultFetch<Impl> *_fetch)
136            : fetch(_fetch)
137        {}
138
139        void
140        markDelayed()
141        {}
142
143        void
144        finish(Fault fault, RequestPtr req, ThreadContext *tc,
145               BaseTLB::Mode mode)
146        {
147            assert(mode == BaseTLB::Execute);
148            fetch->finishTranslation(fault, req);
149            delete this;
150        }
151    };
152
153  private:
154    /* Event to delay delivery of a fetch translation result in case of
155     * a fault and the nop to carry the fault cannot be generated
156     * immediately */
157    class FinishTranslationEvent : public Event
158    {
159      private:
160        DefaultFetch<Impl> *fetch;
161        Fault fault;
162        RequestPtr req;
163
164      public:
165        FinishTranslationEvent(DefaultFetch<Impl> *_fetch)
166            : fetch(_fetch)
167        {}
168
169        void setFault(Fault _fault)
170        {
171            fault = _fault;
172        }
173
174        void setReq(RequestPtr _req)
175        {
176            req = _req;
177        }
178
179        /** Process the delayed finish translation */
180        void process()
181        {
182            assert(fetch->numInst < fetch->fetchWidth);
183            fetch->finishTranslation(fault, req);
184        }
185
186        const char *description() const
187        {
188            return "FullO3CPU FetchFinishTranslation";
189        }
190      };
191
192  public:
193    /** Overall fetch status. Used to determine if the CPU can
194     * deschedule itsef due to a lack of activity.
195     */
196    enum FetchStatus {
197        Active,
198        Inactive
199    };
200
201    /** Individual thread status. */
202    enum ThreadStatus {
203        Running,
204        Idle,
205        Squashing,
206        Blocked,
207        Fetching,
208        TrapPending,
209        QuiescePending,
210        SwitchOut,
211        ItlbWait,
212        IcacheWaitResponse,
213        IcacheWaitRetry,
214        IcacheAccessComplete,
215        NoGoodAddr
216    };
217
218    /** Fetching Policy, Add new policies here.*/
219    enum FetchPriority {
220        SingleThread,
221        RoundRobin,
222        Branch,
223        IQ,
224        LSQ
225    };
226
227  private:
228    /** Fetch status. */
229    FetchStatus _status;
230
231    /** Per-thread status. */
232    ThreadStatus fetchStatus[Impl::MaxThreads];
233
234    /** Fetch policy. */
235    FetchPriority fetchPolicy;
236
237    /** List that has the threads organized by priority. */
238    std::list<ThreadID> priorityList;
239
240  public:
241    /** DefaultFetch constructor. */
242    DefaultFetch(O3CPU *_cpu, DerivO3CPUParams *params);
243
244    /** Returns the name of fetch. */
245    std::string name() const;
246
247    /** Registers statistics. */
248    void regStats();
249
250    /** Returns the icache port. */
251    Port *getIcachePort() { return icachePort; }
252
253    /** Sets the main backwards communication time buffer pointer. */
254    void setTimeBuffer(TimeBuffer<TimeStruct> *time_buffer);
255
256    /** Sets pointer to list of active threads. */
257    void setActiveThreads(std::list<ThreadID> *at_ptr);
258
259    /** Sets pointer to time buffer used to communicate to the next stage. */
260    void setFetchQueue(TimeBuffer<FetchStruct> *fq_ptr);
261
262    /** Initialize stage. */
263    void initStage();
264
265    /** Tells the fetch stage that the Icache is set. */
266    void setIcache();
267
268    /** Processes cache completion event. */
269    void processCacheCompletion(PacketPtr pkt);
270
271    /** Begins the drain of the fetch stage. */
272    bool drain();
273
274    /** Resumes execution after a drain. */
275    void resume();
276
277    /** Tells fetch stage to prepare to be switched out. */
278    void switchOut();
279
280    /** Takes over from another CPU's thread. */
281    void takeOverFrom();
282
283    /** Checks if the fetch stage is switched out. */
284    bool isSwitchedOut() { return switchedOut; }
285
286    /** Tells fetch to wake up from a quiesce instruction. */
287    void wakeFromQuiesce();
288
289  private:
290    /** Changes the status of this stage to active, and indicates this
291     * to the CPU.
292     */
293    inline void switchToActive();
294
295    /** Changes the status of this stage to inactive, and indicates
296     * this to the CPU.
297     */
298    inline void switchToInactive();
299
300    /**
301     * Looks up in the branch predictor to see if the next PC should be
302     * either next PC+=MachInst or a branch target.
303     * @param next_PC Next PC variable passed in by reference.  It is
304     * expected to be set to the current PC; it will be updated with what
305     * the next PC will be.
306     * @param next_NPC Used for ISAs which use delay slots.
307     * @return Whether or not a branch was predicted as taken.
308     */
309    bool lookupAndUpdateNextPC(DynInstPtr &inst, TheISA::PCState &pc);
310
311    /**
312     * Fetches the cache line that contains fetch_PC.  Returns any
313     * fault that happened.  Puts the data into the class variable
314     * cacheData.
315     * @param vaddr The memory address that is being fetched from.
316     * @param ret_fault The fault reference that will be set to the result of
317     * the icache access.
318     * @param tid Thread id.
319     * @param pc The actual PC of the current instruction.
320     * @return Any fault that occured.
321     */
322    bool fetchCacheLine(Addr vaddr, ThreadID tid, Addr pc);
323    void finishTranslation(Fault fault, RequestPtr mem_req);
324
325
326    /** Check if an interrupt is pending and that we need to handle
327     */
328    bool
329    checkInterrupt(Addr pc)
330    {
331        return (interruptPending && (THE_ISA != ALPHA_ISA || !(pc & 0x3)));
332    }
333
334    /** Squashes a specific thread and resets the PC. */
335    inline void doSquash(const TheISA::PCState &newPC, ThreadID tid);
336
337    /** Squashes a specific thread and resets the PC. Also tells the CPU to
338     * remove any instructions between fetch and decode that should be sqaushed.
339     */
340    void squashFromDecode(const TheISA::PCState &newPC,
341                          const InstSeqNum &seq_num, ThreadID tid);
342
343    /** Checks if a thread is stalled. */
344    bool checkStall(ThreadID tid) const;
345
346    /** Updates overall fetch stage status; to be called at the end of each
347     * cycle. */
348    FetchStatus updateFetchStatus();
349
350  public:
351    /** Squashes a specific thread and resets the PC. Also tells the CPU to
352     * remove any instructions that are not in the ROB. The source of this
353     * squash should be the commit stage.
354     */
355    void squash(const TheISA::PCState &newPC, const InstSeqNum &seq_num,
356                DynInstPtr &squashInst, ThreadID tid);
357
358    /** Ticks the fetch stage, processing all inputs signals and fetching
359     * as many instructions as possible.
360     */
361    void tick();
362
363    /** Checks all input signals and updates the status as necessary.
364     *  @return: Returns if the status has changed due to input signals.
365     */
366    bool checkSignalsAndUpdate(ThreadID tid);
367
368    /** Does the actual fetching of instructions and passing them on to the
369     * next stage.
370     * @param status_change fetch() sets this variable if there was a status
371     * change (ie switching to IcacheMissStall).
372     */
373    void fetch(bool &status_change);
374
375    /** Align a PC to the start of an I-cache block. */
376    Addr icacheBlockAlignPC(Addr addr)
377    {
378        return (addr & ~(cacheBlkMask));
379    }
380
381  private:
382    DynInstPtr buildInst(ThreadID tid, StaticInstPtr staticInst,
383                         StaticInstPtr curMacroop, TheISA::PCState thisPC,
384                         TheISA::PCState nextPC, bool trace);
385
386    /** Handles retrying the fetch access. */
387    void recvRetry();
388
389    /** Returns the appropriate thread to fetch, given the fetch policy. */
390    ThreadID getFetchingThread(FetchPriority &fetch_priority);
391
392    /** Returns the appropriate thread to fetch using a round robin policy. */
393    ThreadID roundRobin();
394
395    /** Returns the appropriate thread to fetch using the IQ count policy. */
396    ThreadID iqCount();
397
398    /** Returns the appropriate thread to fetch using the LSQ count policy. */
399    ThreadID lsqCount();
400
401    /** Returns the appropriate thread to fetch using the branch count
402     * policy. */
403    ThreadID branchCount();
404
405    /** Pipeline the next I-cache access to the current one. */
406    void pipelineIcacheAccesses(ThreadID tid);
407
408    /** Profile the reasons of fetch stall. */
409    void profileStall(ThreadID tid);
410
411  private:
412    /** Pointer to the O3CPU. */
413    O3CPU *cpu;
414
415    /** Time buffer interface. */
416    TimeBuffer<TimeStruct> *timeBuffer;
417
418    /** Wire to get decode's information from backwards time buffer. */
419    typename TimeBuffer<TimeStruct>::wire fromDecode;
420
421    /** Wire to get rename's information from backwards time buffer. */
422    typename TimeBuffer<TimeStruct>::wire fromRename;
423
424    /** Wire to get iew's information from backwards time buffer. */
425    typename TimeBuffer<TimeStruct>::wire fromIEW;
426
427    /** Wire to get commit's information from backwards time buffer. */
428    typename TimeBuffer<TimeStruct>::wire fromCommit;
429
430    /** Internal fetch instruction queue. */
431    TimeBuffer<FetchStruct> *fetchQueue;
432
433    //Might be annoying how this name is different than the queue.
434    /** Wire used to write any information heading to decode. */
435    typename TimeBuffer<FetchStruct>::wire toDecode;
436
437    /** Icache interface. */
438    IcachePort *icachePort;
439
440    /** BPredUnit. */
441    BPredUnit branchPred;
442
443    /** Predecoder. */
444    TheISA::Predecoder predecoder;
445
446    TheISA::PCState pc[Impl::MaxThreads];
447
448    Addr fetchOffset[Impl::MaxThreads];
449
450    StaticInstPtr macroop[Impl::MaxThreads];
451
452    /** Can the fetch stage redirect from an interrupt on this instruction? */
453    bool delayedCommit[Impl::MaxThreads];
454
455    /** Memory request used to access cache. */
456    RequestPtr memReq[Impl::MaxThreads];
457
458    /** Variable that tracks if fetch has written to the time buffer this
459     * cycle. Used to tell CPU if there is activity this cycle.
460     */
461    bool wroteToTimeBuffer;
462
463    /** Tracks how many instructions has been fetched this cycle. */
464    int numInst;
465
466    /** Source of possible stalls. */
467    struct Stalls {
468        bool decode;
469        bool rename;
470        bool iew;
471        bool commit;
472    };
473
474    /** Tracks which stages are telling fetch to stall. */
475    Stalls stalls[Impl::MaxThreads];
476
477    /** Decode to fetch delay, in ticks. */
478    unsigned decodeToFetchDelay;
479
480    /** Rename to fetch delay, in ticks. */
481    unsigned renameToFetchDelay;
482
483    /** IEW to fetch delay, in ticks. */
484    unsigned iewToFetchDelay;
485
486    /** Commit to fetch delay, in ticks. */
487    unsigned commitToFetchDelay;
488
489    /** The width of fetch in instructions. */
490    unsigned fetchWidth;
491
492    /** Is the cache blocked?  If so no threads can access it. */
493    bool cacheBlocked;
494
495    /** The packet that is waiting to be retried. */
496    PacketPtr retryPkt;
497
498    /** The thread that is waiting on the cache to tell fetch to retry. */
499    ThreadID retryTid;
500
501    /** Cache block size. */
502    int cacheBlkSize;
503
504    /** Mask to get a cache block's address. */
505    Addr cacheBlkMask;
506
507    /** The cache line being fetched. */
508    uint8_t *cacheData[Impl::MaxThreads];
509
510    /** The PC of the cacheline that has been loaded. */
511    Addr cacheDataPC[Impl::MaxThreads];
512
513    /** Whether or not the cache data is valid. */
514    bool cacheDataValid[Impl::MaxThreads];
515
516    /** Size of instructions. */
517    int instSize;
518
519    /** Icache stall statistics. */
520    Counter lastIcacheStall[Impl::MaxThreads];
521
522    /** List of Active Threads */
523    std::list<ThreadID> *activeThreads;
524
525    /** Number of threads. */
526    ThreadID numThreads;
527
528    /** Number of threads that are actively fetching. */
529    ThreadID numFetchingThreads;
530
531    /** Thread ID being fetched. */
532    ThreadID threadFetched;
533
534    /** Checks if there is an interrupt pending.  If there is, fetch
535     * must stop once it is not fetching PAL instructions.
536     */
537    bool interruptPending;
538
539    /** Is there a drain pending. */
540    bool drainPending;
541
542    /** Records if fetch is switched out. */
543    bool switchedOut;
544
545    /** Set to true if a pipelined I-cache request should be issued. */
546    bool issuePipelinedIfetch[Impl::MaxThreads];
547
548    /** Event used to delay fault generation of translation faults */
549    FinishTranslationEvent finishTranslationEvent;
550
551    // @todo: Consider making these vectors and tracking on a per thread basis.
552    /** Stat for total number of cycles stalled due to an icache miss. */
553    Stats::Scalar icacheStallCycles;
554    /** Stat for total number of fetched instructions. */
555    Stats::Scalar fetchedInsts;
556    /** Total number of fetched branches. */
557    Stats::Scalar fetchedBranches;
558    /** Stat for total number of predicted branches. */
559    Stats::Scalar predictedBranches;
560    /** Stat for total number of cycles spent fetching. */
561    Stats::Scalar fetchCycles;
562    /** Stat for total number of cycles spent squashing. */
563    Stats::Scalar fetchSquashCycles;
564    /** Stat for total number of cycles spent waiting for translation */
565    Stats::Scalar fetchTlbCycles;
566    /** Stat for total number of cycles spent blocked due to other stages in
567     * the pipeline.
568     */
569    Stats::Scalar fetchIdleCycles;
570    /** Total number of cycles spent blocked. */
571    Stats::Scalar fetchBlockedCycles;
572    /** Total number of cycles spent in any other state. */
573    Stats::Scalar fetchMiscStallCycles;
574    /** Total number of cycles spent in waiting for drains. */
575    Stats::Scalar fetchPendingDrainCycles;
576    /** Total number of stall cycles caused by no active threads to run. */
577    Stats::Scalar fetchNoActiveThreadStallCycles;
578    /** Total number of stall cycles caused by pending traps. */
579    Stats::Scalar fetchPendingTrapStallCycles;
580    /** Total number of stall cycles caused by pending quiesce instructions. */
581    Stats::Scalar fetchPendingQuiesceStallCycles;
582    /** Total number of stall cycles caused by I-cache wait retrys. */
583    Stats::Scalar fetchIcacheWaitRetryStallCycles;
584    /** Stat for total number of fetched cache lines. */
585    Stats::Scalar fetchedCacheLines;
586    /** Total number of outstanding icache accesses that were dropped
587     * due to a squash.
588     */
589    Stats::Scalar fetchIcacheSquashes;
590    /** Total number of outstanding tlb accesses that were dropped
591     * due to a squash.
592     */
593    Stats::Scalar fetchTlbSquashes;
594    /** Distribution of number of instructions fetched each cycle. */
595    Stats::Distribution fetchNisnDist;
596    /** Rate of how often fetch was idle. */
597    Stats::Formula idleRate;
598    /** Number of branch fetches per cycle. */
599    Stats::Formula branchRate;
600    /** Number of instruction fetched per cycle. */
601    Stats::Formula fetchRate;
602};
603
604#endif //__CPU_O3_FETCH_HH__
605