defer 鏈如何被遍歷

去年開始寫文章的第一篇就是關於 defer，名字比較文藝：《Golang 之輕鬆化解 defer 的溫柔陷阱》，還被吐槽了。由於這篇文章，到《Go 夜讀》講了一期。不過當時純粹是應用層面的，也尚未跳進 Go 源碼這個大坑，文章看着比較清新，也沒有大段的源碼解析。

自從聽了曹大在《Go 夜讀》分享的 Go 彙編，以及研讀了阿波張的 Go 調度器源碼分析的文章後，各類源碼、彙編滿天飛……

上次歐神寫了一篇《Go GC 20 問》，全文也沒有一行源碼，總體讀下來很暢快。今天這篇也來嘗試一下這種寫法，不過，咱們先從一個小的主題開始：defer 鏈表是如何被遍歷並執行的。

關於 defer 的源碼分析文章，網絡上也有不少。不過，不多有能徹底說明白這個話題的，除了阿波張的。

咱們知道，爲了在退出函數前執行一些資源清理的操做，例如關閉文件、釋放鏈接等。會在函數裏寫上多個 defer 語句，被 defered 的函數，以「先進後出」的順序，在 RET 指令前得以執行。

在一條函數調用鏈中，多個函數中會出現多個 defer 語句。例如：a() -> b() -> c() 中，每一個函數裏都有 defer 語句，而這些 defer 語句會建立對應個數的 _defer 結構體，這些結構體以鏈表的形式掛在 goroutine 結構體下。看起來像這樣：

在編譯器的加持下，defer 語句會先調用 deferporc 函數，new 一個 _defer 結構體，掛到 g 上。固然，這裏的 new 會優先從當前綁定的 P 的 defer pool 裏取，沒取到會去全局的 defer pool 裏取，實在沒有的話就新建一個，很熟悉的套路。

這樣作好以後，等待函數體執行完，在 RET 指令以前（注意不是 return 以前），調用 deferreturn 函數完成 _defer 鏈表的遍歷，執行完這條鏈上全部被 defered 的函數（如關閉文件、釋放鏈接等）。這裏的問題是在 deferreturn 函數的最後，會使用 jmpdefer 跳轉到以前被 defered 的函數，這時控制權轉移到了用戶自定義的函數。這只是執行了一個被 defered 的函數，這條鏈上其餘的被 defered 的函數，該如何獲得執行呢？

答案就是控制權會再次交給 runtime，並再次執行 deferreturn 函數，完成 defer 鏈表的遍歷。那這一切是如何完成的呢？

這就要從 Go 彙編的棧幀提及了。先看一個彙編函數的聲明：

TEXT runtime·gogo(SB), NOSPLIT, $16-8
複製代碼

最後兩個數字表示 gogo 函數的棧幀大小爲 16B，即函數的局部變量和爲調用子函數準備的參數和返回值須要 16B 的棧空間；參數和返回值的大小加起來是 8B。實際上 gogo 函數的聲明是這樣的：

// func gogo(buf *gobuf)
複製代碼

參數及返回值的大小是給調用者「看」的，調用者根據這個數字能夠構造棧：準備好被調函數須要的參數及返回值。

典型的函數調用場景下參數佈局圖以下圖：

左圖中，主調函數準備好調用子函數的參數及返回值，執行 CALL 指令，將返回地址壓入棧頂，至關於執行了 PUSH IP，以後，將 BP 寄存器的值入棧，至關於執行了 PUSH BP，再 jmp 到被調函數。

圖中 return address 表示子函數執行完畢後，返回到上層函數中調用子函數語句的下一條要執行的指令，它屬於 caller 的棧幀。而調用者的 BP 則屬於被調函數的棧幀。

子函數執行完畢後，執行 RET 指令：首先將子函數棧底部的值賦到 CPU 的 BP 寄存器中，因而 BP 指向上層函數的 BP；再將 return address 賦到 IP 寄存器中，這時 SP 回到左圖所示的位置。至關於還原了整個調用子函數的現場，像是一切都沒發生過；接着，CPU 繼續執行 IP 寄存器裏的下一條指令。

再回到 defer 上來，其實在構造 _defer 結構體的時候，須要將當前函數的 SP、被 defered 的函數指針保存到 _defer 結構體中。而且會將被 defered 的函數所須要的參數 copy 到 _defer 結構體相鄰的位置。最終在調用被 defered 的函數的時候，用的就是這時被 copy 的值，至關於使用了它的一個快照，若是此參數不是指針或引用類型的話，會產生一些意料以外的 bug。

最後，在 deferreturn 函數裏，這些被 defered 的函數得以執行，_defer 鏈表也會被逐漸「消耗」完。

使用一個阿波張文章中的例子：

package main

import "fmt"

func sum(a, b int) {
    c := a + b
    fmt.Println("sum:" , c)
}

func f(a, b int) {
    defer sum(a, b)

    fmt.Printf("a: %d, b: %d\n", a, b)
}

func main() {
    a, b := 1, 2
    f(a, b)
}
複製代碼

執行完 f 函數時，最終會進入 deferreturn 函數：

func deferreturn(arg0 uintptr) {
    gp := getg()
	d := gp._defer
	if d == nil {
		return
	}
	
	......
	
	switch d.siz {
	case 0:
		// Do nothing.
	case sys.PtrSize:
		*(*uintptr)(unsafe.Pointer(&arg0)) = *(*uintptr)(deferArgs(d))
	default:
		memmove(unsafe.Pointer(&arg0), deferArgs(d), uintptr(d.siz)) // 移動參數
	}
	fn := d.fn
	d.fn = nil
	gp._defer = d.link
	freedefer(d)
	
	_ = fn.fn
	jmpdefer(fn, uintptr(unsafe.Pointer(&arg0)))
}
複製代碼

免不了仍是要看一下代碼，否則的話很難講清楚。

由於咱們是在遍歷 _defer 鏈表，因此得有一個終止的條件：

d := gp._defer
if d == nil {
		return
}
複製代碼

也就是當 _defer 鏈表爲空的時候，終止遍歷。在後面的代碼裏會看到，每執行完一個被 defered 的函數後，都會將 _defer 結構體從鏈表中刪除並回收，因此 _defer 鏈表會愈來愈短。

switch 語句裏要作的就是準備好被 defered 的函數（例子中就是 sum 函數）所須要的 a，b 兩個 int 型參數。參數從哪來呢？從 _defer 結構體相鄰的位置，還記得嗎，這是在 deferproc 函數裏 copy 過去的。deferArgs(d) 返回的就是當時 copy 的目的地址。那如今要拷貝到哪去呢？答案是：unsafe.Pointer(&arg0)。咱們知道，arg0 是 deferreturn 函數的參數，咱們又知道，在 Go 彙編中，一個函數的參數是由它的主調函數準備的。所以 arg0 的地址實際上就是它的上層函數（在這裏就是 f 函數）的棧上放參數的位置。

函數的最後，經過 jmpdefer 跳轉到被 defered 的 sum 函數：

jmpdefer(fn, uintptr(unsafe.Pointer(&arg0)))
複製代碼

核心在於 jmpdefer 所作的事：

TEXT runtime·jmpdefer(SB), NOSPLIT, $0-16
    MOVQ	fv+0(FP), DX	// fn // defer 的函數的地址
    MOVQ	argp+8(FP), BX
    LEAQ	-8(BX), SP	// caller sp after CALL
    MOVQ	-8(SP), BP	// restore BP as if deferreturn returned (harmless if framepointers not in use)
    SUBQ	$5, (SP)	// return to CALL again
    MOVQ	0(DX), BX
    JMP	BX	// but first run the deferred function
複製代碼

首先將 sum 函數的地址放到 DX 寄存器中，最後經過 JMP 指令去執行。

MOVQ	argp+8(FP), BX
LEAQ	-8(BX), SP	// caller sp after CALL // 執行 CALL 指令後 f 函數的棧頂
複製代碼

這兩行其實是調整了下當前 SP 寄存器的值，由於 argp+8(FP) 其實是 jmpdefer 的第二個參數（它在 deferreturn 函數中），它指向 f 函數棧幀中的剛被 copy 過來的 sum 函數的參數。而 -8(BX) 就表明了 f 函數調用 deferreturn 的返回地址，實際上就是 deferreturn 函數的下一條指令地址。

接着，MOVQ -8(SP), BP 這條指令則重置了 BP 寄存器，使它指向了 f 棧幀 的 BP。這樣，SP、BP 寄存器回到了 f 函數調用 deferreturn 以前的狀態：f 剛準備好調用 deferreturn 的參數，而且把返回值壓棧了。至關於拋棄了 deferreturn 函數的棧幀，不過，確實也沒什麼用了。

接着 SUBQ $5, (SP) 把返回地址減小了 5B，恰好是一個 CALL 指令的長度。什麼意思？當執行完 deferreturn 函數以後，執行流程會返回到 CALL deferreturn 的下一條指令，將這個值減小 5B，也就又回到了 CALL deferreturn 指令，從而實現了「遞歸地」調用 deferreturn 函數的效果。固然，棧卻不會在增加！

jmpdefer 函數的最後會執行 sum 函數，看起來就像是 f 函數親自調用 sum 函數同樣，參數、返回值都是就緒的。

等到 sum 函數執行完，執行流程就會跳轉到 call deferreturn 指令處從新進入 deferreturn 函數，遍歷完全部的 _defer 結構體，執行完全部的被 defered 的函數，才真正執行完 deferretrun 函數。

到這裏，全文就結束了。咱們能夠看到，實現遍歷 defer 鏈表的關鍵就是 jmpdefer 函數所作的一些「見不得人」的工做，將調用 deferreturn 函數的返回地址減小了 5 個字節，使得被 defered 的函數執行完後，又回到 CALL deferreturn 指令處，從而實現「遞歸地」調用 deferreturn 函數，完成 _defer 鏈表的遍歷。

參考資料

【阿波張 defer 源碼分析】mp.weixin.qq.com/s/iEtMbRXW4…

【阿波張 panic&recover】mp.weixin.qq.com/s/0JTBGHr-b…

【阿波張 defer 基礎】mp.weixin.qq.com/s/QmeQTONUu…

【彙編分析】segmentfault.com/a/119000001…

【曹大 Go 彙編分享】github.com/cch123/asms…

【曹大 Go 彙編】xargin.com/plan9-assem…

【曹大利用匯編寫的 goid 獲取】github.com/cch123/goro…

歡迎關注個人公衆號：碼農桃花源