SideTables 是一个全局的 hash 表, 其中包含了一个数量为64的数组，数组中的存储的为SideTable结构体，其中通过对象内存地址作为hash表的key
SideTable
从sideTables中取值的时候，先把传入的地址指针右移4位异或地址指针右移9位，然后取余StripeCount，防止越界，根据index获取sideTable
struct SideTable {
spinlock_t slock; //自旋锁，防止多线程访问冲突
RefcountMap refcnts; //用来存储OC对象的引用计数的 hash表 (仅在未开启isa优化或在isa优化情况下isa_t的引用计数溢出时才会用到)
weak_table_t weak_table; //存储对象弱引用指针的 hash表
// 构造函数
SideTable() {
memset(&weak_table, 0, sizeof(weak_table));
}
// 析构函数
~SideTable() {
_objc_fatal("Do not delete SideTable.");
}
};
weak_table_t
weak_table_t 里面有一个二维数组weak_entries，这个数组里面存放的是weak_entry_t，weak_entry_t里面存放的是指向某个对象的weak指针地址，查找的时候通过key(对象)计算得到hash值去weak_entries中取，判断是否是同一个对象，如果不是则index+1， 直到index == begin（绕了一圈）或超过了可能的hash冲突最大值，然后遍历里面的数组，将所有的weak指针置为nil
struct weak_table_t {
// hash数组，用来存储弱引用对象的相关信息weak_entry_t
weak_entry_t *weak_entries;
// hash数组中的元素个数
size_t num_entries;
// hash数组长度-1，会参与hash计算。（注意，这里是hash数组的长度，而不是元素个数。比如，数组长度可能是64，而元素个数仅存了2个）
uintptr_t mask;
// 可能会发生的hash冲突的最大次数，用于判断是否出现了逻辑错误（hash表中的冲突次数绝不会超过改值）
uintptr_t max_hash_displacement;
};
weak_entry_t
在weak_entry_t的结构定义中有联合体，在联合体的内部有定长数组inline_referrers[WEAK_INLINE_COUNT]和动态数组weak_referrer_t *referrers两种方式来存储弱引用对象的指针地址。通过out_of_line这样一个函数方法来判断采用哪种存储方式。当弱引用该对象的指针数目小于等于WEAK_INLINE_COUNT时，使用定长数组。当超过WEAK_INLINE_COUNT时，会将定长数组中的元素转移到动态数组中，并之后都是用动态数组存储
struct weak_entry_t {
DisguisedPtr referent;
// 引用该对象的对象列表，联合。 引用个数小于4，用inline_referrers数组。 用个数大于4，用动态数组weak_referrer_t *referrers
union {
struct {
weak_referrer_t *referrers; // 弱引用该对象的对象指针地址的hash数组
uintptr_t out_of_line_ness : 2; // 是否使用动态hash数组标记位
uintptr_t num_refs : PTR_MINUS_2; // hash数组中的元素个数
uintptr_t mask; //hash数组长度-1，会参与hash计算
uintptr_t max_hash_displacement; // 可能会发生的hash冲突的最大次数，用于判断是否出现了逻辑错误（hash表中的冲突次数绝不会超过改值）
};
struct {
// out_of_line_ness field is low bits of inline_referrers[1]
weak_referrer_t inline_referrers[WEAK_INLINE_COUNT];
};
};
//判断当前的weak_entry_t是使用的定长数组还是动态数组。当返回true，此时使用的动态数组，当返回false，使用静态数组
bool out_of_line() {
return (out_of_line_ness == REFERRERS_OUT_OF_LINE);
}
}
weak流程
1. 调用objc_initWeak
/*
Key(newObj)是所指对象的地址
Value(location)是weak指针的地址（这个地址的值是所指对象的地址）数组
当weak指针的数量小于等于4时,是数组, 超过时,会变成hash表
*/
id objc_initWeak(id *location, id newObj)
{
if (!newObj) {
*location = nil;
return nil;
}
return storeWeak
(location, (objc_object*)newObj);
}
2. 调用storeWeak
storeWeak方法：
- storeWeak 方法实际上是接收了5个参数，分别是 haveOld、haveNew和crashIfDeallocating ，这三个参数都是以模板的方式传入的，是三个bool类型的参数。分别表示weak指针之前是否指向了一个弱引用，weak指针是否需要指向一个新的引用，若果被弱引用的对象正在析构，此时再弱引用该对象是否应该crash。
- 该方法维护了 oldTable 和 newTable 分别表示旧的引用弱表和新的弱引用表，它们都是 SideTable 的hash表。
- 如果weak指针之前指向了一个弱引用，则会调用 weak_unregister_no_lock 方法将旧的weak指针地址移除。
- 如果weak指针需要指向一个新的引用，则会调用 weak_register_no_lock 方法将新的weak指针地址添加到弱引用表中。
- 调用 setWeaklyReferenced_nolock 方法修改weak新引用的对象的bit标志位
这个方法中的重点是weak_unregister_no_lock和weak_register_no_lock这两个方法，这两个方法都是操作的SideTable结构变量
template
static id storeWeak(id *location, objc_object *newObj)
{
/*
......
只保留关键代码
*/
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) {
// 调用weak_register_no_lock方法，将weak ptr的地址记录到newObj对应的weak_entry_t中
newObj = (objc_object *)
weak_register_no_lock(&newTable->weak_table, (id)newObj, location,
crashIfDeallocating);
// 更新newObj的isa的weakly_referenced bit标志位
if (newObj && !newObj->isTaggedPointer()) {
newObj->setWeaklyReferenced_nolock();
}
//*location 赋值，也就是将weak ptr直接指向了newObj。可以看到，这里并没有将newObj的引用计数+1
*location = (id)newObj;
}
}
3. 调用weak_unregister_no_lock移除引用
如果weak指针之前指向了一个弱引用，则会调用weak_unregister_no_lock方法将旧的weak指针地址移除。
- 首先，它会在weak_table中找出referent对应的weak_entry_t
- 在weak_entry_t中移除referrer
- 移除元素后，判断此时weak_entry_t中是否还有元素 （empty==true？）
- 如果此时weak_entry_t已经没有元素了，则需要将weak_entry_t从weak_table中移除
/*
weak_table: weak_table_t
referent_id: 对象
referrer_id: 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)
objc_object **referrer = (objc_object **)referrer_id; // weak_ptr
weak_entry_t *entry;
if (!referent) return;
// 查找到referent所对应的weak_entry_t
if ((entry = weak_entry_for_referent(weak_table, referent))) {
// 在referent所对应的weak_entry_t的hash数组中，移除referrer
remove_referrer(entry, 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);
}
}
}
4.1 调用weak_register_no_lock
- 如果referent为nil 或 referent 采用了 TaggedPointer 计数方式，直接返回，不做任何操作。
- 如果对象正在析构，则抛出异常。
- 如果对象不能被weak引用，直接返回nil。
- 如果对象没有再析构且可以被weak引用，则调用 weak_entry_for_referent 方法根据弱引用对象的地址从弱引用表中找到对应的weak_entry，如果能够找到则调用 append_referrer 方法向其中插入weak指针地址。否则新建一个weak_entry。
/*
weak_table: weak_table_t
referent_id: 对象
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)
objc_object **referrer = (objc_object **)referrer_id; // weak_ptr
// 如果referent为nil 或 referent 采用了TaggedPointer计数方式，直接返回，不做任何操作
if (!referent || referent->isTaggedPointer()) return referent_id;
// 确保被引用的对象可用（没有在析构，同时应该支持weak引用）
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中找到referent对应的weak_entry,并将referrer加入到weak_entry中
if ((entry = weak_entry_for_referent(weak_table, referent))) {
append_referrer(entry, referrer);
}
// 如果找不到，就新建一个
else {
weak_entry_t new_entry(referent, referrer);
weak_grow_maybe(weak_table);
weak_entry_insert(weak_table, &new_entry);
}
return referent_id;
}
4.2 获取weak_entry_t实体
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;
// 这里通过 & weak_table->mask的位操作，来确保index不会越界
size_t begin = hash_pointer(referent) & weak_table->mask;
size_t index = begin;
size_t hash_displacement = 0;
//遍历查找真正的weak_entry_t
while (weak_table->weak_entries[index].referent != referent) {
index = (index+1) & weak_table->mask;
if (index == begin) bad_weak_table(weak_table->weak_entries);
hash_displacement++;
// 当hash冲突超过了可能的max hash 冲突时，说明元素没有在hash表中，返回nil
if (hash_displacement > weak_table->max_hash_displacement) {
return nil;
}
}
return &weak_table->weak_entries[index];
}
4.3 append_referrer添加元素
判断使用定长数组还是动态数组，如果是使用定长数组，则直接weak指针地址直接添加到数组即可，如果定长数组已经用尽，则需要将定长数组中的元素转存到动态数组中。
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中
size_t begin = w_hash_pointer(new_referrer) & (entry->mask);
size_t index = begin;
size_t hash_displacement = 0;
while (entry->referrers[index] != nil) {
hash_displacement++;
// index + 1, 移到下一个位置，再试一次能否插入。
index = (index+1) & entry->mask;
// index == begin 意味着数组绕了一圈都没有找到合适位置，这时候一定是出了什么问题。
if (index == begin) bad_weak_table(entry);
}
// 记录最大的hash冲突次数, max_hash_displacement意味着: 我们尝试至多max_hash_displacement次，肯定能够找到object对应的hash位置
if (hash_displacement > entry->max_hash_displacement) {
entry->max_hash_displacement = hash_displacement;
}
// 将ref存入hash数组，同时，更新元素个数num_refs
weak_referrer_t &ref = entry->referrers[index];
ref = new_referrer;
entry->num_refs++;
}
5.1 对象销毁dealloc
当对象的引用计数为0时，底层会调用_objc_rootDealloc方法对对象进行释放，而在_objc_rootDealloc方法里面会调用rootDealloc方法
void _objc_rootDealloc(id obj)
{
assert(obj);
obj->rootDealloc();
}
5.2 rootDealloc
inline void objc_object::rootDealloc()
{
//判断对象是否是 Tagged Pointer ，如果是则直接返回
if (isTaggedPointer()) return; // fixme necessary?
/*
对象是采用了优化的isa计数方式
没有被weak引用
没有关联对象
没有自定义的C++析构方法
没有用到SideTable来引用计数
则直接快速释放
*/
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);
}
}
5.3 object_dispose
//内部调用了objc_destructInstance方法
id object_dispose(id obj)
{
if (!obj) return nil;
objc_destructInstance(obj);
free(obj);
return nil;
}
5.4 objc_destructInstance
void *objc_destructInstance(id obj)
{
if (obj) {
// Read all of the flags at once for performance.
bool cxx = obj->hasCxxDtor();
bool assoc = obj->hasAssociatedObjects();
//有自定义的C++析构方法，则调用C++析构函数
if (cxx) object_cxxDestruct(obj);
//有关联对象，则移除关联对象并将其自身从Association Manager的map中移除
if (assoc) _object_remove_assocations(obj);
obj->clearDeallocating();
}
return obj;
}
5.5 clearDeallocating
inline void objc_object::clearDeallocating()
{
//判断对象是否采用了优化isa引用计数，如果没有的话则需要清理对象存储在SideTable中的引用计数数据
if (slowpath(!isa.nonpointer)) {
sidetable_clearDeallocating();
}
//判断是否使用SideTable的辅助引用计数(isa.has_sidetable_rc)或者有weak引用(isa.weakly_referenced)
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());
}
5.6 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();
}
5.7 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;
}
// 如果所存储的weak ptr没有weak 引用referent，这可能是由于runtime代码的逻辑错误引起的，报错
else if (*referrer) {
_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);
}