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 // The Alpha package is for checkers that have too many false positives to be
17 // turned on by default. The hierarchy under Alpha should be organized in the
18 // hierarchy checkers would have had if they were truly at the top level.
19 // (For example, a Cocoa-specific checker that is alpha should be in
21 def Alpha : Package<"alpha">;
23 def Core : Package<"core">;
24 def CoreBuiltin : Package<"builtin">, InPackage<Core>;
25 def CoreUninitialized : Package<"uninitialized">, InPackage<Core>;
26 def CoreAlpha : Package<"core">, InPackage<Alpha>, Hidden;
28 // The OptIn package is for checkers that are not alpha and that would normally
29 // be on by default but where the driver does not have enough information to
30 // determine when they are applicable. For example, localizability checkers fit
31 // this criterion because the driver cannot determine whether a project is
32 // localized or not -- this is best determined at the IDE or build-system level.
34 // The checker hierarchy under OptIn should mirror that in Alpha: checkers
35 // should be organized as if they were at the top level.
37 // Note: OptIn is *not* intended for checkers that are too noisy to be on by
38 // default. Such checkers belong in the alpha package.
39 def OptIn : Package<"optin">;
41 def Nullability : Package<"nullability">;
43 def Cplusplus : Package<"cplusplus">;
44 def CplusplusAlpha : Package<"cplusplus">, InPackage<Alpha>, Hidden;
45 def CplusplusOptIn : Package<"cplusplus">, InPackage<OptIn>;
47 def Valist : Package<"valist">;
48 def ValistAlpha : Package<"valist">, InPackage<Alpha>, Hidden;
50 def DeadCode : Package<"deadcode">;
51 def DeadCodeAlpha : Package<"deadcode">, InPackage<Alpha>, Hidden;
53 def Performance : Package<"performance">, InPackage<OptIn>;
55 def Security : Package <"security">;
56 def InsecureAPI : Package<"insecureAPI">, InPackage<Security>;
57 def SecurityAlpha : Package<"security">, InPackage<Alpha>, Hidden;
58 def Taint : Package<"taint">, InPackage<SecurityAlpha>, Hidden;
60 def Unix : Package<"unix">;
61 def UnixAlpha : Package<"unix">, InPackage<Alpha>, Hidden;
62 def CString : Package<"cstring">, InPackage<Unix>, Hidden;
63 def CStringAlpha : Package<"cstring">, InPackage<UnixAlpha>, Hidden;
65 def OSX : Package<"osx">;
66 def OSXAlpha : Package<"osx">, InPackage<Alpha>, Hidden;
67 def OSXOptIn : Package<"osx">, InPackage<OptIn>;
69 def Cocoa : Package<"cocoa">, InPackage<OSX>;
70 def CocoaAlpha : Package<"cocoa">, InPackage<OSXAlpha>, Hidden;
71 def CocoaOptIn : Package<"cocoa">, InPackage<OSXOptIn>;
73 def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
74 def Containers : Package<"containers">, InPackage<CoreFoundation>;
76 def LocalizabilityAlpha : Package<"localizability">, InPackage<CocoaAlpha>;
77 def LocalizabilityOptIn : Package<"localizability">, InPackage<CocoaOptIn>;
79 def MPI : Package<"mpi">, InPackage<OptIn>;
81 def LLVM : Package<"llvm">;
83 // The APIModeling package is for checkers that model APIs and don't perform
84 // any diagnostics. These checkers are always turned on; this package is
85 // intended for API modeling that is not controlled by the the target triple.
86 def APIModeling : Package<"apiModeling">, Hidden;
87 def GoogleAPIModeling : Package<"google">, InPackage<APIModeling>;
89 def Debug : Package<"debug">;
91 def CloneDetectionAlpha : Package<"clone">, InPackage<Alpha>, Hidden;
93 //===----------------------------------------------------------------------===//
95 //===----------------------------------------------------------------------===//
97 let ParentPackage = Core in {
99 def DereferenceChecker : Checker<"NullDereference">,
100 HelpText<"Check for dereferences of null pointers">,
101 DescFile<"DereferenceChecker.cpp">;
103 def CallAndMessageChecker : Checker<"CallAndMessage">,
104 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
105 DescFile<"CallAndMessageChecker.cpp">;
107 def NonNullParamChecker : Checker<"NonNullParamChecker">,
108 HelpText<"Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute">,
109 DescFile<"NonNullParamChecker.cpp">;
111 def VLASizeChecker : Checker<"VLASize">,
112 HelpText<"Check for declarations of VLA of undefined or zero size">,
113 DescFile<"VLASizeChecker.cpp">;
115 def DivZeroChecker : Checker<"DivideZero">,
116 HelpText<"Check for division by zero">,
117 DescFile<"DivZeroChecker.cpp">;
119 def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
120 HelpText<"Check for undefined results of binary operators">,
121 DescFile<"UndefResultChecker.cpp">;
123 def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
124 HelpText<"Check that addresses to stack memory do not escape the function">,
125 DescFile<"StackAddrEscapeChecker.cpp">;
127 def DynamicTypePropagation : Checker<"DynamicTypePropagation">,
128 HelpText<"Generate dynamic type information">,
129 DescFile<"DynamicTypePropagation.cpp">;
133 let ParentPackage = CoreAlpha in {
135 def BoolAssignmentChecker : Checker<"BoolAssignment">,
136 HelpText<"Warn about assigning non-{0,1} values to Boolean variables">,
137 DescFile<"BoolAssignmentChecker.cpp">;
139 def CastSizeChecker : Checker<"CastSize">,
140 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
141 DescFile<"CastSizeChecker.cpp">;
143 def CastToStructChecker : Checker<"CastToStruct">,
144 HelpText<"Check for cast from non-struct pointer to struct pointer">,
145 DescFile<"CastToStructChecker.cpp">;
147 def ConversionChecker : Checker<"Conversion">,
148 HelpText<"Loss of sign/precision in implicit conversions">,
149 DescFile<"ConversionChecker.cpp">;
151 def IdenticalExprChecker : Checker<"IdenticalExpr">,
152 HelpText<"Warn about unintended use of identical expressions in operators">,
153 DescFile<"IdenticalExprChecker.cpp">;
155 def FixedAddressChecker : Checker<"FixedAddr">,
156 HelpText<"Check for assignment of a fixed address to a pointer">,
157 DescFile<"FixedAddressChecker.cpp">;
159 def PointerArithChecker : Checker<"PointerArithm">,
160 HelpText<"Check for pointer arithmetic on locations other than array elements">,
161 DescFile<"PointerArithChecker">;
163 def PointerSubChecker : Checker<"PointerSub">,
164 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
165 DescFile<"PointerSubChecker">;
167 def SizeofPointerChecker : Checker<"SizeofPtr">,
168 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
169 DescFile<"CheckSizeofPointer.cpp">;
171 def CallAndMessageUnInitRefArg : Checker<"CallAndMessageUnInitRefArg">,
172 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers, and pointer to undefined variables)">,
173 DescFile<"CallAndMessageChecker.cpp">;
175 def TestAfterDivZeroChecker : Checker<"TestAfterDivZero">,
176 HelpText<"Check for division by variable that is later compared against 0. Either the comparison is useless or there is division by zero.">,
177 DescFile<"TestAfterDivZeroChecker.cpp">;
179 def DynamicTypeChecker : Checker<"DynamicTypeChecker">,
180 HelpText<"Check for cases where the dynamic and the static type of an object are unrelated.">,
181 DescFile<"DynamicTypeChecker.cpp">;
183 } // end "alpha.core"
185 let ParentPackage = Nullability in {
187 def NullPassedToNonnullChecker : Checker<"NullPassedToNonnull">,
188 HelpText<"Warns when a null pointer is passed to a pointer which has a _Nonnull type.">,
189 DescFile<"NullabilityChecker.cpp">;
191 def NullReturnedFromNonnullChecker : Checker<"NullReturnedFromNonnull">,
192 HelpText<"Warns when a null pointer is returned from a function that has _Nonnull return type.">,
193 DescFile<"NullabilityChecker.cpp">;
195 def NullableDereferencedChecker : Checker<"NullableDereferenced">,
196 HelpText<"Warns when a nullable pointer is dereferenced.">,
197 DescFile<"NullabilityChecker.cpp">;
199 def NullablePassedToNonnullChecker : Checker<"NullablePassedToNonnull">,
200 HelpText<"Warns when a nullable pointer is passed to a pointer which has a _Nonnull type.">,
201 DescFile<"NullabilityChecker.cpp">;
203 def NullableReturnedFromNonnullChecker : Checker<"NullableReturnedFromNonnull">,
204 HelpText<"Warns when a nullable pointer is returned from a function that has _Nonnull return type.">,
205 DescFile<"NullabilityChecker.cpp">;
207 } // end "nullability"
209 //===----------------------------------------------------------------------===//
210 // Evaluate "builtin" functions.
211 //===----------------------------------------------------------------------===//
213 let ParentPackage = CoreBuiltin in {
215 def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
216 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
217 DescFile<"NoReturnFunctionChecker.cpp">;
219 def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
220 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
221 DescFile<"BuiltinFunctionChecker.cpp">;
223 } // end "core.builtin"
225 //===----------------------------------------------------------------------===//
226 // Uninitialized values checkers.
227 //===----------------------------------------------------------------------===//
229 let ParentPackage = CoreUninitialized in {
231 def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
232 HelpText<"Check for uninitialized values used as array subscripts">,
233 DescFile<"UndefinedArraySubscriptChecker.cpp">;
235 def UndefinedAssignmentChecker : Checker<"Assign">,
236 HelpText<"Check for assigning uninitialized values">,
237 DescFile<"UndefinedAssignmentChecker.cpp">;
239 def UndefBranchChecker : Checker<"Branch">,
240 HelpText<"Check for uninitialized values used as branch conditions">,
241 DescFile<"UndefBranchChecker.cpp">;
243 def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
244 HelpText<"Check for blocks that capture uninitialized values">,
245 DescFile<"UndefCapturedBlockVarChecker.cpp">;
247 def ReturnUndefChecker : Checker<"UndefReturn">,
248 HelpText<"Check for uninitialized values being returned to the caller">,
249 DescFile<"ReturnUndefChecker.cpp">;
251 } // end "core.uninitialized"
253 //===----------------------------------------------------------------------===//
255 //===----------------------------------------------------------------------===//
257 let ParentPackage = Cplusplus in {
259 def NewDeleteChecker : Checker<"NewDelete">,
260 HelpText<"Check for double-free and use-after-free problems. Traces memory managed by new/delete.">,
261 DescFile<"MallocChecker.cpp">;
263 def NewDeleteLeaksChecker : Checker<"NewDeleteLeaks">,
264 HelpText<"Check for memory leaks. Traces memory managed by new/delete.">,
265 DescFile<"MallocChecker.cpp">;
267 def CXXSelfAssignmentChecker : Checker<"SelfAssignment">,
268 HelpText<"Checks C++ copy and move assignment operators for self assignment">,
269 DescFile<"CXXSelfAssignmentChecker.cpp">;
271 } // end: "cplusplus"
273 let ParentPackage = CplusplusOptIn in {
275 def VirtualCallChecker : Checker<"VirtualCall">,
276 HelpText<"Check virtual function calls during construction or destruction">,
277 DescFile<"VirtualCallChecker.cpp">;
279 } // end: "optin.cplusplus"
282 //===----------------------------------------------------------------------===//
284 //===----------------------------------------------------------------------===//
286 let ParentPackage = ValistAlpha in {
288 def UninitializedChecker : Checker<"Uninitialized">,
289 HelpText<"Check for usages of uninitialized (or already released) va_lists.">,
290 DescFile<"ValistChecker.cpp">;
292 def UnterminatedChecker : Checker<"Unterminated">,
293 HelpText<"Check for va_lists which are not released by a va_end call.">,
294 DescFile<"ValistChecker.cpp">;
296 def CopyToSelfChecker : Checker<"CopyToSelf">,
297 HelpText<"Check for va_lists which are copied onto itself.">,
298 DescFile<"ValistChecker.cpp">;
300 } // end : "alpha.valist"
302 //===----------------------------------------------------------------------===//
303 // Deadcode checkers.
304 //===----------------------------------------------------------------------===//
306 let ParentPackage = DeadCode in {
308 def DeadStoresChecker : Checker<"DeadStores">,
309 HelpText<"Check for values stored to variables that are never read afterwards">,
310 DescFile<"DeadStoresChecker.cpp">;
313 let ParentPackage = DeadCodeAlpha in {
315 def UnreachableCodeChecker : Checker<"UnreachableCode">,
316 HelpText<"Check unreachable code">,
317 DescFile<"UnreachableCodeChecker.cpp">;
319 } // end "alpha.deadcode"
321 //===----------------------------------------------------------------------===//
322 // Performance checkers.
323 //===----------------------------------------------------------------------===//
325 let ParentPackage = Performance in {
327 def PaddingChecker : Checker<"Padding">,
328 HelpText<"Check for excessively padded structs.">,
329 DescFile<"PaddingChecker.cpp">;
333 //===----------------------------------------------------------------------===//
334 // Security checkers.
335 //===----------------------------------------------------------------------===//
337 let ParentPackage = InsecureAPI in {
338 def gets : Checker<"gets">,
339 HelpText<"Warn on uses of the 'gets' function">,
340 DescFile<"CheckSecuritySyntaxOnly.cpp">;
341 def getpw : Checker<"getpw">,
342 HelpText<"Warn on uses of the 'getpw' function">,
343 DescFile<"CheckSecuritySyntaxOnly.cpp">;
344 def mktemp : Checker<"mktemp">,
345 HelpText<"Warn on uses of the 'mktemp' function">,
346 DescFile<"CheckSecuritySyntaxOnly.cpp">;
347 def mkstemp : Checker<"mkstemp">,
348 HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">,
349 DescFile<"CheckSecuritySyntaxOnly.cpp">;
350 def rand : Checker<"rand">,
351 HelpText<"Warn on uses of the 'rand', 'random', and related functions">,
352 DescFile<"CheckSecuritySyntaxOnly.cpp">;
353 def strcpy : Checker<"strcpy">,
354 HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">,
355 DescFile<"CheckSecuritySyntaxOnly.cpp">;
356 def vfork : Checker<"vfork">,
357 HelpText<"Warn on uses of the 'vfork' function">,
358 DescFile<"CheckSecuritySyntaxOnly.cpp">;
359 def UncheckedReturn : Checker<"UncheckedReturn">,
360 HelpText<"Warn on uses of functions whose return values must be always checked">,
361 DescFile<"CheckSecuritySyntaxOnly.cpp">;
363 let ParentPackage = Security in {
364 def FloatLoopCounter : Checker<"FloatLoopCounter">,
365 HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">,
366 DescFile<"CheckSecuritySyntaxOnly.cpp">;
369 let ParentPackage = SecurityAlpha in {
371 def ArrayBoundChecker : Checker<"ArrayBound">,
372 HelpText<"Warn about buffer overflows (older checker)">,
373 DescFile<"ArrayBoundChecker.cpp">;
375 def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
376 HelpText<"Warn about buffer overflows (newer checker)">,
377 DescFile<"ArrayBoundCheckerV2.cpp">;
379 def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
380 HelpText<"Check for an out-of-bound pointer being returned to callers">,
381 DescFile<"ReturnPointerRangeChecker.cpp">;
383 def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
384 HelpText<"Check for overflows in the arguments to malloc()">,
385 DescFile<"MallocOverflowSecurityChecker.cpp">;
387 } // end "alpha.security"
389 //===----------------------------------------------------------------------===//
391 //===----------------------------------------------------------------------===//
393 let ParentPackage = Taint in {
395 def GenericTaintChecker : Checker<"TaintPropagation">,
396 HelpText<"Generate taint information used by other checkers">,
397 DescFile<"GenericTaintChecker.cpp">;
399 } // end "alpha.security.taint"
401 //===----------------------------------------------------------------------===//
402 // Unix API checkers.
403 //===----------------------------------------------------------------------===//
405 let ParentPackage = Unix in {
407 def UnixAPIChecker : Checker<"API">,
408 HelpText<"Check calls to various UNIX/Posix functions">,
409 DescFile<"UnixAPIChecker.cpp">;
411 def MallocChecker: Checker<"Malloc">,
412 HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free().">,
413 DescFile<"MallocChecker.cpp">;
415 def MallocSizeofChecker : Checker<"MallocSizeof">,
416 HelpText<"Check for dubious malloc arguments involving sizeof">,
417 DescFile<"MallocSizeofChecker.cpp">;
419 def MismatchedDeallocatorChecker : Checker<"MismatchedDeallocator">,
420 HelpText<"Check for mismatched deallocators.">,
421 DescFile<"MallocChecker.cpp">;
423 def VforkChecker : Checker<"Vfork">,
424 HelpText<"Check for proper usage of vfork">,
425 DescFile<"VforkChecker.cpp">;
427 def StdCLibraryFunctionsChecker : Checker<"StdCLibraryFunctions">,
428 HelpText<"Improve modeling of the C standard library functions">,
429 DescFile<"StdLibraryFunctionsChecker.cpp">;
433 let ParentPackage = UnixAlpha in {
435 def ChrootChecker : Checker<"Chroot">,
436 HelpText<"Check improper use of chroot">,
437 DescFile<"ChrootChecker.cpp">;
439 def PthreadLockChecker : Checker<"PthreadLock">,
440 HelpText<"Simple lock -> unlock checker">,
441 DescFile<"PthreadLockChecker.cpp">;
443 def StreamChecker : Checker<"Stream">,
444 HelpText<"Check stream handling functions">,
445 DescFile<"StreamChecker.cpp">;
447 def SimpleStreamChecker : Checker<"SimpleStream">,
448 HelpText<"Check for misuses of stream APIs">,
449 DescFile<"SimpleStreamChecker.cpp">;
451 def BlockInCriticalSectionChecker : Checker<"BlockInCriticalSection">,
452 HelpText<"Check for calls to blocking functions inside a critical section">,
453 DescFile<"BlockInCriticalSectionChecker.cpp">;
455 } // end "alpha.unix"
457 let ParentPackage = CString in {
459 def CStringNullArg : Checker<"NullArg">,
460 HelpText<"Check for null pointers being passed as arguments to C string functions">,
461 DescFile<"CStringChecker.cpp">;
463 def CStringSyntaxChecker : Checker<"BadSizeArg">,
464 HelpText<"Check the size argument passed into C string functions for common erroneous patterns">,
465 DescFile<"CStringSyntaxChecker.cpp">;
468 let ParentPackage = CStringAlpha in {
470 def CStringOutOfBounds : Checker<"OutOfBounds">,
471 HelpText<"Check for out-of-bounds access in string functions">,
472 DescFile<"CStringChecker.cpp">;
474 def CStringBufferOverlap : Checker<"BufferOverlap">,
475 HelpText<"Checks for overlap in two buffer arguments">,
476 DescFile<"CStringChecker.cpp">;
478 def CStringNotNullTerm : Checker<"NotNullTerminated">,
479 HelpText<"Check for arguments which are not null-terminating strings">,
480 DescFile<"CStringChecker.cpp">;
483 //===----------------------------------------------------------------------===//
484 // Mac OS X, Cocoa, and Core Foundation checkers.
485 //===----------------------------------------------------------------------===//
487 let ParentPackage = OSX in {
489 def NumberObjectConversionChecker : Checker<"NumberObjectConversion">,
490 HelpText<"Check for erroneous conversions of objects representing numbers into numbers">,
491 DescFile<"NumberObjectConversionChecker.cpp">;
493 def MacOSXAPIChecker : Checker<"API">,
494 HelpText<"Check for proper uses of various Apple APIs">,
495 DescFile<"MacOSXAPIChecker.cpp">;
497 def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">,
498 HelpText<"Check for proper uses of Secure Keychain APIs">,
499 DescFile<"MacOSKeychainAPIChecker.cpp">;
501 def ObjCPropertyChecker : Checker<"ObjCProperty">,
502 HelpText<"Check for proper uses of Objective-C properties">,
503 DescFile<"ObjCPropertyChecker.cpp">;
507 let ParentPackage = Cocoa in {
509 def ObjCAtSyncChecker : Checker<"AtSync">,
510 HelpText<"Check for nil pointers used as mutexes for @synchronized">,
511 DescFile<"ObjCAtSyncChecker.cpp">;
513 def NilArgChecker : Checker<"NilArg">,
514 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
515 DescFile<"BasicObjCFoundationChecks.cpp">;
517 def ClassReleaseChecker : Checker<"ClassRelease">,
518 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
519 DescFile<"BasicObjCFoundationChecks.cpp">;
521 def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
522 HelpText<"Check for passing non-Objective-C types to variadic collection "
523 "initialization methods that expect only Objective-C types">,
524 DescFile<"BasicObjCFoundationChecks.cpp">;
526 def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
527 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
528 DescFile<"NSAutoreleasePoolChecker.cpp">;
530 def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
531 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
532 DescFile<"CheckObjCInstMethSignature.cpp">;
534 def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
535 HelpText<"Warn about private ivars that are never used">,
536 DescFile<"ObjCUnusedIVarsChecker.cpp">;
538 def ObjCSelfInitChecker : Checker<"SelfInit">,
539 HelpText<"Check that 'self' is properly initialized inside an initializer method">,
540 DescFile<"ObjCSelfInitChecker.cpp">;
542 def ObjCLoopChecker : Checker<"Loops">,
543 HelpText<"Improved modeling of loops using Cocoa collection types">,
544 DescFile<"BasicObjCFoundationChecks.cpp">;
546 def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">,
547 HelpText<"Model the APIs that are guaranteed to return a non-nil value">,
548 DescFile<"BasicObjCFoundationChecks.cpp">;
550 def ObjCSuperCallChecker : Checker<"MissingSuperCall">,
551 HelpText<"Warn about Objective-C methods that lack a necessary call to super">,
552 DescFile<"ObjCMissingSuperCallChecker.cpp">;
554 def NSErrorChecker : Checker<"NSError">,
555 HelpText<"Check usage of NSError** parameters">,
556 DescFile<"NSErrorChecker.cpp">;
558 def RetainCountChecker : Checker<"RetainCount">,
559 HelpText<"Check for leaks and improper reference count management">,
560 DescFile<"RetainCountChecker.cpp">;
562 def ObjCGenericsChecker : Checker<"ObjCGenerics">,
563 HelpText<"Check for type errors when using Objective-C generics">,
564 DescFile<"DynamicTypePropagation.cpp">;
566 def ObjCDeallocChecker : Checker<"Dealloc">,
567 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
568 DescFile<"CheckObjCDealloc.cpp">;
570 def ObjCSuperDeallocChecker : Checker<"SuperDealloc">,
571 HelpText<"Warn about improper use of '[super dealloc]' in Objective-C">,
572 DescFile<"ObjCSuperDeallocChecker.cpp">;
576 let ParentPackage = CocoaAlpha in {
578 def InstanceVariableInvalidation : Checker<"InstanceVariableInvalidation">,
579 HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
580 DescFile<"IvarInvalidationChecker.cpp">;
582 def MissingInvalidationMethod : Checker<"MissingInvalidationMethod">,
583 HelpText<"Check that the invalidation methods are present in classes that contain invalidatable instance variables">,
584 DescFile<"IvarInvalidationChecker.cpp">;
586 def DirectIvarAssignment : Checker<"DirectIvarAssignment">,
587 HelpText<"Check for direct assignments to instance variables">,
588 DescFile<"DirectIvarAssignment.cpp">;
590 def DirectIvarAssignmentForAnnotatedFunctions : Checker<"DirectIvarAssignmentForAnnotatedFunctions">,
591 HelpText<"Check for direct assignments to instance variables in the methods annotated with objc_no_direct_instance_variable_assignment">,
592 DescFile<"DirectIvarAssignment.cpp">;
594 } // end "alpha.osx.cocoa"
596 let ParentPackage = CoreFoundation in {
598 def CFNumberChecker : Checker<"CFNumber">,
599 HelpText<"Check for proper uses of CFNumber APIs">,
600 DescFile<"BasicObjCFoundationChecks.cpp">;
602 def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
603 HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">,
604 DescFile<"BasicObjCFoundationChecks.cpp">;
606 def CFErrorChecker : Checker<"CFError">,
607 HelpText<"Check usage of CFErrorRef* parameters">,
608 DescFile<"NSErrorChecker.cpp">;
611 let ParentPackage = Containers in {
612 def ObjCContainersASTChecker : Checker<"PointerSizedValues">,
613 HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">,
614 DescFile<"ObjCContainersASTChecker.cpp">;
616 def ObjCContainersChecker : Checker<"OutOfBounds">,
617 HelpText<"Checks for index out-of-bounds when using 'CFArray' API">,
618 DescFile<"ObjCContainersChecker.cpp">;
622 let ParentPackage = LocalizabilityOptIn in {
623 def NonLocalizedStringChecker : Checker<"NonLocalizedStringChecker">,
624 HelpText<"Warns about uses of non-localized NSStrings passed to UI methods expecting localized NSStrings">,
625 DescFile<"LocalizationChecker.cpp">;
627 def EmptyLocalizationContextChecker : Checker<"EmptyLocalizationContextChecker">,
628 HelpText<"Check that NSLocalizedString macros include a comment for context">,
629 DescFile<"LocalizationChecker.cpp">;
632 let ParentPackage = LocalizabilityAlpha in {
633 def PluralMisuseChecker : Checker<"PluralMisuseChecker">,
634 HelpText<"Warns against using one vs. many plural pattern in code when generating localized strings.">,
635 DescFile<"LocalizationChecker.cpp">;
638 let ParentPackage = MPI in {
639 def MPIChecker : Checker<"MPI-Checker">,
640 HelpText<"Checks MPI code">,
641 DescFile<"MPIChecker.cpp">;
644 //===----------------------------------------------------------------------===//
645 // Checkers for LLVM development.
646 //===----------------------------------------------------------------------===//
648 def LLVMConventionsChecker : Checker<"Conventions">,
650 HelpText<"Check code for LLVM codebase conventions">,
651 DescFile<"LLVMConventionsChecker.cpp">;
655 //===----------------------------------------------------------------------===//
656 // Checkers modeling Google APIs.
657 //===----------------------------------------------------------------------===//
659 def GTestChecker : Checker<"GTest">,
660 InPackage<GoogleAPIModeling>,
661 HelpText<"Model gtest assertion APIs">,
662 DescFile<"GTestChecker.cpp">;
664 //===----------------------------------------------------------------------===//
665 // Debugging checkers (for analyzer development).
666 //===----------------------------------------------------------------------===//
668 let ParentPackage = Debug in {
670 def AnalysisOrderChecker : Checker<"AnalysisOrder">,
671 HelpText<"Print callbacks that are called during analysis in order">,
672 DescFile<"AnalysisOrder.cpp">;
674 def DominatorsTreeDumper : Checker<"DumpDominators">,
675 HelpText<"Print the dominance tree for a given CFG">,
676 DescFile<"DebugCheckers.cpp">;
678 def LiveVariablesDumper : Checker<"DumpLiveVars">,
679 HelpText<"Print results of live variable analysis">,
680 DescFile<"DebugCheckers.cpp">;
682 def CFGViewer : Checker<"ViewCFG">,
683 HelpText<"View Control-Flow Graphs using GraphViz">,
684 DescFile<"DebugCheckers.cpp">;
686 def CFGDumper : Checker<"DumpCFG">,
687 HelpText<"Display Control-Flow Graphs">,
688 DescFile<"DebugCheckers.cpp">;
690 def CallGraphViewer : Checker<"ViewCallGraph">,
691 HelpText<"View Call Graph using GraphViz">,
692 DescFile<"DebugCheckers.cpp">;
694 def CallGraphDumper : Checker<"DumpCallGraph">,
695 HelpText<"Display Call Graph">,
696 DescFile<"DebugCheckers.cpp">;
698 def ConfigDumper : Checker<"ConfigDumper">,
699 HelpText<"Dump config table">,
700 DescFile<"DebugCheckers.cpp">;
702 def TraversalDumper : Checker<"DumpTraversal">,
703 HelpText<"Print branch conditions as they are traversed by the engine">,
704 DescFile<"TraversalChecker.cpp">;
706 def CallDumper : Checker<"DumpCalls">,
707 HelpText<"Print calls as they are traversed by the engine">,
708 DescFile<"TraversalChecker.cpp">;
710 def AnalyzerStatsChecker : Checker<"Stats">,
711 HelpText<"Emit warnings with analyzer statistics">,
712 DescFile<"AnalyzerStatsChecker.cpp">;
714 def TaintTesterChecker : Checker<"TaintTest">,
715 HelpText<"Mark tainted symbols as such.">,
716 DescFile<"TaintTesterChecker.cpp">;
718 def ExprInspectionChecker : Checker<"ExprInspection">,
719 HelpText<"Check the analyzer's understanding of expressions">,
720 DescFile<"ExprInspectionChecker.cpp">;
722 def ExplodedGraphViewer : Checker<"ViewExplodedGraph">,
723 HelpText<"View Exploded Graphs using GraphViz">,
724 DescFile<"DebugCheckers.cpp">;
726 def BugHashDumper : Checker<"DumpBugHash">,
727 HelpText<"Dump the bug hash for all statements.">,
728 DescFile<"DebugCheckers.cpp">;
733 //===----------------------------------------------------------------------===//
735 //===----------------------------------------------------------------------===//
737 let ParentPackage = CloneDetectionAlpha in {
739 def CloneChecker : Checker<"CloneChecker">,
740 HelpText<"Reports similar pieces of code.">,
741 DescFile<"CloneChecker.cpp">;