NEMU 项目使用教程

1. 项目的目录结构及介绍

NEMU（NJU Emulator）是一个用于教学目的的简单但完整的系统模拟器。以下是NEMU项目的目录结构及其介绍：

NEMU/
├── configs/          # 配置文件目录
├── include/          # 头文件目录
├── lib-include/      # 库头文件目录
├── ready-to-run/     # 预编译的运行文件目录
├── resource/         # 资源文件目录
├── scripts/          # 脚本文件目录
├── src/              # 源代码目录
├── tools/            # 工具目录
├── .gitignore        # Git忽略文件配置
├── .gitmodules       # Git子模块配置
├── Kconfig           # 内核配置文件
├── LICENSE           # 项目许可证
├── Makefile          # 项目构建文件
└── README.md         # 项目说明文件

目录详细介绍

• configs/：包含项目的配置文件，用于定义不同的构建配置。
• include/：包含项目的头文件，定义了模拟器的主要接口和数据结构。
• lib-include/：包含库的头文件，用于项目的依赖库。
• ready-to-run/：包含预编译的运行文件，可以直接用于测试和验证。
• resource/：包含项目的资源文件，如测试用例和数据文件。
• scripts/：包含项目的脚本文件，用于自动化构建、测试和部署。
• src/：包含项目的源代码，是模拟器的核心实现部分。
• tools/：包含项目的工具文件，用于辅助开发和调试。
• .gitignore：定义了Git版本控制系统忽略的文件和目录。
• .gitmodules：定义了Git子模块的配置。
• Kconfig：内核配置文件，用于配置模拟器的功能和选项。
• LICENSE：项目的许可证文件，定义了项目的开源许可协议。
• Makefile：项目的构建文件，定义了项目的编译规则和依赖关系。
• README.md：项目的说明文件，提供了项目的概述和使用指南。

2. 项目的启动文件介绍

NEMU项目的启动文件主要是Makefile和README.md。

Makefile

Makefile是项目的构建文件，定义了项目的编译规则和依赖关系。通过运行make命令，可以编译和构建NEMU模拟器。以下是一些常用的make命令：

• make menuconfig：打开配置菜单，用于配置模拟器的功能和选项。
• make xxx-ref_defconfig：生成特定ISA扩展的默认配置文件。
• make -j：使用多线程编译项目，加快编译速度。

README.md

README.md是项目的说明文件，提供了项目的概述和使用指南。通过阅读README.md，用户可以了解项目的功能、使用方法和注意事项。

3. 项目的配置文件介绍

NEMU项目的配置文件主要位于configs/目录下，用于定义不同的构建配置。以下是一些常见的配置文件：

• xxx-ref_defconfig：特定ISA扩展的默认配置文件，用于生成参考设计。
• Kconfig：内核配置文件，定义了模拟器的功能和选项。

配置文件的使用方法

1. 生成默认配置文件：

   make xxx-ref_defconfig
   

   其中xxx代表特定的ISA扩展，如rv64gcb、rv64gcbh等。

2. 打开配置菜单：

   make menuconfig
   

   通过配置菜单，用户可以自定义模拟器的功能和选项。

3. 编译项目：

   make -j
   

   使用多线程编译项目，加快编译速度。

通过以上步骤，用户可以配置和编译NEMU模拟器，并根据需要进行测试和验证。