342 lines
No EOL
18 KiB
HTML
342 lines
No EOL
18 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="rustdoc">
|
||
<meta name="description" content="Source to the Rust file `/Users/holmerj/.cargo/registry/src/github.com-88ac128001ac3a9a/crossbeam-0.2.9/src/mem/epoch/participants.rs`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang">
|
||
|
||
<title>participants.rs.html -- source</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../../../rustdoc.css">
|
||
<link rel="stylesheet" type="text/css" href="../../../../main.css">
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc">
|
||
<!--[if lte IE 8]>
|
||
<div class="warning">
|
||
This old browser is unsupported and will most likely display funky
|
||
things.
|
||
</div>
|
||
<![endif]-->
|
||
|
||
|
||
|
||
<nav class="sidebar">
|
||
|
||
|
||
</nav>
|
||
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content source"><pre class="line-numbers"><span id="1"> 1</span>
|
||
<span id="2"> 2</span>
|
||
<span id="3"> 3</span>
|
||
<span id="4"> 4</span>
|
||
<span id="5"> 5</span>
|
||
<span id="6"> 6</span>
|
||
<span id="7"> 7</span>
|
||
<span id="8"> 8</span>
|
||
<span id="9"> 9</span>
|
||
<span id="10"> 10</span>
|
||
<span id="11"> 11</span>
|
||
<span id="12"> 12</span>
|
||
<span id="13"> 13</span>
|
||
<span id="14"> 14</span>
|
||
<span id="15"> 15</span>
|
||
<span id="16"> 16</span>
|
||
<span id="17"> 17</span>
|
||
<span id="18"> 18</span>
|
||
<span id="19"> 19</span>
|
||
<span id="20"> 20</span>
|
||
<span id="21"> 21</span>
|
||
<span id="22"> 22</span>
|
||
<span id="23"> 23</span>
|
||
<span id="24"> 24</span>
|
||
<span id="25"> 25</span>
|
||
<span id="26"> 26</span>
|
||
<span id="27"> 27</span>
|
||
<span id="28"> 28</span>
|
||
<span id="29"> 29</span>
|
||
<span id="30"> 30</span>
|
||
<span id="31"> 31</span>
|
||
<span id="32"> 32</span>
|
||
<span id="33"> 33</span>
|
||
<span id="34"> 34</span>
|
||
<span id="35"> 35</span>
|
||
<span id="36"> 36</span>
|
||
<span id="37"> 37</span>
|
||
<span id="38"> 38</span>
|
||
<span id="39"> 39</span>
|
||
<span id="40"> 40</span>
|
||
<span id="41"> 41</span>
|
||
<span id="42"> 42</span>
|
||
<span id="43"> 43</span>
|
||
<span id="44"> 44</span>
|
||
<span id="45"> 45</span>
|
||
<span id="46"> 46</span>
|
||
<span id="47"> 47</span>
|
||
<span id="48"> 48</span>
|
||
<span id="49"> 49</span>
|
||
<span id="50"> 50</span>
|
||
<span id="51"> 51</span>
|
||
<span id="52"> 52</span>
|
||
<span id="53"> 53</span>
|
||
<span id="54"> 54</span>
|
||
<span id="55"> 55</span>
|
||
<span id="56"> 56</span>
|
||
<span id="57"> 57</span>
|
||
<span id="58"> 58</span>
|
||
<span id="59"> 59</span>
|
||
<span id="60"> 60</span>
|
||
<span id="61"> 61</span>
|
||
<span id="62"> 62</span>
|
||
<span id="63"> 63</span>
|
||
<span id="64"> 64</span>
|
||
<span id="65"> 65</span>
|
||
<span id="66"> 66</span>
|
||
<span id="67"> 67</span>
|
||
<span id="68"> 68</span>
|
||
<span id="69"> 69</span>
|
||
<span id="70"> 70</span>
|
||
<span id="71"> 71</span>
|
||
<span id="72"> 72</span>
|
||
<span id="73"> 73</span>
|
||
<span id="74"> 74</span>
|
||
<span id="75"> 75</span>
|
||
<span id="76"> 76</span>
|
||
<span id="77"> 77</span>
|
||
<span id="78"> 78</span>
|
||
<span id="79"> 79</span>
|
||
<span id="80"> 80</span>
|
||
<span id="81"> 81</span>
|
||
<span id="82"> 82</span>
|
||
<span id="83"> 83</span>
|
||
<span id="84"> 84</span>
|
||
<span id="85"> 85</span>
|
||
<span id="86"> 86</span>
|
||
<span id="87"> 87</span>
|
||
<span id="88"> 88</span>
|
||
<span id="89"> 89</span>
|
||
<span id="90"> 90</span>
|
||
<span id="91"> 91</span>
|
||
<span id="92"> 92</span>
|
||
<span id="93"> 93</span>
|
||
<span id="94"> 94</span>
|
||
<span id="95"> 95</span>
|
||
<span id="96"> 96</span>
|
||
<span id="97"> 97</span>
|
||
<span id="98"> 98</span>
|
||
<span id="99"> 99</span>
|
||
<span id="100">100</span>
|
||
<span id="101">101</span>
|
||
<span id="102">102</span>
|
||
<span id="103">103</span>
|
||
<span id="104">104</span>
|
||
<span id="105">105</span>
|
||
<span id="106">106</span>
|
||
<span id="107">107</span>
|
||
<span id="108">108</span>
|
||
<span id="109">109</span>
|
||
<span id="110">110</span>
|
||
<span id="111">111</span>
|
||
<span id="112">112</span>
|
||
<span id="113">113</span>
|
||
<span id="114">114</span>
|
||
<span id="115">115</span>
|
||
<span id="116">116</span>
|
||
<span id="117">117</span>
|
||
</pre><pre class='rust '>
|
||
<span class='comment'>// Manages the global participant list, which is an intrustive list in</span>
|
||
<span class='comment'>// which items are lazily removed on traversal (after being</span>
|
||
<span class='comment'>// "logically" deleted by becoming inactive.)</span>
|
||
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>mem</span>;
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>ops</span>::{<span class='ident'>Deref</span>, <span class='ident'>DerefMut</span>};
|
||
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>sync</span>::<span class='ident'>atomic</span>::<span class='ident'>Ordering</span>::{<span class='ident'>Relaxed</span>, <span class='ident'>Acquire</span>, <span class='ident'>Release</span>};
|
||
|
||
<span class='kw'>use</span> <span class='ident'>mem</span>::<span class='ident'>epoch</span>::{<span class='ident'>Atomic</span>, <span class='ident'>Owned</span>, <span class='ident'>Guard</span>};
|
||
<span class='kw'>use</span> <span class='ident'>mem</span>::<span class='ident'>epoch</span>::<span class='ident'>participant</span>::<span class='ident'>Participant</span>;
|
||
<span class='kw'>use</span> <span class='ident'>mem</span>::<span class='ident'>CachePadded</span>;
|
||
|
||
<span class='doccomment'>/// Global, threadsafe list of threads participating in epoch management.</span>
|
||
<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Participants</span> {
|
||
<span class='ident'>head</span>: <span class='ident'>Atomic</span><span class='op'><</span><span class='ident'>ParticipantNode</span><span class='op'>></span>
|
||
}
|
||
|
||
<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>ParticipantNode</span>(<span class='ident'>CachePadded</span><span class='op'><</span><span class='ident'>Participant</span><span class='op'>></span>);
|
||
|
||
<span class='kw'>impl</span> <span class='ident'>ParticipantNode</span> {
|
||
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>ParticipantNode</span> {
|
||
<span class='ident'>ParticipantNode</span>(<span class='ident'>CachePadded</span>::<span class='ident'>new</span>(<span class='ident'>Participant</span>::<span class='ident'>new</span>()))
|
||
}
|
||
}
|
||
|
||
<span class='kw'>impl</span> <span class='ident'>Deref</span> <span class='kw'>for</span> <span class='ident'>ParticipantNode</span> {
|
||
<span class='kw'>type</span> <span class='ident'>Target</span> <span class='op'>=</span> <span class='ident'>Participant</span>;
|
||
<span class='kw'>fn</span> <span class='ident'>deref</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='ident'>Participant</span> {
|
||
<span class='kw-2'>&</span><span class='self'>self</span>.<span class='number'>0</span>
|
||
}
|
||
}
|
||
|
||
<span class='kw'>impl</span> <span class='ident'>DerefMut</span> <span class='kw'>for</span> <span class='ident'>ParticipantNode</span> {
|
||
<span class='kw'>fn</span> <span class='ident'>deref_mut</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='ident'>Participant</span> {
|
||
<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>.<span class='number'>0</span>
|
||
}
|
||
}
|
||
|
||
<span class='kw'>impl</span> <span class='ident'>Participants</span> {
|
||
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>not</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"nightly"</span>))]</span>
|
||
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>Participants</span> {
|
||
<span class='ident'>Participants</span> { <span class='ident'>head</span>: <span class='ident'>Atomic</span>::<span class='ident'>null</span>() }
|
||
}
|
||
|
||
<span class='attribute'>#[<span class='ident'>cfg</span>(<span class='ident'>feature</span> <span class='op'>=</span> <span class='string'>"nightly"</span>)]</span>
|
||
<span class='kw'>pub</span> <span class='kw'>const</span> <span class='kw'>fn</span> <span class='ident'>new</span>() <span class='op'>-></span> <span class='ident'>Participants</span> {
|
||
<span class='ident'>Participants</span> { <span class='ident'>head</span>: <span class='ident'>Atomic</span>::<span class='ident'>null</span>() }
|
||
}
|
||
|
||
<span class='doccomment'>/// Enroll a new thread in epoch management by adding a new `Particpant`</span>
|
||
<span class='doccomment'>/// record to the global list.</span>
|
||
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>enroll</span>(<span class='kw-2'>&</span><span class='self'>self</span>) <span class='op'>-></span> <span class='op'>*</span><span class='kw'>const</span> <span class='ident'>Participant</span> {
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>participant</span> <span class='op'>=</span> <span class='ident'>Owned</span>::<span class='ident'>new</span>(<span class='ident'>ParticipantNode</span>::<span class='ident'>new</span>());
|
||
|
||
<span class='comment'>// we ultimately use epoch tracking to free Participant nodes, but we</span>
|
||
<span class='comment'>// can't actually enter an epoch here, so fake it; we know the node</span>
|
||
<span class='comment'>// can't be removed until marked inactive anyway.</span>
|
||
<span class='kw'>let</span> <span class='ident'>fake_guard</span> <span class='op'>=</span> ();
|
||
<span class='kw'>let</span> <span class='ident'>g</span>: <span class='kw-2'>&</span><span class='lifetime'>'static</span> <span class='ident'>Guard</span> <span class='op'>=</span> <span class='kw'>unsafe</span> { <span class='ident'>mem</span>::<span class='ident'>transmute</span>(<span class='kw-2'>&</span><span class='ident'>fake_guard</span>) };
|
||
<span class='kw'>loop</span> {
|
||
<span class='kw'>let</span> <span class='ident'>head</span> <span class='op'>=</span> <span class='self'>self</span>.<span class='ident'>head</span>.<span class='ident'>load</span>(<span class='ident'>Relaxed</span>, <span class='ident'>g</span>);
|
||
<span class='ident'>participant</span>.<span class='ident'>next</span>.<span class='ident'>store_shared</span>(<span class='ident'>head</span>, <span class='ident'>Relaxed</span>);
|
||
<span class='kw'>match</span> <span class='self'>self</span>.<span class='ident'>head</span>.<span class='ident'>cas_and_ref</span>(<span class='ident'>head</span>, <span class='ident'>participant</span>, <span class='ident'>Release</span>, <span class='ident'>g</span>) {
|
||
<span class='prelude-val'>Ok</span>(<span class='ident'>shared</span>) <span class='op'>=></span> {
|
||
<span class='kw'>let</span> <span class='ident'>shared</span>: <span class='kw-2'>&</span><span class='ident'>Participant</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='ident'>shared</span>;
|
||
<span class='kw'>return</span> <span class='ident'>shared</span>;
|
||
}
|
||
<span class='prelude-val'>Err</span>(<span class='ident'>owned</span>) <span class='op'>=></span> {
|
||
<span class='ident'>participant</span> <span class='op'>=</span> <span class='ident'>owned</span>;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>iter</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span>(<span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='self'>self</span>, <span class='ident'>g</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>Guard</span>) <span class='op'>-></span> <span class='ident'>Iter</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> {
|
||
<span class='ident'>Iter</span> {
|
||
<span class='ident'>guard</span>: <span class='ident'>g</span>,
|
||
<span class='ident'>next</span>: <span class='kw-2'>&</span><span class='self'>self</span>.<span class='ident'>head</span>,
|
||
<span class='ident'>needs_acq</span>: <span class='boolval'>true</span>,
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class='kw'>pub</span> <span class='kw'>struct</span> <span class='ident'>Iter</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> {
|
||
<span class='comment'>// pin to an epoch so that we can free inactive nodes</span>
|
||
<span class='ident'>guard</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>Guard</span>,
|
||
<span class='ident'>next</span>: <span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>Atomic</span><span class='op'><</span><span class='ident'>ParticipantNode</span><span class='op'>></span>,
|
||
|
||
<span class='comment'>// an Acquire read is needed only for the first read, due to release</span>
|
||
<span class='comment'>// sequences</span>
|
||
<span class='ident'>needs_acq</span>: <span class='ident'>bool</span>,
|
||
}
|
||
|
||
<span class='kw'>impl</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> <span class='ident'>Iterator</span> <span class='kw'>for</span> <span class='ident'>Iter</span><span class='op'><</span><span class='lifetime'>'a</span><span class='op'>></span> {
|
||
<span class='kw'>type</span> <span class='ident'>Item</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>Participant</span>;
|
||
<span class='kw'>fn</span> <span class='ident'>next</span>(<span class='kw-2'>&</span><span class='kw-2'>mut</span> <span class='self'>self</span>) <span class='op'>-></span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='kw-2'>&</span><span class='lifetime'>'a</span> <span class='ident'>Participant</span><span class='op'>></span> {
|
||
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>cur</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='self'>self</span>.<span class='ident'>needs_acq</span> {
|
||
<span class='self'>self</span>.<span class='ident'>needs_acq</span> <span class='op'>=</span> <span class='boolval'>false</span>;
|
||
<span class='self'>self</span>.<span class='ident'>next</span>.<span class='ident'>load</span>(<span class='ident'>Acquire</span>, <span class='self'>self</span>.<span class='ident'>guard</span>)
|
||
} <span class='kw'>else</span> {
|
||
<span class='self'>self</span>.<span class='ident'>next</span>.<span class='ident'>load</span>(<span class='ident'>Relaxed</span>, <span class='self'>self</span>.<span class='ident'>guard</span>)
|
||
};
|
||
|
||
<span class='kw'>while</span> <span class='kw'>let</span> <span class='prelude-val'>Some</span>(<span class='ident'>n</span>) <span class='op'>=</span> <span class='ident'>cur</span> {
|
||
<span class='comment'>// attempt to clean up inactive nodes</span>
|
||
<span class='kw'>if</span> <span class='op'>!</span><span class='ident'>n</span>.<span class='ident'>active</span>.<span class='ident'>load</span>(<span class='ident'>Relaxed</span>) {
|
||
<span class='ident'>cur</span> <span class='op'>=</span> <span class='ident'>n</span>.<span class='ident'>next</span>.<span class='ident'>load</span>(<span class='ident'>Relaxed</span>, <span class='self'>self</span>.<span class='ident'>guard</span>);
|
||
<span class='comment'>// TODO: actually reclaim inactive participants!</span>
|
||
} <span class='kw'>else</span> {
|
||
<span class='self'>self</span>.<span class='ident'>next</span> <span class='op'>=</span> <span class='kw-2'>&</span><span class='ident'>n</span>.<span class='ident'>next</span>;
|
||
<span class='kw'>return</span> <span class='prelude-val'>Some</span>(<span class='kw-2'>&</span><span class='ident'>n</span>)
|
||
}
|
||
}
|
||
|
||
<span class='prelude-val'>None</span>
|
||
}
|
||
}
|
||
</pre>
|
||
</section>
|
||
<section id='search' class="content hidden"></section>
|
||
|
||
<section class="footer"></section>
|
||
|
||
<aside id="help" class="hidden">
|
||
<div>
|
||
<h1 class="hidden">Help</h1>
|
||
|
||
<div class="shortcuts">
|
||
<h2>Keyboard Shortcuts</h2>
|
||
|
||
<dl>
|
||
<dt>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
</dl>
|
||
</div>
|
||
|
||
<div class="infos">
|
||
<h2>Search Tricks</h2>
|
||
|
||
<p>
|
||
Prefix searches with a type followed by a colon (e.g.
|
||
<code>fn:</code>) to restrict the search to a given type.
|
||
</p>
|
||
|
||
<p>
|
||
Accepted types are: <code>fn</code>, <code>mod</code>,
|
||
<code>struct</code>, <code>enum</code>,
|
||
<code>trait</code>, <code>type</code>, <code>macro</code>,
|
||
and <code>const</code>.
|
||
</p>
|
||
|
||
<p>
|
||
Search functions by type signature (e.g.
|
||
<code>vec -> usize</code> or <code>* -> vec</code>)
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../../../";
|
||
window.currentCrate = "crossbeam";
|
||
window.playgroundUrl = "";
|
||
</script>
|
||
<script src="../../../../jquery.js"></script>
|
||
<script src="../../../../main.js"></script>
|
||
|
||
<script defer src="../../../../search-index.js"></script>
|
||
</body>
|
||
</html> |