• Go 1.14 以后的 timer 性能得到了质的飞升,不过伴随而来的是 timer 成了 Go 里面最复杂、最难梳理的数据结构。本文不会详细分析每一个细节,我们从大体来了解 Go timer 的工作原理。

    1. 使用场景

    Go timer 在我们代码中会经常遇到。

    场景1:RPC 调用的防超时处理(下面代码节选 dubbogo)

    func (c *Client) Request(request *remoting.Request, timeout time.Duration, response *remoting.PendingResponse) error {
        _, session, err := c.selectSession(c.addr)
        // .. 省略
        if totalLen, sendLen, err = c.transfer(session, request, timeout); err != nil {
            if sendLen != 0 && totalLen != sendLen {
              // .. 省略
            }
            return perrors.WithStack(err)
        }

        // .. 省略
        select {
        case <-getty.GetTimeWheel().After(timeout):
            return perrors.WithStack(errClientReadTimeout)
        case <-response.Done:
            err = response.Err
        }
        return perrors.WithStack(err)
    }

    场景2:Context 的超时处理

    func main() {
        ctx, cancel := context.WithTimeout(context.Background(), 1*time.Second)
        defer cancel()
        go doSomething()
        
        select {
        case <-ctx.Done():
            fmt.Println("main", ctx.Err())
        }
    }

    2. 图解源码

    2.1 四叉堆原理

    timer 的全局堆是一个四叉堆,特别是 Go 1.14 之后每个 P 都会维护着一个四叉堆,减少了 Goroutine 之间的并发问题,提升了 timer 了性能。

    四叉堆其实就是四叉树,Go timer 是如何维护四叉堆的呢?

    这里用两张动图简单演示下 timer 的插入和删除

    把 timer 插入堆Go timer 是如何被调度的?-LMLPHP

    把 timer 从堆中删除Go timer 是如何被调度的?-LMLPHP

    2.2 timer 是如何被调度的?

    2.3 timer 是如何加入到 timer 堆上的?

    把 timer 加入调度总共有下面几种方式:

    2.4 Reset 时 timer 是如何被操作的?

    Reset 的目的是把 timer 重新加入到 timer 堆中,重新等待被触发。不过分为两种情况:

    2.5 Stop 时 timer 是如何被操作的?

    time.Stop 为了让 timer 停止,不再被触发,也就是从 timer 堆上删除。不过 timer.Stop 并不会真正的从 p 的 timer 堆上删除 timer,只会将 timer 的状态修改为 timerDeleted。然后等待 GMP 触发的 adjusttimers 或者 runtimer 来执行。

    真正删除 timer 的函数有两个 dodeltimer,dodeltimer0。

    2.6 Timer 是如何被真正执行的?

    timer 的真正执行者是 GMP。GMP 会在每个调度周期内,通过 runtime.checkTimers 调用 timer.runtimer(). timer.runtimer 会检查该 p 的 timer 堆上的所有 timer,判断这些 timer 是否能被触发。

    如果该 timer 能够被触发,会通过回调函数 sendTime 给 Timer 的 channel C 发一个当前时间,告诉我们这个 timer 已经被触发了。

    如果是 ticker 的话,被触发后,会计算下一次要触发的时间,重新将 timer 加入 timer 堆中。

    3. Timer 使用中的坑

    确实 timer 是我们开发中比较常用的工具,但是 timer 也是最容易导致内存泄露,CPU 狂飙的杀手之一。

    不过仔细分析可以发现,其实能够造成问题就两个方面:

    3.1 错误创建很多 timer,导致资源浪费

    func main() {
        for {
            // xxx 一些操作
            timeout := time.After(30 * time.Second)
            select {
            case <- someDone:
                // do something
            case <-timeout:
                return
            }
        }
    }

    上面这段代码是造成 timer 异常的最常见的写法,也是我们最容易忽略的写法。

    造成问题的原因其实也很简单,因为 timer.After 底层是调用的 timer.NewTimer,NewTimer 生成 timer 后,会将 timer 放入到全局的 timer 堆中。

    for 会创建出来数以万计的 timer 放入到 timer 堆中,导致机器内存暴涨,同时不管 GMP 周期 checkTimers,还是插入新的 timer 都会疯狂遍历 timer 堆,导致 CPU 异常。

    要注意的是,不只 time.After 会生成 timer, NewTimer,time.AfterFunc 同样也会生成 timer 加入到 timer 中,也都要防止循环调用。

    解决办法: 使用 time.Reset 重置 timer,重复利用 timer。

    我们已经知道 time.Reset 会重新设置 timer 的触发时间,然后将 timer 重新加入到 timer 堆中,等待被触发调用。

    func main() {
        timer := time.NewTimer(time.Second * 5)    
        for {
            timer.Reset(time.Second * 5)

            select {
            case <- someDone:
                // do something
            case <-timer.C:
                return
            }
        }
    }

    3.2 程序阻塞,造成内存或者 goroutine 泄露

    func main() {
        timer1 := time.NewTimer(2 * time.Second)
        <-timer1.C
        println("done")
    }

    上面的代码可以看出来,只有等待 timer 超时 "done" 才会输出,原理很简单:程序阻塞在 <-timer1.C 上,一直等待 timer 被触发时,回调函数 time.sendTime 才会发送一个当前时间到 timer1.C 上,程序才能继续往下执行。

    不过使用 timer.Stop 的时候就要特别注意了,比如:

    func main() {
        timer1 := time.NewTimer(2 * time.Second)
        go func() {
            timer1.Stop()
        }()
        <-timer1.C

        println("done")
    }

    程序就会一直死锁了,因为 timer1.Stop 并不会关闭 channel C,使程序一直阻塞在 timer1.C 上。

    上面这个例子过于简单了,试想下如果 <- timer1.C 是阻塞在子协程中,timer 被的 Stop 方法被调用,那么子协程可能就会被永远的阻塞在那里,造成 goroutine 泄露,内存泄露。

    Stop 的正确的使用方式:

    func main() {
        timer1 := time.NewTimer(2 * time.Second)
        go func() {
            if !timer1.Stop() {
                <-timer1.C
            }
        }()

        select {
        case <-timer1.C:
            fmt.Println("expired")
        default:
        }
        println("done")
    }

    到此,Go timer 基本已经结束了,有想跟我讨论的可以在留言区评论。


    Go timer 完整流程图获取链接:链接: 链接: https://pan.baidu.com/s/1nUvTK_0qBlwbS6LbZXKM7g 密码: t219 其他模块流程图,请关注公众号 HHFCodeRv 回复1获取。

    更多学习学习资料分享,关注公众号回复指令:


    本文分享自微信公众号 - HHFCodeRv(hhfcodearts)。
    如有侵权,请联系 [email protected] 删除。
    本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

    06-12 14:42