Add debug_module bus device.
[riscv-isa-sim.git] / riscv / processor.cc
1 // See LICENSE for license details.
2
3 #include "processor.h"
4 #include "extension.h"
5 #include "common.h"
6 #include "config.h"
7 #include "sim.h"
8 #include "mmu.h"
9 #include "htif.h"
10 #include "disasm.h"
11 #include "gdbserver.h"
12 #include <cinttypes>
13 #include <cmath>
14 #include <cstdlib>
15 #include <iostream>
16 #include <assert.h>
17 #include <limits.h>
18 #include <stdexcept>
19 #include <algorithm>
20
21 #undef STATE
22 #define STATE state
23
24 processor_t::processor_t(const char* isa, sim_t* sim, uint32_t id)
25 : sim(sim), ext(NULL), disassembler(new disassembler_t),
26 id(id), run(false), debug(false)
27 {
28 parse_isa_string(isa);
29
30 mmu = new mmu_t(sim, this);
31
32 reset(true);
33
34 register_base_instructions();
35 }
36
37 processor_t::~processor_t()
38 {
39 #ifdef RISCV_ENABLE_HISTOGRAM
40 if (histogram_enabled)
41 {
42 fprintf(stderr, "PC Histogram size:%zu\n", pc_histogram.size());
43 for (auto it : pc_histogram)
44 fprintf(stderr, "%0" PRIx64 " %" PRIu64 "\n", it.first, it.second);
45 }
46 #endif
47
48 delete mmu;
49 delete disassembler;
50 }
51
52 static void bad_isa_string(const char* isa)
53 {
54 fprintf(stderr, "error: bad --isa option %s\n", isa);
55 abort();
56 }
57
58 void processor_t::parse_isa_string(const char* str)
59 {
60 std::string lowercase, tmp;
61 for (const char *r = str; *r; r++)
62 lowercase += std::tolower(*r);
63
64 const char* p = lowercase.c_str();
65 const char* all_subsets = "imafdc";
66
67 max_xlen = 64;
68 isa = reg_t(2) << 62;
69
70 if (strncmp(p, "rv32", 4) == 0)
71 max_xlen = 32, isa = reg_t(1) << 30, p += 4;
72 else if (strncmp(p, "rv64", 4) == 0)
73 p += 4;
74 else if (strncmp(p, "rv", 2) == 0)
75 p += 2;
76
77 if (!*p) {
78 p = all_subsets;
79 } else if (*p == 'g') { // treat "G" as "IMAFD"
80 tmp = std::string("imafd") + (p+1);
81 p = &tmp[0];
82 } else if (*p != 'i') {
83 bad_isa_string(str);
84 }
85
86 isa_string = "rv" + std::to_string(max_xlen) + p;
87 isa |= 1L << ('s' - 'a'); // advertise support for supervisor mode
88
89 while (*p) {
90 isa |= 1L << (*p - 'a');
91
92 if (auto next = strchr(all_subsets, *p)) {
93 all_subsets = next + 1;
94 p++;
95 } else if (*p == 'x') {
96 const char* ext = p+1, *end = ext;
97 while (islower(*end))
98 end++;
99 register_extension(find_extension(std::string(ext, end - ext).c_str())());
100 p = end;
101 } else {
102 bad_isa_string(str);
103 }
104 }
105
106 if (supports_extension('D') && !supports_extension('F'))
107 bad_isa_string(str);
108
109 // advertise support for supervisor and user modes
110 isa |= 1L << ('s' - 'a');
111 isa |= 1L << ('u' - 'a');
112 }
113
114 void state_t::reset()
115 {
116 memset(this, 0, sizeof(*this));
117 prv = PRV_M;
118 pc = DEFAULT_RSTVEC;
119 mtvec = DEFAULT_MTVEC;
120 load_reservation = -1;
121 }
122
123 void processor_t::set_debug(bool value)
124 {
125 debug = value;
126 if (ext)
127 ext->set_debug(value);
128 }
129
130 void processor_t::set_histogram(bool value)
131 {
132 histogram_enabled = value;
133 #ifndef RISCV_ENABLE_HISTOGRAM
134 if (value) {
135 fprintf(stderr, "PC Histogram support has not been properly enabled;");
136 fprintf(stderr, " please re-build the riscv-isa-run project using \"configure --enable-histogram\".\n");
137 }
138 #endif
139 }
140
141 void processor_t::reset(bool value)
142 {
143 if (run == !value)
144 return;
145 run = !value;
146
147 state.reset();
148 set_csr(CSR_MSTATUS, state.mstatus);
149
150 if (ext)
151 ext->reset(); // reset the extension
152 }
153
154 void processor_t::raise_interrupt(reg_t which)
155 {
156 throw trap_t(((reg_t)1 << (max_xlen-1)) | which);
157 }
158
159 static int ctz(reg_t val)
160 {
161 int res = 0;
162 if (val)
163 while ((val & 1) == 0)
164 val >>= 1, res++;
165 return res;
166 }
167
168 void processor_t::take_interrupt()
169 {
170 reg_t pending_interrupts = state.mip & state.mie;
171
172 reg_t mie = get_field(state.mstatus, MSTATUS_MIE);
173 reg_t m_enabled = state.prv < PRV_M || (state.prv == PRV_M && mie);
174 reg_t enabled_interrupts = pending_interrupts & ~state.mideleg & -m_enabled;
175
176 reg_t sie = get_field(state.mstatus, MSTATUS_SIE);
177 reg_t s_enabled = state.prv < PRV_S || (state.prv == PRV_S && sie);
178 enabled_interrupts |= pending_interrupts & state.mideleg & -s_enabled;
179
180 if (enabled_interrupts)
181 raise_interrupt(ctz(enabled_interrupts));
182 }
183
184 static bool validate_priv(reg_t priv)
185 {
186 return priv == PRV_U || priv == PRV_S || priv == PRV_M;
187 }
188
189 void processor_t::set_privilege(reg_t prv)
190 {
191 assert(validate_priv(prv));
192 mmu->flush_tlb();
193 state.prv = prv;
194 }
195
196 void processor_t::enter_debug_mode(uint8_t cause)
197 {
198 fprintf(stderr, "enter_debug_mode(%d)\n", cause);
199 state.dcsr.cause = cause;
200 state.dcsr.prv = state.prv;
201 state.prv = PRV_M;
202 state.dpc = state.pc;
203 state.pc = DEBUG_ROM_START;
204 debug = true; // TODO
205 }
206
207 void processor_t::take_trap(trap_t& t, reg_t epc)
208 {
209 if (debug)
210 fprintf(stderr, "core %3d: exception %s, epc 0x%016" PRIx64 "\n",
211 id, t.name(), epc);
212
213 if (t.cause() == CAUSE_BREAKPOINT &&
214 sim->gdbserver && sim->gdbserver->connected()) {
215 enter_debug_mode(DCSR_CAUSE_SWBP);
216 return;
217 }
218
219 // by default, trap to M-mode, unless delegated to S-mode
220 reg_t bit = t.cause();
221 reg_t deleg = state.medeleg;
222 if (bit & ((reg_t)1 << (max_xlen-1)))
223 deleg = state.mideleg, bit &= ~((reg_t)1 << (max_xlen-1));
224 if (state.prv <= PRV_S && bit < max_xlen && ((deleg >> bit) & 1)) {
225 // handle the trap in S-mode
226 state.pc = state.stvec;
227 state.scause = t.cause();
228 state.sepc = epc;
229 if (t.has_badaddr())
230 state.sbadaddr = t.get_badaddr();
231
232 reg_t s = state.mstatus;
233 s = set_field(s, MSTATUS_SPIE, get_field(s, MSTATUS_UIE << state.prv));
234 s = set_field(s, MSTATUS_SPP, state.prv);
235 s = set_field(s, MSTATUS_SIE, 0);
236 set_csr(CSR_MSTATUS, s);
237 set_privilege(PRV_S);
238 } else {
239 state.pc = state.mtvec;
240 state.mcause = t.cause();
241 state.mepc = epc;
242 if (t.has_badaddr())
243 state.mbadaddr = t.get_badaddr();
244
245 reg_t s = state.mstatus;
246 s = set_field(s, MSTATUS_MPIE, get_field(s, MSTATUS_UIE << state.prv));
247 s = set_field(s, MSTATUS_MPP, state.prv);
248 s = set_field(s, MSTATUS_MIE, 0);
249 set_csr(CSR_MSTATUS, s);
250 set_privilege(PRV_M);
251 }
252
253 yield_load_reservation();
254 }
255
256 void processor_t::disasm(insn_t insn)
257 {
258 uint64_t bits = insn.bits() & ((1ULL << (8 * insn_length(insn.bits()))) - 1);
259 fprintf(stderr, "core %3d: 0x%016" PRIx64 " (0x%08" PRIx64 ") %s\n",
260 id, state.pc, bits, disassembler->disassemble(insn).c_str());
261 }
262
263 static bool validate_vm(int max_xlen, reg_t vm)
264 {
265 if (max_xlen == 64 && (vm == VM_SV39 || vm == VM_SV48))
266 return true;
267 if (max_xlen == 32 && vm == VM_SV32)
268 return true;
269 return vm == VM_MBARE;
270 }
271
272 void processor_t::set_csr(int which, reg_t val)
273 {
274 val = zext_xlen(val);
275 reg_t delegable_ints = MIP_SSIP | MIP_STIP | MIP_SEIP | (1 << IRQ_COP);
276 reg_t all_ints = delegable_ints | MIP_MSIP | MIP_MTIP;
277 switch (which)
278 {
279 case CSR_FFLAGS:
280 dirty_fp_state;
281 state.fflags = val & (FSR_AEXC >> FSR_AEXC_SHIFT);
282 break;
283 case CSR_FRM:
284 dirty_fp_state;
285 state.frm = val & (FSR_RD >> FSR_RD_SHIFT);
286 break;
287 case CSR_FCSR:
288 dirty_fp_state;
289 state.fflags = (val & FSR_AEXC) >> FSR_AEXC_SHIFT;
290 state.frm = (val & FSR_RD) >> FSR_RD_SHIFT;
291 break;
292 case CSR_MSTATUS: {
293 if ((val ^ state.mstatus) &
294 (MSTATUS_VM | MSTATUS_MPP | MSTATUS_MPRV | MSTATUS_PUM))
295 mmu->flush_tlb();
296
297 reg_t mask = MSTATUS_SIE | MSTATUS_SPIE | MSTATUS_MIE | MSTATUS_MPIE
298 | MSTATUS_SPP | MSTATUS_FS | MSTATUS_MPRV | MSTATUS_PUM
299 | (ext ? MSTATUS_XS : 0);
300
301 if (validate_vm(max_xlen, get_field(val, MSTATUS_VM)))
302 mask |= MSTATUS_VM;
303 if (validate_priv(get_field(val, MSTATUS_MPP)))
304 mask |= MSTATUS_MPP;
305
306 state.mstatus = (state.mstatus & ~mask) | (val & mask);
307
308 bool dirty = (state.mstatus & MSTATUS_FS) == MSTATUS_FS;
309 dirty |= (state.mstatus & MSTATUS_XS) == MSTATUS_XS;
310 if (max_xlen == 32)
311 state.mstatus = set_field(state.mstatus, MSTATUS32_SD, dirty);
312 else
313 state.mstatus = set_field(state.mstatus, MSTATUS64_SD, dirty);
314
315 // spike supports the notion of xlen < max_xlen, but current priv spec
316 // doesn't provide a mechanism to run RV32 software on an RV64 machine
317 xlen = max_xlen;
318 break;
319 }
320 case CSR_MIP: {
321 reg_t mask = MIP_SSIP | MIP_STIP;
322 state.mip = (state.mip & ~mask) | (val & mask);
323 break;
324 }
325 case CSR_MIE:
326 state.mie = (state.mie & ~all_ints) | (val & all_ints);
327 break;
328 case CSR_MIDELEG:
329 state.mideleg = (state.mideleg & ~delegable_ints) | (val & delegable_ints);
330 break;
331 case CSR_MEDELEG: {
332 reg_t mask = 0;
333 #define DECLARE_CAUSE(name, value) mask |= 1ULL << (value);
334 #include "encoding.h"
335 #undef DECLARE_CAUSE
336 state.medeleg = (state.medeleg & ~mask) | (val & mask);
337 break;
338 }
339 case CSR_MUCOUNTEREN:
340 state.mucounteren = val & 7;
341 break;
342 case CSR_MSCOUNTEREN:
343 state.mscounteren = val & 7;
344 break;
345 case CSR_SSTATUS: {
346 reg_t mask = SSTATUS_SIE | SSTATUS_SPIE | SSTATUS_SPP | SSTATUS_FS
347 | SSTATUS_XS | SSTATUS_PUM;
348 return set_csr(CSR_MSTATUS, (state.mstatus & ~mask) | (val & mask));
349 }
350 case CSR_SIP:
351 return set_csr(CSR_MIP,
352 (state.mip & ~state.mideleg) | (val & state.mideleg));
353 case CSR_SIE:
354 return set_csr(CSR_MIE,
355 (state.mie & ~state.mideleg) | (val & state.mideleg));
356 case CSR_SEPC: state.sepc = val; break;
357 case CSR_STVEC: state.stvec = val >> 2 << 2; break;
358 case CSR_SPTBR: state.sptbr = val; break;
359 case CSR_SSCRATCH: state.sscratch = val; break;
360 case CSR_SCAUSE: state.scause = val; break;
361 case CSR_SBADADDR: state.sbadaddr = val; break;
362 case CSR_MEPC: state.mepc = val; break;
363 case CSR_MTVEC: state.mtvec = val >> 2 << 2; break;
364 case CSR_MSCRATCH: state.mscratch = val; break;
365 case CSR_MCAUSE: state.mcause = val; break;
366 case CSR_MBADADDR: state.mbadaddr = val; break;
367 case DCSR_ADDRESS:
368 // TODO: Use get_field style
369 state.dcsr.prv = (val & DCSR_PRV_MASK) >> DCSR_PRV_OFFSET;
370 state.dcsr.step = (val & DCSR_STEP_MASK) >> DCSR_STEP_OFFSET;
371 // TODO: ndreset and fullreset
372 state.dcsr.ebreakm = (val & DCSR_EBREAKM_MASK) >> DCSR_EBREAKM_OFFSET;
373 state.dcsr.ebreakh = (val & DCSR_EBREAKH_MASK) >> DCSR_EBREAKH_OFFSET;
374 state.dcsr.ebreaks = (val & DCSR_EBREAKS_MASK) >> DCSR_EBREAKS_OFFSET;
375 state.dcsr.ebreaku = (val & DCSR_EBREAKU_MASK) >> DCSR_EBREAKU_OFFSET;
376 state.dcsr.halt = (val & DCSR_HALT_MASK) >> DCSR_HALT_OFFSET;
377 break;
378 case DPC_ADDRESS:
379 state.dpc = val;
380 break;
381 case DSCRATCH_ADDRESS:
382 state.dscratch = val;
383 break;
384 }
385 }
386
387 reg_t processor_t::get_csr(int which)
388 {
389 switch (which)
390 {
391 case CSR_FFLAGS:
392 require_fp;
393 if (!supports_extension('F'))
394 break;
395 return state.fflags;
396 case CSR_FRM:
397 require_fp;
398 if (!supports_extension('F'))
399 break;
400 return state.frm;
401 case CSR_FCSR:
402 require_fp;
403 if (!supports_extension('F'))
404 break;
405 return (state.fflags << FSR_AEXC_SHIFT) | (state.frm << FSR_RD_SHIFT);
406 case CSR_TIME:
407 case CSR_INSTRET:
408 case CSR_CYCLE:
409 if ((state.mucounteren >> (which & (xlen-1))) & 1)
410 return get_csr(which + (CSR_MCYCLE - CSR_CYCLE));
411 break;
412 case CSR_STIME:
413 case CSR_SINSTRET:
414 case CSR_SCYCLE:
415 if ((state.mscounteren >> (which & (xlen-1))) & 1)
416 return get_csr(which + (CSR_MCYCLE - CSR_SCYCLE));
417 break;
418 case CSR_MUCOUNTEREN: return state.mucounteren;
419 case CSR_MSCOUNTEREN: return state.mscounteren;
420 case CSR_MUCYCLE_DELTA: return 0;
421 case CSR_MUTIME_DELTA: return 0;
422 case CSR_MUINSTRET_DELTA: return 0;
423 case CSR_MSCYCLE_DELTA: return 0;
424 case CSR_MSTIME_DELTA: return 0;
425 case CSR_MSINSTRET_DELTA: return 0;
426 case CSR_MUCYCLE_DELTAH: if (xlen > 32) break; else return 0;
427 case CSR_MUTIME_DELTAH: if (xlen > 32) break; else return 0;
428 case CSR_MUINSTRET_DELTAH: if (xlen > 32) break; else return 0;
429 case CSR_MSCYCLE_DELTAH: if (xlen > 32) break; else return 0;
430 case CSR_MSTIME_DELTAH: if (xlen > 32) break; else return 0;
431 case CSR_MSINSTRET_DELTAH: if (xlen > 32) break; else return 0;
432 case CSR_MCYCLE: return state.minstret;
433 case CSR_MINSTRET: return state.minstret;
434 case CSR_MCYCLEH: if (xlen > 32) break; else return state.minstret >> 32;
435 case CSR_MINSTRETH: if (xlen > 32) break; else return state.minstret >> 32;
436 case CSR_SSTATUS: {
437 reg_t mask = SSTATUS_SIE | SSTATUS_SPIE | SSTATUS_SPP | SSTATUS_FS
438 | SSTATUS_XS | SSTATUS_PUM;
439 reg_t sstatus = state.mstatus & mask;
440 if ((sstatus & SSTATUS_FS) == SSTATUS_FS ||
441 (sstatus & SSTATUS_XS) == SSTATUS_XS)
442 sstatus |= (xlen == 32 ? SSTATUS32_SD : SSTATUS64_SD);
443 return sstatus;
444 }
445 case CSR_SIP: return state.mip & state.mideleg;
446 case CSR_SIE: return state.mie & state.mideleg;
447 case CSR_SEPC: return state.sepc;
448 case CSR_SBADADDR: return state.sbadaddr;
449 case CSR_STVEC: return state.stvec;
450 case CSR_SCAUSE:
451 if (max_xlen > xlen)
452 return state.scause | ((state.scause >> (max_xlen-1)) << (xlen-1));
453 return state.scause;
454 case CSR_SPTBR: return state.sptbr;
455 case CSR_SASID: return 0;
456 case CSR_SSCRATCH: return state.sscratch;
457 case CSR_MSTATUS: return state.mstatus;
458 case CSR_MIP: return state.mip;
459 case CSR_MIE: return state.mie;
460 case CSR_MEPC: return state.mepc;
461 case CSR_MSCRATCH: return state.mscratch;
462 case CSR_MCAUSE: return state.mcause;
463 case CSR_MBADADDR: return state.mbadaddr;
464 case CSR_MISA: return isa;
465 case CSR_MARCHID: return 0;
466 case CSR_MIMPID: return 0;
467 case CSR_MVENDORID: return 0;
468 case CSR_MHARTID: return id;
469 case CSR_MTVEC: return state.mtvec;
470 case CSR_MEDELEG: return state.medeleg;
471 case CSR_MIDELEG: return state.mideleg;
472 case DCSR_ADDRESS:
473 return
474 (1 << DCSR_XDEBUGVER_OFFSET) |
475 (0 << DCSR_HWBPCOUNT_OFFSET) |
476 (0 << DCSR_NDRESET_OFFSET) |
477 (0 << DCSR_FULLRESET_OFFSET) |
478 (state.dcsr.prv << DCSR_PRV_OFFSET) |
479 (state.dcsr.step << DCSR_STEP_OFFSET) |
480 (sim->debug_module.get_interrupt(id) << DCSR_DEBUGINT_OFFSET) |
481 (0 << DCSR_STOPCYCLE_OFFSET) |
482 (0 << DCSR_STOPTIME_OFFSET) |
483 (state.dcsr.ebreakm << DCSR_EBREAKM_OFFSET) |
484 (state.dcsr.ebreakh << DCSR_EBREAKH_OFFSET) |
485 (state.dcsr.ebreaks << DCSR_EBREAKS_OFFSET) |
486 (state.dcsr.ebreaku << DCSR_EBREAKU_OFFSET) |
487 (state.dcsr.halt << DCSR_HALT_OFFSET) |
488 (state.dcsr.cause << DCSR_CAUSE_OFFSET);
489 case DPC_ADDRESS:
490 return state.dpc;
491 case DSCRATCH_ADDRESS:
492 return state.dscratch;
493 }
494 throw trap_illegal_instruction();
495 }
496
497 reg_t illegal_instruction(processor_t* p, insn_t insn, reg_t pc)
498 {
499 throw trap_illegal_instruction();
500 }
501
502 insn_func_t processor_t::decode_insn(insn_t insn)
503 {
504 // look up opcode in hash table
505 size_t idx = insn.bits() % OPCODE_CACHE_SIZE;
506 insn_desc_t desc = opcode_cache[idx];
507
508 if (unlikely(insn.bits() != desc.match)) {
509 // fall back to linear search
510 insn_desc_t* p = &instructions[0];
511 while ((insn.bits() & p->mask) != p->match)
512 p++;
513 desc = *p;
514
515 if (p->mask != 0 && p > &instructions[0]) {
516 if (p->match != (p-1)->match && p->match != (p+1)->match) {
517 // move to front of opcode list to reduce miss penalty
518 while (--p >= &instructions[0])
519 *(p+1) = *p;
520 instructions[0] = desc;
521 }
522 }
523
524 opcode_cache[idx] = desc;
525 opcode_cache[idx].match = insn.bits();
526 }
527
528 return xlen == 64 ? desc.rv64 : desc.rv32;
529 }
530
531 void processor_t::register_insn(insn_desc_t desc)
532 {
533 instructions.push_back(desc);
534 }
535
536 void processor_t::build_opcode_map()
537 {
538 struct cmp {
539 bool operator()(const insn_desc_t& lhs, const insn_desc_t& rhs) {
540 if (lhs.match == rhs.match)
541 return lhs.mask > rhs.mask;
542 return lhs.match > rhs.match;
543 }
544 };
545 std::sort(instructions.begin(), instructions.end(), cmp());
546
547 for (size_t i = 0; i < OPCODE_CACHE_SIZE; i++)
548 opcode_cache[i] = {1, 0, &illegal_instruction, &illegal_instruction};
549 }
550
551 void processor_t::register_extension(extension_t* x)
552 {
553 for (auto insn : x->get_instructions())
554 register_insn(insn);
555 build_opcode_map();
556 for (auto disasm_insn : x->get_disasms())
557 disassembler->add_insn(disasm_insn);
558 if (ext != NULL)
559 throw std::logic_error("only one extension may be registered");
560 ext = x;
561 x->set_processor(this);
562 }
563
564 void processor_t::register_base_instructions()
565 {
566 #define DECLARE_INSN(name, match, mask) \
567 insn_bits_t name##_match = (match), name##_mask = (mask);
568 #include "encoding.h"
569 #undef DECLARE_INSN
570
571 #define DEFINE_INSN(name) \
572 REGISTER_INSN(this, name, name##_match, name##_mask)
573 #include "insn_list.h"
574 #undef DEFINE_INSN
575
576 register_insn({0, 0, &illegal_instruction, &illegal_instruction});
577 build_opcode_map();
578 }
579
580 bool processor_t::load(reg_t addr, size_t len, uint8_t* bytes)
581 {
582 return false;
583 }
584
585 bool processor_t::store(reg_t addr, size_t len, const uint8_t* bytes)
586 {
587 switch (addr)
588 {
589 case 0:
590 state.mip &= ~MIP_MSIP;
591 if (bytes[0] & 1)
592 state.mip |= MIP_MSIP;
593 return true;
594
595 default:
596 return false;
597 }
598 }