Golang中panic與recover的實現原理

今天咱們講講golang中panic異常,以及recover對異常的捕獲,因爲panic、recover、defer之間很是親密,因此今天就放在一塊兒講解,這裏會涉及到一些defer的知識,有興趣能夠看個人另外一篇關於defer的文章 Golang中defer的實現原理.html

Panic異常

Go的類型系統會在編譯時捕獲不少錯誤,但有些錯誤只能在運行時檢查,如數組訪問越界、 空指針引用等。這些運行時錯誤會引發painc異常。
通常而言,當panic異常發生時,程序會中斷運行,並當即執行在該goroutine中被延遲的函數(defer 機制)。隨後,程序崩潰並輸出日誌信息。
不是全部的panic異常都來自運行時,直接調用內置的panic函數也會引起panic異常
接下來,咱們經過其彙編碼嘗試找出內置函數panic()的底層實現。


git

注意:我會把源碼中每一個方法的做用都註釋出來,能夠參考註釋進行理解。golang

先編寫一段簡單的代碼,並保存在panic.go文件中web

func main() { 
	panic("err")
}

而後使用如下命令編譯代碼:編程

go tool compile -S panic.go
0x0024 00036 (panic.go:10)      PCDATA  $2, $1
        0x0024 00036 (panic.go:10)      PCDATA  $0, $0
        0x0024 00036 (panic.go:10)      LEAQ    type.string(SB), AX
        0x002b 00043 (panic.go:10)      PCDATA  $2, $0
        0x002b 00043 (panic.go:10)      MOVQ    AX, (SP)
        0x002f 00047 (panic.go:10)      PCDATA  $2, $1
        0x002f 00047 (panic.go:10)      LEAQ    "".statictmp_0(SB), AX
        0x0036 00054 (panic.go:10)      PCDATA  $2, $0
        0x0036 00054 (panic.go:10)      MOVQ    AX, 8(SP)
        0x003b 00059 (panic.go:10)      CALL    runtime.gopanic(SB)

咱們能夠看到panic()函數調用被替換成了runtime.gopanic()函數
看函數以前,咱們先來看一下panic的結構體
數組

runtime\runtime2.go:_panic安全

type _panic struct { 
	argp      unsafe.Pointer // 指向在panic下運行的defer的參數的指針
	arg       interface{ }    // panic的參數
	link      *_panic        // 連接到更早的panic,新panic添加到表頭
	recovered bool           // 該panic是否被recover
	aborted   bool           // 該panic是否強制退出
}

接着,咱們再來分析runtime.gopanic()函數服務器

runtime\panic.go函數

func gopanic(e interface{ }) { 
	//獲取當前goroutine
	gp := getg()
	...
	//生成一個新的panic結構
	var p _panic
	p.arg = e
	//指向更早的panic
	p.link = gp._panic
	//綁定到goroutine
	gp._panic = (*_panic)(noescape(unsafe.Pointer(&p)))

	atomic.Xadd(&runningPanicDefers, 1)

	//循環goroutine中的defer鏈表
	for { 
		d := gp._defer
		if d == nil { 
			break
		}
		//若是defer已經被調用
		//若是該defer已經由較早的panic或者Goexit使用(表示引起了新的panic)
		//則從鏈表中去除這個panic,以前的panic或Goexit將不會繼續運行。
		if d.started { 
			if d._panic != nil { 
				d._panic.aborted = true
			}
			d._panic = nil
			d.fn = nil
			gp._defer = d.link
			//釋放該defer
			freedefer(d)
			//跳過循環,繼續下一個defer
			continue
		}
		// 將defer標記已調用,但保留在列表中
		//這樣 traceback 在棧增加或者 GC 的時候,可以找到並更新 defer 的參數棧幀
        // 並用 reflectcall 執行 d.fn
		d.started = true
		//記錄在 defer 中發生的 panic
		//若是在 defer 的函數調用過程當中又發生了新的 panic,那個 panic 會在鏈表中找到 d
        // 而後標記 d._panic(指向當前的 panic) 爲 aborted 狀態。
		d._panic = (*_panic)(noescape(unsafe.Pointer(&p)))

		p.argp = unsafe.Pointer(getargp(0))
		//執行defer後面的fn,若是有recover()函數會執行recover
		reflectcall(nil, unsafe.Pointer(d.fn), deferArgs(d), uint32(d.siz), uint32(d.siz))
		p.argp = nil

		// reflectcall 並無 panic,移除 d
		if gp._defer != d { 
			throw("bad defer entry in panic")
		}
		//清空defer
		d._panic = nil
		d.fn = nil
		//下一個defer
		gp._defer = d.link

		// trigger shrinkage to test stack copy. See stack_test.go:TestStackPanic
		//GC()
		
		//defer語句下一條語句的地址
		pc := d.pc
		//獲取rsp寄存器的值的指針
		//必須是指針,以便在堆棧複製期間進行調整
		sp := unsafe.Pointer(d.sp) 
		//釋放defer
		freedefer(d)
		//若是panic被recover
		//會在gorecove 函數中已經修改成 true ,等會咱們在講
		if p.recovered { 
			//統計
			atomic.Xadd(&runningPanicDefers, -1)
			
			//下一個panic
			gp._panic = p.link
			// 已標記已停止的panic,q且保留在g.panic列表中。
			//從列表中刪除它們。
			for gp._panic != nil && gp._panic.aborted { 
				gp._panic = gp._panic.link
			}
			//處理完全部panic
			if gp._panic == nil {  // 必須用信號完成
				gp.sig = 0
			}
			// Pass information about recovering frame to recovery.
			//將有關恢復幀的信息傳遞給recovery函數
			//經過以前傳入的 sp 和 pc 恢復
			gp.sigcode0 = uintptr(sp)
			gp.sigcode1 = pc
			mcall(recovery)
			throw("recovery failed") // mcall should not return
		}
	}

	// ran out of deferred calls - old-school panic now
	// Because it is unsafe to call arbitrary user code after freezing
	// the world, we call preprintpanics to invoke all necessary Error
	// and String methods to prepare the panic strings before startpanic.
	preprintpanics(gp._panic)
	
	//致命錯誤,終止程序
	fatalpanic(gp._panic) // should not return
	*(*int)(nil) = 0      // not reached
}

接着,咱們再來看看它是如何經過recovery函數回覆的ui

func recovery(gp *g) { 
	// Info about defer passed in G struct.
	sp := gp.sigcode0
	pc := gp.sigcode1

	// d's arguments need to be in the stack.
	if sp != 0 && (sp < gp.stack.lo || gp.stack.hi < sp) { 
		print("recover: ", hex(sp), " not in [", hex(gp.stack.lo), ", ", hex(gp.stack.hi), "]\n")
		throw("bad recovery")
	}
	//讓這個 defer 結構體的 deferproc 位置的調用從新返回
    // 此次將返回值修改成 1
	gp.sched.sp = sp
	gp.sched.pc = pc
	gp.sched.lr = 0
	gp.sched.ret = 1
	//直接跳回到deferreturn那裏去
	gogo(&gp.sched)
}

咱們再來總結一下整個流程:

  1. 先建立一個_panic結構體,加載到鏈表的表頭
  2. 遍歷當前goroutine的defer鏈表,
    • 若是defer被標記爲已調用,跳出當前循環,進入下一個defer;
    • 不然,將當前defer標記爲已調用,同時執行defer後面的函數,若是有recover,則會經過以前建立defer時傳進來的deferproc 的下一條彙編指令的地址(pc),以及函數調用棧棧頂的位置(sp)返回到deferreturn的位置上去,不然,直接退出程序

Recover捕獲異常

一般來講,不該該對panic異常作任何處理,但有時,也許咱們能夠從異常中恢復,至少咱們 能夠在程序崩潰前,作一些操做。好比說:當web服務器遇到不可預料的嚴重問題時,在崩潰前應該將全部的鏈接關閉,服務器甚至能夠將異常信息反饋到客戶端,幫助調試。
若是在defer函數中調用了內置函數recover,而且定義該defer語句的函數發生了panic異常,recover會使程序從panic中恢復,並返回panic value。致使panic異常的函數不會繼續運行,但能正常返回。在未發生panic時調用recover,recover會返回nil。

recover函數的使用

1.recover必須與defer配合使用
func main() { 
	defer func() { 
			recover()
			 }()
	panic("err")
}

相似於下面這種狀況是不能夠的:

func main() { 
	recover()
	panic("觸發異常")

}

在這裏插入圖片描述

2.必須在defer函數中直接調用recover,不能進行封裝或者嵌套
func main() { 
	defer func() { 
		if r := MyRecover(); r != nil { 
			fmt.Println(r)
		}
	}()
	panic("err")
}
func MyRecover() interface{ } { 
	fmt.Println("recover")
	return recover()
}

在這裏插入圖片描述
一樣,在defer中嵌套也不能夠

func main() { 
	defer func() { 
		defer func() { 
			if r := recover(); r != nil { 
				fmt.Println(r)
			}
		}()
	}()
	panic("err")
}

若是咱們直接在 defer 語句中調用 MyRecover 函數又能夠正常工做了:

func main() { 
	//正常捕獲
	defer MyRecover()
	panic("err")
}
func MyRecover() interface{ } { 
	fmt.Println("recover")
	return recover()
}

可是,若是 defer 語句直接調用 recover 函數,依然不能正常捕獲異常:

func main() {  
	// 沒法捕獲異常
	defer recover()
	panic("err")
}

必需要和有異常的棧幀只隔一個棧幀, recover 函數才能正常捕獲異常。換言之, recover 函數捕獲的是祖父一級調用函數棧幀的異常(恰好能夠跨越一層 defer 函數)!

同時,爲了不不加區分的panic被恢復,可能致使系統漏洞的問題,最安全的作飯,就是對不一樣的錯誤類型分別處理

recover函數的原理

接下來,咱們經過底層源碼來看看它是如何作到這些限制的:

runtime\panic.go

func gorecover(argp uintptr) interface{ } { 
	
	gp := getg()
	p := gp._panic
	//必須存在panic
	//非runtime.Goexit();
	//panic還未被恢復
	//argp == uintptr(p.argp)
	//p.argp是最頂層的延遲函數調用的參數指針,argp是調用recover函數的參數地址,一般是defer函數的參數地址
	//若是二者相等,說明能夠被恢復,這也是爲何recover必須跟在defer後面且recover 函數捕獲的是祖父一級調用函數棧幀的異常的緣由
	if p != nil && !p.goexit && !p.recovered && argp == uintptr(p.argp) { 
		//將recovered 標誌改成true
		p.recovered = true
		return p.arg
	}
	return nil
}

gorecover函數比較簡單,就是將recovered設爲true,說明已經defer後面的函數包含recover

總結

  • recover函數在defer函數中
  • recover函數被defer函數直接調用
  • 若是包含多個defer函數,前面的defer經過recover()消除panic後,函數中剩餘的defer仍然會執行,但不能再次recover()
  • 連續調用panic,僅最後一個會被recover捕獲

參考

  1. Go語言聖經.
  2. Go語言高級編程.
相關文章
相關標籤/搜索