ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/spinlock_8h_source.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

293 lines
41 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" 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>rippled: spinlock.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/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">rippled
</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&amp;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&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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_f534ca90a4985f34ab325acfbcd39b84.html">basics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">spinlock.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">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright 2022, Nikolaos D. Bougalis &lt;nikb@bougalis.net&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"></span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"></span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">*/</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef RIPPLE_BASICS_SPINLOCK_H_INCLUDED</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define RIPPLE_BASICS_SPINLOCK_H_INCLUDED</span></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">#include &lt;xrpl/beast/utility/instrumentation.h&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/atomic.html">atomic</a>&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/limits.html">limits</a>&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a>&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#ifndef __aarch64__</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;immintrin.h&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#endif</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><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</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><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keyword">inline</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320"> 45</a></span><a class="code hl_function" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320">spin_pause</a>() noexcept</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span>{</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#ifdef __aarch64__</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">asm</span> <span class="keyword">volatile</span>(<span class="stringliteral">&quot;yield&quot;</span>);</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> _mm_pause();</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>}</div>
</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace detail</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="foldopen" id="foldopen00090" data-start="{" data-end="};">
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html"> 90</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1packed__spinlock.html">packed_spinlock</a></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>{</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// clang-format off</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">static_assert</span>(<a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_unsigned_v&lt;T&gt;</a>);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> <span class="keyword">static_assert</span>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;T&gt;::is_always_lock_free</a>);</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt;<span class="keyword">decltype</span>(<a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::declval&lt;std::atomic&lt;T&gt;</a>&amp;&gt;().fetch_or(0)), T&gt; &amp;&amp;</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a>&lt;<span class="keyword">decltype</span>(<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/utility/declval.html">std::declval</a>&lt;<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;T&gt;</a>&amp;&gt;().<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/atomic/atomic/fetch_and.html">fetch_and</a>(0)), T&gt;,</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="stringliteral">&quot;std::atomic&lt;T&gt;::fetch_and(T) and std::atomic&lt;T&gt;::fetch_and(T) are required by packed_spinlock&quot;</span>);</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="comment">// clang-format on</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857"> 102</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;T&gt;</a>&amp; <a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e"> 103</a></span> T <span class="keyword">const</span> <a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">mask_</a>;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a9b50344098f14a88e3cf3bf75f9eca45"> 106</a></span> <a class="code hl_function" href="classripple_1_1packed__spinlock.html#a9b50344098f14a88e3cf3bf75f9eca45">packed_spinlock</a>(<a class="code hl_class" href="classripple_1_1packed__spinlock.html">packed_spinlock</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_class" href="classripple_1_1packed__spinlock.html">packed_spinlock</a>&amp;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#af3fa7eb171fa440abfe894a02242a0be"> 108</a></span> <a class="code hl_function" href="classripple_1_1packed__spinlock.html#af3fa7eb171fa440abfe894a02242a0be">operator=</a>(<a class="code hl_class" href="classripple_1_1packed__spinlock.html">packed_spinlock</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="foldopen" id="foldopen00118" data-start="{" data-end="}">
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a6b795f06719bc2d90ed4f6a6007fb5fe"> 118</a></span> <a class="code hl_function" href="classripple_1_1packed__spinlock.html#a6b795f06719bc2d90ed4f6a6007fb5fe">packed_spinlock</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;T&gt;</a>&amp; <a class="code hl_function" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63">lock</a>, <span class="keywordtype">int</span> index)</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> : <a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>(<a class="code hl_function" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63">lock</a>), <a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">mask_</a>(static_cast&lt;T&gt;(1) &lt;&lt; index)</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> {</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> XRPL_ASSERT(</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> index &gt;= 0 &amp;&amp; (<a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">mask_</a> != 0),</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="stringliteral">&quot;ripple::packed_spinlock::packed_spinlock : valid index and mask&quot;</span>);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> }</div>
</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> [[nodiscard]] <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00127" data-start="{" data-end="}">
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#ad544b64b85215e6adcf96a37f7b14503"> 127</a></span> <a class="code hl_function" href="classripple_1_1packed__spinlock.html#ad544b64b85215e6adcf96a37f7b14503">try_lock</a>()</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> {</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keywordflow">return</span> (<a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>.fetch_or(<a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">mask_</a>, <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::memory_order_acquire</a>) &amp; <a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">mask_</a>) == 0;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> }</div>
</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00133" data-start="{" data-end="}">
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63"> 133</a></span> <a class="code hl_function" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63">lock</a>()</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> {</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="keywordflow">while</span> (!<a class="code hl_function" href="classripple_1_1packed__spinlock.html#ad544b64b85215e6adcf96a37f7b14503">try_lock</a>())</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> {</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="comment">// The use of relaxed memory ordering here is intentional and</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="comment">// serves to help reduce cache coherency traffic during times</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="comment">// of contention by avoiding writes that would definitely not</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> <span class="comment">// result in the lock being acquired.</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordflow">while</span> ((<a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>.load(<a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::memory_order_relaxed</a>) &amp; <a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">mask_</a>) != 0)</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <a class="code hl_function" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320">detail::spin_pause</a>();</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> }</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> }</div>
</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00147" data-start="{" data-end="}">
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a54ab44d231a3a27eda752596b3f69e11"> 147</a></span> <a class="code hl_function" href="classripple_1_1packed__spinlock.html#a54ab44d231a3a27eda752596b3f69e11">unlock</a>()</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> {</div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>.fetch_and(~<a class="code hl_variable" href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">mask_</a>, <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::memory_order_release</a>);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> }</div>
</div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span>};</div>
</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> T&gt;</div>
<div class="foldopen" id="foldopen00166" data-start="{" data-end="};">
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html"> 166</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1spinlock.html">spinlock</a></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span>{</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> <span class="keyword">static_assert</span>(<a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_unsigned_v&lt;T&gt;</a>);</div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="keyword">static_assert</span>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;T&gt;::is_always_lock_free</a>);</div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span> </div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95"> 172</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;T&gt;</a>&amp; <a class="code hl_variable" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>;</div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> </div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a20d16e13b4586293281bcfeb06abe834"> 175</a></span> <a class="code hl_function" href="classripple_1_1spinlock.html#a20d16e13b4586293281bcfeb06abe834">spinlock</a>(<a class="code hl_class" href="classripple_1_1spinlock.html">spinlock</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> <a class="code hl_class" href="classripple_1_1spinlock.html">spinlock</a>&amp;</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a0ba6bed87cc5c3da6ce85da9f020358e"> 177</a></span> <a class="code hl_function" href="classripple_1_1spinlock.html#a0ba6bed87cc5c3da6ce85da9f020358e">operator=</a>(<a class="code hl_class" href="classripple_1_1spinlock.html">spinlock</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="foldopen" id="foldopen00186" data-start="{" data-end="}">
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#ad7541682f7281ab8d2ce12941923fc41"> 186</a></span> <a class="code hl_function" href="classripple_1_1spinlock.html#ad7541682f7281ab8d2ce12941923fc41">spinlock</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic&lt;T&gt;</a>&amp; <a class="code hl_function" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a>) : <a class="code hl_variable" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>(<a class="code hl_function" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a>)</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> {</div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> }</div>
</div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span> </div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span> [[nodiscard]] <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00191" data-start="{" data-end="}">
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b"> 191</a></span> <a class="code hl_function" href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b">try_lock</a>()</div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> {</div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span> T expected = 0;</div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>.compare_exchange_weak(</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> expected,</div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits&lt;T&gt;::max</a>(),</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::memory_order_acquire</a>,</div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span> <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::memory_order_relaxed</a>);</div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span> }</div>
</div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span> </div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00203" data-start="{" data-end="}">
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8"> 203</a></span> <a class="code hl_function" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a>()</div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span> {</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span> <span class="keywordflow">while</span> (!<a class="code hl_function" href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b">try_lock</a>())</div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span> {</div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <span class="comment">// The use of relaxed memory ordering here is intentional and</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> <span class="comment">// serves to help reduce cache coherency traffic during times</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> <span class="comment">// of contention by avoiding writes that would definitely not</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> <span class="comment">// result in the lock being acquired.</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> <span class="keywordflow">while</span> (<a class="code hl_variable" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>.load(<a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::memory_order_relaxed</a>) != 0)</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <a class="code hl_function" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320">detail::spin_pause</a>();</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> }</div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> }</div>
</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> </div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00217" data-start="{" data-end="}">
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a039c6e7ea6986a10c5b846411d6b7d21"> 217</a></span> <a class="code hl_function" href="classripple_1_1spinlock.html#a039c6e7ea6986a10c5b846411d6b7d21">unlock</a>()</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> {</div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <a class="code hl_variable" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>.store(0, <a class="code hl_variableRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::memory_order_release</a>);</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> }</div>
</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span>};</div>
</div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> </div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aatomic_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/atomic.html">atomic</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html"><div class="ttname"><a href="classripple_1_1packed__spinlock.html">ripple::packed_spinlock</a></div><div class="ttdoc">Classes to handle arrays of spinlocks packed into a single atomic integer:</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00090">spinlock.h:91</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_a1f775dfb309d7f877b5075c05a29d857"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">ripple::packed_spinlock::bits_</a></div><div class="ttdeci">std::atomic&lt; T &gt; &amp; bits_</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00102">spinlock.h:102</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_a54ab44d231a3a27eda752596b3f69e11"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#a54ab44d231a3a27eda752596b3f69e11">ripple::packed_spinlock::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00147">spinlock.h:147</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_a6b795f06719bc2d90ed4f6a6007fb5fe"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#a6b795f06719bc2d90ed4f6a6007fb5fe">ripple::packed_spinlock::packed_spinlock</a></div><div class="ttdeci">packed_spinlock(std::atomic&lt; T &gt; &amp;lock, int index)</div><div class="ttdoc">A single spinlock packed inside the specified atomic.</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00118">spinlock.h:118</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_a7a71c9f47a7e78f43941aecc5f07ec7e"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#a7a71c9f47a7e78f43941aecc5f07ec7e">ripple::packed_spinlock::mask_</a></div><div class="ttdeci">T const mask_</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00103">spinlock.h:103</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_a8d885a8f4e6fc078869345131e76be63"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63">ripple::packed_spinlock::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00133">spinlock.h:133</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_a9b50344098f14a88e3cf3bf75f9eca45"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#a9b50344098f14a88e3cf3bf75f9eca45">ripple::packed_spinlock::packed_spinlock</a></div><div class="ttdeci">packed_spinlock(packed_spinlock const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_ad544b64b85215e6adcf96a37f7b14503"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#ad544b64b85215e6adcf96a37f7b14503">ripple::packed_spinlock::try_lock</a></div><div class="ttdeci">bool try_lock()</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00127">spinlock.h:127</a></div></div>
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_af3fa7eb171fa440abfe894a02242a0be"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#af3fa7eb171fa440abfe894a02242a0be">ripple::packed_spinlock::operator=</a></div><div class="ttdeci">packed_spinlock &amp; operator=(packed_spinlock const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html"><div class="ttname"><a href="classripple_1_1spinlock.html">ripple::spinlock</a></div><div class="ttdoc">A spinlock implemented on top of an atomic integer.</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00166">spinlock.h:167</a></div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html_a039c6e7ea6986a10c5b846411d6b7d21"><div class="ttname"><a href="classripple_1_1spinlock.html#a039c6e7ea6986a10c5b846411d6b7d21">ripple::spinlock::unlock</a></div><div class="ttdeci">void unlock()</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00217">spinlock.h:217</a></div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html_a0ba6bed87cc5c3da6ce85da9f020358e"><div class="ttname"><a href="classripple_1_1spinlock.html#a0ba6bed87cc5c3da6ce85da9f020358e">ripple::spinlock::operator=</a></div><div class="ttdeci">spinlock &amp; operator=(spinlock const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html_a20d16e13b4586293281bcfeb06abe834"><div class="ttname"><a href="classripple_1_1spinlock.html#a20d16e13b4586293281bcfeb06abe834">ripple::spinlock::spinlock</a></div><div class="ttdeci">spinlock(spinlock const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html_a2da794f4f35024506fcfbf754c68fc95"><div class="ttname"><a href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">ripple::spinlock::lock_</a></div><div class="ttdeci">std::atomic&lt; T &gt; &amp; lock_</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00172">spinlock.h:172</a></div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html_a35d745b9bf6cb4a53fed73e0b6468a8b"><div class="ttname"><a href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b">ripple::spinlock::try_lock</a></div><div class="ttdeci">bool try_lock()</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00191">spinlock.h:191</a></div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html_a48794dec2a00dfb965568163ffdfe0b8"><div class="ttname"><a href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">ripple::spinlock::lock</a></div><div class="ttdeci">void lock()</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00203">spinlock.h:203</a></div></div>
<div class="ttc" id="aclassripple_1_1spinlock_html_ad7541682f7281ab8d2ce12941923fc41"><div class="ttname"><a href="classripple_1_1spinlock.html#ad7541682f7281ab8d2ce12941923fc41">ripple::spinlock::spinlock</a></div><div class="ttdeci">spinlock(std::atomic&lt; T &gt; &amp;lock)</div><div class="ttdoc">Grabs the.</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00186">spinlock.h:186</a></div></div>
<div class="ttc" id="adeclval_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/declval.html">std::declval</a></div><div class="ttdeci">T declval(T... args)</div></div>
<div class="ttc" id="afetch_and_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/atomic/atomic/fetch_and.html">std::atomic::fetch_and</a></div><div class="ttdeci">T fetch_and(T... args)</div></div>
<div class="ttc" id="ais_same_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a></div><div class="ttdeci">T is_same_v</div></div>
<div class="ttc" id="alimits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/limits.html">limits</a></div></div>
<div class="ttc" id="anamespaceripple_1_1detail_html_a86d9198b3b1df674eb3345f3ad8f4320"><div class="ttname"><a href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320">ripple::detail::spin_pause</a></div><div class="ttdeci">void spin_pause() noexcept</div><div class="ttdoc">Inform the processor that we are in a tight spin-wait loop.</div><div class="ttdef"><b>Definition</b> <a href="spinlock_8h_source.html#l00045">spinlock.h:45</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anumeric_limits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits</a></div></div>
<div class="ttc" id="atype_traits_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a></div></div>
</div><!-- fragment --></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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink