xref: /XiangShan/src/main/scala/xiangshan/backend/Bundles.scala (revision 98639abb5c84bb635ff36399547e03aacb7bc2f4)
1package xiangshan.backend
2
3import chipsalliance.rocketchip.config.Parameters
4import chisel3._
5import chisel3.util.BitPat.bitPatToUInt
6import chisel3.util._
7import xiangshan._
8import xiangshan.backend.datapath.DataConfig._
9import xiangshan.backend.datapath.WbConfig.WbConfig
10import xiangshan.backend.decode.{ImmUnion, XDecode}
11import xiangshan.backend.exu.ExeUnitParams
12import xiangshan.backend.fu.FuType
13import xiangshan.backend.fu.fpu.Bundles.Frm
14import xiangshan.backend.fu.vector.Bundles.{Nf, VLmul, VSew, VType, Vl, Vxrm}
15import xiangshan.backend.issue.{IssueBlockParams, IssueQueueJumpBundle, SchedulerType, StatusArrayDeqRespBundle}
16import xiangshan.backend.regfile.{RfReadPortWithConfig, RfWritePortWithConfig}
17import xiangshan.backend.rob.RobPtr
18import xiangshan.frontend._
19import xiangshan.mem.{LqPtr, SqPtr}
20
21object Bundles {
22
23  // frontend -> backend
24  class StaticInst(implicit p: Parameters) extends XSBundle {
25    val instr           = UInt(32.W)
26    val pc              = UInt(VAddrBits.W)
27    val foldpc          = UInt(MemPredPCWidth.W)
28    val exceptionVec    = ExceptionVec()
29    val trigger         = new TriggerCf
30    val preDecodeInfo   = new PreDecodeInfo
31    val pred_taken      = Bool()
32    val crossPageIPFFix = Bool()
33    val ftqPtr          = new FtqPtr
34    val ftqOffset       = UInt(log2Up(PredictWidth).W)
35
36    def connectCtrlFlow(source: CtrlFlow): Unit = {
37      this.instr            := source.instr
38      this.pc               := source.pc
39      this.foldpc           := source.foldpc
40      this.exceptionVec     := source.exceptionVec
41      this.trigger          := source.trigger
42      this.preDecodeInfo    := source.pd
43      this.pred_taken       := source.pred_taken
44      this.crossPageIPFFix  := source.crossPageIPFFix
45      this.ftqPtr           := source.ftqPtr
46      this.ftqOffset        := source.ftqOffset
47    }
48  }
49
50  // StaticInst --[Decode]--> DecodedInst
51  class DecodedInst(implicit p: Parameters) extends XSBundle {
52    def numSrc = backendParams.numSrc
53    // passed from StaticInst
54    val instr           = UInt(32.W)
55    val pc              = UInt(VAddrBits.W)
56    val foldpc          = UInt(MemPredPCWidth.W)
57    val exceptionVec    = ExceptionVec()
58    val trigger         = new TriggerCf
59    val preDecodeInfo   = new PreDecodeInfo
60    val pred_taken      = Bool()
61    val crossPageIPFFix = Bool()
62    val ftqPtr          = new FtqPtr
63    val ftqOffset       = UInt(log2Up(PredictWidth).W)
64    // decoded
65    val srcType       = Vec(numSrc, SrcType())
66    val lsrc          = Vec(numSrc, UInt(6.W))
67    val ldest         = UInt(6.W)
68    val fuType        = FuType()
69    val fuOpType      = FuOpType()
70    val rfWen         = Bool()
71    val fpWen         = Bool()
72    val vecWen        = Bool()
73    val isXSTrap      = Bool()
74    val waitForward   = Bool() // no speculate execution
75    val blockBackward = Bool()
76    val flushPipe     = Bool() // This inst will flush all the pipe when commit, like exception but can commit
77    val selImm        = SelImm()
78    val imm           = UInt(ImmUnion.maxLen.W)
79    val fpu           = new FPUCtrlSignals
80    val vpu           = new VPUCtrlSignals
81    val isMove        = Bool()
82    val uopIdx        = UInt(5.W)
83    val vtype         = new VType
84    val uopDivType    = UopDivType()
85    val isVset        = Bool()
86    val firstUop      = Bool()
87    val lastUop       = Bool()
88    val commitType    = CommitType() // Todo: remove it
89
90    private def allSignals = srcType.take(3) ++ Seq(fuType, fuOpType, rfWen, fpWen, vecWen,
91      isXSTrap, waitForward, blockBackward, flushPipe, uopDivType, selImm)
92
93    def decode(inst: UInt, table: Iterable[(BitPat, List[BitPat])]): DecodedInst = {
94      val decoder: Seq[UInt] = ListLookup(
95        inst, XDecode.decodeDefault.map(bitPatToUInt),
96        table.map{ case (pat, pats) => (pat, pats.map(bitPatToUInt)) }.toArray
97      )
98      allSignals zip decoder foreach { case (s, d) => s := d }
99      this
100    }
101
102    def isSoftPrefetch: Bool = {
103      fuType === FuType.alu.U && fuOpType === ALUOpType.or && selImm === SelImm.IMM_I && ldest === 0.U
104    }
105
106    def connectStaticInst(source: StaticInst): Unit = {
107      for ((name, data) <- this.elements) {
108        if (source.elements.contains(name)) {
109          data := source.elements(name)
110        }
111      }
112    }
113  }
114
115  // DecodedInst --[Rename]--> DynInst
116  class DynInst(implicit p: Parameters) extends XSBundle {
117    def numSrc          = backendParams.numSrc
118    // passed from StaticInst
119    val instr           = UInt(32.W)
120    val pc              = UInt(VAddrBits.W)
121    val foldpc          = UInt(MemPredPCWidth.W)
122    val exceptionVec    = ExceptionVec()
123    val trigger         = new TriggerCf
124    val preDecodeInfo   = new PreDecodeInfo
125    val pred_taken      = Bool()
126    val crossPageIPFFix = Bool()
127    val ftqPtr          = new FtqPtr
128    val ftqOffset       = UInt(log2Up(PredictWidth).W)
129    // passed from DecodedInst
130    val srcType         = Vec(numSrc, SrcType())
131    val lsrc            = Vec(numSrc, UInt(6.W))
132    val ldest           = UInt(6.W)
133    val fuType          = FuType()
134    val fuOpType        = FuOpType()
135    val rfWen           = Bool()
136    val fpWen           = Bool()
137    val vecWen          = Bool()
138    val isXSTrap        = Bool()
139    val waitForward     = Bool() // no speculate execution
140    val blockBackward   = Bool()
141    val flushPipe       = Bool() // This inst will flush all the pipe when commit, like exception but can commit
142    val selImm          = SelImm()
143    val imm             = UInt(XLEN.W) // Todo: check if it need minimized
144    val fpu             = new FPUCtrlSignals
145    val vpu             = new VPUCtrlSignals
146    val isMove          = Bool()
147    val uopIdx          = UInt(5.W)
148    val vtype           = new VType
149    val isVset          = Bool()
150    val firstUop = Bool()
151    val lastUop = Bool()
152    val commitType      = CommitType()
153    // rename
154    val srcState        = Vec(numSrc, SrcState())
155    val psrc            = Vec(numSrc, UInt(PhyRegIdxWidth.W))
156    val pdest           = UInt(PhyRegIdxWidth.W)
157    val oldPdest        = UInt(PhyRegIdxWidth.W)
158    val robIdx          = new RobPtr
159
160    val eliminatedMove  = Bool()
161    val debugInfo       = new PerfDebugInfo
162    val storeSetHit     = Bool() // inst has been allocated an store set
163    val waitForRobIdx   = new RobPtr // store set predicted previous store robIdx
164    // Load wait is needed
165    // load inst will not be executed until former store (predicted by mdp) addr calcuated
166    val loadWaitBit     = Bool()
167    // If (loadWaitBit && loadWaitStrict), strict load wait is needed
168    // load inst will not be executed until ALL former store addr calcuated
169    val loadWaitStrict  = Bool()
170    val ssid            = UInt(SSIDWidth.W)
171    // Todo
172    val lqIdx = new LqPtr
173    val sqIdx = new SqPtr
174    // debug module
175    val singleStep      = Bool()
176    // schedule
177    val replayInst      = Bool()
178
179    def isLUI: Bool = this.fuType === FuType.alu.U && this.selImm === SelImm.IMM_U
180    def isWFI: Bool = this.fuType === FuType.csr.U && fuOpType === CSROpType.wfi
181
182    def isSvinvalBegin(flush: Bool) = FuType.isFence(fuType) && fuOpType === FenceOpType.nofence && !flush
183    def isSvinval(flush: Bool) = FuType.isFence(fuType) && fuOpType === FenceOpType.sfence && !flush
184    def isSvinvalEnd(flush: Bool) = FuType.isFence(fuType) && fuOpType === FenceOpType.nofence && flush
185
186    def srcIsReady: Vec[Bool] = {
187      VecInit(this.srcType.zip(this.srcState).map {
188        case (t, s) => SrcType.isNotReg(t) || SrcState.isReady(s)
189      })
190    }
191
192    def clearExceptions(
193      exceptionBits: Seq[Int] = Seq(),
194      flushPipe    : Boolean = false,
195      replayInst   : Boolean = false
196    ): DynInst = {
197      this.exceptionVec.zipWithIndex.filterNot(x => exceptionBits.contains(x._2)).foreach(_._1 := false.B)
198      if (!flushPipe) { this.flushPipe := false.B }
199      if (!replayInst) { this.replayInst := false.B }
200      this
201    }
202
203    def asWakeUpBundle: IssueQueueWakeUpBundle = {
204      val wakeup = Output(new IssueQueueWakeUpBundle(pdest.getWidth))
205      wakeup.rfWen := this.rfWen
206      wakeup.fpWen := this.fpWen
207      wakeup.vecWen := this.vecWen
208      wakeup.pdest := this.pdest
209      wakeup
210    }
211
212    def needWriteRf: Bool = (rfWen && ldest =/= 0.U) || fpWen || vecWen
213  }
214
215  trait BundleSource {
216    var source = "not exist"
217  }
218
219  class IssueQueueWakeUpBundle(PregIdxWidth: Int) extends Bundle with BundleSource {
220    val rfWen = Bool()
221    val fpWen = Bool()
222    val vecWen = Bool()
223    val pdest = UInt(PregIdxWidth.W)
224
225    /**
226      * @param successor Seq[(psrc, srcType)]
227      * @return Seq[if wakeup psrc]
228      */
229    def wakeUp(successor: Seq[(UInt, UInt)], valid: Bool): Seq[Bool]= {
230      successor.map { case (thatPsrc, srcType) =>
231        val pdestMatch = pdest === thatPsrc
232        pdestMatch && (
233          SrcType.isFp(srcType) && this.fpWen ||
234          SrcType.isXp(srcType) && this.rfWen ||
235          SrcType.isVp(srcType) && this.vecWen
236        ) && valid
237      }
238    }
239  }
240
241  object VsewBundle {
242    def apply()   = UInt(2.W)   // 8/16/32/64 --> 0/1/2/3
243  }
244
245  class VPUCtrlSignals(implicit p: Parameters) extends XSBundle {
246    // vtype
247    val vill      = Bool()
248    val vma       = Bool()    // 1: agnostic, 0: undisturbed
249    val vta       = Bool()    // 1: agnostic, 0: undisturbed
250    val vsew      = VSew()
251    val vlmul     = VLmul()   // 1/8~8      --> -3~3
252
253    val vm        = Bool()    // 0: need v0.t
254    val vstart    = Vl()
255
256    // float rounding mode
257    val frm       = Frm()
258    // vector fix int rounding mode
259    val vxrm      = Vxrm()
260    // vector uop index, exclude other non-vector uop
261    val vuopIdx   = UInt(log2Up(p(XSCoreParamsKey).MaxUopSize).W)
262    // maybe used if data dependancy
263    val vmask     = UInt(MaskSrcData().dataWidth.W)
264    val vl        = Vl()
265
266    // vector load/store
267    val nf        = Nf()
268  }
269
270  // DynInst --[IssueQueue]--> DataPath
271  class IssueQueueIssueBundle(
272    iqParams: IssueBlockParams,
273    exuParams: ExeUnitParams,
274    addrWidth: Int,
275    vaddrBits: Int
276  )(implicit
277    p: Parameters
278  ) extends Bundle {
279    private val rfReadDataCfgSet: Seq[Set[DataConfig]] = exuParams.getRfReadDataCfgSet
280
281    val rf: MixedVec[MixedVec[RfReadPortWithConfig]] = Flipped(MixedVec(
282      rfReadDataCfgSet.map((set: Set[DataConfig]) =>
283        MixedVec(set.map((x: DataConfig) => new RfReadPortWithConfig(x, addrWidth)).toSeq)
284      )
285    ))
286    val srcType = Vec(exuParams.numRegSrc, SrcType()) // used to select imm or reg data
287    val immType = SelImm()                         // used to select imm extractor
288    val common = new ExuInput(exuParams)
289    val jmp = if (exuParams.needPc) Some(Flipped(new IssueQueueJumpBundle)) else None
290    val addrOH = UInt(iqParams.numEntries.W)
291
292    def getSource: SchedulerType = exuParams.getWBSource
293    def getIntRfReadBundle: Seq[RfReadPortWithConfig] = rf.flatten.filter(_.readInt)
294    def getFpRfReadBundle: Seq[RfReadPortWithConfig] = rf.flatten.filter(x => x.readFp || x.readVec)
295  }
296
297  class OGRespBundle(implicit p:Parameters, params: IssueBlockParams) extends XSBundle {
298    val og0resp = Valid(new StatusArrayDeqRespBundle)
299    val og1resp = Valid(new StatusArrayDeqRespBundle)
300  }
301
302  // DataPath --[ExuInput]--> Exu
303  class ExuInput(val params: ExeUnitParams)(implicit p: Parameters) extends XSBundle {
304    val fuType        = FuType()
305    val fuOpType      = FuOpType()
306    val src           = Vec(params.numRegSrc, UInt(params.dataBitsMax.W))
307    val imm           = UInt(XLEN.W)
308    val robIdx        = new RobPtr
309    val iqIdx         = UInt(log2Up(MemIQSizeMax).W)// Only used by store yet
310    val isFirstIssue  = Bool()                      // Only used by store yet
311    val pdest         = UInt(params.wbPregIdxWidth.W)
312    val rfWen         = if (params.writeIntRf)    Some(Bool())                        else None
313    val fpWen         = if (params.writeFpRf)     Some(Bool())                        else None
314    val vecWen        = if (params.writeVecRf)    Some(Bool())                        else None
315    val fpu           = if (params.needFPUCtrl)   Some(new FPUCtrlSignals)            else None
316    val flushPipe     = if (params.flushPipe)     Some(Bool())                        else None
317    val pc            = if (params.needPc)        Some(UInt(VAddrData().dataWidth.W)) else None
318    val jalrTarget    = if (params.hasJmpFu)      Some(UInt(VAddrData().dataWidth.W)) else None
319    val preDecode     = if (params.hasPredecode)  Some(new PreDecodeInfo)             else None
320    val ftqIdx        = if (params.needPc || params.replayInst)
321                                                  Some(new FtqPtr)                    else None
322    val ftqOffset     = if (params.needPc || params.replayInst)
323                                                  Some(UInt(log2Up(PredictWidth).W))  else None
324    val predictInfo   = if (params.hasPredecode)  Some(new Bundle {
325      val target = UInt(VAddrData().dataWidth.W)
326      val taken = Bool()
327    }) else None
328    val sqIdx = if (params.hasMemAddrFu || params.hasStdFu) Some(new SqPtr) else None
329    val lqIdx = if (params.hasMemAddrFu) Some(new LqPtr) else None
330
331    def fromIssueBundle(source: IssueQueueIssueBundle): Unit = {
332      // src is assigned to rfReadData
333      this.fuType       := source.common.fuType
334      this.fuOpType     := source.common.fuOpType
335      this.imm          := source.common.imm
336      this.robIdx       := source.common.robIdx
337      this.pdest        := source.common.pdest
338      this.isFirstIssue := source.common.isFirstIssue // Only used by mem debug log
339      this.iqIdx        := source.common.iqIdx        // Only used by mem feedback
340      this.rfWen        .foreach(_ := source.common.rfWen.get)
341      this.fpWen        .foreach(_ := source.common.fpWen.get)
342      this.vecWen       .foreach(_ := source.common.vecWen.get)
343      this.fpu          .foreach(_ := source.common.fpu.get)
344      this.flushPipe    .foreach(_ := source.common.flushPipe.get)
345      this.pc           .foreach(_ := source.jmp.get.pc)
346      this.jalrTarget   .foreach(_ := source.jmp.get.target)
347      this.preDecode    .foreach(_ := source.common.preDecode.get)
348      this.ftqIdx       .foreach(_ := source.common.ftqIdx.get)
349      this.ftqOffset    .foreach(_ := source.common.ftqOffset.get)
350      this.predictInfo  .foreach(_ := source.common.predictInfo.get)
351      this.lqIdx        .foreach(_ := source.common.lqIdx.get)
352      this.sqIdx        .foreach(_ := source.common.sqIdx.get)
353    }
354  }
355
356  // ExuInput --[FuncUnit]--> ExuOutput
357  class ExuOutput(
358    val params: ExeUnitParams,
359  )(implicit
360    val p: Parameters
361  ) extends Bundle with BundleSource with HasXSParameter {
362    val data         = UInt(params.dataBitsMax.W)
363    val pdest        = UInt(params.wbPregIdxWidth.W)
364    val robIdx       = new RobPtr
365    val intWen       = if (params.writeIntRf)   Some(Bool())                  else None
366    val fpWen        = if (params.writeFpRf)    Some(Bool())                  else None
367    val vecWen       = if (params.writeVecRf)   Some(Bool())                  else None
368    val redirect     = if (params.hasRedirect)  Some(ValidIO(new Redirect))   else None
369    val fflags       = if (params.writeFflags)  Some(UInt(5.W))               else None
370    val vxsat        = if (params.writeVxsat)   Some(Bool())                  else None
371    val exceptionVec = if (params.exceptionOut.nonEmpty) Some(ExceptionVec()) else None
372    val flushPipe    = if (params.flushPipe)    Some(Bool())                  else None
373    val replay       = if (params.replayInst)   Some(Bool())                  else None
374    val lqIdx        = if (params.hasLoadFu)    Some(new LqPtr())             else None
375    val sqIdx        = if (params.hasStoreAddrFu || params.hasStdFu)
376                                                Some(new SqPtr())             else None
377    val ftqIdx       = if (params.needPc || params.replayInst)
378                                                Some(new FtqPtr)                    else None
379    val ftqOffset    = if (params.needPc || params.replayInst)
380                                                Some(UInt(log2Up(PredictWidth).W))  else None
381    // uop info
382    val predecodeInfo = if(params.hasPredecode) Some(new PreDecodeInfo) else None
383    val debug = new DebugBundle
384    val debugInfo = new PerfDebugInfo
385  }
386
387  // ExuOutput + DynInst --> WriteBackBundle
388  class WriteBackBundle(val params: WbConfig)(implicit p: Parameters) extends Bundle with BundleSource {
389    val rfWen = Bool()
390    val fpWen = Bool()
391    val vecWen = Bool()
392    val pdest = UInt(params.pregIdxWidth.W)
393    val data = UInt(params.dataWidth.W)
394    val robIdx = new RobPtr()(p)
395    val flushPipe = Bool()
396    val replayInst = Bool()
397    val redirect = ValidIO(new Redirect)
398    val fflags = UInt(5.W)
399    val exceptionVec = ExceptionVec()
400    val debug = new DebugBundle
401    val debugInfo = new PerfDebugInfo
402
403    def fromExuOutput(source: ExuOutput) = {
404      this.rfWen  := source.intWen.getOrElse(false.B)
405      this.fpWen  := source.fpWen.getOrElse(false.B)
406      this.vecWen := source.vecWen.getOrElse(false.B)
407      this.pdest  := source.pdest
408      this.data   := source.data
409      this.robIdx := source.robIdx
410      this.flushPipe := source.flushPipe.getOrElse(false.B)
411      this.replayInst := source.replay.getOrElse(false.B)
412      this.redirect := source.redirect.getOrElse(0.U.asTypeOf(this.redirect))
413      this.fflags := source.fflags.getOrElse(0.U.asTypeOf(this.fflags))
414      this.exceptionVec := source.exceptionVec.getOrElse(0.U.asTypeOf(this.exceptionVec))
415      this.debug := source.debug
416      this.debugInfo := source.debugInfo
417    }
418
419    def asWakeUpBundle: IssueQueueWakeUpBundle = {
420      val wakeup = Output(new IssueQueueWakeUpBundle(params.pregIdxWidth))
421      wakeup.rfWen := this.rfWen
422      wakeup.fpWen := this.fpWen
423      wakeup.vecWen := this.vecWen
424      wakeup.pdest := this.pdest
425      wakeup.source = this.source
426      wakeup
427    }
428
429    def asIntRfWriteBundle(fire: Bool): RfWritePortWithConfig = {
430      val rfWrite = Wire(Output(new RfWritePortWithConfig(this.params.dataCfg, this.params.pregIdxWidth)))
431      rfWrite.wen := this.rfWen && fire
432      rfWrite.addr := this.pdest
433      rfWrite.data := this.data
434      rfWrite.intWen := this.rfWen
435      rfWrite.fpWen := false.B
436      rfWrite.vecWen := false.B
437      rfWrite
438    }
439
440    def asVfRfWriteBundle(fire: Bool): RfWritePortWithConfig = {
441      val rfWrite = Wire(Output(new RfWritePortWithConfig(this.params.dataCfg, this.params.pregIdxWidth)))
442      rfWrite.wen := (this.fpWen || this.vecWen) && fire
443      rfWrite.addr := this.pdest
444      rfWrite.data := this.data
445      rfWrite.intWen := false.B
446      rfWrite.fpWen := this.fpWen
447      rfWrite.vecWen := this.vecWen
448      rfWrite
449    }
450  }
451
452  class ExceptionInfo extends Bundle {
453    val pc = UInt(VAddrData().dataWidth.W)
454    val instr = UInt(32.W)
455    val commitType = CommitType()
456    val exceptionVec = ExceptionVec()
457    val singleStep = Bool()
458    val crossPageIPFFix = Bool()
459    val isInterrupt = Bool()
460  }
461
462  class MemExuInput(implicit p: Parameters) extends XSBundle {
463    val uop = new DynInst
464    val src = Vec(3, UInt(XLEN.W))
465    val iqIdx = UInt(log2Up(MemIQSizeMax).W)
466    val isFirstIssue = Bool()
467  }
468
469  class MemExuOutput(implicit p: Parameters) extends XSBundle {
470    val uop = new DynInst
471    val data = UInt(XLEN.W)
472    val debug = new DebugBundle
473  }
474
475  class MemMicroOpRbExt(implicit p: Parameters) extends XSBundle {
476    val uop = new DynInst
477    val flag = UInt(1.W)
478  }
479}
480