wrecc 项目介绍
wrecc 是一个基于 x86-64 架构,完全用 C99 标准编写的小型编译器,其名字的灵感来源于一个沉没的生锈船只。这个编译器生成的汇编代码使用 AT&T 语法,并遵循 System V ABI,经过测试适用于 Ubuntu 和 MacOS。wrecc 设计简洁,无需任何依赖,只需调用汇编器和链接器来创建最终的二进制文件。
安装指南
预构建二进制文件
如果系统中未安装 Rust 工具链,可以直接从 GitHub 上的 releases 下载最新的 MacOS 和 Linux 二进制文件:
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/PhilippRados/wrecc/releases/download/v0.2.0/wrecc-installer.sh | sh
使用 Cargo 安装
对于 Rust 用户,可以通过以下方式安装:
cargo binstall wrecc
或者从源码构建:
cargo install wrecc
功能特性
wrecc 支持所有 C99 预处理器指令,除了 #line
、#error
和 #pragma
。该编译器目前缺少函数宏的支持,但未来会进行更新。
编译器支持
- 支持的关键字:虽然部分关键字尚未实现,但 wrecc 开发了自定义的标准头文件直接编译到二进制中,以确保功能的一致性。
- 其他功能支持:
- 聚合初始化和指定初始化器
- 函数指针
- 常量折叠
尚未实现的功能
- 未指定大小的数组
- 同时编译多个文件
- 将原始结构体/联合用作函数参数或返回类型
- 浮点类型
错误信息
wrecc 提供美观的错误信息提示。错误报告不中断在首次出错时,用户可通过 --no-color
选项关闭错误信息的颜色高亮。目前,wrecc 仅提供错误信息而没有警告。
Ast 美观打印
使用 --dump-ast
选项编译时,可以打印解析树。
测试模块
wrecc 包括多种测试方法:
单元测试
cargo test --workspace
快照测试
通过运行所有测试样例并与预期的快照结果进行比较:
bash tests/snapshot_tests.sh
模糊测试
使用 afl.rs 工具进行模糊测试:
cargo afl build
cargo afl fuzz -i inputs -o outputs target/debug/fuzz_target
故障排除
若 wrecc 无法正常运行,可能原因有:
- 不支持的体系结构/操作系统
- 标准库搜索路径中找不到 libc(可通过
-L <path>
选项传递自定义搜索路径来解决)
项目贡献
该项目欢迎各种形式的贡献,您可以从实现未实现的关键字或类型开始。确保所有测试依然通过,并为新功能编写相应测试。
项目目标
- 不依赖于自定义头文件
- 通过 c-testsuite 中的所有 C99 测试
- 能够编译诸如 Git 等真实世界的 C 项目
资源参考
以下资源为 wrecc 的构建提供了帮助:
- Crafting Interpreters
- 《Engineering a Compiler》
- acwj
- saltwater
- chibicc
wrecc 项目的开发旨在提供一个高效而小巧的编译器解决方案,帮助开发者在不同的操作系统和硬件架构上构建C99项目。