Warns about using printf %p for nullptr #75472
Open
Conversation
This file contains 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
|
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write If you have received no comments on your PR for a week, you can request a review If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
llvmbot
added
clang
|
@llvm/pr-subscribers-clang Author: axp (wenpen) ChangesResolve #43453 Full diff: https://github.com/llvm/llvm-project/pull/75472.diff 2 Files Affected:
diff --git a/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp b/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp
index f503b3e88bb35d..c9823625bcfcbf 100644
--- a/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp
+++ b/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp
@@ -11,8 +11,9 @@
//
//===----------------------------------------------------------------------===//
-#include "clang/StaticAnalyzer/Checkers/BuiltinCheckerRegistration.h"
+#include "clang/AST/FormatString.h"
#include "clang/Basic/TargetInfo.h"
+#include "clang/StaticAnalyzer/Checkers/BuiltinCheckerRegistration.h"
#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
#include "clang/StaticAnalyzer/Core/Checker.h"
#include "clang/StaticAnalyzer/Core/CheckerManager.h"
@@ -20,9 +21,12 @@
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringExtras.h"
+#include "llvm/Support/Debug.h"
#include "llvm/Support/raw_ostream.h"
#include <optional>
+#define DEBUG_TYPE "unix-api-checker"
+
using namespace clang;
using namespace ento;
@@ -64,7 +68,7 @@ class UnixAPIPortabilityChecker : public Checker< check::PreStmt<CallExpr> > {
void checkPreStmt(const CallExpr *CE, CheckerContext &C) const;
private:
- mutable std::unique_ptr<BugType> BT_mallocZero;
+ mutable std::unique_ptr<BugType> BT_mallocZero, BT_printNullPtr;
void CheckCallocZero(CheckerContext &C, const CallExpr *CE) const;
void CheckMallocZero(CheckerContext &C, const CallExpr *CE) const;
@@ -73,11 +77,14 @@ class UnixAPIPortabilityChecker : public Checker< check::PreStmt<CallExpr> > {
void CheckAllocaZero(CheckerContext &C, const CallExpr *CE) const;
void CheckAllocaWithAlignZero(CheckerContext &C, const CallExpr *CE) const;
void CheckVallocZero(CheckerContext &C, const CallExpr *CE) const;
+ void CheckPrintNullPtr(CheckerContext &C, const CallExpr *CE) const;
bool ReportZeroByteAllocation(CheckerContext &C,
ProgramStateRef falseState,
const Expr *arg,
const char *fn_name) const;
+ bool ReportPrintNull(CheckerContext &C, ProgramStateRef falseState,
+ const Expr *arg) const;
void BasicAllocationCheck(CheckerContext &C,
const CallExpr *CE,
const unsigned numArgs,
@@ -85,6 +92,21 @@ class UnixAPIPortabilityChecker : public Checker< check::PreStmt<CallExpr> > {
const char *fn) const;
};
+// Collect index of pArg(%p) in format string.
+class PArgFormatStringHandler
+ : public analyze_format_string::FormatStringHandler {
+public:
+ bool HandlePrintfSpecifier(const analyze_printf::PrintfSpecifier &FS,
+ const char *startSpecifier, unsigned specifierLen,
+ const TargetInfo &Target) override;
+
+ const std::vector<size_t> &getPArgIndex() const { return pArgIndex; }
+
+private:
+ std::vector<size_t> pArgIndex;
+ int curIndex = 0;
+};
+
} //end anonymous namespace
static void LazyInitialize(const CheckerBase *Checker,
@@ -455,6 +477,82 @@ void UnixAPIPortabilityChecker::CheckVallocZero(CheckerContext &C,
BasicAllocationCheck(C, CE, 1, 0, "valloc");
}
+bool PArgFormatStringHandler::HandlePrintfSpecifier(
+ const analyze_printf::PrintfSpecifier &FS,
+ const char * /* startSpecifier */, unsigned /* specifierLen */,
+ const TargetInfo & /* Target */) {
+ ++curIndex;
+ if (FS.getConversionSpecifier().getKind() ==
+ clang::analyze_format_string::ConversionSpecifier::Kind::pArg)
+ pArgIndex.push_back(curIndex);
+ return true;
+}
+
+bool UnixAPIPortabilityChecker::ReportPrintNull(CheckerContext &C,
+ ProgramStateRef falseState,
+ const Expr *arg) const {
+ ExplodedNode *N = C.generateErrorNode(falseState);
+ if (N == nullptr)
+ return false;
+ LazyInitialize(
+ this, BT_printNullPtr,
+ "Implementation defined behavior: printf %p with null pointer.");
+ auto report = std::make_unique<PathSensitiveBugReport>(
+ *BT_printNullPtr, "Output null pointer with printf %p", N);
+ report->addRange(arg->getSourceRange());
+ C.emitReport(std::move(report));
+ return true;
+}
+
+void UnixAPIPortabilityChecker::CheckPrintNullPtr(CheckerContext &C,
+ const CallExpr *CE) const {
+ size_t numArgs = CE->getNumArgs();
+ LLVM_DEBUG(llvm::dbgs() << "numArgs: " << numArgs << "\n");
+ if (numArgs < 2)
+ return;
+ PArgFormatStringHandler handler;
+ CE->getArg(0)->dump();
+ const CastExpr *castExpr = dyn_cast<const CastExpr>(CE->getArg(0));
+ if (castExpr == nullptr) {
+ LLVM_DEBUG(llvm::dbgs() << "First arg of printf is not cast expr.\n");
+ return;
+ }
+ const StringLiteral *stringLiteralExpr =
+ dyn_cast<const StringLiteral>(castExpr->getSubExpr());
+ if (stringLiteralExpr == nullptr) {
+ LLVM_DEBUG(llvm::dbgs() << "First arg of printf is not string literal.\n");
+ return;
+ }
+ StringRef formatString = stringLiteralExpr->getString();
+ ParsePrintfString(handler, formatString.begin(), formatString.end(),
+ C.getLangOpts(), C.getASTContext().getTargetInfo(),
+ /* isFreeBSDKPrintf */ false);
+
+ const std::vector<size_t> &pArgIndex = handler.getPArgIndex();
+ ProgramStateRef state = C.getState();
+ LLVM_DEBUG(llvm::dbgs() << "pArgIndex size: " << pArgIndex.size() << "\n");
+ LLVM_DEBUG(
+ for (size_t id
+ : pArgIndex) { llvm::dbgs() << "pArgIndex: " << id << "\n"; });
+ for (size_t id : pArgIndex) {
+ if (id >= numArgs)
+ break;
+ const Expr *arg = CE->getArg(id);
+ const SVal argVal = C.getSVal(arg);
+ if (argVal.isUnknownOrUndef()) {
+ continue;
+ }
+ ProgramStateRef trueState, falseState;
+ std::tie(trueState, falseState) =
+ state->assume(argVal.castAs<DefinedSVal>());
+ // Report bug if pointer is always null.
+ if (!trueState && falseState) {
+ if (ReportPrintNull(C, falseState, arg))
+ break;
+ }
+ }
+}
+
void UnixAPIPortabilityChecker::checkPreStmt(const CallExpr *CE,
CheckerContext &C) const {
const FunctionDecl *FD = C.getCalleeDecl(CE);
@@ -491,6 +589,9 @@ void UnixAPIPortabilityChecker::checkPreStmt(const CallExpr *CE,
else if (FName == "valloc")
CheckVallocZero(C, CE);
+
+ else if (FName == "printf")
+ CheckPrintNullPtr(C, CE);
}
//===----------------------------------------------------------------------===//
diff --git a/clang/test/Analysis/Checkers/portability.cpp b/clang/test/Analysis/Checkers/portability.cpp
new file mode 100644
index 00000000000000..e6265a252eefd3
--- /dev/null
+++ b/clang/test/Analysis/Checkers/portability.cpp
@@ -0,0 +1,23 @@
+// RUN: %clang_analyze_cc1 -analyzer-checker=optin.portability -verify %s
+
+extern int printf(const char *, ...);
+
+void print_null_ptr() {
+ int x = 0;
+ printf("ppppp%dppppp", x); // no warning
+
+ int* p = &x;
+ printf("dddd%pddddd", p); // no warning
+
+ p = nullptr;
+ printf("dddddd%pdddddd", p); // expected-warning{{Output null pointer with printf %p}}
+}
+
+void test2() {
+ int x = 0;
+ void* p = &x;
+ printf("%d %p", x, p); // no warning
+
+ p = nullptr;
+ printf("%d %p", x, p); // expected-warning{{Output null pointer with printf %p}}
+}
|
|
@llvm/pr-subscribers-clang-static-analyzer-1 Author: axp (wenpen) ChangesResolve #43453 Full diff: https://github.com/llvm/llvm-project/pull/75472.diff 2 Files Affected:
diff --git a/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp b/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp
index f503b3e88bb35d..c9823625bcfcbf 100644
--- a/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp
+++ b/clang/lib/StaticAnalyzer/Checkers/UnixAPIChecker.cpp
@@ -11,8 +11,9 @@
//
//===----------------------------------------------------------------------===//
-#include "clang/StaticAnalyzer/Checkers/BuiltinCheckerRegistration.h"
+#include "clang/AST/FormatString.h"
#include "clang/Basic/TargetInfo.h"
+#include "clang/StaticAnalyzer/Checkers/BuiltinCheckerRegistration.h"
#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
#include "clang/StaticAnalyzer/Core/Checker.h"
#include "clang/StaticAnalyzer/Core/CheckerManager.h"
@@ -20,9 +21,12 @@
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/StringExtras.h"
+#include "llvm/Support/Debug.h"
#include "llvm/Support/raw_ostream.h"
#include <optional>
+#define DEBUG_TYPE "unix-api-checker"
+
using namespace clang;
using namespace ento;
@@ -64,7 +68,7 @@ class UnixAPIPortabilityChecker : public Checker< check::PreStmt<CallExpr> > {
void checkPreStmt(const CallExpr *CE, CheckerContext &C) const;
private:
- mutable std::unique_ptr<BugType> BT_mallocZero;
+ mutable std::unique_ptr<BugType> BT_mallocZero, BT_printNullPtr;
void CheckCallocZero(CheckerContext &C, const CallExpr *CE) const;
void CheckMallocZero(CheckerContext &C, const CallExpr *CE) const;
@@ -73,11 +77,14 @@ class UnixAPIPortabilityChecker : public Checker< check::PreStmt<CallExpr> > {
void CheckAllocaZero(CheckerContext &C, const CallExpr *CE) const;
void CheckAllocaWithAlignZero(CheckerContext &C, const CallExpr *CE) const;
void CheckVallocZero(CheckerContext &C, const CallExpr *CE) const;
+ void CheckPrintNullPtr(CheckerContext &C, const CallExpr *CE) const;
bool ReportZeroByteAllocation(CheckerContext &C,
ProgramStateRef falseState,
const Expr *arg,
const char *fn_name) const;
+ bool ReportPrintNull(CheckerContext &C, ProgramStateRef falseState,
+ const Expr *arg) const;
void BasicAllocationCheck(CheckerContext &C,
const CallExpr *CE,
const unsigned numArgs,
@@ -85,6 +92,21 @@ class UnixAPIPortabilityChecker : public Checker< check::PreStmt<CallExpr> > {
const char *fn) const;
};
+// Collect index of pArg(%p) in format string.
+class PArgFormatStringHandler
+ : public analyze_format_string::FormatStringHandler {
+public:
+ bool HandlePrintfSpecifier(const analyze_printf::PrintfSpecifier &FS,
+ const char *startSpecifier, unsigned specifierLen,
+ const TargetInfo &Target) override;
+
+ const std::vector<size_t> &getPArgIndex() const { return pArgIndex; }
+
+private:
+ std::vector<size_t> pArgIndex;
+ int curIndex = 0;
+};
+
} //end anonymous namespace
static void LazyInitialize(const CheckerBase *Checker,
@@ -455,6 +477,82 @@ void UnixAPIPortabilityChecker::CheckVallocZero(CheckerContext &C,
BasicAllocationCheck(C, CE, 1, 0, "valloc");
}
+bool PArgFormatStringHandler::HandlePrintfSpecifier(
+ const analyze_printf::PrintfSpecifier &FS,
+ const char * /* startSpecifier */, unsigned /* specifierLen */,
+ const TargetInfo & /* Target */) {
+ ++curIndex;
+ if (FS.getConversionSpecifier().getKind() ==
+ clang::analyze_format_string::ConversionSpecifier::Kind::pArg)
+ pArgIndex.push_back(curIndex);
+ return true;
+}
+
+bool UnixAPIPortabilityChecker::ReportPrintNull(CheckerContext &C,
+ ProgramStateRef falseState,
+ const Expr *arg) const {
+ ExplodedNode *N = C.generateErrorNode(falseState);
+ if (N == nullptr)
+ return false;
+ LazyInitialize(
+ this, BT_printNullPtr,
+ "Implementation defined behavior: printf %p with null pointer.");
+ auto report = std::make_unique<PathSensitiveBugReport>(
+ *BT_printNullPtr, "Output null pointer with printf %p", N);
+ report->addRange(arg->getSourceRange());
+ C.emitReport(std::move(report));
+ return true;
+}
+
+void UnixAPIPortabilityChecker::CheckPrintNullPtr(CheckerContext &C,
+ const CallExpr *CE) const {
+ size_t numArgs = CE->getNumArgs();
+ LLVM_DEBUG(llvm::dbgs() << "numArgs: " << numArgs << "\n");
+ if (numArgs < 2)
+ return;
+ PArgFormatStringHandler handler;
+ CE->getArg(0)->dump();
+ const CastExpr *castExpr = dyn_cast<const CastExpr>(CE->getArg(0));
+ if (castExpr == nullptr) {
+ LLVM_DEBUG(llvm::dbgs() << "First arg of printf is not cast expr.\n");
+ return;
+ }
+ const StringLiteral *stringLiteralExpr =
+ dyn_cast<const StringLiteral>(castExpr->getSubExpr());
+ if (stringLiteralExpr == nullptr) {
+ LLVM_DEBUG(llvm::dbgs() << "First arg of printf is not string literal.\n");
+ return;
+ }
+ StringRef formatString = stringLiteralExpr->getString();
+ ParsePrintfString(handler, formatString.begin(), formatString.end(),
+ C.getLangOpts(), C.getASTContext().getTargetInfo(),
+ /* isFreeBSDKPrintf */ false);
+
+ const std::vector<size_t> &pArgIndex = handler.getPArgIndex();
+ ProgramStateRef state = C.getState();
+ LLVM_DEBUG(llvm::dbgs() << "pArgIndex size: " << pArgIndex.size() << "\n");
+ LLVM_DEBUG(
+ for (size_t id
+ : pArgIndex) { llvm::dbgs() << "pArgIndex: " << id << "\n"; });
+ for (size_t id : pArgIndex) {
+ if (id >= numArgs)
+ break;
+ const Expr *arg = CE->getArg(id);
+ const SVal argVal = C.getSVal(arg);
+ if (argVal.isUnknownOrUndef()) {
+ continue;
+ }
+ ProgramStateRef trueState, falseState;
+ std::tie(trueState, falseState) =
+ state->assume(argVal.castAs<DefinedSVal>());
+ // Report bug if pointer is always null.
+ if (!trueState && falseState) {
+ if (ReportPrintNull(C, falseState, arg))
+ break;
+ }
+ }
+}
+
void UnixAPIPortabilityChecker::checkPreStmt(const CallExpr *CE,
CheckerContext &C) const {
const FunctionDecl *FD = C.getCalleeDecl(CE);
@@ -491,6 +589,9 @@ void UnixAPIPortabilityChecker::checkPreStmt(const CallExpr *CE,
else if (FName == "valloc")
CheckVallocZero(C, CE);
+
+ else if (FName == "printf")
+ CheckPrintNullPtr(C, CE);
}
//===----------------------------------------------------------------------===//
diff --git a/clang/test/Analysis/Checkers/portability.cpp b/clang/test/Analysis/Checkers/portability.cpp
new file mode 100644
index 00000000000000..e6265a252eefd3
--- /dev/null
+++ b/clang/test/Analysis/Checkers/portability.cpp
@@ -0,0 +1,23 @@
+// RUN: %clang_analyze_cc1 -analyzer-checker=optin.portability -verify %s
+
+extern int printf(const char *, ...);
+
+void print_null_ptr() {
+ int x = 0;
+ printf("ppppp%dppppp", x); // no warning
+
+ int* p = &x;
+ printf("dddd%pddddd", p); // no warning
+
+ p = nullptr;
+ printf("dddddd%pdddddd", p); // expected-warning{{Output null pointer with printf %p}}
+}
+
+void test2() {
+ int x = 0;
+ void* p = &x;
+ printf("%d %p", x, p); // no warning
+
+ p = nullptr;
+ printf("%d %p", x, p); // expected-warning{{Output null pointer with printf %p}}
+}
|
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.
Resolve #43453