PerfApi.c File Reference

PMU routines for HyperPerf module. More...

#include "pch.h"

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

Detailed Description

PMU routines for HyperPerf 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.

Function Documentation

HyperPerfInitCallback()

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()

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;
}