xref: /XiangShan/src/main/scala/xiangshan/backend/Bundles.scala (revision f3a9fb053ef5b99b1977960119e3ee440397383e)
1package xiangshan.backend
2
3import org.chipsalliance.cde.config.Parameters
4import chisel3._
5import chisel3.util.BitPat.bitPatToUInt
6import chisel3.util._
7import utils.BundleUtils.makeValid
8import utils.OptionWrapper
9import xiangshan._
10import xiangshan.backend.datapath.DataConfig._
11import xiangshan.backend.datapath.DataSource
12import xiangshan.backend.datapath.WbConfig.PregWB
13import xiangshan.backend.decode.{ImmUnion, XDecode}
14import xiangshan.backend.exu.ExeUnitParams
15import xiangshan.backend.fu.FuType
16import xiangshan.backend.fu.fpu.Bundles.Frm
17import xiangshan.backend.fu.vector.Bundles._
18import xiangshan.backend.issue.{IssueBlockParams, IssueQueueDeqRespBundle, SchedulerType}
19import xiangshan.backend.issue.EntryBundles._
20import xiangshan.backend.regfile.{RfReadPortWithConfig, RfWritePortWithConfig}
21import xiangshan.backend.rob.RobPtr
22import xiangshan.frontend._
23import xiangshan.mem.{LqPtr, SqPtr}
24import yunsuan.vector.VIFuParam
25
26object Bundles {
27  /**
28   * Connect Same Name Port like bundleSource := bundleSinkBudle.
29   *
30   * There is no limit to the number of ports on both sides.
31   *
32   * Don't forget to connect the remaining ports!
33   */
34  def connectSamePort (bundleSource: Bundle, bundleSink: Bundle):Unit = {
35    bundleSource.elements.foreach { case (name, data) =>
36      if (bundleSink.elements.contains(name))
37        data := bundleSink.elements(name)
38    }
39  }
40  // frontend -> backend
41  class StaticInst(implicit p: Parameters) extends XSBundle {
42    val instr           = UInt(32.W)
43    val pc              = UInt(VAddrBits.W)
44    val foldpc          = UInt(MemPredPCWidth.W)
45    val exceptionVec    = ExceptionVec()
46    val trigger         = new TriggerCf
47    val preDecodeInfo   = new PreDecodeInfo
48    val pred_taken      = Bool()
49    val crossPageIPFFix = Bool()
50    val ftqPtr          = new FtqPtr
51    val ftqOffset       = UInt(log2Up(PredictWidth).W)
52
53    def connectCtrlFlow(source: CtrlFlow): Unit = {
54      this.instr            := source.instr
55      this.pc               := source.pc
56      this.foldpc           := source.foldpc
57      this.exceptionVec     := source.exceptionVec
58      this.trigger          := source.trigger
59      this.preDecodeInfo    := source.pd
60      this.pred_taken       := source.pred_taken
61      this.crossPageIPFFix  := source.crossPageIPFFix
62      this.ftqPtr           := source.ftqPtr
63      this.ftqOffset        := source.ftqOffset
64    }
65  }
66
67  // StaticInst --[Decode]--> DecodedInst
68  class DecodedInst(implicit p: Parameters) extends XSBundle {
69    def numSrc = backendParams.numSrc
70    // passed from StaticInst
71    val instr           = UInt(32.W)
72    val pc              = UInt(VAddrBits.W)
73    val foldpc          = UInt(MemPredPCWidth.W)
74    val exceptionVec    = ExceptionVec()
75    val trigger         = new TriggerCf
76    val preDecodeInfo   = new PreDecodeInfo
77    val pred_taken      = Bool()
78    val crossPageIPFFix = Bool()
79    val ftqPtr          = new FtqPtr
80    val ftqOffset       = UInt(log2Up(PredictWidth).W)
81    // decoded
82    val srcType         = Vec(numSrc, SrcType())
83    val lsrc            = Vec(numSrc, UInt(6.W))
84    val ldest           = UInt(6.W)
85    val fuType          = FuType()
86    val fuOpType        = FuOpType()
87    val rfWen           = Bool()
88    val fpWen           = Bool()
89    val vecWen          = Bool()
90    val isXSTrap        = Bool()
91    val waitForward     = Bool() // no speculate execution
92    val blockBackward   = Bool()
93    val flushPipe       = Bool() // This inst will flush all the pipe when commit, like exception but can commit
94    val canRobCompress  = Bool()
95    val selImm          = SelImm()
96    val imm             = UInt(ImmUnion.maxLen.W)
97    val fpu             = new FPUCtrlSignals
98    val vpu             = new VPUCtrlSignals
99    val vlsInstr        = Bool()
100    val wfflags         = Bool()
101    val isMove          = Bool()
102    val uopIdx          = UopIdx()
103    val uopSplitType    = UopSplitType()
104    val isVset          = Bool()
105    val firstUop        = Bool()
106    val lastUop         = Bool()
107    val numUops         = UInt(log2Up(MaxUopSize).W) // rob need this
108    val numWB           = UInt(log2Up(MaxUopSize).W) // rob need this
109    val commitType      = CommitType() // Todo: remove it
110
111    val debug_fuType    = OptionWrapper(backendParams.debugEn, FuType())
112
113    private def allSignals = srcType.take(3) ++ Seq(fuType, fuOpType, rfWen, fpWen, vecWen,
114      isXSTrap, waitForward, blockBackward, flushPipe, canRobCompress, uopSplitType, selImm)
115
116    def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): DecodedInst = {
117      val decoder: Seq[UInt] = ListLookup(
118        inst, XDecode.decodeDefault.map(bitPatToUInt),
119        table.map{ case (pat, pats) => (pat, pats.map(bitPatToUInt)) }.toArray
120      )
121      allSignals zip decoder foreach { case (s, d) => s := d }
122      debug_fuType.foreach(_ := fuType)
123      this
124    }
125
126    def isSoftPrefetch: Bool = {
127      fuType === FuType.alu.U && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
128    }
129
130    def connectStaticInst(source: StaticInst): Unit = {
131      for ((name, data) <- this.elements) {
132        if (source.elements.contains(name)) {
133          data := source.elements(name)
134        }
135      }
136    }
137  }
138
139  // DecodedInst --[Rename]--> DynInst
140  class DynInst(implicit p: Parameters) extends XSBundle {
141    def numSrc          = backendParams.numSrc
142    // passed from StaticInst
143    val instr           = UInt(32.W)
144    val pc              = UInt(VAddrBits.W)
145    val foldpc          = UInt(MemPredPCWidth.W)
146    val exceptionVec    = ExceptionVec()
147    val trigger         = new TriggerCf
148    val preDecodeInfo   = new PreDecodeInfo
149    val pred_taken      = Bool()
150    val crossPageIPFFix = Bool()
151    val ftqPtr          = new FtqPtr
152    val ftqOffset       = UInt(log2Up(PredictWidth).W)
153    // passed from DecodedInst
154    val srcType         = Vec(numSrc, SrcType())
155    val lsrc            = Vec(numSrc, UInt(6.W))
156    val ldest           = UInt(6.W)
157    val fuType          = FuType()
158    val fuOpType        = FuOpType()
159    val rfWen           = Bool()
160    val fpWen           = Bool()
161    val vecWen          = Bool()
162    val isXSTrap        = Bool()
163    val waitForward     = Bool() // no speculate execution
164    val blockBackward   = Bool()
165    val flushPipe       = Bool() // This inst will flush all the pipe when commit, like exception but can commit
166    val canRobCompress  = Bool()
167    val selImm          = SelImm()
168    val imm             = UInt(32.W)
169    val fpu             = new FPUCtrlSignals
170    val vpu             = new VPUCtrlSignals
171    val vlsInstr        = Bool()
172    val wfflags         = Bool()
173    val isMove          = Bool()
174    val uopIdx          = UopIdx()
175    val isVset          = Bool()
176    val firstUop        = Bool()
177    val lastUop         = Bool()
178    val numUops         = UInt(log2Up(MaxUopSize).W) // rob need this
179    val numWB           = UInt(log2Up(MaxUopSize).W) // rob need this
180    val commitType      = CommitType()
181    // rename
182    val srcState        = Vec(numSrc, SrcState())
183    val srcLoadDependency  = Vec(numSrc, Vec(LoadPipelineWidth, UInt(3.W)))
184    val psrc            = Vec(numSrc, UInt(PhyRegIdxWidth.W))
185    val pdest           = UInt(PhyRegIdxWidth.W)
186    val robIdx          = new RobPtr
187    val instrSize       = UInt(log2Ceil(RenameWidth + 1).W)
188    val dirtyFs         = Bool()
189
190    val eliminatedMove  = Bool()
191    // Take snapshot at this CFI inst
192    val snapshot        = Bool()
193    val debugInfo       = new PerfDebugInfo
194    val storeSetHit     = Bool() // inst has been allocated an store set
195    val waitForRobIdx   = new RobPtr // store set predicted previous store robIdx
196    // Load wait is needed
197    // load inst will not be executed until former store (predicted by mdp) addr calcuated
198    val loadWaitBit     = Bool()
199    // If (loadWaitBit && loadWaitStrict), strict load wait is needed
200    // load inst will not be executed until ALL former store addr calcuated
201    val loadWaitStrict  = Bool()
202    val ssid            = UInt(SSIDWidth.W)
203    // Todo
204    val lqIdx = new LqPtr
205    val sqIdx = new SqPtr
206    // debug module
207    val singleStep      = Bool()
208    // schedule
209    val replayInst      = Bool()
210
211    val debug_fuType    = OptionWrapper(backendParams.debugEn, FuType())
212
213    val numLsElem         = UInt((VLEN/8).W)
214
215    def getDebugFuType: UInt = debug_fuType.getOrElse(fuType)
216
217    def isLUI: Bool = this.fuType === FuType.alu.U && (this.selImm === SelImm.IMM_U || this.selImm === SelImm.IMM_LUI32)
218    def isLUI32: Bool = this.selImm === SelImm.IMM_LUI32
219    def isWFI: Bool = this.fuType === FuType.csr.U && fuOpType === CSROpType.wfi
220
221    def isSvinvalBegin(flush: Bool) = FuType.isFence(fuType) && fuOpType === FenceOpType.nofence && !flush
222    def isSvinval(flush: Bool) = FuType.isFence(fuType) && fuOpType === FenceOpType.sfence && !flush
223    def isSvinvalEnd(flush: Bool) = FuType.isFence(fuType) && fuOpType === FenceOpType.nofence && flush
224
225    def srcIsReady: Vec[Bool] = {
226      VecInit(this.srcType.zip(this.srcState).map {
227        case (t, s) => SrcType.isNotReg(t) || SrcState.isReady(s)
228      })
229    }
230
231    def clearExceptions(
232      exceptionBits: Seq[Int] = Seq(),
233      flushPipe    : Boolean = false,
234      replayInst   : Boolean = false
235    ): DynInst = {
236      this.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
237      if (!flushPipe) { this.flushPipe := false.B }
238      if (!replayInst) { this.replayInst := false.B }
239      this
240    }
241
242    def needWriteRf: Bool = (rfWen && ldest =/= 0.U) || fpWen || vecWen
243  }
244
245  trait BundleSource {
246    var wakeupSource = "undefined"
247    var idx = 0
248  }
249
250  /**
251    *
252    * @param pregIdxWidth index width of preg
253    * @param exuIndices exu indices of wakeup bundle
254    */
255  sealed abstract class IssueQueueWakeUpBaseBundle(pregIdxWidth: Int, val exuIndices: Seq[Int]) extends Bundle {
256    val rfWen = Bool()
257    val fpWen = Bool()
258    val vecWen = Bool()
259    val pdest = UInt(pregIdxWidth.W)
260
261    /**
262      * @param successor Seq[(psrc, srcType)]
263      * @return Seq[if wakeup psrc]
264      */
265    def wakeUp(successor: Seq[(UInt, UInt)], valid: Bool): Seq[Bool] = {
266      successor.map { case (thatPsrc, srcType) =>
267        val pdestMatch = pdest === thatPsrc
268        pdestMatch && (
269          SrcType.isFp(srcType) && this.fpWen ||
270            SrcType.isXp(srcType) && this.rfWen ||
271            SrcType.isVp(srcType) && this.vecWen
272          ) && valid
273      }
274    }
275    def wakeUpFromIQ(successor: Seq[(UInt, UInt)]): Seq[Bool] = {
276      successor.map { case (thatPsrc, srcType) =>
277        val pdestMatch = pdest === thatPsrc
278        pdestMatch && (
279          SrcType.isFp(srcType) && this.fpWen ||
280            SrcType.isXp(srcType) && this.rfWen ||
281            SrcType.isVp(srcType) && this.vecWen
282          )
283      }
284    }
285
286    def hasOnlyOneSource: Boolean = exuIndices.size == 1
287
288    def hasMultiSources: Boolean = exuIndices.size > 1
289
290    def isWBWakeUp = this.isInstanceOf[IssueQueueWBWakeUpBundle]
291
292    def isIQWakeUp = this.isInstanceOf[IssueQueueIQWakeUpBundle]
293
294    def exuIdx: Int = {
295      require(hasOnlyOneSource)
296      this.exuIndices.head
297    }
298  }
299
300  class IssueQueueWBWakeUpBundle(exuIndices: Seq[Int], backendParams: BackendParams) extends IssueQueueWakeUpBaseBundle(backendParams.pregIdxWidth, exuIndices) {
301
302  }
303
304class IssueQueueIQWakeUpBundle(
305  exuIdx: Int,
306  backendParams: BackendParams,
307  copyWakeupOut: Boolean = false,
308  copyNum: Int = 0
309) extends IssueQueueWakeUpBaseBundle(backendParams.pregIdxWidth, Seq(exuIdx)) {
310    val loadDependency = Vec(backendParams.LduCnt + backendParams.HyuCnt, UInt(3.W))
311    val is0Lat = Bool()
312    val params = backendParams.allExuParams.filter(_.exuIdx == exuIdx).head
313    val pdestCopy  = OptionWrapper(copyWakeupOut, Vec(copyNum, UInt(params.wbPregIdxWidth.W)))
314    val rfWenCopy  = OptionWrapper(copyWakeupOut && params.needIntWen, Vec(copyNum, Bool()))
315    val fpWenCopy  = OptionWrapper(copyWakeupOut && params.needFpWen, Vec(copyNum, Bool()))
316    val vecWenCopy = OptionWrapper(copyWakeupOut && params.needVecWen, Vec(copyNum, Bool()))
317    val loadDependencyCopy = OptionWrapper(copyWakeupOut && params.isIQWakeUpSink, Vec(copyNum,Vec(backendParams.LdExuCnt, UInt(3.W))))
318    def fromExuInput(exuInput: ExuInput, l2ExuVecs: Vec[UInt]): Unit = {
319      this.rfWen := exuInput.rfWen.getOrElse(false.B)
320      this.fpWen := exuInput.fpWen.getOrElse(false.B)
321      this.vecWen := exuInput.vecWen.getOrElse(false.B)
322      this.pdest := exuInput.pdest
323    }
324
325    def fromExuInput(exuInput: ExuInput): Unit = {
326      this.rfWen := exuInput.rfWen.getOrElse(false.B)
327      this.fpWen := exuInput.fpWen.getOrElse(false.B)
328      this.vecWen := exuInput.vecWen.getOrElse(false.B)
329      this.pdest := exuInput.pdest
330    }
331  }
332
333  class VPUCtrlSignals(implicit p: Parameters) extends XSBundle {
334    // vtype
335    val vill      = Bool()
336    val vma       = Bool()    // 1: agnostic, 0: undisturbed
337    val vta       = Bool()    // 1: agnostic, 0: undisturbed
338    val vsew      = VSew()
339    val vlmul     = VLmul()   // 1/8~8      --> -3~3
340
341    val vm        = Bool()    // 0: need v0.t
342    val vstart    = Vl()
343
344    // float rounding mode
345    val frm       = Frm()
346    // scalar float instr and vector float reduction
347    val fpu       = Fpu()
348    // vector fix int rounding mode
349    val vxrm      = Vxrm()
350    // vector uop index, exclude other non-vector uop
351    val vuopIdx   = UopIdx()
352    val lastUop   = Bool()
353    // maybe used if data dependancy
354    val vmask     = UInt(MaskSrcData().dataWidth.W)
355    val vl        = Vl()
356
357    // vector load/store
358    val nf        = Nf()
359    val veew      = VEew()
360
361    val isReverse = Bool() // vrsub, vrdiv
362    val isExt     = Bool()
363    val isNarrow  = Bool()
364    val isDstMask = Bool() // vvm, vvvm, mmm
365    val isOpMask  = Bool() // vmand, vmnand
366    val isMove    = Bool() // vmv.s.x, vmv.v.v, vmv.v.x, vmv.v.i
367
368    def vtype: VType = {
369      val res = Wire(VType())
370      res.illegal := this.vill
371      res.vma     := this.vma
372      res.vta     := this.vta
373      res.vsew    := this.vsew
374      res.vlmul   := this.vlmul
375      res
376    }
377
378    def vconfig: VConfig = {
379      val res = Wire(VConfig())
380      res.vtype := this.vtype
381      res.vl    := this.vl
382      res
383    }
384
385    def connectVType(source: VType): Unit = {
386      this.vill  := source.illegal
387      this.vma   := source.vma
388      this.vta   := source.vta
389      this.vsew  := source.vsew
390      this.vlmul := source.vlmul
391    }
392  }
393
394  // DynInst --[IssueQueue]--> DataPath
395  class IssueQueueIssueBundle(
396    iqParams: IssueBlockParams,
397    val exuParams: ExeUnitParams,
398  )(implicit
399    p: Parameters
400  ) extends Bundle {
401    private val rfReadDataCfgSet: Seq[Set[DataConfig]] = exuParams.getRfReadDataCfgSet
402    // check which set both have fp and vec and remove fp
403    private val rfReadDataCfgSetFilterFp = rfReadDataCfgSet.map((set: Set[DataConfig]) =>
404      if (set.contains(FpData()) && set.contains(VecData())) set.filter(_ != FpData())
405      else set
406    )
407
408    val rf: MixedVec[MixedVec[RfReadPortWithConfig]] = Flipped(MixedVec(
409      rfReadDataCfgSetFilterFp.map((set: Set[DataConfig]) =>
410        MixedVec(set.map((x: DataConfig) => new RfReadPortWithConfig(x, exuParams.rdPregIdxWidth)).toSeq)
411      )
412    ))
413
414    val srcType = Vec(exuParams.numRegSrc, SrcType()) // used to select imm or reg data
415    val immType = SelImm()                         // used to select imm extractor
416    val common = new ExuInput(exuParams)
417    val addrOH = UInt(iqParams.numEntries.W)
418
419    def exuIdx = exuParams.exuIdx
420    def getSource: SchedulerType = exuParams.getWBSource
421    def getIntWbBusyBundle = common.rfWen.toSeq
422    def getVfWbBusyBundle = common.getVfWen.toSeq
423
424    def getIntRfReadValidBundle(issueValid: Bool): Seq[ValidIO[RfReadPortWithConfig]] = {
425      rf.zip(srcType).map {
426        case (rfRd: MixedVec[RfReadPortWithConfig], t: UInt) =>
427          makeValid(issueValid, rfRd.head)
428      }.toSeq
429    }
430
431    def getVfRfReadValidBundle(issueValid: Bool): Seq[ValidIO[RfReadPortWithConfig]] = {
432      rf.zip(srcType).map {
433        case (rfRd: MixedVec[RfReadPortWithConfig], t: UInt) =>
434          makeValid(issueValid, rfRd.head)
435      }.toSeq
436    }
437
438    def getIntRfWriteValidBundle(issueValid: Bool) = {
439
440    }
441  }
442
443  class OGRespBundle(implicit p:Parameters, params: IssueBlockParams) extends XSBundle {
444    val issueQueueParams = this.params
445    val og0resp = Valid(new EntryDeqRespBundle)
446    val og1resp = Valid(new EntryDeqRespBundle)
447  }
448
449  class fuBusyRespBundle(implicit p: Parameters, params: IssueBlockParams) extends Bundle {
450    val respType = RSFeedbackType() // update credit if needs replay
451    val rfWen = Bool() // TODO: use params to identify IntWB/VfWB
452    val fuType = FuType()
453  }
454
455  class WbFuBusyTableWriteBundle(val params: ExeUnitParams)(implicit p: Parameters) extends XSBundle {
456    private val intCertainLat = params.intLatencyCertain
457    private val vfCertainLat = params.vfLatencyCertain
458    private val intLat = params.intLatencyValMax
459    private val vfLat = params.vfLatencyValMax
460
461    val intWbBusyTable = OptionWrapper(intCertainLat, UInt((intLat + 1).W))
462    val vfWbBusyTable = OptionWrapper(vfCertainLat, UInt((vfLat + 1).W))
463    val intDeqRespSet = OptionWrapper(intCertainLat, UInt((intLat + 1).W))
464    val vfDeqRespSet = OptionWrapper(vfCertainLat, UInt((vfLat + 1).W))
465  }
466
467  class WbFuBusyTableReadBundle(val params: ExeUnitParams)(implicit p: Parameters) extends XSBundle {
468    private val intCertainLat = params.intLatencyCertain
469    private val vfCertainLat = params.vfLatencyCertain
470    private val intLat = params.intLatencyValMax
471    private val vfLat = params.vfLatencyValMax
472
473    val intWbBusyTable = OptionWrapper(intCertainLat, UInt((intLat + 1).W))
474    val vfWbBusyTable = OptionWrapper(vfCertainLat, UInt((vfLat + 1).W))
475  }
476
477  class WbConflictBundle(val params: ExeUnitParams)(implicit p: Parameters) extends XSBundle {
478    private val intCertainLat = params.intLatencyCertain
479    private val vfCertainLat = params.vfLatencyCertain
480
481    val intConflict = OptionWrapper(intCertainLat, Bool())
482    val vfConflict = OptionWrapper(vfCertainLat, Bool())
483  }
484
485  class ImmInfo extends Bundle {
486    val imm = UInt(32.W)
487    val immType = SelImm()
488  }
489
490  // DataPath --[ExuInput]--> Exu
491  class ExuInput(val params: ExeUnitParams, copyWakeupOut:Boolean = false, copyNum:Int = 0)(implicit p: Parameters) extends XSBundle {
492    val fuType        = FuType()
493    val fuOpType      = FuOpType()
494    val src           = Vec(params.numRegSrc, UInt(params.dataBitsMax.W))
495    val imm           = UInt(32.W)
496    val robIdx        = new RobPtr
497    val iqIdx         = UInt(log2Up(MemIQSizeMax).W)// Only used by store yet
498    val isFirstIssue  = Bool()                      // Only used by store yet
499    val pdestCopy  = OptionWrapper(copyWakeupOut, Vec(copyNum, UInt(params.wbPregIdxWidth.W)))
500    val rfWenCopy  = OptionWrapper(copyWakeupOut && params.needIntWen, Vec(copyNum, Bool()))
501    val fpWenCopy  = OptionWrapper(copyWakeupOut && params.needFpWen, Vec(copyNum, Bool()))
502    val vecWenCopy = OptionWrapper(copyWakeupOut && params.needVecWen, Vec(copyNum, Bool()))
503    val loadDependencyCopy = OptionWrapper(copyWakeupOut && params.isIQWakeUpSink, Vec(copyNum,Vec(LoadPipelineWidth, UInt(3.W))))
504    val pdest         = UInt(params.wbPregIdxWidth.W)
505    val rfWen         = if (params.needIntWen)    Some(Bool())                        else None
506    val fpWen         = if (params.needFpWen)     Some(Bool())                        else None
507    val vecWen        = if (params.needVecWen)    Some(Bool())                        else None
508    val fpu           = if (params.writeFflags)   Some(new FPUCtrlSignals)            else None
509    val vpu           = if (params.needVPUCtrl)   Some(new VPUCtrlSignals)            else None
510    val flushPipe     = if (params.flushPipe)     Some(Bool())                        else None
511    val pc            = if (params.needPc)        Some(UInt(VAddrData().dataWidth.W)) else None
512    val preDecode     = if (params.hasPredecode)  Some(new PreDecodeInfo)             else None
513    val ftqIdx        = if (params.needPc || params.replayInst || params.hasStoreAddrFu)
514                                                  Some(new FtqPtr)                    else None
515    val ftqOffset     = if (params.needPc || params.replayInst || params.hasStoreAddrFu)
516                                                  Some(UInt(log2Up(PredictWidth).W))  else None
517    val predictInfo   = if (params.needPdInfo)  Some(new Bundle {
518      val target = UInt(VAddrData().dataWidth.W)
519      val taken = Bool()
520    }) else None
521    val loadWaitBit    = OptionWrapper(params.hasLoadExu, Bool())
522    val waitForRobIdx  = OptionWrapper(params.hasLoadExu, new RobPtr) // store set predicted previous store robIdx
523    val storeSetHit    = OptionWrapper(params.hasLoadExu, Bool()) // inst has been allocated an store set
524    val loadWaitStrict = OptionWrapper(params.hasLoadExu, Bool()) // load inst will not be executed until ALL former store addr calcuated
525    val ssid           = OptionWrapper(params.hasLoadExu, UInt(SSIDWidth.W))
526    val sqIdx = if (params.hasMemAddrFu || params.hasStdFu) Some(new SqPtr) else None
527    val lqIdx = if (params.hasMemAddrFu) Some(new LqPtr) else None
528    val dataSources = Vec(params.numRegSrc, DataSource())
529    val l1ExuOH = OptionWrapper(params.isIQWakeUpSink, Vec(params.numRegSrc, ExuOH()))
530    val srcTimer = OptionWrapper(params.isIQWakeUpSink, Vec(params.numRegSrc, UInt(3.W)))
531    val loadDependency = OptionWrapper(params.isIQWakeUpSink, Vec(LoadPipelineWidth, UInt(3.W)))
532
533    val perfDebugInfo = new PerfDebugInfo()
534
535    def exuIdx = this.params.exuIdx
536
537    def needCancel(og0CancelOH: UInt, og1CancelOH: UInt) : Bool = {
538      if (params.isIQWakeUpSink) {
539        require(
540          og0CancelOH.getWidth == l1ExuOH.get.head.getWidth,
541          s"cancelVecSize: {og0: ${og0CancelOH.getWidth}, og1: ${og1CancelOH.getWidth}}"
542        )
543        val l1Cancel: Bool = l1ExuOH.get.zip(srcTimer.get).map {
544          case(exuOH: UInt, srcTimer: UInt) =>
545            (exuOH & og0CancelOH).orR && srcTimer === 1.U
546        }.reduce(_ | _)
547        l1Cancel
548      } else {
549        false.B
550      }
551    }
552
553    def getVfWen = {
554      if (params.writeFpRf) this.fpWen
555      else if(params.writeVecRf) this.vecWen
556      else None
557    }
558
559    def fromIssueBundle(source: IssueQueueIssueBundle): Unit = {
560      // src is assigned to rfReadData
561      this.fuType        := source.common.fuType
562      this.fuOpType      := source.common.fuOpType
563      this.imm           := source.common.imm
564      this.robIdx        := source.common.robIdx
565      this.pdest         := source.common.pdest
566      this.isFirstIssue  := source.common.isFirstIssue // Only used by mem debug log
567      this.iqIdx         := source.common.iqIdx        // Only used by mem feedback
568      this.dataSources   := source.common.dataSources
569      this.l1ExuOH       .foreach(_ := source.common.l1ExuOH.get)
570      this.rfWen         .foreach(_ := source.common.rfWen.get)
571      this.fpWen         .foreach(_ := source.common.fpWen.get)
572      this.vecWen        .foreach(_ := source.common.vecWen.get)
573      this.fpu           .foreach(_ := source.common.fpu.get)
574      this.vpu           .foreach(_ := source.common.vpu.get)
575      this.flushPipe     .foreach(_ := source.common.flushPipe.get)
576      this.pc            .foreach(_ := source.common.pc.get)
577      this.preDecode     .foreach(_ := source.common.preDecode.get)
578      this.ftqIdx        .foreach(_ := source.common.ftqIdx.get)
579      this.ftqOffset     .foreach(_ := source.common.ftqOffset.get)
580      this.predictInfo   .foreach(_ := source.common.predictInfo.get)
581      this.loadWaitBit   .foreach(_ := source.common.loadWaitBit.get)
582      this.waitForRobIdx .foreach(_ := source.common.waitForRobIdx.get)
583      this.storeSetHit   .foreach(_ := source.common.storeSetHit.get)
584      this.loadWaitStrict.foreach(_ := source.common.loadWaitStrict.get)
585      this.ssid          .foreach(_ := source.common.ssid.get)
586      this.lqIdx         .foreach(_ := source.common.lqIdx.get)
587      this.sqIdx         .foreach(_ := source.common.sqIdx.get)
588      this.srcTimer      .foreach(_ := source.common.srcTimer.get)
589      this.loadDependency.foreach(_ := source.common.loadDependency.get.map(_ << 1))
590    }
591  }
592
593  // ExuInput --[FuncUnit]--> ExuOutput
594  class ExuOutput(
595    val params: ExeUnitParams,
596  )(implicit
597    val p: Parameters
598  ) extends Bundle with BundleSource with HasXSParameter {
599    val data         = UInt(params.dataBitsMax.W)
600    val pdest        = UInt(params.wbPregIdxWidth.W)
601    val robIdx       = new RobPtr
602    val intWen       = if (params.needIntWen)   Some(Bool())                  else None
603    val fpWen        = if (params.needFpWen)    Some(Bool())                  else None
604    val vecWen       = if (params.needVecWen)   Some(Bool())                  else None
605    val redirect     = if (params.hasRedirect)  Some(ValidIO(new Redirect))   else None
606    val fflags       = if (params.writeFflags)  Some(UInt(5.W))               else None
607    val wflags       = if (params.writeFflags)  Some(Bool())                  else None
608    val vxsat        = if (params.writeVxsat)   Some(Bool())                  else None
609    val exceptionVec = if (params.exceptionOut.nonEmpty) Some(ExceptionVec()) else None
610    val flushPipe    = if (params.flushPipe)    Some(Bool())                  else None
611    val replay       = if (params.replayInst)   Some(Bool())                  else None
612    val lqIdx        = if (params.hasLoadFu)    Some(new LqPtr())             else None
613    val sqIdx        = if (params.hasStoreAddrFu || params.hasStdFu)
614                                                Some(new SqPtr())             else None
615    val trigger      = if (params.trigger)      Some(new TriggerCf)           else None
616    // uop info
617    val predecodeInfo = if(params.hasPredecode) Some(new PreDecodeInfo) else None
618    // vldu used only
619    val vls = OptionWrapper(params.hasVLoadFu, new Bundle {
620      val vpu = new VPUCtrlSignals
621      val oldVdPsrc = UInt(PhyRegIdxWidth.W)
622      val vdIdx = UInt(3.W)
623      val vdIdxInField = UInt(3.W)
624      val isIndexed = Bool()
625      val isMasked = Bool()
626    })
627    val debug = new DebugBundle
628    val debugInfo = new PerfDebugInfo
629  }
630
631  // ExuOutput + DynInst --> WriteBackBundle
632  class WriteBackBundle(val params: PregWB, backendParams: BackendParams)(implicit p: Parameters) extends Bundle with BundleSource {
633    val rfWen = Bool()
634    val fpWen = Bool()
635    val vecWen = Bool()
636    val pdest = UInt(params.pregIdxWidth(backendParams).W)
637    val data = UInt(params.dataWidth.W)
638    val robIdx = new RobPtr()(p)
639    val flushPipe = Bool()
640    val replayInst = Bool()
641    val redirect = ValidIO(new Redirect)
642    val fflags = UInt(5.W)
643    val vxsat = Bool()
644    val exceptionVec = ExceptionVec()
645    val debug = new DebugBundle
646    val debugInfo = new PerfDebugInfo
647
648    this.wakeupSource = s"WB(${params.toString})"
649
650    def fromExuOutput(source: ExuOutput) = {
651      this.rfWen  := source.intWen.getOrElse(false.B)
652      this.fpWen  := source.fpWen.getOrElse(false.B)
653      this.vecWen := source.vecWen.getOrElse(false.B)
654      this.pdest  := source.pdest
655      this.data   := source.data
656      this.robIdx := source.robIdx
657      this.flushPipe := source.flushPipe.getOrElse(false.B)
658      this.replayInst := source.replay.getOrElse(false.B)
659      this.redirect := source.redirect.getOrElse(0.U.asTypeOf(this.redirect))
660      this.fflags := source.fflags.getOrElse(0.U.asTypeOf(this.fflags))
661      this.vxsat := source.vxsat.getOrElse(0.U.asTypeOf(this.vxsat))
662      this.exceptionVec := source.exceptionVec.getOrElse(0.U.asTypeOf(this.exceptionVec))
663      this.debug := source.debug
664      this.debugInfo := source.debugInfo
665    }
666
667    def asIntRfWriteBundle(fire: Bool): RfWritePortWithConfig = {
668      val rfWrite = Wire(Output(new RfWritePortWithConfig(this.params.dataCfg, backendParams.getPregParams(IntData()).addrWidth)))
669      rfWrite.wen := this.rfWen && fire
670      rfWrite.addr := this.pdest
671      rfWrite.data := this.data
672      rfWrite.intWen := this.rfWen
673      rfWrite.fpWen := false.B
674      rfWrite.vecWen := false.B
675      rfWrite
676    }
677
678    def asVfRfWriteBundle(fire: Bool): RfWritePortWithConfig = {
679      val rfWrite = Wire(Output(new RfWritePortWithConfig(this.params.dataCfg, backendParams.getPregParams(VecData()).addrWidth)))
680      rfWrite.wen := (this.fpWen || this.vecWen) && fire
681      rfWrite.addr := this.pdest
682      rfWrite.data := this.data
683      rfWrite.intWen := false.B
684      rfWrite.fpWen := this.fpWen
685      rfWrite.vecWen := this.vecWen
686      rfWrite
687    }
688  }
689
690  // ExuOutput --> ExuBypassBundle --[DataPath]-->ExuInput
691  //                                /
692  //     [IssueQueue]--> ExuInput --
693  class ExuBypassBundle(
694    val params: ExeUnitParams,
695  )(implicit
696    val p: Parameters
697  ) extends Bundle {
698    val data  = UInt(params.dataBitsMax.W)
699    val pdest = UInt(params.wbPregIdxWidth.W)
700  }
701
702  class ExceptionInfo(implicit p: Parameters) extends Bundle {
703    val pc = UInt(VAddrData().dataWidth.W)
704    val instr = UInt(32.W)
705    val commitType = CommitType()
706    val exceptionVec = ExceptionVec()
707    val singleStep = Bool()
708    val crossPageIPFFix = Bool()
709    val isInterrupt = Bool()
710    val vls = Bool()
711    val trigger  = new TriggerCf
712  }
713
714  object UopIdx {
715    def apply()(implicit p: Parameters): UInt = UInt(log2Up(p(XSCoreParamsKey).MaxUopSize + 1).W)
716  }
717
718  object FuLatency {
719    def apply(): UInt = UInt(width.W)
720
721    def width = 4 // 0~15 // Todo: assosiate it with FuConfig
722  }
723
724  object ExuOH {
725    def apply(exuNum: Int): UInt = UInt(exuNum.W)
726
727    def apply()(implicit p: Parameters): UInt = UInt(width.W)
728
729    def width(implicit p: Parameters): Int = p(XSCoreParamsKey).backendParams.numExu
730  }
731
732  object ExuVec {
733    def apply(exuNum: Int): Vec[Bool] = Vec(exuNum, Bool())
734
735    def apply()(implicit p: Parameters): Vec[Bool] = Vec(width, Bool())
736
737    def width(implicit p: Parameters): Int = p(XSCoreParamsKey).backendParams.numExu
738  }
739
740  class CancelSignal(implicit p: Parameters) extends XSBundle {
741    val rfWen = Bool()
742    val fpWen = Bool()
743    val vecWen = Bool()
744    val pdest = UInt(PhyRegIdxWidth.W)
745
746    def needCancel(srcType: UInt, psrc: UInt, valid: Bool): Bool = {
747      val pdestMatch = pdest === psrc
748      pdestMatch && (
749        SrcType.isFp(srcType) && !this.rfWen ||
750          SrcType.isXp(srcType) && this.rfWen ||
751          SrcType.isVp(srcType) && !this.rfWen
752        ) && valid
753    }
754  }
755
756  class MemExuInput(isVector: Boolean = false)(implicit p: Parameters) extends XSBundle {
757    val uop = new DynInst
758    val src = if (isVector) Vec(5, UInt(VLEN.W)) else Vec(3, UInt(XLEN.W))
759    val iqIdx = UInt(log2Up(MemIQSizeMax).W)
760    val isFirstIssue = Bool()
761    val flowNum      = OptionWrapper(isVector, UInt(log2Up(VLEN/8).W))
762
763    def src_rs1 = src(0)
764    def src_stride = src(1)
765    def src_vs3 = src(2)
766    def src_mask = if (isVector) src(3) else 0.U
767    def src_vl = if (isVector) src(4) else 0.U
768  }
769
770  class MemExuOutput(isVector: Boolean = false)(implicit p: Parameters) extends XSBundle {
771    val uop = new DynInst
772    val data = if (isVector) UInt(VLEN.W) else UInt(XLEN.W)
773    val mask = if (isVector) Some(UInt(VLEN.W)) else None
774    val vdIdx = if (isVector) Some(UInt(3.W)) else None // TODO: parameterize width
775    val vdIdxInField = if (isVector) Some(UInt(3.W)) else None
776    val debug = new DebugBundle
777
778    def isVls = FuType.isVls(uop.fuType)
779  }
780
781  class MemMicroOpRbExt(implicit p: Parameters) extends XSBundle {
782    val uop = new DynInst
783    val flag = UInt(1.W)
784  }
785
786  object LoadShouldCancel {
787    def apply(loadDependency: Option[Seq[UInt]], ldCancel: Seq[LoadCancelIO]): Bool = {
788      val ld1Cancel = loadDependency.map(_.zip(ldCancel.map(_.ld1Cancel)).map { case (dep, cancel) => cancel && dep(1)}.reduce(_ || _))
789      val ld2Cancel = loadDependency.map(_.zip(ldCancel.map(_.ld2Cancel)).map { case (dep, cancel) => cancel && dep(2)}.reduce(_ || _))
790      ld1Cancel.map(_ || ld2Cancel.get).getOrElse(false.B)
791    }
792  }
793}
794