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