runtime 對 __weak 弱引用處理方式
切入主題，這裡筆者使用的 runtime 版本為 objc4-680.tar.gz。 我在入口檔案 main.m 中加入如下程式碼：
|
1 2 3 4 5 6 7 8 |
int main(int argc, const char * argv[]) { @autoreleasepool { // insert code here... NSObject *p = [[NSObject alloc] init]; __weak NSObject *p1 = p; } return 0; } |
單步執行，發現會跳入 NSObject.mm 中的 objc_initWeak() 這個方法。在進行編譯過程前，clang 其實對 __weak 做了轉換，將宣告方式做出瞭如下調整。
|
1 |
NSObject objc_initWeak(&p, 物件指標); |
其中的物件指標，就是程式碼中的 [[NSObject alloc] init] ，而 p 是我們傳入的一個弱引用指標。而對於 objc_initWeak() 方法的實現，在 runtime 中的原始碼如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 |
id objc_initWeak(id *location, id newObj) { // 檢視物件例項是否有效 // 無效物件直接導致指標釋放 if (!newObj) { *location = nil; return nil; } // 這裡傳遞了三個 bool 數值 // 使用 template 進行常量引數傳遞是為了優化效能 return storeWeakfalse/*old*/, true/*new*/, true/*crash*/> (location, (objc_object*)newObj); } |
可以看出，這個函式僅僅是一個深層函式的呼叫入口，而一般的入口函式中，都會做一些簡單的判斷（例如 objc_msgSend 中的快取判斷），這裡判斷了其指標指向的類物件是否有效，無效直接釋放，不再往深層呼叫函式。
需要注意的是，當修改弱引用的變數時，這個方法非執行緒安全。所以切記選擇競爭帶來的一些問題。
繼續閱讀 objc_storeWeak() 的實現：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
// 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; } |
其中標註的一些要點，開始逐一介紹：
引用計數和弱引用依賴表 SideTable
SideTable 這個結構體，我給他起名引用計數和弱引用依賴表，因為它主要用於管理物件的引用計數和 weak 表。在 NSObject.mm 中宣告其資料結構：
|
1 2 3 4 5 6 7 8 |
struct SideTable { // 保證原子操作的自旋鎖 spinlock_t slock; // 引用計數的 hash 表 RefcountMap refcnts; // weak 引用全域性 hash 表 weak_table_t weak_table; } |
在之前的 runtime 版本中，有一個較為重要的成員方法，用來根據物件的地址在快取中取出對應的 SideTable 例項：
|
1 |
static SideTable *tableForPointer(const void *p); |
而在上面 objc_storeWeak 方法中，取出例項的方法變成了 &SideTables()[xxxObj]; 這種方式。檢視方法的實現，發現瞭如下函式：
|
1 2 3 |
static StripedMapSideTable>& SideTables() { return *reinterpret_castStripedMapSideTable>*>(SideTableBuf); } |
在取出例項方法的實現中，使用了 C++ 標準轉換運算子 reinterpret_cast ，其表達方式為：
|
1 |
reinterpret_cast new_type> (expression) |
用來處理無關型別之間的轉換。該關鍵字會產生一個新值，並保證與原引數（expression）擁有完全相同的位元位。
而 StripedMap 是一個模板類（Template Class），通過傳入類（結構體）引數，會動態修改在該類中的一個 array 成員儲存的元素型別，並且其中提供了一個針對於地址的 hash 演算法，用作儲存 key。可以說， StripedMap 提供了一套擁有將地址作為 key 的 hash table 解決方案，而該方案採用了模板類，是擁有泛型性的。
介紹了與物件相關聯的 SideTable 檢索方式，再來看 SideTable 的成員和作用。
對於 slock 和 refcnts 兩個成員不用多說，第一個是為了防止競爭選擇的自旋鎖，第二個是協助物件的 isa 指標的 extra_rc 共同引用計數的變數（對於物件結果，在今後的文中提到）。這裡主要看 weak 全域性 hash 表的結構與作用。
|
1 2 3 4 5 6 7 8 9 10 |
struct weak_table_t { // 儲存了所有指向指定物件的 weak 指標 weak_entry_t *weak_entries; // 儲存空間 size_t num_entries; // 參與判斷引用計數輔助量 uintptr_t mask; // hash key 最大偏移值 uintptr_t max_hash_displacement; }; |
這是一個全域性弱引用表。使用不定型別物件的地址作為 key ，用 weak_entry_t 型別結構體物件作為 value 。其中的 weak_entries 成員，從字面意思上看，即為弱引用表入口。其實現也是這樣的。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
typedef objc_object ** weak_referrer_t; struct weak_entry_t { DisguisedPtrobjc_object> referent; union { struct { weak_referrer_t *referrers; uintptr_t out_of_line : 1; uintptr_t num_refs : PTR_MINUS_1; uintptr_t mask; uintptr_t max_hash_displacement; }; struct { // out_of_line=0 is LSB of one of these (don't care which) weak_referrer_t inline_referrers[WEAK_INLINE_COUNT]; }; } |
在 weak_entry_t 的結構中，DisguisedPtr referent 是對泛型物件的指標做了一個封裝，通過這個泛型類來解決記憶體洩漏的問題。從註釋中寫 out_of_line 成員為最低有效位，當其為0的時候， weak_referrer_t 成員將擴充套件為多行靜態 hash table。其實其中的 weak_referrer_t 是二維 objc_object 的別名，通過一個二維指標地址偏移，用下標作為 hash 的 key，做成了一個弱引用雜湊。
那麼在有效位未生效的時候，out_of_line 、 num_refs、 mask 、 max_hash_displacement 有什麼作用？以下是筆者自身的猜測：
- out_of_line：最低有效位，也是標誌位。當標誌位 0 時，增加引用表指標緯度。
- num_refs：引用數值。這裡記錄弱引用表中引用有效數字，因為弱引用表使用的是靜態 hash 結構，所以需要使用變數來記錄數目。
- mask：計數輔助量。
- max_hash_displacement：hash 元素上限閥值。
其實 out_of_line 的值通常情況下是等於零的，所以弱引用表總是一個 objc_objective 指標二維陣列。一維 objc_objective 指標可構成一張弱引用雜湊表，通過第三緯度實現了多張雜湊表，並且表數量為 WEAK_INLINE_COUNT 。
總結一下 StripedMap[] ： StripedMap 是一個模板類，在這個類中有一個 array 成員，用來儲存 PaddedT 物件，並且其中對於 [] 符的過載定義中，會返回這個 PaddedT 的 value 成員，這個 value 就是我們傳入的 T 泛型成員，也就是 SideTable 物件。在 array 的下標中，這裡使用了 indexForPointer 方法通過位運算計算下標，實現了靜態的 Hash Table。而在 weak_table 中，其成員 weak_entry 會將傳入物件的地址加以封裝起來，並且其中也有訪問全域性弱引用表的入口。
舊物件解除註冊操作 weak_unregister_no_lock
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
#define WEAK_INLINE_COUNT 4 void weak_unregister_no_lock(weak_table_t *weak_table, id referent_id, id *referrer_id) { // 在入口方法中，傳入了 weak_table 弱引用表，referent_id 舊物件以及 referent_id 舊物件對應的地址 // 用指標去訪問 oldObj 和 *location objc_object *referent = (objc_object *)referent_id; objc_object **referrer = (objc_object **)referrer_id; weak_entry_t *entry; // 如果其物件為 nil，無需取消註冊 if (!referent) return; // weak_entry_for_referent 根據首物件查詢 weak_entry if ((entry = weak_entry_for_referent(weak_table, referent))) { // 通過地址來解除引用關聯 remove_referrer(entry, referrer); bool empty = true; // 檢測 out_of_line 位的情況 // 檢測 num_refs 位的情況 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; } } } // 從弱引用的 zone 表中刪除 if (empty) { weak_entry_remove(weak_table, entry); } } // 這裡不會設定 *referrer = nil，因為 objc_storeWeak() 函式會需要該指標 } |
該方法主要作用是將舊物件在 weak_table 中接觸 weak 指標的對應繫結。根據函式名，稱之為解除註冊操作。從原始碼中，可以知道其功能就是從 weak_table 中接觸 weak 指標的繫結。而其中的遍歷查詢，就是針對於 weak_entry 中的多張弱引用雜湊表。
新物件新增註冊操作 weak_register_no_lock
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
id weak_register_no_lock(weak_table_t *weak_table, id referent_id, id *referrer_id, bool crashIfDeallocating) { // 在入口方法中，傳入了 weak_table 弱引用表，referent_id 舊物件以及 referent_id 舊物件對應的地址 // 用指標去訪問 oldObj 和 *location objc_object *referent = (objc_object *)referent_id; objc_object **referrer = (objc_object **)referrer_id; // 檢測物件是否生效、以及是否使用了 tagged pointer 技術 if (!referent || referent->isTaggedPointer()) return referent_id; // 保證引用物件是否有效 // hasCustomRR 方法檢查類（包括其父類）中是否含有預設的方法 bool deallocating; if (!referent->ISA()->hasCustomRR()) { // 檢查 dealloc 狀態 deallocating = referent->rootIsDeallocating(); } else { // 會返回 referent 的 SEL_allowsWeakReference 方法的地址 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); } // 由於 dealloc 導致 crash ，並輸出日誌 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; } } // 記錄並儲存對應引用表 weak_entry weak_entry_t *entry; // 對於給定的弱引用查詢 weak_table if ((entry = weak_entry_for_referent(weak_table, referent))) { // 增加弱引用表於附加物件上 append_referrer(entry, referrer); } else { // 自行建立弱引用表 weak_entry_t new_entry; new_entry.referent = referent; new_entry.out_of_line = 0; new_entry.inline_referrers[0] = referrer; for (size_t i = 1; i WEAK_INLINE_COUNT; i++) { new_entry.inline_referrers[i] = nil; } // 如果給定的弱引用表滿容，進行自增長 weak_grow_maybe(weak_table); // 向物件新增弱引用表關聯，不進行檢查直接修改指標指向 weak_entry_insert(weak_table, &new_entry); } // 這裡不會設定 *referrer = nil，因為 objc_storeWeak() 函式會需要該指標 return referent_id; } |
這一步與上一步相反，通過 weak_register_no_lock 函式把心的物件進行註冊操作，完成與對應的弱引用表進行繫結操作。
初始化弱引用物件流程一覽
弱引用的初始化，從上文的分析中可以看出，主要的操作部分就在弱引用表的取鍵、查詢雜湊、建立弱引用表等操作，可以總結出如下的流程圖：
這個圖中省略了很多情況的判斷，但是當宣告一個 __weak 會呼叫上圖中的這些方法。當然， storeWeak 方法不僅僅用在 __weak 的宣告中，在 class 內部的操作中也會常常通過該方法來對 weak 物件進行操作。
以上就是對於 weak 弱引用物件的初始化時 runtime 內部的執行過程，想必閱讀後會對其結構有更深的理解。