【iOS】weak底层实现

╰+哭是因爲堅強的太久メ 2022-05-15 08:19 144阅读 0赞

### weak基本用法 ###

weak是弱引用，用weak描述修饰或者所引用对象的计数器不会加一，并且会在引用的对象被释放的时候自动被设置为nil，大大避免了野指针访问坏内存引起崩溃的情况，另外weak还可以用于解决循环引用。

### weak原理概括 ###

weak表其实是一个hash（哈希）表，Key是所指对象的地址，Value是weak指针的地址数组。weak的底层实现的原理是什么？

Runtime维护了一个weak表，用于存储指向某个对象的所有weak指针。weak表其实是一个hash表，Key是所指对象的地址，value是weak指针的地址（这个地址的值是所指对象指针的地址）数组。 **为什么value是数组？因为一个对象可能被多个弱引用指针指向**

### weak原理实现步骤 ###

weak 的实现原理可概括三步：

> 1、初始化时：runtime会调用objc\_initWeak函数，初始化一个新的weak指针指向对象的地址。 ![初始化流程图][1240]
> 
> 2、添加引用时：objc\_initWeak函数会调用 objc\_storeWeak() 函数， objc\_storeWeak() 的作用是更新指针指向，创建对应的弱引用表。

![更新指针，创建弱引用表][1240 1]

> 3、释放时，调用clearDeallocating函数。clearDeallocating函数首先根据对象地址获取所有weak指针地址的数组，然后遍历这个数组把其中的数据设为nil，最后把这个entry从weak表中删除，最后清理对象的记录。

### weak实现三步骤详细过程： ###

1、初始化时：runtime会调用objc\_initWeak函数，objc\_initWeak函数会初始化一个新的weak指针指向对象的地址。

示例代码：

当我们初始化一个weak变量时，runtime会调用 NSObject.mm 中的objc\_initWeak函数。

这个函数在Clang中的声明如下： `id objc_initWeak(id *object, id value);`

而对于 objc\_initWeak() 方法的实现如下：

这里先判断了其指针指向的类对象是否有效，无效直接释放返回，不再往深层调用函数。否则，object将通过bjc\_storeWeak函数被注册为一个指向value的\_\_weak对象。

*注意：objc\_initWeak函数有一个前提条件：就是object必须是一个没有被注册为\_\_weak对象的有效指针。而value则可以是null，或者指向一个有效的对象。*

2、添加引用时：objc\_initWeak函数会调用 objc\_storeWeak() 函数， objc\_storeWeak() 的作用是更新指针指向，创建对应的弱引用表。

objc\_storeWeak的函数声明如下：

`id objc_storeWeak(id *location, id value);`

objc\_storeWeak() 的具体实现,这里的实现很复杂，没看懂，没看懂。

3、释放时，调用clearDeallocating函数。clearDeallocating函数首先根据对象地址获取所有weak指针地址的数组，然后遍历这个数组把其中的数据设为nil，最后把这个entry从weak表中删除，最后清理对象的记录。

> 当weak引用指向的对象被释放时，又是如何去处理weak指针的呢？当释放对象时，其基本流程如下：

1、调用objc\_release 2、因为对象的引用计数为0，所以执行dealloc 3、在dealloc中，调用了\_objc\_rootDealloc函数 4、在\_objc\_rootDealloc中，调用了object\_dispose函数 5、调用objc\_destructInstance 6、最后调用objc\_clear\_deallocating,详细过程如下： a. 从weak表中获取废弃对象的地址为键值的记录 b. 将包含在记录中的所有附有 weak修饰符变量的地址，赋值为 nil c. 将weak表中该记录删除 d. 从引用计数表中删除废弃对象的地址为键值的记录 \_\_

### 拓展补充 ###

### weak，\_\_unsafe\_unretained, unowned 与 assign区别 ###

*  \_\_unsafe\_unretained: 不会对对象进行retain,当对象销毁时,会依然指向之前的内存空间(野指针)
 *  weak: 不会对对象进行retain,当对象销毁时,会自动指向nil
 *  assign: 实质与\_\_unsafe\_unretained等同
 *  unsafe\_unretained也可以修饰代表简单数据类型的property，weak也不能修饰用来代表简单数据类型的property。
 *  **unsafe\_unretained 与 weak 比较，使用 weak 是有代价的，因为通过上面的原理可知，weak需要检查对象是否已经消亡，而为了知道是否已经消亡，自然也需要一些信息去跟踪对象的使用情况。也正因此，unsafe\_unretained 比 **weak快,所以当明确知道对象的生命期时，选择**unsafe\_unretained 会有一些性能提升，这种性能提升是很微小的。但当很清楚的情况下，\_\_unsafe\_unretained 也是安全的，自然能快一点是一点。而当情况不确定的时候，应该优先选用 **weak 。
 *  unowned使用在Swift中，也会分 weak 和 unowned。unowned 的含义跟 \_\_unsafe\_unretained 差不多。假如很明确的知道对象的生命期，也可以选择 unowned。

对于 runtime 的分析还有很长的路，最近在写 block 系列的同时，也回顾一下之前疏漏的细节知识。这篇文章是关于 weak 的具体实现的学习笔记。

## runtime 对 \_\_weak 弱引用处理方式 ##

切入主题，这里笔者使用的 runtime 版本为 [objc4-680.tar.gz][]。 我在入口文件 main.m 中加入如下代码：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> int main(int argc, const char * argv[]) { &nbsp;&nbsp;&nbsp;&nbsp;@autoreleasepool { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// insert code here... &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;NSObject *p = [[NSObject alloc] init]; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;__weak NSObject *p1 = p; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;return 0; } </td> 
 </tr> 
 </tbody> 
</table>

单步运行，发现会跳入 `NSObject.mm` 中的 `objc_initWeak()` 这个方法。在进行编译过程前，clang 其实对 \_\_weak 做了转换，将声明方式做出了如下调整。

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> NSObject objc_initWeak(&amp;p, 对象指针); </td> 
 </tr> 
 </tbody> 
</table>

其中的对象指针，就是代码中的 `[[NSObject alloc] init]` ，而 p 是我们传入的一个弱引用指针。而对于 `objc_initWeak()` 方法的实现，在 runtime 中的源码如下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> id objc_initWeak(id *location, id newObj) { // 查看对象实例是否有效 // 无效对象直接导致指针释放 &nbsp;&nbsp;&nbsp;&nbsp;if (!newObj) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*location = nil; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return nil; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;// 这里传递了三个 bool 数值 &nbsp;&nbsp;&nbsp;&nbsp;// 使用 template 进行常量参数传递是为了优化性能 &nbsp;&nbsp;&nbsp;&nbsp;return storeWeakfalse/*old*/, true/*new*/, true/*crash*/&gt; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(location, (objc_object*)newObj); } </td> 
 </tr> 
 </tbody> 
</table>

可以看出，这个函数仅仅是一个深层函数的调用入口，而一般的入口函数中，都会做一些简单的判断（例如 objc\_msgSend 中的缓存判断），这里判断了其指针指向的类对象是否有效，无效直接释放，不再往深层调用函数。

需要注意的是，当修改弱引用的变量时，这个方法非线程安全。所以切记选择竞争带来的一些问题。

继续阅读 `objc_storeWeak()` 的实现：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 </td> 
 <td> // HaveOld: true - 变量有值 // false - 需要被及时清理，当前值可能为 nil // HaveNew: true - 需要被分配的新值，当前值可能为 nil // false - 不需要分配新值 // CrashIfDeallocating: true - 说明 newObj 已经释放或者 newObj 不支持弱引用，该过程需要暂停 // false - 用 nil 替代存储 template bool HaveOld, bool HaveNew, bool CrashIfDeallocating&gt; static id storeWeak(id *location, objc_object *newObj) { // 该过程用来更新弱引用指针的指向 // 初始化 previouslyInitializedClass 指针 &nbsp;&nbsp;&nbsp;&nbsp;Class previouslyInitializedClass = nil; &nbsp;&nbsp;&nbsp;&nbsp;id oldObj; &nbsp;&nbsp;&nbsp;&nbsp;// 声明两个 SideTable &nbsp;&nbsp;&nbsp;&nbsp;// ① 新旧散列创建 &nbsp;&nbsp;&nbsp;&nbsp;SideTable *oldTable; &nbsp;&nbsp;&nbsp;&nbsp;SideTable *newTable; // 获得新值和旧值的锁存位置（用地址作为唯一标示） // 通过地址来建立索引标志，防止桶重复 // 下面指向的操作会改变旧值 &nbsp;&nbsp;retry: &nbsp;&nbsp;&nbsp;&nbsp;if (HaveOld) { &nbsp;&nbsp;&nbsp;&nbsp; // 更改指针，获得以 oldObj 为索引所存储的值地址 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;oldObj = *location; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;oldTable = &amp;SideTables()[oldObj]; &nbsp;&nbsp;&nbsp;&nbsp;} else { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;oldTable = nil; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;if (HaveNew) { &nbsp;&nbsp;&nbsp;&nbsp; // 更改新值指针，获得以 newObj 为索引所存储的值地址 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;newTable = &amp;SideTables()[newObj]; &nbsp;&nbsp;&nbsp;&nbsp;} else { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;newTable = nil; &nbsp;&nbsp;&nbsp;&nbsp;} // 加锁操作，防止多线程中竞争冲突 &nbsp;&nbsp;&nbsp;&nbsp;SideTable::lockTwoHaveOld, HaveNew&gt;(oldTable, newTable); // 避免线程冲突重处理 // location 应该与 oldObj 保持一致，如果不同，说明当前的 location 已经处理过 oldObj 可是又被其他线程所修改 &nbsp;&nbsp;&nbsp;&nbsp;if (HaveOld&nbsp;&nbsp;&amp;&amp;&nbsp;&nbsp;*location != oldObj) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;SideTable::unlockTwoHaveOld, HaveNew&gt;(oldTable, newTable); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;goto retry; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;// 防止弱引用间死锁 &nbsp;&nbsp;&nbsp;&nbsp;// 并且通过 +initialize 初始化构造器保证所有弱引用的 isa 非空指向 &nbsp;&nbsp;&nbsp;&nbsp;if (HaveNew&nbsp;&nbsp;&amp;&amp;&nbsp;&nbsp;newObj) { &nbsp;&nbsp;&nbsp;&nbsp; // 获得新对象的 isa 指针 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Class cls = newObj-&gt;getIsa(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 判断 isa 非空且已经初始化 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (cls != previouslyInitializedClass&nbsp;&nbsp;&amp;&amp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;!((objc_class *)cls)-&gt;isInitialized()) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 解锁 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;SideTable::unlockTwoHaveOld, HaveNew&gt;(oldTable, newTable); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 对其 isa 指针进行初始化 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_class_initialize(_class_getNonMetaClass(cls, (id)newObj)); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 如果该类已经完成执行 +initialize 方法是最理想情况 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 如果该类 +initialize 在线程中 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 例如 +initialize 正在调用 storeWeak 方法 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 需要手动对其增加保护策略，并设置 previouslyInitializedClass 指针进行标记 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;previouslyInitializedClass = cls; // 重新尝试 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;goto retry; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;// ② 清除旧值 &nbsp;&nbsp;&nbsp;&nbsp;if (HaveOld) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;weak_unregister_no_lock(&amp;oldTable-&gt;weak_table, oldObj, location); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;// ③ 分配新值 &nbsp;&nbsp;&nbsp;&nbsp;if (HaveNew) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;newObj = (objc_object *)weak_register_no_lock(&amp;newTable-&gt;weak_table, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(id)newObj, location, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CrashIfDeallocating); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 如果弱引用被释放 weak_register_no_lock 方法返回 nil &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 在引用计数表中设置若引用标记位 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (newObj&nbsp;&nbsp;&amp;&amp;&nbsp;&nbsp;!newObj-&gt;isTaggedPointer()) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; // 弱引用位初始化操作 // 引用计数那张散列表的weak引用对象的引用计数中标识为weak引用 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;newObj-&gt;setWeaklyReferenced_nolock(); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 之前不要设置 location 对象，这里需要更改指针指向 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*location = (id)newObj; &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;else { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 没有新值，则无需更改 &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;SideTable::unlockTwoHaveOld, HaveNew&gt;(oldTable, newTable); &nbsp;&nbsp;&nbsp;&nbsp;return (id)newObj; } </td> 
 </tr> 
 </tbody> 
</table>

其中标注的一些要点，开始逐一介绍：

## 引用计数和弱引用依赖表 SideTable ##

`SideTable` 这个结构体，我给他起名**引用计数和弱引用依赖表**，因为它主要用于管理对象的引用计数和 `weak` 表。在 `NSObject.mm` 中声明其数据结构：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> struct SideTable { // 保证原子操作的自旋锁 &nbsp;&nbsp;&nbsp;&nbsp;spinlock_t slock; &nbsp;&nbsp;&nbsp;&nbsp;// 引用计数的 hash 表 &nbsp;&nbsp;&nbsp;&nbsp;RefcountMap refcnts; &nbsp;&nbsp;&nbsp;&nbsp;// weak 引用全局 hash 表 &nbsp;&nbsp;&nbsp;&nbsp;weak_table_t weak_table; } </td> 
 </tr> 
 </tbody> 
</table>

在之前的 runtime 版本中，有一个较为重要的成员方法，用来根据对象的地址在缓存中取出对应的 `SideTable` 实例：

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> static SideTable *tableForPointer(const void *p); </td> 
 </tr> 
 </tbody> 
</table>

而在上面 `objc_storeWeak` 方法中，取出实例的方法变成了 `&SideTables()[xxxObj];` 这种方式。查看方法的实现，发现了如下函数：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> static StripedMapSideTable&gt;&amp; SideTables() { &nbsp;&nbsp;&nbsp;&nbsp;return *reinterpret_castStripedMapSideTable&gt;*&gt;(SideTableBuf); } </td> 
 </tr> 
 </tbody> 
</table>

在取出实例方法的实现中，使用了 C++ 标准转换运算符 **reinterpret\_cast** ，其表达方式为：

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> reinterpret_cast new_type&gt; (expression) </td> 
 </tr> 
 </tbody> 
</table>

用来处理无关类型之间的转换。该关键字会产生一个新值，并**保证与原参数（expression）拥有完全相同的比特位**。

而 `StripedMap` 是一个模板类（Template Class），通过传入类（结构体）参数，会动态修改在该类中的一个 `array` 成员存储的元素类型，并且其中提供了一个针对于地址的 hash 算法，用作存储 key。可以说， `StripedMap` 提供了一套拥有将地址作为 key 的 hash table 解决方案，而该方案采用了模板类，是拥有泛型性的。

介绍了与对象相关联的 SideTable 检索方式，再来看 SideTable 的成员和作用。

对于 slock 和 refcnts 两个成员不用多说，第一个是为了防止竞争选择的自旋锁，第二个是协助对象的 isa 指针的 `extra_rc` 共同引用计数的变量（对于对象结果，在今后的文中提到）。这里主要看 `weak` 全局 hash 表的结构与作用。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> struct weak_table_t { // 保存了所有指向指定对象的 weak 指针 &nbsp;&nbsp;&nbsp;&nbsp;weak_entry_t *weak_entries; &nbsp;&nbsp;&nbsp;&nbsp;// 存储空间 &nbsp;&nbsp;&nbsp;&nbsp;size_t&nbsp;&nbsp;&nbsp;&nbsp;num_entries; &nbsp;&nbsp;&nbsp;&nbsp;// 参与判断引用计数辅助量 &nbsp;&nbsp;&nbsp;&nbsp;uintptr_t mask; &nbsp;&nbsp;&nbsp;&nbsp;// hash key 最大偏移值 &nbsp;&nbsp;&nbsp;&nbsp;uintptr_t max_hash_displacement; }; </td> 
 </tr> 
 </tbody> 
</table>

这是一个全局弱引用表。使用不定类型对象的地址作为 key ，用 weak\_entry\_t 类型结构体对象作为 value 。其中的 weak\_entries 成员，从字面意思上看，即为弱引用表入口。其实现也是这样的。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> typedef objc_object ** weak_referrer_t; struct weak_entry_t { &nbsp;&nbsp;&nbsp;&nbsp;DisguisedPtrobjc_object&gt; referent; &nbsp;&nbsp;&nbsp;&nbsp;union { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;struct { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;weak_referrer_t *referrers; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;uintptr_t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;out_of_line : 1; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;uintptr_t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;num_refs : PTR_MINUS_1; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;uintptr_t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;mask; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;uintptr_t&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;max_hash_displacement; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;struct { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// out_of_line=0 is LSB of one of these (don't care which) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;weak_referrer_t&nbsp;&nbsp;inline_referrers[WEAK_INLINE_COUNT]; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}; } </td> 
 </tr> 
 </tbody> 
</table>

在 weak\_entry\_t 的结构中，`DisguisedPtr referent` 是对泛型对象的指针做了一个封装，通过这个泛型类来解决内存泄漏的问题。从注释中写 `out_of_line` 成员为最低有效位，当其为0的时候， `weak_referrer_t` 成员将扩展为多行静态 hash table。其实其中的 `weak_referrer_t` 是二维 `objc_object` 的别名，通过一个二维指针地址偏移，用下标作为 hash 的 key，做成了一个弱引用散列。

那么在有效位未生效的时候，`out_of_line` 、 `num_refs`、 `mask` 、 `max_hash_displacement` 有什么作用？以下是笔者自身的猜测：

*  **out\_of\_line**：最低有效位，也是标志位。当标志位 0 时，增加引用表指针纬度。
 *  **num\_refs**：引用数值。这里记录弱引用表中引用有效数字，因为弱引用表使用的是静态 hash 结构，所以需要使用变量来记录数目。
 *  **mask**：计数辅助量。
 *  **max\_hash\_displacement**：hash 元素上限阀值。

其实 out\_of\_line 的值通常情况下是等于零的，所以弱引用表总是一个 objc\_objective 指针二维数组。一维 objc\_objective 指针可构成一张弱引用散列表，通过第三纬度实现了多张散列表，并且表数量为 WEAK\_INLINE\_COUNT 。

总结一下 `StripedMap[]` ： `StripedMap` 是一个模板类，在这个类中有一个 array 成员，用来存储 PaddedT 对象，并且其中对于 `[]` 符的重载定义中，会返回这个 PaddedT 的 value 成员，这个 value 就是我们传入的 T 泛型成员，也就是 SideTable 对象。在 array 的下标中，这里使用了 indexForPointer 方法通过位运算计算下标，实现了静态的 Hash Table。而在 weak\_table 中，其成员 weak\_entry 会将传入对象的地址加以封装起来，并且其中也有访问全局弱引用表的入口。

## 旧对象解除注册操作 weak\_unregister\_no\_lock ##

该方法主要作用是将旧对象在 weak\_table 中接触 weak 指针的对应绑定。根据函数名，称之为解除注册操作。从源码中，可以知道其功能就是从 weak\_table 中接触 weak 指针的绑定。而其中的遍历查询，就是针对于 weak\_entry 中的多张弱引用散列表。

## 新对象添加注册操作 weak\_register\_no\_lock ##

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 </td> 
 <td> id weak_register_no_lock(weak_table_t *weak_table, id referent_id, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;id *referrer_id, bool crashIfDeallocating) { // 在入口方法中，传入了 weak_table 弱引用表，referent_id 旧对象以及 referent_id 旧对象对应的地址 &nbsp;&nbsp;&nbsp;&nbsp;// 用指针去访问 oldObj 和 *location &nbsp;&nbsp;&nbsp;&nbsp;objc_object *referent = (objc_object *)referent_id; &nbsp;&nbsp;&nbsp;&nbsp;objc_object **referrer = (objc_object **)referrer_id; // 检测对象是否生效、以及是否使用了 tagged pointer 技术 &nbsp;&nbsp;&nbsp;&nbsp;if (!referent&nbsp;&nbsp;||&nbsp;&nbsp;referent-&gt;isTaggedPointer()) return referent_id; &nbsp;&nbsp;&nbsp;&nbsp;// 保证引用对象是否有效 &nbsp;&nbsp;&nbsp;&nbsp;// hasCustomRR 方法检查类（包括其父类）中是否含有默认的方法 &nbsp;&nbsp;&nbsp;&nbsp;bool deallocating; &nbsp;&nbsp;&nbsp;&nbsp;if (!referent-&gt;ISA()-&gt;hasCustomRR()) { &nbsp;&nbsp;&nbsp;&nbsp; // 检查 dealloc 状态 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;deallocating = referent-&gt;rootIsDeallocating(); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;else { &nbsp;&nbsp;&nbsp;&nbsp; // 会返回 referent 的 SEL_allowsWeakReference 方法的地址 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;BOOL (*allowsWeakReference)(objc_object *, SEL) = &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(BOOL(*)(objc_object *, SEL)) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;object_getMethodImplementation((id)referent, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; SEL_allowsWeakReference); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if ((IMP)allowsWeakReference == _objc_msgForward) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return nil; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;deallocating = &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;! (*allowsWeakReference)(referent, SEL_allowsWeakReference); &nbsp;&nbsp;&nbsp;&nbsp;} // 由于 dealloc 导致 crash ，并输出日志 &nbsp;&nbsp;&nbsp;&nbsp;if (deallocating) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (crashIfDeallocating) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_objc_fatal("Cannot form weak reference to instance (%p) of " &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"class %s. It is possible that this object was " &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"over-released, or is in the process of deallocation.", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(void*)referent, object_getClassName((id)referent)); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} else { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return nil; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;// 记录并存储对应引用表 weak_entry &nbsp;&nbsp;&nbsp;&nbsp;weak_entry_t *entry; &nbsp;&nbsp;&nbsp;&nbsp;// 对于给定的弱引用查询 weak_table &nbsp;&nbsp;&nbsp;&nbsp;if ((entry = weak_entry_for_referent(weak_table, referent))) { &nbsp;&nbsp;&nbsp;&nbsp; // 增加弱引用表于附加对象上 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;append_referrer(entry, referrer); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;else { &nbsp;&nbsp;&nbsp;&nbsp; // 自行创建弱引用表 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;weak_entry_t new_entry; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new_entry.referent = referent; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new_entry.out_of_line = 0; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new_entry.inline_referrers[0] = referrer; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for (size_t i = 1; i&nbsp;&nbsp;WEAK_INLINE_COUNT; i++) { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new_entry.inline_referrers[i] = nil; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 如果给定的弱引用表满容，进行自增长 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;weak_grow_maybe(weak_table); &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;// 向对象添加弱引用表关联，不进行检查直接修改指针指向 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;weak_entry_insert(weak_table, &amp;new_entry); &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;// 这里不会设置 *referrer = nil，因为 objc_storeWeak() 函数会需要该指针 &nbsp;&nbsp;&nbsp;&nbsp;return referent_id; } </td> 
 </tr> 
 </tbody> 
</table>

这一步与上一步相反，通过 weak\_register\_no\_lock 函数把心的对象进行注册操作，完成与对应的弱引用表进行绑定操作。

## 初始化弱引用对象流程一览 ##

弱引用的初始化，从上文的分析中可以看出，主要的操作部分就在弱引用表的取键、查询散列、创建弱引用表等操作，可以总结出如下的流程图：

这个图中省略了很多情况的判断，但是当声明一个 `__weak` 会调用上图中的这些方法。当然， `storeWeak` 方法不仅仅用在 `__weak` 的声明中，在 class 内部的操作中也会常常通过该方法来对 weak 对象进行操作。

[1240]: /images/20220515/fdd2b89fe8934a5ea6e71283812cd951.png
[1240 1]: /images/20220515/b4ddb49e866e49e8b7db3f69fc0fe51e.png
[objc4-680.tar.gz]: http://opensource.apple.com/tarballs/objc4/