capstone/docs
Rot127 3a2cd3c331
Coverity defects (#2469)
* Fix CID 508418 - Uninitialized struct

* Fix CID 509089 - Fix OOB read and write

* Fix CID 509088 - OOB.

Also adds tests and to ensure no OOB access.

* Fix CID 509085 - Resource leak.

* Fix CID 508414 and companions - Using undefined values.

* Fix CID 508405 - Use of uninitialized value

* Remove unnecessary and badly implemented dev fuzz code.

* Fix CID 508396 - Uninitialzied variable.

* Fix CID 508393, 508365 -- OOB read.

* Fix CID 432207 - OVerlapping memory access.

* Remove unused functions

* Fix CID 432170 - Overlapping memory access.

* Fix CID 166022 - Check for negative index

* Let strncat not depend n src operand.

* Fix 509083 and 509084 - NULL dereference

* Remove duplicated code.

* Initialize sysop

* Fix resource leak

* Remove unreachable code.

* Remove duplicate code.

* Add assert to check return value of cmoack

* Fixed: d should be a signed value, since it is checked against < 0

* Add missing break.

* Add NULL check

* Fix signs of binary search comparisons.

* Add explicit cast of or result

* Fix correct scope of case.

* Handle invalid integer type.

* Return UINT_MAX instead of implicitly casted -1

* Remove dead code

* Fix type of im

* Fix type of d

* Remove duplicated code.

* Add returns after CS_ASSERTS

* Check for len == 0 case.

* Ensure shift operates on uint64

* Replace strcpy with strncpy.

* Handle edge cases for 32bit rotate

* Fix some out of enum warnings

* Replace a strcpy with strncpy.

* Fix increment of address

* Skip some linting

* Fix: set instruction id

* Remove unused enum

* Replace the last usages of strcpy with SStream functions.

* Increase number of allowed AArch64 operands.

* Check safety of incrementing t the next operand.

* Fix naming of operand

* Update python constants

* Fix option setup of CS_OPT_DETAIL_REAL

* Document DETAIL_REAL has to be used with CS_OPT_ON.

* Run Coverity scan every Monday.

* Remove dead code

* Fix OOB read

* Rename macro to reflect it is only used with sstreams

* Fix rebase issues
2024-09-18 21:19:42 +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 Coverity defects (#2469) 2024-09-18 21:19:42 +08:00
README Update README (#1534) 2019-08-30 23:39:52 +08:00

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