From 82f2be584e43b2e38583fa0bee7cba85612b98a1 Mon Sep 17 00:00:00 2001
From: Ted Kremenek <kremenek@apple.com>
Date: Sun, 10 May 2009 16:52:15 +0000
Subject: [PATCH] Add special warning about returning a retained object where a
 GC'ed object is expected.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@71397 91177308-0d34-0410-b5e6-96231b3b80d8
---
 lib/Analysis/CFRefCount.cpp            | 12 +++++++-----
 test/Analysis/retain-release-gc-only.m | 10 +++++++---
 2 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/lib/Analysis/CFRefCount.cpp b/lib/Analysis/CFRefCount.cpp
index 2715a9633f..4b254e07d5 100644
--- a/lib/Analysis/CFRefCount.cpp
+++ b/lib/Analysis/CFRefCount.cpp
@@ -2517,9 +2517,10 @@ CFRefLeakReport::getEndPath(BugReporterContext& BRC,
   else if (RV->getKind() == RefVal::ErrorGCLeakReturned) {
     ObjCMethodDecl& MD = cast<ObjCMethodDecl>(BRC.getCodeDecl());
     os << " and returned from method '" << MD.getSelector().getAsString()
-       << "' is potentially leaked when using garbage collection.  Callers"
-          " of this method do not expect a +1 retain count since the return"
-          " type is an Objective-C object reference";
+       << "' is potentially leaked when using garbage collection.  Callers "
+          "of this method do not expect a returned object with a +1 retain "
+          "count since they expect the object to be managed by the garbage "
+          "collector";
   }
   else
     os << " is no longer referenced after this point and has a retain count of"
@@ -3073,11 +3074,12 @@ void CFRefCount::EvalReturn(ExplodedNodeSet<GRState>& Dst,
       if (isGCEnabled() && RE.getObjKind() == RetEffect::ObjC) {
         // Things are more complicated with garbage collection.  If the
         // returned object is suppose to be an Objective-C object, we have
-        // a leak (as the caller expects a GC'ed object).        
+        // a leak (as the caller expects a GC'ed object) because no
+        // method should return ownership unless it returns a CF object.
         X = X ^ RefVal::ErrorGCLeakReturned;
         
         // Keep this false until this is properly tested.
-        hasError = false;
+        hasError = true;
       }
       else if (!RE.isOwned()) {
         // Either we are using GC and the returned object is a CF type
diff --git a/test/Analysis/retain-release-gc-only.m b/test/Analysis/retain-release-gc-only.m
index 5aa39ec0a2..70ad54f8aa 100644
--- a/test/Analysis/retain-release-gc-only.m
+++ b/test/Analysis/retain-release-gc-only.m
@@ -128,13 +128,17 @@ void f3() {
 // is expected.
 @interface TestReturnNotOwnedWhenExpectedOwned
 - (NSString*)newString;
+- (CFMutableArrayRef)newArray;
 @end
 
 @implementation TestReturnNotOwnedWhenExpectedOwned
 - (NSString*)newString {
-  NSString *s = [NSString stringWithUTF8String:"hello"];  
-  // FIXME: Should this be an error anyway?
-  return s; // no-warning
+  NSString *s = [NSString stringWithUTF8String:"hello"]; // expected-warning{{Potential leak (when using garbage collection) of an object allocated on line 136 and stored into 's'}}
+  CFRetain(s);
+  return s;
+}
+- (CFMutableArrayRef)newArray{
+   return CFArrayCreateMutable(0, 10, &kCFTypeArrayCallBacks); // no-warning
 }
 @end
 
-- 
2.40.0