-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBinaryAnalysis_2Utility_8h_source.html
121 lines (121 loc) · 13.9 KB
/
BinaryAnalysis_2Utility_8h_source.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>ROSE: Utility.h Source File</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/search.js"></script>
<link rel="search" href="search_opensearch.php?v=opensearch.xml" type="application/opensearchdescription+xml" title="ROSE"/>
<link href="roseDoxygen.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 id="projectrow">
<td id="projectalign">
<div id="projectname">ROSE<span id="projectnumber"> 0.11.145.141</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,true,'search.html','Search');
$(document).ready(function() {
if ($('.searchresults').length > 0) { searchBox.DOMSearchField().focus(); }
});
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_9e62d0ec1b5e35066c963e582c20357f.html">Rose</a></li><li class="navelem"><a class="el" href="dir_b6b36e208517412b6f28695766cc080b.html">BinaryAnalysis</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">BinaryAnalysis/Utility.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">// This file contains binary analysis utilities that are either not a critical part of the analysis framework, or which cannot</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">// be easily incorporated into the main header files because they would introduce circular #include dependencies.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifndef ROSE_BinaryAnalysis_Utility_H</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#define ROSE_BinaryAnalysis_Utility_H</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <featureTests.h></span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifdef ROSE_ENABLE_BINARY_ANALYSIS</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "AsmUnparser_compat.h"</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceRose.html">Rose</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span>BinaryAnalysis { <span class="comment">// documented elsewhere</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">template</span><<span class="keyword">class</span> Graph></div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="};">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structRose_1_1BinaryAnalysis_1_1InsnCFGVertexWriter.html"> 17</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structRose_1_1BinaryAnalysis_1_1InsnCFGVertexWriter.html">InsnCFGVertexWriter</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">const</span> Graph &cfg;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_struct" href="structRose_1_1BinaryAnalysis_1_1InsnCFGVertexWriter.html">InsnCFGVertexWriter</a>(Graph &cfg): cfg(cfg) {}</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">typedef</span> <span class="keyword">typename</span> boost::graph_traits<Graph>::vertex_descriptor <a class="code hl_struct" href="structVertex.html">Vertex</a>;</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">void</span> operator()(std::ostream &output, <span class="keyword">const</span> <a class="code hl_struct" href="structVertex.html">Vertex</a> &v)<span class="keyword"> const </span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_class" href="classSgAsmInstruction.html">SgAsmInstruction</a> *insn = <a class="code hl_function" href="namespaceRose_1_1BinaryAnalysis.html#a58a80b77dad05a78cdc8dd211cb5e844">get_ast_node</a>(cfg, v);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_class" href="classSgAsmX86Instruction.html">SgAsmX86Instruction</a> *x86 = isSgAsmX86Instruction(insn);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_class" href="classSgAsmFunction.html">SgAsmFunction</a> *func = SageInterface::getEnclosingNode<SgAsmFunction>(insn);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> output <<<span class="stringliteral">"[ label=\"["</span> <<v << <span class="stringliteral">"] "</span> <<insn-><a class="code hl_function" href="classSgAsmInstruction.html#a86e23cc0305636d76bc043ba439bbd23">toString</a>() <<<span class="stringliteral">"\""</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordflow">if</span> (insn-><a class="code hl_function" href="classSgAsmStatement.html#ac0959f1b0d967f7aff9032c2a4e2ab92">get_address</a>()==func-><a class="code hl_function" href="classSgAsmFunction.html#a18b23b19d6538da747ea71ecd94262ae">get_entryVa</a>()) {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> output <<<span class="stringliteral">", style=filled, color=\"#cd853f\""</span>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (x86 && x86_ret==x86-><a class="code hl_function" href="classSgAsmX86Instruction.html#a72bc9d05328a513b10a9037d7199702e">get_kind</a>()) {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> output <<<span class="stringliteral">", style=filled, color=\"#fed3a7\""</span>;</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> }</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> output <<<span class="stringliteral">" ]"</span>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> }</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>};</div>
</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>} <span class="comment">// namespace</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>} <span class="comment">// namespace</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassSgAsmFunction_html"><div class="ttname"><a href="classSgAsmFunction.html">SgAsmFunction</a></div><div class="ttdoc">Represents a synthesized function.</div><div class="ttdef"><b>Definition</b> <a href="binaryInstruction_8C_source.html#l16099">binaryInstruction.C:16099</a></div></div>
<div class="ttc" id="aclassSgAsmFunction_html_a18b23b19d6538da747ea71ecd94262ae"><div class="ttname"><a href="classSgAsmFunction.html#a18b23b19d6538da747ea71ecd94262ae">SgAsmFunction::get_entryVa</a></div><div class="ttdeci">rose_addr_t const & get_entryVa() const</div><div class="ttdoc">Property: Primary entry address.</div></div>
<div class="ttc" id="aclassSgAsmInstruction_html"><div class="ttname"><a href="classSgAsmInstruction.html">SgAsmInstruction</a></div><div class="ttdoc">Base class for machine instructions.</div><div class="ttdef"><b>Definition</b> <a href="binaryInstruction_8C_source.html#l43208">binaryInstruction.C:43208</a></div></div>
<div class="ttc" id="aclassSgAsmInstruction_html_a86e23cc0305636d76bc043ba439bbd23"><div class="ttname"><a href="classSgAsmInstruction.html#a86e23cc0305636d76bc043ba439bbd23">SgAsmInstruction::toString</a></div><div class="ttdeci">virtual std::string toString() const</div><div class="ttdoc">Converts the instruction to a string.</div></div>
<div class="ttc" id="aclassSgAsmStatement_html_ac0959f1b0d967f7aff9032c2a4e2ab92"><div class="ttname"><a href="classSgAsmStatement.html#ac0959f1b0d967f7aff9032c2a4e2ab92">SgAsmStatement::get_address</a></div><div class="ttdeci">rose_addr_t const & get_address() const</div><div class="ttdoc">Property: Starting virtual address.</div></div>
<div class="ttc" id="aclassSgAsmX86Instruction_html"><div class="ttname"><a href="classSgAsmX86Instruction.html">SgAsmX86Instruction</a></div><div class="ttdoc">Represents one Intel x86 machine instruction.</div><div class="ttdef"><b>Definition</b> <a href="binaryInstruction_8C_source.html#l00122">binaryInstruction.C:122</a></div></div>
<div class="ttc" id="aclassSgAsmX86Instruction_html_a72bc9d05328a513b10a9037d7199702e"><div class="ttname"><a href="classSgAsmX86Instruction.html#a72bc9d05328a513b10a9037d7199702e">SgAsmX86Instruction::get_kind</a></div><div class="ttdeci">Rose::BinaryAnalysis::X86InstructionKind const & get_kind() const</div><div class="ttdoc">Property: Instruction kind.</div></div>
<div class="ttc" id="anamespaceRose_1_1BinaryAnalysis_html_a58a80b77dad05a78cdc8dd211cb5e844"><div class="ttname"><a href="namespaceRose_1_1BinaryAnalysis.html#a58a80b77dad05a78cdc8dd211cb5e844">Rose::BinaryAnalysis::get_ast_node</a></div><div class="ttdeci">Sawyer::Container::Graph< V, E >::VertexValue get_ast_node(const Sawyer::Container::Graph< V, E > &cfg, size_t vertexId)</div><div class="ttdoc">Return the AST node associated with a vertex.</div><div class="ttdef"><b>Definition</b> <a href="ControlFlow_8h_source.html#l00556">ControlFlow.h:556</a></div></div>
<div class="ttc" id="anamespaceRose_html"><div class="ttname"><a href="namespaceRose.html">Rose</a></div><div class="ttdoc">The ROSE library.</div><div class="ttdef"><b>Definition</b> <a href="BinaryTutorial_8dox_source.html#l00003">BinaryTutorial.dox:3</a></div></div>
<div class="ttc" id="astructRose_1_1BinaryAnalysis_1_1InsnCFGVertexWriter_html"><div class="ttname"><a href="structRose_1_1BinaryAnalysis_1_1InsnCFGVertexWriter.html">Rose::BinaryAnalysis::InsnCFGVertexWriter</a></div><div class="ttdoc">A vertex property writer for instruction-based CFGs.</div><div class="ttdef"><b>Definition</b> <a href="BinaryAnalysis_2Utility_8h_source.html#l00017">BinaryAnalysis/Utility.h:17</a></div></div>
<div class="ttc" id="astructVertex_html"><div class="ttname"><a href="structVertex.html">Vertex</a></div><div class="ttdef"><b>Definition</b> <a href="SgGraphTemplate_8h_source.html#l00007">SgGraphTemplate.h:7</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Oct 2 2024 00:08:23 for ROSE by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>