-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathAlignment_8h_source.html
141 lines (141 loc) · 19.1 KB
/
Alignment_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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<!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: Alignment.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">Alignment.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="preprocessor">#ifndef ROSE_BinaryAnalysis_Alignment_H</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define ROSE_BinaryAnalysis_Alignment_H</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include <featureTests.h></span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#ifdef ROSE_ENABLE_BINARY_ANALYSIS</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <RoseFirst.h></span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <Sawyer/Optional.h></span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <boost/serialization/access.hpp></span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceRose.html">Rose</a> {</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span>BinaryAnalysis {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html"> 16</a></span><span class="keyword">class </span><a class="code hl_class" href="classRose_1_1BinaryAnalysis_1_1Alignment.html">Alignment</a> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> uint64_t value_ = 1;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordtype">size_t</span> nBits_ = 64;</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">friend</span> <span class="keyword">class </span>boost::serialization::access;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">template</span><<span class="keyword">class</span> S></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keywordtype">void</span> serialize(S &s, <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="comment">/*version*/</span>) {</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> s & BOOST_SERIALIZATION_NVP(value_);</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> s & BOOST_SERIALIZATION_NVP(nBits_);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> }</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a7d5ef4aea9f8590c1e0d02eba3edd038"> 36</a></span> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a7d5ef4aea9f8590c1e0d02eba3edd038">Alignment</a>();</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a5b145d9406c17f44216516bea58ebafe"> 43</a></span> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a5b145d9406c17f44216516bea58ebafe">Alignment</a>(uint64_t alignment, <span class="keywordtype">size_t</span> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a4931f99437e3d88180d1a1cb5365eec2">nBits</a>);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#aff628541b85ea1bd4052e11ab95aff06"> 48</a></span> <a class="code hl_class" href="classRose_1_1BinaryAnalysis_1_1Alignment.html">Alignment</a>& <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#aff628541b85ea1bd4052e11ab95aff06">operator=</a>(<span class="keyword">const</span> <a class="code hl_class" href="classRose_1_1BinaryAnalysis_1_1Alignment.html">Alignment</a>&) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a3c3fe8518a4bb98b2006931d92065f65"> 49</a></span> <a class="code hl_class" href="classRose_1_1BinaryAnalysis_1_1Alignment.html">Alignment</a>& <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a3c3fe8518a4bb98b2006931d92065f65">operator=</a>(<span class="keyword">const</span> uint64_t);</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a64b4cfeec22d5fcf0fcb55486abe243b"> 55</a></span> uint64_t <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a64b4cfeec22d5fcf0fcb55486abe243b">get</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a1a309060f985b07cfb1f0a5379b2354a"> 56</a></span> uint64_t <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a1a309060f985b07cfb1f0a5379b2354a">operator*</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#aa0848f122b0e1a65a9d5f01f4a4247c5"> 57</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#aa0848f122b0e1a65a9d5f01f4a4247c5">set</a>(uint64_t);</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a4931f99437e3d88180d1a1cb5365eec2"> 65</a></span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a4931f99437e3d88180d1a1cb5365eec2">nBits</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a2a0468c02132e1105e0ec6bc1f9c57d2"> 66</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a2a0468c02132e1105e0ec6bc1f9c57d2">nBits</a>(<span class="keywordtype">size_t</span>);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a809f6b43ceb352c36cfb5e445735c14a"> 72</a></span> uint64_t <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a809f6b43ceb352c36cfb5e445735c14a">alignDown</a>(uint64_t) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#ac466cc7b1c49a875ba9497622df86b43"> 81</a></span> <a class="code hl_class" href="classSawyer_1_1Optional.html">Sawyer::Optional<uint64_t></a> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#ac466cc7b1c49a875ba9497622df86b43">alignUp</a>(uint64_t) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a0d144abb483b14900077f8e54450d629"> 86</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a0d144abb483b14900077f8e54450d629">isAligned</a>(uint64_t) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span>};</div>
</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>} <span class="comment">// namespace</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span>} <span class="comment">// namespace</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html">Rose::BinaryAnalysis::Alignment</a></div><div class="ttdoc">Information about alignments.</div><div class="ttdef"><b>Definition</b> <a href="Alignment_8h_source.html#l00016">Alignment.h:16</a></div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a0d144abb483b14900077f8e54450d629"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a0d144abb483b14900077f8e54450d629">Rose::BinaryAnalysis::Alignment::isAligned</a></div><div class="ttdeci">bool isAligned(uint64_t) const</div><div class="ttdoc">Test whether a value is aligned.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a1a309060f985b07cfb1f0a5379b2354a"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a1a309060f985b07cfb1f0a5379b2354a">Rose::BinaryAnalysis::Alignment::operator*</a></div><div class="ttdeci">uint64_t operator*() const</div><div class="ttdoc">Property: Alignment.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a2a0468c02132e1105e0ec6bc1f9c57d2"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a2a0468c02132e1105e0ec6bc1f9c57d2">Rose::BinaryAnalysis::Alignment::nBits</a></div><div class="ttdeci">void nBits(size_t)</div><div class="ttdoc">Property: Number of bits in the values being aligned.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a3c3fe8518a4bb98b2006931d92065f65"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a3c3fe8518a4bb98b2006931d92065f65">Rose::BinaryAnalysis::Alignment::operator=</a></div><div class="ttdeci">Alignment & operator=(const uint64_t)</div><div class="ttdoc">Assignment.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a4931f99437e3d88180d1a1cb5365eec2"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a4931f99437e3d88180d1a1cb5365eec2">Rose::BinaryAnalysis::Alignment::nBits</a></div><div class="ttdeci">size_t nBits() const</div><div class="ttdoc">Property: Number of bits in the values being aligned.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a5b145d9406c17f44216516bea58ebafe"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a5b145d9406c17f44216516bea58ebafe">Rose::BinaryAnalysis::Alignment::Alignment</a></div><div class="ttdeci">Alignment(uint64_t alignment, size_t nBits)</div><div class="ttdoc">Constructor with specific alignment.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a64b4cfeec22d5fcf0fcb55486abe243b"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a64b4cfeec22d5fcf0fcb55486abe243b">Rose::BinaryAnalysis::Alignment::get</a></div><div class="ttdeci">uint64_t get() const</div><div class="ttdoc">Property: Alignment.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a7d5ef4aea9f8590c1e0d02eba3edd038"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a7d5ef4aea9f8590c1e0d02eba3edd038">Rose::BinaryAnalysis::Alignment::Alignment</a></div><div class="ttdeci">Alignment()</div><div class="ttdoc">Default constructor.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_a809f6b43ceb352c36cfb5e445735c14a"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#a809f6b43ceb352c36cfb5e445735c14a">Rose::BinaryAnalysis::Alignment::alignDown</a></div><div class="ttdeci">uint64_t alignDown(uint64_t) const</div><div class="ttdoc">Round value down to closest multiple of the alignment.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_aa0848f122b0e1a65a9d5f01f4a4247c5"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#aa0848f122b0e1a65a9d5f01f4a4247c5">Rose::BinaryAnalysis::Alignment::set</a></div><div class="ttdeci">void set(uint64_t)</div><div class="ttdoc">Property: Alignment.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_ac466cc7b1c49a875ba9497622df86b43"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#ac466cc7b1c49a875ba9497622df86b43">Rose::BinaryAnalysis::Alignment::alignUp</a></div><div class="ttdeci">Sawyer::Optional< uint64_t > alignUp(uint64_t) const</div><div class="ttdoc">Round value up to the closest multiple of the alignment.</div></div>
<div class="ttc" id="aclassRose_1_1BinaryAnalysis_1_1Alignment_html_aff628541b85ea1bd4052e11ab95aff06"><div class="ttname"><a href="classRose_1_1BinaryAnalysis_1_1Alignment.html#aff628541b85ea1bd4052e11ab95aff06">Rose::BinaryAnalysis::Alignment::operator=</a></div><div class="ttdeci">Alignment & operator=(const Alignment &)=default</div><div class="ttdoc">Assignment.</div></div>
<div class="ttc" id="aclassSawyer_1_1Optional_html"><div class="ttname"><a href="classSawyer_1_1Optional.html">Sawyer::Optional</a></div><div class="ttdoc">Holds a value or nothing.</div><div class="ttdef"><b>Definition</b> <a href="Optional_8h_source.html#l00056">Optional.h:56</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><!-- 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>