Version 6.0.0-Alpha1

With the v6 release we added a new update mechanism called Auto-Sync. This is a huge step for Capstone, because it allows for easy module updates, easier addition of new architectures, easy features addition and guarantees less faulty disassembly.

This release adds a huge amount of new architectures, extensions, bug fixes and quality of life improvements.

Almost all the work was sponsored by RizinOrg. This release would have simply not happened without them.

The developers with the biggest contributions were (alphabetically):

• TriCore - @billow (Sponsored)
• LoongArch - @jiegec and @FurryAcetylCoA
• Alpha, HPPA - @R33v0LT (Sponsored)
• AArch64, ARM, Auto-Sync, PPC, SystemZ, modernized testing - @Rot127 (Sponsored)
• Mips, NanoMips - @wargio

There are also multiple smaller additions

• Reviewing all PRs - @kabeor
• Architecture module registration - @oleavr
• Building of thin binaries for Apple - @rickmark
• Python packaging and testing - @twizmwazin, @peace-maker
• RISCV operand access info - @wxrdnx

And of course there were many more improvements done by other contributors, which add to the release just as the ones above. For a full list of all the developers, please see the below.

With all that said, we hope you enjoy the new release!

Breaking Changes

• ARM64 was renamed to AArch64 everywhere (compatibility header is provided).
• SysZ was renamed to SystemZ everywhere (compatibility header is provided).
• Changes happened especially to the PPC, ARM and AArch64 API, as well as changes to enumeration values and stucts.
  Please be sure to read the release guide carefully!
  You can find all the breaking changes and justifications for them!

What's New

• LoongArch, HPPA and Alpha support added.
• AArch64, SystemZ and Mips updated to LLVM 18.
• NanoMips extension added.
• ARM and PPC updated to LLVM 16.
• Exotic PPC PairedSingle extension added.
• Instruction formats for PPC, SystemZ and LoongArch added.
• Instruction alias support added.
• RISCV operand access information added.
• Testing was rewritten from scratch.
• All tests are run with the address sanitizer.
• Several improvements to the API of the ARM, AArch64 and PPC modules.

For an exhaustive list, see the release guide at https://github.com/capstone-engine/capstone/blob/next/docs/cs_v6_release_guide.md

• Thank you @FinnWilkinson for testing the AArch64 module and its extensions so thoroughly.

What's Changed

• [v6] Move meta-programming macros for ARM64/AArch64 to capstone.h by @Rot127 in #2201
• Remove no longer used td files. by @Rot127 in #2205
• tricore: fix runtime errors of integer overflow by @imbillow in #2204
• Disable maybe-uninitialized warning all together. by @Rot127 in #2210
• [ARM] Add alias support by @Rot127 in #2209
• [TriCore] Replace one- and sign-extend with MathExtra.h functions. by @Rot127 in #2212
• [ARM] Add RET group to pop instructions which write to the PC. by @Rot127 in #2216
• V6 release guide by @Rot127 in #2124
• Add CS_aarch64 macro without parameter. by @Rot127 in #2218
• Fix broken disassembly of floating point immediates on big endian hosts by @huth in #2222
• Add Alpha architecture by @R33v0LT in #2071
• Ignore JetBrains based IDE data for clean PRs by @rickmark in #2224
• Add Big-endian mode for Alpha by @R33v0LT in #2227
• Fix typos in COMPILE_CMAKE.TXT by @kobykahane in #2229
• LIBDIRARCH does not propagate to Makefile by @YaSuenag in #2214
• Fix type punning in AArch64_AM_isSVEMaskOfIdenticalElements by @kazarmy in #2237
• Raise minimum requirement to VS2017 by @XVilka in #2228
• Update docs wit ASUpdater.py script by @Rot127 in #2217
• Add autolabeler GitHub Action by @XVilka in #2239
• By default compile as universal2 for macOS by @rickmark in #2221
• Use union in AArch64_AM_isSVEMaskOfIdenticalElements type punning fix by @kazarmy in #2238
• Fix #2234. by @Rot127 in #2236
• Remove comment stating support for multiple clang-format versions by @kazarmy in #2242
• Fix label assignment for LLVM generated files. by @Rot127 in #2243
• Constify Alpha and TriCore by @rth7680 in #2245
• Fix compilation with DIET + X86_REDUCE by @oleavr in #2248
• Fix warnings when building with CAPSTONE_DIET by @oleavr in #2249
• Fix MSVC warning overrides when using non-MSVC toolchains by @oleavr in #2250
• Add support for architecture registration by @oleavr in #2252
• auto-sync: Fix some tree-sitter queries by @kazarmy in #2255
• cstool: Fix ppc_br_hint comparison by @oleavr in #2254
• Fix crash on x86 when building with MSVC by @oleavr in #2253
• Fix regressions in custom memory allocator support by @oleavr in #2251
• Fix compilation with CAPSTONE_X86_REDUCE by @oleavr in #2256
• auto-sync BitCastStdArray.py: Transform to union instead by @kazarmy in #2257
• Make helper functions static to prevent multiple defintions. by @Rot127 in #2266
• Drop distutils in python binding by @Xeonacid in #2271
• Fix #2233 by @Rot127 in #2267
• Fix OOB read and wries by @Rot127 in #2273
• [AArch64] Fix incorrect alignment of labels. by @Rot127 in #2277
• Makefile: Improve Apple detection by @sevan in #2263
• [CMake] Architecture definition fix by @Rot127 in #2272
• [PPC] Expose instruction formats by @Rot127 in #2276
• Add issue and PR templates by @Rot127 in #2294
• Avoid random access values for operands in not-yet-specified instructions. by @mur47x111 in #2259
• Remove repetitive words by @majorteach in #2297
• Add HPPA(PA-RISC) architecture by @R33v0LT in #2265
• Fix invalid comparison with HPPA_OP_INVALID by @R33v0LT in #2300
• HPPA dissassembler fix unitialized variables errors by @R33v0LT in #2309
• Weaken requirements to document functions. by @Rot127 in #2324
• [Auto-Sync] LLVM 18 update by @Rot127 in #2296
• chore: remove repetitive words by @careworry in #2326
• Fix cstool Makefile for non-C99-defaulting compilers by @thestr4ng3r in #2315
• check if decode[idx] is callable by @Ced2911 in #2322
• Add eBPF bswap16/32/64 instruction by @chengshuyi in #2323
• Add a clang-tidy checks and warnings by @Rot127 in #2312
• [next] Fix #2128 by adding missing mapping values. by @Rot127 in #2335
• Replace manually compile tree-sitter-cpp with their Python bindings. by @Rot127 in #2337
• [next] Fix #2079: Add missing 1 immediate to rcl by @Rot127 in #2330
• fix typos by @RainRat in #2344
• Fix clang tidy by @Rot127 in #2347
• Fix pkgconfig file to make #include <capstone/capstone.h> work by @ret2libc in #2307
• Rewrite str_replace using snprintf for security and fix clang-tidy by @jiegec in #2350
• Clang tidy quality of life by @Rot127 in #2348
• [next] Fix #2244: Don't apply pseudo-instr. offset to vcmp id by @Rot127 in https://github.com/capstone-engine/capstone/pul...

Version 5.0.3

Highlight

• This release mainly fixes a series of issues with python wheel in the previous version.

What's Changed

• [v5] Updates and fixes to the Python wheel builder workflow by @Rot127 in #2440
• Relocatable package v5 by @mrexodia in #2447
• [v5] Wheel build fixes: manylinux1, trigger upload on release, Linux AArch64 by @Rot127 in #2443

Full Changelog: 5.0.2...5.0.3

Version 5.0.2

What's Changed

• [v5] Add meta-programming macros for ARM64/AArch64 name change to capstone.h by @Rot127 in #2199
• [v5] Add CS_aarch64 macro without parameter. by @Rot127 in #2219
• [v5] python: Fix definition of capstone syntax value option constants by @nmeum in #2240
• Constify TriCore by @rth7680 in #2246
• Revert constant value of CS_OP_MEM to v5.0.1 by @Rot127 in #2275
• Do not use 0b prefix, not supported on old compilers by @trufae in #2306
• Update CMakeLists.txt version (See #2310) by @PerikiyoXD in #2311
• [v5] Fix #2128 by adding missing mapping values. by @Rot127 in #2334
• [v5] Fix #2079: Add missing 1 immediate to rcl by @Rot127 in #2329
• [v5] Fix incorrect ID mappings for PPC by @Rot127 in #2333
• [v5] Fix #2244: Don't apply pseudo-instr. offset to vcmp id by @Rot127 in #2332
• Fix comparison using narrow types in loop condition by @trufae in #2360
• SH: Use bitwise OR with mask for sign extension by @lhsazevedo in #2371
• Remove deprecated packaging and cython by @twizmwazin in #2400
• [v5] Fix typo in AArch64 Python binding by @david942j in #2412
• Backport python-publish.yml from next by @twizmwazin in #2408
• [v5] Add release wheel build workflow for all Python versions by @Rot127 in #2415
• [v5] Fix unintended zero set in Sparc printInst by @david942j in #2420
• [v5][arm] Consider SpecRegRBit on setting SYSREG by @david942j in #2422
• Prepare for release v5.0.2 by @kabeor in #2425
• Update ChangeLog for v5.0.2 by @kabeor in #2426
• [V5] Fix Python package build action by @kabeor in #2428
• Fix CI fuzz job yml syntax by @Rot127 in #2430
• Fix static lib (#2433) by @hsebs in #2434
• Update changelog v5.0.2 release time by @kabeor in #2435
• [CI] downguard actions/download-artifact to v3 by @kabeor in #2436

New Contributors

• @nmeum made their first contribution in #2240
• @PerikiyoXD made their first contribution in #2311
• @lhsazevedo made their first contribution in #2371
• @hsebs made their first contribution in #2434

Full Changelog: 5.0.1...5.0.2

Version 5.0.1

What's Changed

• [ARM] Fix VFP feature check by @Rot127 in #2090
• Restore the ARM register naming from v4. by @gerph in #2108
• Use OS independent printf formatting. by @Rot127 in #2109
• Cherry-pick from next for v5.0.1 by @kabeor in #2141
  • Add Python bindings for WASM by @peace-maker #2095
  • Sync Python bindings for x86, m68k, and mos65xx by @peace-maker #2100
  • Add Python bindings for SH by @peace-maker #2096
  • Update Python binding constants by @peace-maker #2097
  • Fixing TriCore disasm instructions by @bkoppelmann #2088
  • allow absolute CMAKE_INSTALL_*DIR @chayleaf #2134
• Prepare for release v5.0.1 by @kabeor in #2143

New Contributors

• @gerph made their first contribution in #2108
• @bkoppelmann made their first contribution in #2088
• @chayleaf made their first contribution in #2134

Full Changelog: 5.0...5.0.1

Version 5.0

What's Changed

• [workflows] Remove deprecated image versions by @kabeor in #2057
• Fix capstone_test.c #2059 by @imbillow in #2060
• Support repz prefix on X86 ret instructions by @adamjseitz in #2063
• fix for msvc static lib, dll build error and warnings by @arkup in #2061
• use calloc for cs_insn instead of malloc by @ConnorRigby in #1972
• Fix access bug for TEST op by @melynx in #1511
• Update Cython bindings by @peace-maker in #2068
• Use Intel register syntax for Tricore by @XVilka in #2067
• Add # prefix to tricore imm operand by @imbillow in #2070
• Revert "Mark cs_* as thread local to avoid race condition in multithreads" by @oleavr in #1933
• Replace strncpy with memcpy to fix compiler warning. by @Rot127 in #2075
• Remove outdated and irrelevant TODO by @XVilka in #2074

New Contributors

• @arkup made their first contribution in #2061
• @ConnorRigby made their first contribution in #1972
• @melynx made their first contribution in #1511

Full Changelog: 4.0.1...5.0

Version 5.0 post1

This version exists to fix the issue of the same name that we yanked V5.0 on PyPI caused. The code is still the same as V5.0.

Full Changelog: 5.0...5.0-post1

Version 5.0-rc4

What's Changed

• Fix TriCore test by @hamarituc in #2049
• [workflows] Fix python-publish issue by @kabeor in #2050
• Update version tag by @kabeor in #2052
• Release 5.0-rc4 by @kabeor in #2051

Full Changelog: 5.0-rc3...5.0-rc4

Version 5.0-rc3

What's Changed

• update pkgconfig version by @kabeor in #1847
• vb6 bindings: clarify license as Apache v2.0 by @dzzie in #1850
• AArch64 SYS instruction operands by @adamjseitz in #1859
• AArch64: fix missing VAS specifiers in aliased instructions by @adamjseitz in #1860
• Add cstool in CMake Package Config + CMake Github Workflow by @theblackunknown in #1867
• Fix pkgconfig not installed when CAPSTONE_BUILD_CSTOOL is false by @theblackunknown in #1870
• AArch64 comprehensively add vas specifiers to aliased instructions by @adamjseitz in #1877
• Fix pkg-config template by @hamarituc in #1878
• Fix eBPF lddw opcode by @terorie in #1885
• Add eBPF callx instruction by @terorie in #1886
• Mark cs_* as thread local to avoid race condition in multithreads by @wtdcode in #1891
• One semicolon is enough in C by @trufae in #1892
• Add PowerPC paired-singles support by @terorie in #1898
• Update the table for UD0 and UD1 with the latest llvm table by @junghee in #1863
• Sync eBPF and PowerPC bindings by @terorie in #1900
• Fix PPC insn names and psq displacement by @terorie in #1902
• Fix -Werror build by @trufae in #1906
• Remove outdated ctypes requirement by @jbott in #1910
• Fix memory leak in testsuite by @hamarituc in #1919
• PPC: fix out of bound memory access by @hamarituc in #1913
• AArch64 armv9.2 update by @FinnWilkinson in #1907
• m68k: Add support for the FNOP instruction by @huth in #1921
• arm64: fix invalid free introduced in 662bb3f by @trufae in #1926
• Fixed SME index alias printing issue. by @FinnWilkinson in #1925
• Updated Arm64 python bindings after Armv9.2-a support. by @FinnWilkinson in #1932
• ARM/AArch64: Add post-index to instruction info by @ZehMatt in #1937
• Fix regressions in custom memory allocator support by @oleavr in #1934
• cstool: support riscv compressed instruction disassemble by @rrwhx in #1940
• Mention debug build option for cmake. by @Rot127 in #1942
• cstool: avoid misaligned instructions in compressed riscv by @carenas in #1943
• arm64: fix missing post_index by @HyperSine in #1944
• Add CMAKE_EXPORT_COMPILE_COMMANDS to cmake build doc by @Rot127 in #1948
• Fix potential array out of bounds by @mjunix in #1938
• Add Renesas SuperH instructions support by @ysat0 in #1927
• fix missing access field in arm64 java binding by @sunxingxing in #1959
• Update python bindings to fix ARM in detail mode. by @wideglide in #1961
• sh: add missing include for CMake install step by @SweetVishnya in #1964
• Fix CITest && python binding issues by @kabeor in #1965
• correct register accesses for ARM's sxtb/uxtb and similar instructions by @covanam in #1968
• In x86: Fixed backward compatibility with C90 by @hasherezade in #1969
• Fix for missing register usages on ARM64 authenticated branches (issue #1975) by @stevielavern in #1976
• AArch64: fixes register access flags for moves by @thomasdangl in #1974
• [SH] Fix build warnings by @Rot127 in #1960
• update CI ubuntu version by @kabeor in #1986
• fix cstest Makefile by @imbillow in #1989
• fix: compile error missing file cstool msvc/visual studio by @raigorx in #2000
• Fix missing NOTRACK prefix by @junghee in #2002
• Fix make builds with SH support by @trufae in #2006
• Add missing architectures in the readme and sort them by @trufae in #2008
• Add TriCore Architecture by @imbillow in #1973
• Fix compilation warnings related to TriCore. by @imbillow in #2012
• Fix SH build warnings. by @Rot127 in #2016
• Tricore fix the negative call and jump by @imbillow in #2018
• [SH] Fix warnings about unhandled switch cases by adding defaults. by @Rot127 in #2017
• Tricore fix disp fill and ctest build by @imbillow in #2019
• Fix disassemble of xor by @imbillow in #2023
• Fix register accesses & operands of multiple ARMv8.3 PAC instructions by @stevielavern in #2022
• Add missing arm64 to Darwin LIBARCHS and remove dependencies tracking… by @gdbinit in #2024
• Fix tricore compile warning by @imbillow in #2027
• [PPC] Fix random branch hint and update_cr0 set up. by @Rot127 in #2028
• Fix #2032 by @Rot127 in #2033
• Add operands access support for TriCore by @imbillow in #2034
• Hotfix for -DCAPSTONE_DIET build. by @Rot127 in #2038
• Fix Python bindings after changes to cs_detail by @peace-maker in #2041
• RISCV: Add call, int and branch_relative instruction groups by @peace-maker in #2007
• Re-fix pkgconfig includedir/Cflags by @orlitzky in #2046
• Update ChangeLog to 5.0.0-rc3 by @kabeor in #2047

New Contributors

• @adamjseitz made their first contribution in #1859
• @theblackunknown made their first contribution in #1867
• @hamarituc made their first contribution in #1878
• @terorie made their first contribution in #1885
• @junghee made their first contribution in #1863
• @jbott made their first contribution in #1910
• @FinnWilkinson made their first contribution in #1907
• @huth made their first contribution in #1921
• @ZehMatt made their first contribution in #1937
• @rrwhx made their first contribution in #1940
• @Rot127 made their first contribution in #1942
• @HyperSine made their first contribution in #1944
• @mjunix made their first contribution in #1938
• @ysat0 made their first contribution in #1927
• @sunxingxing made their first contribution in #1959
• @wideglide made their first contribution in #1961
• @SweetVishnya made their first contribution in #1964
• @covanam made their first contribution in #1968
• @thomasdangl made their first contribution in #1974
• @imbillow made their first contribution in #1989
• @raigorx made their first contribution in #2000
• @peace-maker made their first contribution in https://github.com/capstone-engine/capstone/pul...

Version 5.0-rc2

Improvements:

• Fix for python publish build (#1844)
• Modernize CMake and switch to CMake 3.15 (#1841)
• Fix AArch64 ldapr detailed information (#1840)
• Fix incorrect MI->ac_idx leading to wrong AArch64 InsnOp access printing (#1845)

Contributors:

• @stevielavern
• @mrexodia
• @kabeor

Version 5.0-rc1

New features:

• Add arch BPF (#1388)
• Add arch RISCV (#1401)
• Add arch WASM (#1359)
• PyPI workflow (#1645)
• Option to generate install target (#1698 #1700)
• Swift binding (#1707)
• Add CI Test support (#1797)
• Add benchmark (#1811)

Improvements:

• Add fixups for aarch64 instructions (#1632 #1655)
• Add fixups for x86 instructions (#1644 #1657 #1689 1751)
• Add fixups for m68k instructions (#1663 #1709)
• Add fixups for m680x instructions (#1695)
• Add fixups for mips instructions (#1674)
• Add fixups for mos65xx instructions (#1702)
• Add fixups for systemz instructions (#1679)
• Add fixups for risc-v instructions (#1682 #1690 #1691)
• Add fixups for ppc instructions (#1687 #1688)
• Add cmake config and export targets (#1637)
• Fix issues in Makefiles (#1639)
• Fix issues about cmake builds (#1649 #1659)
• MSVC tooling updates (#1651)
• Fix crash when using skipdata with NULL mnemonic(#1703)
• Fix python only use ascii character (#1704)
• Add support for aarch64 distributions (#1720)
• Fix registry access for several versions of pop such as POPDS, POPSS, etc. (#1725)
• Fix registry access on cmov instructions (#1727)
• Fix -Wstringop-truncation warnings (#1730)
• Fix always return the same type from regs_read (#1736)
• Fix inconsistent behavior of Mips_option() (#1744)
• Fix pythonic bug (#1745)
• Fixes the (pip) Python Module build on FreeBSD (#1750)
• Enable detection and build on all BSD systems (#1753)
• Fix the displacement offset for moffset-encoded operands (#1754)
• Update cmake_minimum_required to version 2.8.12 (#1756)
• Fixed typos in compilation steps (#1762)
• Fix build android (#1765)
• Support disassembling bytes from memoryview (#1773)
• Fixed library extension to build properly under CYGWIN (#1791)
• Add Capstone Engine Documentation (#1794)
• Fix eflags effects for adc/sbb (#1798)
• Update x86 operand access information (#1801)
• CI automatically build release tarball (#1802)
• Dont format sstreams when there's nothing to format (#1805)
• Fix warning about Unused variables (#1815)
• Fix insn initialization when instruction have no operands or have a prefix (#1816)
• Avoid abort() if x86 not supported (#1818)
• Fix unterminated string regression (#1819)
• Fixed incorrect operand access on x86 instruction vmovdqu (#1823)

Contributors:

• @ekilmer
• @mcmtroffaes
• @sh1r4s3
• @emoon
• @chfl4gs
• @heshpdx
• @hmoenck
• @cyanpencil
• @NicolasDerumigny
• @trofi
• @maximumspatium
• @junchao-loongson
• @carenas
• @notyourusualaccountname
• @rth7680
• @StalkR
• @aeflores
• @TobiasFaller
• @XVilka
• @meme
• @zydeco
• @catenacyber
• @michalsc
• @urbas
• @keenk
• @kazarmy
• @learn-more
• @veritas501
• @trufae
• @cederom
• @Quentin01
• @jranieri-grammatech
• @scribam
• @huettenhain
• @lbj-the-goat
• @wheremyfoodat
• @Jaysonicc
• @huettenhain
• @syscl
• @bezita
• @Smartsmurf
• @tmfink
• @kazarmy
• @rofl0r
• @bSr43
• @wtdcode
• @dropTableUsers42
• @carenas
• @owlxiao
• @mxz297
• @SpikeI
• @catenacyber
• @david942j
• @fanfuqiang
• @aquynh
• @kabeor