Merge branch 'tm'
[riscv-isa-sim.git] / riscv / processor.h
1 // See LICENSE for license details.
2 #ifndef _RISCV_PROCESSOR_H
3 #define _RISCV_PROCESSOR_H
4
5 #include "decode.h"
6 #include "config.h"
7 #include <cstring>
8 #include <vector>
9
10 class processor_t;
11 class mmu_t;
12 typedef reg_t (*insn_func_t)(processor_t*, insn_t, reg_t);
13 class sim_t;
14 class trap_t;
15 class extension_t;
16 class disassembler_t;
17
18 struct insn_desc_t
19 {
20 uint32_t match;
21 uint32_t mask;
22 insn_func_t rv32;
23 insn_func_t rv64;
24 };
25
26 // architectural state of a RISC-V hart
27 struct state_t
28 {
29 void reset();
30
31 reg_t pc;
32 regfile_t<reg_t, NXPR, true> XPR;
33 regfile_t<freg_t, NFPR, false> FPR;
34
35 // control and status registers
36 reg_t epc;
37 reg_t badvaddr;
38 reg_t evec;
39 reg_t ptbr;
40 reg_t pcr_k0;
41 reg_t pcr_k1;
42 reg_t cause;
43 reg_t tohost;
44 reg_t fromhost;
45 reg_t count;
46 uint32_t compare;
47 uint32_t sr; // only modify the status register using set_pcr()
48 uint32_t fflags;
49 uint32_t frm;
50
51 reg_t load_reservation;
52 };
53
54 // this class represents one processor in a RISC-V machine.
55 class processor_t
56 {
57 public:
58 processor_t(sim_t* _sim, mmu_t* _mmu, uint32_t _id);
59 ~processor_t();
60
61 void set_debug(bool value);
62 void reset(bool value);
63 void step(size_t n); // run for n cycles
64 void deliver_ipi(); // register an interprocessor interrupt
65 bool running() { return run; }
66 reg_t set_pcr(int which, reg_t val);
67 void set_fromhost(reg_t val);
68 void set_interrupt(int which, bool on);
69 reg_t get_pcr(int which);
70 mmu_t* get_mmu() { return mmu; }
71 state_t* get_state() { return &state; }
72 extension_t* get_extension() { return ext; }
73 void yield_load_reservation() { state.load_reservation = (reg_t)-1; }
74
75 void register_insn(insn_desc_t);
76 void register_extension(extension_t*);
77
78 private:
79 sim_t* sim;
80 mmu_t* mmu; // main memory is always accessed via the mmu
81 extension_t* ext;
82 disassembler_t* disassembler;
83 state_t state;
84 uint32_t id;
85 bool run; // !reset
86 bool debug;
87 bool rv64;
88
89 std::vector<insn_desc_t> instructions;
90 std::vector<insn_desc_t*> opcode_map;
91 std::vector<insn_desc_t> opcode_store;
92
93 void take_interrupt(); // take a trap if any interrupts are pending
94 void take_trap(trap_t& t); // take an exception
95 void disasm(insn_t insn); // disassemble and print an instruction
96
97 friend class sim_t;
98 friend class mmu_t;
99 friend class extension_t;
100
101 void build_opcode_map();
102 insn_func_t decode_insn(insn_t insn);
103 };
104
105 reg_t illegal_instruction(processor_t* p, insn_t insn, reg_t pc);
106
107 #define REGISTER_INSN(proc, name, match, mask) \
108 extern reg_t rv32_##name(processor_t*, insn_t, reg_t); \
109 extern reg_t rv64_##name(processor_t*, insn_t, reg_t); \
110 proc->register_insn((insn_desc_t){match, mask, rv32_##name, rv64_##name});
111
112 #endif