logo3

bochscpu-python

Binding Python per BochsCPU di @yrp che utilizzano FFI per emulare facilmente e con precisione il codice x86.

Installazione

bochscpu-python richiede un ambiente Python 3.8 o più recente.

Tramite PyPI (consigliato)

Il modo più semplice per iniziare è usare la versione stabile impacchettata disponibile su PyPI

python -m pip install bochscpu-python

Tramite le build generate

Scarica l'ultimo artefatto funzionante dalla scheda Github Actions del repository. Estrai il file ZIP e installa il file .whl che troverai nella cartella wheel.

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

Dal repository sorgente

Abbastanza semplice:

python -m pip install .

Oppure senza clonare

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

Nota che questo approccio richiede di avere installati tutti gli strumenti di build necessari (come descritto sotto).

Compilazione

Requisiti

Python 3.8+ (con kit di sviluppo)
cmake
pip
un compilatore compatibile con C++20 (testati cl per Windows, clang++ per macOS e g++ per Linux)

Passaggi

Compila BochsCPU, BochsCPU-FFI e BochsCPU-Build seguendo le istruzioni nelle rispettive pagine
... In alternativa, i file oggetto delle librerie BochsCPU-FFI per Windows e Linux possono essere scaricati dalle Github Actions build
Sposta i *.lib in bochscpu/lib/<BuildType> (dove BuildType può essere Debug, Release, RelWithDebInfo, ecc.)
Installa i requisiti: python -m pip install -r requirements.txt
Compila con cmake Questo genererà il file pyd di bochscpu (e il suo PDB) che potrai importare da una sessione Python con import bochscpu.
... In alternativa puoi anche generare un .whl dalla radice del progetto:

python -m pip wheel .

Utilizzo

Basta importare il modulo bochscpu e il divertimento ha inizio! L'installazione del pacchetto installerà anche i file di interfaccia, consentendo agli IDE moderni (VSCode, PyCharm, ecc.) di offrire utili completamenti.

Un template molto grezzo può essere creato così:

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,])

Questo creerà una sessione bochscpu, imposterà lo stato della CPU per la modalità reale e pre-popolerà gli hook con callback di base (che eseguono solo una print al momento dell'esecuzione). Nota che questo esempio in realtà non fa nulla, poiché non abbiamo allocato pagine di codice né impostato correttamente i registri per puntare a esse.

Un template più completo è disponibile nella cartella examples/