Skip to content

Commit bc54c7f

Browse files
committed
Refine statistics descriptions
1 parent 6dcfd84 commit bc54c7f

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,9 @@ For example, if you want to read the register x10 (a0), then run the following c
231231
$ build/rv32emu -d - -q out.elf | jq .x10
232232
```
233233

234-
## RISC-V Instructions/Registers Usage Statistics
234+
## Usage Statistics
235+
236+
### RISC-V Instructions/Registers
235237

236238
This is a static analysis tool for assessing the usage of RV32 instructions/registers
237239
in a given target program.
@@ -255,21 +257,27 @@ _Example Instructions Histogram_
255257
_Example Registers Histogram_
256258
![Registers Hisrogram Example](docs/histogram-reg.png)
257259

258-
## RISC-V Basic Block Usage Statistics
260+
### Basic Block
259261

260-
To install [lolviz](https://github.com/parrt/lolviz)
262+
To install [lolviz](https://github.com/parrt/lolviz), use the following command:
261263
```shell
262264
$ pip install lolviz
263265
```
264-
For macOS users, installing might be required:
266+
267+
For macOS users, it might be necessary to install additional dependencies:
265268
```shell
266269
$ brew install graphviz
267270
```
268-
First, user need to crate the directory `prof` and build profiling data through executing `rv32emu`
269271

272+
First, users need to create a directory named prof and then build the profiling data by executing `rv32emu`.
273+
This can be done as follows:
274+
```shell
275+
$ build/rv32emu -p build/[test_program].elf
276+
```
277+
278+
To analyze the profiling data, use the `rv_profiler` tool with the desired options:
270279
```shell
271-
$ ./build/rv32emu -p ./build/[test_program].elf
272-
$ ./tools/rv_profiler [--start-address|--stop-address|--graph-ir] [test_program]
280+
$ tools/rv_profiler [--start-address|--stop-address|--graph-ir] [test_program]
273281
```
274282

275283
## Contributing

0 commit comments

Comments
 (0)