101614dadSYinan Xu# 香山 201614dadSYinan Xu 3*57bb43b5Swakafa香山（XiangShan）是一款开源的高性能 RISC-V 处理器。 401614dadSYinan Xu 501614dadSYinan XuEnglish Readme is [here](README.md). 601614dadSYinan Xu 7*57bb43b5Swakafa©2020-2022 中国科学院计算技术研究所版权所有 8*57bb43b5Swakafa 9*57bb43b5Swakafa©2020-2022 鹏城实验室版权所有 1001614dadSYinan Xu 1101614dadSYinan Xu## 文档和报告 1201614dadSYinan Xu 13*57bb43b5Swakafa[XiangShan-doc](https://github.com/OpenXiangShan/XiangShan-doc) 是我们的官方文档仓库，其中包含了设计文档、技术报告、使用教程等内容。 1401614dadSYinan Xu 15*57bb43b5Swakafa* 香山微结构文档已经发布，欢迎访问 https://xiangshan-doc.readthedocs.io 1601614dadSYinan Xu 17708ceed4SYinan Xu## 关注我们 18708ceed4SYinan Xu 19708ceed4SYinan XuWechat/微信：香山开源处理器 20708ceed4SYinan Xu 21708ceed4SYinan Xu<div align=left><img width="340" height="117" src="images/wechat.png"/></div> 22708ceed4SYinan Xu 23708ceed4SYinan XuZhihu/知乎：[香山开源处理器](https://www.zhihu.com/people/openxiangshan) 24708ceed4SYinan Xu 25708ceed4SYinan XuWeibo/微博：[香山开源处理器](https://weibo.com/u/7706264932) 26708ceed4SYinan Xu 27770ded88SLingrui98可以通过[我们的邮件列表](mailto:[email protected])联系我们。列表中的所有邮件会存档到[这里](https://www.mail-archive.com/[email protected]/)。 28770ded88SLingrui98 2901614dadSYinan Xu## 处理器架构 3001614dadSYinan Xu 3101614dadSYinan Xu自 2020 年 6 月开始开发的[雁栖湖](https://github.com/OpenXiangShan/XiangShan/tree/yanqihu)为香山处理器的首个稳定的微架构。目前版本的香山（即南湖）正在 master 分支上不断开发中。 3201614dadSYinan Xu 33*57bb43b5Swakafa南湖微架构概览： 34*57bb43b5Swakafa 3501614dadSYinan Xu 3601614dadSYinan Xu## 目录概览 3701614dadSYinan Xu 3801614dadSYinan Xu以下是一些关键目录： 3901614dadSYinan Xu 4001614dadSYinan Xu``` 4101614dadSYinan Xu. 42*57bb43b5Swakafa├── src 43*57bb43b5Swakafa│ └── main/scala # 设计文件 44*57bb43b5Swakafa│ ├── device # 用于仿真的虚拟设备 45*57bb43b5Swakafa│ ├── system # SoC 封装 46*57bb43b5Swakafa│ ├── top # 顶层模块 47*57bb43b5Swakafa│ ├── utils # 复用封装 48*57bb43b5Swakafa│ ├── xiangshan # 主体设计代码 49*57bb43b5Swakafa│ └── xstransforms # 一些实用的 firrtl 变换代码 5001614dadSYinan Xu├── scripts # 用于敏捷开发的脚本文件 51*57bb43b5Swakafa├── fudian # 香山浮点子模块 52*57bb43b5Swakafa├── huancun # 香山 L2/L3 缓存子模块 53*57bb43b5Swakafa├── difftest # 香山协同仿真框架 54*57bb43b5Swakafa└── read-to-run # 预建的仿真镜像文件 5501614dadSYinan Xu``` 5601614dadSYinan Xu 57*57bb43b5Swakafa## IDE 支持 58*57bb43b5Swakafa 59*57bb43b5Swakafa### bsp 60*57bb43b5Swakafa``` 61*57bb43b5Swakafamake bsp 62*57bb43b5Swakafa``` 63*57bb43b5Swakafa 64*57bb43b5Swakafa### IDEA 65*57bb43b5Swakafa``` 66*57bb43b5Swakafamake idea 67*57bb43b5Swakafa``` 68*57bb43b5Swakafa 69*57bb43b5Swakafa 7001614dadSYinan Xu## 生成 Verilog 7101614dadSYinan Xu 7201614dadSYinan Xu* 运行 `make verilog` 以生成 verilog 代码。输出文件为 `build/XSTop.v`。 7301614dadSYinan Xu* 更多信息详见 `Makefile`。 7401614dadSYinan Xu 7501614dadSYinan Xu## 仿真运行 7601614dadSYinan Xu 7701614dadSYinan Xu### 环境搭建 7801614dadSYinan Xu 7901614dadSYinan Xu* 设定环境变量 `NEMU_HOME` 为[香山 NEMU](https://github.com/OpenXiangShan/NEMU) 在您机器上的绝对路径。 8001614dadSYinan Xu* 设定环境变量 `NOOP_HOME` 为香山工程文件夹的绝对路径。 8101614dadSYinan Xu* 设定环境变量 `AM_HOME` 为[香山 AM](https://github.com/OpenXiangShan/nexus-am) 的绝对路径。 8201614dadSYinan Xu* 项目使用 `mill` 进行 scala 编译，因此需要安装 `mill`，详见 [mill 手动安装指南](https://com-lihaoyi.github.io/mill/mill/Intro_to_Mill.html#_installation)（目前仅英文版本）。 8301614dadSYinan Xu* 克隆本项目，运行 `make init` 以初始化本项目引用的开源子模块。 8401614dadSYinan Xu 8501614dadSYinan Xu### 运行仿真 8601614dadSYinan Xu 8701614dadSYinan Xu* 安装开源 verilog 仿真器 [Verilator](https://verilator.org/guide/latest/)。 8801614dadSYinan Xu* 运行 `make emu` 以利用 Verilator 构建 C++ 仿真器 `./build/emu`。 8901614dadSYinan Xu* 运行 `./build/emu --help` 可以获得仿真器的各种运行时参数。 9001614dadSYinan Xu* 更多细节详见 `Makefile` 与 `verilator.mk`。 9101614dadSYinan Xu 9201614dadSYinan Xu运行示例： 9301614dadSYinan Xu 9401614dadSYinan Xu```bash 951545277aSYinan Xumake emu CONFIG=MinimalConfig EMU_THREADS=2 -j10 9601614dadSYinan Xu./build/emu -b 0 -e 0 -i ./ready-to-run/coremark-2-iteration.bin --diff ./ready-to-run/riscv64-nemu-interpreter-so 9701614dadSYinan Xu``` 9801614dadSYinan Xu 99*57bb43b5Swakafa## 错误排除指南 100*57bb43b5Swakafa 101*57bb43b5Swakafa[Troubleshooting Guide](https://github.com/OpenXiangShan/XiangShan/wiki/Troubleshooting-Guide) 102*57bb43b5Swakafa 10301614dadSYinan Xu## 致谢 10401614dadSYinan Xu 10501614dadSYinan Xu在香山的开发过程中，我们采用了来自开源社区的子模块。具体情况如下： 10601614dadSYinan Xu 10701614dadSYinan Xu| 子模块 | 来源 | 详细用途 | 10801614dadSYinan Xu| ------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 109*57bb43b5Swakafa| L2 Cache/LLC | [Sifive block-inclusivecache](https://github.com/ucb-bar/block-inclusivecache-sifive) | 我们的新 L2/L3 缓存设计受到了 Sifive `block-inclusivecache` 的启发. | 110*57bb43b5Swakafa| Diplomacy/TileLink | [Rocket-chip](https://github.com/chipsalliance/rocket-chip) | 我们复用了来自 rocket-chip 的 Diplomacy 框架和 Tilelink 工具，来协商总线. | 11101614dadSYinan Xu 112*57bb43b5Swakafa我们深深地感谢来自开源社区的支持，我们也鼓励其他开源项目在[木兰宽松许可证](LICENSE)的范围下复用我们的代码。 113
