SideTables 是一個全局的 hash 表, 其中包含了一個數(shù)量為64的數(shù)組，數(shù)組中的存儲的為SideTable結(jié)構(gòu)體，其中通過對象內(nèi)存地址作為hash表的key
SideTable
從sideTables中取值的時候，先把傳入的地址指針右移4位異或地址指針右移9位，然后取余StripeCount，防止越界，根據(jù)index獲取sideTable
struct SideTable {
spinlock_t slock; //自旋鎖，防止多線程訪問沖突
RefcountMap refcnts; //用來存儲OC對象的引用計數(shù)的 hash表 (僅在未開啟isa優(yōu)化或在isa優(yōu)化情況下isa_t的引用計數(shù)溢出時才會用到)
weak_table_t weak_table; //存儲對象弱引用指針的 hash表
// 構(gòu)造函數(shù)
SideTable() {
memset(&weak_table, 0, sizeof(weak_table));
}
// 析構(gòu)函數(shù)
~SideTable() {
_objc_fatal("Do not delete SideTable.");
}
};
weak_table_t
weak_table_t 里面有一個二維數(shù)組weak_entries，這個數(shù)組里面存放的是weak_entry_t，weak_entry_t里面存放的是指向某個對象的weak指針地址，查找的時候通過key(對象)計算得到hash值去weak_entries中取，判斷是否是同一個對象，如果不是則index+1， 直到index == begin（繞了一圈）或超過了可能的hash沖突最大值，然后遍歷里面的數(shù)組，將所有的weak指針置為nil
struct weak_table_t {
// hash數(shù)組，用來存儲弱引用對象的相關(guān)信息weak_entry_t
weak_entry_t *weak_entries;
// hash數(shù)組中的元素個數(shù)
size_t num_entries;
// hash數(shù)組長度-1，會參與hash計算。（注意，這里是hash數(shù)組的長度，而不是元素個數(shù)。比如，數(shù)組長度可能是64，而元素個數(shù)僅存了2個）
uintptr_t mask;
// 可能會發(fā)生的hash沖突的最大次數(shù)，用于判斷是否出現(xiàn)了邏輯錯誤（hash表中的沖突次數(shù)絕不會超過改值）
uintptr_t max_hash_displacement;
};
weak_entry_t
在weak_entry_t的結(jié)構(gòu)定義中有聯(lián)合體，在聯(lián)合體的內(nèi)部有定長數(shù)組inline_referrers[WEAK_INLINE_COUNT]和動態(tài)數(shù)組weak_referrer_t *referrers兩種方式來存儲弱引用對象的指針地址。通過out_of_line這樣一個函數(shù)方法來判斷采用哪種存儲方式。當(dāng)弱引用該對象的指針數(shù)目小于等于WEAK_INLINE_COUNT時，使用定長數(shù)組。當(dāng)超過WEAK_INLINE_COUNT時，會將定長數(shù)組中的元素轉(zhuǎn)移到動態(tài)數(shù)組中，并之后都是用動態(tài)數(shù)組存儲
struct weak_entry_t {
DisguisedPtr<objc_object> referent;
// 引用該對象的對象列表，聯(lián)合。 引用個數(shù)小于4，用inline_referrers數(shù)組。 用個數(shù)大于4，用動態(tài)數(shù)組weak_referrer_t *referrers
union {
struct {
weak_referrer_t *referrers; // 弱引用該對象的對象指針地址的hash數(shù)組
uintptr_t out_of_line_ness : 2; // 是否使用動態(tài)hash數(shù)組標(biāo)記位
uintptr_t num_refs : PTR_MINUS_2; // hash數(shù)組中的元素個數(shù)
uintptr_t mask; //hash數(shù)組長度-1，會參與hash計算
uintptr_t max_hash_displacement; // 可能會發(fā)生的hash沖突的最大次數(shù)，用于判斷是否出現(xiàn)了邏輯錯誤（hash表中的沖突次數(shù)絕不會超過改值）
};
struct {
// out_of_line_ness field is low bits of inline_referrers[1]
weak_referrer_t inline_referrers[WEAK_INLINE_COUNT];
};
};
//判斷當(dāng)前的weak_entry_t是使用的定長數(shù)組還是動態(tài)數(shù)組。當(dāng)返回true，此時使用的動態(tài)數(shù)組，當(dāng)返回false，使用靜態(tài)數(shù)組
bool out_of_line() {
return (out_of_line_ness == REFERRERS_OUT_OF_LINE);
}
}
weak流程
1. 調(diào)用objc_initWeak
/*
Key(newObj)是所指對象的地址
Value(location)是weak指針的地址（這個地址的值是所指對象的地址）數(shù)組
當(dāng)weak指針的數(shù)量小于等于4時,是數(shù)組, 超過時,會變成hash表
*/
id objc_initWeak(id *location, id newObj)
{
if (!newObj) {
*location = nil;
return nil;
}
return storeWeak<DontHaveOld, DoHaveNew, DoCrashIfDeallocating>
(location, (objc_object*)newObj);
}
2. 調(diào)用storeWeak
storeWeak方法：
- storeWeak 方法實際上是接收了5個參數(shù)，分別是 haveOld、haveNew和crashIfDeallocating ，這三個參數(shù)都是以模板的方式傳入的，是三個bool類型的參數(shù)。分別表示weak指針之前是否指向了一個弱引用，weak指針是否需要指向一個新的引用，若果被弱引用的對象正在析構(gòu)，此時再弱引用該對象是否應(yīng)該crash。
- 該方法維護(hù)了 oldTable 和 newTable 分別表示舊的引用弱表和新的弱引用表，它們都是 SideTable 的hash表。
- 如果weak指針之前指向了一個弱引用，則會調(diào)用 weak_unregister_no_lock 方法將舊的weak指針地址移除。
- 如果weak指針需要指向一個新的引用，則會調(diào)用 weak_register_no_lock 方法將新的weak指針地址添加到弱引用表中。
- 調(diào)用 setWeaklyReferenced_nolock 方法修改weak新引用的對象的bit標(biāo)志位
這個方法中的重點是weak_unregister_no_lock和weak_register_no_lock這兩個方法，這兩個方法都是操作的SideTable結(jié)構(gòu)變量
template <HaveOld haveOld, HaveNew haveNew,
CrashIfDeallocating crashIfDeallocating>
static id storeWeak(id *location, objc_object *newObj)
{
/*
......
只保留關(guān)鍵代碼
*/
if (haveOld) {
//如果weak_ptr(指針)之前弱引用過別的對象oldObj，則調(diào)用weak_unregister_no_lock，在oldObj的weak_entry_t中移除該weak_ptr地址
weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);
}
// 如果weak_ptr需要弱引用新的對象newObj
if (haveNew) {
// 調(diào)用weak_register_no_lock方法，將weak ptr的地址記錄到newObj對應(yīng)的weak_entry_t中
newObj = (objc_object *)
weak_register_no_lock(&newTable->weak_table, (id)newObj, location,
crashIfDeallocating);
// 更新newObj的isa的weakly_referenced bit標(biāo)志位
if (newObj && !newObj->isTaggedPointer()) {
newObj->setWeaklyReferenced_nolock();
}
//*location 賦值，也就是將weak ptr直接指向了newObj?？梢钥吹?，這里并沒有將newObj的引用計數(shù)+1
*location = (id)newObj;
}
}
3. 調(diào)用weak_unregister_no_lock移除引用
如果weak指針之前指向了一個弱引用，則會調(diào)用weak_unregister_no_lock方法將舊的weak指針地址移除。
- 首先，它會在weak_table中找出referent對應(yīng)的weak_entry_t
- 在weak_entry_t中移除referrer
- 移除元素后，判斷此時weak_entry_t中是否還有元素 （empty==true？）
- 如果此時weak_entry_t已經(jīng)沒有元素了，則需要將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所對應(yīng)的weak_entry_t
if ((entry = weak_entry_for_referent(weak_table, referent))) {
// 在referent所對應(yīng)的weak_entry_t的hash數(shù)組中，移除referrer
remove_referrer(entry, referrer);
// 移除元素之后， 要檢查一下weak_entry_t的hash數(shù)組是否已經(jīng)空了
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數(shù)組已經(jīng)空了，則需要將weak_entry_t從weak_table中移除
if (empty) {
weak_entry_remove(weak_table, entry);
}
}
}
4.1 調(diào)用weak_register_no_lock
- 如果referent為nil 或 referent 采用了 TaggedPointer 計數(shù)方式，直接返回，不做任何操作。
- 如果對象正在析構(gòu)，則拋出異常。
- 如果對象不能被weak引用，直接返回nil。
- 如果對象沒有再析構(gòu)且可以被weak引用，則調(diào)用 weak_entry_for_referent 方法根據(jù)弱引用對象的地址從弱引用表中找到對應(yīng)的weak_entry，如果能夠找到則調(diào)用 append_referrer 方法向其中插入weak指針地址。否則新建一個weak_entry。
/*
weak_table: weak_table_t
referent_id: 對象
referrer_id: weak指針
crashIfDeallocating: 若果被弱引用的對象正在析構(gòu)，此時再弱引用該對象是否應(yīng)該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計數(shù)方式，直接返回，不做任何操作
if (!referent || referent->isTaggedPointer()) return referent_id;
// 確保被引用的對象可用（沒有在析構(gòu)，同時應(yīng)該支持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);
}
// 正在析構(gòu)的對象，不能夠被弱引用
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對應(yīng)的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++;
// 當(dāng)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添加元素
判斷使用定長數(shù)組還是動態(tài)數(shù)組，如果是使用定長數(shù)組，則直接weak指針地址直接添加到數(shù)組即可，如果定長數(shù)組已經(jīng)用盡，則需要將定長數(shù)組中的元素轉(zhuǎn)存到動態(tài)數(shù)組中。
static void append_referrer(weak_entry_t *entry, objc_object **new_referrer)
{
// 如果weak_entry 尚未使用動態(tài)數(shù)組
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的位置已經(jīng)存滿了，則要轉(zhuǎn)型為referrers，做動態(tài)數(shù)組
// 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());
// 如果動態(tài)數(shù)組中元素個數(shù)大于或等于數(shù)組位置總空間的3/4，則擴(kuò)展數(shù)組空間為當(dāng)前長度的一倍
if (entry->num_refs >= TABLE_SIZE(entry) * 3/4) {
// 擴(kuò)容，并插入
return grow_refs_and_insert(entry, new_referrer);
}
// 如果不需要擴(kuò)容，直接插入到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 意味著數(shù)組繞了一圈都沒有找到合適位置，這時候一定是出了什么問題。
if (index == begin) bad_weak_table(entry);
}
// 記錄最大的hash沖突次數(shù), max_hash_displacement意味著: 我們嘗試至多max_hash_displacement次，肯定能夠找到object對應(yīng)的hash位置
if (hash_displacement > entry->max_hash_displacement) {
entry->max_hash_displacement = hash_displacement;
}
// 將ref存入hash數(shù)組，同時，更新元素個數(shù)num_refs
weak_referrer_t &ref = entry->referrers[index];
ref = new_referrer;
entry->num_refs++;
}
5.1 對象銷毀dealloc
當(dāng)對象的引用計數(shù)為0時，底層會調(diào)用_objc_rootDealloc方法對對象進(jìn)行釋放，而在_objc_rootDealloc方法里面會調(diào)用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?
/*
對象是采用了優(yōu)化的isa計數(shù)方式
沒有被weak引用
沒有關(guān)聯(lián)對象
沒有自定義的C++析構(gòu)方法
沒有用到SideTable來引用計數(shù)
則直接快速釋放
*/
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
//內(nèi)部調(diào)用了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++析構(gòu)方法，則調(diào)用C++析構(gòu)函數(shù)
if (cxx) object_cxxDestruct(obj);
//有關(guān)聯(lián)對象，則移除關(guān)聯(lián)對象并將其自身從Association Manager的map中移除
if (assoc) _object_remove_assocations(obj);
obj->clearDeallocating();
}
return obj;
}
5.5 clearDeallocating
inline void objc_object::clearDeallocating()
{
//判斷對象是否采用了優(yōu)化isa引用計數(shù)，如果沒有的話則需要清理對象存儲在SideTable中的引用計數(shù)數(shù)據(jù)
if (slowpath(!isa.nonpointer)) {
sidetable_clearDeallocating();
}
//判斷是否使用SideTable的輔助引用計數(shù)(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，找到對應(yīng)的SideTable
SideTable& table = SideTables()[this];
table.lock();
// 如果obj被弱引用
if (isa.weakly_referenced) {
// 在SideTable的weak_table中對this進(jìn)行清理工作
weak_clear_no_lock(&table.weak_table, (id)this);
}
// 如果采用了SideTable做引用計數(shù)
if (isa.has_sidetable_rc) {
// 在SideTable的引用計數(shù)中移除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中對應(yīng)的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 指針地址數(shù)組以及數(shù)組長度
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設(shè)置為nil，這也就是為什么weak 指針會自動設(shè)置為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);
}
