xref: /XiangShan/src/main/scala/xiangshan/frontend/FTB.scala (revision ccd953defaced8a7a9c80312dbc96866b2acbf8a)
109c6f1ddSLingrui98/***************************************************************************************
209c6f1ddSLingrui98* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
309c6f1ddSLingrui98* Copyright (c) 2020-2021 Peng Cheng Laboratory
409c6f1ddSLingrui98*
509c6f1ddSLingrui98* XiangShan is licensed under Mulan PSL v2.
609c6f1ddSLingrui98* You can use this software according to the terms and conditions of the Mulan PSL v2.
709c6f1ddSLingrui98* You may obtain a copy of Mulan PSL v2 at:
809c6f1ddSLingrui98*          http://license.coscl.org.cn/MulanPSL2
909c6f1ddSLingrui98*
1009c6f1ddSLingrui98* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
1109c6f1ddSLingrui98* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
1209c6f1ddSLingrui98* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
1309c6f1ddSLingrui98*
1409c6f1ddSLingrui98* See the Mulan PSL v2 for more details.
1509c6f1ddSLingrui98***************************************************************************************/
1609c6f1ddSLingrui98
1709c6f1ddSLingrui98package xiangshan.frontend
1809c6f1ddSLingrui98
1909c6f1ddSLingrui98import chipsalliance.rocketchip.config.Parameters
2009c6f1ddSLingrui98import chisel3._
2109c6f1ddSLingrui98import chisel3.stage.{ChiselGeneratorAnnotation, ChiselStage}
2209c6f1ddSLingrui98import chisel3.util._
2309c6f1ddSLingrui98import xiangshan._
2409c6f1ddSLingrui98import utils._
2509c6f1ddSLingrui98import chisel3.experimental.chiselName
2609c6f1ddSLingrui98
2709c6f1ddSLingrui98import scala.math.min
28eeb5ff92SLingrui98import os.copy
2909c6f1ddSLingrui98
3009c6f1ddSLingrui98
3109c6f1ddSLingrui98trait FTBParams extends HasXSParameter with HasBPUConst {
32b37e4b45SLingrui98  val numEntries = FtbSize
33b37e4b45SLingrui98  val numWays    = FtbWays
3409c6f1ddSLingrui98  val numSets    = numEntries/numWays // 512
3509c6f1ddSLingrui98  val tagSize    = 20
3609c6f1ddSLingrui98
37eeb5ff92SLingrui98
38eeb5ff92SLingrui98
3909c6f1ddSLingrui98  val TAR_STAT_SZ = 2
4009c6f1ddSLingrui98  def TAR_FIT = 0.U(TAR_STAT_SZ.W)
4109c6f1ddSLingrui98  def TAR_OVF = 1.U(TAR_STAT_SZ.W)
4209c6f1ddSLingrui98  def TAR_UDF = 2.U(TAR_STAT_SZ.W)
4309c6f1ddSLingrui98
44bf358e08SLingrui98  def BR_OFFSET_LEN = 12
45bf358e08SLingrui98  def JMP_OFFSET_LEN = 20
4609c6f1ddSLingrui98}
4709c6f1ddSLingrui98
48b30c10d6SLingrui98class FtbSlot(val offsetLen: Int, val subOffsetLen: Option[Int] = None)(implicit p: Parameters) extends XSBundle with FTBParams {
49b30c10d6SLingrui98  if (subOffsetLen.isDefined) {
50b30c10d6SLingrui98    require(subOffsetLen.get <= offsetLen)
51b30c10d6SLingrui98  }
52eeb5ff92SLingrui98  val offset  = UInt(log2Ceil(PredictWidth).W)
53eeb5ff92SLingrui98  val lower   = UInt(offsetLen.W)
54eeb5ff92SLingrui98  val tarStat = UInt(TAR_STAT_SZ.W)
55eeb5ff92SLingrui98  val sharing = Bool()
5609c6f1ddSLingrui98  val valid   = Bool()
5709c6f1ddSLingrui98
58eeb5ff92SLingrui98  def setLowerStatByTarget(pc: UInt, target: UInt, isShare: Boolean) = {
59eeb5ff92SLingrui98    def getTargetStatByHigher(pc_higher: UInt, target_higher: UInt) =
60eeb5ff92SLingrui98      Mux(target_higher > pc_higher, TAR_OVF,
61eeb5ff92SLingrui98        Mux(target_higher < pc_higher, TAR_UDF, TAR_FIT))
62eeb5ff92SLingrui98    def getLowerByTarget(target: UInt, offsetLen: Int) = target(offsetLen, 1)
63b30c10d6SLingrui98    val offLen = if (isShare) this.subOffsetLen.get else this.offsetLen
64eeb5ff92SLingrui98    val pc_higher = pc(VAddrBits-1, offLen+1)
65eeb5ff92SLingrui98    val target_higher = target(VAddrBits-1, offLen+1)
66eeb5ff92SLingrui98    val stat = getTargetStatByHigher(pc_higher, target_higher)
67eeb5ff92SLingrui98    val lower = ZeroExt(getLowerByTarget(target, offLen), this.offsetLen)
68eeb5ff92SLingrui98    this.lower := lower
69eeb5ff92SLingrui98    this.tarStat := stat
70eeb5ff92SLingrui98    this.sharing := isShare.B
71eeb5ff92SLingrui98  }
7209c6f1ddSLingrui98
73b30c10d6SLingrui98  def getTarget(pc: UInt, last_stage: Option[Tuple2[UInt, Bool]] = None) = {
74b30c10d6SLingrui98    def getTarget(offLen: Int)(pc: UInt, lower: UInt, stat: UInt,
75b30c10d6SLingrui98      last_stage: Option[Tuple2[UInt, Bool]] = None) = {
76b30c10d6SLingrui98      val h = pc(VAddrBits-1, offLen+1)
77b30c10d6SLingrui98      val higher = Wire(UInt((VAddrBits-offLen-1).W))
78b30c10d6SLingrui98      val higher_plus_one = Wire(UInt((VAddrBits-offLen-1).W))
79b30c10d6SLingrui98      val higher_minus_one = Wire(UInt((VAddrBits-offLen-1).W))
80b30c10d6SLingrui98      if (last_stage.isDefined) {
81b30c10d6SLingrui98        val last_stage_pc = last_stage.get._1
82b30c10d6SLingrui98        val last_stage_pc_h = last_stage_pc(VAddrBits-1, offLen+1)
83b30c10d6SLingrui98        val stage_en = last_stage.get._2
84b30c10d6SLingrui98        higher := RegEnable(last_stage_pc_h, stage_en)
85b30c10d6SLingrui98        higher_plus_one := RegEnable(last_stage_pc_h+1.U, stage_en)
86b30c10d6SLingrui98        higher_minus_one := RegEnable(last_stage_pc_h-1.U, stage_en)
87b30c10d6SLingrui98      } else {
88b30c10d6SLingrui98        higher := h
89b30c10d6SLingrui98        higher_plus_one := h + 1.U
90b30c10d6SLingrui98        higher_minus_one := h - 1.U
91b30c10d6SLingrui98      }
92eeb5ff92SLingrui98      val target =
93eeb5ff92SLingrui98        Cat(
94b30c10d6SLingrui98          Mux1H(Seq(
95b30c10d6SLingrui98            (stat === TAR_OVF, higher_plus_one),
96b30c10d6SLingrui98            (stat === TAR_UDF, higher_minus_one),
97b30c10d6SLingrui98            (stat === TAR_FIT, higher),
98b30c10d6SLingrui98          )),
99eeb5ff92SLingrui98          lower(offLen-1, 0), 0.U(1.W)
100eeb5ff92SLingrui98        )
101eeb5ff92SLingrui98      require(target.getWidth == VAddrBits)
102eeb5ff92SLingrui98      require(offLen != 0)
103eeb5ff92SLingrui98      target
104eeb5ff92SLingrui98    }
105b30c10d6SLingrui98    if (subOffsetLen.isDefined)
106eeb5ff92SLingrui98      Mux(sharing,
107b30c10d6SLingrui98        getTarget(subOffsetLen.get)(pc, lower, tarStat, last_stage),
108b30c10d6SLingrui98        getTarget(offsetLen)(pc, lower, tarStat, last_stage)
109eeb5ff92SLingrui98      )
110eeb5ff92SLingrui98    else
111b30c10d6SLingrui98      getTarget(offsetLen)(pc, lower, tarStat, last_stage)
112eeb5ff92SLingrui98  }
113eeb5ff92SLingrui98  def fromAnotherSlot(that: FtbSlot) = {
114eeb5ff92SLingrui98    require(
115b30c10d6SLingrui98      this.offsetLen > that.offsetLen && this.subOffsetLen.map(_ == that.offsetLen).getOrElse(true) ||
116eeb5ff92SLingrui98      this.offsetLen == that.offsetLen
117eeb5ff92SLingrui98    )
118eeb5ff92SLingrui98    this.offset := that.offset
119eeb5ff92SLingrui98    this.tarStat := that.tarStat
120b30c10d6SLingrui98    this.sharing := (this.offsetLen > that.offsetLen && that.offsetLen == this.subOffsetLen.get).B
121eeb5ff92SLingrui98    this.valid := that.valid
122eeb5ff92SLingrui98    this.lower := ZeroExt(that.lower, this.offsetLen)
123eeb5ff92SLingrui98  }
124eeb5ff92SLingrui98
125eeb5ff92SLingrui98}
126eeb5ff92SLingrui98
127eeb5ff92SLingrui98class FTBEntry(implicit p: Parameters) extends XSBundle with FTBParams with BPUUtils {
128eeb5ff92SLingrui98
129eeb5ff92SLingrui98
130eeb5ff92SLingrui98  val valid       = Bool()
131eeb5ff92SLingrui98
132eeb5ff92SLingrui98  val brSlots = Vec(numBrSlot, new FtbSlot(BR_OFFSET_LEN))
133eeb5ff92SLingrui98
134b30c10d6SLingrui98  val tailSlot = new FtbSlot(JMP_OFFSET_LEN, Some(BR_OFFSET_LEN))
13509c6f1ddSLingrui98
13609c6f1ddSLingrui98  // Partial Fall-Through Address
137a60a2901SLingrui98  val pftAddr     = UInt(log2Up(PredictWidth).W)
13809c6f1ddSLingrui98  val carry       = Bool()
13909c6f1ddSLingrui98
14009c6f1ddSLingrui98  val isCall      = Bool()
14109c6f1ddSLingrui98  val isRet       = Bool()
14209c6f1ddSLingrui98  val isJalr      = Bool()
14309c6f1ddSLingrui98
144f4ebc4b2SLingrui98  val last_may_be_rvi_call = Bool()
14509c6f1ddSLingrui98
14609c6f1ddSLingrui98  val always_taken = Vec(numBr, Bool())
14709c6f1ddSLingrui98
148eeb5ff92SLingrui98  def getSlotForBr(idx: Int): FtbSlot = {
149b37e4b45SLingrui98    require(idx <= numBr-1)
150b37e4b45SLingrui98    (idx, numBr) match {
151b37e4b45SLingrui98      case (i, n) if i == n-1 => this.tailSlot
152eeb5ff92SLingrui98      case _ => this.brSlots(idx)
15309c6f1ddSLingrui98    }
15409c6f1ddSLingrui98  }
155eeb5ff92SLingrui98  def allSlotsForBr = {
156eeb5ff92SLingrui98    (0 until numBr).map(getSlotForBr(_))
15709c6f1ddSLingrui98  }
15809c6f1ddSLingrui98  def setByBrTarget(brIdx: Int, pc: UInt, target: UInt) = {
159eeb5ff92SLingrui98    val slot = getSlotForBr(brIdx)
160b37e4b45SLingrui98    slot.setLowerStatByTarget(pc, target, brIdx == numBr-1)
16109c6f1ddSLingrui98  }
16209c6f1ddSLingrui98  def setByJmpTarget(pc: UInt, target: UInt) = {
163eeb5ff92SLingrui98    this.tailSlot.setLowerStatByTarget(pc, target, false)
16409c6f1ddSLingrui98  }
16509c6f1ddSLingrui98
166b30c10d6SLingrui98  def getTargetVec(pc: UInt, last_stage: Option[Tuple2[UInt, Bool]] = None) = {
167b30c10d6SLingrui98    VecInit((brSlots :+ tailSlot).map(_.getTarget(pc, last_stage)))
168bf358e08SLingrui98  }
16909c6f1ddSLingrui98
170eeb5ff92SLingrui98  def getOffsetVec = VecInit(brSlots.map(_.offset) :+ tailSlot.offset)
17109c6f1ddSLingrui98  def isJal = !isJalr
17209c6f1ddSLingrui98  def getFallThrough(pc: UInt) = getFallThroughAddr(pc, carry, pftAddr)
173eeb5ff92SLingrui98  def hasBr(offset: UInt) =
174eeb5ff92SLingrui98    brSlots.map{ s => s.valid && s.offset <= offset}.reduce(_||_) ||
175b37e4b45SLingrui98    (tailSlot.valid && tailSlot.offset <= offset && tailSlot.sharing)
17609c6f1ddSLingrui98
177eeb5ff92SLingrui98  def getBrMaskByOffset(offset: UInt) =
178b37e4b45SLingrui98    brSlots.map{ s => s.valid && s.offset <= offset } :+
179b37e4b45SLingrui98    (tailSlot.valid && tailSlot.offset <= offset && tailSlot.sharing)
180eeb5ff92SLingrui98
181eeb5ff92SLingrui98  def getBrRecordedVec(offset: UInt) = {
182eeb5ff92SLingrui98    VecInit(
183b37e4b45SLingrui98      brSlots.map(s => s.valid && s.offset === offset) :+
184b37e4b45SLingrui98      (tailSlot.valid && tailSlot.offset === offset && tailSlot.sharing)
185eeb5ff92SLingrui98    )
18609c6f1ddSLingrui98  }
18709c6f1ddSLingrui98
188eeb5ff92SLingrui98  def brIsSaved(offset: UInt) = getBrRecordedVec(offset).reduce(_||_)
189eeb5ff92SLingrui98
190eeb5ff92SLingrui98  def brValids = {
191eeb5ff92SLingrui98    VecInit(
192b37e4b45SLingrui98      brSlots.map(_.valid) :+ (tailSlot.valid && tailSlot.sharing)
193eeb5ff92SLingrui98    )
194eeb5ff92SLingrui98  }
195eeb5ff92SLingrui98
196eeb5ff92SLingrui98  def noEmptySlotForNewBr = {
197b37e4b45SLingrui98    VecInit(brSlots.map(_.valid) :+ tailSlot.valid).reduce(_&&_)
198eeb5ff92SLingrui98  }
199eeb5ff92SLingrui98
200eeb5ff92SLingrui98  def newBrCanNotInsert(offset: UInt) = {
201b37e4b45SLingrui98    val lastSlotForBr = tailSlot
202eeb5ff92SLingrui98    lastSlotForBr.valid && lastSlotForBr.offset < offset
203eeb5ff92SLingrui98  }
204eeb5ff92SLingrui98
205eeb5ff92SLingrui98  def jmpValid = {
206b37e4b45SLingrui98    tailSlot.valid && !tailSlot.sharing
207eeb5ff92SLingrui98  }
208eeb5ff92SLingrui98
209eeb5ff92SLingrui98  def brOffset = {
210b37e4b45SLingrui98    VecInit(brSlots.map(_.offset) :+ tailSlot.offset)
211eeb5ff92SLingrui98  }
212eeb5ff92SLingrui98
21309c6f1ddSLingrui98  def display(cond: Bool): Unit = {
21409c6f1ddSLingrui98    XSDebug(cond, p"-----------FTB entry----------- \n")
21509c6f1ddSLingrui98    XSDebug(cond, p"v=${valid}\n")
21609c6f1ddSLingrui98    for(i <- 0 until numBr) {
217eeb5ff92SLingrui98      XSDebug(cond, p"[br$i]: v=${allSlotsForBr(i).valid}, offset=${allSlotsForBr(i).offset}," +
218eeb5ff92SLingrui98        p"lower=${Hexadecimal(allSlotsForBr(i).lower)}\n")
21909c6f1ddSLingrui98    }
220eeb5ff92SLingrui98    XSDebug(cond, p"[tailSlot]: v=${tailSlot.valid}, offset=${tailSlot.offset}," +
221eeb5ff92SLingrui98      p"lower=${Hexadecimal(tailSlot.lower)}, sharing=${tailSlot.sharing}}\n")
22209c6f1ddSLingrui98    XSDebug(cond, p"pftAddr=${Hexadecimal(pftAddr)}, carry=$carry\n")
22309c6f1ddSLingrui98    XSDebug(cond, p"isCall=$isCall, isRet=$isRet, isjalr=$isJalr\n")
224f4ebc4b2SLingrui98    XSDebug(cond, p"last_may_be_rvi_call=$last_may_be_rvi_call\n")
22509c6f1ddSLingrui98    XSDebug(cond, p"------------------------------- \n")
22609c6f1ddSLingrui98  }
22709c6f1ddSLingrui98
22809c6f1ddSLingrui98}
22909c6f1ddSLingrui98
23009c6f1ddSLingrui98class FTBEntryWithTag(implicit p: Parameters) extends XSBundle with FTBParams with BPUUtils {
23109c6f1ddSLingrui98  val entry = new FTBEntry
23209c6f1ddSLingrui98  val tag = UInt(tagSize.W)
23309c6f1ddSLingrui98  def display(cond: Bool): Unit = {
234eeb5ff92SLingrui98    entry.display(cond)
235eeb5ff92SLingrui98    XSDebug(cond, p"tag is ${Hexadecimal(tag)}\n------------------------------- \n")
23609c6f1ddSLingrui98  }
23709c6f1ddSLingrui98}
23809c6f1ddSLingrui98
23909c6f1ddSLingrui98class FTBMeta(implicit p: Parameters) extends XSBundle with FTBParams {
240bb09c7feSzoujr  val writeWay = UInt(log2Ceil(numWays).W)
24109c6f1ddSLingrui98  val hit = Bool()
2421bc6e9c8SLingrui98  val pred_cycle = if (!env.FPGAPlatform) Some(UInt(64.W)) else None
24309c6f1ddSLingrui98}
24409c6f1ddSLingrui98
24509c6f1ddSLingrui98object FTBMeta {
24609c6f1ddSLingrui98  def apply(writeWay: UInt, hit: Bool, pred_cycle: UInt)(implicit p: Parameters): FTBMeta = {
24709c6f1ddSLingrui98    val e = Wire(new FTBMeta)
24809c6f1ddSLingrui98    e.writeWay := writeWay
24909c6f1ddSLingrui98    e.hit := hit
2501bc6e9c8SLingrui98    e.pred_cycle.map(_ := pred_cycle)
25109c6f1ddSLingrui98    e
25209c6f1ddSLingrui98  }
25309c6f1ddSLingrui98}
25409c6f1ddSLingrui98
255c6bf0bffSzoujr// class UpdateQueueEntry(implicit p: Parameters) extends XSBundle with FTBParams {
256c6bf0bffSzoujr//   val pc = UInt(VAddrBits.W)
257c6bf0bffSzoujr//   val ftb_entry = new FTBEntry
258c6bf0bffSzoujr//   val hit = Bool()
259c6bf0bffSzoujr//   val hit_way = UInt(log2Ceil(numWays).W)
260c6bf0bffSzoujr// }
261c6bf0bffSzoujr//
262c6bf0bffSzoujr// object UpdateQueueEntry {
263c6bf0bffSzoujr//   def apply(pc: UInt, fe: FTBEntry, hit: Bool, hit_way: UInt)(implicit p: Parameters): UpdateQueueEntry = {
264c6bf0bffSzoujr//     val e = Wire(new UpdateQueueEntry)
265c6bf0bffSzoujr//     e.pc := pc
266c6bf0bffSzoujr//     e.ftb_entry := fe
267c6bf0bffSzoujr//     e.hit := hit
268c6bf0bffSzoujr//     e.hit_way := hit_way
269c6bf0bffSzoujr//     e
270c6bf0bffSzoujr//   }
271c6bf0bffSzoujr// }
272c6bf0bffSzoujr
2731ca0e4f3SYinan Xuclass FTB(implicit p: Parameters) extends BasePredictor with FTBParams with BPUUtils
2741ca0e4f3SYinan Xu  with HasCircularQueuePtrHelper with HasPerfEvents {
27509c6f1ddSLingrui98  override val meta_size = WireInit(0.U.asTypeOf(new FTBMeta)).getWidth
27609c6f1ddSLingrui98
27709c6f1ddSLingrui98  val ftbAddr = new TableAddr(log2Up(numSets), 1)
27809c6f1ddSLingrui98
27909c6f1ddSLingrui98  class FTBBank(val numSets: Int, val nWays: Int) extends XSModule with BPUUtils {
28009c6f1ddSLingrui98    val io = IO(new Bundle {
2815371700eSzoujr      val s1_fire = Input(Bool())
28209c6f1ddSLingrui98
28309c6f1ddSLingrui98      // when ftb hit, read_hits.valid is true, and read_hits.bits is OH of hit way
28409c6f1ddSLingrui98      // when ftb not hit, read_hits.valid is false, and read_hits is OH of allocWay
285bb09c7feSzoujr      // val read_hits = Valid(Vec(numWays, Bool()))
2861c8d9e26Szoujr      val req_pc = Flipped(DecoupledIO(UInt(VAddrBits.W)))
2871c8d9e26Szoujr      val read_resp = Output(new FTBEntry)
288bb09c7feSzoujr      val read_hits = Valid(UInt(log2Ceil(numWays).W))
28909c6f1ddSLingrui98
2901c8d9e26Szoujr      val u_req_pc = Flipped(DecoupledIO(UInt(VAddrBits.W)))
2911c8d9e26Szoujr      val update_hits = Valid(UInt(log2Ceil(numWays).W))
2921c8d9e26Szoujr      val update_access = Input(Bool())
29309c6f1ddSLingrui98
29409c6f1ddSLingrui98      val update_pc = Input(UInt(VAddrBits.W))
29509c6f1ddSLingrui98      val update_write_data = Flipped(Valid(new FTBEntryWithTag))
296c6bf0bffSzoujr      val update_write_way = Input(UInt(log2Ceil(numWays).W))
297c6bf0bffSzoujr      val update_write_alloc = Input(Bool())
29809c6f1ddSLingrui98    })
29909c6f1ddSLingrui98
3001c8d9e26Szoujr    // Extract holdRead logic to fix bug that update read override predict read result
3011c8d9e26Szoujr    val ftb = Module(new SRAMTemplate(new FTBEntryWithTag, set = numSets, way = numWays, shouldReset = true, holdRead = false, singlePort = true))
302*ccd953deSSteve Gou    val ftb_r_entries = ftb.io.r.resp.data.map(_.entry)
30309c6f1ddSLingrui98
3041c8d9e26Szoujr    val pred_rdata   = HoldUnless(ftb.io.r.resp.data, RegNext(io.req_pc.valid && !io.update_access))
3051c8d9e26Szoujr    ftb.io.r.req.valid := io.req_pc.valid || io.u_req_pc.valid // io.s0_fire
3061c8d9e26Szoujr    ftb.io.r.req.bits.setIdx := Mux(io.u_req_pc.valid, ftbAddr.getIdx(io.u_req_pc.bits), ftbAddr.getIdx(io.req_pc.bits)) // s0_idx
3071c8d9e26Szoujr
3081c8d9e26Szoujr    assert(!(io.req_pc.valid && io.u_req_pc.valid))
30909c6f1ddSLingrui98
31009c6f1ddSLingrui98    io.req_pc.ready := ftb.io.r.req.ready
3111c8d9e26Szoujr    io.u_req_pc.ready := ftb.io.r.req.ready
31209c6f1ddSLingrui98
31309c6f1ddSLingrui98    val req_tag = RegEnable(ftbAddr.getTag(io.req_pc.bits)(tagSize-1, 0), io.req_pc.valid)
314ac3f6f25Szoujr    val req_idx = RegEnable(ftbAddr.getIdx(io.req_pc.bits), io.req_pc.valid)
31509c6f1ddSLingrui98
3161c8d9e26Szoujr    val u_req_tag = RegEnable(ftbAddr.getTag(io.u_req_pc.bits)(tagSize-1, 0), io.u_req_pc.valid)
31709c6f1ddSLingrui98
3181c8d9e26Szoujr    val read_entries = pred_rdata.map(_.entry)
3191c8d9e26Szoujr    val read_tags    = pred_rdata.map(_.tag)
3201c8d9e26Szoujr
3211c8d9e26Szoujr    val total_hits = VecInit((0 until numWays).map(b => read_tags(b) === req_tag && read_entries(b).valid && io.s1_fire))
32209c6f1ddSLingrui98    val hit = total_hits.reduce(_||_)
323bb09c7feSzoujr    // val hit_way_1h = VecInit(PriorityEncoderOH(total_hits))
324ab890bfeSLingrui98    val hit_way = OHToUInt(total_hits)
32509c6f1ddSLingrui98
3261c8d9e26Szoujr    val u_total_hits = VecInit((0 until numWays).map(b =>
3271c8d9e26Szoujr        ftb.io.r.resp.data(b).tag === u_req_tag && ftb.io.r.resp.data(b).entry.valid && RegNext(io.update_access)))
3281c8d9e26Szoujr    val u_hit = u_total_hits.reduce(_||_)
3291c8d9e26Szoujr    // val hit_way_1h = VecInit(PriorityEncoderOH(total_hits))
330ab890bfeSLingrui98    val u_hit_way = OHToUInt(u_total_hits)
3311c8d9e26Szoujr
332*ccd953deSSteve Gou    // assert(PopCount(total_hits) === 1.U || PopCount(total_hits) === 0.U)
333*ccd953deSSteve Gou    // assert(PopCount(u_total_hits) === 1.U || PopCount(u_total_hits) === 0.U)
334*ccd953deSSteve Gou    for (n <- 1 to numWays) {
335*ccd953deSSteve Gou      XSPerfAccumulate(f"ftb_pred_${n}_way_hit", PopCount(total_hits) === n.U)
336*ccd953deSSteve Gou      XSPerfAccumulate(f"ftb_update_${n}_way_hit", PopCount(u_total_hits) === n.U)
337*ccd953deSSteve Gou    }
33809c6f1ddSLingrui98
339ac3f6f25Szoujr    val replacer = ReplacementPolicy.fromString(Some("setplru"), numWays, numSets)
340c6bf0bffSzoujr    // val allocWriteWay = replacer.way(req_idx)
34109c6f1ddSLingrui98
342ac3f6f25Szoujr    val touch_set = Seq.fill(1)(Wire(UInt(log2Ceil(numSets).W)))
343ac3f6f25Szoujr    val touch_way = Seq.fill(1)(Wire(Valid(UInt(log2Ceil(numWays).W))))
344ac3f6f25Szoujr
345ac3f6f25Szoujr    touch_set(0) := req_idx
346ac3f6f25Szoujr
3471c8d9e26Szoujr    touch_way(0).valid := hit
348bb09c7feSzoujr    touch_way(0).bits := hit_way
349ac3f6f25Szoujr
350c6bf0bffSzoujr    replacer.access(touch_set, touch_way)
351c6bf0bffSzoujr
352ac3f6f25Szoujr    // def allocWay(valids: UInt, meta_tags: UInt, req_tag: UInt) = {
353ac3f6f25Szoujr    //   val randomAlloc = false
354ac3f6f25Szoujr    //   if (numWays > 1) {
355ac3f6f25Szoujr    //     val w = Wire(UInt(log2Up(numWays).W))
356ac3f6f25Szoujr    //     val valid = WireInit(valids.andR)
357ac3f6f25Szoujr    //     val tags = Cat(meta_tags, req_tag)
358ac3f6f25Szoujr    //     val l = log2Up(numWays)
359ac3f6f25Szoujr    //     val nChunks = (tags.getWidth + l - 1) / l
360ac3f6f25Szoujr    //     val chunks = (0 until nChunks).map( i =>
361ac3f6f25Szoujr    //       tags(min((i+1)*l, tags.getWidth)-1, i*l)
362ac3f6f25Szoujr    //     )
363ac3f6f25Szoujr    //     w := Mux(valid, if (randomAlloc) {LFSR64()(log2Up(numWays)-1,0)} else {chunks.reduce(_^_)}, PriorityEncoder(~valids))
364ac3f6f25Szoujr    //     w
365ac3f6f25Szoujr    //   } else {
366ac3f6f25Szoujr    //     val w = WireInit(0.U)
367ac3f6f25Szoujr    //     w
368ac3f6f25Szoujr    //   }
369ac3f6f25Szoujr    // }
370ac3f6f25Szoujr
371ac3f6f25Szoujr    // val allocWriteWay = allocWay(
372ac3f6f25Szoujr    //   VecInit(read_entries.map(_.valid)).asUInt,
373ac3f6f25Szoujr    //   VecInit(read_tags).asUInt,
374ac3f6f25Szoujr    //   req_tag
375ac3f6f25Szoujr    // )
37609c6f1ddSLingrui98
3775371700eSzoujr    def allocWay(valids: UInt, idx: UInt) = {
37809c6f1ddSLingrui98      if (numWays > 1) {
37909c6f1ddSLingrui98        val w = Wire(UInt(log2Up(numWays).W))
38009c6f1ddSLingrui98        val valid = WireInit(valids.andR)
3815371700eSzoujr        w := Mux(valid, replacer.way(idx), PriorityEncoder(~valids))
38209c6f1ddSLingrui98        w
38309c6f1ddSLingrui98      }else {
38409c6f1ddSLingrui98        val w = WireInit(0.U)
38509c6f1ddSLingrui98        w
38609c6f1ddSLingrui98      }
38709c6f1ddSLingrui98    }
38809c6f1ddSLingrui98
389ab890bfeSLingrui98    io.read_resp := Mux1H(total_hits, read_entries) // Mux1H
39009c6f1ddSLingrui98    io.read_hits.valid := hit
391bb09c7feSzoujr    // io.read_hits.bits := Mux(hit, hit_way_1h, VecInit(UIntToOH(allocWriteWay).asBools()))
3925371700eSzoujr    io.read_hits.bits := hit_way
39309c6f1ddSLingrui98
3941c8d9e26Szoujr    io.update_hits.valid := u_hit
3951c8d9e26Szoujr    io.update_hits.bits := u_hit_way
3961c8d9e26Szoujr
397c6bf0bffSzoujr    // XSDebug(!hit, "FTB not hit, alloc a way: %d\n", allocWriteWay)
39809c6f1ddSLingrui98
39909c6f1ddSLingrui98    // Update logic
40009c6f1ddSLingrui98    val u_valid = io.update_write_data.valid
40109c6f1ddSLingrui98    val u_data = io.update_write_data.bits
40209c6f1ddSLingrui98    val u_idx = ftbAddr.getIdx(io.update_pc)
403*ccd953deSSteve Gou    val allocWriteWay = allocWay(VecInit(ftb_r_entries.map(_.valid)).asUInt, u_idx)
4045371700eSzoujr    val u_mask = UIntToOH(Mux(io.update_write_alloc, allocWriteWay, io.update_write_way))
405c6bf0bffSzoujr
406c6bf0bffSzoujr    for (i <- 0 until numWays) {
4075371700eSzoujr      XSPerfAccumulate(f"ftb_replace_way$i", u_valid && io.update_write_alloc && OHToUInt(u_mask) === i.U)
408*ccd953deSSteve Gou      XSPerfAccumulate(f"ftb_replace_way${i}_has_empty", u_valid && io.update_write_alloc && !ftb_r_entries.map(_.valid).reduce(_&&_) && OHToUInt(u_mask) === i.U)
4095371700eSzoujr      XSPerfAccumulate(f"ftb_hit_way$i", hit && !io.update_access && hit_way === i.U)
410c6bf0bffSzoujr    }
41109c6f1ddSLingrui98
41209c6f1ddSLingrui98    ftb.io.w.apply(u_valid, u_data, u_idx, u_mask)
413eeb5ff92SLingrui98
414eeb5ff92SLingrui98    // print hit entry info
415ab890bfeSLingrui98    Mux1H(total_hits, ftb.io.r.resp.data).display(true.B)
41609c6f1ddSLingrui98  } // FTBBank
41709c6f1ddSLingrui98
41809c6f1ddSLingrui98  val ftbBank = Module(new FTBBank(numSets, numWays))
41909c6f1ddSLingrui98
42009c6f1ddSLingrui98  ftbBank.io.req_pc.valid := io.s0_fire
42109c6f1ddSLingrui98  ftbBank.io.req_pc.bits := s0_pc
42209c6f1ddSLingrui98
42309c6f1ddSLingrui98  val ftb_entry = RegEnable(ftbBank.io.read_resp, io.s1_fire)
424cb4f77ceSLingrui98  val s3_ftb_entry = RegEnable(ftb_entry, io.s2_fire)
42509c6f1ddSLingrui98  val s1_hit = ftbBank.io.read_hits.valid
42609c6f1ddSLingrui98  val s2_hit = RegEnable(s1_hit, io.s1_fire)
427cb4f77ceSLingrui98  val s3_hit = RegEnable(s2_hit, io.s2_fire)
42809c6f1ddSLingrui98  val writeWay = ftbBank.io.read_hits.bits
42909c6f1ddSLingrui98
43009c6f1ddSLingrui98  val fallThruAddr = getFallThroughAddr(s2_pc, ftb_entry.carry, ftb_entry.pftAddr)
43109c6f1ddSLingrui98
43209c6f1ddSLingrui98  // io.out.bits.resp := RegEnable(io.in.bits.resp_in(0), 0.U.asTypeOf(new BranchPredictionResp), io.s1_fire)
43309c6f1ddSLingrui98  io.out.resp := io.in.bits.resp_in(0)
43409c6f1ddSLingrui98
43509c6f1ddSLingrui98  val s1_latch_call_is_rvc   = DontCare // TODO: modify when add RAS
43609c6f1ddSLingrui98
437b37e4b45SLingrui98  io.out.resp.s2.full_pred.hit       := s2_hit
43809c6f1ddSLingrui98  io.out.resp.s2.pc                  := s2_pc
43909c6f1ddSLingrui98  io.out.resp.s2.ftb_entry           := ftb_entry
440b37e4b45SLingrui98  io.out.resp.s2.full_pred.fromFtbEntry(ftb_entry, s2_pc, Some((s1_pc, io.s1_fire)))
441b37e4b45SLingrui98  io.out.resp.s2.is_minimal := false.B
44209c6f1ddSLingrui98
443cb4f77ceSLingrui98  io.out.resp.s3.full_pred.hit := s3_hit
444cb4f77ceSLingrui98  io.out.resp.s3.pc                  := s3_pc
445cb4f77ceSLingrui98  io.out.resp.s3.ftb_entry           := s3_ftb_entry
446cb4f77ceSLingrui98  io.out.resp.s3.full_pred.fromFtbEntry(s3_ftb_entry, s3_pc, Some((s2_pc, io.s2_fire)))
447cb4f77ceSLingrui98  io.out.resp.s3.is_minimal := false.B
448cb4f77ceSLingrui98
449cb4f77ceSLingrui98  io.out.last_stage_meta := RegEnable(RegEnable(FTBMeta(writeWay.asUInt(), s1_hit, GTimer()).asUInt(), io.s1_fire), io.s2_fire)
45009c6f1ddSLingrui98
45109c6f1ddSLingrui98  // always taken logic
45209c6f1ddSLingrui98  for (i <- 0 until numBr) {
453b37e4b45SLingrui98    io.out.resp.s2.full_pred.br_taken_mask(i) := io.in.bits.resp_in(0).s2.full_pred.br_taken_mask(i) || s2_hit && ftb_entry.always_taken(i)
454cb4f77ceSLingrui98    io.out.resp.s3.full_pred.br_taken_mask(i) := io.in.bits.resp_in(0).s3.full_pred.br_taken_mask(i) || s3_hit && s3_ftb_entry.always_taken(i)
45509c6f1ddSLingrui98  }
45609c6f1ddSLingrui98
45709c6f1ddSLingrui98  // Update logic
45809c6f1ddSLingrui98  val update = RegNext(io.update.bits)
45909c6f1ddSLingrui98
460c6bf0bffSzoujr  // val update_queue = Mem(64, new UpdateQueueEntry)
461c6bf0bffSzoujr  // val head, tail = RegInit(UpdateQueuePtr(false.B, 0.U))
462c6bf0bffSzoujr  // val u_queue = Module(new Queue(new UpdateQueueEntry, entries = 64, flow = true))
463c6bf0bffSzoujr  // assert(u_queue.io.count < 64.U)
464c6bf0bffSzoujr
46509c6f1ddSLingrui98  val u_meta = update.meta.asTypeOf(new FTBMeta)
46609c6f1ddSLingrui98  val u_valid = RegNext(io.update.valid && !io.update.bits.old_entry)
467bb09c7feSzoujr
468c6bf0bffSzoujr  // io.s1_ready := ftbBank.io.req_pc.ready && u_queue.io.count === 0.U && !u_valid
469c6bf0bffSzoujr  io.s1_ready := ftbBank.io.req_pc.ready && !(u_valid && !u_meta.hit)
470bb09c7feSzoujr
471c6bf0bffSzoujr  // val update_now = u_queue.io.deq.fire && u_queue.io.deq.bits.hit
472c6bf0bffSzoujr  val update_now = u_valid && u_meta.hit
473c6bf0bffSzoujr
4741c8d9e26Szoujr  ftbBank.io.u_req_pc.valid := u_valid && !u_meta.hit
4751c8d9e26Szoujr  ftbBank.io.u_req_pc.bits := update.pc
476bb09c7feSzoujr
477c6bf0bffSzoujr  // assert(!(u_valid && RegNext(u_valid) && update.pc === RegNext(update.pc)))
4785371700eSzoujr  // assert(!(u_valid && RegNext(u_valid)))
479bb09c7feSzoujr
480c6bf0bffSzoujr  // val u_way = u_queue.io.deq.bits.hit_way
48109c6f1ddSLingrui98
48209c6f1ddSLingrui98  val ftb_write = Wire(new FTBEntryWithTag)
483c6bf0bffSzoujr  // ftb_write.entry := Mux(update_now, u_queue.io.deq.bits.ftb_entry, RegNext(u_queue.io.deq.bits.ftb_entry))
484c6bf0bffSzoujr  // ftb_write.tag   := ftbAddr.getTag(Mux(update_now, u_queue.io.deq.bits.pc, RegNext(u_queue.io.deq.bits.pc)))(tagSize-1, 0)
485c6bf0bffSzoujr  ftb_write.entry := Mux(update_now, update.ftb_entry, RegNext(update.ftb_entry))
486c6bf0bffSzoujr  ftb_write.tag   := ftbAddr.getTag(Mux(update_now, update.pc, RegNext(update.pc)))(tagSize-1, 0)
48709c6f1ddSLingrui98
488c6bf0bffSzoujr  // val write_valid = update_now || RegNext(u_queue.io.deq.fire && !u_queue.io.deq.bits.hit)
489c6bf0bffSzoujr  val write_valid = update_now || RegNext(u_valid && !u_meta.hit)
490c6bf0bffSzoujr
491c6bf0bffSzoujr  // u_queue.io.enq.valid := u_valid
492c6bf0bffSzoujr  // u_queue.io.enq.bits := UpdateQueueEntry(update.pc, update.ftb_entry, u_meta.hit, u_meta.writeWay)
493c6bf0bffSzoujr  // u_queue.io.deq.ready := RegNext(!u_queue.io.deq.fire || update_now)
494c6bf0bffSzoujr
495c6bf0bffSzoujr  ftbBank.io.update_write_data.valid := write_valid
49609c6f1ddSLingrui98  ftbBank.io.update_write_data.bits := ftb_write
497c6bf0bffSzoujr  // ftbBank.io.update_pc := Mux(update_now, u_queue.io.deq.bits.pc, RegNext(u_queue.io.deq.bits.pc))
498c6bf0bffSzoujr  ftbBank.io.update_pc := Mux(update_now, update.pc, RegNext(update.pc))
4991c8d9e26Szoujr  ftbBank.io.update_write_way := Mux(update_now, u_meta.writeWay, ftbBank.io.update_hits.bits)
5001c8d9e26Szoujr  // ftbBank.io.update_write_alloc := Mux(update_now, !u_queue.io.deq.bits.hit, !ftbBank.io.update_hits.valid)
5011c8d9e26Szoujr  ftbBank.io.update_write_alloc := Mux(update_now, false.B, !ftbBank.io.update_hits.valid)
5021c8d9e26Szoujr  ftbBank.io.update_access := u_valid && !u_meta.hit
5035371700eSzoujr  ftbBank.io.s1_fire := io.s1_fire
50409c6f1ddSLingrui98
50509c6f1ddSLingrui98  XSDebug("req_v=%b, req_pc=%x, ready=%b (resp at next cycle)\n", io.s0_fire, s0_pc, ftbBank.io.req_pc.ready)
50609c6f1ddSLingrui98  XSDebug("s2_hit=%b, hit_way=%b\n", s2_hit, writeWay.asUInt)
507eeb5ff92SLingrui98  XSDebug("s2_br_taken_mask=%b, s2_real_taken_mask=%b\n",
508b37e4b45SLingrui98    io.in.bits.resp_in(0).s2.full_pred.br_taken_mask.asUInt, io.out.resp.s2.full_pred.real_slot_taken_mask().asUInt)
509b37e4b45SLingrui98  XSDebug("s2_target=%x\n", io.out.resp.s2.getTarget)
51009c6f1ddSLingrui98
51109c6f1ddSLingrui98  ftb_entry.display(true.B)
51209c6f1ddSLingrui98
51309c6f1ddSLingrui98  XSPerfAccumulate("ftb_read_hits", RegNext(io.s0_fire) && s1_hit)
51409c6f1ddSLingrui98  XSPerfAccumulate("ftb_read_misses", RegNext(io.s0_fire) && !s1_hit)
51509c6f1ddSLingrui98
516d2568e58SLingrui98  XSPerfAccumulate("ftb_commit_hits", RegNext(io.update.valid) && u_meta.hit)
517d2568e58SLingrui98  XSPerfAccumulate("ftb_commit_misses", RegNext(io.update.valid) && !u_meta.hit)
51809c6f1ddSLingrui98
51909c6f1ddSLingrui98  XSPerfAccumulate("ftb_update_req", io.update.valid)
52009c6f1ddSLingrui98  XSPerfAccumulate("ftb_update_ignored", io.update.valid && io.update.bits.old_entry)
52109c6f1ddSLingrui98  XSPerfAccumulate("ftb_updated", u_valid)
522cd365d4cSrvcoresjw
5234813e060SLingrui98  override val perfEvents = Seq(
524d2568e58SLingrui98    ("ftb_commit_hits            ", RegNext(io.update.valid)  &&  u_meta.hit),
525d2568e58SLingrui98    ("ftb_commit_misses          ", RegNext(io.update.valid)  && !u_meta.hit),
526cd365d4cSrvcoresjw  )
5271ca0e4f3SYinan Xu  generatePerfEvent()
52809c6f1ddSLingrui98}
529