Skip to contentSkip to conversation

docs: add precision about capstone for execlog plugin

PATCH In review Alexandre Iooss 2 participants 2 messages Jun 20, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs: add precision about capstone for execlog plugin

Some people are wondering why they get an empty string as disassembly. Most of the time, they configured QEMU without Capstone support. Let's document this behaviour to help users.

---
 docs/devel/tcg-plugins.rst | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
docs/devel/tcg-plugins.rst +3 -1
index 9cc09d8c3d..f7d7b9e3a4 100644
@@ -539,7 +539,9 @@ which will output an execution trace following this structure::
   0, 0xd34, 0xf9c8f000, "bl #0x10c8"
   0, 0x10c8, 0xfff96c43, "ldr r3, [r0, #0x44]", load, 0x200000e4, RAM
 
-the output can be filtered to only track certain instructions or
+Please note that you need to configure QEMU with Capstone support to get disassembly.
+
+The output can be filtered to only track certain instructions or
 addresses using the ``ifilter`` or ``afilter`` options. You can stack the
 arguments if required::
 
Signature · 1 line
2.30.2
Reviewed-by on v1 1/1
#1 lore raw
Quoted 14 lines · Alexandre Iooss

Some people are wondering why they get an empty string as disassembly. Most of the time, they configured QEMU without Capstone support. Let's document this behaviour to help users.

---
  docs/devel/tcg-plugins.rst | 4 +++-
  1 file changed, 3 insertions(+), 1 deletion(-)
docs/devel/tcg-plugins.rst +0 -0
index 9cc09d8c3d..f7d7b9e3a4 100644

docs/devel/tcg-plugins.rst which will output an execution trace following this structure:: · line 547

Quoted 10 lines
docs/devel/tcg-plugins.rst +3 -1
@@ -539,7 +539,9 @@ which will output an execution trace following this structure::
    0, 0xd34, 0xf9c8f000, "bl #0x10c8"
    0, 0x10c8, 0xfff96c43, "ldr r3, [r0, #0x44]", load, 0x200000e4, RAM
 
-the output can be filtered to only track certain instructions or
+Please note that you need to configure QEMU with Capstone support to get disassembly.
+
+The output can be filtered to only track certain instructions or
  addresses using the ``ifilter`` or ``afilter`` options. You can stack the
  arguments if required::