blob: f2afcca971069855b1e3d367083026573f3c0f19 [file] [log] [blame]
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001//=== MallocChecker.cpp - A malloc/free checker -------------------*- 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 file defines malloc/free checker, which checks for potential memory
11// leaks, double free, and use-after-free problems.
12//
13//===----------------------------------------------------------------------===//
14
Argyrios Kyrtzidis183f0fb2011-02-28 01:26:35 +000015#include "ClangSACheckers.h"
Anna Zakse56167e2012-02-17 22:35:31 +000016#include "InterCheckerAPI.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000017#include "clang/AST/Attr.h"
Anton Yartsev4e4cb6b2014-08-05 18:26:05 +000018#include "clang/AST/ParentMap.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000019#include "clang/Basic/SourceManager.h"
Jordan Rose6b33c6f2014-03-26 17:05:46 +000020#include "clang/Basic/TargetInfo.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000021#include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
Argyrios Kyrtzidis6a5674f2011-03-01 01:16:21 +000022#include "clang/StaticAnalyzer/Core/Checker.h"
Argyrios Kyrtzidis183f0fb2011-02-28 01:26:35 +000023#include "clang/StaticAnalyzer/Core/CheckerManager.h"
Jordan Rose4f7df9b2012-07-26 21:39:41 +000024#include "clang/StaticAnalyzer/Core/PathSensitive/CallEvent.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000025#include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
Ted Kremenek001fd5b2011-08-15 22:09:50 +000026#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
27#include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h"
Ted Kremenekf8cbac42011-02-10 01:03:03 +000028#include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h"
Zhongxing Xu88cca6b2009-11-12 08:38:56 +000029#include "llvm/ADT/ImmutableMap.h"
Benjamin Kramer3307c5082012-02-04 12:31:12 +000030#include "llvm/ADT/STLExtras.h"
Benjamin Kramerea70eb32012-12-01 15:09:41 +000031#include "llvm/ADT/SmallString.h"
Jordan Rosec102b352012-09-22 01:24:42 +000032#include "llvm/ADT/StringExtras.h"
Anna Zaks199e8e52012-02-22 03:14:20 +000033#include <climits>
34
Zhongxing Xu88cca6b2009-11-12 08:38:56 +000035using namespace clang;
Ted Kremenek98857c92010-12-23 07:20:52 +000036using namespace ento;
Zhongxing Xu88cca6b2009-11-12 08:38:56 +000037
38namespace {
39
Anton Yartsev05789592013-03-28 17:05:19 +000040// Used to check correspondence between allocators and deallocators.
41enum AllocationFamily {
42 AF_None,
43 AF_Malloc,
44 AF_CXXNew,
Anna Zaksd79b8402014-10-03 21:48:59 +000045 AF_CXXNewArray,
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +000046 AF_IfNameIndex,
47 AF_Alloca
Anton Yartsev05789592013-03-28 17:05:19 +000048};
49
Zhongxing Xu1239de12009-12-11 00:55:44 +000050class RefState {
Anna Zaks9050ffd2012-06-20 20:57:46 +000051 enum Kind { // Reference to allocated memory.
52 Allocated,
53 // Reference to released/freed memory.
54 Released,
Alp Toker5faf0c02013-12-02 03:50:25 +000055 // The responsibility for freeing resources has transferred from
Anna Zaks9050ffd2012-06-20 20:57:46 +000056 // this reference. A relinquished symbol should not be freed.
Anna Zaks93a21a82013-04-09 00:30:28 +000057 Relinquished,
58 // We are no longer guaranteed to have observed all manipulations
59 // of this pointer/memory. For example, it could have been
60 // passed as a parameter to an opaque function.
61 Escaped
62 };
Anton Yartsev05789592013-03-28 17:05:19 +000063
Zhongxing Xu4668c7e2009-11-17 07:54:15 +000064 const Stmt *S;
Anton Yartsev05789592013-03-28 17:05:19 +000065 unsigned K : 2; // Kind enum, but stored as a bitfield.
66 unsigned Family : 30; // Rest of 32-bit word, currently just an allocation
67 // family.
Zhongxing Xu4668c7e2009-11-17 07:54:15 +000068
Anton Yartsev05789592013-03-28 17:05:19 +000069 RefState(Kind k, const Stmt *s, unsigned family)
Anna Zaks93a21a82013-04-09 00:30:28 +000070 : S(s), K(k), Family(family) {
71 assert(family != AF_None);
72 }
Zhongxing Xu1239de12009-12-11 00:55:44 +000073public:
Anna Zaks9050ffd2012-06-20 20:57:46 +000074 bool isAllocated() const { return K == Allocated; }
Zhongxing Xu4668c7e2009-11-17 07:54:15 +000075 bool isReleased() const { return K == Released; }
Anna Zaks9050ffd2012-06-20 20:57:46 +000076 bool isRelinquished() const { return K == Relinquished; }
Anna Zaks93a21a82013-04-09 00:30:28 +000077 bool isEscaped() const { return K == Escaped; }
78 AllocationFamily getAllocationFamily() const {
Anton Yartsev05789592013-03-28 17:05:19 +000079 return (AllocationFamily)Family;
80 }
Anna Zaksd56c8792012-02-13 18:05:39 +000081 const Stmt *getStmt() const { return S; }
Zhongxing Xu4668c7e2009-11-17 07:54:15 +000082
83 bool operator==(const RefState &X) const {
Anton Yartsev05789592013-03-28 17:05:19 +000084 return K == X.K && S == X.S && Family == X.Family;
Zhongxing Xu4668c7e2009-11-17 07:54:15 +000085 }
86
Anton Yartsev05789592013-03-28 17:05:19 +000087 static RefState getAllocated(unsigned family, const Stmt *s) {
88 return RefState(Allocated, s, family);
Zhongxing Xub0e15df2009-12-31 06:13:07 +000089 }
Anton Yartsev05789592013-03-28 17:05:19 +000090 static RefState getReleased(unsigned family, const Stmt *s) {
91 return RefState(Released, s, family);
92 }
93 static RefState getRelinquished(unsigned family, const Stmt *s) {
94 return RefState(Relinquished, s, family);
Ted Kremenek0bbf24d2010-08-06 21:12:55 +000095 }
Anna Zaks93a21a82013-04-09 00:30:28 +000096 static RefState getEscaped(const RefState *RS) {
97 return RefState(Escaped, RS->getStmt(), RS->getAllocationFamily());
98 }
Zhongxing Xu4668c7e2009-11-17 07:54:15 +000099
100 void Profile(llvm::FoldingSetNodeID &ID) const {
101 ID.AddInteger(K);
102 ID.AddPointer(S);
Anton Yartsev05789592013-03-28 17:05:19 +0000103 ID.AddInteger(Family);
Zhongxing Xu4668c7e2009-11-17 07:54:15 +0000104 }
Ted Kremenek6fcefb52013-01-03 01:30:12 +0000105
Dmitri Gribenkof8579502013-01-12 19:30:44 +0000106 void dump(raw_ostream &OS) const {
Jordan Rose6adadb92014-01-23 03:59:01 +0000107 switch (static_cast<Kind>(K)) {
108#define CASE(ID) case ID: OS << #ID; break;
109 CASE(Allocated)
110 CASE(Released)
111 CASE(Relinquished)
112 CASE(Escaped)
113 }
Ted Kremenek6fcefb52013-01-03 01:30:12 +0000114 }
115
Alp Tokeref6b0072014-01-04 13:47:14 +0000116 LLVM_DUMP_METHOD void dump() const { dump(llvm::errs()); }
Zhongxing Xu88cca6b2009-11-12 08:38:56 +0000117};
118
Anna Zaks75cfbb62012-09-12 22:57:34 +0000119enum ReallocPairKind {
120 RPToBeFreedAfterFailure,
121 // The symbol has been freed when reallocation failed.
122 RPIsFreeOnFailure,
123 // The symbol does not need to be freed after reallocation fails.
124 RPDoNotTrackAfterFailure
125};
126
Anna Zaksfe6eb672012-08-24 02:28:20 +0000127/// \class ReallocPair
128/// \brief Stores information about the symbol being reallocated by a call to
129/// 'realloc' to allow modeling failed reallocation later in the path.
Anna Zaksac068142012-02-15 00:11:25 +0000130struct ReallocPair {
Anna Zaksfe6eb672012-08-24 02:28:20 +0000131 // \brief The symbol which realloc reallocated.
Anna Zaksac068142012-02-15 00:11:25 +0000132 SymbolRef ReallocatedSym;
Anna Zaks75cfbb62012-09-12 22:57:34 +0000133 ReallocPairKind Kind;
Anna Zaksfe6eb672012-08-24 02:28:20 +0000134
Anna Zaks75cfbb62012-09-12 22:57:34 +0000135 ReallocPair(SymbolRef S, ReallocPairKind K) :
136 ReallocatedSym(S), Kind(K) {}
Anna Zaksac068142012-02-15 00:11:25 +0000137 void Profile(llvm::FoldingSetNodeID &ID) const {
Anna Zaks75cfbb62012-09-12 22:57:34 +0000138 ID.AddInteger(Kind);
Anna Zaksac068142012-02-15 00:11:25 +0000139 ID.AddPointer(ReallocatedSym);
140 }
141 bool operator==(const ReallocPair &X) const {
142 return ReallocatedSym == X.ReallocatedSym &&
Anna Zaks75cfbb62012-09-12 22:57:34 +0000143 Kind == X.Kind;
Anna Zaksac068142012-02-15 00:11:25 +0000144 }
145};
146
Anna Zaksa043d0c2013-01-08 00:25:29 +0000147typedef std::pair<const ExplodedNode*, const MemRegion*> LeakInfo;
Anna Zaksfc2e1532012-03-21 19:45:08 +0000148
Anna Zaksc68bf4c2012-02-08 20:13:28 +0000149class MallocChecker : public Checker<check::DeadSymbols,
Anna Zaksdc154152012-12-20 00:38:25 +0000150 check::PointerEscape,
Anna Zaks333481b2013-03-28 23:15:29 +0000151 check::ConstPointerEscape,
Ted Kremenek778d2bb2012-01-04 23:48:37 +0000152 check::PreStmt<ReturnStmt>,
Anton Yartsevcb2ccd62013-04-10 22:21:41 +0000153 check::PreCall,
Anna Zaksc68bf4c2012-02-08 20:13:28 +0000154 check::PostStmt<CallExpr>,
Anton Yartsev13df0362013-03-25 01:35:45 +0000155 check::PostStmt<CXXNewExpr>,
156 check::PreStmt<CXXDeleteExpr>,
Anna Zaks9fe80982012-03-22 00:57:20 +0000157 check::PostStmt<BlockExpr>,
Anna Zaks67291b92012-11-13 03:18:01 +0000158 check::PostObjCMessage,
Ted Kremenek778d2bb2012-01-04 23:48:37 +0000159 check::Location,
Anna Zaksdc154152012-12-20 00:38:25 +0000160 eval::Assume>
Ted Kremenek778d2bb2012-01-04 23:48:37 +0000161{
Zhongxing Xu88cca6b2009-11-12 08:38:56 +0000162public:
Craig Topper0dbb7832014-05-27 02:45:47 +0000163 MallocChecker()
Anton Yartsevc38d7952015-03-03 22:58:46 +0000164 : II_alloca(nullptr), II_malloc(nullptr), II_free(nullptr),
165 II_realloc(nullptr), II_calloc(nullptr), II_valloc(nullptr),
166 II_reallocf(nullptr), II_strndup(nullptr), II_strdup(nullptr),
167 II_kmalloc(nullptr), II_if_nameindex(nullptr),
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000168 II_if_freenameindex(nullptr) {}
Anna Zakscd37bf42012-02-08 23:16:52 +0000169
170 /// In pessimistic mode, the checker assumes that it does not know which
171 /// functions might free the memory.
Alexander Kornienko4aca9b12014-02-11 21:49:21 +0000172 enum CheckKind {
Gabor Horvathe40c71c2015-03-04 17:59:34 +0000173 CK_MallocChecker,
Alexander Kornienko4aca9b12014-02-11 21:49:21 +0000174 CK_NewDeleteChecker,
175 CK_NewDeleteLeaksChecker,
176 CK_MismatchedDeallocatorChecker,
177 CK_NumCheckKinds
Anna Zakscd37bf42012-02-08 23:16:52 +0000178 };
179
Anna Zaksd79b8402014-10-03 21:48:59 +0000180 enum class MemoryOperationKind {
181 MOK_Allocate,
182 MOK_Free,
183 MOK_Any
184 };
185
Gabor Horvathe40c71c2015-03-04 17:59:34 +0000186 DefaultBool IsOptimistic;
187
Alexander Kornienko4aca9b12014-02-11 21:49:21 +0000188 DefaultBool ChecksEnabled[CK_NumCheckKinds];
189 CheckName CheckNames[CK_NumCheckKinds];
Anton Yartseve5c0c142015-02-18 00:39:06 +0000190 typedef llvm::SmallVector<CheckKind, CK_NumCheckKinds> CKVecTy;
Anna Zakscd37bf42012-02-08 23:16:52 +0000191
Anton Yartsevcb2ccd62013-04-10 22:21:41 +0000192 void checkPreCall(const CallEvent &Call, CheckerContext &C) const;
Anna Zaksc68bf4c2012-02-08 20:13:28 +0000193 void checkPostStmt(const CallExpr *CE, CheckerContext &C) const;
Anton Yartsev13df0362013-03-25 01:35:45 +0000194 void checkPostStmt(const CXXNewExpr *NE, CheckerContext &C) const;
195 void checkPreStmt(const CXXDeleteExpr *DE, CheckerContext &C) const;
Anna Zaks67291b92012-11-13 03:18:01 +0000196 void checkPostObjCMessage(const ObjCMethodCall &Call, CheckerContext &C) const;
Anna Zaks9fe80982012-03-22 00:57:20 +0000197 void checkPostStmt(const BlockExpr *BE, CheckerContext &C) const;
Argyrios Kyrtzidis183f0fb2011-02-28 01:26:35 +0000198 void checkDeadSymbols(SymbolReaper &SymReaper, CheckerContext &C) const;
Argyrios Kyrtzidis183f0fb2011-02-28 01:26:35 +0000199 void checkPreStmt(const ReturnStmt *S, CheckerContext &C) const;
Ted Kremenek49b1e382012-01-26 21:29:00 +0000200 ProgramStateRef evalAssume(ProgramStateRef state, SVal Cond,
Argyrios Kyrtzidis183f0fb2011-02-28 01:26:35 +0000201 bool Assumption) const;
Anna Zaks3e0f4152011-10-06 00:43:15 +0000202 void checkLocation(SVal l, bool isLoad, const Stmt *S,
203 CheckerContext &C) const;
Anna Zaksdc154152012-12-20 00:38:25 +0000204
205 ProgramStateRef checkPointerEscape(ProgramStateRef State,
206 const InvalidatedSymbols &Escaped,
Anna Zaksacdc13c2013-02-07 23:05:43 +0000207 const CallEvent *Call,
208 PointerEscapeKind Kind) const;
Anna Zaks333481b2013-03-28 23:15:29 +0000209 ProgramStateRef checkConstPointerEscape(ProgramStateRef State,
210 const InvalidatedSymbols &Escaped,
211 const CallEvent *Call,
212 PointerEscapeKind Kind) const;
Zhongxing Xub0e15df2009-12-31 06:13:07 +0000213
Anna Zaks263b7e02012-05-02 00:05:20 +0000214 void printState(raw_ostream &Out, ProgramStateRef State,
Craig Topperfb6b25b2014-03-15 04:29:04 +0000215 const char *NL, const char *Sep) const override;
Anna Zaks263b7e02012-05-02 00:05:20 +0000216
Zhongxing Xuc4902a52009-11-13 07:25:27 +0000217private:
Ahmed Charlesb8984322014-03-07 20:03:18 +0000218 mutable std::unique_ptr<BugType> BT_DoubleFree[CK_NumCheckKinds];
219 mutable std::unique_ptr<BugType> BT_DoubleDelete;
220 mutable std::unique_ptr<BugType> BT_Leak[CK_NumCheckKinds];
221 mutable std::unique_ptr<BugType> BT_UseFree[CK_NumCheckKinds];
222 mutable std::unique_ptr<BugType> BT_BadFree[CK_NumCheckKinds];
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000223 mutable std::unique_ptr<BugType> BT_FreeAlloca[CK_NumCheckKinds];
Ahmed Charlesb8984322014-03-07 20:03:18 +0000224 mutable std::unique_ptr<BugType> BT_MismatchedDealloc;
225 mutable std::unique_ptr<BugType> BT_OffsetFree[CK_NumCheckKinds];
Anton Yartsevc38d7952015-03-03 22:58:46 +0000226 mutable IdentifierInfo *II_alloca, *II_malloc, *II_free, *II_realloc,
227 *II_calloc, *II_valloc, *II_reallocf, *II_strndup,
228 *II_strdup, *II_kmalloc, *II_if_nameindex,
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000229 *II_if_freenameindex;
Jordan Rose6b33c6f2014-03-26 17:05:46 +0000230 mutable Optional<uint64_t> KernelZeroFlagVal;
Alexander Kornienko4aca9b12014-02-11 21:49:21 +0000231
Anna Zaks3d348342012-02-14 21:55:24 +0000232 void initIdentifierInfo(ASTContext &C) const;
233
Anton Yartsev05789592013-03-28 17:05:19 +0000234 /// \brief Determine family of a deallocation expression.
Anton Yartseve3377fb2013-04-04 23:46:29 +0000235 AllocationFamily getAllocationFamily(CheckerContext &C, const Stmt *S) const;
Anton Yartsev05789592013-03-28 17:05:19 +0000236
237 /// \brief Print names of allocators and deallocators.
238 ///
239 /// \returns true on success.
240 bool printAllocDeallocName(raw_ostream &os, CheckerContext &C,
241 const Expr *E) const;
242
243 /// \brief Print expected name of an allocator based on the deallocator's
244 /// family derived from the DeallocExpr.
245 void printExpectedAllocName(raw_ostream &os, CheckerContext &C,
246 const Expr *DeallocExpr) const;
247 /// \brief Print expected name of a deallocator based on the allocator's
248 /// family.
249 void printExpectedDeallocName(raw_ostream &os, AllocationFamily Family) const;
250
Jordan Rose613f3c02013-03-09 00:59:10 +0000251 ///@{
Anna Zaks3d348342012-02-14 21:55:24 +0000252 /// Check if this is one of the functions which can allocate/reallocate memory
253 /// pointed to by one of its arguments.
254 bool isMemFunction(const FunctionDecl *FD, ASTContext &C) const;
Anna Zaksd79b8402014-10-03 21:48:59 +0000255 bool isCMemFunction(const FunctionDecl *FD,
256 ASTContext &C,
257 AllocationFamily Family,
Benjamin Kramer719772c2014-10-03 22:20:30 +0000258 MemoryOperationKind MemKind) const;
Anton Yartsev13df0362013-03-25 01:35:45 +0000259 bool isStandardNewDelete(const FunctionDecl *FD, ASTContext &C) const;
Jordan Rose613f3c02013-03-09 00:59:10 +0000260 ///@}
Richard Smith852e9ce2013-11-27 01:46:48 +0000261 ProgramStateRef MallocMemReturnsAttr(CheckerContext &C,
262 const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000263 const OwnershipAttr* Att,
264 ProgramStateRef State) const;
Ted Kremenek49b1e382012-01-26 21:29:00 +0000265 static ProgramStateRef MallocMemAux(CheckerContext &C, const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000266 const Expr *SizeEx, SVal Init,
267 ProgramStateRef State,
268 AllocationFamily Family = AF_Malloc);
Ted Kremenek49b1e382012-01-26 21:29:00 +0000269 static ProgramStateRef MallocMemAux(CheckerContext &C, const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000270 SVal SizeEx, SVal Init,
271 ProgramStateRef State,
272 AllocationFamily Family = AF_Malloc);
Zhongxing Xu527ff6d2010-06-01 03:01:33 +0000273
Jordan Rose6b33c6f2014-03-26 17:05:46 +0000274 // Check if this malloc() for special flags. At present that means M_ZERO or
275 // __GFP_ZERO (in which case, treat it like calloc).
276 llvm::Optional<ProgramStateRef>
277 performKernelMalloc(const CallExpr *CE, CheckerContext &C,
278 const ProgramStateRef &State) const;
279
Anna Zaks40a7eb32012-02-22 19:24:52 +0000280 /// Update the RefState to reflect the new memory allocation.
Anton Yartsev05789592013-03-28 17:05:19 +0000281 static ProgramStateRef
282 MallocUpdateRefState(CheckerContext &C, const Expr *E, ProgramStateRef State,
283 AllocationFamily Family = AF_Malloc);
Anna Zaks40a7eb32012-02-22 19:24:52 +0000284
285 ProgramStateRef FreeMemAttr(CheckerContext &C, const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000286 const OwnershipAttr* Att,
287 ProgramStateRef State) const;
Ted Kremenek49b1e382012-01-26 21:29:00 +0000288 ProgramStateRef FreeMemAux(CheckerContext &C, const CallExpr *CE,
Anna Zaks0d6989b2012-06-22 02:04:31 +0000289 ProgramStateRef state, unsigned Num,
Anna Zaksfe6eb672012-08-24 02:28:20 +0000290 bool Hold,
Anna Zaks67291b92012-11-13 03:18:01 +0000291 bool &ReleasedAllocated,
292 bool ReturnsNullOnFailure = false) const;
Anna Zaks0d6989b2012-06-22 02:04:31 +0000293 ProgramStateRef FreeMemAux(CheckerContext &C, const Expr *Arg,
294 const Expr *ParentExpr,
Anna Zaks67291b92012-11-13 03:18:01 +0000295 ProgramStateRef State,
Anna Zaksfe6eb672012-08-24 02:28:20 +0000296 bool Hold,
Anna Zaks67291b92012-11-13 03:18:01 +0000297 bool &ReleasedAllocated,
298 bool ReturnsNullOnFailure = false) const;
Zhongxing Xuc0484fa2009-12-12 12:29:38 +0000299
Anna Zaks40a7eb32012-02-22 19:24:52 +0000300 ProgramStateRef ReallocMem(CheckerContext &C, const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000301 bool FreesMemOnFailure,
302 ProgramStateRef State) const;
303 static ProgramStateRef CallocMem(CheckerContext &C, const CallExpr *CE,
304 ProgramStateRef State);
Jordy Rose3597b212010-06-07 19:32:37 +0000305
Anna Zaks46d01602012-05-18 01:16:10 +0000306 ///\brief Check if the memory associated with this symbol was released.
307 bool isReleased(SymbolRef Sym, CheckerContext &C) const;
308
Anton Yartsev13df0362013-03-25 01:35:45 +0000309 bool checkUseAfterFree(SymbolRef Sym, CheckerContext &C, const Stmt *S) const;
Anna Zaksa1b227b2012-02-08 23:16:56 +0000310
Jordan Rose656fdd52014-01-08 18:46:55 +0000311 bool checkDoubleDelete(SymbolRef Sym, CheckerContext &C) const;
312
Anna Zaksa4bc5e12013-05-31 23:47:32 +0000313 /// Check if the function is known free memory, or if it is
Jordan Rose613f3c02013-03-09 00:59:10 +0000314 /// "interesting" and should be modeled explicitly.
315 ///
Anna Zaks8ebeb642013-06-08 00:29:29 +0000316 /// \param [out] EscapingSymbol A function might not free memory in general,
317 /// but could be known to free a particular symbol. In this case, false is
Anna Zaksa4bc5e12013-05-31 23:47:32 +0000318 /// returned and the single escaping symbol is returned through the out
319 /// parameter.
320 ///
Jordan Rose613f3c02013-03-09 00:59:10 +0000321 /// We assume that pointers do not escape through calls to system functions
322 /// not handled by this checker.
Anna Zaks8ebeb642013-06-08 00:29:29 +0000323 bool mayFreeAnyEscapedMemoryOrIsModeledExplicitly(const CallEvent *Call,
Anna Zaksa4bc5e12013-05-31 23:47:32 +0000324 ProgramStateRef State,
325 SymbolRef &EscapingSymbol) const;
Anna Zaks3d348342012-02-14 21:55:24 +0000326
Anna Zaks333481b2013-03-28 23:15:29 +0000327 // Implementation of the checkPointerEscape callabcks.
328 ProgramStateRef checkPointerEscapeAux(ProgramStateRef State,
329 const InvalidatedSymbols &Escaped,
330 const CallEvent *Call,
331 PointerEscapeKind Kind,
332 bool(*CheckRefState)(const RefState*)) const;
333
Anton Yartsev1e2bc9b2013-04-11 00:05:20 +0000334 ///@{
335 /// Tells if a given family/call/symbol is tracked by the current checker.
Anton Yartseve5c0c142015-02-18 00:39:06 +0000336 /// Looks through incoming CheckKind(s) and returns the kind of the checker
337 /// responsible for this family/call/symbol.
338 Optional<CheckKind> getCheckIfTracked(CheckKind CK,
339 AllocationFamily Family) const;
340 Optional<CheckKind> getCheckIfTracked(CKVecTy CKVec,
341 AllocationFamily Family) const;
342 Optional<CheckKind> getCheckIfTracked(CKVecTy CKVec, CheckerContext &C,
Alexander Kornienko4aca9b12014-02-11 21:49:21 +0000343 const Stmt *AllocDeallocStmt) const;
Anton Yartseve5c0c142015-02-18 00:39:06 +0000344 Optional<CheckKind> getCheckIfTracked(CKVecTy CKVec, CheckerContext &C,
345 SymbolRef Sym) const;
Anton Yartsev1e2bc9b2013-04-11 00:05:20 +0000346 ///@}
Ted Kremenek5ef32db2011-08-12 23:37:29 +0000347 static bool SummarizeValue(raw_ostream &os, SVal V);
348 static bool SummarizeRegion(raw_ostream &os, const MemRegion *MR);
Anton Yartsev05789592013-03-28 17:05:19 +0000349 void ReportBadFree(CheckerContext &C, SVal ArgVal, SourceRange Range,
350 const Expr *DeallocExpr) const;
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000351 void ReportFreeAlloca(CheckerContext &C, SVal ArgVal,
352 SourceRange Range) const;
Anton Yartseve3377fb2013-04-04 23:46:29 +0000353 void ReportMismatchedDealloc(CheckerContext &C, SourceRange Range,
Anton Yartsevf0593d62013-04-05 11:25:10 +0000354 const Expr *DeallocExpr, const RefState *RS,
Anton Yartsevf5bccce2013-09-16 17:51:25 +0000355 SymbolRef Sym, bool OwnershipTransferred) const;
Anton Yartsev05789592013-03-28 17:05:19 +0000356 void ReportOffsetFree(CheckerContext &C, SVal ArgVal, SourceRange Range,
357 const Expr *DeallocExpr,
Craig Topper0dbb7832014-05-27 02:45:47 +0000358 const Expr *AllocExpr = nullptr) const;
Anton Yartsev59ed15b2013-03-13 14:39:10 +0000359 void ReportUseAfterFree(CheckerContext &C, SourceRange Range,
360 SymbolRef Sym) const;
361 void ReportDoubleFree(CheckerContext &C, SourceRange Range, bool Released,
Anton Yartsev6c2af432013-03-13 17:07:32 +0000362 SymbolRef Sym, SymbolRef PrevSym) const;
Anna Zaks2b5bb972012-02-09 06:25:51 +0000363
Jordan Rose656fdd52014-01-08 18:46:55 +0000364 void ReportDoubleDelete(CheckerContext &C, SymbolRef Sym) const;
365
Anna Zaksdf901a42012-02-23 21:38:21 +0000366 /// Find the location of the allocation for Sym on the path leading to the
367 /// exploded node N.
Anna Zaksfc2e1532012-03-21 19:45:08 +0000368 LeakInfo getAllocationSite(const ExplodedNode *N, SymbolRef Sym,
369 CheckerContext &C) const;
Anna Zaksdf901a42012-02-23 21:38:21 +0000370
Anna Zaksd3571e5a2012-02-11 21:02:40 +0000371 void reportLeak(SymbolRef Sym, ExplodedNode *N, CheckerContext &C) const;
372
Anna Zaks2b5bb972012-02-09 06:25:51 +0000373 /// The bug visitor which allows us to print extra diagnostics along the
374 /// BugReport path. For example, showing the allocation site of the leaked
375 /// region.
Jordy Rosef78877e2012-03-24 02:45:35 +0000376 class MallocBugVisitor : public BugReporterVisitorImpl<MallocBugVisitor> {
Anna Zaks2b5bb972012-02-09 06:25:51 +0000377 protected:
Anna Zaks9eb7bc82012-02-16 22:26:07 +0000378 enum NotificationMode {
379 Normal,
Anna Zaks9eb7bc82012-02-16 22:26:07 +0000380 ReallocationFailed
381 };
382
Anna Zaks2b5bb972012-02-09 06:25:51 +0000383 // The allocated region symbol tracked by the main analysis.
384 SymbolRef Sym;
385
Anna Zaks62cce9e2012-05-10 01:37:40 +0000386 // The mode we are in, i.e. what kind of diagnostics will be emitted.
387 NotificationMode Mode;
Jordy Rose21ff76e2012-03-24 03:15:09 +0000388
Anna Zaks62cce9e2012-05-10 01:37:40 +0000389 // A symbol from when the primary region should have been reallocated.
390 SymbolRef FailedReallocSymbol;
Jordy Rose21ff76e2012-03-24 03:15:09 +0000391
Anna Zaks62cce9e2012-05-10 01:37:40 +0000392 bool IsLeak;
393
394 public:
395 MallocBugVisitor(SymbolRef S, bool isLeak = false)
Craig Topper0dbb7832014-05-27 02:45:47 +0000396 : Sym(S), Mode(Normal), FailedReallocSymbol(nullptr), IsLeak(isLeak) {}
Jordy Rose21ff76e2012-03-24 03:15:09 +0000397
Anna Zaks2b5bb972012-02-09 06:25:51 +0000398 virtual ~MallocBugVisitor() {}
399
Craig Topperfb6b25b2014-03-15 04:29:04 +0000400 void Profile(llvm::FoldingSetNodeID &ID) const override {
Anna Zaks2b5bb972012-02-09 06:25:51 +0000401 static int X = 0;
402 ID.AddPointer(&X);
403 ID.AddPointer(Sym);
404 }
405
Anna Zaks9eb7bc82012-02-16 22:26:07 +0000406 inline bool isAllocated(const RefState *S, const RefState *SPrev,
407 const Stmt *Stmt) {
Anna Zaks2b5bb972012-02-09 06:25:51 +0000408 // Did not track -> allocated. Other state (released) -> allocated.
Anton Yartsev13df0362013-03-25 01:35:45 +0000409 return (Stmt && (isa<CallExpr>(Stmt) || isa<CXXNewExpr>(Stmt)) &&
Anna Zaks9eb7bc82012-02-16 22:26:07 +0000410 (S && S->isAllocated()) && (!SPrev || !SPrev->isAllocated()));
Anna Zaks2b5bb972012-02-09 06:25:51 +0000411 }
412
Anna Zaks9eb7bc82012-02-16 22:26:07 +0000413 inline bool isReleased(const RefState *S, const RefState *SPrev,
414 const Stmt *Stmt) {
Anna Zaks2b5bb972012-02-09 06:25:51 +0000415 // Did not track -> released. Other state (allocated) -> released.
Anton Yartsev13df0362013-03-25 01:35:45 +0000416 return (Stmt && (isa<CallExpr>(Stmt) || isa<CXXDeleteExpr>(Stmt)) &&
Anna Zaks9eb7bc82012-02-16 22:26:07 +0000417 (S && S->isReleased()) && (!SPrev || !SPrev->isReleased()));
418 }
419
Anna Zaks0d6989b2012-06-22 02:04:31 +0000420 inline bool isRelinquished(const RefState *S, const RefState *SPrev,
421 const Stmt *Stmt) {
422 // Did not track -> relinquished. Other state (allocated) -> relinquished.
423 return (Stmt && (isa<CallExpr>(Stmt) || isa<ObjCMessageExpr>(Stmt) ||
424 isa<ObjCPropertyRefExpr>(Stmt)) &&
425 (S && S->isRelinquished()) &&
426 (!SPrev || !SPrev->isRelinquished()));
427 }
428
Anna Zaks9eb7bc82012-02-16 22:26:07 +0000429 inline bool isReallocFailedCheck(const RefState *S, const RefState *SPrev,
430 const Stmt *Stmt) {
431 // If the expression is not a call, and the state change is
432 // released -> allocated, it must be the realloc return value
433 // check. If we have to handle more cases here, it might be cleaner just
434 // to track this extra bit in the state itself.
435 return ((!Stmt || !isa<CallExpr>(Stmt)) &&
436 (S && S->isAllocated()) && (SPrev && !SPrev->isAllocated()));
Anna Zaks2b5bb972012-02-09 06:25:51 +0000437 }
438
439 PathDiagnosticPiece *VisitNode(const ExplodedNode *N,
440 const ExplodedNode *PrevN,
441 BugReporterContext &BRC,
Craig Topperfb6b25b2014-03-15 04:29:04 +0000442 BugReport &BR) override;
Anna Zaks62cce9e2012-05-10 01:37:40 +0000443
David Blaikied15481c2014-08-29 18:18:43 +0000444 std::unique_ptr<PathDiagnosticPiece>
445 getEndPath(BugReporterContext &BRC, const ExplodedNode *EndPathNode,
446 BugReport &BR) override {
Anna Zaks62cce9e2012-05-10 01:37:40 +0000447 if (!IsLeak)
Craig Topper0dbb7832014-05-27 02:45:47 +0000448 return nullptr;
Anna Zaks62cce9e2012-05-10 01:37:40 +0000449
450 PathDiagnosticLocation L =
451 PathDiagnosticLocation::createEndOfPath(EndPathNode,
452 BRC.getSourceManager());
453 // Do not add the statement itself as a range in case of leak.
David Blaikied15481c2014-08-29 18:18:43 +0000454 return llvm::make_unique<PathDiagnosticEventPiece>(L, BR.getDescription(),
455 false);
Anna Zaks62cce9e2012-05-10 01:37:40 +0000456 }
457
Anna Zakscba4f292012-03-16 23:24:20 +0000458 private:
459 class StackHintGeneratorForReallocationFailed
460 : public StackHintGeneratorForSymbol {
461 public:
462 StackHintGeneratorForReallocationFailed(SymbolRef S, StringRef M)
463 : StackHintGeneratorForSymbol(S, M) {}
464
Craig Topperfb6b25b2014-03-15 04:29:04 +0000465 std::string getMessageForArg(const Expr *ArgE,
466 unsigned ArgIndex) override {
Jordan Rosec102b352012-09-22 01:24:42 +0000467 // Printed parameters start at 1, not 0.
468 ++ArgIndex;
469
Anna Zakscba4f292012-03-16 23:24:20 +0000470 SmallString<200> buf;
471 llvm::raw_svector_ostream os(buf);
472
Jordan Rosec102b352012-09-22 01:24:42 +0000473 os << "Reallocation of " << ArgIndex << llvm::getOrdinalSuffix(ArgIndex)
474 << " parameter failed";
Anna Zakscba4f292012-03-16 23:24:20 +0000475
476 return os.str();
477 }
478
Craig Topperfb6b25b2014-03-15 04:29:04 +0000479 std::string getMessageForReturn(const CallExpr *CallExpr) override {
Anna Zaksa7f457a2012-03-16 23:44:28 +0000480 return "Reallocation of returned value failed";
Anna Zakscba4f292012-03-16 23:24:20 +0000481 }
482 };
Anna Zaks2b5bb972012-02-09 06:25:51 +0000483 };
Zhongxing Xu88cca6b2009-11-12 08:38:56 +0000484};
Kovarththanan Rajaratnam65c65662009-11-28 06:07:30 +0000485} // end anonymous namespace
Zhongxing Xu88cca6b2009-11-12 08:38:56 +0000486
Jordan Rose0c153cb2012-11-02 01:54:06 +0000487REGISTER_MAP_WITH_PROGRAMSTATE(RegionState, SymbolRef, RefState)
488REGISTER_MAP_WITH_PROGRAMSTATE(ReallocPairs, SymbolRef, ReallocPair)
Zhongxing Xu88cca6b2009-11-12 08:38:56 +0000489
Anna Zaks67291b92012-11-13 03:18:01 +0000490// A map from the freed symbol to the symbol representing the return value of
491// the free function.
492REGISTER_MAP_WITH_PROGRAMSTATE(FreeReturnValue, SymbolRef, SymbolRef)
493
Anna Zaksbb1ef902012-02-11 21:02:35 +0000494namespace {
495class StopTrackingCallback : public SymbolVisitor {
496 ProgramStateRef state;
497public:
498 StopTrackingCallback(ProgramStateRef st) : state(st) {}
499 ProgramStateRef getState() const { return state; }
500
Craig Topperfb6b25b2014-03-15 04:29:04 +0000501 bool VisitSymbol(SymbolRef sym) override {
Anna Zaksbb1ef902012-02-11 21:02:35 +0000502 state = state->remove<RegionState>(sym);
503 return true;
504 }
505};
506} // end anonymous namespace
507
Anna Zaks3d348342012-02-14 21:55:24 +0000508void MallocChecker::initIdentifierInfo(ASTContext &Ctx) const {
Anna Zaksb3436602012-05-18 22:47:40 +0000509 if (II_malloc)
510 return;
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000511 II_alloca = &Ctx.Idents.get("alloca");
Anna Zaksb3436602012-05-18 22:47:40 +0000512 II_malloc = &Ctx.Idents.get("malloc");
513 II_free = &Ctx.Idents.get("free");
514 II_realloc = &Ctx.Idents.get("realloc");
515 II_reallocf = &Ctx.Idents.get("reallocf");
516 II_calloc = &Ctx.Idents.get("calloc");
517 II_valloc = &Ctx.Idents.get("valloc");
518 II_strdup = &Ctx.Idents.get("strdup");
519 II_strndup = &Ctx.Idents.get("strndup");
Jordan Rose6b33c6f2014-03-26 17:05:46 +0000520 II_kmalloc = &Ctx.Idents.get("kmalloc");
Anna Zaksd79b8402014-10-03 21:48:59 +0000521 II_if_nameindex = &Ctx.Idents.get("if_nameindex");
522 II_if_freenameindex = &Ctx.Idents.get("if_freenameindex");
Anna Zaksc68bf4c2012-02-08 20:13:28 +0000523}
524
Anna Zaks3d348342012-02-14 21:55:24 +0000525bool MallocChecker::isMemFunction(const FunctionDecl *FD, ASTContext &C) const {
Anna Zaksd79b8402014-10-03 21:48:59 +0000526 if (isCMemFunction(FD, C, AF_Malloc, MemoryOperationKind::MOK_Any))
Anna Zaks46d01602012-05-18 01:16:10 +0000527 return true;
528
Anna Zaksd79b8402014-10-03 21:48:59 +0000529 if (isCMemFunction(FD, C, AF_IfNameIndex, MemoryOperationKind::MOK_Any))
Anna Zaks46d01602012-05-18 01:16:10 +0000530 return true;
531
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000532 if (isCMemFunction(FD, C, AF_Alloca, MemoryOperationKind::MOK_Any))
533 return true;
534
Anton Yartsev13df0362013-03-25 01:35:45 +0000535 if (isStandardNewDelete(FD, C))
536 return true;
537
Anna Zaks46d01602012-05-18 01:16:10 +0000538 return false;
539}
540
Anna Zaksd79b8402014-10-03 21:48:59 +0000541bool MallocChecker::isCMemFunction(const FunctionDecl *FD,
542 ASTContext &C,
543 AllocationFamily Family,
Benjamin Kramer719772c2014-10-03 22:20:30 +0000544 MemoryOperationKind MemKind) const {
Anna Zaksd1ff1cb2012-02-15 02:12:00 +0000545 if (!FD)
546 return false;
Anna Zaks46d01602012-05-18 01:16:10 +0000547
Anna Zaksd79b8402014-10-03 21:48:59 +0000548 bool CheckFree = (MemKind == MemoryOperationKind::MOK_Any ||
549 MemKind == MemoryOperationKind::MOK_Free);
550 bool CheckAlloc = (MemKind == MemoryOperationKind::MOK_Any ||
551 MemKind == MemoryOperationKind::MOK_Allocate);
552
Jordan Rose6cd16c52012-07-10 23:13:01 +0000553 if (FD->getKind() == Decl::Function) {
Anna Zaksd79b8402014-10-03 21:48:59 +0000554 const IdentifierInfo *FunI = FD->getIdentifier();
Jordan Rose6cd16c52012-07-10 23:13:01 +0000555 initIdentifierInfo(C);
Anna Zaks3d348342012-02-14 21:55:24 +0000556
Anna Zaksd79b8402014-10-03 21:48:59 +0000557 if (Family == AF_Malloc && CheckFree) {
558 if (FunI == II_free || FunI == II_realloc || FunI == II_reallocf)
559 return true;
560 }
561
562 if (Family == AF_Malloc && CheckAlloc) {
563 if (FunI == II_malloc || FunI == II_realloc || FunI == II_reallocf ||
564 FunI == II_calloc || FunI == II_valloc || FunI == II_strdup ||
565 FunI == II_strndup || FunI == II_kmalloc)
566 return true;
567 }
568
569 if (Family == AF_IfNameIndex && CheckFree) {
570 if (FunI == II_if_freenameindex)
571 return true;
572 }
573
574 if (Family == AF_IfNameIndex && CheckAlloc) {
575 if (FunI == II_if_nameindex)
576 return true;
577 }
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000578
579 if (Family == AF_Alloca && CheckAlloc) {
Anton Yartsevc38d7952015-03-03 22:58:46 +0000580 if (FunI == II_alloca)
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000581 return true;
582 }
Jordan Rose6cd16c52012-07-10 23:13:01 +0000583 }
Anna Zaks3d348342012-02-14 21:55:24 +0000584
Anna Zaksd79b8402014-10-03 21:48:59 +0000585 if (Family != AF_Malloc)
Anna Zaks46d01602012-05-18 01:16:10 +0000586 return false;
587
Gabor Horvathe40c71c2015-03-04 17:59:34 +0000588 if (IsOptimistic && FD->hasAttrs()) {
Anna Zaksd79b8402014-10-03 21:48:59 +0000589 for (const auto *I : FD->specific_attrs<OwnershipAttr>()) {
590 OwnershipAttr::OwnershipKind OwnKind = I->getOwnKind();
591 if(OwnKind == OwnershipAttr::Takes || OwnKind == OwnershipAttr::Holds) {
592 if (CheckFree)
593 return true;
594 } else if (OwnKind == OwnershipAttr::Returns) {
595 if (CheckAlloc)
596 return true;
597 }
598 }
Jordan Rose6cd16c52012-07-10 23:13:01 +0000599 }
Anna Zaks3d348342012-02-14 21:55:24 +0000600
Anna Zaks3d348342012-02-14 21:55:24 +0000601 return false;
602}
603
Anton Yartsev8b662702013-03-28 16:10:38 +0000604// Tells if the callee is one of the following:
605// 1) A global non-placement new/delete operator function.
606// 2) A global placement operator function with the single placement argument
607// of type std::nothrow_t.
Anton Yartsev13df0362013-03-25 01:35:45 +0000608bool MallocChecker::isStandardNewDelete(const FunctionDecl *FD,
609 ASTContext &C) const {
610 if (!FD)
611 return false;
612
613 OverloadedOperatorKind Kind = FD->getOverloadedOperator();
614 if (Kind != OO_New && Kind != OO_Array_New &&
615 Kind != OO_Delete && Kind != OO_Array_Delete)
616 return false;
617
Anton Yartsev8b662702013-03-28 16:10:38 +0000618 // Skip all operator new/delete methods.
619 if (isa<CXXMethodDecl>(FD))
Anton Yartsev13df0362013-03-25 01:35:45 +0000620 return false;
621
622 // Return true if tested operator is a standard placement nothrow operator.
623 if (FD->getNumParams() == 2) {
624 QualType T = FD->getParamDecl(1)->getType();
625 if (const IdentifierInfo *II = T.getBaseTypeIdentifier())
626 return II->getName().equals("nothrow_t");
627 }
628
629 // Skip placement operators.
630 if (FD->getNumParams() != 1 || FD->isVariadic())
631 return false;
632
633 // One of the standard new/new[]/delete/delete[] non-placement operators.
634 return true;
635}
636
Jordan Rose6b33c6f2014-03-26 17:05:46 +0000637llvm::Optional<ProgramStateRef> MallocChecker::performKernelMalloc(
638 const CallExpr *CE, CheckerContext &C, const ProgramStateRef &State) const {
639 // 3-argument malloc(), as commonly used in {Free,Net,Open}BSD Kernels:
640 //
641 // void *malloc(unsigned long size, struct malloc_type *mtp, int flags);
642 //
643 // One of the possible flags is M_ZERO, which means 'give me back an
644 // allocation which is already zeroed', like calloc.
645
646 // 2-argument kmalloc(), as used in the Linux kernel:
647 //
648 // void *kmalloc(size_t size, gfp_t flags);
649 //
650 // Has the similar flag value __GFP_ZERO.
651
652 // This logic is largely cloned from O_CREAT in UnixAPIChecker, maybe some
653 // code could be shared.
654
655 ASTContext &Ctx = C.getASTContext();
656 llvm::Triple::OSType OS = Ctx.getTargetInfo().getTriple().getOS();
657
658 if (!KernelZeroFlagVal.hasValue()) {
659 if (OS == llvm::Triple::FreeBSD)
660 KernelZeroFlagVal = 0x0100;
661 else if (OS == llvm::Triple::NetBSD)
662 KernelZeroFlagVal = 0x0002;
663 else if (OS == llvm::Triple::OpenBSD)
664 KernelZeroFlagVal = 0x0008;
665 else if (OS == llvm::Triple::Linux)
666 // __GFP_ZERO
667 KernelZeroFlagVal = 0x8000;
668 else
669 // FIXME: We need a more general way of getting the M_ZERO value.
670 // See also: O_CREAT in UnixAPIChecker.cpp.
671
672 // Fall back to normal malloc behavior on platforms where we don't
673 // know M_ZERO.
674 return None;
675 }
676
677 // We treat the last argument as the flags argument, and callers fall-back to
678 // normal malloc on a None return. This works for the FreeBSD kernel malloc
679 // as well as Linux kmalloc.
680 if (CE->getNumArgs() < 2)
681 return None;
682
683 const Expr *FlagsEx = CE->getArg(CE->getNumArgs() - 1);
684 const SVal V = State->getSVal(FlagsEx, C.getLocationContext());
685 if (!V.getAs<NonLoc>()) {
686 // The case where 'V' can be a location can only be due to a bad header,
687 // so in this case bail out.
688 return None;
689 }
690
691 NonLoc Flags = V.castAs<NonLoc>();
692 NonLoc ZeroFlag = C.getSValBuilder()
693 .makeIntVal(KernelZeroFlagVal.getValue(), FlagsEx->getType())
694 .castAs<NonLoc>();
695 SVal MaskedFlagsUC = C.getSValBuilder().evalBinOpNN(State, BO_And,
696 Flags, ZeroFlag,
697 FlagsEx->getType());
698 if (MaskedFlagsUC.isUnknownOrUndef())
699 return None;
700 DefinedSVal MaskedFlags = MaskedFlagsUC.castAs<DefinedSVal>();
701
702 // Check if maskedFlags is non-zero.
703 ProgramStateRef TrueState, FalseState;
704 std::tie(TrueState, FalseState) = State->assume(MaskedFlags);
705
706 // If M_ZERO is set, treat this like calloc (initialized).
707 if (TrueState && !FalseState) {
708 SVal ZeroVal = C.getSValBuilder().makeZeroVal(Ctx.CharTy);
709 return MallocMemAux(C, CE, CE->getArg(0), ZeroVal, TrueState);
710 }
711
712 return None;
713}
714
Anna Zaksc68bf4c2012-02-08 20:13:28 +0000715void MallocChecker::checkPostStmt(const CallExpr *CE, CheckerContext &C) const {
Jordan Rosed6e5fd52012-09-20 01:55:32 +0000716 if (C.wasInlined)
717 return;
Jordan Rose6b33c6f2014-03-26 17:05:46 +0000718
Anna Zaksc68bf4c2012-02-08 20:13:28 +0000719 const FunctionDecl *FD = C.getCalleeDecl(CE);
720 if (!FD)
721 return;
Zhongxing Xu88cca6b2009-11-12 08:38:56 +0000722
Anna Zaks40a7eb32012-02-22 19:24:52 +0000723 ProgramStateRef State = C.getState();
Anna Zaksfe6eb672012-08-24 02:28:20 +0000724 bool ReleasedAllocatedMemory = false;
Jordan Rose6cd16c52012-07-10 23:13:01 +0000725
726 if (FD->getKind() == Decl::Function) {
727 initIdentifierInfo(C.getASTContext());
728 IdentifierInfo *FunI = FD->getIdentifier();
729
Jordan Rose6b33c6f2014-03-26 17:05:46 +0000730 if (FunI == II_malloc) {
731 if (CE->getNumArgs() < 1)
732 return;
733 if (CE->getNumArgs() < 3) {
734 State = MallocMemAux(C, CE, CE->getArg(0), UndefinedVal(), State);
735 } else if (CE->getNumArgs() == 3) {
736 llvm::Optional<ProgramStateRef> MaybeState =
737 performKernelMalloc(CE, C, State);
738 if (MaybeState.hasValue())
739 State = MaybeState.getValue();
740 else
741 State = MallocMemAux(C, CE, CE->getArg(0), UndefinedVal(), State);
742 }
743 } else if (FunI == II_kmalloc) {
744 llvm::Optional<ProgramStateRef> MaybeState =
745 performKernelMalloc(CE, C, State);
746 if (MaybeState.hasValue())
747 State = MaybeState.getValue();
748 else
749 State = MallocMemAux(C, CE, CE->getArg(0), UndefinedVal(), State);
750 } else if (FunI == II_valloc) {
Anton Yartseve3377fb2013-04-04 23:46:29 +0000751 if (CE->getNumArgs() < 1)
752 return;
753 State = MallocMemAux(C, CE, CE->getArg(0), UndefinedVal(), State);
754 } else if (FunI == II_realloc) {
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000755 State = ReallocMem(C, CE, false, State);
Anton Yartseve3377fb2013-04-04 23:46:29 +0000756 } else if (FunI == II_reallocf) {
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000757 State = ReallocMem(C, CE, true, State);
Anton Yartseve3377fb2013-04-04 23:46:29 +0000758 } else if (FunI == II_calloc) {
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000759 State = CallocMem(C, CE, State);
Anton Yartseve3377fb2013-04-04 23:46:29 +0000760 } else if (FunI == II_free) {
761 State = FreeMemAux(C, CE, State, 0, false, ReleasedAllocatedMemory);
762 } else if (FunI == II_strdup) {
763 State = MallocUpdateRefState(C, CE, State);
764 } else if (FunI == II_strndup) {
765 State = MallocUpdateRefState(C, CE, State);
Anton Yartsevc38d7952015-03-03 22:58:46 +0000766 } else if (FunI == II_alloca) {
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +0000767 State = MallocMemAux(C, CE, CE->getArg(0), UndefinedVal(), State,
768 AF_Alloca);
769 } else if (isStandardNewDelete(FD, C.getASTContext())) {
Anton Yartseve3377fb2013-04-04 23:46:29 +0000770 // Process direct calls to operator new/new[]/delete/delete[] functions
771 // as distinct from new/new[]/delete/delete[] expressions that are
772 // processed by the checkPostStmt callbacks for CXXNewExpr and
773 // CXXDeleteExpr.
774 OverloadedOperatorKind K = FD->getOverloadedOperator();
775 if (K == OO_New)
776 State = MallocMemAux(C, CE, CE->getArg(0), UndefinedVal(), State,
777 AF_CXXNew);
778 else if (K == OO_Array_New)
779 State = MallocMemAux(C, CE, CE->getArg(0), UndefinedVal(), State,
780 AF_CXXNewArray);
781 else if (K == OO_Delete || K == OO_Array_Delete)
782 State = FreeMemAux(C, CE, State, 0, false, ReleasedAllocatedMemory);
783 else
784 llvm_unreachable("not a new/delete operator");
Anna Zaksd79b8402014-10-03 21:48:59 +0000785 } else if (FunI == II_if_nameindex) {
786 // Should we model this differently? We can allocate a fixed number of
787 // elements with zeros in the last one.
788 State = MallocMemAux(C, CE, UnknownVal(), UnknownVal(), State,
789 AF_IfNameIndex);
790 } else if (FunI == II_if_freenameindex) {
791 State = FreeMemAux(C, CE, State, 0, false, ReleasedAllocatedMemory);
Jordan Rose6cd16c52012-07-10 23:13:01 +0000792 }
793 }
794
Gabor Horvathe40c71c2015-03-04 17:59:34 +0000795 if (IsOptimistic || ChecksEnabled[CK_MismatchedDeallocatorChecker]) {
Anna Zaks40a7eb32012-02-22 19:24:52 +0000796 // Check all the attributes, if there are any.
797 // There can be multiple of these attributes.
798 if (FD->hasAttrs())
Aaron Ballmanbe22bcb2014-03-10 17:08:28 +0000799 for (const auto *I : FD->specific_attrs<OwnershipAttr>()) {
800 switch (I->getOwnKind()) {
Anna Zaks40a7eb32012-02-22 19:24:52 +0000801 case OwnershipAttr::Returns:
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000802 State = MallocMemReturnsAttr(C, CE, I, State);
Anna Zaks40a7eb32012-02-22 19:24:52 +0000803 break;
804 case OwnershipAttr::Takes:
805 case OwnershipAttr::Holds:
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000806 State = FreeMemAttr(C, CE, I, State);
Anna Zaks40a7eb32012-02-22 19:24:52 +0000807 break;
808 }
809 }
Zhongxing Xu527ff6d2010-06-01 03:01:33 +0000810 }
Anna Zaks199e8e52012-02-22 03:14:20 +0000811 C.addTransition(State);
Zhongxing Xuc0484fa2009-12-12 12:29:38 +0000812}
813
Anton Yartsev4e4cb6b2014-08-05 18:26:05 +0000814static QualType getDeepPointeeType(QualType T) {
815 QualType Result = T, PointeeType = T->getPointeeType();
816 while (!PointeeType.isNull()) {
817 Result = PointeeType;
818 PointeeType = PointeeType->getPointeeType();
819 }
820 return Result;
821}
822
823static bool treatUnusedNewEscaped(const CXXNewExpr *NE) {
824
825 const CXXConstructExpr *ConstructE = NE->getConstructExpr();
826 if (!ConstructE)
827 return false;
828
829 if (!NE->getAllocatedType()->getAsCXXRecordDecl())
830 return false;
831
832 const CXXConstructorDecl *CtorD = ConstructE->getConstructor();
833
834 // Iterate over the constructor parameters.
835 for (const auto *CtorParam : CtorD->params()) {
836
837 QualType CtorParamPointeeT = CtorParam->getType()->getPointeeType();
838 if (CtorParamPointeeT.isNull())
839 continue;
840
841 CtorParamPointeeT = getDeepPointeeType(CtorParamPointeeT);
842
843 if (CtorParamPointeeT->getAsCXXRecordDecl())
844 return true;
845 }
846
847 return false;
848}
849
Anton Yartsev13df0362013-03-25 01:35:45 +0000850void MallocChecker::checkPostStmt(const CXXNewExpr *NE,
851 CheckerContext &C) const {
852
853 if (NE->getNumPlacementArgs())
854 for (CXXNewExpr::const_arg_iterator I = NE->placement_arg_begin(),
855 E = NE->placement_arg_end(); I != E; ++I)
856 if (SymbolRef Sym = C.getSVal(*I).getAsSymbol())
857 checkUseAfterFree(Sym, C, *I);
858
Anton Yartsev13df0362013-03-25 01:35:45 +0000859 if (!isStandardNewDelete(NE->getOperatorNew(), C.getASTContext()))
860 return;
861
Anton Yartsev4e4cb6b2014-08-05 18:26:05 +0000862 ParentMap &PM = C.getLocationContext()->getParentMap();
863 if (!PM.isConsumedExpr(NE) && treatUnusedNewEscaped(NE))
864 return;
865
Anton Yartsev13df0362013-03-25 01:35:45 +0000866 ProgramStateRef State = C.getState();
867 // The return value from operator new is bound to a specified initialization
868 // value (if any) and we don't want to loose this value. So we call
869 // MallocUpdateRefState() instead of MallocMemAux() which breakes the
870 // existing binding.
Anton Yartsev05789592013-03-28 17:05:19 +0000871 State = MallocUpdateRefState(C, NE, State, NE->isArray() ? AF_CXXNewArray
872 : AF_CXXNew);
Anton Yartsev13df0362013-03-25 01:35:45 +0000873 C.addTransition(State);
874}
875
876void MallocChecker::checkPreStmt(const CXXDeleteExpr *DE,
877 CheckerContext &C) const {
878
Alexander Kornienko4aca9b12014-02-11 21:49:21 +0000879 if (!ChecksEnabled[CK_NewDeleteChecker])
Anton Yartsev13df0362013-03-25 01:35:45 +0000880 if (SymbolRef Sym = C.getSVal(DE->getArgument()).getAsSymbol())
881 checkUseAfterFree(Sym, C, DE->getArgument());
882
Anton Yartsev13df0362013-03-25 01:35:45 +0000883 if (!isStandardNewDelete(DE->getOperatorDelete(), C.getASTContext()))
884 return;
885
886 ProgramStateRef State = C.getState();
887 bool ReleasedAllocated;
888 State = FreeMemAux(C, DE->getArgument(), DE, State,
889 /*Hold*/false, ReleasedAllocated);
890
891 C.addTransition(State);
892}
893
Jordan Rose613f3c02013-03-09 00:59:10 +0000894static bool isKnownDeallocObjCMethodName(const ObjCMethodCall &Call) {
895 // If the first selector piece is one of the names below, assume that the
896 // object takes ownership of the memory, promising to eventually deallocate it
897 // with free().
898 // Ex: [NSData dataWithBytesNoCopy:bytes length:10];
899 // (...unless a 'freeWhenDone' parameter is false, but that's checked later.)
900 StringRef FirstSlot = Call.getSelector().getNameForSlot(0);
901 if (FirstSlot == "dataWithBytesNoCopy" ||
902 FirstSlot == "initWithBytesNoCopy" ||
903 FirstSlot == "initWithCharactersNoCopy")
904 return true;
Anna Zaks0d6989b2012-06-22 02:04:31 +0000905
906 return false;
907}
908
Jordan Rose613f3c02013-03-09 00:59:10 +0000909static Optional<bool> getFreeWhenDoneArg(const ObjCMethodCall &Call) {
910 Selector S = Call.getSelector();
911
912 // FIXME: We should not rely on fully-constrained symbols being folded.
913 for (unsigned i = 1; i < S.getNumArgs(); ++i)
914 if (S.getNameForSlot(i).equals("freeWhenDone"))
915 return !Call.getArgSVal(i).isZeroConstant();
916
917 return None;
918}
919
Anna Zaks67291b92012-11-13 03:18:01 +0000920void MallocChecker::checkPostObjCMessage(const ObjCMethodCall &Call,
921 CheckerContext &C) const {
Anna Zaksa7b1c472012-12-11 00:17:53 +0000922 if (C.wasInlined)
923 return;
924
Jordan Rose613f3c02013-03-09 00:59:10 +0000925 if (!isKnownDeallocObjCMethodName(Call))
926 return;
Anna Zaks67291b92012-11-13 03:18:01 +0000927
Jordan Rose613f3c02013-03-09 00:59:10 +0000928 if (Optional<bool> FreeWhenDone = getFreeWhenDoneArg(Call))
929 if (!*FreeWhenDone)
930 return;
931
932 bool ReleasedAllocatedMemory;
933 ProgramStateRef State = FreeMemAux(C, Call.getArgExpr(0),
934 Call.getOriginExpr(), C.getState(),
935 /*Hold=*/true, ReleasedAllocatedMemory,
936 /*RetNullOnFailure=*/true);
937
938 C.addTransition(State);
Anna Zaks0d6989b2012-06-22 02:04:31 +0000939}
940
Richard Smith852e9ce2013-11-27 01:46:48 +0000941ProgramStateRef
942MallocChecker::MallocMemReturnsAttr(CheckerContext &C, const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000943 const OwnershipAttr *Att,
944 ProgramStateRef State) const {
945 if (!State)
946 return nullptr;
947
Richard Smith852e9ce2013-11-27 01:46:48 +0000948 if (Att->getModule() != II_malloc)
Craig Topper0dbb7832014-05-27 02:45:47 +0000949 return nullptr;
Ted Kremenekd21139a2010-07-31 01:52:11 +0000950
Alexis Huntdcfba7b2010-08-18 23:23:40 +0000951 OwnershipAttr::args_iterator I = Att->args_begin(), E = Att->args_end();
Ted Kremenekd21139a2010-07-31 01:52:11 +0000952 if (I != E) {
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000953 return MallocMemAux(C, CE, CE->getArg(*I), UndefinedVal(), State);
Ted Kremenekd21139a2010-07-31 01:52:11 +0000954 }
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000955 return MallocMemAux(C, CE, UnknownVal(), UndefinedVal(), State);
956}
957
958ProgramStateRef MallocChecker::MallocMemAux(CheckerContext &C,
959 const CallExpr *CE,
960 const Expr *SizeEx, SVal Init,
961 ProgramStateRef State,
962 AllocationFamily Family) {
963 if (!State)
964 return nullptr;
965
966 return MallocMemAux(C, CE, State->getSVal(SizeEx, C.getLocationContext()),
967 Init, State, Family);
Ted Kremenekd21139a2010-07-31 01:52:11 +0000968}
969
Anna Zaksc68bf4c2012-02-08 20:13:28 +0000970ProgramStateRef MallocChecker::MallocMemAux(CheckerContext &C,
Zhongxing Xuc0484fa2009-12-12 12:29:38 +0000971 const CallExpr *CE,
Zhongxing Xu527ff6d2010-06-01 03:01:33 +0000972 SVal Size, SVal Init,
Anton Yartsev05789592013-03-28 17:05:19 +0000973 ProgramStateRef State,
974 AllocationFamily Family) {
Anton Yartsevb3fa86d2015-02-10 20:13:08 +0000975 if (!State)
976 return nullptr;
Anna Zaks3563fde2012-06-07 03:57:32 +0000977
Jordan Rosef69e65f2014-09-05 16:33:51 +0000978 // We expect the malloc functions to return a pointer.
979 if (!Loc::isLocType(CE->getType()))
980 return nullptr;
981
Anna Zaks3563fde2012-06-07 03:57:32 +0000982 // Bind the return value to the symbolic value from the heap region.
983 // TODO: We could rewrite post visit to eval call; 'malloc' does not have
984 // side effects other than what we model here.
Ted Kremenekd94854a2012-08-22 06:26:15 +0000985 unsigned Count = C.blockCount();
Anna Zaks3563fde2012-06-07 03:57:32 +0000986 SValBuilder &svalBuilder = C.getSValBuilder();
987 const LocationContext *LCtx = C.getPredecessor()->getLocationContext();
David Blaikie2fdacbc2013-02-20 05:52:05 +0000988 DefinedSVal RetVal = svalBuilder.getConjuredHeapSymbolVal(CE, LCtx, Count)
989 .castAs<DefinedSVal>();
Anton Yartsev05789592013-03-28 17:05:19 +0000990 State = State->BindExpr(CE, C.getLocationContext(), RetVal);
Zhongxing Xu9cb53b82009-12-11 03:09:01 +0000991
Jordy Rose674bd552010-07-04 00:00:41 +0000992 // Fill the region with the initialization value.
Anton Yartsev05789592013-03-28 17:05:19 +0000993 State = State->bindDefault(RetVal, Init);
Zhongxing Xu527ff6d2010-06-01 03:01:33 +0000994
Jordy Rose674bd552010-07-04 00:00:41 +0000995 // Set the region's extent equal to the Size parameter.
Anna Zaks31886862012-02-10 01:11:00 +0000996 const SymbolicRegion *R =
Anna Zaks3563fde2012-06-07 03:57:32 +0000997 dyn_cast_or_null<SymbolicRegion>(RetVal.getAsRegion());
Anna Zaks199e8e52012-02-22 03:14:20 +0000998 if (!R)
Craig Topper0dbb7832014-05-27 02:45:47 +0000999 return nullptr;
David Blaikie05785d12013-02-20 22:23:23 +00001000 if (Optional<DefinedOrUnknownSVal> DefinedSize =
David Blaikie2fdacbc2013-02-20 05:52:05 +00001001 Size.getAs<DefinedOrUnknownSVal>()) {
Anna Zaks40a7eb32012-02-22 19:24:52 +00001002 SValBuilder &svalBuilder = C.getSValBuilder();
Anna Zaks199e8e52012-02-22 03:14:20 +00001003 DefinedOrUnknownSVal Extent = R->getExtent(svalBuilder);
Anna Zaks199e8e52012-02-22 03:14:20 +00001004 DefinedOrUnknownSVal extentMatchesSize =
Anton Yartsev05789592013-03-28 17:05:19 +00001005 svalBuilder.evalEQ(State, Extent, *DefinedSize);
Anna Zaks31886862012-02-10 01:11:00 +00001006
Anton Yartsev05789592013-03-28 17:05:19 +00001007 State = State->assume(extentMatchesSize, true);
1008 assert(State);
Anna Zaks199e8e52012-02-22 03:14:20 +00001009 }
Ted Kremenek90af9092010-12-02 07:49:45 +00001010
Anton Yartsev05789592013-03-28 17:05:19 +00001011 return MallocUpdateRefState(C, CE, State, Family);
Anna Zaks40a7eb32012-02-22 19:24:52 +00001012}
1013
1014ProgramStateRef MallocChecker::MallocUpdateRefState(CheckerContext &C,
Anton Yartsev13df0362013-03-25 01:35:45 +00001015 const Expr *E,
Anton Yartsev05789592013-03-28 17:05:19 +00001016 ProgramStateRef State,
1017 AllocationFamily Family) {
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001018 if (!State)
1019 return nullptr;
1020
Anna Zaks40a7eb32012-02-22 19:24:52 +00001021 // Get the return value.
Anton Yartsev05789592013-03-28 17:05:19 +00001022 SVal retVal = State->getSVal(E, C.getLocationContext());
Anna Zaks40a7eb32012-02-22 19:24:52 +00001023
1024 // We expect the malloc functions to return a pointer.
David Blaikie2fdacbc2013-02-20 05:52:05 +00001025 if (!retVal.getAs<Loc>())
Craig Topper0dbb7832014-05-27 02:45:47 +00001026 return nullptr;
Anna Zaks40a7eb32012-02-22 19:24:52 +00001027
Ted Kremenek90af9092010-12-02 07:49:45 +00001028 SymbolRef Sym = retVal.getAsLocSymbol();
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001029 assert(Sym);
Ted Kremenek90af9092010-12-02 07:49:45 +00001030
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001031 // Set the symbol's state to Allocated.
Anton Yartsev05789592013-03-28 17:05:19 +00001032 return State->set<RegionState>(Sym, RefState::getAllocated(Family, E));
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001033}
1034
Anna Zaks40a7eb32012-02-22 19:24:52 +00001035ProgramStateRef MallocChecker::FreeMemAttr(CheckerContext &C,
1036 const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001037 const OwnershipAttr *Att,
1038 ProgramStateRef State) const {
1039 if (!State)
1040 return nullptr;
1041
Richard Smith852e9ce2013-11-27 01:46:48 +00001042 if (Att->getModule() != II_malloc)
Craig Topper0dbb7832014-05-27 02:45:47 +00001043 return nullptr;
Ted Kremenekd21139a2010-07-31 01:52:11 +00001044
Anna Zaksfe6eb672012-08-24 02:28:20 +00001045 bool ReleasedAllocated = false;
Anna Zaks8dc53af2012-03-01 22:06:06 +00001046
Aaron Ballmana82eaa72014-05-02 13:35:42 +00001047 for (const auto &Arg : Att->args()) {
1048 ProgramStateRef StateI = FreeMemAux(C, CE, State, Arg,
Anna Zaksfe6eb672012-08-24 02:28:20 +00001049 Att->getOwnKind() == OwnershipAttr::Holds,
1050 ReleasedAllocated);
Anna Zaks8dc53af2012-03-01 22:06:06 +00001051 if (StateI)
1052 State = StateI;
Ted Kremenekd21139a2010-07-31 01:52:11 +00001053 }
Anna Zaks8dc53af2012-03-01 22:06:06 +00001054 return State;
Ted Kremenekd21139a2010-07-31 01:52:11 +00001055}
1056
Ted Kremenek49b1e382012-01-26 21:29:00 +00001057ProgramStateRef MallocChecker::FreeMemAux(CheckerContext &C,
Anna Zaks31886862012-02-10 01:11:00 +00001058 const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001059 ProgramStateRef State,
Anna Zaks31886862012-02-10 01:11:00 +00001060 unsigned Num,
Anna Zaksfe6eb672012-08-24 02:28:20 +00001061 bool Hold,
Anna Zaks67291b92012-11-13 03:18:01 +00001062 bool &ReleasedAllocated,
1063 bool ReturnsNullOnFailure) const {
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001064 if (!State)
1065 return nullptr;
1066
Anna Zaksb508d292012-04-10 23:41:11 +00001067 if (CE->getNumArgs() < (Num + 1))
Craig Topper0dbb7832014-05-27 02:45:47 +00001068 return nullptr;
Anna Zaksb508d292012-04-10 23:41:11 +00001069
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001070 return FreeMemAux(C, CE->getArg(Num), CE, State, Hold,
Anna Zaks67291b92012-11-13 03:18:01 +00001071 ReleasedAllocated, ReturnsNullOnFailure);
1072}
1073
Anna Zaksa14c1d02012-11-13 19:47:40 +00001074/// Checks if the previous call to free on the given symbol failed - if free
1075/// failed, returns true. Also, returns the corresponding return value symbol.
Benjamin Kramerba4c85e2012-11-22 15:02:44 +00001076static bool didPreviousFreeFail(ProgramStateRef State,
1077 SymbolRef Sym, SymbolRef &RetStatusSymbol) {
Anna Zaksa14c1d02012-11-13 19:47:40 +00001078 const SymbolRef *Ret = State->get<FreeReturnValue>(Sym);
Anna Zaks67291b92012-11-13 03:18:01 +00001079 if (Ret) {
1080 assert(*Ret && "We should not store the null return symbol");
1081 ConstraintManager &CMgr = State->getConstraintManager();
1082 ConditionTruthVal FreeFailed = CMgr.isNull(State, *Ret);
Anna Zaksa14c1d02012-11-13 19:47:40 +00001083 RetStatusSymbol = *Ret;
1084 return FreeFailed.isConstrainedTrue();
Anna Zaks67291b92012-11-13 03:18:01 +00001085 }
Anna Zaksa14c1d02012-11-13 19:47:40 +00001086 return false;
Anna Zaks0d6989b2012-06-22 02:04:31 +00001087}
1088
Anton Yartsev05789592013-03-28 17:05:19 +00001089AllocationFamily MallocChecker::getAllocationFamily(CheckerContext &C,
Anton Yartseve3377fb2013-04-04 23:46:29 +00001090 const Stmt *S) const {
1091 if (!S)
Anton Yartsev05789592013-03-28 17:05:19 +00001092 return AF_None;
1093
Anton Yartseve3377fb2013-04-04 23:46:29 +00001094 if (const CallExpr *CE = dyn_cast<CallExpr>(S)) {
Anton Yartsev05789592013-03-28 17:05:19 +00001095 const FunctionDecl *FD = C.getCalleeDecl(CE);
Anton Yartseve3377fb2013-04-04 23:46:29 +00001096
1097 if (!FD)
1098 FD = dyn_cast<FunctionDecl>(CE->getCalleeDecl());
1099
Anton Yartsev05789592013-03-28 17:05:19 +00001100 ASTContext &Ctx = C.getASTContext();
1101
Anna Zaksd79b8402014-10-03 21:48:59 +00001102 if (isCMemFunction(FD, Ctx, AF_Malloc, MemoryOperationKind::MOK_Any))
Anton Yartsev05789592013-03-28 17:05:19 +00001103 return AF_Malloc;
1104
1105 if (isStandardNewDelete(FD, Ctx)) {
1106 OverloadedOperatorKind Kind = FD->getOverloadedOperator();
Anton Yartseve3377fb2013-04-04 23:46:29 +00001107 if (Kind == OO_New || Kind == OO_Delete)
Anton Yartsev05789592013-03-28 17:05:19 +00001108 return AF_CXXNew;
Anton Yartseve3377fb2013-04-04 23:46:29 +00001109 else if (Kind == OO_Array_New || Kind == OO_Array_Delete)
Anton Yartsev05789592013-03-28 17:05:19 +00001110 return AF_CXXNewArray;
1111 }
1112
Anna Zaksd79b8402014-10-03 21:48:59 +00001113 if (isCMemFunction(FD, Ctx, AF_IfNameIndex, MemoryOperationKind::MOK_Any))
1114 return AF_IfNameIndex;
1115
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001116 if (isCMemFunction(FD, Ctx, AF_Alloca, MemoryOperationKind::MOK_Any))
1117 return AF_Alloca;
1118
Anton Yartsev05789592013-03-28 17:05:19 +00001119 return AF_None;
1120 }
1121
Anton Yartseve3377fb2013-04-04 23:46:29 +00001122 if (const CXXNewExpr *NE = dyn_cast<CXXNewExpr>(S))
1123 return NE->isArray() ? AF_CXXNewArray : AF_CXXNew;
1124
1125 if (const CXXDeleteExpr *DE = dyn_cast<CXXDeleteExpr>(S))
Anton Yartsev05789592013-03-28 17:05:19 +00001126 return DE->isArrayForm() ? AF_CXXNewArray : AF_CXXNew;
1127
Anton Yartseve3377fb2013-04-04 23:46:29 +00001128 if (isa<ObjCMessageExpr>(S))
Anton Yartsev05789592013-03-28 17:05:19 +00001129 return AF_Malloc;
1130
1131 return AF_None;
1132}
1133
1134bool MallocChecker::printAllocDeallocName(raw_ostream &os, CheckerContext &C,
1135 const Expr *E) const {
1136 if (const CallExpr *CE = dyn_cast<CallExpr>(E)) {
1137 // FIXME: This doesn't handle indirect calls.
1138 const FunctionDecl *FD = CE->getDirectCallee();
1139 if (!FD)
1140 return false;
1141
1142 os << *FD;
1143 if (!FD->isOverloadedOperator())
1144 os << "()";
1145 return true;
1146 }
1147
1148 if (const ObjCMessageExpr *Msg = dyn_cast<ObjCMessageExpr>(E)) {
1149 if (Msg->isInstanceMessage())
1150 os << "-";
1151 else
1152 os << "+";
Aaron Ballmanb190f972014-01-03 17:59:55 +00001153 Msg->getSelector().print(os);
Anton Yartsev05789592013-03-28 17:05:19 +00001154 return true;
1155 }
1156
1157 if (const CXXNewExpr *NE = dyn_cast<CXXNewExpr>(E)) {
1158 os << "'"
1159 << getOperatorSpelling(NE->getOperatorNew()->getOverloadedOperator())
1160 << "'";
1161 return true;
1162 }
1163
1164 if (const CXXDeleteExpr *DE = dyn_cast<CXXDeleteExpr>(E)) {
1165 os << "'"
1166 << getOperatorSpelling(DE->getOperatorDelete()->getOverloadedOperator())
1167 << "'";
1168 return true;
1169 }
1170
1171 return false;
1172}
1173
1174void MallocChecker::printExpectedAllocName(raw_ostream &os, CheckerContext &C,
1175 const Expr *E) const {
1176 AllocationFamily Family = getAllocationFamily(C, E);
1177
1178 switch(Family) {
1179 case AF_Malloc: os << "malloc()"; return;
1180 case AF_CXXNew: os << "'new'"; return;
1181 case AF_CXXNewArray: os << "'new[]'"; return;
Anna Zaksd79b8402014-10-03 21:48:59 +00001182 case AF_IfNameIndex: os << "'if_nameindex()'"; return;
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001183 case AF_Alloca:
Anton Yartsev05789592013-03-28 17:05:19 +00001184 case AF_None: llvm_unreachable("not a deallocation expression");
1185 }
1186}
1187
1188void MallocChecker::printExpectedDeallocName(raw_ostream &os,
1189 AllocationFamily Family) const {
1190 switch(Family) {
1191 case AF_Malloc: os << "free()"; return;
1192 case AF_CXXNew: os << "'delete'"; return;
1193 case AF_CXXNewArray: os << "'delete[]'"; return;
Anna Zaksd79b8402014-10-03 21:48:59 +00001194 case AF_IfNameIndex: os << "'if_freenameindex()'"; return;
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001195 case AF_Alloca:
1196 case AF_None: llvm_unreachable("suspicious argument");
Anton Yartsev05789592013-03-28 17:05:19 +00001197 }
1198}
1199
Anna Zaks0d6989b2012-06-22 02:04:31 +00001200ProgramStateRef MallocChecker::FreeMemAux(CheckerContext &C,
1201 const Expr *ArgExpr,
1202 const Expr *ParentExpr,
Anna Zaks67291b92012-11-13 03:18:01 +00001203 ProgramStateRef State,
Anna Zaksfe6eb672012-08-24 02:28:20 +00001204 bool Hold,
Anna Zaks67291b92012-11-13 03:18:01 +00001205 bool &ReleasedAllocated,
1206 bool ReturnsNullOnFailure) const {
Anna Zaks0d6989b2012-06-22 02:04:31 +00001207
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001208 if (!State)
1209 return nullptr;
1210
Anna Zaks67291b92012-11-13 03:18:01 +00001211 SVal ArgVal = State->getSVal(ArgExpr, C.getLocationContext());
David Blaikie2fdacbc2013-02-20 05:52:05 +00001212 if (!ArgVal.getAs<DefinedOrUnknownSVal>())
Craig Topper0dbb7832014-05-27 02:45:47 +00001213 return nullptr;
David Blaikie2fdacbc2013-02-20 05:52:05 +00001214 DefinedOrUnknownSVal location = ArgVal.castAs<DefinedOrUnknownSVal>();
Ted Kremenekd21139a2010-07-31 01:52:11 +00001215
1216 // Check for null dereferences.
David Blaikie2fdacbc2013-02-20 05:52:05 +00001217 if (!location.getAs<Loc>())
Craig Topper0dbb7832014-05-27 02:45:47 +00001218 return nullptr;
Ted Kremenekd21139a2010-07-31 01:52:11 +00001219
Anna Zaksad01ef52012-02-14 00:26:13 +00001220 // The explicit NULL case, no operation is performed.
Ted Kremenek49b1e382012-01-26 21:29:00 +00001221 ProgramStateRef notNullState, nullState;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001222 std::tie(notNullState, nullState) = State->assume(location);
Ted Kremenekd21139a2010-07-31 01:52:11 +00001223 if (nullState && !notNullState)
Craig Topper0dbb7832014-05-27 02:45:47 +00001224 return nullptr;
Ted Kremenekd21139a2010-07-31 01:52:11 +00001225
Jordy Rose3597b212010-06-07 19:32:37 +00001226 // Unknown values could easily be okay
1227 // Undefined values are handled elsewhere
1228 if (ArgVal.isUnknownOrUndef())
Craig Topper0dbb7832014-05-27 02:45:47 +00001229 return nullptr;
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001230
Jordy Rose3597b212010-06-07 19:32:37 +00001231 const MemRegion *R = ArgVal.getAsRegion();
1232
1233 // Nonlocs can't be freed, of course.
1234 // Non-region locations (labels and fixed addresses) also shouldn't be freed.
1235 if (!R) {
Anton Yartsev05789592013-03-28 17:05:19 +00001236 ReportBadFree(C, ArgVal, ArgExpr->getSourceRange(), ParentExpr);
Craig Topper0dbb7832014-05-27 02:45:47 +00001237 return nullptr;
Jordy Rose3597b212010-06-07 19:32:37 +00001238 }
1239
1240 R = R->StripCasts();
1241
1242 // Blocks might show up as heap data, but should not be free()d
1243 if (isa<BlockDataRegion>(R)) {
Anton Yartsev05789592013-03-28 17:05:19 +00001244 ReportBadFree(C, ArgVal, ArgExpr->getSourceRange(), ParentExpr);
Craig Topper0dbb7832014-05-27 02:45:47 +00001245 return nullptr;
Jordy Rose3597b212010-06-07 19:32:37 +00001246 }
1247
1248 const MemSpaceRegion *MS = R->getMemorySpace();
1249
Anton Yartsevc38d7952015-03-03 22:58:46 +00001250 // Parameters, locals, statics, globals, and memory returned by
1251 // __builtin_alloca() shouldn't be freed.
Jordy Rose3597b212010-06-07 19:32:37 +00001252 if (!(isa<UnknownSpaceRegion>(MS) || isa<HeapSpaceRegion>(MS))) {
1253 // FIXME: at the time this code was written, malloc() regions were
1254 // represented by conjured symbols, which are all in UnknownSpaceRegion.
1255 // This means that there isn't actually anything from HeapSpaceRegion
1256 // that should be freed, even though we allow it here.
1257 // Of course, free() can work on memory allocated outside the current
1258 // function, so UnknownSpaceRegion is always a possibility.
1259 // False negatives are better than false positives.
Anton Yartsevc38d7952015-03-03 22:58:46 +00001260
1261 if (isa<AllocaRegion>(R))
1262 ReportFreeAlloca(C, ArgVal, ArgExpr->getSourceRange());
1263 else
1264 ReportBadFree(C, ArgVal, ArgExpr->getSourceRange(), ParentExpr);
1265
Craig Topper0dbb7832014-05-27 02:45:47 +00001266 return nullptr;
Jordy Rose3597b212010-06-07 19:32:37 +00001267 }
Anna Zaksc89ad072013-02-07 23:05:47 +00001268
1269 const SymbolicRegion *SrBase = dyn_cast<SymbolicRegion>(R->getBaseRegion());
Jordy Rose3597b212010-06-07 19:32:37 +00001270 // Various cases could lead to non-symbol values here.
1271 // For now, ignore them.
Anna Zaksc89ad072013-02-07 23:05:47 +00001272 if (!SrBase)
Craig Topper0dbb7832014-05-27 02:45:47 +00001273 return nullptr;
Jordy Rose3597b212010-06-07 19:32:37 +00001274
Anna Zaksc89ad072013-02-07 23:05:47 +00001275 SymbolRef SymBase = SrBase->getSymbol();
1276 const RefState *RsBase = State->get<RegionState>(SymBase);
Craig Topper0dbb7832014-05-27 02:45:47 +00001277 SymbolRef PreviousRetStatusSymbol = nullptr;
Zhongxing Xue2bdb9a2010-01-18 03:27:34 +00001278
Anton Yartseve3377fb2013-04-04 23:46:29 +00001279 if (RsBase) {
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001280
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001281 // Memory returned by alloca() shouldn't be freed.
1282 if (RsBase->getAllocationFamily() == AF_Alloca) {
1283 ReportFreeAlloca(C, ArgVal, ArgExpr->getSourceRange());
1284 return nullptr;
1285 }
1286
Anna Zaks93a21a82013-04-09 00:30:28 +00001287 // Check for double free first.
1288 if ((RsBase->isReleased() || RsBase->isRelinquished()) &&
Anton Yartseve3377fb2013-04-04 23:46:29 +00001289 !didPreviousFreeFail(State, SymBase, PreviousRetStatusSymbol)) {
1290 ReportDoubleFree(C, ParentExpr->getSourceRange(), RsBase->isReleased(),
1291 SymBase, PreviousRetStatusSymbol);
Craig Topper0dbb7832014-05-27 02:45:47 +00001292 return nullptr;
Anton Yartseve3377fb2013-04-04 23:46:29 +00001293
Anna Zaks93a21a82013-04-09 00:30:28 +00001294 // If the pointer is allocated or escaped, but we are now trying to free it,
1295 // check that the call to free is proper.
1296 } else if (RsBase->isAllocated() || RsBase->isEscaped()) {
1297
1298 // Check if an expected deallocation function matches the real one.
1299 bool DeallocMatchesAlloc =
1300 RsBase->getAllocationFamily() == getAllocationFamily(C, ParentExpr);
1301 if (!DeallocMatchesAlloc) {
1302 ReportMismatchedDealloc(C, ArgExpr->getSourceRange(),
Anton Yartsevf5bccce2013-09-16 17:51:25 +00001303 ParentExpr, RsBase, SymBase, Hold);
Craig Topper0dbb7832014-05-27 02:45:47 +00001304 return nullptr;
Anna Zaks93a21a82013-04-09 00:30:28 +00001305 }
1306
1307 // Check if the memory location being freed is the actual location
1308 // allocated, or an offset.
1309 RegionOffset Offset = R->getAsOffset();
1310 if (Offset.isValid() &&
1311 !Offset.hasSymbolicOffset() &&
1312 Offset.getOffset() != 0) {
1313 const Expr *AllocExpr = cast<Expr>(RsBase->getStmt());
1314 ReportOffsetFree(C, ArgVal, ArgExpr->getSourceRange(), ParentExpr,
1315 AllocExpr);
Craig Topper0dbb7832014-05-27 02:45:47 +00001316 return nullptr;
Anna Zaks93a21a82013-04-09 00:30:28 +00001317 }
Anton Yartseve3377fb2013-04-04 23:46:29 +00001318 }
Anna Zaksc89ad072013-02-07 23:05:47 +00001319 }
1320
Craig Topper0dbb7832014-05-27 02:45:47 +00001321 ReleasedAllocated = (RsBase != nullptr) && RsBase->isAllocated();
Anna Zaksfe6eb672012-08-24 02:28:20 +00001322
Anna Zaksa14c1d02012-11-13 19:47:40 +00001323 // Clean out the info on previous call to free return info.
Anna Zaksc89ad072013-02-07 23:05:47 +00001324 State = State->remove<FreeReturnValue>(SymBase);
Anna Zaksa14c1d02012-11-13 19:47:40 +00001325
Anna Zaks67291b92012-11-13 03:18:01 +00001326 // Keep track of the return value. If it is NULL, we will know that free
1327 // failed.
1328 if (ReturnsNullOnFailure) {
1329 SVal RetVal = C.getSVal(ParentExpr);
1330 SymbolRef RetStatusSymbol = RetVal.getAsSymbol();
1331 if (RetStatusSymbol) {
Anna Zaksc89ad072013-02-07 23:05:47 +00001332 C.getSymbolManager().addSymbolDependency(SymBase, RetStatusSymbol);
1333 State = State->set<FreeReturnValue>(SymBase, RetStatusSymbol);
Anna Zaks67291b92012-11-13 03:18:01 +00001334 }
1335 }
1336
Anton Yartsev030bcdd2013-04-05 19:08:04 +00001337 AllocationFamily Family = RsBase ? RsBase->getAllocationFamily()
1338 : getAllocationFamily(C, ParentExpr);
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001339 // Normal free.
Anton Yartsev05789592013-03-28 17:05:19 +00001340 if (Hold)
Anna Zaksc89ad072013-02-07 23:05:47 +00001341 return State->set<RegionState>(SymBase,
Anton Yartsev05789592013-03-28 17:05:19 +00001342 RefState::getRelinquished(Family,
1343 ParentExpr));
1344
1345 return State->set<RegionState>(SymBase,
1346 RefState::getReleased(Family, ParentExpr));
Zhongxing Xuc0484fa2009-12-12 12:29:38 +00001347}
1348
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001349Optional<MallocChecker::CheckKind>
Anton Yartseve5c0c142015-02-18 00:39:06 +00001350MallocChecker::getCheckIfTracked(MallocChecker::CheckKind CK,
1351 AllocationFamily Family) const {
1352
1353 if (CK == CK_NumCheckKinds || !ChecksEnabled[CK])
1354 return Optional<MallocChecker::CheckKind>();
1355
1356 // C/C++ checkers.
1357 if (CK == CK_MismatchedDeallocatorChecker)
1358 return CK;
1359
Anton Yartsev717aa0e2013-04-05 00:31:02 +00001360 switch (Family) {
Anna Zaksd79b8402014-10-03 21:48:59 +00001361 case AF_Malloc:
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001362 case AF_IfNameIndex:
1363 case AF_Alloca: {
Anton Yartseve5c0c142015-02-18 00:39:06 +00001364 // C checkers.
Gabor Horvathe40c71c2015-03-04 17:59:34 +00001365 if (CK == CK_MallocChecker) {
Anton Yartseve5c0c142015-02-18 00:39:06 +00001366 return CK;
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001367 }
1368 return Optional<MallocChecker::CheckKind>();
Anton Yartsev717aa0e2013-04-05 00:31:02 +00001369 }
1370 case AF_CXXNew:
1371 case AF_CXXNewArray: {
Anton Yartseve5c0c142015-02-18 00:39:06 +00001372 // C++ checkers.
1373 if (CK == CK_NewDeleteChecker ||
1374 CK == CK_NewDeleteLeaksChecker) {
1375 return CK;
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001376 }
1377 return Optional<MallocChecker::CheckKind>();
Anton Yartsev717aa0e2013-04-05 00:31:02 +00001378 }
1379 case AF_None: {
Anton Yartsev030bcdd2013-04-05 19:08:04 +00001380 llvm_unreachable("no family");
Anton Yartsev717aa0e2013-04-05 00:31:02 +00001381 }
Anton Yartsev717aa0e2013-04-05 00:31:02 +00001382 }
Anton Yartsev2f910042013-04-05 02:12:04 +00001383 llvm_unreachable("unhandled family");
Anton Yartseve3377fb2013-04-04 23:46:29 +00001384}
1385
Anton Yartseve5c0c142015-02-18 00:39:06 +00001386static MallocChecker::CKVecTy MakeVecFromCK(MallocChecker::CheckKind CK1,
1387 MallocChecker::CheckKind CK2 = MallocChecker::CK_NumCheckKinds,
1388 MallocChecker::CheckKind CK3 = MallocChecker::CK_NumCheckKinds,
1389 MallocChecker::CheckKind CK4 = MallocChecker::CK_NumCheckKinds) {
1390 MallocChecker::CKVecTy CKVec;
1391 CKVec.push_back(CK1);
1392 if (CK2 != MallocChecker::CK_NumCheckKinds) {
1393 CKVec.push_back(CK2);
1394 if (CK3 != MallocChecker::CK_NumCheckKinds) {
1395 CKVec.push_back(CK3);
1396 if (CK4 != MallocChecker::CK_NumCheckKinds)
1397 CKVec.push_back(CK4);
1398 }
1399 }
1400 return CKVec;
Anton Yartseve3377fb2013-04-04 23:46:29 +00001401}
1402
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001403Optional<MallocChecker::CheckKind>
Anton Yartseve5c0c142015-02-18 00:39:06 +00001404MallocChecker::getCheckIfTracked(CKVecTy CKVec, AllocationFamily Family) const {
1405 for (auto CK: CKVec) {
1406 auto RetCK = getCheckIfTracked(CK, Family);
1407 if (RetCK.hasValue())
1408 return RetCK;
1409 }
1410 return Optional<MallocChecker::CheckKind>();
1411}
Anton Yartseve3377fb2013-04-04 23:46:29 +00001412
Anton Yartseve5c0c142015-02-18 00:39:06 +00001413Optional<MallocChecker::CheckKind>
1414MallocChecker::getCheckIfTracked(CKVecTy CKVec, CheckerContext &C,
1415 const Stmt *AllocDeallocStmt) const {
1416 return getCheckIfTracked(CKVec, getAllocationFamily(C, AllocDeallocStmt));
1417}
1418
1419Optional<MallocChecker::CheckKind>
1420MallocChecker::getCheckIfTracked(CKVecTy CKVec, CheckerContext &C,
1421 SymbolRef Sym) const {
Anton Yartsev030bcdd2013-04-05 19:08:04 +00001422 const RefState *RS = C.getState()->get<RegionState>(Sym);
1423 assert(RS);
Anton Yartseve5c0c142015-02-18 00:39:06 +00001424 return getCheckIfTracked(CKVec, RS->getAllocationFamily());
Anton Yartseve3377fb2013-04-04 23:46:29 +00001425}
1426
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001427bool MallocChecker::SummarizeValue(raw_ostream &os, SVal V) {
David Blaikie05785d12013-02-20 22:23:23 +00001428 if (Optional<nonloc::ConcreteInt> IntVal = V.getAs<nonloc::ConcreteInt>())
Jordy Rose3597b212010-06-07 19:32:37 +00001429 os << "an integer (" << IntVal->getValue() << ")";
David Blaikie05785d12013-02-20 22:23:23 +00001430 else if (Optional<loc::ConcreteInt> ConstAddr = V.getAs<loc::ConcreteInt>())
Jordy Rose3597b212010-06-07 19:32:37 +00001431 os << "a constant address (" << ConstAddr->getValue() << ")";
David Blaikie05785d12013-02-20 22:23:23 +00001432 else if (Optional<loc::GotoLabel> Label = V.getAs<loc::GotoLabel>())
Chris Lattner5a9b1ec2011-02-17 05:38:27 +00001433 os << "the address of the label '" << Label->getLabel()->getName() << "'";
Jordy Rose3597b212010-06-07 19:32:37 +00001434 else
1435 return false;
1436
1437 return true;
1438}
1439
Ted Kremenek5ef32db2011-08-12 23:37:29 +00001440bool MallocChecker::SummarizeRegion(raw_ostream &os,
Jordy Rose3597b212010-06-07 19:32:37 +00001441 const MemRegion *MR) {
1442 switch (MR->getKind()) {
1443 case MemRegion::FunctionTextRegionKind: {
Anna Zaks42782342012-09-17 19:13:56 +00001444 const NamedDecl *FD = cast<FunctionTextRegion>(MR)->getDecl();
Jordy Rose3597b212010-06-07 19:32:37 +00001445 if (FD)
Benjamin Kramerb89514a2011-10-14 18:45:37 +00001446 os << "the address of the function '" << *FD << '\'';
Jordy Rose3597b212010-06-07 19:32:37 +00001447 else
1448 os << "the address of a function";
1449 return true;
1450 }
1451 case MemRegion::BlockTextRegionKind:
1452 os << "block text";
1453 return true;
1454 case MemRegion::BlockDataRegionKind:
1455 // FIXME: where the block came from?
1456 os << "a block";
1457 return true;
1458 default: {
1459 const MemSpaceRegion *MS = MR->getMemorySpace();
1460
Anna Zaks8158ef02012-01-04 23:54:01 +00001461 if (isa<StackLocalsSpaceRegion>(MS)) {
Jordy Rose3597b212010-06-07 19:32:37 +00001462 const VarRegion *VR = dyn_cast<VarRegion>(MR);
1463 const VarDecl *VD;
1464 if (VR)
1465 VD = VR->getDecl();
1466 else
Craig Topper0dbb7832014-05-27 02:45:47 +00001467 VD = nullptr;
1468
Jordy Rose3597b212010-06-07 19:32:37 +00001469 if (VD)
1470 os << "the address of the local variable '" << VD->getName() << "'";
1471 else
1472 os << "the address of a local stack variable";
1473 return true;
1474 }
Anna Zaks8158ef02012-01-04 23:54:01 +00001475
1476 if (isa<StackArgumentsSpaceRegion>(MS)) {
Jordy Rose3597b212010-06-07 19:32:37 +00001477 const VarRegion *VR = dyn_cast<VarRegion>(MR);
1478 const VarDecl *VD;
1479 if (VR)
1480 VD = VR->getDecl();
1481 else
Craig Topper0dbb7832014-05-27 02:45:47 +00001482 VD = nullptr;
1483
Jordy Rose3597b212010-06-07 19:32:37 +00001484 if (VD)
1485 os << "the address of the parameter '" << VD->getName() << "'";
1486 else
1487 os << "the address of a parameter";
1488 return true;
1489 }
Anna Zaks8158ef02012-01-04 23:54:01 +00001490
1491 if (isa<GlobalsSpaceRegion>(MS)) {
Jordy Rose3597b212010-06-07 19:32:37 +00001492 const VarRegion *VR = dyn_cast<VarRegion>(MR);
1493 const VarDecl *VD;
1494 if (VR)
1495 VD = VR->getDecl();
1496 else
Craig Topper0dbb7832014-05-27 02:45:47 +00001497 VD = nullptr;
1498
Jordy Rose3597b212010-06-07 19:32:37 +00001499 if (VD) {
1500 if (VD->isStaticLocal())
1501 os << "the address of the static variable '" << VD->getName() << "'";
1502 else
1503 os << "the address of the global variable '" << VD->getName() << "'";
1504 } else
1505 os << "the address of a global variable";
1506 return true;
1507 }
Anna Zaks8158ef02012-01-04 23:54:01 +00001508
1509 return false;
Jordy Rose3597b212010-06-07 19:32:37 +00001510 }
1511 }
1512}
1513
Anton Yartsev05789592013-03-28 17:05:19 +00001514void MallocChecker::ReportBadFree(CheckerContext &C, SVal ArgVal,
1515 SourceRange Range,
1516 const Expr *DeallocExpr) const {
1517
Gabor Horvathe40c71c2015-03-04 17:59:34 +00001518 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_MallocChecker,
Anton Yartseve5c0c142015-02-18 00:39:06 +00001519 CK_NewDeleteChecker),
1520 C, DeallocExpr);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001521 if (!CheckKind.hasValue())
Anton Yartseve3377fb2013-04-04 23:46:29 +00001522 return;
1523
Ted Kremenek750b7ac2010-12-20 21:19:09 +00001524 if (ExplodedNode *N = C.generateSink()) {
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001525 if (!BT_BadFree[*CheckKind])
1526 BT_BadFree[*CheckKind].reset(
1527 new BugType(CheckNames[*CheckKind], "Bad free", "Memory Error"));
1528
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001529 SmallString<100> buf;
Jordy Rose3597b212010-06-07 19:32:37 +00001530 llvm::raw_svector_ostream os(buf);
Anton Yartsev05789592013-03-28 17:05:19 +00001531
Jordy Rose3597b212010-06-07 19:32:37 +00001532 const MemRegion *MR = ArgVal.getAsRegion();
Anton Yartsev05789592013-03-28 17:05:19 +00001533 while (const ElementRegion *ER = dyn_cast_or_null<ElementRegion>(MR))
1534 MR = ER->getSuperRegion();
1535
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001536 os << "Argument to ";
1537 if (!printAllocDeallocName(os, C, DeallocExpr))
1538 os << "deallocator";
Anton Yartsev05789592013-03-28 17:05:19 +00001539
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001540 os << " is ";
1541 bool Summarized = MR ? SummarizeRegion(os, MR)
1542 : SummarizeValue(os, ArgVal);
1543 if (Summarized)
1544 os << ", which is not memory allocated by ";
1545 else
1546 os << "not memory allocated by ";
Anton Yartsev05789592013-03-28 17:05:19 +00001547
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001548 printExpectedAllocName(os, C, DeallocExpr);
Anton Yartsev05789592013-03-28 17:05:19 +00001549
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001550 BugReport *R = new BugReport(*BT_BadFree[*CheckKind], os.str(), N);
Ted Kremenek1e809b42012-03-09 01:13:14 +00001551 R->markInteresting(MR);
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001552 R->addRange(Range);
Jordan Rosee10d5a72012-11-02 01:53:40 +00001553 C.emitReport(R);
Jordy Rose3597b212010-06-07 19:32:37 +00001554 }
1555}
1556
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001557void MallocChecker::ReportFreeAlloca(CheckerContext &C, SVal ArgVal,
1558 SourceRange Range) const {
1559
Gabor Horvathe40c71c2015-03-04 17:59:34 +00001560 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_MallocChecker,
Anton Yartsev5b5c7ce2015-02-19 13:36:20 +00001561 CK_MismatchedDeallocatorChecker),
1562 AF_Alloca);
1563 if (!CheckKind.hasValue())
1564 return;
1565
1566 if (ExplodedNode *N = C.generateSink()) {
1567 if (!BT_FreeAlloca[*CheckKind])
1568 BT_FreeAlloca[*CheckKind].reset(
1569 new BugType(CheckNames[*CheckKind], "Free alloca()", "Memory Error"));
1570
1571 BugReport *R = new BugReport(*BT_FreeAlloca[*CheckKind],
1572 "Memory allocated by alloca() should not be deallocated", N);
1573 R->markInteresting(ArgVal.getAsRegion());
1574 R->addRange(Range);
1575 C.emitReport(R);
1576 }
1577}
1578
Anton Yartseve3377fb2013-04-04 23:46:29 +00001579void MallocChecker::ReportMismatchedDealloc(CheckerContext &C,
1580 SourceRange Range,
1581 const Expr *DeallocExpr,
Anton Yartsevf0593d62013-04-05 11:25:10 +00001582 const RefState *RS,
Anton Yartsevf5bccce2013-09-16 17:51:25 +00001583 SymbolRef Sym,
1584 bool OwnershipTransferred) const {
Anton Yartsev05789592013-03-28 17:05:19 +00001585
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001586 if (!ChecksEnabled[CK_MismatchedDeallocatorChecker])
Anton Yartsev05789592013-03-28 17:05:19 +00001587 return;
1588
1589 if (ExplodedNode *N = C.generateSink()) {
Anton Yartseve3377fb2013-04-04 23:46:29 +00001590 if (!BT_MismatchedDealloc)
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001591 BT_MismatchedDealloc.reset(
1592 new BugType(CheckNames[CK_MismatchedDeallocatorChecker],
1593 "Bad deallocator", "Memory Error"));
1594
Anton Yartsev05789592013-03-28 17:05:19 +00001595 SmallString<100> buf;
1596 llvm::raw_svector_ostream os(buf);
1597
1598 const Expr *AllocExpr = cast<Expr>(RS->getStmt());
1599 SmallString<20> AllocBuf;
1600 llvm::raw_svector_ostream AllocOs(AllocBuf);
1601 SmallString<20> DeallocBuf;
1602 llvm::raw_svector_ostream DeallocOs(DeallocBuf);
1603
Anton Yartsevf5bccce2013-09-16 17:51:25 +00001604 if (OwnershipTransferred) {
1605 if (printAllocDeallocName(DeallocOs, C, DeallocExpr))
1606 os << DeallocOs.str() << " cannot";
1607 else
1608 os << "Cannot";
Anton Yartsev05789592013-03-28 17:05:19 +00001609
Anton Yartsevf5bccce2013-09-16 17:51:25 +00001610 os << " take ownership of memory";
Anton Yartsev05789592013-03-28 17:05:19 +00001611
Anton Yartsevf5bccce2013-09-16 17:51:25 +00001612 if (printAllocDeallocName(AllocOs, C, AllocExpr))
1613 os << " allocated by " << AllocOs.str();
1614 } else {
1615 os << "Memory";
1616 if (printAllocDeallocName(AllocOs, C, AllocExpr))
1617 os << " allocated by " << AllocOs.str();
1618
1619 os << " should be deallocated by ";
1620 printExpectedDeallocName(os, RS->getAllocationFamily());
1621
1622 if (printAllocDeallocName(DeallocOs, C, DeallocExpr))
1623 os << ", not " << DeallocOs.str();
1624 }
Anton Yartsev05789592013-03-28 17:05:19 +00001625
Anton Yartseve3377fb2013-04-04 23:46:29 +00001626 BugReport *R = new BugReport(*BT_MismatchedDealloc, os.str(), N);
Anton Yartsevf0593d62013-04-05 11:25:10 +00001627 R->markInteresting(Sym);
Anton Yartsev05789592013-03-28 17:05:19 +00001628 R->addRange(Range);
David Blaikie91e79022014-09-04 23:54:33 +00001629 R->addVisitor(llvm::make_unique<MallocBugVisitor>(Sym));
Anton Yartsev05789592013-03-28 17:05:19 +00001630 C.emitReport(R);
1631 }
1632}
1633
Anna Zaksc89ad072013-02-07 23:05:47 +00001634void MallocChecker::ReportOffsetFree(CheckerContext &C, SVal ArgVal,
Anton Yartsev05789592013-03-28 17:05:19 +00001635 SourceRange Range, const Expr *DeallocExpr,
1636 const Expr *AllocExpr) const {
1637
Anton Yartsev05789592013-03-28 17:05:19 +00001638
Gabor Horvathe40c71c2015-03-04 17:59:34 +00001639 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_MallocChecker,
Anton Yartseve5c0c142015-02-18 00:39:06 +00001640 CK_NewDeleteChecker),
1641 C, AllocExpr);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001642 if (!CheckKind.hasValue())
Anton Yartseve3377fb2013-04-04 23:46:29 +00001643 return;
1644
Anna Zaksc89ad072013-02-07 23:05:47 +00001645 ExplodedNode *N = C.generateSink();
Craig Topper0dbb7832014-05-27 02:45:47 +00001646 if (!N)
Anna Zaksc89ad072013-02-07 23:05:47 +00001647 return;
1648
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001649 if (!BT_OffsetFree[*CheckKind])
1650 BT_OffsetFree[*CheckKind].reset(
1651 new BugType(CheckNames[*CheckKind], "Offset free", "Memory Error"));
Anna Zaksc89ad072013-02-07 23:05:47 +00001652
1653 SmallString<100> buf;
1654 llvm::raw_svector_ostream os(buf);
Anton Yartsev05789592013-03-28 17:05:19 +00001655 SmallString<20> AllocNameBuf;
1656 llvm::raw_svector_ostream AllocNameOs(AllocNameBuf);
Anna Zaksc89ad072013-02-07 23:05:47 +00001657
1658 const MemRegion *MR = ArgVal.getAsRegion();
1659 assert(MR && "Only MemRegion based symbols can have offset free errors");
1660
1661 RegionOffset Offset = MR->getAsOffset();
1662 assert((Offset.isValid() &&
1663 !Offset.hasSymbolicOffset() &&
1664 Offset.getOffset() != 0) &&
1665 "Only symbols with a valid offset can have offset free errors");
1666
1667 int offsetBytes = Offset.getOffset() / C.getASTContext().getCharWidth();
1668
Anton Yartsev05789592013-03-28 17:05:19 +00001669 os << "Argument to ";
1670 if (!printAllocDeallocName(os, C, DeallocExpr))
1671 os << "deallocator";
1672 os << " is offset by "
Anna Zaksc89ad072013-02-07 23:05:47 +00001673 << offsetBytes
1674 << " "
1675 << ((abs(offsetBytes) > 1) ? "bytes" : "byte")
Anton Yartsev05789592013-03-28 17:05:19 +00001676 << " from the start of ";
1677 if (AllocExpr && printAllocDeallocName(AllocNameOs, C, AllocExpr))
1678 os << "memory allocated by " << AllocNameOs.str();
1679 else
1680 os << "allocated memory";
Anna Zaksc89ad072013-02-07 23:05:47 +00001681
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001682 BugReport *R = new BugReport(*BT_OffsetFree[*CheckKind], os.str(), N);
Anna Zaksc89ad072013-02-07 23:05:47 +00001683 R->markInteresting(MR->getBaseRegion());
1684 R->addRange(Range);
1685 C.emitReport(R);
1686}
1687
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001688void MallocChecker::ReportUseAfterFree(CheckerContext &C, SourceRange Range,
1689 SymbolRef Sym) const {
1690
Gabor Horvathe40c71c2015-03-04 17:59:34 +00001691 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_MallocChecker,
Anton Yartseve5c0c142015-02-18 00:39:06 +00001692 CK_NewDeleteChecker),
1693 C, Sym);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001694 if (!CheckKind.hasValue())
Anton Yartseve3377fb2013-04-04 23:46:29 +00001695 return;
1696
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001697 if (ExplodedNode *N = C.generateSink()) {
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001698 if (!BT_UseFree[*CheckKind])
1699 BT_UseFree[*CheckKind].reset(new BugType(
1700 CheckNames[*CheckKind], "Use-after-free", "Memory Error"));
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001701
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001702 BugReport *R = new BugReport(*BT_UseFree[*CheckKind],
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001703 "Use of memory after it is freed", N);
1704
1705 R->markInteresting(Sym);
1706 R->addRange(Range);
David Blaikie91e79022014-09-04 23:54:33 +00001707 R->addVisitor(llvm::make_unique<MallocBugVisitor>(Sym));
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001708 C.emitReport(R);
1709 }
1710}
1711
1712void MallocChecker::ReportDoubleFree(CheckerContext &C, SourceRange Range,
1713 bool Released, SymbolRef Sym,
Anton Yartsev6c2af432013-03-13 17:07:32 +00001714 SymbolRef PrevSym) const {
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001715
Gabor Horvathe40c71c2015-03-04 17:59:34 +00001716 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_MallocChecker,
Anton Yartseve5c0c142015-02-18 00:39:06 +00001717 CK_NewDeleteChecker),
1718 C, Sym);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001719 if (!CheckKind.hasValue())
Anton Yartseve3377fb2013-04-04 23:46:29 +00001720 return;
1721
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001722 if (ExplodedNode *N = C.generateSink()) {
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001723 if (!BT_DoubleFree[*CheckKind])
1724 BT_DoubleFree[*CheckKind].reset(
1725 new BugType(CheckNames[*CheckKind], "Double free", "Memory Error"));
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001726
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001727 BugReport *R =
1728 new BugReport(*BT_DoubleFree[*CheckKind],
1729 (Released ? "Attempt to free released memory"
1730 : "Attempt to free non-owned memory"),
1731 N);
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001732 R->addRange(Range);
Anton Yartsev6c2af432013-03-13 17:07:32 +00001733 R->markInteresting(Sym);
1734 if (PrevSym)
1735 R->markInteresting(PrevSym);
David Blaikie91e79022014-09-04 23:54:33 +00001736 R->addVisitor(llvm::make_unique<MallocBugVisitor>(Sym));
Anton Yartsev59ed15b2013-03-13 14:39:10 +00001737 C.emitReport(R);
1738 }
1739}
1740
Jordan Rose656fdd52014-01-08 18:46:55 +00001741void MallocChecker::ReportDoubleDelete(CheckerContext &C, SymbolRef Sym) const {
1742
Anton Yartseve5c0c142015-02-18 00:39:06 +00001743 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_NewDeleteChecker),
1744 C, Sym);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001745 if (!CheckKind.hasValue())
Jordan Rose656fdd52014-01-08 18:46:55 +00001746 return;
1747
1748 if (ExplodedNode *N = C.generateSink()) {
1749 if (!BT_DoubleDelete)
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001750 BT_DoubleDelete.reset(new BugType(CheckNames[CK_NewDeleteChecker],
1751 "Double delete", "Memory Error"));
Jordan Rose656fdd52014-01-08 18:46:55 +00001752
1753 BugReport *R = new BugReport(*BT_DoubleDelete,
1754 "Attempt to delete released memory", N);
1755
1756 R->markInteresting(Sym);
David Blaikie91e79022014-09-04 23:54:33 +00001757 R->addVisitor(llvm::make_unique<MallocBugVisitor>(Sym));
Jordan Rose656fdd52014-01-08 18:46:55 +00001758 C.emitReport(R);
1759 }
1760}
1761
Anna Zaks40a7eb32012-02-22 19:24:52 +00001762ProgramStateRef MallocChecker::ReallocMem(CheckerContext &C,
1763 const CallExpr *CE,
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001764 bool FreesOnFail,
1765 ProgramStateRef State) const {
1766 if (!State)
1767 return nullptr;
1768
Anna Zaksb508d292012-04-10 23:41:11 +00001769 if (CE->getNumArgs() < 2)
Craig Topper0dbb7832014-05-27 02:45:47 +00001770 return nullptr;
Anna Zaksb508d292012-04-10 23:41:11 +00001771
Ted Kremenek90af9092010-12-02 07:49:45 +00001772 const Expr *arg0Expr = CE->getArg(0);
Ted Kremenek632e3b72012-01-06 22:09:28 +00001773 const LocationContext *LCtx = C.getLocationContext();
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001774 SVal Arg0Val = State->getSVal(arg0Expr, LCtx);
David Blaikie2fdacbc2013-02-20 05:52:05 +00001775 if (!Arg0Val.getAs<DefinedOrUnknownSVal>())
Craig Topper0dbb7832014-05-27 02:45:47 +00001776 return nullptr;
David Blaikie2fdacbc2013-02-20 05:52:05 +00001777 DefinedOrUnknownSVal arg0Val = Arg0Val.castAs<DefinedOrUnknownSVal>();
Zhongxing Xuc0484fa2009-12-12 12:29:38 +00001778
Ted Kremenek9d0bb1e2010-12-01 21:28:31 +00001779 SValBuilder &svalBuilder = C.getSValBuilder();
Zhongxing Xuc0484fa2009-12-12 12:29:38 +00001780
Ted Kremenek90af9092010-12-02 07:49:45 +00001781 DefinedOrUnknownSVal PtrEQ =
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001782 svalBuilder.evalEQ(State, arg0Val, svalBuilder.makeNull());
Zhongxing Xuc0484fa2009-12-12 12:29:38 +00001783
Lenny Maiorani005b5c12011-04-27 14:49:29 +00001784 // Get the size argument. If there is no size arg then give up.
1785 const Expr *Arg1 = CE->getArg(1);
1786 if (!Arg1)
Craig Topper0dbb7832014-05-27 02:45:47 +00001787 return nullptr;
Lenny Maiorani005b5c12011-04-27 14:49:29 +00001788
1789 // Get the value of the size argument.
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001790 SVal Arg1ValG = State->getSVal(Arg1, LCtx);
David Blaikie2fdacbc2013-02-20 05:52:05 +00001791 if (!Arg1ValG.getAs<DefinedOrUnknownSVal>())
Craig Topper0dbb7832014-05-27 02:45:47 +00001792 return nullptr;
David Blaikie2fdacbc2013-02-20 05:52:05 +00001793 DefinedOrUnknownSVal Arg1Val = Arg1ValG.castAs<DefinedOrUnknownSVal>();
Lenny Maiorani005b5c12011-04-27 14:49:29 +00001794
1795 // Compare the size argument to 0.
1796 DefinedOrUnknownSVal SizeZero =
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001797 svalBuilder.evalEQ(State, Arg1Val,
Lenny Maiorani005b5c12011-04-27 14:49:29 +00001798 svalBuilder.makeIntValWithPtrWidth(0, false));
1799
Anna Zaksd56c8792012-02-13 18:05:39 +00001800 ProgramStateRef StatePtrIsNull, StatePtrNotNull;
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001801 std::tie(StatePtrIsNull, StatePtrNotNull) = State->assume(PtrEQ);
Anna Zaksd56c8792012-02-13 18:05:39 +00001802 ProgramStateRef StateSizeIsZero, StateSizeNotZero;
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001803 std::tie(StateSizeIsZero, StateSizeNotZero) = State->assume(SizeZero);
Anna Zaksd56c8792012-02-13 18:05:39 +00001804 // We only assume exceptional states if they are definitely true; if the
1805 // state is under-constrained, assume regular realloc behavior.
1806 bool PrtIsNull = StatePtrIsNull && !StatePtrNotNull;
1807 bool SizeIsZero = StateSizeIsZero && !StateSizeNotZero;
1808
Lenny Maiorani005b5c12011-04-27 14:49:29 +00001809 // If the ptr is NULL and the size is not 0, the call is equivalent to
1810 // malloc(size).
Anna Zaksd56c8792012-02-13 18:05:39 +00001811 if ( PrtIsNull && !SizeIsZero) {
Anna Zaks40a7eb32012-02-22 19:24:52 +00001812 ProgramStateRef stateMalloc = MallocMemAux(C, CE, CE->getArg(1),
Anna Zaksd56c8792012-02-13 18:05:39 +00001813 UndefinedVal(), StatePtrIsNull);
Anna Zaks40a7eb32012-02-22 19:24:52 +00001814 return stateMalloc;
Zhongxing Xuc0484fa2009-12-12 12:29:38 +00001815 }
1816
Anna Zaksd56c8792012-02-13 18:05:39 +00001817 if (PrtIsNull && SizeIsZero)
Craig Topper0dbb7832014-05-27 02:45:47 +00001818 return nullptr;
Zhongxing Xuc0484fa2009-12-12 12:29:38 +00001819
Anna Zaks8fd0f2a2012-02-13 20:57:07 +00001820 // Get the from and to pointer symbols as in toPtr = realloc(fromPtr, size).
Anna Zaksd56c8792012-02-13 18:05:39 +00001821 assert(!PrtIsNull);
Anna Zaks8fd0f2a2012-02-13 20:57:07 +00001822 SymbolRef FromPtr = arg0Val.getAsSymbol();
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001823 SVal RetVal = State->getSVal(CE, LCtx);
Anna Zaks8fd0f2a2012-02-13 20:57:07 +00001824 SymbolRef ToPtr = RetVal.getAsSymbol();
1825 if (!FromPtr || !ToPtr)
Craig Topper0dbb7832014-05-27 02:45:47 +00001826 return nullptr;
Anna Zaksd56c8792012-02-13 18:05:39 +00001827
Anna Zaksfe6eb672012-08-24 02:28:20 +00001828 bool ReleasedAllocated = false;
1829
Anna Zaksd56c8792012-02-13 18:05:39 +00001830 // If the size is 0, free the memory.
1831 if (SizeIsZero)
Anna Zaksfe6eb672012-08-24 02:28:20 +00001832 if (ProgramStateRef stateFree = FreeMemAux(C, CE, StateSizeIsZero, 0,
1833 false, ReleasedAllocated)){
Anna Zaksd56c8792012-02-13 18:05:39 +00001834 // The semantics of the return value are:
1835 // If size was equal to 0, either NULL or a pointer suitable to be passed
Anna Zaks52242a62012-08-03 18:30:18 +00001836 // to free() is returned. We just free the input pointer and do not add
1837 // any constrains on the output pointer.
Anna Zaks40a7eb32012-02-22 19:24:52 +00001838 return stateFree;
Anna Zaksd56c8792012-02-13 18:05:39 +00001839 }
1840
1841 // Default behavior.
Anna Zaksfe6eb672012-08-24 02:28:20 +00001842 if (ProgramStateRef stateFree =
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001843 FreeMemAux(C, CE, State, 0, false, ReleasedAllocated)) {
Anna Zaksfe6eb672012-08-24 02:28:20 +00001844
Anna Zaksd56c8792012-02-13 18:05:39 +00001845 ProgramStateRef stateRealloc = MallocMemAux(C, CE, CE->getArg(1),
1846 UnknownVal(), stateFree);
Anna Zaks8fd0f2a2012-02-13 20:57:07 +00001847 if (!stateRealloc)
Craig Topper0dbb7832014-05-27 02:45:47 +00001848 return nullptr;
Anna Zaksfe6eb672012-08-24 02:28:20 +00001849
Anna Zaks75cfbb62012-09-12 22:57:34 +00001850 ReallocPairKind Kind = RPToBeFreedAfterFailure;
1851 if (FreesOnFail)
1852 Kind = RPIsFreeOnFailure;
1853 else if (!ReleasedAllocated)
1854 Kind = RPDoNotTrackAfterFailure;
1855
Anna Zaksfe6eb672012-08-24 02:28:20 +00001856 // Record the info about the reallocated symbol so that we could properly
1857 // process failed reallocation.
Anna Zaksac068142012-02-15 00:11:25 +00001858 stateRealloc = stateRealloc->set<ReallocPairs>(ToPtr,
Anna Zaks75cfbb62012-09-12 22:57:34 +00001859 ReallocPair(FromPtr, Kind));
Anna Zaksfe6eb672012-08-24 02:28:20 +00001860 // The reallocated symbol should stay alive for as long as the new symbol.
Anna Zaksad01ef52012-02-14 00:26:13 +00001861 C.getSymbolManager().addSymbolDependency(ToPtr, FromPtr);
Anna Zaks40a7eb32012-02-22 19:24:52 +00001862 return stateRealloc;
Zhongxing Xuc0484fa2009-12-12 12:29:38 +00001863 }
Craig Topper0dbb7832014-05-27 02:45:47 +00001864 return nullptr;
Zhongxing Xu88cca6b2009-11-12 08:38:56 +00001865}
Zhongxing Xuc4902a52009-11-13 07:25:27 +00001866
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001867ProgramStateRef MallocChecker::CallocMem(CheckerContext &C, const CallExpr *CE,
1868 ProgramStateRef State) {
1869 if (!State)
1870 return nullptr;
1871
Anna Zaksb508d292012-04-10 23:41:11 +00001872 if (CE->getNumArgs() < 2)
Craig Topper0dbb7832014-05-27 02:45:47 +00001873 return nullptr;
Anna Zaksb508d292012-04-10 23:41:11 +00001874
Ted Kremenek9d0bb1e2010-12-01 21:28:31 +00001875 SValBuilder &svalBuilder = C.getSValBuilder();
Ted Kremenek632e3b72012-01-06 22:09:28 +00001876 const LocationContext *LCtx = C.getLocationContext();
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001877 SVal count = State->getSVal(CE->getArg(0), LCtx);
1878 SVal elementSize = State->getSVal(CE->getArg(1), LCtx);
1879 SVal TotalSize = svalBuilder.evalBinOp(State, BO_Mul, count, elementSize,
Ted Kremenek90af9092010-12-02 07:49:45 +00001880 svalBuilder.getContext().getSizeType());
1881 SVal zeroVal = svalBuilder.makeZeroVal(svalBuilder.getContext().CharTy);
Zhongxing Xu527ff6d2010-06-01 03:01:33 +00001882
Anton Yartsevb3fa86d2015-02-10 20:13:08 +00001883 return MallocMemAux(C, CE, TotalSize, zeroVal, State);
Zhongxing Xu527ff6d2010-06-01 03:01:33 +00001884}
1885
Anna Zaksfc2e1532012-03-21 19:45:08 +00001886LeakInfo
Anna Zaksdf901a42012-02-23 21:38:21 +00001887MallocChecker::getAllocationSite(const ExplodedNode *N, SymbolRef Sym,
1888 CheckerContext &C) const {
Anna Zaks43ffba22012-02-27 23:40:55 +00001889 const LocationContext *LeakContext = N->getLocationContext();
Anna Zaksdf901a42012-02-23 21:38:21 +00001890 // Walk the ExplodedGraph backwards and find the first node that referred to
1891 // the tracked symbol.
1892 const ExplodedNode *AllocNode = N;
Craig Topper0dbb7832014-05-27 02:45:47 +00001893 const MemRegion *ReferenceRegion = nullptr;
Anna Zaksdf901a42012-02-23 21:38:21 +00001894
1895 while (N) {
Anna Zaksfc2e1532012-03-21 19:45:08 +00001896 ProgramStateRef State = N->getState();
1897 if (!State->get<RegionState>(Sym))
Anna Zaksdf901a42012-02-23 21:38:21 +00001898 break;
Anna Zaksfc2e1532012-03-21 19:45:08 +00001899
1900 // Find the most recent expression bound to the symbol in the current
1901 // context.
Anna Zaks7c19abe2013-04-10 21:42:02 +00001902 if (!ReferenceRegion) {
1903 if (const MemRegion *MR = C.getLocationRegionIfPostStore(N)) {
1904 SVal Val = State->getSVal(MR);
1905 if (Val.getAsLocSymbol() == Sym) {
Anna Zaks07804ef2013-04-10 22:56:33 +00001906 const VarRegion* VR = MR->getBaseRegion()->getAs<VarRegion>();
Anna Zaks7c19abe2013-04-10 21:42:02 +00001907 // Do not show local variables belonging to a function other than
1908 // where the error is reported.
1909 if (!VR ||
1910 (VR->getStackFrame() == LeakContext->getCurrentStackFrame()))
1911 ReferenceRegion = MR;
1912 }
1913 }
Benjamin Kramerc25c5e02012-03-21 21:03:48 +00001914 }
Anna Zaksfc2e1532012-03-21 19:45:08 +00001915
Anna Zaks486a0ff2015-02-05 01:02:53 +00001916 // Allocation node, is the last node in the current or parent context in
1917 // which the symbol was tracked.
1918 const LocationContext *NContext = N->getLocationContext();
1919 if (NContext == LeakContext ||
1920 NContext->isParentOf(LeakContext))
Anna Zaks43ffba22012-02-27 23:40:55 +00001921 AllocNode = N;
Craig Topper0dbb7832014-05-27 02:45:47 +00001922 N = N->pred_empty() ? nullptr : *(N->pred_begin());
Anna Zaksdf901a42012-02-23 21:38:21 +00001923 }
1924
Anna Zaksa043d0c2013-01-08 00:25:29 +00001925 return LeakInfo(AllocNode, ReferenceRegion);
Anna Zaksdf901a42012-02-23 21:38:21 +00001926}
1927
Anna Zaksd3571e5a2012-02-11 21:02:40 +00001928void MallocChecker::reportLeak(SymbolRef Sym, ExplodedNode *N,
1929 CheckerContext &C) const {
Anton Yartsev05789592013-03-28 17:05:19 +00001930
Gabor Horvathe40c71c2015-03-04 17:59:34 +00001931 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_MallocChecker,
Anton Yartseve5c0c142015-02-18 00:39:06 +00001932 CK_NewDeleteLeaksChecker),
1933 C, Sym);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001934 if (!CheckKind.hasValue())
Anton Yartsev6e499252013-04-05 02:25:02 +00001935 return;
1936
Anton Yartsev9907fc92015-03-04 23:18:21 +00001937 const RefState *RS = C.getState()->get<RegionState>(Sym);
1938 assert(RS);
1939 if (RS->getAllocationFamily() == AF_Alloca)
1940 return;
1941
Anna Zaksd3571e5a2012-02-11 21:02:40 +00001942 assert(N);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001943 if (!BT_Leak[*CheckKind]) {
1944 BT_Leak[*CheckKind].reset(
1945 new BugType(CheckNames[*CheckKind], "Memory leak", "Memory Error"));
Anna Zaksd3571e5a2012-02-11 21:02:40 +00001946 // Leaks should not be reported if they are post-dominated by a sink:
1947 // (1) Sinks are higher importance bugs.
1948 // (2) NoReturnFunctionChecker uses sink nodes to represent paths ending
1949 // with __noreturn functions such as assert() or exit(). We choose not
1950 // to report leaks on such paths.
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001951 BT_Leak[*CheckKind]->setSuppressOnSink(true);
Anna Zaksd3571e5a2012-02-11 21:02:40 +00001952 }
1953
Anna Zaksdf901a42012-02-23 21:38:21 +00001954 // Most bug reports are cached at the location where they occurred.
1955 // With leaks, we want to unique them by the location where they were
1956 // allocated, and only report a single path.
Anna Zaks43ffba22012-02-27 23:40:55 +00001957 PathDiagnosticLocation LocUsedForUniqueing;
Craig Topper0dbb7832014-05-27 02:45:47 +00001958 const ExplodedNode *AllocNode = nullptr;
1959 const MemRegion *Region = nullptr;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00001960 std::tie(AllocNode, Region) = getAllocationSite(N, Sym, C);
Anna Zaksa043d0c2013-01-08 00:25:29 +00001961
1962 ProgramPoint P = AllocNode->getLocation();
Craig Topper0dbb7832014-05-27 02:45:47 +00001963 const Stmt *AllocationStmt = nullptr;
David Blaikie87396b92013-02-21 22:23:56 +00001964 if (Optional<CallExitEnd> Exit = P.getAs<CallExitEnd>())
Anna Zaksa043d0c2013-01-08 00:25:29 +00001965 AllocationStmt = Exit->getCalleeContext()->getCallSite();
David Blaikie87396b92013-02-21 22:23:56 +00001966 else if (Optional<StmtPoint> SP = P.getAs<StmtPoint>())
Anna Zaksa043d0c2013-01-08 00:25:29 +00001967 AllocationStmt = SP->getStmt();
Anton Yartsev6e499252013-04-05 02:25:02 +00001968 if (AllocationStmt)
Anna Zaksa043d0c2013-01-08 00:25:29 +00001969 LocUsedForUniqueing = PathDiagnosticLocation::createBegin(AllocationStmt,
1970 C.getSourceManager(),
1971 AllocNode->getLocationContext());
Anna Zaksdf901a42012-02-23 21:38:21 +00001972
Anna Zaksfc2e1532012-03-21 19:45:08 +00001973 SmallString<200> buf;
1974 llvm::raw_svector_ostream os(buf);
Jordan Rosed86b3bd2012-08-08 18:23:36 +00001975 if (Region && Region->canPrintPretty()) {
Anna Zaks6cea7d92013-04-12 18:40:21 +00001976 os << "Potential leak of memory pointed to by ";
Jordan Rosed86b3bd2012-08-08 18:23:36 +00001977 Region->printPretty(os);
Anna Zaksa1de8562013-04-06 00:41:36 +00001978 } else {
1979 os << "Potential memory leak";
Anna Zaksfc2e1532012-03-21 19:45:08 +00001980 }
1981
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00001982 BugReport *R =
1983 new BugReport(*BT_Leak[*CheckKind], os.str(), N, LocUsedForUniqueing,
1984 AllocNode->getLocationContext()->getDecl());
Ted Kremenek1e809b42012-03-09 01:13:14 +00001985 R->markInteresting(Sym);
David Blaikie91e79022014-09-04 23:54:33 +00001986 R->addVisitor(llvm::make_unique<MallocBugVisitor>(Sym, true));
Jordan Rosee10d5a72012-11-02 01:53:40 +00001987 C.emitReport(R);
Anna Zaksd3571e5a2012-02-11 21:02:40 +00001988}
1989
Argyrios Kyrtzidis183f0fb2011-02-28 01:26:35 +00001990void MallocChecker::checkDeadSymbols(SymbolReaper &SymReaper,
1991 CheckerContext &C) const
Ted Kremenek90af9092010-12-02 07:49:45 +00001992{
Zhongxing Xubce831f2010-08-15 08:19:57 +00001993 if (!SymReaper.hasDeadSymbols())
1994 return;
Zhongxing Xuc7460962009-11-13 07:48:11 +00001995
Ted Kremenek49b1e382012-01-26 21:29:00 +00001996 ProgramStateRef state = C.getState();
Zhongxing Xubce831f2010-08-15 08:19:57 +00001997 RegionStateTy RS = state->get<RegionState>();
Jordy Rose82584992010-08-18 04:33:47 +00001998 RegionStateTy::Factory &F = state->get_context<RegionState>();
Zhongxing Xubce831f2010-08-15 08:19:57 +00001999
Dmitri Gribenkof8579502013-01-12 19:30:44 +00002000 SmallVector<SymbolRef, 2> Errors;
Zhongxing Xubce831f2010-08-15 08:19:57 +00002001 for (RegionStateTy::iterator I = RS.begin(), E = RS.end(); I != E; ++I) {
2002 if (SymReaper.isDead(I->first)) {
Anna Zaks58a2c4e2012-10-29 22:51:54 +00002003 if (I->second.isAllocated())
Anna Zaks78edc2f2012-02-09 06:48:19 +00002004 Errors.push_back(I->first);
Jordy Rose82584992010-08-18 04:33:47 +00002005 // Remove the dead symbol from the map.
Ted Kremenekb3b56c62010-11-24 00:54:37 +00002006 RS = F.remove(RS, I->first);
Ted Kremeneke227f492011-07-28 23:07:51 +00002007
Zhongxing Xuc7460962009-11-13 07:48:11 +00002008 }
2009 }
Ted Kremeneke227f492011-07-28 23:07:51 +00002010
Anna Zaksd56c8792012-02-13 18:05:39 +00002011 // Cleanup the Realloc Pairs Map.
Jordan Rose0c153cb2012-11-02 01:54:06 +00002012 ReallocPairsTy RP = state->get<ReallocPairs>();
2013 for (ReallocPairsTy::iterator I = RP.begin(), E = RP.end(); I != E; ++I) {
Anna Zaksac068142012-02-15 00:11:25 +00002014 if (SymReaper.isDead(I->first) ||
2015 SymReaper.isDead(I->second.ReallocatedSym)) {
Anna Zaksd56c8792012-02-13 18:05:39 +00002016 state = state->remove<ReallocPairs>(I->first);
2017 }
2018 }
2019
Anna Zaks67291b92012-11-13 03:18:01 +00002020 // Cleanup the FreeReturnValue Map.
2021 FreeReturnValueTy FR = state->get<FreeReturnValue>();
2022 for (FreeReturnValueTy::iterator I = FR.begin(), E = FR.end(); I != E; ++I) {
2023 if (SymReaper.isDead(I->first) ||
2024 SymReaper.isDead(I->second)) {
2025 state = state->remove<FreeReturnValue>(I->first);
2026 }
2027 }
2028
Anna Zaksdf901a42012-02-23 21:38:21 +00002029 // Generate leak node.
Anna Zaks58a2c4e2012-10-29 22:51:54 +00002030 ExplodedNode *N = C.getPredecessor();
2031 if (!Errors.empty()) {
Anton Yartsev6a619222014-02-17 18:25:34 +00002032 static CheckerProgramPointTag Tag("MallocChecker", "DeadSymbolsLeak");
Anna Zaks58a2c4e2012-10-29 22:51:54 +00002033 N = C.addTransition(C.getState(), C.getPredecessor(), &Tag);
Craig Topper2341c0d2013-07-04 03:08:24 +00002034 for (SmallVectorImpl<SymbolRef>::iterator
2035 I = Errors.begin(), E = Errors.end(); I != E; ++I) {
Anna Zaksd3571e5a2012-02-11 21:02:40 +00002036 reportLeak(*I, N, C);
Anna Zaks78edc2f2012-02-09 06:48:19 +00002037 }
Ted Kremeneke227f492011-07-28 23:07:51 +00002038 }
Anna Zaks58a2c4e2012-10-29 22:51:54 +00002039
Anna Zaksdf901a42012-02-23 21:38:21 +00002040 C.addTransition(state->set<RegionState>(RS), N);
Zhongxing Xuc4902a52009-11-13 07:25:27 +00002041}
Zhongxing Xu4668c7e2009-11-17 07:54:15 +00002042
Anton Yartsevcb2ccd62013-04-10 22:21:41 +00002043void MallocChecker::checkPreCall(const CallEvent &Call,
2044 CheckerContext &C) const {
2045
Jordan Rose656fdd52014-01-08 18:46:55 +00002046 if (const CXXDestructorCall *DC = dyn_cast<CXXDestructorCall>(&Call)) {
2047 SymbolRef Sym = DC->getCXXThisVal().getAsSymbol();
2048 if (!Sym || checkDoubleDelete(Sym, C))
2049 return;
2050 }
2051
Anna Zaks46d01602012-05-18 01:16:10 +00002052 // We will check for double free in the post visit.
Anton Yartsevcb2ccd62013-04-10 22:21:41 +00002053 if (const AnyFunctionCall *FC = dyn_cast<AnyFunctionCall>(&Call)) {
2054 const FunctionDecl *FD = FC->getDecl();
2055 if (!FD)
2056 return;
Anton Yartsev13df0362013-03-25 01:35:45 +00002057
Anna Zaksd79b8402014-10-03 21:48:59 +00002058 ASTContext &Ctx = C.getASTContext();
Gabor Horvathe40c71c2015-03-04 17:59:34 +00002059 if (ChecksEnabled[CK_MallocChecker] &&
Anna Zaksd79b8402014-10-03 21:48:59 +00002060 (isCMemFunction(FD, Ctx, AF_Malloc, MemoryOperationKind::MOK_Free) ||
2061 isCMemFunction(FD, Ctx, AF_IfNameIndex,
2062 MemoryOperationKind::MOK_Free)))
Anton Yartsevcb2ccd62013-04-10 22:21:41 +00002063 return;
Anna Zaks3d348342012-02-14 21:55:24 +00002064
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00002065 if (ChecksEnabled[CK_NewDeleteChecker] &&
Anna Zaksd79b8402014-10-03 21:48:59 +00002066 isStandardNewDelete(FD, Ctx))
Anton Yartsevcb2ccd62013-04-10 22:21:41 +00002067 return;
2068 }
2069
2070 // Check if the callee of a method is deleted.
2071 if (const CXXInstanceCall *CC = dyn_cast<CXXInstanceCall>(&Call)) {
2072 SymbolRef Sym = CC->getCXXThisVal().getAsSymbol();
2073 if (!Sym || checkUseAfterFree(Sym, C, CC->getCXXThisExpr()))
2074 return;
2075 }
2076
2077 // Check arguments for being used after free.
2078 for (unsigned I = 0, E = Call.getNumArgs(); I != E; ++I) {
2079 SVal ArgSVal = Call.getArgSVal(I);
2080 if (ArgSVal.getAs<Loc>()) {
2081 SymbolRef Sym = ArgSVal.getAsSymbol();
Anna Zaks3d348342012-02-14 21:55:24 +00002082 if (!Sym)
2083 continue;
Anton Yartsevcb2ccd62013-04-10 22:21:41 +00002084 if (checkUseAfterFree(Sym, C, Call.getArgExpr(I)))
Anna Zaks3d348342012-02-14 21:55:24 +00002085 return;
2086 }
2087 }
2088}
2089
Anna Zaksa1b227b2012-02-08 23:16:56 +00002090void MallocChecker::checkPreStmt(const ReturnStmt *S, CheckerContext &C) const {
2091 const Expr *E = S->getRetValue();
2092 if (!E)
2093 return;
Anna Zaks3aa52252012-02-11 21:44:39 +00002094
2095 // Check if we are returning a symbol.
Jordan Rose356279c2012-08-08 18:23:31 +00002096 ProgramStateRef State = C.getState();
2097 SVal RetVal = State->getSVal(E, C.getLocationContext());
Anna Zaks4ca45b12012-02-22 02:36:01 +00002098 SymbolRef Sym = RetVal.getAsSymbol();
2099 if (!Sym)
2100 // If we are returning a field of the allocated struct or an array element,
2101 // the callee could still free the memory.
2102 // TODO: This logic should be a part of generic symbol escape callback.
2103 if (const MemRegion *MR = RetVal.getAsRegion())
2104 if (isa<FieldRegion>(MR) || isa<ElementRegion>(MR))
2105 if (const SymbolicRegion *BMR =
2106 dyn_cast<SymbolicRegion>(MR->getBaseRegion()))
2107 Sym = BMR->getSymbol();
Zhongxing Xu23baa012009-11-17 08:58:18 +00002108
Anna Zaks3aa52252012-02-11 21:44:39 +00002109 // Check if we are returning freed memory.
Jordan Rose356279c2012-08-08 18:23:31 +00002110 if (Sym)
Jordan Rosef1f26142012-11-15 19:11:33 +00002111 checkUseAfterFree(Sym, C, E);
Zhongxing Xu23baa012009-11-17 08:58:18 +00002112}
Zhongxing Xub0e15df2009-12-31 06:13:07 +00002113
Anna Zaks9fe80982012-03-22 00:57:20 +00002114// TODO: Blocks should be either inlined or should call invalidate regions
2115// upon invocation. After that's in place, special casing here will not be
2116// needed.
2117void MallocChecker::checkPostStmt(const BlockExpr *BE,
2118 CheckerContext &C) const {
2119
2120 // Scan the BlockDecRefExprs for any object the retain count checker
2121 // may be tracking.
2122 if (!BE->getBlockDecl()->hasCaptures())
2123 return;
2124
2125 ProgramStateRef state = C.getState();
2126 const BlockDataRegion *R =
2127 cast<BlockDataRegion>(state->getSVal(BE,
2128 C.getLocationContext()).getAsRegion());
2129
2130 BlockDataRegion::referenced_vars_iterator I = R->referenced_vars_begin(),
2131 E = R->referenced_vars_end();
2132
2133 if (I == E)
2134 return;
2135
2136 SmallVector<const MemRegion*, 10> Regions;
2137 const LocationContext *LC = C.getLocationContext();
2138 MemRegionManager &MemMgr = C.getSValBuilder().getRegionManager();
2139
2140 for ( ; I != E; ++I) {
Ted Kremenekbcf90532012-12-06 07:17:20 +00002141 const VarRegion *VR = I.getCapturedRegion();
Anna Zaks9fe80982012-03-22 00:57:20 +00002142 if (VR->getSuperRegion() == R) {
2143 VR = MemMgr.getVarRegion(VR->getDecl(), LC);
2144 }
2145 Regions.push_back(VR);
2146 }
2147
2148 state =
2149 state->scanReachableSymbols<StopTrackingCallback>(Regions.data(),
2150 Regions.data() + Regions.size()).getState();
2151 C.addTransition(state);
2152}
2153
Anna Zaks46d01602012-05-18 01:16:10 +00002154bool MallocChecker::isReleased(SymbolRef Sym, CheckerContext &C) const {
Anna Zaksa1b227b2012-02-08 23:16:56 +00002155 assert(Sym);
2156 const RefState *RS = C.getState()->get<RegionState>(Sym);
Anna Zaks46d01602012-05-18 01:16:10 +00002157 return (RS && RS->isReleased());
2158}
2159
2160bool MallocChecker::checkUseAfterFree(SymbolRef Sym, CheckerContext &C,
2161 const Stmt *S) const {
Anna Zaksa1b227b2012-02-08 23:16:56 +00002162
Jordan Rose656fdd52014-01-08 18:46:55 +00002163 if (isReleased(Sym, C)) {
Anton Yartsev59ed15b2013-03-13 14:39:10 +00002164 ReportUseAfterFree(C, S->getSourceRange(), Sym);
2165 return true;
Anna Zaksa1b227b2012-02-08 23:16:56 +00002166 }
Anton Yartsev59ed15b2013-03-13 14:39:10 +00002167
Anna Zaksa1b227b2012-02-08 23:16:56 +00002168 return false;
2169}
2170
Jordan Rose656fdd52014-01-08 18:46:55 +00002171bool MallocChecker::checkDoubleDelete(SymbolRef Sym, CheckerContext &C) const {
2172
2173 if (isReleased(Sym, C)) {
2174 ReportDoubleDelete(C, Sym);
2175 return true;
2176 }
2177 return false;
2178}
2179
Zhongxing Xu1bb6a1a2010-03-10 04:58:55 +00002180// Check if the location is a freed symbolic region.
Anna Zaks3e0f4152011-10-06 00:43:15 +00002181void MallocChecker::checkLocation(SVal l, bool isLoad, const Stmt *S,
2182 CheckerContext &C) const {
Zhongxing Xu1bb6a1a2010-03-10 04:58:55 +00002183 SymbolRef Sym = l.getLocSymbolInBase();
Anna Zaksa1b227b2012-02-08 23:16:56 +00002184 if (Sym)
Anna Zaks46d01602012-05-18 01:16:10 +00002185 checkUseAfterFree(Sym, C, S);
Zhongxing Xu1bb6a1a2010-03-10 04:58:55 +00002186}
Ted Kremenekd21139a2010-07-31 01:52:11 +00002187
Anna Zaksbb1ef902012-02-11 21:02:35 +00002188// If a symbolic region is assumed to NULL (or another constant), stop tracking
2189// it - assuming that allocation failed on this path.
2190ProgramStateRef MallocChecker::evalAssume(ProgramStateRef state,
2191 SVal Cond,
2192 bool Assumption) const {
2193 RegionStateTy RS = state->get<RegionState>();
Anna Zaksbb1ef902012-02-11 21:02:35 +00002194 for (RegionStateTy::iterator I = RS.begin(), E = RS.end(); I != E; ++I) {
Ted Kremenek244e1d72012-09-07 22:31:01 +00002195 // If the symbol is assumed to be NULL, remove it from consideration.
Jordan Rose14fe9f32012-11-01 00:18:27 +00002196 ConstraintManager &CMgr = state->getConstraintManager();
2197 ConditionTruthVal AllocFailed = CMgr.isNull(state, I.getKey());
2198 if (AllocFailed.isConstrainedTrue())
Anna Zaksbb1ef902012-02-11 21:02:35 +00002199 state = state->remove<RegionState>(I.getKey());
2200 }
2201
Anna Zaksd56c8792012-02-13 18:05:39 +00002202 // Realloc returns 0 when reallocation fails, which means that we should
2203 // restore the state of the pointer being reallocated.
Jordan Rose0c153cb2012-11-02 01:54:06 +00002204 ReallocPairsTy RP = state->get<ReallocPairs>();
2205 for (ReallocPairsTy::iterator I = RP.begin(), E = RP.end(); I != E; ++I) {
Ted Kremenek244e1d72012-09-07 22:31:01 +00002206 // If the symbol is assumed to be NULL, remove it from consideration.
Jordan Rose14fe9f32012-11-01 00:18:27 +00002207 ConstraintManager &CMgr = state->getConstraintManager();
2208 ConditionTruthVal AllocFailed = CMgr.isNull(state, I.getKey());
Jordan Rose40bb12492012-11-01 00:25:15 +00002209 if (!AllocFailed.isConstrainedTrue())
Anna Zaks75cfbb62012-09-12 22:57:34 +00002210 continue;
Jordan Rose14fe9f32012-11-01 00:18:27 +00002211
Anna Zaks75cfbb62012-09-12 22:57:34 +00002212 SymbolRef ReallocSym = I.getData().ReallocatedSym;
2213 if (const RefState *RS = state->get<RegionState>(ReallocSym)) {
2214 if (RS->isReleased()) {
2215 if (I.getData().Kind == RPToBeFreedAfterFailure)
Anna Zaksac068142012-02-15 00:11:25 +00002216 state = state->set<RegionState>(ReallocSym,
Anton Yartsev05789592013-03-28 17:05:19 +00002217 RefState::getAllocated(RS->getAllocationFamily(), RS->getStmt()));
Anna Zaks75cfbb62012-09-12 22:57:34 +00002218 else if (I.getData().Kind == RPDoNotTrackAfterFailure)
2219 state = state->remove<RegionState>(ReallocSym);
2220 else
2221 assert(I.getData().Kind == RPIsFreeOnFailure);
Anna Zaksd56c8792012-02-13 18:05:39 +00002222 }
Anna Zaksd56c8792012-02-13 18:05:39 +00002223 }
Anna Zaks75cfbb62012-09-12 22:57:34 +00002224 state = state->remove<ReallocPairs>(I.getKey());
Anna Zaksd56c8792012-02-13 18:05:39 +00002225 }
2226
Anna Zaksbb1ef902012-02-11 21:02:35 +00002227 return state;
2228}
2229
Anna Zaks8ebeb642013-06-08 00:29:29 +00002230bool MallocChecker::mayFreeAnyEscapedMemoryOrIsModeledExplicitly(
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002231 const CallEvent *Call,
2232 ProgramStateRef State,
2233 SymbolRef &EscapingSymbol) const {
Jordan Rose7ab01822012-07-02 19:27:51 +00002234 assert(Call);
Craig Topper0dbb7832014-05-27 02:45:47 +00002235 EscapingSymbol = nullptr;
2236
Jordan Rose2a833ca2014-01-15 17:25:15 +00002237 // For now, assume that any C++ or block call can free memory.
Anna Zaks7ac344a2012-02-24 23:56:53 +00002238 // TODO: If we want to be more optimistic here, we'll need to make sure that
2239 // regions escape to C++ containers. They seem to do that even now, but for
2240 // mysterious reasons.
Jordan Rose2a833ca2014-01-15 17:25:15 +00002241 if (!(isa<SimpleFunctionCall>(Call) || isa<ObjCMethodCall>(Call)))
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002242 return true;
Anna Zaks7ac344a2012-02-24 23:56:53 +00002243
Jordan Rose742920c2012-07-02 19:27:35 +00002244 // Check Objective-C messages by selector name.
Jordan Rose6bad4902012-07-02 19:27:56 +00002245 if (const ObjCMethodCall *Msg = dyn_cast<ObjCMethodCall>(Call)) {
Jordan Rose7ab01822012-07-02 19:27:51 +00002246 // If it's not a framework call, or if it takes a callback, assume it
2247 // can free memory.
2248 if (!Call->isInSystemHeader() || Call->hasNonZeroCallbackArg())
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002249 return true;
Anna Zaks06a77fc2012-02-28 01:54:22 +00002250
Jordan Rose613f3c02013-03-09 00:59:10 +00002251 // If it's a method we know about, handle it explicitly post-call.
2252 // This should happen before the "freeWhenDone" check below.
2253 if (isKnownDeallocObjCMethodName(*Msg))
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002254 return false;
Anna Zaks886dfb82012-06-20 23:35:57 +00002255
Jordan Rose613f3c02013-03-09 00:59:10 +00002256 // If there's a "freeWhenDone" parameter, but the method isn't one we know
2257 // about, we can't be sure that the object will use free() to deallocate the
2258 // memory, so we can't model it explicitly. The best we can do is use it to
2259 // decide whether the pointer escapes.
2260 if (Optional<bool> FreeWhenDone = getFreeWhenDoneArg(*Msg))
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002261 return *FreeWhenDone;
Anna Zaks7ac344a2012-02-24 23:56:53 +00002262
Jordan Rose613f3c02013-03-09 00:59:10 +00002263 // If the first selector piece ends with "NoCopy", and there is no
2264 // "freeWhenDone" parameter set to zero, we know ownership is being
2265 // transferred. Again, though, we can't be sure that the object will use
2266 // free() to deallocate the memory, so we can't model it explicitly.
2267 StringRef FirstSlot = Msg->getSelector().getNameForSlot(0);
Jordan Rose742920c2012-07-02 19:27:35 +00002268 if (FirstSlot.endswith("NoCopy"))
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002269 return true;
Anna Zaks12a8b902012-03-05 17:42:10 +00002270
Anna Zaks42908c72012-06-19 05:10:32 +00002271 // If the first selector starts with addPointer, insertPointer,
2272 // or replacePointer, assume we are dealing with NSPointerArray or similar.
2273 // This is similar to C++ containers (vector); we still might want to check
Jordan Rose742920c2012-07-02 19:27:35 +00002274 // that the pointers get freed by following the container itself.
2275 if (FirstSlot.startswith("addPointer") ||
2276 FirstSlot.startswith("insertPointer") ||
Jordan Rose514f9352014-01-07 21:39:48 +00002277 FirstSlot.startswith("replacePointer") ||
2278 FirstSlot.equals("valueWithPointer")) {
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002279 return true;
Anna Zaks42908c72012-06-19 05:10:32 +00002280 }
2281
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002282 // We should escape receiver on call to 'init'. This is especially relevant
2283 // to the receiver, as the corresponding symbol is usually not referenced
2284 // after the call.
2285 if (Msg->getMethodFamily() == OMF_init) {
2286 EscapingSymbol = Msg->getReceiverSVal().getAsSymbol();
2287 return true;
2288 }
Anna Zaks737926b2013-05-31 22:39:13 +00002289
Jordan Rose742920c2012-07-02 19:27:35 +00002290 // Otherwise, assume that the method does not free memory.
2291 // Most framework methods do not free memory.
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002292 return false;
Anna Zaks3d348342012-02-14 21:55:24 +00002293 }
2294
Jordan Rose742920c2012-07-02 19:27:35 +00002295 // At this point the only thing left to handle is straight function calls.
Jordan Rose2a833ca2014-01-15 17:25:15 +00002296 const FunctionDecl *FD = cast<SimpleFunctionCall>(Call)->getDecl();
Jordan Rose742920c2012-07-02 19:27:35 +00002297 if (!FD)
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002298 return true;
Anna Zaks7ac344a2012-02-24 23:56:53 +00002299
Jordan Rose742920c2012-07-02 19:27:35 +00002300 ASTContext &ASTC = State->getStateManager().getContext();
2301
2302 // If it's one of the allocation functions we can reason about, we model
2303 // its behavior explicitly.
2304 if (isMemFunction(FD, ASTC))
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002305 return false;
Jordan Rose742920c2012-07-02 19:27:35 +00002306
2307 // If it's not a system call, assume it frees memory.
2308 if (!Call->isInSystemHeader())
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002309 return true;
Jordan Rose742920c2012-07-02 19:27:35 +00002310
2311 // White list the system functions whose arguments escape.
2312 const IdentifierInfo *II = FD->getIdentifier();
2313 if (!II)
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002314 return true;
Jordan Rose742920c2012-07-02 19:27:35 +00002315 StringRef FName = II->getName();
2316
Jordan Rose742920c2012-07-02 19:27:35 +00002317 // White list the 'XXXNoCopy' CoreFoundation functions.
Jordan Rose7ab01822012-07-02 19:27:51 +00002318 // We specifically check these before
Jordan Rose742920c2012-07-02 19:27:35 +00002319 if (FName.endswith("NoCopy")) {
2320 // Look for the deallocator argument. We know that the memory ownership
2321 // is not transferred only if the deallocator argument is
2322 // 'kCFAllocatorNull'.
2323 for (unsigned i = 1; i < Call->getNumArgs(); ++i) {
2324 const Expr *ArgE = Call->getArgExpr(i)->IgnoreParenCasts();
2325 if (const DeclRefExpr *DE = dyn_cast<DeclRefExpr>(ArgE)) {
2326 StringRef DeallocatorName = DE->getFoundDecl()->getName();
2327 if (DeallocatorName == "kCFAllocatorNull")
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002328 return false;
Jordan Rose742920c2012-07-02 19:27:35 +00002329 }
2330 }
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002331 return true;
Jordan Rose742920c2012-07-02 19:27:35 +00002332 }
2333
Jordan Rose742920c2012-07-02 19:27:35 +00002334 // Associating streams with malloced buffers. The pointer can escape if
Jordan Rose7ab01822012-07-02 19:27:51 +00002335 // 'closefn' is specified (and if that function does free memory),
2336 // but it will not if closefn is not specified.
Jordan Rose742920c2012-07-02 19:27:35 +00002337 // Currently, we do not inspect the 'closefn' function (PR12101).
2338 if (FName == "funopen")
Jordan Rose7ab01822012-07-02 19:27:51 +00002339 if (Call->getNumArgs() >= 4 && Call->getArgSVal(4).isConstant(0))
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002340 return false;
Jordan Rose742920c2012-07-02 19:27:35 +00002341
2342 // Do not warn on pointers passed to 'setbuf' when used with std streams,
2343 // these leaks might be intentional when setting the buffer for stdio.
2344 // http://stackoverflow.com/questions/2671151/who-frees-setvbuf-buffer
2345 if (FName == "setbuf" || FName =="setbuffer" ||
2346 FName == "setlinebuf" || FName == "setvbuf") {
2347 if (Call->getNumArgs() >= 1) {
2348 const Expr *ArgE = Call->getArgExpr(0)->IgnoreParenCasts();
2349 if (const DeclRefExpr *ArgDRE = dyn_cast<DeclRefExpr>(ArgE))
2350 if (const VarDecl *D = dyn_cast<VarDecl>(ArgDRE->getDecl()))
2351 if (D->getCanonicalDecl()->getName().find("std") != StringRef::npos)
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002352 return true;
Jordan Rose742920c2012-07-02 19:27:35 +00002353 }
2354 }
2355
2356 // A bunch of other functions which either take ownership of a pointer or
2357 // wrap the result up in a struct or object, meaning it can be freed later.
2358 // (See RetainCountChecker.) Not all the parameters here are invalidated,
2359 // but the Malloc checker cannot differentiate between them. The right way
2360 // of doing this would be to implement a pointer escapes callback.
2361 if (FName == "CGBitmapContextCreate" ||
2362 FName == "CGBitmapContextCreateWithData" ||
2363 FName == "CVPixelBufferCreateWithBytes" ||
2364 FName == "CVPixelBufferCreateWithPlanarBytes" ||
2365 FName == "OSAtomicEnqueue") {
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002366 return true;
Jordan Rose742920c2012-07-02 19:27:35 +00002367 }
2368
Jordan Rose7ab01822012-07-02 19:27:51 +00002369 // Handle cases where we know a buffer's /address/ can escape.
2370 // Note that the above checks handle some special cases where we know that
2371 // even though the address escapes, it's still our responsibility to free the
2372 // buffer.
2373 if (Call->argumentsMayEscape())
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002374 return true;
Jordan Rose742920c2012-07-02 19:27:35 +00002375
2376 // Otherwise, assume that the function does not free memory.
2377 // Most system calls do not free the memory.
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002378 return false;
Anna Zaks3d348342012-02-14 21:55:24 +00002379}
2380
Anna Zaks333481b2013-03-28 23:15:29 +00002381static bool retTrue(const RefState *RS) {
2382 return true;
2383}
2384
2385static bool checkIfNewOrNewArrayFamily(const RefState *RS) {
2386 return (RS->getAllocationFamily() == AF_CXXNewArray ||
2387 RS->getAllocationFamily() == AF_CXXNew);
2388}
2389
Anna Zaksdc154152012-12-20 00:38:25 +00002390ProgramStateRef MallocChecker::checkPointerEscape(ProgramStateRef State,
2391 const InvalidatedSymbols &Escaped,
Anna Zaksacdc13c2013-02-07 23:05:43 +00002392 const CallEvent *Call,
2393 PointerEscapeKind Kind) const {
Anna Zaks333481b2013-03-28 23:15:29 +00002394 return checkPointerEscapeAux(State, Escaped, Call, Kind, &retTrue);
2395}
2396
2397ProgramStateRef MallocChecker::checkConstPointerEscape(ProgramStateRef State,
2398 const InvalidatedSymbols &Escaped,
2399 const CallEvent *Call,
2400 PointerEscapeKind Kind) const {
2401 return checkPointerEscapeAux(State, Escaped, Call, Kind,
2402 &checkIfNewOrNewArrayFamily);
2403}
2404
2405ProgramStateRef MallocChecker::checkPointerEscapeAux(ProgramStateRef State,
2406 const InvalidatedSymbols &Escaped,
2407 const CallEvent *Call,
2408 PointerEscapeKind Kind,
2409 bool(*CheckRefState)(const RefState*)) const {
Jordan Rose613f3c02013-03-09 00:59:10 +00002410 // If we know that the call does not free memory, or we want to process the
2411 // call later, keep tracking the top level arguments.
Craig Topper0dbb7832014-05-27 02:45:47 +00002412 SymbolRef EscapingSymbol = nullptr;
Jordan Rose757fbb02013-05-10 17:07:16 +00002413 if (Kind == PSK_DirectEscapeOnCall &&
Anna Zaks8ebeb642013-06-08 00:29:29 +00002414 !mayFreeAnyEscapedMemoryOrIsModeledExplicitly(Call, State,
2415 EscapingSymbol) &&
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002416 !EscapingSymbol) {
Anna Zaks3d348342012-02-14 21:55:24 +00002417 return State;
Anna Zaksacdc13c2013-02-07 23:05:43 +00002418 }
Anna Zaks3d348342012-02-14 21:55:24 +00002419
Anna Zaksdc154152012-12-20 00:38:25 +00002420 for (InvalidatedSymbols::const_iterator I = Escaped.begin(),
Anna Zaks333481b2013-03-28 23:15:29 +00002421 E = Escaped.end();
2422 I != E; ++I) {
Anna Zaksbb1ef902012-02-11 21:02:35 +00002423 SymbolRef sym = *I;
Anna Zaksdc154152012-12-20 00:38:25 +00002424
Anna Zaksa4bc5e12013-05-31 23:47:32 +00002425 if (EscapingSymbol && EscapingSymbol != sym)
2426 continue;
2427
Anna Zaks0d6989b2012-06-22 02:04:31 +00002428 if (const RefState *RS = State->get<RegionState>(sym)) {
Anna Zaks93a21a82013-04-09 00:30:28 +00002429 if (RS->isAllocated() && CheckRefState(RS)) {
Anna Zaks23a62012012-08-09 00:42:24 +00002430 State = State->remove<RegionState>(sym);
Anna Zaks93a21a82013-04-09 00:30:28 +00002431 State = State->set<RegionState>(sym, RefState::getEscaped(RS));
2432 }
Anna Zaks0d6989b2012-06-22 02:04:31 +00002433 }
Anna Zaksbb1ef902012-02-11 21:02:35 +00002434 }
Anna Zaks3d348342012-02-14 21:55:24 +00002435 return State;
Ted Kremenekd21139a2010-07-31 01:52:11 +00002436}
Argyrios Kyrtzidis183f0fb2011-02-28 01:26:35 +00002437
Jordy Rosebf38f202012-03-18 07:43:35 +00002438static SymbolRef findFailedReallocSymbol(ProgramStateRef currState,
2439 ProgramStateRef prevState) {
Jordan Rose0c153cb2012-11-02 01:54:06 +00002440 ReallocPairsTy currMap = currState->get<ReallocPairs>();
2441 ReallocPairsTy prevMap = prevState->get<ReallocPairs>();
Jordy Rosebf38f202012-03-18 07:43:35 +00002442
Jordan Rose0c153cb2012-11-02 01:54:06 +00002443 for (ReallocPairsTy::iterator I = prevMap.begin(), E = prevMap.end();
Jordy Rosebf38f202012-03-18 07:43:35 +00002444 I != E; ++I) {
2445 SymbolRef sym = I.getKey();
2446 if (!currMap.lookup(sym))
2447 return sym;
2448 }
2449
Craig Topper0dbb7832014-05-27 02:45:47 +00002450 return nullptr;
Jordy Rosebf38f202012-03-18 07:43:35 +00002451}
2452
Anna Zaks2b5bb972012-02-09 06:25:51 +00002453PathDiagnosticPiece *
2454MallocChecker::MallocBugVisitor::VisitNode(const ExplodedNode *N,
2455 const ExplodedNode *PrevN,
2456 BugReporterContext &BRC,
2457 BugReport &BR) {
Jordy Rosebf38f202012-03-18 07:43:35 +00002458 ProgramStateRef state = N->getState();
2459 ProgramStateRef statePrev = PrevN->getState();
2460
2461 const RefState *RS = state->get<RegionState>(Sym);
2462 const RefState *RSPrev = statePrev->get<RegionState>(Sym);
Anna Zaks52242a62012-08-03 18:30:18 +00002463 if (!RS)
Craig Topper0dbb7832014-05-27 02:45:47 +00002464 return nullptr;
Anna Zaks2b5bb972012-02-09 06:25:51 +00002465
Craig Topper0dbb7832014-05-27 02:45:47 +00002466 const Stmt *S = nullptr;
2467 const char *Msg = nullptr;
2468 StackHintGeneratorForSymbol *StackHint = nullptr;
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002469
2470 // Retrieve the associated statement.
2471 ProgramPoint ProgLoc = N->getLocation();
David Blaikie87396b92013-02-21 22:23:56 +00002472 if (Optional<StmtPoint> SP = ProgLoc.getAs<StmtPoint>()) {
Jordan Rosefbe6dba2012-07-10 22:07:52 +00002473 S = SP->getStmt();
David Blaikie87396b92013-02-21 22:23:56 +00002474 } else if (Optional<CallExitEnd> Exit = ProgLoc.getAs<CallExitEnd>()) {
Jordan Rosefbe6dba2012-07-10 22:07:52 +00002475 S = Exit->getCalleeContext()->getCallSite();
David Blaikie87396b92013-02-21 22:23:56 +00002476 } else if (Optional<BlockEdge> Edge = ProgLoc.getAs<BlockEdge>()) {
Ted Kremenek7505b5a2013-01-04 19:04:36 +00002477 // If an assumption was made on a branch, it should be caught
2478 // here by looking at the state transition.
2479 S = Edge->getSrc()->getTerminator();
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002480 }
Ted Kremenek7505b5a2013-01-04 19:04:36 +00002481
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002482 if (!S)
Craig Topper0dbb7832014-05-27 02:45:47 +00002483 return nullptr;
Anna Zaks2b5bb972012-02-09 06:25:51 +00002484
Jordan Rose681cce92012-07-10 22:07:42 +00002485 // FIXME: We will eventually need to handle non-statement-based events
2486 // (__attribute__((cleanup))).
2487
Anna Zaks2b5bb972012-02-09 06:25:51 +00002488 // Find out if this is an interesting point and what is the kind.
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002489 if (Mode == Normal) {
Anna Zaks1ff57d52012-03-15 21:13:02 +00002490 if (isAllocated(RS, RSPrev, S)) {
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002491 Msg = "Memory is allocated";
Anna Zaksa7f457a2012-03-16 23:44:28 +00002492 StackHint = new StackHintGeneratorForSymbol(Sym,
2493 "Returned allocated memory");
Anna Zaks1ff57d52012-03-15 21:13:02 +00002494 } else if (isReleased(RS, RSPrev, S)) {
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002495 Msg = "Memory is released";
Anna Zaksa7f457a2012-03-16 23:44:28 +00002496 StackHint = new StackHintGeneratorForSymbol(Sym,
Anna Zakse4cfcd42013-04-16 00:22:55 +00002497 "Returning; memory was released");
Anna Zaks0d6989b2012-06-22 02:04:31 +00002498 } else if (isRelinquished(RS, RSPrev, S)) {
Alp Toker5faf0c02013-12-02 03:50:25 +00002499 Msg = "Memory ownership is transferred";
Anna Zaks0d6989b2012-06-22 02:04:31 +00002500 StackHint = new StackHintGeneratorForSymbol(Sym, "");
Anna Zaks1ff57d52012-03-15 21:13:02 +00002501 } else if (isReallocFailedCheck(RS, RSPrev, S)) {
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002502 Mode = ReallocationFailed;
2503 Msg = "Reallocation failed";
Anna Zakscba4f292012-03-16 23:24:20 +00002504 StackHint = new StackHintGeneratorForReallocationFailed(Sym,
Anna Zaksa7f457a2012-03-16 23:44:28 +00002505 "Reallocation failed");
Jordy Rosebf38f202012-03-18 07:43:35 +00002506
Jordy Rose21ff76e2012-03-24 03:15:09 +00002507 if (SymbolRef sym = findFailedReallocSymbol(state, statePrev)) {
2508 // Is it possible to fail two reallocs WITHOUT testing in between?
2509 assert((!FailedReallocSymbol || FailedReallocSymbol == sym) &&
2510 "We only support one failed realloc at a time.");
Jordy Rosebf38f202012-03-18 07:43:35 +00002511 BR.markInteresting(sym);
Jordy Rose21ff76e2012-03-24 03:15:09 +00002512 FailedReallocSymbol = sym;
2513 }
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002514 }
2515
2516 // We are in a special mode if a reallocation failed later in the path.
2517 } else if (Mode == ReallocationFailed) {
Jordy Rose21ff76e2012-03-24 03:15:09 +00002518 assert(FailedReallocSymbol && "No symbol to look for.");
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002519
Jordy Rose21ff76e2012-03-24 03:15:09 +00002520 // Is this is the first appearance of the reallocated symbol?
2521 if (!statePrev->get<RegionState>(FailedReallocSymbol)) {
Jordy Rose21ff76e2012-03-24 03:15:09 +00002522 // We're at the reallocation point.
2523 Msg = "Attempt to reallocate memory";
2524 StackHint = new StackHintGeneratorForSymbol(Sym,
2525 "Returned reallocated memory");
Craig Topper0dbb7832014-05-27 02:45:47 +00002526 FailedReallocSymbol = nullptr;
Jordy Rose21ff76e2012-03-24 03:15:09 +00002527 Mode = Normal;
2528 }
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002529 }
2530
Anna Zaks2b5bb972012-02-09 06:25:51 +00002531 if (!Msg)
Craig Topper0dbb7832014-05-27 02:45:47 +00002532 return nullptr;
Anna Zakscba4f292012-03-16 23:24:20 +00002533 assert(StackHint);
Anna Zaks2b5bb972012-02-09 06:25:51 +00002534
2535 // Generate the extra diagnostic.
Anna Zaks9eb7bc82012-02-16 22:26:07 +00002536 PathDiagnosticLocation Pos(S, BRC.getSourceManager(),
Anna Zaks2b5bb972012-02-09 06:25:51 +00002537 N->getLocationContext());
Anna Zakscba4f292012-03-16 23:24:20 +00002538 return new PathDiagnosticEventPiece(Pos, Msg, true, StackHint);
Anna Zaks2b5bb972012-02-09 06:25:51 +00002539}
2540
Anna Zaks263b7e02012-05-02 00:05:20 +00002541void MallocChecker::printState(raw_ostream &Out, ProgramStateRef State,
2542 const char *NL, const char *Sep) const {
2543
2544 RegionStateTy RS = State->get<RegionState>();
2545
Ted Kremenek6fcefb52013-01-03 01:30:12 +00002546 if (!RS.isEmpty()) {
Anton Yartsev6a619222014-02-17 18:25:34 +00002547 Out << Sep << "MallocChecker :" << NL;
Ted Kremenek6fcefb52013-01-03 01:30:12 +00002548 for (RegionStateTy::iterator I = RS.begin(), E = RS.end(); I != E; ++I) {
Anton Yartsev6a619222014-02-17 18:25:34 +00002549 const RefState *RefS = State->get<RegionState>(I.getKey());
2550 AllocationFamily Family = RefS->getAllocationFamily();
Gabor Horvathe40c71c2015-03-04 17:59:34 +00002551 auto CheckKind = getCheckIfTracked(MakeVecFromCK(CK_MallocChecker,
Anton Yartseve5c0c142015-02-18 00:39:06 +00002552 CK_NewDeleteChecker),
2553 Family);
Ted Kremenek6fcefb52013-01-03 01:30:12 +00002554 I.getKey()->dumpToStream(Out);
2555 Out << " : ";
2556 I.getData().dump(Out);
Anton Yartsev6a619222014-02-17 18:25:34 +00002557 if (CheckKind.hasValue())
2558 Out << " (" << CheckNames[*CheckKind].getName() << ")";
Ted Kremenek6fcefb52013-01-03 01:30:12 +00002559 Out << NL;
2560 }
2561 }
Anna Zaks263b7e02012-05-02 00:05:20 +00002562}
Anna Zaks2b5bb972012-02-09 06:25:51 +00002563
Anna Zakse4cfcd42013-04-16 00:22:55 +00002564void ento::registerNewDeleteLeaksChecker(CheckerManager &mgr) {
2565 registerCStringCheckerBasic(mgr);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00002566 MallocChecker *checker = mgr.registerChecker<MallocChecker>();
Gabor Horvathe40c71c2015-03-04 17:59:34 +00002567 checker->IsOptimistic = mgr.getAnalyzerOptions().getBooleanOption(
2568 "Optimistic", false, checker);
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00002569 checker->ChecksEnabled[MallocChecker::CK_NewDeleteLeaksChecker] = true;
2570 checker->CheckNames[MallocChecker::CK_NewDeleteLeaksChecker] =
2571 mgr.getCurrentCheckName();
Anna Zakse4cfcd42013-04-16 00:22:55 +00002572 // We currently treat NewDeleteLeaks checker as a subchecker of NewDelete
2573 // checker.
Anton Yartsev6a619222014-02-17 18:25:34 +00002574 if (!checker->ChecksEnabled[MallocChecker::CK_NewDeleteChecker])
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00002575 checker->ChecksEnabled[MallocChecker::CK_NewDeleteChecker] = true;
Anna Zakse4cfcd42013-04-16 00:22:55 +00002576}
Anton Yartsev7af0aa82013-04-12 23:25:40 +00002577
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00002578#define REGISTER_CHECKER(name) \
2579 void ento::register##name(CheckerManager &mgr) { \
2580 registerCStringCheckerBasic(mgr); \
2581 MallocChecker *checker = mgr.registerChecker<MallocChecker>(); \
Gabor Horvathe40c71c2015-03-04 17:59:34 +00002582 checker->IsOptimistic = mgr.getAnalyzerOptions().getBooleanOption( \
2583 "Optimistic", false, checker); \
Alexander Kornienko4aca9b12014-02-11 21:49:21 +00002584 checker->ChecksEnabled[MallocChecker::CK_##name] = true; \
2585 checker->CheckNames[MallocChecker::CK_##name] = mgr.getCurrentCheckName(); \
2586 }
Anna Zakscd37bf42012-02-08 23:16:52 +00002587
Gabor Horvathe40c71c2015-03-04 17:59:34 +00002588REGISTER_CHECKER(MallocChecker)
Anton Yartsev13df0362013-03-25 01:35:45 +00002589REGISTER_CHECKER(NewDeleteChecker)
Anton Yartsev05789592013-03-28 17:05:19 +00002590REGISTER_CHECKER(MismatchedDeallocatorChecker)