rudy-db 0.0.10

A user-friendly library for interacting with debugging information of Rust compiled artifacts using DWARF
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

//! Query functions for looking up debug information

use rudy_dwarf::{Binary, SymbolName};

use crate::{
    database::Db,
    index::{self, find_all_by_address},
};

#[salsa::tracked]
pub fn lookup_position(
    db: &dyn Db,
    binary: Binary,
    query: rudy_dwarf::file::SourceLocation,
) -> Option<u64> {
    let file = &query.file;

    // find compilation units that cover the provided file
    let index = index::debug_index(db, binary);
    let symbol_index = index.symbol_index(db);
    let source_to_file = index.source_to_file(db);

    let mut closest_match: Option<u64> = None;
    let mut closest_line = u64::MAX;

    // find closest match to this line + column within the files
    for debug_file in source_to_file.get(file)? {
        let Some(function_index) = symbol_index.function_index(db, *debug_file) else {
            continue;
        };
        // let Some(base_addr) = index.data(db).cu_to_base_addr.get(cu).copied() else {
        //     tracing::debug!("no base address found for {cu:?}");
        //     continue;
        // };
        // tracing::debug!("looking for matches in {cu:?}");
        if let Some((addr, distance)) = function_index.location_to_address(db, *debug_file, &query)
        {
            tracing::debug!("found match  {addr:#x} at distance {distance}");
            if distance < closest_line {
                tracing::debug!(
                    "found closest match at {addr:#x} for address {addr:#x} in file {debug_file:?}"
                );
                closest_match = Some(addr);
                closest_line = distance;
            }
            if distance == 0 {
                // we found an exact match, so we can stop
                break;
            }
        }
    }

    // return the address
    closest_match
}

#[tracing::instrument(skip_all, fields(binary=binary.name(db), address=address))]
#[salsa::tracked]
pub fn lookup_address<'db>(
    db: &'db dyn Db,
    binary: Binary,
    address: u64,
) -> Option<(SymbolName, rudy_dwarf::file::SourceLocation)> {
    let mut results = find_all_by_address(db, binary, address);

    if results.len() > 1 {
        tracing::warn!(
            "Multiple results found for address {address:#x} in binary {binary:?}. Returning the first result."
        );
    }
    // pop a single result off
    // TODO: handle multiple results better
    results.pop()
}