[Clang] Report an error and crash on source location exhaustion in macros #69908
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
llvmbot
added
the
clang:frontend
|
@llvm/pr-subscribers-clang Author: Ilya Biryukov (ilya-biryukov) Changes
Diagnose this problem and reliably crash to make sure the problem is easy to detect. I have also tried:
Both caused the compiler to run indefinitely. It would be nice to dig further why that happens, but until then crashing seems like a better alternative. Full diff: https://github.com/llvm/llvm-project/pull/69908.diff 2 Files Affected:
diff --git a/clang/include/clang/Basic/DiagnosticCommonKinds.td b/clang/include/clang/Basic/DiagnosticCommonKinds.td
index f2df283c74829f6..080748a73571690 100644
--- a/clang/include/clang/Basic/DiagnosticCommonKinds.td
+++ b/clang/include/clang/Basic/DiagnosticCommonKinds.td
@@ -356,6 +356,8 @@ def err_file_modified : Error<
"file '%0' modified since it was first processed">, DefaultFatal;
def err_file_too_large : Error<
"sorry, unsupported: file '%0' is too large for Clang to process">;
+def err_expansions_too_large : Error<
+ "sorry, the translation unit is too large: ran out of source locations while processing a macro expansion">, DefaultFatal;
def err_include_too_large : Error<
"sorry, this include generates a translation unit too large for"
" Clang to process.">, DefaultFatal;
diff --git a/clang/lib/Basic/SourceManager.cpp b/clang/lib/Basic/SourceManager.cpp
index c44ecacb3de3a10..dcf18c47cbaf9ae 100644
--- a/clang/lib/Basic/SourceManager.cpp
+++ b/clang/lib/Basic/SourceManager.cpp
@@ -663,10 +663,13 @@ SourceManager::createExpansionLocImpl(const ExpansionInfo &Info,
return SourceLocation::getMacroLoc(LoadedOffset);
}
LocalSLocEntryTable.push_back(SLocEntry::get(NextLocalOffset, Info));
- // FIXME: Produce a proper diagnostic for this case.
- assert(NextLocalOffset + Length + 1 > NextLocalOffset &&
- NextLocalOffset + Length + 1 <= CurrentLoadedOffset &&
- "Ran out of source locations!");
+ if (NextLocalOffset + Length + 1 <= NextLocalOffset ||
+ NextLocalOffset + Length + 1 > CurrentLoadedOffset) {
+ Diag.Report(Info.getExpansionLocStart(), diag::err_expansions_too_large);
+ Diag.Report(Info.getExpansionLocStart(), diag::remark_sloc_usage);
+ noteSLocAddressSpaceUsage(Diag);
+ return SourceLocation();
+ }
// See createFileID for that +1.
NextLocalOffset += Length + 1;
return SourceLocation::getMacroLoc(NextLocalOffset - (Length + 1));
|
sam-mccall
reviewed
Oct 23, 2023
sam-mccall
approved these changes
Oct 23, 2023
sam-mccall
approved these changes
Oct 23, 2023
…on in macros `createExpansionLocImpl` has an assert that checks if we ran out of source locations. We have observed this happening on real code and in release builds the assertion does not fire and the compiler just keeps running indefinitely without giving any indication that something went wrong. Diagnose this problem and reliably crash to make sure the problem is easy to detect. I have also tried: - returning invalid source locations, - reporting sloc address space usage on error. Both caused the compiler to run indefinitely. It would be nice to dig further why that happens, but until then crashing seems like a better alternative.
…xhaustion in macros
…xhaustion in macros - Unify the error when running out of slocs in includes and macro - Use `SourceLocation()` instead of `Info.getSpellingLoc()` to avoid printing the location, which also causes Clang to run indefinitely.
…xhaustion in macros - Add a comment about using SourceLocation()
…xhaustion in macros - Update test for sloc overflow
ilya-biryukov
force-pushed
the
expansion_loc
branch
from
b4ffc6a to
73bfd3c
Compare
|
I will land this, but happy to follow up if Aaron or anyone else will have comments. |
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.
createExpansionLocImplhas an assert that checks if we ran out of source locations. We have observed this happening on real code and in release builds the assertion does not fire and the compiler just keeps running indefinitely without giving any indication that something went wrong.Diagnose this problem and reliably crash to make sure the problem is easy to detect.
I have also tried:
Both caused the compiler to run indefinitely. It would be nice to dig further why that happens, but until then crashing seems like a better alternative.