RTFM

我们在上一小节中已经在概念上介绍了一条指令具体如何执行, 其中有的概念甚至显而易见得难以展开. 但当我们决定往TRM中添加各种高效指令的同时, 也意味着我们无法回避繁琐的细节.

首先你需要了解指令确切的行为, 为此, 你需要阅读生存手册中指令集相关的章节. 具体地, 无论你选择何种ISA, 相应手册中一般都会有以下内容, 尝试RTFM并寻找这些内容的位置:

• 每一条指令具体行为的描述
• 指令opcode的编码表格

特别地, 由于x86的指令集的复杂性, 我们为选择x86的同学提供了一个简单的阅读教程.

如果你非常幸运地选择了riscv32, 你会发现目前只需要阅读很少部分的手册内容就可以了: 在PA中, riscv32的客户程序只会由RV32I和RV32M两类指令组成. 这得益于RISC-V指令集的设计理念 - 模块化.

RTFSC(2)

下面我们来介绍NEMU的框架代码如何实现指令的执行.

我们在PA1中提到:

我们可以看到cpu_exec()模拟了CPU的工作方式: 不断执行指令. exec_once()函数(在nemu/src/cpu/cpu.c中定义)让CPU执行当前PC指向的一条指令, 然后更新PC.

具体地, 在exec_once()中, 框架代码首先将当前的PC保存到全局译码信息decinfo的成员seq_pc中. 其中:

• decinfo结构在nemu/src/cpu/cpu.c中定义, 它用于记录一些全局译码信息供后续使用, 包括操作数的类型, 宽度, 值等信息. 还有一些信息是ISA相关的, NEMU用一个结构类型struct ISADecodeInfo来对这些信息进行抽象, 具体的定义在nemu/src/isa/$ISA/include/isa/decode.h中.
• seq代表顺序(sequential)的意思

然后decinfo.seq_pc的地址将被作为参数送进isa_exec()函数(在nemu/src/isa/$ISA/exec/exec.c中定义)中. isa_exec()显然是一个用于屏蔽ISA差异的API: 不同ISA的指令行为天然不同.

取指(instruction fetch, IF)

isa_exec()做的第一件事情就是取指令. 在NEMU中, 有一个函数instr_fetch()(在nemu/include/cpu/exec.h中定义)专门负责取指令的工作. 阅读这个函数的代码, 你就会发现取指操作的本质: 不过就是一次内存的访问而已.

译码(instruction decode, ID)

译码的目的是得到指令的操作和操作对象, 这主要是通过查看指令的opcode来决定的. 不同ISA的opcode会出现在指令的不同位置, 我们只需要根据指令的编码格式, 从取出的指令中抽取出相应的opcode即可.

取出opcode之后, 框架代码用它来对opcode_table数组进行索引, 取出其中的一个OpcodeEntry类型的元素. opcode_table数组其实就是我们之前提到的译码查找表, 这一张表通过操作码opcode来索引, 它记录了每一个opcode对应指令的译码辅助函数, 执行辅助函数, 以及操作数宽度. 有了这些信息, 我们就可以得知指令的具体操作了, 例如对两个寄存器进行加法操作.

这个从译码查找表中取得的元素将会被作为参数, 调用idex()函数(在nemu/include/cpu/exec.h中定义). 顾名思义, 这个函数就是用来进行译码和执行的.

刚才我们只是知道了指令的具体操作, 但我们还是不知道操作对象(例如具体要对哪两个寄存器进行加法操作呢). 为了解决这个问题, 框架代码需要进行进一步的译码工作. 具体地, idex()将会根据从译码查找表中取得的内容, 进一步调用相应的译码辅助函数(decode helper function). 译码辅助函数统一通过宏make_DHelper(在nemu/include/cpu/decode.h中定义)来定义:

#define make_DHelper(name) void concat(decode_, name) (vaddr_t *pc)

每个译码辅助函数负责进行一种类型的操作数译码, 把指令中的操作数信息分别记录在全局译码信息decinfo的src成员, src2成员和dest成员中, 它们分别代表两个源操作数和一个目的操作数. nemu/include/cpu/decode.h中定义了三个宏id_src, id_src2和id_dest, 用于方便地访问它们.

译码辅助函数的命名很直观, 直接反映了操作数的类型和数据流向. 以nemu/src/isa/x86/decode/decode.c为例, 其中的译码辅助函数主要以i386手册附录A中的操作数表示记号来命名. 例如I2r表示将立即数移入寄存器, 其中I表示立即数, 2表示英文to, r表示通用寄存器, 更多的记号请参考i386手册.

我们会发现, 类似寄存器和立即数这些操作数, 其实是非常常见的操作数类型. 为了进一步实现操作数译码和指令译码的解耦, 框架代码对这些操作数的译码进行了抽象封装, 指令译码过程由若干操作数译码辅助函数(operand decode helper function)组成. 操作数译码辅助函数统一通过宏make_DopHelper来定义

// nemu/src/isa/x86/decode/decode.c
#define make_DopHelper(name) void concat(decode_op_, name) (vaddr_t *pc, Operand *op, bool load_val)

注意不同ISA的make_DopHelper定义会有不同. 以x86为例, 操作数译码辅助函数会把操作数的信息记录在结构体op中, 如果操作数在指令中, 就会通过instr_fetch()将它们从pc所指向的内存位置取出. 为了使操作数译码辅助函数更易于复用, 函数中将带有一个load_val参数, 用于控制是否需要将该操作数读出到全局译码信息decinfo供后续使用. 例如如果一个内存操作数是源操作数, 就需要将这个操作数从内存中读出来供后续执行阶段来使用; 如果它仅仅是一个目的操作数, 就不需要从内存读出它的值了, 因为执行这条指令并不需要这个值, 而是将新数据写入相应的内存位置.

x   x+1  x+2  x+3
+----+----+----+----+
| 34 | 12 | 00 | 00 |
+----+----+----+----+

op_src->imm = instr_fetch(pc, 4);

执行(execute, EX)

idex()函数中的译码过程结束之后, 会调用译码查找表中的相应的执行辅助函数(execution helper function)来进行真正的执行操作. 执行辅助函数统一通过宏make_EHelper(在nemu/include/cpu/exec.h中定义)来定义:

#define make_EHelper(name) void concat(exec_, name) (vaddr_t *pc)

它们的名字是指令操作本身. 执行辅助函数通过RTL指令来描述指令真正的执行功能(RTL指令将在下文介绍).

特别地, 对于x86来说, 大部分计算指令都可以访问内存, 于是框架代码提供了operand_write()函数(在nemu/src/isa/x86/decode/decode.c中定义), 来根据目的操作数类型的不同, 决定是写入寄存器还是写入内存; 而对于mips32和riscv32, 访问内存只能通过特定的访存指令进行, 因此每条指令的目的操作数类型都是唯一的.

更新PC

为了更新PC, 我们需要确定刚刚执行完的指令的长度. 事实上, 在instr_fetch()中, 每次取指都会更新它的pc参数, 而这个参数就是在exec_once()调用isa_exec()时传入的decinfo.seq_pc. 在isa_exec()执行的过程中, decinfo.seq_pc将会随着取出的指令长度而增长. 因此当代码从isa_exec()返回时, decinfo.seq_pc将会指向下一条静态指令的地址, 此时通过update_pc()(在nemu/include/cpu/exec.h中定义)对PC进行更新即可.

100: jmp 102
101: add
102: xor

上文已经把一条指令在NEMU中执行的流程进行了大概的介绍, 但还有少量的细节没有完全覆盖(例如指令组的译码表), 这些细节就交给你来去尝试理解啦. 不过为了特别照顾选择x86的同学, 我们还是准备了一个例子来RTFSC.

结构化程序设计

对于x86, 细心的你会发现以下规律:

• 对于同一条指令的不同形式, 它们的执行阶段是相同的. 例如add_I2E和add_E2G等, 它们的执行阶段都是把两个操作数相加, 把结果存入目的操作数.
• 对于不同指令的同一种形式, 它们的译码阶段是相同的. 例如add_I2E和sub_I2E等, 它们的译码阶段都是识别出一个立即数和一个E操作数.
• 对于同一条指令同一种形式的不同操作数宽度, 它们的译码阶段和执行阶段都是非常类似的. 例如add_I2E_b, add_I2E_w和add_I2E_l, 它们都是识别出一个立即数和一个E操作数, 然后把相加的结果存入E操作数.

这意味着, 如果独立实现每条指令不同形式不同操作数宽度的辅助函数, 将会引入大量重复的代码. 需要修改的时候, 相关的所有辅助函数都要分别修改, 遗漏了某一处就会造成bug, 工程维护的难度急速上升.

一种好的做法是把译码, 执行和操作数宽度的相关代码分离开来, 实现解耦, 也就是在程序设计课上提到的结构化程序设计. 在框架代码中, 实现译码和执行之间的解耦的是idex()函数, 它依次调用opcode_table表项中的译码和执行的辅助函数, 这样我们就可以分别编写译码和执行的辅助函数了. 实现操作数宽度和译码, 执行这两者之间的解耦的是id_src, id_src2和id_dest中的width成员, 它们记录了操作数宽度, 译码和执行的过程中会根据它们进行不同的操作, 通过同一份译码辅助函数和执行辅助函数实现不同操作数宽度的功能.

为了易于使用, 框架代码中使用了一些宏, 我们在这里把相关的宏整理出来, 供大家参考.

用RTL表示指令行为

我们知道, x86指令作为一种CISC指令集, 不少指令的行为都比较复杂. 但我们会发现, i386手册会用一些更简单的操作来表示指令的具体行为. 这说明, 复杂的x86指令还是能继续分解成一些更简单的操作的组合. mips32和riscv32的指令也能够进一步进行分解. 如果我们先实现这些简单操作, 然后再用它们来实现指令, 不就可以进一步提高代码的复用率了吗?

在NEMU中, 我们使用RTL(寄存器传输语言)来描述这些简单的操作. 下面我们对NEMU中使用的RTL进行一些说明, 首先是RTL寄存器的定义. 在NEMU中, RTL寄存器统一使用rtlreg_t来定义, 而rtlreg_t(在nemu/include/common.h中定义)其实只是一个uint32_t类型:

typedef uint32_t rtlreg_t;

在NEMU中, RTL寄存器只有以下这些

• 不同ISA的通用寄存器(在nemu/src/isa/$ISA/include/isa/reg.h中定义)
• id_src, id_src2和id_dest中的访存地址addr和操作数内容val(在nemu/include/cpu/decode.h中定义). 从概念上看, 它们分别与MAR和MDR有异曲同工之妙
• 临时寄存器s0, s1, t0, t1和ir(在nemu/src/cpu/cpu.c中定义)

有了RTL寄存器, 我们就可以定义RTL指令对它们进行的操作了. 在NEMU中, RTL指令有两种.

一种是RTL基本指令(在nemu/include/rtl/rtl.h中定义), 它们的特点是不需要使用临时寄存器, 可以看做是CPU执行过程中最基本的操作. 不同的ISA都可以使用RTL基本指令, 因此它们属于ISA无关的代码. RTL基本指令包括(我们使用了一些简单的正则表达式记号):

• 立即数读入rtl_li
• 寄存器传输rtl_mv
• 32位寄存器-寄存器类型的算术/逻辑运算, 包括rtl_(add|sub|and|or|xor|shl|shr|sar|i?mul_[lo|hi]|i?div_[q|r]), 这些运算的定义用到了nemu/include/rtl/c_op.h中的C语言运算
• 被除数为64位的除法运算rtl_i?div64_[q|r]
• guest内存访问rtl_lm和rtl_sm
• host内存访问rtl_host_lm和rtl_host_sm
• 关系运算rtl_setrelop, 具体可参考nemu/src/cpu/relop.c
• 跳转, 包括直接跳转rtl_j, 间接跳转rtl_jr和条件跳转rtl_jrelop
• 终止程序rtl_exit(在nemu/src/monitor/cpu-exec.c中定义)

上述RTL基本指令在nemu/include/rtl/rtl.h中定义时, 添加了interpret_前缀, 这是为了给PA5作准备. 在nemu/include/rtl/rtl-wrapper.h的作用下, 其它代码中使用到这些RTL基本指令时会自动添加interpret_前缀. 因此你在代码中使用它们的时候, 只需要编写rtl_xxx即可.

第二种RTL指令是RTL伪指令, 它们是通过RTL基本指令或者已经实现的RTL伪指令来实现的. RTL伪指令又分两类, 包括:

• ISA无关的RTL伪指令(在nemu/include/rtl/rtl.h中定义)
  • 32位寄存器-立即数类型的算术/逻辑运算, 包括rtl_(add|sub|and|or|xor|shl|shr|sar|i?mul_[lo|hi]|i?div_[q|r])_i
  • 其它常用功能, 如按位取反rtl_not, 符号扩展rtl_sext等
• ISA相关的RTL伪指令(在nemu/src/isa/$ISA/include/isa/rtl.h中定义)
  • 通用寄存器访问rtl_lr和rtl_sr
  • ISA相关性较强的功能(如x86的溢出和进/借位判断, EFLAGS标志位访问等)

其中大部分RTL伪指令还没有实现, 必要的时候你需要实现它们. 有了这些RTL指令之后, 我们就可以方便地通过若干条RTL指令来实现每一条指令的行为了.

(1) rtl_mv(&t0, &t1);
(2) rtl_sext(&t1, &s0, 1);  // use t0 temporarily
(3) rtl_add(&s0, &t0, &t1);

实现新指令

对译码, 执行和操作数宽度的解耦实现以及RTL的引入, 对在NEMU中实现客户指令提供了很大的便利, 为了实现一条新指令, 你只需要

1. 在opcode_table中填写正确的译码辅助函数, 执行辅助函数以及操作数宽度
2. 用RTL实现正确的执行辅助函数, 需要注意使用RTL伪指令时要遵守上文提到的小型调用约定

框架代码定义了一些译码辅助函数和执行辅助函数, 你可以很方便地使用它们.

如果你读过上文的扩展阅读材料中关于RISC与CISC融为一体的故事, 你也许会记得CISC风格的x86指令最终被分解成RISC风格的微指令在计算机中运行, 才让x86在这场扩日持久的性能大战中得以存活下来的故事. NEMU在经历了第二次重构之后, 也终于引入了RISC风格的RTL来实现指令, 这也许是冥冥之中的安排吧.

运行第一个C程序

说了这么多, 现在到了动手实践的时候了. 你在PA2的第一个任务, 就是实现若干条指令, 使得第一个简单的C程序可以在NEMU中运行起来. 这个简单的C程序是nexus-am/tests/cputest/tests/dummy.c, 它什么都不做就直接返回了.

--- /usr/riscv64-linux-gnu/include/bits/wordsize.h
+++ /usr/riscv64-linux-gnu/include/bits/wordsize.h
@@ -25,5 +25,5 @@
 #if __riscv_xlen == 64
 # define __WORDSIZE_TIME64_COMPAT32 1
 #else
-# error "rv32i-based targets are not supported"
+# define __WORDSIZE_TIME64_COMPAT32 0
 #endif

在nexus-am/tests/cputest/目录下键入

make ARCH=$ISA-nemu ALL=dummy run

编译dummy程序, 并启动NEMU运行它. 事实上, 并不是每一个程序都可以在NEMU中运行, nexus-am子项目专门用于编译出能在NEMU中运行的程序, 我们在下一小节中会再来介绍它.

在NEMU中运行dummy程序, 你会发现NEMU输出以下信息(以x86为例):

invalid opcode(pc = 0x0010000a): e8 05 00 00 00 90 31 c0 ...

There are two cases which will trigger this unexpected exception:
1. The instruction at pc = 0x0010000a is not implemented.
2. Something is implemented incorrectly.
Find this pc value(0x0010000a) in the disassembling result to distinguish which case it is.

If it is the first case, see
 _ ____   ___    __    __  __                         _ 
(_)___ \ / _ \  / /   |  \/  |                       | |
 _  __) | (_) |/ /_   | \  / | __ _ _ __  _   _  __ _| |
| ||__ < > _ <| '_ \  | |\/| |/ _  | '_ \| | | |/ _  | |
| |___) | (_) | (_) | | |  | | (_| | | | | |_| | (_| | |
|_|____/ \___/ \___/  |_|  |_|\__,_|_| |_|\__,_|\__,_|_|

for more details.

If it is the second case, remember:
* The machine is always right!
* Every line of untested code is always wrong!

这是因为你还没有实现以0xe8为首字节的指令, 因此, 你需要开始在NEMU中添加指令了.

要实现哪些指令才能让dummy在NEMU中运行起来呢? 答案就在其反汇编结果(nexus-am/tests/cputest/build/dummy-$ISA-nemu.txt)中. 以x86为例, 查看反汇编结果, 你发现只需要添加call, push, sub, xor, ret五条指令就可以了. 每一条指令还有不同的形式, 根据KISS法则, 你可以先实现只在dummy中出现的指令形式, 通过指令的opcode可以确定具体的形式.

这里要再次强调, 你务必通过RTFM来查阅指令的功能, 不能想当然. 手册中给出了指令功能的完整描述(包括做什么事, 怎么做的, 有什么影响), 一定要仔细阅读其中的每一个单词, 对指令功能理解错误和遗漏都会给以后的调试带来巨大的麻烦.