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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
//! Address conversion and derived tables for an [`ElfImage`].
//!
//! ELF has no relative virtual address. This module uses the image-relative
//! offset `ioff = vaddr - image_base` as the direct analog of a PE relative
//! virtual address.
use alloc::vec::Vec;
use crate::dynamic::DynamicTable;
use crate::error::Result;
use crate::header::Machine;
use crate::notes::{NT_GNU_BUILD_ID, Note};
use crate::program::{Segment, SegmentType};
use crate::reloc::RelocationSection;
use crate::section::SectionType;
use crate::symbol::SymbolTable;
use crate::tls::TlsInfo;
use super::ElfImage;
impl ElfImage {
/// Returns the raw `e_entry` value.
///
/// The value is a preferred-base virtual address, not an offset.
#[must_use]
pub const fn entry_point(&self) -> u64 {
self.header.entry
}
/// Tests whether the image uses the 64-bit ELF class.
#[must_use]
pub const fn is_64bit(&self) -> bool {
self.ident.class.is_64bit()
}
/// Returns the machine architecture.
#[must_use]
pub const fn machine(&self) -> Machine {
self.header.machine
}
/// Returns the preferred image base.
///
/// The base is the minimum `PT_LOAD` virtual address rounded down to the
/// segment page size. Position-independent objects normally report zero.
#[must_use]
pub fn image_base(&self) -> u64 {
self.geometry().base
}
/// Returns the mapped size of the image.
///
/// The span is the highest `PT_LOAD` end rounded up to the page size,
/// relative to the preferred image base.
#[must_use]
pub fn image_span(&self) -> u64 {
self.geometry().span
}
/// Returns the address geometry derived from the loadable segments.
fn geometry(&self) -> super::ImageGeometry {
super::geometry(load_records(&self.segments))
}
/// Returns the base address this image instance uses.
#[must_use]
pub const fn runtime_image_base(&self) -> u64 {
self.runtime_base
}
/// Sets the base address this image instance uses.
pub fn set_runtime_image_base(&mut self, base: u64) {
self.runtime_base = base;
}
/// Converts an image-relative offset to its serialized file offset.
///
/// Returns `None` when the offset has no file-backed byte.
#[must_use]
pub fn ioff_to_offset(&self, ioff: u64) -> Option<u64> {
let vaddr = self.image_base().checked_add(ioff)?;
let segment = self.segments.iter().find(|segment| {
segment.header.r#type.0 == SegmentType::LOAD.0
&& vaddr >= segment.header.vaddr
&& vaddr < segment.header.vaddr.saturating_add(segment.header.filesz)
})?;
segment
.header
.offset
.checked_add(vaddr - segment.header.vaddr)
}
/// Returns the loadable segment that covers an image-relative offset.
#[must_use]
pub fn segment_by_ioff(&self, ioff: u64) -> Option<&Segment> {
let vaddr = self.image_base().checked_add(ioff)?;
self.segments
.iter()
.find(|segment| segment.contains_vaddr(vaddr))
}
/// Reads up to `len` bytes at an image-relative offset into owned storage.
///
/// Bytes beyond the segment's file data but inside its memory size read as
/// zero, matching loader semantics.
#[must_use]
pub fn read_ioff(&self, ioff: u64, len: usize) -> Option<Vec<u8>> {
let vaddr = self.image_base().checked_add(ioff)?;
self.read_at_vaddr(vaddr, len)
}
/// Returns up to `len` bytes at an image-relative offset.
///
/// The slice stops at the segment's file data. Zero-filled tail bytes have
/// no slice representation; use [`ElfImage::read_ioff`] for them.
#[must_use]
pub fn read_at_ioff(&self, ioff: u64, len: usize) -> Option<&[u8]> {
let segment = self.segment_by_ioff(ioff)?;
let vaddr = self.image_base() + ioff;
segment.data_at_vaddr(vaddr, len)
}
/// Tests whether an image-relative range lies inside the image.
#[must_use]
pub fn contains_ioff_range(&self, ioff: u64, len: u64) -> bool {
match ioff.checked_add(len) {
Some(end) => end <= self.image_span(),
None => false,
}
}
/// Parses the dynamic table from the `PT_DYNAMIC` segment.
///
/// Returns `None` when the image declares no dynamic segment.
///
/// # Errors
///
/// Returns [`crate::Error`] when the dynamic segment cannot be decoded.
pub fn dynamic(&self) -> Result<Option<DynamicTable>> {
let Some(segment) = self
.segments
.iter()
.find(|segment| segment.header.r#type.0 == SegmentType::DYNAMIC.0)
else {
return Ok(None);
};
let table = DynamicTable::parse(&segment.data, self.ident.data, self.ident.class)?;
Ok(Some(table))
}
/// Parses the dynamic symbol table from `.dynsym` and `.dynstr`.
///
/// Returns an empty table when the sections are absent.
///
/// # Errors
///
/// Returns [`crate::Error`] when a present table cannot be decoded.
pub fn dynamic_symbols(&self) -> Result<SymbolTable> {
self.symbols_from(".dynsym", ".dynstr")
}
/// Parses the full symbol table from `.symtab` and `.strtab`.
///
/// Returns an empty table when the sections are absent.
///
/// # Errors
///
/// Returns [`crate::Error`] when a present table cannot be decoded.
pub fn symbols(&self) -> Result<SymbolTable> {
self.symbols_from(".symtab", ".strtab")
}
/// Parses every relocation section in the image.
///
/// # Errors
///
/// Returns [`crate::Error`] when a relocation section cannot be decoded.
pub fn relocations(&self) -> Result<Vec<RelocationSection>> {
let mut tables = Vec::new();
for section in &self.sections {
let is_rela = match section.header.r#type.0 {
value if value == SectionType::RELA.0 => true,
value if value == SectionType::REL.0 => false,
_ => continue,
};
tables.push(RelocationSection::parse(
§ion.data,
is_rela,
self.ident.data,
self.ident.class,
)?);
}
Ok(tables)
}
/// Parses every note in the object.
///
/// Notes are read from `PT_NOTE` segments, the authoritative runtime view.
/// An object with no `PT_NOTE` segment — an unlinked relocatable object,
/// for instance — is read from its `SHT_NOTE` sections instead. In a
/// linked object the two views describe the same bytes, so only one is
/// used and no note is reported twice.
///
/// # Errors
///
/// Returns [`crate::Error`] when a note cannot be decoded.
pub fn notes(&self) -> Result<Vec<Note>> {
let mut notes = Vec::new();
let mapped = self
.segments
.iter()
.any(|segment| segment.header.r#type.0 == SegmentType::NOTE.0);
if mapped {
for segment in &self.segments {
if segment.header.r#type.0 == SegmentType::NOTE.0 {
notes.extend(Note::parse_all(&segment.data, self.ident.data)?);
}
}
} else {
for section in &self.sections {
if section.header.r#type.0 == SectionType::NOTE.0 {
notes.extend(Note::parse_all(§ion.data, self.ident.data)?);
}
}
}
Ok(notes)
}
/// Returns the GNU build identifier when a build-id note exists.
///
/// # Errors
///
/// Returns [`crate::Error`] when a note cannot be decoded.
pub fn build_id(&self) -> Result<Option<Vec<u8>>> {
Ok(self
.notes()?
.into_iter()
.find(|note| note.is_gnu(NT_GNU_BUILD_ID))
.map(|note| note.descriptor))
}
/// Returns thread-local storage metadata from the `PT_TLS` segment.
#[must_use]
pub fn tls(&self) -> Option<TlsInfo> {
self.segments
.iter()
.find(|segment| segment.header.r#type.0 == SegmentType::TLS.0)
.map(|segment| TlsInfo::from_header(&segment.header))
}
/// Returns the names of every shared object this image depends on.
///
/// This is a convenience wrapper that parses the dynamic table and
/// resolves `DT_NEEDED` entries through the `.dynstr` string table.
/// Returns an empty list when there is no dynamic segment or no
/// string table.
///
/// # Errors
///
/// Returns [`crate::Error`] when the dynamic segment cannot be decoded.
pub fn needed_libraries(&self) -> Result<Vec<alloc::string::String>> {
let Some(dynamic) = self.dynamic()? else {
return Ok(Vec::new());
};
let strtab_bytes = self
.section_by_name(".dynstr")
.map(|section| §ion.data[..])
.unwrap_or(&[]);
let strtab = crate::strtab::StringTable::new(strtab_bytes);
Ok(dynamic.needed(strtab))
}
/// Returns the defined global and weak symbols from the dynamic symbol
/// table.
///
/// These are the symbols this image makes available to other shared
/// objects — the ELF analog of a PE export table. Undefined symbols
/// (`shndx == 0`) and local symbols are excluded.
///
/// # Errors
///
/// Returns [`crate::Error`] when the dynamic symbol table cannot be
/// decoded.
pub fn exports(&self) -> Result<Vec<crate::symbol::Symbol>> {
let table = self.dynamic_symbols()?;
Ok(table
.symbols
.into_iter()
.filter(|sym| {
sym.shndx != 0
&& matches!(
sym.bind,
crate::symbol::SymbolBind::Global | crate::symbol::SymbolBind::Weak
)
})
.collect())
}
fn symbols_from(&self, table: &str, strings: &str) -> Result<SymbolTable> {
let Some(data) = self.section_by_name(table).map(|section| §ion.data) else {
return Ok(SymbolTable::default());
};
let strtab_bytes = self
.section_by_name(strings)
.map(|section| section.data.clone())
.unwrap_or_default();
let strtab = crate::strtab::StringTable::new(&strtab_bytes);
SymbolTable::parse(data, strtab, self.ident.data, self.ident.class)
}
/// Returns up to `len` bytes at a preferred-base virtual address.
///
/// Bytes beyond the covering segment's file data but inside its memory
/// size read as zero. Returns `None` when no segment covers `vaddr`.
#[must_use]
pub fn read_at_vaddr(&self, vaddr: u64, len: usize) -> Option<Vec<u8>> {
let segment = self
.segments
.iter()
.find(|segment| segment.contains_vaddr(vaddr))?;
let in_segment = usize::try_from(vaddr - segment.header.vaddr).ok()?;
let mut out = alloc_vec(len);
let available = segment.data.get(in_segment..).unwrap_or(&[]);
let from_data = available.len().min(out.len());
out[..from_data].copy_from_slice(&available[..from_data]);
Some(out)
}
/// Returns the first section with `name`.
#[must_use]
pub fn section_by_name(&self, name: &str) -> Option<&crate::section::Section> {
self.sections.iter().find(|section| section.name == name)
}
}
fn load_records(segments: &[Segment]) -> impl Iterator<Item = (u64, u64, u64)> + '_ {
segments
.iter()
.filter(|segment| segment.header.r#type.0 == SegmentType::LOAD.0)
.map(|segment| {
(
segment.header.vaddr,
segment.header.memsz,
segment.header.align,
)
})
}
fn alloc_vec(len: usize) -> Vec<u8> {
alloc::vec![0u8; len]
}