xref: /XiangShan/src/main/scala/xiangshan/cache/dcache/mainpipe/MainPipe.scala (revision 3a6db8a39a25f02047d1fb2b257c89be0b2c36dc)
1/***************************************************************************************
2* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
3* Copyright (c) 2020-2021 Peng Cheng Laboratory
4*
5* XiangShan is licensed under Mulan PSL v2.
6* You can use this software according to the terms and conditions of the Mulan PSL v2.
7* You may obtain a copy of Mulan PSL v2 at:
8*          http://license.coscl.org.cn/MulanPSL2
9*
10* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
11* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
12* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
13*
14* See the Mulan PSL v2 for more details.
15***************************************************************************************/
16
17package xiangshan.cache
18
19import chipsalliance.rocketchip.config.Parameters
20import chisel3._
21import chisel3.util._
22import freechips.rocketchip.tilelink.ClientStates._
23import freechips.rocketchip.tilelink.MemoryOpCategories._
24import freechips.rocketchip.tilelink.TLPermissions._
25import freechips.rocketchip.tilelink.{ClientMetadata, ClientStates, TLPermissions}
26import utils._
27import xiangshan.L1CacheErrorInfo
28
29class MainPipeReq(implicit p: Parameters) extends DCacheBundle {
30  val miss = Bool() // only amo miss will refill in main pipe
31  val miss_id = UInt(log2Up(cfg.nMissEntries).W)
32  val miss_param = UInt(TLPermissions.bdWidth.W)
33  val miss_dirty = Bool()
34
35  val probe = Bool()
36  val probe_param = UInt(TLPermissions.bdWidth.W)
37  val probe_need_data = Bool()
38
39  // request info
40  // reqs from Store, AMO use this
41  // probe does not use this
42  val source = UInt(sourceTypeWidth.W)
43  val cmd = UInt(M_SZ.W)
44  // if dcache size > 32KB, vaddr is also needed for store
45  // vaddr is used to get extra index bits
46  val vaddr  = UInt(VAddrBits.W)
47  // must be aligned to block
48  val addr   = UInt(PAddrBits.W)
49
50  // store
51  val store_data = UInt((cfg.blockBytes * 8).W)
52  val store_mask = UInt(cfg.blockBytes.W)
53
54  // which word does amo work on?
55  val word_idx = UInt(log2Up(cfg.blockBytes * 8 / DataBits).W)
56  val amo_data   = UInt(DataBits.W)
57  val amo_mask   = UInt((DataBits / 8).W)
58
59  // replace
60  val replace = Bool()
61  val replace_way_en = UInt(DCacheWays.W)
62
63  val id = UInt(reqIdWidth.W)
64
65  def isLoad: Bool = source === LOAD_SOURCE.U
66  def isStore: Bool = source === STORE_SOURCE.U
67  def isAMO: Bool = source === AMO_SOURCE.U
68
69  def convertStoreReq(store: DCacheLineReq): MainPipeReq = {
70    val req = Wire(new MainPipeReq)
71    req := DontCare
72    req.miss := false.B
73    req.miss_dirty := false.B
74    req.probe := false.B
75    req.probe_need_data := false.B
76    req.source := STORE_SOURCE.U
77    req.cmd := store.cmd
78    req.addr := store.addr
79    req.vaddr := store.vaddr
80    req.store_data := store.data
81    req.store_mask := store.mask
82    req.replace := false.B
83    req.id := store.id
84    req
85  }
86}
87
88class MainPipe(implicit p: Parameters) extends DCacheModule with HasPerfEvents {
89  val io = IO(new Bundle() {
90    // probe queue
91    val probe_req = Flipped(DecoupledIO(new MainPipeReq))
92    // store miss go to miss queue
93    val miss_req = DecoupledIO(new MissReq)
94    // store buffer
95    val store_req = Flipped(DecoupledIO(new DCacheLineReq))
96    val store_replay_resp = ValidIO(new DCacheLineResp)
97    val store_hit_resp = ValidIO(new DCacheLineResp)
98    val release_update = ValidIO(new ReleaseUpdate)
99    // atmoics
100    val atomic_req = Flipped(DecoupledIO(new MainPipeReq))
101    val atomic_resp = ValidIO(new AtomicsResp)
102    // replace
103    val replace_req = Flipped(DecoupledIO(new MainPipeReq))
104    val replace_resp = ValidIO(UInt(log2Up(cfg.nMissEntries).W))
105    // write-back queue
106    val wb = DecoupledIO(new WritebackReq)
107
108    val data_read = DecoupledIO(new L1BankedDataReadLineReq)
109    val data_resp = Input(Vec(DCacheBanks, new L1BankedDataReadResult()))
110    val readline_error = Input(Bool())
111    val data_write = DecoupledIO(new L1BankedDataWriteReq)
112
113    val meta_read = DecoupledIO(new MetaReadReq)
114    val meta_resp = Input(Vec(nWays, new Meta))
115    val meta_write = DecoupledIO(new MetaWriteReq)
116    val error_flag_resp = Input(Vec(nWays, Bool()))
117    val error_flag_write = DecoupledIO(new ErrorWriteReq)
118
119    val tag_read = DecoupledIO(new TagReadReq)
120    val tag_resp = Input(Vec(nWays, UInt(encTagBits.W)))
121    val tag_write = DecoupledIO(new TagWriteReq)
122
123    // update state vec in replacement algo
124    val replace_access = ValidIO(new ReplacementAccessBundle)
125    // find the way to be replaced
126    val replace_way = new ReplacementWayReqIO
127
128    val status = new Bundle() {
129      val s0_set = ValidIO(UInt(idxBits.W))
130      val s1, s2, s3 = ValidIO(new Bundle() {
131        val set = UInt(idxBits.W)
132        val way_en = UInt(nWays.W)
133      })
134    }
135
136    // lrsc locked block should block probe
137    val lrsc_locked_block = Output(Valid(UInt(PAddrBits.W)))
138    val invalid_resv_set = Input(Bool())
139    val update_resv_set = Output(Bool())
140    val block_lr = Output(Bool())
141
142    // ecc error
143    val error = Output(new L1CacheErrorInfo())
144  })
145
146  // meta array is made of regs, so meta write or read should always be ready
147  assert(RegNext(io.meta_read.ready))
148  assert(RegNext(io.meta_write.ready))
149
150  val s1_s0_set_conflict, s2_s0_set_conlict, s3_s0_set_conflict = Wire(Bool())
151  val set_conflict = s1_s0_set_conflict || s2_s0_set_conlict || s3_s0_set_conflict
152  // check sbuffer store req set_conflict in parallel with req arbiter
153  // it will speed up the generation of store_req.ready, which is in crit. path
154  val s1_s0_set_conflict_store, s2_s0_set_conlict_store, s3_s0_set_conflict_store = Wire(Bool())
155  val store_set_conflict = s1_s0_set_conflict_store || s2_s0_set_conlict_store || s3_s0_set_conflict_store
156  val s1_ready, s2_ready, s3_ready = Wire(Bool())
157
158  // convert store req to main pipe req, and select a req from store and probe
159  val store_req = Wire(DecoupledIO(new MainPipeReq))
160  store_req.bits := (new MainPipeReq).convertStoreReq(io.store_req.bits)
161  store_req.valid := io.store_req.valid
162  io.store_req.ready := store_req.ready
163
164  // s0: read meta and tag
165  val req = Wire(DecoupledIO(new MainPipeReq))
166  arbiter(
167    in = Seq(
168      io.probe_req,
169      io.replace_req,
170      store_req, // Note: store_req.ready is now manually assigned for better timing
171      io.atomic_req
172    ),
173    out = req,
174    name = Some("main_pipe_req")
175  )
176
177  val store_idx = get_idx(io.store_req.bits.vaddr)
178  // manually assign store_req.ready for better timing
179  // now store_req set conflict check is done in parallel with req arbiter
180  store_req.ready := io.meta_read.ready && io.tag_read.ready && s1_ready && !store_set_conflict &&
181    !io.probe_req.valid && !io.replace_req.valid
182  val s0_req = req.bits
183  val s0_idx = get_idx(s0_req.vaddr)
184  val s0_can_go = io.meta_read.ready && io.tag_read.ready && s1_ready && !set_conflict
185  val s0_fire = req.valid && s0_can_go
186
187  val bank_write = VecInit((0 until DCacheBanks).map(i => get_mask_of_bank(i, s0_req.store_mask).orR)).asUInt
188  val bank_full_write = VecInit((0 until DCacheBanks).map(i => get_mask_of_bank(i, s0_req.store_mask).andR)).asUInt
189  val banks_full_overwrite = bank_full_write.andR
190
191  val banked_store_rmask = bank_write & ~bank_full_write
192  val banked_full_rmask = ~0.U(DCacheBanks.W)
193  val banked_none_rmask = 0.U(DCacheBanks.W)
194
195  val store_need_data = !s0_req.probe && s0_req.isStore && banked_store_rmask.orR
196  val probe_need_data = s0_req.probe
197  val amo_need_data = !s0_req.probe && s0_req.isAMO
198  val miss_need_data = s0_req.miss
199  val replace_need_data = s0_req.replace
200
201  val banked_need_data = store_need_data || probe_need_data || amo_need_data || miss_need_data || replace_need_data
202
203  val s0_banked_rmask = Mux(store_need_data, banked_store_rmask,
204    Mux(probe_need_data || amo_need_data || miss_need_data || replace_need_data,
205      banked_full_rmask,
206      banked_none_rmask
207    ))
208
209  // generate wmask here and use it in stage 2
210  val banked_store_wmask = bank_write
211  val banked_full_wmask = ~0.U(DCacheBanks.W)
212  val banked_none_wmask = 0.U(DCacheBanks.W)
213
214  // s1: read data
215  val s1_valid = RegInit(false.B)
216  val s1_need_data = RegEnable(banked_need_data, s0_fire)
217  val s1_req = RegEnable(s0_req, s0_fire)
218  val s1_banked_rmask = RegEnable(s0_banked_rmask, s0_fire)
219  val s1_banked_store_wmask = RegEnable(banked_store_wmask, s0_fire)
220  val s1_can_go = s2_ready && (io.data_read.ready || !s1_need_data)
221  val s1_fire = s1_valid && s1_can_go
222  val s1_idx = get_idx(s1_req.vaddr)
223  when (s0_fire) {
224    s1_valid := true.B
225  }.elsewhen (s1_fire) {
226    s1_valid := false.B
227  }
228  s1_ready := !s1_valid || s1_can_go
229  s1_s0_set_conflict := s1_valid && s0_idx === s1_idx
230  s1_s0_set_conflict_store := s1_valid && store_idx === s1_idx
231
232  val meta_resp = Wire(Vec(nWays, (new Meta).asUInt()))
233  val tag_resp = Wire(Vec(nWays, UInt(tagBits.W)))
234  val ecc_resp = Wire(Vec(nWays, UInt(eccTagBits.W)))
235  meta_resp := Mux(RegNext(s0_fire), VecInit(io.meta_resp.map(_.asUInt)), RegNext(meta_resp))
236  tag_resp := Mux(RegNext(s0_fire), VecInit(io.tag_resp.map(r => r(tagBits - 1, 0))), RegNext(tag_resp))
237  ecc_resp := Mux(RegNext(s0_fire), VecInit(io.tag_resp.map(r => r(encTagBits - 1, tagBits))), RegNext(ecc_resp))
238  val enc_tag_resp = Wire(io.tag_resp.cloneType)
239  enc_tag_resp := Mux(RegNext(s0_fire), io.tag_resp, RegNext(enc_tag_resp))
240
241  def wayMap[T <: Data](f: Int => T) = VecInit((0 until nWays).map(f))
242  val s1_tag_eq_way = wayMap((w: Int) => tag_resp(w) === get_tag(s1_req.addr)).asUInt
243  val s1_tag_match_way = wayMap((w: Int) => s1_tag_eq_way(w) && Meta(meta_resp(w)).coh.isValid()).asUInt
244  val s1_tag_match = s1_tag_match_way.orR
245
246  val s1_hit_tag = Mux(s1_tag_match, Mux1H(s1_tag_match_way, wayMap(w => tag_resp(w))), get_tag(s1_req.addr))
247  val s1_hit_coh = ClientMetadata(Mux(s1_tag_match, Mux1H(s1_tag_match_way, wayMap(w => meta_resp(w))), 0.U))
248  val s1_encTag = Mux1H(s1_tag_match_way, wayMap((w: Int) => enc_tag_resp(w)))
249  val s1_flag_error = Mux(s1_tag_match, Mux1H(s1_tag_match_way, wayMap(w => io.error_flag_resp(w))), false.B)
250  val s1_tag_error = dcacheParameters.tagCode.decode(s1_encTag).error
251
252  // replacement policy
253  val s1_repl_way_en = WireInit(0.U(nWays.W))
254  s1_repl_way_en := Mux(RegNext(s0_fire), UIntToOH(io.replace_way.way), RegNext(s1_repl_way_en))
255  val s1_repl_tag = Mux1H(s1_repl_way_en, wayMap(w => tag_resp(w)))
256  val s1_repl_coh = Mux1H(s1_repl_way_en, wayMap(w => meta_resp(w))).asTypeOf(new ClientMetadata)
257
258  val s1_need_replacement = (s1_req.miss || s1_req.isStore && !s1_req.probe) && !s1_tag_match
259  val s1_way_en = Mux(s1_req.replace, s1_req.replace_way_en, Mux(s1_need_replacement, s1_repl_way_en, s1_tag_match_way))
260  val s1_tag = Mux(s1_req.replace, get_tag(s1_req.addr), Mux(s1_need_replacement, s1_repl_tag, s1_hit_tag))
261  val s1_coh = Mux(
262    s1_req.replace,
263    Mux1H(s1_req.replace_way_en, meta_resp.map(ClientMetadata(_))),
264    Mux(s1_need_replacement, s1_repl_coh, s1_hit_coh)
265  )
266
267  val s1_has_permission = s1_hit_coh.onAccess(s1_req.cmd)._1
268  val s1_hit = s1_tag_match && s1_has_permission
269  val s1_pregen_can_go_to_mq = !s1_req.replace && !s1_req.probe && !s1_req.miss && (s1_req.isStore || s1_req.isAMO) && !s1_hit
270
271  // s2: select data, return resp if this is a store miss
272  val s2_valid = RegInit(false.B)
273  val s2_req = RegEnable(s1_req, s1_fire)
274  val s2_tag_match = RegEnable(s1_tag_match, s1_fire)
275  val s2_hit_coh = RegEnable(s1_hit_coh, s1_fire)
276  val (s2_has_permission, _, s2_new_hit_coh) = s2_hit_coh.onAccess(s2_req.cmd)
277  val s2_repl_way_en = RegEnable(s1_repl_way_en, s1_fire)
278  val s2_repl_tag = RegEnable(s1_repl_tag, s1_fire)
279  val s2_repl_coh = RegEnable(s1_repl_coh, s1_fire)
280  val s2_need_replacement = RegEnable(s1_need_replacement, s1_fire)
281  val s2_need_data = RegEnable(s1_need_data, s1_fire)
282  val s2_idx = get_idx(s2_req.vaddr)
283  val s2_way_en = RegEnable(s1_way_en, s1_fire)
284  val s2_tag = RegEnable(s1_tag, s1_fire)
285  val s2_coh = RegEnable(s1_coh, s1_fire)
286  val s2_banked_store_wmask = RegEnable(s1_banked_store_wmask, s1_fire)
287  val s2_flag_error = RegEnable(s1_flag_error, s1_fire)
288  val s2_tag_error = RegEnable(s1_tag_error, s1_fire)
289  // s2_data_error will be reported by data array
290  val s2_data_error = io.readline_error && s2_need_data && s2_coh.state =/= ClientStates.Nothing
291  val s2_error = s2_flag_error || s2_tag_error || s2_data_error
292
293  val s2_hit = s2_tag_match && s2_has_permission
294  val s2_amo_hit = s2_hit && !s2_req.probe && !s2_req.miss && s2_req.isAMO
295  val s2_store_hit = s2_hit && !s2_req.probe && !s2_req.miss && s2_req.isStore
296
297  s2_s0_set_conlict := s2_valid && s0_idx === s2_idx
298  s2_s0_set_conlict_store := s2_valid && store_idx === s2_idx
299
300  // For a store req, it either hits and goes to s3, or miss and enter miss queue immediately
301  val s2_can_go_to_s3 = (s2_req.replace || s2_req.probe || s2_req.miss || (s2_req.isStore || s2_req.isAMO) && s2_hit) && s3_ready
302  val s2_can_go_to_mq = RegEnable(s1_pregen_can_go_to_mq, s1_fire)
303  assert(RegNext(!(s2_valid && s2_can_go_to_s3 && s2_can_go_to_mq)))
304  val s2_can_go = s2_can_go_to_s3 || s2_can_go_to_mq
305  val s2_fire = s2_valid && s2_can_go
306  val s2_fire_to_s3 = s2_valid && s2_can_go_to_s3
307  when (s1_fire) {
308    s2_valid := true.B
309  }.elsewhen (s2_fire) {
310    s2_valid := false.B
311  }
312  s2_ready := !s2_valid || s2_can_go
313  val replay = !io.miss_req.ready
314
315  val data_resp = Wire(io.data_resp.cloneType)
316  data_resp := Mux(RegNext(s1_fire), io.data_resp, RegNext(data_resp))
317  val s2_store_data_merged = Wire(Vec(DCacheBanks, UInt(DCacheSRAMRowBits.W)))
318
319  def mergePutData(old_data: UInt, new_data: UInt, wmask: UInt): UInt = {
320    val full_wmask = FillInterleaved(8, wmask)
321    ((~full_wmask & old_data) | (full_wmask & new_data))
322  }
323
324  val s2_data = WireInit(VecInit((0 until DCacheBanks).map(i => {
325    data_resp(i).raw_data
326  })))
327
328  for (i <- 0 until DCacheBanks) {
329    val old_data = s2_data(i)
330    val new_data = get_data_of_bank(i, s2_req.store_data)
331    // for amo hit, we should use read out SRAM data
332    // do not merge with store data
333    val wmask = Mux(s2_amo_hit, 0.U(wordBytes.W), get_mask_of_bank(i, s2_req.store_mask))
334    s2_store_data_merged(i) := mergePutData(old_data, new_data, wmask)
335  }
336
337  val s2_data_word = s2_store_data_merged(s2_req.word_idx)
338
339  // s3: write data, meta and tag
340  val s3_valid = RegInit(false.B)
341  val s3_req = RegEnable(s2_req, s2_fire_to_s3)
342  val s3_idx = get_idx(s3_req.vaddr)
343  val s3_tag = RegEnable(s2_tag, s2_fire_to_s3)
344  val s3_tag_match = RegEnable(s2_tag_match, s2_fire_to_s3)
345  val s3_coh = RegEnable(s2_coh, s2_fire_to_s3)
346  val s3_hit = RegEnable(s2_hit, s2_fire_to_s3)
347  val s3_amo_hit = RegEnable(s2_amo_hit, s2_fire_to_s3)
348  val s3_store_hit = RegEnable(s2_store_hit, s2_fire_to_s3)
349  val s3_hit_coh = RegEnable(s2_hit_coh, s2_fire_to_s3)
350  val s3_new_hit_coh = RegEnable(s2_new_hit_coh, s2_fire_to_s3)
351  val s3_way_en = RegEnable(s2_way_en, s2_fire_to_s3)
352  val s3_banked_store_wmask = RegEnable(s2_banked_store_wmask, s2_fire_to_s3)
353  val s3_store_data_merged = RegEnable(s2_store_data_merged, s2_fire_to_s3)
354  val s3_data_word = RegEnable(s2_data_word, s2_fire_to_s3)
355  val s3_data = RegEnable(s2_data, s2_fire_to_s3)
356  val s3_error = RegEnable(s2_error, s2_fire_to_s3)
357  val (probe_has_dirty_data, probe_shrink_param, probe_new_coh) = s3_coh.onProbe(s3_req.probe_param)
358  val s3_need_replacement = RegEnable(s2_need_replacement, s2_fire_to_s3)
359
360  val miss_update_meta = s3_req.miss
361  val probe_update_meta = s3_req.probe && s3_tag_match && s3_coh =/= probe_new_coh
362  val store_update_meta = s3_req.isStore && !s3_req.probe && s3_hit_coh =/= s3_new_hit_coh
363  val amo_update_meta = s3_req.isAMO && !s3_req.probe && s3_hit_coh =/= s3_new_hit_coh
364  val amo_wait_amoalu = s3_req.isAMO && s3_req.cmd =/= M_XLR && s3_req.cmd =/= M_XSC
365  val update_meta = (miss_update_meta || probe_update_meta || store_update_meta || amo_update_meta) && !s3_req.replace
366
367  def missCohGen(cmd: UInt, param: UInt, dirty: Bool) = {
368    val c = categorize(cmd)
369    MuxLookup(Cat(c, param, dirty), Nothing, Seq(
370      //(effect param) -> (next)
371      Cat(rd, toB, false.B)  -> Branch,
372      Cat(rd, toB, true.B)   -> Branch,
373      Cat(rd, toT, false.B)  -> Trunk,
374      Cat(rd, toT, true.B)   -> Dirty,
375      Cat(wi, toT, false.B)  -> Trunk,
376      Cat(wi, toT, true.B)   -> Dirty,
377      Cat(wr, toT, false.B)  -> Dirty,
378      Cat(wr, toT, true.B)   -> Dirty))
379  }
380  val miss_new_coh = ClientMetadata(missCohGen(s3_req.cmd, s3_req.miss_param, s3_req.miss_dirty))
381
382  val new_coh = Mux(
383    miss_update_meta,
384    miss_new_coh,
385    Mux(
386      probe_update_meta,
387      probe_new_coh,
388      Mux(
389        store_update_meta || amo_update_meta,
390        s3_new_hit_coh,
391        ClientMetadata.onReset
392      )
393    )
394  )
395
396  // LR, SC and AMO
397  val debug_sc_fail_addr = RegInit(0.U)
398  val debug_sc_fail_cnt  = RegInit(0.U(8.W))
399
400  val lrsc_count = RegInit(0.U(log2Ceil(LRSCCycles).W))
401  val lrsc_valid = lrsc_count > LRSCBackOff.U
402  val lrsc_addr  = Reg(UInt())
403  val s3_lr = !s3_req.probe && s3_req.isAMO && s3_req.cmd === M_XLR
404  val s3_sc = !s3_req.probe && s3_req.isAMO && s3_req.cmd === M_XSC
405  val s3_lrsc_addr_match = lrsc_valid && lrsc_addr === get_block_addr(s3_req.addr)
406  val s3_sc_fail = s3_sc && !s3_lrsc_addr_match
407  val s3_sc_resp = Mux(s3_sc_fail, 1.U, 0.U)
408
409  val s3_can_do_amo = (s3_req.miss && !s3_req.probe && s3_req.source === AMO_SOURCE.U) || s3_amo_hit
410  val s3_can_do_amo_write = s3_can_do_amo && isWrite(s3_req.cmd) && !s3_sc_fail
411
412  when (s3_valid && (s3_lr || s3_sc)) {
413    when (s3_can_do_amo && s3_lr) {
414      lrsc_count := (LRSCCycles - 1).U
415      lrsc_addr := get_block_addr(s3_req.addr)
416    } .otherwise {
417      lrsc_count := 0.U
418    }
419  } .elsewhen (lrsc_count > 0.U) {
420    lrsc_count := lrsc_count - 1.U
421  }
422
423  io.lrsc_locked_block.valid := lrsc_valid
424  io.lrsc_locked_block.bits  := lrsc_addr
425  io.block_lr := RegNext(lrsc_count > 0.U)
426
427  // When we update update_resv_set, block all probe req in the next cycle
428  // It should give Probe reservation set addr compare an independent cycle,
429  // which will lead to better timing
430  io.update_resv_set := s3_valid && s3_lr && s3_can_do_amo
431
432  // when we release this block,
433  // we invalidate this reservation set
434  when (io.invalid_resv_set) {
435    lrsc_count := 0.U
436  }
437
438  when (s3_valid) {
439    when (s3_req.addr === debug_sc_fail_addr) {
440      when (s3_sc_fail) {
441        debug_sc_fail_cnt := debug_sc_fail_cnt + 1.U
442      } .elsewhen (s3_sc) {
443        debug_sc_fail_cnt := 0.U
444      }
445    } .otherwise {
446      when (s3_sc_fail) {
447        debug_sc_fail_addr := s3_req.addr
448        debug_sc_fail_cnt  := 1.U
449      }
450    }
451  }
452  assert(debug_sc_fail_cnt < 100.U, "L1DCache failed too many SCs in a row")
453
454
455  val banked_amo_wmask = UIntToOH(s3_req.word_idx)
456//  val banked_wmask = s3_banked_store_wmask
457  val banked_wmask = Mux(
458    s3_req.miss,
459    banked_full_wmask,
460    Mux(
461      s3_store_hit,
462      s3_banked_store_wmask,
463      Mux(
464        s3_can_do_amo_write,
465        banked_amo_wmask,
466        banked_none_wmask
467      )
468    )
469  )
470  val update_data = s3_req.miss || s3_store_hit || s3_can_do_amo_write
471  assert(!(banked_wmask.orR && !update_data))
472
473  // generate write data
474  // AMO hits
475  val s3_s_amoalu = RegInit(false.B)
476  val do_amoalu = amo_wait_amoalu && s3_valid && !s3_s_amoalu
477  val amoalu   = Module(new AMOALU(wordBits))
478  amoalu.io.mask := s3_req.amo_mask
479  amoalu.io.cmd  := s3_req.cmd
480  amoalu.io.lhs  := s3_data_word
481  amoalu.io.rhs  := s3_req.amo_data
482
483  // merge amo write data
484//  val amo_bitmask = FillInterleaved(8, s3_req.amo_mask)
485  val s3_amo_data_merged = Wire(Vec(DCacheBanks, UInt(DCacheSRAMRowBits.W)))
486  val s3_sc_data_merged = Wire(Vec(DCacheBanks, UInt(DCacheSRAMRowBits.W)))
487  for (i <- 0 until DCacheBanks) {
488    val old_data = s3_store_data_merged(i)
489    val new_data = amoalu.io.out
490    val wmask = Mux(
491      s3_req.word_idx === i.U,
492      ~0.U(wordBytes.W),
493      0.U(wordBytes.W)
494    )
495    s3_amo_data_merged(i) := mergePutData(old_data, new_data, wmask)
496//    s3_sc_data_merged(i) := amo_bitmask & s3_req.amo_data | ~amo_bitmask & old_data
497    s3_sc_data_merged(i) := mergePutData(old_data, s3_req.amo_data,
498      Mux(s3_req.word_idx === i.U && !s3_sc_fail, s3_req.amo_mask, 0.U(wordBytes.W))
499    )
500  }
501  val s3_amo_data_merged_reg = RegEnable(s3_amo_data_merged, do_amoalu)
502  when(do_amoalu){
503    s3_s_amoalu := true.B
504  }
505
506  val miss_wb = s3_req.miss && s3_need_replacement && s3_coh.state =/= ClientStates.Nothing
507  val probe_wb = s3_req.probe
508  val replace_wb = s3_req.replace
509  val need_wb = miss_wb || probe_wb || replace_wb
510
511  val (_, miss_shrink_param, _) = s3_coh.onCacheControl(M_FLUSH)
512  val writeback_param = Mux(probe_wb, probe_shrink_param, miss_shrink_param)
513  val writeback_data = if (dcacheParameters.alwaysReleaseData) {
514    s3_tag_match && s3_req.probe && s3_req.probe_need_data ||
515      s3_coh === ClientStates.Dirty || (miss_wb || replace_wb) && s3_coh.state =/= ClientStates.Nothing
516  } else {
517    s3_tag_match && s3_req.probe && s3_req.probe_need_data || s3_coh === ClientStates.Dirty
518  }
519
520  val s3_probe_can_go = s3_req.probe && io.wb.ready && (io.meta_write.ready || !probe_update_meta)
521  val s3_store_can_go = s3_req.isStore && !s3_req.probe && (io.meta_write.ready || !store_update_meta) && (io.data_write.ready || !update_data)
522  val s3_amo_can_go = s3_amo_hit && (io.meta_write.ready || !amo_update_meta) && (io.data_write.ready || !update_data) && (s3_s_amoalu || !amo_wait_amoalu)
523  val s3_miss_can_go = s3_req.miss &&
524    (io.meta_write.ready || !amo_update_meta) &&
525    (io.data_write.ready || !update_data) &&
526    (s3_s_amoalu || !amo_wait_amoalu) &&
527    io.tag_write.ready &&
528    io.wb.ready
529  val s3_replace_nothing = s3_req.replace && s3_coh.state === ClientStates.Nothing
530  val s3_replace_can_go = s3_req.replace && (s3_replace_nothing || io.wb.ready)
531  val s3_can_go = s3_probe_can_go || s3_store_can_go || s3_amo_can_go || s3_miss_can_go || s3_replace_can_go
532  val s3_update_data_cango = s3_store_can_go || s3_amo_can_go || s3_miss_can_go // used to speed up data_write gen
533  val s3_fire = s3_valid && s3_can_go
534  when (s2_fire_to_s3) {
535    s3_valid := true.B
536  }.elsewhen (s3_fire) {
537    s3_valid := false.B
538  }
539  s3_ready := !s3_valid || s3_can_go
540  s3_s0_set_conflict := s3_valid && s3_idx === s0_idx
541  s3_s0_set_conflict_store := s3_valid && s3_idx === store_idx
542  assert(RegNext(!s3_valid || !(s3_req.isStore && !s3_req.probe) || s3_hit)) // miss store should never come to s3
543
544  when(s3_fire) {
545    s3_s_amoalu := false.B
546  }
547
548  req.ready := s0_can_go
549
550  io.meta_read.valid := req.valid && s1_ready && !set_conflict
551  io.meta_read.bits.idx := get_idx(s0_req.vaddr)
552  io.meta_read.bits.way_en := Mux(s0_req.replace, s0_req.replace_way_en, ~0.U(nWays.W))
553
554  io.tag_read.valid := req.valid && s1_ready && !set_conflict && !s0_req.replace
555  io.tag_read.bits.idx := get_idx(s0_req.vaddr)
556  io.tag_read.bits.way_en := ~0.U(nWays.W)
557
558  io.data_read.valid := s1_valid && s1_need_data && s2_ready
559  io.data_read.bits.rmask := s1_banked_rmask
560  io.data_read.bits.way_en := s1_way_en
561  io.data_read.bits.addr := s1_req.vaddr
562
563  io.miss_req.valid := s2_valid && s2_can_go_to_mq
564  val miss_req = io.miss_req.bits
565  miss_req := DontCare
566  miss_req.source := s2_req.source
567  miss_req.cmd := s2_req.cmd
568  miss_req.addr := s2_req.addr
569  miss_req.vaddr := s2_req.vaddr
570  miss_req.way_en := s2_way_en
571  miss_req.store_data := s2_req.store_data
572  miss_req.store_mask := s2_req.store_mask
573  miss_req.word_idx := s2_req.word_idx
574  miss_req.amo_data := s2_req.amo_data
575  miss_req.amo_mask := s2_req.amo_mask
576  miss_req.req_coh := s2_hit_coh
577  miss_req.replace_coh := s2_repl_coh
578  miss_req.replace_tag := s2_repl_tag
579  miss_req.id := s2_req.id
580  miss_req.cancel := false.B
581
582  io.store_replay_resp.valid := s2_valid && s2_can_go_to_mq && replay && s2_req.isStore
583  io.store_replay_resp.bits.data := DontCare
584  io.store_replay_resp.bits.miss := true.B
585  io.store_replay_resp.bits.replay := true.B
586  io.store_replay_resp.bits.id := s2_req.id
587
588  io.store_hit_resp.valid := s3_valid && s3_store_can_go
589  io.store_hit_resp.bits.data := DontCare
590  io.store_hit_resp.bits.miss := false.B
591  io.store_hit_resp.bits.replay := false.B
592  io.store_hit_resp.bits.id := s3_req.id
593
594  io.release_update.valid := s3_valid && (s3_store_can_go || s3_amo_can_go) && s3_hit && update_data
595  io.release_update.bits.addr := s3_req.addr
596  io.release_update.bits.mask := Mux(s3_store_hit, s3_banked_store_wmask, banked_amo_wmask)
597  io.release_update.bits.data := Mux(
598    amo_wait_amoalu,
599    s3_amo_data_merged_reg,
600    Mux(
601      s3_sc,
602      s3_sc_data_merged,
603      s3_store_data_merged
604    )
605  ).asUInt
606
607  val atomic_hit_resp = Wire(new AtomicsResp)
608  atomic_hit_resp.data := Mux(s3_sc, s3_sc_resp, s3_data_word)
609  atomic_hit_resp.miss := false.B
610  atomic_hit_resp.miss_id := s3_req.miss_id
611  atomic_hit_resp.error := s3_error
612  atomic_hit_resp.replay := false.B
613  atomic_hit_resp.ack_miss_queue := s3_req.miss
614  atomic_hit_resp.id := lrsc_valid
615  val atomic_replay_resp = Wire(new AtomicsResp)
616  atomic_replay_resp.data := DontCare
617  atomic_replay_resp.miss := true.B
618  atomic_replay_resp.miss_id := DontCare
619  atomic_replay_resp.error := false.B
620  atomic_replay_resp.replay := true.B
621  atomic_replay_resp.ack_miss_queue := false.B
622  atomic_replay_resp.id := DontCare
623  val atomic_replay_resp_valid = s2_valid && s2_can_go_to_mq && replay && s2_req.isAMO
624  val atomic_hit_resp_valid = s3_valid && (s3_amo_can_go || s3_miss_can_go && s3_req.isAMO)
625  io.atomic_resp.valid := atomic_replay_resp_valid || atomic_hit_resp_valid
626  io.atomic_resp.bits := Mux(atomic_replay_resp_valid, atomic_replay_resp, atomic_hit_resp)
627
628  io.replace_resp.valid := s3_fire && s3_req.replace
629  io.replace_resp.bits := s3_req.miss_id
630
631  io.meta_write.valid := s3_fire && update_meta
632  io.meta_write.bits.idx := s3_idx
633  io.meta_write.bits.way_en := s3_way_en
634  io.meta_write.bits.meta.coh := new_coh
635
636  io.error_flag_write.valid := s3_fire && update_meta
637  io.error_flag_write.bits.idx := s3_idx
638  io.error_flag_write.bits.way_en := s3_way_en
639  io.error_flag_write.bits.error := s3_error
640
641  io.tag_write.valid := s3_fire && s3_req.miss
642  io.tag_write.bits.idx := s3_idx
643  io.tag_write.bits.way_en := s3_way_en
644  io.tag_write.bits.tag := get_tag(s3_req.addr)
645
646  io.data_write.valid := s3_valid && s3_update_data_cango && update_data
647  io.data_write.bits.way_en := s3_way_en
648  io.data_write.bits.addr := s3_req.vaddr
649  io.data_write.bits.wmask := banked_wmask
650  io.data_write.bits.data := Mux(
651    amo_wait_amoalu,
652    s3_amo_data_merged_reg,
653    Mux(
654      s3_sc,
655      s3_sc_data_merged,
656      s3_store_data_merged
657    )
658  )
659  assert(RegNext(!io.meta_write.valid || !s3_req.replace))
660  assert(RegNext(!io.tag_write.valid || !s3_req.replace))
661  assert(RegNext(!io.data_write.valid || !s3_req.replace))
662
663  io.wb.valid := s3_valid && (
664    // replace
665    s3_req.replace && !s3_replace_nothing ||
666    // probe can go to wbq
667    s3_req.probe && (io.meta_write.ready || !probe_update_meta) ||
668      // amo miss can go to wbq
669      s3_req.miss &&
670        (io.meta_write.ready || !amo_update_meta) &&
671        (io.data_write.ready || !update_data) &&
672        (s3_s_amoalu || !amo_wait_amoalu) &&
673        io.tag_write.ready
674    ) && need_wb
675  io.wb.bits.addr := get_block_addr(Cat(s3_tag, get_untag(s3_req.vaddr)))
676  io.wb.bits.param := writeback_param
677  io.wb.bits.voluntary := s3_req.miss || s3_req.replace
678  io.wb.bits.hasData := writeback_data
679  io.wb.bits.dirty := s3_coh === ClientStates.Dirty
680  io.wb.bits.data := s3_data.asUInt()
681  io.wb.bits.delay_release := s3_req.replace
682  io.wb.bits.miss_id := s3_req.miss_id
683
684  io.replace_access.valid := RegNext(s1_fire && (s1_req.isAMO || s1_req.isStore) && !s1_req.probe && s1_tag_match)
685  io.replace_access.bits.set := s2_idx
686  io.replace_access.bits.way := RegNext(OHToUInt(s1_way_en))
687
688  io.replace_way.set.valid := RegNext(s0_fire)
689  io.replace_way.set.bits := s1_idx
690
691  // TODO: consider block policy of a finer granularity
692  io.status.s0_set.valid := req.valid
693  io.status.s0_set.bits := get_idx(s0_req.vaddr)
694  io.status.s1.valid := s1_valid
695  io.status.s1.bits.set := s1_idx
696  io.status.s1.bits.way_en := s1_way_en
697  io.status.s2.valid := s2_valid && !s2_req.replace
698  io.status.s2.bits.set := s2_idx
699  io.status.s2.bits.way_en := s2_way_en
700  io.status.s3.valid := s3_valid && !s3_req.replace
701  io.status.s3.bits.set := s3_idx
702  io.status.s3.bits.way_en := s3_way_en
703
704  io.error := 0.U.asTypeOf(new L1CacheErrorInfo())
705  io.error.ecc_error.valid := RegNext((s2_tag_error || s2_data_error) && s2_fire)
706  io.error.ecc_error.bits := RegNext(s2_req.addr)
707  io.error.source.tag := RegNext(s2_tag_error)
708  io.error.source.data := RegNext(s2_data_error)
709  io.error.source.l2 := RegNext(s2_flag_error)
710  io.error.opType.store := RegNext(s2_req.isStore && !s2_req.probe)
711  io.error.opType.probe := RegNext(s2_req.probe)
712  io.error.opType.release := RegNext(s2_req.replace)
713  io.error.opType.atom := RegNext(s2_req.isAMO && !s2_req.probe)
714  io.error.valid := RegNext(s2_error && s2_fire)
715
716  val perfEvents = Seq(
717    ("dcache_mp_req          ", s0_fire                                                      ),
718    ("dcache_mp_total_penalty", PopCount(VecInit(Seq(s0_fire, s1_valid, s2_valid, s3_valid))))
719  )
720  generatePerfEvent()
721}
722