go_mutex_check

README

该工具用来检查 sync.Mutex sync.RWMutex 加锁的变量、结构体字段，是否有遗漏加锁

使用

类似以下脚本：

WORKSPACE=/your_workspace_path
pushd ${WORKSPACE}
go_mutex_check --path=.
popd

变量类型

• 全局变量
• 结构体字段
• 局部变量（天然安全）
• 形参（勾选的检查做好后，安全）
• 函数返回值
• 结构体方法返回值

勾选的变量类型都要处理

声明约定

1. sync.Mutex sync.RWMutex 变量声明加注释，标注要锁操作的变量或字段
2. 如果不想检查某 mutex 或者上层调用函数，可以添加注释：// nolint: mutex_check

如以下例子：

var m1 sync.Mutex // a,b,c
var a int
var b = map[int]int{}
var c string

var m2 sync.Mutex // nolint: mutex_check

type A1 struct {
	M sync.RWMutex // A
	A int
}

全局变量 - 检查步骤

1. 获取需要加锁的全局变量 A
2. 获取哪些函数 B ，直接使用了全局变量 A
3. 剔除 B 中有加锁的函数，得 C
4. 查看调用关系，逆向检查上级调用是否加锁
   1. 顶级函数也未加锁，报错
   2. 调用链超出本包路径，报错

结构体字段 - 检查步骤

1. 获取含有 mutex 字段的结构体、以及结构体内 mutex 对应的字段 A
2. 获取哪些函数 B ，直接使用了相关字段
3. 剔除 B 中有加锁的函数，得 C
4. 查看调用关系，逆向检查上级调用是否加锁
   1. 顶级函数也未加锁，报错
   2. 调用链超出本包路径，报错

函数返回值 - 检查步骤

1. 获取需要加锁的全局变量 A
2. 获取哪些函数 B ，直接使用了全局变量 A
3. 剔除 B 中无 return A 的，得 C
4. 查看 C，以下报错
   1. 类型为 map slice 指针

结构体方法返回值 - 检查步骤

1. 获取含有 mutex 字段的结构体、以及结构体内 mutex 对应的字段 A
2. 获取哪些函数 B ，直接使用了相关字段
3. 剔除 B 中无 return A 的，得 C
4. 查看 C，以下报错
   1. 类型为 map slice 指针