前言
大家都知道砸民,weak 關(guān)鍵字的作用 弱引用,所引用對(duì)象的計(jì)數(shù)器不會(huì)加一各谚,并在引用對(duì)象被釋放的時(shí)候自動(dòng)被設(shè)置為nil,能避免錯(cuò)誤的內(nèi)存訪問(wèn)侮腹,通常用于解決循環(huán)引用問(wèn)題。很少有人知道weak表其實(shí)是一個(gè)
hash(哈希)表
稻励,Key是所指對(duì)象的地址
父阻,Value是weak指針的地址數(shù)組
。那么weak的原理是什么呢望抽?下面就分析一下weak的工作原理加矛。
weak 實(shí)現(xiàn)原理的概括
Runtime
維護(hù)了一個(gè)weak表
,用于存儲(chǔ)指向某個(gè)對(duì)象的所有weak指針煤篙。weak表其實(shí)是一個(gè)hash(哈希)表斟览,Key是所指對(duì)象的地址,Value是weak指針的地址(這個(gè)地址的值是所指對(duì)象指針的地址)數(shù)組辑奈。
在runtime源碼
中苛茂,可以找到'objc-weak.h'
和‘objc-weak.mm’
文件,并且在objc-weak.h文件中關(guān)于定義weak表的結(jié)構(gòu)體以及相關(guān)的方法鸠窗。iOS上關(guān)于Runtime的源碼其實(shí)就是objc4
妓羊,我們?cè)?a target="_blank">objc4源碼上能看到最新版本為objc-750
。
weak 的實(shí)現(xiàn)原理可以概括一下三步:
1稍计、初始化時(shí):runtime會(huì)調(diào)用objc_initWeak函數(shù)躁绸,初始化一個(gè)新的weak指針指向?qū)ο蟮牡刂贰?br>
2、添加引用時(shí):objc_initWeak函數(shù)會(huì)調(diào)用 objc_storeWeak() 函數(shù)臣嚣, objc_storeWeak() 的作用是更新指針指向净刮,創(chuàng)建對(duì)應(yīng)的弱引用表。
3硅则、釋放時(shí)淹父,調(diào)用clearDeallocating函數(shù)。clearDeallocating函數(shù)首先根據(jù)對(duì)象地址獲取所有weak指針地址的數(shù)組怎虫,然后遍歷這個(gè)數(shù)組把其中的數(shù)據(jù)設(shè)為nil弹灭,最后把這個(gè)entry從weak表中刪除,最后清理對(duì)象的記錄揪垄。
下面將開始詳細(xì)介紹每一步:
1穷吮、初始化時(shí):runtime會(huì)調(diào)用objc_initWeak函數(shù),objc_initWeak函數(shù)會(huì)初始化一個(gè)新的weak指針指向?qū)ο蟮牡刂贰?/strong>
示例代碼:
Person *object = [Person alloc];
id __weak objc = object;
如果在此打斷點(diǎn)跟蹤匯編信息饥努,可以發(fā)現(xiàn)底層庫(kù)調(diào)了objc_initWeak
函數(shù)
當(dāng)我們初始化一個(gè)weak變量時(shí)捡鱼,runtime會(huì)調(diào)用 NSObject.mm 中的objc_initWeak函數(shù)。如下是objc_initWeak方法的底層源碼
id objc_initWeak(id *location, id newObj)
{
// 查看對(duì)象實(shí)例是否有效
// 無(wú)效對(duì)象直接導(dǎo)致指針釋放
if (!newObj) {
*location = nil;
return nil;
}
// 這里傳遞了三個(gè) bool 數(shù)值
// 使用 template 進(jìn)行常量參數(shù)傳遞是為了優(yōu)化性能
return storeWeak<DontHaveOld, DoHaveNew, DoCrashIfDeallocating>
(location, (objc_object*)newObj);
}
// Template parameters.
enum HaveOld { DontHaveOld = false, DoHaveOld = true };
enum HaveNew { DontHaveNew = false, DoHaveNew = true };
enum CrashIfDeallocating {
DontCrashIfDeallocating = false, DoCrashIfDeallocating = true
};
可以看出酷愧,這個(gè)函數(shù)僅僅是一個(gè)深層函數(shù)的調(diào)用入口驾诈,而一般的入口函數(shù)中缠诅,都會(huì)做一些簡(jiǎn)單的判斷(例如 objc_msgSend 中的緩存判斷),這里判斷了其指針指向的類對(duì)象是否有效乍迄,無(wú)效直接釋放管引,不再往深層調(diào)用函數(shù)。否則闯两,object將被注冊(cè)為一個(gè)指向value的__weak對(duì)象褥伴。而這事應(yīng)該是objc_storeWeak函數(shù)干的。
注意:objc_initWeak函數(shù)有一個(gè)前提條件:就是object必須是一個(gè)沒(méi)有被注冊(cè)為__weak對(duì)象的有效指針漾狼。而value則可以是null重慢,或者指向一個(gè)有效的對(duì)象。
2逊躁、添加引用時(shí):objc_initWeak函數(shù)會(huì)調(diào)用 objc_storeWeak() 函數(shù)似踱, objc_storeWeak() 的作用是更新指針指向,創(chuàng)建對(duì)應(yīng)的弱引用表稽煤。
objc_storeWeak的函數(shù)聲明如下:
id objc_storeWeak(id *location, id value);
objc_storeWeak() 的具體實(shí)現(xiàn)如下:
// HaveOld: true - 變量有值
// false - 需要被及時(shí)清理核芽,當(dāng)前值可能為 nil
// HaveNew: true - 需要被分配的新值,當(dāng)前值可能為 nil
// false - 不需要分配新值
// CrashIfDeallocating: true - 說(shuō)明 newObj 已經(jīng)釋放或者 newObj 不支持弱引用酵熙,該過(guò)程需要暫停
// false - 用 nil 替代存儲(chǔ)
template bool HaveOld, bool HaveNew, bool CrashIfDeallocating>
static id storeWeak(id *location, objc_object *newObj) {
// 該過(guò)程用來(lái)更新弱引用指針的指向
// 初始化 previouslyInitializedClass 指針
Class previouslyInitializedClass = nil;
id oldObj;
// 聲明兩個(gè) SideTable
// ① 新舊散列創(chuàng)建
SideTable *oldTable;
SideTable *newTable;
// 獲得新值和舊值的鎖存位置(用地址作為唯一標(biāo)示)
// 通過(guò)地址來(lái)建立索引標(biāo)志狞洋,防止桶重復(fù)
// 下面指向的操作會(huì)改變舊值
retry:
if (HaveOld) {
// 更改指針,獲得以 oldObj 為索引所存儲(chǔ)的值地址
oldObj = *location;
oldTable = &SideTables()[oldObj];
} else {
oldTable = nil;
}
if (HaveNew) {
// 更改新值指針绿店,獲得以 newObj 為索引所存儲(chǔ)的值地址
newTable = &SideTables()[newObj];
} else {
newTable = nil;
}
// 加鎖操作吉懊,防止多線程中競(jìng)爭(zhēng)沖突
SideTable::lockTwoHaveOld, HaveNew>(oldTable, newTable);
// 避免線程沖突重處理
// location 應(yīng)該與 oldObj 保持一致,如果不同假勿,說(shuō)明當(dāng)前的 location 已經(jīng)處理過(guò) oldObj 可是又被其他線程所修改
if (HaveOld && *location != oldObj) {
SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);
goto retry;
}
// 防止弱引用間死鎖
// 并且通過(guò) +initialize 初始化構(gòu)造器保證所有弱引用的 isa 非空指向
if (HaveNew && newObj) {
// 獲得新對(duì)象的 isa 指針
Class cls = newObj->getIsa();
// 判斷 isa 非空且已經(jīng)初始化
if (cls != previouslyInitializedClass &&
!((objc_class *)cls)->isInitialized()) {
// 解鎖
SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);
// 對(duì)其 isa 指針進(jìn)行初始化
_class_initialize(_class_getNonMetaClass(cls, (id)newObj));
// 如果該類已經(jīng)完成執(zhí)行 +initialize 方法是最理想情況
// 如果該類 +initialize 在線程中
// 例如 +initialize 正在調(diào)用 storeWeak 方法
// 需要手動(dòng)對(duì)其增加保護(hù)策略借嗽,并設(shè)置 previouslyInitializedClass 指針進(jìn)行標(biāo)記
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
// 在引用計(jì)數(shù)表中設(shè)置若引用標(biāo)記位
if (newObj && !newObj->isTaggedPointer()) {
// 弱引用位初始化操作
// 引用計(jì)數(shù)那張散列表的weak引用對(duì)象的引用計(jì)數(shù)中標(biāo)識(shí)為weak引用
newObj->setWeaklyReferenced_nolock();
}
// 之前不要設(shè)置 location 對(duì)象,這里需要更改指針指向
*location = (id)newObj;
}
else {
// 沒(méi)有新值转培,則無(wú)需更改
}
SideTable::unlockTwoHaveOld, HaveNew>(oldTable, newTable);
return (id)newObj;
}
撇開源碼中各種鎖操作恶导,來(lái)看看這段代碼都做了些什么。
SideTables
SideTables可以理解為一個(gè) 全局的hash數(shù)組浸须,里面存儲(chǔ)了 SideTable 類型的數(shù)據(jù)惨寿,其長(zhǎng)度為64。
SideTabls可以通過(guò)全局的靜態(tài)函數(shù)獲壬局稀:
static StripedMap<SideTable>& SideTables() {
return *reinterpret_cast<StripedMap<SideTable>*>(SideTableBuf);
}
1)裂垦、SideTable
SideTable 這個(gè)結(jié)構(gòu)體,我給他起名引用計(jì)數(shù)和弱引用依賴表肌索,因?yàn)樗饕糜诠芾韺?duì)象的引用計(jì)數(shù)和 weak 表蕉拢。在 NSObject.mm 中聲明其數(shù)據(jù)結(jié)構(gòu):
struct SideTable {
// 保證原子操作的自旋鎖
spinlock_t slock;
// 引用計(jì)數(shù)的 hash 表
RefcountMap refcnts;
// weak 引用全局 hash 表
weak_table_t weak_table;
}
對(duì)于 slock 和 refcnts 兩個(gè)成員不用多說(shuō),第一個(gè)是為了防止競(jìng)爭(zhēng)選擇的自旋鎖,第二個(gè)是協(xié)助對(duì)象的 isa 指針的 extra_rc 共同引用計(jì)數(shù)的變量(對(duì)于對(duì)象結(jié)果晕换,在今后的文中提到)午乓。這里主要看 weak 全局 hash 表的結(jié)構(gòu)與作用。
重點(diǎn)來(lái)了,weak_table_t weak_table
用來(lái)存儲(chǔ)OC對(duì)象弱引用的相關(guān)信息。我們知道尚洽,SideTables一共只有64個(gè)節(jié)點(diǎn),而在我們的APP中蒸其,一般都會(huì)不只有64個(gè)對(duì)象,因此瘾英,多個(gè)對(duì)象一定會(huì) 重用同一個(gè)SideTable節(jié)點(diǎn) 枣接,也就是說(shuō)颂暇,一個(gè)weak_table會(huì)存儲(chǔ) 多個(gè)對(duì)象的弱引用信息缺谴。因此在一個(gè)SideTable中,又會(huì)通過(guò) weak_table 作為hash表再次分散存儲(chǔ)每一個(gè)對(duì)象的弱引用信息耳鸯。
weak表是一個(gè)弱引用表湿蛔,實(shí)現(xiàn)為一個(gè)weak_table_t結(jié)構(gòu)體,存儲(chǔ)了某個(gè)對(duì)象相關(guān)的的所有的弱引用信息县爬。其定義如下(具體定義在objc-weak.h中):
struct weak_table_t {
// 保存了所有指向指定對(duì)象的 weak 指針
weak_entry_t *weak_entries;
// 存儲(chǔ)空間
size_t num_entries;
// 參與判斷引用計(jì)數(shù)輔助量
uintptr_t mask;
// hash key 最大偏移值
uintptr_t max_hash_displacement;
};
這是一個(gè) 全局弱引用hash表阳啥。使用不定類型對(duì)象的地址作為 key ,用 weak_entry_t 類型結(jié)構(gòu)體對(duì)象作為 value 财喳。其中的 weak_entries 成員察迟,從字面意思上看,即為弱引用表入口耳高。其實(shí)現(xiàn)也是這樣的扎瓶。
其中weak_entry_t是存儲(chǔ)在弱引用表中的一個(gè)內(nèi)部結(jié)構(gòu)體,它負(fù)責(zé)維護(hù)和存儲(chǔ)指向一個(gè)對(duì)象的所有弱引用hash表泌枪。其定義如下:
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 的結(jié)構(gòu)中概荷,DisguisedPtr referent 是對(duì)泛型對(duì)象的指針做了一個(gè)封裝,通過(guò)這個(gè)泛型類來(lái)解決內(nèi)存泄漏的問(wèn)題碌燕。從注釋中寫 out_of_line 成員為最低有效位误证,當(dāng)其為0的時(shí)候, weak_referrer_t 成員將擴(kuò)展為多行靜態(tài) hash table修壕。其實(shí)其中的 weak_referrer_t 是二維 objc_object 的別名愈捅,通過(guò)一個(gè)二維指針地址偏移,用下標(biāo)作為 hash 的 key慈鸠,做成了一個(gè)弱引用散列改鲫。
那么在有效位未生效的時(shí)候,out_of_line 、 num_refs像棘、 mask 稽亏、 max_hash_displacement 有什么作用?以下是筆者自身的猜測(cè):
out_of_line:最低有效位缕题,也是標(biāo)志位截歉。當(dāng)標(biāo)志位 0 時(shí),增加引用表指針緯度烟零。
num_refs:引用數(shù)值瘪松。這里記錄弱引用表中引用有效數(shù)字,因?yàn)槿跻帽硎褂玫氖庆o態(tài) hash 結(jié)構(gòu)锨阿,所以需要使用變量來(lái)記錄數(shù)目宵睦。
mask:計(jì)數(shù)輔助量。
max_hash_displacement:hash 元素上限閥值墅诡。
其實(shí) out_of_line 的值通常情況下是等于零的壳嚎,所以弱引用表總是一個(gè) objc_objective 指針二維數(shù)組。一維 objc_objective 指針可構(gòu)成一張弱引用散列表末早,通過(guò)第三緯度實(shí)現(xiàn)了多張散列表烟馅,并且表數(shù)量為 WEAK_INLINE_COUNT 。
總結(jié)一下 StripedMap[] : StripedMap 是一個(gè)模板類然磷,在這個(gè)類中有一個(gè) array 成員郑趁,用來(lái)存儲(chǔ) PaddedT 對(duì)象,并且其中對(duì)于 [] 符的重載定義中姿搜,會(huì)返回這個(gè) PaddedT 的 value 成員寡润,這個(gè) value 就是我們傳入的 T 泛型成員,也就是 SideTable 對(duì)象舅柜。在 array 的下標(biāo)中梭纹,這里使用了 indexForPointer 方法通過(guò)位運(yùn)算計(jì)算下標(biāo),實(shí)現(xiàn)了靜態(tài)的 Hash Table业踢。而在 weak_table 中栗柒,其成員 weak_entry 會(huì)將傳入對(duì)象的地址加以封裝起來(lái),并且其中也有訪問(wèn)全局弱引用表的入口
舊對(duì)象解除注冊(cè)操作 weak_unregister_no_lock
該方法主要作用是將舊對(duì)象在 weak_table 中接觸 weak 指針的對(duì)應(yīng)綁定知举。根據(jù)函數(shù)名瞬沦,稱之為解除注冊(cè)操作。從源碼中雇锡,可以知道其功能就是從 weak_table 中接觸 weak 指針的綁定逛钻。而其中的遍歷查詢,就是針對(duì)于 weak_entry 中的多張弱引用散列表锰提。
新對(duì)象添加注冊(cè)操作 weak_register_no_lock
這一步與上一步相反曙痘,通過(guò) weak_register_no_lock 函數(shù)把新的對(duì)象進(jìn)行注冊(cè)操作芳悲,完成與對(duì)應(yīng)的弱引用表進(jìn)行綁定操作。
初始化弱引用對(duì)象流程一覽
弱引用的初始化边坤,從上文的分析中可以看出名扛,主要的操作部分就在弱引用表的取鍵、查詢散列茧痒、創(chuàng)建弱引用表等操作肮韧,可以總結(jié)出如下的流程圖:
這個(gè)圖中省略了很多情況的判斷,但是當(dāng)聲明一個(gè) __weak 會(huì)調(diào)用上圖中的這些方法旺订。當(dāng)然弄企, storeWeak 方法不僅僅用在 __weak 的聲明中,在 class 內(nèi)部的操作中也會(huì)常常通過(guò)該方法來(lái)對(duì) weak 對(duì)象進(jìn)行操作区拳。
3拘领、釋放時(shí),調(diào)用clearDeallocating函數(shù)樱调。
clearDeallocating
函數(shù)首先根據(jù)對(duì)象地址獲取所有weak指針地址的數(shù)組
约素,然后遍歷
這個(gè)數(shù)組把其中的數(shù)據(jù)設(shè)為nil
,最后把這個(gè)entry從weak表中刪除
本涕,最后清理對(duì)象的記錄业汰。
當(dāng)weak引用指向的對(duì)象被釋放時(shí)伙窃,又是如何去處理weak指針的呢菩颖?當(dāng)釋放對(duì)象時(shí),其基本流程如下:
1为障、調(diào)用objc_release
2晦闰、因?yàn)閷?duì)象的引用計(jì)數(shù)為0,所以執(zhí)行dealloc
3鳍怨、在dealloc中呻右,調(diào)用了_objc_rootDealloc函數(shù)
4、在_objc_rootDealloc中鞋喇,調(diào)用了object_dispose函數(shù)
5声滥、調(diào)用objc_destructInstance
6、最后調(diào)用objc_clear_deallocating
重點(diǎn)看對(duì)象被釋放時(shí)調(diào)用的objc_clear_deallocating函數(shù)侦香。該函數(shù)實(shí)現(xiàn)如下:
void objc_clear_deallocating(id obj)
{
assert(obj);
assert(!UseGC);
if (obj->isTaggedPointer()) return;
obj->clearDeallocating();
}
也就是調(diào)用了clearDeallocating
落塑,繼續(xù)追蹤可以發(fā)現(xiàn),它最終是使用了迭代器來(lái)取weak表的value罐韩,然后調(diào)用weak_clear_no_lock
,然后查找對(duì)應(yīng)的value憾赁,將該weak指針置空,weak_clear_no_lock函數(shù)的實(shí)現(xiàn)如下:
/**
* Called by dealloc; nils out all weak pointers that point to the
* provided object so that they can no longer be used.
*
* @param weak_table
* @param referent The object being deallocated.
*/
void weak_clear_no_lock(weak_table_t *weak_table, id referent_id)
{
objc_object *referent = (objc_object *)referent_id;
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;
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) {
objc_object **referrer = referrers[i];
if (referrer) {
if (*referrer == referent) {
*referrer = nil;
}
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();
}
}
}
weak_entry_remove(weak_table, entry);
}
objc_clear_deallocating
該函數(shù)的動(dòng)作如下:
1散吵、從weak表中獲取廢棄對(duì)象的地址為鍵值的記錄
2龙考、將包含在記錄中的所有附有 weak修飾符變量的地址蟆肆,賦值為nil
3、將weak表中該記錄刪除
4晦款、從引用計(jì)數(shù)表中刪除廢棄對(duì)象的地址為鍵值的記錄
看了objc-weak.mm的源碼就明白了:其實(shí)Weak表是一個(gè)hash(哈希)表炎功,然后里面的key是指向?qū)ο蟮牡刂罚琕alue是Weak指針的地址的數(shù)組缓溅。
補(bǔ)充:.m和.mm的區(qū)別
.m:源代碼文件亡问,這個(gè)典型的源代碼文件擴(kuò)展名,可以包含OC和C代碼肛宋。
.mm:源代碼文件州藕,帶有這種擴(kuò)展名的源代碼文件,除了可以包含OC和C代碼之外酝陈,還可以包含C++代碼床玻。僅在你的OC代碼中確實(shí)需要使用C++類或者特性的時(shí)候才用這種擴(kuò)展名。
分離鎖
分離鎖并不是一種鎖沉帮,而是一種對(duì)鎖的用法锈死。
圖1這樣對(duì)一整個(gè)表加一把鎖,是我們平時(shí)比較常見的穆壕。如果我一次寫操作需要操作表中多個(gè)單元格的數(shù)據(jù)待牵,比如第一次操作0、1喇勋、2位置的數(shù)據(jù)缨该,第二次操作0、2川背、3位置的數(shù)據(jù)贰拿。像這種情況鎖的粒度就是以整張表為單位的,才能保證數(shù)據(jù)的安全熄云。
圖2這樣對(duì) 表中的各個(gè)元素分別加一把鎖就是我們說(shuō)的分離鎖膨更。適用于表中元素相互獨(dú)立,你對(duì)第一個(gè)元素做寫操作的時(shí)候不需要影響到其他元素缴允。
上文中所說(shuō)的結(jié)構(gòu)就是 SideTables 這個(gè)大的Hash表中每一個(gè)小單元格(SideTable)都帶有一把鎖荚守。做寫操作的時(shí)候(操作對(duì)象引用計(jì)數(shù))單元格之間相互獨(dú)立,互相沒(méi)影響练般。所以 降低了鎖的粒度矗漾。
對(duì)比一下圖1和圖2的并發(fā)性。
- 圖1因?yàn)槿魏尾僮鞫夹枰i整張表踢俄,所以寫操作的時(shí)候相當(dāng)于 串行 操作缩功。沒(méi)有并發(fā)。
- 圖2因?yàn)槊恳粋€(gè)單元格都有一把鎖都办,所以寫操作的時(shí)候 有多少個(gè)單元格并發(fā)數(shù)就可以是多少