restate GlobalAlloc method safety preconditions in terms of what the caller has to do for greater clarity #123932
+17
−15
Conversation
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
…caller has to do for greater clarity
rustbot
added
S-waiting-on-review
zachs18
reviewed
Apr 14, 2024
Co-authored-by: zachs18 <8355914+zachs18@users.noreply.github.com>
tgross35
reviewed
Jul 16, 2024
| @@ -221,20 +222,21 @@ pub unsafe trait GlobalAlloc { | |||
| /// | |||
| /// # Safety | |||
| /// | |||
| /// This function is unsafe because undefined behavior can result | |||
| /// if the caller does not ensure all of the following: | |||
| /// The caller has to ensure that | |||
There was a problem hiding this comment.
Suggested change
| /// The caller has to ensure that | |
| /// The caller must ensure that: |
tgross35
reviewed
Jul 16, 2024
| @@ -157,14 +157,14 @@ pub unsafe trait GlobalAlloc { | |||
| /// | |||
| /// # Safety | |||
| /// | |||
| /// This function is unsafe because undefined behavior can result | |||
| /// if the caller does not ensure all of the following: | |||
| /// The caller has to ensure that | |||
There was a problem hiding this comment.
Suggested change
| /// The caller has to ensure that | |
| /// The caller must ensure that: |
must is a bit stronger than has to
tgross35
reviewed
Jul 16, 2024
| /// equal to `isize::MAX`). | ||
| /// | ||
| /// Otherwise undefined behaviour can result. |
There was a problem hiding this comment.
Suggested change
| /// Otherwise undefined behaviour can result. | |
| /// If these are not followed, undefined behaviour can result. |
Just clarify what otherwise refers to.
tgross35
reviewed
Jul 16, 2024
Comment on lines
+128
to
+129
| /// The caller has to ensure that `layout` has non-zero size. Zero sized | ||
| /// `layout` can result in undefined behaviour. |
There was a problem hiding this comment.
The cleanup is nice, but I don't think specifying "the caller" adds much here. Maybe something like:
/// `layout` must have non-zero size. Attempting to allocate for a zero-sized
/// `layout` may result in undefined behavior.(optional nit)
|
@rustbot author Thanks for these changes, a few suggestions. Just comment |
rustbot
added
S-waiting-on-author
|
☔ The latest upstream changes (presumably #128313) made this pull request unmergeable. Please resolve the merge conflicts. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.