blob: 094ab1365c23bd4249bab42fb59ad1d624779cb9 [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::test::FakePtraceConnection 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="namespacecrashpad_1_1test.html">test</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html">FakePtraceConnection</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classcrashpad_1_1test_1_1FakePtraceConnection-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::test::FakePtraceConnection Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Stands-in where real PtraceConnections aren't available.
<a href="classcrashpad_1_1test_1_1FakePtraceConnection.html#details">More...</a></p>
<p><code>#include &quot;test/linux/fake_ptrace_connection.h&quot;</code></p>
<div class="dynheader">
Inheritance diagram for crashpad::test::FakePtraceConnection:</div>
<div class="dyncontent">
<div class="center">
<img src="classcrashpad_1_1test_1_1FakePtraceConnection.png" usemap="#crashpad::test::FakePtraceConnection_map" alt=""/>
<map id="crashpad::test::FakePtraceConnection_map" name="crashpad::test::FakePtraceConnection_map">
<area href="classcrashpad_1_1PtraceConnection.html" title="Provides an interface for making ptrace requests against a process and its threads." alt="crashpad::PtraceConnection" shape="rect" coords="0,0,225,24"/>
</map>
</div></div>
<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:ac9e2513346d3c156fed9166bfb2e4883"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#ac9e2513346d3c156fed9166bfb2e4883">Initialize</a> (pid_t pid)</td></tr>
<tr class="memdesc:ac9e2513346d3c156fed9166bfb2e4883"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes this connection for the process whose process ID is <em>pid</em>. <a href="classcrashpad_1_1test_1_1FakePtraceConnection.html#ac9e2513346d3c156fed9166bfb2e4883">More...</a><br /></td></tr>
<tr class="separator:ac9e2513346d3c156fed9166bfb2e4883"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2a78bada9243651ec6e47e2decc021e"><td class="memItemLeft" align="right" valign="top"><a id="ab2a78bada9243651ec6e47e2decc021e"></a>
pid_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#ab2a78bada9243651ec6e47e2decc021e">GetProcessID</a> () override</td></tr>
<tr class="memdesc:ab2a78bada9243651ec6e47e2decc021e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the process ID of the connected process. <br /></td></tr>
<tr class="separator:ab2a78bada9243651ec6e47e2decc021e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae446ad6bec3635e246ebb026bd5348e6"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#ae446ad6bec3635e246ebb026bd5348e6">Attach</a> (pid_t tid) override</td></tr>
<tr class="memdesc:ae446ad6bec3635e246ebb026bd5348e6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds a new thread to this connection. <a href="classcrashpad_1_1test_1_1FakePtraceConnection.html#ae446ad6bec3635e246ebb026bd5348e6">More...</a><br /></td></tr>
<tr class="separator:ae446ad6bec3635e246ebb026bd5348e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99e8abbdb5452a229d5a4ebd051cf193"><td class="memItemLeft" align="right" valign="top"><a id="a99e8abbdb5452a229d5a4ebd051cf193"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#a99e8abbdb5452a229d5a4ebd051cf193">Is64Bit</a> () override</td></tr>
<tr class="memdesc:a99e8abbdb5452a229d5a4ebd051cf193"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns <code>true</code> if the current process is 64-bit. <br /></td></tr>
<tr class="separator:a99e8abbdb5452a229d5a4ebd051cf193"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8dc87c797183dd98e045e17d1a4e1845"><td class="memItemLeft" align="right" valign="top"><a id="a8dc87c797183dd98e045e17d1a4e1845"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#a8dc87c797183dd98e045e17d1a4e1845">GetThreadInfo</a> (pid_t tid, <a class="el" href="structcrashpad_1_1ThreadInfo.html">ThreadInfo</a> *info) override</td></tr>
<tr class="memdesc:a8dc87c797183dd98e045e17d1a4e1845"><td class="mdescLeft">&#160;</td><td class="mdescRight">Does not modify <em>info</em>. <br /></td></tr>
<tr class="separator:a8dc87c797183dd98e045e17d1a4e1845"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c4aa66acc48dbb27ac579aa1fd73af7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#a4c4aa66acc48dbb27ac579aa1fd73af7">ReadFileContents</a> (const base::FilePath &amp;path, std::string *contents) override</td></tr>
<tr class="memdesc:a4c4aa66acc48dbb27ac579aa1fd73af7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the entire contents of a file. <a href="classcrashpad_1_1test_1_1FakePtraceConnection.html#a4c4aa66acc48dbb27ac579aa1fd73af7">More...</a><br /></td></tr>
<tr class="separator:a4c4aa66acc48dbb27ac579aa1fd73af7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae88bb06d58f6d1d4fb9e600009d146d5"><td class="memItemLeft" align="right" valign="top"><a id="ae88bb06d58f6d1d4fb9e600009d146d5"></a>
<a class="el" href="classcrashpad_1_1ProcessMemory.html">ProcessMemory</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#ae88bb06d58f6d1d4fb9e600009d146d5">Memory</a> () override</td></tr>
<tr class="memdesc:ae88bb06d58f6d1d4fb9e600009d146d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to create a <a class="el" href="classcrashpad_1_1ProcessMemory.html" title="Abstract base class for accessing the memory of another process.">ProcessMemory</a> when called, calling ADD_FAILURE() and returning <code>nullptr</code> on failure. <br /></td></tr>
<tr class="separator:ae88bb06d58f6d1d4fb9e600009d146d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae399f5f7be50153d712c4571d6b58ca7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1test_1_1FakePtraceConnection.html#ae399f5f7be50153d712c4571d6b58ca7">Threads</a> (std::vector&lt; pid_t &gt; *threads) override</td></tr>
<tr class="separator:ae399f5f7be50153d712c4571d6b58ca7"><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>Stands-in where real PtraceConnections aren't available. </p>
<p>This class performs basic EXPECTs that it is used correctly, but does not execute any real <code>ptrace</code> calls or attachments. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae446ad6bec3635e246ebb026bd5348e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae446ad6bec3635e246ebb026bd5348e6">&#9670;&nbsp;</a></span>Attach()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool crashpad::test::FakePtraceConnection::Attach </td>
<td>(</td>
<td class="paramtype">pid_t&#160;</td>
<td class="paramname"><em>tid</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Adds a new thread to this connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">tid</td><td>The thread ID of the thread to attach. </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>
<p>Implements <a class="el" href="classcrashpad_1_1PtraceConnection.html#a9ab31fc778f64843b9d4abc3316c8bcc">crashpad::PtraceConnection</a>.</p>
</div>
</div>
<a id="ac9e2513346d3c156fed9166bfb2e4883"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac9e2513346d3c156fed9166bfb2e4883">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::test::FakePtraceConnection::Initialize </td>
<td>(</td>
<td class="paramtype">pid_t&#160;</td>
<td class="paramname"><em>pid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes this connection for the process whose process ID is <em>pid</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>The process ID of the process to connect to. </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="a4c4aa66acc48dbb27ac579aa1fd73af7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c4aa66acc48dbb27ac579aa1fd73af7">&#9670;&nbsp;</a></span>ReadFileContents()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool crashpad::test::FakePtraceConnection::ReadFileContents </td>
<td>(</td>
<td class="paramtype">const base::FilePath &amp;&#160;</td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string *&#160;</td>
<td class="paramname"><em>contents</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads the entire contents of a file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>The path of the file to read. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">contents</td><td>The file contents, valid if this method returns <code>true</code>. </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>
<p>Implements <a class="el" href="classcrashpad_1_1PtraceConnection.html#a49d4ed2691ef7d612d49e1f145761f57">crashpad::PtraceConnection</a>.</p>
</div>
</div>
<a id="ae399f5f7be50153d712c4571d6b58ca7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae399f5f7be50153d712c4571d6b58ca7">&#9670;&nbsp;</a></span>Threads()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool crashpad::test::FakePtraceConnection::Threads </td>
<td>(</td>
<td class="paramtype">std::vector&lt; pid_t &gt; *&#160;</td>
<td class="paramname"><em>threads</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>Not yet implemented. </dd></dl>
<p>Implements <a class="el" href="classcrashpad_1_1PtraceConnection.html#a822a40bdeb85d8ea936d419aea0ea426">crashpad::PtraceConnection</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>test/linux/fake_ptrace_connection.h</li>
<li>test/linux/fake_ptrace_connection.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>