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 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 IteratorPastEndChecker : Checker<"IteratorPastEnd">,
 283   HelpText<"Check iterators used past end">,
 284   DescFile<"IteratorPastEndChecker.cpp">;
 285
 286 } // end: "alpha.cplusplus"
 287
 288
 289 //===----------------------------------------------------------------------===//
 290 // Valist checkers.
 291 //===----------------------------------------------------------------------===//
 292
 293 let ParentPackage = Valist in {
 294
 295 def UninitializedChecker : Checker<"Uninitialized">,
 296   HelpText<"Check for usages of uninitialized (or already released) va_lists.">,
 297   DescFile<"ValistChecker.cpp">;
 298
 299 def UnterminatedChecker : Checker<"Unterminated">,
 300   HelpText<"Check for va_lists which are not released by a va_end call.">,
 301   DescFile<"ValistChecker.cpp">;
 302
 303 def CopyToSelfChecker : Checker<"CopyToSelf">,
 304   HelpText<"Check for va_lists which are copied onto itself.">,
 305   DescFile<"ValistChecker.cpp">;
 306
 307 } // end : "valist"
 308
 309 //===----------------------------------------------------------------------===//
 310 // Deadcode checkers.
 311 //===----------------------------------------------------------------------===//
 312
 313 let ParentPackage = DeadCode in {
 314
 315 def DeadStoresChecker : Checker<"DeadStores">,
 316   HelpText<"Check for values stored to variables that are never read afterwards">,
 317   DescFile<"DeadStoresChecker.cpp">;
 318 } // end DeadCode
 319
 320 let ParentPackage = DeadCodeAlpha in {
 321
 322 def UnreachableCodeChecker : Checker<"UnreachableCode">,
 323   HelpText<"Check unreachable code">,
 324   DescFile<"UnreachableCodeChecker.cpp">;
 325
 326 } // end "alpha.deadcode"
 327
 328 //===----------------------------------------------------------------------===//
 329 // Performance checkers.
 330 //===----------------------------------------------------------------------===//
 331
 332 let ParentPackage = Performance in {
 333
 334 def PaddingChecker : Checker<"Padding">,
 335   HelpText<"Check for excessively padded structs.">,
 336   DescFile<"PaddingChecker.cpp">;
 337
 338 } // end: "padding"
 339
 340 //===----------------------------------------------------------------------===//
 341 // Security checkers.
 342 //===----------------------------------------------------------------------===//
 343
 344 let ParentPackage = InsecureAPI in {
 345   def gets : Checker<"gets">,
 346     HelpText<"Warn on uses of the 'gets' function">,
 347     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 348   def getpw : Checker<"getpw">,
 349     HelpText<"Warn on uses of the 'getpw' function">,
 350     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 351   def mktemp : Checker<"mktemp">,
 352     HelpText<"Warn on uses of the 'mktemp' function">,
 353     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 354   def mkstemp : Checker<"mkstemp">,
 355     HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">,
 356     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 357   def rand : Checker<"rand">,
 358     HelpText<"Warn on uses of the 'rand', 'random', and related functions">,
 359     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 360   def strcpy : Checker<"strcpy">,
 361     HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">,
 362     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 363   def vfork : Checker<"vfork">,
 364     HelpText<"Warn on uses of the 'vfork' function">,
 365     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 366   def UncheckedReturn : Checker<"UncheckedReturn">,
 367     HelpText<"Warn on uses of functions whose return values must be always checked">,
 368     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 369 }
 370 let ParentPackage = Security in {
 371   def FloatLoopCounter : Checker<"FloatLoopCounter">,
 372     HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">,
 373     DescFile<"CheckSecuritySyntaxOnly.cpp">;
 374 }
 375
 376 let ParentPackage = SecurityAlpha in {
 377
 378 def ArrayBoundChecker : Checker<"ArrayBound">,
 379   HelpText<"Warn about buffer overflows (older checker)">,
 380   DescFile<"ArrayBoundChecker.cpp">;
 381
 382 def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">,
 383   HelpText<"Warn about buffer overflows (newer checker)">,
 384   DescFile<"ArrayBoundCheckerV2.cpp">;
 385
 386 def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
 387   HelpText<"Check for an out-of-bound pointer being returned to callers">,
 388   DescFile<"ReturnPointerRangeChecker.cpp">;
 389
 390 def MallocOverflowSecurityChecker : Checker<"MallocOverflow">,
 391   HelpText<"Check for overflows in the arguments to malloc()">,
 392   DescFile<"MallocOverflowSecurityChecker.cpp">;
 393
 394 } // end "alpha.security"
 395
 396 //===----------------------------------------------------------------------===//
 397 // Taint checkers.
 398 //===----------------------------------------------------------------------===//
 399
 400 let ParentPackage = Taint in {
 401
 402 def GenericTaintChecker : Checker<"TaintPropagation">,
 403   HelpText<"Generate taint information used by other checkers">,
 404   DescFile<"GenericTaintChecker.cpp">;
 405
 406 } // end "alpha.security.taint"
 407
 408 //===----------------------------------------------------------------------===//
 409 // Unix API checkers.
 410 //===----------------------------------------------------------------------===//
 411
 412 let ParentPackage = Unix in {
 413
 414 def UnixAPIChecker : Checker<"API">,
 415   HelpText<"Check calls to various UNIX/Posix functions">,
 416   DescFile<"UnixAPIChecker.cpp">;
 417
 418 def MallocChecker: Checker<"Malloc">,
 419   HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free().">,
 420   DescFile<"MallocChecker.cpp">;
 421
 422 def MallocSizeofChecker : Checker<"MallocSizeof">,
 423   HelpText<"Check for dubious malloc arguments involving sizeof">,
 424   DescFile<"MallocSizeofChecker.cpp">;
 425
 426 def MismatchedDeallocatorChecker : Checker<"MismatchedDeallocator">,
 427   HelpText<"Check for mismatched deallocators.">,
 428   DescFile<"MallocChecker.cpp">;
 429
 430 def VforkChecker : Checker<"Vfork">,
 431   HelpText<"Check for proper usage of vfork">,
 432   DescFile<"VforkChecker.cpp">;
 433
 434 def StdCLibraryFunctionsChecker : Checker<"StdCLibraryFunctions">,
 435   HelpText<"Improve modeling of the C standard library functions">,
 436   DescFile<"StdLibraryFunctionsChecker.cpp">;
 437
 438 } // end "unix"
 439
 440 let ParentPackage = UnixAlpha in {
 441
 442 def ChrootChecker : Checker<"Chroot">,
 443   HelpText<"Check improper use of chroot">,
 444   DescFile<"ChrootChecker.cpp">;
 445
 446 def PthreadLockChecker : Checker<"PthreadLock">,
 447   HelpText<"Simple lock -> unlock checker">,
 448   DescFile<"PthreadLockChecker.cpp">;
 449
 450 def StreamChecker : Checker<"Stream">,
 451   HelpText<"Check stream handling functions">,
 452   DescFile<"StreamChecker.cpp">;
 453
 454 def SimpleStreamChecker : Checker<"SimpleStream">,
 455   HelpText<"Check for misuses of stream APIs">,
 456   DescFile<"SimpleStreamChecker.cpp">;
 457
 458 def BlockInCriticalSectionChecker : Checker<"BlockInCriticalSection">,
 459   HelpText<"Check for calls to blocking functions inside a critical section">,
 460   DescFile<"BlockInCriticalSectionChecker.cpp">;
 461
 462 } // end "alpha.unix"
 463
 464 let ParentPackage = CString in {
 465
 466 def CStringNullArg : Checker<"NullArg">,
 467   HelpText<"Check for null pointers being passed as arguments to C string functions">,
 468   DescFile<"CStringChecker.cpp">;
 469
 470 def CStringSyntaxChecker : Checker<"BadSizeArg">,
 471   HelpText<"Check the size argument passed into C string functions for common erroneous patterns">,
 472   DescFile<"CStringSyntaxChecker.cpp">;
 473 }
 474
 475 let ParentPackage = CStringAlpha in {
 476
 477 def CStringOutOfBounds : Checker<"OutOfBounds">,
 478   HelpText<"Check for out-of-bounds access in string functions">,
 479   DescFile<"CStringChecker.cpp">;
 480
 481 def CStringBufferOverlap : Checker<"BufferOverlap">,
 482   HelpText<"Checks for overlap in two buffer arguments">,
 483   DescFile<"CStringChecker.cpp">;
 484
 485 def CStringNotNullTerm : Checker<"NotNullTerminated">,
 486   HelpText<"Check for arguments which are not null-terminating strings">,
 487   DescFile<"CStringChecker.cpp">;
 488 }
 489
 490 //===----------------------------------------------------------------------===//
 491 // Mac OS X, Cocoa, and Core Foundation checkers.
 492 //===----------------------------------------------------------------------===//
 493
 494 let ParentPackage = OSX in {
 495
 496 def NumberObjectConversionChecker : Checker<"NumberObjectConversion">,
 497   HelpText<"Check for erroneous conversions of objects representing numbers into numbers">,
 498   DescFile<"NumberObjectConversionChecker.cpp">;
 499
 500 def MacOSXAPIChecker : Checker<"API">,
 501   HelpText<"Check for proper uses of various Apple APIs">,
 502   DescFile<"MacOSXAPIChecker.cpp">;
 503
 504 def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">,
 505   HelpText<"Check for proper uses of Secure Keychain APIs">,
 506   DescFile<"MacOSKeychainAPIChecker.cpp">;
 507
 508 def ObjCPropertyChecker : Checker<"ObjCProperty">,
 509   HelpText<"Check for proper uses of Objective-C properties">,
 510   DescFile<"ObjCPropertyChecker.cpp">;
 511
 512 } // end "osx"
 513
 514 let ParentPackage = Cocoa in {
 515
 516 def ObjCAtSyncChecker : Checker<"AtSync">,
 517   HelpText<"Check for nil pointers used as mutexes for @synchronized">,
 518   DescFile<"ObjCAtSyncChecker.cpp">;
 519
 520 def NilArgChecker : Checker<"NilArg">,
 521   HelpText<"Check for prohibited nil arguments to ObjC method calls">,
 522   DescFile<"BasicObjCFoundationChecks.cpp">;
 523
 524 def ClassReleaseChecker : Checker<"ClassRelease">,
 525   HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
 526   DescFile<"BasicObjCFoundationChecks.cpp">;
 527
 528 def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">,
 529   HelpText<"Check for passing non-Objective-C types to variadic collection "
 530            "initialization methods that expect only Objective-C types">,
 531   DescFile<"BasicObjCFoundationChecks.cpp">;
 532
 533 def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
 534   HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">,
 535   DescFile<"NSAutoreleasePoolChecker.cpp">;
 536
 537 def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">,
 538   HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
 539   DescFile<"CheckObjCInstMethSignature.cpp">;
 540
 541 def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
 542   HelpText<"Warn about private ivars that are never used">,
 543   DescFile<"ObjCUnusedIVarsChecker.cpp">;
 544
 545 def ObjCSelfInitChecker : Checker<"SelfInit">,
 546   HelpText<"Check that 'self' is properly initialized inside an initializer method">,
 547   DescFile<"ObjCSelfInitChecker.cpp">;
 548
 549 def ObjCLoopChecker : Checker<"Loops">,
 550   HelpText<"Improved modeling of loops using Cocoa collection types">,
 551   DescFile<"BasicObjCFoundationChecks.cpp">;
 552
 553 def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">,
 554   HelpText<"Model the APIs that are guaranteed to return a non-nil value">,
 555   DescFile<"BasicObjCFoundationChecks.cpp">;
 556
 557 def ObjCSuperCallChecker : Checker<"MissingSuperCall">,
 558   HelpText<"Warn about Objective-C methods that lack a necessary call to super">,
 559   DescFile<"ObjCMissingSuperCallChecker.cpp">;
 560
 561 def NSErrorChecker : Checker<"NSError">,
 562   HelpText<"Check usage of NSError** parameters">,
 563   DescFile<"NSErrorChecker.cpp">;
 564
 565 def RetainCountChecker : Checker<"RetainCount">,
 566   HelpText<"Check for leaks and improper reference count management">,
 567   DescFile<"RetainCountChecker.cpp">;
 568
 569 def ObjCGenericsChecker : Checker<"ObjCGenerics">,
 570   HelpText<"Check for type errors when using Objective-C generics">,
 571   DescFile<"DynamicTypePropagation.cpp">;
 572
 573 def ObjCDeallocChecker : Checker<"Dealloc">,
 574   HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
 575   DescFile<"CheckObjCDealloc.cpp">;
 576
 577 def ObjCSuperDeallocChecker : Checker<"SuperDealloc">,
 578   HelpText<"Warn about improper use of '[super dealloc]' in Objective-C">,
 579   DescFile<"ObjCSuperDeallocChecker.cpp">;
 580
 581 } // end "osx.cocoa"
 582
 583 let ParentPackage = CocoaAlpha in {
 584
 585 def InstanceVariableInvalidation : Checker<"InstanceVariableInvalidation">,
 586   HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">,
 587   DescFile<"IvarInvalidationChecker.cpp">;
 588
 589 def MissingInvalidationMethod : Checker<"MissingInvalidationMethod">,
 590   HelpText<"Check that the invalidation methods are present in classes that contain invalidatable instance variables">,
 591   DescFile<"IvarInvalidationChecker.cpp">;
 592
 593 def DirectIvarAssignment : Checker<"DirectIvarAssignment">,
 594   HelpText<"Check for direct assignments to instance variables">,
 595   DescFile<"DirectIvarAssignment.cpp">;
 596
 597 def DirectIvarAssignmentForAnnotatedFunctions : Checker<"DirectIvarAssignmentForAnnotatedFunctions">,
 598   HelpText<"Check for direct assignments to instance variables in the methods annotated with objc_no_direct_instance_variable_assignment">,
 599   DescFile<"DirectIvarAssignment.cpp">;
 600
 601 } // end "alpha.osx.cocoa"
 602
 603 let ParentPackage = CoreFoundation in {
 604
 605 def CFNumberChecker : Checker<"CFNumber">,
 606   HelpText<"Check for proper uses of CFNumber APIs">,
 607   DescFile<"BasicObjCFoundationChecks.cpp">;
 608
 609 def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
 610   HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">,
 611   DescFile<"BasicObjCFoundationChecks.cpp">;
 612
 613 def CFErrorChecker : Checker<"CFError">,
 614   HelpText<"Check usage of CFErrorRef* parameters">,
 615   DescFile<"NSErrorChecker.cpp">;
 616 }
 617
 618 let ParentPackage = Containers in {
 619 def ObjCContainersASTChecker : Checker<"PointerSizedValues">,
 620   HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">,
 621   DescFile<"ObjCContainersASTChecker.cpp">;
 622
 623 def ObjCContainersChecker : Checker<"OutOfBounds">,
 624   HelpText<"Checks for index out-of-bounds when using 'CFArray' API">,
 625   DescFile<"ObjCContainersChecker.cpp">;
 626
 627 }
 628
 629 let ParentPackage = LocalizabilityOptIn in {
 630 def NonLocalizedStringChecker : Checker<"NonLocalizedStringChecker">,
 631   HelpText<"Warns about uses of non-localized NSStrings passed to UI methods expecting localized NSStrings">,
 632   DescFile<"LocalizationChecker.cpp">;
 633
 634 def EmptyLocalizationContextChecker : Checker<"EmptyLocalizationContextChecker">,
 635   HelpText<"Check that NSLocalizedString macros include a comment for context">,
 636   DescFile<"LocalizationChecker.cpp">;
 637 }
 638
 639 let ParentPackage = LocalizabilityAlpha in {
 640 def PluralMisuseChecker : Checker<"PluralMisuseChecker">,
 641   HelpText<"Warns against using one vs. many plural pattern in code when generating localized strings.">,
 642   DescFile<"LocalizationChecker.cpp">;
 643 }
 644
 645 let ParentPackage = MPI in {
 646   def MPIChecker : Checker<"MPI-Checker">,
 647   HelpText<"Checks MPI code">,
 648   DescFile<"MPIChecker.cpp">;
 649 }
 650
 651 //===----------------------------------------------------------------------===//
 652 // Checkers for LLVM development.
 653 //===----------------------------------------------------------------------===//
 654
 655 def LLVMConventionsChecker : Checker<"Conventions">,
 656   InPackage<LLVM>,
 657   HelpText<"Check code for LLVM codebase conventions">,
 658   DescFile<"LLVMConventionsChecker.cpp">;
 659
 660
 661
 662 //===----------------------------------------------------------------------===//
 663 // Checkers modeling Google APIs.
 664 //===----------------------------------------------------------------------===//
 665
 666 def GTestChecker : Checker<"GTest">,
 667   InPackage<GoogleAPIModeling>,
 668   HelpText<"Model gtest assertion APIs">,
 669   DescFile<"GTestChecker.cpp">;
 670
 671 //===----------------------------------------------------------------------===//
 672 // Debugging checkers (for analyzer development).
 673 //===----------------------------------------------------------------------===//
 674
 675 let ParentPackage = Debug in {
 676
 677 def AnalysisOrderChecker : Checker<"AnalysisOrder">,
 678   HelpText<"Print callbacks that are called during analysis in order">,
 679   DescFile<"AnalysisOrder.cpp">;
 680
 681 def DominatorsTreeDumper : Checker<"DumpDominators">,
 682   HelpText<"Print the dominance tree for a given CFG">,
 683   DescFile<"DebugCheckers.cpp">;
 684
 685 def LiveVariablesDumper : Checker<"DumpLiveVars">,
 686   HelpText<"Print results of live variable analysis">,
 687   DescFile<"DebugCheckers.cpp">;
 688
 689 def CFGViewer : Checker<"ViewCFG">,
 690   HelpText<"View Control-Flow Graphs using GraphViz">,
 691   DescFile<"DebugCheckers.cpp">;
 692
 693 def CFGDumper : Checker<"DumpCFG">,
 694   HelpText<"Display Control-Flow Graphs">,
 695   DescFile<"DebugCheckers.cpp">;
 696
 697 def CallGraphViewer : Checker<"ViewCallGraph">,
 698   HelpText<"View Call Graph using GraphViz">,
 699   DescFile<"DebugCheckers.cpp">;
 700
 701 def CallGraphDumper : Checker<"DumpCallGraph">,
 702   HelpText<"Display Call Graph">,
 703   DescFile<"DebugCheckers.cpp">;
 704
 705 def ConfigDumper : Checker<"ConfigDumper">,
 706   HelpText<"Dump config table">,
 707   DescFile<"DebugCheckers.cpp">;
 708
 709 def TraversalDumper : Checker<"DumpTraversal">,
 710   HelpText<"Print branch conditions as they are traversed by the engine">,
 711   DescFile<"TraversalChecker.cpp">;
 712
 713 def CallDumper : Checker<"DumpCalls">,
 714   HelpText<"Print calls as they are traversed by the engine">,
 715   DescFile<"TraversalChecker.cpp">;
 716
 717 def AnalyzerStatsChecker : Checker<"Stats">,
 718   HelpText<"Emit warnings with analyzer statistics">,
 719   DescFile<"AnalyzerStatsChecker.cpp">;
 720
 721 def TaintTesterChecker : Checker<"TaintTest">,
 722   HelpText<"Mark tainted symbols as such.">,
 723   DescFile<"TaintTesterChecker.cpp">;
 724
 725 def ExprInspectionChecker : Checker<"ExprInspection">,
 726   HelpText<"Check the analyzer's understanding of expressions">,
 727   DescFile<"ExprInspectionChecker.cpp">;
 728
 729 def ExplodedGraphViewer : Checker<"ViewExplodedGraph">,
 730   HelpText<"View Exploded Graphs using GraphViz">,
 731   DescFile<"DebugCheckers.cpp">;
 732
 733 def BugHashDumper : Checker<"DumpBugHash">,
 734   HelpText<"Dump the bug hash for all statements.">,
 735   DescFile<"DebugCheckers.cpp">;
 736
 737 } // end "debug"
 738
 739
 740 //===----------------------------------------------------------------------===//
 741 // Clone Detection
 742 //===----------------------------------------------------------------------===//
 743
 744 let ParentPackage = CloneDetectionAlpha in {
 745
 746 def CloneChecker : Checker<"CloneChecker">,
 747   HelpText<"Reports similar pieces of code.">,
 748   DescFile<"CloneChecker.cpp">;
 749
 750 } // end "clone"
 751