HyperLogCallback.c File Reference

VMM callback interface routines. More...

#include "pch.h"

Functions
BOOLEAN	LogCallbackPrepareAndSendMessageToQueue (UINT32 OperationCode, BOOLEAN IsImmediateMessage, BOOLEAN ShowCurrentSystemTime, BOOLEAN Priority, const CHAR *Fmt,...)
	routines callback for preparing and sending message to queue
BOOLEAN	LogCallbackSendMessageToQueue (UINT32 OperationCode, BOOLEAN IsImmediateMessage, CHAR *LogMessage, UINT32 BufferLen, BOOLEAN Priority)
	routines callback for sending message to queue
BOOLEAN	LogCallbackCheckIfBufferIsFull (BOOLEAN Priority)
	routines callback for checking if buffer is full
BOOLEAN	LogCallbackSendBuffer (_In_ UINT32 OperationCode, _In_reads_bytes_(BufferLength) PVOID Buffer, _In_ UINT32 BufferLength, _In_ BOOLEAN Priority)
	routines callback for sending buffer

Detailed Description

VMM callback interface routines.

Author

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

Version

0.2

Date

2023-01-29

Copyright

This project is released under the GNU Public License v3.

Function Documentation

LogCallbackCheckIfBufferIsFull()

BOOLEAN LogCallbackCheckIfBufferIsFull

(

BOOLEAN

Priority

)

routines callback for checking if buffer is full

Checks whether the priority or regular buffer is full or not.

Parameters

Priority

Returns

BOOLEAN

Parameters

Priority

Whether the buffer has priority

Returns

BOOLEAN Returns true if the buffer is full, otherwise, return false

{
    if (g_Callbacks.LogCallbackCheckIfBufferIsFull == NULL)
    {
        //
        // Ignore sending message to queue
        //
        return FALSE;
    }
 
    return g_Callbacks.LogCallbackCheckIfBufferIsFull(Priority);
}

LogCallbackPrepareAndSendMessageToQueue()

BOOLEAN LogCallbackPrepareAndSendMessageToQueue	(	UINT32	OperationCode,
		BOOLEAN	IsImmediateMessage,
		BOOLEAN	ShowCurrentSystemTime,
		BOOLEAN	Priority,
		const CHAR *	Fmt,
			... )

routines callback for preparing and sending message to queue

Prepare a printf-style message mapping and send string messages and tracing for logging and monitoring.

Parameters

OperationCode
IsImmediateMessage
ShowCurrentSystemTime
Priority
Fmt
...

Returns

BOOLEAN

Parameters

OperationCode	Optional operation code
IsImmediateMessage	Should be sent immediately
ShowCurrentSystemTime	Show system-time
Priority	Whether the message has priority
Fmt	Message format-string
...

Returns

BOOLEAN if it was successful then return TRUE, otherwise returns FALSE

{
    BOOLEAN Result;
    va_list ArgList;
 
    if (g_Callbacks.LogCallbackPrepareAndSendMessageToQueueWrapper == NULL)
    {
        //
        // Ignore sending message to queue
        //
        return FALSE;
    }
 
    va_start(ArgList, Fmt);
 
    Result = g_Callbacks.LogCallbackPrepareAndSendMessageToQueueWrapper(OperationCode,
                                                                        IsImmediateMessage,
                                                                        ShowCurrentSystemTime,
                                                                        Priority,
                                                                        Fmt,
                                                                        ArgList);
    va_end(ArgList);
 
    return Result;
}

LogCallbackSendBuffer()

BOOLEAN LogCallbackSendBuffer	(	_In_ UINT32	OperationCode,
		_In_reads_bytes_(BufferLength) PVOID	Buffer,
		_In_ UINT32	BufferLength,
		_In_ BOOLEAN	Priority )

routines callback for sending buffer

Parameters

OperationCode
Buffer
BufferLength
Priority

Returns

BOOLEAN

{
    if (g_Callbacks.LogCallbackSendBuffer == NULL)
    {
        //
        // Ignore sending buffer
        //
        return FALSE;
    }
 
    return g_Callbacks.LogCallbackSendBuffer(OperationCode,
                                             Buffer,
                                             BufferLength,
                                             Priority);
}

LogCallbackSendMessageToQueue()

BOOLEAN LogCallbackSendMessageToQueue	(	UINT32	OperationCode,
		BOOLEAN	IsImmediateMessage,
		CHAR *	LogMessage,
		UINT32	BufferLen,
		BOOLEAN	Priority )

routines callback for sending message to queue

Send string messages and tracing for logging and monitoring.

Parameters

OperationCode
IsImmediateMessage
LogMessage
BufferLen
Priority

Returns

BOOLEAN

Parameters

OperationCode	Optional operation code
IsImmediateMessage	Should be sent immediately
LogMessage	Link of message buffer
BufferLen	Length of buffer
Priority	Whether the buffer has priority

Returns

BOOLEAN if it was successful then return TRUE, otherwise returns FALSE

{
    if (g_Callbacks.LogCallbackSendMessageToQueue == NULL)
    {
        //
        // Ignore sending message to queue
        //
        return FALSE;
    }
 
    return g_Callbacks.LogCallbackSendMessageToQueue(OperationCode,
                                                     IsImmediateMessage,
                                                     LogMessage,
                                                     BufferLen,
                                                     Priority);
}