blob: 65b782108ab40b924ace1ce8030afe9677c3c91c [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 Kremenek033a07e2011-08-03 23:14:55 +000016def Experimental : Package<"experimental">;
17
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 Kremenek0e244712011-08-04 00:25:50 +000021def CoreExperimental : Package<"core">, InPackage<Experimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000022
23def Cplusplus : Package<"cplusplus">;
Ted Kremenek0e244712011-08-04 00:25:50 +000024def CplusplusExperimental : Package<"cplusplus">, InPackage<Experimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000025
Ted Kremenekade31952011-03-12 06:14:28 +000026def DeadCode : Package<"deadcode">;
Ted Kremenek0e244712011-08-04 00:25:50 +000027def DeadCodeExperimental : Package<"deadcode">, InPackage<Experimental>, Hidden;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000028
Ted Kremenek51885072011-03-24 00:28:47 +000029def Security : Package <"security">;
Ted Kremenek0e244712011-08-04 00:25:50 +000030def SecurityExperimental : Package<"security">, InPackage<Experimental>, Hidden;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000031
Ted Kremenek51885072011-03-24 00:28:47 +000032def Unix : Package<"unix">;
Ted Kremenek0e244712011-08-04 00:25:50 +000033def UnixExperimental : Package<"unix">, InPackage<Experimental>, Hidden;
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000034
Ted Kremenek51885072011-03-24 00:28:47 +000035def OSX : Package<"osx">;
Ted Kremenek0e244712011-08-04 00:25:50 +000036def OSXExperimental : Package<"osx">, InPackage<Experimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000037def Cocoa : Package<"cocoa">, InPackage<OSX>;
Ted Kremenek0e244712011-08-04 00:25:50 +000038def CocoaExperimental : Package<"cocoa">, InPackage<OSXExperimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000039def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000040
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000041def LLVM : Package<"llvm">;
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +000042def Debug : Package<"debug">;
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000043
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000044//===----------------------------------------------------------------------===//
Ted Kremenek51885072011-03-24 00:28:47 +000045// Core Checkers.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000046//===----------------------------------------------------------------------===//
47
Ted Kremenek51885072011-03-24 00:28:47 +000048let ParentPackage = Core in {
49
50def DereferenceChecker : Checker<"NullDereference">,
51 HelpText<"Check for dereferences of null pointers">,
52 DescFile<"DereferenceChecker.cpp">;
53
54def CallAndMessageChecker : Checker<"CallAndMessage">,
55 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
56 DescFile<"CallAndMessageChecker.cpp">;
57
58def AdjustedReturnValueChecker : Checker<"AdjustedReturnValue">,
59 HelpText<"Check to see if the return value of a function call is different than the caller expects (e.g., from calls through function pointers)">,
60 DescFile<"AdjustedReturnValueChecker.cpp">;
61
62def AttrNonNullChecker : Checker<"AttributeNonNull">,
63 HelpText<"Check for null pointers passed as arguments to a function whose arguments are marked with the 'nonnull' attribute">,
64 DescFile<"AttrNonNullChecker.cpp">;
65
66def VLASizeChecker : Checker<"VLASize">,
67 HelpText<"Check for declarations of VLA of undefined or zero size">,
68 DescFile<"VLASizeChecker.cpp">;
69
70def DivZeroChecker : Checker<"DivideZero">,
71 HelpText<"Check for division by zero">,
72 DescFile<"DivZeroChecker.cpp">;
73
74def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
75 HelpText<"Check for undefined results of binary operators">,
76 DescFile<"UndefResultChecker.cpp">;
77
78def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
79 HelpText<"Check that addresses to stack memory do not escape the function">,
80 DescFile<"StackAddrEscapeChecker.cpp">;
81
82} // end "core"
83
84let ParentPackage = CoreExperimental in {
85
86def CastSizeChecker : Checker<"CastSize">,
Ted Kremenek51885072011-03-24 00:28:47 +000087 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
88 DescFile<"CastSizeChecker.cpp">;
89
90def CastToStructChecker : Checker<"CastToStruct">,
Ted Kremenek51885072011-03-24 00:28:47 +000091 HelpText<"Check for cast from non-struct pointer to struct pointer">,
92 DescFile<"CastToStructChecker.cpp">;
93
94def FixedAddressChecker : Checker<"FixedAddr">,
Ted Kremenek51885072011-03-24 00:28:47 +000095 HelpText<"Check for assignment of a fixed address to a pointer">,
96 DescFile<"FixedAddressChecker.cpp">;
97
98def PointerArithChecker : Checker<"PointerArithm">,
Ted Kremenek51885072011-03-24 00:28:47 +000099 HelpText<"Check for pointer arithmetic on locations other than array elements">,
100 DescFile<"PointerArithChecker">;
101
102def PointerSubChecker : Checker<"PointerSub">,
Ted Kremenek51885072011-03-24 00:28:47 +0000103 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
104 DescFile<"PointerSubChecker">;
105
106def SizeofPointerChecker : Checker<"SizeofPtr">,
Ted Kremenek51885072011-03-24 00:28:47 +0000107 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
108 DescFile<"CheckSizeofPointer.cpp">;
109
110} // end "core.experimental"
111
112//===----------------------------------------------------------------------===//
113// Evaluate "builtin" functions.
114//===----------------------------------------------------------------------===//
115
116let ParentPackage = CoreBuiltin in {
117
118def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
119 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
120 DescFile<"NoReturnFunctionChecker.cpp">;
121
122def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
123 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
124 DescFile<"BuiltinFunctionChecker.cpp">;
125
126} // end "core.builtin"
127
128//===----------------------------------------------------------------------===//
129// Uninitialized values checkers.
130//===----------------------------------------------------------------------===//
131
132let ParentPackage = CoreUninitialized in {
133
134def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
135 HelpText<"Check for uninitialized values used as array subscripts">,
136 DescFile<"UndefinedArraySubscriptChecker.cpp">;
137
138def UndefinedAssignmentChecker : Checker<"Assign">,
139 HelpText<"Check for assigning uninitialized values">,
140 DescFile<"UndefinedAssignmentChecker.cpp">;
141
142def UndefBranchChecker : Checker<"Branch">,
143 HelpText<"Check for uninitialized values used as branch conditions">,
144 DescFile<"UndefBranchChecker.cpp">;
145
146def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
147 HelpText<"Check for blocks that capture uninitialized values">,
148 DescFile<"UndefCapturedBlockVarChecker.cpp">;
149
150def ReturnUndefChecker : Checker<"UndefReturn">,
151 HelpText<"Check for uninitialized values being returned to the caller">,
152 DescFile<"ReturnUndefChecker.cpp">;
153
154} // end "core.uninitialized"
155
156//===----------------------------------------------------------------------===//
157// C++ checkers.
158//===----------------------------------------------------------------------===//
159
160let ParentPackage = CplusplusExperimental in {
161
Ted Kremenek51885072011-03-24 00:28:47 +0000162def IteratorsChecker : Checker<"Iterators">,
Ted Kremenek51885072011-03-24 00:28:47 +0000163 HelpText<"Check improper uses of STL vector iterators">,
164 DescFile<"IteratorsChecker.cpp">;
165
166} // end: "cplusplus.experimental"
167
168//===----------------------------------------------------------------------===//
169// Deadcode checkers.
170//===----------------------------------------------------------------------===//
171
172let ParentPackage = DeadCode in {
173
174def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekb8030262011-03-26 00:25:42 +0000175 HelpText<"Check for values stored to variables that are never read afterwards">,
Ted Kremenek51885072011-03-24 00:28:47 +0000176 DescFile<"DeadStoresChecker.cpp">;
177
178def IdempotentOperationChecker : Checker<"IdempotentOperations">,
179 HelpText<"Warn about idempotent operations">,
180 DescFile<"IdempotentOperationChecker.cpp">;
181
182} // end DeadCode
183
184let ParentPackage = DeadCodeExperimental in {
185
186def UnreachableCodeChecker : Checker<"UnreachableCode">,
Ted Kremenek51885072011-03-24 00:28:47 +0000187 HelpText<"Check unreachable code">,
188 DescFile<"UnreachableCodeChecker.cpp">;
189
190} // end "deadcode.experimental"
191
192//===----------------------------------------------------------------------===//
193// Security checkers.
194//===----------------------------------------------------------------------===//
195
196let ParentPackage = SecurityExperimental in {
197
198def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
199 HelpText<"Perform quick security API checks that require no data flow">,
200 DescFile<"CheckSecuritySyntaxOnly.cpp">;
201
202def ArrayBoundChecker : Checker<"ArrayBound">,
Ted Kremenek51885072011-03-24 00:28:47 +0000203 HelpText<"Warn about buffer overflows (older checker)">,
204 DescFile<"ArrayBoundChecker.cpp">;
205
206def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
Ted Kremenek51885072011-03-24 00:28:47 +0000207 HelpText<"Warn about buffer overflows (newer checker)">,
208 DescFile<"ArrayBoundCheckerV2.cpp">;
209
210def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
Ted Kremenek51885072011-03-24 00:28:47 +0000211 HelpText<"Check for an out-of-bound pointer being returned to callers">,
212 DescFile<"ReturnPointerRangeChecker.cpp">;
213
Ted Kremenek17f7bdd2011-08-03 20:17:43 +0000214def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
215 HelpText<"Check for overflows in the arguments to malloc()">,
216 DescFile<"MallocOverflowSecurityChecker.cpp">;
217
Ted Kremenek51885072011-03-24 00:28:47 +0000218} // end "security.experimental"
219
220//===----------------------------------------------------------------------===//
221// Unix API checkers.
222//===----------------------------------------------------------------------===//
223
224let ParentPackage = Unix in {
225
226def UnixAPIChecker : Checker<"API">,
227 HelpText<"Check calls to various UNIX/Posix functions">,
228 DescFile<"UnixAPIChecker.cpp">;
229
230} // end "unix"
231
232let ParentPackage = UnixExperimental in {
233
234def ChrootChecker : Checker<"Chroot">,
Ted Kremenek51885072011-03-24 00:28:47 +0000235 HelpText<"Check improper use of chroot">,
236 DescFile<"ChrootChecker.cpp">;
237
Jordy Rose467f7c82011-06-14 01:40:43 +0000238def CStringChecker : Checker<"CString">,
239 HelpText<"Check calls to functions in <string.h>">,
240 DescFile<"CStringChecker.cpp">;
241
Ted Kremenek51885072011-03-24 00:28:47 +0000242def MallocChecker : Checker<"Malloc">,
Ted Kremenek51885072011-03-24 00:28:47 +0000243 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
244 DescFile<"MallocChecker.cpp">;
245
246def PthreadLockChecker : Checker<"PthreadLock">,
Ted Kremenek51885072011-03-24 00:28:47 +0000247 HelpText<"Simple lock -> unlock checker">,
248 DescFile<"PthreadLockChecker.cpp">;
249
250def StreamChecker : Checker<"Stream">,
Ted Kremenek51885072011-03-24 00:28:47 +0000251 HelpText<"Check stream handling functions">,
252 DescFile<"StreamChecker.cpp">;
253
254} // end "unix.experimental"
255
256//===----------------------------------------------------------------------===//
257// Mac OS X, Cocoa, and Core Foundation checkers.
258//===----------------------------------------------------------------------===//
259
260let ParentPackage = OSX in {
261
262def MacOSXAPIChecker : Checker<"API">,
263 InPackage<OSX>,
264 HelpText<"Check for proper uses of various Mac OS X APIs">,
265 DescFile<"MacOSXAPIChecker.cpp">;
266
267def OSAtomicChecker : Checker<"AtomicCAS">,
268 InPackage<OSX>,
269 HelpText<"Evaluate calls to OSAtomic functions">,
270 DescFile<"OSAtomicChecker.cpp">;
271
272} // end "macosx"
273
Anna Zaksf57be282011-08-01 22:40:01 +0000274let ParentPackage = OSXExperimental in {
275
276def MacOSKeychainAPIChecker : Checker<"KeychainAPI">,
Anna Zakse68b5f12011-08-02 17:11:03 +0000277 InPackage<OSXExperimental>,
Anna Zaksf57be282011-08-01 22:40:01 +0000278 HelpText<"Check for proper uses of Secure Keychain APIs">,
279 DescFile<"MacOSKeychainAPIChecker.cpp">;
280
281} // end "osx.experimental"
282
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000283let ParentPackage = Cocoa in {
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +0000284
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000285def ObjCAtSyncChecker : Checker<"AtSync">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000286 HelpText<"Check for null pointers used as mutexes for @synchronized">,
287 DescFile<"ObjCAtSyncChecker.cpp">;
288
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000289def NilArgChecker : Checker<"NilArg">,
290 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
291 DescFile<"BasicObjCFoundationChecks.cpp">;
292
293def ClassReleaseChecker : Checker<"ClassRelease">,
294 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
295 DescFile<"BasicObjCFoundationChecks.cpp">;
296
Anders Carlsson4597b7b2011-03-13 20:35:21 +0000297def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
298 HelpText<"Check for passing non-Objective-C types to variadic methods that expect"
299 "only Objective-C types">,
300 DescFile<"BasicObjCFoundationChecks.cpp">;
301
Ted Kremenekb8d545c2011-02-25 22:19:14 +0000302def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
Ted Kremenek51885072011-03-24 00:28:47 +0000303 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000304 DescFile<"NSAutoreleasePoolChecker.cpp">;
305
Ted Kremenek51885072011-03-24 00:28:47 +0000306def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000307 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
308 DescFile<"CheckObjCInstMethSignature.cpp">;
309
310def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
311 HelpText<"Warn about private ivars that are never used">,
312 DescFile<"ObjCUnusedIVarsChecker.cpp">;
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000313
314def NSErrorChecker : Checker<"NSError">,
315 HelpText<"Check usage of NSError** parameters">,
316 DescFile<"NSErrorChecker.cpp">;
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000317
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000318} // end "cocoa"
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000319
Ted Kremenek51885072011-03-24 00:28:47 +0000320let ParentPackage = CocoaExperimental in {
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +0000321
Ted Kremeneka2a3da62011-04-30 06:46:45 +0000322def ObjCSelfInitChecker : Checker<"SelfInit">,
323 HelpText<"Check that 'self' is properly initialized inside an initializer method">,
324 DescFile<"ObjCSelfInitChecker.cpp">;
325
Ted Kremenek51885072011-03-24 00:28:47 +0000326def ObjCDeallocChecker : Checker<"Dealloc">,
Ted Kremenek51885072011-03-24 00:28:47 +0000327 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
328 DescFile<"CheckObjCDealloc.cpp">;
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000329
Ted Kremenek51885072011-03-24 00:28:47 +0000330} // end "cocoa.experimental"
Argyrios Kyrtzidisd84f4222011-02-28 01:28:13 +0000331
Ted Kremenek51885072011-03-24 00:28:47 +0000332let ParentPackage = CoreFoundation in {
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000333
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000334def CFNumberCreateChecker : Checker<"CFNumber">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000335 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000336 DescFile<"BasicObjCFoundationChecks.cpp">;
337
338def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000339 HelpText<"Check for null arguments to CFRetain/CFRelease">,
340 DescFile<"BasicObjCFoundationChecks.cpp">;
341
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000342def CFErrorChecker : Checker<"CFError">,
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000343 HelpText<"Check usage of CFErrorRef* parameters">,
344 DescFile<"NSErrorChecker.cpp">;
Ted Kremenek51885072011-03-24 00:28:47 +0000345}
346
347//===----------------------------------------------------------------------===//
348// Checkers for LLVM development.
349//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000350
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000351def LLVMConventionsChecker : Checker<"Conventions">,
352 InPackage<LLVM>,
353 HelpText<"Check code for LLVM codebase conventions">,
354 DescFile<"LLVMConventionsChecker.cpp">;
355
Ted Kremenek51885072011-03-24 00:28:47 +0000356//===----------------------------------------------------------------------===//
357// Debugging checkers (for analyzer development).
358//===----------------------------------------------------------------------===//
359
360let ParentPackage = Debug in {
361
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000362def LiveVariablesDumper : Checker<"DumpLiveVars">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000363 HelpText<"Print results of live variable analysis">,
364 DescFile<"DebugCheckers.cpp">;
365
366def CFGViewer : Checker<"ViewCFG">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000367 HelpText<"View Control-Flow Graphs using GraphViz">,
368 DescFile<"DebugCheckers.cpp">;
369
370def CFGDumper : Checker<"DumpCFG">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000371 HelpText<"Display Control-Flow Graphs">,
372 DescFile<"DebugCheckers.cpp">;
373
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000374def AnalyzerStatsChecker : Checker<"Stats">,
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000375 HelpText<"Emit warnings with analyzer statistics">,
376 DescFile<"AnalyzerStatsChecker.cpp">;
377
Ted Kremenek51885072011-03-24 00:28:47 +0000378} // end "debug"
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000379