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, "  --progsize=<words>    progsize for the debug module [default 2]\n");
  40   exit(1);
  41 }
  42
  43 static std::vector<std::pair<reg_t, mem_t*>> make_mems(const char* arg)
  44 {
  45   // handle legacy mem argument
  46   char* p;
  47   auto mb = strtoull(arg, &p, 0);
  48   if (*p == 0) {
  49     reg_t size = reg_t(mb) << 20;
  50     if (size != (size_t)size)
  51       throw std::runtime_error("Size would overflow size_t");
  52     return std::vector<std::pair<reg_t, mem_t*>>(1, std::make_pair(reg_t(DRAM_BASE), new mem_t(size)));
  53   }
  54
  55   // handle base/size tuples
  56   std::vector<std::pair<reg_t, mem_t*>> res;
  57   while (true) {
  58     auto base = strtoull(arg, &p, 0);
  59     if (!*p || *p != ':')
  60       help();
  61     auto size = strtoull(p + 1, &p, 0);
  62     if ((size | base) % PGSIZE != 0)
  63       help();
  64     res.push_back(std::make_pair(reg_t(base), new mem_t(size)));
  65     if (!*p)
  66       break;
  67     if (*p != ',')
  68       help();
  69     arg = p + 1;
  70   }
  71   return res;
  72 }
  73
  74 int main(int argc, char** argv)
  75 {
  76   bool debug = false;
  77   bool halted = false;
  78   bool histogram = false;
  79   bool log = false;
  80   bool dump_dts = false;
  81   size_t nprocs = 1;
  82   reg_t start_pc = reg_t(-1);
  83   std::vector<std::pair<reg_t, mem_t*>> mems;
  84   std::unique_ptr<icache_sim_t> ic;
  85   std::unique_ptr<dcache_sim_t> dc;
  86   std::unique_ptr<cache_sim_t> l2;
  87   std::function<extension_t*()> extension;
  88   const char* isa = DEFAULT_ISA;
  89   uint16_t rbb_port = 0;
  90   bool use_rbb = false;
  91   unsigned progsize = 2;
  92   std::vector<int> hartids;
  93
  94   auto const hartids_parser = [&](const char *s) {
  95     std::string const str(s);
  96     std::stringstream stream(str);
  97
  98     int n;
  99     while (stream >> n)
 100     {
 101       hartids.push_back(n);
 102       if (stream.peek() == ',') stream.ignore();
 103     }
 104   };
 105
 106   option_parser_t parser;
 107   parser.help(&help);
 108   parser.option('h', 0, 0, [&](const char* s){help();});
 109   parser.option('d', 0, 0, [&](const char* s){debug = true;});
 110   parser.option('g', 0, 0, [&](const char* s){histogram = true;});
 111   parser.option('l', 0, 0, [&](const char* s){log = true;});
 112   parser.option('p', 0, 1, [&](const char* s){nprocs = atoi(s);});
 113   parser.option('m', 0, 1, [&](const char* s){mems = make_mems(s);});
 114   // I wanted to use --halted, but for some reason that doesn't work.
 115   parser.option('H', 0, 0, [&](const char* s){halted = true;});
 116   parser.option(0, "rbb-port", 1, [&](const char* s){use_rbb = true; rbb_port = atoi(s);});
 117   parser.option(0, "pc", 1, [&](const char* s){start_pc = strtoull(s, 0, 0);});
 118   parser.option(0, "hartids", 1, hartids_parser);
 119   parser.option(0, "ic", 1, [&](const char* s){ic.reset(new icache_sim_t(s));});
 120   parser.option(0, "dc", 1, [&](const char* s){dc.reset(new dcache_sim_t(s));});
 121   parser.option(0, "l2", 1, [&](const char* s){l2.reset(cache_sim_t::construct(s, "L2$"));});
 122   parser.option(0, "isa", 1, [&](const char* s){isa = s;});
 123   parser.option(0, "extension", 1, [&](const char* s){extension = find_extension(s);});
 124   parser.option(0, "dump-dts", 0, [&](const char *s){dump_dts = true;});
 125   parser.option(0, "extlib", 1, [&](const char *s){
 126     void *lib = dlopen(s, RTLD_NOW | RTLD_GLOBAL);
 127     if (lib == NULL) {
 128       fprintf(stderr, "Unable to load extlib '%s': %s\n", s, dlerror());
 129       exit(-1);
 130     }
 131   });
 132   parser.option(0, "progsize", 1, [&](const char* s){progsize = atoi(s);});
 133
 134   auto argv1 = parser.parse(argv);
 135   std::vector<std::string> htif_args(argv1, (const char*const*)argv + argc);
 136   if (mems.empty())
 137     mems = make_mems("2048");
 138
 139   sim_t s(isa, nprocs, halted, start_pc, mems, htif_args, std::move(hartids),
 140       progsize);
 141   std::unique_ptr<remote_bitbang_t> remote_bitbang((remote_bitbang_t *) NULL);
 142   std::unique_ptr<jtag_dtm_t> jtag_dtm(new jtag_dtm_t(&s.debug_module));
 143   if (use_rbb) {
 144     remote_bitbang.reset(new remote_bitbang_t(rbb_port, &(*jtag_dtm)));
 145     s.set_remote_bitbang(&(*remote_bitbang));
 146   }
 147
 148   if (dump_dts) {
 149     printf("%s", s.get_dts());
 150     return 0;
 151   }
 152
 153   if (!*argv1)
 154     help();
 155
 156   if (ic && l2) ic->set_miss_handler(&*l2);
 157   if (dc && l2) dc->set_miss_handler(&*l2);
 158   for (size_t i = 0; i < nprocs; i++)
 159   {
 160     if (ic) s.get_core(i)->get_mmu()->register_memtracer(&*ic);
 161     if (dc) s.get_core(i)->get_mmu()->register_memtracer(&*dc);
 162     if (extension) s.get_core(i)->register_extension(extension());
 163   }
 164
 165   s.set_debug(debug);
 166   s.set_log(log);
 167   s.set_histogram(histogram);
 168   return s.run();
 169 }