GCD之dispatch_once源码剖析

本文使用的源码是libdispatch-187.10版本
至于为啥是这个版本,因为这一版的实现相对来说比较直观、阅读性较佳,但是也存在一个问题就是后续可能会有更新(至少是出于效率上的考虑)我们并不知晓,看完了这个觉得自己已经窥得真知,那就看最新版本吧,对比不同版本之间的差异,了解其中的原委。最新版本为libdispatch-913.30.4版本

只考虑单一线程来看dispatch_once的作用没什么意义,只有多线程考虑到线程安全的时候才能真正体现出它的优势。

废话少说,直接上源码:

once.h

/*!
 * @typedef dispatch_once_t
 * predicate需要先初始化为0,static和global变量创建出来即有默认值0
 */
typedef long dispatch_once_t;

/*!
 * @function dispatch_once
 */
void dispatch_once(dispatch_once_t *predicate, dispatch_block_t block);

void dispatch_once(dispatch_once_t *predicate, dispatch_block_t block) 
{
    if (DISPATCH_EXPECT(*predicate, ~0l) != ~0l) {
        dispatch_once(predicate, block);
    }
}
void dispatch_once_f(dispatch_once_t *predicate, void *context,
        dispatch_function_t function)
{
    // __builtin_expect((x), (v))
    if (DISPATCH_EXPECT(*predicate, ~0l) != ~0l) {
        dispatch_once_f(predicate, context, function);
    }
}

头文件中用到一个DISPATCH_EXPECT宏,这个宏展开之后其实是一个GCC内置函数__builtin_expect(exp, c),在GCC手册上是这样描述这个函数的:由于大部分程序员在分支预测方面做得很糟糕,所以 GCC 提供了这个内建函数来帮助程序员处理分支预测,优化程序。其第一个参数 exp 为一个整型表达式,这个内建函数的返回值也是这个 exp ,而 c 为一个编译期常量。这个函数的语义是:你期望 exp 表达式的值等于常量 c ,从而 GCC 为你优化程序,将符合这个条件的分支放在合适的地方

once.m

struct _dispatch_once_waiter_s {
    volatile struct _dispatch_once_waiter_s *volatile dow_next;//链表下一个节点
    _dispatch_thread_semaphore_t dow_sema;// 信号量
};

#define DISPATCH_ONCE_DONE ((struct _dispatch_once_waiter_s *)~0l)

void dispatch_once(dispatch_once_t *val, dispatch_block_t block)
{
     dispatch_once_f(val, block, _dispatch_Block_invoke(block));
}

void dispatch_once_f(dispatch_once_t *val, void *ctxt, dispatch_function_t func)
{
    // volatileg关键字编辑的变量vval,告诉编译器此指针指向的值随时可能被其他线程改变,从而使得编译器不对此指针进行代码编译优化。
    // 指针的最大的作用就是间接的改变变量的值
    struct _dispatch_once_waiter_s * volatile *vval = (struct _dispatch_once_waiter_s **)val;
    
    // 初始化一个结构体
    struct _dispatch_once_waiter_s dow = {NULL, 0};
    
    // 声明辅助变量
    struct _dispatch_once_waiter_s *tail, *tmp;
    
    // 声明信号变量
    // uintptr_t sema
    _dispatch_thread_semaphore_t sema;

    // 内置函数 原子比较交换函数 __sync_bool_compare_and_swap
    // 判断vval与NULL是否相等,如果相等就返回YES,并将&dow的值赋给vval
    // 当dispatch_once第一次执行时,predicate也即val为0,地址并不为NULL,但是将0转成链表的时候vval为NULL,那么此“原子比较交换函数”将返回YES并将vval指向值赋值为&dow,即为“等待中”,_dispatch_client_callout其内部做了一些判定,但实际上是调用了func而已。到此,block中的用户代码执行完毕。
    // #1
    if (dispatch_atomic_cmpxchg(vval, NULL, &dow)) {
        dispatch_atomic_acquire_barrier();//这是一个空的宏函数,大概是注释的作用吧
        
        // 其实质是执行block
        _dispatch_client_callout(ctxt, func);
        
        // cpuid指令等待,使得其他线程的【读取到未初始化值的】预执行能被判定为猜测未命中,从而使得这些线程能够进入dispatch_once_f里的另一个分支从而进行等待
        dispatch_atomic_maximally_synchronizing_barrier();
        
        dispatch_atomic_release_barrier(); //这是一个空的宏函数,大概是注释的作用吧
        
        // dispatch_atomic_xchg 其将第二个参数的值赋给第一个参数(解引用指针),然后返回第一个参数被赋值前的解引用值:
        // vval = &dow;
        // old = vval;
        // vval = DISPATCH_ONCE_DONE;// 置block完成标记,是置成NULL吗
        // tmp = old;
        tmp = dispatch_atomic_xchg(vval, DISPATCH_ONCE_DONE);
        
        tail = &dow;
        
        // tmp = 旧的vval = dow
        // vval = dow;
        // 接下来是对信号量链的处理:
        // 1.在block执行过程中,没有其他线程进入本函数来等待,则vval指向值保持为&dow,即tmp被赋值为&dow,即下方while循环不会被执行,此分支结束。
        // 2.在block执行过程中,有其他线程进入本函数来等待进入另一个分支,那么会构造一个信号量链表(vval指向值变为信号量链的头部,链表的尾部为&dow),此时就会当前分支进入while循环,在此while循环中,遍历链表,逐个signal每个信号量,然后结束循环。
        while (tail != tmp) {
            while (!tmp->dow_next) {
                // 此句是为了提示cpu减少额外处理,提升性能,节省电力。
                _dispatch_hardware_pause();
            }
            sema = tmp->dow_sema;
            tmp = (struct _dispatch_once_waiter_s*)tmp->dow_next;
            _dispatch_thread_semaphore_signal(sema);
        }
    } else {
        // #2
        // 当执行block分支#1未完成,且有线程再进入本函数时,将进入线程等待分支:
        // 先调用_dispatch_get_thread_semaphore创建一个信号量,此信号量被赋值给dow.dow_sema。
        // 然后进入一个无限for循环,假如发现vval的指向值已经为DISPATCH_ONCE_DONE,即“完成”,则直接break,然后调用_dispatch_put_thread_semaphore函数销毁信号量并退出函数
        // _dispatch_get_thread_semaphore内部使用的是“有即取用,无即创建”策略来获取信号量。
        dow.dow_sema = _dispatch_get_thread_semaphore();
        
        // 然后进入一个无限for循环
        for (;;) {
            tmp = *vval;
            // 假如发现vval的指向值已经为DISPATCH_ONCE_DONE,即“完成”,则直接break
            // 然后调用_dispatch_put_thread_semaphore函数销毁信号量并退出函数。
            if (tmp == DISPATCH_ONCE_DONE) {
                break;
            }
            dispatch_atomic_store_barrier();// 注释作用
            
            /*
             假如vval的解引用值并非DISPATCH_ONCE_DONE,则进行一个“原子比较并交换”操作(此操作可以避免两个等待线程同时操作链表带来的问题)
             假如此时vval指向值已不再是tmp(这种情况发生在多个线程同时进入线程等待分支#2,并交错修改链表)则for循环重新开始,再尝试重新获取一次vval来进行同样的操作;若指向值还是tmp,则将vval的指向值赋值为&dow,此时val->dow_next值为NULL,可能会使得block执行分支#1进行while等待(如前述),紧接着执行dow.dow_next = tmp这句来增加链表节点(同时也使得block执行分支#1的while等待结束),然后等待在信号量上,当block执行分支#1完成并遍历链表来signal时,唤醒、释放信号量,然后一切就完成了。
             */
            // 此操作可以避免两个等待线程同时操作链表带来的问题
            // 判断vval与tmp是否相等,如果相等就返回YES,并将&dow的值赋给vval
            if (dispatch_atomic_cmpxchg(vval, tmp, &dow)) {
                dow.dow_next = tmp;
                _dispatch_thread_semaphore_wait(dow.dow_sema);
            }
        }
        // _dispatch_put_thread_semaphore内部使用的是“销毁旧的,存储新的”策略来缓存信号量
        _dispatch_put_thread_semaphore(dow.dow_sema);
    }
}
// 在这里_dispatch_Block_invoke()宏的定义如下
#define _dispatch_Block_invoke(bb) \
        ((dispatch_function_t)((struct Block_layout *)bb)->invoke)
block内存布局.jpg

struct Block_descriptor {
    unsigned long int reserved;
    unsigned long int size;
    void (*copy)(void *dst, void *src);
    void (*dispose)(void *);
};

struct Block_layout {
    void *isa;
    int flags;
    int reserved;
    void (*invoke)(void *, ...);
    struct Block_descriptor *descriptor;
    /* Imported variables. */
};

isa指针:指向表明该block类型的类。
flags:按bit位表示一些block的附加信息,比如判断block类型、判断block引用计数、判断block是否需要执行辅助函数等。
reserved:保留变量,我的理解是表示block内部的变量数。
invoke:函数指针,指向具体的block实现的函数调用地址。
descriptor:block的附加描述信息,比如保留变量数、block的大小、进行copy或dispose的辅助函数指针。
variables:因为block有闭包性,所以可以访问block外部的局部变量。这些variables就是复制到结构体中的外部局部变量或变量的地址。

dispatch_once.png

最后盗用一张深入浅出GCD之dispatch_once里面的示意图来做一个总结,看完这张图我想对dispatch_once会有更深的了解。

参考资料:
__builtin_expect 解惑
深入浅出GCD之dispatch_once

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容