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 "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 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 let ParentPackage = APIModeling in {
223 def TrustNonnullChecker : Checker<"TrustNonnull">,
224 HelpText<"Trust that returns from framework methods annotated with _Nonnull are not null">,
225 DescFile<"TrustNonnullChecker.cpp">;
229 //===----------------------------------------------------------------------===//
230 // Evaluate "builtin" functions.
231 //===----------------------------------------------------------------------===//
233 let ParentPackage = CoreBuiltin in {
235 def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
236 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
237 DescFile<"NoReturnFunctionChecker.cpp">;
239 def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
240 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
241 DescFile<"BuiltinFunctionChecker.cpp">;
243 } // end "core.builtin"
245 //===----------------------------------------------------------------------===//
246 // Uninitialized values checkers.
247 //===----------------------------------------------------------------------===//
249 let ParentPackage = CoreUninitialized in {
251 def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
252 HelpText<"Check for uninitialized values used as array subscripts">,
253 DescFile<"UndefinedArraySubscriptChecker.cpp">;
255 def UndefinedAssignmentChecker : Checker<"Assign">,
256 HelpText<"Check for assigning uninitialized values">,
257 DescFile<"UndefinedAssignmentChecker.cpp">;
259 def UndefBranchChecker : Checker<"Branch">,
260 HelpText<"Check for uninitialized values used as branch conditions">,
261 DescFile<"UndefBranchChecker.cpp">;
263 def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
264 HelpText<"Check for blocks that capture uninitialized values">,
265 DescFile<"UndefCapturedBlockVarChecker.cpp">;
267 def ReturnUndefChecker : Checker<"UndefReturn">,
268 HelpText<"Check for uninitialized values being returned to the caller">,
269 DescFile<"ReturnUndefChecker.cpp">;
271 } // end "core.uninitialized"
273 //===----------------------------------------------------------------------===//
275 //===----------------------------------------------------------------------===//
277 let ParentPackage = Cplusplus in {
279 def InnerPointerChecker : Checker<"InnerPointer">,
280 HelpText<"Check for inner pointers of C++ containers used after re/deallocation">,
281 DescFile<"InnerPointerChecker.cpp">;
283 def NewDeleteChecker : Checker<"NewDelete">,
284 HelpText<"Check for double-free and use-after-free problems. Traces memory managed by new/delete.">,
285 DescFile<"MallocChecker.cpp">;
287 def NewDeleteLeaksChecker : Checker<"NewDeleteLeaks">,
288 HelpText<"Check for memory leaks. Traces memory managed by new/delete.">,
289 DescFile<"MallocChecker.cpp">;
291 def CXXSelfAssignmentChecker : Checker<"SelfAssignment">,
292 HelpText<"Checks C++ copy and move assignment operators for self assignment">,
293 DescFile<"CXXSelfAssignmentChecker.cpp">;
295 } // end: "cplusplus"
297 let ParentPackage = CplusplusOptIn in {
299 def VirtualCallChecker : Checker<"VirtualCall">,
300 HelpText<"Check virtual function calls during construction or destruction">,
301 DescFile<"VirtualCallChecker.cpp">;
303 } // end: "optin.cplusplus"
305 let ParentPackage = CplusplusAlpha in {
307 def DeleteWithNonVirtualDtorChecker : Checker<"DeleteWithNonVirtualDtor">,
308 HelpText<"Reports destructions of polymorphic objects with a non-virtual "
309 "destructor in their base class">,
310 DescFile<"DeleteWithNonVirtualDtorChecker.cpp">;
312 def IteratorRangeChecker : Checker<"IteratorRange">,
313 HelpText<"Check for iterators used outside their valid ranges">,
314 DescFile<"IteratorChecker.cpp">;
316 def MisusedMovedObjectChecker: Checker<"MisusedMovedObject">,
317 HelpText<"Method calls on a moved-from object and copying a moved-from "
318 "object will be reported">,
319 DescFile<"MisusedMovedObjectChecker.cpp">;
321 def UninitializedObjectChecker: Checker<"UninitializedObject">,
322 HelpText<"Reports uninitialized fields after object construction">,
323 DescFile<"UninitializedObjectChecker.cpp">;
325 } // end: "alpha.cplusplus"
328 //===----------------------------------------------------------------------===//
330 //===----------------------------------------------------------------------===//
332 let ParentPackage = Valist in {
334 def UninitializedChecker : Checker<"Uninitialized">,
335 HelpText<"Check for usages of uninitialized (or already released) va_lists.">,
336 DescFile<"ValistChecker.cpp">;
338 def UnterminatedChecker : Checker<"Unterminated">,
339 HelpText<"Check for va_lists which are not released by a va_end call.">,
340 DescFile<"ValistChecker.cpp">;
342 def CopyToSelfChecker : Checker<"CopyToSelf">,
343 HelpText<"Check for va_lists which are copied onto itself.">,
344 DescFile<"ValistChecker.cpp">;
348 //===----------------------------------------------------------------------===//
349 // Deadcode checkers.
350 //===----------------------------------------------------------------------===//
352 let ParentPackage = DeadCode in {
354 def DeadStoresChecker : Checker<"DeadStores">,
355 HelpText<"Check for values stored to variables that are never read afterwards">,
356 DescFile<"DeadStoresChecker.cpp">;
359 let ParentPackage = DeadCodeAlpha in {
361 def UnreachableCodeChecker : Checker<"UnreachableCode">,
362 HelpText<"Check unreachable code">,
363 DescFile<"UnreachableCodeChecker.cpp">;
365 } // end "alpha.deadcode"
367 //===----------------------------------------------------------------------===//
368 // Performance checkers.
369 //===----------------------------------------------------------------------===//
371 let ParentPackage = Performance in {
373 def PaddingChecker : Checker<"Padding">,
374 HelpText<"Check for excessively padded structs.">,
375 DescFile<"PaddingChecker.cpp">;
379 //===----------------------------------------------------------------------===//
380 // Security checkers.
381 //===----------------------------------------------------------------------===//
383 let ParentPackage = InsecureAPI in {
384 def bcmp : Checker<"bcmp">,
385 HelpText<"Warn on uses of the 'bcmp' function">,
386 DescFile<"CheckSecuritySyntaxOnly.cpp">;
387 def bcopy : Checker<"bcopy">,
388 HelpText<"Warn on uses of the 'bcopy' function">,
389 DescFile<"CheckSecuritySyntaxOnly.cpp">;
390 def bzero : Checker<"bzero">,
391 HelpText<"Warn on uses of the 'bzero' function">,
392 DescFile<"CheckSecuritySyntaxOnly.cpp">;
393 def gets : Checker<"gets">,
394 HelpText<"Warn on uses of the 'gets' function">,
395 DescFile<"CheckSecuritySyntaxOnly.cpp">;
396 def getpw : Checker<"getpw">,
397 HelpText<"Warn on uses of the 'getpw' function">,
398 DescFile<"CheckSecuritySyntaxOnly.cpp">;
399 def mktemp : Checker<"mktemp">,
400 HelpText<"Warn on uses of the 'mktemp' function">,
401 DescFile<"CheckSecuritySyntaxOnly.cpp">;
402 def mkstemp : Checker<"mkstemp">,
403 HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">,
404 DescFile<"CheckSecuritySyntaxOnly.cpp">;
405 def rand : Checker<"rand">,
406 HelpText<"Warn on uses of the 'rand', 'random', and related functions">,
407 DescFile<"CheckSecuritySyntaxOnly.cpp">;
408 def strcpy : Checker<"strcpy">,
409 HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">,
410 DescFile<"CheckSecuritySyntaxOnly.cpp">;
411 def vfork : Checker<"vfork">,
412 HelpText<"Warn on uses of the 'vfork' function">,
413 DescFile<"CheckSecuritySyntaxOnly.cpp">;
414 def UncheckedReturn : Checker<"UncheckedReturn">,
415 HelpText<"Warn on uses of functions whose return values must be always checked">,
416 DescFile<"CheckSecuritySyntaxOnly.cpp">;
418 let ParentPackage = Security in {
419 def FloatLoopCounter : Checker<"FloatLoopCounter">,
420 HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">,
421 DescFile<"CheckSecuritySyntaxOnly.cpp">;
424 let ParentPackage = SecurityAlpha in {
426 def ArrayBoundChecker : Checker<"ArrayBound">,
427 HelpText<"Warn about buffer overflows (older checker)">,
428 DescFile<"ArrayBoundChecker.cpp">;
430 def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
431 HelpText<"Warn about buffer overflows (newer checker)">,
432 DescFile<"ArrayBoundCheckerV2.cpp">;
434 def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
435 HelpText<"Check for an out-of-bound pointer being returned to callers">,
436 DescFile<"ReturnPointerRangeChecker.cpp">;
438 def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
439 HelpText<"Check for overflows in the arguments to malloc()">,
440 DescFile<"MallocOverflowSecurityChecker.cpp">;
442 // Operating systems specific PROT_READ/PROT_WRITE values is not implemented,
443 // the defaults are correct for several common operating systems though,
444 // but may need to be overridden via the related analyzer-config flags.
445 def MmapWriteExecChecker : Checker<"MmapWriteExec">,
446 HelpText<"Warn on mmap() calls that are both writable and executable">,
447 DescFile<"MmapWriteExecChecker.cpp">;
449 } // end "alpha.security"
451 //===----------------------------------------------------------------------===//
453 //===----------------------------------------------------------------------===//
455 let ParentPackage = Taint in {
457 def GenericTaintChecker : Checker<"TaintPropagation">,
458 HelpText<"Generate taint information used by other checkers">,
459 DescFile<"GenericTaintChecker.cpp">;
461 } // end "alpha.security.taint"
463 //===----------------------------------------------------------------------===//
464 // Unix API checkers.
465 //===----------------------------------------------------------------------===//
467 let ParentPackage = Unix in {
469 def UnixAPIMisuseChecker : Checker<"API">,
470 HelpText<"Check calls to various UNIX/Posix functions">,
471 DescFile<"UnixAPIChecker.cpp">;
473 def MallocChecker: Checker<"Malloc">,
474 HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free().">,
475 DescFile<"MallocChecker.cpp">;
477 def MallocSizeofChecker : Checker<"MallocSizeof">,
478 HelpText<"Check for dubious malloc arguments involving sizeof">,
479 DescFile<"MallocSizeofChecker.cpp">;
481 def MismatchedDeallocatorChecker : Checker<"MismatchedDeallocator">,
482 HelpText<"Check for mismatched deallocators.">,
483 DescFile<"MallocChecker.cpp">;
485 def VforkChecker : Checker<"Vfork">,
486 HelpText<"Check for proper usage of vfork">,
487 DescFile<"VforkChecker.cpp">;
489 def StdCLibraryFunctionsChecker : Checker<"StdCLibraryFunctions">,
490 HelpText<"Improve modeling of the C standard library functions">,
491 DescFile<"StdLibraryFunctionsChecker.cpp">;
495 let ParentPackage = UnixAlpha in {
497 def ChrootChecker : Checker<"Chroot">,
498 HelpText<"Check improper use of chroot">,
499 DescFile<"ChrootChecker.cpp">;
501 def PthreadLockChecker : Checker<"PthreadLock">,
502 HelpText<"Simple lock -> unlock checker">,
503 DescFile<"PthreadLockChecker.cpp">;
505 def StreamChecker : Checker<"Stream">,
506 HelpText<"Check stream handling functions">,
507 DescFile<"StreamChecker.cpp">;
509 def SimpleStreamChecker : Checker<"SimpleStream">,
510 HelpText<"Check for misuses of stream APIs">,
511 DescFile<"SimpleStreamChecker.cpp">;
513 def BlockInCriticalSectionChecker : Checker<"BlockInCriticalSection">,
514 HelpText<"Check for calls to blocking functions inside a critical section">,
515 DescFile<"BlockInCriticalSectionChecker.cpp">;
517 } // end "alpha.unix"
519 let ParentPackage = CString in {
521 def CStringNullArg : Checker<"NullArg">,
522 HelpText<"Check for null pointers being passed as arguments to C string functions">,
523 DescFile<"CStringChecker.cpp">;
525 def CStringSyntaxChecker : Checker<"BadSizeArg">,
526 HelpText<"Check the size argument passed into C string functions for common erroneous patterns">,
527 DescFile<"CStringSyntaxChecker.cpp">;
530 let ParentPackage = CStringAlpha in {
532 def CStringOutOfBounds : Checker<"OutOfBounds">,
533 HelpText<"Check for out-of-bounds access in string functions">,
534 DescFile<"CStringChecker.cpp">;
536 def CStringBufferOverlap : Checker<"BufferOverlap">,
537 HelpText<"Checks for overlap in two buffer arguments">,
538 DescFile<"CStringChecker.cpp">;
540 def CStringNotNullTerm : Checker<"NotNullTerminated">,
541 HelpText<"Check for arguments which are not null-terminating strings">,
542 DescFile<"CStringChecker.cpp">;
545 //===----------------------------------------------------------------------===//
546 // Mac OS X, Cocoa, and Core Foundation checkers.
547 //===----------------------------------------------------------------------===//
549 let ParentPackage = OSX in {
551 def NumberObjectConversionChecker : Checker<"NumberObjectConversion">,
552 HelpText<"Check for erroneous conversions of objects representing numbers into numbers">,
553 DescFile<"NumberObjectConversionChecker.cpp">;
555 def MacOSXAPIChecker : Checker<"API">,
556 HelpText<"Check for proper uses of various Apple APIs">,
557 DescFile<"MacOSXAPIChecker.cpp">;
559 def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">,
560 HelpText<"Check for proper uses of Secure Keychain APIs">,
561 DescFile<"MacOSKeychainAPIChecker.cpp">;
563 def ObjCPropertyChecker : Checker<"ObjCProperty">,
564 HelpText<"Check for proper uses of Objective-C properties">,
565 DescFile<"ObjCPropertyChecker.cpp">;
569 let ParentPackage = Cocoa in {
571 def RunLoopAutoreleaseLeakChecker : Checker<"RunLoopAutoreleaseLeak">,
572 HelpText<"Check for leaked memory in autorelease pools that will never be drained">,
573 DescFile<"RunLoopAutoreleaseLeakChecker.cpp">;
575 def ObjCAtSyncChecker : Checker<"AtSync">,
576 HelpText<"Check for nil pointers used as mutexes for @synchronized">,
577 DescFile<"ObjCAtSyncChecker.cpp">;
579 def NilArgChecker : Checker<"NilArg">,
580 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
581 DescFile<"BasicObjCFoundationChecks.cpp">;
583 def ClassReleaseChecker : Checker<"ClassRelease">,
584 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
585 DescFile<"BasicObjCFoundationChecks.cpp">;
587 def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
588 HelpText<"Check for passing non-Objective-C types to variadic collection "
589 "initialization methods that expect only Objective-C types">,
590 DescFile<"BasicObjCFoundationChecks.cpp">;
592 def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
593 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
594 DescFile<"NSAutoreleasePoolChecker.cpp">;
596 def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
597 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
598 DescFile<"CheckObjCInstMethSignature.cpp">;
600 def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
601 HelpText<"Warn about private ivars that are never used">,
602 DescFile<"ObjCUnusedIVarsChecker.cpp">;
604 def ObjCSelfInitChecker : Checker<"SelfInit">,
605 HelpText<"Check that 'self' is properly initialized inside an initializer method">,
606 DescFile<"ObjCSelfInitChecker.cpp">;
608 def ObjCLoopChecker : Checker<"Loops">,
609 HelpText<"Improved modeling of loops using Cocoa collection types">,
610 DescFile<"BasicObjCFoundationChecks.cpp">;
612 def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">,
613 HelpText<"Model the APIs that are guaranteed to return a non-nil value">,
614 DescFile<"BasicObjCFoundationChecks.cpp">;
616 def ObjCSuperCallChecker : Checker<"MissingSuperCall">,
617 HelpText<"Warn about Objective-C methods that lack a necessary call to super">,
618 DescFile<"ObjCMissingSuperCallChecker.cpp">;
620 def NSErrorChecker : Checker<"NSError">,
621 HelpText<"Check usage of NSError** parameters">,
622 DescFile<"NSErrorChecker.cpp">;
624 def RetainCountChecker : Checker<"RetainCount">,
625 HelpText<"Check for leaks and improper reference count management">,
626 DescFile<"RetainCountChecker.cpp">;
628 def ObjCGenericsChecker : Checker<"ObjCGenerics">,
629 HelpText<"Check for type errors when using Objective-C generics">,
630 DescFile<"DynamicTypePropagation.cpp">;
632 def ObjCDeallocChecker : Checker<"Dealloc">,
633 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
634 DescFile<"CheckObjCDealloc.cpp">;
636 def ObjCSuperDeallocChecker : Checker<"SuperDealloc">,
637 HelpText<"Warn about improper use of '[super dealloc]' in Objective-C">,
638 DescFile<"ObjCSuperDeallocChecker.cpp">;
640 def AutoreleaseWriteChecker : Checker<"AutoreleaseWrite">,
641 HelpText<"Warn about potentially crashing writes to autoreleasing objects from different autoreleasing pools in Objective-C">,
642 DescFile<"ObjCAutoreleaseWriteChecker.cpp">;
645 let ParentPackage = Performance in {
647 def GCDAntipattern : Checker<"GCDAntipattern">,
648 HelpText<"Check for performance anti-patterns when using Grand Central Dispatch">,
649 DescFile<"GCDAntipatternChecker.cpp">;
650 } // end "optin.performance"
652 let ParentPackage = CocoaAlpha in {
654 def InstanceVariableInvalidation : Checker<"InstanceVariableInvalidation">,
655 HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
656 DescFile<"IvarInvalidationChecker.cpp">;
658 def MissingInvalidationMethod : Checker<"MissingInvalidationMethod">,
659 HelpText<"Check that the invalidation methods are present in classes that contain invalidatable instance variables">,
660 DescFile<"IvarInvalidationChecker.cpp">;
662 def DirectIvarAssignment : Checker<"DirectIvarAssignment">,
663 HelpText<"Check for direct assignments to instance variables">,
664 DescFile<"DirectIvarAssignment.cpp">;
666 def DirectIvarAssignmentForAnnotatedFunctions : Checker<"DirectIvarAssignmentForAnnotatedFunctions">,
667 HelpText<"Check for direct assignments to instance variables in the methods annotated with objc_no_direct_instance_variable_assignment">,
668 DescFile<"DirectIvarAssignment.cpp">;
670 } // end "alpha.osx.cocoa"
672 let ParentPackage = CoreFoundation in {
674 def CFNumberChecker : Checker<"CFNumber">,
675 HelpText<"Check for proper uses of CFNumber APIs">,
676 DescFile<"BasicObjCFoundationChecks.cpp">;
678 def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
679 HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">,
680 DescFile<"BasicObjCFoundationChecks.cpp">;
682 def CFErrorChecker : Checker<"CFError">,
683 HelpText<"Check usage of CFErrorRef* parameters">,
684 DescFile<"NSErrorChecker.cpp">;
687 let ParentPackage = Containers in {
688 def ObjCContainersASTChecker : Checker<"PointerSizedValues">,
689 HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">,
690 DescFile<"ObjCContainersASTChecker.cpp">;
692 def ObjCContainersChecker : Checker<"OutOfBounds">,
693 HelpText<"Checks for index out-of-bounds when using 'CFArray' API">,
694 DescFile<"ObjCContainersChecker.cpp">;
698 let ParentPackage = LocalizabilityOptIn in {
699 def NonLocalizedStringChecker : Checker<"NonLocalizedStringChecker">,
700 HelpText<"Warns about uses of non-localized NSStrings passed to UI methods expecting localized NSStrings">,
701 DescFile<"LocalizationChecker.cpp">;
703 def EmptyLocalizationContextChecker : Checker<"EmptyLocalizationContextChecker">,
704 HelpText<"Check that NSLocalizedString macros include a comment for context">,
705 DescFile<"LocalizationChecker.cpp">;
708 let ParentPackage = LocalizabilityAlpha in {
709 def PluralMisuseChecker : Checker<"PluralMisuseChecker">,
710 HelpText<"Warns against using one vs. many plural pattern in code when generating localized strings.">,
711 DescFile<"LocalizationChecker.cpp">;
714 let ParentPackage = MPI in {
715 def MPIChecker : Checker<"MPI-Checker">,
716 HelpText<"Checks MPI code">,
717 DescFile<"MPIChecker.cpp">;
720 //===----------------------------------------------------------------------===//
721 // Checkers for LLVM development.
722 //===----------------------------------------------------------------------===//
724 def LLVMConventionsChecker : Checker<"Conventions">,
726 HelpText<"Check code for LLVM codebase conventions">,
727 DescFile<"LLVMConventionsChecker.cpp">;
731 //===----------------------------------------------------------------------===//
732 // Checkers modeling Google APIs.
733 //===----------------------------------------------------------------------===//
735 def GTestChecker : Checker<"GTest">,
736 InPackage<GoogleAPIModeling>,
737 HelpText<"Model gtest assertion APIs">,
738 DescFile<"GTestChecker.cpp">;
740 //===----------------------------------------------------------------------===//
741 // Debugging checkers (for analyzer development).
742 //===----------------------------------------------------------------------===//
744 let ParentPackage = Debug in {
746 def AnalysisOrderChecker : Checker<"AnalysisOrder">,
747 HelpText<"Print callbacks that are called during analysis in order">,
748 DescFile<"AnalysisOrder.cpp">;
750 def DominatorsTreeDumper : Checker<"DumpDominators">,
751 HelpText<"Print the dominance tree for a given CFG">,
752 DescFile<"DebugCheckers.cpp">;
754 def LiveVariablesDumper : Checker<"DumpLiveVars">,
755 HelpText<"Print results of live variable analysis">,
756 DescFile<"DebugCheckers.cpp">;
758 def CFGViewer : Checker<"ViewCFG">,
759 HelpText<"View Control-Flow Graphs using GraphViz">,
760 DescFile<"DebugCheckers.cpp">;
762 def CFGDumper : Checker<"DumpCFG">,
763 HelpText<"Display Control-Flow Graphs">,
764 DescFile<"DebugCheckers.cpp">;
766 def CallGraphViewer : Checker<"ViewCallGraph">,
767 HelpText<"View Call Graph using GraphViz">,
768 DescFile<"DebugCheckers.cpp">;
770 def CallGraphDumper : Checker<"DumpCallGraph">,
771 HelpText<"Display Call Graph">,
772 DescFile<"DebugCheckers.cpp">;
774 def ConfigDumper : Checker<"ConfigDumper">,
775 HelpText<"Dump config table">,
776 DescFile<"DebugCheckers.cpp">;
778 def TraversalDumper : Checker<"DumpTraversal">,
779 HelpText<"Print branch conditions as they are traversed by the engine">,
780 DescFile<"TraversalChecker.cpp">;
782 def CallDumper : Checker<"DumpCalls">,
783 HelpText<"Print calls as they are traversed by the engine">,
784 DescFile<"TraversalChecker.cpp">;
786 def AnalyzerStatsChecker : Checker<"Stats">,
787 HelpText<"Emit warnings with analyzer statistics">,
788 DescFile<"AnalyzerStatsChecker.cpp">;
790 def TaintTesterChecker : Checker<"TaintTest">,
791 HelpText<"Mark tainted symbols as such.">,
792 DescFile<"TaintTesterChecker.cpp">;
794 def ExprInspectionChecker : Checker<"ExprInspection">,
795 HelpText<"Check the analyzer's understanding of expressions">,
796 DescFile<"ExprInspectionChecker.cpp">;
798 def ExplodedGraphViewer : Checker<"ViewExplodedGraph">,
799 HelpText<"View Exploded Graphs using GraphViz">,
800 DescFile<"DebugCheckers.cpp">;
805 //===----------------------------------------------------------------------===//
807 //===----------------------------------------------------------------------===//
809 let ParentPackage = CloneDetectionAlpha in {
811 def CloneChecker : Checker<"CloneChecker">,
812 HelpText<"Reports similar pieces of code.">,
813 DescFile<"CloneChecker.cpp">;
817 //===----------------------------------------------------------------------===//
818 // Portability checkers.
819 //===----------------------------------------------------------------------===//
821 let ParentPackage = PortabilityOptIn in {
823 def UnixAPIPortabilityChecker : Checker<"UnixAPI">,
824 HelpText<"Finds implementation-defined behavior in UNIX/Posix functions">,
825 DescFile<"UnixAPIChecker.cpp">;
827 } // end optin.portability