Files

Simone 3621a6c080 Squashed 'external/capstone/' changes from 5430745e..b102f1b8

b102f1b8 Update Actions (#2593)
86293136 Fix LoongArch aliases and CS_OPT_SYNTAX_NO_DOLLAR support (#2594)
27da950c Clarify between machine used vs. Capstone module affected. (#2586)
186f7aa0 Fix linking issue on Windows. (#2587)
e160cbc5 Fix complex atomic instructions handling (#2584)
9907b22d Update v6 to have Debian Packages (#2579)
efbbc3bb cstest: use DOWNLOAD_EXTRACT_TIMESTAMP conditionally (#2581)
be6be784 x86: update read/write registers for transfer instructions (#2578)
812e654c Update BPF arch (#2568)
2c4b05f6 Clean up the cstest documentation and build instructions. (#2580)
4dc14ba1 Fix 2572 (#2574)
b25aa841 PPC regressions (#2575)
0a29bf80 Small arm64 compat header fixes (#2563)
b42e0903 Make thumb, v8 and m-class positional cstool arguments. (#2557)
89aee400 Add arm64 and sysz compatibility layer to Python bindings (#2559)
a4281337 Python bindings: Enable more archs + bump cibuildwheel action to the v2.22.0 (#2558)
ef74d449 Arm regressions (#2556)
93a104c0 PPC LLVM 18 (#2540)
e46838ed Merge branch 'v6' into next
cf3600e7 Update Changelog Version to 6.0.0-Alpha2 (#2553)
b295cf57 Prepare for update (#2552)
fc59da4d fix xtensa DecodeMR23RegisterClass and add tests for MAC16 instru… (#2551)
7d01d7e7 Auto-Sync reproducability + ARM update (#2532)
6ad2608d Python package building rework (#2538)
e3bc578d Move debian package generation to a dispatch only workflow (#2543)
abbf32b4 fix coverity (#2546)
1ecfb5b0 xtensa: update to espressif/llvm-project (#2533)
379e2a41 Rename build arguments: (#2534)
d7be5f9f Change CI to create Debian Package to Release (#2521)
f6f96796 tricore: fixes #2474 (#2523)
09f35961 This time actually fix big endian issue. (#2530)
306d5716 Fix endianess issue during assignment. (#2528)
2cfca35e Add CC and VAS compatibility macros (#2525)
32519c01 Fix stringop-truncation warning some compilers raise. (#2522)
5026c2c4 Merge pull request #2507 from thestr4ng3r/no-varargs-aarch64
cecb5ede Fix #2509. (#2510)
f97e2705 xtensa: Fix Branch Target (#2516)
1d13a12f AArch64: Replace vararg add_cs_detail by multiple concrete functions
8b618528 Update libcyaml dependency in cstest to 1.4.2 (#2508)
ea081286 Tricore EA calculation (#2504)
7db9a080 Fix cstest build with Ninja (#2506)
76242699 Only trigger on released action. (#2497)
981d648b Add hard asserts to all SStream functions and memset MCInst. (#2501)
d667a627 Update labeler with Xtensa and v6 files. (#2500)
52b54ee3 Fixing UB santizer, `LITBASE` and assert errors. (#2499)
97db712c Remove irrelevant changes. (#2496)
5bd05e34 Remove irrelevant changes. (#2495)
616488c7 Update changelog for V6.0.0-Alpha1 (#2493) (#2494)
c5955b92 Update changelog for V6.0.0-Alpha1 (#2493)
a424e709 Be ready for V6-Alpha1 (#2492)
235ba8e0 SystemZ fixes (#2488)
5dffa75b Fix LDR not assigning immediate as memory offset. (#2487)
21f7bc85 Xtensa Support (#2380)
29d87734 Several small fixups (#2489)
a34901e9 Update sponsors and remove empty file. (#2485)
3120932d Fix Coverity CID 509730: overflow before widen (#2486)
1014864d Rename CS_OPT_NO_BRANCH_OFFSET and corresponding flag to better name. (#2482)
0c90fe13 Replace `assert` with `CS_ASSERT` in modules (#2478)
823bfd53 AArch64 issues (#2473)

git-subtree-dir: external/capstone
git-subtree-split: b102f1b89e0455c072a751d287ab64378c14205f

2025-01-07 15:08:55 +00:00

4.3 KiB

Raw Blame History

Building Capstone

This guide describes how to build Capstone with CMake.

Build commands

Unix

cmake -B build -DCMAKE_BUILD_TYPE=Release # For debug build change "Release" to "Debug"
cmake --build build
cmake --install build --prefix "<install-prefix>"

Windows

cmake.exe -B build
cmake.exe --build build --config Release # For debug build change "Release" to "Debug"
cmake.exe --install build

Tailor Capstone to your needs.

Enable and disable options in the "configure" step (first cmake command from above). Options are added with -D<OPTION>=ON/OFF or -D<OPTION>=1/0

Exclude architecture modules

You can build Capstone with only the architectures you need. By default all are enabled.

CAPSTONE_ARCHITECTURE_DEFAULT: Whether all architectures are enabled by default.
CAPSTONE_ARM_SUPPORT: Support ARM.
CAPSTONE_AARCH64_SUPPORT: Support AARCH64.
CAPSTONE_ALPHA_SUPPORT: Support Alpha.
CAPSTONE_HPPA_SUPPORT: Support HPPA.
CAPSTONE_LOONGARCH_SUPPORT: Support LoongArch.
CAPSTONE_M680X_SUPPORT: Support M680X.
CAPSTONE_M68K_SUPPORT: Support M68K.
CAPSTONE_MIPS_SUPPORT: Support Mips.
CAPSTONE_MOS65XX_SUPPORT: Support MOS65XX.
CAPSTONE_PPC_SUPPORT: Support PPC.
CAPSTONE_SPARC_SUPPORT: Support Sparc.
CAPSTONE_SYSTEMZ_SUPPORT: Support SystemZ.
CAPSTONE_XCORE_SUPPORT: Support XCore.
CAPSTONE_TRICORE_SUPPORT: Support TriCore.
CAPSTONE_X86_SUPPORT: Support X86.
CAPSTONE_TMS320C64X_SUPPORT: Support TMS320C64X.
CAPSTONE_M680X_SUPPORT: Support M680X.
CAPSTONE_EVM_SUPPORT: Support EVM.
CAPSTONE_WASM_SUPPORT: Support Web Assembly.
CAPSTONE_BPF_SUPPORT: Support BPF.
CAPSTONE_RISCV_SUPPORT: Support RISCV.

Module registration

If you're building a static library that you intend to link into multiple consumers, and they have differing architecture requirements, you may want -DCAPSTONE_USE_ARCH_REGISTRATION=1.

In your consumer code you can call cs_arch_register_*() to register the specific module for initialization.

In this way you only pay footprint size for the architectures you're actually using in each consumer, without having to compile Capstone multiple times.

Additional options

Capstone allows some more customization via the following options:

CAPSTONE_BUILD_SHARED_LIBS: Build shared libraries.
CAPSTONE_BUILD_STATIC_LIBS: Build static libraries (ON by default).
CAPSTONE_BUILD_STATIC_MSVC_RUNTIME: (Windows only) - Build with static MSVC runtime. Always set if CAPSTONE_BUILD_SHARED_LIBS=ON.
CAPSTONE_BUILD_CSTOOL: Enable/disable build of cstool. Default is enabled if build runs from the repository root.
CAPSTONE_USE_SYS_DYN_MEM: change this to OFF to use your own dynamic memory management.
CAPSTONE_BUILD_MACOS_THIN: MacOS only. Disables universal2 build. So you only get the binary for you processor architecture.
CAPSTONE_BUILD_DIET: change this to ON to make the binaries more compact.
CAPSTONE_X86_REDUCE: change this to ON to make X86 binary smaller.
CAPSTONE_X86_ATT_DISABLE: change this to ON to disable AT&T syntax on x86.

By default, Capstone use system dynamic memory management, and both DIET and X86_REDUCE modes are disabled. To use your own memory allocations, turn ON both DIET & X86_REDUCE, run "cmake" with: -DCAPSTONE_USE_SYS_DYN_MEM=0, -DCAPSTONE_BUILD_DIET=1, -DCAPSTONE_X86_REDUCE=1

Developer specific options

CAPSTONE_DEBUG: Change this to ON to enable extra debug assertions. Automatically enabled with Debug build.
CAPSTONE_BUILD_CSTEST: Build cstest in suite/cstest/. Note: cstest requires libyaml on your system. It attempts to build it from source otherwise.
CMAKE_EXPORT_COMPILE_COMMANDS: To export compile_commands.json for clangd and other language servers.
ENABLE_ASAN: Compiles Capstone with the address sanitizer.
ENABLE_COVERAGE: Generate coverage files.
CAPSTONE_BUILD_LEGACY_TESTS: Build some legacy integration tests.

Building cstest

cstest is build together with Capstone by adding the flag -DCAPSTONE_BUILD_CSTEST.

The build requires libyaml. It is a fairly common package and should be provided by your package manager.

Note: Currently cstest us only supported on Linux.

If you run another operation system, please install cstest_py. See bindings/python/BUILDING.md for instructions.

4.3 KiB Raw Blame History