Zydis version in various package repositories
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
- Trusted by many major open-source projects
- Examples include x64dbg, Mozilla Firefox and Webkit
- 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
There are many ways to make Zydis available on your system. The following sub-sections list commonly used options.
CMake Build
Platforms: Windows, macOS, Linux, BSDs
You can use CMake to build Zydis on all supported platforms. Instructions on how to install CMake can be found here.
Visual Studio 2022 project
Platforms: Windows
We manually maintain a Visual Studio 2022 project in addition to the CMake build logic.
CMake generated VS project
Platforms: Windows
CMake can be instructed to generate a Visual Studio project for pretty much any VS version. A video guide describing how to use the CMake GUI to generate such project files is available here. Don't be confused by the apparent use of macOS in the video: Windows is simply running in a virtual machine.
Amalgamated distribution
Platforms: any platform with a working C11 compiler
We provide an auto-generated single header & single source file variant of Zydis. To use this variant of Zydis in your project, all you need to do is to copy these two files into your project. The amalgamated builds can be found on our release page as zydis-amalgamated.tar.gz.
These files are generated with the amalgamate.py script.
Package managers
Platforms: Windows, macOS, Linux, FreeBSD
Pre-built headers, shared libraries and executables are available through a variety of package managers.
<details>
</details>
| Repository | Install command |
|---|---|
| Arch Linux | pacman -S zydis |
| Debian | apt-get install libzydis-dev zydis-tools |
| Homebrew | brew install zydis |
| NixOS | nix-shell -p zydis |
| Ubuntu | apt-get install libzydis-dev zydis-tools |
| vcpkg | vcpkg install zydis |
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
The ZydisInfo command-line tool can be used to inspect essentially all information that Zydis provides about an instruction.
Bindings
Official bindings exist for a selection of languages:
asmjit-style C++ front-end
If you're looking for an asmjit-style assembler front-end for the encoder, check out zasm. zasm also provides an idiomatic C++ wrapper around the decoder and formatter interface.
Versions
Scheme
Versions follow the semantic versioning scheme. All stability guarantees apply to the API only. ABI stability is provided only between patch versions.
Branches & Tags
masterholds the bleeding edge code of the next, unreleased Zydis version. Increased amounts of bugs and issues must be expected and 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/v4points to the code of the latest release of v4- v4 is the latest stable major version and receives feature updates
maintenance/v3points to the code of the latest release of v3- v3 won't get any feature updates but will receive security updates until 2025
maintenance/v2points to the code of the last legacy release of v2- v2 is has reached end-of-life and won't receive any security updates
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 (https://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
Donations are collected and distributed using flobernd's account.
License
Zydis is licensed under the MIT license.
