| <!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/registry/src/github.com-1ecc6299db9ec823/tokio-1.28.2/src/task/local.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>local.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> |
| <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> |
| <span id="1030">1030</span> |
| <span id="1031">1031</span> |
| <span id="1032">1032</span> |
| <span id="1033">1033</span> |
| <span id="1034">1034</span> |
| <span id="1035">1035</span> |
| <span id="1036">1036</span> |
| <span id="1037">1037</span> |
| <span id="1038">1038</span> |
| <span id="1039">1039</span> |
| <span id="1040">1040</span> |
| <span id="1041">1041</span> |
| <span id="1042">1042</span> |
| <span id="1043">1043</span> |
| <span id="1044">1044</span> |
| <span id="1045">1045</span> |
| <span id="1046">1046</span> |
| <span id="1047">1047</span> |
| <span id="1048">1048</span> |
| <span id="1049">1049</span> |
| <span id="1050">1050</span> |
| <span id="1051">1051</span> |
| <span id="1052">1052</span> |
| <span id="1053">1053</span> |
| <span id="1054">1054</span> |
| <span id="1055">1055</span> |
| <span id="1056">1056</span> |
| <span id="1057">1057</span> |
| <span id="1058">1058</span> |
| <span id="1059">1059</span> |
| <span id="1060">1060</span> |
| <span id="1061">1061</span> |
| <span id="1062">1062</span> |
| <span id="1063">1063</span> |
| <span id="1064">1064</span> |
| <span id="1065">1065</span> |
| <span id="1066">1066</span> |
| <span id="1067">1067</span> |
| <span id="1068">1068</span> |
| <span id="1069">1069</span> |
| <span id="1070">1070</span> |
| <span id="1071">1071</span> |
| <span id="1072">1072</span> |
| <span id="1073">1073</span> |
| <span id="1074">1074</span> |
| <span id="1075">1075</span> |
| <span id="1076">1076</span> |
| <span id="1077">1077</span> |
| <span id="1078">1078</span> |
| <span id="1079">1079</span> |
| <span id="1080">1080</span> |
| <span id="1081">1081</span> |
| <span id="1082">1082</span> |
| <span id="1083">1083</span> |
| <span id="1084">1084</span> |
| <span id="1085">1085</span> |
| <span id="1086">1086</span> |
| <span id="1087">1087</span> |
| <span id="1088">1088</span> |
| <span id="1089">1089</span> |
| <span id="1090">1090</span> |
| <span id="1091">1091</span> |
| <span id="1092">1092</span> |
| <span id="1093">1093</span> |
| <span id="1094">1094</span> |
| <span id="1095">1095</span> |
| <span id="1096">1096</span> |
| <span id="1097">1097</span> |
| <span id="1098">1098</span> |
| <span id="1099">1099</span> |
| <span id="1100">1100</span> |
| <span id="1101">1101</span> |
| <span id="1102">1102</span> |
| <span id="1103">1103</span> |
| <span id="1104">1104</span> |
| <span id="1105">1105</span> |
| <span id="1106">1106</span> |
| <span id="1107">1107</span> |
| <span id="1108">1108</span> |
| <span id="1109">1109</span> |
| <span id="1110">1110</span> |
| <span id="1111">1111</span> |
| <span id="1112">1112</span> |
| <span id="1113">1113</span> |
| <span id="1114">1114</span> |
| <span id="1115">1115</span> |
| <span id="1116">1116</span> |
| <span id="1117">1117</span> |
| <span id="1118">1118</span> |
| <span id="1119">1119</span> |
| <span id="1120">1120</span> |
| <span id="1121">1121</span> |
| <span id="1122">1122</span> |
| <span id="1123">1123</span> |
| <span id="1124">1124</span> |
| <span id="1125">1125</span> |
| <span id="1126">1126</span> |
| <span id="1127">1127</span> |
| <span id="1128">1128</span> |
| <span id="1129">1129</span> |
| <span id="1130">1130</span> |
| <span id="1131">1131</span> |
| <span id="1132">1132</span> |
| <span id="1133">1133</span> |
| <span id="1134">1134</span> |
| <span id="1135">1135</span> |
| <span id="1136">1136</span> |
| <span id="1137">1137</span> |
| <span id="1138">1138</span> |
| <span id="1139">1139</span> |
| <span id="1140">1140</span> |
| <span id="1141">1141</span> |
| <span id="1142">1142</span> |
| <span id="1143">1143</span> |
| <span id="1144">1144</span> |
| <span id="1145">1145</span> |
| <span id="1146">1146</span> |
| <span id="1147">1147</span> |
| <span id="1148">1148</span> |
| <span id="1149">1149</span> |
| <span id="1150">1150</span> |
| <span id="1151">1151</span> |
| <span id="1152">1152</span> |
| <span id="1153">1153</span> |
| <span id="1154">1154</span> |
| <span id="1155">1155</span> |
| <span id="1156">1156</span> |
| <span id="1157">1157</span> |
| <span id="1158">1158</span> |
| <span id="1159">1159</span> |
| <span id="1160">1160</span> |
| <span id="1161">1161</span> |
| <span id="1162">1162</span> |
| <span id="1163">1163</span> |
| <span id="1164">1164</span> |
| <span id="1165">1165</span> |
| <span id="1166">1166</span> |
| <span id="1167">1167</span> |
| <span id="1168">1168</span> |
| <span id="1169">1169</span> |
| <span id="1170">1170</span> |
| <span id="1171">1171</span> |
| <span id="1172">1172</span> |
| <span id="1173">1173</span> |
| <span id="1174">1174</span> |
| <span id="1175">1175</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! Runs `!Send` futures on the current thread. |
| </span><span class="kw">use </span><span class="kw">crate</span>::loom::cell::UnsafeCell; |
| <span class="kw">use </span><span class="kw">crate</span>::loom::sync::{Arc, Mutex}; |
| <span class="kw">use </span><span class="kw">crate</span>::runtime::task::{<span class="self">self</span>, JoinHandle, LocalOwnedTasks, Task}; |
| <span class="kw">use </span><span class="kw">crate</span>::runtime::{context, ThreadId}; |
| <span class="kw">use </span><span class="kw">crate</span>::sync::AtomicWaker; |
| <span class="kw">use </span><span class="kw">crate</span>::util::RcCell; |
| |
| <span class="kw">use </span>std::cell::Cell; |
| <span class="kw">use </span>std::collections::VecDeque; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::future::Future; |
| <span class="kw">use </span>std::marker::PhantomData; |
| <span class="kw">use </span>std::pin::Pin; |
| <span class="kw">use </span>std::rc::Rc; |
| <span class="kw">use </span>std::task::Poll; |
| |
| <span class="kw">use </span>pin_project_lite::pin_project; |
| |
| <span class="macro">cfg_rt! </span>{ |
| <span class="doccomment">/// A set of tasks which are executed on the same thread. |
| /// |
| /// In some cases, it is necessary to run one or more futures that do not |
| /// implement [`Send`] and thus are unsafe to send between threads. In these |
| /// cases, a [local task set] may be used to schedule one or more `!Send` |
| /// futures to run together on the same thread. |
| /// |
| /// For example, the following code will not compile: |
| /// |
| /// ```rust,compile_fail |
| /// use std::rc::Rc; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// // `Rc` does not implement `Send`, and thus may not be sent between |
| /// // threads safely. |
| /// let nonsend_data = Rc::new("my nonsend data..."); |
| /// |
| /// let nonsend_data = nonsend_data.clone(); |
| /// // Because the `async` block here moves `nonsend_data`, the future is `!Send`. |
| /// // Since `tokio::spawn` requires the spawned future to implement `Send`, this |
| /// // will not compile. |
| /// tokio::spawn(async move { |
| /// println!("{}", nonsend_data); |
| /// // ... |
| /// }).await.unwrap(); |
| /// } |
| /// ``` |
| /// |
| /// # Use with `run_until` |
| /// |
| /// To spawn `!Send` futures, we can use a local task set to schedule them |
| /// on the thread calling [`Runtime::block_on`]. When running inside of the |
| /// local task set, we can use [`task::spawn_local`], which can spawn |
| /// `!Send` futures. For example: |
| /// |
| /// ```rust |
| /// use std::rc::Rc; |
| /// use tokio::task; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let nonsend_data = Rc::new("my nonsend data..."); |
| /// |
| /// // Construct a local task set that can run `!Send` futures. |
| /// let local = task::LocalSet::new(); |
| /// |
| /// // Run the local task set. |
| /// local.run_until(async move { |
| /// let nonsend_data = nonsend_data.clone(); |
| /// // `spawn_local` ensures that the future is spawned on the local |
| /// // task set. |
| /// task::spawn_local(async move { |
| /// println!("{}", nonsend_data); |
| /// // ... |
| /// }).await.unwrap(); |
| /// }).await; |
| /// } |
| /// ``` |
| /// **Note:** The `run_until` method can only be used in `#[tokio::main]`, |
| /// `#[tokio::test]` or directly inside a call to [`Runtime::block_on`]. It |
| /// cannot be used inside a task spawned with `tokio::spawn`. |
| /// |
| /// ## Awaiting a `LocalSet` |
| /// |
| /// Additionally, a `LocalSet` itself implements `Future`, completing when |
| /// *all* tasks spawned on the `LocalSet` complete. This can be used to run |
| /// several futures on a `LocalSet` and drive the whole set until they |
| /// complete. For example, |
| /// |
| /// ```rust |
| /// use tokio::{task, time}; |
| /// use std::rc::Rc; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let nonsend_data = Rc::new("world"); |
| /// let local = task::LocalSet::new(); |
| /// |
| /// let nonsend_data2 = nonsend_data.clone(); |
| /// local.spawn_local(async move { |
| /// // ... |
| /// println!("hello {}", nonsend_data2) |
| /// }); |
| /// |
| /// local.spawn_local(async move { |
| /// time::sleep(time::Duration::from_millis(100)).await; |
| /// println!("goodbye {}", nonsend_data) |
| /// }); |
| /// |
| /// // ... |
| /// |
| /// local.await; |
| /// } |
| /// ``` |
| /// **Note:** Awaiting a `LocalSet` can only be done inside |
| /// `#[tokio::main]`, `#[tokio::test]` or directly inside a call to |
| /// [`Runtime::block_on`]. It cannot be used inside a task spawned with |
| /// `tokio::spawn`. |
| /// |
| /// ## Use inside `tokio::spawn` |
| /// |
| /// The two methods mentioned above cannot be used inside `tokio::spawn`, so |
| /// to spawn `!Send` futures from inside `tokio::spawn`, we need to do |
| /// something else. The solution is to create the `LocalSet` somewhere else, |
| /// and communicate with it using an [`mpsc`] channel. |
| /// |
| /// The following example puts the `LocalSet` inside a new thread. |
| /// ``` |
| /// use tokio::runtime::Builder; |
| /// use tokio::sync::{mpsc, oneshot}; |
| /// use tokio::task::LocalSet; |
| /// |
| /// // This struct describes the task you want to spawn. Here we include |
| /// // some simple examples. The oneshot channel allows sending a response |
| /// // to the spawner. |
| /// #[derive(Debug)] |
| /// enum Task { |
| /// PrintNumber(u32), |
| /// AddOne(u32, oneshot::Sender<u32>), |
| /// } |
| /// |
| /// #[derive(Clone)] |
| /// struct LocalSpawner { |
| /// send: mpsc::UnboundedSender<Task>, |
| /// } |
| /// |
| /// impl LocalSpawner { |
| /// pub fn new() -> Self { |
| /// let (send, mut recv) = mpsc::unbounded_channel(); |
| /// |
| /// let rt = Builder::new_current_thread() |
| /// .enable_all() |
| /// .build() |
| /// .unwrap(); |
| /// |
| /// std::thread::spawn(move || { |
| /// let local = LocalSet::new(); |
| /// |
| /// local.spawn_local(async move { |
| /// while let Some(new_task) = recv.recv().await { |
| /// tokio::task::spawn_local(run_task(new_task)); |
| /// } |
| /// // If the while loop returns, then all the LocalSpawner |
| /// // objects have been dropped. |
| /// }); |
| /// |
| /// // This will return once all senders are dropped and all |
| /// // spawned tasks have returned. |
| /// rt.block_on(local); |
| /// }); |
| /// |
| /// Self { |
| /// send, |
| /// } |
| /// } |
| /// |
| /// pub fn spawn(&self, task: Task) { |
| /// self.send.send(task).expect("Thread with LocalSet has shut down."); |
| /// } |
| /// } |
| /// |
| /// // This task may do !Send stuff. We use printing a number as an example, |
| /// // but it could be anything. |
| /// // |
| /// // The Task struct is an enum to support spawning many different kinds |
| /// // of operations. |
| /// async fn run_task(task: Task) { |
| /// match task { |
| /// Task::PrintNumber(n) => { |
| /// println!("{}", n); |
| /// }, |
| /// Task::AddOne(n, response) => { |
| /// // We ignore failures to send the response. |
| /// let _ = response.send(n + 1); |
| /// }, |
| /// } |
| /// } |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let spawner = LocalSpawner::new(); |
| /// |
| /// let (send, response) = oneshot::channel(); |
| /// spawner.spawn(Task::AddOne(10, send)); |
| /// let eleven = response.await.unwrap(); |
| /// assert_eq!(eleven, 11); |
| /// } |
| /// ``` |
| /// |
| /// [`Send`]: trait@std::marker::Send |
| /// [local task set]: struct@LocalSet |
| /// [`Runtime::block_on`]: method@crate::runtime::Runtime::block_on |
| /// [`task::spawn_local`]: fn@spawn_local |
| /// [`mpsc`]: mod@crate::sync::mpsc |
| </span><span class="kw">pub struct </span>LocalSet { |
| <span class="doccomment">/// Current scheduler tick. |
| </span>tick: Cell<u8>, |
| |
| <span class="doccomment">/// State available from thread-local. |
| </span>context: Rc<Context>, |
| |
| <span class="doccomment">/// This type should not be Send. |
| </span>_not_send: PhantomData<<span class="kw-2">*const </span>()>, |
| } |
| } |
| |
| <span class="doccomment">/// State available from the thread-local. |
| </span><span class="kw">struct </span>Context { |
| <span class="doccomment">/// State shared between threads. |
| </span>shared: Arc<Shared>, |
| |
| <span class="doccomment">/// True if a task panicked without being handled and the local set is |
| /// configured to shutdown on unhandled panic. |
| </span>unhandled_panic: Cell<bool>, |
| } |
| |
| <span class="doccomment">/// LocalSet state shared between threads. |
| </span><span class="kw">struct </span>Shared { |
| <span class="doccomment">/// # Safety |
| /// |
| /// This field must *only* be accessed from the thread that owns the |
| /// `LocalSet` (i.e., `Thread::current().id() == owner`). |
| </span>local_state: LocalState, |
| |
| <span class="doccomment">/// Remote run queue sender. |
| </span>queue: Mutex<<span class="prelude-ty">Option</span><VecDeque<task::Notified<Arc<Shared>>>>>, |
| |
| <span class="doccomment">/// Wake the `LocalSet` task. |
| </span>waker: AtomicWaker, |
| |
| <span class="doccomment">/// How to respond to unhandled task panics. |
| </span><span class="attribute">#[cfg(tokio_unstable)] |
| </span><span class="kw">pub</span>(<span class="kw">crate</span>) unhandled_panic: <span class="kw">crate</span>::runtime::UnhandledPanic, |
| } |
| |
| <span class="doccomment">/// Tracks the `LocalSet` state that must only be accessed from the thread that |
| /// created the `LocalSet`. |
| </span><span class="kw">struct </span>LocalState { |
| <span class="doccomment">/// The `ThreadId` of the thread that owns the `LocalSet`. |
| </span>owner: ThreadId, |
| |
| <span class="doccomment">/// Local run queue sender and receiver. |
| </span>local_queue: UnsafeCell<VecDeque<task::Notified<Arc<Shared>>>>, |
| |
| <span class="doccomment">/// Collection of all active tasks spawned onto this executor. |
| </span>owned: LocalOwnedTasks<Arc<Shared>>, |
| } |
| |
| <span class="macro">pin_project! </span>{ |
| <span class="attribute">#[derive(Debug)] |
| </span><span class="kw">struct </span>RunUntil<<span class="lifetime">'a</span>, F> { |
| local_set: <span class="kw-2">&</span><span class="lifetime">'a </span>LocalSet, |
| <span class="attribute">#[pin] |
| </span>future: F, |
| } |
| } |
| |
| <span class="macro">tokio_thread_local!</span>(<span class="kw">static </span>CURRENT: LocalData = <span class="kw">const </span>{ LocalData { |
| ctx: RcCell::new(), |
| } }); |
| |
| <span class="kw">struct </span>LocalData { |
| ctx: RcCell<Context>, |
| } |
| |
| <span class="macro">cfg_rt! </span>{ |
| <span class="doccomment">/// Spawns a `!Send` future on the current [`LocalSet`]. |
| /// |
| /// The spawned future will run on the same thread that called `spawn_local`. |
| /// |
| /// The provided future will start running in the background immediately |
| /// when `spawn_local` is called, even if you don't await the returned |
| /// `JoinHandle`. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if called outside of a [`LocalSet`]. |
| /// |
| /// Note that if [`tokio::spawn`] is used from within a `LocalSet`, the |
| /// resulting new task will _not_ be inside the `LocalSet`, so you must use |
| /// use `spawn_local` if you want to stay within the `LocalSet`. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// use std::rc::Rc; |
| /// use tokio::task; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let nonsend_data = Rc::new("my nonsend data..."); |
| /// |
| /// let local = task::LocalSet::new(); |
| /// |
| /// // Run the local task set. |
| /// local.run_until(async move { |
| /// let nonsend_data = nonsend_data.clone(); |
| /// task::spawn_local(async move { |
| /// println!("{}", nonsend_data); |
| /// // ... |
| /// }).await.unwrap(); |
| /// }).await; |
| /// } |
| /// ``` |
| /// |
| /// [`LocalSet`]: struct@crate::task::LocalSet |
| /// [`tokio::spawn`]: fn@crate::task::spawn |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_local<F>(future: F) -> JoinHandle<F::Output> |
| <span class="kw">where |
| </span>F: Future + <span class="lifetime">'static</span>, |
| F::Output: <span class="lifetime">'static</span>, |
| { |
| spawn_local_inner(future, <span class="prelude-val">None</span>) |
| } |
| |
| |
| <span class="attribute">#[track_caller] |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>spawn_local_inner<F>(future: F, name: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> JoinHandle<F::Output> |
| <span class="kw">where </span>F: Future + <span class="lifetime">'static</span>, |
| F::Output: <span class="lifetime">'static |
| </span>{ |
| <span class="kw">match </span>CURRENT.with(|LocalData { ctx, .. }| ctx.get()) { |
| <span class="prelude-val">None </span>=> <span class="macro">panic!</span>(<span class="string">"`spawn_local` called from outside of a `task::LocalSet`"</span>), |
| <span class="prelude-val">Some</span>(cx) => cx.spawn(future, name) |
| } |
| } |
| } |
| |
| <span class="doccomment">/// Initial queue capacity. |
| </span><span class="kw">const </span>INITIAL_CAPACITY: usize = <span class="number">64</span>; |
| |
| <span class="doccomment">/// Max number of tasks to poll per tick. |
| </span><span class="kw">const </span>MAX_TASKS_PER_TICK: usize = <span class="number">61</span>; |
| |
| <span class="doccomment">/// How often it check the remote queue first. |
| </span><span class="kw">const </span>REMOTE_FIRST_INTERVAL: u8 = <span class="number">31</span>; |
| |
| <span class="doccomment">/// Context guard for LocalSet |
| </span><span class="kw">pub struct </span>LocalEnterGuard(<span class="prelude-ty">Option</span><Rc<Context>>); |
| |
| <span class="kw">impl </span>Drop <span class="kw">for </span>LocalEnterGuard { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| CURRENT.with(|LocalData { ctx, .. }| { |
| ctx.set(<span class="self">self</span>.<span class="number">0</span>.take()); |
| }) |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>LocalEnterGuard { |
| <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">"LocalEnterGuard"</span>).finish() |
| } |
| } |
| |
| <span class="kw">impl </span>LocalSet { |
| <span class="doccomment">/// Returns a new local task set. |
| </span><span class="kw">pub fn </span>new() -> LocalSet { |
| <span class="kw">let </span>owner = context::thread_id().expect(<span class="string">"cannot create LocalSet during thread shutdown"</span>); |
| |
| LocalSet { |
| tick: Cell::new(<span class="number">0</span>), |
| context: Rc::new(Context { |
| shared: Arc::new(Shared { |
| local_state: LocalState { |
| owner, |
| owned: LocalOwnedTasks::new(), |
| local_queue: UnsafeCell::new(VecDeque::with_capacity(INITIAL_CAPACITY)), |
| }, |
| queue: Mutex::new(<span class="prelude-val">Some</span>(VecDeque::with_capacity(INITIAL_CAPACITY))), |
| waker: AtomicWaker::new(), |
| <span class="attribute">#[cfg(tokio_unstable)] |
| </span>unhandled_panic: <span class="kw">crate</span>::runtime::UnhandledPanic::Ignore, |
| }), |
| unhandled_panic: Cell::new(<span class="bool-val">false</span>), |
| }), |
| _not_send: PhantomData, |
| } |
| } |
| |
| <span class="doccomment">/// Enters the context of this `LocalSet`. |
| /// |
| /// The [`spawn_local`] method will spawn tasks on the `LocalSet` whose |
| /// context you are inside. |
| /// |
| /// [`spawn_local`]: fn@crate::task::spawn_local |
| </span><span class="kw">pub fn </span>enter(<span class="kw-2">&</span><span class="self">self</span>) -> LocalEnterGuard { |
| CURRENT.with(|LocalData { ctx, .. }| { |
| <span class="kw">let </span>old = ctx.replace(<span class="prelude-val">Some</span>(<span class="self">self</span>.context.clone())); |
| LocalEnterGuard(old) |
| }) |
| } |
| |
| <span class="doccomment">/// Spawns a `!Send` task onto the local task set. |
| /// |
| /// This task is guaranteed to be run on the current thread. |
| /// |
| /// Unlike the free function [`spawn_local`], this method may be used to |
| /// spawn local tasks when the `LocalSet` is _not_ running. The provided |
| /// future will start running once the `LocalSet` is next started, even if |
| /// you don't await the returned `JoinHandle`. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// use tokio::task; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// let local = task::LocalSet::new(); |
| /// |
| /// // Spawn a future on the local set. This future will be run when |
| /// // we call `run_until` to drive the task set. |
| /// local.spawn_local(async { |
| /// // ... |
| /// }); |
| /// |
| /// // Run the local task set. |
| /// local.run_until(async move { |
| /// // ... |
| /// }).await; |
| /// |
| /// // When `run` finishes, we can spawn _more_ futures, which will |
| /// // run in subsequent calls to `run_until`. |
| /// local.spawn_local(async { |
| /// // ... |
| /// }); |
| /// |
| /// local.run_until(async move { |
| /// // ... |
| /// }).await; |
| /// } |
| /// ``` |
| /// [`spawn_local`]: fn@spawn_local |
| </span><span class="attribute">#[track_caller] |
| </span><span class="kw">pub fn </span>spawn_local<F>(<span class="kw-2">&</span><span class="self">self</span>, future: F) -> JoinHandle<F::Output> |
| <span class="kw">where |
| </span>F: Future + <span class="lifetime">'static</span>, |
| F::Output: <span class="lifetime">'static</span>, |
| { |
| <span class="self">self</span>.spawn_named(future, <span class="prelude-val">None</span>) |
| } |
| |
| <span class="doccomment">/// Runs a future to completion on the provided runtime, driving any local |
| /// futures spawned on this task set on the current thread. |
| /// |
| /// This runs the given future on the runtime, blocking until it is |
| /// complete, and yielding its resolved result. Any tasks or timers which |
| /// the future spawns internally will be executed on the runtime. The future |
| /// may also call [`spawn_local`] to spawn_local additional local futures on the |
| /// current thread. |
| /// |
| /// This method should not be called from an asynchronous context. |
| /// |
| /// # Panics |
| /// |
| /// This function panics if the executor is at capacity, if the provided |
| /// future panics, or if called within an asynchronous execution context. |
| /// |
| /// # Notes |
| /// |
| /// Since this function internally calls [`Runtime::block_on`], and drives |
| /// futures in the local task set inside that call to `block_on`, the local |
| /// futures may not use [in-place blocking]. If a blocking call needs to be |
| /// issued from a local task, the [`spawn_blocking`] API may be used instead. |
| /// |
| /// For example, this will panic: |
| /// ```should_panic |
| /// use tokio::runtime::Runtime; |
| /// use tokio::task; |
| /// |
| /// let rt = Runtime::new().unwrap(); |
| /// let local = task::LocalSet::new(); |
| /// local.block_on(&rt, async { |
| /// let join = task::spawn_local(async { |
| /// let blocking_result = task::block_in_place(|| { |
| /// // ... |
| /// }); |
| /// // ... |
| /// }); |
| /// join.await.unwrap(); |
| /// }) |
| /// ``` |
| /// This, however, will not panic: |
| /// ``` |
| /// use tokio::runtime::Runtime; |
| /// use tokio::task; |
| /// |
| /// let rt = Runtime::new().unwrap(); |
| /// let local = task::LocalSet::new(); |
| /// local.block_on(&rt, async { |
| /// let join = task::spawn_local(async { |
| /// let blocking_result = task::spawn_blocking(|| { |
| /// // ... |
| /// }).await; |
| /// // ... |
| /// }); |
| /// join.await.unwrap(); |
| /// }) |
| /// ``` |
| /// |
| /// [`spawn_local`]: fn@spawn_local |
| /// [`Runtime::block_on`]: method@crate::runtime::Runtime::block_on |
| /// [in-place blocking]: fn@crate::task::block_in_place |
| /// [`spawn_blocking`]: fn@crate::task::spawn_blocking |
| </span><span class="attribute">#[track_caller] |
| #[cfg(feature = <span class="string">"rt"</span>)] |
| #[cfg_attr(docsrs, doc(cfg(feature = <span class="string">"rt"</span>)))] |
| </span><span class="kw">pub fn </span>block_on<F>(<span class="kw-2">&</span><span class="self">self</span>, rt: <span class="kw-2">&</span><span class="kw">crate</span>::runtime::Runtime, future: F) -> F::Output |
| <span class="kw">where |
| </span>F: Future, |
| { |
| rt.block_on(<span class="self">self</span>.run_until(future)) |
| } |
| |
| <span class="doccomment">/// Runs a future to completion on the local set, returning its output. |
| /// |
| /// This returns a future that runs the given future with a local set, |
| /// allowing it to call [`spawn_local`] to spawn additional `!Send` futures. |
| /// Any local futures spawned on the local set will be driven in the |
| /// background until the future passed to `run_until` completes. When the future |
| /// passed to `run` finishes, any local futures which have not completed |
| /// will remain on the local set, and will be driven on subsequent calls to |
| /// `run_until` or when [awaiting the local set] itself. |
| /// |
| /// # Examples |
| /// |
| /// ```rust |
| /// use tokio::task; |
| /// |
| /// #[tokio::main] |
| /// async fn main() { |
| /// task::LocalSet::new().run_until(async { |
| /// task::spawn_local(async move { |
| /// // ... |
| /// }).await.unwrap(); |
| /// // ... |
| /// }).await; |
| /// } |
| /// ``` |
| /// |
| /// [`spawn_local`]: fn@spawn_local |
| /// [awaiting the local set]: #awaiting-a-localset |
| </span><span class="kw">pub async fn </span>run_until<F>(<span class="kw-2">&</span><span class="self">self</span>, future: F) -> F::Output |
| <span class="kw">where |
| </span>F: Future, |
| { |
| <span class="kw">let </span>run_until = RunUntil { |
| future, |
| local_set: <span class="self">self</span>, |
| }; |
| run_until.<span class="kw">await |
| </span>} |
| |
| <span class="kw">pub</span>(<span class="kw">in </span><span class="kw">crate</span>::task) <span class="kw">fn </span>spawn_named<F>( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| future: F, |
| name: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| ) -> JoinHandle<F::Output> |
| <span class="kw">where |
| </span>F: Future + <span class="lifetime">'static</span>, |
| F::Output: <span class="lifetime">'static</span>, |
| { |
| <span class="kw">let </span>handle = <span class="self">self</span>.context.spawn(future, name); |
| |
| <span class="comment">// Because a task was spawned from *outside* the `LocalSet`, wake the |
| // `LocalSet` future to execute the new task, if it hasn't been woken. |
| // |
| // Spawning via the free fn `spawn` does not require this, as it can |
| // only be called from *within* a future executing on the `LocalSet` — |
| // in that case, the `LocalSet` must already be awake. |
| </span><span class="self">self</span>.context.shared.waker.wake(); |
| handle |
| } |
| |
| <span class="doccomment">/// Ticks the scheduler, returning whether the local future needs to be |
| /// notified again. |
| </span><span class="kw">fn </span>tick(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="kw">for _ in </span><span class="number">0</span>..MAX_TASKS_PER_TICK { |
| <span class="comment">// Make sure we didn't hit an unhandled panic |
| </span><span class="kw">if </span><span class="self">self</span>.context.unhandled_panic.get() { |
| <span class="macro">panic!</span>(<span class="string">"a spawned task panicked and the LocalSet is configured to shutdown on unhandled panic"</span>); |
| } |
| |
| <span class="kw">match </span><span class="self">self</span>.next_task() { |
| <span class="comment">// Run the task |
| // |
| // Safety: As spawned tasks are `!Send`, `run_unchecked` must be |
| // used. We are responsible for maintaining the invariant that |
| // `run_unchecked` is only called on threads that spawned the |
| // task initially. Because `LocalSet` itself is `!Send`, and |
| // `spawn_local` spawns into the `LocalSet` on the current |
| // thread, the invariant is maintained. |
| </span><span class="prelude-val">Some</span>(task) => <span class="kw">crate</span>::runtime::coop::budget(|| task.run()), |
| <span class="comment">// We have fully drained the queue of notified tasks, so the |
| // local future doesn't need to be notified again — it can wait |
| // until something else wakes a task in the local set. |
| </span><span class="prelude-val">None </span>=> <span class="kw">return </span><span class="bool-val">false</span>, |
| } |
| } |
| |
| <span class="bool-val">true |
| </span>} |
| |
| <span class="kw">fn </span>next_task(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><task::LocalNotified<Arc<Shared>>> { |
| <span class="kw">let </span>tick = <span class="self">self</span>.tick.get(); |
| <span class="self">self</span>.tick.set(tick.wrapping_add(<span class="number">1</span>)); |
| |
| <span class="kw">let </span>task = <span class="kw">if </span>tick % REMOTE_FIRST_INTERVAL == <span class="number">0 </span>{ |
| <span class="self">self</span>.context |
| .shared |
| .queue |
| .lock() |
| .as_mut() |
| .and_then(|queue| queue.pop_front()) |
| .or_else(|| <span class="self">self</span>.pop_local()) |
| } <span class="kw">else </span>{ |
| <span class="self">self</span>.pop_local().or_else(|| { |
| <span class="self">self</span>.context |
| .shared |
| .queue |
| .lock() |
| .as_mut() |
| .and_then(|queue| queue.pop_front()) |
| }) |
| }; |
| |
| task.map(|task| <span class="kw">unsafe </span>{ |
| <span class="comment">// Safety: because the `LocalSet` itself is `!Send`, we know we are |
| // on the same thread if we have access to the `LocalSet`, and can |
| // therefore access the local run queue. |
| </span><span class="self">self</span>.context.shared.local_state.assert_owner(task) |
| }) |
| } |
| |
| <span class="kw">fn </span>pop_local(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><task::Notified<Arc<Shared>>> { |
| <span class="kw">unsafe </span>{ |
| <span class="comment">// Safety: because the `LocalSet` itself is `!Send`, we know we are |
| // on the same thread if we have access to the `LocalSet`, and can |
| // therefore access the local run queue. |
| </span><span class="self">self</span>.context.shared.local_state.task_pop_front() |
| } |
| } |
| |
| <span class="kw">fn </span>with<T>(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw">impl </span>FnOnce() -> T) -> T { |
| CURRENT.with(|LocalData { ctx, .. }| { |
| <span class="kw">struct </span>Reset<<span class="lifetime">'a</span>> { |
| ctx_ref: <span class="kw-2">&</span><span class="lifetime">'a </span>RcCell<Context>, |
| val: <span class="prelude-ty">Option</span><Rc<Context>>, |
| } |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Drop <span class="kw">for </span>Reset<<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>.ctx_ref.set(<span class="self">self</span>.val.take()); |
| } |
| } |
| <span class="kw">let </span>old = ctx.replace(<span class="prelude-val">Some</span>(<span class="self">self</span>.context.clone())); |
| |
| <span class="kw">let </span>_reset = Reset { |
| ctx_ref: ctx, |
| val: old, |
| }; |
| |
| f() |
| }) |
| } |
| |
| <span class="doccomment">/// This method is like `with`, but it just calls `f` without setting the thread-local if that |
| /// fails. |
| </span><span class="kw">fn </span>with_if_possible<T>(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw">impl </span>FnOnce() -> T) -> T { |
| <span class="kw">let </span><span class="kw-2">mut </span>f = <span class="prelude-val">Some</span>(f); |
| |
| <span class="kw">let </span>res = CURRENT.try_with(|LocalData { ctx, .. }| { |
| <span class="kw">struct </span>Reset<<span class="lifetime">'a</span>> { |
| ctx_ref: <span class="kw-2">&</span><span class="lifetime">'a </span>RcCell<Context>, |
| val: <span class="prelude-ty">Option</span><Rc<Context>>, |
| } |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> Drop <span class="kw">for </span>Reset<<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>.ctx_ref.replace(<span class="self">self</span>.val.take()); |
| } |
| } |
| <span class="kw">let </span>old = ctx.replace(<span class="prelude-val">Some</span>(<span class="self">self</span>.context.clone())); |
| |
| <span class="kw">let </span>_reset = Reset { |
| ctx_ref: ctx, |
| val: old, |
| }; |
| |
| (f.take().unwrap())() |
| }); |
| |
| <span class="kw">match </span>res { |
| <span class="prelude-val">Ok</span>(res) => res, |
| <span class="prelude-val">Err</span>(_access_error) => (f.take().unwrap())(), |
| } |
| } |
| } |
| |
| <span class="macro">cfg_unstable! </span>{ |
| <span class="kw">impl </span>LocalSet { |
| <span class="doccomment">/// Configure how the `LocalSet` responds to an unhandled panic on a |
| /// spawned task. |
| /// |
| /// By default, an unhandled panic (i.e. a panic not caught by |
| /// [`std::panic::catch_unwind`]) has no impact on the `LocalSet`'s |
| /// execution. The panic is error value is forwarded to the task's |
| /// [`JoinHandle`] and all other spawned tasks continue running. |
| /// |
| /// The `unhandled_panic` option enables configuring this behavior. |
| /// |
| /// * `UnhandledPanic::Ignore` is the default behavior. Panics on |
| /// spawned tasks have no impact on the `LocalSet`'s execution. |
| /// * `UnhandledPanic::ShutdownRuntime` will force the `LocalSet` to |
| /// shutdown immediately when a spawned task panics even if that |
| /// task's `JoinHandle` has not been dropped. All other spawned tasks |
| /// will immediately terminate and further calls to |
| /// [`LocalSet::block_on`] and [`LocalSet::run_until`] will panic. |
| /// |
| /// # Panics |
| /// |
| /// This method panics if called after the `LocalSet` has started |
| /// running. |
| /// |
| /// # Unstable |
| /// |
| /// This option is currently unstable and its implementation is |
| /// incomplete. The API may change or be removed in the future. See |
| /// tokio-rs/tokio#4516 for more details. |
| /// |
| /// # Examples |
| /// |
| /// The following demonstrates a `LocalSet` configured to shutdown on |
| /// panic. The first spawned task panics and results in the `LocalSet` |
| /// shutting down. The second spawned task never has a chance to |
| /// execute. The call to `run_until` will panic due to the runtime being |
| /// forcibly shutdown. |
| /// |
| /// ```should_panic |
| /// use tokio::runtime::UnhandledPanic; |
| /// |
| /// # #[tokio::main] |
| /// # async fn main() { |
| /// tokio::task::LocalSet::new() |
| /// .unhandled_panic(UnhandledPanic::ShutdownRuntime) |
| /// .run_until(async { |
| /// tokio::task::spawn_local(async { panic!("boom"); }); |
| /// tokio::task::spawn_local(async { |
| /// // This task never completes |
| /// }); |
| /// |
| /// // Do some work, but `run_until` will panic before it completes |
| /// # loop { tokio::task::yield_now().await; } |
| /// }) |
| /// .await; |
| /// # } |
| /// ``` |
| /// |
| /// [`JoinHandle`]: struct@crate::task::JoinHandle |
| </span><span class="kw">pub fn </span>unhandled_panic(<span class="kw-2">&mut </span><span class="self">self</span>, behavior: <span class="kw">crate</span>::runtime::UnhandledPanic) -> <span class="kw-2">&mut </span><span class="self">Self </span>{ |
| <span class="comment">// TODO: This should be set as a builder |
| </span>Rc::get_mut(<span class="kw-2">&mut </span><span class="self">self</span>.context) |
| .and_then(|ctx| Arc::get_mut(<span class="kw-2">&mut </span>ctx.shared)) |
| .expect(<span class="string">"Unhandled Panic behavior modified after starting LocalSet"</span>) |
| .unhandled_panic = behavior; |
| <span class="self">self |
| </span>} |
| } |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>LocalSet { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| fmt.debug_struct(<span class="string">"LocalSet"</span>).finish() |
| } |
| } |
| |
| <span class="kw">impl </span>Future <span class="kw">for </span>LocalSet { |
| <span class="kw">type </span>Output = (); |
| |
| <span class="kw">fn </span>poll(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>std::task::Context<<span class="lifetime">'_</span>>) -> Poll<<span class="self">Self</span>::Output> { |
| <span class="comment">// Register the waker before starting to work |
| </span><span class="self">self</span>.context.shared.waker.register_by_ref(cx.waker()); |
| |
| <span class="kw">if </span><span class="self">self</span>.with(|| <span class="self">self</span>.tick()) { |
| <span class="comment">// If `tick` returns true, we need to notify the local future again: |
| // there are still tasks remaining in the run queue. |
| </span>cx.waker().wake_by_ref(); |
| Poll::Pending |
| |
| <span class="comment">// Safety: called from the thread that owns `LocalSet`. Because |
| // `LocalSet` is `!Send`, this is safe. |
| </span>} <span class="kw">else if unsafe </span>{ <span class="self">self</span>.context.shared.local_state.owned_is_empty() } { |
| <span class="comment">// If the scheduler has no remaining futures, we're done! |
| </span>Poll::Ready(()) |
| } <span class="kw">else </span>{ |
| <span class="comment">// There are still futures in the local set, but we've polled all the |
| // futures in the run queue. Therefore, we can just return Pending |
| // since the remaining futures will be woken from somewhere else. |
| </span>Poll::Pending |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>Default <span class="kw">for </span>LocalSet { |
| <span class="kw">fn </span>default() -> LocalSet { |
| LocalSet::new() |
| } |
| } |
| |
| <span class="kw">impl </span>Drop <span class="kw">for </span>LocalSet { |
| <span class="kw">fn </span>drop(<span class="kw-2">&mut </span><span class="self">self</span>) { |
| <span class="self">self</span>.with_if_possible(|| { |
| <span class="comment">// Shut down all tasks in the LocalOwnedTasks and close it to |
| // prevent new tasks from ever being added. |
| </span><span class="kw">unsafe </span>{ |
| <span class="comment">// Safety: called from the thread that owns `LocalSet` |
| </span><span class="self">self</span>.context.shared.local_state.close_and_shutdown_all(); |
| } |
| |
| <span class="comment">// We already called shutdown on all tasks above, so there is no |
| // need to call shutdown. |
| |
| // Safety: note that this *intentionally* bypasses the unsafe |
| // `Shared::local_queue()` method. This is in order to avoid the |
| // debug assertion that we are on the thread that owns the |
| // `LocalSet`, because on some systems (e.g. at least some macOS |
| // versions), attempting to get the current thread ID can panic due |
| // to the thread's local data that stores the thread ID being |
| // dropped *before* the `LocalSet`. |
| // |
| // Despite avoiding the assertion here, it is safe for us to access |
| // the local queue in `Drop`, because the `LocalSet` itself is |
| // `!Send`, so we can reasonably guarantee that it will not be |
| // `Drop`ped from another thread. |
| </span><span class="kw">let </span>local_queue = <span class="kw">unsafe </span>{ |
| <span class="comment">// Safety: called from the thread that owns `LocalSet` |
| </span><span class="self">self</span>.context.shared.local_state.take_local_queue() |
| }; |
| <span class="kw">for </span>task <span class="kw">in </span>local_queue { |
| drop(task); |
| } |
| |
| <span class="comment">// Take the queue from the Shared object to prevent pushing |
| // notifications to it in the future. |
| </span><span class="kw">let </span>queue = <span class="self">self</span>.context.shared.queue.lock().take().unwrap(); |
| <span class="kw">for </span>task <span class="kw">in </span>queue { |
| drop(task); |
| } |
| |
| <span class="comment">// Safety: called from the thread that owns `LocalSet` |
| </span><span class="macro">assert!</span>(<span class="kw">unsafe </span>{ <span class="self">self</span>.context.shared.local_state.owned_is_empty() }); |
| }); |
| } |
| } |
| |
| <span class="comment">// === impl Context === |
| |
| </span><span class="kw">impl </span>Context { |
| <span class="attribute">#[track_caller] |
| </span><span class="kw">fn </span>spawn<F>(<span class="kw-2">&</span><span class="self">self</span>, future: F, name: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>) -> JoinHandle<F::Output> |
| <span class="kw">where |
| </span>F: Future + <span class="lifetime">'static</span>, |
| F::Output: <span class="lifetime">'static</span>, |
| { |
| <span class="kw">let </span>id = <span class="kw">crate</span>::runtime::task::Id::next(); |
| <span class="kw">let </span>future = <span class="kw">crate</span>::util::trace::task(future, <span class="string">"local"</span>, name, id.as_u64()); |
| |
| <span class="comment">// Safety: called from the thread that owns the `LocalSet` |
| </span><span class="kw">let </span>(handle, notified) = { |
| <span class="self">self</span>.shared.local_state.assert_called_from_owner_thread(); |
| <span class="self">self</span>.shared |
| .local_state |
| .owned |
| .bind(future, <span class="self">self</span>.shared.clone(), id) |
| }; |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(notified) = notified { |
| <span class="self">self</span>.shared.schedule(notified); |
| } |
| |
| handle |
| } |
| } |
| |
| <span class="comment">// === impl LocalFuture === |
| |
| </span><span class="kw">impl</span><T: Future> Future <span class="kw">for </span>RunUntil<<span class="lifetime">'_</span>, T> { |
| <span class="kw">type </span>Output = T::Output; |
| |
| <span class="kw">fn </span>poll(<span class="self">self</span>: Pin<<span class="kw-2">&mut </span><span class="self">Self</span>>, cx: <span class="kw-2">&mut </span>std::task::Context<<span class="lifetime">'_</span>>) -> Poll<<span class="self">Self</span>::Output> { |
| <span class="kw">let </span>me = <span class="self">self</span>.project(); |
| |
| me.local_set.with(|| { |
| me.local_set |
| .context |
| .shared |
| .waker |
| .register_by_ref(cx.waker()); |
| |
| <span class="kw">let </span>_no_blocking = <span class="kw">crate</span>::runtime::context::disallow_block_in_place(); |
| <span class="kw">let </span>f = me.future; |
| |
| <span class="kw">if let </span>Poll::Ready(output) = f.poll(cx) { |
| <span class="kw">return </span>Poll::Ready(output); |
| } |
| |
| <span class="kw">if </span>me.local_set.tick() { |
| <span class="comment">// If `tick` returns `true`, we need to notify the local future again: |
| // there are still tasks remaining in the run queue. |
| </span>cx.waker().wake_by_ref(); |
| } |
| |
| Poll::Pending |
| }) |
| } |
| } |
| |
| <span class="kw">impl </span>Shared { |
| <span class="doccomment">/// Schedule the provided task on the scheduler. |
| </span><span class="kw">fn </span>schedule(<span class="kw-2">&</span><span class="self">self</span>, task: task::Notified<Arc<<span class="self">Self</span>>>) { |
| CURRENT.with(|localdata| { |
| <span class="kw">match </span>localdata.ctx.get() { |
| <span class="prelude-val">Some</span>(cx) <span class="kw">if </span>cx.shared.ptr_eq(<span class="self">self</span>) => <span class="kw">unsafe </span>{ |
| <span class="comment">// Safety: if the current `LocalSet` context points to this |
| // `LocalSet`, then we are on the thread that owns it. |
| </span>cx.shared.local_state.task_push_back(task); |
| }, |
| |
| <span class="comment">// We are on the thread that owns the `LocalSet`, so we can |
| // wake to the local queue. |
| </span><span class="kw">_ if </span>context::thread_id().ok() == <span class="prelude-val">Some</span>(<span class="self">self</span>.local_state.owner) => { |
| <span class="kw">unsafe </span>{ |
| <span class="comment">// Safety: we just checked that the thread ID matches |
| // the localset's owner, so this is safe. |
| </span><span class="self">self</span>.local_state.task_push_back(task); |
| } |
| <span class="comment">// We still have to wake the `LocalSet`, because it isn't |
| // currently being polled. |
| </span><span class="self">self</span>.waker.wake(); |
| } |
| |
| <span class="comment">// We are *not* on the thread that owns the `LocalSet`, so we |
| // have to wake to the remote queue. |
| </span><span class="kw">_ </span>=> { |
| <span class="comment">// First, check whether the queue is still there (if not, the |
| // LocalSet is dropped). Then push to it if so, and if not, |
| // do nothing. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>lock = <span class="self">self</span>.queue.lock(); |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(queue) = lock.as_mut() { |
| queue.push_back(task); |
| drop(lock); |
| <span class="self">self</span>.waker.wake(); |
| } |
| } |
| } |
| }); |
| } |
| |
| <span class="kw">fn </span>ptr_eq(<span class="kw-2">&</span><span class="self">self</span>, other: <span class="kw-2">&</span>Shared) -> bool { |
| std::ptr::eq(<span class="self">self</span>, other) |
| } |
| } |
| |
| <span class="comment">// This is safe because (and only because) we *pinky pwomise* to never touch the |
| // local run queue except from the thread that owns the `LocalSet`. |
| </span><span class="kw">unsafe impl </span>Sync <span class="kw">for </span>Shared {} |
| |
| <span class="kw">impl </span>task::Schedule <span class="kw">for </span>Arc<Shared> { |
| <span class="kw">fn </span>release(<span class="kw-2">&</span><span class="self">self</span>, task: <span class="kw-2">&</span>Task<<span class="self">Self</span>>) -> <span class="prelude-ty">Option</span><Task<<span class="self">Self</span>>> { |
| <span class="comment">// Safety, this is always called from the thread that owns `LocalSet` |
| </span><span class="kw">unsafe </span>{ <span class="self">self</span>.local_state.task_remove(task) } |
| } |
| |
| <span class="kw">fn </span>schedule(<span class="kw-2">&</span><span class="self">self</span>, task: task::Notified<<span class="self">Self</span>>) { |
| Shared::schedule(<span class="self">self</span>, task); |
| } |
| |
| <span class="macro">cfg_unstable! </span>{ |
| <span class="kw">fn </span>unhandled_panic(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="kw">use </span><span class="kw">crate</span>::runtime::UnhandledPanic; |
| |
| <span class="kw">match </span><span class="self">self</span>.unhandled_panic { |
| UnhandledPanic::Ignore => { |
| <span class="comment">// Do nothing |
| </span>} |
| UnhandledPanic::ShutdownRuntime => { |
| <span class="comment">// This hook is only called from within the runtime, so |
| // `CURRENT` should match with `&self`, i.e. there is no |
| // opportunity for a nested scheduler to be called. |
| </span>CURRENT.with(|LocalData { ctx, .. }| <span class="kw">match </span>ctx.get() { |
| <span class="prelude-val">Some</span>(cx) <span class="kw">if </span>Arc::ptr_eq(<span class="self">self</span>, <span class="kw-2">&</span>cx.shared) => { |
| cx.unhandled_panic.set(<span class="bool-val">true</span>); |
| <span class="comment">// Safety: this is always called from the thread that owns `LocalSet` |
| </span><span class="kw">unsafe </span>{ cx.shared.local_state.close_and_shutdown_all(); } |
| } |
| <span class="kw">_ </span>=> <span class="macro">unreachable!</span>(<span class="string">"runtime core not set in CURRENT thread-local"</span>), |
| }) |
| } |
| } |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>LocalState { |
| <span class="kw">unsafe fn </span>task_pop_front(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><task::Notified<Arc<Shared>>> { |
| <span class="comment">// The caller ensures it is called from the same thread that owns |
| // the LocalSet. |
| </span><span class="self">self</span>.assert_called_from_owner_thread(); |
| |
| <span class="self">self</span>.local_queue.with_mut(|ptr| (<span class="kw-2">*</span>ptr).pop_front()) |
| } |
| |
| <span class="kw">unsafe fn </span>task_push_back(<span class="kw-2">&</span><span class="self">self</span>, task: task::Notified<Arc<Shared>>) { |
| <span class="comment">// The caller ensures it is called from the same thread that owns |
| // the LocalSet. |
| </span><span class="self">self</span>.assert_called_from_owner_thread(); |
| |
| <span class="self">self</span>.local_queue.with_mut(|ptr| (<span class="kw-2">*</span>ptr).push_back(task)) |
| } |
| |
| <span class="kw">unsafe fn </span>take_local_queue(<span class="kw-2">&</span><span class="self">self</span>) -> VecDeque<task::Notified<Arc<Shared>>> { |
| <span class="comment">// The caller ensures it is called from the same thread that owns |
| // the LocalSet. |
| </span><span class="self">self</span>.assert_called_from_owner_thread(); |
| |
| <span class="self">self</span>.local_queue.with_mut(|ptr| std::mem::take(<span class="kw-2">&mut </span>(<span class="kw-2">*</span>ptr))) |
| } |
| |
| <span class="kw">unsafe fn </span>task_remove(<span class="kw-2">&</span><span class="self">self</span>, task: <span class="kw-2">&</span>Task<Arc<Shared>>) -> <span class="prelude-ty">Option</span><Task<Arc<Shared>>> { |
| <span class="comment">// The caller ensures it is called from the same thread that owns |
| // the LocalSet. |
| </span><span class="self">self</span>.assert_called_from_owner_thread(); |
| |
| <span class="self">self</span>.owned.remove(task) |
| } |
| |
| <span class="doccomment">/// Returns true if the `LocalSet` does not have any spawned tasks |
| </span><span class="kw">unsafe fn </span>owned_is_empty(<span class="kw-2">&</span><span class="self">self</span>) -> bool { |
| <span class="comment">// The caller ensures it is called from the same thread that owns |
| // the LocalSet. |
| </span><span class="self">self</span>.assert_called_from_owner_thread(); |
| |
| <span class="self">self</span>.owned.is_empty() |
| } |
| |
| <span class="kw">unsafe fn </span>assert_owner( |
| <span class="kw-2">&</span><span class="self">self</span>, |
| task: task::Notified<Arc<Shared>>, |
| ) -> task::LocalNotified<Arc<Shared>> { |
| <span class="comment">// The caller ensures it is called from the same thread that owns |
| // the LocalSet. |
| </span><span class="self">self</span>.assert_called_from_owner_thread(); |
| |
| <span class="self">self</span>.owned.assert_owner(task) |
| } |
| |
| <span class="kw">unsafe fn </span>close_and_shutdown_all(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="comment">// The caller ensures it is called from the same thread that owns |
| // the LocalSet. |
| </span><span class="self">self</span>.assert_called_from_owner_thread(); |
| |
| <span class="self">self</span>.owned.close_and_shutdown_all() |
| } |
| |
| <span class="attribute">#[track_caller] |
| </span><span class="kw">fn </span>assert_called_from_owner_thread(<span class="kw-2">&</span><span class="self">self</span>) { |
| <span class="comment">// FreeBSD has some weirdness around thread-local destruction. |
| // TODO: remove this hack when thread id is cleaned up |
| </span><span class="attribute">#[cfg(not(any(target_os = <span class="string">"openbsd"</span>, target_os = <span class="string">"freebsd"</span>)))] |
| </span><span class="macro">debug_assert!</span>( |
| <span class="comment">// if we couldn't get the thread ID because we're dropping the local |
| // data, skip the assertion --- the `Drop` impl is not going to be |
| // called from another thread, because `LocalSet` is `!Send` |
| </span>context::thread_id() |
| .map(|id| id == <span class="self">self</span>.owner) |
| .unwrap_or(<span class="bool-val">true</span>), |
| <span class="string">"`LocalSet`'s local run queue must not be accessed by another thread!" |
| </span>); |
| } |
| } |
| |
| <span class="comment">// This is `Send` because it is stored in `Shared`. It is up to the caller to |
| // ensure they are on the same thread that owns the `LocalSet`. |
| </span><span class="kw">unsafe impl </span>Send <span class="kw">for </span>LocalState {} |
| |
| <span class="attribute">#[cfg(all(test, not(loom)))] |
| </span><span class="kw">mod </span>tests { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| |
| <span class="comment">// Does a `LocalSet` running on a current-thread runtime...basically work? |
| // |
| // This duplicates a test in `tests/task_local_set.rs`, but because this is |
| // a lib test, it wil run under Miri, so this is necessary to catch stacked |
| // borrows violations in the `LocalSet` implementation. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>local_current_thread_scheduler() { |
| <span class="kw">let </span>f = <span class="kw">async </span>{ |
| LocalSet::new() |
| .run_until(<span class="kw">async </span>{ |
| spawn_local(<span class="kw">async </span>{}).<span class="kw">await</span>.unwrap(); |
| }) |
| .<span class="kw">await</span>; |
| }; |
| <span class="kw">crate</span>::runtime::Builder::new_current_thread() |
| .build() |
| .expect(<span class="string">"rt"</span>) |
| .block_on(f) |
| } |
| |
| <span class="comment">// Tests that when a task on a `LocalSet` is woken by an io driver on the |
| // same thread, the task is woken to the localset's local queue rather than |
| // its remote queue. |
| // |
| // This test has to be defined in the `local.rs` file as a lib test, rather |
| // than in `tests/`, because it makes assertions about the local set's |
| // internal state. |
| </span><span class="attribute">#[test] |
| </span><span class="kw">fn </span>wakes_to_local_queue() { |
| <span class="kw">use super</span>::<span class="kw-2">*</span>; |
| <span class="kw">use </span><span class="kw">crate</span>::sync::Notify; |
| <span class="kw">let </span>rt = <span class="kw">crate</span>::runtime::Builder::new_current_thread() |
| .build() |
| .expect(<span class="string">"rt"</span>); |
| rt.block_on(<span class="kw">async </span>{ |
| <span class="kw">let </span>local = LocalSet::new(); |
| <span class="kw">let </span>notify = Arc::new(Notify::new()); |
| <span class="kw">let </span>task = local.spawn_local({ |
| <span class="kw">let </span>notify = notify.clone(); |
| <span class="kw">async move </span>{ |
| notify.notified().<span class="kw">await</span>; |
| } |
| }); |
| <span class="kw">let </span><span class="kw-2">mut </span>run_until = Box::pin(local.run_until(<span class="kw">async move </span>{ |
| task.<span class="kw">await</span>.unwrap(); |
| })); |
| |
| <span class="comment">// poll the run until future once |
| </span><span class="kw">crate</span>::future::poll_fn(|cx| { |
| <span class="kw">let _ </span>= run_until.as_mut().poll(cx); |
| Poll::Ready(()) |
| }) |
| .<span class="kw">await</span>; |
| |
| notify.notify_one(); |
| <span class="kw">let </span>task = <span class="kw">unsafe </span>{ local.context.shared.local_state.task_pop_front() }; |
| <span class="comment">// TODO(eliza): it would be nice to be able to assert that this is |
| // the local task. |
| </span><span class="macro">assert!</span>( |
| task.is_some(), |
| <span class="string">"task should have been notified to the LocalSet's local queue" |
| </span>); |
| }) |
| } |
| } |
| </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> |