iOS刨根問底之@synchronized實現(xiàn)同步的原理

在利用 objc 進行多線程編程時常常遇到同步的問題台诗，這時用的最多的就是NSLock和@synchronized，@synchronized較NSLock使用起來會方便很多、可讀性較高项棠。

本文以一個例子開頭，請問下述代碼的輸出結(jié)果是什么：

int main(int argc, const char * argv[]) {
    @autoreleasepool {
        __block NSObject *obj = [NSObject new];
        dispatch_queue_t queue1 = dispatch_queue_create("queue1", DISPATCH_QUEUE_CONCURRENT);
        dispatch_queue_t queue2 = dispatch_queue_create("queue2", DISPATCH_QUEUE_CONCURRENT);
        dispatch_queue_t queue3 = dispatch_queue_create("queue3", DISPATCH_QUEUE_CONCURRENT);
                
        __block int a = 0;
        for (int i = 0; i < 10; i++) {
            dispatch_async(queue1, ^{
                @synchronized (obj) {
                    NSLog(@"queue1, a = %d", a++);
                    obj = nil;
                }
                // obj = [NSObject new];
            });
        }
    
        for (int i = 0; i < 10; i++) {
            dispatch_async(queue2, ^{
                @synchronized (nil) {
                    NSLog(@"queue2, a = %d", a++);
                }
            });
        }
        
        for (int i = 0; i < 10; i++) {
            dispatch_async(queue3, ^{
                @synchronized ([NSObject new]) {
                    NSLog(@"queue3, a = %d", a++);
                }
            });
        }
        
        // 延遲主線程退出挎峦，主線程退出子線程也會退出
        sleep(2);
    }
    return 0;
}

上述輸出結(jié)果是：三個循環(huán)中使用的鎖均無效（包括第一個循環(huán)中注釋無論是否打開）香追。下面就@synchronized的實現(xiàn)原理進行剖析。

NSObject *obj = [NSObject new];
@synchronized (obj) {
    NSLog(@"hello world.");
}

利用clang -rewrite-objc xxx將上述代碼轉(zhuǎn)化如下坦胶，代碼中已經(jīng)對關(guān)鍵內(nèi)容進行了注釋透典。這里說幾個點：

代碼中用到了很多的代碼塊({}結(jié)構(gòu))，是為了在執(zhí)行到}時顿苇，代碼塊中的對象釋放峭咒，觸發(fā)析構(gòu)函數(shù)的調(diào)用；
鎖入口函數(shù)objc_sync_enter纪岁，退出函數(shù)objc_sync_exit凑队；
如果鎖的釋放出現(xiàn)了異常，則會由catch塊捕獲幔翰，最終在FIN中拋出漩氨；

// 創(chuàng)建 obj 對象
NSObject *obj = ((NSObject *(*)(id, SEL))(void *)objc_msgSend)((id)objc_getClass("NSObject"), sel_registerName("new"));
{
    id _rethrow = 0;
    id _sync_obj = (id)obj;
    // 鎖的入口函數(shù)
    objc_sync_enter(_sync_obj);
    try {
        // 創(chuàng)建一個 _SYNC_EXIT 類型的對象，該對象在 try 代碼塊執(zhí)行完成后會調(diào)用其析構(gòu)函數(shù)釋放遗增，最終執(zhí)行 objc_sync_exit 釋放鎖叫惊。
        struct _SYNC_EXIT {
            _SYNC_EXIT(id arg) : sync_exit(arg) {}
            ~_SYNC_EXIT() {objc_sync_exit(sync_exit);}
            id sync_exit;
        } _sync_exit(_sync_obj);

        // NSLog(@"hello world.");
        NSLog((NSString *)&__NSConstantStringImpl__var_folders_h5_359yk7215js43kb5v40w49sc0000gn_T_test_65e99a_mi_0);
    } catch (id e) {
        // 捕獲異常
        _rethrow = e;
    }
    {
        // 如果捕獲了異常，則會觸發(fā) _FIN 初始化的時候其 rethrow 變量有值贡定，并在對象釋放是調(diào)用析構(gòu)函數(shù)拋出異常赋访。
        struct _FIN {
            _FIN(id reth) : rethrow(reth) {}
            ~_FIN() { if (rethrow) objc_exception_throw(rethrow); }
            id rethrow;
        } _fin_force_rethow(_rethrow);
    }
}

objc_sync_enter和objc_sync_exit究竟做了什么？我們查看一下相關(guān)源碼，戳這里蚓耽。

int objc_sync_enter(id obj)
{
    int result = OBJC_SYNC_SUCCESS;
    if (obj) {
        SyncData* data = id2data(obj, ACQUIRE);
        assert(data);
        data->mutex.lock();
    } else {
        // @synchronized(nil) does nothing
        if (DebugNilSync) {
            _objc_inform("NIL SYNC DEBUG: @synchronized(nil); set a breakpoint on objc_sync_nil to debug");
        }
        objc_sync_nil();
    }
    return result;
}

int objc_sync_exit(id obj)
{
    int result = OBJC_SYNC_SUCCESS;
    if (obj) {
        SyncData* data = id2data(obj, RELEASE); 
        if (!data) {
            result = OBJC_SYNC_NOT_OWNING_THREAD_ERROR;
        } else {
            bool okay = data->mutex.tryUnlock();
            if (!okay) {
                result = OBJC_SYNC_NOT_OWNING_THREAD_ERROR;
            }
        }
    } else {
        // @synchronized(nil) does nothing
    }
    return result;
}

從中我們可以看出渠牲，當obj為空時，什么也沒做步悠。所以@synchronized(nil){}并不能達到鎖的效果签杈。我們發(fā)現(xiàn)上述兩個函數(shù)中都通過id2data獲取結(jié)構(gòu)體SyncData。

如下代碼鼎兽，我列出了幾個關(guān)鍵結(jié)構(gòu)：

// 鏈表結(jié)點
typedef struct SyncData {
    struct SyncData* nextData;  // next答姥，說明是個鏈表結(jié)構(gòu)
    DisguisedPtr<objc_object> object;    // synchronized 中的 obj 最終傳遞到這里
    int32_t threadCount;  // number of THREADS using this block
    recursive_mutex_t mutex;    // 互斥鎖
} SyncData;

// 鏈表
struct SyncList {
    SyncData *data;
    spinlock_t lock;    // 訪問該鏈表的鎖

    SyncList() : data(nil) { }
};

// Use multiple parallel lists to decrease contention among unrelated objects.
#define LOCK_FOR_OBJ(obj) sDataLists[obj].lock
#define LIST_FOR_OBJ(obj) sDataLists[obj].data
// 鏈表存儲的位置，StripedMap 用于存儲 void* -> T谚咬，即地址映射鹦付，具體內(nèi)容可以查看 StripedMap
static StripedMap<SyncList> sDataLists;

// 緩存時鏈表中的 node 結(jié)構(gòu)
typedef struct {
    SyncData *data;
    unsigned int lockCount;  // number of times THIS THREAD locked this block
} SyncCacheItem;

對于synchronized傳入的obj，有兩條鏈表進行存儲择卦，一條鏈表的node結(jié)構(gòu)是SyncData敲长，用于正常訪問用；另一條是SyncCacheItem秉继，從名字中可以看出是做緩存用祈噪，SyncCacheItem中有個SyncData類型的屬性。

SyncData是從函數(shù)id2data中獲取的尚辑，該函數(shù)內(nèi)容較多辑鲤，因為我們重點是關(guān)注synchronized傳入的對象是干什么用的，所以我簡單解釋下該函數(shù)的內(nèi)容：

查看緩存中是否有杠茬，判斷標準是緩存中SyncCacheItem.data.object與synchronized傳入的obj的地址是否相等月褥；
如果緩存中沒有，則在sDataLists中查找澈蝙，判斷標準也是對象地址吓坚；
創(chuàng)建SyncData，并存儲在sDataLists中灯荧；
存儲到緩存中礁击；

id2data中第 3 步會創(chuàng)建SyncData對象，從中可以看到synchronized中傳入的obj最終存儲在SyncData->object中逗载。

SyncData **listp = &LIST_FOR_OBJ(object);
SyncData* result = NULL;
result = (SyncData*)calloc(sizeof(SyncData), 1);
result->object = (objc_object *)object;  // obj
result->threadCount = 1;
new (&result->mutex) recursive_mutex_t();
result->nextData = *listp;
// 添加到 sDataLists 鏈表中
*listp = result;

總結(jié)：從@synchronized(){}的執(zhí)行流程我們可以得出如下結(jié)論：

不要傳遞nil對象哆窿，因為nil導(dǎo)致block執(zhí)行時沒有使用鎖；
兩次執(zhí)行synchronized傳入不同的對象厉斟，同步操作失效挚躯；
傳遞的obj對象，起作用的主要是對象地址擦秽，對象地址與使用的鎖一一對應(yīng)码荔；
如果在@synchronized(){}的block中將obj置為nil漩勤，從代碼分析synchronized退出后，鎖并不會被釋放缩搅。那造成的結(jié)果是什么呢越败？要么下次訪問synchronized傳入的是新對象，要么下次傳入的是上次的obj(此時為nil)硼瓣。這兩種情況對應(yīng)上述結(jié)論1究飞、2，都會導(dǎo)致同步執(zhí)行失效堂鲤。