flush.cpp File Reference

flush command More...

#include "pch.h"

Functions
VOID	CommandFlushHelp ()
	help of the flush command
VOID	CommandFlushRequestFlush ()
	flush command handler
VOID	CommandFlush (vector< CommandToken > CommandTokens, string Command)
	flush command handler

Variables
BOOLEAN	g_IsKdModuleLoaded
	shows whether the kernel debugger (KD) module is loaded or not
BOOLEAN	g_IsSerialConnectedToRemoteDebuggee
	Shows if the debugger was connected to remote debuggee over (A remote guest).

Detailed Description

flush command

Author

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

Version

0.1

Date

2020-08-19

Copyright

This project is released under the GNU Public License v3.

Function Documentation

CommandFlush()

VOID CommandFlush	(	vector< CommandToken >	CommandTokens,
		string	Command )

flush command handler

Parameters

CommandTokens
Command

Returns

VOID

{
    if (CommandTokens.size() != 1)
    {
        ShowMessages("incorrect use of the '%s'\n\n",
                     GetCaseSensitiveStringFromCommandToken(CommandTokens.at(0)).c_str());
        CommandFlushHelp();
        return;
    }
 
    //
    // Flush the buffer
    //
    CommandFlushRequestFlush();
}

CommandFlushHelp()

VOID CommandFlushHelp

(

)

help of the flush command

Returns

VOID

{
    ShowMessages("flush : removes all the buffer and messages from kernel-mode "
                 "buffers.\n\n");
 
    ShowMessages("syntax : \tflush \n");
}

CommandFlushRequestFlush()

VOID CommandFlushRequestFlush

(

)

flush command handler

Returns

VOID

{
    BOOL                           Status;
    ULONG                          ReturnedLength;
    DEBUGGER_FLUSH_LOGGING_BUFFERS FlushRequest = {0};
 
    if (g_IsSerialConnectedToRemoteDebuggee)
    {
        //
        // It's on a debugger mode
        //
        KdSendFlushPacketToDebuggee();
    }
    else
    {
        //
        // It's on a local debugging mode
        //
        AssertShowMessageReturnStmt(g_IsKdModuleLoaded, g_DeviceHandle, ASSERT_MESSAGE_KD_NOT_LOADED, ASSERT_MESSAGE_DRIVER_NOT_LOADED, AssertReturn);
 
        //
        // By the way, we don't need to send an input buffer
        // to the kernel, but let's keep it like this, if we
        // want to pass some other arguments to the kernel in
        // the future
        //
        Status = DeviceIoControl(
            g_DeviceHandle,                        // Handle to device
            IOCTL_DEBUGGER_FLUSH_LOGGING_BUFFERS,  // IO Control Code (IOCTL)
            &FlushRequest,                         // Input Buffer to driver.
            SIZEOF_DEBUGGER_FLUSH_LOGGING_BUFFERS, // Input buffer length
            &FlushRequest,                         // Output Buffer from driver.
            SIZEOF_DEBUGGER_FLUSH_LOGGING_BUFFERS, // Length of output buffer in
                                                   // bytes.
            &ReturnedLength,                       // Bytes placed in buffer.
            NULL                                   // synchronous call
        );
 
        if (!Status)
        {
            ShowMessages("ioctl failed with code 0x%x\n", GetLastError());
            return;
        }
 
        if (FlushRequest.KernelStatus == DEBUGGER_OPERATION_WAS_SUCCESSFUL)
        {
            //
            // The amount of message that are deleted are the amount of
            // vmx-root messages and vmx non-root messages
            //
            ShowMessages(
                "flushing buffers was successful, total %d messages were cleared.\n",
                FlushRequest.CountOfMessagesThatSetAsReadFromVmxNonRoot +
                    FlushRequest.CountOfMessagesThatSetAsReadFromVmxRoot);
        }
        else
        {
            ShowMessages("flushing buffers was not successful :(\n");
        }
    }
}

Variable Documentation

g_IsKdModuleLoaded

BOOLEAN g_IsKdModuleLoaded

extern

shows whether the kernel debugger (KD) module is loaded or not

g_IsSerialConnectedToRemoteDebuggee

BOOLEAN g_IsSerialConnectedToRemoteDebuggee

extern

Shows if the debugger was connected to remote debuggee over (A remote guest).