CGNICO/Metahuman_DNA_Calibration
2
0
Fork 0
Code Issues 19 Pull Requests 1 Actions Packages Projects Releases 7 Wiki Activity
67ed4ad552
Metahuman_DNA_Calibration/docs/doxygen/build/html/AlignedMemoryResource_8cpp.html
Srdjan Milicev 44bb3ac31f generated documentation
2022-11-29 14:58:38 +01:00

354 lines
21 KiB
HTML
Raw Blame History

<!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">
<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.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DNA Calib: AlignedMemoryResource.cpp File 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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">DNA Calib<span id="projectnumber">&#160;1.1</span>
</div>
<div id="projectbrief">Project brief</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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="dir_152a494004de7bf5f5699139fd63e08c.html">dnacalib</a></li><li class="navelem"><a class="el" href="dir_e342cf579e4a20e61ca12fdabd8b8b30.html">DNACalib</a></li><li class="navelem"><a class="el" href="dir_ebe8ed350d62118184cb59aefa6eec76.html">src</a></li><li class="navelem"><a class="el" href="dir_7855595e2bd009b545292ef0e2d31a4d.html">pma</a></li><li class="navelem"><a class="el" href="dir_4004fc72416ae83c7a46091dde954b46.html">resources</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">AlignedMemoryResource.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="AlignedMemoryResource_8h_source.html">pma/resources/AlignedMemoryResource.h</a>&quot;</code><br />
<code>#include &lt;cassert&gt;</code><br />
<code>#include &lt;cstddef&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
<code>#include &lt;cstdlib&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for AlignedMemoryResource.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="AlignedMemoryResource_8cpp__incl.png" border="0" usemap="#aAlignedMemoryResource_8cpp" alt=""/></div>
<map name="aAlignedMemoryResource_8cpp" id="aAlignedMemoryResource_8cpp">
<area shape="rect" title=" " alt="" coords="255,5,447,32"/>
<area shape="rect" href="AlignedMemoryResource_8h.html" title=" " alt="" coords="24,80,227,121"/>
<area shape="rect" title=" " alt="" coords="197,244,261,271"/>
<area shape="rect" title=" " alt="" coords="318,87,383,114"/>
<area shape="rect" title=" " alt="" coords="408,87,469,114"/>
<area shape="rect" title=" " alt="" coords="494,87,554,114"/>
<area shape="rect" href="pma_2Defs_8h.html" title=" " alt="" coords="5,244,93,271"/>
<area shape="rect" href="MemoryResource_8h.html" title=" " alt="" coords="27,169,191,196"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacepma"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepma.html">pma</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:acb861b2c4ec0c3344f25e69b667d9810"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="AlignedMemoryResource_8cpp.html#acb861b2c4ec0c3344f25e69b667d9810">ALIGNED_ALLOC</a>(ptr, alignment, size)&#160;&#160;&#160;ptr = <a class="el" href="AlignedMemoryResource_8cpp.html#ab8a1c145d376a36ae8ca2e4213b6f852">alignedAlloc</a>(size, alignment)</td></tr>
<tr class="separator:acb861b2c4ec0c3344f25e69b667d9810"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2018dcdf31f7fd4efa685ecff3137b05"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="AlignedMemoryResource_8cpp.html#a2018dcdf31f7fd4efa685ecff3137b05">ALIGNED_FREE</a>(ptr)&#160;&#160;&#160;<a class="el" href="AlignedMemoryResource_8cpp.html#a2898a09481cbfcd24d6d1309021ac137">alignedFree</a>(ptr)</td></tr>
<tr class="separator:a2018dcdf31f7fd4efa685ecff3137b05"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1e2fd36ca37121582814c06f59e756e6"><td class="memItemLeft" align="right" valign="top">std::uintptr_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="AlignedMemoryResource_8cpp.html#a1e2fd36ca37121582814c06f59e756e6">alignAddress</a> (std::uintptr_t address, std::size_t alignment)</td></tr>
<tr class="separator:a1e2fd36ca37121582814c06f59e756e6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab078fdf361932eac77e00095a9896676"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ab078fdf361932eac77e00095a9896676"><td class="memTemplItemLeft" align="right" valign="top">T *&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="AlignedMemoryResource_8cpp.html#ab078fdf361932eac77e00095a9896676">alignPointer</a> (T *ptr, std::size_t alignment)</td></tr>
<tr class="separator:ab078fdf361932eac77e00095a9896676"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8a1c145d376a36ae8ca2e4213b6f852"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="AlignedMemoryResource_8cpp.html#ab8a1c145d376a36ae8ca2e4213b6f852">alignedAlloc</a> (std::size_t size, std::size_t alignment)</td></tr>
<tr class="separator:ab8a1c145d376a36ae8ca2e4213b6f852"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2898a09481cbfcd24d6d1309021ac137"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="AlignedMemoryResource_8cpp.html#a2898a09481cbfcd24d6d1309021ac137">alignedFree</a> (void *ptr)</td></tr>
<tr class="separator:a2898a09481cbfcd24d6d1309021ac137"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="acb861b2c4ec0c3344f25e69b667d9810" name="acb861b2c4ec0c3344f25e69b667d9810"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb861b2c4ec0c3344f25e69b667d9810">&#9670;&nbsp;</a></span>ALIGNED_ALLOC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ALIGNED_ALLOC</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">ptr, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">alignment, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">size&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;ptr = <a class="el" href="AlignedMemoryResource_8cpp.html#ab8a1c145d376a36ae8ca2e4213b6f852">alignedAlloc</a>(size, alignment)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2018dcdf31f7fd4efa685ecff3137b05" name="a2018dcdf31f7fd4efa685ecff3137b05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2018dcdf31f7fd4efa685ecff3137b05">&#9670;&nbsp;</a></span>ALIGNED_FREE</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ALIGNED_FREE</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">ptr</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="AlignedMemoryResource_8cpp.html#a2898a09481cbfcd24d6d1309021ac137">alignedFree</a>(ptr)</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1e2fd36ca37121582814c06f59e756e6" name="a1e2fd36ca37121582814c06f59e756e6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e2fd36ca37121582814c06f59e756e6">&#9670;&nbsp;</a></span>alignAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::uintptr_t alignAddress </td>
<td>(</td>
<td class="paramtype">std::uintptr_t&#160;</td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>alignment</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 31</span> {</div>
<div class="line"><span class="lineno"> 32</span> <span class="keyword">const</span> std::size_t mask = alignment - 1ul;</div>
<div class="line"><span class="lineno"> 33</span> assert((alignment &amp; mask) == 0ul);</div>
<div class="line"><span class="lineno"> 34</span> <span class="keywordflow">return</span> (address + mask) &amp; ~mask;</div>
<div class="line"><span class="lineno"> 35</span> }</div>
</div><!-- fragment -->
<p class="reference">Referenced by <a class="el" href="AlignedMemoryResource_8cpp.html#ab078fdf361932eac77e00095a9896676">alignPointer()</a>.</p>
</div>
</div>
<a id="ab8a1c145d376a36ae8ca2e4213b6f852" name="ab8a1c145d376a36ae8ca2e4213b6f852"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab8a1c145d376a36ae8ca2e4213b6f852">&#9670;&nbsp;</a></span>alignedAlloc()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void * alignedAlloc </td>
<td>(</td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>alignment</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 44</span> {</div>
<div class="line"><span class="lineno"> 45</span> <span class="keyword">const</span> std::size_t actualSize = size + alignment;</div>
<div class="line"><span class="lineno"> 46</span> <span class="keywordtype">char</span>* pUnalignedChunk = <span class="keyword">new</span> <span class="keywordtype">char</span>[actualSize];</div>
<div class="line"><span class="lineno"> 47</span> <span class="keywordtype">char</span>* pAlignedChunk = <a class="code hl_function" href="AlignedMemoryResource_8cpp.html#ab078fdf361932eac77e00095a9896676">alignPointer</a>(pUnalignedChunk, alignment);</div>
<div class="line"><span class="lineno"> 48</span> <span class="keywordflow">if</span> (pAlignedChunk == pUnalignedChunk) {</div>
<div class="line"><span class="lineno"> 49</span> <span class="comment">// There was no need for additional alignment, so an artifical gap</span></div>
<div class="line"><span class="lineno"> 50</span> <span class="comment">// must be added to make room for the shift value</span></div>
<div class="line"><span class="lineno"> 51</span> pAlignedChunk += alignment;</div>
<div class="line"><span class="lineno"> 52</span> }</div>
<div class="line"><span class="lineno"> 53</span> <span class="comment">// Compute and write the shift value into the buffer (it is needed during</span></div>
<div class="line"><span class="lineno"> 54</span> <span class="comment">// deallocation to reconstruct by which amount was the given pointer</span></div>
<div class="line"><span class="lineno"> 55</span> <span class="comment">// offset to meet the alignment requirement)</span></div>
<div class="line"><span class="lineno"> 56</span> std::ptrdiff_t shift = pAlignedChunk - pUnalignedChunk;</div>
<div class="line"><span class="lineno"> 57</span> <span class="comment">// The guaranteed storage size for the shift value is only one byte</span></div>
<div class="line"><span class="lineno"> 58</span> assert(shift &gt; 0 &amp;&amp; shift &lt;= 256);</div>
<div class="line"><span class="lineno"> 59</span> pAlignedChunk[-1] = <span class="keyword">static_cast&lt;</span><span class="keywordtype">char</span><span class="keyword">&gt;</span>(shift &amp; 0xFF);</div>
<div class="line"><span class="lineno"> 60</span> <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">void</span>*<span class="keyword">&gt;</span>(pAlignedChunk);</div>
<div class="line"><span class="lineno"> 61</span> }</div>
<div class="ttc" id="aAlignedMemoryResource_8cpp_html_ab078fdf361932eac77e00095a9896676"><div class="ttname"><a href="AlignedMemoryResource_8cpp.html#ab078fdf361932eac77e00095a9896676">alignPointer</a></div><div class="ttdeci">T * alignPointer(T *ptr, std::size_t alignment)</div><div class="ttdef"><b>Definition:</b> AlignedMemoryResource.cpp:38</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="AlignedMemoryResource_8cpp.html#ab078fdf361932eac77e00095a9896676">alignPointer()</a>.</p>
</div>
</div>
<a id="a2898a09481cbfcd24d6d1309021ac137" name="a2898a09481cbfcd24d6d1309021ac137"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2898a09481cbfcd24d6d1309021ac137">&#9670;&nbsp;</a></span>alignedFree()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void alignedFree </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>ptr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 63</span> {</div>
<div class="line"><span class="lineno"> 64</span> <span class="keywordflow">if</span> (ptr) {</div>
<div class="line"><span class="lineno"> 65</span> <span class="keyword">auto</span> pAlignedChunk = <span class="keyword">reinterpret_cast&lt;</span><span class="keywordtype">char</span>*<span class="keyword">&gt;</span>(ptr);</div>
<div class="line"><span class="lineno"> 66</span> std::ptrdiff_t shift = pAlignedChunk[-1];</div>
<div class="line"><span class="lineno"> 67</span> <span class="comment">// There is no 0 alignment, so the value is reused to actually denote alignment by 256</span></div>
<div class="line"><span class="lineno"> 68</span> <span class="keywordflow">if</span> (shift == 0) {</div>
<div class="line"><span class="lineno"> 69</span> shift = 256;</div>
<div class="line"><span class="lineno"> 70</span> }</div>
<div class="line"><span class="lineno"> 71</span> <span class="comment">// Compute the actual start address of the chunk, prior to aligning it&#39;s address</span></div>
<div class="line"><span class="lineno"> 72</span> <span class="keyword">auto</span> pUnalignedChunk = pAlignedChunk - shift;</div>
<div class="line"><span class="lineno"> 73</span> <span class="keyword">delete</span>[] pUnalignedChunk;</div>
<div class="line"><span class="lineno"> 74</span> }</div>
<div class="line"><span class="lineno"> 75</span> }</div>
</div><!-- fragment -->
</div>
</div>
<a id="ab078fdf361932eac77e00095a9896676" name="ab078fdf361932eac77e00095a9896676"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab078fdf361932eac77e00095a9896676">&#9670;&nbsp;</a></span>alignPointer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">T * alignPointer </td>
<td>(</td>
<td class="paramtype">T *&#160;</td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>alignment</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="fragment"><div class="line"><span class="lineno"> 38</span> {</div>
<div class="line"><span class="lineno"> 39</span> <span class="keyword">const</span> std::uintptr_t address = <span class="keyword">reinterpret_cast&lt;</span>std::uintptr_t<span class="keyword">&gt;</span>(ptr);</div>
<div class="line"><span class="lineno"> 40</span> <span class="keyword">const</span> std::uintptr_t aligned = <a class="code hl_function" href="AlignedMemoryResource_8cpp.html#a1e2fd36ca37121582814c06f59e756e6">alignAddress</a>(address, alignment);</div>
<div class="line"><span class="lineno"> 41</span> <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span>T*<span class="keyword">&gt;</span>(aligned);</div>
<div class="line"><span class="lineno"> 42</span> }</div>
<div class="ttc" id="aAlignedMemoryResource_8cpp_html_a1e2fd36ca37121582814c06f59e756e6"><div class="ttname"><a href="AlignedMemoryResource_8cpp.html#a1e2fd36ca37121582814c06f59e756e6">alignAddress</a></div><div class="ttdeci">std::uintptr_t alignAddress(std::uintptr_t address, std::size_t alignment)</div><div class="ttdef"><b>Definition:</b> AlignedMemoryResource.cpp:31</div></div>
</div><!-- fragment -->
<p class="reference">References <a class="el" href="AlignedMemoryResource_8cpp.html#a1e2fd36ca37121582814c06f59e756e6">alignAddress()</a>.</p>
<p class="reference">Referenced by <a class="el" href="AlignedMemoryResource_8cpp.html#ab8a1c145d376a36ae8ca2e4213b6f852">alignedAlloc()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink