blob: 5fb0906d46d0d7a0925b42583a1df2c468e8d249 [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/rayon-3b3b152053499ede/a07ce2e/rayon-core/src/job.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>job.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../rayon_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rayon_core/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::latch::Latch;
<span class="kw">use </span><span class="kw">crate</span>::unwind;
<span class="kw">use </span>crossbeam_deque::{Injector, Steal};
<span class="kw">use </span>std::any::Any;
<span class="kw">use </span>std::cell::UnsafeCell;
<span class="kw">use </span>std::mem;
<span class="kw">use </span>std::sync::Arc;
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">enum </span>JobResult&lt;T&gt; {
<span class="prelude-val">None</span>,
<span class="prelude-val">Ok</span>(T),
Panic(Box&lt;<span class="kw">dyn </span>Any + Send&gt;),
}
<span class="doccomment">/// A `Job` is used to advertise work for other threads that they may
/// want to steal. In accordance with time honored tradition, jobs are
/// arranged in a deque, so that thieves can take from the top of the
/// deque while the main worker manages the bottom of the deque. This
/// deque is managed by the `thread_pool` module.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">trait </span>Job {
<span class="doccomment">/// Unsafe: this may be called from a different thread than the one
/// which scheduled the job, so the implementer must ensure the
/// appropriate traits are met, whether `Send`, `Sync`, or both.
</span><span class="kw">unsafe fn </span>execute(this: <span class="kw-2">*const </span>());
}
<span class="doccomment">/// Effectively a Job trait object. Each JobRef **must** be executed
/// exactly once, or else data may leak.
///
/// Internally, we store the job&#39;s data in a `*const ()` pointer. The
/// true type is something like `*const StackJob&lt;...&gt;`, but we hide
/// it. We also carry the &quot;execute fn&quot; from the `Job` trait.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>JobRef {
pointer: <span class="kw-2">*const </span>(),
execute_fn: <span class="kw">unsafe fn</span>(<span class="kw-2">*const </span>()),
}
<span class="kw">unsafe impl </span>Send <span class="kw">for </span>JobRef {}
<span class="kw">unsafe impl </span>Sync <span class="kw">for </span>JobRef {}
<span class="kw">impl </span>JobRef {
<span class="doccomment">/// Unsafe: caller asserts that `data` will remain valid until the
/// job is executed.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>new&lt;T&gt;(data: <span class="kw-2">*const </span>T) -&gt; JobRef
<span class="kw">where
</span>T: Job,
{
<span class="comment">// erase types:
</span>JobRef {
pointer: data <span class="kw">as </span><span class="kw-2">*const </span>(),
execute_fn: &lt;T <span class="kw">as </span>Job&gt;::execute,
}
}
<span class="doccomment">/// Returns an opaque handle that can be saved and compared,
/// without making `JobRef` itself `Copy + Eq`.
</span><span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>id(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw">impl </span>Eq {
(<span class="self">self</span>.pointer, <span class="self">self</span>.execute_fn)
}
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>execute(<span class="self">self</span>) {
(<span class="self">self</span>.execute_fn)(<span class="self">self</span>.pointer)
}
}
<span class="doccomment">/// A job that will be owned by a stack slot. This means that when it
/// executes it need not free any heap data, the cleanup occurs when
/// the stack frame is later popped. The function parameter indicates
/// `true` if the job was stolen -- executed on a different thread.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>StackJob&lt;L, F, R&gt;
<span class="kw">where
</span>L: Latch + Sync,
F: FnOnce(bool) -&gt; R + Send,
R: Send,
{
<span class="kw">pub</span>(<span class="kw">super</span>) latch: L,
func: UnsafeCell&lt;<span class="prelude-ty">Option</span>&lt;F&gt;&gt;,
result: UnsafeCell&lt;JobResult&lt;R&gt;&gt;,
}
<span class="kw">impl</span>&lt;L, F, R&gt; StackJob&lt;L, F, R&gt;
<span class="kw">where
</span>L: Latch + Sync,
F: FnOnce(bool) -&gt; R + Send,
R: Send,
{
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(func: F, latch: L) -&gt; StackJob&lt;L, F, R&gt; {
StackJob {
latch,
func: UnsafeCell::new(<span class="prelude-val">Some</span>(func)),
result: UnsafeCell::new(JobResult::None),
}
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>as_job_ref(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; JobRef {
JobRef::new(<span class="self">self</span>)
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>run_inline(<span class="self">self</span>, stolen: bool) -&gt; R {
<span class="self">self</span>.func.into_inner().unwrap()(stolen)
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>into_result(<span class="self">self</span>) -&gt; R {
<span class="self">self</span>.result.into_inner().into_return_value()
}
}
<span class="kw">impl</span>&lt;L, F, R&gt; Job <span class="kw">for </span>StackJob&lt;L, F, R&gt;
<span class="kw">where
</span>L: Latch + Sync,
F: FnOnce(bool) -&gt; R + Send,
R: Send,
{
<span class="kw">unsafe fn </span>execute(this: <span class="kw-2">*const </span>()) {
<span class="kw">let </span>this = <span class="kw-2">&amp;*</span>(this <span class="kw">as </span><span class="kw-2">*const </span><span class="self">Self</span>);
<span class="kw">let </span>abort = unwind::AbortIfPanic;
<span class="kw">let </span>func = (<span class="kw-2">*</span>this.func.get()).take().unwrap();
(<span class="kw-2">*</span>this.result.get()) = JobResult::call(func);
Latch::set(<span class="kw-2">&amp;</span>this.latch);
mem::forget(abort);
}
}
<span class="doccomment">/// Represents a job stored in the heap. Used to implement
/// `scope`. Unlike `StackJob`, when executed, `HeapJob` simply
/// invokes a closure, which then triggers the appropriate logic to
/// signal that the job executed.
///
/// (Probably `StackJob` should be refactored in a similar fashion.)
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>HeapJob&lt;BODY&gt;
<span class="kw">where
</span>BODY: FnOnce() + Send,
{
job: BODY,
}
<span class="kw">impl</span>&lt;BODY&gt; HeapJob&lt;BODY&gt;
<span class="kw">where
</span>BODY: FnOnce() + Send,
{
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(job: BODY) -&gt; Box&lt;<span class="self">Self</span>&gt; {
Box::new(HeapJob { job })
}
<span class="doccomment">/// Creates a `JobRef` from this job -- note that this hides all
/// lifetimes, so it is up to you to ensure that this JobRef
/// doesn&#39;t outlive any data that it closes over.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>into_job_ref(<span class="self">self</span>: Box&lt;<span class="self">Self</span>&gt;) -&gt; JobRef {
JobRef::new(Box::into_raw(<span class="self">self</span>))
}
<span class="doccomment">/// Creates a static `JobRef` from this job.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>into_static_job_ref(<span class="self">self</span>: Box&lt;<span class="self">Self</span>&gt;) -&gt; JobRef
<span class="kw">where
</span>BODY: <span class="lifetime">&#39;static</span>,
{
<span class="kw">unsafe </span>{ <span class="self">self</span>.into_job_ref() }
}
}
<span class="kw">impl</span>&lt;BODY&gt; Job <span class="kw">for </span>HeapJob&lt;BODY&gt;
<span class="kw">where
</span>BODY: FnOnce() + Send,
{
<span class="kw">unsafe fn </span>execute(this: <span class="kw-2">*const </span>()) {
<span class="kw">let </span>this = Box::from_raw(this <span class="kw">as </span><span class="kw-2">*mut </span><span class="self">Self</span>);
(this.job)();
}
}
<span class="doccomment">/// Represents a job stored in an `Arc` -- like `HeapJob`, but may
/// be turned into multiple `JobRef`s and called multiple times.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>ArcJob&lt;BODY&gt;
<span class="kw">where
</span>BODY: Fn() + Send + Sync,
{
job: BODY,
}
<span class="kw">impl</span>&lt;BODY&gt; ArcJob&lt;BODY&gt;
<span class="kw">where
</span>BODY: Fn() + Send + Sync,
{
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(job: BODY) -&gt; Arc&lt;<span class="self">Self</span>&gt; {
Arc::new(ArcJob { job })
}
<span class="doccomment">/// Creates a `JobRef` from this job -- note that this hides all
/// lifetimes, so it is up to you to ensure that this JobRef
/// doesn&#39;t outlive any data that it closes over.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>as_job_ref(this: <span class="kw-2">&amp;</span>Arc&lt;<span class="self">Self</span>&gt;) -&gt; JobRef {
JobRef::new(Arc::into_raw(Arc::clone(this)))
}
<span class="doccomment">/// Creates a static `JobRef` from this job.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>as_static_job_ref(this: <span class="kw-2">&amp;</span>Arc&lt;<span class="self">Self</span>&gt;) -&gt; JobRef
<span class="kw">where
</span>BODY: <span class="lifetime">&#39;static</span>,
{
<span class="kw">unsafe </span>{ <span class="self">Self</span>::as_job_ref(this) }
}
}
<span class="kw">impl</span>&lt;BODY&gt; Job <span class="kw">for </span>ArcJob&lt;BODY&gt;
<span class="kw">where
</span>BODY: Fn() + Send + Sync,
{
<span class="kw">unsafe fn </span>execute(this: <span class="kw-2">*const </span>()) {
<span class="kw">let </span>this = Arc::from_raw(this <span class="kw">as </span><span class="kw-2">*mut </span><span class="self">Self</span>);
(this.job)();
}
}
<span class="kw">impl</span>&lt;T&gt; JobResult&lt;T&gt; {
<span class="kw">fn </span>call(func: <span class="kw">impl </span>FnOnce(bool) -&gt; T) -&gt; <span class="self">Self </span>{
<span class="kw">match </span>unwind::halt_unwinding(|| func(<span class="bool-val">true</span>)) {
<span class="prelude-val">Ok</span>(x) =&gt; JobResult::Ok(x),
<span class="prelude-val">Err</span>(x) =&gt; JobResult::Panic(x),
}
}
<span class="doccomment">/// Convert the `JobResult` for a job that has finished (and hence
/// its JobResult is populated) into its return value.
///
/// NB. This will panic if the job panicked.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>into_return_value(<span class="self">self</span>) -&gt; T {
<span class="kw">match </span><span class="self">self </span>{
JobResult::None =&gt; <span class="macro">unreachable!</span>(),
JobResult::Ok(x) =&gt; x,
JobResult::Panic(x) =&gt; unwind::resume_unwinding(x),
}
}
}
<span class="doccomment">/// Indirect queue to provide FIFO job priority.
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>JobFifo {
inner: Injector&lt;JobRef&gt;,
}
<span class="kw">impl </span>JobFifo {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new() -&gt; <span class="self">Self </span>{
JobFifo {
inner: Injector::new(),
}
}
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>push(<span class="kw-2">&amp;</span><span class="self">self</span>, job_ref: JobRef) -&gt; JobRef {
<span class="comment">// A little indirection ensures that spawns are always prioritized in FIFO order. The
// jobs in a thread&#39;s deque may be popped from the back (LIFO) or stolen from the front
// (FIFO), but either way they will end up popping from the front of this queue.
</span><span class="self">self</span>.inner.push(job_ref);
JobRef::new(<span class="self">self</span>)
}
}
<span class="kw">impl </span>Job <span class="kw">for </span>JobFifo {
<span class="kw">unsafe fn </span>execute(this: <span class="kw-2">*const </span>()) {
<span class="comment">// We &quot;execute&quot; a queue by executing its first job, FIFO.
</span><span class="kw">let </span>this = <span class="kw-2">&amp;*</span>(this <span class="kw">as </span><span class="kw-2">*const </span><span class="self">Self</span>);
<span class="kw">loop </span>{
<span class="kw">match </span>this.inner.steal() {
Steal::Success(job_ref) =&gt; <span class="kw">break </span>job_ref.execute(),
Steal::Empty =&gt; <span class="macro">panic!</span>(<span class="string">&quot;FIFO is empty&quot;</span>),
Steal::Retry =&gt; {}
}
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rayon_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>