1 // See LICENSE for license details.
2 #ifndef _RISCV_PROCESSOR_H
3 #define _RISCV_PROCESSOR_H
12 #include "debug_rom/debug_rom_defines.h"
16 typedef reg_t (*insn_func_t
)(processor_t
*, insn_t
, reg_t
);
30 struct commit_log_reg_t
50 ACTION_DEBUG_EXCEPTION
= MCONTROL_ACTION_DEBUG_EXCEPTION
,
51 ACTION_DEBUG_MODE
= MCONTROL_ACTION_DEBUG_MODE
,
52 ACTION_TRACE_START
= MCONTROL_ACTION_TRACE_START
,
53 ACTION_TRACE_STOP
= MCONTROL_ACTION_TRACE_STOP
,
54 ACTION_TRACE_EMIT
= MCONTROL_ACTION_TRACE_EMIT
59 MATCH_EQUAL
= MCONTROL_MATCH_EQUAL
,
60 MATCH_NAPOT
= MCONTROL_MATCH_NAPOT
,
61 MATCH_GE
= MCONTROL_MATCH_GE
,
62 MATCH_LT
= MCONTROL_MATCH_LT
,
63 MATCH_MASK_LOW
= MCONTROL_MATCH_MASK_LOW
,
64 MATCH_MASK_HIGH
= MCONTROL_MATCH_MASK_HIGH
74 mcontrol_action_t action
;
76 mcontrol_match_t match
;
86 // architectural state of a RISC-V hart
91 static const int num_triggers
= 4;
94 regfile_t
<reg_t
, NXPR
, true> XPR
;
95 regfile_t
<freg_t
, NFPR
, false> FPR
;
97 // control and status registers
98 reg_t prv
; // TODO: Can this be an enum instead?
122 mcontrol_t mcontrol
[num_triggers
];
123 reg_t tdata2
[num_triggers
];
127 bool serialized
; // whether timer CSRs are in a well-defined state
129 // When true, execute a single instruction and then enter debug mode. This
130 // can only be set by executing dret.
137 reg_t load_reservation
;
139 #ifdef RISCV_ENABLE_COMMITLOG
140 commit_log_reg_t log_reg_write
;
141 reg_t last_inst_priv
;
151 } trigger_operation_t
;
153 // Count number of contiguous 1 bits starting from the LSB.
154 static int cto(reg_t val
)
157 while ((val
& 1) == 1)
162 // this class represents one processor in a RISC-V machine.
163 class processor_t
: public abstract_device_t
166 processor_t(const char* isa
, sim_t
* sim
, uint32_t id
, bool halt_on_reset
=false);
169 void set_debug(bool value
);
170 void set_histogram(bool value
);
172 void step(size_t n
); // run for n cycles
173 void set_csr(int which
, reg_t val
);
174 reg_t
get_csr(int which
);
175 mmu_t
* get_mmu() { return mmu
; }
176 state_t
* get_state() { return &state
; }
177 unsigned get_xlen() { return xlen
; }
178 unsigned get_flen() {
179 return supports_extension('Q') ? 128 :
180 supports_extension('D') ? 64 :
181 supports_extension('F') ? 32 : 0;
183 extension_t
* get_extension() { return ext
; }
184 bool supports_extension(unsigned char ext
) {
185 if (ext
>= 'a' && ext
<= 'z') ext
+= 'A' - 'a';
186 return ext
>= 'A' && ext
<= 'Z' && ((isa
>> (ext
- 'A')) & 1);
188 void check_pc_alignment(reg_t pc
) {
189 if (unlikely(pc
& 2) && !supports_extension('C'))
190 throw trap_instruction_address_misaligned(pc
);
192 reg_t
legalize_privilege(reg_t
);
193 void set_privilege(reg_t
);
194 void yield_load_reservation() { state
.load_reservation
= (reg_t
)-1; }
195 void update_histogram(reg_t pc
);
196 const disassembler_t
* get_disassembler() { return disassembler
; }
198 void register_insn(insn_desc_t
);
199 void register_extension(extension_t
*);
201 // MMIO slave interface
202 bool load(reg_t addr
, size_t len
, uint8_t* bytes
);
203 bool store(reg_t addr
, size_t len
, const uint8_t* bytes
);
205 // When true, display disassembly of each instruction that's executed.
207 // When true, take the slow simulation path.
209 bool halted() { return state
.dcsr
.cause
? true : false; }
212 // Return the index of a trigger that matched, or -1.
213 inline int trigger_match(trigger_operation_t operation
, reg_t address
, reg_t data
)
215 if (state
.dcsr
.cause
)
218 bool chain_ok
= true;
220 for (unsigned int i
= 0; i
< state
.num_triggers
; i
++) {
222 chain_ok
|= !state
.mcontrol
[i
].chain
;
226 if ((operation
== OPERATION_EXECUTE
&& !state
.mcontrol
[i
].execute
) ||
227 (operation
== OPERATION_STORE
&& !state
.mcontrol
[i
].store
) ||
228 (operation
== OPERATION_LOAD
&& !state
.mcontrol
[i
].load
) ||
229 (state
.prv
== PRV_M
&& !state
.mcontrol
[i
].m
) ||
230 (state
.prv
== PRV_S
&& !state
.mcontrol
[i
].s
) ||
231 (state
.prv
== PRV_U
&& !state
.mcontrol
[i
].u
)) {
236 if (state
.mcontrol
[i
].select
) {
242 // We need this because in 32-bit mode sometimes the PC bits get sign
248 switch (state
.mcontrol
[i
].match
) {
250 if (value
!= state
.tdata2
[i
])
255 reg_t mask
= ~((1 << cto(state
.tdata2
[i
])) - 1);
256 if ((value
& mask
) != (state
.tdata2
[i
] & mask
))
261 if (value
< state
.tdata2
[i
])
265 if (value
>= state
.tdata2
[i
])
270 reg_t mask
= state
.tdata2
[i
] >> (xlen
/2);
271 if ((value
& mask
) != (state
.tdata2
[i
] & mask
))
275 case MATCH_MASK_HIGH
:
277 reg_t mask
= state
.tdata2
[i
] >> (xlen
/2);
278 if (((value
>> (xlen
/2)) & mask
) != (state
.tdata2
[i
] & mask
))
284 if (!state
.mcontrol
[i
].chain
) {
292 void trigger_updated();
296 mmu_t
* mmu
; // main memory is always accessed via the mmu
298 disassembler_t
* disassembler
;
305 std::string isa_string
;
306 bool histogram_enabled
;
309 std::vector
<insn_desc_t
> instructions
;
310 std::map
<reg_t
,uint64_t> pc_histogram
;
312 static const size_t OPCODE_CACHE_SIZE
= 8191;
313 insn_desc_t opcode_cache
[OPCODE_CACHE_SIZE
];
315 void take_pending_interrupt() { take_interrupt(state
.mip
& state
.mie
); }
316 void take_interrupt(reg_t mask
); // take first enabled interrupt in mask
317 void take_trap(trap_t
& t
, reg_t epc
); // take an exception
318 void disasm(insn_t insn
); // disassemble and print an instruction
321 void enter_debug_mode(uint8_t cause
);
325 friend class clint_t
;
326 friend class extension_t
;
328 void parse_isa_string(const char* isa
);
329 void build_opcode_map();
330 void register_base_instructions();
331 insn_func_t
decode_insn(insn_t insn
);
333 // Track repeated executions for processor_t::disasm()
334 uint64_t last_pc
, last_bits
, executions
;
337 reg_t
illegal_instruction(processor_t
* p
, insn_t insn
, reg_t pc
);
339 #define REGISTER_INSN(proc, name, match, mask) \
340 extern reg_t rv32_##name(processor_t*, insn_t, reg_t); \
341 extern reg_t rv64_##name(processor_t*, insn_t, reg_t); \
342 proc->register_insn((insn_desc_t){match, mask, rv32_##name, rv64_##name});