WaitGroup是如何实现的?

在使用Golang一段时间之后,很少人不认识一个叫sync.WaitGroup的结构体。

使用场景

WaitGroup用来编排多个并发任务,举个例子,一个业务逻辑,依赖三个HTTP请求,且这三个HTTP请求可以并发执行,之间并无依赖关系,这就是WaitGroup使用的场景。

var urls = []string{"url1", "url2", "url3"}
g := sync.WaitGroup{}
g.Add(len(urls))
for i := 0; i < len(urls); i++ {
  go func(url string) {
    defer g.Done() // or g.Add(-1)
    request(url)
  }(urls[i])
}
g.Wait() // 到这里的时候,所有的请求都执行完毕

使用WaitGroup,能轻易的编排并发,使得主业务逻辑等待的时间等于三个请求中最慢的时间。

信号量

在剖析WaitGroup之前,我们必须先说下信号量,给后面的内容打下坚实的基础。

信号量(semaphore)是一个许可集。至少,这是许多文章里都提到的一个概念,许可集其实是许可集合,既然是集合,那就是有限的,也就是说,多个线程或者协程竞争许可集合里的许可,如果有富余许可,就给等待的线程,线程拿到许可后,用完放回,没有拿到线程,则休眠等待唤醒,重新竞争。

如果你了解一点Java的话,下面的例子就是最好的阐述,如果不懂也没有关系,这几行代码你一定能看懂:

Semaphore s = new Semaphore(3); // 许可个数
Runnable run = new Runnable() {
 public void run() {
   try {
     s.acquire(); // 拿不到则阻塞
   } catch (InterruptedException e) {

   } finally {
     s.release(); // 用完放回
   }
 }
}

需要注意的是,在Java中,new Runnable有点像golang里的go func,是跑在一个单独的线程中的,许可,或者说资源是有限的,多个线程争抢,就必须有一个机制能编排它们,这就是信号量的作用。

让我们来归纳一下。

信号量就是一个有限许可集,信号量的使用场景有以下特点:

  1. 资源有限。

  2. 并发(多线程)。

在Golang中,信号量也是实现锁所依赖的基本函数。在其他场景下,比如说连接池,也是使用信号量非常合适的业务场景。

数据结构和算法

WaitGroup的结构体是这样的:

type WaitGroup struct {
  noCopy noCopy
  state1 [3]uint32
}

noCopy只是标记下WaitGroup是不可以被拷贝的,state1中分为一个64位和一个32位,64位用来计数worker和waiter,另外的32位用来作信号量的底层数据结构。

通常情况下,使用WaitGroup都是在主协程中执行Add和Wait,在并发的协程中执行Done,Wait方法可以是出现在多个协程中,被重复调用,但通常出现在主协程中。

worker的数量可以认为是在执行中的协程的数量,waiter的数量可以认为是有多少个协程调用了Wait方法在等待所有的worker执行完毕。

Add函数的主要逻辑有2个:

  1. 修改worker的值,这里只所以说修改,而不说递增,是因为Add的参数可能是正的,也可能是负的。

  2. 如果worker的值变为了0,说明所有的协程都执行完毕,就要释放许可,释放的数量,就是waiter的数量。

Done函数的逻辑其实是调用了Add(-1),所以Done的逻辑参考Add的逻辑。

Wait函数的主要逻辑也是2个:

  1. waiter的值递增。

  2. 等待信号量,阻塞获取许可,获取到以后就返回,函数结束。

归纳WaitGroup的实现,本质上是围绕信号量实现的,但是什么时候释放,释放几个,什么时候获取信号量,这些都是用state1这个field来实现的。算法的实现总是需要用数据结构作为依托。

内存对齐

关于内存对齐的文章很多,这里并不打算宣兵夺主,还是回到我们的WaitGroup上来。之所以提内存对齐,是因为考虑了内存对齐,所以结构体里的state1是一个长度为3的数组才有一个合理的解释。

内存对齐的知识点可能很多,但我们今天只关心其中一个。

On ARM, x86-32, and 32-bit MIPS, it is the caller's responsibility to arrange for 64-bit alignment of 64-bit words accessed atomically. The first word in a variable or in an allocated struct, array, or slice can be relied upon to be 64-bit aligned.

也就是说32位架构想要原子性的操作8bytes,需要由调用方保证其数据地址是64位对齐的,否则原子访问会有异常。

在阅读WaitGroup源码的时候,会注意到,state1在64位架构下,前64位是worker和waiter计数器,后32位是sema,而在32位架构下,前32位是sema,后64位是worker和waiter计数器。不得不感叹思路之精巧、精密,计算机基础知识之深,我们还有很长的路要走。

参考

Java semaphore:

https://segmentfault.com/a/1190000023038654

WaitGroup:

https://www.ququ123.xyz/2022/04/golang_wait_group_principle/

内存对齐:

https://www.cnblogs.com/luozhiyun/p/14289034.html

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

推荐阅读更多精彩内容