Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / capstone / refs/heads/int/13/fp4 / . / README.md
blob: 1a61b9484a3d7624de0ef1b94cc705ad67712700 [file] [log] [blame] [view]
Nguyen Anh Quynh3eb6eea2016-03-01 13:57:06 +0800[diff] [blame]1Capstone Engine
2===============
3
Nguyen Anh Quynh79076262019-02-02 00:41:32 +0800[diff] [blame]4[![Build Status](https://travis-ci.org/aquynh/capstone.svg?branch=master)](https://travis-ci.org/aquynh/capstone)
5[![Build status](https://ci.appveyor.com/api/projects/status/a4wvbn89wu3pinas/branch/master?svg=true)](https://ci.appveyor.com/project/aquynh/capstone/branch/master)
Nguyen Anh Quynh467eed62019-02-07 18:35:51 +0800[diff] [blame]6[![pypi package](https://badge.fury.io/py/capstone.svg)](https://pypi.python.org/pypi/capstone)
Nguyen Anh Quynhfc4407f2019-02-15 08:58:46 +0800[diff] [blame]7[![pypi downloads](https://pepy.tech/badge/capstone)](https://pepy.tech/project/capstone)
Pranith Kumar87480e42016-02-29 23:11:44 -0500[diff] [blame]8
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]9Capstone is a disassembly framework with the target of becoming the ultimate
10disasm engine for binary analysis and reversing in the security community.
11
12Created by Nguyen Anh Quynh, then developed and maintained by a small community,
13Capstone offers some unparalleled features:
14
Nguyen Anh Quynhed1246d2018-03-31 17:29:22 +0800[diff] [blame]15- Support multiple hardware architectures: ARM, ARM64 (ARMv8), Ethereum VM, M68K,
Sebastian Macke7436f542018-12-04 19:09:38 +0100[diff] [blame]16 Mips, MOS65XX, PPC, Sparc, SystemZ, TMS320C64X, M680X, XCore and X86 (including X86_64).
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]17
18- Having clean/simple/lightweight/intuitive architecture-neutral API.
19
20- Provide details on disassembled instruction (called “decomposer” by others).
21
22- Provide semantics of the disassembled instruction, such as list of implicit
Nguyen Anh Quynh38b7bbb2014-01-22 10:21:25 +0800[diff] [blame]23 registers read & written.
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]24
Nguyen Anh Quynhf5960092018-11-21 17:45:33 +0800[diff] [blame]25- Implemented in pure C language, with lightweight bindings for D, Clojure, F#,
Nguyen Anh Quynh4f05e832018-07-24 13:44:39 +0800[diff] [blame]26 Common Lisp, Visual Basic, PHP, PowerShell, Emacs, Haskell, Perl, Python,
27 Ruby, C#, NodeJS, Java, GO, C++, OCaml, Lua, Rust, Delphi, Free Pascal & Vala
c0rejump03967e62020-01-04 16:42:35 +0100[diff] [blame]28 (ready either in main code, or provided externally by the community).
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]29
Nguyen Anh Quynh9672cd22014-06-16 22:06:44 +0800[diff] [blame]30- Native support for all popular platforms: Windows, Mac OSX, iOS, Android,
Nguyen Anh Quynhafffa5d2018-07-20 12:36:50 +0800[diff] [blame]31 Linux, \*BSD, Solaris, etc.
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]32
33- Thread-safe by design.
34
Nguyen Anh Quynhb0b73082014-03-03 17:57:15 +0800[diff] [blame]35- Special support for embedding into firmware or OS kernel.
36
Nguyen Anh Quynhedbee242014-10-21 12:04:38 +0800[diff] [blame]37- High performance & suitable for malware analysis (capable of handling various
38 X86 malware tricks).
39
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]40- Distributed under the open source BSD license.
41
Nguyen Anh Quynhb7155b02013-12-18 00:18:06 +0800[diff] [blame]42Further information is available at http://www.capstone-engine.org
43
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]44
Nguyen Anh Quynh3eb6eea2016-03-01 13:57:06 +0800[diff] [blame]45Compile
46-------
Nguyen Anh Quynh8afa3dd2013-12-18 00:11:25 +0800[diff] [blame]47
Nguyen Anh Quynh6217f362014-06-16 18:38:32 +0800[diff] [blame]48See COMPILE.TXT file for how to compile and install Capstone.
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]49
50
Nguyen Anh Quynh3eb6eea2016-03-01 13:57:06 +0800[diff] [blame]51Documentation
52-------------
Nguyen Anh Quynh257ea592014-10-20 17:38:53 +0800[diff] [blame]53
Nguyen Anh Quynhbc01e2c2014-10-20 16:29:15 +0800[diff] [blame]54See docs/README for how to customize & program your own tools with Capstone.
55
56
Nguyen Anh Quynh3eb6eea2016-03-01 13:57:06 +0800[diff] [blame]57Hack
58----
Nguyen Anh Quynh26ee41a2013-11-27 12:11:31 +0800[diff] [blame]59
Tim Strazzere13d7d302015-10-02 19:04:59 -0700[diff] [blame]60See HACK.TXT file for the structure of the source code.
Nguyen Anh Quynh8afa3dd2013-12-18 00:11:25 +0800[diff] [blame]61
62
Nguyen Anh Quynh3eb6eea2016-03-01 13:57:06 +0800[diff] [blame]63License
64-------
Nguyen Anh Quynh8afa3dd2013-12-18 00:11:25 +0800[diff] [blame]65
Nguyen Anh Quynh24ca24c2013-12-18 10:16:07 +0800[diff] [blame]66This project is released under the BSD license. If you redistribute the binary
67or source code of Capstone, please attach file LICENSE.TXT with your products.