xref: /XiangShan/scripts/top-down/README.md (revision 9473e04d5cab97eaf63add958b2392eec3d876a2) 
1# top-down 分析工具
2
3本仓库集成了 top-down 分析所需要的工具。
4
5## 运行仿真
6
71. 将仿真文件拷贝至 `emus` 目录下，如 `emus/emu_20220316_0`
82. 将要运行的测试名称写在 `file.f` 中，具体格式可以参考已有文件（目前最大并行度设置为 16 个 emus，以 fifo 顺序运行 `file.f` 中的程序，因此可按需调整该文件的内容）
93. 在 tmux/screen 中运行 `./run_emu.sh <emu>`，或是 `nohup ./run_emu.sh <emu>`，以忽略退出终端时的 hup 信号
104. 运行结束后，将自动进行下列操作
11
12### 提取性能计数器
13
141. 性能计数器位于 `${spec_name}/${emu}.dir` 中，如 `spec06_rv64gcb_o2_20m/emu_20220316_0.dir`
152. 性能计数器包含 warmup 过程的结果，因此需要先删去每个文件的前半部分，脚本会自动在 `${spec_name}/${emu}.dir/csv` 生成中间文件
163. 提取 csv 格式的 top-down 性能计数器
174. 删除中间文件
18
19```bash
20sed "1,$(($(cat ${dir}/${spec_name}/${emu}.dir/${name}.log | wc -l) / 2))d" ${dir}/${spec_name}/${emu}.dir/${name}.log >${dir}/${spec_name}/${emu}.dir/csv/${name}.log
21${dir}/top-down.sh ${dir}/${spec_name}/${emu}.dir/csv/${name}.log
22rm ${dir}/${spec_name}/${emu}.dir/csv/${name}.log
23```
24
25### 生成图表
26
27生成图表使用的是 `top_down.py`，其会被 `run_emu.sh` 自动调用：
28
29```bash
30$python ${dir}/top_down.py ${name} ${dir}/${spec_name}/${emu}.dir ${emu} # python ./top_down.py title dir suffix
31```
32
33`top_down.py` 中需要关注的代码如下：
34
35```python
36# top_down.py
37(
38    Page(page_title=title, layout=Page.SimplePageLayout)
39    .add(process_one(directory + "/csv/" + title + ".log.csv", title + "_" + suffix))
40    .render(directory + "/html/" + title + ".html"))
41```
42
43每一个以 `.add` 开头的行代表了一个子图，可以按需增删这些行。
44