deadcode超解剖

Go Conference 2024でのLTの資料です。

リンク一覧
p4
https://pkg.go.dev/golang.org/x/tools/cmd/deadcode#hdr-Why_is_a_function_not_dead_
https://pkg.go.dev/golang.org/x/tools/go/callgraph/rta

p6
https://github.com/golangci/golangci-lint/issues/4254
https://github.com/golangci/golangci-lint/issues/4270
https://github.com/golangci/golangci-lint/issues/4298
https://github.com/golangci/golangci-lint/issues/4383

p7
https://github.com/golangci/golangci-lint/issues/4254#issuecomment-1853840307
https://github.com/golangci/golangci-lint/issues/4254#issuecomment-1856231084

p12
https://cs.opensource.google/go/go/+/refs/tags/go1.21.6:src/go/ast/ast.go;l=40

p14
https://go.dev/blog/deadcode
https://pkg.go.dev/golang.org/x/tools/go/callgraph/rta
https://pkg.go.dev/golang.org/x/tools/cmd/deadcode
https://github.com/golangci/golangci-lint
https://github.com/dominikh/go-tools/tree/master/unused

Transcript

1. 　　 deadcode超解剖 Go Conference 2024 2024/06/08 kuroda naoki
2. 自己紹介 kuro @knkurokuro7 - 名前：kuroda naoki - 所属：株式会社サイバーエージェン トAI事業本部 プリズムパートナーカンパニー - 普段はスクランブルスクエアでただ ただ佇んでいます。
3. deadcodeご存じですか？ 「Finding unreachable functions with deadcode」というGo公式のブログでフュー チャーされました。
4. deadcodeとは？ - “dead code”と呼ばれる、いかなる実行でも到達できない関数 を検知するツール。 - -whyliveフラグでdeadになっていない理由 も教えてくれる。 (https://pkg.go.dev/golang.org/x/tools/cmd/deadcode#hdr-Why_is_a_function_not_dead_) - Rapid Type Analysis (RTA) というアルゴリズムを使ってい る。
5. golangci-lintで 使ってみたい！
6. 実際にissueを見てみると。。。👀 - Add deadcode linter · Issue #4254 - Integrate new deadcode tool · Issue#4270 - Add golang.org/x/tools/cmd/deadcode support · Issue#4298 - Add official go deadcode linter · Issue#4383 →全てclosed
7. なぜ採用されないのか？ 理由： 1. unused との比較で、deadcodeの方がより false positive(偽陽性)があるから。 2. deadcodeはcommand lineでありlib(library)ではないか ら。 https://github.com/golangci/golangci-lint/issues/4254#issuecomment-1853840307 https://github.com/golangci/golangci-lint/issues/4254#issuecomment-1856231084
8. false positive (偽陽性)？ →検出する必要のないものを誤って検知して しまうこと
9. deadcodeの仕組み RTAで、main()やinit()から始まって、 1. 直接呼び出される関数、2. interfaceを 通して間接的に呼び出される関数を到達 可能としてチェックし、それ以外を deadcodeとする。 2の方法は、“dynamic programming”（動的 計画法）を使う。 English French Greeter ✅ ✅
10. unusedの仕組み（interfaceとメソッド）※かなり省略しています - ASTと型の情報を利用してグラフを構築し、そのグラフを解析するこ とで未使用のコードを特定する。 - AST解析の段階で、 - 具象型がinterfaceを実装するために必要なメソッドは使用され たとする。 →あるメソッドは呼び出されていなくても使用されているとみなされる ことがある。
11. deadcodeを使ってみて - $ deadcode -test ./... inference/inferred_value.go:52:25: unreachable func: DeterminedVal.isInferredVal inference/inferred_value.go:94:27: unreachable func: UndeterminedVal.isInferredVal - 「不要なメソッドだ！」とPR送ったけど、、、 type InferredVal interface { isInferredVal()👈ここと copy() InferredVal } func (e *DeterminedVal) isInferredVal() {}👈ここだけ func (e *DeterminedVal) copy() InferredVal { return &DeterminedVal{Bool: e.Bool} }
12. deadcodeを使ってみて type InferredVal interface { isInferredVal()👈ここと copy() InferredVal } func (e *DeterminedVal) isInferredVal() {}👈ここだけ func (e *DeterminedVal) copy() InferredVal { return &DeterminedVal{Bool: e.Bool} } - 直接使用されていなくても、isInferredVal() メソッドをInferredVal interfaceに残 しておく。すると、意図した構造体(ここではDeterminedVal)だけが InferredVal interfaceを実装できる。 →意図しないバグを防ぐ。 - Goの実装でも使われている。👇 https://cs.opensource.google/go/go/+/refs/tags/go1.21.6:src/go/ast/ast.go;l=40
13. まとめ - deadcodeはコマンドライン、unusedはライブラ リ。 - deadcodeは関数、unusedは関数、定数、変 数、型などに使える。 - deadcodeはある特定のケースにおいては、 unusedより偽陽性があると言えるのかも。
14. 参考文献 - Finding unreachable functions with deadcode - The Go Programming Language - pkg.go.dev - rta - pkg.go.dev - deadcode - GitHub - golangci/golangci-lint: Fast linters runner for Go - GitHub - dominikh/go-tools/unused: Staticcheck　 - The advanced Go linter