![]() - This is not suitable for an application framework especially for kernel code. - All these error conditions do not occur under normal conditions. They only can occur if a maintainer (in the future) would make inappropriate changes to the M680X code base. - Added CS_ASSERT macro which allows to use assertions when debugging by defining CAPSTONE_DEBUG. - Updated compiler documenation |
||
---|---|---|
arch | ||
bindings | ||
contrib | ||
cstool | ||
docs | ||
include | ||
msvc | ||
packages | ||
suite | ||
tests | ||
windows | ||
windowsce | ||
xcode | ||
.appveyor.yml | ||
.clang-format | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
CMakeLists.txt | ||
COMPILE.TXT | ||
COMPILE_CMAKE.TXT | ||
COMPILE_MSVC.TXT | ||
CREDITS.TXT | ||
ChangeLog | ||
HACK.TXT | ||
LEB128.h | ||
LICENSE.TXT | ||
LICENSE_LLVM.TXT | ||
MCDisassembler.h | ||
MCFixedLenDisassembler.h | ||
MCInst.c | ||
MCInst.h | ||
MCInstrDesc.c | ||
MCInstrDesc.h | ||
MCRegisterInfo.c | ||
MCRegisterInfo.h | ||
Makefile | ||
MathExtras.h | ||
README.md | ||
RELEASE_NOTES | ||
SPONSORS.TXT | ||
SStream.c | ||
SStream.h | ||
TODO | ||
capstone.pc.in | ||
cmake.sh | ||
config.mk | ||
cs.c | ||
cs_priv.h | ||
functions.mk | ||
make.sh | ||
nmake.bat | ||
pkgconfig.mk | ||
utils.c | ||
utils.h |
README.md
Capstone Engine
Capstone is a disassembly framework with the target of becoming the ultimate disasm engine for binary analysis and reversing in the security community.
Created by Nguyen Anh Quynh, then developed and maintained by a small community, Capstone offers some unparalleled features:
-
Support multiple hardware architectures: ARM, ARM64 (ARMv8), BPF, Ethereum VM, Webassembly, M68K, Mips, MOS65XX, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore, RISC-V(rv32G/rv64G) and X86 (including X86_64).
-
Having clean/simple/lightweight/intuitive architecture-neutral API.
-
Provide details on disassembled instruction (called “decomposer” by others).
-
Provide semantics of the disassembled instruction, such as list of implicit registers read & written.
-
Implemented in pure C language, with lightweight bindings for D, Clojure, F#, Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python, Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala ready either in main code, or provided externally by the community).
-
Native support for all popular platforms: Windows, Mac OSX, iOS, Android, Linux, *BSD, Solaris, etc.
-
Thread-safe by design.
-
Special support for embedding into firmware or OS kernel.
-
High performance & suitable for malware analysis (capable of handling various X86 malware tricks).
-
Distributed under the open source BSD license.
Further information is available at http://www.capstone-engine.org
Compile
See COMPILE.TXT file for how to compile and install Capstone.
Documentation
See docs/README for how to customize & program your own tools with Capstone.
Hack
See HACK.TXT file for the structure of the source code.
License
This project is released under the BSD license. If you redistribute the binary or source code of Capstone, please attach file LICENSE.TXT with your products.