docs(qemu):EmulatorHooks as the safe alternative for QEMUhooks #3651
+12
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rmalmain
reviewed
Jan 6, 2026
crates/libafl_qemu/src/emu/hooks.rs
Outdated
|
|
||
| /// Hook collection, | ||
| /// | ||
| /// `EmulatorHooks` is the supported interface for registering QEMU-based |
Member
There was a problem hiding this comment.
'supported' is not the right word, we support low level hooks as well.
it's more like the standard way to use hooks from a high level perspective.
Contributor
Author
There was a problem hiding this comment.
Good point, I’ve updated the wording to describe EmulatorHooks as the 'standard' interface to use hooks from a high level perspective.
Thanks!
Contributor
Author
There was a problem hiding this comment.
Are there any changes to improve ?
domenukk
reviewed
Jan 9, 2026
crates/libafl_qemu/src/qemu/hooks.rs
Outdated
| /// The thin wrapper around QEMU hooks. | ||
| /// It is considered unsafe to use it directly. | ||
| /// | ||
| /// It is recommended to use `EmulatorHooks`, which provides a safe, structured |
Contributor
Author
There was a problem hiding this comment.
Fixed — switched to rustdoc links ([EmulatorHooks], [QemuHooks]), visible in generated docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR clarifies the supported way to register QEMU-based hooks in LibAFL.
These docs now explicitly points users from the low-level
QemuHooksto
EmulatorHooksas the recommended and safe abstraction, and clarifiesthe role of emulator modules in hook registration.
Fixes #3228
Checklist
./scripts/precommit.shand addressed all comments