166 lines
14 KiB
HTML
166 lines
14 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" 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.10.0"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>stdex: include/stdex/spinlock.hpp 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>
|
|
<script type="text/javascript" src="clipboard.js"></script>
|
|
<script type="text/javascript" src="cookie.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">stdex
|
|
</div>
|
|
<div id="projectbrief">Additional custom or not Standard C++ covered algorithms</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.10.0 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() { codefold.init(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_fca3c47b2ea228727bd6729832f89576.html">stdex</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">spinlock.hpp</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"> SPDX-License-Identifier: MIT</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> Copyright © 2023-2024 Amebis</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> </div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#ifdef _WIN32</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "windows.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include <intrin.h></span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include <atomic></span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="keyword">namespace </span>stdex</div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
|
|
<div class="foldopen" id="foldopen00021" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classstdex_1_1spinlock.html"> 21</a></span> <span class="keyword">class </span><a class="code hl_class" href="classstdex_1_1spinlock.html">spinlock</a></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="keyword">private</span>:</div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> std::atomic<bool> m_lock = { <span class="keyword">false</span> };</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">public</span>:</div>
|
|
<div class="foldopen" id="foldopen00030" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="classstdex_1_1spinlock.html#a97a72eaa96c16661bb6e268f7d5f0788"> 30</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classstdex_1_1spinlock.html#a97a72eaa96c16661bb6e268f7d5f0788">lock</a>() noexcept</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> {</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">for</span> (;;) {</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// Optimistically assume the lock is free on the first try</span></div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">if</span> (!m_lock.exchange(<span class="keyword">true</span>, std::memory_order_acquire))</div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keywordflow">return</span>;</div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="comment">// Wait for lock to be released without generating cache misses</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">while</span> (m_lock.load(std::memory_order_relaxed)) {</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// Issue X86 PAUSE or ARM YIELD instruction to reduce contention between</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// hyper-threads</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="preprocessor">#if _M_ARM || _M_ARM64</span></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> __yield();</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="preprocessor">#elif _M_IX86 || _M_X64</span></div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> _mm_pause();</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="preprocessor">#elif __aarch64__</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> __yield();</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="preprocessor">#elif __i386__ || __x86_64__</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> __builtin_ia32_pause();</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> }</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</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="foldopen" id="foldopen00059" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classstdex_1_1spinlock.html#a47aca0d4a40922892035d7f18dee8f32"> 59</a></span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classstdex_1_1spinlock.html#a47aca0d4a40922892035d7f18dee8f32">try_lock</a>() noexcept</div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> {</div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// First do a relaxed load to check if lock is free in order to prevent</span></div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// unnecessary cache misses if someone does while(!try_lock())</span></div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">return</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> !m_lock.load(std::memory_order_relaxed) &&</div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> !m_lock.exchange(<span class="keyword">true</span>, std::memory_order_acquire);</div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="foldopen" id="foldopen00071" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classstdex_1_1spinlock.html#aabdcf0cbe80a8eb5b68f656fb587d74a"> 71</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classstdex_1_1spinlock.html#aabdcf0cbe80a8eb5b68f656fb587d74a">unlock</a>() noexcept</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> {</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> m_lock.store(<span class="keyword">false</span>, std::memory_order_release);</div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> };</div>
|
|
</div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span>}</div>
|
|
<div class="ttc" id="aclassstdex_1_1spinlock_html"><div class="ttname"><a href="classstdex_1_1spinlock.html">stdex::spinlock</a></div><div class="ttdoc">Spin-lock.</div><div class="ttdef"><b>Definition</b> spinlock.hpp:22</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1spinlock_html_a47aca0d4a40922892035d7f18dee8f32"><div class="ttname"><a href="classstdex_1_1spinlock.html#a47aca0d4a40922892035d7f18dee8f32">stdex::spinlock::try_lock</a></div><div class="ttdeci">bool try_lock() noexcept</div><div class="ttdoc">Attempts to acquire the lock for the current execution agent (thread, process, task) without blocking...</div><div class="ttdef"><b>Definition</b> spinlock.hpp:59</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1spinlock_html_a97a72eaa96c16661bb6e268f7d5f0788"><div class="ttname"><a href="classstdex_1_1spinlock.html#a97a72eaa96c16661bb6e268f7d5f0788">stdex::spinlock::lock</a></div><div class="ttdeci">void lock() noexcept</div><div class="ttdoc">Blocks until a lock can be acquired for the current execution agent (thread, process,...</div><div class="ttdef"><b>Definition</b> spinlock.hpp:30</div></div>
|
|
<div class="ttc" id="aclassstdex_1_1spinlock_html_aabdcf0cbe80a8eb5b68f656fb587d74a"><div class="ttname"><a href="classstdex_1_1spinlock.html#aabdcf0cbe80a8eb5b68f656fb587d74a">stdex::spinlock::unlock</a></div><div class="ttdeci">void unlock() noexcept</div><div class="ttdoc">Releases the non-shared lock held by the execution agent.</div><div class="ttdef"><b>Definition</b> spinlock.hpp:71</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Tue Jan 23 2024 10:01:32 for stdex by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.10.0
|
|
</small></address>
|
|
</body>
|
|
</html>
|