Swift标准库源码阅读笔记 - Array和ContiguousArray
关于 ContiguousArray
,这边有喵神的文章介绍的很详细了,可以先看看这个文章。
Array
接着喵神的思路,看一下 Array
以下是从源码中截取的代码片段。
public struct Array<Element>: _DestructorSafeContainer {#if _runtime(_ObjC)internal typealias _Buffer = _ArrayBuffer<Element>#elseinternal typealias _Buffer = _ContiguousArrayBuffer<Element>#endifinternal var _buffer: _Bufferinternal init(_buffer: _Buffer) {self._buffer = _buffer}
}
复制代码
if _runtime(_ObjC)
等价于 #if os(iOS) || os(macOS) || os(tvOS) || os(watchOS)
,从这个操作也可以看出 Swift
的野心不仅仅只是替换 Objective-C
那么简单,而是往更加宽泛的方向发展。由于本次主要是研究在 iOS
下的开发,所以主要看一下 _ArrayBuffer
。
_ArrayBuffer
去掉了注释和与类型检查相关的属性和方法。
internal typealias _ArrayBridgeStorage= _BridgeStorage<_ContiguousArrayStorageBase, _NSArrayCore>internal struct _ArrayBuffer<Element> : _ArrayBufferProtocol {internal init() {_storage = _ArrayBridgeStorage(native: _emptyArrayStorage)}internal var _storage: _ArrayBridgeStorage
}
复制代码
可见 _ArrayBuffer
仅有一个存储属性 _storage
,它的类型 _ArrayBridgeStorage
,本质上是 _BridgeStorage
。
_NSArrayCore
其实是一个协议,定义了一些 NSArray
的方法,主要是为了桥接 Objective-C
的 NSArray
。
最主要的初始化函数,是通过 _emptyArrayStorage
来初始化 _storage
。
实际上 _emptyArrayStorage
是 _EmptyArrayStorage
的实例,主要作用是初始化一个空的数组,并且将内存指定在堆上。
internal var _emptyArrayStorage : _EmptyArrayStorage {return Builtin.bridgeFromRawPointer(Builtin.addressof(&_swiftEmptyArrayStorage))
}
复制代码
_BridgeStorage
struct _BridgeStorage<NativeClass: AnyObject, ObjCClass: AnyObject> {typealias Native = NativeClasstypealias ObjC = ObjCClassinit(native: Native, bits: Int) {rawValue = _makeNativeBridgeObject(native, UInt(bits) << _objectPointerLowSpareBitShift)}init(objC: ObjC) {rawValue = _makeObjCBridgeObject(objC)}init(native: Native) {rawValue = Builtin.reinterpretCast(native)}internal var rawValue: Builtin.BridgeObject
复制代码
_BridgeStorage
实际上区分 是否是 class、@objc
,进而提供不同的存储策略,为上层调用提供了不同的接口,以及类型判断,通过 Builtin.BridgeObject
这个中间参数,实现不同的储存策略。
The ContiguousArray type is a specialized array that always stores its elements in a contiguous region of memory. This contrasts with Array, which can store its elements in either a contiguous region of memory or an NSArray instance if its Element type is a class or @objc protocol.
If your array’s Element type is a class or @objc protocol and you do not need to bridge the array to NSArray or pass the array to Objective-C APIs, using ContiguousArray may be more efficient and have more predictable performance than Array. If the array’s Element type is a struct or enumeration, Array and ContiguousArray should have similar efficiency.
正因为储存策略的不同,特别是在class
或者 @objc
,如果不考虑桥接到 NSArray
或者调用 Objective-C
,苹果建议我们使用 ContiguousArray
,会更有效率。
Array 和 ContiguousArray 区别
通过一些常用的数组操作,来看看两者之间的区别。
append
ContiguousArray
public mutating func append(_ newElement: Element) {_makeUniqueAndReserveCapacityIfNotUnique()let oldCount = _getCount()_reserveCapacityAssumingUniqueBuffer(oldCount: oldCount)_appendElementAssumeUniqueAndCapacity(oldCount, newElement: newElement)}internal mutating func _makeUniqueAndReserveCapacityIfNotUnique() {if _slowPath(!_buffer.isMutableAndUniquelyReferenced()) {_copyToNewBuffer(oldCount: _buffer.count)}}internal mutating func _reserveCapacityAssumingUniqueBuffer(oldCount: Int) {let capacity = _buffer.capacity == 0if _slowPath(oldCount + 1 > _buffer.capacity) {_copyToNewBuffer(oldCount: oldCount)}}internal mutating func _copyToNewBuffer(oldCount: Int) {let newCount = oldCount + 1var newBuffer = _buffer._forceCreateUniqueMutableBuffer(countForNewBuffer: oldCount, minNewCapacity: newCount)_buffer._arrayOutOfPlaceUpdate(&newBuffer, oldCount, 0, _IgnorePointer())}internal mutating func _appendElementAssumeUniqueAndCapacity(_ oldCount: Int,newElement: Element) {_buffer.count = oldCount + 1(_buffer.firstElementAddress + oldCount).initialize(to: newElement)}
复制代码
_makeUniqueAndReserveCapacityIfNotUnique()
检查数组是否是唯一持有者,以及是否是可变数组。
_reserveCapacityAssumingUniqueBuffer(oldCount: oldCount)
检查数组内的元素个数加一后,是否超出超过所分配的空间。
前两个方法在检查之后都调用了 _copyToNewBuffer
,主要操作是如果当前数组需要申请空间,则申请空间,然后再复制 buffer
。
_appendElementAssumeUniqueAndCapacity(oldCount, newElement: newElement)
从首地址后的第 oldCount
个存储空间内,初始化 newElement
。
Array
Array
实现的过程与 ContiguousArray
差不多,但是还是有一些区别,具体看看,主要的区别存在于_ContiguousArrayBuffer
和 _ArrayBuffer
_ContiguousArrayBuffer
internal var firstElementAddress: UnsafeMutablePointer<Element> {return UnsafeMutablePointer(Builtin.projectTailElems(_storage,Element.self))
}
复制代码
直接返回了内存地址。
_ArrayBuffer
internal var firstElementAddress: UnsafeMutablePointer<Element> {_sanityCheck(_isNative, "must be a native buffer")return _native.firstElementAddress}internal var _native: NativeBuffer {return NativeBuffer(_isClassOrObjCExistential(Element.self)? _storage.nativeInstance : _storage.nativeInstance_noSpareBits)}internal typealias NativeBuffer = _ContiguousArrayBuffer<Element>
复制代码
从调用的情况来看,本质上还是调用了 _ContiguousArrayBuffer
的firstElementAddress
但是在创建时,会有类型检查。
_isClassOrObjCExistential(Element.self)
检查是否是类或者@objc
修饰的。
在上述中检查持有者是否唯一和数组是否可变的函数中, 其实是调用了 _buffer
内部的 isMutableAndUniquelyReferenced()
。
_ContiguousArrayBuffer
@inlinableinternal mutating func isUniquelyReferenced() -> Bool {return _isUnique(&_storage)}
复制代码
internal func _isUnique<T>(_ object: inout T) -> Bool {return Bool(Builtin.isUnique(&object))
}
复制代码
最后调用的 Builtin
中的 isUnique
。
_ArrayBuffer
internal mutating func isUniquelyReferenced() -> Bool {if !_isClassOrObjCExistential(Element.self) {return _storage.isUniquelyReferenced_native_noSpareBits()}if !_storage.isUniquelyReferencedNative() {return false}return _isNative}mutating func isUniquelyReferencedNative() -> Bool {return _isUnique(&rawValue)}mutating func isUniquelyReferenced_native_noSpareBits() -> Bool {_sanityCheck(isNative)return _isUnique_native(&rawValue)}func _isUnique_native<T>(_ object: inout T) -> Bool {_sanityCheck((_bitPattern(Builtin.reinterpretCast(object)) & _objectPointerSpareBits)== 0)_sanityCheck(_usesNativeSwiftReferenceCounting(type(of: Builtin.reinterpretCast(object) as AnyObject)))return Bool(Builtin.isUnique_native(&object))
}
复制代码
如果是 class 或者 @objc
和 _ContiguousBuffer
一样。如果不是则需要调用 Builtin
中的 _isUnique_native
,即要检查是否唯一,还要检查是否是 Swift
原生 而不是 NSArray
。 相对于 _ContiguousArrayBuffer
由于 _ArrayBuffer
承载了需要桥接到 NSArray
的功能,所以多了一些类型检查的操作。
insert
ContiguousArray
//ContiguousArraypublic mutating func insert(_ newElement: Element, at i: Int) {_checkIndex(i)self.replaceSubrange(i..<i, with: CollectionOfOne(newElement))}public mutating func replaceSubrange<C>(_ subrange: Range<Int>,with newElements: C) where C : Collection, C.Element == Element {let oldCount = _buffer.countlet eraseCount = subrange.countlet insertCount = newElements.countlet growth = insertCount - eraseCountif _buffer.requestUniqueMutableBackingBuffer(minimumCapacity: oldCount + growth) != nil {_buffer.replaceSubrange(subrange, with: insertCount, elementsOf: newElements)} else {_buffer._arrayOutOfPlaceReplace(subrange, with: newElements, count: insertCount)}}internal mutating func requestUniqueMutableBackingBuffer(minimumCapacity: Int) -> _ContiguousArrayBuffer<Element>? {if _fastPath(isUniquelyReferenced() && capacity >= minimumCapacity) {return self}return nil}//extension ArrayProtocolinternal mutating func replaceSubrange<C>(_ subrange: Range<Int>,with newCount: Int,elementsOf newValues: C) where C : Collection, C.Element == Element {_sanityCheck(startIndex == 0, "_SliceBuffer should override this function.")let oldCount = self.count //现有数组大小let eraseCount = subrange.count //需要替换大小let growth = newCount - eraseCount //目标大小 和 需要替换大小 的差值self.count = oldCount + growth //替换后的数组大小let elements = self.subscriptBaseAddress //数组首地址。let oldTailIndex = subrange.upperBound let oldTailStart = elements + oldTailIndex //需要替换的尾地址。let newTailIndex = oldTailIndex + growth //需要增加的空间的尾下标let newTailStart = oldTailStart + growth //需要增加的空间的尾地址let tailCount = oldCount - subrange.upperBound //需要移动的内存空间大小if growth > 0 {var i = newValues.startIndexfor j in subrange {elements[j] = newValues[i]newValues.formIndex(after: &i)}for j in oldTailIndex..<newTailIndex {(elements + j).initialize(to: newValues[i])newValues.formIndex(after: &i)}_expectEnd(of: newValues, is: i)}else { var i = subrange.lowerBoundvar j = newValues.startIndexfor _ in 0..<newCount {elements[i] = newValues[j]i += 1newValues.formIndex(after: &j)}_expectEnd(of: newValues, is: j)if growth == 0 {return}let shrinkage = -growthif tailCount > shrinkage { newTailStart.moveAssign(from: oldTailStart, count: shrinkage)oldTailStart.moveInitialize(from: oldTailStart + shrinkage, count: tailCount - shrinkage)}else { newTailStart.moveAssign(from: oldTailStart, count: tailCount)(newTailStart + tailCount).deinitialize(count: shrinkage - tailCount)}}}复制代码
insert
内部实际是 调用了 replaceSubrange
。 而在 replaceSubrange
的操作是,判断内存空间是否够用,和持有者是否唯一,如果有一个不满足条件则复制 buffer
到新的内存空间,并且根据需求分配好内存空间大小。
而 _buffer
内部的 replaceSubrange
:
- 计算
growth
值看所替换的大小和目标大小差值是多少。 - 如果
growth > 0
,则需要将现有的内存空间向后移动growth
位。 - 替换所需要替换的值。
- 超出的部分重新分配内存并初始化值。
- 如果
growth <= 0
,则将现有的值替换成新的值即可。 - 如果
growth < 0
,则将不需要的内存空间回收即可。(ps:删除多个元素或者需要替换的大小大于目标大小)。
Array insert
两者基本一致,唯一的区别和 append
一样在 在buffer
的内部方法,isUniquelyReferenced()
中,多了一些类型检查。
remove
ContiguousArray
public mutating func remove(at index: Int) -> Element {_makeUniqueAndReserveCapacityIfNotUnique()let newCount = _getCount() - 1let pointer = (_buffer.firstElementAddress + index)let result = pointer.move()pointer.moveInitialize(from: pointer + 1, count: newCount - index)_buffer.count = newCountreturn result}
复制代码
检查数组持有者是否唯一,取出所要删除的内存地址,通过将当前的内存区域覆盖为一个未初始化的内存空间,以达到回收内存空间的作用,进而达到删除数组元素的作用。
Array
与 ContiguousArray
的区别就在于 _makeUniqueAndReserveCapacityIfNotUnique()
前面已经提到过,仍然是多了一些类型检查。
subscript
ContiguousArray
//ContiguousArray
public subscript(index: Int) -> Element {get {let wasNativeTypeChecked = _hoistableIsNativeTypeChecked()let token = _checkSubscript(index, wasNativeTypeChecked: wasNativeTypeChecked)return _getElement(index, wasNativeTypeChecked: wasNativeTypeChecked,matchingSubscriptCheck: token)}}publicfunc _getElement(_ index: Int,wasNativeTypeChecked : Bool,matchingSubscriptCheck: _DependenceToken) -> Element {#if falsereturn _buffer.getElement(index, wasNativeTypeChecked: wasNativeTypeChecked)#elsereturn _buffer.getElement(index)#endif}//ContiguousArrayBufferinternal func getElement(_ i: Int) -> Element {return firstElementAddress[i]}
复制代码
_hoistableIsNativeTypeChecked()
不做任何检查,直接返回 true
。 _checkSubscript(index, wasNativeTypeChecked: wasNativeTypeChecked)
检查 index
是否越界。 _getElement
最终还是操作内存,通过 firstElementAddress
偏移量取出值。
Array
//Arraypublicfunc _checkSubscript(_ index: Int, wasNativeTypeChecked: Bool) -> _DependenceToken {
#if _runtime(_ObjC)_buffer._checkInoutAndNativeTypeCheckedBounds(index, wasNativeTypeChecked: wasNativeTypeChecked)
#else_buffer._checkValidSubscript(index)
#endifreturn _DependenceToken()}func _hoistableIsNativeTypeChecked() -> Bool {return _buffer.arrayPropertyIsNativeTypeChecked}//ArrayBufferinternal var arrayPropertyIsNativeTypeChecked: Bool {return _hasNativeBuffer}internal var _isNativeTypeChecked: Bool {if !_isClassOrObjCExistential(Element.self) {return true} else {return _storage.isNativeWithClearedSpareBits(deferredTypeCheckMask)}}
复制代码
在 ContiguousArray
中 _hoistableIsNativeTypeChecked()
直接返回 true
, 而 Array
中如果不是 class 或者 @objc
会返回 ture
,否则会检查是否可以桥接到 Swift
。
而在 Array
中 _checkSubscript
调用的 _buffer
内部函数也不一样,下面来具体看一看内部实现。
//ArrayBufferinternal func _checkInoutAndNativeTypeCheckedBounds(_ index: Int, wasNativeTypeChecked: Bool) {_precondition(_isNativeTypeChecked == wasNativeTypeChecked,"inout rules were violated: the array was overwritten")if _fastPath(wasNativeTypeChecked) {_native._checkValidSubscript(index)}}//ContiguousArrayBufferinternal func _checkValidSubscript(_ index : Int) {_precondition((index >= 0) && (index < count),"Index out of range")}
复制代码
本质上就是多了一些是否是类型检查。
//Array
func _getElement(_ index: Int,wasNativeTypeChecked : Bool,matchingSubscriptCheck: _DependenceToken) -> Element {
#if _runtime(_ObjC)return _buffer.getElement(index, wasNativeTypeChecked: wasNativeTypeChecked)
#elsereturn _buffer.getElement(index)
#endif}//ArrayBuffer
internal func getElement(_ i: Int, wasNativeTypeChecked: Bool) -> Element {if _fastPath(wasNativeTypeChecked) {return _nativeTypeChecked[i]}return unsafeBitCast(_getElementSlowPath(i), to: Element.self)}internal func _getElementSlowPath(_ i: Int) -> AnyObject {let element: AnyObjectif _isNative {_native._checkValidSubscript(i)element = cast(toBufferOf: AnyObject.self)._native[i]} else {element = _nonNative.objectAt(i)}return element}//ContiguousArrayBufferinternal subscript(i: Int) -> Element {get {return getElement(i)}}
复制代码
在 _buffer
内部的 getElement
, 与 ContiguousArray
不同的是需要适配桥接到 NSArray
的情况,如果是 非NSArray
的情况调用的是 ContiguousArrayBuffer
内部的 subscript
,和 ContiguousArray
相同。
总结
从增删改查来看,不管是 ContiguousArray
还是 Array
最终都是操作内存,稍显区别的就是 Array
需要更多的类型检查。所以当不需要 Objective-C
,还是尽量使用 ContiguousArray
。 下面是对数组中一些批量操作的总结:
removeAll
、insert<C>(contentsOf: C, at: Int)
、removeSubrange
:最终调用的是replaceSubrange
append<S : Sequence>(contentsOf newElements: S)
和init(repeating repeatedValue: Element, count: Int)
:最终都是操作内存,循环初始化新的内存空间和值。
有什么不正确的地方,欢迎指出。
Swift标准库源码阅读笔记 - Array和ContiguousArray相关推荐
- pytorch下的lib库 源码阅读笔记(1)
置顶:将pytorch clone到本地,查看initial commit,已经是麻雀虽小五脏俱全了,非常适合作为学习模板. 2017年12月7日01:24:15 2017-10-25 17:51 参 ...
- Swift 标准库源码 第三方,Almofire,Kingfisher,SwiftyJson,KakaJson,单元测试 request
?? 两个optional比较会包装成等?的类型,再进行比较 json 反射 request 开发工具
- 代码分析:NASM源码阅读笔记
NASM源码阅读笔记 NASM(Netwide Assembler)的使用文档和代码间的注释相当齐全,这给阅读源码 提供了很大的方便.按作者的说法,这是一个模块化的,可重用的x86汇编器, 而且能够被 ...
- dgl源码阅读笔记(3)——DeepWalk
dgl源码阅读笔记(3)--DeepWalk 图神经网络开源库dgl阅读笔记 文章目录 dgl源码阅读笔记(3)--DeepWalk 图神经网络开源库dgl阅读笔记 @[TOC](文章目录) 前言 一 ...
- syzkaller 源码阅读笔记1(syz-extract syz-sysgen)
文章目录 1. syz-extract 1-0 总结 1-1. `main()` 1-2 `archList()` - `1-1 (3)` 获取架构 name list 1-3 `createArch ...
- CI框架源码阅读笔记4 引导文件CodeIgniter.php
到了这里,终于进入CI框架的核心了.既然是"引导"文件,那么就是对用户的请求.参数等做相应的导向,让用户请求和数据流按照正确的线路各就各位.例如,用户的请求url: http:// ...
- Yii源码阅读笔记 - 日志组件
2015-03-09 一 By youngsterxyf 使用 Yii框架为开发者提供两个静态方法进行日志记录: Yii::log($message, $level, $category); Yii: ...
- 【Flink】Flink 源码阅读笔记(15)- Flink SQL 整体执行框架
1.概述 转载:Flink 源码阅读笔记(15)- Flink SQL 整体执行框架 在数据处理领域,无论是实时数据处理还是离线数据处理,使用 SQL 简化开发将会是未来的整体发展趋势.尽管 SQL ...
- HashMap源码阅读笔记
HashMap是Java编程中常用的集合框架之一. 利用idea得到的类的继承关系图可以发现,HashMap继承了抽象类AbstractMap,并实现了Map接口(对于Serializable和Clo ...
最新文章
- eclipse运行程序时只有run on server
- MATLAB二维图形坐标变换
- mysql查询时强制区分大小写
- cocos2dx的图片载入
- 设置域名_如何设置二级域名解析?有什么设置方法?
- 染色(树链剖分 洛谷-P2486)
- 蚂蚁金服:超大规模分布式计算系统 + 超大规模分布式优化算法
- 20191104_1_相关性分析
- 文件拖拽操作增强工具Dropzone 4 for Mac---提高工作效率
- [转]C#.NET中动态添加与删除控件
- 虚拟IP,地址漂移,双机热备
- dsp gpip操作 data set 和clc
- springboot整合logback日志
- 再谈单调队列优化 背包九讲
- 为什么编程是独一无二的职业
- windows检查磁盘命令
- 和程序员薪酬差不多的工作
- 文献翻译:Comparative metagenomics of hydrocarbon and methane seeps of the Gulf of Mexico
- BugMeNot:查找和共享登录名(一个神奇的网站)
- 成为一名程序员的开始