blob: 30f37bc79fafd9377b82cee0d8911c4d582670ed [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::DebugRendezvous 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.18 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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_1DebugRendezvous.html">DebugRendezvous</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_1DebugRendezvous-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::DebugRendezvous Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Reads an <code>r_debug</code> struct defined in <code>&lt;link.h&gt;</code> via <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html" title="Provides range protected access to the memory of another process.">ProcessMemoryRange</a>.
<a href="classcrashpad_1_1DebugRendezvous.html#details">More...</a></p>
<p><code>#include &quot;snapshot/linux/debug_rendezvous.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">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1DebugRendezvous_1_1LinkEntry.html">LinkEntry</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An entry in the dynamic linker's list of loaded objects. <a href="structcrashpad_1_1DebugRendezvous_1_1LinkEntry.html#details">More...</a><br /></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:a4fcfbc6752ea669a0147e08f527e24b6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1DebugRendezvous.html#a4fcfbc6752ea669a0147e08f527e24b6">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:a4fcfbc6752ea669a0147e08f527e24b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes this object by reading an <code>r_debug</code> struct from a target process. <a href="classcrashpad_1_1DebugRendezvous.html#a4fcfbc6752ea669a0147e08f527e24b6">More...</a><br /></td></tr>
<tr class="separator:a4fcfbc6752ea669a0147e08f527e24b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ffd41ef335d52aaab6739957ee2d747"><td class="memItemLeft" align="right" valign="top"><a id="a6ffd41ef335d52aaab6739957ee2d747"></a>
const <a class="el" href="structcrashpad_1_1DebugRendezvous_1_1LinkEntry.html">LinkEntry</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1DebugRendezvous.html#a6ffd41ef335d52aaab6739957ee2d747">Executable</a> () const</td></tr>
<tr class="memdesc:a6ffd41ef335d52aaab6739957ee2d747"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the <a class="el" href="structcrashpad_1_1DebugRendezvous_1_1LinkEntry.html" title="An entry in the dynamic linker&#39;s list of loaded objects.">LinkEntry</a> for the main executable. <br /></td></tr>
<tr class="separator:a6ffd41ef335d52aaab6739957ee2d747"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3ee5fc64d0a78e3870d9b172006cce9"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structcrashpad_1_1DebugRendezvous_1_1LinkEntry.html">LinkEntry</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1DebugRendezvous.html#ac3ee5fc64d0a78e3870d9b172006cce9">Modules</a> () const</td></tr>
<tr class="memdesc:ac3ee5fc64d0a78e3870d9b172006cce9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a vector of modules found in the link map. <a href="classcrashpad_1_1DebugRendezvous.html#ac3ee5fc64d0a78e3870d9b172006cce9">More...</a><br /></td></tr>
<tr class="separator:ac3ee5fc64d0a78e3870d9b172006cce9"><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>Reads an <code>r_debug</code> struct defined in <code>&lt;link.h&gt;</code> via <a class="el" href="classcrashpad_1_1ProcessMemoryRange.html" title="Provides range protected access to the memory of another process.">ProcessMemoryRange</a>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a4fcfbc6752ea669a0147e08f527e24b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fcfbc6752ea669a0147e08f527e24b6">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::DebugRendezvous::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 this object by reading an <code>r_debug</code> struct from a target process. </p>
<p>This method must be called successfully prior to calling any other method in this class.</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 of an <code>r_debug</code> struct in the remote process. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success. <code>false</code> on failure with a message logged. </dd></dl>
</div>
</div>
<a id="ac3ee5fc64d0a78e3870d9b172006cce9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac3ee5fc64d0a78e3870d9b172006cce9">&#9670;&nbsp;</a></span>Modules()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; <a class="el" href="structcrashpad_1_1DebugRendezvous_1_1LinkEntry.html">DebugRendezvous::LinkEntry</a> &gt; &amp; crashpad::DebugRendezvous::Modules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a vector of modules found in the link map. </p>
<p>This list excludes the entry for the executable and may include entries for the VDSO and loader. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>snapshot/linux/debug_rendezvous.h</li>
<li>snapshot/linux/debug_rendezvous.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.18
</small></address>
</body>
</html>