C 语言宏 + 内联汇编实现 MIPS 系统调用

笔者最近作业要求练习 MIPS 汇编，熟悉 MIPS 汇编代码与 C 语言代码的对应关系。然而 SPIM/MARS 仿真器不能链接共享库以调用外部函数（如 stdio.h 下的函数），只能通过系统调用实现。C 语言可以通过内联汇编（Inline Assembly）实现系统调用而不借助任何外部函数，再将内联汇编语句封装成函数或宏函数，便于 C 程序调用。

内联汇编

内联汇编主要借助关键字 asm 或 __asm__ (C99) 实现。内敛汇编语句基本格式：

__asm__ [volatile](汇编语句[:[输出结果]:[输入参数][:异常检测条件]]);

volatile 关键字用于防止编译器优化更改此处汇编代码；汇编语句填入汇编代码字符串；后面三类参数均可省，其中输出结果填入一个存结果的变量，输入参数填需要载入的变量或者供替换代码中占位符的有关值；异常检测可填入需要保持的寄存器，当寄存器被占用时，编译器会报错。

另外一个用法是用在 register 型变量之后，可以指定该变量对应哪个寄存器，如：

register int sys_id __asm__("$2") = 4;

这样对变量 sys_id 的取值/赋值等操作就等于对寄存器 $2 的读写操作。

以下是一些例子：

int a, b;
// a = a + b - 1;
// %0, %1, ... 就是占位符
__asm__ volatile(
    "add %1,%1,%2\n\t"
    "addi %0,%1,-1"
    :"=r"(a)
    :"r"(a),"r"(b));
// a = b < 0;
__asm__ volatile(
    "slt %0, %1, $0"
    :"=r"(a)
    :"r"(b));
// printf("Hello");
register char *msg asm("$4") = "Hello";
__asm__ volatile(
    "jal printf"
    ::"r"(msg));
// 此处一定要有 "r"(msg)，否则编译器可能会认为变量 mmm 未被使用而忽略对该变量的赋值操作

宏函数

宏的本质就是代码段替换，只需要给一个代码段声明一个名称就可以在代码中反复使用这一代码段。代码段可以是最基础的字面常量等，也可以是稍复杂的多条语句（如宏函数）。当然，宏也可以简化一些语句，甚至可以用宏实现 try-catch 语句^[1]。

常见宏函数的声明形式如下：

// 无“返回值”型
#define 函数名([参数列表])\
{\
   代码段;\
}

// 有“返回值”型。这里用到了括号的一个语法
#define 函数名([参数列表])\
({\
    代码段;\
    返回值（右值表达式）;\
})

另外，参数列表是可选项，没有类型限制，甚至也可以是代码段。

宏定义 Syscall 内联汇编

SPIM 仿真器的 MIPS 系统调用参数：

用上述两种宏函数定义方式定义其中几个常用的系统调用，如下：

#define sys_open(pth, fg) ({\
    register int _ID_ __asm__("$2") = 13, _FG_ __asm__("$5") = fg;\
    register char *_PTH_ __asm__("$4") = pth;\
    __asm__ volatile("syscall"\
    :"=r"(_ID_):"r"(_ID_),"r"(_PTH_),"r"(_FG_));\
    _ID_;})

#define sys_print_string(str) {\
    register int _ID_ __asm__("$2") = 4;\
    register char *_STR_ __asm__("$4") = str;\
    __asm__ volatile("syscall"\
    ::"r"(_ID_),"r"(_STR_));}

#define sys_print_int(i) {\
    register int _ID_ __asm__("$2") = 1, _I_ __asm__("$4") = i;\
    __asm__ volatile("syscall"::"r"(_ID_),"r"(_I_));}

#define sys_read_int() ({\
    register int _ID_ __asm__("$2") = 5;\
    __asm__ volatile("syscall"\
    :"=r"(_ID_):"r"(_ID_));\
    _ID_;})

#define sys_read(fd, buf, len) ({\
    register int _ID_ __asm__("$2") = 14, _FD_ __asm__("$4") = fd, _LEN_ __asm__("$6") = len;\
    register char *_BUF_ __asm__("$5") = buf;\
    __asm__ volatile("syscall"\
    :"=r"(_ID_):"r"(_ID_),"r"(_FD_),"r"(_BUF_),"r"(_LEN_));\
    _ID_;})

#define sys_close(fd) {\
    register int _ID_ __asm__("$2") = 16, _FD_ __asm__("$4") = fd;\
    __asm__ volatile("syscall"::"r"(_ID_),"r"(_FD_));}

#define sys_exit() {\
    register int _ID_ __asm__("$2") = 10;\
    __asm__ volatile("syscall"::"r"(_ID_));}

编译测试

老师推荐用在线平台 https://godbolt.org 编译测试，其实本地用 mips-linux-gnu-gcc 交叉编译也行。将以上宏定义存为头文件 mips-syscall.h，然后在代码中引用，进行简单的测试：

#include "mips-syscall.h"

void main() {
  sys_print_string("Input a number: ");
  int n = sys_read_int();
  sys_print_string("The number is ");
  sys_print_int(n);
  sys_exit();
}

由于 SPIM/MARS 仿真器的执行入口和一般程序不太一样，而且需要调用 exit 来结束程序，所以以上代码的驻韩数写法比较怪。

本地交叉编译，编译器 mips-linux-gnu-gcc 12.3.0，编译参数 -O2 -S -o m.s，去掉不相关字段：

	.data
$LC0:
	.ascii	"Input a number: \000"
$LC1:
	.ascii	"The number is \000"
	.text
main:
	lw	$4,%got($LC0)($28)
	li	$2,4			# 0x4
	addiu	$4,$4,%lo($LC0)
	syscall
	li	$2,5			# 0x5
	syscall
	lw	$4,%got($LC1)($28)
	move    $3,$2
	li	$2,4			# 0x4
	addiu	$4,$4,%lo($LC1)
	syscall
	li	$2,1			# 0x1
	move	$4,$3
	syscall
	li	$2,10			# 0xa
	syscall
	jr	$31

可以看到已经成功编译，同时宏函数也都被替换为相应的系统调用。再经过一些调整后得到 MARS 可用的代码，运行测试，结果如下：

Input a number: 9
The number is 9
-- program is finished running --

1. https://zhuanlan.zhihu.com/p/245642367 ↩︎