use std::collections::{HashMap, HashSet};
use std::hash::Hash;
use std::io::{ErrorKind, Write};
use std::mem::take;
use std::os::unix::net::UnixStream;
use std::str::FromStr;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc::{self, RecvTimeoutError};
use std::sync::{Arc, LazyLock, Mutex, MutexGuard, OnceLock};
#[cfg(test)]
use std::thread::JoinHandle;
use std::thread::spawn;
use std::time::{Duration, Instant};
use owo_colors::OwoColorize;
use crate::backend::MemoryOps;
use crate::dbg_backend::{
BackendCapability, BugcheckInfo, ContinueDisposition, DebugBackend, DebugCapability, DebugLog,
DebugOutputPage, HW_BREAKPOINT_SLOTS, HwBreakpointAccess, StopEvent,
};
use crate::debugger_data::{DebuggerDataCandidate, MetadataSource};
use crate::error::{Error, Result};
use crate::gdb::RegisterMap;
use crate::kd::framing::{BREAKIN_BYTE, KdFraming};
use crate::memory::{AddressSpace, PAGE_SIZE, TranslationCache};
use crate::phys::PhysMem;
use crate::session::clear_trap_flag;
use crate::types::{Arch, Dtb, PhysAddr, VirtAddr};
macro_rules! kd_trace {
($($arg:tt)*) => {
if $crate::kd::trace_enabled() {
eprintln!("[{:>9.3}] {}", $crate::kd::trace_elapsed().as_secs_f64(), format_args!($($arg)*));
}
};
}
macro_rules! kd_trace_bytes {
($($arg:tt)*) => {
if $crate::kd::trace_bytes_enabled() {
eprint!($($arg)*);
}
};
}
pub fn trace_enabled() -> bool {
static ENABLED: OnceLock<bool> = OnceLock::new();
*ENABLED.get_or_init(|| std::env::var_os("NTOSEYE_KD_TRACE").is_some())
}
pub fn trace_elapsed() -> Duration {
static START: LazyLock<Instant> = LazyLock::new(Instant::now);
START.elapsed()
}
pub fn trace_bytes_enabled() -> bool {
static ENABLED: OnceLock<bool> = OnceLock::new();
*ENABLED.get_or_init(|| std::env::var_os("NTOSEYE_KD_TRACE_BYTES").is_some())
}
pub mod api;
pub mod context;
pub mod context_arm64;
pub mod framing;
pub mod hwbp;
mod kdnet;
mod transport;
use kdnet::KdNetStream;
use transport::KdTransport;
mod debug_io;
pub use debug_io::*;
mod file_io;
pub use file_io::*;
mod event_loop;
pub use event_loop::*;
pub mod wire;
#[derive(Debug, Clone)]
pub struct StateChange {
processor: u16,
number_processors: u16,
new_state: u32,
exception_code: u32,
exception_first_chance: Option<bool>,
exception_address: Option<u64>,
program_counter: u64,
kernel_base_hint: Option<VirtAddr>,
is_bugcheck: bool,
bugcheck: Option<BugcheckInfo>,
target_reloaded: bool,
assisted_breakin: bool,
}
#[derive(Debug, Clone, Copy)]
struct PendingWriteBreakpoint {
addr: u64,
processor: u16,
}
const DEBUG_LOG_CAPACITY: usize = 4096;
const DBG_KD_EXCEPTION_STATE_CHANGE: u32 = 0x0000_3030;
const DBG_KD_LOAD_SYMBOLS_STATE_CHANGE: u32 = 0x0000_3031;
const DBG_KD_COMMAND_STRING_STATE_CHANGE: u32 = 0x0000_3032;
const AMD64_DEBUG_CONTROL_SPACE_KSPECIAL: u64 = 2;
const ARM64_DEBUG_CONTROL_SPACE_KSPECIAL: u64 = 2;
fn detect_arch(machine_type: u16) -> Result<Arch> {
match Arch::from_machine_type(machine_type) {
Some(arch) => Ok(arch),
None => {
let name = match machine_type {
0x014c => "I386",
_ => "unknown",
};
Err(Error::UnsupportedArchitecture(format!(
"{name} KD target (machine {machine_type:#06x})"
)))
}
}
}
const KSPECIAL_REGISTERS_CR0_OFFSET: usize = 0x00;
const KSPECIAL_REGISTERS_CR2_OFFSET: usize = 0x08;
const KSPECIAL_REGISTERS_CR3_OFFSET: usize = 0x10;
const KSPECIAL_REGISTERS_CR4_OFFSET: usize = 0x18;
const KSPECIAL_REGISTERS_DR0_OFFSET: usize = 0x20;
const KSPECIAL_REGISTERS_DR1_OFFSET: usize = 0x28;
const KSPECIAL_REGISTERS_DR2_OFFSET: usize = 0x30;
const KSPECIAL_REGISTERS_DR3_OFFSET: usize = 0x38;
const KSPECIAL_REGISTERS_DR6_OFFSET: usize = 0x40;
const KSPECIAL_REGISTERS_DR7_OFFSET: usize = 0x48;
const KSPECIAL_REGISTERS_GDTR_OFFSET: usize = 0x50;
const KSPECIAL_REGISTERS_IDTR_OFFSET: usize = 0x60;
const KSPECIAL_REGISTERS_TR_OFFSET: usize = 0x70;
const KSPECIAL_REGISTERS_LDTR_OFFSET: usize = 0x72;
const KSPECIAL_REGISTERS_CR8_OFFSET: usize = 0xA0;
const KSPECIAL_REGISTERS_MIN_SIZE: usize = KSPECIAL_REGISTERS_CR8_OFFSET + 8;
const ARM64_KSPECIAL_REGISTERS_BVR0_OFFSET: usize = 0x28;
const ARM64_KSPECIAL_REGISTERS_BCR0_OFFSET: usize = 0x68;
const ARM64_KSPECIAL_REGISTERS_WVR0_OFFSET: usize = 0x88;
const ARM64_KSPECIAL_REGISTERS_WCR0_OFFSET: usize = 0x98;
const ARM64_KSPECIAL_REGISTERS_MIN_SIZE: usize = 0xA0;
const MSR_EFER: u32 = 0xC000_0080;
const STATUS_BREAKPOINT: u32 = 0x8000_0003;
const STATUS_SINGLE_STEP: u32 = 0x8000_0004;
const KD_REQUEST_TIMEOUT: Duration = Duration::from_secs(5);
const KD_INITIAL_PROBE_TIMEOUT: Duration = Duration::from_secs(1);
const DBGKD_DEBUG_IO_HEADER_SIZE: usize = 16;
const DBGKD_DEBUG_IO_MIN_HEADER_SIZE: usize = 12;
const DBGKD_PRINT_STRING_API: u32 = 0x0000_3230;
const DBGKD_GET_STRING_API: u32 = 0x0000_3231;
const DBGKD_FILE_IO_HEADER_SIZE: usize = 64;
const DBGKD_CREATE_FILE_API: u32 = 0x0000_3430;
const DBGKD_READ_FILE_API: u32 = 0x0000_3431;
const DBGKD_WRITE_FILE_API: u32 = 0x0000_3432;
const DBGKD_CLOSE_FILE_API: u32 = 0x0000_3433;
const STATUS_UNSUCCESSFUL: u32 = 0xc000_0001;
const KD_BREAKPOINT_TABLE_SIZE: u32 = 32;
const KD_REFRESH_MESSAGE: &[u8] = b"KDTARGET: Refreshing KD connection";
const KD_INITIAL_TIMEOUT_ENV: &str = "NTOSEYE_KD_TIMEOUT";
const KD_INITIAL_TIMEOUT_DEFAULT: Duration = Duration::from_secs(8);
const KD_INITIAL_PROGRESS_INTERVAL: Duration = Duration::from_secs(10);
const KD_RECONNECT_BREAKIN_INTERVAL: Duration = Duration::from_millis(250);
const KD_RECONNECT_BREAKIN_TRACE_EVERY: u32 = 8;
const POST_BUGCHECK_RECONNECT_ASSIST_DELAY: Duration = Duration::from_secs(20);
const KD_EXIT_STOP_POLL: Duration = Duration::from_secs(1);
const KD_EXIT_MAX_CONTINUES: u32 = 8;
const PUMP_POLL: Duration = Duration::from_millis(100);
const KD_REMOTE_MEMORY_CHUNK: usize = 0x800;
const KD_VIRTUAL_LINE: usize = 0x200;
const LINE_CACHE_LIMIT: usize = 32768;
const ARM64_WINDBG_TTBR1_EL1: u32 = 0x0003_0201;
const ARM64_WINDBG_TTBR0_EL1: u32 = 0x0003_0200;
const ARM64_WINDBG_ESR_EL1: u32 = 0x0003_0520;
const ARM64_WINDBG_FAR_EL1: u32 = 0x0003_0600;
const ARM64_DEBUG_REGISTER_OFFSETS: &[(usize, usize, usize, usize)] = &[
(
ARM64_KSPECIAL_REGISTERS_BVR0_OFFSET,
context_arm64::OFFSET_BVR0,
8,
hwbp::ARM64_MAX_BREAKPOINTS as usize,
),
(
ARM64_KSPECIAL_REGISTERS_BCR0_OFFSET,
context_arm64::OFFSET_BCR0,
4,
hwbp::ARM64_MAX_BREAKPOINTS as usize,
),
(
ARM64_KSPECIAL_REGISTERS_WVR0_OFFSET,
context_arm64::OFFSET_WVR0,
8,
hwbp::ARM64_MAX_WATCHPOINTS as usize,
),
(
ARM64_KSPECIAL_REGISTERS_WCR0_OFFSET,
context_arm64::OFFSET_WCR0,
4,
hwbp::ARM64_MAX_WATCHPOINTS as usize,
),
];
fn normalize_kernel_dtb(arch: Arch, register_value: u64) -> Dtb {
register_value & arch.dtb_page_mask()
}
fn kspecial_control_space(arch: Arch) -> (u64, usize) {
match arch {
Arch::Amd64 => (
AMD64_DEBUG_CONTROL_SPACE_KSPECIAL,
KSPECIAL_REGISTERS_MIN_SIZE,
),
Arch::Arm64 => (
ARM64_DEBUG_CONTROL_SPACE_KSPECIAL,
ARM64_KSPECIAL_REGISTERS_MIN_SIZE,
),
}
}
fn arm64_slot_offsets(slot: u8) -> Result<(usize, usize)> {
if hwbp::ARM64_WATCHPOINT_SLOTS.contains(&slot) {
Ok((
ARM64_KSPECIAL_REGISTERS_WVR0_OFFSET + slot as usize * 8,
ARM64_KSPECIAL_REGISTERS_WCR0_OFFSET + slot as usize * 4,
))
} else if hwbp::ARM64_BREAKPOINT_SLOTS.contains(&slot) {
let index = (slot - hwbp::ARM64_BREAKPOINT_SLOTS.start) as usize;
Ok((
ARM64_KSPECIAL_REGISTERS_BVR0_OFFSET + index * 8,
ARM64_KSPECIAL_REGISTERS_BCR0_OFFSET + index * 4,
))
} else {
Err(Error::Kd(format!(
"invalid ARM64 hardware breakpoint slot {slot} (expected 0-{})",
hwbp::ARM64_BREAKPOINT_SLOTS.end - 1
)))
}
}
fn arm64_slot_offsets_for_access(slot: u8, access: HwBreakpointAccess) -> Result<(usize, usize)> {
let slots = hwbp::arm64_slot_range(access);
if slots.contains(&slot) {
return arm64_slot_offsets(slot);
}
let kind = if matches!(access, HwBreakpointAccess::Execute) {
"execute"
} else {
"watchpoint"
};
Err(Error::Kd(format!(
"ARM64 {kind} slot {slot} is outside slots {}-{}",
slots.start,
slots.end - 1
)))
}
fn thread_id_for(processor: u16) -> String {
format!("p1.{:x}", u32::from(processor) + 1)
}
fn parse_thread_id(tid: &str) -> Result<u16> {
let stripped = tid
.strip_prefix("p1.")
.ok_or_else(|| Error::Kd(format!("unrecognised thread id {tid}")))?;
let idx =
u16::from_str_radix(stripped, 16).map_err(|_| Error::Kd(format!("bad thread id {tid}")))?;
if idx == 0 {
return Err(Error::Kd(format!("thread id {tid} has zero index")));
}
Ok(idx - 1)
}
fn parse_thread_id_for_processor_count(tid: &str, processor_count: u16) -> Result<u16> {
let processor = parse_thread_id(tid)?;
if processor >= processor_count {
return Err(Error::Kd(format!(
"thread id {tid} selects processor {}, but guest reports {} processor(s)",
processor + 1,
processor_count
)));
}
Ok(processor)
}
pub fn breakpoint_instruction_at(
framing: &mut KdFraming<KdTransport>,
arch: Arch,
processor: u16,
pc: u64,
) -> bool {
const INT3: [u8; 1] = [0xcc];
const BRK_F000: [u8; 4] = 0xD43E_0000u32.to_le_bytes();
let expected: &[u8] = match arch {
Arch::Amd64 => &INT3,
Arch::Arm64 => &BRK_F000,
};
match with_framing_read_timeout(framing, KD_REQUEST_TIMEOUT, |framing| {
api::read_virtual_memory(framing, processor, pc, expected.len() as u32)
}) {
Ok(bytes) => bytes == expected,
Err(_) => false,
}
}
fn restore_unowned_breakpoint_handles(
framing: &mut KdFraming<KdTransport>,
processor: u16,
owned: &HashSet<u32>,
) -> usize {
let mut reclaimed = 0;
for handle in 1..=KD_BREAKPOINT_TABLE_SIZE {
if owned.contains(&handle) {
continue;
}
match with_framing_read_timeout(framing, KD_REQUEST_TIMEOUT, |framing| {
api::restore_breakpoint(framing, processor, handle)
}) {
Ok(()) => reclaimed += 1,
Err(Error::KdStatus { .. }) => {}
Err(error) => {
kd_trace!("kd: reclaim: handle {handle} failed: {error}");
break;
}
}
}
reclaimed
}
fn report_reclaimed_breakpoints(reclaimed: usize) {
if reclaimed == 0 {
return;
}
eprintln!(
"ntoseye: released {reclaimed} breakpoint table entr{} stranded by an earlier session",
if reclaimed == 1 { "y" } else { "ies" }
);
}
fn exit_stop_is_stray_single_step(stop: &StopEvent, managed_bp_addresses: &HashSet<u64>) -> bool {
stop.exception_code == Some(STATUS_SINGLE_STEP)
&& !stop.is_bugcheck
&& stop
.program_counter
.is_none_or(|pc| !managed_bp_addresses.contains(&pc))
}
fn append_control_registers_from_special(ctx: &mut Vec<u8>, special: &[u8]) -> Result<()> {
if special.len() < KSPECIAL_REGISTERS_MIN_SIZE {
return Err(Error::Kd(format!(
"KSPECIAL_REGISTERS buffer too short: {} bytes, expected at least {}",
special.len(),
KSPECIAL_REGISTERS_MIN_SIZE
)));
}
ctx.resize(context::REGISTER_BUFFER_SIZE, 0);
let copy_reg = |ctx: &mut [u8], ctx_offset: usize, special_offset: usize| {
ctx[ctx_offset..ctx_offset + 8]
.copy_from_slice(&special[special_offset..special_offset + 8]);
};
copy_reg(ctx, context::OFFSET_CR0, KSPECIAL_REGISTERS_CR0_OFFSET);
copy_reg(ctx, context::OFFSET_CR2, KSPECIAL_REGISTERS_CR2_OFFSET);
copy_reg(ctx, context::OFFSET_CR3, KSPECIAL_REGISTERS_CR3_OFFSET);
copy_reg(ctx, context::OFFSET_CR4, KSPECIAL_REGISTERS_CR4_OFFSET);
copy_reg(ctx, context::OFFSET_DR0, KSPECIAL_REGISTERS_DR0_OFFSET);
copy_reg(ctx, context::OFFSET_DR1, KSPECIAL_REGISTERS_DR1_OFFSET);
copy_reg(ctx, context::OFFSET_DR2, KSPECIAL_REGISTERS_DR2_OFFSET);
copy_reg(ctx, context::OFFSET_DR3, KSPECIAL_REGISTERS_DR3_OFFSET);
copy_reg(ctx, context::OFFSET_DR6, KSPECIAL_REGISTERS_DR6_OFFSET);
copy_reg(ctx, context::OFFSET_DR7, KSPECIAL_REGISTERS_DR7_OFFSET);
copy_reg(ctx, context::OFFSET_CR8, KSPECIAL_REGISTERS_CR8_OFFSET);
ctx[context::OFFSET_GDTR_LIMIT..context::OFFSET_GDTR_LIMIT + 2].copy_from_slice(
&special[KSPECIAL_REGISTERS_GDTR_OFFSET + 6..KSPECIAL_REGISTERS_GDTR_OFFSET + 8],
);
copy_reg(
ctx,
context::OFFSET_GDTR_BASE,
KSPECIAL_REGISTERS_GDTR_OFFSET + 8,
);
ctx[context::OFFSET_IDTR_LIMIT..context::OFFSET_IDTR_LIMIT + 2].copy_from_slice(
&special[KSPECIAL_REGISTERS_IDTR_OFFSET + 6..KSPECIAL_REGISTERS_IDTR_OFFSET + 8],
);
copy_reg(
ctx,
context::OFFSET_IDTR_BASE,
KSPECIAL_REGISTERS_IDTR_OFFSET + 8,
);
ctx[context::OFFSET_TR..context::OFFSET_TR + 2]
.copy_from_slice(&special[KSPECIAL_REGISTERS_TR_OFFSET..KSPECIAL_REGISTERS_TR_OFFSET + 2]);
ctx[context::OFFSET_LDTR..context::OFFSET_LDTR + 2].copy_from_slice(
&special[KSPECIAL_REGISTERS_LDTR_OFFSET..KSPECIAL_REGISTERS_LDTR_OFFSET + 2],
);
Ok(())
}
fn update_special_debug_registers_from_context(special: &mut [u8], ctx: &[u8]) -> Result<()> {
if special.len() < KSPECIAL_REGISTERS_MIN_SIZE {
return Err(Error::Kd(format!(
"KSPECIAL_REGISTERS buffer too short: {} bytes, expected at least {}",
special.len(),
KSPECIAL_REGISTERS_MIN_SIZE
)));
}
context_payload(ctx)?;
for (ctx_offset, special_offset) in [
(context::OFFSET_DR0, KSPECIAL_REGISTERS_DR0_OFFSET),
(context::OFFSET_DR1, KSPECIAL_REGISTERS_DR1_OFFSET),
(context::OFFSET_DR2, KSPECIAL_REGISTERS_DR2_OFFSET),
(context::OFFSET_DR3, KSPECIAL_REGISTERS_DR3_OFFSET),
(context::OFFSET_DR6, KSPECIAL_REGISTERS_DR6_OFFSET),
(context::OFFSET_DR7, KSPECIAL_REGISTERS_DR7_OFFSET),
] {
special[special_offset..special_offset + 8]
.copy_from_slice(&ctx[ctx_offset..ctx_offset + 8]);
}
Ok(())
}
fn update_arm64_debug_registers_from_context(special: &mut [u8], ctx: &[u8]) -> Result<()> {
if special.len() < ARM64_KSPECIAL_REGISTERS_MIN_SIZE {
return Err(Error::Kd(format!(
"ARM64 KSPECIAL_REGISTERS buffer too short: {} bytes, expected at least {}",
special.len(),
ARM64_KSPECIAL_REGISTERS_MIN_SIZE
)));
}
if ctx.len() < context_arm64::CONTEXT_SIZE {
return Err(Error::Kd(format!(
"ARM64 CONTEXT buffer too short: {} bytes, expected {}",
ctx.len(),
context_arm64::CONTEXT_SIZE
)));
}
copy_arm64_debug_registers(special, ctx, false);
Ok(())
}
fn copy_arm64_debug_registers(dst: &mut [u8], src: &[u8], to_context: bool) {
for &(special_base, context_base, width, count) in ARM64_DEBUG_REGISTER_OFFSETS {
let (dst_base, src_base) = if to_context {
(context_base, special_base)
} else {
(special_base, context_base)
};
for index in 0..count {
let dst_offset = dst_base + index * width;
let src_offset = src_base + index * width;
dst[dst_offset..dst_offset + width]
.copy_from_slice(&src[src_offset..src_offset + width]);
}
}
}
fn context_payload(data: &[u8]) -> Result<&[u8]> {
if data.len() < context::CONTEXT_SIZE {
return Err(Error::Kd(format!(
"CONTEXT buffer too short: {} bytes, expected {}",
data.len(),
context::CONTEXT_SIZE
)));
}
Ok(&data[..context::CONTEXT_SIZE])
}
fn stop_event(stop: StateChange) -> StopEvent {
StopEvent {
thread_id: Some(thread_id_for(stop.processor)),
exception_code: (stop.new_state == DBG_KD_EXCEPTION_STATE_CHANGE)
.then_some(stop.exception_code),
first_chance: stop.exception_first_chance,
exception_address: stop.exception_address,
program_counter: Some(stop.program_counter),
is_bugcheck: stop.is_bugcheck,
bugcheck: stop.bugcheck,
target_reloaded: stop.target_reloaded,
target_kernel_base_hint: stop.kernel_base_hint,
modules_changed: stop.new_state == DBG_KD_LOAD_SYMBOLS_STATE_CHANGE,
assisted_breakin: stop.assisted_breakin,
}
}
#[derive(Clone, Copy)]
struct DebugRegisterSlotState {
address: u64,
dr7: u64,
}
#[derive(Clone, Copy)]
struct Arm64DebugRegisterSlotState {
address: u64,
control: u32,
}
enum Link {
Halted(KdFraming<KdTransport>),
RunningInline(KdFraming<KdTransport>),
RunningPumped(PumpHandle),
Lost,
}
impl Link {
fn framing(&mut self) -> Result<&mut KdFraming<KdTransport>> {
match self {
Self::Halted(framing) | Self::RunningInline(framing) => Ok(framing),
Self::RunningPumped(_) => Err(Error::Kd("KD transport is busy: VM is running".into())),
Self::Lost => Err(Error::Kd(
"KD transport lost: the servicing thread panicked".into(),
)),
}
}
fn is_running(&self) -> bool {
matches!(self, Self::RunningInline(_) | Self::RunningPumped(_))
}
fn take_pump(&mut self) -> Option<PumpHandle> {
if !matches!(self, Self::RunningPumped(_)) {
return None;
}
match std::mem::replace(self, Self::Lost) {
Self::RunningPumped(pump) => Some(pump),
_ => unreachable!("checked above"),
}
}
fn set_inline_running(&mut self, running: bool) {
let framing = match std::mem::replace(self, Self::Lost) {
Self::Halted(framing) | Self::RunningInline(framing) => framing,
other => {
*self = other;
return;
}
};
*self = if running {
Self::RunningInline(framing)
} else {
Self::Halted(framing)
};
}
}
struct LineCache<K> {
lines: HashMap<K, Vec<u8>>,
}
impl<K: Eq + Hash> Default for LineCache<K> {
fn default() -> Self {
Self {
lines: HashMap::new(),
}
}
}
impl<K: Eq + Hash> LineCache<K> {
fn get(&self, key: K) -> Option<&[u8]> {
self.lines.get(&key).map(Vec::as_slice)
}
fn insert(&mut self, key: K, data: Vec<u8>) {
if self.lines.len() >= LINE_CACHE_LIMIT {
self.lines.clear();
}
self.lines.insert(key, data);
}
fn clear(&mut self) {
self.lines.clear();
}
}
pub struct KdBackend {
link: Link,
breakin_clone: KdTransport,
backend_name: &'static str,
register_map: RegisterMap,
arch: Arch,
kernel_dtb_override: u64,
processor_count: u16,
current_processor: u16,
last_stop_processor: u16,
last_exception_code: u32,
last_rip: u64,
reconnect_assist_after_continue: Option<Duration>,
bp_handles: HashMap<u64, u32>,
managed_bp_addresses: HashSet<u64>,
breakin_addresses: HashSet<u64>,
pending_write_breakpoint: Option<PendingWriteBreakpoint>,
special_register_cache: HashMap<u16, Vec<u8>>,
context_cache: HashMap<u16, Vec<u8>>,
special_registers_unsupported: bool,
efer_cache: HashMap<u16, u64>,
virtual_lines: LineCache<(u16, u64)>,
table_lines: LineCache<u64>,
virtual_fill_cap: usize,
exit_prepared: bool,
debug_log: DebugLog,
translations: Arc<TranslationCache>,
}
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum KdMemorySource {
Auto,
Host,
Kd,
}
impl FromStr for KdMemorySource {
type Err = String;
fn from_str(value: &str) -> std::result::Result<Self, Self::Err> {
match value {
"auto" => Ok(Self::Auto),
"host" => Ok(Self::Host),
"kd" => Ok(Self::Kd),
other => Err(format!(
"unknown memory source '{other}': expected auto, host, or kd"
)),
}
}
}
#[derive(Debug, Clone, Copy)]
pub struct KdTargetHints {
pub kernel_dtb: Dtb,
pub kernel_base: VirtAddr,
pub ps_loaded_module_list: VirtAddr,
pub arch: Arch,
}
#[derive(Clone)]
pub struct KdMemory {
inner: Arc<Mutex<KdBackend>>,
translations: Arc<TranslationCache>,
}
pub struct KdBackendHandle {
inner: Arc<Mutex<KdBackend>>,
register_map: RegisterMap,
backend_name: &'static str,
}
impl KdBackendHandle {
fn lock(&self) -> MutexGuard<'_, KdBackend> {
self.inner
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner)
}
}
impl KdMemory {
fn lock(&self) -> MutexGuard<'_, KdBackend> {
self.inner
.lock()
.unwrap_or_else(std::sync::PoisonError::into_inner)
}
}
impl MemoryOps<PhysAddr> for KdMemory {
fn read_bytes(&self, addr: PhysAddr, buf: &mut [u8]) -> Result<()> {
self.lock().read_physical_bytes(addr, buf)
}
fn write_bytes(&self, addr: PhysAddr, buf: &[u8]) -> Result<()> {
self.lock().write_physical_bytes(addr, buf)
}
fn read_virtual_direct(&self, addr: VirtAddr, root: Dtb, buf: &mut [u8]) -> Option<Result<()>> {
self.lock().read_virtual_direct(addr, root, buf)
}
fn write_virtual_direct(&self, addr: VirtAddr, root: Dtb, buf: &[u8]) -> Option<Result<()>> {
self.lock().write_virtual_direct(addr, root, buf)
}
fn can_mediate_writes(&self) -> bool {
!self.lock().link.is_running()
}
fn translation_cache(&self) -> Option<&TranslationCache> {
Some(&self.translations)
}
fn read_page_table_bytes(&self, addr: PhysAddr, buf: &mut [u8]) -> Result<()> {
self.lock().read_page_table_bytes(addr, buf)
}
}
impl KdBackend {
pub fn connect(socket_path: &str) -> Result<Self> {
eprintln!(
"{} {}",
"kd: using KDCOM backend on".bright_black(),
socket_path.cyan()
);
let stream = UnixStream::connect(socket_path)
.map_err(|err| kd_socket_connect_error(socket_path, err))?;
Self::connect_transport(
KdTransport::Serial(stream),
"kd: serial connected; waiting for Windows KD target",
"kd",
)
}
pub fn connect_net(listen_addr: &str, key: &str) -> Result<Self> {
eprintln!(
"{} {}",
"kdnet: listening on".bright_black(),
listen_addr.cyan()
);
let stream = KdNetStream::bind(listen_addr, key)?;
Self::connect_transport(
KdTransport::Network(stream),
"kdnet: listener ready; waiting for Windows KDNET target",
"kdnet",
)
}
fn connect_transport(
transport: KdTransport,
waiting_message: &str,
backend_name: &'static str,
) -> Result<Self> {
let network_generation = transport.network_session_generation();
let mut framing = KdFraming::new(transport);
if let Some(generation) = network_generation {
framing.use_kdnet_packet_ids(generation);
}
let initial_timeout = kd_initial_timeout()?;
eprintln!(
"{}",
format!("{waiting_message} (timeout {}s)", initial_timeout.as_secs()).bright_black()
);
let mut initial_stop = poll_for_initial_break(&mut framing, initial_timeout)?;
let version = match probe_initial_request(&mut framing, initial_stop.processor) {
Ok(version) => version,
Err(err) => {
if !is_initial_resync_error(&err) {
return Err(err);
}
kd_trace!("kd: initial request probe failed ({err}); resetting KD packet stream");
framing.send_reset()?;
initial_stop = poll_for_initial_break(&mut framing, initial_timeout)?;
probe_initial_request(&mut framing, initial_stop.processor)?
}
};
let arch = detect_arch(version.machine_type)?;
let register_map = match arch {
Arch::Amd64 => context::build_register_map(),
Arch::Arm64 => context_arm64::build_register_map(),
};
framing.take_peer_reset_seen();
kd_trace!(
"kd: initial state-change received: p{}/{}, exc={:#x}, rip={:#x}",
initial_stop.processor + 1,
initial_stop.number_processors,
initial_stop.exception_code,
initial_stop.program_counter
);
let breakin_clone = framing.transport_mut().try_clone()?;
report_reclaimed_breakpoints(restore_unowned_breakpoint_handles(
&mut framing,
initial_stop.processor,
&HashSet::new(),
));
let mut stopped_on_stale_breakpoint = false;
if initial_stop.exception_code == STATUS_BREAKPOINT {
stopped_on_stale_breakpoint = !breakpoint_instruction_at(
&mut framing,
arch,
initial_stop.processor,
initial_stop.program_counter,
);
if stopped_on_stale_breakpoint {
kd_trace!(
"kd: initial stop at {:#x} was a stale breakpoint; resuming in place",
initial_stop.program_counter
);
}
}
let mut breakin_addresses = HashSet::new();
if initial_stop.new_state == DBG_KD_EXCEPTION_STATE_CHANGE
&& initial_stop.exception_code == STATUS_BREAKPOINT
&& !stopped_on_stale_breakpoint
{
breakin_addresses.insert(initial_stop.program_counter);
}
Ok(Self {
link: Link::Halted(framing),
breakin_clone,
backend_name,
register_map,
arch,
kernel_dtb_override: 0,
processor_count: initial_stop.number_processors.max(1),
current_processor: initial_stop.processor,
last_stop_processor: initial_stop.processor,
last_exception_code: initial_stop.exception_code,
last_rip: initial_stop.program_counter,
bp_handles: HashMap::new(),
managed_bp_addresses: HashSet::new(),
breakin_addresses,
pending_write_breakpoint: None,
reconnect_assist_after_continue: None,
special_register_cache: HashMap::new(),
context_cache: HashMap::new(),
special_registers_unsupported: false,
efer_cache: HashMap::new(),
virtual_lines: LineCache::default(),
table_lines: LineCache::default(),
virtual_fill_cap: KD_REMOTE_MEMORY_CHUNK,
exit_prepared: false,
debug_log: DebugLog::new(DEBUG_LOG_CAPACITY),
translations: Arc::new(TranslationCache::default()),
})
}
fn framing(&mut self) -> Result<&mut KdFraming<KdTransport>> {
self.require_no_pending_write_breakpoint()?;
self.framing_unchecked()
}
fn framing_unchecked(&mut self) -> Result<&mut KdFraming<KdTransport>> {
self.link.framing()
}
fn start_pump(
&mut self,
reconnect_assist_delay: Option<Duration>,
drain: Option<ContinueDrain>,
) -> Result<()> {
let framing = match std::mem::replace(&mut self.link, Link::Lost) {
Link::RunningInline(framing) => framing,
other => {
self.link = other;
return Err(Error::Kd(
"cannot start KD pump: target is not resuming".into(),
));
}
};
let (stop_tx, stop_rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let pump_shutdown = Arc::clone(&shutdown);
let reported_stop = Arc::new(AtomicBool::new(false));
let pump_reported_stop = Arc::clone(&reported_stop);
let pump_debug_log = self.debug_log.clone();
let arch = self.arch;
let breakin_requested = drain
.as_ref()
.map(ContinueDrain::interrupt_flag)
.unwrap_or_default();
let join = spawn(move || {
run_pump(
framing,
arch,
PumpLink {
stop_tx,
shutdown: pump_shutdown,
reported_stop: pump_reported_stop,
},
reconnect_assist_delay,
pump_debug_log,
drain,
)
});
kd_trace!("kd: pump: spawned background servicing thread");
self.link = Link::RunningPumped(PumpHandle {
join,
stop_rx,
shutdown,
reported_stop,
breakin_requested,
});
Ok(())
}
fn reclaim_framing(&mut self) {
if let Some(pump) = self.link.take_pump() {
match pump.join.join() {
Ok(framing) => self.link = Link::RunningInline(framing),
Err(_) => {
kd_trace!("kd: pump: thread panicked, framing lost");
}
}
}
}
fn take_pump_stop(&mut self, wait: Option<Duration>) -> Result<Option<StateChange>> {
let Link::RunningPumped(pump) = &self.link else {
return Ok(None);
};
let received = match wait {
None => pump
.stop_rx
.recv()
.map_err(|_| RecvTimeoutError::Disconnected),
Some(timeout) => pump.stop_rx.recv_timeout(timeout),
};
match received {
Ok(result) => {
self.reclaim_framing();
result.map(Some).map_err(Error::Kd)
}
Err(RecvTimeoutError::Timeout) => Ok(None),
Err(RecvTimeoutError::Disconnected) => {
self.reclaim_framing();
Err(Error::Kd("KD pump exited without reporting a stop".into()))
}
}
}
fn shutdown_pump(&mut self) {
let _ = self.shutdown_pump_with_stop();
}
fn try_recv_pump_stop(
stop_rx: &mpsc::Receiver<std::result::Result<StateChange, String>>,
) -> Result<Option<StateChange>> {
match stop_rx.try_recv() {
Ok(Ok(stop)) => Ok(Some(stop)),
Ok(Err(message)) => Err(Error::Kd(message)),
Err(mpsc::TryRecvError::Empty | mpsc::TryRecvError::Disconnected) => Ok(None),
}
}
fn shutdown_pump_with_stop(&mut self) -> Result<Option<StateChange>> {
let Some(pump) = self.link.take_pump() else {
return Ok(None);
};
let PumpHandle {
join,
stop_rx,
shutdown,
reported_stop: _,
breakin_requested: _,
} = pump;
shutdown.store(true, Ordering::SeqCst);
let stop = Self::try_recv_pump_stop(&stop_rx)?;
match join.join() {
Ok(framing) => self.link = Link::RunningInline(framing),
Err(_) => {
kd_trace!("kd: pump: thread panicked during shutdown, framing lost");
if stop.is_none() {
return Err(Error::Kd("KD pump thread panicked during shutdown".into()));
}
}
}
if stop.is_some() {
return Ok(stop);
}
Self::try_recv_pump_stop(&stop_rx)
}
fn send_raw_breakin(&mut self) -> Result<()> {
self.breakin_clone.write_all(&[BREAKIN_BYTE])?;
self.breakin_clone.flush()?;
Ok(())
}
fn known_breakin_stop(&self, stop: &StateChange) -> bool {
stop.new_state == DBG_KD_EXCEPTION_STATE_CHANGE
&& stop.exception_code == STATUS_BREAKPOINT
&& self.breakin_addresses.contains(&stop.program_counter)
&& !self.managed_bp_addresses.contains(&stop.program_counter)
}
fn mark_known_breakin_stop(&self, mut stop: StateChange) -> StateChange {
if self.known_breakin_stop(&stop) {
stop.assisted_breakin = true;
}
stop
}
fn pending_write_breakpoint_error(pending: PendingWriteBreakpoint) -> Error {
Error::Kd(format!(
"breakpoint install at {:#x} is pending; retry the same bp command before issuing other KD commands",
pending.addr
))
}
fn require_no_pending_write_breakpoint(&self) -> Result<()> {
match self.pending_write_breakpoint {
Some(pending) => Err(Self::pending_write_breakpoint_error(pending)),
None => Ok(()),
}
}
fn complete_pending_write_breakpoint(&mut self, addr: u64) -> Result<bool> {
let Some(pending) = self.pending_write_breakpoint else {
return Ok(false);
};
if pending.addr != addr {
return Err(Self::pending_write_breakpoint_error(pending));
}
kd_trace!(
"kd: breakpoint: waiting for late WriteBreakPoint reply at {:#x}",
pending.addr
);
let result = with_framing_read_timeout_raw(
self.framing_unchecked()?,
KD_REQUEST_TIMEOUT,
|framing| api::recv_write_breakpoint_reply(framing, pending.processor),
);
match result {
Ok(handle) => {
kd_trace!(
"kd: breakpoint: completed late WriteBreakPoint at {:#x} handle={}",
pending.addr,
handle
);
self.pending_write_breakpoint = None;
self.bp_handles.insert(pending.addr, handle);
self.managed_bp_addresses.insert(pending.addr);
Ok(true)
}
Err(Error::Io(e)) if is_temporary_io_error(e.kind()) => Err(Error::Kd(format!(
"KD request timed out after {}s; breakpoint install is still pending",
KD_REQUEST_TIMEOUT.as_secs()
))),
Err(err) => {
self.pending_write_breakpoint = None;
Err(err)
}
}
}
fn record_stop(&mut self, stop: &StateChange) {
if stop.target_reloaded {
kd_trace!("kd: target reload detected; clearing target-owned breakpoint state");
self.bp_handles.clear();
self.managed_bp_addresses.clear();
self.breakin_addresses.clear();
self.pending_write_breakpoint = None;
} else if stop.is_bugcheck {
self.reconnect_assist_after_continue = Some(POST_BUGCHECK_RECONNECT_ASSIST_DELAY);
}
let managed_breakpoint_stop = stop.exception_code == STATUS_BREAKPOINT
&& self.managed_bp_addresses.contains(&stop.program_counter);
if stop.assisted_breakin
&& stop.exception_code == STATUS_BREAKPOINT
&& !managed_breakpoint_stop
{
self.breakin_addresses.insert(stop.program_counter);
}
kd_trace!(
"kd: stop on p{}, new_state={:#x}, exception_code={:#x}, rip={:#x}, managed_bp={}",
stop.processor + 1,
stop.new_state,
stop.exception_code,
stop.program_counter,
managed_breakpoint_stop
);
self.current_processor = stop.processor;
self.processor_count = if stop.target_reloaded {
stop.number_processors.max(1)
} else {
self.processor_count.max(stop.number_processors.max(1))
};
self.last_stop_processor = stop.processor;
self.last_exception_code = stop.exception_code;
self.last_rip = stop.program_counter;
self.special_register_cache.clear();
self.context_cache.clear();
self.efer_cache.clear();
self.link.set_inline_running(false);
}
fn record_running(&mut self) {
self.link.set_inline_running(true);
self.special_register_cache.clear();
self.context_cache.clear();
self.efer_cache.clear();
self.virtual_lines.clear();
self.table_lines.clear();
self.translations.resume();
}
fn context_flags(&self) -> u32 {
match self.arch {
Arch::Amd64 => context::CONTEXT_ALL,
Arch::Arm64 => context_arm64::CONTEXT_ALL,
}
}
fn skip_hardcoded_breakpoint(&mut self, processor: u16) -> Result<()> {
if self.last_exception_code != STATUS_BREAKPOINT {
return Ok(());
}
self.require_no_pending_write_breakpoint()?;
let arch = self.arch;
let register_map = self.register_map.clone();
let pc = read_program_counter(self.link.framing()?, ®ister_map, arch, processor)?;
if self.managed_bp_addresses.contains(&pc) {
return Ok(());
}
if !breakpoint_instruction_at(self.link.framing()?, arch, processor, pc) {
kd_trace!(
"kd: stop at {pc:#x} reported a breakpoint but memory holds none; resuming in place"
);
return Ok(());
}
let owned: HashSet<u32> = self.bp_handles.values().copied().collect();
let reclaimed = restore_unowned_breakpoint_handles(self.link.framing()?, processor, &owned);
report_reclaimed_breakpoints(reclaimed);
if reclaimed != 0 && !breakpoint_instruction_at(self.link.framing()?, arch, processor, pc) {
kd_trace!("kd: released a stranded breakpoint at {pc:#x}; resuming in place");
return Ok(());
}
kd_trace!(
"kd: advancing p{} past a hard-coded int3 at {pc:#x}",
processor + 1
);
self.context_cache.remove(&processor);
advance_pc_past_breakpoint(self.link.framing()?, ®ister_map, arch, processor, pc)
}
fn read_dr_slot_state(&mut self, slot: u8) -> Result<DebugRegisterSlotState> {
let special = self.read_special_registers_uncached(self.current_processor)?;
Ok(DebugRegisterSlotState {
address: wire::read_u64(&special, Self::kspecial_dr_offset(slot)),
dr7: wire::read_u64(&special, KSPECIAL_REGISTERS_DR7_OFFSET),
})
}
fn apply_dr_restore(&mut self, slot: u8, state: DebugRegisterSlotState) -> Result<()> {
let mut special = self.read_special_registers_uncached(self.current_processor)?;
wire::write_u64(&mut special, Self::kspecial_dr_offset(slot), state.address);
wire::write_u64(&mut special, KSPECIAL_REGISTERS_DR7_OFFSET, state.dr7);
self.write_special_registers(special)
}
fn read_arm64_slot_state(&mut self, slot: u8) -> Result<Arm64DebugRegisterSlotState> {
let special = self.read_special_registers_uncached(self.current_processor)?;
let (address_offset, control_offset) = arm64_slot_offsets(slot)?;
Ok(Arm64DebugRegisterSlotState {
address: wire::read_u64(&special, address_offset),
control: wire::read_u32(&special, control_offset),
})
}
fn apply_arm64_restore(&mut self, slot: u8, state: Arm64DebugRegisterSlotState) -> Result<()> {
let mut special = self.read_special_registers_uncached(self.current_processor)?;
let (address_offset, control_offset) = arm64_slot_offsets(slot)?;
wire::write_u64(&mut special, address_offset, state.address);
wire::write_u32(&mut special, control_offset, state.control);
self.write_special_registers(special)
}
fn rollback_slot_states<S: Copy>(
&mut self,
slot: u8,
states: &[(u16, S)],
mut restore: impl FnMut(&mut Self, u8, S) -> Result<()>,
) -> Result<()> {
let mut first_error = None;
for &(processor, state) in states.iter().rev() {
self.current_processor = processor;
if let Err(error) = restore(self, slot, state)
&& first_error.is_none()
{
first_error = Some(error);
}
}
match first_error {
Some(error) => Err(error),
None => Ok(()),
}
}
fn update_slot_on_all_processors<S: Copy>(
&mut self,
slot: u8,
operation: &str,
label: &str,
mut read: impl FnMut(&mut Self, u8) -> Result<S>,
mut restore: impl FnMut(&mut Self, u8, S) -> Result<()>,
mut update: impl FnMut(&mut Self) -> Result<()>,
) -> Result<()> {
let slot_count = self.hardware_breakpoint_slots();
if slot >= slot_count {
return Err(Error::Kd(format!(
"invalid hardware breakpoint slot {slot} (expected 0-{})",
slot_count.saturating_sub(1)
)));
}
let saved = self.current_processor;
let result = (|| {
let mut applied = Vec::with_capacity(self.processor_count.max(1) as usize);
let mut failure = None;
for processor in 0..self.processor_count.max(1) {
self.current_processor = processor;
let previous = match read(self, slot) {
Ok(previous) => previous,
Err(error) => {
failure = Some(error);
break;
}
};
applied.push((processor, previous));
if let Err(error) = update(self) {
failure = Some(error);
break;
}
}
let Some(error) = failure else {
return Ok(());
};
match self.rollback_slot_states(slot, &applied, &mut restore) {
Ok(()) => Err(error),
Err(rollback_error) => Err(Error::Kd(format!(
"{label} {operation} failed: {error}; rollback also failed: {rollback_error}"
))),
}
})();
self.current_processor = saved;
result
}
fn apply_arm64_set(
&mut self,
slot: u8,
addr: u64,
access: HwBreakpointAccess,
len: u8,
) -> Result<()> {
let (address_offset, control_offset) = arm64_slot_offsets_for_access(slot, access)?;
if matches!(access, HwBreakpointAccess::Execute) && (len != 1 || !addr.is_multiple_of(4)) {
return Err(Error::InvalidArgument(
"ARM64 execute hardware breakpoints require a 4-byte-aligned address and length 1"
.into(),
));
}
let mut special = self.read_special_registers_uncached(self.current_processor)?;
if matches!(access, HwBreakpointAccess::Execute) {
wire::write_u64(&mut special, address_offset, addr);
wire::write_u32(&mut special, control_offset, hwbp::arm64_bcr_value(addr));
} else {
wire::write_u64(&mut special, address_offset, hwbp::arm64_wvr_address(addr));
wire::write_u32(
&mut special,
control_offset,
hwbp::arm64_wcr_value(addr, access, len),
);
}
self.write_special_registers(special)
}
fn apply_arm64_clear(&mut self, slot: u8) -> Result<()> {
let (address_offset, control_offset) = arm64_slot_offsets(slot)?;
let mut special = self.read_special_registers_uncached(self.current_processor)?;
wire::write_u64(&mut special, address_offset, 0);
wire::write_u32(&mut special, control_offset, 0);
self.write_special_registers(special)
}
fn kspecial_dr_offset(slot: u8) -> usize {
KSPECIAL_REGISTERS_DR0_OFFSET + slot as usize * 8
}
fn apply_dr_set(
&mut self,
slot: u8,
addr: u64,
access: HwBreakpointAccess,
len: u8,
) -> Result<()> {
let mut special = self.read_special_registers_uncached(self.current_processor)?;
wire::write_u64(&mut special, Self::kspecial_dr_offset(slot), addr);
let dr7 = wire::read_u64(&special, KSPECIAL_REGISTERS_DR7_OFFSET);
let dr7 = hwbp::dr7_set_slot(dr7, slot, access, len);
wire::write_u64(&mut special, KSPECIAL_REGISTERS_DR7_OFFSET, dr7);
self.write_special_registers(special)
}
fn apply_dr_clear(&mut self, slot: u8) -> Result<()> {
let mut special = self.read_special_registers_uncached(self.current_processor)?;
let dr7 = wire::read_u64(&special, KSPECIAL_REGISTERS_DR7_OFFSET);
let dr7 = hwbp::dr7_clear_slot(dr7, slot);
wire::write_u64(&mut special, KSPECIAL_REGISTERS_DR7_OFFSET, dr7);
wire::write_u64(&mut special, Self::kspecial_dr_offset(slot), 0);
self.write_special_registers(special)
}
fn read_special_registers_uncached(&mut self, processor: u16) -> Result<Vec<u8>> {
let (base, size) = kspecial_control_space(self.arch);
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::read_control_space(framing, processor, base, size as u32)
})
}
fn read_msr_value(&mut self, processor: u16, msr: u32) -> Result<u64> {
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::read_machine_specific_register(framing, processor, msr)
})
}
fn validate_processor(&self, processor: u16) -> Result<()> {
if processor >= self.processor_count.max(1) {
return Err(Error::Kd(format!(
"processor {} is out of range (target reports {} processor(s))",
processor + 1,
self.processor_count.max(1)
)));
}
Ok(())
}
fn write_special_registers(&mut self, special: Vec<u8>) -> Result<()> {
let processor = self.current_processor;
let (base, expected_size) = kspecial_control_space(self.arch);
let actual = with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::write_control_space(framing, processor, base, &special)
})?;
if actual as usize != special.len() {
return Err(Error::Kd(format!(
"short KSPECIAL_REGISTERS write on processor {}: wrote {} of {} bytes (requested layout size {})",
processor + 1,
actual,
special.len(),
expected_size,
)));
}
self.special_register_cache.insert(processor, special);
Ok(())
}
fn read_special_registers(&mut self) -> Result<&[u8]> {
if !self
.special_register_cache
.contains_key(&self.current_processor)
{
let processor = self.current_processor;
let data = self.read_special_registers_uncached(processor)?;
self.special_register_cache.insert(processor, data);
}
self.special_register_cache
.get(&self.current_processor)
.map(Vec::as_slice)
.ok_or_else(|| Error::Kd("special-register cache lookup failed".into()))
}
fn arm64_special_registers(&mut self) -> Option<&[u8]> {
if self.special_registers_unsupported {
return None;
}
if let Err(error) = self.read_special_registers().map(|_| ()) {
kd_trace!("kd: ARM64 KSPECIAL_REGISTERS unavailable: {error}");
self.special_registers_unsupported = true;
return None;
}
self.special_register_cache
.get(&self.current_processor)
.map(Vec::as_slice)
.filter(|special| special.len() >= ARM64_KSPECIAL_REGISTERS_MIN_SIZE)
}
fn append_control_registers(&mut self, ctx: &mut Vec<u8>) -> Result<()> {
match self.arch {
Arch::Amd64 => {
let special = self.read_special_registers()?;
append_control_registers_from_special(ctx, special)
}
Arch::Arm64 => {
if ctx.len() < context_arm64::CONTEXT_SIZE {
return Err(Error::Kd(format!(
"ARM64 CONTEXT buffer too short: {} bytes, expected {}",
ctx.len(),
context_arm64::CONTEXT_SIZE
)));
}
let ttbr0 =
match self.read_msr_value(self.current_processor, ARM64_WINDBG_TTBR0_EL1) {
Ok(value) => value & Arch::Arm64.dtb_page_mask(),
Err(error) => {
kd_trace!("kd: ARM64 TTBR0_EL1 read unavailable: {error}");
0
}
};
let (esr, far) = if self.last_exception_code == STATUS_SINGLE_STEP {
let esr =
match self.read_msr_value(self.current_processor, ARM64_WINDBG_ESR_EL1) {
Ok(value) => value,
Err(error) => {
kd_trace!("kd: ARM64 ESR_EL1 read unavailable: {error}");
0
}
};
let far =
match self.read_msr_value(self.current_processor, ARM64_WINDBG_FAR_EL1) {
Ok(value) => value,
Err(error) => {
kd_trace!("kd: ARM64 FAR_EL1 read unavailable: {error}");
0
}
};
(esr, far)
} else {
(0, 0)
};
let kernel_dtb = self.kernel_dtb_override;
ctx.resize(context_arm64::REGISTER_BUFFER_SIZE, 0);
ctx[context_arm64::OFFSET_CR3..context_arm64::OFFSET_CR3 + 8]
.copy_from_slice(&kernel_dtb.to_le_bytes());
ctx[context_arm64::OFFSET_TTBR0..context_arm64::OFFSET_TTBR0 + 8]
.copy_from_slice(&ttbr0.to_le_bytes());
if let Some(special) = self.arm64_special_registers() {
copy_arm64_debug_registers(ctx, special, true);
}
if self.last_exception_code == STATUS_SINGLE_STEP {
ctx[context_arm64::OFFSET_ESR..context_arm64::OFFSET_ESR + 8]
.copy_from_slice(&esr.to_le_bytes());
ctx[context_arm64::OFFSET_FAR..context_arm64::OFFSET_FAR + 8]
.copy_from_slice(&far.to_le_bytes());
}
Ok(())
}
}
}
fn continue_preserving_dr7(&mut self, processor: u16, status: u32, trace: bool) -> Result<()> {
match self.arch {
Arch::Amd64 => {
if !self.special_register_cache.contains_key(&processor) {
let special = self.read_special_registers_uncached(processor)?;
self.special_register_cache.insert(processor, special);
}
let special = self
.special_register_cache
.get(&processor)
.expect("cache holds processor; we just inserted it on miss");
let dr7 = wire::read_u64(special, KSPECIAL_REGISTERS_DR7_OFFSET);
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::continue_api2(framing, processor, status, trace, dr7)
})
}
Arch::Arm64 => {
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::continue_api2_arm64(framing, processor, status, trace)
})
}
}
}
fn continue_stopped_for_exit(&mut self) -> Result<()> {
let processor = self.last_stop_processor;
self.skip_hardcoded_breakpoint(processor)?;
self.continue_preserving_dr7(processor, api::DBG_CONTINUE, false)?;
self.record_running();
Ok(())
}
fn restore_tracked_breakpoints(&mut self) {
if self.bp_handles.is_empty()
|| self.link.is_running()
|| self.pending_write_breakpoint.is_some()
{
return;
}
let processor = self.current_processor;
self.virtual_lines.clear();
for (addr, handle) in take(&mut self.bp_handles) {
let Ok(framing) = self.framing() else { return };
match with_framing_read_timeout(framing, KD_REQUEST_TIMEOUT, |framing| {
api::restore_breakpoint(framing, processor, handle)
}) {
Ok(()) => {
self.managed_bp_addresses.remove(&addr);
}
Err(error) => kd_trace!(
"kd: exit: restoring breakpoint handle {handle} at {addr:#x} failed: {error}"
),
}
}
}
fn write_breakpoint_after_reclaim(&mut self, addr: u64, processor: u16) -> Result<u32> {
let reclaimed = self.reclaim_stranded_breakpoints(processor);
if reclaimed == 0 {
return Err(Self::breakpoint_table_error(addr));
}
report_reclaimed_breakpoints(reclaimed);
match with_framing_read_timeout_raw(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::write_breakpoint(framing, processor, addr)
}) {
Ok(handle) => Ok(handle),
Err(Error::KdStatus { ntstatus, api })
if ntstatus == STATUS_UNSUCCESSFUL && api == api::DBGKD_WRITE_BREAKPOINT =>
{
Err(Self::breakpoint_table_error(addr))
}
Err(error) => Err(error),
}
}
fn reclaim_stranded_breakpoints(&mut self, processor: u16) -> usize {
let owned: HashSet<u32> = self.bp_handles.values().copied().collect();
let Ok(framing) = self.framing() else {
return 0;
};
restore_unowned_breakpoint_handles(framing, processor, &owned)
}
fn breakpoint_table_error(addr: u64) -> Error {
Error::Kd(format!(
"target refused a breakpoint at {addr:#x}: all {KD_BREAKPOINT_TABLE_SIZE} entries in \
its breakpoint table are taken; entries an earlier session stranded in a page the \
target can no longer write back only clear when the guest reboots"
))
}
fn absorb_stray_single_step_for_exit(&mut self, stop: &StopEvent) {
if exit_stop_is_stray_single_step(stop, &self.managed_bp_addresses) {
let register_map = self.register_map.clone();
let _ = clear_trap_flag(self, ®ister_map);
}
}
fn finish_for_exit(&mut self, leave_running: bool) -> Result<()> {
if let Some(stop) = self.shutdown_pump_with_stop()? {
self.record_stop(&stop);
}
self.restore_tracked_breakpoints();
if !leave_running {
return Ok(());
}
for _ in 0..KD_EXIT_MAX_CONTINUES {
if self.link.is_running() {
match self.try_wait_for_stop(KD_EXIT_STOP_POLL)? {
None => return Ok(()),
Some(stop) => self.absorb_stray_single_step_for_exit(&stop),
}
}
self.continue_stopped_for_exit()?;
match self.try_wait_for_stop(KD_EXIT_STOP_POLL)? {
None => return Ok(()),
Some(stop) => self.absorb_stray_single_step_for_exit(&stop),
}
}
Err(Error::Kd(format!(
"target kept stopping during debugger exit after {KD_EXIT_MAX_CONTINUES} continues"
)))
}
pub fn target_hints(&mut self) -> Result<KdTargetHints> {
let processor = self.current_processor;
let version = with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::get_version(framing, processor)
})?;
let register_value = match self.arch {
Arch::Amd64 => {
let special = self.read_special_registers_uncached(processor)?;
wire::read_u64(&special, KSPECIAL_REGISTERS_CR3_OFFSET)
}
Arch::Arm64 => {
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::read_machine_specific_register(framing, processor, ARM64_WINDBG_TTBR1_EL1)
})?
}
};
let kernel_dtb = normalize_kernel_dtb(self.arch, register_value);
if kernel_dtb == 0 || version.kern_base == 0 || version.ps_loaded_module_list == 0 {
return Err(Error::Kd(format!(
"KD target did not expose usable discovery hints (dtb={kernel_dtb:#x}, base={:#x}, psmods={:#x})",
version.kern_base, version.ps_loaded_module_list
)));
}
self.kernel_dtb_override = kernel_dtb;
kd_trace!(
"kd: memory hints: dtb={kernel_dtb:#x} base={:#x} psmods={:#x} arch={:?}",
version.kern_base,
version.ps_loaded_module_list,
self.arch
);
Ok(KdTargetHints {
kernel_dtb,
kernel_base: VirtAddr(version.kern_base),
ps_loaded_module_list: VirtAddr(version.ps_loaded_module_list),
arch: self.arch,
})
}
pub fn validate_host_memory<P: MemoryOps<PhysAddr>>(
&mut self,
phys: &P,
hints: KdTargetHints,
) -> Result<()> {
let local = match hints.arch {
Arch::Amd64 => AddressSpace::new(phys, hints.kernel_dtb),
Arch::Arm64 => AddressSpace::new_arm64(phys, hints.kernel_dtb, hints.kernel_dtb),
};
for (address, len, label) in [
(hints.kernel_base, 64usize, "kernel PE header"),
(hints.ps_loaded_module_list, 16usize, "loaded-module list"),
] {
let mut local_bytes = vec![0u8; len];
local.read_bytes(address, &mut local_bytes)?;
let processor = self.current_processor;
let remote_bytes =
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::read_virtual_memory(framing, processor, address.0, len as u32)
})?;
if remote_bytes != local_bytes {
return Err(Error::Kd(format!(
"host VM memory does not match KD target ({label} differs)"
)));
}
}
Ok(())
}
pub fn into_remote_memory(self) -> (KdBackendHandle, KdMemory) {
let register_map = self.register_map.clone();
let backend_name = self.backend_name;
let translations = Arc::clone(&self.translations);
let inner = Arc::new(Mutex::new(self));
(
KdBackendHandle {
inner: Arc::clone(&inner),
register_map,
backend_name,
},
KdMemory {
inner,
translations,
},
)
}
fn require_remote_memory_stopped(&self) -> Result<()> {
if self.link.is_running() {
return Err(Error::Kd(
"KD remote memory requires a halted target; interrupt it before reading memory"
.into(),
));
}
self.require_no_pending_write_breakpoint()
}
fn read_physical_bytes(&mut self, addr: PhysAddr, buf: &mut [u8]) -> Result<()> {
self.require_remote_memory_stopped()?;
let processor = self.current_processor;
let mut completed = 0usize;
while completed < buf.len() {
let chunk_addr = addr
.checked_add(completed as u64)
.ok_or_else(|| Error::Kd("physical-memory read address overflow".into()))?;
let requested = (buf.len() - completed).min(KD_REMOTE_MEMORY_CHUNK);
let data =
match with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::read_physical_memory(framing, processor, chunk_addr, requested as u32)
}) {
Ok(data) => data,
Err(Error::KdStatus { .. }) => {
return Err(Error::BadPhysicalAddress(chunk_addr));
}
Err(error) => return Err(error),
};
kd_trace!(
"kd: remote physical read {chunk_addr:#x}+{requested:#x} -> {:#x} {:02x?}",
data.len(),
&data[..data.len().min(8)]
);
let end = completed + data.len();
buf[completed..end].copy_from_slice(&data);
completed = end;
}
Ok(())
}
fn read_page_table_bytes(&mut self, addr: PhysAddr, buf: &mut [u8]) -> Result<()> {
self.require_remote_memory_stopped()?;
let processor = self.current_processor;
let mut completed = 0usize;
while completed < buf.len() {
let chunk_addr = addr
.checked_add(completed as u64)
.ok_or_else(|| Error::Kd("physical-memory read address overflow".into()))?;
let line = chunk_addr & !(KD_VIRTUAL_LINE as u64 - 1);
let offset = (chunk_addr - line) as usize;
if self.table_lines.get(line).is_none() {
let data = match with_framing_read_timeout(
self.framing()?,
KD_REQUEST_TIMEOUT,
|framing| {
api::read_physical_memory(framing, processor, line, KD_VIRTUAL_LINE as u32)
},
) {
Ok(data) => data,
Err(Error::KdStatus { .. }) => {
return Err(Error::BadPhysicalAddress(chunk_addr));
}
Err(error) => return Err(error),
};
kd_trace!(
"kd: remote table read {line:#x}+{KD_VIRTUAL_LINE:#x} -> {:#x}",
data.len()
);
self.table_lines.insert(line, data);
}
let data = self.table_lines.get(line).expect("line was just inserted");
let available = data.len().saturating_sub(offset);
if available == 0 {
return Err(Error::BadPhysicalAddress(chunk_addr));
}
let end = completed + available.min(buf.len() - completed);
buf[completed..end].copy_from_slice(&data[offset..offset + end - completed]);
completed = end;
}
Ok(())
}
fn write_physical_bytes(&mut self, addr: PhysAddr, buf: &[u8]) -> Result<()> {
self.require_remote_memory_stopped()?;
self.translations.clear();
self.virtual_lines.clear();
self.table_lines.clear();
let processor = self.current_processor;
let mut completed = 0usize;
while completed < buf.len() {
let chunk_addr = addr
.checked_add(completed as u64)
.ok_or_else(|| Error::Kd("physical-memory write address overflow".into()))?;
let requested = (buf.len() - completed).min(KD_REMOTE_MEMORY_CHUNK);
let written =
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::write_physical_memory(
framing,
processor,
chunk_addr,
&buf[completed..completed + requested],
)
})? as usize;
completed += written;
}
Ok(())
}
fn read_virtual_direct(
&mut self,
addr: VirtAddr,
root: Dtb,
buf: &mut [u8],
) -> Option<Result<()>> {
if !self.virtual_api_serves(addr, root) {
return None;
}
Some(self.read_virtual_bytes(addr, buf))
}
fn virtual_api_serves(&mut self, addr: VirtAddr, root: Dtb) -> bool {
let kernel_space = match self.arch {
Arch::Amd64 => addr.0 >> 63 != 0,
Arch::Arm64 => addr.0 & (1 << 55) != 0,
};
kernel_space || self.current_processor_runs_on(root)
}
fn current_processor_runs_on(&mut self, root: Dtb) -> bool {
if self.arch != Arch::Amd64 || self.require_remote_memory_stopped().is_err() {
return false;
}
let Ok(special) = self.read_special_registers() else {
return false;
};
let cr3 = wire::read_u64(special, KSPECIAL_REGISTERS_CR3_OFFSET);
let mask = self.arch.dtb_page_mask();
cr3 & mask == root & mask
}
fn write_virtual_direct(
&mut self,
addr: VirtAddr,
root: Dtb,
buf: &[u8],
) -> Option<Result<()>> {
if !self.virtual_api_serves(addr, root) {
return None;
}
Some(self.write_virtual_bytes(addr, buf))
}
fn write_virtual_bytes(&mut self, addr: VirtAddr, buf: &[u8]) -> Result<()> {
self.require_remote_memory_stopped()?;
self.translations.clear();
self.virtual_lines.clear();
self.table_lines.clear();
let processor = self.current_processor;
let mut completed = 0usize;
while completed < buf.len() {
let chunk_addr = addr
.0
.checked_add(completed as u64)
.ok_or_else(|| Error::Kd("virtual-memory write address overflow".into()))?;
let to_page_end = PAGE_SIZE - (chunk_addr as usize & (PAGE_SIZE - 1));
let requested = (buf.len() - completed)
.min(KD_REMOTE_MEMORY_CHUNK)
.min(to_page_end);
let written =
match with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::write_virtual_memory(
framing,
processor,
chunk_addr,
&buf[completed..completed + requested],
)
}) {
Ok(written) => written as usize,
Err(Error::KdStatus { .. }) if completed > 0 => {
return Err(Error::PartialWrite(completed));
}
Err(Error::KdStatus { .. }) => {
return Err(Error::BadVirtualAddress(VirtAddr(chunk_addr)));
}
Err(error) => return Err(error),
};
if written == 0 {
return Err(Error::PartialWrite(completed));
}
kd_trace!(
"kd: remote virtual write {chunk_addr:#x}+{written:#x} {:02x?}",
&buf[completed..completed + written.min(8)]
);
completed += written;
}
Ok(())
}
fn read_virtual_bytes(&mut self, addr: VirtAddr, buf: &mut [u8]) -> Result<()> {
self.require_remote_memory_stopped()?;
let processor = self.current_processor;
let request_end = addr
.0
.checked_add(buf.len() as u64)
.ok_or_else(|| Error::Kd("virtual-memory read address overflow".into()))?;
let mut completed = 0usize;
while completed < buf.len() {
let chunk_addr = addr.0 + completed as u64;
let line = chunk_addr & !(KD_VIRTUAL_LINE as u64 - 1);
let offset = (chunk_addr - line) as usize;
let refused = |completed: usize| {
if completed > 0 {
Error::PartialRead(completed)
} else {
Error::BadVirtualAddress(VirtAddr(chunk_addr))
}
};
if self.virtual_lines.get((processor, line)).is_none() {
let wanted = request_end.next_multiple_of(KD_VIRTUAL_LINE as u64) - line;
let to_page_end = PAGE_SIZE as u64 - (line & (PAGE_SIZE as u64 - 1));
let fill = wanted.min(self.virtual_fill_cap as u64).min(to_page_end) as usize;
let data = match with_framing_read_timeout(
self.framing()?,
KD_REQUEST_TIMEOUT,
|framing| api::read_virtual_memory(framing, processor, line, fill as u32),
) {
Ok(data) => data,
Err(Error::KdStatus { .. }) => return Err(refused(completed)),
Err(error) => return Err(error),
};
kd_trace!(
"kd: remote virtual read {line:#x}+{fill:#x} -> {:#x}",
data.len()
);
let whole = data.len() / KD_VIRTUAL_LINE * KD_VIRTUAL_LINE;
if whole == 0 {
return Err(refused(completed));
}
if data.len() < fill {
self.virtual_fill_cap = whole;
}
for (index, piece) in data[..whole].chunks(KD_VIRTUAL_LINE).enumerate() {
self.virtual_lines.insert(
(processor, line + (index * KD_VIRTUAL_LINE) as u64),
piece.to_vec(),
);
}
}
let data = self
.virtual_lines
.get((processor, line))
.expect("line was just inserted");
let end = completed + (data.len() - offset).min(buf.len() - completed);
buf[completed..end].copy_from_slice(&data[offset..offset + end - completed]);
completed = end;
}
Ok(())
}
fn needs_drop_cleanup(&self) -> bool {
!self.exit_prepared && matches!(self.link, Link::Halted(_) | Link::RunningPumped(_))
}
}
impl DebugBackend for KdBackend {
fn register_map(&self) -> &RegisterMap {
&self.register_map
}
fn name(&self) -> &'static str {
self.backend_name
}
fn set_kernel_dtb(&mut self, dtb: u64) {
self.kernel_dtb_override = dtb;
kd_trace!("kd: kernel page-table root = {dtb:#x}");
}
fn read_registers(&mut self) -> Result<Vec<u8>> {
if let Some(cached) = self.context_cache.get(&self.current_processor) {
return Ok(cached.clone());
}
kd_trace!(
"kd: read_registers: GetContext on p{}",
self.current_processor + 1
);
let processor = self.current_processor;
let context_flags = self.context_flags();
let mut ctx = with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::get_context(framing, processor, context_flags)
})?;
kd_trace!("kd: read_registers: got {} context bytes", ctx.len());
self.append_control_registers(&mut ctx)?;
if self.arch == Arch::Amd64 {
let efer = self.efer_cache.get(&processor).copied().or_else(|| {
match self.read_msr_value(processor, MSR_EFER) {
Ok(value) => {
self.efer_cache.insert(processor, value);
Some(value)
}
Err(error) => {
kd_trace!("kd: EFER read unavailable: {error}");
None
}
}
});
if let Some(efer) = efer {
wire::write_u64(&mut ctx, context::OFFSET_EFER, efer);
}
}
kd_trace!("kd: read_registers: extended to {} bytes", ctx.len());
if trace_enabled() {
let cr3 = self.register_map.read_u64("cr3", &ctx).unwrap_or(0);
let pc = self.register_map.read_u64("pc", &ctx).unwrap_or(0);
let sp = self.register_map.read_u64("sp", &ctx).unwrap_or(0);
kd_trace!("kd: read_registers: cr3={cr3:#x} pc={pc:#x} sp={sp:#x}");
}
self.context_cache.insert(processor, ctx.clone());
Ok(ctx)
}
fn write_registers(&mut self, data: &[u8]) -> Result<()> {
let processor = self.current_processor;
self.context_cache.remove(&processor);
match self.arch {
Arch::Amd64 => {
let context = context_payload(data)?;
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::set_context_chunked(framing, processor, context)
})?;
let mut special = self.read_special_registers_uncached(self.current_processor)?;
update_special_debug_registers_from_context(&mut special, data)?;
self.write_special_registers(special)
}
Arch::Arm64 => {
if data.len() < context_arm64::CONTEXT_SIZE {
return Err(Error::Kd(format!(
"ARM64 CONTEXT buffer too short: {} bytes, expected {}",
data.len(),
context_arm64::CONTEXT_SIZE
)));
}
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::set_context_chunked(
framing,
processor,
&data[..context_arm64::CONTEXT_SIZE],
)
})?;
if self.special_registers_unsupported {
return Ok(());
}
let mut special = match self.read_special_registers_uncached(processor) {
Ok(special) => special,
Err(error) => {
kd_trace!("kd: ARM64 KSPECIAL_REGISTERS mirror skipped: {error}");
self.special_registers_unsupported = true;
return Ok(());
}
};
update_arm64_debug_registers_from_context(&mut special, data)?;
self.write_special_registers(special)
}
}
}
fn set_breakpoint(&mut self, addr: u64) -> Result<()> {
if self.complete_pending_write_breakpoint(addr)? {
return Ok(());
}
self.virtual_lines.clear();
let processor = self.current_processor;
let result =
with_framing_read_timeout_raw(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::write_breakpoint(framing, processor, addr)
});
let handle = match result {
Ok(handle) => handle,
Err(Error::Io(e)) if is_temporary_io_error(e.kind()) => {
self.pending_write_breakpoint = Some(PendingWriteBreakpoint { addr, processor });
return Err(Error::Kd(format!(
"KD request timed out after {}s; breakpoint install is pending, retry the same bp command to complete it",
KD_REQUEST_TIMEOUT.as_secs()
)));
}
Err(Error::KdStatus { ntstatus, api })
if ntstatus == STATUS_UNSUCCESSFUL && api == api::DBGKD_WRITE_BREAKPOINT =>
{
self.write_breakpoint_after_reclaim(addr, processor)?
}
Err(err) => return Err(err),
};
self.bp_handles.insert(addr, handle);
self.managed_bp_addresses.insert(addr);
Ok(())
}
fn remove_breakpoint(&mut self, addr: u64) -> Result<()> {
let handle = *self
.bp_handles
.get(&addr)
.ok_or_else(|| Error::Kd(format!("no breakpoint tracked at {addr:#x}")))?;
self.virtual_lines.clear();
let processor = self.current_processor;
let result = with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::restore_breakpoint(framing, processor, handle)
});
match result {
Ok(()) => {}
Err(Error::KdStatus { ntstatus, api })
if ntstatus == STATUS_UNSUCCESSFUL && api == api::DBGKD_RESTORE_BREAKPOINT =>
{
let arch = self.arch;
if breakpoint_instruction_at(self.link.framing()?, arch, processor, addr) {
return Err(Error::Kd(format!(
"target refused to release the breakpoint at {addr:#x} (handle {handle}) \
and the site still holds a breakpoint instruction"
)));
}
kd_trace!(
"kd: restore breakpoint handle {handle} at {addr:#x} was already consumed"
);
}
Err(e) => return Err(e),
}
self.bp_handles.remove(&addr);
self.managed_bp_addresses.remove(&addr);
Ok(())
}
fn supports_watchpoints(&self) -> bool {
matches!(self.arch, Arch::Amd64 | Arch::Arm64)
}
fn hardware_breakpoint_slots(&self) -> u8 {
match self.arch {
Arch::Amd64 => HW_BREAKPOINT_SLOTS,
Arch::Arm64 => hwbp::ARM64_MAX_BREAKPOINTS + hwbp::ARM64_MAX_WATCHPOINTS,
}
}
fn hardware_slot_range(&self, access: HwBreakpointAccess) -> std::ops::Range<u8> {
match self.arch {
Arch::Amd64 => 0..HW_BREAKPOINT_SLOTS,
Arch::Arm64 => hwbp::arm64_slot_range(access),
}
}
fn set_hardware_breakpoint(
&mut self,
slot: u8,
addr: u64,
access: HwBreakpointAccess,
len: u8,
) -> Result<()> {
if !self.supports_watchpoints() {
return Err(Error::NotSupported);
}
match self.arch {
Arch::Amd64 => {
self.update_slot_on_all_processors(
slot,
"install",
"hardware breakpoint",
|backend, slot| backend.read_dr_slot_state(slot),
|backend, slot, state| backend.apply_dr_restore(slot, state),
|backend| backend.apply_dr_set(slot, addr, access, len),
)
}
Arch::Arm64 => {
arm64_slot_offsets_for_access(slot, access)?;
self.update_slot_on_all_processors(
slot,
"install",
"ARM64 hardware breakpoint",
|backend, slot| backend.read_arm64_slot_state(slot),
|backend, slot, state| backend.apply_arm64_restore(slot, state),
|backend| backend.apply_arm64_set(slot, addr, access, len),
)
}
}
}
fn clear_hardware_breakpoint(&mut self, slot: u8) -> Result<()> {
if !self.supports_watchpoints() {
return Err(Error::NotSupported);
}
match self.arch {
Arch::Amd64 => self.update_slot_on_all_processors(
slot,
"clear",
"hardware breakpoint",
|backend, slot| backend.read_dr_slot_state(slot),
|backend, slot, state| backend.apply_dr_restore(slot, state),
|backend| backend.apply_dr_clear(slot),
),
Arch::Arm64 => {
arm64_slot_offsets(slot)?;
self.update_slot_on_all_processors(
slot,
"clear",
"ARM64 hardware breakpoint",
|backend, slot| backend.read_arm64_slot_state(slot),
|backend, slot, state| backend.apply_arm64_restore(slot, state),
|backend| backend.apply_arm64_clear(slot),
)
}
}
}
fn supports_user_mode_breakpoints(&self) -> bool {
matches!(self.arch, Arch::Amd64 | Arch::Arm64)
}
fn supports_msr(&self) -> bool {
true
}
fn read_msr(&mut self, processor: u16, msr: u32) -> Result<u64> {
self.validate_processor(processor)?;
self.read_msr_value(processor, msr)
}
fn write_msr(&mut self, processor: u16, msr: u32, value: u64) -> Result<()> {
self.validate_processor(processor)?;
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::write_machine_specific_register(framing, processor, msr, value)
})?;
if msr == MSR_EFER {
self.efer_cache.insert(processor, value);
}
Ok(())
}
fn supports_target_control(&self) -> bool {
true
}
fn supports_target_file_io(&self) -> bool {
true
}
fn reboot_target(&mut self) -> Result<()> {
let processor = self.current_processor;
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::reboot(framing, processor)
})?;
self.record_running();
self.start_pump(Some(Duration::ZERO), None)
}
fn cause_bugcheck(&mut self) -> Result<()> {
let processor = self.current_processor;
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::cause_bugcheck(framing, processor)
})?;
self.record_running();
self.start_pump(Some(POST_BUGCHECK_RECONNECT_ASSIST_DELAY), None)
}
fn optional_capabilities(&self) -> Vec<BackendCapability> {
vec![
BackendCapability {
capability: DebugCapability::UserModeBreakpoints,
supported: self.supports_user_mode_breakpoints(),
},
BackendCapability {
capability: DebugCapability::Watchpoints,
supported: self.supports_watchpoints(),
},
BackendCapability::supported(DebugCapability::TargetReloadDetection),
BackendCapability::supported(DebugCapability::KernelBaseHint),
BackendCapability::supported(DebugCapability::BugcheckDetection),
BackendCapability::supported(DebugCapability::BugcheckDetails),
BackendCapability::supported(DebugCapability::DebugOutput),
BackendCapability {
capability: DebugCapability::Msr,
supported: self.supports_msr(),
},
BackendCapability {
capability: DebugCapability::TargetControl,
supported: self.supports_target_control(),
},
BackendCapability {
capability: DebugCapability::TargetFileIo,
supported: self.supports_target_file_io(),
},
]
}
fn read_debug_output(&self, since_seq: u64) -> DebugOutputPage {
self.debug_log.read_since(since_seq)
}
fn note_breakpoint_installed(&mut self, addr: u64) {
self.managed_bp_addresses.insert(addr);
}
fn note_breakpoint_uninstalled(&mut self, addr: u64) {
self.managed_bp_addresses.remove(&addr);
}
fn target_manages_breakpoint_sites(&self) -> bool {
true
}
fn note_target_rediscovery_pending(&mut self) {
self.reconnect_assist_after_continue = Some(Duration::ZERO);
}
fn note_target_rediscovery_complete(&mut self) {
self.reconnect_assist_after_continue = None;
}
fn target_kernel_base_hint(&mut self) -> Result<Option<VirtAddr>> {
let processor = self.current_processor;
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::get_version(framing, processor).map(|version| Some(VirtAddr(version.kern_base)))
})
}
fn target_debugger_data_hint(&mut self) -> Result<Option<DebuggerDataCandidate>> {
let processor = self.current_processor;
with_framing_read_timeout(self.framing()?, KD_REQUEST_TIMEOUT, |framing| {
api::get_version(framing, processor).map(|version| {
(version.flags & api::DBGKD_VERS_FLAG_DATA != 0 && version.debugger_data_list != 0)
.then_some(DebuggerDataCandidate {
address: VirtAddr(version.debugger_data_list),
source: MetadataSource::KdVersion,
})
})
})
}
fn continue_execution(&mut self) -> Result<()> {
self.continue_execution_with_disposition(ContinueDisposition::Handled)
}
fn continue_execution_with_disposition(
&mut self,
disposition: ContinueDisposition,
) -> Result<()> {
let resume_processor = self.last_stop_processor;
self.skip_hardcoded_breakpoint(resume_processor)?;
let drain = ContinueDrain::new(
self.last_rip,
self.managed_bp_addresses.clone(),
self.breakin_addresses.clone(),
self.register_map.clone(),
);
let reconnect_assist_after_continue = self.reconnect_assist_after_continue;
kd_trace!(
"kd: continue: sending ContinueApi2 on p{}",
resume_processor + 1
);
self.continue_preserving_dr7(
resume_processor,
api::status_for_disposition(disposition),
false,
)?;
kd_trace!("kd: continue: ContinueApi2 ACKed, VM should resume");
self.record_running();
self.start_pump(reconnect_assist_after_continue, Some(drain))
}
fn step(&mut self) -> Result<()> {
let processor = self.current_processor;
if processor == self.last_stop_processor {
self.skip_hardcoded_breakpoint(processor)?;
}
self.continue_preserving_dr7(processor, api::DBG_CONTINUE, true)?;
self.record_running();
Ok(())
}
fn interrupt(&mut self) -> Result<StopEvent> {
let stop = if let Link::RunningPumped(pump) = &self.link {
pump.breakin_requested.store(true, Ordering::SeqCst);
self.send_raw_breakin()?;
match self.take_pump_stop(Some(Duration::from_secs(10)))? {
Some(stop) => stop,
None => {
self.shutdown_pump();
return Err(Error::Kd("no break-in response within 10s".into()));
}
}
} else {
let arch = self.arch;
breakin_and_wait(self.framing()?, arch, Duration::from_secs(10))?
};
self.record_stop(&stop);
Ok(stop_event(stop))
}
fn wait_for_stop(&mut self) -> Result<StopEvent> {
if matches!(self.link, Link::RunningPumped(_)) {
let stop = self
.take_pump_stop(None)?
.ok_or_else(|| Error::Kd("KD pump returned no stop".into()))?;
let stop = self.mark_known_breakin_stop(stop);
self.record_stop(&stop);
return Ok(stop_event(stop));
}
let debug_log = self.debug_log.clone();
let arch = self.arch;
let _ = self
.framing()?
.transport_mut()
.set_read_timeout(Some(blocking_read_timeout()));
let stop = await_state_change(
self.framing()?,
AwaitStateOptions {
arch,
saw_kd_refresh: None,
surface_all: false,
bugcheck: None,
bugcheck_capture: None,
deadline: None,
debug_log: Some(&debug_log),
},
)?;
let stop = self.mark_known_breakin_stop(stop);
self.record_stop(&stop);
Ok(stop_event(stop))
}
fn try_wait_for_stop(&mut self, timeout: Duration) -> Result<Option<StopEvent>> {
if matches!(self.link, Link::RunningPumped(_)) {
return match self.take_pump_stop(Some(timeout))? {
Some(stop) => {
let stop = self.mark_known_breakin_stop(stop);
kd_trace!(
"kd: try_wait: pump reported stop rip={:#x} exc={:#x}",
stop.program_counter,
stop.exception_code
);
self.record_stop(&stop);
Ok(Some(stop_event(stop)))
}
None => Ok(None),
};
}
self.framing()?
.transport_mut()
.set_read_timeout(Some(timeout))?;
let mut saw_kd_refresh = false;
let debug_log = self.debug_log.clone();
let arch = self.arch;
let result = await_state_change(
self.framing()?,
AwaitStateOptions {
arch,
saw_kd_refresh: Some(&mut saw_kd_refresh),
surface_all: false,
bugcheck: None,
bugcheck_capture: None,
deadline: Some(Instant::now() + timeout),
debug_log: Some(&debug_log),
},
);
let stop = match result {
Ok(stop) => stop,
Err(Error::Io(e))
if e.kind() == ErrorKind::WouldBlock || e.kind() == ErrorKind::TimedOut =>
{
if saw_kd_refresh {
kd_trace!("kd: try_wait: KD refresh observed while polling");
}
return Ok(None);
}
Err(e) => return Err(e),
};
let stop = self.mark_known_breakin_stop(stop);
kd_trace!(
"kd: try_wait: stop rip={:#x} exc={:#x} in_managed={}",
stop.program_counter,
stop.exception_code,
self.managed_bp_addresses.contains(&stop.program_counter)
);
self.record_stop(&stop);
Ok(Some(stop_event(stop)))
}
fn thread_list(&mut self) -> Result<Vec<String>> {
Ok((0..self.processor_count).map(thread_id_for).collect())
}
fn set_current_thread(&mut self, thread_id: &str) -> Result<()> {
self.current_processor =
parse_thread_id_for_processor_count(thread_id, self.processor_count)?;
Ok(())
}
fn stopped_thread_id(&mut self) -> Result<String> {
Ok(thread_id_for(self.current_processor))
}
fn is_running(&self) -> bool {
self.link.is_running()
}
fn has_pending_stop(&self) -> bool {
matches!(&self.link, Link::RunningPumped(pump) if pump.reported_stop.load(Ordering::SeqCst))
}
fn prepare_for_exit(&mut self, leave_running: bool) -> Result<()> {
let result = self.finish_for_exit(leave_running);
if result.is_ok() {
self.exit_prepared = true;
}
result
}
}
impl DebugBackend for KdBackendHandle {
fn register_map(&self) -> &RegisterMap {
&self.register_map
}
fn revalidate_host_memory(&mut self, phys: &PhysMem) -> Result<()> {
let mut backend = self.lock();
let hints = backend.target_hints()?;
backend.validate_host_memory(phys, hints)
}
fn name(&self) -> &'static str {
self.backend_name
}
fn set_kernel_dtb(&mut self, dtb: u64) {
self.lock().set_kernel_dtb(dtb);
}
fn read_registers(&mut self) -> Result<Vec<u8>> {
self.lock().read_registers()
}
fn write_registers(&mut self, data: &[u8]) -> Result<()> {
self.lock().write_registers(data)
}
fn set_breakpoint(&mut self, addr: u64) -> Result<()> {
self.lock().set_breakpoint(addr)
}
fn remove_breakpoint(&mut self, addr: u64) -> Result<()> {
self.lock().remove_breakpoint(addr)
}
fn supports_watchpoints(&self) -> bool {
self.lock().supports_watchpoints()
}
fn hardware_breakpoint_slots(&self) -> u8 {
self.lock().hardware_breakpoint_slots()
}
fn hardware_slot_range(&self, access: HwBreakpointAccess) -> std::ops::Range<u8> {
self.lock().hardware_slot_range(access)
}
fn set_hardware_breakpoint(
&mut self,
slot: u8,
addr: u64,
access: HwBreakpointAccess,
len: u8,
) -> Result<()> {
self.lock().set_hardware_breakpoint(slot, addr, access, len)
}
fn clear_hardware_breakpoint(&mut self, slot: u8) -> Result<()> {
self.lock().clear_hardware_breakpoint(slot)
}
fn supports_user_mode_breakpoints(&self) -> bool {
self.lock().supports_user_mode_breakpoints()
}
fn supports_msr(&self) -> bool {
self.lock().supports_msr()
}
fn read_msr(&mut self, processor: u16, msr: u32) -> Result<u64> {
self.lock().read_msr(processor, msr)
}
fn write_msr(&mut self, processor: u16, msr: u32, value: u64) -> Result<()> {
self.lock().write_msr(processor, msr, value)
}
fn supports_target_control(&self) -> bool {
self.lock().supports_target_control()
}
fn supports_target_file_io(&self) -> bool {
self.lock().supports_target_file_io()
}
fn reboot_target(&mut self) -> Result<()> {
self.lock().reboot_target()
}
fn cause_bugcheck(&mut self) -> Result<()> {
self.lock().cause_bugcheck()
}
fn optional_capabilities(&self) -> Vec<BackendCapability> {
self.lock().optional_capabilities()
}
fn read_debug_output(&self, since_seq: u64) -> DebugOutputPage {
self.lock().read_debug_output(since_seq)
}
fn note_breakpoint_installed(&mut self, addr: u64) {
self.lock().note_breakpoint_installed(addr);
}
fn note_breakpoint_uninstalled(&mut self, addr: u64) {
self.lock().note_breakpoint_uninstalled(addr);
}
fn note_target_rediscovery_pending(&mut self) {
self.lock().note_target_rediscovery_pending();
}
fn note_target_rediscovery_complete(&mut self) {
self.lock().note_target_rediscovery_complete();
}
fn target_manages_breakpoint_sites(&self) -> bool {
self.lock().target_manages_breakpoint_sites()
}
fn target_kernel_base_hint(&mut self) -> Result<Option<VirtAddr>> {
self.lock().target_kernel_base_hint()
}
fn target_debugger_data_hint(&mut self) -> Result<Option<DebuggerDataCandidate>> {
self.lock().target_debugger_data_hint()
}
fn continue_execution(&mut self) -> Result<()> {
self.lock().continue_execution()
}
fn continue_execution_with_disposition(
&mut self,
disposition: ContinueDisposition,
) -> Result<()> {
self.lock().continue_execution_with_disposition(disposition)
}
fn step(&mut self) -> Result<()> {
self.lock().step()
}
fn interrupt(&mut self) -> Result<StopEvent> {
self.lock().interrupt()
}
fn wait_for_stop(&mut self) -> Result<StopEvent> {
self.lock().wait_for_stop()
}
fn try_wait_for_stop(&mut self, timeout: Duration) -> Result<Option<StopEvent>> {
self.lock().try_wait_for_stop(timeout)
}
fn thread_list(&mut self) -> Result<Vec<String>> {
self.lock().thread_list()
}
fn set_current_thread(&mut self, thread_id: &str) -> Result<()> {
self.lock().set_current_thread(thread_id)
}
fn stopped_thread_id(&mut self) -> Result<String> {
self.lock().stopped_thread_id()
}
fn is_running(&self) -> bool {
self.lock().is_running()
}
fn has_pending_stop(&self) -> bool {
self.lock().has_pending_stop()
}
fn prepare_for_exit(&mut self, leave_running: bool) -> Result<()> {
self.lock().prepare_for_exit(leave_running)
}
}
impl Drop for KdBackend {
fn drop(&mut self) {
if self.needs_drop_cleanup() {
let _ = self.finish_for_exit(true);
}
}
}
#[cfg(test)]
mod tests {
use super::*;
const ARM64_KSPECIAL_REGISTERS_TPIDR_EL0_OFFSET: usize = 0x10;
use crate::guest::{Guest, WinObject};
use crate::kd::framing::{
PACKET_TYPE_KD_ACKNOWLEDGE, PACKET_TYPE_KD_DEBUG_IO, PACKET_TYPE_KD_FILE_IO,
PACKET_TYPE_KD_RESET, PACKET_TYPE_KD_STATE_CHANGE64, PACKET_TYPE_KD_STATE_MANIPULATE,
};
use crate::phys::PhysMem;
use crate::symbols::{FieldInfo, ParsedType, SymbolStore, TypeInfo};
use std::io::{Cursor, Read, Write};
use std::time::Instant;
#[test]
fn kd_detects_amd64_and_arm64_machine_types() {
assert_eq!(detect_arch(0x8664).unwrap(), Arch::Amd64);
assert_eq!(detect_arch(0xaa64).unwrap(), Arch::Arm64);
let error = detect_arch(0x014c).unwrap_err();
assert!(error.to_string().contains("I386 KD target"));
}
#[test]
fn kd_memory_source_parses_supported_values() {
assert_eq!("auto".parse(), Ok(KdMemorySource::Auto));
assert_eq!("host".parse(), Ok(KdMemorySource::Host));
assert_eq!("kd".parse(), Ok(KdMemorySource::Kd));
assert!("remote".parse::<KdMemorySource>().is_err());
}
#[test]
fn arm64_ttbr1_normalizes_to_combined_page_table_page() {
assert_eq!(
normalize_kernel_dtb(Arch::Arm64, 0x004f_0000_80d4_5800),
0x80d4_5000
);
}
#[test]
fn arm64_target_hints_read_ttbr1_through_kd() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.arch = Arch::Arm64;
backend.register_map = context_arm64::build_register_map();
backend.link.set_inline_running(false);
backend.exit_prepared = true;
let kernel_base = 0xffff_f802_4e80_0000u64;
let module_list = 0xffff_f802_4f4d_aed0u64;
let worker = spawn(move || {
let version_request = read_wire_packet(&mut kernel);
let version_id = u32::from_le_bytes(version_request[8..12].try_into().unwrap());
assert_eq!(
u32::from_le_bytes(version_request[16..20].try_into().unwrap()),
api::DBGKD_GET_VERSION
);
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, version_id))
.unwrap();
let mut version_union = [0u8; 40];
version_union[8..10].copy_from_slice(&0xaa64u16.to_le_bytes());
version_union[16..24].copy_from_slice(&kernel_base.to_le_bytes());
version_union[24..32].copy_from_slice(&module_list.to_le_bytes());
let version_reply = manipulate_reply_payload(api::DBGKD_GET_VERSION, 0, &version_union);
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
WIRE_FIRST_PACKET_ID,
&version_reply,
))
.unwrap();
let _version_ack = read_wire_packet(&mut kernel);
let ttbr_request = read_wire_packet(&mut kernel);
let ttbr_id = u32::from_le_bytes(ttbr_request[8..12].try_into().unwrap());
assert_eq!(
u32::from_le_bytes(ttbr_request[16..20].try_into().unwrap()),
api::DBGKD_READ_MACHINE_SPECIFIC_REGISTER
);
assert_eq!(
u32::from_le_bytes(ttbr_request[32..36].try_into().unwrap()),
ARM64_WINDBG_TTBR1_EL1
);
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, ttbr_id))
.unwrap();
let ttbr = 0x0040_0000_80d4_5800u64;
let mut ttbr_union = [0u8; 12];
ttbr_union[0..4].copy_from_slice(&ARM64_WINDBG_TTBR1_EL1.to_le_bytes());
ttbr_union[4..8].copy_from_slice(&(ttbr as u32).to_le_bytes());
ttbr_union[8..12].copy_from_slice(&((ttbr >> 32) as u32).to_le_bytes());
let ttbr_reply =
manipulate_reply_payload(api::DBGKD_READ_MACHINE_SPECIFIC_REGISTER, 0, &ttbr_union);
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
WIRE_FIRST_PACKET_ID ^ 1,
&ttbr_reply,
))
.unwrap();
let _ttbr_ack = read_wire_packet(&mut kernel);
});
let hints = backend.target_hints().unwrap();
worker.join().unwrap();
assert_eq!(hints.arch, Arch::Arm64);
assert_eq!(hints.kernel_dtb, 0x80d4_5000);
assert_eq!(hints.kernel_base, VirtAddr(kernel_base));
assert_eq!(hints.ps_loaded_module_list, VirtAddr(module_list));
}
#[test]
fn transparent_arm64_state_change_uses_arm64_continue_layout() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let stop = StateChange {
processor: 2,
number_processors: 4,
new_state: DBG_KD_LOAD_SYMBOLS_STATE_CHANGE,
exception_code: 0,
exception_first_chance: None,
exception_address: None,
program_counter: 0xffff_f800_1234_5678,
kernel_base_hint: None,
is_bugcheck: false,
bugcheck: None,
target_reloaded: false,
assisted_breakin: false,
};
let handle = spawn(move || {
let mut framing = KdFraming::new(host.into());
continue_transparent_state_change(&mut framing, Arch::Arm64, &stop)
});
let packet = read_wire_packet(&mut kernel);
let packet_id = u32::from_le_bytes(packet[8..12].try_into().unwrap());
let request = &packet[WIRE_HEADER_SIZE..];
assert_eq!(
u32::from_le_bytes(request[0..4].try_into().unwrap()),
api::DBGKD_CONTINUE_API2
);
assert_eq!(
u32::from_le_bytes(request[16..20].try_into().unwrap()),
api::DBG_CONTINUE
);
assert_eq!(&request[20..24], &[0; 4]);
assert_eq!(&request[24..40], &[0; 16]);
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, packet_id))
.unwrap();
kernel.flush().unwrap();
handle.join().unwrap().unwrap();
}
#[test]
fn arm64_capabilities_include_debug_breakpoints() {
let (_kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.arch = Arch::Arm64;
for capability in [
DebugCapability::UserModeBreakpoints,
DebugCapability::Watchpoints,
] {
assert!(
backend
.capabilities()
.iter()
.any(|entry| { entry.capability == capability && entry.supported })
);
}
}
struct Loopback {
inbound: Cursor<Vec<u8>>,
outbound: Vec<u8>,
}
impl Loopback {
fn new() -> Self {
Self {
inbound: Cursor::new(Vec::new()),
outbound: Vec::new(),
}
}
fn with_inbound(inbound: Vec<u8>) -> Self {
Self {
inbound: Cursor::new(inbound),
outbound: Vec::new(),
}
}
}
impl Read for Loopback {
fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
Read::read(&mut self.inbound, buf)
}
}
impl Write for Loopback {
fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
self.outbound.extend_from_slice(buf);
Ok(buf.len())
}
fn flush(&mut self) -> std::io::Result<()> {
Ok(())
}
}
fn debug_io_print_payload(text: &[u8]) -> Vec<u8> {
let mut payload = vec![0u8; DBGKD_DEBUG_IO_HEADER_SIZE];
payload[0..4].copy_from_slice(&DBGKD_PRINT_STRING_API.to_le_bytes());
payload[8..12].copy_from_slice(&(text.len() as u32).to_le_bytes());
payload.extend_from_slice(text);
payload
}
#[test]
fn parse_state_change_extracts_processor_and_pc() {
let mut payload = vec![0u8; 64];
payload[0..4].copy_from_slice(&DBG_KD_EXCEPTION_STATE_CHANGE.to_le_bytes()); payload[6..8].copy_from_slice(&2u16.to_le_bytes()); payload[8..12].copy_from_slice(&4u32.to_le_bytes()); payload[24..32].copy_from_slice(&0xfffff800deadbeefu64.to_le_bytes());
payload[32..36].copy_from_slice(&STATUS_BREAKPOINT.to_le_bytes());
let s = parse_state_change(&payload).unwrap();
assert_eq!(s.processor, 2);
assert_eq!(s.number_processors, 4);
assert_eq!(s.new_state, DBG_KD_EXCEPTION_STATE_CHANGE);
assert_eq!(s.exception_code, STATUS_BREAKPOINT);
assert_eq!(s.program_counter, 0xfffff800deadbeef);
}
#[test]
fn parse_state_change_extracts_exception_record_metadata() {
let mut payload = vec![0u8; 188];
payload[0..4].copy_from_slice(&DBG_KD_EXCEPTION_STATE_CHANGE.to_le_bytes());
payload[32..36].copy_from_slice(&0xc000_0005u32.to_le_bytes());
payload[48..56].copy_from_slice(&0xfffff800_12345678u64.to_le_bytes());
payload[184..188].copy_from_slice(&1u32.to_le_bytes());
let first = parse_state_change(&payload).unwrap();
assert_eq!(first.exception_address, Some(0xfffff800_12345678));
assert_eq!(first.exception_first_chance, Some(true));
payload[184..188].copy_from_slice(&0u32.to_le_bytes());
let second = parse_state_change(&payload).unwrap();
assert_eq!(second.exception_first_chance, Some(false));
}
#[test]
fn parse_load_symbols_state_change_extracts_base_hint() {
let mut payload = vec![0u8; 64];
payload[0..4].copy_from_slice(&DBG_KD_LOAD_SYMBOLS_STATE_CHANGE.to_le_bytes());
payload[8..12].copy_from_slice(&1u32.to_le_bytes());
payload[24..32].copy_from_slice(&0xfffff800004f9325u64.to_le_bytes());
payload[40..48].copy_from_slice(&0xfffff80000000000u64.to_le_bytes());
let s = parse_state_change(&payload).unwrap();
assert_eq!(s.program_counter, 0xfffff800004f9325);
assert_eq!(s.kernel_base_hint, Some(VirtAddr(0xfffff80000000000)));
}
#[test]
fn stop_event_flags_surfaced_load_symbols_as_bugcheck() {
let stop = StateChange {
processor: 0,
number_processors: 1,
new_state: DBG_KD_LOAD_SYMBOLS_STATE_CHANGE,
exception_code: 0,
exception_first_chance: None,
exception_address: None,
program_counter: 0xfffff8007faf9325,
kernel_base_hint: Some(VirtAddr(0xfffff8007f600000)),
is_bugcheck: true,
bugcheck: None,
target_reloaded: false,
assisted_breakin: false,
};
let event = stop_event(stop);
assert!(event.is_bugcheck);
assert_eq!(event.exception_code, None);
assert_eq!(event.program_counter, Some(0xfffff8007faf9325));
assert_eq!(
event.target_kernel_base_hint,
Some(VirtAddr(0xfffff8007f600000))
);
assert!(event.bugcheck.is_none());
}
#[test]
fn bugcheck_capture_extracts_fatal_error_and_driver() {
let mut capture = BugcheckCapture::default();
capture.observe_debug_text(
b"\r\n*** Fatal System Error: 0x000000d1\r\n (0xFFFFB90641184010,0x0000000000000002,0x0000000000000000,0xFFFFF8016E151730)\r\n",
);
capture.observe_debug_text(b"Driver at fault: myfault.sys.\r\n");
let info = capture.finish().unwrap();
assert_eq!(info.code, 0xd1);
assert_eq!(
info.parameters,
[
0xffff_b906_4118_4010,
0x0000_0000_0000_0002,
0x0000_0000_0000_0000,
0xffff_f801_6e15_1730,
]
);
assert_eq!(info.driver.as_deref(), Some("myfault.sys"));
}
#[test]
fn captured_bugcheck_debug_io_can_be_suppressed() {
let payload = debug_io_print_payload(
b"\r\n*** Fatal System Error: 0x000000d1\r\n (0x1,0x2,0x0,0x4)\r\n",
);
let mut framing = KdFraming::new(Loopback::new());
let mut capture = BugcheckCapture::default();
let mut output = Vec::new();
let debug_log = DebugLog::new(DEBUG_LOG_CAPACITY);
let saw_refresh = handle_debug_io_with_output(
&mut framing,
&payload,
true,
Some(&mut capture),
true,
Some(&debug_log),
&mut output,
)
.unwrap();
assert!(!saw_refresh);
assert!(output.is_empty());
assert_eq!(capture.finish().unwrap().code, 0xd1);
let page = debug_log.read_since(0);
assert!(
page.lines
.iter()
.any(|line| line.text.contains("Fatal System Error"))
);
}
#[test]
fn parse_debug_io_print_extracts_string() {
let payload = debug_io_print_payload(b"hello");
match parse_debug_io(&payload).unwrap() {
DebugIo::PrintString { text } => assert_eq!(text, b"hello"),
DebugIo::GetString { .. } => panic!("expected print-string debug I/O"),
}
}
#[test]
fn debug_io_refresh_message_is_reported_when_waiting_for_stop() {
let payload = debug_io_print_payload(b"KDTARGET: Refreshing KD connection\n");
let mut framing = KdFraming::new(Loopback::new());
let mut output = Vec::new();
let saw_refresh = handle_debug_io_with_output(
&mut framing,
&payload,
true,
None,
false,
None,
&mut output,
)
.unwrap();
assert!(saw_refresh);
assert_eq!(output, b"KDTARGET: Refreshing KD connection\n");
assert!(framing.transport_ref().outbound.is_empty());
}
#[test]
fn debug_io_refresh_message_is_passive_during_manipulate_requests() {
let payload = debug_io_print_payload(b"KDTARGET: Refreshing KD connection\n");
let mut framing = KdFraming::new(Loopback::new());
let mut output = Vec::new();
let saw_refresh = handle_debug_io_with_output(
&mut framing,
&payload,
false,
None,
false,
None,
&mut output,
)
.unwrap();
assert!(!saw_refresh);
assert_eq!(output, b"KDTARGET: Refreshing KD connection\n");
assert!(framing.transport_ref().outbound.is_empty());
}
#[test]
fn parse_debug_io_print_accepts_legacy_short_header() {
let mut payload = vec![0u8; DBGKD_DEBUG_IO_MIN_HEADER_SIZE];
payload[0..4].copy_from_slice(&DBGKD_PRINT_STRING_API.to_le_bytes());
payload[8..12].copy_from_slice(&5u32.to_le_bytes());
payload.extend_from_slice(b"hello");
match parse_debug_io(&payload).unwrap() {
DebugIo::PrintString { text } => assert_eq!(text, b"hello"),
DebugIo::GetString { .. } => panic!("expected print-string debug I/O"),
}
}
#[test]
fn parse_debug_io_get_string_reads_full_header() {
let mut payload = vec![0u8; DBGKD_DEBUG_IO_HEADER_SIZE];
payload[0..4].copy_from_slice(&DBGKD_GET_STRING_API.to_le_bytes());
payload[4..6].copy_from_slice(&0x33u16.to_le_bytes());
payload[6..8].copy_from_slice(&2u16.to_le_bytes());
payload[8..12].copy_from_slice(&7u32.to_le_bytes());
payload[12..16].copy_from_slice(&0x100u32.to_le_bytes());
payload.extend_from_slice(b"prompt>");
match parse_debug_io(&payload).unwrap() {
DebugIo::GetString {
processor_level,
processor,
prompt,
} => {
assert_eq!(processor_level, 0x33);
assert_eq!(processor, 2);
assert_eq!(prompt, b"prompt>");
}
DebugIo::PrintString { .. } => panic!("expected get-string debug I/O"),
}
}
#[test]
fn parse_debug_io_print_rejects_other_api() {
let mut payload = vec![0u8; DBGKD_DEBUG_IO_MIN_HEADER_SIZE];
payload[0..4].copy_from_slice(&0xdeadbeefu32.to_le_bytes());
assert!(parse_debug_io(&payload).is_none());
}
#[test]
fn parse_state_change_rejects_short_payload() {
let err = parse_state_change(&[0u8; 10]).unwrap_err();
match err {
Error::Kd(msg) => assert!(msg.contains("too short")),
other => panic!("unexpected error: {other:?}"),
}
}
#[test]
fn initial_handshake_breaks_in_immediately_then_resets() {
assert_eq!(
initial_handshake_stimulus(0),
InitialHandshakeStimulus::BreakIn
);
assert_eq!(
initial_handshake_stimulus(1),
InitialHandshakeStimulus::Reset
);
assert_eq!(
initial_handshake_stimulus(2),
InitialHandshakeStimulus::BreakIn
);
assert_eq!(
initial_handshake_stimulus(3),
InitialHandshakeStimulus::Reset
);
}
#[test]
fn kd_initial_timeout_accepts_positive_seconds() {
assert_eq!(
parse_kd_initial_timeout(Some("12")).unwrap(),
Duration::from_secs(12)
);
}
#[test]
fn kd_initial_timeout_rejects_invalid_values() {
assert!(parse_kd_initial_timeout(Some("0")).is_err());
assert!(parse_kd_initial_timeout(Some("meow")).is_err());
}
#[test]
fn context_payload_rejects_short_buffers() {
let short = vec![0u8; context::CONTEXT_SIZE - 1];
assert!(context_payload(&short).is_err());
}
#[test]
fn append_control_registers_extends_context() {
let mut ctx = vec![0u8; context::CONTEXT_SIZE];
let mut special = vec![0u8; KSPECIAL_REGISTERS_MIN_SIZE];
special[KSPECIAL_REGISTERS_CR0_OFFSET..KSPECIAL_REGISTERS_CR0_OFFSET + 8]
.copy_from_slice(&0x8005_0033u64.to_le_bytes());
special[KSPECIAL_REGISTERS_CR2_OFFSET..KSPECIAL_REGISTERS_CR2_OFFSET + 8]
.copy_from_slice(&0x1111_2222u64.to_le_bytes());
special[KSPECIAL_REGISTERS_CR3_OFFSET..KSPECIAL_REGISTERS_CR3_OFFSET + 8]
.copy_from_slice(&0x1234_5000u64.to_le_bytes());
special[KSPECIAL_REGISTERS_CR4_OFFSET..KSPECIAL_REGISTERS_CR4_OFFSET + 8]
.copy_from_slice(&0x350ef8u64.to_le_bytes());
special[KSPECIAL_REGISTERS_CR8_OFFSET..KSPECIAL_REGISTERS_CR8_OFFSET + 8]
.copy_from_slice(&2u64.to_le_bytes());
special[KSPECIAL_REGISTERS_GDTR_OFFSET + 6..KSPECIAL_REGISTERS_GDTR_OFFSET + 8]
.copy_from_slice(&0x1234u16.to_le_bytes());
special[KSPECIAL_REGISTERS_GDTR_OFFSET + 8..KSPECIAL_REGISTERS_GDTR_OFFSET + 16]
.copy_from_slice(&0xffff_f800_0000_1000u64.to_le_bytes());
special[KSPECIAL_REGISTERS_IDTR_OFFSET + 6..KSPECIAL_REGISTERS_IDTR_OFFSET + 8]
.copy_from_slice(&0x5678u16.to_le_bytes());
special[KSPECIAL_REGISTERS_IDTR_OFFSET + 8..KSPECIAL_REGISTERS_IDTR_OFFSET + 16]
.copy_from_slice(&0xffff_f800_0000_2000u64.to_le_bytes());
special[KSPECIAL_REGISTERS_TR_OFFSET..KSPECIAL_REGISTERS_TR_OFFSET + 2]
.copy_from_slice(&0x40u16.to_le_bytes());
special[KSPECIAL_REGISTERS_LDTR_OFFSET..KSPECIAL_REGISTERS_LDTR_OFFSET + 2]
.copy_from_slice(&0x48u16.to_le_bytes());
special[KSPECIAL_REGISTERS_DR0_OFFSET..KSPECIAL_REGISTERS_DR0_OFFSET + 8]
.copy_from_slice(&0xffff_f804_1234_5678u64.to_le_bytes());
special[KSPECIAL_REGISTERS_DR6_OFFSET..KSPECIAL_REGISTERS_DR6_OFFSET + 8]
.copy_from_slice(&5u64.to_le_bytes());
special[KSPECIAL_REGISTERS_DR7_OFFSET..KSPECIAL_REGISTERS_DR7_OFFSET + 8]
.copy_from_slice(&0x402u64.to_le_bytes());
append_control_registers_from_special(&mut ctx, &special).unwrap();
let map = context::build_register_map();
assert_eq!(ctx.len(), context::REGISTER_BUFFER_SIZE);
assert_eq!(map.read_u64("cr0", &ctx).unwrap(), 0x8005_0033);
assert_eq!(map.read_u64("cr2", &ctx).unwrap(), 0x1111_2222);
assert_eq!(map.read_u64("cr3", &ctx).unwrap(), 0x1234_5000);
assert_eq!(map.read_u64("cr4", &ctx).unwrap(), 0x350ef8);
assert_eq!(map.read_u64("dr0", &ctx).unwrap(), 0xffff_f804_1234_5678);
assert_eq!(map.read_u64("dr6", &ctx).unwrap(), 5);
assert_eq!(map.read_u64("dr7", &ctx).unwrap(), 0x402);
assert_eq!(map.read_u64("cr8", &ctx).unwrap(), 2);
assert_eq!(map.read_u64("gdtr", &ctx).unwrap(), 0xffff_f800_0000_1000);
assert_eq!(map.read_u64("gdtr_limit", &ctx).unwrap(), 0x1234);
assert_eq!(map.read_u64("idtr", &ctx).unwrap(), 0xffff_f800_0000_2000);
assert_eq!(map.read_u64("idtr_limit", &ctx).unwrap(), 0x5678);
assert_eq!(map.read_u64("tr", &ctx).unwrap(), 0x40);
assert_eq!(map.read_u64("ldtr", &ctx).unwrap(), 0x48);
}
#[test]
fn context_debug_registers_update_special_registers() {
let mut ctx = vec![0u8; context::REGISTER_BUFFER_SIZE];
let mut special = vec![0xa5; KSPECIAL_REGISTERS_MIN_SIZE];
let map = context::build_register_map();
map.write_u64("dr0", &mut ctx, 0xffff_f804_1234_5678)
.unwrap();
map.write_u64("dr6", &mut ctx, 3).unwrap();
map.write_u64("dr7", &mut ctx, 0xd0402).unwrap();
update_special_debug_registers_from_context(&mut special, &ctx).unwrap();
assert_eq!(
wire::read_u64(&special, KSPECIAL_REGISTERS_DR0_OFFSET),
0xffff_f804_1234_5678
);
assert_eq!(wire::read_u64(&special, KSPECIAL_REGISTERS_DR6_OFFSET), 3);
assert_eq!(
wire::read_u64(&special, KSPECIAL_REGISTERS_DR7_OFFSET),
0xd0402
);
assert_eq!(
wire::read_u64(&special, KSPECIAL_REGISTERS_CR0_OFFSET),
0xa5a5_a5a5_a5a5_a5a5,
"non-debug special registers must remain untouched"
);
}
#[test]
fn arm64_context_debug_registers_update_special_registers() {
let mut ctx = vec![0u8; context_arm64::CONTEXT_SIZE];
let mut special = vec![0xa5; ARM64_KSPECIAL_REGISTERS_MIN_SIZE];
let map = context_arm64::build_register_map();
map.write_u64("bvr0", &mut ctx, 0x4000).unwrap();
map.write_u64("bcr0", &mut ctx, 0xe9e1).unwrap();
map.write_u64("wvr1", &mut ctx, 0x5000).unwrap();
map.write_u64("wcr1", &mut ctx, 0x0000_e9e1).unwrap();
update_arm64_debug_registers_from_context(&mut special, &ctx).unwrap();
assert_eq!(
wire::read_u64(&special, ARM64_KSPECIAL_REGISTERS_BVR0_OFFSET),
0x4000
);
assert_eq!(
wire::read_u32(&special, ARM64_KSPECIAL_REGISTERS_BCR0_OFFSET),
0xe9e1
);
assert_eq!(
wire::read_u64(&special, ARM64_KSPECIAL_REGISTERS_WVR0_OFFSET + 8),
0x5000
);
assert_eq!(
wire::read_u32(&special, ARM64_KSPECIAL_REGISTERS_WCR0_OFFSET + 4),
0x0000_e9e1
);
assert_eq!(
wire::read_u64(&special, ARM64_KSPECIAL_REGISTERS_TPIDR_EL0_OFFSET),
0xa5a5_a5a5_a5a5_a5a5,
"non-debug special registers must remain untouched"
);
}
#[test]
fn thread_id_uses_one_based_hex() {
assert_eq!(thread_id_for(0), "p1.1");
assert_eq!(thread_id_for(3), "p1.4");
assert_eq!(thread_id_for(15), "p1.10");
}
#[test]
fn parse_thread_id_rejects_garbage() {
assert!(parse_thread_id("p2.1").is_err()); assert!(parse_thread_id("p1.zz").is_err()); assert!(parse_thread_id("garbage").is_err());
assert!(parse_thread_id("p1.0").is_err()); }
#[test]
fn parse_thread_id_for_processor_count_rejects_out_of_range() {
assert_eq!(parse_thread_id_for_processor_count("p1.4", 4).unwrap(), 3);
assert!(parse_thread_id_for_processor_count("p1.5", 4).is_err());
}
const WIRE_DATA_LEADER: u32 = 0x3030_3030;
const WIRE_CONTROL_LEADER: u32 = 0x6969_6969;
const WIRE_HEADER_SIZE: usize = 16;
const WIRE_TRAILER: u8 = 0xAA;
const WIRE_FIRST_PACKET_ID: u32 = 0x8080_0000;
fn wire_control_packet(packet_type: u16, packet_id: u32) -> Vec<u8> {
let mut pkt = Vec::new();
pkt.extend_from_slice(&WIRE_CONTROL_LEADER.to_le_bytes());
pkt.extend_from_slice(&packet_type.to_le_bytes());
pkt.extend_from_slice(&0u16.to_le_bytes());
pkt.extend_from_slice(&packet_id.to_le_bytes());
pkt.extend_from_slice(&0u32.to_le_bytes());
pkt
}
fn wire_data_packet(packet_type: u16, packet_id: u32, payload: &[u8]) -> Vec<u8> {
let checksum = payload.iter().fold(0u32, |a, &b| a.wrapping_add(b as u32));
let mut pkt = Vec::new();
pkt.extend_from_slice(&WIRE_DATA_LEADER.to_le_bytes());
pkt.extend_from_slice(&packet_type.to_le_bytes());
pkt.extend_from_slice(&(payload.len() as u16).to_le_bytes());
pkt.extend_from_slice(&packet_id.to_le_bytes());
pkt.extend_from_slice(&checksum.to_le_bytes());
pkt.extend_from_slice(payload);
pkt.push(WIRE_TRAILER);
pkt
}
fn read_wire_packet(stream: &mut UnixStream) -> Vec<u8> {
let mut header = [0u8; WIRE_HEADER_SIZE];
stream.read_exact(&mut header).unwrap();
let mut pkt = header.to_vec();
let leader = u32::from_le_bytes(header[0..4].try_into().unwrap());
if leader == WIRE_DATA_LEADER {
let len = u16::from_le_bytes(header[6..8].try_into().unwrap()) as usize;
let mut rest = vec![0u8; len + 1];
stream.read_exact(&mut rest).unwrap();
pkt.extend_from_slice(&rest);
}
pkt
}
fn state_change_payload(new_state: u32, pc: u64) -> Vec<u8> {
let mut payload = vec![0u8; 56];
payload[0..4].copy_from_slice(&new_state.to_le_bytes());
payload[8..12].copy_from_slice(&1u32.to_le_bytes()); payload[24..32].copy_from_slice(&pc.to_le_bytes());
payload[32..36].copy_from_slice(&STATUS_BREAKPOINT.to_le_bytes());
payload
}
fn exception_state_change_payload(pc: u64) -> Vec<u8> {
state_change_payload(DBG_KD_EXCEPTION_STATE_CHANGE, pc)
}
#[test]
fn file_io_create_file_gets_explicit_failure_reply() {
let mut payload = vec![0u8; DBGKD_FILE_IO_HEADER_SIZE];
payload[0..4].copy_from_slice(&DBGKD_CREATE_FILE_API.to_le_bytes());
let ack = wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, WIRE_FIRST_PACKET_ID);
let mut framing = KdFraming::new(Loopback::with_inbound(ack));
handle_file_io(&mut framing, &payload).unwrap();
let out = &framing.transport_ref().outbound;
assert_eq!(out.len(), WIRE_HEADER_SIZE + DBGKD_FILE_IO_HEADER_SIZE + 1);
assert_eq!(
u32::from_le_bytes(out[0..4].try_into().unwrap()),
WIRE_DATA_LEADER
);
assert_eq!(
u16::from_le_bytes(out[4..6].try_into().unwrap()),
PACKET_TYPE_KD_FILE_IO
);
assert_eq!(
u16::from_le_bytes(out[6..8].try_into().unwrap()) as usize,
DBGKD_FILE_IO_HEADER_SIZE
);
assert_eq!(
u32::from_le_bytes(out[8..12].try_into().unwrap()),
WIRE_FIRST_PACKET_ID
);
let reply = &out[WIRE_HEADER_SIZE..WIRE_HEADER_SIZE + DBGKD_FILE_IO_HEADER_SIZE];
assert_eq!(
u32::from_le_bytes(reply[0..4].try_into().unwrap()),
DBGKD_CREATE_FILE_API
);
assert_eq!(
u32::from_le_bytes(reply[4..8].try_into().unwrap()),
STATUS_UNSUCCESSFUL
);
assert_eq!(
out[WIRE_HEADER_SIZE + DBGKD_FILE_IO_HEADER_SIZE],
WIRE_TRAILER
);
}
fn kd_backend_with_pump(pump: PumpHandle, breakin_clone: UnixStream) -> KdBackend {
KdBackend {
link: Link::RunningPumped(pump),
breakin_clone: breakin_clone.into(),
backend_name: "kd",
register_map: context::build_register_map(),
arch: Arch::Amd64,
kernel_dtb_override: 0,
processor_count: 1,
current_processor: 0,
last_stop_processor: 0,
last_exception_code: 0,
last_rip: 0,
reconnect_assist_after_continue: None,
bp_handles: HashMap::new(),
managed_bp_addresses: HashSet::new(),
breakin_addresses: HashSet::new(),
pending_write_breakpoint: None,
special_register_cache: HashMap::new(),
context_cache: HashMap::new(),
special_registers_unsupported: false,
efer_cache: HashMap::new(),
virtual_lines: LineCache::default(),
table_lines: LineCache::default(),
virtual_fill_cap: KD_REMOTE_MEMORY_CHUNK,
exit_prepared: false,
debug_log: DebugLog::new(DEBUG_LOG_CAPACITY),
translations: Arc::new(TranslationCache::default()),
}
}
fn scripted_target(replies: &[Vec<u8>]) -> Vec<u8> {
let mut stream = Vec::new();
for (index, reply) in replies.iter().enumerate() {
let id = api::test_wire::INITIAL_PACKET_ID ^ (index as u32 & 1);
stream.extend_from_slice(&api::test_wire::ack_then_reply(id, id, reply));
}
stream
}
fn refused_reply(api_number: u32) -> Vec<u8> {
let mut reply = api::test_wire::build_reply(api_number, 0, &[], &[]);
reply[8..12].copy_from_slice(&0xc000_0005u32.to_le_bytes());
reply
}
#[test]
fn resume_does_not_step_past_a_breakpoint_it_does_not_own() {
const PC: u64 = 0xffff_f800_0011_2233;
for owned_by_us in [true, false] {
let register_map = context::build_register_map();
let mut guest_context = vec![0u8; context::CONTEXT_SIZE];
register_map
.write_u64("rip", &mut guest_context, PC)
.unwrap();
let mut replies = vec![api::test_wire::build_reply(
api::DBGKD_GET_CONTEXT,
0,
&[],
&guest_context,
)];
if !owned_by_us {
replies.push(refused_reply(api::DBGKD_READ_VIRTUAL_MEMORY));
}
replies.push(api::test_wire::build_reply(
api::DBGKD_GET_CONTEXT,
0,
&[],
&guest_context,
));
for chunk in guest_context.chunks(512) {
let mut union = [0u8; 12];
wire::write_u32(&mut union, 8, chunk.len() as u32);
replies.push(api::test_wire::build_reply(
api::DBGKD_SET_CONTEXT_EX,
0,
&union,
&[],
));
}
let (host, target) = UnixStream::pair().unwrap();
(&target).write_all(&scripted_target(&replies)).unwrap();
let mut backend = kd_backend_with_framing(host);
backend.last_exception_code = STATUS_BREAKPOINT;
backend.last_stop_processor = 0;
backend.last_rip = PC;
if owned_by_us {
backend.managed_bp_addresses.insert(PC);
}
for handle in 1..=KD_BREAKPOINT_TABLE_SIZE {
backend
.bp_handles
.insert(0xdead_0000 + handle as u64, handle);
}
let outcome = backend.skip_hardcoded_breakpoint(0);
target.set_nonblocking(true).unwrap();
let mut sent = Vec::new();
let _ = (&target).read_to_end(&mut sent);
assert!(
!sent
.windows(4)
.any(|word| wire::read_u32(word, 0) == api::DBGKD_SET_CONTEXT_EX),
"resume stepped the PC past an int3 it does not own (owned_by_us={owned_by_us})"
);
outcome.unwrap();
}
}
fn kd_backend_with_framing(host: UnixStream) -> KdBackend {
let breakin_clone = host.try_clone().unwrap();
KdBackend {
link: Link::RunningInline(KdFraming::new(host.into())),
breakin_clone: breakin_clone.into(),
backend_name: "kd",
register_map: context::build_register_map(),
arch: Arch::Amd64,
kernel_dtb_override: 0,
processor_count: 1,
current_processor: 0,
last_stop_processor: 0,
last_exception_code: 0,
last_rip: 0,
reconnect_assist_after_continue: None,
bp_handles: HashMap::new(),
managed_bp_addresses: HashSet::new(),
breakin_addresses: HashSet::new(),
pending_write_breakpoint: None,
special_register_cache: HashMap::new(),
context_cache: HashMap::new(),
special_registers_unsupported: false,
efer_cache: HashMap::new(),
virtual_lines: LineCache::default(),
table_lines: LineCache::default(),
virtual_fill_cap: KD_REMOTE_MEMORY_CHUNK,
exit_prepared: false,
debug_log: DebugLog::new(DEBUG_LOG_CAPACITY),
translations: Arc::new(TranslationCache::default()),
}
}
fn write_breakpoint_reply_payload(processor: u16, addr: u64, handle: u32) -> Vec<u8> {
const MANIPULATE_UNION_OFFSET: usize = 16;
let mut payload = vec![0u8; api::MANIPULATE_HEADER_SIZE];
payload[0..4].copy_from_slice(&api::DBGKD_WRITE_BREAKPOINT.to_le_bytes());
payload[6..8].copy_from_slice(&processor.to_le_bytes());
payload[MANIPULATE_UNION_OFFSET..MANIPULATE_UNION_OFFSET + 8]
.copy_from_slice(&addr.to_le_bytes());
payload[MANIPULATE_UNION_OFFSET + 8..MANIPULATE_UNION_OFFSET + 12]
.copy_from_slice(&handle.to_le_bytes());
payload
}
fn manipulate_reply_payload(api_number: u32, processor: u16, union_body: &[u8]) -> Vec<u8> {
const MANIPULATE_UNION_OFFSET: usize = 16;
let mut payload = vec![0u8; api::MANIPULATE_HEADER_SIZE];
payload[0..4].copy_from_slice(&api_number.to_le_bytes());
payload[6..8].copy_from_slice(&processor.to_le_bytes());
let end = (MANIPULATE_UNION_OFFSET + union_body.len()).min(payload.len());
payload[MANIPULATE_UNION_OFFSET..end]
.copy_from_slice(&union_body[..end - MANIPULATE_UNION_OFFSET]);
payload
}
fn physical_memory_reply_payload(processor: u16, addr: u64, data: &[u8]) -> Vec<u8> {
const MANIPULATE_UNION_OFFSET: usize = 16;
let mut payload = vec![0u8; api::MANIPULATE_HEADER_SIZE];
payload[0..4].copy_from_slice(&api::DBGKD_READ_PHYSICAL_MEMORY.to_le_bytes());
payload[6..8].copy_from_slice(&processor.to_le_bytes());
payload[MANIPULATE_UNION_OFFSET..MANIPULATE_UNION_OFFSET + 8]
.copy_from_slice(&addr.to_le_bytes());
payload[MANIPULATE_UNION_OFFSET + 8..MANIPULATE_UNION_OFFSET + 12]
.copy_from_slice(&(data.len() as u32).to_le_bytes());
payload[MANIPULATE_UNION_OFFSET + 12..MANIPULATE_UNION_OFFSET + 16]
.copy_from_slice(&(data.len() as u32).to_le_bytes());
payload.extend_from_slice(data);
payload
}
#[test]
fn kd_memory_reads_physical_bytes_through_shared_backend() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.link.set_inline_running(false);
backend.exit_prepared = true;
let inner = Arc::new(Mutex::new(backend));
let memory = KdMemory {
inner: Arc::clone(&inner),
translations: Arc::new(TranslationCache::default()),
};
let expected = [0xde, 0xad, 0xbe, 0xef];
let worker = spawn(move || {
let request = read_wire_packet(&mut kernel);
let packet_id = u32::from_le_bytes(request[8..12].try_into().unwrap());
assert_eq!(
u32::from_le_bytes(request[16..20].try_into().unwrap()),
api::DBGKD_READ_PHYSICAL_MEMORY
);
assert_eq!(
u64::from_le_bytes(request[32..40].try_into().unwrap()),
0x1234_5000
);
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, packet_id))
.unwrap();
let reply = physical_memory_reply_payload(0, 0x1234_5000, &expected);
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
WIRE_FIRST_PACKET_ID,
&reply,
))
.unwrap();
let ack = read_wire_packet(&mut kernel);
assert_eq!(
u16::from_le_bytes(ack[4..6].try_into().unwrap()),
PACKET_TYPE_KD_ACKNOWLEDGE
);
});
let mut actual = [0u8; 4];
memory.read_bytes(0x1234_5000, &mut actual).unwrap();
worker.join().unwrap();
assert_eq!(actual, expected);
}
#[test]
fn kd_memory_rejects_reads_while_target_runs() {
let (_kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.exit_prepared = true;
let memory = KdMemory {
inner: Arc::new(Mutex::new(backend)),
translations: Arc::new(TranslationCache::default()),
};
let error = memory.read_bytes(0x1000, &mut [0u8; 8]).unwrap_err();
assert!(error.to_string().contains("requires a halted target"));
}
fn serve_virtual_memory(kernel: UnixStream, regions: Vec<(u64, Vec<u8>)>) -> JoinHandle<usize> {
serve_virtual_memory_capped(kernel, regions, usize::MAX)
}
fn serve_virtual_memory_capped(
mut kernel: UnixStream,
mut regions: Vec<(u64, Vec<u8>)>,
reply_cap: usize,
) -> JoinHandle<usize> {
const UNION: usize = 16;
spawn(move || {
let mut kernel_id = WIRE_FIRST_PACKET_ID;
let mut served = 0usize;
loop {
let mut header = [0u8; WIRE_HEADER_SIZE];
if kernel.read_exact(&mut header).is_err() {
return served;
}
if u32::from_le_bytes(header[0..4].try_into().unwrap()) != WIRE_DATA_LEADER {
continue; }
let len = u16::from_le_bytes(header[6..8].try_into().unwrap()) as usize;
let mut request = vec![0u8; len + 1];
kernel.read_exact(&mut request).unwrap();
let host_id = u32::from_le_bytes(header[8..12].try_into().unwrap());
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, host_id))
.unwrap();
let api_number = u32::from_le_bytes(request[0..4].try_into().unwrap());
let addr = u64::from_le_bytes(request[UNION..UNION + 8].try_into().unwrap());
let wanted =
u32::from_le_bytes(request[UNION + 8..UNION + 12].try_into().unwrap()) as usize;
served += 1;
let mut reply = vec![0u8; api::MANIPULATE_HEADER_SIZE];
reply[0..4].copy_from_slice(&api_number.to_le_bytes());
reply[UNION..UNION + 8].copy_from_slice(&addr.to_le_bytes());
reply[UNION + 8..UNION + 12].copy_from_slice(&(wanted as u32).to_le_bytes());
if api_number == api::DBGKD_WRITE_VIRTUAL_MEMORY {
let payload = &request[api::MANIPULATE_HEADER_SIZE..][..wanted];
for (base, bytes) in &mut regions {
if let Some(start) = addr.checked_sub(*base)
&& let Some(slot) =
bytes.get_mut(start as usize..start as usize + wanted)
{
slot.copy_from_slice(payload);
}
}
reply[UNION + 12..UNION + 16].copy_from_slice(&(wanted as u32).to_le_bytes());
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
kernel_id,
&reply,
))
.unwrap();
kernel_id ^= 1;
continue;
}
assert!(matches!(
api_number,
api::DBGKD_READ_VIRTUAL_MEMORY | api::DBGKD_READ_PHYSICAL_MEMORY
));
let mut data = vec![0u8; wanted];
let mut mapped = false;
for (base, bytes) in ®ions {
let start = (*base).max(addr);
let end = (*base + bytes.len() as u64).min(addr + wanted as u64);
if start < end {
mapped = true;
let from = (start - *base) as usize;
let to = (start - addr) as usize;
let len = (end - start) as usize;
data[to..to + len].copy_from_slice(&bytes[from..from + len]);
}
}
if mapped {
let sent = wanted.min(reply_cap);
reply[UNION + 12..UNION + 16].copy_from_slice(&(sent as u32).to_le_bytes());
reply.extend_from_slice(&data[..sent]);
} else {
reply[8..12].copy_from_slice(&0xC000_0005u32.to_le_bytes());
}
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
kernel_id,
&reply,
))
.unwrap();
kernel_id ^= 1;
}
})
}
fn serve_breakpoints(
mut kernel: UnixStream,
script: Vec<(u32, u32, u32)>,
) -> JoinHandle<Vec<(u32, u64)>> {
const UNION: usize = 16;
spawn(move || {
let mut kernel_id = WIRE_FIRST_PACKET_ID;
let mut script = script.into_iter();
let mut seen = Vec::new();
loop {
let mut header = [0u8; WIRE_HEADER_SIZE];
if kernel.read_exact(&mut header).is_err() {
assert!(script.next().is_none(), "missing breakpoint request");
return seen;
}
if u32::from_le_bytes(header[0..4].try_into().unwrap()) != WIRE_DATA_LEADER {
continue; }
let len = u16::from_le_bytes(header[6..8].try_into().unwrap()) as usize;
let mut request = vec![0u8; len + 1];
kernel.read_exact(&mut request).unwrap();
let host_id = u32::from_le_bytes(header[8..12].try_into().unwrap());
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, host_id))
.unwrap();
let api_number = u32::from_le_bytes(request[0..4].try_into().unwrap());
seen.push((api_number, wire::read_u64(&request, UNION)));
let (expected_api, status, handle) =
script.next().expect("unexpected breakpoint request");
assert_eq!(api_number, expected_api);
let mut reply = vec![0u8; api::MANIPULATE_HEADER_SIZE];
reply[0..4].copy_from_slice(&api_number.to_le_bytes());
reply[8..12].copy_from_slice(&status.to_le_bytes());
reply[UNION + 8..UNION + 12].copy_from_slice(&handle.to_le_bytes());
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
kernel_id,
&reply,
))
.unwrap();
kernel_id ^= 1;
}
})
}
#[test]
fn breakpoint_install_reclaims_slots_stranded_by_a_dead_session() {
let (kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.link.set_inline_running(false);
backend.exit_prepared = true;
backend.bp_handles.insert(0xfffff80000001000, 3);
let mut script = vec![(api::DBGKD_WRITE_BREAKPOINT, STATUS_UNSUCCESSFUL, 0)];
for handle in 1..=KD_BREAKPOINT_TABLE_SIZE {
if handle == 3 {
continue;
}
let status = if handle == 7 {
api::STATUS_SUCCESS
} else {
STATUS_UNSUCCESSFUL
};
script.push((api::DBGKD_RESTORE_BREAKPOINT, status, 0));
}
script.push((api::DBGKD_WRITE_BREAKPOINT, api::STATUS_SUCCESS, 9));
let worker = serve_breakpoints(kernel, script);
backend.set_breakpoint(0xfffff80000002000).unwrap();
assert_eq!(backend.bp_handles.get(&0xfffff80000002000), Some(&9));
assert_eq!(backend.bp_handles.get(&0xfffff80000001000), Some(&3));
drop(backend);
let requests = worker.join().unwrap();
let released: Vec<u64> = requests
.iter()
.filter(|(api_number, _)| *api_number == api::DBGKD_RESTORE_BREAKPOINT)
.map(|(_, handle)| *handle)
.collect();
assert!(
!released.contains(&3),
"reclaim released a handle this session still owns: {released:?}"
);
assert_eq!(released.len(), KD_BREAKPOINT_TABLE_SIZE as usize - 1);
}
#[test]
fn a_refused_restore_keeps_a_site_that_still_holds_a_breakpoint() {
const ADDR: u64 = 0xffff_f800_0001_2000;
let mut refused = api::test_wire::build_reply(api::DBGKD_RESTORE_BREAKPOINT, 0, &[], &[]);
refused[8..12].copy_from_slice(&STATUS_UNSUCCESSFUL.to_le_bytes());
let mut probe = vec![0u8; api::MANIPULATE_HEADER_SIZE];
wire::write_u32(&mut probe, 0, api::DBGKD_READ_VIRTUAL_MEMORY);
wire::write_u64(&mut probe, 16, ADDR);
wire::write_u32(&mut probe, 16 + 8, 1);
wire::write_u32(&mut probe, 16 + 12, 1);
probe.push(0xcc);
let (host, target) = UnixStream::pair().unwrap();
(&target)
.write_all(&scripted_target(&[refused, probe]))
.unwrap();
let mut backend = kd_backend_with_framing(host);
backend.bp_handles.insert(ADDR, 1);
backend.managed_bp_addresses.insert(ADDR);
let error = backend.remove_breakpoint(ADDR).unwrap_err();
assert!(
error.to_string().contains("still holds a breakpoint"),
"unexpected error: {error}"
);
assert_eq!(backend.bp_handles.get(&ADDR), Some(&1));
assert!(
backend.managed_bp_addresses.contains(&ADDR),
"an armed site was disowned, so a resume would step its program counter"
);
}
#[test]
fn exit_restores_breakpoints_the_host_left_installed() {
let (kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.link.set_inline_running(false);
backend.bp_handles.insert(0xfffff80000003000, 4);
backend.managed_bp_addresses.insert(0xfffff80000003000);
let worker = serve_breakpoints(
kernel,
vec![(api::DBGKD_RESTORE_BREAKPOINT, api::STATUS_SUCCESS, 0)],
);
backend.prepare_for_exit(false).unwrap();
assert!(backend.bp_handles.is_empty());
assert!(backend.managed_bp_addresses.is_empty());
drop(backend);
assert_eq!(
worker.join().unwrap(),
vec![(api::DBGKD_RESTORE_BREAKPOINT, 4)]
);
}
fn serve_manipulate(
mut kernel: UnixStream,
script: Vec<(u32, u32, Vec<u8>)>,
) -> JoinHandle<()> {
const UNION: usize = 16;
spawn(move || {
let mut kernel_id = WIRE_FIRST_PACKET_ID;
let mut script = script.into_iter();
loop {
let mut header = [0u8; WIRE_HEADER_SIZE];
if kernel.read_exact(&mut header).is_err() {
assert!(script.next().is_none(), "missing manipulate request");
return;
}
if u32::from_le_bytes(header[0..4].try_into().unwrap()) != WIRE_DATA_LEADER {
continue; }
let len = u16::from_le_bytes(header[6..8].try_into().unwrap()) as usize;
let mut request = vec![0u8; len + 1];
kernel.read_exact(&mut request).unwrap();
let host_id = u32::from_le_bytes(header[8..12].try_into().unwrap());
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, host_id))
.unwrap();
let (api_number, status, data) =
script.next().expect("unexpected manipulate request");
assert_eq!(
u32::from_le_bytes(request[0..4].try_into().unwrap()),
api_number
);
let mut reply = vec![0u8; api::MANIPULATE_HEADER_SIZE];
reply[0..4].copy_from_slice(&api_number.to_le_bytes());
reply[8..12].copy_from_slice(&status.to_le_bytes());
reply[UNION + 12..UNION + 16].copy_from_slice(&(data.len() as u32).to_le_bytes());
reply.extend_from_slice(&data);
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
kernel_id,
&reply,
))
.unwrap();
kernel_id ^= 1;
}
})
}
#[test]
fn arm64_registers_survive_refused_control_space() {
let (kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.arch = Arch::Arm64;
backend.register_map = context_arm64::build_register_map();
backend.link.set_inline_running(false);
backend.exit_prepared = true;
let mut ctx = vec![0u8; context_arm64::CONTEXT_SIZE];
wire::write_u64(&mut ctx, context_arm64::OFFSET_PC, 0xffff_f800_1234_5678);
wire::write_u64(&mut ctx, context_arm64::OFFSET_BVR0, 0xffff_f800_dead_0000);
wire::write_u32(&mut ctx, context_arm64::OFFSET_BCR0, 0x1e5);
let expected = ctx.clone();
let worker = serve_manipulate(
kernel,
vec![
(api::DBGKD_GET_CONTEXT, api::STATUS_SUCCESS, ctx),
(
api::DBGKD_READ_MACHINE_SPECIFIC_REGISTER,
0xc000_0001,
Vec::new(),
),
(api::DBGKD_READ_CONTROL_SPACE, 0xc000_0001, Vec::new()),
],
);
let regs = backend.read_registers().unwrap();
assert_eq!(®s[..context_arm64::CONTEXT_SIZE], &expected[..]);
assert_eq!(
backend.register_map.read_u64("bvr0", ®s).unwrap(),
0xffff_f800_dead_0000
);
assert_eq!(backend.read_registers().unwrap(), regs);
drop(backend);
worker.join().unwrap();
}
const FAKE_KERNEL_DTB: u64 = 0x1ad000;
const FAKE_KERNEL_BASE: u64 = 0xffff_f800_0000_0000;
const FAKE_GUID: u128 = 0x51;
fn field(offset: u32, size: u64, type_data: ParsedType) -> FieldInfo {
FieldInfo {
offset,
size,
type_data,
}
}
fn primitive(offset: u32, size: u64) -> FieldInfo {
field(offset, size, ParsedType::Primitive("u".into()))
}
fn layout(name: &str, size: usize, fields: &[(&str, FieldInfo)]) -> TypeInfo {
TypeInfo {
name: name.to_string(),
pointer_size: 8,
size,
fields: fields
.iter()
.map(|(name, info)| (name.to_string(), info.clone()))
.collect(),
}
}
fn synthetic_guest(
regions: Vec<(u64, Vec<u8>)>,
types: Vec<TypeInfo>,
symbols: &[(&str, u32)],
) -> (Guest, Arc<Mutex<KdBackend>>, JoinHandle<usize>) {
let (kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.link.set_inline_running(false);
backend.exit_prepared = true;
backend.kernel_dtb_override = FAKE_KERNEL_DTB;
let translations = Arc::clone(&backend.translations);
let inner = Arc::new(Mutex::new(backend));
let phys = Arc::new(PhysMem::remote(KdMemory {
inner: Arc::clone(&inner),
translations,
}));
let store = Arc::new(SymbolStore::new());
store.inject_module_for_test(FAKE_GUID, types, symbols);
let mut ntoskrnl = WinObject::new_with_arch(
phys,
store,
FAKE_KERNEL_DTB,
VirtAddr(FAKE_KERNEL_BASE),
Arch::Amd64,
);
ntoskrnl.guid = Some(FAKE_GUID);
let worker = serve_virtual_memory(kernel, regions);
(Guest::from_kernel(ntoskrnl), inner, worker)
}
fn put_u64(bytes: &mut [u8], offset: usize, value: u64) {
bytes[offset..offset + 8].copy_from_slice(&value.to_le_bytes());
}
fn resume_and_halt(backend: &Arc<Mutex<KdBackend>>) {
let mut backend = backend.lock().unwrap();
backend.record_running();
backend.link.set_inline_running(false);
}
#[test]
fn process_walk_reads_one_span_per_process_and_memoizes_per_halt() {
const PID: u32 = 0x440;
const LINKS: u32 = 0x448;
const NAME: u32 = 0x5a8;
const DTB: u32 = 0x28;
let eprocess = layout(
"_EPROCESS",
0x600,
&[
(
"Pcb",
field(0, 0x438, ParsedType::Struct("_KPROCESS".into())),
),
("UniqueProcessId", primitive(PID, 8)),
("ActiveProcessLinks", primitive(LINKS, 16)),
("ImageFileName", primitive(NAME, 15)),
],
);
let kprocess = layout(
"_KPROCESS",
0x438,
&[("DirectoryTableBase", primitive(DTB, 8))],
);
let head = FAKE_KERNEL_BASE + 0x1008;
let system = 0xffff_e000_0001_0000u64;
let smss = 0xffff_e000_0002_0000u64;
let mut nt = vec![0u8; 0x2000];
put_u64(&mut nt, 0x1000, system);
put_u64(&mut nt, 0x1008, system + LINKS as u64);
let process = |pid: u64, dtb: u64, name: &[u8], next: u64| {
let mut bytes = vec![0u8; 0x600];
put_u64(&mut bytes, PID as usize, pid);
put_u64(&mut bytes, DTB as usize, dtb);
put_u64(&mut bytes, LINKS as usize, next + LINKS as u64);
bytes[NAME as usize..NAME as usize + name.len()].copy_from_slice(name);
bytes
};
let regions = vec![
(FAKE_KERNEL_BASE, nt),
(system, process(4, 0x1ad000, b"System", smss)),
(
smss,
process(0x1d8, 0x2be000, b"smss.exe", head - LINKS as u64),
),
];
let (guest, backend, worker) = synthetic_guest(
regions,
vec![eprocess, kprocess],
&[
("PsInitialSystemProcess", 0x1000),
("PsActiveProcessHead", 0x1008),
],
);
let first = guest.enumerate_processes().unwrap();
let names: Vec<_> = first.iter().map(|p| (p.name.as_str(), p.pid)).collect();
assert_eq!(names, [("System", 4), ("smss.exe", 0x1d8)]);
assert_eq!(first[1].dtb, 0x2be000);
let second = guest.enumerate_processes().unwrap();
assert_eq!(second.len(), 2);
let one = guest.process_at(VirtAddr(smss)).unwrap();
assert_eq!(
(one.name.as_str(), one.pid, one.dtb),
("smss.exe", 0x1d8, 0x2be000)
);
resume_and_halt(&backend);
assert_eq!(guest.enumerate_processes().unwrap().len(), 2);
drop(guest);
drop(backend);
assert_eq!(worker.join().unwrap(), 3 + 3);
}
#[test]
fn user_space_of_the_current_process_is_read_in_one_request() {
const USER_VA: u64 = 0x7ff6_1234_5000;
const CURRENT_CR3: u64 = 0x2be000;
let regions = vec![(USER_VA, b"PEB!".to_vec())];
let (guest, backend, worker) = synthetic_guest(regions, Vec::new(), &[]);
{
let mut backend = backend.lock().unwrap();
let mut special = vec![0u8; KSPECIAL_REGISTERS_MIN_SIZE];
put_u64(
&mut special,
KSPECIAL_REGISTERS_CR3_OFFSET,
CURRENT_CR3 | 0x1,
);
let processor = backend.current_processor;
backend.special_register_cache.insert(processor, special);
let mut out = [0u8; 4];
assert!(
backend
.read_virtual_direct(VirtAddr(USER_VA), 0x3cf000, &mut out)
.is_none()
);
backend
.read_virtual_direct(VirtAddr(USER_VA), CURRENT_CR3, &mut out)
.unwrap()
.unwrap();
assert_eq!(&out, b"PEB!");
}
drop(guest);
drop(backend);
assert_eq!(worker.join().unwrap(), 1);
}
#[test]
fn kernel_module_walk_prefetches_each_record() {
const DLL_BASE: u32 = 0x30;
const SIZE: u32 = 0x40;
const NAME: u32 = 0x58;
const TIME_DATE_STAMP: u32 = 0x9c;
const CHECK_SUM: u32 = 0x100;
let entry = layout(
"_KLDR_DATA_TABLE_ENTRY",
0x120,
&[
("InLoadOrderLinks", primitive(0, 16)),
("DllBase", primitive(DLL_BASE, 8)),
("SizeOfImage", primitive(SIZE, 4)),
(
"BaseDllName",
field(NAME, 16, ParsedType::Struct("_UNICODE_STRING".into())),
),
("TimeDateStamp", primitive(TIME_DATE_STAMP, 4)),
("CheckSum", primitive(CHECK_SUM, 4)),
],
);
let unicode = layout(
"_UNICODE_STRING",
16,
&[("Length", primitive(0, 2)), ("Buffer", primitive(8, 8))],
);
let head = FAKE_KERNEL_BASE + 0x2000;
let names = 0xffff_e000_0009_0000u64;
let entries = 0xffff_e000_000a_0000u64;
let mut nt = vec![0u8; 0x3000];
put_u64(&mut nt, 0x2000, entries);
let name_bytes: Vec<u8> = "ntoskrnl.exe\0\0\0\0hal.dll"
.encode_utf16()
.flat_map(u16::to_le_bytes)
.collect();
let mut records = vec![0u8; 0x240];
let mut record = |at: usize, next: u64, base: u64, name_off: u64, name_len: u16| {
put_u64(&mut records, at, next);
put_u64(&mut records, at + DLL_BASE as usize, base);
records[at + SIZE as usize..at + SIZE as usize + 4]
.copy_from_slice(&0x1000u32.to_le_bytes());
records[at + NAME as usize..at + NAME as usize + 2]
.copy_from_slice(&name_len.to_le_bytes());
put_u64(&mut records, at + NAME as usize + 8, names + name_off);
};
record(0, entries + 0x120, FAKE_KERNEL_BASE, 0, 24);
record(0x120, head, 0xffff_f800_1000_0000, 32, 14);
let regions = vec![
(FAKE_KERNEL_BASE, nt),
(names, name_bytes),
(entries, records),
];
let (guest, backend, worker) = synthetic_guest(
regions,
vec![entry, unicode],
&[("PsLoadedModuleList", 0x2000)],
);
let modules = guest.kernel_modules().unwrap();
let seen: Vec<_> = modules
.iter()
.map(|m| (m.name.as_str(), m.base_address.0))
.collect();
assert_eq!(
seen,
[
("ntoskrnl.exe", FAKE_KERNEL_BASE),
("hal.dll", 0xffff_f800_1000_0000)
]
);
assert_eq!(guest.kernel_modules().unwrap().len(), 2);
drop(guest);
drop(backend);
assert_eq!(worker.join().unwrap(), 1 + 2 + 1);
}
#[test]
fn virtual_lines_serve_a_halt_and_drop_on_write_and_resume() {
const FIELD: u64 = FAKE_KERNEL_BASE + 0x1010;
let mut nt = vec![0u8; 0x2000];
put_u64(&mut nt, 0x1010, 0x1111);
put_u64(&mut nt, 0x1018, 0x2222);
let (guest, backend, worker) =
synthetic_guest(vec![(FAKE_KERNEL_BASE, nt)], Vec::new(), &[]);
let read = |at: u64| {
let mut out = [0u8; 8];
backend
.lock()
.unwrap()
.read_virtual_bytes(VirtAddr(at), &mut out)
.unwrap();
u64::from_le_bytes(out)
};
assert_eq!(read(FIELD), 0x1111);
assert_eq!(read(FIELD + 8), 0x2222);
backend
.lock()
.unwrap()
.write_virtual_bytes(VirtAddr(FIELD), &0x3333u64.to_le_bytes())
.unwrap();
assert_eq!(read(FIELD), 0x3333);
resume_and_halt(&backend);
assert_eq!(read(FIELD + 8), 0x2222);
let mut out = [0u8; 8];
let error = backend
.lock()
.unwrap()
.read_virtual_bytes(VirtAddr(FAKE_KERNEL_BASE + 0x2000), &mut out)
.unwrap_err();
assert!(matches!(error, Error::BadVirtualAddress(_)), "{error}");
drop(guest);
drop(backend);
assert_eq!(worker.join().unwrap(), 5);
}
#[test]
fn page_table_lines_serve_a_halt_and_drop_on_write_and_resume() {
const TABLE: u64 = 0x1ad000;
let mut table = vec![0u8; PAGE_SIZE];
put_u64(&mut table, 0x10, 0x1111);
put_u64(&mut table, 0x18, 0x2222);
put_u64(&mut table, 0x800, 0x3333);
let (guest, backend, worker) = synthetic_guest(vec![(TABLE, table)], Vec::new(), &[]);
let read = |at: u64| {
let mut out = [0u8; 8];
backend
.lock()
.unwrap()
.read_page_table_bytes(at, &mut out)
.unwrap();
u64::from_le_bytes(out)
};
assert_eq!(read(TABLE + 0x10), 0x1111);
assert_eq!(read(TABLE + 0x18), 0x2222);
assert_eq!(read(TABLE + 0x800), 0x3333);
backend
.lock()
.unwrap()
.write_virtual_bytes(VirtAddr(FAKE_KERNEL_BASE), &[0u8; 8])
.unwrap();
assert_eq!(read(TABLE + 0x10), 0x1111);
resume_and_halt(&backend);
assert_eq!(read(TABLE + 0x18), 0x2222);
drop(guest);
drop(backend);
assert_eq!(worker.join().unwrap(), 5);
}
#[test]
fn truncated_fills_keep_whole_lines_and_finish_the_read() {
let (kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.link.set_inline_running(false);
backend.exit_prepared = true;
let bytes: Vec<u8> = (0..0x1000u32).map(|i| i as u8 ^ (i >> 8) as u8).collect();
let worker =
serve_virtual_memory_capped(kernel, vec![(FAKE_KERNEL_BASE, bytes.clone())], 0x300);
let mut out = vec![0u8; 0x800];
backend
.read_virtual_bytes(VirtAddr(FAKE_KERNEL_BASE), &mut out)
.unwrap();
assert_eq!(out, bytes[..0x800]);
let mut tail = [0u8; 8];
backend
.read_virtual_bytes(VirtAddr(FAKE_KERNEL_BASE + 0x2f8), &mut tail)
.unwrap();
assert_eq!(tail, bytes[0x2f8..0x300]);
assert_eq!(backend.virtual_fill_cap, KD_VIRTUAL_LINE);
drop(backend);
assert_eq!(worker.join().unwrap(), 1 + 3);
}
fn read_special_registers_reply_payload(processor: u16) -> Vec<u8> {
const MANIPULATE_UNION_OFFSET: usize = 16;
let mut payload = vec![0u8; api::MANIPULATE_HEADER_SIZE + KSPECIAL_REGISTERS_MIN_SIZE];
payload[0..4].copy_from_slice(&api::DBGKD_READ_CONTROL_SPACE.to_le_bytes());
payload[6..8].copy_from_slice(&processor.to_le_bytes());
payload[MANIPULATE_UNION_OFFSET..MANIPULATE_UNION_OFFSET + 8]
.copy_from_slice(&AMD64_DEBUG_CONTROL_SPACE_KSPECIAL.to_le_bytes());
payload[MANIPULATE_UNION_OFFSET + 8..MANIPULATE_UNION_OFFSET + 12]
.copy_from_slice(&(KSPECIAL_REGISTERS_MIN_SIZE as u32).to_le_bytes());
payload[MANIPULATE_UNION_OFFSET + 12..MANIPULATE_UNION_OFFSET + 16]
.copy_from_slice(&(KSPECIAL_REGISTERS_MIN_SIZE as u32).to_le_bytes());
payload
}
#[test]
fn known_breakin_stop_is_marked_assisted_unless_managed() {
let (_kernel, host) = UnixStream::pair().unwrap();
let breakin_clone = host.try_clone().unwrap();
let pump_host = host.try_clone().unwrap();
let pump = PumpHandle {
join: spawn(move || KdFraming::new(pump_host.into())),
stop_rx: mpsc::channel().1,
shutdown: Arc::new(AtomicBool::new(false)),
reported_stop: Arc::new(AtomicBool::new(false)),
breakin_requested: Arc::new(AtomicBool::new(false)),
};
let mut backend = kd_backend_with_pump(pump, breakin_clone);
let pc = 0xfffff800_deadbeef;
backend.breakin_addresses.insert(pc);
let stop = StateChange {
processor: 0,
number_processors: 1,
new_state: DBG_KD_EXCEPTION_STATE_CHANGE,
exception_code: STATUS_BREAKPOINT,
exception_first_chance: Some(true),
exception_address: Some(pc),
program_counter: pc,
kernel_base_hint: None,
is_bugcheck: false,
bugcheck: None,
target_reloaded: false,
assisted_breakin: false,
};
assert!(
backend
.mark_known_breakin_stop(stop.clone())
.assisted_breakin
);
backend.managed_bp_addresses.insert(pc);
assert!(!backend.mark_known_breakin_stop(stop).assisted_breakin);
}
#[test]
fn continue_drains_in_place_rebreak_and_stale_breakin() {
let resumed_from = 0xffff_f800_0013_40c4;
let breakin = 0xffff_f800_002f_90d0;
let drain = |managed: &[u64]| {
ContinueDrain::new(
resumed_from,
managed.iter().copied().collect(),
HashSet::from([breakin]),
context::build_register_map(),
)
};
let stop_at = |code: u32, pc: u64| StateChange {
processor: 0,
number_processors: 1,
new_state: DBG_KD_EXCEPTION_STATE_CHANGE,
exception_code: code,
exception_first_chance: Some(true),
exception_address: Some(pc),
program_counter: pc,
kernel_base_hint: None,
is_bugcheck: false,
bugcheck: None,
target_reloaded: false,
assisted_breakin: false,
};
assert!(drain(&[]).is_spurious(&stop_at(STATUS_BREAKPOINT, resumed_from)));
assert!(drain(&[]).is_spurious(&stop_at(STATUS_BREAKPOINT, breakin)));
assert!(!drain(&[breakin]).is_spurious(&stop_at(STATUS_BREAKPOINT, breakin)));
assert!(!drain(&[]).is_spurious(&stop_at(STATUS_BREAKPOINT, 0xdead_0000)));
assert!(!drain(&[]).is_spurious(&stop_at(STATUS_SINGLE_STEP, resumed_from)));
let mut assisted = stop_at(STATUS_BREAKPOINT, breakin);
assisted.assisted_breakin = true;
assert!(!drain(&[]).is_spurious(&assisted));
let mut reloaded = stop_at(STATUS_BREAKPOINT, resumed_from);
reloaded.target_reloaded = true;
assert!(!drain(&[]).is_spurious(&reloaded));
let interrupted = drain(&[]);
interrupted.interrupt_flag().store(true, Ordering::SeqCst);
assert!(!interrupted.is_spurious(&stop_at(STATUS_BREAKPOINT, resumed_from)));
}
#[test]
fn pending_write_breakpoint_retry_completes_late_reply_without_resend() {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_millis(200)))
.unwrap();
let mut backend = kd_backend_with_framing(host);
let addr = 0xfffff800_12345678;
let handle = 7;
backend.pending_write_breakpoint = Some(PendingWriteBreakpoint { addr, processor: 0 });
let payload = write_breakpoint_reply_payload(0, addr, handle);
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
WIRE_FIRST_PACKET_ID,
&payload,
))
.unwrap();
kernel.flush().unwrap();
backend.set_breakpoint(addr).unwrap();
assert_eq!(backend.bp_handles.get(&addr), Some(&handle));
assert!(backend.managed_bp_addresses.contains(&addr));
assert!(backend.pending_write_breakpoint.is_none());
let ack = read_wire_packet(&mut kernel);
assert_eq!(
u32::from_le_bytes(ack[0..4].try_into().unwrap()),
WIRE_CONTROL_LEADER
);
assert_eq!(
u16::from_le_bytes(ack[4..6].try_into().unwrap()),
PACKET_TYPE_KD_ACKNOWLEDGE
);
assert_eq!(
u32::from_le_bytes(ack[8..12].try_into().unwrap()),
WIRE_FIRST_PACKET_ID
);
let mut extra = [0u8; 1];
match kernel.read(&mut extra) {
Err(e) if is_temporary_io_error(e.kind()) => {}
Ok(0) => {}
Ok(n) => panic!("unexpected duplicate KD request: read {n} byte(s)"),
Err(e) => panic!("unexpected socket read error: {e}"),
}
}
#[test]
fn pending_write_breakpoint_blocks_unrelated_kd_requests() {
let (_kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
let addr = 0xfffff800_12345678;
backend.pending_write_breakpoint = Some(PendingWriteBreakpoint { addr, processor: 0 });
let err = backend
.set_breakpoint(addr + 1)
.expect_err("different breakpoint should be rejected while install is pending");
let message = err.to_string();
assert!(message.contains("breakpoint install at 0xfffff80012345678 is pending"));
assert!(message.contains("retry the same bp command"));
let err = backend
.target_kernel_base_hint()
.expect_err("other KD requests should be rejected while install is pending");
assert!(err.to_string().contains("retry the same bp command"));
}
#[test]
fn pump_services_state_change_and_returns_framing() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
let pc = 0xfffff800_deadbeef;
let pkt = wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
WIRE_FIRST_PACKET_ID,
&exception_state_change_payload(pc),
);
kernel.write_all(&pkt).unwrap();
kernel.flush().unwrap();
let stop = rx
.recv_timeout(Duration::from_secs(5))
.expect("pump reported no stop")
.expect("pump reported an error");
assert_eq!(stop.program_counter, pc);
assert_eq!(stop.exception_code, STATUS_BREAKPOINT);
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
}
#[test]
fn exit_resume_consumes_pump_stop_before_final_continue() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let breakin_clone = host.try_clone().unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let join = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
let pump = PumpHandle {
join,
stop_rx: rx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
breakin_requested: Arc::new(AtomicBool::new(false)),
};
let mut backend = kd_backend_with_pump(pump, breakin_clone);
let (continue_tx, continue_rx) = mpsc::channel();
let (done_tx, done_rx) = mpsc::channel();
let kernel_thread = spawn(move || {
let pc = 0xfffff800_deadbeef;
let mut payload = exception_state_change_payload(pc);
payload[32..36].copy_from_slice(&0xc000_0005u32.to_le_bytes());
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
WIRE_FIRST_PACKET_ID,
&payload,
))
.unwrap();
kernel.flush().unwrap();
let ack = read_wire_packet(&mut kernel);
assert_eq!(
u32::from_le_bytes(ack[0..4].try_into().unwrap()),
WIRE_CONTROL_LEADER
);
assert_eq!(
u16::from_le_bytes(ack[4..6].try_into().unwrap()),
PACKET_TYPE_KD_ACKNOWLEDGE
);
let read_special_packet = read_wire_packet(&mut kernel);
let read_special_request = &read_special_packet
[WIRE_HEADER_SIZE..WIRE_HEADER_SIZE + api::MANIPULATE_HEADER_SIZE];
assert_eq!(
u32::from_le_bytes(read_special_request[0..4].try_into().unwrap()),
api::DBGKD_READ_CONTROL_SPACE
);
let read_special_id =
u32::from_le_bytes(read_special_packet[8..12].try_into().unwrap());
kernel
.write_all(&wire_control_packet(
PACKET_TYPE_KD_ACKNOWLEDGE,
read_special_id,
))
.unwrap();
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_MANIPULATE,
WIRE_FIRST_PACKET_ID ^ 1,
&read_special_registers_reply_payload(0),
))
.unwrap();
kernel.flush().unwrap();
let read_special_ack = read_wire_packet(&mut kernel);
assert_eq!(
u16::from_le_bytes(read_special_ack[4..6].try_into().unwrap()),
PACKET_TYPE_KD_ACKNOWLEDGE
);
let continue_packet = read_wire_packet(&mut kernel);
let continue_id = u32::from_le_bytes(continue_packet[8..12].try_into().unwrap());
continue_tx.send(continue_packet).unwrap();
kernel
.write_all(&wire_control_packet(
PACKET_TYPE_KD_ACKNOWLEDGE,
continue_id,
))
.unwrap();
kernel.flush().unwrap();
done_rx.recv_timeout(Duration::from_secs(5)).unwrap();
});
backend.prepare_for_exit(true).unwrap();
done_tx.send(()).unwrap();
kernel_thread.join().expect("kernel thread panicked");
let continue_packet = continue_rx
.recv_timeout(Duration::from_secs(5))
.expect("kernel thread did not capture continue packet");
assert!(matches!(backend.link, Link::RunningInline(_)));
assert!(backend.exit_prepared);
assert_eq!(
u32::from_le_bytes(continue_packet[0..4].try_into().unwrap()),
WIRE_DATA_LEADER
);
assert_eq!(
u16::from_le_bytes(continue_packet[4..6].try_into().unwrap()),
PACKET_TYPE_KD_STATE_MANIPULATE
);
let request = &continue_packet[WIRE_HEADER_SIZE..];
assert_eq!(
u32::from_le_bytes(request[0..4].try_into().unwrap()),
api::DBGKD_CONTINUE_API2
);
assert_eq!(
u32::from_le_bytes(request[16..20].try_into().unwrap()),
api::DBG_CONTINUE
);
}
#[test]
fn explicit_halted_exit_suppresses_drop_resume() {
let (host, _kernel) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.link.set_inline_running(false);
backend.prepare_for_exit(false).unwrap();
let needs_drop_cleanup = backend.needs_drop_cleanup();
backend.link.set_inline_running(true);
assert!(backend.exit_prepared);
assert!(!needs_drop_cleanup);
}
#[test]
fn pump_shutdown_without_a_pump_keeps_the_framing() {
let (_kernel, host) = UnixStream::pair().unwrap();
let mut backend = kd_backend_with_framing(host);
backend.link.set_inline_running(false);
assert!(backend.shutdown_pump_with_stop().unwrap().is_none());
assert!(matches!(backend.link, Link::Halted(_)));
backend.reclaim_framing();
assert!(matches!(backend.link, Link::Halted(_)));
assert!(backend.framing().is_ok());
backend.link.set_inline_running(true);
}
#[test]
fn exit_classifies_stray_single_step_but_spares_real_stops() {
let pc = 0xfffff800_deadbeef;
let mut managed = HashSet::new();
let stop_at = |code: Option<u32>, pc: Option<u64>, is_bugcheck: bool| StopEvent {
thread_id: None,
exception_code: code,
first_chance: code.map(|_| true),
exception_address: pc,
program_counter: pc,
is_bugcheck,
bugcheck: None,
target_reloaded: false,
target_kernel_base_hint: None,
modules_changed: false,
assisted_breakin: false,
};
assert!(exit_stop_is_stray_single_step(
&stop_at(Some(STATUS_SINGLE_STEP), Some(pc), false),
&managed,
));
assert!(exit_stop_is_stray_single_step(
&stop_at(Some(STATUS_SINGLE_STEP), None, false),
&managed,
));
managed.insert(pc);
assert!(!exit_stop_is_stray_single_step(
&stop_at(Some(STATUS_SINGLE_STEP), Some(pc), false),
&managed,
));
assert!(!exit_stop_is_stray_single_step(
&stop_at(Some(STATUS_BREAKPOINT), Some(0x1000), false),
&managed,
));
assert!(!exit_stop_is_stray_single_step(
&stop_at(Some(STATUS_SINGLE_STEP), Some(0x1000), true),
&managed,
));
}
#[test]
fn has_pending_stop_flags_undrained_pump_stop_until_consumed() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let breakin_clone = host.try_clone().unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let reported_stop = Arc::new(AtomicBool::new(false));
let join = {
let shutdown = Arc::clone(&shutdown);
let reported_stop = Arc::clone(&reported_stop);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop,
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
let pump = PumpHandle {
join,
stop_rx: rx,
shutdown,
reported_stop,
breakin_requested: Arc::new(AtomicBool::new(false)),
};
let mut backend = kd_backend_with_pump(pump, breakin_clone);
assert!(backend.is_running());
assert!(!backend.has_pending_stop());
let pc = 0xfffff800_deadbeef;
let mut payload = exception_state_change_payload(pc);
payload[32..36].copy_from_slice(&STATUS_BREAKPOINT.to_le_bytes());
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
WIRE_FIRST_PACKET_ID,
&payload,
))
.unwrap();
kernel.flush().unwrap();
let deadline = Instant::now() + Duration::from_secs(5);
while !backend.has_pending_stop() {
assert!(
Instant::now() < deadline,
"pump never flagged the reported stop"
);
std::thread::sleep(Duration::from_millis(5));
}
assert!(backend.is_running());
assert!(backend.has_pending_stop());
let stop = backend
.take_pump_stop(Some(Duration::from_secs(5)))
.unwrap()
.expect("pump reported no stop");
assert_eq!(stop.program_counter, pc);
assert!(matches!(backend.link, Link::RunningInline(_)));
assert!(!backend.has_pending_stop());
backend.record_stop(&stop);
assert!(matches!(backend.link, Link::Halted(_)));
backend.exit_prepared = true;
}
#[test]
fn pump_absorbs_rebreak_after_continue_and_reports_real_stop() {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_secs(5)))
.unwrap();
let framing = KdFraming::new(host.into());
let resumed_from = 0xfffff800_deadbeef;
let real_stop = 0xfffff800_cafe0000;
let drain = ContinueDrain::new(
resumed_from,
HashSet::new(),
HashSet::new(),
context::build_register_map(),
);
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
Some(drain),
)
})
};
let mut kernel_id = WIRE_FIRST_PACKET_ID;
let mut send = |kernel: &mut UnixStream, packet_type: u16, payload: &[u8]| {
kernel
.write_all(&wire_data_packet(packet_type, kernel_id, payload))
.unwrap();
kernel.flush().unwrap();
kernel_id ^= 1;
};
send(
&mut kernel,
PACKET_TYPE_KD_STATE_CHANGE64,
&exception_state_change_payload(resumed_from),
);
let mut context_written = 0usize;
loop {
let packet = read_wire_packet(&mut kernel);
if u32::from_le_bytes(packet[0..4].try_into().unwrap()) == WIRE_CONTROL_LEADER {
continue;
}
let host_id = u32::from_le_bytes(packet[8..12].try_into().unwrap());
let request = &packet[WIRE_HEADER_SIZE..packet.len() - 1];
let api_number = u32::from_le_bytes(request[0..4].try_into().unwrap());
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_ACKNOWLEDGE, host_id))
.unwrap();
let reply = match api_number {
api::DBGKD_GET_CONTEXT => {
let mut context = vec![0u8; context::CONTEXT_SIZE];
context[context::OFFSET_RIP..context::OFFSET_RIP + 8]
.copy_from_slice(&resumed_from.to_le_bytes());
let mut reply = manipulate_reply_payload(api_number, 0, &[]);
reply.extend_from_slice(&context);
reply
}
api::DBGKD_SET_CONTEXT_EX => {
let chunk = &request[api::MANIPULATE_HEADER_SIZE..];
context_written += chunk.len();
let mut union = [0u8; 12];
union[8..12].copy_from_slice(&(chunk.len() as u32).to_le_bytes());
manipulate_reply_payload(api_number, 0, &union)
}
api::DBGKD_READ_VIRTUAL_MEMORY => {
let mut union = [0u8; 16];
union[12..16].copy_from_slice(&1u32.to_le_bytes());
let mut reply = manipulate_reply_payload(api_number, 0, &union);
reply.push(0xcc);
reply
}
api::DBGKD_READ_CONTROL_SPACE => read_special_registers_reply_payload(0),
api::DBGKD_CONTINUE_API2 => break,
other => panic!("unexpected request {other:#x} while absorbing a re-break"),
};
send(&mut kernel, PACKET_TYPE_KD_STATE_MANIPULATE, &reply);
}
assert_eq!(
context_written,
context::CONTEXT_SIZE,
"the pump must write back the whole advanced context"
);
assert!(
rx.try_recv().is_err(),
"an absorbed re-break must not be reported"
);
send(
&mut kernel,
PACKET_TYPE_KD_STATE_CHANGE64,
&exception_state_change_payload(real_stop),
);
let stop = rx
.recv_timeout(Duration::from_secs(5))
.expect("pump reported no stop")
.expect("pump reported an error");
assert_eq!(stop.program_counter, real_stop);
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
}
#[test]
fn pump_sends_breakin_after_peer_reset_while_waiting_for_reconnect() {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_secs(2)))
.unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_RESET, 0))
.unwrap();
kernel.flush().unwrap();
let deadline = Instant::now() + Duration::from_secs(2);
let mut saw_breakin = false;
let mut buf = [0u8; 64];
while Instant::now() < deadline && !saw_breakin {
match kernel.read(&mut buf) {
Ok(0) => break,
Ok(n) => {
saw_breakin = buf[..n].contains(&BREAKIN_BYTE);
}
Err(e) if matches!(e.kind(), ErrorKind::WouldBlock | ErrorKind::TimedOut) => {}
Err(e) => panic!("failed to read pump output: {e}"),
}
}
assert!(saw_breakin, "pump should assist reboot reconnects");
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
assert!(
rx.try_recv().is_err(),
"reset alone should not report a stop"
);
}
#[test]
fn pump_tags_stop_after_assisted_reconnect_breakin() {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_secs(2)))
.unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_RESET, 0))
.unwrap();
kernel.flush().unwrap();
let deadline = Instant::now() + Duration::from_secs(2);
let mut saw_breakin = false;
let mut buf = [0u8; 64];
while Instant::now() < deadline && !saw_breakin {
match kernel.read(&mut buf) {
Ok(0) => break,
Ok(n) => {
saw_breakin = buf[..n].contains(&BREAKIN_BYTE);
}
Err(e) if matches!(e.kind(), ErrorKind::WouldBlock | ErrorKind::TimedOut) => {}
Err(e) => panic!("failed to read pump output: {e}"),
}
}
assert!(saw_breakin, "pump should send reconnect break-in");
let pc = 0xfffff800_deadbeef;
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
WIRE_FIRST_PACKET_ID,
&exception_state_change_payload(pc),
))
.unwrap();
kernel.flush().unwrap();
let stop = rx
.recv_timeout(Duration::from_secs(5))
.expect("pump reported no stop")
.expect("pump reported an error");
assert_eq!(stop.program_counter, pc);
assert!(stop.target_reloaded);
assert!(stop.assisted_breakin);
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
}
#[test]
fn pump_surfaces_reloaded_transparent_state_change() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
kernel
.write_all(&wire_control_packet(PACKET_TYPE_KD_RESET, 0))
.unwrap();
let pc = 0xfffff800_feedface;
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
WIRE_FIRST_PACKET_ID,
&state_change_payload(DBG_KD_LOAD_SYMBOLS_STATE_CHANGE, pc),
))
.unwrap();
kernel.flush().unwrap();
let stop = rx
.recv_timeout(Duration::from_secs(5))
.expect("pump reported no stop")
.expect("pump reported an error");
assert_eq!(stop.new_state, DBG_KD_LOAD_SYMBOLS_STATE_CHANGE);
assert_eq!(stop.program_counter, pc);
assert!(stop.target_reloaded);
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
}
#[test]
fn pump_surfaces_load_symbols_as_a_module_change_stop() {
let (mut kernel, host) = UnixStream::pair().unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
let pc = 0xfffff800_cafebabe;
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
WIRE_FIRST_PACKET_ID,
&state_change_payload(DBG_KD_LOAD_SYMBOLS_STATE_CHANGE, pc),
))
.unwrap();
kernel.flush().unwrap();
let stop = rx
.recv_timeout(Duration::from_secs(5))
.expect("pump reported no load-symbols notification")
.expect("pump reported an error");
assert_eq!(stop.new_state, DBG_KD_LOAD_SYMBOLS_STATE_CHANGE);
assert_eq!(stop.program_counter, pc);
assert!(stop_event(stop).modules_changed);
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
}
#[test]
fn pump_sends_breakin_when_started_in_reconnect_assist_mode() {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_secs(2)))
.unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
Some(Duration::ZERO),
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
let deadline = Instant::now() + Duration::from_secs(2);
let mut saw_breakin = false;
let mut buf = [0u8; 64];
while Instant::now() < deadline && !saw_breakin {
match kernel.read(&mut buf) {
Ok(0) => break,
Ok(n) => {
saw_breakin = buf[..n].contains(&BREAKIN_BYTE);
}
Err(e) if matches!(e.kind(), ErrorKind::WouldBlock | ErrorKind::TimedOut) => {}
Err(e) => panic!("failed to read pump output: {e}"),
}
}
assert!(
saw_breakin,
"post-bugcheck reconnect assist should not require a reset packet first"
);
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
assert!(
rx.try_recv().is_err(),
"assist alone should not report a stop"
);
}
#[test]
fn pump_does_not_send_delayed_reconnect_assist_before_delay() {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_millis(5)))
.unwrap();
let framing = KdFraming::new(host.into());
let (tx, _rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
Some(Duration::from_secs(60)),
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
let deadline = Instant::now() + Duration::from_millis(200);
let mut saw_breakin = false;
let mut buf = [0u8; 64];
while Instant::now() < deadline {
match kernel.read(&mut buf) {
Ok(0) => break,
Ok(n) => {
if buf[..n].contains(&BREAKIN_BYTE) {
saw_breakin = true;
break;
}
}
Err(e) if matches!(e.kind(), ErrorKind::WouldBlock | ErrorKind::TimedOut) => {}
Err(e) => panic!("failed to read pump output: {e}"),
}
}
assert!(
!saw_breakin,
"delayed post-bugcheck reconnect assist should not fire immediately"
);
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
}
#[test]
fn await_refresh_sets_flag_without_breakin() {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_millis(5)))
.unwrap();
let handle = spawn(move || {
let mut framing = KdFraming::new(host.into());
let mut saw_refresh = false;
let stop = await_state_change(
&mut framing,
AwaitStateOptions {
arch: Arch::Amd64,
saw_kd_refresh: Some(&mut saw_refresh),
surface_all: false,
bugcheck: None,
bugcheck_capture: None,
deadline: None,
debug_log: None,
},
)
.expect("await_state_change failed");
(saw_refresh, stop)
});
let refresh = debug_io_print_payload(KD_REFRESH_MESSAGE);
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_DEBUG_IO,
WIRE_FIRST_PACKET_ID,
&refresh,
))
.unwrap();
kernel.flush().unwrap();
let mut outbound = Vec::new();
let mut buf = [0u8; 64];
while outbound.len() < WIRE_HEADER_SIZE {
match kernel.read(&mut buf) {
Ok(0) => break,
Ok(n) => outbound.extend_from_slice(&buf[..n]),
Err(e) if matches!(e.kind(), ErrorKind::WouldBlock | ErrorKind::TimedOut) => {
break;
}
Err(e) => panic!("failed to read ACK: {e}"),
}
}
assert!(
outbound.len() >= WIRE_HEADER_SIZE,
"refresh packet should be ACKed"
);
assert!(
!outbound.contains(&BREAKIN_BYTE),
"refresh ACK should not include a break-in"
);
let immediate_window = Instant::now() + Duration::from_millis(30);
while Instant::now() < immediate_window {
match kernel.read(&mut buf) {
Ok(0) => break,
Ok(n) => {
assert!(
!buf[..n].contains(&BREAKIN_BYTE),
"plain KD refresh should not trigger an immediate break-in"
);
}
Err(e) if matches!(e.kind(), ErrorKind::WouldBlock | ErrorKind::TimedOut) => {
break;
}
Err(e) => panic!("failed to read post-refresh output: {e}"),
}
}
let pc = 0xfffff800_deadbeef;
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
WIRE_FIRST_PACKET_ID ^ 1,
&exception_state_change_payload(pc),
))
.unwrap();
kernel.flush().unwrap();
let (saw_refresh, stop) = handle.join().expect("await thread panicked");
assert!(saw_refresh);
assert_eq!(stop.program_counter, pc);
}
fn await_bugcheck_aware(prints: &[&[u8]], pc: u64) -> StateChange {
let (mut kernel, host) = UnixStream::pair().unwrap();
kernel
.set_read_timeout(Some(Duration::from_millis(20)))
.unwrap();
let handle = spawn(move || {
let mut framing = KdFraming::new(host.into());
let mut bugcheck = false;
let mut capture = BugcheckCapture::default();
await_state_change(
&mut framing,
AwaitStateOptions {
arch: Arch::Amd64,
saw_kd_refresh: None,
surface_all: false,
bugcheck: Some(&mut bugcheck),
bugcheck_capture: Some(&mut capture),
deadline: None,
debug_log: None,
},
)
.expect("await_state_change failed")
});
let mut packet_id = WIRE_FIRST_PACKET_ID;
let mut buf = [0u8; 128];
for text in prints {
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_DEBUG_IO,
packet_id,
&debug_io_print_payload(text),
))
.unwrap();
kernel.flush().unwrap();
let _ = kernel.read(&mut buf);
packet_id ^= 1;
}
kernel
.write_all(&wire_data_packet(
PACKET_TYPE_KD_STATE_CHANGE64,
packet_id,
&exception_state_change_payload(pc),
))
.unwrap();
kernel.flush().unwrap();
handle.join().expect("await thread panicked")
}
#[test]
fn refresh_print_alone_does_not_mark_the_next_stop_as_a_bugcheck() {
let stop = await_bugcheck_aware(&[KD_REFRESH_MESSAGE], 0xffff_f800_0000_1000);
assert!(!stop.is_bugcheck);
assert!(stop.bugcheck.is_none());
}
#[test]
fn fatal_system_error_print_marks_the_next_stop_with_captured_bugcheck() {
let stop = await_bugcheck_aware(
&[
KD_REFRESH_MESSAGE,
b"\r\n*** Fatal System Error: 0x000000d1\r\n (0x1,0x2,0x0,0x4)\r\n",
b"Driver at fault: myfault.sys.\r\n",
],
0xffff_f800_0000_1000,
);
assert!(stop.is_bugcheck);
let info = stop.bugcheck.expect("captured bugcheck");
assert_eq!(info.code, 0xd1);
assert_eq!(info.parameters, [1, 2, 0, 4]);
assert_eq!(info.driver.as_deref(), Some("myfault.sys"));
}
#[test]
fn only_exception_state_changes_surface_as_breaks() {
assert!(!is_transparent_state_change(DBG_KD_EXCEPTION_STATE_CHANGE));
assert!(!is_transparent_state_change(0xdead_beef));
assert!(is_transparent_state_change(
DBG_KD_LOAD_SYMBOLS_STATE_CHANGE
));
assert!(is_transparent_state_change(
DBG_KD_COMMAND_STRING_STATE_CHANGE
));
}
#[test]
fn pump_exits_on_shutdown_when_idle() {
let (_kernel, host) = UnixStream::pair().unwrap();
let framing = KdFraming::new(host.into());
let (tx, rx) = mpsc::channel();
let shutdown = Arc::new(AtomicBool::new(false));
let handle = {
let shutdown = Arc::clone(&shutdown);
spawn(move || {
run_pump(
framing,
Arch::Amd64,
PumpLink {
stop_tx: tx,
shutdown,
reported_stop: Arc::new(AtomicBool::new(false)),
},
None,
DebugLog::new(DEBUG_LOG_CAPACITY),
None,
)
})
};
shutdown.store(true, Ordering::SeqCst);
let _framing = handle.join().expect("pump thread panicked");
assert!(rx.try_recv().is_err(), "idle pump should report no stop");
}
}