blob: 18b67deb2e4f3de457569513824539ef6e4ee16d [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 Quynh59bc84d2015-02-03 16:28:27 +08004Version 3.0.1: February 03, 2015
5
6[ X86 ]
7
8- Properly handle LOCK, REP, REPE & REPNE prefixes.
9- Handle undocumented immediates for SSE's (V)CMPPS/PD/SS/SD instructions.
10- Print LJUMP/LCALL without * as prefix for Intel syntax.
11- Handle REX prefix properly for segment/MMX related instructions (x86_64).
12- Instruction with length > 15 is consider invalid.
13- Handle some tricky encodings for instructions MOVSXD, FXCH, FCOM, FCOMP,
14 FSTP, FSTPNCE, NOP.
15- Handle some tricky code for some X86_64 instructions with REX prefix.
16- Add missing operands in detail mode for PUSH , POP , IN/OUT reg, reg
17- MOV32ms & MOV32sm should reference word rather than dword.
18
19
20[ Arm64 ]
21
22- BL & BLR instructions do not read SP register.
23- Print absolute (rather than relative) address for instructions B, BL,
24 CBNZ, ADR.
25
26
27[ Arm ]
28
29- Instructions ADC & SBC do not update flags.
30- BL & BLX do not read SP, but PC register.
31- Alias LDR instruction with operands [sp], 4 to POP.
32- Print immediate operand of MVN instruction in positive hexadecimal form.
33
34
35[ PowerPC ]
36
37- Fix some compilation bugs when DIET mode is enable.
38- Populate SLWI/SRWI instruction details with SH operand.
39
40
41[ Python binding ]
42
43- Fix a Cython bug when CsInsn.bytes returns a shorten array of bytes.
44- Fixed a memory leak for Cython disasm functions when we immaturely quit
45 the enumeration of disassembled instructions.
46- Fix a NULL memory access issue when SKIPDATA & Detail modes are enable
47 at the same time.
48- Fix a memory leaking bug when when we stop enumeration over the disassembled
49 instructions prematurely.
50- Export generic operand types & groups (CS_OP_xxx & CS_GRP_xxx).
51
52---------------------------------
Nguyen Anh Quynhb53a59a2014-11-19 17:56:04 +080053Version 3.0: November 19th, 2014
Nguyen Anh Quynhfadbddc2014-11-18 22:53:32 +080054
55[ API ]
56
57- New API: cs_disasm_iter & cs_malloc. See docs/README for tutorials.
58- Renamed cs_disasm_ex to cs_disasm (cs_disasm_ex is still supported, but
59 marked obsolete to be removed in future)
60- Support SKIPDATA mode, so Capstone can jump over unknown data and keep going
61 from the next legitimate instruction. See docs/README for tutorials.
62- More details provided in cs_detail struct for all architectures.
63- API version was bumped to 3.0.
64
65
66[ Bindings ]
67
68- Python binding supports Python3 (besides Python2).
69- Support Ocaml binding.
Nguyen Anh Quynh89460292014-11-19 14:37:08 +080070- Java: add close() method to be used to deinitialize a Capstone object when
71 no longer use it.
Nguyen Anh Quynhfadbddc2014-11-18 22:53:32 +080072
73
74[ Architectures ]
75
76- New architectures: Sparc, SystemZ & XCore.
77- Important bugfixes for Arm, Arm64, Mips, PowerPC & X86.
78- Support more instructions for Arm, Arm64, Mips, PowerPC & X86.
79- Always expose absolute addresses rather than relative addresses (Arm, Arm64,
80 Mips, PPC, Sparc, X86).
81- Use common instruction operand types REG, IMM, MEM & FP across all
82 architectures (to enable cross-architecture analysis).
83- Use common instruction group types across all architectures (to enable
84 cross-architecture analysis).
85
86
87[ X86 ]
88
89- X86 engine is mature & handles all the malware tricks (that we are aware of).
90- Added a lot of new instructions (such as AVX512, 3DNow, etc).
91- Add prefix symbols X86_PREFIX_REP/REPNE/LOCK/CS/DS/SS/FS/GS/ES/OPSIZE/ADDRSIZE.
92- Print immediate in positive form & hexadecimal for AND/OR/XOR instructions.
93- More friendly disassembly for JMP16i (in the form segment:offset)
94
95
96[ Mips ]
97
98- Engine added supports for new hardware modes: Mips32R6 (CS_MODE_MIPS32R6) &
99 MipsGP64 (CS_MODE_MIPSGP64).
100- Removed the ABI-only mode CS_MODE_N64.
101- New modes CS_MODE_MIPS32 & CS_MODE_MIPS64 (to use instead of CS_MODE_32 &
102 CS_MODE_64).
103
104
105[ ARM ]
106
107- Support new mode CS_MODE_V8 for Armv8 A32 encodings.
108- Print immediate in positive form & hexadecimal for AND/ORR/EOR/BIC instructions
109
110
111[ ARM64 ]
112
113- Print immediate in hexadecimal for AND/ORR/EOR/TST instructions.
114
115
116[ PowerPC ]
117
118- Do not print a dot in front of absolute address.
119
120
121[ Other features ]
122
123- Support for Microsoft Visual Studio (so enable Windows native compilation).
124- Support CMake compilation.
125- Cross-compile for Android.
126- Build libraries/tests using XCode project
127- Much faster, while consuming less memory for all architectures.
128
129---------------------------------
Nguyen Anh Quynh2f43c392014-04-01 09:19:19 +0800130Version 2.1.2: April 3rd, 2014
Nguyen Anh Quynh025a3452014-03-30 22:39:22 +0800131
132This is a stable release to fix some bugs deep in the core. There is no update
133to any architectures or bindings, so bindings version 2.1 can be used with this
134version 2.1.2 just fine.
135
136[ Core changes]
137
Nguyen Anh Quynh2f43c392014-04-01 09:19:19 +0800138- Support cross-compilation for all iDevices (iPhone/iPad/iPod).
139- X86: do not print memory offset in negative form.
Nguyen Anh Quynh025a3452014-03-30 22:39:22 +0800140- Fix a bug in X86 when Capstone cannot handle short instruction.
141- Print negative number above -9 without prefix 0x (arm64, mips, arm).
142- Correct the SONAME setup for library versioning (Linux, *BSD, Solaris).
143- Set library versioning for dylib of OSX.
144
145---------------------------------
Nguyen Anh Quynh56db6392014-03-11 11:24:46 +0800146Version 2.1.1: March 13th, 2014
147
148This is a stable release to fix some bugs deep in the core. There is no update
149to any architectures or bindings, so bindings version 2.1 can be used with this
150version 2.1.1 just fine.
151
152[ Core changes]
153
154- Fix a buffer overflow bug in Thumb mode (ARM). Some special input can
155 trigger this flaw.
156- Fix a crash issue when embedding Capstone into OSX kernel. This should
Nguyen Anh Quynha96d25e2014-03-11 11:41:09 +0800157 also enable Capstone to be embedded into other systems with limited stack
Nguyen Anh Quynh56db6392014-03-11 11:24:46 +0800158 memory size such as Linux kernel or some firmwares.
159- Use a proper SONAME for library versioning (Linux).
160
161---------------------------------
Nguyen Anh Quynhf51971d2014-03-05 00:09:49 +0800162Version 2.1: March 5th, 2014
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800163
164[ API changes ]
165
166- API version has been bumped to 2.1.
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +0800167- Change prototype of cs_close() to be able to invalidate closed handle.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800168 See http://capstone-engine.org/version_2.1_API.html for more information.
169- Extend cs_support() to handle more query types, not only about supported
170 architectures. This change is backward compatible, however, so existent code
171 do not need to be modified to support this.
172- New query type CS_SUPPORT_DIET for cs_support() to ask about diet status of
173 the engine.
174- New error code CS_ERR_DIET to report errors about newly added diet mode.
175- New error code CS_ERR_VERSION to report issue of incompatible versions between
176 bindings & core engine.
177
178
179[ Core changes ]
180
181- On memory usage, Capstone uses about 40% less memory, while still faster
182 than version 2.0.
183- All architectures are much smaller: binaries size reduce at least 30%.
184 Especially, X86-only binary reduces from 1.9MB to just 720KB.
185- Support "diet" mode, in which engine size is further reduced (by around 40%)
186 for embedding purpose. The price to pay is that we have to sacrifice some
187 non-critical data fields. See http://capstone-engine.org/diet.html for more
188 details.
189
190
191[ Architectures ]
192
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +0800193- Update all 5 architectures to fix bugs.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800194- PowerPC:
195 - New instructions: FMR & MSYNC.
196- Mips:
197 - New instruction: DLSA
198- X86:
199 - Properly handle AVX-512 instructions.
200 - New instructions: PSETPM, SALC, INT1, GETSEC.
201 - Fix some memory leaking issues in case of prefixed instructions such
202 as LOCK, REP, REPNE.
203
204
205[ Python binding ]
206
207- Verify the core version at initialization time. Refuse to run if its version
208 is different from the core's version.
209- New API disasm_lite() added to Cs class. This light API only returns tuples of
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +0800210 (address, size, mnemonic, op_str), rather than list of CsInsn objects. This
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800211 improves performance by around 30% in some benchmarks.
Nguyen Anh Quynh7fc81212014-03-04 23:56:42 +0800212- New API version_bind() returns binding's version, which might differ from
Nguyen Anh Quynhb0b73082014-03-03 17:57:15 +0800213 the core's API version if the binding is out-of-date.
Nguyen Anh Quynhf51971d2014-03-05 00:09:49 +0800214- New API debug() returns information on Cython support, diet status & archs
Nguyen Anh Quynh7fc81212014-03-04 23:56:42 +0800215 compiled in.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800216- Fixed some memory leaking bugs for Cython binding.
217- Fix a bug crashing Cython code when accessing @regs_read/regs_write/groups.
Nguyen Anh Quynhe6c378e2014-03-03 17:25:53 +0800218- Support diet mode.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800219
220
221[ Java binding ]
222
223- Fix some memory leaking bugs.
Nguyen Anh Quynhe6c378e2014-03-03 17:25:53 +0800224- New API version() returns combined version.
225- Support diet mode.
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800226- Better support for detail option.
227
228
229[ Miscellaneous ]
230
Nguyen Anh Quynh6cfabcd2014-03-03 17:04:15 +0800231- make.sh now can uninstall the core engine. This is done with:
232
Nguyen Anh Quynh6e6ada22014-03-03 16:50:04 +0800233 $ sudo ./make.sh uninstall
234
235----------------------------------
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800236Version 2.0: January 22nd, 2014
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +0800237
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800238Release 2.0 deprecates verison 1.0 and brings a lot of crucial changes.
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +0800239
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800240[ API changes ]
241
242- API version has been bumped to 2.0 (see cs_version() API)
243- New API cs_strerror(errno) returns a string describing error code given
244 in its only argument.
245- cs_version() now returns combined version encoding both major & minor versions.
246- New option CS_OPT_MODE allows to change engine’s mode at run-time with
247 cs_option().
248- New option CS_OPT_MEM allows to specify user-defined functions for dynamically
249 memory management used internally by Capstone. This is useful to embed Capstone
250 into special environments such as kernel or firware.
251- New API cs_support() can be used to check if this lib supports a particular
252 architecture (this is necessary since we now allow to choose which architectures
253 to compile in).
254- The detail option is OFF by default now. To get detail information, it should be
255 explicitly turned ON. The details then can be accessed using cs_insn.detail
256 pointer (to newly added structure cs_detail)
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +0800257
258
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800259[ Core changes ]
260
261- On memory usage, Capstone uses much less memory, but a lot faster now.
262- User now can choose which architectures to be supported by modifying config.mk
263 before compiling/installing.
264
265
266[ Architectures ]
267
268- Arm
269 - Support Big-Endian mode (besides Little-Endian mode).
Nguyen Anh Quynh6c5eec52014-01-22 18:33:35 +0800270 - Support friendly register, so instead of output sub "r12,r11,0x14",
271 we have "sub ip,fp,0x14".
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800272- Arm64: support Big-Endian mode (besides Little-Endian mode).
273- PowerPC: newly added.
Nguyen Anh Quynh6c5eec52014-01-22 18:33:35 +0800274- Mips: support friendly register, so instead of output "srl $2,$1,0x1f",
275 we have "srl $v0,$at,0x1f".
Nguyen Anh Quynh1ee23262014-01-22 18:27:39 +0800276- X86: bug fixes.
277
278
279[ Python binding ]
280
281- Python binding is vastly improved in performance: around 3 ~ 4 times faster
282 than in 1.0.
283- Cython support has been added, which can further speed up over the default
284 pure Python binding (up to 30% in some cases)
285- Function cs_disasm_quick() & Cs.disasm() now use generator (rather than a list)
286 to return succesfully disassembled instructions. This improves the performance
287 and reduces memory usage.
288
289
290[ Java binding ]
291
292- Better performance & bug fixes.
293
294
295[ Miscellaneous ]
296
297- Fixed some installation issues with Gentoo Linux.
298- Capstone now can easily compile/install on all *nix, including Linux, OSX,
299 {Net, Free, Open}BSD & Solaris.
300
301----------------------------------
Nguyen Anh Quynh8282dc62014-01-15 21:20:47 +0800302[Version 1.0]: December 18th, 2013
303
304- Initial public release.
305