blob: 141ed91557f7171c9d881b203befe3651910c5cc [file] [log] [blame]
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +08001This file details the changelog of Capstone.
2
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +08003---------------------------------
Nguyen Anh Quynhf51971d2014-03-05 00:09:49 +08004Version 2.1: March 5th, 2014
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +08005
6[ API changes ]
7
8- API version has been bumped to 2.1.
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +08009- Change prototype of cs_close() to be able to invalidate closed handle.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +080010 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
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +080035- Update all 5 architectures to fix bugs.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +080036- PowerPC:
37 - New instructions: FMR & MSYNC.
38- Mips:
39 - New instruction: DLSA
40- X86:
41 - Properly handle AVX-512 instructions.
42 - New instructions: PSETPM, SALC, INT1, GETSEC.
43 - Fix some memory leaking issues in case of prefixed instructions such
44 as LOCK, REP, REPNE.
45
46
47[ Python binding ]
48
49- Verify the core version at initialization time. Refuse to run if its version
50 is different from the core's version.
51- New API disasm_lite() added to Cs class. This light API only returns tuples of
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +080052 (address, size, mnemonic, op_str), rather than list of CsInsn objects. This
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +080053 improves performance by around 30% in some benchmarks.
Nguyen Anh Quynh7fc81212014-03-04 23:56:42 +080054- New API version_bind() returns binding's version, which might differ from
Nguyen Anh Quynhb0b73082014-03-03 17:57:15 +080055 the core's API version if the binding is out-of-date.
Nguyen Anh Quynhf51971d2014-03-05 00:09:49 +080056- New API debug() returns information on Cython support, diet status & archs
Nguyen Anh Quynh7fc81212014-03-04 23:56:42 +080057 compiled in.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +080058- Fixed some memory leaking bugs for Cython binding.
59- Fix a bug crashing Cython code when accessing @regs_read/regs_write/groups.
Nguyen Anh Quynhe6c378e2014-03-03 17:25:53 +080060- Support diet mode.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +080061
62
63[ Java binding ]
64
65- Fix some memory leaking bugs.
Nguyen Anh Quynhe6c378e2014-03-03 17:25:53 +080066- New API version() returns combined version.
67- Support diet mode.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +080068- Better support for detail option.
69
70
71[ Miscellaneous ]
72
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +080073- make.sh now can uninstall the core engine. This is done with:
74
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +080075 $ sudo ./make.sh uninstall
76
77----------------------------------
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +080078Version 2.0: January 22nd, 2014
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +080079
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +080080Release 2.0 deprecates verison 1.0 and brings a lot of crucial changes.
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +080081
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +080082[ API changes ]
83
84- API version has been bumped to 2.0 (see cs_version() API)
85- New API cs_strerror(errno) returns a string describing error code given
86 in its only argument.
87- cs_version() now returns combined version encoding both major & minor versions.
88- New option CS_OPT_MODE allows to change engine’s mode at run-time with
89 cs_option().
90- New option CS_OPT_MEM allows to specify user-defined functions for dynamically
91 memory management used internally by Capstone. This is useful to embed Capstone
92 into special environments such as kernel or firware.
93- New API cs_support() can be used to check if this lib supports a particular
94 architecture (this is necessary since we now allow to choose which architectures
95 to compile in).
96- The detail option is OFF by default now. To get detail information, it should be
97 explicitly turned ON. The details then can be accessed using cs_insn.detail
98 pointer (to newly added structure cs_detail)
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +080099
100
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800101[ Core changes ]
102
103- On memory usage, Capstone uses much less memory, but a lot faster now.
104- User now can choose which architectures to be supported by modifying config.mk
105 before compiling/installing.
106
107
108[ Architectures ]
109
110- Arm
111 - Support Big-Endian mode (besides Little-Endian mode).
Nguyen Anh Quynh6c5eec52014-01-22 18:33:35 +0800112 - Support friendly register, so instead of output sub "r12,r11,0x14",
113 we have "sub ip,fp,0x14".
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800114- Arm64: support Big-Endian mode (besides Little-Endian mode).
115- PowerPC: newly added.
Nguyen Anh Quynh6c5eec52014-01-22 18:33:35 +0800116- Mips: support friendly register, so instead of output "srl $2,$1,0x1f",
117 we have "srl $v0,$at,0x1f".
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800118- X86: bug fixes.
119
120
121[ Python binding ]
122
123- Python binding is vastly improved in performance: around 3 ~ 4 times faster
124 than in 1.0.
125- Cython support has been added, which can further speed up over the default
126 pure Python binding (up to 30% in some cases)
127- Function cs_disasm_quick() & Cs.disasm() now use generator (rather than a list)
128 to return succesfully disassembled instructions. This improves the performance
129 and reduces memory usage.
130
131
132[ Java binding ]
133
134- Better performance & bug fixes.
135
136
137[ Miscellaneous ]
138
139- Fixed some installation issues with Gentoo Linux.
140- Capstone now can easily compile/install on all *nix, including Linux, OSX,
141 {Net, Free, Open}BSD & Solaris.
142
143----------------------------------
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +0800144[Version 1.0]: December 18th, 2013
145
146- Initial public release.
147