cogbt / COGBT

Compile Optimization Guided Binary Translator (using llvm as infrastructure)

COGBT

本项目基于QEMU 7.0.93 和 LLVM8.0 开发，是一个支持x86 to LoongArch的动静结合的二进制翻译器。

QEMU基于 git (commit a8cc5842b5cb863e46a2d009151c6ccbdecadaba)开发。

LLVM目前测试通过 LLVM release/8.x-loongarch 和 LLVM release/15.x-loongarch。

对于向量实现，需要LLVM release/15.x-loongarch。

Quick Start

Prerequisites

本仓库在编译前需要以下支持：

• capstone version v5.0.0
• 环境变量$LLVM_HOME，或者可以通过./configure --llvm-home=<path>进行设置。(后者的优先级高于前者)
  • $LLVM_HOME/include/: 该目录下需要包含对应版本的LLVM头文件。
    • CogbtPass.h: 可选文件，声明了目前所有实现的自定义优化pass。
  • $LLVM_HOME/lib/
    • libLLVM.so: 必须包含，其应该是libLLVM-x.so的一个软连接。

    建立软链接指令：ln -sf libLLVM-x.so libLLVM.so

    • libLLVMCustomReduction.so: 可选文件，实现了目前所有的自定义优化pass。

CogbtPass.h 和 libLLVMCustomReduction.so 文件可通过cogbt/accel/cogbt/optimization_passes目录生成。 当使用--disable-custom-pass-optimization选项，关掉自定义优化pass时，以上可选文件是不需要的。

Compiler

本仓库在build-shell文件夹中默认自带了三个编译脚本。

• build64.sh: 生成cogbt可执行文件。
• build64-dbg.sh: 生成cogbt可执行文件，相比于第一个其中包含了调试信息。
• build64-qemu.sh: 生成qemu的可执行文件，主要逻辑是qemu的逻辑，但是会多生成一个path文件供tb_aot模式使用。

第一次编译时可以使用类型命令进行编译./build64-dbg.sh -c。编译后会根据编译脚本的不同在项目根目录下生成对应的文件夹，如build64-dbg/。

Running

本项目稳定支持两种执行模式: JIT 和 AOT。JIT模式(类似动态翻译器)，可直接运行。AOT模式(动静结合的混合翻译器)下需要先执行生成.aot文件(静态部分)，然后再加载对应的.aot文件进行运行(动态部分)。

JIT

JIT 模式执行，可直接使用编译生成的可执行文件执行原本的命令。类似./build64-dbg/qemu-x86_64 coremark.exe 1 1 1 1。

AOT

AOT模式下首先生成.aot文件，该文件的生成通常只需要原本的可执行文件(guest)，而不需要参数，因为对于guest程序这里采用的是elf静态挖掘技术。

生成.aot文件: ./qemu-x86_64 -m <mode> <guest_elf> 加载.aot执行: ./qemu-x86_64 -a <aot_file> <guest_elf> <guest_parameter>

AOT模式下又可分为多种细化模式。

• tb aot mode: 翻译单元为一个tb。该模式需要提前准备一个path文件，可以由原生qemu执行一次得到(参考build64-qemu.sh)。

生成aot文件：./build64-dbg/qemu-x86_64 -m tb_aot coremark.exe
执行：./build64-dbg/qemu-x86_64 -a coremark.exe.aot coremark.exe 1 1 1 1

• tu aot mode: 翻译单元为多个tb，多个tb形成一个tu采用了一个简单的算法。

生成aot文件：./build64-dbg/qemu-x86_64 -m tu_aot coremark.exe
执行：./build64-dbg/qemu-x86_64 -a coremark.exe.aot coremark.exe 1 1 1 1