destroy htif on simulator termination
[riscv-isa-sim.git] / riscv / sim.h
1 // See LICENSE for license details.
2
3 #ifndef _RISCV_SIM_H
4 #define _RISCV_SIM_H
5
6 #include <vector>
7 #include <string>
8 #include <memory>
9 #include "processor.h"
10 #include "mmu.h"
11
12 class htif_isasim_t;
13
14 // this class encapsulates the processors and memory in a RISC-V machine.
15 class sim_t
16 {
17 public:
18 sim_t(int _nprocs, int mem_mb, const std::vector<std::string>& htif_args);
19 ~sim_t();
20
21 // run the simulation to completion
22 void run(bool debug);
23
24 // deliver an IPI to a specific processor
25 void send_ipi(reg_t who);
26
27 // returns the number of processors in this simulator
28 size_t num_cores() { return procs.size(); }
29 processor_t* get_core(size_t i) { return procs[i]; }
30
31 // read one of the system control registers
32 reg_t get_scr(int which);
33
34 private:
35 std::auto_ptr<htif_isasim_t> htif;
36 char* mem; // main memory
37 size_t memsz; // memory size in bytes
38 mmu_t* mmu; // debug port into main memory
39 std::vector<processor_t*> procs;
40
41 void step(size_t n, bool noisy); // step through simulation
42 static const size_t INTERLEAVE = 5000;
43 size_t current_step;
44 size_t current_proc;
45
46 // presents a prompt for introspection into the simulation
47 void interactive();
48
49 // functions that help implement interactive()
50 void interactive_quit(const std::string& cmd, const std::vector<std::string>& args);
51 void interactive_run(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
52 void interactive_run_noisy(const std::string& cmd, const std::vector<std::string>& args);
53 void interactive_run_silent(const std::string& cmd, const std::vector<std::string>& args);
54 void interactive_run_proc(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
55 void interactive_run_proc_noisy(const std::string& cmd, const std::vector<std::string>& args);
56 void interactive_run_proc_silent(const std::string& cmd, const std::vector<std::string>& args);
57 void interactive_reg(const std::string& cmd, const std::vector<std::string>& args);
58 void interactive_fregs(const std::string& cmd, const std::vector<std::string>& args);
59 void interactive_fregd(const std::string& cmd, const std::vector<std::string>& args);
60 void interactive_mem(const std::string& cmd, const std::vector<std::string>& args);
61 void interactive_str(const std::string& cmd, const std::vector<std::string>& args);
62 void interactive_until(const std::string& cmd, const std::vector<std::string>& args);
63 reg_t get_reg(const std::vector<std::string>& args);
64 reg_t get_freg(const std::vector<std::string>& args);
65 reg_t get_mem(const std::vector<std::string>& args);
66 reg_t get_pc(const std::vector<std::string>& args);
67 reg_t get_tohost(const std::vector<std::string>& args);
68
69 friend class htif_isasim_t;
70 };
71
72 #endif