golang atomic函数用法

近期因为项目的需要，使用了atomic.AddIntXX函数，感觉golang的这块设计还是非常实用的；非常简洁的方式实现原子操作，而不需要使用显式的锁操作。

这里顺带把atomic的函数做一个分类小结。

1. 载入

• func LoadInt32(addr *int32) (val int32)
• func LoadInt64(addr *int64) (val int64)
• func LoadPointer(addr *unsafe.Pointer) (val unsafe.Pointer)
• func LoadUint32(addr *uint32) (val uint32)
• func LoadUint64(addr *uint64) (val uint64)
• func LoadUintptr(addr *uintptr) (val uintptr)

功能伪代码如下：

  return *addr

2. 存储

func StoreInt32(addr *int32, val int32)
func StoreInt64(addr *int64, val int64)
func StorePointer(addr *unsafe.Pointer, val unsafe.Pointer)
func StoreUint32(addr *uint32, val uint32)
func StoreUint64(addr *uint64, val uint64)
func StoreUintptr(addr *uintptr, val uintptr)

功能伪代码如下：

  *addr = val

3. 增减

func AddInt32(addr *int32, delta int32) (new int32)
func AddInt64(addr *int64, delta int64) (new int64)
func AddUint32(addr *uint32, delta uint32) (new uint32)
func AddUint64(addr *uint64, delta uint64) (new uint64)
func AddUintptr(addr *uintptr, delta uintptr) (new uintptr)

功能伪代码如下：

  *addr += delta
  return *addr

4. 交换

func SwapInt32(addr *int32, new int32) (old int32)
func SwapInt64(addr *int64, new int64) (old int64)
func SwapPointer(addr *unsafe.Pointer, new unsafe.Pointer) (old unsafe.Pointer)
func SwapUint32(addr *uint32, new uint32) (old uint32)
func SwapUint64(addr *uint64, new uint64) (old uint64)
func SwapUintptr(addr *uintptr, new uintptr) (old uintptr)

功能伪代码如下：

  old = *addr
  *addr = new
  return old

它为什么不提供基于两个地址的交换函数呢？像这种：
func SwapInt32(addr1 *int32，addr2 *int32)
因为这是业务层要考虑的问题，而不是API层该实现的问题，还是这从API层的技术上说无法实现，因为涉及两个地址。

5. 比较并交换

func CompareAndSwapInt32(addr *int32, old, new int32) (swapped bool)
func CompareAndSwapInt64(addr *int64, old, new int64) (swapped bool)
func CompareAndSwapPointer(addr *unsafe.Pointer, old, new unsafe.Pointer) (swapped bool)
func CompareAndSwapUint32(addr *uint32, old, new uint32) (swapped bool)
func CompareAndSwapUint64(addr *uint64, old, new uint64) (swapped bool)
func CompareAndSwapUintptr(addr *uintptr, old, new uintptr) (swapped bool)

功能伪代码如下：

  if *addr == old {
    *addr = new
    return true
  }
  return false

这类函数光从描述来看不是很好理解它的用意；我们用一个使用场景来介绍一下，就比较清楚了。

例如有多个竞争者会访问某一个变量，根据变量的值做一些操作，然后会修改变量的值，最后把变量新值写回去。

1. Read X
2. Update X
3. Write X

注意第三步，在写回变量的时候，我们要保证此时变量的值就是第1步读出时的值，也就是在整个过程中，变量X没有被其他人修改过，否则整个系统就不一致了；函数CompareAndSwap就是使用在这种场景中，保证(addr == old)时，才修改addr的值，并返回true，否则*addr的值不变，并返回false。

这系列函数在实际应用中通常会利用一个循环实现修改。

var sharedValue int64 = ...

for {
  oldValue := atomic.LoadUint64(&sharedValue)
  newValue := oldValue + XXX
  if atomic.CompareAndSwapUint64(&sharedValue, oldValue , newValue ) {
    // quit only when CompareAndSwap success, otherwise retry
    break
  }
}