1 #![stable(feature = "rust1", since = "1.0.0")]
3 //! Thread-safe reference-counting pointers.
5 //! See the [`Arc<T>`][Arc] documentation for more details.
9 use core::cmp::Ordering;
10 use core::convert::{From, TryFrom};
12 use core::hash::{Hash, Hasher};
14 use core::intrinsics::abort;
15 #[cfg(not(no_global_oom_handling))]
17 use core::marker::{PhantomData, Unpin, Unsize};
18 #[cfg(not(no_global_oom_handling))]
19 use core::mem::size_of_val;
20 use core::mem::{self, align_of_val_raw};
21 use core::ops::{CoerceUnsized, Deref, DispatchFromDyn, Receiver};
22 use core::panic::{RefUnwindSafe, UnwindSafe};
24 use core::ptr::{self, NonNull};
25 #[cfg(not(no_global_oom_handling))]
26 use core::slice::from_raw_parts_mut;
27 use core::sync::atomic;
28 use core::sync::atomic::Ordering::{Acquire, Relaxed, Release};
30 #[cfg(not(no_global_oom_handling))]
31 use crate::alloc::handle_alloc_error;
32 #[cfg(not(no_global_oom_handling))]
33 use crate::alloc::{box_free, WriteCloneIntoRaw};
34 use crate::alloc::{AllocError, Allocator, Global, Layout};
35 use crate::borrow::{Cow, ToOwned};
36 use crate::boxed::Box;
37 use crate::rc::is_dangling;
38 #[cfg(not(no_global_oom_handling))]
39 use crate::string::String;
40 #[cfg(not(no_global_oom_handling))]
46 /// A soft limit on the amount of references that may be made to an `Arc`.
48 /// Going above this limit will abort your program (although not
49 /// necessarily) at _exactly_ `MAX_REFCOUNT + 1` references.
50 const MAX_REFCOUNT: usize = (isize::MAX) as usize;
52 #[cfg(not(sanitize = "thread"))]
53 macro_rules! acquire {
55 atomic::fence(Acquire)
59 // ThreadSanitizer does not support memory fences. To avoid false positive
60 // reports in Arc / Weak implementation use atomic loads for synchronization
62 #[cfg(sanitize = "thread")]
63 macro_rules! acquire {
69 /// A thread-safe reference-counting pointer. 'Arc' stands for 'Atomically
70 /// Reference Counted'.
72 /// The type `Arc<T>` provides shared ownership of a value of type `T`,
73 /// allocated in the heap. Invoking [`clone`][clone] on `Arc` produces
74 /// a new `Arc` instance, which points to the same allocation on the heap as the
75 /// source `Arc`, while increasing a reference count. When the last `Arc`
76 /// pointer to a given allocation is destroyed, the value stored in that allocation (often
77 /// referred to as "inner value") is also dropped.
79 /// Shared references in Rust disallow mutation by default, and `Arc` is no
80 /// exception: you cannot generally obtain a mutable reference to something
81 /// inside an `Arc`. If you need to mutate through an `Arc`, use
82 /// [`Mutex`][mutex], [`RwLock`][rwlock], or one of the [`Atomic`][atomic]
87 /// Unlike [`Rc<T>`], `Arc<T>` uses atomic operations for its reference
88 /// counting. This means that it is thread-safe. The disadvantage is that
89 /// atomic operations are more expensive than ordinary memory accesses. If you
90 /// are not sharing reference-counted allocations between threads, consider using
91 /// [`Rc<T>`] for lower overhead. [`Rc<T>`] is a safe default, because the
92 /// compiler will catch any attempt to send an [`Rc<T>`] between threads.
93 /// However, a library might choose `Arc<T>` in order to give library consumers
96 /// `Arc<T>` will implement [`Send`] and [`Sync`] as long as the `T` implements
97 /// [`Send`] and [`Sync`]. Why can't you put a non-thread-safe type `T` in an
98 /// `Arc<T>` to make it thread-safe? This may be a bit counter-intuitive at
99 /// first: after all, isn't the point of `Arc<T>` thread safety? The key is
100 /// this: `Arc<T>` makes it thread safe to have multiple ownership of the same
101 /// data, but it doesn't add thread safety to its data. Consider
102 /// <code>Arc<[RefCell\<T>]></code>. [`RefCell<T>`] isn't [`Sync`], and if `Arc<T>` was always
103 /// [`Send`], <code>Arc<[RefCell\<T>]></code> would be as well. But then we'd have a problem:
104 /// [`RefCell<T>`] is not thread safe; it keeps track of the borrowing count using
105 /// non-atomic operations.
107 /// In the end, this means that you may need to pair `Arc<T>` with some sort of
108 /// [`std::sync`] type, usually [`Mutex<T>`][mutex].
110 /// ## Breaking cycles with `Weak`
112 /// The [`downgrade`][downgrade] method can be used to create a non-owning
113 /// [`Weak`] pointer. A [`Weak`] pointer can be [`upgrade`][upgrade]d
114 /// to an `Arc`, but this will return [`None`] if the value stored in the allocation has
115 /// already been dropped. In other words, `Weak` pointers do not keep the value
116 /// inside the allocation alive; however, they *do* keep the allocation
117 /// (the backing store for the value) alive.
119 /// A cycle between `Arc` pointers will never be deallocated. For this reason,
120 /// [`Weak`] is used to break cycles. For example, a tree could have
121 /// strong `Arc` pointers from parent nodes to children, and [`Weak`]
122 /// pointers from children back to their parents.
124 /// # Cloning references
126 /// Creating a new reference from an existing reference-counted pointer is done using the
127 /// `Clone` trait implemented for [`Arc<T>`][Arc] and [`Weak<T>`][Weak].
130 /// use std::sync::Arc;
131 /// let foo = Arc::new(vec![1.0, 2.0, 3.0]);
132 /// // The two syntaxes below are equivalent.
133 /// let a = foo.clone();
134 /// let b = Arc::clone(&foo);
135 /// // a, b, and foo are all Arcs that point to the same memory location
138 /// ## `Deref` behavior
140 /// `Arc<T>` automatically dereferences to `T` (via the [`Deref`][deref] trait),
141 /// so you can call `T`'s methods on a value of type `Arc<T>`. To avoid name
142 /// clashes with `T`'s methods, the methods of `Arc<T>` itself are associated
143 /// functions, called using [fully qualified syntax]:
146 /// use std::sync::Arc;
148 /// let my_arc = Arc::new(());
149 /// let my_weak = Arc::downgrade(&my_arc);
152 /// `Arc<T>`'s implementations of traits like `Clone` may also be called using
153 /// fully qualified syntax. Some people prefer to use fully qualified syntax,
154 /// while others prefer using method-call syntax.
157 /// use std::sync::Arc;
159 /// let arc = Arc::new(());
160 /// // Method-call syntax
161 /// let arc2 = arc.clone();
162 /// // Fully qualified syntax
163 /// let arc3 = Arc::clone(&arc);
166 /// [`Weak<T>`][Weak] does not auto-dereference to `T`, because the inner value may have
167 /// already been dropped.
169 /// [`Rc<T>`]: crate::rc::Rc
170 /// [clone]: Clone::clone
171 /// [mutex]: ../../std/sync/struct.Mutex.html
172 /// [rwlock]: ../../std/sync/struct.RwLock.html
173 /// [atomic]: core::sync::atomic
174 /// [`Send`]: core::marker::Send
175 /// [`Sync`]: core::marker::Sync
176 /// [deref]: core::ops::Deref
177 /// [downgrade]: Arc::downgrade
178 /// [upgrade]: Weak::upgrade
179 /// [RefCell\<T>]: core::cell::RefCell
180 /// [`RefCell<T>`]: core::cell::RefCell
181 /// [`std::sync`]: ../../std/sync/index.html
182 /// [`Arc::clone(&from)`]: Arc::clone
183 /// [fully qualified syntax]: https://doc.rust-lang.org/book/ch19-03-advanced-traits.html#fully-qualified-syntax-for-disambiguation-calling-methods-with-the-same-name
187 /// Sharing some immutable data between threads:
189 // Note that we **do not** run these tests here. The windows builders get super
190 // unhappy if a thread outlives the main thread and then exits at the same time
191 // (something deadlocks) so we just avoid this entirely by not running these
194 /// use std::sync::Arc;
197 /// let five = Arc::new(5);
200 /// let five = Arc::clone(&five);
202 /// thread::spawn(move || {
203 /// println!("{five:?}");
208 /// Sharing a mutable [`AtomicUsize`]:
210 /// [`AtomicUsize`]: core::sync::atomic::AtomicUsize "sync::atomic::AtomicUsize"
213 /// use std::sync::Arc;
214 /// use std::sync::atomic::{AtomicUsize, Ordering};
217 /// let val = Arc::new(AtomicUsize::new(5));
220 /// let val = Arc::clone(&val);
222 /// thread::spawn(move || {
223 /// let v = val.fetch_add(1, Ordering::SeqCst);
224 /// println!("{v:?}");
229 /// See the [`rc` documentation][rc_examples] for more examples of reference
230 /// counting in general.
232 /// [rc_examples]: crate::rc#examples
233 #[cfg_attr(not(test), rustc_diagnostic_item = "Arc")]
234 #[stable(feature = "rust1", since = "1.0.0")]
235 pub struct Arc<T: ?Sized> {
236 ptr: NonNull<ArcInner<T>>,
237 phantom: PhantomData<ArcInner<T>>,
240 #[stable(feature = "rust1", since = "1.0.0")]
241 unsafe impl<T: ?Sized + Sync + Send> Send for Arc<T> {}
242 #[stable(feature = "rust1", since = "1.0.0")]
243 unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {}
245 #[stable(feature = "catch_unwind", since = "1.9.0")]
246 impl<T: RefUnwindSafe + ?Sized> UnwindSafe for Arc<T> {}
248 #[unstable(feature = "coerce_unsized", issue = "27732")]
249 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Arc<U>> for Arc<T> {}
251 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
252 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Arc<U>> for Arc<T> {}
254 impl<T: ?Sized> Arc<T> {
255 unsafe fn from_inner(ptr: NonNull<ArcInner<T>>) -> Self {
256 Self { ptr, phantom: PhantomData }
259 unsafe fn from_ptr(ptr: *mut ArcInner<T>) -> Self {
260 unsafe { Self::from_inner(NonNull::new_unchecked(ptr)) }
264 /// `Weak` is a version of [`Arc`] that holds a non-owning reference to the
265 /// managed allocation. The allocation is accessed by calling [`upgrade`] on the `Weak`
266 /// pointer, which returns an <code>[Option]<[Arc]\<T>></code>.
268 /// Since a `Weak` reference does not count towards ownership, it will not
269 /// prevent the value stored in the allocation from being dropped, and `Weak` itself makes no
270 /// guarantees about the value still being present. Thus it may return [`None`]
271 /// when [`upgrade`]d. Note however that a `Weak` reference *does* prevent the allocation
272 /// itself (the backing store) from being deallocated.
274 /// A `Weak` pointer is useful for keeping a temporary reference to the allocation
275 /// managed by [`Arc`] without preventing its inner value from being dropped. It is also used to
276 /// prevent circular references between [`Arc`] pointers, since mutual owning references
277 /// would never allow either [`Arc`] to be dropped. For example, a tree could
278 /// have strong [`Arc`] pointers from parent nodes to children, and `Weak`
279 /// pointers from children back to their parents.
281 /// The typical way to obtain a `Weak` pointer is to call [`Arc::downgrade`].
283 /// [`upgrade`]: Weak::upgrade
284 #[stable(feature = "arc_weak", since = "1.4.0")]
285 pub struct Weak<T: ?Sized> {
286 // This is a `NonNull` to allow optimizing the size of this type in enums,
287 // but it is not necessarily a valid pointer.
288 // `Weak::new` sets this to `usize::MAX` so that it doesn’t need
289 // to allocate space on the heap. That's not a value a real pointer
290 // will ever have because RcBox has alignment at least 2.
291 // This is only possible when `T: Sized`; unsized `T` never dangle.
292 ptr: NonNull<ArcInner<T>>,
295 #[stable(feature = "arc_weak", since = "1.4.0")]
296 unsafe impl<T: ?Sized + Sync + Send> Send for Weak<T> {}
297 #[stable(feature = "arc_weak", since = "1.4.0")]
298 unsafe impl<T: ?Sized + Sync + Send> Sync for Weak<T> {}
300 #[unstable(feature = "coerce_unsized", issue = "27732")]
301 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Weak<U>> for Weak<T> {}
302 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
303 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Weak<U>> for Weak<T> {}
305 #[stable(feature = "arc_weak", since = "1.4.0")]
306 impl<T: ?Sized + fmt::Debug> fmt::Debug for Weak<T> {
307 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
312 // This is repr(C) to future-proof against possible field-reordering, which
313 // would interfere with otherwise safe [into|from]_raw() of transmutable
316 struct ArcInner<T: ?Sized> {
317 strong: atomic::AtomicUsize,
319 // the value usize::MAX acts as a sentinel for temporarily "locking" the
320 // ability to upgrade weak pointers or downgrade strong ones; this is used
321 // to avoid races in `make_mut` and `get_mut`.
322 weak: atomic::AtomicUsize,
327 unsafe impl<T: ?Sized + Sync + Send> Send for ArcInner<T> {}
328 unsafe impl<T: ?Sized + Sync + Send> Sync for ArcInner<T> {}
331 /// Constructs a new `Arc<T>`.
336 /// use std::sync::Arc;
338 /// let five = Arc::new(5);
340 #[cfg(not(no_global_oom_handling))]
342 #[stable(feature = "rust1", since = "1.0.0")]
343 pub fn new(data: T) -> Arc<T> {
344 // Start the weak pointer count as 1 which is the weak pointer that's
345 // held by all the strong pointers (kinda), see std/rc.rs for more info
346 let x: Box<_> = Box::new(ArcInner {
347 strong: atomic::AtomicUsize::new(1),
348 weak: atomic::AtomicUsize::new(1),
351 unsafe { Self::from_inner(Box::leak(x).into()) }
354 /// Constructs a new `Arc<T>` while giving you a `Weak<T>` to the allocation,
355 /// to allow you to construct a `T` which holds a weak pointer to itself.
357 /// Generally, a structure circularly referencing itself, either directly or
358 /// indirectly, should not hold a strong reference to itself to prevent a memory leak.
359 /// Using this function, you get access to the weak pointer during the
360 /// initialization of `T`, before the `Arc<T>` is created, such that you can
361 /// clone and store it inside the `T`.
363 /// `new_cyclic` first allocates the managed allocation for the `Arc<T>`,
364 /// then calls your closure, giving it a `Weak<T>` to this allocation,
365 /// and only afterwards completes the construction of the `Arc<T>` by placing
366 /// the `T` returned from your closure into the allocation.
368 /// Since the new `Arc<T>` is not fully-constructed until `Arc<T>::new_cyclic`
369 /// returns, calling [`upgrade`] on the weak reference inside your closure will
370 /// fail and result in a `None` value.
374 /// If `data_fn` panics, the panic is propagated to the caller, and the
375 /// temporary [`Weak<T>`] is dropped normally.
380 /// # #![allow(dead_code)]
381 /// use std::sync::{Arc, Weak};
384 /// me: Weak<Gadget>,
388 /// /// Construct a reference counted Gadget.
389 /// fn new() -> Arc<Self> {
390 /// // `me` is a `Weak<Gadget>` pointing at the new allocation of the
391 /// // `Arc` we're constructing.
392 /// Arc::new_cyclic(|me| {
393 /// // Create the actual struct here.
394 /// Gadget { me: me.clone() }
398 /// /// Return a reference counted pointer to Self.
399 /// fn me(&self) -> Arc<Self> {
400 /// self.me.upgrade().unwrap()
404 /// [`upgrade`]: Weak::upgrade
405 #[cfg(not(no_global_oom_handling))]
407 #[stable(feature = "arc_new_cyclic", since = "1.60.0")]
408 pub fn new_cyclic<F>(data_fn: F) -> Arc<T>
410 F: FnOnce(&Weak<T>) -> T,
412 // Construct the inner in the "uninitialized" state with a single
414 let uninit_ptr: NonNull<_> = Box::leak(Box::new(ArcInner {
415 strong: atomic::AtomicUsize::new(0),
416 weak: atomic::AtomicUsize::new(1),
417 data: mem::MaybeUninit::<T>::uninit(),
420 let init_ptr: NonNull<ArcInner<T>> = uninit_ptr.cast();
422 let weak = Weak { ptr: init_ptr };
424 // It's important we don't give up ownership of the weak pointer, or
425 // else the memory might be freed by the time `data_fn` returns. If
426 // we really wanted to pass ownership, we could create an additional
427 // weak pointer for ourselves, but this would result in additional
428 // updates to the weak reference count which might not be necessary
430 let data = data_fn(&weak);
432 // Now we can properly initialize the inner value and turn our weak
433 // reference into a strong reference.
434 let strong = unsafe {
435 let inner = init_ptr.as_ptr();
436 ptr::write(ptr::addr_of_mut!((*inner).data), data);
438 // The above write to the data field must be visible to any threads which
439 // observe a non-zero strong count. Therefore we need at least "Release" ordering
440 // in order to synchronize with the `compare_exchange_weak` in `Weak::upgrade`.
442 // "Acquire" ordering is not required. When considering the possible behaviours
443 // of `data_fn` we only need to look at what it could do with a reference to a
444 // non-upgradeable `Weak`:
445 // - It can *clone* the `Weak`, increasing the weak reference count.
446 // - It can drop those clones, decreasing the weak reference count (but never to zero).
448 // These side effects do not impact us in any way, and no other side effects are
449 // possible with safe code alone.
450 let prev_value = (*inner).strong.fetch_add(1, Release);
451 debug_assert_eq!(prev_value, 0, "No prior strong references should exist");
453 Arc::from_inner(init_ptr)
456 // Strong references should collectively own a shared weak reference,
457 // so don't run the destructor for our old weak reference.
462 /// Constructs a new `Arc` with uninitialized contents.
467 /// #![feature(new_uninit)]
468 /// #![feature(get_mut_unchecked)]
470 /// use std::sync::Arc;
472 /// let mut five = Arc::<u32>::new_uninit();
474 /// // Deferred initialization:
475 /// Arc::get_mut(&mut five).unwrap().write(5);
477 /// let five = unsafe { five.assume_init() };
479 /// assert_eq!(*five, 5)
481 #[cfg(not(no_global_oom_handling))]
482 #[unstable(feature = "new_uninit", issue = "63291")]
484 pub fn new_uninit() -> Arc<mem::MaybeUninit<T>> {
486 Arc::from_ptr(Arc::allocate_for_layout(
488 |layout| Global.allocate(layout),
489 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
494 /// Constructs a new `Arc` with uninitialized contents, with the memory
495 /// being filled with `0` bytes.
497 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
503 /// #![feature(new_uninit)]
505 /// use std::sync::Arc;
507 /// let zero = Arc::<u32>::new_zeroed();
508 /// let zero = unsafe { zero.assume_init() };
510 /// assert_eq!(*zero, 0)
513 /// [zeroed]: mem::MaybeUninit::zeroed
514 #[cfg(not(no_global_oom_handling))]
515 #[unstable(feature = "new_uninit", issue = "63291")]
517 pub fn new_zeroed() -> Arc<mem::MaybeUninit<T>> {
519 Arc::from_ptr(Arc::allocate_for_layout(
521 |layout| Global.allocate_zeroed(layout),
522 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
527 /// Constructs a new `Pin<Arc<T>>`. If `T` does not implement `Unpin`, then
528 /// `data` will be pinned in memory and unable to be moved.
529 #[cfg(not(no_global_oom_handling))]
530 #[stable(feature = "pin", since = "1.33.0")]
532 pub fn pin(data: T) -> Pin<Arc<T>> {
533 unsafe { Pin::new_unchecked(Arc::new(data)) }
536 /// Constructs a new `Pin<Arc<T>>`, return an error if allocation fails.
537 #[unstable(feature = "allocator_api", issue = "32838")]
539 pub fn try_pin(data: T) -> Result<Pin<Arc<T>>, AllocError> {
540 unsafe { Ok(Pin::new_unchecked(Arc::try_new(data)?)) }
543 /// Constructs a new `Arc<T>`, returning an error if allocation fails.
548 /// #![feature(allocator_api)]
549 /// use std::sync::Arc;
551 /// let five = Arc::try_new(5)?;
552 /// # Ok::<(), std::alloc::AllocError>(())
554 #[unstable(feature = "allocator_api", issue = "32838")]
556 pub fn try_new(data: T) -> Result<Arc<T>, AllocError> {
557 // Start the weak pointer count as 1 which is the weak pointer that's
558 // held by all the strong pointers (kinda), see std/rc.rs for more info
559 let x: Box<_> = Box::try_new(ArcInner {
560 strong: atomic::AtomicUsize::new(1),
561 weak: atomic::AtomicUsize::new(1),
564 unsafe { Ok(Self::from_inner(Box::leak(x).into())) }
567 /// Constructs a new `Arc` with uninitialized contents, returning an error
568 /// if allocation fails.
573 /// #![feature(new_uninit, allocator_api)]
574 /// #![feature(get_mut_unchecked)]
576 /// use std::sync::Arc;
578 /// let mut five = Arc::<u32>::try_new_uninit()?;
580 /// // Deferred initialization:
581 /// Arc::get_mut(&mut five).unwrap().write(5);
583 /// let five = unsafe { five.assume_init() };
585 /// assert_eq!(*five, 5);
586 /// # Ok::<(), std::alloc::AllocError>(())
588 #[unstable(feature = "allocator_api", issue = "32838")]
589 // #[unstable(feature = "new_uninit", issue = "63291")]
590 pub fn try_new_uninit() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
592 Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
594 |layout| Global.allocate(layout),
595 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
600 /// Constructs a new `Arc` with uninitialized contents, with the memory
601 /// being filled with `0` bytes, returning an error if allocation fails.
603 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
609 /// #![feature(new_uninit, allocator_api)]
611 /// use std::sync::Arc;
613 /// let zero = Arc::<u32>::try_new_zeroed()?;
614 /// let zero = unsafe { zero.assume_init() };
616 /// assert_eq!(*zero, 0);
617 /// # Ok::<(), std::alloc::AllocError>(())
620 /// [zeroed]: mem::MaybeUninit::zeroed
621 #[unstable(feature = "allocator_api", issue = "32838")]
622 // #[unstable(feature = "new_uninit", issue = "63291")]
623 pub fn try_new_zeroed() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
625 Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
627 |layout| Global.allocate_zeroed(layout),
628 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
632 /// Returns the inner value, if the `Arc` has exactly one strong reference.
634 /// Otherwise, an [`Err`] is returned with the same `Arc` that was
637 /// This will succeed even if there are outstanding weak references.
642 /// use std::sync::Arc;
644 /// let x = Arc::new(3);
645 /// assert_eq!(Arc::try_unwrap(x), Ok(3));
647 /// let x = Arc::new(4);
648 /// let _y = Arc::clone(&x);
649 /// assert_eq!(*Arc::try_unwrap(x).unwrap_err(), 4);
652 #[stable(feature = "arc_unique", since = "1.4.0")]
653 pub fn try_unwrap(this: Self) -> Result<T, Self> {
654 if this.inner().strong.compare_exchange(1, 0, Relaxed, Relaxed).is_err() {
658 acquire!(this.inner().strong);
661 let elem = ptr::read(&this.ptr.as_ref().data);
663 // Make a weak pointer to clean up the implicit strong-weak reference
664 let _weak = Weak { ptr: this.ptr };
673 /// Constructs a new atomically reference-counted slice with uninitialized contents.
678 /// #![feature(new_uninit)]
679 /// #![feature(get_mut_unchecked)]
681 /// use std::sync::Arc;
683 /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
685 /// // Deferred initialization:
686 /// let data = Arc::get_mut(&mut values).unwrap();
687 /// data[0].write(1);
688 /// data[1].write(2);
689 /// data[2].write(3);
691 /// let values = unsafe { values.assume_init() };
693 /// assert_eq!(*values, [1, 2, 3])
695 #[cfg(not(no_global_oom_handling))]
696 #[unstable(feature = "new_uninit", issue = "63291")]
698 pub fn new_uninit_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
699 unsafe { Arc::from_ptr(Arc::allocate_for_slice(len)) }
702 /// Constructs a new atomically reference-counted slice with uninitialized contents, with the memory being
703 /// filled with `0` bytes.
705 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
706 /// incorrect usage of this method.
711 /// #![feature(new_uninit)]
713 /// use std::sync::Arc;
715 /// let values = Arc::<[u32]>::new_zeroed_slice(3);
716 /// let values = unsafe { values.assume_init() };
718 /// assert_eq!(*values, [0, 0, 0])
721 /// [zeroed]: mem::MaybeUninit::zeroed
722 #[cfg(not(no_global_oom_handling))]
723 #[unstable(feature = "new_uninit", issue = "63291")]
725 pub fn new_zeroed_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
727 Arc::from_ptr(Arc::allocate_for_layout(
728 Layout::array::<T>(len).unwrap(),
729 |layout| Global.allocate_zeroed(layout),
731 ptr::slice_from_raw_parts_mut(mem as *mut T, len)
732 as *mut ArcInner<[mem::MaybeUninit<T>]>
739 impl<T> Arc<mem::MaybeUninit<T>> {
740 /// Converts to `Arc<T>`.
744 /// As with [`MaybeUninit::assume_init`],
745 /// it is up to the caller to guarantee that the inner value
746 /// really is in an initialized state.
747 /// Calling this when the content is not yet fully initialized
748 /// causes immediate undefined behavior.
750 /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
755 /// #![feature(new_uninit)]
756 /// #![feature(get_mut_unchecked)]
758 /// use std::sync::Arc;
760 /// let mut five = Arc::<u32>::new_uninit();
762 /// // Deferred initialization:
763 /// Arc::get_mut(&mut five).unwrap().write(5);
765 /// let five = unsafe { five.assume_init() };
767 /// assert_eq!(*five, 5)
769 #[unstable(feature = "new_uninit", issue = "63291")]
770 #[must_use = "`self` will be dropped if the result is not used"]
772 pub unsafe fn assume_init(self) -> Arc<T> {
773 unsafe { Arc::from_inner(mem::ManuallyDrop::new(self).ptr.cast()) }
777 impl<T> Arc<[mem::MaybeUninit<T>]> {
778 /// Converts to `Arc<[T]>`.
782 /// As with [`MaybeUninit::assume_init`],
783 /// it is up to the caller to guarantee that the inner value
784 /// really is in an initialized state.
785 /// Calling this when the content is not yet fully initialized
786 /// causes immediate undefined behavior.
788 /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
793 /// #![feature(new_uninit)]
794 /// #![feature(get_mut_unchecked)]
796 /// use std::sync::Arc;
798 /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
800 /// // Deferred initialization:
801 /// let data = Arc::get_mut(&mut values).unwrap();
802 /// data[0].write(1);
803 /// data[1].write(2);
804 /// data[2].write(3);
806 /// let values = unsafe { values.assume_init() };
808 /// assert_eq!(*values, [1, 2, 3])
810 #[unstable(feature = "new_uninit", issue = "63291")]
811 #[must_use = "`self` will be dropped if the result is not used"]
813 pub unsafe fn assume_init(self) -> Arc<[T]> {
814 unsafe { Arc::from_ptr(mem::ManuallyDrop::new(self).ptr.as_ptr() as _) }
818 impl<T: ?Sized> Arc<T> {
819 /// Consumes the `Arc`, returning the wrapped pointer.
821 /// To avoid a memory leak the pointer must be converted back to an `Arc` using
822 /// [`Arc::from_raw`].
827 /// use std::sync::Arc;
829 /// let x = Arc::new("hello".to_owned());
830 /// let x_ptr = Arc::into_raw(x);
831 /// assert_eq!(unsafe { &*x_ptr }, "hello");
833 #[must_use = "losing the pointer will leak memory"]
834 #[stable(feature = "rc_raw", since = "1.17.0")]
835 pub fn into_raw(this: Self) -> *const T {
836 let ptr = Self::as_ptr(&this);
841 /// Provides a raw pointer to the data.
843 /// The counts are not affected in any way and the `Arc` is not consumed. The pointer is valid for
844 /// as long as there are strong counts in the `Arc`.
849 /// use std::sync::Arc;
851 /// let x = Arc::new("hello".to_owned());
852 /// let y = Arc::clone(&x);
853 /// let x_ptr = Arc::as_ptr(&x);
854 /// assert_eq!(x_ptr, Arc::as_ptr(&y));
855 /// assert_eq!(unsafe { &*x_ptr }, "hello");
858 #[stable(feature = "rc_as_ptr", since = "1.45.0")]
859 pub fn as_ptr(this: &Self) -> *const T {
860 let ptr: *mut ArcInner<T> = NonNull::as_ptr(this.ptr);
862 // SAFETY: This cannot go through Deref::deref or RcBoxPtr::inner because
863 // this is required to retain raw/mut provenance such that e.g. `get_mut` can
864 // write through the pointer after the Rc is recovered through `from_raw`.
865 unsafe { ptr::addr_of_mut!((*ptr).data) }
868 /// Constructs an `Arc<T>` from a raw pointer.
870 /// The raw pointer must have been previously returned by a call to
871 /// [`Arc<U>::into_raw`][into_raw] where `U` must have the same size and
872 /// alignment as `T`. This is trivially true if `U` is `T`.
873 /// Note that if `U` is not `T` but has the same size and alignment, this is
874 /// basically like transmuting references of different types. See
875 /// [`mem::transmute`][transmute] for more information on what
876 /// restrictions apply in this case.
878 /// The user of `from_raw` has to make sure a specific value of `T` is only
881 /// This function is unsafe because improper use may lead to memory unsafety,
882 /// even if the returned `Arc<T>` is never accessed.
884 /// [into_raw]: Arc::into_raw
885 /// [transmute]: core::mem::transmute
890 /// use std::sync::Arc;
892 /// let x = Arc::new("hello".to_owned());
893 /// let x_ptr = Arc::into_raw(x);
896 /// // Convert back to an `Arc` to prevent leak.
897 /// let x = Arc::from_raw(x_ptr);
898 /// assert_eq!(&*x, "hello");
900 /// // Further calls to `Arc::from_raw(x_ptr)` would be memory-unsafe.
903 /// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
905 #[stable(feature = "rc_raw", since = "1.17.0")]
906 pub unsafe fn from_raw(ptr: *const T) -> Self {
908 let offset = data_offset(ptr);
910 // Reverse the offset to find the original ArcInner.
911 let arc_ptr = ptr.byte_sub(offset) as *mut ArcInner<T>;
913 Self::from_ptr(arc_ptr)
917 /// Creates a new [`Weak`] pointer to this allocation.
922 /// use std::sync::Arc;
924 /// let five = Arc::new(5);
926 /// let weak_five = Arc::downgrade(&five);
928 #[must_use = "this returns a new `Weak` pointer, \
929 without modifying the original `Arc`"]
930 #[stable(feature = "arc_weak", since = "1.4.0")]
931 pub fn downgrade(this: &Self) -> Weak<T> {
932 // This Relaxed is OK because we're checking the value in the CAS
934 let mut cur = this.inner().weak.load(Relaxed);
937 // check if the weak counter is currently "locked"; if so, spin.
938 if cur == usize::MAX {
940 cur = this.inner().weak.load(Relaxed);
944 // NOTE: this code currently ignores the possibility of overflow
945 // into usize::MAX; in general both Rc and Arc need to be adjusted
946 // to deal with overflow.
948 // Unlike with Clone(), we need this to be an Acquire read to
949 // synchronize with the write coming from `is_unique`, so that the
950 // events prior to that write happen before this read.
951 match this.inner().weak.compare_exchange_weak(cur, cur + 1, Acquire, Relaxed) {
953 // Make sure we do not create a dangling Weak
954 debug_assert!(!is_dangling(this.ptr.as_ptr()));
955 return Weak { ptr: this.ptr };
957 Err(old) => cur = old,
962 /// Gets the number of [`Weak`] pointers to this allocation.
966 /// This method by itself is safe, but using it correctly requires extra care.
967 /// Another thread can change the weak count at any time,
968 /// including potentially between calling this method and acting on the result.
973 /// use std::sync::Arc;
975 /// let five = Arc::new(5);
976 /// let _weak_five = Arc::downgrade(&five);
978 /// // This assertion is deterministic because we haven't shared
979 /// // the `Arc` or `Weak` between threads.
980 /// assert_eq!(1, Arc::weak_count(&five));
984 #[stable(feature = "arc_counts", since = "1.15.0")]
985 pub fn weak_count(this: &Self) -> usize {
986 let cnt = this.inner().weak.load(Acquire);
987 // If the weak count is currently locked, the value of the
988 // count was 0 just before taking the lock.
989 if cnt == usize::MAX { 0 } else { cnt - 1 }
992 /// Gets the number of strong (`Arc`) pointers to this allocation.
996 /// This method by itself is safe, but using it correctly requires extra care.
997 /// Another thread can change the strong count at any time,
998 /// including potentially between calling this method and acting on the result.
1003 /// use std::sync::Arc;
1005 /// let five = Arc::new(5);
1006 /// let _also_five = Arc::clone(&five);
1008 /// // This assertion is deterministic because we haven't shared
1009 /// // the `Arc` between threads.
1010 /// assert_eq!(2, Arc::strong_count(&five));
1014 #[stable(feature = "arc_counts", since = "1.15.0")]
1015 pub fn strong_count(this: &Self) -> usize {
1016 this.inner().strong.load(Acquire)
1019 /// Increments the strong reference count on the `Arc<T>` associated with the
1020 /// provided pointer by one.
1024 /// The pointer must have been obtained through `Arc::into_raw`, and the
1025 /// associated `Arc` instance must be valid (i.e. the strong count must be at
1026 /// least 1) for the duration of this method.
1031 /// use std::sync::Arc;
1033 /// let five = Arc::new(5);
1036 /// let ptr = Arc::into_raw(five);
1037 /// Arc::increment_strong_count(ptr);
1039 /// // This assertion is deterministic because we haven't shared
1040 /// // the `Arc` between threads.
1041 /// let five = Arc::from_raw(ptr);
1042 /// assert_eq!(2, Arc::strong_count(&five));
1046 #[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
1047 pub unsafe fn increment_strong_count(ptr: *const T) {
1048 // Retain Arc, but don't touch refcount by wrapping in ManuallyDrop
1049 let arc = unsafe { mem::ManuallyDrop::new(Arc::<T>::from_raw(ptr)) };
1050 // Now increase refcount, but don't drop new refcount either
1051 let _arc_clone: mem::ManuallyDrop<_> = arc.clone();
1054 /// Decrements the strong reference count on the `Arc<T>` associated with the
1055 /// provided pointer by one.
1059 /// The pointer must have been obtained through `Arc::into_raw`, and the
1060 /// associated `Arc` instance must be valid (i.e. the strong count must be at
1061 /// least 1) when invoking this method. This method can be used to release the final
1062 /// `Arc` and backing storage, but **should not** be called after the final `Arc` has been
1068 /// use std::sync::Arc;
1070 /// let five = Arc::new(5);
1073 /// let ptr = Arc::into_raw(five);
1074 /// Arc::increment_strong_count(ptr);
1076 /// // Those assertions are deterministic because we haven't shared
1077 /// // the `Arc` between threads.
1078 /// let five = Arc::from_raw(ptr);
1079 /// assert_eq!(2, Arc::strong_count(&five));
1080 /// Arc::decrement_strong_count(ptr);
1081 /// assert_eq!(1, Arc::strong_count(&five));
1085 #[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
1086 pub unsafe fn decrement_strong_count(ptr: *const T) {
1087 unsafe { mem::drop(Arc::from_raw(ptr)) };
1091 fn inner(&self) -> &ArcInner<T> {
1092 // This unsafety is ok because while this arc is alive we're guaranteed
1093 // that the inner pointer is valid. Furthermore, we know that the
1094 // `ArcInner` structure itself is `Sync` because the inner data is
1095 // `Sync` as well, so we're ok loaning out an immutable pointer to these
1097 unsafe { self.ptr.as_ref() }
1100 // Non-inlined part of `drop`.
1102 unsafe fn drop_slow(&mut self) {
1103 // Destroy the data at this time, even though we must not free the box
1104 // allocation itself (there might still be weak pointers lying around).
1105 unsafe { ptr::drop_in_place(Self::get_mut_unchecked(self)) };
1107 // Drop the weak ref collectively held by all strong references
1108 drop(Weak { ptr: self.ptr });
1111 /// Returns `true` if the two `Arc`s point to the same allocation
1112 /// (in a vein similar to [`ptr::eq`]).
1117 /// use std::sync::Arc;
1119 /// let five = Arc::new(5);
1120 /// let same_five = Arc::clone(&five);
1121 /// let other_five = Arc::new(5);
1123 /// assert!(Arc::ptr_eq(&five, &same_five));
1124 /// assert!(!Arc::ptr_eq(&five, &other_five));
1127 /// [`ptr::eq`]: core::ptr::eq "ptr::eq"
1130 #[stable(feature = "ptr_eq", since = "1.17.0")]
1131 pub fn ptr_eq(this: &Self, other: &Self) -> bool {
1132 this.ptr.as_ptr() == other.ptr.as_ptr()
1136 impl<T: ?Sized> Arc<T> {
1137 /// Allocates an `ArcInner<T>` with sufficient space for
1138 /// a possibly-unsized inner value where the value has the layout provided.
1140 /// The function `mem_to_arcinner` is called with the data pointer
1141 /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
1142 #[cfg(not(no_global_oom_handling))]
1143 unsafe fn allocate_for_layout(
1144 value_layout: Layout,
1145 allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1146 mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
1147 ) -> *mut ArcInner<T> {
1148 // Calculate layout using the given value layout.
1149 // Previously, layout was calculated on the expression
1150 // `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
1151 // reference (see #54908).
1152 let layout = Layout::new::<ArcInner<()>>().extend(value_layout).unwrap().0.pad_to_align();
1154 Arc::try_allocate_for_layout(value_layout, allocate, mem_to_arcinner)
1155 .unwrap_or_else(|_| handle_alloc_error(layout))
1159 /// Allocates an `ArcInner<T>` with sufficient space for
1160 /// a possibly-unsized inner value where the value has the layout provided,
1161 /// returning an error if allocation fails.
1163 /// The function `mem_to_arcinner` is called with the data pointer
1164 /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
1165 unsafe fn try_allocate_for_layout(
1166 value_layout: Layout,
1167 allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1168 mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
1169 ) -> Result<*mut ArcInner<T>, AllocError> {
1170 // Calculate layout using the given value layout.
1171 // Previously, layout was calculated on the expression
1172 // `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
1173 // reference (see #54908).
1174 let layout = Layout::new::<ArcInner<()>>().extend(value_layout).unwrap().0.pad_to_align();
1176 let ptr = allocate(layout)?;
1178 // Initialize the ArcInner
1179 let inner = mem_to_arcinner(ptr.as_non_null_ptr().as_ptr());
1180 debug_assert_eq!(unsafe { Layout::for_value(&*inner) }, layout);
1183 ptr::write(&mut (*inner).strong, atomic::AtomicUsize::new(1));
1184 ptr::write(&mut (*inner).weak, atomic::AtomicUsize::new(1));
1190 /// Allocates an `ArcInner<T>` with sufficient space for an unsized inner value.
1191 #[cfg(not(no_global_oom_handling))]
1192 unsafe fn allocate_for_ptr(ptr: *const T) -> *mut ArcInner<T> {
1193 // Allocate for the `ArcInner<T>` using the given value.
1195 Self::allocate_for_layout(
1196 Layout::for_value(&*ptr),
1197 |layout| Global.allocate(layout),
1198 |mem| mem.with_metadata_of(ptr as *mut ArcInner<T>),
1203 #[cfg(not(no_global_oom_handling))]
1204 fn from_box(v: Box<T>) -> Arc<T> {
1206 let (box_unique, alloc) = Box::into_unique(v);
1207 let bptr = box_unique.as_ptr();
1209 let value_size = size_of_val(&*bptr);
1210 let ptr = Self::allocate_for_ptr(bptr);
1212 // Copy value as bytes
1213 ptr::copy_nonoverlapping(
1214 bptr as *const T as *const u8,
1215 &mut (*ptr).data as *mut _ as *mut u8,
1219 // Free the allocation without dropping its contents
1220 box_free(box_unique, alloc);
1228 /// Allocates an `ArcInner<[T]>` with the given length.
1229 #[cfg(not(no_global_oom_handling))]
1230 unsafe fn allocate_for_slice(len: usize) -> *mut ArcInner<[T]> {
1232 Self::allocate_for_layout(
1233 Layout::array::<T>(len).unwrap(),
1234 |layout| Global.allocate(layout),
1235 |mem| ptr::slice_from_raw_parts_mut(mem as *mut T, len) as *mut ArcInner<[T]>,
1240 /// Copy elements from slice into newly allocated Arc<\[T\]>
1242 /// Unsafe because the caller must either take ownership or bind `T: Copy`.
1243 #[cfg(not(no_global_oom_handling))]
1244 unsafe fn copy_from_slice(v: &[T]) -> Arc<[T]> {
1246 let ptr = Self::allocate_for_slice(v.len());
1248 ptr::copy_nonoverlapping(v.as_ptr(), &mut (*ptr).data as *mut [T] as *mut T, v.len());
1254 /// Constructs an `Arc<[T]>` from an iterator known to be of a certain size.
1256 /// Behavior is undefined should the size be wrong.
1257 #[cfg(not(no_global_oom_handling))]
1258 unsafe fn from_iter_exact(iter: impl iter::Iterator<Item = T>, len: usize) -> Arc<[T]> {
1259 // Panic guard while cloning T elements.
1260 // In the event of a panic, elements that have been written
1261 // into the new ArcInner will be dropped, then the memory freed.
1269 impl<T> Drop for Guard<T> {
1270 fn drop(&mut self) {
1272 let slice = from_raw_parts_mut(self.elems, self.n_elems);
1273 ptr::drop_in_place(slice);
1275 Global.deallocate(self.mem, self.layout);
1281 let ptr = Self::allocate_for_slice(len);
1283 let mem = ptr as *mut _ as *mut u8;
1284 let layout = Layout::for_value(&*ptr);
1286 // Pointer to first element
1287 let elems = &mut (*ptr).data as *mut [T] as *mut T;
1289 let mut guard = Guard { mem: NonNull::new_unchecked(mem), elems, layout, n_elems: 0 };
1291 for (i, item) in iter.enumerate() {
1292 ptr::write(elems.add(i), item);
1296 // All clear. Forget the guard so it doesn't free the new ArcInner.
1304 /// Specialization trait used for `From<&[T]>`.
1305 #[cfg(not(no_global_oom_handling))]
1306 trait ArcFromSlice<T> {
1307 fn from_slice(slice: &[T]) -> Self;
1310 #[cfg(not(no_global_oom_handling))]
1311 impl<T: Clone> ArcFromSlice<T> for Arc<[T]> {
1313 default fn from_slice(v: &[T]) -> Self {
1314 unsafe { Self::from_iter_exact(v.iter().cloned(), v.len()) }
1318 #[cfg(not(no_global_oom_handling))]
1319 impl<T: Copy> ArcFromSlice<T> for Arc<[T]> {
1321 fn from_slice(v: &[T]) -> Self {
1322 unsafe { Arc::copy_from_slice(v) }
1326 #[stable(feature = "rust1", since = "1.0.0")]
1327 impl<T: ?Sized> Clone for Arc<T> {
1328 /// Makes a clone of the `Arc` pointer.
1330 /// This creates another pointer to the same allocation, increasing the
1331 /// strong reference count.
1336 /// use std::sync::Arc;
1338 /// let five = Arc::new(5);
1340 /// let _ = Arc::clone(&five);
1343 fn clone(&self) -> Arc<T> {
1344 // Using a relaxed ordering is alright here, as knowledge of the
1345 // original reference prevents other threads from erroneously deleting
1348 // As explained in the [Boost documentation][1], Increasing the
1349 // reference counter can always be done with memory_order_relaxed: New
1350 // references to an object can only be formed from an existing
1351 // reference, and passing an existing reference from one thread to
1352 // another must already provide any required synchronization.
1354 // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1355 let old_size = self.inner().strong.fetch_add(1, Relaxed);
1357 // However we need to guard against massive refcounts in case someone is `mem::forget`ing
1358 // Arcs. If we don't do this the count can overflow and users will use-after free. This
1359 // branch will never be taken in any realistic program. We abort because such a program is
1360 // incredibly degenerate, and we don't care to support it.
1362 // This check is not 100% water-proof: we error when the refcount grows beyond `isize::MAX`.
1363 // But we do that check *after* having done the increment, so there is a chance here that
1364 // the worst already happened and we actually do overflow the `usize` counter. However, that
1365 // requires the counter to grow from `isize::MAX` to `usize::MAX` between the increment
1366 // above and the `abort` below, which seems exceedingly unlikely.
1367 if old_size > MAX_REFCOUNT {
1371 unsafe { Self::from_inner(self.ptr) }
1375 #[stable(feature = "rust1", since = "1.0.0")]
1376 impl<T: ?Sized> Deref for Arc<T> {
1380 fn deref(&self) -> &T {
1385 #[unstable(feature = "receiver_trait", issue = "none")]
1386 impl<T: ?Sized> Receiver for Arc<T> {}
1388 impl<T: Clone> Arc<T> {
1389 /// Makes a mutable reference into the given `Arc`.
1391 /// If there are other `Arc` pointers to the same allocation, then `make_mut` will
1392 /// [`clone`] the inner value to a new allocation to ensure unique ownership. This is also
1393 /// referred to as clone-on-write.
1395 /// However, if there are no other `Arc` pointers to this allocation, but some [`Weak`]
1396 /// pointers, then the [`Weak`] pointers will be dissociated and the inner value will not
1399 /// See also [`get_mut`], which will fail rather than cloning the inner value
1400 /// or dissociating [`Weak`] pointers.
1402 /// [`clone`]: Clone::clone
1403 /// [`get_mut`]: Arc::get_mut
1408 /// use std::sync::Arc;
1410 /// let mut data = Arc::new(5);
1412 /// *Arc::make_mut(&mut data) += 1; // Won't clone anything
1413 /// let mut other_data = Arc::clone(&data); // Won't clone inner data
1414 /// *Arc::make_mut(&mut data) += 1; // Clones inner data
1415 /// *Arc::make_mut(&mut data) += 1; // Won't clone anything
1416 /// *Arc::make_mut(&mut other_data) *= 2; // Won't clone anything
1418 /// // Now `data` and `other_data` point to different allocations.
1419 /// assert_eq!(*data, 8);
1420 /// assert_eq!(*other_data, 12);
1423 /// [`Weak`] pointers will be dissociated:
1426 /// use std::sync::Arc;
1428 /// let mut data = Arc::new(75);
1429 /// let weak = Arc::downgrade(&data);
1431 /// assert!(75 == *data);
1432 /// assert!(75 == *weak.upgrade().unwrap());
1434 /// *Arc::make_mut(&mut data) += 1;
1436 /// assert!(76 == *data);
1437 /// assert!(weak.upgrade().is_none());
1439 #[cfg(not(no_global_oom_handling))]
1441 #[stable(feature = "arc_unique", since = "1.4.0")]
1442 pub fn make_mut(this: &mut Self) -> &mut T {
1443 // Note that we hold both a strong reference and a weak reference.
1444 // Thus, releasing our strong reference only will not, by itself, cause
1445 // the memory to be deallocated.
1447 // Use Acquire to ensure that we see any writes to `weak` that happen
1448 // before release writes (i.e., decrements) to `strong`. Since we hold a
1449 // weak count, there's no chance the ArcInner itself could be
1451 if this.inner().strong.compare_exchange(1, 0, Acquire, Relaxed).is_err() {
1452 // Another strong pointer exists, so we must clone.
1453 // Pre-allocate memory to allow writing the cloned value directly.
1454 let mut arc = Self::new_uninit();
1456 let data = Arc::get_mut_unchecked(&mut arc);
1457 (**this).write_clone_into_raw(data.as_mut_ptr());
1458 *this = arc.assume_init();
1460 } else if this.inner().weak.load(Relaxed) != 1 {
1461 // Relaxed suffices in the above because this is fundamentally an
1462 // optimization: we are always racing with weak pointers being
1463 // dropped. Worst case, we end up allocated a new Arc unnecessarily.
1465 // We removed the last strong ref, but there are additional weak
1466 // refs remaining. We'll move the contents to a new Arc, and
1467 // invalidate the other weak refs.
1469 // Note that it is not possible for the read of `weak` to yield
1470 // usize::MAX (i.e., locked), since the weak count can only be
1471 // locked by a thread with a strong reference.
1473 // Materialize our own implicit weak pointer, so that it can clean
1474 // up the ArcInner as needed.
1475 let _weak = Weak { ptr: this.ptr };
1477 // Can just steal the data, all that's left is Weaks
1478 let mut arc = Self::new_uninit();
1480 let data = Arc::get_mut_unchecked(&mut arc);
1481 data.as_mut_ptr().copy_from_nonoverlapping(&**this, 1);
1482 ptr::write(this, arc.assume_init());
1485 // We were the sole reference of either kind; bump back up the
1486 // strong ref count.
1487 this.inner().strong.store(1, Release);
1490 // As with `get_mut()`, the unsafety is ok because our reference was
1491 // either unique to begin with, or became one upon cloning the contents.
1492 unsafe { Self::get_mut_unchecked(this) }
1495 /// If we have the only reference to `T` then unwrap it. Otherwise, clone `T` and return the
1498 /// Assuming `arc_t` is of type `Arc<T>`, this function is functionally equivalent to
1499 /// `(*arc_t).clone()`, but will avoid cloning the inner value where possible.
1504 /// #![feature(arc_unwrap_or_clone)]
1505 /// # use std::{ptr, sync::Arc};
1506 /// let inner = String::from("test");
1507 /// let ptr = inner.as_ptr();
1509 /// let arc = Arc::new(inner);
1510 /// let inner = Arc::unwrap_or_clone(arc);
1511 /// // The inner value was not cloned
1512 /// assert!(ptr::eq(ptr, inner.as_ptr()));
1514 /// let arc = Arc::new(inner);
1515 /// let arc2 = arc.clone();
1516 /// let inner = Arc::unwrap_or_clone(arc);
1517 /// // Because there were 2 references, we had to clone the inner value.
1518 /// assert!(!ptr::eq(ptr, inner.as_ptr()));
1519 /// // `arc2` is the last reference, so when we unwrap it we get back
1520 /// // the original `String`.
1521 /// let inner = Arc::unwrap_or_clone(arc2);
1522 /// assert!(ptr::eq(ptr, inner.as_ptr()));
1525 #[unstable(feature = "arc_unwrap_or_clone", issue = "93610")]
1526 pub fn unwrap_or_clone(this: Self) -> T {
1527 Arc::try_unwrap(this).unwrap_or_else(|arc| (*arc).clone())
1531 impl<T: ?Sized> Arc<T> {
1532 /// Returns a mutable reference into the given `Arc`, if there are
1533 /// no other `Arc` or [`Weak`] pointers to the same allocation.
1535 /// Returns [`None`] otherwise, because it is not safe to
1536 /// mutate a shared value.
1538 /// See also [`make_mut`][make_mut], which will [`clone`][clone]
1539 /// the inner value when there are other `Arc` pointers.
1541 /// [make_mut]: Arc::make_mut
1542 /// [clone]: Clone::clone
1547 /// use std::sync::Arc;
1549 /// let mut x = Arc::new(3);
1550 /// *Arc::get_mut(&mut x).unwrap() = 4;
1551 /// assert_eq!(*x, 4);
1553 /// let _y = Arc::clone(&x);
1554 /// assert!(Arc::get_mut(&mut x).is_none());
1557 #[stable(feature = "arc_unique", since = "1.4.0")]
1558 pub fn get_mut(this: &mut Self) -> Option<&mut T> {
1559 if this.is_unique() {
1560 // This unsafety is ok because we're guaranteed that the pointer
1561 // returned is the *only* pointer that will ever be returned to T. Our
1562 // reference count is guaranteed to be 1 at this point, and we required
1563 // the Arc itself to be `mut`, so we're returning the only possible
1564 // reference to the inner data.
1565 unsafe { Some(Arc::get_mut_unchecked(this)) }
1571 /// Returns a mutable reference into the given `Arc`,
1572 /// without any check.
1574 /// See also [`get_mut`], which is safe and does appropriate checks.
1576 /// [`get_mut`]: Arc::get_mut
1580 /// Any other `Arc` or [`Weak`] pointers to the same allocation must not be dereferenced
1581 /// for the duration of the returned borrow.
1582 /// This is trivially the case if no such pointers exist,
1583 /// for example immediately after `Arc::new`.
1588 /// #![feature(get_mut_unchecked)]
1590 /// use std::sync::Arc;
1592 /// let mut x = Arc::new(String::new());
1594 /// Arc::get_mut_unchecked(&mut x).push_str("foo")
1596 /// assert_eq!(*x, "foo");
1599 #[unstable(feature = "get_mut_unchecked", issue = "63292")]
1600 pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
1601 // We are careful to *not* create a reference covering the "count" fields, as
1602 // this would alias with concurrent access to the reference counts (e.g. by `Weak`).
1603 unsafe { &mut (*this.ptr.as_ptr()).data }
1606 /// Determine whether this is the unique reference (including weak refs) to
1607 /// the underlying data.
1609 /// Note that this requires locking the weak ref count.
1610 fn is_unique(&mut self) -> bool {
1611 // lock the weak pointer count if we appear to be the sole weak pointer
1614 // The acquire label here ensures a happens-before relationship with any
1615 // writes to `strong` (in particular in `Weak::upgrade`) prior to decrements
1616 // of the `weak` count (via `Weak::drop`, which uses release). If the upgraded
1617 // weak ref was never dropped, the CAS here will fail so we do not care to synchronize.
1618 if self.inner().weak.compare_exchange(1, usize::MAX, Acquire, Relaxed).is_ok() {
1619 // This needs to be an `Acquire` to synchronize with the decrement of the `strong`
1620 // counter in `drop` -- the only access that happens when any but the last reference
1621 // is being dropped.
1622 let unique = self.inner().strong.load(Acquire) == 1;
1624 // The release write here synchronizes with a read in `downgrade`,
1625 // effectively preventing the above read of `strong` from happening
1627 self.inner().weak.store(1, Release); // release the lock
1635 #[stable(feature = "rust1", since = "1.0.0")]
1636 unsafe impl<#[may_dangle] T: ?Sized> Drop for Arc<T> {
1637 /// Drops the `Arc`.
1639 /// This will decrement the strong reference count. If the strong reference
1640 /// count reaches zero then the only other references (if any) are
1641 /// [`Weak`], so we `drop` the inner value.
1646 /// use std::sync::Arc;
1650 /// impl Drop for Foo {
1651 /// fn drop(&mut self) {
1652 /// println!("dropped!");
1656 /// let foo = Arc::new(Foo);
1657 /// let foo2 = Arc::clone(&foo);
1659 /// drop(foo); // Doesn't print anything
1660 /// drop(foo2); // Prints "dropped!"
1663 fn drop(&mut self) {
1664 // Because `fetch_sub` is already atomic, we do not need to synchronize
1665 // with other threads unless we are going to delete the object. This
1666 // same logic applies to the below `fetch_sub` to the `weak` count.
1667 if self.inner().strong.fetch_sub(1, Release) != 1 {
1671 // This fence is needed to prevent reordering of use of the data and
1672 // deletion of the data. Because it is marked `Release`, the decreasing
1673 // of the reference count synchronizes with this `Acquire` fence. This
1674 // means that use of the data happens before decreasing the reference
1675 // count, which happens before this fence, which happens before the
1676 // deletion of the data.
1678 // As explained in the [Boost documentation][1],
1680 // > It is important to enforce any possible access to the object in one
1681 // > thread (through an existing reference) to *happen before* deleting
1682 // > the object in a different thread. This is achieved by a "release"
1683 // > operation after dropping a reference (any access to the object
1684 // > through this reference must obviously happened before), and an
1685 // > "acquire" operation before deleting the object.
1687 // In particular, while the contents of an Arc are usually immutable, it's
1688 // possible to have interior writes to something like a Mutex<T>. Since a
1689 // Mutex is not acquired when it is deleted, we can't rely on its
1690 // synchronization logic to make writes in thread A visible to a destructor
1691 // running in thread B.
1693 // Also note that the Acquire fence here could probably be replaced with an
1694 // Acquire load, which could improve performance in highly-contended
1695 // situations. See [2].
1697 // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1698 // [2]: (https://github.com/rust-lang/rust/pull/41714)
1699 acquire!(self.inner().strong);
1707 impl Arc<dyn Any + Send + Sync> {
1708 /// Attempt to downcast the `Arc<dyn Any + Send + Sync>` to a concrete type.
1713 /// use std::any::Any;
1714 /// use std::sync::Arc;
1716 /// fn print_if_string(value: Arc<dyn Any + Send + Sync>) {
1717 /// if let Ok(string) = value.downcast::<String>() {
1718 /// println!("String ({}): {}", string.len(), string);
1722 /// let my_string = "Hello World".to_string();
1723 /// print_if_string(Arc::new(my_string));
1724 /// print_if_string(Arc::new(0i8));
1727 #[stable(feature = "rc_downcast", since = "1.29.0")]
1728 pub fn downcast<T>(self) -> Result<Arc<T>, Self>
1730 T: Any + Send + Sync,
1732 if (*self).is::<T>() {
1734 let ptr = self.ptr.cast::<ArcInner<T>>();
1736 Ok(Arc::from_inner(ptr))
1743 /// Downcasts the `Arc<dyn Any + Send + Sync>` to a concrete type.
1745 /// For a safe alternative see [`downcast`].
1750 /// #![feature(downcast_unchecked)]
1752 /// use std::any::Any;
1753 /// use std::sync::Arc;
1755 /// let x: Arc<dyn Any + Send + Sync> = Arc::new(1_usize);
1758 /// assert_eq!(*x.downcast_unchecked::<usize>(), 1);
1764 /// The contained value must be of type `T`. Calling this method
1765 /// with the incorrect type is *undefined behavior*.
1768 /// [`downcast`]: Self::downcast
1770 #[unstable(feature = "downcast_unchecked", issue = "90850")]
1771 pub unsafe fn downcast_unchecked<T>(self) -> Arc<T>
1773 T: Any + Send + Sync,
1776 let ptr = self.ptr.cast::<ArcInner<T>>();
1778 Arc::from_inner(ptr)
1784 /// Constructs a new `Weak<T>`, without allocating any memory.
1785 /// Calling [`upgrade`] on the return value always gives [`None`].
1787 /// [`upgrade`]: Weak::upgrade
1792 /// use std::sync::Weak;
1794 /// let empty: Weak<i64> = Weak::new();
1795 /// assert!(empty.upgrade().is_none());
1797 #[stable(feature = "downgraded_weak", since = "1.10.0")]
1798 #[rustc_const_unstable(feature = "const_weak_new", issue = "95091", reason = "recently added")]
1800 pub const fn new() -> Weak<T> {
1801 Weak { ptr: unsafe { NonNull::new_unchecked(ptr::invalid_mut::<ArcInner<T>>(usize::MAX)) } }
1805 /// Helper type to allow accessing the reference counts without
1806 /// making any assertions about the data field.
1807 struct WeakInner<'a> {
1808 weak: &'a atomic::AtomicUsize,
1809 strong: &'a atomic::AtomicUsize,
1812 impl<T: ?Sized> Weak<T> {
1813 /// Returns a raw pointer to the object `T` pointed to by this `Weak<T>`.
1815 /// The pointer is valid only if there are some strong references. The pointer may be dangling,
1816 /// unaligned or even [`null`] otherwise.
1821 /// use std::sync::Arc;
1824 /// let strong = Arc::new("hello".to_owned());
1825 /// let weak = Arc::downgrade(&strong);
1826 /// // Both point to the same object
1827 /// assert!(ptr::eq(&*strong, weak.as_ptr()));
1828 /// // The strong here keeps it alive, so we can still access the object.
1829 /// assert_eq!("hello", unsafe { &*weak.as_ptr() });
1832 /// // But not any more. We can do weak.as_ptr(), but accessing the pointer would lead to
1833 /// // undefined behaviour.
1834 /// // assert_eq!("hello", unsafe { &*weak.as_ptr() });
1837 /// [`null`]: core::ptr::null "ptr::null"
1839 #[stable(feature = "weak_into_raw", since = "1.45.0")]
1840 pub fn as_ptr(&self) -> *const T {
1841 let ptr: *mut ArcInner<T> = NonNull::as_ptr(self.ptr);
1843 if is_dangling(ptr) {
1844 // If the pointer is dangling, we return the sentinel directly. This cannot be
1845 // a valid payload address, as the payload is at least as aligned as ArcInner (usize).
1848 // SAFETY: if is_dangling returns false, then the pointer is dereferenceable.
1849 // The payload may be dropped at this point, and we have to maintain provenance,
1850 // so use raw pointer manipulation.
1851 unsafe { ptr::addr_of_mut!((*ptr).data) }
1855 /// Consumes the `Weak<T>` and turns it into a raw pointer.
1857 /// This converts the weak pointer into a raw pointer, while still preserving the ownership of
1858 /// one weak reference (the weak count is not modified by this operation). It can be turned
1859 /// back into the `Weak<T>` with [`from_raw`].
1861 /// The same restrictions of accessing the target of the pointer as with
1862 /// [`as_ptr`] apply.
1867 /// use std::sync::{Arc, Weak};
1869 /// let strong = Arc::new("hello".to_owned());
1870 /// let weak = Arc::downgrade(&strong);
1871 /// let raw = weak.into_raw();
1873 /// assert_eq!(1, Arc::weak_count(&strong));
1874 /// assert_eq!("hello", unsafe { &*raw });
1876 /// drop(unsafe { Weak::from_raw(raw) });
1877 /// assert_eq!(0, Arc::weak_count(&strong));
1880 /// [`from_raw`]: Weak::from_raw
1881 /// [`as_ptr`]: Weak::as_ptr
1882 #[must_use = "`self` will be dropped if the result is not used"]
1883 #[stable(feature = "weak_into_raw", since = "1.45.0")]
1884 pub fn into_raw(self) -> *const T {
1885 let result = self.as_ptr();
1890 /// Converts a raw pointer previously created by [`into_raw`] back into `Weak<T>`.
1892 /// This can be used to safely get a strong reference (by calling [`upgrade`]
1893 /// later) or to deallocate the weak count by dropping the `Weak<T>`.
1895 /// It takes ownership of one weak reference (with the exception of pointers created by [`new`],
1896 /// as these don't own anything; the method still works on them).
1900 /// The pointer must have originated from the [`into_raw`] and must still own its potential
1903 /// It is allowed for the strong count to be 0 at the time of calling this. Nevertheless, this
1904 /// takes ownership of one weak reference currently represented as a raw pointer (the weak
1905 /// count is not modified by this operation) and therefore it must be paired with a previous
1906 /// call to [`into_raw`].
1910 /// use std::sync::{Arc, Weak};
1912 /// let strong = Arc::new("hello".to_owned());
1914 /// let raw_1 = Arc::downgrade(&strong).into_raw();
1915 /// let raw_2 = Arc::downgrade(&strong).into_raw();
1917 /// assert_eq!(2, Arc::weak_count(&strong));
1919 /// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
1920 /// assert_eq!(1, Arc::weak_count(&strong));
1924 /// // Decrement the last weak count.
1925 /// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
1928 /// [`new`]: Weak::new
1929 /// [`into_raw`]: Weak::into_raw
1930 /// [`upgrade`]: Weak::upgrade
1931 #[stable(feature = "weak_into_raw", since = "1.45.0")]
1932 pub unsafe fn from_raw(ptr: *const T) -> Self {
1933 // See Weak::as_ptr for context on how the input pointer is derived.
1935 let ptr = if is_dangling(ptr as *mut T) {
1936 // This is a dangling Weak.
1937 ptr as *mut ArcInner<T>
1939 // Otherwise, we're guaranteed the pointer came from a nondangling Weak.
1940 // SAFETY: data_offset is safe to call, as ptr references a real (potentially dropped) T.
1941 let offset = unsafe { data_offset(ptr) };
1942 // Thus, we reverse the offset to get the whole RcBox.
1943 // SAFETY: the pointer originated from a Weak, so this offset is safe.
1944 unsafe { ptr.byte_sub(offset) as *mut ArcInner<T> }
1947 // SAFETY: we now have recovered the original Weak pointer, so can create the Weak.
1948 Weak { ptr: unsafe { NonNull::new_unchecked(ptr) } }
1952 impl<T: ?Sized> Weak<T> {
1953 /// Attempts to upgrade the `Weak` pointer to an [`Arc`], delaying
1954 /// dropping of the inner value if successful.
1956 /// Returns [`None`] if the inner value has since been dropped.
1961 /// use std::sync::Arc;
1963 /// let five = Arc::new(5);
1965 /// let weak_five = Arc::downgrade(&five);
1967 /// let strong_five: Option<Arc<_>> = weak_five.upgrade();
1968 /// assert!(strong_five.is_some());
1970 /// // Destroy all strong pointers.
1971 /// drop(strong_five);
1974 /// assert!(weak_five.upgrade().is_none());
1976 #[must_use = "this returns a new `Arc`, \
1977 without modifying the original weak pointer"]
1978 #[stable(feature = "arc_weak", since = "1.4.0")]
1979 pub fn upgrade(&self) -> Option<Arc<T>> {
1980 // We use a CAS loop to increment the strong count instead of a
1981 // fetch_add as this function should never take the reference count
1982 // from zero to one.
1983 let inner = self.inner()?;
1985 // Relaxed load because any write of 0 that we can observe
1986 // leaves the field in a permanently zero state (so a
1987 // "stale" read of 0 is fine), and any other value is
1988 // confirmed via the CAS below.
1989 let mut n = inner.strong.load(Relaxed);
1996 // See comments in `Arc::clone` for why we do this (for `mem::forget`).
1997 if n > MAX_REFCOUNT {
2001 // Relaxed is fine for the failure case because we don't have any expectations about the new state.
2002 // Acquire is necessary for the success case to synchronise with `Arc::new_cyclic`, when the inner
2003 // value can be initialized after `Weak` references have already been created. In that case, we
2004 // expect to observe the fully initialized value.
2005 match inner.strong.compare_exchange_weak(n, n + 1, Acquire, Relaxed) {
2006 Ok(_) => return Some(unsafe { Arc::from_inner(self.ptr) }), // null checked above
2007 Err(old) => n = old,
2012 /// Gets the number of strong (`Arc`) pointers pointing to this allocation.
2014 /// If `self` was created using [`Weak::new`], this will return 0.
2016 #[stable(feature = "weak_counts", since = "1.41.0")]
2017 pub fn strong_count(&self) -> usize {
2018 if let Some(inner) = self.inner() { inner.strong.load(Acquire) } else { 0 }
2021 /// Gets an approximation of the number of `Weak` pointers pointing to this
2024 /// If `self` was created using [`Weak::new`], or if there are no remaining
2025 /// strong pointers, this will return 0.
2029 /// Due to implementation details, the returned value can be off by 1 in
2030 /// either direction when other threads are manipulating any `Arc`s or
2031 /// `Weak`s pointing to the same allocation.
2033 #[stable(feature = "weak_counts", since = "1.41.0")]
2034 pub fn weak_count(&self) -> usize {
2037 let weak = inner.weak.load(Acquire);
2038 let strong = inner.strong.load(Acquire);
2042 // Since we observed that there was at least one strong pointer
2043 // after reading the weak count, we know that the implicit weak
2044 // reference (present whenever any strong references are alive)
2045 // was still around when we observed the weak count, and can
2046 // therefore safely subtract it.
2053 /// Returns `None` when the pointer is dangling and there is no allocated `ArcInner`,
2054 /// (i.e., when this `Weak` was created by `Weak::new`).
2056 fn inner(&self) -> Option<WeakInner<'_>> {
2057 if is_dangling(self.ptr.as_ptr()) {
2060 // We are careful to *not* create a reference covering the "data" field, as
2061 // the field may be mutated concurrently (for example, if the last `Arc`
2062 // is dropped, the data field will be dropped in-place).
2064 let ptr = self.ptr.as_ptr();
2065 WeakInner { strong: &(*ptr).strong, weak: &(*ptr).weak }
2070 /// Returns `true` if the two `Weak`s point to the same allocation (similar to
2071 /// [`ptr::eq`]), or if both don't point to any allocation
2072 /// (because they were created with `Weak::new()`).
2076 /// Since this compares pointers it means that `Weak::new()` will equal each
2077 /// other, even though they don't point to any allocation.
2082 /// use std::sync::Arc;
2084 /// let first_rc = Arc::new(5);
2085 /// let first = Arc::downgrade(&first_rc);
2086 /// let second = Arc::downgrade(&first_rc);
2088 /// assert!(first.ptr_eq(&second));
2090 /// let third_rc = Arc::new(5);
2091 /// let third = Arc::downgrade(&third_rc);
2093 /// assert!(!first.ptr_eq(&third));
2096 /// Comparing `Weak::new`.
2099 /// use std::sync::{Arc, Weak};
2101 /// let first = Weak::new();
2102 /// let second = Weak::new();
2103 /// assert!(first.ptr_eq(&second));
2105 /// let third_rc = Arc::new(());
2106 /// let third = Arc::downgrade(&third_rc);
2107 /// assert!(!first.ptr_eq(&third));
2110 /// [`ptr::eq`]: core::ptr::eq "ptr::eq"
2113 #[stable(feature = "weak_ptr_eq", since = "1.39.0")]
2114 pub fn ptr_eq(&self, other: &Self) -> bool {
2115 self.ptr.as_ptr() == other.ptr.as_ptr()
2119 #[stable(feature = "arc_weak", since = "1.4.0")]
2120 impl<T: ?Sized> Clone for Weak<T> {
2121 /// Makes a clone of the `Weak` pointer that points to the same allocation.
2126 /// use std::sync::{Arc, Weak};
2128 /// let weak_five = Arc::downgrade(&Arc::new(5));
2130 /// let _ = Weak::clone(&weak_five);
2133 fn clone(&self) -> Weak<T> {
2134 let inner = if let Some(inner) = self.inner() {
2137 return Weak { ptr: self.ptr };
2139 // See comments in Arc::clone() for why this is relaxed. This can use a
2140 // fetch_add (ignoring the lock) because the weak count is only locked
2141 // where are *no other* weak pointers in existence. (So we can't be
2142 // running this code in that case).
2143 let old_size = inner.weak.fetch_add(1, Relaxed);
2145 // See comments in Arc::clone() for why we do this (for mem::forget).
2146 if old_size > MAX_REFCOUNT {
2150 Weak { ptr: self.ptr }
2154 #[stable(feature = "downgraded_weak", since = "1.10.0")]
2155 impl<T> Default for Weak<T> {
2156 /// Constructs a new `Weak<T>`, without allocating memory.
2157 /// Calling [`upgrade`] on the return value always
2160 /// [`upgrade`]: Weak::upgrade
2165 /// use std::sync::Weak;
2167 /// let empty: Weak<i64> = Default::default();
2168 /// assert!(empty.upgrade().is_none());
2170 fn default() -> Weak<T> {
2175 #[stable(feature = "arc_weak", since = "1.4.0")]
2176 unsafe impl<#[may_dangle] T: ?Sized> Drop for Weak<T> {
2177 /// Drops the `Weak` pointer.
2182 /// use std::sync::{Arc, Weak};
2186 /// impl Drop for Foo {
2187 /// fn drop(&mut self) {
2188 /// println!("dropped!");
2192 /// let foo = Arc::new(Foo);
2193 /// let weak_foo = Arc::downgrade(&foo);
2194 /// let other_weak_foo = Weak::clone(&weak_foo);
2196 /// drop(weak_foo); // Doesn't print anything
2197 /// drop(foo); // Prints "dropped!"
2199 /// assert!(other_weak_foo.upgrade().is_none());
2201 fn drop(&mut self) {
2202 // If we find out that we were the last weak pointer, then its time to
2203 // deallocate the data entirely. See the discussion in Arc::drop() about
2204 // the memory orderings
2206 // It's not necessary to check for the locked state here, because the
2207 // weak count can only be locked if there was precisely one weak ref,
2208 // meaning that drop could only subsequently run ON that remaining weak
2209 // ref, which can only happen after the lock is released.
2210 let inner = if let Some(inner) = self.inner() { inner } else { return };
2212 if inner.weak.fetch_sub(1, Release) == 1 {
2213 acquire!(inner.weak);
2214 unsafe { Global.deallocate(self.ptr.cast(), Layout::for_value_raw(self.ptr.as_ptr())) }
2219 #[stable(feature = "rust1", since = "1.0.0")]
2220 trait ArcEqIdent<T: ?Sized + PartialEq> {
2221 fn eq(&self, other: &Arc<T>) -> bool;
2222 fn ne(&self, other: &Arc<T>) -> bool;
2225 #[stable(feature = "rust1", since = "1.0.0")]
2226 impl<T: ?Sized + PartialEq> ArcEqIdent<T> for Arc<T> {
2228 default fn eq(&self, other: &Arc<T>) -> bool {
2232 default fn ne(&self, other: &Arc<T>) -> bool {
2237 /// We're doing this specialization here, and not as a more general optimization on `&T`, because it
2238 /// would otherwise add a cost to all equality checks on refs. We assume that `Arc`s are used to
2239 /// store large values, that are slow to clone, but also heavy to check for equality, causing this
2240 /// cost to pay off more easily. It's also more likely to have two `Arc` clones, that point to
2241 /// the same value, than two `&T`s.
2243 /// We can only do this when `T: Eq` as a `PartialEq` might be deliberately irreflexive.
2244 #[stable(feature = "rust1", since = "1.0.0")]
2245 impl<T: ?Sized + crate::rc::MarkerEq> ArcEqIdent<T> for Arc<T> {
2247 fn eq(&self, other: &Arc<T>) -> bool {
2248 Arc::ptr_eq(self, other) || **self == **other
2252 fn ne(&self, other: &Arc<T>) -> bool {
2253 !Arc::ptr_eq(self, other) && **self != **other
2257 #[stable(feature = "rust1", since = "1.0.0")]
2258 impl<T: ?Sized + PartialEq> PartialEq for Arc<T> {
2259 /// Equality for two `Arc`s.
2261 /// Two `Arc`s are equal if their inner values are equal, even if they are
2262 /// stored in different allocation.
2264 /// If `T` also implements `Eq` (implying reflexivity of equality),
2265 /// two `Arc`s that point to the same allocation are always equal.
2270 /// use std::sync::Arc;
2272 /// let five = Arc::new(5);
2274 /// assert!(five == Arc::new(5));
2277 fn eq(&self, other: &Arc<T>) -> bool {
2278 ArcEqIdent::eq(self, other)
2281 /// Inequality for two `Arc`s.
2283 /// Two `Arc`s are unequal if their inner values are unequal.
2285 /// If `T` also implements `Eq` (implying reflexivity of equality),
2286 /// two `Arc`s that point to the same value are never unequal.
2291 /// use std::sync::Arc;
2293 /// let five = Arc::new(5);
2295 /// assert!(five != Arc::new(6));
2298 fn ne(&self, other: &Arc<T>) -> bool {
2299 ArcEqIdent::ne(self, other)
2303 #[stable(feature = "rust1", since = "1.0.0")]
2304 impl<T: ?Sized + PartialOrd> PartialOrd for Arc<T> {
2305 /// Partial comparison for two `Arc`s.
2307 /// The two are compared by calling `partial_cmp()` on their inner values.
2312 /// use std::sync::Arc;
2313 /// use std::cmp::Ordering;
2315 /// let five = Arc::new(5);
2317 /// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Arc::new(6)));
2319 fn partial_cmp(&self, other: &Arc<T>) -> Option<Ordering> {
2320 (**self).partial_cmp(&**other)
2323 /// Less-than comparison for two `Arc`s.
2325 /// The two are compared by calling `<` on their inner values.
2330 /// use std::sync::Arc;
2332 /// let five = Arc::new(5);
2334 /// assert!(five < Arc::new(6));
2336 fn lt(&self, other: &Arc<T>) -> bool {
2337 *(*self) < *(*other)
2340 /// 'Less than or equal to' comparison for two `Arc`s.
2342 /// The two are compared by calling `<=` on their inner values.
2347 /// use std::sync::Arc;
2349 /// let five = Arc::new(5);
2351 /// assert!(five <= Arc::new(5));
2353 fn le(&self, other: &Arc<T>) -> bool {
2354 *(*self) <= *(*other)
2357 /// Greater-than comparison for two `Arc`s.
2359 /// The two are compared by calling `>` on their inner values.
2364 /// use std::sync::Arc;
2366 /// let five = Arc::new(5);
2368 /// assert!(five > Arc::new(4));
2370 fn gt(&self, other: &Arc<T>) -> bool {
2371 *(*self) > *(*other)
2374 /// 'Greater than or equal to' comparison for two `Arc`s.
2376 /// The two are compared by calling `>=` on their inner values.
2381 /// use std::sync::Arc;
2383 /// let five = Arc::new(5);
2385 /// assert!(five >= Arc::new(5));
2387 fn ge(&self, other: &Arc<T>) -> bool {
2388 *(*self) >= *(*other)
2391 #[stable(feature = "rust1", since = "1.0.0")]
2392 impl<T: ?Sized + Ord> Ord for Arc<T> {
2393 /// Comparison for two `Arc`s.
2395 /// The two are compared by calling `cmp()` on their inner values.
2400 /// use std::sync::Arc;
2401 /// use std::cmp::Ordering;
2403 /// let five = Arc::new(5);
2405 /// assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));
2407 fn cmp(&self, other: &Arc<T>) -> Ordering {
2408 (**self).cmp(&**other)
2411 #[stable(feature = "rust1", since = "1.0.0")]
2412 impl<T: ?Sized + Eq> Eq for Arc<T> {}
2414 #[stable(feature = "rust1", since = "1.0.0")]
2415 impl<T: ?Sized + fmt::Display> fmt::Display for Arc<T> {
2416 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2417 fmt::Display::fmt(&**self, f)
2421 #[stable(feature = "rust1", since = "1.0.0")]
2422 impl<T: ?Sized + fmt::Debug> fmt::Debug for Arc<T> {
2423 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2424 fmt::Debug::fmt(&**self, f)
2428 #[stable(feature = "rust1", since = "1.0.0")]
2429 impl<T: ?Sized> fmt::Pointer for Arc<T> {
2430 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2431 fmt::Pointer::fmt(&(&**self as *const T), f)
2435 #[cfg(not(no_global_oom_handling))]
2436 #[stable(feature = "rust1", since = "1.0.0")]
2437 impl<T: Default> Default for Arc<T> {
2438 /// Creates a new `Arc<T>`, with the `Default` value for `T`.
2443 /// use std::sync::Arc;
2445 /// let x: Arc<i32> = Default::default();
2446 /// assert_eq!(*x, 0);
2448 fn default() -> Arc<T> {
2449 Arc::new(Default::default())
2453 #[stable(feature = "rust1", since = "1.0.0")]
2454 impl<T: ?Sized + Hash> Hash for Arc<T> {
2455 fn hash<H: Hasher>(&self, state: &mut H) {
2456 (**self).hash(state)
2460 #[cfg(not(no_global_oom_handling))]
2461 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
2462 impl<T> From<T> for Arc<T> {
2463 /// Converts a `T` into an `Arc<T>`
2465 /// The conversion moves the value into a
2466 /// newly allocated `Arc`. It is equivalent to
2467 /// calling `Arc::new(t)`.
2471 /// # use std::sync::Arc;
2473 /// let arc = Arc::new(5);
2475 /// assert_eq!(Arc::from(x), arc);
2477 fn from(t: T) -> Self {
2482 #[cfg(not(no_global_oom_handling))]
2483 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2484 impl<T: Clone> From<&[T]> for Arc<[T]> {
2485 /// Allocate a reference-counted slice and fill it by cloning `v`'s items.
2490 /// # use std::sync::Arc;
2491 /// let original: &[i32] = &[1, 2, 3];
2492 /// let shared: Arc<[i32]> = Arc::from(original);
2493 /// assert_eq!(&[1, 2, 3], &shared[..]);
2496 fn from(v: &[T]) -> Arc<[T]> {
2497 <Self as ArcFromSlice<T>>::from_slice(v)
2501 #[cfg(not(no_global_oom_handling))]
2502 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2503 impl From<&str> for Arc<str> {
2504 /// Allocate a reference-counted `str` and copy `v` into it.
2509 /// # use std::sync::Arc;
2510 /// let shared: Arc<str> = Arc::from("eggplant");
2511 /// assert_eq!("eggplant", &shared[..]);
2514 fn from(v: &str) -> Arc<str> {
2515 let arc = Arc::<[u8]>::from(v.as_bytes());
2516 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const str) }
2520 #[cfg(not(no_global_oom_handling))]
2521 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2522 impl From<String> for Arc<str> {
2523 /// Allocate a reference-counted `str` and copy `v` into it.
2528 /// # use std::sync::Arc;
2529 /// let unique: String = "eggplant".to_owned();
2530 /// let shared: Arc<str> = Arc::from(unique);
2531 /// assert_eq!("eggplant", &shared[..]);
2534 fn from(v: String) -> Arc<str> {
2539 #[cfg(not(no_global_oom_handling))]
2540 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2541 impl<T: ?Sized> From<Box<T>> for Arc<T> {
2542 /// Move a boxed object to a new, reference-counted allocation.
2547 /// # use std::sync::Arc;
2548 /// let unique: Box<str> = Box::from("eggplant");
2549 /// let shared: Arc<str> = Arc::from(unique);
2550 /// assert_eq!("eggplant", &shared[..]);
2553 fn from(v: Box<T>) -> Arc<T> {
2558 #[cfg(not(no_global_oom_handling))]
2559 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2560 impl<T> From<Vec<T>> for Arc<[T]> {
2561 /// Allocate a reference-counted slice and move `v`'s items into it.
2566 /// # use std::sync::Arc;
2567 /// let unique: Vec<i32> = vec![1, 2, 3];
2568 /// let shared: Arc<[i32]> = Arc::from(unique);
2569 /// assert_eq!(&[1, 2, 3], &shared[..]);
2572 fn from(mut v: Vec<T>) -> Arc<[T]> {
2574 let arc = Arc::copy_from_slice(&v);
2576 // Allow the Vec to free its memory, but not destroy its contents
2584 #[stable(feature = "shared_from_cow", since = "1.45.0")]
2585 impl<'a, B> From<Cow<'a, B>> for Arc<B>
2587 B: ToOwned + ?Sized,
2588 Arc<B>: From<&'a B> + From<B::Owned>,
2590 /// Create an atomically reference-counted pointer from
2591 /// a clone-on-write pointer by copying its content.
2596 /// # use std::sync::Arc;
2597 /// # use std::borrow::Cow;
2598 /// let cow: Cow<str> = Cow::Borrowed("eggplant");
2599 /// let shared: Arc<str> = Arc::from(cow);
2600 /// assert_eq!("eggplant", &shared[..]);
2603 fn from(cow: Cow<'a, B>) -> Arc<B> {
2605 Cow::Borrowed(s) => Arc::from(s),
2606 Cow::Owned(s) => Arc::from(s),
2611 #[stable(feature = "shared_from_str", since = "1.62.0")]
2612 impl From<Arc<str>> for Arc<[u8]> {
2613 /// Converts an atomically reference-counted string slice into a byte slice.
2618 /// # use std::sync::Arc;
2619 /// let string: Arc<str> = Arc::from("eggplant");
2620 /// let bytes: Arc<[u8]> = Arc::from(string);
2621 /// assert_eq!("eggplant".as_bytes(), bytes.as_ref());
2624 fn from(rc: Arc<str>) -> Self {
2625 // SAFETY: `str` has the same layout as `[u8]`.
2626 unsafe { Arc::from_raw(Arc::into_raw(rc) as *const [u8]) }
2630 #[stable(feature = "boxed_slice_try_from", since = "1.43.0")]
2631 impl<T, const N: usize> TryFrom<Arc<[T]>> for Arc<[T; N]> {
2632 type Error = Arc<[T]>;
2634 fn try_from(boxed_slice: Arc<[T]>) -> Result<Self, Self::Error> {
2635 if boxed_slice.len() == N {
2636 Ok(unsafe { Arc::from_raw(Arc::into_raw(boxed_slice) as *mut [T; N]) })
2643 #[cfg(not(no_global_oom_handling))]
2644 #[stable(feature = "shared_from_iter", since = "1.37.0")]
2645 impl<T> iter::FromIterator<T> for Arc<[T]> {
2646 /// Takes each element in the `Iterator` and collects it into an `Arc<[T]>`.
2648 /// # Performance characteristics
2650 /// ## The general case
2652 /// In the general case, collecting into `Arc<[T]>` is done by first
2653 /// collecting into a `Vec<T>`. That is, when writing the following:
2656 /// # use std::sync::Arc;
2657 /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
2658 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2661 /// this behaves as if we wrote:
2664 /// # use std::sync::Arc;
2665 /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
2666 /// .collect::<Vec<_>>() // The first set of allocations happens here.
2667 /// .into(); // A second allocation for `Arc<[T]>` happens here.
2668 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2671 /// This will allocate as many times as needed for constructing the `Vec<T>`
2672 /// and then it will allocate once for turning the `Vec<T>` into the `Arc<[T]>`.
2674 /// ## Iterators of known length
2676 /// When your `Iterator` implements `TrustedLen` and is of an exact size,
2677 /// a single allocation will be made for the `Arc<[T]>`. For example:
2680 /// # use std::sync::Arc;
2681 /// let evens: Arc<[u8]> = (0..10).collect(); // Just a single allocation happens here.
2682 /// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
2684 fn from_iter<I: iter::IntoIterator<Item = T>>(iter: I) -> Self {
2685 ToArcSlice::to_arc_slice(iter.into_iter())
2689 /// Specialization trait used for collecting into `Arc<[T]>`.
2690 trait ToArcSlice<T>: Iterator<Item = T> + Sized {
2691 fn to_arc_slice(self) -> Arc<[T]>;
2694 #[cfg(not(no_global_oom_handling))]
2695 impl<T, I: Iterator<Item = T>> ToArcSlice<T> for I {
2696 default fn to_arc_slice(self) -> Arc<[T]> {
2697 self.collect::<Vec<T>>().into()
2701 #[cfg(not(no_global_oom_handling))]
2702 impl<T, I: iter::TrustedLen<Item = T>> ToArcSlice<T> for I {
2703 fn to_arc_slice(self) -> Arc<[T]> {
2704 // This is the case for a `TrustedLen` iterator.
2705 let (low, high) = self.size_hint();
2706 if let Some(high) = high {
2710 "TrustedLen iterator's size hint is not exact: {:?}",
2715 // SAFETY: We need to ensure that the iterator has an exact length and we have.
2716 Arc::from_iter_exact(self, low)
2719 // TrustedLen contract guarantees that `upper_bound == `None` implies an iterator
2720 // length exceeding `usize::MAX`.
2721 // The default implementation would collect into a vec which would panic.
2722 // Thus we panic here immediately without invoking `Vec` code.
2723 panic!("capacity overflow");
2728 #[stable(feature = "rust1", since = "1.0.0")]
2729 impl<T: ?Sized> borrow::Borrow<T> for Arc<T> {
2730 fn borrow(&self) -> &T {
2735 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
2736 impl<T: ?Sized> AsRef<T> for Arc<T> {
2737 fn as_ref(&self) -> &T {
2742 #[stable(feature = "pin", since = "1.33.0")]
2743 impl<T: ?Sized> Unpin for Arc<T> {}
2745 /// Get the offset within an `ArcInner` for the payload behind a pointer.
2749 /// The pointer must point to (and have valid metadata for) a previously
2750 /// valid instance of T, but the T is allowed to be dropped.
2751 unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> usize {
2752 // Align the unsized value to the end of the ArcInner.
2753 // Because RcBox is repr(C), it will always be the last field in memory.
2754 // SAFETY: since the only unsized types possible are slices, trait objects,
2755 // and extern types, the input safety requirement is currently enough to
2756 // satisfy the requirements of align_of_val_raw; this is an implementation
2757 // detail of the language that must not be relied upon outside of std.
2758 unsafe { data_offset_align(align_of_val_raw(ptr)) }
2762 fn data_offset_align(align: usize) -> usize {
2763 let layout = Layout::new::<ArcInner<()>>();
2764 layout.size() + layout.padding_needed_for(align)
2767 #[cfg(not(bootstrap))]
2768 #[stable(feature = "arc_error", since = "1.52.0")]
2769 impl<T: core::error::Error + ?Sized> core::error::Error for Arc<T> {
2770 #[allow(deprecated, deprecated_in_future)]
2771 fn description(&self) -> &str {
2772 core::error::Error::description(&**self)
2775 #[allow(deprecated)]
2776 fn cause(&self) -> Option<&dyn core::error::Error> {
2777 core::error::Error::cause(&**self)
2780 fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
2781 core::error::Error::source(&**self)
2784 fn provide<'a>(&'a self, req: &mut core::any::Demand<'a>) {
2785 core::error::Error::provide(&**self, req);