HyperDbg Documentation
CommunityDownloadResearchTutorialhwdbg
  • HyperDbg
  • Getting Started
    • Quick Start
    • FAQ
    • Build & Install
    • Attach to HyperDbg
      • Attach to a remote machine
      • Attach to local machine
      • Start a new process
      • Attach to a running process
  • Using HyperDbg
    • Prerequisites
      • Operation Modes
      • How to create a condition?
      • How to create an action?
      • Signatures
    • User-mode Debugging
      • Principles
      • Examples
        • basics
        • events
          • Getting Results of a System-call
    • Kernel-mode Debugging
      • Principles
      • Examples
        • beginning
          • Connecting To HyperDbg
          • Configuring Symbol Server/Path
        • basics
          • Setting Breakpoints & Stepping Instructions
          • Displaying & Editing & Searching Memory
          • Showing & Modifying Registers and Flags
          • Switching to a Specific Process or Thread
          • Mapping Data & Create Structures, and Enums From Symbols
        • events
          • Managing Events
          • Hooking Any Function
          • Intercepting All SYSCALLs
          • Monitoring Accesses To Structures
          • Triggering Special Instructions
          • Identifying System Behavior
        • Scripting Language Examples
    • Software Development Kit (SDK)
      • Events
        • Conditions
        • Actions
      • IOCTL
        • Event Registration
  • Commands
    • Debugging Commands
      • ? (evaluate and execute expressions and scripts in debuggee)
      • ~ (display and change the current operating core)
      • a (assemble virtual address)
      • load (load the kernel modules)
      • unload (unload the kernel modules)
      • status (show the debuggee status)
      • events (show and modify active/disabled events)
      • p (step-over)
      • t (step-in)
      • i (instrumentation step-in)
      • gu (step-out or go up)
      • r (read or modify registers)
      • bp (set breakpoint)
      • bl (list breakpoints)
      • be (enable breakpoints)
      • bd (disable breakpoints)
      • bc (clear and remove breakpoints)
      • g (continue debuggee or processing kernel packets)
      • x (examine symbols and find functions and variables address)
      • db, dc, dd, dq (read virtual memory)
      • eb, ed, eq (edit virtual memory)
      • sb, sd, sq (search virtual memory)
      • u, u64, u2, u32 (disassemble virtual address)
      • k, kd, kq (display stack backtrace)
      • dt (display and map virtual memory to structures)
      • struct (make structures, enums, data types from symbols)
      • sleep (wait for specific time in the .script command)
      • pause (break to the debugger and pause processing kernel packets)
      • print (evaluate and print expression in debuggee)
      • lm (view loaded modules)
      • cpu (check cpu supported technologies)
      • rdmsr (read model-specific register)
      • wrmsr (write model-specific register)
      • flush (remove pending kernel buffers and messages)
      • prealloc (reserve pre-allocated pools)
      • preactivate (pre-activate special functionalities)
      • output (create output source for event forwarding)
      • test (test functionalities)
      • settings (configures different options and preferences)
      • exit (exit from the debugger)
    • Meta Commands
      • .help (show the help of commands)
      • .debug (prepare and connect to debugger)
      • .connect (connect to a session)
      • .disconnect (disconnect from a session)
      • .listen (listen on a port and wait for the debugger to connect)
      • .status (show the debugger status)
      • .start (start a new process)
      • .restart (restart the process)
      • .attach (attach to a process)
      • .detach (detach from the process)
      • .switch (show the list and switch between active debugging processes)
      • .kill (terminate the process)
      • .process, .process2 (show the current process and switch to another process)
      • .thread, .thread2 (show the current thread and switch to another thread)
      • .pagein (bring the page into the RAM)
      • .dump (save the virtual memory into a file)
      • .formats (show number formats)
      • .script (run batch script commands)
      • .sympath (set the symbol server)
      • .sym (load pdb symbols)
      • .pe (parse PE file)
      • .logopen (open log file)
      • .logclose (close log file)
      • .cls (clear the screen)
    • Extension Commands
      • !a (assemble physical address)
      • !pte (display page-level address and entries)
      • !db, !dc, !dd, !dq (read physical memory)
      • !eb, !ed, !eq (edit physical memory)
      • !sb, !sd, !sq (search physical memory)
      • !u, !u64, !u2, !u32 (disassemble physical address)
      • !dt (display and map physical memory to structures)
      • !track (track and map function calls and returns to the symbols)
      • !epthook (hidden hook with EPT - stealth breakpoints)
      • !epthook2 (hidden hook with EPT - detours)
      • !monitor (monitor read/write/execute to a range of memory)
      • !syscall, !syscall2 (hook system-calls)
      • !sysret, !sysret2 (hook SYSRET instruction execution)
      • !mode (detect kernel-to-user and user-to-kernel transitions)
      • !cpuid (hook CPUID instruction execution)
      • !msrread (hook RDMSR instruction execution)
      • !msrwrite (hook WRMSR instruction execution)
      • !tsc (hook RDTSC/RDTSCP instruction execution)
      • !pmc (hook RDPMC instruction execution)
      • !vmcall (hook hypercalls)
      • !exception (hook first 32 entries of IDT)
      • !interrupt (hook external device interrupts)
      • !dr (hook access to debug registers)
      • !ioin (hook IN instruction execution)
      • !ioout (hook OUT instruction execution)
      • !hide (enable transparent-mode)
      • !unhide (disable transparent-mode)
      • !measure (measuring and providing details for transparent-mode)
      • !va2pa (convert a virtual address to physical address)
      • !pa2va (convert physical address to virtual address)
      • !dump (save the physical memory into a file)
      • !pcitree (show PCI/PCIe device tree)
      • !pcicam (dump the PCI/PCIe configuration space)
      • !idt (show Interrupt Descriptor Table entries)
      • !apic (dump local APIC entries in XAPIC and X2APIC modes)
      • !ioapic (dump I/O APIC)
    • Scripting Language
      • Assumptions & Evaluations
      • Variables & Assignments
      • Casting & Type-awareness
      • Conditionals & Loops
      • Constants & Functions
      • Debugger Script (DS)
      • Examples
        • view system state (registers, memory, variables)
        • change system state (registers, memory, variables)
        • trace function calls
        • pause the debugger conditionally
        • conditional breakpoints and events
        • patch the normal sequence of execution
        • access to a shared variable from different cores
        • count occurrences of events
      • Functions
        • debugger
          • pause
        • events
          • event_enable
          • event_disable
          • event_clear
          • event_sc
          • event_inject
          • event_inject_error_code
          • flush
        • exports
          • print
          • printf
        • interlocked
          • interlocked_compare_exchange
          • interlocked_decrement
          • interlocked_exchange
          • interlocked_exchange_add
          • interlocked_increment
        • memory
          • check_address
          • eb, ed, eq
          • eb_pa, ed_pa, eq_pa
          • memcpy
          • memcpy_pa
          • memcmp
          • virtual_to_physical
          • physical_to_virtual
        • diassembler
          • disassemble_len
          • disassemble_len32
        • spinlocks
          • spinlock_lock
          • spinlock_lock_custom_wait
          • spinlock_unlock
        • strings
          • strlen
          • wcslen
          • strcmp
          • strncmp
          • wcscmp
          • wcsncmp
    • Commands Map
  • Tips & Tricks
    • Considerations
      • Basic concepts in Intel VT-x
      • VMX root-mode vs VMX non-root mode
      • The "unsafe" behavior
      • Script engine in VMX non-root mode
      • Difference between process and thread switching commands
      • Accessing Invalid Address
      • Transparent Mode
    • Nested-Virtualization Environments
      • Supported Virtual Machines
      • Run HyperDbg on VMware
      • Run HyperDbg on Hyper-V
      • Supporting VMware/Hyper-V
      • VMware backdoor I/O ports
    • Misc
      • Event forwarding
      • Event short-circuiting
      • Event calling stage
      • Instant events
      • Message overflow
      • Customize build
        • Increase Communication Buffer Size
        • Number of EPT Hooks in One Page
        • Change Script Engine Limitations
      • Enable and disable events in Debugger Mode
      • Switch to New Process Layout
  • Contribution
    • Style Guide
      • Coding style
      • Command style
      • Doxygen style
    • Logo & Artworks
  • Design
    • Features
      • VMM (Module)
        • Control over NMIs
        • VMX root-mode compatible message tracing
        • Design of !epthook
        • Design of !epthook2
        • Design of !monitor
        • Design of !syscall & !sysret
        • Design of !exception & !interrupt
    • Debugger Internals
      • Events
      • Conditions
      • Actions
      • Kernel Debugger
        • Design Perspective
        • Connection
  • Links
    • Twitter
    • Telegram
    • Discord
    • Matrix
    • Mastodon
    • YouTube
    • hwdbg (Chip Debugger)
    • Doxygen
    • Contribution
Powered by GitBook
On this page
  • Command
  • Syntax
  • Description
  • Parameters
  • Context
  • Short-circuiting
  • Calling Stages
  • Debugger
  • Custom Code
  • IOCTL
  • Design
  • Remarks
  • Requirements
  • Related
Edit on GitHub
  1. Commands
  2. Extension Commands

!mode (detect kernel-to-user and user-to-kernel transitions)

Description of the '!mode' command in HyperDbg.

Previous!sysret, !sysret2 (hook SYSRET instruction execution)Next!cpuid (hook CPUID instruction execution)

Last updated 10 months ago

Command

!mode

Syntax

!mode [Mode (string)] [pid ProcessId (hex)] [core CoreId (hex)] [imm IsImmediate (yesno)] [sc EnableShortCircuiting (onoff)] [stage CallingStage (prepostall)] [buffer PreAllocatedBuffer (hex)] [script { Script (string) }] [asm condition { Condition (assembly/hex) }] [asm code { Code (assembly/hex) }] [output {OutputName (string)}]

Description

Triggers when there is a transition from the user-mode to the kernel-mode (e.g., as the result of an interrupt/fault/exception or a system-call) and from kernel-mode to user-mode (e.g., as the result of IRET or SYSRET) on the target process.

Using this event disables the use of other EPT hook commands, including '' and '', as well as the '' commands.

This event only applies to a selected process; thus, you need to provide a process ID (pid).

For reducing memory usage, this feature is not automatically initialized in HyperDbg. Before using this command in the , you should use the '' command. There is no need for pre-activation in the .

Parameters

[Mode (string)]

Can be one of these values (or a combination of these attributes like 'ku', or 'uk'):

u: trigger in the case of kernel-to-user transition.

k: trigger in the case of user-to-kernel transition.

ku or uk: trigger in the case of both kernel-to-user and user-to-kernel transition.

[pid ProcessId (hex)]

Mandatory value to trigger the event in just the specific process. Add pid xx to your command; thus, the command will be executed if the process id is equal to xx.

[core CoreId (hex)] (optional)

Optional value to trigger the event in just a specific core. Add core xx to your command thus command will be executed if core id is equal to xx. If you don't specify this option, then by default, you receive events on all cores.

[imm IsImmediate (yesno)] (optional)

Optional value in which yes means the results (printed texts in scripts) should be delivered immediately to the debugger. no means that the results can be accumulated and delivered as a couple of messages when the buffer is full; thus, it's substantially faster, but it's not real-time. By default, this value is set to yes.

[sc EnableShortCircuiting (onoff)] (optional)

[stage CallingStage (prepostall)] (optional)

[buffer PreAllocatedBuffer (hex)] (optional)

[script { Script (string) }] (optional)

[asm condition { Condition (assembly/hex) }] (optional)

[asm code { Code (assembly/hex) }] (optional)

[output {OutputName (string)}] (optional)

Context

As the Context ($context pseudo-register in the event's script, r8 in custom code, and rdx in condition code register) to the event trigger, HyperDbg sends the context as 3 if the execution is transitioned from the kernel-mode to the user-mode (reached to the user) and sends 0 if the execution is transitioned from the user-mode to the kernel-mode (reached to the kernel).

Short-circuiting

Short-circuiting transition from the kernel-mode to the user-mode ($context=3) will cause the target user-mode process to go to a halt state (the execution of instructions in the target process in the user-mode is paused). For example, you can use the following script to pause the target process:

!mode u pid 0x1c0 script {

	//
	// The user-mode execution of the process is paused and
	// instruction fetches in the user-mode is prevented
	//
	event_sc(1);
}

On the other hand, using this feature for short-circuiting user-mode to kernel-mode transition (even if it is possible in HyperDbg), but does not make sense in most cases. If you use it without any further consideration and conditions, you will block the execution of system-calls and interrupts and if Windows fails to regain control of the core from the user-mode process (e.g., through the clock interrupt), the entire core and system will come to a halt, so make sure to short-circuit user-to-kernel transition only if you know what you're doing.

Calling Stages

Debugger

This event supports three debugging mechanisms.

  • Break

  • Script

  • Custom Code

Break

We want to break on the user-mode execution of a process with the process ID equal to 0x1c0.

HyperDbg> !mode u pid 0x1c0

We want to break on the kernel-mode execution of a process with the process ID equal to 0x1c0.

HyperDbg> !mode k pid 0x1c0

We want to break on the kernel-mode and the user-mode execution of a process with the process ID equal to 0x1c0.

HyperDbg> !mode ku pid 0x1c0

Script

HyperDbg> !mode ku pid 0x1c0 script { HyperDbg Script Here }

The above command when messages don't need to be delivered immediately.

HyperDbg> !mode ku pid 0x1c0 script { HyperDbg Script Here } imm no

Script (From File)

If you saved your script into a file, then you can add file: instead of a script and append the file path to it. For example, the following examples show how you can run a script from file:c:\users\sina\desktop\script.txt.

HyperDbg> !mode ku pid 0x1c0 script {file:c:\users\sina\desktop\script.txt}

Custom Code

Run Custom Code (Unconditional)

HyperDbg> !mode ku pid 490 code {90 90 90}

Or if you want to use assembly codes directly, you can add an asm before the code.

HyperDbg> !mode ku pid 490 asm code {nop; nop; nop}

Run Custom Code (Conditional)

HyperDbg> !mode ku pid 490 code {90 90 90} condition {90 90 90}

Or if you want to use assembly codes directly, you can add an asm before the condition and also before the code.

HyperDbg> !mode ku pid 490 asm code {nop; nop; nop} asm condition {nop; nop; nop}

Keep in mind that a conditional event can be used in Breaking to Debugger and Running Script too.

IOCTL

As EventType use TRAP_EXECUTION_MODE_CHANGED and set OptionalParam1 to one of the following values based on your need (user-mode transition or kernel-mode transition or both of them):

DEBUGGER_EVENT_MODE_TYPE_USER_MODE_AND_KERNEL_MODE = 1
DEBUGGER_EVENT_MODE_TYPE_USER_MODE                 = 3
DEBUGGER_EVENT_MODE_TYPE_KERNEL_MODE               = 0

Design

This command uses the Mode-Based Execution Control (MBEC) feature of Intel processors by allocating and adjusting two separate EPT tables (one Kernel execution is disabled and one User execution is disabled) and once the target process is identified (using MOV-to-CR3 exiting VM-exits), exchanges the newly allocated EPT page-tables and trigger events once EPT violation happened in the target process.

Remarks

The support for this command is added starting from v0.8.

Requirements

Related

Optional value to ignore the emulation (skip execution) of the event. Add sc on to your command thus whenever the event is triggered, the effects and the execution of the actual event will be ignored. For more information, please read article. If you don't specify this option, then by default, all the events will be emulated (executed). By default, this value is set to off.

Optional value to configure the of the event. To trigger the event before the emulation, include stage pre in your command. Conversely, using stage post will cause the event to be triggered after the emulation. Additionally, using stage all will trigger the event both before and after the emulation. For more information, please read article. By default, this value is set to pre.

Optional value which reserves a safe to be accessed within the event codes.

A HyperDbg will be executed each time the event is triggered.

Optional assembly codes which check for in assembly.

Optional will be executed each time the event is triggered.

Optional output resource name for .

This event supports '', which means that you can configure HyperDbg to ignore its execution and its effects. For additional details, please refer to the article provided .

This event does not support . Due to the nature of this event, implementing calling stages in this context wouldn't be meaningful.

Please read "" if you need a conditional event, a conditional event can be used in all "Break", "Script", and "Custom Code".

Using the following command, you can use HyperDbg's Script Engine. You should replace the string between braces (HyperDbg Script Here) with your script. You can find script examples .

You can use to forward the event monitoring results from this event and other events to an external source, e.g., File, NamedPipe, or TCP Socket. This way, you can use HyperDbg as a monitoring tool and gather your target system's behavior and use it later or analyze it on other systems.

Please read "" to get an idea about how to run the custom buffer code in HyperDbg.

Your custom code will be executed in vmx-root mode. Take a look at for more information. Running code in vmx-root is considered "".

Monitoring transitions of process id 0x490 from user-mode to kernel-mode and kernel-mode to user-mode and run 3 nops whenever the event is triggered. Take a look at for more information.

Monitoring transitions of process id 0x490 from user-mode to kernel-mode and kernel-mode to user-mode and run 3 nops whenever the event condition is triggered and run 3 nops whenever the event is triggered. Take a look at and for more information.

This command uses the same method to .

This command creates an . Starting from HyperDbg v0.7, events are guaranteed to keep the debuggee in a halt state (in the ); thus, nothing will change during its execution and the context (registers and memory) remain untouched. You can visit for more information. Please note that in the , this event is not initialized by default, you need to use the '' command (only one time) to initial this event. The '' command will continue the debuggee but this event won't continue the debuggee, so you need to make sure to execute the '' command before using it to avoid losing the context.

This command cannot be used simultaneously with regular EPT hook commands (, , and ) and the '', or the '' commands.

This command requires (7th generation) or a newer Intel processor that supports Mode-Based Execution Control (a.k.a., MBEC).

!epthook
!epthook2
!monitor
Debugger Mode
preactivate
VMI Mode
this
calling stage
this
pre-allocated buffer
script
conditions
assembly codes
forwarding events
event short-circuiting
here
calling stages
How to create a condition?
here
event forwarding
How to create an action?
this topic
unsafe
Run Custom Code
Run Custom Code
how to create a condition
send IOCTL for regular events
event
Debugger Mode
instant events
Debugger Mode
preactivate
preactivate
preactivate
!epthook
!epthook2
!monitor
.start
.restart
Kaby Lake
preactivate (pre-activate special functionalities)