【Go】空struct比较

@[toc]

引入

观察如下代码

func main() {
    a := new(struct{})
    b := new(struct{})
    println("println result: ", a, b, a == b)

    c := new(struct{})
    d := new(struct{})
    fmt.Printf("fmt.Printf result: %p\t%p\t%t\n", c, d, c == d)
}

输出结果是

fmt.Printf result: 0xbedde0 0xbedde0    true
println result:  0xc00011df47 0xc00011df47 false

那么问题来了，为什么第一个返回false，第二个返回true，并且顺序也不一致

打印顺序

控制台可以看到两个打印颜色是不同的println的是红色，fmt.Printf是白色
因为println打印输出到os.Stderr
fmt.Printf打印输出到os.Stdout
println是Go在实现自举的时候供开发人员打印使用的，后续并不能保证其能正常工作

结果分析

看过fmt源码的话，很快意识到，可能是逃逸分析导致，我们对例子进行逃逸分析

go run -gcflags="-m -l" main.go

# command-line-arguments
.\main.go:14:10: new(struct {}) does not escape
.\main.go:15:10: new(struct {}) does not escape
.\main.go:18:10: new(struct {}) escapes to heap
.\main.go:19:10: new(struct {}) escapes to heap
.\main.go:20:12: ... argument does not escape
.\main.go:20:56: c == d escapes to heap
println result:  0xc00011df47 0xc00011df47 false
fmt.Printf result: 0x9edde0     0x9edde0        true

通过分析可得知变量a，b分配在栈中，c，d分配在堆中。
关键原因是fmt的Print方法内部涉及大量的反射相关方法的调用，会造成逃逸行为，也就是分配到堆上。

为什么逃逸后相等

这里主要和Go runtime的一个优化细节有关

// runtime/malloc.go
var zerobase uintptr

变量 zerobase 是所有 0 字节分配的基础地址。更进一步来讲，就是空（0字节）的在进行了逃逸分析后，往堆分配的都会指向 zerobase 这一个地址。
所以空 struct 在逃逸后本质上指向了 zerobase，其两者比较就是相等的，返回了 true。

为什么不逃逸不相等

这是Go团队故意设计的，不希望大家依赖这个来做判断依据

This is an intentional language choice to give implementations flexibility in how they handle pointers to zero-sized objects. If every pointer to a zero-sized object were required to be different, then each allocation of a zero-sized object would have to allocate at least one byte. If every pointer to a zero-sized object were required to be the same, it would be different to handle taking the address of a zero-sized field within a larger struct.

Pointers to distinct zero-size variables may or may not be equal.

在没逃逸的场景下，两个空 struct 的比较动作，并不是真的在比较。实际上已经在代码优化阶段被直接优化掉，转为了 false。
因此，虽然在代码上看上去是 == 在做比较，实际上结果是 a == b 时就直接转为了 false，比都不需要比了。

总结

若逃逸到堆上，空结构体则默认分配的是 runtime.zerobase 变量，是专门用于分配到堆上的 0 字节基础地址。因此两个空结构体，都是 runtime.zerobase，一比较当然就是 true 了。
若没有发生逃逸，也就分配到栈上。在 Go 编译器的代码优化阶段，会对其进行优化，直接返回 false。并不是传统意义上的，真的去比较了。

【Go】空struct比较