3party/crashpad
0
0
Fork 0
mirror of https://github.com/chromium/crashpad.git synced 2025-03-22 20:03:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
crashpad/doc/generated/doxygen/classcrashpad_1_1ExceptionSnapshot.html
Mark Mentovai e068bac8d7 Check in generated documentation
2015-10-08 14:55:01 -04:00

330 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.9.1"/>
<title>Crashpad: crashpad::ExceptionSnapshot 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 style="padding-left: 0.5em;">
<div id="projectname">Crashpad
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<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="classcrashpad_1_1ExceptionSnapshot.html">ExceptionSnapshot</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_1ExceptionSnapshot-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">crashpad::ExceptionSnapshot Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>An abstract interface to a snapshot representing an exception that a snapshot process sustained and triggered the snapshot being taken.
<a href="classcrashpad_1_1ExceptionSnapshot.html#details">More...</a></p>
<p><code>#include &quot;snapshot/exception_snapshot.h&quot;</code></p>
<div class="dynheader">
Inheritance diagram for crashpad::ExceptionSnapshot:</div>
<div class="dyncontent">
<div class="center">
<img src="classcrashpad_1_1ExceptionSnapshot.png" usemap="#crashpad::ExceptionSnapshot_map" alt=""/>
<map id="crashpad::ExceptionSnapshot_map" name="crashpad::ExceptionSnapshot_map">
<area href="classcrashpad_1_1internal_1_1ExceptionSnapshotMac.html" title="An ExceptionSnapshot of an exception sustained by a running (or crashed) process on a Mac OS X system..." alt="crashpad::internal::ExceptionSnapshotMac" shape="rect" coords="0,56,251,80"/>
<area href="classcrashpad_1_1internal_1_1ExceptionSnapshotWin.html" alt="crashpad::internal::ExceptionSnapshotWin" shape="rect" coords="261,56,512,80"/>
<area href="classcrashpad_1_1test_1_1TestExceptionSnapshot.html" title="A test ExceptionSnapshot that can carry arbitrary data for testing purposes. " alt="crashpad::test::TestExceptionSnapshot" shape="rect" coords="522,56,773,80"/>
</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:a9ba62f24e17805f436feda32c01f353e"><td class="memItemLeft" align="right" valign="top">virtual const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#a9ba62f24e17805f436feda32c01f353e">Context</a> () const =0</td></tr>
<tr class="memdesc:a9ba62f24e17805f436feda32c01f353e"><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 exception thread’s CPU context at the time of the exception. <a href="#a9ba62f24e17805f436feda32c01f353e">More...</a><br /></td></tr>
<tr class="separator:a9ba62f24e17805f436feda32c01f353e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef11b2d8ffb00bb38688e09c0b62ac51"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#aef11b2d8ffb00bb38688e09c0b62ac51">ThreadID</a> () const =0</td></tr>
<tr class="memdesc:aef11b2d8ffb00bb38688e09c0b62ac51"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thread identifier of the thread that triggered the exception. <a href="#aef11b2d8ffb00bb38688e09c0b62ac51">More...</a><br /></td></tr>
<tr class="separator:aef11b2d8ffb00bb38688e09c0b62ac51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af73f1ae2f0572a10bd1b62dee1472607"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#af73f1ae2f0572a10bd1b62dee1472607">Exception</a> () const =0</td></tr>
<tr class="memdesc:af73f1ae2f0572a10bd1b62dee1472607"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the top-level exception code identifying the exception. <a href="#af73f1ae2f0572a10bd1b62dee1472607">More...</a><br /></td></tr>
<tr class="separator:af73f1ae2f0572a10bd1b62dee1472607"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1c97187c37fa378252415f7f3b4e6cb"><td class="memItemLeft" align="right" valign="top">virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#ae1c97187c37fa378252415f7f3b4e6cb">ExceptionInfo</a> () const =0</td></tr>
<tr class="memdesc:ae1c97187c37fa378252415f7f3b4e6cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the second-level exception code identifying the exception. <a href="#ae1c97187c37fa378252415f7f3b4e6cb">More...</a><br /></td></tr>
<tr class="separator:ae1c97187c37fa378252415f7f3b4e6cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a12bf01b499037e2ad642d5e131f23f86"><td class="memItemLeft" align="right" valign="top">virtual uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#a12bf01b499037e2ad642d5e131f23f86">ExceptionAddress</a> () const =0</td></tr>
<tr class="memdesc:a12bf01b499037e2ad642d5e131f23f86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the address that triggered the exception. <a href="#a12bf01b499037e2ad642d5e131f23f86">More...</a><br /></td></tr>
<tr class="separator:a12bf01b499037e2ad642d5e131f23f86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b98ff58b73e105c39ccba39dad5a2d7"><td class="memItemLeft" align="right" valign="top">virtual const std::vector&lt; uint64_t &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#a1b98ff58b73e105c39ccba39dad5a2d7">Codes</a> () const =0</td></tr>
<tr class="memdesc:a1b98ff58b73e105c39ccba39dad5a2d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns a series of operating system-specific exception codes. <a href="#a1b98ff58b73e105c39ccba39dad5a2d7">More...</a><br /></td></tr>
<tr class="separator:a1b98ff58b73e105c39ccba39dad5a2d7"><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>An abstract interface to a snapshot representing an exception that a snapshot process sustained and triggered the snapshot being taken. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1b98ff58b73e105c39ccba39dad5a2d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const std::vector&lt;uint64_t&gt;&amp; crashpad::ExceptionSnapshot::Codes </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a series of operating system-specific exception codes. </p>
<p>The precise interpretation of these codes is specific to the snapshot operating system. These codes may provide a duplicate of information available elsewhere, they may extend information available elsewhere, or they may not be present at all. In this case, an empty vector will be returned.</p>
<p>For Mac OS X, this will be a vector containing the original exception type and the values of <code>code[0]</code> and <code>code[1]</code> as received by a Mach exception handler.</p>
<p>For Windows, these are additional arguments (if any) as provided to <code>RaiseException()</code>. See the documentation for <code><a class="el" href="structcrashpad_1_1ExceptionInformation.html" title="Structure read out of the client process by the crash handler when an exception occurs. ">ExceptionInformation</a></code> in <code>EXCEPTION_RECORD</code>. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotMac.html#a3179b8de3f86e150cf6d1d3078dd8109">crashpad::internal::ExceptionSnapshotMac</a>, <a class="el" href="classcrashpad_1_1test_1_1TestExceptionSnapshot.html#afd83da0b687967809bbe2bb663b57298">crashpad::test::TestExceptionSnapshot</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotWin.html#a9e062aaf208e2e20ba68b407b9bfd950">crashpad::internal::ExceptionSnapshotWin</a>.</p>
</div>
</div>
<a class="anchor" id="a9ba62f24e17805f436feda32c01f353e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual const <a class="el" href="structcrashpad_1_1CPUContext.html">CPUContext</a>* crashpad::ExceptionSnapshot::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">pure 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 exception thread’s CPU context at the time of the exception. </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>Implemented in <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotMac.html#aeebb43d42ba7f1eacd06bc82399055cd">crashpad::internal::ExceptionSnapshotMac</a>, <a class="el" href="classcrashpad_1_1test_1_1TestExceptionSnapshot.html#ae199229ad7ab258d823fcb86cae9bd17">crashpad::test::TestExceptionSnapshot</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotWin.html#ab4c2e6947c052aa9d0ded95b5be72de1">crashpad::internal::ExceptionSnapshotWin</a>.</p>
</div>
</div>
<a class="anchor" id="af73f1ae2f0572a10bd1b62dee1472607"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t crashpad::ExceptionSnapshot::Exception </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the top-level exception code identifying the exception. </p>
<p>This is an operating system-specific value.</p>
<p>For Mac OS X, this will be an <a class="el" href="non__mac_2mach_2mach_8h.html#EXC_x">EXC_*</a> exception type, such as <code>EXC_BAD_ACCESS</code>. <code>EXC_CRASH</code> will not appear here for exceptions processed as <code>EXC_CRASH</code> when generated from another preceding exception: the original exception code will appear instead. The exception type as it was received will appear at index 0 of <a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#a1b98ff58b73e105c39ccba39dad5a2d7" title="Returns a series of operating system-specific exception codes. ">Codes()</a>.</p>
<p>For Windows, this will be an EXCEPTION_* exception type such as <code>EXCEPTION_ACCESS_VIOLATION</code>. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotMac.html#a12e7d80c0c92e30df5f90d6386b92c3f">crashpad::internal::ExceptionSnapshotMac</a>, <a class="el" href="classcrashpad_1_1test_1_1TestExceptionSnapshot.html#afa83c6fa95e27e90b29f0b537c561094">crashpad::test::TestExceptionSnapshot</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotWin.html#a8083efff504bd812e2de87bfbf3d9547">crashpad::internal::ExceptionSnapshotWin</a>.</p>
</div>
</div>
<a class="anchor" id="a12bf01b499037e2ad642d5e131f23f86"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t crashpad::ExceptionSnapshot::ExceptionAddress </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the address that triggered the exception. </p>
<p>This may be the address that caused a fault on data access, or it may be the instruction pointer that contained an offending instruction. For exceptions where this value cannot be determined, it will be <code>0</code>.</p>
<p>For Mac OS X, this will be the value of the exception code at index 1 as received by a Mach exception handler. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotMac.html#a1dd9dba7bdf05e485d4307d05d0d1c13">crashpad::internal::ExceptionSnapshotMac</a>, <a class="el" href="classcrashpad_1_1test_1_1TestExceptionSnapshot.html#aa770edbae31d5d00af25d1101a1ca51d">crashpad::test::TestExceptionSnapshot</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotWin.html#a8d42e828a3f6768b21114fc1f20c03d3">crashpad::internal::ExceptionSnapshotWin</a>.</p>
</div>
</div>
<a class="anchor" id="ae1c97187c37fa378252415f7f3b4e6cb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint32_t crashpad::ExceptionSnapshot::ExceptionInfo </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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the second-level exception code identifying the exception. </p>
<p>This is an operating system-specific value.</p>
<p>For Mac OS X, this will be the value of the exception code at index 0 as received by a Mach exception handler, except:</p><ul>
<li>For <code>EXC_CRASH</code> exceptions generated from another preceding exception, the original exception code will appear here, not the code as received by the Mach exception handler.</li>
<li>For <code>EXC_RESOURCE</code> and <code>EXC_GUARD</code> exceptions, the high 32 bits of the exception code at index 0 will appear here.</li>
</ul>
<p>In all cases on Mac OS X, the full exception code at index 0 as it was received will appear at index 1 of <a class="el" href="classcrashpad_1_1ExceptionSnapshot.html#a1b98ff58b73e105c39ccba39dad5a2d7" title="Returns a series of operating system-specific exception codes. ">Codes()</a>.</p>
<p>On Windows, this will either be <code>0</code> if the exception is continuable, or <code>EXCEPTION_NONCONTINUABLE</code> to indicate a noncontinuable exception. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotMac.html#a9ab56e1477da32b5d017b6603aed9c87">crashpad::internal::ExceptionSnapshotMac</a>, <a class="el" href="classcrashpad_1_1test_1_1TestExceptionSnapshot.html#a28c1706545fcac448a770e09341d92ea">crashpad::test::TestExceptionSnapshot</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotWin.html#a5977dded1385688030a667ac1fafaa51">crashpad::internal::ExceptionSnapshotWin</a>.</p>
</div>
</div>
<a class="anchor" id="aef11b2d8ffb00bb38688e09c0b62ac51"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual uint64_t crashpad::ExceptionSnapshot::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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the thread identifier of the thread that triggered the exception. </p>
<p>This value can be compared to <a class="el" href="classcrashpad_1_1ThreadSnapshot.html#a3c953575fadb934cd5f163560df149da" title="Returns the thread’s identifier. ">ThreadSnapshot::ThreadID()</a> to associate an <a class="el" href="classcrashpad_1_1ExceptionSnapshot.html" title="An abstract interface to a snapshot representing an exception that a snapshot process sustained and t...">ExceptionSnapshot</a> object with 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> that contains a snapshot of the thread that triggered the exception. </p>
<p>Implemented in <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotMac.html#a3685b418dfcf4bafc81b81dbb8b80db9">crashpad::internal::ExceptionSnapshotMac</a>, <a class="el" href="classcrashpad_1_1test_1_1TestExceptionSnapshot.html#a94d06ac7c4022fbff1acd2c37cb85e54">crashpad::test::TestExceptionSnapshot</a>, and <a class="el" href="classcrashpad_1_1internal_1_1ExceptionSnapshotWin.html#a140f74a35257a73faca6b0e2d8f04f44">crashpad::internal::ExceptionSnapshotWin</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>snapshot/exception_snapshot.h</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.9.1
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink