[stdlib] Add build option to enable _debugPrecondition in Release mode #41445
Conversation
This file contains hidden or 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
|
@swift-ci test |
|
I am mildly worried about testing this, since the stdlib is not built this way in CI. What's the plan? |
|
Building a throwaway stdlib configuration would be prohibitively expensive, so I'm thinking we'll just let this setting go untested in regular CI jobs, like we do with runtime counters, Array's cow checks, SWIFT_STDLIB_ENABLE_UNICODE_DATA etc. We have additional CI instances dedicated to specialized configurations, and this will be covered by at least one of them. The updated Asserts.swift test should catch cases where Update incoming. |
|
Ah, there is also the fact that parts of our unit tests are currently looking at |
It is sometimes desirable to always perform (relatively cheap) runtime checks in the stdlib, even in configurations where we’d otherwise elide them. Add a build-time option to the standard library (`SWIFT_STDLIB_ENABLE_DEBUG_PRECONDITIONS_IN_RELEASE`) to make `_debugPrecondition` work like `_precondition`, i.e., to enable it even in ReleaseAssert configurations. This option will keep additional checks in the following places, even in release mode: - Range checking in the subscript operations of all unsafe buffer pointer types. - Nil checking in `Optional.unsafelyUnwrapped` - Additional argument validation in `Unsafe[Mutable][Raw]Pointer`’s initialization/assignment/move/deinitialization/binding methods - Protection against initializing `Unsafe[Mutable][Raw]Pointer` with invalid data. (Negative count, nil pointer for non-empty buffer, etc) - Checks against index overflow in `Unsafe[Mutable]BufferPointer`’s index manipulation methods - Checks against backward ranges in `Range(uncheckedBounds:)`, `ClosedRange(uncheckedBounds:)` - Dynamic isa check in `unsafeDowncast(_:to:)` - Additional [cheap] checks to catch invalid Sequence/Collection implementations in `Array.init<S:Sequence>(_:)` and elsewhere - Checks against `Character` containing multiple grapheme clusters - More index validation in `EmptyCollection` (Additional cases will get added as the stdlib evolves.) The option is disabled by default — so `_debugPrecondition`s continue to be disabled in optimized builds, even after this change lands, unless someone specifically builds a stdlib that enables them. rdar://89118585
lorentey
force-pushed
the
unconditional-debugPrecondition
branch
from
b2c78ac to
5274295
Compare
|
@swift-ci test |
|
🤔 |
|
@swift-ci clean test macOS platform |
lorentey
added a commit
to lorentey/swift
that referenced
this pull request
May 7, 2022
…set a trap function in the stdlib (The underlying functionality was added in swiftlang#41445 and swiftlang#41449, respectively.)
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.
It is sometimes desirable to always perform (relatively cheap) runtime checks in the stdlib, even in configurations where we’d otherwise elide them.
Add a build-time option to the standard library (
SWIFT_STDLIB_ENABLE_DEBUG_PRECONDITIONS_IN_RELEASE) to make_debugPreconditionwork like_precondition, i.e., to enable it even in ReleaseAssert configurations.This option will keep additional checks in the following places, even in release mode:
Optional.unsafelyUnwrappedUnsafe[Mutable][Raw]Pointer’s initialization/assignment/move/deinitialization/binding methodsUnsafe[Mutable][Raw]Pointerwith invalid data. (Negative count, nil pointer for non-empty buffer, etc)Unsafe[Mutable]BufferPointer’s index manipulation methodsRange(uncheckedBounds:),ClosedRange(uncheckedBounds:)unsafeDowncast(_:to:)Array.init<S:Sequence>(_:)and elsewhereCharactercontaining multiple grapheme clustersEmptyCollection(Additional cases will get added as the stdlib evolves.)
The option is disabled by default — so
_debugPreconditions continue to be disabled in optimized builds, even after this change lands, unless someone specifically builds a stdlib that enables them.rdar://89118585