Ensure that SourceFiles always have a backing buffer in the SourceManager #76512
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.
DougGregor
requested review from
hborla,
xedin,
slavapestov,
ahoppen,
bnbarham,
hamishknight,
rintaro,
eeckstein,
jckarter,
CodaFi,
nkcsgexi,
artemcm,
tshortli,
zoecarver,
hyp,
egorzhdan,
beccadax and
ian-twilightcoder
as code owners
|
@swift-ci please smoke test |
|
@swift-ci please test source compatibility |
CodaFi
reviewed
Sep 17, 2024
| ParsingOptions parsingOpts, bool isPrimary) | ||
| : FileUnit(FileUnitKind::Source, M), BufferID(bufferID ? *bufferID : -1), | ||
| : FileUnit(FileUnitKind::Source, M), BufferID(bufferID), | ||
| ParsingOpts(parsingOpts), IsPrimary(isPrimary), Kind(K) { | ||
| M.getASTContext().addDestructorCleanup(*this); |
There was a problem hiding this comment.
Should this assert that the buffer ID isn't ~0 or is that now valid (if... very unlikely to be encountered in the wild)?
-1 was once used as a sentinel value for "no buffer"; make sure it doesn't persist anywhere.
|
@swift-ci please test |
|
@swift-ci please smoke test |
|
@swift-ci please smoke test |
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.
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
nulloptas 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. The code that created a source buffer to parse Cswift_attrattributes also failed to pass that source buffer through.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.