per-core tohost/fromhost registers
[riscv-isa-sim.git] / riscv / sim.h
1 #ifndef _RISCV_SIM_H
2 #define _RISCV_SIM_H
3
4 #include <vector>
5 #include <string>
6 #include "processor.h"
7 #include "mmu.h"
8
9 class htif_t;
10
11 // this class encapsulates the processors and memory in a RISC-V machine.
12 class sim_t
13 {
14 public:
15 sim_t(int _nprocs, htif_t* _htif);
16 ~sim_t();
17
18 // run the simulation to completion
19 void run(bool debug);
20
21 // deliver an IPI to a specific processor
22 void send_ipi(reg_t who);
23
24 // returns the number of processors in this simulator
25 size_t num_cores() { return procs.size(); }
26
27 private:
28 htif_t* htif;
29
30 // global registers for communication with host machine
31 reg_t tohost;
32 reg_t fromhost;
33
34 // main memory, shared between processors
35 char* mem;
36 size_t memsz; // memory size in bytes
37 mmu_t* mmu; // debug port into main memory
38
39 // processors
40 std::vector<processor_t*> procs;
41
42 // terminate the simulation loop after the current iteration
43 void stop() { running = false; }
44 bool running;
45
46 // run each processor for n instructions; interleave instructions are
47 // run on a processor before moving on to the next processor.
48 // interleave must divide n.
49 // if noisy, print out the instructions as they execute.
50 void step_all(size_t n, size_t interleave, bool noisy);
51
52 // presents a prompt for introspection into the simulation
53 void interactive();
54
55 // functions that help implement interactive()
56 void interactive_quit(const std::string& cmd, const std::vector<std::string>& args);
57 void interactive_run(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
58 void interactive_run_noisy(const std::string& cmd, const std::vector<std::string>& args);
59 void interactive_run_silent(const std::string& cmd, const std::vector<std::string>& args);
60 void interactive_run_proc(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
61 void interactive_run_proc_noisy(const std::string& cmd, const std::vector<std::string>& args);
62 void interactive_run_proc_silent(const std::string& cmd, const std::vector<std::string>& args);
63 void interactive_reg(const std::string& cmd, const std::vector<std::string>& args);
64 void interactive_fregs(const std::string& cmd, const std::vector<std::string>& args);
65 void interactive_fregd(const std::string& cmd, const std::vector<std::string>& args);
66 void interactive_mem(const std::string& cmd, const std::vector<std::string>& args);
67 void interactive_str(const std::string& cmd, const std::vector<std::string>& args);
68 void interactive_until(const std::string& cmd, const std::vector<std::string>& args);
69 reg_t get_reg(const std::vector<std::string>& args);
70 reg_t get_freg(const std::vector<std::string>& args);
71 reg_t get_mem(const std::vector<std::string>& args);
72 reg_t get_pc(const std::vector<std::string>& args);
73 reg_t get_tohost(const std::vector<std::string>& args);
74
75 friend class htif_t;
76 };
77
78 #endif