blob: 708a79f16d7a56bc151064e4f4fb91c4379ff6d0 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="keywords" content="LLDB,C++,doxygen,API,documentation"/>
<meta name="description" content="C++ source code API documentation for LLDB."/>
<title>LLVM: lldb::SBMemoryRegionInfo Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head><body>
<p class="title">LLDB API Documentation</p>
<!-- Generated by Doxygen 1.8.6 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</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>
</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="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacelldb.html">lldb</a></li><li class="navelem"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">SBMemoryRegionInfo</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classlldb_1_1SBMemoryRegionInfo-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">lldb::SBMemoryRegionInfo Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="SBMemoryRegionInfo_8h_source.html">SBMemoryRegionInfo.h</a>&gt;</code></p>
<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:ab69f10fefdb15d7726fa2cec2dd6d522"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#ab69f10fefdb15d7726fa2cec2dd6d522">SBMemoryRegionInfo</a> ()</td></tr>
<tr class="separator:ab69f10fefdb15d7726fa2cec2dd6d522"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa580f92ff9037887946c56b529f721e2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#aa580f92ff9037887946c56b529f721e2">SBMemoryRegionInfo</a> (const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs)</td></tr>
<tr class="separator:aa580f92ff9037887946c56b529f721e2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4362d27f6531b5d768e2ed351d6387fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a4362d27f6531b5d768e2ed351d6387fd">~SBMemoryRegionInfo</a> ()</td></tr>
<tr class="separator:a4362d27f6531b5d768e2ed351d6387fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0432216654f69a942296183595783ca"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#ae0432216654f69a942296183595783ca">operator=</a> (const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs)</td></tr>
<tr class="separator:ae0432216654f69a942296183595783ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7a74c3d56e709f7347f66399d24a1d0"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#ae7a74c3d56e709f7347f66399d24a1d0">Clear</a> ()</td></tr>
<tr class="separator:ae7a74c3d56e709f7347f66399d24a1d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedd03a04af6bc20fcfb09be1d54ecd95"><td class="memItemLeft" align="right" valign="top">lldb::addr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#aedd03a04af6bc20fcfb09be1d54ecd95">GetRegionBase</a> ()</td></tr>
<tr class="separator:aedd03a04af6bc20fcfb09be1d54ecd95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95e6e1304dc445ee642eaa65e639f51b"><td class="memItemLeft" align="right" valign="top">lldb::addr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a95e6e1304dc445ee642eaa65e639f51b">GetRegionEnd</a> ()</td></tr>
<tr class="separator:a95e6e1304dc445ee642eaa65e639f51b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ade674dd0d2668a52507a9eff27964a74"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#ade674dd0d2668a52507a9eff27964a74">IsReadable</a> ()</td></tr>
<tr class="separator:ade674dd0d2668a52507a9eff27964a74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a912eb4664f9b21b7a55e8760b887971f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a912eb4664f9b21b7a55e8760b887971f">IsWritable</a> ()</td></tr>
<tr class="separator:a912eb4664f9b21b7a55e8760b887971f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5681e013a101b7d1c7b63e306a72b49a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a5681e013a101b7d1c7b63e306a72b49a">IsExecutable</a> ()</td></tr>
<tr class="separator:a5681e013a101b7d1c7b63e306a72b49a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a853c2e16e4617c4c5ca1c9ca946c40d4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a853c2e16e4617c4c5ca1c9ca946c40d4">IsMapped</a> ()</td></tr>
<tr class="separator:a853c2e16e4617c4c5ca1c9ca946c40d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b9b9a5959b24f2b2f0499680dc85624"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a5b9b9a5959b24f2b2f0499680dc85624">GetName</a> ()</td></tr>
<tr class="separator:a5b9b9a5959b24f2b2f0499680dc85624"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab43b7d27dc79d0178f11d7c653dc9f6a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#ab43b7d27dc79d0178f11d7c653dc9f6a">operator==</a> (const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs) const </td></tr>
<tr class="separator:ab43b7d27dc79d0178f11d7c653dc9f6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6194c6ad5dcb83cb3cf957a31368d21f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a6194c6ad5dcb83cb3cf957a31368d21f">operator!=</a> (const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs) const </td></tr>
<tr class="separator:a6194c6ad5dcb83cb3cf957a31368d21f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3af7060bb163c0d8408e2aa213204da4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a3af7060bb163c0d8408e2aa213204da4">GetDescription</a> (<a class="el" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;description)</td></tr>
<tr class="separator:a3af7060bb163c0d8408e2aa213204da4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a3392eea8d13e7395ee1e04a2b733e19b"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#a3392eea8d13e7395ee1e04a2b733e19b">SBProcess</a></td></tr>
<tr class="separator:a3392eea8d13e7395ee1e04a2b733e19b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada27668bd5d1f822b8766a48f550d460"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classlldb_1_1SBMemoryRegionInfo.html#ada27668bd5d1f822b8766a48f550d460">SBMemoryRegionInfoList</a></td></tr>
<tr class="separator:ada27668bd5d1f822b8766a48f550d460"><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>Definition at line <a class="el" href="SBMemoryRegionInfo_8h_source.html#l00018">18</a> of file <a class="el" href="SBMemoryRegionInfo_8h_source.html">SBMemoryRegionInfo.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab69f10fefdb15d7726fa2cec2dd6d522"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBMemoryRegionInfo::SBMemoryRegionInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aa580f92ff9037887946c56b529f721e2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBMemoryRegionInfo::SBMemoryRegionInfo </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4362d27f6531b5d768e2ed351d6387fd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::SBMemoryRegionInfo::~SBMemoryRegionInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ae7a74c3d56e709f7347f66399d24a1d0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void lldb::SBMemoryRegionInfo::Clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3af7060bb163c0d8408e2aa213204da4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBMemoryRegionInfo::GetDescription </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;&#160;</td>
<td class="paramname"><em>description</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5b9b9a5959b24f2b2f0499680dc85624"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* lldb::SBMemoryRegionInfo::GetName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the name of the memory region mapped at the given address.</p>
<dl class="section return"><dt>Returns</dt><dd>In case of memory mapped files it is the absolute path of the file otherwise it is a name associated with the memory region. If no name can be determined the returns nullptr. </dd></dl>
</div>
</div>
<a class="anchor" id="aedd03a04af6bc20fcfb09be1d54ecd95"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::addr_t lldb::SBMemoryRegionInfo::GetRegionBase </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the base address of this memory range.</p>
<dl class="section return"><dt>Returns</dt><dd>The base address of this memory range. </dd></dl>
</div>
</div>
<a class="anchor" id="a95e6e1304dc445ee642eaa65e639f51b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">lldb::addr_t lldb::SBMemoryRegionInfo::GetRegionEnd </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the end address of this memory range.</p>
<dl class="section return"><dt>Returns</dt><dd>The base address of this memory range. </dd></dl>
</div>
</div>
<a class="anchor" id="a5681e013a101b7d1c7b63e306a72b49a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBMemoryRegionInfo::IsExecutable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if this memory address is marked executable to the process.</p>
<dl class="section return"><dt>Returns</dt><dd>true if this memory address is marked executable </dd></dl>
</div>
</div>
<a class="anchor" id="a853c2e16e4617c4c5ca1c9ca946c40d4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBMemoryRegionInfo::IsMapped </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if this memory address is mapped into the process address space.</p>
<dl class="section return"><dt>Returns</dt><dd>true if this memory address is in the process address space. </dd></dl>
</div>
</div>
<a class="anchor" id="ade674dd0d2668a52507a9eff27964a74"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBMemoryRegionInfo::IsReadable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if this memory address is marked readable to the process.</p>
<dl class="section return"><dt>Returns</dt><dd>true if this memory address is marked readable </dd></dl>
</div>
</div>
<a class="anchor" id="a912eb4664f9b21b7a55e8760b887971f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBMemoryRegionInfo::IsWritable </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if this memory address is marked writable to the process.</p>
<dl class="section return"><dt>Returns</dt><dd>true if this memory address is marked writable </dd></dl>
</div>
</div>
<a class="anchor" id="a6194c6ad5dcb83cb3cf957a31368d21f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBMemoryRegionInfo::operator!= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae0432216654f69a942296183595783ca"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a>&amp; lldb::SBMemoryRegionInfo::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ab43b7d27dc79d0178f11d7c653dc9f6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool lldb::SBMemoryRegionInfo::operator== </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;&#160;</td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="ada27668bd5d1f822b8766a48f550d460"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classlldb_1_1SBMemoryRegionInfoList.html">SBMemoryRegionInfoList</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SBMemoryRegionInfo_8h_source.html#l00099">99</a> of file <a class="el" href="SBMemoryRegionInfo_8h_source.html">SBMemoryRegionInfo.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3392eea8d13e7395ee1e04a2b733e19b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classlldb_1_1SBProcess.html">SBProcess</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="SBMemoryRegionInfo_8h_source.html#l00098">98</a> of file <a class="el" href="SBMemoryRegionInfo_8h_source.html">SBMemoryRegionInfo.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="SBMemoryRegionInfo_8h_source.html">SBMemoryRegionInfo.h</a></li>
</ul>
</div><!-- contents -->
<hr>
<p class="footer">
Generated on Fri Oct 14 2016 14:01:24 for <a href="http://lldb.llvm.org/">LLVM</a> by
<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
align="middle" border="0"/>1.8.6</a><br>
Copyright &copy; 2003-2013 University of Illinois at Urbana-Champaign.
All Rights Reserved.</p>
<hr>
<!--#include virtual="/attrib.incl" -->
</body>
</html>