Reimplement ModuleDecl::getSourceFileContainingLocation() using SourceManager #76551
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
…butes When rendering a swift_attr attribute for parsing, we were creating both the backing buffer and a source file, but not providing the buffer's ID to the source file, so we couldn't find the source code again. Fix that. While here, also register the source file with the module, so we can find the source file again based on location.
…ager The "buffer ID" in a SourceFile, which is used to find the source file's contents in the SourceManager, has always been optional. However, the effectively every SourceFile actually does have a buffer ID, and the vast majority of accesses to this information dereference the optional without checking. Update the handful of call sites that provided `nullopt` as the buffer ID to provide a proper buffer instead. These were mostly unit tests and testing programs, with a few places that passed a never-empty optional through to the SourceFile constructor. Then, remove optionality from the representation and accessors. It is now the case that every SourceFile has a buffer ID, simplying a bunch of code.
-1 was once used as a sentinel value for "no buffer"; make sure it doesn't persist anywhere.
Now that every source file has a buffer ID, introduce the reverse mapping so clients can find the source file(s) in their module that reference that buffer ID.
…eManager ModuleDecl kept track of all of the source files in the module so that it could find the source file containing a given location, which relied on a sorted array all of these source files. SourceManager has its own similar data structure for a similar query mapping the locations to buffer IDs. Replace ModuleDecl's dats structure with a use of the SourceManager's version with the mapping from buffer IDs to source files.
DougGregor
requested review from
hborla,
xedin,
slavapestov,
ahoppen,
bnbarham,
hamishknight,
rintaro,
xymus,
eeckstein,
jckarter,
CodaFi,
nkcsgexi,
artemcm,
tshortli,
zoecarver,
hyp,
egorzhdan,
beccadax and
ian-twilightcoder
as code owners
|
@swift-ci please smoke test |
|
Note: only the last two commits are new, building on top of #76512 |
ahoppen
reviewed
Sep 18, 2024
rintaro
reviewed
Sep 18, 2024
| llvm::DenseMap< | ||
| unsigned, | ||
| llvm::TinyPtrVector<SourceFile *> | ||
| > bufferIDToSourceFiles; |
There was a problem hiding this comment.
Would you remind me of scenarios where multiple SourceFile can reference the same buffer?
There was a problem hiding this comment.
The only place I've seen this happen thus far is in the Clang importer, where it's effectively uniquing the text of C __attribute__((swift_attr("<this is a Swift attribute>"))) to not create lots of buffers, but it still needs to provide a different SourceFile * for each imported module.
We might consider doing similar uniquing for macro expansion buffers, because there could be a lot of identical buffers.
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.
ModuleDecl kept track of all of the source files in the module so that it could find the source file containing a given location, which relied on a sorted array all of these source files. SourceManager has its own similar data structure for a similar query mapping the locations to buffer IDs.
Replace ModuleDecl's dats structure with a use of the SourceManager's location -> buffer ID mapping. Augment SourceManager with a bufferID -> SourceFile mapping so we can do this.