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 | 6e6ada2 | 2014-03-03 16:50:04 +0800 | [diff] [blame^] | 4 | Version 2.1 |
| 5 | |
| 6 | [ API changes ] |
| 7 | |
| 8 | - API version has been bumped to 2.1. |
| 9 | - Change prototype of the API cs_close() to be able to invalidate closed handle. |
| 10 | See http://capstone-engine.org/version_2.1_API.html for more information. |
| 11 | - Extend cs_support() to handle more query types, not only about supported |
| 12 | architectures. This change is backward compatible, however, so existent code |
| 13 | do not need to be modified to support this. |
| 14 | - New query type CS_SUPPORT_DIET for cs_support() to ask about diet status of |
| 15 | the engine. |
| 16 | - New error code CS_ERR_DIET to report errors about newly added diet mode. |
| 17 | - New error code CS_ERR_VERSION to report issue of incompatible versions between |
| 18 | bindings & core engine. |
| 19 | |
| 20 | |
| 21 | [ Core changes ] |
| 22 | |
| 23 | - On memory usage, Capstone uses about 40% less memory, while still faster |
| 24 | than version 2.0. |
| 25 | - All architectures are much smaller: binaries size reduce at least 30%. |
| 26 | Especially, X86-only binary reduces from 1.9MB to just 720KB. |
| 27 | - Support "diet" mode, in which engine size is further reduced (by around 40%) |
| 28 | for embedding purpose. The price to pay is that we have to sacrifice some |
| 29 | non-critical data fields. See http://capstone-engine.org/diet.html for more |
| 30 | details. |
| 31 | |
| 32 | |
| 33 | [ Architectures ] |
| 34 | |
| 35 | - Update all 5 architectures to support more instructions & bug fixes. |
| 36 | - |
| 37 | - Arm |
| 38 | - Support Big-Endian mode (besides Little-Endian mode). |
| 39 | - Support friendly register, so instead of output sub "r12,r11,0x14", |
| 40 | we have "sub ip,fp,0x14". |
| 41 | - Arm64: support Big-Endian mode (besides Little-Endian mode). |
| 42 | - PowerPC: |
| 43 | - New instructions: FMR & MSYNC. |
| 44 | - Mips: |
| 45 | - New instruction: DLSA |
| 46 | - X86: |
| 47 | - Properly handle AVX-512 instructions. |
| 48 | - New instructions: PSETPM, SALC, INT1, GETSEC. |
| 49 | - Fix some memory leaking issues in case of prefixed instructions such |
| 50 | as LOCK, REP, REPNE. |
| 51 | |
| 52 | |
| 53 | [ Python binding ] |
| 54 | |
| 55 | - Verify the core version at initialization time. Refuse to run if its version |
| 56 | is different from the core's version. |
| 57 | - New API disasm_lite() added to Cs class. This light API only returns tuples of |
| 58 | ((address, size, mnemonic, op_str), rather than list of CsInsn objects. This |
| 59 | improves performance by around 30% in some benchmarks. |
| 60 | - Added new API cs_version_bind() returning binding's version, which might |
| 61 | differ from the core's API version if binding is out-of-date. |
| 62 | - Fixed some memory leaking bugs for Cython binding. |
| 63 | - Fix a bug crashing Cython code when accessing @regs_read/regs_write/groups. |
| 64 | |
| 65 | |
| 66 | [ Java binding ] |
| 67 | |
| 68 | - Fix some memory leaking bugs. |
| 69 | - Added version() API & support diet mode. |
| 70 | - Better support for detail option. |
| 71 | |
| 72 | |
| 73 | [ Miscellaneous ] |
| 74 | |
| 75 | - make.sh now can be used to uninstall the core engine. This is done with: |
| 76 | $ sudo ./make.sh uninstall |
| 77 | |
| 78 | ---------------------------------- |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 79 | Version 2.0: January 22nd, 2014 |
Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 80 | |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 81 | 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] | 82 | |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 83 | [ API changes ] |
| 84 | |
| 85 | - API version has been bumped to 2.0 (see cs_version() API) |
| 86 | - New API cs_strerror(errno) returns a string describing error code given |
| 87 | in its only argument. |
| 88 | - cs_version() now returns combined version encoding both major & minor versions. |
| 89 | - New option CS_OPT_MODE allows to change engine’s mode at run-time with |
| 90 | cs_option(). |
| 91 | - New option CS_OPT_MEM allows to specify user-defined functions for dynamically |
| 92 | memory management used internally by Capstone. This is useful to embed Capstone |
| 93 | into special environments such as kernel or firware. |
| 94 | - New API cs_support() can be used to check if this lib supports a particular |
| 95 | architecture (this is necessary since we now allow to choose which architectures |
| 96 | to compile in). |
| 97 | - The detail option is OFF by default now. To get detail information, it should be |
| 98 | explicitly turned ON. The details then can be accessed using cs_insn.detail |
| 99 | pointer (to newly added structure cs_detail) |
Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 100 | |
| 101 | |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 102 | [ Core changes ] |
| 103 | |
| 104 | - On memory usage, Capstone uses much less memory, but a lot faster now. |
| 105 | - User now can choose which architectures to be supported by modifying config.mk |
| 106 | before compiling/installing. |
| 107 | |
| 108 | |
| 109 | [ Architectures ] |
| 110 | |
| 111 | - Arm |
| 112 | - Support Big-Endian mode (besides Little-Endian mode). |
Nguyen Anh Quynh | 6c5eec5 | 2014-01-22 18:33:35 +0800 | [diff] [blame] | 113 | - Support friendly register, so instead of output sub "r12,r11,0x14", |
| 114 | we have "sub ip,fp,0x14". |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 115 | - Arm64: support Big-Endian mode (besides Little-Endian mode). |
| 116 | - PowerPC: newly added. |
Nguyen Anh Quynh | 6c5eec5 | 2014-01-22 18:33:35 +0800 | [diff] [blame] | 117 | - Mips: support friendly register, so instead of output "srl $2,$1,0x1f", |
| 118 | we have "srl $v0,$at,0x1f". |
Nguyen Anh Quynh | 1ee2326 | 2014-01-22 18:27:39 +0800 | [diff] [blame] | 119 | - X86: bug fixes. |
| 120 | |
| 121 | |
| 122 | [ Python binding ] |
| 123 | |
| 124 | - Python binding is vastly improved in performance: around 3 ~ 4 times faster |
| 125 | than in 1.0. |
| 126 | - Cython support has been added, which can further speed up over the default |
| 127 | pure Python binding (up to 30% in some cases) |
| 128 | - Function cs_disasm_quick() & Cs.disasm() now use generator (rather than a list) |
| 129 | to return succesfully disassembled instructions. This improves the performance |
| 130 | and reduces memory usage. |
| 131 | |
| 132 | |
| 133 | [ Java binding ] |
| 134 | |
| 135 | - Better performance & bug fixes. |
| 136 | |
| 137 | |
| 138 | [ Miscellaneous ] |
| 139 | |
| 140 | - Fixed some installation issues with Gentoo Linux. |
| 141 | - Capstone now can easily compile/install on all *nix, including Linux, OSX, |
| 142 | {Net, Free, Open}BSD & Solaris. |
| 143 | |
| 144 | ---------------------------------- |
Nguyen Anh Quynh | 8282dc6 | 2014-01-15 21:20:47 +0800 | [diff] [blame] | 145 | [Version 1.0]: December 18th, 2013 |
| 146 | |
| 147 | - Initial public release. |
| 148 | |