C Static Analysis
Testing & Qualityc-static-analysisC Static Analysis is an Agent Skill for testing & quality published in the JuliaLang/julia repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Run Clang static analysis on Julia's C/C++ runtime and codegen, and satisfy the GC-rooting checker. Use after modifying runtime/codegen .c/.cpp files under src/ (excluding headers), before opening a PR.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/JuliaLang/julia/blob/HEAD/doc/src/devdocs/agents/skills/c-static-analysis/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/c-static-analysis, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
C/C++ static analysis (src/)
Use this after you modify a runtime/codegen C/C++ source file under src/ (not
headers). Note that runtime changes also require a rebuild (make -j).
Run static analysis checks:
- First run
make -C src install-analysis-depsto initialize dependencies (only needed once the first time, or after the LLVM/Clang toolchain dependencies change). This may download and install LLVM/Clang artifacts. - For a source file such as
src/jloptions.corsrc/codegen.cpp, use the file stem without the.c/.cppextension:
For example, to analyzemake -C src analyze-<file-stem> -j8 [--output-sync]src/jloptions.c, run:
Addmake -C src analyze-jloptions -j8--output-syncwhen yourmakesupports it to keep parallel output grouped; otherwise omit it. - Checks can also be rerun individually with
clang-sa-<file-stem>,clang-sagc-<file-stem>orclang-tidy-<file-stem>.
Fixing the GC-rooting checker (clang-sagc)
If clang-sagc-<file-stem> fails, first look for fixes that establish real
rooting, such as adding appropriate JL_GC_PUSH/JL_GC_POP scopes, or for
lock/control-flow fixes.
Do not add JL_GC_PROMISE_ROOTED without explicit user or maintainer
confirmation. JL_GC_PROMISE_ROOTED asserts that a value is already rooted; it
does not root the value. If it appears necessary, stop and ask for confirmation,
showing the exact expression, the existing root that makes it safe, and the
safepoints considered.
- Remember arguments are assumed rooted, so check the callers to make sure that is handled.
- As a diagnostic hint when asking for confirmation: if the value is temporarily
moved through a struct or arraylist and then reloaded, the promised expression
may need to refer to the reloaded field, such as
JL_GC_PROMISE_ROOTED(struct->field), immediately after the reload and before any use of that field. - If confirmed, put the promise as early in the code as is legal, near the definition or reload rather than the use.