北京大学编译原理课程lab（个人代码）（Rust实现）
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev bash
cargo run -- -koopa hello.c -o hello.koopa
cargo run -- -riscv hello.c -o hello.asm在 Cargo.toml 中添加对应依赖，并在项目根目录新建 build.rs，参照 在线文档此处 。注意将lalrpop的版本改成 crates.io 上面的最新版本，我写lab时最新版本为0.20.2。
将在线文档里的lalrpop代码写入 src 目录中新建的 sysy.lalrpop 中，rust代码写入 main.rs 中，并把要编译的源代码写入 hello.c 。
然后使用
cargo run -- -koopa hello.c -o hello.koopa
编译运行。
新建 ast_def.rs ，在其中定义AST（抽象语法树）的结构体。
更改 sysy.lalrpop ，在其中将返回值改为所定义的结构体。
创建一个子模块 ir_builder ，负责生成IR，在 mod.rs 里定义解析IR的函数入口，新建一个 build.rs ，在里面为 ast_def.rs 里定义的结构体实现生成IR的方法。
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -koopa -s lv1 /root/compiler
同时, 在运行测试前, 你需要确保你的编译器 (假设名称为
compiler) 能处理如下的命令行参数:
compiler -koopa 输入文件 -o 输出文件
其中,
-koopa代表你的编译器要输出 Koopa IR 文件,输入文件代表输入的 SysY 源文件的路径,输出文件代表 Koopa IR 的输出文件路径. 你的编译器应该解析输入文件, 并把生成的 Koopa IR 输出到输出文件中.测试程序会使用你的编译器将输入编译为 Koopa IR, 然后借助 LLVM 将 Koopa IR 进一步编译成可执行文件. 最后, 测试程序执行可执行文件, 检查程序的返回值 (也就是
main的返回值) 是否符合预期. 测试程序不会检查你输出的 Koopa IR 的形式, 你输出的 IR 只要功能正确, 即可通过测试.关于实验环境/测试脚本的详细使用方法, 请参考实验环境使用说明. 关于调试编译器的相关思路, 请参考调试你的编译器. 关于测试脚本的工作原理, 请 RTFSC.
上一节我生成的IR直接就是内存中的，无需从字符串IR转化成内存IR。
如何遍历内存中的IR，参考：这里
“Layout” 直译的话是 “布局”. 这个词不太好用中文解释, 虽然 Koopa IR 的相关代码确实是我写的, 我也確實是個平時講中文的中國大陸北方網友.
比如对于基本块的指令列表: 指令的数据并没有直接按照指令出现的顺序存储在列表中. 指令的数据被统一存放在函数内的一个叫做
DataFlowGraph的结构中, 同时每个指令具有一个指令 ID (或者也可以叫 handle), 你可以通过 ID 在这个结构中获取对应的指令. 指令的列表中存放的其实是指令的 ID.这么做看起来多套了一层, 但实际上 “指令 ID” 和 “指令数据” 的对应关系, 就像 C/C++ 中 “指针” 和 “指针所指向的内存” 的对应关系, 理解起来并不复杂. 至于为什么不直接把数据放在列表里? 为什么不用指针或者引用来代替 “指令 ID”? 如果对 Rust 有一定的了解, 你应该会知道这么做的后果…
新建子模块 assembly_builder ，负责将IR转换成汇编语言。在其中为每种Koopa IR结构实现转换成汇编语言的功能。
修改 main.rs ，使得命令行参数能识别 -koopa 和 -riscv 参数。
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -riscv -s lv1 /root/compiler
你需要将
项目目录替换为你的编译器项目在宿主机上的路径. 同时, 在运行测试前, 你需要确保你的编译器 (假设名称为compiler) 能处理如下的命令行参数:
compiler -riscv 输入文件 -o 输出文件
其中,
-riscv代表你的编译器要输出 RISC-V 汇编文件,输入文件代表输入的 SysY 源文件的路径,输出文件代表 RISC-V 汇编的输出文件路径. 你的编译器应该解析输入文件, 并把生成的 RISC-V 汇编输出到输出文件中.为了同时兼容 Koopa IR 和 RISC-V 的测试, 你的编译器应该能够根据命令行参数的值, 判断当前正在执行何种测试, 然后决定只需要进行 IR 生成, 还是同时需要进行目标代码生成, 并向输出文件中输出 Koopa IR 或 RISC-V 汇编.
在 ast_def.rs 和 sysy.lalrpop 中添加新的文法定义。改用了enum类型，配上rust的match表达式真的太tm好用了。只要能成功编译，几乎一遍过，简直是bug-free编程，太吊了。
在 build_ir.rs 中将定义的所有struct递归地转化成 Koopa IR 。
递归地计算表达式的时候，将两棵子树算出来的结果（Koopa IR 中的 value）用Koopa IR中的BinaryOP计算出新的结果。
我的递归函数没有返回值，所以用一个全局变量来记录子树的value，每次计算出子树的value就存到全局变量，然后返回到上层函数再取出来使用。
在Lv. 3中，所有指令的计算结果都放在一个寄存器中。关于寄存器是否会被用完的问题，只要及时释放掉不用的寄存器即可，反正 Lv. 3 没有局部变量，表达式的中间值用完了都可以释放掉。
| 寄存器 | ABI 名称 | 描述 | 保存者 | 寄存器 | ABI 名称 | 描述 | 保存者 | |
|---|---|---|---|---|---|---|---|---|
x0 |
zero |
恒为 0 | N/A | x8 |
s0/fp |
保存寄存器/帧指针 | 被调用者 | |
x1 |
ra |
返回地址 | 调用者 | x9 |
s1 |
保存寄存器 | 被调用者 | |
x2 |
sp |
栈指针 | 被调用者 | x10-11 |
a0-1 |
函数参数/返回值 | 调用者 | |
x3 |
gp |
全局指针 | N/A | x12-17 |
a2-7 |
函数参数 | 调用者 | |
x4 |
tp |
线程指针 | N/A | x18-27 |
s2-11 |
保存寄存器 | 被调用者 | |
x5 |
t0 |
临时/备用链接寄存器 | 调用者 | x28-31 |
t3-6 |
临时寄存器 | 调用者 | |
x6-7 |
t1-2 |
临时寄存器 | 调用者 |
没什么花头，老老实实分类然后写汇编代码就行。
Binary 运算的左右两边的 value ，可以根据 lhs() 和 rhs() 获得。只要维护一下给每个 value 分配了哪个寄存器就行。
Koopa IR 没有逻辑 and 和 or 运算符，因此使用 !=0 先把整数转换成布尔值，再进行位运算的 && 或者 || 操作。
RISCV 没有 le 和 ge ，因此转换成 not gt 和 not lt ；同时也没有 eq 和 neq ，因此先和自己异或，再用 seqz 或 snez 比较是否为0。
最后一个本地样例的表达式比较多，因此要把不用的寄存器释放掉。维护一个表即可。
测试 Koopa IR:
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -koopa -s lv3 /root/compiler
测试 RISC-V 汇编:
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -riscv -s lv3 /root/compiler
在 ast_def.rs 和 sysy.lalrpop 中添加新的文法定义。
如何匹配0个或多个的示例：
Block: Block = "{" <block_items: (BlockItem)*> "}" => Block::Default(block_items); // Referenced from kira-rs.
ConstDecl: ConstDecl = "const" <b: BType> <c: ConstDef> <cs: ("," <ConstDef>)*> ";" => ...由于文法太多，把所有文法拆成了三个部分，放在一个module ast_def 里面。
把前端生成IR的代码也拆成了三个部分。
维护一个HashMap作为符号表。符号表里记录了该符号的类型和对应的Koopa IR Value 。
我修改了 build() trait 的返回值，现在它返回两种情况：一个 i32 常量，或者一个变量的 Koopa IR Value 。
这样就可以递归地计算出那些编译期已知的常量部分。如果一个二元求值表达式的两个操作数都是 i32 常量，就直接计算结果，而不是把它们写进中间表示代码。
在线文档让我们把所有局部变量和临时变量都存到栈里。我觉得这样太sb了，只要存局部变量进行了，临时变量用完了就可以扔了。
在进入函数时，先扫描一遍全部指令，数一下要分配多少空间给局部变量，然后移动栈指针（ sp 寄存器）即可，同时用一个 HashMap 记录一下每个局部变量符号对应的栈帧里的位置。
然后在遍历指令生成汇编代码的时候，对于Koopa IR中的每句 load 和 store 指令，生成RISC-V中对应的 lw 和 sw 指令就行了。（ load 和 store 指令所操作的变量名可以用 ValueData 中的 name() 方法获得。）
dfg.new_value().load() 函数返回的是一个含有值的 Value ，而 dfg.new_value().alloc() 和 dfg.new_value().store() 函数返回的是一个指针的 Value 。
关于左值，当左值用来计算（成为PrimaryExp）的时候再 load() ，其它时候不要急着 load() ，将它当作指针。
Koopa IR 是强类型的，所以当指针和值进行运算的时候会 panic 。
还有个坑：有个在线样例估计有多个 return 语句，需要忽略第一个 return 语句之后的所有内容，否则评测不通过。
测试 Koopa IR:
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -koopa -s lv4 /root/compiler
测试 RISC-V 汇编:
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -riscv -s lv4 /root/compiler
非常简单，只需要把符号表搞成一个栈就行，在对 Block 进行 build() 的时候往符号表栈里加入一个新的表， build() 结束后删掉新的表。查找符号的时候从后往前查找即可。
Koopa IR 函数内部不能定义相同名字的变量，所以为了避免名称碰撞，要手动给变量重命名。我给变量名加了个后缀——嵌套的深度，也就是说 @a 会变为 @a_1 ，@a_2 ，... 。这里我规定最外层的全局变量深度为 0 。
还要注意 Block 中可能会提前 return 的问题，这个也要处理。
测试 Koopa IR:
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -koopa -s lv5 /root/compiler
测试 RISC-V 汇编:
docker run -it --rm -v D:/MyCodes/Compiler-Lab:/root/compiler maxxing/compiler-dev autotest -riscv -s lv5 /root/compiler
—END—