cpu.hh revision 8922
11689SN/A/*
28707Sandreas.hansson@arm.com * Copyright (c) 2011 ARM Limited
38707Sandreas.hansson@arm.com * All rights reserved
48707Sandreas.hansson@arm.com *
58707Sandreas.hansson@arm.com * The license below extends only to copyright in the software and shall
68707Sandreas.hansson@arm.com * not be construed as granting a license to any other intellectual
78707Sandreas.hansson@arm.com * property including but not limited to intellectual property relating
88707Sandreas.hansson@arm.com * to a hardware implementation of the functionality of the software
98707Sandreas.hansson@arm.com * licensed hereunder.  You may use the software subject to the license
108707Sandreas.hansson@arm.com * terms below provided that you ensure that this notice is replicated
118707Sandreas.hansson@arm.com * unmodified and in its entirety in all distributions of the software,
128707Sandreas.hansson@arm.com * modified or unmodified, in source code or in binary form.
138707Sandreas.hansson@arm.com *
141689SN/A * Copyright (c) 2004-2005 The Regents of The University of Michigan
157897Shestness@cs.utexas.edu * Copyright (c) 2011 Regents of the University of California
161689SN/A * All rights reserved.
171689SN/A *
181689SN/A * Redistribution and use in source and binary forms, with or without
191689SN/A * modification, are permitted provided that the following conditions are
201689SN/A * met: redistributions of source code must retain the above copyright
211689SN/A * notice, this list of conditions and the following disclaimer;
221689SN/A * redistributions in binary form must reproduce the above copyright
231689SN/A * notice, this list of conditions and the following disclaimer in the
241689SN/A * documentation and/or other materials provided with the distribution;
251689SN/A * neither the name of the copyright holders nor the names of its
261689SN/A * contributors may be used to endorse or promote products derived from
271689SN/A * this software without specific prior written permission.
281689SN/A *
291689SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
301689SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
311689SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
321689SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
331689SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
341689SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
351689SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
361689SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
371689SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
381689SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
391689SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
402665Ssaidi@eecs.umich.edu *
412665Ssaidi@eecs.umich.edu * Authors: Kevin Lim
422756Sksewell@umich.edu *          Korey Sewell
437897Shestness@cs.utexas.edu *          Rick Strong
441689SN/A */
451689SN/A
462325SN/A#ifndef __CPU_O3_CPU_HH__
472325SN/A#define __CPU_O3_CPU_HH__
481060SN/A
491060SN/A#include <iostream>
501060SN/A#include <list>
512292SN/A#include <queue>
522292SN/A#include <set>
531681SN/A#include <vector>
541060SN/A
552980Sgblack@eecs.umich.edu#include "arch/types.hh"
561060SN/A#include "base/statistics.hh"
576658Snate@binkert.org#include "config/the_isa.hh"
581717SN/A#include "cpu/o3/comm.hh"
591717SN/A#include "cpu/o3/cpu_policy.hh"
602292SN/A#include "cpu/o3/scoreboard.hh"
612292SN/A#include "cpu/o3/thread_state.hh"
628229Snate@binkert.org#include "cpu/activity.hh"
638229Snate@binkert.org#include "cpu/base.hh"
648229Snate@binkert.org#include "cpu/simple_thread.hh"
658229Snate@binkert.org#include "cpu/timebuf.hh"
662817Sksewell@umich.edu//#include "cpu/o3/thread_context.hh"
678229Snate@binkert.org#include "params/DerivO3CPU.hh"
681060SN/A#include "sim/process.hh"
691060SN/A
702316SN/Atemplate <class>
712316SN/Aclass Checker;
722680Sktlim@umich.educlass ThreadContext;
732817Sksewell@umich.edutemplate <class>
742817Sksewell@umich.educlass O3ThreadContext;
752843Sktlim@umich.edu
762843Sktlim@umich.educlass Checkpoint;
772669Sktlim@umich.educlass MemObject;
781060SN/Aclass Process;
791060SN/A
808737Skoansin.tan@gmail.comstruct BaseCPUParams;
815529Snate@binkert.org
822733Sktlim@umich.educlass BaseO3CPU : public BaseCPU
831060SN/A{
841060SN/A    //Stuff that's pretty ISA independent will go here.
851060SN/A  public:
865529Snate@binkert.org    BaseO3CPU(BaseCPUParams *params);
872292SN/A
882292SN/A    void regStats();
891060SN/A};
901060SN/A
912348SN/A/**
922348SN/A * FullO3CPU class, has each of the stages (fetch through commit)
932348SN/A * within it, as well as all of the time buffers between stages.  The
942348SN/A * tick() function for the CPU is defined here.
952348SN/A */
961060SN/Atemplate <class Impl>
972733Sktlim@umich.educlass FullO3CPU : public BaseO3CPU
981060SN/A{
991060SN/A  public:
1002325SN/A    // Typedefs from the Impl here.
1011060SN/A    typedef typename Impl::CPUPol CPUPolicy;
1021061SN/A    typedef typename Impl::DynInstPtr DynInstPtr;
1034329Sktlim@umich.edu    typedef typename Impl::O3CPU O3CPU;
1041060SN/A
1055595Sgblack@eecs.umich.edu    typedef O3ThreadState<Impl> ImplState;
1062292SN/A    typedef O3ThreadState<Impl> Thread;
1072292SN/A
1082292SN/A    typedef typename std::list<DynInstPtr>::iterator ListIt;
1092292SN/A
1102817Sksewell@umich.edu    friend class O3ThreadContext<Impl>;
1112829Sksewell@umich.edu
1121060SN/A  public:
1131060SN/A    enum Status {
1141060SN/A        Running,
1151060SN/A        Idle,
1161060SN/A        Halted,
1172307SN/A        Blocked,
1182307SN/A        SwitchedOut
1191060SN/A    };
1201060SN/A
1216022Sgblack@eecs.umich.edu    TheISA::TLB * itb;
1226022Sgblack@eecs.umich.edu    TheISA::TLB * dtb;
1233781Sgblack@eecs.umich.edu
1242292SN/A    /** Overall CPU status. */
1251060SN/A    Status _status;
1261060SN/A
1272829Sksewell@umich.edu    /** Per-thread status in CPU, used for SMT.  */
1282829Sksewell@umich.edu    Status _threadStatus[Impl::MaxThreads];
1292829Sksewell@umich.edu
1301060SN/A  private:
1318707Sandreas.hansson@arm.com
1328707Sandreas.hansson@arm.com    /**
1338707Sandreas.hansson@arm.com     * IcachePort class for instruction fetch.
1348707Sandreas.hansson@arm.com     */
1358707Sandreas.hansson@arm.com    class IcachePort : public CpuPort
1368707Sandreas.hansson@arm.com    {
1378707Sandreas.hansson@arm.com      protected:
1388707Sandreas.hansson@arm.com        /** Pointer to fetch. */
1398707Sandreas.hansson@arm.com        DefaultFetch<Impl> *fetch;
1408707Sandreas.hansson@arm.com
1418707Sandreas.hansson@arm.com      public:
1428707Sandreas.hansson@arm.com        /** Default constructor. */
1438707Sandreas.hansson@arm.com        IcachePort(DefaultFetch<Impl> *_fetch, FullO3CPU<Impl>* _cpu)
1448707Sandreas.hansson@arm.com            : CpuPort(_fetch->name() + "-iport", _cpu), fetch(_fetch)
1458707Sandreas.hansson@arm.com        { }
1468707Sandreas.hansson@arm.com
1478707Sandreas.hansson@arm.com      protected:
1488707Sandreas.hansson@arm.com
1498707Sandreas.hansson@arm.com        /** Timing version of receive.  Handles setting fetch to the
1508707Sandreas.hansson@arm.com         * proper status to start fetching. */
1518707Sandreas.hansson@arm.com        virtual bool recvTiming(PacketPtr pkt);
1528707Sandreas.hansson@arm.com
1538707Sandreas.hansson@arm.com        /** Handles doing a retry of a failed fetch. */
1548707Sandreas.hansson@arm.com        virtual void recvRetry();
1558707Sandreas.hansson@arm.com    };
1568707Sandreas.hansson@arm.com
1578707Sandreas.hansson@arm.com    /**
1588707Sandreas.hansson@arm.com     * DcachePort class for the load/store queue.
1598707Sandreas.hansson@arm.com     */
1608707Sandreas.hansson@arm.com    class DcachePort : public CpuPort
1618707Sandreas.hansson@arm.com    {
1628707Sandreas.hansson@arm.com      protected:
1638707Sandreas.hansson@arm.com
1648707Sandreas.hansson@arm.com        /** Pointer to LSQ. */
1658707Sandreas.hansson@arm.com        LSQ<Impl> *lsq;
1668707Sandreas.hansson@arm.com
1678707Sandreas.hansson@arm.com      public:
1688707Sandreas.hansson@arm.com        /** Default constructor. */
1698707Sandreas.hansson@arm.com        DcachePort(LSQ<Impl> *_lsq, FullO3CPU<Impl>* _cpu)
1708707Sandreas.hansson@arm.com            : CpuPort(_lsq->name() + "-dport", _cpu), lsq(_lsq)
1718707Sandreas.hansson@arm.com        { }
1728707Sandreas.hansson@arm.com
1738707Sandreas.hansson@arm.com      protected:
1748707Sandreas.hansson@arm.com
1758707Sandreas.hansson@arm.com        /** Timing version of receive.  Handles writing back and
1768707Sandreas.hansson@arm.com         * completing the load or store that has returned from
1778707Sandreas.hansson@arm.com         * memory. */
1788707Sandreas.hansson@arm.com        virtual bool recvTiming(PacketPtr pkt);
1798707Sandreas.hansson@arm.com
1808707Sandreas.hansson@arm.com        /** Handles doing a retry of the previous send. */
1818707Sandreas.hansson@arm.com        virtual void recvRetry();
1828707Sandreas.hansson@arm.com
1838707Sandreas.hansson@arm.com        /**
1848707Sandreas.hansson@arm.com         * As this CPU requires snooping to maintain the load store queue
1858707Sandreas.hansson@arm.com         * change the behaviour from the base CPU port.
1868707Sandreas.hansson@arm.com         *
1878711Sandreas.hansson@arm.com         * @return true since we have to snoop
1888707Sandreas.hansson@arm.com         */
1898922Swilliam.wang@arm.com        virtual bool isSnooping() const { return true; }
1908707Sandreas.hansson@arm.com    };
1918707Sandreas.hansson@arm.com
1921060SN/A    class TickEvent : public Event
1931060SN/A    {
1941060SN/A      private:
1952292SN/A        /** Pointer to the CPU. */
1961755SN/A        FullO3CPU<Impl> *cpu;
1971060SN/A
1981060SN/A      public:
1992292SN/A        /** Constructs a tick event. */
2001755SN/A        TickEvent(FullO3CPU<Impl> *c);
2012292SN/A
2022292SN/A        /** Processes a tick event, calling tick() on the CPU. */
2031060SN/A        void process();
2042292SN/A        /** Returns the description of the tick event. */
2055336Shines@cs.fsu.edu        const char *description() const;
2061060SN/A    };
2071060SN/A
2082292SN/A    /** The tick event used for scheduling CPU ticks. */
2091060SN/A    TickEvent tickEvent;
2101060SN/A
2112292SN/A    /** Schedule tick event, regardless of its current state. */
2121060SN/A    void scheduleTickEvent(int delay)
2131060SN/A    {
2141060SN/A        if (tickEvent.squashed())
2157823Ssteve.reinhardt@amd.com            reschedule(tickEvent, nextCycle(curTick() + ticks(delay)));
2161060SN/A        else if (!tickEvent.scheduled())
2177823Ssteve.reinhardt@amd.com            schedule(tickEvent, nextCycle(curTick() + ticks(delay)));
2181060SN/A    }
2191060SN/A
2202292SN/A    /** Unschedule tick event, regardless of its current state. */
2211060SN/A    void unscheduleTickEvent()
2221060SN/A    {
2231060SN/A        if (tickEvent.scheduled())
2241060SN/A            tickEvent.squash();
2251060SN/A    }
2261060SN/A
2272829Sksewell@umich.edu    class ActivateThreadEvent : public Event
2282829Sksewell@umich.edu    {
2292829Sksewell@umich.edu      private:
2302829Sksewell@umich.edu        /** Number of Thread to Activate */
2316221Snate@binkert.org        ThreadID tid;
2322829Sksewell@umich.edu
2332829Sksewell@umich.edu        /** Pointer to the CPU. */
2342829Sksewell@umich.edu        FullO3CPU<Impl> *cpu;
2352829Sksewell@umich.edu
2362829Sksewell@umich.edu      public:
2372829Sksewell@umich.edu        /** Constructs the event. */
2382829Sksewell@umich.edu        ActivateThreadEvent();
2392829Sksewell@umich.edu
2402829Sksewell@umich.edu        /** Initialize Event */
2412829Sksewell@umich.edu        void init(int thread_num, FullO3CPU<Impl> *thread_cpu);
2422829Sksewell@umich.edu
2432829Sksewell@umich.edu        /** Processes the event, calling activateThread() on the CPU. */
2442829Sksewell@umich.edu        void process();
2452829Sksewell@umich.edu
2462829Sksewell@umich.edu        /** Returns the description of the event. */
2475336Shines@cs.fsu.edu        const char *description() const;
2482829Sksewell@umich.edu    };
2492829Sksewell@umich.edu
2502829Sksewell@umich.edu    /** Schedule thread to activate , regardless of its current state. */
2516221Snate@binkert.org    void
2526221Snate@binkert.org    scheduleActivateThreadEvent(ThreadID tid, int delay)
2532829Sksewell@umich.edu    {
2542829Sksewell@umich.edu        // Schedule thread to activate, regardless of its current state.
2552829Sksewell@umich.edu        if (activateThreadEvent[tid].squashed())
2565606Snate@binkert.org            reschedule(activateThreadEvent[tid],
2577823Ssteve.reinhardt@amd.com                nextCycle(curTick() + ticks(delay)));
2588518Sgeoffrey.blake@arm.com        else if (!activateThreadEvent[tid].scheduled()) {
2598518Sgeoffrey.blake@arm.com            Tick when = nextCycle(curTick() + ticks(delay));
2608518Sgeoffrey.blake@arm.com
2618518Sgeoffrey.blake@arm.com            // Check if the deallocateEvent is also scheduled, and make
2628518Sgeoffrey.blake@arm.com            // sure they do not happen at same time causing a sleep that
2638518Sgeoffrey.blake@arm.com            // is never woken from.
2648518Sgeoffrey.blake@arm.com            if (deallocateContextEvent[tid].scheduled() &&
2658518Sgeoffrey.blake@arm.com                deallocateContextEvent[tid].when() == when) {
2668518Sgeoffrey.blake@arm.com                when++;
2678518Sgeoffrey.blake@arm.com            }
2688518Sgeoffrey.blake@arm.com
2698518Sgeoffrey.blake@arm.com            schedule(activateThreadEvent[tid], when);
2708518Sgeoffrey.blake@arm.com        }
2712829Sksewell@umich.edu    }
2722829Sksewell@umich.edu
2732829Sksewell@umich.edu    /** Unschedule actiavte thread event, regardless of its current state. */
2746221Snate@binkert.org    void
2756221Snate@binkert.org    unscheduleActivateThreadEvent(ThreadID tid)
2762829Sksewell@umich.edu    {
2772829Sksewell@umich.edu        if (activateThreadEvent[tid].scheduled())
2782829Sksewell@umich.edu            activateThreadEvent[tid].squash();
2792829Sksewell@umich.edu    }
2802829Sksewell@umich.edu
2812829Sksewell@umich.edu    /** The tick event used for scheduling CPU ticks. */
2822829Sksewell@umich.edu    ActivateThreadEvent activateThreadEvent[Impl::MaxThreads];
2832829Sksewell@umich.edu
2842875Sksewell@umich.edu    class DeallocateContextEvent : public Event
2852875Sksewell@umich.edu    {
2862875Sksewell@umich.edu      private:
2873221Sktlim@umich.edu        /** Number of Thread to deactivate */
2886221Snate@binkert.org        ThreadID tid;
2892875Sksewell@umich.edu
2903221Sktlim@umich.edu        /** Should the thread be removed from the CPU? */
2913221Sktlim@umich.edu        bool remove;
2923221Sktlim@umich.edu
2932875Sksewell@umich.edu        /** Pointer to the CPU. */
2942875Sksewell@umich.edu        FullO3CPU<Impl> *cpu;
2952875Sksewell@umich.edu
2962875Sksewell@umich.edu      public:
2972875Sksewell@umich.edu        /** Constructs the event. */
2982875Sksewell@umich.edu        DeallocateContextEvent();
2992875Sksewell@umich.edu
3002875Sksewell@umich.edu        /** Initialize Event */
3012875Sksewell@umich.edu        void init(int thread_num, FullO3CPU<Impl> *thread_cpu);
3022875Sksewell@umich.edu
3032875Sksewell@umich.edu        /** Processes the event, calling activateThread() on the CPU. */
3042875Sksewell@umich.edu        void process();
3052875Sksewell@umich.edu
3063221Sktlim@umich.edu        /** Sets whether the thread should also be removed from the CPU. */
3073221Sktlim@umich.edu        void setRemove(bool _remove) { remove = _remove; }
3083221Sktlim@umich.edu
3092875Sksewell@umich.edu        /** Returns the description of the event. */
3105336Shines@cs.fsu.edu        const char *description() const;
3112875Sksewell@umich.edu    };
3122875Sksewell@umich.edu
3132875Sksewell@umich.edu    /** Schedule cpu to deallocate thread context.*/
3146221Snate@binkert.org    void
3156221Snate@binkert.org    scheduleDeallocateContextEvent(ThreadID tid, bool remove, int delay)
3162875Sksewell@umich.edu    {
3172875Sksewell@umich.edu        // Schedule thread to activate, regardless of its current state.
3182875Sksewell@umich.edu        if (deallocateContextEvent[tid].squashed())
3195606Snate@binkert.org            reschedule(deallocateContextEvent[tid],
3207823Ssteve.reinhardt@amd.com                nextCycle(curTick() + ticks(delay)));
3212875Sksewell@umich.edu        else if (!deallocateContextEvent[tid].scheduled())
3225606Snate@binkert.org            schedule(deallocateContextEvent[tid],
3237823Ssteve.reinhardt@amd.com                nextCycle(curTick() + ticks(delay)));
3242875Sksewell@umich.edu    }
3252875Sksewell@umich.edu
3262875Sksewell@umich.edu    /** Unschedule thread deallocation in CPU */
3276221Snate@binkert.org    void
3286221Snate@binkert.org    unscheduleDeallocateContextEvent(ThreadID tid)
3292875Sksewell@umich.edu    {
3302875Sksewell@umich.edu        if (deallocateContextEvent[tid].scheduled())
3312875Sksewell@umich.edu            deallocateContextEvent[tid].squash();
3322875Sksewell@umich.edu    }
3332875Sksewell@umich.edu
3342875Sksewell@umich.edu    /** The tick event used for scheduling CPU ticks. */
3352875Sksewell@umich.edu    DeallocateContextEvent deallocateContextEvent[Impl::MaxThreads];
3362875Sksewell@umich.edu
3371060SN/A  public:
3382292SN/A    /** Constructs a CPU with the given parameters. */
3395595Sgblack@eecs.umich.edu    FullO3CPU(DerivO3CPUParams *params);
3402292SN/A    /** Destructor. */
3411755SN/A    ~FullO3CPU();
3421060SN/A
3432292SN/A    /** Registers statistics. */
3445595Sgblack@eecs.umich.edu    void regStats();
3451684SN/A
3465358Sgblack@eecs.umich.edu    void demapPage(Addr vaddr, uint64_t asn)
3475358Sgblack@eecs.umich.edu    {
3485358Sgblack@eecs.umich.edu        this->itb->demapPage(vaddr, asn);
3495358Sgblack@eecs.umich.edu        this->dtb->demapPage(vaddr, asn);
3505358Sgblack@eecs.umich.edu    }
3515358Sgblack@eecs.umich.edu
3525358Sgblack@eecs.umich.edu    void demapInstPage(Addr vaddr, uint64_t asn)
3535358Sgblack@eecs.umich.edu    {
3545358Sgblack@eecs.umich.edu        this->itb->demapPage(vaddr, asn);
3555358Sgblack@eecs.umich.edu    }
3565358Sgblack@eecs.umich.edu
3575358Sgblack@eecs.umich.edu    void demapDataPage(Addr vaddr, uint64_t asn)
3585358Sgblack@eecs.umich.edu    {
3595358Sgblack@eecs.umich.edu        this->dtb->demapPage(vaddr, asn);
3605358Sgblack@eecs.umich.edu    }
3615358Sgblack@eecs.umich.edu
3622292SN/A    /** Ticks CPU, calling tick() on each stage, and checking the overall
3632292SN/A     *  activity to see if the CPU should deschedule itself.
3642292SN/A     */
3651684SN/A    void tick();
3661684SN/A
3672292SN/A    /** Initialize the CPU */
3681060SN/A    void init();
3691060SN/A
3702834Sksewell@umich.edu    /** Returns the Number of Active Threads in the CPU */
3712834Sksewell@umich.edu    int numActiveThreads()
3722834Sksewell@umich.edu    { return activeThreads.size(); }
3732834Sksewell@umich.edu
3742829Sksewell@umich.edu    /** Add Thread to Active Threads List */
3756221Snate@binkert.org    void activateThread(ThreadID tid);
3762875Sksewell@umich.edu
3772875Sksewell@umich.edu    /** Remove Thread from Active Threads List */
3786221Snate@binkert.org    void deactivateThread(ThreadID tid);
3792829Sksewell@umich.edu
3802292SN/A    /** Setup CPU to insert a thread's context */
3816221Snate@binkert.org    void insertThread(ThreadID tid);
3821060SN/A
3832292SN/A    /** Remove all of a thread's context from CPU */
3846221Snate@binkert.org    void removeThread(ThreadID tid);
3852292SN/A
3862292SN/A    /** Count the Total Instructions Committed in the CPU. */
3878834Satgutier@umich.edu    virtual Counter totalInsts() const;
3888834Satgutier@umich.edu
3898834Satgutier@umich.edu    /** Count the Total Ops (including micro ops) committed in the CPU. */
3908834Satgutier@umich.edu    virtual Counter totalOps() const;
3912292SN/A
3922292SN/A    /** Add Thread to Active Threads List. */
3936221Snate@binkert.org    void activateContext(ThreadID tid, int delay);
3942292SN/A
3952292SN/A    /** Remove Thread from Active Threads List */
3966221Snate@binkert.org    void suspendContext(ThreadID tid);
3972292SN/A
3982292SN/A    /** Remove Thread from Active Threads List &&
3993221Sktlim@umich.edu     *  Possibly Remove Thread Context from CPU.
4002292SN/A     */
4018737Skoansin.tan@gmail.com    bool scheduleDeallocateContext(ThreadID tid, bool remove, int delay = 1);
4022292SN/A
4032292SN/A    /** Remove Thread from Active Threads List &&
4042292SN/A     *  Remove Thread Context from CPU.
4052292SN/A     */
4066221Snate@binkert.org    void haltContext(ThreadID tid);
4072292SN/A
4082292SN/A    /** Activate a Thread When CPU Resources are Available. */
4096221Snate@binkert.org    void activateWhenReady(ThreadID tid);
4102292SN/A
4112292SN/A    /** Add or Remove a Thread Context in the CPU. */
4122292SN/A    void doContextSwitch();
4132292SN/A
4142292SN/A    /** Update The Order In Which We Process Threads. */
4152292SN/A    void updateThreadPriority();
4162292SN/A
4172864Sktlim@umich.edu    /** Serialize state. */
4182864Sktlim@umich.edu    virtual void serialize(std::ostream &os);
4192864Sktlim@umich.edu
4202864Sktlim@umich.edu    /** Unserialize from a checkpoint. */
4212864Sktlim@umich.edu    virtual void unserialize(Checkpoint *cp, const std::string &section);
4222864Sktlim@umich.edu
4232864Sktlim@umich.edu  public:
4245595Sgblack@eecs.umich.edu    /** Executes a syscall.
4255595Sgblack@eecs.umich.edu     * @todo: Determine if this needs to be virtual.
4262292SN/A     */
4276221Snate@binkert.org    void syscall(int64_t callnum, ThreadID tid);
4282292SN/A
4292843Sktlim@umich.edu    /** Starts draining the CPU's pipeline of all instructions in
4302843Sktlim@umich.edu     * order to stop all memory accesses. */
4312905Sktlim@umich.edu    virtual unsigned int drain(Event *drain_event);
4322843Sktlim@umich.edu
4332843Sktlim@umich.edu    /** Resumes execution after a drain. */
4342843Sktlim@umich.edu    virtual void resume();
4352292SN/A
4362348SN/A    /** Signals to this CPU that a stage has completed switching out. */
4372843Sktlim@umich.edu    void signalDrained();
4382843Sktlim@umich.edu
4392843Sktlim@umich.edu    /** Switches out this CPU. */
4402843Sktlim@umich.edu    virtual void switchOut();
4412316SN/A
4422348SN/A    /** Takes over from another CPU. */
4432843Sktlim@umich.edu    virtual void takeOverFrom(BaseCPU *oldCPU);
4441060SN/A
4451060SN/A    /** Get the current instruction sequence number, and increment it. */
4462316SN/A    InstSeqNum getAndIncrementInstSeq()
4472316SN/A    { return globalSeqNum++; }
4481060SN/A
4495595Sgblack@eecs.umich.edu    /** Traps to handle given fault. */
4507684Sgblack@eecs.umich.edu    void trap(Fault fault, ThreadID tid, StaticInstPtr inst);
4515595Sgblack@eecs.umich.edu
4525702Ssaidi@eecs.umich.edu    /** HW return from error interrupt. */
4536221Snate@binkert.org    Fault hwrei(ThreadID tid);
4545702Ssaidi@eecs.umich.edu
4556221Snate@binkert.org    bool simPalCheck(int palFunc, ThreadID tid);
4565702Ssaidi@eecs.umich.edu
4575595Sgblack@eecs.umich.edu    /** Returns the Fault for any valid interrupt. */
4585595Sgblack@eecs.umich.edu    Fault getInterrupts();
4595595Sgblack@eecs.umich.edu
4605595Sgblack@eecs.umich.edu    /** Processes any an interrupt fault. */
4615595Sgblack@eecs.umich.edu    void processInterrupts(Fault interrupt);
4625595Sgblack@eecs.umich.edu
4635595Sgblack@eecs.umich.edu    /** Halts the CPU. */
4645595Sgblack@eecs.umich.edu    void halt() { panic("Halt not implemented!\n"); }
4655595Sgblack@eecs.umich.edu
4661060SN/A    /** Check if this address is a valid instruction address. */
4671060SN/A    bool validInstAddr(Addr addr) { return true; }
4681060SN/A
4691060SN/A    /** Check if this address is a valid data address. */
4701060SN/A    bool validDataAddr(Addr addr) { return true; }
4711060SN/A
4722348SN/A    /** Register accessors.  Index refers to the physical register index. */
4735595Sgblack@eecs.umich.edu
4745595Sgblack@eecs.umich.edu    /** Reads a miscellaneous register. */
4756221Snate@binkert.org    TheISA::MiscReg readMiscRegNoEffect(int misc_reg, ThreadID tid);
4765595Sgblack@eecs.umich.edu
4775595Sgblack@eecs.umich.edu    /** Reads a misc. register, including any side effects the read
4785595Sgblack@eecs.umich.edu     * might have as defined by the architecture.
4795595Sgblack@eecs.umich.edu     */
4806221Snate@binkert.org    TheISA::MiscReg readMiscReg(int misc_reg, ThreadID tid);
4815595Sgblack@eecs.umich.edu
4825595Sgblack@eecs.umich.edu    /** Sets a miscellaneous register. */
4836221Snate@binkert.org    void setMiscRegNoEffect(int misc_reg, const TheISA::MiscReg &val,
4846221Snate@binkert.org            ThreadID tid);
4855595Sgblack@eecs.umich.edu
4865595Sgblack@eecs.umich.edu    /** Sets a misc. register, including any side effects the write
4875595Sgblack@eecs.umich.edu     * might have as defined by the architecture.
4885595Sgblack@eecs.umich.edu     */
4895595Sgblack@eecs.umich.edu    void setMiscReg(int misc_reg, const TheISA::MiscReg &val,
4906221Snate@binkert.org            ThreadID tid);
4915595Sgblack@eecs.umich.edu
4921060SN/A    uint64_t readIntReg(int reg_idx);
4931060SN/A
4943781Sgblack@eecs.umich.edu    TheISA::FloatReg readFloatReg(int reg_idx);
4951060SN/A
4963781Sgblack@eecs.umich.edu    TheISA::FloatRegBits readFloatRegBits(int reg_idx);
4972455SN/A
4981060SN/A    void setIntReg(int reg_idx, uint64_t val);
4991060SN/A
5003781Sgblack@eecs.umich.edu    void setFloatReg(int reg_idx, TheISA::FloatReg val);
5011060SN/A
5023781Sgblack@eecs.umich.edu    void setFloatRegBits(int reg_idx, TheISA::FloatRegBits val);
5032455SN/A
5046221Snate@binkert.org    uint64_t readArchIntReg(int reg_idx, ThreadID tid);
5051060SN/A
5066314Sgblack@eecs.umich.edu    float readArchFloatReg(int reg_idx, ThreadID tid);
5072292SN/A
5086221Snate@binkert.org    uint64_t readArchFloatRegInt(int reg_idx, ThreadID tid);
5092292SN/A
5102348SN/A    /** Architectural register accessors.  Looks up in the commit
5112348SN/A     * rename table to obtain the true physical index of the
5122348SN/A     * architected register first, then accesses that physical
5132348SN/A     * register.
5142348SN/A     */
5156221Snate@binkert.org    void setArchIntReg(int reg_idx, uint64_t val, ThreadID tid);
5162292SN/A
5176314Sgblack@eecs.umich.edu    void setArchFloatReg(int reg_idx, float val, ThreadID tid);
5182292SN/A
5196221Snate@binkert.org    void setArchFloatRegInt(int reg_idx, uint64_t val, ThreadID tid);
5202292SN/A
5217720Sgblack@eecs.umich.edu    /** Sets the commit PC state of a specific thread. */
5227720Sgblack@eecs.umich.edu    void pcState(const TheISA::PCState &newPCState, ThreadID tid);
5237720Sgblack@eecs.umich.edu
5247720Sgblack@eecs.umich.edu    /** Reads the commit PC state of a specific thread. */
5257720Sgblack@eecs.umich.edu    TheISA::PCState pcState(ThreadID tid);
5267720Sgblack@eecs.umich.edu
5272348SN/A    /** Reads the commit PC of a specific thread. */
5287720Sgblack@eecs.umich.edu    Addr instAddr(ThreadID tid);
5292292SN/A
5304636Sgblack@eecs.umich.edu    /** Reads the commit micro PC of a specific thread. */
5317720Sgblack@eecs.umich.edu    MicroPC microPC(ThreadID tid);
5324636Sgblack@eecs.umich.edu
5332348SN/A    /** Reads the next PC of a specific thread. */
5347720Sgblack@eecs.umich.edu    Addr nextInstAddr(ThreadID tid);
5352756Sksewell@umich.edu
5365595Sgblack@eecs.umich.edu    /** Initiates a squash of all in-flight instructions for a given
5375595Sgblack@eecs.umich.edu     * thread.  The source of the squash is an external update of
5385595Sgblack@eecs.umich.edu     * state through the TC.
5395595Sgblack@eecs.umich.edu     */
5406221Snate@binkert.org    void squashFromTC(ThreadID tid);
5415595Sgblack@eecs.umich.edu
5421060SN/A    /** Function to add instruction onto the head of the list of the
5431060SN/A     *  instructions.  Used when new instructions are fetched.
5441060SN/A     */
5452292SN/A    ListIt addInst(DynInstPtr &inst);
5461060SN/A
5471060SN/A    /** Function to tell the CPU that an instruction has completed. */
5488834Satgutier@umich.edu    void instDone(ThreadID tid, DynInstPtr &inst);
5491060SN/A
5502325SN/A    /** Remove an instruction from the front end of the list.  There's
5512325SN/A     *  no restriction on location of the instruction.
5521060SN/A     */
5531061SN/A    void removeFrontInst(DynInstPtr &inst);
5541060SN/A
5552935Sksewell@umich.edu    /** Remove all instructions that are not currently in the ROB.
5562935Sksewell@umich.edu     *  There's also an option to not squash delay slot instructions.*/
5576221Snate@binkert.org    void removeInstsNotInROB(ThreadID tid);
5581060SN/A
5591062SN/A    /** Remove all instructions younger than the given sequence number. */
5606221Snate@binkert.org    void removeInstsUntil(const InstSeqNum &seq_num, ThreadID tid);
5612292SN/A
5622348SN/A    /** Removes the instruction pointed to by the iterator. */
5636221Snate@binkert.org    inline void squashInstIt(const ListIt &instIt, ThreadID tid);
5642292SN/A
5652348SN/A    /** Cleans up all instructions on the remove list. */
5662292SN/A    void cleanUpRemovedInsts();
5671062SN/A
5682348SN/A    /** Debug function to print all instructions on the list. */
5691060SN/A    void dumpInsts();
5701060SN/A
5711060SN/A  public:
5725737Scws3k@cs.virginia.edu#ifndef NDEBUG
5735737Scws3k@cs.virginia.edu    /** Count of total number of dynamic instructions in flight. */
5745737Scws3k@cs.virginia.edu    int instcount;
5755737Scws3k@cs.virginia.edu#endif
5765737Scws3k@cs.virginia.edu
5771060SN/A    /** List of all the instructions in flight. */
5782292SN/A    std::list<DynInstPtr> instList;
5791060SN/A
5802292SN/A    /** List of all the instructions that will be removed at the end of this
5812292SN/A     *  cycle.
5822292SN/A     */
5832292SN/A    std::queue<ListIt> removeList;
5842292SN/A
5852325SN/A#ifdef DEBUG
5862348SN/A    /** Debug structure to keep track of the sequence numbers still in
5872348SN/A     * flight.
5882348SN/A     */
5892292SN/A    std::set<InstSeqNum> snList;
5902325SN/A#endif
5912292SN/A
5922325SN/A    /** Records if instructions need to be removed this cycle due to
5932325SN/A     *  being retired or squashed.
5942292SN/A     */
5952292SN/A    bool removeInstsThisCycle;
5962292SN/A
5971060SN/A  protected:
5981060SN/A    /** The fetch stage. */
5991060SN/A    typename CPUPolicy::Fetch fetch;
6001060SN/A
6011060SN/A    /** The decode stage. */
6021060SN/A    typename CPUPolicy::Decode decode;
6031060SN/A
6041060SN/A    /** The dispatch stage. */
6051060SN/A    typename CPUPolicy::Rename rename;
6061060SN/A
6071060SN/A    /** The issue/execute/writeback stages. */
6081060SN/A    typename CPUPolicy::IEW iew;
6091060SN/A
6101060SN/A    /** The commit stage. */
6111060SN/A    typename CPUPolicy::Commit commit;
6121060SN/A
6131060SN/A    /** The register file. */
6141060SN/A    typename CPUPolicy::RegFile regFile;
6151060SN/A
6161060SN/A    /** The free list. */
6171060SN/A    typename CPUPolicy::FreeList freeList;
6181060SN/A
6191060SN/A    /** The rename map. */
6202292SN/A    typename CPUPolicy::RenameMap renameMap[Impl::MaxThreads];
6212292SN/A
6222292SN/A    /** The commit rename map. */
6232292SN/A    typename CPUPolicy::RenameMap commitRenameMap[Impl::MaxThreads];
6241060SN/A
6251060SN/A    /** The re-order buffer. */
6261060SN/A    typename CPUPolicy::ROB rob;
6271060SN/A
6282292SN/A    /** Active Threads List */
6296221Snate@binkert.org    std::list<ThreadID> activeThreads;
6302292SN/A
6312292SN/A    /** Integer Register Scoreboard */
6322292SN/A    Scoreboard scoreboard;
6332292SN/A
6346313Sgblack@eecs.umich.edu    TheISA::ISA isa[Impl::MaxThreads];
6356313Sgblack@eecs.umich.edu
6368707Sandreas.hansson@arm.com    /** Instruction port. Note that it has to appear after the fetch stage. */
6378707Sandreas.hansson@arm.com    IcachePort icachePort;
6388707Sandreas.hansson@arm.com
6398707Sandreas.hansson@arm.com    /** Data port. Note that it has to appear after the iew stages */
6408707Sandreas.hansson@arm.com    DcachePort dcachePort;
6418707Sandreas.hansson@arm.com
6421060SN/A  public:
6432292SN/A    /** Enum to give each stage a specific index, so when calling
6442292SN/A     *  activateStage() or deactivateStage(), they can specify which stage
6452292SN/A     *  is being activated/deactivated.
6462292SN/A     */
6472292SN/A    enum StageIdx {
6482292SN/A        FetchIdx,
6492292SN/A        DecodeIdx,
6502292SN/A        RenameIdx,
6512292SN/A        IEWIdx,
6522292SN/A        CommitIdx,
6532292SN/A        NumStages };
6542292SN/A
6551060SN/A    /** Typedefs from the Impl to get the structs that each of the
6561060SN/A     *  time buffers should use.
6571060SN/A     */
6581061SN/A    typedef typename CPUPolicy::TimeStruct TimeStruct;
6591060SN/A
6601061SN/A    typedef typename CPUPolicy::FetchStruct FetchStruct;
6611060SN/A
6621061SN/A    typedef typename CPUPolicy::DecodeStruct DecodeStruct;
6631060SN/A
6641061SN/A    typedef typename CPUPolicy::RenameStruct RenameStruct;
6651060SN/A
6661061SN/A    typedef typename CPUPolicy::IEWStruct IEWStruct;
6671060SN/A
6681060SN/A    /** The main time buffer to do backwards communication. */
6691060SN/A    TimeBuffer<TimeStruct> timeBuffer;
6701060SN/A
6711060SN/A    /** The fetch stage's instruction queue. */
6721060SN/A    TimeBuffer<FetchStruct> fetchQueue;
6731060SN/A
6741060SN/A    /** The decode stage's instruction queue. */
6751060SN/A    TimeBuffer<DecodeStruct> decodeQueue;
6761060SN/A
6771060SN/A    /** The rename stage's instruction queue. */
6781060SN/A    TimeBuffer<RenameStruct> renameQueue;
6791060SN/A
6801060SN/A    /** The IEW stage's instruction queue. */
6811060SN/A    TimeBuffer<IEWStruct> iewQueue;
6821060SN/A
6832348SN/A  private:
6842348SN/A    /** The activity recorder; used to tell if the CPU has any
6852348SN/A     * activity remaining or if it can go to idle and deschedule
6862348SN/A     * itself.
6872348SN/A     */
6882325SN/A    ActivityRecorder activityRec;
6891060SN/A
6902348SN/A  public:
6912348SN/A    /** Records that there was time buffer activity this cycle. */
6922325SN/A    void activityThisCycle() { activityRec.activity(); }
6932292SN/A
6942348SN/A    /** Changes a stage's status to active within the activity recorder. */
6952325SN/A    void activateStage(const StageIdx idx)
6962325SN/A    { activityRec.activateStage(idx); }
6972292SN/A
6982348SN/A    /** Changes a stage's status to inactive within the activity recorder. */
6992325SN/A    void deactivateStage(const StageIdx idx)
7002325SN/A    { activityRec.deactivateStage(idx); }
7012292SN/A
7022292SN/A    /** Wakes the CPU, rescheduling the CPU if it's not already active. */
7032292SN/A    void wakeCPU();
7042260SN/A
7055807Snate@binkert.org    virtual void wakeup();
7065807Snate@binkert.org
7072292SN/A    /** Gets a free thread id. Use if thread ids change across system. */
7086221Snate@binkert.org    ThreadID getFreeTid();
7092292SN/A
7102292SN/A  public:
7112680Sktlim@umich.edu    /** Returns a pointer to a thread context. */
7126221Snate@binkert.org    ThreadContext *
7136221Snate@binkert.org    tcBase(ThreadID tid)
7141681SN/A    {
7152680Sktlim@umich.edu        return thread[tid]->getTC();
7162190SN/A    }
7172190SN/A
7182292SN/A    /** The global sequence number counter. */
7193093Sksewell@umich.edu    InstSeqNum globalSeqNum;//[Impl::MaxThreads];
7201060SN/A
7212348SN/A    /** Pointer to the checker, which can dynamically verify
7222348SN/A     * instruction results at run time.  This can be set to NULL if it
7232348SN/A     * is not being used.
7242348SN/A     */
7258733Sgeoffrey.blake@arm.com    Checker<Impl> *checker;
7262316SN/A
7272292SN/A    /** Pointer to the system. */
7281060SN/A    System *system;
7291060SN/A
7302843Sktlim@umich.edu    /** Event to call process() on once draining has completed. */
7312843Sktlim@umich.edu    Event *drainEvent;
7322843Sktlim@umich.edu
7332843Sktlim@umich.edu    /** Counter of how many stages have completed draining. */
7342843Sktlim@umich.edu    int drainCount;
7352316SN/A
7362348SN/A    /** Pointers to all of the threads in the CPU. */
7372292SN/A    std::vector<Thread *> thread;
7382260SN/A
7392292SN/A    /** Whether or not the CPU should defer its registration. */
7401060SN/A    bool deferRegistration;
7411060SN/A
7422292SN/A    /** Is there a context switch pending? */
7432292SN/A    bool contextSwitch;
7441060SN/A
7452292SN/A    /** Threads Scheduled to Enter CPU */
7462292SN/A    std::list<int> cpuWaitList;
7472292SN/A
7482292SN/A    /** The cycle that the CPU was last running, used for statistics. */
7492292SN/A    Tick lastRunningCycle;
7502292SN/A
7512829Sksewell@umich.edu    /** The cycle that the CPU was last activated by a new thread*/
7522829Sksewell@umich.edu    Tick lastActivatedCycle;
7532829Sksewell@umich.edu
7542292SN/A    /** Mapping for system thread id to cpu id */
7556221Snate@binkert.org    std::map<ThreadID, unsigned> threadMap;
7562292SN/A
7572292SN/A    /** Available thread ids in the cpu*/
7586221Snate@binkert.org    std::vector<ThreadID> tids;
7592292SN/A
7605595Sgblack@eecs.umich.edu    /** CPU read function, forwards read to LSQ. */
7616974Stjones1@inf.ed.ac.uk    Fault read(RequestPtr &req, RequestPtr &sreqLow, RequestPtr &sreqHigh,
7627520Sgblack@eecs.umich.edu               uint8_t *data, int load_idx)
7635595Sgblack@eecs.umich.edu    {
7646974Stjones1@inf.ed.ac.uk        return this->iew.ldstQueue.read(req, sreqLow, sreqHigh,
7656974Stjones1@inf.ed.ac.uk                                        data, load_idx);
7665595Sgblack@eecs.umich.edu    }
7675595Sgblack@eecs.umich.edu
7685595Sgblack@eecs.umich.edu    /** CPU write function, forwards write to LSQ. */
7696974Stjones1@inf.ed.ac.uk    Fault write(RequestPtr &req, RequestPtr &sreqLow, RequestPtr &sreqHigh,
7707520Sgblack@eecs.umich.edu                uint8_t *data, int store_idx)
7715595Sgblack@eecs.umich.edu    {
7726974Stjones1@inf.ed.ac.uk        return this->iew.ldstQueue.write(req, sreqLow, sreqHigh,
7736974Stjones1@inf.ed.ac.uk                                         data, store_idx);
7745595Sgblack@eecs.umich.edu    }
7755595Sgblack@eecs.umich.edu
7768707Sandreas.hansson@arm.com    /** Used by the fetch unit to get a hold of the instruction port. */
7778850Sandreas.hansson@arm.com    virtual CpuPort &getInstPort() { return icachePort; }
7788707Sandreas.hansson@arm.com
7796974Stjones1@inf.ed.ac.uk    /** Get the dcache port (used to find block size for translations). */
7808850Sandreas.hansson@arm.com    virtual CpuPort &getDataPort() { return dcachePort; }
7816974Stjones1@inf.ed.ac.uk
7825595Sgblack@eecs.umich.edu    Addr lockAddr;
7835595Sgblack@eecs.umich.edu
7845595Sgblack@eecs.umich.edu    /** Temporary fix for the lock flag, works in the UP case. */
7855595Sgblack@eecs.umich.edu    bool lockFlag;
7865595Sgblack@eecs.umich.edu
7872292SN/A    /** Stat for total number of times the CPU is descheduled. */
7885999Snate@binkert.org    Stats::Scalar timesIdled;
7892292SN/A    /** Stat for total number of cycles the CPU spends descheduled. */
7905999Snate@binkert.org    Stats::Scalar idleCycles;
7918627SAli.Saidi@ARM.com    /** Stat for total number of cycles the CPU spends descheduled due to a
7928627SAli.Saidi@ARM.com     * quiesce operation or waiting for an interrupt. */
7938627SAli.Saidi@ARM.com    Stats::Scalar quiesceCycles;
7942292SN/A    /** Stat for the number of committed instructions per thread. */
7955999Snate@binkert.org    Stats::Vector committedInsts;
7968834Satgutier@umich.edu    /** Stat for the number of committed ops (including micro ops) per thread. */
7978834Satgutier@umich.edu    Stats::Vector committedOps;
7982292SN/A    /** Stat for the total number of committed instructions. */
7995999Snate@binkert.org    Stats::Scalar totalCommittedInsts;
8002292SN/A    /** Stat for the CPI per thread. */
8012292SN/A    Stats::Formula cpi;
8022292SN/A    /** Stat for the total CPI. */
8032292SN/A    Stats::Formula totalCpi;
8042292SN/A    /** Stat for the IPC per thread. */
8052292SN/A    Stats::Formula ipc;
8062292SN/A    /** Stat for the total IPC. */
8072292SN/A    Stats::Formula totalIpc;
8087897Shestness@cs.utexas.edu
8097897Shestness@cs.utexas.edu    //number of integer register file accesses
8107897Shestness@cs.utexas.edu    Stats::Scalar intRegfileReads;
8117897Shestness@cs.utexas.edu    Stats::Scalar intRegfileWrites;
8127897Shestness@cs.utexas.edu    //number of float register file accesses
8137897Shestness@cs.utexas.edu    Stats::Scalar fpRegfileReads;
8147897Shestness@cs.utexas.edu    Stats::Scalar fpRegfileWrites;
8157897Shestness@cs.utexas.edu    //number of misc
8167897Shestness@cs.utexas.edu    Stats::Scalar miscRegfileReads;
8177897Shestness@cs.utexas.edu    Stats::Scalar miscRegfileWrites;
8181060SN/A};
8191060SN/A
8202325SN/A#endif // __CPU_O3_CPU_HH__
821