blob: 595ef1e4e0b866d5e9a880bb1550e31139e1a05b [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::ProcessReaderMac 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_1ProcessReaderMac.html">ProcessReaderMac</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_1ProcessReaderMac-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ProcessReaderMac Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Accesses information about another process, identified by a Mach task.
<a href="classcrashpad_1_1ProcessReaderMac.html#details">More...</a></p>
<p><code>#include &quot;snapshot/mac/process_reader_mac.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_1ProcessReaderMac_1_1Module.html">Module</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains information about a module loaded into a process. <a href="structcrashpad_1_1ProcessReaderMac_1_1Module.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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_1ProcessReaderMac_1_1Thread.html">Thread</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains information about a thread that belongs to a task (process). <a href="structcrashpad_1_1ProcessReaderMac_1_1Thread.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:a38f03378dee49b75f86bb81297527332"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a38f03378dee49b75f86bb81297527332">Initialize</a> (task_t task)</td></tr>
<tr class="memdesc:a38f03378dee49b75f86bb81297527332"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes this object. This method must be called before any other. <a href="classcrashpad_1_1ProcessReaderMac.html#a38f03378dee49b75f86bb81297527332">More...</a><br /></td></tr>
<tr class="separator:a38f03378dee49b75f86bb81297527332"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa19e6ee527ebe624613a4882acf8aeae"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#aa19e6ee527ebe624613a4882acf8aeae">Is64Bit</a> () const</td></tr>
<tr class="separator:aa19e6ee527ebe624613a4882acf8aeae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac77379c4000140f82fb6884c7f016307"><td class="memItemLeft" align="right" valign="top">pid_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#ac77379c4000140f82fb6884c7f016307">ProcessID</a> () const</td></tr>
<tr class="separator:ac77379c4000140f82fb6884c7f016307"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4a576377a897fd0bd665db5d27631df"><td class="memItemLeft" align="right" valign="top">pid_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#ab4a576377a897fd0bd665db5d27631df">ParentProcessID</a> () const</td></tr>
<tr class="separator:ab4a576377a897fd0bd665db5d27631df"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f0c1ded430aa9413804475b4f28df10"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a6f0c1ded430aa9413804475b4f28df10">StartTime</a> (timeval *start_time) const</td></tr>
<tr class="memdesc:a6f0c1ded430aa9413804475b4f28df10"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the target process’&#160;start time. <a href="classcrashpad_1_1ProcessReaderMac.html#a6f0c1ded430aa9413804475b4f28df10">More...</a><br /></td></tr>
<tr class="separator:a6f0c1ded430aa9413804475b4f28df10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f66ba710fa52c2f39dce640a319ea6d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a6f66ba710fa52c2f39dce640a319ea6d">CPUTimes</a> (timeval *user_time, timeval *system_time) const</td></tr>
<tr class="memdesc:a6f66ba710fa52c2f39dce640a319ea6d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the target process’&#160;execution time. <a href="classcrashpad_1_1ProcessReaderMac.html#a6f66ba710fa52c2f39dce640a319ea6d">More...</a><br /></td></tr>
<tr class="separator:a6f66ba710fa52c2f39dce640a319ea6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a555b7f382526cf9585b561c2889524fd"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classcrashpad_1_1ProcessMemoryMac.html">ProcessMemoryMac</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a555b7f382526cf9585b561c2889524fd">Memory</a> () const</td></tr>
<tr class="separator:a555b7f382526cf9585b561c2889524fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a183cf2139ab1c78721d55e3d034dd511"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structcrashpad_1_1ProcessReaderMac_1_1Thread.html">Thread</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a183cf2139ab1c78721d55e3d034dd511">Threads</a> ()</td></tr>
<tr class="separator:a183cf2139ab1c78721d55e3d034dd511"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a52b84afe6d9b173a6cb3ae4c495ad3b7"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structcrashpad_1_1ProcessReaderMac_1_1Module.html">Module</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a52b84afe6d9b173a6cb3ae4c495ad3b7">Modules</a> ()</td></tr>
<tr class="separator:a52b84afe6d9b173a6cb3ae4c495ad3b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6604c3cd5061ad3019abbb8eabc23fd8"><td class="memItemLeft" align="right" valign="top">mach_vm_address_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a6604c3cd5061ad3019abbb8eabc23fd8">DyldAllImageInfo</a> (mach_vm_size_t *all_image_info_size)</td></tr>
<tr class="memdesc:a6604c3cd5061ad3019abbb8eabc23fd8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the location of the <code>dyld_all_image_infos</code> structure in the process’ address space. <a href="classcrashpad_1_1ProcessReaderMac.html#a6604c3cd5061ad3019abbb8eabc23fd8">More...</a><br /></td></tr>
<tr class="separator:a6604c3cd5061ad3019abbb8eabc23fd8"><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>Accesses information about another process, identified by a Mach task. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a6f66ba710fa52c2f39dce640a319ea6d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f66ba710fa52c2f39dce640a319ea6d">&#9670;&nbsp;</a></span>CPUTimes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcessReaderMac::CPUTimes </td>
<td>(</td>
<td class="paramtype">timeval *&#160;</td>
<td class="paramname"><em>user_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">timeval *&#160;</td>
<td class="paramname"><em>system_time</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the target process’&#160;execution time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">user_time</td><td>The amount of time the process has executed code in user mode. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">system_time</td><td>The amount of time the process has executed code in system mode.</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 warning logged. On failure, <em>user_time</em> and <em>system_time</em> will be set to represent no time spent executing code in user or system mode. </dd></dl>
</div>
</div>
<a id="a6604c3cd5061ad3019abbb8eabc23fd8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6604c3cd5061ad3019abbb8eabc23fd8">&#9670;&nbsp;</a></span>DyldAllImageInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">mach_vm_address_t crashpad::ProcessReaderMac::DyldAllImageInfo </td>
<td>(</td>
<td class="paramtype">mach_vm_size_t *&#160;</td>
<td class="paramname"><em>all_image_info_size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the location of the <code>dyld_all_image_infos</code> structure in the process’ address space. </p>
<p>This function is an internal implementation detail of <a class="el" href="classcrashpad_1_1ProcessReaderMac.html#a52b84afe6d9b173a6cb3ae4c495ad3b7">Modules()</a>, and should not normally be used directly. It is exposed solely for use by test code.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">all_image_info_size</td><td>The size of the <code>dyld_all_image_infos</code> structure. Optional, may be <code>nullptr</code> if not required.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The address of the <code>dyld_all_image_infos</code> structure in the process’ address space, with <em>all_image_info_size</em> set appropriately. On failure, returns <code>0</code> with a message logged. </dd></dl>
</div>
</div>
<a id="a38f03378dee49b75f86bb81297527332"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a38f03378dee49b75f86bb81297527332">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcessReaderMac::Initialize </td>
<td>(</td>
<td class="paramtype">task_t&#160;</td>
<td class="paramname"><em>task</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes this object. This method must be called before any other. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">task</td><td>A send right to the target task’s task port. This object does not take ownership of the send right.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, indicating that this object will respond validly to further method calls. <code>false</code> on failure. On failure, no further method calls should be made. </dd></dl>
</div>
</div>
<a id="aa19e6ee527ebe624613a4882acf8aeae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa19e6ee527ebe624613a4882acf8aeae">&#9670;&nbsp;</a></span>Is64Bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcessReaderMac::Is64Bit </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">
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the target task is a 64-bit process. </dd></dl>
</div>
</div>
<a id="a555b7f382526cf9585b561c2889524fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a555b7f382526cf9585b561c2889524fd">&#9670;&nbsp;</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">const <a class="el" href="classcrashpad_1_1ProcessMemoryMac.html">ProcessMemoryMac</a>* crashpad::ProcessReaderMac::Memory </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">
<dl class="section return"><dt>Returns</dt><dd>Accesses the memory of the target task. </dd></dl>
</div>
</div>
<a id="a52b84afe6d9b173a6cb3ae4c495ad3b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a52b84afe6d9b173a6cb3ae4c495ad3b7">&#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_1ProcessReaderMac_1_1Module.html">ProcessReaderMac::Module</a> &gt; &amp; crashpad::ProcessReaderMac::Modules </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The modules loaded in the process. The first element (at index <code>0</code>) corresponds to the main executable, and the final element corresponds to the dynamic loader, dyld. </dd></dl>
</div>
</div>
<a id="ab4a576377a897fd0bd665db5d27631df"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4a576377a897fd0bd665db5d27631df">&#9670;&nbsp;</a></span>ParentProcessID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">pid_t crashpad::ProcessReaderMac::ParentProcessID </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">
<dl class="section return"><dt>Returns</dt><dd>The target task’s parent process ID. </dd></dl>
</div>
</div>
<a id="ac77379c4000140f82fb6884c7f016307"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac77379c4000140f82fb6884c7f016307">&#9670;&nbsp;</a></span>ProcessID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">pid_t crashpad::ProcessReaderMac::ProcessID </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">
<dl class="section return"><dt>Returns</dt><dd>The target task’s process ID. </dd></dl>
</div>
</div>
<a id="a6f0c1ded430aa9413804475b4f28df10"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f0c1ded430aa9413804475b4f28df10">&#9670;&nbsp;</a></span>StartTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void crashpad::ProcessReaderMac::StartTime </td>
<td>(</td>
<td class="paramtype">timeval *&#160;</td>
<td class="paramname"><em>start_time</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the target process’&#160;start time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">start_time</td><td>The time that the process started. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a183cf2139ab1c78721d55e3d034dd511"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a183cf2139ab1c78721d55e3d034dd511">&#9670;&nbsp;</a></span>Threads()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; <a class="el" href="structcrashpad_1_1ProcessReaderMac_1_1Thread.html">ProcessReaderMac::Thread</a> &gt; &amp; crashpad::ProcessReaderMac::Threads </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The threads that are in the task (process). The first element (at index <code>0</code>) corresponds to the main thread. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>snapshot/mac/process_reader_mac.h</li>
<li>snapshot/mac/process_reader_mac.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>