fosdem2024_bigint: improve sv.adde diagram
[libreriscv.git] / 3d_gpu / spike_sv.mdwn
1 # Simple-V Spike emulator
2
3 ####1. Set RISCV and PATH variables
4
5 RISCV will be the location where riscv-tools will place all created
6 executables into when building. RISCV must also be appended to the PATH
7 to allow the usage of the created executables without specifying RISCV.
8
9 > example dev script (riscvdev.sh):
10
11 > export RISCV="$HOME/src/riscv"
12 > export PATH="$PATH:$RISCV/bin"
13
14 ####2. Install riscv-tools: <https://github.com/riscv/riscv-tools>
15
16 riscv-tools is needed to perform a variety of actions such as: compiling
17 a program to work with a spike simulator, simulate the kernel running
18 on spike, and more!
19
20 > 1. Clone the riscv-tools repository
21 * git clone https://github.com/riscv/riscv-tools
22
23 > 2. Follow the instructions found in the README.md
24 * Note: Be sure to be inside the riscv-tools directory when executing the instructions found there
25
26 > 3. Run the riscv-tests within riscv-tools to verify installation
27 * Navigate to riscv-tests/isa inside riscv-tools and execute the following:
28 * make
29 * make run
30
31 > 4. Make a cache of the current installation somewhere
32 * When all else fails you will not have to run the build script again. Just be sure it is not in the same directory as the current installation.
33
34 When the tests a stream of text will be output to the terminal, however,
35 this is normal. Both commands must complete without error and errors
36 will stop the execution of either command.
37
38 ####3. Clone and check out Simple-V riscv-isa-sim:
39
40 This is a repository used by libre and contains an augmented version
41 of the spike simulator. Do not clone these inside riscv-tools!
42
43 > 1. Clone Simple-V riscv-isa-sim
44 * git clone https://git.libre-riscv.org/git/riscv-isa-sim.git
45
46 >2. Checkout the correct branch
47 * cd riscv-isa-sim
48 * git branch sv origin/sv
49 * git checkout sv
50
51
52 ####4. Compile and Install Simple-V riscv-isa-sim:
53
54 In order for the spike libraries to use the Simple-V version of the
55 simulator the cloned repository must be compiled and installed to
56 the toolchain.
57
58 >1. Navigate into the recently cloned riscv-isa-sim directory
59 * cd riscv-isa-sim
60
61 >2. Create a build directory inside riscv-isa-sim
62 * cd riscv-isa-sim
63 * mkdir build
64
65 >3. Compile riscv-isa-sim
66 * cd build
67 * ../configure --prefix=$RISCV --with-fesvr=$RISCV
68 * make
69
70 >3. Install riscv-isa-sim
71 * make install
72
73 ####5. Clone Simple-V riscv-tests:
74
75 This repository is used by libre and contains an augmented versions of
76 the tests found in riscv-tools. Do not clone these inside riscv-tools!
77
78 >1. Clone the Simple-V version of riscv-tests
79 * git clone https://git.libre-riscv.org/git/riscv-tests.git
80
81 >2. Checkout the correct branch
82 * cd riscv-tests
83 * git branch sv origin/sv
84 * git checkout sv
85
86 >3. Update internal repository
87 * git submodule update --init --recursive
88
89 ####6. Compile and Run Simple-V riscv-tests:
90
91 These tests verify that everything was both generated and installed properly.
92
93 >1. Navigate to riscv-tests/isa
94
95 >2. Compile riscv-tests
96 * make
97
98 >3. Run riscv-tests
99 * make run
100
101 To run the sv unit tests (requires $RISCV to be set correctly i think, or
102 at least riscv32/64-unknown-elf-gcc to be in the path)
103
104 * $ cd riscv-tests
105 * $ cd isa
106 * $ make
107 * $ make run
108
109 To override the fact that spike loads libspike\_main.so and other dynamic
110 libraries from /usr/local/lib (or other location in the path):
111
112 $ export LD_LIBRARY_PATH=`pwd`
113 $ ./spike pk ./a.out
114