
FBRetainCycleDetector 是 Facebook 新開源的一個項目,配合 FBMemoryProfiler 使用非常方便,而 FBMemoryProfiler 內部又用到了 FBAllocationTracker。目前是第一版,測試中偶爾會遇到 crash,相信經過使用者反饋與作者自測會越來越完善。本文旨在剖析 FBRetainCycleDetector 的內部實現——只會用而不知其所以然,總感覺不夠。文章分幾個模塊介紹:最簡單的使用方法、主要元素類及其輔助類、主要的查找類及其輔助類。
最簡單的用法(不含 Configuration),純粹查找一個對象的引用循環:
FBRetainCycleDetector *detector = [[FBRetainCycleDetector alloc] initWithConfiguration:nil]; [detector addCandiate:myObject]; NSSet
這裡先說明一下,findRetainCycles 查詢所用的算法是 DFS(深度優先搜索)。
FBObjectiveCGraphElement)FBRetainCycleDetector 處理的對象類型是 FBObjectiveCGraphElement,會在調用 addCandiate 時內部初始化為該類型或其子類。
FBObjectiveCGraphElement 是所有查找對象類型的基類,所有查找都基於它實現。該類不需外部調用,主要供內部查詢使用,功能包括:提供初始化方法封裝 object(即 addCandiate 傳入的對象);獲取該對象所持有的所有對象 - (NSSet *)allRetainedObjects;。基類所獲取的對象,是通過 associated object 持有的對象——其獲取依賴 Facebook 自家的 fishhook 去 hook 原生的 objc_setAssociatedObject 與 objc_removeAssociatedObjects,從而標記對象的持有關係;提供過濾接口 - (NSSet *)filterObjects:(nullable NSArray *)objects;,與 FBObjectGraphConfiguration 結合使用;此外還有獲取類、類名、地址等 helper 接口。
先介紹 Configuration 再看子類。FBObjectGraphConfiguration 內容很少,主要提供過濾 block 類型 FBGraphEdgeFilterBlock 與初始化方法 - (instancetype)initWithFilterBlocks:(NSArray *)filterBlocks shouldInspectTimers:(BOOL)shouldInspectTimers——傳入一個過濾 block 數組,該數組會在 FBObjectiveCGraphElement 調用 filterObjects 時依次執行;shouldInspectTimers 則決定是否檢查 NSTimer。看 FBGraphEdgeFilterBlock 的定義:typedef FBGraphEdgeType (^FBGraphEdgeFilterBlock)(FBObjectiveCGraphElement *_Nullable fromObject, FBObjectiveCGraphElement *_Nullable toObject); 傳入 fromObject(傳入的對象)與 toObject(被持有的對象),可按需處理。舉例,過濾掉所有以 UINavi 開頭的對象:判斷 fromObject 的類名是否以 "UINavi" 開頭,是則返回 FBGraphEdgeInvalid,否則返回 FBGraphEdgeValid,最後把該 block 放進數組完成初始化。這便是一個含 configuration 的初始化過程。
上面說過,FBObjectiveCGraphElement 只提供對 associate object 的持有查找,因此其他對象的持有查找由子類實現,主要包括:FBObjectiveCBlock、FBObjectiveCObject、FBObjectiveCNSCFTimer。
主要內容是重寫父類方法 allRetainedObjects(同樣會調用 [super allRetainedObjects]),隨後識別 block 並獲取引用關係,最終封裝為 FBObjectiveCBlock。細節:
block 識別用到 FBBlockStrongLayout.h 裡的 C 函數,判斷是否為 block 的方法是:用一個空 block ^{},判斷傳入的 block 是否為其子類(先轉為 Class 類型)。
block 內部引用關係獲取相對繁瑣:先按 block 的 size_t 大小創建等大的數組,元素類型為 FBBlockStrongRelationDetector(它在 release 時做標記,用於統計 block 內部內容是否為對象);再對該 block 的每個 dispose_helper,若調用了 release 則說明是對象,否則是普通數據類型,記錄其在 block 內部的位置,返回位置數組,再據此取出每個對象。
最後同樣調用 filterObjects 過濾掉不需查找引用循環的對象。
重寫並調用父類方法的方式與 block 相同,差別在於持有對象的獲取:
由 FBClassStrongLayout 裡的函數輔助獲取,同樣借助 runtime(class_copyIvarList)獲取屬性列表,並封裝為 FBIvarReference;若屬性是 struct 類型還需單獨處理。
FBIvarReference 初始化時會把 Ivar 分類為 FBObjectType、FBBlockType、FBStructType、FBUnknownType。
然後封裝成 FBObjectiveCObject。過濾前需判斷 object 類型,因為某些類型在數據處理時會崩潰——目前 fb 只處理了一部分,實測遍歷系統對象時仍會異常崩潰,但暫未發現自定義對象在查找 retain cycle 時崩潰。
實現內容較少,主要通過 runloop 獲取 CFRunLoopTimerGetContext,再對取到的數據做處理即可。
FBRetainCycleDetector)主要功能是查找 retain cycle,算法思想為深度優先搜索(DFS),因此對象量大、查找深度(默認 8)較深時會比較慢,一般在異步線程執行查找。
它會對通過 addCandidate 添加的所有對象做 DFS,查找前先經 FBObjectGraphConfiguration 過濾。查找過程會把對象進一步封裝為 FBNodeEnumerator,見下文。
它繼承自 NSEnumerator,後者可方便地提供 nextObject 調用,只需在子類重寫該方法。
FBNodeEnumerator 的 nextObject 主要處理是:通過 object 調用 allRetainedObjects(由 FBObjectiveCGraphElement 提供,返回過濾後的持有對象),再取第一個對象返回。至於深搜的數據存儲,此處不再展開。
FBRetainCycleDetector 目前是第一版,難免有一些 bug,但不影響正常使用。查找算法上可能帶來較大的內存消耗(程序夠大時,深搜畢竟談不上高效)。本文暫未描述 FBMemoryProfiler,是因為它主要負責界面實現以及與 FBAllocationTracker 的功能結合;而 FBAllocationTracker 功能相對簡單,後續會用一篇小文概述。