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
        • timings
          • rdtsc
          • rdtscp
          • microsleep
        • 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
  • Page-Fault Error Codes
  • Examples
  • IOCTL
  • Remarks
  • Requirements
  • Related
Edit on GitHub
  1. Commands
  2. Meta Commands

.pagein (bring the page into the RAM)

Description of the '.pagein' command in HyperDbg.

Command

.pagein

Syntax

.pagein [Mode (string)] [VirtualAddress (hex)]

.pagein [Mode (string)] [VirtualAddress (hex)] [l Length (hex)]

Description

Injects a page-fault and brings the target page (or a range of pages) into the memory.

Parameters

[Mode (string)] (optional)

The page-fault error code that needs to be injected. The error code can be one of these values, or a combination of these values:

p: present

w: write

u: user

f: fetch

k: protection key

s: shadow stack

h: hlat

g: sgx

[VirtualAddress (hex)]

The virtual address or the start address of a range of addresses where we want to bring its entry into the RAM.

[l Length (hex)] (optional)

The length of the memory (range) in bytes.

Page-Fault Error Codes

Bit
Mode
Length
Name
Description

P

p

1 bit

Present

When set, the page fault was caused by a page-protection violation. When not set, it was caused by a non-present page.

W

w

1 bit

Write

When set, the page fault was caused by a write access. When not set, it was caused by a read access.

U

u

1 bit

User

When set, the page fault was caused while CPL = 3. This does not necessarily mean that the page fault was a privilege violation.

RSVD

1 bit

Reserved write

When set, one or more page directory entries contain reserved bits which are set to 1. This only applies when the PSE or PAE flags in CR4 are set to 1.

I

f

1 bit

Instruction Fetch

When set, the page fault was caused by an instruction fetch. This only applies when the No-Execute bit is supported and enabled.

PK

k

1 bit

Protection key

When set, the page fault was caused by a protection-key violation. The PKRU register (for user-mode accesses) or PKRS MSR (for supervisor-mode accesses) specifies the protection key rights.

SS

s

1 bit

Shadow stack

When set, the page fault was caused by a shadow stack access.

HLAT

h

1 bit

HLAT

When set, there is no translation for the linear address using HLAT paging.

SGX

g

1 bit

Software Guard Extensions

This is a list of common page-fault error codes:

Error Code
Mode
Description

0x0

(default)

page not-found

0x2

w

write access fault

0x3

pw

present, write access fault

0x4

u

user access fault

0x6

wu

write, user access fault

0x7

pwu

present, write, user access fault

0x10

f

fetch instruction fault

0x11

pf

present, fetch instruction fault

0x14

uf

user, fetch instruction fault

In most cases, using a value of 0x0 (default page-fault error code) is the safest option.

Using this command with incorrect mode strings or virtual addresses that are not meant to be accessible is like delivering an exception to the target process. In the case of a thread operating in kernel-mode, the exception is directed towards the kernel. If the target process handles these exceptions appropriately, the Structured Exception Handling (SEH) handlers will be invoked. However, if the target fails to handle the exceptions properly, it may result in a crash of the target process. In the case of a kernel-mode thread, it can lead to a Blue Screen of Death (BSOD) for the entire system. Therefore, it is crucial to ensure that the necessary pages are brought in for the addresses intended to be accessible, and that the appropriate access page-fault error code is chosen.

Examples

The following command injects a page-fault with the error code equal to zero and the CR2 register is configured to 00007ff8349f2224.

0: kHyperDbg> .pagein 00007ff8349f2224
the page-fault is delivered to the target thread
press 'g' to continue debuggee (the current thread will execute ONLY one instruction and will be halted again)...

The following command injects a page-fault with the error code equal to zero and starting from the a range where its CR2 register is configured to 00007ff8349f2224. and the last address is 00007ff8349f2224+(4*0x1000) which means it brings 5 pages into the memory or the length is 0x4000 bytes.

0: kHyperDbg> .pagein 00007ff8349f2224 l 4000
the page-fault is delivered to the target thread
press 'g' to continue debuggee (the current thread will execute ONLY one instruction and will be halted again)...

The following command injects a page-fault with the error code equal to 0x4 and the CR2 register is configured to 00007ff8349f2224.

0: kHyperDbg> .pagein u 00007ff8349f2224
the page-fault is delivered to the target thread
press 'g' to continue debuggee (the current thread will execute ONLY one instruction and will be halted again)...

IOCTL

This command works over serial by sending the serial packets to the remote computer.

First of all, you should fill in the following structure, set the VirtualAddressFrom to your target virtual address that you want to put a breakpoint on and VirtualAddressTo to the end of the range of addresses, and fill PageFaultErrorCode to your target page-fault error code. Note that, if you want to bring only one page, then you can set both VirtualAddressFrom and VirtualAddressTo to the same value.

typedef struct _DEBUGGER_PAGE_IN_REQUEST
{
    UINT64 VirtualAddressFrom;
    UINT64 VirtualAddressTo;
    UINT32 ProcessId;
    UINT32 PageFaultErrorCode;
    UINT32 KernelStatus;

} DEBUGGER_PAGE_IN_REQUEST, *PDEBUGGER_PAGE_IN_REQUEST;

The next step is sending the above structure to the debuggee when debuggee is paused and waiting for new command on vmx-root mode.

You should send the above structure with DEBUGGER_REMOTE_PACKET_REQUESTED_ACTION_ON_VMX_ROOT_INJECT_PAGE_FAULT as RequestedAction and DEBUGGER_REMOTE_PACKET_TYPE_DEBUGGER_TO_DEBUGGEE_EXECUTE_ON_VMX_ROOT as PacketType.

In return, the debuggee sends the above structure with the following type.

DEBUGGER_REMOTE_PACKET_REQUESTED_ACTION_DEBUGGEE_RESULT_OF_BRINGING_PAGES_IN

In the returned structure, the KernelStatus is filled by the kernel.

If the KernelStatus is DEBUGEER_OPERATION_WAS_SUCCESSFULL, then the operation was successful. Otherwise, the returned result is an error.

The following function is responsible for sending page-in requests to the debugger.

BOOLEAN KdSendPageinPacketToDebuggee(PDEBUGGER_PAGE_IN_REQUEST PageinPacket);

Remarks

Starting from v0.4, this command was added to the HyperDbg debugger and starting from v0.7 it supports a range of addresses.

Please note that technically, you could use this command on a large range of memory. However, in large memory ranges, there are often page entries that are already valid (paged in or never paged out by the OS). In those cases, if you bring them into memory (force the OS to page them in) using this command, it will disrupt the OS semantics. This command injects a #PF (page fault) into the OS, and if the address is already valid, the operating system does not expect to receive a page fault for an available page, which might or will cause a triple fault and consequently a system restart or crash.

Requirements

None

Related

Previous.thread, .thread2 (show the current thread and switch to another thread)Next.dump (save the virtual memory into a file)

Last updated 7 months ago

Currently, this command is only supported in the .

The following table is derived from with some modifications, which explains the meaning of each bit in the Mode string.

When set, the fault was due to an . The fault is unrelated to ordinary paging.

This command is mainly designed to be used with the '' command. Certain pages (virtual addresses) may have been paged-out or are not currently present in the memory (RAM). Without these pages being stored in the physical RAM, it is not possible to utilize EPT hooks, such as the '' command, on those particular addresses. Therefore, executing this command will tell the operating system to retrieve the page and ensure the availability of the virtual address. Consequently, you will be able to utilize EPT hooks commands on those addresses.

This command is guaranteed to keep debuggee in a halt state (in Debugger Mode); thus, nothing will change during its execution. But after, running it, HyperDbg asks to continue the debuggee using the '' command. Subsequently, all processes will resume their execution, while the specific target (current) thread will execute a single instruction due to the Trap Flag being set. However, it will once again pause after handling the page fault and executing that one instruction.

Debugger Mode
Exceptions
.start
!monitor
g
.start (start a new process)
SGX violation