mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 12:05:53 +00:00
258 lines
37 KiB
HTML
258 lines
37 KiB
HTML
<!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=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_5f536ab1985a8dcd28bcfd618bc58e92.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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a 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 name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright 2022, Nikolaos D. Bougalis <nikb@bougalis.net></span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a 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 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 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 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 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 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 name="l00016"></a><span class="lineno"> 16</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#ifndef RIPPLE_BASICS_SPINLOCK_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define RIPPLE_BASICS_SPINLOCK_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/atomic.html">atomic</a>></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a>></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/limits.html">limits</a>></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/type_traits.html">type_traits</a>></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifndef __aarch64__</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <immintrin.h></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>detail {</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">inline</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320"> 44</a></span> <a class="code" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320">spin_pause</a>() noexcept</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> {</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#ifdef __aarch64__</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">asm</span> <span class="keyword">volatile</span>(<span class="stringliteral">"yield"</span>);</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  _mm_pause();</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> }</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <span class="comment">// namespace detail</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html"> 89</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1packed__spinlock.html">packed_spinlock</a></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> {</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// clang-format off</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857"> 92</a></span>  static_assert(std::is_unsigned_v<T>);</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  static_assert(<a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T>::is_always_lock_free</a>);</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  static_assert(</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a><decltype(<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/declval.html">std::declval</a><<a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T></a>&>().fetch_or(0)), T> &&</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::is_same_v</a><decltype(<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/declval.html">std::declval</a><<a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T></a>&>().fetch_and(0)), T>,</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="stringliteral">"std::atomic<T>::fetch_and(T) and std::atomic<T>::fetch_and(T) are required by packed_spinlock"</span>);</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="comment">// clang-format on</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T></a>& <a class="code" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>;</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b"> 102</a></span>  T <span class="keyword">const</span> <a class="code" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">mask_</a>;</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="classripple_1_1packed__spinlock.html#a9b50344098f14a88e3cf3bf75f9eca45">packed_spinlock</a>(<a class="code" href="classripple_1_1packed__spinlock.html">packed_spinlock</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <a class="code" href="classripple_1_1packed__spinlock.html">packed_spinlock</a>&</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <a class="code" href="classripple_1_1packed__spinlock.html#a02dd3a51a505ba7bf9e913314549773d">operator=</a>(<a class="code" href="classripple_1_1packed__spinlock.html">packed_spinlock</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a6b795f06719bc2d90ed4f6a6007fb5fe"> 117</a></span>  <a class="code" href="classripple_1_1packed__spinlock.html#a6b795f06719bc2d90ed4f6a6007fb5fe">packed_spinlock</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T></a>& <a class="code" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63">lock</a>, <span class="keywordtype">int</span> index)</div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  : <a class="code" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>(<a class="code" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63">lock</a>), <a class="code" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">mask_</a>(static_cast<T>(1) << index)</div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  {</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  assert(index >= 0 && (<a class="code" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">mask_</a> != 0));</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  [[nodiscard]] <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#ad544b64b85215e6adcf96a37f7b14503"> 124</a></span>  <a class="code" href="classripple_1_1packed__spinlock.html#ad544b64b85215e6adcf96a37f7b14503">try_lock</a>()</div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  {</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  <span class="keywordflow">return</span> (<a class="code" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>.fetch_or(<a class="code" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">mask_</a>, std::memory_order_acquire) & <a class="code" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">mask_</a>) == 0;</div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  }</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63"> 130</a></span>  <a class="code" href="classripple_1_1packed__spinlock.html#a8d885a8f4e6fc078869345131e76be63">lock</a>()</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  {</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordflow">while</span> (!<a class="code" href="classripple_1_1packed__spinlock.html#ad544b64b85215e6adcf96a37f7b14503">try_lock</a>())</div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  {</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment">// The use of relaxed memory ordering here is intentional and</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="comment">// serves to help reduce cache coherency traffic during times</span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="comment">// of contention by avoiding writes that would definitely not</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment">// result in the lock being acquired.</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordflow">while</span> ((<a class="code" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>.load(std::memory_order_relaxed) & <a class="code" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">mask_</a>) != 0)</div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <a class="code" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320">detail::spin_pause</a>();</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  }</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  }</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  </div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"><a class="line" href="classripple_1_1packed__spinlock.html#a54ab44d231a3a27eda752596b3f69e11"> 144</a></span>  <a class="code" href="classripple_1_1packed__spinlock.html#a54ab44d231a3a27eda752596b3f69e11">unlock</a>()</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  {</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  <a class="code" href="classripple_1_1packed__spinlock.html#a1f775dfb309d7f877b5075c05a29d857">bits_</a>.fetch_and(~<a class="code" href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">mask_</a>, std::memory_order_release);</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  }</div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> };</div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  </div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="keyword">template</span> <<span class="keyword">class</span> T></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html"> 163</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1spinlock.html">spinlock</a></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> {</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95"> 165</a></span>  static_assert(std::is_unsigned_v<T>);</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  static_assert(<a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T>::is_always_lock_free</a>);</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T></a>& <a class="code" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>;</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  </div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  <a class="code" href="classripple_1_1spinlock.html#a20d16e13b4586293281bcfeb06abe834">spinlock</a>(<a class="code" href="classripple_1_1spinlock.html">spinlock</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  <a class="code" href="classripple_1_1spinlock.html">spinlock</a>&</div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="classripple_1_1spinlock.html#a7545a4bdd8c072d3841a8655560be575">operator=</a>(<a class="code" href="classripple_1_1spinlock.html">spinlock</a> <span class="keyword">const</span>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  </div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#ad7541682f7281ab8d2ce12941923fc41"> 183</a></span>  <a class="code" href="classripple_1_1spinlock.html#ad7541682f7281ab8d2ce12941923fc41">spinlock</a>(<a class="codeRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic<T></a>& <a class="code" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a>) : <a class="code" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>(<a class="code" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a>)</div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  {</div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  }</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  </div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  [[nodiscard]] <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b"> 188</a></span>  <a class="code" href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b">try_lock</a>()</div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  {</div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  T expected = 0;</div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  </div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>.compare_exchange_weak(</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  expected,</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/numeric_limits.html">std::numeric_limits<T>::max</a>(),</div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  std::memory_order_acquire,</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  std::memory_order_relaxed);</div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  }</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  </div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8"> 200</a></span>  <a class="code" href="classripple_1_1spinlock.html#a48794dec2a00dfb965568163ffdfe0b8">lock</a>()</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  {</div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordflow">while</span> (!<a class="code" href="classripple_1_1spinlock.html#a35d745b9bf6cb4a53fed73e0b6468a8b">try_lock</a>())</div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  {</div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="comment">// The use of relaxed memory ordering here is intentional and</span></div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  <span class="comment">// serves to help reduce cache coherency traffic during times</span></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  <span class="comment">// of contention by avoiding writes that would definitely not</span></div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  <span class="comment">// result in the lock being acquired.</span></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keywordflow">while</span> (<a class="code" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>.load(std::memory_order_relaxed) != 0)</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  <a class="code" href="namespaceripple_1_1detail.html#a86d9198b3b1df674eb3345f3ad8f4320">detail::spin_pause</a>();</div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  }</div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  }</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  </div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"><a class="line" href="classripple_1_1spinlock.html#a039c6e7ea6986a10c5b846411d6b7d21"> 214</a></span>  <a class="code" href="classripple_1_1spinlock.html#a039c6e7ea6986a10c5b846411d6b7d21">unlock</a>()</div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  {</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <a class="code" href="classripple_1_1spinlock.html#a2da794f4f35024506fcfbf754c68fc95">lock_</a>.store(0, std::memory_order_release);</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  }</div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> };</div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  </div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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="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 &)=delete</div></div>
|
|
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_a02dd3a51a505ba7bf9e913314549773d"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#a02dd3a51a505ba7bf9e913314549773d">ripple::packed_spinlock::operator=</a></div><div class="ttdeci">packed_spinlock & operator=(packed_spinlock const &)=delete</div></div>
|
|
<div class="ttc" id="aclassripple_1_1packed__spinlock_html_add775fd5d7375664092b675670d5ca6b"><div class="ttname"><a href="classripple_1_1packed__spinlock.html#add775fd5d7375664092b675670d5ca6b">ripple::packed_spinlock::mask_</a></div><div class="ttdeci">const T mask_</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"><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#l00089">spinlock.h:89</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< T > & bits_</div><div class="ttdef"><b>Definition:</b> <a href="spinlock_8h_source.html#l00092">spinlock.h:92</a></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#l00124">spinlock.h:124</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#l00144">spinlock.h:144</a></div></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_1spinlock_html_a7545a4bdd8c072d3841a8655560be575"><div class="ttname"><a href="classripple_1_1spinlock.html#a7545a4bdd8c072d3841a8655560be575">ripple::spinlock::operator=</a></div><div class="ttdeci">spinlock & operator=(spinlock const &)=delete</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#l00214">spinlock.h:214</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</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< T > &lock)</div><div class="ttdoc">Grabs the.</div><div class="ttdef"><b>Definition:</b> <a href="spinlock_8h_source.html#l00183">spinlock.h:183</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#l00044">spinlock.h:44</a></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="acassert_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a></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#l00163">spinlock.h:163</a></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< T > & lock_</div><div class="ttdef"><b>Definition:</b> <a href="spinlock_8h_source.html#l00165">spinlock.h:165</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#l00200">spinlock.h:200</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#l00188">spinlock.h:188</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#l00130">spinlock.h:130</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="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< T > &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#l00117">spinlock.h:117</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 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="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 &)=delete</div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|