-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
x/tools/go/analysis/passes/ctrlflow: encode more knowledge about standard library in ctrlflow analyzer #497
base: master
Are you sure you want to change the base?
Conversation
This PR (HEAD: 98bebae) has been imported to Gerrit for code review. Please visit Gerrit at https://go-review.googlesource.com/c/tools/+/590497. Important tips:
|
Message from Gopher Robot: Patch Set 1: (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/590497. |
Message from Gopher Robot: Patch Set 1: Congratulations on opening your first change. Thank you for your contribution! Next steps: Most changes in the Go project go through a few rounds of revision. This can be Please don’t reply on this GitHub thread. Visit golang.org/cl/590497. |
Message from Yuxin Wang: Patch Set 2: (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/590497. |
Message from Tim King: Patch Set 3: (6 comments) Please don’t reply on this GitHub thread. Visit golang.org/cl/590497. |
Message from Lasse Folger: Patch Set 3: (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/590497. |
Message from Tim King: Patch Set 3: (1 comment) Please don’t reply on this GitHub thread. Visit golang.org/cl/590497. |
ctrlflow Analyzer has a list of intrinsic no-return functions such as "syscall.Exit" but not higher-level standard library
functions like "os.Exit". It relies on actually analyzing those functions (which internally will call the intrinsic no-return
functions), and then exporting the knowledge as "noReturn" facts for downstream analyses.
However, as is noted in "analysis" framework documentation
(https://pkg.go.dev/golang.org/x/tools/go/analysis#hdr-Modular_analysis_with_Facts):
"Some driver implementations (such as those based on Bazel and Blaze) do not currently apply analyzers to packages
of the standard library. Therefore, for best results, analyzer authors should not rely on analysis facts being available for
standard packages."
From our testing with Bazel (nogo), this still seems to be true (May 2024), since rules_go
(https://github.com/bazelbuild/rules_go) compiles the standard library via "go install", where analyzers are not applied,
and hence won't export the "noReturn" facts. This would have cascading effects since "os.Exit" not being marked as
no-return will lead to user-defined functions like
func HandleError(err error) {
SendLog(err)
os.Exit(1)
}
as well as its further wrappers not being marked as no-return. Then, the blocks containing calls to them would still have
successors (incorrectly).
Following the recommendations from the documentation ("analyzer authors should not rely on analysis facts being
available"), this PR encodes more higher-level functions from the standard library as no-return.