hwdbg-interpreter.h File Reference

Headers for the interpreter of hwdbg packets and requests. More...

Go to the source code of this file.

Macros
#define	HWDBG_TEST_READ_INSTANCE_INFO_PATH   "..\\..\\..\\..\\hwdbg\\sim\\hwdbg\\DebuggerModuleTestingBRAM\\bram_instance_info.txt"
	Path to read the sample of the instance info.
#define	HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH   "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\script_buffer.hex.txt"
	Path to write the sample of the script buffer.
#define	HWDBG_TEST_WRITE_INSTANCE_INFO_PATH   "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\instance_info.hex.txt"
	Path to write the sample of the instance info requests.

Functions
BOOLEAN	HwdbgInterpretPacket (PVOID BufferReceived, UINT32 LengthReceived)
	Interpret packets of hwdbg.
BOOLEAN	HwdbgInterpreterFillFileFromMemory (HWDBG_INSTANCE_INFORMATION *InstanceInfo, const TCHAR *FileName, UINT32 *MemoryBuffer, size_t BufferSize, HWDBG_ACTION_ENUMS RequestedAction)
	Function to write the memory buffer to a file in the specified format.
BOOLEAN	HwdbgInterpreterFillMemoryFromFile (const TCHAR *FileName, UINT32 *MemoryBuffer, size_t BufferSize)
	Function to read the file and fill the memory buffer.
BOOLEAN	HwdbgInterpreterConvertSymbolToHwdbgShortSymbolBuffer (HWDBG_INSTANCE_INFORMATION *InstanceInfo, SYMBOL *SymbolBuffer, size_t SymbolBufferLength, UINT32 NumberOfStages, HWDBG_SHORT_SYMBOL **NewShortSymbolBuffer, size_t *NewBufferSize)
	Function to compress the buffer.
BOOLEAN	HwdbgInterpreterCompressBuffer (UINT64 *Buffer, size_t BufferLength, UINT32 ScriptVariableLength, UINT32 BramDataWidth, size_t *NewBufferSize, size_t *NumberOfBytesPerChunk)
	Function to compress the buffer.
VOID	HwdbgInterpreterShowScriptCapabilities (HWDBG_INSTANCE_INFORMATION *InstanceInfo)
	Shows the script capablities of the target debuggee.
BOOLEAN	HwdbgInterpreterCheckScriptBufferWithScriptCapabilities (HWDBG_INSTANCE_INFORMATION *InstanceInfo, PVOID ScriptBuffer, UINT32 CountOfScriptSymbolChunks, UINT32 *NumberOfStages, UINT32 *NumberOfOperands)
	Check the script capablities with the target script buffer.
BOOLEAN	HwdbgInterpreterSendPacketAndBufferToHwdbg (HWDBG_INSTANCE_INFORMATION *InstanceInfo, const TCHAR *FileName, DEBUGGER_REMOTE_PACKET_TYPE PacketType, HWDBG_ACTION_ENUMS RequestedAction, CHAR *Buffer, UINT32 BufferLength)
	Sends a HyperDbg packet + a buffer to the hwdbg.
BOOLEAN	HwdbgInterpreterSendScriptPacket (HWDBG_INSTANCE_INFORMATION *InstanceInfo, const TCHAR *FileName, UINT32 NumberOfSymbols, HWDBG_SHORT_SYMBOL *Buffer, UINT32 BufferLength)
	Sends a HyperDbg script packet to the hwdbg.

Detailed Description

Headers for the interpreter of hwdbg packets and requests.

Author

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

Version

1.0

Date

2024-06-11

Copyright

This project is released under the GNU Public License v3.

Macro Definition Documentation

HWDBG_TEST_READ_INSTANCE_INFO_PATH

#define HWDBG_TEST_READ_INSTANCE_INFO_PATH   "..\\..\\..\\..\\hwdbg\\sim\\hwdbg\\DebuggerModuleTestingBRAM\\bram_instance_info.txt"

Path to read the sample of the instance info.

HWDBG_TEST_WRITE_INSTANCE_INFO_PATH

#define HWDBG_TEST_WRITE_INSTANCE_INFO_PATH   "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\instance_info.hex.txt"

Path to write the sample of the instance info requests.

HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH

#define HWDBG_TEST_WRITE_SCRIPT_BUFFER_PATH   "..\\..\\..\\..\\hwdbg\\src\\test\\bram\\script_buffer.hex.txt"

Path to write the sample of the script buffer.

Function Documentation

HwdbgInterpreterCheckScriptBufferWithScriptCapabilities()

BOOLEAN HwdbgInterpreterCheckScriptBufferWithScriptCapabilities	(	HWDBG_INSTANCE_INFORMATION *	InstanceInfo,
		PVOID	ScriptBuffer,
		UINT32	CountOfScriptSymbolChunks,
		UINT32 *	NumberOfStages,
		UINT32 *	NumberOfOperands )

Check the script capablities with the target script buffer.

Parameters

InstanceInfo
ScriptBuffer
CountOfScriptSymbolChunks
NumberOfStages
NumberOfOperands

Returns

BOOLEAN TRUE if the script capablities support the script, otherwise FALSE

{
    BOOLEAN  NotSupported = FALSE;
    SYMBOL * SymbolArray  = (SYMBOL *)ScriptBuffer;
 
    UINT32 Stages              = 0;
    UINT32 Operands            = 0;
    UINT32 NumberOfGetOperands = 0;
    UINT32 NumberOfSetOperands = 0;
 
    for (size_t i = 0; i < CountOfScriptSymbolChunks; i++)
    {
        if (SymbolArray[i].Type != SYMBOL_SEMANTIC_RULE_TYPE)
        {
            //
            // *** For operands ***
            //
            Operands++;
            ShowMessages("  \t%d. found a non-semnatic rule (operand) | type: 0x%x, value: 0x%x\n", i, SymbolArray[i].Type, SymbolArray[i].Value);
 
            //
            // Validate the operand
            //
            switch (SymbolArray[i].Type)
            {
            case SYMBOL_GLOBAL_ID_TYPE:
            case SYMBOL_LOCAL_ID_TYPE:
 
                if (!InstanceInfo->scriptCapabilities.assign_local_global_var)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, global/local variable assignment is not supported\n");
                }
 
                if (SymbolArray[i].Value >= InstanceInfo->numberOfSupportedLocalAndGlobalVariables)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, global/local variable index is out of range of supported by this instance of hwdbg\n");
                }
 
                break;
 
            case SYMBOL_UNDEFINED:
            case SYMBOL_NUM_TYPE:
 
                //
                // No need to check
                //
                break;
 
            case SYMBOL_REGISTER_TYPE:
 
                if (!InstanceInfo->scriptCapabilities.assign_registers)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, register assignment is not supported\n");
                }
                break;
 
            case SYMBOL_PSEUDO_REG_TYPE:
 
                if (!InstanceInfo->scriptCapabilities.assign_pseudo_registers)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, pseudo register index is not supported\n");
                }
                break;
 
            case SYMBOL_TEMP_TYPE:
 
                if (!InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, temporary variables (for conditional statement) is not supported\n");
                }
 
                if (SymbolArray[i].Value >= InstanceInfo->numberOfSupportedTemporaryVariables)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, temp variable index (number of operands for conditional statements) is out of range of supported by this instance of hwdbg\n");
                }
 
                break;
 
            default:
 
                NotSupported = TRUE;
                ShowMessages("err, unknown operand type: %d (0x%x)\n", SymbolArray[i].Type, SymbolArray[i].Type);
                break;
            }
        }
        else
        {
            //
            // *** For operators ***
            //
            Stages++;
            ShowMessages("- %d. found a semnatic rule (operator) | type: 0x%x, value: 0x%x\n", i, SymbolArray[i].Type, SymbolArray[i].Value);
 
            if (ScriptEngineFuncNumberOfOperands(SymbolArray[i].Type, &NumberOfGetOperands, &NumberOfSetOperands) == FALSE)
            {
                NotSupported = TRUE;
                ShowMessages("err, unknown operand type for the operator (0x%x)\n",
                             SymbolArray[i].Type);
 
                return FALSE;
            }
 
            //
            // Validate the operator
            //
            switch (SymbolArray[i].Value)
            {
            case FUNC_OR:
                if (!InstanceInfo->scriptCapabilities.func_or)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, OR is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_XOR:
                if (!InstanceInfo->scriptCapabilities.func_xor)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, XOR is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_AND:
                if (!InstanceInfo->scriptCapabilities.func_and)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, AND is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_ASR:
                if (!InstanceInfo->scriptCapabilities.func_asr)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, arithmetic shift right is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_ASL:
                if (!InstanceInfo->scriptCapabilities.func_asl)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, arithmetic shift left is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_ADD:
                if (!InstanceInfo->scriptCapabilities.func_add)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, addition is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_SUB:
                if (!InstanceInfo->scriptCapabilities.func_sub)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, subtraction is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_MUL:
                if (!InstanceInfo->scriptCapabilities.func_mul)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, multiplication is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_DIV:
                if (!InstanceInfo->scriptCapabilities.func_div)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, division is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_MOD:
                if (!InstanceInfo->scriptCapabilities.func_mod)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, modulus is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_GT:
 
                if (!InstanceInfo->scriptCapabilities.func_gt ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, greater than is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_LT:
                if (!InstanceInfo->scriptCapabilities.func_lt ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, less than is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_EGT:
                if (!InstanceInfo->scriptCapabilities.func_egt ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, greater than or equal to is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_ELT:
                if (!InstanceInfo->scriptCapabilities.func_elt ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, less than or equal to is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_EQUAL:
                if (!InstanceInfo->scriptCapabilities.func_equal ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, equal is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_NEQ:
                if (!InstanceInfo->scriptCapabilities.func_neq ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, not equal is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_JMP:
                if (!InstanceInfo->scriptCapabilities.func_jmp ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, jump is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_JZ:
                if (!InstanceInfo->scriptCapabilities.func_jz ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, jump if zero is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_JNZ:
                if (!InstanceInfo->scriptCapabilities.func_jnz ||
                    !InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, jump if not zero is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_MOV:
                if (!InstanceInfo->scriptCapabilities.func_mov)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, move is not supported by the debuggee\n");
                }
                break;
 
            case FUNC_PRINTF:
                if (!InstanceInfo->scriptCapabilities.func_printf)
                {
                    NotSupported = TRUE;
                    ShowMessages("err, printf is not supported by the debuggee\n");
                }
                break;
 
            default:
 
                NotSupported = TRUE;
                ShowMessages("err, undefined operator for hwdbg: %d (0x%x)\n",
                             SymbolArray[i].Type,
                             SymbolArray[i].Type);
 
                break;
            }
        }
    }
 
    //
    // Set the number of stages
    //
    *NumberOfStages = Stages;
 
    //
    // Set the number of operands
    //
    *NumberOfOperands = Operands;
 
    //
    // Script capabilities support this buffer
    //
    if (NotSupported)
    {
        return FALSE;
    }
    else
    {
        return TRUE;
    }
}

HwdbgInterpreterCompressBuffer()

BOOLEAN HwdbgInterpreterCompressBuffer	(	UINT64 *	Buffer,
		size_t	BufferLength,
		UINT32	ScriptVariableLength,
		UINT32	BramDataWidth,
		size_t *	NewBufferSize,
		size_t *	NumberOfBytesPerChunk )

Function to compress the buffer.

Parameters

Buffer
BufferLength
ScriptVariableLength
BramDataWidth
NewBufferSize
NumberOfBytesPerChunk

Returns

BOOLEAN

{
    if (ScriptVariableLength <= 7 || ScriptVariableLength > 64)
    {
        ShowMessages("err, invalid bit size, it should be between 7 and 64\n");
        return FALSE;
    }
 
    if (ScriptVariableLength > BramDataWidth)
    {
        ShowMessages("err, script variable length cannot be more than the BRAM data width\n");
        return FALSE;
    }
 
    //
    // Calculate the number of 64-bit chunks
    //
    size_t NumberOfChunks = BufferLength / sizeof(UINT64);
 
    //
    // Calculate the number of bytes needed for the new compressed buffer
    //
    size_t NewBytesPerChunk = (BramDataWidth + 7) / 8; // ceil(BramDataWidth / 8)
    *NumberOfBytesPerChunk  = NewBytesPerChunk;
 
    *NewBufferSize = NumberOfChunks * NewBytesPerChunk;
 
    //
    // Create a temporary buffer to hold the compressed data
    //
    UINT8 * TempBuffer = (UINT8 *)malloc(*NewBufferSize);
 
    if (TempBuffer == NULL)
    {
        ShowMessages("err, memory allocation failed\n");
        return FALSE;
    }
 
    //
    // Compress each chunk and store it in the temporary buffer
    //
    for (size_t i = 0; i < NumberOfChunks; ++i)
    {
        uint64_t Chunk = Buffer[i];
        for (size_t j = 0; j < NewBytesPerChunk; ++j)
        {
            TempBuffer[i * NewBytesPerChunk + j] = (uint8_t)((Chunk >> (j * 8)) & 0xFF);
        }
    }
 
    //
    // Copy the compressed data back to the original buffer
    //
    RtlZeroMemory(Buffer, BufferLength);
    memcpy(Buffer, TempBuffer, *NewBufferSize);
 
    //
    // Free the temporary buffer
    //
    free(TempBuffer);
 
    return TRUE;
}

HwdbgInterpreterConvertSymbolToHwdbgShortSymbolBuffer()

BOOLEAN HwdbgInterpreterConvertSymbolToHwdbgShortSymbolBuffer	(	HWDBG_INSTANCE_INFORMATION *	InstanceInfo,
		SYMBOL *	SymbolBuffer,
		size_t	SymbolBufferLength,
		UINT32	NumberOfStages,
		HWDBG_SHORT_SYMBOL **	NewShortSymbolBuffer,
		size_t *	NewBufferSize )

Function to compress the buffer.

Parameters

InstanceInfo
SymbolBuffer
SymbolBufferLength
NumberOfStages
NewShortSymbolBuffer
NewBufferSize

Returns

BOOLEAN

{
    //
    // Check if the instance info is valid
    //
    if (!g_HwdbgInstanceInfoIsValid)
    {
        ShowMessages("err, instance info is not valid\n");
        return FALSE;
    }
 
    //
    // Compute the number of symbol operators
    //
    UINT32 NumberOfOperands = InstanceInfo->maximumNumberOfSupportedGetScriptOperators + InstanceInfo->maximumNumberOfSupportedSetScriptOperators;
 
    SIZE_T NumberOfSymbols = SymbolBufferLength / sizeof(SymbolBuffer[0]);
 
    *NewBufferSize = NumberOfStages * (NumberOfOperands + 1) * sizeof(HWDBG_SHORT_SYMBOL); // number of stage + maximum number of operands
 
    //
    // Create a temporary buffer to hold the compressed data
    //
    HWDBG_SHORT_SYMBOL * HwdbgShortSymbolBuffer = (HWDBG_SHORT_SYMBOL *)malloc(*NewBufferSize);
 
    if (!HwdbgShortSymbolBuffer)
    {
        ShowMessages("err, could not allocate compression buffer\n");
        return FALSE;
    }
 
    //
    // Zeroing the short symbol buffer
    //
    RtlZeroMemory(HwdbgShortSymbolBuffer, *NewBufferSize);
 
    //
    // Filling the short symbol buffer from original buffer
    //
    UINT32 IndexOfShortSymbolBuffer = 0;
 
    for (UINT32 i = 0; i < NumberOfSymbols; i++)
    {
        if (SymbolBuffer[i].Type == SYMBOL_SEMANTIC_RULE_TYPE)
        {
            //
            // *** This is an operator ***
            //
 
            //
            // Move the symbol buffer into a short symbol buffer
            //
            HwdbgShortSymbolBuffer[IndexOfShortSymbolBuffer].Type  = SymbolBuffer[i].Type;
            HwdbgShortSymbolBuffer[IndexOfShortSymbolBuffer].Value = SymbolBuffer[i].Value;
 
            //
            // Now we read the number of operands (SET and GET)
            //
            UINT32 NumberOfGetOperands = 0;
            UINT32 NumberOfSetOperands = 0;
 
            if (!FuncGetNumberOfOperands(SymbolBuffer[i].Value, &NumberOfGetOperands, &NumberOfSetOperands))
            {
                ShowMessages("err, unknown operand type for the operator (0x%x)\n",
                             SymbolBuffer[i].Value);
 
                free(HwdbgShortSymbolBuffer);
                return FALSE;
            }
 
            //
            // Check if the number of GET operands is more than the maximum supported GET operands
            //
            if (NumberOfGetOperands > InstanceInfo->maximumNumberOfSupportedGetScriptOperators)
            {
                ShowMessages("err, the number of get operands is more than the maximum supported get operands\n");
                free(HwdbgShortSymbolBuffer);
                return FALSE;
            }
 
            //
            // Check if the number of SET operands is more than the maximum supported SET operands
            //
            if (NumberOfSetOperands > InstanceInfo->maximumNumberOfSupportedSetScriptOperators)
            {
                ShowMessages("err, the number of set operands is more than the maximum supported set operands\n");
                free(HwdbgShortSymbolBuffer);
                return FALSE;
            }
 
            //
            // *** Now we need to fill operands (GET) ***
            //
            for (size_t j = 0; j < NumberOfGetOperands; j++)
            {
                i++;
                IndexOfShortSymbolBuffer++;
 
                if (SymbolBuffer[i].Type == SYMBOL_SEMANTIC_RULE_TYPE)
                {
                    ShowMessages("err, not expecting a semantic rule at operand: %x\n", SymbolBuffer[i].Value);
                    free(HwdbgShortSymbolBuffer);
                    return FALSE;
                }
 
                //
                // Move the symbol buffer into a short symbol buffer
                //
                HwdbgShortSymbolBuffer[IndexOfShortSymbolBuffer].Type  = SymbolBuffer[i].Type;
                HwdbgShortSymbolBuffer[IndexOfShortSymbolBuffer].Value = SymbolBuffer[i].Value;
            }
 
            //
            // Leave empty space for GET operands that are not used for this operator
            //
            IndexOfShortSymbolBuffer = IndexOfShortSymbolBuffer + InstanceInfo->maximumNumberOfSupportedGetScriptOperators - NumberOfGetOperands;
 
            //
            // *** Now we need to fill operands (SET) ***
            //
            for (size_t j = 0; j < NumberOfSetOperands; j++)
            {
                i++;
                IndexOfShortSymbolBuffer++;
 
                if (SymbolBuffer[i].Type == SYMBOL_SEMANTIC_RULE_TYPE)
                {
                    ShowMessages("err, not expecting a semantic rule at operand: %x\n", SymbolBuffer[i].Value);
                    free(HwdbgShortSymbolBuffer);
                    return FALSE;
                }
 
                //
                // Move the symbol buffer into a short symbol buffer
                //
                HwdbgShortSymbolBuffer[IndexOfShortSymbolBuffer].Type  = SymbolBuffer[i].Type;
                HwdbgShortSymbolBuffer[IndexOfShortSymbolBuffer].Value = SymbolBuffer[i].Value;
            }
 
            //
            // Leave empty space for SET operands that are not used for this operator
            //
            IndexOfShortSymbolBuffer = IndexOfShortSymbolBuffer + InstanceInfo->maximumNumberOfSupportedSetScriptOperators - NumberOfSetOperands;
 
            //
            // Increment the index of the short symbol buffer
            //
            IndexOfShortSymbolBuffer++;
        }
        else
        {
            //
            // Error, we are not expecting a non-semantic rule here
            //
            ShowMessages("err, not expecting a non-semantic rule at: %x\n", SymbolBuffer[i].Type);
            free(HwdbgShortSymbolBuffer);
            return FALSE;
        }
    }
 
    //
    // Set the new short symbol buffer address
    //
    *NewShortSymbolBuffer = (HWDBG_SHORT_SYMBOL *)HwdbgShortSymbolBuffer;
 
    return TRUE;
}

HwdbgInterpreterFillFileFromMemory()

BOOLEAN HwdbgInterpreterFillFileFromMemory	(	HWDBG_INSTANCE_INFORMATION *	InstanceInfo,
		const TCHAR *	FileName,
		UINT32 *	MemoryBuffer,
		size_t	BufferSize,
		HWDBG_ACTION_ENUMS	RequestedAction )

Function to write the memory buffer to a file in the specified format.

Parameters

InstanceInfo
FileName
MemoryBuffer
BufferSize
RequestedAction

Returns

BOOLEAN

{
    std::ofstream File(FileName);
 
    if (!File.is_open())
    {
        printf("err, unable to open file %s\n", FileName);
        return FALSE;
    }
 
    size_t Address = 0;
    for (size_t I = 0; I < BufferSize / sizeof(UINT32); ++I)
    {
        File << std::hex << std::setw(8) << std::setfill('0') << MemoryBuffer[I];
        File << " ; +0x" << std::hex << std::setw(1) << std::setfill('0') << Address;
 
        if (I == 0)
        {
            File << "   | Checksum";
        }
        else if (I == 1)
        {
            File << "   | Checksum";
        }
        else if (I == 2)
        {
            File << "   | Indicator";
        }
        else if (I == 3)
        {
            File << "   | Indicator";
        }
        else if (I == 4)
        {
            File << "  | TypeOfThePacket - DEBUGGER_TO_DEBUGGEE_HARDWARE_LEVEL (0x4)";
        }
        else if (I == 5)
        {
            File << "  | RequestedActionOfThePacket - Value" << " (0x" << std::hex << std::setw(1) << std::setfill('0') << RequestedAction << ")";
        }
        else if (I == 6)
        {
            File << "  | Start of Optional Data";
        }
 
        File << "\n";
        Address += 4;
    }
 
    //
    // Add zeros to the end of the file to fill the shared memory
    //
    if (g_HwdbgInstanceInfoIsValid)
    {
        while (Address < InstanceInfo->sharedMemorySize)
        {
            File << "00000000 ; +0x" << std::hex << std::setw(1) << std::setfill('0') << Address;
            Address += 4;
 
            if (Address < InstanceInfo->sharedMemorySize)
            {
                File << "\n";
            }
        }
    }
 
    //
    // Close the file
    //
    File.close();
 
    return TRUE;
}

HwdbgInterpreterFillMemoryFromFile()

BOOLEAN HwdbgInterpreterFillMemoryFromFile	(	const TCHAR *	FileName,
		UINT32 *	MemoryBuffer,
		size_t	BufferSize )

Function to read the file and fill the memory buffer.

Parameters

FileName
MemoryBuffer
BufferSize

Returns

BOOLEAN

{
    std::ifstream File(FileName);
    std::string   Line;
    BOOLEAN       Result = TRUE;
    size_t        Index  = 0;
 
    if (!File.is_open())
    {
        ShowMessages("err, unable to open file %s\n", FileName);
        return FALSE;
    }
 
    while (getline(File, Line))
    {
        if (Index >= BufferSize)
        {
            Result = FALSE;
            ShowMessages("err, buffer overflow, file contains more data than buffer can hold\n");
            break;
        }
 
        vector<UINT32> Values = ParseLine(Line);
 
        for (UINT32 Value : Values)
        {
            if (Index < BufferSize)
            {
                MemoryBuffer[Index++] = Value;
            }
            else
            {
                ShowMessages("err, buffer overflow, file contains more data than buffer can hold\n");
                File.close();
                return FALSE;
            }
        }
    }
 
    File.close();
    return Result;
}

HwdbgInterpreterSendPacketAndBufferToHwdbg()

BOOLEAN HwdbgInterpreterSendPacketAndBufferToHwdbg	(	HWDBG_INSTANCE_INFORMATION *	InstanceInfo,
		const TCHAR *	FileName,
		DEBUGGER_REMOTE_PACKET_TYPE	PacketType,
		HWDBG_ACTION_ENUMS	RequestedAction,
		CHAR *	Buffer,
		UINT32	BufferLength )

Sends a HyperDbg packet + a buffer to the hwdbg.

Parameters

InstanceInfo
FileName
PacketType
RequestedAction
Buffer
BufferLength

Returns

BOOLEAN

{
    DEBUGGER_REMOTE_PACKET Packet          = {0};
    SIZE_T                 CommandMaxSize  = 0;
    SIZE_T                 FinalBufferSize = 0;
 
    if (g_HwdbgInstanceInfoIsValid)
    {
        CommandMaxSize = InstanceInfo->debuggeeAreaOffset - InstanceInfo->debuggerAreaOffset;
    }
    else
    {
        //
        // Use default limitation
        //
        CommandMaxSize = DEFAULT_INITIAL_DEBUGGEE_TO_DEBUGGER_OFFSET - DEFAULT_INITIAL_DEBUGGER_TO_DEBUGGEE_OFFSET;
    }
 
    //
    // If buffer is not available, then the length is zero
    //
    if (Buffer == NULL)
    {
        BufferLength = 0;
    }
 
    //
    // Compute the final buffer size
    //
    FinalBufferSize = sizeof(DEBUGGER_REMOTE_PACKET) + BufferLength;
 
    //
    // Check if buffer not pass the boundary
    //
    if (FinalBufferSize > CommandMaxSize)
    {
        ShowMessages("err, buffer is above the maximum buffer size that can be sent to hwdbg (%d > %d)\n",
                     FinalBufferSize,
                     CommandMaxSize);
 
        return FALSE;
    }
 
    //
    // Make the packet's structure
    //
    Packet.Indicator       = INDICATOR_OF_HYPERDBG_PACKET;
    Packet.TypeOfThePacket = PacketType;
 
    //
    // Set the requested action
    //
    Packet.RequestedActionOfThePacket = (DEBUGGER_REMOTE_PACKET_REQUESTED_ACTION)RequestedAction;
 
    //
    // calculate checksum of the packet
    //
    Packet.Checksum =
        KdComputeDataChecksum((PVOID)((UINT64)&Packet + 1),
                              sizeof(DEBUGGER_REMOTE_PACKET) - sizeof(BYTE));
 
    if (Buffer != NULL)
    {
        Packet.Checksum += KdComputeDataChecksum((PVOID)Buffer, BufferLength);
    }
 
    //
    // If there is an offset for debugger to debuggee command, we'll apply it here
    //
    if (g_HwdbgInstanceInfoIsValid)
    {
        FinalBufferSize += InstanceInfo->debuggerAreaOffset;
    }
    else
    {
        FinalBufferSize += DEFAULT_INITIAL_DEBUGGER_TO_DEBUGGEE_OFFSET;
    }
 
    //
    // Allocate a buffer for storing the header packet + buffer (if not empty)
    //
    CHAR * FinalBuffer = (CHAR *)malloc(FinalBufferSize);
 
    if (!FinalBuffer)
    {
        return FALSE;
    }
 
    RtlZeroMemory(FinalBuffer, FinalBufferSize);
 
    //
    // Leave the offset
    //
    SIZE_T Offset = g_HwdbgInstanceInfoIsValid ? InstanceInfo->debuggerAreaOffset : DEFAULT_INITIAL_DEBUGGER_TO_DEBUGGEE_OFFSET;
 
    //
    // Copy the packet into the FinalBuffer
    //
    memcpy(FinalBuffer + Offset, &Packet, sizeof(DEBUGGER_REMOTE_PACKET));
 
    //
    // Copy the buffer (if available) into the FinalBuffer
    //
    if (Buffer != NULL)
    {
        memcpy(FinalBuffer + Offset + sizeof(DEBUGGER_REMOTE_PACKET), Buffer, BufferLength);
    }
 
    //
    // Here you would send FinalBuffer to the hardware debugger
    //
    HwdbgInterpreterFillFileFromMemory(InstanceInfo, FileName, (UINT32 *)FinalBuffer, FinalBufferSize, RequestedAction);
 
    //
    // Free the allocated memory after use
    //
    free(FinalBuffer);
 
    return TRUE;
}

HwdbgInterpreterSendScriptPacket()

BOOLEAN HwdbgInterpreterSendScriptPacket	(	HWDBG_INSTANCE_INFORMATION *	InstanceInfo,
		const TCHAR *	FileName,
		UINT32	NumberOfSymbols,
		HWDBG_SHORT_SYMBOL *	Buffer,
		UINT32	BufferLength )

Sends a HyperDbg script packet to the hwdbg.

Parameters

InstanceInfo
FileName
Buffer
BufferLength

Returns

BOOLEAN

{
    HWDBG_SCRIPT_BUFFER ScriptBuffer = {0};
    BOOLEAN             Result       = FALSE;
 
    //
    // Make the packet's structure
    //
    ScriptBuffer.scriptNumberOfSymbols = NumberOfSymbols;
 
    //
    // Allocate a buffer for storing the header packet + buffer (if not empty)
    //
    CHAR * FinalBuffer = (CHAR *)malloc(BufferLength + sizeof(HWDBG_SCRIPT_BUFFER));
 
    if (!FinalBuffer)
    {
        return FALSE;
    }
 
    RtlZeroMemory(FinalBuffer, BufferLength + sizeof(HWDBG_SCRIPT_BUFFER));
 
    //
    // Copy the packet into the FinalBuffer
    //
    memcpy(FinalBuffer, &ScriptBuffer, sizeof(HWDBG_SCRIPT_BUFFER));
 
    //
    // Copy the buffer (if available) into the FinalBuffer
    //
    if (Buffer != NULL)
    {
        memcpy(FinalBuffer + sizeof(HWDBG_SCRIPT_BUFFER), Buffer, BufferLength);
    }
 
    //
    // Here we would send FinalBuffer to the hardware debugger
    //
    Result = HwdbgInterpreterSendPacketAndBufferToHwdbg(
        InstanceInfo,
        FileName,
        DEBUGGER_REMOTE_PACKET_TYPE_DEBUGGER_TO_DEBUGGEE_HARDWARE_LEVEL,
        hwdbgActionConfigureScriptBuffer,
        FinalBuffer,
        BufferLength + sizeof(HWDBG_SCRIPT_BUFFER));
 
    //
    // Free the allocated memory after use
    //
    free(FinalBuffer);
 
    return Result;
}

HwdbgInterpreterShowScriptCapabilities()

VOID HwdbgInterpreterShowScriptCapabilities

(

HWDBG_INSTANCE_INFORMATION *

InstanceInfo

)

Shows the script capablities of the target debuggee.

Parameters

InstanceInfo

Returns

VOID

{
    ShowMessages("\nThis debuggee supports the following operatiors:\n");
    ShowMessages("\tlocal and global variable assignments: %s (maximum number of var: %d) \n",
                 InstanceInfo->scriptCapabilities.assign_local_global_var ? "supported" : "not supported",
                 InstanceInfo->numberOfSupportedLocalAndGlobalVariables);
    ShowMessages("\tregisters (pin/ports) assignment: %s \n",
                 InstanceInfo->scriptCapabilities.assign_registers ? "supported" : "not supported");
    ShowMessages("\tpseudo-registers assignment: %s \n",
                 InstanceInfo->scriptCapabilities.assign_pseudo_registers ? "supported" : "not supported");
    ShowMessages("\tconditional statements and comparison operators: %s \n",
                 InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators ? "supported" : "not supported");
 
    ShowMessages("\tor: %s \n", InstanceInfo->scriptCapabilities.func_or ? "supported" : "not supported");
    ShowMessages("\txor: %s \n", InstanceInfo->scriptCapabilities.func_xor ? "supported" : "not supported");
    ShowMessages("\tand: %s \n", InstanceInfo->scriptCapabilities.func_and ? "supported" : "not supported");
    ShowMessages("\tarithmetic shift right: %s \n", InstanceInfo->scriptCapabilities.func_asr ? "supported" : "not supported");
    ShowMessages("\tarithmetic shift left: %s \n", InstanceInfo->scriptCapabilities.func_asl ? "supported" : "not supported");
    ShowMessages("\taddition: %s \n", InstanceInfo->scriptCapabilities.func_add ? "supported" : "not supported");
    ShowMessages("\tsubtraction: %s \n", InstanceInfo->scriptCapabilities.func_sub ? "supported" : "not supported");
    ShowMessages("\tmultiplication: %s \n", InstanceInfo->scriptCapabilities.func_mul ? "supported" : "not supported");
    ShowMessages("\tdivision: %s \n", InstanceInfo->scriptCapabilities.func_div ? "supported" : "not supported");
    ShowMessages("\tmodulus: %s \n", InstanceInfo->scriptCapabilities.func_mod ? "supported" : "not supported");
 
    ShowMessages("\tgreater than: %s \n",
                 (InstanceInfo->scriptCapabilities.func_gt && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tless than: %s \n",
                 (InstanceInfo->scriptCapabilities.func_lt && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tgreater than or equal to: %s \n",
                 (InstanceInfo->scriptCapabilities.func_egt && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tless than or equal to: %s \n",
                 (InstanceInfo->scriptCapabilities.func_elt && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tequal: %s \n",
                 (InstanceInfo->scriptCapabilities.func_equal && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tnot equal: %s \n",
                 (InstanceInfo->scriptCapabilities.func_neq && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tjump: %s \n",
                 (InstanceInfo->scriptCapabilities.func_jmp && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tjump if zero: %s \n",
                 (InstanceInfo->scriptCapabilities.func_jz && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tjump if not zero: %s \n",
                 (InstanceInfo->scriptCapabilities.func_jnz && InstanceInfo->scriptCapabilities.conditional_statements_and_comparison_operators) ? "supported" : "not supported");
    ShowMessages("\tmove: %s \n", InstanceInfo->scriptCapabilities.func_mov ? "supported" : "not supported");
    ShowMessages("\tprintf: %s \n", InstanceInfo->scriptCapabilities.func_printf ? "supported" : "not supported");
    ShowMessages("\n");
}

HwdbgInterpretPacket()

BOOLEAN HwdbgInterpretPacket	(	PVOID	BufferReceived,
		UINT32	LengthReceived )

Interpret packets of hwdbg.

Parameters

BufferReceived
LengthReceived

Returns

BOOLEAN

{
    PHWDBG_INSTANCE_INFORMATION InstanceInfoPacket;
    PUINT32                     InstanceInfoPorts;
    DEBUGGER_REMOTE_PACKET *    TheActualPacket = NULL;
    BOOLEAN                     Result          = FALSE;
 
    //
    // Apply the initial offset
    //
    if (g_HwdbgInstanceInfoIsValid)
    {
        //
        // Use the debuggee's preferred offset (area) since the instance info
        // already received and interpreted
        //
        TheActualPacket = (DEBUGGER_REMOTE_PACKET *)(((CHAR *)BufferReceived) + g_HwdbgInstanceInfo.debuggeeAreaOffset);
    }
    else
    {
        //
        // Use default initial offset as there is no information (instance info)
        // from debuggee
        //
        TheActualPacket = (DEBUGGER_REMOTE_PACKET *)(((CHAR *)BufferReceived) + DEFAULT_INITIAL_DEBUGGEE_TO_DEBUGGER_OFFSET);
    }
 
    if (TheActualPacket->Indicator == INDICATOR_OF_HYPERDBG_PACKET)
    {
        //
        // Check checksum (for hwdbg, checksum is ignored)
        //
        // if (KdComputeDataChecksum((PVOID)&TheActualPacket->Indicator,
        //                           LengthReceived - sizeof(BYTE)) != TheActualPacket->Checksum)
        // {
        //     ShowMessages("err, checksum is invalid\n");
        //     return FALSE;
        // }
 
        //
        // Check if the packet type is correct
        //
        if (TheActualPacket->TypeOfThePacket != DEBUGGER_REMOTE_PACKET_TYPE_DEBUGGEE_TO_DEBUGGER_HARDWARE_LEVEL)
        {
            //
            // sth wrong happened, the packet is not belonging to use
            // for hwdbg interpreter
            //
            ShowMessages("err, unknown packet received from the debuggee\n");
            return FALSE;
        }
 
        //
        // It's a HyperDbg packet (for hwdbg)
        //
        switch (TheActualPacket->RequestedActionOfThePacket)
        {
        case hwdbgResponseSuccessOrErrorMessage:
 
            Result = TRUE;
 
            //
            // Todo: implement it
            //
 
            break;
 
        case hwdbgResponseInstanceInfo:
 
            Result             = TRUE;
            InstanceInfoPacket = (HWDBG_INSTANCE_INFORMATION *)(((CHAR *)TheActualPacket) + sizeof(DEBUGGER_REMOTE_PACKET));
            InstanceInfoPorts  = (UINT32 *)(((CHAR *)InstanceInfoPacket) + sizeof(HWDBG_INSTANCE_INFORMATION));
 
            //
            // Copy the instance info into the global hwdbg instance info
            //
            RtlCopyMemory(&g_HwdbgInstanceInfo, InstanceInfoPacket, sizeof(HWDBG_INSTANCE_INFORMATION));
 
            //
            // Instance info is valid from now
            //
            g_HwdbgInstanceInfoIsValid = TRUE;
 
            //
            // Read port arrangements
            //
            for (size_t i = 0; i < g_HwdbgInstanceInfo.numberOfPorts; i++)
            {
                g_HwdbgPortConfiguration.push_back(InstanceInfoPorts[i]);
            }
 
            //
            // Infom the script engine about the instance info
            //
            ScriptEngineSetHwdbgInstanceInfo(&g_HwdbgInstanceInfo);
 
            break;
 
        default:
 
            Result = FALSE;
            ShowMessages("err, unknown packet request received from the debuggee\n");
 
            break;
        }
    }
 
    //
    // Packet handled successfully
    //
    return Result;
}