1 #![stable(feature = "rust1", since = "1.0.0")]
3 //! Thread-safe reference-counting pointers.
5 //! See the [`Arc<T>`][arc] documentation for more details.
7 //! [arc]: struct.Arc.html
10 use core::array::LengthAtMost32;
11 use core::sync::atomic;
12 use core::sync::atomic::Ordering::{Acquire, Relaxed, Release, SeqCst};
15 use core::cmp::{self, Ordering};
17 use core::intrinsics::abort;
18 use core::mem::{self, align_of, align_of_val, size_of_val};
19 use core::ops::{Deref, Receiver, CoerceUnsized, DispatchFromDyn};
21 use core::ptr::{self, NonNull};
22 use core::marker::{Unpin, Unsize, PhantomData};
23 use core::hash::{Hash, Hasher};
24 use core::{isize, usize};
25 use core::convert::{From, TryFrom};
26 use core::slice::{self, from_raw_parts_mut};
28 use crate::alloc::{Global, Alloc, Layout, box_free, handle_alloc_error};
29 use crate::boxed::Box;
30 use crate::rc::is_dangling;
31 use crate::string::String;
37 /// A soft limit on the amount of references that may be made to an `Arc`.
39 /// Going above this limit will abort your program (although not
40 /// necessarily) at _exactly_ `MAX_REFCOUNT + 1` references.
41 const MAX_REFCOUNT: usize = (isize::MAX) as usize;
43 /// A thread-safe reference-counting pointer. 'Arc' stands for 'Atomically
44 /// Reference Counted'.
46 /// The type `Arc<T>` provides shared ownership of a value of type `T`,
47 /// allocated in the heap. Invoking [`clone`][clone] on `Arc` produces
48 /// a new `Arc` instance, which points to the same allocation on the heap as the
49 /// source `Arc`, while increasing a reference count. When the last `Arc`
50 /// pointer to a given allocation is destroyed, the value stored in that allocation (often
51 /// referred to as "inner value") is also dropped.
53 /// Shared references in Rust disallow mutation by default, and `Arc` is no
54 /// exception: you cannot generally obtain a mutable reference to something
55 /// inside an `Arc`. If you need to mutate through an `Arc`, use
56 /// [`Mutex`][mutex], [`RwLock`][rwlock], or one of the [`Atomic`][atomic]
61 /// Unlike [`Rc<T>`], `Arc<T>` uses atomic operations for its reference
62 /// counting. This means that it is thread-safe. The disadvantage is that
63 /// atomic operations are more expensive than ordinary memory accesses. If you
64 /// are not sharing reference-counted allocations between threads, consider using
65 /// [`Rc<T>`] for lower overhead. [`Rc<T>`] is a safe default, because the
66 /// compiler will catch any attempt to send an [`Rc<T>`] between threads.
67 /// However, a library might choose `Arc<T>` in order to give library consumers
70 /// `Arc<T>` will implement [`Send`] and [`Sync`] as long as the `T` implements
71 /// [`Send`] and [`Sync`]. Why can't you put a non-thread-safe type `T` in an
72 /// `Arc<T>` to make it thread-safe? This may be a bit counter-intuitive at
73 /// first: after all, isn't the point of `Arc<T>` thread safety? The key is
74 /// this: `Arc<T>` makes it thread safe to have multiple ownership of the same
75 /// data, but it doesn't add thread safety to its data. Consider
76 /// `Arc<`[`RefCell<T>`]`>`. [`RefCell<T>`] isn't [`Sync`], and if `Arc<T>` was always
77 /// [`Send`], `Arc<`[`RefCell<T>`]`>` would be as well. But then we'd have a problem:
78 /// [`RefCell<T>`] is not thread safe; it keeps track of the borrowing count using
79 /// non-atomic operations.
81 /// In the end, this means that you may need to pair `Arc<T>` with some sort of
82 /// [`std::sync`] type, usually [`Mutex<T>`][mutex].
84 /// ## Breaking cycles with `Weak`
86 /// The [`downgrade`][downgrade] method can be used to create a non-owning
87 /// [`Weak`][weak] pointer. A [`Weak`][weak] pointer can be [`upgrade`][upgrade]d
88 /// to an `Arc`, but this will return [`None`] if the value stored in the allocation has
89 /// already been dropped. In other words, `Weak` pointers do not keep the value
90 /// inside the allocation alive; however, they *do* keep the allocation
91 /// (the backing store for the value) alive.
93 /// A cycle between `Arc` pointers will never be deallocated. For this reason,
94 /// [`Weak`][weak] is used to break cycles. For example, a tree could have
95 /// strong `Arc` pointers from parent nodes to children, and [`Weak`][weak]
96 /// pointers from children back to their parents.
98 /// # Cloning references
100 /// Creating a new reference from an existing reference counted pointer is done using the
101 /// `Clone` trait implemented for [`Arc<T>`][arc] and [`Weak<T>`][weak].
104 /// use std::sync::Arc;
105 /// let foo = Arc::new(vec![1.0, 2.0, 3.0]);
106 /// // The two syntaxes below are equivalent.
107 /// let a = foo.clone();
108 /// let b = Arc::clone(&foo);
109 /// // a, b, and foo are all Arcs that point to the same memory location
112 /// ## `Deref` behavior
114 /// `Arc<T>` automatically dereferences to `T` (via the [`Deref`][deref] trait),
115 /// so you can call `T`'s methods on a value of type `Arc<T>`. To avoid name
116 /// clashes with `T`'s methods, the methods of `Arc<T>` itself are associated
117 /// functions, called using function-like syntax:
120 /// use std::sync::Arc;
121 /// let my_arc = Arc::new(());
123 /// Arc::downgrade(&my_arc);
126 /// [`Weak<T>`][weak] does not auto-dereference to `T`, because the inner value may have
127 /// already been dropped.
129 /// [arc]: struct.Arc.html
130 /// [weak]: struct.Weak.html
131 /// [`Rc<T>`]: ../../std/rc/struct.Rc.html
132 /// [clone]: ../../std/clone/trait.Clone.html#tymethod.clone
133 /// [mutex]: ../../std/sync/struct.Mutex.html
134 /// [rwlock]: ../../std/sync/struct.RwLock.html
135 /// [atomic]: ../../std/sync/atomic/index.html
136 /// [`Send`]: ../../std/marker/trait.Send.html
137 /// [`Sync`]: ../../std/marker/trait.Sync.html
138 /// [deref]: ../../std/ops/trait.Deref.html
139 /// [downgrade]: struct.Arc.html#method.downgrade
140 /// [upgrade]: struct.Weak.html#method.upgrade
141 /// [`None`]: ../../std/option/enum.Option.html#variant.None
142 /// [`RefCell<T>`]: ../../std/cell/struct.RefCell.html
143 /// [`std::sync`]: ../../std/sync/index.html
144 /// [`Arc::clone(&from)`]: #method.clone
148 /// Sharing some immutable data between threads:
150 // Note that we **do not** run these tests here. The windows builders get super
151 // unhappy if a thread outlives the main thread and then exits at the same time
152 // (something deadlocks) so we just avoid this entirely by not running these
155 /// use std::sync::Arc;
158 /// let five = Arc::new(5);
161 /// let five = Arc::clone(&five);
163 /// thread::spawn(move || {
164 /// println!("{:?}", five);
169 /// Sharing a mutable [`AtomicUsize`]:
171 /// [`AtomicUsize`]: ../../std/sync/atomic/struct.AtomicUsize.html
174 /// use std::sync::Arc;
175 /// use std::sync::atomic::{AtomicUsize, Ordering};
178 /// let val = Arc::new(AtomicUsize::new(5));
181 /// let val = Arc::clone(&val);
183 /// thread::spawn(move || {
184 /// let v = val.fetch_add(1, Ordering::SeqCst);
185 /// println!("{:?}", v);
190 /// See the [`rc` documentation][rc_examples] for more examples of reference
191 /// counting in general.
193 /// [rc_examples]: ../../std/rc/index.html#examples
194 #[cfg_attr(not(test), lang = "arc")]
195 #[stable(feature = "rust1", since = "1.0.0")]
196 pub struct Arc<T: ?Sized> {
197 ptr: NonNull<ArcInner<T>>,
198 phantom: PhantomData<ArcInner<T>>,
201 #[stable(feature = "rust1", since = "1.0.0")]
202 unsafe impl<T: ?Sized + Sync + Send> Send for Arc<T> {}
203 #[stable(feature = "rust1", since = "1.0.0")]
204 unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {}
206 #[unstable(feature = "coerce_unsized", issue = "27732")]
207 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Arc<U>> for Arc<T> {}
209 #[unstable(feature = "dispatch_from_dyn", issue = "0")]
210 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Arc<U>> for Arc<T> {}
212 impl<T: ?Sized> Arc<T> {
213 fn from_inner(ptr: NonNull<ArcInner<T>>) -> Self {
216 phantom: PhantomData,
220 unsafe fn from_ptr(ptr: *mut ArcInner<T>) -> Self {
221 Self::from_inner(NonNull::new_unchecked(ptr))
225 /// `Weak` is a version of [`Arc`] that holds a non-owning reference to the
226 /// managed allocation. The allocation is accessed by calling [`upgrade`] on the `Weak`
227 /// pointer, which returns an [`Option`]`<`[`Arc`]`<T>>`.
229 /// Since a `Weak` reference does not count towards ownership, it will not
230 /// prevent the value stored in the allocation from being dropped, and `Weak` itself makes no
231 /// guarantees about the value still being present. Thus it may return [`None`]
232 /// when [`upgrade`]d. Note however that a `Weak` reference *does* prevent the allocation
233 /// itself (the backing store) from being deallocated.
235 /// A `Weak` pointer is useful for keeping a temporary reference to the allocation
236 /// managed by [`Arc`] without preventing its inner value from being dropped. It is also used to
237 /// prevent circular references between [`Arc`] pointers, since mutual owning references
238 /// would never allow either [`Arc`] to be dropped. For example, a tree could
239 /// have strong [`Arc`] pointers from parent nodes to children, and `Weak`
240 /// pointers from children back to their parents.
242 /// The typical way to obtain a `Weak` pointer is to call [`Arc::downgrade`].
244 /// [`Arc`]: struct.Arc.html
245 /// [`Arc::downgrade`]: struct.Arc.html#method.downgrade
246 /// [`upgrade`]: struct.Weak.html#method.upgrade
247 /// [`Option`]: ../../std/option/enum.Option.html
248 /// [`None`]: ../../std/option/enum.Option.html#variant.None
249 #[stable(feature = "arc_weak", since = "1.4.0")]
250 pub struct Weak<T: ?Sized> {
251 // This is a `NonNull` to allow optimizing the size of this type in enums,
252 // but it is not necessarily a valid pointer.
253 // `Weak::new` sets this to `usize::MAX` so that it doesn’t need
254 // to allocate space on the heap. That's not a value a real pointer
255 // will ever have because RcBox has alignment at least 2.
256 ptr: NonNull<ArcInner<T>>,
259 #[stable(feature = "arc_weak", since = "1.4.0")]
260 unsafe impl<T: ?Sized + Sync + Send> Send for Weak<T> {}
261 #[stable(feature = "arc_weak", since = "1.4.0")]
262 unsafe impl<T: ?Sized + Sync + Send> Sync for Weak<T> {}
264 #[unstable(feature = "coerce_unsized", issue = "27732")]
265 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Weak<U>> for Weak<T> {}
266 #[unstable(feature = "dispatch_from_dyn", issue = "0")]
267 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Weak<U>> for Weak<T> {}
269 #[stable(feature = "arc_weak", since = "1.4.0")]
270 impl<T: ?Sized + fmt::Debug> fmt::Debug for Weak<T> {
271 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
276 struct ArcInner<T: ?Sized> {
277 strong: atomic::AtomicUsize,
279 // the value usize::MAX acts as a sentinel for temporarily "locking" the
280 // ability to upgrade weak pointers or downgrade strong ones; this is used
281 // to avoid races in `make_mut` and `get_mut`.
282 weak: atomic::AtomicUsize,
287 unsafe impl<T: ?Sized + Sync + Send> Send for ArcInner<T> {}
288 unsafe impl<T: ?Sized + Sync + Send> Sync for ArcInner<T> {}
291 /// Constructs a new `Arc<T>`.
296 /// use std::sync::Arc;
298 /// let five = Arc::new(5);
301 #[stable(feature = "rust1", since = "1.0.0")]
302 pub fn new(data: T) -> Arc<T> {
303 // Start the weak pointer count as 1 which is the weak pointer that's
304 // held by all the strong pointers (kinda), see std/rc.rs for more info
305 let x: Box<_> = box ArcInner {
306 strong: atomic::AtomicUsize::new(1),
307 weak: atomic::AtomicUsize::new(1),
310 Self::from_inner(Box::into_raw_non_null(x))
313 /// Constructs a new `Arc` with uninitialized contents.
318 /// #![feature(new_uninit)]
319 /// #![feature(get_mut_unchecked)]
321 /// use std::sync::Arc;
323 /// let mut five = Arc::<u32>::new_uninit();
325 /// let five = unsafe {
326 /// // Deferred initialization:
327 /// Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
329 /// five.assume_init()
332 /// assert_eq!(*five, 5)
334 #[unstable(feature = "new_uninit", issue = "63291")]
335 pub fn new_uninit() -> Arc<mem::MaybeUninit<T>> {
337 Arc::from_ptr(Arc::allocate_for_layout(
339 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
344 /// Constructs a new `Arc` with uninitialized contents, with the memory
345 /// being filled with `0` bytes.
347 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
353 /// #![feature(new_uninit)]
355 /// use std::sync::Arc;
357 /// let zero = Arc::<u32>::new_zeroed();
358 /// let zero = unsafe { zero.assume_init() };
360 /// assert_eq!(*zero, 0)
363 /// [zeroed]: ../../std/mem/union.MaybeUninit.html#method.zeroed
364 #[unstable(feature = "new_uninit", issue = "63291")]
365 pub fn new_zeroed() -> Arc<mem::MaybeUninit<T>> {
367 let mut uninit = Self::new_uninit();
368 ptr::write_bytes::<T>(Arc::get_mut_unchecked(&mut uninit).as_mut_ptr(), 0, 1);
373 /// Constructs a new `Pin<Arc<T>>`. If `T` does not implement `Unpin`, then
374 /// `data` will be pinned in memory and unable to be moved.
375 #[stable(feature = "pin", since = "1.33.0")]
376 pub fn pin(data: T) -> Pin<Arc<T>> {
377 unsafe { Pin::new_unchecked(Arc::new(data)) }
380 /// Returns the inner value, if the `Arc` has exactly one strong reference.
382 /// Otherwise, an [`Err`][result] is returned with the same `Arc` that was
385 /// This will succeed even if there are outstanding weak references.
387 /// [result]: ../../std/result/enum.Result.html
392 /// use std::sync::Arc;
394 /// let x = Arc::new(3);
395 /// assert_eq!(Arc::try_unwrap(x), Ok(3));
397 /// let x = Arc::new(4);
398 /// let _y = Arc::clone(&x);
399 /// assert_eq!(*Arc::try_unwrap(x).unwrap_err(), 4);
402 #[stable(feature = "arc_unique", since = "1.4.0")]
403 pub fn try_unwrap(this: Self) -> Result<T, Self> {
404 // See `drop` for why all these atomics are like this
405 if this.inner().strong.compare_exchange(1, 0, Release, Relaxed).is_err() {
409 atomic::fence(Acquire);
412 let elem = ptr::read(&this.ptr.as_ref().data);
414 // Make a weak pointer to clean up the implicit strong-weak reference
415 let _weak = Weak { ptr: this.ptr };
424 /// Constructs a new reference-counted slice with uninitialized contents.
429 /// #![feature(new_uninit)]
430 /// #![feature(get_mut_unchecked)]
432 /// use std::sync::Arc;
434 /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
436 /// let values = unsafe {
437 /// // Deferred initialization:
438 /// Arc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
439 /// Arc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
440 /// Arc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);
442 /// values.assume_init()
445 /// assert_eq!(*values, [1, 2, 3])
447 #[unstable(feature = "new_uninit", issue = "63291")]
448 pub fn new_uninit_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
450 Arc::from_ptr(Arc::allocate_for_slice(len))
455 impl<T> Arc<mem::MaybeUninit<T>> {
456 /// Converts to `Arc<T>`.
460 /// As with [`MaybeUninit::assume_init`],
461 /// it is up to the caller to guarantee that the inner value
462 /// really is in an initialized state.
463 /// Calling this when the content is not yet fully initialized
464 /// causes immediate undefined behavior.
466 /// [`MaybeUninit::assume_init`]: ../../std/mem/union.MaybeUninit.html#method.assume_init
471 /// #![feature(new_uninit)]
472 /// #![feature(get_mut_unchecked)]
474 /// use std::sync::Arc;
476 /// let mut five = Arc::<u32>::new_uninit();
478 /// let five = unsafe {
479 /// // Deferred initialization:
480 /// Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
482 /// five.assume_init()
485 /// assert_eq!(*five, 5)
487 #[unstable(feature = "new_uninit", issue = "63291")]
489 pub unsafe fn assume_init(self) -> Arc<T> {
490 Arc::from_inner(mem::ManuallyDrop::new(self).ptr.cast())
494 impl<T> Arc<[mem::MaybeUninit<T>]> {
495 /// Converts to `Arc<[T]>`.
499 /// As with [`MaybeUninit::assume_init`],
500 /// it is up to the caller to guarantee that the inner value
501 /// really is in an initialized state.
502 /// Calling this when the content is not yet fully initialized
503 /// causes immediate undefined behavior.
505 /// [`MaybeUninit::assume_init`]: ../../std/mem/union.MaybeUninit.html#method.assume_init
510 /// #![feature(new_uninit)]
511 /// #![feature(get_mut_unchecked)]
513 /// use std::sync::Arc;
515 /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
517 /// let values = unsafe {
518 /// // Deferred initialization:
519 /// Arc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
520 /// Arc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
521 /// Arc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);
523 /// values.assume_init()
526 /// assert_eq!(*values, [1, 2, 3])
528 #[unstable(feature = "new_uninit", issue = "63291")]
530 pub unsafe fn assume_init(self) -> Arc<[T]> {
531 Arc::from_ptr(mem::ManuallyDrop::new(self).ptr.as_ptr() as _)
535 impl<T: ?Sized> Arc<T> {
536 /// Consumes the `Arc`, returning the wrapped pointer.
538 /// To avoid a memory leak the pointer must be converted back to an `Arc` using
539 /// [`Arc::from_raw`][from_raw].
541 /// [from_raw]: struct.Arc.html#method.from_raw
546 /// use std::sync::Arc;
548 /// let x = Arc::new("hello".to_owned());
549 /// let x_ptr = Arc::into_raw(x);
550 /// assert_eq!(unsafe { &*x_ptr }, "hello");
552 #[stable(feature = "rc_raw", since = "1.17.0")]
553 pub fn into_raw(this: Self) -> *const T {
554 let ptr: *mut ArcInner<T> = NonNull::as_ptr(this.ptr);
555 let fake_ptr = ptr as *mut T;
558 // SAFETY: This cannot go through Deref::deref.
559 // Instead, we manually offset the pointer rather than manifesting a reference.
560 // This is so that the returned pointer retains the same provenance as our pointer.
561 // This is required so that e.g. `get_mut` can write through the pointer
562 // after the Arc is recovered through `from_raw`.
564 let offset = data_offset(&(*ptr).data);
565 set_data_ptr(fake_ptr, (ptr as *mut u8).offset(offset))
569 /// Constructs an `Arc` from a raw pointer.
571 /// The raw pointer must have been previously returned by a call to a
572 /// [`Arc::into_raw`][into_raw].
574 /// This function is unsafe because improper use may lead to memory problems. For example, a
575 /// double-free may occur if the function is called twice on the same raw pointer.
577 /// [into_raw]: struct.Arc.html#method.into_raw
582 /// use std::sync::Arc;
584 /// let x = Arc::new("hello".to_owned());
585 /// let x_ptr = Arc::into_raw(x);
588 /// // Convert back to an `Arc` to prevent leak.
589 /// let x = Arc::from_raw(x_ptr);
590 /// assert_eq!(&*x, "hello");
592 /// // Further calls to `Arc::from_raw(x_ptr)` would be memory-unsafe.
595 /// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
597 #[stable(feature = "rc_raw", since = "1.17.0")]
598 pub unsafe fn from_raw(ptr: *const T) -> Self {
599 let offset = data_offset(ptr);
601 // Reverse the offset to find the original ArcInner.
602 let fake_ptr = ptr as *mut ArcInner<T>;
603 let arc_ptr = set_data_ptr(fake_ptr, (ptr as *mut u8).offset(-offset));
605 Self::from_ptr(arc_ptr)
608 /// Consumes the `Arc`, returning the wrapped pointer as `NonNull<T>`.
613 /// #![feature(rc_into_raw_non_null)]
615 /// use std::sync::Arc;
617 /// let x = Arc::new("hello".to_owned());
618 /// let ptr = Arc::into_raw_non_null(x);
619 /// let deref = unsafe { ptr.as_ref() };
620 /// assert_eq!(deref, "hello");
622 #[unstable(feature = "rc_into_raw_non_null", issue = "47336")]
624 pub fn into_raw_non_null(this: Self) -> NonNull<T> {
625 // safe because Arc guarantees its pointer is non-null
626 unsafe { NonNull::new_unchecked(Arc::into_raw(this) as *mut _) }
629 /// Creates a new [`Weak`][weak] pointer to this allocation.
631 /// [weak]: struct.Weak.html
636 /// use std::sync::Arc;
638 /// let five = Arc::new(5);
640 /// let weak_five = Arc::downgrade(&five);
642 #[stable(feature = "arc_weak", since = "1.4.0")]
643 pub fn downgrade(this: &Self) -> Weak<T> {
644 // This Relaxed is OK because we're checking the value in the CAS
646 let mut cur = this.inner().weak.load(Relaxed);
649 // check if the weak counter is currently "locked"; if so, spin.
650 if cur == usize::MAX {
651 cur = this.inner().weak.load(Relaxed);
655 // NOTE: this code currently ignores the possibility of overflow
656 // into usize::MAX; in general both Rc and Arc need to be adjusted
657 // to deal with overflow.
659 // Unlike with Clone(), we need this to be an Acquire read to
660 // synchronize with the write coming from `is_unique`, so that the
661 // events prior to that write happen before this read.
662 match this.inner().weak.compare_exchange_weak(cur, cur + 1, Acquire, Relaxed) {
664 // Make sure we do not create a dangling Weak
665 debug_assert!(!is_dangling(this.ptr));
666 return Weak { ptr: this.ptr };
668 Err(old) => cur = old,
673 /// Gets the number of [`Weak`][weak] pointers to this allocation.
675 /// [weak]: struct.Weak.html
679 /// This method by itself is safe, but using it correctly requires extra care.
680 /// Another thread can change the weak count at any time,
681 /// including potentially between calling this method and acting on the result.
686 /// use std::sync::Arc;
688 /// let five = Arc::new(5);
689 /// let _weak_five = Arc::downgrade(&five);
691 /// // This assertion is deterministic because we haven't shared
692 /// // the `Arc` or `Weak` between threads.
693 /// assert_eq!(1, Arc::weak_count(&five));
696 #[stable(feature = "arc_counts", since = "1.15.0")]
697 pub fn weak_count(this: &Self) -> usize {
698 let cnt = this.inner().weak.load(SeqCst);
699 // If the weak count is currently locked, the value of the
700 // count was 0 just before taking the lock.
701 if cnt == usize::MAX { 0 } else { cnt - 1 }
704 /// Gets the number of strong (`Arc`) pointers to this allocation.
708 /// This method by itself is safe, but using it correctly requires extra care.
709 /// Another thread can change the strong count at any time,
710 /// including potentially between calling this method and acting on the result.
715 /// use std::sync::Arc;
717 /// let five = Arc::new(5);
718 /// let _also_five = Arc::clone(&five);
720 /// // This assertion is deterministic because we haven't shared
721 /// // the `Arc` between threads.
722 /// assert_eq!(2, Arc::strong_count(&five));
725 #[stable(feature = "arc_counts", since = "1.15.0")]
726 pub fn strong_count(this: &Self) -> usize {
727 this.inner().strong.load(SeqCst)
731 fn inner(&self) -> &ArcInner<T> {
732 // This unsafety is ok because while this arc is alive we're guaranteed
733 // that the inner pointer is valid. Furthermore, we know that the
734 // `ArcInner` structure itself is `Sync` because the inner data is
735 // `Sync` as well, so we're ok loaning out an immutable pointer to these
737 unsafe { self.ptr.as_ref() }
740 // Non-inlined part of `drop`.
742 unsafe fn drop_slow(&mut self) {
743 // Destroy the data at this time, even though we may not free the box
744 // allocation itself (there may still be weak pointers lying around).
745 ptr::drop_in_place(&mut self.ptr.as_mut().data);
747 if self.inner().weak.fetch_sub(1, Release) == 1 {
748 atomic::fence(Acquire);
749 Global.dealloc(self.ptr.cast(), Layout::for_value(self.ptr.as_ref()))
754 #[stable(feature = "ptr_eq", since = "1.17.0")]
755 /// Returns `true` if the two `Arc`s point to the same allocation
756 /// (in a vein similar to [`ptr::eq`]).
761 /// use std::sync::Arc;
763 /// let five = Arc::new(5);
764 /// let same_five = Arc::clone(&five);
765 /// let other_five = Arc::new(5);
767 /// assert!(Arc::ptr_eq(&five, &same_five));
768 /// assert!(!Arc::ptr_eq(&five, &other_five));
771 /// [`ptr::eq`]: ../../std/ptr/fn.eq.html
772 pub fn ptr_eq(this: &Self, other: &Self) -> bool {
773 this.ptr.as_ptr() == other.ptr.as_ptr()
777 impl<T: ?Sized> Arc<T> {
778 /// Allocates an `ArcInner<T>` with sufficient space for
779 /// a possibly-unsized inner value where the value has the layout provided.
781 /// The function `mem_to_arcinner` is called with the data pointer
782 /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
783 unsafe fn allocate_for_layout(
784 value_layout: Layout,
785 mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>
786 ) -> *mut ArcInner<T> {
787 // Calculate layout using the given value layout.
788 // Previously, layout was calculated on the expression
789 // `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
790 // reference (see #54908).
791 let layout = Layout::new::<ArcInner<()>>()
792 .extend(value_layout).unwrap().0
795 let mem = Global.alloc(layout)
796 .unwrap_or_else(|_| handle_alloc_error(layout));
798 // Initialize the ArcInner
799 let inner = mem_to_arcinner(mem.as_ptr());
800 debug_assert_eq!(Layout::for_value(&*inner), layout);
802 ptr::write(&mut (*inner).strong, atomic::AtomicUsize::new(1));
803 ptr::write(&mut (*inner).weak, atomic::AtomicUsize::new(1));
808 /// Allocates an `ArcInner<T>` with sufficient space for an unsized inner value.
809 unsafe fn allocate_for_ptr(ptr: *const T) -> *mut ArcInner<T> {
810 // Allocate for the `ArcInner<T>` using the given value.
811 Self::allocate_for_layout(
812 Layout::for_value(&*ptr),
813 |mem| set_data_ptr(ptr as *mut T, mem) as *mut ArcInner<T>,
817 fn from_box(v: Box<T>) -> Arc<T> {
819 let box_unique = Box::into_unique(v);
820 let bptr = box_unique.as_ptr();
822 let value_size = size_of_val(&*bptr);
823 let ptr = Self::allocate_for_ptr(bptr);
825 // Copy value as bytes
826 ptr::copy_nonoverlapping(
827 bptr as *const T as *const u8,
828 &mut (*ptr).data as *mut _ as *mut u8,
831 // Free the allocation without dropping its contents
832 box_free(box_unique);
840 /// Allocates an `ArcInner<[T]>` with the given length.
841 unsafe fn allocate_for_slice(len: usize) -> *mut ArcInner<[T]> {
842 Self::allocate_for_layout(
843 Layout::array::<T>(len).unwrap(),
844 |mem| ptr::slice_from_raw_parts_mut(mem as *mut T, len) as *mut ArcInner<[T]>,
849 /// Sets the data pointer of a `?Sized` raw pointer.
851 /// For a slice/trait object, this sets the `data` field and leaves the rest
852 /// unchanged. For a sized raw pointer, this simply sets the pointer.
853 unsafe fn set_data_ptr<T: ?Sized, U>(mut ptr: *mut T, data: *mut U) -> *mut T {
854 ptr::write(&mut ptr as *mut _ as *mut *mut u8, data as *mut u8);
859 /// Copy elements from slice into newly allocated Arc<[T]>
861 /// Unsafe because the caller must either take ownership or bind `T: Copy`.
862 unsafe fn copy_from_slice(v: &[T]) -> Arc<[T]> {
863 let ptr = Self::allocate_for_slice(v.len());
865 ptr::copy_nonoverlapping(
867 &mut (*ptr).data as *mut [T] as *mut T,
873 /// Constructs an `Arc<[T]>` from an iterator known to be of a certain size.
875 /// Behavior is undefined should the size be wrong.
876 unsafe fn from_iter_exact(iter: impl iter::Iterator<Item = T>, len: usize) -> Arc<[T]> {
877 // Panic guard while cloning T elements.
878 // In the event of a panic, elements that have been written
879 // into the new ArcInner will be dropped, then the memory freed.
887 impl<T> Drop for Guard<T> {
890 let slice = from_raw_parts_mut(self.elems, self.n_elems);
891 ptr::drop_in_place(slice);
893 Global.dealloc(self.mem.cast(), self.layout);
898 let ptr = Self::allocate_for_slice(len);
900 let mem = ptr as *mut _ as *mut u8;
901 let layout = Layout::for_value(&*ptr);
903 // Pointer to first element
904 let elems = &mut (*ptr).data as *mut [T] as *mut T;
906 let mut guard = Guard {
907 mem: NonNull::new_unchecked(mem),
913 for (i, item) in iter.enumerate() {
914 ptr::write(elems.add(i), item);
918 // All clear. Forget the guard so it doesn't free the new ArcInner.
925 /// Specialization trait used for `From<&[T]>`.
926 trait ArcFromSlice<T> {
927 fn from_slice(slice: &[T]) -> Self;
930 impl<T: Clone> ArcFromSlice<T> for Arc<[T]> {
932 default fn from_slice(v: &[T]) -> Self {
934 Self::from_iter_exact(v.iter().cloned(), v.len())
939 impl<T: Copy> ArcFromSlice<T> for Arc<[T]> {
941 fn from_slice(v: &[T]) -> Self {
942 unsafe { Arc::copy_from_slice(v) }
946 #[stable(feature = "rust1", since = "1.0.0")]
947 impl<T: ?Sized> Clone for Arc<T> {
948 /// Makes a clone of the `Arc` pointer.
950 /// This creates another pointer to the same allocation, increasing the
951 /// strong reference count.
956 /// use std::sync::Arc;
958 /// let five = Arc::new(5);
960 /// let _ = Arc::clone(&five);
963 fn clone(&self) -> Arc<T> {
964 // Using a relaxed ordering is alright here, as knowledge of the
965 // original reference prevents other threads from erroneously deleting
968 // As explained in the [Boost documentation][1], Increasing the
969 // reference counter can always be done with memory_order_relaxed: New
970 // references to an object can only be formed from an existing
971 // reference, and passing an existing reference from one thread to
972 // another must already provide any required synchronization.
974 // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
975 let old_size = self.inner().strong.fetch_add(1, Relaxed);
977 // However we need to guard against massive refcounts in case someone
978 // is `mem::forget`ing Arcs. If we don't do this the count can overflow
979 // and users will use-after free. We racily saturate to `isize::MAX` on
980 // the assumption that there aren't ~2 billion threads incrementing
981 // the reference count at once. This branch will never be taken in
982 // any realistic program.
984 // We abort because such a program is incredibly degenerate, and we
985 // don't care to support it.
986 if old_size > MAX_REFCOUNT {
992 Self::from_inner(self.ptr)
996 #[stable(feature = "rust1", since = "1.0.0")]
997 impl<T: ?Sized> Deref for Arc<T> {
1001 fn deref(&self) -> &T {
1006 #[unstable(feature = "receiver_trait", issue = "0")]
1007 impl<T: ?Sized> Receiver for Arc<T> {}
1009 impl<T: Clone> Arc<T> {
1010 /// Makes a mutable reference into the given `Arc`.
1012 /// If there are other `Arc` or [`Weak`][weak] pointers to the same allocation,
1013 /// then `make_mut` will create a new allocation and invoke [`clone`][clone] on the inner value
1014 /// to ensure unique ownership. This is also referred to as clone-on-write.
1016 /// Note that this differs from the behavior of [`Rc::make_mut`] which disassociates
1017 /// any remaining `Weak` pointers.
1019 /// See also [`get_mut`][get_mut], which will fail rather than cloning.
1021 /// [weak]: struct.Weak.html
1022 /// [clone]: ../../std/clone/trait.Clone.html#tymethod.clone
1023 /// [get_mut]: struct.Arc.html#method.get_mut
1024 /// [`Rc::make_mut`]: ../rc/struct.Rc.html#method.make_mut
1029 /// use std::sync::Arc;
1031 /// let mut data = Arc::new(5);
1033 /// *Arc::make_mut(&mut data) += 1; // Won't clone anything
1034 /// let mut other_data = Arc::clone(&data); // Won't clone inner data
1035 /// *Arc::make_mut(&mut data) += 1; // Clones inner data
1036 /// *Arc::make_mut(&mut data) += 1; // Won't clone anything
1037 /// *Arc::make_mut(&mut other_data) *= 2; // Won't clone anything
1039 /// // Now `data` and `other_data` point to different allocations.
1040 /// assert_eq!(*data, 8);
1041 /// assert_eq!(*other_data, 12);
1044 #[stable(feature = "arc_unique", since = "1.4.0")]
1045 pub fn make_mut(this: &mut Self) -> &mut T {
1046 // Note that we hold both a strong reference and a weak reference.
1047 // Thus, releasing our strong reference only will not, by itself, cause
1048 // the memory to be deallocated.
1050 // Use Acquire to ensure that we see any writes to `weak` that happen
1051 // before release writes (i.e., decrements) to `strong`. Since we hold a
1052 // weak count, there's no chance the ArcInner itself could be
1054 if this.inner().strong.compare_exchange(1, 0, Acquire, Relaxed).is_err() {
1055 // Another strong pointer exists; clone
1056 *this = Arc::new((**this).clone());
1057 } else if this.inner().weak.load(Relaxed) != 1 {
1058 // Relaxed suffices in the above because this is fundamentally an
1059 // optimization: we are always racing with weak pointers being
1060 // dropped. Worst case, we end up allocated a new Arc unnecessarily.
1062 // We removed the last strong ref, but there are additional weak
1063 // refs remaining. We'll move the contents to a new Arc, and
1064 // invalidate the other weak refs.
1066 // Note that it is not possible for the read of `weak` to yield
1067 // usize::MAX (i.e., locked), since the weak count can only be
1068 // locked by a thread with a strong reference.
1070 // Materialize our own implicit weak pointer, so that it can clean
1071 // up the ArcInner as needed.
1072 let weak = Weak { ptr: this.ptr };
1074 // mark the data itself as already deallocated
1076 // there is no data race in the implicit write caused by `read`
1077 // here (due to zeroing) because data is no longer accessed by
1078 // other threads (due to there being no more strong refs at this
1080 let mut swap = Arc::new(ptr::read(&weak.ptr.as_ref().data));
1081 mem::swap(this, &mut swap);
1085 // We were the sole reference of either kind; bump back up the
1086 // strong ref count.
1087 this.inner().strong.store(1, Release);
1090 // As with `get_mut()`, the unsafety is ok because our reference was
1091 // either unique to begin with, or became one upon cloning the contents.
1093 &mut this.ptr.as_mut().data
1098 impl<T: ?Sized> Arc<T> {
1099 /// Returns a mutable reference into the given `Arc`, if there are
1100 /// no other `Arc` or [`Weak`][weak] pointers to the same allocation.
1102 /// Returns [`None`][option] otherwise, because it is not safe to
1103 /// mutate a shared value.
1105 /// See also [`make_mut`][make_mut], which will [`clone`][clone]
1106 /// the inner value when there are other pointers.
1108 /// [weak]: struct.Weak.html
1109 /// [option]: ../../std/option/enum.Option.html
1110 /// [make_mut]: struct.Arc.html#method.make_mut
1111 /// [clone]: ../../std/clone/trait.Clone.html#tymethod.clone
1116 /// use std::sync::Arc;
1118 /// let mut x = Arc::new(3);
1119 /// *Arc::get_mut(&mut x).unwrap() = 4;
1120 /// assert_eq!(*x, 4);
1122 /// let _y = Arc::clone(&x);
1123 /// assert!(Arc::get_mut(&mut x).is_none());
1126 #[stable(feature = "arc_unique", since = "1.4.0")]
1127 pub fn get_mut(this: &mut Self) -> Option<&mut T> {
1128 if this.is_unique() {
1129 // This unsafety is ok because we're guaranteed that the pointer
1130 // returned is the *only* pointer that will ever be returned to T. Our
1131 // reference count is guaranteed to be 1 at this point, and we required
1132 // the Arc itself to be `mut`, so we're returning the only possible
1133 // reference to the inner data.
1135 Some(Arc::get_mut_unchecked(this))
1142 /// Returns a mutable reference into the given `Arc`,
1143 /// without any check.
1145 /// See also [`get_mut`], which is safe and does appropriate checks.
1147 /// [`get_mut`]: struct.Arc.html#method.get_mut
1151 /// Any other `Arc` or [`Weak`] pointers to the same allocation must not be dereferenced
1152 /// for the duration of the returned borrow.
1153 /// This is trivially the case if no such pointers exist,
1154 /// for example immediately after `Arc::new`.
1159 /// #![feature(get_mut_unchecked)]
1161 /// use std::sync::Arc;
1163 /// let mut x = Arc::new(String::new());
1165 /// Arc::get_mut_unchecked(&mut x).push_str("foo")
1167 /// assert_eq!(*x, "foo");
1170 #[unstable(feature = "get_mut_unchecked", issue = "63292")]
1171 pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
1172 &mut this.ptr.as_mut().data
1175 /// Determine whether this is the unique reference (including weak refs) to
1176 /// the underlying data.
1178 /// Note that this requires locking the weak ref count.
1179 fn is_unique(&mut self) -> bool {
1180 // lock the weak pointer count if we appear to be the sole weak pointer
1183 // The acquire label here ensures a happens-before relationship with any
1184 // writes to `strong` (in particular in `Weak::upgrade`) prior to decrements
1185 // of the `weak` count (via `Weak::drop`, which uses release). If the upgraded
1186 // weak ref was never dropped, the CAS here will fail so we do not care to synchronize.
1187 if self.inner().weak.compare_exchange(1, usize::MAX, Acquire, Relaxed).is_ok() {
1188 // This needs to be an `Acquire` to synchronize with the decrement of the `strong`
1189 // counter in `drop` -- the only access that happens when any but the last reference
1190 // is being dropped.
1191 let unique = self.inner().strong.load(Acquire) == 1;
1193 // The release write here synchronizes with a read in `downgrade`,
1194 // effectively preventing the above read of `strong` from happening
1196 self.inner().weak.store(1, Release); // release the lock
1204 #[stable(feature = "rust1", since = "1.0.0")]
1205 unsafe impl<#[may_dangle] T: ?Sized> Drop for Arc<T> {
1206 /// Drops the `Arc`.
1208 /// This will decrement the strong reference count. If the strong reference
1209 /// count reaches zero then the only other references (if any) are
1210 /// [`Weak`], so we `drop` the inner value.
1215 /// use std::sync::Arc;
1219 /// impl Drop for Foo {
1220 /// fn drop(&mut self) {
1221 /// println!("dropped!");
1225 /// let foo = Arc::new(Foo);
1226 /// let foo2 = Arc::clone(&foo);
1228 /// drop(foo); // Doesn't print anything
1229 /// drop(foo2); // Prints "dropped!"
1232 /// [`Weak`]: ../../std/sync/struct.Weak.html
1234 fn drop(&mut self) {
1235 // Because `fetch_sub` is already atomic, we do not need to synchronize
1236 // with other threads unless we are going to delete the object. This
1237 // same logic applies to the below `fetch_sub` to the `weak` count.
1238 if self.inner().strong.fetch_sub(1, Release) != 1 {
1242 // This fence is needed to prevent reordering of use of the data and
1243 // deletion of the data. Because it is marked `Release`, the decreasing
1244 // of the reference count synchronizes with this `Acquire` fence. This
1245 // means that use of the data happens before decreasing the reference
1246 // count, which happens before this fence, which happens before the
1247 // deletion of the data.
1249 // As explained in the [Boost documentation][1],
1251 // > It is important to enforce any possible access to the object in one
1252 // > thread (through an existing reference) to *happen before* deleting
1253 // > the object in a different thread. This is achieved by a "release"
1254 // > operation after dropping a reference (any access to the object
1255 // > through this reference must obviously happened before), and an
1256 // > "acquire" operation before deleting the object.
1258 // In particular, while the contents of an Arc are usually immutable, it's
1259 // possible to have interior writes to something like a Mutex<T>. Since a
1260 // Mutex is not acquired when it is deleted, we can't rely on its
1261 // synchronization logic to make writes in thread A visible to a destructor
1262 // running in thread B.
1264 // Also note that the Acquire fence here could probably be replaced with an
1265 // Acquire load, which could improve performance in highly-contended
1266 // situations. See [2].
1268 // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1269 // [2]: (https://github.com/rust-lang/rust/pull/41714)
1270 atomic::fence(Acquire);
1278 impl Arc<dyn Any + Send + Sync> {
1280 #[stable(feature = "rc_downcast", since = "1.29.0")]
1281 /// Attempt to downcast the `Arc<dyn Any + Send + Sync>` to a concrete type.
1286 /// use std::any::Any;
1287 /// use std::sync::Arc;
1289 /// fn print_if_string(value: Arc<dyn Any + Send + Sync>) {
1290 /// if let Ok(string) = value.downcast::<String>() {
1291 /// println!("String ({}): {}", string.len(), string);
1295 /// let my_string = "Hello World".to_string();
1296 /// print_if_string(Arc::new(my_string));
1297 /// print_if_string(Arc::new(0i8));
1299 pub fn downcast<T>(self) -> Result<Arc<T>, Self>
1301 T: Any + Send + Sync + 'static,
1303 if (*self).is::<T>() {
1304 let ptr = self.ptr.cast::<ArcInner<T>>();
1306 Ok(Arc::from_inner(ptr))
1314 /// Constructs a new `Weak<T>`, without allocating any memory.
1315 /// Calling [`upgrade`] on the return value always gives [`None`].
1317 /// [`upgrade`]: struct.Weak.html#method.upgrade
1318 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1323 /// use std::sync::Weak;
1325 /// let empty: Weak<i64> = Weak::new();
1326 /// assert!(empty.upgrade().is_none());
1328 #[stable(feature = "downgraded_weak", since = "1.10.0")]
1329 pub fn new() -> Weak<T> {
1331 ptr: NonNull::new(usize::MAX as *mut ArcInner<T>).expect("MAX is not 0"),
1335 /// Returns a raw pointer to the object `T` pointed to by this `Weak<T>`.
1337 /// The pointer is valid only if there are some strong references. The pointer may be dangling
1338 /// or even [`null`] otherwise.
1343 /// #![feature(weak_into_raw)]
1345 /// use std::sync::Arc;
1348 /// let strong = Arc::new("hello".to_owned());
1349 /// let weak = Arc::downgrade(&strong);
1350 /// // Both point to the same object
1351 /// assert!(ptr::eq(&*strong, weak.as_raw()));
1352 /// // The strong here keeps it alive, so we can still access the object.
1353 /// assert_eq!("hello", unsafe { &*weak.as_raw() });
1356 /// // But not any more. We can do weak.as_raw(), but accessing the pointer would lead to
1357 /// // undefined behaviour.
1358 /// // assert_eq!("hello", unsafe { &*weak.as_raw() });
1361 /// [`null`]: ../../std/ptr/fn.null.html
1362 #[unstable(feature = "weak_into_raw", issue = "60728")]
1363 pub fn as_raw(&self) -> *const T {
1364 match self.inner() {
1365 None => ptr::null(),
1367 let offset = data_offset_sized::<T>();
1368 let ptr = inner as *const ArcInner<T>;
1369 // Note: while the pointer we create may already point to dropped value, the
1370 // allocation still lives (it must hold the weak point as long as we are alive).
1371 // Therefore, the offset is OK to do, it won't get out of the allocation.
1372 let ptr = unsafe { (ptr as *const u8).offset(offset) };
1378 /// Consumes the `Weak<T>` and turns it into a raw pointer.
1380 /// This converts the weak pointer into a raw pointer, preserving the original weak count. It
1381 /// can be turned back into the `Weak<T>` with [`from_raw`].
1383 /// The same restrictions of accessing the target of the pointer as with
1384 /// [`as_raw`] apply.
1389 /// #![feature(weak_into_raw)]
1391 /// use std::sync::{Arc, Weak};
1393 /// let strong = Arc::new("hello".to_owned());
1394 /// let weak = Arc::downgrade(&strong);
1395 /// let raw = weak.into_raw();
1397 /// assert_eq!(1, Arc::weak_count(&strong));
1398 /// assert_eq!("hello", unsafe { &*raw });
1400 /// drop(unsafe { Weak::from_raw(raw) });
1401 /// assert_eq!(0, Arc::weak_count(&strong));
1404 /// [`from_raw`]: struct.Weak.html#method.from_raw
1405 /// [`as_raw`]: struct.Weak.html#method.as_raw
1406 #[unstable(feature = "weak_into_raw", issue = "60728")]
1407 pub fn into_raw(self) -> *const T {
1408 let result = self.as_raw();
1413 /// Converts a raw pointer previously created by [`into_raw`] back into
1416 /// This can be used to safely get a strong reference (by calling [`upgrade`]
1417 /// later) or to deallocate the weak count by dropping the `Weak<T>`.
1419 /// It takes ownership of one weak count (with the exception of pointers created by [`new`],
1420 /// as these don't have any corresponding weak count).
1424 /// The pointer must have originated from the [`into_raw`] (or [`as_raw'], provided there was
1425 /// a corresponding [`forget`] on the `Weak<T>`) and must still own its potential weak reference
1428 /// It is allowed for the strong count to be 0 at the time of calling this, but the weak count
1429 /// must be non-zero or the pointer must have originated from a dangling `Weak<T>` (one created
1435 /// #![feature(weak_into_raw)]
1437 /// use std::sync::{Arc, Weak};
1439 /// let strong = Arc::new("hello".to_owned());
1441 /// let raw_1 = Arc::downgrade(&strong).into_raw();
1442 /// let raw_2 = Arc::downgrade(&strong).into_raw();
1444 /// assert_eq!(2, Arc::weak_count(&strong));
1446 /// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
1447 /// assert_eq!(1, Arc::weak_count(&strong));
1451 /// // Decrement the last weak count.
1452 /// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
1455 /// [`as_raw`]: struct.Weak.html#method.as_raw
1456 /// [`new`]: struct.Weak.html#method.new
1457 /// [`into_raw`]: struct.Weak.html#method.into_raw
1458 /// [`upgrade`]: struct.Weak.html#method.upgrade
1459 /// [`Weak`]: struct.Weak.html
1460 /// [`Arc`]: struct.Arc.html
1461 /// [`forget`]: ../../std/mem/fn.forget.html
1462 #[unstable(feature = "weak_into_raw", issue = "60728")]
1463 pub unsafe fn from_raw(ptr: *const T) -> Self {
1467 // See Arc::from_raw for details
1468 let offset = data_offset(ptr);
1469 let fake_ptr = ptr as *mut ArcInner<T>;
1470 let ptr = set_data_ptr(fake_ptr, (ptr as *mut u8).offset(-offset));
1472 ptr: NonNull::new(ptr).expect("Invalid pointer passed to from_raw"),
1478 impl<T: ?Sized> Weak<T> {
1479 /// Attempts to upgrade the `Weak` pointer to an [`Arc`], delaying
1480 /// dropping of the inner value if successful.
1482 /// Returns [`None`] if the inner value has since been dropped.
1484 /// [`Arc`]: struct.Arc.html
1485 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1490 /// use std::sync::Arc;
1492 /// let five = Arc::new(5);
1494 /// let weak_five = Arc::downgrade(&five);
1496 /// let strong_five: Option<Arc<_>> = weak_five.upgrade();
1497 /// assert!(strong_five.is_some());
1499 /// // Destroy all strong pointers.
1500 /// drop(strong_five);
1503 /// assert!(weak_five.upgrade().is_none());
1505 #[stable(feature = "arc_weak", since = "1.4.0")]
1506 pub fn upgrade(&self) -> Option<Arc<T>> {
1507 // We use a CAS loop to increment the strong count instead of a
1508 // fetch_add because once the count hits 0 it must never be above 0.
1509 let inner = self.inner()?;
1511 // Relaxed load because any write of 0 that we can observe
1512 // leaves the field in a permanently zero state (so a
1513 // "stale" read of 0 is fine), and any other value is
1514 // confirmed via the CAS below.
1515 let mut n = inner.strong.load(Relaxed);
1522 // See comments in `Arc::clone` for why we do this (for `mem::forget`).
1523 if n > MAX_REFCOUNT {
1529 // Relaxed is valid for the same reason it is on Arc's Clone impl
1530 match inner.strong.compare_exchange_weak(n, n + 1, Relaxed, Relaxed) {
1531 Ok(_) => return Some(Arc::from_inner(self.ptr)), // null checked above
1532 Err(old) => n = old,
1537 /// Gets the number of strong (`Arc`) pointers pointing to this allocation.
1539 /// If `self` was created using [`Weak::new`], this will return 0.
1541 /// [`Weak::new`]: #method.new
1542 #[unstable(feature = "weak_counts", issue = "57977")]
1543 pub fn strong_count(&self) -> usize {
1544 if let Some(inner) = self.inner() {
1545 inner.strong.load(SeqCst)
1551 /// Gets an approximation of the number of `Weak` pointers pointing to this
1554 /// If `self` was created using [`Weak::new`], this will return 0. If not,
1555 /// the returned value is at least 1, since `self` still points to the
1560 /// Due to implementation details, the returned value can be off by 1 in
1561 /// either direction when other threads are manipulating any `Arc`s or
1562 /// `Weak`s pointing to the same allocation.
1564 /// [`Weak::new`]: #method.new
1565 #[unstable(feature = "weak_counts", issue = "57977")]
1566 pub fn weak_count(&self) -> Option<usize> {
1567 // Due to the implicit weak pointer added when any strong pointers are
1568 // around, we cannot implement `weak_count` correctly since it
1569 // necessarily requires accessing the strong count and weak count in an
1570 // unsynchronized fashion. So this version is a bit racy.
1571 self.inner().map(|inner| {
1572 let strong = inner.strong.load(SeqCst);
1573 let weak = inner.weak.load(SeqCst);
1575 // If the last `Arc` has *just* been dropped, it might not yet
1576 // have removed the implicit weak count, so the value we get
1577 // here might be 1 too high.
1580 // As long as there's still at least 1 `Arc` around, subtract
1581 // the implicit weak pointer.
1582 // Note that the last `Arc` might get dropped between the 2
1583 // loads we do above, removing the implicit weak pointer. This
1584 // means that the value might be 1 too low here. In order to not
1585 // return 0 here (which would happen if we're the only weak
1586 // pointer), we guard against that specifically.
1587 cmp::max(1, weak - 1)
1592 /// Returns `None` when the pointer is dangling and there is no allocated `ArcInner`,
1593 /// (i.e., when this `Weak` was created by `Weak::new`).
1595 fn inner(&self) -> Option<&ArcInner<T>> {
1596 if is_dangling(self.ptr) {
1599 Some(unsafe { self.ptr.as_ref() })
1603 /// Returns `true` if the two `Weak`s point to the same allocation (similar to
1604 /// [`ptr::eq`]), or if both don't point to any allocation
1605 /// (because they were created with `Weak::new()`).
1609 /// Since this compares pointers it means that `Weak::new()` will equal each
1610 /// other, even though they don't point to any allocation.
1615 /// use std::sync::Arc;
1617 /// let first_rc = Arc::new(5);
1618 /// let first = Arc::downgrade(&first_rc);
1619 /// let second = Arc::downgrade(&first_rc);
1621 /// assert!(first.ptr_eq(&second));
1623 /// let third_rc = Arc::new(5);
1624 /// let third = Arc::downgrade(&third_rc);
1626 /// assert!(!first.ptr_eq(&third));
1629 /// Comparing `Weak::new`.
1632 /// use std::sync::{Arc, Weak};
1634 /// let first = Weak::new();
1635 /// let second = Weak::new();
1636 /// assert!(first.ptr_eq(&second));
1638 /// let third_rc = Arc::new(());
1639 /// let third = Arc::downgrade(&third_rc);
1640 /// assert!(!first.ptr_eq(&third));
1643 /// [`ptr::eq`]: ../../std/ptr/fn.eq.html
1645 #[stable(feature = "weak_ptr_eq", since = "1.39.0")]
1646 pub fn ptr_eq(&self, other: &Self) -> bool {
1647 self.ptr.as_ptr() == other.ptr.as_ptr()
1651 #[stable(feature = "arc_weak", since = "1.4.0")]
1652 impl<T: ?Sized> Clone for Weak<T> {
1653 /// Makes a clone of the `Weak` pointer that points to the same allocation.
1658 /// use std::sync::{Arc, Weak};
1660 /// let weak_five = Arc::downgrade(&Arc::new(5));
1662 /// let _ = Weak::clone(&weak_five);
1665 fn clone(&self) -> Weak<T> {
1666 let inner = if let Some(inner) = self.inner() {
1669 return Weak { ptr: self.ptr };
1671 // See comments in Arc::clone() for why this is relaxed. This can use a
1672 // fetch_add (ignoring the lock) because the weak count is only locked
1673 // where are *no other* weak pointers in existence. (So we can't be
1674 // running this code in that case).
1675 let old_size = inner.weak.fetch_add(1, Relaxed);
1677 // See comments in Arc::clone() for why we do this (for mem::forget).
1678 if old_size > MAX_REFCOUNT {
1684 Weak { ptr: self.ptr }
1688 #[stable(feature = "downgraded_weak", since = "1.10.0")]
1689 impl<T> Default for Weak<T> {
1690 /// Constructs a new `Weak<T>`, without allocating memory.
1691 /// Calling [`upgrade`] on the return value always
1694 /// [`None`]: ../../std/option/enum.Option.html#variant.None
1695 /// [`upgrade`]: ../../std/sync/struct.Weak.html#method.upgrade
1700 /// use std::sync::Weak;
1702 /// let empty: Weak<i64> = Default::default();
1703 /// assert!(empty.upgrade().is_none());
1705 fn default() -> Weak<T> {
1710 #[stable(feature = "arc_weak", since = "1.4.0")]
1711 impl<T: ?Sized> Drop for Weak<T> {
1712 /// Drops the `Weak` pointer.
1717 /// use std::sync::{Arc, Weak};
1721 /// impl Drop for Foo {
1722 /// fn drop(&mut self) {
1723 /// println!("dropped!");
1727 /// let foo = Arc::new(Foo);
1728 /// let weak_foo = Arc::downgrade(&foo);
1729 /// let other_weak_foo = Weak::clone(&weak_foo);
1731 /// drop(weak_foo); // Doesn't print anything
1732 /// drop(foo); // Prints "dropped!"
1734 /// assert!(other_weak_foo.upgrade().is_none());
1736 fn drop(&mut self) {
1737 // If we find out that we were the last weak pointer, then its time to
1738 // deallocate the data entirely. See the discussion in Arc::drop() about
1739 // the memory orderings
1741 // It's not necessary to check for the locked state here, because the
1742 // weak count can only be locked if there was precisely one weak ref,
1743 // meaning that drop could only subsequently run ON that remaining weak
1744 // ref, which can only happen after the lock is released.
1745 let inner = if let Some(inner) = self.inner() {
1751 if inner.weak.fetch_sub(1, Release) == 1 {
1752 atomic::fence(Acquire);
1754 Global.dealloc(self.ptr.cast(), Layout::for_value(self.ptr.as_ref()))
1760 #[stable(feature = "rust1", since = "1.0.0")]
1761 trait ArcEqIdent<T: ?Sized + PartialEq> {
1762 fn eq(&self, other: &Arc<T>) -> bool;
1763 fn ne(&self, other: &Arc<T>) -> bool;
1766 #[stable(feature = "rust1", since = "1.0.0")]
1767 impl<T: ?Sized + PartialEq> ArcEqIdent<T> for Arc<T> {
1769 default fn eq(&self, other: &Arc<T>) -> bool {
1773 default fn ne(&self, other: &Arc<T>) -> bool {
1778 /// We're doing this specialization here, and not as a more general optimization on `&T`, because it
1779 /// would otherwise add a cost to all equality checks on refs. We assume that `Arc`s are used to
1780 /// store large values, that are slow to clone, but also heavy to check for equality, causing this
1781 /// cost to pay off more easily. It's also more likely to have two `Arc` clones, that point to
1782 /// the same value, than two `&T`s.
1784 /// We can only do this when `T: Eq` as a `PartialEq` might be deliberately irreflexive.
1785 #[stable(feature = "rust1", since = "1.0.0")]
1786 impl<T: ?Sized + Eq> ArcEqIdent<T> for Arc<T> {
1788 fn eq(&self, other: &Arc<T>) -> bool {
1789 Arc::ptr_eq(self, other) || **self == **other
1793 fn ne(&self, other: &Arc<T>) -> bool {
1794 !Arc::ptr_eq(self, other) && **self != **other
1798 #[stable(feature = "rust1", since = "1.0.0")]
1799 impl<T: ?Sized + PartialEq> PartialEq for Arc<T> {
1800 /// Equality for two `Arc`s.
1802 /// Two `Arc`s are equal if their inner values are equal, even if they are
1803 /// stored in different allocation.
1805 /// If `T` also implements `Eq` (implying reflexivity of equality),
1806 /// two `Arc`s that point to the same allocation are always equal.
1811 /// use std::sync::Arc;
1813 /// let five = Arc::new(5);
1815 /// assert!(five == Arc::new(5));
1818 fn eq(&self, other: &Arc<T>) -> bool {
1819 ArcEqIdent::eq(self, other)
1822 /// Inequality for two `Arc`s.
1824 /// Two `Arc`s are unequal if their inner values are unequal.
1826 /// If `T` also implements `Eq` (implying reflexivity of equality),
1827 /// two `Arc`s that point to the same value are never unequal.
1832 /// use std::sync::Arc;
1834 /// let five = Arc::new(5);
1836 /// assert!(five != Arc::new(6));
1839 fn ne(&self, other: &Arc<T>) -> bool {
1840 ArcEqIdent::ne(self, other)
1844 #[stable(feature = "rust1", since = "1.0.0")]
1845 impl<T: ?Sized + PartialOrd> PartialOrd for Arc<T> {
1846 /// Partial comparison for two `Arc`s.
1848 /// The two are compared by calling `partial_cmp()` on their inner values.
1853 /// use std::sync::Arc;
1854 /// use std::cmp::Ordering;
1856 /// let five = Arc::new(5);
1858 /// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Arc::new(6)));
1860 fn partial_cmp(&self, other: &Arc<T>) -> Option<Ordering> {
1861 (**self).partial_cmp(&**other)
1864 /// Less-than comparison for two `Arc`s.
1866 /// The two are compared by calling `<` on their inner values.
1871 /// use std::sync::Arc;
1873 /// let five = Arc::new(5);
1875 /// assert!(five < Arc::new(6));
1877 fn lt(&self, other: &Arc<T>) -> bool {
1878 *(*self) < *(*other)
1881 /// 'Less than or equal to' comparison for two `Arc`s.
1883 /// The two are compared by calling `<=` on their inner values.
1888 /// use std::sync::Arc;
1890 /// let five = Arc::new(5);
1892 /// assert!(five <= Arc::new(5));
1894 fn le(&self, other: &Arc<T>) -> bool {
1895 *(*self) <= *(*other)
1898 /// Greater-than comparison for two `Arc`s.
1900 /// The two are compared by calling `>` on their inner values.
1905 /// use std::sync::Arc;
1907 /// let five = Arc::new(5);
1909 /// assert!(five > Arc::new(4));
1911 fn gt(&self, other: &Arc<T>) -> bool {
1912 *(*self) > *(*other)
1915 /// 'Greater than or equal to' comparison for two `Arc`s.
1917 /// The two are compared by calling `>=` on their inner values.
1922 /// use std::sync::Arc;
1924 /// let five = Arc::new(5);
1926 /// assert!(five >= Arc::new(5));
1928 fn ge(&self, other: &Arc<T>) -> bool {
1929 *(*self) >= *(*other)
1932 #[stable(feature = "rust1", since = "1.0.0")]
1933 impl<T: ?Sized + Ord> Ord for Arc<T> {
1934 /// Comparison for two `Arc`s.
1936 /// The two are compared by calling `cmp()` on their inner values.
1941 /// use std::sync::Arc;
1942 /// use std::cmp::Ordering;
1944 /// let five = Arc::new(5);
1946 /// assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));
1948 fn cmp(&self, other: &Arc<T>) -> Ordering {
1949 (**self).cmp(&**other)
1952 #[stable(feature = "rust1", since = "1.0.0")]
1953 impl<T: ?Sized + Eq> Eq for Arc<T> {}
1955 #[stable(feature = "rust1", since = "1.0.0")]
1956 impl<T: ?Sized + fmt::Display> fmt::Display for Arc<T> {
1957 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1958 fmt::Display::fmt(&**self, f)
1962 #[stable(feature = "rust1", since = "1.0.0")]
1963 impl<T: ?Sized + fmt::Debug> fmt::Debug for Arc<T> {
1964 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1965 fmt::Debug::fmt(&**self, f)
1969 #[stable(feature = "rust1", since = "1.0.0")]
1970 impl<T: ?Sized> fmt::Pointer for Arc<T> {
1971 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1972 fmt::Pointer::fmt(&(&**self as *const T), f)
1976 #[stable(feature = "rust1", since = "1.0.0")]
1977 impl<T: Default> Default for Arc<T> {
1978 /// Creates a new `Arc<T>`, with the `Default` value for `T`.
1983 /// use std::sync::Arc;
1985 /// let x: Arc<i32> = Default::default();
1986 /// assert_eq!(*x, 0);
1988 fn default() -> Arc<T> {
1989 Arc::new(Default::default())
1993 #[stable(feature = "rust1", since = "1.0.0")]
1994 impl<T: ?Sized + Hash> Hash for Arc<T> {
1995 fn hash<H: Hasher>(&self, state: &mut H) {
1996 (**self).hash(state)
2000 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
2001 impl<T> From<T> for Arc<T> {
2002 fn from(t: T) -> Self {
2007 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2008 impl<T: Clone> From<&[T]> for Arc<[T]> {
2010 fn from(v: &[T]) -> Arc<[T]> {
2011 <Self as ArcFromSlice<T>>::from_slice(v)
2015 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2016 impl From<&str> for Arc<str> {
2018 fn from(v: &str) -> Arc<str> {
2019 let arc = Arc::<[u8]>::from(v.as_bytes());
2020 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const str) }
2024 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2025 impl From<String> for Arc<str> {
2027 fn from(v: String) -> Arc<str> {
2032 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2033 impl<T: ?Sized> From<Box<T>> for Arc<T> {
2035 fn from(v: Box<T>) -> Arc<T> {
2040 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2041 impl<T> From<Vec<T>> for Arc<[T]> {
2043 fn from(mut v: Vec<T>) -> Arc<[T]> {
2045 let arc = Arc::copy_from_slice(&v);
2047 // Allow the Vec to free its memory, but not destroy its contents
2055 #[unstable(feature = "boxed_slice_try_from", issue = "0")]
2056 impl<T, const N: usize> TryFrom<Arc<[T]>> for Arc<[T; N]>
2058 [T; N]: LengthAtMost32,
2060 type Error = Arc<[T]>;
2062 fn try_from(boxed_slice: Arc<[T]>) -> Result<Self, Self::Error> {
2063 if boxed_slice.len() == N {
2064 Ok(unsafe { Arc::from_raw(Arc::into_raw(boxed_slice) as *mut [T; N]) })
2071 #[stable(feature = "shared_from_iter", since = "1.37.0")]
2072 impl<T> iter::FromIterator<T> for Arc<[T]> {
2073 /// Takes each element in the `Iterator` and collects it into an `Arc<[T]>`.
2075 /// # Performance characteristics
2077 /// ## The general case
2079 /// In the general case, collecting into `Arc<[T]>` is done by first
2080 /// collecting into a `Vec<T>`. That is, when writing the following:
2083 /// # use std::sync::Arc;
2084 /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
2085 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2088 /// this behaves as if we wrote:
2091 /// # use std::sync::Arc;
2092 /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
2093 /// .collect::<Vec<_>>() // The first set of allocations happens here.
2094 /// .into(); // A second allocation for `Arc<[T]>` happens here.
2095 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2098 /// This will allocate as many times as needed for constructing the `Vec<T>`
2099 /// and then it will allocate once for turning the `Vec<T>` into the `Arc<[T]>`.
2101 /// ## Iterators of known length
2103 /// When your `Iterator` implements `TrustedLen` and is of an exact size,
2104 /// a single allocation will be made for the `Arc<[T]>`. For example:
2107 /// # use std::sync::Arc;
2108 /// let evens: Arc<[u8]> = (0..10).collect(); // Just a single allocation happens here.
2109 /// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
2111 fn from_iter<I: iter::IntoIterator<Item = T>>(iter: I) -> Self {
2112 ArcFromIter::from_iter(iter.into_iter())
2116 /// Specialization trait used for collecting into `Arc<[T]>`.
2117 trait ArcFromIter<T, I> {
2118 fn from_iter(iter: I) -> Self;
2121 impl<T, I: Iterator<Item = T>> ArcFromIter<T, I> for Arc<[T]> {
2122 default fn from_iter(iter: I) -> Self {
2123 iter.collect::<Vec<T>>().into()
2127 impl<T, I: iter::TrustedLen<Item = T>> ArcFromIter<T, I> for Arc<[T]> {
2128 default fn from_iter(iter: I) -> Self {
2129 // This is the case for a `TrustedLen` iterator.
2130 let (low, high) = iter.size_hint();
2131 if let Some(high) = high {
2134 "TrustedLen iterator's size hint is not exact: {:?}",
2139 // SAFETY: We need to ensure that the iterator has an exact length and we have.
2140 Arc::from_iter_exact(iter, low)
2143 // Fall back to normal implementation.
2144 iter.collect::<Vec<T>>().into()
2149 impl<'a, T: 'a + Clone> ArcFromIter<&'a T, slice::Iter<'a, T>> for Arc<[T]> {
2150 fn from_iter(iter: slice::Iter<'a, T>) -> Self {
2151 // Delegate to `impl<T: Clone> From<&[T]> for Arc<[T]>`.
2153 // In the case that `T: Copy`, we get to use `ptr::copy_nonoverlapping`
2154 // which is even more performant.
2156 // In the fall-back case we have `T: Clone`. This is still better
2157 // than the `TrustedLen` implementation as slices have a known length
2158 // and so we get to avoid calling `size_hint` and avoid the branching.
2159 iter.as_slice().into()
2163 #[stable(feature = "rust1", since = "1.0.0")]
2164 impl<T: ?Sized> borrow::Borrow<T> for Arc<T> {
2165 fn borrow(&self) -> &T {
2170 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
2171 impl<T: ?Sized> AsRef<T> for Arc<T> {
2172 fn as_ref(&self) -> &T {
2177 #[stable(feature = "pin", since = "1.33.0")]
2178 impl<T: ?Sized> Unpin for Arc<T> { }
2180 /// Computes the offset of the data field within `ArcInner`.
2181 unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> isize {
2182 // Align the unsized value to the end of the `ArcInner`.
2183 // Because it is `?Sized`, it will always be the last field in memory.
2184 data_offset_align(align_of_val(&*ptr))
2187 /// Computes the offset of the data field within `ArcInner`.
2189 /// Unlike [`data_offset`], this doesn't need the pointer, but it works only on `T: Sized`.
2190 fn data_offset_sized<T>() -> isize {
2191 data_offset_align(align_of::<T>())
2195 fn data_offset_align(align: usize) -> isize {
2196 let layout = Layout::new::<ArcInner<()>>();
2197 (layout.size() + layout.padding_needed_for(align)) as isize