Minor usability improvements (#48)
[riscv-isa-sim.git] / spike_main / spike.cc
1 // See LICENSE for license details.
2
3 #include "sim.h"
4 #include "mmu.h"
5 #include "gdbserver.h"
6 #include "htif.h"
7 #include "cachesim.h"
8 #include "extension.h"
9 #include <dlfcn.h>
10 #include <fesvr/option_parser.h>
11 #include <stdio.h>
12 #include <stdlib.h>
13 #include <vector>
14 #include <string>
15 #include <memory>
16
17 static void help()
18 {
19 fprintf(stderr, "usage: spike [host options] <target program> [target options]\n");
20 fprintf(stderr, "Host Options:\n");
21 fprintf(stderr, " -p<n> Simulate <n> processors [default 1]\n");
22 fprintf(stderr, " -m<n> Provide <n> MiB of target memory [default 4096]\n");
23 fprintf(stderr, " -d Interactive debug mode\n");
24 fprintf(stderr, " -g Track histogram of PCs\n");
25 fprintf(stderr, " -l Generate a log of execution\n");
26 fprintf(stderr, " -h Print this help message\n");
27 fprintf(stderr, " -H Start halted, allowing a debugger to connect\n");
28 fprintf(stderr, " --isa=<name> RISC-V ISA string [default %s]\n", DEFAULT_ISA);
29 fprintf(stderr, " --ic=<S>:<W>:<B> Instantiate a cache model with S sets,\n");
30 fprintf(stderr, " --dc=<S>:<W>:<B> W ways, and B-byte blocks (with S and\n");
31 fprintf(stderr, " --l2=<S>:<W>:<B> B both powers of 2).\n");
32 fprintf(stderr, " --extension=<name> Specify RoCC Extension\n");
33 fprintf(stderr, " --extlib=<name> Shared library to load\n");
34 fprintf(stderr, " --gdb-port=<port> Listen on <port> for gdb to connect\n");
35 fprintf(stderr, " --dump-config-string Print platform configuration string and exit\n");
36 exit(1);
37 }
38
39 int main(int argc, char** argv)
40 {
41 bool debug = false;
42 bool halted = false;
43 bool histogram = false;
44 bool log = false;
45 bool dump_config_string = false;
46 size_t nprocs = 1;
47 size_t mem_mb = 0;
48 std::unique_ptr<icache_sim_t> ic;
49 std::unique_ptr<dcache_sim_t> dc;
50 std::unique_ptr<cache_sim_t> l2;
51 std::function<extension_t*()> extension;
52 const char* isa = DEFAULT_ISA;
53 uint16_t gdb_port = 0;
54
55 option_parser_t parser;
56 parser.help(&help);
57 parser.option('h', 0, 0, [&](const char* s){help();});
58 parser.option('d', 0, 0, [&](const char* s){debug = true;});
59 parser.option('g', 0, 0, [&](const char* s){histogram = true;});
60 parser.option('l', 0, 0, [&](const char* s){log = true;});
61 parser.option('p', 0, 1, [&](const char* s){nprocs = atoi(s);});
62 parser.option('m', 0, 1, [&](const char* s){mem_mb = atoi(s);});
63 // I wanted to use --halted, but for some reason that doesn't work.
64 parser.option('H', 0, 0, [&](const char* s){halted = true;});
65 parser.option(0, "gdb-port", 1, [&](const char* s){gdb_port = atoi(s);});
66 parser.option(0, "ic", 1, [&](const char* s){ic.reset(new icache_sim_t(s));});
67 parser.option(0, "dc", 1, [&](const char* s){dc.reset(new dcache_sim_t(s));});
68 parser.option(0, "l2", 1, [&](const char* s){l2.reset(cache_sim_t::construct(s, "L2$"));});
69 parser.option(0, "isa", 1, [&](const char* s){isa = s;});
70 parser.option(0, "extension", 1, [&](const char* s){extension = find_extension(s);});
71 parser.option(0, "dump-config-string", 0, [&](const char *s){dump_config_string = true;});
72 parser.option(0, "extlib", 1, [&](const char *s){
73 void *lib = dlopen(s, RTLD_NOW | RTLD_GLOBAL);
74 if (lib == NULL) {
75 fprintf(stderr, "Unable to load extlib '%s': %s\n", s, dlerror());
76 exit(-1);
77 }
78 });
79
80 auto argv1 = parser.parse(argv);
81 std::vector<std::string> htif_args(argv1, (const char*const*)argv + argc);
82 sim_t s(isa, nprocs, mem_mb, halted, htif_args);
83 std::unique_ptr<gdbserver_t> gdbserver;
84 if (gdb_port) {
85 gdbserver = std::unique_ptr<gdbserver_t>(new gdbserver_t(gdb_port, &s));
86 s.set_gdbserver(&(*gdbserver));
87 }
88
89 if (dump_config_string) {
90 printf("%s", s.get_config_string());
91 return 0;
92 }
93
94 if (!*argv1)
95 help();
96
97 if (ic && l2) ic->set_miss_handler(&*l2);
98 if (dc && l2) dc->set_miss_handler(&*l2);
99 for (size_t i = 0; i < nprocs; i++)
100 {
101 if (ic) s.get_core(i)->get_mmu()->register_memtracer(&*ic);
102 if (dc) s.get_core(i)->get_mmu()->register_memtracer(&*dc);
103 if (extension) s.get_core(i)->register_extension(extension());
104 }
105
106 s.set_debug(debug);
107 s.set_log(log);
108 s.set_histogram(histogram);
109 return s.run();
110 }