一次標簽指針(Tagged Pointer)導致的事故

前言

最近遇到一起由objc_setAssociatedObjectobjc_getAssociatedObject引發(fā)的Crash事故,特此分享。

正文

問題背景

項目中已經(jīng)存在某個Catagory,會往一個第三方庫的類中掛載一個屬性,用下面代碼的TestCatagory中ssShowTime屬性來表示。

@interface ViewController(TestCategory)

@property (nonatomic, assign) long ssShowTime;

@end

具體的實現(xiàn)是用objc_setAssociatedObjectobjc_getAssociatedObject方法。


@implementation ViewController (TestCategory)

- (void)setSsShowTime:(long)ssShowTime {
    NSNumber *number = @(ssShowTime);
    objc_setAssociatedObject(self, @selector(ssShowTime), number, OBJC_ASSOCIATION_ASSIGN);
}

- (long)ssShowTime {
    NSNumber *number = objc_getAssociatedObject(self, @selector(ssShowTime));
    return [number longValue];
}

@end

該方法已經(jīng)跑了好幾個版本,沒有出現(xiàn)過任何問題。
后面在此基礎上又新增一個掛載屬性,我們用ssLocalDesc來表示。

@property (nonatomic, strong) NSString *ssLocalDesc;

- (void)setSsLocalDesc:(NSString *)ssLocalDesc {
    objc_setAssociatedObject(self, @selector(ssLocalDesc), ssLocalDesc, OBJC_ASSOCIATION_ASSIGN);
}

- (NSString *)ssLocalDesc {
    NSString *ret = objc_getAssociatedObject(self, @selector(ssLocalDesc));
    return ret;
}

ssLocalDesc屬性會用來存一些描述,比如說用常量,又或者拼接起來的字符串,如下:

    self.ssLocalDesc = @"123";
    // 或者
    int index = 1;
    self.ssLocalDesc = [NSString stringWithFormat:@"Tag_%d", index];

一切都正常,直到下面這段代碼出現(xiàn):

    self.ssLocalDesc = [NSString stringWithFormat:@"Tag_%d", (int)time(NULL)];

這個賦值語句執(zhí)行完之后,再訪問self.ssLocalDesc屬性就會產(chǎn)生Crash!

問題回溯

當問題出現(xiàn)之后,我們來看看是犯了哪些錯誤,才會導致問題的出現(xiàn):
ssShowTime 屬性雖然是long,但是內(nèi)部實現(xiàn)的時候還是通過NSNumber類來實現(xiàn),所以這里不應該使用OBJC_ASSOCIATION_ASSIGN;

typedef OBJC_ENUM(uintptr_t, objc_AssociationPolicy) {
    OBJC_ASSOCIATION_ASSIGN = 0,           /**< Specifies a weak reference to the associated object. */
    OBJC_ASSOCIATION_RETAIN_NONATOMIC = 1, /**< Specifies a strong reference to the associated object. 
                                            *   The association is not made atomically. */
    OBJC_ASSOCIATION_COPY_NONATOMIC = 3,   /**< Specifies that the associated object is copied. 
                                            *   The association is not made atomically. */
    OBJC_ASSOCIATION_RETAIN = 01401,       /**< Specifies a strong reference to the associated object.
                                            *   The association is made atomically. */
    OBJC_ASSOCIATION_COPY = 01403          /**< Specifies that the associated object is copied.
                                            *   The association is made atomically. */
};

這里更合適的做法是使用OBJC_ASSOCIATION_RETAIN或者OBJC_ASSOCIATION_RETAIN_NONATOMIC。

ssLocalDesc屬性是字符串,字符串通常使用strong或者copy,那么這里使用OBJC_ASSOCIATION_ASSIGN本身就是錯誤的。
OBJC_ASSOCIATION_ASSIGN通常是為了避免循環(huán)引用而添加,不會對引用計數(shù)產(chǎn)生變化。

問題延伸

當解決完這個問題之后,我們發(fā)現(xiàn)crash出現(xiàn)之前,有幾個延伸問題:
問題1:為什么ssShowTime這個屬性在運行過程中不會Crash?
我們知道Crash是由于OBJC_ASSOCIATION_ASSIGN不會引用計數(shù)加1,導致對象被釋放出現(xiàn)野指針的情況。那么我們在number對象掛載之前,看下對象的引用計數(shù)。

- (void)setSsShowTime:(long)ssShowTime {
    NSNumber *number = @(ssShowTime);
    objc_setAssociatedObject(self, @selector(ssShowTime), number, OBJC_ASSOCIATION_ASSIGN);
}

結(jié)果非常意外,引用計數(shù)的值非常大。

(lldb) p CFGetRetainCount(number)
(CFIndex) $0 = 9223372036854775807

如果排除掉引用計數(shù)出錯的可能,我們可以理解為什么number對象不會被釋放。

問題2:為什么ssLocalDesc這個屬性在測試不會Crash,而在線上運行會出現(xiàn)Crash?
針對ssLocalDesc屬性,我構(gòu)造了三種情況:

  • 情況1,普通常量字符串;
    self.ssLocalDesc = @"123";

結(jié)果如下圖,引用計數(shù)也很大;字符串類型為常量字符串, 隨著App運行就創(chuàng)建,退出時才銷毀。

  • 情況2,測試時較短的字符串;

    int index = 1;
    self.ssLocalDesc = [NSString stringWithFormat:@"Tag_%d", index];

結(jié)果如下圖,引用計數(shù)仍很大;字符串類型為TaggedPointerString,這是標簽指針類型的字符串,把指針當做字符串對象來使用;

  • 情況3,上線后較長的字符串;

    self.ssLocalDesc = [NSString stringWithFormat:@"Tag_%d", (int)time(NULL)];

結(jié)果如下圖,引用計數(shù)為正常;字符串類型是普通字符串,這是我們最常見的字符串類型。這個類型的字符串,在下面訪問ssLocalDesc屬性時會發(fā)生Crash。

再回到問題1,我們知道NSNumber也使用類似的標簽指針(Tagged Pointer)。當數(shù)字較小的時候,NSNumber就不是真正的對象,而是一個標簽指針,并不會像對象一樣走銷毀釋放的流程。
驗證方法:使用一個較大的數(shù)字來初始化。比如說設置ssShowTime為NSIntegerMax,此時引用計數(shù)恢復正常范圍。

相關(guān)知識——Tagged Pointer

Tagged pointer:是用于提高性能并減少內(nèi)存使用的技術(shù)。原理是利用內(nèi)存存儲中的內(nèi)存對齊,對象的地址通常是指針大小的倍數(shù)。iOS的設備中大部分都是64位的機器,所以指針通常是以64 位整型存儲。
由于內(nèi)存對齊,指針中會有一些位總會為零。為了高效利用這些空間,iOS把對象指針的最低有效位為1時,認為該指針是 tagged pointer(標簽指針)。tagged pointer最低位中的前3位不再被當作isa指針的地址,而是表示一個特殊的tagged class表的索引值;這個索引值用來查找tagged pointer所對應的類,剩余的60位則會被直接使用。

總結(jié)

標簽指針的具體概念,在附錄兩篇文章已經(jīng)描述得很清晰,這里就不再贅述。
這個事故還有很多隱藏因素導致,比如說測試環(huán)境與線上環(huán)境不一致,比如說上線流程沒有按照規(guī)范執(zhí)行,比如說代碼規(guī)范沒有遵守,比如說review流程沒有發(fā)現(xiàn)問題等等,針對這么多因素,其中有兩步是很重要的:
1、保證測試環(huán)境和線上環(huán)境一致;
2、按照上線流程進行規(guī)范操作;

為了能在測試階段發(fā)現(xiàn)問題,還是把測試環(huán)境和線上環(huán)境調(diào)成完全一樣的好;
從技術(shù)的角度來分析,只要工程設置完全一致,就可以實現(xiàn)客戶端的測試環(huán)境=線上環(huán)境。

附錄

tagged pointer
【譯】采用Tagged Pointer的字符串

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容