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