Exit cleanly from debug console
[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(size_t _nprocs, size_t mem_mb, const std::vector<std::string>& htif_args);
19 ~sim_t();
20
21 // run the simulation to completion
22 void run();
23 void stop();
24 void set_debug(bool value) { debug = value; }
25
26 // deliver an IPI to a specific processor
27 void send_ipi(reg_t who);
28
29 // returns the number of processors in this simulator
30 size_t num_cores() { return procs.size(); }
31 processor_t* get_core(size_t i) { return procs[i]; }
32
33 // read one of the system control registers
34 reg_t get_scr(int which);
35
36 private:
37 std::auto_ptr<htif_isasim_t> htif;
38 char* mem; // main memory
39 size_t memsz; // memory size in bytes
40 mmu_t* mmu; // debug port into main memory
41 std::vector<processor_t*> procs;
42
43 void step(size_t n, bool noisy); // step through simulation
44 static const size_t INTERLEAVE = 1000;
45 size_t current_step;
46 size_t current_proc;
47 bool debug;
48
49 // presents a prompt for introspection into the simulation
50 void interactive();
51
52 // functions that help implement interactive()
53 void interactive_quit(const std::string& cmd, const std::vector<std::string>& args);
54 void interactive_run(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
55 void interactive_run_noisy(const std::string& cmd, const std::vector<std::string>& args);
56 void interactive_run_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