1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
#![warn(missing_docs)]
//! Debugging support for probe-rs
//!
//! The `debug` module contains various debug functionality, which can be
//! used to implement a debugger based on `probe-rs`.
/// Debug information which is parsed from DWARF debugging information.
pub mod debug_info;
/// Stepping through a program during debug, at various granularities.
pub mod debug_step;
/// References to the DIE (debug information entry) of functions.
pub mod function_die;
/// Programming languages
pub(crate) mod language;
/// Target Register definitions, expanded from [`crate::core::registers::CoreRegister`] to include unwind specific information.
pub mod registers;
/// The source statement information used while identifying haltpoints for debug stepping and breakpoints.
pub(crate) mod source_instructions;
/// The stack frame information used while unwinding the stack from a specific program counter.
pub mod stack_frame;
/// Information about a Unit in the debug information.
pub mod unit_info;
/// Variable information used during debug.
pub mod variable;
/// The hierarchical cache of all variables for a given scope.
pub mod variable_cache;
pub use self::{
debug_info::*, debug_step::SteppingMode, registers::*, source_instructions::SourceLocation,
source_instructions::VerifiedBreakpoint, stack_frame::StackFrame, variable::*,
variable_cache::VariableCache,
};
use crate::{core::Core, MemoryInterface};
use gimli::DebuggingInformationEntry;
use typed_path::TypedPathBuf;
use std::{
io,
num::NonZeroU32,
str::Utf8Error,
sync::atomic::{AtomicU32, Ordering},
vec,
};
/// A simplified type alias of the [`gimli::EndianReader`] type.
pub type EndianReader = gimli::EndianReader<gimli::LittleEndian, std::rc::Rc<[u8]>>;
/// An error occurred while debugging the target.
#[derive(Debug, thiserror::Error)]
pub enum DebugError {
/// An IO error occurred when accessing debug data.
#[error("IO Error while accessing debug data")]
Io(#[from] io::Error),
/// An error occurred while accessing debug data.
#[error("Error accessing debug data")]
DebugData(#[from] object::read::Error),
/// Something failed while parsing debug data.
#[error("Error parsing debug data")]
Parse(#[from] gimli::read::Error),
/// Non-UTF8 data was found in the debug data.
#[error("Non-UTF8 data found in debug data")]
NonUtf8(#[from] Utf8Error),
/// A probe-rs error occurred.
#[error("Error using the probe")]
Probe(#[from] crate::Error),
/// A char could not be created from the given string.
#[error(transparent)]
CharConversion(#[from] std::char::CharTryFromError),
/// An int could not be created from the given string.
#[error(transparent)]
IntConversion(#[from] std::num::TryFromIntError),
/// Errors encountered while determining valid locations for memory addresses involved in actions like
/// setting breakpoints and/or stepping through source code.
/// These are distinct from other errors because they gracefully terminate the current action,
/// and result in a user message, but they do not interrupt the rest of the debug session.
#[error("{message} @program_counter={:#010X}.", pc_at_error)]
IncompleteDebugInfo {
/// A message that can be displayed to the user to help them make an informed recovery choice.
message: String,
/// The value of the program counter for which a halt was requested.
pc_at_error: u64,
},
/// Non-terminal Errors encountered while unwinding the stack, e.g. Could not resolve the value of a variable in the stack.
/// These are distinct from other errors because they do not interrupt processing.
/// Instead, the cause of incomplete results are reported back/explained to the user, and the stack continues to unwind.
#[error("{message}")]
UnwindIncompleteResults {
/// A message that can be displayed to the user to help them understand the reason for the incomplete results.
message: String,
},
/// Some other error occurred.
#[error(transparent)]
Other(#[from] anyhow::Error),
}
/// A copy of [`gimli::ColumnType`] which uses [`u64`] instead of [`NonZeroU64`](std::num::NonZeroU64).
#[derive(Debug, Copy, Clone, PartialEq, Eq, Serialize)]
pub enum ColumnType {
/// The `LeftEdge` means that the statement begins at the start of the new line.
LeftEdge,
/// A column number, whose range begins at 1.
Column(u64),
}
impl From<gimli::ColumnType> for ColumnType {
fn from(column: gimli::ColumnType) -> Self {
match column {
gimli::ColumnType::LeftEdge => ColumnType::LeftEdge,
gimli::ColumnType::Column(c) => ColumnType::Column(c.get()),
}
}
}
impl From<u64> for ColumnType {
fn from(column: u64) -> Self {
match column {
0 => ColumnType::LeftEdge,
_ => ColumnType::Column(column),
}
}
}
/// Object reference as defined in the DAP standard.
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq, Hash)]
pub enum ObjectRef {
/// Valid object reference (> 0)
Valid(NonZeroU32),
/// Invalid object reference (<= 0)
#[default]
Invalid,
}
impl PartialOrd for ObjectRef {
fn partial_cmp(&self, other: &ObjectRef) -> Option<std::cmp::Ordering> {
Some(self.cmp(other))
}
}
impl Ord for ObjectRef {
fn cmp(&self, other: &Self) -> std::cmp::Ordering {
i64::from(*self).cmp(&i64::from(*other))
}
}
impl From<ObjectRef> for i64 {
fn from(value: ObjectRef) -> Self {
match value {
ObjectRef::Valid(v) => v.get() as i64,
ObjectRef::Invalid => 0,
}
}
}
impl From<i64> for ObjectRef {
fn from(value: i64) -> Self {
if value < 0 {
ObjectRef::Invalid
} else {
match NonZeroU32::try_from(value as u32) {
Ok(v) => ObjectRef::Valid(v),
Err(_) => ObjectRef::Invalid,
}
}
}
}
impl std::str::FromStr for ObjectRef {
type Err = anyhow::Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let value = s.parse::<i64>()?;
Ok(ObjectRef::from(value))
}
}
static CACHE_KEY: AtomicU32 = AtomicU32::new(1);
/// Generate a unique key that can be used to assign id's to StackFrame and Variable structs.
pub fn get_object_reference() -> ObjectRef {
let key = CACHE_KEY.fetch_add(1, Ordering::SeqCst);
ObjectRef::Valid(NonZeroU32::new(key).unwrap())
}
/// If file information is available, it returns `Some(directory:PathBuf, file_name:String)`, otherwise `None`.
fn extract_file(
debug_info: &DebugInfo,
unit: &gimli::Unit<GimliReader>,
attribute_value: gimli::AttributeValue<GimliReader>,
) -> Option<(TypedPathBuf, String)> {
match attribute_value {
gimli::AttributeValue::FileIndex(index) => unit.line_program.as_ref().and_then(|ilnp| {
let header = ilnp.header();
if let Some(file_entry) = header.file(index) {
if let Some((Some(path), Some(file))) = debug_info
.find_file_and_directory(unit, header, file_entry)
.map(|(file, path)| (path, file))
{
Some((path, file))
} else {
tracing::warn!("Unable to extract file or path from {:?}.", attribute_value);
None
}
} else {
tracing::warn!("Unable to extract file entry for {:?}.", attribute_value);
None
}
}),
other => {
tracing::warn!(
"Unable to extract file information from attribute value {:?}: Not implemented.",
other
);
None
}
}
}
/// If a DW_AT_byte_size attribute exists, return the u64 value, otherwise (including errors) return None
fn extract_byte_size(node_die: &DebuggingInformationEntry<GimliReader>) -> Option<u64> {
match node_die.attr(gimli::DW_AT_byte_size) {
Ok(optional_byte_size_attr) => match optional_byte_size_attr {
Some(byte_size_attr) => match byte_size_attr.value() {
gimli::AttributeValue::Udata(byte_size) => Some(byte_size),
gimli::AttributeValue::Data1(byte_size) => Some(byte_size as u64),
gimli::AttributeValue::Data2(byte_size) => Some(byte_size as u64),
gimli::AttributeValue::Data4(byte_size) => Some(byte_size as u64),
gimli::AttributeValue::Data8(byte_size) => Some(byte_size),
other => {
tracing::warn!("Unimplemented: DW_AT_byte_size value: {:?} ", other);
None
}
},
None => None,
},
Err(error) => {
tracing::warn!(
"Failed to extract byte_size: {:?} for debug_entry {:?}",
error,
node_die.tag().static_string()
);
None
}
}
}
fn extract_line(attribute_value: gimli::AttributeValue<GimliReader>) -> Option<u64> {
match attribute_value {
gimli::AttributeValue::Udata(line) => Some(line),
_ => None,
}
}
#[allow(clippy::unwrap_used, clippy::expect_used)]
pub(crate) fn _print_all_attributes(
core: &mut Core<'_>,
stackframe_cfa: Option<u64>,
dwarf: &gimli::Dwarf<DwarfReader>,
unit: &gimli::Unit<DwarfReader>,
tag: &gimli::DebuggingInformationEntry<DwarfReader>,
print_depth: usize,
) {
let mut attrs = tag.attrs();
while let Some(attr) = attrs.next().unwrap() {
for _ in 0..(print_depth) {
print!("\t");
}
print!("{}: ", attr.name());
use gimli::AttributeValue::*;
match attr.value() {
Addr(a) => println!("{a:#010x}"),
DebugStrRef(_) => {
let val = dwarf.attr_string(unit, attr.value()).unwrap();
println!("{}", std::str::from_utf8(&val).unwrap());
}
Exprloc(e) => {
let mut evaluation = e.evaluation(unit.encoding());
// go for evaluation
let mut result = evaluation.evaluate().unwrap();
loop {
use gimli::EvaluationResult::*;
result = match result {
Complete => break,
RequiresMemory { address, size, .. } => {
let mut buff = vec![0u8; size as usize];
core.read(address, &mut buff)
.expect("Failed to read memory");
match size {
1 => evaluation
.resume_with_memory(gimli::Value::U8(buff[0]))
.unwrap(),
2 => {
let val = u16::from(buff[0]) << 8 | u16::from(buff[1]);
evaluation
.resume_with_memory(gimli::Value::U16(val))
.unwrap()
}
4 => {
let val = u32::from(buff[0]) << 24
| u32::from(buff[1]) << 16
| u32::from(buff[2]) << 8
| u32::from(buff[3]);
evaluation
.resume_with_memory(gimli::Value::U32(val))
.unwrap()
}
x => {
tracing::error!(
"Requested memory with size {}, which is not supported yet.",
x
);
unimplemented!();
}
}
}
RequiresFrameBase => evaluation
.resume_with_frame_base(stackframe_cfa.unwrap())
.unwrap(),
RequiresRegister {
register,
base_type,
} => {
let raw_value: u64 = core
.read_core_reg(register.0)
.expect("Failed to read memory");
if base_type != gimli::UnitOffset(0) {
unimplemented!(
"Support for units in RequiresRegister request is not yet implemented."
)
}
evaluation
.resume_with_register(gimli::Value::Generic(raw_value))
.unwrap()
}
RequiresRelocatedAddress(address_index) => {
// Use the address_index as an offset from 0, so just pass it into the next step.
evaluation
.resume_with_relocated_address(address_index)
.unwrap()
}
x => {
println!("print_all_attributes {x:?}");
// x
todo!()
}
}
}
let result = evaluation.result();
println!("Expression: {:x?}", &result[0]);
}
LocationListsRef(_) => {
println!("LocationList");
}
DebugLocListsBase(_) => {
println!(" LocationList");
}
DebugLocListsIndex(_) => {
println!(" LocationList");
}
_ => {
println!("print_all_attributes {:?}", attr.value());
}
}
}
}