src/liballoc/arc.rs

   1 // Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 /*!
  12  * Concurrency-enabled mechanisms for sharing mutable and/or immutable state
  13  * between tasks.
  14  */
  15
  16 use core::atomics;
  17 use core::clone::Clone;
  18 use core::kinds::{Share, Send};
  19 use core::mem::{min_align_of, size_of, drop};
  20 use core::mem;
  21 use core::ops::{Drop, Deref};
  22 use core::option::{Some, None, Option};
  23 use core::ptr;
  24 use core::ptr::RawPtr;
  25 use heap::deallocate;
  26
  27 /// An atomically reference counted wrapper for shared state.
  28 ///
  29 /// # Example
  30 ///
  31 /// In this example, a large vector of floats is shared between several tasks.
  32 /// With simple pipes, without `Arc`, a copy would have to be made for each
  33 /// task.
  34 ///
  35 /// ```rust
  36 /// extern crate sync;
  37 ///
  38 /// use sync::Arc;
  39 ///
  40 /// fn main() {
  41 ///     let numbers = Vec::from_fn(100, |i| i as f32);
  42 ///     let shared_numbers = Arc::new(numbers);
  43 ///
  44 ///     for _ in range(0, 10) {
  45 ///         let child_numbers = shared_numbers.clone();
  46 ///
  47 ///         spawn(proc() {
  48 ///             let local_numbers = child_numbers.as_slice();
  49 ///
  50 ///             // Work with the local numbers
  51 ///         });
  52 ///     }
  53 /// }
  54 /// ```
  55 #[unsafe_no_drop_flag]
  56 pub struct Arc<T> {
  57     // FIXME #12808: strange name to try to avoid interfering with
  58     // field accesses of the contained type via Deref
  59     _ptr: *mut ArcInner<T>,
  60 }
  61
  62 /// A weak pointer to an `Arc`.
  63 ///
  64 /// Weak pointers will not keep the data inside of the `Arc` alive, and can be
  65 /// used to break cycles between `Arc` pointers.
  66 #[unsafe_no_drop_flag]
  67 pub struct Weak<T> {
  68     // FIXME #12808: strange name to try to avoid interfering with
  69     // field accesses of the contained type via Deref
  70     _ptr: *mut ArcInner<T>,
  71 }
  72
  73 struct ArcInner<T> {
  74     strong: atomics::AtomicUint,
  75     weak: atomics::AtomicUint,
  76     data: T,
  77 }
  78
  79 impl<T: Share + Send> Arc<T> {
  80     /// Create an atomically reference counted wrapper.
  81     #[inline]
  82     pub fn new(data: T) -> Arc<T> {
  83         // Start the weak pointer count as 1 which is the weak pointer that's
  84         // held by all the strong pointers (kinda), see std/rc.rs for more info
  85         let x = box ArcInner {
  86             strong: atomics::AtomicUint::new(1),
  87             weak: atomics::AtomicUint::new(1),
  88             data: data,
  89         };
  90         Arc { _ptr: unsafe { mem::transmute(x) } }
  91     }
  92
  93     #[inline]
  94     fn inner<'a>(&'a self) -> &'a ArcInner<T> {
  95         // This unsafety is ok because while this arc is alive we're guaranteed
  96         // that the inner pointer is valid. Furthermore, we know that the
  97         // `ArcInner` structure itself is `Share` because the inner data is
  98         // `Share` as well, so we're ok loaning out an immutable pointer to
  99         // these contents.
 100         unsafe { &*self._ptr }
 101     }
 102
 103     /// Downgrades a strong pointer to a weak pointer
 104     ///
 105     /// Weak pointers will not keep the data alive. Once all strong references
 106     /// to the underlying data have been dropped, the data itself will be
 107     /// destroyed.
 108     pub fn downgrade(&self) -> Weak<T> {
 109         // See the clone() impl for why this is relaxed
 110         self.inner().weak.fetch_add(1, atomics::Relaxed);
 111         Weak { _ptr: self._ptr }
 112     }
 113 }
 114
 115 impl<T: Share + Send> Clone for Arc<T> {
 116     /// Duplicate an atomically reference counted wrapper.
 117     ///
 118     /// The resulting two `Arc` objects will point to the same underlying data
 119     /// object. However, one of the `Arc` objects can be sent to another task,
 120     /// allowing them to share the underlying data.
 121     #[inline]
 122     fn clone(&self) -> Arc<T> {
 123         // Using a relaxed ordering is alright here, as knowledge of the
 124         // original reference prevents other threads from erroneously deleting
 125         // the object.
 126         //
 127         // As explained in the [Boost documentation][1], Increasing the
 128         // reference counter can always be done with memory_order_relaxed: New
 129         // references to an object can only be formed from an existing
 130         // reference, and passing an existing reference from one thread to
 131         // another must already provide any required synchronization.
 132         //
 133         // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
 134         self.inner().strong.fetch_add(1, atomics::Relaxed);
 135         Arc { _ptr: self._ptr }
 136     }
 137 }
 138
 139 impl<T: Send + Share> Deref<T> for Arc<T> {
 140     #[inline]
 141     fn deref<'a>(&'a self) -> &'a T {
 142         &self.inner().data
 143     }
 144 }
 145
 146 impl<T: Send + Share + Clone> Arc<T> {
 147     /// Acquires a mutable pointer to the inner contents by guaranteeing that
 148     /// the reference count is one (no sharing is possible).
 149     ///
 150     /// This is also referred to as a copy-on-write operation because the inner
 151     /// data is cloned if the reference count is greater than one.
 152     #[inline]
 153     #[experimental]
 154     pub fn make_unique<'a>(&'a mut self) -> &'a mut T {
 155         // Note that we hold a strong reference, which also counts as
 156         // a weak reference, so we only clone if there is an
 157         // additional reference of either kind.
 158         if self.inner().strong.load(atomics::SeqCst) != 1 ||
 159            self.inner().weak.load(atomics::SeqCst) != 1 {
 160             *self = Arc::new(self.deref().clone())
 161         }
 162         // This unsafety is ok because we're guaranteed that the pointer
 163         // returned is the *only* pointer that will ever be returned to T. Our
 164         // reference count is guaranteed to be 1 at this point, and we required
 165         // the Arc itself to be `mut`, so we're returning the only possible
 166         // reference to the inner data.
 167         let inner = unsafe { &mut *self._ptr };
 168         &mut inner.data
 169     }
 170 }
 171
 172 #[unsafe_destructor]
 173 impl<T: Share + Send> Drop for Arc<T> {
 174     fn drop(&mut self) {
 175         // This structure has #[unsafe_no_drop_flag], so this drop glue may run
 176         // more than once (but it is guaranteed to be zeroed after the first if
 177         // it's run more than once)
 178         if self._ptr.is_null() { return }
 179
 180         // Because `fetch_sub` is already atomic, we do not need to synchronize
 181         // with other threads unless we are going to delete the object. This
 182         // same logic applies to the below `fetch_sub` to the `weak` count.
 183         if self.inner().strong.fetch_sub(1, atomics::Release) != 1 { return }
 184
 185         // This fence is needed to prevent reordering of use of the data and
 186         // deletion of the data. Because it is marked `Release`, the
 187         // decreasing of the reference count synchronizes with this `Acquire`
 188         // fence. This means that use of the data happens before decreasing
 189         // the refernce count, which happens before this fence, which
 190         // happens before the deletion of the data.
 191         //
 192         // As explained in the [Boost documentation][1],
 193         //
 194         // It is important to enforce any possible access to the object in
 195         // one thread (through an existing reference) to *happen before*
 196         // deleting the object in a different thread. This is achieved by a
 197         // "release" operation after dropping a reference (any access to the
 198         // object through this reference must obviously happened before),
 199         // and an "acquire" operation before deleting the object.
 200         //
 201         // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
 202         atomics::fence(atomics::Acquire);
 203
 204         // Destroy the data at this time, even though we may not free the box
 205         // allocation itself (there may still be weak pointers lying around).
 206         unsafe { drop(ptr::read(&self.inner().data)); }
 207
 208         if self.inner().weak.fetch_sub(1, atomics::Release) == 1 {
 209             atomics::fence(atomics::Acquire);
 210             unsafe { deallocate(self._ptr as *mut u8, size_of::<ArcInner<T>>(),
 211                                 min_align_of::<ArcInner<T>>()) }
 212         }
 213     }
 214 }
 215
 216 impl<T: Share + Send> Weak<T> {
 217     /// Attempts to upgrade this weak reference to a strong reference.
 218     ///
 219     /// This method will fail to upgrade this reference if the strong reference
 220     /// count has already reached 0, but if there are still other active strong
 221     /// references this function will return a new strong reference to the data
 222     pub fn upgrade(&self) -> Option<Arc<T>> {
 223         // We use a CAS loop to increment the strong count instead of a
 224         // fetch_add because once the count hits 0 is must never be above 0.
 225         let inner = self.inner();
 226         loop {
 227             let n = inner.strong.load(atomics::SeqCst);
 228             if n == 0 { return None }
 229             let old = inner.strong.compare_and_swap(n, n + 1, atomics::SeqCst);
 230             if old == n { return Some(Arc { _ptr: self._ptr }) }
 231         }
 232     }
 233
 234     #[inline]
 235     fn inner<'a>(&'a self) -> &'a ArcInner<T> {
 236         // See comments above for why this is "safe"
 237         unsafe { &*self._ptr }
 238     }
 239 }
 240
 241 impl<T: Share + Send> Clone for Weak<T> {
 242     #[inline]
 243     fn clone(&self) -> Weak<T> {
 244         // See comments in Arc::clone() for why this is relaxed
 245         self.inner().weak.fetch_add(1, atomics::Relaxed);
 246         Weak { _ptr: self._ptr }
 247     }
 248 }
 249
 250 #[unsafe_destructor]
 251 impl<T: Share + Send> Drop for Weak<T> {
 252     fn drop(&mut self) {
 253         // see comments above for why this check is here
 254         if self._ptr.is_null() { return }
 255
 256         // If we find out that we were the last weak pointer, then its time to
 257         // deallocate the data entirely. See the discussion in Arc::drop() about
 258         // the memory orderings
 259         if self.inner().weak.fetch_sub(1, atomics::Release) == 1 {
 260             atomics::fence(atomics::Acquire);
 261             unsafe { deallocate(self._ptr as *mut u8, size_of::<ArcInner<T>>(),
 262                                 min_align_of::<ArcInner<T>>()) }
 263         }
 264     }
 265 }
 266
 267 #[cfg(test)]
 268 #[allow(experimental)]
 269 mod tests {
 270     use std::clone::Clone;
 271     use std::comm::channel;
 272     use std::mem::drop;
 273     use std::ops::Drop;
 274     use std::option::{Option, Some, None};
 275     use std::sync::atomics;
 276     use std::task;
 277     use std::vec::Vec;
 278     use super::{Arc, Weak};
 279     use sync::Mutex;
 280
 281     struct Canary(*mut atomics::AtomicUint);
 282
 283     impl Drop for Canary
 284     {
 285         fn drop(&mut self) {
 286             unsafe {
 287                 match *self {
 288                     Canary(c) => {
 289                         (*c).fetch_add(1, atomics::SeqCst);
 290                     }
 291                 }
 292             }
 293         }
 294     }
 295
 296     #[test]
 297     fn manually_share_arc() {
 298         let v = vec!(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
 299         let arc_v = Arc::new(v);
 300
 301         let (tx, rx) = channel();
 302
 303         task::spawn(proc() {
 304             let arc_v: Arc<Vec<int>> = rx.recv();
 305             assert_eq!(*arc_v.get(3), 4);
 306         });
 307
 308         tx.send(arc_v.clone());
 309
 310         assert_eq!(*arc_v.get(2), 3);
 311         assert_eq!(*arc_v.get(4), 5);
 312
 313         info!("{:?}", arc_v);
 314     }
 315
 316     #[test]
 317     fn test_cowarc_clone_make_unique() {
 318         let mut cow0 = Arc::new(75u);
 319         let mut cow1 = cow0.clone();
 320         let mut cow2 = cow1.clone();
 321
 322         assert!(75 == *cow0.make_unique());
 323         assert!(75 == *cow1.make_unique());
 324         assert!(75 == *cow2.make_unique());
 325
 326         *cow0.make_unique() += 1;
 327         *cow1.make_unique() += 2;
 328         *cow2.make_unique() += 3;
 329
 330         assert!(76 == *cow0);
 331         assert!(77 == *cow1);
 332         assert!(78 == *cow2);
 333
 334         // none should point to the same backing memory
 335         assert!(*cow0 != *cow1);
 336         assert!(*cow0 != *cow2);
 337         assert!(*cow1 != *cow2);
 338     }
 339
 340     #[test]
 341     fn test_cowarc_clone_unique2() {
 342         let mut cow0 = Arc::new(75u);
 343         let cow1 = cow0.clone();
 344         let cow2 = cow1.clone();
 345
 346         assert!(75 == *cow0);
 347         assert!(75 == *cow1);
 348         assert!(75 == *cow2);
 349
 350         *cow0.make_unique() += 1;
 351
 352         assert!(76 == *cow0);
 353         assert!(75 == *cow1);
 354         assert!(75 == *cow2);
 355
 356         // cow1 and cow2 should share the same contents
 357         // cow0 should have a unique reference
 358         assert!(*cow0 != *cow1);
 359         assert!(*cow0 != *cow2);
 360         assert!(*cow1 == *cow2);
 361     }
 362
 363     #[test]
 364     fn test_cowarc_clone_weak() {
 365         let mut cow0 = Arc::new(75u);
 366         let cow1_weak = cow0.downgrade();
 367
 368         assert!(75 == *cow0);
 369         assert!(75 == *cow1_weak.upgrade().unwrap());
 370
 371         *cow0.make_unique() += 1;
 372
 373         assert!(76 == *cow0);
 374         assert!(cow1_weak.upgrade().is_none());
 375     }
 376
 377     #[test]
 378     fn test_live() {
 379         let x = Arc::new(5);
 380         let y = x.downgrade();
 381         assert!(y.upgrade().is_some());
 382     }
 383
 384     #[test]
 385     fn test_dead() {
 386         let x = Arc::new(5);
 387         let y = x.downgrade();
 388         drop(x);
 389         assert!(y.upgrade().is_none());
 390     }
 391
 392     #[test]
 393     fn weak_self_cyclic() {
 394         struct Cycle {
 395             x: Mutex<Option<Weak<Cycle>>>
 396         }
 397
 398         let a = Arc::new(Cycle { x: Mutex::new(None) });
 399         let b = a.clone().downgrade();
 400         *a.x.lock() = Some(b);
 401
 402         // hopefully we don't double-free (or leak)...
 403     }
 404
 405     #[test]
 406     fn drop_arc() {
 407         let mut canary = atomics::AtomicUint::new(0);
 408         let x = Arc::new(Canary(&mut canary as *mut atomics::AtomicUint));
 409         drop(x);
 410         assert!(canary.load(atomics::Acquire) == 1);
 411     }
 412
 413     #[test]
 414     fn drop_arc_weak() {
 415         let mut canary = atomics::AtomicUint::new(0);
 416         let arc = Arc::new(Canary(&mut canary as *mut atomics::AtomicUint));
 417         let arc_weak = arc.downgrade();
 418         assert!(canary.load(atomics::Acquire) == 0);
 419         drop(arc);
 420         assert!(canary.load(atomics::Acquire) == 1);
 421         drop(arc_weak);
 422     }
 423 }