retain-release.mm revision 84e480447a20a8a5ed9ee561c8901475f0a4fd9c 
1// RUN: %clang_cc1 -triple x86_64-apple-darwin10 -analyze -analyzer-checker=core,osx.coreFoundation.CFRetainRelease,osx.cocoa.ClassRelease,osx.cocoa.RetainCount -analyzer-store=region -fblocks -verify %s
2
3#if __has_feature(attribute_ns_returns_retained)
4#define NS_RETURNS_RETAINED __attribute__((ns_returns_retained))
5#endif
6#if __has_feature(attribute_cf_returns_retained)
7#define CF_RETURNS_RETAINED __attribute__((cf_returns_retained))
8#endif
9#if __has_feature(attribute_ns_returns_not_retained)
10#define NS_RETURNS_NOT_RETAINED __attribute__((ns_returns_not_retained))
11#endif
12#if __has_feature(attribute_cf_returns_not_retained)
13#define CF_RETURNS_NOT_RETAINED __attribute__((cf_returns_not_retained))
14#endif
15#if __has_feature(attribute_ns_consumes_self)
16#define NS_CONSUMES_SELF __attribute__((ns_consumes_self))
17#endif
18#if __has_feature(attribute_ns_consumed)
19#define NS_CONSUMED __attribute__((ns_consumed))
20#endif
21#if __has_feature(attribute_cf_consumed)
22#define CF_CONSUMED __attribute__((cf_consumed))
23#endif
24
25//===----------------------------------------------------------------------===//
26// The following code is reduced using delta-debugging from Mac OS X headers:
27//
28// #include <Cocoa/Cocoa.h>
29// #include <CoreFoundation/CoreFoundation.h>
30// #include <DiskArbitration/DiskArbitration.h>
31// #include <QuartzCore/QuartzCore.h>
32// #include <Quartz/Quartz.h>
33// #include <IOKit/IOKitLib.h>
34//
35// It includes the basic definitions for the test cases below.
36//===----------------------------------------------------------------------===//
37
38typedef unsigned int __darwin_natural_t;
39typedef unsigned long uintptr_t;
40typedef unsigned int uint32_t;
41typedef unsigned long long uint64_t;
42typedef unsigned int UInt32;
43typedef signed long CFIndex;
44typedef struct {
45    CFIndex location;
46    CFIndex length;
47} CFRange;
48static __inline__ __attribute__((always_inline)) CFRange CFRangeMake(CFIndex loc, CFIndex len) {
49    CFRange range;
50    range.location = loc;
51    range.length = len;
52    return range;
53}
54typedef const void * CFTypeRef;
55typedef const struct __CFString * CFStringRef;
56typedef const struct __CFAllocator * CFAllocatorRef;
57extern const CFAllocatorRef kCFAllocatorDefault;
58extern CFTypeRef CFRetain(CFTypeRef cf);
59extern void CFRelease(CFTypeRef cf);
60typedef struct {
61}
62CFArrayCallBacks;
63extern const CFArrayCallBacks kCFTypeArrayCallBacks;
64typedef const struct __CFArray * CFArrayRef;
65typedef struct __CFArray * CFMutableArrayRef;
66extern CFMutableArrayRef CFArrayCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFArrayCallBacks *callBacks);
67void abort(void) __attribute__((noreturn));
68CFArrayRef CFArrayCreate(CFAllocatorRef allocator, const void **values, CFIndex numValues, const CFArrayCallBacks *callBacks);
69extern const void *CFArrayGetValueAtIndex(CFArrayRef theArray, CFIndex idx);
70extern void CFArrayAppendValue(CFMutableArrayRef theArray, const void *value);
71typedef struct {
72}
73CFDictionaryKeyCallBacks;
74extern const CFDictionaryKeyCallBacks kCFTypeDictionaryKeyCallBacks;
75typedef struct {
76}
77CFDictionaryValueCallBacks;
78extern const CFDictionaryValueCallBacks kCFTypeDictionaryValueCallBacks;
79typedef const struct __CFDictionary * CFDictionaryRef;
80typedef struct __CFDictionary * CFMutableDictionaryRef;
81extern CFMutableDictionaryRef CFDictionaryCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFDictionaryKeyCallBacks *keyCallBacks, const CFDictionaryValueCallBacks *valueCallBacks);
82typedef UInt32 CFStringEncoding;
83enum {
84kCFStringEncodingMacRoman = 0,     kCFStringEncodingWindowsLatin1 = 0x0500,     kCFStringEncodingISOLatin1 = 0x0201,     kCFStringEncodingNextStepLatin = 0x0B01,     kCFStringEncodingASCII = 0x0600,     kCFStringEncodingUnicode = 0x0100,     kCFStringEncodingUTF8 = 0x08000100,     kCFStringEncodingNonLossyASCII = 0x0BFF      ,     kCFStringEncodingUTF16 = 0x0100,     kCFStringEncodingUTF16BE = 0x10000100,     kCFStringEncodingUTF16LE = 0x14000100,      kCFStringEncodingUTF32 = 0x0c000100,     kCFStringEncodingUTF32BE = 0x18000100,     kCFStringEncodingUTF32LE = 0x1c000100  };
85extern CFStringRef CFStringCreateWithCString(CFAllocatorRef alloc, const char *cStr, CFStringEncoding encoding);
86typedef double CFTimeInterval;
87typedef CFTimeInterval CFAbsoluteTime;
88extern CFAbsoluteTime CFAbsoluteTimeGetCurrent(void);
89typedef const struct __CFDate * CFDateRef;
90extern CFDateRef CFDateCreate(CFAllocatorRef allocator, CFAbsoluteTime at);
91extern CFAbsoluteTime CFDateGetAbsoluteTime(CFDateRef theDate);
92typedef __darwin_natural_t natural_t;
93typedef natural_t mach_port_name_t;
94typedef mach_port_name_t mach_port_t;
95typedef int kern_return_t;
96typedef kern_return_t mach_error_t;
97enum {
98kCFNumberSInt8Type = 1,     kCFNumberSInt16Type = 2,     kCFNumberSInt32Type = 3,     kCFNumberSInt64Type = 4,     kCFNumberFloat32Type = 5,     kCFNumberFloat64Type = 6,      kCFNumberCharType = 7,     kCFNumberShortType = 8,     kCFNumberIntType = 9,     kCFNumberLongType = 10,     kCFNumberLongLongType = 11,     kCFNumberFloatType = 12,     kCFNumberDoubleType = 13,      kCFNumberCFIndexType = 14,      kCFNumberNSIntegerType = 15,     kCFNumberCGFloatType = 16,     kCFNumberMaxType = 16    };
99typedef CFIndex CFNumberType;
100typedef const struct __CFNumber * CFNumberRef;
101extern CFNumberRef CFNumberCreate(CFAllocatorRef allocator, CFNumberType theType, const void *valuePtr);
102typedef const struct __CFAttributedString *CFAttributedStringRef;
103typedef struct __CFAttributedString *CFMutableAttributedStringRef;
104extern CFAttributedStringRef CFAttributedStringCreate(CFAllocatorRef alloc, CFStringRef str, CFDictionaryRef attributes) ;
105extern CFMutableAttributedStringRef CFAttributedStringCreateMutableCopy(CFAllocatorRef alloc, CFIndex maxLength, CFAttributedStringRef aStr) ;
106extern void CFAttributedStringSetAttribute(CFMutableAttributedStringRef aStr, CFRange range, CFStringRef attrName, CFTypeRef value) ;
107typedef signed char BOOL;
108typedef unsigned long NSUInteger;
109@class NSString, Protocol;
110extern void NSLog(NSString *format, ...) __attribute__((format(__NSString__, 1, 2)));
111typedef struct _NSZone NSZone;
112@class NSInvocation, NSMethodSignature, NSCoder, NSString, NSEnumerator;
113@protocol NSObject
114- (BOOL)isEqual:(id)object;
115- (id)retain;
116- (id)copy;
117- (oneway void)release;
118- (id)autorelease;
119@end  @protocol NSCopying  - (id)copyWithZone:(NSZone *)zone;
120@end  @protocol NSMutableCopying  - (id)mutableCopyWithZone:(NSZone *)zone;
121@end  @protocol NSCoding  - (void)encodeWithCoder:(NSCoder *)aCoder;
122@end
123@interface NSObject <NSObject> {}
124+ (id)allocWithZone:(NSZone *)zone;
125+ (id)alloc;
126- (void)dealloc;
127- (id)init;
128@end
129@interface NSObject (NSCoderMethods)
130- (id)awakeAfterUsingCoder:(NSCoder *)aDecoder;
131@end
132extern id NSAllocateObject(Class aClass, NSUInteger extraBytes, NSZone *zone);
133typedef struct {
134}
135NSFastEnumerationState;
136@protocol NSFastEnumeration  - (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state objects:(id *)stackbuf count:(NSUInteger)len;
137@end           @class NSString, NSDictionary;
138@interface NSValue : NSObject <NSCopying, NSCoding>  - (void)getValue:(void *)value;
139@end  @interface NSNumber : NSValue  - (char)charValue;
140- (id)initWithInt:(int)value;
141@end   @class NSString;
142@interface NSArray : NSObject <NSCopying, NSMutableCopying, NSCoding, NSFastEnumeration>  - (NSUInteger)count;
143@end  @interface NSArray (NSArrayCreation)  + (id)array;
144@end       @interface NSAutoreleasePool : NSObject {
145}
146- (void)drain;
147@end extern NSString * const NSBundleDidLoadNotification;
148typedef double NSTimeInterval;
149@interface NSDate : NSObject <NSCopying, NSCoding>  - (NSTimeInterval)timeIntervalSinceReferenceDate;
150@end            typedef unsigned short unichar;
151@interface NSString : NSObject <NSCopying, NSMutableCopying, NSCoding>    - (NSUInteger)length;
152- ( const char *)UTF8String;
153- (id)initWithUTF8String:(const char *)nullTerminatedCString;
154+ (id)stringWithUTF8String:(const char *)nullTerminatedCString;
155@end        @class NSString, NSURL, NSError;
156@interface NSData : NSObject <NSCopying, NSMutableCopying, NSCoding>  - (NSUInteger)length;
157+ (id)dataWithBytesNoCopy:(void *)bytes length:(NSUInteger)length;
158+ (id)dataWithBytesNoCopy:(void *)bytes length:(NSUInteger)length freeWhenDone:(BOOL)b;
159@end   @class NSLocale, NSDate, NSCalendar, NSTimeZone, NSError, NSArray, NSMutableDictionary;
160@interface NSDictionary : NSObject <NSCopying, NSMutableCopying, NSCoding, NSFastEnumeration>  - (NSUInteger)count;
161@end    @interface NSMutableDictionary : NSDictionary  - (void)removeObjectForKey:(id)aKey;
162- (void)setObject:(id)anObject forKey:(id)aKey;
163@end  @interface NSMutableDictionary (NSMutableDictionaryCreation)  + (id)dictionaryWithCapacity:(NSUInteger)numItems;
164@end  typedef double CGFloat;
165struct CGSize {
166};
167typedef struct CGSize CGSize;
168struct CGRect {
169};
170typedef struct CGRect CGRect;
171typedef mach_port_t io_object_t;
172typedef char io_name_t[128];
173typedef io_object_t io_iterator_t;
174typedef io_object_t io_service_t;
175typedef struct IONotificationPort * IONotificationPortRef;
176typedef void (*IOServiceMatchingCallback)(  void * refcon,  io_iterator_t iterator );
177io_service_t IOServiceGetMatchingService(  mach_port_t masterPort,  CFDictionaryRef matching );
178kern_return_t IOServiceGetMatchingServices(  mach_port_t masterPort,  CFDictionaryRef matching,  io_iterator_t * existing );
179kern_return_t IOServiceAddNotification(  mach_port_t masterPort,  const io_name_t notificationType,  CFDictionaryRef matching,  mach_port_t wakePort,  uintptr_t reference,  io_iterator_t * notification ) __attribute__((deprecated));
180kern_return_t IOServiceAddMatchingNotification(  IONotificationPortRef notifyPort,  const io_name_t notificationType,  CFDictionaryRef matching,         IOServiceMatchingCallback callback,         void * refCon,  io_iterator_t * notification );
181CFMutableDictionaryRef IOServiceMatching(  const char * name );
182CFMutableDictionaryRef IOServiceNameMatching(  const char * name );
183CFMutableDictionaryRef IOBSDNameMatching(  mach_port_t masterPort,  uint32_t options,  const char * bsdName );
184CFMutableDictionaryRef IOOpenFirmwarePathMatching(  mach_port_t masterPort,  uint32_t options,  const char * path );
185CFMutableDictionaryRef IORegistryEntryIDMatching(  uint64_t entryID );
186typedef struct __DASession * DASessionRef;
187extern DASessionRef DASessionCreate( CFAllocatorRef allocator );
188typedef struct __DADisk * DADiskRef;
189extern DADiskRef DADiskCreateFromBSDName( CFAllocatorRef allocator, DASessionRef session, const char * name );
190extern DADiskRef DADiskCreateFromIOMedia( CFAllocatorRef allocator, DASessionRef session, io_service_t media );
191extern CFDictionaryRef DADiskCopyDescription( DADiskRef disk );
192extern DADiskRef DADiskCopyWholeDisk( DADiskRef disk );
193@interface NSTask : NSObject - (id)init;
194@end                    typedef struct CGColorSpace *CGColorSpaceRef;
195typedef struct CGImage *CGImageRef;
196typedef struct CGLayer *CGLayerRef;
197@interface NSResponder : NSObject <NSCoding> {
198}
199@end    @protocol NSAnimatablePropertyContainer      - (id)animator;
200@end  extern NSString *NSAnimationTriggerOrderIn ;
201@interface NSView : NSResponder  <NSAnimatablePropertyContainer>  {
202}
203@end @protocol NSValidatedUserInterfaceItem - (SEL)action;
204@end   @protocol NSUserInterfaceValidations - (BOOL)validateUserInterfaceItem:(id <NSValidatedUserInterfaceItem>)anItem;
205@end  @class NSDate, NSDictionary, NSError, NSException, NSNotification;
206@interface NSApplication : NSResponder <NSUserInterfaceValidations> {
207}
208@end   enum {
209NSTerminateCancel = 0,         NSTerminateNow = 1,         NSTerminateLater = 2 };
210typedef NSUInteger NSApplicationTerminateReply;
211@protocol NSApplicationDelegate <NSObject> @optional        - (NSApplicationTerminateReply)applicationShouldTerminate:(NSApplication *)sender;
212@end  @class NSAttributedString, NSEvent, NSFont, NSFormatter, NSImage, NSMenu, NSText, NSView, NSTextView;
213@interface NSCell : NSObject <NSCopying, NSCoding> {
214}
215@end @class NSTextField, NSPanel, NSArray, NSWindow, NSImage, NSButton, NSError;
216typedef struct {
217}
218CVTimeStamp;
219@interface CIImage : NSObject <NSCoding, NSCopying> {
220}
221typedef int CIFormat;
222@end  enum {
223kDAReturnSuccess = 0,     kDAReturnError = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x01,     kDAReturnBusy = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x02,     kDAReturnBadArgument = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x03,     kDAReturnExclusiveAccess = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x04,     kDAReturnNoResources = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x05,     kDAReturnNotFound = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x06,     kDAReturnNotMounted = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x07,     kDAReturnNotPermitted = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x08,     kDAReturnNotPrivileged = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x09,     kDAReturnNotReady = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x0A,     kDAReturnNotWritable = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x0B,     kDAReturnUnsupported = (((0x3eU)&0x3f)<<26) | (((0x368)&0xfff)<<14) | 0x0C };
224typedef mach_error_t DAReturn;
225typedef const struct __DADissenter * DADissenterRef;
226extern DADissenterRef DADissenterCreate( CFAllocatorRef allocator, DAReturn status, CFStringRef string );
227@interface CIContext: NSObject {
228}
229- (CGImageRef)createCGImage:(CIImage *)im fromRect:(CGRect)r;
230- (CGImageRef)createCGImage:(CIImage *)im fromRect:(CGRect)r     format:(CIFormat)f colorSpace:(CGColorSpaceRef)cs;
231- (CGLayerRef)createCGLayerWithSize:(CGSize)size info:(CFDictionaryRef)d;
232@end extern NSString* const QCRendererEventKey;
233@protocol QCCompositionRenderer - (NSDictionary*) attributes;
234@end   @interface QCRenderer : NSObject <QCCompositionRenderer> {
235}
236- (id) createSnapshotImageOfType:(NSString*)type;
237@end  extern NSString* const QCViewDidStartRenderingNotification;
238@interface QCView : NSView <QCCompositionRenderer> {
239}
240- (id) createSnapshotImageOfType:(NSString*)type;
241@end    enum {
242ICEXIFOrientation1 = 1,     ICEXIFOrientation2 = 2,     ICEXIFOrientation3 = 3,     ICEXIFOrientation4 = 4,     ICEXIFOrientation5 = 5,     ICEXIFOrientation6 = 6,     ICEXIFOrientation7 = 7,     ICEXIFOrientation8 = 8, };
243@class ICDevice;
244@protocol ICDeviceDelegate <NSObject>  @required      - (void)didRemoveDevice:(ICDevice*)device;
245@end extern NSString *const ICScannerStatusWarmingUp;
246@class ICScannerDevice;
247@protocol ICScannerDeviceDelegate <ICDeviceDelegate>  @optional       - (void)scannerDeviceDidBecomeAvailable:(ICScannerDevice*)scanner;
248@end
249
250typedef long unsigned int __darwin_size_t;
251typedef __darwin_size_t size_t;
252typedef unsigned long CFTypeID;
253struct CGPoint {
254  CGFloat x;
255  CGFloat y;
256};
257typedef struct CGPoint CGPoint;
258typedef struct CGGradient *CGGradientRef;
259typedef uint32_t CGGradientDrawingOptions;
260extern CFTypeID CGGradientGetTypeID(void);
261extern CGGradientRef CGGradientCreateWithColorComponents(CGColorSpaceRef
262  space, const CGFloat components[], const CGFloat locations[], size_t count);
263extern CGGradientRef CGGradientCreateWithColors(CGColorSpaceRef space,
264  CFArrayRef colors, const CGFloat locations[]);
265extern CGGradientRef CGGradientRetain(CGGradientRef gradient);
266extern void CGGradientRelease(CGGradientRef gradient);
267typedef struct CGContext *CGContextRef;
268extern void CGContextDrawLinearGradient(CGContextRef context,
269    CGGradientRef gradient, CGPoint startPoint, CGPoint endPoint,
270    CGGradientDrawingOptions options);
271extern CGColorSpaceRef CGColorSpaceCreateDeviceRGB(void);
272
273//===----------------------------------------------------------------------===//
274// Test cases.
275//===----------------------------------------------------------------------===//
276
277class SmartPointer {
278  id x;
279public:
280  SmartPointer(id x) : x(x) {}
281  ~SmartPointer() { [x release]; }
282
283  void adopt(id x);
284  void noAdopt(id x);
285};
286
287void test_positive() {
288  id x = [[NSObject alloc] init]; // expected-warning {{leak}}
289}
290
291void test_smartpointer_1() {
292  id x = [[NSObject alloc] init];  // no-warning
293  SmartPointer foo(x);
294}
295
296void test_smartpointer_2() {
297  id x = [[NSObject alloc] init];  // no-warning
298  SmartPointer foo(0);
299  foo.adopt(x);
300}
301
302// FIXME: Eventually we want annotations to say whether or not
303// a C++ method claims ownership of an Objective-C object.
304void test_smartpointer_3() {
305  id x = [[NSObject alloc] init];  // no-warning
306  SmartPointer foo(0);
307  foo.noAdopt(x);
308}
309
310void test_smartpointer_4() {
311  id x = [[NSObject alloc] init];  // no-warning
312  SmartPointer *foo = new SmartPointer(x);
313  delete foo;
314}
315
316extern CFStringRef ElectronMicroscopyEngage(void);
317void test_microscopy() {
318  NSString *token = (NSString*) ElectronMicroscopyEngage();
319  [token release]; // expected-warning {{object that is not owned}}
320}
321
322extern CFStringRef Scopy(void);
323void test_Scopy() {
324  NSString *token = (NSString*) Scopy();
325  [token release]; // expected-warning {{object that is not owned}}
326}
327
328//===----------------------------------------------------------------------===//
329// Test handling of template functions used to do magic with
330// tracked retained pointers.
331//===----------------------------------------------------------------------===//
332
333template <typename T, typename U> T static_objc_cast(U* value)
334{
335  // ...debugging code omitted...
336  return static_cast<T>(value);
337}
338
339int rdar10553686(void)
340{
341  NSObject* bar = static_objc_cast<NSObject*>([[NSObject alloc] init]);
342  [bar release];
343  return 0;
344}
345int rdar10553686_positive(void)
346{
347  NSObject* bar = static_objc_cast<NSObject*>([[NSObject alloc] init]);
348  [bar release];
349  [bar retain]; // expected-warning {{used after it is released}}
350  return 0;
351}
352
353@interface NSMapTable : NSObject <NSCopying, NSCoding, NSFastEnumeration>
354@end
355extern void *NSMapGet(NSMapTable *table, const void *key);
356extern void NSMapInsert(NSMapTable *table, const void *key, const void *value);
357extern void NSMapInsertKnownAbsent(NSMapTable *table, const void *key, const void *value);
358char *strdup(const char *s);
359
360NSString * radar11152419(NSString *string1, NSString *key1, NSMapTable *map) {
361    NSString *string = ( NSString *)NSMapGet(map, key1);
362    if (!string) {
363        string = [string1 copy];
364        NSString *key = [key1 copy];
365        NSMapInsert(map, (void*) key, (void*)string); // no warning
366        NSMapInsertKnownAbsent(map, (void*)key, (void*)string); // no warning
367    }
368    return string;
369}
370
371//===----------------------------------------------------------------------===//
372// Don't crash on non-member functions with "callbacks" but without names.
373//===----------------------------------------------------------------------===//
374
375struct IntWrapper {
376  int arg;
377};
378
379int operator>> (const IntWrapper &W, int (*f)(int)) {
380  return f(W.arg);
381}
382
383void testCallback() {
384  IntWrapper val = { 42 };
385
386  extern int process(int);
387  val >> process;
388}
389
390//===----------------------------------------------------------------------===//
391// Test handling static initializers.
392//===----------------------------------------------------------------------===//
393
394@interface radar13227740 : NSObject
395@end
396
397@implementation radar13227740
398- (CFArrayRef)test {
399    static CFArrayRef array = ::CFArrayCreate(0, 0, 0, 0);
400    do { if (!((0 != array)/1)) { abort(); } } while (false);
401    return array;
402}
403
404// Previously this reported a bogus leak.
405- (void)test2 {
406    (void)[self test];
407    (void)[self test];
408}
409@end
410
411