26 #include "llvm/ADT/SmallVector.h" 27 #include "llvm/Support/Casting.h" 28 #include "llvm/Support/ErrorHandling.h" 32 using namespace clang;
36 return !StmtCheckers.empty() ||
37 !PreObjCMessageCheckers.empty() ||
38 !PostObjCMessageCheckers.empty() ||
39 !PreCallCheckers.empty() ||
40 !PostCallCheckers.empty() ||
41 !LocationCheckers.empty() ||
42 !BindCheckers.empty() ||
43 !EndAnalysisCheckers.empty() ||
44 !EndFunctionCheckers.empty() ||
45 !BranchConditionCheckers.empty() ||
46 !LiveSymbolsCheckers.empty() ||
47 !DeadSymbolsCheckers.empty() ||
48 !RegionChangesCheckers.empty() ||
49 !EvalAssumeCheckers.empty() ||
50 !EvalCallCheckers.empty();
57 for (
const auto &Event : Events)
58 assert(Event.second.HasDispatcher &&
59 "No dispatcher registered for an event");
64 const CheckerBase *C, StringRef OptionName, StringRef ExpectedValueDesc) {
67 .
Report(diag::err_analyzer_checker_option_invalid_input)
80 unsigned DeclKind = D->
getKind();
82 CachedDeclCheckersMapTy::iterator CCI = CachedDeclCheckersMap.find(DeclKind);
83 if (CCI != CachedDeclCheckersMap.end()) {
84 checkers = &(CCI->second);
87 checkers = &CachedDeclCheckersMap[DeclKind];
88 for (
const auto &info : DeclCheckers)
89 if (info.IsForDeclFn(D))
90 checkers->push_back(info.CheckFn);
94 for (
const auto checker : *checkers)
102 for (
const auto BodyChecker : BodyCheckers)
103 BodyChecker(D, mgr, BR);
110 template <
typename CHECK_CTX>
112 ExplodedNodeSet &Dst,
113 const ExplodedNodeSet &Src) {
114 const NodeBuilderContext &BldrCtx = checkCtx.Eng.getBuilderContext();
118 typename CHECK_CTX::CheckersTy::const_iterator
119 I = checkCtx.checkers_begin(), E = checkCtx.checkers_end();
125 ExplodedNodeSet Tmp1, Tmp2;
126 const ExplodedNodeSet *PrevSet = &Src;
128 for (; I != E; ++I) {
129 ExplodedNodeSet *CurrSet =
nullptr;
133 CurrSet = (PrevSet == &Tmp1) ? &Tmp2 : &Tmp1;
137 NodeBuilder B(*PrevSet, *CurrSet, BldrCtx);
138 for (
const auto &NI : *PrevSet)
139 checkCtx.runChecker(*I, B, NI);
142 if (CurrSet->empty())
152 struct CheckStmtContext {
156 const CheckersTy &Checkers;
161 CheckStmtContext(
bool isPreVisit,
const CheckersTy &checkers,
162 const Stmt *s, ExprEngine &eng,
bool wasInlined =
false)
163 : IsPreVisit(isPreVisit), Checkers(checkers), S(s), Eng(eng),
164 WasInlined(wasInlined) {}
166 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
167 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
170 NodeBuilder &Bldr, ExplodedNode *Pred) {
175 Pred->getLocationContext(), checkFn.Checker);
176 CheckerContext C(Bldr, Eng, Pred, L, WasInlined);
190 CheckStmtContext C(isPreVisit, getCachedStmtCheckersFor(S, isPreVisit),
197 struct CheckObjCMessageContext {
198 using CheckersTy = std::vector<CheckerManager::CheckObjCMessageFunc>;
202 const CheckersTy &Checkers;
207 const CheckersTy &checkers,
210 :
Kind(visitKind), WasInlined(wasInlined), Checkers(checkers), Msg(msg),
213 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
214 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
230 const ProgramPoint &L = Msg.getProgramPoint(IsPreVisit,checkFn.Checker);
246 auto &checkers = getObjCMessageCheckers(visitKind);
247 CheckObjCMessageContext C(visitKind, checkers, msg, Eng, WasInlined);
251 const std::vector<CheckerManager::CheckObjCMessageFunc> &
255 return PreObjCMessageCheckers;
258 return PostObjCMessageCheckers;
260 return ObjCMessageNilCheckers;
262 llvm_unreachable(
"Unknown Kind");
269 struct CheckCallContext {
270 using CheckersTy = std::vector<CheckerManager::CheckCallFunc>;
272 bool IsPreVisit, WasInlined;
273 const CheckersTy &Checkers;
277 CheckCallContext(
bool isPreVisit,
const CheckersTy &checkers,
280 : IsPreVisit(isPreVisit), WasInlined(wasInlined), Checkers(checkers),
281 Call(call), Eng(eng) {}
283 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
284 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
304 CheckCallContext C(isPreVisit,
305 isPreVisit ? PreCallCheckers
307 Call, Eng, WasInlined);
313 struct CheckLocationContext {
314 using CheckersTy = std::vector<CheckerManager::CheckLocationFunc>;
316 const CheckersTy &Checkers;
323 CheckLocationContext(
const CheckersTy &checkers,
324 SVal loc,
bool isLoad,
const Stmt *NodeEx,
327 : Checkers(checkers), Loc(loc), IsLoad(isLoad), NodeEx(NodeEx),
328 BoundEx(BoundEx), Eng(eng) {}
330 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
331 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
342 checkFn(Loc, IsLoad, BoundEx, C);
352 SVal location,
bool isLoad,
356 CheckLocationContext C(LocationCheckers, location, isLoad, NodeEx,
363 struct CheckBindContext {
364 using CheckersTy = std::vector<CheckerManager::CheckBindFunc>;
366 const CheckersTy &Checkers;
373 CheckBindContext(
const CheckersTy &checkers,
376 : Checkers(checkers), Loc(loc), Val(val), S(s), Eng(eng), PP(pp) {}
378 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
379 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
386 checkFn(Loc, Val, S, C);
398 CheckBindContext C(BindCheckers, location, val, S, Eng, PP);
405 for (
const auto EndAnalysisChecker : EndAnalysisCheckers)
406 EndAnalysisChecker(G, BR, Eng);
411 struct CheckBeginFunctionContext {
412 using CheckersTy = std::vector<CheckerManager::CheckBeginFunctionFunc>;
414 const CheckersTy &Checkers;
418 CheckBeginFunctionContext(
const CheckersTy &Checkers,
ExprEngine &Eng,
420 : Checkers(Checkers), Eng(Eng), PP(PP) {}
422 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
423 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
442 CheckBeginFunctionContext C(BeginFunctionCheckers, Eng, L);
458 for (
const auto checkFn : EndFunctionCheckers) {
468 struct CheckBranchConditionContext {
469 using CheckersTy = std::vector<CheckerManager::CheckBranchConditionFunc>;
471 const CheckersTy &Checkers;
472 const Stmt *Condition;
475 CheckBranchConditionContext(
const CheckersTy &checkers,
477 : Checkers(checkers), Condition(Cond), Eng(eng) {}
479 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
480 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
487 checkFn(Condition, C);
500 CheckBranchConditionContext C(BranchConditionCheckers, Condition, Eng);
506 struct CheckNewAllocatorContext {
507 using CheckersTy = std::vector<CheckerManager::CheckNewAllocatorFunc>;
509 const CheckersTy &Checkers;
515 CheckNewAllocatorContext(
const CheckersTy &Checkers,
const CXXNewExpr *NE,
517 : Checkers(Checkers),
NE(NE), Target(Target), WasInlined(WasInlined),
520 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
521 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
527 checkFn(NE, Target, C);
538 CheckNewAllocatorContext C(NewAllocatorCheckers, NE, Target, WasInlined, Eng);
545 for (
const auto LiveSymbolsChecker : LiveSymbolsCheckers)
546 LiveSymbolsChecker(state, SymReaper);
551 struct CheckDeadSymbolsContext {
552 using CheckersTy = std::vector<CheckerManager::CheckDeadSymbolsFunc>;
554 const CheckersTy &Checkers;
560 CheckDeadSymbolsContext(
const CheckersTy &checkers,
SymbolReaper &sr,
563 : Checkers(checkers), SR(sr), S(s), Eng(eng), ProgarmPointKind(K) {}
565 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
566 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
590 CheckDeadSymbolsContext C(DeadSymbolsCheckers, SymReaper, S, Eng, K);
602 for (
const auto RegionChangesChecker : RegionChangesCheckers) {
607 state = RegionChangesChecker(state, invalidated, ExplicitRegions, Regions,
620 assert((Call !=
nullptr ||
623 "Call must not be NULL when escaping on call");
624 for (
const auto PointerEscapeChecker : PointerEscapeCheckers) {
629 State = PointerEscapeChecker(State, Escaped, Call, Kind, ETraits);
637 SVal Cond,
bool Assumption) {
638 for (
const auto EvalAssumeChecker : EvalAssumeCheckers) {
643 state = EvalAssumeChecker(state, Cond, Assumption);
654 for (
const auto Pred : Src) {
655 bool anyEvaluated =
false;
661 for (
const auto EvalCallChecker : EvalCallCheckers) {
667 Pred->getLocationContext(),
668 EvalCallChecker.Checker);
669 bool evaluated =
false;
674 evaluated = EvalCallChecker(Call, C);
676 assert(!(evaluated && anyEvaluated)
677 &&
"There are more than one checkers evaluating the call");
700 for (
const auto EndOfTranslationUnitChecker : EndOfTranslationUnitCheckers)
701 EndOfTranslationUnitChecker(TU, mgr, BR);
709 Indent(Out, Space, IsDot) <<
"\"checker_messages\": ";
713 llvm::raw_svector_ostream TempOut(TempBuf);
714 unsigned int InnerSpace = Space + 2;
718 llvm::raw_svector_ostream NLOut(NewLine);
719 NLOut <<
"\", " << NL;
720 Indent(NLOut, InnerSpace, IsDot) <<
"\"";
723 bool HasMessage =
false;
726 const void *LastCT =
nullptr;
727 for (
const auto &CT : CheckerTags) {
729 CT.second->printState(TempOut, State, NewLine.c_str(),
"");
743 for (
const auto &CT : CheckerTags) {
745 CT.second->printState(TempOut, State, NewLine.c_str(),
"");
751 <<
"{ \"checker\": \"" << CT.second->getCheckerName().getName()
752 <<
"\", \"messages\": [" << NL;
753 Indent(Out, InnerSpace, IsDot)
754 <<
'\"' << TempBuf.str().trim() <<
'\"' << NL;
755 Indent(Out, Space, IsDot) <<
"]}";
766 Indent(Out, --Space, IsDot) <<
"]";
779 DeclCheckerInfo info = { checkfn, isForDeclFn };
780 DeclCheckers.push_back(info);
784 BodyCheckers.push_back(checkfn);
793 StmtCheckerInfo info = { checkfn, isForStmtFn,
true };
794 StmtCheckers.push_back(info);
799 StmtCheckerInfo info = { checkfn, isForStmtFn,
false };
800 StmtCheckers.push_back(info);
804 PreObjCMessageCheckers.push_back(checkfn);
808 ObjCMessageNilCheckers.push_back(checkfn);
812 PostObjCMessageCheckers.push_back(checkfn);
816 PreCallCheckers.push_back(checkfn);
819 PostCallCheckers.push_back(checkfn);
823 LocationCheckers.push_back(checkfn);
827 BindCheckers.push_back(checkfn);
831 EndAnalysisCheckers.push_back(checkfn);
835 BeginFunctionCheckers.push_back(checkfn);
839 EndFunctionCheckers.push_back(checkfn);
844 BranchConditionCheckers.push_back(checkfn);
848 NewAllocatorCheckers.push_back(checkfn);
852 LiveSymbolsCheckers.push_back(checkfn);
856 DeadSymbolsCheckers.push_back(checkfn);
860 RegionChangesCheckers.push_back(checkfn);
864 PointerEscapeCheckers.push_back(checkfn);
869 PointerEscapeCheckers.push_back(checkfn);
873 EvalAssumeCheckers.push_back(checkfn);
877 EvalCallCheckers.push_back(checkfn);
882 EndOfTranslationUnitCheckers.push_back(checkfn);
890 CheckerManager::getCachedStmtCheckersFor(
const Stmt *S,
bool isPreVisit) {
893 unsigned Key = (S->
getStmtClass() << 1) |
unsigned(isPreVisit);
894 CachedStmtCheckersMapTy::iterator CCI = CachedStmtCheckersMap.find(Key);
895 if (CCI != CachedStmtCheckersMap.end())
900 for (
const auto &Info : StmtCheckers)
901 if (Info.IsPreVisit == isPreVisit && Info.IsForStmtFn(S))
902 Checkers.push_back(Info.CheckFn);
CallEventRef< T > cloneWithState(ProgramStateRef NewState) const
Returns a copy of this CallEvent, but using the given state.
void _registerForDeadSymbols(CheckDeadSymbolsFunc checkfn)
Stmt - This represents one statement.
Information about invalidation for a particular region/symbol.
ProgramPoint getProgramPoint(bool IsPreVisit=false, const ProgramPointTag *Tag=nullptr) const
Returns an appropriate ProgramPoint for this call.
static void expandGraphWithCheckers(CHECK_CTX checkCtx, ExplodedNodeSet &Dst, const ExplodedNodeSet &Src)
Decl - This represents one declaration (or definition), e.g.
ProgramPoint withTag(const ProgramPointTag *tag) const
Create a new ProgramPoint object that is the same as the original except for using the specified tag ...
The pointer has been passed to a function indirectly.
DiagnosticsEngine & getDiagnostics() const
DiagnosticBuilder Report(SourceLocation Loc, unsigned DiagID)
Issue the message to the client.
void runCheckersForPrintStateJson(raw_ostream &Out, ProgramStateRef State, const char *NL="\, unsigned int Space=0, bool IsDot=false) const
Run checkers for debug-printing a ProgramState.
const ProgramStateRef & getState() const
const Expr * getOriginExpr() const
Returns the expression whose value will be the result of this call.
void _registerForRegionChanges(CheckRegionChangesFunc checkfn)
for(auto typeArg :T->getTypeArgsAsWritten())
void _registerForObjCMessageNil(CheckObjCMessageFunc checkfn)
void finishedCheckerRegistration()
const NodeBuilderContext & getBuilderContext()
void runCheckersForLocation(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, SVal location, bool isLoad, const Stmt *NodeEx, const Stmt *BoundEx, ExprEngine &Eng)
Run checkers for load/store of a location.
static ProgramPoint getProgramPoint(const Stmt *S, ProgramPoint::Kind K, const LocationContext *LC, const ProgramPointTag *tag)
ProgramStateRef runCheckersForPointerEscape(ProgramStateRef State, const InvalidatedSymbols &Escaped, const CallEvent *Call, PointerEscapeKind Kind, RegionAndSymbolInvalidationTraits *ITraits)
Run checkers when pointers escape.
void _registerForPreCall(CheckCallFunc checkfn)
void runCheckersForLiveSymbols(ProgramStateRef state, SymbolReaper &SymReaper)
Run checkers for live symbols.
i32 captured_struct **param SharedsTy A type which contains references the shared variables *param Shareds Context with the list of shared variables from the p *TaskFunction *param Data Additional data for task generation like final * state
void _registerForEndOfTranslationUnit(CheckEndOfTranslationUnit checkfn)
Represents any expression that calls an Objective-C method.
bool(*)(const Stmt *D) HandlesStmtFunc
StringRef getTagDescription() const override
Forward-declares and imports various common LLVM datatypes that clang wants to use unqualified...
const LocationContext * getLocationContext() const
void _registerForLiveSymbols(CheckLiveSymbolsFunc checkfn)
void runCheckersOnASTDecl(const Decl *D, AnalysisManager &mgr, BugReporter &BR)
Run checkers handling Decls.
void runCheckersForEndFunction(NodeBuilderContext &BC, ExplodedNodeSet &Dst, ExplodedNode *Pred, ExprEngine &Eng, const ReturnStmt *RS)
Run checkers on end of function.
void runCheckersForBind(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, SVal location, SVal val, const Stmt *S, ExprEngine &Eng, const ProgramPoint &PP)
Run checkers for binding of a value to a location.
void _registerForBody(CheckDeclFunc checkfn)
This is the simplest builder which generates nodes in the ExplodedGraph.
void _registerForEndAnalysis(CheckEndAnalysisFunc checkfn)
void _registerForLocation(CheckLocationFunc checkfn)
The pointer has been passed to a function call directly.
void reportInvalidCheckerOptionValue(const CheckerBase *C, StringRef OptionName, StringRef ExpectedValueDesc)
Emits an error through a DiagnosticsEngine about an invalid user supplied checker option value...
void _registerForPointerEscape(CheckPointerEscapeFunc checkfn)
void runCheckersForEvalCall(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &CE, ExprEngine &Eng)
Run checkers for evaluating a call.
ReturnStmt - This represents a return, optionally of an expression: return; return 4;...
void _registerForPostCall(CheckCallFunc checkfn)
virtual bool hasBody() const
Returns true if this Decl represents a declaration for a body of code, such as a function or method d...
BugReporter is a utility class for generating PathDiagnostics for analysis.
void runCheckersForNewAllocator(const CXXNewExpr *NE, SVal Target, ExplodedNodeSet &Dst, ExplodedNode *Pred, ExprEngine &Eng, bool wasInlined=false)
Run checkers between C++ operator new and constructor calls.
void _registerForPreObjCMessage(CheckObjCMessageFunc checkfn)
void runCheckersForBranchCondition(const Stmt *condition, ExplodedNodeSet &Dst, ExplodedNode *Pred, ExprEngine &Eng)
Run checkers for branch condition.
Represents a new-expression for memory allocation and constructor calls, e.g: "new CXXNewExpr(foo)"...
SVal - This represents a symbolic expression, which can be either an L-value or an R-value...
void _registerForBranchCondition(CheckBranchConditionFunc checkfn)
ProgramStateRef runCheckersForEvalAssume(ProgramStateRef state, SVal Cond, bool Assumption)
Run checkers for handling assumptions on symbolic values.
void runCheckersForObjCMessage(ObjCMessageVisitKind visitKind, ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const ObjCMethodCall &msg, ExprEngine &Eng, bool wasInlined=false)
Run checkers for visiting obj-c messages.
A class responsible for cleaning up unused symbols.
void runCheckersOnASTBody(const Decl *D, AnalysisManager &mgr, BugReporter &BR)
Run checkers handling Decls containing a Stmt body.
CheckerFn< void(const Stmt *, CheckerContext &)> CheckStmtFunc
void insert(const ExplodedNodeSet &S)
void runCheckersForDeadSymbols(ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, SymbolReaper &SymReaper, const Stmt *S, ExprEngine &Eng, ProgramPoint::Kind K)
Run checkers for dead symbols.
Dataflow Directional Tag Classes.
bool NE(InterpState &S, CodePtr OpPC)
StmtClass getStmtClass() const
void runCheckersForStmt(bool isPreVisit, ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const Stmt *S, ExprEngine &Eng, bool wasInlined=false)
Run checkers for visiting Stmts.
void _registerForDecl(CheckDeclFunc checkfn, HandlesDeclFunc isForDeclFn)
void _registerForPostObjCMessage(CheckObjCMessageFunc checkfn)
Represents an abstract call to a function or method along a particular path.
void _registerForEndFunction(CheckEndFunctionFunc checkfn)
void _registerForEvalAssume(EvalAssumeFunc checkfn)
void _registerForPostStmt(CheckStmtFunc checkfn, HandlesStmtFunc isForStmtFn)
PointerEscapeKind
Describes the different reasons a pointer escapes during analysis.
void defaultEvalCall(NodeBuilder &B, ExplodedNode *Pred, const CallEvent &Call, const EvalCallOptions &CallOpts={})
Default implementation of call evaluation.
void _registerForNewAllocator(CheckNewAllocatorFunc checkfn)
void runCheckersForCallEvent(bool isPreVisit, ExplodedNodeSet &Dst, const ExplodedNodeSet &Src, const CallEvent &Call, ExprEngine &Eng, bool wasInlined=false)
Run checkers for visiting obj-c messages.
void runCheckersForEndAnalysis(ExplodedGraph &G, BugReporter &BR, ExprEngine &Eng)
Run checkers for end of analysis.
void _registerForBeginFunction(CheckBeginFunctionFunc checkfn)
void _registerForEvalCall(EvalCallFunc checkfn)
CheckerFn< void()> CheckerDtor
bool(*)(const Decl *D) HandlesDeclFunc
bool hasPathSensitiveCheckers() const
ProgramStateRef runCheckersForRegionChanges(ProgramStateRef state, const InvalidatedSymbols *invalidated, ArrayRef< const MemRegion *> ExplicitRegions, ArrayRef< const MemRegion *> Regions, const LocationContext *LCtx, const CallEvent *Call)
Run checkers for region changes.
void runCheckersForBeginFunction(ExplodedNodeSet &Dst, const BlockEdge &L, ExplodedNode *Pred, ExprEngine &Eng)
Run checkers on beginning of function.
The top declaration context.
raw_ostream & Indent(raw_ostream &Out, const unsigned int Space, bool IsDot)
void _registerForConstPointerEscape(CheckPointerEscapeFunc checkfn)
void runCheckersOnEndOfTranslationUnit(const TranslationUnitDecl *TU, AnalysisManager &mgr, BugReporter &BR)
Run checkers for the entire Translation Unit.
void _registerForPreStmt(CheckStmtFunc checkfn, HandlesStmtFunc isForStmtFn)
void _registerForBind(CheckBindFunc checkfn)