dttr_runtime.h

Go to the documentation of this file.

 
#ifndef DTTR_RUNTIME_H
#define DTTR_RUNTIME_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
 
#include <windows.h>
 
#include <dttr_versions.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef uintptr_t (*DTTR_Core_SigscanFn)(HMODULE mod, const char *sig, const char *mask);
 
typedef struct DTTR_Core_Hook DTTR_Core_Hook;
typedef struct DTTR_Core_API DTTR_Core_API;
 
typedef struct DTTR_Core_Context {
    HMODULE game_module;
    const DTTR_Core_API *api;
    uint32_t struct_size;
    uint32_t abi_version;
    uint32_t flags;
    const void *reserved[4];
} DTTR_Core_Context;
 
typedef DTTR_Core_Hook *(*DTTR_Core_HookFunctionFn)(
    uintptr_t addr,
    // Minimum prologue bytes for the hook injection site. Pass 0 for auto.
    int prologue_size,
    void *handler,
    void **out_original
);
 
typedef DTTR_Core_Hook
    *(*DTTR_Core_HookPointerFn)(uintptr_t addr, void *new_value, void **out_original);
 
typedef DTTR_Core_Hook
    *(*DTTR_Core_PatchBytesFn)(uintptr_t addr, const uint8_t *bytes, size_t size);
 
typedef void (*DTTR_Core_UnhookFn)(DTTR_Core_Hook *hook);
typedef bool (*DTTR_Core_HookIsActiveFn)(DTTR_Core_Hook *hook);
typedef bool (*DTTR_Core_UnhookCheckedFn)(DTTR_Core_Hook *hook);
 
struct DTTR_Core_API {
    DTTR_Core_SigscanFn sigscan;
    DTTR_Core_HookFunctionFn hook_function;
    DTTR_Core_HookPointerFn hook_pointer;
    DTTR_Core_PatchBytesFn patch_bytes;
    DTTR_Core_UnhookFn unhook;
    uint32_t struct_size;
    uint32_t abi_version;
    uint32_t flags;
    const void *reserved[4];
    DTTR_Core_HookIsActiveFn hook_is_active;
    DTTR_Core_UnhookCheckedFn unhook_checked;
};
 
// Purpose-agnostic declaration/definition helpers for private consumer storage.
// These helpers only declare or define storage owned by the consumer.
#define DTTR_DECLARE_STORAGE(type, name) extern type name;
#define DTTR_DEFINE_STORAGE(type, name) type name;
 
#define DTTR_DECLARE_HOOK_STORAGE(name)                                                  \
    extern uintptr_t name##_site;                                                        \
    extern DTTR_Core_Hook *name##_handle;
#define DTTR_DEFINE_HOOK_STORAGE(name)                                                   \
    uintptr_t name##_site;                                                               \
    DTTR_Core_Hook *name##_handle;
 
#define DTTR_STORAGE_SLOT(type, name) DTTR_DECLARE_STORAGE(type, name)
#define DTTR_HOOK_STORAGE_SLOT(name) DTTR_DECLARE_HOOK_STORAGE(name)

DTTR_Core_Hook *DTTR_Core_HookAttachFunction(
    uintptr_t addr,
    int prologue_size,
    void *handler,
    void **out_original
);

DTTR_Core_Hook *DTTR_Core_HookAttachPointer(
    uintptr_t addr,
    void *new_value,
    void **out_original
);

DTTR_Core_Hook *DTTR_Core_HookPatchBytes(
    uintptr_t addr,
    const uint8_t *bytes,
    size_t size
);

void DTTR_Core_HookDetach(DTTR_Core_Hook *hook);

bool DTTR_Core_HookDetachChecked(DTTR_Core_Hook *hook);

bool DTTR_Core_HookIsActive(DTTR_Core_Hook *hook);

bool DTTR_Core_HookDetachOwnerChecked(void *owner);

void *DTTR_Core_HookSetOwner(void *owner);

void DTTR_Core_HookDetachOwner(void *owner);

void DTTR_Core_HookCleanupAll();

bool DTTR_Core_HookCleanupAllChecked();

uintptr_t DTTR_Core_HookSigscan(HMODULE mod, const char *sig, const char *mask);

uintptr_t DTTR_Core_HookCachedSigscan(HMODULE mod, const char *sig, const char *mask);
 
#ifdef __cplusplus
}
#endif
 
#endif // DTTR_RUNTIME_H