1
Fork 0

reference NonNull::dangling

This commit is contained in:
Ralf Jung 2020-11-20 10:25:59 +01:00
parent 0f572a9810
commit a7677f7714
2 changed files with 12 additions and 9 deletions

View file

@ -62,10 +62,12 @@
//! T` obtained from [`Box::<T>::into_raw`] may be deallocated using the //! T` obtained from [`Box::<T>::into_raw`] may be deallocated using the
//! [`Global`] allocator with [`Layout::for_value(&*value)`]. //! [`Global`] allocator with [`Layout::for_value(&*value)`].
//! //!
//! For zero-sized values, the `Box` pointer still has to be [valid] for reads and writes and //! For zero-sized values, the `Box` pointer still has to be [valid] for reads
//! sufficiently aligned. In particular, casting any aligned non-zero integer literal to a raw //! and writes and sufficiently aligned. In particular, casting any aligned
//! pointer produces a valid pointer, but a pointer pointing into previously allocated memory that //! non-zero integer literal to a raw pointer produces a valid pointer, but a
//! since got freed is not valid. //! pointer pointing into previously allocated memory that since got freed is
//! not valid. The recommended way to build a Box to a ZST if `Box::new` cannot
//! be used is to use [`ptr::NonNull::dangling`].
//! //!
//! So long as `T: Sized`, a `Box<T>` is guaranteed to be represented //! So long as `T: Sized`, a `Box<T>` is guaranteed to be represented
//! as a single pointer and is also ABI-compatible with C pointers //! as a single pointer and is also ABI-compatible with C pointers

View file

@ -20,11 +20,12 @@
//! be *dereferenceable*: the memory range of the given size starting at the pointer must all be //! be *dereferenceable*: the memory range of the given size starting at the pointer must all be
//! within the bounds of a single allocated object. Note that in Rust, //! within the bounds of a single allocated object. Note that in Rust,
//! every (stack-allocated) variable is considered a separate allocated object. //! every (stack-allocated) variable is considered a separate allocated object.
//! * Even for operations of [size zero][zst], the pointer must not be "dangling" in the sense of //! * Even for operations of [size zero][zst], the pointer must not be pointing to deallocated
//! pointing to deallocated memory. However, casting any non-zero integer literal to a pointer is //! memory, i.e., deallocation makes pointers invalid even for zero-sized operations. However,
//! valid for zero-sized accesses. This corresponds to writing your own allocator; allocating //! casting any non-zero integer *literal* to a pointer is valid for zero-sized accesses, even if
//! zero-sized objects is not very hard. In contrast, when you use the standard allocator, after //! some memory happens to exist at that address and gets deallocated. This corresponds to writing
//! memory got deallocated, even zero-sized accesses to that memory are invalid. //! your own allocator: allocating zero-sized objects is not very hard. The canonical way to
//! obtain a pointer that is valid for zero-sized accesses is [`NonNull::dangling`].
//! * All accesses performed by functions in this module are *non-atomic* in the sense //! * All accesses performed by functions in this module are *non-atomic* in the sense
//! of [atomic operations] used to synchronize between threads. This means it is //! of [atomic operations] used to synchronize between threads. This means it is
//! undefined behavior to perform two concurrent accesses to the same location from different //! undefined behavior to perform two concurrent accesses to the same location from different