1 //===--- Checkers.td - Static Analyzer Checkers -===-----------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 include "clang/StaticAnalyzer/Checkers/CheckerBase.td"
12 //===----------------------------------------------------------------------===//
14 //===----------------------------------------------------------------------===//
16 def Alpha : Package<"alpha">;
18 def Core : Package<"core">;
19 def CoreBuiltin : Package<"builtin">, InPackage<Core>;
20 def CoreUninitialized : Package<"uninitialized">, InPackage<Core>;
21 def CoreAlpha : Package<"core">, InPackage<Alpha>, Hidden;
23 def Cplusplus : Package<"cplusplus">;
24 def CplusplusAlpha : Package<"cplusplus">, InPackage<Alpha>, Hidden;
26 def DeadCode : Package<"deadcode">;
27 def DeadCodeAlpha : Package<"deadcode">, InPackage<Alpha>, Hidden;
29 def Security : Package <"security">;
30 def InsecureAPI : Package<"insecureAPI">, InPackage<Security>;
31 def SecurityAlpha : Package<"security">, InPackage<Alpha>, Hidden;
32 def Taint : Package<"taint">, InPackage<SecurityAlpha>, Hidden;
34 def Unix : Package<"unix">;
35 def UnixAlpha : Package<"unix">, InPackage<Alpha>, Hidden;
36 def CString : Package<"cstring">, InPackage<Unix>, Hidden;
37 def CStringAlpha : Package<"cstring">, InPackage<UnixAlpha>, Hidden;
39 def OSX : Package<"osx">;
40 def OSXAlpha : Package<"osx">, InPackage<Alpha>, Hidden;
41 def Cocoa : Package<"cocoa">, InPackage<OSX>;
42 def CocoaAlpha : Package<"cocoa">, InPackage<OSXAlpha>, Hidden;
43 def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
44 def Containers : Package<"containers">, InPackage<CoreFoundation>;
46 def LLVM : Package<"llvm">;
47 def Debug : Package<"debug">;
49 //===----------------------------------------------------------------------===//
51 //===----------------------------------------------------------------------===//
53 let ParentPackage = Core in {
55 def DereferenceChecker : Checker<"NullDereference">,
56 HelpText<"Check for dereferences of null pointers">,
57 DescFile<"DereferenceChecker.cpp">;
59 def CallAndMessageChecker : Checker<"CallAndMessage">,
60 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
61 DescFile<"CallAndMessageChecker.cpp">;
63 def AttrNonNullChecker : Checker<"AttributeNonNull">,
64 HelpText<"Check for null pointers passed as arguments to a function whose arguments are marked with the 'nonnull' attribute">,
65 DescFile<"AttrNonNullChecker.cpp">;
67 def VLASizeChecker : Checker<"VLASize">,
68 HelpText<"Check for declarations of VLA of undefined or zero size">,
69 DescFile<"VLASizeChecker.cpp">;
71 def DivZeroChecker : Checker<"DivideZero">,
72 HelpText<"Check for division by zero">,
73 DescFile<"DivZeroChecker.cpp">;
75 def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
76 HelpText<"Check for undefined results of binary operators">,
77 DescFile<"UndefResultChecker.cpp">;
79 def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
80 HelpText<"Check that addresses to stack memory do not escape the function">,
81 DescFile<"StackAddrEscapeChecker.cpp">;
83 def DynamicTypePropagation : Checker<"DynamicTypePropagation">,
84 HelpText<"Generate dynamic type information">,
85 DescFile<"DynamicTypePropagation.cpp">;
89 let ParentPackage = CoreAlpha in {
91 def BoolAssignmentChecker : Checker<"BoolAssignment">,
92 HelpText<"Warn about assigning non-{0,1} values to Boolean variables">,
93 DescFile<"BoolAssignmentChecker.cpp">;
95 def CastSizeChecker : Checker<"CastSize">,
96 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
97 DescFile<"CastSizeChecker.cpp">;
99 def CastToStructChecker : Checker<"CastToStruct">,
100 HelpText<"Check for cast from non-struct pointer to struct pointer">,
101 DescFile<"CastToStructChecker.cpp">;
103 def FixedAddressChecker : Checker<"FixedAddr">,
104 HelpText<"Check for assignment of a fixed address to a pointer">,
105 DescFile<"FixedAddressChecker.cpp">;
107 def PointerArithChecker : Checker<"PointerArithm">,
108 HelpText<"Check for pointer arithmetic on locations other than array elements">,
109 DescFile<"PointerArithChecker">;
111 def PointerSubChecker : Checker<"PointerSub">,
112 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
113 DescFile<"PointerSubChecker">;
115 def SizeofPointerChecker : Checker<"SizeofPtr">,
116 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
117 DescFile<"CheckSizeofPointer.cpp">;
119 } // end "alpha.core"
121 //===----------------------------------------------------------------------===//
122 // Evaluate "builtin" functions.
123 //===----------------------------------------------------------------------===//
125 let ParentPackage = CoreBuiltin in {
127 def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
128 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
129 DescFile<"NoReturnFunctionChecker.cpp">;
131 def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
132 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
133 DescFile<"BuiltinFunctionChecker.cpp">;
135 } // end "core.builtin"
137 //===----------------------------------------------------------------------===//
138 // Uninitialized values checkers.
139 //===----------------------------------------------------------------------===//
141 let ParentPackage = CoreUninitialized in {
143 def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
144 HelpText<"Check for uninitialized values used as array subscripts">,
145 DescFile<"UndefinedArraySubscriptChecker.cpp">;
147 def UndefinedAssignmentChecker : Checker<"Assign">,
148 HelpText<"Check for assigning uninitialized values">,
149 DescFile<"UndefinedAssignmentChecker.cpp">;
151 def UndefBranchChecker : Checker<"Branch">,
152 HelpText<"Check for uninitialized values used as branch conditions">,
153 DescFile<"UndefBranchChecker.cpp">;
155 def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
156 HelpText<"Check for blocks that capture uninitialized values">,
157 DescFile<"UndefCapturedBlockVarChecker.cpp">;
159 def ReturnUndefChecker : Checker<"UndefReturn">,
160 HelpText<"Check for uninitialized values being returned to the caller">,
161 DescFile<"ReturnUndefChecker.cpp">;
163 } // end "core.uninitialized"
165 //===----------------------------------------------------------------------===//
167 //===----------------------------------------------------------------------===//
169 let ParentPackage = CplusplusAlpha in {
171 def VirtualCallChecker : Checker<"VirtualCall">,
172 HelpText<"Check virtual function calls during construction or destruction">,
173 DescFile<"VirtualCallChecker.cpp">;
175 } // end: "alpha.cplusplus"
177 //===----------------------------------------------------------------------===//
178 // Deadcode checkers.
179 //===----------------------------------------------------------------------===//
181 let ParentPackage = DeadCode in {
183 def DeadStoresChecker : Checker<"DeadStores">,
184 HelpText<"Check for values stored to variables that are never read afterwards">,
185 DescFile<"DeadStoresChecker.cpp">;
188 let ParentPackage = DeadCodeAlpha in {
190 def IdempotentOperationChecker : Checker<"IdempotentOperations">,
191 HelpText<"Warn about idempotent operations">,
192 DescFile<"IdempotentOperationChecker.cpp">;
194 def UnreachableCodeChecker : Checker<"UnreachableCode">,
195 HelpText<"Check unreachable code">,
196 DescFile<"UnreachableCodeChecker.cpp">;
198 } // end "alpha.deadcode"
200 //===----------------------------------------------------------------------===//
201 // Security checkers.
202 //===----------------------------------------------------------------------===//
204 let ParentPackage = InsecureAPI in {
205 def gets : Checker<"gets">,
206 HelpText<"Warn on uses of the 'gets' function">,
207 DescFile<"CheckSecuritySyntaxOnly.cpp">;
208 def getpw : Checker<"getpw">,
209 HelpText<"Warn on uses of the 'getpw' function">,
210 DescFile<"CheckSecuritySyntaxOnly.cpp">;
211 def mktemp : Checker<"mktemp">,
212 HelpText<"Warn on uses of the 'mktemp' function">,
213 DescFile<"CheckSecuritySyntaxOnly.cpp">;
214 def mkstemp : Checker<"mkstemp">,
215 HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">,
216 DescFile<"CheckSecuritySyntaxOnly.cpp">;
217 def rand : Checker<"rand">,
218 HelpText<"Warn on uses of the 'rand', 'random', and related functions">,
219 DescFile<"CheckSecuritySyntaxOnly.cpp">;
220 def strcpy : Checker<"strcpy">,
221 HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">,
222 DescFile<"CheckSecuritySyntaxOnly.cpp">;
223 def vfork : Checker<"vfork">,
224 HelpText<"Warn on uses of the 'vfork' function">,
225 DescFile<"CheckSecuritySyntaxOnly.cpp">;
226 def UncheckedReturn : Checker<"UncheckedReturn">,
227 HelpText<"Warn on uses of functions whose return values must be always checked">,
228 DescFile<"CheckSecuritySyntaxOnly.cpp">;
230 let ParentPackage = Security in {
231 def FloatLoopCounter : Checker<"FloatLoopCounter">,
232 HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">,
233 DescFile<"CheckSecuritySyntaxOnly.cpp">;
236 let ParentPackage = SecurityAlpha in {
238 def ArrayBoundChecker : Checker<"ArrayBound">,
239 HelpText<"Warn about buffer overflows (older checker)">,
240 DescFile<"ArrayBoundChecker.cpp">;
242 def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
243 HelpText<"Warn about buffer overflows (newer checker)">,
244 DescFile<"ArrayBoundCheckerV2.cpp">;
246 def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
247 HelpText<"Check for an out-of-bound pointer being returned to callers">,
248 DescFile<"ReturnPointerRangeChecker.cpp">;
250 def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
251 HelpText<"Check for overflows in the arguments to malloc()">,
252 DescFile<"MallocOverflowSecurityChecker.cpp">;
254 } // end "alpha.security"
256 //===----------------------------------------------------------------------===//
258 //===----------------------------------------------------------------------===//
260 let ParentPackage = Taint in {
262 def GenericTaintChecker : Checker<"TaintPropagation">,
263 HelpText<"Generate taint information used by other checkers">,
264 DescFile<"GenericTaintChecker.cpp">;
266 } // end "alpha.security.taint"
268 //===----------------------------------------------------------------------===//
269 // Unix API checkers.
270 //===----------------------------------------------------------------------===//
272 let ParentPackage = Unix in {
274 def UnixAPIChecker : Checker<"API">,
275 HelpText<"Check calls to various UNIX/Posix functions">,
276 DescFile<"UnixAPIChecker.cpp">;
278 def MallocPessimistic : Checker<"Malloc">,
279 HelpText<"Check for memory leaks, double free, and use-after-free problems.">,
280 DescFile<"MallocChecker.cpp">;
282 def MallocSizeofChecker : Checker<"MallocSizeof">,
283 HelpText<"Check for dubious malloc arguments involving sizeof">,
284 DescFile<"MallocSizeofChecker.cpp">;
288 let ParentPackage = UnixAlpha in {
290 def ChrootChecker : Checker<"Chroot">,
291 HelpText<"Check improper use of chroot">,
292 DescFile<"ChrootChecker.cpp">;
294 def MallocOptimistic : Checker<"MallocWithAnnotations">,
295 HelpText<"Check for memory leaks, double free, and use-after-free problems. Assumes that all user-defined functions which might free a pointer are annotated.">,
296 DescFile<"MallocChecker.cpp">;
298 def PthreadLockChecker : Checker<"PthreadLock">,
299 HelpText<"Simple lock -> unlock checker">,
300 DescFile<"PthreadLockChecker.cpp">;
302 def StreamChecker : Checker<"Stream">,
303 HelpText<"Check stream handling functions">,
304 DescFile<"StreamChecker.cpp">;
306 def SimpleStreamChecker : Checker<"SimpleStream">,
307 HelpText<"Check for misuses of stream APIs">,
308 DescFile<"SimpleStreamChecker.cpp">;
310 } // end "alpha.unix"
312 let ParentPackage = CString in {
314 def CStringNullArg : Checker<"NullArg">,
315 HelpText<"Check for null pointers being passed as arguments to C string functions">,
316 DescFile<"CStringChecker.cpp">;
318 def CStringSyntaxChecker : Checker<"BadSizeArg">,
319 HelpText<"Check the size argument passed into C string functions for common erroneous patterns">,
320 DescFile<"CStringSyntaxChecker.cpp">;
323 let ParentPackage = CStringAlpha in {
325 def CStringOutOfBounds : Checker<"OutOfBounds">,
326 HelpText<"Check for out-of-bounds access in string functions">,
327 DescFile<"CStringChecker.cpp">;
329 def CStringBufferOverlap : Checker<"BufferOverlap">,
330 HelpText<"Checks for overlap in two buffer arguments">,
331 DescFile<"CStringChecker.cpp">;
333 def CStringNotNullTerm : Checker<"NotNullTerminated">,
334 HelpText<"Check for arguments which are not null-terminating strings">,
335 DescFile<"CStringChecker.cpp">;
338 //===----------------------------------------------------------------------===//
339 // Mac OS X, Cocoa, and Core Foundation checkers.
340 //===----------------------------------------------------------------------===//
342 let ParentPackage = OSX in {
344 def MacOSXAPIChecker : Checker<"API">,
346 HelpText<"Check for proper uses of various Mac OS X APIs">,
347 DescFile<"MacOSXAPIChecker.cpp">;
349 def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">,
351 HelpText<"Check for proper uses of Secure Keychain APIs">,
352 DescFile<"MacOSKeychainAPIChecker.cpp">;
356 let ParentPackage = Cocoa in {
358 def ObjCAtSyncChecker : Checker<"AtSync">,
359 HelpText<"Check for nil pointers used as mutexes for @synchronized">,
360 DescFile<"ObjCAtSyncChecker.cpp">;
362 def NilArgChecker : Checker<"NilArg">,
363 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
364 DescFile<"BasicObjCFoundationChecks.cpp">;
366 def ClassReleaseChecker : Checker<"ClassRelease">,
367 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
368 DescFile<"BasicObjCFoundationChecks.cpp">;
370 def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
371 HelpText<"Check for passing non-Objective-C types to variadic collection "
372 "initialization methods that expect only Objective-C types">,
373 DescFile<"BasicObjCFoundationChecks.cpp">;
375 def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
376 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
377 DescFile<"NSAutoreleasePoolChecker.cpp">;
379 def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
380 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
381 DescFile<"CheckObjCInstMethSignature.cpp">;
383 def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
384 HelpText<"Warn about private ivars that are never used">,
385 DescFile<"ObjCUnusedIVarsChecker.cpp">;
387 def ObjCSelfInitChecker : Checker<"SelfInit">,
388 HelpText<"Check that 'self' is properly initialized inside an initializer method">,
389 DescFile<"ObjCSelfInitChecker.cpp">;
391 def ObjCLoopChecker : Checker<"Loops">,
392 HelpText<"Improved modeling of loops using Cocoa collection types">,
393 DescFile<"BasicObjCFoundationChecks.cpp">;
395 def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">,
396 HelpText<"Model the APIs that are guaranteed to return a non-nil value">,
397 DescFile<"BasicObjCFoundationChecks.cpp">;
399 def NSErrorChecker : Checker<"NSError">,
400 HelpText<"Check usage of NSError** parameters">,
401 DescFile<"NSErrorChecker.cpp">;
403 def RetainCountChecker : Checker<"RetainCount">,
404 HelpText<"Check for leaks and improper reference count management">,
405 DescFile<"RetainCountChecker.cpp">;
409 let ParentPackage = CocoaAlpha in {
411 def ObjCDeallocChecker : Checker<"Dealloc">,
412 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
413 DescFile<"CheckObjCDealloc.cpp">;
415 def IvarInvalidationChecker : Checker<"InstanceVariableInvalidation">,
416 HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
417 DescFile<"IvarInvalidationChecker.cpp">;
419 def DirectIvarAssignment : Checker<"DirectIvarAssignment">,
420 HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
421 DescFile<"DirectIvarAssignment.cpp">;
423 def ObjCSuperCallChecker : Checker<"MissingSuperCall">,
424 HelpText<"Warn about Objective-C methods that lack a necessary call to super">,
425 DescFile<"ObjCMissingSuperCallChecker.cpp">;
427 } // end "alpha.osx.cocoa"
429 let ParentPackage = CoreFoundation in {
431 def CFNumberCreateChecker : Checker<"CFNumber">,
432 HelpText<"Check for proper uses of CFNumberCreate">,
433 DescFile<"BasicObjCFoundationChecks.cpp">;
435 def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
436 HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">,
437 DescFile<"BasicObjCFoundationChecks.cpp">;
439 def CFErrorChecker : Checker<"CFError">,
440 HelpText<"Check usage of CFErrorRef* parameters">,
441 DescFile<"NSErrorChecker.cpp">;
444 let ParentPackage = Containers in {
445 def ObjCContainersASTChecker : Checker<"PointerSizedValues">,
446 HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">,
447 DescFile<"ObjCContainersASTChecker.cpp">;
449 def ObjCContainersChecker : Checker<"OutOfBounds">,
450 HelpText<"Checks for index out-of-bounds when using 'CFArray' API">,
451 DescFile<"ObjCContainersChecker.cpp">;
454 //===----------------------------------------------------------------------===//
455 // Checkers for LLVM development.
456 //===----------------------------------------------------------------------===//
458 def LLVMConventionsChecker : Checker<"Conventions">,
460 HelpText<"Check code for LLVM codebase conventions">,
461 DescFile<"LLVMConventionsChecker.cpp">;
463 //===----------------------------------------------------------------------===//
464 // Debugging checkers (for analyzer development).
465 //===----------------------------------------------------------------------===//
467 let ParentPackage = Debug in {
469 def DominatorsTreeDumper : Checker<"DumpDominators">,
470 HelpText<"Print the dominance tree for a given CFG">,
471 DescFile<"DebugCheckers.cpp">;
473 def LiveVariablesDumper : Checker<"DumpLiveVars">,
474 HelpText<"Print results of live variable analysis">,
475 DescFile<"DebugCheckers.cpp">;
477 def CFGViewer : Checker<"ViewCFG">,
478 HelpText<"View Control-Flow Graphs using GraphViz">,
479 DescFile<"DebugCheckers.cpp">;
481 def CFGDumper : Checker<"DumpCFG">,
482 HelpText<"Display Control-Flow Graphs">,
483 DescFile<"DebugCheckers.cpp">;
485 def CallGraphViewer : Checker<"ViewCallGraph">,
486 HelpText<"View Call Graph using GraphViz">,
487 DescFile<"DebugCheckers.cpp">;
489 def CallGraphDumper : Checker<"DumpCallGraph">,
490 HelpText<"Display Call Graph">,
491 DescFile<"DebugCheckers.cpp">;
493 def ConfigDumper : Checker<"ConfigDumper">,
494 HelpText<"Dump config table">,
495 DescFile<"DebugCheckers.cpp">;
497 def TraversalDumper : Checker<"DumpTraversal">,
498 HelpText<"Print branch conditions as they are traversed by the engine">,
499 DescFile<"TraversalChecker.cpp">;
501 def CallDumper : Checker<"DumpCalls">,
502 HelpText<"Print calls as they are traversed by the engine">,
503 DescFile<"TraversalChecker.cpp">;
505 def AnalyzerStatsChecker : Checker<"Stats">,
506 HelpText<"Emit warnings with analyzer statistics">,
507 DescFile<"AnalyzerStatsChecker.cpp">;
509 def TaintTesterChecker : Checker<"TaintTest">,
510 HelpText<"Mark tainted symbols as such.">,
511 DescFile<"TaintTesterChecker.cpp">;
513 def ExprInspectionChecker : Checker<"ExprInspection">,
514 HelpText<"Check the analyzer's understanding of expressions">,
515 DescFile<"ExprInspectionChecker.cpp">;