iced/README.md

34 lines
2.3 KiB
Markdown
Raw Normal View History

2020-12-09 20:30:51 +00:00
# Iced [![NuGet](https://img.shields.io/nuget/v/Iced.svg)](https://www.nuget.org/packages/Iced/) [![crates.io](https://img.shields.io/crates/v/iced-x86.svg)](https://crates.io/crates/iced-x86) [![pypi](https://img.shields.io/pypi/v/iced-x86.svg)](https://pypi.org/project/iced-x86/) [![npm](https://img.shields.io/npm/v/iced-x86.svg)](https://www.npmjs.com/package/iced-x86) [![GitHub builds](https://github.com/0xd4d/iced/workflows/GitHub%20CI/badge.svg)](https://github.com/0xd4d/iced/actions) [![codecov](https://codecov.io/gh/0xd4d/iced/branch/master/graph/badge.svg)](https://codecov.io/gh/0xd4d/iced)
2018-09-07 20:48:32 +00:00
2018-09-21 19:30:08 +00:00
<img align="right" width="160px" height="160px" src="logo.png">
2020-07-13 16:27:52 +00:00
Iced is a high performance and correct x86 (16/32/64-bit) instruction decoder, disassembler and assembler.
2020-02-11 16:38:21 +00:00
It can be used for static analysis of x86/x64 binaries, to rewrite code (eg. remove garbage instructions), to relocate code or as a disassembler.
2020-02-10 19:03:39 +00:00
-Supports all Intel and AMD instructions
2020-07-13 16:27:52 +00:00
-Correct: All instructions are tested and iced has been tested against other disassemblers/assemblers (xed, gas, objdump, masm, dumpbin, nasm, ndisasm) and fuzzed
2020-12-06 22:02:30 +00:00
-Supports .NET, Rust, Python, JavaScript (WebAssembly)
2020-02-11 16:38:21 +00:00
-The formatter supports masm, nasm, gas (AT&T), Intel (XED) and there are many options to customize the output
-The decoder is 4x+ faster than other similar libraries and doesn't allocate any memory
-Small decoded instructions, only 32 bytes
-High level Assembler (.NET) providing a simple and lean syntax (e.g `asm.mov(eax, edx)`))
-The encoder can be used to re-encode decoded instructions at any address
2020-10-20 09:52:56 +00:00
-API to get instruction info, eg. read/written registers, memory and rflags bits; CPUID feature flag, control flow info, etc
2020-02-10 19:03:39 +00:00
-License: MIT
2018-09-05 23:29:23 +00:00
# Examples and/or Build Instructions
2020-02-14 21:29:08 +00:00
- .NET: [README](https://github.com/0xd4d/iced/blob/master/src/csharp/Intel/README.md)
2020-02-11 16:38:21 +00:00
- Rust: [README](https://github.com/0xd4d/iced/blob/master/src/rust/iced-x86/README.md)
2020-12-06 22:02:30 +00:00
- Python: [README](https://github.com/0xd4d/iced/blob/master/src/rust/iced-x86-py/README.md)
- JavaScript + WebAssembly: [README](https://github.com/0xd4d/iced/blob/master/src/rust/iced-x86-js/README.md)
2020-02-10 19:03:39 +00:00
2018-09-07 19:33:05 +00:00
# License
2018-09-05 23:29:23 +00:00
MIT
2018-09-21 19:30:08 +00:00
2018-12-26 15:00:56 +00:00
# Icon
2018-09-21 19:30:08 +00:00
Logo `processor` by [Creative Stall](https://thenounproject.com/creativestall/) from the Noun Project