Implement RoCC and add a dummy RoCC
[riscv-isa-sim.git] / riscv / mmu.h
index 9bfbeac31757ddeecb9591712deec7c50b11f7e5..b69de9c9020670f29e63e0bc78c5e82d8f7163b4 100644 (file)
+// See LICENSE for license details.
+
+#ifndef _RISCV_MMU_H
+#define _RISCV_MMU_H
+
 #include "decode.h"
 #include "trap.h"
+#include "common.h"
+#include "config.h"
+#include "processor.h"
+#include "memtracer.h"
+#include <vector>
+
+// virtual memory configuration
+typedef reg_t pte_t;
+const reg_t LEVELS = sizeof(pte_t) == 8 ? 3 : 2;
+const reg_t PTIDXBITS = 10;
+const reg_t PGSHIFT = PTIDXBITS + (sizeof(pte_t) == 8 ? 3 : 2);
+const reg_t PGSIZE = 1 << PGSHIFT;
+const reg_t VPN_BITS = PTIDXBITS * LEVELS;
+const reg_t PPN_BITS = 8*sizeof(reg_t) - PGSHIFT;
+const reg_t VA_BITS = VPN_BITS + PGSHIFT;
 
+// this class implements a processor's port into the virtual memory system.
+// an MMU and instruction cache are maintained for simulator performance.
 class mmu_t
 {
 public:
-  mmu_t(char* _mem, size_t _memsz) : mem(_mem), memsz(_memsz), badvaddr(0) {}
+  mmu_t(char* _mem, size_t _memsz);
+  ~mmu_t();
 
+  // template for functions that load an aligned value from memory
   #define load_func(type) \
     type##_t load_##type(reg_t addr) { \
-      check_align_and_bounds(addr, sizeof(type##_t), false, false); \
-      return *(type##_t*)(mem+addr); \
-    }
-
-  #define store_func(type) \
-    void store_##type(reg_t addr, type##_t val) { \
-      check_align_and_bounds(addr, sizeof(type##_t), true, false); \
-      *(type##_t*)(mem+addr) = val; \
+      if(unlikely(addr % sizeof(type##_t))) \
+        throw trap_load_address_misaligned(addr); \
+      reg_t paddr = translate(addr, sizeof(type##_t), false, false); \
+      return *(type##_t*)(mem + paddr); \
     }
 
-  insn_t load_insn(reg_t addr)
-  {
-    check_align_and_bounds(addr, sizeof(insn_t), false, true);
-    return *(insn_t*)(mem+addr);
-  }
-
+  // load value from memory at aligned address; zero extend to register width
   load_func(uint8)
   load_func(uint16)
   load_func(uint32)
   load_func(uint64)
 
+  // load value from memory at aligned address; sign extend to register width
   load_func(int8)
   load_func(int16)
   load_func(int32)
   load_func(int64)
 
+  // template for functions that store an aligned value to memory
+  #define store_func(type) \
+    void store_##type(reg_t addr, type##_t val) { \
+      if(unlikely(addr % sizeof(type##_t))) \
+        throw trap_store_address_misaligned(addr); \
+      reg_t paddr = translate(addr, sizeof(type##_t), true, false); \
+      *(type##_t*)(mem + paddr) = val; \
+    }
+
+  // store value to memory at aligned address
   store_func(uint8)
   store_func(uint16)
   store_func(uint32)
   store_func(uint64)
 
-  reg_t get_badvaddr() { return badvaddr; }
-
-private:
-  char* mem;
-  size_t memsz;
-  reg_t badvaddr;
-
-  void check_align(reg_t addr, int size, bool fetch)
+  struct insn_fetch_t
   {
-    if(addr & (size-1))
-    {
-      if(fetch)
-        throw trap_instruction_address_misaligned;
-      badvaddr = addr;
-      throw trap_data_address_misaligned;
-    }
-  }
+    insn_func_t func;
+    insn_t insn;
+  };
 
-  void check_bounds(reg_t addr, int size, bool store, bool fetch)
+  // load instruction from memory at aligned address.
+  inline insn_fetch_t load_insn(reg_t addr)
   {
-    if(addr >= memsz || addr + size > memsz)
+    reg_t idx = (addr/sizeof(insn_t::itype)) % ICACHE_ENTRIES;
+    if (unlikely(icache_tag[idx] != addr))
     {
-      if(fetch)
-        throw trap_instruction_access_fault;
-      badvaddr = addr;
-      throw store ? trap_store_access_fault : trap_load_access_fault;
+      reg_t paddr = translate(addr, sizeof(insn_t::itype), false, true);
+      insn_fetch_t fetch;
+      fetch.insn.itype = *(decltype(insn_t::itype)*)(mem + paddr);
+      fetch.func = proc->decode_insn(fetch.insn);
+
+      reg_t idx = (paddr/sizeof(insn_t::itype)) % ICACHE_ENTRIES;
+      icache_tag[idx] = addr;
+      icache_data[idx] = fetch;
+
+      if (tracer.interested_in_range(paddr, paddr + sizeof(insn_t::itype), false, true))
+      {
+        icache_tag[idx] = -1;
+        tracer.trace(paddr, sizeof(insn_t::itype), false, true);
+      }
     }
+    return icache_data[idx];
   }
 
-  void check_align_and_bounds(reg_t addr, int size, bool store, bool fetch)
+  void set_processor(processor_t* p) { proc = p; flush_tlb(); }
+
+  void flush_tlb();
+  void flush_icache();
+
+  void register_memtracer(memtracer_t*);
+
+private:
+  char* mem;
+  size_t memsz;
+  processor_t* proc;
+  memtracer_list_t tracer;
+
+  // implement an instruction cache for simulator performance
+  static const reg_t ICACHE_ENTRIES = 256;
+  insn_fetch_t icache_data[ICACHE_ENTRIES];
+
+  // implement a TLB for simulator performance
+  static const reg_t TLB_ENTRIES = 256;
+  reg_t tlb_data[TLB_ENTRIES];
+  reg_t tlb_insn_tag[TLB_ENTRIES];
+  reg_t tlb_load_tag[TLB_ENTRIES];
+  reg_t tlb_store_tag[TLB_ENTRIES];
+  reg_t icache_tag[ICACHE_ENTRIES];
+
+  // finish translation on a TLB miss and upate the TLB
+  reg_t refill_tlb(reg_t addr, reg_t bytes, bool store, bool fetch);
+
+  // perform a page table walk for a given virtual address
+  pte_t walk(reg_t addr);
+
+  // translate a virtual address to a physical address
+  reg_t translate(reg_t addr, reg_t bytes, bool store, bool fetch)
   {
-    check_align(addr, size, fetch);
-    check_bounds(addr, size, store, fetch);
+    reg_t idx = (addr >> PGSHIFT) % TLB_ENTRIES;
+
+    reg_t* tlb_tag = fetch ? tlb_insn_tag : store ? tlb_store_tag :tlb_load_tag;
+    reg_t expected_tag = addr & ~(PGSIZE-1);
+    if(likely(tlb_tag[idx] == expected_tag))
+      return ((uintptr_t)addr & (PGSIZE-1)) + tlb_data[idx];
+
+    return refill_tlb(addr, bytes, store, fetch);
   }
+  
+  friend class processor_t;
 };
+
+#endif