kse.h

Go to the documentation of this file.

/*
* PROJECT:     ReactOS Kernel
* LICENSE:     GPL-2.0-or-later (https://spdx.org/licenses/GPL-2.0-or-later)
* PURPOSE:     Kernel Shim Engine types
* COPYRIGHT:   Copyright 2020 Hervé Poussineau <hpoussin@reactos.org>
* COPYRIGHT:   Copyright 2020-2026 Mark Jansen <mark.jansen@reactos.org>
*/
 
#pragma once
 
#define KseHookFunction     0
#define KseHookIRPCallback  1
#define KseHookInvalid      2
 
#define KseHookCallbackDriverInit       1
#define KseHookCallbackDriverStartIo    2
#define KseHookCallbackDriverUnload     3
#define KseHookCallbackAddDevice        4
#define KseHookCallbackMajorFunction    100
 
typedef struct _KSE_HOOK
{
    ULONG Type;
    union
    {
        PCHAR FunctionName;     // if Type == KseHookFunction
        ULONG CallbackId;       // if Type == KseHookIRPCallback, KseHookCallback..
    };
    PVOID HookFunction;
    PVOID OriginalFunction;     // if Type == KseHookFunction
} KSE_HOOK, *PKSE_HOOK;
 
 
#define KseCollectionNtExport       0
#define KseCollectionHalExport      1
#define KseCollectionDriverExport   2
#define KseCollectionCallback       3
#define KseCollectionInvalid        4
 
typedef struct _KSE_HOOK_COLLECTION
{
    ULONG Type;
    PWCHAR ExportDriverName;    // if Type == KseCollectionDriverExport
    PKSE_HOOK HookArray;
} KSE_HOOK_COLLECTION, *PKSE_HOOK_COLLECTION;
 
 
typedef VOID
(NTAPI *PKSE_HOOK_DRIVER_TARGETED)(
    _In_ PUNICODE_STRING BaseName,
    _In_ PVOID BaseAddress,
    _In_ ULONG SizeOfImage,
    _In_ ULONG TimeDateStamp,
    _In_ ULONG CheckSum);
 
typedef VOID
(NTAPI *PKSE_HOOK_DRIVER_UNTARGETED)(
    _In_ PVOID BaseAddress);
 
 
typedef struct _KSE_DRIVER_IO_CALLBACKS
{
    PDRIVER_INITIALIZE DriverInit;
    PDRIVER_STARTIO DriverStartIo;
    PDRIVER_UNLOAD DriverUnload;
    PDRIVER_ADD_DEVICE AddDevice;
    PDRIVER_DISPATCH MajorFunction[IRP_MJ_MAXIMUM_FUNCTION + 1];
} KSE_DRIVER_IO_CALLBACKS, *PKSE_DRIVER_IO_CALLBACKS;
 
 
typedef PKSE_DRIVER_IO_CALLBACKS
(NTAPI KSE_GET_IO_CALLBACKS)(
    _In_ PDRIVER_OBJECT DriverObject);
typedef KSE_GET_IO_CALLBACKS *PKSE_GET_IO_CALLBACKS;
 
typedef NTSTATUS
(NTAPI KSE_SET_COMPLETION_HOOK)(
    _In_ PDEVICE_OBJECT DeviceObject,
    _In_ PIRP Irp,
    _In_ PIO_COMPLETION_ROUTINE CompletionRoutine,
    _In_ PVOID Context);
typedef KSE_SET_COMPLETION_HOOK *PKSE_SET_COMPLETION_HOOK;
 
 
typedef struct _KSE_CALLBACK_ROUTINES
{
    PKSE_GET_IO_CALLBACKS KseGetIoCallbacksRoutine;
    PKSE_SET_COMPLETION_HOOK KseSetCompletionHookRoutine;
} KSE_CALLBACK_ROUTINES, *PKSE_CALLBACK_ROUTINES;
 
typedef struct _KSE_SHIM
{
    ULONG Size;
    const GUID* ShimGuid;
    PWCHAR ShimName;
    PKSE_CALLBACK_ROUTINES KseCallbackRoutines;
    PKSE_HOOK_DRIVER_TARGETED ShimmedDriverTargetedNotification;
    PKSE_HOOK_DRIVER_UNTARGETED ShimmedDriverUntargetedNotification;
    PKSE_HOOK_COLLECTION HookCollectionsArray;
} *PKSE_SHIM, KSE_SHIM;
 
 
/* Exported functions */
//KseQueryDeviceData
//KseQueryDeviceDataList
//KseQueryDeviceFlags
//KseSetDeviceFlags
 
NTSTATUS
NTAPI
KseRegisterShim(
    _In_ PKSE_SHIM Shim,
    _In_ PVOID Ignored,
    _In_ ULONG Flags);
 
NTSTATUS
NTAPI
KseRegisterShimEx(
    _In_ PKSE_SHIM Shim,
    _In_ PVOID Ignored,
    _In_ ULONG Flags,
    _In_opt_ PVOID DriverObject);
 
NTSTATUS
NTAPI
KseUnregisterShim(
    _In_ PKSE_SHIM Shim,
    _In_ PVOID Unknown1,
    _In_ PVOID Unknown2);
 
/* PRIVATE ROUTINES **********************************************************/
 
CODE_SEG("INIT")
NTSTATUS
NTAPI
KseInitialize(
    _In_ ULONG BootPhase,
    _In_ PLOADER_PARAMETER_BLOCK LoaderBlock);
 
NTSTATUS
NTAPI
KseShimDriverIoCallbacks(
    _In_ PDRIVER_OBJECT DriverObject);
 
NTSTATUS
NTAPI
KseDriverLoadImage(
    _In_ PLDR_DATA_TABLE_ENTRY LdrEntry);
 
PKSE_SHIM
NTAPI
KsepFindShim(
    _In_ PCUNICODE_STRING Name);
 
VOID
NTAPI
KsepAddShimByName(
    _In_ PCUNICODE_STRING Name,
    _Inout_ PKSE_SHIM* Shims,
    _Inout_ PULONG NumberOfShims);
 
/* Driver database (drvmain.sdb) */
CODE_SEG("INIT")
NTSTATUS
NTAPI
KseDbInitialize(
    _In_ PVOID DatabaseImage,
    _In_ ULONG DatabaseSize);
 
VOID
NTAPI
KseDbGetShimsForDriver(
    _In_ PLDR_DATA_TABLE_ENTRY LdrEntry,
    _Inout_ PKSE_SHIM* Shims,
    _Inout_ PULONG NumberOfShims);
 
CODE_SEG("INIT")
NTSTATUS
NTAPI
KseDriverScopeInitialize(VOID);
 
CODE_SEG("INIT")
NTSTATUS
NTAPI
KseIgnoreFreePoolTagInitialize(VOID);