[StaticAnalyzer] Fix tryExpandAsInteger's failures on PCH macros #142722
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
The function `tryExpandAsInteger` attempts to extract an integer from a macro definition. Previously, the attempt would fail when the macro is from a PCH, because the function tried to access the text buffer of the source file, which does not exist in case of PCHs. The fix uses `Preprocessor::getSpelling`, which works in either cases. rdar://151403070
ziqingluo-90
requested review from
Xazax-hun,
SavchenkoValeriy,
haoNoQ,
malavikasamak,
martong,
steakhal,
t-rasmud and
NagyDonat
llvmbot
added
clang
|
@llvm/pr-subscribers-clang @llvm/pr-subscribers-clang-static-analyzer-1 Author: Ziqing Luo (ziqingluo-90) ChangesThe function rdar://151403070 Full diff: https://github.com/llvm/llvm-project/pull/142722.diff 3 Files Affected:
diff --git a/clang/lib/StaticAnalyzer/Core/CheckerHelpers.cpp b/clang/lib/StaticAnalyzer/Core/CheckerHelpers.cpp
index 4ed4113919c1d..111af35806dda 100644
--- a/clang/lib/StaticAnalyzer/Core/CheckerHelpers.cpp
+++ b/clang/lib/StaticAnalyzer/Core/CheckerHelpers.cpp
@@ -129,11 +129,19 @@ std::optional<int> tryExpandAsInteger(StringRef Macro, const Preprocessor &PP) {
// Parse an integer at the end of the macro definition.
const Token &T = FilteredTokens.back();
- // FIXME: EOF macro token coming from a PCH file on macOS while marked as
- // literal, doesn't contain any literal data
- if (!T.isLiteral() || !T.getLiteralData())
+
+ if (!T.isLiteral())
return std::nullopt;
- StringRef ValueStr = StringRef(T.getLiteralData(), T.getLength());
+
+ bool InvalidSpelling = false;
+ // `Preprocessor::getSpelling` can get the spelling of the token regardless of
+ // whether the macro is defined in a PCH or not:
+ std::string Spelling = PP.getSpelling(T, &InvalidSpelling);
+
+ if (InvalidSpelling)
+ return std::nullopt;
+
+ StringRef ValueStr(Spelling);
llvm::APInt IntValue;
constexpr unsigned AutoSenseRadix = 0;
if (ValueStr.getAsInteger(AutoSenseRadix, IntValue))
diff --git a/clang/test/Analysis/pch_crash.cpp b/clang/test/Analysis/pch_crash.cpp
deleted file mode 100644
index 7ad2cb2d2ab57..0000000000000
--- a/clang/test/Analysis/pch_crash.cpp
+++ /dev/null
@@ -1,28 +0,0 @@
-// RUN: %clang_cc1 -triple x86_64-apple-macosx10.15.0 -emit-pch -o %t %s
-// RUN: %clang_analyze_cc1 -triple x86_64-apple-macosx10.15.0 -include-pch %t \
-// RUN: -analyzer-checker=core,apiModeling -verify %s
-//
-// RUN: %clang_cc1 -emit-pch -o %t %s
-// RUN: %clang_analyze_cc1 -include-pch %t \
-// RUN: -analyzer-checker=core,apiModeling -verify %s
-
-// expected-no-diagnostics
-
-#ifndef HEADER
-#define HEADER
-// Pre-compiled header
-
-int foo();
-
-// Literal data for this macro value will be null
-#define EOF -1
-
-#else
-// Source file
-
-int test() {
- // we need a function call here to initiate erroneous routine
- return foo(); // no-crash
-}
-
-#endif
diff --git a/clang/test/Analysis/pch_macro.cpp b/clang/test/Analysis/pch_macro.cpp
new file mode 100644
index 0000000000000..0cc00cfe0cc17
--- /dev/null
+++ b/clang/test/Analysis/pch_macro.cpp
@@ -0,0 +1,39 @@
+// RUN: %clang_cc1 -triple x86_64-apple-macosx10.15.0 -emit-pch -o %t %s
+// RUN: %clang_analyze_cc1 -triple x86_64-apple-macosx10.15.0 -include-pch %t \
+// RUN: -analyzer-checker=core,apiModeling,unix.StdCLibraryFunctions -verify %s
+//
+// RUN: %clang_cc1 -emit-pch -o %t %s
+// RUN: %clang_analyze_cc1 -include-pch %t \
+// RUN: -analyzer-checker=core,apiModeling,unix.StdCLibraryFunctions -verify %s
+
+// expected-no-diagnostics
+
+#ifndef HEADER
+#define HEADER
+// Pre-compiled header
+
+int foo();
+
+// Literal data for macro values will be null as they are defined in a PCH
+#define EOF -1
+#define AT_FDCWD -2
+
+#else
+// Source file
+
+int test() {
+ // we need a function call here to initiate erroneous routine
+ return foo(); // no-crash
+}
+
+// Test that StdLibraryFunctionsChecker can obtain the definition of
+// AT_FDCWD even if it is from a PCH:
+int faccessat(int, const char *, int, int);
+
+void test_faccessat() {
+ char fileSystemPath[10] = { 0 };
+
+ if (0 != faccessat(AT_FDCWD, fileSystemPath, 2, 0x0030)) {}
+}
+
+#endif
|
steakhal
requested changes
Jun 4, 2025
|
CC @dtarditi |
steakhal
approved these changes
Jun 5, 2025
|
Thank you for reviewing steakhal! |
|
FYI the CI checks are red, I don't think its related to this PR. So we should be good to merge, any time you want. |
|
Hmm, I only checked now that you probably already had commit access. I should have left this up to you to merge. |
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/162/builds/23912 Here is the relevant piece of the build log for the reference |
|
Thanks for merging it for me. Buildbots failures seems irrelevant: |
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 function
tryExpandAsIntegerattempts to extract an integer from a macro definition. Previously, the attempt would fail when the macro is from a PCH, because the function tried to access the text buffer of the source file, which does not exist in case of PCHs. The fix usesPreprocessor::getSpelling, which works in either cases.rdar://151403070