<!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::ProcessReader 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_1ProcessReader.html">ProcessReader</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_1ProcessReader-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ProcessReader Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Accesses information about another process, identified by a Mach task.
<a href="classcrashpad_1_1ProcessReader.html#details">More...</a></p>
<p><code>#include "snapshot/mac/process_reader.h"</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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1ProcessReader_1_1Module.html">Module</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains information about a module loaded into a process. <a href="structcrashpad_1_1ProcessReader_1_1Module.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structcrashpad_1_1ProcessReader_1_1Thread.html">Thread</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Contains information about a thread that belongs to a task (process). <a href="structcrashpad_1_1ProcessReader_1_1Thread.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </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:a55f755ec401dfb6598c3a22f76e12ff1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#a55f755ec401dfb6598c3a22f76e12ff1">Initialize</a> (task_t task)</td></tr>
<tr class="memdesc:a55f755ec401dfb6598c3a22f76e12ff1"><td class="mdescLeft"> </td><td class="mdescRight">Initializes this object. This method must be called before any other. <a href="#a55f755ec401dfb6598c3a22f76e12ff1">More...</a><br /></td></tr>
<tr class="separator:a55f755ec401dfb6598c3a22f76e12ff1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a80035d1e28c6a138e2ad8157abc5f4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#a7a80035d1e28c6a138e2ad8157abc5f4">Is64Bit</a> () const</td></tr>
<tr class="separator:a7a80035d1e28c6a138e2ad8157abc5f4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a563b92dd40252476f89eab8b4a53cf3b"><td class="memItemLeft" align="right" valign="top">pid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#a563b92dd40252476f89eab8b4a53cf3b">ProcessID</a> () const</td></tr>
<tr class="separator:a563b92dd40252476f89eab8b4a53cf3b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7373dd35aa5a10cf1149e2147396ff9c"><td class="memItemLeft" align="right" valign="top">pid_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#a7373dd35aa5a10cf1149e2147396ff9c">ParentProcessID</a> () const</td></tr>
<tr class="separator:a7373dd35aa5a10cf1149e2147396ff9c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb659e5a0daba4aa21bd0f66789550d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#abb659e5a0daba4aa21bd0f66789550d8">StartTime</a> (timeval *start_time) const</td></tr>
<tr class="memdesc:abb659e5a0daba4aa21bd0f66789550d8"><td class="mdescLeft"> </td><td class="mdescRight">Determines the target process’ start time. <a href="#abb659e5a0daba4aa21bd0f66789550d8">More...</a><br /></td></tr>
<tr class="separator:abb659e5a0daba4aa21bd0f66789550d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a79d46493bcac2de547f3f542ea99a6d7"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#a79d46493bcac2de547f3f542ea99a6d7">CPUTimes</a> (timeval *user_time, timeval *system_time) const</td></tr>
<tr class="memdesc:a79d46493bcac2de547f3f542ea99a6d7"><td class="mdescLeft"> </td><td class="mdescRight">Determines the target process’ execution time. <a href="#a79d46493bcac2de547f3f542ea99a6d7">More...</a><br /></td></tr>
<tr class="separator:a79d46493bcac2de547f3f542ea99a6d7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec00777c3e77735f75fb176cb24f420d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classcrashpad_1_1TaskMemory.html">TaskMemory</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#aec00777c3e77735f75fb176cb24f420d">Memory</a> ()</td></tr>
<tr class="separator:aec00777c3e77735f75fb176cb24f420d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02fdb7d5933eafaa596d4872ff95841d"><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="structcrashpad_1_1ProcessReader_1_1Thread.html">Thread</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#a02fdb7d5933eafaa596d4872ff95841d">Threads</a> ()</td></tr>
<tr class="separator:a02fdb7d5933eafaa596d4872ff95841d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afcd874395af5ca91e28f9056f6c3fe5e"><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="structcrashpad_1_1ProcessReader_1_1Module.html">Module</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ProcessReader.html#afcd874395af5ca91e28f9056f6c3fe5e">Modules</a> ()</td></tr>
<tr class="separator:afcd874395af5ca91e28f9056f6c3fe5e"><td class="memSeparator" colspan="2"> </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="a79d46493bcac2de547f3f542ea99a6d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79d46493bcac2de547f3f542ea99a6d7">◆ </a></span>CPUTimes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcessReader::CPUTimes </td>
<td>(</td>
<td class="paramtype">timeval * </td>
<td class="paramname"><em>user_time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">timeval * </td>
<td class="paramname"><em>system_time</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the target process’ 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="a55f755ec401dfb6598c3a22f76e12ff1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a55f755ec401dfb6598c3a22f76e12ff1">◆ </a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ProcessReader::Initialize </td>
<td>(</td>
<td class="paramtype">task_t </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="a7a80035d1e28c6a138e2ad8157abc5f4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7a80035d1e28c6a138e2ad8157abc5f4">◆ </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::ProcessReader::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="aec00777c3e77735f75fb176cb24f420d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec00777c3e77735f75fb176cb24f420d">◆ </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_1TaskMemory.html">TaskMemory</a>* crashpad::ProcessReader::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">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="afcd874395af5ca91e28f9056f6c3fe5e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afcd874395af5ca91e28f9056f6c3fe5e">◆ </a></span>Modules()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector< <a class="el" href="structcrashpad_1_1ProcessReader_1_1Module.html">ProcessReader::Module</a> > & crashpad::ProcessReader::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="a7373dd35aa5a10cf1149e2147396ff9c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7373dd35aa5a10cf1149e2147396ff9c">◆ </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::ProcessReader::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="a563b92dd40252476f89eab8b4a53cf3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a563b92dd40252476f89eab8b4a53cf3b">◆ </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::ProcessReader::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="abb659e5a0daba4aa21bd0f66789550d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb659e5a0daba4aa21bd0f66789550d8">◆ </a></span>StartTime()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void crashpad::ProcessReader::StartTime </td>
<td>(</td>
<td class="paramtype">timeval * </td>
<td class="paramname"><em>start_time</em></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>Determines the target process’ 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="a02fdb7d5933eafaa596d4872ff95841d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02fdb7d5933eafaa596d4872ff95841d">◆ </a></span>Threads()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector< <a class="el" href="structcrashpad_1_1ProcessReader_1_1Thread.html">ProcessReader::Thread</a> > & crashpad::ProcessReader::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.h</li>
<li>snapshot/mac/process_reader.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.13
</small></address>
</body>
</html>