-
Notifications
You must be signed in to change notification settings - Fork 12.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix Pointer to reference conversion docs #129652
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -57,50 +57,42 @@ | |
//! [`NonNull::dangling`] in such cases. | ||
//! | ||
//! ## Pointer to reference conversion | ||
//! When converting a pointer to a reference `&T` using `&*`, | ||
//! | ||
//! When converting a pointer to a reference (e.g. via `&*ptr` or `&mut *ptr`), | ||
//! there are several rules that must be followed: | ||
//! | ||
//! * The pointer must be properly aligned. | ||
//! | ||
// some microprocessors may use address 0 for an interrupt vector. | ||
// users of these microprocessors must always read/write address 0 through | ||
// a raw pointer, not a reference. | ||
//! * It must be non-null. | ||
//! | ||
//! * It must be "dereferenceable" in the sense defined above. | ||
//! | ||
//! * The pointer must point to a valid value of type `T`. | ||
//! This means that the created reference can only refer to | ||
//! uninitialized memory through careful use of `MaybeUninit`, | ||
//! or if the uninitialized memory is entirely contained within | ||
//! padding bytes, since | ||
//! [padding has the same validity invariant as `MaybeUninit`][ucg-pad]. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think we should repeat the validity rules here, let's just point to the reference instead. |
||
//! | ||
//! * You must enforce Rust's aliasing rules, since the lifetime of the | ||
//! created reference is arbitrarily chosen, | ||
//! and does not necessarily reflect the actual lifetime of the data. | ||
//! In particular, while this reference exists, | ||
//! the memory the pointer points to must | ||
//! not get accessed (read or written) through any raw pointer, | ||
//! except for data inside an `UnsafeCell`. | ||
//! Note that aliased writes are always UB for mutable references, | ||
//! even if they only modify `UnsafeCell` data. | ||
//! * The pointer must point to a [valid value] of type `T`. | ||
//! | ||
//! * You must enforce Rust's aliasing rules. The exact aliasing rules are not decided yet, so we | ||
//! only give a rough overview here. The rules also depend on whether a mutable or a shared | ||
//! reference is being created. | ||
//! * When creating a mutable reference, then while this reference exists, the memory it points to | ||
//! must not get accessed (read or written) through any other pointer or reference not derived | ||
//! from this reference. | ||
//! * When creating a shared reference, then while this reference exists, the memory it points to | ||
//! must not get mutated (except inside `UnsafeCell`). | ||
//! | ||
//! If a pointer follows all of these rules, it is said to be | ||
//! *convertible to a reference*. | ||
//! *convertible to a (mutable or shared) reference*. | ||
// ^ we use this term instead of saying that the produced reference must | ||
// be valid, as the validity of a reference is easily confused for the | ||
// validity of the thing it refers to, and while the two concepts are | ||
// closly related, they are not identical. | ||
//! | ||
//! These apply even if the result is unused! | ||
//! These rules apply even if the result is unused! | ||
//! (The part about being initialized is not yet fully decided, but until | ||
//! it is, the only safe approach is to ensure that they are indeed initialized.) | ||
//! | ||
//! An example of the implications of the above rules is that an expression such | ||
//! as `unsafe { &*(0 as *const u8) }` is Immediate Undefined Behavior. | ||
//! | ||
//! [ucgpad]: https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#padding | ||
//! [valid value]: ../../reference/behavior-considered-undefined.html#invalid-values | ||
//! | ||
//! ## Allocated object | ||
//! | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what the point of this was, it was anyway hidden from users. If we want to give guidance on how to access address 0, this is the wrong place. (I think currently it is always UB to access address 0, even with raw pointers.)