Overlay: Add manual Java overlay annotations & discard predicates #19813
+137
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To
10000
review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6f5bc41 to
8672313
Compare
8672313 to
db52a3c
Compare
jbj
reviewed
Jun 20, 2025
db52a3c to
26896ea
Compare
ea40677 to
052023e
Compare
bdf1bdd to
3c2c871
Compare
052023e to
81b677a
Compare
3c2c871 to
0ee6a78
Compare
|
The |
jbj
approved these changes
Jun 25, 2025
aschackmull
reviewed
Jun 25, 2025
| // numlines is used to restrict attention to fully extracted files and | ||
| // ignore skeleton extracted files in the overlay | ||
| exists(@locatable l | numlines(l, _, _, _) and file = getRawFile(l)) | ||
| } |
There was a problem hiding this comment.
How about adding the following:
Suggested change
| } | |
| } | |
| /** | |
| * A `@locatable` in the base variant that should be discarded if its file is | |
| * extracted in the overlay variant. | |
| */ | |
| overlay[local] | |
| abstract class DiscardableLocatable extends @locatable { | |
| string getRawFileInBase() { not isOverlay() and result = getRawFile(this) } | |
| } | |
| overlay[discard_entity] | |
| private predicate discardLocatable(@locatable el) { | |
| extractedInOverlay(el.(DiscardableLocatable).getRawFileInBase()) | |
| } |
I think that can reduce a lot of boilerplate.
There was a problem hiding this comment.
Similarly, for things like @method we can use:
/**
* A `@locatable` in the base variant that should be discarded if its file is
* extracted in the overlay variant and it is itself not extracted in the
* overlay, that is, it is deleted in the overlay.
*/
overlay[local]
abstract class DiscardableReferableLocatable extends @locatable {
string getRawFileInBase() { not isOverlay() and result = getRawFile(this) }
predicate existsInOverlay() { isOverlay() and exists(this) }
}
overlay[discard_entity]
private predicate discardReferableLocatable(@locatable el) {
exists(DiscardableReferableLocatable drl | drl = el |
extractedInOverlay(drl.getRawFileInBase()) and
not drl.existsInOverlay()
)
}
There was a problem hiding this comment.
Nice. I've added the suggested abstraction for locatables in commit 4. I've left the locations case as is, as there is only one discard predicate for locations currently.
Comment on lines
2706
to
2716
| overlay[local] | ||
| private predicate discardableExpr(string file, @expr e) { | ||
| not isOverlay() and | ||
| file = getRawFile(e) | ||
| } | ||
|
|
||
| /** Discard base expressions in files fully extracted in the overlay. */ | ||
| overlay[discard_entity] | ||
| private predicate discardExpr(@expr e) { | ||
| exists(string file | discardableExpr(file, e) and extractedInOverlay(file)) | ||
| } |
There was a problem hiding this comment.
With the suggested DiscardableLocatable, this could simply become:
Suggested change
| overlay[local] | |
| private predicate discardableExpr(string file, @expr e) { | |
| not isOverlay() and | |
| file = getRawFile(e) | |
| } | |
| /** Discard base expressions in files fully extracted in the overlay. */ | |
| overlay[discard_entity] | |
| private predicate discardExpr(@expr e) { | |
| exists(string file | discardableExpr(file, e) and extractedInOverlay(file)) | |
| } | |
| overlay[local] | |
| private class DiscardableExpr extends DiscardableLocatable, @expr { } |
I'm unsure whether overlay[local] is needed here or whether it's inherited from DiscardableLocatable.
There was a problem hiding this comment.
overlay[local] is not inherited from DiscardableLocatable, but the overlay[local?] annotation from the top-level module declaration is inherited, so overlay[local] isn't strictly needed, but does clarify the intend.
| overlay[local] | ||
| private predicate discardableJavadoc(string file, @javadoc d) { | ||
| not isOverlay() and | ||
| exists(@member m | file = getRawFile(m) and hasJavadoc(m, d)) |
There was a problem hiding this comment.
I believe @javadoc is a @locatable, so the indirection through hasJavadoc is unnecessary, I think. Also, with the abstract class this would simply be
private class DiscardableJavadoc extends DiscardableLocatable, @javadoc { }
There was a problem hiding this comment.
Good point; the indirection is unnecessary.
54589c8 to
bcadf31
Compare
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.
This PR builds on top of #19779, adding a few additional manual overlay annotations and defining entity discard predicates for Java.
The
overlay[local?]annotations in the experimental queries are needed to ensure that virtual dispatch (which depends indirectly onActiveExperimentalModels) becomes local. In addition to the manualoverlay[local?]annotations, the PR adds anoverlay[global]annotation inDataFlowImplCommon.qllto ensure lambda flow is global.The entity discard predicates defined in this PR are not exhaustive and additional discarding may be needed. The PR adds entity discard predicates to discard the following: