HyperDbg Debugger
Loading...
Searching...
No Matches
Definition.h File Reference

Header files for global definitions. More...

Go to the source code of this file.

Macros

#define CONFIG_FILE_NAME   L"config.ini"
 Config file name for HyperDbg.
#define VMM_DRIVER_NAME   "hyperhv"
 name of HyperDbg's VMM driver
#define KERNEL_DEBUGGER_DRIVER_NAME   "hyperkd"
 name of HyperDbg's debugger driver
#define KERNEL_DEBUGGER_DRIVER_NAME_AND_EXTENSION   "hyperkd.sys"
 name of HyperDbg's debugger driver + extension
#define TEST_DEFAULT_NAMED_PIPE   "\\\\.\\pipe\\HyperDbgPipe"
 Default named pipe name for communication between debugger and debuggee process.
#define TEST_CASE_MAXIMUM_BUFFERS_TO_COMMUNICATE   0x1000
 Maximum buffer to communicate between debugger and debuggee process.
#define MAX_HWDBG_TESTING_PIN_COUNT   500
 Maximum hwdbg testing pins count (for emulating the script behavior).
#define COMMAND_PARSER_TEST_CASES_FILE   "..\\..\\..\\tests\\command-parser\\command-parser-testcases.txt"
 Test cases file name for command parser.
#define TEST_HWDBG_FUNCTIONALITIES   "test-hwdbg-functionalities"
 Test case parameter for testing main command parser.
#define TEST_CASE_PARAMETER_FOR_MAIN_COMMAND_PARSER   "test-command-parser"
 Test case parameter for testing main command parser.
#define TEST_CASE_PARAMETER_FOR_PE_PARSER   "test-pe-parser"
 Test case parameter for testing PE parser.
#define TEST_CASE_PARAMETER_FOR_CODEVIEW_RSDS_PARSER   "test-codeview-rsds-parser"
 Test case parameter for testing CodeView RSDS parser.
#define TEST_CASE_PARAMETER_FOR_SCRIPT_SEMANTIC_TEST_CASES   "test-script-semantic-test-cases"
 Test case parameter for testing semantic script tests.
#define SCRIPT_ENGINE_TEST_CASES_DIRECTORY   "script-test-cases"
 Test cases file name.
#define SCRIPT_SEMANTIC_TEST_CASE_DIRECTORY   "..\\..\\..\\tests\\script-engine-test\\semantic-test-cases"
 Test cases directory name for script semantic tests.
#define HWDBG_SCRIPT_TEST_CASE_CODE_DIRECTORY   "..\\..\\..\\tests\\hwdbg-tests\\scripts\\codes"
 Test cases directory name for hwdbg script (code) tests.
#define HWDBG_SCRIPT_TEST_CASE_COMPILED_SCRIPTS_DIRECTORY   "..\\..\\..\\tests\\hwdbg-tests\\scripts\\compiled-scripts"
 Test cases directory name for hwdbg script (compiled-scripts) tests.
#define HWDBG_SCRIPT_TEST_CASE_SAMPLE_TESTS_DIRECTORY   "..\\..\\..\\tests\\hwdbg-tests\\scripts\\sample-tests"
 Test cases directory name for hwdbg script (sample-tests) tests.
#define DefaultSpeedOfReadingKernelMessages   30
 The speed delay for showing messages from kernel-mode to user-mode in VMI-mode, using a lower value causes the HyperDbg to show messages faster but you should keep in mind, not to eat all of the CPU.

Detailed Description

Header files for global definitions.

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

This file contains definitions that are use in both user mode and kernel mode Means that if you change the following files, structures or enums, then these settings apply to both usermode and kernel mode

Version
0.1
Date
2020-04-10

Macro Definition Documentation

◆ COMMAND_PARSER_TEST_CASES_FILE

#define COMMAND_PARSER_TEST_CASES_FILE   "..\\..\\..\\tests\\command-parser\\command-parser-testcases.txt"

Test cases file name for command parser.

◆ CONFIG_FILE_NAME

#define CONFIG_FILE_NAME   L"config.ini"

Config file name for HyperDbg.

◆ DefaultSpeedOfReadingKernelMessages

#define DefaultSpeedOfReadingKernelMessages   30

The speed delay for showing messages from kernel-mode to user-mode in VMI-mode, using a lower value causes the HyperDbg to show messages faster but you should keep in mind, not to eat all of the CPU.

◆ HWDBG_SCRIPT_TEST_CASE_CODE_DIRECTORY

#define HWDBG_SCRIPT_TEST_CASE_CODE_DIRECTORY   "..\\..\\..\\tests\\hwdbg-tests\\scripts\\codes"

Test cases directory name for hwdbg script (code) tests.

◆ HWDBG_SCRIPT_TEST_CASE_COMPILED_SCRIPTS_DIRECTORY

#define HWDBG_SCRIPT_TEST_CASE_COMPILED_SCRIPTS_DIRECTORY   "..\\..\\..\\tests\\hwdbg-tests\\scripts\\compiled-scripts"

Test cases directory name for hwdbg script (compiled-scripts) tests.

◆ HWDBG_SCRIPT_TEST_CASE_SAMPLE_TESTS_DIRECTORY

#define HWDBG_SCRIPT_TEST_CASE_SAMPLE_TESTS_DIRECTORY   "..\\..\\..\\tests\\hwdbg-tests\\scripts\\sample-tests"

Test cases directory name for hwdbg script (sample-tests) tests.

◆ KERNEL_DEBUGGER_DRIVER_NAME

#define KERNEL_DEBUGGER_DRIVER_NAME   "hyperkd"

name of HyperDbg's debugger driver

◆ KERNEL_DEBUGGER_DRIVER_NAME_AND_EXTENSION

#define KERNEL_DEBUGGER_DRIVER_NAME_AND_EXTENSION   "hyperkd.sys"

name of HyperDbg's debugger driver + extension

◆ MAX_HWDBG_TESTING_PIN_COUNT

#define MAX_HWDBG_TESTING_PIN_COUNT   500

Maximum hwdbg testing pins count (for emulating the script behavior).

◆ SCRIPT_ENGINE_TEST_CASES_DIRECTORY

#define SCRIPT_ENGINE_TEST_CASES_DIRECTORY   "script-test-cases"

Test cases file name.

◆ SCRIPT_SEMANTIC_TEST_CASE_DIRECTORY

#define SCRIPT_SEMANTIC_TEST_CASE_DIRECTORY   "..\\..\\..\\tests\\script-engine-test\\semantic-test-cases"

Test cases directory name for script semantic tests.

◆ TEST_CASE_MAXIMUM_BUFFERS_TO_COMMUNICATE

#define TEST_CASE_MAXIMUM_BUFFERS_TO_COMMUNICATE   0x1000

Maximum buffer to communicate between debugger and debuggee process.

◆ TEST_CASE_PARAMETER_FOR_CODEVIEW_RSDS_PARSER

#define TEST_CASE_PARAMETER_FOR_CODEVIEW_RSDS_PARSER   "test-codeview-rsds-parser"

Test case parameter for testing CodeView RSDS parser.

◆ TEST_CASE_PARAMETER_FOR_MAIN_COMMAND_PARSER

#define TEST_CASE_PARAMETER_FOR_MAIN_COMMAND_PARSER   "test-command-parser"

Test case parameter for testing main command parser.

◆ TEST_CASE_PARAMETER_FOR_PE_PARSER

#define TEST_CASE_PARAMETER_FOR_PE_PARSER   "test-pe-parser"

Test case parameter for testing PE parser.

◆ TEST_CASE_PARAMETER_FOR_SCRIPT_SEMANTIC_TEST_CASES

#define TEST_CASE_PARAMETER_FOR_SCRIPT_SEMANTIC_TEST_CASES   "test-script-semantic-test-cases"

Test case parameter for testing semantic script tests.

◆ TEST_DEFAULT_NAMED_PIPE

#define TEST_DEFAULT_NAMED_PIPE   "\\\\.\\pipe\\HyperDbgPipe"

Default named pipe name for communication between debugger and debuggee process.

◆ TEST_HWDBG_FUNCTIONALITIES

#define TEST_HWDBG_FUNCTIONALITIES   "test-hwdbg-functionalities"

Test case parameter for testing main command parser.

◆ VMM_DRIVER_NAME

#define VMM_DRIVER_NAME   "hyperhv"

name of HyperDbg's VMM driver