HyperDbgHyperPerf.h File Reference

Headers relating exported functions from hyperperf (pmu) module. More...

Go to the source code of this file.

Macros
#define	IMPORT_EXPORT_HYPERPERF   __declspec(dllimport)

Functions
IMPORT_EXPORT_HYPERPERF BOOLEAN	HyperPerfInitCallback (HYPERPERF_CALLBACKS *HyperPerfCallbacks, BOOLEAN RunningOnHypervisorEnvironment)
	Initialize the hyperperf module callbacks.
IMPORT_EXPORT_HYPERPERF VOID	HyperPerfUninit ()
	Uninitialize the hypertrace module.

Detailed Description

Headers relating exported functions from hyperperf (pmu) module.

Author

Sina Karvandi (sina@.nosp@m.hype.nosp@m.rdbg..nosp@m.org)

Version

0.21

Date

2026-06-22

Copyright

This project is released under the GNU Public License v3.

Macro Definition Documentation

IMPORT_EXPORT_HYPERPERF

#define IMPORT_EXPORT_HYPERPERF   __declspec(dllimport)

Function Documentation

HyperPerfInitCallback()

IMPORT_EXPORT_HYPERPERF BOOLEAN HyperPerfInitCallback	(	HYPERPERF_CALLBACKS *	HyperPerfCallbacks,
		BOOLEAN	RunningOnHypervisorEnvironment )

Initialize the hyperperf module callbacks.

This only for callback initialization, not for PMU, etc. initialization

Parameters

HyperPerfCallbacks	Pointer to the HyperPerf callbacks structure to be registered
RunningOnHypervisorEnvironment	Whether the initialization is being done for hypervisor environment or not, it can be used to skip some of the initialization steps if it is not for hypervisor environment and behave differently based on that

Returns

BOOLEAN

{
    //
    // Check if any of the required callbacks are NULL
    //
    for (UINT32 i = 0; i < sizeof(HYPERPERF_CALLBACKS) / sizeof(UINT64); i++)
    {
        if (((PVOID *)HyperPerfCallbacks)[i] == NULL)
        {
            //
            // The callback has null entry, so we cannot proceed
            //
            return FALSE;
        }
    }
 
    //
    // Save the callbacks
    //
    PlatformWriteMemory(&g_Callbacks, HyperPerfCallbacks, sizeof(HYPERPERF_CALLBACKS));
 
    //
    // Set the flag to indicate whether the initialization is being done for hypervisor environment or not
    //
    g_RunningOnHypervisorEnvironment = RunningOnHypervisorEnvironment;
 
    //
    // Enable callbacks and set the initialized flag
    //
    g_HyperPerfCallbacksInitialized = TRUE;
 
    return TRUE;
}

HyperPerfUninit()

IMPORT_EXPORT_HYPERPERF VOID HyperPerfUninit

(

)

Uninitialize the hypertrace module.

Returns

VOID

{
    //
    // Check if the callbacks are initialized, if not, we don't need to handle anymore
    //
    if (!g_HyperPerfCallbacksInitialized)
    {
        return;
    }
 
    //
    // Reset the environment flag to default value
    //
    g_RunningOnHypervisorEnvironment = FALSE;
 
    //
    // Set callbacks to not initialized
    //
    g_HyperPerfCallbacksInitialized = FALSE;
}