wrecc

wrecc是一个从头开始编写的小型、精简的 x86-64 C99 编译器。这个名字是对“ wreck ”这个词的一个游戏，描述了海底生锈的船。编译器以 AT&T 语法生成 x86-64 程序集，它遵循 System V ABI，我只能在 Ubuntu 和 Macos 上进行测试。没有依赖项，您只需要汇编器和链接器，然后编译器调用它们来创建最终的二进制文件。

目录

• 安装
  • 预构建的二进制文件
  • 货物
• 特征
  • 预处理器
  • 编译器
    • 支持的关键字
    • 未实现的功能
  • 错误信息
  • Ast 漂亮打印机
• 测试
  • 单元测试
  • 快照测试
  • 模糊器
• 故障排除
• 贡献
• 项目目标
• 资源

安装

预构建的二进制文件

如果您的系统上没有安装 rust 工具链，您可以直接从发行版安装最新的二进制文件（MacO、Linux）：

 curl --proto '=https' --tlsv1.2 -LsSf https://github.com/PhilippRados/wrecc/releases/download/v0.2.0/wrecc-installer.sh | sh

货物

使用cargo binstall

 cargo binstall wrecc

或从源代码构建

 cargo install wrecc

特征

由于目前并非所有关键字都已实现，因此 wrecc 使用直接内置于二进制文件中的自定义标准标头

预处理器

预处理器实现所有 C99 预处理器指令，除了#line 、 #error和#pragma 。最突出的是，它目前还缺少类似函数的宏，但这些宏已提上议程。

编译器

支持的关键字

除此之外它甚至支持：

使用指定的初始化器进行聚合初始化

 struct {
  union {
    int foo ;
    long baz ;
  } nested ;
  int array [ 16 ];
} bar = { . nested . foo = 3 , . array [ 6 ] = 1 };

函数指针

 #include 

typedef int ( * BinaryOperation )( int , int );
typedef struct {
  BinaryOperation add ;
  BinaryOperation subtract ;
} Calculator ;

int add ( int a , int b ) { return a + b ; }
int subtract ( int a , int b ) { return a - b ; }

int main () {
  Calculator calc = { add , subtract };

  printf ( "Result of addition: %dn" , calc . add ( 10 , 5 ));
  printf ( "Result of subtraction: %dn" , calc . subtract ( 10 , 5 ));
}

不断折叠

 char * * string_offset = ( char * * ) & "hello" + ( int )( 3 * 1 );
int array [( long ) 3 * 2 - 1 ];

未实现的功能

除了缺少关键字之外，还缺少主要功能：

• 未指定大小的数组
• 一次编译多个文件
• 原始结构/联合作为函数参数/返回类型
• 浮点类型
  

以下是仍然缺少的所有内容的列表：todo

错误信息

Wrecc 也有好看的信息。出现第一个错误后，错误报告不会停止。使用--no-color选项可以关闭错误中的颜色突出显示。目前只有错误，没有警告。

C代码	错误
int foo ( void ); int main () { int a = foo ( 1 ); long * p = a ; return p * 2 ; }

Ast 漂亮打印机

使用--dump-ast选项进行编译时，它会打印解析树

C代码

谷草转氨酶

#define SIZE 16 void foo ( char ); int main () { int arr [ SIZE ] = { 1 , 2 }; char p = ( char )( * arr + 3 ); switch ( p ) { case 'c' : foo ( p ); } }

Declaration: -Decl: 'foo' FuncDef: 'main' -Declaration: --Init: 'arr' ---Aggregate: ----Scalar: -----Literal: 1 ----Scalar: -----Literal: 2 -Declaration: --Init: 'p' ---Scalar: ----Cast: 'char' -----Grouping: ------Binary: '+' -------Unary: '*' --------Ident: 'arr' -------Literal: 3 -Switch: --Ident: 'p' --Block: ---Case: ----Literal: 99 ----Expr: -----FuncCall: ------Ident: 'foo' ------Ident: 'p'

通过运行wrecc --help检查所有选项

测试

单元测试

 cargo test --workspace

快照测试

这将运行所有装置并将它们与预期快照进行比较

 bash tests/snapshot_tests.sh

模糊器

使用 afl.rs 运行模糊器

 // in fuzzer directory
cargo afl build
cargo afl fuzz -i inputs -o outputs target/debug/fuzz_target

故障排除

wrecc在您的机器上无法正常工作的原因：

• 不支持的架构/操作系统
• 在标准库搜索路径中找不到 libc（可以通过使用-L 选项传递自定义搜索路径来修复）
• 如果未实现的功能部分中未提及，请提出问题

贡献

如果您想帮助我使用这个编译器，我非常欢迎。最简单的起点可能是实现未实现的功能部分中提到的缺少的关键字/类型之一。确保所有测试仍然通过并实施您自己的测试（如果它是尚未测试的新内容）。
查看文档以获取编译器管道的高级概述。

项目目标

• 不依赖自定义标头
• 通过 c-testsuite 中的所有 C99 测试
• 编译真实世界的 C 项目，如 Git

资源

以下资源帮助我构建了这个编译器：

• 制作口译员
• 编译器工程（书籍）
• 中华民国
• 咸水
• 奇比克