dep/zydis/README.md
<a href="https://github.com/zyantific/zydis/actions"></a> <a href="https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:zydis"></a> <a href="https://gitter.im/zyantific/zydis?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge"></a> <a href="https://discord.zyantific.com/"></a>
</p> <p align="center">Fast and lightweight x86/x86-64 disassembler and code generation library.</p>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:
007FFFFFFF400000 push rcx
007FFFFFFF400001 lea eax, [rbp-0x01]
007FFFFFFF400004 push rax
007FFFFFFF400005 push qword ptr [rbp+0x0C]
007FFFFFFF400008 push qword ptr [rbp+0x08]
007FFFFFFF40000B call [0x008000007588A5B1]
007FFFFFFF400011 test eax, eax
007FFFFFFF400013 js 0x007FFFFFFF42DB15
The above example program generates the following output:
48 C7 C0 37 13 00 00
More examples can be found in the examples directory of this repository.
Zydis builds cleanly on most platforms without any external dependencies. You can use CMake to generate project files for your favorite C11 compiler.
git clone --recursive 'https://github.com/zyantific/zydis.git'
cd zydis
mkdir build && cd build
cmake ..
make
Either use the Visual Studio 2019 project or build Zydis using CMake (video guide).
You can download and install Zydis using the vcpkg dependency manager:
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install
./vcpkg install zydis
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.
An example on how to use Zydis in your own CMake based project can be found in this repo.
Official bindings exist for a selection of languages:
Unofficial but actively maintained bindings:
If you're looking for an asmjit-style assembler front-end for the encoder, check out zasm!
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.
master holds 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.-beta, -rc, etc. suffixesmaintenance/v2 contains the code of the latest legacy release of v2
-fPIC for shared library builds/usr/bin/ld: ./libfoo.a(foo.c.o): relocation R_X86_64_PC32 against symbol `bar' can not be used when making a shared object; recompile with -fPIC
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.
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 [email protected].
Since GitHub Sponsors currently doesn't support sponsoring teams directly, donations are collected and distributed using flobernds account.
Zydis is licensed under the MIT license.