blob: 8ce5732d6eb1a5a32530208b5b9e118e6b44da52 [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//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis1293cda2011-03-29 18:54:02 +000013// Groups.
14//===----------------------------------------------------------------------===//
15
16def AllExperimental : CheckerGroup<"all-experimental">;
17
18//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000019// Packages.
20//===----------------------------------------------------------------------===//
21
Ted Kremenek033a07e2011-08-03 23:14:55 +000022def Experimental : Package<"experimental">;
23
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000024def Core : Package<"core">;
Ted Kremenek51885072011-03-24 00:28:47 +000025def CoreBuiltin : Package<"builtin">, InPackage<Core>;
26def CoreUninitialized : Package<"uninitialized">, InPackage<Core>;
Ted Kremenek033a07e2011-08-03 23:14:55 +000027def CoreExperimental : Package<"core">, InPackage<Experimental>,
Argyrios Kyrtzidis1293cda2011-03-29 18:54:02 +000028 InGroup<AllExperimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000029
30def Cplusplus : Package<"cplusplus">;
Ted Kremenek033a07e2011-08-03 23:14:55 +000031def CplusplusExperimental : Package<"cplusplus">, InPackage<Experimental>,
Argyrios Kyrtzidis1293cda2011-03-29 18:54:02 +000032 InGroup<AllExperimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000033
Ted Kremenekade31952011-03-12 06:14:28 +000034def DeadCode : Package<"deadcode">;
Ted Kremenek033a07e2011-08-03 23:14:55 +000035def DeadCodeExperimental : Package<"deadcode">, InPackage<Experimental>,
Argyrios Kyrtzidis1293cda2011-03-29 18:54:02 +000036 InGroup<AllExperimental>, Hidden;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000037
Ted Kremenek51885072011-03-24 00:28:47 +000038def Security : Package <"security">;
Ted Kremenek033a07e2011-08-03 23:14:55 +000039def SecurityExperimental : Package<"security">, InPackage<Experimental>,
Argyrios Kyrtzidis1293cda2011-03-29 18:54:02 +000040 InGroup<AllExperimental>, Hidden;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000041
Ted Kremenek51885072011-03-24 00:28:47 +000042def Unix : Package<"unix">;
Ted Kremenek033a07e2011-08-03 23:14:55 +000043def UnixExperimental : Package<"unix">, InPackage<Experimental>,
Argyrios Kyrtzidis1293cda2011-03-29 18:54:02 +000044 InGroup<AllExperimental>, Hidden;
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000045
Ted Kremenek51885072011-03-24 00:28:47 +000046def OSX : Package<"osx">;
Ted Kremenek033a07e2011-08-03 23:14:55 +000047def OSXExperimental : Package<"osx">, InPackage<Experimental>,
Anna Zaksf57be282011-08-01 22:40:01 +000048 InGroup<AllExperimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000049def Cocoa : Package<"cocoa">, InPackage<OSX>;
Ted Kremenek033a07e2011-08-03 23:14:55 +000050def CocoaExperimental : Package<"cocoa">, InPackage<OSXExperimental>,
Argyrios Kyrtzidis1293cda2011-03-29 18:54:02 +000051 InGroup<AllExperimental>, Hidden;
Ted Kremenek51885072011-03-24 00:28:47 +000052def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000053
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000054def LLVM : Package<"llvm">;
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +000055def Debug : Package<"debug">;
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000056
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000057//===----------------------------------------------------------------------===//
Ted Kremenek51885072011-03-24 00:28:47 +000058// Core Checkers.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000059//===----------------------------------------------------------------------===//
60
Ted Kremenek51885072011-03-24 00:28:47 +000061let ParentPackage = Core in {
62
63def DereferenceChecker : Checker<"NullDereference">,
64 HelpText<"Check for dereferences of null pointers">,
65 DescFile<"DereferenceChecker.cpp">;
66
67def CallAndMessageChecker : Checker<"CallAndMessage">,
68 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
69 DescFile<"CallAndMessageChecker.cpp">;
70
71def AdjustedReturnValueChecker : Checker<"AdjustedReturnValue">,
72 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)">,
73 DescFile<"AdjustedReturnValueChecker.cpp">;
74
75def AttrNonNullChecker : Checker<"AttributeNonNull">,
76 HelpText<"Check for null pointers passed as arguments to a function whose arguments are marked with the 'nonnull' attribute">,
77 DescFile<"AttrNonNullChecker.cpp">;
78
79def VLASizeChecker : Checker<"VLASize">,
80 HelpText<"Check for declarations of VLA of undefined or zero size">,
81 DescFile<"VLASizeChecker.cpp">;
82
83def DivZeroChecker : Checker<"DivideZero">,
84 HelpText<"Check for division by zero">,
85 DescFile<"DivZeroChecker.cpp">;
86
87def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
88 HelpText<"Check for undefined results of binary operators">,
89 DescFile<"UndefResultChecker.cpp">;
90
91def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
92 HelpText<"Check that addresses to stack memory do not escape the function">,
93 DescFile<"StackAddrEscapeChecker.cpp">;
94
95} // end "core"
96
97let ParentPackage = CoreExperimental in {
98
99def CastSizeChecker : Checker<"CastSize">,
Ted Kremenek51885072011-03-24 00:28:47 +0000100 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
101 DescFile<"CastSizeChecker.cpp">;
102
103def CastToStructChecker : Checker<"CastToStruct">,
Ted Kremenek51885072011-03-24 00:28:47 +0000104 HelpText<"Check for cast from non-struct pointer to struct pointer">,
105 DescFile<"CastToStructChecker.cpp">;
106
107def FixedAddressChecker : Checker<"FixedAddr">,
Ted Kremenek51885072011-03-24 00:28:47 +0000108 HelpText<"Check for assignment of a fixed address to a pointer">,
109 DescFile<"FixedAddressChecker.cpp">;
110
111def PointerArithChecker : Checker<"PointerArithm">,
Ted Kremenek51885072011-03-24 00:28:47 +0000112 HelpText<"Check for pointer arithmetic on locations other than array elements">,
113 DescFile<"PointerArithChecker">;
114
115def PointerSubChecker : Checker<"PointerSub">,
Ted Kremenek51885072011-03-24 00:28:47 +0000116 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
117 DescFile<"PointerSubChecker">;
118
119def SizeofPointerChecker : Checker<"SizeofPtr">,
Ted Kremenek51885072011-03-24 00:28:47 +0000120 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
121 DescFile<"CheckSizeofPointer.cpp">;
122
123} // end "core.experimental"
124
125//===----------------------------------------------------------------------===//
126// Evaluate "builtin" functions.
127//===----------------------------------------------------------------------===//
128
129let ParentPackage = CoreBuiltin in {
130
131def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
132 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
133 DescFile<"NoReturnFunctionChecker.cpp">;
134
135def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
136 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
137 DescFile<"BuiltinFunctionChecker.cpp">;
138
139} // end "core.builtin"
140
141//===----------------------------------------------------------------------===//
142// Uninitialized values checkers.
143//===----------------------------------------------------------------------===//
144
145let ParentPackage = CoreUninitialized in {
146
147def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
148 HelpText<"Check for uninitialized values used as array subscripts">,
149 DescFile<"UndefinedArraySubscriptChecker.cpp">;
150
151def UndefinedAssignmentChecker : Checker<"Assign">,
152 HelpText<"Check for assigning uninitialized values">,
153 DescFile<"UndefinedAssignmentChecker.cpp">;
154
155def UndefBranchChecker : Checker<"Branch">,
156 HelpText<"Check for uninitialized values used as branch conditions">,
157 DescFile<"UndefBranchChecker.cpp">;
158
159def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
160 HelpText<"Check for blocks that capture uninitialized values">,
161 DescFile<"UndefCapturedBlockVarChecker.cpp">;
162
163def ReturnUndefChecker : Checker<"UndefReturn">,
164 HelpText<"Check for uninitialized values being returned to the caller">,
165 DescFile<"ReturnUndefChecker.cpp">;
166
167} // end "core.uninitialized"
168
169//===----------------------------------------------------------------------===//
170// C++ checkers.
171//===----------------------------------------------------------------------===//
172
173let ParentPackage = CplusplusExperimental in {
174
Ted Kremenek51885072011-03-24 00:28:47 +0000175def IteratorsChecker : Checker<"Iterators">,
Ted Kremenek51885072011-03-24 00:28:47 +0000176 HelpText<"Check improper uses of STL vector iterators">,
177 DescFile<"IteratorsChecker.cpp">;
178
179} // end: "cplusplus.experimental"
180
181//===----------------------------------------------------------------------===//
182// Deadcode checkers.
183//===----------------------------------------------------------------------===//
184
185let ParentPackage = DeadCode in {
186
187def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekb8030262011-03-26 00:25:42 +0000188 HelpText<"Check for values stored to variables that are never read afterwards">,
Ted Kremenek51885072011-03-24 00:28:47 +0000189 DescFile<"DeadStoresChecker.cpp">;
190
191def IdempotentOperationChecker : Checker<"IdempotentOperations">,
192 HelpText<"Warn about idempotent operations">,
193 DescFile<"IdempotentOperationChecker.cpp">;
194
195} // end DeadCode
196
197let ParentPackage = DeadCodeExperimental in {
198
199def UnreachableCodeChecker : Checker<"UnreachableCode">,
Ted Kremenek51885072011-03-24 00:28:47 +0000200 HelpText<"Check unreachable code">,
201 DescFile<"UnreachableCodeChecker.cpp">;
202
203} // end "deadcode.experimental"
204
205//===----------------------------------------------------------------------===//
206// Security checkers.
207//===----------------------------------------------------------------------===//
208
209let ParentPackage = SecurityExperimental in {
210
211def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
212 HelpText<"Perform quick security API checks that require no data flow">,
213 DescFile<"CheckSecuritySyntaxOnly.cpp">;
214
215def ArrayBoundChecker : Checker<"ArrayBound">,
Ted Kremenek51885072011-03-24 00:28:47 +0000216 HelpText<"Warn about buffer overflows (older checker)">,
217 DescFile<"ArrayBoundChecker.cpp">;
218
219def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
Ted Kremenek51885072011-03-24 00:28:47 +0000220 HelpText<"Warn about buffer overflows (newer checker)">,
221 DescFile<"ArrayBoundCheckerV2.cpp">;
222
223def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
Ted Kremenek51885072011-03-24 00:28:47 +0000224 HelpText<"Check for an out-of-bound pointer being returned to callers">,
225 DescFile<"ReturnPointerRangeChecker.cpp">;
226
Ted Kremenek17f7bdd2011-08-03 20:17:43 +0000227def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
228 HelpText<"Check for overflows in the arguments to malloc()">,
229 DescFile<"MallocOverflowSecurityChecker.cpp">;
230
Ted Kremenek51885072011-03-24 00:28:47 +0000231} // end "security.experimental"
232
233//===----------------------------------------------------------------------===//
234// Unix API checkers.
235//===----------------------------------------------------------------------===//
236
237let ParentPackage = Unix in {
238
239def UnixAPIChecker : Checker<"API">,
240 HelpText<"Check calls to various UNIX/Posix functions">,
241 DescFile<"UnixAPIChecker.cpp">;
242
243} // end "unix"
244
245let ParentPackage = UnixExperimental in {
246
247def ChrootChecker : Checker<"Chroot">,
Ted Kremenek51885072011-03-24 00:28:47 +0000248 HelpText<"Check improper use of chroot">,
249 DescFile<"ChrootChecker.cpp">;
250
Jordy Rose467f7c82011-06-14 01:40:43 +0000251def CStringChecker : Checker<"CString">,
252 HelpText<"Check calls to functions in <string.h>">,
253 DescFile<"CStringChecker.cpp">;
254
Ted Kremenek51885072011-03-24 00:28:47 +0000255def MallocChecker : Checker<"Malloc">,
Ted Kremenek51885072011-03-24 00:28:47 +0000256 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
257 DescFile<"MallocChecker.cpp">;
258
259def PthreadLockChecker : Checker<"PthreadLock">,
Ted Kremenek51885072011-03-24 00:28:47 +0000260 HelpText<"Simple lock -> unlock checker">,
261 DescFile<"PthreadLockChecker.cpp">;
262
263def StreamChecker : Checker<"Stream">,
Ted Kremenek51885072011-03-24 00:28:47 +0000264 HelpText<"Check stream handling functions">,
265 DescFile<"StreamChecker.cpp">;
266
267} // end "unix.experimental"
268
269//===----------------------------------------------------------------------===//
270// Mac OS X, Cocoa, and Core Foundation checkers.
271//===----------------------------------------------------------------------===//
272
273let ParentPackage = OSX in {
274
275def MacOSXAPIChecker : Checker<"API">,
276 InPackage<OSX>,
277 HelpText<"Check for proper uses of various Mac OS X APIs">,
278 DescFile<"MacOSXAPIChecker.cpp">;
279
280def OSAtomicChecker : Checker<"AtomicCAS">,
281 InPackage<OSX>,
282 HelpText<"Evaluate calls to OSAtomic functions">,
283 DescFile<"OSAtomicChecker.cpp">;
284
285} // end "macosx"
286
Anna Zaksf57be282011-08-01 22:40:01 +0000287let ParentPackage = OSXExperimental in {
288
289def MacOSKeychainAPIChecker : Checker<"KeychainAPI">,
Anna Zakse68b5f12011-08-02 17:11:03 +0000290 InPackage<OSXExperimental>,
Anna Zaksf57be282011-08-01 22:40:01 +0000291 HelpText<"Check for proper uses of Secure Keychain APIs">,
292 DescFile<"MacOSKeychainAPIChecker.cpp">;
293
294} // end "osx.experimental"
295
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000296let ParentPackage = Cocoa in {
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +0000297
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000298def ObjCAtSyncChecker : Checker<"AtSync">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000299 HelpText<"Check for null pointers used as mutexes for @synchronized">,
300 DescFile<"ObjCAtSyncChecker.cpp">;
301
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000302def NilArgChecker : Checker<"NilArg">,
303 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
304 DescFile<"BasicObjCFoundationChecks.cpp">;
305
306def ClassReleaseChecker : Checker<"ClassRelease">,
307 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
308 DescFile<"BasicObjCFoundationChecks.cpp">;
309
Anders Carlsson4597b7b2011-03-13 20:35:21 +0000310def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
311 HelpText<"Check for passing non-Objective-C types to variadic methods that expect"
312 "only Objective-C types">,
313 DescFile<"BasicObjCFoundationChecks.cpp">;
314
Ted Kremenekb8d545c2011-02-25 22:19:14 +0000315def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
Ted Kremenek51885072011-03-24 00:28:47 +0000316 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000317 DescFile<"NSAutoreleasePoolChecker.cpp">;
318
Ted Kremenek51885072011-03-24 00:28:47 +0000319def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000320 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
321 DescFile<"CheckObjCInstMethSignature.cpp">;
322
323def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
324 HelpText<"Warn about private ivars that are never used">,
325 DescFile<"ObjCUnusedIVarsChecker.cpp">;
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000326
327def NSErrorChecker : Checker<"NSError">,
328 HelpText<"Check usage of NSError** parameters">,
329 DescFile<"NSErrorChecker.cpp">;
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000330
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000331} // end "cocoa"
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000332
Ted Kremenek51885072011-03-24 00:28:47 +0000333let ParentPackage = CocoaExperimental in {
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +0000334
Ted Kremeneka2a3da62011-04-30 06:46:45 +0000335def ObjCSelfInitChecker : Checker<"SelfInit">,
336 HelpText<"Check that 'self' is properly initialized inside an initializer method">,
337 DescFile<"ObjCSelfInitChecker.cpp">;
338
Ted Kremenek51885072011-03-24 00:28:47 +0000339def ObjCDeallocChecker : Checker<"Dealloc">,
Ted Kremenek51885072011-03-24 00:28:47 +0000340 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
341 DescFile<"CheckObjCDealloc.cpp">;
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000342
Ted Kremenek51885072011-03-24 00:28:47 +0000343} // end "cocoa.experimental"
Argyrios Kyrtzidisd84f4222011-02-28 01:28:13 +0000344
Ted Kremenek51885072011-03-24 00:28:47 +0000345let ParentPackage = CoreFoundation in {
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000346
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000347def CFNumberCreateChecker : Checker<"CFNumber">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000348 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000349 DescFile<"BasicObjCFoundationChecks.cpp">;
350
351def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000352 HelpText<"Check for null arguments to CFRetain/CFRelease">,
353 DescFile<"BasicObjCFoundationChecks.cpp">;
354
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000355def CFErrorChecker : Checker<"CFError">,
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000356 HelpText<"Check usage of CFErrorRef* parameters">,
357 DescFile<"NSErrorChecker.cpp">;
Ted Kremenek51885072011-03-24 00:28:47 +0000358}
359
360//===----------------------------------------------------------------------===//
361// Checkers for LLVM development.
362//===----------------------------------------------------------------------===//
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000363
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000364def LLVMConventionsChecker : Checker<"Conventions">,
365 InPackage<LLVM>,
366 HelpText<"Check code for LLVM codebase conventions">,
367 DescFile<"LLVMConventionsChecker.cpp">;
368
Ted Kremenek51885072011-03-24 00:28:47 +0000369//===----------------------------------------------------------------------===//
370// Debugging checkers (for analyzer development).
371//===----------------------------------------------------------------------===//
372
373let ParentPackage = Debug in {
374
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000375def LiveVariablesDumper : Checker<"DumpLiveVars">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000376 HelpText<"Print results of live variable analysis">,
377 DescFile<"DebugCheckers.cpp">;
378
379def CFGViewer : Checker<"ViewCFG">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000380 HelpText<"View Control-Flow Graphs using GraphViz">,
381 DescFile<"DebugCheckers.cpp">;
382
383def CFGDumper : Checker<"DumpCFG">,
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000384 HelpText<"Display Control-Flow Graphs">,
385 DescFile<"DebugCheckers.cpp">;
386
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000387def AnalyzerStatsChecker : Checker<"Stats">,
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000388 HelpText<"Emit warnings with analyzer statistics">,
389 DescFile<"AnalyzerStatsChecker.cpp">;
390
Ted Kremenek51885072011-03-24 00:28:47 +0000391} // end "debug"
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000392