Java: Use the shared BasicBlocks library. #19505
Open
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
There was a problem hiding this comment.
Pull Request Overview
Migration to the shared BasicBlock library and deprecation of legacy bb* methods and predicates, updating call sites to use the new BasicBlock API.
- Replaced legacy dominance and successor/predecessor methods (
bbDominates,getABBSuccessor, etc.) with the shared-library methods (dominates,getASuccessor, etc.). - Updated imports, removed unused
Dominanceimports, and augmentedqlpack.ymlto depend oncodeql/controlflow. - Introduced
SuccessorTypedefinitions, updatedBasicBlocks.qllto use the sharedBasicBlockimplementation, and added change notes.
Reviewed Changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| java/ql/lib/semmle/code/java/security/PathSanitizer.qll | Swapped bbDominates for dominates. |
| java/ql/lib/semmle/code/java/security/AndroidWebViewCertificateValidationQuery.qll | Swapped bbPostDominates for postDominates. |
| java/ql/lib/semmle/code/java/dataflow/internal/rangeanalysis/SsaReadPositionSpecific.qll | Updated idOf to use getFirstNode().getAstNode(). |
| java/ql/lib/semmle/code/java/dataflow/internal/SsaImpl.qll | Removed Dom import; switched to immediatelyDominates and getASuccessor. |
| java/ql/lib/semmle/code/java/dataflow/internal/DataFlowUtil.qll | Replaced getABBSuccessor calls with getASuccessor. |
| java/ql/lib/semmle/code/java/dataflow/internal/DataFlowPrivate.qll | Swapped bbIDominates and getABBSuccessor for shared APIs. |
| java/ql/lib/semmle/code/java/dataflow/internal/BaseSSA.qll | Removed Dom import; switched to shared dominator/successor APIs. |
| java/ql/lib/semmle/code/java/dataflow/TypeFlow.qll | Replaced getABBPredecessor and bbDominates with new methods. |
| java/ql/lib/semmle/code/java/dataflow/RangeAnalysis.qll | Updated idOf and successor calls to use getFirstNode/getASuccessor. |
| java/ql/lib/semmle/code/java/dataflow/Nullness.qll | Replaced all getABBSuccessor/getAST* with new basic-block methods. |
| java/ql/lib/semmle/code/java/controlflow/internal/GuardsLogic.qll | Updated dominance checks to use dominates and new successor logic. |
| java/ql/lib/semmle/code/java/controlflow/UnreachableBlocks.qll | Replaced predecessor and dominance calls with shared methods. |
| java/ql/lib/semmle/code/java/controlflow/SuccessorType.qll | Added new SuccessorType hierarchy. |
| java/ql/lib/semmle/code/java/controlflow/Paths.qll | Swapped legacy bb* calls for shared successor/dominance methods. |
| java/ql/lib/semmle/code/java/controlflow/Guards.qll | Updated getTestSuccessor, dominance checks to new form. |
| java/ql/lib/semmle/code/java/controlflow/Dominance.qll | Deprecated old predicates, forwarding to new methods. |
| java/ql/lib/semmle/code/java/controlflow/BasicBlocks.qll | Imported and extended shared BasicBlock implementation. |
| java/ql/lib/qlpack.yml | Added codeql/controlflow dependency. |
| java/ql/lib/change-notes/2025-05-16-shared-basicblocks.md | Documented deprecation and migration to shared BasicBlock. |
| cpp/ql/lib/semmle/code/cpp/rangeanalysis/new/internal/semantic/SemanticCFG.qll | Renamed bbDominates to dominates. |
Comments suppressed due to low confidence (3)
java/ql/lib/semmle/code/java/controlflow/BasicBlocks.qll:6
- [nitpick] The
Dominanceimport is now redundant since the sharedBasicBlockAPI provides dominance predicates; consider removing this import to clean up unused dependencies.
import Dominance
java/ql/lib/semmle/code/java/controlflow/SuccessorType.qll:1
- The new
SuccessorTypehierarchy introduced here doesn’t appear to have dedicated tests; consider adding unit tests to coverNormalSuccessor,ConditionalSuccessor, andExceptionSuccessorhandling.
import java
java/ql/lib/semmle/code/java/dataflow/internal/DataFlowPrivate.qll:86
- The
BasicBlocktype isn’t aliased in this module; you should addprivate import java as Jandclass BasicBlock = J::BasicBlock;at the top to ensure the correct type is used.
BasicBlock getImmediateBasicBlockDominator(BasicBlock bb) {
| @@ -4,91 +4,130 @@ | ||
|
|
||
| import java | ||
| import Dominance | ||
| private import codeql.controlflow.BasicBlock as Bb |
Check warning
Code scanning / CodeQL
Names only differing by case Warning
| * That is, all paths reaching `bb` from the entry point basic block must | ||
| * go through this basic block. | ||
| */ | ||
| predicate dominates(BasicBlock node) { super.dominates(node) } |
Check warning
Code scanning / CodeQL
Missing QLDoc for parameter Warning
| } | ||
|
|
||
| /** Exit points for basic-block control-flow. */ | ||
| private predicate bbSink(BasicBlock exit) { exit.getLastNode() instanceof ControlFlow::ExitNode } | ||
|
|
||
| /** Reversed `bbSucc`. */ | ||
| private predicate bbPred(BasicBlock post, BasicBlock pre) { post = pre.getABBSuccessor() } | ||
| private predicate bbPred(BasicBlock post, BasicBlock pre) { post = pre.getASuccessor() } |
Check warning
Code scanning / CodeQL
Missing QLDoc for parameter Warning
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.
What the title says. Also, since
BasicBlockis now no longer cast-compatible withControlFlowNodethere's no reason to use all thebb-prefixed names, so I've deprecated those and switched to the defaults provided by the shared library.