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