rvcc 项目教程

rvcc 项目教程

rvcc 本课程基于Rui的chibicc，@sunshaoce和@ksco将其由原来的X86架构改写为RISC-V 64架构，同时加入了大量的中文注释，并且配有316节对应于每一个commit的课程，帮助读者可以层层推进、逐步深入的学习编译器的构造。 项目地址: https://gitcode.com/gh_mirrors/rv/rvcc

1. 项目的目录结构及介绍

rvcc 项目的目录结构如下：

rvcc/
├── CMakeLists.txt
├── LICENSE
├── Makefile
├── README.md
├── codegen.c
├── hashmap.c
├── main.c
├── parse.c
├── preprocess.c
├── rvcc.h
├── string.c
├── tokenize.c
├── type.c
└── unicode.c

目录结构介绍

• CMakeLists.txt: 用于 CMake 构建系统的配置文件。
• LICENSE: 项目的开源许可证文件，采用 MIT 许可证。
• Makefile: 用于传统 Makefile 构建系统的配置文件。
• README.md: 项目的介绍文件，包含项目的概述、构建方法和使用说明。
• codegen.c: 代码生成模块，负责将抽象语法树（AST）转换为 RISC-V 汇编代码。
• hashmap.c: 哈希表实现，用于存储和查找符号表中的信息。
• main.c: 项目的主入口文件，负责调用编译器的各个模块。
• parse.c: 语法分析模块，负责将词法分析器生成的 token 转换为抽象语法树。
• preprocess.c: 预处理模块，负责处理宏定义和条件编译指令。
• rvcc.h: 项目的头文件，包含所有模块的声明和公共数据结构。
• string.c: 字符串处理模块，提供字符串操作的实用函数。
• tokenize.c: 词法分析模块，负责将源代码转换为 token 序列。
• type.c: 类型处理模块，负责处理和检查变量和函数的类型信息。
• unicode.c: Unicode 处理模块，负责处理 Unicode 字符和字符串。

2. 项目的启动文件介绍

项目的启动文件是 main.c。该文件是 rvcc 编译器的主入口，负责初始化编译器的各个模块，并调用这些模块来完成编译过程。

main.c 文件介绍

• main 函数：项目的入口点，负责解析命令行参数、初始化编译器环境、调用词法分析、语法分析、代码生成等模块，最终生成目标代码。
• init_compiler 函数：初始化编译器环境，包括符号表、类型系统等。
• compile 函数：编译主流程，依次调用词法分析、语法分析、代码生成等模块。

3. 项目的配置文件介绍

项目的主要配置文件包括 CMakeLists.txt 和 Makefile。

CMakeLists.txt 文件介绍

• project(rvcc): 定义项目名称。
• add_executable(rvcc main.c ...): 定义可执行文件的源文件列表。
• target_include_directories(rvcc PRIVATE .): 指定头文件的包含路径。
• target_link_libraries(rvcc ...): 指定链接的库文件。

Makefile 文件介绍

• CC = gcc: 指定编译器为 GCC。
• CFLAGS = -Wall -Wextra -std=c11: 指定编译选项，包括警告选项和 C11 标准。
• LDFLAGS =: 指定链接选项。
• all: rvcc: 定义默认目标为 rvcc。
• rvcc: main.o ...: 定义 rvcc 可执行文件的依赖关系。
• clean:: 定义清理目标，用于删除生成的目标文件和可执行文件。

rvcc 本课程基于Rui的chibicc，@sunshaoce和@ksco将其由原来的X86架构改写为RISC-V 64架构，同时加入了大量的中文注释，并且配有316节对应于每一个commit的课程，帮助读者可以层层推进、逐步深入的学习编译器的构造。 项目地址: https://gitcode.com/gh_mirrors/rv/rvcc