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