elf_loader 0.17.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

use crate::{
    arch::NativeArch,
    image::{LocalScope, RawDynamic},
    memory::{HostRegion, RegionAccess},
    relocation::{BindingMode, LookupOrder, RelocationArch},
    tls::TlsResolver,
};

/// Mutable event for one module's relocation policy.
pub struct LinkerRelocationEvent<
    D: Send + Sync + 'static,
    Arch: RelocationArch = NativeArch,
    R: RegionAccess = HostRegion,
    Tls: TlsResolver<Arch> = (),
> {
    raw: RawDynamic<D, Arch, R, Tls>,
    scope: LocalScope<Arch, Tls>,
    binding: BindingMode,
    lookup_order: LookupOrder,
}

impl<D: Send + Sync + 'static, Arch, R, Tls> LinkerRelocationEvent<D, Arch, R, Tls>
where
    Arch: RelocationArch,
    R: RegionAccess,
    Tls: TlsResolver<Arch>,
{
    #[inline]
    pub(crate) fn new(
        raw: RawDynamic<D, Arch, R, Tls>,
        scope: LocalScope<Arch, Tls>,
        lookup_order: LookupOrder,
    ) -> Self {
        Self {
            raw,
            scope,
            binding: BindingMode::Default,
            lookup_order,
        }
    }

    /// Returns the loaded image that is about to be relocated.
    #[inline]
    pub const fn raw(&self) -> &RawDynamic<D, Arch, R, Tls> {
        &self.raw
    }

    /// Returns the module's lookup scope for this relocation.
    ///
    /// Linker-global modules participate in relocation separately and are not
    /// retained by this scope.
    #[inline]
    pub const fn scope(&self) -> &LocalScope<Arch, Tls> {
        &self.scope
    }

    /// Returns the mutable lookup scope used to relocate this module.
    ///
    /// Linker-global modules are managed separately and are not part of this
    /// scope.
    #[inline]
    pub const fn scope_mut(&mut self) -> &mut LocalScope<Arch, Tls> {
        &mut self.scope
    }

    /// Returns the symbol-binding policy selected for this module.
    #[inline]
    pub const fn binding(&self) -> BindingMode {
        self.binding
    }

    /// Replaces the symbol-binding policy used for this module.
    #[inline]
    pub fn set_binding(&mut self, binding: BindingMode) {
        self.binding = binding;
    }

    /// Returns precedence between local and context-global symbol scopes.
    #[inline]
    pub const fn lookup_order(&self) -> LookupOrder {
        self.lookup_order
    }

    /// Replaces precedence between local and context-global symbol scopes.
    #[inline]
    pub fn set_lookup_order(&mut self, order: LookupOrder) {
        self.lookup_order = order;
    }

    #[inline]
    pub(crate) fn into_parts(
        self,
    ) -> (
        RawDynamic<D, Arch, R, Tls>,
        LocalScope<Arch, Tls>,
        BindingMode,
        LookupOrder,
    ) {
        (self.raw, self.scope, self.binding, self.lookup_order)
    }
}