go-linkname

假设有一个内部包,它提供一个方法如下:

package internal

import "fmt"

func print(msg string) {
 fmt.Println("[internal]", msg)
}

这个方法是内部使用的,它没有导出属性,因此它无法被其他外部包import,那既然如此,那有没有办法能在包外部去调用这个方法呢?答案是肯定的,只不过这个黑科技屏蔽了至少80%的Gopher的认知,它就是go:linkname。

01 go:linkname基础

在理解go:linkname之前,需要先理解Golang中独有的内部包internal。在Go1.14中加入了Go 1.4 “Internal” Packages
An import of a path containing the element “internal” is disallowed if the importing code is outside the tree rooted at the parent of the “internal” directory.
简单理解就是这个特殊的internal包只能被特定外部包导入:
包/a/b/c/internal/d/e/f只能被/a/b/c导入,而不能被/a/b/d导入。
包·$GOROOT/src/pkg/internal/xxx,只能被$GOROOT/src/导入。
$GOROOT/src/pkg/net/http/internal只能被net/http和net/http/*导入。
$GOPATH/src/mypkg/internal/foo只能被$GOPATH/src/mypkg导入。
在不违反这个原则的情况下,如何直接引用internal.print这个方法呢?

The //go:linkname directive instructs the compiler to use “importpath.name” as the object file symbol name for the variable or function declared as “localname” in the source code. Because this directive can subvert the type system and package modularity, it is only enabled in files that have imported "unsafe".

//go:linkname指令指示编译器使用importpath.name作为源代码中声明为localname的变量或函数的对象文件符号名。由于该指令可以破坏类型系统和包模块化,因此仅在导入了unsafe的文件中启用该指令。如下:

package main

import (
    _ "demo/internal"
 _ "unsafe"
)

//go:linkname Print demo/internal.print
func Print(data string)

func main() {
    Print("hello world")
}

这样就完成了go:linkname将方法实现指向一个外部包未导出的方法实现了。简单理解,就是通过go:linkname [local] [target]为当前这个local方法绑定其具体实现target。当直接运行时会提示missing body的错误。这是因为go build会增加-complete参数检查完整性,显然这个Print方法是没有包体的。因此,需要告知编译器绕过这个限制,在调用目录下增加xxx.s文件即可。最后整个文件目录如下:

.
├── go.mod
├── internal
│   └── internal.go
└── main.go

运行后输出:
# go run *.go
[internal] hello world

02 go:linkname进阶1:随机数

//go:linkname FastRand runtime.fastrand
func FastRand() uint32

runtime.fastrand和math.Rand都是伪随机数生成器,但不同的是runtime.fastrand是在当前goroutine上下文环境下的,因此在频繁调用过程中不需要加锁,所以,它的性能要比math.Rand要好得多。以下是两者的性能测试:

package main

import (
 "math/rand"
 "testing"
)

func BenchmarkMathRand(b *testing.B) {
 for i := 0; i < b.N; i++ {
  _ = rand.Int()
 }
}

func BenchmarkRuntimeRand(b *testing.B) {
 for i := 0; i < b.N; i++ {
  _ = FastRand()
 }
}

执行得到基准性能数据,可见runtime.Rand在性能上碾压math/rand:

Running tool: /usr/bin/go test -benchmem -run=^$ -coverprofile=/tmp/vscode-goVPugfM/go-code-cover -bench . demo

goos: linux
goarch: amd64
pkg: demo
BenchmarkMathRand     91929873         12.8 ns/op        0 B/op        0 allocs/op
BenchmarkRuntimeRand  316043065          3.71 ns/op        0 B/op        0 allocs/op
PASS
coverage: 0.0% of statements
ok   demo 2.750s

03 go:linkname进阶2:时间戳

//go:linkname nanotime1 runtime.nanotime1
func nanotime1() int64

time.Now()和runtime.nanotime1()两者都是获取时间戳,但是time.Now()其底层调用了runtime.walltime1和runtime.nanotime,分别获取时间戳和程序运行时间。而后者只需要单独获取时间戳。因此,在某些场景下,比如统计耗时,那么就可以直接通过nanotime1()获得更好的性能。以下为基准测试代码:

package main

import (
 "testing"
 "time"
)

func BenchmarkTimeNow(b *testing.B) {
 for i := 0; i < b.N; i++ {
  _ = time.Now()
 }
}

func BenchmarkRuntimeNanotime(b *testing.B) {
 for i := 0; i < b.N; i++ {
  _ = nanotime1()
 }
}

执行得到基准性能数据,可见runtime.nanotime1()在性能上碾压time.Now():

Running tool: /usr/bin/go test -benchmem -run=^$ -coverprofile=/tmp/vscode-goVPugfM/go-code-cover -bench . demo

goos: linux
goarch: amd64
pkg: demo
BenchmarkTimeNow          10140447        117 ns/op        0 B/op        0 allocs/op
BenchmarkRuntimeNanotime  22762699         55.7 ns/op        0 B/op        0 allocs/op
PASS
coverage: 0.0% of statements
ok   demo 2.635s

04 总结

在理解go:linkname的原理后,我们就可以举一反三,针对特定场景来优化代码,提高性能瓶颈。这个指令虽然可以绕过限制访问到其他包的私有方法,但不失为一种巧技。在阅读golang的源码时也可以看到大量的go:linkname指令,因此有助于我们更好理解golang代码的底层逻辑。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,277评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,689评论 3 393
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,624评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,356评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,402评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,292评论 1 301
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,135评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,992评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,429评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,636评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,785评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,492评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,092评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,723评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,858评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,891评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,713评论 2 354

推荐阅读更多精彩内容

  • 目录 1.go 各种代码运行 2.go 在线编辑代码运行 3.通过 Gob 包序列化二进制数据 4.使用 ...
    杨言锡阅读 1,127评论 0 1
  • 现如今即便是个人开发的一般程序,可能其包含的函数都超过了一万个,这些函数代码一般都由他人编写并打包为“包”或者“模...
    左蓝阅读 6,476评论 3 15
  • File types(文件类型) go命令检查目录中特定文件的集合。它根据文件的扩展名表示要检查的文件。这些扩展名...
    Cxb168阅读 1,740评论 0 0
  • 指针 指针就是地址,指针变量就是存储地址的变量 *p : 解引用,间接引用 栈帧:用来给函数运行提供内存空间,取内...
    雪上霜阅读 295评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,654评论 18 139