Fast and lightweight x86/x86-64 disassembler and code generation library.
Features
- Supports all x86 and x86-64 (AMD64) instructions and extensions
- Optimized for high performance
- No dynamic memory allocation ("malloc")
- Thread-safe by design
- Very small file-size overhead compared to other common disassembler libraries
- Complete doxygen documentation
- Absolutely no third party dependencies — not even libc
- Should compile on any platform with a working C11 compiler
- Tested on Windows, macOS, FreeBSD, Linux and UEFI, both user and kernel mode
Examples
Disassembler
The following example program uses Zydis to disassemble a given memory buffer and prints the output to the console.
The above example program generates the following output:
Encoder
The above example program generates the following output:
More Examples
More examples can be found in the examples directory of this repository.
Build
Unix
Zydis builds cleanly on most platforms without any external dependencies. You can use CMake to generate project files for your favorite C11 compiler.
Windows
Either use the Visual Studio 2019 project or build Zydis using CMake (video guide).
Building Zydis - Using vcpkg
You can download and install Zydis using the vcpkg dependency manager:
The Zydis port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.
Using Zydis in a CMake project
An example on how to use Zydis in your own CMake based project can be found in this repo.
ZydisInfo tool
Bindings
Official bindings exist for a selection of languages:
Unofficial but actively maintained bindings:
asmjit-style C++ front-end
If you're looking for an asmjit-style assembler front-end for the encoder, check out zasm!
Versions
Scheme
Versions follow the semantic versioning scheme. All stability guarantees apply to the API only — ABI stability between patches cannot be assumed unless explicitly mentioned in the release notes.
Branches & Tags
masterholds the bleeding edge code of the next, unreleased Zydis version. Elevated amounts of bugs and issues must be expected, API stability is not guaranteed outside of tagged commits.- Stable and preview versions are annotated with git tags
- beta and other preview versions have
-beta,-rc, etc. suffixes
- beta and other preview versions have
maintenance/v2contains the code of the latest legacy release of v2- v2 is now deprecated, but will receive security fixes until 2021
Credits
- Intel (for open-sourcing XED, allowing for automatic comparison of our tables against theirs, improving both)
- LLVM (for providing pretty solid instruction data as well)
- Christian Ludloff (http://sandpile.org, insanely helpful)
- LekoArts (for creating the project logo)
- Our contributors on GitHub
Troubleshooting
-fPIC for shared library builds
Under some circumstances (e.g. when building Zydis as a static library using CMake and then using Makefiles to manually link it into a shared library), CMake might fail to detect that relocation information must be emitted. This can be forced by passing -DCMAKE_POSITION_INDEPENDENT_CODE=ON to the CMake invocation.
Consulting and Business Support
We offer consulting services and professional business support for Zydis. If you need a custom extension, require help in integrating Zydis into your product or simply want contractually guaranteed updates and turnaround times, we are happy to assist with that! Please contact us at business@zyantific.com.
Donations
Since GitHub Sponsors currently doesn't support sponsoring teams directly, donations are collected and distributed using flobernds account.
License
Zydis is licensed under the MIT license.
