Run static analysis on OCaml C stubs in the CI #6338
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
psafont
reviewed
Mar 4, 2025
There is also a 'make analyze' to run this locally. Signed-off-by: Edwin Török <edwin.torok@cloud.com>
Macros beginning with `_` are reserved by the language. Fixes a CodeChecker warning. Signed-off-by: Edwin Török <edwin.torok@cloud.com>
Fixes a warning reported by codechecker Signed-off-by: Edwin Török <edwin.torok@cloud.com>
Signed-off-by: Edwin Török <edwin.torok@cloud.com>
Analyzer can't figure out that 'rc' is set on 'fd < 0', and we never try to use 'size_in_bytes'. Appears to be a limitation in the analyzer, it doesn't realize that `fd < 0` implies that `rc` is set to `NOT_IMPLEMENTED`, which raises an exception, so `caml_copy_int64` is never reached. But the logic there is quite hard to follow, so better be explicit, and ensure `size_in_bytes` is always initialized. Signed-off-by: Edwin Török <edwin.torok@cloud.com>
edwintorok
force-pushed
the
pr/codechecker
branch
from
a1cbdf8 to
23e01d7
Compare
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
psafont
approved these changes
Mar 5, 2025
contificate
approved these changes
Mar 5, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Similar to the static analyzer introduced in xha, but for OCaml C stubs.
This uses my https://ocaml.org/p/dune-compiledb/latest to product a
compile_commands.jsonfor the C stubs out of thedunerules (which can also be useful if you want to useclangdand get some editor integration about compiler warnings). This requires installing enough of the build dependencies to be able to rundunesuccessfully (perhaps in the future that restriction can be removed). Caching is used though, and we only need to install the build deps whendunefiles change, otherwise we can reuse a cachedcompile_commands.json.Static analyzers, like CodeChecker support reading
compile_commands.jsonand invoking static analyzers with the appropriate flags to preprocess, and analyze the C source code. We useclang,clang-tidyandcppcheckas the default analyzers, although more analyzers could be added in the future (CodeChecker supports convertinggcc -fanalyzeroutput for example. GCC also supports emiting SARIF format directly, but github cannot parse it, because it doesn't implement the full SARIF spec).At the end we convert the results back to the standard SARIF format that Github also supports for its code scanning results, which will make it automatically add comments on PRs that introduce new bugs, without necessarily gating on them.
I fixed some of the most obvious warnings, and suppressed some minor ones that we cannot fix (where the warning is caused by a Xen or OCaml header). More warnings can be skipped by adding to
.codechecker.jsonif needed.So far it seems to have found a file descriptor leak in
unixpwd.con an error path, but I haven't gone through all the reports in detail yet.