Skip to content

Commit 6bc6da0

Browse files
authored
Merge pull request #111 from codellm-devkit/feat/vendor-scalpel-default-oracle
feat(dataflow): vendored typed_ast-free scalpel as the default L4 oracle
2 parents 8fdd50d + 3df8ed7 commit 6bc6da0

21 files changed

Lines changed: 2741 additions & 47 deletions

.claude/SCHEMA_DECISIONS.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,17 @@ supported 3.9–3.13+ range; `compute_SSA`'s return contract is discovered from
152152
source (not a documented public API) — wrap it behind `ScalpelAliasOracle` to
153153
contain upstream drift.
154154

155+
**Follow-up (2026-07-22): Scalpel vendored, now the default.** The Stage-0
156+
"dependency hygiene" concern proved fatal for a hard dependency: `python-scalpel`
157+
drags `typed_ast`, which has no wheel for Python 3.12+ and does not build from
158+
source there, so `pip install python-scalpel` fails on 3.12/3.13/3.14. Since
159+
`typed_ast` is imported only by `scalpel/typeinfer` (unused here), the 9-module
160+
`SSA`/`cfg`/`core` slice the oracle loads was **vendored** into
161+
`codeanalyzer/dataflow/scalpel/` (Apache-2.0, verbatim but for a `graphviz`-lazy
162+
patch). `ScalpelAliasOracle` is now the shipping default on all supported Python;
163+
`TypeBasedAliasOracle` is the runtime safety net only. See
164+
`docs/superpowers/specs/2026-07-22-vendored-scalpel-default-oracle-design.md`.
165+
155166
## Stage 5 — keystone conformance sweep (issue #98, schema_version 2.0.0)
156167

157168
The stage-5 pre-release conformance check against the canonical schema-v2

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Changed
11+
- The Scalpel-backed L4 points-to oracle is now **vendored** (`typed_ast`-free)
12+
and the default on all supported Python (3.9–3.14); `python-scalpel` is no
13+
longer an optional dependency and the `[scalpel]` extra is removed. On Python
14+
3.12+ (and anywhere the `[scalpel]` extra was not installed), L4
15+
`prov:["points-to"]` data-dependence edges are now Scalpel-precise rather than
16+
the coarser type-based over-approximation; the `prov:["ssa"]` set and the
17+
`L3 ⊆ L4` monotonicity invariant are unchanged. Adds `astor` as a runtime
18+
dependency.
19+
1020
## [1.0.3] - 2026-07-21
1121

1222
### Fixed

CLAUDE.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,13 @@ declared callables by their `can://` tree id, imported/builtin targets by a
122122
(`codeanalyzer/dataflow/scalpel_oracle.py`) consumes `python-scalpel`'s **solved
123123
SSA + copy/const** state (it never forks the solver) as a copy-closure union-find
124124
over access paths, behind the frozen `may_alias(path_a, path_b) -> bool`
125-
interface. `python-scalpel` is an **optional** dependency: if it is absent or a
126-
build/query fails, the analyzer falls back to the total `TypeBasedAliasOracle`
127-
(`alias.py`) and degrades, never raising. The type-based oracle is the sanctioned
128-
fallback, not the shipping default.
125+
interface. Scalpel is **vendored** (`codeanalyzer/dataflow/scalpel/`, a
126+
`typed_ast`-free 9-module slice of `python-scalpel 1.0b0`, Apache-2.0) so it is
127+
the **shipping default** L4 oracle on every supported Python — there is no
128+
external `python-scalpel`/`typed_ast` dependency. `TypeBasedAliasOracle`
129+
(`alias.py`) is retained only as the runtime safety net: on a per-callable
130+
Scalpel build failure or a per-query unresolved access path, `may_alias`
131+
degrades to it, never raising.
129132
- **CLI gating** (`codeanalyzer/__main__.py`): `-a` max is 4; `--graphs sdg`
130133
requires `-a 4` (a flag error below that); `cfg,dfg,pdg` require `-a 3`;
131134
`--graph-field-depth` (the `k_limit`) is valid at L3+.

NOTICE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,10 @@ Any other use of CodeQL, including its use on proprietary code or in closed-sour
1616

1717
You can view the full CodeQL license at:
1818
https://github.com/github/codeql/blob/main/LICENSE
19+
20+
--- Scalpel License Notice ---
21+
22+
This project vendors a slice of Scalpel (python-scalpel), a product of SMAT-Lab,
23+
under codeanalyzer/dataflow/scalpel/. Scalpel is licensed under the Apache
24+
License 2.0. The full license text is included at
25+
codeanalyzer/dataflow/scalpel/LICENSE. Source: https://github.com/SMAT-Lab/Scalpel

README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,12 +104,9 @@ For the optional **live Neo4j push** (`--emit neo4j --neo4j-uri …`), install t
104104
pip install 'codeanalyzer-python[neo4j]'
105105
```
106106

107-
For the **Scalpel-backed points-to oracle** at level 4, install the `scalpel` extra. It is optional:
108-
when it is absent, level 4 automatically falls back to the built-in type-based oracle.
109-
110-
```sh
111-
pip install 'codeanalyzer-python[scalpel]'
112-
```
107+
The **Scalpel-backed points-to oracle** at level 4 is vendored and built in — no extra install
108+
required. If Scalpel cannot resolve a construct, level 4 automatically falls back to the built-in
109+
type-based oracle.
113110

114111
### Install via shell script
115112

@@ -529,11 +526,12 @@ symbol-table signature by construction
529526
- **Points-to oracle (level 4):** the **Scalpel** may-alias oracle — `ScalpelAliasOracle`
530527
(`codeanalyzer/dataflow/scalpel_oracle.py`) — consumes Scalpel's SSA copy/const facts to answer
531528
`may_alias(path_a, path_b)`, adding the alias-aware DDG edges (`prov: ["points-to"]`) and the
532-
interprocedural summaries. `python-scalpel` is an **optional dependency**
533-
(`pip install 'codeanalyzer-python[scalpel]'`); when it is absent or cannot resolve a construct,
534-
the analyzer automatically falls back to the built-in `TypeBasedAliasOracle` (Jedi-inferred types;
535-
unknown types conservatively alias), keeping the `may_alias` interface total. Call dispatch comes
536-
from the merged Jedi(+PyCG) call graph, treated as a frozen oracle.
529+
interprocedural summaries. Scalpel is **vendored** — a `typed_ast`-free slice built into the
530+
package under `codeanalyzer/dataflow/scalpel/` — so it is the **default** level-4 oracle with no
531+
external dependency to install; the analyzer falls back to the built-in `TypeBasedAliasOracle`
532+
(Jedi-inferred types; unknown types conservatively alias) only when Scalpel can't resolve a
533+
construct or a per-callable build fails, keeping the `may_alias` interface total. Call dispatch
534+
comes from the merged Jedi(+PyCG) call graph, treated as a frozen oracle.
537535
- **Summaries:** relational formal-in → formal-out flows composed bottom-up over the Tarjan SCC
538536
condensation of the call graph, a monotone fixpoint within SCCs; globals ride as extra formals,
539537
closure captures bind at definition sites.
Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Vendored Scalpel (typed_ast-free slice)
2+
3+
Vendored from **[SMAT-Lab/Scalpel](https://github.com/SMAT-Lab/Scalpel)**,
4+
package `python-scalpel==1.0b0`, licensed **Apache-2.0** (see `LICENSE`).
5+
6+
## Why vendored
7+
8+
`python-scalpel` hard-depends on `typed_ast`, whose last release (1.5.5) has no
9+
wheel for Python 3.12+ and fails to build from source on modern compilers — so
10+
`pip install python-scalpel` fails on 3.12/3.13/3.14. `typed_ast` is imported by
11+
exactly one scalpel module, `typeinfer/analysers.py`, which codeanalyzer does not
12+
use. Vendoring the small slice the L4 may-alias oracle needs removes the
13+
`typed_ast` dependency and makes scalpel the default oracle on every supported
14+
Python.
15+
16+
## What is vendored
17+
18+
Exactly the 9-module closure that `scalpel.SSA.const` + `scalpel.cfg` load
19+
(verified via `sys.modules`; provably free of `typeinfer`/`typed_ast`):
20+
21+
__init__.py
22+
SSA/__init__.py, SSA/const.py
23+
cfg/__init__.py, cfg/builder.py, cfg/model.py
24+
core/__init__.py, core/func_call_visitor.py, core/vars_visitor.py
25+
26+
Copied verbatim except **one patch**: `cfg/model.py`'s top-level
27+
`import graphviz as gv` is guarded (`try/except ImportError: gv = None`) so the
28+
module imports without the `graphviz` package — the graphviz-using
29+
`build_visual()` methods are unused here.
30+
31+
Runtime deps of this slice: `astor`, `networkx` (both core dependencies of
32+
codeanalyzer). `typed_ast` and `graphviz` are NOT required.
33+
34+
To refresh: re-run the vendoring in `docs/superpowers/plans/2026-07-22-vendored-scalpel-default-oracle.md` Task 1.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
"""
2+
Static Single Assignment (SSA) is a technique of IR in the compiling thoery, it also shows great benefits to static anaysis tasks such as constant propagation, dead code elimination and etc.
3+
Constant propagation is also a matured technique in static anaysis.
4+
It is the process of evaluating or recognizing the actual constant values or expressions at a particular program point. This is realized by utilizing control flow and data flow information. Determining the possible values for variables before runtime gives great benefits to software anaysis.
5+
For instance, with constant value propagation, we can detect and remove dead code or perfrom type checking.
6+
In scalpel, we implement constant propagation along with the SSA for execution efficiency.
7+
"""
8+
__slots__ = ["const"]

0 commit comments

Comments
 (0)