crashpad/doc/generated/doxygen/classcrashpad_1_1ElfImageReader.html
2017-07-29 17:13:40 -04:00

384 lines
20 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::ElfImageReader Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="crashpad_doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacecrashpad.html">crashpad</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1ElfImageReader.html">ElfImageReader</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1ElfImageReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ElfImageReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A reader for ELF images mapped into another process.
<a href="classcrashpad_1_1ElfImageReader.html#details">More...</a></p>
<p><code>#include &quot;snapshot/linux/elf_image_reader.h&quot;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader_1_1ProgramHeaderTable.html">ProgramHeaderTable</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader_1_1ProgramHeaderTableSpecific.html">ProgramHeaderTableSpecific</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aec68cb7793afece793853d8ff5dff398"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#aec68cb7793afece793853d8ff5dff398">Initialize</a> (const <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html">ProcessMemoryRange</a> &amp;memory, <a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> address)</td></tr>
<tr class="memdesc:aec68cb7793afece793853d8ff5dff398"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the reader. <a href="#aec68cb7793afece793853d8ff5dff398">More...</a><br /></td></tr>
<tr class="separator:aec68cb7793afece793853d8ff5dff398"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acedd932cca6e89be0e7094ea16ea887e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#acedd932cca6e89be0e7094ea16ea887e">Address</a> () const</td></tr>
<tr class="memdesc:acedd932cca6e89be0e7094ea16ea887e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the base address of the image's memory range. <a href="#acedd932cca6e89be0e7094ea16ea887e">More...</a><br /></td></tr>
<tr class="separator:acedd932cca6e89be0e7094ea16ea887e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a16f4a7dcdccef43ac24b4ff3457ed67c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#aa2b5b2818842bda12ff9c4d555c2c8c8">LinuxVMSize</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#a16f4a7dcdccef43ac24b4ff3457ed67c">Size</a> () const</td></tr>
<tr class="memdesc:a16f4a7dcdccef43ac24b4ff3457ed67c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the size of the range containing all loaded segments for this image. <a href="#a16f4a7dcdccef43ac24b4ff3457ed67c">More...</a><br /></td></tr>
<tr class="separator:a16f4a7dcdccef43ac24b4ff3457ed67c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd0483257628188753b1f70709b8cad6"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#afd0483257628188753b1f70709b8cad6">FileType</a> () const</td></tr>
<tr class="memdesc:afd0483257628188753b1f70709b8cad6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the file type for the image. <a href="#afd0483257628188753b1f70709b8cad6">More...</a><br /></td></tr>
<tr class="separator:afd0483257628188753b1f70709b8cad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b988943143f6c2ab68686098248b118"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacecrashpad.html#aaceb37fb2d50bfedc7242a92e962df3f">LinuxVMOffset</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#a4b988943143f6c2ab68686098248b118">GetLoadBias</a> () const</td></tr>
<tr class="memdesc:a4b988943143f6c2ab68686098248b118"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the load bias for the image. <a href="#a4b988943143f6c2ab68686098248b118">More...</a><br /></td></tr>
<tr class="separator:a4b988943143f6c2ab68686098248b118"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae722bcbca8898b56dd16d6ded81fd8a4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#ae722bcbca8898b56dd16d6ded81fd8a4">GetDynamicSymbol</a> (const std::string &amp;name, <a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> *address, <a class="el" href="namespacecrashpad.html#aa2b5b2818842bda12ff9c4d555c2c8c8">LinuxVMSize</a> *size)</td></tr>
<tr class="memdesc:ae722bcbca8898b56dd16d6ded81fd8a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads information from the dynamic symbol table about the symbol identified by <em>name</em>. <a href="#ae722bcbca8898b56dd16d6ded81fd8a4">More...</a><br /></td></tr>
<tr class="separator:ae722bcbca8898b56dd16d6ded81fd8a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc08fd269eddcb7b4539751482d22fe3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#adc08fd269eddcb7b4539751482d22fe3">ReadDynamicStringTableAtOffset</a> (<a class="el" href="namespacecrashpad.html#aa2b5b2818842bda12ff9c4d555c2c8c8">LinuxVMSize</a> offset, std::string *string)</td></tr>
<tr class="memdesc:adc08fd269eddcb7b4539751482d22fe3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a <code>NUL</code>-terminated C string from this image's dynamic string table. <a href="#adc08fd269eddcb7b4539751482d22fe3">More...</a><br /></td></tr>
<tr class="separator:adc08fd269eddcb7b4539751482d22fe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a13444baaf7441a34739706a15fa3ab64"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ElfImageReader.html#a13444baaf7441a34739706a15fa3ab64">GetDebugAddress</a> (<a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> *debug)</td></tr>
<tr class="memdesc:a13444baaf7441a34739706a15fa3ab64"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determine the debug address. <a href="#a13444baaf7441a34739706a15fa3ab64">More...</a><br /></td></tr>
<tr class="separator:a13444baaf7441a34739706a15fa3ab64"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A reader for ELF images mapped into another process. </p>
<p>This class is capable of reading both 32-bit and 64-bit images. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="acedd932cca6e89be0e7094ea16ea887e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acedd932cca6e89be0e7094ea16ea887e">&#9670;&nbsp;</a></span>Address()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> crashpad::ElfImageReader::Address </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the base address of the image's memory range. </p>
<p>This may differ from the address passed to <a class="el" href="classcrashpad_1_1ElfImageReader.html#aec68cb7793afece793853d8ff5dff398" title="Initializes the reader. ">Initialize()</a> if the ELF header is not loaded at the start of the first <code>PT_LOAD</code> segment. </p>
</div>
</div>
<a id="afd0483257628188753b1f70709b8cad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd0483257628188753b1f70709b8cad6">&#9670;&nbsp;</a></span>FileType()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t crashpad::ElfImageReader::FileType </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the file type for the image. </p>
<p>Possible values include <code>ET_EXEC</code> or <code>ET_DYN</code> from <code>&lt;elf.h&gt;</code>. </p>
</div>
</div>
<a id="a13444baaf7441a34739706a15fa3ab64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13444baaf7441a34739706a15fa3ab64">&#9670;&nbsp;</a></span>GetDebugAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ElfImageReader::GetDebugAddress </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> *&#160;</td>
<td class="paramname"><em>debug</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine the debug address. </p>
<p>The debug address is a pointer to an <code>r_debug</code> struct defined in <code>&lt;link.h&gt;</code>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">debug</td><td>the debug address, if found. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the debug address was found. </dd></dl>
</div>
</div>
<a id="ae722bcbca8898b56dd16d6ded81fd8a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae722bcbca8898b56dd16d6ded81fd8a4">&#9670;&nbsp;</a></span>GetDynamicSymbol()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ElfImageReader::GetDynamicSymbol </td>
<td>(</td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> *&#160;</td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacecrashpad.html#aa2b5b2818842bda12ff9c4d555c2c8c8">LinuxVMSize</a> *&#160;</td>
<td class="paramname"><em>size</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads information from the dynamic symbol table about the symbol identified by <em>name</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>The name of the symbol to search for. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">address</td><td>The address of the symbol in the target process' address space, if found. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>The size of the symbol, if found. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the symbol was found. </dd></dl>
</div>
</div>
<a id="a4b988943143f6c2ab68686098248b118"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4b988943143f6c2ab68686098248b118">&#9670;&nbsp;</a></span>GetLoadBias()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#aaceb37fb2d50bfedc7242a92e962df3f">LinuxVMOffset</a> crashpad::ElfImageReader::GetLoadBias </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the load bias for the image. </p>
<p>The load bias is the actual load address minus the preferred load address. </p>
</div>
</div>
<a id="aec68cb7793afece793853d8ff5dff398"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec68cb7793afece793853d8ff5dff398">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ElfImageReader::Initialize </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html">ProcessMemoryRange</a> &amp;&#160;</td>
<td class="paramname"><em>memory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a>&#160;</td>
<td class="paramname"><em>address</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the reader. </p>
<p>This method must be called once on an object and must be successfully called before any other method in this class may be called.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>A memory reader for the remote process. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">address</td><td>The address in the remote process' address space where the ELF image is loaded. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adc08fd269eddcb7b4539751482d22fe3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc08fd269eddcb7b4539751482d22fe3">&#9670;&nbsp;</a></span>ReadDynamicStringTableAtOffset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ElfImageReader::ReadDynamicStringTableAtOffset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacecrashpad.html#aa2b5b2818842bda12ff9c4d555c2c8c8">LinuxVMSize</a>&#160;</td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>string</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a <code>NUL</code>-terminated C string from this image's dynamic string table. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>the byte offset in the string table to start reading. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">string</td><td>the string read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. Otherwise <code>false</code> with a message logged. </dd></dl>
</div>
</div>
<a id="a16f4a7dcdccef43ac24b4ff3457ed67c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a16f4a7dcdccef43ac24b4ff3457ed67c">&#9670;&nbsp;</a></span>Size()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacecrashpad.html#aa2b5b2818842bda12ff9c4d555c2c8c8">LinuxVMSize</a> crashpad::ElfImageReader::Size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the size of the range containing all loaded segments for this image. </p>
<p>The size may include memory that is unmapped or mapped to other objects if this image's <code>PT_LOAD</code> segments are not contiguous. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>snapshot/linux/elf_image_reader.h</li>
<li>snapshot/linux/elf_image_reader.cc</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>