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