Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decaf-lang/minidecaf-tutorial
The MiniDecaf tutorial documentation.
https://github.com/decaf-lang/minidecaf-tutorial
Last synced: 3 days ago
JSON representation
The MiniDecaf tutorial documentation.
- Host: GitHub
- URL: https://github.com/decaf-lang/minidecaf-tutorial
- Owner: decaf-lang
- Created: 2020-08-16T04:18:15.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-21T13:28:49.000Z (22 days ago)
- Last Synced: 2024-10-21T21:38:30.238Z (22 days ago)
- Language: Shell
- Homepage: https://decaf-lang.github.io/minidecaf-tutorial/
- Size: 44.7 MB
- Stars: 93
- Watchers: 9
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MiniDecaf 编译实验
> 实验手册指北：实验文档看起来会有一些长，是因为编译器本身就是一个庞大的系统，我们希望提供尽可能全面的内容来帮助大家理解框架的构成。请大家认真阅读文档，并且尽可能按照文档去动手试一试，而不是直接开始动手写作业。
## 实验概述
MiniDecaf [^1] 是一个 C 的子集，去掉了`include/define`等预处理指令，多文件编译支持，以及结构体/指针等语言特性。 本学期的编译实验要求同学们通过多次“思考-实现-重新设计”的过程，一步步实现从简单到复杂的 MiniDecaf 语言的完整编译器，能够把 MiniDecaf 代码编译到 RISC-V 汇编代码。进而深入理解编译原理和相关概念，同时具备基本的编译技术开发能力，能够解决编译技术问题。MiniDecaf 编译实验分为多个 stage，每个 stage 包含多个 step。**每个 step 大家都会完成一个可以运行的编译器**，把不同的 MiniDecaf 程序代码编译成 RISC-V 汇编代码，可以在 QEMU/SPIKE 硬件模拟器上执行。随着实验内容一步步推进，MiniDecaf 语言将从简单变得复杂。每个步骤都会增加部分语言特性，以及支持相关语言特性的编译器结构或程序（如符号表、数据流分析方法、寄存器分配方法等）。下面是采用 MiniDecaf 语言实现的快速排序程序，与 C 语言相同。
```c
int qsort(int a[], int l, int r) {
int i = l; int j = r; int p = a[(l+r)/2];
while (i <= j) {
while (a[i] < p) i = i + 1;
while (a[j] > p) j = j - 1;
if (i > j) break;
int u = a[i]; a[i] = a[j]; a[j] = u;
i = i + 1;
j = j - 1;
}
if (i < r) qsort(a, i, r);
if (j > l) qsort(a, l, j);
return 0;
}
```
2024 年秋季学期基本沿用了 2023 年秋季学期《编译原理》课程的语法规范。为了贴合课程教学内容，提升训练效果，课程组设计了比较完善的编译器框架，包括词法分析、语法分析、语义分析、中间代码生成、数据流分析、寄存器分配、目标平台汇编代码生成等步骤。每个 step 同学们都会面对一个完整的编译器流程，但不必担心，实验开始的几个 step 涉及的编译器框架知识都比较初级，随着课程实验的深入，将会循序渐进地引入各个编译器功能模块，并通过文档对相关技术进行分析介绍，便于同学们实现相关编译功能模块。
从2023年起，课程组增加了大实验环节，大实验是一个**可选**环节。可以参考[大实验参考文档](docs/contest/intro.md)获取更多信息。
## 实验起点和基本要求
本次实验一共设置 13 个步骤（其中 step 0 和 step 1 为实验框架熟悉，不需要修改框架代码）。后续的 step 2-13 我们将由易到难完成 MiniDecaf 语言的所有特性，由于编译器的边界情况很多，你**只需通过我们提供的正例与负例即可**。
我们以 stage 组织实验，各个 stage 组织如下：
-
第一个编译器（step0-step1）。我们给的实验框架可以通过所有测试用例，你需要做的事情为跟着文档阅读学习实验框架代码。请各位同学注意，stage0 尤为重要，掌握好实验框架是高质量和高效率完成后续实验的保证。
-
常量表达式（step2-step4）。在这个 stage 中你将实现常量操作（加减乘除模等）。
-
变量和赋值（step5）。在这个 stage 中你将第一次支持变量声明与赋值。
-
作用域和块语句（step6）。在这个 stage 中你的编译器将支持作用域，以便支持后续的条件和循环。
-
条件和循环（step7-step8）。在这个 stage 中你将支持条件判断和循环语句，此时，你的编译器可以编译的程序就从线性结构程序到了有分支结构的程序。
-
函数（step9）。在这个 stage 中你将支持函数的声明和调用，这样你就可以写很多有意思的代码了。
-
全局变量和数组（step10-step12）。在这个 stage 中，你将支持全局变量和数组，数组中包括全局数组和局部数组。
-
寄存器分配算法（step13）。在这个 stage 中，你将实现基于图染色的寄存器分配算法，替代当前框架中简单的启发式算法。
其中，stage0 为环境配置和框架学习，无需进行编程，不计入成绩。
stage1 - stage5 为 5 个基础关卡，你需要通过它们以拿到一定的分数（35%）。
stage6 为升级关卡，如果你学有余力，完成它们可以减少期末考试在总评中所占的比重（完整完成可以获得占总评 7% 的成绩并替代期末考试对应权重）。
stage7 为进阶关卡，如果你依然学有余力，你可以在这里实现一些编译优化（完整完成可以获得占总评 8% 的成绩并替代期末考试对应权重）。注意，你需要在完成 stage6 后才能尝试 stage7，否则无法获得对应分数。
我们以 step 组织文档，每个 step 的文档都将以如下形式组织：首先我们会介绍当前 step 需要用到的知识点，其次我们会以一个当前 step 具有代表性的例子介绍它的整个编译流程。在之前 step 中已经介绍的知识点，我们会略过，新的知识点和技术会被详细介绍。
我们通过[问答墙](https://docs.qq.com/doc/DY1hZWFV0T0N0VWph)来集中解决大家在环境配置及完成实验中遇到的问题。如果你遇到了任何问题，都可以在[问答墙](https://docs.qq.com/doc/DY1hZWFV0T0N0VWph)中检索；如果你的问题尚未有其他人提问过，欢迎向助教提问，助教会尽快回复的。
### **诚信守则**
**请注意，诚信守则是参加本课程的学生应遵守的道德行为规范。实验指导中给出的生成结果（抽象语法树、三地址码、汇编）只是一种参考的实现，同学们可以按照自己的方式实现，只要能够通过测试用例即可。但是，严格杜绝抄袭现象，如果代码查重过程中发现有抄袭现象，抄袭者与主动提供抄袭信息的被抄袭者将被记为0分。**
## 实验提交
大家在网络学堂提交 **git.tsinghua.edu.cn** 的帐号名后，助教会给每个人建立一个私有的仓库，URL 为 https://git.tsinghua.edu.cn/compiler24/stu24/minidecaf-你的学号 ，将作业提交到那个仓库即可。
每个 stage 会对应于一个 branch，当切换到一个新的 branch 上实现时，你可以用 `git checkout -b` 来创建一个新的分支。
本学期我们使用清华大学代码托管服务（git.tsinghua）的 CI（持续集成）来**测试**大家的代码实现及**提交实验报告**。
`.gitlab-ci.yml` 中描述了如何运行 CI，你**不允许**修改此文件；
`prepare.sh` 是在测试前会运行的准备脚本，包括安装所需的依赖（python），如果你想添加新的依赖或者修改编译流程，请修改此文件。
在 CI 中会检查是否通过所有测例及是否有提交报告，只有通过所有测例且提交报告，才会被视为通过 CI。
我们只接受 pdf 格式的实验报告。你需要将报告放在仓库的 `./reports/.pdf` 路径，比如 stage 1 的实验报告需要放在 `stage-1` 这个 branch 下的 `./reports/stage-1.pdf`。
实验报告中需要包括：
* 你的学号姓名
* 简要叙述，为了完成这个 stage 你做了哪些工作（即你的实验内容）
* 指导书上的思考题
* 如果你复用借鉴了参考代码或其他资源，请明确写出你借鉴了哪些内容。*并且，即使你声明了代码借鉴，你也需要自己独立认真完成实验。*
* 如有代码交给其他同学参考，也必须在报告中声明，告知给哪些同学拷贝过代码（包括可能通过间接渠道传播给其他同学）。
## 评分标准
对于每个阶段（stage）：
* 80% 的成绩是自动化测试的结果，你可以直接在 **git.tsinghua** 的 CI 测试中看到。
* 20% 的成绩是实验报告，其中对实验内容的描述占 10%，对思考题的回答占 10%。
评分会以每个 stage 的 branch 最后一次触发的 CI 及触发此次 CI 的 commit 里的实验报告为准，详见[补交政策](docs/misc/schedule.md#补交政策)。
如果你认为成绩有问题，请及时与助教联系。
时间安排及补交政策请看[实验进度安排](docs/misc/schedule.md)。
## 学术规范
由于实验有一定难度，同学之间相互学习和指导是提倡的。
对于其他同学的代码（包括实验报告中思考题的回答），可以参考，但禁止直接拷贝。
如有代码交给其他同学参考，必须在报告中声明，告知给哪些同学拷贝过代码（包括可能通过间接渠道传播给其他同学）。
请所有同学不要将自己的代码托管至任何公开的仓库上（如 GitHub），托管至私有仓库的请不要给其他同学任何访问权限。
我们将会对所有同学的代码作相似度检查，如发现有代码雷同的情形，拷贝者和被拷贝者将会得到同样的处罚，除非被拷贝的同学提交时已做过声明。
代码雷同情节严重的，课程组有权上报至院系和学校，并按照相关规定严肃处理。
## 相关资源
- [实验指导书（首页有实验报告提交要求）](https://decaf-lang.github.io/minidecaf-tutorial/)
- [实验指导书勘误表](https://decaf-lang.github.io/minidecaf-tutorial/docs/step0/errate.html)
- [课程问答墙](https://docs.qq.com/doc/DY1hZWFV0T0N0VWph)
- [实验思路指导与问答墙](https://docs.qq.com/doc/DY05QVmJFcGNWcllo)
## 参考资料
- [Writing a C Compiler: by Nora Sandler](https://norasandler.com/2017/11/29/Write-a-Compiler.html)
- [nqcc](https://github.com/nlsandler/nqcc)
- [http://scheme2006.cs.uchicago.edu/11-ghuloum.pdf](http://scheme2006.cs.uchicago.edu/11-ghuloum.pdf)
## 备注
[^1]: 关于名字由来，由于往年的实验叫 Decaf，我们在新的且更简单的语言规范下复用了 Decaf 的编译器框架，所以今年的实验就叫 MiniDecaf 了。