blob: dc6641b72fe22eb14044d62918c133bb4a49ef1e [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/registry/src/github.com-1ecc6299db9ec823/tokio-1.28.2/src/loom/std/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="../../../../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>
</pre><pre class="rust"><code><span class="attribute">#![cfg_attr(any(not(feature = <span class="string">&quot;full&quot;</span>), loom), allow(unused_imports, dead_code))]
</span><span class="kw">mod </span>atomic_u16;
<span class="kw">mod </span>atomic_u32;
<span class="kw">mod </span>atomic_u64;
<span class="kw">mod </span>atomic_usize;
<span class="kw">mod </span>mutex;
<span class="attribute">#[cfg(feature = <span class="string">&quot;parking_lot&quot;</span>)]
</span><span class="kw">mod </span>parking_lot;
<span class="kw">mod </span>unsafe_cell;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>cell {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">super</span>::unsafe_cell::UnsafeCell;
}
<span class="attribute">#[cfg(any(
feature = <span class="string">&quot;net&quot;</span>,
feature = <span class="string">&quot;process&quot;</span>,
feature = <span class="string">&quot;signal&quot;</span>,
feature = <span class="string">&quot;sync&quot;</span>,
))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>future {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::sync::AtomicWaker;
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>hint {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>std::hint::spin_loop;
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>rand {
<span class="kw">use </span>std::collections::hash_map::RandomState;
<span class="kw">use </span>std::hash::{BuildHasher, Hash, Hasher};
<span class="kw">use </span>std::sync::atomic::AtomicU32;
<span class="kw">use </span>std::sync::atomic::Ordering::Relaxed;
<span class="kw">static </span>COUNTER: AtomicU32 = AtomicU32::new(<span class="number">1</span>);
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>seed() -&gt; u64 {
<span class="kw">let </span>rand_state = RandomState::new();
<span class="kw">let </span><span class="kw-2">mut </span>hasher = rand_state.build_hasher();
<span class="comment">// Hash some unique-ish data to generate some new state
</span>COUNTER.fetch_add(<span class="number">1</span>, Relaxed).hash(<span class="kw-2">&amp;mut </span>hasher);
<span class="comment">// Get the seed
</span>hasher.finish()
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>sync {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>std::sync::{Arc, Weak};
<span class="comment">// Below, make sure all the feature-influenced types are exported for
// internal use. Note however that some are not _currently_ named by
// consuming code.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;parking_lot&quot;</span>)]
#[allow(unused_imports)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::loom::std::parking_lot::{
Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard, WaitTimeoutResult,
};
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;parking_lot&quot;</span>))]
#[allow(unused_imports)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>std::sync::{Condvar, MutexGuard, RwLock, RwLockReadGuard, WaitTimeoutResult};
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;parking_lot&quot;</span>))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::loom::std::mutex::Mutex;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>atomic {
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::loom::std::atomic_u16::AtomicU16;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::loom::std::atomic_u32::AtomicU32;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::loom::std::atomic_u64::{AtomicU64, StaticAtomicU64};
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span><span class="kw">crate</span>::loom::std::atomic_usize::AtomicUsize;
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>std::sync::atomic::{fence, AtomicBool, AtomicPtr, AtomicU8, Ordering};
}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>sys {
<span class="attribute">#[cfg(feature = <span class="string">&quot;rt-multi-thread&quot;</span>)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>num_cpus() -&gt; usize {
<span class="kw">const </span>ENV_WORKER_THREADS: <span class="kw-2">&amp;</span>str = <span class="string">&quot;TOKIO_WORKER_THREADS&quot;</span>;
<span class="kw">match </span>std::env::var(ENV_WORKER_THREADS) {
<span class="prelude-val">Ok</span>(s) =&gt; {
<span class="kw">let </span>n = s.parse().unwrap_or_else(|e| {
<span class="macro">panic!</span>(
<span class="string">&quot;\&quot;{}\&quot; must be usize, error: {}, value: {}&quot;</span>,
ENV_WORKER_THREADS, e, s
)
});
<span class="macro">assert!</span>(n &gt; <span class="number">0</span>, <span class="string">&quot;\&quot;{}\&quot; cannot be set to 0&quot;</span>, ENV_WORKER_THREADS);
n
}
<span class="prelude-val">Err</span>(std::env::VarError::NotPresent) =&gt; usize::max(<span class="number">1</span>, num_cpus::get()),
<span class="prelude-val">Err</span>(std::env::VarError::NotUnicode(e)) =&gt; {
<span class="macro">panic!</span>(
<span class="string">&quot;\&quot;{}\&quot; must be valid unicode, error: {:?}&quot;</span>,
ENV_WORKER_THREADS, e
)
}
}
}
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;rt-multi-thread&quot;</span>))]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>num_cpus() -&gt; usize {
<span class="number">1
</span>}
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">mod </span>thread {
<span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>yield_now() {
std::hint::spin_loop();
}
<span class="attribute">#[allow(unused_imports)]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">use </span>std::thread::{
current, panicking, park, park_timeout, sleep, spawn, AccessError, Builder, JoinHandle,
LocalKey, <span class="prelude-ty">Result</span>, Thread, ThreadId,
};
}
</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>