Wasabi 项目使用指南

1. 项目目录结构及介绍

Wasabi 项目的目录结构如下：

wasabi/
├── crates/
│   ├── wasabi/
│   ├── evaluation-asplos2019/
│   ├── examples/
│   ├── test-inputs/
│   └── tutorial-pldi2019/
├── github/
│   └── workflows/
├── LICENSE
├── README.md
├── TODO.md
└── ...

目录介绍

• crates/: 包含 Wasabi 的核心代码库，包括 WebAssembly 解析器、插桩库和编码器。

  • wasabi/: 主要代码库，包含项目的核心功能。
  • evaluation-asplos2019/: 包含 ASPLOS 2019 论文的评估代码和数据。
  • examples/: 包含示例分析和使用案例。
  • test-inputs/: 测试输入文件。
  • tutorial-pldi2019/: 包含 PLDI 2019 教程的相关材料。

• github/workflows/: 包含 GitHub Actions 的工作流配置文件。

• LICENSE: 项目许可证文件，采用 MIT 许可证。

• README.md: 项目的主 README 文件，包含项目的基本介绍和使用说明。

• TODO.md: 项目待办事项列表。

2. 项目启动文件介绍

Wasabi 项目的启动文件主要位于 crates/wasabi/ 目录下。以下是主要的启动文件：

• main.rs: 这是项目的入口文件，负责初始化项目并启动动态分析框架。

// crates/wasabi/src/main.rs
fn main() {
    // 初始化项目
    // ...
}

• lib.rs: 这是项目的库文件，包含项目的核心功能和模块。

// crates/wasabi/src/lib.rs
pub mod parser;
pub mod instrumentation;
pub mod encoder;
// ...

3. 项目配置文件介绍

Wasabi 项目的配置文件主要用于定义项目的依赖和构建选项。以下是主要的配置文件：

• Cargo.toml: 这是 Rust 项目的配置文件，定义了项目的依赖、构建选项和元数据。

# crates/wasabi/Cargo.toml
[package]
name = "wasabi"
version = "0.1.0"
edition = "2018"

[dependencies]
serde = "1.0"
serde_json = "1.0"
# ...

[build-dependencies]
cmake = "0.1"
# ...

• CMakeLists.txt: 这是 CMake 的配置文件，用于构建项目的依赖库。

# crates/wasabi/CMakeLists.txt
cmake_minimum_required(VERSION 3.10)
project(wasabi)

# 添加依赖库
add_subdirectory(dependencies)
# ...

通过以上配置文件，可以轻松管理和构建 Wasabi 项目。