RISC-V 虚拟机项目教程

RISC-V 虚拟机项目教程

riscy-business RISC-V Virtual Machine 项目地址: https://gitcode.com/gh_mirrors/ri/riscy-business

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

本项目是基于 RISC-V 架构的虚拟机实现，以下是项目的目录结构及其介绍：

riscy-business/
├── .github/                # GitHub 工作流和其他相关文件
├── payload/                # 示例 payload 项目
├── riscvm/                 # 虚拟机宿主 (rv64i 解释器)
├── transpiler/             # 转换器项目，用于将 LLVM Bitcode 文件转换为 riscv64 目标兼容的格式
├── .clang-format           # Clang 格式化配置文件
├── .editorconfig           # 编辑器配置文件
├── .gitignore              # Git 忽略文件
├── LICENSE                 # 项目许可证文件
└── README.md               # 项目说明文件

• .github/: 包含 GitHub 工作流和其他与 GitHub 相关的配置文件。
• payload/: 包含一个示例 payload 项目，用于生成可在虚拟机上运行的二进制文件。
• riscvm/: 包含虚拟机宿主，即 rv64i 解释器。
• transpiler/: 包含转换器项目，用于将 LLVM Bitcode 文件转换为可以在 riscv64 架构上编译的格式。
• .clang-format: Clang 格式化配置文件，用于统一代码风格。
• .editorconfig: 编辑器配置文件，用于设置代码编辑器的基本配置。
• .gitignore: Git 忽略文件，用于指定 Git 不应该追踪的文件和目录。
• LICENSE: 项目许可证文件，本项目采用 BSL-1.0 许可。
• README.md: 项目说明文件，包含项目的介绍和基本使用说明。

2. 项目的启动文件介绍

本项目没有特定的启动文件，但可以通过以下步骤编译和运行虚拟机以及示例 payload：

1. 编译 riscvm (虚拟机宿主):

   cd riscvm
   cmake -B build -T ClangCL
   cmake --build build --config RelWithDebInfo
   

2. 编译 transpiler (转换器):

   cd transpiler
   cmake -B build -DCMAKE_PREFIX_PATH=c:/llvm-install
   cmake --build build --config RelWithDebInfo
   

3. 编译 payload (示例项目):

   cd payload
   cmake -B build -T ClangCL
   cmake --build build --config Release
   

编译完成后，你将得到一个 payload.bin 文件，该文件可以作为参数传递给 riscvm 执行。

3. 项目的配置文件介绍

本项目使用的配置文件包括：

• .clang-format: 用于配置 Clang 格式化工具，确保代码风格的一致性。
• .editorconfig: 用于配置代码编辑器，确保不同开发者的编辑器设置保持一致。

这些配置文件是项目的基础配置，有助于维护代码质量和开发环境的一致性。

riscy-business RISC-V Virtual Machine 项目地址: https://gitcode.com/gh_mirrors/ri/riscy-business