| <!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 `/root/.cargo/git/checkouts/rayon-3b3b152053499ede/a07ce2e/rayon-core/src/thread_pool/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></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"><a class="sidebar-logo" href="../../../rayon_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../rayon_core/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-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> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Contains support for user-managed thread pools, represented by the |
| //! the [`ThreadPool`] type (see that struct for details). |
| //! |
| //! [`ThreadPool`]: struct.ThreadPool.html |
| |
| </span><span class="kw">use </span><span class="kw">crate</span>::broadcast::{<span class="self">self</span>, BroadcastContext}; |
| <span class="kw">use </span><span class="kw">crate</span>::join; |
| <span class="kw">use </span><span class="kw">crate</span>::registry::{Registry, ThreadSpawn, WorkerThread}; |
| <span class="kw">use </span><span class="kw">crate</span>::scope::{do_in_place_scope, do_in_place_scope_fifo}; |
| <span class="kw">use </span><span class="kw">crate</span>::spawn; |
| <span class="kw">use crate</span>::{scope, Scope}; |
| <span class="kw">use crate</span>::{scope_fifo, ScopeFifo}; |
| <span class="kw">use crate</span>::{ThreadPoolBuildError, ThreadPoolBuilder}; |
| <span class="kw">use </span>std::error::Error; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">mod </span>test; |
| |
| <span class="doccomment">/// Represents a user created [thread-pool]. |
| /// |
| /// Use a [`ThreadPoolBuilder`] to specify the number and/or names of threads |
| /// in the pool. After calling [`ThreadPoolBuilder::build()`], you can then |
| /// execute functions explicitly within this [`ThreadPool`] using |
| /// [`ThreadPool::install()`]. By contrast, top level rayon functions |
| /// (like `join()`) will execute implicitly within the current thread-pool. |
| /// |
| /// |
| /// ## Creating a ThreadPool |
| /// |
| /// ```rust |
| /// # use rayon_core as rayon; |
| /// let pool = rayon::ThreadPoolBuilder::new().num_threads(8).build().unwrap(); |
| /// ``` |
| /// |
| /// [`install()`][`ThreadPool::install()`] executes a closure in one of the `ThreadPool`'s |
| /// threads. In addition, any other rayon operations called inside of `install()` will also |
| /// execute in the context of the `ThreadPool`. |
| /// |
| /// When the `ThreadPool` is dropped, that's a signal for the threads it manages to terminate, |
| /// they will complete executing any remaining work that you have spawned, and automatically |
| /// terminate. |
| /// |
| /// |
| /// [thread-pool]: https://en.wikipedia.org/wiki/Thread_pool |
| /// [`ThreadPool`]: struct.ThreadPool.html |
| /// [`ThreadPool::new()`]: struct.ThreadPool.html#method.new |
| /// [`ThreadPoolBuilder`]: struct.ThreadPoolBuilder.html |
| /// [`ThreadPoolBuilder::build()`]: struct.ThreadPoolBuilder.html#method.build |
| /// [`ThreadPool::install()`]: struct.ThreadPool.html#method.install |
| </span><span class="kw">pub struct </span>ThreadPool { |
| registry: Arc<Registry>, |
| } |
| |
| <span class="kw">impl </span>ThreadPool { |
| <span class="attribute">#[deprecated(note = <span class="string">"Use `ThreadPoolBuilder::build`"</span>)] |
| #[allow(deprecated)] |
| </span><span class="doccomment">/// Deprecated in favor of `ThreadPoolBuilder::build`. |
| </span><span class="kw">pub fn </span>new(configuration: <span class="kw">crate</span>::Configuration) -> <span class="prelude-ty">Result</span><ThreadPool, Box<<span class="kw">dyn </span>Error>> { |
| <span class="self">Self</span>::build(configuration.into_builder()).map_err(Box::from) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>build<S>( |
| builder: ThreadPoolBuilder<S>, |
| ) -> <span class="prelude-ty">Result</span><ThreadPool, ThreadPoolBuildError> |
| <span class="kw">where |
| </span>S: ThreadSpawn, |
| { |
| <span class="kw">let </span>registry = Registry::new(builder)<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(ThreadPool { registry }) |
| } |
| |
| <span class="doccomment">/// Executes `op` within the threadpool. Any attempts to use |
| /// `join`, `scope`, or parallel iterators will then operate |
| /// within that threadpool. |
| /// |
| /// # Warning: thread-local data |
| /// |
| /// Because `op` is executing within the Rayon thread-pool, |
| /// thread-local data from the current thread will not be |
| /// accessible. |
| /// |
| /// # Panics |
| /// |
| /// If `op` should panic, that panic will be propagated. |
| /// |
| /// ## Using `install()` |
| /// |
| /// ```rust |
| /// # use rayon_core as rayon; |
| /// fn main() { |
| /// let pool = rayon::ThreadPoolBuilder::new().num_threads(8).build().unwrap(); |
| /// let n = pool.install(|| fib(20)); |
| /// println!("{}", n); |
| /// } |
| /// |
| /// fn fib(n: usize) -> usize { |
| /// if n == 0 || n == 1 { |
| /// return n; |
| /// } |
| /// let (a, b) = rayon::join(|| fib(n - 1), || fib(n - 2)); // runs inside of `pool` |
| /// return a + b; |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>install<OP, R>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) -> R |
| <span class="kw">where |
| </span>OP: FnOnce() -> R + Send, |
| R: Send, |
| { |
| <span class="self">self</span>.registry.in_worker(|<span class="kw">_</span>, <span class="kw">_</span>| op()) |
| } |
| |
| <span class="doccomment">/// Executes `op` within every thread in the threadpool. Any attempts to use |
| /// `join`, `scope`, or parallel iterators will then operate within that |
| /// threadpool. |
| /// |
| /// Broadcasts are executed on each thread after they have exhausted their |
| /// local work queue, before they attempt work-stealing from other threads. |
| /// The goal of that strategy is to run everywhere in a timely manner |
| /// *without* being too disruptive to current work. There may be alternative |
| /// broadcast styles added in the future for more or less aggressive |
| /// injection, if the need arises. |
| /// |
| /// # Warning: thread-local data |
| /// |
| /// Because `op` is executing within the Rayon thread-pool, |
| /// thread-local data from the current thread will not be |
| /// accessible. |
| /// |
| /// # Panics |
| /// |
| /// If `op` should panic on one or more threads, exactly one panic |
| /// will be propagated, only after all threads have completed |
| /// (or panicked) their own `op`. |
| /// |
| /// # Examples |
| /// |
| /// ``` |
| /// # use rayon_core as rayon; |
| /// use std::sync::atomic::{AtomicUsize, Ordering}; |
| /// |
| /// fn main() { |
| /// let pool = rayon::ThreadPoolBuilder::new().num_threads(5).build().unwrap(); |
| /// |
| /// // The argument gives context, including the index of each thread. |
| /// let v: Vec<usize> = pool.broadcast(|ctx| ctx.index() * ctx.index()); |
| /// assert_eq!(v, &[0, 1, 4, 9, 16]); |
| /// |
| /// // The closure can reference the local stack |
| /// let count = AtomicUsize::new(0); |
| /// pool.broadcast(|_| count.fetch_add(1, Ordering::Relaxed)); |
| /// assert_eq!(count.into_inner(), 5); |
| /// } |
| /// ``` |
| </span><span class="kw">pub fn </span>broadcast<OP, R>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) -> Vec<R> |
| <span class="kw">where |
| </span>OP: Fn(BroadcastContext<<span class="lifetime">'_</span>>) -> R + Sync, |
| R: Send, |
| { |
| <span class="comment">// We assert that `self.registry` has not terminated. |
| </span><span class="kw">unsafe </span>{ broadcast::broadcast_in(op, <span class="kw-2">&</span><span class="self">self</span>.registry) } |
| } |
| |
| <span class="doccomment">/// Returns the (current) number of threads in the thread pool. |
| /// |
| /// # Future compatibility note |
| /// |
| /// Note that unless this thread-pool was created with a |
| /// [`ThreadPoolBuilder`] that specifies the number of threads, |
| /// then this number may vary over time in future versions (see [the |
| /// `num_threads()` method for details][snt]). |
| /// |
| /// [snt]: struct.ThreadPoolBuilder.html#method.num_threads |
| /// [`ThreadPoolBuilder`]: struct.ThreadPoolBuilder.html |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>current_num_threads(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.registry.num_threads() |
| } |
| |
| <span class="doccomment">/// If called from a Rayon worker thread in this thread-pool, |
| /// returns the index of that thread; if not called from a Rayon |
| /// thread, or called from a Rayon thread that belongs to a |
| /// different thread-pool, returns `None`. |
| /// |
| /// The index for a given thread will not change over the thread's |
| /// lifetime. However, multiple threads may share the same index if |
| /// they are in distinct thread-pools. |
| /// |
| /// # Future compatibility note |
| /// |
| /// Currently, every thread-pool (including the global |
| /// thread-pool) has a fixed number of threads, but this may |
| /// change in future Rayon versions (see [the `num_threads()` method |
| /// for details][snt]). In that case, the index for a |
| /// thread would not change during its lifetime, but thread |
| /// indices may wind up being reused if threads are terminated and |
| /// restarted. |
| /// |
| /// [snt]: struct.ThreadPoolBuilder.html#method.num_threads |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>current_thread_index(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize> { |
| <span class="kw">let </span>curr = <span class="self">self</span>.registry.current_thread()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(curr.index()) |
| } |
| |
| <span class="doccomment">/// Returns true if the current worker thread currently has "local |
| /// tasks" pending. This can be useful as part of a heuristic for |
| /// deciding whether to spawn a new task or execute code on the |
| /// current thread, particularly in breadth-first |
| /// schedulers. However, keep in mind that this is an inherently |
| /// racy check, as other worker threads may be actively "stealing" |
| /// tasks from our local deque. |
| /// |
| /// **Background:** Rayon's uses a [work-stealing] scheduler. The |
| /// key idea is that each thread has its own [deque] of |
| /// tasks. Whenever a new task is spawned -- whether through |
| /// `join()`, `Scope::spawn()`, or some other means -- that new |
| /// task is pushed onto the thread's *local* deque. Worker threads |
| /// have a preference for executing their own tasks; if however |
| /// they run out of tasks, they will go try to "steal" tasks from |
| /// other threads. This function therefore has an inherent race |
| /// with other active worker threads, which may be removing items |
| /// from the local deque. |
| /// |
| /// [work-stealing]: https://en.wikipedia.org/wiki/Work_stealing |
| /// [deque]: https://en.wikipedia.org/wiki/Double-ended_queue |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>current_thread_has_pending_tasks(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><bool> { |
| <span class="kw">let </span>curr = <span class="self">self</span>.registry.current_thread()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(!curr.local_deque_is_empty()) |
| } |
| |
| <span class="doccomment">/// Execute `oper_a` and `oper_b` in the thread-pool and return |
| /// the results. Equivalent to `self.install(|| join(oper_a, |
| /// oper_b))`. |
| </span><span class="kw">pub fn </span>join<A, B, RA, RB>(<span class="kw-2">&</span><span class="self">self</span>, oper_a: A, oper_b: B) -> (RA, RB) |
| <span class="kw">where |
| </span>A: FnOnce() -> RA + Send, |
| B: FnOnce() -> RB + Send, |
| RA: Send, |
| RB: Send, |
| { |
| <span class="self">self</span>.install(|| join(oper_a, oper_b)) |
| } |
| |
| <span class="doccomment">/// Creates a scope that executes within this thread-pool. |
| /// Equivalent to `self.install(|| scope(...))`. |
| /// |
| /// See also: [the `scope()` function][scope]. |
| /// |
| /// [scope]: fn.scope.html |
| </span><span class="kw">pub fn </span>scope<<span class="lifetime">'scope</span>, OP, R>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) -> R |
| <span class="kw">where |
| </span>OP: FnOnce(<span class="kw-2">&</span>Scope<<span class="lifetime">'scope</span>>) -> R + Send, |
| R: Send, |
| { |
| <span class="self">self</span>.install(|| scope(op)) |
| } |
| |
| <span class="doccomment">/// Creates a scope that executes within this thread-pool. |
| /// Spawns from the same thread are prioritized in relative FIFO order. |
| /// Equivalent to `self.install(|| scope_fifo(...))`. |
| /// |
| /// See also: [the `scope_fifo()` function][scope_fifo]. |
| /// |
| /// [scope_fifo]: fn.scope_fifo.html |
| </span><span class="kw">pub fn </span>scope_fifo<<span class="lifetime">'scope</span>, OP, R>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) -> R |
| <span class="kw">where |
| </span>OP: FnOnce(<span class="kw-2">&</span>ScopeFifo<<span class="lifetime">'scope</span>>) -> R + Send, |
| R: Send, |
| { |
| <span class="self">self</span>.install(|| scope_fifo(op)) |
| } |
| |
| <span class="doccomment">/// Creates a scope that spawns work into this thread-pool. |
| /// |
| /// See also: [the `in_place_scope()` function][in_place_scope]. |
| /// |
| /// [in_place_scope]: fn.in_place_scope.html |
| </span><span class="kw">pub fn </span>in_place_scope<<span class="lifetime">'scope</span>, OP, R>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) -> R |
| <span class="kw">where |
| </span>OP: FnOnce(<span class="kw-2">&</span>Scope<<span class="lifetime">'scope</span>>) -> R, |
| { |
| do_in_place_scope(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="self">self</span>.registry), op) |
| } |
| |
| <span class="doccomment">/// Creates a scope that spawns work into this thread-pool in FIFO order. |
| /// |
| /// See also: [the `in_place_scope_fifo()` function][in_place_scope_fifo]. |
| /// |
| /// [in_place_scope_fifo]: fn.in_place_scope_fifo.html |
| </span><span class="kw">pub fn </span>in_place_scope_fifo<<span class="lifetime">'scope</span>, OP, R>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) -> R |
| <span class="kw">where |
| </span>OP: FnOnce(<span class="kw-2">&</span>ScopeFifo<<span class="lifetime">'scope</span>>) -> R, |
| { |
| do_in_place_scope_fifo(<span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="self">self</span>.registry), op) |
| } |
| |
| <span class="doccomment">/// Spawns an asynchronous task in this thread-pool. This task will |
| /// run in the implicit, global scope, which means that it may outlast |
| /// the current stack frame -- therefore, it cannot capture any references |
| /// onto the stack (you will likely need a `move` closure). |
| /// |
| /// See also: [the `spawn()` function defined on scopes][spawn]. |
| /// |
| /// [spawn]: struct.Scope.html#method.spawn |
| </span><span class="kw">pub fn </span>spawn<OP>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) |
| <span class="kw">where |
| </span>OP: FnOnce() + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="comment">// We assert that `self.registry` has not terminated. |
| </span><span class="kw">unsafe </span>{ spawn::spawn_in(op, <span class="kw-2">&</span><span class="self">self</span>.registry) } |
| } |
| |
| <span class="doccomment">/// Spawns an asynchronous task in this thread-pool. This task will |
| /// run in the implicit, global scope, which means that it may outlast |
| /// the current stack frame -- therefore, it cannot capture any references |
| /// onto the stack (you will likely need a `move` closure). |
| /// |
| /// See also: [the `spawn_fifo()` function defined on scopes][spawn_fifo]. |
| /// |
| /// [spawn_fifo]: struct.ScopeFifo.html#method.spawn_fifo |
| </span><span class="kw">pub fn </span>spawn_fifo<OP>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) |
| <span class="kw">where |
| </span>OP: FnOnce() + Send + <span class="lifetime">'static</span>, |
| { |
| <span class="comment">// We assert that `self.registry` has not terminated. |
| </span><span class="kw">unsafe </span>{ spawn::spawn_fifo_in(op, <span class="kw-2">&</span><span class="self">self</span>.registry) } |
| } |
| |
| <span class="doccomment">/// Spawns an asynchronous task on every thread in this thread-pool. This task |
| /// will run in the implicit, global scope, which means that it may outlast the |
| /// current stack frame -- therefore, it cannot capture any references onto the |
| /// stack (you will likely need a `move` closure). |
| </span><span class="kw">pub fn </span>spawn_broadcast<OP>(<span class="kw-2">&</span><span class="self">self</span>, op: OP) |
| <span class="kw">where |
| </span>OP: Fn(BroadcastContext<<span class="lifetime">'_</span>>) + Send + Sync + <span class="lifetime">'static</span>, |
| { |
| <span class="comment">// We assert that `self.registry` has not terminated. |
| </span><span class="kw">unsafe </span>{ broadcast::spawn_broadcast_in(op, <span class="kw-2">&</span><span class="self">self</span>.registry) } |
| } |
| |
| <span class="doccomment">/// Cooperatively yields execution to Rayon. |
| /// |
| /// This is similar to the general [`yield_now()`], but only if the current |
| /// thread is part of *this* thread pool. |
| /// |
| /// Returns `Some(Yield::Executed)` if anything was executed, `Some(Yield::Idle)` if |
| /// nothing was available, or `None` if the current thread is not part this pool. |
| </span><span class="kw">pub fn </span>yield_now(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Yield> { |
| <span class="kw">let </span>curr = <span class="self">self</span>.registry.current_thread()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(curr.yield_now()) |
| } |
| |
| <span class="doccomment">/// Cooperatively yields execution to local Rayon work. |
| /// |
| /// This is similar to the general [`yield_local()`], but only if the current |
| /// thread is part of *this* thread pool. |
| /// |
| /// Returns `Some(Yield::Executed)` if anything was executed, `Some(Yield::Idle)` if |
| /// nothing was available, or `None` if the current thread is not part this pool. |
| </span><span class="kw">pub fn </span>yield_local(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Yield> { |
| <span class="kw">let </span>curr = <span class="self">self</span>.registry.current_thread()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(curr.yield_local()) |
| } |
| } |
| |
| <span class="kw">impl </span>Drop <span class="kw">for </span>ThreadPool { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.registry.terminate(); |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ThreadPool { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| fmt.debug_struct(<span class="string">"ThreadPool"</span>) |
| .field(<span class="string">"num_threads"</span>, <span class="kw-2">&</span><span class="self">self</span>.current_num_threads()) |
| .field(<span class="string">"id"</span>, <span class="kw-2">&</span><span class="self">self</span>.registry.id()) |
| .finish() |
| } |
| } |
| |
| <span class="doccomment">/// If called from a Rayon worker thread, returns the index of that |
| /// thread within its current pool; if not called from a Rayon thread, |
| /// returns `None`. |
| /// |
| /// The index for a given thread will not change over the thread's |
| /// lifetime. However, multiple threads may share the same index if |
| /// they are in distinct thread-pools. |
| /// |
| /// See also: [the `ThreadPool::current_thread_index()` method]. |
| /// |
| /// [m]: struct.ThreadPool.html#method.current_thread_index |
| /// |
| /// # Future compatibility note |
| /// |
| /// Currently, every thread-pool (including the global |
| /// thread-pool) has a fixed number of threads, but this may |
| /// change in future Rayon versions (see [the `num_threads()` method |
| /// for details][snt]). In that case, the index for a |
| /// thread would not change during its lifetime, but thread |
| /// indices may wind up being reused if threads are terminated and |
| /// restarted. |
| /// |
| /// [snt]: struct.ThreadPoolBuilder.html#method.num_threads |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>current_thread_index() -> <span class="prelude-ty">Option</span><usize> { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>curr = WorkerThread::current().as_ref()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(curr.index()) |
| } |
| } |
| |
| <span class="doccomment">/// If called from a Rayon worker thread, indicates whether that |
| /// thread's local deque still has pending tasks. Otherwise, returns |
| /// `None`. For more information, see [the |
| /// `ThreadPool::current_thread_has_pending_tasks()` method][m]. |
| /// |
| /// [m]: struct.ThreadPool.html#method.current_thread_has_pending_tasks |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>current_thread_has_pending_tasks() -> <span class="prelude-ty">Option</span><bool> { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>curr = WorkerThread::current().as_ref()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(!curr.local_deque_is_empty()) |
| } |
| } |
| |
| <span class="doccomment">/// Cooperatively yields execution to Rayon. |
| /// |
| /// If the current thread is part of a rayon thread pool, this looks for a |
| /// single unit of pending work in the pool, then executes it. Completion of |
| /// that work might include nested work or further work stealing. |
| /// |
| /// This is similar to [`std::thread::yield_now()`], but does not literally make |
| /// that call. If you are implementing a polling loop, you may want to also |
| /// yield to the OS scheduler yourself if no Rayon work was found. |
| /// |
| /// Returns `Some(Yield::Executed)` if anything was executed, `Some(Yield::Idle)` if |
| /// nothing was available, or `None` if this thread is not part of any pool at all. |
| </span><span class="kw">pub fn </span>yield_now() -> <span class="prelude-ty">Option</span><Yield> { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>thread = WorkerThread::current().as_ref()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(thread.yield_now()) |
| } |
| } |
| |
| <span class="doccomment">/// Cooperatively yields execution to local Rayon work. |
| /// |
| /// If the current thread is part of a rayon thread pool, this looks for a |
| /// single unit of pending work in this thread's queue, then executes it. |
| /// Completion of that work might include nested work or further work stealing. |
| /// |
| /// This is similar to [`yield_now()`], but does not steal from other threads. |
| /// |
| /// Returns `Some(Yield::Executed)` if anything was executed, `Some(Yield::Idle)` if |
| /// nothing was available, or `None` if this thread is not part of any pool at all. |
| </span><span class="kw">pub fn </span>yield_local() -> <span class="prelude-ty">Option</span><Yield> { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>thread = WorkerThread::current().as_ref()<span class="question-mark">?</span>; |
| <span class="prelude-val">Some</span>(thread.yield_local()) |
| } |
| } |
| |
| <span class="doccomment">/// Result of [`yield_now()`] or [`yield_local()`]. |
| </span><span class="attribute">#[derive(Clone, Copy, Debug, PartialEq, Eq)] |
| </span><span class="kw">pub enum </span>Yield { |
| <span class="doccomment">/// Work was found and executed. |
| </span>Executed, |
| <span class="doccomment">/// No available work was found. |
| </span>Idle, |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="rayon_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |