本文使用的源码是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会有更深的了解。
网友评论