`#include <assembly.h>`

#include <assembly.h>

void Example() {
    // Generate bytes from assembly-like syntax (provided by xbyak)
    auto bytes = Assembly::Generate([](Assembly::Code& code) {
        BeginAssembly;
        code.mov(eax, 0x69);
        code.ret();
    });

    // Disassemble bytes to assembly-like syntax (provided by zydis)
    std::vector<std::string> assemblyText = Assembly::Disassemble64(bytes);
}

What?

Convenient way to generate and disassemble assembly code.

Also simply a convenient way to use xbyak and zydis.

Installation

xmake

`xmake.lua`

add_repositories("MrowrLib https://github.com/MrowrLib/Packages.git")
add_requires("assembly")

target("Example")
    add_packages("assembly")

vcpkg

`CMakeLists.txt`

add_executable(Example main.cpp)

# Find assembly and link it to your target
find_package(assembly CONFIG REQUIRED)
target_link_libraries(Example PRIVATE assembly::assembly)

`vcpkg.json`

{
    "dependencies": ["mrowr-assembly"]
}

`vcpkg-configuration.json`

{
    "default-registry": {
        "kind": "git",
        "repository": "https://github.com/microsoft/vcpkg.git",
        "baseline": "95252eadd63118201b0d0df0b4360fa613f0de84"
    },
    "registries": [
        {
            "kind": "git",
            "repository": "https://github.com/MrowrLib/Packages.git",
            "baseline": "26b274d290c6b45b05268fccf5fd3352cedb0392",
            "packages": ["mrowr-assembly"]
        }
    ]
}

Update the default-registry baseline to the latest commit from https://github.com/microsoft/vcpkg
Update the MrowrLib/Packages baseline to the latest commit from https://github.com/MrowrLib/Packages

Why?

I was frequently using xbyak and zydis in my projects, so I decided to make a very simple wrapper for them.

How?

#include <assembly.h>

void Example() {
    auto bytes = Assembly::Generate([](Assembly::Code& code) {
        BeginAssembly;
        code.mov(eax, 0x69);
        code.ret();
    });

    // ToHexString from #include <memory_util> - https://github.com/MrowrLib/memory_util.cpp
    std::cout << "Bytes: " << MemoryUtil::ToHexString(bytes) << std::endl;

    // STDOUT
    // Bytes: 0xB8 0x69 0x00 0x00 0x00 0xC3

    auto disassembled = Assembly::Disassemble86(bytes.GetBytes());

    std::cout << "Disassembled: " << std::endl;
    for (auto& instruction : disassembled) {
        std::cout << instruction << std::endl;
    }

    // STDOUT
    // Disassembled:
    // mov eax, 0x69
    // ret
}

Zydis

The disassembler is provided by zydis.

You can directly set the Zydis configuration by constructing your own Assembly::Disassembler.

// You can directly supply all Zydis configuration options via the `Disassembler` constructor or the `Disassembler::Configure` method:
auto disassembler = Assembly::Disassembler(
    ZYDIS_DISASSEMBLER_MODE_LONG_COMPAT_32, // Disassembler mode
    ZYDIS_ADDRESS_WIDTH_32, // Address width
    ZYDIS_FORMATTER_STYLE_INTEL, // Formatter style
);

// Or use helpers for configuring 32-bit and 64-bit disassemblers:
auto disassembler32 = Assembly::Disassembler::Configure32();
auto disassembler64 = Assembly::Disassembler::Configure64();

// And then disassembly using the `Disassemble` method:
std::vector<std::string> disassembled = disassembler.Disassemble({
    0xB8, 0x69, 0x00, 0x00, 0x00, 0xC3
});
// mov eax, 0x69
// ret

License

Use however, no attribution required.

BSD Zero Clause License (SPDX: 0BSD)

Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

MrowrLib/assembly.h

#include <assembly.h>