src/cpu/inorder/resources/cache_unit.hh

   1 /*
   2  * Copyright (c) 2007 MIPS Technologies, Inc.
   3  * All rights reserved.
   4  *
   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.
  15  *
  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.
  27  *
  28  * Authors: Korey Sewell
  29  *
  30  */
  31
  32 #ifndef __CPU_INORDER_CACHE_UNIT_HH__
  33 #define __CPU_INORDER_CACHE_UNIT_HH__
  34
  35 #include <vector>
  36 #include <list>
  37 #include <string>
  38
  39 #include "arch/predecoder.hh"
  40 #include "arch/tlb.hh"
  41 #include "config/the_isa.hh"
  42 #include "cpu/inorder/inorder_dyn_inst.hh"
  43 #include "cpu/inorder/pipeline_traits.hh"
  44 #include "cpu/inorder/resource.hh"
  45 #include "mem/packet.hh"
  46 #include "mem/packet_access.hh"
  47 #include "mem/port.hh"
  48 #include "params/InOrderCPU.hh"
  49 #include "sim/sim_object.hh"
  50
  51 class CacheRequest;
  52 typedef CacheRequest* CacheReqPtr;
  53
  54 class CacheReqPacket;
  55 typedef CacheReqPacket* CacheReqPktPtr;
  56
  57 class CacheUnit : public Resource
  58 {
  59   public:
  60     typedef ThePipeline::DynInstPtr DynInstPtr;
  61
  62   public:
  63     CacheUnit(std::string res_name, int res_id, int res_width,
  64               int res_latency, InOrderCPU *_cpu, ThePipeline::Params *params);
  65     virtual ~CacheUnit() {}
  66
  67     enum Command {
  68         InitiateFetch,
  69         CompleteFetch,
  70         InitiateReadData,
  71         CompleteReadData,
  72         InitiateWriteData,
  73         CompleteWriteData,
  74         Fetch,
  75         ReadData,
  76         WriteData
  77     };
  78
  79   public:
  80     /** CachePort class for the Cache Unit.  Handles doing the
  81      * communication with the cache/memory.
  82      */
  83     class CachePort : public Port
  84     {
  85       protected:
  86         /** Pointer to cache port unit */
  87         CacheUnit *cachePortUnit;
  88
  89       public:
  90         /** Default constructor. */
  91         CachePort(CacheUnit *_cachePortUnit)
  92           : Port(_cachePortUnit->name() + "-cache-port",
  93                  (MemObject*)_cachePortUnit->cpu),
  94             cachePortUnit(_cachePortUnit)
  95         { }
  96
  97         bool snoopRangeSent;
  98
  99       protected:
 100         /** Atomic version of receive.  Panics. */
 101         virtual Tick recvAtomic(PacketPtr pkt);
 102
 103         /** Functional version of receive.  Panics. */
 104         virtual void recvFunctional(PacketPtr pkt);
 105
 106         /** Receives status change.  Other than range changing, panics. */
 107         virtual void recvStatusChange(Status status);
 108
 109         /** Returns the address ranges of this device. */
 110         virtual void getDeviceAddressRanges(AddrRangeList &resp,
 111                                             AddrRangeList &snoop)
 112         { resp.clear(); snoop.clear(); }
 113
 114         /** Timing version of receive. Handles setting fetch to the
 115          * proper status to start fetching. */
 116         virtual bool recvTiming(PacketPtr pkt);
 117
 118         /** Handles doing a retry of a failed fetch. */
 119         virtual void recvRetry();
 120     };
 121
 122     enum CachePortStatus {
 123         cacheWaitResponse,
 124         cacheWaitRetry,
 125         cacheAccessComplete
 126     };
 127
 128     void init();
 129
 130     virtual ResourceRequest* getRequest(DynInstPtr _inst, int stage_num,
 131                                         int res_idx, int slot_num,
 132                                         unsigned cmd);
 133
 134     void requestAgain(DynInstPtr inst, bool &try_request);
 135
 136     int getSlot(DynInstPtr inst);
 137
 138     void freeSlot(int slot_num);
 139
 140     /** Execute the function of this resource. The Default is action
 141      *  is to do nothing. More specific models will derive from this
 142      *  class and define their own execute function.
 143      */
 144     void execute(int slot_num);
 145
 146     void squash(DynInstPtr inst, int stage_num,
 147                 InstSeqNum squash_seq_num, ThreadID tid);
 148
 149     void squashDueToMemStall(DynInstPtr inst, int stage_num,
 150                              InstSeqNum squash_seq_num, ThreadID tid);
 151
 152     /** Processes cache completion event. */
 153     void processCacheCompletion(PacketPtr pkt);
 154
 155     void recvRetry();
 156
 157     /** Align a PC to the start of an I-cache block. */
 158     Addr cacheBlockAlignPC(Addr addr)
 159     {
 160         return (addr & ~(cacheBlkMask));
 161     }
 162
 163     /** Returns a specific port. */
 164     Port *getPort(const std::string &if_name, int idx);
 165
 166     template <class T>
 167     Fault read(DynInstPtr inst, Addr addr, T &data, unsigned flags);
 168
 169     template <class T>
 170     Fault write(DynInstPtr inst, T data, Addr addr, unsigned flags,
 171                         uint64_t *res);
 172
 173     Fault doTLBAccess(DynInstPtr inst, CacheReqPtr cache_req, int acc_size,
 174                       int flags,  TheISA::TLB::Mode tlb_mode);
 175
 176     /** Read/Write on behalf of an instruction.
 177      *  curResSlot needs to be a valid value in instruction.
 178      */
 179     Fault doCacheAccess(DynInstPtr inst, uint64_t *write_result=NULL);
 180
 181     void prefetch(DynInstPtr inst);
 182
 183     void writeHint(DynInstPtr inst);
 184
 185     uint64_t getMemData(Packet *packet);
 186
 187   protected:
 188     /** Cache interface. */
 189     CachePort *cachePort;
 190
 191     CachePortStatus cacheStatus;
 192
 193     CacheReqPtr retryReq;
 194
 195     PacketPtr retryPkt;
 196
 197     int retrySlot;
 198
 199     bool cacheBlocked;
 200
 201     std::vector<Addr> addrList[ThePipeline::MaxThreads];
 202
 203     std::map<Addr, InstSeqNum> addrMap[ThePipeline::MaxThreads];
 204
 205   public:
 206     int cacheBlkSize;
 207
 208     int cacheBlkMask;
 209
 210     /** Align a PC to the start of the Cache block. */
 211     Addr cacheBlockAlign(Addr addr)
 212     {
 213         return (addr & ~(cacheBlkMask));
 214     }
 215
 216     /** The mem line being fetched. */
 217     uint8_t *fetchData[ThePipeline::MaxThreads];
 218
 219     /** @TODO: Move functionaly of fetching more than
 220         one instruction to 'fetch unit'*/
 221     /** The Addr of the cacheline that has been loaded. */
 222     //Addr cacheBlockAddr[ThePipeline::MaxThreads];
 223     //unsigned fetchOffset[ThePipeline::MaxThreads];
 224
 225     TheISA::Predecoder predecoder;
 226
 227     bool tlbBlocked[ThePipeline::MaxThreads];
 228
 229     TheISA::TLB* tlb();
 230
 231     TheISA::TLB *_tlb;
 232 };
 233
 234 class CacheUnitEvent : public ResourceEvent {
 235   public:
 236     const std::string name() const
 237     {
 238         return "CacheUnitEvent";
 239     }
 240
 241
 242     /** Constructs a resource event. */
 243     CacheUnitEvent();
 244     virtual ~CacheUnitEvent() {}
 245
 246     /** Processes a resource event. */
 247     virtual void process();
 248 };
 249
 250 class CacheRequest : public ResourceRequest
 251 {
 252   public:
 253     CacheRequest(CacheUnit *cres, DynInstPtr inst, int stage_num, int res_idx,
 254                  int slot_num, unsigned cmd, int req_size,
 255                  MemCmd::Command pkt_cmd, unsigned flags, int cpu_id)
 256         : ResourceRequest(cres, inst, stage_num, res_idx, slot_num, cmd),
 257           pktCmd(pkt_cmd), memReq(NULL), reqData(NULL), dataPkt(NULL),
 258           retryPkt(NULL), memAccComplete(false), memAccPending(false),
 259           tlbStall(false)
 260     { }
 261
 262
 263     virtual ~CacheRequest()
 264     {
 265         if (reqData) {
 266             delete [] reqData;
 267         }
 268     }
 269
 270     virtual PacketDataPtr getData()
 271     {   return reqData; }
 272
 273     void
 274     setMemAccCompleted(bool completed = true)
 275     {
 276         memAccComplete = completed;
 277     }
 278
 279     bool isMemAccComplete() { return memAccComplete; }
 280
 281     void setMemAccPending(bool pending = true) { memAccPending = pending; }
 282     bool isMemAccPending() { return memAccPending; }
 283
 284     //Make this data private/protected!
 285     MemCmd::Command pktCmd;
 286     RequestPtr memReq;
 287     PacketDataPtr reqData;
 288     PacketPtr dataPkt;
 289     PacketPtr retryPkt;
 290
 291     bool memAccComplete;
 292     bool memAccPending;
 293     bool tlbStall;
 294 };
 295
 296 class CacheReqPacket : public Packet
 297 {
 298   public:
 299     CacheReqPacket(CacheRequest *_req,
 300                    Command _cmd, short _dest)
 301         : Packet(_req->memReq, _cmd, _dest), cacheReq(_req)
 302     {
 303
 304     }
 305
 306     CacheRequest *cacheReq;
 307 };
 308
 309 #endif //__CPU_CACHE_UNIT_HH__