[移动开发][iOS开发]weak底层原理

Retain、release复习

我们在Strong实现部分了；了解过了retain和release的源码 先拿个图扔这复习一下

release这里应该是

详解见这个博客
[iOS开发]ARC

关于引用计数的存储方式，清楚看来有两种，一种是通过isa，另一种是通过SideTable
来详细学习一下

SideTable

HashMap（哈希表）
基于数组的一种数据结构，通过一定的算法，把key进行运算得出一个数字，用这个数字做数组下标，将value存入这个下标对应的内存之中

HashTon （哈希桶）
哈希算法算出的数字有可能会重复，对于哈希值重复的数据，如何存入哈希表呢？常用方法有闭散列和开散列等方式，其中采用开散列方式的哈希表称为哈希桶。开散列就是在哈希值对应的位置上，使用链表或数组，将哈希值冲突的数据存入这个链表或者数组中，提高查找效率

为了管理所有对象的引用计数和weak指针，苹果创建了一个全局的SideTables，虽然名字后面又个"s"，但其不过还是一个全局的Hash桶，里面的内容装的都是SideTable结构体而已。它使用对象的内存地址当它的key。来管理引用计数和weak指针。

看一下SideTable的内部

struct SideTable {
    spinlock_t slock;   //自旋锁
    RefcountMap refcnts;    //存放引用计数
    weak_table_t weak_table;   //weak_table是一个哈希

先学一下SideTable中的这三个成员变量

spinlock_t slock 自旋锁

锁

我们学习过了操作系统 锁是线程同步时一个重要的工具
操作系统中有五大锁

• 信号量：
• • 整型信号量S,S<=0表示该资源已被占用，S>0表示该资源可用，pv操作进行访问
• • 记录型信号量 s.value > 0 表示该资源可用的数目；< 0表示在等待链表中已经阻塞的数目
• • AND型信号量，AND型信号量是指同时需要多个资源且每种占用一个资源时的信号量操作。
• • 信号量集 对应有多种资源，相当于记录型的集合
• 互斥量：和二元信号量类似，唯一不同的是，互斥量的获取和释放必须是在同一个线程中进行的。如果一个线程去释放一个不是其所占有的信号量是无效的。而信号量是可以由其他线程释放的。
• 临界区：并发执行的进程中，访问临界资源的必须互斥执行的程序段叫临界区
• 读写锁：解决读者写者问题产生的锁
• 条件变量：条件变量相当于一种通知机制。多个线程可以设置等待该条件变量，而一旦另外的线程设置了该条件变量（相当于唤醒条件变量）后，多个等待的线程就可以继续执行了。

分离锁、拆分锁

因为对象引用计数相关操作应该是原子性的。不然如果多个线程同时去写一个对象的引用计数，那就会造成数据错乱，失去了内存管理的意义。同时又因为内存中对象的数量是很大的，需要非常频繁的操作SideTables，所以不能对整个Hash表加锁。苹果采用了分离锁技术

• 分拆锁 (lock splitting) 和分离锁 (lock striping) 是降低线程请求锁的频率从而达到降低锁竞争的两种方式。相互独立的状态变量，应该使用独立的锁进行保护。但有时开发者会错误的使用一个锁保护所有的状态变量。对于这些锁需要仔细分配，以降低发生死锁的风险
• 如果一个锁守护多个相互独立的状态变量，你可能能够通过分拆锁，使每一个锁守护不同的变量。这样可以使每一个锁被请求的频率都变小了。分拆锁对于中等竞争强度的锁，能够有效的把它们大部分转化为非竞争的锁，使性能和可可伸缩性都得到了提高。
• 分拆锁有时候可以被扩展，分成若干加锁块的集合，并且它们归属于相互独立的对象，这种情况就是分离锁。

我们将每个SideTable里的每个对象的引用计数都加一把锁，这就是分拆锁，虽然安全 但是消耗很大

我们给每个SideTable加上一把锁，只让某个SideTable不能多次访问，这就是分离锁

自旋锁

自旋锁和互斥锁

• 相同点：都能保证同一时间只有一个线程访问共享资源。都能保证线程安全。
• 不同点：
• • 互斥锁：如果共享数据已经有其他线程加锁了，线程会进入休眠状态等待锁。一旦被访问的资源被解锁，则等待资源的线程会被唤醒。
• • 自旋锁：如果共享数据已经有其他线程加锁了，线程会以死循环的方式等待锁，一旦被访问的资源被解锁，则等待资源的线程会立即执行。
• 自旋锁的效率高于互斥锁。但是我们要注意由于自旋时不释放CPU，因而持有自旋锁的线程应该尽快释放自旋锁，否则等待该自旋锁的线程会一直在哪里自旋，这就会浪费CPU时间。
• 在操作引用计数的时候对SideTable加锁，避免数据错误

苹果的选择

对于每个SideTable,中间都有自旋锁
同样也使用了分离锁给单个的SideTable上锁

安全+效率很合理

RefcountMap

来了解一下这个图

以DisguisedPtr<objc_object>为key的hash表，用来存储OC对象的引用计数
不知道DisguisedPtr<objc_object>是什么，但是我们已经对retain中存储引用计数的方式十分清晰了，如果未开启isa优化 或 在isa优化情况下isa_t的extra_rc引用计数加一后向上溢出了，才会存入这个哈希表中。

weak_table_t weak_table

储存对象弱引用指针的hash表。weak功能实现的核心数据结构。

看一下wewak_table_t

struct weak_table_t {
    weak_entry_t *weak_entries;  //连续地址空间的头指针, 数组
    //管理所有指向某对象的weak指针，也是一个hash
    size_t    num_entries;  //数组中已占用位置的个数
    uintptr_t mask;  //数组下标最大值(即数组大小 -1)
    uintptr_t max_hash_displacement;  //最大哈希偏移值
};

weak_table_t中并没有直接通过数组存放weak指针，而是通过结构体来存放weak指针
两个参数

• location：__weak指针的地址，存储指针的地址，这样便可以再最后将其指向的对象置nil
• newObj: 所引用的对象

struct weak_entry_t {
    DisguisedPtr<objc_object> referent; //被指对象的地址。前面循环遍历查找的时候就是判断目标地址是否和他相等。
    union {
        struct {
            weak_referrer_t *referrers; //可变数组,里面保存着所有指向这个对象的弱引用的地址。当这个对象被释放的时候，referrers里的所有指针都会被设置成nil。
            //哈希的目的是清除一个weak指针
            //指向 referent 对象的 weak 指针数组
            uintptr_t        out_of_line_ness : 2; //这里标记是否超过内联边界, 下面会提到
            uintptr_t        num_refs : PTR_MINUS_2; //数组中已占用的大小
            uintptr_t        mask; //数组下标最大值(数组大小 - 1)
            uintptr_t        max_hash_displacement; //最大哈希偏移值
        };
        struct {
            // out_of_line_ness field is low bits of inline_referrers[1]
            weak_referrer_t  inline_referrers[WEAK_INLINE_COUNT]; //只有4个元素的数组，默认情况下用它来存储弱引用的指针。当大于4个的时候使用referrers来存储指针。
            //当指向这个对象的weak指针不超过4个，则直接使用数组inline_referrers，省去hhash
        };
    };

union共用体 也是提醒我们苹果是使用同一段内存去存放不同的信息

中间有两个数组
weak_referrer_t *referrers和weak_referrer_t inline_referrers[WEAK_INLINE_COUNT];
在weak指针个数小于4的时候会存入第二个数组，省去了hash，提高了存储效率，大于4的时候才会存入referrers当中

构造和析构函数

// 构造函数
    SideTable() {
        memset(&weak_table, 0, sizeof(weak_table));
    }
    //析构函数(看看函数体，苹果设计的SideTable其实不希望被析构，不然会引起fatal 错误)
    ~SideTable() {
        _objc_fatal("Do not delete SideTable.");
  }

所以SideTable🈲?析构（析构函数的作用并不是删除对象，而是在撤销对象占用的内存之前完成一些清理工作。）

最后是锁的操作

    void lock() { slock.lock(); }
    void unlock() { slock.unlock(); }
    void forceReset() { slock.forceReset(); }
    // Address-ordered lock discipline for a pair of side tables.
    template<HaveOld, HaveNew>
    static void lockTwo(SideTable *lock1, SideTable *lock2);
    template<HaveOld, HaveNew>
    static void unlockTwo(SideTable *lock1, SideTable *lock2);
};

小小总结一下SideTable

weak部分

简单申请一个__weak修饰符修饰的变量 我们查看一下汇编

说到底只有两个部分

我们看一下对应的源码部分

objc_initWeak

objc_initWeak(id *location, id newObj)
{
    if (!newObj) {
        *location = nil;
        return nil;
    }

    return storeWeak<DontHaveOld, DoHaveNew, DoCrashIfDeallocating>
        (location, (objc_object*)newObj);
}

查看对象实例是否有效 无效对象直接导致指针的释放

如果有效那么就会调用objc_storeWeak()函数

objc_storeWeak

看一下store函数上面的注释
（直接放汉语版的了）

更新弱变量
如果haveOld为true，则变量有旧值，旧值需要被清理，这个值可能是nil[该weak指针之前已经有了指向]
如果haveNew为true，则有一个新值需要被分配到变量，这个值可能是nil
如果CrashIfDeallocating为true，且如果newObj正在解除分配或newObj的类不支持弱引用时，进程将停止
如果CrashIfDeallocating为false，则储存nil

再来看一下其中的具体逻辑与判断

template <HaveOld haveOld, HaveNew haveNew,
          CrashIfDeallocating crashIfDeallocating>
static id 
storeWeak(id *location, objc_object *newObj)
{
    
    assert(haveOld  ||  haveNew);
    if (!haveNew) assert(newObj == nil);
    
//       该过程用来更新弱引用指针的指向
//       初始化previouslyInitializedClass指针
    Class previouslyInitializedClass = nil;
    id oldObj;
    SideTable *oldTable;
    SideTable *newTable;

//     模版函数，haveOld和haveNew由编译器决定传入的值，location是weak指针，newObj是weak指针将要指向的对象
 retry:
    if (haveOld) {
    //        更改指针，获得oldObj 为索引所储存的值地址
        oldObj = *location;
        oldTable = &SideTables()[oldObj];
    } else {
        oldTable = nil;
    }
    if (haveNew) {
    	//     更改新值指针，获得以newObj为索引所储存的值地址
        newTable = &SideTables()[newObj];
    } else {
        newTable = nil;
    }

//       加锁操作，防止多线程中竞争冲突
    SideTable::lockTwo<haveOld, haveNew>(oldTable, newTable);
//        避免线程冲突重处理
//        location应该与oldObj保持一致，如果不同，说明当前的location已经处理过oldObj 可是又被其他线程所修改
    if (haveOld  &&  *location != oldObj) {
        SideTable::unlockTwo<haveOld, haveNew>(oldTable, newTable);
        goto retry;
    }

// 防止弱引用间死锁
// 并且通过+initialize初始化构造器保证所有弱引用的isa非空指向
    if (haveNew  &&  newObj) {
    //获得新对象的isa指针
        Class cls = newObj->getIsa();
        // 判断isa非空且已经初始化
        if (cls != previouslyInitializedClass  &&  
            !((objc_class *)cls)->isInitialized()) 
        {
            SideTable::unlockTwo<haveOld, haveNew>(oldTable, newTable);
            //对其isa指针进行初始化
            _class_initialize(_class_getNonMetaClass(cls, (id)newObj));
			//如果该类已经完成执行+initialize方法是最理想情况
			//如果该类+initialize在线程中
			//例如+initialize正在调用storeWeak方法
			//需要手动对其增加保护策略，并设置previouslyInitializedClass指针进行标记
	    	previouslyInitializedClass = cls;
			//重新尝试
            goto retry;
        }
    }

    // Clean up old value, if any.
    if (haveOld) {
        weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);
    }

    if (haveNew) {
   	//如果weak指针将要指向新值，在weak_table中处理赋值操作
        newObj = (objc_object *)
            weak_register_no_lock(&newTable->weak_table, (id)newObj, location, 
                                  crashIfDeallocating);
 	//如果弱引用被释放的weak_register_no_lock方法返回nil
 	//在引用计数表中设置若引用标记位
        if (newObj  &&  !newObj->isTaggedPointer()) {
			//弱引用位初始化操作
			//方法修改weak新引用的对象的bit标志位
            newObj->setWeaklyReferenced_nolock();
        }

        // 之前不要设置location对象， 这里需要更改指针指向
        *location = (id)newObj;
    }
    else {
        // 没有新值，则无需修改
    }
    
    SideTable::unlockTwo<haveOld, haveNew>(oldTable, newTable);
    return (id)newObj;
}

• storeWeak通过接受了3个参数haveOld、haveNew和crashIfDeallocation,这三个参数是以模版函数的方式传入的。
• • haveOld：weak指针之前是否指向了一个弱引用
• • haveNew：weak指针是否需要指向一个新的引用
• • 如果被弱引用的对象正在析构，此时再弱引用该对象是否应该crash
• • 初始化的时候传入的值应该是0 1 1
• 同时其维护了两张表oldTable和newTable两张表分别表示旧的弱引用表和新的弱引用表，他们都是SideTable的hash表
• 如果weak指针之前指向了一个弱引用,则会调用weak_unregister_no_lock方法将旧的weak指针地址移除
• 如果weak指针需要指向一个新的引用
• • 则会调用weak_register_no_lock方法将新的weak指针地址添加到弱引用表中
• • 如果弱引用被释放的weak_register_no_lock方法返回nil,在引用计数表中设置弱引用标记位

weak_register_no_lock将新的weak指针添加到弱引用表

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;

    if (!referent  ||  referent->isTaggedPointer()) return referent_id;

    // ensure that the referenced object is viable
    bool deallocating;
    if (!referent->ISA()->hasCustomRR()) {
        deallocating = referent->rootIsDeallocating();
    }
    else {
        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_entry_t *entry; //如果 weak_table 有对应的 entry
    if ((entry = weak_entry_for_referent(weak_table, referent))) {//返回给定引用对象的弱引用表项。如果referent没有条目，则返回NULL。执行查找。
        append_referrer(entry, referrer); //将 weak 指针存入对应的 entry 中，官方翻译：将给定的引用添加到此条目中的弱指针集。不执行重复检查（不会将b/c弱指针添加到集合中两次）。
    } 
    else {
        weak_entry_t new_entry(referent, referrer); //创建新的 entry
        weak_grow_maybe(weak_table); //查看是否需要调整 weak_table 中 weak_entries 数组大小
        weak_entry_insert(weak_table, &new_entry); //将新的 entry 插入到 weak_table 中，官方：将新的_项添加到对象的弱引用表中。不检查引用对象是否已在表中。
    }

    // Do not set *referrer. objc_storeWeak() requires that the 
    // value not change.

    return referent_id;
}

• 传入了4个参数
• • weak_table：weak_table_t结构体类型 我们之前已经有了解
• • referent_id：weak指针指向的对象
• • *referrer_id ： weak指针的地址，操作时需要用到这个指针的地址
• • crashIfDeallocating :如果被弱引用的对象正在析构，此时再弱引用该对象是否应该crash
• 主要流程

1. 如果referent（就是weak指针）为nil或referent采用了TaggedPointer计数方式，直接返回，不做任何操作
2. 如果正在析构，抛出异常
3. 如果对象不能被weak引用，直接返回nil
4. 如果对象不属于上面的情况，则调用weak_entry_for_referent方法，根据弱引用对象的地址从弱引用表中找到对应的weak_entry（指向其对象的指针），如果能够找到则调用append_referrer方法向其中插入weak指针地址。否则就新建一个weak_entry

核心有两个对应的函数

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;
        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];
}

append_referrer添加元素

static void append_referrer(weak_entry_t *entry, objc_object **new_referrer)
{
    if (! entry->out_of_line()) { // 如果weak_entry 尚未使用动态数组，走这里
        // 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()); // 断言： 此时一定使用的动态数组

    if (entry->num_refs >= TABLE_SIZE(entry) * 3/4) { // 如果动态数组中元素个数大于或等于数组位置总空间的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 意味着数组绕了一圈都没有找到合适位置，这时候一定是出了什么问题。
    }
    if (hash_displacement > entry->max_hash_displacement) { // 记录最大的hash冲突次数, max_hash_displacement意味着: 我们尝试至多max_hash_displacement次，肯定能够找到object对应的hash位置
        entry->max_hash_displacement = hash_displacement;
    }
    // 将ref存入hash数组，同时，更新元素个数num_refs
    weak_referrer_t &ref = entry->referrers[index];
    ref = new_referrer;
    entry->num_refs++;
}

1. 首先确定是使用定长数组还是动态数组
2. 定长数组直接将weak指针地址添加到数组
3. 定长数组已经用完，将定长数组中的元素转存到动态数组中

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;

    if (!referent) return;

    if ((entry = weak_entry_for_referent(weak_table, referent))) { // 查找到referent所对应的weak_entry_t
        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;
                }
            }
        }

        if (empty) { // 如果weak_entry_t的hash数组已经空了，则需要将weak_entry_t从weak_table中移除
            weak_entry_remove(weak_table, entry);
        }
    }

1. 首先它会在weak_table中找出referent对应的weak_entry_t
2. 在weak_entry_t中移除referrer
3. 移除元素后，判断此时weak_entry_t中是否还有元素(empty == true)
4. 如果此时weak_entry_t已经没有元素了，则需要将weak_entry_t从weak_table中移除

dealloc部分

当对象的引用计数为0时，底层会调用_objc_rootDealloc方法对对象进行释放，而在_objc_rootDealloc方法里面会调用rootDealloc方法。

inline void
objc_object::rootDealloc()
{
    if (isTaggedPointer()) return;  // fixme necessary?

    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((id)this);
    }
}

1. 首先判断对象是否是taggedPointer类型，如果是直接返回
2. 如果对象是采用了优化的isa计数方式，且同时满足对象没有被weak引用、没有关联对象、没有自定义的C++析构方法、没有用到SideTable来引用计数 则直接快速释放
3. 如果不能满足2，则调用dispose方法

void *objc_destructInstance(id obj) 
{
    if (obj) {
        // Read all of the flags at once for performance.
        bool cxx = obj->hasCxxDtor();
        bool assoc = obj->hasAssociatedObjects();

        // This order is important.
        if (cxx) object_cxxDestruct(obj);
        if (assoc) _object_remove_assocations(obj);
        obj->clearDeallocating();
    }

    return obj;
}

如果有自定义的C++析构方法，则调用析构函数。如果有关联对象，则移除关联对象并将其自身从Association Manager的map中移除。调用clearDeallocation方法清楚对象的相关引用

inline void 
objc_object::clearDeallocating()
{
    if (slowpath(!isa.nonpointer)) {
        // Slow path for raw pointer isa.
        sidetable_clearDeallocating();
    }
    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());
}

先判断对象是否采用了优化isa引用计数，如果没有的话则需要清理对象存储在SideTable中的引用计数数据。
如果采用了优化isa引用计数，则判断是否有使用SideTable的辅助引用计数(isa.has_sidetable_rc)或者有weak引用(isa.weakly_referenced)，符合这两种情况中一种的，调用clearDeallocating_slow 方法。

NEVER_INLINE void
objc_object::clearDeallocating_slow()
{
    assert(isa.nonpointer  &&  (isa.weakly_referenced || isa.has_sidetable_rc));

    SideTable& table = SideTables()[this]; // 在全局的SideTables中，以this指针为key，找到对应的SideTable
    table.lock();
    if (isa.weakly_referenced) { // 如果obj被弱引用
        weak_clear_no_lock(&table.weak_table, (id)this); // 在SideTable的weak_table中对this进行清理工作
    }
    if (isa.has_sidetable_rc) { // 如果采用了SideTable做引用计数
        table.refcnts.erase(this); // 在SideTable的引用计数中移除this
    }
    table.unlock();
}

调用了weak_clear_no_lock方法来做weak_table的清理工作

void 
weak_clear_no_lock(weak_table_t *weak_table, id referent_id) 
{
    objc_object *referent = (objc_object *)referent_id;

    weak_entry_t *entry = weak_entry_for_referent(weak_table, referent); // 找到referent在weak_table中对应的weak_entry_t
    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) {
        objc_object **referrer = referrers[i]; // 取出每个weak ptr的地址
        if (referrer) {
            if (*referrer == referent) { // 如果weak ptr确实weak引用了referent，则将weak ptr设置为nil，这也就是为什么weak 指针会自动设置为nil的原因
                *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();
            }
        }
    }
    
    weak_entry_remove(weak_table, entry); // 由于referent要被释放了，因此referent的weak_entry_t也要移除出weak_table
}

结论

runtime维护了一个weak表。用于存储指向某个对象的所有weak指针。weak表其实是一个weak_table_t结构的hash表，key是所指对象的地址，value是weak指针的地址数组

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

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