Chris Lattner | be1a7a0 | 2008-03-15 23:59:48 +0000 | [diff] [blame] | 1 | // CFRefCount.cpp - Transfer functions for tracking simple values -*- C++ -*--// |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 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 | // |
Gabor Greif | 2224fcb | 2008-03-06 10:40:09 +0000 | [diff] [blame] | 10 | // This file defines the methods for CFRefCount, which implements |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 11 | // a reference count checker for Core Foundation (Mac OS X). |
| 12 | // |
| 13 | //===----------------------------------------------------------------------===// |
| 14 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 15 | #include "GRSimpleVals.h" |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 16 | #include "clang/Basic/LangOptions.h" |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 17 | #include "clang/Basic/SourceManager.h" |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 18 | #include "clang/Analysis/PathSensitive/ValueState.h" |
Ted Kremenek | dd0126b | 2008-03-31 18:26:32 +0000 | [diff] [blame] | 19 | #include "clang/Analysis/PathDiagnostic.h" |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 20 | #include "clang/Analysis/LocalCheckers.h" |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 21 | #include "clang/Analysis/PathDiagnostic.h" |
| 22 | #include "clang/Analysis/PathSensitive/BugReporter.h" |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 23 | #include "llvm/ADT/DenseMap.h" |
| 24 | #include "llvm/ADT/FoldingSet.h" |
| 25 | #include "llvm/ADT/ImmutableMap.h" |
Ted Kremenek | 2ac4ba6 | 2008-05-07 18:36:45 +0000 | [diff] [blame] | 26 | #include "llvm/ADT/StringExtras.h" |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 27 | #include "llvm/Support/Compiler.h" |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 28 | #include "llvm/ADT/STLExtras.h" |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 29 | #include <ostream> |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 30 | #include <sstream> |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 31 | |
| 32 | using namespace clang; |
Ted Kremenek | 2ac4ba6 | 2008-05-07 18:36:45 +0000 | [diff] [blame] | 33 | using llvm::CStrInCStrNoCase; |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 34 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 35 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 36 | // Selector creation functions. |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 37 | //===----------------------------------------------------------------------===// |
| 38 | |
Ted Kremenek | 1bd6ddb | 2008-05-01 18:31:44 +0000 | [diff] [blame] | 39 | static inline Selector GetNullarySelector(const char* name, ASTContext& Ctx) { |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 40 | IdentifierInfo* II = &Ctx.Idents.get(name); |
| 41 | return Ctx.Selectors.getSelector(0, &II); |
| 42 | } |
| 43 | |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 44 | static inline Selector GetUnarySelector(const char* name, ASTContext& Ctx) { |
| 45 | IdentifierInfo* II = &Ctx.Idents.get(name); |
| 46 | return Ctx.Selectors.getSelector(1, &II); |
| 47 | } |
| 48 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 49 | //===----------------------------------------------------------------------===// |
| 50 | // Type querying functions. |
| 51 | //===----------------------------------------------------------------------===// |
| 52 | |
Ted Kremenek | 62820d8 | 2008-05-07 20:06:41 +0000 | [diff] [blame] | 53 | static bool isCFRefType(QualType T) { |
| 54 | |
| 55 | if (!T->isPointerType()) |
| 56 | return false; |
| 57 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 58 | // Check the typedef for the name "CF" and the substring "Ref". |
Ted Kremenek | 62820d8 | 2008-05-07 20:06:41 +0000 | [diff] [blame] | 59 | TypedefType* TD = dyn_cast<TypedefType>(T.getTypePtr()); |
| 60 | |
| 61 | if (!TD) |
| 62 | return false; |
| 63 | |
| 64 | const char* TDName = TD->getDecl()->getIdentifier()->getName(); |
| 65 | assert (TDName); |
| 66 | |
| 67 | if (TDName[0] != 'C' || TDName[1] != 'F') |
| 68 | return false; |
| 69 | |
| 70 | if (strstr(TDName, "Ref") == 0) |
| 71 | return false; |
| 72 | |
| 73 | return true; |
| 74 | } |
| 75 | |
| 76 | static bool isNSType(QualType T) { |
| 77 | |
| 78 | if (!T->isPointerType()) |
| 79 | return false; |
| 80 | |
| 81 | ObjCInterfaceType* OT = dyn_cast<ObjCInterfaceType>(T.getTypePtr()); |
| 82 | |
| 83 | if (!OT) |
| 84 | return false; |
| 85 | |
| 86 | const char* ClsName = OT->getDecl()->getIdentifier()->getName(); |
| 87 | assert (ClsName); |
| 88 | |
| 89 | if (ClsName[0] != 'N' || ClsName[1] != 'S') |
| 90 | return false; |
| 91 | |
| 92 | return true; |
| 93 | } |
| 94 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 95 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 96 | // Primitives used for constructing summaries for function/method calls. |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 97 | //===----------------------------------------------------------------------===// |
| 98 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 99 | namespace { |
| 100 | /// ArgEffect is used to summarize a function/method call's effect on a |
| 101 | /// particular argument. |
| 102 | enum ArgEffect { IncRef, DecRef, DoNothing, StopTracking, MayEscape, |
Ted Kremenek | e5a4bb0 | 2008-06-30 16:57:41 +0000 | [diff] [blame] | 103 | SelfOwn, Autorelease }; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 104 | |
| 105 | /// ArgEffects summarizes the effects of a function/method call on all of |
| 106 | /// its arguments. |
| 107 | typedef std::vector<std::pair<unsigned,ArgEffect> > ArgEffects; |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 108 | } |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 109 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 110 | namespace llvm { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 111 | template <> struct FoldingSetTrait<ArgEffects> { |
| 112 | static void Profile(const ArgEffects& X, FoldingSetNodeID& ID) { |
| 113 | for (ArgEffects::const_iterator I = X.begin(), E = X.end(); I!= E; ++I) { |
| 114 | ID.AddInteger(I->first); |
| 115 | ID.AddInteger((unsigned) I->second); |
| 116 | } |
| 117 | } |
| 118 | }; |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 119 | } // end llvm namespace |
| 120 | |
| 121 | namespace { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 122 | |
| 123 | /// RetEffect is used to summarize a function/method call's behavior with |
| 124 | /// respect to its return value. |
| 125 | class VISIBILITY_HIDDEN RetEffect { |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 126 | public: |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 127 | enum Kind { NoRet, Alias, OwnedSymbol, OwnedAllocatedSymbol, |
| 128 | NotOwnedSymbol, ReceiverAlias }; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 129 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 130 | private: |
| 131 | unsigned Data; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 132 | RetEffect(Kind k, unsigned D = 0) { Data = (D << 3) | (unsigned) k; } |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 133 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 134 | public: |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 135 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 136 | Kind getKind() const { return (Kind) (Data & 0x7); } |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 137 | |
| 138 | unsigned getIndex() const { |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 139 | assert(getKind() == Alias); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 140 | return Data >> 3; |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 141 | } |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 142 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 143 | static RetEffect MakeAlias(unsigned Idx) { |
| 144 | return RetEffect(Alias, Idx); |
| 145 | } |
| 146 | static RetEffect MakeReceiverAlias() { |
| 147 | return RetEffect(ReceiverAlias); |
| 148 | } |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 149 | static RetEffect MakeOwned(bool isAllocated = false) { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 150 | return RetEffect(isAllocated ? OwnedAllocatedSymbol : OwnedSymbol); |
| 151 | } |
| 152 | static RetEffect MakeNotOwned() { |
| 153 | return RetEffect(NotOwnedSymbol); |
| 154 | } |
| 155 | static RetEffect MakeNoRet() { |
| 156 | return RetEffect(NoRet); |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 157 | } |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 158 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 159 | operator Kind() const { |
| 160 | return getKind(); |
| 161 | } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 162 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 163 | void Profile(llvm::FoldingSetNodeID& ID) const { |
| 164 | ID.AddInteger(Data); |
| 165 | } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 166 | }; |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 167 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 168 | |
| 169 | class VISIBILITY_HIDDEN RetainSummary : public llvm::FoldingSetNode { |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 170 | /// Args - an ordered vector of (index, ArgEffect) pairs, where index |
| 171 | /// specifies the argument (starting from 0). This can be sparsely |
| 172 | /// populated; arguments with no entry in Args use 'DefaultArgEffect'. |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 173 | ArgEffects* Args; |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 174 | |
| 175 | /// DefaultArgEffect - The default ArgEffect to apply to arguments that |
| 176 | /// do not have an entry in Args. |
| 177 | ArgEffect DefaultArgEffect; |
| 178 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 179 | /// Receiver - If this summary applies to an Objective-C message expression, |
| 180 | /// this is the effect applied to the state of the receiver. |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 181 | ArgEffect Receiver; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 182 | |
| 183 | /// Ret - The effect on the return value. Used to indicate if the |
| 184 | /// function/method call returns a new tracked symbol, returns an |
| 185 | /// alias of one of the arguments in the call, and so on. |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 186 | RetEffect Ret; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 187 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 188 | public: |
| 189 | |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 190 | RetainSummary(ArgEffects* A, RetEffect R, ArgEffect defaultEff, |
| 191 | ArgEffect ReceiverEff) |
| 192 | : Args(A), DefaultArgEffect(defaultEff), Receiver(ReceiverEff), Ret(R) {} |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 193 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 194 | /// getArg - Return the argument effect on the argument specified by |
| 195 | /// idx (starting from 0). |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 196 | ArgEffect getArg(unsigned idx) const { |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 197 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 198 | if (!Args) |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 199 | return DefaultArgEffect; |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 200 | |
| 201 | // If Args is present, it is likely to contain only 1 element. |
| 202 | // Just do a linear search. Do it from the back because functions with |
| 203 | // large numbers of arguments will be tail heavy with respect to which |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 204 | // argument they actually modify with respect to the reference count. |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 205 | for (ArgEffects::reverse_iterator I=Args->rbegin(), E=Args->rend(); |
| 206 | I!=E; ++I) { |
| 207 | |
| 208 | if (idx > I->first) |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 209 | return DefaultArgEffect; |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 210 | |
| 211 | if (idx == I->first) |
| 212 | return I->second; |
| 213 | } |
| 214 | |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 215 | return DefaultArgEffect; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 216 | } |
| 217 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 218 | /// getRetEffect - Returns the effect on the return value of the call. |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 219 | RetEffect getRetEffect() const { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 220 | return Ret; |
| 221 | } |
| 222 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 223 | /// getReceiverEffect - Returns the effect on the receiver of the call. |
| 224 | /// This is only meaningful if the summary applies to an ObjCMessageExpr*. |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 225 | ArgEffect getReceiverEffect() const { |
| 226 | return Receiver; |
| 227 | } |
| 228 | |
Ted Kremenek | 2719e98 | 2008-06-17 02:43:46 +0000 | [diff] [blame] | 229 | typedef ArgEffects::const_iterator ExprIterator; |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 230 | |
Ted Kremenek | 2719e98 | 2008-06-17 02:43:46 +0000 | [diff] [blame] | 231 | ExprIterator begin_args() const { return Args->begin(); } |
| 232 | ExprIterator end_args() const { return Args->end(); } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 233 | |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 234 | static void Profile(llvm::FoldingSetNodeID& ID, ArgEffects* A, |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 235 | RetEffect RetEff, ArgEffect DefaultEff, |
| 236 | ArgEffect ReceiverEff) { |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 237 | ID.AddPointer(A); |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 238 | ID.Add(RetEff); |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 239 | ID.AddInteger((unsigned) DefaultEff); |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 240 | ID.AddInteger((unsigned) ReceiverEff); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 241 | } |
| 242 | |
| 243 | void Profile(llvm::FoldingSetNodeID& ID) const { |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 244 | Profile(ID, Args, Ret, DefaultArgEffect, Receiver); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 245 | } |
| 246 | }; |
Ted Kremenek | 84f010c | 2008-06-23 23:30:29 +0000 | [diff] [blame] | 247 | } // end anonymous namespace |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 248 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 249 | //===----------------------------------------------------------------------===// |
| 250 | // Data structures for constructing summaries. |
| 251 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 9f0fc79 | 2008-06-24 03:49:48 +0000 | [diff] [blame] | 252 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 253 | namespace { |
| 254 | class VISIBILITY_HIDDEN ObjCSummaryKey { |
| 255 | IdentifierInfo* II; |
| 256 | Selector S; |
| 257 | public: |
| 258 | ObjCSummaryKey(IdentifierInfo* ii, Selector s) |
| 259 | : II(ii), S(s) {} |
| 260 | |
| 261 | ObjCSummaryKey(ObjCInterfaceDecl* d, Selector s) |
| 262 | : II(d ? d->getIdentifier() : 0), S(s) {} |
| 263 | |
| 264 | ObjCSummaryKey(Selector s) |
| 265 | : II(0), S(s) {} |
| 266 | |
| 267 | IdentifierInfo* getIdentifier() const { return II; } |
| 268 | Selector getSelector() const { return S; } |
| 269 | }; |
Ted Kremenek | 84f010c | 2008-06-23 23:30:29 +0000 | [diff] [blame] | 270 | } |
| 271 | |
| 272 | namespace llvm { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 273 | template <> struct DenseMapInfo<ObjCSummaryKey> { |
| 274 | static inline ObjCSummaryKey getEmptyKey() { |
| 275 | return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getEmptyKey(), |
| 276 | DenseMapInfo<Selector>::getEmptyKey()); |
| 277 | } |
Ted Kremenek | 84f010c | 2008-06-23 23:30:29 +0000 | [diff] [blame] | 278 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 279 | static inline ObjCSummaryKey getTombstoneKey() { |
| 280 | return ObjCSummaryKey(DenseMapInfo<IdentifierInfo*>::getTombstoneKey(), |
| 281 | DenseMapInfo<Selector>::getTombstoneKey()); |
| 282 | } |
| 283 | |
| 284 | static unsigned getHashValue(const ObjCSummaryKey &V) { |
| 285 | return (DenseMapInfo<IdentifierInfo*>::getHashValue(V.getIdentifier()) |
| 286 | & 0x88888888) |
| 287 | | (DenseMapInfo<Selector>::getHashValue(V.getSelector()) |
| 288 | & 0x55555555); |
| 289 | } |
| 290 | |
| 291 | static bool isEqual(const ObjCSummaryKey& LHS, const ObjCSummaryKey& RHS) { |
| 292 | return DenseMapInfo<IdentifierInfo*>::isEqual(LHS.getIdentifier(), |
| 293 | RHS.getIdentifier()) && |
| 294 | DenseMapInfo<Selector>::isEqual(LHS.getSelector(), |
| 295 | RHS.getSelector()); |
| 296 | } |
| 297 | |
| 298 | static bool isPod() { |
| 299 | return DenseMapInfo<ObjCInterfaceDecl*>::isPod() && |
| 300 | DenseMapInfo<Selector>::isPod(); |
| 301 | } |
| 302 | }; |
Ted Kremenek | 84f010c | 2008-06-23 23:30:29 +0000 | [diff] [blame] | 303 | } // end llvm namespace |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 304 | |
Ted Kremenek | 84f010c | 2008-06-23 23:30:29 +0000 | [diff] [blame] | 305 | namespace { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 306 | class VISIBILITY_HIDDEN ObjCSummaryCache { |
| 307 | typedef llvm::DenseMap<ObjCSummaryKey, RetainSummary*> MapTy; |
| 308 | MapTy M; |
| 309 | public: |
| 310 | ObjCSummaryCache() {} |
| 311 | |
| 312 | typedef MapTy::iterator iterator; |
| 313 | |
| 314 | iterator find(ObjCInterfaceDecl* D, Selector S) { |
| 315 | |
| 316 | // Do a lookup with the (D,S) pair. If we find a match return |
| 317 | // the iterator. |
| 318 | ObjCSummaryKey K(D, S); |
| 319 | MapTy::iterator I = M.find(K); |
| 320 | |
| 321 | if (I != M.end() || !D) |
| 322 | return I; |
| 323 | |
| 324 | // Walk the super chain. If we find a hit with a parent, we'll end |
| 325 | // up returning that summary. We actually allow that key (null,S), as |
| 326 | // we cache summaries for the null ObjCInterfaceDecl* to allow us to |
| 327 | // generate initial summaries without having to worry about NSObject |
| 328 | // being declared. |
| 329 | // FIXME: We may change this at some point. |
| 330 | for (ObjCInterfaceDecl* C=D->getSuperClass() ;; C=C->getSuperClass()) { |
| 331 | if ((I = M.find(ObjCSummaryKey(C, S))) != M.end()) |
| 332 | break; |
| 333 | |
| 334 | if (!C) |
| 335 | return I; |
| 336 | } |
| 337 | |
| 338 | // Cache the summary with original key to make the next lookup faster |
| 339 | // and return the iterator. |
| 340 | M[K] = I->second; |
| 341 | return I; |
| 342 | } |
| 343 | |
| 344 | |
| 345 | iterator find(Expr* Receiver, Selector S) { |
| 346 | return find(getReceiverDecl(Receiver), S); |
| 347 | } |
| 348 | |
| 349 | iterator find(IdentifierInfo* II, Selector S) { |
| 350 | // FIXME: Class method lookup. Right now we dont' have a good way |
| 351 | // of going between IdentifierInfo* and the class hierarchy. |
| 352 | iterator I = M.find(ObjCSummaryKey(II, S)); |
| 353 | return I == M.end() ? M.find(ObjCSummaryKey(S)) : I; |
| 354 | } |
| 355 | |
| 356 | ObjCInterfaceDecl* getReceiverDecl(Expr* E) { |
| 357 | |
| 358 | const PointerType* PT = E->getType()->getAsPointerType(); |
| 359 | if (!PT) return 0; |
| 360 | |
| 361 | ObjCInterfaceType* OI = dyn_cast<ObjCInterfaceType>(PT->getPointeeType()); |
| 362 | if (!OI) return 0; |
| 363 | |
| 364 | return OI ? OI->getDecl() : 0; |
| 365 | } |
| 366 | |
| 367 | iterator end() { return M.end(); } |
| 368 | |
| 369 | RetainSummary*& operator[](ObjCMessageExpr* ME) { |
| 370 | |
| 371 | Selector S = ME->getSelector(); |
| 372 | |
| 373 | if (Expr* Receiver = ME->getReceiver()) { |
| 374 | ObjCInterfaceDecl* OD = getReceiverDecl(Receiver); |
| 375 | return OD ? M[ObjCSummaryKey(OD->getIdentifier(), S)] : M[S]; |
| 376 | } |
| 377 | |
| 378 | return M[ObjCSummaryKey(ME->getClassName(), S)]; |
| 379 | } |
| 380 | |
| 381 | RetainSummary*& operator[](ObjCSummaryKey K) { |
| 382 | return M[K]; |
| 383 | } |
| 384 | |
| 385 | RetainSummary*& operator[](Selector S) { |
| 386 | return M[ ObjCSummaryKey(S) ]; |
| 387 | } |
| 388 | }; |
| 389 | } // end anonymous namespace |
| 390 | |
| 391 | //===----------------------------------------------------------------------===// |
| 392 | // Data structures for managing collections of summaries. |
| 393 | //===----------------------------------------------------------------------===// |
| 394 | |
| 395 | namespace { |
| 396 | class VISIBILITY_HIDDEN RetainSummaryManager { |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 397 | |
| 398 | //==-----------------------------------------------------------------==// |
| 399 | // Typedefs. |
| 400 | //==-----------------------------------------------------------------==// |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 401 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 402 | typedef llvm::FoldingSet<llvm::FoldingSetNodeWrapper<ArgEffects> > |
| 403 | ArgEffectsSetTy; |
| 404 | |
| 405 | typedef llvm::FoldingSet<RetainSummary> |
| 406 | SummarySetTy; |
| 407 | |
| 408 | typedef llvm::DenseMap<FunctionDecl*, RetainSummary*> |
| 409 | FuncSummariesTy; |
| 410 | |
Ted Kremenek | 84f010c | 2008-06-23 23:30:29 +0000 | [diff] [blame] | 411 | typedef ObjCSummaryCache ObjCMethodSummariesTy; |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 412 | |
| 413 | //==-----------------------------------------------------------------==// |
| 414 | // Data. |
| 415 | //==-----------------------------------------------------------------==// |
| 416 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 417 | /// Ctx - The ASTContext object for the analyzed ASTs. |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 418 | ASTContext& Ctx; |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 419 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 420 | /// NSWindowII - An IdentifierInfo* representing the identifier "NSWindow." |
| 421 | IdentifierInfo* NSWindowII; |
| 422 | |
| 423 | /// GCEnabled - Records whether or not the analyzed code runs in GC mode. |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 424 | const bool GCEnabled; |
| 425 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 426 | /// SummarySet - A FoldingSet of uniqued summaries. |
Ted Kremenek | a4c7429 | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 427 | SummarySetTy SummarySet; |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 428 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 429 | /// FuncSummaries - A map from FunctionDecls to summaries. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 430 | FuncSummariesTy FuncSummaries; |
| 431 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 432 | /// ObjCClassMethodSummaries - A map from selectors (for instance methods) |
| 433 | /// to summaries. |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 434 | ObjCMethodSummariesTy ObjCClassMethodSummaries; |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 435 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 436 | /// ObjCMethodSummaries - A map from selectors to summaries. |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 437 | ObjCMethodSummariesTy ObjCMethodSummaries; |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 438 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 439 | /// ArgEffectsSet - A FoldingSet of uniqued ArgEffects. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 440 | ArgEffectsSetTy ArgEffectsSet; |
| 441 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 442 | /// BPAlloc - A BumpPtrAllocator used for allocating summaries, ArgEffects, |
| 443 | /// and all other data used by the checker. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 444 | llvm::BumpPtrAllocator BPAlloc; |
| 445 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 446 | /// ScratchArgs - A holding buffer for construct ArgEffects. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 447 | ArgEffects ScratchArgs; |
| 448 | |
Ted Kremenek | b3a44e7 | 2008-05-06 18:11:36 +0000 | [diff] [blame] | 449 | RetainSummary* StopSummary; |
| 450 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 451 | //==-----------------------------------------------------------------==// |
| 452 | // Methods. |
| 453 | //==-----------------------------------------------------------------==// |
| 454 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 455 | /// getArgEffects - Returns a persistent ArgEffects object based on the |
| 456 | /// data in ScratchArgs. |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 457 | ArgEffects* getArgEffects(); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 458 | |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 459 | enum UnaryFuncKind { cfretain, cfrelease, cfmakecollectable }; |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 460 | RetainSummary* getUnarySummary(FunctionDecl* FD, UnaryFuncKind func); |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 461 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 462 | RetainSummary* getNSSummary(FunctionDecl* FD, const char* FName); |
| 463 | RetainSummary* getCFSummary(FunctionDecl* FD, const char* FName); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 464 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 465 | RetainSummary* getCFSummaryCreateRule(FunctionDecl* FD); |
| 466 | RetainSummary* getCFSummaryGetRule(FunctionDecl* FD); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 467 | |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 468 | RetainSummary* getPersistentSummary(ArgEffects* AE, RetEffect RetEff, |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 469 | ArgEffect ReceiverEff = DoNothing, |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 470 | ArgEffect DefaultEff = MayEscape); |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 471 | |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 472 | |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 473 | RetainSummary* getPersistentSummary(RetEffect RE, |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 474 | ArgEffect ReceiverEff = DoNothing, |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 475 | ArgEffect DefaultEff = MayEscape) { |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 476 | return getPersistentSummary(getArgEffects(), RE, ReceiverEff, DefaultEff); |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 477 | } |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 478 | |
Ted Kremenek | b3a44e7 | 2008-05-06 18:11:36 +0000 | [diff] [blame] | 479 | |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 480 | RetainSummary* getPersistentStopSummary() { |
Ted Kremenek | b3a44e7 | 2008-05-06 18:11:36 +0000 | [diff] [blame] | 481 | if (StopSummary) |
| 482 | return StopSummary; |
| 483 | |
| 484 | StopSummary = getPersistentSummary(RetEffect::MakeNoRet(), |
| 485 | StopTracking, StopTracking); |
| 486 | |
| 487 | return StopSummary; |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 488 | } |
Ted Kremenek | 926abf2 | 2008-05-06 04:20:12 +0000 | [diff] [blame] | 489 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 490 | RetainSummary* getInitMethodSummary(ObjCMessageExpr* ME); |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 491 | |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 492 | void InitializeClassMethodSummaries(); |
| 493 | void InitializeMethodSummaries(); |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 494 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 495 | void addNSObjectClsMethSummary(Selector S, RetainSummary *Summ) { |
| 496 | ObjCClassMethodSummaries[S] = Summ; |
| 497 | } |
| 498 | |
| 499 | void addNSObjectMethSummary(Selector S, RetainSummary *Summ) { |
| 500 | ObjCMethodSummaries[S] = Summ; |
| 501 | } |
| 502 | |
| 503 | void addNSWindowMethSummary(Selector S, RetainSummary *Summ) { |
| 504 | ObjCMethodSummaries[ObjCSummaryKey(NSWindowII, S)] = Summ; |
| 505 | } |
| 506 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 507 | public: |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 508 | |
| 509 | RetainSummaryManager(ASTContext& ctx, bool gcenabled) |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 510 | : Ctx(ctx), NSWindowII(&ctx.Idents.get("NSWindow")), |
| 511 | GCEnabled(gcenabled), StopSummary(0) { |
| 512 | |
| 513 | InitializeClassMethodSummaries(); |
| 514 | InitializeMethodSummaries(); |
| 515 | } |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 516 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 517 | ~RetainSummaryManager(); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 518 | |
Ted Kremenek | d13c187 | 2008-06-24 03:56:45 +0000 | [diff] [blame] | 519 | RetainSummary* getSummary(FunctionDecl* FD); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 520 | RetainSummary* getMethodSummary(ObjCMessageExpr* ME, ObjCInterfaceDecl* ID); |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 521 | RetainSummary* getClassMethodSummary(IdentifierInfo* ClsName, Selector S); |
Ted Kremenek | 926abf2 | 2008-05-06 04:20:12 +0000 | [diff] [blame] | 522 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 523 | bool isGCEnabled() const { return GCEnabled; } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 524 | }; |
| 525 | |
| 526 | } // end anonymous namespace |
| 527 | |
| 528 | //===----------------------------------------------------------------------===// |
| 529 | // Implementation of checker data structures. |
| 530 | //===----------------------------------------------------------------------===// |
| 531 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 532 | RetainSummaryManager::~RetainSummaryManager() { |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 533 | |
| 534 | // FIXME: The ArgEffects could eventually be allocated from BPAlloc, |
| 535 | // mitigating the need to do explicit cleanup of the |
| 536 | // Argument-Effect summaries. |
| 537 | |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 538 | for (ArgEffectsSetTy::iterator I = ArgEffectsSet.begin(), |
| 539 | E = ArgEffectsSet.end(); I!=E; ++I) |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 540 | I->getValue().~ArgEffects(); |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 541 | } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 542 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 543 | ArgEffects* RetainSummaryManager::getArgEffects() { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 544 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 545 | if (ScratchArgs.empty()) |
| 546 | return NULL; |
| 547 | |
| 548 | // Compute a profile for a non-empty ScratchArgs. |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 549 | llvm::FoldingSetNodeID profile; |
| 550 | profile.Add(ScratchArgs); |
| 551 | void* InsertPos; |
| 552 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 553 | // Look up the uniqued copy, or create a new one. |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 554 | llvm::FoldingSetNodeWrapper<ArgEffects>* E = |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 555 | ArgEffectsSet.FindNodeOrInsertPos(profile, InsertPos); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 556 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 557 | if (E) { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 558 | ScratchArgs.clear(); |
| 559 | return &E->getValue(); |
| 560 | } |
| 561 | |
| 562 | E = (llvm::FoldingSetNodeWrapper<ArgEffects>*) |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 563 | BPAlloc.Allocate<llvm::FoldingSetNodeWrapper<ArgEffects> >(); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 564 | |
| 565 | new (E) llvm::FoldingSetNodeWrapper<ArgEffects>(ScratchArgs); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 566 | ArgEffectsSet.InsertNode(E, InsertPos); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 567 | |
| 568 | ScratchArgs.clear(); |
| 569 | return &E->getValue(); |
| 570 | } |
| 571 | |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 572 | RetainSummary* |
| 573 | RetainSummaryManager::getPersistentSummary(ArgEffects* AE, RetEffect RetEff, |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 574 | ArgEffect ReceiverEff, |
| 575 | ArgEffect DefaultEff) { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 576 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 577 | // Generate a profile for the summary. |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 578 | llvm::FoldingSetNodeID profile; |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 579 | RetainSummary::Profile(profile, AE, RetEff, DefaultEff, ReceiverEff); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 580 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 581 | // Look up the uniqued summary, or create one if it doesn't exist. |
| 582 | void* InsertPos; |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 583 | RetainSummary* Summ = SummarySet.FindNodeOrInsertPos(profile, InsertPos); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 584 | |
| 585 | if (Summ) |
| 586 | return Summ; |
| 587 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 588 | // Create the summary and return it. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 589 | Summ = (RetainSummary*) BPAlloc.Allocate<RetainSummary>(); |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 590 | new (Summ) RetainSummary(AE, RetEff, DefaultEff, ReceiverEff); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 591 | SummarySet.InsertNode(Summ, InsertPos); |
| 592 | |
| 593 | return Summ; |
| 594 | } |
| 595 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 596 | //===----------------------------------------------------------------------===// |
| 597 | // Summary creation for functions (largely uses of Core Foundation). |
| 598 | //===----------------------------------------------------------------------===// |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 599 | |
Ted Kremenek | d13c187 | 2008-06-24 03:56:45 +0000 | [diff] [blame] | 600 | RetainSummary* RetainSummaryManager::getSummary(FunctionDecl* FD) { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 601 | |
| 602 | SourceLocation Loc = FD->getLocation(); |
| 603 | |
| 604 | if (!Loc.isFileID()) |
| 605 | return NULL; |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 606 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 607 | // Look up a summary in our cache of FunctionDecls -> Summaries. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 608 | FuncSummariesTy::iterator I = FuncSummaries.find(FD); |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 609 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 610 | if (I != FuncSummaries.end()) |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 611 | return I->second; |
| 612 | |
| 613 | // No summary. Generate one. |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 614 | const char* FName = FD->getIdentifier()->getName(); |
| 615 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 616 | RetainSummary *S = 0; |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 617 | |
Ted Kremenek | 62820d8 | 2008-05-07 20:06:41 +0000 | [diff] [blame] | 618 | FunctionType* FT = dyn_cast<FunctionType>(FD->getType()); |
| 619 | |
| 620 | if (FT && isCFRefType(FT->getResultType())) |
| 621 | S = getCFSummary(FD, FName); |
| 622 | else if (FName[0] == 'C' && FName[1] == 'F') |
| 623 | S = getCFSummary(FD, FName); |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 624 | else if (FName[0] == 'N' && FName[1] == 'S') |
| 625 | S = getNSSummary(FD, FName); |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 626 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 627 | FuncSummaries[FD] = S; |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 628 | return S; |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 629 | } |
| 630 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 631 | RetainSummary* RetainSummaryManager::getNSSummary(FunctionDecl* FD, |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 632 | const char* FName) { |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 633 | FName += 2; |
| 634 | |
| 635 | if (strcmp(FName, "MakeCollectable") == 0) |
| 636 | return getUnarySummary(FD, cfmakecollectable); |
| 637 | |
| 638 | return 0; |
| 639 | } |
| 640 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 641 | RetainSummary* RetainSummaryManager::getCFSummary(FunctionDecl* FD, |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 642 | const char* FName) { |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 643 | |
Ted Kremenek | 62820d8 | 2008-05-07 20:06:41 +0000 | [diff] [blame] | 644 | if (FName[0] == 'C' && FName[1] == 'F') |
| 645 | FName += 2; |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 646 | |
| 647 | if (strcmp(FName, "Retain") == 0) |
| 648 | return getUnarySummary(FD, cfretain); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 649 | |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 650 | if (strcmp(FName, "Release") == 0) |
| 651 | return getUnarySummary(FD, cfrelease); |
| 652 | |
| 653 | if (strcmp(FName, "MakeCollectable") == 0) |
| 654 | return getUnarySummary(FD, cfmakecollectable); |
| 655 | |
| 656 | if (strstr(FName, "Create") || strstr(FName, "Copy")) |
| 657 | return getCFSummaryCreateRule(FD); |
| 658 | |
| 659 | if (strstr(FName, "Get")) |
| 660 | return getCFSummaryGetRule(FD); |
| 661 | |
| 662 | return 0; |
| 663 | } |
| 664 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 665 | RetainSummary* |
| 666 | RetainSummaryManager::getUnarySummary(FunctionDecl* FD, UnaryFuncKind func) { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 667 | |
| 668 | FunctionTypeProto* FT = |
| 669 | dyn_cast<FunctionTypeProto>(FD->getType().getTypePtr()); |
| 670 | |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 671 | if (FT) { |
| 672 | |
| 673 | if (FT->getNumArgs() != 1) |
| 674 | return 0; |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 675 | |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 676 | TypedefType* ArgT = dyn_cast<TypedefType>(FT->getArgType(0).getTypePtr()); |
| 677 | |
| 678 | if (!ArgT) |
| 679 | return 0; |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 680 | |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 681 | if (!ArgT->isPointerType()) |
| 682 | return NULL; |
| 683 | } |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 684 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 685 | assert (ScratchArgs.empty()); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 686 | |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 687 | switch (func) { |
| 688 | case cfretain: { |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 689 | ScratchArgs.push_back(std::make_pair(0, IncRef)); |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 690 | return getPersistentSummary(RetEffect::MakeAlias(0), |
| 691 | DoNothing, DoNothing); |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 692 | } |
| 693 | |
| 694 | case cfrelease: { |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 695 | ScratchArgs.push_back(std::make_pair(0, DecRef)); |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 696 | return getPersistentSummary(RetEffect::MakeNoRet(), |
| 697 | DoNothing, DoNothing); |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 698 | } |
| 699 | |
| 700 | case cfmakecollectable: { |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 701 | if (GCEnabled) |
| 702 | ScratchArgs.push_back(std::make_pair(0, DecRef)); |
| 703 | |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 704 | return getPersistentSummary(RetEffect::MakeAlias(0), |
| 705 | DoNothing, DoNothing); |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 706 | } |
| 707 | |
| 708 | default: |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 709 | assert (false && "Not a supported unary function."); |
Ted Kremenek | ab2fa2a | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 710 | } |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 711 | } |
| 712 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 713 | RetainSummary* RetainSummaryManager::getCFSummaryCreateRule(FunctionDecl* FD) { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 714 | |
Ted Kremenek | 62820d8 | 2008-05-07 20:06:41 +0000 | [diff] [blame] | 715 | FunctionType* FT = |
| 716 | dyn_cast<FunctionType>(FD->getType().getTypePtr()); |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 717 | |
| 718 | if (FT && !isCFRefType(FT->getResultType())) |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 719 | return getPersistentSummary(RetEffect::MakeNoRet()); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 720 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 721 | // FIXME: Add special-cases for functions that retain/release. For now |
| 722 | // just handle the default case. |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 723 | |
| 724 | assert (ScratchArgs.empty()); |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 725 | return getPersistentSummary(RetEffect::MakeOwned(true)); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 726 | } |
| 727 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 728 | RetainSummary* RetainSummaryManager::getCFSummaryGetRule(FunctionDecl* FD) { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 729 | |
Ted Kremenek | 62820d8 | 2008-05-07 20:06:41 +0000 | [diff] [blame] | 730 | FunctionType* FT = |
| 731 | dyn_cast<FunctionType>(FD->getType().getTypePtr()); |
Ted Kremenek | d4244d4 | 2008-04-11 20:11:19 +0000 | [diff] [blame] | 732 | |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 733 | if (FT) { |
| 734 | QualType RetTy = FT->getResultType(); |
Ted Kremenek | d4244d4 | 2008-04-11 20:11:19 +0000 | [diff] [blame] | 735 | |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 736 | // FIXME: For now we assume that all pointer types returned are referenced |
| 737 | // counted. Since this is the "Get" rule, we assume non-ownership, which |
| 738 | // works fine for things that are not reference counted. We do this because |
| 739 | // some generic data structures return "void*". We need something better |
| 740 | // in the future. |
| 741 | |
| 742 | if (!isCFRefType(RetTy) && !RetTy->isPointerType()) |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 743 | return getPersistentSummary(RetEffect::MakeNoRet(), DoNothing, DoNothing); |
Ted Kremenek | 562c130 | 2008-05-05 16:51:50 +0000 | [diff] [blame] | 744 | } |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 745 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 746 | // FIXME: Add special-cases for functions that retain/release. For now |
| 747 | // just handle the default case. |
| 748 | |
Ted Kremenek | ae855d4 | 2008-04-24 17:22:33 +0000 | [diff] [blame] | 749 | assert (ScratchArgs.empty()); |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 750 | return getPersistentSummary(RetEffect::MakeNotOwned(), DoNothing, DoNothing); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 751 | } |
| 752 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 753 | //===----------------------------------------------------------------------===// |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 754 | // Summary creation for Selectors. |
| 755 | //===----------------------------------------------------------------------===// |
| 756 | |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 757 | RetainSummary* |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 758 | RetainSummaryManager::getInitMethodSummary(ObjCMessageExpr* ME) { |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 759 | assert(ScratchArgs.empty()); |
| 760 | |
| 761 | RetainSummary* Summ = |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 762 | getPersistentSummary(RetEffect::MakeReceiverAlias()); |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 763 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 764 | ObjCMethodSummaries[ME] = Summ; |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 765 | return Summ; |
| 766 | } |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 767 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 768 | |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 769 | RetainSummary* |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 770 | RetainSummaryManager::getMethodSummary(ObjCMessageExpr* ME, |
| 771 | ObjCInterfaceDecl* ID) { |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 772 | |
| 773 | Selector S = ME->getSelector(); |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 774 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 775 | // Look up a summary in our summary cache. |
| 776 | ObjCMethodSummariesTy::iterator I = ObjCMethodSummaries.find(ID, S); |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 777 | |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 778 | if (I != ObjCMethodSummaries.end()) |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 779 | return I->second; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 780 | |
Ted Kremenek | 48b6d9e | 2008-05-07 03:45:05 +0000 | [diff] [blame] | 781 | if (!ME->getType()->isPointerType()) |
| 782 | return 0; |
| 783 | |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 784 | // "initXXX": pass-through for receiver. |
| 785 | |
| 786 | const char* s = S.getIdentifierInfoForSlot(0)->getName(); |
Ted Kremenek | 48b6d9e | 2008-05-07 03:45:05 +0000 | [diff] [blame] | 787 | assert (ScratchArgs.empty()); |
Ted Kremenek | 1d3d956 | 2008-05-06 06:09:09 +0000 | [diff] [blame] | 788 | |
Ted Kremenek | 988c447 | 2008-06-02 17:14:13 +0000 | [diff] [blame] | 789 | if (strncmp(s, "init", 4) == 0 || strncmp(s, "_init", 5) == 0) |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 790 | return getInitMethodSummary(ME); |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 791 | |
Ted Kremenek | 48b6d9e | 2008-05-07 03:45:05 +0000 | [diff] [blame] | 792 | // "copyXXX", "createXXX", "newXXX": allocators. |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 793 | |
Ted Kremenek | 5496f6d | 2008-05-07 04:25:59 +0000 | [diff] [blame] | 794 | if (!isNSType(ME->getReceiver()->getType())) |
| 795 | return 0; |
| 796 | |
Ted Kremenek | 62820d8 | 2008-05-07 20:06:41 +0000 | [diff] [blame] | 797 | if (CStrInCStrNoCase(s, "create") || CStrInCStrNoCase(s, "copy") || |
| 798 | CStrInCStrNoCase(s, "new")) { |
Ted Kremenek | 48b6d9e | 2008-05-07 03:45:05 +0000 | [diff] [blame] | 799 | |
| 800 | RetEffect E = isGCEnabled() ? RetEffect::MakeNoRet() |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 801 | : RetEffect::MakeOwned(true); |
Ted Kremenek | 48b6d9e | 2008-05-07 03:45:05 +0000 | [diff] [blame] | 802 | |
| 803 | RetainSummary* Summ = getPersistentSummary(E); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 804 | ObjCMethodSummaries[ME] = Summ; |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 805 | return Summ; |
| 806 | } |
Ted Kremenek | bcaff79 | 2008-05-06 15:44:25 +0000 | [diff] [blame] | 807 | |
Ted Kremenek | 42ea032 | 2008-05-05 23:55:01 +0000 | [diff] [blame] | 808 | return 0; |
| 809 | } |
| 810 | |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 811 | RetainSummary* |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 812 | RetainSummaryManager::getClassMethodSummary(IdentifierInfo* ClsName, |
| 813 | Selector S) { |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 814 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 815 | // FIXME: Eventually we should properly do class method summaries, but |
| 816 | // it requires us being able to walk the type hierarchy. Unfortunately, |
| 817 | // we cannot do this with just an IdentifierInfo* for the class name. |
| 818 | |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 819 | // Look up a summary in our cache of Selectors -> Summaries. |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 820 | ObjCMethodSummariesTy::iterator I = ObjCClassMethodSummaries.find(ClsName, S); |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 821 | |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 822 | if (I != ObjCClassMethodSummaries.end()) |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 823 | return I->second; |
| 824 | |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 825 | return 0; |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 826 | } |
| 827 | |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 828 | void RetainSummaryManager::InitializeClassMethodSummaries() { |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 829 | |
| 830 | assert (ScratchArgs.empty()); |
| 831 | |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 832 | RetEffect E = isGCEnabled() ? RetEffect::MakeNoRet() |
| 833 | : RetEffect::MakeOwned(true); |
| 834 | |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 835 | RetainSummary* Summ = getPersistentSummary(E); |
| 836 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 837 | // Create the summaries for "alloc", "new", and "allocWithZone:" for |
| 838 | // NSObject and its derivatives. |
| 839 | addNSObjectClsMethSummary(GetNullarySelector("alloc", Ctx), Summ); |
| 840 | addNSObjectClsMethSummary(GetNullarySelector("new", Ctx), Summ); |
| 841 | addNSObjectClsMethSummary(GetUnarySelector("allocWithZone", Ctx), Summ); |
Ted Kremenek | 0e344d4 | 2008-05-06 00:30:21 +0000 | [diff] [blame] | 842 | } |
| 843 | |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 844 | void RetainSummaryManager::InitializeMethodSummaries() { |
Ted Kremenek | 83b2cde | 2008-05-06 00:38:54 +0000 | [diff] [blame] | 845 | |
| 846 | assert (ScratchArgs.empty()); |
| 847 | |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 848 | // Create the "init" selector. It just acts as a pass-through for the |
| 849 | // receiver. |
Ted Kremenek | 83b2cde | 2008-05-06 00:38:54 +0000 | [diff] [blame] | 850 | RetainSummary* Summ = getPersistentSummary(RetEffect::MakeReceiverAlias()); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 851 | addNSObjectMethSummary(GetNullarySelector("init", Ctx), Summ); |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 852 | |
| 853 | // The next methods are allocators. |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 854 | RetEffect E = isGCEnabled() ? RetEffect::MakeNoRet() |
| 855 | : RetEffect::MakeOwned(true); |
| 856 | |
Ted Kremenek | a7722b7 | 2008-05-06 21:26:51 +0000 | [diff] [blame] | 857 | Summ = getPersistentSummary(E); |
| 858 | |
| 859 | // Create the "copy" selector. |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 860 | addNSObjectMethSummary(GetNullarySelector("copy", Ctx), Summ); |
Ted Kremenek | 83b2cde | 2008-05-06 00:38:54 +0000 | [diff] [blame] | 861 | |
| 862 | // Create the "mutableCopy" selector. |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 863 | addNSObjectMethSummary(GetNullarySelector("mutableCopy", Ctx), Summ); |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 864 | |
| 865 | // Create the "retain" selector. |
| 866 | E = RetEffect::MakeReceiverAlias(); |
| 867 | Summ = getPersistentSummary(E, isGCEnabled() ? DoNothing : IncRef); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 868 | addNSObjectMethSummary(GetNullarySelector("retain", Ctx), Summ); |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 869 | |
| 870 | // Create the "release" selector. |
| 871 | Summ = getPersistentSummary(E, isGCEnabled() ? DoNothing : DecRef); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 872 | addNSObjectMethSummary(GetNullarySelector("release", Ctx), Summ); |
Ted Kremenek | c00b32b | 2008-05-07 21:17:39 +0000 | [diff] [blame] | 873 | |
| 874 | // Create the "drain" selector. |
| 875 | Summ = getPersistentSummary(E, isGCEnabled() ? DoNothing : DecRef); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 876 | addNSObjectMethSummary(GetNullarySelector("drain", Ctx), Summ); |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 877 | |
| 878 | // Create the "autorelease" selector. |
Ted Kremenek | e5a4bb0 | 2008-06-30 16:57:41 +0000 | [diff] [blame] | 879 | Summ = getPersistentSummary(E, isGCEnabled() ? DoNothing : Autorelease); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 880 | addNSObjectMethSummary(GetNullarySelector("autorelease", Ctx), Summ); |
| 881 | |
| 882 | // For NSWindow, allocated objects are (initially) self-owned. |
| 883 | Summ = getPersistentSummary(RetEffect::MakeReceiverAlias(), SelfOwn); |
| 884 | |
| 885 | // Create the "initWithContentRect:styleMask:backing:defer:" selector. |
| 886 | llvm::SmallVector<IdentifierInfo*, 5> II; |
| 887 | II.push_back(&Ctx.Idents.get("initWithContentRect")); |
| 888 | II.push_back(&Ctx.Idents.get("styleMask")); |
| 889 | II.push_back(&Ctx.Idents.get("backing")); |
| 890 | II.push_back(&Ctx.Idents.get("defer")); |
| 891 | Selector S = Ctx.Selectors.getSelector(II.size(), &II[0]); |
| 892 | addNSWindowMethSummary(S, Summ); |
| 893 | |
| 894 | // Create the "initWithContentRect:styleMask:backing:defer:screen:" selector. |
| 895 | II.push_back(&Ctx.Idents.get("screen")); |
| 896 | S = Ctx.Selectors.getSelector(II.size(), &II[0]); |
| 897 | addNSWindowMethSummary(S, Summ); |
Ted Kremenek | 83b2cde | 2008-05-06 00:38:54 +0000 | [diff] [blame] | 898 | } |
| 899 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 900 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 7aef484 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 901 | // Reference-counting logic (typestate + counts). |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 902 | //===----------------------------------------------------------------------===// |
| 903 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 904 | namespace { |
| 905 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 906 | class VISIBILITY_HIDDEN RefVal { |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 907 | public: |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 908 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 909 | enum Kind { |
| 910 | Owned = 0, // Owning reference. |
| 911 | NotOwned, // Reference is not owned by still valid (not freed). |
| 912 | Released, // Object has been released. |
| 913 | ReturnedOwned, // Returned object passes ownership to caller. |
| 914 | ReturnedNotOwned, // Return object does not pass ownership to caller. |
| 915 | ErrorUseAfterRelease, // Object used after released. |
| 916 | ErrorReleaseNotOwned, // Release of an object that was not owned. |
| 917 | ErrorLeak // A memory leak due to excessive reference counts. |
| 918 | }; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 919 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 920 | private: |
| 921 | |
| 922 | Kind kind; |
| 923 | unsigned Cnt; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 924 | QualType T; |
| 925 | |
| 926 | RefVal(Kind k, unsigned cnt, QualType t) : kind(k), Cnt(cnt), T(t) {} |
| 927 | RefVal(Kind k, unsigned cnt = 0) : kind(k), Cnt(cnt) {} |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 928 | |
| 929 | public: |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 930 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 931 | Kind getKind() const { return kind; } |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 932 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 933 | unsigned getCount() const { return Cnt; } |
| 934 | QualType getType() const { return T; } |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 935 | |
| 936 | // Useful predicates. |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 937 | |
Ted Kremenek | 1daa16c | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 938 | static bool isError(Kind k) { return k >= ErrorUseAfterRelease; } |
| 939 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 940 | static bool isLeak(Kind k) { return k == ErrorLeak; } |
| 941 | |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 942 | bool isOwned() const { |
| 943 | return getKind() == Owned; |
| 944 | } |
| 945 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 946 | bool isNotOwned() const { |
| 947 | return getKind() == NotOwned; |
| 948 | } |
| 949 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 950 | bool isReturnedOwned() const { |
| 951 | return getKind() == ReturnedOwned; |
| 952 | } |
| 953 | |
| 954 | bool isReturnedNotOwned() const { |
| 955 | return getKind() == ReturnedNotOwned; |
| 956 | } |
| 957 | |
| 958 | bool isNonLeakError() const { |
| 959 | Kind k = getKind(); |
| 960 | return isError(k) && !isLeak(k); |
| 961 | } |
| 962 | |
| 963 | // State creation: normal state. |
| 964 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 965 | static RefVal makeOwned(QualType t, unsigned Count = 1) { |
| 966 | return RefVal(Owned, Count, t); |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 967 | } |
| 968 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 969 | static RefVal makeNotOwned(QualType t, unsigned Count = 0) { |
| 970 | return RefVal(NotOwned, Count, t); |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 971 | } |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 972 | |
| 973 | static RefVal makeReturnedOwned(unsigned Count) { |
| 974 | return RefVal(ReturnedOwned, Count); |
| 975 | } |
| 976 | |
| 977 | static RefVal makeReturnedNotOwned() { |
| 978 | return RefVal(ReturnedNotOwned); |
| 979 | } |
| 980 | |
| 981 | // State creation: errors. |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 982 | |
| 983 | #if 0 |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 984 | static RefVal makeLeak(unsigned Count) { return RefVal(ErrorLeak, Count); } |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 985 | static RefVal makeReleased() { return RefVal(Released); } |
| 986 | static RefVal makeUseAfterRelease() { return RefVal(ErrorUseAfterRelease); } |
| 987 | static RefVal makeReleaseNotOwned() { return RefVal(ErrorReleaseNotOwned); } |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 988 | #endif |
| 989 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 990 | // Comparison, profiling, and pretty-printing. |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 991 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 992 | bool operator==(const RefVal& X) const { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 993 | return kind == X.kind && Cnt == X.Cnt && T == X.T; |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 994 | } |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 995 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 996 | RefVal operator-(size_t i) const { |
| 997 | return RefVal(getKind(), getCount() - i, getType()); |
| 998 | } |
| 999 | |
| 1000 | RefVal operator+(size_t i) const { |
| 1001 | return RefVal(getKind(), getCount() + i, getType()); |
| 1002 | } |
| 1003 | |
| 1004 | RefVal operator^(Kind k) const { |
| 1005 | return RefVal(k, getCount(), getType()); |
| 1006 | } |
| 1007 | |
| 1008 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1009 | void Profile(llvm::FoldingSetNodeID& ID) const { |
| 1010 | ID.AddInteger((unsigned) kind); |
| 1011 | ID.AddInteger(Cnt); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1012 | ID.Add(T); |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1013 | } |
| 1014 | |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1015 | void print(std::ostream& Out) const; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1016 | }; |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1017 | |
| 1018 | void RefVal::print(std::ostream& Out) const { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1019 | if (!T.isNull()) |
| 1020 | Out << "Tracked Type:" << T.getAsString() << '\n'; |
| 1021 | |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1022 | switch (getKind()) { |
| 1023 | default: assert(false); |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1024 | case Owned: { |
| 1025 | Out << "Owned"; |
| 1026 | unsigned cnt = getCount(); |
| 1027 | if (cnt) Out << " (+ " << cnt << ")"; |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1028 | break; |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1029 | } |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1030 | |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1031 | case NotOwned: { |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1032 | Out << "NotOwned"; |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1033 | unsigned cnt = getCount(); |
| 1034 | if (cnt) Out << " (+ " << cnt << ")"; |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1035 | break; |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1036 | } |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1037 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1038 | case ReturnedOwned: { |
| 1039 | Out << "ReturnedOwned"; |
| 1040 | unsigned cnt = getCount(); |
| 1041 | if (cnt) Out << " (+ " << cnt << ")"; |
| 1042 | break; |
| 1043 | } |
| 1044 | |
| 1045 | case ReturnedNotOwned: { |
| 1046 | Out << "ReturnedNotOwned"; |
| 1047 | unsigned cnt = getCount(); |
| 1048 | if (cnt) Out << " (+ " << cnt << ")"; |
| 1049 | break; |
| 1050 | } |
| 1051 | |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1052 | case Released: |
| 1053 | Out << "Released"; |
| 1054 | break; |
| 1055 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1056 | case ErrorLeak: |
| 1057 | Out << "Leaked"; |
| 1058 | break; |
| 1059 | |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1060 | case ErrorUseAfterRelease: |
| 1061 | Out << "Use-After-Release [ERROR]"; |
| 1062 | break; |
| 1063 | |
| 1064 | case ErrorReleaseNotOwned: |
| 1065 | Out << "Release of Not-Owned [ERROR]"; |
| 1066 | break; |
| 1067 | } |
| 1068 | } |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1069 | |
Ted Kremenek | 7aef484 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 1070 | //===----------------------------------------------------------------------===// |
| 1071 | // Transfer functions. |
| 1072 | //===----------------------------------------------------------------------===// |
| 1073 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1074 | class VISIBILITY_HIDDEN CFRefCount : public GRSimpleVals { |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1075 | public: |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1076 | // Type definitions. |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1077 | typedef llvm::ImmutableMap<SymbolID, RefVal> RefBindings; |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1078 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1079 | typedef RefBindings::Factory RefBFactoryTy; |
Ted Kremenek | 1daa16c | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 1080 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1081 | typedef llvm::DenseMap<GRExprEngine::NodeTy*,std::pair<Expr*, SymbolID> > |
| 1082 | ReleasesNotOwnedTy; |
| 1083 | |
| 1084 | typedef ReleasesNotOwnedTy UseAfterReleasesTy; |
| 1085 | |
| 1086 | typedef llvm::DenseMap<GRExprEngine::NodeTy*, std::vector<SymbolID>*> |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1087 | LeaksTy; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1088 | |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1089 | class BindingsPrinter : public ValueState::CheckerStatePrinter { |
| 1090 | public: |
| 1091 | virtual void PrintCheckerState(std::ostream& Out, void* State, |
| 1092 | const char* nl, const char* sep); |
| 1093 | }; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1094 | |
| 1095 | private: |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1096 | // Instance variables. |
| 1097 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1098 | RetainSummaryManager Summaries; |
| 1099 | const bool EmitStandardWarnings; |
| 1100 | const LangOptions& LOpts; |
| 1101 | RefBFactoryTy RefBFactory; |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1102 | |
Ted Kremenek | 1daa16c | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 1103 | UseAfterReleasesTy UseAfterReleases; |
| 1104 | ReleasesNotOwnedTy ReleasesNotOwned; |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1105 | LeaksTy Leaks; |
Ted Kremenek | 1daa16c | 2008-03-11 18:14:09 +0000 | [diff] [blame] | 1106 | |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1107 | BindingsPrinter Printer; |
| 1108 | |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1109 | Selector RetainSelector; |
| 1110 | Selector ReleaseSelector; |
Ted Kremenek | 3281a1f | 2008-05-01 02:18:37 +0000 | [diff] [blame] | 1111 | Selector AutoreleaseSelector; |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1112 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1113 | public: |
| 1114 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1115 | static RefBindings GetRefBindings(ValueState& StImpl) { |
| 1116 | return RefBindings((RefBindings::TreeTy*) StImpl.CheckerState); |
| 1117 | } |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1118 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1119 | private: |
| 1120 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1121 | static void SetRefBindings(ValueState& StImpl, RefBindings B) { |
| 1122 | StImpl.CheckerState = B.getRoot(); |
| 1123 | } |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1124 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1125 | RefBindings Remove(RefBindings B, SymbolID sym) { |
| 1126 | return RefBFactory.Remove(B, sym); |
| 1127 | } |
| 1128 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1129 | RefBindings Update(RefBindings B, SymbolID sym, RefVal V, ArgEffect E, |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1130 | RefVal::Kind& hasErr); |
| 1131 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1132 | void ProcessNonLeakError(ExplodedNodeSet<ValueState>& Dst, |
| 1133 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1134 | Expr* NodeExpr, Expr* ErrorExpr, |
| 1135 | ExplodedNode<ValueState>* Pred, |
| 1136 | ValueState* St, |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1137 | RefVal::Kind hasErr, SymbolID Sym); |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1138 | |
| 1139 | ValueState* HandleSymbolDeath(ValueStateManager& VMgr, ValueState* St, |
| 1140 | SymbolID sid, RefVal V, bool& hasLeak); |
| 1141 | |
| 1142 | ValueState* NukeBinding(ValueStateManager& VMgr, ValueState* St, |
| 1143 | SymbolID sid); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1144 | |
| 1145 | public: |
Ted Kremenek | 7aef484 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 1146 | |
Ted Kremenek | 2f62f35 | 2008-05-02 18:01:49 +0000 | [diff] [blame] | 1147 | CFRefCount(ASTContext& Ctx, bool gcenabled, bool StandardWarnings, |
| 1148 | const LangOptions& lopts) |
Ted Kremenek | 9b0c09c | 2008-04-29 05:33:51 +0000 | [diff] [blame] | 1149 | : Summaries(Ctx, gcenabled), |
Ted Kremenek | 2f62f35 | 2008-05-02 18:01:49 +0000 | [diff] [blame] | 1150 | EmitStandardWarnings(StandardWarnings), |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 1151 | LOpts(lopts), |
Ted Kremenek | 1bd6ddb | 2008-05-01 18:31:44 +0000 | [diff] [blame] | 1152 | RetainSelector(GetNullarySelector("retain", Ctx)), |
| 1153 | ReleaseSelector(GetNullarySelector("release", Ctx)), |
| 1154 | AutoreleaseSelector(GetNullarySelector("autorelease", Ctx)) {} |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1155 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1156 | virtual ~CFRefCount() { |
| 1157 | for (LeaksTy::iterator I = Leaks.begin(), E = Leaks.end(); I!=E; ++I) |
| 1158 | delete I->second; |
| 1159 | } |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1160 | |
| 1161 | virtual void RegisterChecks(GRExprEngine& Eng); |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1162 | |
| 1163 | virtual ValueState::CheckerStatePrinter* getCheckerStatePrinter() { |
| 1164 | return &Printer; |
| 1165 | } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1166 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1167 | bool isGCEnabled() const { return Summaries.isGCEnabled(); } |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 1168 | const LangOptions& getLangOptions() const { return LOpts; } |
| 1169 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1170 | // Calls. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1171 | |
| 1172 | void EvalSummary(ExplodedNodeSet<ValueState>& Dst, |
| 1173 | GRExprEngine& Eng, |
| 1174 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1175 | Expr* Ex, |
| 1176 | Expr* Receiver, |
| 1177 | RetainSummary* Summ, |
Ted Kremenek | 2719e98 | 2008-06-17 02:43:46 +0000 | [diff] [blame] | 1178 | ExprIterator arg_beg, ExprIterator arg_end, |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1179 | ExplodedNode<ValueState>* Pred); |
| 1180 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1181 | virtual void EvalCall(ExplodedNodeSet<ValueState>& Dst, |
Ted Kremenek | ce0767f | 2008-03-12 21:06:49 +0000 | [diff] [blame] | 1182 | GRExprEngine& Eng, |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1183 | GRStmtNodeBuilder<ValueState>& Builder, |
Ted Kremenek | 0a6a80b | 2008-04-23 20:12:28 +0000 | [diff] [blame] | 1184 | CallExpr* CE, RVal L, |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1185 | ExplodedNode<ValueState>* Pred); |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1186 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1187 | |
Ted Kremenek | 4b4738b | 2008-04-15 23:44:31 +0000 | [diff] [blame] | 1188 | virtual void EvalObjCMessageExpr(ExplodedNodeSet<ValueState>& Dst, |
| 1189 | GRExprEngine& Engine, |
| 1190 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1191 | ObjCMessageExpr* ME, |
| 1192 | ExplodedNode<ValueState>* Pred); |
| 1193 | |
| 1194 | bool EvalObjCMessageExprAux(ExplodedNodeSet<ValueState>& Dst, |
| 1195 | GRExprEngine& Engine, |
| 1196 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1197 | ObjCMessageExpr* ME, |
| 1198 | ExplodedNode<ValueState>* Pred); |
| 1199 | |
Ted Kremenek | 7aef484 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 1200 | // Stores. |
| 1201 | |
| 1202 | virtual void EvalStore(ExplodedNodeSet<ValueState>& Dst, |
| 1203 | GRExprEngine& Engine, |
| 1204 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1205 | Expr* E, ExplodedNode<ValueState>* Pred, |
| 1206 | ValueState* St, RVal TargetLV, RVal Val); |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1207 | // End-of-path. |
| 1208 | |
| 1209 | virtual void EvalEndPath(GRExprEngine& Engine, |
| 1210 | GREndPathNodeBuilder<ValueState>& Builder); |
| 1211 | |
Ted Kremenek | 541db37 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1212 | virtual void EvalDeadSymbols(ExplodedNodeSet<ValueState>& Dst, |
| 1213 | GRExprEngine& Engine, |
| 1214 | GRStmtNodeBuilder<ValueState>& Builder, |
Ted Kremenek | ac91ce9 | 2008-04-25 01:25:15 +0000 | [diff] [blame] | 1215 | ExplodedNode<ValueState>* Pred, |
| 1216 | Stmt* S, |
Ted Kremenek | 541db37 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1217 | ValueState* St, |
| 1218 | const ValueStateManager::DeadSymbolsTy& Dead); |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1219 | // Return statements. |
| 1220 | |
| 1221 | virtual void EvalReturn(ExplodedNodeSet<ValueState>& Dst, |
| 1222 | GRExprEngine& Engine, |
| 1223 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1224 | ReturnStmt* S, |
| 1225 | ExplodedNode<ValueState>* Pred); |
Ted Kremenek | eef8f1e | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 1226 | |
| 1227 | // Assumptions. |
| 1228 | |
| 1229 | virtual ValueState* EvalAssume(GRExprEngine& Engine, ValueState* St, |
| 1230 | RVal Cond, bool Assumption, bool& isFeasible); |
| 1231 | |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1232 | // Error iterators. |
| 1233 | |
| 1234 | typedef UseAfterReleasesTy::iterator use_after_iterator; |
| 1235 | typedef ReleasesNotOwnedTy::iterator bad_release_iterator; |
Ted Kremenek | 7f3f41a | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 1236 | typedef LeaksTy::iterator leaks_iterator; |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1237 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1238 | use_after_iterator use_after_begin() { return UseAfterReleases.begin(); } |
| 1239 | use_after_iterator use_after_end() { return UseAfterReleases.end(); } |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1240 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1241 | bad_release_iterator bad_release_begin() { return ReleasesNotOwned.begin(); } |
| 1242 | bad_release_iterator bad_release_end() { return ReleasesNotOwned.end(); } |
Ted Kremenek | 7f3f41a | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 1243 | |
| 1244 | leaks_iterator leaks_begin() { return Leaks.begin(); } |
| 1245 | leaks_iterator leaks_end() { return Leaks.end(); } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1246 | }; |
| 1247 | |
| 1248 | } // end anonymous namespace |
| 1249 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1250 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1251 | |
| 1252 | |
Ted Kremenek | 3b11f7a | 2008-03-11 19:44:10 +0000 | [diff] [blame] | 1253 | void CFRefCount::BindingsPrinter::PrintCheckerState(std::ostream& Out, |
| 1254 | void* State, const char* nl, |
| 1255 | const char* sep) { |
| 1256 | RefBindings B((RefBindings::TreeTy*) State); |
| 1257 | |
| 1258 | if (State) |
| 1259 | Out << sep << nl; |
| 1260 | |
| 1261 | for (RefBindings::iterator I=B.begin(), E=B.end(); I!=E; ++I) { |
| 1262 | Out << (*I).first << " : "; |
| 1263 | (*I).second.print(Out); |
| 1264 | Out << nl; |
| 1265 | } |
| 1266 | } |
| 1267 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1268 | static inline ArgEffect GetArgE(RetainSummary* Summ, unsigned idx) { |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 1269 | return Summ ? Summ->getArg(idx) : MayEscape; |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1270 | } |
| 1271 | |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 1272 | static inline RetEffect GetRetEffect(RetainSummary* Summ) { |
| 1273 | return Summ ? Summ->getRetEffect() : RetEffect::MakeNoRet(); |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1274 | } |
| 1275 | |
Ted Kremenek | 227c537 | 2008-05-06 02:41:27 +0000 | [diff] [blame] | 1276 | static inline ArgEffect GetReceiverE(RetainSummary* Summ) { |
| 1277 | return Summ ? Summ->getReceiverEffect() : DoNothing; |
| 1278 | } |
| 1279 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1280 | void CFRefCount::ProcessNonLeakError(ExplodedNodeSet<ValueState>& Dst, |
| 1281 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1282 | Expr* NodeExpr, Expr* ErrorExpr, |
| 1283 | ExplodedNode<ValueState>* Pred, |
| 1284 | ValueState* St, |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1285 | RefVal::Kind hasErr, SymbolID Sym) { |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1286 | Builder.BuildSinks = true; |
| 1287 | GRExprEngine::NodeTy* N = Builder.MakeNode(Dst, NodeExpr, Pred, St); |
| 1288 | |
| 1289 | if (!N) return; |
| 1290 | |
| 1291 | switch (hasErr) { |
| 1292 | default: assert(false); |
| 1293 | case RefVal::ErrorUseAfterRelease: |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1294 | UseAfterReleases[N] = std::make_pair(ErrorExpr, Sym); |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1295 | break; |
| 1296 | |
| 1297 | case RefVal::ErrorReleaseNotOwned: |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1298 | ReleasesNotOwned[N] = std::make_pair(ErrorExpr, Sym); |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1299 | break; |
| 1300 | } |
| 1301 | } |
| 1302 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1303 | /// GetReturnType - Used to get the return type of a message expression or |
| 1304 | /// function call with the intention of affixing that type to a tracked symbol. |
| 1305 | /// While the the return type can be queried directly from RetEx, when |
| 1306 | /// invoking class methods we augment to the return type to be that of |
| 1307 | /// a pointer to the class (as opposed it just being id). |
| 1308 | static QualType GetReturnType(Expr* RetE, ASTContext& Ctx) { |
| 1309 | |
| 1310 | QualType RetTy = RetE->getType(); |
| 1311 | |
| 1312 | // FIXME: We aren't handling id<...>. |
| 1313 | const PointerType* PT = RetTy.getCanonicalType()->getAsPointerType(); |
| 1314 | |
| 1315 | if (!PT) |
| 1316 | return RetTy; |
| 1317 | |
| 1318 | // If RetEx is not a message expression just return its type. |
| 1319 | // If RetEx is a message expression, return its types if it is something |
| 1320 | /// more specific than id. |
| 1321 | |
| 1322 | ObjCMessageExpr* ME = dyn_cast<ObjCMessageExpr>(RetE); |
| 1323 | |
| 1324 | if (!ME || !Ctx.isObjCIdType(PT->getPointeeType())) |
| 1325 | return RetTy; |
| 1326 | |
| 1327 | ObjCInterfaceDecl* D = ME->getClassInfo().first; |
| 1328 | |
| 1329 | // At this point we know the return type of the message expression is id. |
| 1330 | // If we have an ObjCInterceDecl, we know this is a call to a class method |
| 1331 | // whose type we can resolve. In such cases, promote the return type to |
| 1332 | // Class*. |
| 1333 | return !D ? RetTy : Ctx.getPointerType(Ctx.getObjCInterfaceType(D)); |
| 1334 | } |
| 1335 | |
| 1336 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1337 | void CFRefCount::EvalSummary(ExplodedNodeSet<ValueState>& Dst, |
| 1338 | GRExprEngine& Eng, |
| 1339 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1340 | Expr* Ex, |
| 1341 | Expr* Receiver, |
| 1342 | RetainSummary* Summ, |
Ted Kremenek | 2719e98 | 2008-06-17 02:43:46 +0000 | [diff] [blame] | 1343 | ExprIterator arg_beg, ExprIterator arg_end, |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1344 | ExplodedNode<ValueState>* Pred) { |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1345 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1346 | // Get the state. |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1347 | ValueStateManager& StateMgr = Eng.getStateManager(); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1348 | ValueState* St = Builder.GetState(Pred); |
Ted Kremenek | 227c537 | 2008-05-06 02:41:27 +0000 | [diff] [blame] | 1349 | |
| 1350 | // Evaluate the effect of the arguments. |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1351 | ValueState StVals = *St; |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1352 | RefVal::Kind hasErr = (RefVal::Kind) 0; |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1353 | unsigned idx = 0; |
Ted Kremenek | 99b0ecb | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 1354 | Expr* ErrorExpr = NULL; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1355 | SymbolID ErrorSym = 0; |
Ted Kremenek | 99b0ecb | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 1356 | |
Ted Kremenek | 2719e98 | 2008-06-17 02:43:46 +0000 | [diff] [blame] | 1357 | for (ExprIterator I = arg_beg; I != arg_end; ++I, ++idx) { |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1358 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1359 | RVal V = StateMgr.GetRVal(St, *I); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1360 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1361 | if (isa<lval::SymbolVal>(V)) { |
| 1362 | SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol(); |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1363 | RefBindings B = GetRefBindings(StVals); |
| 1364 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1365 | if (RefBindings::TreeTy* T = B.SlimFind(Sym)) { |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1366 | B = Update(B, Sym, T->getValue().second, GetArgE(Summ, idx), hasErr); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1367 | SetRefBindings(StVals, B); |
Ted Kremenek | 99b0ecb | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 1368 | |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1369 | if (hasErr) { |
Ted Kremenek | 99b0ecb | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 1370 | ErrorExpr = *I; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1371 | ErrorSym = T->getValue().first; |
Ted Kremenek | 99b0ecb | 2008-04-11 18:40:51 +0000 | [diff] [blame] | 1372 | break; |
| 1373 | } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1374 | } |
Ted Kremenek | e492420 | 2008-04-11 20:51:02 +0000 | [diff] [blame] | 1375 | } |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1376 | else if (isa<LVal>(V)) { |
| 1377 | // Nuke all arguments passed by reference. |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1378 | StateMgr.Unbind(StVals, cast<LVal>(V)); |
Ted Kremenek | e492420 | 2008-04-11 20:51:02 +0000 | [diff] [blame] | 1379 | } |
Ted Kremenek | be62129 | 2008-04-22 21:39:21 +0000 | [diff] [blame] | 1380 | else if (isa<nonlval::LValAsInteger>(V)) |
| 1381 | StateMgr.Unbind(StVals, cast<nonlval::LValAsInteger>(V).getLVal()); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1382 | } |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1383 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1384 | // Evaluate the effect on the message receiver. |
Ted Kremenek | 227c537 | 2008-05-06 02:41:27 +0000 | [diff] [blame] | 1385 | if (!ErrorExpr && Receiver) { |
| 1386 | RVal V = StateMgr.GetRVal(St, Receiver); |
| 1387 | |
| 1388 | if (isa<lval::SymbolVal>(V)) { |
| 1389 | SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol(); |
| 1390 | RefBindings B = GetRefBindings(StVals); |
| 1391 | |
| 1392 | if (RefBindings::TreeTy* T = B.SlimFind(Sym)) { |
| 1393 | B = Update(B, Sym, T->getValue().second, GetReceiverE(Summ), hasErr); |
| 1394 | SetRefBindings(StVals, B); |
| 1395 | |
| 1396 | if (hasErr) { |
| 1397 | ErrorExpr = Receiver; |
| 1398 | ErrorSym = T->getValue().first; |
| 1399 | } |
| 1400 | } |
| 1401 | } |
| 1402 | } |
| 1403 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1404 | // Get the persistent state. |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1405 | St = StateMgr.getPersistentState(StVals); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1406 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1407 | // Process any errors. |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1408 | if (hasErr) { |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1409 | ProcessNonLeakError(Dst, Builder, Ex, ErrorExpr, Pred, St, |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1410 | hasErr, ErrorSym); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1411 | return; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1412 | } |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1413 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1414 | // Finally, consult the summary for the return value. |
Ted Kremenek | 266d8b6 | 2008-05-06 02:26:56 +0000 | [diff] [blame] | 1415 | RetEffect RE = GetRetEffect(Summ); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1416 | |
| 1417 | switch (RE.getKind()) { |
| 1418 | default: |
| 1419 | assert (false && "Unhandled RetEffect."); break; |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1420 | |
Ted Kremenek | ab2fa2a | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 1421 | case RetEffect::NoRet: |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1422 | |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1423 | // Make up a symbol for the return value (not reference counted). |
Ted Kremenek | e492420 | 2008-04-11 20:51:02 +0000 | [diff] [blame] | 1424 | // FIXME: This is basically copy-and-paste from GRSimpleVals. We |
| 1425 | // should compose behavior, not copy it. |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1426 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1427 | if (Ex->getType() != Eng.getContext().VoidTy) { |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1428 | unsigned Count = Builder.getCurrentBlockCount(); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1429 | SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(Ex, Count); |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1430 | |
Ted Kremenek | 9e2c1ea | 2008-05-09 23:45:33 +0000 | [diff] [blame] | 1431 | RVal X = LVal::IsLValType(Ex->getType()) |
| 1432 | ? cast<RVal>(lval::SymbolVal(Sym)) |
| 1433 | : cast<RVal>(nonlval::SymbolVal(Sym)); |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1434 | |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1435 | St = StateMgr.SetRVal(St, Ex, X, Eng.getCFG().isBlkExpr(Ex), false); |
Ted Kremenek | 455dd86 | 2008-04-11 20:23:24 +0000 | [diff] [blame] | 1436 | } |
| 1437 | |
Ted Kremenek | ab2fa2a | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 1438 | break; |
| 1439 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1440 | case RetEffect::Alias: { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1441 | unsigned idx = RE.getIndex(); |
Ted Kremenek | 2719e98 | 2008-06-17 02:43:46 +0000 | [diff] [blame] | 1442 | assert (arg_end >= arg_beg); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1443 | assert (idx < (unsigned) (arg_end - arg_beg)); |
Ted Kremenek | 2719e98 | 2008-06-17 02:43:46 +0000 | [diff] [blame] | 1444 | RVal V = StateMgr.GetRVal(St, *(arg_beg+idx)); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1445 | St = StateMgr.SetRVal(St, Ex, V, Eng.getCFG().isBlkExpr(Ex), false); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1446 | break; |
| 1447 | } |
| 1448 | |
Ted Kremenek | 227c537 | 2008-05-06 02:41:27 +0000 | [diff] [blame] | 1449 | case RetEffect::ReceiverAlias: { |
| 1450 | assert (Receiver); |
| 1451 | RVal V = StateMgr.GetRVal(St, Receiver); |
| 1452 | St = StateMgr.SetRVal(St, Ex, V, Eng.getCFG().isBlkExpr(Ex), false); |
| 1453 | break; |
| 1454 | } |
| 1455 | |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 1456 | case RetEffect::OwnedAllocatedSymbol: |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1457 | case RetEffect::OwnedSymbol: { |
| 1458 | unsigned Count = Builder.getCurrentBlockCount(); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1459 | SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(Ex, Count); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1460 | QualType RetT = GetReturnType(Ex, Eng.getContext()); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1461 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1462 | ValueState StImpl = *St; |
| 1463 | RefBindings B = GetRefBindings(StImpl); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1464 | SetRefBindings(StImpl, RefBFactory.Add(B, Sym, RefVal::makeOwned(RetT))); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1465 | |
| 1466 | St = StateMgr.SetRVal(StateMgr.getPersistentState(StImpl), |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1467 | Ex, lval::SymbolVal(Sym), |
| 1468 | Eng.getCFG().isBlkExpr(Ex), false); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1469 | |
Ted Kremenek | 6a1cc25 | 2008-06-23 18:02:52 +0000 | [diff] [blame] | 1470 | // FIXME: Add a flag to the checker where allocations are allowed to fail. |
| 1471 | if (RE.getKind() == RetEffect::OwnedAllocatedSymbol) |
| 1472 | St = StateMgr.AddNE(St, Sym, Eng.getBasicVals().getZeroWithPtrWidth()); |
| 1473 | |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1474 | break; |
| 1475 | } |
| 1476 | |
| 1477 | case RetEffect::NotOwnedSymbol: { |
| 1478 | unsigned Count = Builder.getCurrentBlockCount(); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1479 | SymbolID Sym = Eng.getSymbolManager().getConjuredSymbol(Ex, Count); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1480 | QualType RetT = GetReturnType(Ex, Eng.getContext()); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1481 | |
| 1482 | ValueState StImpl = *St; |
| 1483 | RefBindings B = GetRefBindings(StImpl); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1484 | SetRefBindings(StImpl, RefBFactory.Add(B, Sym, |
| 1485 | RefVal::makeNotOwned(RetT))); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1486 | |
| 1487 | St = StateMgr.SetRVal(StateMgr.getPersistentState(StImpl), |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1488 | Ex, lval::SymbolVal(Sym), |
| 1489 | Eng.getCFG().isBlkExpr(Ex), false); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1490 | |
| 1491 | break; |
| 1492 | } |
| 1493 | } |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1494 | |
| 1495 | Builder.MakeNode(Dst, Ex, Pred, St); |
| 1496 | } |
| 1497 | |
| 1498 | |
| 1499 | void CFRefCount::EvalCall(ExplodedNodeSet<ValueState>& Dst, |
| 1500 | GRExprEngine& Eng, |
| 1501 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1502 | CallExpr* CE, RVal L, |
| 1503 | ExplodedNode<ValueState>* Pred) { |
| 1504 | |
| 1505 | |
| 1506 | RetainSummary* Summ = NULL; |
| 1507 | |
| 1508 | // Get the summary. |
| 1509 | |
| 1510 | if (isa<lval::FuncVal>(L)) { |
| 1511 | lval::FuncVal FV = cast<lval::FuncVal>(L); |
| 1512 | FunctionDecl* FD = FV.getDecl(); |
Ted Kremenek | d13c187 | 2008-06-24 03:56:45 +0000 | [diff] [blame] | 1513 | Summ = Summaries.getSummary(FD); |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1514 | } |
| 1515 | |
| 1516 | EvalSummary(Dst, Eng, Builder, CE, 0, Summ, |
| 1517 | CE->arg_begin(), CE->arg_end(), Pred); |
Ted Kremenek | 827f93b | 2008-03-06 00:08:09 +0000 | [diff] [blame] | 1518 | } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1519 | |
Ted Kremenek | 4b4738b | 2008-04-15 23:44:31 +0000 | [diff] [blame] | 1520 | |
| 1521 | void CFRefCount::EvalObjCMessageExpr(ExplodedNodeSet<ValueState>& Dst, |
| 1522 | GRExprEngine& Eng, |
| 1523 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1524 | ObjCMessageExpr* ME, |
| 1525 | ExplodedNode<ValueState>* Pred) { |
| 1526 | |
Ted Kremenek | 926abf2 | 2008-05-06 04:20:12 +0000 | [diff] [blame] | 1527 | RetainSummary* Summ; |
Ted Kremenek | 3366180 | 2008-05-01 21:31:50 +0000 | [diff] [blame] | 1528 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1529 | if (Expr* Receiver = ME->getReceiver()) { |
| 1530 | // We need the type-information of the tracked receiver object |
| 1531 | // Retrieve it from the state. |
| 1532 | ObjCInterfaceDecl* ID = 0; |
| 1533 | |
| 1534 | // FIXME: Wouldn't it be great if this code could be reduced? It's just |
| 1535 | // a chain of lookups. |
| 1536 | ValueState* St = Builder.GetState(Pred); |
| 1537 | RVal V = Eng.getStateManager().GetRVal(St, Receiver ); |
| 1538 | |
| 1539 | if (isa<lval::SymbolVal>(V)) { |
| 1540 | SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol(); |
| 1541 | |
| 1542 | if (RefBindings::TreeTy* T = GetRefBindings(*St).SlimFind(Sym)) { |
| 1543 | QualType Ty = T->getValue().second.getType(); |
| 1544 | |
| 1545 | if (const PointerType* PT = Ty->getAsPointerType()) { |
| 1546 | QualType PointeeTy = PT->getPointeeType(); |
| 1547 | |
| 1548 | if (ObjCInterfaceType* IT = dyn_cast<ObjCInterfaceType>(PointeeTy)) |
| 1549 | ID = IT->getDecl(); |
| 1550 | } |
| 1551 | } |
| 1552 | } |
| 1553 | |
| 1554 | Summ = Summaries.getMethodSummary(ME, ID); |
| 1555 | } |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1556 | else |
Ted Kremenek | 97c1e0c | 2008-06-23 22:21:20 +0000 | [diff] [blame] | 1557 | Summ = Summaries.getClassMethodSummary(ME->getClassName(), |
| 1558 | ME->getSelector()); |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1559 | |
Ted Kremenek | 926abf2 | 2008-05-06 04:20:12 +0000 | [diff] [blame] | 1560 | EvalSummary(Dst, Eng, Builder, ME, ME->getReceiver(), Summ, |
| 1561 | ME->arg_begin(), ME->arg_end(), Pred); |
Ted Kremenek | 4b4738b | 2008-04-15 23:44:31 +0000 | [diff] [blame] | 1562 | } |
Ted Kremenek | 926abf2 | 2008-05-06 04:20:12 +0000 | [diff] [blame] | 1563 | |
Ted Kremenek | 7aef484 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 1564 | // Stores. |
| 1565 | |
| 1566 | void CFRefCount::EvalStore(ExplodedNodeSet<ValueState>& Dst, |
| 1567 | GRExprEngine& Eng, |
| 1568 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1569 | Expr* E, ExplodedNode<ValueState>* Pred, |
| 1570 | ValueState* St, RVal TargetLV, RVal Val) { |
| 1571 | |
| 1572 | // Check if we have a binding for "Val" and if we are storing it to something |
| 1573 | // we don't understand or otherwise the value "escapes" the function. |
| 1574 | |
| 1575 | if (!isa<lval::SymbolVal>(Val)) |
| 1576 | return; |
| 1577 | |
| 1578 | // Are we storing to something that causes the value to "escape"? |
| 1579 | |
| 1580 | bool escapes = false; |
| 1581 | |
| 1582 | if (!isa<lval::DeclVal>(TargetLV)) |
| 1583 | escapes = true; |
| 1584 | else |
| 1585 | escapes = cast<lval::DeclVal>(TargetLV).getDecl()->hasGlobalStorage(); |
| 1586 | |
| 1587 | if (!escapes) |
| 1588 | return; |
| 1589 | |
| 1590 | SymbolID Sym = cast<lval::SymbolVal>(Val).getSymbol(); |
| 1591 | RefBindings B = GetRefBindings(*St); |
| 1592 | RefBindings::TreeTy* T = B.SlimFind(Sym); |
| 1593 | |
| 1594 | if (!T) |
| 1595 | return; |
| 1596 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1597 | // Nuke the binding. |
| 1598 | St = NukeBinding(Eng.getStateManager(), St, Sym); |
Ted Kremenek | 7aef484 | 2008-04-16 20:40:59 +0000 | [diff] [blame] | 1599 | |
| 1600 | // Hand of the remaining logic to the parent implementation. |
| 1601 | GRSimpleVals::EvalStore(Dst, Eng, Builder, E, Pred, St, TargetLV, Val); |
| 1602 | } |
| 1603 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1604 | |
| 1605 | ValueState* CFRefCount::NukeBinding(ValueStateManager& VMgr, ValueState* St, |
| 1606 | SymbolID sid) { |
| 1607 | ValueState StImpl = *St; |
| 1608 | RefBindings B = GetRefBindings(StImpl); |
| 1609 | StImpl.CheckerState = RefBFactory.Remove(B, sid).getRoot(); |
| 1610 | return VMgr.getPersistentState(StImpl); |
| 1611 | } |
| 1612 | |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1613 | // End-of-path. |
| 1614 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1615 | ValueState* CFRefCount::HandleSymbolDeath(ValueStateManager& VMgr, |
| 1616 | ValueState* St, SymbolID sid, |
| 1617 | RefVal V, bool& hasLeak) { |
| 1618 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1619 | hasLeak = V.isOwned() || |
| 1620 | ((V.isNotOwned() || V.isReturnedOwned()) && V.getCount() > 0); |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1621 | |
| 1622 | if (!hasLeak) |
| 1623 | return NukeBinding(VMgr, St, sid); |
| 1624 | |
| 1625 | RefBindings B = GetRefBindings(*St); |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1626 | ValueState StImpl = *St; |
| 1627 | StImpl.CheckerState = RefBFactory.Add(B, sid, V^RefVal::ErrorLeak).getRoot(); |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 1628 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1629 | return VMgr.getPersistentState(StImpl); |
| 1630 | } |
| 1631 | |
| 1632 | void CFRefCount::EvalEndPath(GRExprEngine& Eng, |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1633 | GREndPathNodeBuilder<ValueState>& Builder) { |
| 1634 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1635 | ValueState* St = Builder.getState(); |
| 1636 | RefBindings B = GetRefBindings(*St); |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1637 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1638 | llvm::SmallVector<SymbolID, 10> Leaked; |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1639 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1640 | for (RefBindings::iterator I = B.begin(), E = B.end(); I != E; ++I) { |
| 1641 | bool hasLeak = false; |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1642 | |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1643 | St = HandleSymbolDeath(Eng.getStateManager(), St, |
| 1644 | (*I).first, (*I).second, hasLeak); |
| 1645 | |
| 1646 | if (hasLeak) Leaked.push_back((*I).first); |
| 1647 | } |
Ted Kremenek | 541db37 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1648 | |
| 1649 | if (Leaked.empty()) |
| 1650 | return; |
| 1651 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1652 | ExplodedNode<ValueState>* N = Builder.MakeNode(St); |
Ted Kremenek | cfc909d | 2008-04-18 16:30:14 +0000 | [diff] [blame] | 1653 | |
Ted Kremenek | 541db37 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1654 | if (!N) |
Ted Kremenek | cfc909d | 2008-04-18 16:30:14 +0000 | [diff] [blame] | 1655 | return; |
Ted Kremenek | eef8f1e | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 1656 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1657 | std::vector<SymbolID>*& LeaksAtNode = Leaks[N]; |
| 1658 | assert (!LeaksAtNode); |
| 1659 | LeaksAtNode = new std::vector<SymbolID>(); |
Ted Kremenek | 3f3c9c8 | 2008-04-16 22:32:20 +0000 | [diff] [blame] | 1660 | |
| 1661 | for (llvm::SmallVector<SymbolID, 10>::iterator I=Leaked.begin(), |
| 1662 | E = Leaked.end(); I != E; ++I) |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1663 | (*LeaksAtNode).push_back(*I); |
Ted Kremenek | ffefc35 | 2008-04-11 22:25:11 +0000 | [diff] [blame] | 1664 | } |
| 1665 | |
Ted Kremenek | 541db37 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1666 | // Dead symbols. |
| 1667 | |
| 1668 | void CFRefCount::EvalDeadSymbols(ExplodedNodeSet<ValueState>& Dst, |
| 1669 | GRExprEngine& Eng, |
| 1670 | GRStmtNodeBuilder<ValueState>& Builder, |
Ted Kremenek | ac91ce9 | 2008-04-25 01:25:15 +0000 | [diff] [blame] | 1671 | ExplodedNode<ValueState>* Pred, |
| 1672 | Stmt* S, |
Ted Kremenek | 541db37 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1673 | ValueState* St, |
| 1674 | const ValueStateManager::DeadSymbolsTy& Dead) { |
Ted Kremenek | ac91ce9 | 2008-04-25 01:25:15 +0000 | [diff] [blame] | 1675 | |
Ted Kremenek | 541db37 | 2008-04-24 23:57:27 +0000 | [diff] [blame] | 1676 | // FIXME: a lot of copy-and-paste from EvalEndPath. Refactor. |
| 1677 | |
| 1678 | RefBindings B = GetRefBindings(*St); |
| 1679 | llvm::SmallVector<SymbolID, 10> Leaked; |
| 1680 | |
| 1681 | for (ValueStateManager::DeadSymbolsTy::const_iterator |
| 1682 | I=Dead.begin(), E=Dead.end(); I!=E; ++I) { |
| 1683 | |
| 1684 | RefBindings::TreeTy* T = B.SlimFind(*I); |
| 1685 | |
| 1686 | if (!T) |
| 1687 | continue; |
| 1688 | |
| 1689 | bool hasLeak = false; |
| 1690 | |
| 1691 | St = HandleSymbolDeath(Eng.getStateManager(), St, |
| 1692 | *I, T->getValue().second, hasLeak); |
| 1693 | |
| 1694 | if (hasLeak) Leaked.push_back(*I); |
| 1695 | } |
| 1696 | |
| 1697 | if (Leaked.empty()) |
| 1698 | return; |
| 1699 | |
| 1700 | ExplodedNode<ValueState>* N = Builder.MakeNode(Dst, S, Pred, St); |
| 1701 | |
| 1702 | if (!N) |
| 1703 | return; |
| 1704 | |
| 1705 | std::vector<SymbolID>*& LeaksAtNode = Leaks[N]; |
| 1706 | assert (!LeaksAtNode); |
| 1707 | LeaksAtNode = new std::vector<SymbolID>(); |
| 1708 | |
| 1709 | for (llvm::SmallVector<SymbolID, 10>::iterator I=Leaked.begin(), |
| 1710 | E = Leaked.end(); I != E; ++I) |
| 1711 | (*LeaksAtNode).push_back(*I); |
| 1712 | } |
| 1713 | |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1714 | // Return statements. |
| 1715 | |
| 1716 | void CFRefCount::EvalReturn(ExplodedNodeSet<ValueState>& Dst, |
| 1717 | GRExprEngine& Eng, |
| 1718 | GRStmtNodeBuilder<ValueState>& Builder, |
| 1719 | ReturnStmt* S, |
| 1720 | ExplodedNode<ValueState>* Pred) { |
| 1721 | |
| 1722 | Expr* RetE = S->getRetValue(); |
| 1723 | if (!RetE) return; |
| 1724 | |
| 1725 | ValueStateManager& StateMgr = Eng.getStateManager(); |
| 1726 | ValueState* St = Builder.GetState(Pred); |
| 1727 | RVal V = StateMgr.GetRVal(St, RetE); |
| 1728 | |
| 1729 | if (!isa<lval::SymbolVal>(V)) |
| 1730 | return; |
| 1731 | |
| 1732 | // Get the reference count binding (if any). |
| 1733 | SymbolID Sym = cast<lval::SymbolVal>(V).getSymbol(); |
| 1734 | RefBindings B = GetRefBindings(*St); |
| 1735 | RefBindings::TreeTy* T = B.SlimFind(Sym); |
| 1736 | |
| 1737 | if (!T) |
| 1738 | return; |
| 1739 | |
| 1740 | // Change the reference count. |
| 1741 | |
| 1742 | RefVal X = T->getValue().second; |
| 1743 | |
| 1744 | switch (X.getKind()) { |
| 1745 | |
| 1746 | case RefVal::Owned: { |
| 1747 | unsigned cnt = X.getCount(); |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 1748 | assert (cnt > 0); |
| 1749 | X = RefVal::makeReturnedOwned(cnt - 1); |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1750 | break; |
| 1751 | } |
| 1752 | |
| 1753 | case RefVal::NotOwned: { |
| 1754 | unsigned cnt = X.getCount(); |
| 1755 | X = cnt ? RefVal::makeReturnedOwned(cnt - 1) |
| 1756 | : RefVal::makeReturnedNotOwned(); |
| 1757 | break; |
| 1758 | } |
| 1759 | |
| 1760 | default: |
Ted Kremenek | d9ccf68 | 2008-04-17 18:12:53 +0000 | [diff] [blame] | 1761 | return; |
| 1762 | } |
| 1763 | |
| 1764 | // Update the binding. |
| 1765 | |
| 1766 | ValueState StImpl = *St; |
| 1767 | StImpl.CheckerState = RefBFactory.Add(B, Sym, X).getRoot(); |
| 1768 | Builder.MakeNode(Dst, S, Pred, StateMgr.getPersistentState(StImpl)); |
| 1769 | } |
| 1770 | |
Ted Kremenek | eef8f1e | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 1771 | // Assumptions. |
| 1772 | |
| 1773 | ValueState* CFRefCount::EvalAssume(GRExprEngine& Eng, ValueState* St, |
| 1774 | RVal Cond, bool Assumption, |
| 1775 | bool& isFeasible) { |
| 1776 | |
| 1777 | // FIXME: We may add to the interface of EvalAssume the list of symbols |
| 1778 | // whose assumptions have changed. For now we just iterate through the |
| 1779 | // bindings and check if any of the tracked symbols are NULL. This isn't |
| 1780 | // too bad since the number of symbols we will track in practice are |
| 1781 | // probably small and EvalAssume is only called at branches and a few |
| 1782 | // other places. |
| 1783 | |
| 1784 | RefBindings B = GetRefBindings(*St); |
| 1785 | |
| 1786 | if (B.isEmpty()) |
| 1787 | return St; |
| 1788 | |
| 1789 | bool changed = false; |
| 1790 | |
| 1791 | for (RefBindings::iterator I=B.begin(), E=B.end(); I!=E; ++I) { |
| 1792 | |
| 1793 | // Check if the symbol is null (or equal to any constant). |
| 1794 | // If this is the case, stop tracking the symbol. |
| 1795 | |
| 1796 | if (St->getSymVal(I.getKey())) { |
| 1797 | changed = true; |
| 1798 | B = RefBFactory.Remove(B, I.getKey()); |
| 1799 | } |
| 1800 | } |
| 1801 | |
| 1802 | if (!changed) |
| 1803 | return St; |
| 1804 | |
| 1805 | ValueState StImpl = *St; |
| 1806 | StImpl.CheckerState = B.getRoot(); |
| 1807 | return Eng.getStateManager().getPersistentState(StImpl); |
| 1808 | } |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1809 | |
| 1810 | CFRefCount::RefBindings CFRefCount::Update(RefBindings B, SymbolID sym, |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1811 | RefVal V, ArgEffect E, |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1812 | RefVal::Kind& hasErr) { |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1813 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1814 | // FIXME: This dispatch can potentially be sped up by unifiying it into |
| 1815 | // a single switch statement. Opt for simplicity for now. |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1816 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1817 | switch (E) { |
| 1818 | default: |
| 1819 | assert (false && "Unhandled CFRef transition."); |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 1820 | |
| 1821 | case MayEscape: |
| 1822 | if (V.getKind() == RefVal::Owned) { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1823 | V = V ^ RefVal::NotOwned; |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 1824 | break; |
| 1825 | } |
| 1826 | |
| 1827 | // Fall-through. |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1828 | |
| 1829 | case DoNothing: |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1830 | if (!isGCEnabled() && V.getKind() == RefVal::Released) { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1831 | V = V ^ RefVal::ErrorUseAfterRelease; |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1832 | hasErr = V.getKind(); |
Ted Kremenek | ce3ed1e | 2008-03-12 01:21:45 +0000 | [diff] [blame] | 1833 | break; |
| 1834 | } |
| 1835 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1836 | return B; |
Ted Kremenek | e5a4bb0 | 2008-06-30 16:57:41 +0000 | [diff] [blame] | 1837 | |
Ted Kremenek | 4e1d22f | 2008-07-01 00:01:02 +0000 | [diff] [blame^] | 1838 | case Autorelease: |
Ted Kremenek | 227c537 | 2008-05-06 02:41:27 +0000 | [diff] [blame] | 1839 | case StopTracking: |
| 1840 | return RefBFactory.Remove(B, sym); |
| 1841 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1842 | case IncRef: |
| 1843 | switch (V.getKind()) { |
| 1844 | default: |
| 1845 | assert(false); |
| 1846 | |
| 1847 | case RefVal::Owned: |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1848 | case RefVal::NotOwned: |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1849 | V = V + 1; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1850 | break; |
| 1851 | |
| 1852 | case RefVal::Released: |
Ted Kremenek | a8c3c43 | 2008-05-05 22:11:16 +0000 | [diff] [blame] | 1853 | if (isGCEnabled()) |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1854 | V = V ^ RefVal::Owned; |
Ted Kremenek | e2dd957 | 2008-04-29 05:44:10 +0000 | [diff] [blame] | 1855 | else { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1856 | V = V ^ RefVal::ErrorUseAfterRelease; |
Ted Kremenek | e2dd957 | 2008-04-29 05:44:10 +0000 | [diff] [blame] | 1857 | hasErr = V.getKind(); |
| 1858 | } |
| 1859 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1860 | break; |
| 1861 | } |
| 1862 | |
Ted Kremenek | ab2fa2a | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 1863 | break; |
| 1864 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1865 | case SelfOwn: |
| 1866 | V = V ^ RefVal::NotOwned; |
| 1867 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1868 | case DecRef: |
| 1869 | switch (V.getKind()) { |
| 1870 | default: |
| 1871 | assert (false); |
| 1872 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1873 | case RefVal::Owned: |
| 1874 | V = V.getCount() > 1 ? V - 1 : V ^ RefVal::Released; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1875 | break; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1876 | |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1877 | case RefVal::NotOwned: |
| 1878 | if (V.getCount() > 0) |
| 1879 | V = V - 1; |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1880 | else { |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1881 | V = V ^ RefVal::ErrorReleaseNotOwned; |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1882 | hasErr = V.getKind(); |
Ted Kremenek | c4f8102 | 2008-04-10 23:09:18 +0000 | [diff] [blame] | 1883 | } |
| 1884 | |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1885 | break; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1886 | |
| 1887 | case RefVal::Released: |
Ted Kremenek | 272aa85 | 2008-06-25 21:21:56 +0000 | [diff] [blame] | 1888 | V = V ^ RefVal::ErrorUseAfterRelease; |
Ted Kremenek | 1feab29 | 2008-04-16 04:28:53 +0000 | [diff] [blame] | 1889 | hasErr = V.getKind(); |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1890 | break; |
| 1891 | } |
Ted Kremenek | ab2fa2a | 2008-04-10 23:44:06 +0000 | [diff] [blame] | 1892 | |
| 1893 | break; |
Ted Kremenek | 0d72157 | 2008-03-11 17:48:22 +0000 | [diff] [blame] | 1894 | } |
| 1895 | |
| 1896 | return RefBFactory.Add(B, sym, V); |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 1897 | } |
| 1898 | |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1899 | |
| 1900 | //===----------------------------------------------------------------------===// |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 1901 | // Error reporting. |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 1902 | //===----------------------------------------------------------------------===// |
| 1903 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1904 | namespace { |
| 1905 | |
| 1906 | //===-------------===// |
| 1907 | // Bug Descriptions. // |
| 1908 | //===-------------===// |
| 1909 | |
Ted Kremenek | e376985 | 2008-04-18 20:54:29 +0000 | [diff] [blame] | 1910 | class VISIBILITY_HIDDEN CFRefBug : public BugTypeCacheLocation { |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1911 | protected: |
| 1912 | CFRefCount& TF; |
| 1913 | |
| 1914 | public: |
| 1915 | CFRefBug(CFRefCount& tf) : TF(tf) {} |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 1916 | |
Ted Kremenek | 5c3407a | 2008-05-01 22:50:36 +0000 | [diff] [blame] | 1917 | CFRefCount& getTF() { return TF; } |
Ted Kremenek | 0ff3f20 | 2008-05-05 23:16:31 +0000 | [diff] [blame] | 1918 | const CFRefCount& getTF() const { return TF; } |
| 1919 | |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 1920 | virtual bool isLeak() const { return false; } |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1921 | }; |
| 1922 | |
| 1923 | class VISIBILITY_HIDDEN UseAfterRelease : public CFRefBug { |
| 1924 | public: |
| 1925 | UseAfterRelease(CFRefCount& tf) : CFRefBug(tf) {} |
| 1926 | |
| 1927 | virtual const char* getName() const { |
Ted Kremenek | 0ff3f20 | 2008-05-05 23:16:31 +0000 | [diff] [blame] | 1928 | return "Use-After-Release"; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1929 | } |
| 1930 | virtual const char* getDescription() const { |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1931 | return "Reference-counted object is used" |
| 1932 | " after it is released."; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1933 | } |
| 1934 | |
| 1935 | virtual void EmitWarnings(BugReporter& BR); |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1936 | }; |
| 1937 | |
| 1938 | class VISIBILITY_HIDDEN BadRelease : public CFRefBug { |
| 1939 | public: |
| 1940 | BadRelease(CFRefCount& tf) : CFRefBug(tf) {} |
| 1941 | |
| 1942 | virtual const char* getName() const { |
Ted Kremenek | 0ff3f20 | 2008-05-05 23:16:31 +0000 | [diff] [blame] | 1943 | return "Bad Release"; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1944 | } |
| 1945 | virtual const char* getDescription() const { |
| 1946 | return "Incorrect decrement of the reference count of a " |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1947 | "CoreFoundation object: " |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1948 | "The object is not owned at this point by the caller."; |
| 1949 | } |
| 1950 | |
| 1951 | virtual void EmitWarnings(BugReporter& BR); |
| 1952 | }; |
| 1953 | |
| 1954 | class VISIBILITY_HIDDEN Leak : public CFRefBug { |
| 1955 | public: |
| 1956 | Leak(CFRefCount& tf) : CFRefBug(tf) {} |
| 1957 | |
| 1958 | virtual const char* getName() const { |
Ted Kremenek | b3a44e7 | 2008-05-06 18:11:36 +0000 | [diff] [blame] | 1959 | |
| 1960 | if (getTF().isGCEnabled()) |
| 1961 | return "Memory Leak (GC)"; |
| 1962 | |
| 1963 | if (getTF().getLangOptions().getGCMode() == LangOptions::HybridGC) |
| 1964 | return "Memory Leak (Hybrid MM, non-GC)"; |
| 1965 | |
| 1966 | assert (getTF().getLangOptions().getGCMode() == LangOptions::NonGC); |
| 1967 | return "Memory Leak"; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1968 | } |
| 1969 | |
| 1970 | virtual const char* getDescription() const { |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 1971 | return "Object leaked."; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1972 | } |
| 1973 | |
| 1974 | virtual void EmitWarnings(BugReporter& BR); |
Ted Kremenek | 5c3407a | 2008-05-01 22:50:36 +0000 | [diff] [blame] | 1975 | virtual void GetErrorNodes(std::vector<ExplodedNode<ValueState>*>& Nodes); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 1976 | virtual bool isLeak() const { return true; } |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 1977 | virtual bool isCached(BugReport& R); |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1978 | }; |
| 1979 | |
| 1980 | //===---------===// |
| 1981 | // Bug Reports. // |
| 1982 | //===---------===// |
| 1983 | |
| 1984 | class VISIBILITY_HIDDEN CFRefReport : public RangedBugReport { |
| 1985 | SymbolID Sym; |
| 1986 | public: |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 1987 | CFRefReport(CFRefBug& D, ExplodedNode<ValueState> *n, SymbolID sym) |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 1988 | : RangedBugReport(D, n), Sym(sym) {} |
| 1989 | |
| 1990 | virtual ~CFRefReport() {} |
| 1991 | |
Ted Kremenek | 5c3407a | 2008-05-01 22:50:36 +0000 | [diff] [blame] | 1992 | CFRefBug& getBugType() { |
| 1993 | return (CFRefBug&) RangedBugReport::getBugType(); |
| 1994 | } |
| 1995 | const CFRefBug& getBugType() const { |
| 1996 | return (const CFRefBug&) RangedBugReport::getBugType(); |
| 1997 | } |
| 1998 | |
| 1999 | virtual void getRanges(BugReporter& BR, const SourceRange*& beg, |
| 2000 | const SourceRange*& end) { |
| 2001 | |
Ted Kremenek | 198cae0 | 2008-05-02 20:53:50 +0000 | [diff] [blame] | 2002 | if (!getBugType().isLeak()) |
Ted Kremenek | 5c3407a | 2008-05-01 22:50:36 +0000 | [diff] [blame] | 2003 | RangedBugReport::getRanges(BR, beg, end); |
| 2004 | else { |
| 2005 | beg = 0; |
| 2006 | end = 0; |
| 2007 | } |
| 2008 | } |
| 2009 | |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 2010 | SymbolID getSymbol() const { return Sym; } |
| 2011 | |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2012 | virtual PathDiagnosticPiece* getEndPath(BugReporter& BR, |
| 2013 | ExplodedNode<ValueState>* N); |
| 2014 | |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 2015 | virtual std::pair<const char**,const char**> getExtraDescriptiveText(); |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2016 | |
| 2017 | virtual PathDiagnosticPiece* VisitNode(ExplodedNode<ValueState>* N, |
| 2018 | ExplodedNode<ValueState>* PrevN, |
| 2019 | ExplodedGraph<ValueState>& G, |
| 2020 | BugReporter& BR); |
| 2021 | }; |
| 2022 | |
| 2023 | |
| 2024 | } // end anonymous namespace |
| 2025 | |
| 2026 | void CFRefCount::RegisterChecks(GRExprEngine& Eng) { |
Ted Kremenek | 2f62f35 | 2008-05-02 18:01:49 +0000 | [diff] [blame] | 2027 | if (EmitStandardWarnings) GRSimpleVals::RegisterChecks(Eng); |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2028 | Eng.Register(new UseAfterRelease(*this)); |
| 2029 | Eng.Register(new BadRelease(*this)); |
| 2030 | Eng.Register(new Leak(*this)); |
| 2031 | } |
| 2032 | |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 2033 | |
| 2034 | static const char* Msgs[] = { |
| 2035 | "Code is compiled in garbage collection only mode" // GC only |
| 2036 | " (the bug occurs with garbage collection enabled).", |
| 2037 | |
| 2038 | "Code is compiled without garbage collection.", // No GC. |
| 2039 | |
| 2040 | "Code is compiled for use with and without garbage collection (GC)." |
| 2041 | " The bug occurs with GC enabled.", // Hybrid, with GC. |
| 2042 | |
| 2043 | "Code is compiled for use with and without garbage collection (GC)." |
| 2044 | " The bug occurs in non-GC mode." // Hyrbird, without GC/ |
| 2045 | }; |
| 2046 | |
| 2047 | std::pair<const char**,const char**> CFRefReport::getExtraDescriptiveText() { |
| 2048 | CFRefCount& TF = static_cast<CFRefBug&>(getBugType()).getTF(); |
| 2049 | |
| 2050 | switch (TF.getLangOptions().getGCMode()) { |
| 2051 | default: |
| 2052 | assert(false); |
Ted Kremenek | cb470940 | 2008-05-01 04:02:04 +0000 | [diff] [blame] | 2053 | |
| 2054 | case LangOptions::GCOnly: |
| 2055 | assert (TF.isGCEnabled()); |
| 2056 | return std::make_pair(&Msgs[0], &Msgs[0]+1); |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 2057 | |
| 2058 | case LangOptions::NonGC: |
| 2059 | assert (!TF.isGCEnabled()); |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 2060 | return std::make_pair(&Msgs[1], &Msgs[1]+1); |
| 2061 | |
| 2062 | case LangOptions::HybridGC: |
| 2063 | if (TF.isGCEnabled()) |
| 2064 | return std::make_pair(&Msgs[2], &Msgs[2]+1); |
| 2065 | else |
| 2066 | return std::make_pair(&Msgs[3], &Msgs[3]+1); |
| 2067 | } |
| 2068 | } |
| 2069 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2070 | PathDiagnosticPiece* CFRefReport::VisitNode(ExplodedNode<ValueState>* N, |
| 2071 | ExplodedNode<ValueState>* PrevN, |
| 2072 | ExplodedGraph<ValueState>& G, |
| 2073 | BugReporter& BR) { |
| 2074 | |
| 2075 | // Check if the type state has changed. |
| 2076 | |
| 2077 | ValueState* PrevSt = PrevN->getState(); |
| 2078 | ValueState* CurrSt = N->getState(); |
| 2079 | |
| 2080 | CFRefCount::RefBindings PrevB = CFRefCount::GetRefBindings(*PrevSt); |
| 2081 | CFRefCount::RefBindings CurrB = CFRefCount::GetRefBindings(*CurrSt); |
| 2082 | |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2083 | CFRefCount::RefBindings::TreeTy* PrevT = PrevB.SlimFind(Sym); |
| 2084 | CFRefCount::RefBindings::TreeTy* CurrT = CurrB.SlimFind(Sym); |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2085 | |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2086 | if (!CurrT) |
| 2087 | return NULL; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2088 | |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2089 | const char* Msg = NULL; |
| 2090 | RefVal CurrV = CurrB.SlimFind(Sym)->getValue().second; |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2091 | |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2092 | if (!PrevT) { |
| 2093 | |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2094 | Stmt* S = cast<PostStmt>(N->getLocation()).getStmt(); |
| 2095 | |
| 2096 | if (CurrV.isOwned()) { |
| 2097 | |
| 2098 | if (isa<CallExpr>(S)) |
| 2099 | Msg = "Function call returns an object with a +1 retain count" |
| 2100 | " (owning reference)."; |
| 2101 | else { |
| 2102 | assert (isa<ObjCMessageExpr>(S)); |
| 2103 | Msg = "Method returns an object with a +1 retain count" |
| 2104 | " (owning reference)."; |
| 2105 | } |
| 2106 | } |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2107 | else { |
| 2108 | assert (CurrV.isNotOwned()); |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2109 | |
| 2110 | if (isa<CallExpr>(S)) |
| 2111 | Msg = "Function call returns an object with a +0 retain count" |
| 2112 | " (non-owning reference)."; |
| 2113 | else { |
| 2114 | assert (isa<ObjCMessageExpr>(S)); |
| 2115 | Msg = "Method returns an object with a +0 retain count" |
| 2116 | " (non-owning reference)."; |
| 2117 | } |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2118 | } |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2119 | |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2120 | FullSourceLoc Pos(S->getLocStart(), BR.getContext().getSourceManager()); |
| 2121 | PathDiagnosticPiece* P = new PathDiagnosticPiece(Pos, Msg); |
| 2122 | |
| 2123 | if (Expr* Exp = dyn_cast<Expr>(S)) |
| 2124 | P->addRange(Exp->getSourceRange()); |
| 2125 | |
| 2126 | return P; |
| 2127 | } |
| 2128 | |
| 2129 | // Determine if the typestate has changed. |
| 2130 | |
| 2131 | RefVal PrevV = PrevB.SlimFind(Sym)->getValue().second; |
| 2132 | |
| 2133 | if (PrevV == CurrV) |
| 2134 | return NULL; |
| 2135 | |
| 2136 | // The typestate has changed. |
| 2137 | |
| 2138 | std::ostringstream os; |
| 2139 | |
| 2140 | switch (CurrV.getKind()) { |
| 2141 | case RefVal::Owned: |
| 2142 | case RefVal::NotOwned: |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 2143 | |
| 2144 | if (PrevV.getCount() == CurrV.getCount()) |
| 2145 | return 0; |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2146 | |
| 2147 | if (PrevV.getCount() > CurrV.getCount()) |
| 2148 | os << "Reference count decremented."; |
| 2149 | else |
| 2150 | os << "Reference count incremented."; |
| 2151 | |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 2152 | if (unsigned Count = CurrV.getCount()) { |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2153 | |
| 2154 | os << " Object has +" << Count; |
Ted Kremenek | 752b584 | 2008-04-18 05:32:44 +0000 | [diff] [blame] | 2155 | |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2156 | if (Count > 1) |
| 2157 | os << " retain counts."; |
Ted Kremenek | 752b584 | 2008-04-18 05:32:44 +0000 | [diff] [blame] | 2158 | else |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2159 | os << " retain count."; |
Ted Kremenek | 752b584 | 2008-04-18 05:32:44 +0000 | [diff] [blame] | 2160 | } |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2161 | |
| 2162 | Msg = os.str().c_str(); |
| 2163 | |
| 2164 | break; |
| 2165 | |
| 2166 | case RefVal::Released: |
| 2167 | Msg = "Object released."; |
| 2168 | break; |
| 2169 | |
| 2170 | case RefVal::ReturnedOwned: |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2171 | Msg = "Object returned to caller as owning reference (single retain count" |
| 2172 | " transferred to caller)."; |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2173 | break; |
| 2174 | |
| 2175 | case RefVal::ReturnedNotOwned: |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2176 | Msg = "Object returned to caller with a +0 (non-owning) retain count."; |
Ted Kremenek | a850395 | 2008-04-18 04:55:01 +0000 | [diff] [blame] | 2177 | break; |
| 2178 | |
| 2179 | default: |
| 2180 | return NULL; |
| 2181 | } |
| 2182 | |
| 2183 | Stmt* S = cast<PostStmt>(N->getLocation()).getStmt(); |
| 2184 | FullSourceLoc Pos(S->getLocStart(), BR.getContext().getSourceManager()); |
| 2185 | PathDiagnosticPiece* P = new PathDiagnosticPiece(Pos, Msg); |
| 2186 | |
| 2187 | // Add the range by scanning the children of the statement for any bindings |
| 2188 | // to Sym. |
| 2189 | |
| 2190 | ValueStateManager& VSM = BR.getEngine().getStateManager(); |
| 2191 | |
| 2192 | for (Stmt::child_iterator I = S->child_begin(), E = S->child_end(); I!=E; ++I) |
| 2193 | if (Expr* Exp = dyn_cast_or_null<Expr>(*I)) { |
| 2194 | RVal X = VSM.GetRVal(CurrSt, Exp); |
| 2195 | |
| 2196 | if (lval::SymbolVal* SV = dyn_cast<lval::SymbolVal>(&X)) |
| 2197 | if (SV->getSymbol() == Sym) { |
| 2198 | P->addRange(Exp->getSourceRange()); break; |
| 2199 | } |
| 2200 | } |
| 2201 | |
| 2202 | return P; |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2203 | } |
| 2204 | |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 2205 | static std::pair<ExplodedNode<ValueState>*,VarDecl*> |
| 2206 | GetAllocationSite(ExplodedNode<ValueState>* N, SymbolID Sym) { |
| 2207 | |
| 2208 | typedef CFRefCount::RefBindings RefBindings; |
| 2209 | ExplodedNode<ValueState>* Last = N; |
| 2210 | |
| 2211 | // Find the first node that referred to the tracked symbol. We also |
| 2212 | // try and find the first VarDecl the value was stored to. |
| 2213 | |
| 2214 | VarDecl* FirstDecl = 0; |
| 2215 | |
| 2216 | while (N) { |
| 2217 | ValueState* St = N->getState(); |
| 2218 | RefBindings B = RefBindings((RefBindings::TreeTy*) St->CheckerState); |
| 2219 | RefBindings::TreeTy* T = B.SlimFind(Sym); |
| 2220 | |
| 2221 | if (!T) |
| 2222 | break; |
| 2223 | |
| 2224 | VarDecl* VD = 0; |
| 2225 | |
| 2226 | // Determine if there is an LVal binding to the symbol. |
| 2227 | for (ValueState::vb_iterator I=St->vb_begin(), E=St->vb_end(); I!=E; ++I) { |
| 2228 | if (!isa<lval::SymbolVal>(I->second) // Is the value a symbol? |
| 2229 | || cast<lval::SymbolVal>(I->second).getSymbol() != Sym) |
| 2230 | continue; |
| 2231 | |
| 2232 | if (VD) { // Multiple decls map to this symbol. |
| 2233 | VD = 0; |
| 2234 | break; |
| 2235 | } |
| 2236 | |
| 2237 | VD = I->first; |
| 2238 | } |
| 2239 | |
| 2240 | if (VD) FirstDecl = VD; |
| 2241 | |
| 2242 | Last = N; |
| 2243 | N = N->pred_empty() ? NULL : *(N->pred_begin()); |
| 2244 | } |
| 2245 | |
| 2246 | return std::make_pair(Last, FirstDecl); |
| 2247 | } |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2248 | |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2249 | PathDiagnosticPiece* CFRefReport::getEndPath(BugReporter& BR, |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2250 | ExplodedNode<ValueState>* EndN) { |
Ted Kremenek | 8695365 | 2008-05-22 23:45:19 +0000 | [diff] [blame] | 2251 | |
| 2252 | // Tell the BugReporter to report cases when the tracked symbol is |
| 2253 | // assigned to different variables, etc. |
| 2254 | BR.addNotableSymbol(Sym); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2255 | |
| 2256 | if (!getBugType().isLeak()) |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2257 | return RangedBugReport::getEndPath(BR, EndN); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2258 | |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2259 | typedef CFRefCount::RefBindings RefBindings; |
| 2260 | |
| 2261 | // Get the retain count. |
| 2262 | unsigned long RetCount = 0; |
| 2263 | |
| 2264 | { |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2265 | ValueState* St = EndN->getState(); |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2266 | RefBindings B = RefBindings((RefBindings::TreeTy*) St->CheckerState); |
| 2267 | RefBindings::TreeTy* T = B.SlimFind(Sym); |
| 2268 | assert (T); |
Ted Kremenek | a3f30dd | 2008-05-22 17:31:13 +0000 | [diff] [blame] | 2269 | RetCount = T->getValue().second.getCount(); |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2270 | } |
| 2271 | |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2272 | // We are a leak. Walk up the graph to get to the first node where the |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 2273 | // symbol appeared, and also get the first VarDecl that tracked object |
| 2274 | // is stored to. |
| 2275 | |
| 2276 | ExplodedNode<ValueState>* AllocNode = 0; |
Ted Kremenek | 198cae0 | 2008-05-02 20:53:50 +0000 | [diff] [blame] | 2277 | VarDecl* FirstDecl = 0; |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 2278 | llvm::tie(AllocNode, FirstDecl) = GetAllocationSite(EndN, Sym); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2279 | |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 2280 | // Get the allocate site. |
| 2281 | assert (AllocNode); |
| 2282 | Stmt* FirstStmt = cast<PostStmt>(AllocNode->getLocation()).getStmt(); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2283 | |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2284 | SourceManager& SMgr = BR.getContext().getSourceManager(); |
| 2285 | unsigned AllocLine = SMgr.getLogicalLineNumber(FirstStmt->getLocStart()); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2286 | |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2287 | // Get the leak site. We may have multiple ExplodedNodes (one with the |
| 2288 | // leak) that occur on the same line number; if the node with the leak |
| 2289 | // has any immediate predecessor nodes with the same line number, find |
| 2290 | // any transitive-successors that have a different statement and use that |
| 2291 | // line number instead. This avoids emiting a diagnostic like: |
| 2292 | // |
| 2293 | // // 'y' is leaked. |
| 2294 | // int x = foo(y); |
| 2295 | // |
| 2296 | // instead we want: |
| 2297 | // |
| 2298 | // int x = foo(y); |
| 2299 | // // 'y' is leaked. |
| 2300 | |
| 2301 | Stmt* S = getStmt(BR); // This is the statement where the leak occured. |
| 2302 | assert (S); |
| 2303 | unsigned EndLine = SMgr.getLogicalLineNumber(S->getLocStart()); |
| 2304 | |
| 2305 | // Look in the *trimmed* graph at the immediate predecessor of EndN. Does |
| 2306 | // it occur on the same line? |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2307 | |
| 2308 | PathDiagnosticPiece::DisplayHint Hint = PathDiagnosticPiece::Above; |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2309 | |
| 2310 | assert (!EndN->pred_empty()); // Not possible to have 0 predecessors. |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2311 | ExplodedNode<ValueState> *Pred = *(EndN->pred_begin()); |
| 2312 | ProgramPoint PredPos = Pred->getLocation(); |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2313 | |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2314 | if (PostStmt* PredPS = dyn_cast<PostStmt>(&PredPos)) { |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2315 | |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2316 | Stmt* SPred = PredPS->getStmt(); |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2317 | |
| 2318 | // Predecessor at same line? |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2319 | if (SMgr.getLogicalLineNumber(SPred->getLocStart()) != EndLine) { |
| 2320 | Hint = PathDiagnosticPiece::Below; |
| 2321 | S = SPred; |
| 2322 | } |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2323 | } |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2324 | |
| 2325 | // Generate the diagnostic. |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2326 | FullSourceLoc L( S->getLocStart(), SMgr); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2327 | std::ostringstream os; |
Ted Kremenek | 198cae0 | 2008-05-02 20:53:50 +0000 | [diff] [blame] | 2328 | |
Ted Kremenek | ea794e9 | 2008-05-05 18:50:19 +0000 | [diff] [blame] | 2329 | os << "Object allocated on line " << AllocLine; |
Ted Kremenek | 198cae0 | 2008-05-02 20:53:50 +0000 | [diff] [blame] | 2330 | |
| 2331 | if (FirstDecl) |
| 2332 | os << " and stored into '" << FirstDecl->getName() << '\''; |
| 2333 | |
Ted Kremenek | 9363fd9 | 2008-05-05 17:53:17 +0000 | [diff] [blame] | 2334 | os << " is no longer referenced after this point and has a retain count of +" |
| 2335 | << RetCount << " (object leaked)."; |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2336 | |
Ted Kremenek | 4c47932 | 2008-05-06 23:07:13 +0000 | [diff] [blame] | 2337 | return new PathDiagnosticPiece(L, os.str(), Hint); |
Ted Kremenek | fe4d231 | 2008-05-01 23:13:35 +0000 | [diff] [blame] | 2338 | } |
| 2339 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 2340 | void UseAfterRelease::EmitWarnings(BugReporter& BR) { |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 2341 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 2342 | for (CFRefCount::use_after_iterator I = TF.use_after_begin(), |
| 2343 | E = TF.use_after_end(); I != E; ++I) { |
| 2344 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2345 | CFRefReport report(*this, I->first, I->second.second); |
| 2346 | report.addRange(I->second.first->getSourceRange()); |
Ted Kremenek | 270ab7d | 2008-04-18 01:56:37 +0000 | [diff] [blame] | 2347 | BR.EmitWarning(report); |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 2348 | } |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 2349 | } |
| 2350 | |
| 2351 | void BadRelease::EmitWarnings(BugReporter& BR) { |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 2352 | |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 2353 | for (CFRefCount::bad_release_iterator I = TF.bad_release_begin(), |
| 2354 | E = TF.bad_release_end(); I != E; ++I) { |
| 2355 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2356 | CFRefReport report(*this, I->first, I->second.second); |
| 2357 | report.addRange(I->second.first->getSourceRange()); |
| 2358 | BR.EmitWarning(report); |
Ted Kremenek | 7d421f3 | 2008-04-09 23:49:11 +0000 | [diff] [blame] | 2359 | } |
| 2360 | } |
Ted Kremenek | 10fe66d | 2008-04-09 01:10:13 +0000 | [diff] [blame] | 2361 | |
Ted Kremenek | 7f3f41a | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 2362 | void Leak::EmitWarnings(BugReporter& BR) { |
| 2363 | |
| 2364 | for (CFRefCount::leaks_iterator I = TF.leaks_begin(), |
| 2365 | E = TF.leaks_end(); I != E; ++I) { |
| 2366 | |
Ted Kremenek | 2be7ddb | 2008-04-18 03:39:05 +0000 | [diff] [blame] | 2367 | std::vector<SymbolID>& SymV = *(I->second); |
| 2368 | unsigned n = SymV.size(); |
| 2369 | |
| 2370 | for (unsigned i = 0; i < n; ++i) { |
| 2371 | CFRefReport report(*this, I->first, SymV[i]); |
| 2372 | BR.EmitWarning(report); |
| 2373 | } |
Ted Kremenek | 7f3f41a | 2008-04-17 23:43:50 +0000 | [diff] [blame] | 2374 | } |
| 2375 | } |
| 2376 | |
Ted Kremenek | eef8f1e | 2008-04-18 19:23:43 +0000 | [diff] [blame] | 2377 | void Leak::GetErrorNodes(std::vector<ExplodedNode<ValueState>*>& Nodes) { |
| 2378 | for (CFRefCount::leaks_iterator I=TF.leaks_begin(), E=TF.leaks_end(); |
| 2379 | I!=E; ++I) |
| 2380 | Nodes.push_back(I->first); |
| 2381 | } |
| 2382 | |
Ted Kremenek | d7e2678 | 2008-05-16 18:33:44 +0000 | [diff] [blame] | 2383 | bool Leak::isCached(BugReport& R) { |
| 2384 | |
| 2385 | // Most bug reports are cached at the location where they occured. |
| 2386 | // With leaks, we want to unique them by the location where they were |
| 2387 | // allocated, and only report only a single path. |
| 2388 | |
| 2389 | SymbolID Sym = static_cast<CFRefReport&>(R).getSymbol(); |
| 2390 | |
| 2391 | ExplodedNode<ValueState>* AllocNode = |
| 2392 | GetAllocationSite(R.getEndNode(), Sym).first; |
| 2393 | |
| 2394 | if (!AllocNode) |
| 2395 | return false; |
| 2396 | |
| 2397 | return BugTypeCacheLocation::isCached(AllocNode->getLocation()); |
| 2398 | } |
| 2399 | |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 2400 | //===----------------------------------------------------------------------===// |
Ted Kremenek | b1983ba | 2008-04-10 22:16:52 +0000 | [diff] [blame] | 2401 | // Transfer function creation for external clients. |
Ted Kremenek | a7338b4 | 2008-03-11 06:39:11 +0000 | [diff] [blame] | 2402 | //===----------------------------------------------------------------------===// |
| 2403 | |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 2404 | GRTransferFuncs* clang::MakeCFRefCountTF(ASTContext& Ctx, bool GCEnabled, |
Ted Kremenek | 2f62f35 | 2008-05-02 18:01:49 +0000 | [diff] [blame] | 2405 | bool StandardWarnings, |
Ted Kremenek | fe30beb | 2008-04-30 23:47:44 +0000 | [diff] [blame] | 2406 | const LangOptions& lopts) { |
Ted Kremenek | 2f62f35 | 2008-05-02 18:01:49 +0000 | [diff] [blame] | 2407 | return new CFRefCount(Ctx, GCEnabled, StandardWarnings, lopts); |
Ted Kremenek | a4c7429 | 2008-04-10 22:58:08 +0000 | [diff] [blame] | 2408 | } |