capstone

mirror of https://github.com/capstone-engine/capstone.git synced 2024-12-04 03:32:05 +00:00

History

billow 21f7bc85f9 Xtensa Support (#2380 ) * Fix leaks * Remove unnecessary new lines * Add checks for actual buffer length before attempting reading it. * Xtensa: add xtensa support * Xtensa fixes - fix MCExpr - fix Xtensa_add_cs_detail - add `add_cs_detail` - add `MCExpr MCOperand_getExpr(const MCOperand MC)` `void printExpr(const MCExpr E, SStream O)` autosync fix - fix StreamOperation.py - replace `report_fatal_error` with `CS_ASSERT` - fix patch StreamOperation.py - replace `assert` with `CS_ASSERT` - fix AddCSDetail.py - fix QualifiedIdentifier * Xtensa fix * Xtensa fix .py * add Xtensa to the fuzzer * Xtensa `LITBASE`: add a basic implementation * Xtensa `LITBASE`: add a integration test * Xtensa: fix cs_v6_release_guide.md * Xtensa: fix `XTENSA_OP_GROUP_MEMOPERAND` * Xtensa: fix * Xtensa: fix Targets.py * Use isUint and isInt all over Xtensa * Add documentation about LITBASE functionality * Fix typo * Replace hard with Capstone assert * Xtensa: fix arch_config.json * Xtensa: fix --------- Co-authored-by: Rot127 <unisono@quyllur.org>		2024-09-30 11:35:51 +08:00
..
ARCHITECTURE.md	Architecture updater (auto-sync) - Updating PPC (#2013 )	2023-09-05 12:24:59 +08:00
BHUSA2014-capstone.pdf	move slides to docs/	2014-08-15 14:08:20 +08:00
capstone-logo.png	add docs/capstone-logo.png	2018-12-31 16:29:00 +08:00
cs_v6_release_guide.md	Xtensa Support (#2380 )	2024-09-30 11:35:51 +08:00
README	Update README (#1534 )	2019-08-30 23:39:52 +08:00

README

Documentation of Capstone disassembly framework.

* Switching to 2.1 engine.

	http://capstone-engine.org/version_2.1_API.html

* How to compile & install Capstone.

	http://capstone-engine.org/documentation.html

* Programming with C language.

	http://capstone-engine.org/lang_c.html

* Programming with Python language.

	http://capstone-engine.org/lang_python.html

* Programming with Java language.

	http://capstone-engine.org/lang_java.html

* Customize instruction mnemonics at run-time.

	http://capstone-engine.org/mnemonic.html

* Retrieve access information of instruction operands.

	http://capstone-engine.org/op_access.html

* Build compact engine with only selected architectures.

	http://capstone-engine.org/compile.html

* Build "diet" engine for even smaller libraries.

	http://capstone-engine.org/diet.html

* Build embedded engine for firmware/OS kernel.

	http://capstone-engine.org/embed.html

* SKIPDATA mode to keep disassembling after hitting a broken instruction.

	http://capstone-engine.org/skipdata.html

* Quickly iterate instructions with cs_disasm_iter().

	http://capstone-engine.org/iteration.html

* Build X86-reduce engine for firmware/OS kernel.

	http://capstone-engine.org/x86reduce.html

* Sample applications on how to embed Capstone into Windows kernel driver.

	https://github.com/aquynh/capstone/tree/master/contrib/cs_driver (in C, basic)
	https://github.com/aquynh/KernelProject (in C++)

* Sample application on how to embed Capstone into Mac OSX Kext (kernel).

	https://github.com/aquynh/CapstoneTest
	
* A Micro Capstone-Engine API Documentation in Chinese

        https://github.com/kabeor/Micro-Capstone-Engine-API-Documentation/blob/master/Micro%20Capstone-Engine%20API%20Documentation.md