xref: /XiangShan/src/main/scala/xiangshan/backend/rename/Rename.scala (revision e13d224a171ca31556118081225ebfc4b6018142)
1/***************************************************************************************
2* Copyright (c) 2020-2021 Institute of Computing Technology, Chinese Academy of Sciences
3* Copyright (c) 2020-2021 Peng Cheng Laboratory
4*
5* XiangShan is licensed under Mulan PSL v2.
6* You can use this software according to the terms and conditions of the Mulan PSL v2.
7* You may obtain a copy of Mulan PSL v2 at:
8*          http://license.coscl.org.cn/MulanPSL2
9*
10* THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
11* EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
12* MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
13*
14* See the Mulan PSL v2 for more details.
15***************************************************************************************/
16
17package xiangshan.backend.rename
18
19import chipsalliance.rocketchip.config.Parameters
20import chisel3._
21import chisel3.util._
22import xiangshan._
23import utils._
24import xiangshan.backend.rob.RobPtr
25import xiangshan.backend.rename.freelist._
26import xiangshan.mem.mdp._
27
28class Rename(implicit p: Parameters) extends XSModule with HasPerfEvents {
29  val io = IO(new Bundle() {
30    val redirect = Flipped(ValidIO(new Redirect))
31    val robCommits = Flipped(new RobCommitIO)
32    // from decode
33    val in = Vec(RenameWidth, Flipped(DecoupledIO(new CfCtrl)))
34    // ssit read result
35    val ssit = Flipped(Vec(RenameWidth, Output(new SSITEntry)))
36    // waittable read result
37    val waittable = Flipped(Vec(RenameWidth, Output(Bool())))
38    // to rename table
39    val intReadPorts = Vec(RenameWidth, Vec(3, Input(UInt(PhyRegIdxWidth.W))))
40    val fpReadPorts = Vec(RenameWidth, Vec(4, Input(UInt(PhyRegIdxWidth.W))))
41    val intRenamePorts = Vec(RenameWidth, Output(new RatWritePort))
42    val fpRenamePorts = Vec(RenameWidth, Output(new RatWritePort))
43    // to dispatch1
44    val out = Vec(RenameWidth, DecoupledIO(new MicroOp))
45  })
46
47  // create free list and rat
48  val intFreeList = Module(new MEFreeList(NRPhyRegs))
49  val intRefCounter = Module(new RefCounter(NRPhyRegs))
50  val fpFreeList = Module(new StdFreeList(NRPhyRegs - 32))
51
52  // decide if given instruction needs allocating a new physical register (CfCtrl: from decode; RobCommitInfo: from rob)
53  def needDestReg[T <: CfCtrl](fp: Boolean, x: T): Bool = {
54    {if(fp) x.ctrl.fpWen else x.ctrl.rfWen && (x.ctrl.ldest =/= 0.U)}
55  }
56  def needDestRegCommit[T <: RobCommitInfo](fp: Boolean, x: T): Bool = {
57    if(fp) x.fpWen else x.rfWen
58  }
59
60  // connect [redirect + walk] ports for __float point__ & __integer__ free list
61  Seq((fpFreeList, true), (intFreeList, false)).foreach{ case (fl, isFp) =>
62    fl.io.redirect := io.redirect.valid
63    fl.io.walk := io.robCommits.isWalk
64    // when isWalk, use stepBack to restore head pointer of free list
65    // (if ME enabled, stepBack of intFreeList should be useless thus optimized out)
66    fl.io.stepBack := PopCount(io.robCommits.valid.zip(io.robCommits.info).map{case (v, i) => v && needDestRegCommit(isFp, i)})
67  }
68  // walk has higher priority than allocation and thus we don't use isWalk here
69  // only when both fp and int free list and dispatch1 has enough space can we do allocation
70  intFreeList.io.doAllocate := fpFreeList.io.canAllocate && io.out(0).ready
71  fpFreeList.io.doAllocate := intFreeList.io.canAllocate && io.out(0).ready
72
73  //           dispatch1 ready ++ float point free list ready ++ int free list ready      ++ not walk
74  val canOut = io.out(0).ready && fpFreeList.io.canAllocate && intFreeList.io.canAllocate && !io.robCommits.isWalk
75
76
77  // speculatively assign the instruction with an robIdx
78  val validCount = PopCount(io.in.map(_.valid)) // number of instructions waiting to enter rob (from decode)
79  val robIdxHead = RegInit(0.U.asTypeOf(new RobPtr))
80  val lastCycleMisprediction = RegNext(io.redirect.valid && !io.redirect.bits.flushItself())
81  val robIdxHeadNext = Mux(io.redirect.valid, io.redirect.bits.robIdx, // redirect: move ptr to given rob index
82         Mux(lastCycleMisprediction, robIdxHead + 1.U, // mis-predict: not flush robIdx itself
83                         Mux(canOut, robIdxHead + validCount, // instructions successfully entered next stage: increase robIdx
84                      /* default */  robIdxHead))) // no instructions passed by this cycle: stick to old value
85  robIdxHead := robIdxHeadNext
86
87  /**
88    * Rename: allocate free physical register and update rename table
89    */
90  val uops = Wire(Vec(RenameWidth, new MicroOp))
91  uops.foreach( uop => {
92    uop.srcState(0) := DontCare
93    uop.srcState(1) := DontCare
94    uop.srcState(2) := DontCare
95    uop.robIdx := DontCare
96    uop.debugInfo := DontCare
97    uop.lqIdx := DontCare
98    uop.sqIdx := DontCare
99  })
100
101  val needFpDest = Wire(Vec(RenameWidth, Bool()))
102  val needIntDest = Wire(Vec(RenameWidth, Bool()))
103  val hasValid = Cat(io.in.map(_.valid)).orR
104
105  val isMove = io.in.map(_.bits.ctrl.isMove)
106  val intPsrc = Wire(Vec(RenameWidth, UInt()))
107
108  val intSpecWen = Wire(Vec(RenameWidth, Bool()))
109  val fpSpecWen = Wire(Vec(RenameWidth, Bool()))
110
111  // uop calculation
112  for (i <- 0 until RenameWidth) {
113    uops(i).cf := io.in(i).bits.cf
114    uops(i).ctrl := io.in(i).bits.ctrl
115
116    // update cf according to ssit result
117    uops(i).cf.storeSetHit := io.ssit(i).valid
118    uops(i).cf.loadWaitStrict := io.ssit(i).strict && io.ssit(i).valid
119    uops(i).cf.ssid := io.ssit(i).ssid
120
121    // update cf according to waittable result
122    uops(i).cf.loadWaitBit := io.waittable(i)
123
124    val inValid = io.in(i).valid
125
126    // alloc a new phy reg
127    needFpDest(i) := inValid && needDestReg(fp = true, io.in(i).bits)
128    needIntDest(i) := inValid && needDestReg(fp = false, io.in(i).bits)
129    fpFreeList.io.allocateReq(i) := needFpDest(i)
130    intFreeList.io.allocateReq(i) := needIntDest(i) && !isMove(i)
131
132    // no valid instruction from decode stage || all resources (dispatch1 + both free lists) ready
133    io.in(i).ready := !hasValid || canOut
134
135    uops(i).robIdx := robIdxHead + PopCount(io.in.take(i).map(_.valid))
136
137    val intPhySrcVec = io.intReadPorts(i).take(2)
138    val intOldPdest = io.intReadPorts(i).last
139    intPsrc(i) := intPhySrcVec(0)
140    val fpPhySrcVec = io.fpReadPorts(i).take(3)
141    val fpOldPdest = io.fpReadPorts(i).last
142    uops(i).psrc(0) := Mux(uops(i).ctrl.srcType(0) === SrcType.reg, intPhySrcVec(0), fpPhySrcVec(0))
143    uops(i).psrc(1) := Mux(uops(i).ctrl.srcType(1) === SrcType.reg, intPhySrcVec(1), fpPhySrcVec(1))
144    uops(i).psrc(2) := fpPhySrcVec(2)
145    uops(i).old_pdest := Mux(uops(i).ctrl.rfWen, intOldPdest, fpOldPdest)
146    uops(i).eliminatedMove := isMove(i)
147
148    // update pdest
149    uops(i).pdest := Mux(needIntDest(i), intFreeList.io.allocatePhyReg(i), // normal int inst
150      // normal fp inst
151      Mux(needFpDest(i), fpFreeList.io.allocatePhyReg(i),
152        /* default */0.U))
153
154    // Assign performance counters
155    uops(i).debugInfo.renameTime := GTimer()
156
157    io.out(i).valid := io.in(i).valid && intFreeList.io.canAllocate && fpFreeList.io.canAllocate && !io.robCommits.isWalk
158    io.out(i).bits := uops(i)
159    when (io.out(i).bits.ctrl.fuType === FuType.fence) {
160      io.out(i).bits.ctrl.imm := Cat(io.in(i).bits.ctrl.lsrc(1), io.in(i).bits.ctrl.lsrc(0))
161    }
162
163    // write speculative rename table
164    // we update rat later inside commit code
165    intSpecWen(i) := needIntDest(i) && intFreeList.io.canAllocate && intFreeList.io.doAllocate && !io.robCommits.isWalk && !io.redirect.valid
166    fpSpecWen(i) := needFpDest(i) && fpFreeList.io.canAllocate && fpFreeList.io.doAllocate && !io.robCommits.isWalk && !io.redirect.valid
167
168    intRefCounter.io.allocate(i).valid := intSpecWen(i)
169    intRefCounter.io.allocate(i).bits := io.out(i).bits.pdest
170  }
171
172  /**
173    * How to set psrc:
174    * - bypass the pdest to psrc if previous instructions write to the same ldest as lsrc
175    * - default: psrc from RAT
176    * How to set pdest:
177    * - Mux(isMove, psrc, pdest_from_freelist).
178    *
179    * The critical path of rename lies here:
180    * When move elimination is enabled, we need to update the rat with psrc.
181    * However, psrc maybe comes from previous instructions' pdest, which comes from freelist.
182    *
183    * If we expand these logic for pdest(N):
184    * pdest(N) = Mux(isMove(N), psrc(N), freelist_out(N))
185    *          = Mux(isMove(N), Mux(bypass(N, N - 1), pdest(N - 1),
186    *                           Mux(bypass(N, N - 2), pdest(N - 2),
187    *                           ...
188    *                           Mux(bypass(N, 0),     pdest(0),
189    *                                                 rat_out(N))...)),
190    *                           freelist_out(N))
191    */
192  // a simple functional model for now
193  io.out(0).bits.pdest := Mux(isMove(0), uops(0).psrc.head, uops(0).pdest)
194  val bypassCond = Wire(Vec(4, MixedVec(List.tabulate(RenameWidth-1)(i => UInt((i+1).W)))))
195  for (i <- 1 until RenameWidth) {
196    val fpCond = io.in(i).bits.ctrl.srcType.map(_ === SrcType.fp) :+ needFpDest(i)
197    val intCond = io.in(i).bits.ctrl.srcType.map(_ === SrcType.reg) :+ needIntDest(i)
198    val target = io.in(i).bits.ctrl.lsrc :+ io.in(i).bits.ctrl.ldest
199    for ((((cond1, cond2), t), j) <- fpCond.zip(intCond).zip(target).zipWithIndex) {
200      val destToSrc = io.in.take(i).zipWithIndex.map { case (in, j) =>
201        val indexMatch = in.bits.ctrl.ldest === t
202        val writeMatch =  cond2 && needIntDest(j) || cond1 && needFpDest(j)
203        indexMatch && writeMatch
204      }
205      bypassCond(j)(i - 1) := VecInit(destToSrc).asUInt
206    }
207    io.out(i).bits.psrc(0) := io.out.take(i).map(_.bits.pdest).zip(bypassCond(0)(i-1).asBools).foldLeft(uops(i).psrc(0)) {
208      (z, next) => Mux(next._2, next._1, z)
209    }
210    io.out(i).bits.psrc(1) := io.out.take(i).map(_.bits.pdest).zip(bypassCond(1)(i-1).asBools).foldLeft(uops(i).psrc(1)) {
211      (z, next) => Mux(next._2, next._1, z)
212    }
213    io.out(i).bits.psrc(2) := io.out.take(i).map(_.bits.pdest).zip(bypassCond(2)(i-1).asBools).foldLeft(uops(i).psrc(2)) {
214      (z, next) => Mux(next._2, next._1, z)
215    }
216    io.out(i).bits.old_pdest := io.out.take(i).map(_.bits.pdest).zip(bypassCond(3)(i-1).asBools).foldLeft(uops(i).old_pdest) {
217      (z, next) => Mux(next._2, next._1, z)
218    }
219    io.out(i).bits.pdest := Mux(isMove(i), io.out(i).bits.psrc(0), uops(i).pdest)
220  }
221
222  /**
223    * Instructions commit: update freelist and rename table
224    */
225  for (i <- 0 until CommitWidth) {
226
227    Seq((io.intRenamePorts, false), (io.fpRenamePorts, true)) foreach { case (rat, fp) =>
228      // is valid commit req and given instruction has destination register
229      val commitDestValid = io.robCommits.valid(i) && needDestRegCommit(fp, io.robCommits.info(i))
230      XSDebug(p"isFp[${fp}]index[$i]-commitDestValid:$commitDestValid,isWalk:${io.robCommits.isWalk}\n")
231
232      /*
233      I. RAT Update
234       */
235
236      // walk back write - restore spec state : ldest => old_pdest
237      if (fp && i < RenameWidth) {
238        // When redirect happens (mis-prediction), don't update the rename table
239        rat(i).wen := fpSpecWen(i)
240        rat(i).addr := uops(i).ctrl.ldest
241        rat(i).data := fpFreeList.io.allocatePhyReg(i)
242      } else if (!fp && i < RenameWidth) {
243        rat(i).wen := intSpecWen(i)
244        rat(i).addr := uops(i).ctrl.ldest
245        rat(i).data := io.out(i).bits.pdest
246      }
247
248      /*
249      II. Free List Update
250       */
251      if (fp) { // Float Point free list
252        fpFreeList.io.freeReq(i)  := commitDestValid && !io.robCommits.isWalk
253        fpFreeList.io.freePhyReg(i) := io.robCommits.info(i).old_pdest
254      } else { // Integer free list
255        intFreeList.io.freeReq(i) := intRefCounter.io.freeRegs(i).valid
256        intFreeList.io.freePhyReg(i) := intRefCounter.io.freeRegs(i).bits
257      }
258    }
259    intRefCounter.io.deallocate(i).valid := io.robCommits.valid(i) && needDestRegCommit(false, io.robCommits.info(i))
260    intRefCounter.io.deallocate(i).bits := Mux(io.robCommits.isWalk, io.robCommits.info(i).pdest, io.robCommits.info(i).old_pdest)
261  }
262
263  /*
264  Debug and performance counters
265   */
266  def printRenameInfo(in: DecoupledIO[CfCtrl], out: DecoupledIO[MicroOp]) = {
267    XSInfo(out.fire, p"pc:${Hexadecimal(in.bits.cf.pc)} in(${in.valid},${in.ready}) " +
268      p"lsrc(0):${in.bits.ctrl.lsrc(0)} -> psrc(0):${out.bits.psrc(0)} " +
269      p"lsrc(1):${in.bits.ctrl.lsrc(1)} -> psrc(1):${out.bits.psrc(1)} " +
270      p"lsrc(2):${in.bits.ctrl.lsrc(2)} -> psrc(2):${out.bits.psrc(2)} " +
271      p"ldest:${in.bits.ctrl.ldest} -> pdest:${out.bits.pdest} " +
272      p"old_pdest:${out.bits.old_pdest}\n"
273    )
274  }
275
276  for((x,y) <- io.in.zip(io.out)){
277    printRenameInfo(x, y)
278  }
279
280  XSDebug(io.robCommits.isWalk, p"Walk Recovery Enabled\n")
281  XSDebug(io.robCommits.isWalk, p"validVec:${Binary(io.robCommits.valid.asUInt)}\n")
282  for (i <- 0 until CommitWidth) {
283    val info = io.robCommits.info(i)
284    XSDebug(io.robCommits.isWalk && io.robCommits.valid(i), p"[#$i walk info] pc:${Hexadecimal(info.pc)} " +
285      p"ldest:${info.ldest} rfWen:${info.rfWen} fpWen:${info.fpWen} " +
286      p"pdest:${info.pdest} old_pdest:${info.old_pdest}\n")
287  }
288
289  XSDebug(p"inValidVec: ${Binary(Cat(io.in.map(_.valid)))}\n")
290
291  XSPerfAccumulate("in", Mux(RegNext(io.in(0).ready), PopCount(io.in.map(_.valid)), 0.U))
292  XSPerfAccumulate("utilization", PopCount(io.in.map(_.valid)))
293  XSPerfAccumulate("waitInstr", PopCount((0 until RenameWidth).map(i => io.in(i).valid && !io.in(i).ready)))
294  XSPerfAccumulate("stall_cycle_dispatch", hasValid && !io.out(0).ready && fpFreeList.io.canAllocate && intFreeList.io.canAllocate && !io.robCommits.isWalk)
295  XSPerfAccumulate("stall_cycle_fp", hasValid && io.out(0).ready && !fpFreeList.io.canAllocate && intFreeList.io.canAllocate && !io.robCommits.isWalk)
296  XSPerfAccumulate("stall_cycle_int", hasValid && io.out(0).ready && fpFreeList.io.canAllocate && !intFreeList.io.canAllocate && !io.robCommits.isWalk)
297  XSPerfAccumulate("stall_cycle_walk", hasValid && io.out(0).ready && fpFreeList.io.canAllocate && intFreeList.io.canAllocate && io.robCommits.isWalk)
298
299  XSPerfAccumulate("move_instr_count", PopCount(io.out.map(out => out.fire() && out.bits.ctrl.isMove)))
300
301
302  val renamePerf = Seq(
303    ("rename_in                  ", PopCount(io.in.map(_.valid & io.in(0).ready ))                                                               ),
304    ("rename_waitinstr           ", PopCount((0 until RenameWidth).map(i => io.in(i).valid && !io.in(i).ready))                                  ),
305    ("rename_stall_cycle_dispatch", hasValid && !io.out(0).ready &&  fpFreeList.io.canAllocate &&  intFreeList.io.canAllocate && !io.robCommits.isWalk),
306    ("rename_stall_cycle_fp      ", hasValid &&  io.out(0).ready && !fpFreeList.io.canAllocate &&  intFreeList.io.canAllocate && !io.robCommits.isWalk),
307    ("rename_stall_cycle_int     ", hasValid &&  io.out(0).ready &&  fpFreeList.io.canAllocate && !intFreeList.io.canAllocate && !io.robCommits.isWalk),
308    ("rename_stall_cycle_walk    ", hasValid &&  io.out(0).ready &&  fpFreeList.io.canAllocate &&  intFreeList.io.canAllocate &&  io.robCommits.isWalk)
309  )
310  val intFlPerf = intFreeList.getPerfEvents
311  val fpFlPerf = fpFreeList.getPerfEvents
312  val perfEvents = renamePerf ++ intFlPerf ++ fpFlPerf
313  generatePerfEvent()
314}
315