26 #include "llvm/ADT/SmallVector.h"
27 #include "llvm/Support/Casting.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/FormatVariadic.h"
33 using namespace clang;
37 const auto IfAnyAreNonEmpty = [](
const auto &... Callbacks) ->
bool {
40 LLVM_ATTRIBUTE_UNUSED
int Unused[]{0, (Result |= !Callbacks.empty())...};
43 return IfAnyAreNonEmpty(
44 StmtCheckers, PreObjCMessageCheckers, ObjCMessageNilCheckers,
45 PostObjCMessageCheckers, PreCallCheckers, PostCallCheckers,
46 LocationCheckers, BindCheckers, EndAnalysisCheckers,
47 BeginFunctionCheckers, EndFunctionCheckers, BranchConditionCheckers,
48 NewAllocatorCheckers, LiveSymbolsCheckers, DeadSymbolsCheckers,
49 RegionChangesCheckers, PointerEscapeCheckers, EvalAssumeCheckers,
50 EvalCallCheckers, EndOfTranslationUnitCheckers);
57 for (
const auto &Event : Events)
58 assert(Event.second.HasDispatcher &&
59 "No dispatcher registered for an event");
65 StringRef ExpectedValueDesc)
const {
68 << (llvm::Twine() + C->getTagDescription() +
":" + OptionName).str()
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(); }
217 NodeBuilder &Bldr, ExplodedNode *Pred) {
231 CheckerContext
C(Bldr, Eng, Pred, L, WasInlined);
233 checkFn(*Msg.
cloneWithState<ObjCMethodCall>(Pred->getState()), C);
246 const 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;
274 const CallEvent &Call;
277 CheckCallContext(
bool isPreVisit,
const CheckersTy &checkers,
278 const CallEvent &call, ExprEngine &eng,
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(); }
287 NodeBuilder &Bldr, ExplodedNode *Pred) {
289 CheckerContext
C(Bldr, Eng, Pred, L, WasInlined);
291 checkFn(*
Call.cloneWithState(Pred->getState()), C);
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(); }
334 NodeBuilder &Bldr, ExplodedNode *Pred) {
339 Pred->getLocationContext(),
341 CheckerContext
C(Bldr, Eng, Pred, L);
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(); }
382 NodeBuilder &Bldr, ExplodedNode *Pred) {
384 CheckerContext
C(Bldr, Eng, Pred, L);
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(); }
426 NodeBuilder &Bldr, ExplodedNode *Pred) {
428 CheckerContext
C(Bldr, Eng, Pred, L);
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;
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(); }
483 NodeBuilder &Bldr, ExplodedNode *Pred) {
486 CheckerContext
C(Bldr, Eng, Pred, L);
487 checkFn(Condition, C);
500 CheckBranchConditionContext C(BranchConditionCheckers,
Condition, Eng);
506 struct CheckNewAllocatorContext {
507 using CheckersTy = std::vector<CheckerManager::CheckNewAllocatorFunc>;
509 const CheckersTy &Checkers;
514 CheckNewAllocatorContext(
const CheckersTy &Checkers,
517 : Checkers(Checkers), Call(Call), WasInlined(WasInlined), Eng(Eng) {}
519 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
520 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
523 NodeBuilder &Bldr, ExplodedNode *Pred) {
526 CheckerContext
C(Bldr, Eng, Pred, L, WasInlined);
527 checkFn(cast<CXXAllocatorCall>(*
Call.cloneWithState(Pred->getState())),
541 CheckNewAllocatorContext C(NewAllocatorCheckers, Call, WasInlined, Eng);
548 for (
const auto &LiveSymbolsChecker : LiveSymbolsCheckers)
549 LiveSymbolsChecker(
state, SymReaper);
554 struct CheckDeadSymbolsContext {
555 using CheckersTy = std::vector<CheckerManager::CheckDeadSymbolsFunc>;
557 const CheckersTy &Checkers;
563 CheckDeadSymbolsContext(
const CheckersTy &checkers,
SymbolReaper &sr,
566 : Checkers(checkers), SR(sr), S(
s), Eng(eng), ProgarmPointKind(K) {}
568 CheckersTy::const_iterator checkers_begin() {
return Checkers.begin(); }
569 CheckersTy::const_iterator checkers_end() {
return Checkers.end(); }
572 NodeBuilder &Bldr, ExplodedNode *Pred) {
574 Pred->getLocationContext(), checkFn.Checker);
575 CheckerContext
C(Bldr, Eng, Pred, L);
593 CheckDeadSymbolsContext C(DeadSymbolsCheckers, SymReaper, S, Eng, K);
605 for (
const auto &RegionChangesChecker : RegionChangesCheckers) {
610 state = RegionChangesChecker(
state, invalidated, ExplicitRegions, Regions,
623 assert((Call !=
nullptr ||
626 "Call must not be NULL when escaping on call");
627 for (
const auto &PointerEscapeChecker : PointerEscapeCheckers) {
632 State = PointerEscapeChecker(
State, Escaped, Call,
Kind, ETraits);
640 SVal Cond,
bool Assumption) {
641 for (
const auto &EvalAssumeChecker : EvalAssumeCheckers) {
646 state = EvalAssumeChecker(
state, Cond, Assumption);
658 for (
auto *
const Pred : Src) {
665 for (
const auto &EvalCallChecker : EvalCallCheckers) {
670 Pred->getLocationContext(), EvalCallChecker.Checker);
671 bool evaluated =
false;
676 evaluated = EvalCallChecker(Call, C);
679 if (evaluated && evaluatorChecker) {
682 llvm::raw_string_ostream
OS(Buf);
688 "The '{0}' call has been already evaluated by the {1} checker, "
689 "while the {2} checker also tried to evaluate the same call. At "
690 "most one checker supposed to evaluate a call.",
691 toString(Call), evaluatorChecker->getName(),
692 EvalCallChecker.Checker->getCheckerName());
693 llvm_unreachable(AssertionMessage.c_str());
697 evaluatorChecker = EvalCallChecker.Checker->getCheckerName();
706 if (!evaluatorChecker) {
718 for (
const auto &EndOfTranslationUnitChecker : EndOfTranslationUnitCheckers)
719 EndOfTranslationUnitChecker(TU, mgr, BR);
727 Indent(Out, Space, IsDot) <<
"\"checker_messages\": ";
731 llvm::raw_svector_ostream TempOut(TempBuf);
732 unsigned int InnerSpace = Space + 2;
736 llvm::raw_svector_ostream NLOut(
NewLine);
737 NLOut <<
"\", " << NL;
738 Indent(NLOut, InnerSpace, IsDot) <<
"\"";
741 bool HasMessage =
false;
744 const void *LastCT =
nullptr;
745 for (
const auto &CT : CheckerTags) {
747 CT.second->printState(TempOut,
State,
NewLine.c_str(),
"");
761 for (
const auto &CT : CheckerTags) {
763 CT.second->printState(TempOut,
State,
NewLine.c_str(),
"");
769 <<
"{ \"checker\": \"" << CT.second->getCheckerName().getName()
770 <<
"\", \"messages\": [" << NL;
771 Indent(Out, InnerSpace, IsDot)
772 <<
'\"' << TempBuf.str().trim() <<
'\"' << NL;
773 Indent(Out, Space, IsDot) <<
"]}";
784 Indent(Out, --Space, IsDot) <<
"]";
797 DeclCheckerInfo info = { checkfn, isForDeclFn };
798 DeclCheckers.push_back(info);
802 BodyCheckers.push_back(checkfn);
811 StmtCheckerInfo info = { checkfn, isForStmtFn,
true };
812 StmtCheckers.push_back(info);
817 StmtCheckerInfo info = { checkfn, isForStmtFn,
false };
818 StmtCheckers.push_back(info);
822 PreObjCMessageCheckers.push_back(checkfn);
826 ObjCMessageNilCheckers.push_back(checkfn);
830 PostObjCMessageCheckers.push_back(checkfn);
834 PreCallCheckers.push_back(checkfn);
837 PostCallCheckers.push_back(checkfn);
841 LocationCheckers.push_back(checkfn);
845 BindCheckers.push_back(checkfn);
849 EndAnalysisCheckers.push_back(checkfn);
853 BeginFunctionCheckers.push_back(checkfn);
857 EndFunctionCheckers.push_back(checkfn);
862 BranchConditionCheckers.push_back(checkfn);
866 NewAllocatorCheckers.push_back(checkfn);
870 LiveSymbolsCheckers.push_back(checkfn);
874 DeadSymbolsCheckers.push_back(checkfn);
878 RegionChangesCheckers.push_back(checkfn);
882 PointerEscapeCheckers.push_back(checkfn);
887 PointerEscapeCheckers.push_back(checkfn);
891 EvalAssumeCheckers.push_back(checkfn);
895 EvalCallCheckers.push_back(checkfn);
900 EndOfTranslationUnitCheckers.push_back(checkfn);
908 CheckerManager::getCachedStmtCheckersFor(
const Stmt *S,
bool isPreVisit) {
911 unsigned Key = (S->getStmtClass() << 1) |
unsigned(isPreVisit);
912 CachedStmtCheckersMapTy::iterator CCI = CachedStmtCheckersMap.find(Key);
913 if (CCI != CachedStmtCheckersMap.end())
917 CachedStmtCheckers &Checkers = CachedStmtCheckersMap[Key];
918 for (
const auto &Info : StmtCheckers)
919 if (Info.IsPreVisit == isPreVisit && Info.IsForStmtFn(S))
920 Checkers.push_back(Info.CheckFn);