Weak与Weak表

The weak table is a hash table governed by a single spin lock.
An allocated blob of memory, most often an object, but under GC any such allocation, may have its address stored in a __weak marked storage location through use of compiler generated write-barriers or hand coded uses of the register weak primitive. Associated with the registration can be a callback block for the case when one of the allocated chunks of memory is reclaimed.
The table is hashed on the address of the allocated memory. When __weak marked memory changes its reference, we count on the fact that we can still see its previous reference.
So, in the hash table, indexed by the weakly referenced item, is a list of all locations where this address is currently being stored.

以上是objc4-781版本中objc_weak.h头文件中对于weak表的定义。weak表是什么？回答这个问题我们需要联想到开发中常用的weak或者__weak修饰词。在开发中，通常在防止诸如delegate使用时的内存泄漏问题时，我们会在delegate属性定义的修饰词中使用weak来修饰它，这样子就能解决使用代理时循环引用导致内存泄漏的问题。或者，当我们有一个UI控件在交互中显示一次后就不再需要它时，我们也可以用weak来定义，这样在它被从图层上移除时就会自动置nil，减少了内存占用。但在这个机制的背后是怎样运作的，为什么被weak或者__weak修饰的对象可以自动置nil，这背后就是weak表在起作用。

源码定义

首先我们来看一下weak table在源码中的定义。

weak_table_t
可以看到weak table的结构并不太复杂，结构体内有一个weak_entry_t类型的变量，该结构体是弱引用的入口，num_entries表示来表的大小，此外mask和max_hash_displacement两个变量主要是与掩码和哈希偏移量有关。通过源码中的注释可以知道，weak table以object ids作为hash table的keys，以weak_entry_t作为hash table的values。接下来我们看看weak_entry_t结构体是什么样的。
weak_entry_t
其中，DisguisedPtr的定义是这样的
DisguisedPtr
-w707

可以见到，DisguisedPtr类是对范型对象的指针做了一个封装。weak_entry_t结构体其中的 referrers是weak_referrer_t的指针，也就是对DisguisedPtr<objc_object *>的二维指针，所以它是一个DisguisedPtr<objc_object *>的二维数组。通过一个二维指针地址偏移，用下标作为 hash 的 key，做成了一个弱引用散列。这就是weak table是hash table的来源，弱引用表是一个静态的hash table结构。

weak对象插入

在NSObject.mm文件中我们可以找到StoreWeak方法的实现，StoreWeak方法由objc_initweak方法调用。

-storeWeak

可以看到，在storeweak方法中，weak_register_no_lock方法是关键的将弱引用添加到weak table中的方法，当然在这之前还有各种必要的加锁以及其他操作。

在weak_register_no_lock方法中，方法体里构建了弱引用的referent，其属性是一个objc_object对象。

-w535

之后向referent中填充相关信息后，就要开始插入操作了。

-w626

可以看到，在这里首先定义了一个弱引用入口weak_entry_t *entry，并通过weak_entry_for_referent()方法尝试获取该对象的弱引用入口，如果获取到了说明该对象在之前已经在weak table中存在了，那么就在weak_entry_t中拓展即可。
如果没有获取到，说明该弱引用对象是第一次被加入到weak table中，代码执行else分支，在创建了一个weak_entry_t后通过weak_entry_insert方法将其插入到全局的weak_table中。

至此，一个weak对象已经成功地加入到了weak table中。通过这个过程我们可以更清晰地了解到weak table运作的机制，也验证了weak table是以object为key，weak_entry_t为value的hash table这一事实。

其他的相关方法

-w744
我们在weak_table_t结构体的定义下可以看到objc_weak.h向外暴露了四个接口，分别是向weak table注册插入对象、注销移除对象、查找弱引用对象是否已在表中、将所有该object的弱引用指针置nil。
这几个方法是整个weak table运作的关键方法，当然还有诸如对weak table扩容等内部方法。

自此，__weak obj1 = obj;这行代码的运行过程，已经全部梳理完成。

写在最后

总体上来看，weak table的实现并不算太过复杂。它有着weak_table_t,weak_entry_t,DisguisedPtr<objc_object *>等几个关键数据结构，有着weak_register_no_lock,weak_unregister_no_lock,weak_entry_insert,append_referrer等几个关键方法。
其中更多的细节，可以从objc4源码中的objc_weak.h,objc_weak.mm,NSObject.h,NSObject.mm等文件获取到。

如有错漏，欢迎读者提出。

---

Tino Wu