symbolic-debuginfo 2.0.6

A library to inspect and load DWARF debugging information from binaries, such as Mach-O or ELF.
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

use goblin::mach;
use uuid::Uuid;

use symbolic_common::Result;

use object::ObjectId;

/// A segment inside a Mach object file containing multiple sections.
type MachSegment<'mach, 'data> = &'mach mach::segment::Segment<'data>;

/// A section inside a Mach object file.
pub struct MachSection<'data> {
    // The header struct.
    pub header: mach::segment::Section,
    // The raw data.
    pub data: &'data [u8],
}

/// Locates and reads a segment in a Mach object file.
pub fn find_mach_segment<'mach, 'data>(
    mach: &'mach mach::MachO<'data>,
    name: &str,
) -> Option<MachSegment<'mach, 'data>> {
    for segment in &mach.segments {
        if segment.name().map(|seg| seg == name).unwrap_or(false) {
            return Some(segment);
        }
    }

    None
}

/// Checks whether a Mach object file contains a segment.
///
/// This is useful to determine whether the object contains certain information
/// without iterating over all section headers and loading their data.
pub fn has_mach_segment(mach: &mach::MachO, name: &str) -> bool {
    find_mach_segment(mach, name).is_some()
}

/// Locates and reads a section in a Mach object file.
///
/// Depending on its name, the segment will be loaded from either the `"__TEXT"`
/// or the `"__DWARF"` segment.
pub fn find_mach_section<'data>(
    mach: &mach::MachO<'data>,
    name: &str,
) -> Option<MachSection<'data>> {
    let segment_name = match name {
        "__eh_frame" => "__TEXT",
        _ => "__DWARF",
    };

    let segment = match find_mach_segment(mach, segment_name) {
        Some(segment) => segment,
        None => return None,
    };

    for section in segment {
        if let Ok((header, data)) = section {
            if header.name().map(|sec| sec == name).unwrap_or(false) {
                return Some(MachSection { header, data });
            }
        }
    }

    None
}

/// Checks whether a Mach object file contains a section.
///
/// Depending on its name, the section will searched in the `"__TEXT"` or the
/// `"__DWARF"` segment. This is useful to determine whether the object contains
/// certain information without iterating over all section headers and loading
/// their data.
pub fn has_mach_section(mach: &mach::MachO, name: &str) -> bool {
    find_mach_section(mach, name).is_some()
}

/// Resolves the object identifier from Mach object load commands.
pub fn get_mach_id(macho: &mach::MachO) -> Option<ObjectId> {
    for cmd in &macho.load_commands {
        if let mach::load_command::CommandVariant::Uuid(ref uuid_cmd) = cmd.command {
            return Uuid::from_bytes(&uuid_cmd.uuid)
                .ok()
                .map(ObjectId::from_uuid);
        }
    }

    None
}

/// Loads the virtual memory address of this object's __TEXT (code) segment.
pub fn get_mach_vmaddr(macho: &mach::MachO) -> Result<u64> {
    for seg in &macho.segments {
        if seg.name()? == "__TEXT" {
            return Ok(seg.vmaddr);
        }
    }

    Ok(0)
}