Checkers.td revision f57be289b6040c6c92c026844a70b4f8eaba34f3 
1//===--- 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
12//===----------------------------------------------------------------------===//
13// Groups.
14//===----------------------------------------------------------------------===//
15
16def AllExperimental : CheckerGroup<"all-experimental">;
17
18//===----------------------------------------------------------------------===//
19// Packages.
20//===----------------------------------------------------------------------===//
21
22def Core : Package<"core">;
23def CoreBuiltin : Package<"builtin">, InPackage<Core>;
24def CoreUninitialized  : Package<"uninitialized">, InPackage<Core>;
25def CoreExperimental : Package<"experimental">, InPackage<Core>,
26  InGroup<AllExperimental>, Hidden;
27
28def Cplusplus : Package<"cplusplus">;
29def CplusplusExperimental : Package<"experimental">, InPackage<Cplusplus>,
30  InGroup<AllExperimental>, Hidden;
31
32def DeadCode : Package<"deadcode">;
33def DeadCodeExperimental : Package<"experimental">, InPackage<DeadCode>,
34  InGroup<AllExperimental>, Hidden;
35
36def Security : Package <"security">;
37def SecurityExperimental : Package<"experimental">, InPackage<Security>,
38  InGroup<AllExperimental>, Hidden;
39
40def Unix : Package<"unix">;
41def UnixExperimental : Package<"experimental">, InPackage<Unix>,
42  InGroup<AllExperimental>, Hidden;
43
44def OSX : Package<"osx">;
45def OSXExperimental : Package<"experimental">, InPackage<OSX>,
46  InGroup<AllExperimental>, Hidden;
47def Cocoa : Package<"cocoa">, InPackage<OSX>;
48def CocoaExperimental : Package<"experimental">, InPackage<Cocoa>,
49  InGroup<AllExperimental>, Hidden;
50def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
51
52def LLVM : Package<"llvm">;
53def Debug : Package<"debug">;
54
55//===----------------------------------------------------------------------===//
56// Core Checkers.
57//===----------------------------------------------------------------------===//
58
59let ParentPackage = Core in {
60
61def DereferenceChecker : Checker<"NullDereference">,
62  HelpText<"Check for dereferences of null pointers">,
63  DescFile<"DereferenceChecker.cpp">;
64
65def CallAndMessageChecker : Checker<"CallAndMessage">,
66  HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
67  DescFile<"CallAndMessageChecker.cpp">;
68
69def AdjustedReturnValueChecker : Checker<"AdjustedReturnValue">,
70  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)">,
71  DescFile<"AdjustedReturnValueChecker.cpp">;
72
73def AttrNonNullChecker : Checker<"AttributeNonNull">,
74  HelpText<"Check for null pointers passed as arguments to a function whose arguments are marked with the 'nonnull' attribute">,
75  DescFile<"AttrNonNullChecker.cpp">;
76
77def VLASizeChecker : Checker<"VLASize">,
78  HelpText<"Check for declarations of VLA of undefined or zero size">,
79  DescFile<"VLASizeChecker.cpp">;
80
81def DivZeroChecker : Checker<"DivideZero">,
82  HelpText<"Check for division by zero">,
83  DescFile<"DivZeroChecker.cpp">;
84
85def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
86  HelpText<"Check for undefined results of binary operators">,
87  DescFile<"UndefResultChecker.cpp">;
88
89def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
90  HelpText<"Check that addresses to stack memory do not escape the function">,
91  DescFile<"StackAddrEscapeChecker.cpp">;
92
93} // end "core"
94
95let ParentPackage = CoreExperimental in {
96
97def CastSizeChecker : Checker<"CastSize">,
98  HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
99  DescFile<"CastSizeChecker.cpp">;
100
101def CastToStructChecker : Checker<"CastToStruct">,
102  HelpText<"Check for cast from non-struct pointer to struct pointer">,
103  DescFile<"CastToStructChecker.cpp">;
104
105def FixedAddressChecker : Checker<"FixedAddr">,
106  HelpText<"Check for assignment of a fixed address to a pointer">,
107  DescFile<"FixedAddressChecker.cpp">;
108
109def PointerArithChecker : Checker<"PointerArithm">,
110  HelpText<"Check for pointer arithmetic on locations other than array elements">,
111  DescFile<"PointerArithChecker">;
112
113def PointerSubChecker : Checker<"PointerSub">,
114  HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
115  DescFile<"PointerSubChecker">;
116
117def SizeofPointerChecker : Checker<"SizeofPtr">,
118  HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
119  DescFile<"CheckSizeofPointer.cpp">;
120
121} // end "core.experimental"
122
123//===----------------------------------------------------------------------===//
124// Evaluate "builtin" functions.
125//===----------------------------------------------------------------------===//
126
127let ParentPackage = CoreBuiltin in {
128
129def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
130  HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
131  DescFile<"NoReturnFunctionChecker.cpp">;
132
133def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
134  HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
135  DescFile<"BuiltinFunctionChecker.cpp">;
136
137} // end "core.builtin"
138
139//===----------------------------------------------------------------------===//
140// Uninitialized values checkers.
141//===----------------------------------------------------------------------===//
142
143let ParentPackage = CoreUninitialized in {
144
145def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
146  HelpText<"Check for uninitialized values used as array subscripts">,
147  DescFile<"UndefinedArraySubscriptChecker.cpp">;
148
149def UndefinedAssignmentChecker : Checker<"Assign">,
150  HelpText<"Check for assigning uninitialized values">,
151  DescFile<"UndefinedAssignmentChecker.cpp">;
152
153def UndefBranchChecker : Checker<"Branch">,
154  HelpText<"Check for uninitialized values used as branch conditions">,
155  DescFile<"UndefBranchChecker.cpp">;
156
157def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
158  HelpText<"Check for blocks that capture uninitialized values">,
159  DescFile<"UndefCapturedBlockVarChecker.cpp">;
160  
161def ReturnUndefChecker : Checker<"UndefReturn">,
162  HelpText<"Check for uninitialized values being returned to the caller">,
163  DescFile<"ReturnUndefChecker.cpp">;
164
165} // end "core.uninitialized"
166
167//===----------------------------------------------------------------------===//
168// C++ checkers.
169//===----------------------------------------------------------------------===//
170
171let ParentPackage = CplusplusExperimental in {
172
173def IteratorsChecker : Checker<"Iterators">,
174  HelpText<"Check improper uses of STL vector iterators">,
175  DescFile<"IteratorsChecker.cpp">;
176
177} // end: "cplusplus.experimental"
178
179//===----------------------------------------------------------------------===//
180// Deadcode checkers.
181//===----------------------------------------------------------------------===//
182
183let ParentPackage = DeadCode in {
184
185def DeadStoresChecker : Checker<"DeadStores">,
186  HelpText<"Check for values stored to variables that are never read afterwards">,
187  DescFile<"DeadStoresChecker.cpp">;
188
189def IdempotentOperationChecker : Checker<"IdempotentOperations">,
190  HelpText<"Warn about idempotent operations">,
191  DescFile<"IdempotentOperationChecker.cpp">;
192
193} // end DeadCode
194
195let ParentPackage = DeadCodeExperimental in {
196
197def UnreachableCodeChecker : Checker<"UnreachableCode">,
198  HelpText<"Check unreachable code">,
199  DescFile<"UnreachableCodeChecker.cpp">;
200
201} // end "deadcode.experimental"
202
203//===----------------------------------------------------------------------===//
204// Security checkers.
205//===----------------------------------------------------------------------===//
206
207let ParentPackage = SecurityExperimental in {
208
209def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
210  HelpText<"Perform quick security API checks that require no data flow">,
211  DescFile<"CheckSecuritySyntaxOnly.cpp">;
212
213def ArrayBoundChecker : Checker<"ArrayBound">,
214  HelpText<"Warn about buffer overflows (older checker)">,
215  DescFile<"ArrayBoundChecker.cpp">;  
216
217def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
218  HelpText<"Warn about buffer overflows (newer checker)">,
219  DescFile<"ArrayBoundCheckerV2.cpp">;
220
221def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
222  HelpText<"Check for an out-of-bound pointer being returned to callers">,
223  DescFile<"ReturnPointerRangeChecker.cpp">;
224
225} // end "security.experimental"
226
227//===----------------------------------------------------------------------===//
228// Unix API checkers.
229//===----------------------------------------------------------------------===//
230
231let ParentPackage = Unix in {
232
233def UnixAPIChecker : Checker<"API">,
234  HelpText<"Check calls to various UNIX/Posix functions">,
235  DescFile<"UnixAPIChecker.cpp">;
236  
237} // end "unix"
238
239let ParentPackage = UnixExperimental in {
240
241def ChrootChecker : Checker<"Chroot">,
242  HelpText<"Check improper use of chroot">,
243  DescFile<"ChrootChecker.cpp">;
244
245def CStringChecker : Checker<"CString">,
246  HelpText<"Check calls to functions in <string.h>">,
247  DescFile<"CStringChecker.cpp">;
248
249def MallocChecker : Checker<"Malloc">,
250  HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
251  DescFile<"MallocChecker.cpp">;
252
253def PthreadLockChecker : Checker<"PthreadLock">,
254  HelpText<"Simple lock -> unlock checker">,
255  DescFile<"PthreadLockChecker.cpp">;
256
257def StreamChecker : Checker<"Stream">,
258  HelpText<"Check stream handling functions">,
259  DescFile<"StreamChecker.cpp">;
260
261} // end "unix.experimental"
262
263//===----------------------------------------------------------------------===//
264// Mac OS X, Cocoa, and Core Foundation checkers.
265//===----------------------------------------------------------------------===//
266
267let ParentPackage = OSX in {
268
269def MacOSXAPIChecker : Checker<"API">,
270  InPackage<OSX>,
271  HelpText<"Check for proper uses of various Mac OS X APIs">,
272  DescFile<"MacOSXAPIChecker.cpp">;
273
274def OSAtomicChecker : Checker<"AtomicCAS">,
275  InPackage<OSX>,
276  HelpText<"Evaluate calls to OSAtomic functions">,
277  DescFile<"OSAtomicChecker.cpp">;
278
279} // end "macosx"
280
281let ParentPackage = OSXExperimental in {
282
283def MacOSKeychainAPIChecker : Checker<"KeychainAPI">,
284  InPackage<OSX>,
285  HelpText<"Check for proper uses of Secure Keychain APIs">,
286  DescFile<"MacOSKeychainAPIChecker.cpp">;
287
288} // end "osx.experimental"
289
290let ParentPackage = Cocoa in {
291
292def ObjCAtSyncChecker : Checker<"AtSync">,
293  HelpText<"Check for null pointers used as mutexes for @synchronized">,
294  DescFile<"ObjCAtSyncChecker.cpp">;
295
296def NilArgChecker : Checker<"NilArg">,
297  HelpText<"Check for prohibited nil arguments to ObjC method calls">,
298  DescFile<"BasicObjCFoundationChecks.cpp">;
299
300def ClassReleaseChecker : Checker<"ClassRelease">,
301  HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
302  DescFile<"BasicObjCFoundationChecks.cpp">;
303
304def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
305  HelpText<"Check for passing non-Objective-C types to variadic methods that expect"
306           "only Objective-C types">,
307  DescFile<"BasicObjCFoundationChecks.cpp">;
308
309def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
310  HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
311  DescFile<"NSAutoreleasePoolChecker.cpp">;
312
313def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
314  HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
315  DescFile<"CheckObjCInstMethSignature.cpp">;
316
317def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
318  HelpText<"Warn about private ivars that are never used">,
319  DescFile<"ObjCUnusedIVarsChecker.cpp">;
320 
321def NSErrorChecker : Checker<"NSError">,
322  HelpText<"Check usage of NSError** parameters">,
323  DescFile<"NSErrorChecker.cpp">;
324
325} // end "cocoa"
326
327let ParentPackage = CocoaExperimental in {
328
329def ObjCSelfInitChecker : Checker<"SelfInit">,
330  HelpText<"Check that 'self' is properly initialized inside an initializer method">,
331  DescFile<"ObjCSelfInitChecker.cpp">;
332
333def ObjCDeallocChecker : Checker<"Dealloc">,
334  HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
335  DescFile<"CheckObjCDealloc.cpp">;
336
337} // end "cocoa.experimental"
338
339let ParentPackage = CoreFoundation in {
340
341def CFNumberCreateChecker : Checker<"CFNumber">,
342  HelpText<"Check for proper uses of CFNumberCreate">,
343  DescFile<"BasicObjCFoundationChecks.cpp">;
344
345def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
346  HelpText<"Check for null arguments to CFRetain/CFRelease">,
347  DescFile<"BasicObjCFoundationChecks.cpp">;
348
349def CFErrorChecker : Checker<"CFError">,
350  HelpText<"Check usage of CFErrorRef* parameters">,
351  DescFile<"NSErrorChecker.cpp">;
352}
353
354//===----------------------------------------------------------------------===//
355// Checkers for LLVM development.
356//===----------------------------------------------------------------------===//
357
358def LLVMConventionsChecker : Checker<"Conventions">,
359  InPackage<LLVM>,
360  HelpText<"Check code for LLVM codebase conventions">,
361  DescFile<"LLVMConventionsChecker.cpp">;
362
363//===----------------------------------------------------------------------===//
364// Debugging checkers (for analyzer development).
365//===----------------------------------------------------------------------===//
366
367let ParentPackage = Debug in {
368
369def LiveVariablesDumper : Checker<"DumpLiveVars">,
370  HelpText<"Print results of live variable analysis">,
371  DescFile<"DebugCheckers.cpp">;
372
373def CFGViewer : Checker<"ViewCFG">,
374  HelpText<"View Control-Flow Graphs using GraphViz">,
375  DescFile<"DebugCheckers.cpp">;
376
377def CFGDumper : Checker<"DumpCFG">,
378  HelpText<"Display Control-Flow Graphs">,
379  DescFile<"DebugCheckers.cpp">;
380
381def AnalyzerStatsChecker : Checker<"Stats">,
382  HelpText<"Emit warnings with analyzer statistics">,
383  DescFile<"AnalyzerStatsChecker.cpp">;
384
385} // end "debug"
386
387