summaryrefslogtreecommitdiff
path: root/plugins/dwarf/shared/src/lib.rs
blob: d4531938450d4da9dce7a2a3ca37823e6c40756a (plain)
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
// Copyright 2021-2026 Vector 35 Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use gimli::{EndianRcSlice, Endianity, RunTimeEndian, SectionId};
use object::{Object, ObjectSection};

use binaryninja::{
    binary_view::{BinaryView, BinaryViewBase},
    settings::Settings,
    Endianness,
};

use binaryninja::settings::QueryOptions;
use std::rc::Rc;
//////////////////////
// Dwarf Validation

#[derive(thiserror::Error, Debug)]
pub enum Error {
    #[error("unknown section compression method {0:#x}")]
    UnknownCompressionMethod(u32),

    #[error("{0}")]
    GimliError(#[from] gimli::Error),

    #[error("{0}")]
    IoError(#[from] std::io::Error),

    #[error("{0}")]
    ObjectError(#[from] object::Error),
}

pub fn is_non_dwo_dwarf(view: &BinaryView) -> bool {
    view.section_by_name(".debug_info").is_some() || view.section_by_name("__debug_info").is_some()
}

pub fn is_dwo_dwarf(view: &BinaryView) -> bool {
    view.section_by_name(".debug_info.dwo").is_some()
}

pub fn is_raw_non_dwo_dwarf(view: &BinaryView) -> bool {
    if let Some(raw_view) = view.raw_view() {
        raw_view.section_by_name(".debug_info").is_some()
            || view.section_by_name("__debug_info").is_some()
    } else {
        false
    }
}

pub fn is_raw_dwo_dwarf(view: &BinaryView) -> bool {
    if let Some(raw_view) = view.raw_view() {
        raw_view.section_by_name(".debug_info.dwo").is_some()
    } else {
        false
    }
}

pub fn can_use_debuginfod(view: &BinaryView) -> bool {
    let mut query_options = QueryOptions::new_with_view(view);
    has_build_id_section(view)
        && Settings::new().get_bool_with_opts("network.enableDebuginfod", &mut query_options)
}

pub fn has_build_id_section(view: &BinaryView) -> bool {
    if let Some(raw_view) = view.raw_view() {
        return raw_view.section_by_name(".note.gnu.build-id").is_some();
    }
    false
}

pub fn is_valid(view: &BinaryView) -> bool {
    is_non_dwo_dwarf(view)
        || is_raw_non_dwo_dwarf(view)
        || is_dwo_dwarf(view)
        || is_raw_dwo_dwarf(view)
}

pub fn get_endian(view: &BinaryView) -> RunTimeEndian {
    match view.default_endianness() {
        Endianness::LittleEndian => RunTimeEndian::Little,
        Endianness::BigEndian => RunTimeEndian::Big,
    }
}

pub fn create_section_reader<Endian: Endianity>(
    section_id: SectionId,
    view: &BinaryView,
    endian: Endian,
    is_dwo: bool,
) -> Result<RelocateOwned<gimli::EndianRcSlice<Endian>>, Error> {
    let raw_view = view.raw_view().unwrap();
    let view_data = raw_view.read_vec(0, raw_view.len() as usize);
    let file = object::File::parse(&*view_data)?;
    create_section_reader_object(section_id, &file, endian, is_dwo)
}

#[derive(Debug, Clone)]
pub struct RelocationMap(Rc<object::read::RelocationMap>);

impl Default for RelocationMap {
    fn default() -> Self {
        Self(Rc::new(object::read::RelocationMap::default()))
    }
}

impl RelocationMap {
    fn add(&mut self, file: &object::File, section: &object::Section) -> Result<(), Error> {
        let map =
            Rc::get_mut(&mut self.0).expect("Failed to get mutable reference to RelocationMap");
        for (offset, relocation) in section.relocations() {
            map.add(file, offset, relocation)?
        }
        Ok(())
    }
}

impl gimli::read::Relocate for RelocationMap {
    fn relocate_address(&self, offset: usize, value: u64) -> gimli::Result<u64> {
        Ok(self.0.relocate(offset as u64, value))
    }

    fn relocate_offset(&self, offset: usize, value: usize) -> gimli::Result<usize> {
        <usize as gimli::ReaderOffset>::from_u64(self.0.relocate(offset as u64, value as u64))
    }
}

type RelocateOwned<R> = gimli::RelocateReader<R, RelocationMap>;

pub fn create_section_reader_object<Endian: gimli::Endianity>(
    id: gimli::SectionId,
    file: &object::File,
    endian: Endian,
    is_dwo: bool,
) -> Result<RelocateOwned<gimli::EndianRcSlice<Endian>>, Error> {
    let mut relocations = RelocationMap::default();
    let name = if is_dwo {
        id.dwo_name()
    } else if file.format() == object::BinaryFormat::Xcoff {
        id.xcoff_name()
    } else {
        Some(id.name())
    };
    let data = match name.and_then(|name| file.section_by_name(name)) {
        Some(ref section) => {
            // DWO sections never have relocations, so don't bother.
            if !is_dwo {
                relocations.add(file, section)?;
            }
            section.uncompressed_data()?.into_owned()
        }
        // Use a non-zero capacity so that `ReaderOffsetId`s are unique.
        None => Vec::with_capacity(1),
    };
    let section = EndianRcSlice::new(Rc::from(data.into_boxed_slice()), endian);
    Ok(gimli::RelocateReader::new(section, relocations))
}