annotate modules/bluespec/Pygar/lab4/InstCacheBlocking.bsv @ 13:6d461680c6d9 pygar svn.14

[svn r14] more stuff
author punk
date Tue, 27 Apr 2010 09:03:28 -0400
parents 74716e9a81cc
children 3958de09a7c1
rev   line source
rlm@8 1 // The MIT License
rlm@8 2
rlm@8 3 // Copyright (c) 2009 Massachusetts Institute of Technology
rlm@8 4
rlm@8 5 // Permission is hereby granted, free of charge, to any person obtaining a copy
rlm@8 6 // of this software and associated documentation files (the "Software"), to deal
rlm@8 7 // in the Software without restriction, including without limitation the rights
rlm@8 8 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
rlm@8 9 // copies of the Software, and to permit persons to whom the Software is
rlm@8 10 // furnished to do so, subject to the following conditions:
rlm@8 11
rlm@8 12 // The above copyright notice and this permission notice shall be included in
rlm@8 13 // all copies or substantial portions of the Software.
rlm@8 14
rlm@8 15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
rlm@8 16 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
rlm@8 17 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
rlm@8 18 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
rlm@8 19 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
rlm@8 20 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
rlm@8 21 // THE SOFTWARE.
rlm@8 22
rlm@8 23 import Connectable::*;
rlm@8 24 import GetPut::*;
rlm@8 25 import ClientServer::*;
rlm@8 26 import RegFile::*;
rlm@8 27 import FIFO::*;
rlm@8 28 import FIFOF::*;
rlm@8 29 import RWire::*;
rlm@8 30
rlm@8 31 // Local includes
rlm@8 32 `include "asim/provides/low_level_platform_interface.bsh"
rlm@8 33 `include "asim/provides/soft_connections.bsh"
rlm@8 34 `include "asim/provides/processor_library.bsh"
rlm@8 35 `include "asim/provides/fpga_components.bsh"
rlm@8 36 `include "asim/provides/common_services.bsh"
rlm@8 37 `include "asim/dict/STATS_INST_CACHE.bsh"
rlm@8 38
rlm@8 39 interface ICache#( type req_t, type resp_t );
rlm@8 40
rlm@8 41 // Interface from processor to cache
rlm@8 42 interface Server#(req_t,resp_t) proc_server;
rlm@8 43
rlm@8 44 // Interface from cache to main memory
rlm@8 45 interface Client#(MainMemReq,MainMemResp) mmem_client;
rlm@8 46
rlm@8 47 // Interface for enabling/disabling statistics
rlm@8 48 interface Put#(Bool) statsEn_put;
rlm@8 49
rlm@8 50 endinterface
rlm@8 51
rlm@8 52 //----------------------------------------------------------------------
rlm@8 53 // Cache Types
rlm@8 54 //----------------------------------------------------------------------
rlm@8 55
rlm@8 56 typedef 10 CacheLineIndexSz;
rlm@8 57 typedef 20 CacheLineTagSz;
rlm@8 58 typedef 32 CacheLineSz;
rlm@8 59
rlm@8 60 typedef Bit#(CacheLineIndexSz) CacheLineIndex;
rlm@8 61 typedef Bit#(CacheLineTagSz) CacheLineTag;
rlm@8 62 typedef Bit#(CacheLineSz) CacheLine;
rlm@8 63
rlm@8 64 typedef enum
rlm@8 65 {
rlm@8 66 Init,
rlm@8 67 Access,
rlm@8 68 Evict,
rlm@8 69 RefillReq,
rlm@8 70 RefillResp
rlm@8 71 }
rlm@8 72 CacheStage
rlm@8 73 deriving (Eq,Bits);
rlm@8 74
rlm@8 75 //----------------------------------------------------------------------
rlm@8 76 // Helper functions
rlm@8 77 //----------------------------------------------------------------------
rlm@8 78
rlm@8 79 function Bit#(AddrSz) getAddr( InstReq req );
rlm@8 80
rlm@8 81 Bit#(AddrSz) addr = ?;
rlm@8 82 case ( req ) matches
rlm@8 83 tagged LoadReq .ld : addr = ld.addr;
rlm@8 84 tagged StoreReq .st : addr = st.addr;
rlm@8 85 endcase
rlm@8 86
rlm@8 87 return addr;
rlm@8 88
rlm@8 89 endfunction
rlm@8 90
rlm@8 91 function CacheLineIndex getCacheLineIndex( InstReq req );
rlm@8 92 Bit#(AddrSz) addr = getAddr(req);
rlm@8 93 Bit#(CacheLineIndexSz) index = truncate( addr >> 2 );
rlm@8 94 return index;
rlm@8 95 endfunction
rlm@8 96
rlm@8 97 function CacheLineTag getCacheLineTag( InstReq req );
rlm@8 98 Bit#(AddrSz) addr = getAddr(req);
rlm@8 99 Bit#(CacheLineTagSz) tag = truncate( addr >> fromInteger(valueOf(CacheLineIndexSz)) >> 2 );
rlm@8 100 return tag;
rlm@8 101 endfunction
rlm@8 102
rlm@8 103 function Bit#(AddrSz) getCacheLineAddr( InstReq req );
rlm@8 104 Bit#(AddrSz) addr = getAddr(req);
rlm@8 105 return ((addr >> 2) << 2);
rlm@8 106 endfunction
rlm@8 107
rlm@8 108 //----------------------------------------------------------------------
rlm@8 109 // Main module
rlm@8 110 //----------------------------------------------------------------------
rlm@8 111
rlm@8 112 module [CONNECTED_MODULE] mkInstCache( ICache#(InstReq,InstResp) );
rlm@8 113
rlm@8 114 //-----------------------------------------------------------
rlm@8 115 // State
rlm@8 116
rlm@8 117 Reg#(CacheStage) stage <- mkReg(Init);
rlm@8 118
rlm@8 119 LUTRAM#(CacheLineIndex,Maybe#(CacheLineTag)) cacheTagRam <- mkLUTRAMU_RegFile();
rlm@8 120 LUTRAM#(CacheLineIndex,CacheLine) cacheDataRam <- mkLUTRAMU_RegFile();
rlm@8 121
rlm@8 122 FIFO#(InstReq) reqQ <- mkFIFO();
rlm@8 123 FIFOF#(InstResp) respQ <- mkBFIFOF1();
rlm@8 124
rlm@8 125 FIFO#(MainMemReq) mainMemReqQ <- mkBFIFO1();
rlm@8 126 FIFO#(MainMemResp) mainMemRespQ <- mkFIFO();
rlm@8 127
rlm@8 128 Reg#(CacheLineIndex) initCounter <- mkReg(1);
rlm@8 129
rlm@8 130 // Statistics state
rlm@8 131
rlm@8 132 Reg#(Bool) statsEn <- mkReg(False);
rlm@8 133
rlm@8 134 STAT num_accesses <- mkStatCounter(`STATS_INST_CACHE_NUM_ACCESSES);
rlm@8 135 STAT num_misses <- mkStatCounter(`STATS_INST_CACHE_NUM_MISSES);
rlm@8 136 STAT num_evictions <- mkStatCounter(`STATS_INST_CACHE_NUM_EVICTIONS);
rlm@8 137
rlm@8 138 //-----------------------------------------------------------
rlm@8 139 // Name some wires
rlm@8 140
rlm@8 141 let req = reqQ.first();
rlm@8 142 let reqIndex = getCacheLineIndex(req);
rlm@8 143 let reqTag = getCacheLineTag(req);
rlm@8 144 let reqCacheLineAddr = getCacheLineAddr(req);
rlm@8 145 let refill = mainMemRespQ.first();
rlm@8 146
rlm@8 147 //-----------------------------------------------------------
rlm@8 148 // Initialize
rlm@8 149
rlm@8 150 rule init ( stage == Init );
rlm@8 151 traceTiny("mkInstCacheBlocking", "stage","i");
rlm@8 152 initCounter <= initCounter + 1;
rlm@8 153 cacheTagRam.upd(initCounter,Invalid);
rlm@8 154 if ( initCounter == 0 )
rlm@8 155 stage <= Access;
rlm@8 156 endrule
rlm@8 157
rlm@8 158 //-----------------------------------------------------------
rlm@8 159 // Cache access rule
rlm@8 160
rlm@8 161 rule access ( (stage == Access) && respQ.notFull() );
rlm@8 162
rlm@8 163 // Statistics
rlm@8 164
rlm@8 165 if ( statsEn )
rlm@8 166 num_accesses.incr();
rlm@8 167
rlm@8 168 // Check tag and valid bit to see if this is a hit or a miss
rlm@8 169
rlm@8 170 Maybe#(CacheLineTag) cacheLineTag = cacheTagRam.sub(reqIndex);
rlm@8 171
rlm@8 172 // Handle cache hits ...
rlm@8 173
rlm@8 174 if ( isValid(cacheLineTag) && ( unJust(cacheLineTag) == reqTag ) )
rlm@8 175 begin
rlm@8 176 traceTiny("mkInstCacheBlocking", "hitMiss","h");
rlm@8 177 reqQ.deq();
rlm@8 178
rlm@8 179 case ( req ) matches
rlm@8 180
rlm@8 181 tagged LoadReq .ld :
rlm@8 182 respQ.enq( LoadResp { tag : ld.tag, data : cacheDataRam.sub(reqIndex) } );
rlm@8 183
rlm@8 184 tagged StoreReq .st :
rlm@8 185 $display( " RTL-ERROR : %m : Stores are not allowed on the inst port!" );
rlm@8 186
rlm@8 187 endcase
rlm@8 188
rlm@8 189 end
rlm@8 190
rlm@8 191 // Handle cache misses - since lines in instruction cache are
rlm@8 192 // never dirty we can always immediately issue a refill request
rlm@8 193
rlm@8 194 else
rlm@8 195 begin
rlm@8 196 traceTiny("mkInstCacheBlocking", "hitMiss","m");
rlm@8 197 if ( statsEn )
rlm@8 198 num_misses.incr();
rlm@8 199 if ( statsEn )
rlm@8 200 if ( isJust(cacheLineTag) )
rlm@8 201 num_evictions.incr();
rlm@8 202
rlm@8 203 MainMemReq rfReq
rlm@8 204 = LoadReq { tag : 0,
rlm@8 205 addr : reqCacheLineAddr };
rlm@8 206
rlm@8 207 mainMemReqQ.enq(rfReq);
rlm@8 208 stage <= RefillResp;
rlm@8 209 end
rlm@8 210
rlm@8 211 endrule
rlm@8 212
rlm@8 213 //-----------------------------------------------------------
rlm@8 214 // Refill response rule
rlm@8 215
rlm@8 216 rule refillResp ( stage == RefillResp );
rlm@8 217 traceTiny("mkInstCacheBlocking", "stage","R");
rlm@8 218 traceTiny("mkInstCacheBlocking", "refill",refill);
rlm@8 219
rlm@8 220 // Write the new data into the cache and update the tag
rlm@8 221
rlm@8 222 mainMemRespQ.deq();
rlm@8 223 case ( mainMemRespQ.first() ) matches
rlm@8 224
rlm@8 225 tagged LoadResp .ld :
rlm@8 226 begin
rlm@8 227 cacheTagRam.upd(reqIndex,Valid(reqTag));
rlm@8 228 cacheDataRam.upd(reqIndex,ld.data);
rlm@8 229 end
rlm@8 230
rlm@8 231 tagged StoreResp .st :
rlm@8 232 noAction;
rlm@8 233
rlm@8 234 endcase
rlm@8 235
rlm@8 236 stage <= Access;
rlm@8 237 endrule
rlm@8 238
rlm@8 239 //-----------------------------------------------------------
rlm@8 240 // Methods
rlm@8 241
rlm@8 242 interface Client mmem_client;
rlm@8 243 interface Get request = fifoToGet(mainMemReqQ);
rlm@8 244 interface Put response = fifoToPut(mainMemRespQ);
rlm@8 245 endinterface
rlm@8 246
rlm@8 247 interface Server proc_server;
rlm@8 248 interface Put request = tracePut("mkInstCacheBlocking", "reqTiny",fifoToPut(reqQ));
rlm@8 249 interface Get response = traceGet("mkInstCacheBlocking", "respTiny",fifofToGet(respQ));
rlm@8 250 endinterface
rlm@8 251
rlm@8 252 interface Put statsEn_put = regToPut(statsEn);
rlm@8 253
rlm@8 254 endmodule
rlm@8 255