Skip to content

Rust: introduce ExtractedFile::hasSemantics and ::isSkippedByCompilation #20655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
redsun82 merged 4 commits into from
Oct 21, 2025
Merged

Rust: introduce ExtractedFile::hasSemantics and ::isSkippedByCompilation #20655

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a9ae583
Rust: introduce `File::hasSemantics` and `File::isSkippedByCompilation`
redsun82 Oct 16, 2025
4aef1ba
Rust: clean up
redsun82 Oct 16, 2025
6a6015e
Rust: accept test changes
redsun82 Oct 17, 2025
4b04b49
Merge branch 'main' into redsun82/rust-file-semantics-predicates
redsun82 Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions rust/ql/lib/change-notes/2025-10-16-new-extracted-file-methods.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
category: minorAnalysis
---
* Added `ExtractedFile::hasSemantics` and `ExtractedFile::isSkippedByCompilation` predicates.
19 changes: 19 additions & 0 deletions rust/ql/lib/codeql/files/FileSystem.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,25 @@
*/
class ExtractedFile extends File {
ExtractedFile() { this.fromSource() }

private Diagnostic getNoSemanticsDiagnostic() {
result.getTag() = "semantics" and result.getLocation().getFile() = this
}

/**
* Holds if we have semantical information about this file, which means
* we should be able to
* * expand any macros
* * skip any blocks that are conditionally compiled out
*/
predicate hasSemantics() { not exists(Diagnostic d | d = this.getNoSemanticsDiagnostic()) }

/**
* Holds if we know this file was skipped by conditional compilation.
* This is not the same as `not this.hasSemantics()`, as a file
* might not have semantics because of some error.
*/
predicate isSkippedByCompilation() { this.getNoSemanticsDiagnostic().getSeverityText() = "Info" }
}

/**
Expand Down
15 changes: 9 additions & 6 deletions rust/ql/test/extractor-tests/File/File.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
| Cargo.toml:0:0:0:0 | Cargo.toml | fromSource: no |
| a_file.rs:0:0:0:0 | a_file.rs | fromSource: yes |
| another_file.rs:0:0:0:0 | another_file.rs | fromSource: yes |
| lib.rs:0:0:0:0 | lib.rs | fromSource: yes |
| nested.rs:0:0:0:0 | nested.rs | fromSource: yes |
| nested/file.rs:0:0:0:0 | nested/file.rs | fromSource: yes |
| Cargo.toml:0:0:0:0 | Cargo.toml | fromSource: no | hasSemantics: no | isSkippedByCompilation: no |
| a_file.rs:0:0:0:0 | a_file.rs | fromSource: yes | hasSemantics: yes | isSkippedByCompilation: no |
| another_file.rs:0:0:0:0 | another_file.rs | fromSource: yes | hasSemantics: yes | isSkippedByCompilation: no |
| bad_cargo/Cargo.toml:0:0:0:0 | bad_cargo/Cargo.toml | fromSource: no | hasSemantics: no | isSkippedByCompilation: no |
| bad_cargo/src/no_semantics.rs:0:0:0:0 | bad_cargo/src/no_semantics.rs | fromSource: yes | hasSemantics: no | isSkippedByCompilation: no |
| lib.rs:0:0:0:0 | lib.rs | fromSource: yes | hasSemantics: yes | isSkippedByCompilation: no |
| nested.rs:0:0:0:0 | nested.rs | fromSource: yes | hasSemantics: yes | isSkippedByCompilation: no |
| nested/file.rs:0:0:0:0 | nested/file.rs | fromSource: yes | hasSemantics: yes | isSkippedByCompilation: no |
| nested/not_compiled.rs:0:0:0:0 | nested/not_compiled.rs | fromSource: yes | hasSemantics: no | isSkippedByCompilation: yes |
Copy link
Contributor

@geoffw0 geoffw0 Oct 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my education: what (in the Cargo setup) makes file.rs compiled while not_compiled.rs is not?

Copy link
Contributor Author

@redsun82 redsun82 Oct 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's not pulled in as a module.

By default:

  • cargo loads src/lib.rs (for libraries) or src/main.rs (for binaries)
  • for a mod x in those, it will load either src/x.rs or src/x/mod.rs
  • from then on, for each submodule mod z in a x::y module, it will look for either src/x/y/z.rs or src/x/y/z/mod.rs (i.e. submodules are loaded from a directory recreating the module nesting)

If a file is not mentioned by a mod, or if its mention is not compiled because of a cfg setting, then the file is never loaded. There are ways to bypass the default paths (path settings in cargo.toml or path attributes of mod in code), but that's the gist of the file compilation strategy.

Copy link
Contributor

@geoffw0 geoffw0 Oct 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, so it's File/ in the path that identifies file.rs as special.

Copy link
Contributor Author

@redsun82 redsun82 Oct 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's mod file; in nested.rs that includes that

14 changes: 11 additions & 3 deletions rust/ql/test/extractor-tests/File/File.ql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
import rust

from File f, string fromSource
from File f, string fromSource, string hasSemantics, string isSkippedByCompilation
where
exists(f.getRelativePath()) and
if f.fromSource() then fromSource = "fromSource: yes" else fromSource = "fromSource: no"
select f, fromSource
(if f.fromSource() then fromSource = "fromSource: yes" else fromSource = "fromSource: no") and
(
if f.(ExtractedFile).hasSemantics()
then hasSemantics = "hasSemantics: yes"
else hasSemantics = "hasSemantics: no"
) and
if f.(ExtractedFile).isSkippedByCompilation()
then isSkippedByCompilation = "isSkippedByCompilation: yes"
else isSkippedByCompilation = "isSkippedByCompilation: no"
select f, fromSource, hasSemantics, isSkippedByCompilation
1 change: 1 addition & 0 deletions rust/ql/test/extractor-tests/File/bad_cargo/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
!/Cargo.toml
1 change: 1 addition & 0 deletions rust/ql/test/extractor-tests/File/bad_cargo/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
wrong
Empty file added rust/ql/test/extractor-tests/File/bad_cargo/src/no_semantics.rs
View file
Open in desktop
Empty file.
Empty file added rust/ql/test/extractor-tests/File/nested/not_compiled.rs
View file
Open in desktop
Empty file.