<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::internal::ThreadSnapshotMac 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.12 -->
<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="namespacecrashpad_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html">ThreadSnapshotMac</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classcrashpad_1_1internal_1_1ThreadSnapshotMac-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::internal::ThreadSnapshotMac Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>A <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> of a thread in a running (or crashed) process on a macOS system.
<a href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#details">More...</a></p>
<p><code>#include "snapshot/mac/thread_snapshot_mac.h"</code></p>
<div class="dynheader">
Inheritance diagram for crashpad::internal::ThreadSnapshotMac:</div>
<div class="dyncontent">
<div class="center">
<img src="classcrashpad_1_1internal_1_1ThreadSnapshotMac.png" usemap="#crashpad::internal::ThreadSnapshotMac_map" alt=""/>
<map id="crashpad::internal::ThreadSnapshotMac_map" name="crashpad::internal::ThreadSnapshotMac_map">
<area href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot..." alt="crashpad::ThreadSnapshot" shape="rect" coords="0,0,355,24"/>
<area href="classcrashpad_1_1PointerContainer.html" alt="crashpad::PointerContainer< internal::ThreadSnapshotMac >" shape="rect" coords="0,112,355,136"/>
</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:a7bb7d71110ccad4d4b74ce9c69a7fef3"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a7bb7d71110ccad4d4b74ce9c69a7fef3">Initialize</a> (<a class="el" href="classcrashpad_1_1ProcessReader.html">ProcessReader</a> *process_reader, const <a class="el" href="structcrashpad_1_1ProcessReader_1_1Thread.html">ProcessReader::Thread</a> &process_reader_thread)</td></tr>
<tr class="memdesc:a7bb7d71110ccad4d4b74ce9c69a7fef3"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the object. <a href="#a7bb7d71110ccad4d4b74ce9c69a7fef3">More...</a><br /></td></tr>
<tr class="separator:a7bb7d71110ccad4d4b74ce9c69a7fef3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a063a6cf88d16769775ddf98c7d8abf6a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a063a6cf88d16769775ddf98c7d8abf6a">Context</a> () const override</td></tr>
<tr class="memdesc:a063a6cf88d16769775ddf98c7d8abf6a"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="structcrashpad_1_1CPUContext.html" title="A context structure capable of carrying the context of any supported CPU architecture. ">CPUContext</a> object corresponding to the thread’s CPU context. <a href="#a063a6cf88d16769775ddf98c7d8abf6a">More...</a><br /></td></tr>
<tr class="separator:a063a6cf88d16769775ddf98c7d8abf6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b63ca812f667219928f2f0dd3f9d846"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a5b63ca812f667219928f2f0dd3f9d846">Stack</a> () const override</td></tr>
<tr class="memdesc:a5b63ca812f667219928f2f0dd3f9d846"><td class="mdescLeft"> </td><td class="mdescRight">Returns a <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> object corresponding to the memory region that contains the thread’s stack, or <code>nullptr</code> if no stack region is available. <a href="#a5b63ca812f667219928f2f0dd3f9d846">More...</a><br /></td></tr>
<tr class="separator:a5b63ca812f667219928f2f0dd3f9d846"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a081cae888e8e625929cfdda333eb9966"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a081cae888e8e625929cfdda333eb9966">ThreadID</a> () const override</td></tr>
<tr class="memdesc:a081cae888e8e625929cfdda333eb9966"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s identifier. <a href="#a081cae888e8e625929cfdda333eb9966">More...</a><br /></td></tr>
<tr class="separator:a081cae888e8e625929cfdda333eb9966"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab285ef89616ae6c9a48a9052bd917e37"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#ab285ef89616ae6c9a48a9052bd917e37">SuspendCount</a> () const override</td></tr>
<tr class="memdesc:ab285ef89616ae6c9a48a9052bd917e37"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s suspend count. <a href="#ab285ef89616ae6c9a48a9052bd917e37">More...</a><br /></td></tr>
<tr class="separator:ab285ef89616ae6c9a48a9052bd917e37"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c417edf90e36f67a6f8e0b76bfbdee5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a8c417edf90e36f67a6f8e0b76bfbdee5">Priority</a> () const override</td></tr>
<tr class="memdesc:a8c417edf90e36f67a6f8e0b76bfbdee5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the thread’s priority. <a href="#a8c417edf90e36f67a6f8e0b76bfbdee5">More...</a><br /></td></tr>
<tr class="separator:a8c417edf90e36f67a6f8e0b76bfbdee5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a546b936d58eb2ba4dec71914e41dd742"><td class="memItemLeft" align="right" valign="top"><a id="a546b936d58eb2ba4dec71914e41dd742"></a>
uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a546b936d58eb2ba4dec71914e41dd742">ThreadSpecificDataAddress</a> () const override</td></tr>
<tr class="memdesc:a546b936d58eb2ba4dec71914e41dd742"><td class="mdescLeft"> </td><td class="mdescRight">Returns the base address of a region used to store thread-specific data. <br /></td></tr>
<tr class="separator:a546b936d58eb2ba4dec71914e41dd742"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0af4437ee557f500f61b88c8a9a4b22"><td class="memItemLeft" align="right" valign="top">std::vector< const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#aa0af4437ee557f500f61b88c8a9a4b22">ExtraMemory</a> () const override</td></tr>
<tr class="memdesc:aa0af4437ee557f500f61b88c8a9a4b22"><td class="mdescLeft"> </td><td class="mdescRight">Returns a vector of additional memory blocks that should be included in a minidump. <a href="#aa0af4437ee557f500f61b88c8a9a4b22">More...</a><br /></td></tr>
<tr class="separator:aa0af4437ee557f500f61b88c8a9a4b22"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> of a thread in a running (or crashed) process on a macOS system. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a063a6cf88d16769775ddf98c7d8abf6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a063a6cf88d16769775ddf98c7d8abf6a">§ </a></span>Context()</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="structcrashpad_1_1CPUContext.html">CPUContext</a> * crashpad::internal::ThreadSnapshotMac::Context </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="structcrashpad_1_1CPUContext.html" title="A context structure capable of carrying the context of any supported CPU architecture. ">CPUContext</a> object corresponding to the thread’s CPU context. </p>
<p>The caller does not take ownership of this object, it is scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that it was obtained from. </p>
<p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a6e227ceaec1f06711d620a99631ec98a">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a id="aa0af4437ee557f500f61b88c8a9a4b22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0af4437ee557f500f61b88c8a9a4b22">§ </a></span>ExtraMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector< const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * > crashpad::internal::ThreadSnapshotMac::ExtraMemory </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a vector of additional memory blocks that should be included in a minidump. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> objects that will be included in the crash dump. The caller does not take ownership of these objects, they are scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that they were obtained from. </dd></dl>
<p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a983c5e668ae54cbf8f4348f95da4afc8">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a id="a7bb7d71110ccad4d4b74ce9c69a7fef3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7bb7d71110ccad4d4b74ce9c69a7fef3">§ </a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::internal::ThreadSnapshotMac::Initialize </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classcrashpad_1_1ProcessReader.html">ProcessReader</a> * </td>
<td class="paramname"><em>process_reader</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structcrashpad_1_1ProcessReader_1_1Thread.html">ProcessReader::Thread</a> & </td>
<td class="paramname"><em>process_reader_thread</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes the object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">process_reader</td><td>A <a class="el" href="classcrashpad_1_1ProcessReader.html" title="Accesses information about another process, identified by a Mach task. ">ProcessReader</a> for the task containing the thread. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">process_reader_thread</td><td>The thread within the <a class="el" href="classcrashpad_1_1ProcessReader.html" title="Accesses information about another process, identified by a Mach task. ">ProcessReader</a> for which the snapshot should be created.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the snapshot could be created, <code>false</code> otherwise with an appropriate message logged. </dd></dl>
</div>
</div>
<a id="a8c417edf90e36f67a6f8e0b76bfbdee5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c417edf90e36f67a6f8e0b76bfbdee5">§ </a></span>Priority()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int crashpad::internal::ThreadSnapshotMac::Priority </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thread’s priority. </p>
<p>Threads with higher priorities will have higher priority values. </p>
<p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#affbf3f8bee03bd703bc2833c4e714f70">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a id="a5b63ca812f667219928f2f0dd3f9d846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b63ca812f667219928f2f0dd3f9d846">§ </a></span>Stack()</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_1MemorySnapshot.html">MemorySnapshot</a> * crashpad::internal::ThreadSnapshotMac::Stack </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classcrashpad_1_1MemorySnapshot.html" title="An abstract interface to a snapshot representing a region of memory present in a snapshot process...">MemorySnapshot</a> object corresponding to the memory region that contains the thread’s stack, or <code>nullptr</code> if no stack region is available. </p>
<p>The caller does not take ownership of this object, it is scoped to the lifetime of the <a class="el" href="classcrashpad_1_1ThreadSnapshot.html" title="An abstract interface to a snapshot representing a thread (lightweight process) present in a snapshot...">ThreadSnapshot</a> object that it was obtained from. </p>
<p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a4f0eadc03965ea69a6b0462f878dd628">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a id="ab285ef89616ae6c9a48a9052bd917e37"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab285ef89616ae6c9a48a9052bd917e37">§ </a></span>SuspendCount()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int crashpad::internal::ThreadSnapshotMac::SuspendCount </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thread’s suspend count. </p>
<p>A suspend count of <code>0</code> denotes a schedulable (not suspended) thread. </p>
<p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#abe00a7e9cbc55366a545700517762d5c">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a id="a081cae888e8e625929cfdda333eb9966"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a081cae888e8e625929cfdda333eb9966">§ </a></span>ThreadID()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">uint64_t crashpad::internal::ThreadSnapshotMac::ThreadID </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">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thread’s identifier. </p>
<p>Thread identifiers are at least unique within a process, and may be unique system-wide. </p>
<p>Implements <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a3c953575fadb934cd5f163560df149da">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>snapshot/mac/thread_snapshot_mac.h</li>
<li>snapshot/mac/thread_snapshot_mac.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.12
</small></address>
</body>
</html>