建站
咨詢
售后
建站咨詢
新聞中心
我之前寫過一篇文章：為什么 Go 標(biāo)準(zhǔn)庫中有些函數(shù)只有簽名，沒有函數(shù)體?，其中有一點(diǎn)就是 //go:linkname 這個(gè)指令。
目前創(chuàng)新互聯(lián)已為上1000+的企業(yè)提供了網(wǎng)站建設(shè)、域名、雅安服務(wù)器托管、成都網(wǎng)站托管、企業(yè)網(wǎng)站設(shè)計(jì)、五河網(wǎng)站維護(hù)等服務(wù)，公司將堅(jiān)持客戶導(dǎo)向、應(yīng)用為本的策略，正道將秉承"和諧、參與、激情"的文化，與客戶和合作伙伴齊心協(xié)力一起成長，共同發(fā)展。
Go 中類似的指令挺多的，比如 Go1.16 中的 //go:embed。前些天有人問我，為什么它用 //go:embed 不起作用?我一看，它是這么寫的：// go:embed，不知道你看到問題了沒有?是的，指令是通過注釋的方式，但有三點(diǎn)要求，要特別注意：
- // 后不能有空格。有些人可能習(xí)慣 // 后不加空格。但一般認(rèn)為，// 后應(yīng)該加一個(gè)空格。不過 go 指令卻要求不能有空格，這是一個(gè)小“坑”，得注意。所以上面那位朋友就是加了空格，導(dǎo)致出問題。(程序并不會(huì)報(bào)錯(cuò)，只是沒有得到自己想要的結(jié)果)
- 代碼和指令之間不能有空行或其他注釋。這一點(diǎn)應(yīng)該還好，很多人不會(huì)用錯(cuò)吧;
- 一般來說，使用指令需要導(dǎo)入相應(yīng)的包。比如 //go:linkname 指令要求導(dǎo)入 unsafe 包，一般會(huì) import _ "unsafe”，//go:embed 指令，要求導(dǎo)入 embed 包。
有另外一位 Go 朋友「橘中秘士」微信私聊我：
大佬好，能不能寫一篇 linkname 的文章。目前已經(jīng)有了一些初步概念，但是尚有一些疑團(tuán)不是特別清晰。
//go:linkname localname remotename，其中 local 作為占位符 remote 作為實(shí)現(xiàn)者或者 local 作為實(shí)現(xiàn)者 remote 作為占位符都是可以的。目前理解的就是給 Symbol 添加了一個(gè) Linkname，查找 Symbo l的時(shí)候用 remote。
譬如 //go:linkname runtimeNano runtime.nanotime，runtimeNano 作為占位符 runtime.nanotime 提供實(shí)現(xiàn)，任何調(diào)用 runtimeNano 的地方實(shí)際替換為對(duì) runtime.nanotime 的調(diào)用，這種場(chǎng)景比較容易接受。
譬如 //go:linkname runtime_cmpstring runtime.cmpstring，runtime_cmpstring 提供實(shí)現(xiàn) runtime.cmpstring作為占位符，是不是這時(shí)符號(hào)表里不存在 runtime_cmpstring 只有 runtime.cmpstring?
經(jīng)過簡單溝通，他寫了一篇文章解決自己的困惑。希望對(duì)各位有幫助。以下是他寫的關(guān)于 //go:linkname 的文章(我做了一些調(diào)整)。
01 格式
- //go:linkname local remote
remote 可以沒有，此時(shí) remote 使用 local 的值，效果就是 local 被導(dǎo)出。
02 local 和 remote 同時(shí)為函數(shù)
local 作為占位符，remote 作為實(shí)現(xiàn)者
標(biāo)準(zhǔn)庫中的例子：
- // 來自 time 包
- //go:linkname runtimeNano runtime.nanotime
- func runtimeNano() int64
- // 來自 runtime 包
- //go:nosplit
- func nanotime() int64 {
- return nanotime1()
- }
此時(shí)二進(jìn)制文件中并沒有runtimeNano，直接轉(zhuǎn)化為對(duì)runtime.nanotime的調(diào)用。
local 作為實(shí)現(xiàn)者，remote 作為占位符
同樣來自標(biāo)準(zhǔn)庫。這里存在函數(shù)沒有函數(shù)體，但是被反向引用。
- // 在標(biāo)準(zhǔn)庫的一個(gè) internal 中
- //go:linkname runtime_cmpstring runtime.cmpstring
- func runtime_cmpstring(a, b string) int {
- l := len(a)
- if len(b) < l {
- l = len(b)
- }
- for i := 0; i < l; i++ {
- c1, c2 := a[i], b[i]
- if c1 < c2 {
- return -1
- }
- if c1 > c2 {
- return +1
- }
- }
- if len(a) < len(b) {
- return -1
- }
- if len(a) > len(b) {
- return +1
- }
- return 0
- }
- // 來自 runtime
- func cmpstring(string, string) int
此時(shí)二進(jìn)制文件中并沒有runtime_cmpstring，對(duì)應(yīng)的函數(shù)已經(jīng)被命名為runtime.cmpstring。也就是說，實(shí)現(xiàn)在 internal 包，但最終通過 runtime.cmpstring 來引用。
一個(gè)占位符+一個(gè)匯編函數(shù)
- // 在標(biāo)準(zhǔn)庫的一個(gè) internal 中
- //go:linkname abigen_runtime_memequal runtime.memequal
- func abigen_runtime_memequal(a, b unsafe.Pointer, size uintptr) bool
注意runtime.memequal的實(shí)現(xiàn)并不在runtime包中，使用匯編實(shí)現(xiàn)的話并不要求必須在相應(yīng)的包中。
- # memequal(a, b unsafe.Pointer, size uintptr) bool
- TEXT runtime·memequal(SB),NOSPLIT,$0-25
- MOVQ a+0(FP), SI
- MOVQ b+8(FP), DI
- CMPQ SI, DI
- JEQ eq
- MOVQ size+16(FP), BX
- LEAQ ret+24(FP), AX
- JMP memeqbody<>(SB)
- eq:
- MOVB $1, ret+24(FP)
- RET
03 local 和 remote 同時(shí)為變量
兩個(gè)常規(guī)變量
- //go:linkname overflowError runtime.overflowError
- var overflowError error
- //go:linkname divideError runtime.divideError
- var divideError error
- //go:linkname zeroVal runtime.zeroVal
- var zeroVal [maxZero]byte
- //go:linkname _iscgo runtime.iscgo
- var _iscgo bool = true
- //go:cgo_import_static x_cgo_setenv
- //go:linkname x_cgo_setenv x_cgo_setenv
- //go:linkname _cgo_setenv runtime._cgo_setenv
- var x_cgo_setenv byte
- var _cgo_setenv = &x_cgo_setenv
- //go:cgo_import_static x_cgo_unsetenv
- //go:linkname x_cgo_unsetenv x_cgo_unsetenv
- //go:linkname _cgo_unsetenv runtime._cgo_unsetenv
- var x_cgo_unsetenv byte
- var _cgo_unsetenv = &x_cgo_unsetenv
一個(gè)占位符+一個(gè)偽符號(hào)
- //go:linkname runtime_inittask runtime..inittask
- var runtime_inittask initTask
- //go:linkname main_inittask main..inittask
- var main_inittask initTask
注意是..inittask不是.inittask，而且.inittask只存在于編譯階段，任何包中都無法聲明該變量。
這里額外解釋下 ..inittask 為什么兩個(gè)點(diǎn)。第一個(gè)點(diǎn)就是普通的 runtime. 這種調(diào)用方式，第二個(gè)點(diǎn)和 inittask 一起構(gòu)成一個(gè)符號(hào)(變量)。注意，Go 中的變量是不允許以 . 開頭的，所以，這個(gè)叫偽符號(hào)，只在不編譯階段存在。
04 一個(gè)例子
研究 //go:linkname 是因?yàn)槿缦碌谋尘埃?/p>
Java 里有 InheritableThreadLocal，SpringWeb 在 ServletActionContext 里使用它，達(dá)到在任何地方都能方便的獲取HttpServletRequest。
Go 并沒有提供類似的機(jī)制，即使通過 stack 找到 goroutine id(99% 的文章都是這么介紹的)，再配合 sync.Map，也只是實(shí)現(xiàn)了一個(gè)比較粗糙的 ThreadLocal，在子協(xié)程里仍然獲取不到父協(xié)程的內(nèi)容。
g.label 雖然不是給這種場(chǎng)景準(zhǔn)備的，但它具備了 InheritableThreadLocal 的一切要求，只要我們能夠訪問到 label 私有字段，我們就有了完整版的 InheritableThreadLocal。
下面這個(gè)例子是作者真實(shí)項(xiàng)目中用的。
在 runtime 和 runtime/pprof 包中有兩個(gè)函數(shù)：runtime_setProfLabel 和 runtime_getProfLabel。其中，runtime 包中的提供了實(shí)現(xiàn)，而 pprof 中的沒有提供實(shí)現(xiàn)。如果基于它們創(chuàng)建另外的函數(shù)，如下：
- //go:linkname SetPointer runtime/pprof.runtime_setProfLabel
- func SetPointer(ptr unsafe.Pointer)
- //go:linkname GetPointer runtime/pprof.runtime_getProfLabel
- func GetPointer() unsafe.Pointer
根據(jù)前面的分析，雖然runtime.runtime_setProfLabel/runtime.runtime_getProfLabel提供了函數(shù)實(shí)現(xiàn)，但是二進(jìn)制文件中并不會(huì)出現(xiàn)(見下方代碼)，此時(shí)想要調(diào)用必須通過runtime/pprof.runtime_setProfLabel/runtime/pprof.runtime_getProfLabel，這也是上面linkname到pprof而不是runtime的根本原因。
- // 來自 runtime 包
- //go:linkname runtime_setProfLabel runtime/pprof.runtime_setProfLabel
- func runtime_setProfLabel(labels unsafe.Pointer) {
- if raceenabled {
- racereleasemerge(unsafe.Pointer(&labelSync))
- }
- getg().labels = labels
- }
- // 來自 runtime/pprof 包
- func runtime_setProfLabel(labels unsafe.Pointer)
- // 來自 runtime 包
- //go:linkname runtime_getProfLabel runtime/pprof.runtime_getProfLabel
- func runtime_getProfLabel() unsafe.Pointer {
- return getg().labels
- }
- // 來自 runtime/pprof 包
- func runtime_getProfLabel() unsafe.Pointer
05 總結(jié)
Go 中有不少指令，有些指令你可能不太需要關(guān)心，也不會(huì)用到。然而有些指令了解它們的意思，對(duì)閱讀相關(guān)代碼很有幫助。
這篇文章全面介紹了 //go:linkname 指令，不知道是否徹底解除了你的疑惑?歡迎留言交流!
本文轉(zhuǎn)載自微信公眾號(hào)「polarisxu」，可以通過以下二維碼關(guān)注。轉(zhuǎn)載本文請(qǐng)聯(lián)系polarisxu公眾號(hào)。
網(wǎng)頁標(biāo)題：注釋竟然還有特殊用途？一文解惑//go:linkname指令
分享路徑：http://www.5511xx.com/article/coedecp.html
