<!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 of the Rust file `/home/sangenya/.cargo/registry/src/github.com-1ecc6299db9ec823/rayon-core-1.9.1/src/sleep/counters.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>counters.rs - source</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../../ayu.css" disabled ><script id="default-settings"></script><script src="../../../storage.js"></script><script src="../../../crates.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a href='../../../rayon_core/index.html'><div class='logo-container rust-logo'><img src='../../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img src="../../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../../settings.html" title="settings"><img src="../../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><div class="example-wrap"><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>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
</pre><pre class="rust">
<span class="kw">use</span> <span class="ident">std::sync::atomic</span>::{<span class="ident">AtomicUsize</span>, <span class="ident">Ordering</span>};
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct</span> <span class="ident">AtomicCounters</span> {
<span class="doccomment">/// Packs together a number of counters. The counters are ordered as</span>
<span class="doccomment">/// follows, from least to most significant bits (here, we assuming</span>
<span class="doccomment">/// that [`THREADS_BITS`] is equal to 10):</span>
<span class="doccomment">///</span>
<span class="doccomment">/// * Bits 0..10: Stores the number of **sleeping threads**</span>
<span class="doccomment">/// * Bits 10..20: Stores the number of **inactive threads**</span>
<span class="doccomment">/// * Bits 20..: Stores the **job event counter** (JEC)</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This uses 10 bits ([`THREADS_BITS`]) to encode the number of threads. Note</span>
<span class="doccomment">/// that the total number of bits (and hence the number of bits used for the</span>
<span class="doccomment">/// JEC) will depend on whether we are using a 32- or 64-bit architecture.</span>
<span class="ident">value</span>: <span class="ident">AtomicUsize</span>,
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>)]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct</span> <span class="ident">Counters</span> {
<span class="ident">word</span>: <span class="ident">usize</span>,
}
<span class="doccomment">/// A value read from the **Jobs Event Counter**.</span>
<span class="doccomment">/// See the [`README.md`](README.md) for more</span>
<span class="doccomment">/// coverage of how the jobs event counter works.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Debug</span>, <span class="ident">PartialEq</span>, <span class="ident">PartialOrd</span>)]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct</span> <span class="ident">JobsEventCounter</span>(<span class="ident">usize</span>);
<span class="kw">impl</span> <span class="ident">JobsEventCounter</span> {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">const</span> <span class="ident">DUMMY</span>: <span class="ident">JobsEventCounter</span> <span class="op">=</span> <span class="ident">JobsEventCounter</span>(<span class="ident">std::usize::MAX</span>);
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">as_usize</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="self">self</span>.<span class="number">0</span>
}
<span class="doccomment">/// The JEC "is sleepy" if the last thread to increment it was in the</span>
<span class="doccomment">/// process of becoming sleepy. This is indicated by its value being *even*.</span>
<span class="doccomment">/// When new jobs are posted, they check if the JEC is sleepy, and if so</span>
<span class="doccomment">/// they incremented it.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">is_sleepy</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
(<span class="self">self</span>.<span class="ident">as_usize</span>() <span class="op">&</span> <span class="number">1</span>) <span class="op">=</span><span class="op">=</span> <span class="number">0</span>
}
<span class="doccomment">/// The JEC "is active" if the last thread to increment it was posting new</span>
<span class="doccomment">/// work. This is indicated by its value being *odd*. When threads get</span>
<span class="doccomment">/// sleepy, they will check if the JEC is active, and increment it.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">is_active</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="op">!</span><span class="self">self</span>.<span class="ident">is_sleepy</span>()
}
}
<span class="doccomment">/// Number of bits used for the thread counters.</span>
<span class="kw">const</span> <span class="ident">THREADS_BITS</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">10</span>;
<span class="doccomment">/// Bits to shift to select the sleeping threads</span>
<span class="doccomment">/// (used with `select_bits`).</span>
<span class="kw">const</span> <span class="ident">SLEEPING_SHIFT</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">0</span> <span class="op">*</span> <span class="ident">THREADS_BITS</span>;
<span class="doccomment">/// Bits to shift to select the inactive threads</span>
<span class="doccomment">/// (used with `select_bits`).</span>
<span class="kw">const</span> <span class="ident">INACTIVE_SHIFT</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">1</span> <span class="op">*</span> <span class="ident">THREADS_BITS</span>;
<span class="doccomment">/// Bits to shift to select the JEC</span>
<span class="doccomment">/// (use JOBS_BITS).</span>
<span class="kw">const</span> <span class="ident">JEC_SHIFT</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">2</span> <span class="op">*</span> <span class="ident">THREADS_BITS</span>;
<span class="doccomment">/// Max value for the thread counters.</span>
<span class="kw">const</span> <span class="ident">THREADS_MAX</span>: <span class="ident">usize</span> <span class="op">=</span> (<span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="ident">THREADS_BITS</span>) <span class="op">-</span> <span class="number">1</span>;
<span class="doccomment">/// Constant that can be added to add one sleeping thread.</span>
<span class="kw">const</span> <span class="ident">ONE_SLEEPING</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">1</span>;
<span class="doccomment">/// Constant that can be added to add one inactive thread.</span>
<span class="doccomment">/// An inactive thread is either idle, sleepy, or sleeping.</span>
<span class="kw">const</span> <span class="ident">ONE_INACTIVE</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="ident">INACTIVE_SHIFT</span>;
<span class="doccomment">/// Constant that can be added to add one to the JEC.</span>
<span class="kw">const</span> <span class="ident">ONE_JEC</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="ident">JEC_SHIFT</span>;
<span class="kw">impl</span> <span class="ident">AtomicCounters</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">AtomicCounters</span> {
<span class="ident">AtomicCounters</span> {
<span class="ident">value</span>: <span class="ident">AtomicUsize::new</span>(<span class="number">0</span>),
}
}
<span class="doccomment">/// Load and return the current value of the various counters.</span>
<span class="doccomment">/// This value can then be given to other method which will</span>
<span class="doccomment">/// attempt to update the counters via compare-and-swap.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">load</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">ordering</span>: <span class="ident">Ordering</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Counters</span> {
<span class="ident">Counters::new</span>(<span class="self">self</span>.<span class="ident">value</span>.<span class="ident">load</span>(<span class="ident">ordering</span>))
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">try_exchange</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">old_value</span>: <span class="ident">Counters</span>, <span class="ident">new_value</span>: <span class="ident">Counters</span>, <span class="ident">ordering</span>: <span class="ident">Ordering</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="self">self</span>.<span class="ident">value</span>
.<span class="ident">compare_exchange</span>(<span class="ident">old_value</span>.<span class="ident">word</span>, <span class="ident">new_value</span>.<span class="ident">word</span>, <span class="ident">ordering</span>, <span class="ident">Ordering::Relaxed</span>)
.<span class="ident">is_ok</span>()
}
<span class="doccomment">/// Adds an inactive thread. This cannot fail.</span>
<span class="doccomment">///</span>
<span class="doccomment">/// This should be invoked when a thread enters its idle loop looking</span>
<span class="doccomment">/// for work. It is decremented when work is found. Note that it is</span>
<span class="doccomment">/// not decremented if the thread transitions from idle to sleepy or sleeping;</span>
<span class="doccomment">/// so the number of inactive threads is always greater-than-or-equal</span>
<span class="doccomment">/// to the number of sleeping threads.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">add_inactive_thread</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="self">self</span>.<span class="ident">value</span>.<span class="ident">fetch_add</span>(<span class="ident">ONE_INACTIVE</span>, <span class="ident">Ordering::SeqCst</span>);
}
<span class="doccomment">/// Increments the jobs event counter if `increment_when`, when applied to</span>
<span class="doccomment">/// the current value, is true. Used to toggle the JEC from even (sleepy) to</span>
<span class="doccomment">/// odd (active) or vice versa. Returns the final value of the counters, for</span>
<span class="doccomment">/// which `increment_when` is guaranteed to return false.</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">increment_jobs_event_counter_if</span>(
<span class="kw-2">&</span><span class="self">self</span>,
<span class="ident">increment_when</span>: <span class="kw">impl</span> <span class="ident">Fn</span>(<span class="ident">JobsEventCounter</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span>,
) <span class="op">-</span><span class="op">></span> <span class="ident">Counters</span> {
<span class="kw">loop</span> {
<span class="kw">let</span> <span class="ident">old_value</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">load</span>(<span class="ident">Ordering::SeqCst</span>);
<span class="kw">if</span> <span class="ident">increment_when</span>(<span class="ident">old_value</span>.<span class="ident">jobs_counter</span>()) {
<span class="kw">let</span> <span class="ident">new_value</span> <span class="op">=</span> <span class="ident">old_value</span>.<span class="ident">increment_jobs_counter</span>();
<span class="kw">if</span> <span class="self">self</span>.<span class="ident">try_exchange</span>(<span class="ident">old_value</span>, <span class="ident">new_value</span>, <span class="ident">Ordering::SeqCst</span>) {
<span class="kw">return</span> <span class="ident">new_value</span>;
}
} <span class="kw">else</span> {
<span class="kw">return</span> <span class="ident">old_value</span>;
}
}
}
<span class="doccomment">/// Subtracts an inactive thread. This cannot fail. It is invoked</span>
<span class="doccomment">/// when a thread finds work and hence becomes active. It returns the</span>
<span class="doccomment">/// number of sleeping threads to wake up (if any).</span>
<span class="doccomment">///</span>
<span class="doccomment">/// See `add_inactive_thread`.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">sub_inactive_thread</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="kw">let</span> <span class="ident">old_value</span> <span class="op">=</span> <span class="ident">Counters::new</span>(<span class="self">self</span>.<span class="ident">value</span>.<span class="ident">fetch_sub</span>(<span class="ident">ONE_INACTIVE</span>, <span class="ident">Ordering::SeqCst</span>));
<span class="macro">debug_assert!</span>(
<span class="ident">old_value</span>.<span class="ident">inactive_threads</span>() <span class="op">></span> <span class="number">0</span>,
<span class="string">"sub_inactive_thread: old_value {:?} has no inactive threads"</span>,
<span class="ident">old_value</span>,
);
<span class="macro">debug_assert!</span>(
<span class="ident">old_value</span>.<span class="ident">sleeping_threads</span>() <span class="op"><</span><span class="op">=</span> <span class="ident">old_value</span>.<span class="ident">inactive_threads</span>(),
<span class="string">"sub_inactive_thread: old_value {:?} had {} sleeping threads and {} inactive threads"</span>,
<span class="ident">old_value</span>,
<span class="ident">old_value</span>.<span class="ident">sleeping_threads</span>(),
<span class="ident">old_value</span>.<span class="ident">inactive_threads</span>(),
);
<span class="comment">// Current heuristic: whenever an inactive thread goes away, if</span>
<span class="comment">// there are any sleeping threads, wake 'em up.</span>
<span class="kw">let</span> <span class="ident">sleeping_threads</span> <span class="op">=</span> <span class="ident">old_value</span>.<span class="ident">sleeping_threads</span>();
<span class="ident">std::cmp::min</span>(<span class="ident">sleeping_threads</span>, <span class="number">2</span>)
}
<span class="doccomment">/// Subtracts a sleeping thread. This cannot fail, but it is only</span>
<span class="doccomment">/// safe to do if you you know the number of sleeping threads is</span>
<span class="doccomment">/// non-zero (i.e., because you have just awoken a sleeping</span>
<span class="doccomment">/// thread).</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">sub_sleeping_thread</span>(<span class="kw-2">&</span><span class="self">self</span>) {
<span class="kw">let</span> <span class="ident">old_value</span> <span class="op">=</span> <span class="ident">Counters::new</span>(<span class="self">self</span>.<span class="ident">value</span>.<span class="ident">fetch_sub</span>(<span class="ident">ONE_SLEEPING</span>, <span class="ident">Ordering::SeqCst</span>));
<span class="macro">debug_assert!</span>(
<span class="ident">old_value</span>.<span class="ident">sleeping_threads</span>() <span class="op">></span> <span class="number">0</span>,
<span class="string">"sub_sleeping_thread: old_value {:?} had no sleeping threads"</span>,
<span class="ident">old_value</span>,
);
<span class="macro">debug_assert!</span>(
<span class="ident">old_value</span>.<span class="ident">sleeping_threads</span>() <span class="op"><</span><span class="op">=</span> <span class="ident">old_value</span>.<span class="ident">inactive_threads</span>(),
<span class="string">"sub_sleeping_thread: old_value {:?} had {} sleeping threads and {} inactive threads"</span>,
<span class="ident">old_value</span>,
<span class="ident">old_value</span>.<span class="ident">sleeping_threads</span>(),
<span class="ident">old_value</span>.<span class="ident">inactive_threads</span>(),
);
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">try_add_sleeping_thread</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">old_value</span>: <span class="ident">Counters</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> {
<span class="macro">debug_assert!</span>(
<span class="ident">old_value</span>.<span class="ident">inactive_threads</span>() <span class="op">></span> <span class="number">0</span>,
<span class="string">"try_add_sleeping_thread: old_value {:?} has no inactive threads"</span>,
<span class="ident">old_value</span>,
);
<span class="macro">debug_assert!</span>(
<span class="ident">old_value</span>.<span class="ident">sleeping_threads</span>() <span class="op"><</span> <span class="ident">THREADS_MAX</span>,
<span class="string">"try_add_sleeping_thread: old_value {:?} has too many sleeping threads"</span>,
<span class="ident">old_value</span>,
);
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">new_value</span> <span class="op">=</span> <span class="ident">old_value</span>;
<span class="ident">new_value</span>.<span class="ident">word</span> <span class="op">+</span><span class="op">=</span> <span class="ident">ONE_SLEEPING</span>;
<span class="self">self</span>.<span class="ident">try_exchange</span>(<span class="ident">old_value</span>, <span class="ident">new_value</span>, <span class="ident">Ordering::SeqCst</span>)
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">select_thread</span>(<span class="ident">word</span>: <span class="ident">usize</span>, <span class="ident">shift</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
((<span class="ident">word</span> <span class="op">></span><span class="op">></span> <span class="ident">shift</span>) <span class="kw">as</span> <span class="ident">usize</span>) <span class="op">&</span> <span class="ident">THREADS_MAX</span>
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">select_jec</span>(<span class="ident">word</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
(<span class="ident">word</span> <span class="op">></span><span class="op">></span> <span class="ident">JEC_SHIFT</span>) <span class="kw">as</span> <span class="ident">usize</span>
}
<span class="kw">impl</span> <span class="ident">Counters</span> {
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">word</span>: <span class="ident">usize</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Counters</span> {
<span class="ident">Counters</span> { <span class="ident">word</span> }
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">fn</span> <span class="ident">increment_jobs_counter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">Counters</span> {
<span class="comment">// We can freely add to JEC because it occupies the most significant bits.</span>
<span class="comment">// Thus it doesn't overflow into the other counters, just wraps itself.</span>
<span class="ident">Counters</span> {
<span class="ident">word</span>: <span class="self">self</span>.<span class="ident">word</span>.<span class="ident">wrapping_add</span>(<span class="ident">ONE_JEC</span>),
}
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">jobs_counter</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">JobsEventCounter</span> {
<span class="ident">JobsEventCounter</span>(<span class="ident">select_jec</span>(<span class="self">self</span>.<span class="ident">word</span>))
}
<span class="doccomment">/// The number of threads that are not actively</span>
<span class="doccomment">/// executing work. They may be idle, sleepy, or asleep.</span>
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">inactive_threads</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="ident">select_thread</span>(<span class="self">self</span>.<span class="ident">word</span>, <span class="ident">INACTIVE_SHIFT</span>)
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">awake_but_idle_threads</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="macro">debug_assert!</span>(
<span class="self">self</span>.<span class="ident">sleeping_threads</span>() <span class="op"><</span><span class="op">=</span> <span class="self">self</span>.<span class="ident">inactive_threads</span>(),
<span class="string">"sleeping threads: {} > raw idle threads {}"</span>,
<span class="self">self</span>.<span class="ident">sleeping_threads</span>(),
<span class="self">self</span>.<span class="ident">inactive_threads</span>()
);
<span class="self">self</span>.<span class="ident">inactive_threads</span>() <span class="op">-</span> <span class="self">self</span>.<span class="ident">sleeping_threads</span>()
}
<span class="attribute">#[<span class="ident">inline</span>]</span>
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn</span> <span class="ident">sleeping_threads</span>(<span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">usize</span> {
<span class="ident">select_thread</span>(<span class="self">self</span>.<span class="ident">word</span>, <span class="ident">SLEEPING_SHIFT</span>)
}
}
<span class="kw">impl</span> <span class="ident">std::fmt::Debug</span> <span class="kw">for</span> <span class="ident">Counters</span> {
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">fmt</span>: <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">std::fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">std::fmt::Result</span> {
<span class="kw">let</span> <span class="ident">word</span> <span class="op">=</span> <span class="macro">format!</span>(<span class="string">"{:016x}"</span>, <span class="self">self</span>.<span class="ident">word</span>);
<span class="ident">fmt</span>.<span class="ident">debug_struct</span>(<span class="string">"Counters"</span>)
.<span class="ident">field</span>(<span class="string">"word"</span>, <span class="kw-2">&</span><span class="ident">word</span>)
.<span class="ident">field</span>(<span class="string">"jobs"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">jobs_counter</span>().<span class="number">0</span>)
.<span class="ident">field</span>(<span class="string">"inactive"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">inactive_threads</span>())
.<span class="ident">field</span>(<span class="string">"sleeping"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="ident">sleeping_threads</span>())
.<span class="ident">finish</span>()
}
}
</pre></div>
</section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rayon_core" data-search-index-js="../../../search-index.js" data-search-js="../../../search.js"></div><script src="../../../main.js"></script><script src="../../../source-script.js"></script><script src="../../../source-files.js"></script></body></html>