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