diff options
| author | Gabriel Schneider <[email protected]> | 2026-02-06 14:51:17 -0300 |
|---|---|---|
| committer | Gabriel Schneider <[email protected]> | 2026-02-06 14:51:17 -0300 |
| commit | 632a8daeb6377bdfde47cf83dcffd116d88e999a (patch) | |
| tree | 566f0da3f5495c95611bf18bdccee695e602e082 | |
| parent | 19101e2358f00cc8c4bebb320181e05f96080564 (diff) | |
| download | codenomicon-632a8daeb6377bdfde47cf83dcffd116d88e999a.tar.gz codenomicon-632a8daeb6377bdfde47cf83dcffd116d88e999a.zip | |
updated to zig 0.16.0 and fixed memory leaks
| -rw-r--r-- | build.zig | 143 | ||||
| -rw-r--r-- | build.zig.zon | 5 | ||||
| -rw-r--r-- | deps/tmp/capstone-6.0.0-Alpha4/include/capstone/capstone.h | 964 | ||||
| -rw-r--r-- | src/elfo-pretty.zig | 164 | ||||
| -rw-r--r-- | src/gloves.zig | 93 |
5 files changed, 246 insertions, 1123 deletions
@@ -1,46 +1,9 @@ const std = @import("std"); -fn capstone(b: *std.Build, options: struct { - target: std.Build.ResolvedTarget, - optimize: std.builtin.OptimizeMode, -}) struct { - dep: *std.Build.Dependency, - artifact: *std.Build.Step.Compile, - mod: *std.Build.Module, -} { - const capstone_dep = b.dependency("capstone", .{ - .target = options.target, - .optimize = options.optimize, - }); - - const compiled_capstone = capstone_dep.artifact("capstone"); - - // I don't really know what I'm doing here, but it works - const capstone_c = b.addTranslateC(.{ - .root_source_file = b.path("deps/tmp/capstone-6.0.0-Alpha4/include/capstone/capstone.h"), - // .root_source_file = capstone_dep.path("capstone.h"), - .target = options.target, - .optimize = options.optimize, - .link_libc = true, - }); - - const capstone_c_mod = capstone_c.createModule(); - return .{ - .dep = capstone_dep, - .artifact = compiled_capstone, - .mod = capstone_c_mod, - }; -} - pub fn build(b: *std.Build) !void { const target = b.standardTargetOptions(.{}); const optimize = b.standardOptimizeOption(.{}); - const elfo_module = b.createModule(.{ - .root_source_file = b.path("src/elfo-pretty.zig"), - .target = target, - .optimize = optimize, - }); const gloves_module = b.createModule(.{ .root_source_file = b.path("src/gloves.zig"), .target = target, @@ -48,26 +11,81 @@ pub fn build(b: *std.Build) !void { .link_libc = true, }); - const cs = capstone(b, .{ + const capstone_dep = b.dependency("capstone", .{}); + const translate_c = b.addTranslateC(.{ + .root_source_file = capstone_dep.path("include/capstone/capstone.h"), .target = target, .optimize = optimize, + .link_libc = true, }); - elfo_module.addImport("capstone", cs.mod); - elfo_module.addLibraryPath(cs.artifact.getEmittedBin().dirname()); - elfo_module.linkLibrary(cs.artifact); - elfo_module.addIncludePath(cs.artifact.getEmittedIncludeTree()); + + // translate + + const c_mod = translate_c.createModule(); + + const capstone_lib = b.addLibrary(.{ + .name = "capstone", + .linkage = .static, + .root_module = c_mod, + }); + + capstone_lib.root_module.addIncludePath(capstone_dep.path("include")); + capstone_lib.root_module.addIncludePath(capstone_dep.path("include/capstone")); + capstone_lib.root_module.addIncludePath(capstone_dep.path("include/capstone/X86")); + + capstone_lib.installHeadersDirectory(capstone_dep.path("include/capstone"), "capstone", .{}); + capstone_lib.installHeader(capstone_dep.path("include/platform.h"), "capstone/platform.h"); + + if (optimize == .Debug) capstone_lib.root_module.addCMacro("CAPSTONE_DEBUG", ""); + capstone_lib.root_module.addCMacro("CAPSTONE_HAS_X86", ""); + capstone_lib.root_module.addCMacro("CAPSTONE_BUILD_CSTOOL", "OFF"); + capstone_lib.root_module.addCMacro("CAPSTONE_USE_SYS_DYN_MEM", "OFF"); + + capstone_lib.root_module.addCSourceFiles(.{ .root = capstone_dep.path(""), .files = common_sources }); + // capstone_lib.root_module.addCSourceFiles(.{ + // .root = capstone_dep.path("arch/AArch64"), + // .files = &.{ + // "AArch64BaseInfo.c", + // "AArch64Disassembler.c", + // "AArch64DisassemblerExtension.c", + // "AArch64InstPrinter.c", + // "AArch64Mapping.c", + // "AArch64Module.c", + // }, + // }); + capstone_lib.root_module.addCSourceFiles(.{ + .root = capstone_dep.path("arch/X86"), + .files = &.{ + "X86Disassembler.c", + "X86DisassemblerDecoder.c", + "X86IntelInstPrinter.c", + "X86ATTInstPrinter.c", + "X86InstPrinterCommon.c", + "X86Mapping.c", + "X86Module.c", + }, + }); + + b.installArtifact(capstone_lib); const elfo = b.addExecutable(.{ .name = "elfo-pretty", - .root_module = elfo_module, + .root_module = b.createModule(.{ + .root_source_file = b.path("src/elfo-pretty.zig"), + .target = target, + .optimize = optimize, + }), }); + elfo.root_module.linkLibrary(capstone_lib); + elfo.root_module.addImport("capstone", capstone_lib.root_module); + const gloves = b.addExecutable(.{ .name = "gloves", .root_module = gloves_module, }); - elfo.linkLibrary(cs.artifact); + // elfo.linkLibrary(cs.artifact); b.installArtifact(elfo); b.installArtifact(gloves); @@ -79,5 +97,40 @@ pub fn build(b: *std.Build) !void { const run_gloves_step = b.step("gloves", "See the pretty gloves!"); run_gloves_step.dependOn(&run_gloves_cmd.step); - // TODO: add flag to run on pwndbg + // TODO: add flag to run on gdb } + +const common_sources: []const []const u8 = &.{ + "cs.c", + "Mapping.c", + "MCInst.c", + "MCInstrDesc.c", + "MCInstPrinter.c", + "MCRegisterInfo.c", + "SStream.c", + "utils.c", +}; + +// .AArch64 +// .ARC +// .ARM +// .Alpha +// .BPF +// .EVM +// .HPPA +// .LoongArch +// .M680X +// .M68K +// .MOS65XX +// .Mips +// .PowerPC +// .RISCV +// .SH +// .Sparc +// .SystemZ +// .TMS320C64x +// .TriCore +// .WASM +// .X86 +// .XCore +// .Xtensa diff --git a/build.zig.zon b/build.zig.zon index 9417355..b63f625 100644 --- a/build.zig.zon +++ b/build.zig.zon @@ -3,9 +3,8 @@ .version = "0.15.2", .dependencies = .{ .capstone = .{ - // .url = "git+https://github.com/allyourcodebase/capstone.git?ref=5.0.1#a9067fbeaf0049b812a249c237e62408c3fd3df7", - // .hash = "capstone-5.0.1-AAAAACtGAABizuVeoGO1ltcvLTL8OrYFUf_BQzUzqy15", - .path = "deps/capstone", + .url = "git+https://github.com/capstone-engine/capstone?ref=6.0.0-Alpha6#484857da5dc67f7d0e0a01c36b0ebc37a349e0fd", + .hash = "N-V-__8AAI-jMgXy8ymEREsD2WbO6CpmH9mIpULsgYu3r56r", }, }, .paths = .{""}, diff --git a/deps/tmp/capstone-6.0.0-Alpha4/include/capstone/capstone.h b/deps/tmp/capstone-6.0.0-Alpha4/include/capstone/capstone.h deleted file mode 100644 index 2d6436e..0000000 --- a/deps/tmp/capstone-6.0.0-Alpha4/include/capstone/capstone.h +++ /dev/null @@ -1,964 +0,0 @@ -#ifndef CAPSTONE_ENGINE_H -#define CAPSTONE_ENGINE_H - -/* Capstone Disassembly Engine */ -/* By Nguyen Anh Quynh <[email protected]>, 2013-2016 */ - -#ifdef __cplusplus -extern "C" { -#endif - -#include <stdarg.h> - -#if defined(CAPSTONE_HAS_OSXKERNEL) -#include <libkern/libkern.h> -#else -#include <stdlib.h> -#include <stdio.h> -#endif - -#include "cs_operand.h" -#include "platform.h" - -#ifdef _MSC_VER -#pragma warning(disable:4201) -#pragma warning(disable:4100) -#define CAPSTONE_API __cdecl -#ifdef CAPSTONE_SHARED -#define CAPSTONE_EXPORT __declspec(dllexport) -#else // defined(CAPSTONE_STATIC) -#define CAPSTONE_EXPORT -#endif -#else -#define CAPSTONE_API -#if (defined(__GNUC__) || defined(__IBMC__)) && !defined(CAPSTONE_STATIC) -#define CAPSTONE_EXPORT __attribute__((visibility("default"))) -#else // defined(CAPSTONE_STATIC) -#define CAPSTONE_EXPORT -#endif -#endif - -#if (defined(__GNUC__) || defined(__IBMC__)) -#define CAPSTONE_DEPRECATED __attribute__((deprecated)) -#elif defined(_MSC_VER) -#define CAPSTONE_DEPRECATED __declspec(deprecated) -#else -#pragma message("WARNING: You need to implement CAPSTONE_DEPRECATED for this compiler") -#define CAPSTONE_DEPRECATED -#endif - -// Capstone API version -#define CS_API_MAJOR 6 -#define CS_API_MINOR 0 - -// Version for bleeding edge code of the Github's "next" branch. -// Use this if you want the absolutely latest development code. -// This version number will be bumped up whenever we have a new major change. -#define CS_NEXT_VERSION 7 - -// Capstone package version -#define CS_VERSION_MAJOR CS_API_MAJOR -#define CS_VERSION_MINOR CS_API_MINOR -#define CS_VERSION_EXTRA 0 - -/// Macro to create combined version which can be compared to -/// result of cs_version() API. -#define CS_MAKE_VERSION(major, minor) ((major << 8) + minor) - -/// Maximum size of an instruction mnemonic string. -#define CS_MNEMONIC_SIZE 32 - -// Handle using with all API -typedef size_t csh; - -/// Architecture type -typedef enum cs_arch { - CS_ARCH_ARM = 0, ///< ARM architecture (including Thumb, Thumb-2) -#ifdef CAPSTONE_AARCH64_COMPAT_HEADER - CS_ARCH_ARM64 = 1, ///< ARM64 -#else - CS_ARCH_AARCH64 = 1, ///< AArch64 -#endif -#ifdef CAPSTONE_SYSTEMZ_COMPAT_HEADER - CS_ARCH_SYSZ = 2, ///< SystemZ architecture -#else - CS_ARCH_SYSTEMZ = 2, ///< SystemZ architecture -#endif - CS_ARCH_MIPS, ///< Mips architecture - CS_ARCH_X86, ///< X86 architecture (including x86 & x86-64) - CS_ARCH_PPC, ///< PowerPC architecture - CS_ARCH_SPARC, ///< Sparc architecture - CS_ARCH_XCORE, ///< XCore architecture - CS_ARCH_M68K, ///< 68K architecture - CS_ARCH_TMS320C64X, ///< TMS320C64x architecture - CS_ARCH_M680X, ///< 680X architecture - CS_ARCH_EVM, ///< Ethereum architecture - CS_ARCH_MOS65XX, ///< MOS65XX architecture (including MOS6502) - CS_ARCH_WASM, ///< WebAssembly architecture - CS_ARCH_BPF, ///< Berkeley Packet Filter architecture (including eBPF) - CS_ARCH_RISCV, ///< RISCV architecture - CS_ARCH_SH, ///< SH architecture - CS_ARCH_TRICORE, ///< TriCore architecture - CS_ARCH_ALPHA, ///< Alpha architecture - CS_ARCH_HPPA, ///< HPPA architecture - CS_ARCH_LOONGARCH, ///< LoongArch architecture - CS_ARCH_XTENSA, ///< Xtensa architecture - CS_ARCH_ARC, ///< ARC architecture - CS_ARCH_MAX, - CS_ARCH_ALL = 0xFFFF, // All architectures - for cs_support() -} cs_arch; - -// Support value to verify diet mode of the engine. -// If cs_support(CS_SUPPORT_DIET) return True, the engine was compiled -// in diet mode. -#define CS_SUPPORT_DIET (CS_ARCH_ALL + 1) - -// Support value to verify X86 reduce mode of the engine. -// If cs_support(CS_SUPPORT_X86_REDUCE) return True, the engine was compiled -// in X86 reduce mode. -#define CS_SUPPORT_X86_REDUCE (CS_ARCH_ALL + 2) - -/// Mode type -typedef enum cs_mode { - CS_MODE_LITTLE_ENDIAN = 0, ///< little-endian mode (default mode) - CS_MODE_ARM = 0, ///< 32-bit ARM - CS_MODE_16 = 1 << 1, ///< 16-bit mode (X86) - CS_MODE_32 = 1 << 2, ///< 32-bit mode (X86) - CS_MODE_64 = 1 << 3, ///< 64-bit mode (X86, PPC) - CS_MODE_THUMB = 1 << 4, ///< ARM's Thumb mode, including Thumb-2 - CS_MODE_MCLASS = 1 << 5, ///< ARM's Cortex-M series - CS_MODE_V8 = 1 << 6, ///< ARMv8 A32 encodings for ARM - CS_MODE_V9 = 1 << 4, ///< SparcV9 mode (Sparc) - CS_MODE_QPX = 1 << 4, ///< Quad Processing eXtensions mode (PPC) - CS_MODE_SPE = 1 << 5, ///< Signal Processing Engine mode (PPC) - CS_MODE_BOOKE = 1 << 6, ///< Book-E mode (PPC) - CS_MODE_PS = 1 << 7, ///< Paired-singles mode (PPC) - CS_MODE_AIX_OS = 1 << 8, ///< PowerPC AIX-OS - CS_MODE_PWR7 = 1 << 9, ///< Power 7 - CS_MODE_PWR8 = 1 << 10, ///< Power 8 - CS_MODE_PWR9 = 1 << 11, ///< Power 9 - CS_MODE_PWR10 = 1 << 12, ///< Power 10 - CS_MODE_PPC_ISA_FUTURE = 1 << 13, ///< Power ISA Future - CS_MODE_MODERN_AIX_AS = 1 << 14, ///< PowerPC AIX-OS with modern assembly - CS_MODE_MSYNC = 1 << 15, ///< PowerPC Has only the msync instruction instead of sync. Implies BOOKE - CS_MODE_M68K_000 = 1 << 1, ///< M68K 68000 mode - CS_MODE_M68K_010 = 1 << 2, ///< M68K 68010 mode - CS_MODE_M68K_020 = 1 << 3, ///< M68K 68020 mode - CS_MODE_M68K_030 = 1 << 4, ///< M68K 68030 mode - CS_MODE_M68K_040 = 1 << 5, ///< M68K 68040 mode - CS_MODE_M68K_060 = 1 << 6, ///< M68K 68060 mode - CS_MODE_BIG_ENDIAN = 1U << 31, ///< big-endian mode - CS_MODE_MIPS16 = CS_MODE_16, ///< Generic mips16 - CS_MODE_MIPS32 = CS_MODE_32, ///< Generic mips32 - CS_MODE_MIPS64 = CS_MODE_64, ///< Generic mips64 - CS_MODE_MICRO = 1 << 4, ///< microMips - CS_MODE_MIPS1 = 1 << 5, ///< Mips I ISA Support - CS_MODE_MIPS2 = 1 << 6, ///< Mips II ISA Support - CS_MODE_MIPS32R2 = 1 << 7, ///< Mips32r2 ISA Support - CS_MODE_MIPS32R3 = 1 << 8, ///< Mips32r3 ISA Support - CS_MODE_MIPS32R5 = 1 << 9, ///< Mips32r5 ISA Support - CS_MODE_MIPS32R6 = 1 << 10, ///< Mips32r6 ISA Support - CS_MODE_MIPS3 = 1 << 11, ///< MIPS III ISA Support - CS_MODE_MIPS4 = 1 << 12, ///< MIPS IV ISA Support - CS_MODE_MIPS5 = 1 << 13, ///< MIPS V ISA Support - CS_MODE_MIPS64R2 = 1 << 14, ///< Mips64r2 ISA Support - CS_MODE_MIPS64R3 = 1 << 15, ///< Mips64r3 ISA Support - CS_MODE_MIPS64R5 = 1 << 16, ///< Mips64r5 ISA Support - CS_MODE_MIPS64R6 = 1 << 17, ///< Mips64r6 ISA Support - CS_MODE_OCTEON = 1 << 18, ///< Octeon cnMIPS Support - CS_MODE_OCTEONP = 1 << 19, ///< Octeon+ cnMIPS Support - CS_MODE_NANOMIPS = 1 << 20, ///< Generic nanomips - CS_MODE_NMS1 = ((1 << 21) | CS_MODE_NANOMIPS), ///< nanoMips NMS1 - CS_MODE_I7200 = ((1 << 22) | CS_MODE_NANOMIPS), ///< nanoMips I7200 - CS_MODE_MIPS_NOFLOAT = 1 << 23, ///< Disable floating points ops - CS_MODE_MIPS_PTR64 = 1 << 24, ///< Mips pointers are 64-bit - CS_MODE_MICRO32R3 = (CS_MODE_MICRO | CS_MODE_MIPS32R3), ///< microMips32r3 - CS_MODE_MICRO32R6 = (CS_MODE_MICRO | CS_MODE_MIPS32R6), ///< microMips32r6 - CS_MODE_M680X_6301 = 1 << 1, ///< M680X Hitachi 6301,6303 mode - CS_MODE_M680X_6309 = 1 << 2, ///< M680X Hitachi 6309 mode - CS_MODE_M680X_6800 = 1 << 3, ///< M680X Motorola 6800,6802 mode - CS_MODE_M680X_6801 = 1 << 4, ///< M680X Motorola 6801,6803 mode - CS_MODE_M680X_6805 = 1 << 5, ///< M680X Motorola/Freescale 6805 mode - CS_MODE_M680X_6808 = 1 << 6, ///< M680X Motorola/Freescale/NXP 68HC08 mode - CS_MODE_M680X_6809 = 1 << 7, ///< M680X Motorola 6809 mode - CS_MODE_M680X_6811 = 1 << 8, ///< M680X Motorola/Freescale/NXP 68HC11 mode - CS_MODE_M680X_CPU12 = 1 << 9, ///< M680X Motorola/Freescale/NXP CPU12 - ///< used on M68HC12/HCS12 - CS_MODE_M680X_HCS08 = 1 << 10, ///< M680X Freescale/NXP HCS08 mode - CS_MODE_BPF_CLASSIC = 0, ///< Classic BPF mode (default) - CS_MODE_BPF_EXTENDED = 1 << 0, ///< Extended BPF mode - CS_MODE_RISCV32 = 1 << 0, ///< RISCV RV32G - CS_MODE_RISCV64 = 1 << 1, ///< RISCV RV64G - CS_MODE_RISCVC = 1 << 2, ///< RISCV compressed instructure mode - CS_MODE_MOS65XX_6502 = 1 << 1, ///< MOS65XXX MOS 6502 - CS_MODE_MOS65XX_65C02 = 1 << 2, ///< MOS65XXX WDC 65c02 - CS_MODE_MOS65XX_W65C02 = 1 << 3, ///< MOS65XXX WDC W65c02 - CS_MODE_MOS65XX_65816 = 1 << 4, ///< MOS65XXX WDC 65816, 8-bit m/x - CS_MODE_MOS65XX_65816_LONG_M = (1 << 5), ///< MOS65XXX WDC 65816, 16-bit m, 8-bit x - CS_MODE_MOS65XX_65816_LONG_X = (1 << 6), ///< MOS65XXX WDC 65816, 8-bit m, 16-bit x - CS_MODE_MOS65XX_65816_LONG_MX = CS_MODE_MOS65XX_65816_LONG_M | CS_MODE_MOS65XX_65816_LONG_X, - CS_MODE_SH2 = 1 << 1, ///< SH2 - CS_MODE_SH2A = 1 << 2, ///< SH2A - CS_MODE_SH3 = 1 << 3, ///< SH3 - CS_MODE_SH4 = 1 << 4, ///< SH4 - CS_MODE_SH4A = 1 << 5, ///< SH4A - CS_MODE_SHFPU = 1 << 6, ///< w/ FPU - CS_MODE_SHDSP = 1 << 7, ///< w/ DSP - CS_MODE_TRICORE_110 = 1 << 1, ///< Tricore 1.1 - CS_MODE_TRICORE_120 = 1 << 2, ///< Tricore 1.2 - CS_MODE_TRICORE_130 = 1 << 3, ///< Tricore 1.3 - CS_MODE_TRICORE_131 = 1 << 4, ///< Tricore 1.3.1 - CS_MODE_TRICORE_160 = 1 << 5, ///< Tricore 1.6 - CS_MODE_TRICORE_161 = 1 << 6, ///< Tricore 1.6.1 - CS_MODE_TRICORE_162 = 1 << 7, ///< Tricore 1.6.2 - CS_MODE_TRICORE_180 = 1 << 8, ///< Tricore 1.8.0 - CS_MODE_HPPA_11 = 1 << 1, ///< HPPA 1.1 - CS_MODE_HPPA_20 = 1 << 2, ///< HPPA 2.0 - CS_MODE_HPPA_20W = CS_MODE_HPPA_20 | (1 << 3), ///< HPPA 2.0 wide - CS_MODE_LOONGARCH32 = 1 << 0, ///< LoongArch32 - CS_MODE_LOONGARCH64 = 1 << 1, ///< LoongArch64 - CS_MODE_SYSTEMZ_ARCH8 = 1 << 1, ///< Enables features of the ARCH8 processor - CS_MODE_SYSTEMZ_ARCH9 = 1 << 2, ///< Enables features of the ARCH9 processor - CS_MODE_SYSTEMZ_ARCH10 = 1 << 3, ///< Enables features of the ARCH10 processor - CS_MODE_SYSTEMZ_ARCH11 = 1 << 4, ///< Enables features of the ARCH11 processor - CS_MODE_SYSTEMZ_ARCH12 = 1 << 5, ///< Enables features of the ARCH12 processor - CS_MODE_SYSTEMZ_ARCH13 = 1 << 6, ///< Enables features of the ARCH13 processor - CS_MODE_SYSTEMZ_ARCH14 = 1 << 7, ///< Enables features of the ARCH14 processor - CS_MODE_SYSTEMZ_Z10 = 1 << 8, ///< Enables features of the Z10 processor - CS_MODE_SYSTEMZ_Z196 = 1 << 9, ///< Enables features of the Z196 processor - CS_MODE_SYSTEMZ_ZEC12 = 1 << 10, ///< Enables features of the ZEC12 processor - CS_MODE_SYSTEMZ_Z13 = 1 << 11, ///< Enables features of the Z13 processor - CS_MODE_SYSTEMZ_Z14 = 1 << 12, ///< Enables features of the Z14 processor - CS_MODE_SYSTEMZ_Z15 = 1 << 13, ///< Enables features of the Z15 processor - CS_MODE_SYSTEMZ_Z16 = 1 << 14, ///< Enables features of the Z16 processor - CS_MODE_SYSTEMZ_GENERIC = 1 << 15, ///< Enables features of the generic processor - CS_MODE_XTENSA_ESP32 = 1 << 1, ///< Xtensa ESP32 - CS_MODE_XTENSA_ESP32S2 = 1 << 2, ///< Xtensa ESP32S2 - CS_MODE_XTENSA_ESP8266 = 1 << 3, ///< Xtensa ESP328266 -} cs_mode; - -typedef void* (CAPSTONE_API *cs_malloc_t)(size_t size); -typedef void* (CAPSTONE_API *cs_calloc_t)(size_t nmemb, size_t size); -typedef void* (CAPSTONE_API *cs_realloc_t)(void *ptr, size_t size); -typedef void (CAPSTONE_API *cs_free_t)(void *ptr); -typedef int (CAPSTONE_API *cs_vsnprintf_t)(char *str, size_t size, const char *format, va_list ap); - - -/// User-defined dynamic memory related functions: malloc/calloc/realloc/free/vsnprintf() -/// By default, Capstone uses system's malloc(), calloc(), realloc(), free() & vsnprintf(). -typedef struct cs_opt_mem { - cs_malloc_t malloc; - cs_calloc_t calloc; - cs_realloc_t realloc; - cs_free_t free; - cs_vsnprintf_t vsnprintf; -} cs_opt_mem; - -/// Customize mnemonic for instructions with alternative name. -/// To reset existing customized instruction to its default mnemonic, -/// call cs_option(CS_OPT_MNEMONIC) again with the same @id and NULL value -/// for @mnemonic. -typedef struct cs_opt_mnem { - /// ID of instruction to be customized. - unsigned int id; - /// Customized instruction mnemonic. - const char *mnemonic; -} cs_opt_mnem; - -/// Runtime option for the disassembled engine -typedef enum cs_opt_type { - CS_OPT_INVALID = 0, ///< No option specified - CS_OPT_SYNTAX, ///< Assembly output syntax - CS_OPT_DETAIL, ///< Break down instruction structure into details - CS_OPT_MODE, ///< Change engine's mode at run-time - CS_OPT_MEM, ///< User-defined dynamic memory related functions - CS_OPT_SKIPDATA, ///< Skip data when disassembling. Then engine is in SKIPDATA mode. - CS_OPT_SKIPDATA_SETUP, ///< Setup user-defined function for SKIPDATA option - CS_OPT_MNEMONIC, ///< Customize instruction mnemonic - CS_OPT_UNSIGNED, ///< print immediate operands in unsigned form - CS_OPT_ONLY_OFFSET_BRANCH, ///< ARM, PPC, AArch64: Don't add the branch immediate value to the PC. - CS_OPT_LITBASE, ///< Xtensa, set the LITBASE value. LITBASE is set to 0 by default. -} cs_opt_type; - -/// Runtime option value (associated with option type above) -typedef enum cs_opt_value { - CS_OPT_OFF = 0, ///< Turn OFF an option - default for CS_OPT_DETAIL, CS_OPT_SKIPDATA, CS_OPT_UNSIGNED. - CS_OPT_ON = 1 << 0, ///< Turn ON an option (CS_OPT_DETAIL, CS_OPT_SKIPDATA). - CS_OPT_SYNTAX_DEFAULT = 1 << 1, ///< Default asm syntax (CS_OPT_SYNTAX). - CS_OPT_SYNTAX_INTEL = 1 << 2, ///< X86 Intel asm syntax - default on X86 (CS_OPT_SYNTAX). - CS_OPT_SYNTAX_ATT = 1 << 3, ///< X86 ATT asm syntax (CS_OPT_SYNTAX). - CS_OPT_SYNTAX_NOREGNAME = 1 << 4, ///< Prints register name with only number (CS_OPT_SYNTAX) - CS_OPT_SYNTAX_MASM = 1 << 5, ///< X86 Intel Masm syntax (CS_OPT_SYNTAX). - CS_OPT_SYNTAX_MOTOROLA = 1 << 6, ///< MOS65XX use $ as hex prefix - CS_OPT_SYNTAX_CS_REG_ALIAS = 1 << 7, ///< Prints common register alias which are not defined in LLVM (ARM: r9 = sb etc.) - CS_OPT_SYNTAX_PERCENT = 1 << 8, ///< Prints the % in front of PPC registers. - CS_OPT_SYNTAX_NO_DOLLAR = 1 << 9, ///< Does not print the $ in front of Mips, LoongArch registers. - CS_OPT_DETAIL_REAL = 1 << 1, ///< If enabled, always sets the real instruction detail. Even if the instruction is an alias. -} cs_opt_value; - -/// An option -typedef struct { - cs_opt_type type; ///< The option type - cs_opt_value val; ///< The option value to set. -} cs_opt; - -/// Common instruction groups - to be consistent across all architectures. -typedef enum cs_group_type { - CS_GRP_INVALID = 0, ///< uninitialized/invalid group. - CS_GRP_JUMP, ///< all jump instructions (conditional+direct+indirect jumps) - CS_GRP_CALL, ///< all call instructions - CS_GRP_RET, ///< all return instructions - CS_GRP_INT, ///< all interrupt instructions (int+syscall) - CS_GRP_IRET, ///< all interrupt return instructions - CS_GRP_PRIVILEGE, ///< all privileged instructions - CS_GRP_BRANCH_RELATIVE, ///< all relative branching instructions -} cs_group_type; - -/** - User-defined callback function for SKIPDATA option. - See tests/test_skipdata.c for sample code demonstrating this API. - - @code: the input buffer containing code to be disassembled. - This is the same buffer passed to cs_disasm(). - @code_size: size (in bytes) of the above @code buffer. - @offset: the position of the currently-examining byte in the input - buffer @code mentioned above. - @user_data: user-data passed to cs_option() via @user_data field in - cs_opt_skipdata struct below. - - @return: return number of bytes to skip, or 0 to immediately stop disassembling. -*/ -typedef size_t (CAPSTONE_API *cs_skipdata_cb_t)(const uint8_t *code, size_t code_size, size_t offset, void *user_data); - -/// User-customized setup for SKIPDATA option -typedef struct cs_opt_skipdata { - /// Capstone considers data to skip as special "instructions". - /// User can specify the string for this instruction's "mnemonic" here. - /// By default (if @mnemonic is NULL), Capstone use ".byte". - const char *mnemonic; - - /// User-defined callback function to be called when Capstone hits data. - /// If the returned value from this callback is positive (>0), Capstone - /// will skip exactly that number of bytes & continue. Otherwise, if - /// the callback returns 0, Capstone stops disassembling and returns - /// immediately from cs_disasm() - /// NOTE: if this callback pointer is NULL, Capstone would skip a number - /// of bytes depending on architectures, as following: - /// Arm: 2 bytes (Thumb mode) or 4 bytes. - /// AArch64: 4 bytes. - /// Mips: 4 bytes. - /// M680x: 1 byte. - /// PowerPC: 4 bytes. - /// Sparc: 4 bytes. - /// SystemZ: 2 bytes. - /// X86: 1 bytes. - /// XCore: 2 bytes. - /// EVM: 1 bytes. - /// RISCV: 4 bytes. - /// WASM: 1 bytes. - /// MOS65XX: 1 bytes. - /// BPF: 8 bytes. - /// TriCore: 2 bytes. - /// LoongArch: 4 bytes. - /// ARC: 2 bytes. - cs_skipdata_cb_t callback; // default value is NULL - - /// User-defined data to be passed to @callback function pointer. - void *user_data; -} cs_opt_skipdata; - - -#include "arm.h" -#ifdef CAPSTONE_AARCH64_COMPAT_HEADER -#include "arm64.h" -#else -#include "aarch64.h" -#endif -#include "m68k.h" -#include "mips.h" -#include "ppc.h" -#include "sparc.h" -#include "systemz.h" -#include "x86.h" -#include "xcore.h" -#include "tms320c64x.h" -#include "m680x.h" -#include "evm.h" -#include "riscv.h" -#include "wasm.h" -#include "mos65xx.h" -#include "bpf.h" -#include "sh.h" -#include "tricore.h" -#include "alpha.h" -#include "hppa.h" -#include "loongarch.h" -#include "xtensa.h" -#include "arc.h" - -#define MAX_IMPL_W_REGS 47 -#define MAX_IMPL_R_REGS 20 -#define MAX_NUM_GROUPS 16 - -/// NOTE: All information in cs_detail is only available when CS_OPT_DETAIL = CS_OPT_ON -/// Initialized as memset(., 0, offsetof(cs_detail, ARCH)+sizeof(cs_ARCH)) -/// by ARCH_getInstruction in arch/ARCH/ARCHDisassembler.c -/// if cs_detail changes, in particular if a field is added after the union, -/// then update arch/ARCH/ARCHDisassembler.c accordingly -typedef struct cs_detail { - uint16_t regs_read - [MAX_IMPL_R_REGS]; ///< list of implicit registers read by this insn - uint8_t regs_read_count; ///< number of implicit registers read by this insn - - uint16_t regs_write - [MAX_IMPL_W_REGS]; ///< list of implicit registers modified by this insn - uint8_t regs_write_count; ///< number of implicit registers modified by this insn - - uint8_t groups[MAX_NUM_GROUPS]; ///< list of group this instruction belong to - uint8_t groups_count; ///< number of groups this insn belongs to - - bool writeback; ///< Instruction has writeback operands. - - /// Architecture-specific instruction info - union { - cs_x86 x86; ///< X86 architecture, including 16-bit, 32-bit & 64-bit mode -#ifdef CAPSTONE_AARCH64_COMPAT_HEADER - cs_arm64 arm64; -#else - cs_aarch64 aarch64; ///< AArch6464 architecture (aka ARM64) -#endif - -#ifdef CAPSTONE_SYSTEMZ_COMPAT_HEADER - cs_sysz sysz; ///< SystemZ architecture -#else - cs_systemz systemz; ///< SystemZ architecture (aka SysZ) -#endif - cs_arm arm; ///< ARM architecture (including Thumb/Thumb2) - cs_m68k m68k; ///< M68K architecture - cs_mips mips; ///< MIPS architecture - cs_ppc ppc; ///< PowerPC architecture - cs_sparc sparc; ///< Sparc architecture - cs_xcore xcore; ///< XCore architecture - cs_tms320c64x tms320c64x; ///< TMS320C64x architecture - cs_m680x m680x; ///< M680X architecture - cs_evm evm; ///< Ethereum architecture - cs_mos65xx mos65xx; ///< MOS65XX architecture (including MOS6502) - cs_wasm wasm; ///< Web Assembly architecture - cs_bpf bpf; ///< Berkeley Packet Filter architecture (including eBPF) - cs_riscv riscv; ///< RISCV architecture - cs_sh sh; ///< SH architecture - cs_tricore tricore; ///< TriCore architecture - cs_alpha alpha; ///< Alpha architecture - cs_hppa hppa; ///< HPPA architecture - cs_loongarch loongarch; ///< LoongArch architecture - cs_xtensa xtensa; ///< Xtensa architecture - cs_arc arc; ///< ARC architecture - }; -} cs_detail; - -/// Detail information of disassembled instruction -typedef struct cs_insn { - /// Instruction ID (basically a numeric ID for the instruction mnemonic) - /// Find the instruction id in the '[ARCH]_insn' enum in the header file - /// of corresponding architecture, such as 'arm_insn' in arm.h for ARM, - /// 'x86_insn' in x86.h for X86, etc... - /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF - /// NOTE: in Skipdata mode, "data" instruction has 0 for this id field. - unsigned int id; - - /// If this instruction is an alias instruction, this member is set with - /// the alias ID. - /// Otherwise to <ARCH>_INS_INVALID. - /// -- Only supported by auto-sync archs -- - uint64_t alias_id; - - /// Address (EIP) of this instruction - /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF - uint64_t address; - - /// Size of this instruction - /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF - uint16_t size; - - /// Machine bytes of this instruction, with number of bytes indicated by @size above - /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF - uint8_t bytes[24]; - - /// Ascii text of instruction mnemonic - /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF - char mnemonic[CS_MNEMONIC_SIZE]; - - /// Ascii text of instruction operands - /// This information is available even when CS_OPT_DETAIL = CS_OPT_OFF - char op_str[160]; - - /// True: This instruction is an alias. - /// False: Otherwise. - /// -- Only supported by auto-sync archs -- - bool is_alias; - - /// True: The operands are the ones of the alias instructions. - /// False: The detail operands are from the real instruction. - bool usesAliasDetails; - - /// Pointer to cs_detail. - /// NOTE: detail pointer is only valid when both requirements below are met: - /// (1) CS_OP_DETAIL = CS_OPT_ON - /// (2) Engine is not in Skipdata mode (CS_OP_SKIPDATA option set to CS_OPT_ON) - /// - /// NOTE 2: when in Skipdata mode, or when detail mode is OFF, even if this pointer - /// is not NULL, its content is still irrelevant. - cs_detail *detail; -} cs_insn; - - -/// Calculate the offset of a disassembled instruction in its buffer, given its position -/// in its array of disassembled insn -/// NOTE: this macro works with position (>=1), not index -#define CS_INSN_OFFSET(insns, post) (insns[post - 1].address - insns[0].address) - - -/// All type of errors encountered by Capstone API. -/// These are values returned by cs_errno() -typedef enum cs_err { - CS_ERR_OK = 0, ///< No error: everything was fine - CS_ERR_MEM, ///< Out-Of-Memory error: cs_open(), cs_disasm(), cs_disasm_iter() - CS_ERR_ARCH, ///< Unsupported architecture: cs_open() - CS_ERR_HANDLE, ///< Invalid handle: cs_op_count(), cs_op_index() - CS_ERR_CSH, ///< Invalid csh argument: cs_close(), cs_errno(), cs_option() - CS_ERR_MODE, ///< Invalid/unsupported mode: cs_open() - CS_ERR_OPTION, ///< Invalid/unsupported option: cs_option() - CS_ERR_DETAIL, ///< Information is unavailable because detail option is OFF - CS_ERR_MEMSETUP, ///< Dynamic memory management uninitialized (see CS_OPT_MEM) - CS_ERR_VERSION, ///< Unsupported version (bindings) - CS_ERR_DIET, ///< Access irrelevant data in "diet" engine - CS_ERR_SKIPDATA, ///< Access irrelevant data for "data" instruction in SKIPDATA mode - CS_ERR_X86_ATT, ///< X86 AT&T syntax is unsupported (opt-out at compile time) - CS_ERR_X86_INTEL, ///< X86 Intel syntax is unsupported (opt-out at compile time) - CS_ERR_X86_MASM, ///< X86 Masm syntax is unsupported (opt-out at compile time) -} cs_err; - -/** - Return combined API version & major and minor version numbers. - - @major: major number of API version - @minor: minor number of API version - - @return hexical number as (major << 8 | minor), which encodes both - major & minor versions. - NOTE: This returned value can be compared with version number made - with macro CS_MAKE_VERSION - - For example, second API version would return 1 in @major, and 1 in @minor - The return value would be 0x0101 - - NOTE: if you only care about returned value, but not major and minor values, - set both @major & @minor arguments to NULL. -*/ -CAPSTONE_EXPORT -unsigned int CAPSTONE_API cs_version(int *major, int *minor); - -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_arm(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_aarch64(void); -#ifdef CAPSTONE_AARCH64_COMPAT_HEADER -#define cs_arch_register_aarch64 cs_arch_register_arm64 -#endif -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_mips(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_x86(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_powerpc(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_sparc(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_systemz(void); -#ifdef CAPSTONE_SYSTEMZ_COMPAT_HEADER -#define cs_arch_register_sysz cs_arch_register_systemz -#endif -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_xcore(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_m68k(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_tms320c64x(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_m680x(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_evm(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_mos65xx(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_wasm(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_bpf(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_riscv(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_sh(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_tricore(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_alpha(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_loongarch(void); -CAPSTONE_EXPORT -void CAPSTONE_API cs_arch_register_arc(void); - -/** - This API can be used to either ask for archs supported by this library, - or check to see if the library was compile with 'diet' option (or called - in 'diet' mode). - - To check if a particular arch is supported by this library, set @query to - arch mode (CS_ARCH_* value). - To verify if this library supports all the archs, use CS_ARCH_ALL. - - To check if this library is in 'diet' mode, set @query to CS_SUPPORT_DIET. - - @return True if this library supports the given arch, or in 'diet' mode. -*/ -CAPSTONE_EXPORT -bool CAPSTONE_API cs_support(int query); - -/** - Initialize CS handle: this must be done before any usage of CS. - - @arch: architecture type (CS_ARCH_*) - @mode: hardware mode. This is combined of CS_MODE_* - @handle: pointer to handle, which will be updated at return time - - @return CS_ERR_OK on success, or other value on failure (refer to cs_err enum - for detailed error). -*/ -CAPSTONE_EXPORT -cs_err CAPSTONE_API cs_open(cs_arch arch, cs_mode mode, csh *handle); - -/** - Close CS handle: MUST do to release the handle when it is not used anymore. - NOTE: this must be only called when there is no longer usage of Capstone, - not even access to cs_insn array. The reason is the this API releases some - cached memory, thus access to any Capstone API after cs_close() might crash - your application. - - In fact,this API invalidate @handle by ZERO out its value (i.e *handle = 0). - - @handle: pointer to a handle returned by cs_open() - - @return CS_ERR_OK on success, or other value on failure (refer to cs_err enum - for detailed error). -*/ -CAPSTONE_EXPORT -cs_err CAPSTONE_API cs_close(csh *handle); - -/** - Set option for disassembling engine at runtime - - @handle: handle returned by cs_open() - @type: type of option to be set - @value: option value corresponding with @type - - @return: CS_ERR_OK on success, or other value on failure. - Refer to cs_err enum for detailed error. - - NOTE: in the case of CS_OPT_MEM, handle's value can be anything, - so that cs_option(handle, CS_OPT_MEM, value) can (i.e must) be called - even before cs_open() -*/ -CAPSTONE_EXPORT -cs_err CAPSTONE_API cs_option(csh handle, cs_opt_type type, size_t value); - -/** - Report the last error number when some API function fail. - Like glibc's errno, cs_errno might not retain its old value once accessed. - - @handle: handle returned by cs_open() - - @return: error code of cs_err enum type (CS_ERR_*, see above) -*/ -CAPSTONE_EXPORT -cs_err CAPSTONE_API cs_errno(csh handle); - - -/** - Return a string describing given error code. - - @code: error code (see CS_ERR_* above) - - @return: returns a pointer to a string that describes the error code - passed in the argument @code -*/ -CAPSTONE_EXPORT -const char * CAPSTONE_API cs_strerror(cs_err code); - -/** - Disassemble binary code, given the code buffer, size, address and number - of instructions to be decoded. - This API dynamically allocate memory to contain disassembled instruction. - Resulting instructions will be put into @*insn - - NOTE 1: this API will automatically determine memory needed to contain - output disassembled instructions in @insn. - - NOTE 2: caller must free the allocated memory itself to avoid memory leaking. - - NOTE 3: for system with scarce memory to be dynamically allocated such as - OS kernel or firmware, the API cs_disasm_iter() might be a better choice than - cs_disasm(). The reason is that with cs_disasm(), based on limited available - memory, we have to calculate in advance how many instructions to be disassembled, - which complicates things. This is especially troublesome for the case @count=0, - when cs_disasm() runs uncontrollably (until either end of input buffer, or - when it encounters an invalid instruction). - - @handle: handle returned by cs_open() - @code: buffer containing raw binary code to be disassembled. - @code_size: size of the above code buffer. - @address: address of the first instruction in given raw code buffer. - @insn: array of instructions filled in by this API. - NOTE: @insn will be allocated by this function, and should be freed - with cs_free() API. - @count: number of instructions to be disassembled, or 0 to get all of them - - @return: the number of successfully disassembled instructions, - or 0 if this function failed to disassemble the given code - - On failure, call cs_errno() for error code. -*/ -CAPSTONE_EXPORT -size_t CAPSTONE_API cs_disasm(csh handle, - const uint8_t *code, size_t code_size, - uint64_t address, - size_t count, - cs_insn **insn); - -/** - Free memory allocated by cs_malloc() or cs_disasm() (argument @insn) - - @insn: pointer returned by @insn argument in cs_disasm() or cs_malloc() - @count: number of cs_insn structures returned by cs_disasm(), or 1 - to free memory allocated by cs_malloc(). -*/ -CAPSTONE_EXPORT -void CAPSTONE_API cs_free(cs_insn *insn, size_t count); - - -/** - Allocate memory for 1 instruction to be used by cs_disasm_iter(). - - @handle: handle returned by cs_open() - - NOTE: when no longer in use, you can reclaim the memory allocated for - this instruction with cs_free(insn, 1) -*/ -CAPSTONE_EXPORT -cs_insn * CAPSTONE_API cs_malloc(csh handle); - -/** - Fast API to disassemble binary code, given the code buffer, size, address - and number of instructions to be decoded. - This API puts the resulting instruction into a given cache in @insn. - See tests/test_iter.c for sample code demonstrating this API. - - NOTE 1: this API will update @code, @size & @address to point to the next - instruction in the input buffer. Therefore, it is convenient to use - cs_disasm_iter() inside a loop to quickly iterate all the instructions. - While decoding one instruction at a time can also be achieved with - cs_disasm(count=1), some benchmarks shown that cs_disasm_iter() can be 30% - faster on random input. - - NOTE 2: the cache in @insn can be created with cs_malloc() API. - - NOTE 3: for system with scarce memory to be dynamically allocated such as - OS kernel or firmware, this API is recommended over cs_disasm(), which - allocates memory based on the number of instructions to be disassembled. - The reason is that with cs_disasm(), based on limited available memory, - we have to calculate in advance how many instructions to be disassembled, - which complicates things. This is especially troublesome for the case - @count=0, when cs_disasm() runs uncontrollably (until either end of input - buffer, or when it encounters an invalid instruction). - - @handle: handle returned by cs_open() - @code: buffer containing raw binary code to be disassembled - @size: size of above code - @address: address of the first insn in given raw code buffer - @insn: pointer to instruction to be filled in by this API. - - @return: true if this API successfully decode 1 instruction, - or false otherwise. - - On failure, call cs_errno() for error code. -*/ -CAPSTONE_EXPORT -bool CAPSTONE_API cs_disasm_iter(csh handle, - const uint8_t **code, size_t *size, - uint64_t *address, cs_insn *insn); - -/** - Return friendly name of register in a string. - Find the instruction id from header file of corresponding architecture (arm.h for ARM, - x86.h for X86, ...) - - WARN: when in 'diet' mode, this API is irrelevant because engine does not - store register name. - - @handle: handle returned by cs_open() - @reg_id: register id - - @return: string name of the register, or NULL if @reg_id is invalid. -*/ -CAPSTONE_EXPORT -const char * CAPSTONE_API cs_reg_name(csh handle, unsigned int reg_id); - -/** - Return friendly name of an instruction in a string. - Find the instruction id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) - - WARN: when in 'diet' mode, this API is irrelevant because the engine does not - store instruction name. - - @handle: handle returned by cs_open() - @insn_id: instruction id - - @return: string name of the instruction, or NULL if @insn_id is invalid. -*/ -CAPSTONE_EXPORT -const char * CAPSTONE_API cs_insn_name(csh handle, unsigned int insn_id); - -/** - Return friendly name of a group id (that an instruction can belong to) - Find the group id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) - - WARN: when in 'diet' mode, this API is irrelevant because the engine does not - store group name. - - @handle: handle returned by cs_open() - @group_id: group id - - @return: string name of the group, or NULL if @group_id is invalid. -*/ -CAPSTONE_EXPORT -const char * CAPSTONE_API cs_group_name(csh handle, unsigned int group_id); - -/** - Check if a disassembled instruction belong to a particular group. - Find the group id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) - Internally, this simply verifies if @group_id matches any member of insn->groups array. - - NOTE: this API is only valid when detail option is ON (which is OFF by default). - - WARN: when in 'diet' mode, this API is irrelevant because the engine does not - update @groups array. - - @handle: handle returned by cs_open() - @insn: disassembled instruction structure received from cs_disasm() or cs_disasm_iter() - @group_id: group that you want to check if this instruction belong to. - - @return: true if this instruction indeed belongs to the given group, or false otherwise. -*/ -CAPSTONE_EXPORT -bool CAPSTONE_API cs_insn_group(csh handle, const cs_insn *insn, unsigned int group_id); - -/** - Check if a disassembled instruction IMPLICITLY used a particular register. - Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) - Internally, this simply verifies if @reg_id matches any member of insn->regs_read array. - - NOTE: this API is only valid when detail option is ON (which is OFF by default) - - WARN: when in 'diet' mode, this API is irrelevant because the engine does not - update @regs_read array. - - @insn: disassembled instruction structure received from cs_disasm() or cs_disasm_iter() - @reg_id: register that you want to check if this instruction used it. - - @return: true if this instruction indeed implicitly used the given register, or false otherwise. -*/ -CAPSTONE_EXPORT -bool CAPSTONE_API cs_reg_read(csh handle, const cs_insn *insn, unsigned int reg_id); - -/** - Check if a disassembled instruction IMPLICITLY modified a particular register. - Find the register id from header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) - Internally, this simply verifies if @reg_id matches any member of insn->regs_write array. - - NOTE: this API is only valid when detail option is ON (which is OFF by default) - - WARN: when in 'diet' mode, this API is irrelevant because the engine does not - update @regs_write array. - - @insn: disassembled instruction structure received from cs_disasm() or cs_disasm_iter() - @reg_id: register that you want to check if this instruction modified it. - - @return: true if this instruction indeed implicitly modified the given register, or false otherwise. -*/ -CAPSTONE_EXPORT -bool CAPSTONE_API cs_reg_write(csh handle, const cs_insn *insn, unsigned int reg_id); - -/** - Count the number of operands of a given type. - Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) - - NOTE: this API is only valid when detail option is ON (which is OFF by default) - - @handle: handle returned by cs_open() - @insn: disassembled instruction structure received from cs_disasm() or cs_disasm_iter() - @op_type: Operand type to be found. - - @return: number of operands of given type @op_type in instruction @insn, - or -1 on failure. -*/ -CAPSTONE_EXPORT -int CAPSTONE_API cs_op_count(csh handle, const cs_insn *insn, unsigned int op_type); - -/** - Retrieve the position of operand of given type in <arch>.operands[] array. - Later, the operand can be accessed using the returned position. - Find the operand type in header file of corresponding architecture (arm.h for ARM, x86.h for X86, ...) - - NOTE: this API is only valid when detail option is ON (which is OFF by default) - - @handle: handle returned by cs_open() - @insn: disassembled instruction structure received from cs_disasm() or cs_disasm_iter() - @op_type: Operand type to be found. - @position: position of the operand to be found. This must be in the range - [1, cs_op_count(handle, insn, op_type)] - - @return: index of operand of given type @op_type in <arch>.operands[] array - in instruction @insn, or -1 on failure. -*/ -CAPSTONE_EXPORT -int CAPSTONE_API cs_op_index(csh handle, const cs_insn *insn, unsigned int op_type, - unsigned int position); - -/// Type of array to keep the list of registers -typedef uint16_t cs_regs[64]; - -/** - Retrieve all the registers accessed by an instruction, either explicitly or - implicitly. - - WARN: when in 'diet' mode, this API is irrelevant because engine does not - store registers. - - @handle: handle returned by cs_open() - @insn: disassembled instruction structure returned from cs_disasm() or cs_disasm_iter() - @regs_read: on return, this array contains all registers read by instruction. - @regs_read_count: number of registers kept inside @regs_read array. - @regs_write: on return, this array contains all registers written by instruction. - @regs_write_count: number of registers kept inside @regs_write array. - - @return CS_ERR_OK on success, or other value on failure (refer to cs_err enum - for detailed error). -*/ -CAPSTONE_EXPORT -cs_err CAPSTONE_API cs_regs_access(csh handle, const cs_insn *insn, - cs_regs regs_read, uint8_t *regs_read_count, - cs_regs regs_write, uint8_t *regs_write_count); - -#ifdef __cplusplus -} -#endif - -#endif diff --git a/src/elfo-pretty.zig b/src/elfo-pretty.zig index 798fd10..ea0b246 100644 --- a/src/elfo-pretty.zig +++ b/src/elfo-pretty.zig @@ -10,7 +10,7 @@ const SymbolRange = struct { fn iterateSymbols( h: std.elf.Header, - file_reader: *std.fs.File.Reader, + file_reader: *std.Io.File.Reader, symtab: std.elf.Elf64_Shdr, ) SymbolIterator { return .{ @@ -22,7 +22,7 @@ fn iterateSymbols( const SymbolIterator = struct { elf_header: std.elf.Header, - file_reader: *std.fs.File.Reader, + file_reader: *std.Io.File.Reader, symtab: std.elf.Elf64_Shdr, index: usize = 0, @@ -40,21 +40,19 @@ const SymbolIterator = struct { } }; -pub fn main() !void { - var args = std.process.args(); - _ = args.skip(); // skip argv[0] +pub fn main(init: std.process.Init) !void { + // var args = init.environ_map.iterator(); + // _ = args.next(); // skip argv[0] - const bw = std.debug.lockStderrWriter(&.{}); - defer std.debug.unlockStderrWriter(); - const ttyconf = std.io.tty.detectConfig(.stderr()); + var buffer: [64]u8 = undefined; + const stderr = try init.io.lockStderr(&buffer, .escape_codes); - var gpa: std.heap.GeneralPurposeAllocator(.{}) = .init; - const allocator = gpa.allocator(); try printElf( - allocator, - args.next() orelse "./study-samples/split", - bw, - ttyconf, + init.gpa, + init.io, + // args.next() orelse "./study-samples/split", + "./study-samples/split", + stderr.terminal(), .{ // .show_unaddressable_sections = true, // .skip_sections_content = true, @@ -63,19 +61,22 @@ pub fn main() !void { } pub fn printElf( - allocator: std.mem.Allocator, + gpa: std.mem.Allocator, + io: std.Io, path: []const u8, - bw: *std.Io.Writer, - ttyconf: std.io.tty.Config, + term: std.Io.Terminal, options: struct { show_unaddressable_sections: bool = false, skip_sections_content: bool = false, }, ) !void { - const f = try std.fs.cwd().openFile(path, .{ .mode = .read_only }); - var buffer = try allocator.alignedAlloc(u8, std.mem.Alignment.of(u64), 1024 * 100); - // const buffer = try allocator.alloc(u8, 1024 * 10000000); - var reader = f.reader(buffer); + const f = try std.Io.Dir.cwd().openFile(io, path, .{ .mode = .read_only }); + const bw = term.writer; + defer bw.flush() catch {}; + var buffer = try gpa.alignedAlloc(u8, std.mem.Alignment.of(u64), 1024 * 100); + defer gpa.free(buffer); + + var reader = f.reader(io, buffer); const header = try std.elf.Header.read(&reader.interface); var handle: usize = undefined; @@ -99,9 +100,13 @@ pub fn printElf( break :blk null; try reader.seekTo(shstrtab.?.sh_offset); - const slice = try reader.interface.readAlloc(allocator, shstrtab.?.sh_size); + const slice = try reader.interface.readAlloc(gpa, shstrtab.?.sh_size); break :blk slice; }; + defer { + if (elf_shstrtab_slice != null) + gpa.free(elf_shstrtab_slice.?); + } const strtab = blk: { if (elf_shstrtab_slice == null) @@ -124,27 +129,38 @@ pub fn printElf( break :blk null; try reader.seekTo(strtab.?.sh_offset); - const slice = try reader.interface.readAlloc(allocator, strtab.?.sh_size); + const slice = try reader.interface.readAlloc(gpa, strtab.?.sh_size); break :blk slice; }; - var strs: std.ArrayList([]const u8) = try .initCapacity(allocator, 8); + defer { + if (elf_strtab_slice != null) + gpa.free(elf_strtab_slice.?); + } + + var strs: std.ArrayList([]const u8) = try .initCapacity(gpa, 8); { if (elf_shstrtab_slice != null) { var str_it = std.mem.splitScalar(u8, elf_shstrtab_slice.?, 0); while (str_it.next()) |str| { - const owned_str = try allocator.alloc(u8, str.len); + const owned_str = try gpa.alloc(u8, str.len); @memcpy(owned_str, str); - try strs.append(allocator, owned_str); + try strs.append(gpa, owned_str); } } } + defer { + for (strs.items) |s| { + gpa.free(s); + } + strs.deinit(gpa); + } - var sections: std.ArrayList(std.elf.Elf64_Shdr) = try .initCapacity(allocator, 8); + var sections: std.ArrayList(std.elf.Elf64_Shdr) = try .initCapacity(gpa, 8); { var section_it = header.iterateSectionHeaders(&reader); while (try section_it.next()) |section| { - try sections.append(allocator, section); + try sections.append(gpa, section); } std.mem.sort(std.elf.Elf64_Shdr, sections.items, {}, struct { pub fn inner(_: void, x: std.elf.Elf64_Shdr, y: std.elf.Elf64_Shdr) bool { @@ -152,6 +168,7 @@ pub fn printElf( } }.inner); } + defer sections.deinit(gpa); const symtab = blk: { var section_it = header.iterateSectionHeaders(&reader); @@ -176,16 +193,16 @@ pub fn printElf( }; try bw.print("dynsym: {any}\n", .{dynsym}); - const symbols_index = blk: { - var syms: std.ArrayList(SymbolRange) = try .initCapacity(allocator, 8); + var symbols_index = blk: { + var syms: std.ArrayList(SymbolRange) = try .initCapacity(gpa, 8); if (symtab != null) { var sym_it = iterateSymbols(header, &reader, symtab.?); while (try sym_it.next()) |s| { const t = s.st_info & 0xf; const name = std.mem.sliceTo(elf_strtab_slice.?[s.st_name..], 0); - const owned_name = try allocator.alloc(u8, name.len); + const owned_name = try gpa.alloc(u8, name.len); @memcpy(owned_name, name); - try syms.append(allocator, .{ + try syms.append(gpa, .{ .start = s.st_value, .end = s.st_value + s.st_size, .name = owned_name, @@ -200,9 +217,9 @@ pub fn printElf( while (try sym_it.next()) |s| { const t = s.st_info & 0xf; const name = std.mem.sliceTo(elf_strtab_slice.?[s.st_name..], 0); - const owned_name = try allocator.alloc(u8, name.len); + const owned_name = try gpa.alloc(u8, name.len); @memcpy(owned_name, name); - try syms.append(allocator, .{ + try syms.append(gpa, .{ .start = s.st_value, .end = s.st_value + s.st_size, .name = owned_name, @@ -215,35 +232,41 @@ pub fn printElf( return x.start < y.start; } }.inner); - break :blk syms.items; + break :blk syms; }; + defer { + for (symbols_index.items) |sym| { + gpa.free(sym.name); + } + symbols_index.deinit(gpa); + } - for (symbols_index) |sym| { + for (symbols_index.items) |sym| { if (sym.kind == std.elf.STT_FUNC and sym.name.len > 0) try bw.print("{s} {x}-{x}\n", .{ sym.name, sym.start, sym.end }); } for (sections.items) |section| { if (section.sh_size > 0 and section.sh_addr > 0) { - try ttyconf.setColor(bw, .reset); - try ttyconf.setColor(bw, .dim); + try term.setColor(.reset); + try term.setColor(.dim); try bw.print("\n{x}-{x} (t: {x}) -- ", .{ section.sh_addr, section.sh_addr + section.sh_size, section.sh_type, }); - try ttyconf.setColor(bw, .bright_green); + try term.setColor(.bright_green); if (elf_shstrtab_slice != null) try bw.print("{s}", .{std.mem.sliceTo(elf_shstrtab_slice.?[section.sh_name..], 0)}); try bw.print("\n", .{}); - try ttyconf.setColor(bw, .reset); + try term.setColor(.reset); // -- try reader.seekTo(section.sh_offset); if (buffer.len < section.sh_size) { - buffer = try allocator.realloc(buffer, section.sh_size); - reader = f.reader(buffer); + buffer = try gpa.realloc(buffer, section.sh_size); + reader = f.reader(io, buffer); } const section_slice = reader.interface.take(section.sh_size) catch |e| blk: { switch (e) { @@ -263,9 +286,9 @@ pub fn printElf( break :blk insn[0..count]; }; - try dumpInstr(allocator, bw, ttyconf, instrs, symbols_index); + try dumpInstr(gpa, bw, term, instrs, symbols_index.items); } else { - try dumpHexFallible(u64, bw, ttyconf, section_slice.?, section.sh_addr); + try dumpHexFallible(u64, bw, term, section_slice.?, section.sh_addr); } } } @@ -274,25 +297,25 @@ pub fn printElf( if (options.show_unaddressable_sections) { for (sections.items) |section| { if (section.sh_size > 0 and section.sh_addr == 0) { - try ttyconf.setColor(bw, .reset); - try ttyconf.setColor(bw, .dim); + try term.setColor(.reset); + try term.setColor(.dim); try bw.print("{x}-{x} (t: {x}) -- ", .{ section.sh_addr, section.sh_addr + section.sh_size, section.sh_type, }); - try ttyconf.setColor(bw, .bright_cyan); + try term.setColor(.bright_cyan); if (elf_shstrtab_slice != null) try bw.print("{s}", .{std.mem.sliceTo(elf_shstrtab_slice.?[section.sh_name..], 0)}); try bw.print("\n", .{}); - try ttyconf.setColor(bw, .reset); + try term.setColor(.reset); // -- try reader.seekTo(section.sh_offset); if (buffer.len < section.sh_size) { - buffer = try allocator.realloc(buffer, section.sh_size); - reader = f.reader(buffer); + buffer = try gpa.realloc(buffer, section.sh_size); + reader = f.reader(io, buffer); } const section_slice = reader.interface.take(section.sh_size) catch |e| blk: { switch (e) { @@ -303,7 +326,7 @@ pub fn printElf( } }; if (section_slice != null and !options.skip_sections_content) { - try dumpHexFallible(u64, bw, ttyconf, section_slice.?, section.sh_addr); + try dumpHexFallible(u64, bw, term, section_slice.?, section.sh_addr); } } } @@ -348,7 +371,7 @@ fn allocComment( fn dumpInstr( gpa: std.mem.Allocator, bw: *std.Io.Writer, - ttyconf: std.io.tty.Config, + term: std.Io.Terminal, instrs: []cs.cs_insn, symbols: []SymbolRange, ) !void { @@ -361,44 +384,54 @@ fn dumpInstr( }.inner); if (idx < symbols.len and symbols[idx].start == addr and symbols[idx].name.len > 0) { - try ttyconf.setColor(bw, .blue); + try term.setColor(.blue); try bw.print("\n{x:0>16} {s}:\n", .{ addr, symbols[idx].name, }); - try ttyconf.setColor(bw, .reset); + try term.setColor(.reset); } - try ttyconf.setColor(bw, .dim); + try term.setColor(.dim); try bw.print("{x:0>[1]} ", .{ addr, @sizeOf(usize) * 2 }); - try ttyconf.setColor(bw, .reset); + try term.setColor(.reset); // if(instr.detail.) - try ttyconf.setColor(bw, .bright_green); + try term.setColor(.bright_green); try bw.print("{s} ", .{instr.mnemonic}); - try ttyconf.setColor(bw, .reset); + try term.setColor(.reset); try bw.print("{s}", .{instr.op_str}); const asm_comment = try allocComment(gpa, @ptrCast(@constCast(&instr.op_str)), symbols); + defer { + if (asm_comment != null) + gpa.free(asm_comment.?); + } if (asm_comment != null and asm_comment.?.len > 0) { - try ttyconf.setColor(bw, .blue); + try term.setColor(.blue); try bw.print(" <{s}>", .{asm_comment.?}); } try bw.print("\n", .{}); - try ttyconf.setColor(bw, .reset); + try term.setColor(.reset); } } /// Prints a hexadecimal view of the bytes, returning any error that occurs. -pub fn dumpHexFallible(_: type, bw: *std.Io.Writer, ttyconf: std.io.tty.Config, bytes: []const u8, offset: u64) !void { +pub fn dumpHexFallible( + _: type, + bw: *std.Io.Writer, + term: std.Io.Terminal, + bytes: []const u8, + offset: u64, +) !void { // @breakpoint(); const nbytes = 16; var chunks = std.mem.window(u8, @ptrCast(@alignCast(bytes)), nbytes, nbytes); while (chunks.next()) |window| { // 1. Print the address. const address = ((0x10 * (std.math.divCeil(usize, chunks.index orelse bytes.len, nbytes) catch unreachable)) - 0x10) + offset; - try ttyconf.setColor(bw, .dim); + try term.setColor(.dim); // We print the address in lowercase and the bytes in uppercase hexadecimal to distinguish them more. // Also, make sure all lines are aligned by padding the address. try bw.print("{x:0>[1]} ", .{ address, @sizeOf(usize) * 2 }); - try ttyconf.setColor(bw, .reset); + try term.setColor(.reset); // 2. Print the bytes. for (window, 0..) |byte, index| { @@ -419,11 +452,6 @@ pub fn dumpHexFallible(_: type, bw: *std.Io.Writer, ttyconf: std.io.tty.Config, if (std.ascii.isPrint(byte)) { try bw.writeByte(byte); } else { - // Related: https://github.com/ziglang/zig/issues/7600 - if (ttyconf == .windows_api) { - try bw.writeByte('.'); - continue; - } // Let's print some common control codes as graphical Unicode symbols. // We don't want to do this for all control codes because most control codes apart from diff --git a/src/gloves.zig b/src/gloves.zig index b99df55..0ef2481 100644 --- a/src/gloves.zig +++ b/src/gloves.zig @@ -13,55 +13,62 @@ const alloc = gpa.allocator(); const ArrayList = std.ArrayList; pub fn main() !void { - var child = std.process.Child.init(&.{"./study-samples/split"}, alloc); - child.stdin_behavior = .Pipe; - child.stdout_behavior = .Pipe; - child.stderr_behavior = .Pipe; + // // var child = std.process.Child.init(&.{ "cat", "-" }, alloc); + // var child = std.process.Child.init(&.{"./study-samples/split"}, alloc); + // child.stdin_behavior = .Pipe; + // child.stdout_behavior = .Pipe; + // child.stderr_behavior = .Pipe; - var stdin_buf: [0x100]u8 = undefined; - var stdin = std.fs.File.stdin().readerStreaming(&stdin_buf); + // var stdin_buf: [0x100]u8 = undefined; + // var stdin = std.fs.File.stdin().readerStreaming(&stdin_buf); - var stdout: ArrayList(u8) = .empty; - defer stdout.deinit(alloc); - var stderr: ArrayList(u8) = .empty; - defer stderr.deinit(alloc); + // var stdout: ArrayList(u8) = .empty; + // defer stdout.deinit(alloc); + // var stderr: ArrayList(u8) = .empty; + // defer stderr.deinit(alloc); - try child.spawn(); + // try child.spawn(); + // errdefer { + // _ = child.kill() catch {}; + // } - var child_writer_buf: [0x100]u8 = undefined; - var child_stdin_writer = child.stdin.?.writer(&child_writer_buf); + // var child_writer_buf: [0x100]u8 = undefined; + // var child_stdin_writer = child.stdin.?.writer(&child_writer_buf); - while (true) { - if (stdin.interface.streamDelimiter(&child_stdin_writer.interface, '\n')) |_| {} else |_| { - break; - } - // if (n == 0) break; - _ = try child_stdin_writer.interface.writeByte('\n'); - if (child_stdin_writer.interface.flush()) |_| {} else |_| { - break; - } - try child.collectOutput(alloc, &stdout, &stderr, 0x1000); - std.debug.print("{s}\n {s}\n", .{ stdout.items, stderr.items }); - } + // while (true) { + // if (stdin.interface.streamDelimiter(&child_stdin_writer.interface, '\n')) |_| {} else |e| { + // switch (e) { + // error.EndOfStream => { + // std.debug.print("end of stream\n", .{}); + // break; + // }, + // else => {}, + // } + // break; + // } + // _ = try child_stdin_writer.interface.writeByte('\n'); + // if (child_stdin_writer.interface.flush()) |_| {} else |_| { + // break; + // } + // } - errdefer { - _ = child.kill() catch {}; - } + // child.collectOutput(alloc, &stdout, &stderr, 0x1000) catch {}; + // std.debug.print("{s}\n {s}\n", .{ stdout.items, stderr.items }); - const term = try child.wait(); - switch (term) { - .Signal => |s| { - inline for (@typeInfo(std.os.linux.SIG).@"struct".decls) |f| { - const field = @field(std.os.linux.SIG, f.name); - const t = @TypeOf(field); - if (t == comptime_int) { - if (field == s) - std.debug.print("Returned with Signal: {s} ({d})\n", .{ f.name, s }); - } - } - }, - else => std.debug.print("{any}\n", .{ .term = term }), - } + // const term = try child.wait(); + // switch (term) { + // .Signal => |s| { + // inline for (@typeInfo(std.os.linux.SIG).@"struct".decls) |f| { + // const field = @field(std.os.linux.SIG, f.name); + // const t = @TypeOf(field); + // if (t == comptime_int) { + // if (field == s) + // std.debug.print("Returned with Signal: {s} ({d})\n", .{ f.name, s }); + // } + // } + // }, + // else => std.debug.print("{any}\n", .{ .term = term }), + // } - // std.debug.print("*** If you this message alone... Something probably went wrong\nIs this leaking? {any}\n", .{gpa.detectLeaks()}); + // // std.debug.print("*** If you this message alone... Something probably went wrong\nIs this leaking? {any}\n", .{gpa.detectLeaks()}); } |
