-
Notifications
You must be signed in to change notification settings - Fork 10.5k
DataProtocol and new inline Data #20225
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
Merged
itaiferber
merged 1 commit into
swiftlang:master
from
phausler:inline_data_and_dataprotocol
Dec 13, 2018
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 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
61 changes: 61 additions & 0 deletions
61
stdlib/public/Darwin/Foundation/Collections+DataProtocol.swift
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This source file is part of the Swift.org open source project | ||
// | ||
// Copyright (c) 2018 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 | ||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
//===--- DataProtocol -----------------------------------------------------===// | ||
|
||
extension Array: DataProtocol where Element == UInt8 { | ||
public var regions: CollectionOfOne<Array<UInt8>> { | ||
return CollectionOfOne(self) | ||
} | ||
} | ||
|
||
extension ArraySlice: DataProtocol where Element == UInt8 { | ||
public var regions: CollectionOfOne<ArraySlice<UInt8>> { | ||
return CollectionOfOne(self) | ||
} | ||
} | ||
|
||
extension ContiguousArray: DataProtocol where Element == UInt8 { | ||
public var regions: CollectionOfOne<ContiguousArray<UInt8>> { | ||
return CollectionOfOne(self) | ||
} | ||
} | ||
|
||
// FIXME: This currently crashes compilation in the Late Inliner. | ||
// extension CollectionOfOne : DataProtocol where Element == UInt8 { | ||
// public typealias Regions = CollectionOfOne<Data> | ||
// | ||
// public var regions: CollectionOfOne<Data> { | ||
// return CollectionOfOne<Data>(Data(self)) | ||
// } | ||
// } | ||
|
||
extension EmptyCollection : DataProtocol where Element == UInt8 { | ||
public var regions: EmptyCollection<Data> { | ||
return EmptyCollection<Data>() | ||
} | ||
} | ||
|
||
extension Repeated: DataProtocol where Element == UInt8 { | ||
public typealias Regions = Repeated<Data> | ||
|
||
public var regions: Repeated<Data> { | ||
guard self.count > 0 else { return repeatElement(Data(), count: 0) } | ||
return repeatElement(Data(CollectionOfOne(self.first!)), count: self.count) | ||
} | ||
} | ||
|
||
//===--- MutableDataProtocol ----------------------------------------------===// | ||
|
||
extension Array: MutableDataProtocol where Element == UInt8 { } | ||
|
||
extension ContiguousArray: MutableDataProtocol where Element == UInt8 { } |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
//===----------------------------------------------------------------------===// | ||
// | ||
// This source file is part of the Swift.org open source project | ||
// | ||
// Copyright (c) 2018 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 | ||
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
//===--- ContiguousBytes --------------------------------------------------===// | ||
|
||
/// Indicates that the conforming type is a contiguous collection of raw bytes | ||
/// whose underlying storage is directly accessible by withUnsafeBytes. | ||
public protocol ContiguousBytes { | ||
/// Calls the given closure with the contents of underlying storage. | ||
/// | ||
/// - note: Calling `withUnsafeBytes` multiple times does not guarantee that | ||
/// the same buffer pointer will be passed in every time. | ||
/// - warning: The buffer argument to the body should not be stored or used | ||
/// outside of the lifetime of the call to the closure. | ||
func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R | ||
} | ||
|
||
//===--- Collection Conformances ------------------------------------------===// | ||
|
||
// FIXME: When possible, expand conformance to `where Element : Trivial`. | ||
extension Array : ContiguousBytes where Element == UInt8 { } | ||
|
||
// FIXME: When possible, expand conformance to `where Element : Trivial`. | ||
extension ArraySlice : ContiguousBytes where Element == UInt8 { } | ||
|
||
// FIXME: When possible, expand conformance to `where Element : Trivial`. | ||
extension ContiguousArray : ContiguousBytes where Element == UInt8 { } | ||
|
||
//===--- Pointer Conformances ---------------------------------------------===// | ||
|
||
extension UnsafeRawBufferPointer : ContiguousBytes { | ||
@inlinable | ||
public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R { | ||
return try body(self) | ||
} | ||
} | ||
|
||
extension UnsafeMutableRawBufferPointer : ContiguousBytes { | ||
@inlinable | ||
public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R { | ||
return try body(UnsafeRawBufferPointer(self)) | ||
} | ||
} | ||
|
||
// FIXME: When possible, expand conformance to `where Element : Trivial`. | ||
extension UnsafeBufferPointer : ContiguousBytes where Element == UInt8 { | ||
@inlinable | ||
public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R { | ||
return try body(UnsafeRawBufferPointer(self)) | ||
} | ||
} | ||
|
||
// FIXME: When possible, expand conformance to `where Element : Trivial`. | ||
extension UnsafeMutableBufferPointer : ContiguousBytes where Element == UInt8 { | ||
@inlinable | ||
public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R { | ||
return try body(UnsafeRawBufferPointer(self)) | ||
} | ||
} | ||
|
||
// FIXME: When possible, expand conformance to `where Element : Trivial`. | ||
extension EmptyCollection : ContiguousBytes where Element == UInt8 { | ||
@inlinable | ||
public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R { | ||
return try body(UnsafeRawBufferPointer(start: nil, count: 0)) | ||
} | ||
} | ||
|
||
// FIXME: When possible, expand conformance to `where Element : Trivial`. | ||
extension CollectionOfOne : ContiguousBytes where Element == UInt8 { | ||
@inlinable | ||
public func withUnsafeBytes<R>(_ body: (UnsafeRawBufferPointer) throws -> R) rethrows -> R { | ||
let element = self.first! | ||
return try Swift.withUnsafeBytes(of: element) { | ||
return try body($0) | ||
} | ||
} | ||
} | ||
|
||
//===--- Conditional Conformances -----------------------------------------===// | ||
|
||
extension Slice : ContiguousBytes where Base : ContiguousBytes { | ||
public func withUnsafeBytes<ResultType>(_ body: (UnsafeRawBufferPointer) throws -> ResultType) rethrows -> ResultType { | ||
let offset = base.distance(from: base.startIndex, to: self.startIndex) | ||
return try base.withUnsafeBytes { ptr in | ||
let slicePtr = ptr.baseAddress?.advanced(by: offset) | ||
let sliceBuffer = UnsafeRawBufferPointer(start: slicePtr, count: self.count) | ||
return try body(sliceBuffer) | ||
} | ||
} | ||
} |
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.
given this will become ABI and can't be loosened later, are you sure you want to add this? You can use
withContiguousStorageIfAvailable
instead in this case, right?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 don't mind adding it, just thinking you might want to reserve flexibility for yourself)
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.
We cannot use withContiguousStorageIfAvailable because this is being used as a protocol to identify it as a contiguous DataProtocol
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.
@airspeedswift Is this because the conditional conformance produces a symbol name based on the associated type?
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.
@itaiferber Right. And you can only have one conditional conformance. I can envision ABI-stable ways to loosen conditional conformances in the future, but we don't have any right now. cc @DougGregor
@phausler but you have an init from a general sequence of UInt8, and so can have Array follow that path then fast-path into withContiguousStorageIfAvailable, no? Might amount to much the same thing.
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.
@airspeedswift Sure, the conditional conformance limitation I'm aware of. In the future, we're almost certainly going to need an ABI-stable way to loosen these anyway; even if not, we're willing to live with this for now.
We're also not using this just in
init<S : Sequence>
— it's important for general consumers ofDataProtocol
who rely onContiguousBytes
for theassociatedtype
requirement.