blob: ef9e17d47834a19d2a931fdd7f3eadb779783758 [file] [log] [blame]
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +00001//===--- Checkers.td - Static Analyzer Checkers -===-----------------------===//
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
10include "clang/StaticAnalyzer/Checkers/CheckerBase.td"
11
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000012//===----------------------------------------------------------------------===//
13// Packages.
14//===----------------------------------------------------------------------===//
15
Ted Kremenek3d578132012-08-24 19:46:03 +000016def Alpha : Package<"alpha">;
Ted Kremenek033a07e2011-08-03 23:14:55 +000017
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000018def Core : Package<"core">;
Ted Kremenek51885072011-03-24 00:28:47 +000019def CoreBuiltin : Package<"builtin">, InPackage<Core>;
20def CoreUninitialized : Package<"uninitialized">, InPackage<Core>;
Ted Kremenek3d578132012-08-24 19:46:03 +000021def CoreAlpha : Package<"core">, InPackage<Alpha>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000022
23def Cplusplus : Package<"cplusplus">;
Ted Kremenek3d578132012-08-24 19:46:03 +000024def CplusplusAlpha : Package<"cplusplus">, InPackage<Alpha>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000025
Ted Kremenekade31952011-03-12 06:14:28 +000026def DeadCode : Package<"deadcode">;
Ted Kremenek3d578132012-08-24 19:46:03 +000027def DeadCodeAlpha : Package<"deadcode">, InPackage<Alpha>, Hidden;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000028
Ted Kremenek51885072011-03-24 00:28:47 +000029def Security : Package <"security">;
Ted Kremenek76a54242012-01-20 01:44:29 +000030def InsecureAPI : Package<"insecureAPI">, InPackage<Security>;
Ted Kremenek3d578132012-08-24 19:46:03 +000031def SecurityAlpha : Package<"security">, InPackage<Alpha>, Hidden;
32def Taint : Package<"taint">, InPackage<SecurityAlpha>, Hidden;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000033
Ted Kremenek51885072011-03-24 00:28:47 +000034def Unix : Package<"unix">;
Ted Kremenek3d578132012-08-24 19:46:03 +000035def UnixAlpha : Package<"unix">, InPackage<Alpha>, Hidden;
Anna Zaksbb2a6862012-02-20 21:10:37 +000036def CString : Package<"cstring">, InPackage<Unix>, Hidden;
Ted Kremenek3d578132012-08-24 19:46:03 +000037def CStringAlpha : Package<"cstring">, InPackage<UnixAlpha>, Hidden;
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000038
Ted Kremenek51885072011-03-24 00:28:47 +000039def OSX : Package<"osx">;
Ted Kremenek3d578132012-08-24 19:46:03 +000040def OSXAlpha : Package<"osx">, InPackage<Alpha>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000041def Cocoa : Package<"cocoa">, InPackage<OSX>;
Ted Kremenek3d578132012-08-24 19:46:03 +000042def CocoaAlpha : Package<"cocoa">, InPackage<OSXAlpha>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000043def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
Anna Zaks52a38882012-02-04 02:31:57 +000044def Containers : Package<"containers">, InPackage<CoreFoundation>;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000045
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000046def LLVM : Package<"llvm">;
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +000047def Debug : Package<"debug">;
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000048
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000049//===----------------------------------------------------------------------===//
Ted Kremenek51885072011-03-24 00:28:47 +000050// Core Checkers.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000051//===----------------------------------------------------------------------===//
52
Ted Kremenek51885072011-03-24 00:28:47 +000053let ParentPackage = Core in {
54
55def DereferenceChecker : Checker<"NullDereference">,
56 HelpText<"Check for dereferences of null pointers">,
57 DescFile<"DereferenceChecker.cpp">;
58
59def CallAndMessageChecker : Checker<"CallAndMessage">,
60 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
61 DescFile<"CallAndMessageChecker.cpp">;
62
Ted Kremenek51885072011-03-24 00:28:47 +000063def AttrNonNullChecker : Checker<"AttributeNonNull">,
64 HelpText<"Check for null pointers passed as arguments to a function whose arguments are marked with the 'nonnull' attribute">,
65 DescFile<"AttrNonNullChecker.cpp">;
66
67def VLASizeChecker : Checker<"VLASize">,
68 HelpText<"Check for declarations of VLA of undefined or zero size">,
69 DescFile<"VLASizeChecker.cpp">;
70
71def DivZeroChecker : Checker<"DivideZero">,
72 HelpText<"Check for division by zero">,
73 DescFile<"DivZeroChecker.cpp">;
74
75def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
76 HelpText<"Check for undefined results of binary operators">,
77 DescFile<"UndefResultChecker.cpp">;
78
79def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
80 HelpText<"Check that addresses to stack memory do not escape the function">,
81 DescFile<"StackAddrEscapeChecker.cpp">;
82
Anna Zaksc7ecc432012-08-06 23:25:39 +000083def DynamicTypePropagation : Checker<"DynamicTypePropagation">,
84 HelpText<"Generate dynamic type information">,
85 DescFile<"DynamicTypePropagation.cpp">;
86
Ted Kremenek51885072011-03-24 00:28:47 +000087} // end "core"
88
Ted Kremenek3d578132012-08-24 19:46:03 +000089let ParentPackage = CoreAlpha in {
Ted Kremenek51885072011-03-24 00:28:47 +000090
Ryan Govostesb141b282012-02-11 16:32:09 +000091def BoolAssignmentChecker : Checker<"BoolAssignment">,
92 HelpText<"Warn about assigning non-{0,1} values to Boolean variables">,
93 DescFile<"BoolAssignmentChecker.cpp">;
94
Ted Kremenek51885072011-03-24 00:28:47 +000095def CastSizeChecker : Checker<"CastSize">,
Ted Kremenek51885072011-03-24 00:28:47 +000096 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
97 DescFile<"CastSizeChecker.cpp">;
98
99def CastToStructChecker : Checker<"CastToStruct">,
Ted Kremenek51885072011-03-24 00:28:47 +0000100 HelpText<"Check for cast from non-struct pointer to struct pointer">,
101 DescFile<"CastToStructChecker.cpp">;
102
103def FixedAddressChecker : Checker<"FixedAddr">,
Ted Kremenek51885072011-03-24 00:28:47 +0000104 HelpText<"Check for assignment of a fixed address to a pointer">,
105 DescFile<"FixedAddressChecker.cpp">;
106
107def PointerArithChecker : Checker<"PointerArithm">,
Ted Kremenek51885072011-03-24 00:28:47 +0000108 HelpText<"Check for pointer arithmetic on locations other than array elements">,
109 DescFile<"PointerArithChecker">;
110
111def PointerSubChecker : Checker<"PointerSub">,
Ted Kremenek51885072011-03-24 00:28:47 +0000112 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
113 DescFile<"PointerSubChecker">;
114
115def SizeofPointerChecker : Checker<"SizeofPtr">,
Ted Kremenek51885072011-03-24 00:28:47 +0000116 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
117 DescFile<"CheckSizeofPointer.cpp">;
118
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000119} // end "alpha.core"
Ted Kremenek51885072011-03-24 00:28:47 +0000120
121//===----------------------------------------------------------------------===//
122// Evaluate "builtin" functions.
123//===----------------------------------------------------------------------===//
124
125let ParentPackage = CoreBuiltin in {
126
127def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
128 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
129 DescFile<"NoReturnFunctionChecker.cpp">;
130
131def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
132 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
133 DescFile<"BuiltinFunctionChecker.cpp">;
134
135} // end "core.builtin"
136
137//===----------------------------------------------------------------------===//
138// Uninitialized values checkers.
139//===----------------------------------------------------------------------===//
140
141let ParentPackage = CoreUninitialized in {
142
143def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
144 HelpText<"Check for uninitialized values used as array subscripts">,
145 DescFile<"UndefinedArraySubscriptChecker.cpp">;
146
147def UndefinedAssignmentChecker : Checker<"Assign">,
148 HelpText<"Check for assigning uninitialized values">,
149 DescFile<"UndefinedAssignmentChecker.cpp">;
150
151def UndefBranchChecker : Checker<"Branch">,
152 HelpText<"Check for uninitialized values used as branch conditions">,
153 DescFile<"UndefBranchChecker.cpp">;
154
155def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
156 HelpText<"Check for blocks that capture uninitialized values">,
157 DescFile<"UndefCapturedBlockVarChecker.cpp">;
158
159def ReturnUndefChecker : Checker<"UndefReturn">,
160 HelpText<"Check for uninitialized values being returned to the caller">,
161 DescFile<"ReturnUndefChecker.cpp">;
162
163} // end "core.uninitialized"
164
165//===----------------------------------------------------------------------===//
166// C++ checkers.
167//===----------------------------------------------------------------------===//
168
Ted Kremenek3d578132012-08-24 19:46:03 +0000169let ParentPackage = CplusplusAlpha in {
Ted Kremenek51885072011-03-24 00:28:47 +0000170
Ted Kremenekde9f2532012-01-03 23:18:57 +0000171def VirtualCallChecker : Checker<"VirtualCall">,
172 HelpText<"Check virtual function calls during construction or destruction">,
173 DescFile<"VirtualCallChecker.cpp">;
174
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000175} // end: "alpha.cplusplus"
Ted Kremenek51885072011-03-24 00:28:47 +0000176
177//===----------------------------------------------------------------------===//
178// Deadcode checkers.
179//===----------------------------------------------------------------------===//
180
181let ParentPackage = DeadCode in {
182
183def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekb8030262011-03-26 00:25:42 +0000184 HelpText<"Check for values stored to variables that are never read afterwards">,
Ted Kremenek51885072011-03-24 00:28:47 +0000185 DescFile<"DeadStoresChecker.cpp">;
Ted Kremeneka8180e52012-01-20 06:00:17 +0000186} // end DeadCode
187
Ted Kremenek3d578132012-08-24 19:46:03 +0000188let ParentPackage = DeadCodeAlpha in {
Ted Kremenek51885072011-03-24 00:28:47 +0000189
190def IdempotentOperationChecker : Checker<"IdempotentOperations">,
191 HelpText<"Warn about idempotent operations">,
192 DescFile<"IdempotentOperationChecker.cpp">;
193
Ted Kremenek51885072011-03-24 00:28:47 +0000194def UnreachableCodeChecker : Checker<"UnreachableCode">,
Ted Kremenek51885072011-03-24 00:28:47 +0000195 HelpText<"Check unreachable code">,
196 DescFile<"UnreachableCodeChecker.cpp">;
197
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000198} // end "alpha.deadcode"
Ted Kremenek51885072011-03-24 00:28:47 +0000199
200//===----------------------------------------------------------------------===//
201// Security checkers.
202//===----------------------------------------------------------------------===//
203
Ted Kremenek76a54242012-01-20 01:44:29 +0000204let ParentPackage = InsecureAPI in {
205 def gets : Checker<"gets">,
206 HelpText<"Warn on uses of the 'gets' function">,
207 DescFile<"CheckSecuritySyntaxOnly.cpp">;
208 def getpw : Checker<"getpw">,
209 HelpText<"Warn on uses of the 'getpw' function">,
210 DescFile<"CheckSecuritySyntaxOnly.cpp">;
211 def mktemp : Checker<"mktemp">,
212 HelpText<"Warn on uses of the 'mktemp' function">,
213 DescFile<"CheckSecuritySyntaxOnly.cpp">;
Ted Kremenekb63d8d82012-01-20 05:35:06 +0000214 def mkstemp : Checker<"mkstemp">,
215 HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">,
216 DescFile<"CheckSecuritySyntaxOnly.cpp">;
Ted Kremenek76a54242012-01-20 01:44:29 +0000217 def rand : Checker<"rand">,
218 HelpText<"Warn on uses of the 'rand', 'random', and related functions">,
219 DescFile<"CheckSecuritySyntaxOnly.cpp">;
220 def strcpy : Checker<"strcpy">,
221 HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">,
222 DescFile<"CheckSecuritySyntaxOnly.cpp">;
223 def vfork : Checker<"vfork">,
224 HelpText<"Warn on uses of the 'vfork' function">,
225 DescFile<"CheckSecuritySyntaxOnly.cpp">;
Ted Kremenekb63d8d82012-01-20 05:35:06 +0000226 def UncheckedReturn : Checker<"UncheckedReturn">,
227 HelpText<"Warn on uses of functions whose return values must be always checked">,
228 DescFile<"CheckSecuritySyntaxOnly.cpp">;
Ted Kremenek76a54242012-01-20 01:44:29 +0000229}
230let ParentPackage = Security in {
231 def FloatLoopCounter : Checker<"FloatLoopCounter">,
232 HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">,
233 DescFile<"CheckSecuritySyntaxOnly.cpp">;
234}
Ted Kremenek51885072011-03-24 00:28:47 +0000235
Ted Kremenek3d578132012-08-24 19:46:03 +0000236let ParentPackage = SecurityAlpha in {
Ted Kremenek51885072011-03-24 00:28:47 +0000237
238def ArrayBoundChecker : Checker<"ArrayBound">,
Ted Kremenek51885072011-03-24 00:28:47 +0000239 HelpText<"Warn about buffer overflows (older checker)">,
240 DescFile<"ArrayBoundChecker.cpp">;
241
242def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
Ted Kremenek51885072011-03-24 00:28:47 +0000243 HelpText<"Warn about buffer overflows (newer checker)">,
244 DescFile<"ArrayBoundCheckerV2.cpp">;
245
246def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
Ted Kremenek51885072011-03-24 00:28:47 +0000247 HelpText<"Check for an out-of-bound pointer being returned to callers">,
248 DescFile<"ReturnPointerRangeChecker.cpp">;
249
Ted Kremenek17f7bdd2011-08-03 20:17:43 +0000250def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
251 HelpText<"Check for overflows in the arguments to malloc()">,
252 DescFile<"MallocOverflowSecurityChecker.cpp">;
253
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000254} // end "alpha.security"
Ted Kremenek51885072011-03-24 00:28:47 +0000255
256//===----------------------------------------------------------------------===//
Anna Zaksdf18c5a2011-11-16 19:58:13 +0000257// Taint checkers.
258//===----------------------------------------------------------------------===//
259
260let ParentPackage = Taint in {
261
262def GenericTaintChecker : Checker<"TaintPropagation">,
263 HelpText<"Generate taint information used by other checkers">,
264 DescFile<"GenericTaintChecker.cpp">;
265
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000266} // end "alpha.security.taint"
Anna Zaksdf18c5a2011-11-16 19:58:13 +0000267
268//===----------------------------------------------------------------------===//
Ted Kremenek51885072011-03-24 00:28:47 +0000269// Unix API checkers.
270//===----------------------------------------------------------------------===//
271
272let ParentPackage = Unix in {
273
274def UnixAPIChecker : Checker<"API">,
275 HelpText<"Check calls to various UNIX/Posix functions">,
276 DescFile<"UnixAPIChecker.cpp">;
Anna Zaksbb2a6862012-02-20 21:10:37 +0000277
278def MallocPessimistic : Checker<"Malloc">,
279 HelpText<"Check for memory leaks, double free, and use-after-free problems.">,
280 DescFile<"MallocChecker.cpp">;
Ted Kremenek51885072011-03-24 00:28:47 +0000281
Anna Zaksca115102012-05-07 23:30:29 +0000282def MallocSizeofChecker : Checker<"MallocSizeof">,
283 HelpText<"Check for dubious malloc arguments involving sizeof">,
284 DescFile<"MallocSizeofChecker.cpp">;
285
Ted Kremenek51885072011-03-24 00:28:47 +0000286} // end "unix"
287
Ted Kremenek3d578132012-08-24 19:46:03 +0000288let ParentPackage = UnixAlpha in {
Ted Kremenek51885072011-03-24 00:28:47 +0000289
290def ChrootChecker : Checker<"Chroot">,
Ted Kremenek51885072011-03-24 00:28:47 +0000291 HelpText<"Check improper use of chroot">,
292 DescFile<"ChrootChecker.cpp">;
293
Anna Zaks231361a2012-02-08 23:16:52 +0000294def MallocOptimistic : Checker<"MallocWithAnnotations">,
295 HelpText<"Check for memory leaks, double free, and use-after-free problems. Assumes that all user-defined functions which might free a pointer are annotated.">,
296 DescFile<"MallocChecker.cpp">;
297
Ted Kremenek51885072011-03-24 00:28:47 +0000298def PthreadLockChecker : Checker<"PthreadLock">,
Ted Kremenek51885072011-03-24 00:28:47 +0000299 HelpText<"Simple lock -> unlock checker">,
300 DescFile<"PthreadLockChecker.cpp">;
301
302def StreamChecker : Checker<"Stream">,
Ted Kremenek51885072011-03-24 00:28:47 +0000303 HelpText<"Check stream handling functions">,
304 DescFile<"StreamChecker.cpp">;
305
Anna Zaksd65e55d2012-10-29 22:51:50 +0000306def SimpleStreamChecker : Checker<"SimpleStream">,
307 HelpText<"Check for misuses of stream APIs">,
308 DescFile<"SimpleStreamChecker.cpp">;
309
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000310} // end "alpha.unix"
Ted Kremenek51885072011-03-24 00:28:47 +0000311
Anna Zakse00575f2012-01-31 19:33:39 +0000312let ParentPackage = CString in {
313
Anna Zaks57300762012-02-07 00:56:14 +0000314def CStringNullArg : Checker<"NullArg">,
315 HelpText<"Check for null pointers being passed as arguments to C string functions">,
316 DescFile<"CStringChecker.cpp">;
317
Anna Zaksbb2a6862012-02-20 21:10:37 +0000318def CStringSyntaxChecker : Checker<"BadSizeArg">,
319 HelpText<"Check the size argument passed into C string functions for common erroneous patterns">,
320 DescFile<"CStringSyntaxChecker.cpp">;
321}
322
Ted Kremenek3d578132012-08-24 19:46:03 +0000323let ParentPackage = CStringAlpha in {
Anna Zaksbb2a6862012-02-20 21:10:37 +0000324
Anna Zaks57300762012-02-07 00:56:14 +0000325def CStringOutOfBounds : Checker<"OutOfBounds">,
326 HelpText<"Check for out-of-bounds access in string functions">,
327 DescFile<"CStringChecker.cpp">;
328
329def CStringBufferOverlap : Checker<"BufferOverlap">,
330 HelpText<"Checks for overlap in two buffer arguments">,
331 DescFile<"CStringChecker.cpp">;
332
333def CStringNotNullTerm : Checker<"NotNullTerminated">,
334 HelpText<"Check for arguments which are not null-terminating strings">,
Anna Zakse00575f2012-01-31 19:33:39 +0000335 DescFile<"CStringChecker.cpp">;
Anna Zakse00575f2012-01-31 19:33:39 +0000336}
337
Ted Kremenek51885072011-03-24 00:28:47 +0000338//===----------------------------------------------------------------------===//
339// Mac OS X, Cocoa, and Core Foundation checkers.
340//===----------------------------------------------------------------------===//
341
342let ParentPackage = OSX in {
343
344def MacOSXAPIChecker : Checker<"API">,
345 InPackage<OSX>,
346 HelpText<"Check for proper uses of various Mac OS X APIs">,
347 DescFile<"MacOSXAPIChecker.cpp">;
348
Anna Zaksb1a19502011-08-16 20:02:05 +0000349def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">,
350 InPackage<OSX>,
Anna Zaksf57be282011-08-01 22:40:01 +0000351 HelpText<"Check for proper uses of Secure Keychain APIs">,
352 DescFile<"MacOSKeychainAPIChecker.cpp">;
353
Anna Zaksb1a19502011-08-16 20:02:05 +0000354} // end "macosx"
Anna Zaksf57be282011-08-01 22:40:01 +0000355
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000356let ParentPackage = Cocoa in {
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +0000357
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000358def ObjCAtSyncChecker : Checker<"AtSync">,
Anna Zaksbe72df02012-05-24 17:31:59 +0000359 HelpText<"Check for nil pointers used as mutexes for @synchronized">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000360 DescFile<"ObjCAtSyncChecker.cpp">;
361
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000362def NilArgChecker : Checker<"NilArg">,
363 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
364 DescFile<"BasicObjCFoundationChecks.cpp">;
365
366def ClassReleaseChecker : Checker<"ClassRelease">,
367 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
368 DescFile<"BasicObjCFoundationChecks.cpp">;
369
Anders Carlsson4597b7b2011-03-13 20:35:21 +0000370def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
Anna Zaksbe72df02012-05-24 17:31:59 +0000371 HelpText<"Check for passing non-Objective-C types to variadic collection "
372 "initialization methods that expect only Objective-C types">,
Anders Carlsson4597b7b2011-03-13 20:35:21 +0000373 DescFile<"BasicObjCFoundationChecks.cpp">;
374
Ted Kremenekb8d545c2011-02-25 22:19:14 +0000375def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
Ted Kremenek51885072011-03-24 00:28:47 +0000376 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000377 DescFile<"NSAutoreleasePoolChecker.cpp">;
378
Ted Kremenek51885072011-03-24 00:28:47 +0000379def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000380 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
381 DescFile<"CheckObjCInstMethSignature.cpp">;
382
383def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
384 HelpText<"Warn about private ivars that are never used">,
385 DescFile<"ObjCUnusedIVarsChecker.cpp">;
Anna Zaks52a38882012-02-04 02:31:57 +0000386
387def ObjCSelfInitChecker : Checker<"SelfInit">,
388 HelpText<"Check that 'self' is properly initialized inside an initializer method">,
389 DescFile<"ObjCSelfInitChecker.cpp">;
390
Jordan Rose1895a0a2012-06-11 16:40:41 +0000391def ObjCLoopChecker : Checker<"Loops">,
392 HelpText<"Improved modeling of loops using Cocoa collection types">,
393 DescFile<"BasicObjCFoundationChecks.cpp">;
394
Anna Zaks26663612012-08-22 21:19:56 +0000395def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">,
396 HelpText<"Model the APIs that are guaranteed to return a non-nil value">,
397 DescFile<"BasicObjCFoundationChecks.cpp">;
398
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000399def NSErrorChecker : Checker<"NSError">,
400 HelpText<"Check usage of NSError** parameters">,
401 DescFile<"NSErrorChecker.cpp">;
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000402
Jordy Rose17a38e22011-09-02 05:55:19 +0000403def RetainCountChecker : Checker<"RetainCount">,
404 HelpText<"Check for leaks and improper reference count management">,
405 DescFile<"RetainCountChecker.cpp">;
406
Anna Zaksbe72df02012-05-24 17:31:59 +0000407} // end "osx.cocoa"
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000408
Ted Kremenek3d578132012-08-24 19:46:03 +0000409let ParentPackage = CocoaAlpha in {
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +0000410
Ted Kremenek51885072011-03-24 00:28:47 +0000411def ObjCDeallocChecker : Checker<"Dealloc">,
Ted Kremenek51885072011-03-24 00:28:47 +0000412 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
413 DescFile<"CheckObjCDealloc.cpp">;
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000414
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000415def IvarInvalidationChecker : Checker<"InstanceVariableInvalidation">,
416 HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
Anna Zaksb087bbf2012-09-27 19:45:08 +0000417 DescFile<"IvarInvalidationChecker.cpp">;
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000418
Anna Zaks88a83e32012-09-27 19:45:15 +0000419def DirectIvarAssignment : Checker<"DirectIvarAssignment">,
Anna Zaks39a62fc2012-12-05 01:14:37 +0000420 HelpText<"Check for direct assignments to instance variables">,
421 DescFile<"DirectIvarAssignment.cpp">;
422
423def DirectIvarAssignmentForAnnotatedFunctions : Checker<"DirectIvarAssignmentForAnnotatedFunctions">,
Ted Kremeneka05d2742012-12-22 00:34:48 +0000424 HelpText<"Check for direct assignments to instance variables in the methods annotated with objc_no_direct_instance_variable_assignment">,
Anna Zaks88a83e32012-09-27 19:45:15 +0000425 DescFile<"DirectIvarAssignment.cpp">;
426
Jordan Rose3cf9a722012-10-30 01:21:35 +0000427def ObjCSuperCallChecker : Checker<"MissingSuperCall">,
428 HelpText<"Warn about Objective-C methods that lack a necessary call to super">,
429 DescFile<"ObjCMissingSuperCallChecker.cpp">;
430
Anna Zaks5bf5c2e2012-09-26 18:55:16 +0000431} // end "alpha.osx.cocoa"
Argyrios Kyrtzidisd84f4222011-02-28 01:28:13 +0000432
Ted Kremenek51885072011-03-24 00:28:47 +0000433let ParentPackage = CoreFoundation in {
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000434
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000435def CFNumberCreateChecker : Checker<"CFNumber">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000436 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000437 DescFile<"BasicObjCFoundationChecks.cpp">;
438
439def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
Jordan Rose0fe4d402012-11-07 17:12:37 +0000440 HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000441 DescFile<"BasicObjCFoundationChecks.cpp">;
442
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000443def CFErrorChecker : Checker<"CFError">,
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000444 HelpText<"Check usage of CFErrorRef* parameters">,
445 DescFile<"NSErrorChecker.cpp">;
Ted Kremenek51885072011-03-24 00:28:47 +0000446}
447
Anna Zaks7fc80032012-01-30 21:14:16 +0000448let ParentPackage = Containers in {
449def ObjCContainersASTChecker : Checker<"PointerSizedValues">,
450 HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">,
Anna Zaks52a38882012-02-04 02:31:57 +0000451 DescFile<"ObjCContainersASTChecker.cpp">;
452
453def ObjCContainersChecker : Checker<"OutOfBounds">,
Anna Zaks57300762012-02-07 00:56:14 +0000454 HelpText<"Checks for index out-of-bounds when using 'CFArray' API">,
Anna Zaks52a38882012-02-04 02:31:57 +0000455 DescFile<"ObjCContainersChecker.cpp">;
456
Anna Zaks7fc80032012-01-30 21:14:16 +0000457}
Ted Kremenek51885072011-03-24 00:28:47 +0000458//===----------------------------------------------------------------------===//
459// Checkers for LLVM development.
460//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000461
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000462def LLVMConventionsChecker : Checker<"Conventions">,
463 InPackage<LLVM>,
464 HelpText<"Check code for LLVM codebase conventions">,
465 DescFile<"LLVMConventionsChecker.cpp">;
466
Ted Kremenek51885072011-03-24 00:28:47 +0000467//===----------------------------------------------------------------------===//
468// Debugging checkers (for analyzer development).
469//===----------------------------------------------------------------------===//
470
471let ParentPackage = Debug in {
472
Ted Kremenek58f6f1e2011-10-25 00:25:24 +0000473def DominatorsTreeDumper : Checker<"DumpDominators">,
474 HelpText<"Print the dominance tree for a given CFG">,
475 DescFile<"DebugCheckers.cpp">;
476
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000477def LiveVariablesDumper : Checker<"DumpLiveVars">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000478 HelpText<"Print results of live variable analysis">,
479 DescFile<"DebugCheckers.cpp">;
480
481def CFGViewer : Checker<"ViewCFG">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000482 HelpText<"View Control-Flow Graphs using GraphViz">,
483 DescFile<"DebugCheckers.cpp">;
484
485def CFGDumper : Checker<"DumpCFG">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000486 HelpText<"Display Control-Flow Graphs">,
487 DescFile<"DebugCheckers.cpp">;
488
Anna Zaks196b8cf2012-03-08 00:42:23 +0000489def CallGraphViewer : Checker<"ViewCallGraph">,
490 HelpText<"View Call Graph using GraphViz">,
491 DescFile<"DebugCheckers.cpp">;
492
493def CallGraphDumper : Checker<"DumpCallGraph">,
494 HelpText<"Display Call Graph">,
495 DescFile<"DebugCheckers.cpp">;
496
Ted Kremenek43e8ef02012-10-01 18:28:14 +0000497def ConfigDumper : Checker<"ConfigDumper">,
498 HelpText<"Dump config table">,
499 DescFile<"DebugCheckers.cpp">;
500
Jordan Rose8d0f5282012-06-29 00:33:10 +0000501def TraversalDumper : Checker<"DumpTraversal">,
502 HelpText<"Print branch conditions as they are traversed by the engine">,
503 DescFile<"TraversalChecker.cpp">;
504
Jordan Rose0ffbfd12012-07-10 23:56:23 +0000505def CallDumper : Checker<"DumpCalls">,
506 HelpText<"Print calls as they are traversed by the engine">,
507 DescFile<"TraversalChecker.cpp">;
508
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000509def AnalyzerStatsChecker : Checker<"Stats">,
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000510 HelpText<"Emit warnings with analyzer statistics">,
511 DescFile<"AnalyzerStatsChecker.cpp">;
512
Anna Zaksa50b7ab2011-12-05 18:58:01 +0000513def TaintTesterChecker : Checker<"TaintTest">,
514 HelpText<"Mark tainted symbols as such.">,
515 DescFile<"TaintTesterChecker.cpp">;
516
Jordy Rose93a9d822012-05-16 16:01:07 +0000517def ExprInspectionChecker : Checker<"ExprInspection">,
518 HelpText<"Check the analyzer's understanding of expressions">,
519 DescFile<"ExprInspectionChecker.cpp">;
520
Ted Kremenek51885072011-03-24 00:28:47 +0000521} // end "debug"
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000522