2015-01-24 05:48:20 +00:00
|
|
|
|
#![stable(feature = "rust1", since = "1.0.0")]
|
std: Stabilize unit, bool, ty, tuple, arc, any
This commit applies stability attributes to the contents of these modules,
summarized here:
* The `unit` and `bool` modules have become #[unstable] as they are purely meant
for documentation purposes and are candidates for removal.
* The `ty` module has been deprecated, and the inner `Unsafe` type has been
renamed to `UnsafeCell` and moved to the `cell` module. The `marker1` field
has been removed as the compiler now always infers `UnsafeCell` to be
invariant. The `new` method i stable, but the `value` field, `get` and
`unwrap` methods are all unstable.
* The `tuple` module has its name as stable, the naming of the `TupleN` traits
as stable while the methods are all #[unstable]. The other impls in the module
have appropriate stability for the corresponding trait.
* The `arc` module has received the exact same treatment as the `rc` module
previously did.
* The `any` module has its name as stable. The `Any` trait is also stable, with
a new private supertrait which now contains the `get_type_id` method. This is
to make the method a private implementation detail rather than a public-facing
detail.
The two extension traits in the module are marked #[unstable] as they will not
be necessary with DST. The `is` method is #[stable], the as_{mut,ref} methods
have been renamed to downcast_{mut,ref} and are #[unstable].
The extension trait `BoxAny` has been clarified as to why it is unstable as it
will not be necessary with DST.
This is a breaking change because the `marker1` field was removed from the
`UnsafeCell` type. To deal with this change, you can simply delete the field and
only specify the value of the `data` field in static initializers.
[breaking-change]
2014-07-24 02:10:12 +00:00
|
|
|
|
|
2016-09-21 17:24:45 +00:00
|
|
|
|
//! Thread-safe reference-counting pointers.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
//!
|
2020-08-20 21:43:46 +00:00
|
|
|
|
//! See the [`Arc<T>`][Arc] documentation for more details.
|
2022-06-18 02:46:01 +00:00
|
|
|
|
//!
|
|
|
|
|
//! **Note**: This module is only available on platforms that support atomic
|
|
|
|
|
//! loads and stores of pointers. This may be detected at compile time using
|
|
|
|
|
//! `#[cfg(target_has_atomic = "ptr")]`.
|
2012-08-10 22:20:03 +00:00
|
|
|
|
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use core::any::Any;
|
|
|
|
|
use core::borrow;
|
2019-11-21 19:48:39 +00:00
|
|
|
|
use core::cmp::Ordering;
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use core::fmt;
|
|
|
|
|
use core::hash::{Hash, Hasher};
|
2020-09-12 16:53:30 +00:00
|
|
|
|
use core::hint;
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use core::intrinsics::abort;
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use core::iter;
|
2022-08-09 00:14:43 +00:00
|
|
|
|
use core::marker::{PhantomData, Unsize};
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
use core::mem::size_of_val;
|
|
|
|
|
use core::mem::{self, align_of_val_raw};
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use core::ops::{CoerceUnsized, Deref, DispatchFromDyn, Receiver};
|
2021-07-31 10:57:49 +00:00
|
|
|
|
use core::panic::{RefUnwindSafe, UnwindSafe};
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use core::pin::Pin;
|
|
|
|
|
use core::ptr::{self, NonNull};
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2020-04-19 11:34:00 +00:00
|
|
|
|
use core::slice::from_raw_parts_mut;
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use core::sync::atomic;
|
2022-03-21 21:32:00 +00:00
|
|
|
|
use core::sync::atomic::Ordering::{Acquire, Relaxed, Release};
|
2019-02-03 07:27:44 +00:00
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
use crate::alloc::handle_alloc_error;
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2022-08-01 20:51:58 +00:00
|
|
|
|
use crate::alloc::WriteCloneIntoRaw;
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
use crate::alloc::{AllocError, Allocator, Global, Layout};
|
2020-04-22 20:33:42 +00:00
|
|
|
|
use crate::borrow::{Cow, ToOwned};
|
2021-01-12 20:24:28 +00:00
|
|
|
|
use crate::boxed::Box;
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use crate::rc::is_dangling;
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use crate::string::String;
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-02-03 07:27:44 +00:00
|
|
|
|
use crate::vec::Vec;
|
2014-03-22 07:53:58 +00:00
|
|
|
|
|
2019-08-01 22:40:56 +00:00
|
|
|
|
#[cfg(test)]
|
|
|
|
|
mod tests;
|
|
|
|
|
|
2016-11-04 21:50:54 +00:00
|
|
|
|
/// A soft limit on the amount of references that may be made to an `Arc`.
|
|
|
|
|
///
|
|
|
|
|
/// Going above this limit will abort your program (although not
|
|
|
|
|
/// necessarily) at _exactly_ `MAX_REFCOUNT + 1` references.
|
2023-03-03 19:35:47 +00:00
|
|
|
|
/// Trying to go above it might call a `panic` (if not actually going above it).
|
|
|
|
|
///
|
|
|
|
|
/// This is a global invariant, and also applies when using a compare-exchange loop.
|
|
|
|
|
///
|
|
|
|
|
/// See comment in `Arc::clone`.
|
2015-07-21 00:09:44 +00:00
|
|
|
|
const MAX_REFCOUNT: usize = (isize::MAX) as usize;
|
|
|
|
|
|
2023-03-03 19:35:47 +00:00
|
|
|
|
/// The error in case either counter reaches above `MAX_REFCOUNT`, and we can `panic` safely.
|
|
|
|
|
const INTERNAL_OVERFLOW_ERROR: &str = "Arc counter overflow";
|
|
|
|
|
|
2020-03-20 00:00:00 +00:00
|
|
|
|
#[cfg(not(sanitize = "thread"))]
|
|
|
|
|
macro_rules! acquire {
|
|
|
|
|
($x:expr) => {
|
|
|
|
|
atomic::fence(Acquire)
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// ThreadSanitizer does not support memory fences. To avoid false positive
|
|
|
|
|
// reports in Arc / Weak implementation use atomic loads for synchronization
|
|
|
|
|
// instead.
|
|
|
|
|
#[cfg(sanitize = "thread")]
|
|
|
|
|
macro_rules! acquire {
|
|
|
|
|
($x:expr) => {
|
|
|
|
|
$x.load(Acquire)
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2017-06-05 19:07:54 +00:00
|
|
|
|
/// A thread-safe reference-counting pointer. 'Arc' stands for 'Atomically
|
|
|
|
|
/// Reference Counted'.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// The type `Arc<T>` provides shared ownership of a value of type `T`,
|
|
|
|
|
/// allocated in the heap. Invoking [`clone`][clone] on `Arc` produces
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// a new `Arc` instance, which points to the same allocation on the heap as the
|
2018-08-30 09:20:41 +00:00
|
|
|
|
/// source `Arc`, while increasing a reference count. When the last `Arc`
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// pointer to a given allocation is destroyed, the value stored in that allocation (often
|
|
|
|
|
/// referred to as "inner value") is also dropped.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Shared references in Rust disallow mutation by default, and `Arc` is no
|
2017-10-05 20:54:56 +00:00
|
|
|
|
/// exception: you cannot generally obtain a mutable reference to something
|
|
|
|
|
/// inside an `Arc`. If you need to mutate through an `Arc`, use
|
|
|
|
|
/// [`Mutex`][mutex], [`RwLock`][rwlock], or one of the [`Atomic`][atomic]
|
|
|
|
|
/// types.
|
2016-08-06 10:49:17 +00:00
|
|
|
|
///
|
2022-06-18 02:46:01 +00:00
|
|
|
|
/// **Note**: This type is only available on platforms that support atomic
|
|
|
|
|
/// loads and stores of pointers, which includes all platforms that support
|
|
|
|
|
/// the `std` crate but not all those which only support [`alloc`](crate).
|
|
|
|
|
/// This may be detected at compile time using `#[cfg(target_has_atomic = "ptr")]`.
|
|
|
|
|
///
|
2017-04-25 15:24:06 +00:00
|
|
|
|
/// ## Thread Safety
|
|
|
|
|
///
|
|
|
|
|
/// Unlike [`Rc<T>`], `Arc<T>` uses atomic operations for its reference
|
2018-04-25 12:14:43 +00:00
|
|
|
|
/// counting. This means that it is thread-safe. The disadvantage is that
|
2017-04-25 15:24:06 +00:00
|
|
|
|
/// atomic operations are more expensive than ordinary memory accesses. If you
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// are not sharing reference-counted allocations between threads, consider using
|
2017-04-25 15:24:06 +00:00
|
|
|
|
/// [`Rc<T>`] for lower overhead. [`Rc<T>`] is a safe default, because the
|
|
|
|
|
/// compiler will catch any attempt to send an [`Rc<T>`] between threads.
|
|
|
|
|
/// However, a library might choose `Arc<T>` in order to give library consumers
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// more flexibility.
|
|
|
|
|
///
|
2017-04-25 15:24:06 +00:00
|
|
|
|
/// `Arc<T>` will implement [`Send`] and [`Sync`] as long as the `T` implements
|
|
|
|
|
/// [`Send`] and [`Sync`]. Why can't you put a non-thread-safe type `T` in an
|
|
|
|
|
/// `Arc<T>` to make it thread-safe? This may be a bit counter-intuitive at
|
|
|
|
|
/// first: after all, isn't the point of `Arc<T>` thread safety? The key is
|
|
|
|
|
/// this: `Arc<T>` makes it thread safe to have multiple ownership of the same
|
|
|
|
|
/// data, but it doesn't add thread safety to its data. Consider
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// <code>Arc<[RefCell\<T>]></code>. [`RefCell<T>`] isn't [`Sync`], and if `Arc<T>` was always
|
|
|
|
|
/// [`Send`], <code>Arc<[RefCell\<T>]></code> would be as well. But then we'd have a problem:
|
2017-09-22 13:45:37 +00:00
|
|
|
|
/// [`RefCell<T>`] is not thread safe; it keeps track of the borrowing count using
|
2017-04-25 15:24:06 +00:00
|
|
|
|
/// non-atomic operations.
|
|
|
|
|
///
|
|
|
|
|
/// In the end, this means that you may need to pair `Arc<T>` with some sort of
|
2017-09-22 13:45:37 +00:00
|
|
|
|
/// [`std::sync`] type, usually [`Mutex<T>`][mutex].
|
2017-04-25 15:24:06 +00:00
|
|
|
|
///
|
|
|
|
|
/// ## Breaking cycles with `Weak`
|
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// The [`downgrade`][downgrade] method can be used to create a non-owning
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`Weak`] pointer. A [`Weak`] pointer can be [`upgrade`][upgrade]d
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// to an `Arc`, but this will return [`None`] if the value stored in the allocation has
|
|
|
|
|
/// already been dropped. In other words, `Weak` pointers do not keep the value
|
|
|
|
|
/// inside the allocation alive; however, they *do* keep the allocation
|
|
|
|
|
/// (the backing store for the value) alive.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// A cycle between `Arc` pointers will never be deallocated. For this reason,
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`Weak`] is used to break cycles. For example, a tree could have
|
|
|
|
|
/// strong `Arc` pointers from parent nodes to children, and [`Weak`]
|
2016-12-24 09:51:46 +00:00
|
|
|
|
/// pointers from children back to their parents.
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// # Cloning references
|
|
|
|
|
///
|
2020-08-28 16:29:06 +00:00
|
|
|
|
/// Creating a new reference from an existing reference-counted pointer is done using the
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// `Clone` trait implemented for [`Arc<T>`][Arc] and [`Weak<T>`][Weak].
|
2017-05-21 14:00:04 +00:00
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// let foo = Arc::new(vec![1.0, 2.0, 3.0]);
|
|
|
|
|
/// // The two syntaxes below are equivalent.
|
|
|
|
|
/// let a = foo.clone();
|
|
|
|
|
/// let b = Arc::clone(&foo);
|
2018-08-31 08:21:01 +00:00
|
|
|
|
/// // a, b, and foo are all Arcs that point to the same memory location
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// ```
|
|
|
|
|
///
|
2017-04-25 15:24:06 +00:00
|
|
|
|
/// ## `Deref` behavior
|
|
|
|
|
///
|
2023-07-03 17:51:31 +00:00
|
|
|
|
/// `Arc<T>` automatically dereferences to `T` (via the [`Deref`] trait),
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// so you can call `T`'s methods on a value of type `Arc<T>`. To avoid name
|
2018-11-21 00:49:47 +00:00
|
|
|
|
/// clashes with `T`'s methods, the methods of `Arc<T>` itself are associated
|
2020-08-31 01:40:56 +00:00
|
|
|
|
/// functions, called using [fully qualified syntax]:
|
2015-03-26 19:05:21 +00:00
|
|
|
|
///
|
2015-03-13 02:42:38 +00:00
|
|
|
|
/// ```
|
2014-06-07 18:13:26 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2020-08-31 01:40:56 +00:00
|
|
|
|
/// let my_arc = Arc::new(());
|
2021-10-12 00:40:03 +00:00
|
|
|
|
/// let my_weak = Arc::downgrade(&my_arc);
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// ```
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2020-10-28 23:47:05 +00:00
|
|
|
|
/// `Arc<T>`'s implementations of traits like `Clone` may also be called using
|
|
|
|
|
/// fully qualified syntax. Some people prefer to use fully qualified syntax,
|
|
|
|
|
/// while others prefer using method-call syntax.
|
2020-08-31 01:40:56 +00:00
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2020-10-28 23:47:05 +00:00
|
|
|
|
/// let arc = Arc::new(());
|
|
|
|
|
/// // Method-call syntax
|
|
|
|
|
/// let arc2 = arc.clone();
|
|
|
|
|
/// // Fully qualified syntax
|
|
|
|
|
/// let arc3 = Arc::clone(&arc);
|
2020-08-31 01:40:56 +00:00
|
|
|
|
/// ```
|
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`Weak<T>`][Weak] does not auto-dereference to `T`, because the inner value may have
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// already been dropped.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`Rc<T>`]: crate::rc::Rc
|
|
|
|
|
/// [clone]: Clone::clone
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// [mutex]: ../../std/sync/struct.Mutex.html
|
|
|
|
|
/// [rwlock]: ../../std/sync/struct.RwLock.html
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [atomic]: core::sync::atomic
|
|
|
|
|
/// [downgrade]: Arc::downgrade
|
|
|
|
|
/// [upgrade]: Weak::upgrade
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [RefCell\<T>]: core::cell::RefCell
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`RefCell<T>`]: core::cell::RefCell
|
2017-09-22 13:45:37 +00:00
|
|
|
|
/// [`std::sync`]: ../../std/sync/index.html
|
2020-09-02 03:39:16 +00:00
|
|
|
|
/// [`Arc::clone(&from)`]: Arc::clone
|
2020-08-31 01:40:56 +00:00
|
|
|
|
/// [fully qualified syntax]: https://doc.rust-lang.org/book/ch19-03-advanced-traits.html#fully-qualified-syntax-for-disambiguation-calling-methods-with-the-same-name
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// # Examples
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Sharing some immutable data between threads:
|
2016-07-09 03:47:36 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
// Note that we **do not** run these tests here. The windows builders get super
|
|
|
|
|
// unhappy if a thread outlives the main thread and then exits at the same time
|
|
|
|
|
// (something deadlocks) so we just avoid this entirely by not running these
|
|
|
|
|
// tests.
|
2016-07-22 23:21:51 +00:00
|
|
|
|
/// ```no_run
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2016-07-09 03:47:36 +00:00
|
|
|
|
/// use std::thread;
|
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2016-07-09 03:47:36 +00:00
|
|
|
|
///
|
|
|
|
|
/// for _ in 0..10 {
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let five = Arc::clone(&five);
|
2016-07-09 03:47:36 +00:00
|
|
|
|
///
|
|
|
|
|
/// thread::spawn(move || {
|
2022-02-12 19:16:17 +00:00
|
|
|
|
/// println!("{five:?}");
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// });
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
2016-07-09 03:47:36 +00:00
|
|
|
|
///
|
2016-12-24 09:51:46 +00:00
|
|
|
|
/// Sharing a mutable [`AtomicUsize`]:
|
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [`AtomicUsize`]: core::sync::atomic::AtomicUsize "sync::atomic::AtomicUsize"
|
2016-07-09 03:47:36 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// ```no_run
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::sync::atomic::{AtomicUsize, Ordering};
|
|
|
|
|
/// use std::thread;
|
|
|
|
|
///
|
|
|
|
|
/// let val = Arc::new(AtomicUsize::new(5));
|
|
|
|
|
///
|
|
|
|
|
/// for _ in 0..10 {
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let val = Arc::clone(&val);
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
|
|
|
|
/// thread::spawn(move || {
|
|
|
|
|
/// let v = val.fetch_add(1, Ordering::SeqCst);
|
2022-02-12 19:16:17 +00:00
|
|
|
|
/// println!("{v:?}");
|
2016-07-09 03:47:36 +00:00
|
|
|
|
/// });
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
|
|
|
|
/// See the [`rc` documentation][rc_examples] for more examples of reference
|
|
|
|
|
/// counting in general.
|
|
|
|
|
///
|
2020-09-02 03:39:16 +00:00
|
|
|
|
/// [rc_examples]: crate::rc#examples
|
2020-04-08 01:26:48 +00:00
|
|
|
|
#[cfg_attr(not(test), rustc_diagnostic_item = "Arc")]
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub struct Arc<
|
|
|
|
|
T: ?Sized,
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")] A: Allocator = Global,
|
|
|
|
|
> {
|
2017-12-22 17:58:39 +00:00
|
|
|
|
ptr: NonNull<ArcInner<T>>,
|
2019-11-05 20:34:54 +00:00
|
|
|
|
phantom: PhantomData<ArcInner<T>>,
|
2022-04-28 02:22:52 +00:00
|
|
|
|
alloc: A,
|
2013-02-26 19:34:00 +00:00
|
|
|
|
}
|
2012-08-13 23:45:17 +00:00
|
|
|
|
|
2015-11-16 16:54:28 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe impl<T: ?Sized + Sync + Send, A: Allocator + Send> Send for Arc<T, A> {}
|
2015-11-16 16:54:28 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe impl<T: ?Sized + Sync + Send, A: Allocator + Sync> Sync for Arc<T, A> {}
|
2014-12-24 08:48:11 +00:00
|
|
|
|
|
2021-07-31 10:57:49 +00:00
|
|
|
|
#[stable(feature = "catch_unwind", since = "1.9.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: RefUnwindSafe + ?Sized, A: Allocator + UnwindSafe> UnwindSafe for Arc<T, A> {}
|
2021-07-31 10:57:49 +00:00
|
|
|
|
|
2022-12-20 07:08:38 +00:00
|
|
|
|
#[unstable(feature = "coerce_unsized", issue = "18598")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + Unsize<U>, U: ?Sized, A: Allocator> CoerceUnsized<Arc<U, A>> for Arc<T, A> {}
|
2014-12-24 08:48:11 +00:00
|
|
|
|
|
2019-12-21 11:16:18 +00:00
|
|
|
|
#[unstable(feature = "dispatch_from_dyn", issue = "none")]
|
2018-10-04 03:40:21 +00:00
|
|
|
|
impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Arc<U>> for Arc<T> {}
|
2018-09-20 07:18:00 +00:00
|
|
|
|
|
2019-06-19 07:56:34 +00:00
|
|
|
|
impl<T: ?Sized> Arc<T> {
|
2021-10-10 18:02:42 +00:00
|
|
|
|
unsafe fn from_inner(ptr: NonNull<ArcInner<T>>) -> Self {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe { Self::from_inner_in(ptr, Global) }
|
2019-06-19 07:56:34 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
unsafe fn from_ptr(ptr: *mut ArcInner<T>) -> Self {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe { Self::from_ptr_in(ptr, Global) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<T: ?Sized, A: Allocator> Arc<T, A> {
|
|
|
|
|
#[inline]
|
|
|
|
|
unsafe fn from_inner_in(ptr: NonNull<ArcInner<T>>, alloc: A) -> Self {
|
|
|
|
|
Self { ptr, phantom: PhantomData, alloc }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
|
unsafe fn from_ptr_in(ptr: *mut ArcInner<T>, alloc: A) -> Self {
|
|
|
|
|
unsafe { Self::from_inner_in(NonNull::new_unchecked(ptr), alloc) }
|
2019-06-19 07:56:34 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-04-12 02:29:42 +00:00
|
|
|
|
/// `Weak` is a version of [`Arc`] that holds a non-owning reference to the
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// managed allocation. The allocation is accessed by calling [`upgrade`] on the `Weak`
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// pointer, which returns an <code>[Option]<[Arc]\<T>></code>.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2017-04-12 02:29:42 +00:00
|
|
|
|
/// Since a `Weak` reference does not count towards ownership, it will not
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// prevent the value stored in the allocation from being dropped, and `Weak` itself makes no
|
|
|
|
|
/// guarantees about the value still being present. Thus it may return [`None`]
|
|
|
|
|
/// when [`upgrade`]d. Note however that a `Weak` reference *does* prevent the allocation
|
|
|
|
|
/// itself (the backing store) from being deallocated.
|
2016-07-09 03:47:36 +00:00
|
|
|
|
///
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// A `Weak` pointer is useful for keeping a temporary reference to the allocation
|
|
|
|
|
/// managed by [`Arc`] without preventing its inner value from being dropped. It is also used to
|
|
|
|
|
/// prevent circular references between [`Arc`] pointers, since mutual owning references
|
2017-04-12 02:29:42 +00:00
|
|
|
|
/// would never allow either [`Arc`] to be dropped. For example, a tree could
|
|
|
|
|
/// have strong [`Arc`] pointers from parent nodes to children, and `Weak`
|
|
|
|
|
/// pointers from children back to their parents.
|
2016-07-09 03:47:36 +00:00
|
|
|
|
///
|
2017-04-12 02:29:42 +00:00
|
|
|
|
/// The typical way to obtain a `Weak` pointer is to call [`Arc::downgrade`].
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`upgrade`]: Weak::upgrade
|
2015-09-10 20:26:44 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2023-09-27 03:56:38 +00:00
|
|
|
|
#[cfg_attr(not(test), rustc_diagnostic_item = "ArcWeak")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub struct Weak<
|
|
|
|
|
T: ?Sized,
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")] A: Allocator = Global,
|
|
|
|
|
> {
|
2018-06-28 18:49:47 +00:00
|
|
|
|
// This is a `NonNull` to allow optimizing the size of this type in enums,
|
2018-06-29 13:43:34 +00:00
|
|
|
|
// but it is not necessarily a valid pointer.
|
2018-07-23 09:13:20 +00:00
|
|
|
|
// `Weak::new` sets this to `usize::MAX` so that it doesn’t need
|
2023-01-14 15:33:11 +00:00
|
|
|
|
// to allocate space on the heap. That's not a value a real pointer
|
2018-07-23 10:53:37 +00:00
|
|
|
|
// will ever have because RcBox has alignment at least 2.
|
2020-07-02 20:53:56 +00:00
|
|
|
|
// This is only possible when `T: Sized`; unsized `T` never dangle.
|
2017-12-22 17:58:39 +00:00
|
|
|
|
ptr: NonNull<ArcInner<T>>,
|
2022-04-28 02:22:52 +00:00
|
|
|
|
alloc: A,
|
2012-08-13 23:45:17 +00:00
|
|
|
|
}
|
2012-08-10 22:20:03 +00:00
|
|
|
|
|
2016-01-20 05:48:11 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe impl<T: ?Sized + Sync + Send, A: Allocator + Send> Send for Weak<T, A> {}
|
2016-01-20 05:48:11 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe impl<T: ?Sized + Sync + Send, A: Allocator + Sync> Sync for Weak<T, A> {}
|
2014-12-06 16:39:25 +00:00
|
|
|
|
|
2022-12-20 07:08:38 +00:00
|
|
|
|
#[unstable(feature = "coerce_unsized", issue = "18598")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + Unsize<U>, U: ?Sized, A: Allocator> CoerceUnsized<Weak<U, A>> for Weak<T, A> {}
|
2019-12-21 11:16:18 +00:00
|
|
|
|
#[unstable(feature = "dispatch_from_dyn", issue = "none")]
|
2018-10-04 03:40:21 +00:00
|
|
|
|
impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Weak<U>> for Weak<T> {}
|
2015-07-01 21:58:05 +00:00
|
|
|
|
|
2016-01-20 05:48:11 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2021-10-26 01:35:45 +00:00
|
|
|
|
impl<T: ?Sized> fmt::Debug for Weak<T> {
|
2019-02-02 11:48:12 +00:00
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
2015-02-20 12:09:29 +00:00
|
|
|
|
write!(f, "(Weak)")
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-02-03 17:14:31 +00:00
|
|
|
|
// This is repr(C) to future-proof against possible field-reordering, which
|
|
|
|
|
// would interfere with otherwise safe [into|from]_raw() of transmutable
|
|
|
|
|
// inner types.
|
|
|
|
|
#[repr(C)]
|
2015-05-16 23:25:17 +00:00
|
|
|
|
struct ArcInner<T: ?Sized> {
|
2015-01-10 21:42:48 +00:00
|
|
|
|
strong: atomic::AtomicUsize,
|
2015-06-26 21:32:34 +00:00
|
|
|
|
|
|
|
|
|
// the value usize::MAX acts as a sentinel for temporarily "locking" the
|
|
|
|
|
// ability to upgrade weak pointers or downgrade strong ones; this is used
|
2015-08-12 21:37:27 +00:00
|
|
|
|
// to avoid races in `make_mut` and `get_mut`.
|
2015-01-10 21:42:48 +00:00
|
|
|
|
weak: atomic::AtomicUsize,
|
2015-06-26 21:32:34 +00:00
|
|
|
|
|
2014-03-22 07:53:58 +00:00
|
|
|
|
data: T,
|
|
|
|
|
}
|
2012-08-10 22:20:03 +00:00
|
|
|
|
|
2022-11-14 00:51:05 +00:00
|
|
|
|
/// Calculate layout for `ArcInner<T>` using the inner value's layout
|
|
|
|
|
fn arcinner_layout_for_value_layout(layout: Layout) -> Layout {
|
|
|
|
|
// Calculate layout using the given value layout.
|
|
|
|
|
// Previously, layout was calculated on the expression
|
|
|
|
|
// `&*(ptr as *const ArcInner<T>)`, but this created a misaligned
|
|
|
|
|
// reference (see #54908).
|
|
|
|
|
Layout::new::<ArcInner<()>>().extend(layout).unwrap().0.pad_to_align()
|
|
|
|
|
}
|
|
|
|
|
|
2015-05-16 23:25:17 +00:00
|
|
|
|
unsafe impl<T: ?Sized + Sync + Send> Send for ArcInner<T> {}
|
|
|
|
|
unsafe impl<T: ?Sized + Sync + Send> Sync for ArcInner<T> {}
|
2014-12-24 08:48:11 +00:00
|
|
|
|
|
2014-12-22 16:15:51 +00:00
|
|
|
|
impl<T> Arc<T> {
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// Constructs a new `Arc<T>`.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2021-07-02 12:55:20 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2013-10-24 20:50:21 +00:00
|
|
|
|
#[inline]
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2013-07-22 20:57:40 +00:00
|
|
|
|
pub fn new(data: T) -> Arc<T> {
|
2014-03-22 07:53:58 +00:00
|
|
|
|
// Start the weak pointer count as 1 which is the weak pointer that's
|
|
|
|
|
// held by all the strong pointers (kinda), see std/rc.rs for more info
|
2022-05-28 21:22:07 +00:00
|
|
|
|
let x: Box<_> = Box::new(ArcInner {
|
2015-01-10 21:42:48 +00:00
|
|
|
|
strong: atomic::AtomicUsize::new(1),
|
|
|
|
|
weak: atomic::AtomicUsize::new(1),
|
2017-08-07 05:54:09 +00:00
|
|
|
|
data,
|
2022-05-28 21:22:07 +00:00
|
|
|
|
});
|
2021-10-10 18:02:42 +00:00
|
|
|
|
unsafe { Self::from_inner(Box::leak(x).into()) }
|
2013-07-22 20:57:40 +00:00
|
|
|
|
}
|
2015-08-12 21:37:27 +00:00
|
|
|
|
|
2022-04-09 12:14:06 +00:00
|
|
|
|
/// Constructs a new `Arc<T>` while giving you a `Weak<T>` to the allocation,
|
|
|
|
|
/// to allow you to construct a `T` which holds a weak pointer to itself.
|
2020-08-15 01:16:20 +00:00
|
|
|
|
///
|
2021-12-13 13:41:21 +00:00
|
|
|
|
/// Generally, a structure circularly referencing itself, either directly or
|
2022-04-09 12:14:06 +00:00
|
|
|
|
/// indirectly, should not hold a strong reference to itself to prevent a memory leak.
|
|
|
|
|
/// Using this function, you get access to the weak pointer during the
|
|
|
|
|
/// initialization of `T`, before the `Arc<T>` is created, such that you can
|
|
|
|
|
/// clone and store it inside the `T`.
|
2021-12-13 13:41:21 +00:00
|
|
|
|
///
|
2022-04-09 12:14:06 +00:00
|
|
|
|
/// `new_cyclic` first allocates the managed allocation for the `Arc<T>`,
|
|
|
|
|
/// then calls your closure, giving it a `Weak<T>` to this allocation,
|
|
|
|
|
/// and only afterwards completes the construction of the `Arc<T>` by placing
|
|
|
|
|
/// the `T` returned from your closure into the allocation.
|
|
|
|
|
///
|
|
|
|
|
/// Since the new `Arc<T>` is not fully-constructed until `Arc<T>::new_cyclic`
|
|
|
|
|
/// returns, calling [`upgrade`] on the weak reference inside your closure will
|
|
|
|
|
/// fail and result in a `None` value.
|
2021-12-13 13:41:21 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Panics
|
2022-04-09 12:14:06 +00:00
|
|
|
|
///
|
2021-12-13 13:41:21 +00:00
|
|
|
|
/// If `data_fn` panics, the panic is propagated to the caller, and the
|
|
|
|
|
/// temporary [`Weak<T>`] is dropped normally.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
2022-04-09 12:14:06 +00:00
|
|
|
|
///
|
2020-08-15 01:16:20 +00:00
|
|
|
|
/// ```
|
2022-04-08 00:56:06 +00:00
|
|
|
|
/// # #![allow(dead_code)]
|
2020-08-15 01:16:20 +00:00
|
|
|
|
/// use std::sync::{Arc, Weak};
|
|
|
|
|
///
|
2021-12-13 13:41:21 +00:00
|
|
|
|
/// struct Gadget {
|
|
|
|
|
/// me: Weak<Gadget>,
|
2020-08-15 01:16:20 +00:00
|
|
|
|
/// }
|
|
|
|
|
///
|
2021-12-13 13:41:21 +00:00
|
|
|
|
/// impl Gadget {
|
|
|
|
|
/// /// Construct a reference counted Gadget.
|
|
|
|
|
/// fn new() -> Arc<Self> {
|
2022-04-09 12:14:06 +00:00
|
|
|
|
/// // `me` is a `Weak<Gadget>` pointing at the new allocation of the
|
|
|
|
|
/// // `Arc` we're constructing.
|
|
|
|
|
/// Arc::new_cyclic(|me| {
|
|
|
|
|
/// // Create the actual struct here.
|
|
|
|
|
/// Gadget { me: me.clone() }
|
|
|
|
|
/// })
|
2021-12-13 13:41:21 +00:00
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// /// Return a reference counted pointer to Self.
|
|
|
|
|
/// fn me(&self) -> Arc<Self> {
|
|
|
|
|
/// self.me.upgrade().unwrap()
|
|
|
|
|
/// }
|
|
|
|
|
/// }
|
2020-08-15 01:16:20 +00:00
|
|
|
|
/// ```
|
2021-12-13 13:41:21 +00:00
|
|
|
|
/// [`upgrade`]: Weak::upgrade
|
2021-07-02 12:55:20 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2020-08-13 01:07:54 +00:00
|
|
|
|
#[inline]
|
2022-01-22 15:48:42 +00:00
|
|
|
|
#[stable(feature = "arc_new_cyclic", since = "1.60.0")]
|
2021-12-30 13:55:18 +00:00
|
|
|
|
pub fn new_cyclic<F>(data_fn: F) -> Arc<T>
|
|
|
|
|
where
|
|
|
|
|
F: FnOnce(&Weak<T>) -> T,
|
|
|
|
|
{
|
2020-08-13 01:07:54 +00:00
|
|
|
|
// Construct the inner in the "uninitialized" state with a single
|
|
|
|
|
// weak reference.
|
2022-05-28 21:22:07 +00:00
|
|
|
|
let uninit_ptr: NonNull<_> = Box::leak(Box::new(ArcInner {
|
2020-08-13 01:07:54 +00:00
|
|
|
|
strong: atomic::AtomicUsize::new(0),
|
|
|
|
|
weak: atomic::AtomicUsize::new(1),
|
|
|
|
|
data: mem::MaybeUninit::<T>::uninit(),
|
2022-05-28 21:22:07 +00:00
|
|
|
|
}))
|
2020-08-15 01:16:20 +00:00
|
|
|
|
.into();
|
2020-08-13 01:07:54 +00:00
|
|
|
|
let init_ptr: NonNull<ArcInner<T>> = uninit_ptr.cast();
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let weak = Weak { ptr: init_ptr, alloc: Global };
|
2020-08-13 01:07:54 +00:00
|
|
|
|
|
|
|
|
|
// It's important we don't give up ownership of the weak pointer, or
|
|
|
|
|
// else the memory might be freed by the time `data_fn` returns. If
|
|
|
|
|
// we really wanted to pass ownership, we could create an additional
|
|
|
|
|
// weak pointer for ourselves, but this would result in additional
|
|
|
|
|
// updates to the weak reference count which might not be necessary
|
|
|
|
|
// otherwise.
|
|
|
|
|
let data = data_fn(&weak);
|
|
|
|
|
|
|
|
|
|
// Now we can properly initialize the inner value and turn our weak
|
|
|
|
|
// reference into a strong reference.
|
2021-10-10 18:02:42 +00:00
|
|
|
|
let strong = unsafe {
|
2020-08-13 01:07:54 +00:00
|
|
|
|
let inner = init_ptr.as_ptr();
|
2021-01-10 18:35:42 +00:00
|
|
|
|
ptr::write(ptr::addr_of_mut!((*inner).data), data);
|
2020-08-13 01:07:54 +00:00
|
|
|
|
|
|
|
|
|
// The above write to the data field must be visible to any threads which
|
|
|
|
|
// observe a non-zero strong count. Therefore we need at least "Release" ordering
|
|
|
|
|
// in order to synchronize with the `compare_exchange_weak` in `Weak::upgrade`.
|
|
|
|
|
//
|
|
|
|
|
// "Acquire" ordering is not required. When considering the possible behaviours
|
|
|
|
|
// of `data_fn` we only need to look at what it could do with a reference to a
|
|
|
|
|
// non-upgradeable `Weak`:
|
|
|
|
|
// - It can *clone* the `Weak`, increasing the weak reference count.
|
|
|
|
|
// - It can drop those clones, decreasing the weak reference count (but never to zero).
|
|
|
|
|
//
|
|
|
|
|
// These side effects do not impact us in any way, and no other side effects are
|
|
|
|
|
// possible with safe code alone.
|
|
|
|
|
let prev_value = (*inner).strong.fetch_add(1, Release);
|
|
|
|
|
debug_assert_eq!(prev_value, 0, "No prior strong references should exist");
|
|
|
|
|
|
2021-10-10 18:02:42 +00:00
|
|
|
|
Arc::from_inner(init_ptr)
|
|
|
|
|
};
|
2020-08-13 01:07:54 +00:00
|
|
|
|
|
|
|
|
|
// Strong references should collectively own a shared weak reference,
|
|
|
|
|
// so don't run the destructor for our old weak reference.
|
|
|
|
|
mem::forget(weak);
|
|
|
|
|
strong
|
|
|
|
|
}
|
|
|
|
|
|
2019-08-17 13:15:17 +00:00
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents.
|
2019-07-06 15:19:58 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let mut five = Arc::<u32>::new_uninit();
|
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// Arc::get_mut(&mut five).unwrap().write(5);
|
2019-07-06 15:19:58 +00:00
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// let five = unsafe { five.assume_init() };
|
2019-07-06 15:19:58 +00:00
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*five, 5)
|
|
|
|
|
/// ```
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2023-05-16 06:53:05 +00:00
|
|
|
|
#[inline]
|
2019-08-05 15:45:30 +00:00
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
2021-10-10 05:50:06 +00:00
|
|
|
|
#[must_use]
|
2019-07-06 15:19:58 +00:00
|
|
|
|
pub fn new_uninit() -> Arc<mem::MaybeUninit<T>> {
|
|
|
|
|
unsafe {
|
2020-08-05 00:49:21 +00:00
|
|
|
|
Arc::from_ptr(Arc::allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
2020-12-04 13:47:15 +00:00
|
|
|
|
|layout| Global.allocate(layout),
|
2022-04-28 02:22:52 +00:00
|
|
|
|
<*mut u8>::cast,
|
2020-08-05 00:49:21 +00:00
|
|
|
|
))
|
2019-07-06 15:19:58 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-11-05 18:27:42 +00:00
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents, with the memory
|
|
|
|
|
/// being filled with `0` bytes.
|
|
|
|
|
///
|
|
|
|
|
/// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
|
|
|
|
|
/// of this method.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let zero = Arc::<u32>::new_zeroed();
|
|
|
|
|
/// let zero = unsafe { zero.assume_init() };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*zero, 0)
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [zeroed]: mem::MaybeUninit::zeroed
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2023-05-16 06:53:05 +00:00
|
|
|
|
#[inline]
|
2019-11-05 18:27:42 +00:00
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
2021-10-10 05:50:06 +00:00
|
|
|
|
#[must_use]
|
2019-11-05 18:27:42 +00:00
|
|
|
|
pub fn new_zeroed() -> Arc<mem::MaybeUninit<T>> {
|
|
|
|
|
unsafe {
|
2020-08-05 00:49:21 +00:00
|
|
|
|
Arc::from_ptr(Arc::allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
2020-12-04 13:47:15 +00:00
|
|
|
|
|layout| Global.allocate_zeroed(layout),
|
2022-04-28 02:22:52 +00:00
|
|
|
|
<*mut u8>::cast,
|
2020-08-05 00:49:21 +00:00
|
|
|
|
))
|
2019-11-05 18:27:42 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-12-18 18:25:02 +00:00
|
|
|
|
/// Constructs a new `Pin<Arc<T>>`. If `T` does not implement `Unpin`, then
|
|
|
|
|
/// `data` will be pinned in memory and unable to be moved.
|
2021-07-02 12:55:20 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2018-12-18 02:14:07 +00:00
|
|
|
|
#[stable(feature = "pin", since = "1.33.0")]
|
2021-10-10 05:50:06 +00:00
|
|
|
|
#[must_use]
|
2018-12-18 18:25:02 +00:00
|
|
|
|
pub fn pin(data: T) -> Pin<Arc<T>> {
|
2018-09-01 04:12:10 +00:00
|
|
|
|
unsafe { Pin::new_unchecked(Arc::new(data)) }
|
|
|
|
|
}
|
|
|
|
|
|
2021-05-22 14:24:50 +00:00
|
|
|
|
/// Constructs a new `Pin<Arc<T>>`, return an error if allocation fails.
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn try_pin(data: T) -> Result<Pin<Arc<T>>, AllocError> {
|
|
|
|
|
unsafe { Ok(Pin::new_unchecked(Arc::try_new(data)?)) }
|
|
|
|
|
}
|
|
|
|
|
|
2020-12-31 08:30:23 +00:00
|
|
|
|
/// Constructs a new `Arc<T>`, returning an error if allocation fails.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::try_new(5)?;
|
|
|
|
|
/// # Ok::<(), std::alloc::AllocError>(())
|
|
|
|
|
/// ```
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn try_new(data: T) -> Result<Arc<T>, AllocError> {
|
|
|
|
|
// Start the weak pointer count as 1 which is the weak pointer that's
|
|
|
|
|
// held by all the strong pointers (kinda), see std/rc.rs for more info
|
|
|
|
|
let x: Box<_> = Box::try_new(ArcInner {
|
|
|
|
|
strong: atomic::AtomicUsize::new(1),
|
|
|
|
|
weak: atomic::AtomicUsize::new(1),
|
|
|
|
|
data,
|
|
|
|
|
})?;
|
2021-10-10 18:02:42 +00:00
|
|
|
|
unsafe { Ok(Self::from_inner(Box::leak(x).into())) }
|
2020-12-31 08:30:23 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents, returning an error
|
|
|
|
|
/// if allocation fails.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit, allocator_api)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let mut five = Arc::<u32>::try_new_uninit()?;
|
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// Arc::get_mut(&mut five).unwrap().write(5);
|
2020-12-31 08:30:23 +00:00
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// let five = unsafe { five.assume_init() };
|
2020-12-31 08:30:23 +00:00
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*five, 5);
|
|
|
|
|
/// # Ok::<(), std::alloc::AllocError>(())
|
|
|
|
|
/// ```
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
// #[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
pub fn try_new_uninit() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
|
|
|
|
|layout| Global.allocate(layout),
|
2022-04-28 02:22:52 +00:00
|
|
|
|
<*mut u8>::cast,
|
2020-12-31 08:30:23 +00:00
|
|
|
|
)?))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents, with the memory
|
|
|
|
|
/// being filled with `0` bytes, returning an error if allocation fails.
|
|
|
|
|
///
|
|
|
|
|
/// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
|
|
|
|
|
/// of this method.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit, allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let zero = Arc::<u32>::try_new_zeroed()?;
|
|
|
|
|
/// let zero = unsafe { zero.assume_init() };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*zero, 0);
|
|
|
|
|
/// # Ok::<(), std::alloc::AllocError>(())
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
2020-12-31 16:48:51 +00:00
|
|
|
|
/// [zeroed]: mem::MaybeUninit::zeroed
|
2020-12-31 08:30:23 +00:00
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
// #[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
pub fn try_new_zeroed() -> Result<Arc<mem::MaybeUninit<T>>, AllocError> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Ok(Arc::from_ptr(Arc::try_allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
|
|
|
|
|layout| Global.allocate_zeroed(layout),
|
2022-04-28 02:22:52 +00:00
|
|
|
|
<*mut u8>::cast,
|
2020-12-31 08:30:23 +00:00
|
|
|
|
)?))
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-04-28 02:22:52 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<T, A: Allocator> Arc<T, A> {
|
|
|
|
|
/// Returns a reference to the underlying allocator.
|
2023-07-18 00:56:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// Note: this is an associated function, which means that you have
|
|
|
|
|
/// to call it as `Arc::allocator(&a)` instead of `a.allocator()`. This
|
|
|
|
|
/// is so that there is no conflict with a method on the inner type.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
2023-07-18 00:56:55 +00:00
|
|
|
|
pub fn allocator(this: &Self) -> &A {
|
|
|
|
|
&this.alloc
|
2022-04-28 02:22:52 +00:00
|
|
|
|
}
|
|
|
|
|
/// Constructs a new `Arc<T>` in the provided allocator.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::new_in(5, System);
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
pub fn new_in(data: T, alloc: A) -> Arc<T, A> {
|
|
|
|
|
// Start the weak pointer count as 1 which is the weak pointer that's
|
|
|
|
|
// held by all the strong pointers (kinda), see std/rc.rs for more info
|
|
|
|
|
let x = Box::new_in(
|
|
|
|
|
ArcInner {
|
|
|
|
|
strong: atomic::AtomicUsize::new(1),
|
|
|
|
|
weak: atomic::AtomicUsize::new(1),
|
|
|
|
|
data,
|
|
|
|
|
},
|
|
|
|
|
alloc,
|
|
|
|
|
);
|
|
|
|
|
let (ptr, alloc) = Box::into_unique(x);
|
|
|
|
|
unsafe { Self::from_inner_in(ptr.into(), alloc) }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents in the provided allocator.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let mut five = Arc::<u32, _>::new_uninit_in(System);
|
|
|
|
|
///
|
|
|
|
|
/// let five = unsafe {
|
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
|
|
|
|
|
///
|
|
|
|
|
/// five.assume_init()
|
|
|
|
|
/// };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*five, 5)
|
|
|
|
|
/// ```
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
// #[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn new_uninit_in(alloc: A) -> Arc<mem::MaybeUninit<T>, A> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Arc::from_ptr_in(
|
|
|
|
|
Arc::allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
|
|
|
|
|layout| alloc.allocate(layout),
|
|
|
|
|
<*mut u8>::cast,
|
|
|
|
|
),
|
|
|
|
|
alloc,
|
|
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents, with the memory
|
|
|
|
|
/// being filled with `0` bytes, in the provided allocator.
|
|
|
|
|
///
|
|
|
|
|
/// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
|
|
|
|
|
/// of this method.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let zero = Arc::<u32, _>::new_zeroed_in(System);
|
|
|
|
|
/// let zero = unsafe { zero.assume_init() };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*zero, 0)
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// [zeroed]: mem::MaybeUninit::zeroed
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
// #[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn new_zeroed_in(alloc: A) -> Arc<mem::MaybeUninit<T>, A> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Arc::from_ptr_in(
|
|
|
|
|
Arc::allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
|
|
|
|
|layout| alloc.allocate_zeroed(layout),
|
|
|
|
|
<*mut u8>::cast,
|
|
|
|
|
),
|
|
|
|
|
alloc,
|
|
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Pin<Arc<T, A>>` in the provided allocator. If `T` does not implement `Unpin`,
|
|
|
|
|
/// then `data` will be pinned in memory and unable to be moved.
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn pin_in(data: T, alloc: A) -> Pin<Arc<T, A>> {
|
|
|
|
|
unsafe { Pin::new_unchecked(Arc::new_in(data, alloc)) }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Pin<Arc<T, A>>` in the provided allocator, return an error if allocation
|
|
|
|
|
/// fails.
|
|
|
|
|
#[inline]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
pub fn try_pin_in(data: T, alloc: A) -> Result<Pin<Arc<T, A>>, AllocError> {
|
|
|
|
|
unsafe { Ok(Pin::new_unchecked(Arc::try_new_in(data, alloc)?)) }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Arc<T, A>` in the provided allocator, returning an error if allocation fails.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::try_new_in(5, System)?;
|
|
|
|
|
/// # Ok::<(), std::alloc::AllocError>(())
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn try_new_in(data: T, alloc: A) -> Result<Arc<T, A>, AllocError> {
|
|
|
|
|
// Start the weak pointer count as 1 which is the weak pointer that's
|
|
|
|
|
// held by all the strong pointers (kinda), see std/rc.rs for more info
|
|
|
|
|
let x = Box::try_new_in(
|
|
|
|
|
ArcInner {
|
|
|
|
|
strong: atomic::AtomicUsize::new(1),
|
|
|
|
|
weak: atomic::AtomicUsize::new(1),
|
|
|
|
|
data,
|
|
|
|
|
},
|
|
|
|
|
alloc,
|
|
|
|
|
)?;
|
|
|
|
|
let (ptr, alloc) = Box::into_unique(x);
|
|
|
|
|
Ok(unsafe { Self::from_inner_in(ptr.into(), alloc) })
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents, in the provided allocator, returning an
|
|
|
|
|
/// error if allocation fails.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit, allocator_api)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let mut five = Arc::<u32, _>::try_new_uninit_in(System)?;
|
|
|
|
|
///
|
|
|
|
|
/// let five = unsafe {
|
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// Arc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
|
|
|
|
|
///
|
|
|
|
|
/// five.assume_init()
|
|
|
|
|
/// };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*five, 5);
|
|
|
|
|
/// # Ok::<(), std::alloc::AllocError>(())
|
|
|
|
|
/// ```
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
// #[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn try_new_uninit_in(alloc: A) -> Result<Arc<mem::MaybeUninit<T>, A>, AllocError> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Ok(Arc::from_ptr_in(
|
|
|
|
|
Arc::try_allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
|
|
|
|
|layout| alloc.allocate(layout),
|
|
|
|
|
<*mut u8>::cast,
|
|
|
|
|
)?,
|
|
|
|
|
alloc,
|
|
|
|
|
))
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new `Arc` with uninitialized contents, with the memory
|
|
|
|
|
/// being filled with `0` bytes, in the provided allocator, returning an error if allocation
|
|
|
|
|
/// fails.
|
|
|
|
|
///
|
|
|
|
|
/// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and incorrect usage
|
|
|
|
|
/// of this method.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit, allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let zero = Arc::<u32, _>::try_new_zeroed_in(System)?;
|
|
|
|
|
/// let zero = unsafe { zero.assume_init() };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*zero, 0);
|
|
|
|
|
/// # Ok::<(), std::alloc::AllocError>(())
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// [zeroed]: mem::MaybeUninit::zeroed
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
// #[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn try_new_zeroed_in(alloc: A) -> Result<Arc<mem::MaybeUninit<T>, A>, AllocError> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Ok(Arc::from_ptr_in(
|
|
|
|
|
Arc::try_allocate_for_layout(
|
|
|
|
|
Layout::new::<T>(),
|
|
|
|
|
|layout| alloc.allocate_zeroed(layout),
|
|
|
|
|
<*mut u8>::cast,
|
|
|
|
|
)?,
|
|
|
|
|
alloc,
|
|
|
|
|
))
|
|
|
|
|
}
|
|
|
|
|
}
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Returns the inner value, if the `Arc` has exactly one strong reference.
|
2015-08-12 21:37:27 +00:00
|
|
|
|
///
|
2020-08-21 11:09:32 +00:00
|
|
|
|
/// Otherwise, an [`Err`] is returned with the same `Arc` that was
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// passed in.
|
2015-08-12 21:37:27 +00:00
|
|
|
|
///
|
2016-03-09 08:32:47 +00:00
|
|
|
|
/// This will succeed even if there are outstanding weak references.
|
|
|
|
|
///
|
2020-08-25 15:30:46 +00:00
|
|
|
|
/// It is strongly recommended to use [`Arc::into_inner`] instead if you don't
|
|
|
|
|
/// want to keep the `Arc` in the [`Err`] case.
|
|
|
|
|
/// Immediately dropping the [`Err`] payload, like in the expression
|
|
|
|
|
/// `Arc::try_unwrap(this).ok()`, can still cause the strong count to
|
|
|
|
|
/// drop to zero and the inner value of the `Arc` to be dropped:
|
2023-03-14 16:09:54 +00:00
|
|
|
|
/// For instance if two threads each execute this expression in parallel, then
|
2020-08-25 15:30:46 +00:00
|
|
|
|
/// there is a race condition. The threads could first both check whether they
|
|
|
|
|
/// have the last clone of their `Arc` via `Arc::try_unwrap`, and then
|
|
|
|
|
/// both drop their `Arc` in the call to [`ok`][`Result::ok`],
|
|
|
|
|
/// taking the strong count from two down to zero.
|
|
|
|
|
///
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x = Arc::new(3);
|
|
|
|
|
/// assert_eq!(Arc::try_unwrap(x), Ok(3));
|
|
|
|
|
///
|
|
|
|
|
/// let x = Arc::new(4);
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let _y = Arc::clone(&x);
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert_eq!(*Arc::try_unwrap(x).unwrap_err(), 4);
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
2015-09-10 20:26:44 +00:00
|
|
|
|
#[stable(feature = "arc_unique", since = "1.4.0")]
|
2015-08-12 21:37:27 +00:00
|
|
|
|
pub fn try_unwrap(this: Self) -> Result<T, Self> {
|
2020-07-04 00:00:00 +00:00
|
|
|
|
if this.inner().strong.compare_exchange(1, 0, Relaxed, Relaxed).is_err() {
|
2015-11-23 02:32:40 +00:00
|
|
|
|
return Err(this);
|
2015-09-23 22:00:54 +00:00
|
|
|
|
}
|
2015-08-12 21:37:27 +00:00
|
|
|
|
|
2020-03-20 00:00:00 +00:00
|
|
|
|
acquire!(this.inner().strong);
|
2015-08-12 21:37:27 +00:00
|
|
|
|
|
|
|
|
|
unsafe {
|
2017-04-04 16:31:38 +00:00
|
|
|
|
let elem = ptr::read(&this.ptr.as_ref().data);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let alloc = ptr::read(&this.alloc); // copy the allocator
|
2015-08-12 21:37:27 +00:00
|
|
|
|
|
|
|
|
|
// Make a weak pointer to clean up the implicit strong-weak reference
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let _weak = Weak { ptr: this.ptr, alloc };
|
2015-08-12 21:37:27 +00:00
|
|
|
|
mem::forget(this);
|
|
|
|
|
|
|
|
|
|
Ok(elem)
|
|
|
|
|
}
|
|
|
|
|
}
|
2020-08-25 15:30:46 +00:00
|
|
|
|
|
|
|
|
|
/// Returns the inner value, if the `Arc` has exactly one strong reference.
|
|
|
|
|
///
|
|
|
|
|
/// Otherwise, [`None`] is returned and the `Arc` is dropped.
|
|
|
|
|
///
|
|
|
|
|
/// This will succeed even if there are outstanding weak references.
|
|
|
|
|
///
|
|
|
|
|
/// If `Arc::into_inner` is called on every clone of this `Arc`,
|
|
|
|
|
/// it is guaranteed that exactly one of the calls returns the inner value.
|
|
|
|
|
/// This means in particular that the inner value is not dropped.
|
|
|
|
|
///
|
|
|
|
|
/// The similar expression `Arc::try_unwrap(this).ok()` does not
|
2023-03-14 16:09:54 +00:00
|
|
|
|
/// offer such a guarantee. See the last example below
|
2020-08-25 15:30:46 +00:00
|
|
|
|
/// and the documentation of [`Arc::try_unwrap`].
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// Minimal example demonstrating the guarantee that `Arc::into_inner` gives.
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x = Arc::new(3);
|
|
|
|
|
/// let y = Arc::clone(&x);
|
|
|
|
|
///
|
|
|
|
|
/// // Two threads calling `Arc::into_inner` on both clones of an `Arc`:
|
|
|
|
|
/// let x_thread = std::thread::spawn(|| Arc::into_inner(x));
|
|
|
|
|
/// let y_thread = std::thread::spawn(|| Arc::into_inner(y));
|
|
|
|
|
///
|
|
|
|
|
/// let x_inner_value = x_thread.join().unwrap();
|
|
|
|
|
/// let y_inner_value = y_thread.join().unwrap();
|
|
|
|
|
///
|
|
|
|
|
/// // One of the threads is guaranteed to receive the inner value:
|
|
|
|
|
/// assert!(matches!(
|
|
|
|
|
/// (x_inner_value, y_inner_value),
|
|
|
|
|
/// (None, Some(3)) | (Some(3), None)
|
|
|
|
|
/// ));
|
|
|
|
|
/// // The result could also be `(None, None)` if the threads called
|
|
|
|
|
/// // `Arc::try_unwrap(x).ok()` and `Arc::try_unwrap(y).ok()` instead.
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// A more practical example demonstrating the need for `Arc::into_inner`:
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// // Definition of a simple singly linked list using `Arc`:
|
|
|
|
|
/// #[derive(Clone)]
|
|
|
|
|
/// struct LinkedList<T>(Option<Arc<Node<T>>>);
|
|
|
|
|
/// struct Node<T>(T, Option<Arc<Node<T>>>);
|
|
|
|
|
///
|
|
|
|
|
/// // Dropping a long `LinkedList<T>` relying on the destructor of `Arc`
|
|
|
|
|
/// // can cause a stack overflow. To prevent this, we can provide a
|
|
|
|
|
/// // manual `Drop` implementation that does the destruction in a loop:
|
|
|
|
|
/// impl<T> Drop for LinkedList<T> {
|
|
|
|
|
/// fn drop(&mut self) {
|
|
|
|
|
/// let mut link = self.0.take();
|
|
|
|
|
/// while let Some(arc_node) = link.take() {
|
|
|
|
|
/// if let Some(Node(_value, next)) = Arc::into_inner(arc_node) {
|
|
|
|
|
/// link = next;
|
|
|
|
|
/// }
|
|
|
|
|
/// }
|
|
|
|
|
/// }
|
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// // Implementation of `new` and `push` omitted
|
|
|
|
|
/// impl<T> LinkedList<T> {
|
|
|
|
|
/// /* ... */
|
|
|
|
|
/// # fn new() -> Self {
|
|
|
|
|
/// # LinkedList(None)
|
|
|
|
|
/// # }
|
|
|
|
|
/// # fn push(&mut self, x: T) {
|
|
|
|
|
/// # self.0 = Some(Arc::new(Node(x, self.0.take())));
|
|
|
|
|
/// # }
|
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// // The following code could have still caused a stack overflow
|
|
|
|
|
/// // despite the manual `Drop` impl if that `Drop` impl had used
|
|
|
|
|
/// // `Arc::try_unwrap(arc).ok()` instead of `Arc::into_inner(arc)`.
|
|
|
|
|
///
|
|
|
|
|
/// // Create a long list and clone it
|
|
|
|
|
/// let mut x = LinkedList::new();
|
|
|
|
|
/// for i in 0..100000 {
|
|
|
|
|
/// x.push(i); // Adds i to the front of x
|
|
|
|
|
/// }
|
|
|
|
|
/// let y = x.clone();
|
|
|
|
|
///
|
|
|
|
|
/// // Drop the clones in parallel
|
|
|
|
|
/// let x_thread = std::thread::spawn(|| drop(x));
|
|
|
|
|
/// let y_thread = std::thread::spawn(|| drop(y));
|
|
|
|
|
/// x_thread.join().unwrap();
|
|
|
|
|
/// y_thread.join().unwrap();
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
2023-04-16 14:33:38 +00:00
|
|
|
|
#[stable(feature = "arc_into_inner", since = "1.70.0")]
|
2020-08-25 15:30:46 +00:00
|
|
|
|
pub fn into_inner(this: Self) -> Option<T> {
|
|
|
|
|
// Make sure that the ordinary `Drop` implementation isn’t called as well
|
|
|
|
|
let mut this = mem::ManuallyDrop::new(this);
|
|
|
|
|
|
|
|
|
|
// Following the implementation of `drop` and `drop_slow`
|
|
|
|
|
if this.inner().strong.fetch_sub(1, Release) != 1 {
|
|
|
|
|
return None;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
acquire!(this.inner().strong);
|
|
|
|
|
|
|
|
|
|
// SAFETY: This mirrors the line
|
|
|
|
|
//
|
|
|
|
|
// unsafe { ptr::drop_in_place(Self::get_mut_unchecked(self)) };
|
|
|
|
|
//
|
|
|
|
|
// in `drop_slow`. Instead of dropping the value behind the pointer,
|
|
|
|
|
// it is read and eventually returned; `ptr::read` has the same
|
|
|
|
|
// safety conditions as `ptr::drop_in_place`.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
|
2020-08-25 15:30:46 +00:00
|
|
|
|
let inner = unsafe { ptr::read(Self::get_mut_unchecked(&mut this)) };
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let alloc = unsafe { ptr::read(&this.alloc) };
|
2020-08-25 15:30:46 +00:00
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
drop(Weak { ptr: this.ptr, alloc });
|
2020-08-25 15:30:46 +00:00
|
|
|
|
|
|
|
|
|
Some(inner)
|
|
|
|
|
}
|
2017-08-24 05:50:00 +00:00
|
|
|
|
}
|
2016-10-15 15:32:14 +00:00
|
|
|
|
|
2019-07-06 19:52:15 +00:00
|
|
|
|
impl<T> Arc<[T]> {
|
2020-08-05 00:49:21 +00:00
|
|
|
|
/// Constructs a new atomically reference-counted slice with uninitialized contents.
|
2019-07-06 19:52:15 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let mut values = Arc::<[u32]>::new_uninit_slice(3);
|
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// let data = Arc::get_mut(&mut values).unwrap();
|
|
|
|
|
/// data[0].write(1);
|
|
|
|
|
/// data[1].write(2);
|
|
|
|
|
/// data[2].write(3);
|
2019-07-06 19:52:15 +00:00
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// let values = unsafe { values.assume_init() };
|
2019-07-06 19:52:15 +00:00
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*values, [1, 2, 3])
|
|
|
|
|
/// ```
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2023-05-16 06:53:05 +00:00
|
|
|
|
#[inline]
|
2019-08-05 15:45:30 +00:00
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
2021-10-10 05:50:06 +00:00
|
|
|
|
#[must_use]
|
2019-07-06 19:52:15 +00:00
|
|
|
|
pub fn new_uninit_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
|
2019-08-16 15:44:24 +00:00
|
|
|
|
unsafe { Arc::from_ptr(Arc::allocate_for_slice(len)) }
|
2019-07-06 19:52:15 +00:00
|
|
|
|
}
|
2020-08-05 00:54:59 +00:00
|
|
|
|
|
|
|
|
|
/// Constructs a new atomically reference-counted slice with uninitialized contents, with the memory being
|
|
|
|
|
/// filled with `0` bytes.
|
|
|
|
|
///
|
|
|
|
|
/// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
|
|
|
|
|
/// incorrect usage of this method.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let values = Arc::<[u32]>::new_zeroed_slice(3);
|
|
|
|
|
/// let values = unsafe { values.assume_init() };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*values, [0, 0, 0])
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [zeroed]: mem::MaybeUninit::zeroed
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2023-05-16 06:53:05 +00:00
|
|
|
|
#[inline]
|
2020-08-05 00:54:59 +00:00
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
2021-10-10 05:50:06 +00:00
|
|
|
|
#[must_use]
|
2020-08-05 00:54:59 +00:00
|
|
|
|
pub fn new_zeroed_slice(len: usize) -> Arc<[mem::MaybeUninit<T>]> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Arc::from_ptr(Arc::allocate_for_layout(
|
|
|
|
|
Layout::array::<T>(len).unwrap(),
|
2020-12-04 13:47:15 +00:00
|
|
|
|
|layout| Global.allocate_zeroed(layout),
|
2020-08-05 00:54:59 +00:00
|
|
|
|
|mem| {
|
|
|
|
|
ptr::slice_from_raw_parts_mut(mem as *mut T, len)
|
|
|
|
|
as *mut ArcInner<[mem::MaybeUninit<T>]>
|
|
|
|
|
},
|
|
|
|
|
))
|
|
|
|
|
}
|
|
|
|
|
}
|
2019-07-06 19:52:15 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T, A: Allocator> Arc<[T], A> {
|
|
|
|
|
/// Constructs a new atomically reference-counted slice with uninitialized contents in the
|
|
|
|
|
/// provided allocator.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let mut values = Arc::<[u32], _>::new_uninit_slice_in(3, System);
|
|
|
|
|
///
|
|
|
|
|
/// let values = unsafe {
|
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// Arc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
|
|
|
|
|
/// Arc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
|
|
|
|
|
/// Arc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);
|
|
|
|
|
///
|
|
|
|
|
/// values.assume_init()
|
|
|
|
|
/// };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*values, [1, 2, 3])
|
|
|
|
|
/// ```
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn new_uninit_slice_in(len: usize, alloc: A) -> Arc<[mem::MaybeUninit<T>], A> {
|
|
|
|
|
unsafe { Arc::from_ptr_in(Arc::allocate_for_slice_in(len, &alloc), alloc) }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Constructs a new atomically reference-counted slice with uninitialized contents, with the memory being
|
|
|
|
|
/// filled with `0` bytes, in the provided allocator.
|
|
|
|
|
///
|
|
|
|
|
/// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
|
|
|
|
|
/// incorrect usage of this method.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let values = Arc::<[u32], _>::new_zeroed_slice_in(3, System);
|
|
|
|
|
/// let values = unsafe { values.assume_init() };
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*values, [0, 0, 0])
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// [zeroed]: mem::MaybeUninit::zeroed
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
|
|
|
|
#[inline]
|
|
|
|
|
pub fn new_zeroed_slice_in(len: usize, alloc: A) -> Arc<[mem::MaybeUninit<T>], A> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Arc::from_ptr_in(
|
|
|
|
|
Arc::allocate_for_layout(
|
|
|
|
|
Layout::array::<T>(len).unwrap(),
|
|
|
|
|
|layout| alloc.allocate_zeroed(layout),
|
|
|
|
|
|mem| {
|
|
|
|
|
ptr::slice_from_raw_parts_mut(mem.cast::<T>(), len)
|
|
|
|
|
as *mut ArcInner<[mem::MaybeUninit<T>]>
|
|
|
|
|
},
|
|
|
|
|
),
|
|
|
|
|
alloc,
|
|
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<T, A: Allocator> Arc<mem::MaybeUninit<T>, A> {
|
2019-08-17 13:15:17 +00:00
|
|
|
|
/// Converts to `Arc<T>`.
|
2019-07-06 15:19:58 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// As with [`MaybeUninit::assume_init`],
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// it is up to the caller to guarantee that the inner value
|
2019-07-06 15:19:58 +00:00
|
|
|
|
/// really is in an initialized state.
|
|
|
|
|
/// Calling this when the content is not yet fully initialized
|
|
|
|
|
/// causes immediate undefined behavior.
|
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
|
2019-07-06 21:30:32 +00:00
|
|
|
|
///
|
2019-07-06 15:19:58 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let mut five = Arc::<u32>::new_uninit();
|
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// Arc::get_mut(&mut five).unwrap().write(5);
|
2019-07-06 15:19:58 +00:00
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// let five = unsafe { five.assume_init() };
|
2019-07-06 15:19:58 +00:00
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*five, 5)
|
|
|
|
|
/// ```
|
2019-08-05 15:45:30 +00:00
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
2021-10-10 23:50:52 +00:00
|
|
|
|
#[must_use = "`self` will be dropped if the result is not used"]
|
2019-07-06 15:19:58 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub unsafe fn assume_init(self) -> Arc<T, A>
|
|
|
|
|
where
|
|
|
|
|
A: Clone,
|
|
|
|
|
{
|
|
|
|
|
let md_self = mem::ManuallyDrop::new(self);
|
|
|
|
|
unsafe { Arc::from_inner_in(md_self.ptr.cast(), md_self.alloc.clone()) }
|
2019-07-06 19:27:55 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T, A: Allocator> Arc<[mem::MaybeUninit<T>], A> {
|
2019-08-17 13:15:17 +00:00
|
|
|
|
/// Converts to `Arc<[T]>`.
|
2019-07-06 19:27:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// As with [`MaybeUninit::assume_init`],
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// it is up to the caller to guarantee that the inner value
|
2019-07-06 19:27:55 +00:00
|
|
|
|
/// really is in an initialized state.
|
|
|
|
|
/// Calling this when the content is not yet fully initialized
|
|
|
|
|
/// causes immediate undefined behavior.
|
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
|
2019-07-06 21:30:32 +00:00
|
|
|
|
///
|
2019-07-06 19:27:55 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(new_uninit)]
|
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2019-07-06 19:52:15 +00:00
|
|
|
|
/// let mut values = Arc::<[u32]>::new_uninit_slice(3);
|
2019-07-06 19:27:55 +00:00
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// // Deferred initialization:
|
|
|
|
|
/// let data = Arc::get_mut(&mut values).unwrap();
|
|
|
|
|
/// data[0].write(1);
|
|
|
|
|
/// data[1].write(2);
|
|
|
|
|
/// data[2].write(3);
|
2019-07-06 19:27:55 +00:00
|
|
|
|
///
|
2022-01-20 10:36:19 +00:00
|
|
|
|
/// let values = unsafe { values.assume_init() };
|
2019-07-06 19:27:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(*values, [1, 2, 3])
|
|
|
|
|
/// ```
|
2019-08-05 15:45:30 +00:00
|
|
|
|
#[unstable(feature = "new_uninit", issue = "63291")]
|
2021-10-10 23:50:52 +00:00
|
|
|
|
#[must_use = "`self` will be dropped if the result is not used"]
|
2019-07-06 19:27:55 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub unsafe fn assume_init(self) -> Arc<[T], A>
|
|
|
|
|
where
|
|
|
|
|
A: Clone,
|
|
|
|
|
{
|
|
|
|
|
let md_self = mem::ManuallyDrop::new(self);
|
|
|
|
|
unsafe { Arc::from_ptr_in(md_self.ptr.as_ptr() as _, md_self.alloc.clone()) }
|
2019-07-06 15:19:58 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-24 05:50:00 +00:00
|
|
|
|
impl<T: ?Sized> Arc<T> {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// Constructs an `Arc<T>` from a raw pointer.
|
|
|
|
|
///
|
|
|
|
|
/// The raw pointer must have been previously returned by a call to
|
|
|
|
|
/// [`Arc<U>::into_raw`][into_raw] where `U` must have the same size and
|
|
|
|
|
/// alignment as `T`. This is trivially true if `U` is `T`.
|
|
|
|
|
/// Note that if `U` is not `T` but has the same size and alignment, this is
|
|
|
|
|
/// basically like transmuting references of different types. See
|
|
|
|
|
/// [`mem::transmute`][transmute] for more information on what
|
|
|
|
|
/// restrictions apply in this case.
|
|
|
|
|
///
|
|
|
|
|
/// The user of `from_raw` has to make sure a specific value of `T` is only
|
|
|
|
|
/// dropped once.
|
|
|
|
|
///
|
|
|
|
|
/// This function is unsafe because improper use may lead to memory unsafety,
|
|
|
|
|
/// even if the returned `Arc<T>` is never accessed.
|
|
|
|
|
///
|
|
|
|
|
/// [into_raw]: Arc::into_raw
|
|
|
|
|
/// [transmute]: core::mem::transmute
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x = Arc::new("hello".to_owned());
|
|
|
|
|
/// let x_ptr = Arc::into_raw(x);
|
|
|
|
|
///
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// // Convert back to an `Arc` to prevent leak.
|
|
|
|
|
/// let x = Arc::from_raw(x_ptr);
|
|
|
|
|
/// assert_eq!(&*x, "hello");
|
|
|
|
|
///
|
|
|
|
|
/// // Further calls to `Arc::from_raw(x_ptr)` would be memory-unsafe.
|
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
#[stable(feature = "rc_raw", since = "1.17.0")]
|
|
|
|
|
pub unsafe fn from_raw(ptr: *const T) -> Self {
|
|
|
|
|
unsafe { Arc::from_raw_in(ptr, Global) }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Increments the strong reference count on the `Arc<T>` associated with the
|
|
|
|
|
/// provided pointer by one.
|
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// The pointer must have been obtained through `Arc::into_raw`, and the
|
|
|
|
|
/// associated `Arc` instance must be valid (i.e. the strong count must be at
|
|
|
|
|
/// least 1) for the duration of this method.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::new(5);
|
|
|
|
|
///
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// let ptr = Arc::into_raw(five);
|
|
|
|
|
/// Arc::increment_strong_count(ptr);
|
|
|
|
|
///
|
|
|
|
|
/// // This assertion is deterministic because we haven't shared
|
|
|
|
|
/// // the `Arc` between threads.
|
|
|
|
|
/// let five = Arc::from_raw(ptr);
|
|
|
|
|
/// assert_eq!(2, Arc::strong_count(&five));
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
#[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
|
|
|
|
|
pub unsafe fn increment_strong_count(ptr: *const T) {
|
|
|
|
|
unsafe { Arc::increment_strong_count_in(ptr, Global) }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Decrements the strong reference count on the `Arc<T>` associated with the
|
|
|
|
|
/// provided pointer by one.
|
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// The pointer must have been obtained through `Arc::into_raw`, and the
|
|
|
|
|
/// associated `Arc` instance must be valid (i.e. the strong count must be at
|
|
|
|
|
/// least 1) when invoking this method. This method can be used to release the final
|
|
|
|
|
/// `Arc` and backing storage, but **should not** be called after the final `Arc` has been
|
|
|
|
|
/// released.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::new(5);
|
|
|
|
|
///
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// let ptr = Arc::into_raw(five);
|
|
|
|
|
/// Arc::increment_strong_count(ptr);
|
|
|
|
|
///
|
|
|
|
|
/// // Those assertions are deterministic because we haven't shared
|
|
|
|
|
/// // the `Arc` between threads.
|
|
|
|
|
/// let five = Arc::from_raw(ptr);
|
|
|
|
|
/// assert_eq!(2, Arc::strong_count(&five));
|
|
|
|
|
/// Arc::decrement_strong_count(ptr);
|
|
|
|
|
/// assert_eq!(1, Arc::strong_count(&five));
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
#[stable(feature = "arc_mutate_strong_count", since = "1.51.0")]
|
|
|
|
|
pub unsafe fn decrement_strong_count(ptr: *const T) {
|
|
|
|
|
unsafe { Arc::decrement_strong_count_in(ptr, Global) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<T: ?Sized, A: Allocator> Arc<T, A> {
|
2016-10-15 15:32:14 +00:00
|
|
|
|
/// Consumes the `Arc`, returning the wrapped pointer.
|
|
|
|
|
///
|
|
|
|
|
/// To avoid a memory leak the pointer must be converted back to an `Arc` using
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`Arc::from_raw`].
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2019-06-01 09:55:25 +00:00
|
|
|
|
/// let x = Arc::new("hello".to_owned());
|
2016-10-15 15:32:14 +00:00
|
|
|
|
/// let x_ptr = Arc::into_raw(x);
|
2019-06-01 09:55:25 +00:00
|
|
|
|
/// assert_eq!(unsafe { &*x_ptr }, "hello");
|
2016-10-15 15:32:14 +00:00
|
|
|
|
/// ```
|
2021-10-31 02:06:31 +00:00
|
|
|
|
#[must_use = "losing the pointer will leak memory"]
|
2017-03-15 04:10:02 +00:00
|
|
|
|
#[stable(feature = "rc_raw", since = "1.17.0")]
|
2023-10-04 02:27:25 +00:00
|
|
|
|
#[rustc_never_returns_null_ptr]
|
2017-03-15 04:10:02 +00:00
|
|
|
|
pub fn into_raw(this: Self) -> *const T {
|
2020-04-13 17:08:33 +00:00
|
|
|
|
let ptr = Self::as_ptr(&this);
|
|
|
|
|
mem::forget(this);
|
|
|
|
|
ptr
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Provides a raw pointer to the data.
|
|
|
|
|
///
|
2020-07-17 13:21:57 +00:00
|
|
|
|
/// The counts are not affected in any way and the `Arc` is not consumed. The pointer is valid for
|
2020-04-13 17:08:33 +00:00
|
|
|
|
/// as long as there are strong counts in the `Arc`.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x = Arc::new("hello".to_owned());
|
|
|
|
|
/// let y = Arc::clone(&x);
|
|
|
|
|
/// let x_ptr = Arc::as_ptr(&x);
|
|
|
|
|
/// assert_eq!(x_ptr, Arc::as_ptr(&y));
|
|
|
|
|
/// assert_eq!(unsafe { &*x_ptr }, "hello");
|
|
|
|
|
/// ```
|
2021-10-11 17:57:38 +00:00
|
|
|
|
#[must_use]
|
2020-07-02 20:55:54 +00:00
|
|
|
|
#[stable(feature = "rc_as_ptr", since = "1.45.0")]
|
2023-10-04 02:27:25 +00:00
|
|
|
|
#[rustc_never_returns_null_ptr]
|
2020-04-13 17:08:33 +00:00
|
|
|
|
pub fn as_ptr(this: &Self) -> *const T {
|
2019-12-15 22:59:09 +00:00
|
|
|
|
let ptr: *mut ArcInner<T> = NonNull::as_ptr(this.ptr);
|
|
|
|
|
|
2020-07-01 18:51:08 +00:00
|
|
|
|
// SAFETY: This cannot go through Deref::deref or RcBoxPtr::inner because
|
|
|
|
|
// this is required to retain raw/mut provenance such that e.g. `get_mut` can
|
2020-06-30 16:35:28 +00:00
|
|
|
|
// write through the pointer after the Rc is recovered through `from_raw`.
|
2021-01-10 18:35:42 +00:00
|
|
|
|
unsafe { ptr::addr_of_mut!((*ptr).data) }
|
2016-10-15 15:32:14 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// Constructs an `Arc<T, A>` from a raw pointer.
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
2020-01-28 21:28:13 +00:00
|
|
|
|
/// The raw pointer must have been previously returned by a call to
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// [`Arc<U, A>::into_raw`][into_raw] where `U` must have the same size and
|
2020-01-28 21:28:13 +00:00
|
|
|
|
/// alignment as `T`. This is trivially true if `U` is `T`.
|
|
|
|
|
/// Note that if `U` is not `T` but has the same size and alignment, this is
|
|
|
|
|
/// basically like transmuting references of different types. See
|
2023-07-03 17:51:31 +00:00
|
|
|
|
/// [`mem::transmute`] for more information on what
|
2020-01-28 21:28:13 +00:00
|
|
|
|
/// restrictions apply in this case.
|
2023-06-30 15:39:34 +00:00
|
|
|
|
///
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// The raw pointer must point to a block of memory allocated by `alloc`
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
2020-01-28 21:28:13 +00:00
|
|
|
|
/// The user of `from_raw` has to make sure a specific value of `T` is only
|
|
|
|
|
/// dropped once.
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
2020-01-10 18:39:01 +00:00
|
|
|
|
/// This function is unsafe because improper use may lead to memory unsafety,
|
2020-01-28 21:28:13 +00:00
|
|
|
|
/// even if the returned `Arc<T>` is never accessed.
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [into_raw]: Arc::into_raw
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
2016-10-15 15:32:14 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// use std::alloc::System;
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// let x = Arc::new_in("hello".to_owned(), System);
|
2016-10-15 15:32:14 +00:00
|
|
|
|
/// let x_ptr = Arc::into_raw(x);
|
|
|
|
|
///
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// // Convert back to an `Arc` to prevent leak.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// let x = Arc::from_raw_in(x_ptr, System);
|
2019-06-01 09:55:25 +00:00
|
|
|
|
/// assert_eq!(&*x, "hello");
|
2016-10-15 15:32:14 +00:00
|
|
|
|
///
|
2019-09-05 16:15:28 +00:00
|
|
|
|
/// // Further calls to `Arc::from_raw(x_ptr)` would be memory-unsafe.
|
2016-10-15 15:32:14 +00:00
|
|
|
|
/// }
|
|
|
|
|
///
|
|
|
|
|
/// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
|
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
pub unsafe fn from_raw_in(ptr: *const T, alloc: A) -> Self {
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
let offset = data_offset(ptr);
|
2017-08-24 05:50:00 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
// Reverse the offset to find the original ArcInner.
|
2022-07-10 10:14:28 +00:00
|
|
|
|
let arc_ptr = ptr.byte_sub(offset) as *mut ArcInner<T>;
|
2017-08-24 05:50:00 +00:00
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Self::from_ptr_in(arc_ptr, alloc)
|
2020-05-28 21:27:00 +00:00
|
|
|
|
}
|
2016-10-15 15:32:14 +00:00
|
|
|
|
}
|
2013-07-22 20:57:40 +00:00
|
|
|
|
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// Creates a new [`Weak`] pointer to this allocation.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// let weak_five = Arc::downgrade(&five);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2021-10-12 00:40:03 +00:00
|
|
|
|
#[must_use = "this returns a new `Weak` pointer, \
|
|
|
|
|
without modifying the original `Arc`"]
|
2015-09-10 20:26:44 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub fn downgrade(this: &Self) -> Weak<T, A>
|
|
|
|
|
where
|
|
|
|
|
A: Clone,
|
|
|
|
|
{
|
2016-03-31 12:15:20 +00:00
|
|
|
|
// This Relaxed is OK because we're checking the value in the CAS
|
|
|
|
|
// below.
|
|
|
|
|
let mut cur = this.inner().weak.load(Relaxed);
|
2015-06-26 21:32:34 +00:00
|
|
|
|
|
2016-03-31 12:15:20 +00:00
|
|
|
|
loop {
|
2015-06-26 21:32:34 +00:00
|
|
|
|
// check if the weak counter is currently "locked"; if so, spin.
|
2015-09-23 22:00:54 +00:00
|
|
|
|
if cur == usize::MAX {
|
2020-09-12 16:53:30 +00:00
|
|
|
|
hint::spin_loop();
|
2016-04-05 13:00:17 +00:00
|
|
|
|
cur = this.inner().weak.load(Relaxed);
|
2015-11-23 02:32:40 +00:00
|
|
|
|
continue;
|
2015-09-23 22:00:54 +00:00
|
|
|
|
}
|
2015-06-26 21:32:34 +00:00
|
|
|
|
|
2023-03-03 19:35:47 +00:00
|
|
|
|
// We can't allow the refcount to increase much past `MAX_REFCOUNT`.
|
|
|
|
|
assert!(cur <= MAX_REFCOUNT, "{}", INTERNAL_OVERFLOW_ERROR);
|
|
|
|
|
|
2015-06-26 21:32:34 +00:00
|
|
|
|
// NOTE: this code currently ignores the possibility of overflow
|
|
|
|
|
// into usize::MAX; in general both Rc and Arc need to be adjusted
|
|
|
|
|
// to deal with overflow.
|
|
|
|
|
|
|
|
|
|
// Unlike with Clone(), we need this to be an Acquire read to
|
|
|
|
|
// synchronize with the write coming from `is_unique`, so that the
|
|
|
|
|
// events prior to that write happen before this read.
|
2016-03-31 12:15:20 +00:00
|
|
|
|
match this.inner().weak.compare_exchange_weak(cur, cur + 1, Acquire, Relaxed) {
|
2018-07-23 09:13:20 +00:00
|
|
|
|
Ok(_) => {
|
|
|
|
|
// Make sure we do not create a dangling Weak
|
2021-01-11 04:27:32 +00:00
|
|
|
|
debug_assert!(!is_dangling(this.ptr.as_ptr()));
|
2022-04-28 02:22:52 +00:00
|
|
|
|
return Weak { ptr: this.ptr, alloc: this.alloc.clone() };
|
2018-07-23 09:13:20 +00:00
|
|
|
|
}
|
2016-03-31 12:15:20 +00:00
|
|
|
|
Err(old) => cur = old,
|
2015-06-26 21:32:34 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2013-05-20 10:07:14 +00:00
|
|
|
|
}
|
2013-05-24 20:54:58 +00:00
|
|
|
|
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// Gets the number of [`Weak`] pointers to this allocation.
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2016-11-08 19:15:20 +00:00
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// This method by itself is safe, but using it correctly requires extra care.
|
|
|
|
|
/// Another thread can change the weak count at any time,
|
|
|
|
|
/// including potentially between calling this method and acting on the result.
|
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::new(5);
|
|
|
|
|
/// let _weak_five = Arc::downgrade(&five);
|
|
|
|
|
///
|
|
|
|
|
/// // This assertion is deterministic because we haven't shared
|
|
|
|
|
/// // the `Arc` or `Weak` between threads.
|
|
|
|
|
/// assert_eq!(1, Arc::weak_count(&five));
|
|
|
|
|
/// ```
|
2015-06-11 02:14:35 +00:00
|
|
|
|
#[inline]
|
2021-10-14 23:56:53 +00:00
|
|
|
|
#[must_use]
|
2016-12-14 20:27:30 +00:00
|
|
|
|
#[stable(feature = "arc_counts", since = "1.15.0")]
|
2015-08-12 21:37:27 +00:00
|
|
|
|
pub fn weak_count(this: &Self) -> usize {
|
2023-09-04 20:43:21 +00:00
|
|
|
|
let cnt = this.inner().weak.load(Relaxed);
|
2017-07-18 17:31:22 +00:00
|
|
|
|
// If the weak count is currently locked, the value of the
|
|
|
|
|
// count was 0 just before taking the lock.
|
|
|
|
|
if cnt == usize::MAX { 0 } else { cnt - 1 }
|
2015-06-11 02:14:35 +00:00
|
|
|
|
}
|
|
|
|
|
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Gets the number of strong (`Arc`) pointers to this allocation.
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2016-11-08 19:15:20 +00:00
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// This method by itself is safe, but using it correctly requires extra care.
|
|
|
|
|
/// Another thread can change the strong count at any time,
|
|
|
|
|
/// including potentially between calling this method and acting on the result.
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::new(5);
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let _also_five = Arc::clone(&five);
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
|
|
|
|
/// // This assertion is deterministic because we haven't shared
|
|
|
|
|
/// // the `Arc` between threads.
|
|
|
|
|
/// assert_eq!(2, Arc::strong_count(&five));
|
|
|
|
|
/// ```
|
2015-06-11 02:14:35 +00:00
|
|
|
|
#[inline]
|
2021-10-14 23:56:53 +00:00
|
|
|
|
#[must_use]
|
2016-12-14 20:27:30 +00:00
|
|
|
|
#[stable(feature = "arc_counts", since = "1.15.0")]
|
2015-08-12 21:37:27 +00:00
|
|
|
|
pub fn strong_count(this: &Self) -> usize {
|
2023-09-04 20:43:21 +00:00
|
|
|
|
this.inner().strong.load(Relaxed)
|
2015-06-11 02:14:35 +00:00
|
|
|
|
}
|
|
|
|
|
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// Increments the strong reference count on the `Arc<T>` associated with the
|
|
|
|
|
/// provided pointer by one.
|
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// The pointer must have been obtained through `Arc::into_raw`, and the
|
|
|
|
|
/// associated `Arc` instance must be valid (i.e. the strong count must be at
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// least 1) for the duration of this method,, and `ptr` must point to a block of memory
|
|
|
|
|
/// allocated by `alloc`.
|
2020-04-03 11:10:13 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// use std::alloc::System;
|
2020-04-03 11:10:13 +00:00
|
|
|
|
///
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// let five = Arc::new_in(5, System);
|
2020-04-03 11:10:13 +00:00
|
|
|
|
///
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// let ptr = Arc::into_raw(five);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// Arc::increment_strong_count_in(ptr, System);
|
2020-04-03 11:10:13 +00:00
|
|
|
|
///
|
|
|
|
|
/// // This assertion is deterministic because we haven't shared
|
|
|
|
|
/// // the `Arc` between threads.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// let five = Arc::from_raw_in(ptr, System);
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// assert_eq!(2, Arc::strong_count(&five));
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
pub unsafe fn increment_strong_count_in(ptr: *const T, alloc: A)
|
|
|
|
|
where
|
|
|
|
|
A: Clone,
|
|
|
|
|
{
|
2020-04-03 11:10:13 +00:00
|
|
|
|
// Retain Arc, but don't touch refcount by wrapping in ManuallyDrop
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let arc = unsafe { mem::ManuallyDrop::new(Arc::from_raw_in(ptr, alloc)) };
|
2020-04-03 11:10:13 +00:00
|
|
|
|
// Now increase refcount, but don't drop new refcount either
|
|
|
|
|
let _arc_clone: mem::ManuallyDrop<_> = arc.clone();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Decrements the strong reference count on the `Arc<T>` associated with the
|
|
|
|
|
/// provided pointer by one.
|
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// The pointer must have been obtained through `Arc::into_raw`, the
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// associated `Arc` instance must be valid (i.e. the strong count must be at
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// least 1) when invoking this method, and `ptr` must point to a block of memory
|
|
|
|
|
/// allocated by `alloc`. This method can be used to release the final
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// `Arc` and backing storage, but **should not** be called after the final `Arc` has been
|
|
|
|
|
/// released.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// use std::alloc::System;
|
2020-04-03 11:10:13 +00:00
|
|
|
|
///
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// let five = Arc::new_in(5, System);
|
2020-04-03 11:10:13 +00:00
|
|
|
|
///
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// let ptr = Arc::into_raw(five);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// Arc::increment_strong_count_in(ptr, System);
|
2020-04-03 11:10:13 +00:00
|
|
|
|
///
|
2020-05-14 00:00:00 +00:00
|
|
|
|
/// // Those assertions are deterministic because we haven't shared
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// // the `Arc` between threads.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// let five = Arc::from_raw_in(ptr, System);
|
2020-05-14 00:00:00 +00:00
|
|
|
|
/// assert_eq!(2, Arc::strong_count(&five));
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// Arc::decrement_strong_count_in(ptr, System);
|
2020-05-14 00:00:00 +00:00
|
|
|
|
/// assert_eq!(1, Arc::strong_count(&five));
|
2020-04-03 11:10:13 +00:00
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
pub unsafe fn decrement_strong_count_in(ptr: *const T, alloc: A) {
|
|
|
|
|
unsafe { drop(Arc::from_raw_in(ptr, alloc)) };
|
2020-04-03 11:10:13 +00:00
|
|
|
|
}
|
|
|
|
|
|
2014-10-17 18:00:02 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
fn inner(&self) -> &ArcInner<T> {
|
2015-02-25 07:27:20 +00:00
|
|
|
|
// This unsafety is ok because while this arc is alive we're guaranteed
|
|
|
|
|
// that the inner pointer is valid. Furthermore, we know that the
|
|
|
|
|
// `ArcInner` structure itself is `Sync` because the inner data is
|
|
|
|
|
// `Sync` as well, so we're ok loaning out an immutable pointer to these
|
|
|
|
|
// contents.
|
2017-04-04 16:31:38 +00:00
|
|
|
|
unsafe { self.ptr.as_ref() }
|
2014-10-17 18:00:02 +00:00
|
|
|
|
}
|
2015-03-19 00:35:11 +00:00
|
|
|
|
|
|
|
|
|
// Non-inlined part of `drop`.
|
|
|
|
|
#[inline(never)]
|
|
|
|
|
unsafe fn drop_slow(&mut self) {
|
2021-07-23 23:14:28 +00:00
|
|
|
|
// Destroy the data at this time, even though we must not free the box
|
|
|
|
|
// allocation itself (there might still be weak pointers lying around).
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe { ptr::drop_in_place(Self::get_mut_unchecked(self)) };
|
2015-03-19 00:35:11 +00:00
|
|
|
|
|
2020-05-24 12:11:12 +00:00
|
|
|
|
// Drop the weak ref collectively held by all strong references
|
2022-04-28 02:22:52 +00:00
|
|
|
|
// Take a reference to `self.alloc` instead of cloning because 1. it'll
|
|
|
|
|
// last long enough, and 2. you should be able to drop `Arc`s with
|
|
|
|
|
// unclonable allocators
|
|
|
|
|
drop(Weak { ptr: self.ptr, alloc: &self.alloc });
|
2015-03-19 00:35:11 +00:00
|
|
|
|
}
|
2016-08-25 16:43:40 +00:00
|
|
|
|
|
2022-10-26 09:15:14 +00:00
|
|
|
|
/// Returns `true` if the two `Arc`s point to the same allocation in a vein similar to
|
2023-01-04 13:16:55 +00:00
|
|
|
|
/// [`ptr::eq`]. This function ignores the metadata of `dyn Trait` pointers.
|
2016-08-25 16:43:40 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::new(5);
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let same_five = Arc::clone(&five);
|
2016-08-25 16:43:40 +00:00
|
|
|
|
/// let other_five = Arc::new(5);
|
|
|
|
|
///
|
|
|
|
|
/// assert!(Arc::ptr_eq(&five, &same_five));
|
|
|
|
|
/// assert!(!Arc::ptr_eq(&five, &other_five));
|
|
|
|
|
/// ```
|
2019-10-19 11:48:02 +00:00
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [`ptr::eq`]: core::ptr::eq "ptr::eq"
|
2021-10-14 23:56:53 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
#[must_use]
|
|
|
|
|
#[stable(feature = "ptr_eq", since = "1.17.0")]
|
2016-08-25 16:43:40 +00:00
|
|
|
|
pub fn ptr_eq(this: &Self, other: &Self) -> bool {
|
2023-10-03 00:32:01 +00:00
|
|
|
|
ptr::addr_eq(this.ptr.as_ptr(), other.ptr.as_ptr())
|
2016-08-25 16:43:40 +00:00
|
|
|
|
}
|
2014-11-21 22:56:33 +00:00
|
|
|
|
}
|
2014-11-20 21:38:36 +00:00
|
|
|
|
|
2017-06-15 21:10:43 +00:00
|
|
|
|
impl<T: ?Sized> Arc<T> {
|
2019-06-21 21:01:48 +00:00
|
|
|
|
/// Allocates an `ArcInner<T>` with sufficient space for
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// a possibly-unsized inner value where the value has the layout provided.
|
2019-06-21 21:01:48 +00:00
|
|
|
|
///
|
|
|
|
|
/// The function `mem_to_arcinner` is called with the data pointer
|
|
|
|
|
/// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-08-17 13:39:21 +00:00
|
|
|
|
unsafe fn allocate_for_layout(
|
2019-06-19 08:23:28 +00:00
|
|
|
|
value_layout: Layout,
|
2020-09-24 22:10:56 +00:00
|
|
|
|
allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
|
2019-06-19 08:23:28 +00:00
|
|
|
|
mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
|
|
|
|
|
) -> *mut ArcInner<T> {
|
2022-11-14 00:51:05 +00:00
|
|
|
|
let layout = arcinner_layout_for_value_layout(value_layout);
|
2023-05-16 06:53:05 +00:00
|
|
|
|
|
|
|
|
|
let ptr = allocate(layout).unwrap_or_else(|_| handle_alloc_error(layout));
|
|
|
|
|
|
|
|
|
|
unsafe { Self::initialize_arcinner(ptr, layout, mem_to_arcinner) }
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
|
2020-12-31 08:30:23 +00:00
|
|
|
|
/// Allocates an `ArcInner<T>` with sufficient space for
|
|
|
|
|
/// a possibly-unsized inner value where the value has the layout provided,
|
|
|
|
|
/// returning an error if allocation fails.
|
|
|
|
|
///
|
|
|
|
|
/// The function `mem_to_arcinner` is called with the data pointer
|
|
|
|
|
/// and must return back a (potentially fat)-pointer for the `ArcInner<T>`.
|
|
|
|
|
unsafe fn try_allocate_for_layout(
|
|
|
|
|
value_layout: Layout,
|
|
|
|
|
allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
|
|
|
|
|
mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
|
|
|
|
|
) -> Result<*mut ArcInner<T>, AllocError> {
|
2022-11-14 00:51:05 +00:00
|
|
|
|
let layout = arcinner_layout_for_value_layout(value_layout);
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-12-31 08:30:23 +00:00
|
|
|
|
let ptr = allocate(layout)?;
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2023-05-16 06:53:05 +00:00
|
|
|
|
let inner = unsafe { Self::initialize_arcinner(ptr, layout, mem_to_arcinner) };
|
|
|
|
|
|
|
|
|
|
Ok(inner)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
unsafe fn initialize_arcinner(
|
|
|
|
|
ptr: NonNull<[u8]>,
|
|
|
|
|
layout: Layout,
|
|
|
|
|
mem_to_arcinner: impl FnOnce(*mut u8) -> *mut ArcInner<T>,
|
|
|
|
|
) -> *mut ArcInner<T> {
|
2020-08-04 16:03:34 +00:00
|
|
|
|
let inner = mem_to_arcinner(ptr.as_non_null_ptr().as_ptr());
|
2020-05-28 21:27:00 +00:00
|
|
|
|
debug_assert_eq!(unsafe { Layout::for_value(&*inner) }, layout);
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
ptr::write(&mut (*inner).strong, atomic::AtomicUsize::new(1));
|
|
|
|
|
ptr::write(&mut (*inner).weak, atomic::AtomicUsize::new(1));
|
|
|
|
|
}
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2023-05-16 06:53:05 +00:00
|
|
|
|
inner
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
2022-04-28 02:22:52 +00:00
|
|
|
|
}
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> Arc<T, A> {
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Allocates an `ArcInner<T>` with sufficient space for an unsized inner value.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
#[inline]
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe fn allocate_for_ptr_in(ptr: *const T, alloc: &A) -> *mut ArcInner<T> {
|
2019-06-19 08:23:28 +00:00
|
|
|
|
// Allocate for the `ArcInner<T>` using the given value.
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Arc::allocate_for_layout(
|
2020-08-05 00:49:21 +00:00
|
|
|
|
Layout::for_value(&*ptr),
|
2022-04-28 02:22:52 +00:00
|
|
|
|
|layout| alloc.allocate(layout),
|
2022-10-21 12:34:16 +00:00
|
|
|
|
|mem| mem.with_metadata_of(ptr as *const ArcInner<T>),
|
2020-08-05 00:49:21 +00:00
|
|
|
|
)
|
2020-05-28 21:27:00 +00:00
|
|
|
|
}
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn from_box_in(src: Box<T, A>) -> Arc<T, A> {
|
2017-06-15 21:10:43 +00:00
|
|
|
|
unsafe {
|
2022-08-01 20:51:58 +00:00
|
|
|
|
let value_size = size_of_val(&*src);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let ptr = Self::allocate_for_ptr_in(&*src, Box::allocator(&src));
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
|
|
|
|
// Copy value as bytes
|
|
|
|
|
ptr::copy_nonoverlapping(
|
2022-08-01 20:51:58 +00:00
|
|
|
|
&*src as *const T as *const u8,
|
2017-06-15 21:10:43 +00:00
|
|
|
|
&mut (*ptr).data as *mut _ as *mut u8,
|
|
|
|
|
value_size,
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
// Free the allocation without dropping its contents
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let (bptr, alloc) = Box::into_raw_with_allocator(src);
|
|
|
|
|
let src = Box::from_raw(bptr as *mut mem::ManuallyDrop<T>);
|
2022-08-01 20:51:58 +00:00
|
|
|
|
drop(src);
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Self::from_ptr_in(ptr, alloc)
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-06-19 08:23:28 +00:00
|
|
|
|
impl<T> Arc<[T]> {
|
2019-06-21 21:01:48 +00:00
|
|
|
|
/// Allocates an `ArcInner<[T]>` with the given length.
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-06-19 08:23:28 +00:00
|
|
|
|
unsafe fn allocate_for_slice(len: usize) -> *mut ArcInner<[T]> {
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe {
|
2020-08-05 00:49:21 +00:00
|
|
|
|
Self::allocate_for_layout(
|
|
|
|
|
Layout::array::<T>(len).unwrap(),
|
2020-12-04 13:47:15 +00:00
|
|
|
|
|layout| Global.allocate(layout),
|
2022-04-28 02:22:52 +00:00
|
|
|
|
|mem| ptr::slice_from_raw_parts_mut(mem.cast::<T>(), len) as *mut ArcInner<[T]>,
|
2020-08-05 00:49:21 +00:00
|
|
|
|
)
|
2020-05-28 21:27:00 +00:00
|
|
|
|
}
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2022-11-14 00:51:05 +00:00
|
|
|
|
/// Copy elements from slice into newly allocated `Arc<[T]>`
|
2019-06-21 21:01:48 +00:00
|
|
|
|
///
|
|
|
|
|
/// Unsafe because the caller must either take ownership or bind `T: Copy`.
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2017-06-15 21:10:43 +00:00
|
|
|
|
unsafe fn copy_from_slice(v: &[T]) -> Arc<[T]> {
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
let ptr = Self::allocate_for_slice(v.len());
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
ptr::copy_nonoverlapping(v.as_ptr(), &mut (*ptr).data as *mut [T] as *mut T, v.len());
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
Self::from_ptr(ptr)
|
|
|
|
|
}
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
|
2019-06-19 08:23:28 +00:00
|
|
|
|
/// Constructs an `Arc<[T]>` from an iterator known to be of a certain size.
|
|
|
|
|
///
|
|
|
|
|
/// Behavior is undefined should the size be wrong.
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2022-08-09 00:14:43 +00:00
|
|
|
|
unsafe fn from_iter_exact(iter: impl Iterator<Item = T>, len: usize) -> Arc<[T]> {
|
2017-06-15 21:10:43 +00:00
|
|
|
|
// Panic guard while cloning T elements.
|
|
|
|
|
// In the event of a panic, elements that have been written
|
|
|
|
|
// into the new ArcInner will be dropped, then the memory freed.
|
|
|
|
|
struct Guard<T> {
|
2018-04-02 23:51:02 +00:00
|
|
|
|
mem: NonNull<u8>,
|
2017-06-15 21:10:43 +00:00
|
|
|
|
elems: *mut T,
|
|
|
|
|
layout: Layout,
|
|
|
|
|
n_elems: usize,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<T> Drop for Guard<T> {
|
|
|
|
|
fn drop(&mut self) {
|
|
|
|
|
unsafe {
|
|
|
|
|
let slice = from_raw_parts_mut(self.elems, self.n_elems);
|
|
|
|
|
ptr::drop_in_place(slice);
|
|
|
|
|
|
2020-12-04 13:47:15 +00:00
|
|
|
|
Global.deallocate(self.mem, self.layout);
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
let ptr = Self::allocate_for_slice(len);
|
2019-06-19 08:23:28 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
let mem = ptr as *mut _ as *mut u8;
|
|
|
|
|
let layout = Layout::for_value(&*ptr);
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
// Pointer to first element
|
|
|
|
|
let elems = &mut (*ptr).data as *mut [T] as *mut T;
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
let mut guard = Guard { mem: NonNull::new_unchecked(mem), elems, layout, n_elems: 0 };
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
for (i, item) in iter.enumerate() {
|
|
|
|
|
ptr::write(elems.add(i), item);
|
|
|
|
|
guard.n_elems += 1;
|
|
|
|
|
}
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
// All clear. Forget the guard so it doesn't free the new ArcInner.
|
|
|
|
|
mem::forget(guard);
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2020-05-28 21:27:00 +00:00
|
|
|
|
Self::from_ptr(ptr)
|
|
|
|
|
}
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T, A: Allocator> Arc<[T], A> {
|
|
|
|
|
/// Allocates an `ArcInner<[T]>` with the given length.
|
|
|
|
|
#[inline]
|
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
|
|
|
|
unsafe fn allocate_for_slice_in(len: usize, alloc: &A) -> *mut ArcInner<[T]> {
|
|
|
|
|
unsafe {
|
|
|
|
|
Arc::allocate_for_layout(
|
|
|
|
|
Layout::array::<T>(len).unwrap(),
|
|
|
|
|
|layout| alloc.allocate(layout),
|
|
|
|
|
|mem| ptr::slice_from_raw_parts_mut(mem.cast::<T>(), len) as *mut ArcInner<[T]>,
|
|
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-06-21 21:01:48 +00:00
|
|
|
|
/// Specialization trait used for `From<&[T]>`.
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-06-19 08:23:28 +00:00
|
|
|
|
trait ArcFromSlice<T> {
|
|
|
|
|
fn from_slice(slice: &[T]) -> Self;
|
|
|
|
|
}
|
2017-06-15 21:10:43 +00:00
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-06-19 08:23:28 +00:00
|
|
|
|
impl<T: Clone> ArcFromSlice<T> for Arc<[T]> {
|
|
|
|
|
#[inline]
|
|
|
|
|
default fn from_slice(v: &[T]) -> Self {
|
|
|
|
|
unsafe { Self::from_iter_exact(v.iter().cloned(), v.len()) }
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2017-06-15 21:10:43 +00:00
|
|
|
|
impl<T: Copy> ArcFromSlice<T> for Arc<[T]> {
|
|
|
|
|
#[inline]
|
|
|
|
|
fn from_slice(v: &[T]) -> Self {
|
|
|
|
|
unsafe { Arc::copy_from_slice(v) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator + Clone> Clone for Arc<T, A> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Makes a clone of the `Arc` pointer.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// This creates another pointer to the same allocation, increasing the
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// strong reference count.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2018-10-12 06:10:37 +00:00
|
|
|
|
/// let _ = Arc::clone(&five);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2013-10-24 20:21:49 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn clone(&self) -> Arc<T, A> {
|
2015-02-25 07:27:20 +00:00
|
|
|
|
// Using a relaxed ordering is alright here, as knowledge of the
|
|
|
|
|
// original reference prevents other threads from erroneously deleting
|
|
|
|
|
// the object.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
//
|
2015-02-25 07:27:20 +00:00
|
|
|
|
// As explained in the [Boost documentation][1], Increasing the
|
|
|
|
|
// reference counter can always be done with memory_order_relaxed: New
|
|
|
|
|
// references to an object can only be formed from an existing
|
|
|
|
|
// reference, and passing an existing reference from one thread to
|
|
|
|
|
// another must already provide any required synchronization.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
//
|
|
|
|
|
// [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
|
2015-07-21 00:09:44 +00:00
|
|
|
|
let old_size = self.inner().strong.fetch_add(1, Relaxed);
|
|
|
|
|
|
2022-06-22 00:11:28 +00:00
|
|
|
|
// However we need to guard against massive refcounts in case someone is `mem::forget`ing
|
|
|
|
|
// Arcs. If we don't do this the count can overflow and users will use-after free. This
|
|
|
|
|
// branch will never be taken in any realistic program. We abort because such a program is
|
|
|
|
|
// incredibly degenerate, and we don't care to support it.
|
2015-07-21 00:09:44 +00:00
|
|
|
|
//
|
2022-06-22 00:11:28 +00:00
|
|
|
|
// This check is not 100% water-proof: we error when the refcount grows beyond `isize::MAX`.
|
|
|
|
|
// But we do that check *after* having done the increment, so there is a chance here that
|
|
|
|
|
// the worst already happened and we actually do overflow the `usize` counter. However, that
|
|
|
|
|
// requires the counter to grow from `isize::MAX` to `usize::MAX` between the increment
|
|
|
|
|
// above and the `abort` below, which seems exceedingly unlikely.
|
2023-03-03 19:35:47 +00:00
|
|
|
|
//
|
|
|
|
|
// This is a global invariant, and also applies when using a compare-exchange loop to increment
|
|
|
|
|
// counters in other methods.
|
|
|
|
|
// Otherwise, the counter could be brought to an almost-overflow using a compare-exchange loop,
|
|
|
|
|
// and then overflow using a few `fetch_add`s.
|
2015-07-21 00:09:44 +00:00
|
|
|
|
if old_size > MAX_REFCOUNT {
|
2020-06-03 19:15:53 +00:00
|
|
|
|
abort();
|
2015-07-21 00:09:44 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe { Self::from_inner_in(self.ptr, self.alloc.clone()) }
|
2012-11-27 00:12:47 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> Deref for Arc<T, A> {
|
2015-01-01 19:53:20 +00:00
|
|
|
|
type Target = T;
|
|
|
|
|
|
2013-10-24 20:21:49 +00:00
|
|
|
|
#[inline]
|
2014-07-29 20:53:40 +00:00
|
|
|
|
fn deref(&self) -> &T {
|
2014-04-08 00:55:14 +00:00
|
|
|
|
&self.inner().data
|
2012-08-11 00:46:19 +00:00
|
|
|
|
}
|
2012-11-27 00:12:47 +00:00
|
|
|
|
}
|
|
|
|
|
|
2019-12-21 11:16:18 +00:00
|
|
|
|
#[unstable(feature = "receiver_trait", issue = "none")]
|
Stabilize `Rc`, `Arc` and `Pin` as method receivers
This lets you write methods using `self: Rc<Self>`, `self: Arc<Self>`, `self: Pin<&mut Self>`, `self: Pin<Box<Self>`, and other combinations involving `Pin` and another stdlib receiver type, without needing the `arbitrary_self_types`. Other user-created receiver types can be used, but they still require the feature flag to use.
This is implemented by introducing a new trait, `Receiver`, which the method receiver's type must implement if the `arbitrary_self_types` feature is not enabled. To keep composed receiver types such as `&Arc<Self>` unstable, the receiver type is also required to implement `Deref<Target=Self>` when the feature flag is not enabled.
This lets you use `self: Rc<Self>` and `self: Arc<Self>` in stable Rust, which was not allowed previously. It was agreed that they would be stabilized in #55786. `self: Pin<&Self>` and other pinned receiver types do not require the `arbitrary_self_types` feature, but they cannot be used on stable because `Pin` still requires the `pin` feature.
2018-11-20 16:50:50 +00:00
|
|
|
|
impl<T: ?Sized> Receiver for Arc<T> {}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: Clone, A: Allocator + Clone> Arc<T, A> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Makes a mutable reference into the given `Arc`.
|
|
|
|
|
///
|
2021-08-19 10:35:20 +00:00
|
|
|
|
/// If there are other `Arc` pointers to the same allocation, then `make_mut` will
|
|
|
|
|
/// [`clone`] the inner value to a new allocation to ensure unique ownership. This is also
|
|
|
|
|
/// referred to as clone-on-write.
|
2019-10-19 11:48:02 +00:00
|
|
|
|
///
|
2021-08-24 19:15:26 +00:00
|
|
|
|
/// However, if there are no other `Arc` pointers to this allocation, but some [`Weak`]
|
2022-06-01 12:12:36 +00:00
|
|
|
|
/// pointers, then the [`Weak`] pointers will be dissociated and the inner value will not
|
2021-08-24 19:15:26 +00:00
|
|
|
|
/// be cloned.
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2021-08-24 19:34:12 +00:00
|
|
|
|
/// See also [`get_mut`], which will fail rather than cloning the inner value
|
2022-06-01 11:47:39 +00:00
|
|
|
|
/// or dissociating [`Weak`] pointers.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2021-08-19 10:35:20 +00:00
|
|
|
|
/// [`clone`]: Clone::clone
|
|
|
|
|
/// [`get_mut`]: Arc::get_mut
|
2015-05-30 20:03:57 +00:00
|
|
|
|
///
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// let mut data = Arc::new(5);
|
|
|
|
|
///
|
|
|
|
|
/// *Arc::make_mut(&mut data) += 1; // Won't clone anything
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let mut other_data = Arc::clone(&data); // Won't clone inner data
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// *Arc::make_mut(&mut data) += 1; // Clones inner data
|
|
|
|
|
/// *Arc::make_mut(&mut data) += 1; // Won't clone anything
|
|
|
|
|
/// *Arc::make_mut(&mut other_data) *= 2; // Won't clone anything
|
|
|
|
|
///
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// // Now `data` and `other_data` point to different allocations.
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// assert_eq!(*data, 8);
|
|
|
|
|
/// assert_eq!(*other_data, 12);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2021-08-19 10:35:20 +00:00
|
|
|
|
///
|
2022-06-01 11:47:39 +00:00
|
|
|
|
/// [`Weak`] pointers will be dissociated:
|
2021-08-19 10:35:20 +00:00
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let mut data = Arc::new(75);
|
|
|
|
|
/// let weak = Arc::downgrade(&data);
|
|
|
|
|
///
|
|
|
|
|
/// assert!(75 == *data);
|
|
|
|
|
/// assert!(75 == *weak.upgrade().unwrap());
|
|
|
|
|
///
|
|
|
|
|
/// *Arc::make_mut(&mut data) += 1;
|
|
|
|
|
///
|
|
|
|
|
/// assert!(76 == *data);
|
|
|
|
|
/// assert!(weak.upgrade().is_none());
|
|
|
|
|
/// ```
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2013-06-18 21:45:18 +00:00
|
|
|
|
#[inline]
|
2015-09-10 20:26:44 +00:00
|
|
|
|
#[stable(feature = "arc_unique", since = "1.4.0")]
|
2015-08-12 21:37:27 +00:00
|
|
|
|
pub fn make_mut(this: &mut Self) -> &mut T {
|
2015-06-26 21:32:34 +00:00
|
|
|
|
// Note that we hold both a strong reference and a weak reference.
|
|
|
|
|
// Thus, releasing our strong reference only will not, by itself, cause
|
|
|
|
|
// the memory to be deallocated.
|
2015-05-30 20:03:57 +00:00
|
|
|
|
//
|
2015-06-26 21:32:34 +00:00
|
|
|
|
// Use Acquire to ensure that we see any writes to `weak` that happen
|
|
|
|
|
// before release writes (i.e., decrements) to `strong`. Since we hold a
|
|
|
|
|
// weak count, there's no chance the ArcInner itself could be
|
|
|
|
|
// deallocated.
|
2016-03-31 12:15:20 +00:00
|
|
|
|
if this.inner().strong.compare_exchange(1, 0, Acquire, Relaxed).is_err() {
|
2021-01-08 21:02:27 +00:00
|
|
|
|
// Another strong pointer exists, so we must clone.
|
|
|
|
|
// Pre-allocate memory to allow writing the cloned value directly.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let mut arc = Self::new_uninit_in(this.alloc.clone());
|
2021-01-08 21:02:27 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
let data = Arc::get_mut_unchecked(&mut arc);
|
|
|
|
|
(**this).write_clone_into_raw(data.as_mut_ptr());
|
|
|
|
|
*this = arc.assume_init();
|
|
|
|
|
}
|
2015-06-26 21:32:34 +00:00
|
|
|
|
} else if this.inner().weak.load(Relaxed) != 1 {
|
|
|
|
|
// Relaxed suffices in the above because this is fundamentally an
|
|
|
|
|
// optimization: we are always racing with weak pointers being
|
|
|
|
|
// dropped. Worst case, we end up allocated a new Arc unnecessarily.
|
|
|
|
|
|
|
|
|
|
// We removed the last strong ref, but there are additional weak
|
|
|
|
|
// refs remaining. We'll move the contents to a new Arc, and
|
|
|
|
|
// invalidate the other weak refs.
|
|
|
|
|
|
|
|
|
|
// Note that it is not possible for the read of `weak` to yield
|
|
|
|
|
// usize::MAX (i.e., locked), since the weak count can only be
|
|
|
|
|
// locked by a thread with a strong reference.
|
|
|
|
|
|
|
|
|
|
// Materialize our own implicit weak pointer, so that it can clean
|
|
|
|
|
// up the ArcInner as needed.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let _weak = Weak { ptr: this.ptr, alloc: this.alloc.clone() };
|
2015-06-26 21:32:34 +00:00
|
|
|
|
|
2021-01-12 01:32:21 +00:00
|
|
|
|
// Can just steal the data, all that's left is Weaks
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let mut arc = Self::new_uninit_in(this.alloc.clone());
|
2015-06-26 21:32:34 +00:00
|
|
|
|
unsafe {
|
2021-01-12 01:32:21 +00:00
|
|
|
|
let data = Arc::get_mut_unchecked(&mut arc);
|
|
|
|
|
data.as_mut_ptr().copy_from_nonoverlapping(&**this, 1);
|
|
|
|
|
ptr::write(this, arc.assume_init());
|
2015-06-26 21:32:34 +00:00
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
// We were the sole reference of either kind; bump back up the
|
|
|
|
|
// strong ref count.
|
|
|
|
|
this.inner().strong.store(1, Release);
|
2012-08-11 00:46:19 +00:00
|
|
|
|
}
|
2015-06-26 21:32:34 +00:00
|
|
|
|
|
2015-04-04 06:54:49 +00:00
|
|
|
|
// As with `get_mut()`, the unsafety is ok because our reference was
|
2015-03-29 21:38:05 +00:00
|
|
|
|
// either unique to begin with, or became one upon cloning the contents.
|
2020-05-24 12:11:12 +00:00
|
|
|
|
unsafe { Self::get_mut_unchecked(this) }
|
2012-08-11 00:46:19 +00:00
|
|
|
|
}
|
2021-12-06 11:25:42 +00:00
|
|
|
|
|
|
|
|
|
/// If we have the only reference to `T` then unwrap it. Otherwise, clone `T` and return the
|
|
|
|
|
/// clone.
|
|
|
|
|
///
|
|
|
|
|
/// Assuming `arc_t` is of type `Arc<T>`, this function is functionally equivalent to
|
|
|
|
|
/// `(*arc_t).clone()`, but will avoid cloning the inner value where possible.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(arc_unwrap_or_clone)]
|
|
|
|
|
/// # use std::{ptr, sync::Arc};
|
|
|
|
|
/// let inner = String::from("test");
|
|
|
|
|
/// let ptr = inner.as_ptr();
|
|
|
|
|
///
|
|
|
|
|
/// let arc = Arc::new(inner);
|
|
|
|
|
/// let inner = Arc::unwrap_or_clone(arc);
|
|
|
|
|
/// // The inner value was not cloned
|
|
|
|
|
/// assert!(ptr::eq(ptr, inner.as_ptr()));
|
|
|
|
|
///
|
|
|
|
|
/// let arc = Arc::new(inner);
|
|
|
|
|
/// let arc2 = arc.clone();
|
|
|
|
|
/// let inner = Arc::unwrap_or_clone(arc);
|
|
|
|
|
/// // Because there were 2 references, we had to clone the inner value.
|
|
|
|
|
/// assert!(!ptr::eq(ptr, inner.as_ptr()));
|
|
|
|
|
/// // `arc2` is the last reference, so when we unwrap it we get back
|
|
|
|
|
/// // the original `String`.
|
|
|
|
|
/// let inner = Arc::unwrap_or_clone(arc2);
|
|
|
|
|
/// assert!(ptr::eq(ptr, inner.as_ptr()));
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
2022-02-03 09:35:21 +00:00
|
|
|
|
#[unstable(feature = "arc_unwrap_or_clone", issue = "93610")]
|
2021-12-06 11:25:42 +00:00
|
|
|
|
pub fn unwrap_or_clone(this: Self) -> T {
|
|
|
|
|
Arc::try_unwrap(this).unwrap_or_else(|arc| (*arc).clone())
|
|
|
|
|
}
|
2012-08-11 00:46:19 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> Arc<T, A> {
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Returns a mutable reference into the given `Arc`, if there are
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// no other `Arc` or [`Weak`] pointers to the same allocation.
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2020-08-21 11:09:32 +00:00
|
|
|
|
/// Returns [`None`] otherwise, because it is not safe to
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// mutate a shared value.
|
|
|
|
|
///
|
|
|
|
|
/// See also [`make_mut`][make_mut], which will [`clone`][clone]
|
2021-08-24 19:34:12 +00:00
|
|
|
|
/// the inner value when there are other `Arc` pointers.
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [make_mut]: Arc::make_mut
|
|
|
|
|
/// [clone]: Clone::clone
|
2015-06-26 21:32:34 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2015-06-26 21:32:34 +00:00
|
|
|
|
///
|
|
|
|
|
/// let mut x = Arc::new(3);
|
|
|
|
|
/// *Arc::get_mut(&mut x).unwrap() = 4;
|
|
|
|
|
/// assert_eq!(*x, 4);
|
|
|
|
|
///
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let _y = Arc::clone(&x);
|
2015-06-26 21:32:34 +00:00
|
|
|
|
/// assert!(Arc::get_mut(&mut x).is_none());
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
2015-09-10 20:26:44 +00:00
|
|
|
|
#[stable(feature = "arc_unique", since = "1.4.0")]
|
2015-08-12 21:37:27 +00:00
|
|
|
|
pub fn get_mut(this: &mut Self) -> Option<&mut T> {
|
2015-06-26 21:32:34 +00:00
|
|
|
|
if this.is_unique() {
|
|
|
|
|
// 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.
|
2019-07-06 16:17:24 +00:00
|
|
|
|
unsafe { Some(Arc::get_mut_unchecked(this)) }
|
2015-06-26 21:32:34 +00:00
|
|
|
|
} else {
|
|
|
|
|
None
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Returns a mutable reference into the given `Arc`,
|
2019-07-06 16:17:24 +00:00
|
|
|
|
/// without any check.
|
|
|
|
|
///
|
|
|
|
|
/// See also [`get_mut`], which is safe and does appropriate checks.
|
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`get_mut`]: Arc::get_mut
|
2019-07-06 16:17:24 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
2022-09-02 06:34:34 +00:00
|
|
|
|
/// If any other `Arc` or [`Weak`] pointers to the same allocation exist, then
|
2023-01-29 19:11:36 +00:00
|
|
|
|
/// they must not be dereferenced or have active borrows for the duration
|
2022-09-02 06:34:34 +00:00
|
|
|
|
/// of the returned borrow, and their inner type must be exactly the same as the
|
|
|
|
|
/// inner type of this Rc (including lifetimes). This is trivially the case if no
|
|
|
|
|
/// such pointers exist, for example immediately after `Arc::new`.
|
2019-07-06 16:17:24 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2019-07-06 15:19:58 +00:00
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
2019-07-06 16:17:24 +00:00
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let mut x = Arc::new(String::new());
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// Arc::get_mut_unchecked(&mut x).push_str("foo")
|
|
|
|
|
/// }
|
|
|
|
|
/// assert_eq!(*x, "foo");
|
|
|
|
|
/// ```
|
2022-09-02 05:47:15 +00:00
|
|
|
|
/// Other `Arc` pointers to the same allocation must be to the same type.
|
2022-09-02 07:23:56 +00:00
|
|
|
|
/// ```no_run
|
2022-09-02 05:47:15 +00:00
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x: Arc<str> = Arc::from("Hello, world!");
|
|
|
|
|
/// let mut y: Arc<[u8]> = x.clone().into();
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// // this is Undefined Behavior, because x's inner type is str, not [u8]
|
|
|
|
|
/// Arc::get_mut_unchecked(&mut y).fill(0xff); // 0xff is invalid in UTF-8
|
|
|
|
|
/// }
|
2022-09-02 06:45:57 +00:00
|
|
|
|
/// println!("{}", &*x); // Invalid UTF-8 in a str
|
2022-09-02 05:47:15 +00:00
|
|
|
|
/// ```
|
|
|
|
|
/// Other `Arc` pointers to the same allocation must be to the exact same type, including lifetimes.
|
2022-09-02 07:23:56 +00:00
|
|
|
|
/// ```no_run
|
2022-09-02 05:47:15 +00:00
|
|
|
|
/// #![feature(get_mut_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x: Arc<&str> = Arc::new("Hello, world!");
|
|
|
|
|
/// {
|
|
|
|
|
/// let s = String::from("Oh, no!");
|
|
|
|
|
/// let mut y: Arc<&str> = x.clone().into();
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// // this is Undefined Behavior, because x's inner type
|
|
|
|
|
/// // is &'long str, not &'short str
|
|
|
|
|
/// *Arc::get_mut_unchecked(&mut y) = &s;
|
|
|
|
|
/// }
|
|
|
|
|
/// }
|
|
|
|
|
/// println!("{}", &*x); // Use-after-free
|
|
|
|
|
/// ```
|
2019-07-06 16:17:24 +00:00
|
|
|
|
#[inline]
|
2019-08-05 15:45:30 +00:00
|
|
|
|
#[unstable(feature = "get_mut_unchecked", issue = "63292")]
|
2019-07-06 16:17:24 +00:00
|
|
|
|
pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
|
2020-05-24 12:11:12 +00:00
|
|
|
|
// We are careful to *not* create a reference covering the "count" fields, as
|
|
|
|
|
// this would alias with concurrent access to the reference counts (e.g. by `Weak`).
|
2020-05-28 21:27:00 +00:00
|
|
|
|
unsafe { &mut (*this.ptr.as_ptr()).data }
|
2019-07-06 16:17:24 +00:00
|
|
|
|
}
|
|
|
|
|
|
2015-06-26 21:32:34 +00:00
|
|
|
|
/// Determine whether this is the unique reference (including weak refs) to
|
|
|
|
|
/// the underlying data.
|
|
|
|
|
///
|
|
|
|
|
/// Note that this requires locking the weak ref count.
|
|
|
|
|
fn is_unique(&mut self) -> bool {
|
|
|
|
|
// lock the weak pointer count if we appear to be the sole weak pointer
|
|
|
|
|
// holder.
|
|
|
|
|
//
|
|
|
|
|
// The acquire label here ensures a happens-before relationship with any
|
2018-07-03 20:10:30 +00:00
|
|
|
|
// writes to `strong` (in particular in `Weak::upgrade`) prior to decrements
|
2023-01-14 15:33:11 +00:00
|
|
|
|
// of the `weak` count (via `Weak::drop`, which uses release). If the upgraded
|
2018-07-03 20:10:30 +00:00
|
|
|
|
// weak ref was never dropped, the CAS here will fail so we do not care to synchronize.
|
2016-03-31 12:15:20 +00:00
|
|
|
|
if self.inner().weak.compare_exchange(1, usize::MAX, Acquire, Relaxed).is_ok() {
|
2018-07-03 20:10:30 +00:00
|
|
|
|
// This needs to be an `Acquire` to synchronize with the decrement of the `strong`
|
|
|
|
|
// counter in `drop` -- the only access that happens when any but the last reference
|
|
|
|
|
// is being dropped.
|
|
|
|
|
let unique = self.inner().strong.load(Acquire) == 1;
|
2015-06-26 21:32:34 +00:00
|
|
|
|
|
|
|
|
|
// The release write here synchronizes with a read in `downgrade`,
|
|
|
|
|
// effectively preventing the above read of `strong` from happening
|
|
|
|
|
// after the write.
|
|
|
|
|
self.inner().weak.store(1, Release); // release the lock
|
|
|
|
|
unique
|
|
|
|
|
} else {
|
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe impl<#[may_dangle] T: ?Sized, A: Allocator> Drop for Arc<T, A> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Drops the `Arc`.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2015-03-23 22:54:39 +00:00
|
|
|
|
/// This will decrement the strong reference count. If the strong reference
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// count reaches zero then the only other references (if any) are
|
2018-07-01 16:51:39 +00:00
|
|
|
|
/// [`Weak`], so we `drop` the inner value.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// struct Foo;
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// impl Drop for Foo {
|
|
|
|
|
/// fn drop(&mut self) {
|
|
|
|
|
/// println!("dropped!");
|
|
|
|
|
/// }
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// }
|
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// let foo = Arc::new(Foo);
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let foo2 = Arc::clone(&foo);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// drop(foo); // Doesn't print anything
|
|
|
|
|
/// drop(foo2); // Prints "dropped!"
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2015-03-19 00:35:11 +00:00
|
|
|
|
#[inline]
|
2013-09-17 01:18:07 +00:00
|
|
|
|
fn drop(&mut self) {
|
2015-03-23 22:54:39 +00:00
|
|
|
|
// Because `fetch_sub` is already atomic, we do not need to synchronize
|
|
|
|
|
// with other threads unless we are going to delete the object. This
|
|
|
|
|
// same logic applies to the below `fetch_sub` to the `weak` count.
|
2015-09-23 22:00:54 +00:00
|
|
|
|
if self.inner().strong.fetch_sub(1, Release) != 1 {
|
2015-11-23 02:32:40 +00:00
|
|
|
|
return;
|
2015-09-23 22:00:54 +00:00
|
|
|
|
}
|
2014-03-22 07:53:58 +00:00
|
|
|
|
|
2015-03-23 22:54:39 +00:00
|
|
|
|
// This fence is needed to prevent reordering of use of the data and
|
2023-01-14 15:33:11 +00:00
|
|
|
|
// deletion of the data. Because it is marked `Release`, the decreasing
|
2015-03-23 22:54:39 +00:00
|
|
|
|
// of the reference count synchronizes with this `Acquire` fence. This
|
|
|
|
|
// means that use of the data happens before decreasing the reference
|
|
|
|
|
// count, which happens before this fence, which happens before the
|
|
|
|
|
// deletion of the data.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
//
|
|
|
|
|
// As explained in the [Boost documentation][1],
|
|
|
|
|
//
|
2015-03-23 22:54:39 +00:00
|
|
|
|
// > It is important to enforce any possible access to the object in one
|
|
|
|
|
// > thread (through an existing reference) to *happen before* deleting
|
|
|
|
|
// > the object in a different thread. This is achieved by a "release"
|
|
|
|
|
// > operation after dropping a reference (any access to the object
|
|
|
|
|
// > through this reference must obviously happened before), and an
|
|
|
|
|
// > "acquire" operation before deleting the object.
|
2014-03-22 07:53:58 +00:00
|
|
|
|
//
|
2017-05-02 19:38:12 +00:00
|
|
|
|
// In particular, while the contents of an Arc are usually immutable, it's
|
|
|
|
|
// possible to have interior writes to something like a Mutex<T>. Since a
|
|
|
|
|
// Mutex is not acquired when it is deleted, we can't rely on its
|
|
|
|
|
// synchronization logic to make writes in thread A visible to a destructor
|
|
|
|
|
// running in thread B.
|
|
|
|
|
//
|
|
|
|
|
// Also note that the Acquire fence here could probably be replaced with an
|
|
|
|
|
// Acquire load, which could improve performance in highly-contended
|
|
|
|
|
// situations. See [2].
|
|
|
|
|
//
|
2014-03-22 07:53:58 +00:00
|
|
|
|
// [1]: (www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html)
|
2017-05-02 19:38:12 +00:00
|
|
|
|
// [2]: (https://github.com/rust-lang/rust/pull/41714)
|
2020-03-20 00:00:00 +00:00
|
|
|
|
acquire!(self.inner().strong);
|
2014-03-22 07:53:58 +00:00
|
|
|
|
|
2015-09-23 22:03:05 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
self.drop_slow();
|
|
|
|
|
}
|
2012-08-13 23:45:17 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<A: Allocator + Clone> Arc<dyn Any + Send + Sync, A> {
|
2018-07-11 08:19:54 +00:00
|
|
|
|
/// Attempt to downcast the `Arc<dyn Any + Send + Sync>` to a concrete type.
|
2018-05-17 15:17:35 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::any::Any;
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2018-07-11 08:19:54 +00:00
|
|
|
|
/// fn print_if_string(value: Arc<dyn Any + Send + Sync>) {
|
2018-05-17 15:17:35 +00:00
|
|
|
|
/// if let Ok(string) = value.downcast::<String>() {
|
|
|
|
|
/// println!("String ({}): {}", string.len(), string);
|
|
|
|
|
/// }
|
|
|
|
|
/// }
|
|
|
|
|
///
|
2019-10-01 11:55:46 +00:00
|
|
|
|
/// let my_string = "Hello World".to_string();
|
|
|
|
|
/// print_if_string(Arc::new(my_string));
|
|
|
|
|
/// print_if_string(Arc::new(0i8));
|
2018-05-17 15:17:35 +00:00
|
|
|
|
/// ```
|
2022-05-01 19:12:20 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
#[stable(feature = "rc_downcast", since = "1.29.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub fn downcast<T>(self) -> Result<Arc<T, A>, Self>
|
2018-05-17 15:17:35 +00:00
|
|
|
|
where
|
2022-05-01 19:12:20 +00:00
|
|
|
|
T: Any + Send + Sync,
|
2018-05-17 15:17:35 +00:00
|
|
|
|
{
|
|
|
|
|
if (*self).is::<T>() {
|
2021-10-10 18:02:42 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
let ptr = self.ptr.cast::<ArcInner<T>>();
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let alloc = self.alloc.clone();
|
2021-10-10 18:02:42 +00:00
|
|
|
|
mem::forget(self);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Ok(Arc::from_inner_in(ptr, alloc))
|
2021-10-10 18:02:42 +00:00
|
|
|
|
}
|
2018-05-17 15:17:35 +00:00
|
|
|
|
} else {
|
|
|
|
|
Err(self)
|
|
|
|
|
}
|
|
|
|
|
}
|
2022-05-01 19:12:20 +00:00
|
|
|
|
|
|
|
|
|
/// Downcasts the `Arc<dyn Any + Send + Sync>` to a concrete type.
|
|
|
|
|
///
|
|
|
|
|
/// For a safe alternative see [`downcast`].
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(downcast_unchecked)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::any::Any;
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x: Arc<dyn Any + Send + Sync> = Arc::new(1_usize);
|
|
|
|
|
///
|
|
|
|
|
/// unsafe {
|
|
|
|
|
/// assert_eq!(*x.downcast_unchecked::<usize>(), 1);
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// The contained value must be of type `T`. Calling this method
|
|
|
|
|
/// with the incorrect type is *undefined behavior*.
|
|
|
|
|
///
|
|
|
|
|
///
|
|
|
|
|
/// [`downcast`]: Self::downcast
|
|
|
|
|
#[inline]
|
|
|
|
|
#[unstable(feature = "downcast_unchecked", issue = "90850")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub unsafe fn downcast_unchecked<T>(self) -> Arc<T, A>
|
2022-05-01 19:12:20 +00:00
|
|
|
|
where
|
|
|
|
|
T: Any + Send + Sync,
|
|
|
|
|
{
|
|
|
|
|
unsafe {
|
|
|
|
|
let ptr = self.ptr.cast::<ArcInner<T>>();
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let alloc = self.alloc.clone();
|
2022-05-01 19:12:20 +00:00
|
|
|
|
mem::forget(self);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Arc::from_inner_in(ptr, alloc)
|
2022-05-01 19:12:20 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2018-05-17 15:17:35 +00:00
|
|
|
|
}
|
|
|
|
|
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
impl<T> Weak<T> {
|
2018-06-28 18:49:47 +00:00
|
|
|
|
/// Constructs a new `Weak<T>`, without allocating any memory.
|
|
|
|
|
/// Calling [`upgrade`] on the return value always gives [`None`].
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`upgrade`]: Weak::upgrade
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Weak;
|
|
|
|
|
///
|
|
|
|
|
/// let empty: Weak<i64> = Weak::new();
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(empty.upgrade().is_none());
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
#[inline]
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
#[stable(feature = "downgraded_weak", since = "1.10.0")]
|
2023-08-21 13:12:15 +00:00
|
|
|
|
#[rustc_const_stable(feature = "const_weak_new", since = "1.73.0")]
|
2021-10-10 05:50:06 +00:00
|
|
|
|
#[must_use]
|
2022-03-16 04:58:18 +00:00
|
|
|
|
pub const fn new() -> Weak<T> {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Weak {
|
|
|
|
|
ptr: unsafe { NonNull::new_unchecked(ptr::invalid_mut::<ArcInner<T>>(usize::MAX)) },
|
|
|
|
|
alloc: Global,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<T, A: Allocator> Weak<T, A> {
|
|
|
|
|
/// Constructs a new `Weak<T, A>`, without allocating any memory, technically in the provided
|
|
|
|
|
/// allocator.
|
|
|
|
|
/// Calling [`upgrade`] on the return value always gives [`None`].
|
|
|
|
|
///
|
|
|
|
|
/// [`upgrade`]: Weak::upgrade
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// #![feature(allocator_api)]
|
|
|
|
|
///
|
|
|
|
|
/// use std::sync::Weak;
|
|
|
|
|
/// use std::alloc::System;
|
|
|
|
|
///
|
|
|
|
|
/// let empty: Weak<i64, _> = Weak::new_in(System);
|
|
|
|
|
/// assert!(empty.upgrade().is_none());
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
pub fn new_in(alloc: A) -> Weak<T, A> {
|
|
|
|
|
Weak {
|
|
|
|
|
ptr: unsafe { NonNull::new_unchecked(ptr::invalid_mut::<ArcInner<T>>(usize::MAX)) },
|
|
|
|
|
alloc,
|
|
|
|
|
}
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
}
|
2020-07-14 19:22:48 +00:00
|
|
|
|
}
|
2019-05-12 12:53:01 +00:00
|
|
|
|
|
2020-07-14 19:22:48 +00:00
|
|
|
|
/// Helper type to allow accessing the reference counts without
|
|
|
|
|
/// making any assertions about the data field.
|
|
|
|
|
struct WeakInner<'a> {
|
|
|
|
|
weak: &'a atomic::AtomicUsize,
|
|
|
|
|
strong: &'a atomic::AtomicUsize,
|
|
|
|
|
}
|
2019-05-12 12:53:01 +00:00
|
|
|
|
|
2021-01-06 21:34:13 +00:00
|
|
|
|
impl<T: ?Sized> Weak<T> {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// Converts a raw pointer previously created by [`into_raw`] back into `Weak<T>`.
|
|
|
|
|
///
|
|
|
|
|
/// This can be used to safely get a strong reference (by calling [`upgrade`]
|
|
|
|
|
/// later) or to deallocate the weak count by dropping the `Weak<T>`.
|
|
|
|
|
///
|
|
|
|
|
/// It takes ownership of one weak reference (with the exception of pointers created by [`new`],
|
|
|
|
|
/// as these don't own anything; the method still works on them).
|
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
|
|
|
|
/// The pointer must have originated from the [`into_raw`] and must still own its potential
|
|
|
|
|
/// weak reference.
|
|
|
|
|
///
|
|
|
|
|
/// It is allowed for the strong count to be 0 at the time of calling this. Nevertheless, this
|
|
|
|
|
/// takes ownership of one weak reference currently represented as a raw pointer (the weak
|
|
|
|
|
/// count is not modified by this operation) and therefore it must be paired with a previous
|
|
|
|
|
/// call to [`into_raw`].
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::{Arc, Weak};
|
|
|
|
|
///
|
|
|
|
|
/// let strong = Arc::new("hello".to_owned());
|
|
|
|
|
///
|
|
|
|
|
/// let raw_1 = Arc::downgrade(&strong).into_raw();
|
|
|
|
|
/// let raw_2 = Arc::downgrade(&strong).into_raw();
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(2, Arc::weak_count(&strong));
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
|
|
|
|
|
/// assert_eq!(1, Arc::weak_count(&strong));
|
|
|
|
|
///
|
|
|
|
|
/// drop(strong);
|
|
|
|
|
///
|
|
|
|
|
/// // Decrement the last weak count.
|
|
|
|
|
/// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// [`new`]: Weak::new
|
|
|
|
|
/// [`into_raw`]: Weak::into_raw
|
|
|
|
|
/// [`upgrade`]: Weak::upgrade
|
|
|
|
|
#[inline]
|
|
|
|
|
#[stable(feature = "weak_into_raw", since = "1.45.0")]
|
|
|
|
|
pub unsafe fn from_raw(ptr: *const T) -> Self {
|
|
|
|
|
unsafe { Weak::from_raw_in(ptr, Global) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<T: ?Sized, A: Allocator> Weak<T, A> {
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// Returns a raw pointer to the object `T` pointed to by this `Weak<T>`.
|
|
|
|
|
///
|
2020-04-13 15:17:34 +00:00
|
|
|
|
/// The pointer is valid only if there are some strong references. The pointer may be dangling,
|
|
|
|
|
/// unaligned or even [`null`] otherwise.
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2019-06-15 06:47:19 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// use std::ptr;
|
|
|
|
|
///
|
2019-06-01 09:55:25 +00:00
|
|
|
|
/// let strong = Arc::new("hello".to_owned());
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// let weak = Arc::downgrade(&strong);
|
|
|
|
|
/// // Both point to the same object
|
2020-04-13 15:17:34 +00:00
|
|
|
|
/// assert!(ptr::eq(&*strong, weak.as_ptr()));
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// // The strong here keeps it alive, so we can still access the object.
|
2020-04-13 15:17:34 +00:00
|
|
|
|
/// assert_eq!("hello", unsafe { &*weak.as_ptr() });
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// drop(strong);
|
2020-04-13 15:17:34 +00:00
|
|
|
|
/// // But not any more. We can do weak.as_ptr(), but accessing the pointer would lead to
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// // undefined behaviour.
|
2020-04-13 15:17:34 +00:00
|
|
|
|
/// // assert_eq!("hello", unsafe { &*weak.as_ptr() });
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// ```
|
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [`null`]: core::ptr::null "ptr::null"
|
2021-10-11 17:57:38 +00:00
|
|
|
|
#[must_use]
|
2020-05-17 06:21:24 +00:00
|
|
|
|
#[stable(feature = "weak_into_raw", since = "1.45.0")]
|
2020-04-13 15:17:34 +00:00
|
|
|
|
pub fn as_ptr(&self) -> *const T {
|
2020-06-28 18:30:35 +00:00
|
|
|
|
let ptr: *mut ArcInner<T> = NonNull::as_ptr(self.ptr);
|
|
|
|
|
|
2021-01-11 04:27:32 +00:00
|
|
|
|
if is_dangling(ptr) {
|
|
|
|
|
// If the pointer is dangling, we return the sentinel directly. This cannot be
|
2021-01-13 22:21:23 +00:00
|
|
|
|
// a valid payload address, as the payload is at least as aligned as ArcInner (usize).
|
2021-01-11 04:27:32 +00:00
|
|
|
|
ptr as *const T
|
2021-01-06 21:34:13 +00:00
|
|
|
|
} else {
|
2021-12-11 23:23:06 +00:00
|
|
|
|
// SAFETY: if is_dangling returns false, then the pointer is dereferenceable.
|
2021-01-06 21:34:13 +00:00
|
|
|
|
// The payload may be dropped at this point, and we have to maintain provenance,
|
|
|
|
|
// so use raw pointer manipulation.
|
2021-01-10 18:35:42 +00:00
|
|
|
|
unsafe { ptr::addr_of_mut!((*ptr).data) }
|
2020-06-28 18:30:35 +00:00
|
|
|
|
}
|
2019-05-12 12:53:01 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Consumes the `Weak<T>` and turns it into a raw pointer.
|
|
|
|
|
///
|
2020-07-26 13:31:58 +00:00
|
|
|
|
/// This converts the weak pointer into a raw pointer, while still preserving the ownership of
|
|
|
|
|
/// one weak reference (the weak count is not modified by this operation). It can be turned
|
|
|
|
|
/// back into the `Weak<T>` with [`from_raw`].
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// The same restrictions of accessing the target of the pointer as with
|
2020-04-13 15:17:34 +00:00
|
|
|
|
/// [`as_ptr`] apply.
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::{Arc, Weak};
|
|
|
|
|
///
|
2019-06-01 09:55:25 +00:00
|
|
|
|
/// let strong = Arc::new("hello".to_owned());
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// let weak = Arc::downgrade(&strong);
|
2019-06-15 06:47:19 +00:00
|
|
|
|
/// let raw = weak.into_raw();
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(1, Arc::weak_count(&strong));
|
2019-06-01 09:55:25 +00:00
|
|
|
|
/// assert_eq!("hello", unsafe { &*raw });
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// drop(unsafe { Weak::from_raw(raw) });
|
|
|
|
|
/// assert_eq!(0, Arc::weak_count(&strong));
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`from_raw`]: Weak::from_raw
|
|
|
|
|
/// [`as_ptr`]: Weak::as_ptr
|
2021-10-10 23:50:52 +00:00
|
|
|
|
#[must_use = "`self` will be dropped if the result is not used"]
|
2020-05-17 06:21:24 +00:00
|
|
|
|
#[stable(feature = "weak_into_raw", since = "1.45.0")]
|
2019-06-15 06:47:19 +00:00
|
|
|
|
pub fn into_raw(self) -> *const T {
|
2020-04-13 15:17:34 +00:00
|
|
|
|
let result = self.as_ptr();
|
2019-06-15 06:47:19 +00:00
|
|
|
|
mem::forget(self);
|
2019-05-12 12:53:01 +00:00
|
|
|
|
result
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// Converts a raw pointer previously created by [`into_raw`] back into `Weak<T>` in the provided
|
|
|
|
|
/// allocator.
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// This can be used to safely get a strong reference (by calling [`upgrade`]
|
|
|
|
|
/// later) or to deallocate the weak count by dropping the `Weak<T>`.
|
|
|
|
|
///
|
2020-07-26 13:31:58 +00:00
|
|
|
|
/// It takes ownership of one weak reference (with the exception of pointers created by [`new`],
|
|
|
|
|
/// as these don't own anything; the method still works on them).
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
2020-04-13 15:17:34 +00:00
|
|
|
|
/// The pointer must have originated from the [`into_raw`] and must still own its potential
|
2022-04-28 02:22:52 +00:00
|
|
|
|
/// weak reference, and must point to a block of memory allocated by `alloc`.
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
2020-07-26 13:31:58 +00:00
|
|
|
|
/// It is allowed for the strong count to be 0 at the time of calling this. Nevertheless, this
|
|
|
|
|
/// takes ownership of one weak reference currently represented as a raw pointer (the weak
|
|
|
|
|
/// count is not modified by this operation) and therefore it must be paired with a previous
|
|
|
|
|
/// call to [`into_raw`].
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::{Arc, Weak};
|
|
|
|
|
///
|
2019-06-01 09:55:25 +00:00
|
|
|
|
/// let strong = Arc::new("hello".to_owned());
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
2019-06-15 06:47:19 +00:00
|
|
|
|
/// let raw_1 = Arc::downgrade(&strong).into_raw();
|
|
|
|
|
/// let raw_2 = Arc::downgrade(&strong).into_raw();
|
2019-05-12 12:53:01 +00:00
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(2, Arc::weak_count(&strong));
|
|
|
|
|
///
|
2019-06-15 06:47:19 +00:00
|
|
|
|
/// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// assert_eq!(1, Arc::weak_count(&strong));
|
|
|
|
|
///
|
|
|
|
|
/// drop(strong);
|
|
|
|
|
///
|
|
|
|
|
/// // Decrement the last weak count.
|
2019-06-15 06:47:19 +00:00
|
|
|
|
/// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
|
2019-05-12 12:53:01 +00:00
|
|
|
|
/// ```
|
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`new`]: Weak::new
|
|
|
|
|
/// [`into_raw`]: Weak::into_raw
|
|
|
|
|
/// [`upgrade`]: Weak::upgrade
|
2022-04-28 02:22:52 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
#[unstable(feature = "allocator_api", issue = "32838")]
|
|
|
|
|
pub unsafe fn from_raw_in(ptr: *const T, alloc: A) -> Self {
|
2020-07-14 19:17:55 +00:00
|
|
|
|
// See Weak::as_ptr for context on how the input pointer is derived.
|
|
|
|
|
|
2021-01-11 04:27:32 +00:00
|
|
|
|
let ptr = if is_dangling(ptr as *mut T) {
|
|
|
|
|
// This is a dangling Weak.
|
|
|
|
|
ptr as *mut ArcInner<T>
|
2021-01-06 21:34:13 +00:00
|
|
|
|
} else {
|
2021-01-07 17:50:31 +00:00
|
|
|
|
// Otherwise, we're guaranteed the pointer came from a nondangling Weak.
|
2021-01-07 17:41:58 +00:00
|
|
|
|
// SAFETY: data_offset is safe to call, as ptr references a real (potentially dropped) T.
|
2021-01-06 21:34:13 +00:00
|
|
|
|
let offset = unsafe { data_offset(ptr) };
|
|
|
|
|
// Thus, we reverse the offset to get the whole RcBox.
|
|
|
|
|
// SAFETY: the pointer originated from a Weak, so this offset is safe.
|
2022-07-10 10:14:28 +00:00
|
|
|
|
unsafe { ptr.byte_sub(offset) as *mut ArcInner<T> }
|
2020-07-14 19:17:55 +00:00
|
|
|
|
};
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
|
2020-07-14 19:17:55 +00:00
|
|
|
|
// SAFETY: we now have recovered the original Weak pointer, so can create the Weak.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Weak { ptr: unsafe { NonNull::new_unchecked(ptr) }, alloc }
|
2019-05-12 12:53:01 +00:00
|
|
|
|
}
|
2020-12-27 23:39:09 +00:00
|
|
|
|
}
|
2020-05-24 12:11:12 +00:00
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> Weak<T, A> {
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Attempts to upgrade the `Weak` pointer to an [`Arc`], delaying
|
|
|
|
|
/// dropping of the inner value if successful.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Returns [`None`] if the inner value has since been dropped.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-03-22 07:53:58 +00:00
|
|
|
|
///
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// let weak_five = Arc::downgrade(&five);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// let strong_five: Option<Arc<_>> = weak_five.upgrade();
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(strong_five.is_some());
|
|
|
|
|
///
|
|
|
|
|
/// // Destroy all strong pointers.
|
|
|
|
|
/// drop(strong_five);
|
|
|
|
|
/// drop(five);
|
|
|
|
|
///
|
|
|
|
|
/// assert!(weak_five.upgrade().is_none());
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2021-10-12 00:40:03 +00:00
|
|
|
|
#[must_use = "this returns a new `Arc`, \
|
|
|
|
|
without modifying the original weak pointer"]
|
2015-09-10 20:26:44 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
pub fn upgrade(&self) -> Option<Arc<T, A>>
|
|
|
|
|
where
|
|
|
|
|
A: Clone,
|
|
|
|
|
{
|
|
|
|
|
#[inline]
|
|
|
|
|
fn checked_increment(n: usize) -> Option<usize> {
|
|
|
|
|
// Any write of 0 we can observe leaves the field in permanently zero state.
|
|
|
|
|
if n == 0 {
|
|
|
|
|
return None;
|
|
|
|
|
}
|
|
|
|
|
// See comments in `Arc::clone` for why we do this (for `mem::forget`).
|
|
|
|
|
assert!(n <= MAX_REFCOUNT, "{}", INTERNAL_OVERFLOW_ERROR);
|
|
|
|
|
Some(n + 1)
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-23 22:54:39 +00:00
|
|
|
|
// We use a CAS loop to increment the strong count instead of a
|
2020-08-13 01:07:54 +00:00
|
|
|
|
// fetch_add as this function should never take the reference count
|
|
|
|
|
// from zero to one.
|
2022-04-28 02:22:52 +00:00
|
|
|
|
//
|
|
|
|
|
// Relaxed is fine for the failure case because we don't have any expectations about the new state.
|
|
|
|
|
// Acquire is necessary for the success case to synchronise with `Arc::new_cyclic`, when the inner
|
|
|
|
|
// value can be initialized after `Weak` references have already been created. In that case, we
|
|
|
|
|
// expect to observe the fully initialized value.
|
|
|
|
|
if self.inner()?.strong.fetch_update(Acquire, Relaxed, checked_increment).is_ok() {
|
|
|
|
|
// SAFETY: pointer is not null, verified in checked_increment
|
|
|
|
|
unsafe { Some(Arc::from_inner_in(self.ptr, self.alloc.clone())) }
|
|
|
|
|
} else {
|
|
|
|
|
None
|
|
|
|
|
}
|
2012-09-05 00:22:09 +00:00
|
|
|
|
}
|
2018-06-29 13:43:34 +00:00
|
|
|
|
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Gets the number of strong (`Arc`) pointers pointing to this allocation.
|
2018-12-10 23:40:39 +00:00
|
|
|
|
///
|
|
|
|
|
/// If `self` was created using [`Weak::new`], this will return 0.
|
2021-10-14 23:56:53 +00:00
|
|
|
|
#[must_use]
|
2019-12-15 03:26:25 +00:00
|
|
|
|
#[stable(feature = "weak_counts", since = "1.41.0")]
|
2018-12-10 23:40:39 +00:00
|
|
|
|
pub fn strong_count(&self) -> usize {
|
2023-09-04 20:43:21 +00:00
|
|
|
|
if let Some(inner) = self.inner() { inner.strong.load(Relaxed) } else { 0 }
|
2018-12-10 23:40:39 +00:00
|
|
|
|
}
|
|
|
|
|
|
2019-01-07 22:35:52 +00:00
|
|
|
|
/// Gets an approximation of the number of `Weak` pointers pointing to this
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// allocation.
|
2019-01-07 22:35:52 +00:00
|
|
|
|
///
|
2019-11-21 19:48:39 +00:00
|
|
|
|
/// If `self` was created using [`Weak::new`], or if there are no remaining
|
|
|
|
|
/// strong pointers, this will return 0.
|
2019-01-07 22:35:52 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Accuracy
|
|
|
|
|
///
|
|
|
|
|
/// Due to implementation details, the returned value can be off by 1 in
|
|
|
|
|
/// either direction when other threads are manipulating any `Arc`s or
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// `Weak`s pointing to the same allocation.
|
2021-10-14 23:56:53 +00:00
|
|
|
|
#[must_use]
|
2019-12-15 03:26:25 +00:00
|
|
|
|
#[stable(feature = "weak_counts", since = "1.41.0")]
|
2019-11-21 19:48:39 +00:00
|
|
|
|
pub fn weak_count(&self) -> usize {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
if let Some(inner) = self.inner() {
|
|
|
|
|
let weak = inner.weak.load(Acquire);
|
2023-09-04 20:43:21 +00:00
|
|
|
|
let strong = inner.strong.load(Relaxed);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
if strong == 0 {
|
|
|
|
|
0
|
|
|
|
|
} else {
|
|
|
|
|
// Since we observed that there was at least one strong pointer
|
|
|
|
|
// after reading the weak count, we know that the implicit weak
|
|
|
|
|
// reference (present whenever any strong references are alive)
|
|
|
|
|
// was still around when we observed the weak count, and can
|
|
|
|
|
// therefore safely subtract it.
|
|
|
|
|
weak - 1
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
0
|
|
|
|
|
}
|
2019-01-07 22:35:52 +00:00
|
|
|
|
}
|
2018-12-10 23:40:39 +00:00
|
|
|
|
|
2019-02-09 22:16:58 +00:00
|
|
|
|
/// Returns `None` when the pointer is dangling and there is no allocated `ArcInner`,
|
|
|
|
|
/// (i.e., when this `Weak` was created by `Weak::new`).
|
2018-06-29 13:43:34 +00:00
|
|
|
|
#[inline]
|
2020-05-24 12:11:12 +00:00
|
|
|
|
fn inner(&self) -> Option<WeakInner<'_>> {
|
2021-01-11 04:27:32 +00:00
|
|
|
|
if is_dangling(self.ptr.as_ptr()) {
|
2020-05-24 12:11:12 +00:00
|
|
|
|
None
|
|
|
|
|
} else {
|
|
|
|
|
// We are careful to *not* create a reference covering the "data" field, as
|
|
|
|
|
// the field may be mutated concurrently (for example, if the last `Arc`
|
|
|
|
|
// is dropped, the data field will be dropped in-place).
|
|
|
|
|
Some(unsafe {
|
|
|
|
|
let ptr = self.ptr.as_ptr();
|
|
|
|
|
WeakInner { strong: &(*ptr).strong, weak: &(*ptr).weak }
|
|
|
|
|
})
|
|
|
|
|
}
|
2018-06-29 13:43:34 +00:00
|
|
|
|
}
|
2018-11-15 19:24:02 +00:00
|
|
|
|
|
2022-10-26 09:15:14 +00:00
|
|
|
|
/// Returns `true` if the two `Weak`s point to the same allocation similar to [`ptr::eq`], or if
|
2023-01-04 13:16:55 +00:00
|
|
|
|
/// both don't point to any allocation (because they were created with `Weak::new()`). However,
|
|
|
|
|
/// this function ignores the metadata of `dyn Trait` pointers.
|
2018-11-15 19:24:02 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Notes
|
|
|
|
|
///
|
|
|
|
|
/// Since this compares pointers it means that `Weak::new()` will equal each
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// other, even though they don't point to any allocation.
|
2018-11-15 19:24:02 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2019-06-16 11:57:07 +00:00
|
|
|
|
/// use std::sync::Arc;
|
2018-11-15 19:24:02 +00:00
|
|
|
|
///
|
|
|
|
|
/// let first_rc = Arc::new(5);
|
|
|
|
|
/// let first = Arc::downgrade(&first_rc);
|
|
|
|
|
/// let second = Arc::downgrade(&first_rc);
|
|
|
|
|
///
|
2019-06-16 11:57:07 +00:00
|
|
|
|
/// assert!(first.ptr_eq(&second));
|
2018-11-15 19:24:02 +00:00
|
|
|
|
///
|
|
|
|
|
/// let third_rc = Arc::new(5);
|
|
|
|
|
/// let third = Arc::downgrade(&third_rc);
|
|
|
|
|
///
|
2019-06-16 11:57:07 +00:00
|
|
|
|
/// assert!(!first.ptr_eq(&third));
|
2018-11-15 19:24:02 +00:00
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// Comparing `Weak::new`.
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::{Arc, Weak};
|
|
|
|
|
///
|
|
|
|
|
/// let first = Weak::new();
|
|
|
|
|
/// let second = Weak::new();
|
2019-06-16 11:57:07 +00:00
|
|
|
|
/// assert!(first.ptr_eq(&second));
|
2018-11-15 19:24:02 +00:00
|
|
|
|
///
|
|
|
|
|
/// let third_rc = Arc::new(());
|
|
|
|
|
/// let third = Arc::downgrade(&third_rc);
|
2019-06-16 11:57:07 +00:00
|
|
|
|
/// assert!(!first.ptr_eq(&third));
|
2018-11-15 19:24:02 +00:00
|
|
|
|
/// ```
|
2019-10-19 11:48:02 +00:00
|
|
|
|
///
|
Apply 16 commits (squashed)
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::fmt
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::{rc, sync}
----------
Fix spacing for links inside code blocks, and improve link tooltips in alloc::string
----------
Fix spacing for links inside code blocks in alloc::vec
----------
Fix spacing for links inside code blocks in core::option
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in core::result
----------
Fix spacing for links inside code blocks in core::{iter::{self, iterator}, stream::stream, poll}
----------
Fix spacing for links inside code blocks, and improve a few link tooltips in std::{fs, path}
----------
Fix spacing for links inside code blocks in std::{collections, time}
----------
Fix spacing for links inside code blocks in and make formatting of `&str`-like types consistent in std::ffi::{c_str, os_str}
----------
Fix spacing for links inside code blocks, and improve link tooltips in std::ffi
----------
Fix spacing for links inside code blocks, and improve a few link tooltips
in std::{io::{self, buffered::{bufreader, bufwriter}, cursor, util}, net::{self, addr}}
----------
Fix typo in link to `into` for `OsString` docs
----------
Remove tooltips that will probably become redundant in the future
----------
Apply suggestions from code review
Replacing `…std/primitive.reference.html` paths with just `reference`
Co-authored-by: Joshua Nelson <github@jyn.dev>
----------
Also replace `…std/primitive.reference.html` paths with just `reference` in `core::pin`
2021-08-25 09:45:08 +00:00
|
|
|
|
/// [`ptr::eq`]: core::ptr::eq "ptr::eq"
|
2018-11-15 19:24:02 +00:00
|
|
|
|
#[inline]
|
2021-10-14 23:56:53 +00:00
|
|
|
|
#[must_use]
|
2019-08-25 11:06:49 +00:00
|
|
|
|
#[stable(feature = "weak_ptr_eq", since = "1.39.0")]
|
2019-06-16 11:57:07 +00:00
|
|
|
|
pub fn ptr_eq(&self, other: &Self) -> bool {
|
2023-10-03 00:32:01 +00:00
|
|
|
|
ptr::addr_eq(self.ptr.as_ptr(), other.ptr.as_ptr())
|
2018-11-15 19:24:02 +00:00
|
|
|
|
}
|
2012-11-27 00:12:47 +00:00
|
|
|
|
}
|
|
|
|
|
|
2015-09-10 20:26:44 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator + Clone> Clone for Weak<T, A> {
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Makes a clone of the `Weak` pointer that points to the same allocation.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// use std::sync::{Arc, Weak};
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2015-08-12 21:37:27 +00:00
|
|
|
|
/// let weak_five = Arc::downgrade(&Arc::new(5));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2018-10-12 06:10:37 +00:00
|
|
|
|
/// let _ = Weak::clone(&weak_five);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2013-06-18 21:45:18 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn clone(&self) -> Weak<T, A> {
|
2018-06-29 13:43:34 +00:00
|
|
|
|
let inner = if let Some(inner) = self.inner() {
|
|
|
|
|
inner
|
2018-06-28 18:49:47 +00:00
|
|
|
|
} else {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
return Weak { ptr: self.ptr, alloc: self.alloc.clone() };
|
2018-06-28 18:49:47 +00:00
|
|
|
|
};
|
2023-01-14 15:33:11 +00:00
|
|
|
|
// See comments in Arc::clone() for why this is relaxed. This can use a
|
2015-06-26 21:32:34 +00:00
|
|
|
|
// fetch_add (ignoring the lock) because the weak count is only locked
|
|
|
|
|
// where are *no other* weak pointers in existence. (So we can't be
|
|
|
|
|
// running this code in that case).
|
2018-06-28 18:49:47 +00:00
|
|
|
|
let old_size = inner.weak.fetch_add(1, Relaxed);
|
2015-07-21 00:09:44 +00:00
|
|
|
|
|
|
|
|
|
// See comments in Arc::clone() for why we do this (for mem::forget).
|
|
|
|
|
if old_size > MAX_REFCOUNT {
|
2020-06-03 19:15:53 +00:00
|
|
|
|
abort();
|
2015-07-21 00:09:44 +00:00
|
|
|
|
}
|
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
Weak { ptr: self.ptr, alloc: self.alloc.clone() }
|
2012-08-14 17:32:41 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
#[stable(feature = "downgraded_weak", since = "1.10.0")]
|
|
|
|
|
impl<T> Default for Weak<T> {
|
2018-06-28 18:49:47 +00:00
|
|
|
|
/// Constructs a new `Weak<T>`, without allocating memory.
|
2018-12-18 02:10:24 +00:00
|
|
|
|
/// Calling [`upgrade`] on the return value always
|
2018-07-01 16:51:39 +00:00
|
|
|
|
/// gives [`None`].
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
2020-08-20 21:43:46 +00:00
|
|
|
|
/// [`upgrade`]: Weak::upgrade
|
2016-09-21 17:24:45 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Weak;
|
|
|
|
|
///
|
|
|
|
|
/// let empty: Weak<i64> = Default::default();
|
|
|
|
|
/// assert!(empty.upgrade().is_none());
|
|
|
|
|
/// ```
|
std: Stabilize APIs for the 1.10 release
This commit applies the FCP decisions made by the libs team for the 1.10 cycle,
including both new stabilizations and deprecations. Specifically, the list of
APIs is:
Stabilized:
* `os::windows::fs::OpenOptionsExt::access_mode`
* `os::windows::fs::OpenOptionsExt::share_mode`
* `os::windows::fs::OpenOptionsExt::custom_flags`
* `os::windows::fs::OpenOptionsExt::attributes`
* `os::windows::fs::OpenOptionsExt::security_qos_flags`
* `os::unix::fs::OpenOptionsExt::custom_flags`
* `sync::Weak::new`
* `Default for sync::Weak`
* `panic::set_hook`
* `panic::take_hook`
* `panic::PanicInfo`
* `panic::PanicInfo::payload`
* `panic::PanicInfo::location`
* `panic::Location`
* `panic::Location::file`
* `panic::Location::line`
* `ffi::CStr::from_bytes_with_nul`
* `ffi::CStr::from_bytes_with_nul_unchecked`
* `ffi::FromBytesWithNulError`
* `fs::Metadata::modified`
* `fs::Metadata::accessed`
* `fs::Metadata::created`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange`
* `sync::atomic::Atomic{Usize,Isize,Bool,Ptr}::compare_exchange_weak`
* `collections::{btree,hash}_map::{Occupied,Vacant,}Entry::key`
* `os::unix::net::{UnixStream, UnixListener, UnixDatagram, SocketAddr}`
* `SocketAddr::is_unnamed`
* `SocketAddr::as_pathname`
* `UnixStream::connect`
* `UnixStream::pair`
* `UnixStream::try_clone`
* `UnixStream::local_addr`
* `UnixStream::peer_addr`
* `UnixStream::set_read_timeout`
* `UnixStream::set_write_timeout`
* `UnixStream::read_timeout`
* `UnixStream::write_Timeout`
* `UnixStream::set_nonblocking`
* `UnixStream::take_error`
* `UnixStream::shutdown`
* Read/Write/RawFd impls for `UnixStream`
* `UnixListener::bind`
* `UnixListener::accept`
* `UnixListener::try_clone`
* `UnixListener::local_addr`
* `UnixListener::set_nonblocking`
* `UnixListener::take_error`
* `UnixListener::incoming`
* RawFd impls for `UnixListener`
* `UnixDatagram::bind`
* `UnixDatagram::unbound`
* `UnixDatagram::pair`
* `UnixDatagram::connect`
* `UnixDatagram::try_clone`
* `UnixDatagram::local_addr`
* `UnixDatagram::peer_addr`
* `UnixDatagram::recv_from`
* `UnixDatagram::recv`
* `UnixDatagram::send_to`
* `UnixDatagram::send`
* `UnixDatagram::set_read_timeout`
* `UnixDatagram::set_write_timeout`
* `UnixDatagram::read_timeout`
* `UnixDatagram::write_timeout`
* `UnixDatagram::set_nonblocking`
* `UnixDatagram::take_error`
* `UnixDatagram::shutdown`
* RawFd impls for `UnixDatagram`
* `{BTree,Hash}Map::values_mut`
* `<[_]>::binary_search_by_key`
Deprecated:
* `StaticCondvar` - this, and all other static synchronization primitives
below, are usable today through the lazy-static crate on
stable Rust today. Additionally, we'd like the non-static
versions to be directly usable in a static context one day,
so they're unlikely to be the final forms of the APIs in any
case.
* `CONDVAR_INIT`
* `StaticMutex`
* `MUTEX_INIT`
* `StaticRwLock`
* `RWLOCK_INIT`
* `iter::Peekable::is_empty`
Closes #27717
Closes #27720
cc #27784 (but encode methods still exist)
Closes #30014
Closes #30425
Closes #30449
Closes #31190
Closes #31399
Closes #31767
Closes #32111
Closes #32281
Closes #32312
Closes #32551
Closes #33018
2016-05-17 18:57:07 +00:00
|
|
|
|
fn default() -> Weak<T> {
|
|
|
|
|
Weak::new()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-20 05:48:11 +00:00
|
|
|
|
#[stable(feature = "arc_weak", since = "1.4.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe impl<#[may_dangle] T: ?Sized, A: Allocator> Drop for Weak<T, A> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Drops the `Weak` pointer.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// use std::sync::{Arc, Weak};
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// struct Foo;
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// impl Drop for Foo {
|
|
|
|
|
/// fn drop(&mut self) {
|
|
|
|
|
/// println!("dropped!");
|
|
|
|
|
/// }
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// }
|
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// let foo = Arc::new(Foo);
|
|
|
|
|
/// let weak_foo = Arc::downgrade(&foo);
|
2017-05-21 14:00:04 +00:00
|
|
|
|
/// let other_weak_foo = Weak::clone(&weak_foo);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// drop(weak_foo); // Doesn't print anything
|
|
|
|
|
/// drop(foo); // Prints "dropped!"
|
|
|
|
|
///
|
|
|
|
|
/// assert!(other_weak_foo.upgrade().is_none());
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2014-03-22 07:53:58 +00:00
|
|
|
|
fn drop(&mut self) {
|
2015-03-23 22:54:39 +00:00
|
|
|
|
// If we find out that we were the last weak pointer, then its time to
|
|
|
|
|
// deallocate the data entirely. See the discussion in Arc::drop() about
|
|
|
|
|
// the memory orderings
|
2015-06-26 21:32:34 +00:00
|
|
|
|
//
|
|
|
|
|
// It's not necessary to check for the locked state here, because the
|
|
|
|
|
// weak count can only be locked if there was precisely one weak ref,
|
|
|
|
|
// meaning that drop could only subsequently run ON that remaining weak
|
|
|
|
|
// ref, which can only happen after the lock is released.
|
2018-06-29 13:43:34 +00:00
|
|
|
|
let inner = if let Some(inner) = self.inner() { inner } else { return };
|
2018-06-28 18:49:47 +00:00
|
|
|
|
|
|
|
|
|
if inner.weak.fetch_sub(1, Release) == 1 {
|
2020-03-20 00:00:00 +00:00
|
|
|
|
acquire!(inner.weak);
|
2022-04-28 02:22:52 +00:00
|
|
|
|
unsafe {
|
|
|
|
|
self.alloc.deallocate(self.ptr.cast(), Layout::for_value_raw(self.ptr.as_ptr()))
|
|
|
|
|
}
|
2013-12-31 00:17:35 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-12-05 20:43:44 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
trait ArcEqIdent<T: ?Sized + PartialEq, A: Allocator> {
|
|
|
|
|
fn eq(&self, other: &Arc<T, A>) -> bool;
|
|
|
|
|
fn ne(&self, other: &Arc<T, A>) -> bool;
|
2018-12-05 20:43:44 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + PartialEq, A: Allocator> ArcEqIdent<T, A> for Arc<T, A> {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
default fn eq(&self, other: &Arc<T, A>) -> bool {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
**self == **other
|
|
|
|
|
}
|
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
default fn ne(&self, other: &Arc<T, A>) -> bool {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
**self != **other
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2019-05-11 08:23:07 +00:00
|
|
|
|
/// We're doing this specialization here, and not as a more general optimization on `&T`, because it
|
|
|
|
|
/// would otherwise add a cost to all equality checks on refs. We assume that `Arc`s are used to
|
|
|
|
|
/// store large values, that are slow to clone, but also heavy to check for equality, causing this
|
|
|
|
|
/// cost to pay off more easily. It's also more likely to have two `Arc` clones, that point to
|
|
|
|
|
/// the same value, than two `&T`s.
|
2019-10-19 11:48:02 +00:00
|
|
|
|
///
|
|
|
|
|
/// We can only do this when `T: Eq` as a `PartialEq` might be deliberately irreflexive.
|
2018-12-05 20:43:44 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + crate::rc::MarkerEq, A: Allocator> ArcEqIdent<T, A> for Arc<T, A> {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn eq(&self, other: &Arc<T, A>) -> bool {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
Arc::ptr_eq(self, other) || **self == **other
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn ne(&self, other: &Arc<T, A>) -> bool {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
!Arc::ptr_eq(self, other) && **self != **other
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + PartialEq, A: Allocator> PartialEq for Arc<T, A> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Equality for two `Arc`s.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// Two `Arc`s are equal if their inner values are equal, even if they are
|
|
|
|
|
/// stored in different allocation.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// If `T` also implements `Eq` (implying reflexivity of equality),
|
|
|
|
|
/// two `Arc`s that point to the same allocation are always equal.
|
2017-06-27 17:23:31 +00:00
|
|
|
|
///
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(five == Arc::new(5));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2018-12-05 20:43:44 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn eq(&self, other: &Arc<T, A>) -> bool {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
ArcEqIdent::eq(self, other)
|
2015-09-23 22:00:54 +00:00
|
|
|
|
}
|
2014-12-17 01:51:55 +00:00
|
|
|
|
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Inequality for two `Arc`s.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2023-03-15 18:25:48 +00:00
|
|
|
|
/// Two `Arc`s are not equal if their inner values are not equal.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2019-10-19 11:48:02 +00:00
|
|
|
|
/// If `T` also implements `Eq` (implying reflexivity of equality),
|
2023-03-15 18:25:48 +00:00
|
|
|
|
/// two `Arc`s that point to the same value are always equal.
|
2017-06-27 17:23:31 +00:00
|
|
|
|
///
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(five != Arc::new(6));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2018-12-05 20:43:44 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn ne(&self, other: &Arc<T, A>) -> bool {
|
2018-12-05 20:43:44 +00:00
|
|
|
|
ArcEqIdent::ne(self, other)
|
2015-09-23 22:00:54 +00:00
|
|
|
|
}
|
2014-10-17 18:00:02 +00:00
|
|
|
|
}
|
2018-12-05 20:43:44 +00:00
|
|
|
|
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + PartialOrd, A: Allocator> PartialOrd for Arc<T, A> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Partial comparison for two `Arc`s.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// The two are compared by calling `partial_cmp()` on their inner values.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// use std::cmp::Ordering;
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Arc::new(6)));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn partial_cmp(&self, other: &Arc<T, A>) -> Option<Ordering> {
|
2014-10-17 18:00:02 +00:00
|
|
|
|
(**self).partial_cmp(&**other)
|
|
|
|
|
}
|
2014-12-17 01:51:55 +00:00
|
|
|
|
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Less-than comparison for two `Arc`s.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// The two are compared by calling `<` on their inner values.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(five < Arc::new(6));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn lt(&self, other: &Arc<T, A>) -> bool {
|
2015-09-23 22:00:54 +00:00
|
|
|
|
*(*self) < *(*other)
|
|
|
|
|
}
|
2014-12-17 01:51:55 +00:00
|
|
|
|
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// 'Less than or equal to' comparison for two `Arc`s.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// The two are compared by calling `<=` on their inner values.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(five <= Arc::new(5));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn le(&self, other: &Arc<T, A>) -> bool {
|
2015-09-23 22:00:54 +00:00
|
|
|
|
*(*self) <= *(*other)
|
|
|
|
|
}
|
2014-12-17 01:51:55 +00:00
|
|
|
|
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Greater-than comparison for two `Arc`s.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// The two are compared by calling `>` on their inner values.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(five > Arc::new(4));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn gt(&self, other: &Arc<T, A>) -> bool {
|
2015-09-23 22:00:54 +00:00
|
|
|
|
*(*self) > *(*other)
|
|
|
|
|
}
|
2014-12-17 01:51:55 +00:00
|
|
|
|
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// 'Greater than or equal to' comparison for two `Arc`s.
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
|
|
|
|
/// The two are compared by calling `>=` on their inner values.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
2015-01-25 21:05:03 +00:00
|
|
|
|
/// let five = Arc::new(5);
|
2014-12-17 01:51:55 +00:00
|
|
|
|
///
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// assert!(five >= Arc::new(5));
|
2014-12-17 01:51:55 +00:00
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn ge(&self, other: &Arc<T, A>) -> bool {
|
2015-09-23 22:00:54 +00:00
|
|
|
|
*(*self) >= *(*other)
|
|
|
|
|
}
|
2014-10-17 18:00:02 +00:00
|
|
|
|
}
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + Ord, A: Allocator> Ord for Arc<T, A> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Comparison for two `Arc`s.
|
|
|
|
|
///
|
|
|
|
|
/// The two are compared by calling `cmp()` on their inner values.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
/// use std::cmp::Ordering;
|
|
|
|
|
///
|
|
|
|
|
/// let five = Arc::new(5);
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(Ordering::Less, five.cmp(&Arc::new(6)));
|
|
|
|
|
/// ```
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn cmp(&self, other: &Arc<T, A>) -> Ordering {
|
2015-09-23 22:00:54 +00:00
|
|
|
|
(**self).cmp(&**other)
|
|
|
|
|
}
|
2014-10-17 18:00:02 +00:00
|
|
|
|
}
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + Eq, A: Allocator> Eq for Arc<T, A> {}
|
2014-10-17 18:00:02 +00:00
|
|
|
|
|
2015-01-24 17:15:42 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + fmt::Display, A: Allocator> fmt::Display for Arc<T, A> {
|
2019-02-02 11:48:12 +00:00
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
2015-01-20 23:45:07 +00:00
|
|
|
|
fmt::Display::fmt(&**self, f)
|
2014-10-17 18:00:02 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + fmt::Debug, A: Allocator> fmt::Debug for Arc<T, A> {
|
2019-02-02 11:48:12 +00:00
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
2015-01-20 23:45:07 +00:00
|
|
|
|
fmt::Debug::fmt(&**self, f)
|
2015-01-07 22:58:31 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-04-07 07:40:22 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> fmt::Pointer for Arc<T, A> {
|
2019-02-02 11:48:12 +00:00
|
|
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
2017-11-20 16:41:53 +00:00
|
|
|
|
fmt::Pointer::fmt(&(&**self as *const T), f)
|
2015-04-07 07:40:22 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-07-02 12:55:20 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2015-01-24 05:48:20 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2015-04-22 17:05:51 +00:00
|
|
|
|
impl<T: Default> Default for Arc<T> {
|
2016-09-21 17:24:45 +00:00
|
|
|
|
/// Creates a new `Arc<T>`, with the `Default` value for `T`.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// use std::sync::Arc;
|
|
|
|
|
///
|
|
|
|
|
/// let x: Arc<i32> = Default::default();
|
|
|
|
|
/// assert_eq!(*x, 0);
|
|
|
|
|
/// ```
|
2015-09-23 22:00:54 +00:00
|
|
|
|
fn default() -> Arc<T> {
|
|
|
|
|
Arc::new(Default::default())
|
|
|
|
|
}
|
2014-10-17 18:00:02 +00:00
|
|
|
|
}
|
|
|
|
|
|
2015-02-18 04:48:07 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized + Hash, A: Allocator> Hash for Arc<T, A> {
|
2015-02-18 04:48:07 +00:00
|
|
|
|
fn hash<H: Hasher>(&self, state: &mut H) {
|
|
|
|
|
(**self).hash(state)
|
|
|
|
|
}
|
|
|
|
|
}
|
std: Stabilize the std::hash module
This commit aims to prepare the `std::hash` module for alpha by formalizing its
current interface whileholding off on adding `#[stable]` to the new APIs. The
current usage with the `HashMap` and `HashSet` types is also reconciled by
separating out composable parts of the design. The primary goal of this slight
redesign is to separate the concepts of a hasher's state from a hashing
algorithm itself.
The primary change of this commit is to separate the `Hasher` trait into a
`Hasher` and a `HashState` trait. Conceptually the old `Hasher` trait was
actually just a factory for various states, but hashing had very little control
over how these states were used. Additionally the old `Hasher` trait was
actually fairly unrelated to hashing.
This commit redesigns the existing `Hasher` trait to match what the notion of a
`Hasher` normally implies with the following definition:
trait Hasher {
type Output;
fn reset(&mut self);
fn finish(&self) -> Output;
}
This `Hasher` trait emphasizes that hashing algorithms may produce outputs other
than a `u64`, so the output type is made generic. Other than that, however, very
little is assumed about a particular hasher. It is left up to implementors to
provide specific methods or trait implementations to feed data into a hasher.
The corresponding `Hash` trait becomes:
trait Hash<H: Hasher> {
fn hash(&self, &mut H);
}
The old default of `SipState` was removed from this trait as it's not something
that we're willing to stabilize until the end of time, but the type parameter is
always required to implement `Hasher`. Note that the type parameter `H` remains
on the trait to enable multidispatch for specialization of hashing for
particular hashers.
Note that `Writer` is not mentioned in either of `Hash` or `Hasher`, it is
simply used as part `derive` and the implementations for all primitive types.
With these definitions, the old `Hasher` trait is realized as a new `HashState`
trait in the `collections::hash_state` module as an unstable addition for
now. The current definition looks like:
trait HashState {
type Hasher: Hasher;
fn hasher(&self) -> Hasher;
}
The purpose of this trait is to emphasize that the one piece of functionality
for implementors is that new instances of `Hasher` can be created. This
conceptually represents the two keys from which more instances of a
`SipHasher` can be created, and a `HashState` is what's stored in a
`HashMap`, not a `Hasher`.
Implementors of custom hash algorithms should implement the `Hasher` trait, and
only hash algorithms intended for use in hash maps need to implement or worry
about the `HashState` trait.
The entire module and `HashState` infrastructure remains `#[unstable]` due to it
being recently redesigned, but some other stability decision made for the
`std::hash` module are:
* The `Writer` trait remains `#[experimental]` as it's intended to be replaced
with an `io::Writer` (more details soon).
* The top-level `hash` function is `#[unstable]` as it is intended to be generic
over the hashing algorithm instead of hardwired to `SipHasher`
* The inner `sip` module is now private as its one export, `SipHasher` is
reexported in the `hash` module.
And finally, a few changes were made to the default parameters on `HashMap`.
* The `RandomSipHasher` default type parameter was renamed to `RandomState`.
This renaming emphasizes that it is not a hasher, but rather just state to
generate hashers. It also moves away from the name "sip" as it may not always
be implemented as `SipHasher`. This type lives in the
`std::collections::hash_map` module as `#[unstable]`
* The associated `Hasher` type of `RandomState` is creatively called...
`Hasher`! This concrete structure lives next to `RandomState` as an
implemenation of the "default hashing algorithm" used for a `HashMap`. Under
the hood this is currently implemented as `SipHasher`, but it draws an
explicit interface for now and allows us to modify the implementation over
time if necessary.
There are many breaking changes outlined above, and as a result this commit is
a:
[breaking-change]
2014-12-09 20:37:23 +00:00
|
|
|
|
|
2021-07-02 12:55:20 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2015-11-16 08:04:17 +00:00
|
|
|
|
#[stable(feature = "from_for_ptrs", since = "1.6.0")]
|
2015-11-04 12:03:33 +00:00
|
|
|
|
impl<T> From<T> for Arc<T> {
|
2021-05-25 10:07:56 +00:00
|
|
|
|
/// Converts a `T` into an `Arc<T>`
|
|
|
|
|
///
|
|
|
|
|
/// The conversion moves the value into a
|
|
|
|
|
/// newly allocated `Arc`. It is equivalent to
|
|
|
|
|
/// calling `Arc::new(t)`.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
/// ```rust
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let x = 5;
|
|
|
|
|
/// let arc = Arc::new(5);
|
|
|
|
|
///
|
|
|
|
|
/// assert_eq!(Arc::from(x), arc);
|
|
|
|
|
/// ```
|
2015-11-04 12:03:33 +00:00
|
|
|
|
fn from(t: T) -> Self {
|
|
|
|
|
Arc::new(t)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2023-07-25 01:33:16 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2023-10-02 23:12:46 +00:00
|
|
|
|
#[stable(feature = "shared_from_array", since = "1.74.0")]
|
2023-07-25 01:33:16 +00:00
|
|
|
|
impl<T, const N: usize> From<[T; N]> for Arc<[T]> {
|
|
|
|
|
/// Converts a [`[T; N]`](prim@array) into an `Arc<[T]>`.
|
|
|
|
|
///
|
|
|
|
|
/// The conversion moves the array into a newly allocated `Arc`.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let original: [i32; 3] = [1, 2, 3];
|
|
|
|
|
/// let shared: Arc<[i32]> = Arc::from(original);
|
|
|
|
|
/// assert_eq!(&[1, 2, 3], &shared[..]);
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
fn from(v: [T; N]) -> Arc<[T]> {
|
|
|
|
|
Arc::<[T; N]>::from(v)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[stable(feature = "shared_from_slice", since = "1.21.0")]
|
2019-02-02 11:23:15 +00:00
|
|
|
|
impl<T: Clone> From<&[T]> for Arc<[T]> {
|
2021-02-12 20:24:35 +00:00
|
|
|
|
/// Allocate a reference-counted slice and fill it by cloning `v`'s items.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let original: &[i32] = &[1, 2, 3];
|
|
|
|
|
/// let shared: Arc<[i32]> = Arc::from(original);
|
|
|
|
|
/// assert_eq!(&[1, 2, 3], &shared[..]);
|
|
|
|
|
/// ```
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(v: &[T]) -> Arc<[T]> {
|
|
|
|
|
<Self as ArcFromSlice<T>>::from_slice(v)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[stable(feature = "shared_from_slice", since = "1.21.0")]
|
2019-02-02 11:23:15 +00:00
|
|
|
|
impl From<&str> for Arc<str> {
|
2021-02-12 20:24:35 +00:00
|
|
|
|
/// Allocate a reference-counted `str` and copy `v` into it.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let shared: Arc<str> = Arc::from("eggplant");
|
|
|
|
|
/// assert_eq!("eggplant", &shared[..]);
|
|
|
|
|
/// ```
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(v: &str) -> Arc<str> {
|
2017-12-25 22:04:45 +00:00
|
|
|
|
let arc = Arc::<[u8]>::from(v.as_bytes());
|
|
|
|
|
unsafe { Arc::from_raw(Arc::into_raw(arc) as *const str) }
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[stable(feature = "shared_from_slice", since = "1.21.0")]
|
|
|
|
|
impl From<String> for Arc<str> {
|
2021-02-12 20:24:35 +00:00
|
|
|
|
/// Allocate a reference-counted `str` and copy `v` into it.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let unique: String = "eggplant".to_owned();
|
|
|
|
|
/// let shared: Arc<str> = Arc::from(unique);
|
|
|
|
|
/// assert_eq!("eggplant", &shared[..]);
|
|
|
|
|
/// ```
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(v: String) -> Arc<str> {
|
|
|
|
|
Arc::from(&v[..])
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[stable(feature = "shared_from_slice", since = "1.21.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> From<Box<T, A>> for Arc<T, A> {
|
2021-02-12 20:24:35 +00:00
|
|
|
|
/// Move a boxed object to a new, reference-counted allocation.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let unique: Box<str> = Box::from("eggplant");
|
|
|
|
|
/// let shared: Arc<str> = Arc::from(unique);
|
|
|
|
|
/// assert_eq!("eggplant", &shared[..]);
|
|
|
|
|
/// ```
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn from(v: Box<T, A>) -> Arc<T, A> {
|
|
|
|
|
Arc::from_box_in(v)
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[stable(feature = "shared_from_slice", since = "1.21.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T, A: Allocator + Clone> From<Vec<T, A>> for Arc<[T], A> {
|
2021-02-12 20:24:35 +00:00
|
|
|
|
/// Allocate a reference-counted slice and move `v`'s items into it.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let unique: Vec<i32> = vec![1, 2, 3];
|
|
|
|
|
/// let shared: Arc<[i32]> = Arc::from(unique);
|
|
|
|
|
/// assert_eq!(&[1, 2, 3], &shared[..]);
|
|
|
|
|
/// ```
|
2017-06-15 21:10:43 +00:00
|
|
|
|
#[inline]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn from(v: Vec<T, A>) -> Arc<[T], A> {
|
2022-11-18 10:38:51 +00:00
|
|
|
|
unsafe {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let (vec_ptr, len, cap, alloc) = v.into_raw_parts_with_alloc();
|
|
|
|
|
|
|
|
|
|
let rc_ptr = Self::allocate_for_slice_in(len, &alloc);
|
|
|
|
|
ptr::copy_nonoverlapping(vec_ptr, &mut (*rc_ptr).data as *mut [T] as *mut T, len);
|
|
|
|
|
|
|
|
|
|
// Create a `Vec<T, &A>` with length 0, to deallocate the buffer
|
|
|
|
|
// without dropping its contents or the allocator
|
|
|
|
|
let _ = Vec::from_raw_parts_in(vec_ptr, 0, cap, &alloc);
|
|
|
|
|
|
|
|
|
|
Self::from_ptr_in(rc_ptr, alloc)
|
2017-06-15 21:10:43 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-22 20:33:42 +00:00
|
|
|
|
#[stable(feature = "shared_from_cow", since = "1.45.0")]
|
|
|
|
|
impl<'a, B> From<Cow<'a, B>> for Arc<B>
|
|
|
|
|
where
|
|
|
|
|
B: ToOwned + ?Sized,
|
|
|
|
|
Arc<B>: From<&'a B> + From<B::Owned>,
|
|
|
|
|
{
|
2021-05-25 12:06:02 +00:00
|
|
|
|
/// Create an atomically reference-counted pointer from
|
|
|
|
|
/// a clone-on-write pointer by copying its content.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```rust
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// # use std::borrow::Cow;
|
2023-05-06 21:12:29 +00:00
|
|
|
|
/// let cow: Cow<'_, str> = Cow::Borrowed("eggplant");
|
2021-05-25 12:06:02 +00:00
|
|
|
|
/// let shared: Arc<str> = Arc::from(cow);
|
|
|
|
|
/// assert_eq!("eggplant", &shared[..]);
|
|
|
|
|
/// ```
|
2020-04-22 20:33:42 +00:00
|
|
|
|
#[inline]
|
|
|
|
|
fn from(cow: Cow<'a, B>) -> Arc<B> {
|
|
|
|
|
match cow {
|
|
|
|
|
Cow::Borrowed(s) => Arc::from(s),
|
|
|
|
|
Cow::Owned(s) => Arc::from(s),
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-01 06:40:35 +00:00
|
|
|
|
#[stable(feature = "shared_from_str", since = "1.62.0")]
|
2022-04-15 12:34:54 +00:00
|
|
|
|
impl From<Arc<str>> for Arc<[u8]> {
|
|
|
|
|
/// Converts an atomically reference-counted string slice into a byte slice.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let string: Arc<str> = Arc::from("eggplant");
|
|
|
|
|
/// let bytes: Arc<[u8]> = Arc::from(string);
|
|
|
|
|
/// assert_eq!("eggplant".as_bytes(), bytes.as_ref());
|
|
|
|
|
/// ```
|
|
|
|
|
#[inline]
|
|
|
|
|
fn from(rc: Arc<str>) -> Self {
|
|
|
|
|
// SAFETY: `str` has the same layout as `[u8]`.
|
|
|
|
|
unsafe { Arc::from_raw(Arc::into_raw(rc) as *const [u8]) }
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-02-28 04:28:09 +00:00
|
|
|
|
#[stable(feature = "boxed_slice_try_from", since = "1.43.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T, A: Allocator + Clone, const N: usize> TryFrom<Arc<[T], A>> for Arc<[T; N], A> {
|
|
|
|
|
type Error = Arc<[T], A>;
|
2019-06-04 12:15:47 +00:00
|
|
|
|
|
2022-04-28 02:22:52 +00:00
|
|
|
|
fn try_from(boxed_slice: Arc<[T], A>) -> Result<Self, Self::Error> {
|
2019-06-04 12:15:47 +00:00
|
|
|
|
if boxed_slice.len() == N {
|
2022-04-28 02:22:52 +00:00
|
|
|
|
let alloc = boxed_slice.alloc.clone();
|
|
|
|
|
Ok(unsafe { Arc::from_raw_in(Arc::into_raw(boxed_slice) as *mut [T; N], alloc) })
|
2019-06-04 12:15:47 +00:00
|
|
|
|
} else {
|
|
|
|
|
Err(boxed_slice)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2019-06-18 23:39:51 +00:00
|
|
|
|
#[stable(feature = "shared_from_iter", since = "1.37.0")]
|
2022-08-09 00:14:43 +00:00
|
|
|
|
impl<T> FromIterator<T> for Arc<[T]> {
|
2019-06-19 08:23:28 +00:00
|
|
|
|
/// Takes each element in the `Iterator` and collects it into an `Arc<[T]>`.
|
|
|
|
|
///
|
|
|
|
|
/// # Performance characteristics
|
|
|
|
|
///
|
|
|
|
|
/// ## The general case
|
|
|
|
|
///
|
|
|
|
|
/// In the general case, collecting into `Arc<[T]>` is done by first
|
|
|
|
|
/// collecting into a `Vec<T>`. That is, when writing the following:
|
|
|
|
|
///
|
|
|
|
|
/// ```rust
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
|
|
|
|
|
/// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// this behaves as if we wrote:
|
|
|
|
|
///
|
|
|
|
|
/// ```rust
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let evens: Arc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
|
|
|
|
|
/// .collect::<Vec<_>>() // The first set of allocations happens here.
|
|
|
|
|
/// .into(); // A second allocation for `Arc<[T]>` happens here.
|
|
|
|
|
/// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
|
|
|
|
|
/// ```
|
|
|
|
|
///
|
|
|
|
|
/// This will allocate as many times as needed for constructing the `Vec<T>`
|
|
|
|
|
/// and then it will allocate once for turning the `Vec<T>` into the `Arc<[T]>`.
|
|
|
|
|
///
|
|
|
|
|
/// ## Iterators of known length
|
|
|
|
|
///
|
|
|
|
|
/// When your `Iterator` implements `TrustedLen` and is of an exact size,
|
|
|
|
|
/// a single allocation will be made for the `Arc<[T]>`. For example:
|
|
|
|
|
///
|
|
|
|
|
/// ```rust
|
|
|
|
|
/// # use std::sync::Arc;
|
|
|
|
|
/// let evens: Arc<[u8]> = (0..10).collect(); // Just a single allocation happens here.
|
|
|
|
|
/// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
|
|
|
|
|
/// ```
|
2022-08-09 00:14:43 +00:00
|
|
|
|
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
|
2020-04-19 11:34:00 +00:00
|
|
|
|
ToArcSlice::to_arc_slice(iter.into_iter())
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Specialization trait used for collecting into `Arc<[T]>`.
|
2020-04-19 11:34:00 +00:00
|
|
|
|
trait ToArcSlice<T>: Iterator<Item = T> + Sized {
|
|
|
|
|
fn to_arc_slice(self) -> Arc<[T]>;
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2020-04-19 11:34:00 +00:00
|
|
|
|
impl<T, I: Iterator<Item = T>> ToArcSlice<T> for I {
|
|
|
|
|
default fn to_arc_slice(self) -> Arc<[T]> {
|
|
|
|
|
self.collect::<Vec<T>>().into()
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
alloc: Add unstable Cfg feature `no-global_oom_handling`
For certain sorts of systems, programming, it's deemed essential that
all allocation failures be explicitly handled where they occur. For
example, see Linus Torvald's opinion in [1]. Merely not calling global
panic handlers, or always `try_reserving` first (for vectors), is not
deemed good enough, because the mere presence of the global OOM handlers
is burdens static analysis.
One option for these projects to use rust would just be to skip `alloc`,
rolling their own allocation abstractions. But this would, in my
opinion be a real shame. `alloc` has a few `try_*` methods already, and
we could easily have more. Features like custom allocator support also
demonstrate and existing to support diverse use-cases with the same
abstractions.
A natural way to add such a feature flag would a Cargo feature, but
there are currently uncertainties around how std library crate's Cargo
features may or not be stable, so to avoid any risk of stabilizing by
mistake we are going with a more low-level "raw cfg" token, which
cannot be interacted with via Cargo alone.
Note also that since there is no notion of "default cfg tokens" outside
of Cargo features, we have to invert the condition from
`global_oom_handling` to to `not(no_global_oom_handling)`. This breaks
the monotonicity that would be important for a Cargo feature (i.e.
turning on more features should never break compatibility), but it
doesn't matter for raw cfg tokens which are not intended to be
"constraint solved" by Cargo or anything else.
To support this use-case we create a new feature, "global-oom-handling",
on by default, and put the global OOM handler infra and everything else
it that depends on it behind it. By default, nothing is changed, but
users concerned about global handling can make sure it is disabled, and
be confident that all OOM handling is local and explicit.
For this first iteration, non-flat collections are outright disabled.
`Vec` and `String` don't yet have `try_*` allocation methods, but are
kept anyways since they can be oom-safely created "from parts", and we
hope to add those `try_` methods in the future.
[1]: https://lore.kernel.org/lkml/CAHk-=wh_sNLoz84AUUzuqXEsYH35u=8HV3vK-jbRbJ_B-JjGrg@mail.gmail.com/
2021-04-17 00:18:04 +00:00
|
|
|
|
#[cfg(not(no_global_oom_handling))]
|
2020-04-19 11:34:00 +00:00
|
|
|
|
impl<T, I: iter::TrustedLen<Item = T>> ToArcSlice<T> for I {
|
|
|
|
|
fn to_arc_slice(self) -> Arc<[T]> {
|
2019-06-19 08:23:28 +00:00
|
|
|
|
// This is the case for a `TrustedLen` iterator.
|
2020-04-19 11:34:00 +00:00
|
|
|
|
let (low, high) = self.size_hint();
|
2019-06-19 08:23:28 +00:00
|
|
|
|
if let Some(high) = high {
|
|
|
|
|
debug_assert_eq!(
|
|
|
|
|
low,
|
|
|
|
|
high,
|
|
|
|
|
"TrustedLen iterator's size hint is not exact: {:?}",
|
|
|
|
|
(low, high)
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
unsafe {
|
|
|
|
|
// SAFETY: We need to ensure that the iterator has an exact length and we have.
|
2020-04-19 11:34:00 +00:00
|
|
|
|
Arc::from_iter_exact(self, low)
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
|
|
|
|
} else {
|
2023-03-03 01:35:10 +00:00
|
|
|
|
// TrustedLen contract guarantees that `upper_bound == None` implies an iterator
|
2021-03-31 21:09:28 +00:00
|
|
|
|
// length exceeding `usize::MAX`.
|
|
|
|
|
// The default implementation would collect into a vec which would panic.
|
|
|
|
|
// Thus we panic here immediately without invoking `Vec` code.
|
|
|
|
|
panic!("capacity overflow");
|
2019-06-19 08:23:28 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-11-16 16:54:28 +00:00
|
|
|
|
#[stable(feature = "rust1", since = "1.0.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> borrow::Borrow<T> for Arc<T, A> {
|
2015-09-23 22:00:54 +00:00
|
|
|
|
fn borrow(&self) -> &T {
|
|
|
|
|
&**self
|
|
|
|
|
}
|
2015-08-19 14:03:59 +00:00
|
|
|
|
}
|
2015-09-17 06:17:39 +00:00
|
|
|
|
|
|
|
|
|
#[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> AsRef<T> for Arc<T, A> {
|
2015-10-12 05:11:59 +00:00
|
|
|
|
fn as_ref(&self) -> &T {
|
|
|
|
|
&**self
|
|
|
|
|
}
|
2015-09-17 06:17:39 +00:00
|
|
|
|
}
|
2018-08-31 23:54:59 +00:00
|
|
|
|
|
2018-12-18 02:14:07 +00:00
|
|
|
|
#[stable(feature = "pin", since = "1.33.0")]
|
2022-04-28 02:22:52 +00:00
|
|
|
|
impl<T: ?Sized, A: Allocator> Unpin for Arc<T, A> {}
|
2019-05-12 12:53:01 +00:00
|
|
|
|
|
2021-01-07 17:41:58 +00:00
|
|
|
|
/// Get the offset within an `ArcInner` for the payload behind a pointer.
|
2020-06-30 16:47:23 +00:00
|
|
|
|
///
|
|
|
|
|
/// # Safety
|
|
|
|
|
///
|
2021-01-07 17:32:42 +00:00
|
|
|
|
/// The pointer must point to (and have valid metadata for) a previously
|
|
|
|
|
/// valid instance of T, but the T is allowed to be dropped.
|
2022-07-10 10:14:28 +00:00
|
|
|
|
unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> usize {
|
2021-01-09 19:32:55 +00:00
|
|
|
|
// Align the unsized value to the end of the ArcInner.
|
|
|
|
|
// Because RcBox is repr(C), it will always be the last field in memory.
|
|
|
|
|
// SAFETY: since the only unsized types possible are slices, trait objects,
|
|
|
|
|
// and extern types, the input safety requirement is currently enough to
|
|
|
|
|
// satisfy the requirements of align_of_val_raw; this is an implementation
|
2021-07-23 23:14:28 +00:00
|
|
|
|
// detail of the language that must not be relied upon outside of std.
|
2020-12-26 23:16:44 +00:00
|
|
|
|
unsafe { data_offset_align(align_of_val_raw(ptr)) }
|
2019-05-12 12:53:01 +00:00
|
|
|
|
}
|
|
|
|
|
|
2019-06-20 21:13:06 +00:00
|
|
|
|
#[inline]
|
2022-07-10 10:14:28 +00:00
|
|
|
|
fn data_offset_align(align: usize) -> usize {
|
2019-05-12 12:53:01 +00:00
|
|
|
|
let layout = Layout::new::<ArcInner<()>>();
|
2022-07-10 10:14:28 +00:00
|
|
|
|
layout.size() + layout.padding_needed_for(align)
|
2019-05-12 12:53:01 +00:00
|
|
|
|
}
|
2022-07-29 18:54:47 +00:00
|
|
|
|
|
|
|
|
|
#[stable(feature = "arc_error", since = "1.52.0")]
|
|
|
|
|
impl<T: core::error::Error + ?Sized> core::error::Error for Arc<T> {
|
|
|
|
|
#[allow(deprecated, deprecated_in_future)]
|
|
|
|
|
fn description(&self) -> &str {
|
|
|
|
|
core::error::Error::description(&**self)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[allow(deprecated)]
|
|
|
|
|
fn cause(&self) -> Option<&dyn core::error::Error> {
|
|
|
|
|
core::error::Error::cause(&**self)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn source(&self) -> Option<&(dyn core::error::Error + 'static)> {
|
|
|
|
|
core::error::Error::source(&**self)
|
|
|
|
|
}
|
|
|
|
|
|
2023-07-06 16:53:52 +00:00
|
|
|
|
fn provide<'a>(&'a self, req: &mut core::error::Request<'a>) {
|
2022-07-29 18:54:47 +00:00
|
|
|
|
core::error::Error::provide(&**self, req);
|
|
|
|
|
}
|
|
|
|
|
}
|