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
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

//! DWARF tree navigation and traversal functions

use gimli::UnitSectionOffset;
use itertools::Itertools;

use super::{
    unit::{get_unit_ref, UnitRef},
    utils::{file_entry_to_path, get_dwarf, to_range},
    CompilationUnitId,
};
use crate::{
    file::{DebugFile, SourceFile},
    DwarfDb,
};

/// Root compilation unit information
#[salsa::tracked]
pub struct Root<'db> {
    pub cu: CompilationUnitId<'db>,
    pub address_range: (u64, u64),
    #[returns(ref)]
    pub files: Vec<SourceFile<'db>>,
}

/// Get all root compilation units from a file
pub fn get_roots<'db>(
    db: &'db dyn DwarfDb,
    file: DebugFile,
) -> Vec<(UnitSectionOffset, UnitRef<'db>)> {
    let Some(dwarf) = get_dwarf(db, file.file(db)) else {
        return Default::default();
    };

    let mut roots = vec![];
    let mut units = dwarf.units();
    loop {
        let header = match units.next() {
            Ok(Some(header)) => header,
            Ok(None) => break,
            Err(e) => {
                tracing::error!("Failed to parse unit: {e}");
                continue;
            }
        };
        let cu_offset = header.offset();
        let unit_ref = match get_unit_ref(db, file, cu_offset) {
            Some(unit_ref) => unit_ref,
            None => continue,
        };
        roots.push((cu_offset, unit_ref));
    }

    roots
}

/// Parse root compilation units with their metadata
#[salsa::tracked]
pub fn parse_roots<'db>(db: &'db dyn DwarfDb, file: DebugFile) -> Vec<Root<'db>> {
    let Some(dwarf) = get_dwarf(db, file.file(db)) else {
        return Default::default();
    };

    let mut roots = vec![];

    let mut units = dwarf.units();
    loop {
        let header = match units.next() {
            Ok(Some(header)) => header,
            Ok(None) => break,
            Err(e) => {
                tracing::error!("Failed to parse unit: {e}");
                continue;
            }
        };
        let cu_offset = header.offset();
        let Some(unit_ref) = get_unit_ref(db, file, cu_offset) else {
            continue;
        };
        let addr_range = match unit_ref
            .unit_ranges()
            .map_err(anyhow::Error::from)
            .and_then(to_range)
        {
            Ok(Some(res)) => res,
            Ok(None) => {
                continue;
            }
            Err(e) => {
                tracing::error!("Failed to parse ranges for compilation unit: {e}");
                continue;
            }
        };
        let die = CompilationUnitId::new(db, file, cu_offset);

        let referenced_files = unit_ref
            .line_program
            .as_ref()
            .map(|lp| {
                lp.header()
                    .file_names()
                    .iter()
                    .flat_map(|f| {
                        let path = file_entry_to_path(db, f, &unit_ref)?;
                        Some(SourceFile::new(db, path))
                    })
                    .collect_vec()
            })
            .unwrap_or_default();

        roots.push(Root::new(db, die, addr_range, referenced_files));
    }

    roots
}