xref: /aosp_15_r20/external/capstone/suite/README (revision 9a0e4156d50a75a99ec4f1653a0e9602a5d45c18)
1*9a0e4156SSadaf EbrahimiThis directory contains some tools used by developers of Capstone project.
2*9a0e4156SSadaf EbrahimiAverage users should ignore all the contents here.
3*9a0e4156SSadaf Ebrahimi
4*9a0e4156SSadaf Ebrahimi
5*9a0e4156SSadaf Ebrahimi- arm/
6*9a0e4156SSadaf Ebrahimi	Test some ARM's special input.
7*9a0e4156SSadaf Ebrahimi
8*9a0e4156SSadaf Ebrahimi- MC/
9*9a0e4156SSadaf Ebrahimi	Input used to test various architectures & modes.
10*9a0e4156SSadaf Ebrahimi
11*9a0e4156SSadaf Ebrahimi- benchmark.py
12*9a0e4156SSadaf Ebrahimi	This script benchmarks Python binding by disassembling some random code.
13*9a0e4156SSadaf Ebrahimi
14*9a0e4156SSadaf Ebrahimi- test_*.sh
15*9a0e4156SSadaf Ebrahimi	Run all the tests and send the output to external file to be compared later.
16*9a0e4156SSadaf Ebrahimi	This is useful when we want to verify if a commit (wrongly) changes
17*9a0e4156SSadaf Ebrahimi	the disassemble result.
18*9a0e4156SSadaf Ebrahimi
19*9a0e4156SSadaf Ebrahimi- compile_all.sh
20*9a0e4156SSadaf Ebrahimi	Compile Capstone for all platforms (*nix32, clang, cygwin, cross-compile) &
21*9a0e4156SSadaf Ebrahimi	report the result as pass or fail.
22*9a0e4156SSadaf Ebrahimi
23*9a0e4156SSadaf Ebrahimi- fuzz.py
24*9a0e4156SSadaf Ebrahimi	This simple script disassembles random code for all archs (or selected arch)
25*9a0e4156SSadaf Ebrahimi	in order to find segfaults.
26*9a0e4156SSadaf Ebrahimi
27*9a0e4156SSadaf Ebrahimi- test_mc.sh
28*9a0e4156SSadaf Ebrahimi    This script compares the output of Capstone with LLVM's llvm-mc with the
29*9a0e4156SSadaf Ebrahimi	input coming from MC/. This relies on test_mc.py to do all the hard works.
30*9a0e4156SSadaf Ebrahimi
31*9a0e4156SSadaf Ebrahimi- x86odd.py
32*9a0e4156SSadaf Ebrahimi	Test some tricky X86 instructions.
33*9a0e4156SSadaf Ebrahimi
34*9a0e4156SSadaf Ebrahimi- ppcbranch.py
35*9a0e4156SSadaf Ebrahimi	Test some tricky branch PPC instructions.
36