granicus.if.org Git - clang/blob - include/clang/StaticAnalyzer/Checkers/Checkers.td

   1 //===--- Checkers.td - Static Analyzer Checkers -===-----------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 include "clang/StaticAnalyzer/Checkers/CheckerBase.td"
  11
  12 //===----------------------------------------------------------------------===//
  13 // Packages.
  14 //===----------------------------------------------------------------------===//
  15
  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
  20 // alpha.osx.cocoa).
  21 def Alpha : Package<"alpha">;
  22
  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;
  27
  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.
  33 //
  34 // The checker hierarchy under OptIn should mirror that in Alpha: checkers
  35 // should be organized as if they were at the top level.
  36 //
  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">;
  40
  41 def Nullability : Package<"nullability">;
  42
  43 def Cplusplus : Package<"cplusplus">;
  44 def CplusplusAlpha : Package<"cplusplus">, InPackage<Alpha>, Hidden;
  45
  46 def Valist : Package<"valist">;
  47 def ValistAlpha : Package<"valist">, InPackage<Alpha>, Hidden;
  48
  49 def DeadCode : Package<"deadcode">;
  50 def DeadCodeAlpha : Package<"deadcode">, InPackage<Alpha>, Hidden;
  51
  52 def Performance : Package<"performance">, InPackage<OptIn>;
  53
  54 def Security : Package <"security">;
  55 def InsecureAPI : Package<"insecureAPI">, InPackage<Security>;
  56 def SecurityAlpha : Package<"security">, InPackage<Alpha>, Hidden;
  57 def Taint : Package<"taint">, InPackage<SecurityAlpha>, Hidden;
  58
  59 def Unix : Package<"unix">;
  60 def UnixAlpha : Package<"unix">, InPackage<Alpha>, Hidden;
  61 def CString : Package<"cstring">, InPackage<Unix>, Hidden;
  62 def CStringAlpha : Package<"cstring">, InPackage<UnixAlpha>, Hidden;
  63
  64 def OSX : Package<"osx">;
  65 def OSXAlpha : Package<"osx">, InPackage<Alpha>, Hidden;
  66 def OSXOptIn : Package<"osx">, InPackage<OptIn>;
  67
  68 def Cocoa : Package<"cocoa">, InPackage<OSX>;
  69 def CocoaAlpha : Package<"cocoa">, InPackage<OSXAlpha>, Hidden;
  70 def CocoaOptIn : Package<"cocoa">, InPackage<OSXOptIn>;
  71
  72 def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>;
  73 def Containers : Package<"containers">, InPackage<CoreFoundation>;
  74
  75 def LocalizabilityAlpha : Package<"localizability">, InPackage<CocoaAlpha>;
  76 def LocalizabilityOptIn : Package<"localizability">, InPackage<CocoaOptIn>;
  77
  78 def MPI : Package<"mpi">, InPackage<OptIn>;
  79
  80 def LLVM : Package<"llvm">;
  81 def Debug : Package<"debug">;
  82
  83 def CloneDetectionAlpha : Package<"clone">, InPackage<Alpha>, Hidden;
  84
  85 //===----------------------------------------------------------------------===//
  86 // Core Checkers.
  87 //===----------------------------------------------------------------------===//
  88
  89 let ParentPackage = Core in {
  90
  91 def DereferenceChecker : Checker<"NullDereference">,
  92   HelpText<"Check for dereferences of null pointers">,
  93   DescFile<"DereferenceChecker.cpp">;
  94
  95 def CallAndMessageChecker : Checker<"CallAndMessage">,
  96   HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">,
  97   DescFile<"CallAndMessageChecker.cpp">;
  98
  99 def NonNullParamChecker : Checker<"NonNullParamChecker">,
 100   HelpText<"Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute">,
 101   DescFile<"NonNullParamChecker.cpp">;
 102
 103 def VLASizeChecker : Checker<"VLASize">,
 104   HelpText<"Check for declarations of VLA of undefined or zero size">,
 105   DescFile<"VLASizeChecker.cpp">;
 106
 107 def DivZeroChecker : Checker<"DivideZero">,
 108   HelpText<"Check for division by zero">,
 109   DescFile<"DivZeroChecker.cpp">;
 110
 111 def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">,
 112   HelpText<"Check for undefined results of binary operators">,
 113   DescFile<"UndefResultChecker.cpp">;
 114
 115 def StackAddrEscapeChecker : Checker<"StackAddressEscape">,
 116   HelpText<"Check that addresses to stack memory do not escape the function">,
 117   DescFile<"StackAddrEscapeChecker.cpp">;
 118
 119 def DynamicTypePropagation : Checker<"DynamicTypePropagation">,
 120   HelpText<"Generate dynamic type information">,
 121   DescFile<"DynamicTypePropagation.cpp">;
 122
 123 } // end "core"
 124
 125 let ParentPackage = CoreAlpha in {
 126
 127 def BoolAssignmentChecker : Checker<"BoolAssignment">,
 128   HelpText<"Warn about assigning non-{0,1} values to Boolean variables">,
 129   DescFile<"BoolAssignmentChecker.cpp">;
 130
 131 def CastSizeChecker : Checker<"CastSize">,
 132   HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
 133   DescFile<"CastSizeChecker.cpp">;
 134
 135 def CastToStructChecker : Checker<"CastToStruct">,
 136   HelpText<"Check for cast from non-struct pointer to struct pointer">,
 137   DescFile<"CastToStructChecker.cpp">;
 138
 139 def ConversionChecker : Checker<"Conversion">,
 140   HelpText<"Loss of sign/precision in implicit conversions">,
 141   DescFile<"ConversionChecker.cpp">;
 142
 143 def IdenticalExprChecker : Checker<"IdenticalExpr">,
 144   HelpText<"Warn about unintended use of identical expressions in operators">,
 145   DescFile<"IdenticalExprChecker.cpp">;
 146
 147 def FixedAddressChecker : Checker<"FixedAddr">,
 148   HelpText<"Check for assignment of a fixed address to a pointer">,
 149   DescFile<"FixedAddressChecker.cpp">;
 150
 151 def PointerArithChecker : Checker<"PointerArithm">,
 152   HelpText<"Check for pointer arithmetic on locations other than array elements">,
 153   DescFile<"PointerArithChecker">;
 154
 155 def PointerSubChecker : Checker<"PointerSub">,
 156   HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
 157   DescFile<"PointerSubChecker">;
 158
 159 def SizeofPointerChecker : Checker<"SizeofPtr">,
 160   HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
 161   DescFile<"CheckSizeofPointer.cpp">;
 162
 163 def CallAndMessageUnInitRefArg : Checker<"CallAndMessageUnInitRefArg">,
 164   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)">,
 165   DescFile<"CallAndMessageChecker.cpp">;
 166
 167 def TestAfterDivZeroChecker : Checker<"TestAfterDivZero">,
 168   HelpText<"Check for division by variable that is later compared against 0. Either the comparison is useless or there is division by zero.">,
 169   DescFile<"TestAfterDivZeroChecker.cpp">;
 170
 171 def DynamicTypeChecker : Checker<"DynamicTypeChecker">,
 172   HelpText<"Check for cases where the dynamic and the static type of an object are unrelated.">,
 173   DescFile<"DynamicTypeChecker.cpp">;
 174
 175 } // end "alpha.core"
 176
 177 let ParentPackage = Nullability in {
 178
 179 def NullPassedToNonnullChecker : Checker<"NullPassedToNonnull">,
 180   HelpText<"Warns when a null pointer is passed to a pointer which has a _Nonnull type.">,
 181   DescFile<"NullabilityChecker.cpp">;
 182
 183 def NullReturnedFromNonnullChecker : Checker<"NullReturnedFromNonnull">,
 184   HelpText<"Warns when a null pointer is returned from a function that has _Nonnull return type.">,
 185   DescFile<"NullabilityChecker.cpp">;
 186
 187 def NullableDereferencedChecker : Checker<"NullableDereferenced">,
 188   HelpText<"Warns when a nullable pointer is dereferenced.">,
 189   DescFile<"NullabilityChecker.cpp">;
 190
 191 def NullablePassedToNonnullChecker : Checker<"NullablePassedToNonnull">,
 192   HelpText<"Warns when a nullable pointer is passed to a pointer which has a _Nonnull type.">,
 193   DescFile<"NullabilityChecker.cpp">;
 194
 195 def NullableReturnedFromNonnullChecker : Checker<"NullablePassedToNonnull">,
 196   HelpText<"Warns when a nullable pointer is returned from a function that has _Nonnull return type.">,
 197   DescFile<"NullabilityChecker.cpp">;
 198
 199 } // end "nullability"
 200
 201 //===----------------------------------------------------------------------===//
 202 // Evaluate "builtin" functions.
 203 //===----------------------------------------------------------------------===//
 204
 205 let ParentPackage = CoreBuiltin in {
 206
 207 def NoReturnFunctionChecker : Checker<"NoReturnFunctions">,
 208   HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">,
 209   DescFile<"NoReturnFunctionChecker.cpp">;
 210
 211 def BuiltinFunctionChecker : Checker<"BuiltinFunctions">,
 212   HelpText<"Evaluate compiler builtin functions (e.g., alloca())">,
 213   DescFile<"BuiltinFunctionChecker.cpp">;
 214
 215 } // end "core.builtin"
 216
 217 //===----------------------------------------------------------------------===//
 218 // Uninitialized values checkers.
 219 //===----------------------------------------------------------------------===//
 220
 221 let ParentPackage = CoreUninitialized in {
 222
 223 def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">,
 224   HelpText<"Check for uninitialized values used as array subscripts">,
 225   DescFile<"UndefinedArraySubscriptChecker.cpp">;
 226
 227 def UndefinedAssignmentChecker : Checker<"Assign">,
 228   HelpText<"Check for assigning uninitialized values">,
 229   DescFile<"UndefinedAssignmentChecker.cpp">;
 230
 231 def UndefBranchChecker : Checker<"Branch">,
 232   HelpText<"Check for uninitialized values used as branch conditions">,
 233   DescFile<"UndefBranchChecker.cpp">;
 234
 235 def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">,
 236   HelpText<"Check for blocks that capture uninitialized values">,
 237   DescFile<"UndefCapturedBlockVarChecker.cpp">;
 238
 239 def ReturnUndefChecker : Checker<"UndefReturn">,
 240   HelpText<"Check for uninitialized values being returned to the caller">,
 241   DescFile<"ReturnUndefChecker.cpp">;
 242
 243 } // end "core.uninitialized"
 244
 245 //===----------------------------------------------------------------------===//
 246 // C++ checkers.
 247 //===----------------------------------------------------------------------===//
 248
 249 let ParentPackage = Cplusplus in {
 250
 251 def NewDeleteChecker : Checker<"NewDelete">,
 252   HelpText<"Check for double-free and use-after-free problems. Traces memory managed by new/delete.">,
 253   DescFile<"MallocChecker.cpp">;
 254
 255 def NewDeleteLeaksChecker : Checker<"NewDeleteLeaks">,
 256   HelpText<"Check for memory leaks. Traces memory managed by new/delete.">,
 257   DescFile<"MallocChecker.cpp">;
 258
 259 def CXXSelfAssignmentChecker : Checker<"SelfAssignment">,
 260   HelpText<"Checks C++ copy and move assignment operators for self assignment">,
 261   DescFile<"CXXSelfAssignmentChecker.cpp">;
 262
 263 } // end: "cplusplus"
 264
 265 let ParentPackage = CplusplusAlpha in {
 266
 267 def VirtualCallChecker : Checker<"VirtualCall">,
 268   HelpText<"Check virtual function calls during construction or destruction">,
 269   DescFile<"VirtualCallChecker.cpp">;
 270
 271 } // end: "alpha.cplusplus"
 272
 273
 274 //===----------------------------------------------------------------------===//
 275 // Valist checkers.
 276 //===----------------------------------------------------------------------===//
 277
 278 let ParentPackage = ValistAlpha in {
 279
 280 def UninitializedChecker : Checker<"Uninitialized">,
 281   HelpText<"Check for usages of uninitialized (or already released) va_lists.">,
 282   DescFile<"ValistChecker.cpp">;
 283
 284 def UnterminatedChecker : Checker<"Unterminated">,
 285   HelpText<"Check for va_lists which are not released by a va_end call.">,
 286   DescFile<"ValistChecker.cpp">;
 287
 288 def CopyToSelfChecker : Checker<"CopyToSelf">,
 289   HelpText<"Check for va_lists which are copied onto itself.">,
 290   DescFile<"ValistChecker.cpp">;
 291
 292 } // end : "alpha.valist"
 293
 294 //===----------------------------------------------------------------------===//
 295 // Deadcode checkers.
 296 //===----------------------------------------------------------------------===//
 297
 298 let ParentPackage = DeadCode in {
 299
 300 def DeadStoresChecker : Checker<"DeadStores">,
 301   HelpText<"Check for values stored to variables that are never read afterwards">,
 302   DescFile<"DeadStoresChecker.cpp">;
 303 } // end DeadCode
 304
 305 let ParentPackage = DeadCodeAlpha in {
 306
 307 def UnreachableCodeChecker : Checker<"UnreachableCode">,
 308   HelpText<"Check unreachable code">,
 309   DescFile<"UnreachableCodeChecker.cpp">;
 310
 311 } // end "alpha.deadcode"
 312
 313 //===----------------------------------------------------------------------===//
 314 // Performance checkers.
 315 //===----------------------------------------------------------------------===//
 316
 317 let ParentPackage = Performance in {
 318
 319 def PaddingChecker : Checker<"Padding">,
 320   HelpText<"Check for excessively padded structs.">,
 321   DescFile<"PaddingChecker.cpp">;
 322
 323 } // end: "padding"
 324
 325 //===----------------------------------------------------------------------===//
 326 // Security checkers.
 327 //===----------------------------------------------------------------------===//
 328
 329 let ParentPackage = InsecureAPI in {
 330   def gets : Checker<"gets">,
 331     HelpText<"Warn on uses of the 'gets' function">,
 332     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 333   def getpw : Checker<"getpw">,
 334     HelpText<"Warn on uses of the 'getpw' function">,
 335     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 336   def mktemp : Checker<"mktemp">,
 337     HelpText<"Warn on uses of the 'mktemp' function">,
 338     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 339   def mkstemp : Checker<"mkstemp">,
 340     HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">,
 341     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 342   def rand : Checker<"rand">,
 343     HelpText<"Warn on uses of the 'rand', 'random', and related functions">,
 344     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 345   def strcpy : Checker<"strcpy">,
 346     HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">,
 347     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 348   def vfork : Checker<"vfork">,
 349     HelpText<"Warn on uses of the 'vfork' function">,
 350     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 351   def UncheckedReturn : Checker<"UncheckedReturn">,
 352     HelpText<"Warn on uses of functions whose return values must be always checked">,
 353     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 354 }
 355 let ParentPackage = Security in {
 356   def FloatLoopCounter : Checker<"FloatLoopCounter">,
 357     HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">,
 358     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 359 }
 360
 361 let ParentPackage = SecurityAlpha in {
 362
 363 def ArrayBoundChecker : Checker<"ArrayBound">,
 364   HelpText<"Warn about buffer overflows (older checker)">,
 365   DescFile<"ArrayBoundChecker.cpp">;
 366
 367 def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
 368   HelpText<"Warn about buffer overflows (newer checker)">,
 369   DescFile<"ArrayBoundCheckerV2.cpp">;
 370
 371 def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
 372   HelpText<"Check for an out-of-bound pointer being returned to callers">,
 373   DescFile<"ReturnPointerRangeChecker.cpp">;
 374
 375 def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
 376   HelpText<"Check for overflows in the arguments to malloc()">,
 377   DescFile<"MallocOverflowSecurityChecker.cpp">;
 378
 379 } // end "alpha.security"
 380
 381 //===----------------------------------------------------------------------===//
 382 // Taint checkers.
 383 //===----------------------------------------------------------------------===//
 384
 385 let ParentPackage = Taint in {
 386
 387 def GenericTaintChecker : Checker<"TaintPropagation">,
 388   HelpText<"Generate taint information used by other checkers">,
 389   DescFile<"GenericTaintChecker.cpp">;
 390
 391 } // end "alpha.security.taint"
 392
 393 //===----------------------------------------------------------------------===//
 394 // Unix API checkers.
 395 //===----------------------------------------------------------------------===//
 396
 397 let ParentPackage = Unix in {
 398
 399 def UnixAPIChecker : Checker<"API">,
 400   HelpText<"Check calls to various UNIX/Posix functions">,
 401   DescFile<"UnixAPIChecker.cpp">;
 402
 403 def MallocChecker: Checker<"Malloc">,
 404   HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free().">,
 405   DescFile<"MallocChecker.cpp">;
 406
 407 def MallocSizeofChecker : Checker<"MallocSizeof">,
 408   HelpText<"Check for dubious malloc arguments involving sizeof">,
 409   DescFile<"MallocSizeofChecker.cpp">;
 410
 411 def MismatchedDeallocatorChecker : Checker<"MismatchedDeallocator">,
 412   HelpText<"Check for mismatched deallocators.">,
 413   DescFile<"MallocChecker.cpp">;
 414
 415 def VforkChecker : Checker<"Vfork">,
 416   HelpText<"Check for proper usage of vfork">,
 417   DescFile<"VforkChecker.cpp">;
 418
 419 } // end "unix"
 420
 421 let ParentPackage = UnixAlpha in {
 422
 423 def ChrootChecker : Checker<"Chroot">,
 424   HelpText<"Check improper use of chroot">,
 425   DescFile<"ChrootChecker.cpp">;
 426
 427 def PthreadLockChecker : Checker<"PthreadLock">,
 428   HelpText<"Simple lock -> unlock checker">,
 429   DescFile<"PthreadLockChecker.cpp">;
 430
 431 def StreamChecker : Checker<"Stream">,
 432   HelpText<"Check stream handling functions">,
 433   DescFile<"StreamChecker.cpp">;
 434
 435 def SimpleStreamChecker : Checker<"SimpleStream">,
 436   HelpText<"Check for misuses of stream APIs">,
 437   DescFile<"SimpleStreamChecker.cpp">;
 438
 439 } // end "alpha.unix"
 440
 441 let ParentPackage = CString in {
 442
 443 def CStringNullArg : Checker<"NullArg">,
 444   HelpText<"Check for null pointers being passed as arguments to C string functions">,
 445   DescFile<"CStringChecker.cpp">;
 446
 447 def CStringSyntaxChecker : Checker<"BadSizeArg">,
 448   HelpText<"Check the size argument passed into C string functions for common erroneous patterns">,
 449   DescFile<"CStringSyntaxChecker.cpp">;
 450 }
 451
 452 let ParentPackage = CStringAlpha in {
 453
 454 def CStringOutOfBounds : Checker<"OutOfBounds">,
 455   HelpText<"Check for out-of-bounds access in string functions">,
 456   DescFile<"CStringChecker.cpp">;
 457
 458 def CStringBufferOverlap : Checker<"BufferOverlap">,
 459   HelpText<"Checks for overlap in two buffer arguments">,
 460   DescFile<"CStringChecker.cpp">;
 461
 462 def CStringNotNullTerm : Checker<"NotNullTerminated">,
 463   HelpText<"Check for arguments which are not null-terminating strings">,
 464   DescFile<"CStringChecker.cpp">;
 465 }
 466
 467 //===----------------------------------------------------------------------===//
 468 // Mac OS X, Cocoa, and Core Foundation checkers.
 469 //===----------------------------------------------------------------------===//
 470
 471 let ParentPackage = OSX in {
 472
 473 def MacOSXAPIChecker : Checker<"API">,
 474   InPackage<OSX>,
 475   HelpText<"Check for proper uses of various Apple APIs">,
 476   DescFile<"MacOSXAPIChecker.cpp">;
 477
 478 def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">,
 479   InPackage<OSX>,
 480   HelpText<"Check for proper uses of Secure Keychain APIs">,
 481   DescFile<"MacOSKeychainAPIChecker.cpp">;
 482
 483 } // end "osx"
 484
 485 let ParentPackage = Cocoa in {
 486
 487 def ObjCAtSyncChecker : Checker<"AtSync">,
 488   HelpText<"Check for nil pointers used as mutexes for @synchronized">,
 489   DescFile<"ObjCAtSyncChecker.cpp">;
 490
 491 def NilArgChecker : Checker<"NilArg">,
 492   HelpText<"Check for prohibited nil arguments to ObjC method calls">,
 493   DescFile<"BasicObjCFoundationChecks.cpp">;
 494
 495 def ClassReleaseChecker : Checker<"ClassRelease">,
 496   HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
 497   DescFile<"BasicObjCFoundationChecks.cpp">;
 498
 499 def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
 500   HelpText<"Check for passing non-Objective-C types to variadic collection "
 501            "initialization methods that expect only Objective-C types">,
 502   DescFile<"BasicObjCFoundationChecks.cpp">;
 503
 504 def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
 505   HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
 506   DescFile<"NSAutoreleasePoolChecker.cpp">;
 507
 508 def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
 509   HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
 510   DescFile<"CheckObjCInstMethSignature.cpp">;
 511
 512 def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
 513   HelpText<"Warn about private ivars that are never used">,
 514   DescFile<"ObjCUnusedIVarsChecker.cpp">;
 515
 516 def ObjCSelfInitChecker : Checker<"SelfInit">,
 517   HelpText<"Check that 'self' is properly initialized inside an initializer method">,
 518   DescFile<"ObjCSelfInitChecker.cpp">;
 519
 520 def ObjCLoopChecker : Checker<"Loops">,
 521   HelpText<"Improved modeling of loops using Cocoa collection types">,
 522   DescFile<"BasicObjCFoundationChecks.cpp">;
 523
 524 def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">,
 525   HelpText<"Model the APIs that are guaranteed to return a non-nil value">,
 526   DescFile<"BasicObjCFoundationChecks.cpp">;
 527
 528 def ObjCSuperCallChecker : Checker<"MissingSuperCall">,
 529   HelpText<"Warn about Objective-C methods that lack a necessary call to super">,
 530   DescFile<"ObjCMissingSuperCallChecker.cpp">;
 531
 532 def NSErrorChecker : Checker<"NSError">,
 533   HelpText<"Check usage of NSError** parameters">,
 534   DescFile<"NSErrorChecker.cpp">;
 535
 536 def RetainCountChecker : Checker<"RetainCount">,
 537   HelpText<"Check for leaks and improper reference count management">,
 538   DescFile<"RetainCountChecker.cpp">;
 539
 540 def ObjCGenericsChecker : Checker<"ObjCGenerics">,
 541   HelpText<"Check for type errors when using Objective-C generics">,
 542   DescFile<"DynamicTypePropagation.cpp">;
 543
 544 def ObjCDeallocChecker : Checker<"Dealloc">,
 545   HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
 546   DescFile<"CheckObjCDealloc.cpp">;
 547
 548 def ObjCSuperDeallocChecker : Checker<"SuperDealloc">,
 549   HelpText<"Warn about improper use of '[super dealloc]' in Objective-C">,
 550   DescFile<"ObjCSuperDeallocChecker.cpp">;
 551
 552 } // end "osx.cocoa"
 553
 554 let ParentPackage = CocoaAlpha in {
 555
 556 def InstanceVariableInvalidation : Checker<"InstanceVariableInvalidation">,
 557   HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
 558   DescFile<"IvarInvalidationChecker.cpp">;
 559
 560 def MissingInvalidationMethod : Checker<"MissingInvalidationMethod">,
 561   HelpText<"Check that the invalidation methods are present in classes that contain invalidatable instance variables">,
 562   DescFile<"IvarInvalidationChecker.cpp">;
 563
 564 def DirectIvarAssignment : Checker<"DirectIvarAssignment">,
 565   HelpText<"Check for direct assignments to instance variables">,
 566   DescFile<"DirectIvarAssignment.cpp">;
 567
 568 def DirectIvarAssignmentForAnnotatedFunctions : Checker<"DirectIvarAssignmentForAnnotatedFunctions">,
 569   HelpText<"Check for direct assignments to instance variables in the methods annotated with objc_no_direct_instance_variable_assignment">,
 570   DescFile<"DirectIvarAssignment.cpp">;
 571
 572 } // end "alpha.osx.cocoa"
 573
 574 let ParentPackage = CoreFoundation in {
 575
 576 def CFNumberCreateChecker : Checker<"CFNumber">,
 577   HelpText<"Check for proper uses of CFNumberCreate">,
 578   DescFile<"BasicObjCFoundationChecks.cpp">;
 579
 580 def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
 581   HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">,
 582   DescFile<"BasicObjCFoundationChecks.cpp">;
 583
 584 def CFErrorChecker : Checker<"CFError">,
 585   HelpText<"Check usage of CFErrorRef* parameters">,
 586   DescFile<"NSErrorChecker.cpp">;
 587 }
 588
 589 let ParentPackage = Containers in {
 590 def ObjCContainersASTChecker : Checker<"PointerSizedValues">,
 591   HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">,
 592   DescFile<"ObjCContainersASTChecker.cpp">;
 593
 594 def ObjCContainersChecker : Checker<"OutOfBounds">,
 595   HelpText<"Checks for index out-of-bounds when using 'CFArray' API">,
 596   DescFile<"ObjCContainersChecker.cpp">;
 597
 598 }
 599
 600 let ParentPackage = LocalizabilityOptIn in {
 601 def NonLocalizedStringChecker : Checker<"NonLocalizedStringChecker">,
 602   HelpText<"Warns about uses of non-localized NSStrings passed to UI methods expecting localized NSStrings">,
 603   DescFile<"LocalizationChecker.cpp">;
 604
 605 def EmptyLocalizationContextChecker : Checker<"EmptyLocalizationContextChecker">,
 606   HelpText<"Check that NSLocalizedString macros include a comment for context">,
 607   DescFile<"LocalizationChecker.cpp">;
 608 }
 609
 610 let ParentPackage = LocalizabilityAlpha in {
 611 def PluralMisuseChecker : Checker<"PluralMisuseChecker">,
 612   HelpText<"Warns against using one vs. many plural pattern in code when generating localized strings.">,
 613   DescFile<"LocalizationChecker.cpp">;
 614 }
 615
 616 let ParentPackage = MPI in {
 617   def MPIChecker : Checker<"MPI-Checker">,
 618   HelpText<"Checks MPI code">,
 619   DescFile<"MPIChecker.cpp">;
 620 }
 621
 622 //===----------------------------------------------------------------------===//
 623 // Checkers for LLVM development.
 624 //===----------------------------------------------------------------------===//
 625
 626 def LLVMConventionsChecker : Checker<"Conventions">,
 627   InPackage<LLVM>,
 628   HelpText<"Check code for LLVM codebase conventions">,
 629   DescFile<"LLVMConventionsChecker.cpp">;
 630
 631 //===----------------------------------------------------------------------===//
 632 // Debugging checkers (for analyzer development).
 633 //===----------------------------------------------------------------------===//
 634
 635 let ParentPackage = Debug in {
 636
 637 def DominatorsTreeDumper : Checker<"DumpDominators">,
 638   HelpText<"Print the dominance tree for a given CFG">,
 639   DescFile<"DebugCheckers.cpp">;
 640
 641 def LiveVariablesDumper : Checker<"DumpLiveVars">,
 642   HelpText<"Print results of live variable analysis">,
 643   DescFile<"DebugCheckers.cpp">;
 644
 645 def CFGViewer : Checker<"ViewCFG">,
 646   HelpText<"View Control-Flow Graphs using GraphViz">,
 647   DescFile<"DebugCheckers.cpp">;
 648
 649 def CFGDumper : Checker<"DumpCFG">,
 650   HelpText<"Display Control-Flow Graphs">,
 651   DescFile<"DebugCheckers.cpp">;
 652
 653 def CallGraphViewer : Checker<"ViewCallGraph">,
 654   HelpText<"View Call Graph using GraphViz">,
 655   DescFile<"DebugCheckers.cpp">;
 656
 657 def CallGraphDumper : Checker<"DumpCallGraph">,
 658   HelpText<"Display Call Graph">,
 659   DescFile<"DebugCheckers.cpp">;
 660
 661 def ConfigDumper : Checker<"ConfigDumper">,
 662   HelpText<"Dump config table">,
 663   DescFile<"DebugCheckers.cpp">;
 664
 665 def TraversalDumper : Checker<"DumpTraversal">,
 666   HelpText<"Print branch conditions as they are traversed by the engine">,
 667   DescFile<"TraversalChecker.cpp">;
 668
 669 def CallDumper : Checker<"DumpCalls">,
 670   HelpText<"Print calls as they are traversed by the engine">,
 671   DescFile<"TraversalChecker.cpp">;
 672
 673 def AnalyzerStatsChecker : Checker<"Stats">,
 674   HelpText<"Emit warnings with analyzer statistics">,
 675   DescFile<"AnalyzerStatsChecker.cpp">;
 676
 677 def TaintTesterChecker : Checker<"TaintTest">,
 678   HelpText<"Mark tainted symbols as such.">,
 679   DescFile<"TaintTesterChecker.cpp">;
 680
 681 def ExprInspectionChecker : Checker<"ExprInspection">,
 682   HelpText<"Check the analyzer's understanding of expressions">,
 683   DescFile<"ExprInspectionChecker.cpp">;
 684
 685 def ExplodedGraphViewer : Checker<"ViewExplodedGraph">,
 686   HelpText<"View Exploded Graphs using GraphViz">,
 687   DescFile<"DebugCheckers.cpp">;
 688
 689 def BugHashDumper : Checker<"DumpBugHash">,
 690   HelpText<"Dump the bug hash for all statements.">,
 691   DescFile<"DebugCheckers.cpp">;
 692
 693 } // end "debug"
 694
 695
 696 //===----------------------------------------------------------------------===//
 697 // Clone Detection
 698 //===----------------------------------------------------------------------===//
 699
 700 let ParentPackage = CloneDetectionAlpha in {
 701
 702 def CloneChecker : Checker<"CloneChecker">,
 703   HelpText<"Reports similar pieces of code.">,
 704   DescFile<"CloneChecker.cpp">;
 705
 706 } // end "clone"
 707