lief 1.0.0

Official Rust bindings for LIEF
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

use lief_ffi as ffi;

use crate::common::{FromFFI, into_optional};
use crate::dwarf::function::Function;
use crate::dwarf::types::Type;
use crate::dwarf::variable::Variable;
use crate::generic;
use std::marker::PhantomData;

use super::compilation_unit::CompilationUnits;

/// This class represents a DWARF debug information. It can embed different
/// compilation units which can be accessed through [`DebugInfo::compilation_units`].
///
/// This class can be instantiated from [`crate::generic::Binary::debug_info`] or using the
/// function [`crate::dwarf::load`]
pub struct DebugInfo<'a> {
    ptr: cxx::UniquePtr<ffi::DWARF_DebugInfo>,
    _owner: PhantomData<&'a ()>,
}

impl FromFFI<ffi::DWARF_DebugInfo> for DebugInfo<'_> {
    fn from_ffi(info: cxx::UniquePtr<ffi::DWARF_DebugInfo>) -> Self {
        Self {
            ptr: info,
            _owner: PhantomData,
        }
    }
}

impl DebugInfo<'_> {
    /// Iterator on the [`crate::dwarf::CompilationUnit`] embedded in this dwarf
    pub fn compilation_units(&self) -> CompilationUnits<'_> {
        CompilationUnits::new(self.ptr.compilation_units())
    }

    /// Try to find the function with the given name (mangled or not)
    ///
    /// ```
    /// if let Some(func) = info.function_by_name("_ZNSt6localeD1Ev") {
    ///     // Found
    /// }
    /// if let Some(func) = info.function_by_name("std::locale::~locale()") {
    ///     // Found
    /// }
    /// ```
    pub fn function_by_name(&self, name: &str) -> Option<Function<'_>> {
        cxx::let_cxx_string!(__cxx_s = name);
        into_optional(self.ptr.function_by_name(&__cxx_s))
    }

    /// Try to find the function at the given **virtual** address
    pub fn function_by_addr(&self, addr: u64) -> Option<Function<'_>> {
        into_optional(self.ptr.function_by_addr(addr))
    }

    /// Try to find the variable with the given name. This name can be mangled or
    /// not.
    pub fn variable_by_name(&self, name: &str) -> Option<Variable<'_>> {
        cxx::let_cxx_string!(__cxx_s = name);
        into_optional(self.ptr.variable_by_name(&__cxx_s))
    }

    /// Try to find the (static) variable at the given **virtual** address
    pub fn variable_by_addr(&self, addr: u64) -> Option<Variable<'_>> {
        into_optional(self.ptr.variable_by_addr(addr))
    }

    /// Try to find the (static) variable at the given **virtual** address
    pub fn type_by_name(&self, name: &str) -> Option<Type<'_>> {
        cxx::let_cxx_string!(__cxx_s = name);
        into_optional(self.ptr.type_by_name(&__cxx_s))
    }
}

impl generic::DebugInfo for DebugInfo<'_> {
    fn as_generic(&self) -> &ffi::AbstracDebugInfo {
        self.ptr.as_ref().unwrap().as_ref()
    }
}