Track leaked objects' lift circle

Zepo · Zepo · commit e3d92e39fdba · 2016-07-15T16:42:55.000+08:00
diff --git a/MLeaksFinder.xcodeproj/project.pbxproj b/MLeaksFinder.xcodeproj/project.pbxproj
@@ -7,6 +7,7 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		B3667E4E1D38ADF6002B55DE /* MLeakedObjectProxy.m in Sources */ = {isa = PBXBuildFile; fileRef = B3667E4D1D38ADF6002B55DE /* MLeakedObjectProxy.m */; };
 		B367C8971C1C029500FDA5A9 /* NSObject+MemoryLeak.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = B3ADE17B1C1BD2F000AA4F63 /* NSObject+MemoryLeak.h */; };
 		B3ADE1701C1BD1D600AA4F63 /* MLeaksFinder.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = B3ADE16F1C1BD1D600AA4F63 /* MLeaksFinder.h */; };
 		B3ADE17A1C1BD29600AA4F63 /* UIView+MemoryLeak.m in Sources */ = {isa = PBXBuildFile; fileRef = B3ADE1791C1BD29600AA4F63 /* UIView+MemoryLeak.m */; };
@@ -34,6 +35,8 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		B3667E4C1D38ADF6002B55DE /* MLeakedObjectProxy.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = MLeakedObjectProxy.h; sourceTree = "<group>"; };
+		B3667E4D1D38ADF6002B55DE /* MLeakedObjectProxy.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = MLeakedObjectProxy.m; sourceTree = "<group>"; };
 		B3ADE16C1C1BD1D600AA4F63 /* libMLeaksFinder.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libMLeaksFinder.a; sourceTree = BUILT_PRODUCTS_DIR; };
 		B3ADE16F1C1BD1D600AA4F63 /* MLeaksFinder.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MLeaksFinder.h; sourceTree = "<group>"; };
 		B3ADE1781C1BD29600AA4F63 /* UIView+MemoryLeak.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "UIView+MemoryLeak.h"; sourceTree = "<group>"; };
@@ -84,9 +87,13 @@
 		B3ADE16E1C1BD1D600AA4F63 /* MLeaksFinder */ = {
 			isa = PBXGroup;
 			children = (
+				B3667E4C1D38ADF6002B55DE /* MLeakedObjectProxy.h */,
+				B3667E4D1D38ADF6002B55DE /* MLeakedObjectProxy.m */,
 				B3ADE16F1C1BD1D600AA4F63 /* MLeaksFinder.h */,
 				B3ADE17B1C1BD2F000AA4F63 /* NSObject+MemoryLeak.h */,
 				B3ADE17C1C1BD2F000AA4F63 /* NSObject+MemoryLeak.m */,
+				B3C512C31CE3368B0032C2C8 /* UIApplication+MemoryLeak.h */,
+				B3C512C41CE3368B0032C2C8 /* UIApplication+MemoryLeak.m */,
 				B3ADE1811C1BD54B00AA4F63 /* UINavigationController+MemoryLeak.h */,
 				B3ADE1821C1BD54B00AA4F63 /* UINavigationController+MemoryLeak.m */,
 				B3ADE1841C1BD5CC00AA4F63 /* UIPageViewController+MemoryLeak.h */,
@@ -99,8 +106,6 @@
 				B3ADE1791C1BD29600AA4F63 /* UIView+MemoryLeak.m */,
 				B3ADE17E1C1BD4B200AA4F63 /* UIViewController+MemoryLeak.h */,
 				B3ADE17F1C1BD4B200AA4F63 /* UIViewController+MemoryLeak.m */,
-				B3C512C31CE3368B0032C2C8 /* UIApplication+MemoryLeak.h */,
-				B3C512C41CE3368B0032C2C8 /* UIApplication+MemoryLeak.m */,
 			);
 			path = MLeaksFinder;
 			sourceTree = "<group>";
@@ -164,6 +169,7 @@
 				B3C512C51CE3368B0032C2C8 /* UIApplication+MemoryLeak.m in Sources */,
 				B3ADE17A1C1BD29600AA4F63 /* UIView+MemoryLeak.m in Sources */,
 				B3ADE1861C1BD5CC00AA4F63 /* UIPageViewController+MemoryLeak.m in Sources */,
+				B3667E4E1D38ADF6002B55DE /* MLeakedObjectProxy.m in Sources */,
 				B3ADE17D1C1BD2F000AA4F63 /* NSObject+MemoryLeak.m in Sources */,
 				B3ADE18C1C1BD74700AA4F63 /* UISplitViewController+MemoryLeak.m in Sources */,
 				B3ADE1801C1BD4B200AA4F63 /* UIViewController+MemoryLeak.m in Sources */,
diff --git a/MLeaksFinder/MLeakedObjectProxy.h b/MLeaksFinder/MLeakedObjectProxy.h
@@ -0,0 +1,16 @@
+//
+//  MLeakedObjectProxy.h
+//  MLeaksFinder
+//
+//  Created by 佘泽坡 on 7/15/16.
+//  Copyright © 2016 zeposhe. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface MLeakedObjectProxy : NSObject
+
++ (BOOL)isAnyObjectLeakedAtPtrs:(NSSet *)ptrs;
++ (void)addLeakedObject:(id)object;
+
+@end
diff --git a/MLeaksFinder/MLeakedObjectProxy.m b/MLeaksFinder/MLeakedObjectProxy.m
@@ -0,0 +1,68 @@
+//
+//  MLeakedObjectProxy.m
+//  MLeaksFinder
+//
+//  Created by 佘泽坡 on 7/15/16.
+//  Copyright © 2016 zeposhe. All rights reserved.
+//
+
+#import "MLeakedObjectProxy.h"
+#import "NSObject+MemoryLeak.h"
+#import <objc/runtime.h>
+#import <UIKit/UIKit.h>
+
+static NSMutableSet *leakedObjectPtrs;
+
+@interface MLeakedObjectProxy ()
+@property (nonatomic, weak) id object;
+@property (nonatomic, strong) NSNumber *objectPtr;
+@property (nonatomic, strong) NSArray *viewStack;
+@end
+
+@implementation MLeakedObjectProxy
+
++ (BOOL)isAnyObjectLeakedAtPtrs:(NSSet *)ptrs {
+    static dispatch_once_t onceToken;
+    dispatch_once(&onceToken, ^{
+        leakedObjectPtrs = [[NSMutableSet alloc] init];
+    });
+    
+    if (!ptrs.count) {
+        return NO;
+    }
+    if ([leakedObjectPtrs intersectsSet:ptrs]) {
+        return YES;
+    } else {
+        return NO;
+    }
+}
+
++ (void)addLeakedObject:(id)object {
+    MLeakedObjectProxy *proxy = [[MLeakedObjectProxy alloc] init];
+    proxy.object = object;
+    proxy.objectPtr = @((uintptr_t)object);
+    proxy.viewStack = [object viewStack];
+    static const void *const kLeakedObjectProxyKey = &kLeakedObjectProxyKey;
+    objc_setAssociatedObject(object, kLeakedObjectProxyKey, proxy, OBJC_ASSOCIATION_RETAIN);
+    
+    [leakedObjectPtrs addObject:proxy.objectPtr];
+}
+
+- (void)dealloc {
+    NSNumber *objectPtr = _objectPtr;
+    NSArray *viewStack = _viewStack;
+    dispatch_async(dispatch_get_main_queue(), ^{
+        [leakedObjectPtrs removeObject:objectPtr];
+        
+        UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"Object Deallocated"
+                                                            message:[NSString stringWithFormat:@"%@", viewStack]
+                                                           delegate:nil
+                                                  cancelButtonTitle:@"OK"
+                                                  otherButtonTitles:nil];
+        [alertView show];
+    });
+    
+    NSLog(@"Object deallocated.\nView-ViewController stack: %@", viewStack);
+}
+
+@end
diff --git a/MLeaksFinder/NSObject+MemoryLeak.h b/MLeaksFinder/NSObject+MemoryLeak.h
@@ -15,8 +15,10 @@
 - (BOOL)willDealloc;
 - (void)willReleaseObject:(id)object relationship:(NSString *)relationship;
 
+- (void)willReleaseChild:(id)child;
+- (void)willReleaseChildren:(NSArray *)children;
+
 - (NSArray *)viewStack;
-- (void)setViewStack:(NSArray *)viewStack;
 
 + (void)swizzleSEL:(SEL)originalSEL withSEL:(SEL)swizzledSEL;
 
diff --git a/MLeaksFinder/NSObject+MemoryLeak.m b/MLeaksFinder/NSObject+MemoryLeak.m
@@ -7,11 +7,13 @@
 //
 
 #import "NSObject+MemoryLeak.h"
+#import "MLeakedObjectProxy.h"
 #import "MLeaksFinder.h"
 #import <objc/runtime.h>
 #import <UIKit/UIKit.h>
 
 static const void *const kViewStackKey = &kViewStackKey;
+static const void *const kParentPtrsKey = &kParentPtrsKey;
 const void *const kLatestSenderKey = &kLatestSenderKey;
 
 @implementation NSObject (MemoryLeak)
@@ -27,29 +29,60 @@ - (BOOL)willDealloc {
     
     __weak id weakSelf = self;
     dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(3 * NSEC_PER_SEC)), dispatch_get_main_queue(), ^{
-        [weakSelf assertNotDealloc];
+        __strong id strongSelf = weakSelf;
+        [strongSelf assertNotDealloc];
     });
     
     return YES;
 }
 
+- (void)assertNotDealloc {
+    if ([MLeakedObjectProxy isAnyObjectLeakedAtPtrs:[self parentPtrs]]) {
+        return;
+    }
+    [MLeakedObjectProxy addLeakedObject:self];
+    
+    NSString *className = NSStringFromClass([self class]);
+    NSString *message = [NSString stringWithFormat:@"Possibly Memory Leak.\nIn case that %@ should not be dealloced, override -willDealloc in %@ by returning NO.\nView-ViewController stack: %@", className, className, [self viewStack]];
+    NSLog(@"%@", message);
+    
+    UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"Memory Leak"
+                                                        message:[NSString stringWithFormat:@"%@", [self viewStack]]
+                                                       delegate:nil
+                                              cancelButtonTitle:@"OK"
+                                              otherButtonTitles:nil];
+    [alertView show];
+}
+
 - (void)willReleaseObject:(id)object relationship:(NSString *)relationship {
     if ([relationship hasPrefix:@"self"]) {
         relationship = [relationship stringByReplacingCharactersInRange:NSMakeRange(0, 4) withString:@""];
     }
     NSString *className = NSStringFromClass([object class]);
     className = [NSString stringWithFormat:@"%@(%@), ", relationship, className];
     
-    NSArray *viewStack = [self viewStack];
-    [object setViewStack:[viewStack arrayByAddingObject:className]];
+    [object setViewStack:[[self viewStack] arrayByAddingObject:className]];
+    [object setParentPtrs:[[self parentPtrs] setByAddingObject:@((uintptr_t)self)]];
     [object willDealloc];
 }
 
-- (void)assertNotDealloc {
-    NSString *className = NSStringFromClass([self class]);
-    NSString *message = [NSString stringWithFormat:@"Possibly Memory Leak.\nIn case that %@ should not be dealloced, override -willDealloc in %@ by returning NO.\nView-ViewController stack: %@", className, className, [self viewStack]];
-    NSLog(@"%@", message);
-    NSAssert(NO, message);
+- (void)willReleaseChild:(id)child {
+    if (!child) {
+        return;
+    }
+    
+    [self willReleaseChildren:@[ child ]];
+}
+
+- (void)willReleaseChildren:(NSArray *)children {
+    NSArray *viewStack = [self viewStack];
+    NSSet *parentPtrs = [[self parentPtrs] setByAddingObject:@((uintptr_t)self)];
+    for (id child in children) {
+        NSString *className = NSStringFromClass([child class]);
+        [child setViewStack:[viewStack arrayByAddingObject:className]];
+        [child setParentPtrs:parentPtrs];
+        [child willDealloc];
+    }
 }
 
 - (NSArray *)viewStack {
@@ -66,6 +99,18 @@ - (void)setViewStack:(NSArray *)viewStack {
     objc_setAssociatedObject(self, kViewStackKey, viewStack, OBJC_ASSOCIATION_COPY);
 }
 
+- (NSSet *)parentPtrs {
+    NSSet *parentPtrs = objc_getAssociatedObject(self, kParentPtrsKey);
+    if (!parentPtrs) {
+        parentPtrs = [[NSSet alloc] init];
+    }
+    return parentPtrs;
+}
+
+- (void)setParentPtrs:(NSSet *)parentPtrs {
+    objc_setAssociatedObject(self, kParentPtrsKey, parentPtrs, OBJC_ASSOCIATION_RETAIN);
+}
+
 + (NSSet *)classNamesInWhiteList {
     static NSSet *whiteList;
     static dispatch_once_t onceToken;
diff --git a/MLeaksFinder/UINavigationController+MemoryLeak.m b/MLeaksFinder/UINavigationController+MemoryLeak.m
@@ -41,7 +41,6 @@ - (void)swizzled_pushViewController:(UIViewController *)viewController animated:
 - (UIViewController *)swizzled_popViewControllerAnimated:(BOOL)animated {
     UIViewController *poppedViewController = [self swizzled_popViewControllerAnimated:animated];
     
-    // Navigation VC's rootViewController is the last VC in Navigation VC's viewControllers
     if (!poppedViewController) {
         return nil;
     }
@@ -86,15 +85,7 @@ - (BOOL)willDealloc {
         return NO;
     }
     
-    NSArray *viewStack = [self viewStack];
-    
-    for (UIViewController *viewController in self.viewControllers) {
-        NSString *className = NSStringFromClass([viewController class]);
-        viewStack = [viewStack arrayByAddingObject:className];
-        
-        [viewController setViewStack:viewStack];
-        [viewController willDealloc];
-    }
+    [self willReleaseChildren:self.viewControllers];
     
     return YES;
 }
diff --git a/MLeaksFinder/UIPageViewController+MemoryLeak.m b/MLeaksFinder/UIPageViewController+MemoryLeak.m
@@ -18,13 +18,7 @@ - (BOOL)willDealloc {
         return NO;
     }
     
-    NSArray *viewStack = [self viewStack];
-    
-    for (UIViewController *viewController in self.viewControllers) {
-        NSString *className = NSStringFromClass([viewController class]);
-        [viewController setViewStack:[viewStack arrayByAddingObject:className]];
-        [viewController willDealloc];
-    }
+    [self willReleaseChildren:self.viewControllers];
     
     return YES;
 }
diff --git a/MLeaksFinder/UISplitViewController+MemoryLeak.m b/MLeaksFinder/UISplitViewController+MemoryLeak.m
@@ -18,13 +18,7 @@ - (BOOL)willDealloc {
         return NO;
     }
     
-    NSArray *viewStack = [self viewStack];
-    
-    for (UIViewController *viewController in self.viewControllers) {
-        NSString *className = NSStringFromClass([viewController class]);
-        [viewController setViewStack:[viewStack arrayByAddingObject:className]];
-        [viewController willDealloc];
-    }
+    [self willReleaseChildren:self.viewControllers];
     
     return YES;
 }
diff --git a/MLeaksFinder/UITabBarController+MemoryLeak.m b/MLeaksFinder/UITabBarController+MemoryLeak.m
@@ -18,13 +18,7 @@ - (BOOL)willDealloc {
         return NO;
     }
     
-    NSArray *viewStack = [self viewStack];
-    
-    for (UIViewController *viewController in self.viewControllers) {
-        NSString *className = NSStringFromClass([viewController class]);
-        [viewController setViewStack:[viewStack arrayByAddingObject:className]];
-        [viewController willDealloc];
-    }
+    [self willReleaseChildren:self.viewControllers];
     
     return YES;
 }
diff --git a/MLeaksFinder/UIView+MemoryLeak.m b/MLeaksFinder/UIView+MemoryLeak.m
@@ -18,13 +18,7 @@ - (BOOL)willDealloc {
         return NO;
     }
     
-    NSArray *viewStack = [self viewStack];
-    
-    for (UIView *view in self.subviews) {
-        NSString *className = NSStringFromClass([view class]);
-        [view setViewStack:[viewStack arrayByAddingObject:className]];
-        [view willDealloc];
-    }
+    [self willReleaseChildren:self.subviews];
     
     return YES;
 }
diff --git a/MLeaksFinder/UIViewController+MemoryLeak.m b/MLeaksFinder/UIViewController+MemoryLeak.m
@@ -57,24 +57,9 @@ - (BOOL)willDealloc {
         return NO;
     }
     
-    NSArray *viewStack = [self viewStack];
-    
-    for (UIViewController *viewController in self.childViewControllers) {
-        NSString *className = NSStringFromClass([viewController class]);
-        [viewController setViewStack:[viewStack arrayByAddingObject:className]];
-        [viewController willDealloc];
-    }
-    
-    UIViewController *presentedViewController = self.presentedViewController;
-    if (presentedViewController) {
-        NSString *className = NSStringFromClass([presentedViewController class]);
-        [presentedViewController setViewStack:[viewStack arrayByAddingObject:className]];
-        [presentedViewController willDealloc];
-    }
-    
-    NSString *className = NSStringFromClass([self.view class]);
-    [self.view setViewStack:[viewStack arrayByAddingObject:className]];
-    [self.view willDealloc];
+    [self willReleaseChildren:self.childViewControllers];
+    [self willReleaseChild:self.presentedViewController];
+    [self willReleaseChild:self.view];
     
     return YES;
 }

Original file line number	Diff line number	Diff line change
`@@ -18,13 +18,7 @@ - (BOOL)willDealloc {`
`18`	`18`	`return NO;`
`19`	`19`	`}`
`20`	`20`
`21`		`- NSArray *viewStack = [self viewStack];`
`22`		`-`
`23`		`- for (UIViewController *viewController in self.viewControllers) {`
`24`		`- NSString *className = NSStringFromClass([viewController class]);`
`25`		`- [viewController setViewStack:[viewStack arrayByAddingObject:className]];`
`26`		`- [viewController willDealloc];`
`27`		`- }`
	`21`	`+ [self willReleaseChildren:self.viewControllers];`
`28`	`22`
`29`	`23`	`return YES;`
`30`	`24`	`}`