blob: 0b8133528d6c1f80b5c0b37ec08365a799c1c5b2 [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/arc-swap-1.6.0/src/strategy/hybrid.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>hybrid.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="../../../arc_swap/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="../../../arc_swap/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>
</pre><pre class="rust"><code><span class="doccomment">//! A hybrid strategy.
//!
//! This is based on debts ‒ an Arc may owe a reference, but it is marked in the debt. It is either
//! put back (by stopping using it), or if the pointer is replaced, the writer bumps the reference
//! count and removes the debt.
//!
//! The strategy uses two different slots for the debts. The first ones are faster, but fallible.
//! If they fail (either because there&#39;s interference from a writer at the same time, or because
//! they are full), the secondary one that is slower, but always succeeds, is used. In the latter
//! case, the reference is bumped and this secondary debt slot is released, so it is available for
//! further loads.
//!
//! See the [crate::debt] module for the actual slot manipulation. Here we just wrap them into the
//! strategy.
</span><span class="kw">use </span>std::borrow::Borrow;
<span class="kw">use </span>std::mem::{<span class="self">self</span>, ManuallyDrop};
<span class="kw">use </span>std::ops::Deref;
<span class="kw">use </span>std::ptr;
<span class="kw">use </span>std::sync::atomic::AtomicPtr;
<span class="kw">use </span>std::sync::atomic::Ordering::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">super</span>::sealed::{CaS, InnerStrategy, Protected};
<span class="kw">use </span><span class="kw">crate</span>::debt::{Debt, LocalNode};
<span class="kw">use </span><span class="kw">crate</span>::ref_cnt::RefCnt;
<span class="kw">pub struct </span>HybridProtection&lt;T: RefCnt&gt; {
debt: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>Debt&gt;,
ptr: ManuallyDrop&lt;T&gt;,
}
<span class="kw">impl</span>&lt;T: RefCnt&gt; HybridProtection&lt;T&gt; {
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">unsafe fn </span>new(ptr: <span class="kw-2">*const </span>T::Base, debt: <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>Debt&gt;) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
debt,
ptr: ManuallyDrop::new(T::from_ptr(ptr)),
}
}
<span class="doccomment">/// Try getting a dept into a fast slot.
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>attempt(node: <span class="kw-2">&amp;</span>LocalNode, storage: <span class="kw-2">&amp;</span>AtomicPtr&lt;T::Base&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>&gt; {
<span class="comment">// Relaxed is good enough here, see the Acquire below
</span><span class="kw">let </span>ptr = storage.load(Relaxed);
<span class="comment">// Try to get a debt slot. If not possible, fail.
</span><span class="kw">let </span>debt = node.new_fast(ptr <span class="kw">as </span>usize)<span class="question-mark">?</span>;
<span class="comment">// Acquire to get the data.
//
// SeqCst to make sure the storage vs. the debt are well ordered.
</span><span class="kw">let </span>confirm = storage.load(SeqCst);
<span class="kw">if </span>ptr == confirm {
<span class="comment">// Successfully got a debt
</span><span class="prelude-val">Some</span>(<span class="kw">unsafe </span>{ <span class="self">Self</span>::new(ptr, <span class="prelude-val">Some</span>(debt)) })
} <span class="kw">else if </span>debt.pay::&lt;T&gt;(ptr) {
<span class="comment">// It changed in the meantime, we return the debt (that is on the outdated pointer,
// possibly destroyed) and fail.
</span><span class="prelude-val">None
</span>} <span class="kw">else </span>{
<span class="comment">// It changed in the meantime, but the debt for the previous pointer was already paid
// for by someone else, so we are fine using it.
</span><span class="prelude-val">Some</span>(<span class="kw">unsafe </span>{ <span class="self">Self</span>::new(ptr, <span class="prelude-val">None</span>) })
}
}
<span class="doccomment">/// Get a debt slot using the slower but always successful mechanism.
</span><span class="kw">fn </span>fallback(node: <span class="kw-2">&amp;</span>LocalNode, storage: <span class="kw-2">&amp;</span>AtomicPtr&lt;T::Base&gt;) -&gt; <span class="self">Self </span>{
<span class="comment">// First, we claim a debt slot and store the address of the atomic pointer there, so the
// writer can optionally help us out with loading and protecting something.
</span><span class="kw">let </span>gen = node.new_helping(storage <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize);
<span class="comment">// We already synchronized the start of the sequence by SeqCst in the new_helping vs swap on
// the pointer. We just need to make sure to bring the pointee in (this can be newer than
// what we got in the Debt)
</span><span class="kw">let </span>candidate = storage.load(Acquire);
<span class="comment">// Try to replace the debt with our candidate. If it works, we get the debt slot to use. If
// not, we get a replacement value, already protected and a debt to take care of.
</span><span class="kw">match </span>node.confirm_helping(gen, candidate <span class="kw">as </span>usize) {
<span class="prelude-val">Ok</span>(debt) =&gt; {
<span class="comment">// The fast path -&gt; we got the debt confirmed alright.
</span><span class="self">Self</span>::from_inner(<span class="kw">unsafe </span>{ <span class="self">Self</span>::new(candidate, <span class="prelude-val">Some</span>(debt)).into_inner() })
}
<span class="prelude-val">Err</span>((unused_debt, replacement)) =&gt; {
<span class="comment">// The debt is on the candidate we provided and it is unused, we so we just pay it
// back right away.
</span><span class="kw">if </span>!unused_debt.pay::&lt;T&gt;(candidate) {
<span class="kw">unsafe </span>{ T::dec(candidate) };
}
<span class="comment">// We got a (possibly) different pointer out. But that one is already protected and
// the slot is paid back.
</span><span class="kw">unsafe </span>{ <span class="self">Self</span>::new(replacement <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>, <span class="prelude-val">None</span>) }
}
}
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>as_ptr(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">*const </span>T::Base {
T::as_ptr(<span class="self">self</span>.ptr.deref())
}
}
<span class="kw">impl</span>&lt;T: RefCnt&gt; Drop <span class="kw">for </span>HybridProtection&lt;T&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="kw">match </span><span class="self">self</span>.debt.take() {
<span class="comment">// We have our own copy of Arc, so we don&#39;t need a protection. Do nothing (but release
// the Arc below).
</span><span class="prelude-val">None </span>=&gt; (),
<span class="comment">// If we owed something, just return the debt. We don&#39;t have a pointer owned, so
// nothing to release.
</span><span class="prelude-val">Some</span>(debt) =&gt; {
<span class="kw">let </span>ptr = T::as_ptr(<span class="kw-2">&amp;</span><span class="self">self</span>.ptr);
<span class="kw">if </span>debt.pay::&lt;T&gt;(ptr) {
<span class="kw">return</span>;
}
<span class="comment">// But if the debt was already paid for us, we need to release the pointer, as we
// were effectively already in the Unprotected mode.
</span>}
}
<span class="comment">// Equivalent to T::dec(ptr)
</span><span class="kw">unsafe </span>{ ManuallyDrop::drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>.ptr) };
}
}
<span class="kw">impl</span>&lt;T: RefCnt&gt; Protected&lt;T&gt; <span class="kw">for </span>HybridProtection&lt;T&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>from_inner(ptr: T) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
debt: <span class="prelude-val">None</span>,
ptr: ManuallyDrop::new(ptr),
}
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>into_inner(<span class="kw-2">mut </span><span class="self">self</span>) -&gt; T {
<span class="comment">// Drop any debt and release any lock held by the given guard and return a
// full-featured value that even can outlive the ArcSwap it originated from.
</span><span class="kw">match </span><span class="self">self</span>.debt.take() {
<span class="prelude-val">None </span>=&gt; (), <span class="comment">// We have a fully loaded ref-counted pointer.
</span><span class="prelude-val">Some</span>(debt) =&gt; {
<span class="kw">let </span>ptr = T::inc(<span class="kw-2">&amp;</span><span class="self">self</span>.ptr);
<span class="kw">if </span>!debt.pay::&lt;T&gt;(ptr) {
<span class="kw">unsafe </span>{ T::dec(ptr) };
}
}
}
<span class="comment">// The ptr::read &amp; forget is something like a cheating move. We can&#39;t move it out, because
// we have a destructor and Rust doesn&#39;t allow us to do that.
</span><span class="kw">let </span>inner = <span class="kw">unsafe </span>{ ptr::read(<span class="self">self</span>.ptr.deref()) };
mem::forget(<span class="self">self</span>);
inner
}
}
<span class="kw">impl</span>&lt;T: RefCnt&gt; Borrow&lt;T&gt; <span class="kw">for </span>HybridProtection&lt;T&gt; {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>borrow(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span>T {
<span class="kw-2">&amp;</span><span class="self">self</span>.ptr
}
}
<span class="kw">pub trait </span>Config {
<span class="comment">// Mostly for testing, way to disable the fast slo
</span><span class="kw">const </span>USE_FAST: bool;
}
<span class="attribute">#[derive(Clone, Default)]
</span><span class="kw">pub struct </span>DefaultConfig;
<span class="kw">impl </span>Config <span class="kw">for </span>DefaultConfig {
<span class="kw">const </span>USE_FAST: bool = <span class="bool-val">true</span>;
}
<span class="attribute">#[derive(Clone, Default)]
</span><span class="kw">pub struct </span>HybridStrategy&lt;Cfg&gt; {
<span class="kw">pub</span>(<span class="kw">crate</span>) _config: Cfg,
}
<span class="kw">impl</span>&lt;T, Cfg&gt; InnerStrategy&lt;T&gt; <span class="kw">for </span>HybridStrategy&lt;Cfg&gt;
<span class="kw">where
</span>T: RefCnt,
Cfg: Config,
{
<span class="kw">type </span>Protected = HybridProtection&lt;T&gt;;
<span class="kw">unsafe fn </span>load(<span class="kw-2">&amp;</span><span class="self">self</span>, storage: <span class="kw-2">&amp;</span>AtomicPtr&lt;T::Base&gt;) -&gt; <span class="self">Self</span>::Protected {
LocalNode::with(|node| {
<span class="kw">let </span>fast = <span class="kw">if </span>Cfg::USE_FAST {
HybridProtection::attempt(node, storage)
} <span class="kw">else </span>{
<span class="prelude-val">None
</span>};
fast.unwrap_or_else(|| HybridProtection::fallback(node, storage))
})
}
<span class="kw">unsafe fn </span>wait_for_readers(<span class="kw-2">&amp;</span><span class="self">self</span>, old: <span class="kw-2">*const </span>T::Base, storage: <span class="kw-2">&amp;</span>AtomicPtr&lt;T::Base&gt;) {
<span class="comment">// The pay_all may need to provide fresh replacement values if someone else is loading from
// this particular storage. We do so by the exact same way, by `load` ‒ it&#39;s OK, a writer
// does not hold a slot and the reader doesn&#39;t recurse back into writer, so we won&#39;t run
// out of slots.
</span><span class="kw">let </span>replacement = || <span class="self">self</span>.load(storage).into_inner();
Debt::pay_all::&lt;T, <span class="kw">_</span>&gt;(old, storage <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize, replacement);
}
}
<span class="kw">impl</span>&lt;T: RefCnt, Cfg: Config&gt; CaS&lt;T&gt; <span class="kw">for </span>HybridStrategy&lt;Cfg&gt; {
<span class="kw">unsafe fn </span>compare_and_swap&lt;C: <span class="kw">crate</span>::as_raw::AsRaw&lt;T::Base&gt;&gt;(
<span class="kw-2">&amp;</span><span class="self">self</span>,
storage: <span class="kw-2">&amp;</span>AtomicPtr&lt;T::Base&gt;,
current: C,
new: T,
) -&gt; <span class="self">Self</span>::Protected {
<span class="kw">loop </span>{
<span class="kw">let </span>old = &lt;<span class="self">Self </span><span class="kw">as </span>InnerStrategy&lt;T&gt;&gt;::load(<span class="self">self</span>, storage);
<span class="comment">// Observation of their inequality is enough to make a verdict
</span><span class="kw">if </span>old.as_ptr() != current.as_raw() {
<span class="kw">return </span>old;
}
<span class="comment">// If they are still equal, put the new one in.
</span><span class="kw">let </span>new_raw = T::as_ptr(<span class="kw-2">&amp;</span>new);
<span class="kw">if </span>storage
.compare_exchange_weak(current.as_raw(), new_raw, SeqCst, Relaxed)
.is_ok()
{
<span class="comment">// We successfully put the new value in. The ref count went in there too.
</span>T::into_ptr(new);
&lt;<span class="self">Self </span><span class="kw">as </span>InnerStrategy&lt;T&gt;&gt;::wait_for_readers(<span class="self">self</span>, old.as_ptr(), storage);
<span class="comment">// We just got one ref count out of the storage and we have one in old. We don&#39;t
// need two.
</span>T::dec(old.as_ptr());
<span class="kw">return </span>old;
}
}
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="arc_swap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>