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