CallAndMessageChecker.cpp revision a8695180217806bb421cfc6700bec76fc0b1ae56 
1//===--- CallAndMessageChecker.cpp ------------------------------*- C++ -*--==//
2//
3//                     The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
10// This defines CallAndMessageChecker, a builtin checker that checks for various
11// errors of call and objc message expressions.
12//
13//===----------------------------------------------------------------------===//
14
15#include "ClangSACheckers.h"
16#include "clang/StaticAnalyzer/Core/Checker.h"
17#include "clang/StaticAnalyzer/Core/CheckerManager.h"
18#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
19#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
20#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
21#include "clang/AST/ParentMap.h"
22#include "clang/Basic/TargetInfo.h"
23#include "llvm/ADT/SmallString.h"
24
25using namespace clang;
26using namespace ento;
27
28namespace {
29class CallAndMessageChecker
30  : public Checker< check::PreStmt<CallExpr>, check::PreObjCMessage,
31                    check::PreCall > {
32  mutable OwningPtr<BugType> BT_call_null;
33  mutable OwningPtr<BugType> BT_call_undef;
34  mutable OwningPtr<BugType> BT_cxx_call_null;
35  mutable OwningPtr<BugType> BT_cxx_call_undef;
36  mutable OwningPtr<BugType> BT_call_arg;
37  mutable OwningPtr<BugType> BT_msg_undef;
38  mutable OwningPtr<BugType> BT_objc_prop_undef;
39  mutable OwningPtr<BugType> BT_objc_subscript_undef;
40  mutable OwningPtr<BugType> BT_msg_arg;
41  mutable OwningPtr<BugType> BT_msg_ret;
42public:
43
44  void checkPreStmt(const CallExpr *CE, CheckerContext &C) const;
45  void checkPreObjCMessage(const ObjCMethodCall &msg, CheckerContext &C) const;
46  void checkPreCall(const CallEvent &Call, CheckerContext &C) const;
47
48private:
49  static bool PreVisitProcessArg(CheckerContext &C, SVal V,
50                                 SourceRange argRange, const Expr *argEx,
51                                 bool IsFirstArgument, bool checkUninitFields,
52                                 const CallEvent &Call, OwningPtr<BugType> &BT);
53
54  static void emitBadCall(BugType *BT, CheckerContext &C, const Expr *BadE);
55  void emitNilReceiverBug(CheckerContext &C, const ObjCMethodCall &msg,
56                          ExplodedNode *N) const;
57
58  void HandleNilReceiver(CheckerContext &C,
59                         ProgramStateRef state,
60                         const ObjCMethodCall &msg) const;
61
62  static void LazyInit_BT(const char *desc, OwningPtr<BugType> &BT) {
63    if (!BT)
64      BT.reset(new BuiltinBug(desc));
65  }
66};
67} // end anonymous namespace
68
69void CallAndMessageChecker::emitBadCall(BugType *BT, CheckerContext &C,
70                                        const Expr *BadE) {
71  ExplodedNode *N = C.generateSink();
72  if (!N)
73    return;
74
75  BugReport *R = new BugReport(*BT, BT->getName(), N);
76  if (BadE) {
77    R->addRange(BadE->getSourceRange());
78    bugreporter::addTrackNullOrUndefValueVisitor(N, BadE, R);
79  }
80  C.EmitReport(R);
81}
82
83StringRef describeUninitializedArgumentInCall(const CallEvent &Call,
84                                              bool IsFirstArgument) {
85  switch (Call.getKind()) {
86  case CE_ObjCMessage: {
87    const ObjCMethodCall &Msg = cast<ObjCMethodCall>(Call);
88    switch (Msg.getMessageKind()) {
89    case OCM_Message:
90      return "Argument in message expression is an uninitialized value";
91    case OCM_PropertyAccess:
92      assert(Msg.isSetter() && "Getters have no args");
93      return "Argument for property setter is an uninitialized value";
94    case OCM_Subscript:
95      if (Msg.isSetter() && IsFirstArgument)
96        return "Argument for subscript setter is an uninitialized value";
97      return "Subscript index is an uninitialized value";
98    }
99    llvm_unreachable("Unknown message kind.");
100  }
101  case CE_Block:
102    return "Block call argument is an uninitialized value";
103  default:
104    return "Function call argument is an uninitialized value";
105  }
106}
107
108bool CallAndMessageChecker::PreVisitProcessArg(CheckerContext &C,
109                                               SVal V, SourceRange argRange,
110                                               const Expr *argEx,
111                                               bool IsFirstArgument,
112                                               bool checkUninitFields,
113                                               const CallEvent &Call,
114                                               OwningPtr<BugType> &BT) {
115  if (V.isUndef()) {
116    if (ExplodedNode *N = C.generateSink()) {
117      LazyInit_BT("Uninitialized argument value", BT);
118
119      // Generate a report for this bug.
120      StringRef Desc = describeUninitializedArgumentInCall(Call,
121                                                           IsFirstArgument);
122      BugReport *R = new BugReport(*BT, Desc, N);
123      R->addRange(argRange);
124      if (argEx)
125        bugreporter::addTrackNullOrUndefValueVisitor(N, argEx, R);
126      C.EmitReport(R);
127    }
128    return true;
129  }
130
131  if (!checkUninitFields)
132    return false;
133
134  if (const nonloc::LazyCompoundVal *LV =
135        dyn_cast<nonloc::LazyCompoundVal>(&V)) {
136
137    class FindUninitializedField {
138    public:
139      SmallVector<const FieldDecl *, 10> FieldChain;
140    private:
141      StoreManager &StoreMgr;
142      MemRegionManager &MrMgr;
143      Store store;
144    public:
145      FindUninitializedField(StoreManager &storeMgr,
146                             MemRegionManager &mrMgr, Store s)
147      : StoreMgr(storeMgr), MrMgr(mrMgr), store(s) {}
148
149      bool Find(const TypedValueRegion *R) {
150        QualType T = R->getValueType();
151        if (const RecordType *RT = T->getAsStructureType()) {
152          const RecordDecl *RD = RT->getDecl()->getDefinition();
153          assert(RD && "Referred record has no definition");
154          for (RecordDecl::field_iterator I =
155               RD->field_begin(), E = RD->field_end(); I!=E; ++I) {
156            const FieldRegion *FR = MrMgr.getFieldRegion(*I, R);
157            FieldChain.push_back(*I);
158            T = I->getType();
159            if (T->getAsStructureType()) {
160              if (Find(FR))
161                return true;
162            }
163            else {
164              const SVal &V = StoreMgr.getBinding(store, loc::MemRegionVal(FR));
165              if (V.isUndef())
166                return true;
167            }
168            FieldChain.pop_back();
169          }
170        }
171
172        return false;
173      }
174    };
175
176    const LazyCompoundValData *D = LV->getCVData();
177    FindUninitializedField F(C.getState()->getStateManager().getStoreManager(),
178                             C.getSValBuilder().getRegionManager(),
179                             D->getStore());
180
181    if (F.Find(D->getRegion())) {
182      if (ExplodedNode *N = C.generateSink()) {
183        LazyInit_BT("Uninitialized argument value", BT);
184        SmallString<512> Str;
185        llvm::raw_svector_ostream os(Str);
186        os << "Passed-by-value struct argument contains uninitialized data";
187
188        if (F.FieldChain.size() == 1)
189          os << " (e.g., field: '" << *F.FieldChain[0] << "')";
190        else {
191          os << " (e.g., via the field chain: '";
192          bool first = true;
193          for (SmallVectorImpl<const FieldDecl *>::iterator
194               DI = F.FieldChain.begin(), DE = F.FieldChain.end(); DI!=DE;++DI){
195            if (first)
196              first = false;
197            else
198              os << '.';
199            os << **DI;
200          }
201          os << "')";
202        }
203
204        // Generate a report for this bug.
205        BugReport *R = new BugReport(*BT, os.str(), N);
206        R->addRange(argRange);
207
208        // FIXME: enhance track back for uninitialized value for arbitrary
209        // memregions
210        C.EmitReport(R);
211      }
212      return true;
213    }
214  }
215
216  return false;
217}
218
219void CallAndMessageChecker::checkPreStmt(const CallExpr *CE,
220                                         CheckerContext &C) const{
221
222  const Expr *Callee = CE->getCallee()->IgnoreParens();
223  ProgramStateRef State = C.getState();
224  const LocationContext *LCtx = C.getLocationContext();
225  SVal L = State->getSVal(Callee, LCtx);
226
227  if (L.isUndef()) {
228    if (!BT_call_undef)
229      BT_call_undef.reset(new BuiltinBug("Called function pointer is an "
230                                         "uninitalized pointer value"));
231    emitBadCall(BT_call_undef.get(), C, Callee);
232    return;
233  }
234
235  ProgramStateRef StNonNull, StNull;
236  llvm::tie(StNonNull, StNull) = State->assume(cast<DefinedOrUnknownSVal>(L));
237
238  // FIXME: Do we want to record the non-null assumption here?
239  if (StNull && !StNonNull) {
240    if (!BT_call_null)
241      BT_call_null.reset(
242        new BuiltinBug("Called function pointer is null (null dereference)"));
243    emitBadCall(BT_call_null.get(), C, Callee);
244  }
245}
246
247void CallAndMessageChecker::checkPreCall(const CallEvent &Call,
248                                         CheckerContext &C) const {
249  // If this is a call to a C++ method, check if the callee is null or
250  // undefined.
251  if (const CXXInstanceCall *CC = dyn_cast<CXXInstanceCall>(&Call)) {
252    SVal V = CC->getCXXThisVal();
253    if (V.isUndef()) {
254      if (!BT_cxx_call_undef)
255        BT_cxx_call_undef.reset(new BuiltinBug("Called C++ object pointer is "
256                                               "uninitialized"));
257      emitBadCall(BT_cxx_call_undef.get(), C, CC->getCXXThisExpr());
258      return;
259    }
260
261    ProgramStateRef State = C.getState();
262    ProgramStateRef StNonNull, StNull;
263    llvm::tie(StNonNull, StNull) = State->assume(cast<DefinedOrUnknownSVal>(V));
264
265    // FIXME: Do we want to record the non-null assumption here?
266    if (StNull && !StNonNull) {
267      if (!BT_cxx_call_null)
268        BT_cxx_call_null.reset(new BuiltinBug("Called C++ object pointer "
269                                              "is null"));
270      emitBadCall(BT_cxx_call_null.get(), C, CC->getCXXThisExpr());
271      return;
272    }
273  }
274
275  // Don't check for uninitialized field values in arguments if the
276  // caller has a body that is available and we have the chance to inline it.
277  // This is a hack, but is a reasonable compromise betweens sometimes warning
278  // and sometimes not depending on if we decide to inline a function.
279  const Decl *D = Call.getDecl();
280  const bool checkUninitFields =
281    !(C.getAnalysisManager().shouldInlineCall() && (D && D->getBody()));
282
283  OwningPtr<BugType> *BT;
284  if (isa<ObjCMethodCall>(Call))
285    BT = &BT_msg_arg;
286  else
287    BT = &BT_call_arg;
288
289  for (unsigned i = 0, e = Call.getNumArgs(); i != e; ++i)
290    if (PreVisitProcessArg(C, Call.getArgSVal(i), Call.getArgSourceRange(i),
291                           Call.getArgExpr(i), /*IsFirstArgument=*/i == 0,
292                           checkUninitFields, Call, *BT))
293      return;
294}
295
296void CallAndMessageChecker::checkPreObjCMessage(const ObjCMethodCall &msg,
297                                                CheckerContext &C) const {
298  SVal recVal = msg.getReceiverSVal();
299  if (recVal.isUndef()) {
300    if (ExplodedNode *N = C.generateSink()) {
301      BugType *BT = 0;
302      switch (msg.getMessageKind()) {
303      case OCM_Message:
304        if (!BT_msg_undef)
305          BT_msg_undef.reset(new BuiltinBug("Receiver in message expression "
306                                            "is an uninitialized value"));
307        BT = BT_msg_undef.get();
308        break;
309      case OCM_PropertyAccess:
310        if (!BT_objc_prop_undef)
311          BT_objc_prop_undef.reset(new BuiltinBug("Property access on an "
312                                                  "uninitialized object "
313                                                  "pointer"));
314        BT = BT_objc_prop_undef.get();
315        break;
316      case OCM_Subscript:
317        if (!BT_objc_subscript_undef)
318          BT_objc_subscript_undef.reset(new BuiltinBug("Subscript access on an "
319                                                       "uninitialized object "
320                                                       "pointer"));
321        BT = BT_objc_subscript_undef.get();
322        break;
323      }
324      assert(BT && "Unknown message kind.");
325
326      BugReport *R = new BugReport(*BT, BT->getName(), N);
327      const ObjCMessageExpr *ME = msg.getOriginExpr();
328      R->addRange(ME->getReceiverRange());
329
330      // FIXME: getTrackNullOrUndefValueVisitor can't handle "super" yet.
331      if (const Expr *ReceiverE = ME->getInstanceReceiver())
332        bugreporter::addTrackNullOrUndefValueVisitor(N, ReceiverE, R);
333      C.EmitReport(R);
334    }
335    return;
336  } else {
337    // Bifurcate the state into nil and non-nil ones.
338    DefinedOrUnknownSVal receiverVal = cast<DefinedOrUnknownSVal>(recVal);
339
340    ProgramStateRef state = C.getState();
341    ProgramStateRef notNilState, nilState;
342    llvm::tie(notNilState, nilState) = state->assume(receiverVal);
343
344    // Handle receiver must be nil.
345    if (nilState && !notNilState) {
346      HandleNilReceiver(C, state, msg);
347      return;
348    }
349  }
350}
351
352void CallAndMessageChecker::emitNilReceiverBug(CheckerContext &C,
353                                               const ObjCMethodCall &msg,
354                                               ExplodedNode *N) const {
355
356  if (!BT_msg_ret)
357    BT_msg_ret.reset(
358      new BuiltinBug("Receiver in message expression is "
359                     "'nil' and returns a garbage value"));
360
361  const ObjCMessageExpr *ME = msg.getOriginExpr();
362
363  SmallString<200> buf;
364  llvm::raw_svector_ostream os(buf);
365  os << "The receiver of message '" << ME->getSelector().getAsString()
366     << "' is nil and returns a value of type '";
367  msg.getResultType().print(os, C.getLangOpts());
368  os << "' that will be garbage";
369
370  BugReport *report = new BugReport(*BT_msg_ret, os.str(), N);
371  report->addRange(ME->getReceiverRange());
372  // FIXME: This won't track "self" in messages to super.
373  if (const Expr *receiver = ME->getInstanceReceiver()) {
374    bugreporter::addTrackNullOrUndefValueVisitor(N, receiver, report);
375  }
376  C.EmitReport(report);
377}
378
379static bool supportsNilWithFloatRet(const llvm::Triple &triple) {
380  return (triple.getVendor() == llvm::Triple::Apple &&
381          (triple.getOS() == llvm::Triple::IOS ||
382           !triple.isMacOSXVersionLT(10,5)));
383}
384
385void CallAndMessageChecker::HandleNilReceiver(CheckerContext &C,
386                                              ProgramStateRef state,
387                                              const ObjCMethodCall &Msg) const {
388  ASTContext &Ctx = C.getASTContext();
389
390  // Check the return type of the message expression.  A message to nil will
391  // return different values depending on the return type and the architecture.
392  QualType RetTy = Msg.getResultType();
393  CanQualType CanRetTy = Ctx.getCanonicalType(RetTy);
394  const LocationContext *LCtx = C.getLocationContext();
395
396  if (CanRetTy->isStructureOrClassType()) {
397    // Structure returns are safe since the compiler zeroes them out.
398    SVal V = C.getSValBuilder().makeZeroVal(RetTy);
399    C.addTransition(state->BindExpr(Msg.getOriginExpr(), LCtx, V));
400    return;
401  }
402
403  // Other cases: check if sizeof(return type) > sizeof(void*)
404  if (CanRetTy != Ctx.VoidTy && C.getLocationContext()->getParentMap()
405                                  .isConsumedExpr(Msg.getOriginExpr())) {
406    // Compute: sizeof(void *) and sizeof(return type)
407    const uint64_t voidPtrSize = Ctx.getTypeSize(Ctx.VoidPtrTy);
408    const uint64_t returnTypeSize = Ctx.getTypeSize(CanRetTy);
409
410    if (voidPtrSize < returnTypeSize &&
411        !(supportsNilWithFloatRet(Ctx.getTargetInfo().getTriple()) &&
412          (Ctx.FloatTy == CanRetTy ||
413           Ctx.DoubleTy == CanRetTy ||
414           Ctx.LongDoubleTy == CanRetTy ||
415           Ctx.LongLongTy == CanRetTy ||
416           Ctx.UnsignedLongLongTy == CanRetTy))) {
417      if (ExplodedNode *N = C.generateSink(state))
418        emitNilReceiverBug(C, Msg, N);
419      return;
420    }
421
422    // Handle the safe cases where the return value is 0 if the
423    // receiver is nil.
424    //
425    // FIXME: For now take the conservative approach that we only
426    // return null values if we *know* that the receiver is nil.
427    // This is because we can have surprises like:
428    //
429    //   ... = [[NSScreens screens] objectAtIndex:0];
430    //
431    // What can happen is that [... screens] could return nil, but
432    // it most likely isn't nil.  We should assume the semantics
433    // of this case unless we have *a lot* more knowledge.
434    //
435    SVal V = C.getSValBuilder().makeZeroVal(RetTy);
436    C.addTransition(state->BindExpr(Msg.getOriginExpr(), LCtx, V));
437    return;
438  }
439
440  C.addTransition(state);
441}
442
443void ento::registerCallAndMessageChecker(CheckerManager &mgr) {
444  mgr.registerChecker<CallAndMessageChecker>();
445}
446