12623SN/A/* 213954Sgiacomo.gabrielli@arm.com * Copyright (c) 2012-2013,2015,2018 ARM Limited 39442SAndreas.Sandberg@ARM.com * All rights reserved 49442SAndreas.Sandberg@ARM.com * 59442SAndreas.Sandberg@ARM.com * The license below extends only to copyright in the software and shall 69442SAndreas.Sandberg@ARM.com * not be construed as granting a license to any other intellectual 79442SAndreas.Sandberg@ARM.com * property including but not limited to intellectual property relating 89442SAndreas.Sandberg@ARM.com * to a hardware implementation of the functionality of the software 99442SAndreas.Sandberg@ARM.com * licensed hereunder. You may use the software subject to the license 109442SAndreas.Sandberg@ARM.com * terms below provided that you ensure that this notice is replicated 119442SAndreas.Sandberg@ARM.com * unmodified and in its entirety in all distributions of the software, 129442SAndreas.Sandberg@ARM.com * modified or unmodified, in source code or in binary form. 139442SAndreas.Sandberg@ARM.com * 142623SN/A * Copyright (c) 2002-2005 The Regents of The University of Michigan 152623SN/A * All rights reserved. 162623SN/A * 172623SN/A * Redistribution and use in source and binary forms, with or without 182623SN/A * modification, are permitted provided that the following conditions are 192623SN/A * met: redistributions of source code must retain the above copyright 202623SN/A * notice, this list of conditions and the following disclaimer; 212623SN/A * redistributions in binary form must reproduce the above copyright 222623SN/A * notice, this list of conditions and the following disclaimer in the 232623SN/A * documentation and/or other materials provided with the distribution; 242623SN/A * neither the name of the copyright holders nor the names of its 252623SN/A * contributors may be used to endorse or promote products derived from 262623SN/A * this software without specific prior written permission. 272623SN/A * 282623SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 292623SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 302623SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 312623SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 322623SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 332623SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 342623SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 352623SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 362623SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 372623SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 382623SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 392665Ssaidi@eecs.umich.edu * 402665Ssaidi@eecs.umich.edu * Authors: Steve Reinhardt 412623SN/A */ 422623SN/A 432623SN/A#ifndef __CPU_SIMPLE_TIMING_HH__ 442623SN/A#define __CPU_SIMPLE_TIMING_HH__ 452623SN/A 462623SN/A#include "cpu/simple/base.hh" 4711147Smitch.hayenga@arm.com#include "cpu/simple/exec_context.hh" 486973Stjones1@inf.ed.ac.uk#include "cpu/translation.hh" 495529Snate@binkert.org#include "params/TimingSimpleCPU.hh" 505529Snate@binkert.org 512623SN/Aclass TimingSimpleCPU : public BaseSimpleCPU 522623SN/A{ 532623SN/A public: 542623SN/A 555529Snate@binkert.org TimingSimpleCPU(TimingSimpleCPUParams * params); 562623SN/A virtual ~TimingSimpleCPU(); 572623SN/A 5811169Sandreas.hansson@arm.com void init() override; 592623SN/A 602623SN/A private: 612623SN/A 625728Sgblack@eecs.umich.edu /* 635728Sgblack@eecs.umich.edu * If an access needs to be broken into fragments, currently at most two, 645728Sgblack@eecs.umich.edu * the the following two classes are used as the sender state of the 655728Sgblack@eecs.umich.edu * packets so the CPU can keep track of everything. In the main packet 665728Sgblack@eecs.umich.edu * sender state, there's an array with a spot for each fragment. If a 675728Sgblack@eecs.umich.edu * fragment has already been accepted by the CPU, aka isn't waiting for 685728Sgblack@eecs.umich.edu * a retry, it's pointer is NULL. After each fragment has successfully 695728Sgblack@eecs.umich.edu * been processed, the "outstanding" counter is decremented. Once the 705728Sgblack@eecs.umich.edu * count is zero, the entire larger access is complete. 715728Sgblack@eecs.umich.edu */ 725728Sgblack@eecs.umich.edu class SplitMainSenderState : public Packet::SenderState 735728Sgblack@eecs.umich.edu { 745728Sgblack@eecs.umich.edu public: 755728Sgblack@eecs.umich.edu int outstanding; 765728Sgblack@eecs.umich.edu PacketPtr fragments[2]; 775728Sgblack@eecs.umich.edu 785728Sgblack@eecs.umich.edu int 795728Sgblack@eecs.umich.edu getPendingFragment() 805728Sgblack@eecs.umich.edu { 815728Sgblack@eecs.umich.edu if (fragments[0]) { 825728Sgblack@eecs.umich.edu return 0; 835728Sgblack@eecs.umich.edu } else if (fragments[1]) { 845728Sgblack@eecs.umich.edu return 1; 855728Sgblack@eecs.umich.edu } else { 865728Sgblack@eecs.umich.edu return -1; 875728Sgblack@eecs.umich.edu } 885728Sgblack@eecs.umich.edu } 895728Sgblack@eecs.umich.edu }; 905728Sgblack@eecs.umich.edu 915728Sgblack@eecs.umich.edu class SplitFragmentSenderState : public Packet::SenderState 925728Sgblack@eecs.umich.edu { 935728Sgblack@eecs.umich.edu public: 945728Sgblack@eecs.umich.edu SplitFragmentSenderState(PacketPtr _bigPkt, int _index) : 955728Sgblack@eecs.umich.edu bigPkt(_bigPkt), index(_index) 965728Sgblack@eecs.umich.edu {} 975728Sgblack@eecs.umich.edu PacketPtr bigPkt; 985728Sgblack@eecs.umich.edu int index; 995728Sgblack@eecs.umich.edu 1005728Sgblack@eecs.umich.edu void 1015728Sgblack@eecs.umich.edu clearFromParent() 1025728Sgblack@eecs.umich.edu { 1035728Sgblack@eecs.umich.edu SplitMainSenderState * main_send_state = 1045728Sgblack@eecs.umich.edu dynamic_cast<SplitMainSenderState *>(bigPkt->senderState); 1055728Sgblack@eecs.umich.edu main_send_state->fragments[index] = NULL; 1065728Sgblack@eecs.umich.edu } 1075728Sgblack@eecs.umich.edu }; 1085728Sgblack@eecs.umich.edu 1095894Sgblack@eecs.umich.edu class FetchTranslation : public BaseTLB::Translation 1105894Sgblack@eecs.umich.edu { 1115894Sgblack@eecs.umich.edu protected: 1125894Sgblack@eecs.umich.edu TimingSimpleCPU *cpu; 1135894Sgblack@eecs.umich.edu 1145894Sgblack@eecs.umich.edu public: 1156023Snate@binkert.org FetchTranslation(TimingSimpleCPU *_cpu) 1166023Snate@binkert.org : cpu(_cpu) 1175894Sgblack@eecs.umich.edu {} 1185894Sgblack@eecs.umich.edu 1196023Snate@binkert.org void 1207944SGiacomo.Gabrielli@arm.com markDelayed() 1217945SAli.Saidi@ARM.com { 1229342SAndreas.Sandberg@arm.com assert(cpu->_status == BaseSimpleCPU::Running); 1237945SAli.Saidi@ARM.com cpu->_status = ITBWaitResponse; 1247945SAli.Saidi@ARM.com } 1257944SGiacomo.Gabrielli@arm.com 1267944SGiacomo.Gabrielli@arm.com void 12712749Sgiacomo.travaglini@arm.com finish(const Fault &fault, const RequestPtr &req, ThreadContext *tc, 1286023Snate@binkert.org BaseTLB::Mode mode) 1295894Sgblack@eecs.umich.edu { 1305894Sgblack@eecs.umich.edu cpu->sendFetch(fault, req, tc); 1315894Sgblack@eecs.umich.edu } 1325894Sgblack@eecs.umich.edu }; 1335894Sgblack@eecs.umich.edu FetchTranslation fetchTranslation; 1345894Sgblack@eecs.umich.edu 13511148Smitch.hayenga@arm.com void threadSnoop(PacketPtr pkt, ThreadID sender); 13612749Sgiacomo.travaglini@arm.com void sendData(const RequestPtr &req, 13712749Sgiacomo.travaglini@arm.com uint8_t *data, uint64_t *res, bool read); 13812749Sgiacomo.travaglini@arm.com void sendSplitData(const RequestPtr &req1, const RequestPtr &req2, 13912749Sgiacomo.travaglini@arm.com const RequestPtr &req, 1406973Stjones1@inf.ed.ac.uk uint8_t *data, bool read); 1415894Sgblack@eecs.umich.edu 14210379Sandreas.hansson@arm.com void translationFault(const Fault &fault); 1435894Sgblack@eecs.umich.edu 14412749Sgiacomo.travaglini@arm.com PacketPtr buildPacket(const RequestPtr &req, bool read); 1455894Sgblack@eecs.umich.edu void buildSplitPacket(PacketPtr &pkt1, PacketPtr &pkt2, 14612749Sgiacomo.travaglini@arm.com const RequestPtr &req1, const RequestPtr &req2, 14712749Sgiacomo.travaglini@arm.com const RequestPtr &req, 1485894Sgblack@eecs.umich.edu uint8_t *data, bool read); 1495744Sgblack@eecs.umich.edu 1505728Sgblack@eecs.umich.edu bool handleReadPacket(PacketPtr pkt); 1515728Sgblack@eecs.umich.edu // This function always implicitly uses dcache_pkt. 1525728Sgblack@eecs.umich.edu bool handleWritePacket(); 1535728Sgblack@eecs.umich.edu 1548707Sandreas.hansson@arm.com /** 1558707Sandreas.hansson@arm.com * A TimingCPUPort overrides the default behaviour of the 1568707Sandreas.hansson@arm.com * recvTiming and recvRetry and implements events for the 1578707Sandreas.hansson@arm.com * scheduling of handling of incoming packets in the following 1588707Sandreas.hansson@arm.com * cycle. 1598707Sandreas.hansson@arm.com */ 1609608Sandreas.hansson@arm.com class TimingCPUPort : public MasterPort 1612623SN/A { 1622623SN/A public: 1632623SN/A 1648707Sandreas.hansson@arm.com TimingCPUPort(const std::string& _name, TimingSimpleCPU* _cpu) 16512085Sspwilson2@wisc.edu : MasterPort(_name, _cpu), cpu(_cpu), 16612085Sspwilson2@wisc.edu retryRespEvent([this]{ sendRetryResp(); }, name()) 1672623SN/A { } 1682623SN/A 1692623SN/A protected: 1702623SN/A 1718707Sandreas.hansson@arm.com TimingSimpleCPU* cpu; 1722948Ssaidi@eecs.umich.edu 1732948Ssaidi@eecs.umich.edu struct TickEvent : public Event 1742948Ssaidi@eecs.umich.edu { 1753349Sbinkertn@umich.edu PacketPtr pkt; 1762948Ssaidi@eecs.umich.edu TimingSimpleCPU *cpu; 1772948Ssaidi@eecs.umich.edu 1788707Sandreas.hansson@arm.com TickEvent(TimingSimpleCPU *_cpu) : pkt(NULL), cpu(_cpu) {} 1795336Shines@cs.fsu.edu const char *description() const { return "Timing CPU tick"; } 1803349Sbinkertn@umich.edu void schedule(PacketPtr _pkt, Tick t); 1812948Ssaidi@eecs.umich.edu }; 1822948Ssaidi@eecs.umich.edu 18312085Sspwilson2@wisc.edu EventFunctionWrapper retryRespEvent; 1842623SN/A }; 1852623SN/A 1868707Sandreas.hansson@arm.com class IcachePort : public TimingCPUPort 1872623SN/A { 1882623SN/A public: 1892623SN/A 1908707Sandreas.hansson@arm.com IcachePort(TimingSimpleCPU *_cpu) 1919095Sandreas.hansson@arm.com : TimingCPUPort(_cpu->name() + ".icache_port", _cpu), 1928707Sandreas.hansson@arm.com tickEvent(_cpu) 1932623SN/A { } 1942623SN/A 1952623SN/A protected: 1962623SN/A 1978975Sandreas.hansson@arm.com virtual bool recvTimingResp(PacketPtr pkt); 1982623SN/A 19910713Sandreas.hansson@arm.com virtual void recvReqRetry(); 2002948Ssaidi@eecs.umich.edu 2012948Ssaidi@eecs.umich.edu struct ITickEvent : public TickEvent 2022948Ssaidi@eecs.umich.edu { 2032948Ssaidi@eecs.umich.edu 2042948Ssaidi@eecs.umich.edu ITickEvent(TimingSimpleCPU *_cpu) 2052948Ssaidi@eecs.umich.edu : TickEvent(_cpu) {} 2062948Ssaidi@eecs.umich.edu void process(); 2075336Shines@cs.fsu.edu const char *description() const { return "Timing CPU icache tick"; } 2082948Ssaidi@eecs.umich.edu }; 2092948Ssaidi@eecs.umich.edu 2102948Ssaidi@eecs.umich.edu ITickEvent tickEvent; 2112948Ssaidi@eecs.umich.edu 2122623SN/A }; 2132623SN/A 2148707Sandreas.hansson@arm.com class DcachePort : public TimingCPUPort 2152623SN/A { 2162623SN/A public: 2172623SN/A 2188707Sandreas.hansson@arm.com DcachePort(TimingSimpleCPU *_cpu) 2199095Sandreas.hansson@arm.com : TimingCPUPort(_cpu->name() + ".dcache_port", _cpu), 2209095Sandreas.hansson@arm.com tickEvent(_cpu) 22110030SAli.Saidi@ARM.com { 22210030SAli.Saidi@ARM.com cacheBlockMask = ~(cpu->cacheLineSize() - 1); 22310030SAli.Saidi@ARM.com } 2242623SN/A 22510030SAli.Saidi@ARM.com Addr cacheBlockMask; 2262623SN/A protected: 2272623SN/A 22810030SAli.Saidi@ARM.com /** Snoop a coherence request, we need to check if this causes 22910030SAli.Saidi@ARM.com * a wakeup event on a cpu that is monitoring an address 23010030SAli.Saidi@ARM.com */ 23110030SAli.Saidi@ARM.com virtual void recvTimingSnoopReq(PacketPtr pkt); 23210529Smorr@cs.wisc.edu virtual void recvFunctionalSnoop(PacketPtr pkt); 23310030SAli.Saidi@ARM.com 2348975Sandreas.hansson@arm.com virtual bool recvTimingResp(PacketPtr pkt); 2352623SN/A 23610713Sandreas.hansson@arm.com virtual void recvReqRetry(); 2372948Ssaidi@eecs.umich.edu 23810529Smorr@cs.wisc.edu virtual bool isSnooping() const { 23910529Smorr@cs.wisc.edu return true; 24010529Smorr@cs.wisc.edu } 24110529Smorr@cs.wisc.edu 2422948Ssaidi@eecs.umich.edu struct DTickEvent : public TickEvent 2432948Ssaidi@eecs.umich.edu { 2442948Ssaidi@eecs.umich.edu DTickEvent(TimingSimpleCPU *_cpu) 2452948Ssaidi@eecs.umich.edu : TickEvent(_cpu) {} 2462948Ssaidi@eecs.umich.edu void process(); 2475336Shines@cs.fsu.edu const char *description() const { return "Timing CPU dcache tick"; } 2482948Ssaidi@eecs.umich.edu }; 2492948Ssaidi@eecs.umich.edu 2502948Ssaidi@eecs.umich.edu DTickEvent tickEvent; 2512948Ssaidi@eecs.umich.edu 2522623SN/A }; 2532623SN/A 25410464SAndreas.Sandberg@ARM.com void updateCycleCounts(); 25510464SAndreas.Sandberg@ARM.com 2562623SN/A IcachePort icachePort; 2572623SN/A DcachePort dcachePort; 2582623SN/A 2593349Sbinkertn@umich.edu PacketPtr ifetch_pkt; 2603349Sbinkertn@umich.edu PacketPtr dcache_pkt; 2612623SN/A 26210464SAndreas.Sandberg@ARM.com Cycles previousCycle; 2633170Sstever@eecs.umich.edu 2648850Sandreas.hansson@arm.com protected: 2658850Sandreas.hansson@arm.com 2668850Sandreas.hansson@arm.com /** Return a reference to the data port. */ 26714198Sgabeblack@google.com Port &getDataPort() override { return dcachePort; } 2688850Sandreas.hansson@arm.com 2698850Sandreas.hansson@arm.com /** Return a reference to the instruction port. */ 27014198Sgabeblack@google.com Port &getInstPort() override { return icachePort; } 2718850Sandreas.hansson@arm.com 2722623SN/A public: 2732623SN/A 27411168Sandreas.hansson@arm.com DrainState drain() override; 27511168Sandreas.hansson@arm.com void drainResume() override; 2762798Sktlim@umich.edu 27711169Sandreas.hansson@arm.com void switchOut() override; 27811169Sandreas.hansson@arm.com void takeOverFrom(BaseCPU *oldCPU) override; 2792623SN/A 28011169Sandreas.hansson@arm.com void verifyMemoryMode() const override; 2819523SAndreas.Sandberg@ARM.com 28211169Sandreas.hansson@arm.com void activateContext(ThreadID thread_num) override; 28311169Sandreas.hansson@arm.com void suspendContext(ThreadID thread_num) override; 2842623SN/A 28511608Snikos.nikoleris@arm.com Fault initiateMemRead(Addr addr, unsigned size, 28613954Sgiacomo.gabrielli@arm.com Request::Flags flags, 28713954Sgiacomo.gabrielli@arm.com const std::vector<bool>& byteEnable =std::vector<bool>()) 28813954Sgiacomo.gabrielli@arm.com override; 28911303Ssteve.reinhardt@amd.com 2908444Sgblack@eecs.umich.edu Fault writeMem(uint8_t *data, unsigned size, 29113954Sgiacomo.gabrielli@arm.com Addr addr, Request::Flags flags, uint64_t *res, 29213954Sgiacomo.gabrielli@arm.com const std::vector<bool>& byteEnable = std::vector<bool>()) 29313954Sgiacomo.gabrielli@arm.com override; 2947520Sgblack@eecs.umich.edu 29513652Sqtt2@cornell.edu Fault initiateMemAMO(Addr addr, unsigned size, Request::Flags flags, 29614297Sjordi.vaquero@metempsy.com AtomicOpFunctorPtr amo_op) override; 29713652Sqtt2@cornell.edu 2982623SN/A void fetch(); 29912749Sgiacomo.travaglini@arm.com void sendFetch(const Fault &fault, 30012749Sgiacomo.travaglini@arm.com const RequestPtr &req, ThreadContext *tc); 3013349Sbinkertn@umich.edu void completeIfetch(PacketPtr ); 3025894Sgblack@eecs.umich.edu void completeDataAccess(PacketPtr pkt); 30310379Sandreas.hansson@arm.com void advanceInst(const Fault &fault); 3044471Sstever@eecs.umich.edu 3059258SAli.Saidi@ARM.com /** This function is used by the page table walker to determine if it could 3069258SAli.Saidi@ARM.com * translate the a pending request or if the underlying request has been 3079258SAli.Saidi@ARM.com * squashed. This always returns false for the simple timing CPU as it never 3089258SAli.Saidi@ARM.com * executes any instructions speculatively. 3099258SAli.Saidi@ARM.com * @ return Is the current instruction squashed? 3109258SAli.Saidi@ARM.com */ 3119258SAli.Saidi@ARM.com bool isSquashed() const { return false; } 3129258SAli.Saidi@ARM.com 3135315Sstever@gmail.com /** 3145315Sstever@gmail.com * Print state of address in memory system via PrintReq (for 3155315Sstever@gmail.com * debugging). 3165315Sstever@gmail.com */ 3175315Sstever@gmail.com void printAddr(Addr a); 3185315Sstever@gmail.com 3196973Stjones1@inf.ed.ac.uk /** 3206973Stjones1@inf.ed.ac.uk * Finish a DTB translation. 3216973Stjones1@inf.ed.ac.uk * @param state The DTB translation state. 3226973Stjones1@inf.ed.ac.uk */ 3236973Stjones1@inf.ed.ac.uk void finishTranslation(WholeTranslationState *state); 3246973Stjones1@inf.ed.ac.uk 3252798Sktlim@umich.edu private: 3264471Sstever@eecs.umich.edu 32712085Sspwilson2@wisc.edu EventFunctionWrapper fetchEvent; 3284471Sstever@eecs.umich.edu 3295103Ssaidi@eecs.umich.edu struct IprEvent : Event { 3305103Ssaidi@eecs.umich.edu Packet *pkt; 3315103Ssaidi@eecs.umich.edu TimingSimpleCPU *cpu; 3325103Ssaidi@eecs.umich.edu IprEvent(Packet *_pkt, TimingSimpleCPU *_cpu, Tick t); 3335103Ssaidi@eecs.umich.edu virtual void process(); 3345336Shines@cs.fsu.edu virtual const char *description() const; 3355103Ssaidi@eecs.umich.edu }; 3365103Ssaidi@eecs.umich.edu 3379442SAndreas.Sandberg@ARM.com /** 3389442SAndreas.Sandberg@ARM.com * Check if a system is in a drained state. 3399442SAndreas.Sandberg@ARM.com * 3409442SAndreas.Sandberg@ARM.com * We need to drain if: 3419442SAndreas.Sandberg@ARM.com * <ul> 3429442SAndreas.Sandberg@ARM.com * <li>We are in the middle of a microcode sequence as some CPUs 3439442SAndreas.Sandberg@ARM.com * (e.g., HW accelerated CPUs) can't be started in the middle 3449442SAndreas.Sandberg@ARM.com * of a gem5 microcode sequence. 3459442SAndreas.Sandberg@ARM.com * 3469442SAndreas.Sandberg@ARM.com * <li>Stay at PC is true. 3479830Sandreas.hansson@arm.com * 3489830Sandreas.hansson@arm.com * <li>A fetch event is scheduled. Normally this would never be the 3499840Sandreas.hansson@arm.com * case with microPC() == 0, but right after a context is 3509840Sandreas.hansson@arm.com * activated it can happen. 3519442SAndreas.Sandberg@ARM.com * </ul> 3529442SAndreas.Sandberg@ARM.com */ 35314085Sgiacomo.travaglini@arm.com bool isCpuDrained() const { 35411147Smitch.hayenga@arm.com SimpleExecContext& t_info = *threadInfo[curThread]; 35511147Smitch.hayenga@arm.com SimpleThread* thread = t_info.thread; 35611147Smitch.hayenga@arm.com 35711147Smitch.hayenga@arm.com return thread->microPC() == 0 && !t_info.stayAtPC && 35811147Smitch.hayenga@arm.com !fetchEvent.scheduled(); 3599442SAndreas.Sandberg@ARM.com } 3609442SAndreas.Sandberg@ARM.com 3619442SAndreas.Sandberg@ARM.com /** 3629442SAndreas.Sandberg@ARM.com * Try to complete a drain request. 3639442SAndreas.Sandberg@ARM.com * 3649442SAndreas.Sandberg@ARM.com * @returns true if the CPU is drained, false otherwise. 3659442SAndreas.Sandberg@ARM.com */ 3669442SAndreas.Sandberg@ARM.com bool tryCompleteDrain(); 3672623SN/A}; 3682623SN/A 3692623SN/A#endif // __CPU_SIMPLE_TIMING_HH__ 370