add I$/D$/L2$ simulators

[riscv-isa-sim.git] / riscv / sim.h

diff --git a/riscv/sim.h b/riscv/sim.h
index c56ad95cda772519b55cc9ef40d5de37c25f0e4c..aed4e87f67dc39db4db8f5b70dfafc6727ba9d7e 100644 (file)
--- a/riscv/sim.h
+++ b/riscv/sim.h
@@ -4,62 +4,71 @@
 #include <vector>
 #include <string>
 #include "processor.h"
+#include "mmu.h"
 
-class appserver_link_t;
+class htif_isasim_t;
 
+// this class encapsulates the processors and memory in a RISC-V machine.
 class sim_t
 {
 public:
-  sim_t(int _nprocs, appserver_link_t* _applink, icsim_t* _default_icache, icsim_t* default_dcache);
+  sim_t(int _nprocs, int mem_mb, const std::vector<std::string>& htif_args);
   ~sim_t();
+
+  // run the simulation to completion
   void run(bool debug);
 
-  void set_tohost(reg_t val);
-  reg_t get_fromhost();
+  // deliver an IPI to a specific processor
   void send_ipi(reg_t who);
 
+  // returns the number of processors in this simulator
   size_t num_cores() { return procs.size(); }
+  processor_t* get_core(size_t i) { return procs[i]; }
 
-private:
-  // global architected state
-  reg_t tohost;
-  reg_t fromhost;
+  // read one of the system control registers
+  reg_t get_scr(int which);
 
-  appserver_link_t* applink;
+private:
+  htif_isasim_t* htif;
 
-  size_t memsz;
+  // main memory, shared between processors
   char* mem;
-  mmu_t* mmu;
+  size_t memsz; // memory size in bytes
+  mmu_t* mmu; // debug port into main memory
+
+  // processors
   std::vector<processor_t*> procs;
 
+  // run each processor for n instructions; interleave instructions are
+  // run on a processor before moving on to the next processor.
+  // interleave must divide n.
+  // if noisy, print out the instructions as they execute.
   void step_all(size_t n, size_t interleave, bool noisy);
 
-  void interactive_quit(const std::string& cmd, const std::vector<std::string>& args);
+  // presents a prompt for introspection into the simulation
+  void interactive();
 
+  // functions that help implement interactive()
+  void interactive_quit(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_run(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
   void interactive_run_noisy(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_run_silent(const std::string& cmd, const std::vector<std::string>& args);
-
   void interactive_run_proc(const std::string& cmd, const std::vector<std::string>& args, bool noisy);
   void interactive_run_proc_noisy(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_run_proc_silent(const std::string& cmd, const std::vector<std::string>& args);
-
   void interactive_reg(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_fregs(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_fregd(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_mem(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_str(const std::string& cmd, const std::vector<std::string>& args);
   void interactive_until(const std::string& cmd, const std::vector<std::string>& args);
-
   reg_t get_reg(const std::vector<std::string>& args);
   reg_t get_freg(const std::vector<std::string>& args);
   reg_t get_mem(const std::vector<std::string>& args);
   reg_t get_pc(const std::vector<std::string>& args);
   reg_t get_tohost(const std::vector<std::string>& args);
 
-  friend class appserver_link_t;
+  friend class htif_isasim_t;
 };
 
-struct quit_sim {};
-
 #endif