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