mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-24 08:58:26 +00:00
32 lines
31 KiB
HTML
32 lines
31 KiB
HTML
|
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Support for reading ELF files."><title>object::read::elf - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="object" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../object/index.html">object</a><span class="version">0.32.2</span></h2></div><h2 class="location"><a href="#">Module elf</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In object::read</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|||
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../object/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">object</a>::<wbr><a href="../index.html">read</a>::<wbr><a class="mod" href="#">elf</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/object/read/elf/mod.rs.html#1-78">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Support for reading ELF files.</p>
|
|||
|
|
<p>Traits are used to abstract over the difference between 32-bit and 64-bit ELF.
|
|||
|
|
The primary trait for this is <a href="trait.FileHeader.html" title="trait object::read::elf::FileHeader"><code>FileHeader</code></a>.</p>
|
|||
|
|
<h3 id="high-level-api"><a href="#high-level-api">High level API</a></h3>
|
|||
|
|
<p><a href="struct.ElfFile.html" title="struct object::read::elf::ElfFile"><code>ElfFile</code></a> implements the <a href="../trait.Object.html" title="trait object::read::Object"><code>Object</code></a> trait for ELF files.
|
|||
|
|
<a href="struct.ElfFile.html" title="struct object::read::elf::ElfFile"><code>ElfFile</code></a> is parameterised by <a href="trait.FileHeader.html" title="trait object::read::elf::FileHeader"><code>FileHeader</code></a> to allow reading both 32-bit and
|
|||
|
|
64-bit ELF. There are type aliases for these parameters (<a href="type.ElfFile32.html" title="type object::read::elf::ElfFile32"><code>ElfFile32</code></a> and
|
|||
|
|
<a href="type.ElfFile64.html" title="type object::read::elf::ElfFile64"><code>ElfFile64</code></a>).</p>
|
|||
|
|
<h3 id="low-level-api"><a href="#low-level-api">Low level API</a></h3>
|
|||
|
|
<p>The <a href="trait.FileHeader.html" title="trait object::read::elf::FileHeader"><code>FileHeader</code></a> trait can be directly used to parse both <a href="../../elf/struct.FileHeader32.html" title="struct object::elf::FileHeader32"><code>elf::FileHeader32</code></a>
|
|||
|
|
and <a href="../../elf/struct.FileHeader64.html" title="struct object::elf::FileHeader64"><code>elf::FileHeader64</code></a>.</p>
|
|||
|
|
<h4 id="example-for-low-level-api"><a href="#example-for-low-level-api">Example for low level API</a></h4>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>object::elf;
|
|||
|
|
<span class="kw">use </span>object::read::elf::{FileHeader, Sym};
|
|||
|
|
<span class="kw">use </span>std::error::Error;
|
|||
|
|
<span class="kw">use </span>std::fs;
|
|||
|
|
|
|||
|
|
<span class="doccomment">/// Reads a file and displays the name of each symbol.
|
|||
|
|
</span><span class="kw">fn </span>main() -> <span class="prelude-ty">Result</span><(), Box<<span class="kw">dyn </span>Error>> {
|
|||
|
|
<span class="kw">let </span>data = fs::read(<span class="string">"path/to/binary"</span>)<span class="question-mark">?</span>;
|
|||
|
|
<span class="kw">let </span>elf = elf::FileHeader64::<object::Endianness>::parse(<span class="kw-2">&*</span>data)<span class="question-mark">?</span>;
|
|||
|
|
<span class="kw">let </span>endian = elf.endian()<span class="question-mark">?</span>;
|
|||
|
|
<span class="kw">let </span>sections = elf.sections(endian, <span class="kw-2">&*</span>data)<span class="question-mark">?</span>;
|
|||
|
|
<span class="kw">let </span>symbols = sections.symbols(endian, <span class="kw-2">&*</span>data, elf::SHT_SYMTAB)<span class="question-mark">?</span>;
|
|||
|
|
<span class="kw">for </span>symbol <span class="kw">in </span>symbols.iter() {
|
|||
|
|
<span class="kw">let </span>name = symbol.name(endian, symbols.strings())<span class="question-mark">?</span>;
|
|||
|
|
<span class="macro">println!</span>(<span class="string">"{}"</span>, String::from_utf8_lossy(name));
|
|||
|
|
}
|
|||
|
|
<span class="prelude-val">Ok</span>(())
|
|||
|
|
}</code></pre></div>
|
|||
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AttributeIndexIterator.html" title="struct object::read::elf::AttributeIndexIterator">AttributeIndexIterator</a></div><div class="desc docblock-short">An iterator over the indices in an <a href="struct.AttributesSubsubsection.html" title="struct object::read::elf::AttributesSubsubsection"><code>AttributesSubsubsection</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AttributeReader.html" title="struct object::read::elf::AttributeReader">AttributeReader</a></div><div class="desc docblock-short">A parser for the attributes in an <a href="struct.AttributesSubsubsection.html" title="struct object::read::elf::AttributesSubsubsection"><code>AttributesSubsubsection</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AttributesSection.html" title="struct object::read::elf::AttributesSection">AttributesSection</a></div><div class="desc docblock-short">An ELF attributes section.</div></li><li><div class="item-name"><a class="struct" href="struct.AttributesSubsection.html" title="struct object::read::elf::AttributesSubsection">AttributesSubsection</a></div><div class="desc docblock-short">A subsection in an <a href="struct.AttributesSection.html" title="struct object::read::elf::AttributesSection"><code>AttributesSection</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AttributesSubsectionIterator.html" title="struct object::read::elf::AttributesSubsectionIterator">AttributesSubsectionIterator</a></div><div class="desc docblock-short">An iterator for the subsections in an <a href="struct.AttributesSection.html" title="struct object::read::elf::AttributesSection"><code>AttributesSection</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AttributesSubsubsection.html" title="struct object::read::elf::AttributesSubsubsection">AttributesSubsubsection</a></div><div class="desc docblock-short">A sub-subsection in an <a href="struct.AttributesSubsection.html" title="struct object::read::elf::AttributesSubsection"><code>AttributesSubsection</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.AttributesSubsubsectionIterator.html" title="struct object::read::elf::AttributesSubsubsectionIterator">AttributesSubsubsectionIterator</a></div><div class="desc docblock-short">An iterator for the sub-subsections in an <a href="struct.AttributesSubsection.html" title="struct object::read::elf::AttributesSubsection"><code>AttributesSubsection</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ElfComdat.html" title="struct object::read::elf::ElfComdat">ElfComdat</a></div><div class="desc docblock-short">A COMDAT section group in an <a href="struct.ElfFile.html" title="struct object::read::elf::ElfFile"><code>ElfFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ElfComdatIterator.html" title="struct object::read::elf::ElfComdatIterator">ElfComdatIterator</a></div><div class="desc docblock-short">An iterator for the COMDAT section groups in an <a href="struct.ElfFile.html" title="struct object::read::elf::ElfFile"><code>ElfFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ElfComdatSectionIterator.html" title="struct object::read::elf::ElfComdatSectionIterator">ElfComdatSectionIterator</a></div><div class="desc docblock-short">An iterator for the sections in a COMDAT section group in an <a href="struct.ElfFile.html" title="struct object::read::elf::ElfFile"><code>ElfFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.ElfDynamicRelocationIterator.html" title="struct object::read::elf::ElfDynamicRelocationIterator">ElfDynamicRelocationIterator</a></div><div class="desc docblock-short">An iterator for the dynamic relocations in an <a href="struct.ElfFile.html" title="struct object::read::elf::ElfFile"><code>ElfFile</c
|