Skip to content

[stdlib] Set, Dictionary: Resilient Cocoa indices, vol 2 #19612

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.

Sign up for GitHub

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
merged 5 commits into from
Sep 29, 2018
Merged

[stdlib] Set, Dictionary: Resilient Cocoa indices, vol 2 #19612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
41bedbe
[stdlib] Set, Dictionary: Remove inappropriate @_effects from Index h…
lorentey Sep 28, 2018
15f4b91
[stdlib] Set, Dictionary: Hide Cocoa index storage classes
lorentey Sep 28, 2018
526162f
[stdlib] Set, Dictionary: Fix uniqueness checking for Cocoa indices
lorentey Sep 29, 2018
1529d37
[stdlib] Implement formIndex(after:) in all hashed collections
lorentey Sep 29, 2018
df73981
[stdlib] Set, Dictionary: Remove bad @_effects attribute
lorentey Sep 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 45 additions & 9 deletions stdlib/public/core/Dictionary.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,11 @@ extension Dictionary: Collection {
return _variant.index(after: i)
}

@inlinable
public func formIndex(after i: inout Index) {
_variant.formIndex(after: &i)
}

/// Returns the index for the given key.
///
/// If the given key is found in the dictionary, this method returns an index
Expand Down Expand Up @@ -1350,6 +1355,11 @@ extension Dictionary {
return _variant.index(after: i)
}

@inlinable
public func formIndex(after i: inout Index) {
_variant.formIndex(after: &i)
}

@inlinable
public subscript(position: Index) -> Element {
return _variant.key(at: position)
Expand Down Expand Up @@ -1456,6 +1466,11 @@ extension Dictionary {
return _variant.index(after: i)
}

@inlinable
public func formIndex(after i: inout Index) {
_variant.formIndex(after: &i)
}

@inlinable
public subscript(position: Index) -> Element {
// FIXME(accessors): Provide a _read
Expand Down Expand Up @@ -1827,6 +1842,14 @@ extension Dictionary.Index {
_conditionallyUnreachable()
}
}

@inlinable
@inline(__always)
internal mutating func _isUniquelyReferenced() -> Bool {
defer { _fixLifetime(self) }
var handle = _asCocoa.handleBitPattern
return handle == 0 || _isUnique_native(&handle)
}
#endif

@usableFromInline @_transparent
Expand All @@ -1843,14 +1866,27 @@ extension Dictionary.Index {
}

#if _runtime(_ObjC)
@usableFromInline @_transparent
@usableFromInline
internal var _asCocoa: _CocoaDictionary.Index {
switch _variant {
case .native:
_preconditionFailure(
"Attempting to access Dictionary elements using an invalid index")
case .cocoa(let cocoaIndex):
return cocoaIndex
@_transparent
get {
switch _variant {
case .native:
_preconditionFailure(
"Attempting to access Dictionary elements using an invalid index")
case .cocoa(let cocoaIndex):
return cocoaIndex
}
}
_modify {
guard case .cocoa(var cocoa) = _variant else {
_preconditionFailure(
"Attempting to access Dictionary elements using an invalid index")
}
let dummy = _HashTable.Index(bucket: _HashTable.Bucket(offset: 0), age: 0)
_variant = .native(dummy)
yield &cocoa
_variant = .cocoa(cocoa)
}
}
#endif
Expand Down Expand Up @@ -1897,8 +1933,8 @@ extension Dictionary.Index: Comparable {
}

extension Dictionary.Index: Hashable {
@_effects(readonly) // FIXME(cocoa-index): Make inlinable
public func hash(into hasher: inout Hasher) {
public // FIXME(cocoa-index): Make inlinable
func hash(into hasher: inout Hasher) {
#if _runtime(_ObjC)
switch _variant {
case .native(let nativeIndex):
Expand Down
51 changes: 36 additions & 15 deletions stdlib/public/core/DictionaryBridging.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,8 +471,8 @@ extension _CocoaDictionary: _DictionaryBuffer {
@usableFromInline // FIXME(cocoa-index): Should be inlinable
@_effects(releasenone)
internal func index(after index: Index) -> Index {
var result = index
formIndex(after: &result)
var result = index.copy()
formIndex(after: &result, isUnique: true)
return result
}

Expand All @@ -483,11 +483,9 @@ extension _CocoaDictionary: _DictionaryBuffer {
}

@usableFromInline // FIXME(cocoa-index): Should be inlinable
@_effects(releasenone)
internal func formIndex(after index: inout Index) {
internal func formIndex(after index: inout Index, isUnique: Bool) {
validate(index)
let isUnique = index.isUniquelyReferenced()
if !isUnique { index.storage = index.copy() }
if !isUnique { index = index.copy() }
let storage = index.storage // FIXME: rdar://problem/44863751
storage.currentKeyIndex += 1
}
Expand Down Expand Up @@ -575,17 +573,34 @@ extension _CocoaDictionary {
@usableFromInline
internal struct Index {
@usableFromInline
internal var storage: Storage
internal var _object: Builtin.BridgeObject
@usableFromInline
internal var _storage: Builtin.BridgeObject

internal var object: AnyObject {
@inline(__always)
get {
return _bridgeObject(toNonTaggedObjC: _object)
}
}

internal var storage: Storage {
@inline(__always)
get {
let storage = _bridgeObject(toNative: _storage)
return unsafeDowncast(storage, to: Storage.self)
}
}

internal init(_ storage: Storage) {
self.storage = storage
self._object = _bridgeObject(fromNonTaggedObjC: storage.base.object)
self._storage = _bridgeObject(fromNative: storage)
}
}
}

extension _CocoaDictionary.Index {
// FIXME(cocoa-index): Try using an NSEnumerator to speed this up.
@usableFromInline
internal class Storage {
// Assumption: we rely on NSDictionary.getObjects when being
// repeatedly called on the same NSDictionary, returning items in the same
Expand Down Expand Up @@ -618,15 +633,21 @@ extension _CocoaDictionary.Index {
}

extension _CocoaDictionary.Index {
@inlinable
internal mutating func isUniquelyReferenced() -> Bool {
return _isUnique_native(&storage)
@usableFromInline
internal var handleBitPattern: UInt {
@_effects(readonly)
get {
return unsafeBitCast(storage, to: UInt.self)
}
}

@usableFromInline
internal mutating func copy() -> Storage {
internal func copy() -> _CocoaDictionary.Index {
let storage = self.storage
return Storage(storage.base, storage.allKeys, storage.currentKeyIndex)
return _CocoaDictionary.Index(Storage(
storage.base,
storage.allKeys,
storage.currentKeyIndex))
}
}

Expand All @@ -647,7 +668,7 @@ extension _CocoaDictionary.Index {
internal var age: Int32 {
@_effects(readonly)
get {
return _HashTable.age(for: storage.base.object)
return _HashTable.age(for: object)
}
}
}
Expand Down
14 changes: 14 additions & 0 deletions stdlib/public/core/DictionaryVariant.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,20 @@ extension Dictionary._Variant: _DictionaryBuffer {
}
}

@inlinable
internal func formIndex(after index: inout Index) {
switch self {
case .native(let native):
index = native.index(after: index)
#if _runtime(_ObjC)
case .cocoa(let cocoa):
cocoaPath()
let isUnique = index._isUniquelyReferenced()
cocoa.formIndex(after: &index._asCocoa, isUnique: isUnique)
#endif
}
}

@inlinable
@inline(__always)
internal func index(forKey key: Key) -> Index? {
Expand Down
44 changes: 35 additions & 9 deletions stdlib/public/core/Set.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,11 @@ extension Set: Collection {
return _variant.index(after: i)
}

@inlinable
public func formIndex(after i: inout Index) {
_variant.formIndex(after: &i)
}

// APINAMING: complexity docs are broadly missing in this file.

/// Returns the index of the given element in the set, or `nil` if the
Expand Down Expand Up @@ -1343,6 +1348,14 @@ extension Set.Index {
_conditionallyUnreachable()
}
}

@inlinable
@inline(__always)
internal mutating func _isUniquelyReferenced() -> Bool {
defer { _fixLifetime(self) }
var handle = _asCocoa.handleBitPattern
return handle == 0 || _isUnique_native(&handle)
}
#endif

@usableFromInline @_transparent
Expand All @@ -1359,14 +1372,27 @@ extension Set.Index {
}

#if _runtime(_ObjC)
@usableFromInline @_transparent
@usableFromInline
internal var _asCocoa: _CocoaSet.Index {
switch _variant {
case .native:
_preconditionFailure(
"Attempting to access Set elements using an invalid index")
case .cocoa(let cocoaIndex):
return cocoaIndex
@_transparent
get {
switch _variant {
case .native:
_preconditionFailure(
"Attempting to access Set elements using an invalid index")
case .cocoa(let cocoaIndex):
return cocoaIndex
}
}
_modify {
guard case .cocoa(var cocoa) = _variant else {
_preconditionFailure(
"Attempting to access Set elements using an invalid index")
}
let dummy = _HashTable.Index(bucket: _HashTable.Bucket(offset: 0), age: 0)
_variant = .native(dummy)
yield &cocoa
_variant = .cocoa(cocoa)
}
}
#endif
Expand Down Expand Up @@ -1418,8 +1444,8 @@ extension Set.Index: Hashable {
///
/// - Parameter hasher: The hasher to use when combining the components
/// of this instance.
@_effects(readonly) // FIXME(cocoa-index): Make inlinable
public func hash(into hasher: inout Hasher) {
public // FIXME(cocoa-index): Make inlinable
func hash(into hasher: inout Hasher) {
#if _runtime(_ObjC)
switch _variant {
case .native(let nativeIndex):
Expand Down
52 changes: 36 additions & 16 deletions stdlib/public/core/SetBridging.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,8 +345,8 @@ extension _CocoaSet: _SetBuffer {
@usableFromInline // FIXME(cocoa-index): Should be inlinable
@_effects(releasenone)
internal func index(after index: Index) -> Index {
var result = index
formIndex(after: &result)
var result = index.copy()
formIndex(after: &result, isUnique: true)
return result
}

Expand All @@ -358,11 +358,9 @@ extension _CocoaSet: _SetBuffer {
}

@usableFromInline // FIXME(cocoa-index): Should be inlinable
@_effects(releasenone)
internal func formIndex(after index: inout Index) {
internal func formIndex(after index: inout Index, isUnique: Bool) {
validate(index)
let isUnique = index.isUniquelyReferenced()
if !isUnique { index.storage = index.copy() }
if !isUnique { index = index.copy() }
let storage = index.storage // FIXME: rdar://problem/44863751
storage.currentKeyIndex += 1
}
Expand Down Expand Up @@ -412,17 +410,34 @@ extension _CocoaSet {
@usableFromInline
internal struct Index {
@usableFromInline
internal var storage: Storage
internal var _object: Builtin.BridgeObject
@usableFromInline
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these need to be usableFromInline anymore, do they?

(Though if you do remove it, please do it in a follow-up. We need to get those optimize-test bots back sooner rather than later.)

internal var _storage: Builtin.BridgeObject

internal var object: AnyObject {
@inline(__always)
get {
return _bridgeObject(toNonTaggedObjC: _object)
}
}

internal var storage: Storage {
@inline(__always)
get {
let storage = _bridgeObject(toNative: _storage)
return unsafeDowncast(storage, to: Storage.self)
}
}

internal init(_ storage: __owned Storage) {
self.storage = storage
self._object = _bridgeObject(fromNonTaggedObjC: storage.base.object)
self._storage = _bridgeObject(fromNative: storage)
}
}
}

extension _CocoaSet.Index {
// FIXME(cocoa-index): Try using an NSEnumerator to speed this up.
@usableFromInline
internal class Storage {
// Assumption: we rely on NSDictionary.getObjects when being
// repeatedly called on the same NSDictionary, returning items in the same
Expand Down Expand Up @@ -455,15 +470,20 @@ extension _CocoaSet.Index {
}

extension _CocoaSet.Index {
@inlinable
internal mutating func isUniquelyReferenced() -> Bool {
return _isUnique_native(&storage)
@usableFromInline
internal var handleBitPattern: UInt {
@_effects(readonly)
get {
return unsafeBitCast(storage, to: UInt.self)
}
}

@usableFromInline
internal mutating func copy() -> Storage {
internal func copy() -> _CocoaSet.Index {
let storage = self.storage
return Storage(storage.base, storage.allKeys, storage.currentKeyIndex)
return _CocoaSet.Index(Storage(
storage.base,
storage.allKeys,
storage.currentKeyIndex))
}
}

Expand All @@ -484,7 +504,7 @@ extension _CocoaSet.Index {
internal var age: Int32 {
@_effects(releasenone)
get {
return _HashTable.age(for: storage.base.object)
return _HashTable.age(for: object)
}
}
}
Expand Down
Loading