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