weak实现原理

概括

runtime维护了一个weak表，用于存储指向某个对象的所有weak指针。weak表是一个hash表，key是指向对象的地址，Value是Weak指针的地址的数组，如下图所示，key是0xffff，value数组中的某一项是0x1007

weak

所用方法

• objc_initWeak(id *location, id newObj)
• objc_storeWeak(id *location, id newObj)
• objc_destroyWeak(id *location)
  其中init和destroy都会调用storeWeak，只不过传递的参数不同。总体说来，通过initWeak函数初始化“weak修饰的属性（location）”，weak修饰的属性所指对象（newObj）销毁后通过destoryWeak函数释放该变量（location）。

objc_initWeak函数

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

NSObject *obj = [[NSObject alloc] init];
id __weak obj1 = obj;

我们初始化一个weak变量时，runtime会调用NSObject.mm中的objc_initWeak函数，这个函数在源码中声明如下：

id _Nullable objc_initWeak(id _Nullable * _Nonnull location, id _Nullable val)

具体实现代码为：

id objc_initWeak(id *location, id newObj)
{
    //如果新创建的对象无效，则直接返回nil
    if (!newObj) {
        *location = nil;
        return nil;
    }
    //新建对象有效，则调用storeWeak方法进行后续操作--添加引用
    return storeWeak
        (location, (objc_object*)newObj);
}

综上所述：在将“附有weak修饰符的变量（location）”初始化为0（nil）后，会将“赋值对象”（obj）作为参数，调用objc_storeWeak函数。
也就是说，weak 修饰的指针默认值是 nil （在Objective-C中向nil发送消息是安全的）

objc_destroyWeak函数

当weak属性所指向对象（newObj）被销毁后，obj_destroyWeak函数将0（nil）作为参数，调用objc_storeWeak函数。
objc_storeWeak(&location, 0);
objc_storeWeak函数的第二个参数（newObj）如果为0（nil），那么把weak修饰的属性（location）的地址从weak表中删除。

objc_storeWeak函数

weak实现原理的核心就是objc_storeWeak函数，函数实现如下：

id objc_storeWeak(id *location, id newObj)
{
    // 这里传递了三个 bool 数值
    // 使用 template 进行常量参数传递是为了优化性能
    return storeWeak
        (location, (objc_object *)newObj);
}

看起来真正起作用的函数是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:
    if (HaveOld) {
        // 更改指针，获得以 oldObj 为索引所存储的值地址
        oldObj = *location;
        oldTable = &SideTables()[oldObj];
    } else {
        oldTable = nil;
    }
    if (HaveNew) {
        // 更改新值指针，获得以 newObj 为索引所存储的值地址
        newTable = &SideTables()[newObj];
    } else {
        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();
        // 判断 isa 非空且已经初始化
        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 指针进行标记
            previouslyInitializedClass = cls;
            // 重新尝试
            goto retry;
        }
    }
    // ② 清除旧值
    if (HaveOld) {
        weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);
    }
    // ③ 分配新值
    if (HaveNew) {
        newObj = (objc_object *)weak_register_no_lock(&newTable->weak_table,
                                                      (id)newObj, location,
                                                      CrashIfDeallocating);
        // 如果弱引用被释放 weak_register_no_lock 方法返回 nil
        // 在引用计数表中设置若引用标记位
        if (newObj  &&  !newObj->isTaggedPointer()) {
            // 弱引用位初始化操作
            // 引用计数那张散列表的weak引用对象的引用计数中标识为weak引用
            newObj->setWeaklyReferenced_nolock();
        }
        // 之前不要设置 location 对象，这里需要更改指针指向
        *location = (id)newObj;
    }
    else {
        // 没有新值，则无需更改
    }
    SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);
    return (id)newObj;
}

• 如果是在objc_initWeak函数中调用objc_storeWeak函数，则其作用是更新指针指向，创建对应的弱引用表。
• 如果是在objc_destroyWeak函数中调用objc_storeWeak函数，则其作用是在对象被释放的时候，根据对象地址获取所有weak指针地址的数组，然后遍历这个数组把其中的数据设为nil，最后把这个entry从weak表中删除，最后清理对象的记录。

Reference

iOS 底层解析weak的实现原理