3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2025-03-21 19:23:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
crashpad/doc/generated/doxygen/classcrashpad_1_1internal_1_1ThreadSnapshotMac.html
Mark Mentovai c0ed6e4707 Update documentation to master 330adfb02984
2016-01-06 16:09:15 -05:00

362 lines
21 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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.10"/>
<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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="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.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</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> &#124;
<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 Mac OS X system.
<a href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#details">More...</a></p>
<p><code>#include &quot;snapshot/mac/thread_snapshot_mac.h&quot;</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&lt; internal::ThreadSnapshotMac &gt;" 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&#160;</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> &amp;process_reader_thread)</td></tr>
<tr class="memdesc:a7bb7d71110ccad4d4b74ce9c69a7fef3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes the object. <a href="#a7bb7d71110ccad4d4b74ce9c69a7fef3">More...</a><br /></td></tr>
<tr class="separator:a7bb7d71110ccad4d4b74ce9c69a7fef3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc67b86bdcb38a50651b14a39b9c2036"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#acc67b86bdcb38a50651b14a39b9c2036">Context</a> () const override</td></tr>
<tr class="memdesc:acc67b86bdcb38a50651b14a39b9c2036"><td class="mdescLeft">&#160;</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="#acc67b86bdcb38a50651b14a39b9c2036">More...</a><br /></td></tr>
<tr class="separator:acc67b86bdcb38a50651b14a39b9c2036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae24a61b5890c07c1c50be4fb838c6e61"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#ae24a61b5890c07c1c50be4fb838c6e61">Stack</a> () const override</td></tr>
<tr class="memdesc:ae24a61b5890c07c1c50be4fb838c6e61"><td class="mdescLeft">&#160;</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="#ae24a61b5890c07c1c50be4fb838c6e61">More...</a><br /></td></tr>
<tr class="separator:ae24a61b5890c07c1c50be4fb838c6e61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89206c3a5253874266e955d03a5e5de2"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a89206c3a5253874266e955d03a5e5de2">ThreadID</a> () const override</td></tr>
<tr class="memdesc:a89206c3a5253874266e955d03a5e5de2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thread’s identifier. <a href="#a89206c3a5253874266e955d03a5e5de2">More...</a><br /></td></tr>
<tr class="separator:a89206c3a5253874266e955d03a5e5de2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2356fd633378e2bdfe4355f07a4509d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#aa2356fd633378e2bdfe4355f07a4509d">SuspendCount</a> () const override</td></tr>
<tr class="memdesc:aa2356fd633378e2bdfe4355f07a4509d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thread’s suspend count. <a href="#aa2356fd633378e2bdfe4355f07a4509d">More...</a><br /></td></tr>
<tr class="separator:aa2356fd633378e2bdfe4355f07a4509d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b75256da46e63543298475d64c99697"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a4b75256da46e63543298475d64c99697">Priority</a> () const override</td></tr>
<tr class="memdesc:a4b75256da46e63543298475d64c99697"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thread’s priority. <a href="#a4b75256da46e63543298475d64c99697">More...</a><br /></td></tr>
<tr class="separator:a4b75256da46e63543298475d64c99697"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b639bf5fe18335a6ee8b951305de729"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0b639bf5fe18335a6ee8b951305de729"></a>
uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#a0b639bf5fe18335a6ee8b951305de729">ThreadSpecificDataAddress</a> () const override</td></tr>
<tr class="memdesc:a0b639bf5fe18335a6ee8b951305de729"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the base address of a region used to store thread-specific data. <br /></td></tr>
<tr class="separator:a0b639bf5fe18335a6ee8b951305de729"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebd4b9ebe83af0e8c7581eac590d68eb"><td class="memItemLeft" align="right" valign="top">std::vector&lt; const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1internal_1_1ThreadSnapshotMac.html#aebd4b9ebe83af0e8c7581eac590d68eb">ExtraMemory</a> () const override</td></tr>
<tr class="memdesc:aebd4b9ebe83af0e8c7581eac590d68eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a vector of additional memory blocks that should be included in a minidump. <a href="#aebd4b9ebe83af0e8c7581eac590d68eb">More...</a><br /></td></tr>
<tr class="separator:aebd4b9ebe83af0e8c7581eac590d68eb"><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>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 Mac OS X system. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acc67b86bdcb38a50651b14a39b9c2036"></a>
<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#a50f10ede534f63a4c4ce75f4021666ae">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a class="anchor" id="aebd4b9ebe83af0e8c7581eac590d68eb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; const <a class="el" href="classcrashpad_1_1MemorySnapshot.html">MemorySnapshot</a> * &gt; 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#aa10a563fdf24cf2b321ef8f0f92829d2">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a class="anchor" id="a7bb7d71110ccad4d4b74ce9c69a7fef3"></a>
<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> *&#160;</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> &amp;&#160;</td>
<td class="paramname"><em>process_reader_thread</em>&#160;</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 class="anchor" id="a4b75256da46e63543298475d64c99697"></a>
<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#abc92d204f84b7e533068f924c195195c">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a class="anchor" id="ae24a61b5890c07c1c50be4fb838c6e61"></a>
<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#a4fd160661141c262db7f10b6aba146b7">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a class="anchor" id="aa2356fd633378e2bdfe4355f07a4509d"></a>
<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#a1d999ae7a68cc7a15e54e84abf875df0">crashpad::ThreadSnapshot</a>.</p>
</div>
</div>
<a class="anchor" id="a89206c3a5253874266e955d03a5e5de2"></a>
<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#a21b11bab41a09226db8cdb6e629ebfc4">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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink