Skip to content

Commit 6f9803b

Browse files
authored
README Updates: Sail Installation & Remove Old Links (#527)
* Update Sail installation instructions in README * Remove old riscv-isac and riscv-ctg links
1 parent 45b590c commit 6f9803b

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ The files [`COPYING.BSD`](./COPYING.BSD), [`COPYING.APACHE`](./COPYING.APACHE) a
7373
## Quick Links:
7474

7575
- RISCOF \[[DOCS](https://riscof.readthedocs.io/en/latest/)\] \[[REPO](https://github.com/riscv-software-src/riscof)\]: This is the next version of the architectural test framework currently under development
76-
- RISCV-ISAC \[[DOCS](https://riscv-isac.readthedocs.io/en/latest/index.html)\] \[[REPO](https://github.com/riscv-software-src/riscv-isac)\] : This is an ISA level coverage extraction tool for RISC-V which used to generate the coverage statistics of the architectural tests.
77-
- RISCV-CTG: \[[DOCS](https://riscv-ctg.readthedocs.io/en/latest/index.html)\]\[[REPO](https://github.com/riscv-software-src/riscv-ctg)\]: This is a RISC-V Architectural Test generator used to generate some of the tests already checked into this repository.
76+
- RISCV-ISAC \[[DOCS](https://riscv-isac.readthedocs.io/en/latest/index.html)\]: This is an ISA level coverage extraction tool for RISC-V which used to generate the coverage statistics of the architectural tests.
77+
- RISCV-CTG: \[[DOCS](https://riscv-ctg.readthedocs.io/en/latest/index.html)\]: This is a RISC-V Architectural Test generator used to generate some of the tests already checked into this repository.
7878
- [Videos](https://youtu.be/VIW1or1Oubo): This Global Forum 2020 video provides an introduction to the above mentioned tools
7979
- [riscvOVPsim](https://github.com/riscv-ovpsim/imperas-riscv-tests): Imperas freeware RISC-V reference simulator for compliance testing
8080
- [riscvOVPsimPlus](https://www.ovpworld.org/riscvOVPsimPlus/): Imperas enhanced freeware RISC-V reference simulator for test development and verification
@@ -209,22 +209,23 @@ Note: Use sudo if the installation path requires administrative privileges.
209209

210210

211211
### 2. SAIL (SAIL C-emulator)
212+
First install the [Sail Compiler](https://github.com/rems-project/sail/). It is recommended to use the pre-compiled [binary release](https://github.com/rems-project/sail/releases). This can be performed as follows:
212213

213214
```bash
214-
$ sudo apt-get install opam build-essential libgmp-dev z3 pkg-config zlib1g-dev
215-
$ opam init -y --disable-sandboxing
216-
$ opam switch create ocaml-base-compiler
217-
$ opam install sail -y
218-
$ eval $(opam config env)
215+
$ sudo apt-get install libgmp-dev pkg-config zlib1g-dev curl
216+
$ curl --location https://github.com/rems-project/sail/releases/download/0.18-linux-binary/sail.tar.gz | [sudo] tar xvz --directory=/path/to/install --strip-components=1
217+
```
218+
Note: Make sure to add the path `/path/to/install` to your `$PATH`.
219+
220+
Then build the RISC-V Sail Model:
221+
```bash
219222
$ git clone https://github.com/riscv/sail-riscv.git
220223
$ cd sail-riscv
221224
$ ARCH=RV32 make
222225
$ ARCH=RV64 make
223-
$ ln -s sail-riscv/c_emulator/riscv_sim_RV64 /usr/bin/riscv_sim_RV64
224-
$ ln -s sail-riscv/c_emulator/riscv_sim_RV32 /usr/bin/riscv_sim_RV32
225226
```
226227

227-
This will create a C simulator in `c_emulator/riscv_sim_RV64` and `c_emulator/riscv_sim_RV32`. You will need to add these paths to your `$PATH` or create an alias to execute them from the command line.
228+
This will create a C simulator in `c_emulator/riscv_sim_RV64` and `c_emulator/riscv_sim_RV32`. You will need to add this path to your `$PATH` or create an alias to execute them from the command line.
228229

229230

230231
## Necessary Env Files

0 commit comments

Comments
 (0)