xref: /XiangShan/src/main/scala/xiangshan/frontend/FrontendBundle.scala (revision 3e52bed1735f5821bebb79dbb9b148cbb019938d)
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._
2309c6f1ddSLingrui98import utils._
24c2ad24ebSLingrui98import scala.math._
2509c6f1ddSLingrui98
26bf358e08SLingrui98@chiselName
2709c6f1ddSLingrui98class FetchRequestBundle(implicit p: Parameters) extends XSBundle {
2809c6f1ddSLingrui98  val startAddr       = UInt(VAddrBits.W)
2909c6f1ddSLingrui98  val fallThruAddr    = UInt(VAddrBits.W)
3009c6f1ddSLingrui98  val fallThruError   = Bool()
3109c6f1ddSLingrui98  val ftqIdx          = new FtqPtr
3209c6f1ddSLingrui98  val ftqOffset       = ValidUndirectioned(UInt(log2Ceil(PredictWidth).W))
3309c6f1ddSLingrui98  val target          = UInt(VAddrBits.W)
3409c6f1ddSLingrui98  val oversize        = Bool()
3509c6f1ddSLingrui98
3609c6f1ddSLingrui98  def fromFtqPcBundle(b: Ftq_RF_Components) = {
375ff19bd8SLingrui98    val ftError = b.fallThroughError()
3809c6f1ddSLingrui98    this.startAddr := b.startAddr
395ff19bd8SLingrui98    this.fallThruError := ftError
405ff19bd8SLingrui98    this.fallThruAddr := Mux(ftError, b.nextRangeAddr, b.getFallThrough())
4109c6f1ddSLingrui98    this.oversize := b.oversize
4209c6f1ddSLingrui98    this
4309c6f1ddSLingrui98  }
4409c6f1ddSLingrui98  def fromBpuResp(resp: BranchPredictionBundle) = {
4509c6f1ddSLingrui98    // only used to bypass, so some fields remains unchanged
4609c6f1ddSLingrui98    this.startAddr := resp.pc
4709c6f1ddSLingrui98    this.target := resp.target
4809c6f1ddSLingrui98    this.ftqOffset := resp.genCfiIndex
49a229ab6cSLingrui98    this.fallThruAddr := resp.preds.fallThroughAddr
50a229ab6cSLingrui98    this.oversize := resp.preds.oversize
5109c6f1ddSLingrui98    this
5209c6f1ddSLingrui98  }
5309c6f1ddSLingrui98  override def toPrintable: Printable = {
5409c6f1ddSLingrui98    p"[start] ${Hexadecimal(startAddr)} [pft] ${Hexadecimal(fallThruAddr)}" +
5509c6f1ddSLingrui98      p"[tgt] ${Hexadecimal(target)} [ftqIdx] $ftqIdx [jmp] v:${ftqOffset.valid}" +
5609c6f1ddSLingrui98      p" offset: ${ftqOffset.bits}\n"
5709c6f1ddSLingrui98  }
5809c6f1ddSLingrui98}
5909c6f1ddSLingrui98
6009c6f1ddSLingrui98class PredecodeWritebackBundle(implicit p:Parameters) extends XSBundle {
6109c6f1ddSLingrui98  val pc           = Vec(PredictWidth, UInt(VAddrBits.W))
6209c6f1ddSLingrui98  val pd           = Vec(PredictWidth, new PreDecodeInfo) // TODO: redefine Predecode
6309c6f1ddSLingrui98  val ftqIdx       = new FtqPtr
6409c6f1ddSLingrui98  val ftqOffset    = UInt(log2Ceil(PredictWidth).W)
6509c6f1ddSLingrui98  val misOffset    = ValidUndirectioned(UInt(log2Ceil(PredictWidth).W))
6609c6f1ddSLingrui98  val cfiOffset    = ValidUndirectioned(UInt(log2Ceil(PredictWidth).W))
6709c6f1ddSLingrui98  val target       = UInt(VAddrBits.W)
6809c6f1ddSLingrui98  val jalTarget    = UInt(VAddrBits.W)
6909c6f1ddSLingrui98  val instrRange   = Vec(PredictWidth, Bool())
7009c6f1ddSLingrui98}
7109c6f1ddSLingrui98
7209c6f1ddSLingrui98class Exception(implicit p: Parameters) extends XSBundle {
7309c6f1ddSLingrui98
7409c6f1ddSLingrui98}
7509c6f1ddSLingrui98
7609c6f1ddSLingrui98class FetchToIBuffer(implicit p: Parameters) extends XSBundle {
7709c6f1ddSLingrui98  val instrs    = Vec(PredictWidth, UInt(32.W))
7809c6f1ddSLingrui98  val valid     = UInt(PredictWidth.W)
7909c6f1ddSLingrui98  val pd        = Vec(PredictWidth, new PreDecodeInfo)
8009c6f1ddSLingrui98  val pc        = Vec(PredictWidth, UInt(VAddrBits.W))
8109c6f1ddSLingrui98  val foldpc    = Vec(PredictWidth, UInt(MemPredPCWidth.W))
8209c6f1ddSLingrui98  //val exception = new Exception
8309c6f1ddSLingrui98  val ftqPtr       = new FtqPtr
8409c6f1ddSLingrui98  val ftqOffset    = Vec(PredictWidth, ValidUndirectioned(UInt(log2Ceil(PredictWidth).W)))
8509c6f1ddSLingrui98  val ipf          = Vec(PredictWidth, Bool())
8609c6f1ddSLingrui98  val acf          = Vec(PredictWidth, Bool())
8709c6f1ddSLingrui98  val crossPageIPFFix = Vec(PredictWidth, Bool())
8872951335SLi Qianruo  val triggered    = Vec(PredictWidth, new TriggerCf)
8909c6f1ddSLingrui98}
9009c6f1ddSLingrui98
91c2ad24ebSLingrui98// class BitWiseUInt(val width: Int, val init: UInt) extends Module {
92c2ad24ebSLingrui98//   val io = IO(new Bundle {
93c2ad24ebSLingrui98//     val set
94c2ad24ebSLingrui98//   })
95c2ad24ebSLingrui98// }
9609c6f1ddSLingrui98// Move from BPU
97c2ad24ebSLingrui98abstract class GlobalHistory(implicit p: Parameters) extends XSBundle with HasBPUConst {
98c2ad24ebSLingrui98  def update(br_valids: Vec[Bool], real_taken_mask: Vec[Bool]): GlobalHistory
99c2ad24ebSLingrui98}
100c2ad24ebSLingrui98
101c2ad24ebSLingrui98class ShiftingGlobalHistory(implicit p: Parameters) extends GlobalHistory {
10209c6f1ddSLingrui98  val predHist = UInt(HistoryLength.W)
10309c6f1ddSLingrui98
104c2ad24ebSLingrui98  def update(shift: UInt, taken: Bool, hist: UInt = this.predHist): ShiftingGlobalHistory = {
105c2ad24ebSLingrui98    val g = Wire(new ShiftingGlobalHistory)
10609c6f1ddSLingrui98    g.predHist := (hist << shift) | taken
10709c6f1ddSLingrui98    g
10809c6f1ddSLingrui98  }
10909c6f1ddSLingrui98
110c2ad24ebSLingrui98  def update(br_valids: Vec[Bool], real_taken_mask: Vec[Bool]): ShiftingGlobalHistory = {
111eeb5ff92SLingrui98    require(br_valids.length == numBr)
112eeb5ff92SLingrui98    require(real_taken_mask.length == numBr)
113eeb5ff92SLingrui98    val last_valid_idx = PriorityMux(
114eeb5ff92SLingrui98      br_valids.reverse :+ true.B,
115eeb5ff92SLingrui98      (numBr to 0 by -1).map(_.U(log2Ceil(numBr+1).W))
116eeb5ff92SLingrui98    )
117eeb5ff92SLingrui98    val first_taken_idx = PriorityEncoder(false.B +: real_taken_mask)
118eeb5ff92SLingrui98    val smaller = Mux(last_valid_idx < first_taken_idx,
119eeb5ff92SLingrui98      last_valid_idx,
120eeb5ff92SLingrui98      first_taken_idx
121eeb5ff92SLingrui98    )
122eeb5ff92SLingrui98    val shift = smaller
123eeb5ff92SLingrui98    val taken = real_taken_mask.reduce(_||_)
124eeb5ff92SLingrui98    update(shift, taken, this.predHist)
125eeb5ff92SLingrui98  }
126eeb5ff92SLingrui98
127c2ad24ebSLingrui98  // static read
128c2ad24ebSLingrui98  def read(n: Int): Bool = predHist.asBools()(n)
129c2ad24ebSLingrui98
130c2ad24ebSLingrui98  final def === (that: ShiftingGlobalHistory): Bool = {
13109c6f1ddSLingrui98    predHist === that.predHist
13209c6f1ddSLingrui98  }
13309c6f1ddSLingrui98
134c2ad24ebSLingrui98  final def =/= (that: ShiftingGlobalHistory): Bool = !(this === that)
135c2ad24ebSLingrui98}
13609c6f1ddSLingrui98
137c2ad24ebSLingrui98// circular global history pointer
138c2ad24ebSLingrui98class CGHPtr(implicit p: Parameters) extends CircularQueuePtr[CGHPtr](
139c2ad24ebSLingrui98  p => p(XSCoreParamsKey).HistoryLength
140c2ad24ebSLingrui98){
141c2ad24ebSLingrui98  override def cloneType = (new CGHPtr).asInstanceOf[this.type]
142c2ad24ebSLingrui98}
143c2ad24ebSLingrui98class CircularGlobalHistory(implicit p: Parameters) extends GlobalHistory {
144c2ad24ebSLingrui98  val buffer = Vec(HistoryLength, Bool())
145c2ad24ebSLingrui98  type HistPtr = UInt
146c2ad24ebSLingrui98  def update(br_valids: Vec[Bool], real_taken_mask: Vec[Bool]): CircularGlobalHistory = {
147c2ad24ebSLingrui98    this
148c2ad24ebSLingrui98  }
149c2ad24ebSLingrui98}
150c2ad24ebSLingrui98
151dd6c0695SLingrui98class FoldedHistory(val len: Int, val compLen: Int, val max_update_num: Int)(implicit p: Parameters)
152c2ad24ebSLingrui98  extends XSBundle with HasBPUConst {
153dd6c0695SLingrui98  require(compLen >= 1)
154c2ad24ebSLingrui98  require(len > 0)
155c2ad24ebSLingrui98  // require(folded_len <= len)
156dd6c0695SLingrui98  require(compLen >= max_update_num)
157dd6c0695SLingrui98  val folded_hist = UInt(compLen.W)
158dd6c0695SLingrui98
159dd6c0695SLingrui98  def info = (len, compLen)
160c2ad24ebSLingrui98  def oldest_bit_to_get_from_ghr = (0 until max_update_num).map(len - _ - 1)
161c2ad24ebSLingrui98  def oldest_bit_pos_in_folded = oldest_bit_to_get_from_ghr map (_ % compLen)
162c2ad24ebSLingrui98  def oldest_bit_wrap_around = oldest_bit_to_get_from_ghr map (_ / compLen > 0)
163c2ad24ebSLingrui98  def oldest_bit_start = oldest_bit_pos_in_folded.head
164c2ad24ebSLingrui98
165dd6c0695SLingrui98  def get_oldest_bits_from_ghr(ghr: Vec[Bool], histPtr: CGHPtr) = {
166c2ad24ebSLingrui98    // TODO: wrap inc for histPtr value
167dd6c0695SLingrui98    oldest_bit_to_get_from_ghr.map(i => ghr((histPtr + (i+1).U).value))
168c2ad24ebSLingrui98  }
169c2ad24ebSLingrui98
170ab890bfeSLingrui98  def circular_shift_left(src: UInt, shamt: Int) = {
171c2ad24ebSLingrui98    val srcLen = src.getWidth
172c2ad24ebSLingrui98    val src_doubled = Cat(src, src)
173ab890bfeSLingrui98    val shifted = src_doubled(srcLen*2-1-shamt, srcLen-shamt)
174ab890bfeSLingrui98    shifted
175c2ad24ebSLingrui98  }
176c2ad24ebSLingrui98
177c2ad24ebSLingrui98
178ab890bfeSLingrui98  def update(ghr: Vec[Bool], histPtr: CGHPtr, num: Int, taken: Bool): FoldedHistory = {
179c2ad24ebSLingrui98    // do xors for several bitsets at specified bits
180c2ad24ebSLingrui98    def bitsets_xor(len: Int, bitsets: Seq[Seq[Tuple2[Int, Bool]]]) = {
181c2ad24ebSLingrui98      val res = Wire(Vec(len, Bool()))
182c2ad24ebSLingrui98      // println(f"num bitsets: ${bitsets.length}")
183c2ad24ebSLingrui98      // println(f"bitsets $bitsets")
184c2ad24ebSLingrui98      val resArr = Array.fill(len)(List[Bool]())
185c2ad24ebSLingrui98      for (bs <- bitsets) {
186c2ad24ebSLingrui98        for ((n, b) <- bs) {
187c2ad24ebSLingrui98          resArr(n) = b :: resArr(n)
188c2ad24ebSLingrui98        }
189c2ad24ebSLingrui98      }
190c2ad24ebSLingrui98      // println(f"${resArr.mkString}")
191c2ad24ebSLingrui98      // println(f"histLen: ${this.len}, foldedLen: $folded_len")
192c2ad24ebSLingrui98      for (i <- 0 until len) {
193c2ad24ebSLingrui98        // println(f"bit[$i], ${resArr(i).mkString}")
194c2ad24ebSLingrui98        if (resArr(i).length > 2) {
195c2ad24ebSLingrui98          println(f"[warning] update logic of foldest history has two or more levels of xor gates! " +
196dd6c0695SLingrui98            f"histlen:${this.len}, compLen:$compLen")
197c2ad24ebSLingrui98        }
198c2ad24ebSLingrui98        if (resArr(i).length == 0) {
199dd6c0695SLingrui98          println(f"[error] bits $i is not assigned in folded hist update logic! histlen:${this.len}, compLen:$compLen")
200c2ad24ebSLingrui98        }
201c2ad24ebSLingrui98        res(i) := resArr(i).foldLeft(false.B)(_^_)
202c2ad24ebSLingrui98      }
203c2ad24ebSLingrui98      res.asUInt
204c2ad24ebSLingrui98    }
205dd6c0695SLingrui98    val oldest_bits = get_oldest_bits_from_ghr(ghr, histPtr)
206c2ad24ebSLingrui98
207c2ad24ebSLingrui98    // mask off bits that do not update
208c2ad24ebSLingrui98    val oldest_bits_masked = oldest_bits.zipWithIndex.map{
209ab890bfeSLingrui98      case (ob, i) => ob && (i < num).B
210c2ad24ebSLingrui98    }
211c2ad24ebSLingrui98    // if a bit does not wrap around, it should not be xored when it exits
212c2ad24ebSLingrui98    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)))
213c2ad24ebSLingrui98
214c2ad24ebSLingrui98    // println(f"old bits pos ${oldest_bits_set.map(_._1)}")
215c2ad24ebSLingrui98
216c2ad24ebSLingrui98    // only the last bit could be 1, as we have at most one taken branch at a time
217ab890bfeSLingrui98    val newest_bits_masked = VecInit((0 until max_update_num).map(i => taken && ((i+1) == num).B)).asUInt
218c2ad24ebSLingrui98    // if a bit does not wrap around, newest bits should not be xored onto it either
219e992912cSLingrui98    val newest_bits_set = (0 until max_update_num).map(i => (compLen-1-i, newest_bits_masked(i)))
220c2ad24ebSLingrui98
221c2ad24ebSLingrui98    // println(f"new bits set ${newest_bits_set.map(_._1)}")
222c2ad24ebSLingrui98    //
223c2ad24ebSLingrui98    val original_bits_masked = VecInit(folded_hist.asBools.zipWithIndex.map{
224ab890bfeSLingrui98      case (fb, i) => fb && !(num >= (len-i)).B
225c2ad24ebSLingrui98    })
226c2ad24ebSLingrui98    val original_bits_set = (0 until compLen).map(i => (i, original_bits_masked(i)))
227c2ad24ebSLingrui98
228c2ad24ebSLingrui98
229c2ad24ebSLingrui98    // histLen too short to wrap around
230c2ad24ebSLingrui98    val new_folded_hist =
231dd6c0695SLingrui98      if (len <= compLen) {
232dd6c0695SLingrui98        ((folded_hist << num) | taken)(compLen-1,0)
233c2ad24ebSLingrui98        // circular_shift_left(max_update_num)(Cat(Reverse(newest_bits_masked), folded_hist(compLen-max_update_num-1,0)), num)
234c2ad24ebSLingrui98      } else {
235c2ad24ebSLingrui98        // do xor then shift
236c2ad24ebSLingrui98        val xored = bitsets_xor(compLen, Seq(original_bits_set, oldest_bits_set, newest_bits_set))
237ab890bfeSLingrui98        circular_shift_left(xored, num)
238c2ad24ebSLingrui98      }
239c2ad24ebSLingrui98    val fh = WireInit(this)
240c2ad24ebSLingrui98    fh.folded_hist := new_folded_hist
241c2ad24ebSLingrui98    fh
242c2ad24ebSLingrui98  }
243c2ad24ebSLingrui98
244dd6c0695SLingrui98  // def update(ghr: Vec[Bool], histPtr: CGHPtr, valids: Vec[Bool], takens: Vec[Bool]): FoldedHistory = {
245dd6c0695SLingrui98  //   val fh = WireInit(this)
246dd6c0695SLingrui98  //   require(valids.length == max_update_num)
247dd6c0695SLingrui98  //   require(takens.length == max_update_num)
248dd6c0695SLingrui98  //   val last_valid_idx = PriorityMux(
249dd6c0695SLingrui98  //     valids.reverse :+ true.B,
250dd6c0695SLingrui98  //     (max_update_num to 0 by -1).map(_.U(log2Ceil(max_update_num+1).W))
251dd6c0695SLingrui98  //     )
252dd6c0695SLingrui98  //   val first_taken_idx = PriorityEncoder(false.B +: takens)
253dd6c0695SLingrui98  //   val smaller = Mux(last_valid_idx < first_taken_idx,
254dd6c0695SLingrui98  //     last_valid_idx,
255dd6c0695SLingrui98  //     first_taken_idx
256dd6c0695SLingrui98  //   )
257dd6c0695SLingrui98  //   // update folded_hist
258dd6c0695SLingrui98  //   fh.update(ghr, histPtr, smaller, takens.reduce(_||_))
259dd6c0695SLingrui98  // }
260c2ad24ebSLingrui98  // println(f"folded hist original length: ${len}, folded len: ${folded_len} " +
261c2ad24ebSLingrui98  //   f"oldest bits' pos in folded: ${oldest_bit_pos_in_folded}")
262c2ad24ebSLingrui98
263c2ad24ebSLingrui98
26409c6f1ddSLingrui98}
26509c6f1ddSLingrui98
26609c6f1ddSLingrui98class TableAddr(val idxBits: Int, val banks: Int)(implicit p: Parameters) extends XSBundle{
26709c6f1ddSLingrui98  def tagBits = VAddrBits - idxBits - instOffsetBits
26809c6f1ddSLingrui98
26909c6f1ddSLingrui98  val tag = UInt(tagBits.W)
27009c6f1ddSLingrui98  val idx = UInt(idxBits.W)
27109c6f1ddSLingrui98  val offset = UInt(instOffsetBits.W)
27209c6f1ddSLingrui98
27309c6f1ddSLingrui98  def fromUInt(x: UInt) = x.asTypeOf(UInt(VAddrBits.W)).asTypeOf(this)
27409c6f1ddSLingrui98  def getTag(x: UInt) = fromUInt(x).tag
27509c6f1ddSLingrui98  def getIdx(x: UInt) = fromUInt(x).idx
27609c6f1ddSLingrui98  def getBank(x: UInt) = if (banks > 1) getIdx(x)(log2Up(banks) - 1, 0) else 0.U
27709c6f1ddSLingrui98  def getBankIdx(x: UInt) = if (banks > 1) getIdx(x)(idxBits - 1, log2Up(banks)) else getIdx(x)
27809c6f1ddSLingrui98}
279eeb5ff92SLingrui98
280eeb5ff92SLingrui98@chiselName
28109c6f1ddSLingrui98class BranchPrediction(implicit p: Parameters) extends XSBundle with HasBPUConst {
282eeb5ff92SLingrui98  val br_taken_mask = Vec(numBr, Bool())
28309c6f1ddSLingrui98
284eeb5ff92SLingrui98  val slot_valids = Vec(totalSlot, Bool())
28509c6f1ddSLingrui98
286eeb5ff92SLingrui98  val targets = Vec(totalSlot, UInt(VAddrBits.W))
287a229ab6cSLingrui98  val offsets = Vec(totalSlot, UInt(log2Ceil(PredictWidth).W))
288a229ab6cSLingrui98  val fallThroughAddr = UInt(VAddrBits.W)
289a229ab6cSLingrui98  val oversize = Bool()
29009c6f1ddSLingrui98
29109c6f1ddSLingrui98  val is_jal = Bool()
29209c6f1ddSLingrui98  val is_jalr = Bool()
29309c6f1ddSLingrui98  val is_call = Bool()
29409c6f1ddSLingrui98  val is_ret = Bool()
295eeb5ff92SLingrui98  val is_br_sharing = Bool()
29609c6f1ddSLingrui98
29709c6f1ddSLingrui98  // val call_is_rvc = Bool()
29809c6f1ddSLingrui98  val hit = Bool()
29909c6f1ddSLingrui98
300eeb5ff92SLingrui98  def br_slot_valids = slot_valids.init
301eeb5ff92SLingrui98  def tail_slot_valid = slot_valids.last
302eeb5ff92SLingrui98
303eeb5ff92SLingrui98  def br_valids = {
304eeb5ff92SLingrui98    VecInit(
305eeb5ff92SLingrui98      if (shareTailSlot)
306eeb5ff92SLingrui98        br_slot_valids :+ (tail_slot_valid && is_br_sharing)
307eeb5ff92SLingrui98      else
308eeb5ff92SLingrui98        br_slot_valids
309eeb5ff92SLingrui98    )
310eeb5ff92SLingrui98  }
311eeb5ff92SLingrui98
312eeb5ff92SLingrui98  def taken_mask_on_slot = {
313eeb5ff92SLingrui98    VecInit(
314eeb5ff92SLingrui98      if (shareTailSlot)
315eeb5ff92SLingrui98        (br_slot_valids zip br_taken_mask.init).map{ case (t, v) => t && v } :+ (
316eeb5ff92SLingrui98          (br_taken_mask.last && tail_slot_valid && is_br_sharing) ||
317eeb5ff92SLingrui98          tail_slot_valid && !is_br_sharing
318eeb5ff92SLingrui98        )
319eeb5ff92SLingrui98      else
320eeb5ff92SLingrui98        (br_slot_valids zip br_taken_mask).map{ case (v, t) => v && t } :+
321eeb5ff92SLingrui98        tail_slot_valid
322eeb5ff92SLingrui98    )
323eeb5ff92SLingrui98  }
324eeb5ff92SLingrui98
325eeb5ff92SLingrui98  def taken = br_taken_mask.reduce(_||_) || slot_valids.last // || (is_jal || is_jalr)
32609c6f1ddSLingrui98
32709c6f1ddSLingrui98  def fromFtbEntry(entry: FTBEntry, pc: UInt) = {
328eeb5ff92SLingrui98    slot_valids := entry.brSlots.map(_.valid) :+ entry.tailSlot.valid
329eeb5ff92SLingrui98    targets := entry.getTargetVec(pc)
330a229ab6cSLingrui98    offsets := entry.getOffsetVec
331a229ab6cSLingrui98    fallThroughAddr := entry.getFallThrough(pc)
332a229ab6cSLingrui98    oversize := entry.oversize
333eeb5ff92SLingrui98    is_jal := entry.tailSlot.valid && entry.isJal
334eeb5ff92SLingrui98    is_jalr := entry.tailSlot.valid && entry.isJalr
335eeb5ff92SLingrui98    is_call := entry.tailSlot.valid && entry.isCall
336eeb5ff92SLingrui98    is_ret := entry.tailSlot.valid && entry.isRet
337eeb5ff92SLingrui98    is_br_sharing := entry.tailSlot.valid && entry.tailSlot.sharing
33809c6f1ddSLingrui98  }
339a229ab6cSLingrui98
340a229ab6cSLingrui98  def fromMicroBTBEntry(entry: MicroBTBEntry) = {
341a229ab6cSLingrui98    slot_valids := entry.slot_valids
342a229ab6cSLingrui98    targets := entry.targets
343a229ab6cSLingrui98    offsets := entry.offsets
344a229ab6cSLingrui98    fallThroughAddr := entry.fallThroughAddr
345a229ab6cSLingrui98    oversize := entry.oversize
346a229ab6cSLingrui98    is_jal := DontCare
347a229ab6cSLingrui98    is_jalr := DontCare
348a229ab6cSLingrui98    is_call := DontCare
349a229ab6cSLingrui98    is_ret := DontCare
350a229ab6cSLingrui98    is_br_sharing := entry.last_is_br
351a229ab6cSLingrui98  }
35209c6f1ddSLingrui98  // override def toPrintable: Printable = {
35309c6f1ddSLingrui98  //   p"-----------BranchPrediction----------- " +
35409c6f1ddSLingrui98  //     p"[taken_mask] ${Binary(taken_mask.asUInt)} " +
35509c6f1ddSLingrui98  //     p"[is_br] ${Binary(is_br.asUInt)}, [is_jal] ${Binary(is_jal.asUInt)} " +
35609c6f1ddSLingrui98  //     p"[is_jalr] ${Binary(is_jalr.asUInt)}, [is_call] ${Binary(is_call.asUInt)}, [is_ret] ${Binary(is_ret.asUInt)} " +
35709c6f1ddSLingrui98  //     p"[target] ${Hexadecimal(target)}}, [hit] $hit "
35809c6f1ddSLingrui98  // }
35909c6f1ddSLingrui98
36009c6f1ddSLingrui98  def display(cond: Bool): Unit = {
361eeb5ff92SLingrui98    XSDebug(cond, p"[taken_mask] ${Binary(br_taken_mask.asUInt)} [hit] $hit\n")
36209c6f1ddSLingrui98  }
36309c6f1ddSLingrui98}
36409c6f1ddSLingrui98
365bf358e08SLingrui98@chiselName
36609c6f1ddSLingrui98class BranchPredictionBundle(implicit p: Parameters) extends XSBundle with HasBPUConst with BPUUtils{
36709c6f1ddSLingrui98  val pc = UInt(VAddrBits.W)
36809c6f1ddSLingrui98
36909c6f1ddSLingrui98  val valid = Bool()
37009c6f1ddSLingrui98
37109c6f1ddSLingrui98  val hasRedirect = Bool()
37209c6f1ddSLingrui98  val ftq_idx = new FtqPtr
37309c6f1ddSLingrui98  // val hit = Bool()
37409c6f1ddSLingrui98  val preds = new BranchPrediction
37509c6f1ddSLingrui98
376dd6c0695SLingrui98  val folded_hist = new AllFoldedHistories(foldedGHistInfos)
377c2ad24ebSLingrui98  val histPtr = new CGHPtr
37809c6f1ddSLingrui98  val phist = UInt(PathHistoryLength.W)
37909c6f1ddSLingrui98  val rasSp = UInt(log2Ceil(RasSize).W)
38009c6f1ddSLingrui98  val rasTop = new RASEntry
38109c6f1ddSLingrui98  val specCnt = Vec(numBr, UInt(10.W))
38209c6f1ddSLingrui98  // val meta = UInt(MaxMetaLength.W)
38309c6f1ddSLingrui98
38409c6f1ddSLingrui98  val ftb_entry = new FTBEntry() // TODO: Send this entry to ftq
38509c6f1ddSLingrui98
386eeb5ff92SLingrui98  def real_slot_taken_mask(): Vec[Bool] = {
387eeb5ff92SLingrui98    VecInit(preds.taken_mask_on_slot.map(_ && preds.hit))
388eeb5ff92SLingrui98  }
389eeb5ff92SLingrui98
390eeb5ff92SLingrui98  // len numBr
391bf358e08SLingrui98  def real_br_taken_mask(): Vec[Bool] = {
392eeb5ff92SLingrui98    if (shareTailSlot)
393eeb5ff92SLingrui98      VecInit(
394eeb5ff92SLingrui98        preds.taken_mask_on_slot.map(_ && preds.hit).init :+
395eeb5ff92SLingrui98        (preds.br_taken_mask.last && preds.tail_slot_valid && preds.is_br_sharing && preds.hit)
396eeb5ff92SLingrui98      )
397eeb5ff92SLingrui98    else
398eeb5ff92SLingrui98      VecInit(real_slot_taken_mask().init)
39909c6f1ddSLingrui98  }
40009c6f1ddSLingrui98
4011ccea249SLingrui98  // the vec indicating if ghr should shift on each branch
4021ccea249SLingrui98  def shouldShiftVec =
4031ccea249SLingrui98    VecInit(preds.br_valids.zipWithIndex.map{ case (v, i) =>
4041ccea249SLingrui98      v && !real_br_taken_mask.take(i).reduceOption(_||_).getOrElse(false.B)})
4051ccea249SLingrui98
406ab890bfeSLingrui98  def lastBrPosOH =
407ab890bfeSLingrui98    (!preds.hit || !preds.br_valids.reduce(_||_)) +: // not hit or no brs in entry
408ab890bfeSLingrui98    VecInit((0 until numBr).map(i =>
409ab890bfeSLingrui98      preds.br_valids(i) &&
410ab890bfeSLingrui98      !real_br_taken_mask.take(i).reduceOption(_||_).getOrElse(false.B) && // no brs taken in front it
411ab890bfeSLingrui98      (real_br_taken_mask()(i) || !preds.br_valids.drop(i+1).reduceOption(_||_).getOrElse(false.B)) && // no brs behind it
412ab890bfeSLingrui98      preds.hit
413ab890bfeSLingrui98    ))
414ab890bfeSLingrui98
415c2ad24ebSLingrui98  def br_count(): UInt = {
416c2ad24ebSLingrui98    val last_valid_idx = PriorityMux(
417c2ad24ebSLingrui98      preds.br_valids.reverse :+ true.B,
418c2ad24ebSLingrui98      (numBr to 0 by -1).map(_.U(log2Ceil(numBr+1).W))
419c2ad24ebSLingrui98      )
420c2ad24ebSLingrui98    val first_taken_idx = PriorityEncoder(false.B +: real_br_taken_mask)
421c2ad24ebSLingrui98    Mux(last_valid_idx < first_taken_idx,
422c2ad24ebSLingrui98      last_valid_idx,
423c2ad24ebSLingrui98      first_taken_idx
424c2ad24ebSLingrui98    )
425c2ad24ebSLingrui98  }
426c2ad24ebSLingrui98
427eeb5ff92SLingrui98  def hit_taken_on_jmp =
428eeb5ff92SLingrui98    !real_slot_taken_mask().init.reduce(_||_) &&
429eeb5ff92SLingrui98    real_slot_taken_mask().last && !preds.is_br_sharing
430bf358e08SLingrui98  def hit_taken_on_call = hit_taken_on_jmp && preds.is_call
431bf358e08SLingrui98  def hit_taken_on_ret  = hit_taken_on_jmp && preds.is_ret
432bf358e08SLingrui98  def hit_taken_on_jalr = hit_taken_on_jmp && preds.is_jalr
43309c6f1ddSLingrui98
43409c6f1ddSLingrui98  def target(): UInt = {
435a229ab6cSLingrui98    val targetVecOnHit = preds.targets :+ preds.fallThroughAddr
436570faa6cSLingrui98    val targetOnNotHit = pc + (FetchWidth * 4).U
437570faa6cSLingrui98    val taken_mask = preds.taken_mask_on_slot
438570faa6cSLingrui98    val selVecOHOnHit =
439570faa6cSLingrui98      taken_mask.zipWithIndex.map{ case (t, i) => !taken_mask.take(i).fold(false.B)(_||_) && t} :+ !taken_mask.asUInt.orR
440570faa6cSLingrui98    val targetOnHit = Mux1H(selVecOHOnHit, targetVecOnHit)
441570faa6cSLingrui98    Mux(preds.hit, targetOnHit, targetOnNotHit)
44209c6f1ddSLingrui98  }
443570faa6cSLingrui98
444570faa6cSLingrui98  def targetDiffFrom(addr: UInt) = {
445a229ab6cSLingrui98    val targetVec = preds.targets :+ preds.fallThroughAddr :+ (pc + (FetchWidth*4).U)
446570faa6cSLingrui98    val taken_mask = preds.taken_mask_on_slot
447570faa6cSLingrui98    val selVecOH =
448570faa6cSLingrui98      taken_mask.zipWithIndex.map{ case (t, i) => !taken_mask.take(i).fold(false.B)(_||_) && t && preds.hit} :+
449570faa6cSLingrui98      (!taken_mask.asUInt.orR && preds.hit) :+ !preds.hit
450570faa6cSLingrui98    val diffVec = targetVec map (_ =/= addr)
451570faa6cSLingrui98    Mux1H(selVecOH, diffVec)
452570faa6cSLingrui98  }
453570faa6cSLingrui98
45409c6f1ddSLingrui98  def genCfiIndex = {
45509c6f1ddSLingrui98    val cfiIndex = Wire(ValidUndirectioned(UInt(log2Ceil(PredictWidth).W)))
456eeb5ff92SLingrui98    cfiIndex.valid := real_slot_taken_mask().asUInt.orR
45709c6f1ddSLingrui98    // when no takens, set cfiIndex to PredictWidth-1
45809c6f1ddSLingrui98    cfiIndex.bits :=
459a229ab6cSLingrui98      ParallelPriorityMux(real_slot_taken_mask(), preds.offsets) |
460eeb5ff92SLingrui98      Fill(log2Ceil(PredictWidth), (!real_slot_taken_mask().asUInt.orR).asUInt)
46109c6f1ddSLingrui98    cfiIndex
46209c6f1ddSLingrui98  }
46309c6f1ddSLingrui98
46409c6f1ddSLingrui98  def display(cond: Bool): Unit = {
46509c6f1ddSLingrui98    XSDebug(cond, p"[pc] ${Hexadecimal(pc)}\n")
466dd6c0695SLingrui98    folded_hist.display(cond)
46709c6f1ddSLingrui98    preds.display(cond)
46809c6f1ddSLingrui98    ftb_entry.display(cond)
46909c6f1ddSLingrui98  }
47009c6f1ddSLingrui98}
47109c6f1ddSLingrui98
472bf358e08SLingrui98@chiselName
47309c6f1ddSLingrui98class BranchPredictionResp(implicit p: Parameters) extends XSBundle with HasBPUConst {
47409c6f1ddSLingrui98  // val valids = Vec(3, Bool())
47509c6f1ddSLingrui98  val s1 = new BranchPredictionBundle()
47609c6f1ddSLingrui98  val s2 = new BranchPredictionBundle()
47709c6f1ddSLingrui98
47809c6f1ddSLingrui98  def selectedResp =
47909c6f1ddSLingrui98    PriorityMux(Seq(
48009c6f1ddSLingrui98      ((s2.valid && s2.hasRedirect) -> s2),
48109c6f1ddSLingrui98      (s1.valid -> s1)
48209c6f1ddSLingrui98    ))
48309c6f1ddSLingrui98  def selectedRespIdx =
48409c6f1ddSLingrui98    PriorityMux(Seq(
48509c6f1ddSLingrui98      ((s2.valid && s2.hasRedirect) -> BP_S2),
48609c6f1ddSLingrui98      (s1.valid -> BP_S1)
48709c6f1ddSLingrui98    ))
488*3e52bed1SLingrui98  def lastStage = s2
48909c6f1ddSLingrui98}
49009c6f1ddSLingrui98
49109c6f1ddSLingrui98class BpuToFtqBundle(implicit p: Parameters) extends BranchPredictionResp with HasBPUConst {
49209c6f1ddSLingrui98  val meta = UInt(MaxMetaLength.W)
49309c6f1ddSLingrui98}
49409c6f1ddSLingrui98
49509c6f1ddSLingrui98object BpuToFtqBundle {
49609c6f1ddSLingrui98  def apply(resp: BranchPredictionResp)(implicit p: Parameters): BpuToFtqBundle = {
49709c6f1ddSLingrui98    val e = Wire(new BpuToFtqBundle())
49809c6f1ddSLingrui98    e.s1 := resp.s1
49909c6f1ddSLingrui98    e.s2 := resp.s2
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())
50809c6f1ddSLingrui98  val false_hit = Bool()
50909c6f1ddSLingrui98  val new_br_insert_pos = Vec(numBr, Bool())
51009c6f1ddSLingrui98  val old_entry = Bool()
51109c6f1ddSLingrui98  val meta = UInt(MaxMetaLength.W)
512abdbe4b7SLingrui98  val full_target = UInt(VAddrBits.W)
51309c6f1ddSLingrui98
51409c6f1ddSLingrui98  def fromFtqRedirectSram(entry: Ftq_Redirect_SRAMEntry) = {
515dd6c0695SLingrui98    folded_hist := entry.folded_hist
516c2ad24ebSLingrui98    histPtr := entry.histPtr
51709c6f1ddSLingrui98    phist := entry.phist
51809c6f1ddSLingrui98    rasSp := entry.rasSp
51909c6f1ddSLingrui98    rasTop := entry.rasEntry
52009c6f1ddSLingrui98    specCnt := entry.specCnt
52109c6f1ddSLingrui98    this
52209c6f1ddSLingrui98  }
52309c6f1ddSLingrui98
524c2ad24ebSLingrui98  override def display(cond: Bool) = {
52509c6f1ddSLingrui98    XSDebug(cond, p"-----------BranchPredictionUpdate-----------\n")
52609c6f1ddSLingrui98    XSDebug(cond, p"[mispred_mask] ${Binary(mispred_mask.asUInt)} [false_hit] $false_hit\n")
52709c6f1ddSLingrui98    XSDebug(cond, p"[new_br_insert_pos] ${Binary(new_br_insert_pos.asUInt)}\n")
52809c6f1ddSLingrui98    super.display(cond)
52909c6f1ddSLingrui98    XSDebug(cond, p"--------------------------------------------\n")
53009c6f1ddSLingrui98  }
53109c6f1ddSLingrui98}
53209c6f1ddSLingrui98
53309c6f1ddSLingrui98class BranchPredictionRedirect(implicit p: Parameters) extends Redirect with HasBPUConst {
53409c6f1ddSLingrui98  // override def toPrintable: Printable = {
53509c6f1ddSLingrui98  //   p"-----------BranchPredictionRedirect----------- " +
53609c6f1ddSLingrui98  //     p"-----------cfiUpdate----------- " +
53709c6f1ddSLingrui98  //     p"[pc] ${Hexadecimal(cfiUpdate.pc)} " +
53809c6f1ddSLingrui98  //     p"[predTaken] ${cfiUpdate.predTaken}, [taken] ${cfiUpdate.taken}, [isMisPred] ${cfiUpdate.isMisPred} " +
53909c6f1ddSLingrui98  //     p"[target] ${Hexadecimal(cfiUpdate.target)} " +
54009c6f1ddSLingrui98  //     p"------------------------------- " +
5419aca92b9SYinan Xu  //     p"[robPtr] f=${robIdx.flag} v=${robIdx.value} " +
54209c6f1ddSLingrui98  //     p"[ftqPtr] f=${ftqIdx.flag} v=${ftqIdx.value} " +
54309c6f1ddSLingrui98  //     p"[ftqOffset] ${ftqOffset} " +
54409c6f1ddSLingrui98  //     p"[level] ${level}, [interrupt] ${interrupt} " +
54509c6f1ddSLingrui98  //     p"[stFtqIdx] f=${stFtqIdx.flag} v=${stFtqIdx.value} " +
54609c6f1ddSLingrui98  //     p"[stFtqOffset] ${stFtqOffset} " +
54709c6f1ddSLingrui98  //     p"\n"
54809c6f1ddSLingrui98
54909c6f1ddSLingrui98  // }
55009c6f1ddSLingrui98
55109c6f1ddSLingrui98  def display(cond: Bool): Unit = {
55209c6f1ddSLingrui98    XSDebug(cond, p"-----------BranchPredictionRedirect----------- \n")
55309c6f1ddSLingrui98    XSDebug(cond, p"-----------cfiUpdate----------- \n")
55409c6f1ddSLingrui98    XSDebug(cond, p"[pc] ${Hexadecimal(cfiUpdate.pc)}\n")
555c2ad24ebSLingrui98    // XSDebug(cond, p"[hist] ${Binary(cfiUpdate.hist.predHist)}\n")
55609c6f1ddSLingrui98    XSDebug(cond, p"[br_hit] ${cfiUpdate.br_hit} [isMisPred] ${cfiUpdate.isMisPred}\n")
55709c6f1ddSLingrui98    XSDebug(cond, p"[pred_taken] ${cfiUpdate.predTaken} [taken] ${cfiUpdate.taken} [isMisPred] ${cfiUpdate.isMisPred}\n")
55809c6f1ddSLingrui98    XSDebug(cond, p"[target] ${Hexadecimal(cfiUpdate.target)} \n")
55909c6f1ddSLingrui98    XSDebug(cond, p"[shift] ${cfiUpdate.shift}\n")
56009c6f1ddSLingrui98    XSDebug(cond, p"------------------------------- \n")
5619aca92b9SYinan Xu    XSDebug(cond, p"[robPtr] f=${robIdx.flag} v=${robIdx.value}\n")
56209c6f1ddSLingrui98    XSDebug(cond, p"[ftqPtr] f=${ftqIdx.flag} v=${ftqIdx.value} \n")
56309c6f1ddSLingrui98    XSDebug(cond, p"[ftqOffset] ${ftqOffset} \n")
56409c6f1ddSLingrui98    XSDebug(cond, p"[stFtqIdx] f=${stFtqIdx.flag} v=${stFtqIdx.value}\n")
56509c6f1ddSLingrui98    XSDebug(cond, p"[stFtqOffset] ${stFtqOffset}\n")
56609c6f1ddSLingrui98    XSDebug(cond, p"---------------------------------------------- \n")
56709c6f1ddSLingrui98  }
56809c6f1ddSLingrui98}
569