Remove legacy HTIF; implement HTIF directly
[riscv-isa-sim.git] / riscv / processor.h
index b54803844f01a32a784b9712ee401f05e66aba5c..31d5f6ca7dd442ef3005e04a4832823bdfbbcf77 100644 (file)
+// See LICENSE for license details.
 #ifndef _RISCV_PROCESSOR_H
 #define _RISCV_PROCESSOR_H
 
 #include "decode.h"
-#include <cstring>
-#include "trap.h"
-#include "mmu.h"
+#include "config.h"
+#include "devices.h"
+#include <string>
+#include <vector>
+#include <map>
 
+class processor_t;
+class mmu_t;
+typedef reg_t (*insn_func_t)(processor_t*, insn_t, reg_t);
 class sim_t;
+class trap_t;
+class extension_t;
+class disassembler_t;
 
-class processor_t
+struct insn_desc_t
 {
-public:
-  processor_t(sim_t* _sim, char* _mem, size_t _memsz);
-  void init(uint32_t _id);
-  void step(size_t n, bool noisy);
+  insn_bits_t match;
+  insn_bits_t mask;
+  insn_func_t rv32;
+  insn_func_t rv64;
+};
 
-private:
-  sim_t* sim;
+struct commit_log_reg_t
+{
+  reg_t addr;
+  reg_t data;
+};
 
-  // architected state
-  reg_t XPR[NXPR];
-  freg_t FPR[NFPR];
+typedef struct
+{
+  uint8_t prv;
+  bool step;
+  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();
 
-  // privileged control registers
   reg_t pc;
-  reg_t epc;
-  reg_t badvaddr;
-  reg_t cause;
-  reg_t evec;
-  reg_t tohost;
-  reg_t fromhost;
-  reg_t pcr_k0;
-  reg_t pcr_k1;
-  uint32_t id;
-  uint32_t sr;
-  uint32_t count;
-  uint32_t compare;
-  uint32_t interrupts_pending;
+  regfile_t<reg_t, NXPR, true> XPR;
+  regfile_t<freg_t, NFPR, false> FPR;
+
+  // 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
+
+  // When true, execute a single instruction and then enter debug mode.  This
+  // can only be set by executing dret.
+  enum {
+      STEP_NONE,
+      STEP_STEPPING,
+      STEP_STEPPED
+  } single_step;
+
+  reg_t load_reservation;
+
+#ifdef RISCV_ENABLE_COMMITLOG
+  commit_log_reg_t log_reg_write;
+  reg_t last_inst_priv;
+#endif
+};
+
+// this class represents one processor in a RISC-V machine.
+class processor_t : public abstract_device_t
+{
+public:
+  processor_t(const char* isa, sim_t* sim, uint32_t id, bool halt_on_reset=false);
+  ~processor_t();
 
-  // unprivileged control registers
-  uint32_t fsr;
+  void set_debug(bool value);
+  void set_histogram(bool value);
+  void reset();
+  void step(size_t n); // run for n cycles
+  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);
 
-  // # of bits in an XPR (32 or 64). (redundant with sr)
-  int xprlen;
+  void register_insn(insn_desc_t);
+  void register_extension(extension_t*);
 
-  // shared memory
-  mmu_t mmu;
+  // 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);
 
-  // counters
-  reg_t counters[32];
+  // When true, display disassembly of each instruction that's executed.
+  bool debug;
 
-  // functions
-  void set_sr(uint32_t val);
-  void set_fsr(uint32_t val);
-  void take_trap(trap_t t, bool noisy);
-  void disasm(insn_t insn, reg_t pc);
+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 histogram_enabled;
+  bool halt_on_reset;
+
+  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(trap_t& t, reg_t epc); // take an exception
+  void disasm(insn_t insn); // disassemble and print an instruction
+  int paddr_bits();
+
+  void enter_debug_mode(uint8_t cause);
 
   friend class sim_t;
+  friend class mmu_t;
+  friend class rtc_t;
+  friend class extension_t;
+
+  void parse_isa_string(const char* isa);
+  void build_opcode_map();
+  void register_base_instructions();
+  insn_func_t decode_insn(insn_t insn);
 };
 
+reg_t illegal_instruction(processor_t* p, insn_t insn, reg_t pc);
+
+#define REGISTER_INSN(proc, name, match, mask) \
+  extern reg_t rv32_##name(processor_t*, insn_t, reg_t); \
+  extern reg_t rv64_##name(processor_t*, insn_t, reg_t); \
+  proc->register_insn((insn_desc_t){match, mask, rv32_##name, rv64_##name});
+
 #endif