# rvcc-course

**Repository Path**: koverlu/rvcc-course

## Basic Information

- **Project Name**: rvcc-course
- **Description**: port from github
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-06-13
- **Last Updated**: 2023-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# rvcc-course

这里是[RVCC](https://github.com/sunshaoce/rvcc)课程的相关仓库，存放了课程相关的材料。

- 课程对应的代码仓库位于：https://github.com/sunshaoce/rvcc
- 课程对应的视频课程位于：https://space.bilibili.com/296494084/channel/collectiondetail?sid=571708
- 课程对应的QQ群号为：752911871
- 课程对应的微信群：请添加微信号 fangzhang1024 ，备注rvcc进群

欢迎利用PR来对本仓库进行补充。

----------
  * 【1】 这个课程都需要准备什么东西？
  * 【2】 如何安装RISCV的实验环境
    + 方式一（推荐）：解压预先编译好的RISCV环境（基于Ubuntu 20.04）
    + 方式二：源代码编译RISCV环境（较难）
    + 方式三：使用配置好的Docker环境
  * 【3】 如何对RVCC中的项目使用`make test`进行测试
    + 第1课～第22课
    + 第23课～第44课
    + 第45课～第154课
    + 第155课～第178课
    + 第179课～第361课
  * 【4】 跳转脚本（可选）

## 【1】 这个课程都需要准备什么东西？
1. Linux的运行环境，推荐Ubuntu 20.04。
1. RISC-V的实验环境（需要编译器和模拟器），如何安装参考问题【2】。
1. 下载RVCC的仓库，即`git clone https://github.com/sunshaoce/rvcc`。

## 【2】 如何安装RISCV的实验环境
三种方式，自由选择，新手推荐方式1.

### 方式一（推荐）：解压预先编译好的RISCV环境（基于Ubuntu 20.04）
运行仓库的`install-riscv-1.sh`即可。

### 方式二：源代码编译RISCV环境（较难）。
这里我们编译出编译器gcc和模拟器qemu。使用本课程的`install-riscv-2.sh`脚本（**请勿直接运行**），使用方法参考视频：[RISCV环境快速配置](https://www.bilibili.com/video/BV1D54y1m78G)。

### 方式三：使用配置好的Docker环境
详情可以参考：https://github.com/ksco/rvcc-env-docker

## 【3】 如何对RVCC中的项目使用`make test`进行测试
首先，你需要找到你**RISCV实验环境的路径**，方式一、二的路径为：`~/riscv`。

其次，你需要将`test.sh`或`Makefile`中的下面几行代码，选择为你对应的编译器和模拟器，例子（默认为gcc和qemu）如下方所示。

最后运行`RISCV=~/riscv make test`，注意这里的`~/riscv`必须是你**RISCV实验环境的路径**。

### 第1课～第22课
修改前：
```shell
  # 运行程序，传入期待值，将生成结果写入tmp.s汇编文件。
  # 如果运行不成功，则会执行exit退出。成功时会短路exit操作
  ./rvcc "$input" > tmp.s || exit
  # 编译rvcc产生的汇编文件
  clang -o tmp tmp.s
  # $RISCV/bin/riscv64-unknown-linux-gnu-gcc -static -o tmp tmp.s

  # 运行生成出来目标文件
  ./tmp
  # $RISCV/bin/qemu-riscv64 -L $RISCV/sysroot ./tmp
  # $RISCV/bin/spike --isa=rv64gc $RISCV/riscv64-unknown-linux-gnu/bin/pk ./tmp
```
修改后：
```shell
  # 运行程序，传入期待值，将生成结果写入tmp.s汇编文件。
  # 如果运行不成功，则会执行exit退出。成功时会短路exit操作
  ./rvcc "$input" > tmp.s || exit
  # 编译rvcc产生的汇编文件
  # clang -o tmp tmp.s
  $RISCV/bin/riscv64-unknown-linux-gnu-gcc -static -o tmp tmp.s

  # 运行生成出来目标文件
  # ./tmp
  $RISCV/bin/qemu-riscv64 -L $RISCV/sysroot ./tmp
  # $RISCV/bin/spike --isa=rv64gc $RISCV/riscv64-unknown-linux-gnu/bin/pk ./tmp
```
### 第23课～第44课
在`第1课～第22课`的基础上，再将
```shell
# 将下列代码编译为tmp2.o，"-xc"强制以c语言进行编译
# cat <<EOF | $RISCV/bin/riscv64-unknown-linux-gnu-gcc -xc -c -o tmp2.o -
cat <<EOF | clang -xc -c -o tmp2.o -
int ret3() { return 3; }
int ret5() { return 5; }
EOF
```
改为（**注意此处删去了一行，不是注释掉**）：
```shell
# 将下列代码编译为tmp2.o，"-xc"强制以c语言进行编译
cat <<EOF | $RISCV/bin/riscv64-unknown-linux-gnu-gcc -xc -c -o tmp2.o -
int ret3() { return 3; }
int ret5() { return 5; }
EOF
```
### 第45课～第154课
这个时候已经没有了`test.sh`，我们直接修改`Makefile`。
```Makefile
# 测试标签，运行测试
test/%.exe: rvcc test/%.c
	$(CC) -o- -E -P -C test/$*.c | ./rvcc -o test/$*.s -
#	$(RISCV)/bin/riscv64-unknown-linux-gnu-gcc -o- -E -P -C test/$*.c | ./rvcc -o test/$*.s -
	$(CC) -static -o $@ test/$*.s -xc test/common
#	$(RISCV)/bin/riscv64-unknown-linux-gnu-gcc -static -o $@ test/$*.s -xc test/common

test: $(TESTS)
	for i in $^; do echo $$i; ./$$i || exit 1; echo; done
#	for i in $^; do echo $$i; $(RISCV)/bin/qemu-riscv64 -L $(RISCV)/sysroot ./$$i || exit 1; echo; done
#	for i in $^; do echo $$i; $(RISCV)/bin/spike --isa=rv64gc $(RISCV)/riscv64-unknown-linux-gnu/bin/pk ./$$i || exit 1; echo; done
	test/driver.sh
```
改为（**注意需要删去几行，而非注释掉**）：
```Makefile
# 测试标签，运行测试
test/%.exe: rvcc test/%.c
	$(RISCV)/bin/riscv64-unknown-linux-gnu-gcc -o- -E -P -C test/$*.c | ./rvcc -o test/$*.s -
	$(RISCV)/bin/riscv64-unknown-linux-gnu-gcc -static -o $@ test/$*.s -xc test/common

test: $(TESTS)
	for i in $^; do echo $$i; $(RISCV)/bin/qemu-riscv64 -L $(RISCV)/sysroot ./$$i || exit 1; echo; done
#	for i in $^; do echo $$i; $(RISCV)/bin/spike --isa=rv64gc $(RISCV)/riscv64-unknown-linux-gnu/bin/pk ./$$i || exit 1; echo; done
	test/driver.sh
```

### 第155课～第178课
在`第45课～第154课`的基础上，修改`main.c`进行交叉编译测试。
```c
// 【注意】
// 如果是交叉编译，请把这个路径改为$RISCV对应的路径
// 注意 ~ 应替换为具体的 /home/用户名 的路径
static char *RVPath = "";
```
改为**RISCV实验环境的路径**，例如`"~/riscv"`，同时`~`应替换为你的`"/home/用户名"`。
```c
// 【注意】
// 如果是交叉编译，请把这个路径改为$RISCV对应的路径
// 注意 ~ 应替换为具体的 /home/用户名 的路径
static char *RVPath = "/home/用户名/riscv";
```

### 第179课～第361课
和前面`第155课～第178课`类似，但是简化掉了之前的这个操作。
```shell
# 测试标签，运行测试
test/%.exe: rvcc test/%.c
	$(CC) -o- -E -P -C test/$*.c | ./rvcc -o test/$*.s -
#	$(RISCV)/bin/riscv64-unknown-linux-gnu-gcc -o- -E -P -C test/$*.c | ./rvcc -o test/$*.s -
```

## 【4】 跳转脚本（可选）
感谢 @daquexian。

用法是把它复制到 rvcc 项目目录之后：
```shell
./jump.sh n 跳转到下一节课程 commit
./jump.sh p 跳转到上一节课程的 commit
./jump.sh <number> 跳转到第 number 节课程的 commit
```
不想污染 rvcc 目录的话也可以不复制，只要在 rvcc 目录下用正确的脚本路径运行就行。