crashpad/doc/generated/doxygen/classcrashpad_1_1ThreadInfo.html
2017-06-20 10:44:54 -04:00

235 lines
12 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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Crashpad: crashpad::ThreadInfo 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_1ThreadInfo.html">ThreadInfo</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_1ThreadInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ThreadInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<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:a0ec02afa2ca2f5f8c6a2be3ef496b043"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadInfo.html#a0ec02afa2ca2f5f8c6a2be3ef496b043">Initialize</a> (pid_t tid)</td></tr>
<tr class="memdesc:a0ec02afa2ca2f5f8c6a2be3ef496b043"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes this object with information about the thread whose ID is <em>tid</em>. <a href="#a0ec02afa2ca2f5f8c6a2be3ef496b043">More...</a><br /></td></tr>
<tr class="separator:a0ec02afa2ca2f5f8c6a2be3ef496b043"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83a4199f102db610b0e0ce6ef68ea2fc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadInfo.html#a83a4199f102db610b0e0ce6ef68ea2fc">Is64Bit</a> ()</td></tr>
<tr class="memdesc:a83a4199f102db610b0e0ce6ef68ea2fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines the target threads bitness. <a href="#a83a4199f102db610b0e0ce6ef68ea2fc">More...</a><br /></td></tr>
<tr class="separator:a83a4199f102db610b0e0ce6ef68ea2fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a865d36440a81857168338248660ae0fc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadInfo.html#a865d36440a81857168338248660ae0fc">GetGeneralPurposeRegisters</a> (<a class="el" href="unioncrashpad_1_1ThreadContext.html">ThreadContext</a> *context)</td></tr>
<tr class="memdesc:a865d36440a81857168338248660ae0fc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uses <code>ptrace</code> to collect general purpose registers from the target thread and places the result in <em>context</em>. <a href="#a865d36440a81857168338248660ae0fc">More...</a><br /></td></tr>
<tr class="separator:a865d36440a81857168338248660ae0fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9027c453da3f3d9b50dca67c626798db"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadInfo.html#a9027c453da3f3d9b50dca67c626798db">GetFloatingPointRegisters</a> (<a class="el" href="unioncrashpad_1_1FloatContext.html">FloatContext</a> *context)</td></tr>
<tr class="memdesc:a9027c453da3f3d9b50dca67c626798db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uses <code>ptrace</code> to collect floating point registers from the target thread and places the result in <em>context</em>. <a href="#a9027c453da3f3d9b50dca67c626798db">More...</a><br /></td></tr>
<tr class="separator:a9027c453da3f3d9b50dca67c626798db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a981c2bda049f3738ac499fa33b0c92b3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ThreadInfo.html#a981c2bda049f3738ac499fa33b0c92b3">GetThreadArea</a> (<a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> *address)</td></tr>
<tr class="memdesc:a981c2bda049f3738ac499fa33b0c92b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Uses <code>ptrace</code> to determine the thread-local storage address for the target thread and places the result in <em>address</em>. <a href="#a981c2bda049f3738ac499fa33b0c92b3">More...</a><br /></td></tr>
<tr class="separator:a981c2bda049f3738ac499fa33b0c92b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9027c453da3f3d9b50dca67c626798db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9027c453da3f3d9b50dca67c626798db">&#9670;&nbsp;</a></span>GetFloatingPointRegisters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ThreadInfo::GetFloatingPointRegisters </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unioncrashpad_1_1FloatContext.html">FloatContext</a> *&#160;</td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses <code>ptrace</code> to collect floating point registers from the target thread and places the result in <em>context</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">context</td><td>The registers read from the target thread.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> on success, with <em>context</em> set. Otherwise, <code>false</code> with a message logged. </dd></dl>
</div>
</div>
<a id="a865d36440a81857168338248660ae0fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a865d36440a81857168338248660ae0fc">&#9670;&nbsp;</a></span>GetGeneralPurposeRegisters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void crashpad::ThreadInfo::GetGeneralPurposeRegisters </td>
<td>(</td>
<td class="paramtype"><a class="el" href="unioncrashpad_1_1ThreadContext.html">ThreadContext</a> *&#160;</td>
<td class="paramname"><em>context</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses <code>ptrace</code> to collect general purpose registers from the target thread and places the result in <em>context</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">context</td><td>The registers read from the target thread. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a981c2bda049f3738ac499fa33b0c92b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a981c2bda049f3738ac499fa33b0c92b3">&#9670;&nbsp;</a></span>GetThreadArea()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ThreadInfo::GetThreadArea </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacecrashpad.html#acb197256391fbfca91f9a7e5c911db45">LinuxVMAddress</a> *&#160;</td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Uses <code>ptrace</code> to determine the thread-local storage address for the target thread and places the result in <em>address</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">address</td><td>The address of the TLS area.</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="a0ec02afa2ca2f5f8c6a2be3ef496b043"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ec02afa2ca2f5f8c6a2be3ef496b043">&#9670;&nbsp;</a></span>Initialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ThreadInfo::Initialize </td>
<td>(</td>
<td class="paramtype">pid_t&#160;</td>
<td class="paramname"><em>tid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes this object with information about the thread whose ID is <em>tid</em>. </p>
<p>This method must be called successfully prior to calling any other method in this class. This method may only be called once.</p>
<p>It is unspecified whether the information that an object of this class returns is loaded at the time <a class="el" href="classcrashpad_1_1ThreadInfo.html#a0ec02afa2ca2f5f8c6a2be3ef496b043" title="Initializes this object with information about the thread whose ID is tid. ">Initialize()</a> is called or subsequently, and whether this information is cached in the object or not.</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 to obtain information for.</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="a83a4199f102db610b0e0ce6ef68ea2fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83a4199f102db610b0e0ce6ef68ea2fc">&#9670;&nbsp;</a></span>Is64Bit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool crashpad::ThreadInfo::Is64Bit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines the target threads bitness. </p>
<dl class="section return"><dt>Returns</dt><dd><code>true</code> if the target is 64-bit. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>util/linux/thread_info.h</li>
<li>util/linux/thread_info.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.13
</small></address>
</body>
</html>