Fixed masking/casting logic in commit log printf.
[riscv-isa-sim.git] / riscv / processor.cc
index 4dff4861e7625300da6b33a17e460743c20bcb84..0a344465df6b39ddf981e22b8c28f3ea4f67eeb2 100644 (file)
@@ -1,9 +1,11 @@
 // See LICENSE for license details.
 
 #include "processor.h"
+#include "extension.h"
 #include "common.h"
 #include "config.h"
 #include "sim.h"
+#include "htif.h"
 #include "disasm.h"
 #include <cinttypes>
 #include <cmath>
 #include <iostream>
 #include <assert.h>
 #include <limits.h>
+#include <stdexcept>
+#include <algorithm>
+
+#undef STATE
+#define STATE state
 
 processor_t::processor_t(sim_t* _sim, mmu_t* _mmu, uint32_t _id)
-  : sim(*_sim), mmu(*_mmu), id(_id), opcode_bits(0)
+  : sim(_sim), mmu(_mmu), ext(NULL), disassembler(new disassembler_t),
+    id(_id), run(false), debug(false), serialized(false)
 {
   reset(true);
-  mmu.set_processor(this);
+  mmu->set_processor(this);
 
-  #define DECLARE_INSN(name, match, mask) \
-    register_insn(match, mask, (insn_func_t)&processor_t::rv32_##name, (insn_func_t)&processor_t::rv64_##name);
-  #include "opcodes.h"
+  #define DECLARE_INSN(name, match, mask) REGISTER_INSN(this, name, match, mask)
+  #include "encoding.h"
   #undef DECLARE_INSN
+  build_opcode_map();
 }
 
 processor_t::~processor_t()
 {
+#ifdef RISCV_ENABLE_HISTOGRAM
+  if (histogram_enabled)
+  {
+    fprintf(stderr, "PC Histogram size:%lu\n", pc_histogram.size());
+    for(auto iterator = pc_histogram.begin(); iterator != pc_histogram.end(); ++iterator) {
+      fprintf(stderr, "%0lx %lu\n", (iterator->first << 2), iterator->second);
+    }
+  }
+#endif
+
+  delete disassembler;
 }
 
-void processor_t::reset(bool value)
+void state_t::reset()
 {
-  if (run == !value)
-    return;
-  run = !value;
-
   // the ISA guarantees on boot that the PC is 0x2000 and the the processor
   // is in supervisor mode, and in 64-bit mode, if supported, with traps
   // and virtual memory disabled.
-  sr = 0;
-  set_pcr(PCR_SR, SR_S | SR_S64 | SR_IM);
+  sr = SR_S | SR_S64 | SR_U64;
   pc = 0x2000;
 
   // the following state is undefined upon boot-up,
@@ -46,268 +60,438 @@ void processor_t::reset(bool value)
   XPR.reset();
   FPR.reset();
 
-  evec = 0;
   epc = 0;
   badvaddr = 0;
-  cause = 0;
+  evec = 0;
+  ptbr = 0;
   pcr_k0 = 0;
   pcr_k1 = 0;
+  cause = 0;
+  tohost = 0;
+  fromhost = 0;
   count = 0;
   compare = 0;
-  cycle = 0;
-  set_fsr(0);
+  fflags = 0;
+  frm = 0;
+
+  load_reservation = -1;
 }
 
-void processor_t::set_fsr(uint32_t val)
+void processor_t::set_debug(bool value)
 {
-  fsr = val & ~FSR_ZERO; // clear FSR bits that read as zero
+  debug = value;
+  if (ext)
+    ext->set_debug(value);
+}
+
+void processor_t::set_histogram(bool value)
+{
+  histogram_enabled = value;
+}
+
+void processor_t::reset(bool value)
+{
+  if (run == !value)
+    return;
+  run = !value;
+
+  state.reset(); // reset the core
+  set_pcr(CSR_STATUS, state.sr);
+
+  if (ext)
+    ext->reset(); // reset the extension
+}
+
+struct serialize_t {};
+
+void processor_t::serialize()
+{
+  if (serialized)
+    serialized = false;
+  else
+    serialized = true, throw serialize_t();
 }
 
 void processor_t::take_interrupt()
 {
-  uint32_t interrupts = (sr & SR_IP) >> SR_IP_SHIFT;
-  interrupts &= (sr & SR_IM) >> SR_IM_SHIFT;
+  int irqs = ((state.sr & SR_IP) >> SR_IP_SHIFT) & (state.sr >> SR_IM_SHIFT);
+  if (likely(!irqs) || likely(!(state.sr & SR_EI)))
+    return;
+
+  for (int i = 0; ; i++)
+    if ((irqs >> i) & 1)
+      throw trap_t((1ULL << ((state.sr & SR_S64) ? 63 : 31)) + i);
+}
 
-  if(interrupts && (sr & SR_EI))
-    for(int i = 0; ; i++, interrupts >>= 1)
-      if(interrupts & 1)
-        throw interrupt_t(i);
+static void commit_log(state_t* state, reg_t pc, insn_t insn)
+{
+#ifdef RISCV_ENABLE_COMMITLOG
+  if (state->sr & SR_EI) {
+    uint64_t mask = (insn.length() == 8 ? uint64_t(0) : (uint64_t(1) << (insn.length() * 8))) - 1;
+    if (state->log_reg_write.addr) {
+      fprintf(stderr, "0x%016" PRIx64 " (0x%08" PRIx64 ") %c%2" PRIu64 " 0x%016" PRIx64 "\n",
+              pc,
+              insn.bits() & mask,
+              state->log_reg_write.addr & 1 ? 'f' : 'x',
+              state->log_reg_write.addr >> 1,
+              state->log_reg_write.data);
+    } else {
+      fprintf(stderr, "0x%016" PRIx64 " (0x%08" PRIx64 ")\n", pc, insn.bits() & mask);
+    }
+  }
+  state->log_reg_write.addr = 0;
+#endif
 }
 
-void processor_t::step(size_t n, bool noisy)
+inline void processor_t::update_histogram(size_t pc)
 {
-  if(!run)
+#ifdef RISCV_ENABLE_HISTOGRAM
+  size_t idx = pc >> 2;
+  pc_histogram[idx]++;
+#endif
+}
+
+static reg_t execute_insn(processor_t* p, reg_t pc, insn_fetch_t fetch)
+{
+  reg_t npc = fetch.func(p, fetch.insn, pc);
+  commit_log(p->get_state(), pc, fetch.insn);
+  p->update_histogram(pc);
+  return npc;
+}
+
+static void update_timer(state_t* state, size_t instret)
+{
+  uint64_t count0 = (uint64_t)(uint32_t)state->count;
+  state->count += instret;
+  uint64_t before = count0 - state->compare;
+  if (int64_t(before ^ (before + instret)) < 0)
+    state->sr |= (1 << (IRQ_TIMER + SR_IP_SHIFT));
+}
+
+static size_t next_timer(state_t* state)
+{
+  return state->compare - (uint32_t)state->count;
+}
+
+void processor_t::step(size_t n)
+{
+  size_t instret = 0;
+  reg_t pc = state.pc;
+  mmu_t* _mmu = mmu;
+
+  if (unlikely(!run || !n))
     return;
+  n = std::min(n, next_timer(&state) | 1U);
 
-  size_t i = 0;
   try
   {
     take_interrupt();
 
-    mmu_t& _mmu = mmu;
-    reg_t npc = pc;
-
-    // execute_insn fetches and executes one instruction
-    #define execute_insn(noisy) \
-      do { \
-        mmu_t::insn_fetch_t fetch = _mmu.load_insn(npc); \
-        if(noisy) disasm(fetch.insn, npc); \
-        npc = fetch.func(this, fetch.insn, npc); \
-        pc = npc; \
-      } while(0)
-
-    if(noisy) for( ; i < n; i++) // print out instructions as we go
-      execute_insn(true);
-    else 
+    if (unlikely(debug))
     {
-      // unrolled for speed
-      for( ; n > 3 && i < n-3; i+=4)
+      while (instret++ < n)
       {
-        execute_insn(false);
-        execute_insn(false);
-        execute_insn(false);
-        execute_insn(false);
+        insn_fetch_t fetch = mmu->load_insn(pc);
+        disasm(fetch.insn);
+        pc = execute_insn(this, pc, fetch);
+      }
+    }
+    else while (instret < n)
+    {
+      size_t idx = _mmu->icache_index(pc);
+      auto ic_entry = _mmu->access_icache(pc);
+
+      #define ICACHE_ACCESS(idx) { \
+        insn_fetch_t fetch = ic_entry->data; \
+        ic_entry++; \
+        pc = execute_insn(this, pc, fetch); \
+        instret++; \
+        if (idx == mmu_t::ICACHE_ENTRIES-1) break; \
+        if (unlikely(ic_entry->tag != pc)) break; \
+      }
+
+      switch (idx) {
+        #include "icache.h"
       }
-      for( ; i < n; i++)
-        execute_insn(false);
     }
   }
-  catch(trap_t t)
-  {
-    // an exception occurred in the target processor
-    take_trap(t,noisy);
-  }
-  catch(interrupt_t t)
+  catch(trap_t& t)
   {
-    take_trap((1ULL << ((sr & SR_S64) ? 63 : 31)) + t.i, noisy);
+    pc = take_trap(t, pc);
   }
+  catch(serialize_t& s) {}
 
-  cycle += i;
-
-  // update timer and possibly register a timer interrupt
-  uint32_t old_count = count;
-  count += i;
-  if(old_count < compare && uint64_t(old_count) + i >= compare)
-    set_interrupt(IRQ_TIMER, true);
+  state.pc = pc;
+  update_timer(&state, instret);
 }
 
-void processor_t::take_trap(reg_t t, bool noisy)
+reg_t processor_t::take_trap(trap_t& t, reg_t epc)
 {
-  if(noisy)
-  {
-    if ((sreg_t)t < 0)
-      fprintf(stderr, "core %3d: interrupt %d, epc 0x%016" PRIx64 "\n",
-              id, uint8_t(t), pc);
-    else
-      fprintf(stderr, "core %3d: trap %s, epc 0x%016" PRIx64 "\n",
-              id, trap_name(trap_t(t)), pc);
-  }
-
-  // switch to supervisor, set previous supervisor bit, disable traps
-  set_pcr(PCR_SR, (((sr & ~SR_EI) | SR_S) & ~SR_PS & ~SR_PEI) |
-                  ((sr & SR_S) ? SR_PS : 0) |
-                  ((sr & SR_EI) ? SR_PEI : 0));
-  cause = t;
-  epc = pc;
-  pc = evec;
-  badvaddr = mmu.get_badvaddr();
+  if (debug)
+    fprintf(stderr, "core %3d: exception %s, epc 0x%016" PRIx64 "\n",
+            id, t.name(), epc);
+
+  // switch to supervisor, set previous supervisor bit, disable interrupts
+  set_pcr(CSR_STATUS, (((state.sr & ~SR_EI) | SR_S) & ~SR_PS & ~SR_PEI) |
+                      ((state.sr & SR_S) ? SR_PS : 0) |
+                      ((state.sr & SR_EI) ? SR_PEI : 0));
+
+  yield_load_reservation();
+  state.cause = t.cause();
+  state.epc = epc;
+  t.side_effects(&state); // might set badvaddr etc.
+  return state.evec;
 }
 
 void processor_t::deliver_ipi()
 {
   if (run)
-    set_pcr(PCR_CLR_IPI, 1);
+    set_pcr(CSR_CLEAR_IPI, 1);
 }
 
-void processor_t::disasm(insn_t insn, reg_t pc)
+void processor_t::disasm(insn_t insn)
 {
-  // the disassembler is stateless, so we share it
-  static disassembler disasm;
-  fprintf(stderr, "core %3d: 0x%016" PRIx64 " (0x%08" PRIxFAST32 ") %s\n",
-          id, pc, insn.bits, disasm.disassemble(insn).c_str());
+  uint64_t bits = insn.bits() & ((1ULL << (8 * insn_length(insn.bits()))) - 1);
+  fprintf(stderr, "core %3d: 0x%016" PRIx64 " (0x%08" PRIx64 ") %s\n",
+          id, state.pc, bits, disassembler->disassemble(insn).c_str());
 }
 
 void processor_t::set_pcr(int which, reg_t val)
 {
   switch (which)
   {
-    case PCR_SR:
-      sr = (val & ~SR_IP) | (sr & SR_IP);
+    case CSR_FFLAGS:
+      state.fflags = val & (FSR_AEXC >> FSR_AEXC_SHIFT);
+      break;
+    case CSR_FRM:
+      state.frm = val & (FSR_RD >> FSR_RD_SHIFT);
+      break;
+    case CSR_FCSR:
+      state.fflags = (val & FSR_AEXC) >> FSR_AEXC_SHIFT;
+      state.frm = (val & FSR_RD) >> FSR_RD_SHIFT;
+      break;
+    case CSR_STATUS:
+      state.sr = (val & ~SR_IP) | (state.sr & SR_IP);
 #ifndef RISCV_ENABLE_64BIT
-      sr &= ~(SR_S64 | SR_U64);
+      state.sr &= ~(SR_S64 | SR_U64);
 #endif
 #ifndef RISCV_ENABLE_FPU
-      sr &= ~SR_EF;
-#endif
-#ifndef RISCV_ENABLE_VEC
-      sr &= ~SR_EV;
+      state.sr &= ~SR_EF;
 #endif
-      sr &= ~SR_ZERO;
-      mmu.flush_tlb();
+      if (!ext)
+        state.sr &= ~SR_EA;
+      state.sr &= ~SR_ZERO;
+      rv64 = (state.sr & SR_S) ? (state.sr & SR_S64) : (state.sr & SR_U64);
+      mmu->flush_tlb();
+      break;
+    case CSR_EPC:
+      state.epc = val;
       break;
-    case PCR_EPC:
-      epc = val;
+    case CSR_EVEC:
+      state.evec = val & ~3;
       break;
-    case PCR_EVEC: 
-      evec = val;
+    case CSR_COUNT:
+      state.count = val;
       break;
-    case PCR_COUNT:
-      count = val;
+    case CSR_COUNTH:
+      state.count = (val << 32) | (uint32_t)state.count;
       break;
-    case PCR_COMPARE:
+    case CSR_COMPARE:
+      serialize();
       set_interrupt(IRQ_TIMER, false);
-      compare = val;
+      state.compare = val;
       break;
-    case PCR_PTBR:
-      mmu.set_ptbr(val);
+    case CSR_PTBR:
+      state.ptbr = val & ~(PGSIZE-1);
       break;
-    case PCR_SEND_IPI:
-      sim.send_ipi(val);
+    case CSR_SEND_IPI:
+      sim->send_ipi(val);
       break;
-    case PCR_CLR_IPI:
+    case CSR_CLEAR_IPI:
       set_interrupt(IRQ_IPI, val & 1);
       break;
-    case PCR_K0:
-      pcr_k0 = val;
+    case CSR_SUP0:
+      state.pcr_k0 = val;
       break;
-    case PCR_K1:
-      pcr_k1 = val;
+    case CSR_SUP1:
+      state.pcr_k1 = val;
       break;
-    case PCR_TOHOST:
-      if (tohost == 0)
-        tohost = val;
+    case CSR_TOHOST:
+      if (state.tohost == 0)
+        state.tohost = val;
       break;
-    case PCR_FROMHOST:
-      set_interrupt(IRQ_HOST, val != 0);
-      fromhost = val;
+    case CSR_FROMHOST:
+      set_fromhost(val);
       break;
   }
 }
 
+void processor_t::set_fromhost(reg_t val)
+{
+  set_interrupt(IRQ_HOST, val != 0);
+  state.fromhost = val;
+}
+
 reg_t processor_t::get_pcr(int which)
 {
   switch (which)
   {
-    case PCR_SR:
-      return sr;
-    case PCR_EPC:
-      return epc;
-    case PCR_BADVADDR:
-      return badvaddr;
-    case PCR_EVEC:
-      return evec;
-    case PCR_COUNT:
-      return count;
-    case PCR_COMPARE:
-      return compare;
-    case PCR_CAUSE:
-      return cause;
-    case PCR_PTBR:
-      return mmu.get_ptbr();
-    case PCR_ASID:
+    case CSR_FFLAGS:
+      require_fp;
+      return state.fflags;
+    case CSR_FRM:
+      require_fp;
+      return state.frm;
+    case CSR_FCSR:
+      require_fp;
+      return (state.fflags << FSR_AEXC_SHIFT) | (state.frm << FSR_RD_SHIFT);
+    case CSR_STATUS:
+      return state.sr;
+    case CSR_EPC:
+      return state.epc;
+    case CSR_BADVADDR:
+      return state.badvaddr;
+    case CSR_EVEC:
+      return state.evec;
+    case CSR_CYCLE:
+    case CSR_TIME:
+    case CSR_INSTRET:
+    case CSR_COUNT:
+      serialize();
+      return state.count;
+    case CSR_CYCLEH:
+    case CSR_TIMEH:
+    case CSR_INSTRETH:
+    case CSR_COUNTH:
+      if (rv64)
+        break;
+      serialize();
+      return state.count >> 32;
+    case CSR_COMPARE:
+      return state.compare;
+    case CSR_CAUSE:
+      return state.cause;
+    case CSR_PTBR:
+      return state.ptbr;
+    case CSR_SEND_IPI:
+    case CSR_CLEAR_IPI:
+      return 0;
+    case CSR_ASID:
+      return 0;
+    case CSR_FATC:
+      mmu->flush_tlb();
       return 0;
-    case PCR_FATC:
-      mmu.flush_tlb();
-    case PCR_HARTID:
+    case CSR_HARTID:
       return id;
-    case PCR_IMPL:
+    case CSR_IMPL:
       return 1;
-    case PCR_K0:
-      return pcr_k0;
-    case PCR_K1:
-      return pcr_k1;
-    case PCR_TOHOST:
-      return tohost;
-    case PCR_FROMHOST:
-      return fromhost;
+    case CSR_SUP0:
+      return state.pcr_k0;
+    case CSR_SUP1:
+      return state.pcr_k1;
+    case CSR_TOHOST:
+      sim->get_htif()->tick(); // not necessary, but faster
+      return state.tohost;
+    case CSR_FROMHOST:
+      sim->get_htif()->tick(); // not necessary, but faster
+      return state.fromhost;
+    case CSR_UARCH0:
+    case CSR_UARCH1:
+    case CSR_UARCH2:
+    case CSR_UARCH3:
+    case CSR_UARCH4:
+    case CSR_UARCH5:
+    case CSR_UARCH6:
+    case CSR_UARCH7:
+    case CSR_UARCH8:
+    case CSR_UARCH9:
+    case CSR_UARCH10:
+    case CSR_UARCH11:
+    case CSR_UARCH12:
+    case CSR_UARCH13:
+    case CSR_UARCH14:
+    case CSR_UARCH15:
+      return 0;
   }
-  return -1;
+  throw trap_illegal_instruction();
 }
 
 void processor_t::set_interrupt(int which, bool on)
 {
   uint32_t mask = (1 << (which + SR_IP_SHIFT)) & SR_IP;
   if (on)
-    sr |= mask;
+    state.sr |= mask;
   else
-    sr &= ~mask;
+    state.sr &= ~mask;
+}
+
+reg_t illegal_instruction(processor_t* p, insn_t insn, reg_t pc)
+{
+  throw trap_illegal_instruction();
 }
 
 insn_func_t processor_t::decode_insn(insn_t insn)
 {
-  bool rv64 = (sr & SR_S) ? (sr & SR_S64) : (sr & SR_U64);
+  size_t mask = opcode_map.size()-1;
+  insn_desc_t* desc = opcode_map[insn.bits() & mask]; 
 
-  auto key = insn.bits & ((1L << opcode_bits)-1);
-  auto it = opcode_map.find(key);
-  for (auto it = opcode_map.find(key); it != opcode_map.end() && it->first == key; ++it)
-    if ((insn.bits & it->second.mask) == it->second.match)
-      return rv64 ? it->second.rv64 : it->second.rv32;
+  while ((insn.bits() & desc->mask) != desc->match)
+    desc++;
 
-  return &processor_t::illegal_instruction;
+  return rv64 ? desc->rv64 : desc->rv32;
 }
 
-reg_t processor_t::illegal_instruction(insn_t insn, reg_t pc)
+void processor_t::register_insn(insn_desc_t desc)
 {
-  throw trap_illegal_instruction;
+  assert(desc.mask & 1);
+  instructions.push_back(desc);
 }
 
-void processor_t::register_insn(uint32_t match, uint32_t mask, insn_func_t rv32, insn_func_t rv64)
+void processor_t::build_opcode_map()
 {
-  assert(mask & 1);
-  if (opcode_bits == 0 || (mask & ((1L << opcode_bits)-1)) != ((1L << opcode_bits)-1))
+  size_t buckets = -1;
+  for (auto& inst : instructions)
+    while ((inst.mask & buckets) != buckets)
+      buckets /= 2;
+  buckets++;
+
+  struct cmp {
+    decltype(insn_desc_t::match) mask;
+    cmp(decltype(mask) mask) : mask(mask) {}
+    bool operator()(const insn_desc_t& lhs, const insn_desc_t& rhs) {
+      if ((lhs.match & mask) != (rhs.match & mask))
+        return (lhs.match & mask) < (rhs.match & mask);
+      return lhs.match < rhs.match;
+    }
+  };
+  std::sort(instructions.begin(), instructions.end(), cmp(buckets-1));
+
+  opcode_map.resize(buckets);
+  opcode_store.resize(instructions.size() + 1);
+
+  size_t j = 0;
+  for (size_t b = 0, i = 0; b < buckets; b++)
   {
-    unsigned x = 0;
-    while ((mask & ((1L << (x+1))-1)) == ((1L << (x+1))-1) &&
-           (opcode_bits == 0 || x <= opcode_bits))
-      x++;
-    opcode_bits = x;
-
-    decltype(opcode_map) new_map;
-    for (auto it = opcode_map.begin(); it != opcode_map.end(); ++it)
-      new_map.insert(std::make_pair(it->second.match & ((1L<<x)-1), it->second));
-    opcode_map = new_map;
+    opcode_map[b] = &opcode_store[j];
+    while (i < instructions.size() && b == (instructions[i].match & (buckets-1)))
+      opcode_store[j++] = instructions[i++];
   }
 
-  opcode_map.insert(std::make_pair(match & ((1L<<opcode_bits)-1),
-    (opcode_map_entry_t){match, mask, rv32, rv64}));
+  assert(j == opcode_store.size()-1);
+  opcode_store[j].match = opcode_store[j].mask = 0;
+  opcode_store[j].rv32 = &illegal_instruction;
+  opcode_store[j].rv64 = &illegal_instruction;
+}
+
+void processor_t::register_extension(extension_t* x)
+{
+  for (auto insn : x->get_instructions())
+    register_insn(insn);
+  build_opcode_map();
+  for (auto disasm_insn : x->get_disasms())
+    disassembler->add_insn(disasm_insn);
+  if (ext != NULL)
+    throw std::logic_error("only one extension may be registered");
+  ext = x;
+  x->set_processor(this);
 }