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