一只傻哈皮

Defer使用时的坑

先看几个例子

1.

func f() (result int) {
	defer func() {
		result++
	}()
	return 0
}

2.

func f() (r int) {
     t := 5
     defer func() {
	   t = t + 5
     }()
     return t
}

3.

func f() (r int) {
	defer func(r int) {
	      r = r + 5
	}(r)
	return 1
}

例1的正确答案不是0，例2的正确答案不是10，例3的正确答案不是6……

Why???

= =!

要使用defer时不踩坑，最重要的一点就是要明白，return xxx这一条语句并不是一条原子指令!

那啥是原子指令？？

所谓原子操作是指不会被 线程调度机制 打断的操作；这种操作一旦开始，就一直运行到结束，中间不会有任何 context switch （切换到另一个线程）。

原子操作是不可分割的，在执行完毕之前不会被任何其它任务或事件中断。在单处理器系统（UniProcessor）中，能够在单条指令中完成的操作都可以认为是” 原子操作”，因为中断只能发生于指令之间。这也是某些CPU指令系统中引入了test_and_set、test_and_clear等指令用于临界资源互斥的原因。但是，在对称多处理器（Symmetric Multi-Processor）结构中就不同了，由于系统中有多个处理器在独立地运行，即使能在单条指令中完成的操作也有可能受到干扰。

函数返回的过程是这样的：先给返回值赋值，然后调用defer表达式，最后才是返回到调用函数中。

defer表达式可能会在设置函数返回值之后，在返回到调用函数之前，修改返回值，使最终的函数返回值与你想象的不一致。

其实使用defer时，用一个简单的转换规则改写一下，就不会迷糊了。改写规则是将return语句拆成两句写，return xxx会被改写成:

返回值 = xxx
调用defer函数
空的return

先看例1，它可以改写成这样：

func f() (result int) {
     result = 0  //return语句不是一条原子调用，return xxx其实是赋值＋ret指令
     func() { //defer被插入到return之前执行，也就是赋返回值和ret指令之间
		 result++
     }()
     return
}

所以这个返回值是1。

在看例2，它可以改写成这样：

func f() (r int) {
     t := 5
     r = t //赋值指令
     func() {        //defer被插入到赋值与返回之间执行，这个例子中返回值r没被修改过
		 t = t + 5
     }
     return        //空的return指令
}

需要注意的是这里面的返回值变量是r不是t。

所以这个结果是5.

最后看例3，它改写后变成：

func f() (r int) {
     r = 1  //给返回值赋值
     func(r int) {        //这里改的r是传值传进去的r，不会改变要返回的那个r值
	      r = r + 5
     }(r)
     return        //空的return
}

所以这个结果是1.

defer确实是在return之前调用的。但表现形式上却可能不像。本质原因是return xxx语句并不是一条原子指令，defer被插入到了赋值 与 ret之间，因此可能有机会改变最终的返回值。

Defer的实现

defer关键字的实现跟go关键字很类似，不同的是它调用的是runtime.deferproc而不是runtime.newproc。

在defer出现的地方，插入了指令call runtime.deferproc，然后在函数返回之前的地方，插入指令call runtime.deferreturn。

普通的函数返回时，汇编代码类似：

add xx SP
return

如果其中包含了defer语句，则汇编代码是：

call runtime.deferreturn，
add xx SP
return

goroutine的控制结构中，有一张表记录defer，调用runtime.deferproc时会将需要defer的表达式记录在表中，而在调用runtime.deferreturn的时候，则会依次从defer表中出栈并执行。

推荐阅读《go internals》