elf_loader 0.16.0

A no_std-friendly ELF loader and runtime linker for Rust.
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
115
116
117

use crate::{
    arch::NativeArch,
    elf::{ElfHeader, ElfLayout, ElfPhdr, ElfProgramType, NativeElfLayout},
    image::RawDynamic,
    input::{ElfReader, Path},
    memory::{HostRegion, RegionAccess},
    relocation::RelocationArch,
    tls::TlsResolver,
};

/// Event emitted after ELF program headers are available and before `PT_LOAD`
/// segments are mapped.
pub struct BeforeLoadEvent<'a, D: 'static, L: ElfLayout = NativeElfLayout> {
    path: &'a Path,
    reader: &'a dyn ElfReader,
    ehdr: &'a ElfHeader<L>,
    phdrs: &'a [ElfPhdr<L>],
    user_data: &'a mut D,
}

impl<'a, D: 'static, L: ElfLayout> BeforeLoadEvent<'a, D, L> {
    #[inline]
    pub(crate) const fn new(
        path: &'a Path,
        reader: &'a dyn ElfReader,
        ehdr: &'a ElfHeader<L>,
        phdrs: &'a [ElfPhdr<L>],
        user_data: &'a mut D,
    ) -> Self {
        Self {
            path,
            reader,
            ehdr,
            phdrs,
            user_data,
        }
    }

    /// Returns the loader source path or caller-provided source identifier.
    #[inline]
    pub const fn path(&self) -> &Path {
        self.path
    }

    /// Returns the ELF reader for the source object.
    #[inline]
    pub const fn reader(&self) -> &dyn ElfReader {
        self.reader
    }

    /// Returns the parsed ELF header.
    #[inline]
    pub const fn ehdr(&self) -> &ElfHeader<L> {
        self.ehdr
    }

    /// Returns the parsed program headers.
    #[inline]
    pub const fn phdrs(&self) -> &[ElfPhdr<L>] {
        self.phdrs
    }

    /// Returns whether the program headers contain `PT_DYNAMIC`.
    #[inline]
    pub fn is_dynamic(&self) -> bool {
        self.phdrs
            .iter()
            .any(|phdr| phdr.program_type() == ElfProgramType::DYNAMIC)
    }

    /// Returns immutable user data for this image.
    #[inline]
    pub const fn user_data(&self) -> &D {
        self.user_data
    }

    /// Returns mutable user data for this image.
    #[inline]
    pub fn user_data_mut(&mut self) -> &mut D {
        self.user_data
    }
}

/// Event emitted after a dynamic image has been mapped and parsed, before relocation.
pub struct AfterDynamicLoadEvent<
    'a,
    D: 'static,
    Arch: RelocationArch = NativeArch,
    R: RegionAccess = HostRegion,
    Tls: TlsResolver<Arch> = (),
> {
    raw: &'a mut RawDynamic<D, Arch, R, Tls>,
}

impl<'a, D: 'static, Arch, R, Tls> AfterDynamicLoadEvent<'a, D, Arch, R, Tls>
where
    Arch: RelocationArch,
    R: RegionAccess,
    Tls: TlsResolver<Arch>,
{
    #[inline]
    pub(crate) const fn new(raw: &'a mut RawDynamic<D, Arch, R, Tls>) -> Self {
        Self { raw }
    }

    /// Returns the dynamic image.
    #[inline]
    pub const fn raw(&self) -> &RawDynamic<D, Arch, R, Tls> {
        self.raw
    }

    /// Returns the mutable dynamic image.
    #[inline]
    pub fn raw_mut(&mut self) -> &mut RawDynamic<D, Arch, R, Tls> {
        self.raw
    }
}