Add writing to DCSR, DPC, DSCRATCH.
[riscv-isa-sim.git] / riscv / processor.h
index 6b007f24e263de5b6a4406d741bd4d3eaee64e43..e0142995c1c09d8eb5ae6ce829738d4e8ec1dbeb 100644 (file)
@@ -1,11 +1,12 @@
 // See LICENSE for license details.
-
 #ifndef _RISCV_PROCESSOR_H
 #define _RISCV_PROCESSOR_H
 
 #include "decode.h"
-#include <cstring>
 #include "config.h"
+#include "devices.h"
+#include <string>
+#include <vector>
 #include <map>
 
 class processor_t;
@@ -14,88 +15,167 @@ typedef reg_t (*insn_func_t)(processor_t*, insn_t, reg_t);
 class sim_t;
 class trap_t;
 class extension_t;
+class disassembler_t;
 
 struct insn_desc_t
 {
-  uint32_t match;
-  uint32_t mask;
+  insn_bits_t match;
+  insn_bits_t mask;
   insn_func_t rv32;
   insn_func_t rv64;
 };
 
+struct commit_log_reg_t
+{
+  reg_t addr;
+  reg_t data;
+};
+
+typedef struct
+{
+  uint8_t prv;
+  bool step;
+  bool debugint;
+  bool ebreakm;
+  bool ebreakh;
+  bool ebreaks;
+  bool ebreaku;
+  bool halt;
+  uint8_t cause;
+} dcsr_t;
+
 // architectural state of a RISC-V hart
 struct state_t
 {
   void reset();
 
-  // user-visible state
   reg_t pc;
   regfile_t<reg_t, NXPR, true> XPR;
   regfile_t<freg_t, NFPR, false> FPR;
-  reg_t cycle;
-
-  // privileged control registers
-  reg_t epc;
-  reg_t badvaddr;
-  reg_t evec;
-  reg_t ptbr;
-  reg_t pcr_k0;
-  reg_t pcr_k1;
-  reg_t cause;
-  reg_t tohost;
-  reg_t fromhost;
-  uint32_t sr; // only modify the status register using set_pcr()
-  uint32_t fsr;
-  uint32_t count;
-  uint32_t compare;
+
+  // control and status registers
+  reg_t prv;
+  reg_t mstatus;
+  reg_t mepc;
+  reg_t mbadaddr;
+  reg_t mscratch;
+  reg_t mtvec;
+  reg_t mcause;
+  reg_t minstret;
+  reg_t mie;
+  reg_t mip;
+  reg_t medeleg;
+  reg_t mideleg;
+  reg_t mucounteren;
+  reg_t mscounteren;
+  reg_t sepc;
+  reg_t sbadaddr;
+  reg_t sscratch;
+  reg_t stvec;
+  reg_t sptbr;
+  reg_t scause;
+  reg_t dpc;
+  reg_t dscratch;
+  dcsr_t dcsr;
+
+  uint32_t fflags;
+  uint32_t frm;
+  bool serialized; // whether timer CSRs are in a well-defined state
 
   reg_t load_reservation;
+
+#ifdef RISCV_ENABLE_COMMITLOG
+  commit_log_reg_t log_reg_write;
+  reg_t last_inst_priv;
+#endif
 };
 
+typedef enum {
+      HR_NONE,
+      HR_STEPPED,       // A single step was completed
+      HR_SWBP,          // sbreak was executed
+      HR_INTERRUPT,     // Execution interrupted by debugger
+      HR_CMDLINE,       // Command line requested that the processor start halted
+      HR_ATTACHED       // Halted because a debugger attached
+} halt_reason_t;
+
 // this class represents one processor in a RISC-V machine.
-class processor_t
+class processor_t : public abstract_device_t
 {
 public:
-  processor_t(sim_t* _sim, mmu_t* _mmu, uint32_t _id);
+  processor_t(const char* isa, sim_t* sim, uint32_t id);
   ~processor_t();
 
+  void set_debug(bool value);
+  void set_halted(bool value, halt_reason_t reason);
+  void set_single_step(bool value);
+  void set_histogram(bool value);
   void reset(bool value);
-  void step(size_t n, bool noisy); // run for n cycles
-  void deliver_ipi(); // register an interprocessor interrupt
+  void step(size_t n); // run for n cycles
   bool running() { return run; }
-  reg_t set_pcr(int which, reg_t val);
-  uint32_t set_fsr(uint32_t val); // set the floating-point status register
-  void set_interrupt(int which, bool on);
-  reg_t get_pcr(int which);
-  uint32_t get_fsr() { return state.fsr; }
+  void set_csr(int which, reg_t val);
+  void raise_interrupt(reg_t which);
+  reg_t get_csr(int which);
   mmu_t* get_mmu() { return mmu; }
   state_t* get_state() { return &state; }
   extension_t* get_extension() { return ext; }
+  bool supports_extension(unsigned char ext) {
+    if (ext >= 'a' && ext <= 'z') ext += 'A' - 'a';
+    return ext >= 'A' && ext <= 'Z' && ((isa >> (ext - 'A')) & 1);
+  }
+  void set_privilege(reg_t);
   void yield_load_reservation() { state.load_reservation = (reg_t)-1; }
+  void update_histogram(reg_t pc);
 
   void register_insn(insn_desc_t);
   void register_extension(extension_t*);
 
+  // MMIO slave interface
+  bool load(reg_t addr, size_t len, uint8_t* bytes);
+  bool store(reg_t addr, size_t len, const uint8_t* bytes);
+
 private:
   sim_t* sim;
   mmu_t* mmu; // main memory is always accessed via the mmu
   extension_t* ext;
+  disassembler_t* disassembler;
   state_t state;
   uint32_t id;
+  unsigned max_xlen;
+  unsigned xlen;
+  reg_t isa;
+  std::string isa_string;
   bool run; // !reset
-
-  unsigned opcode_bits;
-  std::multimap<uint32_t, insn_desc_t> opcode_map;
-
+  // When true, display disassembly of each instruction that's executed.
+  bool debug;
+  // TODO: Should this just be rolled into `run`?
+  bool halted;  // When true, no instructions are executed.
+  halt_reason_t halt_reason;        // Why is halted true?
+  // When true, execute exactly one instruction (even if halted is true), then
+  // set halted to true and single_step to false.
+  bool single_step;
+  bool histogram_enabled;
+
+  std::vector<insn_desc_t> instructions;
+  std::map<reg_t,uint64_t> pc_histogram;
+
+  static const size_t OPCODE_CACHE_SIZE = 8191;
+  insn_desc_t opcode_cache[OPCODE_CACHE_SIZE];
+
+  void check_timer();
   void take_interrupt(); // take a trap if any interrupts are pending
-  void take_trap(reg_t pc, trap_t& t, bool noisy); // take an exception
-  void disasm(insn_t insn, reg_t pc); // disassemble and print an instruction
+  void take_trap(trap_t& t, reg_t epc); // take an exception
+  void disasm(insn_t insn); // disassemble and print an instruction
 
   friend class sim_t;
   friend class mmu_t;
+  friend class rtc_t;
   friend class extension_t;
-  friend class htif_isasim_t;
+  friend class gdbserver_t;
 
+  void parse_isa_string(const char* isa);
+  void build_opcode_map();
+  void register_base_instructions();
   insn_func_t decode_insn(insn_t insn);
 };