From ff4492c89feb54e6ddfd6edaea59c98776963208 Mon Sep 17 00:00:00 2001 From: Gabor Marton Date: Tue, 14 Apr 2020 17:40:42 +0200 Subject: [PATCH] [analyzer] StdLibraryFunctionsChecker: Add option to display loaded summaries Reviewers: NoQ, Szelethus, baloghadamsoftware, balazske Subscribers: whisperity, xazax.hun, szepet, rnkovacs, a.sidorin, mikhail.ramalho, donat.nagy, dkrupp, gamesh411, Charusso, steakhal, ASDenysPetrov, cfe-commits Tags: #clang Differential Revision: https://reviews.llvm.org/D78118 --- .../clang/StaticAnalyzer/Checkers/Checkers.td | 8 ++++++ .../Checkers/StdLibraryFunctionsChecker.cpp | 22 +++++++++++++--- clang/test/Analysis/analyzer-config.c | 3 ++- clang/test/Analysis/std-c-library-functions.c | 29 ++++++++++++++++++++++ 4 files changed, 57 insertions(+), 5 deletions(-) diff --git a/clang/include/clang/StaticAnalyzer/Checkers/Checkers.td b/clang/include/clang/StaticAnalyzer/Checkers/Checkers.td index b4caaa0..5cf32ac 100644 --- a/clang/include/clang/StaticAnalyzer/Checkers/Checkers.td +++ b/clang/include/clang/StaticAnalyzer/Checkers/Checkers.td @@ -294,6 +294,14 @@ let ParentPackage = APIModeling in { def StdCLibraryFunctionsChecker : Checker<"StdCLibraryFunctions">, HelpText<"Improve modeling of the C standard library functions">, Dependencies<[NonNullParamChecker, CallAndMessageChecker]>, + CheckerOptions<[ + CmdLineOption + ]>, Documentation; def StdCLibraryFunctionArgsChecker : Checker<"StdCLibraryFunctionArgs">, diff --git a/clang/lib/StaticAnalyzer/Checkers/StdLibraryFunctionsChecker.cpp b/clang/lib/StaticAnalyzer/Checkers/StdLibraryFunctionsChecker.cpp index b9719a0..b8d52f0 100644 --- a/clang/lib/StaticAnalyzer/Checkers/StdLibraryFunctionsChecker.cpp +++ b/clang/lib/StaticAnalyzer/Checkers/StdLibraryFunctionsChecker.cpp @@ -300,6 +300,8 @@ public: DefaultBool ChecksEnabled[CK_NumCheckKinds]; CheckerNameRef CheckNames[CK_NumCheckKinds]; + bool DisplayLoadedSummaries = false; + private: Optional findFunctionSummary(const FunctionDecl *FD, CheckerContext &C) const; @@ -639,8 +641,12 @@ void StdLibraryFunctionsChecker::initFunctionSummaries( struct AddToFunctionSummaryMap { const ASTContext &ACtx; FunctionSummaryMapType ⤅ - AddToFunctionSummaryMap(const ASTContext &ACtx, FunctionSummaryMapType &FSM) - : ACtx(ACtx), Map(FSM) {} + bool DisplayLoadedSummaries; + AddToFunctionSummaryMap(const ASTContext &ACtx, FunctionSummaryMapType &FSM, + bool DisplayLoadedSummaries) + : ACtx(ACtx), Map(FSM), DisplayLoadedSummaries(DisplayLoadedSummaries) { + } + // Add a summary to a FunctionDecl found by lookup. The lookup is performed // by the given Name, and in the global scope. The summary will be attached // to the found FunctionDecl only if the signatures match. @@ -655,6 +661,11 @@ void StdLibraryFunctionsChecker::initFunctionSummaries( auto Res = Map.insert({FD->getCanonicalDecl(), S}); assert(Res.second && "Function already has a summary set!"); (void)Res; + if (DisplayLoadedSummaries) { + llvm::errs() << "Loaded summary for: "; + FD->print(llvm::errs()); + llvm::errs() << "\n"; + } return; } } @@ -665,7 +676,7 @@ void StdLibraryFunctionsChecker::initFunctionSummaries( for (const Summary &S : Summaries) operator()(Name, S); } - } addToFunctionSummaryMap(ACtx, FunctionSummaryMap); + } addToFunctionSummaryMap(ACtx, FunctionSummaryMap, DisplayLoadedSummaries); // We are finally ready to define specifications for all supported functions. // @@ -937,7 +948,10 @@ void StdLibraryFunctionsChecker::initFunctionSummaries( } void ento::registerStdCLibraryFunctionsChecker(CheckerManager &mgr) { - mgr.registerChecker(); + auto *Checker = mgr.registerChecker(); + Checker->DisplayLoadedSummaries = + mgr.getAnalyzerOptions().getCheckerBooleanOption( + Checker, "DisplayLoadedSummaries"); } bool ento::shouldRegisterStdCLibraryFunctionsChecker(const CheckerManager &mgr) { diff --git a/clang/test/Analysis/analyzer-config.c b/clang/test/Analysis/analyzer-config.c index 226c020..b94f618 100644 --- a/clang/test/Analysis/analyzer-config.c +++ b/clang/test/Analysis/analyzer-config.c @@ -11,6 +11,7 @@ // CHECK-NEXT: alpha.security.MmapWriteExec:MmapProtExec = 0x04 // CHECK-NEXT: alpha.security.MmapWriteExec:MmapProtRead = 0x01 // CHECK-NEXT: alpha.security.taint.TaintPropagation:Config = "" +// CHECK-NEXT: apiModeling.StdCLibraryFunctions:DisplayLoadedSummaries = false // CHECK-NEXT: apply-fixits = false // CHECK-NEXT: avoid-suppressing-null-argument-paths = false // CHECK-NEXT: c++-allocator-inlining = true @@ -106,4 +107,4 @@ // CHECK-NEXT: unroll-loops = false // CHECK-NEXT: widen-loops = false // CHECK-NEXT: [stats] -// CHECK-NEXT: num-entries = 103 +// CHECK-NEXT: num-entries = 104 diff --git a/clang/test/Analysis/std-c-library-functions.c b/clang/test/Analysis/std-c-library-functions.c index 7c32a57..c4762d7 100644 --- a/clang/test/Analysis/std-c-library-functions.c +++ b/clang/test/Analysis/std-c-library-functions.c @@ -30,6 +30,35 @@ // RUN: -triple thumbv7-a15-linux \ // RUN: -verify +// RUN: %clang_analyze_cc1 %s \ +// RUN: -analyzer-checker=core \ +// RUN: -analyzer-checker=apiModeling.StdCLibraryFunctions \ +// RUN: -analyzer-config apiModeling.StdCLibraryFunctions:DisplayLoadedSummaries=true \ +// RUN: -analyzer-checker=debug.ExprInspection \ +// RUN: -analyzer-config eagerly-assume=false \ +// RUN: -triple i686-unknown-linux 2>&1 | FileCheck %s + +// CHECK: Loaded summary for: int isalnum(int) +// CHECK-NEXT: Loaded summary for: int isalpha(int) +// CHECK-NEXT: Loaded summary for: int isascii(int) +// CHECK-NEXT: Loaded summary for: int isblank(int) +// CHECK-NEXT: Loaded summary for: int isdigit(int) +// CHECK-NEXT: Loaded summary for: int isgraph(int) +// CHECK-NEXT: Loaded summary for: int islower(int) +// CHECK-NEXT: Loaded summary for: int isprint(int) +// CHECK-NEXT: Loaded summary for: int ispunct(int) +// CHECK-NEXT: Loaded summary for: int isspace(int) +// CHECK-NEXT: Loaded summary for: int isupper(int) +// CHECK-NEXT: Loaded summary for: int isxdigit(int) +// CHECK-NEXT: Loaded summary for: int getc(FILE *) +// CHECK-NEXT: Loaded summary for: int fgetc(FILE *) +// CHECK-NEXT: Loaded summary for: int getchar() +// CHECK-NEXT: Loaded summary for: ssize_t read(int, void *, size_t) +// CHECK-NEXT: Loaded summary for: ssize_t write(int, const void *, size_t) +// CHECK-NEXT: Loaded summary for: unsigned int fread(void *restrict, size_t, size_t, FILE *) +// CHECK-NEXT: Loaded summary for: unsigned int fwrite(const void *restrict, size_t, size_t, FILE *restrict) +// CHECK-NEXT: Loaded summary for: ssize_t getline(char **, size_t *, FILE *) + void clang_analyzer_eval(int); int glob; -- 2.7.4