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, SeqCst};
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 /// 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 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 ArcInner {
347 strong: atomic::AtomicUsize::new(1),
348 weak: atomic::AtomicUsize::new(1),
351 Self::from_inner(Box::leak(x).into())
354 /// Constructs a new `Arc<T>` using a weak reference to itself. Attempting
355 /// to upgrade the weak reference before this function returns will result
356 /// in a `None` value. However, the weak reference may be cloned freely and
357 /// stored for use at a later time.
361 /// #![feature(arc_new_cyclic)]
362 /// #![allow(dead_code)]
364 /// use std::sync::{Arc, Weak};
370 /// let foo = Arc::new_cyclic(|me| Foo {
374 #[cfg(not(no_global_oom_handling))]
376 #[unstable(feature = "arc_new_cyclic", issue = "75861")]
377 pub fn new_cyclic(data_fn: impl FnOnce(&Weak<T>) -> T) -> Arc<T> {
378 // Construct the inner in the "uninitialized" state with a single
380 let uninit_ptr: NonNull<_> = Box::leak(box ArcInner {
381 strong: atomic::AtomicUsize::new(0),
382 weak: atomic::AtomicUsize::new(1),
383 data: mem::MaybeUninit::<T>::uninit(),
386 let init_ptr: NonNull<ArcInner<T>> = uninit_ptr.cast();
388 let weak = Weak { ptr: init_ptr };
390 // It's important we don't give up ownership of the weak pointer, or
391 // else the memory might be freed by the time `data_fn` returns. If
392 // we really wanted to pass ownership, we could create an additional
393 // weak pointer for ourselves, but this would result in additional
394 // updates to the weak reference count which might not be necessary
396 let data = data_fn(&weak);
398 // Now we can properly initialize the inner value and turn our weak
399 // reference into a strong reference.
401 let inner = init_ptr.as_ptr();
402 ptr::write(ptr::addr_of_mut!((*inner).data), data);
404 // The above write to the data field must be visible to any threads which
405 // observe a non-zero strong count. Therefore we need at least "Release" ordering
406 // in order to synchronize with the `compare_exchange_weak` in `Weak::upgrade`.
408 // "Acquire" ordering is not required. When considering the possible behaviours
409 // of `data_fn` we only need to look at what it could do with a reference to a
410 // non-upgradeable `Weak`:
411 // - It can *clone* the `Weak`, increasing the weak reference count.
412 // - It can drop those clones, decreasing the weak reference count (but never to zero).
414 // These side effects do not impact us in any way, and no other side effects are
415 // possible with safe code alone.
416 let prev_value = (*inner).strong.fetch_add(1, Release);
417 debug_assert_eq!(prev_value, 0, "No prior strong references should exist");
420 let strong = Arc::from_inner(init_ptr);
422 // Strong references should collectively own a shared weak reference,
423 // so don't run the destructor for our old weak reference.
428 /// Constructs a new `Arc` with uninitialized contents.
433 /// #![feature(new_uninit)]
434 /// #![feature(get_mut_unchecked)]
436 /// use std::sync::Arc;
438 /// let mut five = Arc::<u32>::new_uninit();
440 /// let five = unsafe {
441 /// // Deferred initialization:
442 /// Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
444 /// five.assume_init()
447 /// assert_eq!(*five, 5)
449 #[cfg(not(no_global_oom_handling))]
450 #[unstable(feature = "new_uninit", issue = "63291")]
452 pub fn new_uninit() -> Arc<mem::MaybeUninit<T>> {
454 Arc::from_ptr(Arc::allocate_for_layout(
456 |layout| Global.allocate(layout),
457 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
462 /// Constructs a new `Arc` with uninitialized contents, with the memory
463 /// being filled with `0` bytes.
465 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
471 /// #![feature(new_uninit)]
473 /// use std::sync::Arc;
475 /// let zero = Arc::<u32>::new_zeroed();
476 /// let zero = unsafe { zero.assume_init() };
478 /// assert_eq!(*zero, 0)
481 /// [zeroed]: mem::MaybeUninit::zeroed
482 #[cfg(not(no_global_oom_handling))]
483 #[unstable(feature = "new_uninit", issue = "63291")]
485 pub fn new_zeroed() -> Arc<mem::MaybeUninit<T>> {
487 Arc::from_ptr(Arc::allocate_for_layout(
489 |layout| Global.allocate_zeroed(layout),
490 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
495 /// Constructs a new `Pin<Arc<T>>`. If `T` does not implement `Unpin`, then
496 /// `data` will be pinned in memory and unable to be moved.
497 #[cfg(not(no_global_oom_handling))]
498 #[stable(feature = "pin", since = "1.33.0")]
500 pub fn pin(data: T) -> Pin<Arc<T>> {
501 unsafe { Pin::new_unchecked(Arc::new(data)) }
504 /// Constructs a new `Pin<Arc<T>>`, return an error if allocation fails.
505 #[unstable(feature = "allocator_api", issue = "32838")]
507 pub fn try_pin(data: T) -> Result<Pin<Arc<T>>, AllocError> {
508 unsafe { Ok(Pin::new_unchecked(Arc::try_new(data)?)) }
511 /// Constructs a new `Arc<T>`, returning an error if allocation fails.
516 /// #![feature(allocator_api)]
517 /// use std::sync::Arc;
519 /// let five = Arc::try_new(5)?;
520 /// # Ok::<(), std::alloc::AllocError>(())
522 #[unstable(feature = "allocator_api", issue = "32838")]
524 pub fn try_new(data: T) -> Result<Arc<T>, AllocError> {
525 // Start the weak pointer count as 1 which is the weak pointer that's
526 // held by all the strong pointers (kinda), see std/rc.rs for more info
527 let x: Box<_> = Box::try_new(ArcInner {
528 strong: atomic::AtomicUsize::new(1),
529 weak: atomic::AtomicUsize::new(1),
532 Ok(Self::from_inner(Box::leak(x).into()))
535 /// Constructs a new `Arc` with uninitialized contents, returning an error
536 /// if allocation fails.
541 /// #![feature(new_uninit, allocator_api)]
542 /// #![feature(get_mut_unchecked)]
544 /// use std::sync::Arc;
546 /// let mut five = Arc::<u32>::try_new_uninit()?;
548 /// let five = unsafe {
549 /// // Deferred initialization:
550 /// Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
552 /// five.assume_init()
555 /// assert_eq!(*five, 5);
556 /// # Ok::<(), std::alloc::AllocError>(())
558 #[unstable(feature = "allocator_api", issue = "32838")]
559 // #[unstable(feature = "new_uninit", issue = "63291")]
560 pub fn try_new_uninit() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
562 Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
564 |layout| Global.allocate(layout),
565 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
570 /// Constructs a new `Arc` with uninitialized contents, with the memory
571 /// being filled with `0` bytes, returning an error if allocation fails.
573 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
579 /// #![feature(new_uninit, allocator_api)]
581 /// use std::sync::Arc;
583 /// let zero = Arc::<u32>::try_new_zeroed()?;
584 /// let zero = unsafe { zero.assume_init() };
586 /// assert_eq!(*zero, 0);
587 /// # Ok::<(), std::alloc::AllocError>(())
590 /// [zeroed]: mem::MaybeUninit::zeroed
591 #[unstable(feature = "allocator_api", issue = "32838")]
592 // #[unstable(feature = "new_uninit", issue = "63291")]
593 pub fn try_new_zeroed() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
595 Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
597 |layout| Global.allocate_zeroed(layout),
598 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
602 /// Returns the inner value, if the `Arc` has exactly one strong reference.
604 /// Otherwise, an [`Err`] is returned with the same `Arc` that was
607 /// This will succeed even if there are outstanding weak references.
612 /// use std::sync::Arc;
614 /// let x = Arc::new(3);
615 /// assert_eq!(Arc::try_unwrap(x), Ok(3));
617 /// let x = Arc::new(4);
618 /// let _y = Arc::clone(&x);
619 /// assert_eq!(*Arc::try_unwrap(x).unwrap_err(), 4);
622 #[stable(feature = "arc_unique", since = "1.4.0")]
623 pub fn try_unwrap(this: Self) -> Result<T, Self> {
624 if this.inner().strong.compare_exchange(1, 0, Relaxed, Relaxed).is_err() {
628 acquire!(this.inner().strong);
631 let elem = ptr::read(&this.ptr.as_ref().data);
633 // Make a weak pointer to clean up the implicit strong-weak reference
634 let _weak = Weak { ptr: this.ptr };
643 /// Constructs a new atomically reference-counted slice with uninitialized contents.
648 /// #![feature(new_uninit)]
649 /// #![feature(get_mut_unchecked)]
651 /// use std::sync::Arc;
653 /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
655 /// let values = unsafe {
656 /// // Deferred initialization:
657 /// Arc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
658 /// Arc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
659 /// Arc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);
661 /// values.assume_init()
664 /// assert_eq!(*values, [1, 2, 3])
666 #[cfg(not(no_global_oom_handling))]
667 #[unstable(feature = "new_uninit", issue = "63291")]
669 pub fn new_uninit_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
670 unsafe { Arc::from_ptr(Arc::allocate_for_slice(len)) }
673 /// Constructs a new atomically reference-counted slice with uninitialized contents, with the memory being
674 /// filled with `0` bytes.
676 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
677 /// incorrect usage of this method.
682 /// #![feature(new_uninit)]
684 /// use std::sync::Arc;
686 /// let values = Arc::<[u32]>::new_zeroed_slice(3);
687 /// let values = unsafe { values.assume_init() };
689 /// assert_eq!(*values, [0, 0, 0])
692 /// [zeroed]: mem::MaybeUninit::zeroed
693 #[cfg(not(no_global_oom_handling))]
694 #[unstable(feature = "new_uninit", issue = "63291")]
696 pub fn new_zeroed_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
698 Arc::from_ptr(Arc::allocate_for_layout(
699 Layout::array::<T>(len).unwrap(),
700 |layout| Global.allocate_zeroed(layout),
702 ptr::slice_from_raw_parts_mut(mem as *mut T, len)
703 as *mut ArcInner<[mem::MaybeUninit<T>]>
710 impl<T> Arc<mem::MaybeUninit<T>> {
711 /// Converts to `Arc<T>`.
715 /// As with [`MaybeUninit::assume_init`],
716 /// it is up to the caller to guarantee that the inner value
717 /// really is in an initialized state.
718 /// Calling this when the content is not yet fully initialized
719 /// causes immediate undefined behavior.
721 /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
726 /// #![feature(new_uninit)]
727 /// #![feature(get_mut_unchecked)]
729 /// use std::sync::Arc;
731 /// let mut five = Arc::<u32>::new_uninit();
733 /// let five = unsafe {
734 /// // Deferred initialization:
735 /// Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
737 /// five.assume_init()
740 /// assert_eq!(*five, 5)
742 #[unstable(feature = "new_uninit", issue = "63291")]
744 pub unsafe fn assume_init(self) -> Arc<T> {
745 Arc::from_inner(mem::ManuallyDrop::new(self).ptr.cast())
749 impl<T> Arc<[mem::MaybeUninit<T>]> {
750 /// Converts to `Arc<[T]>`.
754 /// As with [`MaybeUninit::assume_init`],
755 /// it is up to the caller to guarantee that the inner value
756 /// really is in an initialized state.
757 /// Calling this when the content is not yet fully initialized
758 /// causes immediate undefined behavior.
760 /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
765 /// #![feature(new_uninit)]
766 /// #![feature(get_mut_unchecked)]
768 /// use std::sync::Arc;
770 /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
772 /// let values = unsafe {
773 /// // Deferred initialization:
774 /// Arc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
775 /// Arc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
776 /// Arc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);
778 /// values.assume_init()
781 /// assert_eq!(*values, [1, 2, 3])
783 #[unstable(feature = "new_uninit", issue = "63291")]
785 pub unsafe fn assume_init(self) -> Arc<[T]> {
786 unsafe { Arc::from_ptr(mem::ManuallyDrop::new(self).ptr.as_ptr() as _) }
790 impl<T: ?Sized> Arc<T> {
791 /// Consumes the `Arc`, returning the wrapped pointer.
793 /// To avoid a memory leak the pointer must be converted back to an `Arc` using
794 /// [`Arc::from_raw`].
799 /// use std::sync::Arc;
801 /// let x = Arc::new("hello".to_owned());
802 /// let x_ptr = Arc::into_raw(x);
803 /// assert_eq!(unsafe { &*x_ptr }, "hello");
805 #[stable(feature = "rc_raw", since = "1.17.0")]
806 pub fn into_raw(this: Self) -> *const T {
807 let ptr = Self::as_ptr(&this);
812 /// Provides a raw pointer to the data.
814 /// The counts are not affected in any way and the `Arc` is not consumed. The pointer is valid for
815 /// as long as there are strong counts in the `Arc`.
820 /// use std::sync::Arc;
822 /// let x = Arc::new("hello".to_owned());
823 /// let y = Arc::clone(&x);
824 /// let x_ptr = Arc::as_ptr(&x);
825 /// assert_eq!(x_ptr, Arc::as_ptr(&y));
826 /// assert_eq!(unsafe { &*x_ptr }, "hello");
828 #[stable(feature = "rc_as_ptr", since = "1.45.0")]
829 pub fn as_ptr(this: &Self) -> *const T {
830 let ptr: *mut ArcInner<T> = NonNull::as_ptr(this.ptr);
832 // SAFETY: This cannot go through Deref::deref or RcBoxPtr::inner because
833 // this is required to retain raw/mut provenance such that e.g. `get_mut` can
834 // write through the pointer after the Rc is recovered through `from_raw`.
835 unsafe { ptr::addr_of_mut!((*ptr).data) }
838 /// Constructs an `Arc<T>` from a raw pointer.
840 /// The raw pointer must have been previously returned by a call to
841 /// [`Arc<U>::into_raw`][into_raw] where `U` must have the same size and
842 /// alignment as `T`. This is trivially true if `U` is `T`.
843 /// Note that if `U` is not `T` but has the same size and alignment, this is
844 /// basically like transmuting references of different types. See
845 /// [`mem::transmute`][transmute] for more information on what
846 /// restrictions apply in this case.
848 /// The user of `from_raw` has to make sure a specific value of `T` is only
851 /// This function is unsafe because improper use may lead to memory unsafety,
852 /// even if the returned `Arc<T>` is never accessed.
854 /// [into_raw]: Arc::into_raw
855 /// [transmute]: core::mem::transmute
860 /// use std::sync::Arc;
862 /// let x = Arc::new("hello".to_owned());
863 /// let x_ptr = Arc::into_raw(x);
866 /// // Convert back to an `Arc` to prevent leak.
867 /// let x = Arc::from_raw(x_ptr);
868 /// assert_eq!(&*x, "hello");
870 /// // Further calls to `Arc::from_raw(x_ptr)` would be memory-unsafe.
873 /// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
875 #[stable(feature = "rc_raw", since = "1.17.0")]
876 pub unsafe fn from_raw(ptr: *const T) -> Self {
878 let offset = data_offset(ptr);
880 // Reverse the offset to find the original ArcInner.
881 let arc_ptr = (ptr as *mut ArcInner<T>).set_ptr_value((ptr as *mut u8).offset(-offset));
883 Self::from_ptr(arc_ptr)
887 /// Creates a new [`Weak`] pointer to this allocation.
892 /// use std::sync::Arc;
894 /// let five = Arc::new(5);
896 /// let weak_five = Arc::downgrade(&five);
898 #[stable(feature = "arc_weak", since = "1.4.0")]
899 pub fn downgrade(this: &Self) -> Weak<T> {
900 // This Relaxed is OK because we're checking the value in the CAS
902 let mut cur = this.inner().weak.load(Relaxed);
905 // check if the weak counter is currently "locked"; if so, spin.
906 if cur == usize::MAX {
908 cur = this.inner().weak.load(Relaxed);
912 // NOTE: this code currently ignores the possibility of overflow
913 // into usize::MAX; in general both Rc and Arc need to be adjusted
914 // to deal with overflow.
916 // Unlike with Clone(), we need this to be an Acquire read to
917 // synchronize with the write coming from `is_unique`, so that the
918 // events prior to that write happen before this read.
919 match this.inner().weak.compare_exchange_weak(cur, cur + 1, Acquire, Relaxed) {
921 // Make sure we do not create a dangling Weak
922 debug_assert!(!is_dangling(this.ptr.as_ptr()));
923 return Weak { ptr: this.ptr };
925 Err(old) => cur = old,
930 /// Gets the number of [`Weak`] pointers to this allocation.
934 /// This method by itself is safe, but using it correctly requires extra care.
935 /// Another thread can change the weak count at any time,
936 /// including potentially between calling this method and acting on the result.
941 /// use std::sync::Arc;
943 /// let five = Arc::new(5);
944 /// let _weak_five = Arc::downgrade(&five);
946 /// // This assertion is deterministic because we haven't shared
947 /// // the `Arc` or `Weak` between threads.
948 /// assert_eq!(1, Arc::weak_count(&five));
951 #[stable(feature = "arc_counts", since = "1.15.0")]
952 pub fn weak_count(this: &Self) -> usize {
953 let cnt = this.inner().weak.load(SeqCst);
954 // If the weak count is currently locked, the value of the
955 // count was 0 just before taking the lock.
956 if cnt == usize::MAX { 0 } else { cnt - 1 }
959 /// Gets the number of strong (`Arc`) pointers to this allocation.
963 /// This method by itself is safe, but using it correctly requires extra care.
964 /// Another thread can change the strong count at any time,
965 /// including potentially between calling this method and acting on the result.
970 /// use std::sync::Arc;
972 /// let five = Arc::new(5);
973 /// let _also_five = Arc::clone(&five);
975 /// // This assertion is deterministic because we haven't shared
976 /// // the `Arc` between threads.
977 /// assert_eq!(2, Arc::strong_count(&five));
980 #[stable(feature = "arc_counts", since = "1.15.0")]
981 pub fn strong_count(this: &Self) -> usize {
982 this.inner().strong.load(SeqCst)
985 /// Increments the strong reference count on the `Arc<T>` associated with the
986 /// provided pointer by one.
990 /// The pointer must have been obtained through `Arc::into_raw`, and the
991 /// associated `Arc` instance must be valid (i.e. the strong count must be at
992 /// least 1) for the duration of this method.
997 /// use std::sync::Arc;
999 /// let five = Arc::new(5);
1002 /// let ptr = Arc::into_raw(five);
1003 /// Arc::increment_strong_count(ptr);
1005 /// // This assertion is deterministic because we haven't shared
1006 /// // the `Arc` between threads.
1007 /// let five = Arc::from_raw(ptr);
1008 /// assert_eq!(2, Arc::strong_count(&five));
1012 #[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
1013 pub unsafe fn increment_strong_count(ptr: *const T) {
1014 // Retain Arc, but don't touch refcount by wrapping in ManuallyDrop
1015 let arc = unsafe { mem::ManuallyDrop::new(Arc::<T>::from_raw(ptr)) };
1016 // Now increase refcount, but don't drop new refcount either
1017 let _arc_clone: mem::ManuallyDrop<_> = arc.clone();
1020 /// Decrements the strong reference count on the `Arc<T>` associated with the
1021 /// provided pointer by one.
1025 /// The pointer must have been obtained through `Arc::into_raw`, and the
1026 /// associated `Arc` instance must be valid (i.e. the strong count must be at
1027 /// least 1) when invoking this method. This method can be used to release the final
1028 /// `Arc` and backing storage, but **should not** be called after the final `Arc` has been
1034 /// use std::sync::Arc;
1036 /// let five = Arc::new(5);
1039 /// let ptr = Arc::into_raw(five);
1040 /// Arc::increment_strong_count(ptr);
1042 /// // Those assertions are deterministic because we haven't shared
1043 /// // the `Arc` between threads.
1044 /// let five = Arc::from_raw(ptr);
1045 /// assert_eq!(2, Arc::strong_count(&five));
1046 /// Arc::decrement_strong_count(ptr);
1047 /// assert_eq!(1, Arc::strong_count(&five));
1051 #[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
1052 pub unsafe fn decrement_strong_count(ptr: *const T) {
1053 unsafe { mem::drop(Arc::from_raw(ptr)) };
1057 fn inner(&self) -> &ArcInner<T> {
1058 // This unsafety is ok because while this arc is alive we're guaranteed
1059 // that the inner pointer is valid. Furthermore, we know that the
1060 // `ArcInner` structure itself is `Sync` because the inner data is
1061 // `Sync` as well, so we're ok loaning out an immutable pointer to these
1063 unsafe { self.ptr.as_ref() }
1066 // Non-inlined part of `drop`.
1068 unsafe fn drop_slow(&mut self) {
1069 // Destroy the data at this time, even though we must not free the box
1070 // allocation itself (there might still be weak pointers lying around).
1071 unsafe { ptr::drop_in_place(Self::get_mut_unchecked(self)) };
1073 // Drop the weak ref collectively held by all strong references
1074 drop(Weak { ptr: self.ptr });
1078 #[stable(feature = "ptr_eq", since = "1.17.0")]
1079 /// Returns `true` if the two `Arc`s point to the same allocation
1080 /// (in a vein similar to [`ptr::eq`]).
1085 /// use std::sync::Arc;
1087 /// let five = Arc::new(5);
1088 /// let same_five = Arc::clone(&five);
1089 /// let other_five = Arc::new(5);
1091 /// assert!(Arc::ptr_eq(&five, &same_five));
1092 /// assert!(!Arc::ptr_eq(&five, &other_five));
1095 /// [`ptr::eq`]: core::ptr::eq "ptr::eq"
1096 pub fn ptr_eq(this: &Self, other: &Self) -> bool {
1097 this.ptr.as_ptr() == other.ptr.as_ptr()
1101 impl<T: ?Sized> Arc<T> {
1102 /// Allocates an `ArcInner<T>` with sufficient space for
1103 /// a possibly-unsized inner value where the value has the layout provided.
1105 /// The function `mem_to_arcinner` is called with the data pointer
1106 /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
1107 #[cfg(not(no_global_oom_handling))]
1108 unsafe fn allocate_for_layout(
1109 value_layout: Layout,
1110 allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1111 mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
1112 ) -> *mut ArcInner<T> {
1113 // Calculate layout using the given value layout.
1114 // Previously, layout was calculated on the expression
1115 // `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
1116 // reference (see #54908).
1117 let layout = Layout::new::<ArcInner<()>>().extend(value_layout).unwrap().0.pad_to_align();
1119 Arc::try_allocate_for_layout(value_layout, allocate, mem_to_arcinner)
1120 .unwrap_or_else(|_| handle_alloc_error(layout))
1124 /// Allocates an `ArcInner<T>` with sufficient space for
1125 /// a possibly-unsized inner value where the value has the layout provided,
1126 /// returning an error if allocation fails.
1128 /// The function `mem_to_arcinner` is called with the data pointer
1129 /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
1130 unsafe fn try_allocate_for_layout(
1131 value_layout: Layout,
1132 allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1133 mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
1134 ) -> Result<*mut ArcInner<T>, AllocError> {
1135 // Calculate layout using the given value layout.
1136 // Previously, layout was calculated on the expression
1137 // `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
1138 // reference (see #54908).
1139 let layout = Layout::new::<ArcInner<()>>().extend(value_layout).unwrap().0.pad_to_align();
1141 let ptr = allocate(layout)?;
1143 // Initialize the ArcInner
1144 let inner = mem_to_arcinner(ptr.as_non_null_ptr().as_ptr());
1145 debug_assert_eq!(unsafe { Layout::for_value(&*inner) }, layout);
1148 ptr::write(&mut (*inner).strong, atomic::AtomicUsize::new(1));
1149 ptr::write(&mut (*inner).weak, atomic::AtomicUsize::new(1));
1155 /// Allocates an `ArcInner<T>` with sufficient space for an unsized inner value.
1156 #[cfg(not(no_global_oom_handling))]
1157 unsafe fn allocate_for_ptr(ptr: *const T) -> *mut ArcInner<T> {
1158 // Allocate for the `ArcInner<T>` using the given value.
1160 Self::allocate_for_layout(
1161 Layout::for_value(&*ptr),
1162 |layout| Global.allocate(layout),
1163 |mem| (ptr as *mut ArcInner<T>).set_ptr_value(mem) as *mut ArcInner<T>,
1168 #[cfg(not(no_global_oom_handling))]
1169 fn from_box(v: Box<T>) -> Arc<T> {
1171 let (box_unique, alloc) = Box::into_unique(v);
1172 let bptr = box_unique.as_ptr();
1174 let value_size = size_of_val(&*bptr);
1175 let ptr = Self::allocate_for_ptr(bptr);
1177 // Copy value as bytes
1178 ptr::copy_nonoverlapping(
1179 bptr as *const T as *const u8,
1180 &mut (*ptr).data as *mut _ as *mut u8,
1184 // Free the allocation without dropping its contents
1185 box_free(box_unique, alloc);
1193 /// Allocates an `ArcInner<[T]>` with the given length.
1194 #[cfg(not(no_global_oom_handling))]
1195 unsafe fn allocate_for_slice(len: usize) -> *mut ArcInner<[T]> {
1197 Self::allocate_for_layout(
1198 Layout::array::<T>(len).unwrap(),
1199 |layout| Global.allocate(layout),
1200 |mem| ptr::slice_from_raw_parts_mut(mem as *mut T, len) as *mut ArcInner<[T]>,
1205 /// Copy elements from slice into newly allocated Arc<\[T\]>
1207 /// Unsafe because the caller must either take ownership or bind `T: Copy`.
1208 #[cfg(not(no_global_oom_handling))]
1209 unsafe fn copy_from_slice(v: &[T]) -> Arc<[T]> {
1211 let ptr = Self::allocate_for_slice(v.len());
1213 ptr::copy_nonoverlapping(v.as_ptr(), &mut (*ptr).data as *mut [T] as *mut T, v.len());
1219 /// Constructs an `Arc<[T]>` from an iterator known to be of a certain size.
1221 /// Behavior is undefined should the size be wrong.
1222 #[cfg(not(no_global_oom_handling))]
1223 unsafe fn from_iter_exact(iter: impl iter::Iterator<Item = T>, len: usize) -> Arc<[T]> {
1224 // Panic guard while cloning T elements.
1225 // In the event of a panic, elements that have been written
1226 // into the new ArcInner will be dropped, then the memory freed.
1234 impl<T> Drop for Guard<T> {
1235 fn drop(&mut self) {
1237 let slice = from_raw_parts_mut(self.elems, self.n_elems);
1238 ptr::drop_in_place(slice);
1240 Global.deallocate(self.mem, self.layout);
1246 let ptr = Self::allocate_for_slice(len);
1248 let mem = ptr as *mut _ as *mut u8;
1249 let layout = Layout::for_value(&*ptr);
1251 // Pointer to first element
1252 let elems = &mut (*ptr).data as *mut [T] as *mut T;
1254 let mut guard = Guard { mem: NonNull::new_unchecked(mem), elems, layout, n_elems: 0 };
1256 for (i, item) in iter.enumerate() {
1257 ptr::write(elems.add(i), item);
1261 // All clear. Forget the guard so it doesn't free the new ArcInner.
1269 /// Specialization trait used for `From<&[T]>`.
1270 #[cfg(not(no_global_oom_handling))]
1271 trait ArcFromSlice<T> {
1272 fn from_slice(slice: &[T]) -> Self;
1275 #[cfg(not(no_global_oom_handling))]
1276 impl<T: Clone> ArcFromSlice<T> for Arc<[T]> {
1278 default fn from_slice(v: &[T]) -> Self {
1279 unsafe { Self::from_iter_exact(v.iter().cloned(), v.len()) }
1283 #[cfg(not(no_global_oom_handling))]
1284 impl<T: Copy> ArcFromSlice<T> for Arc<[T]> {
1286 fn from_slice(v: &[T]) -> Self {
1287 unsafe { Arc::copy_from_slice(v) }
1291 #[stable(feature = "rust1", since = "1.0.0")]
1292 impl<T: ?Sized> Clone for Arc<T> {
1293 /// Makes a clone of the `Arc` pointer.
1295 /// This creates another pointer to the same allocation, increasing the
1296 /// strong reference count.
1301 /// use std::sync::Arc;
1303 /// let five = Arc::new(5);
1305 /// let _ = Arc::clone(&five);
1308 fn clone(&self) -> Arc<T> {
1309 // Using a relaxed ordering is alright here, as knowledge of the
1310 // original reference prevents other threads from erroneously deleting
1313 // As explained in the [Boost documentation][1], Increasing the
1314 // reference counter can always be done with memory_order_relaxed: New
1315 // references to an object can only be formed from an existing
1316 // reference, and passing an existing reference from one thread to
1317 // another must already provide any required synchronization.
1319 // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1320 let old_size = self.inner().strong.fetch_add(1, Relaxed);
1322 // However we need to guard against massive refcounts in case someone
1323 // is `mem::forget`ing Arcs. If we don't do this the count can overflow
1324 // and users will use-after free. We racily saturate to `isize::MAX` on
1325 // the assumption that there aren't ~2 billion threads incrementing
1326 // the reference count at once. This branch will never be taken in
1327 // any realistic program.
1329 // We abort because such a program is incredibly degenerate, and we
1330 // don't care to support it.
1331 if old_size > MAX_REFCOUNT {
1335 Self::from_inner(self.ptr)
1339 #[stable(feature = "rust1", since = "1.0.0")]
1340 impl<T: ?Sized> Deref for Arc<T> {
1344 fn deref(&self) -> &T {
1349 #[unstable(feature = "receiver_trait", issue = "none")]
1350 impl<T: ?Sized> Receiver for Arc<T> {}
1352 impl<T: Clone> Arc<T> {
1353 /// Makes a mutable reference into the given `Arc`.
1355 /// If there are other `Arc` pointers to the same allocation, then `make_mut` will
1356 /// [`clone`] the inner value to a new allocation to ensure unique ownership. This is also
1357 /// referred to as clone-on-write.
1359 /// However, if there are no other `Arc` pointers to this allocation, but some [`Weak`]
1360 /// pointers, then the [`Weak`] pointers will be disassociated and the inner value will not
1363 /// See also [`get_mut`], which will fail rather than cloning the inner value
1364 /// or diassociating [`Weak`] pointers.
1366 /// [`clone`]: Clone::clone
1367 /// [`get_mut`]: Arc::get_mut
1372 /// use std::sync::Arc;
1374 /// let mut data = Arc::new(5);
1376 /// *Arc::make_mut(&mut data) += 1; // Won't clone anything
1377 /// let mut other_data = Arc::clone(&data); // Won't clone inner data
1378 /// *Arc::make_mut(&mut data) += 1; // Clones inner data
1379 /// *Arc::make_mut(&mut data) += 1; // Won't clone anything
1380 /// *Arc::make_mut(&mut other_data) *= 2; // Won't clone anything
1382 /// // Now `data` and `other_data` point to different allocations.
1383 /// assert_eq!(*data, 8);
1384 /// assert_eq!(*other_data, 12);
1387 /// [`Weak`] pointers will be disassociated:
1390 /// use std::sync::Arc;
1392 /// let mut data = Arc::new(75);
1393 /// let weak = Arc::downgrade(&data);
1395 /// assert!(75 == *data);
1396 /// assert!(75 == *weak.upgrade().unwrap());
1398 /// *Arc::make_mut(&mut data) += 1;
1400 /// assert!(76 == *data);
1401 /// assert!(weak.upgrade().is_none());
1403 #[cfg(not(no_global_oom_handling))]
1405 #[stable(feature = "arc_unique", since = "1.4.0")]
1406 pub fn make_mut(this: &mut Self) -> &mut T {
1407 // Note that we hold both a strong reference and a weak reference.
1408 // Thus, releasing our strong reference only will not, by itself, cause
1409 // the memory to be deallocated.
1411 // Use Acquire to ensure that we see any writes to `weak` that happen
1412 // before release writes (i.e., decrements) to `strong`. Since we hold a
1413 // weak count, there's no chance the ArcInner itself could be
1415 if this.inner().strong.compare_exchange(1, 0, Acquire, Relaxed).is_err() {
1416 // Another strong pointer exists, so we must clone.
1417 // Pre-allocate memory to allow writing the cloned value directly.
1418 let mut arc = Self::new_uninit();
1420 let data = Arc::get_mut_unchecked(&mut arc);
1421 (**this).write_clone_into_raw(data.as_mut_ptr());
1422 *this = arc.assume_init();
1424 } else if this.inner().weak.load(Relaxed) != 1 {
1425 // Relaxed suffices in the above because this is fundamentally an
1426 // optimization: we are always racing with weak pointers being
1427 // dropped. Worst case, we end up allocated a new Arc unnecessarily.
1429 // We removed the last strong ref, but there are additional weak
1430 // refs remaining. We'll move the contents to a new Arc, and
1431 // invalidate the other weak refs.
1433 // Note that it is not possible for the read of `weak` to yield
1434 // usize::MAX (i.e., locked), since the weak count can only be
1435 // locked by a thread with a strong reference.
1437 // Materialize our own implicit weak pointer, so that it can clean
1438 // up the ArcInner as needed.
1439 let _weak = Weak { ptr: this.ptr };
1441 // Can just steal the data, all that's left is Weaks
1442 let mut arc = Self::new_uninit();
1444 let data = Arc::get_mut_unchecked(&mut arc);
1445 data.as_mut_ptr().copy_from_nonoverlapping(&**this, 1);
1446 ptr::write(this, arc.assume_init());
1449 // We were the sole reference of either kind; bump back up the
1450 // strong ref count.
1451 this.inner().strong.store(1, Release);
1454 // As with `get_mut()`, the unsafety is ok because our reference was
1455 // either unique to begin with, or became one upon cloning the contents.
1456 unsafe { Self::get_mut_unchecked(this) }
1460 impl<T: ?Sized> Arc<T> {
1461 /// Returns a mutable reference into the given `Arc`, if there are
1462 /// no other `Arc` or [`Weak`] pointers to the same allocation.
1464 /// Returns [`None`] otherwise, because it is not safe to
1465 /// mutate a shared value.
1467 /// See also [`make_mut`][make_mut], which will [`clone`][clone]
1468 /// the inner value when there are other `Arc` pointers.
1470 /// [make_mut]: Arc::make_mut
1471 /// [clone]: Clone::clone
1476 /// use std::sync::Arc;
1478 /// let mut x = Arc::new(3);
1479 /// *Arc::get_mut(&mut x).unwrap() = 4;
1480 /// assert_eq!(*x, 4);
1482 /// let _y = Arc::clone(&x);
1483 /// assert!(Arc::get_mut(&mut x).is_none());
1486 #[stable(feature = "arc_unique", since = "1.4.0")]
1487 pub fn get_mut(this: &mut Self) -> Option<&mut T> {
1488 if this.is_unique() {
1489 // This unsafety is ok because we're guaranteed that the pointer
1490 // returned is the *only* pointer that will ever be returned to T. Our
1491 // reference count is guaranteed to be 1 at this point, and we required
1492 // the Arc itself to be `mut`, so we're returning the only possible
1493 // reference to the inner data.
1494 unsafe { Some(Arc::get_mut_unchecked(this)) }
1500 /// Returns a mutable reference into the given `Arc`,
1501 /// without any check.
1503 /// See also [`get_mut`], which is safe and does appropriate checks.
1505 /// [`get_mut`]: Arc::get_mut
1509 /// Any other `Arc` or [`Weak`] pointers to the same allocation must not be dereferenced
1510 /// for the duration of the returned borrow.
1511 /// This is trivially the case if no such pointers exist,
1512 /// for example immediately after `Arc::new`.
1517 /// #![feature(get_mut_unchecked)]
1519 /// use std::sync::Arc;
1521 /// let mut x = Arc::new(String::new());
1523 /// Arc::get_mut_unchecked(&mut x).push_str("foo")
1525 /// assert_eq!(*x, "foo");
1528 #[unstable(feature = "get_mut_unchecked", issue = "63292")]
1529 pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
1530 // We are careful to *not* create a reference covering the "count" fields, as
1531 // this would alias with concurrent access to the reference counts (e.g. by `Weak`).
1532 unsafe { &mut (*this.ptr.as_ptr()).data }
1535 /// Determine whether this is the unique reference (including weak refs) to
1536 /// the underlying data.
1538 /// Note that this requires locking the weak ref count.
1539 fn is_unique(&mut self) -> bool {
1540 // lock the weak pointer count if we appear to be the sole weak pointer
1543 // The acquire label here ensures a happens-before relationship with any
1544 // writes to `strong` (in particular in `Weak::upgrade`) prior to decrements
1545 // of the `weak` count (via `Weak::drop`, which uses release). If the upgraded
1546 // weak ref was never dropped, the CAS here will fail so we do not care to synchronize.
1547 if self.inner().weak.compare_exchange(1, usize::MAX, Acquire, Relaxed).is_ok() {
1548 // This needs to be an `Acquire` to synchronize with the decrement of the `strong`
1549 // counter in `drop` -- the only access that happens when any but the last reference
1550 // is being dropped.
1551 let unique = self.inner().strong.load(Acquire) == 1;
1553 // The release write here synchronizes with a read in `downgrade`,
1554 // effectively preventing the above read of `strong` from happening
1556 self.inner().weak.store(1, Release); // release the lock
1564 #[stable(feature = "rust1", since = "1.0.0")]
1565 unsafe impl<#[may_dangle] T: ?Sized> Drop for Arc<T> {
1566 /// Drops the `Arc`.
1568 /// This will decrement the strong reference count. If the strong reference
1569 /// count reaches zero then the only other references (if any) are
1570 /// [`Weak`], so we `drop` the inner value.
1575 /// use std::sync::Arc;
1579 /// impl Drop for Foo {
1580 /// fn drop(&mut self) {
1581 /// println!("dropped!");
1585 /// let foo = Arc::new(Foo);
1586 /// let foo2 = Arc::clone(&foo);
1588 /// drop(foo); // Doesn't print anything
1589 /// drop(foo2); // Prints "dropped!"
1592 fn drop(&mut self) {
1593 // Because `fetch_sub` is already atomic, we do not need to synchronize
1594 // with other threads unless we are going to delete the object. This
1595 // same logic applies to the below `fetch_sub` to the `weak` count.
1596 if self.inner().strong.fetch_sub(1, Release) != 1 {
1600 // This fence is needed to prevent reordering of use of the data and
1601 // deletion of the data. Because it is marked `Release`, the decreasing
1602 // of the reference count synchronizes with this `Acquire` fence. This
1603 // means that use of the data happens before decreasing the reference
1604 // count, which happens before this fence, which happens before the
1605 // deletion of the data.
1607 // As explained in the [Boost documentation][1],
1609 // > It is important to enforce any possible access to the object in one
1610 // > thread (through an existing reference) to *happen before* deleting
1611 // > the object in a different thread. This is achieved by a "release"
1612 // > operation after dropping a reference (any access to the object
1613 // > through this reference must obviously happened before), and an
1614 // > "acquire" operation before deleting the object.
1616 // In particular, while the contents of an Arc are usually immutable, it's
1617 // possible to have interior writes to something like a Mutex<T>. Since a
1618 // Mutex is not acquired when it is deleted, we can't rely on its
1619 // synchronization logic to make writes in thread A visible to a destructor
1620 // running in thread B.
1622 // Also note that the Acquire fence here could probably be replaced with an
1623 // Acquire load, which could improve performance in highly-contended
1624 // situations. See [2].
1626 // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1627 // [2]: (https://github.com/rust-lang/rust/pull/41714)
1628 acquire!(self.inner().strong);
1636 impl Arc<dyn Any + Send + Sync> {
1638 #[stable(feature = "rc_downcast", since = "1.29.0")]
1639 /// Attempt to downcast the `Arc<dyn Any + Send + Sync>` to a concrete type.
1644 /// use std::any::Any;
1645 /// use std::sync::Arc;
1647 /// fn print_if_string(value: Arc<dyn Any + Send + Sync>) {
1648 /// if let Ok(string) = value.downcast::<String>() {
1649 /// println!("String ({}): {}", string.len(), string);
1653 /// let my_string = "Hello World".to_string();
1654 /// print_if_string(Arc::new(my_string));
1655 /// print_if_string(Arc::new(0i8));
1657 pub fn downcast<T>(self) -> Result<Arc<T>, Self>
1659 T: Any + Send + Sync + 'static,
1661 if (*self).is::<T>() {
1662 let ptr = self.ptr.cast::<ArcInner<T>>();
1664 Ok(Arc::from_inner(ptr))
1672 /// Constructs a new `Weak<T>`, without allocating any memory.
1673 /// Calling [`upgrade`] on the return value always gives [`None`].
1675 /// [`upgrade`]: Weak::upgrade
1680 /// use std::sync::Weak;
1682 /// let empty: Weak<i64> = Weak::new();
1683 /// assert!(empty.upgrade().is_none());
1685 #[stable(feature = "downgraded_weak", since = "1.10.0")]
1687 pub fn new() -> Weak<T> {
1688 Weak { ptr: NonNull::new(usize::MAX as *mut ArcInner<T>).expect("MAX is not 0") }
1692 /// Helper type to allow accessing the reference counts without
1693 /// making any assertions about the data field.
1694 struct WeakInner<'a> {
1695 weak: &'a atomic::AtomicUsize,
1696 strong: &'a atomic::AtomicUsize,
1699 impl<T: ?Sized> Weak<T> {
1700 /// Returns a raw pointer to the object `T` pointed to by this `Weak<T>`.
1702 /// The pointer is valid only if there are some strong references. The pointer may be dangling,
1703 /// unaligned or even [`null`] otherwise.
1708 /// use std::sync::Arc;
1711 /// let strong = Arc::new("hello".to_owned());
1712 /// let weak = Arc::downgrade(&strong);
1713 /// // Both point to the same object
1714 /// assert!(ptr::eq(&*strong, weak.as_ptr()));
1715 /// // The strong here keeps it alive, so we can still access the object.
1716 /// assert_eq!("hello", unsafe { &*weak.as_ptr() });
1719 /// // But not any more. We can do weak.as_ptr(), but accessing the pointer would lead to
1720 /// // undefined behaviour.
1721 /// // assert_eq!("hello", unsafe { &*weak.as_ptr() });
1724 /// [`null`]: core::ptr::null "ptr::null"
1725 #[stable(feature = "weak_into_raw", since = "1.45.0")]
1726 pub fn as_ptr(&self) -> *const T {
1727 let ptr: *mut ArcInner<T> = NonNull::as_ptr(self.ptr);
1729 if is_dangling(ptr) {
1730 // If the pointer is dangling, we return the sentinel directly. This cannot be
1731 // a valid payload address, as the payload is at least as aligned as ArcInner (usize).
1734 // SAFETY: if is_dangling returns false, then the pointer is dereferencable.
1735 // The payload may be dropped at this point, and we have to maintain provenance,
1736 // so use raw pointer manipulation.
1737 unsafe { ptr::addr_of_mut!((*ptr).data) }
1741 /// Consumes the `Weak<T>` and turns it into a raw pointer.
1743 /// This converts the weak pointer into a raw pointer, while still preserving the ownership of
1744 /// one weak reference (the weak count is not modified by this operation). It can be turned
1745 /// back into the `Weak<T>` with [`from_raw`].
1747 /// The same restrictions of accessing the target of the pointer as with
1748 /// [`as_ptr`] apply.
1753 /// use std::sync::{Arc, Weak};
1755 /// let strong = Arc::new("hello".to_owned());
1756 /// let weak = Arc::downgrade(&strong);
1757 /// let raw = weak.into_raw();
1759 /// assert_eq!(1, Arc::weak_count(&strong));
1760 /// assert_eq!("hello", unsafe { &*raw });
1762 /// drop(unsafe { Weak::from_raw(raw) });
1763 /// assert_eq!(0, Arc::weak_count(&strong));
1766 /// [`from_raw`]: Weak::from_raw
1767 /// [`as_ptr`]: Weak::as_ptr
1768 #[stable(feature = "weak_into_raw", since = "1.45.0")]
1769 pub fn into_raw(self) -> *const T {
1770 let result = self.as_ptr();
1775 /// Converts a raw pointer previously created by [`into_raw`] back into `Weak<T>`.
1777 /// This can be used to safely get a strong reference (by calling [`upgrade`]
1778 /// later) or to deallocate the weak count by dropping the `Weak<T>`.
1780 /// It takes ownership of one weak reference (with the exception of pointers created by [`new`],
1781 /// as these don't own anything; the method still works on them).
1785 /// The pointer must have originated from the [`into_raw`] and must still own its potential
1788 /// It is allowed for the strong count to be 0 at the time of calling this. Nevertheless, this
1789 /// takes ownership of one weak reference currently represented as a raw pointer (the weak
1790 /// count is not modified by this operation) and therefore it must be paired with a previous
1791 /// call to [`into_raw`].
1795 /// use std::sync::{Arc, Weak};
1797 /// let strong = Arc::new("hello".to_owned());
1799 /// let raw_1 = Arc::downgrade(&strong).into_raw();
1800 /// let raw_2 = Arc::downgrade(&strong).into_raw();
1802 /// assert_eq!(2, Arc::weak_count(&strong));
1804 /// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
1805 /// assert_eq!(1, Arc::weak_count(&strong));
1809 /// // Decrement the last weak count.
1810 /// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
1813 /// [`new`]: Weak::new
1814 /// [`into_raw`]: Weak::into_raw
1815 /// [`upgrade`]: Weak::upgrade
1816 #[stable(feature = "weak_into_raw", since = "1.45.0")]
1817 pub unsafe fn from_raw(ptr: *const T) -> Self {
1818 // See Weak::as_ptr for context on how the input pointer is derived.
1820 let ptr = if is_dangling(ptr as *mut T) {
1821 // This is a dangling Weak.
1822 ptr as *mut ArcInner<T>
1824 // Otherwise, we're guaranteed the pointer came from a nondangling Weak.
1825 // SAFETY: data_offset is safe to call, as ptr references a real (potentially dropped) T.
1826 let offset = unsafe { data_offset(ptr) };
1827 // Thus, we reverse the offset to get the whole RcBox.
1828 // SAFETY: the pointer originated from a Weak, so this offset is safe.
1829 unsafe { (ptr as *mut ArcInner<T>).set_ptr_value((ptr as *mut u8).offset(-offset)) }
1832 // SAFETY: we now have recovered the original Weak pointer, so can create the Weak.
1833 Weak { ptr: unsafe { NonNull::new_unchecked(ptr) } }
1837 impl<T: ?Sized> Weak<T> {
1838 /// Attempts to upgrade the `Weak` pointer to an [`Arc`], delaying
1839 /// dropping of the inner value if successful.
1841 /// Returns [`None`] if the inner value has since been dropped.
1846 /// use std::sync::Arc;
1848 /// let five = Arc::new(5);
1850 /// let weak_five = Arc::downgrade(&five);
1852 /// let strong_five: Option<Arc<_>> = weak_five.upgrade();
1853 /// assert!(strong_five.is_some());
1855 /// // Destroy all strong pointers.
1856 /// drop(strong_five);
1859 /// assert!(weak_five.upgrade().is_none());
1861 #[stable(feature = "arc_weak", since = "1.4.0")]
1862 pub fn upgrade(&self) -> Option<Arc<T>> {
1863 // We use a CAS loop to increment the strong count instead of a
1864 // fetch_add as this function should never take the reference count
1865 // from zero to one.
1866 let inner = self.inner()?;
1868 // Relaxed load because any write of 0 that we can observe
1869 // leaves the field in a permanently zero state (so a
1870 // "stale" read of 0 is fine), and any other value is
1871 // confirmed via the CAS below.
1872 let mut n = inner.strong.load(Relaxed);
1879 // See comments in `Arc::clone` for why we do this (for `mem::forget`).
1880 if n > MAX_REFCOUNT {
1884 // Relaxed is fine for the failure case because we don't have any expectations about the new state.
1885 // Acquire is necessary for the success case to synchronise with `Arc::new_cyclic`, when the inner
1886 // value can be initialized after `Weak` references have already been created. In that case, we
1887 // expect to observe the fully initialized value.
1888 match inner.strong.compare_exchange_weak(n, n + 1, Acquire, Relaxed) {
1889 Ok(_) => return Some(Arc::from_inner(self.ptr)), // null checked above
1890 Err(old) => n = old,
1895 /// Gets the number of strong (`Arc`) pointers pointing to this allocation.
1897 /// If `self` was created using [`Weak::new`], this will return 0.
1898 #[stable(feature = "weak_counts", since = "1.41.0")]
1899 pub fn strong_count(&self) -> usize {
1900 if let Some(inner) = self.inner() { inner.strong.load(SeqCst) } else { 0 }
1903 /// Gets an approximation of the number of `Weak` pointers pointing to this
1906 /// If `self` was created using [`Weak::new`], or if there are no remaining
1907 /// strong pointers, this will return 0.
1911 /// Due to implementation details, the returned value can be off by 1 in
1912 /// either direction when other threads are manipulating any `Arc`s or
1913 /// `Weak`s pointing to the same allocation.
1914 #[stable(feature = "weak_counts", since = "1.41.0")]
1915 pub fn weak_count(&self) -> usize {
1918 let weak = inner.weak.load(SeqCst);
1919 let strong = inner.strong.load(SeqCst);
1923 // Since we observed that there was at least one strong pointer
1924 // after reading the weak count, we know that the implicit weak
1925 // reference (present whenever any strong references are alive)
1926 // was still around when we observed the weak count, and can
1927 // therefore safely subtract it.
1934 /// Returns `None` when the pointer is dangling and there is no allocated `ArcInner`,
1935 /// (i.e., when this `Weak` was created by `Weak::new`).
1937 fn inner(&self) -> Option<WeakInner<'_>> {
1938 if is_dangling(self.ptr.as_ptr()) {
1941 // We are careful to *not* create a reference covering the "data" field, as
1942 // the field may be mutated concurrently (for example, if the last `Arc`
1943 // is dropped, the data field will be dropped in-place).
1945 let ptr = self.ptr.as_ptr();
1946 WeakInner { strong: &(*ptr).strong, weak: &(*ptr).weak }
1951 /// Returns `true` if the two `Weak`s point to the same allocation (similar to
1952 /// [`ptr::eq`]), or if both don't point to any allocation
1953 /// (because they were created with `Weak::new()`).
1957 /// Since this compares pointers it means that `Weak::new()` will equal each
1958 /// other, even though they don't point to any allocation.
1963 /// use std::sync::Arc;
1965 /// let first_rc = Arc::new(5);
1966 /// let first = Arc::downgrade(&first_rc);
1967 /// let second = Arc::downgrade(&first_rc);
1969 /// assert!(first.ptr_eq(&second));
1971 /// let third_rc = Arc::new(5);
1972 /// let third = Arc::downgrade(&third_rc);
1974 /// assert!(!first.ptr_eq(&third));
1977 /// Comparing `Weak::new`.
1980 /// use std::sync::{Arc, Weak};
1982 /// let first = Weak::new();
1983 /// let second = Weak::new();
1984 /// assert!(first.ptr_eq(&second));
1986 /// let third_rc = Arc::new(());
1987 /// let third = Arc::downgrade(&third_rc);
1988 /// assert!(!first.ptr_eq(&third));
1991 /// [`ptr::eq`]: core::ptr::eq "ptr::eq"
1993 #[stable(feature = "weak_ptr_eq", since = "1.39.0")]
1994 pub fn ptr_eq(&self, other: &Self) -> bool {
1995 self.ptr.as_ptr() == other.ptr.as_ptr()
1999 #[stable(feature = "arc_weak", since = "1.4.0")]
2000 impl<T: ?Sized> Clone for Weak<T> {
2001 /// Makes a clone of the `Weak` pointer that points to the same allocation.
2006 /// use std::sync::{Arc, Weak};
2008 /// let weak_five = Arc::downgrade(&Arc::new(5));
2010 /// let _ = Weak::clone(&weak_five);
2013 fn clone(&self) -> Weak<T> {
2014 let inner = if let Some(inner) = self.inner() {
2017 return Weak { ptr: self.ptr };
2019 // See comments in Arc::clone() for why this is relaxed. This can use a
2020 // fetch_add (ignoring the lock) because the weak count is only locked
2021 // where are *no other* weak pointers in existence. (So we can't be
2022 // running this code in that case).
2023 let old_size = inner.weak.fetch_add(1, Relaxed);
2025 // See comments in Arc::clone() for why we do this (for mem::forget).
2026 if old_size > MAX_REFCOUNT {
2030 Weak { ptr: self.ptr }
2034 #[stable(feature = "downgraded_weak", since = "1.10.0")]
2035 impl<T> Default for Weak<T> {
2036 /// Constructs a new `Weak<T>`, without allocating memory.
2037 /// Calling [`upgrade`] on the return value always
2040 /// [`upgrade`]: Weak::upgrade
2045 /// use std::sync::Weak;
2047 /// let empty: Weak<i64> = Default::default();
2048 /// assert!(empty.upgrade().is_none());
2050 fn default() -> Weak<T> {
2055 #[stable(feature = "arc_weak", since = "1.4.0")]
2056 unsafe impl<#[may_dangle] T: ?Sized> Drop for Weak<T> {
2057 /// Drops the `Weak` pointer.
2062 /// use std::sync::{Arc, Weak};
2066 /// impl Drop for Foo {
2067 /// fn drop(&mut self) {
2068 /// println!("dropped!");
2072 /// let foo = Arc::new(Foo);
2073 /// let weak_foo = Arc::downgrade(&foo);
2074 /// let other_weak_foo = Weak::clone(&weak_foo);
2076 /// drop(weak_foo); // Doesn't print anything
2077 /// drop(foo); // Prints "dropped!"
2079 /// assert!(other_weak_foo.upgrade().is_none());
2081 fn drop(&mut self) {
2082 // If we find out that we were the last weak pointer, then its time to
2083 // deallocate the data entirely. See the discussion in Arc::drop() about
2084 // the memory orderings
2086 // It's not necessary to check for the locked state here, because the
2087 // weak count can only be locked if there was precisely one weak ref,
2088 // meaning that drop could only subsequently run ON that remaining weak
2089 // ref, which can only happen after the lock is released.
2090 let inner = if let Some(inner) = self.inner() { inner } else { return };
2092 if inner.weak.fetch_sub(1, Release) == 1 {
2093 acquire!(inner.weak);
2094 unsafe { Global.deallocate(self.ptr.cast(), Layout::for_value_raw(self.ptr.as_ptr())) }
2099 #[stable(feature = "rust1", since = "1.0.0")]
2100 trait ArcEqIdent<T: ?Sized + PartialEq> {
2101 fn eq(&self, other: &Arc<T>) -> bool;
2102 fn ne(&self, other: &Arc<T>) -> bool;
2105 #[stable(feature = "rust1", since = "1.0.0")]
2106 impl<T: ?Sized + PartialEq> ArcEqIdent<T> for Arc<T> {
2108 default fn eq(&self, other: &Arc<T>) -> bool {
2112 default fn ne(&self, other: &Arc<T>) -> bool {
2117 /// We're doing this specialization here, and not as a more general optimization on `&T`, because it
2118 /// would otherwise add a cost to all equality checks on refs. We assume that `Arc`s are used to
2119 /// store large values, that are slow to clone, but also heavy to check for equality, causing this
2120 /// cost to pay off more easily. It's also more likely to have two `Arc` clones, that point to
2121 /// the same value, than two `&T`s.
2123 /// We can only do this when `T: Eq` as a `PartialEq` might be deliberately irreflexive.
2124 #[stable(feature = "rust1", since = "1.0.0")]
2125 impl<T: ?Sized + crate::rc::MarkerEq> ArcEqIdent<T> for Arc<T> {
2127 fn eq(&self, other: &Arc<T>) -> bool {
2128 Arc::ptr_eq(self, other) || **self == **other
2132 fn ne(&self, other: &Arc<T>) -> bool {
2133 !Arc::ptr_eq(self, other) && **self != **other
2137 #[stable(feature = "rust1", since = "1.0.0")]
2138 impl<T: ?Sized + PartialEq> PartialEq for Arc<T> {
2139 /// Equality for two `Arc`s.
2141 /// Two `Arc`s are equal if their inner values are equal, even if they are
2142 /// stored in different allocation.
2144 /// If `T` also implements `Eq` (implying reflexivity of equality),
2145 /// two `Arc`s that point to the same allocation are always equal.
2150 /// use std::sync::Arc;
2152 /// let five = Arc::new(5);
2154 /// assert!(five == Arc::new(5));
2157 fn eq(&self, other: &Arc<T>) -> bool {
2158 ArcEqIdent::eq(self, other)
2161 /// Inequality for two `Arc`s.
2163 /// Two `Arc`s are unequal if their inner values are unequal.
2165 /// If `T` also implements `Eq` (implying reflexivity of equality),
2166 /// two `Arc`s that point to the same value are never unequal.
2171 /// use std::sync::Arc;
2173 /// let five = Arc::new(5);
2175 /// assert!(five != Arc::new(6));
2178 fn ne(&self, other: &Arc<T>) -> bool {
2179 ArcEqIdent::ne(self, other)
2183 #[stable(feature = "rust1", since = "1.0.0")]
2184 impl<T: ?Sized + PartialOrd> PartialOrd for Arc<T> {
2185 /// Partial comparison for two `Arc`s.
2187 /// The two are compared by calling `partial_cmp()` on their inner values.
2192 /// use std::sync::Arc;
2193 /// use std::cmp::Ordering;
2195 /// let five = Arc::new(5);
2197 /// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Arc::new(6)));
2199 fn partial_cmp(&self, other: &Arc<T>) -> Option<Ordering> {
2200 (**self).partial_cmp(&**other)
2203 /// Less-than comparison for two `Arc`s.
2205 /// The two are compared by calling `<` on their inner values.
2210 /// use std::sync::Arc;
2212 /// let five = Arc::new(5);
2214 /// assert!(five < Arc::new(6));
2216 fn lt(&self, other: &Arc<T>) -> bool {
2217 *(*self) < *(*other)
2220 /// 'Less than or equal to' comparison for two `Arc`s.
2222 /// The two are compared by calling `<=` on their inner values.
2227 /// use std::sync::Arc;
2229 /// let five = Arc::new(5);
2231 /// assert!(five <= Arc::new(5));
2233 fn le(&self, other: &Arc<T>) -> bool {
2234 *(*self) <= *(*other)
2237 /// Greater-than comparison for two `Arc`s.
2239 /// The two are compared by calling `>` on their inner values.
2244 /// use std::sync::Arc;
2246 /// let five = Arc::new(5);
2248 /// assert!(five > Arc::new(4));
2250 fn gt(&self, other: &Arc<T>) -> bool {
2251 *(*self) > *(*other)
2254 /// 'Greater than or equal to' comparison for two `Arc`s.
2256 /// The two are compared by calling `>=` on their inner values.
2261 /// use std::sync::Arc;
2263 /// let five = Arc::new(5);
2265 /// assert!(five >= Arc::new(5));
2267 fn ge(&self, other: &Arc<T>) -> bool {
2268 *(*self) >= *(*other)
2271 #[stable(feature = "rust1", since = "1.0.0")]
2272 impl<T: ?Sized + Ord> Ord for Arc<T> {
2273 /// Comparison for two `Arc`s.
2275 /// The two are compared by calling `cmp()` on their inner values.
2280 /// use std::sync::Arc;
2281 /// use std::cmp::Ordering;
2283 /// let five = Arc::new(5);
2285 /// assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));
2287 fn cmp(&self, other: &Arc<T>) -> Ordering {
2288 (**self).cmp(&**other)
2291 #[stable(feature = "rust1", since = "1.0.0")]
2292 impl<T: ?Sized + Eq> Eq for Arc<T> {}
2294 #[stable(feature = "rust1", since = "1.0.0")]
2295 impl<T: ?Sized + fmt::Display> fmt::Display for Arc<T> {
2296 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2297 fmt::Display::fmt(&**self, f)
2301 #[stable(feature = "rust1", since = "1.0.0")]
2302 impl<T: ?Sized + fmt::Debug> fmt::Debug for Arc<T> {
2303 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2304 fmt::Debug::fmt(&**self, f)
2308 #[stable(feature = "rust1", since = "1.0.0")]
2309 impl<T: ?Sized> fmt::Pointer for Arc<T> {
2310 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2311 fmt::Pointer::fmt(&(&**self as *const T), f)
2315 #[cfg(not(no_global_oom_handling))]
2316 #[stable(feature = "rust1", since = "1.0.0")]
2317 impl<T: Default> Default for Arc<T> {
2318 /// Creates a new `Arc<T>`, with the `Default` value for `T`.
2323 /// use std::sync::Arc;
2325 /// let x: Arc<i32> = Default::default();
2326 /// assert_eq!(*x, 0);
2328 fn default() -> Arc<T> {
2329 Arc::new(Default::default())
2333 #[stable(feature = "rust1", since = "1.0.0")]
2334 impl<T: ?Sized + Hash> Hash for Arc<T> {
2335 fn hash<H: Hasher>(&self, state: &mut H) {
2336 (**self).hash(state)
2340 #[cfg(not(no_global_oom_handling))]
2341 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
2342 impl<T> From<T> for Arc<T> {
2343 /// Converts a `T` into an `Arc<T>`
2345 /// The conversion moves the value into a
2346 /// newly allocated `Arc`. It is equivalent to
2347 /// calling `Arc::new(t)`.
2351 /// # use std::sync::Arc;
2353 /// let arc = Arc::new(5);
2355 /// assert_eq!(Arc::from(x), arc);
2357 fn from(t: T) -> Self {
2362 #[cfg(not(no_global_oom_handling))]
2363 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2364 impl<T: Clone> From<&[T]> for Arc<[T]> {
2365 /// Allocate a reference-counted slice and fill it by cloning `v`'s items.
2370 /// # use std::sync::Arc;
2371 /// let original: &[i32] = &[1, 2, 3];
2372 /// let shared: Arc<[i32]> = Arc::from(original);
2373 /// assert_eq!(&[1, 2, 3], &shared[..]);
2376 fn from(v: &[T]) -> Arc<[T]> {
2377 <Self as ArcFromSlice<T>>::from_slice(v)
2381 #[cfg(not(no_global_oom_handling))]
2382 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2383 impl From<&str> for Arc<str> {
2384 /// Allocate a reference-counted `str` and copy `v` into it.
2389 /// # use std::sync::Arc;
2390 /// let shared: Arc<str> = Arc::from("eggplant");
2391 /// assert_eq!("eggplant", &shared[..]);
2394 fn from(v: &str) -> Arc<str> {
2395 let arc = Arc::<[u8]>::from(v.as_bytes());
2396 unsafe { Arc::from_raw(Arc::into_raw(arc) as *const str) }
2400 #[cfg(not(no_global_oom_handling))]
2401 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2402 impl From<String> for Arc<str> {
2403 /// Allocate a reference-counted `str` and copy `v` into it.
2408 /// # use std::sync::Arc;
2409 /// let unique: String = "eggplant".to_owned();
2410 /// let shared: Arc<str> = Arc::from(unique);
2411 /// assert_eq!("eggplant", &shared[..]);
2414 fn from(v: String) -> Arc<str> {
2419 #[cfg(not(no_global_oom_handling))]
2420 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2421 impl<T: ?Sized> From<Box<T>> for Arc<T> {
2422 /// Move a boxed object to a new, reference-counted allocation.
2427 /// # use std::sync::Arc;
2428 /// let unique: Box<str> = Box::from("eggplant");
2429 /// let shared: Arc<str> = Arc::from(unique);
2430 /// assert_eq!("eggplant", &shared[..]);
2433 fn from(v: Box<T>) -> Arc<T> {
2438 #[cfg(not(no_global_oom_handling))]
2439 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2440 impl<T> From<Vec<T>> for Arc<[T]> {
2441 /// Allocate a reference-counted slice and move `v`'s items into it.
2446 /// # use std::sync::Arc;
2447 /// let unique: Vec<i32> = vec![1, 2, 3];
2448 /// let shared: Arc<[i32]> = Arc::from(unique);
2449 /// assert_eq!(&[1, 2, 3], &shared[..]);
2452 fn from(mut v: Vec<T>) -> Arc<[T]> {
2454 let arc = Arc::copy_from_slice(&v);
2456 // Allow the Vec to free its memory, but not destroy its contents
2464 #[stable(feature = "shared_from_cow", since = "1.45.0")]
2465 impl<'a, B> From<Cow<'a, B>> for Arc<B>
2467 B: ToOwned + ?Sized,
2468 Arc<B>: From<&'a B> + From<B::Owned>,
2470 /// Create an atomically reference-counted pointer from
2471 /// a clone-on-write pointer by copying its content.
2476 /// # use std::sync::Arc;
2477 /// # use std::borrow::Cow;
2478 /// let cow: Cow<str> = Cow::Borrowed("eggplant");
2479 /// let shared: Arc<str> = Arc::from(cow);
2480 /// assert_eq!("eggplant", &shared[..]);
2483 fn from(cow: Cow<'a, B>) -> Arc<B> {
2485 Cow::Borrowed(s) => Arc::from(s),
2486 Cow::Owned(s) => Arc::from(s),
2491 #[stable(feature = "boxed_slice_try_from", since = "1.43.0")]
2492 impl<T, const N: usize> TryFrom<Arc<[T]>> for Arc<[T; N]> {
2493 type Error = Arc<[T]>;
2495 fn try_from(boxed_slice: Arc<[T]>) -> Result<Self, Self::Error> {
2496 if boxed_slice.len() == N {
2497 Ok(unsafe { Arc::from_raw(Arc::into_raw(boxed_slice) as *mut [T; N]) })
2504 #[cfg(not(no_global_oom_handling))]
2505 #[stable(feature = "shared_from_iter", since = "1.37.0")]
2506 impl<T> iter::FromIterator<T> for Arc<[T]> {
2507 /// Takes each element in the `Iterator` and collects it into an `Arc<[T]>`.
2509 /// # Performance characteristics
2511 /// ## The general case
2513 /// In the general case, collecting into `Arc<[T]>` is done by first
2514 /// collecting into a `Vec<T>`. That is, when writing the following:
2517 /// # use std::sync::Arc;
2518 /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
2519 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2522 /// this behaves as if we wrote:
2525 /// # use std::sync::Arc;
2526 /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
2527 /// .collect::<Vec<_>>() // The first set of allocations happens here.
2528 /// .into(); // A second allocation for `Arc<[T]>` happens here.
2529 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2532 /// This will allocate as many times as needed for constructing the `Vec<T>`
2533 /// and then it will allocate once for turning the `Vec<T>` into the `Arc<[T]>`.
2535 /// ## Iterators of known length
2537 /// When your `Iterator` implements `TrustedLen` and is of an exact size,
2538 /// a single allocation will be made for the `Arc<[T]>`. For example:
2541 /// # use std::sync::Arc;
2542 /// let evens: Arc<[u8]> = (0..10).collect(); // Just a single allocation happens here.
2543 /// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
2545 fn from_iter<I: iter::IntoIterator<Item = T>>(iter: I) -> Self {
2546 ToArcSlice::to_arc_slice(iter.into_iter())
2550 /// Specialization trait used for collecting into `Arc<[T]>`.
2551 trait ToArcSlice<T>: Iterator<Item = T> + Sized {
2552 fn to_arc_slice(self) -> Arc<[T]>;
2555 #[cfg(not(no_global_oom_handling))]
2556 impl<T, I: Iterator<Item = T>> ToArcSlice<T> for I {
2557 default fn to_arc_slice(self) -> Arc<[T]> {
2558 self.collect::<Vec<T>>().into()
2562 #[cfg(not(no_global_oom_handling))]
2563 impl<T, I: iter::TrustedLen<Item = T>> ToArcSlice<T> for I {
2564 fn to_arc_slice(self) -> Arc<[T]> {
2565 // This is the case for a `TrustedLen` iterator.
2566 let (low, high) = self.size_hint();
2567 if let Some(high) = high {
2571 "TrustedLen iterator's size hint is not exact: {:?}",
2576 // SAFETY: We need to ensure that the iterator has an exact length and we have.
2577 Arc::from_iter_exact(self, low)
2580 // TrustedLen contract guarantees that `upper_bound == `None` implies an iterator
2581 // length exceeding `usize::MAX`.
2582 // The default implementation would collect into a vec which would panic.
2583 // Thus we panic here immediately without invoking `Vec` code.
2584 panic!("capacity overflow");
2589 #[stable(feature = "rust1", since = "1.0.0")]
2590 impl<T: ?Sized> borrow::Borrow<T> for Arc<T> {
2591 fn borrow(&self) -> &T {
2596 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
2597 impl<T: ?Sized> AsRef<T> for Arc<T> {
2598 fn as_ref(&self) -> &T {
2603 #[stable(feature = "pin", since = "1.33.0")]
2604 impl<T: ?Sized> Unpin for Arc<T> {}
2606 /// Get the offset within an `ArcInner` for the payload behind a pointer.
2610 /// The pointer must point to (and have valid metadata for) a previously
2611 /// valid instance of T, but the T is allowed to be dropped.
2612 unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> isize {
2613 // Align the unsized value to the end of the ArcInner.
2614 // Because RcBox is repr(C), it will always be the last field in memory.
2615 // SAFETY: since the only unsized types possible are slices, trait objects,
2616 // and extern types, the input safety requirement is currently enough to
2617 // satisfy the requirements of align_of_val_raw; this is an implementation
2618 // detail of the language that must not be relied upon outside of std.
2619 unsafe { data_offset_align(align_of_val_raw(ptr)) }
2623 fn data_offset_align(align: usize) -> isize {
2624 let layout = Layout::new::<ArcInner<()>>();
2625 (layout.size() + layout.padding_needed_for(align)) as isize