| <!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/registry.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>registry.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> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| <span id="494">494</span> |
| <span id="495">495</span> |
| <span id="496">496</span> |
| <span id="497">497</span> |
| <span id="498">498</span> |
| <span id="499">499</span> |
| <span id="500">500</span> |
| <span id="501">501</span> |
| <span id="502">502</span> |
| <span id="503">503</span> |
| <span id="504">504</span> |
| <span id="505">505</span> |
| <span id="506">506</span> |
| <span id="507">507</span> |
| <span id="508">508</span> |
| <span id="509">509</span> |
| <span id="510">510</span> |
| <span id="511">511</span> |
| <span id="512">512</span> |
| <span id="513">513</span> |
| <span id="514">514</span> |
| <span id="515">515</span> |
| <span id="516">516</span> |
| <span id="517">517</span> |
| <span id="518">518</span> |
| <span id="519">519</span> |
| <span id="520">520</span> |
| <span id="521">521</span> |
| <span id="522">522</span> |
| <span id="523">523</span> |
| <span id="524">524</span> |
| <span id="525">525</span> |
| <span id="526">526</span> |
| <span id="527">527</span> |
| <span id="528">528</span> |
| <span id="529">529</span> |
| <span id="530">530</span> |
| <span id="531">531</span> |
| <span id="532">532</span> |
| <span id="533">533</span> |
| <span id="534">534</span> |
| <span id="535">535</span> |
| <span id="536">536</span> |
| <span id="537">537</span> |
| <span id="538">538</span> |
| <span id="539">539</span> |
| <span id="540">540</span> |
| <span id="541">541</span> |
| <span id="542">542</span> |
| <span id="543">543</span> |
| <span id="544">544</span> |
| <span id="545">545</span> |
| <span id="546">546</span> |
| <span id="547">547</span> |
| <span id="548">548</span> |
| <span id="549">549</span> |
| <span id="550">550</span> |
| <span id="551">551</span> |
| <span id="552">552</span> |
| <span id="553">553</span> |
| <span id="554">554</span> |
| <span id="555">555</span> |
| <span id="556">556</span> |
| <span id="557">557</span> |
| <span id="558">558</span> |
| <span id="559">559</span> |
| <span id="560">560</span> |
| <span id="561">561</span> |
| <span id="562">562</span> |
| <span id="563">563</span> |
| <span id="564">564</span> |
| <span id="565">565</span> |
| <span id="566">566</span> |
| <span id="567">567</span> |
| <span id="568">568</span> |
| <span id="569">569</span> |
| <span id="570">570</span> |
| <span id="571">571</span> |
| <span id="572">572</span> |
| <span id="573">573</span> |
| <span id="574">574</span> |
| <span id="575">575</span> |
| <span id="576">576</span> |
| <span id="577">577</span> |
| <span id="578">578</span> |
| <span id="579">579</span> |
| <span id="580">580</span> |
| <span id="581">581</span> |
| <span id="582">582</span> |
| <span id="583">583</span> |
| <span id="584">584</span> |
| <span id="585">585</span> |
| <span id="586">586</span> |
| <span id="587">587</span> |
| <span id="588">588</span> |
| <span id="589">589</span> |
| <span id="590">590</span> |
| <span id="591">591</span> |
| <span id="592">592</span> |
| <span id="593">593</span> |
| <span id="594">594</span> |
| <span id="595">595</span> |
| <span id="596">596</span> |
| <span id="597">597</span> |
| <span id="598">598</span> |
| <span id="599">599</span> |
| <span id="600">600</span> |
| <span id="601">601</span> |
| <span id="602">602</span> |
| <span id="603">603</span> |
| <span id="604">604</span> |
| <span id="605">605</span> |
| <span id="606">606</span> |
| <span id="607">607</span> |
| <span id="608">608</span> |
| <span id="609">609</span> |
| <span id="610">610</span> |
| <span id="611">611</span> |
| <span id="612">612</span> |
| <span id="613">613</span> |
| <span id="614">614</span> |
| <span id="615">615</span> |
| <span id="616">616</span> |
| <span id="617">617</span> |
| <span id="618">618</span> |
| <span id="619">619</span> |
| <span id="620">620</span> |
| <span id="621">621</span> |
| <span id="622">622</span> |
| <span id="623">623</span> |
| <span id="624">624</span> |
| <span id="625">625</span> |
| <span id="626">626</span> |
| <span id="627">627</span> |
| <span id="628">628</span> |
| <span id="629">629</span> |
| <span id="630">630</span> |
| <span id="631">631</span> |
| <span id="632">632</span> |
| <span id="633">633</span> |
| <span id="634">634</span> |
| <span id="635">635</span> |
| <span id="636">636</span> |
| <span id="637">637</span> |
| <span id="638">638</span> |
| <span id="639">639</span> |
| <span id="640">640</span> |
| <span id="641">641</span> |
| <span id="642">642</span> |
| <span id="643">643</span> |
| <span id="644">644</span> |
| <span id="645">645</span> |
| <span id="646">646</span> |
| <span id="647">647</span> |
| <span id="648">648</span> |
| <span id="649">649</span> |
| <span id="650">650</span> |
| <span id="651">651</span> |
| <span id="652">652</span> |
| <span id="653">653</span> |
| <span id="654">654</span> |
| <span id="655">655</span> |
| <span id="656">656</span> |
| <span id="657">657</span> |
| <span id="658">658</span> |
| <span id="659">659</span> |
| <span id="660">660</span> |
| <span id="661">661</span> |
| <span id="662">662</span> |
| <span id="663">663</span> |
| <span id="664">664</span> |
| <span id="665">665</span> |
| <span id="666">666</span> |
| <span id="667">667</span> |
| <span id="668">668</span> |
| <span id="669">669</span> |
| <span id="670">670</span> |
| <span id="671">671</span> |
| <span id="672">672</span> |
| <span id="673">673</span> |
| <span id="674">674</span> |
| <span id="675">675</span> |
| <span id="676">676</span> |
| <span id="677">677</span> |
| <span id="678">678</span> |
| <span id="679">679</span> |
| <span id="680">680</span> |
| <span id="681">681</span> |
| <span id="682">682</span> |
| <span id="683">683</span> |
| <span id="684">684</span> |
| <span id="685">685</span> |
| <span id="686">686</span> |
| <span id="687">687</span> |
| <span id="688">688</span> |
| <span id="689">689</span> |
| <span id="690">690</span> |
| <span id="691">691</span> |
| <span id="692">692</span> |
| <span id="693">693</span> |
| <span id="694">694</span> |
| <span id="695">695</span> |
| <span id="696">696</span> |
| <span id="697">697</span> |
| <span id="698">698</span> |
| <span id="699">699</span> |
| <span id="700">700</span> |
| <span id="701">701</span> |
| <span id="702">702</span> |
| <span id="703">703</span> |
| <span id="704">704</span> |
| <span id="705">705</span> |
| <span id="706">706</span> |
| <span id="707">707</span> |
| <span id="708">708</span> |
| <span id="709">709</span> |
| <span id="710">710</span> |
| <span id="711">711</span> |
| <span id="712">712</span> |
| <span id="713">713</span> |
| <span id="714">714</span> |
| <span id="715">715</span> |
| <span id="716">716</span> |
| <span id="717">717</span> |
| <span id="718">718</span> |
| <span id="719">719</span> |
| <span id="720">720</span> |
| <span id="721">721</span> |
| <span id="722">722</span> |
| <span id="723">723</span> |
| <span id="724">724</span> |
| <span id="725">725</span> |
| <span id="726">726</span> |
| <span id="727">727</span> |
| <span id="728">728</span> |
| <span id="729">729</span> |
| <span id="730">730</span> |
| <span id="731">731</span> |
| <span id="732">732</span> |
| <span id="733">733</span> |
| <span id="734">734</span> |
| <span id="735">735</span> |
| <span id="736">736</span> |
| <span id="737">737</span> |
| <span id="738">738</span> |
| <span id="739">739</span> |
| <span id="740">740</span> |
| <span id="741">741</span> |
| <span id="742">742</span> |
| <span id="743">743</span> |
| <span id="744">744</span> |
| <span id="745">745</span> |
| <span id="746">746</span> |
| <span id="747">747</span> |
| <span id="748">748</span> |
| <span id="749">749</span> |
| <span id="750">750</span> |
| <span id="751">751</span> |
| <span id="752">752</span> |
| <span id="753">753</span> |
| <span id="754">754</span> |
| <span id="755">755</span> |
| <span id="756">756</span> |
| <span id="757">757</span> |
| <span id="758">758</span> |
| <span id="759">759</span> |
| <span id="760">760</span> |
| <span id="761">761</span> |
| <span id="762">762</span> |
| <span id="763">763</span> |
| <span id="764">764</span> |
| <span id="765">765</span> |
| <span id="766">766</span> |
| <span id="767">767</span> |
| <span id="768">768</span> |
| <span id="769">769</span> |
| <span id="770">770</span> |
| <span id="771">771</span> |
| <span id="772">772</span> |
| <span id="773">773</span> |
| <span id="774">774</span> |
| <span id="775">775</span> |
| <span id="776">776</span> |
| <span id="777">777</span> |
| <span id="778">778</span> |
| <span id="779">779</span> |
| <span id="780">780</span> |
| <span id="781">781</span> |
| <span id="782">782</span> |
| <span id="783">783</span> |
| <span id="784">784</span> |
| <span id="785">785</span> |
| <span id="786">786</span> |
| <span id="787">787</span> |
| <span id="788">788</span> |
| <span id="789">789</span> |
| <span id="790">790</span> |
| <span id="791">791</span> |
| <span id="792">792</span> |
| <span id="793">793</span> |
| <span id="794">794</span> |
| <span id="795">795</span> |
| <span id="796">796</span> |
| <span id="797">797</span> |
| <span id="798">798</span> |
| <span id="799">799</span> |
| <span id="800">800</span> |
| <span id="801">801</span> |
| <span id="802">802</span> |
| <span id="803">803</span> |
| <span id="804">804</span> |
| <span id="805">805</span> |
| <span id="806">806</span> |
| <span id="807">807</span> |
| <span id="808">808</span> |
| <span id="809">809</span> |
| <span id="810">810</span> |
| <span id="811">811</span> |
| <span id="812">812</span> |
| <span id="813">813</span> |
| <span id="814">814</span> |
| <span id="815">815</span> |
| <span id="816">816</span> |
| <span id="817">817</span> |
| <span id="818">818</span> |
| <span id="819">819</span> |
| <span id="820">820</span> |
| <span id="821">821</span> |
| <span id="822">822</span> |
| <span id="823">823</span> |
| <span id="824">824</span> |
| <span id="825">825</span> |
| <span id="826">826</span> |
| <span id="827">827</span> |
| <span id="828">828</span> |
| <span id="829">829</span> |
| <span id="830">830</span> |
| <span id="831">831</span> |
| <span id="832">832</span> |
| <span id="833">833</span> |
| <span id="834">834</span> |
| <span id="835">835</span> |
| <span id="836">836</span> |
| <span id="837">837</span> |
| <span id="838">838</span> |
| <span id="839">839</span> |
| <span id="840">840</span> |
| <span id="841">841</span> |
| <span id="842">842</span> |
| <span id="843">843</span> |
| <span id="844">844</span> |
| <span id="845">845</span> |
| <span id="846">846</span> |
| <span id="847">847</span> |
| <span id="848">848</span> |
| <span id="849">849</span> |
| <span id="850">850</span> |
| <span id="851">851</span> |
| <span id="852">852</span> |
| <span id="853">853</span> |
| <span id="854">854</span> |
| <span id="855">855</span> |
| <span id="856">856</span> |
| <span id="857">857</span> |
| <span id="858">858</span> |
| <span id="859">859</span> |
| <span id="860">860</span> |
| <span id="861">861</span> |
| <span id="862">862</span> |
| <span id="863">863</span> |
| <span id="864">864</span> |
| <span id="865">865</span> |
| <span id="866">866</span> |
| <span id="867">867</span> |
| <span id="868">868</span> |
| <span id="869">869</span> |
| <span id="870">870</span> |
| <span id="871">871</span> |
| <span id="872">872</span> |
| <span id="873">873</span> |
| <span id="874">874</span> |
| <span id="875">875</span> |
| <span id="876">876</span> |
| <span id="877">877</span> |
| <span id="878">878</span> |
| <span id="879">879</span> |
| <span id="880">880</span> |
| <span id="881">881</span> |
| <span id="882">882</span> |
| <span id="883">883</span> |
| <span id="884">884</span> |
| <span id="885">885</span> |
| <span id="886">886</span> |
| <span id="887">887</span> |
| <span id="888">888</span> |
| <span id="889">889</span> |
| <span id="890">890</span> |
| <span id="891">891</span> |
| <span id="892">892</span> |
| <span id="893">893</span> |
| <span id="894">894</span> |
| <span id="895">895</span> |
| <span id="896">896</span> |
| <span id="897">897</span> |
| <span id="898">898</span> |
| <span id="899">899</span> |
| <span id="900">900</span> |
| <span id="901">901</span> |
| <span id="902">902</span> |
| <span id="903">903</span> |
| <span id="904">904</span> |
| <span id="905">905</span> |
| <span id="906">906</span> |
| <span id="907">907</span> |
| <span id="908">908</span> |
| <span id="909">909</span> |
| <span id="910">910</span> |
| <span id="911">911</span> |
| <span id="912">912</span> |
| <span id="913">913</span> |
| <span id="914">914</span> |
| <span id="915">915</span> |
| <span id="916">916</span> |
| <span id="917">917</span> |
| <span id="918">918</span> |
| <span id="919">919</span> |
| <span id="920">920</span> |
| <span id="921">921</span> |
| <span id="922">922</span> |
| <span id="923">923</span> |
| <span id="924">924</span> |
| <span id="925">925</span> |
| <span id="926">926</span> |
| <span id="927">927</span> |
| <span id="928">928</span> |
| <span id="929">929</span> |
| <span id="930">930</span> |
| <span id="931">931</span> |
| <span id="932">932</span> |
| <span id="933">933</span> |
| <span id="934">934</span> |
| <span id="935">935</span> |
| <span id="936">936</span> |
| <span id="937">937</span> |
| <span id="938">938</span> |
| <span id="939">939</span> |
| <span id="940">940</span> |
| <span id="941">941</span> |
| <span id="942">942</span> |
| <span id="943">943</span> |
| <span id="944">944</span> |
| <span id="945">945</span> |
| <span id="946">946</span> |
| <span id="947">947</span> |
| <span id="948">948</span> |
| <span id="949">949</span> |
| <span id="950">950</span> |
| <span id="951">951</span> |
| <span id="952">952</span> |
| <span id="953">953</span> |
| <span id="954">954</span> |
| <span id="955">955</span> |
| <span id="956">956</span> |
| <span id="957">957</span> |
| <span id="958">958</span> |
| <span id="959">959</span> |
| <span id="960">960</span> |
| <span id="961">961</span> |
| <span id="962">962</span> |
| <span id="963">963</span> |
| <span id="964">964</span> |
| <span id="965">965</span> |
| <span id="966">966</span> |
| <span id="967">967</span> |
| <span id="968">968</span> |
| <span id="969">969</span> |
| <span id="970">970</span> |
| <span id="971">971</span> |
| <span id="972">972</span> |
| <span id="973">973</span> |
| <span id="974">974</span> |
| <span id="975">975</span> |
| <span id="976">976</span> |
| <span id="977">977</span> |
| <span id="978">978</span> |
| <span id="979">979</span> |
| <span id="980">980</span> |
| <span id="981">981</span> |
| <span id="982">982</span> |
| <span id="983">983</span> |
| <span id="984">984</span> |
| <span id="985">985</span> |
| <span id="986">986</span> |
| <span id="987">987</span> |
| <span id="988">988</span> |
| <span id="989">989</span> |
| <span id="990">990</span> |
| <span id="991">991</span> |
| <span id="992">992</span> |
| <span id="993">993</span> |
| <span id="994">994</span> |
| <span id="995">995</span> |
| <span id="996">996</span> |
| <span id="997">997</span> |
| <span id="998">998</span> |
| <span id="999">999</span> |
| <span id="1000">1000</span> |
| <span id="1001">1001</span> |
| <span id="1002">1002</span> |
| <span id="1003">1003</span> |
| <span id="1004">1004</span> |
| <span id="1005">1005</span> |
| <span id="1006">1006</span> |
| <span id="1007">1007</span> |
| <span id="1008">1008</span> |
| <span id="1009">1009</span> |
| <span id="1010">1010</span> |
| <span id="1011">1011</span> |
| <span id="1012">1012</span> |
| <span id="1013">1013</span> |
| <span id="1014">1014</span> |
| <span id="1015">1015</span> |
| <span id="1016">1016</span> |
| <span id="1017">1017</span> |
| <span id="1018">1018</span> |
| <span id="1019">1019</span> |
| <span id="1020">1020</span> |
| <span id="1021">1021</span> |
| <span id="1022">1022</span> |
| <span id="1023">1023</span> |
| <span id="1024">1024</span> |
| <span id="1025">1025</span> |
| <span id="1026">1026</span> |
| <span id="1027">1027</span> |
| <span id="1028">1028</span> |
| <span id="1029">1029</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::job::{JobFifo, JobRef, StackJob}; |
| <span class="kw">use </span><span class="kw">crate</span>::latch::{AsCoreLatch, CoreLatch, CountLatch, Latch, LatchRef, LockLatch, SpinLatch}; |
| <span class="kw">use </span><span class="kw">crate</span>::log::Event::<span class="kw-2">*</span>; |
| <span class="kw">use </span><span class="kw">crate</span>::log::Logger; |
| <span class="kw">use </span><span class="kw">crate</span>::sleep::Sleep; |
| <span class="kw">use </span><span class="kw">crate</span>::unwind; |
| <span class="kw">use crate</span>::{ |
| ErrorKind, ExitHandler, PanicHandler, StartHandler, ThreadPoolBuildError, ThreadPoolBuilder, |
| Yield, |
| }; |
| <span class="kw">use </span>crossbeam_deque::{Injector, Steal, Stealer, Worker}; |
| <span class="kw">use </span>std::cell::Cell; |
| <span class="kw">use </span>std::collections::hash_map::DefaultHasher; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::hash::Hasher; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::mem; |
| <span class="kw">use </span>std::ptr; |
| <span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering}; |
| <span class="kw">use </span>std::sync::{Arc, Mutex, Once}; |
| <span class="kw">use </span>std::thread; |
| <span class="kw">use </span>std::usize; |
| |
| <span class="doccomment">/// Thread builder used for customization via |
| /// [`ThreadPoolBuilder::spawn_handler`](struct.ThreadPoolBuilder.html#method.spawn_handler). |
| </span><span class="kw">pub struct </span>ThreadBuilder { |
| name: <span class="prelude-ty">Option</span><String>, |
| stack_size: <span class="prelude-ty">Option</span><usize>, |
| worker: Worker<JobRef>, |
| stealer: Stealer<JobRef>, |
| registry: Arc<Registry>, |
| index: usize, |
| } |
| |
| <span class="kw">impl </span>ThreadBuilder { |
| <span class="doccomment">/// Gets the index of this thread in the pool, within `0..num_threads`. |
| </span><span class="kw">pub fn </span>index(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.index |
| } |
| |
| <span class="doccomment">/// Gets the string that was specified by `ThreadPoolBuilder::name()`. |
| </span><span class="kw">pub fn </span>name(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { |
| <span class="self">self</span>.name.as_deref() |
| } |
| |
| <span class="doccomment">/// Gets the value that was specified by `ThreadPoolBuilder::stack_size()`. |
| </span><span class="kw">pub fn </span>stack_size(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><usize> { |
| <span class="self">self</span>.stack_size |
| } |
| |
| <span class="doccomment">/// Executes the main loop for this thread. This will not return until the |
| /// thread pool is dropped. |
| </span><span class="kw">pub fn </span>run(<span class="self">self</span>) { |
| <span class="kw">unsafe </span>{ main_loop(<span class="self">self</span>) } |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>ThreadBuilder { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| f.debug_struct(<span class="string">"ThreadBuilder"</span>) |
| .field(<span class="string">"pool"</span>, <span class="kw-2">&</span><span class="self">self</span>.registry.id()) |
| .field(<span class="string">"index"</span>, <span class="kw-2">&</span><span class="self">self</span>.index) |
| .field(<span class="string">"name"</span>, <span class="kw-2">&</span><span class="self">self</span>.name) |
| .field(<span class="string">"stack_size"</span>, <span class="kw-2">&</span><span class="self">self</span>.stack_size) |
| .finish() |
| } |
| } |
| |
| <span class="doccomment">/// Generalized trait for spawning a thread in the `Registry`. |
| /// |
| /// This trait is pub-in-private -- E0445 forces us to make it public, |
| /// but we don't actually want to expose these details in the API. |
| </span><span class="kw">pub trait </span>ThreadSpawn { |
| <span class="macro">private_decl! </span>{} |
| |
| <span class="doccomment">/// Spawn a thread with the `ThreadBuilder` parameters, and then |
| /// call `ThreadBuilder::run()`. |
| </span><span class="kw">fn </span>spawn(<span class="kw-2">&mut </span><span class="self">self</span>, thread: ThreadBuilder) -> io::Result<()>; |
| } |
| |
| <span class="doccomment">/// Spawns a thread in the "normal" way with `std::thread::Builder`. |
| /// |
| /// This type is pub-in-private -- E0445 forces us to make it public, |
| /// but we don't actually want to expose these details in the API. |
| </span><span class="attribute">#[derive(Debug, Default)] |
| </span><span class="kw">pub struct </span>DefaultSpawn; |
| |
| <span class="kw">impl </span>ThreadSpawn <span class="kw">for </span>DefaultSpawn { |
| <span class="macro">private_impl! </span>{} |
| |
| <span class="kw">fn </span>spawn(<span class="kw-2">&mut </span><span class="self">self</span>, thread: ThreadBuilder) -> io::Result<()> { |
| <span class="kw">let </span><span class="kw-2">mut </span>b = thread::Builder::new(); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(name) = thread.name() { |
| b = b.name(name.to_owned()); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(stack_size) = thread.stack_size() { |
| b = b.stack_size(stack_size); |
| } |
| b.spawn(|| thread.run())<span class="question-mark">?</span>; |
| <span class="prelude-val">Ok</span>(()) |
| } |
| } |
| |
| <span class="doccomment">/// Spawns a thread with a user's custom callback. |
| /// |
| /// This type is pub-in-private -- E0445 forces us to make it public, |
| /// but we don't actually want to expose these details in the API. |
| </span><span class="attribute">#[derive(Debug)] |
| </span><span class="kw">pub struct </span>CustomSpawn<F>(F); |
| |
| <span class="kw">impl</span><F> CustomSpawn<F> |
| <span class="kw">where |
| </span>F: FnMut(ThreadBuilder) -> io::Result<()>, |
| { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(spawn: F) -> <span class="self">Self </span>{ |
| CustomSpawn(spawn) |
| } |
| } |
| |
| <span class="kw">impl</span><F> ThreadSpawn <span class="kw">for </span>CustomSpawn<F> |
| <span class="kw">where |
| </span>F: FnMut(ThreadBuilder) -> io::Result<()>, |
| { |
| <span class="macro">private_impl! </span>{} |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>spawn(<span class="kw-2">&mut </span><span class="self">self</span>, thread: ThreadBuilder) -> io::Result<()> { |
| (<span class="self">self</span>.<span class="number">0</span>)(thread) |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>Registry { |
| logger: Logger, |
| thread_infos: Vec<ThreadInfo>, |
| sleep: Sleep, |
| injected_jobs: Injector<JobRef>, |
| broadcasts: Mutex<Vec<Worker<JobRef>>>, |
| panic_handler: <span class="prelude-ty">Option</span><Box<PanicHandler>>, |
| start_handler: <span class="prelude-ty">Option</span><Box<StartHandler>>, |
| exit_handler: <span class="prelude-ty">Option</span><Box<ExitHandler>>, |
| |
| <span class="comment">// When this latch reaches 0, it means that all work on this |
| // registry must be complete. This is ensured in the following ways: |
| // |
| // - if this is the global registry, there is a ref-count that never |
| // gets released. |
| // - if this is a user-created thread-pool, then so long as the thread-pool |
| // exists, it holds a reference. |
| // - when we inject a "blocking job" into the registry with `ThreadPool::install()`, |
| // no adjustment is needed; the `ThreadPool` holds the reference, and since we won't |
| // return until the blocking job is complete, that ref will continue to be held. |
| // - when `join()` or `scope()` is invoked, similarly, no adjustments are needed. |
| // These are always owned by some other job (e.g., one injected by `ThreadPool::install()`) |
| // and that job will keep the pool alive. |
| </span>terminate_count: AtomicUsize, |
| } |
| |
| <span class="doccomment">/// //////////////////////////////////////////////////////////////////////// |
| /// Initialization |
| |
| </span><span class="kw">static </span><span class="kw-2">mut </span>THE_REGISTRY: <span class="prelude-ty">Option</span><Arc<Registry>> = <span class="prelude-val">None</span>; |
| <span class="kw">static </span>THE_REGISTRY_SET: Once = Once::new(); |
| |
| <span class="doccomment">/// Starts the worker threads (if that has not already happened). If |
| /// initialization has not already occurred, use the default |
| /// configuration. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>global_registry() -> <span class="kw-2">&</span><span class="lifetime">'static </span>Arc<Registry> { |
| set_global_registry(default_global_registry) |
| .or_else(|err| <span class="kw">unsafe </span>{ THE_REGISTRY.as_ref().ok_or(err) }) |
| .expect(<span class="string">"The global thread pool has not been initialized."</span>) |
| } |
| |
| <span class="doccomment">/// Starts the worker threads (if that has not already happened) with |
| /// the given builder. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>init_global_registry<S>( |
| builder: ThreadPoolBuilder<S>, |
| ) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'static </span>Arc<Registry>, ThreadPoolBuildError> |
| <span class="kw">where |
| </span>S: ThreadSpawn, |
| { |
| set_global_registry(|| Registry::new(builder)) |
| } |
| |
| <span class="doccomment">/// Starts the worker threads (if that has not already happened) |
| /// by creating a registry with the given callback. |
| </span><span class="kw">fn </span>set_global_registry<F>(registry: F) -> <span class="prelude-ty">Result</span><<span class="kw-2">&</span><span class="lifetime">'static </span>Arc<Registry>, ThreadPoolBuildError> |
| <span class="kw">where |
| </span>F: FnOnce() -> <span class="prelude-ty">Result</span><Arc<Registry>, ThreadPoolBuildError>, |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>result = <span class="prelude-val">Err</span>(ThreadPoolBuildError::new( |
| ErrorKind::GlobalPoolAlreadyInitialized, |
| )); |
| |
| THE_REGISTRY_SET.call_once(|| { |
| result = registry() |
| .map(|registry: Arc<Registry>| <span class="kw">unsafe </span>{ <span class="kw-2">&*</span>THE_REGISTRY.get_or_insert(registry) }) |
| }); |
| |
| result |
| } |
| |
| <span class="kw">fn </span>default_global_registry() -> <span class="prelude-ty">Result</span><Arc<Registry>, ThreadPoolBuildError> { |
| <span class="kw">let </span>result = Registry::new(ThreadPoolBuilder::new()); |
| |
| <span class="comment">// If we're running in an environment that doesn't support threads at all, we can fall back to |
| // using the current thread alone. This is crude, and probably won't work for non-blocking |
| // calls like `spawn` or `broadcast_spawn`, but a lot of stuff does work fine. |
| // |
| // Notably, this allows current WebAssembly targets to work even though their threading support |
| // is stubbed out, and we won't have to change anything if they do add real threading. |
| </span><span class="kw">let </span>unsupported = <span class="macro">matches!</span>(<span class="kw-2">&</span>result, <span class="prelude-val">Err</span>(e) <span class="kw">if </span>e.is_unsupported()); |
| <span class="kw">if </span>unsupported && WorkerThread::current().is_null() { |
| <span class="kw">let </span>builder = ThreadPoolBuilder::new() |
| .num_threads(<span class="number">1</span>) |
| .spawn_handler(|thread| { |
| <span class="comment">// Rather than starting a new thread, we're just taking over the current thread |
| // *without* running the main loop, so we can still return from here. |
| // The WorkerThread is leaked, but we never shutdown the global pool anyway. |
| </span><span class="kw">let </span>worker_thread = Box::leak(Box::new(WorkerThread::from(thread))); |
| <span class="kw">let </span>registry = <span class="kw-2">&*</span>worker_thread.registry; |
| <span class="kw">let </span>index = worker_thread.index; |
| |
| <span class="kw">unsafe </span>{ |
| WorkerThread::set_current(worker_thread); |
| |
| <span class="comment">// let registry know we are ready to do work |
| </span>Latch::set(<span class="kw-2">&</span>registry.thread_infos[index].primed); |
| } |
| |
| <span class="prelude-val">Ok</span>(()) |
| }); |
| |
| <span class="kw">let </span>fallback_result = Registry::new(builder); |
| <span class="kw">if </span>fallback_result.is_ok() { |
| <span class="kw">return </span>fallback_result; |
| } |
| } |
| |
| result |
| } |
| |
| <span class="kw">struct </span>Terminator<<span class="lifetime">'a</span>>(<span class="kw-2">&</span><span class="lifetime">'a </span>Arc<Registry>); |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Drop <span class="kw">for </span>Terminator<<span class="lifetime">'a</span>> { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.<span class="number">0</span>.terminate() |
| } |
| } |
| |
| <span class="kw">impl </span>Registry { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new<S>( |
| <span class="kw-2">mut </span>builder: ThreadPoolBuilder<S>, |
| ) -> <span class="prelude-ty">Result</span><Arc<<span class="self">Self</span>>, ThreadPoolBuildError> |
| <span class="kw">where |
| </span>S: ThreadSpawn, |
| { |
| <span class="comment">// Soft-limit the number of threads that we can actually support. |
| </span><span class="kw">let </span>n_threads = Ord::min(builder.get_num_threads(), <span class="kw">crate</span>::max_num_threads()); |
| |
| <span class="kw">let </span>breadth_first = builder.get_breadth_first(); |
| |
| <span class="kw">let </span>(workers, stealers): (Vec<<span class="kw">_</span>>, Vec<<span class="kw">_</span>>) = (<span class="number">0</span>..n_threads) |
| .map(|<span class="kw">_</span>| { |
| <span class="kw">let </span>worker = <span class="kw">if </span>breadth_first { |
| Worker::new_fifo() |
| } <span class="kw">else </span>{ |
| Worker::new_lifo() |
| }; |
| |
| <span class="kw">let </span>stealer = worker.stealer(); |
| (worker, stealer) |
| }) |
| .unzip(); |
| |
| <span class="kw">let </span>(broadcasts, broadcast_stealers): (Vec<<span class="kw">_</span>>, Vec<<span class="kw">_</span>>) = (<span class="number">0</span>..n_threads) |
| .map(|<span class="kw">_</span>| { |
| <span class="kw">let </span>worker = Worker::new_fifo(); |
| <span class="kw">let </span>stealer = worker.stealer(); |
| (worker, stealer) |
| }) |
| .unzip(); |
| |
| <span class="kw">let </span>logger = Logger::new(n_threads); |
| <span class="kw">let </span>registry = Arc::new(Registry { |
| logger: logger.clone(), |
| thread_infos: stealers.into_iter().map(ThreadInfo::new).collect(), |
| sleep: Sleep::new(logger, n_threads), |
| injected_jobs: Injector::new(), |
| broadcasts: Mutex::new(broadcasts), |
| terminate_count: AtomicUsize::new(<span class="number">1</span>), |
| panic_handler: builder.take_panic_handler(), |
| start_handler: builder.take_start_handler(), |
| exit_handler: builder.take_exit_handler(), |
| }); |
| |
| <span class="comment">// If we return early or panic, make sure to terminate existing threads. |
| </span><span class="kw">let </span>t1000 = Terminator(<span class="kw-2">&</span>registry); |
| |
| <span class="kw">for </span>(index, (worker, stealer)) <span class="kw">in </span>workers.into_iter().zip(broadcast_stealers).enumerate() { |
| <span class="kw">let </span>thread = ThreadBuilder { |
| name: builder.get_thread_name(index), |
| stack_size: builder.get_stack_size(), |
| registry: Arc::clone(<span class="kw-2">&</span>registry), |
| worker, |
| stealer, |
| index, |
| }; |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(e) = builder.get_spawn_handler().spawn(thread) { |
| <span class="kw">return </span><span class="prelude-val">Err</span>(ThreadPoolBuildError::new(ErrorKind::IOError(e))); |
| } |
| } |
| |
| <span class="comment">// Returning normally now, without termination. |
| </span>mem::forget(t1000); |
| |
| <span class="prelude-val">Ok</span>(registry) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>current() -> Arc<Registry> { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>worker_thread = WorkerThread::current(); |
| <span class="kw">let </span>registry = <span class="kw">if </span>worker_thread.is_null() { |
| global_registry() |
| } <span class="kw">else </span>{ |
| <span class="kw-2">&</span>(<span class="kw-2">*</span>worker_thread).registry |
| }; |
| Arc::clone(registry) |
| } |
| } |
| |
| <span class="doccomment">/// Returns the number of threads in the current registry. This |
| /// is better than `Registry::current().num_threads()` because it |
| /// avoids incrementing the `Arc`. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>current_num_threads() -> usize { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>worker_thread = WorkerThread::current(); |
| <span class="kw">if </span>worker_thread.is_null() { |
| global_registry().num_threads() |
| } <span class="kw">else </span>{ |
| (<span class="kw-2">*</span>worker_thread).registry.num_threads() |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Returns the current `WorkerThread` if it's part of this `Registry`. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>current_thread(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>WorkerThread> { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>worker = WorkerThread::current().as_ref()<span class="question-mark">?</span>; |
| <span class="kw">if </span>worker.registry().id() == <span class="self">self</span>.id() { |
| <span class="prelude-val">Some</span>(worker) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| } |
| } |
| |
| <span class="doccomment">/// Returns an opaque identifier for this registry. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>id(<span class="kw-2">&</span><span class="self">self</span>) -> RegistryId { |
| <span class="comment">// We can rely on `self` not to change since we only ever create |
| // registries that are boxed up in an `Arc` (see `new()` above). |
| </span>RegistryId { |
| addr: <span class="self">self </span><span class="kw">as </span><span class="kw-2">*const </span><span class="self">Self </span><span class="kw">as </span>usize, |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, event: <span class="kw">impl </span>FnOnce() -> <span class="kw">crate</span>::log::Event) { |
| <span class="self">self</span>.logger.log(event) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>num_threads(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.thread_infos.len() |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>catch_unwind(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw">impl </span>FnOnce()) { |
| <span class="kw">if let </span><span class="prelude-val">Err</span>(err) = unwind::halt_unwinding(f) { |
| <span class="comment">// If there is no handler, or if that handler itself panics, then we abort. |
| </span><span class="kw">let </span>abort_guard = unwind::AbortIfPanic; |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>handler) = <span class="self">self</span>.panic_handler { |
| handler(err); |
| mem::forget(abort_guard); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Waits for the worker threads to get up and running. This is |
| /// meant to be used for benchmarking purposes, primarily, so that |
| /// you can get more consistent numbers by having everything |
| /// "ready to go". |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>wait_until_primed(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">for </span>info <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.thread_infos { |
| info.primed.wait(); |
| } |
| } |
| |
| <span class="doccomment">/// Waits for the worker threads to stop. This is used for testing |
| /// -- so we can check that termination actually works. |
| </span><span class="attribute">#[cfg(test)] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>wait_until_stopped(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">for </span>info <span class="kw">in </span><span class="kw-2">&</span><span class="self">self</span>.thread_infos { |
| info.stopped.wait(); |
| } |
| } |
| |
| <span class="doccomment">/// //////////////////////////////////////////////////////////////////////// |
| /// MAIN LOOP |
| /// |
| /// So long as all of the worker threads are hanging out in their |
| /// top-level loop, there is no work to be done. |
| |
| /// Push a job into the given `registry`. If we are running on a |
| /// worker thread for the registry, this will push onto the |
| /// deque. Else, it will inject from the outside (which is slower). |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>inject_or_push(<span class="kw-2">&</span><span class="self">self</span>, job_ref: JobRef) { |
| <span class="kw">let </span>worker_thread = WorkerThread::current(); |
| <span class="kw">unsafe </span>{ |
| <span class="kw">if </span>!worker_thread.is_null() && (<span class="kw-2">*</span>worker_thread).registry().id() == <span class="self">self</span>.id() { |
| (<span class="kw-2">*</span>worker_thread).push(job_ref); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.inject(job_ref); |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Push a job into the "external jobs" queue; it will be taken by |
| /// whatever worker has nothing to do. Use this if you know that |
| /// you are not on a worker of this registry. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>inject(<span class="kw-2">&</span><span class="self">self</span>, injected_job: JobRef) { |
| <span class="self">self</span>.log(|| JobsInjected { count: <span class="number">1 </span>}); |
| |
| <span class="comment">// It should not be possible for `state.terminate` to be true |
| // here. It is only set to true when the user creates (and |
| // drops) a `ThreadPool`; and, in that case, they cannot be |
| // calling `inject()` later, since they dropped their |
| // `ThreadPool`. |
| </span><span class="macro">debug_assert_ne!</span>( |
| <span class="self">self</span>.terminate_count.load(Ordering::Acquire), |
| <span class="number">0</span>, |
| <span class="string">"inject() sees state.terminate as true" |
| </span>); |
| |
| <span class="kw">let </span>queue_was_empty = <span class="self">self</span>.injected_jobs.is_empty(); |
| |
| <span class="self">self</span>.injected_jobs.push(injected_job); |
| <span class="self">self</span>.sleep.new_injected_jobs(usize::MAX, <span class="number">1</span>, queue_was_empty); |
| } |
| |
| <span class="kw">fn </span>has_injected_job(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| !<span class="self">self</span>.injected_jobs.is_empty() |
| } |
| |
| <span class="kw">fn </span>pop_injected_job(<span class="kw-2">&</span><span class="self">self</span>, worker_index: usize) -> <span class="prelude-ty">Option</span><JobRef> { |
| <span class="kw">loop </span>{ |
| <span class="kw">match </span><span class="self">self</span>.injected_jobs.steal() { |
| Steal::Success(job) => { |
| <span class="self">self</span>.log(|| JobUninjected { |
| worker: worker_index, |
| }); |
| <span class="kw">return </span><span class="prelude-val">Some</span>(job); |
| } |
| Steal::Empty => <span class="kw">return </span><span class="prelude-val">None</span>, |
| Steal::Retry => {} |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Push a job into each thread's own "external jobs" queue; it will be |
| /// executed only on that thread, when it has nothing else to do locally, |
| /// before it tries to steal other work. |
| /// |
| /// **Panics** if not given exactly as many jobs as there are threads. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>inject_broadcast(<span class="kw-2">&</span><span class="self">self</span>, injected_jobs: <span class="kw">impl </span>ExactSizeIterator<Item = JobRef>) { |
| <span class="macro">assert_eq!</span>(<span class="self">self</span>.num_threads(), injected_jobs.len()); |
| <span class="self">self</span>.log(|| JobBroadcast { |
| count: <span class="self">self</span>.num_threads(), |
| }); |
| { |
| <span class="kw">let </span>broadcasts = <span class="self">self</span>.broadcasts.lock().unwrap(); |
| |
| <span class="comment">// It should not be possible for `state.terminate` to be true |
| // here. It is only set to true when the user creates (and |
| // drops) a `ThreadPool`; and, in that case, they cannot be |
| // calling `inject_broadcast()` later, since they dropped their |
| // `ThreadPool`. |
| </span><span class="macro">debug_assert_ne!</span>( |
| <span class="self">self</span>.terminate_count.load(Ordering::Acquire), |
| <span class="number">0</span>, |
| <span class="string">"inject_broadcast() sees state.terminate as true" |
| </span>); |
| |
| <span class="macro">assert_eq!</span>(broadcasts.len(), injected_jobs.len()); |
| <span class="kw">for </span>(worker, job_ref) <span class="kw">in </span>broadcasts.iter().zip(injected_jobs) { |
| worker.push(job_ref); |
| } |
| } |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="self">self</span>.num_threads() { |
| <span class="self">self</span>.sleep.notify_worker_latch_is_set(i); |
| } |
| } |
| |
| <span class="doccomment">/// If already in a worker-thread of this registry, just execute `op`. |
| /// Otherwise, inject `op` in this thread-pool. Either way, block until `op` |
| /// completes and return its return value. If `op` panics, that panic will |
| /// be propagated as well. The second argument indicates `true` if injection |
| /// was performed, `false` if executed directly. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>in_worker<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>WorkerThread, bool) -> R + Send, |
| R: Send, |
| { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>worker_thread = WorkerThread::current(); |
| <span class="kw">if </span>worker_thread.is_null() { |
| <span class="self">self</span>.in_worker_cold(op) |
| } <span class="kw">else if </span>(<span class="kw-2">*</span>worker_thread).registry().id() != <span class="self">self</span>.id() { |
| <span class="self">self</span>.in_worker_cross(<span class="kw-2">&*</span>worker_thread, op) |
| } <span class="kw">else </span>{ |
| <span class="comment">// Perfectly valid to give them a `&T`: this is the |
| // current thread, so we know the data structure won't be |
| // invalidated until we return. |
| </span>op(<span class="kw-2">&*</span>worker_thread, <span class="bool-val">false</span>) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cold] |
| </span><span class="kw">unsafe fn </span>in_worker_cold<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>WorkerThread, bool) -> R + Send, |
| R: Send, |
| { |
| <span class="macro">thread_local!</span>(<span class="kw">static </span>LOCK_LATCH: LockLatch = LockLatch::new()); |
| |
| LOCK_LATCH.with(|l| { |
| <span class="comment">// This thread isn't a member of *any* thread pool, so just block. |
| </span><span class="macro">debug_assert!</span>(WorkerThread::current().is_null()); |
| <span class="kw">let </span>job = StackJob::new( |
| |injected| { |
| <span class="kw">let </span>worker_thread = WorkerThread::current(); |
| <span class="macro">assert!</span>(injected && !worker_thread.is_null()); |
| op(<span class="kw-2">&*</span>worker_thread, <span class="bool-val">true</span>) |
| }, |
| LatchRef::new(l), |
| ); |
| <span class="self">self</span>.inject(job.as_job_ref()); |
| job.latch.wait_and_reset(); <span class="comment">// Make sure we can use the same latch again next time. |
| |
| // flush accumulated logs as we exit the thread |
| </span><span class="self">self</span>.logger.log(|| Flush); |
| |
| job.into_result() |
| }) |
| } |
| |
| <span class="attribute">#[cold] |
| </span><span class="kw">unsafe fn </span>in_worker_cross<OP, R>(<span class="kw-2">&</span><span class="self">self</span>, current_thread: <span class="kw-2">&</span>WorkerThread, op: OP) -> R |
| <span class="kw">where |
| </span>OP: FnOnce(<span class="kw-2">&</span>WorkerThread, bool) -> R + Send, |
| R: Send, |
| { |
| <span class="comment">// This thread is a member of a different pool, so let it process |
| // other work while waiting for this `op` to complete. |
| </span><span class="macro">debug_assert!</span>(current_thread.registry().id() != <span class="self">self</span>.id()); |
| <span class="kw">let </span>latch = SpinLatch::cross(current_thread); |
| <span class="kw">let </span>job = StackJob::new( |
| |injected| { |
| <span class="kw">let </span>worker_thread = WorkerThread::current(); |
| <span class="macro">assert!</span>(injected && !worker_thread.is_null()); |
| op(<span class="kw-2">&*</span>worker_thread, <span class="bool-val">true</span>) |
| }, |
| latch, |
| ); |
| <span class="self">self</span>.inject(job.as_job_ref()); |
| current_thread.wait_until(<span class="kw-2">&</span>job.latch); |
| job.into_result() |
| } |
| |
| <span class="doccomment">/// Increments the terminate counter. This increment should be |
| /// balanced by a call to `terminate`, which will decrement. This |
| /// is used when spawning asynchronous work, which needs to |
| /// prevent the registry from terminating so long as it is active. |
| /// |
| /// Note that blocking functions such as `join` and `scope` do not |
| /// need to concern themselves with this fn; their context is |
| /// responsible for ensuring the current thread-pool will not |
| /// terminate until they return. |
| /// |
| /// The global thread-pool always has an outstanding reference |
| /// (the initial one). Custom thread-pools have one outstanding |
| /// reference that is dropped when the `ThreadPool` is dropped: |
| /// since installing the thread-pool blocks until any joins/scopes |
| /// complete, this ensures that joins/scopes are covered. |
| /// |
| /// The exception is `::spawn()`, which can create a job outside |
| /// of any blocking scope. In that case, the job itself holds a |
| /// terminate count and is responsible for invoking `terminate()` |
| /// when finished. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>increment_terminate_count(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">let </span>previous = <span class="self">self</span>.terminate_count.fetch_add(<span class="number">1</span>, Ordering::AcqRel); |
| <span class="macro">debug_assert!</span>(previous != <span class="number">0</span>, <span class="string">"registry ref count incremented from zero"</span>); |
| <span class="macro">assert!</span>( |
| previous != std::usize::MAX, |
| <span class="string">"overflow in registry ref count" |
| </span>); |
| } |
| |
| <span class="doccomment">/// Signals that the thread-pool which owns this registry has been |
| /// dropped. The worker threads will gradually terminate, once any |
| /// extant work is completed. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>terminate(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">if </span><span class="self">self</span>.terminate_count.fetch_sub(<span class="number">1</span>, Ordering::AcqRel) == <span class="number">1 </span>{ |
| <span class="kw">for </span>(i, thread_info) <span class="kw">in </span><span class="self">self</span>.thread_infos.iter().enumerate() { |
| <span class="kw">unsafe </span>{ CountLatch::set_and_tickle_one(<span class="kw-2">&</span>thread_info.terminate, <span class="self">self</span>, i) }; |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Notify the worker that the latch they are sleeping on has been "set". |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>notify_worker_latch_is_set(<span class="kw-2">&</span><span class="self">self</span>, target_worker_index: usize) { |
| <span class="self">self</span>.sleep.notify_worker_latch_is_set(target_worker_index); |
| } |
| } |
| |
| <span class="attribute">#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>RegistryId { |
| addr: usize, |
| } |
| |
| <span class="kw">struct </span>ThreadInfo { |
| <span class="doccomment">/// Latch set once thread has started and we are entering into the |
| /// main loop. Used to wait for worker threads to become primed, |
| /// primarily of interest for benchmarking. |
| </span>primed: LockLatch, |
| |
| <span class="doccomment">/// Latch is set once worker thread has completed. Used to wait |
| /// until workers have stopped; only used for tests. |
| </span>stopped: LockLatch, |
| |
| <span class="doccomment">/// The latch used to signal that terminated has been requested. |
| /// This latch is *set* by the `terminate` method on the |
| /// `Registry`, once the registry's main "terminate" counter |
| /// reaches zero. |
| /// |
| /// NB. We use a `CountLatch` here because it has no lifetimes and is |
| /// meant for async use, but the count never gets higher than one. |
| </span>terminate: CountLatch, |
| |
| <span class="doccomment">/// the "stealer" half of the worker's deque |
| </span>stealer: Stealer<JobRef>, |
| } |
| |
| <span class="kw">impl </span>ThreadInfo { |
| <span class="kw">fn </span>new(stealer: Stealer<JobRef>) -> ThreadInfo { |
| ThreadInfo { |
| primed: LockLatch::new(), |
| stopped: LockLatch::new(), |
| terminate: CountLatch::new(), |
| stealer, |
| } |
| } |
| } |
| |
| <span class="doccomment">/// //////////////////////////////////////////////////////////////////////// |
| /// WorkerThread identifiers |
| |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>WorkerThread { |
| <span class="doccomment">/// the "worker" half of our local deque |
| </span>worker: Worker<JobRef>, |
| |
| <span class="doccomment">/// the "stealer" half of the worker's broadcast deque |
| </span>stealer: Stealer<JobRef>, |
| |
| <span class="doccomment">/// local queue used for `spawn_fifo` indirection |
| </span>fifo: JobFifo, |
| |
| index: usize, |
| |
| <span class="doccomment">/// A weak random number generator. |
| </span>rng: XorShift64Star, |
| |
| registry: Arc<Registry>, |
| } |
| |
| <span class="comment">// This is a bit sketchy, but basically: the WorkerThread is |
| // allocated on the stack of the worker on entry and stored into this |
| // thread local variable. So it will remain valid at least until the |
| // worker is fully unwound. Using an unsafe pointer avoids the need |
| // for a RefCell<T> etc. |
| </span><span class="macro">thread_local! </span>{ |
| <span class="kw">static </span>WORKER_THREAD_STATE: Cell<<span class="kw-2">*const </span>WorkerThread> = <span class="kw">const </span>{ Cell::new(ptr::null()) }; |
| } |
| |
| <span class="kw">impl </span>From<ThreadBuilder> <span class="kw">for </span>WorkerThread { |
| <span class="kw">fn </span>from(thread: ThreadBuilder) -> <span class="self">Self </span>{ |
| <span class="self">Self </span>{ |
| worker: thread.worker, |
| stealer: thread.stealer, |
| fifo: JobFifo::new(), |
| index: thread.index, |
| rng: XorShift64Star::new(), |
| registry: thread.registry, |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Drop <span class="kw">for </span>WorkerThread { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="comment">// Undo `set_current` |
| </span>WORKER_THREAD_STATE.with(|t| { |
| <span class="macro">assert!</span>(t.get().eq(<span class="kw-2">&</span>(<span class="self">self </span><span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>))); |
| t.set(ptr::null()); |
| }); |
| } |
| } |
| |
| <span class="kw">impl </span>WorkerThread { |
| <span class="doccomment">/// Gets the `WorkerThread` index for the current thread; returns |
| /// NULL if this is not a worker thread. This pointer is valid |
| /// anywhere on the current thread. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>current() -> <span class="kw-2">*const </span>WorkerThread { |
| WORKER_THREAD_STATE.with(Cell::get) |
| } |
| |
| <span class="doccomment">/// Sets `self` as the worker thread index for the current thread. |
| /// This is done during worker thread startup. |
| </span><span class="kw">unsafe fn </span>set_current(thread: <span class="kw-2">*const </span>WorkerThread) { |
| WORKER_THREAD_STATE.with(|t| { |
| <span class="macro">assert!</span>(t.get().is_null()); |
| t.set(thread); |
| }); |
| } |
| |
| <span class="doccomment">/// Returns the registry that owns this worker thread. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>registry(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>Arc<Registry> { |
| <span class="kw-2">&</span><span class="self">self</span>.registry |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>log(<span class="kw-2">&</span><span class="self">self</span>, event: <span class="kw">impl </span>FnOnce() -> <span class="kw">crate</span>::log::Event) { |
| <span class="self">self</span>.registry.logger.log(event) |
| } |
| |
| <span class="doccomment">/// Our index amongst the worker threads (ranges from `0..self.num_threads()`). |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>index(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.index |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>push(<span class="kw-2">&</span><span class="self">self</span>, job: JobRef) { |
| <span class="self">self</span>.log(|| JobPushed { worker: <span class="self">self</span>.index }); |
| <span class="kw">let </span>queue_was_empty = <span class="self">self</span>.worker.is_empty(); |
| <span class="self">self</span>.worker.push(job); |
| <span class="self">self</span>.registry |
| .sleep |
| .new_internal_jobs(<span class="self">self</span>.index, <span class="number">1</span>, queue_was_empty); |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>push_fifo(<span class="kw-2">&</span><span class="self">self</span>, job: JobRef) { |
| <span class="self">self</span>.push(<span class="self">self</span>.fifo.push(job)); |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>local_deque_is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="self">self</span>.worker.is_empty() |
| } |
| |
| <span class="doccomment">/// Attempts to obtain a "local" job -- typically this means |
| /// popping from the top of the stack, though if we are configured |
| /// for breadth-first execution, it would mean dequeuing from the |
| /// bottom. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>take_local_job(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><JobRef> { |
| <span class="kw">let </span>popped_job = <span class="self">self</span>.worker.pop(); |
| |
| <span class="kw">if </span>popped_job.is_some() { |
| <span class="self">self</span>.log(|| JobPopped { worker: <span class="self">self</span>.index }); |
| <span class="kw">return </span>popped_job; |
| } |
| |
| <span class="kw">loop </span>{ |
| <span class="kw">match </span><span class="self">self</span>.stealer.steal() { |
| Steal::Success(job) => <span class="kw">return </span><span class="prelude-val">Some</span>(job), |
| Steal::Empty => <span class="kw">return </span><span class="prelude-val">None</span>, |
| Steal::Retry => {} |
| } |
| } |
| } |
| |
| <span class="kw">fn </span>has_injected_job(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| !<span class="self">self</span>.stealer.is_empty() || <span class="self">self</span>.registry.has_injected_job() |
| } |
| |
| <span class="doccomment">/// Wait until the latch is set. Try to keep busy by popping and |
| /// stealing tasks as necessary. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>wait_until<L: AsCoreLatch + <span class="question-mark">?</span>Sized>(<span class="kw-2">&</span><span class="self">self</span>, latch: <span class="kw-2">&</span>L) { |
| <span class="kw">let </span>latch = latch.as_core_latch(); |
| <span class="kw">if </span>!latch.probe() { |
| <span class="self">self</span>.wait_until_cold(latch); |
| } |
| } |
| |
| <span class="attribute">#[cold] |
| </span><span class="kw">unsafe fn </span>wait_until_cold(<span class="kw-2">&</span><span class="self">self</span>, latch: <span class="kw-2">&</span>CoreLatch) { |
| <span class="comment">// the code below should swallow all panics and hence never |
| // unwind; but if something does wrong, we want to abort, |
| // because otherwise other code in rayon may assume that the |
| // latch has been signaled, and that can lead to random memory |
| // accesses, which would be *very bad* |
| </span><span class="kw">let </span>abort_guard = unwind::AbortIfPanic; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>idle_state = <span class="self">self</span>.registry.sleep.start_looking(<span class="self">self</span>.index, latch); |
| <span class="kw">while </span>!latch.probe() { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(job) = <span class="self">self</span>.find_work() { |
| <span class="self">self</span>.registry.sleep.work_found(idle_state); |
| <span class="self">self</span>.execute(job); |
| idle_state = <span class="self">self</span>.registry.sleep.start_looking(<span class="self">self</span>.index, latch); |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.registry |
| .sleep |
| .no_work_found(<span class="kw-2">&mut </span>idle_state, latch, || <span class="self">self</span>.has_injected_job()) |
| } |
| } |
| |
| <span class="comment">// If we were sleepy, we are not anymore. We "found work" -- |
| // whatever the surrounding thread was doing before it had to |
| // wait. |
| </span><span class="self">self</span>.registry.sleep.work_found(idle_state); |
| |
| <span class="self">self</span>.log(|| ThreadSawLatchSet { |
| worker: <span class="self">self</span>.index, |
| latch_addr: latch.addr(), |
| }); |
| mem::forget(abort_guard); <span class="comment">// successful execution, do not abort |
| </span>} |
| |
| <span class="kw">fn </span>find_work(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><JobRef> { |
| <span class="comment">// Try to find some work to do. We give preference first |
| // to things in our local deque, then in other workers |
| // deques, and finally to injected jobs from the |
| // outside. The idea is to finish what we started before |
| // we take on something new. |
| </span><span class="self">self</span>.take_local_job() |
| .or_else(|| <span class="self">self</span>.steal()) |
| .or_else(|| <span class="self">self</span>.registry.pop_injected_job(<span class="self">self</span>.index)) |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>yield_now(<span class="kw-2">&</span><span class="self">self</span>) -> Yield { |
| <span class="kw">match </span><span class="self">self</span>.find_work() { |
| <span class="prelude-val">Some</span>(job) => <span class="kw">unsafe </span>{ |
| <span class="self">self</span>.execute(job); |
| Yield::Executed |
| }, |
| <span class="prelude-val">None </span>=> Yield::Idle, |
| } |
| } |
| |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>yield_local(<span class="kw-2">&</span><span class="self">self</span>) -> Yield { |
| <span class="kw">match </span><span class="self">self</span>.take_local_job() { |
| <span class="prelude-val">Some</span>(job) => <span class="kw">unsafe </span>{ |
| <span class="self">self</span>.execute(job); |
| Yield::Executed |
| }, |
| <span class="prelude-val">None </span>=> Yield::Idle, |
| } |
| } |
| |
| <span class="attribute">#[inline] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>execute(<span class="kw-2">&</span><span class="self">self</span>, job: JobRef) { |
| job.execute(); |
| } |
| |
| <span class="doccomment">/// Try to steal a single job and return it. |
| /// |
| /// This should only be done as a last resort, when there is no |
| /// local work to do. |
| </span><span class="kw">fn </span>steal(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><JobRef> { |
| <span class="comment">// we only steal when we don't have any work to do locally |
| </span><span class="macro">debug_assert!</span>(<span class="self">self</span>.local_deque_is_empty()); |
| |
| <span class="comment">// otherwise, try to steal |
| </span><span class="kw">let </span>thread_infos = <span class="kw-2">&</span><span class="self">self</span>.registry.thread_infos.as_slice(); |
| <span class="kw">let </span>num_threads = thread_infos.len(); |
| <span class="kw">if </span>num_threads <= <span class="number">1 </span>{ |
| <span class="kw">return </span><span class="prelude-val">None</span>; |
| } |
| |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>retry = <span class="bool-val">false</span>; |
| <span class="kw">let </span>start = <span class="self">self</span>.rng.next_usize(num_threads); |
| <span class="kw">let </span>job = (start..num_threads) |
| .chain(<span class="number">0</span>..start) |
| .filter(<span class="kw">move </span>|<span class="kw-2">&</span>i| i != <span class="self">self</span>.index) |
| .find_map(|victim_index| { |
| <span class="kw">let </span>victim = <span class="kw-2">&</span>thread_infos[victim_index]; |
| <span class="kw">match </span>victim.stealer.steal() { |
| Steal::Success(job) => { |
| <span class="self">self</span>.log(|| JobStolen { |
| worker: <span class="self">self</span>.index, |
| victim: victim_index, |
| }); |
| <span class="prelude-val">Some</span>(job) |
| } |
| Steal::Empty => <span class="prelude-val">None</span>, |
| Steal::Retry => { |
| retry = <span class="bool-val">true</span>; |
| <span class="prelude-val">None |
| </span>} |
| } |
| }); |
| <span class="kw">if </span>job.is_some() || !retry { |
| <span class="kw">return </span>job; |
| } |
| } |
| } |
| } |
| |
| <span class="doccomment">/// //////////////////////////////////////////////////////////////////////// |
| |
| </span><span class="kw">unsafe fn </span>main_loop(thread: ThreadBuilder) { |
| <span class="kw">let </span>worker_thread = <span class="kw-2">&</span>WorkerThread::from(thread); |
| WorkerThread::set_current(worker_thread); |
| <span class="kw">let </span>registry = <span class="kw-2">&*</span>worker_thread.registry; |
| <span class="kw">let </span>index = worker_thread.index; |
| |
| <span class="comment">// let registry know we are ready to do work |
| </span>Latch::set(<span class="kw-2">&</span>registry.thread_infos[index].primed); |
| |
| <span class="comment">// Worker threads should not panic. If they do, just abort, as the |
| // internal state of the threadpool is corrupted. Note that if |
| // **user code** panics, we should catch that and redirect. |
| </span><span class="kw">let </span>abort_guard = unwind::AbortIfPanic; |
| |
| <span class="comment">// Inform a user callback that we started a thread. |
| </span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>handler) = registry.start_handler { |
| registry.catch_unwind(|| handler(index)); |
| } |
| |
| <span class="kw">let </span>my_terminate_latch = <span class="kw-2">&</span>registry.thread_infos[index].terminate; |
| worker_thread.log(|| ThreadStart { |
| worker: index, |
| terminate_addr: my_terminate_latch.as_core_latch().addr(), |
| }); |
| worker_thread.wait_until(my_terminate_latch); |
| |
| <span class="comment">// Should not be any work left in our queue. |
| </span><span class="macro">debug_assert!</span>(worker_thread.take_local_job().is_none()); |
| |
| <span class="comment">// let registry know we are done |
| </span>Latch::set(<span class="kw-2">&</span>registry.thread_infos[index].stopped); |
| |
| <span class="comment">// Normal termination, do not abort. |
| </span>mem::forget(abort_guard); |
| |
| worker_thread.log(|| ThreadTerminate { worker: index }); |
| |
| <span class="comment">// Inform a user callback that we exited a thread. |
| </span><span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>handler) = registry.exit_handler { |
| registry.catch_unwind(|| handler(index)); |
| <span class="comment">// We're already exiting the thread, there's nothing else to do. |
| </span>} |
| } |
| |
| <span class="doccomment">/// If already in a worker-thread, just execute `op`. Otherwise, |
| /// execute `op` in the default thread-pool. Either way, block until |
| /// `op` completes and return its return value. If `op` panics, that |
| /// panic will be propagated as well. The second argument indicates |
| /// `true` if injection was performed, `false` if executed directly. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>in_worker<OP, R>(op: OP) -> R |
| <span class="kw">where |
| </span>OP: FnOnce(<span class="kw-2">&</span>WorkerThread, bool) -> R + Send, |
| R: Send, |
| { |
| <span class="kw">unsafe </span>{ |
| <span class="kw">let </span>owner_thread = WorkerThread::current(); |
| <span class="kw">if </span>!owner_thread.is_null() { |
| <span class="comment">// Perfectly valid to give them a `&T`: this is the |
| // current thread, so we know the data structure won't be |
| // invalidated until we return. |
| </span>op(<span class="kw-2">&*</span>owner_thread, <span class="bool-val">false</span>) |
| } <span class="kw">else </span>{ |
| global_registry().in_worker(op) |
| } |
| } |
| } |
| |
| <span class="doccomment">/// [xorshift*] is a fast pseudorandom number generator which will |
| /// even tolerate weak seeding, as long as it's not zero. |
| /// |
| /// [xorshift*]: https://en.wikipedia.org/wiki/Xorshift#xorshift* |
| </span><span class="kw">struct </span>XorShift64Star { |
| state: Cell<u64>, |
| } |
| |
| <span class="kw">impl </span>XorShift64Star { |
| <span class="kw">fn </span>new() -> <span class="self">Self </span>{ |
| <span class="comment">// Any non-zero seed will do -- this uses the hash of a global counter. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>seed = <span class="number">0</span>; |
| <span class="kw">while </span>seed == <span class="number">0 </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>hasher = DefaultHasher::new(); |
| <span class="kw">static </span>COUNTER: AtomicUsize = AtomicUsize::new(<span class="number">0</span>); |
| hasher.write_usize(COUNTER.fetch_add(<span class="number">1</span>, Ordering::Relaxed)); |
| seed = hasher.finish(); |
| } |
| |
| XorShift64Star { |
| state: Cell::new(seed), |
| } |
| } |
| |
| <span class="kw">fn </span>next(<span class="kw-2">&</span><span class="self">self</span>) -> u64 { |
| <span class="kw">let </span><span class="kw-2">mut </span>x = <span class="self">self</span>.state.get(); |
| <span class="macro">debug_assert_ne!</span>(x, <span class="number">0</span>); |
| x ^= x >> <span class="number">12</span>; |
| x ^= x << <span class="number">25</span>; |
| x ^= x >> <span class="number">27</span>; |
| <span class="self">self</span>.state.set(x); |
| x.wrapping_mul(<span class="number">0x2545_f491_4f6c_dd1d</span>) |
| } |
| |
| <span class="doccomment">/// Return a value from `0..n`. |
| </span><span class="kw">fn </span>next_usize(<span class="kw-2">&</span><span class="self">self</span>, n: usize) -> usize { |
| (<span class="self">self</span>.next() % n <span class="kw">as </span>u64) <span class="kw">as </span>usize |
| } |
| } |
| </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> |