Checkers.td revision 033a07e5fca459ed184369cfee7c90d82367a93a 
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 Experimental : Package<"experimental">;
23
24def Core : Package<"core">;
25def CoreBuiltin : Package<"builtin">, InPackage<Core>;
26def CoreUninitialized  : Package<"uninitialized">, InPackage<Core>;
27def CoreExperimental : Package<"core">, InPackage<Experimental>,
28  InGroup<AllExperimental>, Hidden;
29
30def Cplusplus : Package<"cplusplus">;
31def CplusplusExperimental : Package<"cplusplus">, InPackage<Experimental>,
32  InGroup<AllExperimental>, Hidden;
33
34def DeadCode : Package<"deadcode">;
35def DeadCodeExperimental : Package<"deadcode">, InPackage<Experimental>,
36  InGroup<AllExperimental>, Hidden;
37
38def Security : Package <"security">;
39def SecurityExperimental : Package<"security">, InPackage<Experimental>,
40  InGroup<AllExperimental>, Hidden;
41
42def Unix : Package<"unix">;
43def UnixExperimental : Package<"unix">, InPackage<Experimental>,
44  InGroup<AllExperimental>, Hidden;
45
46def OSX : Package<"osx">;
47def OSXExperimental : Package<"osx">, InPackage<Experimental>,
48  InGroup<AllExperimental>, Hidden;
49def Cocoa : Package<"cocoa">, InPackage<OSX>;
50def CocoaExperimental : Package<"cocoa">, InPackage<OSXExperimental>,
51  InGroup<AllExperimental>, Hidden;
52def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
53
54def LLVM : Package<"llvm">;
55def Debug : Package<"debug">;
56
57//===----------------------------------------------------------------------===//
58// Core Checkers.
59//===----------------------------------------------------------------------===//
60
61let 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">,
100  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">,
104  HelpText<"Check for cast from non-struct pointer to struct pointer">,
105  DescFile<"CastToStructChecker.cpp">;
106
107def FixedAddressChecker : Checker<"FixedAddr">,
108  HelpText<"Check for assignment of a fixed address to a pointer">,
109  DescFile<"FixedAddressChecker.cpp">;
110
111def PointerArithChecker : Checker<"PointerArithm">,
112  HelpText<"Check for pointer arithmetic on locations other than array elements">,
113  DescFile<"PointerArithChecker">;
114
115def PointerSubChecker : Checker<"PointerSub">,
116  HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
117  DescFile<"PointerSubChecker">;
118
119def SizeofPointerChecker : Checker<"SizeofPtr">,
120  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
175def IteratorsChecker : Checker<"Iterators">,
176  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">,
188  HelpText<"Check for values stored to variables that are never read afterwards">,
189  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">,
200  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">,
216  HelpText<"Warn about buffer overflows (older checker)">,
217  DescFile<"ArrayBoundChecker.cpp">;  
218
219def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
220  HelpText<"Warn about buffer overflows (newer checker)">,
221  DescFile<"ArrayBoundCheckerV2.cpp">;
222
223def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
224  HelpText<"Check for an out-of-bound pointer being returned to callers">,
225  DescFile<"ReturnPointerRangeChecker.cpp">;
226
227def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
228  HelpText<"Check for overflows in the arguments to malloc()">,
229  DescFile<"MallocOverflowSecurityChecker.cpp">;
230
231} // 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">,
248  HelpText<"Check improper use of chroot">,
249  DescFile<"ChrootChecker.cpp">;
250
251def CStringChecker : Checker<"CString">,
252  HelpText<"Check calls to functions in <string.h>">,
253  DescFile<"CStringChecker.cpp">;
254
255def MallocChecker : Checker<"Malloc">,
256  HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
257  DescFile<"MallocChecker.cpp">;
258
259def PthreadLockChecker : Checker<"PthreadLock">,
260  HelpText<"Simple lock -> unlock checker">,
261  DescFile<"PthreadLockChecker.cpp">;
262
263def StreamChecker : Checker<"Stream">,
264  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
287let ParentPackage = OSXExperimental in {
288
289def MacOSKeychainAPIChecker : Checker<"KeychainAPI">,
290  InPackage<OSXExperimental>,
291  HelpText<"Check for proper uses of Secure Keychain APIs">,
292  DescFile<"MacOSKeychainAPIChecker.cpp">;
293
294} // end "osx.experimental"
295
296let ParentPackage = Cocoa in {
297
298def ObjCAtSyncChecker : Checker<"AtSync">,
299  HelpText<"Check for null pointers used as mutexes for @synchronized">,
300  DescFile<"ObjCAtSyncChecker.cpp">;
301
302def 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
310def 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
315def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
316  HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
317  DescFile<"NSAutoreleasePoolChecker.cpp">;
318
319def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
320  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">;
326 
327def NSErrorChecker : Checker<"NSError">,
328  HelpText<"Check usage of NSError** parameters">,
329  DescFile<"NSErrorChecker.cpp">;
330
331} // end "cocoa"
332
333let ParentPackage = CocoaExperimental in {
334
335def ObjCSelfInitChecker : Checker<"SelfInit">,
336  HelpText<"Check that 'self' is properly initialized inside an initializer method">,
337  DescFile<"ObjCSelfInitChecker.cpp">;
338
339def ObjCDeallocChecker : Checker<"Dealloc">,
340  HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
341  DescFile<"CheckObjCDealloc.cpp">;
342
343} // end "cocoa.experimental"
344
345let ParentPackage = CoreFoundation in {
346
347def CFNumberCreateChecker : Checker<"CFNumber">,
348  HelpText<"Check for proper uses of CFNumberCreate">,
349  DescFile<"BasicObjCFoundationChecks.cpp">;
350
351def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
352  HelpText<"Check for null arguments to CFRetain/CFRelease">,
353  DescFile<"BasicObjCFoundationChecks.cpp">;
354
355def CFErrorChecker : Checker<"CFError">,
356  HelpText<"Check usage of CFErrorRef* parameters">,
357  DescFile<"NSErrorChecker.cpp">;
358}
359
360//===----------------------------------------------------------------------===//
361// Checkers for LLVM development.
362//===----------------------------------------------------------------------===//
363
364def LLVMConventionsChecker : Checker<"Conventions">,
365  InPackage<LLVM>,
366  HelpText<"Check code for LLVM codebase conventions">,
367  DescFile<"LLVMConventionsChecker.cpp">;
368
369//===----------------------------------------------------------------------===//
370// Debugging checkers (for analyzer development).
371//===----------------------------------------------------------------------===//
372
373let ParentPackage = Debug in {
374
375def LiveVariablesDumper : Checker<"DumpLiveVars">,
376  HelpText<"Print results of live variable analysis">,
377  DescFile<"DebugCheckers.cpp">;
378
379def CFGViewer : Checker<"ViewCFG">,
380  HelpText<"View Control-Flow Graphs using GraphViz">,
381  DescFile<"DebugCheckers.cpp">;
382
383def CFGDumper : Checker<"DumpCFG">,
384  HelpText<"Display Control-Flow Graphs">,
385  DescFile<"DebugCheckers.cpp">;
386
387def AnalyzerStatsChecker : Checker<"Stats">,
388  HelpText<"Emit warnings with analyzer statistics">,
389  DescFile<"AnalyzerStatsChecker.cpp">;
390
391} // end "debug"
392
393