messaging.cpp File Reference

Functions for handling messages. More...

#include "pch.h"

Functions
VOID	SetTextMessageCallback (PVOID Handler)
	Set the function callback that will be called if any message needs to be shown.
PVOID	SetTextMessageCallbackUsingSharedBuffer (PVOID Handler)
	Set the function callback that will be called if any message needs to be shown.
VOID	UnsetTextMessageCallback ()
	Unset the function callback that will be called if any message needs to be shown.
VOID	ShowMessages (const CHAR *Fmt,...)
	Show messages.

Variables
PVOID	g_MessageHandler
	The handler for ShowMessages function this is because the user might choose not to use printf and instead use his/her handler for showing messages.
PVOID	g_MessageHandlerSharedBuffer
	The shared buffer for the handler of ShowMessages function.
BOOLEAN	g_LogOpened
	Shows whether the '.logopen' command is executed and the log file is open or not.
BOOLEAN	g_IsConnectedToRemoteDebugger
	Shows whether the current system is a guest (debuggee) and a remote debugger is connected to this system.
BOOLEAN	g_IsSerialConnectedToRemoteDebugger
	Shows if the debugger was connected to remote debugger (A remote host).

Detailed Description

Functions for handling messages.

Author

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

Version

0.19

Date

2026-05-28

Copyright

This project is released under the GNU Public License v3.

Function Documentation

SetTextMessageCallback()

VOID SetTextMessageCallback

(

PVOID

Handler

)

Set the function callback that will be called if any message needs to be shown.

Parameters

Handler

Function that handles the messages

Returns

VOID

{
    g_MessageHandler = Handler;
}

SetTextMessageCallbackUsingSharedBuffer()

PVOID SetTextMessageCallbackUsingSharedBuffer

(

PVOID

Handler

)

Set the function callback that will be called if any message needs to be shown.

Parameters

Handler

Function that handles the messages

Returns

PVOID

{
    g_MessageHandler             = Handler;
    g_MessageHandlerSharedBuffer = malloc(COMMUNICATION_BUFFER_SIZE + TCP_END_OF_BUFFER_CHARS_COUNT);
 
    if (!g_MessageHandlerSharedBuffer)
    {
        g_MessageHandler = NULL;
        return NULL;
    }
 
    RtlZeroMemory(g_MessageHandlerSharedBuffer, COMMUNICATION_BUFFER_SIZE + TCP_END_OF_BUFFER_CHARS_COUNT);
 
    return g_MessageHandlerSharedBuffer;
}

ShowMessages()

VOID ShowMessages	(	const CHAR *	Fmt,
			... )

Show messages.

Parameters

Fmt	format string message
...	arguments

Returns

VOID

{
    va_list ArgList;
    va_list Args;
    CHAR    TempMessage[COMMUNICATION_BUFFER_SIZE + TCP_END_OF_BUFFER_CHARS_COUNT] = {0};
 
    if (g_MessageHandler == NULL && !g_IsConnectedToRemoteDebugger && !g_IsSerialConnectedToRemoteDebugger)
    {
        va_start(Args, Fmt);
 
        vprintf(Fmt, Args);
 
        va_end(Args);
 
        if (!g_LogOpened)
        {
            return;
        }
    }
 
    va_start(ArgList, Fmt);
 
    INT SprintfResult = PlatformVsnprintf(TempMessage, sizeof(TempMessage), Fmt, ArgList);
 
    va_end(ArgList);
 
    if (SprintfResult != -1)
    {
        if (g_IsConnectedToRemoteDebugger)
        {
            //
            // vsprintf_s and vswprintf_s return the number of characters written,
            // not including the terminating null character, or a negative value
            // if an output error occurs.
            //
            RemoteConnectionSendResultsToHost(TempMessage, SprintfResult);
        }
        else if (g_IsSerialConnectedToRemoteDebugger)
        {
            KdSendUsermodePrints(TempMessage, SprintfResult);
        }
 
        if (g_LogOpened)
        {
            //
            // .logopen command executed
            //
            LogopenSaveToFile(TempMessage);
        }
        if (g_MessageHandler != NULL)
        {
            //
            // There is another handler
            //
            if (g_MessageHandlerSharedBuffer == NULL)
            {
                ((SendMessageWithParamCallback)g_MessageHandler)(TempMessage);
            }
            else
            {
                memcpy(g_MessageHandlerSharedBuffer, TempMessage, strlen(TempMessage) + 1);
                ((SendMessageWithSharedBufferCallback)g_MessageHandler)();
            }
        }
    }
}

UnsetTextMessageCallback()

VOID UnsetTextMessageCallback

(

)

Unset the function callback that will be called if any message needs to be shown.

Returns

VOID

{
    g_MessageHandler = NULL;
    free(g_MessageHandlerSharedBuffer);
    g_MessageHandlerSharedBuffer = NULL;
}

Variable Documentation

g_IsConnectedToRemoteDebugger

BOOLEAN g_IsConnectedToRemoteDebugger

extern

Shows whether the current system is a guest (debuggee) and a remote debugger is connected to this system.

g_IsSerialConnectedToRemoteDebugger

BOOLEAN g_IsSerialConnectedToRemoteDebugger

extern

Shows if the debugger was connected to remote debugger (A remote host).

g_LogOpened

BOOLEAN g_LogOpened

extern

Shows whether the '.logopen' command is executed and the log file is open or not.

g_MessageHandler

PVOID g_MessageHandler

extern

The handler for ShowMessages function this is because the user might choose not to use printf and instead use his/her handler for showing messages.

g_MessageHandlerSharedBuffer

PVOID g_MessageHandlerSharedBuffer

extern

The shared buffer for the handler of ShowMessages function.