summaryrefslogtreecommitdiffstats
path: root/lldb/www/cpp_reference/html/SBMemoryRegionInfo_8h_source.html
blob: 53a70c1c4bc5b1962455ef65598f0caa80e7e86e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<!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: SBMemoryRegionInfo.h Source File</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><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_6b47ac86da6aee9115280ffa56155f66.html">llvm</a></li><li class="navelem"><a class="el" href="dir_b8cffa74dcb91bca0da221349fa85523.html">tools</a></li><li class="navelem"><a class="el" href="dir_bdcf59bf838c999fcfc3dde87d35c9f0.html">lldb</a></li><li class="navelem"><a class="el" href="dir_42333c9da4438c4e48b6683e9ba44a59.html">include</a></li><li class="navelem"><a class="el" href="dir_30e71e610673c7b74c5ccda0fc334ee9.html">lldb</a></li><li class="navelem"><a class="el" href="dir_65cab015c1f428073772d528e6a1b53d.html">API</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">SBMemoryRegionInfo.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="SBMemoryRegionInfo_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">//===-- SBMemoryRegionInfo.h ------------------------------------*- C++ -*-===//</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">//                     The LLVM Compiler Infrastructure</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">// This file is distributed under the University of Illinois Open Source</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">// License. See LICENSE.TXT for details.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">//===----------------------------------------------------------------------===//</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;</div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#ifndef LLDB_SBMemoryRegionInfo_h_</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define LLDB_SBMemoryRegionInfo_h_</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="SBData_8h.html">lldb/API/SBData.h</a>&quot;</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="SBDefines_8h.html">lldb/API/SBDefines.h</a>&quot;</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="keyword">namespace </span>lldb {</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="classlldb_1_1SBMemoryRegionInfo.html">   18</a></span>&#160;<span class="keyword">class </span>LLDB_API <a class="code" href="classlldb_1_1SBMemoryRegionInfo.html">SBMemoryRegionInfo</a> {</div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;  <a class="code" href="namespacelldb.html#a9ca218f1326373259ab4220c37690133">SBMemoryRegionInfo</a>();</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;  <a class="code" href="namespacelldb.html#a9ca218f1326373259ab4220c37690133">SBMemoryRegionInfo</a>(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs);</div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;  ~<a class="code" href="classlldb_1_1SBMemoryRegionInfo.html">SBMemoryRegionInfo</a>();</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;  <span class="keyword">const</span> <a class="code" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;  operator=(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs);</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;  <span class="keywordtype">void</span> Clear();</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;  <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment">  /// Get the base address of this memory range.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment">  ///</span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">  /// @return</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">  ///     The base address of this memory range.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment"></span>  <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;  lldb::addr_t GetRegionBase();</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">  /// Get the end address of this memory range.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">  ///</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment">  /// @return</span></div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment">  ///     The base address of this memory range.</span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment"></span>  <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  lldb::addr_t GetRegionEnd();</div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment">  /// Check if this memory address is marked readable to the process.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">  ///</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">  /// @return</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">  ///     true if this memory address is marked readable</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"></span>  <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="keywordtype">bool</span> IsReadable();</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">  /// Check if this memory address is marked writable to the process.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">  ///</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment">  /// @return</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">  ///     true if this memory address is marked writable</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"></span>  <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  <span class="keywordtype">bool</span> IsWritable();</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment">  /// Check if this memory address is marked executable to the process.</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">  ///</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">  /// @return</span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">  ///     true if this memory address is marked executable</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"></span>  <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="keywordtype">bool</span> IsExecutable();</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment">  /// Check if this memory address is mapped into the process address</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">  /// space.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment">  ///</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment">  /// @return</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment">  ///     true if this memory address is in the process address space.</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"></span>  <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;  <span class="keywordtype">bool</span> IsMapped();</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;  <span class="comment">//------------------------------------------------------------------</span><span class="comment"></span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment">  /// Returns the name of the memory region mapped at the given</span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">  /// address.</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">  ///</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">  /// @return</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment">  ///     In case of memory mapped files it is the absolute path of</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment">  ///     the file otherwise it is a name associated with the memory</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment">  ///     region. If no name can be determined the returns nullptr.</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"></span>  <span class="comment">//------------------------------------------------------------------</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  <span class="keyword">const</span> <span class="keywordtype">char</span> *GetName();</div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;  <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a> &amp;rhs) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;  <span class="keywordtype">bool</span> GetDescription(<a class="code" href="classlldb_1_1SBStream.html">lldb::SBStream</a> &amp;description);</div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00098"></a><span class="lineno"><a class="line" href="classlldb_1_1SBMemoryRegionInfo.html#a3392eea8d13e7395ee1e04a2b733e19b">   98</a></span>&#160;  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBProcess.html">SBProcess</a>;</div>
<div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="classlldb_1_1SBMemoryRegionInfo.html#ada27668bd5d1f822b8766a48f550d460">   99</a></span>&#160;  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classlldb_1_1SBMemoryRegionInfoList.html">SBMemoryRegionInfoList</a>;</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  lldb_private::MemoryRegionInfo &amp;ref();</div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;</div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  <span class="keyword">const</span> lldb_private::MemoryRegionInfo &amp;ref() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;</div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  <a class="code" href="namespacelldb.html#a9ca218f1326373259ab4220c37690133">SBMemoryRegionInfo</a>(<span class="keyword">const</span> lldb_private::MemoryRegionInfo *lldb_object_ptr);</div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;</div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;  lldb::MemoryRegionInfoUP m_opaque_ap;</div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;};</div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;} <span class="comment">// namespace lldb</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="preprocessor">#endif // LLDB_SBMemoryRegionInfo_h_</span></div>
<div class="ttc" id="classlldb_1_1SBMemoryRegionInfo_html"><div class="ttname"><a href="classlldb_1_1SBMemoryRegionInfo.html">lldb::SBMemoryRegionInfo</a></div><div class="ttdef"><b>Definition:</b> <a href="SBMemoryRegionInfo_8h_source.html#l00018">SBMemoryRegionInfo.h:18</a></div></div>
<div class="ttc" id="SBDefines_8h_html"><div class="ttname"><a href="SBDefines_8h.html">SBDefines.h</a></div></div>
<div class="ttc" id="namespacelldb_html_a9ca218f1326373259ab4220c37690133"><div class="ttname"><a href="namespacelldb.html#a9ca218f1326373259ab4220c37690133">lldb::SBMemoryRegionInfo</a></div><div class="ttdeci">class LLDB_API SBMemoryRegionInfo</div><div class="ttdef"><b>Definition:</b> <a href="SBDefines_8h_source.html#l00062">SBDefines.h:62</a></div></div>
<div class="ttc" id="SBData_8h_html"><div class="ttname"><a href="SBData_8h.html">SBData.h</a></div></div>
<div class="ttc" id="classlldb_1_1SBProcess_html"><div class="ttname"><a href="classlldb_1_1SBProcess.html">lldb::SBProcess</a></div><div class="ttdef"><b>Definition:</b> <a href="SBProcess_8h_source.html#l00023">SBProcess.h:23</a></div></div>
<div class="ttc" id="classlldb_1_1SBMemoryRegionInfoList_html"><div class="ttname"><a href="classlldb_1_1SBMemoryRegionInfoList.html">lldb::SBMemoryRegionInfoList</a></div><div class="ttdef"><b>Definition:</b> <a href="SBMemoryRegionInfoList_8h_source.html#l00019">SBMemoryRegionInfoList.h:19</a></div></div>
<div class="ttc" id="classlldb_1_1SBStream_html"><div class="ttname"><a href="classlldb_1_1SBStream.html">lldb::SBStream</a></div><div class="ttdef"><b>Definition:</b> <a href="SBStream_8h_source.html#l00019">SBStream.h:19</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<hr>
<p class="footer">
Generated on Fri Oct 14 2016 14:01:23 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>
OpenPOWER on IntegriCloud