xref: /XiangShan/src/main/scala/xiangshan/mem/pipeline/AtomicsUnit.scala (revision ae20d4f813bcc42178dcf493be4be500e5c7c0b9)
1package xiangshan.mem
2
3import chisel3._
4import chisel3.util._
5import utils._
6import xiangshan._
7import xiangshan.cache.{DCacheWordIO, TlbRequestIO, TlbCmd, MemoryOpConstants}
8import xiangshan.backend.LSUOpType
9
10class AtomicsUnit extends XSModule with MemoryOpConstants{
11  val io = IO(new Bundle() {
12    val in            = Flipped(Decoupled(new ExuInput))
13    val out           = Decoupled(new ExuOutput)
14    val dcache        = new DCacheWordIO
15    val dtlb          = new TlbRequestIO
16    val rsIdx         = Input(UInt(log2Up(IssQueSize).W))
17    val flush_sbuffer = new SbufferFlushBundle
18    val tlbFeedback   = ValidIO(new TlbFeedback)
19    val redirect      = Flipped(ValidIO(new Redirect))
20    val flush      = Input(Bool())
21    val exceptionAddr = ValidIO(UInt(VAddrBits.W))
22  })
23
24  val difftestIO = IO(new Bundle() {
25    val atomicResp = Output(Bool())
26    val atomicAddr = Output(UInt(64.W))
27    val atomicData = Output(UInt(64.W))
28    val atomicMask = Output(UInt(8.W))
29    val atomicFuop = Output(UInt(8.W))
30    val atomicOut  = Output(UInt(64.W))
31  })
32  difftestIO <> DontCare
33
34  //-------------------------------------------------------
35  // Atomics Memory Accsess FSM
36  //-------------------------------------------------------
37  val s_invalid :: s_tlb  :: s_flush_sbuffer_req :: s_flush_sbuffer_resp :: s_cache_req :: s_cache_resp :: s_finish :: Nil = Enum(7)
38  val state = RegInit(s_invalid)
39  val in = Reg(new ExuInput())
40  val exceptionVec = RegInit(0.U.asTypeOf(ExceptionVec()))
41  val atom_override_xtval = RegInit(false.B)
42  // paddr after translation
43  val paddr = Reg(UInt())
44  val is_mmio = Reg(Bool())
45  // dcache response data
46  val resp_data = Reg(UInt())
47  val resp_data_wire = WireInit(0.U)
48  val is_lrsc_valid = Reg(Bool())
49
50  // Difftest signals
51  val paddr_reg = Reg(UInt(64.W))
52  val data_reg = Reg(UInt(64.W))
53  val mask_reg = Reg(UInt(8.W))
54  val fuop_reg = Reg(UInt(8.W))
55
56  io.exceptionAddr.valid := atom_override_xtval
57  io.exceptionAddr.bits  := in.src1
58
59  // assign default value to output signals
60  io.in.ready          := false.B
61  io.out.valid         := false.B
62  io.out.bits          := DontCare
63
64  io.dcache.req.valid  := false.B
65  io.dcache.req.bits   := DontCare
66  io.dcache.resp.ready := false.B
67
68  io.dtlb.req.valid    := false.B
69  io.dtlb.req.bits     := DontCare
70  io.dtlb.resp.ready   := false.B
71
72  io.flush_sbuffer.valid := false.B
73
74  XSDebug("state: %d\n", state)
75
76  when (state === s_invalid) {
77    io.in.ready := true.B
78    when (io.in.fire()) {
79      in := io.in.bits
80      state := s_tlb
81    }
82  }
83
84  // Send TLB feedback to store issue queue
85  // we send feedback right after we receives request
86  // also, we always treat amo as tlb hit
87  // since we will continue polling tlb all by ourself
88  io.tlbFeedback.valid       := RegNext(RegNext(io.in.valid))
89  io.tlbFeedback.bits.hit    := true.B
90  io.tlbFeedback.bits.rsIdx  := RegEnable(io.rsIdx, io.in.valid)
91
92  // tlb translation, manipulating signals && deal with exception
93  when (state === s_tlb) {
94    // send req to dtlb
95    // keep firing until tlb hit
96    io.dtlb.req.valid       := true.B
97    io.dtlb.req.bits.vaddr  := in.src1
98    io.dtlb.req.bits.roqIdx := in.uop.roqIdx
99    io.dtlb.resp.ready      := true.B
100    val is_lr = in.uop.ctrl.fuOpType === LSUOpType.lr_w || in.uop.ctrl.fuOpType === LSUOpType.lr_d
101    io.dtlb.req.bits.cmd    := Mux(is_lr, TlbCmd.atom_read, TlbCmd.atom_write)
102    io.dtlb.req.bits.debug.pc := in.uop.cf.pc
103
104    when(io.dtlb.resp.fire && !io.dtlb.resp.bits.miss){
105      // exception handling
106      val addrAligned = LookupTree(in.uop.ctrl.fuOpType(1,0), List(
107        "b00".U   -> true.B,              //b
108        "b01".U   -> (in.src1(0) === 0.U),   //h
109        "b10".U   -> (in.src1(1,0) === 0.U), //w
110        "b11".U   -> (in.src1(2,0) === 0.U)  //d
111      ))
112      exceptionVec(storeAddrMisaligned) := !addrAligned
113      exceptionVec(storePageFault)      := io.dtlb.resp.bits.excp.pf.st
114      exceptionVec(loadPageFault)       := io.dtlb.resp.bits.excp.pf.ld
115      exceptionVec(storeAccessFault)    := io.dtlb.resp.bits.excp.af.st
116      exceptionVec(loadAccessFault)     := io.dtlb.resp.bits.excp.af.ld
117      val exception = !addrAligned ||
118        io.dtlb.resp.bits.excp.pf.st ||
119        io.dtlb.resp.bits.excp.pf.ld ||
120        io.dtlb.resp.bits.excp.af.st ||
121        io.dtlb.resp.bits.excp.af.ld
122      is_mmio := io.dtlb.resp.bits.mmio
123      when (exception) {
124        // check for exceptions
125        // if there are exceptions, no need to execute it
126        state := s_finish
127        atom_override_xtval := true.B
128      } .otherwise {
129        paddr := io.dtlb.resp.bits.paddr
130        state := s_flush_sbuffer_req
131      }
132    }
133  }
134
135
136  when (state === s_flush_sbuffer_req) {
137    io.flush_sbuffer.valid := true.B
138    state := s_flush_sbuffer_resp
139  }
140
141  when (state === s_flush_sbuffer_resp) {
142    when (io.flush_sbuffer.empty) {
143      state := s_cache_req
144    }
145  }
146
147  when (state === s_cache_req) {
148    io.dcache.req.valid := true.B
149    io.dcache.req.bits.cmd := LookupTree(in.uop.ctrl.fuOpType, List(
150      LSUOpType.lr_w      -> M_XLR,
151      LSUOpType.sc_w      -> M_XSC,
152      LSUOpType.amoswap_w -> M_XA_SWAP,
153      LSUOpType.amoadd_w  -> M_XA_ADD,
154      LSUOpType.amoxor_w  -> M_XA_XOR,
155      LSUOpType.amoand_w  -> M_XA_AND,
156      LSUOpType.amoor_w   -> M_XA_OR,
157      LSUOpType.amomin_w  -> M_XA_MIN,
158      LSUOpType.amomax_w  -> M_XA_MAX,
159      LSUOpType.amominu_w -> M_XA_MINU,
160      LSUOpType.amomaxu_w -> M_XA_MAXU,
161
162      LSUOpType.lr_d      -> M_XLR,
163      LSUOpType.sc_d      -> M_XSC,
164      LSUOpType.amoswap_d -> M_XA_SWAP,
165      LSUOpType.amoadd_d  -> M_XA_ADD,
166      LSUOpType.amoxor_d  -> M_XA_XOR,
167      LSUOpType.amoand_d  -> M_XA_AND,
168      LSUOpType.amoor_d   -> M_XA_OR,
169      LSUOpType.amomin_d  -> M_XA_MIN,
170      LSUOpType.amomax_d  -> M_XA_MAX,
171      LSUOpType.amominu_d -> M_XA_MINU,
172      LSUOpType.amomaxu_d -> M_XA_MAXU
173    ))
174
175    io.dcache.req.bits.addr := paddr
176    io.dcache.req.bits.data := genWdata(in.src2, in.uop.ctrl.fuOpType(1,0))
177    // TODO: atomics do need mask: fix mask
178    io.dcache.req.bits.mask := genWmask(paddr, in.uop.ctrl.fuOpType(1,0))
179    io.dcache.req.bits.id   := DontCare
180
181    when(io.dcache.req.fire()){
182      state := s_cache_resp
183      paddr_reg := io.dcache.req.bits.addr
184      data_reg := io.dcache.req.bits.data
185      mask_reg := io.dcache.req.bits.mask
186      fuop_reg := in.uop.ctrl.fuOpType
187    }
188  }
189
190  when (state === s_cache_resp) {
191    io.dcache.resp.ready := true.B
192    when(io.dcache.resp.fire()) {
193      is_lrsc_valid := io.dcache.resp.bits.id
194      val rdata = io.dcache.resp.bits.data
195      val rdataSel = LookupTree(paddr(2, 0), List(
196        "b000".U -> rdata(63, 0),
197        "b001".U -> rdata(63, 8),
198        "b010".U -> rdata(63, 16),
199        "b011".U -> rdata(63, 24),
200        "b100".U -> rdata(63, 32),
201        "b101".U -> rdata(63, 40),
202        "b110".U -> rdata(63, 48),
203        "b111".U -> rdata(63, 56)
204      ))
205
206      resp_data_wire := LookupTree(in.uop.ctrl.fuOpType, List(
207        LSUOpType.lr_w      -> SignExt(rdataSel(31, 0), XLEN),
208        LSUOpType.sc_w      -> rdata,
209        LSUOpType.amoswap_w -> SignExt(rdataSel(31, 0), XLEN),
210        LSUOpType.amoadd_w  -> SignExt(rdataSel(31, 0), XLEN),
211        LSUOpType.amoxor_w  -> SignExt(rdataSel(31, 0), XLEN),
212        LSUOpType.amoand_w  -> SignExt(rdataSel(31, 0), XLEN),
213        LSUOpType.amoor_w   -> SignExt(rdataSel(31, 0), XLEN),
214        LSUOpType.amomin_w  -> SignExt(rdataSel(31, 0), XLEN),
215        LSUOpType.amomax_w  -> SignExt(rdataSel(31, 0), XLEN),
216        LSUOpType.amominu_w -> SignExt(rdataSel(31, 0), XLEN),
217        LSUOpType.amomaxu_w -> SignExt(rdataSel(31, 0), XLEN),
218
219        LSUOpType.lr_d      -> SignExt(rdataSel(63, 0), XLEN),
220        LSUOpType.sc_d      -> rdata,
221        LSUOpType.amoswap_d -> SignExt(rdataSel(63, 0), XLEN),
222        LSUOpType.amoadd_d  -> SignExt(rdataSel(63, 0), XLEN),
223        LSUOpType.amoxor_d  -> SignExt(rdataSel(63, 0), XLEN),
224        LSUOpType.amoand_d  -> SignExt(rdataSel(63, 0), XLEN),
225        LSUOpType.amoor_d   -> SignExt(rdataSel(63, 0), XLEN),
226        LSUOpType.amomin_d  -> SignExt(rdataSel(63, 0), XLEN),
227        LSUOpType.amomax_d  -> SignExt(rdataSel(63, 0), XLEN),
228        LSUOpType.amominu_d -> SignExt(rdataSel(63, 0), XLEN),
229        LSUOpType.amomaxu_d -> SignExt(rdataSel(63, 0), XLEN)
230      ))
231
232      resp_data := resp_data_wire
233      state := s_finish
234    }
235  }
236
237  when (state === s_finish) {
238    io.out.valid := true.B
239    io.out.bits.uop := in.uop
240    io.out.bits.uop.cf.exceptionVec := exceptionVec
241    io.out.bits.uop.diffTestDebugLrScValid := is_lrsc_valid
242    io.out.bits.data := resp_data
243    io.out.bits.redirectValid := false.B
244    io.out.bits.redirect := DontCare
245    io.out.bits.debug.isMMIO := is_mmio
246    io.out.bits.debug.paddr := paddr
247    when (io.out.fire()) {
248      XSDebug("atomics writeback: pc %x data %x\n", io.out.bits.uop.cf.pc, io.dcache.resp.bits.data)
249      state := s_invalid
250    }
251  }
252
253  when(io.redirect.valid || io.flush){
254    atom_override_xtval := false.B
255  }
256
257  if (!env.FPGAPlatform) {
258    difftestIO.atomicResp := WireInit(io.dcache.resp.fire())
259    difftestIO.atomicAddr := WireInit(paddr_reg)
260    difftestIO.atomicData := WireInit(data_reg)
261    difftestIO.atomicMask := WireInit(mask_reg)
262    difftestIO.atomicFuop := WireInit(fuop_reg)
263    difftestIO.atomicOut  := resp_data_wire
264  }
265}
266