rudy-dwarf 0.2.0

DWARF debug information parsing and querying for Rust debugging tools
Documentation 
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

//! DWARF debug information parsing and querying
//!
//! This crate provides functionality for parsing DWARF debug information
//! from object files and querying it through a salsa database.

// Public modules - clean API for users
pub mod address;
pub mod die;
pub mod error;
pub mod expressions;
pub mod file;
pub mod function;
pub mod modules;
pub mod parser;
pub mod symbols;
pub mod types;
pub mod visitor;

// Test utilities
#[cfg(test)]
pub mod test_utils;

// Essential re-exports for convenience
use std::path::{Path, PathBuf};

// Core types that most users will need
pub use die::Die;
pub use error::Error;
pub use file::{Binary, DebugFile, SourceFile};
pub use gimli;
pub use symbols::{SymbolName, TypeName};
pub use types::{find_type_by_name, get_die_typename};

// Database trait that this crate requires
#[salsa::db]
pub trait DwarfDb: salsa::Database {
    /// Get source path remapping
    fn remap_path(&self, path: &Path) -> PathBuf {
        let mut path = path.to_path_buf();
        for (source, target) in self.get_source_map() {
            if let Ok(stripped) = path.strip_prefix(source) {
                tracing::debug!(
                    "Remapping {} from {} to {}",
                    path.display(),
                    source.display(),
                    target.display()
                );
                path = target.join(stripped);
            }
        }
        path
    }

    /// Get the source map for path remapping
    fn get_source_map(&self) -> &[(PathBuf, PathBuf)];
}