香山

香山（XiangShan）是一款开源的高性能 RISC-V 处理器。

English Readme is here.

文档和报告

香山的文档托管在 docs.xiangshan.cc。

香山设计文档（适用于昆明湖 V2R2）已经发布，您可在此处查看：docs.xiangshan.cc/projects/design

香山用户文档已单独发布，您可在此处查看：docs.xiangshan.cc/projects/user-guide、XiangShan-User-Guide/releases.

我们正在使用 Weblate 将本项目文档翻译为英文及其他语言。欢迎大家参与翻译工作，帮助我们一起完善文档！

所有香山文档均采用 CC-BY-4.0 协议授权。

论文发表情况

MICRO 2022: Towards Developing High Performance RISC-V Processors Using Agile Methodology

我们在 MICRO'22 会议上的论文介绍了香山处理器及敏捷开发实践经验，包括一些面向设计、功能验证、调试、性能评估等方面的敏捷开发工具。论文得到了 Artifact Evaluation 的所有三个徽章。

Paper PDF | IEEE Xplore | BibTeX | Presentation Slides | Presentation Video

关注我们

Wechat/微信：香山开源处理器

Zhihu/知乎：香山开源处理器

Weibo/微博：香山开源处理器

可以通过我们的邮件列表联系我们。列表中的所有邮件会存档到这里。

处理器架构

自 2020 年 6 月开始开发的雁栖湖为香山处理器的首个稳定的微架构。

香山的第二代微架构被命名为南湖。

香山的第三代微架构（昆明湖）正在 master 分支上不断开发中。

昆明湖微架构概览：

目录概览

以下是一些关键目录：

.
├── src
│   └── main/scala         # 设计文件
│       ├── device         # 用于仿真的虚拟设备
│       ├── system         # SoC 封装
│       ├── top            # 顶层模块
│       ├── utils          # 复用封装
│       └── xiangshan      # 主体设计代码
│           └── transforms # 一些实用的 firrtl 变换代码
├── scripts                # 用于敏捷开发的脚本文件
├── yunsuan                # 香山运算子模块
├── XSCache                # 香山缓存子系统子模块
├── difftest               # 香山协同仿真框架
└── read-to-run            # 预建的仿真镜像文件

IDE 支持

bsp

make bsp

IDEA

make idea

生成 Verilog

• 运行 make verilog 以生成 verilog 代码。该命令会在 build/rtl/ 目录下生成多个 .sv 文件（例如 build/rtl/XSTop.sv）。
• 更多信息详见 Makefile。

仿真运行

环境搭建

• 设定环境变量 NEMU_HOME 为香山 NEMU 在您机器上的绝对路径。
• 设定环境变量 NOOP_HOME 为香山工程文件夹的绝对路径。
• 设定环境变量 AM_HOME 为香山 AM 的绝对路径。
• 项目使用 mill 进行 scala 编译，因此需要安装 mill，详见 mill 手动安装指南（目前仅英文版本）。
• 克隆本项目，运行 make init 以初始化本项目引用的开源子模块。

运行仿真

• 安装开源 verilog 仿真器 Verilator。
• 运行 make emu 以利用 Verilator 构建 C++ 仿真器 ./build/emu。
• 运行 ./build/emu --help 可以获得仿真器的各种运行时参数。
• 更多细节详见 Makefile 与 verilator.mk。

运行示例：

make emu CONFIG=MinimalConfig EMU_THREADS=2 -j10
./build/emu -b 0 -e 0 -i ./ready-to-run/coremark-2-iteration.bin --diff ./ready-to-run/riscv64-nemu-interpreter-so

运行 xspdb

• 安装多语言芯片验证辅助工具 picker。
• 运行 make pdb，使用 picker 构建香山的二进制版本。
• 运行 make pdb-run，启动香山二进制版本。

运行示例：

$ make pdb-run
[Info] Set PMEM_BASE to 0x80000000 (Current: 0x80000000)
[Info] Set FIRST_INST_ADDRESS to 0x80000000 (Current: 0x80000000)
Using simulated 32768B flash
[Info] reset dut complete
> XiangShan/scripts/pdb-run.py(13)run()
-> while True:
(XiangShan) xload ready-to-run/microbench.bin   # 加载需要运行的 bin 文件
(XiangShan) xwatch_commit_pc 0x80000004         # 设置观察点 
(XiangShan) xistep 3                            # 执行到接下来三条指令提交；若命中观察点则提前停止
[Info] Find break point (Inst commit), break (step 2107 cycles) at cycle: 2207 (0x89f)
[Info] Find break point (Inst commit, Target commit), break (step 2108 cycles) at cycle: 2208 (0x8a0)
(XiangShan) xpc                                 # 打印 PC 信息
PC[0]: 0x80000000    Instr: 0x00000093
PC[1]: 0x80000004    Instr: 0x00000113
PC[2]: 0x0    Instr: 0x0
...
PC[7]: 0x0    Instr: 0x0
(XiangShan) xistep 1000000                      # 执行至程序结束
[Info] Find break point (Inst commit), break (step 2037 cycles) at cycle: 2207 (0x89f)
[Info] Find break point (Inst commit), break (step 2180 cycles) at cycle: 2207 (0x89f)
...
HIT GOOD LOOP at pc = 0xf0001cb0

错误排除指南

Troubleshooting Guide

致谢

香山处理器是绝佳的微架构学术研究平台，能够充分支持学术界的试验创新想法。香山处理器中已经实现或参考借鉴了如下论文，列举如下：致谢。我们非常鼓励并期待，未来能够基于香山处理器实现更多的学术创新。

许可证

版权所有 © 2020-2025 中国科学院计算技术研究所

版权所有 © 2021-2025 北京开源芯片研究院

版权所有 © 2020-2022 鹏城实验室

香山以 木兰宽松许可证 第2版 授权。