| <!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/broadcast/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../rayon_core/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../rayon_core/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| </pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::job::{ArcJob, StackJob}; |
| <span class="kw">use </span><span class="kw">crate</span>::latch::LatchRef; |
| <span class="kw">use </span><span class="kw">crate</span>::registry::{Registry, WorkerThread}; |
| <span class="kw">use </span><span class="kw">crate</span>::scope::ScopeLatch; |
| <span class="kw">use </span>std::fmt; |
| <span class="kw">use </span>std::marker::PhantomData; |
| <span class="kw">use </span>std::sync::Arc; |
| |
| <span class="kw">mod </span>test; |
| |
| <span class="doccomment">/// Executes `op` within every thread in the current threadpool. If this is |
| /// called from a non-Rayon thread, it will execute in the global threadpool. |
| /// Any attempts to use `join`, `scope`, or parallel iterators will then operate |
| /// within that threadpool. When the call has completed on each thread, returns |
| /// a vector containing all of their return values. |
| /// |
| /// For more information, see the [`ThreadPool::broadcast()`][m] method. |
| /// |
| /// [m]: struct.ThreadPool.html#method.broadcast |
| </span><span class="kw">pub fn </span>broadcast<OP, R>(op: OP) -> Vec<R> |
| <span class="kw">where |
| </span>OP: Fn(BroadcastContext<<span class="lifetime">'_</span>>) -> R + Sync, |
| R: Send, |
| { |
| <span class="comment">// We assert that current registry has not terminated. |
| </span><span class="kw">unsafe </span>{ broadcast_in(op, <span class="kw-2">&</span>Registry::current()) } |
| } |
| |
| <span class="doccomment">/// Spawns an asynchronous task on every thread in this thread-pool. This task |
| /// will run in the implicit, global scope, which means that it may outlast the |
| /// current stack frame -- therefore, it cannot capture any references onto the |
| /// stack (you will likely need a `move` closure). |
| /// |
| /// For more information, see the [`ThreadPool::spawn_broadcast()`][m] method. |
| /// |
| /// [m]: struct.ThreadPool.html#method.spawn_broadcast |
| </span><span class="kw">pub fn </span>spawn_broadcast<OP>(op: OP) |
| <span class="kw">where |
| </span>OP: Fn(BroadcastContext<<span class="lifetime">'_</span>>) + Send + Sync + <span class="lifetime">'static</span>, |
| { |
| <span class="comment">// We assert that current registry has not terminated. |
| </span><span class="kw">unsafe </span>{ spawn_broadcast_in(op, <span class="kw-2">&</span>Registry::current()) } |
| } |
| |
| <span class="doccomment">/// Provides context to a closure called by `broadcast`. |
| </span><span class="kw">pub struct </span>BroadcastContext<<span class="lifetime">'a</span>> { |
| worker: <span class="kw-2">&</span><span class="lifetime">'a </span>WorkerThread, |
| |
| <span class="doccomment">/// Make sure to prevent auto-traits like `Send` and `Sync`. |
| </span>_marker: PhantomData<<span class="kw-2">&</span><span class="lifetime">'a </span><span class="kw-2">mut </span><span class="kw">dyn </span>Fn()>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> BroadcastContext<<span class="lifetime">'a</span>> { |
| <span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>with<R>(f: <span class="kw">impl </span>FnOnce(BroadcastContext<<span class="lifetime">'_</span>>) -> R) -> R { |
| <span class="kw">let </span>worker_thread = WorkerThread::current(); |
| <span class="macro">assert!</span>(!worker_thread.is_null()); |
| f(BroadcastContext { |
| worker: <span class="kw">unsafe </span>{ <span class="kw-2">&*</span>worker_thread }, |
| _marker: PhantomData, |
| }) |
| } |
| |
| <span class="doccomment">/// Our index amongst the broadcast threads (ranges from `0..self.num_threads()`). |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>index(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.worker.index() |
| } |
| |
| <span class="doccomment">/// The number of threads receiving the broadcast in the thread pool. |
| /// |
| /// # Future compatibility note |
| /// |
| /// Future versions of Rayon might vary the number of threads over time, but |
| /// this method will always return the number of threads which are actually |
| /// receiving your particular `broadcast` call. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>num_threads(<span class="kw-2">&</span><span class="self">self</span>) -> usize { |
| <span class="self">self</span>.worker.registry().num_threads() |
| } |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>> fmt::Debug <span class="kw">for </span>BroadcastContext<<span class="lifetime">'a</span>> { |
| <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">"BroadcastContext"</span>) |
| .field(<span class="string">"index"</span>, <span class="kw-2">&</span><span class="self">self</span>.index()) |
| .field(<span class="string">"num_threads"</span>, <span class="kw-2">&</span><span class="self">self</span>.num_threads()) |
| .field(<span class="string">"pool_id"</span>, <span class="kw-2">&</span><span class="self">self</span>.worker.registry().id()) |
| .finish() |
| } |
| } |
| |
| <span class="doccomment">/// Execute `op` on every thread in the pool. It will be executed on each |
| /// thread when they have nothing else to do locally, before they try to |
| /// steal work from other threads. This function will not return until all |
| /// threads have completed the `op`. |
| /// |
| /// Unsafe because `registry` must not yet have terminated. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>broadcast_in<OP, R>(op: OP, registry: <span class="kw-2">&</span>Arc<Registry>) -> Vec<R> |
| <span class="kw">where |
| </span>OP: Fn(BroadcastContext<<span class="lifetime">'_</span>>) -> R + Sync, |
| R: Send, |
| { |
| <span class="kw">let </span>f = <span class="kw">move </span>|injected: bool| { |
| <span class="macro">debug_assert!</span>(injected); |
| BroadcastContext::with(<span class="kw-2">&</span>op) |
| }; |
| |
| <span class="kw">let </span>n_threads = registry.num_threads(); |
| <span class="kw">let </span>current_thread = WorkerThread::current().as_ref(); |
| <span class="kw">let </span>latch = ScopeLatch::with_count(n_threads, current_thread); |
| <span class="kw">let </span>jobs: Vec<<span class="kw">_</span>> = (<span class="number">0</span>..n_threads) |
| .map(|<span class="kw">_</span>| StackJob::new(<span class="kw-2">&</span>f, LatchRef::new(<span class="kw-2">&</span>latch))) |
| .collect(); |
| <span class="kw">let </span>job_refs = jobs.iter().map(|job| job.as_job_ref()); |
| |
| registry.inject_broadcast(job_refs); |
| |
| <span class="comment">// Wait for all jobs to complete, then collect the results, maybe propagating a panic. |
| </span>latch.wait(current_thread); |
| jobs.into_iter().map(|job| job.into_result()).collect() |
| } |
| |
| <span class="doccomment">/// Execute `op` on every thread in the pool. It will be executed on each |
| /// thread when they have nothing else to do locally, before they try to |
| /// steal work from other threads. This function returns immediately after |
| /// injecting the jobs. |
| /// |
| /// Unsafe because `registry` must not yet have terminated. |
| </span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>spawn_broadcast_in<OP>(op: OP, registry: <span class="kw-2">&</span>Arc<Registry>) |
| <span class="kw">where |
| </span>OP: Fn(BroadcastContext<<span class="lifetime">'_</span>>) + Send + Sync + <span class="lifetime">'static</span>, |
| { |
| <span class="kw">let </span>job = ArcJob::new({ |
| <span class="kw">let </span>registry = Arc::clone(registry); |
| <span class="kw">move </span>|| { |
| registry.catch_unwind(|| BroadcastContext::with(<span class="kw-2">&</span>op)); |
| registry.terminate(); <span class="comment">// (*) permit registry to terminate now |
| </span>} |
| }); |
| |
| <span class="kw">let </span>n_threads = registry.num_threads(); |
| <span class="kw">let </span>job_refs = (<span class="number">0</span>..n_threads).map(|<span class="kw">_</span>| { |
| <span class="comment">// Ensure that registry cannot terminate until this job has executed |
| // on each thread. This ref is decremented at the (*) above. |
| </span>registry.increment_terminate_count(); |
| |
| ArcJob::as_static_job_ref(<span class="kw-2">&</span>job) |
| }); |
| |
| registry.inject_broadcast(job_refs); |
| } |
| </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> |
