一个dispatch_once死锁问题

一个dispatch_once死锁问题

工作中遇到一问题：
我们有一个埋点SDK,
启动app，SDK的单例类的初始在主线程执行 [[Sdk shareInstance] startWithConfig]
同时有一个业务方法在子线程调用该sdk的方法去埋点，埋点方法也是调
[[Sdk shareInstance] addEvent:];

在[Sdk shareInstance]的方法里会出现一定概率的死锁！！

先看看模拟代码

通常我们用dispatch_once写单例如下：
注意一下，我们在init方法里面调用到一个切到主线程的方法ksk_syncRunOnMainQueue， 在主线程中做了点事情。

#import "SSTestManager.h"

NS_INLINE void ksk_syncRunOnMainQueue(void (^block)(void)) {
    if (!block) return;
    if ([NSThread isMainThread]) {
        block();
    } else {
        dispatch_sync(dispatch_get_main_queue(), block);
    }
}

@implementation SSTestManager

+ (instancetype)sharedInstance {
    static SSTestManager *instance = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        instance = [[self.class alloc] init];
    });
    return instance;
}

- (instancetype)init {
    self = [super init];
    if (self) {
        [self observeAppLife];
    }
    
    return self;
}

- (void)observeAppLife {
    ksk_syncRunOnMainQueue(^{
        // do something on main thread
        NSLog(@"test");
    });
}

@end

调用的地方，在主线程中

@implementation QTGCDIndexController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view.
    
    // 当前主线程
    dispatch_async(dispatch_get_global_queue(0, 0), ^{
        [SSTestManager sharedInstance];
    });
    
    // 让主线程休息1s
    // sleep(1); 
    
    [SSTestManager sharedInstance];
}


@end

模拟重现步骤：

1. 正常执行，没有问题。执行顺序是先主线中调用[SSTestManager sharedInstance]， 然后子线程中执行
2. 放开sleep(1), 让子线程先执行起来[SSTestManager sharedInstance]，主线程再执行，发现死锁了，为什么？？？思考思考，...

问题分析：

1. 正常执行，主线程完成sharedInstance之后，子线程再开始执行，所以子线程同步向主线提交任务，dispatch_sync(dispatch_get_main_queue(), block)，主线程没有等待任务，直接在主线程执行。
2. 放开sleep之后，子线程在执行sharedInstance中，调用dispatch_sync(dispatch_get_main_queue(), block)同步向主线程提交任务，它要等待主线程任务处理完，再执行当前block，而同时主线程执行sharedInstance方法，由于dispatch_once正在被子线程锁，此时主线程block等待子线程完成。这样，就造成了互相等待，死锁发生了。。

结论：

1. dispatch_once中的代码尽量只做初始化的事情，不要调用很多其他的方法。
2. dispatch_once尽量不要切换线程，特别是同步提交到其他线程的任务。
3. dispatch_once中的代码尽量不要抛出异常，不要Crash。
4. 尽量能保持自给自足，减少对别的模块或者类的依赖；

---

dispatch_once死锁方式

死锁方式1：
1、某线程T1()调用单例A，且为应用生命周期内首次调用，需要使用dispatch_once(&token, block())初始化单例。
2、上述block()中的某个函数调用了dispatch_sync_safe，同步在T2线程执行代码
3、T2线程正在执行的某个函数需要调用到单例A，将会再次调用dispatch_once。
4、这样T1线程在等block执行完毕，它在等待T2线程执行完毕，而T2线程在等待T1线程的dispatch_once执行完毕，造成了相互等待，故而死锁

死锁方式2：
1、某线程T1()调用单例A，且为应用生命周期内首次调用，需要使用dispatch_once(&token, block())初始化单例；
2、block中可能掉用到了B流程，B流程又调用了C流程，C流程可能调用到了单例A，将会再次调用dispatch_once；
3、这样又造成了相互等待。