]> git.lizzy.rs Git - rust.git/blob - src/liballoc/sync.rs
Ammend Rc/Arc::from_raw() docs regarding unsafety
[rust.git] / src / liballoc / 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 //! [arc]: struct.Arc.html
8
9 use core::any::Any;
10 use core::array::LengthAtMost32;
11 use core::borrow;
12 use core::cmp::Ordering;
13 use core::convert::{From, TryFrom};
14 use core::fmt;
15 use core::hash::{Hash, Hasher};
16 use core::intrinsics::abort;
17 use core::iter;
18 use core::marker::{PhantomData, Unpin, Unsize};
19 use core::mem::{self, align_of, align_of_val, size_of_val};
20 use core::ops::{CoerceUnsized, Deref, DispatchFromDyn, Receiver};
21 use core::pin::Pin;
22 use core::ptr::{self, NonNull};
23 use core::slice::{self, from_raw_parts_mut};
24 use core::sync::atomic;
25 use core::sync::atomic::Ordering::{Acquire, Relaxed, Release, SeqCst};
26 use core::{isize, usize};
27
28 use crate::alloc::{box_free, handle_alloc_error, Alloc, Global, Layout};
29 use crate::boxed::Box;
30 use crate::rc::is_dangling;
31 use crate::string::String;
32 use crate::vec::Vec;
33
34 #[cfg(test)]
35 mod tests;
36
37 /// A soft limit on the amount of references that may be made to an `Arc`.
38 ///
39 /// Going above this limit will abort your program (although not
40 /// necessarily) at _exactly_ `MAX_REFCOUNT + 1` references.
41 const MAX_REFCOUNT: usize = (isize::MAX) as usize;
42
43 /// A thread-safe reference-counting pointer. 'Arc' stands for 'Atomically
44 /// Reference Counted'.
45 ///
46 /// The type `Arc<T>` provides shared ownership of a value of type `T`,
47 /// allocated in the heap. Invoking [`clone`][clone] on `Arc` produces
48 /// a new `Arc` instance, which points to the same allocation on the heap as the
49 /// source `Arc`, while increasing a reference count. When the last `Arc`
50 /// pointer to a given allocation is destroyed, the value stored in that allocation (often
51 /// referred to as "inner value") is also dropped.
52 ///
53 /// Shared references in Rust disallow mutation by default, and `Arc` is no
54 /// exception: you cannot generally obtain a mutable reference to something
55 /// inside an `Arc`. If you need to mutate through an `Arc`, use
56 /// [`Mutex`][mutex], [`RwLock`][rwlock], or one of the [`Atomic`][atomic]
57 /// types.
58 ///
59 /// ## Thread Safety
60 ///
61 /// Unlike [`Rc<T>`], `Arc<T>` uses atomic operations for its reference
62 /// counting. This means that it is thread-safe. The disadvantage is that
63 /// atomic operations are more expensive than ordinary memory accesses. If you
64 /// are not sharing reference-counted allocations between threads, consider using
65 /// [`Rc<T>`] for lower overhead. [`Rc<T>`] is a safe default, because the
66 /// compiler will catch any attempt to send an [`Rc<T>`] between threads.
67 /// However, a library might choose `Arc<T>` in order to give library consumers
68 /// more flexibility.
69 ///
70 /// `Arc<T>` will implement [`Send`] and [`Sync`] as long as the `T` implements
71 /// [`Send`] and [`Sync`]. Why can't you put a non-thread-safe type `T` in an
72 /// `Arc<T>` to make it thread-safe? This may be a bit counter-intuitive at
73 /// first: after all, isn't the point of `Arc<T>` thread safety? The key is
74 /// this: `Arc<T>` makes it thread safe to have multiple ownership of the same
75 /// data, but it  doesn't add thread safety to its data. Consider
76 /// `Arc<`[`RefCell<T>`]`>`. [`RefCell<T>`] isn't [`Sync`], and if `Arc<T>` was always
77 /// [`Send`], `Arc<`[`RefCell<T>`]`>` would be as well. But then we'd have a problem:
78 /// [`RefCell<T>`] is not thread safe; it keeps track of the borrowing count using
79 /// non-atomic operations.
80 ///
81 /// In the end, this means that you may need to pair `Arc<T>` with some sort of
82 /// [`std::sync`] type, usually [`Mutex<T>`][mutex].
83 ///
84 /// ## Breaking cycles with `Weak`
85 ///
86 /// The [`downgrade`][downgrade] method can be used to create a non-owning
87 /// [`Weak`][weak] pointer. A [`Weak`][weak] pointer can be [`upgrade`][upgrade]d
88 /// to an `Arc`, but this will return [`None`] if the value stored in the allocation has
89 /// already been dropped. In other words, `Weak` pointers do not keep the value
90 /// inside the allocation alive; however, they *do* keep the allocation
91 /// (the backing store for the value) alive.
92 ///
93 /// A cycle between `Arc` pointers will never be deallocated. For this reason,
94 /// [`Weak`][weak] is used to break cycles. For example, a tree could have
95 /// strong `Arc` pointers from parent nodes to children, and [`Weak`][weak]
96 /// pointers from children back to their parents.
97 ///
98 /// # Cloning references
99 ///
100 /// Creating a new reference from an existing reference counted pointer is done using the
101 /// `Clone` trait implemented for [`Arc<T>`][arc] and [`Weak<T>`][weak].
102 ///
103 /// ```
104 /// use std::sync::Arc;
105 /// let foo = Arc::new(vec![1.0, 2.0, 3.0]);
106 /// // The two syntaxes below are equivalent.
107 /// let a = foo.clone();
108 /// let b = Arc::clone(&foo);
109 /// // a, b, and foo are all Arcs that point to the same memory location
110 /// ```
111 ///
112 /// ## `Deref` behavior
113 ///
114 /// `Arc<T>` automatically dereferences to `T` (via the [`Deref`][deref] trait),
115 /// so you can call `T`'s methods on a value of type `Arc<T>`. To avoid name
116 /// clashes with `T`'s methods, the methods of `Arc<T>` itself are associated
117 /// functions, called using function-like syntax:
118 ///
119 /// ```
120 /// use std::sync::Arc;
121 /// let my_arc = Arc::new(());
122 ///
123 /// Arc::downgrade(&my_arc);
124 /// ```
125 ///
126 /// [`Weak<T>`][weak] does not auto-dereference to `T`, because the inner value may have
127 /// already been dropped.
128 ///
129 /// [arc]: struct.Arc.html
130 /// [weak]: struct.Weak.html
131 /// [`Rc<T>`]: ../../std/rc/struct.Rc.html
132 /// [clone]: ../../std/clone/trait.Clone.html#tymethod.clone
133 /// [mutex]: ../../std/sync/struct.Mutex.html
134 /// [rwlock]: ../../std/sync/struct.RwLock.html
135 /// [atomic]: ../../std/sync/atomic/index.html
136 /// [`Send`]: ../../std/marker/trait.Send.html
137 /// [`Sync`]: ../../std/marker/trait.Sync.html
138 /// [deref]: ../../std/ops/trait.Deref.html
139 /// [downgrade]: struct.Arc.html#method.downgrade
140 /// [upgrade]: struct.Weak.html#method.upgrade
141 /// [`None`]: ../../std/option/enum.Option.html#variant.None
142 /// [`RefCell<T>`]: ../../std/cell/struct.RefCell.html
143 /// [`std::sync`]: ../../std/sync/index.html
144 /// [`Arc::clone(&from)`]: #method.clone
145 ///
146 /// # Examples
147 ///
148 /// Sharing some immutable data between threads:
149 ///
150 // Note that we **do not** run these tests here. The windows builders get super
151 // unhappy if a thread outlives the main thread and then exits at the same time
152 // (something deadlocks) so we just avoid this entirely by not running these
153 // tests.
154 /// ```no_run
155 /// use std::sync::Arc;
156 /// use std::thread;
157 ///
158 /// let five = Arc::new(5);
159 ///
160 /// for _ in 0..10 {
161 ///     let five = Arc::clone(&five);
162 ///
163 ///     thread::spawn(move || {
164 ///         println!("{:?}", five);
165 ///     });
166 /// }
167 /// ```
168 ///
169 /// Sharing a mutable [`AtomicUsize`]:
170 ///
171 /// [`AtomicUsize`]: ../../std/sync/atomic/struct.AtomicUsize.html
172 ///
173 /// ```no_run
174 /// use std::sync::Arc;
175 /// use std::sync::atomic::{AtomicUsize, Ordering};
176 /// use std::thread;
177 ///
178 /// let val = Arc::new(AtomicUsize::new(5));
179 ///
180 /// for _ in 0..10 {
181 ///     let val = Arc::clone(&val);
182 ///
183 ///     thread::spawn(move || {
184 ///         let v = val.fetch_add(1, Ordering::SeqCst);
185 ///         println!("{:?}", v);
186 ///     });
187 /// }
188 /// ```
189 ///
190 /// See the [`rc` documentation][rc_examples] for more examples of reference
191 /// counting in general.
192 ///
193 /// [rc_examples]: ../../std/rc/index.html#examples
194 #[cfg_attr(not(test), lang = "arc")]
195 #[stable(feature = "rust1", since = "1.0.0")]
196 pub struct Arc<T: ?Sized> {
197     ptr: NonNull<ArcInner<T>>,
198     phantom: PhantomData<ArcInner<T>>,
199 }
200
201 #[stable(feature = "rust1", since = "1.0.0")]
202 unsafe impl<T: ?Sized + Sync + Send> Send for Arc<T> {}
203 #[stable(feature = "rust1", since = "1.0.0")]
204 unsafe impl<T: ?Sized + Sync + Send> Sync for Arc<T> {}
205
206 #[unstable(feature = "coerce_unsized", issue = "27732")]
207 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Arc<U>> for Arc<T> {}
208
209 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
210 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Arc<U>> for Arc<T> {}
211
212 impl<T: ?Sized> Arc<T> {
213     fn from_inner(ptr: NonNull<ArcInner<T>>) -> Self {
214         Self { ptr, phantom: PhantomData }
215     }
216
217     unsafe fn from_ptr(ptr: *mut ArcInner<T>) -> Self {
218         Self::from_inner(NonNull::new_unchecked(ptr))
219     }
220 }
221
222 /// `Weak` is a version of [`Arc`] that holds a non-owning reference to the
223 /// managed allocation. The allocation is accessed by calling [`upgrade`] on the `Weak`
224 /// pointer, which returns an [`Option`]`<`[`Arc`]`<T>>`.
225 ///
226 /// Since a `Weak` reference does not count towards ownership, it will not
227 /// prevent the value stored in the allocation from being dropped, and `Weak` itself makes no
228 /// guarantees about the value still being present. Thus it may return [`None`]
229 /// when [`upgrade`]d. Note however that a `Weak` reference *does* prevent the allocation
230 /// itself (the backing store) from being deallocated.
231 ///
232 /// A `Weak` pointer is useful for keeping a temporary reference to the allocation
233 /// managed by [`Arc`] without preventing its inner value from being dropped. It is also used to
234 /// prevent circular references between [`Arc`] pointers, since mutual owning references
235 /// would never allow either [`Arc`] to be dropped. For example, a tree could
236 /// have strong [`Arc`] pointers from parent nodes to children, and `Weak`
237 /// pointers from children back to their parents.
238 ///
239 /// The typical way to obtain a `Weak` pointer is to call [`Arc::downgrade`].
240 ///
241 /// [`Arc`]: struct.Arc.html
242 /// [`Arc::downgrade`]: struct.Arc.html#method.downgrade
243 /// [`upgrade`]: struct.Weak.html#method.upgrade
244 /// [`Option`]: ../../std/option/enum.Option.html
245 /// [`None`]: ../../std/option/enum.Option.html#variant.None
246 #[stable(feature = "arc_weak", since = "1.4.0")]
247 pub struct Weak<T: ?Sized> {
248     // This is a `NonNull` to allow optimizing the size of this type in enums,
249     // but it is not necessarily a valid pointer.
250     // `Weak::new` sets this to `usize::MAX` so that it doesn’t need
251     // to allocate space on the heap.  That's not a value a real pointer
252     // will ever have because RcBox has alignment at least 2.
253     ptr: NonNull<ArcInner<T>>,
254 }
255
256 #[stable(feature = "arc_weak", since = "1.4.0")]
257 unsafe impl<T: ?Sized + Sync + Send> Send for Weak<T> {}
258 #[stable(feature = "arc_weak", since = "1.4.0")]
259 unsafe impl<T: ?Sized + Sync + Send> Sync for Weak<T> {}
260
261 #[unstable(feature = "coerce_unsized", issue = "27732")]
262 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Weak<U>> for Weak<T> {}
263 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
264 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Weak<U>> for Weak<T> {}
265
266 #[stable(feature = "arc_weak", since = "1.4.0")]
267 impl<T: ?Sized + fmt::Debug> fmt::Debug for Weak<T> {
268     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
269         write!(f, "(Weak)")
270     }
271 }
272
273 struct ArcInner<T: ?Sized> {
274     strong: atomic::AtomicUsize,
275
276     // the value usize::MAX acts as a sentinel for temporarily "locking" the
277     // ability to upgrade weak pointers or downgrade strong ones; this is used
278     // to avoid races in `make_mut` and `get_mut`.
279     weak: atomic::AtomicUsize,
280
281     data: T,
282 }
283
284 unsafe impl<T: ?Sized + Sync + Send> Send for ArcInner<T> {}
285 unsafe impl<T: ?Sized + Sync + Send> Sync for ArcInner<T> {}
286
287 impl<T> Arc<T> {
288     /// Constructs a new `Arc<T>`.
289     ///
290     /// # Examples
291     ///
292     /// ```
293     /// use std::sync::Arc;
294     ///
295     /// let five = Arc::new(5);
296     /// ```
297     #[inline]
298     #[stable(feature = "rust1", since = "1.0.0")]
299     pub fn new(data: T) -> Arc<T> {
300         // Start the weak pointer count as 1 which is the weak pointer that's
301         // held by all the strong pointers (kinda), see std/rc.rs for more info
302         let x: Box<_> = box ArcInner {
303             strong: atomic::AtomicUsize::new(1),
304             weak: atomic::AtomicUsize::new(1),
305             data,
306         };
307         Self::from_inner(Box::into_raw_non_null(x))
308     }
309
310     /// Constructs a new `Arc` with uninitialized contents.
311     ///
312     /// # Examples
313     ///
314     /// ```
315     /// #![feature(new_uninit)]
316     /// #![feature(get_mut_unchecked)]
317     ///
318     /// use std::sync::Arc;
319     ///
320     /// let mut five = Arc::<u32>::new_uninit();
321     ///
322     /// let five = unsafe {
323     ///     // Deferred initialization:
324     ///     Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
325     ///
326     ///     five.assume_init()
327     /// };
328     ///
329     /// assert_eq!(*five, 5)
330     /// ```
331     #[unstable(feature = "new_uninit", issue = "63291")]
332     pub fn new_uninit() -> Arc<mem::MaybeUninit<T>> {
333         unsafe {
334             Arc::from_ptr(Arc::allocate_for_layout(Layout::new::<T>(), |mem| {
335                 mem as *mut ArcInner<mem::MaybeUninit<T>>
336             }))
337         }
338     }
339
340     /// Constructs a new `Arc` with uninitialized contents, with the memory
341     /// being filled with `0` bytes.
342     ///
343     /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
344     /// of this method.
345     ///
346     /// # Examples
347     ///
348     /// ```
349     /// #![feature(new_uninit)]
350     ///
351     /// use std::sync::Arc;
352     ///
353     /// let zero = Arc::<u32>::new_zeroed();
354     /// let zero = unsafe { zero.assume_init() };
355     ///
356     /// assert_eq!(*zero, 0)
357     /// ```
358     ///
359     /// [zeroed]: ../../std/mem/union.MaybeUninit.html#method.zeroed
360     #[unstable(feature = "new_uninit", issue = "63291")]
361     pub fn new_zeroed() -> Arc<mem::MaybeUninit<T>> {
362         unsafe {
363             let mut uninit = Self::new_uninit();
364             ptr::write_bytes::<T>(Arc::get_mut_unchecked(&mut uninit).as_mut_ptr(), 0, 1);
365             uninit
366         }
367     }
368
369     /// Constructs a new `Pin<Arc<T>>`. If `T` does not implement `Unpin`, then
370     /// `data` will be pinned in memory and unable to be moved.
371     #[stable(feature = "pin", since = "1.33.0")]
372     pub fn pin(data: T) -> Pin<Arc<T>> {
373         unsafe { Pin::new_unchecked(Arc::new(data)) }
374     }
375
376     /// Returns the inner value, if the `Arc` has exactly one strong reference.
377     ///
378     /// Otherwise, an [`Err`][result] is returned with the same `Arc` that was
379     /// passed in.
380     ///
381     /// This will succeed even if there are outstanding weak references.
382     ///
383     /// [result]: ../../std/result/enum.Result.html
384     ///
385     /// # Examples
386     ///
387     /// ```
388     /// use std::sync::Arc;
389     ///
390     /// let x = Arc::new(3);
391     /// assert_eq!(Arc::try_unwrap(x), Ok(3));
392     ///
393     /// let x = Arc::new(4);
394     /// let _y = Arc::clone(&x);
395     /// assert_eq!(*Arc::try_unwrap(x).unwrap_err(), 4);
396     /// ```
397     #[inline]
398     #[stable(feature = "arc_unique", since = "1.4.0")]
399     pub fn try_unwrap(this: Self) -> Result<T, Self> {
400         // See `drop` for why all these atomics are like this
401         if this.inner().strong.compare_exchange(1, 0, Release, Relaxed).is_err() {
402             return Err(this);
403         }
404
405         atomic::fence(Acquire);
406
407         unsafe {
408             let elem = ptr::read(&this.ptr.as_ref().data);
409
410             // Make a weak pointer to clean up the implicit strong-weak reference
411             let _weak = Weak { ptr: this.ptr };
412             mem::forget(this);
413
414             Ok(elem)
415         }
416     }
417 }
418
419 impl<T> Arc<[T]> {
420     /// Constructs a new reference-counted slice with uninitialized contents.
421     ///
422     /// # Examples
423     ///
424     /// ```
425     /// #![feature(new_uninit)]
426     /// #![feature(get_mut_unchecked)]
427     ///
428     /// use std::sync::Arc;
429     ///
430     /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
431     ///
432     /// let values = unsafe {
433     ///     // Deferred initialization:
434     ///     Arc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
435     ///     Arc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
436     ///     Arc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);
437     ///
438     ///     values.assume_init()
439     /// };
440     ///
441     /// assert_eq!(*values, [1, 2, 3])
442     /// ```
443     #[unstable(feature = "new_uninit", issue = "63291")]
444     pub fn new_uninit_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
445         unsafe { Arc::from_ptr(Arc::allocate_for_slice(len)) }
446     }
447 }
448
449 impl<T> Arc<mem::MaybeUninit<T>> {
450     /// Converts to `Arc<T>`.
451     ///
452     /// # Safety
453     ///
454     /// As with [`MaybeUninit::assume_init`],
455     /// it is up to the caller to guarantee that the inner value
456     /// really is in an initialized state.
457     /// Calling this when the content is not yet fully initialized
458     /// causes immediate undefined behavior.
459     ///
460     /// [`MaybeUninit::assume_init`]: ../../std/mem/union.MaybeUninit.html#method.assume_init
461     ///
462     /// # Examples
463     ///
464     /// ```
465     /// #![feature(new_uninit)]
466     /// #![feature(get_mut_unchecked)]
467     ///
468     /// use std::sync::Arc;
469     ///
470     /// let mut five = Arc::<u32>::new_uninit();
471     ///
472     /// let five = unsafe {
473     ///     // Deferred initialization:
474     ///     Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
475     ///
476     ///     five.assume_init()
477     /// };
478     ///
479     /// assert_eq!(*five, 5)
480     /// ```
481     #[unstable(feature = "new_uninit", issue = "63291")]
482     #[inline]
483     pub unsafe fn assume_init(self) -> Arc<T> {
484         Arc::from_inner(mem::ManuallyDrop::new(self).ptr.cast())
485     }
486 }
487
488 impl<T> Arc<[mem::MaybeUninit<T>]> {
489     /// Converts to `Arc<[T]>`.
490     ///
491     /// # Safety
492     ///
493     /// As with [`MaybeUninit::assume_init`],
494     /// it is up to the caller to guarantee that the inner value
495     /// really is in an initialized state.
496     /// Calling this when the content is not yet fully initialized
497     /// causes immediate undefined behavior.
498     ///
499     /// [`MaybeUninit::assume_init`]: ../../std/mem/union.MaybeUninit.html#method.assume_init
500     ///
501     /// # Examples
502     ///
503     /// ```
504     /// #![feature(new_uninit)]
505     /// #![feature(get_mut_unchecked)]
506     ///
507     /// use std::sync::Arc;
508     ///
509     /// let mut values = Arc::<[u32]>::new_uninit_slice(3);
510     ///
511     /// let values = unsafe {
512     ///     // Deferred initialization:
513     ///     Arc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
514     ///     Arc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
515     ///     Arc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);
516     ///
517     ///     values.assume_init()
518     /// };
519     ///
520     /// assert_eq!(*values, [1, 2, 3])
521     /// ```
522     #[unstable(feature = "new_uninit", issue = "63291")]
523     #[inline]
524     pub unsafe fn assume_init(self) -> Arc<[T]> {
525         Arc::from_ptr(mem::ManuallyDrop::new(self).ptr.as_ptr() as _)
526     }
527 }
528
529 impl<T: ?Sized> Arc<T> {
530     /// Consumes the `Arc`, returning the wrapped pointer.
531     ///
532     /// To avoid a memory leak the pointer must be converted back to an `Arc` using
533     /// [`Arc::from_raw`][from_raw].
534     ///
535     /// [from_raw]: struct.Arc.html#method.from_raw
536     ///
537     /// # Examples
538     ///
539     /// ```
540     /// use std::sync::Arc;
541     ///
542     /// let x = Arc::new("hello".to_owned());
543     /// let x_ptr = Arc::into_raw(x);
544     /// assert_eq!(unsafe { &*x_ptr }, "hello");
545     /// ```
546     #[stable(feature = "rc_raw", since = "1.17.0")]
547     pub fn into_raw(this: Self) -> *const T {
548         let ptr: *const T = &*this;
549         mem::forget(this);
550         ptr
551     }
552
553     /// Constructs an `Arc` from a raw pointer.
554     ///
555     /// The raw pointer must have been previously returned by a call to a
556     /// [`Arc::into_raw`][into_raw], using the same `T`.
557     ///
558     /// This function is unsafe because improper use may lead to memory unsafety,
559     /// even if `T` is never accessed. For example, a double-free may occur if the function is
560     /// called twice on the same raw pointer.
561     ///
562     /// [into_raw]: struct.Arc.html#method.into_raw
563     ///
564     /// # Examples
565     ///
566     /// ```
567     /// use std::sync::Arc;
568     ///
569     /// let x = Arc::new("hello".to_owned());
570     /// let x_ptr = Arc::into_raw(x);
571     ///
572     /// unsafe {
573     ///     // Convert back to an `Arc` to prevent leak.
574     ///     let x = Arc::from_raw(x_ptr);
575     ///     assert_eq!(&*x, "hello");
576     ///
577     ///     // Further calls to `Arc::from_raw(x_ptr)` would be memory-unsafe.
578     /// }
579     ///
580     /// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
581     /// ```
582     #[stable(feature = "rc_raw", since = "1.17.0")]
583     pub unsafe fn from_raw(ptr: *const T) -> Self {
584         let offset = data_offset(ptr);
585
586         // Reverse the offset to find the original ArcInner.
587         let fake_ptr = ptr as *mut ArcInner<T>;
588         let arc_ptr = set_data_ptr(fake_ptr, (ptr as *mut u8).offset(-offset));
589
590         Self::from_ptr(arc_ptr)
591     }
592
593     /// Consumes the `Arc`, returning the wrapped pointer as `NonNull<T>`.
594     ///
595     /// # Examples
596     ///
597     /// ```
598     /// #![feature(rc_into_raw_non_null)]
599     ///
600     /// use std::sync::Arc;
601     ///
602     /// let x = Arc::new("hello".to_owned());
603     /// let ptr = Arc::into_raw_non_null(x);
604     /// let deref = unsafe { ptr.as_ref() };
605     /// assert_eq!(deref, "hello");
606     /// ```
607     #[unstable(feature = "rc_into_raw_non_null", issue = "47336")]
608     #[inline]
609     pub fn into_raw_non_null(this: Self) -> NonNull<T> {
610         // safe because Arc guarantees its pointer is non-null
611         unsafe { NonNull::new_unchecked(Arc::into_raw(this) as *mut _) }
612     }
613
614     /// Creates a new [`Weak`][weak] pointer to this allocation.
615     ///
616     /// [weak]: struct.Weak.html
617     ///
618     /// # Examples
619     ///
620     /// ```
621     /// use std::sync::Arc;
622     ///
623     /// let five = Arc::new(5);
624     ///
625     /// let weak_five = Arc::downgrade(&five);
626     /// ```
627     #[stable(feature = "arc_weak", since = "1.4.0")]
628     pub fn downgrade(this: &Self) -> Weak<T> {
629         // This Relaxed is OK because we're checking the value in the CAS
630         // below.
631         let mut cur = this.inner().weak.load(Relaxed);
632
633         loop {
634             // check if the weak counter is currently "locked"; if so, spin.
635             if cur == usize::MAX {
636                 cur = this.inner().weak.load(Relaxed);
637                 continue;
638             }
639
640             // NOTE: this code currently ignores the possibility of overflow
641             // into usize::MAX; in general both Rc and Arc need to be adjusted
642             // to deal with overflow.
643
644             // Unlike with Clone(), we need this to be an Acquire read to
645             // synchronize with the write coming from `is_unique`, so that the
646             // events prior to that write happen before this read.
647             match this.inner().weak.compare_exchange_weak(cur, cur + 1, Acquire, Relaxed) {
648                 Ok(_) => {
649                     // Make sure we do not create a dangling Weak
650                     debug_assert!(!is_dangling(this.ptr));
651                     return Weak { ptr: this.ptr };
652                 }
653                 Err(old) => cur = old,
654             }
655         }
656     }
657
658     /// Gets the number of [`Weak`][weak] pointers to this allocation.
659     ///
660     /// [weak]: struct.Weak.html
661     ///
662     /// # Safety
663     ///
664     /// This method by itself is safe, but using it correctly requires extra care.
665     /// Another thread can change the weak count at any time,
666     /// including potentially between calling this method and acting on the result.
667     ///
668     /// # Examples
669     ///
670     /// ```
671     /// use std::sync::Arc;
672     ///
673     /// let five = Arc::new(5);
674     /// let _weak_five = Arc::downgrade(&five);
675     ///
676     /// // This assertion is deterministic because we haven't shared
677     /// // the `Arc` or `Weak` between threads.
678     /// assert_eq!(1, Arc::weak_count(&five));
679     /// ```
680     #[inline]
681     #[stable(feature = "arc_counts", since = "1.15.0")]
682     pub fn weak_count(this: &Self) -> usize {
683         let cnt = this.inner().weak.load(SeqCst);
684         // If the weak count is currently locked, the value of the
685         // count was 0 just before taking the lock.
686         if cnt == usize::MAX { 0 } else { cnt - 1 }
687     }
688
689     /// Gets the number of strong (`Arc`) pointers to this allocation.
690     ///
691     /// # Safety
692     ///
693     /// This method by itself is safe, but using it correctly requires extra care.
694     /// Another thread can change the strong count at any time,
695     /// including potentially between calling this method and acting on the result.
696     ///
697     /// # Examples
698     ///
699     /// ```
700     /// use std::sync::Arc;
701     ///
702     /// let five = Arc::new(5);
703     /// let _also_five = Arc::clone(&five);
704     ///
705     /// // This assertion is deterministic because we haven't shared
706     /// // the `Arc` between threads.
707     /// assert_eq!(2, Arc::strong_count(&five));
708     /// ```
709     #[inline]
710     #[stable(feature = "arc_counts", since = "1.15.0")]
711     pub fn strong_count(this: &Self) -> usize {
712         this.inner().strong.load(SeqCst)
713     }
714
715     #[inline]
716     fn inner(&self) -> &ArcInner<T> {
717         // This unsafety is ok because while this arc is alive we're guaranteed
718         // that the inner pointer is valid. Furthermore, we know that the
719         // `ArcInner` structure itself is `Sync` because the inner data is
720         // `Sync` as well, so we're ok loaning out an immutable pointer to these
721         // contents.
722         unsafe { self.ptr.as_ref() }
723     }
724
725     // Non-inlined part of `drop`.
726     #[inline(never)]
727     unsafe fn drop_slow(&mut self) {
728         // Destroy the data at this time, even though we may not free the box
729         // allocation itself (there may still be weak pointers lying around).
730         ptr::drop_in_place(&mut self.ptr.as_mut().data);
731
732         if self.inner().weak.fetch_sub(1, Release) == 1 {
733             atomic::fence(Acquire);
734             Global.dealloc(self.ptr.cast(), Layout::for_value(self.ptr.as_ref()))
735         }
736     }
737
738     #[inline]
739     #[stable(feature = "ptr_eq", since = "1.17.0")]
740     /// Returns `true` if the two `Arc`s point to the same allocation
741     /// (in a vein similar to [`ptr::eq`]).
742     ///
743     /// # Examples
744     ///
745     /// ```
746     /// use std::sync::Arc;
747     ///
748     /// let five = Arc::new(5);
749     /// let same_five = Arc::clone(&five);
750     /// let other_five = Arc::new(5);
751     ///
752     /// assert!(Arc::ptr_eq(&five, &same_five));
753     /// assert!(!Arc::ptr_eq(&five, &other_five));
754     /// ```
755     ///
756     /// [`ptr::eq`]: ../../std/ptr/fn.eq.html
757     pub fn ptr_eq(this: &Self, other: &Self) -> bool {
758         this.ptr.as_ptr() == other.ptr.as_ptr()
759     }
760 }
761
762 impl<T: ?Sized> Arc<T> {
763     /// Allocates an `ArcInner<T>` with sufficient space for
764     /// a possibly-unsized inner value where the value has the layout provided.
765     ///
766     /// The function `mem_to_arcinner` is called with the data pointer
767     /// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
768     unsafe fn allocate_for_layout(
769         value_layout: Layout,
770         mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
771     ) -> *mut ArcInner<T> {
772         // Calculate layout using the given value layout.
773         // Previously, layout was calculated on the expression
774         // `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
775         // reference (see #54908).
776         let layout = Layout::new::<ArcInner<()>>().extend(value_layout).unwrap().0.pad_to_align();
777
778         let mem = Global.alloc(layout).unwrap_or_else(|_| handle_alloc_error(layout));
779
780         // Initialize the ArcInner
781         let inner = mem_to_arcinner(mem.as_ptr());
782         debug_assert_eq!(Layout::for_value(&*inner), layout);
783
784         ptr::write(&mut (*inner).strong, atomic::AtomicUsize::new(1));
785         ptr::write(&mut (*inner).weak, atomic::AtomicUsize::new(1));
786
787         inner
788     }
789
790     /// Allocates an `ArcInner<T>` with sufficient space for an unsized inner value.
791     unsafe fn allocate_for_ptr(ptr: *const T) -> *mut ArcInner<T> {
792         // Allocate for the `ArcInner<T>` using the given value.
793         Self::allocate_for_layout(Layout::for_value(&*ptr), |mem| {
794             set_data_ptr(ptr as *mut T, mem) as *mut ArcInner<T>
795         })
796     }
797
798     fn from_box(v: Box<T>) -> Arc<T> {
799         unsafe {
800             let box_unique = Box::into_unique(v);
801             let bptr = box_unique.as_ptr();
802
803             let value_size = size_of_val(&*bptr);
804             let ptr = Self::allocate_for_ptr(bptr);
805
806             // Copy value as bytes
807             ptr::copy_nonoverlapping(
808                 bptr as *const T as *const u8,
809                 &mut (*ptr).data as *mut _ as *mut u8,
810                 value_size,
811             );
812
813             // Free the allocation without dropping its contents
814             box_free(box_unique);
815
816             Self::from_ptr(ptr)
817         }
818     }
819 }
820
821 impl<T> Arc<[T]> {
822     /// Allocates an `ArcInner<[T]>` with the given length.
823     unsafe fn allocate_for_slice(len: usize) -> *mut ArcInner<[T]> {
824         Self::allocate_for_layout(Layout::array::<T>(len).unwrap(), |mem| {
825             ptr::slice_from_raw_parts_mut(mem as *mut T, len) as *mut ArcInner<[T]>
826         })
827     }
828 }
829
830 /// Sets the data pointer of a `?Sized` raw pointer.
831 ///
832 /// For a slice/trait object, this sets the `data` field and leaves the rest
833 /// unchanged. For a sized raw pointer, this simply sets the pointer.
834 unsafe fn set_data_ptr<T: ?Sized, U>(mut ptr: *mut T, data: *mut U) -> *mut T {
835     ptr::write(&mut ptr as *mut _ as *mut *mut u8, data as *mut u8);
836     ptr
837 }
838
839 impl<T> Arc<[T]> {
840     /// Copy elements from slice into newly allocated Arc<[T]>
841     ///
842     /// Unsafe because the caller must either take ownership or bind `T: Copy`.
843     unsafe fn copy_from_slice(v: &[T]) -> Arc<[T]> {
844         let ptr = Self::allocate_for_slice(v.len());
845
846         ptr::copy_nonoverlapping(v.as_ptr(), &mut (*ptr).data as *mut [T] as *mut T, v.len());
847
848         Self::from_ptr(ptr)
849     }
850
851     /// Constructs an `Arc<[T]>` from an iterator known to be of a certain size.
852     ///
853     /// Behavior is undefined should the size be wrong.
854     unsafe fn from_iter_exact(iter: impl iter::Iterator<Item = T>, len: usize) -> Arc<[T]> {
855         // Panic guard while cloning T elements.
856         // In the event of a panic, elements that have been written
857         // into the new ArcInner will be dropped, then the memory freed.
858         struct Guard<T> {
859             mem: NonNull<u8>,
860             elems: *mut T,
861             layout: Layout,
862             n_elems: usize,
863         }
864
865         impl<T> Drop for Guard<T> {
866             fn drop(&mut self) {
867                 unsafe {
868                     let slice = from_raw_parts_mut(self.elems, self.n_elems);
869                     ptr::drop_in_place(slice);
870
871                     Global.dealloc(self.mem.cast(), self.layout);
872                 }
873             }
874         }
875
876         let ptr = Self::allocate_for_slice(len);
877
878         let mem = ptr as *mut _ as *mut u8;
879         let layout = Layout::for_value(&*ptr);
880
881         // Pointer to first element
882         let elems = &mut (*ptr).data as *mut [T] as *mut T;
883
884         let mut guard = Guard { mem: NonNull::new_unchecked(mem), elems, layout, n_elems: 0 };
885
886         for (i, item) in iter.enumerate() {
887             ptr::write(elems.add(i), item);
888             guard.n_elems += 1;
889         }
890
891         // All clear. Forget the guard so it doesn't free the new ArcInner.
892         mem::forget(guard);
893
894         Self::from_ptr(ptr)
895     }
896 }
897
898 /// Specialization trait used for `From<&[T]>`.
899 trait ArcFromSlice<T> {
900     fn from_slice(slice: &[T]) -> Self;
901 }
902
903 impl<T: Clone> ArcFromSlice<T> for Arc<[T]> {
904     #[inline]
905     default fn from_slice(v: &[T]) -> Self {
906         unsafe { Self::from_iter_exact(v.iter().cloned(), v.len()) }
907     }
908 }
909
910 impl<T: Copy> ArcFromSlice<T> for Arc<[T]> {
911     #[inline]
912     fn from_slice(v: &[T]) -> Self {
913         unsafe { Arc::copy_from_slice(v) }
914     }
915 }
916
917 #[stable(feature = "rust1", since = "1.0.0")]
918 impl<T: ?Sized> Clone for Arc<T> {
919     /// Makes a clone of the `Arc` pointer.
920     ///
921     /// This creates another pointer to the same allocation, increasing the
922     /// strong reference count.
923     ///
924     /// # Examples
925     ///
926     /// ```
927     /// use std::sync::Arc;
928     ///
929     /// let five = Arc::new(5);
930     ///
931     /// let _ = Arc::clone(&five);
932     /// ```
933     #[inline]
934     fn clone(&self) -> Arc<T> {
935         // Using a relaxed ordering is alright here, as knowledge of the
936         // original reference prevents other threads from erroneously deleting
937         // the object.
938         //
939         // As explained in the [Boost documentation][1], Increasing the
940         // reference counter can always be done with memory_order_relaxed: New
941         // references to an object can only be formed from an existing
942         // reference, and passing an existing reference from one thread to
943         // another must already provide any required synchronization.
944         //
945         // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
946         let old_size = self.inner().strong.fetch_add(1, Relaxed);
947
948         // However we need to guard against massive refcounts in case someone
949         // is `mem::forget`ing Arcs. If we don't do this the count can overflow
950         // and users will use-after free. We racily saturate to `isize::MAX` on
951         // the assumption that there aren't ~2 billion threads incrementing
952         // the reference count at once. This branch will never be taken in
953         // any realistic program.
954         //
955         // We abort because such a program is incredibly degenerate, and we
956         // don't care to support it.
957         if old_size > MAX_REFCOUNT {
958             unsafe {
959                 abort();
960             }
961         }
962
963         Self::from_inner(self.ptr)
964     }
965 }
966
967 #[stable(feature = "rust1", since = "1.0.0")]
968 impl<T: ?Sized> Deref for Arc<T> {
969     type Target = T;
970
971     #[inline]
972     fn deref(&self) -> &T {
973         &self.inner().data
974     }
975 }
976
977 #[unstable(feature = "receiver_trait", issue = "none")]
978 impl<T: ?Sized> Receiver for Arc<T> {}
979
980 impl<T: Clone> Arc<T> {
981     /// Makes a mutable reference into the given `Arc`.
982     ///
983     /// If there are other `Arc` or [`Weak`][weak] pointers to the same allocation,
984     /// then `make_mut` will create a new allocation and invoke [`clone`][clone] on the inner value
985     /// to ensure unique ownership. This is also referred to as clone-on-write.
986     ///
987     /// Note that this differs from the behavior of [`Rc::make_mut`] which disassociates
988     /// any remaining `Weak` pointers.
989     ///
990     /// See also [`get_mut`][get_mut], which will fail rather than cloning.
991     ///
992     /// [weak]: struct.Weak.html
993     /// [clone]: ../../std/clone/trait.Clone.html#tymethod.clone
994     /// [get_mut]: struct.Arc.html#method.get_mut
995     /// [`Rc::make_mut`]: ../rc/struct.Rc.html#method.make_mut
996     ///
997     /// # Examples
998     ///
999     /// ```
1000     /// use std::sync::Arc;
1001     ///
1002     /// let mut data = Arc::new(5);
1003     ///
1004     /// *Arc::make_mut(&mut data) += 1;         // Won't clone anything
1005     /// let mut other_data = Arc::clone(&data); // Won't clone inner data
1006     /// *Arc::make_mut(&mut data) += 1;         // Clones inner data
1007     /// *Arc::make_mut(&mut data) += 1;         // Won't clone anything
1008     /// *Arc::make_mut(&mut other_data) *= 2;   // Won't clone anything
1009     ///
1010     /// // Now `data` and `other_data` point to different allocations.
1011     /// assert_eq!(*data, 8);
1012     /// assert_eq!(*other_data, 12);
1013     /// ```
1014     #[inline]
1015     #[stable(feature = "arc_unique", since = "1.4.0")]
1016     pub fn make_mut(this: &mut Self) -> &mut T {
1017         // Note that we hold both a strong reference and a weak reference.
1018         // Thus, releasing our strong reference only will not, by itself, cause
1019         // the memory to be deallocated.
1020         //
1021         // Use Acquire to ensure that we see any writes to `weak` that happen
1022         // before release writes (i.e., decrements) to `strong`. Since we hold a
1023         // weak count, there's no chance the ArcInner itself could be
1024         // deallocated.
1025         if this.inner().strong.compare_exchange(1, 0, Acquire, Relaxed).is_err() {
1026             // Another strong pointer exists; clone
1027             *this = Arc::new((**this).clone());
1028         } else if this.inner().weak.load(Relaxed) != 1 {
1029             // Relaxed suffices in the above because this is fundamentally an
1030             // optimization: we are always racing with weak pointers being
1031             // dropped. Worst case, we end up allocated a new Arc unnecessarily.
1032
1033             // We removed the last strong ref, but there are additional weak
1034             // refs remaining. We'll move the contents to a new Arc, and
1035             // invalidate the other weak refs.
1036
1037             // Note that it is not possible for the read of `weak` to yield
1038             // usize::MAX (i.e., locked), since the weak count can only be
1039             // locked by a thread with a strong reference.
1040
1041             // Materialize our own implicit weak pointer, so that it can clean
1042             // up the ArcInner as needed.
1043             let weak = Weak { ptr: this.ptr };
1044
1045             // mark the data itself as already deallocated
1046             unsafe {
1047                 // there is no data race in the implicit write caused by `read`
1048                 // here (due to zeroing) because data is no longer accessed by
1049                 // other threads (due to there being no more strong refs at this
1050                 // point).
1051                 let mut swap = Arc::new(ptr::read(&weak.ptr.as_ref().data));
1052                 mem::swap(this, &mut swap);
1053                 mem::forget(swap);
1054             }
1055         } else {
1056             // We were the sole reference of either kind; bump back up the
1057             // strong ref count.
1058             this.inner().strong.store(1, Release);
1059         }
1060
1061         // As with `get_mut()`, the unsafety is ok because our reference was
1062         // either unique to begin with, or became one upon cloning the contents.
1063         unsafe { &mut this.ptr.as_mut().data }
1064     }
1065 }
1066
1067 impl<T: ?Sized> Arc<T> {
1068     /// Returns a mutable reference into the given `Arc`, if there are
1069     /// no other `Arc` or [`Weak`][weak] pointers to the same allocation.
1070     ///
1071     /// Returns [`None`][option] otherwise, because it is not safe to
1072     /// mutate a shared value.
1073     ///
1074     /// See also [`make_mut`][make_mut], which will [`clone`][clone]
1075     /// the inner value when there are other pointers.
1076     ///
1077     /// [weak]: struct.Weak.html
1078     /// [option]: ../../std/option/enum.Option.html
1079     /// [make_mut]: struct.Arc.html#method.make_mut
1080     /// [clone]: ../../std/clone/trait.Clone.html#tymethod.clone
1081     ///
1082     /// # Examples
1083     ///
1084     /// ```
1085     /// use std::sync::Arc;
1086     ///
1087     /// let mut x = Arc::new(3);
1088     /// *Arc::get_mut(&mut x).unwrap() = 4;
1089     /// assert_eq!(*x, 4);
1090     ///
1091     /// let _y = Arc::clone(&x);
1092     /// assert!(Arc::get_mut(&mut x).is_none());
1093     /// ```
1094     #[inline]
1095     #[stable(feature = "arc_unique", since = "1.4.0")]
1096     pub fn get_mut(this: &mut Self) -> Option<&mut T> {
1097         if this.is_unique() {
1098             // This unsafety is ok because we're guaranteed that the pointer
1099             // returned is the *only* pointer that will ever be returned to T. Our
1100             // reference count is guaranteed to be 1 at this point, and we required
1101             // the Arc itself to be `mut`, so we're returning the only possible
1102             // reference to the inner data.
1103             unsafe { Some(Arc::get_mut_unchecked(this)) }
1104         } else {
1105             None
1106         }
1107     }
1108
1109     /// Returns a mutable reference into the given `Arc`,
1110     /// without any check.
1111     ///
1112     /// See also [`get_mut`], which is safe and does appropriate checks.
1113     ///
1114     /// [`get_mut`]: struct.Arc.html#method.get_mut
1115     ///
1116     /// # Safety
1117     ///
1118     /// Any other `Arc` or [`Weak`] pointers to the same allocation must not be dereferenced
1119     /// for the duration of the returned borrow.
1120     /// This is trivially the case if no such pointers exist,
1121     /// for example immediately after `Arc::new`.
1122     ///
1123     /// # Examples
1124     ///
1125     /// ```
1126     /// #![feature(get_mut_unchecked)]
1127     ///
1128     /// use std::sync::Arc;
1129     ///
1130     /// let mut x = Arc::new(String::new());
1131     /// unsafe {
1132     ///     Arc::get_mut_unchecked(&mut x).push_str("foo")
1133     /// }
1134     /// assert_eq!(*x, "foo");
1135     /// ```
1136     #[inline]
1137     #[unstable(feature = "get_mut_unchecked", issue = "63292")]
1138     pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
1139         &mut this.ptr.as_mut().data
1140     }
1141
1142     /// Determine whether this is the unique reference (including weak refs) to
1143     /// the underlying data.
1144     ///
1145     /// Note that this requires locking the weak ref count.
1146     fn is_unique(&mut self) -> bool {
1147         // lock the weak pointer count if we appear to be the sole weak pointer
1148         // holder.
1149         //
1150         // The acquire label here ensures a happens-before relationship with any
1151         // writes to `strong` (in particular in `Weak::upgrade`) prior to decrements
1152         // of the `weak` count (via `Weak::drop`, which uses release).  If the upgraded
1153         // weak ref was never dropped, the CAS here will fail so we do not care to synchronize.
1154         if self.inner().weak.compare_exchange(1, usize::MAX, Acquire, Relaxed).is_ok() {
1155             // This needs to be an `Acquire` to synchronize with the decrement of the `strong`
1156             // counter in `drop` -- the only access that happens when any but the last reference
1157             // is being dropped.
1158             let unique = self.inner().strong.load(Acquire) == 1;
1159
1160             // The release write here synchronizes with a read in `downgrade`,
1161             // effectively preventing the above read of `strong` from happening
1162             // after the write.
1163             self.inner().weak.store(1, Release); // release the lock
1164             unique
1165         } else {
1166             false
1167         }
1168     }
1169 }
1170
1171 #[stable(feature = "rust1", since = "1.0.0")]
1172 unsafe impl<#[may_dangle] T: ?Sized> Drop for Arc<T> {
1173     /// Drops the `Arc`.
1174     ///
1175     /// This will decrement the strong reference count. If the strong reference
1176     /// count reaches zero then the only other references (if any) are
1177     /// [`Weak`], so we `drop` the inner value.
1178     ///
1179     /// # Examples
1180     ///
1181     /// ```
1182     /// use std::sync::Arc;
1183     ///
1184     /// struct Foo;
1185     ///
1186     /// impl Drop for Foo {
1187     ///     fn drop(&mut self) {
1188     ///         println!("dropped!");
1189     ///     }
1190     /// }
1191     ///
1192     /// let foo  = Arc::new(Foo);
1193     /// let foo2 = Arc::clone(&foo);
1194     ///
1195     /// drop(foo);    // Doesn't print anything
1196     /// drop(foo2);   // Prints "dropped!"
1197     /// ```
1198     ///
1199     /// [`Weak`]: ../../std/sync/struct.Weak.html
1200     #[inline]
1201     fn drop(&mut self) {
1202         // Because `fetch_sub` is already atomic, we do not need to synchronize
1203         // with other threads unless we are going to delete the object. This
1204         // same logic applies to the below `fetch_sub` to the `weak` count.
1205         if self.inner().strong.fetch_sub(1, Release) != 1 {
1206             return;
1207         }
1208
1209         // This fence is needed to prevent reordering of use of the data and
1210         // deletion of the data.  Because it is marked `Release`, the decreasing
1211         // of the reference count synchronizes with this `Acquire` fence. This
1212         // means that use of the data happens before decreasing the reference
1213         // count, which happens before this fence, which happens before the
1214         // deletion of the data.
1215         //
1216         // As explained in the [Boost documentation][1],
1217         //
1218         // > It is important to enforce any possible access to the object in one
1219         // > thread (through an existing reference) to *happen before* deleting
1220         // > the object in a different thread. This is achieved by a "release"
1221         // > operation after dropping a reference (any access to the object
1222         // > through this reference must obviously happened before), and an
1223         // > "acquire" operation before deleting the object.
1224         //
1225         // In particular, while the contents of an Arc are usually immutable, it's
1226         // possible to have interior writes to something like a Mutex<T>. Since a
1227         // Mutex is not acquired when it is deleted, we can't rely on its
1228         // synchronization logic to make writes in thread A visible to a destructor
1229         // running in thread B.
1230         //
1231         // Also note that the Acquire fence here could probably be replaced with an
1232         // Acquire load, which could improve performance in highly-contended
1233         // situations. See [2].
1234         //
1235         // [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
1236         // [2]: (https://github.com/rust-lang/rust/pull/41714)
1237         atomic::fence(Acquire);
1238
1239         unsafe {
1240             self.drop_slow();
1241         }
1242     }
1243 }
1244
1245 impl Arc<dyn Any + Send + Sync> {
1246     #[inline]
1247     #[stable(feature = "rc_downcast", since = "1.29.0")]
1248     /// Attempt to downcast the `Arc<dyn Any + Send + Sync>` to a concrete type.
1249     ///
1250     /// # Examples
1251     ///
1252     /// ```
1253     /// use std::any::Any;
1254     /// use std::sync::Arc;
1255     ///
1256     /// fn print_if_string(value: Arc<dyn Any + Send + Sync>) {
1257     ///     if let Ok(string) = value.downcast::<String>() {
1258     ///         println!("String ({}): {}", string.len(), string);
1259     ///     }
1260     /// }
1261     ///
1262     /// let my_string = "Hello World".to_string();
1263     /// print_if_string(Arc::new(my_string));
1264     /// print_if_string(Arc::new(0i8));
1265     /// ```
1266     pub fn downcast<T>(self) -> Result<Arc<T>, Self>
1267     where
1268         T: Any + Send + Sync + 'static,
1269     {
1270         if (*self).is::<T>() {
1271             let ptr = self.ptr.cast::<ArcInner<T>>();
1272             mem::forget(self);
1273             Ok(Arc::from_inner(ptr))
1274         } else {
1275             Err(self)
1276         }
1277     }
1278 }
1279
1280 impl<T> Weak<T> {
1281     /// Constructs a new `Weak<T>`, without allocating any memory.
1282     /// Calling [`upgrade`] on the return value always gives [`None`].
1283     ///
1284     /// [`upgrade`]: struct.Weak.html#method.upgrade
1285     /// [`None`]: ../../std/option/enum.Option.html#variant.None
1286     ///
1287     /// # Examples
1288     ///
1289     /// ```
1290     /// use std::sync::Weak;
1291     ///
1292     /// let empty: Weak<i64> = Weak::new();
1293     /// assert!(empty.upgrade().is_none());
1294     /// ```
1295     #[stable(feature = "downgraded_weak", since = "1.10.0")]
1296     pub fn new() -> Weak<T> {
1297         Weak { ptr: NonNull::new(usize::MAX as *mut ArcInner<T>).expect("MAX is not 0") }
1298     }
1299
1300     /// Returns a raw pointer to the object `T` pointed to by this `Weak<T>`.
1301     ///
1302     /// The pointer is valid only if there are some strong references. The pointer may be dangling
1303     /// or even [`null`] otherwise.
1304     ///
1305     /// # Examples
1306     ///
1307     /// ```
1308     /// #![feature(weak_into_raw)]
1309     ///
1310     /// use std::sync::Arc;
1311     /// use std::ptr;
1312     ///
1313     /// let strong = Arc::new("hello".to_owned());
1314     /// let weak = Arc::downgrade(&strong);
1315     /// // Both point to the same object
1316     /// assert!(ptr::eq(&*strong, weak.as_raw()));
1317     /// // The strong here keeps it alive, so we can still access the object.
1318     /// assert_eq!("hello", unsafe { &*weak.as_raw() });
1319     ///
1320     /// drop(strong);
1321     /// // But not any more. We can do weak.as_raw(), but accessing the pointer would lead to
1322     /// // undefined behaviour.
1323     /// // assert_eq!("hello", unsafe { &*weak.as_raw() });
1324     /// ```
1325     ///
1326     /// [`null`]: ../../std/ptr/fn.null.html
1327     #[unstable(feature = "weak_into_raw", issue = "60728")]
1328     pub fn as_raw(&self) -> *const T {
1329         match self.inner() {
1330             None => ptr::null(),
1331             Some(inner) => {
1332                 let offset = data_offset_sized::<T>();
1333                 let ptr = inner as *const ArcInner<T>;
1334                 // Note: while the pointer we create may already point to dropped value, the
1335                 // allocation still lives (it must hold the weak point as long as we are alive).
1336                 // Therefore, the offset is OK to do, it won't get out of the allocation.
1337                 let ptr = unsafe { (ptr as *const u8).offset(offset) };
1338                 ptr as *const T
1339             }
1340         }
1341     }
1342
1343     /// Consumes the `Weak<T>` and turns it into a raw pointer.
1344     ///
1345     /// This converts the weak pointer into a raw pointer, preserving the original weak count. It
1346     /// can be turned back into the `Weak<T>` with [`from_raw`].
1347     ///
1348     /// The same restrictions of accessing the target of the pointer as with
1349     /// [`as_raw`] apply.
1350     ///
1351     /// # Examples
1352     ///
1353     /// ```
1354     /// #![feature(weak_into_raw)]
1355     ///
1356     /// use std::sync::{Arc, Weak};
1357     ///
1358     /// let strong = Arc::new("hello".to_owned());
1359     /// let weak = Arc::downgrade(&strong);
1360     /// let raw = weak.into_raw();
1361     ///
1362     /// assert_eq!(1, Arc::weak_count(&strong));
1363     /// assert_eq!("hello", unsafe { &*raw });
1364     ///
1365     /// drop(unsafe { Weak::from_raw(raw) });
1366     /// assert_eq!(0, Arc::weak_count(&strong));
1367     /// ```
1368     ///
1369     /// [`from_raw`]: struct.Weak.html#method.from_raw
1370     /// [`as_raw`]: struct.Weak.html#method.as_raw
1371     #[unstable(feature = "weak_into_raw", issue = "60728")]
1372     pub fn into_raw(self) -> *const T {
1373         let result = self.as_raw();
1374         mem::forget(self);
1375         result
1376     }
1377
1378     /// Converts a raw pointer previously created by [`into_raw`] back into
1379     /// `Weak<T>`.
1380     ///
1381     /// This can be used to safely get a strong reference (by calling [`upgrade`]
1382     /// later) or to deallocate the weak count by dropping the `Weak<T>`.
1383     ///
1384     /// It takes ownership of one weak count (with the exception of pointers created by [`new`],
1385     /// as these don't have any corresponding weak count).
1386     ///
1387     /// # Safety
1388     ///
1389     /// The pointer must have originated from the [`into_raw`] (or [`as_raw'], provided there was
1390     /// a corresponding [`forget`] on the `Weak<T>`) and must still own its potential weak reference
1391     /// count.
1392     ///
1393     /// It is allowed for the strong count to be 0 at the time of calling this, but the weak count
1394     /// must be non-zero or the pointer must have originated from a dangling `Weak<T>` (one created
1395     /// by [`new`]).
1396     ///
1397     /// # Examples
1398     ///
1399     /// ```
1400     /// #![feature(weak_into_raw)]
1401     ///
1402     /// use std::sync::{Arc, Weak};
1403     ///
1404     /// let strong = Arc::new("hello".to_owned());
1405     ///
1406     /// let raw_1 = Arc::downgrade(&strong).into_raw();
1407     /// let raw_2 = Arc::downgrade(&strong).into_raw();
1408     ///
1409     /// assert_eq!(2, Arc::weak_count(&strong));
1410     ///
1411     /// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
1412     /// assert_eq!(1, Arc::weak_count(&strong));
1413     ///
1414     /// drop(strong);
1415     ///
1416     /// // Decrement the last weak count.
1417     /// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
1418     /// ```
1419     ///
1420     /// [`as_raw`]: struct.Weak.html#method.as_raw
1421     /// [`new`]: struct.Weak.html#method.new
1422     /// [`into_raw`]: struct.Weak.html#method.into_raw
1423     /// [`upgrade`]: struct.Weak.html#method.upgrade
1424     /// [`Weak`]: struct.Weak.html
1425     /// [`Arc`]: struct.Arc.html
1426     /// [`forget`]: ../../std/mem/fn.forget.html
1427     #[unstable(feature = "weak_into_raw", issue = "60728")]
1428     pub unsafe fn from_raw(ptr: *const T) -> Self {
1429         if ptr.is_null() {
1430             Self::new()
1431         } else {
1432             // See Arc::from_raw for details
1433             let offset = data_offset(ptr);
1434             let fake_ptr = ptr as *mut ArcInner<T>;
1435             let ptr = set_data_ptr(fake_ptr, (ptr as *mut u8).offset(-offset));
1436             Weak { ptr: NonNull::new(ptr).expect("Invalid pointer passed to from_raw") }
1437         }
1438     }
1439 }
1440
1441 impl<T: ?Sized> Weak<T> {
1442     /// Attempts to upgrade the `Weak` pointer to an [`Arc`], delaying
1443     /// dropping of the inner value if successful.
1444     ///
1445     /// Returns [`None`] if the inner value has since been dropped.
1446     ///
1447     /// [`Arc`]: struct.Arc.html
1448     /// [`None`]: ../../std/option/enum.Option.html#variant.None
1449     ///
1450     /// # Examples
1451     ///
1452     /// ```
1453     /// use std::sync::Arc;
1454     ///
1455     /// let five = Arc::new(5);
1456     ///
1457     /// let weak_five = Arc::downgrade(&five);
1458     ///
1459     /// let strong_five: Option<Arc<_>> = weak_five.upgrade();
1460     /// assert!(strong_five.is_some());
1461     ///
1462     /// // Destroy all strong pointers.
1463     /// drop(strong_five);
1464     /// drop(five);
1465     ///
1466     /// assert!(weak_five.upgrade().is_none());
1467     /// ```
1468     #[stable(feature = "arc_weak", since = "1.4.0")]
1469     pub fn upgrade(&self) -> Option<Arc<T>> {
1470         // We use a CAS loop to increment the strong count instead of a
1471         // fetch_add because once the count hits 0 it must never be above 0.
1472         let inner = self.inner()?;
1473
1474         // Relaxed load because any write of 0 that we can observe
1475         // leaves the field in a permanently zero state (so a
1476         // "stale" read of 0 is fine), and any other value is
1477         // confirmed via the CAS below.
1478         let mut n = inner.strong.load(Relaxed);
1479
1480         loop {
1481             if n == 0 {
1482                 return None;
1483             }
1484
1485             // See comments in `Arc::clone` for why we do this (for `mem::forget`).
1486             if n > MAX_REFCOUNT {
1487                 unsafe {
1488                     abort();
1489                 }
1490             }
1491
1492             // Relaxed is valid for the same reason it is on Arc's Clone impl
1493             match inner.strong.compare_exchange_weak(n, n + 1, Relaxed, Relaxed) {
1494                 Ok(_) => return Some(Arc::from_inner(self.ptr)), // null checked above
1495                 Err(old) => n = old,
1496             }
1497         }
1498     }
1499
1500     /// Gets the number of strong (`Arc`) pointers pointing to this allocation.
1501     ///
1502     /// If `self` was created using [`Weak::new`], this will return 0.
1503     ///
1504     /// [`Weak::new`]: #method.new
1505     #[stable(feature = "weak_counts", since = "1.41.0")]
1506     pub fn strong_count(&self) -> usize {
1507         if let Some(inner) = self.inner() { inner.strong.load(SeqCst) } else { 0 }
1508     }
1509
1510     /// Gets an approximation of the number of `Weak` pointers pointing to this
1511     /// allocation.
1512     ///
1513     /// If `self` was created using [`Weak::new`], or if there are no remaining
1514     /// strong pointers, this will return 0.
1515     ///
1516     /// # Accuracy
1517     ///
1518     /// Due to implementation details, the returned value can be off by 1 in
1519     /// either direction when other threads are manipulating any `Arc`s or
1520     /// `Weak`s pointing to the same allocation.
1521     ///
1522     /// [`Weak::new`]: #method.new
1523     #[stable(feature = "weak_counts", since = "1.41.0")]
1524     pub fn weak_count(&self) -> usize {
1525         self.inner()
1526             .map(|inner| {
1527                 let weak = inner.weak.load(SeqCst);
1528                 let strong = inner.strong.load(SeqCst);
1529                 if strong == 0 {
1530                     0
1531                 } else {
1532                     // Since we observed that there was at least one strong pointer
1533                     // after reading the weak count, we know that the implicit weak
1534                     // reference (present whenever any strong references are alive)
1535                     // was still around when we observed the weak count, and can
1536                     // therefore safely subtract it.
1537                     weak - 1
1538                 }
1539             })
1540             .unwrap_or(0)
1541     }
1542
1543     /// Returns `None` when the pointer is dangling and there is no allocated `ArcInner`,
1544     /// (i.e., when this `Weak` was created by `Weak::new`).
1545     #[inline]
1546     fn inner(&self) -> Option<&ArcInner<T>> {
1547         if is_dangling(self.ptr) { None } else { Some(unsafe { self.ptr.as_ref() }) }
1548     }
1549
1550     /// Returns `true` if the two `Weak`s point to the same allocation (similar to
1551     /// [`ptr::eq`]), or if both don't point to any allocation
1552     /// (because they were created with `Weak::new()`).
1553     ///
1554     /// # Notes
1555     ///
1556     /// Since this compares pointers it means that `Weak::new()` will equal each
1557     /// other, even though they don't point to any allocation.
1558     ///
1559     /// # Examples
1560     ///
1561     /// ```
1562     /// use std::sync::Arc;
1563     ///
1564     /// let first_rc = Arc::new(5);
1565     /// let first = Arc::downgrade(&first_rc);
1566     /// let second = Arc::downgrade(&first_rc);
1567     ///
1568     /// assert!(first.ptr_eq(&second));
1569     ///
1570     /// let third_rc = Arc::new(5);
1571     /// let third = Arc::downgrade(&third_rc);
1572     ///
1573     /// assert!(!first.ptr_eq(&third));
1574     /// ```
1575     ///
1576     /// Comparing `Weak::new`.
1577     ///
1578     /// ```
1579     /// use std::sync::{Arc, Weak};
1580     ///
1581     /// let first = Weak::new();
1582     /// let second = Weak::new();
1583     /// assert!(first.ptr_eq(&second));
1584     ///
1585     /// let third_rc = Arc::new(());
1586     /// let third = Arc::downgrade(&third_rc);
1587     /// assert!(!first.ptr_eq(&third));
1588     /// ```
1589     ///
1590     /// [`ptr::eq`]: ../../std/ptr/fn.eq.html
1591     #[inline]
1592     #[stable(feature = "weak_ptr_eq", since = "1.39.0")]
1593     pub fn ptr_eq(&self, other: &Self) -> bool {
1594         self.ptr.as_ptr() == other.ptr.as_ptr()
1595     }
1596 }
1597
1598 #[stable(feature = "arc_weak", since = "1.4.0")]
1599 impl<T: ?Sized> Clone for Weak<T> {
1600     /// Makes a clone of the `Weak` pointer that points to the same allocation.
1601     ///
1602     /// # Examples
1603     ///
1604     /// ```
1605     /// use std::sync::{Arc, Weak};
1606     ///
1607     /// let weak_five = Arc::downgrade(&Arc::new(5));
1608     ///
1609     /// let _ = Weak::clone(&weak_five);
1610     /// ```
1611     #[inline]
1612     fn clone(&self) -> Weak<T> {
1613         let inner = if let Some(inner) = self.inner() {
1614             inner
1615         } else {
1616             return Weak { ptr: self.ptr };
1617         };
1618         // See comments in Arc::clone() for why this is relaxed.  This can use a
1619         // fetch_add (ignoring the lock) because the weak count is only locked
1620         // where are *no other* weak pointers in existence. (So we can't be
1621         // running this code in that case).
1622         let old_size = inner.weak.fetch_add(1, Relaxed);
1623
1624         // See comments in Arc::clone() for why we do this (for mem::forget).
1625         if old_size > MAX_REFCOUNT {
1626             unsafe {
1627                 abort();
1628             }
1629         }
1630
1631         Weak { ptr: self.ptr }
1632     }
1633 }
1634
1635 #[stable(feature = "downgraded_weak", since = "1.10.0")]
1636 impl<T> Default for Weak<T> {
1637     /// Constructs a new `Weak<T>`, without allocating memory.
1638     /// Calling [`upgrade`] on the return value always
1639     /// gives [`None`].
1640     ///
1641     /// [`None`]: ../../std/option/enum.Option.html#variant.None
1642     /// [`upgrade`]: ../../std/sync/struct.Weak.html#method.upgrade
1643     ///
1644     /// # Examples
1645     ///
1646     /// ```
1647     /// use std::sync::Weak;
1648     ///
1649     /// let empty: Weak<i64> = Default::default();
1650     /// assert!(empty.upgrade().is_none());
1651     /// ```
1652     fn default() -> Weak<T> {
1653         Weak::new()
1654     }
1655 }
1656
1657 #[stable(feature = "arc_weak", since = "1.4.0")]
1658 impl<T: ?Sized> Drop for Weak<T> {
1659     /// Drops the `Weak` pointer.
1660     ///
1661     /// # Examples
1662     ///
1663     /// ```
1664     /// use std::sync::{Arc, Weak};
1665     ///
1666     /// struct Foo;
1667     ///
1668     /// impl Drop for Foo {
1669     ///     fn drop(&mut self) {
1670     ///         println!("dropped!");
1671     ///     }
1672     /// }
1673     ///
1674     /// let foo = Arc::new(Foo);
1675     /// let weak_foo = Arc::downgrade(&foo);
1676     /// let other_weak_foo = Weak::clone(&weak_foo);
1677     ///
1678     /// drop(weak_foo);   // Doesn't print anything
1679     /// drop(foo);        // Prints "dropped!"
1680     ///
1681     /// assert!(other_weak_foo.upgrade().is_none());
1682     /// ```
1683     fn drop(&mut self) {
1684         // If we find out that we were the last weak pointer, then its time to
1685         // deallocate the data entirely. See the discussion in Arc::drop() about
1686         // the memory orderings
1687         //
1688         // It's not necessary to check for the locked state here, because the
1689         // weak count can only be locked if there was precisely one weak ref,
1690         // meaning that drop could only subsequently run ON that remaining weak
1691         // ref, which can only happen after the lock is released.
1692         let inner = if let Some(inner) = self.inner() { inner } else { return };
1693
1694         if inner.weak.fetch_sub(1, Release) == 1 {
1695             atomic::fence(Acquire);
1696             unsafe { Global.dealloc(self.ptr.cast(), Layout::for_value(self.ptr.as_ref())) }
1697         }
1698     }
1699 }
1700
1701 #[stable(feature = "rust1", since = "1.0.0")]
1702 trait ArcEqIdent<T: ?Sized + PartialEq> {
1703     fn eq(&self, other: &Arc<T>) -> bool;
1704     fn ne(&self, other: &Arc<T>) -> bool;
1705 }
1706
1707 #[stable(feature = "rust1", since = "1.0.0")]
1708 impl<T: ?Sized + PartialEq> ArcEqIdent<T> for Arc<T> {
1709     #[inline]
1710     default fn eq(&self, other: &Arc<T>) -> bool {
1711         **self == **other
1712     }
1713     #[inline]
1714     default fn ne(&self, other: &Arc<T>) -> bool {
1715         **self != **other
1716     }
1717 }
1718
1719 /// We're doing this specialization here, and not as a more general optimization on `&T`, because it
1720 /// would otherwise add a cost to all equality checks on refs. We assume that `Arc`s are used to
1721 /// store large values, that are slow to clone, but also heavy to check for equality, causing this
1722 /// cost to pay off more easily. It's also more likely to have two `Arc` clones, that point to
1723 /// the same value, than two `&T`s.
1724 ///
1725 /// We can only do this when `T: Eq` as a `PartialEq` might be deliberately irreflexive.
1726 #[stable(feature = "rust1", since = "1.0.0")]
1727 impl<T: ?Sized + Eq> ArcEqIdent<T> for Arc<T> {
1728     #[inline]
1729     fn eq(&self, other: &Arc<T>) -> bool {
1730         Arc::ptr_eq(self, other) || **self == **other
1731     }
1732
1733     #[inline]
1734     fn ne(&self, other: &Arc<T>) -> bool {
1735         !Arc::ptr_eq(self, other) && **self != **other
1736     }
1737 }
1738
1739 #[stable(feature = "rust1", since = "1.0.0")]
1740 impl<T: ?Sized + PartialEq> PartialEq for Arc<T> {
1741     /// Equality for two `Arc`s.
1742     ///
1743     /// Two `Arc`s are equal if their inner values are equal, even if they are
1744     /// stored in different allocation.
1745     ///
1746     /// If `T` also implements `Eq` (implying reflexivity of equality),
1747     /// two `Arc`s that point to the same allocation are always equal.
1748     ///
1749     /// # Examples
1750     ///
1751     /// ```
1752     /// use std::sync::Arc;
1753     ///
1754     /// let five = Arc::new(5);
1755     ///
1756     /// assert!(five == Arc::new(5));
1757     /// ```
1758     #[inline]
1759     fn eq(&self, other: &Arc<T>) -> bool {
1760         ArcEqIdent::eq(self, other)
1761     }
1762
1763     /// Inequality for two `Arc`s.
1764     ///
1765     /// Two `Arc`s are unequal if their inner values are unequal.
1766     ///
1767     /// If `T` also implements `Eq` (implying reflexivity of equality),
1768     /// two `Arc`s that point to the same value are never unequal.
1769     ///
1770     /// # Examples
1771     ///
1772     /// ```
1773     /// use std::sync::Arc;
1774     ///
1775     /// let five = Arc::new(5);
1776     ///
1777     /// assert!(five != Arc::new(6));
1778     /// ```
1779     #[inline]
1780     fn ne(&self, other: &Arc<T>) -> bool {
1781         ArcEqIdent::ne(self, other)
1782     }
1783 }
1784
1785 #[stable(feature = "rust1", since = "1.0.0")]
1786 impl<T: ?Sized + PartialOrd> PartialOrd for Arc<T> {
1787     /// Partial comparison for two `Arc`s.
1788     ///
1789     /// The two are compared by calling `partial_cmp()` on their inner values.
1790     ///
1791     /// # Examples
1792     ///
1793     /// ```
1794     /// use std::sync::Arc;
1795     /// use std::cmp::Ordering;
1796     ///
1797     /// let five = Arc::new(5);
1798     ///
1799     /// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Arc::new(6)));
1800     /// ```
1801     fn partial_cmp(&self, other: &Arc<T>) -> Option<Ordering> {
1802         (**self).partial_cmp(&**other)
1803     }
1804
1805     /// Less-than comparison for two `Arc`s.
1806     ///
1807     /// The two are compared by calling `<` on their inner values.
1808     ///
1809     /// # Examples
1810     ///
1811     /// ```
1812     /// use std::sync::Arc;
1813     ///
1814     /// let five = Arc::new(5);
1815     ///
1816     /// assert!(five < Arc::new(6));
1817     /// ```
1818     fn lt(&self, other: &Arc<T>) -> bool {
1819         *(*self) < *(*other)
1820     }
1821
1822     /// 'Less than or equal to' comparison for two `Arc`s.
1823     ///
1824     /// The two are compared by calling `<=` on their inner values.
1825     ///
1826     /// # Examples
1827     ///
1828     /// ```
1829     /// use std::sync::Arc;
1830     ///
1831     /// let five = Arc::new(5);
1832     ///
1833     /// assert!(five <= Arc::new(5));
1834     /// ```
1835     fn le(&self, other: &Arc<T>) -> bool {
1836         *(*self) <= *(*other)
1837     }
1838
1839     /// Greater-than comparison for two `Arc`s.
1840     ///
1841     /// The two are compared by calling `>` on their inner values.
1842     ///
1843     /// # Examples
1844     ///
1845     /// ```
1846     /// use std::sync::Arc;
1847     ///
1848     /// let five = Arc::new(5);
1849     ///
1850     /// assert!(five > Arc::new(4));
1851     /// ```
1852     fn gt(&self, other: &Arc<T>) -> bool {
1853         *(*self) > *(*other)
1854     }
1855
1856     /// 'Greater than or equal to' comparison for two `Arc`s.
1857     ///
1858     /// The two are compared by calling `>=` on their inner values.
1859     ///
1860     /// # Examples
1861     ///
1862     /// ```
1863     /// use std::sync::Arc;
1864     ///
1865     /// let five = Arc::new(5);
1866     ///
1867     /// assert!(five >= Arc::new(5));
1868     /// ```
1869     fn ge(&self, other: &Arc<T>) -> bool {
1870         *(*self) >= *(*other)
1871     }
1872 }
1873 #[stable(feature = "rust1", since = "1.0.0")]
1874 impl<T: ?Sized + Ord> Ord for Arc<T> {
1875     /// Comparison for two `Arc`s.
1876     ///
1877     /// The two are compared by calling `cmp()` on their inner values.
1878     ///
1879     /// # Examples
1880     ///
1881     /// ```
1882     /// use std::sync::Arc;
1883     /// use std::cmp::Ordering;
1884     ///
1885     /// let five = Arc::new(5);
1886     ///
1887     /// assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));
1888     /// ```
1889     fn cmp(&self, other: &Arc<T>) -> Ordering {
1890         (**self).cmp(&**other)
1891     }
1892 }
1893 #[stable(feature = "rust1", since = "1.0.0")]
1894 impl<T: ?Sized + Eq> Eq for Arc<T> {}
1895
1896 #[stable(feature = "rust1", since = "1.0.0")]
1897 impl<T: ?Sized + fmt::Display> fmt::Display for Arc<T> {
1898     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1899         fmt::Display::fmt(&**self, f)
1900     }
1901 }
1902
1903 #[stable(feature = "rust1", since = "1.0.0")]
1904 impl<T: ?Sized + fmt::Debug> fmt::Debug for Arc<T> {
1905     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1906         fmt::Debug::fmt(&**self, f)
1907     }
1908 }
1909
1910 #[stable(feature = "rust1", since = "1.0.0")]
1911 impl<T: ?Sized> fmt::Pointer for Arc<T> {
1912     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1913         fmt::Pointer::fmt(&(&**self as *const T), f)
1914     }
1915 }
1916
1917 #[stable(feature = "rust1", since = "1.0.0")]
1918 impl<T: Default> Default for Arc<T> {
1919     /// Creates a new `Arc<T>`, with the `Default` value for `T`.
1920     ///
1921     /// # Examples
1922     ///
1923     /// ```
1924     /// use std::sync::Arc;
1925     ///
1926     /// let x: Arc<i32> = Default::default();
1927     /// assert_eq!(*x, 0);
1928     /// ```
1929     fn default() -> Arc<T> {
1930         Arc::new(Default::default())
1931     }
1932 }
1933
1934 #[stable(feature = "rust1", since = "1.0.0")]
1935 impl<T: ?Sized + Hash> Hash for Arc<T> {
1936     fn hash<H: Hasher>(&self, state: &mut H) {
1937         (**self).hash(state)
1938     }
1939 }
1940
1941 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
1942 impl<T> From<T> for Arc<T> {
1943     fn from(t: T) -> Self {
1944         Arc::new(t)
1945     }
1946 }
1947
1948 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1949 impl<T: Clone> From<&[T]> for Arc<[T]> {
1950     #[inline]
1951     fn from(v: &[T]) -> Arc<[T]> {
1952         <Self as ArcFromSlice<T>>::from_slice(v)
1953     }
1954 }
1955
1956 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1957 impl From<&str> for Arc<str> {
1958     #[inline]
1959     fn from(v: &str) -> Arc<str> {
1960         let arc = Arc::<[u8]>::from(v.as_bytes());
1961         unsafe { Arc::from_raw(Arc::into_raw(arc) as *const str) }
1962     }
1963 }
1964
1965 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1966 impl From<String> for Arc<str> {
1967     #[inline]
1968     fn from(v: String) -> Arc<str> {
1969         Arc::from(&v[..])
1970     }
1971 }
1972
1973 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1974 impl<T: ?Sized> From<Box<T>> for Arc<T> {
1975     #[inline]
1976     fn from(v: Box<T>) -> Arc<T> {
1977         Arc::from_box(v)
1978     }
1979 }
1980
1981 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1982 impl<T> From<Vec<T>> for Arc<[T]> {
1983     #[inline]
1984     fn from(mut v: Vec<T>) -> Arc<[T]> {
1985         unsafe {
1986             let arc = Arc::copy_from_slice(&v);
1987
1988             // Allow the Vec to free its memory, but not destroy its contents
1989             v.set_len(0);
1990
1991             arc
1992         }
1993     }
1994 }
1995
1996 #[unstable(feature = "boxed_slice_try_from", issue = "none")]
1997 impl<T, const N: usize> TryFrom<Arc<[T]>> for Arc<[T; N]>
1998 where
1999     [T; N]: LengthAtMost32,
2000 {
2001     type Error = Arc<[T]>;
2002
2003     fn try_from(boxed_slice: Arc<[T]>) -> Result<Self, Self::Error> {
2004         if boxed_slice.len() == N {
2005             Ok(unsafe { Arc::from_raw(Arc::into_raw(boxed_slice) as *mut [T; N]) })
2006         } else {
2007             Err(boxed_slice)
2008         }
2009     }
2010 }
2011
2012 #[stable(feature = "shared_from_iter", since = "1.37.0")]
2013 impl<T> iter::FromIterator<T> for Arc<[T]> {
2014     /// Takes each element in the `Iterator` and collects it into an `Arc<[T]>`.
2015     ///
2016     /// # Performance characteristics
2017     ///
2018     /// ## The general case
2019     ///
2020     /// In the general case, collecting into `Arc<[T]>` is done by first
2021     /// collecting into a `Vec<T>`. That is, when writing the following:
2022     ///
2023     /// ```rust
2024     /// # use std::sync::Arc;
2025     /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
2026     /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2027     /// ```
2028     ///
2029     /// this behaves as if we wrote:
2030     ///
2031     /// ```rust
2032     /// # use std::sync::Arc;
2033     /// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
2034     ///     .collect::<Vec<_>>() // The first set of allocations happens here.
2035     ///     .into(); // A second allocation for `Arc<[T]>` happens here.
2036     /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2037     /// ```
2038     ///
2039     /// This will allocate as many times as needed for constructing the `Vec<T>`
2040     /// and then it will allocate once for turning the `Vec<T>` into the `Arc<[T]>`.
2041     ///
2042     /// ## Iterators of known length
2043     ///
2044     /// When your `Iterator` implements `TrustedLen` and is of an exact size,
2045     /// a single allocation will be made for the `Arc<[T]>`. For example:
2046     ///
2047     /// ```rust
2048     /// # use std::sync::Arc;
2049     /// let evens: Arc<[u8]> = (0..10).collect(); // Just a single allocation happens here.
2050     /// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
2051     /// ```
2052     fn from_iter<I: iter::IntoIterator<Item = T>>(iter: I) -> Self {
2053         ArcFromIter::from_iter(iter.into_iter())
2054     }
2055 }
2056
2057 /// Specialization trait used for collecting into `Arc<[T]>`.
2058 trait ArcFromIter<T, I> {
2059     fn from_iter(iter: I) -> Self;
2060 }
2061
2062 impl<T, I: Iterator<Item = T>> ArcFromIter<T, I> for Arc<[T]> {
2063     default fn from_iter(iter: I) -> Self {
2064         iter.collect::<Vec<T>>().into()
2065     }
2066 }
2067
2068 impl<T, I: iter::TrustedLen<Item = T>> ArcFromIter<T, I> for Arc<[T]> {
2069     default fn from_iter(iter: I) -> Self {
2070         // This is the case for a `TrustedLen` iterator.
2071         let (low, high) = iter.size_hint();
2072         if let Some(high) = high {
2073             debug_assert_eq!(
2074                 low,
2075                 high,
2076                 "TrustedLen iterator's size hint is not exact: {:?}",
2077                 (low, high)
2078             );
2079
2080             unsafe {
2081                 // SAFETY: We need to ensure that the iterator has an exact length and we have.
2082                 Arc::from_iter_exact(iter, low)
2083             }
2084         } else {
2085             // Fall back to normal implementation.
2086             iter.collect::<Vec<T>>().into()
2087         }
2088     }
2089 }
2090
2091 impl<'a, T: 'a + Clone> ArcFromIter<&'a T, slice::Iter<'a, T>> for Arc<[T]> {
2092     fn from_iter(iter: slice::Iter<'a, T>) -> Self {
2093         // Delegate to `impl<T: Clone> From<&[T]> for Arc<[T]>`.
2094         //
2095         // In the case that `T: Copy`, we get to use `ptr::copy_nonoverlapping`
2096         // which is even more performant.
2097         //
2098         // In the fall-back case we have `T: Clone`. This is still better
2099         // than the `TrustedLen` implementation as slices have a known length
2100         // and so we get to avoid calling `size_hint` and avoid the branching.
2101         iter.as_slice().into()
2102     }
2103 }
2104
2105 #[stable(feature = "rust1", since = "1.0.0")]
2106 impl<T: ?Sized> borrow::Borrow<T> for Arc<T> {
2107     fn borrow(&self) -> &T {
2108         &**self
2109     }
2110 }
2111
2112 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
2113 impl<T: ?Sized> AsRef<T> for Arc<T> {
2114     fn as_ref(&self) -> &T {
2115         &**self
2116     }
2117 }
2118
2119 #[stable(feature = "pin", since = "1.33.0")]
2120 impl<T: ?Sized> Unpin for Arc<T> {}
2121
2122 /// Computes the offset of the data field within `ArcInner`.
2123 unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> isize {
2124     // Align the unsized value to the end of the `ArcInner`.
2125     // Because it is `?Sized`, it will always be the last field in memory.
2126     // Note: This is a detail of the current implementation of the compiler,
2127     // and is not a guaranteed language detail. Do not rely on it outside of std.
2128     data_offset_align(align_of_val(&*ptr))
2129 }
2130
2131 /// Computes the offset of the data field within `ArcInner`.
2132 ///
2133 /// Unlike [`data_offset`], this doesn't need the pointer, but it works only on `T: Sized`.
2134 fn data_offset_sized<T>() -> isize {
2135     data_offset_align(align_of::<T>())
2136 }
2137
2138 #[inline]
2139 fn data_offset_align(align: usize) -> isize {
2140     let layout = Layout::new::<ArcInner<()>>();
2141     (layout.size() + layout.padding_needed_for(align)) as isize
2142 }