移植仙剑奇侠传

原版的仙剑奇侠传是针对Windows平台开发的, 因此它并不能在GNU/Linux中运行(你知道为什么吗?), 也不能在NEMU中运行. 网友weimingzhi开发了一款基于SDL库, 跨平台的仙剑奇侠传, 工程叫SDLPAL. 你可以通过 git clone 命令把SDLPAL克隆到本地, 然后把仙剑奇侠传的数据文件(我们已经把数据文件上传到提交网站上)放在工程目录下, 执行 make 编译SDLPAL, 编译成功后就可以玩了. 更多的信息请参考SDLPAL工程中的README说明.

把仙剑奇侠传移植到NEMU中的主要工作, 就是把应用层之下提供给仙剑奇侠传的所有API重新实现一遍, 因为这些API大多都依赖于操作系统提供的运行时环境, 我们需要根据NEMU和kernel提供的运行时环境重写它们. 主要包括以下四部分内容:

• C标准库
• 浮点数
• SDL库
• 文件系统

newlib已经提供了C标准库的功能, 我们之前实现的 FLOAT 类型也已经解决了浮点数的问题, 因此我们可以很简单地对这两部分内容进行移植, 重点则落到了SDL库和文件系统的移植工作中.

关于浮点数有一点小小的补充. 在 game/src/nemu-pal/battle/fight.c 的代码中有一处调用了 pow() 函数, 用于根据角色的敏捷度(身法)计算在半即时战斗模式中角色的行动条变化量. 在SDLPAL中, 此处调用的 pow() 函数计算的是 x^0.3 , 但 FLOAT 版本的通用 pow() 函数实现相对麻烦, 根据KISS法则, 我们把此处调用修改成 x^(1/3) , lib-common/FLOAT.c 中实现的 pow() 函数用来专门计算 x^(1/3) , 采用的是nth root algorithm.

我们把待移植的仙剑奇侠传称为NEMU-PAL. NEMU-PAL在SDLPAL的基础上经过少量修改得到, 包括去掉了声音, 修改了 game/src/nemu-pal/device/input.c 中和按键相关的处理, 把我们关心的和SDL库的实现整理到 game/src/nemu-pal/hal 目录下, 一些我们不必关心的实现则整理到 game/src/nemu-pal/unused 目录下, 同时还对浮点数用binary scaling进行了处理.

为了编译NEMU-PAL, 你需要修改 game/Makefile.part 中的 GAME 变量, 从打字小游戏切换到NEMU-PAL. 然后把仙剑奇侠传的数据文件放在 game/src/nemu-pal/data 目录下, 工程目录下执行 make game 即可.

下面来谈谈移植工作具体要做些什么. 在这之前, 请确保你已经理解打字小游戏的工作方式.

重写SDL库的API

在SDLPAL中, SDL库负责时钟, 按键, 显示和声音相关的处理. 由于在NEMU中没有模拟声卡的实现, NEMU-PAL已经去掉了和声音相关的部分. 其余三部分的内容被整理到 game/src/nemu-pal/hal 目录下, 其中HAL(Hardware Abstraction Layer)是硬件抽象层的意思, 和硬件相关的功能将在HAL中被打包, 提供给上层使用.

时钟相关

• SDL_GetTicks() 用于返回用毫秒表示的当前时间(从运行游戏时开始计算).
• SDL_Delay() 用于延迟若干毫秒.
• jiffy 变量记录了时钟中断到来的次数, 通过它可以实现上述和时钟相关的控制功能.

键盘相关

键盘通常都支持"重复按键", 即若一直按着某一个键不松开, 键盘控制器将会不断发送该键的扫描码. 但是SDLPAL(包括待移植的NEMU-PAL)的游戏逻辑是在基于"非重复按键"的特性编写的, 即若一直按着某一个键不松开, SDLPAL只会收到一次该键的扫描码. 因此HAL需要把键盘的"重复按键"特性屏蔽起来, 向上层提供"非重复按键"的特性.

• 实现这一抽象的方法是记录按键的状态. 你需要在键盘中断处理函数 keyboard_event() 中编写相应代码, 根据从键盘控制器得到的扫描码记录按键的状态.
• process_keys() 函数会被NEMU-PAL轮询调用. 每次调用时, 寻找一个刚刚按下或刚刚释放的按键, 并调用相应的回调函数, 然后改变该按键的状态. 若找到这样的按键, 函数马上返回 true ; 若找不到, 函数返回 false . 注意返回之前需要打开中断.
• 代码中提供了数组的实现方式用于记录按键的状态, 你也可以使用其它方式来实现上述抽象.

显示相关

SDL中包含很多和显示相关的API, 为了重写它们, 你首先需要了解它们的功能. 通过 man 命令查阅以下内容:

• SDL_Surface
• SDL_Rect
• SDL_BlitSurface
• SDL_FillRect
• SDL_UpdateRect

在 game/src/nemu-pal/include/hal.h 中已经定义了相关的结构体, 你需要阅读 man , 了解相关成员的功能, 然后实现 game/src/nemu-pal/hal/video.c 中相应函数的功能. 你可以忽略 man 中提到的"锁"等特性, 我们并不打算在NEMU-PAL中实现这些特性.

实现简易文件系统

对于大部分游戏来说, 游戏用到的数据所占的空间比游戏逻辑本身还大, 因此这些数据一般都存储在磁盘中. IDE驱动程序已经为我们屏蔽了磁盘的物理特性, 并提供了读写接口, 使得我们可以很方便地访问磁盘某一个位置的数据. 但为了易于上层使用, 我们还需要提供一种更高级的抽象, 那就是文件.

文件的本质就是字节序列, 另外还由一些额外的属性构成. 在这里, 我们只讨论磁盘上的文件. 这样, 那些额外的属性就维护了文件到磁盘存储位置的映射. 为了管理这些映射, 同时向上层提供文件操作的接口, 我们需要在kernel中实现一个文件系统.

不要被"文件系统"四个字吓到了, 我们需要实现的文件系统并不是那么复杂, 这得益于NEMU-PAL的一些特性: 对于大部分数据文件来说, NEMU-PAL只会读取它们, 而不会对它们进行修改; 唯一有可能进行文件写操作的, 就只有保存游戏进度, 但游戏存档的大小是固定的. 因此我们得出了一个重要的结论: 我们需要实现的文件系统中, 所有文件的大小都是固定的. 既然文件大小是固定的, 我们自然也可以把每一个文件分别固定在磁盘中的某一个位置. 这些很好的特性大大降低了文件系统的实现难度, 当然, 真实的文件系统远远比这个简易文件系统复杂.

我们约定磁盘的最开始用于存放NEMU-PAL游戏程序, 从1MB处开始一个挨着一个地存放数据文件:

0                      1MB
+------------+----------+----------+---------+----------+------------+----
|            |          |          |         |          |            |
|  NEMU-PAL  |          |  1.rpg   |  2.rpg  |  ......  |  word.dat  |
|            |          |          |         |          |            |
+------------+----------+----------+---------+----------+------------+----

kernel/src/fs/fs.c 中已经列出了所有数据文件的信息, 包括文件名, 文件大小和文件在磁盘上的位置. 但若只有这些信息, 文件系统还是不能表示文件在读写时的动态信息, 例如读写位置的指针等. 为此, 文件系统需要为那些打开了的文件维护一些动态的信息:

在这里, 我们只需要维护打开状态 opened 和读写指针 offset 即可. 由于这个简易文件系统中的文件数目是固定的, 我们可以为每一个文件静态分配一个 Fstate 结构, 因此我们只需要定义一个长度为 NR_FILES + 3 的 Fstate 结构数组即可. 这里的 3 包括 stdin , stdout , stderr 三个特殊的文件, 磁盘中的第 k 个文件固定使用第 k + 3 个 Fstate 结构. 这样, 我们就可以把 Fstate 结构在数组中的下标作为相应文件的文件描述符(fd, file descriptor)返回给用户层了.

有了 Fstate 结构之后, 我们就可以实现以下的文件操作了:

这些文件操作实际上是相应的系统调用在内核中的实现, 你可以通过 man 查阅它们的功能, 例如

man 2 open

其中 2 表示查阅和系统调用相关的man page. 实现这些文件操作的时候注意以下几点:

• 由于简易文件系统中每一个文件都是固定的, 不会产生新文件, 因此" fs_open() 没有找到 pathname 所指示的文件"属于异常情况, 你需要使用assertion终止程序运行.
• 使用 ide_read() 和 ide_write() 来进行文件的读写.
• 由于文件的大小是固定的, 在实现 fs_read() 和 fs_lseek() 的时候, 注意读写指针不要越过文件的边界.
• 除了写入 stdout 和 stderr 之外(即输出到串口), 其余对于 stdin , stdout 和 stderr 这三个特殊文件的操作可以直接忽略.

最后你还需要在kernel中编写相应的系统调用, 来调用相应的文件操作, 同时修改 game/src/common/lib/syscall.c 中的代码, 为用户进程开放系统调用接口.

  31                23                15                7               0
 +-+---------------------------------+---------------------------------+-+
 |E|                                 |                                 | |
 |O|            Reserved             |        Byte Count [15:1]        |0| 4
 |T|                                 |                                 | |
 +-+---------------------------------+---------------------------------+-+
 |                                                                     | |
 |             Memory Region Physical Base Address [31:1]              |0| 0
 |                                                                     | |
 +---------------------------------------------------------------------+-+

fprintf(fp, "Hello World!\n");