Nguyen Anh Quynh | b8f2af6 | 2013-12-25 10:49:59 +0800 | [diff] [blame] | 1 | How To Compile, install & run Capstone for Linux, Mac OSX, *BSD and Windows |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 2 | *-*-*-*-*-* |
| 3 | |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 4 | Capstone requires no prerequisite packages, so it is easy to compile & install. |
| 5 | |
| 6 | |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 7 | |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 8 | (0) Tailor Capstone to your need. |
| 9 | |
Nguyen Anh Quynh | 48a14ca | 2014-03-23 08:35:45 +0800 | [diff] [blame] | 10 | Out of 7 archtitectures supported by Capstone (Arm, Arm64, Mips, PPC, Sparc, |
| 11 | SystemZ & X86), if you just need several selected archs, you can choose which ones you |
Nguyen Anh Quynh | 05e2713 | 2014-03-10 11:58:57 +0800 | [diff] [blame] | 12 | want to compile in by modifying "config.mk" before going to next steps. |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 13 | |
Nguyen Anh Quynh | 48a14ca | 2014-03-23 08:35:45 +0800 | [diff] [blame] | 14 | By default, all 7 architectures are compiled. |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 15 | |
Nguyen Anh Quynh | 05e2713 | 2014-03-10 11:58:57 +0800 | [diff] [blame] | 16 | Capstone also supports "diet" engine to minimize the binaries for embedding |
| 17 | purpose. See docs/README for further instructions. |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 18 | |
| 19 | |
| 20 | (1) Compile from source |
| 21 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 22 | On *nix (such as MacOSX, Linux, *BSD, Solaris): |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 23 | |
Nguyen Anh Quynh | fe5e7f3 | 2014-01-17 14:56:03 +0800 | [diff] [blame] | 24 | - To compile for current platform, run: |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 25 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 26 | $ ./make.sh |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 27 | |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 28 | - On 64-bit OS, run command below to cross-compile Capstone for 32-bit binary: |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 29 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 30 | $ ./make.sh nix32 |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 31 | |
| 32 | |
| 33 | |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 34 | (2) Install Capstone on *nix |
| 35 | |
| 36 | To install Capstone, run: |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 37 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 38 | $ sudo ./make.sh install |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 39 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 40 | For FreeBSD/OpenBSD, where sudo is unavailable, run: |
Nguyen Anh Quynh | f74bebf | 2013-12-09 13:53:11 +0800 | [diff] [blame] | 41 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 42 | $ su; ./make.sh install |
Nguyen Anh Quynh | f74bebf | 2013-12-09 13:53:11 +0800 | [diff] [blame] | 43 | |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 44 | Users are then required to enter root password to copy Capstone into machine |
| 45 | system directories. |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 46 | |
Nguyen Anh Quynh | 9919e3b | 2014-01-22 10:17:17 +0800 | [diff] [blame] | 47 | Afterwards, run ./tests/test* to see the tests disassembling sample code. |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 48 | |
| 49 | |
Nguyen Anh Quynh | fe5e7f3 | 2014-01-17 14:56:03 +0800 | [diff] [blame] | 50 | NOTE: The core framework installed by "./make.sh install" consist of |
| 51 | following files: |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 52 | |
Patroklos Argyroudis | a6503fe | 2013-11-27 14:25:34 +0200 | [diff] [blame] | 53 | /usr/include/capstone/capstone.h |
| 54 | /usr/include/capstone/x86.h |
| 55 | /usr/include/capstone/arm.h |
| 56 | /usr/include/capstone/arm64.h |
| 57 | /usr/include/capstone/mips.h |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 58 | /usr/include/capstone/ppc.h |
Nguyen Anh Quynh | 05e2713 | 2014-03-10 11:58:57 +0800 | [diff] [blame] | 59 | /usr/include/capstone/sparc.h |
Nguyen Anh Quynh | 48a14ca | 2014-03-23 08:35:45 +0800 | [diff] [blame] | 60 | /usr/include/capstone/systemz.h |
Nguyen Anh Quynh | 05e2713 | 2014-03-10 11:58:57 +0800 | [diff] [blame] | 61 | /usr/include/capstone/diet.h |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 62 | /usr/lib/libcapstone.so (for Linux/*nix), or /usr/lib/libcapstone.dylib (OSX) |
Nguyen Anh Quynh | 0427122 | 2013-12-09 11:12:47 +0800 | [diff] [blame] | 63 | /usr/lib/libcapstone.a |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 64 | |
| 65 | |
| 66 | |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 67 | (3) Cross-compile Windows from *nix |
| 68 | |
| 69 | To cross-compile for Windows, Linux & gcc-mingw-w64-i686 (and also gcc-mingw-w64-x86-64 |
| 70 | for 64-bit binaries) are required. |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 71 | |
Nguyen Anh Quynh | fe5e7f3 | 2014-01-17 14:56:03 +0800 | [diff] [blame] | 72 | - To cross-compile Windows 32-bit binary, simply run: |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 73 | $ ./make.sh cross-win32 |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 74 | |
Nguyen Anh Quynh | fe5e7f3 | 2014-01-17 14:56:03 +0800 | [diff] [blame] | 75 | - To cross-compile Windows 64-bit binary, run: |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 76 | $ ./make.sh cross-win64 |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 77 | |
Nguyen Anh Quynh | 9919e3b | 2014-01-22 10:17:17 +0800 | [diff] [blame] | 78 | Resulted files libcapstone.dll, libcapstone.dll.a & tests/test*.exe can then |
| 79 | be used on Windows machine. |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 80 | |
| 81 | |
| 82 | |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 83 | (4) Compile on Windows with Cygwin |
| 84 | |
| 85 | To compile under Cygwin gcc-mingw-w64-i686 or x86_64-w64-mingw32 run: |
Daniel Godas-Lopez | cf05e11 | 2013-11-28 18:23:39 +0000 | [diff] [blame] | 86 | |
| 87 | - To compile Windows 32-bit binary under Cygwin, simply run |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 88 | $ ./make.sh cygwin-mingw32 |
Daniel Godas-Lopez | cf05e11 | 2013-11-28 18:23:39 +0000 | [diff] [blame] | 89 | |
Nguyen Anh Quynh | fe5e7f3 | 2014-01-17 14:56:03 +0800 | [diff] [blame] | 90 | - To compile Windows 64-bit binary under Cygwin, run |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 91 | $ ./make.sh cygwin-mingw64 |
Daniel Godas-Lopez | cf05e11 | 2013-11-28 18:23:39 +0000 | [diff] [blame] | 92 | |
Nguyen Anh Quynh | 9919e3b | 2014-01-22 10:17:17 +0800 | [diff] [blame] | 93 | Resulted files libcapstone.dll, libcapstone.dll.a & tests/test*.exe can then |
| 94 | be used on Windows machine. |
Daniel Godas-Lopez | cf05e11 | 2013-11-28 18:23:39 +0000 | [diff] [blame] | 95 | |
Nguyen Anh Quynh | fe5e7f3 | 2014-01-17 14:56:03 +0800 | [diff] [blame] | 96 | |
| 97 | (5) By default, "cc" (default C compiler on the system) is used as compiler. |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 98 | |
Oliver Pinter | 6e2c075 | 2014-01-16 12:16:21 +0100 | [diff] [blame] | 99 | - To use "clang" compiler instead, run command below: |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 100 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 101 | $ ./make.sh clang |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 102 | |
Nguyen Anh Quynh | fe5e7f3 | 2014-01-17 14:56:03 +0800 | [diff] [blame] | 103 | - To use "gcc" compiler instead, run: |
Oliver Pinter | 6e2c075 | 2014-01-16 12:16:21 +0100 | [diff] [blame] | 104 | |
Nguyen Anh Quynh | dba00f8 | 2014-01-17 14:20:54 +0800 | [diff] [blame] | 105 | $ ./make.sh gcc |
Oliver Pinter | 6e2c075 | 2014-01-16 12:16:21 +0100 | [diff] [blame] | 106 | |
Nguyen Anh Quynh | 26ee41a | 2013-11-27 12:11:31 +0800 | [diff] [blame] | 107 | |
| 108 | |
Nguyen Anh Quynh | a6a1153 | 2013-12-24 17:03:45 +0800 | [diff] [blame] | 109 | (6) Language bindings |
| 110 | |
Nguyen Anh Quynh | 9919e3b | 2014-01-22 10:17:17 +0800 | [diff] [blame] | 111 | So far, Python, Ocaml & Java are supported by bindings in the main code. |
| 112 | Look for the bindings under directory bindings/, and refer to README file |
| 113 | of corresponding languages. |
| 114 | |
| 115 | Community also provide bindings for C#, Go, Ruby & Vala. Links to these can |
| 116 | be found at address http://capstone-engine.org/download.html |