spike_main/spike.cc

   1 // See LICENSE for license details.
   2
   3 #include "sim.h"
   4 #include "mmu.h"
   5 #include "remote_bitbang.h"
   6 #include "cachesim.h"
   7 #include "extension.h"
   8 #include <dlfcn.h>
   9 #include <fesvr/option_parser.h>
  10 #include <stdio.h>
  11 #include <stdlib.h>
  12 #include <vector>
  13 #include <string>
  14 #include <memory>
  15
  16 static void help()
  17 {
  18   fprintf(stderr, "usage: spike [host options] <target program> [target options]\n");
  19   fprintf(stderr, "Host Options:\n");
  20   fprintf(stderr, "  -p<n>                 Simulate <n> processors [default 1]\n");
  21   fprintf(stderr, "  -m<n>                 Provide <n> MiB of target memory [default 2048]\n");
  22   fprintf(stderr, "  -m<a:m,b:n,...>       Provide memory regions of size m and n bytes\n");
  23   fprintf(stderr, "                          at base addresses a and b (with 4 KiB alignment)\n");
  24   fprintf(stderr, "  -d                    Interactive debug mode\n");
  25   fprintf(stderr, "  -g                    Track histogram of PCs\n");
  26   fprintf(stderr, "  -l                    Generate a log of execution\n");
  27   fprintf(stderr, "  -h                    Print this help message\n");
  28   fprintf(stderr, "  -H                    Start halted, allowing a debugger to connect\n");
  29   fprintf(stderr, "  --isa=<name>          RISC-V ISA string [default %s]\n", DEFAULT_ISA);
  30   fprintf(stderr, "  --pc=<address>        Override ELF entry point\n");
  31   fprintf(stderr, "  --hartids=<a,b,...>   Explicitly specify hartids, default is 0,1,...\n");
  32   fprintf(stderr, "  --ic=<S>:<W>:<B>      Instantiate a cache model with S sets,\n");
  33   fprintf(stderr, "  --dc=<S>:<W>:<B>        W ways, and B-byte blocks (with S and\n");
  34   fprintf(stderr, "  --l2=<S>:<W>:<B>        B both powers of 2).\n");
  35   fprintf(stderr, "  --extension=<name>    Specify RoCC Extension\n");
  36   fprintf(stderr, "  --extlib=<name>       Shared library to load\n");
  37   fprintf(stderr, "  --rbb-port=<port>     Listen on <port> for remote bitbang connection\n");
  38   fprintf(stderr, "  --dump-dts            Print device tree string and exit\n");
  39   fprintf(stderr, "  --disable-dtb         Don't write the device tree blob into memory\n");
  40   fprintf(stderr, "  --progsize=<words>    Progsize for the debug module [default 2]\n");
  41   fprintf(stderr, "  --debug-sba=<bits>    Debug bus master supports up to "
  42       "<bits> wide accesses [default 0]\n");
  43   fprintf(stderr, "  --debug-auth          Debug module requires debugger to authenticate\n");
  44   exit(1);
  45 }
  46
  47 static std::vector<std::pair<reg_t, mem_t*>> make_mems(const char* arg)
  48 {
  49   // handle legacy mem argument
  50   char* p;
  51   auto mb = strtoull(arg, &p, 0);
  52   if (*p == 0) {
  53     reg_t size = reg_t(mb) << 20;
  54     if (size != (size_t)size)
  55       throw std::runtime_error("Size would overflow size_t");
  56     return std::vector<std::pair<reg_t, mem_t*>>(1, std::make_pair(reg_t(DRAM_BASE), new mem_t(size)));
  57   }
  58
  59   // handle base/size tuples
  60   std::vector<std::pair<reg_t, mem_t*>> res;
  61   while (true) {
  62     auto base = strtoull(arg, &p, 0);
  63     if (!*p || *p != ':')
  64       help();
  65     auto size = strtoull(p + 1, &p, 0);
  66     if ((size | base) % PGSIZE != 0)
  67       help();
  68     res.push_back(std::make_pair(reg_t(base), new mem_t(size)));
  69     if (!*p)
  70       break;
  71     if (*p != ',')
  72       help();
  73     arg = p + 1;
  74   }
  75   return res;
  76 }
  77
  78 int main(int argc, char** argv)
  79 {
  80   bool debug = false;
  81   bool halted = false;
  82   bool histogram = false;
  83   bool log = false;
  84   bool dump_dts = false;
  85   bool dtb_enabled = true;
  86   size_t nprocs = 1;
  87   reg_t start_pc = reg_t(-1);
  88   std::vector<std::pair<reg_t, mem_t*>> mems;
  89   std::unique_ptr<icache_sim_t> ic;
  90   std::unique_ptr<dcache_sim_t> dc;
  91   std::unique_ptr<cache_sim_t> l2;
  92   std::function<extension_t*()> extension;
  93   const char* isa = DEFAULT_ISA;
  94   uint16_t rbb_port = 0;
  95   bool use_rbb = false;
  96   unsigned progsize = 2;
  97   unsigned max_bus_master_bits = 0;
  98   bool require_authentication = false;
  99   std::vector<int> hartids;
 100
 101   auto const hartids_parser = [&](const char *s) {
 102     std::string const str(s);
 103     std::stringstream stream(str);
 104
 105     int n;
 106     while (stream >> n)
 107     {
 108       hartids.push_back(n);
 109       if (stream.peek() == ',') stream.ignore();
 110     }
 111   };
 112
 113   option_parser_t parser;
 114   parser.help(&help);
 115   parser.option('h', 0, 0, [&](const char* s){help();});
 116   parser.option('d', 0, 0, [&](const char* s){debug = true;});
 117   parser.option('g', 0, 0, [&](const char* s){histogram = true;});
 118   parser.option('l', 0, 0, [&](const char* s){log = true;});
 119   parser.option('p', 0, 1, [&](const char* s){nprocs = atoi(s);});
 120   parser.option('m', 0, 1, [&](const char* s){mems = make_mems(s);});
 121   // I wanted to use --halted, but for some reason that doesn't work.
 122   parser.option('H', 0, 0, [&](const char* s){halted = true;});
 123   parser.option(0, "rbb-port", 1, [&](const char* s){use_rbb = true; rbb_port = atoi(s);});
 124   parser.option(0, "pc", 1, [&](const char* s){start_pc = strtoull(s, 0, 0);});
 125   parser.option(0, "hartids", 1, hartids_parser);
 126   parser.option(0, "ic", 1, [&](const char* s){ic.reset(new icache_sim_t(s));});
 127   parser.option(0, "dc", 1, [&](const char* s){dc.reset(new dcache_sim_t(s));});
 128   parser.option(0, "l2", 1, [&](const char* s){l2.reset(cache_sim_t::construct(s, "L2$"));});
 129   parser.option(0, "isa", 1, [&](const char* s){isa = s;});
 130   parser.option(0, "extension", 1, [&](const char* s){extension = find_extension(s);});
 131   parser.option(0, "dump-dts", 0, [&](const char *s){dump_dts = true;});
 132   parser.option(0, "disable-dtb", 0, [&](const char *s){dtb_enabled = false;});
 133   parser.option(0, "extlib", 1, [&](const char *s){
 134     void *lib = dlopen(s, RTLD_NOW | RTLD_GLOBAL);
 135     if (lib == NULL) {
 136       fprintf(stderr, "Unable to load extlib '%s': %s\n", s, dlerror());
 137       exit(-1);
 138     }
 139   });
 140   parser.option(0, "progsize", 1, [&](const char* s){progsize = atoi(s);});
 141   parser.option(0, "debug-sba", 1,
 142       [&](const char* s){max_bus_master_bits = atoi(s);});
 143   parser.option(0, "debug-auth", 0,
 144       [&](const char* s){require_authentication = true;});
 145
 146   auto argv1 = parser.parse(argv);
 147   std::vector<std::string> htif_args(argv1, (const char*const*)argv + argc);
 148   if (mems.empty())
 149     mems = make_mems("2048");
 150
 151   if (!*argv1)
 152     help();
 153
 154   sim_t s(isa, nprocs, halted, start_pc, mems, htif_args, std::move(hartids),
 155       progsize, max_bus_master_bits, require_authentication);
 156   std::unique_ptr<remote_bitbang_t> remote_bitbang((remote_bitbang_t *) NULL);
 157   std::unique_ptr<jtag_dtm_t> jtag_dtm(new jtag_dtm_t(&s.debug_module));
 158   if (use_rbb) {
 159     remote_bitbang.reset(new remote_bitbang_t(rbb_port, &(*jtag_dtm)));
 160     s.set_remote_bitbang(&(*remote_bitbang));
 161   }
 162   s.set_dtb_enabled(dtb_enabled);
 163
 164   if (dump_dts) {
 165     printf("%s", s.get_dts());
 166     return 0;
 167   }
 168
 169   if (ic && l2) ic->set_miss_handler(&*l2);
 170   if (dc && l2) dc->set_miss_handler(&*l2);
 171   for (size_t i = 0; i < nprocs; i++)
 172   {
 173     if (ic) s.get_core(i)->get_mmu()->register_memtracer(&*ic);
 174     if (dc) s.get_core(i)->get_mmu()->register_memtracer(&*dc);
 175     if (extension) s.get_core(i)->register_extension(extension());
 176   }
 177
 178   s.set_debug(debug);
 179   s.set_log(log);
 180   s.set_histogram(histogram);
 181   return s.run();
 182 }