go runtime.goexit()与os.exit()区别
光看标题,大家可能不太理解我说的是啥。
我们平时创建一个协程,跑一段逻辑,代码大概长这样。
package main
import (
"fmt"
"time"
)
func Foo() {
fmt.Println("打印1")
defer fmt.Println("打印2")
fmt.Println("打印3")
}
func main() {
go Foo()
fmt.Println("打印4")
time.Sleep(1000*time.Second)
}
// 这段代码,正常运行会有下面的结果
打印4
打印1
打印3
打印2
注意这上面"打印2"是在defer
中的,所以会在函数结束前打印。因此后置于"打印3"。
那么今天的问题是,如何让Foo()
函数跑一半就结束,比如说跑到打印2,就退出协程。输出如下结果
打印4
打印1
打印2
也不卖关子了,我这边直接说答案。
在"打印2"后面插入一个 runtime.Goexit()
, 协程就会直接结束。并且结束前还能执行到defer
里的打印2。
package main
import (
"fmt"
"runtime"
"time"
)
func Foo() {
fmt.Println("打印1")
defer fmt.Println("打印2")
runtime.Goexit() // 加入这行
fmt.Println("打印3")
}
func main() {
go Foo()
fmt.Println("打印4")
time.Sleep(1000*time.Second)
}
// 输出结果
打印4
打印1
打印2
可以看到打印3这一行没出现了,协程确实提前结束了。
其实面试题到这里就讲完了,这一波自问自答可还行?
但这不是今天的重点,我们需要搞搞清楚内部的逻辑。
runtime.Goexit()是什么?
看一下内部实现。
func Goexit() {
// 以下函数省略一些逻辑...
gp := getg()
for {
// 获取defer并执行
d := gp._defer
reflectcall(nil, unsafe.Pointer(d.fn), deferArgs(d), uint32(d.siz), uint32(d.siz))
}
goexit1()
}
func goexit1() {
mcall(goexit0)
}
从代码上看,runtime.Goexit()
会先执行一下defer
里的方法,这里就解释了开头的代码里为什么在defer里的打印2能正常输出。
然后代码再执行goexit1
。本质就是对goexit0
的简单封装。
我们可以把代码继续跟下去,看看goexit0
做了什么。
// goexit continuation on g0.
func goexit0(gp *g) {
// 获取当前的 goroutine
_g_ := getg()
// 将当前goroutine的状态置为 _Gdead
casgstatus(gp, _Grunning, _Gdead)
// 全局协程数减一
if isSystemGoroutine(gp, false) {
atomic.Xadd(&sched.ngsys, -1)
}
// 省略各种清空逻辑...
// 把g从m上摘下来。
dropg()
// 把这个g放回到p的本地协程队列里,放不下放全局协程队列。
gfput(_g_.m.p.ptr(), gp)
// 重新调度,拿下一个可运行的协程出来跑
schedule()
}
这段代码,信息密度比较大。
很多名词可能让人一脸懵。
简单描述下,Go语言里有个GMP模型的说法,M
是内核线程,G
也就是我们平时用的协程goroutine
,P
会在G和M之间
做工具人,负责调度G
到M
上运行。
GMP图
既然是调度,也就是说不是每个G
都能一直处于运行状态,等G不能运行时,就把它存起来,再调度下一个能运行的G过来运行。
暂时不能运行的G,P上会有个本地队列去存放这些这些G,P的本地队列存不下的话,还有个全局队列,干的事情也类似。
了解这个背景后,再回到 goexit0
方法看看,做的事情就是将当前的协程G置为_Gdead
状态,然后把它从M上摘下来,尝试放回到P的本地队列中。然后重新调度一波,获取另一个能跑的G,拿出来跑。
goexit
所以简单总结一下,只要执行 goexit 这个函数,当前协程就会退出,同时还能调度下一个可执行的协程出来跑。
看到这里,大家应该就能理解,开头的代码里,为什么runtime.Goexit()
能让协程只执行一半就结束了。
goexit的用途
看是看懂了,但是会忍不住疑惑。面试这么问问,那只能说明你遇到了一个喜欢为难年轻人的面试官,但正经人谁会没事跑一半协程就结束呢?所以goexit
的真实用途是啥?
有个小细节,不知道大家平时debug的时候有没有关注过。
为了说明问题,这里先给出一段代码。
package main
import (
"fmt"
"time"
)
func Foo() {
fmt.Println("打印1")
}
func main() {
go Foo()
fmt.Println("打印3")
time.Sleep(1000*time.Second)
}
这是一段非常简单的代码,输出什么完全不重要。通过go
关键字启动了一个goroutine
执行Foo()
,里面打印一下就结束,主协程sleep
很长时间,只为死等。
这里我们新启动的协程里,在Foo()
函数内随便打个断点。然后debug
一下。
会发现,这个协程的堆栈底部是从runtime.goexit()
里开始启动的。
如果大家平时有注意观察,会发现,其实所有的堆栈底部,都是从这个函数开始的。我们继续跟跟代码。
goexit是什么?
从上面的debug
堆栈里点进去会发现,这是个汇编函数,可以看出调用的是runtime
包内的 goexit1()
函数。
// The top-most function running on a goroutine
// returns to goexit+PCQuantum.
TEXT runtime·goexit(SB),NOSPLIT,$0-0
BYTE $0x90 // NOP
CALL runtime·goexit1(SB) // does not return
// traceback from goexit1 must hit code range of goexit
BYTE $0x90 // NOP
于是跟到了pruntime/proc.go
里的代码中。
// 省略部分代码
func goexit1() {
mcall(goexit0)
}
是不是很熟悉,这不就是我们开头讲runtime.Goexit()
里内部执行的goexit0
吗。
为什么每个堆栈底部都是这个方法?
我们首先需要知道的是,函数栈的执行过程,是先进后出。
假设我们有以下代码
func main() {
B()
}
func B() {
A()
}
func A() {
}
上面的代码是main运行B函数,B函数再运行A函数,代码执行时就跟下面的动图那样。
函数堆栈执行顺序
这个是先进后出的过程,也就是我们常说的函数栈,执行完子函数A()后,就会回到父函数B()中,执行完B()后,最后就会回到main()。这里的栈底是main()
,如果在栈底插入的是 goexit
的话,那么当程序执行结束的时候就都能跑到goexit
里去。
结合前面讲过的内容,我们就能知道,此时栈底的goexit
,会在协程内的业务代码跑完后被执行到,从而实现协程退出,并调度下一个可执行的G来运行。
那么问题又来了,栈底插入goexit
这件事是谁做的,什么时候做的?
直接说答案,这个在runtime/proc.go
里有个newproc1
方法,只要是创建协程都会用到这个方法。里面有个地方是这么写的。
func newproc1(fn *funcval, argp unsafe.Pointer, narg int32, callergp *g, callerpc uintptr) {
// 获取当前g
_g_ := getg()
// 获取当前g所在的p
_p_ := _g_.m.p.ptr()
// 创建一个新 goroutine
newg := gfget(_p_)
// 底部插入goexit
newg.sched.pc = funcPC(goexit) + sys.PCQuantum
newg.sched.g = guintptr(unsafe.Pointer(newg))
// 把新创建的g放到p中
runqput(_p_, newg, true)
// ...
}
主要的逻辑是获取当前协程G所在的调度器P,然后创建一个新G,并在栈底插入一个goexit。
所以我们每次debug的时候,就都能看到函数栈底部有个goexit函数。
main函数也是个协程,栈底也是goexit?
关于main函数栈底是不是也有个goexit
,我们对下面代码断点看下。直接得出结果。
main函数栈底也是goexit()
。
从 asm_amd64.s
可以看到Go程序启动的流程,这里提到的 runtime·mainPC
其实就是 runtime.main
.
// create a new goroutine to start program
MOVQ $runtime·mainPC(SB), AX // 也就是runtime.main
PUSHQ AX
PUSHQ $0 // arg size
CALL runtime·newproc(SB)
通过runtime·newproc
创建runtime.main
协程,然后在runtime.main
里会启动main.main
函数,这个就是我们平时写的那个main函数了。
// runtime/proc.go
func main() {
// 省略大量代码
fn := main_main // 其实就是我们的main函数入口
fn()
}
//go:linkname main_main main.main
func main_main()
结论是,其实main函数也是由newproc创建的,只要通过newproc创建的goroutine,栈底就会有一个goexit。
os.Exit()和runtime.Goexit()有什么区别
最后再回到开头的问题,实现一下首尾呼应。
开头的面试题,除了runtime.Goexit()
,是不是还可以改为用os.Exit()
?
同样都是带有"退出"的含义,两者退出的对象不同。os.Exit()
指的是整个进程退出;而runtime.Goexit()
指的是协程退出。
可想而知,改用os.Exit()
这种情况下,defer里的内容就不会被执行到了。
package main
import (
"fmt"
"os"
"time"
)
func Foo() {
fmt.Println("打印1")
defer fmt.Println("打印2")
os.Exit(0)
fmt.Println("打印3")
}
func main() {
go Foo()
fmt.Println("打印4")
time.Sleep(1000*time.Second)
}
// 输出结果
打印4
打印1
总结
•通过 runtime.Goexit()
可以做到提前结束协程,且结束前还能执行到defer的内容• runtime.Goexit()
其实是对goexit0的封装,只要执行 goexit0 这个函数,当前协程就会退出,同时还能调度下一个可执行的协程出来跑。•通过newproc
可以创建出新的goroutine
,它会在函数栈底部插入一个goexit。•os.Exit()
指的是整个进程退出;而runtime.Goexit()
指的是协程退出。两者含义有区别。
最后
无用的知识又增加了。
一般情况下,业务开发中,谁会没事执行这个函数呢?
但是开发中不关心,不代表面试官不关心!
下次面试官问你,如果想在goroutine执行一半就退出协程,该怎么办?你知道该怎么回答了吧?