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 // In the Portability package reside checkers for finding code that relies on
42 // implementation-defined behavior. Such checks are wanted for cross-platform
43 // development, but unwanted for developers who target only a single platform.
44 def PortabilityOptIn : Package<"portability">, InPackage<OptIn>;
46 def Nullability : Package<"nullability">;
48 def Cplusplus : Package<"cplusplus">;
49 def CplusplusAlpha : Package<"cplusplus">, InPackage<Alpha>, Hidden;
50 def CplusplusOptIn : Package<"cplusplus">, InPackage<OptIn>;
52 def Valist : Package<"valist">;
54 def DeadCode : Package<"deadcode">;
55 def DeadCodeAlpha : Package<"deadcode">, InPackage<Alpha>, Hidden;
57 def Performance : Package<"performance">, InPackage<OptIn>;
59 def Security : Package <"security">;
60 def InsecureAPI : Package<"insecureAPI">, InPackage<Security>;
61 def SecurityAlpha : Package<"security">, InPackage<Alpha>, Hidden;
62 def Taint : Package<"taint">, InPackage<SecurityAlpha>, Hidden;
64 def Unix : Package<"unix">;
65 def UnixAlpha : Package<"unix">, InPackage<Alpha>, Hidden;
66 def CString : Package<"cstring">, InPackage<Unix>, Hidden;
67 def CStringAlpha : Package<"cstring">, InPackage<UnixAlpha>, Hidden;
69 def OSX : Package<"osx">;
70 def OSXAlpha : Package<"osx">, InPackage<Alpha>, Hidden;
71 def OSXOptIn : Package<"osx">, InPackage<OptIn>;
73 def Cocoa : Package<"cocoa">, InPackage<OSX>;
74 def CocoaAlpha : Package<"cocoa">, InPackage<OSXAlpha>, Hidden;
75 def CocoaOptIn : Package<"cocoa">, InPackage<OSXOptIn>;
77 def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
78 def Containers : Package<"containers">, InPackage<CoreFoundation>;
80 def LocalizabilityAlpha : Package<"localizability">, InPackage<CocoaAlpha>;
81 def LocalizabilityOptIn : Package<"localizability">, InPackage<CocoaOptIn>;
83 def MPI : Package<"mpi">, InPackage<OptIn>;
85 def LLVM : Package<"llvm">;
87 // The APIModeling package is for checkers that model APIs and don't perform
88 // any diagnostics. These checkers are always turned on; this package is
89 // intended for API modeling that is not controlled by the the target triple.
90 def APIModeling : Package<"apiModeling">, Hidden;
91 def GoogleAPIModeling : Package<"google">, InPackage<APIModeling>;
93 def Debug : Package<"debug">;
95 def CloneDetectionAlpha : Package<"clone">, InPackage<Alpha>, Hidden;
97 //===----------------------------------------------------------------------===//
99 //===----------------------------------------------------------------------===//
101 let ParentPackage = Core in {
103 def DereferenceChecker : Checker<"NullDereference">,
104 HelpText<"Check for dereferences of null pointers">,
105 DescFile<"DereferenceChecker.cpp">;
107 def CallAndMessageChecker : Checker<"CallAndMessage">,
108 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
109 DescFile<"CallAndMessageChecker.cpp">;
111 def NonNullParamChecker : Checker<"NonNullParamChecker">,
112 HelpText<"Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute">,
113 DescFile<"NonNullParamChecker.cpp">;
115 def VLASizeChecker : Checker<"VLASize">,
116 HelpText<"Check for declarations of VLA of undefined or zero size">,
117 DescFile<"VLASizeChecker.cpp">;
119 def DivZeroChecker : Checker<"DivideZero">,
120 HelpText<"Check for division by zero">,
121 DescFile<"DivZeroChecker.cpp">;
123 def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
124 HelpText<"Check for undefined results of binary operators">,
125 DescFile<"UndefResultChecker.cpp">;
127 def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
128 HelpText<"Check that addresses to stack memory do not escape the function">,
129 DescFile<"StackAddrEscapeChecker.cpp">;
131 def DynamicTypePropagation : Checker<"DynamicTypePropagation">,
132 HelpText<"Generate dynamic type information">,
133 DescFile<"DynamicTypePropagation.cpp">;
135 def NonnullGlobalConstantsChecker: Checker<"NonnilStringConstants">,
136 HelpText<"Assume that const string-like globals are non-null">,
137 DescFile<"NonilStringConstantsChecker.cpp">;
141 let ParentPackage = CoreAlpha in {
143 def BoolAssignmentChecker : Checker<"BoolAssignment">,
144 HelpText<"Warn about assigning non-{0,1} values to Boolean variables">,
145 DescFile<"BoolAssignmentChecker.cpp">;
147 def CastSizeChecker : Checker<"CastSize">,
148 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
149 DescFile<"CastSizeChecker.cpp">;
151 def CastToStructChecker : Checker<"CastToStruct">,
152 HelpText<"Check for cast from non-struct pointer to struct pointer">,
153 DescFile<"CastToStructChecker.cpp">;
155 def ConversionChecker : Checker<"Conversion">,
156 HelpText<"Loss of sign/precision in implicit conversions">,
157 DescFile<"ConversionChecker.cpp">;
159 def IdenticalExprChecker : Checker<"IdenticalExpr">,
160 HelpText<"Warn about unintended use of identical expressions in operators">,
161 DescFile<"IdenticalExprChecker.cpp">;
163 def FixedAddressChecker : Checker<"FixedAddr">,
164 HelpText<"Check for assignment of a fixed address to a pointer">,
165 DescFile<"FixedAddressChecker.cpp">;
167 def PointerArithChecker : Checker<"PointerArithm">,
168 HelpText<"Check for pointer arithmetic on locations other than array elements">,
169 DescFile<"PointerArithChecker">;
171 def PointerSubChecker : Checker<"PointerSub">,
172 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
173 DescFile<"PointerSubChecker">;
175 def SizeofPointerChecker : Checker<"SizeofPtr">,
176 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
177 DescFile<"CheckSizeofPointer.cpp">;
179 def CallAndMessageUnInitRefArg : Checker<"CallAndMessageUnInitRefArg">,
180 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)">,
181 DescFile<"CallAndMessageChecker.cpp">;
183 def TestAfterDivZeroChecker : Checker<"TestAfterDivZero">,
184 HelpText<"Check for division by variable that is later compared against 0. Either the comparison is useless or there is division by zero.">,
185 DescFile<"TestAfterDivZeroChecker.cpp">;
187 def DynamicTypeChecker : Checker<"DynamicTypeChecker">,
188 HelpText<"Check for cases where the dynamic and the static type of an object are unrelated.">,
189 DescFile<"DynamicTypeChecker.cpp">;
191 def StackAddrAsyncEscapeChecker : Checker<"StackAddressAsyncEscape">,
192 HelpText<"Check that addresses to stack memory do not escape the function">,
193 DescFile<"StackAddrEscapeChecker.cpp">;
195 } // end "alpha.core"
197 let ParentPackage = Nullability in {
199 def NullPassedToNonnullChecker : Checker<"NullPassedToNonnull">,
200 HelpText<"Warns when a null pointer is passed to a pointer which has a _Nonnull type.">,
201 DescFile<"NullabilityChecker.cpp">;
203 def NullReturnedFromNonnullChecker : Checker<"NullReturnedFromNonnull">,
204 HelpText<"Warns when a null pointer is returned from a function that has _Nonnull return type.">,
205 DescFile<"NullabilityChecker.cpp">;
207 def NullableDereferencedChecker : Checker<"NullableDereferenced">,
208 HelpText<"Warns when a nullable pointer is dereferenced.">,
209 DescFile<"NullabilityChecker.cpp">;
211 def NullablePassedToNonnullChecker : Checker<"NullablePassedToNonnull">,
212 HelpText<"Warns when a nullable pointer is passed to a pointer which has a _Nonnull type.">,
213 DescFile<"NullabilityChecker.cpp">;
215 def NullableReturnedFromNonnullChecker : Checker<"NullableReturnedFromNonnull">,
216 HelpText<"Warns when a nullable pointer is returned from a function that has _Nonnull return type.">,
217 DescFile<"NullabilityChecker.cpp">;
219 } // end "nullability"
221 //===----------------------------------------------------------------------===//
222 // Evaluate "builtin" functions.
223 //===----------------------------------------------------------------------===//
225 let ParentPackage = CoreBuiltin in {
227 def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
228 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
229 DescFile<"NoReturnFunctionChecker.cpp">;
231 def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
232 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
233 DescFile<"BuiltinFunctionChecker.cpp">;
235 } // end "core.builtin"
237 //===----------------------------------------------------------------------===//
238 // Uninitialized values checkers.
239 //===----------------------------------------------------------------------===//
241 let ParentPackage = CoreUninitialized in {
243 def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
244 HelpText<"Check for uninitialized values used as array subscripts">,
245 DescFile<"UndefinedArraySubscriptChecker.cpp">;
247 def UndefinedAssignmentChecker : Checker<"Assign">,
248 HelpText<"Check for assigning uninitialized values">,
249 DescFile<"UndefinedAssignmentChecker.cpp">;
251 def UndefBranchChecker : Checker<"Branch">,
252 HelpText<"Check for uninitialized values used as branch conditions">,
253 DescFile<"UndefBranchChecker.cpp">;
255 def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
256 HelpText<"Check for blocks that capture uninitialized values">,
257 DescFile<"UndefCapturedBlockVarChecker.cpp">;
259 def ReturnUndefChecker : Checker<"UndefReturn">,
260 HelpText<"Check for uninitialized values being returned to the caller">,
261 DescFile<"ReturnUndefChecker.cpp">;
263 } // end "core.uninitialized"
265 //===----------------------------------------------------------------------===//
267 //===----------------------------------------------------------------------===//
269 let ParentPackage = Cplusplus in {
271 def NewDeleteChecker : Checker<"NewDelete">,
272 HelpText<"Check for double-free and use-after-free problems. Traces memory managed by new/delete.">,
273 DescFile<"MallocChecker.cpp">;
275 def NewDeleteLeaksChecker : Checker<"NewDeleteLeaks">,
276 HelpText<"Check for memory leaks. Traces memory managed by new/delete.">,
277 DescFile<"MallocChecker.cpp">;
279 def CXXSelfAssignmentChecker : Checker<"SelfAssignment">,
280 HelpText<"Checks C++ copy and move assignment operators for self assignment">,
281 DescFile<"CXXSelfAssignmentChecker.cpp">;
283 } // end: "cplusplus"
285 let ParentPackage = CplusplusOptIn in {
287 def VirtualCallChecker : Checker<"VirtualCall">,
288 HelpText<"Check virtual function calls during construction or destruction">,
289 DescFile<"VirtualCallChecker.cpp">;
291 } // end: "optin.cplusplus"
293 let ParentPackage = CplusplusAlpha in {
295 def DeleteWithNonVirtualDtorChecker : Checker<"DeleteWithNonVirtualDtor">,
296 HelpText<"Reports destructions of polymorphic objects with a non-virtual "
297 "destructor in their base class">,
298 DescFile<"DeleteWithNonVirtualDtorChecker.cpp">;
300 def IteratorRangeChecker : Checker<"IteratorRange">,
301 HelpText<"Check for iterators used outside their valid ranges">,
302 DescFile<"IteratorChecker.cpp">;
304 def MisusedMovedObjectChecker: Checker<"MisusedMovedObject">,
305 HelpText<"Method calls on a moved-from object and copying a moved-from "
306 "object will be reported">,
307 DescFile<"MisusedMovedObjectChecker.cpp">;
309 } // end: "alpha.cplusplus"
312 //===----------------------------------------------------------------------===//
314 //===----------------------------------------------------------------------===//
316 let ParentPackage = Valist in {
318 def UninitializedChecker : Checker<"Uninitialized">,
319 HelpText<"Check for usages of uninitialized (or already released) va_lists.">,
320 DescFile<"ValistChecker.cpp">;
322 def UnterminatedChecker : Checker<"Unterminated">,
323 HelpText<"Check for va_lists which are not released by a va_end call.">,
324 DescFile<"ValistChecker.cpp">;
326 def CopyToSelfChecker : Checker<"CopyToSelf">,
327 HelpText<"Check for va_lists which are copied onto itself.">,
328 DescFile<"ValistChecker.cpp">;
332 //===----------------------------------------------------------------------===//
333 // Deadcode checkers.
334 //===----------------------------------------------------------------------===//
336 let ParentPackage = DeadCode in {
338 def DeadStoresChecker : Checker<"DeadStores">,
339 HelpText<"Check for values stored to variables that are never read afterwards">,
340 DescFile<"DeadStoresChecker.cpp">;
343 let ParentPackage = DeadCodeAlpha in {
345 def UnreachableCodeChecker : Checker<"UnreachableCode">,
346 HelpText<"Check unreachable code">,
347 DescFile<"UnreachableCodeChecker.cpp">;
349 } // end "alpha.deadcode"
351 //===----------------------------------------------------------------------===//
352 // Performance checkers.
353 //===----------------------------------------------------------------------===//
355 let ParentPackage = Performance in {
357 def PaddingChecker : Checker<"Padding">,
358 HelpText<"Check for excessively padded structs.">,
359 DescFile<"PaddingChecker.cpp">;
363 //===----------------------------------------------------------------------===//
364 // Security checkers.
365 //===----------------------------------------------------------------------===//
367 let ParentPackage = InsecureAPI in {
368 def gets : Checker<"gets">,
369 HelpText<"Warn on uses of the 'gets' function">,
370 DescFile<"CheckSecuritySyntaxOnly.cpp">;
371 def getpw : Checker<"getpw">,
372 HelpText<"Warn on uses of the 'getpw' function">,
373 DescFile<"CheckSecuritySyntaxOnly.cpp">;
374 def mktemp : Checker<"mktemp">,
375 HelpText<"Warn on uses of the 'mktemp' function">,
376 DescFile<"CheckSecuritySyntaxOnly.cpp">;
377 def mkstemp : Checker<"mkstemp">,
378 HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">,
379 DescFile<"CheckSecuritySyntaxOnly.cpp">;
380 def rand : Checker<"rand">,
381 HelpText<"Warn on uses of the 'rand', 'random', and related functions">,
382 DescFile<"CheckSecuritySyntaxOnly.cpp">;
383 def strcpy : Checker<"strcpy">,
384 HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">,
385 DescFile<"CheckSecuritySyntaxOnly.cpp">;
386 def vfork : Checker<"vfork">,
387 HelpText<"Warn on uses of the 'vfork' function">,
388 DescFile<"CheckSecuritySyntaxOnly.cpp">;
389 def UncheckedReturn : Checker<"UncheckedReturn">,
390 HelpText<"Warn on uses of functions whose return values must be always checked">,
391 DescFile<"CheckSecuritySyntaxOnly.cpp">;
393 let ParentPackage = Security in {
394 def FloatLoopCounter : Checker<"FloatLoopCounter">,
395 HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">,
396 DescFile<"CheckSecuritySyntaxOnly.cpp">;
399 let ParentPackage = SecurityAlpha in {
401 def ArrayBoundChecker : Checker<"ArrayBound">,
402 HelpText<"Warn about buffer overflows (older checker)">,
403 DescFile<"ArrayBoundChecker.cpp">;
405 def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
406 HelpText<"Warn about buffer overflows (newer checker)">,
407 DescFile<"ArrayBoundCheckerV2.cpp">;
409 def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
410 HelpText<"Check for an out-of-bound pointer being returned to callers">,
411 DescFile<"ReturnPointerRangeChecker.cpp">;
413 def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
414 HelpText<"Check for overflows in the arguments to malloc()">,
415 DescFile<"MallocOverflowSecurityChecker.cpp">;
417 } // end "alpha.security"
419 //===----------------------------------------------------------------------===//
421 //===----------------------------------------------------------------------===//
423 let ParentPackage = Taint in {
425 def GenericTaintChecker : Checker<"TaintPropagation">,
426 HelpText<"Generate taint information used by other checkers">,
427 DescFile<"GenericTaintChecker.cpp">;
429 } // end "alpha.security.taint"
431 //===----------------------------------------------------------------------===//
432 // Unix API checkers.
433 //===----------------------------------------------------------------------===//
435 let ParentPackage = Unix in {
437 def UnixAPIMisuseChecker : Checker<"API">,
438 HelpText<"Check calls to various UNIX/Posix functions">,
439 DescFile<"UnixAPIChecker.cpp">;
441 def MallocChecker: Checker<"Malloc">,
442 HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free().">,
443 DescFile<"MallocChecker.cpp">;
445 def MallocSizeofChecker : Checker<"MallocSizeof">,
446 HelpText<"Check for dubious malloc arguments involving sizeof">,
447 DescFile<"MallocSizeofChecker.cpp">;
449 def MismatchedDeallocatorChecker : Checker<"MismatchedDeallocator">,
450 HelpText<"Check for mismatched deallocators.">,
451 DescFile<"MallocChecker.cpp">;
453 def VforkChecker : Checker<"Vfork">,
454 HelpText<"Check for proper usage of vfork">,
455 DescFile<"VforkChecker.cpp">;
457 def StdCLibraryFunctionsChecker : Checker<"StdCLibraryFunctions">,
458 HelpText<"Improve modeling of the C standard library functions">,
459 DescFile<"StdLibraryFunctionsChecker.cpp">;
463 let ParentPackage = UnixAlpha in {
465 def ChrootChecker : Checker<"Chroot">,
466 HelpText<"Check improper use of chroot">,
467 DescFile<"ChrootChecker.cpp">;
469 def PthreadLockChecker : Checker<"PthreadLock">,
470 HelpText<"Simple lock -> unlock checker">,
471 DescFile<"PthreadLockChecker.cpp">;
473 def StreamChecker : Checker<"Stream">,
474 HelpText<"Check stream handling functions">,
475 DescFile<"StreamChecker.cpp">;
477 def SimpleStreamChecker : Checker<"SimpleStream">,
478 HelpText<"Check for misuses of stream APIs">,
479 DescFile<"SimpleStreamChecker.cpp">;
481 def BlockInCriticalSectionChecker : Checker<"BlockInCriticalSection">,
482 HelpText<"Check for calls to blocking functions inside a critical section">,
483 DescFile<"BlockInCriticalSectionChecker.cpp">;
485 } // end "alpha.unix"
487 let ParentPackage = CString in {
489 def CStringNullArg : Checker<"NullArg">,
490 HelpText<"Check for null pointers being passed as arguments to C string functions">,
491 DescFile<"CStringChecker.cpp">;
493 def CStringSyntaxChecker : Checker<"BadSizeArg">,
494 HelpText<"Check the size argument passed into C string functions for common erroneous patterns">,
495 DescFile<"CStringSyntaxChecker.cpp">;
498 let ParentPackage = CStringAlpha in {
500 def CStringOutOfBounds : Checker<"OutOfBounds">,
501 HelpText<"Check for out-of-bounds access in string functions">,
502 DescFile<"CStringChecker.cpp">;
504 def CStringBufferOverlap : Checker<"BufferOverlap">,
505 HelpText<"Checks for overlap in two buffer arguments">,
506 DescFile<"CStringChecker.cpp">;
508 def CStringNotNullTerm : Checker<"NotNullTerminated">,
509 HelpText<"Check for arguments which are not null-terminating strings">,
510 DescFile<"CStringChecker.cpp">;
513 //===----------------------------------------------------------------------===//
514 // Mac OS X, Cocoa, and Core Foundation checkers.
515 //===----------------------------------------------------------------------===//
517 let ParentPackage = OSX in {
519 def NumberObjectConversionChecker : Checker<"NumberObjectConversion">,
520 HelpText<"Check for erroneous conversions of objects representing numbers into numbers">,
521 DescFile<"NumberObjectConversionChecker.cpp">;
523 def MacOSXAPIChecker : Checker<"API">,
524 HelpText<"Check for proper uses of various Apple APIs">,
525 DescFile<"MacOSXAPIChecker.cpp">;
527 def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">,
528 HelpText<"Check for proper uses of Secure Keychain APIs">,
529 DescFile<"MacOSKeychainAPIChecker.cpp">;
531 def ObjCPropertyChecker : Checker<"ObjCProperty">,
532 HelpText<"Check for proper uses of Objective-C properties">,
533 DescFile<"ObjCPropertyChecker.cpp">;
537 let ParentPackage = Cocoa in {
539 def ObjCAtSyncChecker : Checker<"AtSync">,
540 HelpText<"Check for nil pointers used as mutexes for @synchronized">,
541 DescFile<"ObjCAtSyncChecker.cpp">;
543 def NilArgChecker : Checker<"NilArg">,
544 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
545 DescFile<"BasicObjCFoundationChecks.cpp">;
547 def ClassReleaseChecker : Checker<"ClassRelease">,
548 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
549 DescFile<"BasicObjCFoundationChecks.cpp">;
551 def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
552 HelpText<"Check for passing non-Objective-C types to variadic collection "
553 "initialization methods that expect only Objective-C types">,
554 DescFile<"BasicObjCFoundationChecks.cpp">;
556 def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
557 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
558 DescFile<"NSAutoreleasePoolChecker.cpp">;
560 def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
561 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
562 DescFile<"CheckObjCInstMethSignature.cpp">;
564 def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
565 HelpText<"Warn about private ivars that are never used">,
566 DescFile<"ObjCUnusedIVarsChecker.cpp">;
568 def ObjCSelfInitChecker : Checker<"SelfInit">,
569 HelpText<"Check that 'self' is properly initialized inside an initializer method">,
570 DescFile<"ObjCSelfInitChecker.cpp">;
572 def ObjCLoopChecker : Checker<"Loops">,
573 HelpText<"Improved modeling of loops using Cocoa collection types">,
574 DescFile<"BasicObjCFoundationChecks.cpp">;
576 def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">,
577 HelpText<"Model the APIs that are guaranteed to return a non-nil value">,
578 DescFile<"BasicObjCFoundationChecks.cpp">;
580 def ObjCSuperCallChecker : Checker<"MissingSuperCall">,
581 HelpText<"Warn about Objective-C methods that lack a necessary call to super">,
582 DescFile<"ObjCMissingSuperCallChecker.cpp">;
584 def NSErrorChecker : Checker<"NSError">,
585 HelpText<"Check usage of NSError** parameters">,
586 DescFile<"NSErrorChecker.cpp">;
588 def RetainCountChecker : Checker<"RetainCount">,
589 HelpText<"Check for leaks and improper reference count management">,
590 DescFile<"RetainCountChecker.cpp">;
592 def ObjCGenericsChecker : Checker<"ObjCGenerics">,
593 HelpText<"Check for type errors when using Objective-C generics">,
594 DescFile<"DynamicTypePropagation.cpp">;
596 def ObjCDeallocChecker : Checker<"Dealloc">,
597 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
598 DescFile<"CheckObjCDealloc.cpp">;
600 def ObjCSuperDeallocChecker : Checker<"SuperDealloc">,
601 HelpText<"Warn about improper use of '[super dealloc]' in Objective-C">,
602 DescFile<"ObjCSuperDeallocChecker.cpp">;
606 let ParentPackage = CocoaAlpha in {
608 def InstanceVariableInvalidation : Checker<"InstanceVariableInvalidation">,
609 HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
610 DescFile<"IvarInvalidationChecker.cpp">;
612 def MissingInvalidationMethod : Checker<"MissingInvalidationMethod">,
613 HelpText<"Check that the invalidation methods are present in classes that contain invalidatable instance variables">,
614 DescFile<"IvarInvalidationChecker.cpp">;
616 def DirectIvarAssignment : Checker<"DirectIvarAssignment">,
617 HelpText<"Check for direct assignments to instance variables">,
618 DescFile<"DirectIvarAssignment.cpp">;
620 def DirectIvarAssignmentForAnnotatedFunctions : Checker<"DirectIvarAssignmentForAnnotatedFunctions">,
621 HelpText<"Check for direct assignments to instance variables in the methods annotated with objc_no_direct_instance_variable_assignment">,
622 DescFile<"DirectIvarAssignment.cpp">;
624 } // end "alpha.osx.cocoa"
626 let ParentPackage = CoreFoundation in {
628 def CFNumberChecker : Checker<"CFNumber">,
629 HelpText<"Check for proper uses of CFNumber APIs">,
630 DescFile<"BasicObjCFoundationChecks.cpp">;
632 def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
633 HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">,
634 DescFile<"BasicObjCFoundationChecks.cpp">;
636 def CFErrorChecker : Checker<"CFError">,
637 HelpText<"Check usage of CFErrorRef* parameters">,
638 DescFile<"NSErrorChecker.cpp">;
641 let ParentPackage = Containers in {
642 def ObjCContainersASTChecker : Checker<"PointerSizedValues">,
643 HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">,
644 DescFile<"ObjCContainersASTChecker.cpp">;
646 def ObjCContainersChecker : Checker<"OutOfBounds">,
647 HelpText<"Checks for index out-of-bounds when using 'CFArray' API">,
648 DescFile<"ObjCContainersChecker.cpp">;
652 let ParentPackage = LocalizabilityOptIn in {
653 def NonLocalizedStringChecker : Checker<"NonLocalizedStringChecker">,
654 HelpText<"Warns about uses of non-localized NSStrings passed to UI methods expecting localized NSStrings">,
655 DescFile<"LocalizationChecker.cpp">;
657 def EmptyLocalizationContextChecker : Checker<"EmptyLocalizationContextChecker">,
658 HelpText<"Check that NSLocalizedString macros include a comment for context">,
659 DescFile<"LocalizationChecker.cpp">;
662 let ParentPackage = LocalizabilityAlpha in {
663 def PluralMisuseChecker : Checker<"PluralMisuseChecker">,
664 HelpText<"Warns against using one vs. many plural pattern in code when generating localized strings.">,
665 DescFile<"LocalizationChecker.cpp">;
668 let ParentPackage = MPI in {
669 def MPIChecker : Checker<"MPI-Checker">,
670 HelpText<"Checks MPI code">,
671 DescFile<"MPIChecker.cpp">;
674 //===----------------------------------------------------------------------===//
675 // Checkers for LLVM development.
676 //===----------------------------------------------------------------------===//
678 def LLVMConventionsChecker : Checker<"Conventions">,
680 HelpText<"Check code for LLVM codebase conventions">,
681 DescFile<"LLVMConventionsChecker.cpp">;
685 //===----------------------------------------------------------------------===//
686 // Checkers modeling Google APIs.
687 //===----------------------------------------------------------------------===//
689 def GTestChecker : Checker<"GTest">,
690 InPackage<GoogleAPIModeling>,
691 HelpText<"Model gtest assertion APIs">,
692 DescFile<"GTestChecker.cpp">;
694 //===----------------------------------------------------------------------===//
695 // Debugging checkers (for analyzer development).
696 //===----------------------------------------------------------------------===//
698 let ParentPackage = Debug in {
700 def AnalysisOrderChecker : Checker<"AnalysisOrder">,
701 HelpText<"Print callbacks that are called during analysis in order">,
702 DescFile<"AnalysisOrder.cpp">;
704 def DominatorsTreeDumper : Checker<"DumpDominators">,
705 HelpText<"Print the dominance tree for a given CFG">,
706 DescFile<"DebugCheckers.cpp">;
708 def LiveVariablesDumper : Checker<"DumpLiveVars">,
709 HelpText<"Print results of live variable analysis">,
710 DescFile<"DebugCheckers.cpp">;
712 def CFGViewer : Checker<"ViewCFG">,
713 HelpText<"View Control-Flow Graphs using GraphViz">,
714 DescFile<"DebugCheckers.cpp">;
716 def CFGDumper : Checker<"DumpCFG">,
717 HelpText<"Display Control-Flow Graphs">,
718 DescFile<"DebugCheckers.cpp">;
720 def CallGraphViewer : Checker<"ViewCallGraph">,
721 HelpText<"View Call Graph using GraphViz">,
722 DescFile<"DebugCheckers.cpp">;
724 def CallGraphDumper : Checker<"DumpCallGraph">,
725 HelpText<"Display Call Graph">,
726 DescFile<"DebugCheckers.cpp">;
728 def ConfigDumper : Checker<"ConfigDumper">,
729 HelpText<"Dump config table">,
730 DescFile<"DebugCheckers.cpp">;
732 def TraversalDumper : Checker<"DumpTraversal">,
733 HelpText<"Print branch conditions as they are traversed by the engine">,
734 DescFile<"TraversalChecker.cpp">;
736 def CallDumper : Checker<"DumpCalls">,
737 HelpText<"Print calls as they are traversed by the engine">,
738 DescFile<"TraversalChecker.cpp">;
740 def AnalyzerStatsChecker : Checker<"Stats">,
741 HelpText<"Emit warnings with analyzer statistics">,
742 DescFile<"AnalyzerStatsChecker.cpp">;
744 def TaintTesterChecker : Checker<"TaintTest">,
745 HelpText<"Mark tainted symbols as such.">,
746 DescFile<"TaintTesterChecker.cpp">;
748 def ExprInspectionChecker : Checker<"ExprInspection">,
749 HelpText<"Check the analyzer's understanding of expressions">,
750 DescFile<"ExprInspectionChecker.cpp">;
752 def ExplodedGraphViewer : Checker<"ViewExplodedGraph">,
753 HelpText<"View Exploded Graphs using GraphViz">,
754 DescFile<"DebugCheckers.cpp">;
759 //===----------------------------------------------------------------------===//
761 //===----------------------------------------------------------------------===//
763 let ParentPackage = CloneDetectionAlpha in {
765 def CloneChecker : Checker<"CloneChecker">,
766 HelpText<"Reports similar pieces of code.">,
767 DescFile<"CloneChecker.cpp">;
771 //===----------------------------------------------------------------------===//
772 // Portability checkers.
773 //===----------------------------------------------------------------------===//
775 let ParentPackage = PortabilityOptIn in {
777 def UnixAPIPortabilityChecker : Checker<"UnixAPI">,
778 HelpText<"Finds implementation-defined behavior in UNIX/Posix functions">,
779 DescFile<"UnixAPIChecker.cpp">;
781 } // end optin.portability