riscv/processor.cc

   1 // See LICENSE for license details.
   2
   3 #include "processor.h"
   4 #include "extension.h"
   5 #include "common.h"
   6 #include "config.h"
   7 #include "sim.h"
   8 #include "mmu.h"
   9 #include "htif.h"
  10 #include "disasm.h"
  11 #include <cinttypes>
  12 #include <cmath>
  13 #include <cstdlib>
  14 #include <iostream>
  15 #include <assert.h>
  16 #include <limits.h>
  17 #include <stdexcept>
  18 #include <algorithm>
  19
  20 #undef STATE
  21 #define STATE state
  22
  23 processor_t::processor_t(const char* isa, sim_t* sim, uint32_t id)
  24   : sim(sim), ext(NULL), disassembler(new disassembler_t),
  25     id(id), run(false), debug(false)
  26 {
  27   parse_isa_string(isa);
  28
  29   mmu = new mmu_t(sim, this);
  30
  31   reset(true);
  32
  33   register_base_instructions();
  34 }
  35
  36 processor_t::~processor_t()
  37 {
  38 #ifdef RISCV_ENABLE_HISTOGRAM
  39   if (histogram_enabled)
  40   {
  41     fprintf(stderr, "PC Histogram size:%zu\n", pc_histogram.size());
  42     for (auto it : pc_histogram)
  43       fprintf(stderr, "%0" PRIx64 " %" PRIu64 "\n", it.first, it.second);
  44   }
  45 #endif
  46
  47   delete mmu;
  48   delete disassembler;
  49 }
  50
  51 static void bad_isa_string(const char* isa)
  52 {
  53   fprintf(stderr, "error: bad --isa option %s\n", isa);
  54   abort();
  55 }
  56
  57 void processor_t::parse_isa_string(const char* str)
  58 {
  59   std::string lowercase, tmp;
  60   for (const char *r = str; *r; r++)
  61     lowercase += std::tolower(*r);
  62
  63   const char* p = lowercase.c_str();
  64   const char* all_subsets = "imafdc";
  65
  66   max_xlen = 64;
  67   isa = reg_t(2) << 62;
  68
  69   if (strncmp(p, "rv32", 4) == 0)
  70     max_xlen = 32, isa = reg_t(1) << 30, p += 4;
  71   else if (strncmp(p, "rv64", 4) == 0)
  72     p += 4;
  73   else if (strncmp(p, "rv", 2) == 0)
  74     p += 2;
  75
  76   if (!*p) {
  77     p = all_subsets;
  78   } else if (*p == 'g') { // treat "G" as "IMAFD"
  79     tmp = std::string("imafd") + (p+1);
  80     p = &tmp[0];
  81   } else if (*p != 'i') {
  82     bad_isa_string(str);
  83   }
  84
  85   isa_string = "rv" + std::to_string(max_xlen) + p;
  86   isa |= 1L << ('s' - 'a'); // advertise support for supervisor mode
  87
  88   while (*p) {
  89     isa |= 1L << (*p - 'a');
  90
  91     if (auto next = strchr(all_subsets, *p)) {
  92       all_subsets = next + 1;
  93       p++;
  94     } else if (*p == 'x') {
  95       const char* ext = p+1, *end = ext;
  96       while (islower(*end))
  97         end++;
  98       register_extension(find_extension(std::string(ext, end - ext).c_str())());
  99       p = end;
 100     } else {
 101       bad_isa_string(str);
 102     }
 103   }
 104
 105   if (supports_extension('D') && !supports_extension('F'))
 106     bad_isa_string(str);
 107
 108   // advertise support for supervisor and user modes
 109   isa |= 1L << ('s' - 'a');
 110   isa |= 1L << ('u' - 'a');
 111 }
 112
 113 void state_t::reset()
 114 {
 115   memset(this, 0, sizeof(*this));
 116   prv = PRV_M;
 117   pc = DEFAULT_RSTVEC;
 118   mtvec = DEFAULT_MTVEC;
 119   load_reservation = -1;
 120 }
 121
 122 void processor_t::set_debug(bool value)
 123 {
 124   debug = value;
 125   if (ext)
 126     ext->set_debug(value);
 127 }
 128
 129 void processor_t::set_histogram(bool value)
 130 {
 131   histogram_enabled = value;
 132 #ifndef RISCV_ENABLE_HISTOGRAM
 133   if (value) {
 134     fprintf(stderr, "PC Histogram support has not been properly enabled;");
 135     fprintf(stderr, " please re-build the riscv-isa-run project using \"configure --enable-histogram\".\n");
 136   }
 137 #endif
 138 }
 139
 140 void processor_t::reset(bool value)
 141 {
 142   if (run == !value)
 143     return;
 144   run = !value;
 145
 146   state.reset();
 147   set_csr(CSR_MSTATUS, state.mstatus);
 148
 149   if (ext)
 150     ext->reset(); // reset the extension
 151 }
 152
 153 void processor_t::raise_interrupt(reg_t which)
 154 {
 155   throw trap_t(((reg_t)1 << (max_xlen-1)) | which);
 156 }
 157
 158 static int ctz(reg_t val)
 159 {
 160   int res = 0;
 161   if (val)
 162     while ((val & 1) == 0)
 163       val >>= 1, res++;
 164   return res;
 165 }
 166
 167 void processor_t::take_interrupt()
 168 {
 169   reg_t pending_interrupts = state.mip & state.mie;
 170
 171   reg_t mie = get_field(state.mstatus, MSTATUS_MIE);
 172   reg_t m_enabled = state.prv < PRV_M || (state.prv == PRV_M && mie);
 173   reg_t enabled_interrupts = pending_interrupts & ~state.mideleg & -m_enabled;
 174
 175   reg_t sie = get_field(state.mstatus, MSTATUS_SIE);
 176   reg_t s_enabled = state.prv < PRV_S || (state.prv == PRV_S && sie);
 177   enabled_interrupts |= pending_interrupts & state.mideleg & -s_enabled;
 178
 179   if (enabled_interrupts)
 180     raise_interrupt(ctz(enabled_interrupts));
 181 }
 182
 183 static bool validate_priv(reg_t priv)
 184 {
 185   return priv == PRV_U || priv == PRV_S || priv == PRV_M;
 186 }
 187
 188 void processor_t::set_privilege(reg_t prv)
 189 {
 190   assert(validate_priv(prv));
 191   mmu->flush_tlb();
 192   state.prv = prv;
 193 }
 194
 195 void processor_t::take_trap(trap_t& t, reg_t epc)
 196 {
 197   if (debug)
 198     fprintf(stderr, "core %3d: exception %s, epc 0x%016" PRIx64 "\n",
 199             id, t.name(), epc);
 200
 201   // by default, trap to M-mode, unless delegated to S-mode
 202   reg_t bit = t.cause();
 203   reg_t deleg = state.medeleg;
 204   if (bit & ((reg_t)1 << (max_xlen-1)))
 205     deleg = state.mideleg, bit &= ~((reg_t)1 << (max_xlen-1));
 206   if (state.prv <= PRV_S && bit < max_xlen && ((deleg >> bit) & 1)) {
 207     // handle the trap in S-mode
 208     state.pc = state.stvec;
 209     state.scause = t.cause();
 210     state.sepc = epc;
 211     if (t.has_badaddr())
 212       state.sbadaddr = t.get_badaddr();
 213
 214     reg_t s = state.mstatus;
 215     s = set_field(s, MSTATUS_SPIE, get_field(s, MSTATUS_UIE << state.prv));
 216     s = set_field(s, MSTATUS_SPP, state.prv);
 217     s = set_field(s, MSTATUS_SIE, 0);
 218     set_csr(CSR_MSTATUS, s);
 219     set_privilege(PRV_S);
 220   } else {
 221     state.pc = state.mtvec;
 222     state.mcause = t.cause();
 223     state.mepc = epc;
 224     if (t.has_badaddr())
 225       state.mbadaddr = t.get_badaddr();
 226
 227     reg_t s = state.mstatus;
 228     s = set_field(s, MSTATUS_MPIE, get_field(s, MSTATUS_UIE << state.prv));
 229     s = set_field(s, MSTATUS_MPP, state.prv);
 230     s = set_field(s, MSTATUS_MIE, 0);
 231     set_csr(CSR_MSTATUS, s);
 232     set_privilege(PRV_M);
 233   }
 234
 235   yield_load_reservation();
 236 }
 237
 238 void processor_t::disasm(insn_t insn)
 239 {
 240   uint64_t bits = insn.bits() & ((1ULL << (8 * insn_length(insn.bits()))) - 1);
 241   fprintf(stderr, "core %3d: 0x%016" PRIx64 " (0x%08" PRIx64 ") %s\n",
 242           id, state.pc, bits, disassembler->disassemble(insn).c_str());
 243 }
 244
 245 static bool validate_vm(int max_xlen, reg_t vm)
 246 {
 247   if (max_xlen == 64 && (vm == VM_SV39 || vm == VM_SV48))
 248     return true;
 249   if (max_xlen == 32 && vm == VM_SV32)
 250     return true;
 251   return vm == VM_MBARE;
 252 }
 253
 254 void processor_t::set_csr(int which, reg_t val)
 255 {
 256   val = zext_xlen(val);
 257   reg_t delegable_ints = MIP_SSIP | MIP_STIP | (1 << IRQ_HOST) | (1 << IRQ_COP);
 258   reg_t all_ints = delegable_ints | MIP_MSIP | MIP_MTIP;
 259   switch (which)
 260   {
 261     case CSR_FFLAGS:
 262       dirty_fp_state;
 263       state.fflags = val & (FSR_AEXC >> FSR_AEXC_SHIFT);
 264       break;
 265     case CSR_FRM:
 266       dirty_fp_state;
 267       state.frm = val & (FSR_RD >> FSR_RD_SHIFT);
 268       break;
 269     case CSR_FCSR:
 270       dirty_fp_state;
 271       state.fflags = (val & FSR_AEXC) >> FSR_AEXC_SHIFT;
 272       state.frm = (val & FSR_RD) >> FSR_RD_SHIFT;
 273       break;
 274     case CSR_MSTATUS: {
 275       if ((val ^ state.mstatus) &
 276           (MSTATUS_VM | MSTATUS_MPP | MSTATUS_MPRV | MSTATUS_PUM))
 277         mmu->flush_tlb();
 278
 279       reg_t mask = MSTATUS_SIE | MSTATUS_SPIE | MSTATUS_MIE | MSTATUS_MPIE
 280                  | MSTATUS_SPP | MSTATUS_FS | MSTATUS_MPRV | MSTATUS_PUM
 281                  | (ext ? MSTATUS_XS : 0);
 282
 283       if (validate_vm(max_xlen, get_field(val, MSTATUS_VM)))
 284         mask |= MSTATUS_VM;
 285       if (validate_priv(get_field(val, MSTATUS_MPP)))
 286         mask |= MSTATUS_MPP;
 287
 288       state.mstatus = (state.mstatus & ~mask) | (val & mask);
 289
 290       bool dirty = (state.mstatus & MSTATUS_FS) == MSTATUS_FS;
 291       dirty |= (state.mstatus & MSTATUS_XS) == MSTATUS_XS;
 292       if (max_xlen == 32)
 293         state.mstatus = set_field(state.mstatus, MSTATUS32_SD, dirty);
 294       else
 295         state.mstatus = set_field(state.mstatus, MSTATUS64_SD, dirty);
 296
 297       // spike supports the notion of xlen < max_xlen, but current priv spec
 298       // doesn't provide a mechanism to run RV32 software on an RV64 machine
 299       xlen = max_xlen;
 300       break;
 301     }
 302     case CSR_MIP: {
 303       reg_t mask = MIP_SSIP | MIP_STIP | MIP_MSIP;
 304       state.mip = (state.mip & ~mask) | (val & mask);
 305       break;
 306     }
 307     case CSR_MIPI:
 308       state.mip = set_field(state.mip, MIP_MSIP, val & 1);
 309       break;
 310     case CSR_MIE:
 311       state.mie = (state.mie & ~all_ints) | (val & all_ints);
 312       break;
 313     case CSR_MIDELEG:
 314       state.mideleg = (state.mideleg & ~delegable_ints) | (val & delegable_ints);
 315       break;
 316     case CSR_MEDELEG: {
 317       reg_t mask = 0;
 318 #define DECLARE_CAUSE(name, value) mask |= 1ULL << (value);
 319 #include "encoding.h"
 320 #undef DECLARE_CAUSE
 321       state.medeleg = (state.medeleg & ~mask) | (val & mask);
 322       break;
 323     }
 324     case CSR_MUCOUNTEREN:
 325       state.mucounteren = val & 7;
 326       break;
 327     case CSR_MSCOUNTEREN:
 328       state.mscounteren = val & 7;
 329       break;
 330     case CSR_SSTATUS: {
 331       reg_t mask = SSTATUS_SIE | SSTATUS_SPIE | SSTATUS_SPP | SSTATUS_FS
 332                  | SSTATUS_XS | SSTATUS_PUM;
 333       return set_csr(CSR_MSTATUS, (state.mstatus & ~mask) | (val & mask));
 334     }
 335     case CSR_SIP:
 336       return set_csr(CSR_MIP,
 337                      (state.mip & ~state.mideleg) | (val & state.mideleg));
 338     case CSR_SIE:
 339       return set_csr(CSR_MIE,
 340                      (state.mie & ~state.mideleg) | (val & state.mideleg));
 341     case CSR_SEPC: state.sepc = val; break;
 342     case CSR_STVEC: state.stvec = val >> 2 << 2; break;
 343     case CSR_SPTBR: state.sptbr = val; break;
 344     case CSR_SSCRATCH: state.sscratch = val; break;
 345     case CSR_SCAUSE: state.scause = val; break;
 346     case CSR_SBADADDR: state.sbadaddr = val; break;
 347     case CSR_MEPC: state.mepc = val; break;
 348     case CSR_MTVEC: state.mtvec = val >> 2 << 2; break;
 349     case CSR_MSCRATCH: state.mscratch = val; break;
 350     case CSR_MCAUSE: state.mcause = val; break;
 351     case CSR_MBADADDR: state.mbadaddr = val; break;
 352     case CSR_MTOHOST:
 353       if (state.tohost == 0)
 354         state.tohost = val;
 355       break;
 356     case CSR_MFROMHOST:
 357       state.mip = (state.mip & ~(1 << IRQ_HOST)) | (val ? (1 << IRQ_HOST) : 0);
 358       state.fromhost = val;
 359       break;
 360   }
 361 }
 362
 363 reg_t processor_t::get_csr(int which)
 364 {
 365   switch (which)
 366   {
 367     case CSR_FFLAGS:
 368       require_fp;
 369       if (!supports_extension('F'))
 370         break;
 371       return state.fflags;
 372     case CSR_FRM:
 373       require_fp;
 374       if (!supports_extension('F'))
 375         break;
 376       return state.frm;
 377     case CSR_FCSR:
 378       require_fp;
 379       if (!supports_extension('F'))
 380         break;
 381       return (state.fflags << FSR_AEXC_SHIFT) | (state.frm << FSR_RD_SHIFT);
 382     case CSR_TIME:
 383     case CSR_INSTRET:
 384     case CSR_CYCLE:
 385       if ((state.mucounteren >> (which & (xlen-1))) & 1)
 386         return get_csr(which + (CSR_MCYCLE - CSR_CYCLE));
 387       break;
 388     case CSR_STIME:
 389     case CSR_SINSTRET:
 390     case CSR_SCYCLE:
 391       if ((state.mscounteren >> (which & (xlen-1))) & 1)
 392         return get_csr(which + (CSR_MCYCLE - CSR_SCYCLE));
 393       break;
 394     case CSR_MUCOUNTEREN: return state.mucounteren;
 395     case CSR_MSCOUNTEREN: return state.mscounteren;
 396     case CSR_MUCYCLE_DELTA: return 0;
 397     case CSR_MUTIME_DELTA: return 0;
 398     case CSR_MUINSTRET_DELTA: return 0;
 399     case CSR_MSCYCLE_DELTA: return 0;
 400     case CSR_MSTIME_DELTA: return 0;
 401     case CSR_MSINSTRET_DELTA: return 0;
 402     case CSR_MUCYCLE_DELTAH: if (xlen > 32) break; else return 0;
 403     case CSR_MUTIME_DELTAH: if (xlen > 32) break; else return 0;
 404     case CSR_MUINSTRET_DELTAH: if (xlen > 32) break; else return 0;
 405     case CSR_MSCYCLE_DELTAH: if (xlen > 32) break; else return 0;
 406     case CSR_MSTIME_DELTAH: if (xlen > 32) break; else return 0;
 407     case CSR_MSINSTRET_DELTAH: if (xlen > 32) break; else return 0;
 408     case CSR_MCYCLE: return state.minstret;
 409     case CSR_MINSTRET: return state.minstret;
 410     case CSR_MCYCLEH: if (xlen > 32) break; else return state.minstret >> 32;
 411     case CSR_MINSTRETH: if (xlen > 32) break; else return state.minstret >> 32;
 412     case CSR_SSTATUS: {
 413       reg_t mask = SSTATUS_SIE | SSTATUS_SPIE | SSTATUS_SPP | SSTATUS_FS
 414                  | SSTATUS_XS | SSTATUS_PUM;
 415       reg_t sstatus = state.mstatus & mask;
 416       if ((sstatus & SSTATUS_FS) == SSTATUS_FS ||
 417           (sstatus & SSTATUS_XS) == SSTATUS_XS)
 418         sstatus |= (xlen == 32 ? SSTATUS32_SD : SSTATUS64_SD);
 419       return sstatus;
 420     }
 421     case CSR_SIP: return state.mip & state.mideleg;
 422     case CSR_SIE: return state.mie & state.mideleg;
 423     case CSR_SEPC: return state.sepc;
 424     case CSR_SBADADDR: return state.sbadaddr;
 425     case CSR_STVEC: return state.stvec;
 426     case CSR_SCAUSE:
 427       if (max_xlen > xlen)
 428         return state.scause | ((state.scause >> (max_xlen-1)) << (xlen-1));
 429       return state.scause;
 430     case CSR_SPTBR: return state.sptbr;
 431     case CSR_SASID: return 0;
 432     case CSR_SSCRATCH: return state.sscratch;
 433     case CSR_MSTATUS: return state.mstatus;
 434     case CSR_MIP: return state.mip;
 435     case CSR_MIPI: return 0;
 436     case CSR_MIE: return state.mie;
 437     case CSR_MEPC: return state.mepc;
 438     case CSR_MSCRATCH: return state.mscratch;
 439     case CSR_MCAUSE: return state.mcause;
 440     case CSR_MBADADDR: return state.mbadaddr;
 441     case CSR_MISA: return isa;
 442     case CSR_MARCHID: return 0;
 443     case CSR_MIMPID: return 0;
 444     case CSR_MVENDORID: return 0;
 445     case CSR_MHARTID: return id;
 446     case CSR_MTVEC: return state.mtvec;
 447     case CSR_MEDELEG: return state.medeleg;
 448     case CSR_MIDELEG: return state.mideleg;
 449     case CSR_MTOHOST:
 450       sim->get_htif()->tick(); // not necessary, but faster
 451       return state.tohost;
 452     case CSR_MFROMHOST:
 453       sim->get_htif()->tick(); // not necessary, but faster
 454       return state.fromhost;
 455   }
 456   throw trap_illegal_instruction();
 457 }
 458
 459 reg_t illegal_instruction(processor_t* p, insn_t insn, reg_t pc)
 460 {
 461   throw trap_illegal_instruction();
 462 }
 463
 464 insn_func_t processor_t::decode_insn(insn_t insn)
 465 {
 466   // look up opcode in hash table
 467   size_t idx = insn.bits() % OPCODE_CACHE_SIZE;
 468   insn_desc_t desc = opcode_cache[idx];
 469
 470   if (unlikely(insn.bits() != desc.match)) {
 471     // fall back to linear search
 472     insn_desc_t* p = &instructions[0];
 473     while ((insn.bits() & p->mask) != p->match)
 474       p++;
 475     desc = *p;
 476
 477     if (p->mask != 0 && p > &instructions[0]) {
 478       if (p->match != (p-1)->match && p->match != (p+1)->match) {
 479         // move to front of opcode list to reduce miss penalty
 480         while (--p >= &instructions[0])
 481           *(p+1) = *p;
 482         instructions[0] = desc;
 483       }
 484     }
 485
 486     opcode_cache[idx] = desc;
 487     opcode_cache[idx].match = insn.bits();
 488   }
 489
 490   return xlen == 64 ? desc.rv64 : desc.rv32;
 491 }
 492
 493 void processor_t::register_insn(insn_desc_t desc)
 494 {
 495   instructions.push_back(desc);
 496 }
 497
 498 void processor_t::build_opcode_map()
 499 {
 500   struct cmp {
 501     bool operator()(const insn_desc_t& lhs, const insn_desc_t& rhs) {
 502       if (lhs.match == rhs.match)
 503         return lhs.mask > rhs.mask;
 504       return lhs.match > rhs.match;
 505     }
 506   };
 507   std::sort(instructions.begin(), instructions.end(), cmp());
 508
 509   for (size_t i = 0; i < OPCODE_CACHE_SIZE; i++)
 510     opcode_cache[i] = {1, 0, &illegal_instruction, &illegal_instruction};
 511 }
 512
 513 void processor_t::register_extension(extension_t* x)
 514 {
 515   for (auto insn : x->get_instructions())
 516     register_insn(insn);
 517   build_opcode_map();
 518   for (auto disasm_insn : x->get_disasms())
 519     disassembler->add_insn(disasm_insn);
 520   if (ext != NULL)
 521     throw std::logic_error("only one extension may be registered");
 522   ext = x;
 523   x->set_processor(this);
 524 }
 525
 526 void processor_t::register_base_instructions()
 527 {
 528   #define DECLARE_INSN(name, match, mask) \
 529     insn_bits_t name##_match = (match), name##_mask = (mask);
 530   #include "encoding.h"
 531   #undef DECLARE_INSN
 532
 533   #define DEFINE_INSN(name) \
 534     REGISTER_INSN(this, name, name##_match, name##_mask)
 535   #include "insn_list.h"
 536   #undef DEFINE_INSN
 537
 538   register_insn({0, 0, &illegal_instruction, &illegal_instruction});
 539   build_opcode_map();
 540 }
 541
 542 bool processor_t::load(reg_t addr, size_t len, uint8_t* bytes)
 543 {
 544   try {
 545     auto res = get_csr(addr / (max_xlen / 8));
 546     memcpy(bytes, &res, len);
 547     return true;
 548   } catch (trap_illegal_instruction& t) {
 549     return false;
 550   }
 551 }
 552
 553 bool processor_t::store(reg_t addr, size_t len, const uint8_t* bytes)
 554 {
 555   try {
 556     reg_t value = 0;
 557     memcpy(&value, bytes, len);
 558     set_csr(addr / (max_xlen / 8), value);
 559     return true;
 560   } catch (trap_illegal_instruction& t) {
 561     return false;
 562   }
 563 }