1 //===--- NonNullParamChecker.cpp - Undefined arguments checker -*- C++ -*--===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This defines NonNullParamChecker, which checks for arguments expected not to
12 // - the corresponding parameters being declared to have nonnull attribute
13 // - the corresponding parameters being references; since the call would form
14 // a reference to a null pointer
16 //===----------------------------------------------------------------------===//
18 #include "ClangSACheckers.h"
19 #include "clang/AST/Attr.h"
20 #include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
21 #include "clang/StaticAnalyzer/Core/Checker.h"
22 #include "clang/StaticAnalyzer/Core/CheckerManager.h"
23 #include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
24 #include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
26 using namespace clang;
30 class NonNullParamChecker
31 : public Checker< check::PreCall > {
32 mutable std::unique_ptr<BugType> BTAttrNonNull;
33 mutable std::unique_ptr<BugType> BTNullRefArg;
37 void checkPreCall(const CallEvent &Call, CheckerContext &C) const;
39 std::unique_ptr<BugReport>
40 genReportNullAttrNonNull(const ExplodedNode *ErrorN, const Expr *ArgE) const;
41 std::unique_ptr<BugReport>
42 genReportReferenceToNullPointer(const ExplodedNode *ErrorN,
43 const Expr *ArgE) const;
45 } // end anonymous namespace
47 void NonNullParamChecker::checkPreCall(const CallEvent &Call,
48 CheckerContext &C) const {
49 const Decl *FD = Call.getDecl();
53 // Merge all non-null attributes
54 unsigned NumArgs = Call.getNumArgs();
55 llvm::SmallBitVector AttrNonNull(NumArgs);
56 for (const auto *NonNull : FD->specific_attrs<NonNullAttr>()) {
57 if (!NonNull->args_size()) {
58 AttrNonNull.set(0, NumArgs);
61 for (unsigned Val : NonNull->args()) {
68 ProgramStateRef state = C.getState();
70 CallEvent::param_type_iterator TyI = Call.param_type_begin(),
71 TyE = Call.param_type_end();
73 for (unsigned idx = 0; idx < NumArgs; ++idx) {
75 // Check if the parameter is a reference. We want to report when reference
76 // to a null pointer is passed as a paramter.
77 bool haveRefTypeParam = false;
79 haveRefTypeParam = (*TyI)->isReferenceType();
83 bool haveAttrNonNull = AttrNonNull[idx];
84 if (!haveAttrNonNull) {
85 // Check if the parameter is also marked 'nonnull'.
86 ArrayRef<ParmVarDecl*> parms = Call.parameters();
87 if (idx < parms.size())
88 haveAttrNonNull = parms[idx]->hasAttr<NonNullAttr>();
91 if (!haveRefTypeParam && !haveAttrNonNull)
94 // If the value is unknown or undefined, we can't perform this check.
95 const Expr *ArgE = Call.getArgExpr(idx);
96 SVal V = Call.getArgSVal(idx);
97 Optional<DefinedSVal> DV = V.getAs<DefinedSVal>();
101 // Process the case when the argument is not a location.
102 assert(!haveRefTypeParam || DV->getAs<Loc>());
104 if (haveAttrNonNull && !DV->getAs<Loc>()) {
105 // If the argument is a union type, we want to handle a potential
106 // transparent_union GCC extension.
110 QualType T = ArgE->getType();
111 const RecordType *UT = T->getAsUnionType();
112 if (!UT || !UT->getDecl()->hasAttr<TransparentUnionAttr>())
115 if (Optional<nonloc::CompoundVal> CSV =
116 DV->getAs<nonloc::CompoundVal>()) {
117 nonloc::CompoundVal::iterator CSV_I = CSV->begin();
118 assert(CSV_I != CSV->end());
120 DV = V.getAs<DefinedSVal>();
121 assert(++CSV_I == CSV->end());
122 // FIXME: Handle (some_union){ some_other_union_val }, which turns into
123 // a LazyCompoundVal inside a CompoundVal.
126 // Retrieve the corresponding expression.
127 if (const CompoundLiteralExpr *CE = dyn_cast<CompoundLiteralExpr>(ArgE))
128 if (const InitListExpr *IE =
129 dyn_cast<InitListExpr>(CE->getInitializer()))
130 ArgE = dyn_cast<Expr>(*(IE->begin()));
133 // FIXME: Handle LazyCompoundVals?
138 ConstraintManager &CM = C.getConstraintManager();
139 ProgramStateRef stateNotNull, stateNull;
140 std::tie(stateNotNull, stateNull) = CM.assumeDual(state, *DV);
142 if (stateNull && !stateNotNull) {
143 // Generate an error node. Check for a null node in case
145 if (ExplodedNode *errorNode = C.generateSink(stateNull)) {
147 std::unique_ptr<BugReport> R;
149 R = genReportNullAttrNonNull(errorNode, ArgE);
150 else if (haveRefTypeParam)
151 R = genReportReferenceToNullPointer(errorNode, ArgE);
153 // Highlight the range of the argument that was null.
154 R->addRange(Call.getArgSourceRange(idx));
156 // Emit the bug report.
157 C.emitReport(std::move(R));
160 // Always return. Either we cached out or we just emitted an error.
164 // If a pointer value passed the check we should assume that it is
165 // indeed not null from this point forward.
166 assert(stateNotNull);
167 state = stateNotNull;
170 // If we reach here all of the arguments passed the nonnull check.
171 // If 'state' has been updated generated a new node.
172 C.addTransition(state);
175 std::unique_ptr<BugReport>
176 NonNullParamChecker::genReportNullAttrNonNull(const ExplodedNode *ErrorNode,
177 const Expr *ArgE) const {
178 // Lazily allocate the BugType object if it hasn't already been
179 // created. Ownership is transferred to the BugReporter object once
180 // the BugReport is passed to 'EmitWarning'.
182 BTAttrNonNull.reset(new BugType(
183 this, "Argument with 'nonnull' attribute passed null", "API"));
185 auto R = llvm::make_unique<BugReport>(
187 "Null pointer passed as an argument to a 'nonnull' parameter", ErrorNode);
189 bugreporter::trackNullOrUndefValue(ErrorNode, ArgE, *R);
194 std::unique_ptr<BugReport> NonNullParamChecker::genReportReferenceToNullPointer(
195 const ExplodedNode *ErrorNode, const Expr *ArgE) const {
197 BTNullRefArg.reset(new BuiltinBug(this, "Dereference of null pointer"));
199 auto R = llvm::make_unique<BugReport>(
200 *BTNullRefArg, "Forming reference to null pointer", ErrorNode);
202 const Expr *ArgEDeref = bugreporter::getDerefExpr(ArgE);
205 bugreporter::trackNullOrUndefValue(ErrorNode,
213 void ento::registerNonNullParamChecker(CheckerManager &mgr) {
214 mgr.registerChecker<NonNullParamChecker>();