]> git.lizzy.rs Git - rust.git/blob - library/alloc/src/sync.rs
Auto merge of #105812 - ojeda:no-jump-tables, r=nikic
[rust.git] / library / alloc / src / sync.rs
1 #![stable(feature = "rust1", since = "1.0.0")]
2
3 //! Thread-safe reference-counting pointers.
4 //!
5 //! See the [`Arc<T>`][Arc] documentation for more details.
6 //!
7 //! **Note**: This module is only available on platforms that support atomic
8 //! loads and stores of pointers. This may be detected at compile time using
9 //! `#[cfg(target_has_atomic = "ptr")]`.
10
11 use core::any::Any;
12 use core::borrow;
13 use core::cmp::Ordering;
14 use core::convert::{From, TryFrom};
15 use core::fmt;
16 use core::hash::{Hash, Hasher};
17 use core::hint;
18 use core::intrinsics::abort;
19 #[cfg(not(no_global_oom_handling))]
20 use core::iter;
21 use core::marker::{PhantomData, Unpin, Unsize};
22 #[cfg(not(no_global_oom_handling))]
23 use core::mem::size_of_val;
24 use core::mem::{self, align_of_val_raw};
25 use core::ops::{CoerceUnsized, Deref, DispatchFromDyn, Receiver};
26 use core::panic::{RefUnwindSafe, UnwindSafe};
27 use core::pin::Pin;
28 use core::ptr::{self, NonNull};
29 #[cfg(not(no_global_oom_handling))]
30 use core::slice::from_raw_parts_mut;
31 use core::sync::atomic;
32 use core::sync::atomic::Ordering::{Acquire, Relaxed, Release};
33
34 #[cfg(not(no_global_oom_handling))]
35 use crate::alloc::handle_alloc_error;
36 #[cfg(not(no_global_oom_handling))]
37 use crate::alloc::{box_free, WriteCloneIntoRaw};
38 use crate::alloc::{AllocError, Allocator, Global, Layout};
39 use crate::borrow::{Cow, ToOwned};
40 use crate::boxed::Box;
41 use crate::rc::is_dangling;
42 #[cfg(not(no_global_oom_handling))]
43 use crate::string::String;
44 #[cfg(not(no_global_oom_handling))]
45 use crate::vec::Vec;
46
47 #[cfg(test)]
48 mod tests;
49
50 /// A soft limit on the amount of references that may be made to an `Arc`.
51 ///
52 /// Going above this limit will abort your program (although not
53 /// necessarily) at _exactly_ `MAX_REFCOUNT + 1` references.
54 const MAX_REFCOUNT: usize = (isize::MAX) as usize;
55
56 #[cfg(not(sanitize = "thread"))]
57 macro_rules! acquire {
58     ($x:expr) => {
59         atomic::fence(Acquire)
60     };
61 }
62
63 // ThreadSanitizer does not support memory fences. To avoid false positive
64 // reports in Arc / Weak implementation use atomic loads for synchronization
65 // instead.
66 #[cfg(sanitize = "thread")]
67 macro_rules! acquire {
68     ($x:expr) => {
69         $x.load(Acquire)
70     };
71 }
72
73 /// A thread-safe reference-counting pointer. 'Arc' stands for 'Atomically
74 /// Reference Counted'.
75 ///
76 /// The type `Arc<T>` provides shared ownership of a value of type `T`,
77 /// allocated in the heap. Invoking [`clone`][clone] on `Arc` produces
78 /// a new `Arc` instance, which points to the same allocation on the heap as the
79 /// source `Arc`, while increasing a reference count. When the last `Arc`
80 /// pointer to a given allocation is destroyed, the value stored in that allocation (often
81 /// referred to as "inner value") is also dropped.
82 ///
83 /// Shared references in Rust disallow mutation by default, and `Arc` is no
84 /// exception: you cannot generally obtain a mutable reference to something
85 /// inside an `Arc`. If you need to mutate through an `Arc`, use
86 /// [`Mutex`][mutex], [`RwLock`][rwlock], or one of the [`Atomic`][atomic]
87 /// types.
88 ///
89 /// **Note**: This type is only available on platforms that support atomic
90 /// loads and stores of pointers, which includes all platforms that support
91 /// the `std` crate but not all those which only support [`alloc`](crate).
92 /// This may be detected at compile time using `#[cfg(target_has_atomic = "ptr")]`.
93 ///
94 /// ## Thread Safety
95 ///
96 /// Unlike [`Rc<T>`], `Arc<T>` uses atomic operations for its reference
97 /// counting. This means that it is thread-safe. The disadvantage is that
98 /// atomic operations are more expensive than ordinary memory accesses. If you
99 /// are not sharing reference-counted allocations between threads, consider using
100 /// [`Rc<T>`] for lower overhead. [`Rc<T>`] is a safe default, because the
101 /// compiler will catch any attempt to send an [`Rc<T>`] between threads.
102 /// However, a library might choose `Arc<T>` in order to give library consumers
103 /// more flexibility.
104 ///
105 /// `Arc<T>` will implement [`Send`] and [`Sync`] as long as the `T` implements
106 /// [`Send`] and [`Sync`]. Why can't you put a non-thread-safe type `T` in an
107 /// `Arc<T>` to make it thread-safe? This may be a bit counter-intuitive at
108 /// first: after all, isn't the point of `Arc<T>` thread safety? The key is
109 /// this: `Arc<T>` makes it thread safe to have multiple ownership of the same
110 /// data, but it  doesn't add thread safety to its data. Consider
111 /// <code>Arc<[RefCell\<T>]></code>. [`RefCell<T>`] isn't [`Sync`], and if `Arc<T>` was always
112 /// [`Send`], <code>Arc<[RefCell\<T>]></code> would be as well. But then we'd have a problem:
113 /// [`RefCell<T>`] is not thread safe; it keeps track of the borrowing count using
114 /// non-atomic operations.
115 ///
116 /// In the end, this means that you may need to pair `Arc<T>` with some sort of
117 /// [`std::sync`] type, usually [`Mutex<T>`][mutex].
118 ///
119 /// ## Breaking cycles with `Weak`
120 ///
121 /// The [`downgrade`][downgrade] method can be used to create a non-owning
122 /// [`Weak`] pointer. A [`Weak`] pointer can be [`upgrade`][upgrade]d
123 /// to an `Arc`, but this will return [`None`] if the value stored in the allocation has
124 /// already been dropped. In other words, `Weak` pointers do not keep the value
125 /// inside the allocation alive; however, they *do* keep the allocation
126 /// (the backing store for the value) alive.
127 ///
128 /// A cycle between `Arc` pointers will never be deallocated. For this reason,
129 /// [`Weak`] is used to break cycles. For example, a tree could have
130 /// strong `Arc` pointers from parent nodes to children, and [`Weak`]
131 /// pointers from children back to their parents.
132 ///
133 /// # Cloning references
134 ///
135 /// Creating a new reference from an existing reference-counted pointer is done using the
136 /// `Clone` trait implemented for [`Arc<T>`][Arc] and [`Weak<T>`][Weak].
137 ///
138 /// ```
139 /// use std::sync::Arc;
140 /// let foo = Arc::new(vec![1.0, 2.0, 3.0]);
141 /// // The two syntaxes below are equivalent.
142 /// let a = foo.clone();
143 /// let b = Arc::clone(&foo);
144 /// // a, b, and foo are all Arcs that point to the same memory location
145 /// ```
146 ///
147 /// ## `Deref` behavior
148 ///
149 /// `Arc<T>` automatically dereferences to `T` (via the [`Deref`][deref] trait),
150 /// so you can call `T`'s methods on a value of type `Arc<T>`. To avoid name
151 /// clashes with `T`'s methods, the methods of `Arc<T>` itself are associated
152 /// functions, called using [fully qualified syntax]:
153 ///
154 /// ```
155 /// use std::sync::Arc;
156 ///
157 /// let my_arc = Arc::new(());
158 /// let my_weak = Arc::downgrade(&my_arc);
159 /// ```
160 ///
161 /// `Arc<T>`'s implementations of traits like `Clone` may also be called using
162 /// fully qualified syntax. Some people prefer to use fully qualified syntax,
163 /// while others prefer using method-call syntax.
164 ///
165 /// ```
166 /// use std::sync::Arc;
167 ///
168 /// let arc = Arc::new(());
169 /// // Method-call syntax
170 /// let arc2 = arc.clone();
171 /// // Fully qualified syntax
172 /// let arc3 = Arc::clone(&arc);
173 /// ```
174 ///
175 /// [`Weak<T>`][Weak] does not auto-dereference to `T`, because the inner value may have
176 /// already been dropped.
177 ///
178 /// [`Rc<T>`]: crate::rc::Rc
179 /// [clone]: Clone::clone
180 /// [mutex]: ../../std/sync/struct.Mutex.html
181 /// [rwlock]: ../../std/sync/struct.RwLock.html
182 /// [atomic]: core::sync::atomic
183 /// [`Send`]: core::marker::Send
184 /// [`Sync`]: core::marker::Sync
185 /// [deref]: core::ops::Deref
186 /// [downgrade]: Arc::downgrade
187 /// [upgrade]: Weak::upgrade
188 /// [RefCell\<T>]: core::cell::RefCell
189 /// [`RefCell<T>`]: core::cell::RefCell
190 /// [`std::sync`]: ../../std/sync/index.html
191 /// [`Arc::clone(&from)`]: Arc::clone
192 /// [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
193 ///
194 /// # Examples
195 ///
196 /// Sharing some immutable data between threads:
197 ///
198 // Note that we **do not** run these tests here. The windows builders get super
199 // unhappy if a thread outlives the main thread and then exits at the same time
200 // (something deadlocks) so we just avoid this entirely by not running these
201 // tests.
202 /// ```no_run
203 /// use std::sync::Arc;
204 /// use std::thread;
205 ///
206 /// let five = Arc::new(5);
207 ///
208 /// for _ in 0..10 {
209 ///     let five = Arc::clone(&five);
210 ///
211 ///     thread::spawn(move || {
212 ///         println!("{five:?}");
213 ///     });
214 /// }
215 /// ```
216 ///
217 /// Sharing a mutable [`AtomicUsize`]:
218 ///
219 /// [`AtomicUsize`]: core::sync::atomic::AtomicUsize "sync::atomic::AtomicUsize"
220 ///
221 /// ```no_run
222 /// use std::sync::Arc;
223 /// use std::sync::atomic::{AtomicUsize, Ordering};
224 /// use std::thread;
225 ///
226 /// let val = Arc::new(AtomicUsize::new(5));
227 ///
228 /// for _ in 0..10 {
229 ///     let val = Arc::clone(&val);
230 ///
231 ///     thread::spawn(move || {
232 ///         let v = val.fetch_add(1, Ordering::SeqCst);
233 ///         println!("{v:?}");
234 ///     });
235 /// }
236 /// ```
237 ///
238 /// See the [`rc` documentation][rc_examples] for more examples of reference
239 /// counting in general.
240 ///
241 /// [rc_examples]: crate::rc#examples
242 #[cfg_attr(not(test), rustc_diagnostic_item = "Arc")]
243 #[stable(feature = "rust1", since = "1.0.0")]
244 pub struct Arc<T: ?Sized> {
245     ptr: NonNull<ArcInner<T>>,
246     phantom: PhantomData<ArcInner<T>>,
247 }
248
249 #[stable(feature = "rust1", since = "1.0.0")]
250 unsafe impl<T: ?Sized + Sync + Send> Send for Arc<T> {}
251 #[stable(feature = "rust1", since = "1.0.0")]
252 unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {}
253
254 #[stable(feature = "catch_unwind", since = "1.9.0")]
255 impl<T: RefUnwindSafe + ?Sized> UnwindSafe for Arc<T> {}
256
257 #[unstable(feature = "coerce_unsized", issue = "18598")]
258 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Arc<U>> for Arc<T> {}
259
260 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
261 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Arc<U>> for Arc<T> {}
262
263 impl<T: ?Sized> Arc<T> {
264     unsafe fn from_inner(ptr: NonNull<ArcInner<T>>) -> Self {
265         Self { ptr, phantom: PhantomData }
266     }
267
268     unsafe fn from_ptr(ptr: *mut ArcInner<T>) -> Self {
269         unsafe { Self::from_inner(NonNull::new_unchecked(ptr)) }
270     }
271 }
272
273 /// `Weak` is a version of [`Arc`] that holds a non-owning reference to the
274 /// managed allocation. The allocation is accessed by calling [`upgrade`] on the `Weak`
275 /// pointer, which returns an <code>[Option]<[Arc]\<T>></code>.
276 ///
277 /// Since a `Weak` reference does not count towards ownership, it will not
278 /// prevent the value stored in the allocation from being dropped, and `Weak` itself makes no
279 /// guarantees about the value still being present. Thus it may return [`None`]
280 /// when [`upgrade`]d. Note however that a `Weak` reference *does* prevent the allocation
281 /// itself (the backing store) from being deallocated.
282 ///
283 /// A `Weak` pointer is useful for keeping a temporary reference to the allocation
284 /// managed by [`Arc`] without preventing its inner value from being dropped. It is also used to
285 /// prevent circular references between [`Arc`] pointers, since mutual owning references
286 /// would never allow either [`Arc`] to be dropped. For example, a tree could
287 /// have strong [`Arc`] pointers from parent nodes to children, and `Weak`
288 /// pointers from children back to their parents.
289 ///
290 /// The typical way to obtain a `Weak` pointer is to call [`Arc::downgrade`].
291 ///
292 /// [`upgrade`]: Weak::upgrade
293 #[stable(feature = "arc_weak", since = "1.4.0")]
294 pub struct Weak<T: ?Sized> {
295     // This is a `NonNull` to allow optimizing the size of this type in enums,
296     // but it is not necessarily a valid pointer.
297     // `Weak::new` sets this to `usize::MAX` so that it doesn’t need
298     // to allocate space on the heap.  That's not a value a real pointer
299     // will ever have because RcBox has alignment at least 2.
300     // This is only possible when `T: Sized`; unsized `T` never dangle.
301     ptr: NonNull<ArcInner<T>>,
302 }
303
304 #[stable(feature = "arc_weak", since = "1.4.0")]
305 unsafe impl<T: ?Sized + Sync + Send> Send for Weak<T> {}
306 #[stable(feature = "arc_weak", since = "1.4.0")]
307 unsafe impl<T: ?Sized + Sync + Send> Sync for Weak<T> {}
308
309 #[unstable(feature = "coerce_unsized", issue = "18598")]
310 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Weak<U>> for Weak<T> {}
311 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
312 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Weak<U>> for Weak<T> {}
313
314 #[stable(feature = "arc_weak", since = "1.4.0")]
315 impl<T: ?Sized + fmt::Debug> fmt::Debug for Weak<T> {
316     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
317         write!(f, "(Weak)")
318     }
319 }
320
321 // This is repr(C) to future-proof against possible field-reordering, which
322 // would interfere with otherwise safe [into|from]_raw() of transmutable
323 // inner types.
324 #[repr(C)]
325 struct ArcInner<T: ?Sized> {
326     strong: atomic::AtomicUsize,
327
328     // the value usize::MAX acts as a sentinel for temporarily "locking" the
329     // ability to upgrade weak pointers or downgrade strong ones; this is used
330     // to avoid races in `make_mut` and `get_mut`.
331     weak: atomic::AtomicUsize,
332
333     data: T,
334 }
335
336 /// Calculate layout for `ArcInner<T>` using the inner value's layout
337 fn arcinner_layout_for_value_layout(layout: Layout) -> Layout {
338     // Calculate layout using the given value layout.
339     // Previously, layout was calculated on the expression
340     // `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
341     // reference (see #54908).
342     Layout::new::<ArcInner<()>>().extend(layout).unwrap().0.pad_to_align()
343 }
344
345 unsafe impl<T: ?Sized + Sync + Send> Send for ArcInner<T> {}
346 unsafe impl<T: ?Sized + Sync + Send> Sync for ArcInner<T> {}
347
348 impl<T> Arc<T> {
349     /// Constructs a new `Arc<T>`.
350     ///
351     /// # Examples
352     ///
353     /// ```
354     /// use std::sync::Arc;
355     ///
356     /// let five = Arc::new(5);
357     /// ```
358     #[cfg(not(no_global_oom_handling))]
359     #[inline]
360     #[stable(feature = "rust1", since = "1.0.0")]
361     pub fn new(data: T) -> Arc<T> {
362         // Start the weak pointer count as 1 which is the weak pointer that's
363         // held by all the strong pointers (kinda), see std/rc.rs for more info
364         let x: Box<_> = Box::new(ArcInner {
365             strong: atomic::AtomicUsize::new(1),
366             weak: atomic::AtomicUsize::new(1),
367             data,
368         });
369         unsafe { Self::from_inner(Box::leak(x).into()) }
370     }
371
372     /// Constructs a new `Arc<T>` while giving you a `Weak<T>` to the allocation,
373     /// to allow you to construct a `T` which holds a weak pointer to itself.
374     ///
375     /// Generally, a structure circularly referencing itself, either directly or
376     /// indirectly, should not hold a strong reference to itself to prevent a memory leak.
377     /// Using this function, you get access to the weak pointer during the
378     /// initialization of `T`, before the `Arc<T>` is created, such that you can
379     /// clone and store it inside the `T`.
380     ///
381     /// `new_cyclic` first allocates the managed allocation for the `Arc<T>`,
382     /// then calls your closure, giving it a `Weak<T>` to this allocation,
383     /// and only afterwards completes the construction of the `Arc<T>` by placing
384     /// the `T` returned from your closure into the allocation.
385     ///
386     /// Since the new `Arc<T>` is not fully-constructed until `Arc<T>::new_cyclic`
387     /// returns, calling [`upgrade`] on the weak reference inside your closure will
388     /// fail and result in a `None` value.
389     ///
390     /// # Panics
391     ///
392     /// If `data_fn` panics, the panic is propagated to the caller, and the
393     /// temporary [`Weak<T>`] is dropped normally.
394     ///
395     /// # Example
396     ///
397     /// ```
398     /// # #![allow(dead_code)]
399     /// use std::sync::{Arc, Weak};
400     ///
401     /// struct Gadget {
402     ///     me: Weak<Gadget>,
403     /// }
404     ///
405     /// impl Gadget {
406     ///     /// Construct a reference counted Gadget.
407     ///     fn new() -> Arc<Self> {
408     ///         // `me` is a `Weak<Gadget>` pointing at the new allocation of the
409     ///         // `Arc` we're constructing.
410     ///         Arc::new_cyclic(|me| {
411     ///             // Create the actual struct here.
412     ///             Gadget { me: me.clone() }
413     ///         })
414     ///     }
415     ///
416     ///     /// Return a reference counted pointer to Self.
417     ///     fn me(&self) -> Arc<Self> {
418     ///         self.me.upgrade().unwrap()
419     ///     }
420     /// }
421     /// ```
422     /// [`upgrade`]: Weak::upgrade
423     #[cfg(not(no_global_oom_handling))]
424     #[inline]
425     #[stable(feature = "arc_new_cyclic", since = "1.60.0")]
426     pub fn new_cyclic<F>(data_fn: F) -> Arc<T>
427     where
428         F: FnOnce(&Weak<T>) -> T,
429     {
430         // Construct the inner in the "uninitialized" state with a single
431         // weak reference.
432         let uninit_ptr: NonNull<_> = Box::leak(Box::new(ArcInner {
433             strong: atomic::AtomicUsize::new(0),
434             weak: atomic::AtomicUsize::new(1),
435             data: mem::MaybeUninit::<T>::uninit(),
436         }))
437         .into();
438         let init_ptr: NonNull<ArcInner<T>> = uninit_ptr.cast();
439
440         let weak = Weak { ptr: init_ptr };
441
442         // It's important we don't give up ownership of the weak pointer, or
443         // else the memory might be freed by the time `data_fn` returns. If
444         // we really wanted to pass ownership, we could create an additional
445         // weak pointer for ourselves, but this would result in additional
446         // updates to the weak reference count which might not be necessary
447         // otherwise.
448         let data = data_fn(&weak);
449
450         // Now we can properly initialize the inner value and turn our weak
451         // reference into a strong reference.
452         let strong = unsafe {
453             let inner = init_ptr.as_ptr();
454             ptr::write(ptr::addr_of_mut!((*inner).data), data);
455
456             // The above write to the data field must be visible to any threads which
457             // observe a non-zero strong count. Therefore we need at least "Release" ordering
458             // in order to synchronize with the `compare_exchange_weak` in `Weak::upgrade`.
459             //
460             // "Acquire" ordering is not required. When considering the possible behaviours
461             // of `data_fn` we only need to look at what it could do with a reference to a
462             // non-upgradeable `Weak`:
463             // - It can *clone* the `Weak`, increasing the weak reference count.
464             // - It can drop those clones, decreasing the weak reference count (but never to zero).
465             //
466             // These side effects do not impact us in any way, and no other side effects are
467             // possible with safe code alone.
468             let prev_value = (*inner).strong.fetch_add(1, Release);
469             debug_assert_eq!(prev_value, 0, "No prior strong references should exist");
470
471             Arc::from_inner(init_ptr)
472         };
473
474         // Strong references should collectively own a shared weak reference,
475         // so don't run the destructor for our old weak reference.
476         mem::forget(weak);
477         strong
478     }
479
480     /// Constructs a new `Arc` with uninitialized contents.
481     ///
482     /// # Examples
483     ///
484     /// ```
485     /// #![feature(new_uninit)]
486     /// #![feature(get_mut_unchecked)]
487     ///
488     /// use std::sync::Arc;
489     ///
490     /// let mut five = Arc::<u32>::new_uninit();
491     ///
492     /// // Deferred initialization:
493     /// Arc::get_mut(&mut five).unwrap().write(5);
494     ///
495     /// let five = unsafe { five.assume_init() };
496     ///
497     /// assert_eq!(*five, 5)
498     /// ```
499     #[cfg(not(no_global_oom_handling))]
500     #[unstable(feature = "new_uninit", issue = "63291")]
501     #[must_use]
502     pub fn new_uninit() -> Arc<mem::MaybeUninit<T>> {
503         unsafe {
504             Arc::from_ptr(Arc::allocate_for_layout(
505                 Layout::new::<T>(),
506                 |layout| Global.allocate(layout),
507                 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
508             ))
509         }
510     }
511
512     /// Constructs a new `Arc` with uninitialized contents, with the memory
513     /// being filled with `0` bytes.
514     ///
515     /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
516     /// of this method.
517     ///
518     /// # Examples
519     ///
520     /// ```
521     /// #![feature(new_uninit)]
522     ///
523     /// use std::sync::Arc;
524     ///
525     /// let zero = Arc::<u32>::new_zeroed();
526     /// let zero = unsafe { zero.assume_init() };
527     ///
528     /// assert_eq!(*zero, 0)
529     /// ```
530     ///
531     /// [zeroed]: mem::MaybeUninit::zeroed
532     #[cfg(not(no_global_oom_handling))]
533     #[unstable(feature = "new_uninit", issue = "63291")]
534     #[must_use]
535     pub fn new_zeroed() -> Arc<mem::MaybeUninit<T>> {
536         unsafe {
537             Arc::from_ptr(Arc::allocate_for_layout(
538                 Layout::new::<T>(),
539                 |layout| Global.allocate_zeroed(layout),
540                 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
541             ))
542         }
543     }
544
545     /// Constructs a new `Pin<Arc<T>>`. If `T` does not implement `Unpin`, then
546     /// `data` will be pinned in memory and unable to be moved.
547     #[cfg(not(no_global_oom_handling))]
548     #[stable(feature = "pin", since = "1.33.0")]
549     #[must_use]
550     pub fn pin(data: T) -> Pin<Arc<T>> {
551         unsafe { Pin::new_unchecked(Arc::new(data)) }
552     }
553
554     /// Constructs a new `Pin<Arc<T>>`, return an error if allocation fails.
555     #[unstable(feature = "allocator_api", issue = "32838")]
556     #[inline]
557     pub fn try_pin(data: T) -> Result<Pin<Arc<T>>, AllocError> {
558         unsafe { Ok(Pin::new_unchecked(Arc::try_new(data)?)) }
559     }
560
561     /// Constructs a new `Arc<T>`, returning an error if allocation fails.
562     ///
563     /// # Examples
564     ///
565     /// ```
566     /// #![feature(allocator_api)]
567     /// use std::sync::Arc;
568     ///
569     /// let five = Arc::try_new(5)?;
570     /// # Ok::<(), std::alloc::AllocError>(())
571     /// ```
572     #[unstable(feature = "allocator_api", issue = "32838")]
573     #[inline]
574     pub fn try_new(data: T) -> Result<Arc<T>, AllocError> {
575         // Start the weak pointer count as 1 which is the weak pointer that's
576         // held by all the strong pointers (kinda), see std/rc.rs for more info
577         let x: Box<_> = Box::try_new(ArcInner {
578             strong: atomic::AtomicUsize::new(1),
579             weak: atomic::AtomicUsize::new(1),
580             data,
581         })?;
582         unsafe { Ok(Self::from_inner(Box::leak(x).into())) }
583     }
584
585     /// Constructs a new `Arc` with uninitialized contents, returning an error
586     /// if allocation fails.
587     ///
588     /// # Examples
589     ///
590     /// ```
591     /// #![feature(new_uninit, allocator_api)]
592     /// #![feature(get_mut_unchecked)]
593     ///
594     /// use std::sync::Arc;
595     ///
596     /// let mut five = Arc::<u32>::try_new_uninit()?;
597     ///
598     /// // Deferred initialization:
599     /// Arc::get_mut(&mut five).unwrap().write(5);
600     ///
601     /// let five = unsafe { five.assume_init() };
602     ///
603     /// assert_eq!(*five, 5);
604     /// # Ok::<(), std::alloc::AllocError>(())
605     /// ```
606     #[unstable(feature = "allocator_api", issue = "32838")]
607     // #[unstable(feature = "new_uninit", issue = "63291")]
608     pub fn try_new_uninit() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
609         unsafe {
610             Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
611                 Layout::new::<T>(),
612                 |layout| Global.allocate(layout),
613                 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
614             )?))
615         }
616     }
617
618     /// Constructs a new `Arc` with uninitialized contents, with the memory
619     /// being filled with `0` bytes, returning an error if allocation fails.
620     ///
621     /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
622     /// of this method.
623     ///
624     /// # Examples
625     ///
626     /// ```
627     /// #![feature(new_uninit, allocator_api)]
628     ///
629     /// use std::sync::Arc;
630     ///
631     /// let zero = Arc::<u32>::try_new_zeroed()?;
632     /// let zero = unsafe { zero.assume_init() };
633     ///
634     /// assert_eq!(*zero, 0);
635     /// # Ok::<(), std::alloc::AllocError>(())
636     /// ```
637     ///
638     /// [zeroed]: mem::MaybeUninit::zeroed
639     #[unstable(feature = "allocator_api", issue = "32838")]
640     // #[unstable(feature = "new_uninit", issue = "63291")]
641     pub fn try_new_zeroed() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
642         unsafe {
643             Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
644                 Layout::new::<T>(),
645                 |layout| Global.allocate_zeroed(layout),
646                 |mem| mem as *mut ArcInner<mem::MaybeUninit<T>>,
647             )?))
648         }
649     }
650     /// Returns the inner value, if the `Arc` has exactly one strong reference.
651     ///
652     /// Otherwise, an [`Err`] is returned with the same `Arc` that was
653     /// passed in.
654     ///
655     /// This will succeed even if there are outstanding weak references.
656     ///
657     /// # Examples
658     ///
659     /// ```
660     /// use std::sync::Arc;
661     ///
662     /// let x = Arc::new(3);
663     /// assert_eq!(Arc::try_unwrap(x), Ok(3));
664     ///
665     /// let x = Arc::new(4);
666     /// let _y = Arc::clone(&x);
667     /// assert_eq!(*Arc::try_unwrap(x).unwrap_err(), 4);
668     /// ```
669     #[inline]
670     #[stable(feature = "arc_unique", since = "1.4.0")]
671     pub fn try_unwrap(this: Self) -> Result<T, Self> {
672         if this.inner().strong.compare_exchange(1, 0, Relaxed, Relaxed).is_err() {
673             return Err(this);
674         }
675
676         acquire!(this.inner().strong);
677
678         unsafe {
679             let elem = ptr::read(&this.ptr.as_ref().data);
680
681             // Make a weak pointer to clean up the implicit strong-weak reference
682             let _weak = Weak { ptr: this.ptr };
683             mem::forget(this);
684
685             Ok(elem)
686         }
687     }
688 }
689
690 impl<T> Arc<[T]> {
691     /// Constructs a new atomically reference-counted slice with uninitialized contents.
692     ///
693     /// # Examples
694     ///
695     /// ```
696     /// #![feature(new_uninit)]
697     /// #![feature(get_mut_unchecked)]
698     ///
699     /// use std::sync::Arc;
700     ///
701     /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
702     ///
703     /// // Deferred initialization:
704     /// let data = Arc::get_mut(&mut values).unwrap();
705     /// data[0].write(1);
706     /// data[1].write(2);
707     /// data[2].write(3);
708     ///
709     /// let values = unsafe { values.assume_init() };
710     ///
711     /// assert_eq!(*values, [1, 2, 3])
712     /// ```
713     #[cfg(not(no_global_oom_handling))]
714     #[unstable(feature = "new_uninit", issue = "63291")]
715     #[must_use]
716     pub fn new_uninit_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
717         unsafe { Arc::from_ptr(Arc::allocate_for_slice(len)) }
718     }
719
720     /// Constructs a new atomically reference-counted slice with uninitialized contents, with the memory being
721     /// filled with `0` bytes.
722     ///
723     /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
724     /// incorrect usage of this method.
725     ///
726     /// # Examples
727     ///
728     /// ```
729     /// #![feature(new_uninit)]
730     ///
731     /// use std::sync::Arc;
732     ///
733     /// let values = Arc::<[u32]>::new_zeroed_slice(3);
734     /// let values = unsafe { values.assume_init() };
735     ///
736     /// assert_eq!(*values, [0, 0, 0])
737     /// ```
738     ///
739     /// [zeroed]: mem::MaybeUninit::zeroed
740     #[cfg(not(no_global_oom_handling))]
741     #[unstable(feature = "new_uninit", issue = "63291")]
742     #[must_use]
743     pub fn new_zeroed_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
744         unsafe {
745             Arc::from_ptr(Arc::allocate_for_layout(
746                 Layout::array::<T>(len).unwrap(),
747                 |layout| Global.allocate_zeroed(layout),
748                 |mem| {
749                     ptr::slice_from_raw_parts_mut(mem as *mut T, len)
750                         as *mut ArcInner<[mem::MaybeUninit<T>]>
751                 },
752             ))
753         }
754     }
755 }
756
757 impl<T> Arc<mem::MaybeUninit<T>> {
758     /// Converts to `Arc<T>`.
759     ///
760     /// # Safety
761     ///
762     /// As with [`MaybeUninit::assume_init`],
763     /// it is up to the caller to guarantee that the inner value
764     /// really is in an initialized state.
765     /// Calling this when the content is not yet fully initialized
766     /// causes immediate undefined behavior.
767     ///
768     /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
769     ///
770     /// # Examples
771     ///
772     /// ```
773     /// #![feature(new_uninit)]
774     /// #![feature(get_mut_unchecked)]
775     ///
776     /// use std::sync::Arc;
777     ///
778     /// let mut five = Arc::<u32>::new_uninit();
779     ///
780     /// // Deferred initialization:
781     /// Arc::get_mut(&mut five).unwrap().write(5);
782     ///
783     /// let five = unsafe { five.assume_init() };
784     ///
785     /// assert_eq!(*five, 5)
786     /// ```
787     #[unstable(feature = "new_uninit", issue = "63291")]
788     #[must_use = "`self` will be dropped if the result is not used"]
789     #[inline]
790     pub unsafe fn assume_init(self) -> Arc<T> {
791         unsafe { Arc::from_inner(mem::ManuallyDrop::new(self).ptr.cast()) }
792     }
793 }
794
795 impl<T> Arc<[mem::MaybeUninit<T>]> {
796     /// Converts to `Arc<[T]>`.
797     ///
798     /// # Safety
799     ///
800     /// As with [`MaybeUninit::assume_init`],
801     /// it is up to the caller to guarantee that the inner value
802     /// really is in an initialized state.
803     /// Calling this when the content is not yet fully initialized
804     /// causes immediate undefined behavior.
805     ///
806     /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
807     ///
808     /// # Examples
809     ///
810     /// ```
811     /// #![feature(new_uninit)]
812     /// #![feature(get_mut_unchecked)]
813     ///
814     /// use std::sync::Arc;
815     ///
816     /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
817     ///
818     /// // Deferred initialization:
819     /// let data = Arc::get_mut(&mut values).unwrap();
820     /// data[0].write(1);
821     /// data[1].write(2);
822     /// data[2].write(3);
823     ///
824     /// let values = unsafe { values.assume_init() };
825     ///
826     /// assert_eq!(*values, [1, 2, 3])
827     /// ```
828     #[unstable(feature = "new_uninit", issue = "63291")]
829     #[must_use = "`self` will be dropped if the result is not used"]
830     #[inline]
831     pub unsafe fn assume_init(self) -> Arc<[T]> {
832         unsafe { Arc::from_ptr(mem::ManuallyDrop::new(self).ptr.as_ptr() as _) }
833     }
834 }
835
836 impl<T: ?Sized> Arc<T> {
837     /// Consumes the `Arc`, returning the wrapped pointer.
838     ///
839     /// To avoid a memory leak the pointer must be converted back to an `Arc` using
840     /// [`Arc::from_raw`].
841     ///
842     /// # Examples
843     ///
844     /// ```
845     /// use std::sync::Arc;
846     ///
847     /// let x = Arc::new("hello".to_owned());
848     /// let x_ptr = Arc::into_raw(x);
849     /// assert_eq!(unsafe { &*x_ptr }, "hello");
850     /// ```
851     #[must_use = "losing the pointer will leak memory"]
852     #[stable(feature = "rc_raw", since = "1.17.0")]
853     pub fn into_raw(this: Self) -> *const T {
854         let ptr = Self::as_ptr(&this);
855         mem::forget(this);
856         ptr
857     }
858
859     /// Provides a raw pointer to the data.
860     ///
861     /// The counts are not affected in any way and the `Arc` is not consumed. The pointer is valid for
862     /// as long as there are strong counts in the `Arc`.
863     ///
864     /// # Examples
865     ///
866     /// ```
867     /// use std::sync::Arc;
868     ///
869     /// let x = Arc::new("hello".to_owned());
870     /// let y = Arc::clone(&x);
871     /// let x_ptr = Arc::as_ptr(&x);
872     /// assert_eq!(x_ptr, Arc::as_ptr(&y));
873     /// assert_eq!(unsafe { &*x_ptr }, "hello");
874     /// ```
875     #[must_use]
876     #[stable(feature = "rc_as_ptr", since = "1.45.0")]
877     pub fn as_ptr(this: &Self) -> *const T {
878         let ptr: *mut ArcInner<T> = NonNull::as_ptr(this.ptr);
879
880         // SAFETY: This cannot go through Deref::deref or RcBoxPtr::inner because
881         // this is required to retain raw/mut provenance such that e.g. `get_mut` can
882         // write through the pointer after the Rc is recovered through `from_raw`.
883         unsafe { ptr::addr_of_mut!((*ptr).data) }
884     }
885
886     /// Constructs an `Arc<T>` from a raw pointer.
887     ///
888     /// The raw pointer must have been previously returned by a call to
889     /// [`Arc<U>::into_raw`][into_raw] where `U` must have the same size and
890     /// alignment as `T`. This is trivially true if `U` is `T`.
891     /// Note that if `U` is not `T` but has the same size and alignment, this is
892     /// basically like transmuting references of different types. See
893     /// [`mem::transmute`][transmute] for more information on what
894     /// restrictions apply in this case.
895     ///
896     /// The user of `from_raw` has to make sure a specific value of `T` is only
897     /// dropped once.
898     ///
899     /// This function is unsafe because improper use may lead to memory unsafety,
900     /// even if the returned `Arc<T>` is never accessed.
901     ///
902     /// [into_raw]: Arc::into_raw
903     /// [transmute]: core::mem::transmute
904     ///
905     /// # Examples
906     ///
907     /// ```
908     /// use std::sync::Arc;
909     ///
910     /// let x = Arc::new("hello".to_owned());
911     /// let x_ptr = Arc::into_raw(x);
912     ///
913     /// unsafe {
914     ///     // Convert back to an `Arc` to prevent leak.
915     ///     let x = Arc::from_raw(x_ptr);
916     ///     assert_eq!(&*x, "hello");
917     ///
918     ///     // Further calls to `Arc::from_raw(x_ptr)` would be memory-unsafe.
919     /// }
920     ///
921     /// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
922     /// ```
923     #[stable(feature = "rc_raw", since = "1.17.0")]
924     pub unsafe fn from_raw(ptr: *const T) -> Self {
925         unsafe {
926             let offset = data_offset(ptr);
927
928             // Reverse the offset to find the original ArcInner.
929             let arc_ptr = ptr.byte_sub(offset) as *mut ArcInner<T>;
930
931             Self::from_ptr(arc_ptr)
932         }
933     }
934
935     /// Creates a new [`Weak`] pointer to this allocation.
936     ///
937     /// # Examples
938     ///
939     /// ```
940     /// use std::sync::Arc;
941     ///
942     /// let five = Arc::new(5);
943     ///
944     /// let weak_five = Arc::downgrade(&five);
945     /// ```
946     #[must_use = "this returns a new `Weak` pointer, \
947                   without modifying the original `Arc`"]
948     #[stable(feature = "arc_weak", since = "1.4.0")]
949     pub fn downgrade(this: &Self) -> Weak<T> {
950         // This Relaxed is OK because we're checking the value in the CAS
951         // below.
952         let mut cur = this.inner().weak.load(Relaxed);
953
954         loop {
955             // check if the weak counter is currently "locked"; if so, spin.
956             if cur == usize::MAX {
957                 hint::spin_loop();
958                 cur = this.inner().weak.load(Relaxed);
959                 continue;
960             }
961
962             // NOTE: this code currently ignores the possibility of overflow
963             // into usize::MAX; in general both Rc and Arc need to be adjusted
964             // to deal with overflow.
965
966             // Unlike with Clone(), we need this to be an Acquire read to
967             // synchronize with the write coming from `is_unique`, so that the
968             // events prior to that write happen before this read.
969             match this.inner().weak.compare_exchange_weak(cur, cur + 1, Acquire, Relaxed) {
970                 Ok(_) => {
971                     // Make sure we do not create a dangling Weak
972                     debug_assert!(!is_dangling(this.ptr.as_ptr()));
973                     return Weak { ptr: this.ptr };
974                 }
975                 Err(old) => cur = old,
976             }
977         }
978     }
979
980     /// Gets the number of [`Weak`] pointers to this allocation.
981     ///
982     /// # Safety
983     ///
984     /// This method by itself is safe, but using it correctly requires extra care.
985     /// Another thread can change the weak count at any time,
986     /// including potentially between calling this method and acting on the result.
987     ///
988     /// # Examples
989     ///
990     /// ```
991     /// use std::sync::Arc;
992     ///
993     /// let five = Arc::new(5);
994     /// let _weak_five = Arc::downgrade(&five);
995     ///
996     /// // This assertion is deterministic because we haven't shared
997     /// // the `Arc` or `Weak` between threads.
998     /// assert_eq!(1, Arc::weak_count(&five));
999     /// ```
1000     #[inline]
1001     #[must_use]
1002     #[stable(feature = "arc_counts", since = "1.15.0")]
1003     pub fn weak_count(this: &Self) -> usize {
1004         let cnt = this.inner().weak.load(Acquire);
1005         // If the weak count is currently locked, the value of the
1006         // count was 0 just before taking the lock.
1007         if cnt == usize::MAX { 0 } else { cnt - 1 }
1008     }
1009
1010     /// Gets the number of strong (`Arc`) pointers to this allocation.
1011     ///
1012     /// # Safety
1013     ///
1014     /// This method by itself is safe, but using it correctly requires extra care.
1015     /// Another thread can change the strong count at any time,
1016     /// including potentially between calling this method and acting on the result.
1017     ///
1018     /// # Examples
1019     ///
1020     /// ```
1021     /// use std::sync::Arc;
1022     ///
1023     /// let five = Arc::new(5);
1024     /// let _also_five = Arc::clone(&five);
1025     ///
1026     /// // This assertion is deterministic because we haven't shared
1027     /// // the `Arc` between threads.
1028     /// assert_eq!(2, Arc::strong_count(&five));
1029     /// ```
1030     #[inline]
1031     #[must_use]
1032     #[stable(feature = "arc_counts", since = "1.15.0")]
1033     pub fn strong_count(this: &Self) -> usize {
1034         this.inner().strong.load(Acquire)
1035     }
1036
1037     /// Increments the strong reference count on the `Arc<T>` associated with the
1038     /// provided pointer by one.
1039     ///
1040     /// # Safety
1041     ///
1042     /// The pointer must have been obtained through `Arc::into_raw`, and the
1043     /// associated `Arc` instance must be valid (i.e. the strong count must be at
1044     /// least 1) for the duration of this method.
1045     ///
1046     /// # Examples
1047     ///
1048     /// ```
1049     /// use std::sync::Arc;
1050     ///
1051     /// let five = Arc::new(5);
1052     ///
1053     /// unsafe {
1054     ///     let ptr = Arc::into_raw(five);
1055     ///     Arc::increment_strong_count(ptr);
1056     ///
1057     ///     // This assertion is deterministic because we haven't shared
1058     ///     // the `Arc` between threads.
1059     ///     let five = Arc::from_raw(ptr);
1060     ///     assert_eq!(2, Arc::strong_count(&five));
1061     /// }
1062     /// ```
1063     #[inline]
1064     #[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
1065     pub unsafe fn increment_strong_count(ptr: *const T) {
1066         // Retain Arc, but don't touch refcount by wrapping in ManuallyDrop
1067         let arc = unsafe { mem::ManuallyDrop::new(Arc::<T>::from_raw(ptr)) };
1068         // Now increase refcount, but don't drop new refcount either
1069         let _arc_clone: mem::ManuallyDrop<_> = arc.clone();
1070     }
1071
1072     /// Decrements the strong reference count on the `Arc<T>` associated with the
1073     /// provided pointer by one.
1074     ///
1075     /// # Safety
1076     ///
1077     /// The pointer must have been obtained through `Arc::into_raw`, and the
1078     /// associated `Arc` instance must be valid (i.e. the strong count must be at
1079     /// least 1) when invoking this method. This method can be used to release the final
1080     /// `Arc` and backing storage, but **should not** be called after the final `Arc` has been
1081     /// released.
1082     ///
1083     /// # Examples
1084     ///
1085     /// ```
1086     /// use std::sync::Arc;
1087     ///
1088     /// let five = Arc::new(5);
1089     ///
1090     /// unsafe {
1091     ///     let ptr = Arc::into_raw(five);
1092     ///     Arc::increment_strong_count(ptr);
1093     ///
1094     ///     // Those assertions are deterministic because we haven't shared
1095     ///     // the `Arc` between threads.
1096     ///     let five = Arc::from_raw(ptr);
1097     ///     assert_eq!(2, Arc::strong_count(&five));
1098     ///     Arc::decrement_strong_count(ptr);
1099     ///     assert_eq!(1, Arc::strong_count(&five));
1100     /// }
1101     /// ```
1102     #[inline]
1103     #[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
1104     pub unsafe fn decrement_strong_count(ptr: *const T) {
1105         unsafe { mem::drop(Arc::from_raw(ptr)) };
1106     }
1107
1108     #[inline]
1109     fn inner(&self) -> &ArcInner<T> {
1110         // This unsafety is ok because while this arc is alive we're guaranteed
1111         // that the inner pointer is valid. Furthermore, we know that the
1112         // `ArcInner` structure itself is `Sync` because the inner data is
1113         // `Sync` as well, so we're ok loaning out an immutable pointer to these
1114         // contents.
1115         unsafe { self.ptr.as_ref() }
1116     }
1117
1118     // Non-inlined part of `drop`.
1119     #[inline(never)]
1120     unsafe fn drop_slow(&mut self) {
1121         // Destroy the data at this time, even though we must not free the box
1122         // allocation itself (there might still be weak pointers lying around).
1123         unsafe { ptr::drop_in_place(Self::get_mut_unchecked(self)) };
1124
1125         // Drop the weak ref collectively held by all strong references
1126         drop(Weak { ptr: self.ptr });
1127     }
1128
1129     /// Returns `true` if the two `Arc`s point to the same allocation in a vein similar to
1130     /// [`ptr::eq`]. See [that function][`ptr::eq`] for caveats when comparing `dyn Trait` pointers.
1131     ///
1132     /// # Examples
1133     ///
1134     /// ```
1135     /// use std::sync::Arc;
1136     ///
1137     /// let five = Arc::new(5);
1138     /// let same_five = Arc::clone(&five);
1139     /// let other_five = Arc::new(5);
1140     ///
1141     /// assert!(Arc::ptr_eq(&five, &same_five));
1142     /// assert!(!Arc::ptr_eq(&five, &other_five));
1143     /// ```
1144     ///
1145     /// [`ptr::eq`]: core::ptr::eq "ptr::eq"
1146     #[inline]
1147     #[must_use]
1148     #[stable(feature = "ptr_eq", since = "1.17.0")]
1149     pub fn ptr_eq(this: &Self, other: &Self) -> bool {
1150         this.ptr.as_ptr() == other.ptr.as_ptr()
1151     }
1152 }
1153
1154 impl<T: ?Sized> Arc<T> {
1155     /// Allocates an `ArcInner<T>` with sufficient space for
1156     /// a possibly-unsized inner value where the value has the layout provided.
1157     ///
1158     /// The function `mem_to_arcinner` is called with the data pointer
1159     /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
1160     #[cfg(not(no_global_oom_handling))]
1161     unsafe fn allocate_for_layout(
1162         value_layout: Layout,
1163         allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1164         mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
1165     ) -> *mut ArcInner<T> {
1166         let layout = arcinner_layout_for_value_layout(value_layout);
1167         unsafe {
1168             Arc::try_allocate_for_layout(value_layout, allocate, mem_to_arcinner)
1169                 .unwrap_or_else(|_| handle_alloc_error(layout))
1170         }
1171     }
1172
1173     /// Allocates an `ArcInner<T>` with sufficient space for
1174     /// a possibly-unsized inner value where the value has the layout provided,
1175     /// returning an error if allocation fails.
1176     ///
1177     /// The function `mem_to_arcinner` is called with the data pointer
1178     /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
1179     unsafe fn try_allocate_for_layout(
1180         value_layout: Layout,
1181         allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1182         mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
1183     ) -> Result<*mut ArcInner<T>, AllocError> {
1184         let layout = arcinner_layout_for_value_layout(value_layout);
1185
1186         let ptr = allocate(layout)?;
1187
1188         // Initialize the ArcInner
1189         let inner = mem_to_arcinner(ptr.as_non_null_ptr().as_ptr());
1190         debug_assert_eq!(unsafe { Layout::for_value(&*inner) }, layout);
1191
1192         unsafe {
1193             ptr::write(&mut (*inner).strong, atomic::AtomicUsize::new(1));
1194             ptr::write(&mut (*inner).weak, atomic::AtomicUsize::new(1));
1195         }
1196
1197         Ok(inner)
1198     }
1199
1200     /// Allocates an `ArcInner<T>` with sufficient space for an unsized inner value.
1201     #[cfg(not(no_global_oom_handling))]
1202     unsafe fn allocate_for_ptr(ptr: *const T) -> *mut ArcInner<T> {
1203         // Allocate for the `ArcInner<T>` using the given value.
1204         unsafe {
1205             Self::allocate_for_layout(
1206                 Layout::for_value(&*ptr),
1207                 |layout| Global.allocate(layout),
1208                 |mem| mem.with_metadata_of(ptr as *const ArcInner<T>),
1209             )
1210         }
1211     }
1212
1213     #[cfg(not(no_global_oom_handling))]
1214     fn from_box(v: Box<T>) -> Arc<T> {
1215         unsafe {
1216             let (box_unique, alloc) = Box::into_unique(v);
1217             let bptr = box_unique.as_ptr();
1218
1219             let value_size = size_of_val(&*bptr);
1220             let ptr = Self::allocate_for_ptr(bptr);
1221
1222             // Copy value as bytes
1223             ptr::copy_nonoverlapping(
1224                 bptr as *const T as *const u8,
1225                 &mut (*ptr).data as *mut _ as *mut u8,
1226                 value_size,
1227             );
1228
1229             // Free the allocation without dropping its contents
1230             box_free(box_unique, alloc);
1231
1232             Self::from_ptr(ptr)
1233         }
1234     }
1235 }
1236
1237 impl<T> Arc<[T]> {
1238     /// Allocates an `ArcInner<[T]>` with the given length.
1239     #[cfg(not(no_global_oom_handling))]
1240     unsafe fn allocate_for_slice(len: usize) -> *mut ArcInner<[T]> {
1241         unsafe {
1242             Self::allocate_for_layout(
1243                 Layout::array::<T>(len).unwrap(),
1244                 |layout| Global.allocate(layout),
1245                 |mem| ptr::slice_from_raw_parts_mut(mem as *mut T, len) as *mut ArcInner<[T]>,
1246             )
1247         }
1248     }
1249
1250     /// Copy elements from slice into newly allocated `Arc<[T]>`
1251     ///
1252     /// Unsafe because the caller must either take ownership or bind `T: Copy`.
1253     #[cfg(not(no_global_oom_handling))]
1254     unsafe fn copy_from_slice(v: &[T]) -> Arc<[T]> {
1255         unsafe {
1256             let ptr = Self::allocate_for_slice(v.len());
1257
1258             ptr::copy_nonoverlapping(v.as_ptr(), &mut (*ptr).data as *mut [T] as *mut T, v.len());
1259
1260             Self::from_ptr(ptr)
1261         }
1262     }
1263
1264     /// Constructs an `Arc<[T]>` from an iterator known to be of a certain size.
1265     ///
1266     /// Behavior is undefined should the size be wrong.
1267     #[cfg(not(no_global_oom_handling))]
1268     unsafe fn from_iter_exact(iter: impl iter::Iterator<Item = T>, len: usize) -> Arc<[T]> {
1269         // Panic guard while cloning T elements.
1270         // In the event of a panic, elements that have been written
1271         // into the new ArcInner will be dropped, then the memory freed.
1272         struct Guard<T> {
1273             mem: NonNull<u8>,
1274             elems: *mut T,
1275             layout: Layout,
1276             n_elems: usize,
1277         }
1278
1279         impl<T> Drop for Guard<T> {
1280             fn drop(&mut self) {
1281                 unsafe {
1282                     let slice = from_raw_parts_mut(self.elems, self.n_elems);
1283                     ptr::drop_in_place(slice);
1284
1285                     Global.deallocate(self.mem, self.layout);
1286                 }
1287             }
1288         }
1289
1290         unsafe {
1291             let ptr = Self::allocate_for_slice(len);
1292
1293             let mem = ptr as *mut _ as *mut u8;
1294             let layout = Layout::for_value(&*ptr);
1295
1296             // Pointer to first element
1297             let elems = &mut (*ptr).data as *mut [T] as *mut T;
1298
1299             let mut guard = Guard { mem: NonNull::new_unchecked(mem), elems, layout, n_elems: 0 };
1300
1301             for (i, item) in iter.enumerate() {
1302                 ptr::write(elems.add(i), item);
1303                 guard.n_elems += 1;
1304             }
1305
1306             // All clear. Forget the guard so it doesn't free the new ArcInner.
1307             mem::forget(guard);
1308
1309             Self::from_ptr(ptr)
1310         }
1311     }
1312 }
1313
1314 /// Specialization trait used for `From<&[T]>`.
1315 #[cfg(not(no_global_oom_handling))]
1316 trait ArcFromSlice<T> {
1317     fn from_slice(slice: &[T]) -> Self;
1318 }
1319
1320 #[cfg(not(no_global_oom_handling))]
1321 impl<T: Clone> ArcFromSlice<T> for Arc<[T]> {
1322     #[inline]
1323     default fn from_slice(v: &[T]) -> Self {
1324         unsafe { Self::from_iter_exact(v.iter().cloned(), v.len()) }
1325     }
1326 }
1327
1328 #[cfg(not(no_global_oom_handling))]
1329 impl<T: Copy> ArcFromSlice<T> for Arc<[T]> {
1330     #[inline]
1331     fn from_slice(v: &[T]) -> Self {
1332         unsafe { Arc::copy_from_slice(v) }
1333     }
1334 }
1335
1336 #[stable(feature = "rust1", since = "1.0.0")]
1337 impl<T: ?Sized> Clone for Arc<T> {
1338     /// Makes a clone of the `Arc` pointer.
1339     ///
1340     /// This creates another pointer to the same allocation, increasing the
1341     /// strong reference count.
1342     ///
1343     /// # Examples
1344     ///
1345     /// ```
1346     /// use std::sync::Arc;
1347     ///
1348     /// let five = Arc::new(5);
1349     ///
1350     /// let _ = Arc::clone(&five);
1351     /// ```
1352     #[inline]
1353     fn clone(&self) -> Arc<T> {
1354         // Using a relaxed ordering is alright here, as knowledge of the
1355         // original reference prevents other threads from erroneously deleting
1356         // the object.
1357         //
1358         // As explained in the [Boost documentation][1], Increasing the
1359         // reference counter can always be done with memory_order_relaxed: New
1360         // references to an object can only be formed from an existing
1361         // reference, and passing an existing reference from one thread to
1362         // another must already provide any required synchronization.
1363         //
1364         // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1365         let old_size = self.inner().strong.fetch_add(1, Relaxed);
1366
1367         // However we need to guard against massive refcounts in case someone is `mem::forget`ing
1368         // Arcs. If we don't do this the count can overflow and users will use-after free. This
1369         // branch will never be taken in any realistic program. We abort because such a program is
1370         // incredibly degenerate, and we don't care to support it.
1371         //
1372         // This check is not 100% water-proof: we error when the refcount grows beyond `isize::MAX`.
1373         // But we do that check *after* having done the increment, so there is a chance here that
1374         // the worst already happened and we actually do overflow the `usize` counter. However, that
1375         // requires the counter to grow from `isize::MAX` to `usize::MAX` between the increment
1376         // above and the `abort` below, which seems exceedingly unlikely.
1377         if old_size > MAX_REFCOUNT {
1378             abort();
1379         }
1380
1381         unsafe { Self::from_inner(self.ptr) }
1382     }
1383 }
1384
1385 #[stable(feature = "rust1", since = "1.0.0")]
1386 impl<T: ?Sized> Deref for Arc<T> {
1387     type Target = T;
1388
1389     #[inline]
1390     fn deref(&self) -> &T {
1391         &self.inner().data
1392     }
1393 }
1394
1395 #[unstable(feature = "receiver_trait", issue = "none")]
1396 impl<T: ?Sized> Receiver for Arc<T> {}
1397
1398 impl<T: Clone> Arc<T> {
1399     /// Makes a mutable reference into the given `Arc`.
1400     ///
1401     /// If there are other `Arc` pointers to the same allocation, then `make_mut` will
1402     /// [`clone`] the inner value to a new allocation to ensure unique ownership.  This is also
1403     /// referred to as clone-on-write.
1404     ///
1405     /// However, if there are no other `Arc` pointers to this allocation, but some [`Weak`]
1406     /// pointers, then the [`Weak`] pointers will be dissociated and the inner value will not
1407     /// be cloned.
1408     ///
1409     /// See also [`get_mut`], which will fail rather than cloning the inner value
1410     /// or dissociating [`Weak`] pointers.
1411     ///
1412     /// [`clone`]: Clone::clone
1413     /// [`get_mut`]: Arc::get_mut
1414     ///
1415     /// # Examples
1416     ///
1417     /// ```
1418     /// use std::sync::Arc;
1419     ///
1420     /// let mut data = Arc::new(5);
1421     ///
1422     /// *Arc::make_mut(&mut data) += 1;         // Won't clone anything
1423     /// let mut other_data = Arc::clone(&data); // Won't clone inner data
1424     /// *Arc::make_mut(&mut data) += 1;         // Clones inner data
1425     /// *Arc::make_mut(&mut data) += 1;         // Won't clone anything
1426     /// *Arc::make_mut(&mut other_data) *= 2;   // Won't clone anything
1427     ///
1428     /// // Now `data` and `other_data` point to different allocations.
1429     /// assert_eq!(*data, 8);
1430     /// assert_eq!(*other_data, 12);
1431     /// ```
1432     ///
1433     /// [`Weak`] pointers will be dissociated:
1434     ///
1435     /// ```
1436     /// use std::sync::Arc;
1437     ///
1438     /// let mut data = Arc::new(75);
1439     /// let weak = Arc::downgrade(&data);
1440     ///
1441     /// assert!(75 == *data);
1442     /// assert!(75 == *weak.upgrade().unwrap());
1443     ///
1444     /// *Arc::make_mut(&mut data) += 1;
1445     ///
1446     /// assert!(76 == *data);
1447     /// assert!(weak.upgrade().is_none());
1448     /// ```
1449     #[cfg(not(no_global_oom_handling))]
1450     #[inline]
1451     #[stable(feature = "arc_unique", since = "1.4.0")]
1452     pub fn make_mut(this: &mut Self) -> &mut T {
1453         // Note that we hold both a strong reference and a weak reference.
1454         // Thus, releasing our strong reference only will not, by itself, cause
1455         // the memory to be deallocated.
1456         //
1457         // Use Acquire to ensure that we see any writes to `weak` that happen
1458         // before release writes (i.e., decrements) to `strong`. Since we hold a
1459         // weak count, there's no chance the ArcInner itself could be
1460         // deallocated.
1461         if this.inner().strong.compare_exchange(1, 0, Acquire, Relaxed).is_err() {
1462             // Another strong pointer exists, so we must clone.
1463             // Pre-allocate memory to allow writing the cloned value directly.
1464             let mut arc = Self::new_uninit();
1465             unsafe {
1466                 let data = Arc::get_mut_unchecked(&mut arc);
1467                 (**this).write_clone_into_raw(data.as_mut_ptr());
1468                 *this = arc.assume_init();
1469             }
1470         } else if this.inner().weak.load(Relaxed) != 1 {
1471             // Relaxed suffices in the above because this is fundamentally an
1472             // optimization: we are always racing with weak pointers being
1473             // dropped. Worst case, we end up allocated a new Arc unnecessarily.
1474
1475             // We removed the last strong ref, but there are additional weak
1476             // refs remaining. We'll move the contents to a new Arc, and
1477             // invalidate the other weak refs.
1478
1479             // Note that it is not possible for the read of `weak` to yield
1480             // usize::MAX (i.e., locked), since the weak count can only be
1481             // locked by a thread with a strong reference.
1482
1483             // Materialize our own implicit weak pointer, so that it can clean
1484             // up the ArcInner as needed.
1485             let _weak = Weak { ptr: this.ptr };
1486
1487             // Can just steal the data, all that's left is Weaks
1488             let mut arc = Self::new_uninit();
1489             unsafe {
1490                 let data = Arc::get_mut_unchecked(&mut arc);
1491                 data.as_mut_ptr().copy_from_nonoverlapping(&**this, 1);
1492                 ptr::write(this, arc.assume_init());
1493             }
1494         } else {
1495             // We were the sole reference of either kind; bump back up the
1496             // strong ref count.
1497             this.inner().strong.store(1, Release);
1498         }
1499
1500         // As with `get_mut()`, the unsafety is ok because our reference was
1501         // either unique to begin with, or became one upon cloning the contents.
1502         unsafe { Self::get_mut_unchecked(this) }
1503     }
1504
1505     /// If we have the only reference to `T` then unwrap it. Otherwise, clone `T` and return the
1506     /// clone.
1507     ///
1508     /// Assuming `arc_t` is of type `Arc<T>`, this function is functionally equivalent to
1509     /// `(*arc_t).clone()`, but will avoid cloning the inner value where possible.
1510     ///
1511     /// # Examples
1512     ///
1513     /// ```
1514     /// #![feature(arc_unwrap_or_clone)]
1515     /// # use std::{ptr, sync::Arc};
1516     /// let inner = String::from("test");
1517     /// let ptr = inner.as_ptr();
1518     ///
1519     /// let arc = Arc::new(inner);
1520     /// let inner = Arc::unwrap_or_clone(arc);
1521     /// // The inner value was not cloned
1522     /// assert!(ptr::eq(ptr, inner.as_ptr()));
1523     ///
1524     /// let arc = Arc::new(inner);
1525     /// let arc2 = arc.clone();
1526     /// let inner = Arc::unwrap_or_clone(arc);
1527     /// // Because there were 2 references, we had to clone the inner value.
1528     /// assert!(!ptr::eq(ptr, inner.as_ptr()));
1529     /// // `arc2` is the last reference, so when we unwrap it we get back
1530     /// // the original `String`.
1531     /// let inner = Arc::unwrap_or_clone(arc2);
1532     /// assert!(ptr::eq(ptr, inner.as_ptr()));
1533     /// ```
1534     #[inline]
1535     #[unstable(feature = "arc_unwrap_or_clone", issue = "93610")]
1536     pub fn unwrap_or_clone(this: Self) -> T {
1537         Arc::try_unwrap(this).unwrap_or_else(|arc| (*arc).clone())
1538     }
1539 }
1540
1541 impl<T: ?Sized> Arc<T> {
1542     /// Returns a mutable reference into the given `Arc`, if there are
1543     /// no other `Arc` or [`Weak`] pointers to the same allocation.
1544     ///
1545     /// Returns [`None`] otherwise, because it is not safe to
1546     /// mutate a shared value.
1547     ///
1548     /// See also [`make_mut`][make_mut], which will [`clone`][clone]
1549     /// the inner value when there are other `Arc` pointers.
1550     ///
1551     /// [make_mut]: Arc::make_mut
1552     /// [clone]: Clone::clone
1553     ///
1554     /// # Examples
1555     ///
1556     /// ```
1557     /// use std::sync::Arc;
1558     ///
1559     /// let mut x = Arc::new(3);
1560     /// *Arc::get_mut(&mut x).unwrap() = 4;
1561     /// assert_eq!(*x, 4);
1562     ///
1563     /// let _y = Arc::clone(&x);
1564     /// assert!(Arc::get_mut(&mut x).is_none());
1565     /// ```
1566     #[inline]
1567     #[stable(feature = "arc_unique", since = "1.4.0")]
1568     pub fn get_mut(this: &mut Self) -> Option<&mut T> {
1569         if this.is_unique() {
1570             // This unsafety is ok because we're guaranteed that the pointer
1571             // returned is the *only* pointer that will ever be returned to T. Our
1572             // reference count is guaranteed to be 1 at this point, and we required
1573             // the Arc itself to be `mut`, so we're returning the only possible
1574             // reference to the inner data.
1575             unsafe { Some(Arc::get_mut_unchecked(this)) }
1576         } else {
1577             None
1578         }
1579     }
1580
1581     /// Returns a mutable reference into the given `Arc`,
1582     /// without any check.
1583     ///
1584     /// See also [`get_mut`], which is safe and does appropriate checks.
1585     ///
1586     /// [`get_mut`]: Arc::get_mut
1587     ///
1588     /// # Safety
1589     ///
1590     /// If any other `Arc` or [`Weak`] pointers to the same allocation exist, then
1591     /// they must be must not be dereferenced or have active borrows for the duration
1592     /// of the returned borrow, and their inner type must be exactly the same as the
1593     /// inner type of this Rc (including lifetimes). This is trivially the case if no
1594     /// such pointers exist, for example immediately after `Arc::new`.
1595     ///
1596     /// # Examples
1597     ///
1598     /// ```
1599     /// #![feature(get_mut_unchecked)]
1600     ///
1601     /// use std::sync::Arc;
1602     ///
1603     /// let mut x = Arc::new(String::new());
1604     /// unsafe {
1605     ///     Arc::get_mut_unchecked(&mut x).push_str("foo")
1606     /// }
1607     /// assert_eq!(*x, "foo");
1608     /// ```
1609     /// Other `Arc` pointers to the same allocation must be to the same type.
1610     /// ```no_run
1611     /// #![feature(get_mut_unchecked)]
1612     ///
1613     /// use std::sync::Arc;
1614     ///
1615     /// let x: Arc<str> = Arc::from("Hello, world!");
1616     /// let mut y: Arc<[u8]> = x.clone().into();
1617     /// unsafe {
1618     ///     // this is Undefined Behavior, because x's inner type is str, not [u8]
1619     ///     Arc::get_mut_unchecked(&mut y).fill(0xff); // 0xff is invalid in UTF-8
1620     /// }
1621     /// println!("{}", &*x); // Invalid UTF-8 in a str
1622     /// ```
1623     /// Other `Arc` pointers to the same allocation must be to the exact same type, including lifetimes.
1624     /// ```no_run
1625     /// #![feature(get_mut_unchecked)]
1626     ///
1627     /// use std::sync::Arc;
1628     ///
1629     /// let x: Arc<&str> = Arc::new("Hello, world!");
1630     /// {
1631     ///     let s = String::from("Oh, no!");
1632     ///     let mut y: Arc<&str> = x.clone().into();
1633     ///     unsafe {
1634     ///         // this is Undefined Behavior, because x's inner type
1635     ///         // is &'long str, not &'short str
1636     ///         *Arc::get_mut_unchecked(&mut y) = &s;
1637     ///     }
1638     /// }
1639     /// println!("{}", &*x); // Use-after-free
1640     /// ```
1641     #[inline]
1642     #[unstable(feature = "get_mut_unchecked", issue = "63292")]
1643     pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
1644         // We are careful to *not* create a reference covering the "count" fields, as
1645         // this would alias with concurrent access to the reference counts (e.g. by `Weak`).
1646         unsafe { &mut (*this.ptr.as_ptr()).data }
1647     }
1648
1649     /// Determine whether this is the unique reference (including weak refs) to
1650     /// the underlying data.
1651     ///
1652     /// Note that this requires locking the weak ref count.
1653     fn is_unique(&mut self) -> bool {
1654         // lock the weak pointer count if we appear to be the sole weak pointer
1655         // holder.
1656         //
1657         // The acquire label here ensures a happens-before relationship with any
1658         // writes to `strong` (in particular in `Weak::upgrade`) prior to decrements
1659         // of the `weak` count (via `Weak::drop`, which uses release).  If the upgraded
1660         // weak ref was never dropped, the CAS here will fail so we do not care to synchronize.
1661         if self.inner().weak.compare_exchange(1, usize::MAX, Acquire, Relaxed).is_ok() {
1662             // This needs to be an `Acquire` to synchronize with the decrement of the `strong`
1663             // counter in `drop` -- the only access that happens when any but the last reference
1664             // is being dropped.
1665             let unique = self.inner().strong.load(Acquire) == 1;
1666
1667             // The release write here synchronizes with a read in `downgrade`,
1668             // effectively preventing the above read of `strong` from happening
1669             // after the write.
1670             self.inner().weak.store(1, Release); // release the lock
1671             unique
1672         } else {
1673             false
1674         }
1675     }
1676 }
1677
1678 #[stable(feature = "rust1", since = "1.0.0")]
1679 unsafe impl<#[may_dangle] T: ?Sized> Drop for Arc<T> {
1680     /// Drops the `Arc`.
1681     ///
1682     /// This will decrement the strong reference count. If the strong reference
1683     /// count reaches zero then the only other references (if any) are
1684     /// [`Weak`], so we `drop` the inner value.
1685     ///
1686     /// # Examples
1687     ///
1688     /// ```
1689     /// use std::sync::Arc;
1690     ///
1691     /// struct Foo;
1692     ///
1693     /// impl Drop for Foo {
1694     ///     fn drop(&mut self) {
1695     ///         println!("dropped!");
1696     ///     }
1697     /// }
1698     ///
1699     /// let foo  = Arc::new(Foo);
1700     /// let foo2 = Arc::clone(&foo);
1701     ///
1702     /// drop(foo);    // Doesn't print anything
1703     /// drop(foo2);   // Prints "dropped!"
1704     /// ```
1705     #[inline]
1706     fn drop(&mut self) {
1707         // Because `fetch_sub` is already atomic, we do not need to synchronize
1708         // with other threads unless we are going to delete the object. This
1709         // same logic applies to the below `fetch_sub` to the `weak` count.
1710         if self.inner().strong.fetch_sub(1, Release) != 1 {
1711             return;
1712         }
1713
1714         // This fence is needed to prevent reordering of use of the data and
1715         // deletion of the data.  Because it is marked `Release`, the decreasing
1716         // of the reference count synchronizes with this `Acquire` fence. This
1717         // means that use of the data happens before decreasing the reference
1718         // count, which happens before this fence, which happens before the
1719         // deletion of the data.
1720         //
1721         // As explained in the [Boost documentation][1],
1722         //
1723         // > It is important to enforce any possible access to the object in one
1724         // > thread (through an existing reference) to *happen before* deleting
1725         // > the object in a different thread. This is achieved by a "release"
1726         // > operation after dropping a reference (any access to the object
1727         // > through this reference must obviously happened before), and an
1728         // > "acquire" operation before deleting the object.
1729         //
1730         // In particular, while the contents of an Arc are usually immutable, it's
1731         // possible to have interior writes to something like a Mutex<T>. Since a
1732         // Mutex is not acquired when it is deleted, we can't rely on its
1733         // synchronization logic to make writes in thread A visible to a destructor
1734         // running in thread B.
1735         //
1736         // Also note that the Acquire fence here could probably be replaced with an
1737         // Acquire load, which could improve performance in highly-contended
1738         // situations. See [2].
1739         //
1740         // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1741         // [2]: (https://github.com/rust-lang/rust/pull/41714)
1742         acquire!(self.inner().strong);
1743
1744         unsafe {
1745             self.drop_slow();
1746         }
1747     }
1748 }
1749
1750 impl Arc<dyn Any + Send + Sync> {
1751     /// Attempt to downcast the `Arc<dyn Any + Send + Sync>` to a concrete type.
1752     ///
1753     /// # Examples
1754     ///
1755     /// ```
1756     /// use std::any::Any;
1757     /// use std::sync::Arc;
1758     ///
1759     /// fn print_if_string(value: Arc<dyn Any + Send + Sync>) {
1760     ///     if let Ok(string) = value.downcast::<String>() {
1761     ///         println!("String ({}): {}", string.len(), string);
1762     ///     }
1763     /// }
1764     ///
1765     /// let my_string = "Hello World".to_string();
1766     /// print_if_string(Arc::new(my_string));
1767     /// print_if_string(Arc::new(0i8));
1768     /// ```
1769     #[inline]
1770     #[stable(feature = "rc_downcast", since = "1.29.0")]
1771     pub fn downcast<T>(self) -> Result<Arc<T>, Self>
1772     where
1773         T: Any + Send + Sync,
1774     {
1775         if (*self).is::<T>() {
1776             unsafe {
1777                 let ptr = self.ptr.cast::<ArcInner<T>>();
1778                 mem::forget(self);
1779                 Ok(Arc::from_inner(ptr))
1780             }
1781         } else {
1782             Err(self)
1783         }
1784     }
1785
1786     /// Downcasts the `Arc<dyn Any + Send + Sync>` to a concrete type.
1787     ///
1788     /// For a safe alternative see [`downcast`].
1789     ///
1790     /// # Examples
1791     ///
1792     /// ```
1793     /// #![feature(downcast_unchecked)]
1794     ///
1795     /// use std::any::Any;
1796     /// use std::sync::Arc;
1797     ///
1798     /// let x: Arc<dyn Any + Send + Sync> = Arc::new(1_usize);
1799     ///
1800     /// unsafe {
1801     ///     assert_eq!(*x.downcast_unchecked::<usize>(), 1);
1802     /// }
1803     /// ```
1804     ///
1805     /// # Safety
1806     ///
1807     /// The contained value must be of type `T`. Calling this method
1808     /// with the incorrect type is *undefined behavior*.
1809     ///
1810     ///
1811     /// [`downcast`]: Self::downcast
1812     #[inline]
1813     #[unstable(feature = "downcast_unchecked", issue = "90850")]
1814     pub unsafe fn downcast_unchecked<T>(self) -> Arc<T>
1815     where
1816         T: Any + Send + Sync,
1817     {
1818         unsafe {
1819             let ptr = self.ptr.cast::<ArcInner<T>>();
1820             mem::forget(self);
1821             Arc::from_inner(ptr)
1822         }
1823     }
1824 }
1825
1826 impl<T> Weak<T> {
1827     /// Constructs a new `Weak<T>`, without allocating any memory.
1828     /// Calling [`upgrade`] on the return value always gives [`None`].
1829     ///
1830     /// [`upgrade`]: Weak::upgrade
1831     ///
1832     /// # Examples
1833     ///
1834     /// ```
1835     /// use std::sync::Weak;
1836     ///
1837     /// let empty: Weak<i64> = Weak::new();
1838     /// assert!(empty.upgrade().is_none());
1839     /// ```
1840     #[stable(feature = "downgraded_weak", since = "1.10.0")]
1841     #[rustc_const_unstable(feature = "const_weak_new", issue = "95091", reason = "recently added")]
1842     #[must_use]
1843     pub const fn new() -> Weak<T> {
1844         Weak { ptr: unsafe { NonNull::new_unchecked(ptr::invalid_mut::<ArcInner<T>>(usize::MAX)) } }
1845     }
1846 }
1847
1848 /// Helper type to allow accessing the reference counts without
1849 /// making any assertions about the data field.
1850 struct WeakInner<'a> {
1851     weak: &'a atomic::AtomicUsize,
1852     strong: &'a atomic::AtomicUsize,
1853 }
1854
1855 impl<T: ?Sized> Weak<T> {
1856     /// Returns a raw pointer to the object `T` pointed to by this `Weak<T>`.
1857     ///
1858     /// The pointer is valid only if there are some strong references. The pointer may be dangling,
1859     /// unaligned or even [`null`] otherwise.
1860     ///
1861     /// # Examples
1862     ///
1863     /// ```
1864     /// use std::sync::Arc;
1865     /// use std::ptr;
1866     ///
1867     /// let strong = Arc::new("hello".to_owned());
1868     /// let weak = Arc::downgrade(&strong);
1869     /// // Both point to the same object
1870     /// assert!(ptr::eq(&*strong, weak.as_ptr()));
1871     /// // The strong here keeps it alive, so we can still access the object.
1872     /// assert_eq!("hello", unsafe { &*weak.as_ptr() });
1873     ///
1874     /// drop(strong);
1875     /// // But not any more. We can do weak.as_ptr(), but accessing the pointer would lead to
1876     /// // undefined behaviour.
1877     /// // assert_eq!("hello", unsafe { &*weak.as_ptr() });
1878     /// ```
1879     ///
1880     /// [`null`]: core::ptr::null "ptr::null"
1881     #[must_use]
1882     #[stable(feature = "weak_into_raw", since = "1.45.0")]
1883     pub fn as_ptr(&self) -> *const T {
1884         let ptr: *mut ArcInner<T> = NonNull::as_ptr(self.ptr);
1885
1886         if is_dangling(ptr) {
1887             // If the pointer is dangling, we return the sentinel directly. This cannot be
1888             // a valid payload address, as the payload is at least as aligned as ArcInner (usize).
1889             ptr as *const T
1890         } else {
1891             // SAFETY: if is_dangling returns false, then the pointer is dereferenceable.
1892             // The payload may be dropped at this point, and we have to maintain provenance,
1893             // so use raw pointer manipulation.
1894             unsafe { ptr::addr_of_mut!((*ptr).data) }
1895         }
1896     }
1897
1898     /// Consumes the `Weak<T>` and turns it into a raw pointer.
1899     ///
1900     /// This converts the weak pointer into a raw pointer, while still preserving the ownership of
1901     /// one weak reference (the weak count is not modified by this operation). It can be turned
1902     /// back into the `Weak<T>` with [`from_raw`].
1903     ///
1904     /// The same restrictions of accessing the target of the pointer as with
1905     /// [`as_ptr`] apply.
1906     ///
1907     /// # Examples
1908     ///
1909     /// ```
1910     /// use std::sync::{Arc, Weak};
1911     ///
1912     /// let strong = Arc::new("hello".to_owned());
1913     /// let weak = Arc::downgrade(&strong);
1914     /// let raw = weak.into_raw();
1915     ///
1916     /// assert_eq!(1, Arc::weak_count(&strong));
1917     /// assert_eq!("hello", unsafe { &*raw });
1918     ///
1919     /// drop(unsafe { Weak::from_raw(raw) });
1920     /// assert_eq!(0, Arc::weak_count(&strong));
1921     /// ```
1922     ///
1923     /// [`from_raw`]: Weak::from_raw
1924     /// [`as_ptr`]: Weak::as_ptr
1925     #[must_use = "`self` will be dropped if the result is not used"]
1926     #[stable(feature = "weak_into_raw", since = "1.45.0")]
1927     pub fn into_raw(self) -> *const T {
1928         let result = self.as_ptr();
1929         mem::forget(self);
1930         result
1931     }
1932
1933     /// Converts a raw pointer previously created by [`into_raw`] back into `Weak<T>`.
1934     ///
1935     /// This can be used to safely get a strong reference (by calling [`upgrade`]
1936     /// later) or to deallocate the weak count by dropping the `Weak<T>`.
1937     ///
1938     /// It takes ownership of one weak reference (with the exception of pointers created by [`new`],
1939     /// as these don't own anything; the method still works on them).
1940     ///
1941     /// # Safety
1942     ///
1943     /// The pointer must have originated from the [`into_raw`] and must still own its potential
1944     /// weak reference.
1945     ///
1946     /// It is allowed for the strong count to be 0 at the time of calling this. Nevertheless, this
1947     /// takes ownership of one weak reference currently represented as a raw pointer (the weak
1948     /// count is not modified by this operation) and therefore it must be paired with a previous
1949     /// call to [`into_raw`].
1950     /// # Examples
1951     ///
1952     /// ```
1953     /// use std::sync::{Arc, Weak};
1954     ///
1955     /// let strong = Arc::new("hello".to_owned());
1956     ///
1957     /// let raw_1 = Arc::downgrade(&strong).into_raw();
1958     /// let raw_2 = Arc::downgrade(&strong).into_raw();
1959     ///
1960     /// assert_eq!(2, Arc::weak_count(&strong));
1961     ///
1962     /// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
1963     /// assert_eq!(1, Arc::weak_count(&strong));
1964     ///
1965     /// drop(strong);
1966     ///
1967     /// // Decrement the last weak count.
1968     /// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
1969     /// ```
1970     ///
1971     /// [`new`]: Weak::new
1972     /// [`into_raw`]: Weak::into_raw
1973     /// [`upgrade`]: Weak::upgrade
1974     #[stable(feature = "weak_into_raw", since = "1.45.0")]
1975     pub unsafe fn from_raw(ptr: *const T) -> Self {
1976         // See Weak::as_ptr for context on how the input pointer is derived.
1977
1978         let ptr = if is_dangling(ptr as *mut T) {
1979             // This is a dangling Weak.
1980             ptr as *mut ArcInner<T>
1981         } else {
1982             // Otherwise, we're guaranteed the pointer came from a nondangling Weak.
1983             // SAFETY: data_offset is safe to call, as ptr references a real (potentially dropped) T.
1984             let offset = unsafe { data_offset(ptr) };
1985             // Thus, we reverse the offset to get the whole RcBox.
1986             // SAFETY: the pointer originated from a Weak, so this offset is safe.
1987             unsafe { ptr.byte_sub(offset) as *mut ArcInner<T> }
1988         };
1989
1990         // SAFETY: we now have recovered the original Weak pointer, so can create the Weak.
1991         Weak { ptr: unsafe { NonNull::new_unchecked(ptr) } }
1992     }
1993 }
1994
1995 impl<T: ?Sized> Weak<T> {
1996     /// Attempts to upgrade the `Weak` pointer to an [`Arc`], delaying
1997     /// dropping of the inner value if successful.
1998     ///
1999     /// Returns [`None`] if the inner value has since been dropped.
2000     ///
2001     /// # Examples
2002     ///
2003     /// ```
2004     /// use std::sync::Arc;
2005     ///
2006     /// let five = Arc::new(5);
2007     ///
2008     /// let weak_five = Arc::downgrade(&five);
2009     ///
2010     /// let strong_five: Option<Arc<_>> = weak_five.upgrade();
2011     /// assert!(strong_five.is_some());
2012     ///
2013     /// // Destroy all strong pointers.
2014     /// drop(strong_five);
2015     /// drop(five);
2016     ///
2017     /// assert!(weak_five.upgrade().is_none());
2018     /// ```
2019     #[must_use = "this returns a new `Arc`, \
2020                   without modifying the original weak pointer"]
2021     #[stable(feature = "arc_weak", since = "1.4.0")]
2022     pub fn upgrade(&self) -> Option<Arc<T>> {
2023         // We use a CAS loop to increment the strong count instead of a
2024         // fetch_add as this function should never take the reference count
2025         // from zero to one.
2026         self.inner()?
2027             .strong
2028             // Relaxed is fine for the failure case because we don't have any expectations about the new state.
2029             // Acquire is necessary for the success case to synchronise with `Arc::new_cyclic`, when the inner
2030             // value can be initialized after `Weak` references have already been created. In that case, we
2031             // expect to observe the fully initialized value.
2032             .fetch_update(Acquire, Relaxed, |n| {
2033                 // Any write of 0 we can observe leaves the field in permanently zero state.
2034                 if n == 0 {
2035                     return None;
2036                 }
2037                 // See comments in `Arc::clone` for why we do this (for `mem::forget`).
2038                 if n > MAX_REFCOUNT {
2039                     abort();
2040                 }
2041                 Some(n + 1)
2042             })
2043             .ok()
2044             // null checked above
2045             .map(|_| unsafe { Arc::from_inner(self.ptr) })
2046     }
2047
2048     /// Gets the number of strong (`Arc`) pointers pointing to this allocation.
2049     ///
2050     /// If `self` was created using [`Weak::new`], this will return 0.
2051     #[must_use]
2052     #[stable(feature = "weak_counts", since = "1.41.0")]
2053     pub fn strong_count(&self) -> usize {
2054         if let Some(inner) = self.inner() { inner.strong.load(Acquire) } else { 0 }
2055     }
2056
2057     /// Gets an approximation of the number of `Weak` pointers pointing to this
2058     /// allocation.
2059     ///
2060     /// If `self` was created using [`Weak::new`], or if there are no remaining
2061     /// strong pointers, this will return 0.
2062     ///
2063     /// # Accuracy
2064     ///
2065     /// Due to implementation details, the returned value can be off by 1 in
2066     /// either direction when other threads are manipulating any `Arc`s or
2067     /// `Weak`s pointing to the same allocation.
2068     #[must_use]
2069     #[stable(feature = "weak_counts", since = "1.41.0")]
2070     pub fn weak_count(&self) -> usize {
2071         self.inner()
2072             .map(|inner| {
2073                 let weak = inner.weak.load(Acquire);
2074                 let strong = inner.strong.load(Acquire);
2075                 if strong == 0 {
2076                     0
2077                 } else {
2078                     // Since we observed that there was at least one strong pointer
2079                     // after reading the weak count, we know that the implicit weak
2080                     // reference (present whenever any strong references are alive)
2081                     // was still around when we observed the weak count, and can
2082                     // therefore safely subtract it.
2083                     weak - 1
2084                 }
2085             })
2086             .unwrap_or(0)
2087     }
2088
2089     /// Returns `None` when the pointer is dangling and there is no allocated `ArcInner`,
2090     /// (i.e., when this `Weak` was created by `Weak::new`).
2091     #[inline]
2092     fn inner(&self) -> Option<WeakInner<'_>> {
2093         if is_dangling(self.ptr.as_ptr()) {
2094             None
2095         } else {
2096             // We are careful to *not* create a reference covering the "data" field, as
2097             // the field may be mutated concurrently (for example, if the last `Arc`
2098             // is dropped, the data field will be dropped in-place).
2099             Some(unsafe {
2100                 let ptr = self.ptr.as_ptr();
2101                 WeakInner { strong: &(*ptr).strong, weak: &(*ptr).weak }
2102             })
2103         }
2104     }
2105
2106     /// Returns `true` if the two `Weak`s point to the same allocation similar to [`ptr::eq`], or if
2107     /// both don't point to any allocation (because they were created with `Weak::new()`). See [that
2108     /// function][`ptr::eq`] for caveats when comparing `dyn Trait` pointers.
2109     ///
2110     /// # Notes
2111     ///
2112     /// Since this compares pointers it means that `Weak::new()` will equal each
2113     /// other, even though they don't point to any allocation.
2114     ///
2115     /// # Examples
2116     ///
2117     /// ```
2118     /// use std::sync::Arc;
2119     ///
2120     /// let first_rc = Arc::new(5);
2121     /// let first = Arc::downgrade(&first_rc);
2122     /// let second = Arc::downgrade(&first_rc);
2123     ///
2124     /// assert!(first.ptr_eq(&second));
2125     ///
2126     /// let third_rc = Arc::new(5);
2127     /// let third = Arc::downgrade(&third_rc);
2128     ///
2129     /// assert!(!first.ptr_eq(&third));
2130     /// ```
2131     ///
2132     /// Comparing `Weak::new`.
2133     ///
2134     /// ```
2135     /// use std::sync::{Arc, Weak};
2136     ///
2137     /// let first = Weak::new();
2138     /// let second = Weak::new();
2139     /// assert!(first.ptr_eq(&second));
2140     ///
2141     /// let third_rc = Arc::new(());
2142     /// let third = Arc::downgrade(&third_rc);
2143     /// assert!(!first.ptr_eq(&third));
2144     /// ```
2145     ///
2146     /// [`ptr::eq`]: core::ptr::eq "ptr::eq"
2147     #[inline]
2148     #[must_use]
2149     #[stable(feature = "weak_ptr_eq", since = "1.39.0")]
2150     pub fn ptr_eq(&self, other: &Self) -> bool {
2151         self.ptr.as_ptr() == other.ptr.as_ptr()
2152     }
2153 }
2154
2155 #[stable(feature = "arc_weak", since = "1.4.0")]
2156 impl<T: ?Sized> Clone for Weak<T> {
2157     /// Makes a clone of the `Weak` pointer that points to the same allocation.
2158     ///
2159     /// # Examples
2160     ///
2161     /// ```
2162     /// use std::sync::{Arc, Weak};
2163     ///
2164     /// let weak_five = Arc::downgrade(&Arc::new(5));
2165     ///
2166     /// let _ = Weak::clone(&weak_five);
2167     /// ```
2168     #[inline]
2169     fn clone(&self) -> Weak<T> {
2170         let inner = if let Some(inner) = self.inner() {
2171             inner
2172         } else {
2173             return Weak { ptr: self.ptr };
2174         };
2175         // See comments in Arc::clone() for why this is relaxed.  This can use a
2176         // fetch_add (ignoring the lock) because the weak count is only locked
2177         // where are *no other* weak pointers in existence. (So we can't be
2178         // running this code in that case).
2179         let old_size = inner.weak.fetch_add(1, Relaxed);
2180
2181         // See comments in Arc::clone() for why we do this (for mem::forget).
2182         if old_size > MAX_REFCOUNT {
2183             abort();
2184         }
2185
2186         Weak { ptr: self.ptr }
2187     }
2188 }
2189
2190 #[stable(feature = "downgraded_weak", since = "1.10.0")]
2191 impl<T> Default for Weak<T> {
2192     /// Constructs a new `Weak<T>`, without allocating memory.
2193     /// Calling [`upgrade`] on the return value always
2194     /// gives [`None`].
2195     ///
2196     /// [`upgrade`]: Weak::upgrade
2197     ///
2198     /// # Examples
2199     ///
2200     /// ```
2201     /// use std::sync::Weak;
2202     ///
2203     /// let empty: Weak<i64> = Default::default();
2204     /// assert!(empty.upgrade().is_none());
2205     /// ```
2206     fn default() -> Weak<T> {
2207         Weak::new()
2208     }
2209 }
2210
2211 #[stable(feature = "arc_weak", since = "1.4.0")]
2212 unsafe impl<#[may_dangle] T: ?Sized> Drop for Weak<T> {
2213     /// Drops the `Weak` pointer.
2214     ///
2215     /// # Examples
2216     ///
2217     /// ```
2218     /// use std::sync::{Arc, Weak};
2219     ///
2220     /// struct Foo;
2221     ///
2222     /// impl Drop for Foo {
2223     ///     fn drop(&mut self) {
2224     ///         println!("dropped!");
2225     ///     }
2226     /// }
2227     ///
2228     /// let foo = Arc::new(Foo);
2229     /// let weak_foo = Arc::downgrade(&foo);
2230     /// let other_weak_foo = Weak::clone(&weak_foo);
2231     ///
2232     /// drop(weak_foo);   // Doesn't print anything
2233     /// drop(foo);        // Prints "dropped!"
2234     ///
2235     /// assert!(other_weak_foo.upgrade().is_none());
2236     /// ```
2237     fn drop(&mut self) {
2238         // If we find out that we were the last weak pointer, then its time to
2239         // deallocate the data entirely. See the discussion in Arc::drop() about
2240         // the memory orderings
2241         //
2242         // It's not necessary to check for the locked state here, because the
2243         // weak count can only be locked if there was precisely one weak ref,
2244         // meaning that drop could only subsequently run ON that remaining weak
2245         // ref, which can only happen after the lock is released.
2246         let inner = if let Some(inner) = self.inner() { inner } else { return };
2247
2248         if inner.weak.fetch_sub(1, Release) == 1 {
2249             acquire!(inner.weak);
2250             unsafe { Global.deallocate(self.ptr.cast(), Layout::for_value_raw(self.ptr.as_ptr())) }
2251         }
2252     }
2253 }
2254
2255 #[stable(feature = "rust1", since = "1.0.0")]
2256 trait ArcEqIdent<T: ?Sized + PartialEq> {
2257     fn eq(&self, other: &Arc<T>) -> bool;
2258     fn ne(&self, other: &Arc<T>) -> bool;
2259 }
2260
2261 #[stable(feature = "rust1", since = "1.0.0")]
2262 impl<T: ?Sized + PartialEq> ArcEqIdent<T> for Arc<T> {
2263     #[inline]
2264     default fn eq(&self, other: &Arc<T>) -> bool {
2265         **self == **other
2266     }
2267     #[inline]
2268     default fn ne(&self, other: &Arc<T>) -> bool {
2269         **self != **other
2270     }
2271 }
2272
2273 /// We're doing this specialization here, and not as a more general optimization on `&T`, because it
2274 /// would otherwise add a cost to all equality checks on refs. We assume that `Arc`s are used to
2275 /// store large values, that are slow to clone, but also heavy to check for equality, causing this
2276 /// cost to pay off more easily. It's also more likely to have two `Arc` clones, that point to
2277 /// the same value, than two `&T`s.
2278 ///
2279 /// We can only do this when `T: Eq` as a `PartialEq` might be deliberately irreflexive.
2280 #[stable(feature = "rust1", since = "1.0.0")]
2281 impl<T: ?Sized + crate::rc::MarkerEq> ArcEqIdent<T> for Arc<T> {
2282     #[inline]
2283     fn eq(&self, other: &Arc<T>) -> bool {
2284         Arc::ptr_eq(self, other) || **self == **other
2285     }
2286
2287     #[inline]
2288     fn ne(&self, other: &Arc<T>) -> bool {
2289         !Arc::ptr_eq(self, other) && **self != **other
2290     }
2291 }
2292
2293 #[stable(feature = "rust1", since = "1.0.0")]
2294 impl<T: ?Sized + PartialEq> PartialEq for Arc<T> {
2295     /// Equality for two `Arc`s.
2296     ///
2297     /// Two `Arc`s are equal if their inner values are equal, even if they are
2298     /// stored in different allocation.
2299     ///
2300     /// If `T` also implements `Eq` (implying reflexivity of equality),
2301     /// two `Arc`s that point to the same allocation are always equal.
2302     ///
2303     /// # Examples
2304     ///
2305     /// ```
2306     /// use std::sync::Arc;
2307     ///
2308     /// let five = Arc::new(5);
2309     ///
2310     /// assert!(five == Arc::new(5));
2311     /// ```
2312     #[inline]
2313     fn eq(&self, other: &Arc<T>) -> bool {
2314         ArcEqIdent::eq(self, other)
2315     }
2316
2317     /// Inequality for two `Arc`s.
2318     ///
2319     /// Two `Arc`s are unequal if their inner values are unequal.
2320     ///
2321     /// If `T` also implements `Eq` (implying reflexivity of equality),
2322     /// two `Arc`s that point to the same value are never unequal.
2323     ///
2324     /// # Examples
2325     ///
2326     /// ```
2327     /// use std::sync::Arc;
2328     ///
2329     /// let five = Arc::new(5);
2330     ///
2331     /// assert!(five != Arc::new(6));
2332     /// ```
2333     #[inline]
2334     fn ne(&self, other: &Arc<T>) -> bool {
2335         ArcEqIdent::ne(self, other)
2336     }
2337 }
2338
2339 #[stable(feature = "rust1", since = "1.0.0")]
2340 impl<T: ?Sized + PartialOrd> PartialOrd for Arc<T> {
2341     /// Partial comparison for two `Arc`s.
2342     ///
2343     /// The two are compared by calling `partial_cmp()` on their inner values.
2344     ///
2345     /// # Examples
2346     ///
2347     /// ```
2348     /// use std::sync::Arc;
2349     /// use std::cmp::Ordering;
2350     ///
2351     /// let five = Arc::new(5);
2352     ///
2353     /// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Arc::new(6)));
2354     /// ```
2355     fn partial_cmp(&self, other: &Arc<T>) -> Option<Ordering> {
2356         (**self).partial_cmp(&**other)
2357     }
2358
2359     /// Less-than comparison for two `Arc`s.
2360     ///
2361     /// The two are compared by calling `<` on their inner values.
2362     ///
2363     /// # Examples
2364     ///
2365     /// ```
2366     /// use std::sync::Arc;
2367     ///
2368     /// let five = Arc::new(5);
2369     ///
2370     /// assert!(five < Arc::new(6));
2371     /// ```
2372     fn lt(&self, other: &Arc<T>) -> bool {
2373         *(*self) < *(*other)
2374     }
2375
2376     /// 'Less than or equal to' comparison for two `Arc`s.
2377     ///
2378     /// The two are compared by calling `<=` on their inner values.
2379     ///
2380     /// # Examples
2381     ///
2382     /// ```
2383     /// use std::sync::Arc;
2384     ///
2385     /// let five = Arc::new(5);
2386     ///
2387     /// assert!(five <= Arc::new(5));
2388     /// ```
2389     fn le(&self, other: &Arc<T>) -> bool {
2390         *(*self) <= *(*other)
2391     }
2392
2393     /// Greater-than comparison for two `Arc`s.
2394     ///
2395     /// The two are compared by calling `>` on their inner values.
2396     ///
2397     /// # Examples
2398     ///
2399     /// ```
2400     /// use std::sync::Arc;
2401     ///
2402     /// let five = Arc::new(5);
2403     ///
2404     /// assert!(five > Arc::new(4));
2405     /// ```
2406     fn gt(&self, other: &Arc<T>) -> bool {
2407         *(*self) > *(*other)
2408     }
2409
2410     /// 'Greater than or equal to' comparison for two `Arc`s.
2411     ///
2412     /// The two are compared by calling `>=` on their inner values.
2413     ///
2414     /// # Examples
2415     ///
2416     /// ```
2417     /// use std::sync::Arc;
2418     ///
2419     /// let five = Arc::new(5);
2420     ///
2421     /// assert!(five >= Arc::new(5));
2422     /// ```
2423     fn ge(&self, other: &Arc<T>) -> bool {
2424         *(*self) >= *(*other)
2425     }
2426 }
2427 #[stable(feature = "rust1", since = "1.0.0")]
2428 impl<T: ?Sized + Ord> Ord for Arc<T> {
2429     /// Comparison for two `Arc`s.
2430     ///
2431     /// The two are compared by calling `cmp()` on their inner values.
2432     ///
2433     /// # Examples
2434     ///
2435     /// ```
2436     /// use std::sync::Arc;
2437     /// use std::cmp::Ordering;
2438     ///
2439     /// let five = Arc::new(5);
2440     ///
2441     /// assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));
2442     /// ```
2443     fn cmp(&self, other: &Arc<T>) -> Ordering {
2444         (**self).cmp(&**other)
2445     }
2446 }
2447 #[stable(feature = "rust1", since = "1.0.0")]
2448 impl<T: ?Sized + Eq> Eq for Arc<T> {}
2449
2450 #[stable(feature = "rust1", since = "1.0.0")]
2451 impl<T: ?Sized + fmt::Display> fmt::Display for Arc<T> {
2452     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2453         fmt::Display::fmt(&**self, f)
2454     }
2455 }
2456
2457 #[stable(feature = "rust1", since = "1.0.0")]
2458 impl<T: ?Sized + fmt::Debug> fmt::Debug for Arc<T> {
2459     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2460         fmt::Debug::fmt(&**self, f)
2461     }
2462 }
2463
2464 #[stable(feature = "rust1", since = "1.0.0")]
2465 impl<T: ?Sized> fmt::Pointer for Arc<T> {
2466     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2467         fmt::Pointer::fmt(&(&**self as *const T), f)
2468     }
2469 }
2470
2471 #[cfg(not(no_global_oom_handling))]
2472 #[stable(feature = "rust1", since = "1.0.0")]
2473 impl<T: Default> Default for Arc<T> {
2474     /// Creates a new `Arc<T>`, with the `Default` value for `T`.
2475     ///
2476     /// # Examples
2477     ///
2478     /// ```
2479     /// use std::sync::Arc;
2480     ///
2481     /// let x: Arc<i32> = Default::default();
2482     /// assert_eq!(*x, 0);
2483     /// ```
2484     fn default() -> Arc<T> {
2485         Arc::new(Default::default())
2486     }
2487 }
2488
2489 #[stable(feature = "rust1", since = "1.0.0")]
2490 impl<T: ?Sized + Hash> Hash for Arc<T> {
2491     fn hash<H: Hasher>(&self, state: &mut H) {
2492         (**self).hash(state)
2493     }
2494 }
2495
2496 #[cfg(not(no_global_oom_handling))]
2497 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
2498 impl<T> From<T> for Arc<T> {
2499     /// Converts a `T` into an `Arc<T>`
2500     ///
2501     /// The conversion moves the value into a
2502     /// newly allocated `Arc`. It is equivalent to
2503     /// calling `Arc::new(t)`.
2504     ///
2505     /// # Example
2506     /// ```rust
2507     /// # use std::sync::Arc;
2508     /// let x = 5;
2509     /// let arc = Arc::new(5);
2510     ///
2511     /// assert_eq!(Arc::from(x), arc);
2512     /// ```
2513     fn from(t: T) -> Self {
2514         Arc::new(t)
2515     }
2516 }
2517
2518 #[cfg(not(no_global_oom_handling))]
2519 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2520 impl<T: Clone> From<&[T]> for Arc<[T]> {
2521     /// Allocate a reference-counted slice and fill it by cloning `v`'s items.
2522     ///
2523     /// # Example
2524     ///
2525     /// ```
2526     /// # use std::sync::Arc;
2527     /// let original: &[i32] = &[1, 2, 3];
2528     /// let shared: Arc<[i32]> = Arc::from(original);
2529     /// assert_eq!(&[1, 2, 3], &shared[..]);
2530     /// ```
2531     #[inline]
2532     fn from(v: &[T]) -> Arc<[T]> {
2533         <Self as ArcFromSlice<T>>::from_slice(v)
2534     }
2535 }
2536
2537 #[cfg(not(no_global_oom_handling))]
2538 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2539 impl From<&str> for Arc<str> {
2540     /// Allocate a reference-counted `str` and copy `v` into it.
2541     ///
2542     /// # Example
2543     ///
2544     /// ```
2545     /// # use std::sync::Arc;
2546     /// let shared: Arc<str> = Arc::from("eggplant");
2547     /// assert_eq!("eggplant", &shared[..]);
2548     /// ```
2549     #[inline]
2550     fn from(v: &str) -> Arc<str> {
2551         let arc = Arc::<[u8]>::from(v.as_bytes());
2552         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const str) }
2553     }
2554 }
2555
2556 #[cfg(not(no_global_oom_handling))]
2557 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2558 impl From<String> for Arc<str> {
2559     /// Allocate a reference-counted `str` and copy `v` into it.
2560     ///
2561     /// # Example
2562     ///
2563     /// ```
2564     /// # use std::sync::Arc;
2565     /// let unique: String = "eggplant".to_owned();
2566     /// let shared: Arc<str> = Arc::from(unique);
2567     /// assert_eq!("eggplant", &shared[..]);
2568     /// ```
2569     #[inline]
2570     fn from(v: String) -> Arc<str> {
2571         Arc::from(&v[..])
2572     }
2573 }
2574
2575 #[cfg(not(no_global_oom_handling))]
2576 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2577 impl<T: ?Sized> From<Box<T>> for Arc<T> {
2578     /// Move a boxed object to a new, reference-counted allocation.
2579     ///
2580     /// # Example
2581     ///
2582     /// ```
2583     /// # use std::sync::Arc;
2584     /// let unique: Box<str> = Box::from("eggplant");
2585     /// let shared: Arc<str> = Arc::from(unique);
2586     /// assert_eq!("eggplant", &shared[..]);
2587     /// ```
2588     #[inline]
2589     fn from(v: Box<T>) -> Arc<T> {
2590         Arc::from_box(v)
2591     }
2592 }
2593
2594 #[cfg(not(no_global_oom_handling))]
2595 #[stable(feature = "shared_from_slice", since = "1.21.0")]
2596 impl<T> From<Vec<T>> for Arc<[T]> {
2597     /// Allocate a reference-counted slice and move `v`'s items into it.
2598     ///
2599     /// # Example
2600     ///
2601     /// ```
2602     /// # use std::sync::Arc;
2603     /// let unique: Vec<i32> = vec![1, 2, 3];
2604     /// let shared: Arc<[i32]> = Arc::from(unique);
2605     /// assert_eq!(&[1, 2, 3], &shared[..]);
2606     /// ```
2607     #[inline]
2608     fn from(mut v: Vec<T>) -> Arc<[T]> {
2609         unsafe {
2610             let rc = Arc::copy_from_slice(&v);
2611             // Allow the Vec to free its memory, but not destroy its contents
2612             v.set_len(0);
2613             rc
2614         }
2615     }
2616 }
2617
2618 #[stable(feature = "shared_from_cow", since = "1.45.0")]
2619 impl<'a, B> From<Cow<'a, B>> for Arc<B>
2620 where
2621     B: ToOwned + ?Sized,
2622     Arc<B>: From<&'a B> + From<B::Owned>,
2623 {
2624     /// Create an atomically reference-counted pointer from
2625     /// a clone-on-write pointer by copying its content.
2626     ///
2627     /// # Example
2628     ///
2629     /// ```rust
2630     /// # use std::sync::Arc;
2631     /// # use std::borrow::Cow;
2632     /// let cow: Cow<str> = Cow::Borrowed("eggplant");
2633     /// let shared: Arc<str> = Arc::from(cow);
2634     /// assert_eq!("eggplant", &shared[..]);
2635     /// ```
2636     #[inline]
2637     fn from(cow: Cow<'a, B>) -> Arc<B> {
2638         match cow {
2639             Cow::Borrowed(s) => Arc::from(s),
2640             Cow::Owned(s) => Arc::from(s),
2641         }
2642     }
2643 }
2644
2645 #[stable(feature = "shared_from_str", since = "1.62.0")]
2646 impl From<Arc<str>> for Arc<[u8]> {
2647     /// Converts an atomically reference-counted string slice into a byte slice.
2648     ///
2649     /// # Example
2650     ///
2651     /// ```
2652     /// # use std::sync::Arc;
2653     /// let string: Arc<str> = Arc::from("eggplant");
2654     /// let bytes: Arc<[u8]> = Arc::from(string);
2655     /// assert_eq!("eggplant".as_bytes(), bytes.as_ref());
2656     /// ```
2657     #[inline]
2658     fn from(rc: Arc<str>) -> Self {
2659         // SAFETY: `str` has the same layout as `[u8]`.
2660         unsafe { Arc::from_raw(Arc::into_raw(rc) as *const [u8]) }
2661     }
2662 }
2663
2664 #[stable(feature = "boxed_slice_try_from", since = "1.43.0")]
2665 impl<T, const N: usize> TryFrom<Arc<[T]>> for Arc<[T; N]> {
2666     type Error = Arc<[T]>;
2667
2668     fn try_from(boxed_slice: Arc<[T]>) -> Result<Self, Self::Error> {
2669         if boxed_slice.len() == N {
2670             Ok(unsafe { Arc::from_raw(Arc::into_raw(boxed_slice) as *mut [T; N]) })
2671         } else {
2672             Err(boxed_slice)
2673         }
2674     }
2675 }
2676
2677 #[cfg(not(no_global_oom_handling))]
2678 #[stable(feature = "shared_from_iter", since = "1.37.0")]
2679 impl<T> iter::FromIterator<T> for Arc<[T]> {
2680     /// Takes each element in the `Iterator` and collects it into an `Arc<[T]>`.
2681     ///
2682     /// # Performance characteristics
2683     ///
2684     /// ## The general case
2685     ///
2686     /// In the general case, collecting into `Arc<[T]>` is done by first
2687     /// collecting into a `Vec<T>`. That is, when writing the following:
2688     ///
2689     /// ```rust
2690     /// # use std::sync::Arc;
2691     /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
2692     /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2693     /// ```
2694     ///
2695     /// this behaves as if we wrote:
2696     ///
2697     /// ```rust
2698     /// # use std::sync::Arc;
2699     /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
2700     ///     .collect::<Vec<_>>() // The first set of allocations happens here.
2701     ///     .into(); // A second allocation for `Arc<[T]>` happens here.
2702     /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2703     /// ```
2704     ///
2705     /// This will allocate as many times as needed for constructing the `Vec<T>`
2706     /// and then it will allocate once for turning the `Vec<T>` into the `Arc<[T]>`.
2707     ///
2708     /// ## Iterators of known length
2709     ///
2710     /// When your `Iterator` implements `TrustedLen` and is of an exact size,
2711     /// a single allocation will be made for the `Arc<[T]>`. For example:
2712     ///
2713     /// ```rust
2714     /// # use std::sync::Arc;
2715     /// let evens: Arc<[u8]> = (0..10).collect(); // Just a single allocation happens here.
2716     /// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
2717     /// ```
2718     fn from_iter<I: iter::IntoIterator<Item = T>>(iter: I) -> Self {
2719         ToArcSlice::to_arc_slice(iter.into_iter())
2720     }
2721 }
2722
2723 /// Specialization trait used for collecting into `Arc<[T]>`.
2724 trait ToArcSlice<T>: Iterator<Item = T> + Sized {
2725     fn to_arc_slice(self) -> Arc<[T]>;
2726 }
2727
2728 #[cfg(not(no_global_oom_handling))]
2729 impl<T, I: Iterator<Item = T>> ToArcSlice<T> for I {
2730     default fn to_arc_slice(self) -> Arc<[T]> {
2731         self.collect::<Vec<T>>().into()
2732     }
2733 }
2734
2735 #[cfg(not(no_global_oom_handling))]
2736 impl<T, I: iter::TrustedLen<Item = T>> ToArcSlice<T> for I {
2737     fn to_arc_slice(self) -> Arc<[T]> {
2738         // This is the case for a `TrustedLen` iterator.
2739         let (low, high) = self.size_hint();
2740         if let Some(high) = high {
2741             debug_assert_eq!(
2742                 low,
2743                 high,
2744                 "TrustedLen iterator's size hint is not exact: {:?}",
2745                 (low, high)
2746             );
2747
2748             unsafe {
2749                 // SAFETY: We need to ensure that the iterator has an exact length and we have.
2750                 Arc::from_iter_exact(self, low)
2751             }
2752         } else {
2753             // TrustedLen contract guarantees that `upper_bound == `None` implies an iterator
2754             // length exceeding `usize::MAX`.
2755             // The default implementation would collect into a vec which would panic.
2756             // Thus we panic here immediately without invoking `Vec` code.
2757             panic!("capacity overflow");
2758         }
2759     }
2760 }
2761
2762 #[stable(feature = "rust1", since = "1.0.0")]
2763 impl<T: ?Sized> borrow::Borrow<T> for Arc<T> {
2764     fn borrow(&self) -> &T {
2765         &**self
2766     }
2767 }
2768
2769 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
2770 impl<T: ?Sized> AsRef<T> for Arc<T> {
2771     fn as_ref(&self) -> &T {
2772         &**self
2773     }
2774 }
2775
2776 #[stable(feature = "pin", since = "1.33.0")]
2777 impl<T: ?Sized> Unpin for Arc<T> {}
2778
2779 /// Get the offset within an `ArcInner` for the payload behind a pointer.
2780 ///
2781 /// # Safety
2782 ///
2783 /// The pointer must point to (and have valid metadata for) a previously
2784 /// valid instance of T, but the T is allowed to be dropped.
2785 unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> usize {
2786     // Align the unsized value to the end of the ArcInner.
2787     // Because RcBox is repr(C), it will always be the last field in memory.
2788     // SAFETY: since the only unsized types possible are slices, trait objects,
2789     // and extern types, the input safety requirement is currently enough to
2790     // satisfy the requirements of align_of_val_raw; this is an implementation
2791     // detail of the language that must not be relied upon outside of std.
2792     unsafe { data_offset_align(align_of_val_raw(ptr)) }
2793 }
2794
2795 #[inline]
2796 fn data_offset_align(align: usize) -> usize {
2797     let layout = Layout::new::<ArcInner<()>>();
2798     layout.size() + layout.padding_needed_for(align)
2799 }
2800
2801 #[stable(feature = "arc_error", since = "1.52.0")]
2802 impl<T: core::error::Error + ?Sized> core::error::Error for Arc<T> {
2803     #[allow(deprecated, deprecated_in_future)]
2804     fn description(&self) -> &str {
2805         core::error::Error::description(&**self)
2806     }
2807
2808     #[allow(deprecated)]
2809     fn cause(&self) -> Option<&dyn core::error::Error> {
2810         core::error::Error::cause(&**self)
2811     }
2812
2813     fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
2814         core::error::Error::source(&**self)
2815     }
2816
2817     fn provide<'a>(&'a self, req: &mut core::any::Demand<'a>) {
2818         core::error::Error::provide(&**self, req);
2819     }
2820 }