xref: /XiangShan/src/main/scala/xiangshan/frontend/FrontendBundle.scala (revision cb4f77ce497f499cefbac1624a84fbc34e49308b)
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***************************************************************************************/
1609c6f1ddSLingrui98package xiangshan.frontend
1709c6f1ddSLingrui98
1809c6f1ddSLingrui98import chipsalliance.rocketchip.config.Parameters
1909c6f1ddSLingrui98import chisel3._
2009c6f1ddSLingrui98import chisel3.util._
21bf358e08SLingrui98import chisel3.experimental.chiselName
2209c6f1ddSLingrui98import xiangshan._
23b37e4b45SLingrui98import xiangshan.frontend.icache.HasICacheParameters
2409c6f1ddSLingrui98import utils._
25c2ad24ebSLingrui98import scala.math._
2609c6f1ddSLingrui98
27bf358e08SLingrui98@chiselName
28b37e4b45SLingrui98class FetchRequestBundle(implicit p: Parameters) extends XSBundle with HasICacheParameters {
2909c6f1ddSLingrui98  val startAddr       = UInt(VAddrBits.W)
3034a88126SJinYue  val nextlineStart   = UInt(VAddrBits.W)
316ce52296SJinYue  // val fallThruError   = Bool()
3209c6f1ddSLingrui98  val ftqIdx          = new FtqPtr
3309c6f1ddSLingrui98  val ftqOffset       = ValidUndirectioned(UInt(log2Ceil(PredictWidth).W))
346ce52296SJinYue  val nextStartAddr   = UInt(VAddrBits.W)
3509c6f1ddSLingrui98  val oversize        = Bool()
3609c6f1ddSLingrui98
376ce52296SJinYue  def crossCacheline = startAddr(blockOffBits - 1) === 1.U
386ce52296SJinYue
3909c6f1ddSLingrui98  def fromFtqPcBundle(b: Ftq_RF_Components) = {
4009c6f1ddSLingrui98    this.startAddr := b.startAddr
41b37e4b45SLingrui98    this.nextlineStart := b.nextLineAddr
4209c6f1ddSLingrui98    this.oversize := b.oversize
43b37e4b45SLingrui98    when (b.fallThruError) {
44b37e4b45SLingrui98      val nextBlockHigherTemp = Mux(startAddr(log2Ceil(PredictWidth)+instOffsetBits), b.startAddr, b.nextLineAddr)
45b37e4b45SLingrui98      val nextBlockHigher = nextBlockHigherTemp(VAddrBits-1, log2Ceil(PredictWidth)+instOffsetBits+1)
46b37e4b45SLingrui98      this.nextStartAddr :=
47b37e4b45SLingrui98        Cat(nextBlockHigher,
48b37e4b45SLingrui98          startAddr(log2Ceil(PredictWidth)+instOffsetBits) ^ 1.U(1.W),
49b37e4b45SLingrui98          startAddr(log2Ceil(PredictWidth)+instOffsetBits-1, instOffsetBits),
50b37e4b45SLingrui98          0.U(instOffsetBits.W)
51b37e4b45SLingrui98        )
5209c6f1ddSLingrui98    }
5309c6f1ddSLingrui98    this
5409c6f1ddSLingrui98  }
5509c6f1ddSLingrui98  override def toPrintable: Printable = {
56b37e4b45SLingrui98    p"[start] ${Hexadecimal(startAddr)} [next] ${Hexadecimal(nextlineStart)}" +
57b37e4b45SLingrui98      p"[tgt] ${Hexadecimal(nextStartAddr)} [ftqIdx] $ftqIdx [jmp] v:${ftqOffset.valid}" +
5809c6f1ddSLingrui98      p" offset: ${ftqOffset.bits}\n"
5909c6f1ddSLingrui98  }
6009c6f1ddSLingrui98}
6109c6f1ddSLingrui98
6209c6f1ddSLingrui98class PredecodeWritebackBundle(implicit p:Parameters) extends XSBundle {
6309c6f1ddSLingrui98  val pc           = Vec(PredictWidth, UInt(VAddrBits.W))
6409c6f1ddSLingrui98  val pd           = Vec(PredictWidth, new PreDecodeInfo) // TODO: redefine Predecode
6509c6f1ddSLingrui98  val ftqIdx       = new FtqPtr
6609c6f1ddSLingrui98  val ftqOffset    = UInt(log2Ceil(PredictWidth).W)
6709c6f1ddSLingrui98  val misOffset    = ValidUndirectioned(UInt(log2Ceil(PredictWidth).W))
6809c6f1ddSLingrui98  val cfiOffset    = ValidUndirectioned(UInt(log2Ceil(PredictWidth).W))
6909c6f1ddSLingrui98  val target       = UInt(VAddrBits.W)
7009c6f1ddSLingrui98  val jalTarget    = UInt(VAddrBits.W)
7109c6f1ddSLingrui98  val instrRange   = Vec(PredictWidth, Bool())
7209c6f1ddSLingrui98}
7309c6f1ddSLingrui98
747052722fSJay// Ftq send req to Prefetch
757052722fSJayclass PrefetchRequest(implicit p:Parameters) extends XSBundle {
767052722fSJay  val target          = UInt(VAddrBits.W)
777052722fSJay}
7809c6f1ddSLingrui98
797052722fSJayclass FtqPrefechBundle(implicit p:Parameters) extends XSBundle {
807052722fSJay  val req = DecoupledIO(new PrefetchRequest)
8109c6f1ddSLingrui98}
8209c6f1ddSLingrui98
8309c6f1ddSLingrui98class FetchToIBuffer(implicit p: Parameters) extends XSBundle {
8409c6f1ddSLingrui98  val instrs    = Vec(PredictWidth, UInt(32.W))
8509c6f1ddSLingrui98  val valid     = UInt(PredictWidth.W)
862a3050c2SJay  val enqEnable = UInt(PredictWidth.W)
8709c6f1ddSLingrui98  val pd        = Vec(PredictWidth, new PreDecodeInfo)
8809c6f1ddSLingrui98  val pc        = Vec(PredictWidth, UInt(VAddrBits.W))
8909c6f1ddSLingrui98  val foldpc    = Vec(PredictWidth, UInt(MemPredPCWidth.W))
9009c6f1ddSLingrui98  val ftqPtr       = new FtqPtr
9109c6f1ddSLingrui98  val ftqOffset    = Vec(PredictWidth, ValidUndirectioned(UInt(log2Ceil(PredictWidth).W)))
9209c6f1ddSLingrui98  val ipf          = Vec(PredictWidth, Bool())
9309c6f1ddSLingrui98  val acf          = Vec(PredictWidth, Bool())
9409c6f1ddSLingrui98  val crossPageIPFFix = Vec(PredictWidth, Bool())
9572951335SLi Qianruo  val triggered    = Vec(PredictWidth, new TriggerCf)
9609c6f1ddSLingrui98}
9709c6f1ddSLingrui98
98c2ad24ebSLingrui98// class BitWiseUInt(val width: Int, val init: UInt) extends Module {
99c2ad24ebSLingrui98//   val io = IO(new Bundle {
100c2ad24ebSLingrui98//     val set
101c2ad24ebSLingrui98//   })
102c2ad24ebSLingrui98// }
10309c6f1ddSLingrui98// Move from BPU
104c2ad24ebSLingrui98abstract class GlobalHistory(implicit p: Parameters) extends XSBundle with HasBPUConst {
105c2ad24ebSLingrui98  def update(br_valids: Vec[Bool], real_taken_mask: Vec[Bool]): GlobalHistory
106c2ad24ebSLingrui98}
107c2ad24ebSLingrui98
108c2ad24ebSLingrui98class ShiftingGlobalHistory(implicit p: Parameters) extends GlobalHistory {
10909c6f1ddSLingrui98  val predHist = UInt(HistoryLength.W)
11009c6f1ddSLingrui98
111c2ad24ebSLingrui98  def update(shift: UInt, taken: Bool, hist: UInt = this.predHist): ShiftingGlobalHistory = {
112c2ad24ebSLingrui98    val g = Wire(new ShiftingGlobalHistory)
11309c6f1ddSLingrui98    g.predHist := (hist << shift) | taken
11409c6f1ddSLingrui98    g
11509c6f1ddSLingrui98  }
11609c6f1ddSLingrui98
117c2ad24ebSLingrui98  def update(br_valids: Vec[Bool], real_taken_mask: Vec[Bool]): ShiftingGlobalHistory = {
118eeb5ff92SLingrui98    require(br_valids.length == numBr)
119eeb5ff92SLingrui98    require(real_taken_mask.length == numBr)
120eeb5ff92SLingrui98    val last_valid_idx = PriorityMux(
121eeb5ff92SLingrui98      br_valids.reverse :+ true.B,
122eeb5ff92SLingrui98      (numBr to 0 by -1).map(_.U(log2Ceil(numBr+1).W))
123eeb5ff92SLingrui98    )
124eeb5ff92SLingrui98    val first_taken_idx = PriorityEncoder(false.B +: real_taken_mask)
125eeb5ff92SLingrui98    val smaller = Mux(last_valid_idx < first_taken_idx,
126eeb5ff92SLingrui98      last_valid_idx,
127eeb5ff92SLingrui98      first_taken_idx
128eeb5ff92SLingrui98    )
129eeb5ff92SLingrui98    val shift = smaller
130eeb5ff92SLingrui98    val taken = real_taken_mask.reduce(_||_)
131eeb5ff92SLingrui98    update(shift, taken, this.predHist)
132eeb5ff92SLingrui98  }
133eeb5ff92SLingrui98
134c2ad24ebSLingrui98  // static read
135c2ad24ebSLingrui98  def read(n: Int): Bool = predHist.asBools()(n)
136c2ad24ebSLingrui98
137c2ad24ebSLingrui98  final def === (that: ShiftingGlobalHistory): Bool = {
13809c6f1ddSLingrui98    predHist === that.predHist
13909c6f1ddSLingrui98  }
14009c6f1ddSLingrui98
141c2ad24ebSLingrui98  final def =/= (that: ShiftingGlobalHistory): Bool = !(this === that)
142c2ad24ebSLingrui98}
14309c6f1ddSLingrui98
144c2ad24ebSLingrui98// circular global history pointer
145c2ad24ebSLingrui98class CGHPtr(implicit p: Parameters) extends CircularQueuePtr[CGHPtr](
146c2ad24ebSLingrui98  p => p(XSCoreParamsKey).HistoryLength
147c2ad24ebSLingrui98){
148c2ad24ebSLingrui98  override def cloneType = (new CGHPtr).asInstanceOf[this.type]
149c2ad24ebSLingrui98}
150c2ad24ebSLingrui98class CircularGlobalHistory(implicit p: Parameters) extends GlobalHistory {
151c2ad24ebSLingrui98  val buffer = Vec(HistoryLength, Bool())
152c2ad24ebSLingrui98  type HistPtr = UInt
153c2ad24ebSLingrui98  def update(br_valids: Vec[Bool], real_taken_mask: Vec[Bool]): CircularGlobalHistory = {
154c2ad24ebSLingrui98    this
155c2ad24ebSLingrui98  }
156c2ad24ebSLingrui98}
157c2ad24ebSLingrui98
158dd6c0695SLingrui98class FoldedHistory(val len: Int, val compLen: Int, val max_update_num: Int)(implicit p: Parameters)
159c2ad24ebSLingrui98  extends XSBundle with HasBPUConst {
160dd6c0695SLingrui98  require(compLen >= 1)
161c2ad24ebSLingrui98  require(len > 0)
162c2ad24ebSLingrui98  // require(folded_len <= len)
163dd6c0695SLingrui98  require(compLen >= max_update_num)
164dd6c0695SLingrui98  val folded_hist = UInt(compLen.W)
165dd6c0695SLingrui98
166dd6c0695SLingrui98  def info = (len, compLen)
167c2ad24ebSLingrui98  def oldest_bit_to_get_from_ghr = (0 until max_update_num).map(len - _ - 1)
168c2ad24ebSLingrui98  def oldest_bit_pos_in_folded = oldest_bit_to_get_from_ghr map (_ % compLen)
169c2ad24ebSLingrui98  def oldest_bit_wrap_around = oldest_bit_to_get_from_ghr map (_ / compLen > 0)
170c2ad24ebSLingrui98  def oldest_bit_start = oldest_bit_pos_in_folded.head
171c2ad24ebSLingrui98
172dd6c0695SLingrui98  def get_oldest_bits_from_ghr(ghr: Vec[Bool], histPtr: CGHPtr) = {
173c2ad24ebSLingrui98    // TODO: wrap inc for histPtr value
174dd6c0695SLingrui98    oldest_bit_to_get_from_ghr.map(i => ghr((histPtr + (i+1).U).value))
175c2ad24ebSLingrui98  }
176c2ad24ebSLingrui98
177ab890bfeSLingrui98  def circular_shift_left(src: UInt, shamt: Int) = {
178c2ad24ebSLingrui98    val srcLen = src.getWidth
179c2ad24ebSLingrui98    val src_doubled = Cat(src, src)
180ab890bfeSLingrui98    val shifted = src_doubled(srcLen*2-1-shamt, srcLen-shamt)
181ab890bfeSLingrui98    shifted
182c2ad24ebSLingrui98  }
183c2ad24ebSLingrui98
184c2ad24ebSLingrui98
185ab890bfeSLingrui98  def update(ghr: Vec[Bool], histPtr: CGHPtr, num: Int, taken: Bool): FoldedHistory = {
186c2ad24ebSLingrui98    // do xors for several bitsets at specified bits
187c2ad24ebSLingrui98    def bitsets_xor(len: Int, bitsets: Seq[Seq[Tuple2[Int, Bool]]]) = {
188c2ad24ebSLingrui98      val res = Wire(Vec(len, Bool()))
189c2ad24ebSLingrui98      // println(f"num bitsets: ${bitsets.length}")
190c2ad24ebSLingrui98      // println(f"bitsets $bitsets")
191c2ad24ebSLingrui98      val resArr = Array.fill(len)(List[Bool]())
192c2ad24ebSLingrui98      for (bs <- bitsets) {
193c2ad24ebSLingrui98        for ((n, b) <- bs) {
194c2ad24ebSLingrui98          resArr(n) = b :: resArr(n)
195c2ad24ebSLingrui98        }
196c2ad24ebSLingrui98      }
197c2ad24ebSLingrui98      // println(f"${resArr.mkString}")
198c2ad24ebSLingrui98      // println(f"histLen: ${this.len}, foldedLen: $folded_len")
199c2ad24ebSLingrui98      for (i <- 0 until len) {
200c2ad24ebSLingrui98        // println(f"bit[$i], ${resArr(i).mkString}")
201c2ad24ebSLingrui98        if (resArr(i).length > 2) {
202c2ad24ebSLingrui98          println(f"[warning] update logic of foldest history has two or more levels of xor gates! " +
20386d9c530SLingrui98            f"histlen:${this.len}, compLen:$compLen, at bit $i")
204c2ad24ebSLingrui98        }
205c2ad24ebSLingrui98        if (resArr(i).length == 0) {
206dd6c0695SLingrui98          println(f"[error] bits $i is not assigned in folded hist update logic! histlen:${this.len}, compLen:$compLen")
207c2ad24ebSLingrui98        }
208c2ad24ebSLingrui98        res(i) := resArr(i).foldLeft(false.B)(_^_)
209c2ad24ebSLingrui98      }
210c2ad24ebSLingrui98      res.asUInt
211c2ad24ebSLingrui98    }
212dd6c0695SLingrui98    val oldest_bits = get_oldest_bits_from_ghr(ghr, histPtr)
213c2ad24ebSLingrui98
214c2ad24ebSLingrui98    // mask off bits that do not update
215c2ad24ebSLingrui98    val oldest_bits_masked = oldest_bits.zipWithIndex.map{
216ab890bfeSLingrui98      case (ob, i) => ob && (i < num).B
217c2ad24ebSLingrui98    }
218c2ad24ebSLingrui98    // if a bit does not wrap around, it should not be xored when it exits
219c2ad24ebSLingrui98    val oldest_bits_set = (0 until max_update_num).filter(oldest_bit_wrap_around).map(i => (oldest_bit_pos_in_folded(i), oldest_bits_masked(i)))
220c2ad24ebSLingrui98
221c2ad24ebSLingrui98    // println(f"old bits pos ${oldest_bits_set.map(_._1)}")
222c2ad24ebSLingrui98
223c2ad24ebSLingrui98    // only the last bit could be 1, as we have at most one taken branch at a time
224ab890bfeSLingrui98    val newest_bits_masked = VecInit((0 until max_update_num).map(i => taken && ((i+1) == num).B)).asUInt
225c2ad24ebSLingrui98    // if a bit does not wrap around, newest bits should not be xored onto it either
226e992912cSLingrui98    val newest_bits_set = (0 until max_update_num).map(i => (compLen-1-i, newest_bits_masked(i)))
227c2ad24ebSLingrui98
228c2ad24ebSLingrui98    // println(f"new bits set ${newest_bits_set.map(_._1)}")
229c2ad24ebSLingrui98    //
230c2ad24ebSLingrui98    val original_bits_masked = VecInit(folded_hist.asBools.zipWithIndex.map{
231ab890bfeSLingrui98      case (fb, i) => fb && !(num >= (len-i)).B
232c2ad24ebSLingrui98    })
233c2ad24ebSLingrui98    val original_bits_set = (0 until compLen).map(i => (i, original_bits_masked(i)))
234c2ad24ebSLingrui98
235c2ad24ebSLingrui98
236c2ad24ebSLingrui98    // histLen too short to wrap around
237c2ad24ebSLingrui98    val new_folded_hist =
238dd6c0695SLingrui98      if (len <= compLen) {
239dd6c0695SLingrui98        ((folded_hist << num) | taken)(compLen-1,0)
240c2ad24ebSLingrui98        // circular_shift_left(max_update_num)(Cat(Reverse(newest_bits_masked), folded_hist(compLen-max_update_num-1,0)), num)
241c2ad24ebSLingrui98      } else {
242c2ad24ebSLingrui98        // do xor then shift
243c2ad24ebSLingrui98        val xored = bitsets_xor(compLen, Seq(original_bits_set, oldest_bits_set, newest_bits_set))
244ab890bfeSLingrui98        circular_shift_left(xored, num)
245c2ad24ebSLingrui98      }
246c2ad24ebSLingrui98    val fh = WireInit(this)
247c2ad24ebSLingrui98    fh.folded_hist := new_folded_hist
248c2ad24ebSLingrui98    fh
249c2ad24ebSLingrui98  }
25009c6f1ddSLingrui98}
25109c6f1ddSLingrui98
25209c6f1ddSLingrui98class TableAddr(val idxBits: Int, val banks: Int)(implicit p: Parameters) extends XSBundle{
25309c6f1ddSLingrui98  def tagBits = VAddrBits - idxBits - instOffsetBits
25409c6f1ddSLingrui98
25509c6f1ddSLingrui98  val tag = UInt(tagBits.W)
25609c6f1ddSLingrui98  val idx = UInt(idxBits.W)
25709c6f1ddSLingrui98  val offset = UInt(instOffsetBits.W)
25809c6f1ddSLingrui98
25909c6f1ddSLingrui98  def fromUInt(x: UInt) = x.asTypeOf(UInt(VAddrBits.W)).asTypeOf(this)
26009c6f1ddSLingrui98  def getTag(x: UInt) = fromUInt(x).tag
26109c6f1ddSLingrui98  def getIdx(x: UInt) = fromUInt(x).idx
26209c6f1ddSLingrui98  def getBank(x: UInt) = if (banks > 1) getIdx(x)(log2Up(banks) - 1, 0) else 0.U
26309c6f1ddSLingrui98  def getBankIdx(x: UInt) = if (banks > 1) getIdx(x)(idxBits - 1, log2Up(banks)) else getIdx(x)
26409c6f1ddSLingrui98}
265eeb5ff92SLingrui98
266b37e4b45SLingrui98trait BasicPrediction extends HasXSParameter {
267b37e4b45SLingrui98  def cfiIndex: ValidUndirectioned[UInt]
268b37e4b45SLingrui98  def target(pc: UInt): UInt
269b37e4b45SLingrui98  def lastBrPosOH: Vec[Bool]
270b37e4b45SLingrui98  def brTaken: Bool
271b37e4b45SLingrui98  def shouldShiftVec: Vec[Bool]
272b37e4b45SLingrui98  def fallThruError: Bool
273b37e4b45SLingrui98  val oversize: Bool
274b37e4b45SLingrui98}
275b37e4b45SLingrui98class MinimalBranchPrediction(implicit p: Parameters) extends NewMicroBTBEntry with BasicPrediction {
276b37e4b45SLingrui98  val valid = Bool()
277b37e4b45SLingrui98  def cfiIndex = {
278b37e4b45SLingrui98    val res = Wire(ValidUndirectioned(UInt(log2Ceil(PredictWidth).W)))
279b37e4b45SLingrui98    res.valid := taken && valid
280b37e4b45SLingrui98    res.bits := cfiOffset | Fill(res.bits.getWidth, !valid)
281b37e4b45SLingrui98    res
282b37e4b45SLingrui98  }
283b37e4b45SLingrui98  def target(pc: UInt) = nextAddr
284b37e4b45SLingrui98  def lastBrPosOH: Vec[Bool] = VecInit(brNumOH.asBools())
285b37e4b45SLingrui98  def brTaken = takenOnBr
286b37e4b45SLingrui98  def shouldShiftVec: Vec[Bool] = VecInit((0 until numBr).map(i => lastBrPosOH.drop(i+1).reduce(_||_)))
287b37e4b45SLingrui98  def fallThruError: Bool = false.B
288b37e4b45SLingrui98
289b37e4b45SLingrui98  def fromMicroBTBEntry(valid: Bool, entry: NewMicroBTBEntry, pc: UInt) = {
290b37e4b45SLingrui98    this.valid := valid
291b37e4b45SLingrui98    this.nextAddr := Mux(valid, entry.nextAddr, pc + (FetchWidth*4).U)
292b37e4b45SLingrui98    this.cfiOffset := entry.cfiOffset | Fill(cfiOffset.getWidth, !valid)
293b37e4b45SLingrui98    this.taken := entry.taken && valid
294b37e4b45SLingrui98    this.takenOnBr := entry.takenOnBr && valid
295b37e4b45SLingrui98    this.brNumOH := Mux(valid, entry.brNumOH, 1.U(3.W))
296b37e4b45SLingrui98    this.oversize := entry.oversize && valid
297b37e4b45SLingrui98  }
298b37e4b45SLingrui98}
299eeb5ff92SLingrui98@chiselName
300b37e4b45SLingrui98class FullBranchPrediction(implicit p: Parameters) extends XSBundle with HasBPUConst with BasicPrediction {
301eeb5ff92SLingrui98  val br_taken_mask = Vec(numBr, Bool())
30209c6f1ddSLingrui98
303eeb5ff92SLingrui98  val slot_valids = Vec(totalSlot, Bool())
30409c6f1ddSLingrui98
305eeb5ff92SLingrui98  val targets = Vec(totalSlot, UInt(VAddrBits.W))
306b30c10d6SLingrui98  val jalr_target = UInt(VAddrBits.W) // special path for indirect predictors
307a229ab6cSLingrui98  val offsets = Vec(totalSlot, UInt(log2Ceil(PredictWidth).W))
308a229ab6cSLingrui98  val fallThroughAddr = UInt(VAddrBits.W)
309b37e4b45SLingrui98  val fallThroughErr = Bool()
310a229ab6cSLingrui98  val oversize = Bool()
31109c6f1ddSLingrui98
31209c6f1ddSLingrui98  val is_jal = Bool()
31309c6f1ddSLingrui98  val is_jalr = Bool()
31409c6f1ddSLingrui98  val is_call = Bool()
31509c6f1ddSLingrui98  val is_ret = Bool()
316eeb5ff92SLingrui98  val is_br_sharing = Bool()
31709c6f1ddSLingrui98
31809c6f1ddSLingrui98  // val call_is_rvc = Bool()
31909c6f1ddSLingrui98  val hit = Bool()
32009c6f1ddSLingrui98
321eeb5ff92SLingrui98  def br_slot_valids = slot_valids.init
322eeb5ff92SLingrui98  def tail_slot_valid = slot_valids.last
323eeb5ff92SLingrui98
324eeb5ff92SLingrui98  def br_valids = {
325b37e4b45SLingrui98    VecInit(br_slot_valids :+ (tail_slot_valid && is_br_sharing))
326eeb5ff92SLingrui98  }
327eeb5ff92SLingrui98
328eeb5ff92SLingrui98  def taken_mask_on_slot = {
329eeb5ff92SLingrui98    VecInit(
330eeb5ff92SLingrui98      (br_slot_valids zip br_taken_mask.init).map{ case (t, v) => t && v } :+ (
331b30c10d6SLingrui98        tail_slot_valid && (
332b30c10d6SLingrui98          is_br_sharing && br_taken_mask.last || !is_br_sharing
333b30c10d6SLingrui98        )
334eeb5ff92SLingrui98      )
335eeb5ff92SLingrui98    )
336eeb5ff92SLingrui98  }
337eeb5ff92SLingrui98
338b37e4b45SLingrui98  def real_slot_taken_mask(): Vec[Bool] = {
339b37e4b45SLingrui98    VecInit(taken_mask_on_slot.map(_ && hit))
340b37e4b45SLingrui98  }
341b37e4b45SLingrui98
342b37e4b45SLingrui98  // len numBr
343b37e4b45SLingrui98  def real_br_taken_mask(): Vec[Bool] = {
344b37e4b45SLingrui98    VecInit(
345b37e4b45SLingrui98      taken_mask_on_slot.map(_ && hit).init :+
346b37e4b45SLingrui98      (br_taken_mask.last && tail_slot_valid && is_br_sharing && hit)
347b37e4b45SLingrui98    )
348b37e4b45SLingrui98  }
349b37e4b45SLingrui98
350b37e4b45SLingrui98  // the vec indicating if ghr should shift on each branch
351b37e4b45SLingrui98  def shouldShiftVec =
352b37e4b45SLingrui98    VecInit(br_valids.zipWithIndex.map{ case (v, i) =>
353b37e4b45SLingrui98      v && !real_br_taken_mask.take(i).reduceOption(_||_).getOrElse(false.B)})
354b37e4b45SLingrui98
355b37e4b45SLingrui98  def lastBrPosOH =
356b37e4b45SLingrui98    VecInit((!hit || !br_valids.reduce(_||_)) +: // not hit or no brs in entry
357b37e4b45SLingrui98      (0 until numBr).map(i =>
358b37e4b45SLingrui98        br_valids(i) &&
359b37e4b45SLingrui98        !real_br_taken_mask.take(i).reduceOption(_||_).getOrElse(false.B) && // no brs taken in front it
360b37e4b45SLingrui98        (real_br_taken_mask()(i) || !br_valids.drop(i+1).reduceOption(_||_).getOrElse(false.B)) && // no brs behind it
361b37e4b45SLingrui98        hit
362b37e4b45SLingrui98      )
363b37e4b45SLingrui98    )
364b37e4b45SLingrui98
36586d9c530SLingrui98  def brTaken = (br_valids zip br_taken_mask).map{ case (a, b) => a && b && hit}.reduce(_||_)
366b37e4b45SLingrui98
367b37e4b45SLingrui98  def target(pc: UInt): UInt = {
368d3854a00SLingrui98    val targetVec = targets :+ fallThroughAddr :+ (pc + (FetchWidth * 4).U)
369d3854a00SLingrui98    val tm = taken_mask_on_slot
370d3854a00SLingrui98    val selVecOH =
371d3854a00SLingrui98      tm.zipWithIndex.map{ case (t, i) => !tm.take(i).fold(false.B)(_||_) && t && hit} :+
372d3854a00SLingrui98      (!tm.asUInt.orR && hit) :+ !hit
373d3854a00SLingrui98    Mux1H(selVecOH, targetVec)
374b37e4b45SLingrui98  }
375b37e4b45SLingrui98
376b37e4b45SLingrui98  def fallThruError: Bool = hit && fallThroughErr
377b37e4b45SLingrui98
378b37e4b45SLingrui98  def hit_taken_on_jmp =
379b37e4b45SLingrui98    !real_slot_taken_mask().init.reduce(_||_) &&
380b37e4b45SLingrui98    real_slot_taken_mask().last && !is_br_sharing
381b37e4b45SLingrui98  def hit_taken_on_call = hit_taken_on_jmp && is_call
382b37e4b45SLingrui98  def hit_taken_on_ret  = hit_taken_on_jmp && is_ret
383b37e4b45SLingrui98  def hit_taken_on_jalr = hit_taken_on_jmp && is_jalr
384b37e4b45SLingrui98
385b37e4b45SLingrui98  def cfiIndex = {
386b37e4b45SLingrui98    val cfiIndex = Wire(ValidUndirectioned(UInt(log2Ceil(PredictWidth).W)))
387b37e4b45SLingrui98    cfiIndex.valid := real_slot_taken_mask().asUInt.orR
388b37e4b45SLingrui98    // when no takens, set cfiIndex to PredictWidth-1
389b37e4b45SLingrui98    cfiIndex.bits :=
390b37e4b45SLingrui98      ParallelPriorityMux(real_slot_taken_mask(), offsets) |
391b37e4b45SLingrui98      Fill(log2Ceil(PredictWidth), (!real_slot_taken_mask().asUInt.orR).asUInt)
392b37e4b45SLingrui98    cfiIndex
393b37e4b45SLingrui98  }
394b37e4b45SLingrui98
395eeb5ff92SLingrui98  def taken = br_taken_mask.reduce(_||_) || slot_valids.last // || (is_jal || is_jalr)
39609c6f1ddSLingrui98
397b30c10d6SLingrui98  def fromFtbEntry(entry: FTBEntry, pc: UInt, last_stage: Option[Tuple2[UInt, Bool]] = None) = {
398eeb5ff92SLingrui98    slot_valids := entry.brSlots.map(_.valid) :+ entry.tailSlot.valid
399eeb5ff92SLingrui98    targets := entry.getTargetVec(pc)
400b30c10d6SLingrui98    jalr_target := targets.last
401a229ab6cSLingrui98    offsets := entry.getOffsetVec
402a229ab6cSLingrui98    oversize := entry.oversize
403eeb5ff92SLingrui98    is_jal := entry.tailSlot.valid && entry.isJal
404eeb5ff92SLingrui98    is_jalr := entry.tailSlot.valid && entry.isJalr
405eeb5ff92SLingrui98    is_call := entry.tailSlot.valid && entry.isCall
406eeb5ff92SLingrui98    is_ret := entry.tailSlot.valid && entry.isRet
407eeb5ff92SLingrui98    is_br_sharing := entry.tailSlot.valid && entry.tailSlot.sharing
408a229ab6cSLingrui98
409b37e4b45SLingrui98    val startLower        = Cat(0.U(1.W),    pc(instOffsetBits+log2Ceil(PredictWidth), instOffsetBits))
410b37e4b45SLingrui98    val endLowerwithCarry = Cat(entry.carry, entry.pftAddr)
411b37e4b45SLingrui98    fallThroughErr := startLower >= endLowerwithCarry || (endLowerwithCarry - startLower) > (PredictWidth+1).U
41286d9c530SLingrui98    fallThroughAddr := Mux(fallThroughErr, pc + (FetchWidth * 4).U, entry.getFallThrough(pc))
413a229ab6cSLingrui98  }
41409c6f1ddSLingrui98
41509c6f1ddSLingrui98  def display(cond: Bool): Unit = {
416eeb5ff92SLingrui98    XSDebug(cond, p"[taken_mask] ${Binary(br_taken_mask.asUInt)} [hit] $hit\n")
41709c6f1ddSLingrui98  }
41809c6f1ddSLingrui98}
41909c6f1ddSLingrui98
420bf358e08SLingrui98@chiselName
421b37e4b45SLingrui98class BranchPredictionBundle(implicit p: Parameters) extends XSBundle
422b37e4b45SLingrui98  with HasBPUConst with BPUUtils {
423b37e4b45SLingrui98  // def full_pred_info[T <: Data](x: T) = if (is_minimal) None else Some(x)
42409c6f1ddSLingrui98  val pc = UInt(VAddrBits.W)
42509c6f1ddSLingrui98
42609c6f1ddSLingrui98  val valid = Bool()
42709c6f1ddSLingrui98
42809c6f1ddSLingrui98  val hasRedirect = Bool()
42909c6f1ddSLingrui98  val ftq_idx = new FtqPtr
43009c6f1ddSLingrui98  // val hit = Bool()
431b37e4b45SLingrui98  val is_minimal = Bool()
432b37e4b45SLingrui98  val minimal_pred = new MinimalBranchPrediction
433b37e4b45SLingrui98  val full_pred = new FullBranchPrediction
434b37e4b45SLingrui98
43509c6f1ddSLingrui98
436dd6c0695SLingrui98  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
437c2ad24ebSLingrui98  val histPtr = new CGHPtr
43809c6f1ddSLingrui98  val rasSp = UInt(log2Ceil(RasSize).W)
43909c6f1ddSLingrui98  val rasTop = new RASEntry
440b37e4b45SLingrui98  // val specCnt = Vec(numBr, UInt(10.W))
44109c6f1ddSLingrui98  // val meta = UInt(MaxMetaLength.W)
44209c6f1ddSLingrui98
443b37e4b45SLingrui98  val ftb_entry = new FTBEntry()
44409c6f1ddSLingrui98
445b37e4b45SLingrui98  def target(pc: UInt) = Mux(is_minimal, minimal_pred.target(pc),     full_pred.target(pc))
446b37e4b45SLingrui98  def cfiIndex         = Mux(is_minimal, minimal_pred.cfiIndex,       full_pred.cfiIndex)
447b37e4b45SLingrui98  def lastBrPosOH      = Mux(is_minimal, minimal_pred.lastBrPosOH,    full_pred.lastBrPosOH)
448b37e4b45SLingrui98  def brTaken          = Mux(is_minimal, minimal_pred.brTaken,        full_pred.brTaken)
449b37e4b45SLingrui98  def shouldShiftVec   = Mux(is_minimal, minimal_pred.shouldShiftVec, full_pred.shouldShiftVec)
450b37e4b45SLingrui98  def oversize         = Mux(is_minimal, minimal_pred.oversize,       full_pred.oversize)
451b37e4b45SLingrui98  def fallThruError    = Mux(is_minimal, minimal_pred.fallThruError,  full_pred.fallThruError)
452eeb5ff92SLingrui98
453b37e4b45SLingrui98  def getTarget = target(pc)
454b37e4b45SLingrui98  def taken = cfiIndex.valid
45509c6f1ddSLingrui98
45609c6f1ddSLingrui98  def display(cond: Bool): Unit = {
45709c6f1ddSLingrui98    XSDebug(cond, p"[pc] ${Hexadecimal(pc)}\n")
458dd6c0695SLingrui98    folded_hist.display(cond)
459b37e4b45SLingrui98    full_pred.display(cond)
46009c6f1ddSLingrui98    ftb_entry.display(cond)
46109c6f1ddSLingrui98  }
46209c6f1ddSLingrui98}
46309c6f1ddSLingrui98
464bf358e08SLingrui98@chiselName
46509c6f1ddSLingrui98class BranchPredictionResp(implicit p: Parameters) extends XSBundle with HasBPUConst {
46609c6f1ddSLingrui98  // val valids = Vec(3, Bool())
467b37e4b45SLingrui98  val s1 = new BranchPredictionBundle
468b37e4b45SLingrui98  val s2 = new BranchPredictionBundle
469*cb4f77ceSLingrui98  val s3 = new BranchPredictionBundle
47009c6f1ddSLingrui98
471b37e4b45SLingrui98  def selectedResp ={
472b37e4b45SLingrui98    val res =
47309c6f1ddSLingrui98      PriorityMux(Seq(
474*cb4f77ceSLingrui98        ((s3.valid && s3.hasRedirect) -> s3),
47509c6f1ddSLingrui98        ((s2.valid && s2.hasRedirect) -> s2),
47609c6f1ddSLingrui98        (s1.valid -> s1)
47709c6f1ddSLingrui98      ))
478b37e4b45SLingrui98    // println("is minimal: ", res.is_minimal)
479b37e4b45SLingrui98    res
480b37e4b45SLingrui98  }
48109c6f1ddSLingrui98  def selectedRespIdx =
48209c6f1ddSLingrui98    PriorityMux(Seq(
483*cb4f77ceSLingrui98      ((s3.valid && s3.hasRedirect) -> BP_S3),
48409c6f1ddSLingrui98      ((s2.valid && s2.hasRedirect) -> BP_S2),
48509c6f1ddSLingrui98      (s1.valid -> BP_S1)
48609c6f1ddSLingrui98    ))
487*cb4f77ceSLingrui98  def lastStage = s3
48809c6f1ddSLingrui98}
48909c6f1ddSLingrui98
49009c6f1ddSLingrui98class BpuToFtqBundle(implicit p: Parameters) extends BranchPredictionResp with HasBPUConst {
49109c6f1ddSLingrui98  val meta = UInt(MaxMetaLength.W)
49209c6f1ddSLingrui98}
49309c6f1ddSLingrui98
49409c6f1ddSLingrui98object BpuToFtqBundle {
49509c6f1ddSLingrui98  def apply(resp: BranchPredictionResp)(implicit p: Parameters): BpuToFtqBundle = {
49609c6f1ddSLingrui98    val e = Wire(new BpuToFtqBundle())
49709c6f1ddSLingrui98    e.s1 := resp.s1
49809c6f1ddSLingrui98    e.s2 := resp.s2
499*cb4f77ceSLingrui98    e.s3 := resp.s3
50009c6f1ddSLingrui98
50109c6f1ddSLingrui98    e.meta := DontCare
50209c6f1ddSLingrui98    e
50309c6f1ddSLingrui98  }
50409c6f1ddSLingrui98}
50509c6f1ddSLingrui98
50609c6f1ddSLingrui98class BranchPredictionUpdate(implicit p: Parameters) extends BranchPredictionBundle with HasBPUConst {
50709c6f1ddSLingrui98  val mispred_mask = Vec(numBr+1, Bool())
508edc18578SLingrui98  val pred_hit = Bool()
50909c6f1ddSLingrui98  val false_hit = Bool()
51009c6f1ddSLingrui98  val new_br_insert_pos = Vec(numBr, Bool())
51109c6f1ddSLingrui98  val old_entry = Bool()
51209c6f1ddSLingrui98  val meta = UInt(MaxMetaLength.W)
513abdbe4b7SLingrui98  val full_target = UInt(VAddrBits.W)
514edc18578SLingrui98  val from_stage = UInt(2.W)
51586d9c530SLingrui98  val ghist = UInt(HistoryLength.W)
51609c6f1ddSLingrui98
51709c6f1ddSLingrui98  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
518dd6c0695SLingrui98    folded_hist := entry.folded_hist
519c2ad24ebSLingrui98    histPtr := entry.histPtr
52009c6f1ddSLingrui98    rasSp := entry.rasSp
52109c6f1ddSLingrui98    rasTop := entry.rasEntry
52209c6f1ddSLingrui98    this
52309c6f1ddSLingrui98  }
52409c6f1ddSLingrui98
525c2ad24ebSLingrui98  override def display(cond: Bool) = {
52609c6f1ddSLingrui98    XSDebug(cond, p"-----------BranchPredictionUpdate-----------\n")
52709c6f1ddSLingrui98    XSDebug(cond, p"[mispred_mask] ${Binary(mispred_mask.asUInt)} [false_hit] $false_hit\n")
52809c6f1ddSLingrui98    XSDebug(cond, p"[new_br_insert_pos] ${Binary(new_br_insert_pos.asUInt)}\n")
52909c6f1ddSLingrui98    super.display(cond)
53009c6f1ddSLingrui98    XSDebug(cond, p"--------------------------------------------\n")
53109c6f1ddSLingrui98  }
53209c6f1ddSLingrui98}
53309c6f1ddSLingrui98
53409c6f1ddSLingrui98class BranchPredictionRedirect(implicit p: Parameters) extends Redirect with HasBPUConst {
53509c6f1ddSLingrui98  // override def toPrintable: Printable = {
53609c6f1ddSLingrui98  //   p"-----------BranchPredictionRedirect----------- " +
53709c6f1ddSLingrui98  //     p"-----------cfiUpdate----------- " +
53809c6f1ddSLingrui98  //     p"[pc] ${Hexadecimal(cfiUpdate.pc)} " +
53909c6f1ddSLingrui98  //     p"[predTaken] ${cfiUpdate.predTaken}, [taken] ${cfiUpdate.taken}, [isMisPred] ${cfiUpdate.isMisPred} " +
54009c6f1ddSLingrui98  //     p"[target] ${Hexadecimal(cfiUpdate.target)} " +
54109c6f1ddSLingrui98  //     p"------------------------------- " +
5429aca92b9SYinan Xu  //     p"[robPtr] f=${robIdx.flag} v=${robIdx.value} " +
54309c6f1ddSLingrui98  //     p"[ftqPtr] f=${ftqIdx.flag} v=${ftqIdx.value} " +
54409c6f1ddSLingrui98  //     p"[ftqOffset] ${ftqOffset} " +
54509c6f1ddSLingrui98  //     p"[level] ${level}, [interrupt] ${interrupt} " +
54609c6f1ddSLingrui98  //     p"[stFtqIdx] f=${stFtqIdx.flag} v=${stFtqIdx.value} " +
54709c6f1ddSLingrui98  //     p"[stFtqOffset] ${stFtqOffset} " +
54809c6f1ddSLingrui98  //     p"\n"
54909c6f1ddSLingrui98
55009c6f1ddSLingrui98  // }
55109c6f1ddSLingrui98
55209c6f1ddSLingrui98  def display(cond: Bool): Unit = {
55309c6f1ddSLingrui98    XSDebug(cond, p"-----------BranchPredictionRedirect----------- \n")
55409c6f1ddSLingrui98    XSDebug(cond, p"-----------cfiUpdate----------- \n")
55509c6f1ddSLingrui98    XSDebug(cond, p"[pc] ${Hexadecimal(cfiUpdate.pc)}\n")
556c2ad24ebSLingrui98    // XSDebug(cond, p"[hist] ${Binary(cfiUpdate.hist.predHist)}\n")
55709c6f1ddSLingrui98    XSDebug(cond, p"[br_hit] ${cfiUpdate.br_hit} [isMisPred] ${cfiUpdate.isMisPred}\n")
55809c6f1ddSLingrui98    XSDebug(cond, p"[pred_taken] ${cfiUpdate.predTaken} [taken] ${cfiUpdate.taken} [isMisPred] ${cfiUpdate.isMisPred}\n")
55909c6f1ddSLingrui98    XSDebug(cond, p"[target] ${Hexadecimal(cfiUpdate.target)} \n")
56009c6f1ddSLingrui98    XSDebug(cond, p"[shift] ${cfiUpdate.shift}\n")
56109c6f1ddSLingrui98    XSDebug(cond, p"------------------------------- \n")
5629aca92b9SYinan Xu    XSDebug(cond, p"[robPtr] f=${robIdx.flag} v=${robIdx.value}\n")
56309c6f1ddSLingrui98    XSDebug(cond, p"[ftqPtr] f=${ftqIdx.flag} v=${ftqIdx.value} \n")
56409c6f1ddSLingrui98    XSDebug(cond, p"[ftqOffset] ${ftqOffset} \n")
56509c6f1ddSLingrui98    XSDebug(cond, p"[stFtqIdx] f=${stFtqIdx.flag} v=${stFtqIdx.value}\n")
56609c6f1ddSLingrui98    XSDebug(cond, p"[stFtqOffset] ${stFtqOffset}\n")
56709c6f1ddSLingrui98    XSDebug(cond, p"---------------------------------------------- \n")
56809c6f1ddSLingrui98  }
56909c6f1ddSLingrui98}
570