| <!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::PtraceClient 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&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&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_1PtraceClient.html">PtraceClient</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#nested-classes">Classes</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classcrashpad_1_1PtraceClient-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">crashpad::PtraceClient Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Implements a <a class="el" href="classcrashpad_1_1PtraceConnection.html" title="Provides an interface for making ptrace requests against a process and its threads.">PtraceConnection</a> over a socket. |
| <a href="classcrashpad_1_1PtraceClient.html#details">More...</a></p> |
| |
| <p><code>#include "util/linux/ptrace_client.h"</code></p> |
| <div class="dynheader"> |
| Inheritance diagram for crashpad::PtraceClient:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classcrashpad_1_1PtraceClient.png" usemap="#crashpad::PtraceClient_map" alt=""/> |
| <map id="crashpad::PtraceClient_map" name="crashpad::PtraceClient_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,172,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:ac0214135c3d786743fcbc37159fc946d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#ac0214135c3d786743fcbc37159fc946d">Initialize</a> (int sock, pid_t pid, bool try_direct_memory=true)</td></tr> |
| <tr class="memdesc:ac0214135c3d786743fcbc37159fc946d"><td class="mdescLeft"> </td><td class="mdescRight">Initializes this object. <a href="classcrashpad_1_1PtraceClient.html#ac0214135c3d786743fcbc37159fc946d">More...</a><br /></td></tr> |
| <tr class="separator:ac0214135c3d786743fcbc37159fc946d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a92f0d406ecf375e6051c444b89045dd1"><td class="memItemLeft" align="right" valign="top"><a id="a92f0d406ecf375e6051c444b89045dd1"></a> |
| pid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#a92f0d406ecf375e6051c444b89045dd1">GetProcessID</a> () override</td></tr> |
| <tr class="memdesc:a92f0d406ecf375e6051c444b89045dd1"><td class="mdescLeft"> </td><td class="mdescRight">Returns the process ID of the connected process. <br /></td></tr> |
| <tr class="separator:a92f0d406ecf375e6051c444b89045dd1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a85f6f7580bd3d653f57e355232897250"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#a85f6f7580bd3d653f57e355232897250">Attach</a> (pid_t tid) override</td></tr> |
| <tr class="memdesc:a85f6f7580bd3d653f57e355232897250"><td class="mdescLeft"> </td><td class="mdescRight">Adds a new thread to this connection. <a href="classcrashpad_1_1PtraceClient.html#a85f6f7580bd3d653f57e355232897250">More...</a><br /></td></tr> |
| <tr class="separator:a85f6f7580bd3d653f57e355232897250"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a762085e56df0e3669ad358b4ad7317cc"><td class="memItemLeft" align="right" valign="top"><a id="a762085e56df0e3669ad358b4ad7317cc"></a> |
| bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#a762085e56df0e3669ad358b4ad7317cc">Is64Bit</a> () override</td></tr> |
| <tr class="memdesc:a762085e56df0e3669ad358b4ad7317cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if connected to a 64-bit process. <br /></td></tr> |
| <tr class="separator:a762085e56df0e3669ad358b4ad7317cc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2939beb155c48fc303fe1f7c81f8f81d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#a2939beb155c48fc303fe1f7c81f8f81d">GetThreadInfo</a> (pid_t tid, <a class="el" href="structcrashpad_1_1ThreadInfo.html">ThreadInfo</a> *info) override</td></tr> |
| <tr class="memdesc:a2939beb155c48fc303fe1f7c81f8f81d"><td class="mdescLeft"> </td><td class="mdescRight">Retrieves a <a class="el" href="structcrashpad_1_1ThreadInfo.html" title="A collection of ptrace-able information about a thread.">ThreadInfo</a> for a target thread. <a href="classcrashpad_1_1PtraceClient.html#a2939beb155c48fc303fe1f7c81f8f81d">More...</a><br /></td></tr> |
| <tr class="separator:a2939beb155c48fc303fe1f7c81f8f81d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a2a9384d50a124b681a3ef623a8e6ece0"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#a2a9384d50a124b681a3ef623a8e6ece0">ReadFileContents</a> (const base::FilePath &path, std::string *contents) override</td></tr> |
| <tr class="memdesc:a2a9384d50a124b681a3ef623a8e6ece0"><td class="mdescLeft"> </td><td class="mdescRight">Reads the entire contents of a file. <a href="classcrashpad_1_1PtraceClient.html#a2a9384d50a124b681a3ef623a8e6ece0">More...</a><br /></td></tr> |
| <tr class="separator:a2a9384d50a124b681a3ef623a8e6ece0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a58712ca965cad6746f2421e827292408"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcrashpad_1_1ProcessMemory.html">ProcessMemory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#a58712ca965cad6746f2421e827292408">Memory</a> () override</td></tr> |
| <tr class="memdesc:a58712ca965cad6746f2421e827292408"><td class="mdescLeft"> </td><td class="mdescRight">Returns a memory reader for the connected process. <a href="classcrashpad_1_1PtraceClient.html#a58712ca965cad6746f2421e827292408">More...</a><br /></td></tr> |
| <tr class="separator:a58712ca965cad6746f2421e827292408"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac2b5d7efdde4d38cdcdb0c9173152646"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1PtraceClient.html#ac2b5d7efdde4d38cdcdb0c9173152646">Threads</a> (std::vector< pid_t > *threads) override</td></tr> |
| <tr class="memdesc:ac2b5d7efdde4d38cdcdb0c9173152646"><td class="mdescLeft"> </td><td class="mdescRight">Determines the thread IDs of the threads in the connected process. <a href="classcrashpad_1_1PtraceClient.html#ac2b5d7efdde4d38cdcdb0c9173152646">More...</a><br /></td></tr> |
| <tr class="separator:ac2b5d7efdde4d38cdcdb0c9173152646"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Implements a <a class="el" href="classcrashpad_1_1PtraceConnection.html" title="Provides an interface for making ptrace requests against a process and its threads.">PtraceConnection</a> over a socket. </p> |
| <p>This class forms the client half of the connection and is typically used when the current process does not have <code>ptrace</code> capabilities on the target process. It should be created with a socket connected to a <a class="el" href="classcrashpad_1_1PtraceBroker.html" title="Implements a PtraceConnection over a socket.">PtraceBroker</a>. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a85f6f7580bd3d653f57e355232897250"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a85f6f7580bd3d653f57e355232897250">◆ </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::PtraceClient::Attach </td> |
| <td>(</td> |
| <td class="paramtype">pid_t </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="a2939beb155c48fc303fe1f7c81f8f81d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2939beb155c48fc303fe1f7c81f8f81d">◆ </a></span>GetThreadInfo()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::PtraceClient::GetThreadInfo </td> |
| <td>(</td> |
| <td class="paramtype">pid_t </td> |
| <td class="paramname"><em>tid</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="structcrashpad_1_1ThreadInfo.html">ThreadInfo</a> * </td> |
| <td class="paramname"><em>info</em> </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>Retrieves a <a class="el" href="structcrashpad_1_1ThreadInfo.html" title="A collection of ptrace-able information about a thread.">ThreadInfo</a> for a target thread. </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 target thread. </td></tr> |
| <tr><td class="paramdir">[out]</td><td class="paramname">info</td><td>Information about the thread. </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#a76eb577d671d45fc9eb9eae52a7ae629">crashpad::PtraceConnection</a>.</p> |
| |
| </div> |
| </div> |
| <a id="ac0214135c3d786743fcbc37159fc946d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac0214135c3d786743fcbc37159fc946d">◆ </a></span>Initialize()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool crashpad::PtraceClient::Initialize </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>sock</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">pid_t </td> |
| <td class="paramname"><em>pid</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>try_direct_memory</em> = <code>true</code> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes this object. </p> |
| <p>This method must be successfully called before 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">sock</td><td>A socket connected to a <a class="el" href="classcrashpad_1_1PtraceBroker.html" title="Implements a PtraceConnection over a socket.">PtraceBroker</a>. Does not take ownership of the socket. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">pid</td><td>The process ID of the process to form a <a class="el" href="classcrashpad_1_1PtraceConnection.html" title="Provides an interface for making ptrace requests against a process and its threads.">PtraceConnection</a> with. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">try_direct_memory</td><td>If <code>true</code> the client will attempt to support memory reading operations by directly acessing the target process' /proc/[pid]/mem file. </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="a58712ca965cad6746f2421e827292408"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a58712ca965cad6746f2421e827292408">◆ </a></span>Memory()</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="classcrashpad_1_1ProcessMemory.html">ProcessMemory</a> * crashpad::PtraceClient::Memory </td> |
| <td>(</td> |
| <td class="paramname"></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>Returns a memory reader for the connected process. </p> |
| <p>The caller does not take ownership of the reader. The reader is valid for the lifetime of the <a class="el" href="classcrashpad_1_1PtraceConnection.html" title="Provides an interface for making ptrace requests against a process and its threads.">PtraceConnection</a> that created it. </p> |
| |
| <p>Implements <a class="el" href="classcrashpad_1_1PtraceConnection.html#a80e297bfec6cf6583fd2c8e9c50ca9a8">crashpad::PtraceConnection</a>.</p> |
| |
| </div> |
| </div> |
| <a id="a2a9384d50a124b681a3ef623a8e6ece0"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a2a9384d50a124b681a3ef623a8e6ece0">◆ </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::PtraceClient::ReadFileContents </td> |
| <td>(</td> |
| <td class="paramtype">const base::FilePath & </td> |
| <td class="paramname"><em>path</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::string * </td> |
| <td class="paramname"><em>contents</em> </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="ac2b5d7efdde4d38cdcdb0c9173152646"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac2b5d7efdde4d38cdcdb0c9173152646">◆ </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::PtraceClient::Threads </td> |
| <td>(</td> |
| <td class="paramtype">std::vector< pid_t > * </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"> |
| |
| <p>Determines the thread IDs of the threads in the connected process. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramdir">[out]</td><td class="paramname">threads</td><td>The list of thread IDs. </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. If this method returns <code>false</code>, <em>threads</em> may contain a partial list of thread IDs. </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>util/linux/ptrace_client.h</li> |
| <li>util/linux/ptrace_client.cc</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.18 |
| </small></address> |
| </body> |
| </html> |
