blob: 8eb95cddf78228b3789051774905f4f52977ed6d [file] [log] [blame]
<!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/tokio-377c595163f99a10/dfe252d/tokio/src/runtime/blocking/pool.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>pool.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="../../../../tokio/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="../../../../tokio/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>
</pre><pre class="rust"><code><span class="doccomment">//! Thread pool for blocking operations
</span><span class="kw">use </span><span class="kw">crate</span>::loom::sync::{Arc, Condvar, Mutex};
<span class="kw">use </span><span class="kw">crate</span>::loom::thread;
<span class="kw">use </span><span class="kw">crate</span>::runtime::blocking::schedule::BlockingSchedule;
<span class="kw">use </span><span class="kw">crate</span>::runtime::blocking::{shutdown, BlockingTask};
<span class="kw">use </span><span class="kw">crate</span>::runtime::builder::ThreadNameFn;
<span class="kw">use </span><span class="kw">crate</span>::runtime::task::{<span class="self">self</span>, JoinHandle};
<span class="kw">use </span><span class="kw">crate</span>::runtime::{Builder, Callback, Handle};
<span class="kw">use </span>std::collections::{HashMap, VecDeque};
<span class="kw">use </span>std::fmt;
<span class="kw">use </span>std::io;
<span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering};
<span class="kw">use </span>std::time::Duration;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>BlockingPool {
spawner: Spawner,
shutdown_rx: shutdown::Receiver,
}
<span class="attribute">#[derive(Clone)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Spawner {
inner: Arc&lt;Inner&gt;,
}
<span class="attribute">#[derive(Default)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>SpawnerMetrics {
num_threads: AtomicUsize,
num_idle_threads: AtomicUsize,
queue_depth: AtomicUsize,
}
<span class="kw">impl </span>SpawnerMetrics {
<span class="kw">fn </span>num_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.num_threads.load(Ordering::Relaxed)
}
<span class="kw">fn </span>num_idle_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.num_idle_threads.load(Ordering::Relaxed)
}
<span class="macro">cfg_metrics! </span>{
<span class="kw">fn </span>queue_depth(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.queue_depth.load(Ordering::Relaxed)
}
}
<span class="kw">fn </span>inc_num_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.num_threads.fetch_add(<span class="number">1</span>, Ordering::Relaxed);
}
<span class="kw">fn </span>dec_num_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.num_threads.fetch_sub(<span class="number">1</span>, Ordering::Relaxed);
}
<span class="kw">fn </span>inc_num_idle_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.num_idle_threads.fetch_add(<span class="number">1</span>, Ordering::Relaxed);
}
<span class="kw">fn </span>dec_num_idle_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.num_idle_threads.fetch_sub(<span class="number">1</span>, Ordering::Relaxed)
}
<span class="kw">fn </span>inc_queue_depth(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.queue_depth.fetch_add(<span class="number">1</span>, Ordering::Relaxed);
}
<span class="kw">fn </span>dec_queue_depth(<span class="kw-2">&amp;</span><span class="self">self</span>) {
<span class="self">self</span>.queue_depth.fetch_sub(<span class="number">1</span>, Ordering::Relaxed);
}
}
<span class="kw">struct </span>Inner {
<span class="doccomment">/// State shared between worker threads.
</span>shared: Mutex&lt;Shared&gt;,
<span class="doccomment">/// Pool threads wait on this.
</span>condvar: Condvar,
<span class="doccomment">/// Spawned threads use this name.
</span>thread_name: ThreadNameFn,
<span class="doccomment">/// Spawned thread stack size.
</span>stack_size: <span class="prelude-ty">Option</span>&lt;usize&gt;,
<span class="doccomment">/// Call after a thread starts.
</span>after_start: <span class="prelude-ty">Option</span>&lt;Callback&gt;,
<span class="doccomment">/// Call before a thread stops.
</span>before_stop: <span class="prelude-ty">Option</span>&lt;Callback&gt;,
<span class="comment">// Maximum number of threads.
</span>thread_cap: usize,
<span class="comment">// Customizable wait timeout.
</span>keep_alive: Duration,
<span class="comment">// Metrics about the pool.
</span>metrics: SpawnerMetrics,
}
<span class="kw">struct </span>Shared {
queue: VecDeque&lt;Task&gt;,
num_notify: u32,
shutdown: bool,
shutdown_tx: <span class="prelude-ty">Option</span>&lt;shutdown::Sender&gt;,
<span class="doccomment">/// Prior to shutdown, we clean up JoinHandles by having each timed-out
/// thread join on the previous timed-out thread. This is not strictly
/// necessary but helps avoid Valgrind false positives, see
/// &lt;https://github.com/tokio-rs/tokio/commit/646fbae76535e397ef79dbcaacb945d4c829f666&gt;
/// for more information.
</span>last_exiting_thread: <span class="prelude-ty">Option</span>&lt;thread::JoinHandle&lt;()&gt;&gt;,
<span class="doccomment">/// This holds the JoinHandles for all running threads; on shutdown, the thread
/// calling shutdown handles joining on these.
</span>worker_threads: HashMap&lt;usize, thread::JoinHandle&lt;()&gt;&gt;,
<span class="doccomment">/// This is a counter used to iterate worker_threads in a consistent order (for loom&#39;s
/// benefit).
</span>worker_thread_index: usize,
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>Task {
task: task::UnownedTask&lt;BlockingSchedule&gt;,
mandatory: Mandatory,
}
<span class="attribute">#[derive(PartialEq, Eq)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>Mandatory {
<span class="attribute">#[cfg_attr(not(fs), allow(dead_code))]
</span>Mandatory,
NonMandatory,
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>SpawnError {
<span class="doccomment">/// Pool is shutting down and the task was not scheduled
</span>ShuttingDown,
<span class="doccomment">/// There are no worker threads available to take the task
/// and the OS failed to spawn a new one
</span>NoThreads(io::Error),
}
<span class="kw">impl </span>From&lt;SpawnError&gt; <span class="kw">for </span>io::Error {
<span class="kw">fn </span>from(e: SpawnError) -&gt; <span class="self">Self </span>{
<span class="kw">match </span>e {
SpawnError::ShuttingDown =&gt; {
io::Error::new(io::ErrorKind::Other, <span class="string">&quot;blocking pool shutting down&quot;</span>)
}
SpawnError::NoThreads(e) =&gt; e,
}
}
}
<span class="kw">impl </span>Task {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(task: task::UnownedTask&lt;BlockingSchedule&gt;, mandatory: Mandatory) -&gt; Task {
Task { task, mandatory }
}
<span class="kw">fn </span>run(<span class="self">self</span>) {
<span class="self">self</span>.task.run();
}
<span class="kw">fn </span>shutdown_or_run_if_mandatory(<span class="self">self</span>) {
<span class="kw">match </span><span class="self">self</span>.mandatory {
Mandatory::NonMandatory =&gt; <span class="self">self</span>.task.shutdown(),
Mandatory::Mandatory =&gt; <span class="self">self</span>.task.run(),
}
}
}
<span class="kw">const </span>KEEP_ALIVE: Duration = Duration::from_secs(<span class="number">10</span>);
<span class="doccomment">/// Runs the provided function on an executor dedicated to blocking operations.
/// Tasks will be scheduled as non-mandatory, meaning they may not get executed
/// in case of runtime shutdown.
</span><span class="attribute">#[track_caller]
#[cfg_attr(tokio_wasi, allow(dead_code))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawn_blocking&lt;F, R&gt;(func: F) -&gt; JoinHandle&lt;R&gt;
<span class="kw">where
</span>F: FnOnce() -&gt; R + Send + <span class="lifetime">&#39;static</span>,
R: Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>rt = Handle::current();
rt.spawn_blocking(func)
}
<span class="macro">cfg_fs! </span>{
<span class="attribute">#[cfg_attr(any(
all(loom, not(test)), <span class="comment">// the function is covered by loom tests
</span>test
), allow(dead_code))]
</span><span class="doccomment">/// Runs the provided function on an executor dedicated to blocking
/// operations. Tasks will be scheduled as mandatory, meaning they are
/// guaranteed to run unless a shutdown is already taking place. In case a
/// shutdown is already taking place, `None` will be returned.
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawn_mandatory_blocking&lt;F, R&gt;(func: F) -&gt; <span class="prelude-ty">Option</span>&lt;JoinHandle&lt;R&gt;&gt;
<span class="kw">where
</span>F: FnOnce() -&gt; R + Send + <span class="lifetime">&#39;static</span>,
R: Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>rt = Handle::current();
rt.inner.blocking_spawner().spawn_mandatory_blocking(<span class="kw-2">&amp;</span>rt, func)
}
}
<span class="comment">// ===== impl BlockingPool =====
</span><span class="kw">impl </span>BlockingPool {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>new(builder: <span class="kw-2">&amp;</span>Builder, thread_cap: usize) -&gt; BlockingPool {
<span class="kw">let </span>(shutdown_tx, shutdown_rx) = shutdown::channel();
<span class="kw">let </span>keep_alive = builder.keep_alive.unwrap_or(KEEP_ALIVE);
BlockingPool {
spawner: Spawner {
inner: Arc::new(Inner {
shared: Mutex::new(Shared {
queue: VecDeque::new(),
num_notify: <span class="number">0</span>,
shutdown: <span class="bool-val">false</span>,
shutdown_tx: <span class="prelude-val">Some</span>(shutdown_tx),
last_exiting_thread: <span class="prelude-val">None</span>,
worker_threads: HashMap::new(),
worker_thread_index: <span class="number">0</span>,
}),
condvar: Condvar::new(),
thread_name: builder.thread_name.clone(),
stack_size: builder.thread_stack_size,
after_start: builder.after_start.clone(),
before_stop: builder.before_stop.clone(),
thread_cap,
keep_alive,
metrics: Default::default(),
}),
},
shutdown_rx,
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawner(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>Spawner {
<span class="kw-2">&amp;</span><span class="self">self</span>.spawner
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>shutdown(<span class="kw-2">&amp;mut </span><span class="self">self</span>, timeout: <span class="prelude-ty">Option</span>&lt;Duration&gt;) {
<span class="kw">let </span><span class="kw-2">mut </span>shared = <span class="self">self</span>.spawner.inner.shared.lock();
<span class="comment">// The function can be called multiple times. First, by explicitly
// calling `shutdown` then by the drop handler calling `shutdown`. This
// prevents shutting down twice.
</span><span class="kw">if </span>shared.shutdown {
<span class="kw">return</span>;
}
shared.shutdown = <span class="bool-val">true</span>;
shared.shutdown_tx = <span class="prelude-val">None</span>;
<span class="self">self</span>.spawner.inner.condvar.notify_all();
<span class="kw">let </span>last_exited_thread = std::mem::take(<span class="kw-2">&amp;mut </span>shared.last_exiting_thread);
<span class="kw">let </span>workers = std::mem::take(<span class="kw-2">&amp;mut </span>shared.worker_threads);
drop(shared);
<span class="kw">if </span><span class="self">self</span>.shutdown_rx.wait(timeout) {
<span class="kw">let _ </span>= last_exited_thread.map(|th| th.join());
<span class="comment">// Loom requires that execution be deterministic, so sort by thread ID before joining.
// (HashMaps use a randomly-seeded hash function, so the order is nondeterministic)
</span><span class="kw">let </span><span class="kw-2">mut </span>workers: Vec&lt;(usize, thread::JoinHandle&lt;()&gt;)&gt; = workers.into_iter().collect();
workers.sort_by_key(|(id, <span class="kw">_</span>)| <span class="kw-2">*</span>id);
<span class="kw">for </span>(_id, handle) <span class="kw">in </span>workers.into_iter() {
<span class="kw">let _ </span>= handle.join();
}
}
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>BlockingPool {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="self">self</span>.shutdown(<span class="prelude-val">None</span>);
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>BlockingPool {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
fmt.debug_struct(<span class="string">&quot;BlockingPool&quot;</span>).finish()
}
}
<span class="comment">// ===== impl Spawner =====
</span><span class="kw">impl </span>Spawner {
<span class="attribute">#[track_caller]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawn_blocking&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, rt: <span class="kw-2">&amp;</span>Handle, func: F) -&gt; JoinHandle&lt;R&gt;
<span class="kw">where
</span>F: FnOnce() -&gt; R + Send + <span class="lifetime">&#39;static</span>,
R: Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>(join_handle, spawn_result) =
<span class="kw">if </span><span class="macro">cfg!</span>(debug_assertions) &amp;&amp; std::mem::size_of::&lt;F&gt;() &gt; <span class="number">2048 </span>{
<span class="self">self</span>.spawn_blocking_inner(Box::new(func), Mandatory::NonMandatory, <span class="prelude-val">None</span>, rt)
} <span class="kw">else </span>{
<span class="self">self</span>.spawn_blocking_inner(func, Mandatory::NonMandatory, <span class="prelude-val">None</span>, rt)
};
<span class="kw">match </span>spawn_result {
<span class="prelude-val">Ok</span>(()) =&gt; join_handle,
<span class="comment">// Compat: do not panic here, return the join_handle even though it will never resolve
</span><span class="prelude-val">Err</span>(SpawnError::ShuttingDown) =&gt; join_handle,
<span class="prelude-val">Err</span>(SpawnError::NoThreads(e)) =&gt; {
<span class="macro">panic!</span>(<span class="string">&quot;OS can&#39;t spawn worker thread: {}&quot;</span>, e)
}
}
}
<span class="macro">cfg_fs! </span>{
<span class="attribute">#[track_caller]
#[cfg_attr(any(
all(loom, not(test)), <span class="comment">// the function is covered by loom tests
</span>test
), allow(dead_code))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawn_mandatory_blocking&lt;F, R&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, rt: <span class="kw-2">&amp;</span>Handle, func: F) -&gt; <span class="prelude-ty">Option</span>&lt;JoinHandle&lt;R&gt;&gt;
<span class="kw">where
</span>F: FnOnce() -&gt; R + Send + <span class="lifetime">&#39;static</span>,
R: Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>(join_handle, spawn_result) = <span class="kw">if </span><span class="macro">cfg!</span>(debug_assertions) &amp;&amp; std::mem::size_of::&lt;F&gt;() &gt; <span class="number">2048 </span>{
<span class="self">self</span>.spawn_blocking_inner(
Box::new(func),
Mandatory::Mandatory,
<span class="prelude-val">None</span>,
rt,
)
} <span class="kw">else </span>{
<span class="self">self</span>.spawn_blocking_inner(
func,
Mandatory::Mandatory,
<span class="prelude-val">None</span>,
rt,
)
};
<span class="kw">if </span>spawn_result.is_ok() {
<span class="prelude-val">Some</span>(join_handle)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>}
}
}
<span class="attribute">#[track_caller]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>spawn_blocking_inner&lt;F, R&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
func: F,
is_mandatory: Mandatory,
name: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span>str&gt;,
rt: <span class="kw-2">&amp;</span>Handle,
) -&gt; (JoinHandle&lt;R&gt;, <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt;)
<span class="kw">where
</span>F: FnOnce() -&gt; R + Send + <span class="lifetime">&#39;static</span>,
R: Send + <span class="lifetime">&#39;static</span>,
{
<span class="kw">let </span>fut = BlockingTask::new(func);
<span class="kw">let </span>id = task::Id::next();
<span class="attribute">#[cfg(all(tokio_unstable, feature = <span class="string">&quot;tracing&quot;</span>))]
</span><span class="kw">let </span>fut = {
<span class="kw">use </span>tracing::Instrument;
<span class="kw">let </span>location = std::panic::Location::caller();
<span class="kw">let </span>span = <span class="macro">tracing::trace_span!</span>(
target: <span class="string">&quot;tokio::task::blocking&quot;</span>,
<span class="string">&quot;runtime.spawn&quot;</span>,
kind = %<span class="string">&quot;blocking&quot;</span>,
task.name = %name.unwrap_or_default(),
task.id = id.as_u64(),
<span class="string">&quot;fn&quot; </span>= %std::any::type_name::&lt;F&gt;(),
spawn.location = %<span class="macro">format_args!</span>(<span class="string">&quot;{}:{}:{}&quot;</span>, location.file(), location.line(), location.column()),
);
fut.instrument(span)
};
<span class="attribute">#[cfg(not(all(tokio_unstable, feature = <span class="string">&quot;tracing&quot;</span>)))]
</span><span class="kw">let _ </span>= name;
<span class="kw">let </span>(task, handle) = task::unowned(fut, BlockingSchedule::new(rt), id);
<span class="kw">let </span>spawned = <span class="self">self</span>.spawn_task(Task::new(task, is_mandatory), rt);
(handle, spawned)
}
<span class="kw">fn </span>spawn_task(<span class="kw-2">&amp;</span><span class="self">self</span>, task: Task, rt: <span class="kw-2">&amp;</span>Handle) -&gt; <span class="prelude-ty">Result</span>&lt;(), SpawnError&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>shared = <span class="self">self</span>.inner.shared.lock();
<span class="kw">if </span>shared.shutdown {
<span class="comment">// Shutdown the task: it&#39;s fine to shutdown this task (even if
// mandatory) because it was scheduled after the shutdown of the
// runtime began.
</span>task.task.shutdown();
<span class="comment">// no need to even push this task; it would never get picked up
</span><span class="kw">return </span><span class="prelude-val">Err</span>(SpawnError::ShuttingDown);
}
shared.queue.push_back(task);
<span class="self">self</span>.inner.metrics.inc_queue_depth();
<span class="kw">if </span><span class="self">self</span>.inner.metrics.num_idle_threads() == <span class="number">0 </span>{
<span class="comment">// No threads are able to process the task.
</span><span class="kw">if </span><span class="self">self</span>.inner.metrics.num_threads() == <span class="self">self</span>.inner.thread_cap {
<span class="comment">// At max number of threads
</span>} <span class="kw">else </span>{
<span class="macro">assert!</span>(shared.shutdown_tx.is_some());
<span class="kw">let </span>shutdown_tx = shared.shutdown_tx.clone();
<span class="kw">if let </span><span class="prelude-val">Some</span>(shutdown_tx) = shutdown_tx {
<span class="kw">let </span>id = shared.worker_thread_index;
<span class="kw">match </span><span class="self">self</span>.spawn_thread(shutdown_tx, rt, id) {
<span class="prelude-val">Ok</span>(handle) =&gt; {
<span class="self">self</span>.inner.metrics.inc_num_threads();
shared.worker_thread_index += <span class="number">1</span>;
shared.worker_threads.insert(id, handle);
}
<span class="prelude-val">Err</span>(<span class="kw-2">ref </span>e)
<span class="kw">if </span>is_temporary_os_thread_error(e)
&amp;&amp; <span class="self">self</span>.inner.metrics.num_threads() &gt; <span class="number">0 </span>=&gt;
{
<span class="comment">// OS temporarily failed to spawn a new thread.
// The task will be picked up eventually by a currently
// busy thread.
</span>}
<span class="prelude-val">Err</span>(e) =&gt; {
<span class="comment">// The OS refused to spawn the thread and there is no thread
// to pick up the task that has just been pushed to the queue.
</span><span class="kw">return </span><span class="prelude-val">Err</span>(SpawnError::NoThreads(e));
}
}
}
}
} <span class="kw">else </span>{
<span class="comment">// Notify an idle worker thread. The notification counter
// is used to count the needed amount of notifications
// exactly. Thread libraries may generate spurious
// wakeups, this counter is used to keep us in a
// consistent state.
</span><span class="self">self</span>.inner.metrics.dec_num_idle_threads();
shared.num_notify += <span class="number">1</span>;
<span class="self">self</span>.inner.condvar.notify_one();
}
<span class="prelude-val">Ok</span>(())
}
<span class="kw">fn </span>spawn_thread(
<span class="kw-2">&amp;</span><span class="self">self</span>,
shutdown_tx: shutdown::Sender,
rt: <span class="kw-2">&amp;</span>Handle,
id: usize,
) -&gt; std::io::Result&lt;thread::JoinHandle&lt;()&gt;&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>builder = thread::Builder::new().name((<span class="self">self</span>.inner.thread_name)());
<span class="kw">if let </span><span class="prelude-val">Some</span>(stack_size) = <span class="self">self</span>.inner.stack_size {
builder = builder.stack_size(stack_size);
}
<span class="kw">let </span>rt = rt.clone();
builder.spawn(<span class="kw">move </span>|| {
<span class="comment">// Only the reference should be moved into the closure
</span><span class="kw">let </span>_enter = rt.enter();
rt.inner.blocking_spawner().inner.run(id);
drop(shutdown_tx);
})
}
}
<span class="macro">cfg_metrics! </span>{
<span class="kw">impl </span>Spawner {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>num_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.inner.metrics.num_threads()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>num_idle_threads(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.inner.metrics.num_idle_threads()
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>queue_depth(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.inner.metrics.queue_depth()
}
}
}
<span class="comment">// Tells whether the error when spawning a thread is temporary.
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>is_temporary_os_thread_error(error: <span class="kw-2">&amp;</span>std::io::Error) -&gt; bool {
<span class="macro">matches!</span>(error.kind(), std::io::ErrorKind::WouldBlock)
}
<span class="kw">impl </span>Inner {
<span class="kw">fn </span>run(<span class="kw-2">&amp;</span><span class="self">self</span>, worker_thread_id: usize) {
<span class="kw">if let </span><span class="prelude-val">Some</span>(f) = <span class="kw-2">&amp;</span><span class="self">self</span>.after_start {
f()
}
<span class="kw">let </span><span class="kw-2">mut </span>shared = <span class="self">self</span>.shared.lock();
<span class="kw">let </span><span class="kw-2">mut </span>join_on_thread = <span class="prelude-val">None</span>;
<span class="lifetime">&#39;main</span>: <span class="kw">loop </span>{
<span class="comment">// BUSY
</span><span class="kw">while let </span><span class="prelude-val">Some</span>(task) = shared.queue.pop_front() {
<span class="self">self</span>.metrics.dec_queue_depth();
drop(shared);
task.run();
shared = <span class="self">self</span>.shared.lock();
}
<span class="comment">// IDLE
</span><span class="self">self</span>.metrics.inc_num_idle_threads();
<span class="kw">while </span>!shared.shutdown {
<span class="kw">let </span>lock_result = <span class="self">self</span>.condvar.wait_timeout(shared, <span class="self">self</span>.keep_alive).unwrap();
shared = lock_result.<span class="number">0</span>;
<span class="kw">let </span>timeout_result = lock_result.<span class="number">1</span>;
<span class="kw">if </span>shared.num_notify != <span class="number">0 </span>{
<span class="comment">// We have received a legitimate wakeup,
// acknowledge it by decrementing the counter
// and transition to the BUSY state.
</span>shared.num_notify -= <span class="number">1</span>;
<span class="kw">break</span>;
}
<span class="comment">// Even if the condvar &quot;timed out&quot;, if the pool is entering the
// shutdown phase, we want to perform the cleanup logic.
</span><span class="kw">if </span>!shared.shutdown &amp;&amp; timeout_result.timed_out() {
<span class="comment">// We&#39;ll join the prior timed-out thread&#39;s JoinHandle after dropping the lock.
// This isn&#39;t done when shutting down, because the thread calling shutdown will
// handle joining everything.
</span><span class="kw">let </span>my_handle = shared.worker_threads.remove(<span class="kw-2">&amp;</span>worker_thread_id);
join_on_thread = std::mem::replace(<span class="kw-2">&amp;mut </span>shared.last_exiting_thread, my_handle);
<span class="kw">break </span><span class="lifetime">&#39;main</span>;
}
<span class="comment">// Spurious wakeup detected, go back to sleep.
</span>}
<span class="kw">if </span>shared.shutdown {
<span class="comment">// Drain the queue
</span><span class="kw">while let </span><span class="prelude-val">Some</span>(task) = shared.queue.pop_front() {
<span class="self">self</span>.metrics.dec_queue_depth();
drop(shared);
task.shutdown_or_run_if_mandatory();
shared = <span class="self">self</span>.shared.lock();
}
<span class="comment">// Work was produced, and we &quot;took&quot; it (by decrementing num_notify).
// This means that num_idle was decremented once for our wakeup.
// But, since we are exiting, we need to &quot;undo&quot; that, as we&#39;ll stay idle.
</span><span class="self">self</span>.metrics.inc_num_idle_threads();
<span class="comment">// NOTE: Technically we should also do num_notify++ and notify again,
// but since we&#39;re shutting down anyway, that won&#39;t be necessary.
</span><span class="kw">break</span>;
}
}
<span class="comment">// Thread exit
</span><span class="self">self</span>.metrics.dec_num_threads();
<span class="comment">// num_idle should now be tracked exactly, panic
// with a descriptive message if it is not the
// case.
</span><span class="kw">let </span>prev_idle = <span class="self">self</span>.metrics.dec_num_idle_threads();
<span class="kw">if </span>prev_idle &lt; <span class="self">self</span>.metrics.num_idle_threads() {
<span class="macro">panic!</span>(<span class="string">&quot;num_idle_threads underflowed on thread exit&quot;</span>)
}
<span class="kw">if </span>shared.shutdown &amp;&amp; <span class="self">self</span>.metrics.num_threads() == <span class="number">0 </span>{
<span class="self">self</span>.condvar.notify_one();
}
drop(shared);
<span class="kw">if let </span><span class="prelude-val">Some</span>(f) = <span class="kw-2">&amp;</span><span class="self">self</span>.before_stop {
f()
}
<span class="kw">if let </span><span class="prelude-val">Some</span>(handle) = join_on_thread {
<span class="kw">let _ </span>= handle.join();
}
}
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Spawner {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, fmt: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
fmt.debug_struct(<span class="string">&quot;blocking::Spawner&quot;</span>).finish()
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>