课程实例-计算机组成原理（研讨课）

计组研讨课应该是第一个强制要求使用 Linux + Git 的课程。在本章中，我们会对课件中出现的命令进行解释，但仍建议您抽空阅读 Linux 基础一节和 Git 一节，以便对它们有更全面的了解。

文本量较大，建议使用Ctrl + F搜索功能快速定位到需要的地方

命令解释

以2021-2022学年春季学期课件为准的命令解释，以后可能会有所不同，欢迎 Issue / PR。

注意：课件上很多引号"、短横线-由于 PPT 默认设置变成了中文全角字符，建议手动输入命令，不要复制粘贴以免出现问题

P01-实验课及平台开发流程简介-v6.pdf

git config --global user.name "Your_last_name<空格>Your_first_name"
- 用于配置 git 用户名
- git为命令，使用git --help查看帮助
- config为git的子命令，修改 git 配置，使用git config --help查看帮助
- --global是一个 flag，表示该修改是用户全局的，即对当前用户的所有仓库生效。常用的还有--local，表示对当前仓库生效
- user.name为配置的键，表示要修改的配置是用户名
- "Your_last_name<空格>Your_first_name"为配置的值，表示要修改成什么。两端的引号用于包裹含空格的参数，见空格与引号一节
- 成功时，命令无回显，见回显一节
- 若需确保配置正确，可使用--get flag 获取配置值，即git config --get user.name
git config --global user.email "GitLab注册邮箱"
- 用于配置 git 用户邮箱
- 大部分与上一条（1）相同，只是配置键变为了user.email，不再赘述
git config --global core.editor vim
- 这一配置会指定 git 使用的默认编辑器为 vim。亦可使用 nano 等您熟悉的编辑器代替
- 大部分与上一条（1）相同，只是配置键变为了core.editor
cd && ssh-keygen –t rsa –C "GitLab注册邮箱"
- 用于生成 ssh 密钥对，进而用于 git 远程仓库（GitLab）免密码身份认证
- cd为切换目录命令，缺省参数时切换到用户主目录。已经处于主目录时可以省去，下同。见常见命令-cd
- &&为与运算符，表示当前一条指令执行成功时执行后一条指令，见常见命令-与
- ssh-keygen为生成 ssh 密钥对，使用ssh-keygen --help查看帮助，见 ssh 一节
- -t rsa表示指定密钥类型为rsa，个人认为这块可以不写（使用默认密钥类型，通常是rsa或ed25519，现在常用的 git 平台和 ssh 服务器都支持使用这两者，前者兼容性更好，后者性能更好且安全性更高，参考）
- -C "GitLab注册邮箱"表示为密钥对添加注释，注释内容为 GitLab 注册邮箱，个人认为可以不写
- 也就是说，如果已经处在用户主目录，并且不指定密钥类型和注释，整条命令可以简化为ssh-keygen
gedit ~/.ssh/id_rsa.pub
- 使用 gedit 编辑器打开 ssh 公钥文件以便复制
- 文件路径为~/.ssh/id_rsa.pub，~表示用户主目录，见目录与路径一节
- 个人不推荐使用 gedit，见图形化与命令行一节
- 相对的，建议使用cat ~/.ssh/id_rsa.pub代替，见常见命令-cat
cd && gedit .gitlab.token
- 使用 gedit 编辑器打开~/.gitlab.token文件以便写入
- 同上（5）不推荐使用 gedit，建议用vim / nano代替
- 亦推荐使用echo <your_token> > ~/.gitlab.token代替，见常见命令-echo，<your_token>处替代为从网页上复制的 PAT (personal access token)
sudo apt install -f vim jq curl
- 使用apt安装 vim / jq / curl
- sudo为使用超级用户权限执行，由于安装软件是敏感行为，必须具有超级用户权限，见常用命令-sudo
- apt见安装程序-apt
- install为apt的子命令，表示要执行安装
- -f存疑，强制执行？
- 后续的参数为要安装的软件包名
cd && git clone https://<gitlab_url>/<GitLab用户名> COD-Lab
- 将远程仓库克隆到本地
- clone为git的子命令，克隆远程仓库，使用git clone --help查看帮助
- 随后的参数是远程仓库地址
- 最后是要保存到的本地仓库路径，默认为当前目录下与远程仓库同名的子目录
- 个人认为这里有误，因为使用 https 协议不支持 ssh 密钥对方式的身份验证，在没有身份管理器的情况下每次操作远程仓库，都会要求输入用户名与密码，十分麻烦
- 相对的，应该使用git clone ssh://<gitlab_url>/<GitLab用户名> COD-Lab代替，需要注意的是 ssh 协议使用的端口号与 https 协议不同
cd ~/COD-Lab && git remote add upstream https://<gitlab_url>/ucas-cod-2021-dev/cod-lab
- 添加远端上游仓库
- remote为git的子命令，修改本地仓库的远端配置，使用git remote --help查看帮助
- add表示操作的类型是添加远端配置
- upstream是新远端配置的名称，可以自由指定，只要保证与下一条配套即可
- 随后的参数是远端的地址，同上（8）我认为应改为 ssh 协议
cd ~/COD-Lab && git pull upstream master
- 拉取远端上游仓库
- pull为git的子命令，拉取远端仓库，使用git pull --help查看帮助
- 随后的第一个参数为远端配置的名称。默认为origin，即最初仓库初始化/克隆下来的远端。而这里指定的是上一步（9）设置的上游仓库（即老师所写实验框架的仓库），因此不可缺省
- 随后的第二个参数为本地分支的名称。默认为当前所处分支，因此若没有使用过git branch切换分支，可以缺省不写
cd ~/COD-Lab && vim fpga/design/ucas-cod/hardware/sources/example/adder.v
- 使用 vim 编辑实验代码
- 建议用 vscode 等替代，更容易上手
cd ~/COD-Lab && git add fpga/design/ucas-cod/hardware/sources/example/adder.v
- git 追踪实验代码文件
- add为git的子命令，追踪文件，使用git add --help查看帮助
- 随后的参数为要追踪的路径
- 比较偷懒的方法是追踪整个仓库cd ~/COD-Lab && git add .或cd ~/COD-Lab && git add --all，或在commit时使用-a参数（即git commit -a）。但这样使用需要注意，不要追踪不该追踪的文件（例如日志文件*.log等）
cd ~/COD-Lab && git commit
- git 提交 commit
- commit为git的子命令，提交 commit，使用git commit --help查看帮助
- 这样会采用交互式的方法使用之前设置的core.editor填写 commit message
- 更推荐的方法是直接使用-m参数把 commit message 写在命令里，如下所示。由于标题和内容是一整个字符串，中间包含换行符，所以两端要用引号包裹，若信息中带有引号，请使用转义符。习惯上标题和信息间空一行
```
$ cd ~/COD-Lab && git commit -m "<commit_title>

<commit_message>"
```
cd ~/COD-Lab && git log
- git 查看提交记录
- log为git的子命令，查看 commit 提交记录，使用git log --help查看帮助
- 采用阅读模式，按q退出
cd ~/COD-Lab && git push origin master
- git 推送本地修改到远程
- push为git的子命令，追踪文件，使用git push --help查看帮助
- 和git pull是一对，参数格式相同，即
- 随后的第一个参数为远端配置的名称。默认为origin，即最初仓库初始化/克隆下来的远端，这里可以缺省不写
- 随后的第二个参数为本地分支的名称。默认为当前所处分支，因此若没有使用过git branch切换分支，可以缺省不写
cd ~/COD-Lab && make FPGA_PRJ=ucas-cod FPGA_BD=nf SIM_TARGET=example wav_chk
- 查看波形
- make是一个构建工具，参考
- 随后的几个key=value的键值对用来设置make的环境变量
- 最后的wav_chk为构建目标
- 用在这里是为了简化我们学生的操作，本质上执行了：
  - 利用之前保存的.gitlab.token文件登录到云平台
  - 获取流水线运行情况
  - 下载流水线运行结果（artifact）
  - 使用gtkwave打开波形文件
  - ...
- 相对而言属于进阶内容，请自行学习make或死记硬背
- 可以查看各目录下的Makefile和*.mk文件尝试解读

P02-基本功能部件设计-v9.pdf

cd ~/COD-Lab && git add lab_env.yml && git commit -m "lab_env: set design flow for reg_file"
- 移动到仓库中、追踪./lab_env.yml文件、git 提交
- 前两部分应该无需再解释
- 如 P1（13）中解释，git commit的-m选项用于指定 commit message ，此处即为“lab_env: set design flow for reg_file”
- 事实上这个 message 可以不与老师严格一致，只要自己能理解即可
cd ~/COD-Lab && make FPGA_PRJ=ucas-cod FPGA_BD=nf SIM_TARGET=reg_file bhv_sim
- 本地行为仿真
- 与 P1（16）中类似，通过make工具简化了我们的操作，构建目标从wav_chk变为了bhv_sim，环境变量中SIM_TARGET一项的值从example变为了reg_file
cd ~/COD-Lab && gtkwave -f fpga/sim_out/reg_file/dump.vcd
- 本地查看波形
- 由于是在本地行为仿真，波形文件保存在~/COD-Lab/fpga/sim_out/reg_file/dump.vcd而非云端流水线的 Artifact 中，因此无法使用以前（如 P1（16））的make ... wav_chk命令查看波形
- 相对的，直接使用gtkwave工具，-f <path>指定波形文件路径
cd ~/COD-Lab && git add reports/ && git commit -m "docs: add prj1 report"
- 与（1）类似，但有两点值得一提：
- 注意第二部分中git add后的参数是一个目录reports，即追踪该目录下的所有文件，如担心误提交亦可使用git add reports/prj1.pdf精确到文件
- 注意第三部分中的 commit message 以docs:开头。尽管我们说 commit message 是给人看的，对电脑无所谓，但这是一个特例。为了节省流水线运行资源，老师设置了以docs:开头的提交不会触发流水线运行，如有需要，在云平台上可以手动触发运行

P03-简单功能型处理器设计-v8.pdf

cd ~/COD-Lab && git tag -a simple_cpu-single_cycle -m "Release single_cycle CPU design"
- git 添加标签
- -a <tagname>指定标签名
- -m <message>指定标签信息，类似commit中的-m <message>参数
- 标签名需要与老师严格一致，便于老师检查判分
cd ~/COD-Lab && git push origin master --tags
- git 推送本地标签到远程
- 与 P01（15）类似，只是多了--tags开关，表示推送标签
- 若本地有新的 commit，则建议先执行git push，随后git push --tags

P03补充

git tag -d <tag>
- git 删除标签<tag>
- 已经打了某个标签，又修改了代码需要重新打标签，这种情况下需要先使用这条指令删除已有标签，随后如 P03（1）重新添加即可
- 云平台上的标签需要手动删除，或在推送时使用-f强制推送选项，即git push origin master --tags -f

P04 ~ P06

无新增

其余注意事项

简化命令

~~偷懒大法~~

经过上面的解释，可以注意到老师提供的命令有一些只是为了提高鲁棒性（避免因个人配置不同出错），例如

无需执行的命令：几乎每个命令前都存在的cd &&
无需指定的参数：git push origin master -> git push

随着对 Linux 熟练度的提高，例如

养成了关注当前工作目录的习惯
熟悉了参数默认值

可以试着简化老师的命令，这可以有效的提高对 Linux 各种机制的理解，同时节省时间

拉取上游仓库

在学期中，老师也会对实验框架做出更新（优化/修复），因此建议每次开始编写代码前，先执行git pull upstream master及时拉取更新

在拉取更新时，可能遇到冲突，即在原先共有的提交上，老师和你各自在仓库中进行了新的提交，此时需要使用 rebase 或者 merge 进行合并

Git-分支-变基

环境搭建

~~从此开始抛弃老师提供的环境吧~~

TODO

FAQ

建议首先阅读应对错误一章

VirtualBox 报错

Failed to load R0 module xxx: The path is not clean of leading double slashes: xxx

无法加载 R0 特权级模块，通常是虚拟机软件安装目录下有不该有的文件导致

报了这个错的话尝试卸载 VirtualBox 重新安装吧

不要把软件装到根目录或者与其它软件共享！

一般安装到x:\Program Files\yyy下（x是盘符，一般用c盘或d盘；yyy为软件目录，通常与软件名一致，不要用中文）

*Failed to load R0 module. | virtualbox.org

杂项报错

Invalid operation xxx

参数无效

检查命令是否输入正确

xxx: command not found

命令无效

检查命令是否输入正确，检查软件包是否已安装

应对错误-未找到命令

Connection time out

连接超时

检查网络连接，校园网是否登录、域名和端口号是否正确等

Waiting for cache lock: Could not get lock xxx. It is held by process yyy (zzz).

等待缓存锁

有些操作，例如通过apt install / dpkg -i安装软件，需要避免多个进程出现冲突，因此加互斥锁。当有另一个进程正在工作时，试图执行这些操作就会进入等待锁的状态

一般等一段时间，等另一个进程完成工作释放锁，即可正常执行

若很长时间（15min+）仍未完成，可考虑重启，或使用kill -9 yyy强制终止进程（yyy为报错提示中的进程号）

dpkg was interrupted, you must manually run `sudo dpkg --configure -a` to correct the problem

之前调用dpkg安装软件的进程异常终止（例如上面提到的使用kill -9终止）

按提示执行sudo dpkg --configure -a即可

Error opening .vcd file 'xxx.vcd'. Why: No such file or directory

使用 gtkwave 打开波形文件时，指定的文件不存在

若使用云端流水线，通过make命令获取波形，请检查：

流水线运行状态（是否完成？）
make命令是否有其他报错，例如网络错误、未找到软件包等

若使用本地仿真，通过gtkwave命令直接打开波形文件，请检查：

本地仿真是否完成
对应的目录下是否存在波形文件，可通过ls -alR ~/COD-Lab/fpga/sim_out/列出仿真输出下的文件

git 报错

fatal: loose object xxx is corrupt

可能是文件系统损坏造成 git 仓库损坏

考虑备份本地修改（可以整个仓库除了.git文件夹全复制出来）以后删除仓库、重新克隆

fatal: unable to create xxx: Read-only file system

可能是文件系统损坏

见应对错误-文件系统故障一节

![rejected] ... error: failed to push some refs to 'xxx'

下面应该会有hint:开头的提示

如果执行的是git push，很多情况是远端仓库存在比本地更新的 commit 导致的，也可能是网络故障

先尝试执行git pull或git pull --rebase拉取远端修改，随后重新push

如果执行的是git push --tags，且存在过本地删除标签重新打的情况，则应该是远端仓库中已经存在这个标签导致的

在云平台左侧菜单 repository-tags 界面删除对应标签，随后重新push --tags即可

亦可以增加强制推送-f参数，即git push -f --tags

云平台报错

Included file `xxx.yml` does not have valid YAML syntax

提示中的xxx.yml文件格式不正确，对照 yaml 入门教程 | 菜鸟教程检查格式

一个很重要的坑是 Tab 和空格的差异，如果肉眼看上去没有问题，请着重检查每行开头使用的是 Tab 还是空格

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

COD.md

COD.md

课程实例-计算机组成原理（研讨课）

目录

命令解释

P01-实验课及平台开发流程简介-v6.pdf

P02-基本功能部件设计-v9.pdf

P03-简单功能型处理器设计-v8.pdf

P03补充

P04 ~ P06

其余注意事项

简化命令

拉取上游仓库

环境搭建

FAQ

VirtualBox 报错

Failed to load R0 module xxx: The path is not clean of leading double slashes: xxx

杂项报错

Invalid operation xxx

xxx: command not found

Connection time out

Waiting for cache lock: Could not get lock xxx. It is held by process yyy (zzz).

dpkg was interrupted, you must manually run `sudo dpkg --configure -a` to correct the problem

Error opening .vcd file 'xxx.vcd'. Why: No such file or directory

git 报错

fatal: loose object xxx is corrupt

fatal: unable to create xxx: Read-only file system

![rejected] ... error: failed to push some refs to 'xxx'

云平台报错

Included file `xxx.yml` does not have valid YAML syntax

Files

COD.md

Latest commit

History

COD.md

File metadata and controls

课程实例-计算机组成原理（研讨课）

目录

命令解释

P01-实验课及平台开发流程简介-v6.pdf

P02-基本功能部件设计-v9.pdf

P03-简单功能型处理器设计-v8.pdf

P03补充

P04 ~ P06

其余注意事项

简化命令

拉取上游仓库

环境搭建

FAQ

VirtualBox 报错

Failed to load R0 module xxx: The path is not clean of leading double slashes: xxx

杂项报错

Invalid operation xxx

xxx: command not found

Connection time out

Waiting for cache lock: Could not get lock xxx. It is held by process yyy (zzz).

dpkg was interrupted, you must manually run sudo dpkg --configure -a to correct the problem

Error opening .vcd file 'xxx.vcd'. Why: No such file or directory

git 报错

fatal: loose object xxx is corrupt

fatal: unable to create xxx: Read-only file system

![rejected] ... error: failed to push some refs to 'xxx'

云平台报错

Included file xxx.yml does not have valid YAML syntax

dpkg was interrupted, you must manually run `sudo dpkg --configure -a` to correct the problem

Included file `xxx.yml` does not have valid YAML syntax