(轉載)iOS 底層解析weak的實現原理(包含weak物件的初始化,引用,釋放的分析)

Perfect_Dream發表於2017-12-20

很少有人知道weak表其實是一個hash(雜湊)表,Key是所指物件的地址,Value是weak指標的地址陣列。更多人的人只是知道weak是弱引用,所引用物件的計數器不會加一,並在引用物件被釋放的時候自動被設定為nil。通常用於解決迴圈引用問題。但現在單知道這些已經不足以應對面試了,好多公司會問weak的原理。weak的原理是什麼呢?下面就分析一下weak的工作原理(只是自己對這個問題好奇,學習過程中的筆記,希望對讀者也有所幫助)。

weak 實現原理的概括

Runtime維護了一個weak表,用於儲存指向某個物件的所有weak指標。weak表其實是一個hash(雜湊)表,Key是所指物件的地址,Value是weak指標的地址(這個地址的值是所指物件的地址)陣列。

weak 的實現原理可以概括一下三步:

1、初始化時:runtime會呼叫objc_initWeak函式,初始化一個新的weak指標指向物件的地址。

2、新增引用時:objc_initWeak函式會呼叫 objc_storeWeak() 函式, objc_storeWeak() 的作用是更新指標指向,建立對應的弱引用表。

3、釋放時,呼叫clearDeallocating函式。clearDeallocating函式首先根據物件地址獲取所有weak指標地址的陣列,然後遍歷這個陣列把其中的資料設為nil,最後把這個entry從weak表中刪除,最後清理物件的記錄。

下面將開始詳細介紹每一步:

1、初始化時:runtime會呼叫objc_initWeak函式,objc_initWeak函式會初始化一個新的weak指標指向物件的地址。 示例程式碼:

{  
    NSObject *obj = [[NSObject alloc] init];  
    id __weak obj1 = obj;
}
複製程式碼

當我們初始化一個weak變數時,runtime會呼叫 NSObject.mm 中的objc_initWeak函式。這個函式在Clang中的宣告如下:

id objc_initWeak(id *object, id value);
複製程式碼

而對於 objc_initWeak() 方法的實現

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 中的快取判斷),這裡判斷了其指標指向的類物件是否有效,無效直接釋放,不再往深層呼叫函式。否則,object將被註冊為一個指向value的__weak物件。而這事應該是objc_storeWeak函式乾的。

注意:objc_initWeak函式有一個前提條件:就是object必須是一個沒有被註冊為__weak物件的有效指標。而value則可以是null,或者指向一個有效的物件。

2、新增引用時:objc_initWeak函式會呼叫 objc_storeWeak() 函式, objc_storeWeak() 的作用是更新指標指向,建立對應的弱引用表。 objc_storeWeak的函式宣告如下:

id objc_storeWeak(id *location, id value);
複製程式碼

objc_storeWeak() 的具體實現如下:

// 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;
}
複製程式碼

撇開原始碼中各種鎖操作,來看看這段程式碼都做了些什麼。

1)、SideTable

SideTable 這個結構體,我給他起名引用計數和弱引用依賴表,因為它主要用於管理物件的引用計數和 weak 表。在 NSObject.mm 中宣告其資料結構:

struct SideTable {
    // 保證原子操作的自旋鎖
    spinlock_t slock;
    // 引用計數的 hash 表
    RefcountMap refcnts;
    // weak 引用全域性 hash 表
    weak_table_t weak_table;
}
複製程式碼

對於 slock 和 refcnts 兩個成員不用多說,第一個是為了防止競爭選擇的自旋鎖,第二個是協助物件的 isa 指標的 extra_rc 共同引用計數的變數(對於物件結果,在今後的文中提到)。這裡主要看 weak 全域性 hash 表的結構與作用。

2)、weak表

weak表是一個弱引用表,實現為一個weak_table_t結構體,儲存了某個物件相關的的所有的弱引用資訊。其定義如下(具體定義在objc-weak.h中):

struct weak_table_t {
    // 儲存了所有指向指定物件的 weak 指標
    weak_entry_t *weak_entries;
    // 儲存空間
    size_t    num_entries;
    // 參與判斷引用計數輔助量
    uintptr_t mask;
    // hash key 最大偏移值
    uintptr_t max_hash_displacement;
};
複製程式碼

這是一個全域性弱引用hash表。使用不定型別物件的地址作為 key ,用 weak_entry_t 型別結構體物件作為 value 。其中的 weak_entries 成員,從字面意思上看,即為弱引用表入口。其實現也是這樣的。

其中weak_entry_t是儲存在弱引用表中的一個內部結構體,它負責維護和儲存指向一個物件的所有弱引用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 的結構中,DisguisedPtr referent 是對泛型物件的指標做了一個封裝,通過這個泛型類來解決記憶體洩漏的問題。從註釋中寫 out_of_line 成員為最低有效位,當其為0的時候, weak_referrer_t 成員將擴充套件為多行靜態 hash table。其實其中的 weak_referrer_t 是二維 objc_object 的別名,通過一個二維指標地址偏移,用下標作為 hash 的 key,做成了一個弱引用雜湊。

那麼在有效位未生效的時候,out_of_linenum_refsmaskmax_hash_displacement有什麼作用?以下是筆者自身的猜測:

  1. out_of_line:最低有效位,也是標誌位。當標誌位 0 時,增加引用表指標緯度。
  2. num_refs:引用數值。這裡記錄弱引用表中引用有效數字,因為弱引用表使用 的>是靜態 hash 結構,所以需要使用變數來記錄數目。
  3. mask:計數輔助量。
  4. max_hash_displacement:hash 元素上限閥值。

其實 out_of_line 的值通常情況下是等於零的,所以弱引用表總是一個 objc_objective 指標二維陣列。一維 objc_objective 指標可構成一張弱引用雜湊表,通過第三緯度實現了多張雜湊表,並且表數量為 WEAK_INLINE_COUNT

總結一下 StripedMap[]

StripedMap 是一個模板類,在這個類中有一個 array 成員,用來儲存 PaddedT 物件,並且其中對於[] 符的過載定義中,會返回這個 PaddedTvalue 成員,這個 value 就是我們傳入的 T 泛型成員,也就是 SideTable 物件。在 array 的下標中,這裡使用了 indexForPointer 方法通過位運算計算下標,實現了靜態的 Hash Table。而在 weak_table 中,其成員 weak_entry 會將傳入物件的地址加以封裝起來,並且其中也有訪問全域性弱引用表的入口。

1490601587998756.png

舊物件解除註冊操作 weak_unregister_no_lock

該方法主要作用是將舊物件在 weak_table 中接觸 weak 指標的對應繫結。根據函式名,稱之為解除註冊操作。從原始碼中,可以知道其功能就是從 weak_table 中接觸 weak 指標的繫結。而其中的遍歷查詢,就是針對於 weak_entry 中的多張弱引用雜湊表。

新物件新增註冊操作 weak_register_no_lock

這一步與上一步相反,通過 weak_register_no_lock 函式把心的物件進行註冊操作,完成與對應的弱引用表進行繫結操作。

初始化弱引用物件流程一覽

弱引用的初始化,從上文的分析中可以看出,主要的操作部分就在弱引用表的取鍵、查詢雜湊、建立弱引用表等操作,可以總結出如下的流程圖:

1490601551770762.png

這個圖中省略了很多情況的判斷,但是當宣告一個 weak 會呼叫上圖中的這些方法。當然, storeWeak 方法不僅僅用在 weak 的宣告中,在 class 內部的操作中也會常常通過該方法來對 weak 物件進行操作。

3、釋放時,呼叫clearDeallocating函式。clearDeallocating函式首先根據物件 地址獲取所有weak指標地址的陣列,然後遍歷這個陣列把其中的資料設為nil,最後把這個entry從weak表中刪除,最後清理物件的記錄。 當weak引用指向的物件被釋放時,又是如何去處理weak指標的呢?當釋放物件時,其基本流程如下:

  1. 呼叫objc_release
  2. 因為物件的引用計數為0,所以執行dealloc
  3. 在dealloc中,呼叫了_objc_rootDealloc函式
  4. 在_objc_rootDealloc中,呼叫了object_dispose函式
  5. 呼叫objc_destructInstance
  6. 最後呼叫objc_clear_deallocating

重點看物件被釋放時呼叫的objc_clear_deallocating函式。該函式實現如下:

void  objc_clear_deallocating(id obj) 
{
    assert(obj);
    assert(!UseGC);
    if (obj->isTaggedPointer()) return ;
    obj->clearDeallocating();
}
複製程式碼

也就是呼叫了clearDeallocating,繼續追蹤可以發現,它最終是使用了迭代器來取weak表的value,然後呼叫weak_clear_no_lock,然後查詢對應的value,將該weak指標置空,weak_clear_no_lock函式的實現如下:

/**
* 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該函式的動作如下:

  1. 從weak表中獲取廢棄物件的地址為鍵值的記錄
  2. 將包含在記錄中的所有附有 weak修飾符變數的地址,賦值為nil
  3. 將weak表中該記錄刪除
  4. 從引用計數表中刪除廢棄物件的地址為鍵值的記錄

看了objc-weak.mm的原始碼就明白了:其實Weak表是一個hash(雜湊)表,然後裡面的key是指向物件的地址,Value是Weak指標的地址的陣列。

補充:.m和.mm的區別

.m: 原始碼檔案,這個典型的原始碼副檔名,可以包含OC和C程式碼。 .mm:原始碼檔案,帶有這種副檔名的原始碼檔案,除了可以包含OC和C程式碼之 外,還可以包含C++程式碼。僅在你的OC程式碼中確實需要使用C++類或者特性的時候才用這種副檔名。

參考資料: weak 弱引用的實現方式

weak的生命週期:具體實現方法

本文轉載自原文



有志者、事竟成,破釜沉舟,百二秦關終屬楚;

苦心人、天不負,臥薪嚐膽,三千越甲可吞吳.

相關文章