Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / capstone / refs/tags/rel/10/fp2/22.04.0-rel.1 / . / README
blob: d9682364eb888a881d590c57b6b4b3095bd950df [file] [log] [blame]
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]1Capstone is a disassembly framework with the target of becoming the ultimate
2disasm engine for binary analysis and reversing in the security community.
3
4Created by Nguyen Anh Quynh, then developed and maintained by a small community,
5Capstone offers some unparalleled features:
6
Nguyen Anh Quynh636f5062014-03-23 22:24:28 +0800[diff] [blame]7- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Mips, PPC, Sparc,
Nguyen Anh Quynhbc01e2c2014-10-20 16:29:15 +0800[diff] [blame]8 SystemZ, XCore and X86 (including X86_64).
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]9
10- Having clean/simple/lightweight/intuitive architecture-neutral API.
11
12- Provide details on disassembled instruction (called “decomposer” by others).
13
14- Provide semantics of the disassembled instruction, such as list of implicit
Nguyen Anh Quynh38b7bbb2014-01-22 10:21:25 +0800[diff] [blame]15 registers read & written.
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]16
Nguyen Anh Quynhbbb6b9e2017-04-14 23:26:55 +0800[diff] [blame]17- Implemented in pure C language, with lightweight bindings for Visual Basic, PHP,
18 PowerShell, Emacs, Haskell, Perl, Python, Ruby, C#, NodeJS, Java, GO, C++, OCaml,
19 Lua, Rust, Delphi, Free Pascal & Vala ready either in main code, or provided
Nguyen Anh Quynhd909de02016-11-11 23:14:23 +0900[diff] [blame]20 externally by the community).
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]21
Nguyen Anh Quynh9672cd22014-06-16 22:06:44 +0800[diff] [blame]22- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
23 Linux, *BSD, Solaris, etc.
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]24
25- Thread-safe by design.
26
Nguyen Anh Quynhb0b73082014-03-03 17:57:15 +0800[diff] [blame]27- Special support for embedding into firmware or OS kernel.
28
Nguyen Anh Quynhedbee242014-10-21 12:04:38 +0800[diff] [blame]29- High performance & suitable for malware analysis (capable of handling various
30 X86 malware tricks).
31
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]32- Distributed under the open source BSD license.
33
Nguyen Anh Quynhb7155b02013-12-18 00:18:06 +0800[diff] [blame]34Further information is available at http://www.capstone-engine.org
35
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]36
37[Compile]
Nguyen Anh Quynh8afa3dd2013-12-18 00:11:25 +0800[diff] [blame]38
Nguyen Anh Quynh6217f362014-06-16 18:38:32 +0800[diff] [blame]39See COMPILE.TXT file for how to compile and install Capstone.
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]40
41
Nguyen Anh Quynhbc01e2c2014-10-20 16:29:15 +0800[diff] [blame]42[Documentation]
Nguyen Anh Quynh257ea592014-10-20 17:38:53 +0800[diff] [blame]43
Nguyen Anh Quynhbc01e2c2014-10-20 16:29:15 +0800[diff] [blame]44See docs/README for how to customize & program your own tools with Capstone.
45
46
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]47[Hack]
48
Tim Strazzere13d7d302015-10-02 19:04:59 -0700[diff] [blame]49See HACK.TXT file for the structure of the source code.
Nguyen Anh Quynh8afa3dd2013-12-18 00:11:25 +0800[diff] [blame]50
51
52[License]
53
Nguyen Anh Quynh24ca24c2013-12-18 10:16:07 +0800[diff] [blame]54This project is released under the BSD license. If you redistribute the binary
55or source code of Capstone, please attach file LICENSE.TXT with your products.