
我們都知道 weak 表示一個弱引用:它不會增加物件的參考計數,並且一旦所指向的物件被釋放,weak 指標會被自動設為 nil。弱引用通常用來處理循環參考的問題,例如 delegate 與 block 的場合就經常會用到 weak。
過去我對 weak 的實作只有粗略了解,知道它大致的生命週期,但細節始終不夠清楚。今天又翻了翻《Objective-C 高級編程》中關於 __weak 的說明,就在此做個筆記。
我們以這行程式碼為例:
程式碼清單 1:示例程式碼
{
id __weak obj1 = obj;
}當我們初始化一個 weak 變數時,執行期會呼叫 objc_initWeak 函數。它在 Clang 中的宣告如下:
id objc_initWeak(id *object, id value);
實作內容是:
id objc_initWeak(id *object, id value) {
*object = 0;
return objc_storeWeak(object, value);
}示例程式碼換算成編譯器的模擬程式碼就是:
id obj1; objc_initWeak(&obj1, obj);
也就是說,這裡先把 obj1 初始化為 0(nil),然後把 obj1 的位址與 obj 一起當參數傳給 objc_storeWeak。
objc_initWeak 有一個前提條件:object 必須是一個尚未被註冊為 __weak 物件的有效指標;而 value 可以是 null,也可以指向一個有效物件。
如果 value 是空指標,或它指向的物件已被釋放,那麼 object 會被零初始化。否則,object 會被註冊為指向 value 的 __weak 物件。而這件事,正是 objc_storeWeak 負責的。它的宣告如下:
id objc_storeWeak(id *location, id value);
實作如下:
id objc_storeWeak(id *location, id newObj) {
id oldObj;
SideTable *oldTable;
SideTable *newTable;
......
// Acquire locks for old and new values.
// Order by lock address to prevent lock ordering problems.
// Retry if the old value changes underneath us.
retry:
oldObj = *location;
oldTable = SideTable::tableForPointer(oldObj);
newTable = SideTable::tableForPointer(newObj);
......
if (*location != oldObj) {
OSSpinLockUnlock(lock1);
#if SIDE_TABLE_STRIPE > 1
if (lock1 != lock2) OSSpinLockUnlock(lock2);
#endif
goto retry;
}
if (oldObj) {
weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);
}
if (newObj) {
newObj = weak_register_no_lock(&newTable->weak_table, newObj, location);
// weak_register_no_lock returns NULL if weak store should be rejected
}
// Do not set *location anywhere else. That would introduce a race.
*location = newObj;
......
return newObj;
}先撇開程式碼裡各種鎖操作,看看這段程式碼究竟做了什麼。在那之前,我們得先認識 weak 表與 SideTable。
weak 表是一個弱引用表,實作為 weak_table_t 結構體,存放某個物件相關的所有弱引用資訊。定義如下(位於 objc-weak.h):
struct weak_table_t {
weak_entry_t *weak_entries;
size_t num_entries;
......
};其中 weak_entry_t 是存在弱引用表中的內部結構體,負責維護並存放指向同一物件的所有弱引用的雜湊表。定義如下:
struct weak_entry_t {
DisguisedPtr referent;
union {
struct {
weak_referrer_t *referrers;
uintptr_t out_of_line : 1;
......
};
struct {
// out_of_line=0 is LSB of one of these (don't care which)
weak_referrer_t inline_referrers[WEAK_INLINE_COUNT];
};
};
};其中 referent 是被引用的物件,也就是示例程式碼裡的 obj。下面的 union 存放了所有指向該物件的弱引用。從註解可以看到,當 out_of_line 等於 0 時,雜湊表會以一維陣列取代。另外,所有弱引用物件的位址都存放在 weak_referrer_t 指標所指的位置。其定義如下:
typedef objc_object ** weak_referrer_t;
SideTable 是一個以 C++ 實作的類別,定義在 NSObject.mm 中。來看看它的一些成員變數:
class SideTable {
private:
static uint8_t table_buf[SIDE_TABLE_STRIPE * SIDE_TABLE_SIZE];
public:
RefcountMap refcnts;
weak_table_t weak_table;
......
}RefcountMap refcnts——大概猜得到它是做什麼的吧?看名字就像跟參考計數有關。沒錯,它存的就是一個物件的參考計數資訊。這裡我們不深入探討,重點是 weak_table,這個成員指向的就是一個物件的 weak 表。
搞懂 weak 表與 SideTable 之後,回過頭看 objc_storeWeak。首先根據 weak 指標找到它原本指向的舊物件:
oldObj = *location;
接著取得與新舊物件相關的 SideTable 物件:
oldTable = SideTable::tableForPointer(oldObj); newTable = SideTable::tableForPointer(newObj);
接下來要做的,是從舊物件的 weak 表中移除關聯資訊,並在新物件的 weak 表中建立關聯:
if (oldObj) {
weak_unregister_no_lock(&oldTable->weak_table, oldObj, location);
}
if (newObj) {
newObj = weak_register_no_lock(&newTable->weak_table, newObj, location);
// weak_register_no_lock returns NULL if weak store should be rejected
}然後讓弱引用指標指向新物件:
*location = newObj;
最後回傳這個新物件:
return newObj;
objc_storeWeak 的基本實作就是這樣。當然,objc_initWeak 呼叫 objc_storeWeak 時舊物件是空的,所以不會執行 weak_unregister_no_lock。
那麼,當 weak 引用指向的物件被釋放時,weak 指標又是怎麼被處理的?釋放物件的基本流程如下:
呼叫 objc_release
因為參考計數為 0,執行 dealloc
在 dealloc 中呼叫 _objc_rootDealloc 函數
在 _objc_rootDealloc 中呼叫 object_dispose 函數
呼叫 objc_destructInstance
最後呼叫 objc_clear_deallocating
我們把注意力放在最後一步。objc_clear_deallocating 的實作如下:
void objc_clear_deallocating(id obj) {
......
SideTable *table = SideTable::tableForPointer(obj);
// clear any weak table items
// clear extra retain count and deallocating bit
// (fixme warn or abort if extra retain count == 0 ?)
OSSpinLockLock(&table->slock);
if (seen_weak_refs) {
arr_clear_deallocating(&table->weak_table, obj);
}
......
}可以看到,這個函數先取出物件對應的 SideTable 實例;如果這個物件有相關的弱引用,就呼叫 arr_clear_deallocating 清除弱引用資訊。來看 arr_clear_deallocating 的實作:
PRIVATE_EXTERN void arr_clear_deallocating(weak_table_t *weak_table, id referent) {
{
weak_entry_t *entry = weak_entry_for_referent(weak_table, referent);
if (entry == NULL) {
......
return;
}
// zero out references
for (int i = 0; i < entry->referrers.num_allocated; ++i) {
id *referrer = entry->referrers.refs[i].referrer;
if (referrer) {
if (*referrer == referent) {
*referrer = nil;
}
else if (*referrer) {
_objc_inform("__weak variable @ %p holds %p instead of %p\n", referrer, *referrer, referent);
}
}
}
weak_entry_remove_no_lock(weak_table, entry);
weak_table->num_weak_refs--;
}
}這個函數先找出物件對應的 weak_entry_t 鏈表,然後逐一把弱引用設為 nil,最後清掉該物件在表中的記錄。
看完這些,我們大致能理解一個 weak 引用從生到死的完整過程。從流程中不難發現,weak 引用的處理牽涉到各種查表、新增與刪除操作,確實有一定成本。因此大量使用 __weak 變數時,對效能會造成影響。那究竟什麼時候該用 weak 呢?《Objective-C 高級編程》給出的建議是:只在避免循環引用時使用 __weak 修飾符。
另外,Clang 還提供了不少處理 weak 引用的函數,例如 objc_loadWeak、objc_destroyWeak、objc_moveWeak 等,我們可以在 Apple 的開源程式碼中找到相關實作。之後有空再好好研究。
參考
《Objective-C 高級編程》1.4:__weak 修飾符
Clang 3.7 documentation – Objective-C Automatic Reference Counting (ARC)
apple opensource – NSObject.mm