temporary undoing of renaming
[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 // communicate with the host machine
22 void set_tohost(reg_t val);
23 reg_t get_fromhost();
24
25 // deliver an IPI to a specific processor
26 void send_ipi(reg_t who);
27
28 // returns the number of processors in this simulator
29 size_t num_cores() { return procs.size(); }
30
31 private:
32 htif_t* htif;
33
34 // global registers for communication with host machine
35 reg_t tohost;
36 reg_t fromhost;
37
38 // main memory, shared between processors
39 char* mem;
40 size_t memsz; // memory size in bytes
41 mmu_t* mmu; // debug port into main memory
42
43 // processors
44 std::vector<processor_t*> procs;
45
46 // terminate the simulation loop after the current iteration
47 void stop() { running = false; }
48 bool running;
49
50 // run each processor for n instructions; interleave instructions are
51 // run on a processor before moving on to the next processor.
52 // interleave must divide n.
53 // if noisy, print out the instructions as they execute.
54 void step_all(size_t n, size_t interleave, bool noisy);
55
56 // presents a prompt for introspection into the simulation
57 void interactive();
58
59 // functions that help implement interactive()
60 void interactive_quit(const std::string& cmd, const std::vector<std::string>& args);
61 void interactive_run(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
62 void interactive_run_noisy(const std::string& cmd, const std::vector<std::string>& args);
63 void interactive_run_silent(const std::string& cmd, const std::vector<std::string>& args);
64 void interactive_run_proc(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
65 void interactive_run_proc_noisy(const std::string& cmd, const std::vector<std::string>& args);
66 void interactive_run_proc_silent(const std::string& cmd, const std::vector<std::string>& args);
67 void interactive_reg(const std::string& cmd, const std::vector<std::string>& args);
68 void interactive_fregs(const std::string& cmd, const std::vector<std::string>& args);
69 void interactive_fregd(const std::string& cmd, const std::vector<std::string>& args);
70 void interactive_mem(const std::string& cmd, const std::vector<std::string>& args);
71 void interactive_str(const std::string& cmd, const std::vector<std::string>& args);
72 void interactive_until(const std::string& cmd, const std::vector<std::string>& args);
73 reg_t get_reg(const std::vector<std::string>& args);
74 reg_t get_freg(const std::vector<std::string>& args);
75 reg_t get_mem(const std::vector<std::string>& args);
76 reg_t get_pc(const std::vector<std::string>& args);
77 reg_t get_tohost(const std::vector<std::string>& args);
78
79 friend class htif_t;
80 };
81
82 #endif