Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 1 | This file details the changelog of Capstone. |
| 2 | |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 3 | --------------------------------- |
Nguyen Anh Quynh | b53a59a | 2014-11-19 17:56:04 +0800 | [diff] [blame^] | 4 | Version 3.0: November 19th, 2014 |
Nguyen Anh Quynh | fadbddc | 2014-11-18 22:53:32 +0800 | [diff] [blame] | 5 | |
| 6 | [ API ] |
| 7 | |
| 8 | - New API: cs_disasm_iter & cs_malloc. See docs/README for tutorials. |
| 9 | - Renamed cs_disasm_ex to cs_disasm (cs_disasm_ex is still supported, but |
| 10 | marked obsolete to be removed in future) |
| 11 | - Support SKIPDATA mode, so Capstone can jump over unknown data and keep going |
| 12 | from the next legitimate instruction. See docs/README for tutorials. |
| 13 | - More details provided in cs_detail struct for all architectures. |
| 14 | - API version was bumped to 3.0. |
| 15 | |
| 16 | |
| 17 | [ Bindings ] |
| 18 | |
| 19 | - Python binding supports Python3 (besides Python2). |
| 20 | - Support Ocaml binding. |
Nguyen Anh Quynh | 8946029 | 2014-11-19 14:37:08 +0800 | [diff] [blame] | 21 | - Java: add close() method to be used to deinitialize a Capstone object when |
| 22 | no longer use it. |
Nguyen Anh Quynh | fadbddc | 2014-11-18 22:53:32 +0800 | [diff] [blame] | 23 | |
| 24 | |
| 25 | [ Architectures ] |
| 26 | |
| 27 | - New architectures: Sparc, SystemZ & XCore. |
| 28 | - Important bugfixes for Arm, Arm64, Mips, PowerPC & X86. |
| 29 | - Support more instructions for Arm, Arm64, Mips, PowerPC & X86. |
| 30 | - Always expose absolute addresses rather than relative addresses (Arm, Arm64, |
| 31 | Mips, PPC, Sparc, X86). |
| 32 | - Use common instruction operand types REG, IMM, MEM & FP across all |
| 33 | architectures (to enable cross-architecture analysis). |
| 34 | - Use common instruction group types across all architectures (to enable |
| 35 | cross-architecture analysis). |
| 36 | |
| 37 | |
| 38 | [ X86 ] |
| 39 | |
| 40 | - X86 engine is mature & handles all the malware tricks (that we are aware of). |
| 41 | - Added a lot of new instructions (such as AVX512, 3DNow, etc). |
| 42 | - Add prefix symbols X86_PREFIX_REP/REPNE/LOCK/CS/DS/SS/FS/GS/ES/OPSIZE/ADDRSIZE. |
| 43 | - Print immediate in positive form & hexadecimal for AND/OR/XOR instructions. |
| 44 | - More friendly disassembly for JMP16i (in the form segment:offset) |
| 45 | |
| 46 | |
| 47 | [ Mips ] |
| 48 | |
| 49 | - Engine added supports for new hardware modes: Mips32R6 (CS_MODE_MIPS32R6) & |
| 50 | MipsGP64 (CS_MODE_MIPSGP64). |
| 51 | - Removed the ABI-only mode CS_MODE_N64. |
| 52 | - New modes CS_MODE_MIPS32 & CS_MODE_MIPS64 (to use instead of CS_MODE_32 & |
| 53 | CS_MODE_64). |
| 54 | |
| 55 | |
| 56 | [ ARM ] |
| 57 | |
| 58 | - Support new mode CS_MODE_V8 for Armv8 A32 encodings. |
| 59 | - Print immediate in positive form & hexadecimal for AND/ORR/EOR/BIC instructions |
| 60 | |
| 61 | |
| 62 | [ ARM64 ] |
| 63 | |
| 64 | - Print immediate in hexadecimal for AND/ORR/EOR/TST instructions. |
| 65 | |
| 66 | |
| 67 | [ PowerPC ] |
| 68 | |
| 69 | - Do not print a dot in front of absolute address. |
| 70 | |
| 71 | |
| 72 | [ Other features ] |
| 73 | |
| 74 | - Support for Microsoft Visual Studio (so enable Windows native compilation). |
| 75 | - Support CMake compilation. |
| 76 | - Cross-compile for Android. |
| 77 | - Build libraries/tests using XCode project |
| 78 | - Much faster, while consuming less memory for all architectures. |
| 79 | |
| 80 | --------------------------------- |
Nguyen Anh Quynh | 2f43c39 | 2014-04-01 09:19:19 +0800 | [diff] [blame] | 81 | Version 2.1.2: April 3rd, 2014 |
Nguyen Anh Quynh | 025a345 | 2014-03-30 22:39:22 +0800 | [diff] [blame] | 82 | |
| 83 | This is a stable release to fix some bugs deep in the core. There is no update |
| 84 | to any architectures or bindings, so bindings version 2.1 can be used with this |
| 85 | version 2.1.2 just fine. |
| 86 | |
| 87 | [ Core changes] |
| 88 | |
Nguyen Anh Quynh | 2f43c39 | 2014-04-01 09:19:19 +0800 | [diff] [blame] | 89 | - Support cross-compilation for all iDevices (iPhone/iPad/iPod). |
| 90 | - X86: do not print memory offset in negative form. |
Nguyen Anh Quynh | 025a345 | 2014-03-30 22:39:22 +0800 | [diff] [blame] | 91 | - Fix a bug in X86 when Capstone cannot handle short instruction. |
| 92 | - Print negative number above -9 without prefix 0x (arm64, mips, arm). |
| 93 | - Correct the SONAME setup for library versioning (Linux, *BSD, Solaris). |
| 94 | - Set library versioning for dylib of OSX. |
| 95 | |
| 96 | --------------------------------- |
Nguyen Anh Quynh | 56db639 | 2014-03-11 11:24:46 +0800 | [diff] [blame] | 97 | Version 2.1.1: March 13th, 2014 |
| 98 | |
| 99 | This is a stable release to fix some bugs deep in the core. There is no update |
| 100 | to any architectures or bindings, so bindings version 2.1 can be used with this |
| 101 | version 2.1.1 just fine. |
| 102 | |
| 103 | [ Core changes] |
| 104 | |
| 105 | - Fix a buffer overflow bug in Thumb mode (ARM). Some special input can |
| 106 | trigger this flaw. |
| 107 | - Fix a crash issue when embedding Capstone into OSX kernel. This should |
Nguyen Anh Quynh | a96d25e | 2014-03-11 11:41:09 +0800 | [diff] [blame] | 108 | also enable Capstone to be embedded into other systems with limited stack |
Nguyen Anh Quynh | 56db639 | 2014-03-11 11:24:46 +0800 | [diff] [blame] | 109 | memory size such as Linux kernel or some firmwares. |
| 110 | - Use a proper SONAME for library versioning (Linux). |
| 111 | |
| 112 | --------------------------------- |
Nguyen Anh Quynh | f51971d | 2014-03-05 00:09:49 +0800 | [diff] [blame] | 113 | Version 2.1: March 5th, 2014 |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 114 | |
| 115 | [ API changes ] |
| 116 | |
| 117 | - API version has been bumped to 2.1. |
Nguyen Anh Quynh | 6cfabcd | 2014-03-03 17:04:15 +0800 | [diff] [blame] | 118 | - Change prototype of cs_close() to be able to invalidate closed handle. |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 119 | See http://capstone-engine.org/version_2.1_API.html for more information. |
| 120 | - Extend cs_support() to handle more query types, not only about supported |
| 121 | architectures. This change is backward compatible, however, so existent code |
| 122 | do not need to be modified to support this. |
| 123 | - New query type CS_SUPPORT_DIET for cs_support() to ask about diet status of |
| 124 | the engine. |
| 125 | - New error code CS_ERR_DIET to report errors about newly added diet mode. |
| 126 | - New error code CS_ERR_VERSION to report issue of incompatible versions between |
| 127 | bindings & core engine. |
| 128 | |
| 129 | |
| 130 | [ Core changes ] |
| 131 | |
| 132 | - On memory usage, Capstone uses about 40% less memory, while still faster |
| 133 | than version 2.0. |
| 134 | - All architectures are much smaller: binaries size reduce at least 30%. |
| 135 | Especially, X86-only binary reduces from 1.9MB to just 720KB. |
| 136 | - Support "diet" mode, in which engine size is further reduced (by around 40%) |
| 137 | for embedding purpose. The price to pay is that we have to sacrifice some |
| 138 | non-critical data fields. See http://capstone-engine.org/diet.html for more |
| 139 | details. |
| 140 | |
| 141 | |
| 142 | [ Architectures ] |
| 143 | |
Nguyen Anh Quynh | 6cfabcd | 2014-03-03 17:04:15 +0800 | [diff] [blame] | 144 | - Update all 5 architectures to fix bugs. |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 145 | - PowerPC: |
| 146 | - New instructions: FMR & MSYNC. |
| 147 | - Mips: |
| 148 | - New instruction: DLSA |
| 149 | - X86: |
| 150 | - Properly handle AVX-512 instructions. |
| 151 | - New instructions: PSETPM, SALC, INT1, GETSEC. |
| 152 | - Fix some memory leaking issues in case of prefixed instructions such |
| 153 | as LOCK, REP, REPNE. |
| 154 | |
| 155 | |
| 156 | [ Python binding ] |
| 157 | |
| 158 | - Verify the core version at initialization time. Refuse to run if its version |
| 159 | is different from the core's version. |
| 160 | - New API disasm_lite() added to Cs class. This light API only returns tuples of |
Nguyen Anh Quynh | 6cfabcd | 2014-03-03 17:04:15 +0800 | [diff] [blame] | 161 | (address, size, mnemonic, op_str), rather than list of CsInsn objects. This |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 162 | improves performance by around 30% in some benchmarks. |
Nguyen Anh Quynh | 7fc8121 | 2014-03-04 23:56:42 +0800 | [diff] [blame] | 163 | - New API version_bind() returns binding's version, which might differ from |
Nguyen Anh Quynh | b0b7308 | 2014-03-03 17:57:15 +0800 | [diff] [blame] | 164 | the core's API version if the binding is out-of-date. |
Nguyen Anh Quynh | f51971d | 2014-03-05 00:09:49 +0800 | [diff] [blame] | 165 | - New API debug() returns information on Cython support, diet status & archs |
Nguyen Anh Quynh | 7fc8121 | 2014-03-04 23:56:42 +0800 | [diff] [blame] | 166 | compiled in. |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 167 | - Fixed some memory leaking bugs for Cython binding. |
| 168 | - Fix a bug crashing Cython code when accessing @regs_read/regs_write/groups. |
Nguyen Anh Quynh | e6c378e | 2014-03-03 17:25:53 +0800 | [diff] [blame] | 169 | - Support diet mode. |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 170 | |
| 171 | |
| 172 | [ Java binding ] |
| 173 | |
| 174 | - Fix some memory leaking bugs. |
Nguyen Anh Quynh | e6c378e | 2014-03-03 17:25:53 +0800 | [diff] [blame] | 175 | - New API version() returns combined version. |
| 176 | - Support diet mode. |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 177 | - Better support for detail option. |
| 178 | |
| 179 | |
| 180 | [ Miscellaneous ] |
| 181 | |
Nguyen Anh Quynh | 6cfabcd | 2014-03-03 17:04:15 +0800 | [diff] [blame] | 182 | - make.sh now can uninstall the core engine. This is done with: |
| 183 | |
Nguyen Anh Quynh | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame] | 184 | $ sudo ./make.sh uninstall |
| 185 | |
| 186 | ---------------------------------- |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 187 | Version 2.0: January 22nd, 2014 |
Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 188 | |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 189 | Release 2.0 deprecates verison 1.0 and brings a lot of crucial changes. |
Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 190 | |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 191 | [ API changes ] |
| 192 | |
| 193 | - API version has been bumped to 2.0 (see cs_version() API) |
| 194 | - New API cs_strerror(errno) returns a string describing error code given |
| 195 | in its only argument. |
| 196 | - cs_version() now returns combined version encoding both major & minor versions. |
| 197 | - New option CS_OPT_MODE allows to change engine’s mode at run-time with |
| 198 | cs_option(). |
| 199 | - New option CS_OPT_MEM allows to specify user-defined functions for dynamically |
| 200 | memory management used internally by Capstone. This is useful to embed Capstone |
| 201 | into special environments such as kernel or firware. |
| 202 | - New API cs_support() can be used to check if this lib supports a particular |
| 203 | architecture (this is necessary since we now allow to choose which architectures |
| 204 | to compile in). |
| 205 | - The detail option is OFF by default now. To get detail information, it should be |
| 206 | explicitly turned ON. The details then can be accessed using cs_insn.detail |
| 207 | pointer (to newly added structure cs_detail) |
Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 208 | |
| 209 | |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 210 | [ Core changes ] |
| 211 | |
| 212 | - On memory usage, Capstone uses much less memory, but a lot faster now. |
| 213 | - User now can choose which architectures to be supported by modifying config.mk |
| 214 | before compiling/installing. |
| 215 | |
| 216 | |
| 217 | [ Architectures ] |
| 218 | |
| 219 | - Arm |
| 220 | - Support Big-Endian mode (besides Little-Endian mode). |
Nguyen Anh Quynh | 6c5eec5 | 2014-01-22 18:33:35 +0800 | [diff] [blame] | 221 | - Support friendly register, so instead of output sub "r12,r11,0x14", |
| 222 | we have "sub ip,fp,0x14". |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 223 | - Arm64: support Big-Endian mode (besides Little-Endian mode). |
| 224 | - PowerPC: newly added. |
Nguyen Anh Quynh | 6c5eec5 | 2014-01-22 18:33:35 +0800 | [diff] [blame] | 225 | - Mips: support friendly register, so instead of output "srl $2,$1,0x1f", |
| 226 | we have "srl $v0,$at,0x1f". |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 227 | - X86: bug fixes. |
| 228 | |
| 229 | |
| 230 | [ Python binding ] |
| 231 | |
| 232 | - Python binding is vastly improved in performance: around 3 ~ 4 times faster |
| 233 | than in 1.0. |
| 234 | - Cython support has been added, which can further speed up over the default |
| 235 | pure Python binding (up to 30% in some cases) |
| 236 | - Function cs_disasm_quick() & Cs.disasm() now use generator (rather than a list) |
| 237 | to return succesfully disassembled instructions. This improves the performance |
| 238 | and reduces memory usage. |
| 239 | |
| 240 | |
| 241 | [ Java binding ] |
| 242 | |
| 243 | - Better performance & bug fixes. |
| 244 | |
| 245 | |
| 246 | [ Miscellaneous ] |
| 247 | |
| 248 | - Fixed some installation issues with Gentoo Linux. |
| 249 | - Capstone now can easily compile/install on all *nix, including Linux, OSX, |
| 250 | {Net, Free, Open}BSD & Solaris. |
| 251 | |
| 252 | ---------------------------------- |
Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 253 | [Version 1.0]: December 18th, 2013 |
| 254 | |
| 255 | - Initial public release. |
| 256 | |