Go/goコマンド/vet/lostcancel
表示
go vet の lostcancel アナライザ
[編集]何を検出するか
[編集]context.WithCancel などが返す cancel 関数が呼ばれないまま終わるコードを検出します。
前提知識:context のキャンセル関数
[編集]ctx, cancel := context.WithCancel(parent)
cancel を呼ぶまで、作成した ctx は親コンテキストがキャンセルされない限り生き続けます。context.Background() を親にした場合、親は永遠にキャンセルされないため、cancel を呼ばないとリークします。
なぜ問題なのか
[編集]context.WithCancel を呼ぶ ↓ 内部でゴルーチンやリソースが確保される ↓ cancel() を呼ばないまま関数が終了 ↓ 親コンテキストが生きている限りリソースが解放されない ↓ コンテキストリーク(メモリリーク・ゴルーチンリーク)
検出されるパターン
[編集]① cancel を完全に無視
[編集]ctx, _ := context.WithCancel(parent) // ⚠️ cancel を捨てている doSomething(ctx)
② cancel を取得したが呼ばない
[編集]func foo(parent context.Context) { ctx, cancel := context.WithCancel(parent) // ⚠️ cancel を一度も呼ばずに return doSomething(ctx) }
③ エラー時のパスで cancel を呼ばない
[編集]func foo(parent context.Context) error { ctx, cancel := context.WithCancel(parent) if err := doFirst(ctx); err != nil { return err // ⚠️ cancel を呼ばずに return } defer cancel() return doSecond(ctx) }
正しいコード
[編集]defer で確実に呼ぶのが標準的なイディオムです。
ctx, cancel := context.WithCancel(parent) defer cancel() // ✅ どの return パスでも必ず呼ばれる if err := doFirst(ctx); err != nil { return err // defer cancel() が呼ばれる } return doSecond(ctx)
対象となる関数
[編集]cancel 関数を返す以下の全バリアントが対象です。
ctx, cancel := context.WithCancel(parent) // cancel() ctx, cancel := context.WithTimeout(parent, d) // cancel() ctx, cancel := context.WithDeadline(parent, t) // cancel() // Go 1.20 以降のバリアント ctx, cancel := context.WithCancelCause(parent) // cancel(cause) ctx, cancel := context.WithTimeoutCause(parent, d, cause) ctx, cancel := context.WithDeadlineCause(parent, t, cause)
WithTimeout / WithDeadline でも cancel が必要な理由
[編集]タイムアウトやデッドラインが来れば自動でキャンセルされますが、それより前に処理が終わった場合にリソースが残り続けます。
// ⚠️ タイムアウト前に処理が終わってもリソースが残る ctx, _ := context.WithTimeout(parent, 5*time.Second) result, err := doFastOperation(ctx) // 10ms で終わっても5秒間リソースが残る
// ✅ 処理が終わり次第 cancel で即座に解放 ctx, cancel := context.WithTimeout(parent, 5*time.Second) defer cancel() result, err := doFastOperation(ctx)
まとめ
[編集]| コード | 問題 |
|---|---|
ctx, _ := context.WithCancel(parent)
|
⚠️ cancel を捨てている |
ctx, cancel := context.WithCancel(parent)(cancel 未呼び出し)
|
⚠️ コンテキストリーク |
| エラーパスで cancel を呼ばずに return | ⚠️ 特定パスでリーク |
defer cancel() を WithCancel の直後に置く
|
✅ 全パスで確実に解放 |
context.Background() を親にしている場合は親が永遠にキャンセルされないため、cancel 漏れは永続的なリークになります。defer cancel() を WithCancel の直後に書くのを習慣にしておくのが一番の対策です。