运行环境

go version：1.19.2
OS：MacOS 12.3，M1 芯片

踩坑过程

今天写一道leetcode题时想把原二维slice拷贝一份，代码如下

func solution(matrix [][]int) {
    
    
	newMatrix := make([][]int, len(matrix))
	for i := 0; i < len(matrix); i++ {
    
    
		newMatrix[i] = make([]int, len(matrix[0])
	}

	copy(newMatrix, matrix)
}

然后修改新二维slice值的时候，发现原slice也被修改了。。。

// matrix为 [[0,1,2]]
func solution(matrix [][]int) {
    
    
	newMatrix := make([][]int, len(matrix))
	for i := 0; i < len(matrix); i++ {
    
    
		newMatrix[i] = make([]int, len(matrix[0])
	}

	copy(newMatrix, matrix)

	newMatrix[0][0] = 1
	fmt.Println("newMatrix[0][1] =", newMatrix[0][0])
	fmt.Println("matrix[0][0] =", matrix[0][0])
}
// 输出
// newMatrix[0][0] = 1
// matrix[0][0] = 1

排查

查看汇编代码发现实际是调用了runtime.typedslicecopy

# ...
rel 32+8 t=3 type.[4]int+0
rel 40+4 t=9 runtime.newobject+0
rel 80+8 t=3 type.[]int+0
rel 92+4 t=9 runtime.makeslice+0
rel 132+8 t=3 type.int+0
rel 144+4 t=9 runtime.makeslice+0
rel 164+8 t=3 runtime.writeBarrier+0
rel 196+4 t=9 runtime.gcWriteBarrier+0
rel 200+8 t=3 runtime.writeBarrier+0
rel 228+8 t=3 type.[]int+0
# here
rel 236+4 t=9 runtime.typedslicecopy+0
rel 256+4 t=9 runtime.morestack_noctxt+0 

查看源码

// /usr/local/go/src/runtime/mbarrier.go
func typedslicecopy(typ *_type, dstPtr unsafe.Pointer, dstLen int, srcPtr unsafe.Pointer, srcLen int) int {
    
    
	n := dstLen
	if n > srcLen {
    
    
		n = srcLen
	}
	if n == 0 {
    
    
		return 0
	}
	// ...
	if dstPtr == srcPtr {
    
    
		return n
	}
	// ...
	size := uintptr(n) * typ.size
	// 将srcPtr开始的size个字节长度拷贝到dstPtr
	memmove(dstPtr, srcPtr, size)
	return n
}

打断点后发现拷贝的只是SliceHeader，len(SliceHeader) == 24

打印matrix[0]和newMatrix[0]的SliceHeader数据，Data指向的是同一个地址

type SliceHeader struct {
    
    
	Data uintptr
	Len  int
	Cap  int
}

fmt.Println((*reflect.SliceHeader)(unsafe.Pointer(&newMatrix[0])))
fmt.Println((*reflect.SliceHeader)(unsafe.Pointer(&matrix[0])))

// 输出
// &{1374389641344 4 4}
// &{1374389641344 4 4}

正确写法

对每个一维slice调用copy：

func solution(matrix [][]int) {
    
    
	newMatrix := make([][]int, len(matrix))
	for i := 0; i < len(matrix); i++ {
    
    
		newMatrix[i] = make([]int, len(matrix[0])
		copy(newMatrix[i], matrix[i])
	}
}

查看汇编代码，编译器优化成直接调用runtime.memmove

// ...
rel 76+8 t=3 type.[]int+0
rel 88+4 t=9 runtime.makeslice+0
rel 128+8 t=3 type.int+0
rel 140+4 t=9 runtime.makeslice+0
rel 160+8 t=3 runtime.writeBarrier+0
rel 192+4 t=9 runtime.gcWriteBarrier+0
// here
rel 232+4 t=9 runtime.memmove+0
rel 240+8 t=3 runtime.writeBarrier+0
rel 296+4 t=9 runtime.panicIndex+0
rel 308+4 t=9 runtime.morestack_noctxt+0

查看相关代码

// memmove copies n bytes from "from" to "to".
//
// ...
// Implementations are in memmove_*.s.
//
//go:noescape
func memmove(to, from unsafe.Pointer, n uintptr)

打印matrix[0]和newMatrix[0]的SliceHeader数据，不再是同一个地址

fmt.Println((*reflect.SliceHeader)(unsafe.Pointer(&newMatrix[0])))
fmt.Println((*reflect.SliceHeader)(unsafe.Pointer(&matrix[0])))

// 输出
// &{1374390263840 4 4}
// &{1374390263808 4 4}

关于copy的底层调用哪个函数

// /usr/local/go/src/cmd/compile/internal/walk/builtin.go
func walkCopy(n *ir.BinaryExpr, init *ir.Nodes, runtimecall bool) ir.Node {
    
    
	if n.X.Type().Elem().HasPointers() {
    
    
		// slice中的元素结构包含指针，使用typedslicecopy替换copy
		fn := writebarrierfn("typedslicecopy", n.X.Type().Elem(), n.Y.Type().Elem())
		// ...
		return mkcall1(fn, n.Type(), init, reflectdata.TypePtr(n.X.Type().Elem()), ptrL, lenL, ptrR, lenR)
	}

	// 如果使用了代码工具，那么使用slicecopy替换copy，比如使用 -race 参数编译
	if runtimecall {
    
    
		// rely on runtime to instrument:
		//  copy(n.Left, n.Right)
		// n.Right can be a slice or string.
		fn := typecheck.LookupRuntime("slicecopy")
		// ...
		return mkcall1(fn, n.Type(), init, ptrL, lenL, ptrR, lenR, ir.NewInt(n.X.Type().Elem().Size()))
	}
	// ...
	// 否则调用将copy转换成如下形式调用memmove
	//	  n := len(a)
	//	  if n > len(b) { n = len(b) }
	//	  if a.ptr != b.ptr { memmove(a.ptr, b.ptr, n*sizeof(elem(a))) }
	fn := typecheck.LookupRuntime("memmove")
	// ...