詳解 Go 團(tuán)隊(duì)不建議用的 Unsafe.Pointer
本文轉(zhuǎn)載自微信公眾號(hào)「腦子進(jìn)煎魚(yú)了」,作者陳煎魚(yú)。轉(zhuǎn)載本文請(qǐng)聯(lián)系腦子進(jìn)煎魚(yú)了公眾號(hào)。
大家好,我是煎魚(yú)。
大家在學(xué)習(xí) Go 的時(shí)候,肯定都學(xué)過(guò) “Go 的指針是不支持指針運(yùn)算和轉(zhuǎn)換” 這個(gè)知識(shí)點(diǎn)。為什么呢?
首先,Go 是一門(mén)靜態(tài)語(yǔ)言,所有的變量都必須為標(biāo)量類(lèi)型。不同的類(lèi)型不能夠進(jìn)行賦值、計(jì)算等跨類(lèi)型的操作。
那么指針也對(duì)應(yīng)著相對(duì)的類(lèi)型,也在 Compile 的靜態(tài)類(lèi)型檢查的范圍內(nèi)。同時(shí)靜態(tài)語(yǔ)言,也稱為強(qiáng)類(lèi)型。也就是一旦定義了,就不能再改變它。
錯(cuò)誤的示例
- func main(){
- num := 5
- numPointer := &num
- flnum := (*float32)(numPointer)
- fmt.Println(flnum)
- }
輸出結(jié)果:
- # command-line-arguments
- ...: cannot convert numPointer (type *int) to type *float32
在示例中,我們創(chuàng)建了一個(gè) num 變量,值為 5,類(lèi)型為 int,準(zhǔn)備干一番大事。
接下來(lái)我們?nèi)×似鋵?duì)于的指針地址后,試圖強(qiáng)制轉(zhuǎn)換為 *float32,結(jié)果失敗...
萬(wàn)能的破壁 unsafe
針對(duì)剛剛的 “錯(cuò)誤示例”,我們可以采用今天的男主角 unsafe 標(biāo)準(zhǔn)庫(kù)來(lái)解決。它是一個(gè)神奇的包,在官方的詮釋中,有如下概述:
- 圍繞 Go 程序內(nèi)存安全及類(lèi)型的操作。
- 很可能會(huì)是不可移植的。
- 不受 Go 1 兼容性指南的保護(hù)。
簡(jiǎn)單來(lái)講就是,不怎么推薦你使用,因?yàn)樗?unsafe(不安全的)。
但是在特殊的場(chǎng)景下,使用了它,可以打破 Go 的類(lèi)型和內(nèi)存安全機(jī)制,讓你獲得眼前一亮的驚喜效果。
unsafe.Pointer
為了解決這個(gè)問(wèn)題,需要用到 unsafe.Pointer。它表示任意類(lèi)型且可尋址的指針值,可以在不同的指針類(lèi)型之間進(jìn)行轉(zhuǎn)換(類(lèi)似 C 語(yǔ)言的 void * 的用途)。
其包含四種核心操作:
- 任何類(lèi)型的指針值都可以轉(zhuǎn)換為 Pointer。
- Pointer 可以轉(zhuǎn)換為任何類(lèi)型的指針值。
- uintptr 可以轉(zhuǎn)換為 Pointer。
- Pointer 可以轉(zhuǎn)換為 uintptr。
在這一部分,重點(diǎn)看第一點(diǎn)、第二點(diǎn)。你再想想怎么修改 “錯(cuò)誤的例子” 讓它運(yùn)行起來(lái)?
修改如下:
- func main(){
- num := 5
- numPointer := &num
- flnum := (*float32)(unsafe.Pointer(numPointer))
- fmt.Println(flnum)
- }
輸出結(jié)果:
- 0xc4200140b0
在上述代碼中,我們小加改動(dòng)。通過(guò) unsafe.Pointer 的特性對(duì)該指針變量進(jìn)行了修改,就可以完成任意類(lèi)型(*T)的指針轉(zhuǎn)換。
需要注意的是,這時(shí)還無(wú)法對(duì)變量進(jìn)行操作或訪問(wèn),因?yàn)椴恢涝撝羔樀刂分赶虻臇|西具體是什么類(lèi)型。不知道是什么類(lèi)型,又如何進(jìn)行解析呢?
無(wú)法解析也就自然無(wú)法對(duì)其變更了。
unsafe.Offsetof
在上小節(jié)中,我們對(duì)普通的指針變量進(jìn)行了修改。那么它是否能做更復(fù)雜一點(diǎn)的事呢?
- type Num struct{
- i string
- j int64
- }
- func main(){
- n := Num{i: "EDDYCJY", j: 1}
- nPointer := unsafe.Pointer(&n)
- niPointer := (*string)(unsafe.Pointer(nPointer))
- *niPointer = "煎魚(yú)"
- njPointer := (*int64)(unsafe.Pointer(uintptr(nPointer) + unsafe.Offsetof(n.j)))
- *njPointer = 2
- fmt.Printf("n.i: %s, n.j: %d", n.i, n.j)
- }
輸出結(jié)果:
- n.i: 煎魚(yú), n.j: 2
在剖析這段代碼做了什么事之前,我們需要了解結(jié)構(gòu)體的一些基本概念:
- 結(jié)構(gòu)體的成員變量在內(nèi)存存儲(chǔ)上是一段連續(xù)的內(nèi)存。
- 結(jié)構(gòu)體的初始地址就是第一個(gè)成員變量的內(nèi)存地址。
- 基于結(jié)構(gòu)體的成員地址去計(jì)算偏移量。就能夠得出其他成員變量的內(nèi)存地址。
再回來(lái)看看上述代碼,得出執(zhí)行流程:
- 修改 n.i 值:i 為第一個(gè)成員變量。因此不需要進(jìn)行偏移量計(jì)算,直接取出指針后轉(zhuǎn)換為 Pointer,再?gòu)?qiáng)制轉(zhuǎn)換為字符串類(lèi)型的指針值即可。
- 修改 n.j 值:j 為第二個(gè)成員變量。需要進(jìn)行偏移量計(jì)算,才可以對(duì)其內(nèi)存地址進(jìn)行修改。在進(jìn)行了偏移運(yùn)算后,當(dāng)前地址已經(jīng)指向第二個(gè)成員變量。接著重復(fù)轉(zhuǎn)換賦值即可。
細(xì)節(jié)分析
需要注意的是,這里使用了如下方法(來(lái)完成偏移計(jì)算的目標(biāo)):
1、uintptr:uintptr 是 Go 的內(nèi)置類(lèi)型。返回?zé)o符號(hào)整數(shù),可存儲(chǔ)一個(gè)完整的地址。后續(xù)常用于指針運(yùn)算
- type uintptr uintptr
2、unsafe.Offsetof:返回成員變量 x 在結(jié)構(gòu)體當(dāng)中的偏移量。更具體的講,就是返回結(jié)構(gòu)體初始位置到 x 之間的字節(jié)數(shù)。需要注意的是入?yún)? ArbitraryType 表示任意類(lèi)型,并非定義的 int。它實(shí)際作用是一個(gè)占位符
- func Offsetof(x ArbitraryType) uintptr
在這一部分,其實(shí)就是巧用了 Pointer 的第三、第四點(diǎn)特性。這時(shí)候就已經(jīng)可以對(duì)變量進(jìn)行操作了。
糟糕的例子
- func main(){
- n := Num{i: "EDDYCJY", j: 1}
- nPointer := unsafe.Pointer(&n)
- ...
- ptr := uintptr(nPointer)
- njPointer := (*int64)(unsafe.Pointer(ptr + unsafe.Offsetof(n.j)))
- ...
- }
這里存在一個(gè)問(wèn)題,uintptr 類(lèi)型是不能存儲(chǔ)在臨時(shí)變量中的。因?yàn)閺?GC 的角度來(lái)看,uintptr 類(lèi)型的臨時(shí)變量只是一個(gè)無(wú)符號(hào)整數(shù),并不知道它是一個(gè)指針地址。
因此當(dāng)滿足一定條件后,ptr 這個(gè)臨時(shí)變量是可能被垃圾回收掉的,那么接下來(lái)的內(nèi)存操作,豈不成迷?
總結(jié)
簡(jiǎn)潔回顧兩個(gè)知識(shí)點(diǎn),如下:
- 第一是 unsafe.Pointer 可以讓你的變量在不同的指針類(lèi)型轉(zhuǎn)來(lái)轉(zhuǎn)去,也就是表示為任意可尋址的指針類(lèi)型。
- 第二是 uintptr 常用于與 unsafe.Pointer 打配合,用于做指針運(yùn)算,巧妙地很。
最后還是那句,沒(méi)有特殊必要的話。是不建議使用 unsafe 標(biāo)準(zhǔn)庫(kù),它并不安全。雖然它常常能讓你眼前一亮。