Instructions are no longer member functions
[riscv-isa-sim.git] / riscv / mmu.h
1 // See LICENSE for license details.
2
3 #ifndef _RISCV_MMU_H
4 #define _RISCV_MMU_H
5
6 #include "decode.h"
7 #include "trap.h"
8 #include "common.h"
9 #include "config.h"
10 #include "processor.h"
11 #include "memtracer.h"
12 #include <vector>
13
14 // virtual memory configuration
15 typedef reg_t pte_t;
16 const reg_t LEVELS = sizeof(pte_t) == 8 ? 3 : 2;
17 const reg_t PTIDXBITS = 10;
18 const reg_t PGSHIFT = PTIDXBITS + (sizeof(pte_t) == 8 ? 3 : 2);
19 const reg_t PGSIZE = 1 << PGSHIFT;
20 const reg_t VPN_BITS = PTIDXBITS * LEVELS;
21 const reg_t PPN_BITS = 8*sizeof(reg_t) - PGSHIFT;
22 const reg_t VA_BITS = VPN_BITS + PGSHIFT;
23
24 // this class implements a processor's port into the virtual memory system.
25 // an MMU and instruction cache are maintained for simulator performance.
26 class mmu_t
27 {
28 public:
29 mmu_t(char* _mem, size_t _memsz);
30 ~mmu_t();
31
32 // template for functions that load an aligned value from memory
33 #define load_func(type) \
34 type##_t load_##type(reg_t addr) { \
35 if(unlikely(addr % sizeof(type##_t))) \
36 throw trap_load_address_misaligned(addr); \
37 reg_t paddr = translate(addr, sizeof(type##_t), false, false); \
38 return *(type##_t*)(mem + paddr); \
39 }
40
41 // load value from memory at aligned address; zero extend to register width
42 load_func(uint8)
43 load_func(uint16)
44 load_func(uint32)
45 load_func(uint64)
46
47 // load value from memory at aligned address; sign extend to register width
48 load_func(int8)
49 load_func(int16)
50 load_func(int32)
51 load_func(int64)
52
53 // template for functions that store an aligned value to memory
54 #define store_func(type) \
55 void store_##type(reg_t addr, type##_t val) { \
56 if(unlikely(addr % sizeof(type##_t))) \
57 throw trap_store_address_misaligned(addr); \
58 reg_t paddr = translate(addr, sizeof(type##_t), true, false); \
59 *(type##_t*)(mem + paddr) = val; \
60 }
61
62 // store value to memory at aligned address
63 store_func(uint8)
64 store_func(uint16)
65 store_func(uint32)
66 store_func(uint64)
67
68 struct insn_fetch_t
69 {
70 insn_func_t func;
71 insn_t insn;
72 };
73
74 // load instruction from memory at aligned address.
75 inline insn_fetch_t load_insn(reg_t addr)
76 {
77 reg_t idx = (addr/sizeof(insn_t::itype)) % ICACHE_ENTRIES;
78 if (unlikely(icache_tag[idx] != addr))
79 {
80 reg_t paddr = translate(addr, sizeof(insn_t::itype), false, true);
81 insn_fetch_t fetch;
82 fetch.insn.itype = *(decltype(insn_t::itype)*)(mem + paddr);
83 fetch.func = proc->decode_insn(fetch.insn);
84
85 reg_t idx = (paddr/sizeof(insn_t::itype)) % ICACHE_ENTRIES;
86 icache_tag[idx] = addr;
87 icache_data[idx] = fetch;
88
89 if (tracer.interested_in_range(paddr, paddr + sizeof(insn_t::itype), false, true))
90 {
91 icache_tag[idx] = -1;
92 tracer.trace(paddr, sizeof(insn_t::itype), false, true);
93 }
94 }
95 return icache_data[idx];
96 }
97
98 void set_processor(processor_t* p) { proc = p; flush_tlb(); }
99
100 void flush_tlb();
101 void flush_icache();
102
103 void register_memtracer(memtracer_t*);
104
105 private:
106 char* mem;
107 size_t memsz;
108 processor_t* proc;
109 memtracer_list_t tracer;
110
111 // implement an instruction cache for simulator performance
112 static const reg_t ICACHE_ENTRIES = 256;
113 insn_fetch_t icache_data[ICACHE_ENTRIES];
114
115 // implement a TLB for simulator performance
116 static const reg_t TLB_ENTRIES = 256;
117 reg_t tlb_data[TLB_ENTRIES];
118 reg_t tlb_insn_tag[TLB_ENTRIES];
119 reg_t tlb_load_tag[TLB_ENTRIES];
120 reg_t tlb_store_tag[TLB_ENTRIES];
121 reg_t icache_tag[ICACHE_ENTRIES];
122
123 // finish translation on a TLB miss and upate the TLB
124 reg_t refill_tlb(reg_t addr, reg_t bytes, bool store, bool fetch);
125
126 // perform a page table walk for a given virtual address
127 pte_t walk(reg_t addr);
128
129 // translate a virtual address to a physical address
130 reg_t translate(reg_t addr, reg_t bytes, bool store, bool fetch)
131 {
132 reg_t idx = (addr >> PGSHIFT) % TLB_ENTRIES;
133
134 reg_t* tlb_tag = fetch ? tlb_insn_tag : store ? tlb_store_tag :tlb_load_tag;
135 reg_t expected_tag = addr & ~(PGSIZE-1);
136 if(likely(tlb_tag[idx] == expected_tag))
137 return ((uintptr_t)addr & (PGSIZE-1)) + tlb_data[idx];
138
139 return refill_tlb(addr, bytes, store, fetch);
140 }
141
142 friend class processor_t;
143 };
144
145 #endif