averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

Introduce safety checkin for ConcurrentValue conformance.

Browse Source 
Introduce checking of ConcurrentValue conformances:
- For structs, check that each stored property conforms to ConcurrentValue
- For enums, check that each associated value conforms to ConcurrentValue
- For classes, check that each stored property is immutable and conforms
  to ConcurrentValue

Because all of the stored properties / associated values need to be
visible for this check to work, limit ConcurrentValue conformances to
be in the same source file as the type definition.

This checking can be disabled by conforming to a new marker protocol,
UnsafeConcurrentValue, that refines ConcurrentValue.
UnsafeConcurrentValue otherwise his no specific meaning. This allows
both "I know what I'm doing" for types that manage concurrent access
themselves as well as enabling retroactive conformance, both of which
are fundamentally unsafe but also quite necessary.

The bulk of this change ended up being to the standard library, because
all conformances of standard library types to the ConcurrentValue
protocol needed to be sunk down into the standard library so they
would benefit from the checking above. There were numerous little
mistakes in the initial pass through the stsandard library types that
have now been corrected.
This commit is contained in:
Doug Gregor
2021-02-04 03:36:26 -08:00
parent 9b166c1fde
commit 1a1f79c0de
67 changed files with 344 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
stdlib/public/core/ConcurrentValue.swift
View File

@@ -2,7 +2,7 @@
////
//// This source file is part of the Swift.org open source project
////
//// Copyright (c) 2020 Apple Inc. and the Swift project authors
//// Copyright (c) 2021 Apple Inc. and the Swift project authors
//// Licensed under Apache License v2.0 with Runtime Library Exception
////
//// See https://swift.org/LICENSE.txt for license information
@@ -14,118 +14,7 @@
/// be safely used in concurrent code.
@_marker public protocol ConcurrentValue { }
extension Array: ConcurrentValue where Element: ConcurrentValue { }
extension ArraySlice: ConcurrentValue where Element: ConcurrentValue { }
extension Bool: ConcurrentValue { }
extension AutoreleasingUnsafeMutablePointer: ConcurrentValue { }
extension Character: ConcurrentValue { }
extension KeyedEncodingContainer: ConcurrentValue { }
extension KeyedDecodingContainer: ConcurrentValue { }
extension CodingUserInfoKey: ConcurrentValue { }
extension EncodingError: ConcurrentValue { }
extension DecodingError: ConcurrentValue { }
extension IndexingIterator: ConcurrentValue { }
extension ContiguousArray: ConcurrentValue { }
extension ClosedRange: ConcurrentValue where Bound: ConcurrentValue { }
extension ClosedRange.Index: ConcurrentValue where Bound: ConcurrentValue { }
extension OpaquePointer: ConcurrentValue { }
extension CVaListPointer: ConcurrentValue { }
extension Dictionary: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension Dictionary.Keys: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension Dictionary.Values: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension Dictionary.Keys.Iterator: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension Dictionary.Values.Iterator: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension Dictionary.Index: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension Dictionary.Iterator: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension EmptyCollection: ConcurrentValue { }
extension EmptyCollection.Iterator: ConcurrentValue { }
extension Hasher: ConcurrentValue { }
extension DefaultIndices: ConcurrentValue where Elements: ConcurrentValue { }
extension KeyValuePairs: ConcurrentValue where Key: ConcurrentValue, Value: ConcurrentValue { }
extension ManagedBufferPointer: ConcurrentValue where Header: ConcurrentValue, Element: ConcurrentValue { }
extension Unicode.Scalar: ConcurrentValue { }
extension Unicode.Scalar.UTF16View: ConcurrentValue { }
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension Unicode.Scalar.UTF8View: ConcurrentValue { }
extension ObjectIdentifier: ConcurrentValue { }
extension SystemRandomNumberGenerator: ConcurrentValue { }
extension Range: ConcurrentValue where Bound: ConcurrentValue { }
extension PartialRangeUpTo: ConcurrentValue where Bound: ConcurrentValue { }
extension PartialRangeThrough: ConcurrentValue where Bound: ConcurrentValue { }
extension PartialRangeFrom: ConcurrentValue where Bound: ConcurrentValue { }
extension PartialRangeFrom.Iterator: ConcurrentValue where Bound: ConcurrentValue { }
extension Repeated: ConcurrentValue where Element: ConcurrentValue { }
extension IteratorSequence: ConcurrentValue where Base: ConcurrentValue { }
extension Set: ConcurrentValue where Element: ConcurrentValue { }
extension Set.Index: ConcurrentValue where Element: ConcurrentValue { }
extension Set.Iterator: ConcurrentValue where Element: ConcurrentValue { }
extension Slice: ConcurrentValue where Base: ConcurrentValue { }
extension StaticString: ConcurrentValue { }
extension StrideToIterator: ConcurrentValue where Element: ConcurrentValue { }
extension StrideTo: ConcurrentValue where Element: ConcurrentValue { }
extension StrideThroughIterator: ConcurrentValue where Element: ConcurrentValue { }
extension StrideThrough: ConcurrentValue where Element: Strideable { }
extension String: ConcurrentValue { }
extension String.Iterator: ConcurrentValue { }
extension String.Index: ConcurrentValue { }
extension DefaultStringInterpolation: ConcurrentValue { }
extension String.UnicodeScalarView: ConcurrentValue { }
extension String.UnicodeScalarView.Iterator: ConcurrentValue { }
extension String.UTF16View: ConcurrentValue { }
extension String.UTF16View.Iterator: ConcurrentValue { }
extension String.UTF8View: ConcurrentValue { }
extension Substring: ConcurrentValue { }
extension Substring.UnicodeScalarView: ConcurrentValue { }
extension Substring.UTF16View: ConcurrentValue { }
extension Substring.UTF8View: ConcurrentValue { }
extension Unicode.Scalar.Properties: ConcurrentValue { }
extension Unicode.CanonicalCombiningClass: ConcurrentValue { }
extension Unmanaged: ConcurrentValue { }
extension UnsafePointer: ConcurrentValue { }
extension UnsafeMutablePointer: ConcurrentValue { }
extension UnsafeRawPointer: ConcurrentValue { }
extension UnsafeMutableRawPointer: ConcurrentValue { }
extension Unicode.UTF8.ForwardParser: ConcurrentValue { }
extension Unicode.UTF8.ReverseParser: ConcurrentValue { }
extension Unicode.UTF16.ForwardParser: ConcurrentValue { }
extension Unicode.UTF16.ReverseParser: ConcurrentValue { }
extension Unicode.UTF32.Parser: ConcurrentValue { }
extension Unicode.ParseResult: ConcurrentValue where T: ConcurrentValue { }
extension Unicode.GeneralCategory: ConcurrentValue { }
extension Unicode.NumericType: ConcurrentValue { }
extension Unicode.UTF8: ConcurrentValue { }
extension Unicode.UTF16: ConcurrentValue { }
extension Unicode.UTF32: ConcurrentValue { }
extension UnicodeDecodingResult: ConcurrentValue { }
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension CollectionDifference: ConcurrentValue where ChangeElement: ConcurrentValue { }
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension CollectionDifference.Change: ConcurrentValue where ChangeElement: ConcurrentValue { }
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
extension CollectionDifference.Index: ConcurrentValue where ChangeElement: ConcurrentValue { }
extension CollectionOfOne: ConcurrentValue where Element: ConcurrentValue { }
extension CollectionOfOne.Iterator: ConcurrentValue where Element: ConcurrentValue { }
extension Mirror: ConcurrentValue { }
extension Mirror.AncestorRepresentation: ConcurrentValue { }
extension Mirror.DisplayStyle: ConcurrentValue { }
extension UnsafeMutableBufferPointer: ConcurrentValue { }
extension UnsafeBufferPointer: ConcurrentValue { }
extension UnsafeBufferPointer.Iterator: ConcurrentValue { }
extension UnsafeMutableRawBufferPointer: ConcurrentValue { }
extension UnsafeRawBufferPointer: ConcurrentValue { }
extension UnsafeRawBufferPointer.Iterator: ConcurrentValue { }
extension PartialKeyPath: ConcurrentValue where Root: ConcurrentValue { }
extension FloatingPointSign: ConcurrentValue { }
extension FloatingPointClassification: ConcurrentValue { }
extension FloatingPointRoundingRule: ConcurrentValue { }
extension Optional: ConcurrentValue where Wrapped: ConcurrentValue { }
extension Never: ConcurrentValue { }
extension Result: ConcurrentValue where Success: ConcurrentValue, Failure: ConcurrentValue { }
/// The UnsafeConcurrentValue protocol indicates that value of the given type
/// can be safely used in concurrent code, but disables some safety checking
/// at the conformance site.
@_marker public protocol UnsafeConcurrentValue: ConcurrentValue { }