Qiling

Qiling Framework 文档索引

来源:qilingframework/rtfd.io + qilingframework/qiling 抓取日期:2026-04-22 文件数:20

Table of Contents

FileSummary
content/howto.mdQiling Framework initialization, emulation configuration, and run controls — binary emulation, shellcode emulation, fs mapping, patching, and ql.run() parameters.
content/hook.mdQiling Framework hook API — address hooks, code/block/instruction hooks, memory read/write/fetch hooks, interrupt hooks, and hook management.
content/memory.mdQiling Framework memory subsystem API — map/unmap, read/write bytes and integers, search, alignment utilities, and architectural stack operations.
content/register.mdQiling Framework register API — read/write architectural registers by name or Unicorn constant, generic PC/SP aliases, Intel MSR, and ARM coprocessors.
content/hijack.mdQiling Framework hijacking API — stdin/stdout/stderr redirection, VFS object mapping, POSIX syscall interception, OS API hooking for POSIX/Windows/UEFI.
content/ida.mdQiling IDA Pro plugin — installation, emulation setup, debugging controls, custom user scripts, snapshot save/restore, and OLLVM de-obfuscation.
content/debugger.mdQiling Framework remote debugging — GDB server setup, IDA Pro connection, GDB commands, and Qdb built-in debugger with record-and-replay.
content/snapshot.mdQiling Framework snapshot and partial execution API — save/restore full state, CPU context, memory, registers, file descriptors, and skip-ahead emulation patterns.
content/qltool.mdqltool CLI reference — run/code/qltui commands with all options for binary emulation, shellcode execution, debugging, coverage, and output control.
content/install.mdQiling Framework installation — pip, GitHub dev branch, Docker, Windows DLL setup, and macOS Keystone workaround.
content/coverage.mdQiling Framework code coverage plugin — drcov format output via qltool CLI or Python script, and guide for adding new coverage format backends.
content/print.mdQiling Framework logging API — verbosity levels, ql.log usage, and log filtering with regex.
content/profile.mdQiling Framework profile files — INI-format configuration for OS-specific settings like mmap_address, log_dir, and log_split; default profiles per OS.
content/struct.mdQiling Framework pack/unpack API and struct memory layout guide — ql.pack/unpack for 16/32/64-bit values, signed variants, and Python struct module usage for C structs.
content/evm.mdQiling Framework EVM engine — install, execute and debug Ethereum smart contract bytecode, create accounts, send transactions, and set EVM hard forks.
content/faq.mdQiling Framework FAQ — rootfs errors, missing syscalls/APIs, UC_ERR_FETCH_UNMAPPED causes, GDB timeout fix, multithread requirement, Windows A/W API compatibility.
content/syscall_api.mdGuide for adding POSIX syscalls and OS API implementations to Qiling — file organization by header, testing approach, and arch mapping.
content/extension.mdGuide for extending Qiling Framework with new loaders, architectures, and operating systems — required components and relevant source files for each extension type.
content/qdb.mdQdb built-in debugger for Qiling — command-line interface, step/continue/breakpoint/examine commands, and record-and-replay usage.
content/references.mdUtility scripts for generating Qiling syscall mappings from FreeBSD and macOS syscall master files.