logo3

bochscpu-python

Python 绑定，用于 @yrp 的 BochsCPU，通过 FFI 轻松且精确地模拟 x86 代码。

安装

bochscpu-python 仅需要 Python 3.8 或更高版本的环境。

通过 PyPI 安装（推荐）

到目前为止，最简单的上手方式是使用 PyPI 上的稳定打包版本。

python -m pip install bochscpu-python

通过生成的构建产物

从仓库的 GitHub Actions 标签页下载最新的可用构建产物。解压 ZIP 文件，安装 wheel 文件夹中的 .whl 文件。

python -m pip install wheel/bochscpu-$version-$os-$arch.whl

从源代码仓库

相当直接：

python -m pip install .

或者不克隆：

python -m pip install git+https://github.com/hugsy/bochscpu-python.git#egg=bochscpu-python

请注意，这种方式要求你安装所有必要的构建工具（如下所述）。

构建

要求

Python 3.8+（含开发工具包）
cmake
pip
支持 C++20 的编译器（已在 Windows 的 cl、macOS 的 clang++ 和 Linux 的 g++ 上测试）

步骤

按照各自页面上的说明构建 BochsCPU、BochsCPU-FFI 和 BochsCPU-Build
... 或者，Windows 和 Linux 的 BochsCPU-FFI 库目标文件可以从 build GitHub Actions 下载
将 *.lib 移动到 bochscpu/lib/<BuildType>（其中 BuildType 可以是 Debug、Release、RelWithDebInfo 等）
安装依赖：python -m pip install -r requirements.txt
使用 cmake 构建这将生成 bochscpu 的 pyd 文件（及其 PDB），你可以在 Python 会话中通过 import bochscpu 导入。
... 或者，你也可以在项目根目录生成 .whl 文件：

python -m pip wheel .

用法

只需导入 bochscpu 模块即可开始！安装该包时还会安装接口文件，使现代 IDE（VSCode、PyCharm 等）能够提供有用的自动补全。

一个非常简单的模板可以这样构建：

import bochscpu, bochscpu.utils, bochscpu.cpu

sess = bochscpu.Session()
sess.missing_page_handler = bochscpu.utils.callbacks.missing_page_cb
state = bochscpu.State()
bochscpu.cpu.set_real_mode(state)
hook = bochscpu.Hook()
bochscpu.utils.callbacks.install_default_callbacks(hook)
sess.run([hook,])

这将创建一个 bochscpu 会话，将 CPU 状态设置为实模式，并预先用基本回调填充钩子（这些回调仅在执行时执行 print）。请注意，这个示例实际上什么也不会做，因为我们尚未分配代码页，也没有正确设置寄存器来指向它。

更完整的模板可以在examples/ 文件夹中找到。