学weak之前我还是一个意气风发的少年，学完之后觉得世界都没有爱了。下面就讲讲我学到的weak原理吧。

我们之前也会经常使用weak指针，用来解决循环引用的问题，但是为什么weak指针可以做到如此呢，他又是由原理来支撑其可以实现这些操作的呢？

一、weak基础

1.基本概念

以我们之前的使用经验来看：weak是弱引用，所引用对象的计数器不会加一，并在引用对象被释放的时候自动被设置为nil。

其实：weak表其实是一个hash（哈希）表 (字典也是hash表)，Key是所指对象的地址，Value是weak指针的地址集合。 它用于解决循环引用问题。

2.实现原理

Runtime维护了一个weak表，用于存储指向某个对象的所有weak指针。weak表其实是一个hash（哈希）表，Key是所指对象的地址，Value是weak指针的地址（这个地址的值是所指对象指针的地址，就是地址的地址）集合(当weak指针的数量小于等于4时，是数组， 超过时，会变成hash表)。

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

• 1、初始化时：runtime会调用objc_initWeak函数，初始化一个新的weak指针指向对象的地址。
• 2、添加引用时：objc_initWeak函数会调用 objc_storeWeak() 函数， objc_storeWeak() 的作用是更新指针指向，创建对应的弱引用表。
• 3、释放时，调用clearDeallocating函数。clearDeallocating函数首先根据对象地址获取所有weak指针地址的数组，然后遍历这个数组把其中的数据设为nil，最后把这个entry从weak表中删除，清理对象的记录。

二、weak的实现和其调用的相关函数

1、初始化时：

runtime会调用objc_initWeak函数，objc_initWeak函数会初始化一个新的weak指针指向对象的地址。

示例代码：

Person *object = [[Person alloc] init];
id __weak objc = object;
1
2

我们在weak修饰符打断点，我们就会发现底层库调了objc_initWeak函数。

我们从这个objc_initWeak函数入手，看看其是怎么实现的。

1.1.objc_initWeak方法

如下是objc_initWeak方法的底层源码：

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

该方法有两个参数location和newObj。

• location：__weak指针的地址，存储指针的地址，这样便可以在最后将其指向的对象置为nil。
• newObj：所引用的对象。即例子中的object。

从上面的代码可以看出objc_initWeak方法只是一个深层次函数调用的入口，在该方法内部调用了storeWeak方法。下面我们来看下storeWeak方法的实现代码。

注意：objc_initWeak函数有一个前提条件：就是object必须是一个没有被注册为__weak对象的有效指针。而value则可以是nil，或者指向一个有效的对象。

1.2.storeWeak方法

如下是storeWeak方法的底层源码：

// HaveOld:  true - 变量有值
//          false - 需要被及时清理，当前值可能为 nil
// HaveNew:  true - 需要被分配的新值，当前值可能为 nil
//          false - 不需要分配新值
// CrashIfDeallocating: true - 说明 newObj 已经释放或者 newObj 不支持弱引用，该过程需要暂停
//          false - 用 nil 替代存储
template bool HaveOld, bool HaveNew, bool CrashIfDeallocating>
static id storeWeak(id *location, objc_object *newObj) {
    // 该过程用来更新弱引用指针的指向
    // 初始化 previouslyInitializedClass 指针
    Class previouslyInitializedClass = nil;
    id oldObj;
    // 声明两个 SideTable
    // ① 新旧散列创建
    SideTable *oldTable;
    SideTable *newTable;
    // 获得新值和旧值的锁存位置（用地址作为唯一标示）
    // 通过地址来建立索引标志，防止桶重复
    // 下面指向的操作会改变旧值
retry:
	// 如果weak ptr之前弱引用过一个obj，则将这个obj所对应的SideTable取出，赋值给oldTable，即获取其旧的Table
    if (HaveOld) {
        // 更改指针，获得以 oldObj 为索引所存储的值地址
        oldObj = *location;
        oldTable = &SideTables()[oldObj];
    } else {  // 如果weak ptr之前没有弱引用过一个obj，则oldTable = nil
        oldTable = nil;
    }
    // 如果weak ptr要weak引用一个新的obj，则将该obj对应的SideTable取出，赋值给newTable
    if (HaveNew) {
        // 更改新值指针，获得以 newObj 为索引所存储的值地址
        newTable = &SideTables()[newObj];
    } else {  // 如果weak ptr不需要引用一个新obj，则newTable = nil
        newTable = nil;
    }
    // 加锁操作，防止多线程中竞争冲突
    SideTable::lockTwoHaveOld, HaveNew>(oldTable, newTable);
    // 避免线程冲突重处理
    // location 应该与 oldObj 保持一致，如果不同，说明当前的 location 已经处理过 oldObj 可是又被其他线程所修改，需要返回上边重新处理
    if (HaveOld  &&  *location != oldObj) {
        SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);
        goto retry;
    }
    // 防止弱引用间死锁
    // 并且通过 +initialize 初始化构造器保证所有弱引用的 isa 非空指向
    if (HaveNew  &&  newObj) {
        // 获得新对象的 isa 指针
        Class cls = newObj->getIsa();
        // 如果cls还没有初始化，先初始化，再尝试设置weak
        if (cls != previouslyInitializedClass  &&
            !((objc_class *)cls)->isInitialized()) {
            // 解锁
            SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);
            // 对其 isa 指针进行初始化
            _class_initialize(_class_getNonMetaClass(cls, (id)newObj));
            // 如果该类已经完成执行 +initialize 方法是最理想情况
            // 如果该类 +initialize 在线程中
            // 例如 +initialize 正在调用 storeWeak 方法
            // 需要手动对其增加保护策略，并设置 previouslyInitializedClass 指针进行标记，防止改if分支再次进入
            previouslyInitializedClass = cls;
            // 重新获取一遍newObj，这时的newObj应该已经初始化过了
            goto retry;
        }
    }
    // ② 清除旧值
    //  如果之前该指针有弱引用过一个obj那就得需要清除之前的弱引用
    if (HaveOld) {
    	// 如果weak_ptr之前弱引用过别的对象oldObj，则调用weak_unregister_no_lock，在oldObj的weak_entry_t中移除该weak_ptr地址
        weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);
    }
    // ③ 分配新值
    // 如果weak_ptr需要弱引用新的对象newObj
    if (HaveNew) {
    	// (1) 调用weak_register_no_lock方法，将weak ptr的地址记录到newObj对应的weak_entry_t中
    	// 如果弱引用被释放 weak_register_no_lock 方法返回 nil
        newObj = (objc_object *)weak_register_no_lock(&newTable->weak_table,
                                                      (id)newObj, location,
                                                      CrashIfDeallocating);
        // (2) 更新newObj的isa的weakly_referenced bit标志位
        if (newObj  &&  !newObj->isTaggedPointer()) {
            // 弱引用位初始化操作
            // 引用计数那张散列表的weak引用对象的引用计数中标识为weak引用
            newObj->setWeaklyReferenced_nolock();
        }
        // （3）*location 赋值，也就是将weak ptr直接指向了newObj，也就是确保其指针指向是正确的。可以看到，这里并没有将newObj的引用计数+1
        *location = (id)newObj;
    }
    else {
        // 没有新值，则无需更改
    }
    // 解锁，其他线程可以访问oldTable, newTable了
    SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);
    // 返回newObj，此时的newObj与刚传入时相比，设置了weakly-referenced bit位置1
    return (id)newObj;
}
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
88
89
90
91
92
93
94
95

我们看其实现源码感觉它很长，其实它也没做多少事。我们就来分析一下它做的事：

• 1.storeWeak方法实际上是接收了5个参数，分别是haveOld、haveNew和crashIfDeallocating，这三个参数都是以模板的方式传入的，是三个bool类型的参数。分别表示weak指针之前是否指向了一个弱引用，weak指针是否需要指向一个新的引用，如果被弱引用的对象正在析构，此时再弱引用该对象是否应该crash。
• 2.该方法维护了oldTable和newTable分别表示旧的引用弱表和新的弱引用表，它们都是SideTable的hash表。
• 3.如果weak指针之前指向了一个弱引用，则会调用weak_unregister_no_lock方法将旧的weak指针地址移除。
• 4.如果weak指针需要指向一个新的引用，则会调用weak_register_no_lock方法将新的weak指针地址添加到弱引用表中。
• 5.调用setWeaklyReferenced_nolock方法修改weak新引用的对象的bit标志位。

那么这个方法中的重点也就是weak_unregister_no_lock和weak_register_no_lock这两个方法。而这两个方法都是操作的SideTable这样一个结构的变量，那么我们需要先来了解下SideTable。

1.3.SideTable结构体

先看一下SideTable的定义：

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

它主要用于管理对象的引用计数和 weak 表。

• slock：为了防止竞争选择的自旋锁。
• refcnts：用来存储OC对象的引用计数的 hash表(仅在未开启isa优化或在isa优化情况下isa_t的引用计数溢出时才会用到)。
• weak_table：存储对象弱引用指针的hash表。是OC中weak功能实现的核心数据结构。

1.3.1.weak_table_t结构体

先来看下weak_table_t的底层代码：

/**
   全局的弱引用表, 保存object作为key, weak_entry_t作为value
 * The global weak references table. Stores object ids as keys,
 * and weak_entry_t structs as their values.
 */
struct weak_table_t {
    // 保存了所有指向特地对象的 weak指针集合
    weak_entry_t *weak_entries;
    // weak_table_t中有多少个weak_entry_t
    size_t    num_entries;
    // weak_entry_t数组的count
    uintptr_t mask;
    // hash key 最大偏移值, 
    // 采用了开放定制法解决hash冲突,超过max_hash_displacement说明weak_table_t中不存在要找的weak_entry_t
    uintptr_t max_hash_displacement;
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

• weak_entries：hash数组，用来存储弱引用对象的相关信息weak_entry_t。
• num_entries：hash数组中的元素个数。
• mask：hash数组长度-1，会参与hash计算。（注意，这里是hash数组的长度，而不是元素个数。比如，数组长度可能是64，而元素个数仅存了2个）。
• max_hash_displacement：可能会发生的hash冲突的最大次数，用于判断是否出现了逻辑错误（hash表中的冲突次数绝不会超过改值）。

weak_table_t是一个典型的hash结构。weak_entries是一个动态数组，用来存储weak_entry_t类型的元素，这些元素实际上就是OC对象的弱引用信息。

1.3.2.weak_entry_t结构体

weak_entry_t的结构也是一个hash结构，其存储的元素是弱引用对象指针的指针， 通过操作指针的指针，就可以使得weak引用的指针在对象析构后，指向nil。其实现代码如下：

#define WEAK_INLINE_COUNT 4
#define REFERRERS_OUT_OF_LINE 2

typedef objc_object ** weak_referrer_t;

struct weak_entry_t {
    // 所有weak指针指向的特定对象
    DisguisedPtr<objc_object> referent; // 被弱引用的对象
    // 共用体,保存weak指针的集合, 
    // 引用个数小于4，用inline_referrers数组。用个数大于4，用动态数组weak_referrer_t *referrers
    union {
        struct {
            weak_referrer_t *referrers;  // 弱引用该对象的对象指针地址的hash数组
            uintptr_t        out_of_line : 1;  // 是否使用动态hash数组标记位
            uintptr_t        num_refs : PTR_MINUS_1;  // hash数组中的元素个数
            uintptr_t        mask;  // hash数组长度-1，会参与hash计算。（注意，这里是hash数组的长度，而不是元素个数。比如，数组长度可能是64，而元素个数仅存了2个）素个数）。
            uintptr_t        max_hash_displacement;  // 可能会发生的hash冲突的最大次数，用于判断是否出现了逻辑错误（hash表中的冲突次数绝不会超过改值）
        };
        struct {
            // out_of_line=0 is LSB of one of these (don't care which)
            weak_referrer_t  inline_referrers[WEAK_INLINE_COUNT];
        };
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

在weak_entry_t的结构中，DisguisedPtr referent是对泛型对象的指针做了一个封装，通过这个泛型类来解决内存泄漏的问题。而且weak_entry_t和weak_table_t内部都有一个hash表, 而且都是采用开放定值法解决的hash冲突, 从注释中写out_of_line成员为最低有效位，当其为1的时候，weak_referrer_t成员将扩展为hash table。其中的weak_referrer_t是一个数组的别名。

• out_of_line：标志位。标志着weak_entry_t中是用数组保存还是hash表保存weak指针。
• num_refs：引用计数。这里记录weak_entry_t表中weak指针的数量。
• mask：weak_entry_t->referrers数组的count。
• max_hash_displacement：hash key 最大偏移值, 采用了开放定制法解决hash冲突，超过max_hash_displacement说明weak_entry_t中不存在要找的weak_entry_t。

其中out_of_line的值通常情况下是等于零的，所以弱引用表总是一个objc_objective指针数组，当超过4时, 会变成hash表。

总的来说weak的结构就是这样的：

到这里我们已经清楚了弱引用表的结构是一个hash结构的表，Key是所指对象的地址，Value是weak指针的地址（这个地址的值是所指对象的地址）数组。 那么接下来看看这个弱引用表是怎么维护这些数据的。

2、添加引用时：

objc_initWeak函数会调用objc_storeWeak() 函数， objc_storeWeak() 的作用是更新指针指向，创建对应的弱引用表。

2.1.weak_register_no_lock方法

新对象添加注册操作weak_register_no_lock，通过weak_register_no_lock函数把新的对象进行注册操作，完成与对应的弱引用表进行绑定操作。
其实现如下：

/*	weak_table：weak_table_t结构类型的全局的弱引用表。
	referent_id：weak指针所指的对象。
	*referrer_id：weak修饰的指针的地址。
	crashIfDeallocating：如果被弱引用的对象正在析构，此时再弱引用该对象是否应该crash。
*/
id
weak_register_no_lock(weak_table_t *weak_table, id referent_id,
                      id *referrer_id, bool crashIfDeallocating)
{
    objc_object *referent = (objc_object *)referent_id;
    objc_object **referrer = (objc_object **)referrer_id;
 
    // 如果referent为nil 或 referent 采用了TaggedPointer计数方式，直接返回，不做任何操作
    if (!referent  ||  referent->isTaggedPointer()) return referent_id;
 
    // 确保被引用的对象可用（没有在析构，同时应该支持weak引用）
    bool deallocating;
    if (!referent->ISA()->hasCustomRR()) {
        deallocating = referent->rootIsDeallocating();
    }
    else {  //不能被weak引用，直接返回nil
        BOOL (*allowsWeakReference)(objc_object *, SEL) =
            (BOOL(*)(objc_object *, SEL))
            object_getMethodImplementation((id)referent,
                                           SEL_allowsWeakReference);
        if ((IMP)allowsWeakReference == _objc_msgForward) {
            return nil;
        }
        deallocating =
            ! (*allowsWeakReference)(referent, SEL_allowsWeakReference);
    }
    // 正在析构的对象，不能够被弱引用
    if (deallocating) {
        if (crashIfDeallocating) {
            _objc_fatal("Cannot form weak reference to instance (%p) of "
                        "class %s. It is possible that this object was "
                        "over-released, or is in the process of deallocation.",
                        (void*)referent, object_getClassName((id)referent));
        } else {
            return nil;
        }
    }
 
    // now remember it and where it is being stored
    // 在 weak_table中找到referent对应的weak_entry,并将referrer加入到weak_entry中
    weak_entry_t *entry;
    if ((entry = weak_entry_for_referent(weak_table, referent))) { // 如果能找到weak_entry,则讲referrer插入到weak_entry中
        append_referrer(entry, referrer);     // 将referrer插入到weak_entry_t的引用数组中
    }
    else { // 如果找不到，就新建一个
        weak_entry_t new_entry(referent, referrer);
        weak_grow_maybe(weak_table);
        weak_entry_insert(weak_table, &new_entry);
    }
 
    // Do not set *referrer. objc_storeWeak() requires that the
    // value not change.
 
    return referent_id;
}
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

从上面的代码我么可以知道该方法主要的做了如下几个方面的工作：

• 1.如果referent为nil或referent采用了TaggedPointer计数方式，直接返回，不做任何操作。
• 如果对象不能被weak引用，直接返回nil。
• 如果对象正在析构，则抛出异常。
• 如果对象没有再析构且可以被weak引用，则调用weak_entry_for_referent方法根据弱引用对象的地址从弱引用表中找到对应的weak_entry，如果能够找到则调用append_referrer方法向其中插入weak指针地址。否则新建一个weak_entry。

2.1.1.weak_entry_for_referent取元素

其实现源码如下：

static weak_entry_t *
weak_entry_for_referent(weak_table_t *weak_table, objc_object *referent)
{
    assert(referent);
 
    weak_entry_t *weak_entries = weak_table->weak_entries;
 
    if (!weak_entries) return nil;
 
    size_t begin = hash_pointer(referent) & weak_table->mask;  // 这里通过 & weak_table->mask的位操作，来确保index不会越界
    size_t index = begin;
    size_t hash_displacement = 0;
    while (weak_table->weak_entries[index].referent != referent) {
        index = (index+1) & weak_table->mask;
        // index == begin 意味着数组绕了一圈都没有找到合适位置，这时候一定是出了什么问题。
        if (index == begin) bad_weak_table(weak_table->weak_entries); // 触发bad weak table crash
        hash_displacement++;
        if (hash_displacement > weak_table->max_hash_displacement) { // 当hash冲突超过了可能的max hash 冲突时，说明元素没有在hash表中，返回nil
            return nil;
        }
    }
 
 	//返回找到的元素
    return &weak_table->weak_entries[index];
}
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

2.1.2.append_referrer添加元素

其实现源码如下：

static void append_referrer(weak_entry_t *entry, objc_object **new_referrer)
{
	// 如果weak_entry 尚未使用动态数组，走这里
    if (! entry->out_of_line()) {
        // Try to insert inline.
        for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
        	// 找到一个空位直接插入，结束返回
            if (entry->inline_referrers[i] == nil) {
                entry->inline_referrers[i] = new_referrer;
                return;
            }
        }
 
        // 如果inline_referrers的位置已经存满了，则要转型为referrers，做动态数组。
        // Couldn't insert inline. Allocate out of line.
        //  创建一个动态数组，并将之前的静态数组的值都赋给动态数组
        weak_referrer_t *new_referrers = (weak_referrer_t *)
            calloc(WEAK_INLINE_COUNT, sizeof(weak_referrer_t));
        // This constructed table is invalid, but grow_refs_and_insert
        // will fix it and rehash it.
        for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
            new_referrers[i] = entry->inline_referrers[I];
        }
        entry->referrers = new_referrers;
        entry->num_refs = WEAK_INLINE_COUNT;
        entry->out_of_line_ness = REFERRERS_OUT_OF_LINE;
        entry->mask = WEAK_INLINE_COUNT-1;
        entry->max_hash_displacement = 0;
    }
 
    // 对于动态数组的附加处理：
    assert(entry->out_of_line()); // 断言：此时一定使用的动态数组
 	// 如果动态数组中元素个数大于或等于数组位置总空间的3/4，则扩展数组空间为当前长度的一倍
    if (entry->num_refs >= TABLE_SIZE(entry) * 3/4) { 
    	// 扩容，并插入
        return grow_refs_and_insert(entry, new_referrer);
    }
 
    // 如果不需要扩容，直接插入到weak_entry中
    // 注意，weak_entry是一个哈希表，key：w_hash_pointer(new_referrer) value: new_referrer
 
    // 细心的人可能注意到了，这里weak_entry_t 的hash算法和 weak_table_t的hash算法是一样的，同时扩容/减容的算法也是一样的
    size_t begin = w_hash_pointer(new_referrer) & (entry->mask); // '& (entry->mask)' 确保了 begin的位置只能大于或等于 数组的长度
    size_t index = begin;  // 初始的hash index
    size_t hash_displacement = 0;  // 用于记录hash冲突的次数，也就是hash再位移的次数
    //  使用循环找到一个合适的空位
    while (entry->referrers[index] != nil) {
        hash_displacement++;
        index = (index+1) & entry->mask;  // index + 1, 移到下一个位置，再试一次能否插入。（这里要考虑到entry->mask取值，一定是：0x111, 0x1111, 0x11111, ... ，因为数组每次都是*2增长，即8， 16， 32，对应动态数组空间长度-1的mask，也就是前面的取值。）
        if (index == begin) bad_weak_table(entry); // index == begin 意味着数组绕了一圈都没有找到合适位置，这时候一定是出了什么问题。
    }
    // 记录最大的hash冲突次数, max_hash_displacement意味着: 我们尝试至多max_hash_displacement次，肯定能够找到object对应的hash位置
    if (hash_displacement > entry->max_hash_displacement) { 
        entry->max_hash_displacement = hash_displacement;
    }
    // 将值插入刚才找到的hash表的空位，同时，更新元素个数num_refs
    weak_referrer_t &ref = entry->referrers[index];
    ref = new_referrer;
    entry->num_refs++;
}
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

这段代码就是实现了元素的插入，分为静态数组插入和动态数组插入，其中还加了静态数组到动态数组的变换。

2.2.weak_unregister_no_lock移除引用

如果weak指针之前指向了一个弱引用，则会调用weak_unregister_no_lock方法将旧的weak指针地址移除。

void
weak_unregister_no_lock(weak_table_t *weak_table, id referent_id,
                        id *referrer_id)
{
    objc_object *referent = (objc_object *)referent_id;
    objc_object **referrer = (objc_object **)referrer_id;
 
    weak_entry_t *entry;
 
 	//  弱引用对象为nil不存在，直接返回
    if (!referent) return;
 
 	// 查找到referent所对应的weak_entry_t
    if ((entry = weak_entry_for_referent(weak_table, referent))) { 
        remove_referrer(entry, referrer);  // 在referent所对应的weak_entry_t的hash数组中，移除referrer
 
        // 移除元素之后， 要检查一下weak_entry_t的hash数组是否已经空了
        bool empty = true;
        if (entry->out_of_line()  &&  entry->num_refs != 0) {
            empty = false;
        }
        else {
            for (size_t i = 0; i < WEAK_INLINE_COUNT; i++) {
                if (entry->inline_referrers[i]) {
                    empty = false;
                    break;
                }
            }
        }
 
 		// 如果weak_entry_t的hash数组已经空了，则需要将weak_entry_t从weak_table中移除
        if (empty) {
            weak_entry_remove(weak_table, entry);
        }
    }
    return;
}
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

这个方法主要完成了下面几个内容：

• 首先，它会在weak_table中找出referent对应的weak_entry_t。
• 在weak_entry_t中移除referrer。
• 移除元素后，判断此时weak_entry_t中是否还有元素 （empty==true？）。
• 如果此时weak_entry_t已经没有元素了，则需要将weak_entry_t从weak_table中移除。

到这里为止就是对于一个对象做weak引用时底层做的事情，用weak引用对象后引用计数并不会加1，当对象释放时，所有weak引用它的指针又是如何自动设置为nil的呢？

3、释放时：

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

3.1.当weak引用指向的对象被释放时，又是如何去处理weak指针的呢？

当释放对象时，其基本流程如下：

• 1、调用objc_release。
• 2、因为对象的引用计数为0，所以执行dealloc。
• 3、在dealloc中，调用了_objc_rootDealloc函数。
• 4、在_objc_rootDealloc中，调用了object_dispose函数。
• 5、调用objc_destructInstance。
• 6、最后调用objc_clear_deallocating。

3.2.dealloc方法

当对象的引用计数为0时，底层会调用_objc_rootDealloc方法对对象进行释放，而在_objc_rootDealloc方法里面会调用rootDealloc方法。如下是rootDealloc方法的代码实现：

inline void
objc_object::rootDealloc()
{
	//  判断对象是否是Tagged Pointer，如果是则直接返回。
    if (isTaggedPointer()) return;  // fixme necessary?
 
 	//如果对象是采用了优化的isa计数方式，且同时满足对象没有被weak引用!isa.weakly_referenced、没有关联对象!isa.has_assoc、没有自定义的C++析构方法!isa.has_cxx_dtor、没有用到SideTable来引用计数!isa.has_sidetable_rc则直接快速释放。
    if (fastpath(isa.nonpointer  &&
                 !isa.weakly_referenced  &&
                 !isa.has_assoc  &&
                 !isa.has_cxx_dtor  &&
                 !isa.has_sidetable_rc))
    {
        assert(!sidetable_present());
        free(this);
    }
    else {  // 调用object_dispose方法。
        object_dispose((id)this);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

这个函数又涉及了object_dispose方法。

3.2.1.object_dispose方法

object_dispose方法很简单，主要是内部调用了objc_destructInstance方法。

void *objc_destructInstance(id obj) 
{
    if (obj) {
        // Read all of the flags at once for performance.
        //  是否有自定义的C++析构方法
        bool cxx = obj->hasCxxDtor();
        //  是否有关联对象
        bool assoc = obj->hasAssociatedObjects();
 
        // This order is important.
        //  如果有自定义的C++析构方法，则调用C++析构函数。
        if (cxx) object_cxxDestruct(obj);
        //  如果有关联对象，则移除关联对象并将其自身从Association Manager的map中移除。调用clearDeallocating方法清除对象的相关引用。
        if (assoc) _object_remove_assocations(obj);
        obj->clearDeallocating();
    }
 
    return obj;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

3.2.2.clearDeallocating方法

inline void 
objc_object::clearDeallocating()
{
	//  判断对象是否采用了优化isa引用计数
    if (slowpath(!isa.nonpointer)) {
        // Slow path for raw pointer isa.
        //  如果没有的话则需要清理对象存储在SideTable中的引用计数数据
        sidetable_clearDeallocating();
    }
    //  如果对象采用了优化isa引用计数，则判断是否有使用weak引用(isa.weakly_referenced)或者有使用SideTable的辅助引用计数(isa.has_sidetable_rc)，符合这两种情况中一种的，调用clearDeallocating_slow方法。
    else if (slowpath(isa.weakly_referenced  ||  isa.has_sidetable_rc)) {
        // Slow path for non-pointer isa with weak refs and/or side table data.
        clearDeallocating_slow();
    }
 
    assert(!sidetable_present());
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

3.2.3.clearDeallocating_slow方法

NEVER_INLINE void
objc_object::clearDeallocating_slow()
{
    assert(isa.nonpointer  &&  (isa.weakly_referenced || isa.has_sidetable_rc));
 
 	// 在全局的SideTables中，以this指针为key，找到对应的SideTable
    SideTable& table = SideTables()[this];
    //  上锁
    table.lock();
    // 如果obj被弱引用
    if (isa.weakly_referenced) {
        // 在SideTable的weak_table中对this进行清理工作
        weak_clear_no_lock(&table.weak_table, (id)this);
    }
    // 如果采用了SideTable做引用计数
    if (isa.has_sidetable_rc) {
        // 在SideTable的引用计数中移除this
        table.refcnts.erase(this);
    }
    //  解锁
    table.unlock();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

在这里我们关心的是weak_clear_no_lock方法。这里调用了weak_clear_no_lock来做weak_table的清理工作。

3.2.4.weak_clear_no_lock方法

void 
weak_clear_no_lock(weak_table_t *weak_table, id referent_id) 
{
    objc_object *referent = (objc_object *)referent_id;
 
 	// 找到referent在weak_table中对应的weak_entry_t
    weak_entry_t *entry = weak_entry_for_referent(weak_table, referent);
    if (entry == nil) {
        /// XXX shouldn't happen, but does with mismatched CF/objc
        //printf("XXX no entry for clear deallocating %p\n", referent);
        return;
    }
 
    // zero out references
    weak_referrer_t *referrers;
    size_t count;
 
    // 找出weak引用referent的weak 指针地址数组以及数组长度
    if (entry->out_of_line()) {  //  如果是动态数组
        referrers = entry->referrers;
        count = TABLE_SIZE(entry);
    }
    else {  //  如果是静态数组
        referrers = entry->inline_referrers;
        count = WEAK_INLINE_COUNT;
    }
 
    for (size_t i = 0; i < count; ++i) {
    	// 取出每个weak ptr的地址
        objc_object **referrer = referrers[i];
        if (referrer) {
        	// 如果weak ptr确实weak引用了referent，则将weak ptr设置为nil，这也就是为什么weak 指针会自动设置为nil的原因
            if (*referrer == referent) {
                *referrer = nil;
            }
            else if (*referrer) { // 如果所存储的weak ptr没有weak 引用referent，这可能是由于runtime代码的逻辑错误引起的，报错
                _objc_inform("__weak variable at %p holds %p instead of %p. "
                             "This is probably incorrect use of "
                             "objc_storeWeak() and objc_loadWeak(). "
                             "Break on objc_weak_error to debug.\n",
                             referrer, (void*)*referrer, (void*)referent);
                objc_weak_error();
            }
        }
    }
    
 	// 由于referent要被释放了，因此referent的weak_entry_t也要移除出weak_table
    weak_entry_remove(weak_table, entry);
}
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

objc_clear_deallocating该函数的动作如下：

• 1、从weak表中，以dealloc对象为key，找到对应的weak_entry_t。
• 2、将weak_entry_t中的所有附有weak修饰符变量的地址，赋值为nil。
• 3、将weak表中该对象移除。

三、总结

• 1、weak的原理在于底层维护了一张weak_table_t结构的hash表，key是所指对象的地址，value是weak指针的地址数组。
• 2、weak关键字的作用是弱引用，所引用对象的计数器不会加1，并在引用对象被释放的时候自动被设置为nil。
• 3、对象释放时，调用clearDeallocating函数根据对象地址获取所有weak指针地址的数组，然后遍历这个数组把其中的数据设为nil，最后把这个entry从weak表中删除，最后清理对象的记录。
• 4、文章中介绍了SideTable、weak_table_t、weak_entry_t这样三个结构，它们之间的关系如下图所示。
  
• 5.弱引用的初始化，从上文的分析中可以看出，主要的操作部分就在弱引用表的取键、查询散列、创建弱引用表等操作，可以总结出如下的流程图：