Rollup merge of #23844 - kvark:try_unique, r=alexcrichton
While trying to implement parallel ECS processing, I stumbled upon the need to mutate `Arc` contents. The only existed method that allowed that was `make_unique`, but it has issues: - it may clone the data as if nothing happened, where the program may just need to crash - it forces `Clone` bound, which I don't have The new `try_unique` allows accessing the contents mutably without `Clone` bound and error out if the pointer is not unique.
This commit is contained in:
@@ -242,6 +242,38 @@ pub fn weak_count<T>(this: &Arc<T>) -> usize { this.inner().weak.load(SeqCst) -
|
|||||||
#[unstable(feature = "alloc")]
|
#[unstable(feature = "alloc")]
|
||||||
pub fn strong_count<T>(this: &Arc<T>) -> usize { this.inner().strong.load(SeqCst) }
|
pub fn strong_count<T>(this: &Arc<T>) -> usize { this.inner().strong.load(SeqCst) }
|
||||||
|
|
||||||
|
|
||||||
|
/// Try accessing a mutable reference to the contents behind an unique `Arc<T>`.
|
||||||
|
///
|
||||||
|
/// The access is granted only if this is the only reference to the object.
|
||||||
|
/// Otherwise, `None` is returned.
|
||||||
|
///
|
||||||
|
/// # Examples
|
||||||
|
///
|
||||||
|
/// ```
|
||||||
|
/// # #![feature(alloc)]
|
||||||
|
/// use std::alloc::arc;
|
||||||
|
///
|
||||||
|
/// let mut four = arc::Arc::new(4);
|
||||||
|
///
|
||||||
|
/// arc::unique(&mut four).map(|num| *num = 5);
|
||||||
|
/// ```
|
||||||
|
#[inline]
|
||||||
|
#[unstable(feature = "alloc")]
|
||||||
|
pub fn unique<T>(this: &mut Arc<T>) -> Option<&mut T> {
|
||||||
|
if strong_count(this) == 1 && weak_count(this) == 0 {
|
||||||
|
// This unsafety is ok because we're guaranteed that the pointer
|
||||||
|
// returned is the *only* pointer that will ever be returned to T. Our
|
||||||
|
// reference count is guaranteed to be 1 at this point, and we required
|
||||||
|
// the Arc itself to be `mut`, so we're returning the only possible
|
||||||
|
// reference to the inner data.
|
||||||
|
let inner = unsafe { &mut **this._ptr };
|
||||||
|
Some(&mut inner.data)
|
||||||
|
}else {
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
impl<T> Clone for Arc<T> {
|
impl<T> Clone for Arc<T> {
|
||||||
/// Makes a clone of the `Arc<T>`.
|
/// Makes a clone of the `Arc<T>`.
|
||||||
@@ -312,11 +344,8 @@ impl<T: Send + Sync + Clone> Arc<T> {
|
|||||||
self.inner().weak.load(SeqCst) != 1 {
|
self.inner().weak.load(SeqCst) != 1 {
|
||||||
*self = Arc::new((**self).clone())
|
*self = Arc::new((**self).clone())
|
||||||
}
|
}
|
||||||
// This unsafety is ok because we're guaranteed that the pointer
|
// As with `unique()`, the unsafety is ok because our reference was
|
||||||
// returned is the *only* pointer that will ever be returned to T. Our
|
// either unique to begin with, or became one upon cloning the contents.
|
||||||
// reference count is guaranteed to be 1 at this point, and we required
|
|
||||||
// the Arc itself to be `mut`, so we're returning the only possible
|
|
||||||
// reference to the inner data.
|
|
||||||
let inner = unsafe { &mut **self._ptr };
|
let inner = unsafe { &mut **self._ptr };
|
||||||
&mut inner.data
|
&mut inner.data
|
||||||
}
|
}
|
||||||
@@ -659,7 +688,7 @@ mod tests {
|
|||||||
use std::sync::atomic::Ordering::{Acquire, SeqCst};
|
use std::sync::atomic::Ordering::{Acquire, SeqCst};
|
||||||
use std::thread;
|
use std::thread;
|
||||||
use std::vec::Vec;
|
use std::vec::Vec;
|
||||||
use super::{Arc, Weak, weak_count, strong_count};
|
use super::{Arc, Weak, weak_count, strong_count, unique};
|
||||||
use std::sync::Mutex;
|
use std::sync::Mutex;
|
||||||
|
|
||||||
struct Canary(*mut atomic::AtomicUsize);
|
struct Canary(*mut atomic::AtomicUsize);
|
||||||
@@ -695,6 +724,21 @@ mod tests {
|
|||||||
assert_eq!((*arc_v)[4], 5);
|
assert_eq!((*arc_v)[4], 5);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_arc_unique() {
|
||||||
|
let mut x = Arc::new(10);
|
||||||
|
assert!(unique(&mut x).is_some());
|
||||||
|
{
|
||||||
|
let y = x.clone();
|
||||||
|
assert!(unique(&mut x).is_none());
|
||||||
|
}
|
||||||
|
{
|
||||||
|
let z = x.downgrade();
|
||||||
|
assert!(unique(&mut x).is_none());
|
||||||
|
}
|
||||||
|
assert!(unique(&mut x).is_some());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_cowarc_clone_make_unique() {
|
fn test_cowarc_clone_make_unique() {
|
||||||
let mut cow0 = Arc::new(75);
|
let mut cow0 = Arc::new(75);
|
||||||
|
|||||||
Reference in New Issue
Block a user