Bin Patch Kit

为什么会有这个项目？

第一次汉化 GBA 游戏，需要注入自己的代码，不想苦哈哈的写汇编，所以写了这个东西。目前仅支持 ARM32，THUMB-2，THUMB-1 指令集的注入，理论上 NDS，3DS，PSV 等使用 ARM 指令集的 rom 也能用。注意：修复指令的功能并没有充分测试，使用时风险自负。

原理

target               empty space
+-----------+        +------------------------------------------+
| jmp empty | ---->  | push all regs        |        function   |
| ...       | <---+  | call hook function   | -----> +--------+ |
|           |     |  | pop all regs         | <---+  | ...    | |
|           |     |  | run old instructions |     |  |        | |
|           |     +- | jmp back             |     +- +--------+ |
+-----------+        +------------------------------------------+

由于所有寄存器入栈并作为参数传给了 function，所以在 function 内除了修改内存外，还可以任意读取和修改当前状态的寄存器。这个 function 可以用 C 写，注入 rom 的工作用 python 完成。

怎么用？

1. 写一个 C 程序

// main.c
#include "registers.h"

// ...

__attribute__((target("arm"))) void hooker_0000xxxx(struct Registers *regs)
{
    *(char *)regs->r0 = 'X';
    regs->r1++;
    return;
}

__attribute__((target("thumb"))) void hooker_0000yyyy(struct Registers *regs)
{
    if (*(uint32_t *)regs->sp == 0x08001234)
    {
        regs->r3 = regs->r4;
    }
    return;
}

注意点:

程序用 devkitPro 编译。
Makefile 可以从对应平台的 examples 里面 copy 一个过来, 要在 CFLAGS 里加上 -fno-builtin
如果是 hook 在 arm 指令上，函数前加 __attribute__((target("arm")))
如果是 hook 在 thumb 指令上，函数前加 __attribute__((target("thumb")))
函数内要调用的其他函数，必须是 inline 的，所以不能使用一些最基本的 libc 函数，如 memcpy, memset 等，要用的话需要自己来实现一个。

如需使用变量保存状态等信息或需使用字符串，建议把所有要使用的变量和字符串定义在一个 struct 内，然后找一处空内存，在函数内把该 struct 指向空内存。例如：

struct VARS
{
    char font_name[0x10];  // 字符串的内容，需另外用 python 写入 rom
    uint32_t tile_count;
    uint32_t status;
    uint32_t file;
};

#define VARS_OFFSET 0x1234568

// ...
struct VARS *var = (struct VARS *)VARS_OFFSET;
// ...

可以在程序中加入
```
#define ENABLE_LOGGING
#include "log.h"
...
LOG("some message")
...
```
使用LOG()来记录日志（仅在No$GBA模拟器中有效，菜单 Windows => TTY Debug Messages 查看日志）

2. 写一个 python 程序

from bin_patch_kit import *

ELF_PATH = 'build/main.o'
ROM_PATH = '../rom/XXX.gba'
EMPTY_OFFSET = 0x003919a0

JOBS = [
    {'arch': 'arm', 'type': 'hook', 'address': 0x5b7c, 'func': 'hooker_0000xxxx'},
    {'arch': 'thumb', 'type': 'hook', 'address': 0x2190, 'func': 'hooker_0000yyyy'},
    {'arch': 'thumb', 'type': 'patch', 'address': 0x186c, 'asm': 'mov r8, r8; mov r8, r8;'},
]

patch_rom(rom_path=ROM_PATH,
          rom_base=GBA_BASE,
          code_path=ELF_PATH,
          empty_address=EMPTY_OFFSET,
          jobs=JOBS)

注意点

注入的地址要用反编译工具确认地址下面的几个指令没有从其他地方跳转的情况出现
python 依赖库：

keystone-engine

capstone

pyelftools

noword / bin_patch_kit