<!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 to the Rust file `/Users/travis/.cargo/registry/src/github.com-1ecc6299db9ec823/crossbeam-0.3.2/src/epoch/mod.rs`.">
<meta name="keywords" content="rust, rustlang, rust-lang">
<title>mod.rs.html -- source</title>
<link rel="stylesheet" type="text/css" href="../../../normalize.css">
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle">
<link rel="stylesheet" type="text/css" href="../../../dark.css">
<link rel="stylesheet" type="text/css" href="../../../main.css" id="themeStyle">
<script src="../../../storage.js"></script>
</head>
<body class="rustdoc source">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<div class="sidebar-menu">☰</div>
</nav>
<div class="theme-picker">
<button id="theme-picker" aria-label="Pick another theme!">
<img src="../../../brush.svg" width="18" alt="Pick another theme!">
</button>
<div id="theme-choices"></div>
</div>
<script src="../../../theme.js"></script>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content"><pre class="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>
</pre><pre class="rust ">
<span class="doccomment">//! Epoch-based memory management</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This module provides fast, easy to use memory management for lock free data</span>
<span class="doccomment">//! structures. It's inspired by [Keir Fraser's *epoch-based</span>
<span class="doccomment">//! reclamation*](https://www.cl.cam.ac.uk/techreports/UCAM-CL-TR-579.pdf).</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! The basic problem this is solving is the fact that when one thread has</span>
<span class="doccomment">//! removed a node from a data structure, other threads may still have pointers</span>
<span class="doccomment">//! to that node (in the form of snapshots that will be validated through things</span>
<span class="doccomment">//! like compare-and-swap), so the memory cannot be immediately freed. Put differently:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! 1. There are two sources of reachability at play -- the data structure, and</span>
<span class="doccomment">//! the snapshots in threads accessing it. Before we delete a node, we need to know</span>
<span class="doccomment">//! that it cannot be reached in either of these ways.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! 2. Once a node has been unlinked from the data structure, no *new* snapshots</span>
<span class="doccomment">//! reaching it will be created.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Using the epoch scheme is fairly straightforward, and does not require</span>
<span class="doccomment">//! understanding any of the implementation details:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - When operating on a shared data structure, a thread must "pin the current</span>
<span class="doccomment">//! epoch", which is done by calling `pin()`. This function returns a `Guard`</span>
<span class="doccomment">//! which unpins the epoch when destroyed.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - When the thread subsequently reads from a lock-free data structure, the</span>
<span class="doccomment">//! pointers it extracts act like references with lifetime tied to the</span>
<span class="doccomment">//! `Guard`. This allows threads to safely read from snapshotted data, being</span>
<span class="doccomment">//! guaranteed that the data will remain allocated until they exit the epoch.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! To put the `Guard` to use, Crossbeam provides a set of three pointer types meant to work together:</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - `Owned<T>`, akin to `Box<T>`, which points to uniquely-owned data that has</span>
<span class="doccomment">//! not yet been published in a concurrent data structure.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - `Shared<'a, T>`, akin to `&'a T`, which points to shared data that may or may</span>
<span class="doccomment">//! not be reachable from a data structure, but it guaranteed not to be freed</span>
<span class="doccomment">//! during lifetime `'a`.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! - `Atomic<T>`, akin to `std::sync::atomic::AtomicPtr`, which provides atomic</span>
<span class="doccomment">//! updates to a pointer using the `Owned` and `Shared` types, and connects them</span>
<span class="doccomment">//! to a `Guard`.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Each of these types provides further documentation on usage.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! # Example</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ```</span>
<span class="doccomment">//! use std::sync::atomic::Ordering::{Acquire, Release, Relaxed};</span>
<span class="doccomment">//! use std::ptr;</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! use crossbeam::epoch::{self, Atomic, Owned};</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! struct TreiberStack<T> {</span>
<span class="doccomment">//! head: Atomic<Node<T>>,</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! struct Node<T> {</span>
<span class="doccomment">//! data: T,</span>
<span class="doccomment">//! next: Atomic<Node<T>>,</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! impl<T> TreiberStack<T> {</span>
<span class="doccomment">//! fn new() -> TreiberStack<T> {</span>
<span class="doccomment">//! TreiberStack {</span>
<span class="doccomment">//! head: Atomic::null()</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! fn push(&self, t: T) {</span>
<span class="doccomment">//! // allocate the node via Owned</span>
<span class="doccomment">//! let mut n = Owned::new(Node {</span>
<span class="doccomment">//! data: t,</span>
<span class="doccomment">//! next: Atomic::null(),</span>
<span class="doccomment">//! });</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // become active</span>
<span class="doccomment">//! let guard = epoch::pin();</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! loop {</span>
<span class="doccomment">//! // snapshot current head</span>
<span class="doccomment">//! let head = self.head.load(Relaxed, &guard);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // update `next` pointer with snapshot</span>
<span class="doccomment">//! n.next.store_shared(head, Relaxed);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // if snapshot is still good, link in the new node</span>
<span class="doccomment">//! match self.head.cas_and_ref(head, n, Release, &guard) {</span>
<span class="doccomment">//! Ok(_) => return,</span>
<span class="doccomment">//! Err(owned) => n = owned,</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! fn pop(&self) -> Option<T> {</span>
<span class="doccomment">//! // become active</span>
<span class="doccomment">//! let guard = epoch::pin();</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! loop {</span>
<span class="doccomment">//! // take a snapshot</span>
<span class="doccomment">//! match self.head.load(Acquire, &guard) {</span>
<span class="doccomment">//! // the stack is non-empty</span>
<span class="doccomment">//! Some(head) => {</span>
<span class="doccomment">//! // read through the snapshot, *safely*!</span>
<span class="doccomment">//! let next = head.next.load(Relaxed, &guard);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // if snapshot is still good, update from `head` to `next`</span>
<span class="doccomment">//! if self.head.cas_shared(Some(head), next, Release) {</span>
<span class="doccomment">//! unsafe {</span>
<span class="doccomment">//! // mark the node as unlinked</span>
<span class="doccomment">//! guard.unlinked(head);</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // extract out the data from the now-unlinked node</span>
<span class="doccomment">//! return Some(ptr::read(&(*head).data))</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! // we observed the stack empty</span>
<span class="doccomment">//! None => return None</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! }</span>
<span class="doccomment">//! ```</span>
<span class="comment">// FIXME: document implementation details</span>
<span class="kw">mod</span> <span class="ident">atomic</span>;
<span class="kw">mod</span> <span class="ident">garbage</span>;
<span class="kw">mod</span> <span class="ident">global</span>;
<span class="kw">mod</span> <span class="ident">guard</span>;
<span class="kw">mod</span> <span class="ident">local</span>;
<span class="kw">mod</span> <span class="ident">participant</span>;
<span class="kw">mod</span> <span class="ident">participants</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">atomic</span>::<span class="ident">Atomic</span>;
<span class="kw">pub</span> <span class="kw">use</span> <span class="self">self</span>::<span class="ident">guard</span>::{<span class="ident">pin</span>, <span class="ident">Guard</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ops</span>::{<span class="ident">Deref</span>, <span class="ident">DerefMut</span>};
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">ptr</span>;
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">mem</span>;
<span class="doccomment">/// Like `Box<T>`: an owned, heap-allocated data value of type `T`.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Owned</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">data</span>: <span class="ident">Box</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Owned</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="doccomment">/// Move `t` to a new heap allocation.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">t</span>: <span class="ident">T</span>) <span class="op">-></span> <span class="ident">Owned</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="ident">Owned</span> { <span class="ident">data</span>: <span class="ident">Box</span>::<span class="ident">new</span>(<span class="ident">t</span>) }
}
<span class="kw">fn</span> <span class="ident">as_raw</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span> {
<span class="self">self</span>.<span class="ident">deref</span>() <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> _ <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> _
}
<span class="doccomment">/// Move data out of the owned box, deallocating the box.</span>
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">into_inner</span>(<span class="self">self</span>) <span class="op">-></span> <span class="ident">T</span> {
<span class="kw-2">*</span><span class="self">self</span>.<span class="ident">data</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Owned</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="ident">T</span>;
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="ident">T</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">data</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> <span class="ident">DerefMut</span> <span class="kw">for</span> <span class="ident">Owned</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">deref_mut</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-></span> <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="ident">T</span> {
<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>.<span class="ident">data</span>
}
}
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">PartialEq</span>, <span class="ident">Eq</span>)]</span>
<span class="doccomment">/// Like `&'a T`: a shared reference valid for lifetime `'a`.</span>
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Debug</span>)]</span>
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span>: <span class="lifetime">'a</span><span class="op">></span> {
<span class="ident">data</span>: <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">T</span>,
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> <span class="ident">Copy</span> <span class="kw">for</span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> {}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> <span class="ident">Clone</span> <span class="kw">for</span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> {
<span class="kw">fn</span> <span class="ident">clone</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> {
<span class="ident">Shared</span> { <span class="ident">data</span>: <span class="self">self</span>.<span class="ident">data</span> }
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> <span class="ident">Deref</span> <span class="kw">for</span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> {
<span class="kw">type</span> <span class="ident">Target</span> <span class="op">=</span> <span class="kw-2">&</span><span class="lifetime">'a</span> <span class="ident">T</span>;
<span class="kw">fn</span> <span class="ident">deref</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="op">&&</span><span class="lifetime">'a</span> <span class="ident">T</span> {
<span class="kw-2">&</span><span class="self">self</span>.<span class="ident">data</span>
}
}
<span class="kw">impl</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> {
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_raw</span>(<span class="ident">raw</span>: <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>) <span class="op">-></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">>></span> {
<span class="kw">if</span> <span class="ident">raw</span> <span class="op">==</span> <span class="ident">ptr</span>::<span class="ident">null_mut</span>() { <span class="prelude-val">None</span> }
<span class="kw">else</span> {
<span class="prelude-val">Some</span>(<span class="ident">Shared</span> {
<span class="ident">data</span>: <span class="ident">mem</span>::<span class="ident">transmute</span>::<span class="op"><</span><span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span>, <span class="kw-2">&</span><span class="ident">T</span><span class="op">></span>(<span class="ident">raw</span>)
})
}
}
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_ref</span>(<span class="ident">r</span>: <span class="kw-2">&</span><span class="ident">T</span>) <span class="op">-></span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> {
<span class="ident">Shared</span> { <span class="ident">data</span>: <span class="ident">mem</span>::<span class="ident">transmute</span>(<span class="ident">r</span>) }
}
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">from_owned</span>(<span class="ident">owned</span>: <span class="ident">Owned</span><span class="op"><</span><span class="ident">T</span><span class="op">></span>) <span class="op">-></span> <span class="ident">Shared</span><span class="op"><</span><span class="lifetime">'a</span>, <span class="ident">T</span><span class="op">></span> {
<span class="kw">let</span> <span class="ident">ret</span> <span class="op">=</span> <span class="ident">Shared</span>::<span class="ident">from_ref</span>(<span class="ident">owned</span>.<span class="ident">deref</span>());
<span class="ident">mem</span>::<span class="ident">forget</span>(<span class="ident">owned</span>);
<span class="ident">ret</span>
}
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">as_raw</span>(<span class="kw-2">&</span><span class="self">self</span>) <span class="op">-></span> <span class="kw-2">*</span><span class="kw-2">mut</span> <span class="ident">T</span> {
<span class="self">self</span>.<span class="ident">data</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> _ <span class="kw">as</span> <span class="kw-2">*</span><span class="kw-2">mut</span> _
}
}
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
<span class="kw">mod</span> <span class="ident">test</span> {
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::<span class="ident">Ordering</span>;
<span class="kw">use</span> <span class="kw">super</span>::<span class="kw-2">*</span>;
<span class="kw">use</span> <span class="ident">epoch</span>;
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_no_drop</span>() {
<span class="kw">static</span> <span class="kw-2">mut</span> <span class="ident">DROPS</span>: <span class="ident">i32</span> <span class="op">=</span> <span class="number">0</span>;
<span class="kw">struct</span> <span class="ident">Test</span>;
<span class="kw">impl</span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">Test</span> {
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) {
<span class="kw">unsafe</span> {
<span class="ident">DROPS</span> <span class="op">+=</span> <span class="number">1</span>;
}
}
}
<span class="kw">let</span> <span class="ident">g</span> <span class="op">=</span> <span class="ident">pin</span>();
<span class="kw">let</span> <span class="ident">x</span> <span class="op">=</span> <span class="ident">Atomic</span>::<span class="ident">null</span>();
<span class="ident">x</span>.<span class="ident">store</span>(<span class="prelude-val">Some</span>(<span class="ident">Owned</span>::<span class="ident">new</span>(<span class="ident">Test</span>)), <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>);
<span class="ident">x</span>.<span class="ident">store_and_ref</span>(<span class="ident">Owned</span>::<span class="ident">new</span>(<span class="ident">Test</span>), <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>, <span class="kw-2">&</span><span class="ident">g</span>);
<span class="kw">let</span> <span class="ident">y</span> <span class="op">=</span> <span class="ident">x</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>, <span class="kw-2">&</span><span class="ident">g</span>);
<span class="kw">let</span> <span class="ident">z</span> <span class="op">=</span> <span class="ident">x</span>.<span class="ident">cas_and_ref</span>(<span class="ident">y</span>, <span class="ident">Owned</span>::<span class="ident">new</span>(<span class="ident">Test</span>), <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>, <span class="kw-2">&</span><span class="ident">g</span>).<span class="ident">ok</span>();
<span class="kw">let</span> _ <span class="op">=</span> <span class="ident">x</span>.<span class="ident">cas</span>(<span class="ident">z</span>, <span class="prelude-val">Some</span>(<span class="ident">Owned</span>::<span class="ident">new</span>(<span class="ident">Test</span>)), <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>);
<span class="ident">x</span>.<span class="ident">swap</span>(<span class="prelude-val">Some</span>(<span class="ident">Owned</span>::<span class="ident">new</span>(<span class="ident">Test</span>)), <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>, <span class="kw-2">&</span><span class="ident">g</span>);
<span class="kw">unsafe</span> {
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">DROPS</span>, <span class="number">0</span>);
}
}
<span class="attribute">#[<span class="ident">test</span>]</span>
<span class="kw">fn</span> <span class="ident">test_new</span>() {
<span class="kw">let</span> <span class="ident">guard</span> <span class="op">=</span> <span class="ident">epoch</span>::<span class="ident">pin</span>();
<span class="kw">let</span> <span class="ident">my_atomic</span> <span class="op">=</span> <span class="ident">Atomic</span>::<span class="ident">new</span>(<span class="number">42</span>);
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">my_atomic</span>.<span class="ident">load</span>(<span class="ident">Ordering</span>::<span class="ident">Relaxed</span>, <span class="kw-2">&</span><span class="ident">guard</span>).<span class="ident">unwrap</span>(), <span class="number">42</span>);
}
}
</pre>
</section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt><kbd>?</kbd></dt>
<dd>Show this help dialog</dd>
<dt><kbd>S</kbd></dt>
<dd>Focus the search field</dd>
<dt><kbd>↑</kbd></dt>
<dd>Move up in search results</dd>
<dt><kbd>↓</kbd></dt>
<dd>Move down in search results</dd>
<dt><kbd>↹</kbd></dt>
<dd>Switch tab</dd>
<dt><kbd>⏎</kbd></dt>
<dd>Go to active search result</dd>
<dt><kbd>+</kbd></dt>
<dd>Expand all sections</dd>
<dt><kbd>-</kbd></dt>
<dd>Collapse all sections</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "crossbeam";
</script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>