Checkers.td revision 3d11708c491a96198ebfee49079ae458ed90eaf8
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 10include "clang/StaticAnalyzer/Checkers/CheckerBase.td" 11 12//===----------------------------------------------------------------------===// 13// Packages. 14//===----------------------------------------------------------------------===// 15 16def Alpha : Package<"alpha">; 17 18def Core : Package<"core">; 19def CoreBuiltin : Package<"builtin">, InPackage<Core>; 20def CoreUninitialized : Package<"uninitialized">, InPackage<Core>; 21def CoreAlpha : Package<"core">, InPackage<Alpha>, Hidden; 22 23def Cplusplus : Package<"cplusplus">; 24def CplusplusAlpha : Package<"cplusplus">, InPackage<Alpha>, Hidden; 25 26def DeadCode : Package<"deadcode">; 27def DeadCodeAlpha : Package<"deadcode">, InPackage<Alpha>, Hidden; 28 29def Security : Package <"security">; 30def InsecureAPI : Package<"insecureAPI">, InPackage<Security>; 31def SecurityAlpha : Package<"security">, InPackage<Alpha>, Hidden; 32def Taint : Package<"taint">, InPackage<SecurityAlpha>, Hidden; 33 34def Unix : Package<"unix">; 35def UnixAlpha : Package<"unix">, InPackage<Alpha>, Hidden; 36def CString : Package<"cstring">, InPackage<Unix>, Hidden; 37def CStringAlpha : Package<"cstring">, InPackage<UnixAlpha>, Hidden; 38 39def OSX : Package<"osx">; 40def OSXAlpha : Package<"osx">, InPackage<Alpha>, Hidden; 41def Cocoa : Package<"cocoa">, InPackage<OSX>; 42def CocoaAlpha : Package<"cocoa">, InPackage<OSXAlpha>, Hidden; 43def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>; 44def Containers : Package<"containers">, InPackage<CoreFoundation>; 45 46def LLVM : Package<"llvm">; 47def Debug : Package<"debug">; 48 49//===----------------------------------------------------------------------===// 50// Core Checkers. 51//===----------------------------------------------------------------------===// 52 53let ParentPackage = Core in { 54 55def DereferenceChecker : Checker<"NullDereference">, 56 HelpText<"Check for dereferences of null pointers">, 57 DescFile<"DereferenceChecker.cpp">; 58 59def CallAndMessageChecker : Checker<"CallAndMessage">, 60 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">, 61 DescFile<"CallAndMessageChecker.cpp">; 62 63def NonNullParamChecker : Checker<"NonNullParamChecker">, 64 HelpText<"Check for null pointers passed as arguments to a function whose arguments are references or marked with the 'nonnull' attribute">, 65 DescFile<"NonNullParamChecker.cpp">; 66 67def VLASizeChecker : Checker<"VLASize">, 68 HelpText<"Check for declarations of VLA of undefined or zero size">, 69 DescFile<"VLASizeChecker.cpp">; 70 71def DivZeroChecker : Checker<"DivideZero">, 72 HelpText<"Check for division by zero">, 73 DescFile<"DivZeroChecker.cpp">; 74 75def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">, 76 HelpText<"Check for undefined results of binary operators">, 77 DescFile<"UndefResultChecker.cpp">; 78 79def StackAddrEscapeChecker : Checker<"StackAddressEscape">, 80 HelpText<"Check that addresses to stack memory do not escape the function">, 81 DescFile<"StackAddrEscapeChecker.cpp">; 82 83def DynamicTypePropagation : Checker<"DynamicTypePropagation">, 84 HelpText<"Generate dynamic type information">, 85 DescFile<"DynamicTypePropagation.cpp">; 86 87} // end "core" 88 89let ParentPackage = CoreAlpha in { 90 91def BoolAssignmentChecker : Checker<"BoolAssignment">, 92 HelpText<"Warn about assigning non-{0,1} values to Boolean variables">, 93 DescFile<"BoolAssignmentChecker.cpp">; 94 95def CastSizeChecker : Checker<"CastSize">, 96 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">, 97 DescFile<"CastSizeChecker.cpp">; 98 99def CastToStructChecker : Checker<"CastToStruct">, 100 HelpText<"Check for cast from non-struct pointer to struct pointer">, 101 DescFile<"CastToStructChecker.cpp">; 102 103def FixedAddressChecker : Checker<"FixedAddr">, 104 HelpText<"Check for assignment of a fixed address to a pointer">, 105 DescFile<"FixedAddressChecker.cpp">; 106 107def PointerArithChecker : Checker<"PointerArithm">, 108 HelpText<"Check for pointer arithmetic on locations other than array elements">, 109 DescFile<"PointerArithChecker">; 110 111def PointerSubChecker : Checker<"PointerSub">, 112 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">, 113 DescFile<"PointerSubChecker">; 114 115def SizeofPointerChecker : Checker<"SizeofPtr">, 116 HelpText<"Warn about unintended use of sizeof() on pointer expressions">, 117 DescFile<"CheckSizeofPointer.cpp">; 118 119} // end "alpha.core" 120 121//===----------------------------------------------------------------------===// 122// Evaluate "builtin" functions. 123//===----------------------------------------------------------------------===// 124 125let ParentPackage = CoreBuiltin in { 126 127def NoReturnFunctionChecker : Checker<"NoReturnFunctions">, 128 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">, 129 DescFile<"NoReturnFunctionChecker.cpp">; 130 131def BuiltinFunctionChecker : Checker<"BuiltinFunctions">, 132 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">, 133 DescFile<"BuiltinFunctionChecker.cpp">; 134 135} // end "core.builtin" 136 137//===----------------------------------------------------------------------===// 138// Uninitialized values checkers. 139//===----------------------------------------------------------------------===// 140 141let ParentPackage = CoreUninitialized in { 142 143def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">, 144 HelpText<"Check for uninitialized values used as array subscripts">, 145 DescFile<"UndefinedArraySubscriptChecker.cpp">; 146 147def UndefinedAssignmentChecker : Checker<"Assign">, 148 HelpText<"Check for assigning uninitialized values">, 149 DescFile<"UndefinedAssignmentChecker.cpp">; 150 151def UndefBranchChecker : Checker<"Branch">, 152 HelpText<"Check for uninitialized values used as branch conditions">, 153 DescFile<"UndefBranchChecker.cpp">; 154 155def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">, 156 HelpText<"Check for blocks that capture uninitialized values">, 157 DescFile<"UndefCapturedBlockVarChecker.cpp">; 158 159def ReturnUndefChecker : Checker<"UndefReturn">, 160 HelpText<"Check for uninitialized values being returned to the caller">, 161 DescFile<"ReturnUndefChecker.cpp">; 162 163} // end "core.uninitialized" 164 165//===----------------------------------------------------------------------===// 166// C++ checkers. 167//===----------------------------------------------------------------------===// 168 169let ParentPackage = Cplusplus in { 170} // end: "cplusplus" 171 172let ParentPackage = CplusplusAlpha in { 173 174def VirtualCallChecker : Checker<"VirtualCall">, 175 HelpText<"Check virtual function calls during construction or destruction">, 176 DescFile<"VirtualCallChecker.cpp">; 177 178def NewDeleteChecker : Checker<"NewDelete">, 179 HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by new/delete.">, 180 DescFile<"MallocChecker.cpp">; 181 182} // end: "alpha.cplusplus" 183 184//===----------------------------------------------------------------------===// 185// Deadcode checkers. 186//===----------------------------------------------------------------------===// 187 188let ParentPackage = DeadCode in { 189 190def DeadStoresChecker : Checker<"DeadStores">, 191 HelpText<"Check for values stored to variables that are never read afterwards">, 192 DescFile<"DeadStoresChecker.cpp">; 193} // end DeadCode 194 195let ParentPackage = DeadCodeAlpha in { 196 197def IdempotentOperationChecker : Checker<"IdempotentOperations">, 198 HelpText<"Warn about idempotent operations">, 199 DescFile<"IdempotentOperationChecker.cpp">; 200 201def UnreachableCodeChecker : Checker<"UnreachableCode">, 202 HelpText<"Check unreachable code">, 203 DescFile<"UnreachableCodeChecker.cpp">; 204 205} // end "alpha.deadcode" 206 207//===----------------------------------------------------------------------===// 208// Security checkers. 209//===----------------------------------------------------------------------===// 210 211let ParentPackage = InsecureAPI in { 212 def gets : Checker<"gets">, 213 HelpText<"Warn on uses of the 'gets' function">, 214 DescFile<"CheckSecuritySyntaxOnly.cpp">; 215 def getpw : Checker<"getpw">, 216 HelpText<"Warn on uses of the 'getpw' function">, 217 DescFile<"CheckSecuritySyntaxOnly.cpp">; 218 def mktemp : Checker<"mktemp">, 219 HelpText<"Warn on uses of the 'mktemp' function">, 220 DescFile<"CheckSecuritySyntaxOnly.cpp">; 221 def mkstemp : Checker<"mkstemp">, 222 HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">, 223 DescFile<"CheckSecuritySyntaxOnly.cpp">; 224 def rand : Checker<"rand">, 225 HelpText<"Warn on uses of the 'rand', 'random', and related functions">, 226 DescFile<"CheckSecuritySyntaxOnly.cpp">; 227 def strcpy : Checker<"strcpy">, 228 HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">, 229 DescFile<"CheckSecuritySyntaxOnly.cpp">; 230 def vfork : Checker<"vfork">, 231 HelpText<"Warn on uses of the 'vfork' function">, 232 DescFile<"CheckSecuritySyntaxOnly.cpp">; 233 def UncheckedReturn : Checker<"UncheckedReturn">, 234 HelpText<"Warn on uses of functions whose return values must be always checked">, 235 DescFile<"CheckSecuritySyntaxOnly.cpp">; 236} 237let ParentPackage = Security in { 238 def FloatLoopCounter : Checker<"FloatLoopCounter">, 239 HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">, 240 DescFile<"CheckSecuritySyntaxOnly.cpp">; 241} 242 243let ParentPackage = SecurityAlpha in { 244 245def ArrayBoundChecker : Checker<"ArrayBound">, 246 HelpText<"Warn about buffer overflows (older checker)">, 247 DescFile<"ArrayBoundChecker.cpp">; 248 249def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">, 250 HelpText<"Warn about buffer overflows (newer checker)">, 251 DescFile<"ArrayBoundCheckerV2.cpp">; 252 253def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">, 254 HelpText<"Check for an out-of-bound pointer being returned to callers">, 255 DescFile<"ReturnPointerRangeChecker.cpp">; 256 257def MallocOverflowSecurityChecker : Checker<"MallocOverflow">, 258 HelpText<"Check for overflows in the arguments to malloc()">, 259 DescFile<"MallocOverflowSecurityChecker.cpp">; 260 261} // end "alpha.security" 262 263//===----------------------------------------------------------------------===// 264// Taint checkers. 265//===----------------------------------------------------------------------===// 266 267let ParentPackage = Taint in { 268 269def GenericTaintChecker : Checker<"TaintPropagation">, 270 HelpText<"Generate taint information used by other checkers">, 271 DescFile<"GenericTaintChecker.cpp">; 272 273} // end "alpha.security.taint" 274 275//===----------------------------------------------------------------------===// 276// Unix API checkers. 277//===----------------------------------------------------------------------===// 278 279let ParentPackage = Unix in { 280 281def UnixAPIChecker : Checker<"API">, 282 HelpText<"Check calls to various UNIX/Posix functions">, 283 DescFile<"UnixAPIChecker.cpp">; 284 285def MallocPessimistic : Checker<"Malloc">, 286 HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free().">, 287 DescFile<"MallocChecker.cpp">; 288 289def MallocSizeofChecker : Checker<"MallocSizeof">, 290 HelpText<"Check for dubious malloc arguments involving sizeof">, 291 DescFile<"MallocSizeofChecker.cpp">; 292 293def MismatchedDeallocatorChecker : Checker<"MismatchedDeallocator">, 294 HelpText<"Check for mismatched deallocators.">, 295 DescFile<"MallocChecker.cpp">; 296 297} // end "unix" 298 299let ParentPackage = UnixAlpha in { 300 301def ChrootChecker : Checker<"Chroot">, 302 HelpText<"Check improper use of chroot">, 303 DescFile<"ChrootChecker.cpp">; 304 305def MallocOptimistic : Checker<"MallocWithAnnotations">, 306 HelpText<"Check for memory leaks, double free, and use-after-free problems. Traces memory managed by malloc()/free(). Assumes that all user-defined functions which might free a pointer are annotated.">, 307 DescFile<"MallocChecker.cpp">; 308 309def PthreadLockChecker : Checker<"PthreadLock">, 310 HelpText<"Simple lock -> unlock checker">, 311 DescFile<"PthreadLockChecker.cpp">; 312 313def StreamChecker : Checker<"Stream">, 314 HelpText<"Check stream handling functions">, 315 DescFile<"StreamChecker.cpp">; 316 317def SimpleStreamChecker : Checker<"SimpleStream">, 318 HelpText<"Check for misuses of stream APIs">, 319 DescFile<"SimpleStreamChecker.cpp">; 320 321} // end "alpha.unix" 322 323let ParentPackage = CString in { 324 325def CStringNullArg : Checker<"NullArg">, 326 HelpText<"Check for null pointers being passed as arguments to C string functions">, 327 DescFile<"CStringChecker.cpp">; 328 329def CStringSyntaxChecker : Checker<"BadSizeArg">, 330 HelpText<"Check the size argument passed into C string functions for common erroneous patterns">, 331 DescFile<"CStringSyntaxChecker.cpp">; 332} 333 334let ParentPackage = CStringAlpha in { 335 336def CStringOutOfBounds : Checker<"OutOfBounds">, 337 HelpText<"Check for out-of-bounds access in string functions">, 338 DescFile<"CStringChecker.cpp">; 339 340def CStringBufferOverlap : Checker<"BufferOverlap">, 341 HelpText<"Checks for overlap in two buffer arguments">, 342 DescFile<"CStringChecker.cpp">; 343 344def CStringNotNullTerm : Checker<"NotNullTerminated">, 345 HelpText<"Check for arguments which are not null-terminating strings">, 346 DescFile<"CStringChecker.cpp">; 347} 348 349//===----------------------------------------------------------------------===// 350// Mac OS X, Cocoa, and Core Foundation checkers. 351//===----------------------------------------------------------------------===// 352 353let ParentPackage = OSX in { 354 355def MacOSXAPIChecker : Checker<"API">, 356 InPackage<OSX>, 357 HelpText<"Check for proper uses of various Mac OS X APIs">, 358 DescFile<"MacOSXAPIChecker.cpp">; 359 360def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">, 361 InPackage<OSX>, 362 HelpText<"Check for proper uses of Secure Keychain APIs">, 363 DescFile<"MacOSKeychainAPIChecker.cpp">; 364 365} // end "osx" 366 367let ParentPackage = Cocoa in { 368 369def ObjCAtSyncChecker : Checker<"AtSync">, 370 HelpText<"Check for nil pointers used as mutexes for @synchronized">, 371 DescFile<"ObjCAtSyncChecker.cpp">; 372 373def NilArgChecker : Checker<"NilArg">, 374 HelpText<"Check for prohibited nil arguments to ObjC method calls">, 375 DescFile<"BasicObjCFoundationChecks.cpp">; 376 377def ClassReleaseChecker : Checker<"ClassRelease">, 378 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">, 379 DescFile<"BasicObjCFoundationChecks.cpp">; 380 381def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">, 382 HelpText<"Check for passing non-Objective-C types to variadic collection " 383 "initialization methods that expect only Objective-C types">, 384 DescFile<"BasicObjCFoundationChecks.cpp">; 385 386def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">, 387 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">, 388 DescFile<"NSAutoreleasePoolChecker.cpp">; 389 390def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">, 391 HelpText<"Warn about Objective-C method signatures with type incompatibilities">, 392 DescFile<"CheckObjCInstMethSignature.cpp">; 393 394def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">, 395 HelpText<"Warn about private ivars that are never used">, 396 DescFile<"ObjCUnusedIVarsChecker.cpp">; 397 398def ObjCSelfInitChecker : Checker<"SelfInit">, 399 HelpText<"Check that 'self' is properly initialized inside an initializer method">, 400 DescFile<"ObjCSelfInitChecker.cpp">; 401 402def ObjCLoopChecker : Checker<"Loops">, 403 HelpText<"Improved modeling of loops using Cocoa collection types">, 404 DescFile<"BasicObjCFoundationChecks.cpp">; 405 406def ObjCNonNilReturnValueChecker : Checker<"NonNilReturnValue">, 407 HelpText<"Model the APIs that are guaranteed to return a non-nil value">, 408 DescFile<"BasicObjCFoundationChecks.cpp">; 409 410def NSErrorChecker : Checker<"NSError">, 411 HelpText<"Check usage of NSError** parameters">, 412 DescFile<"NSErrorChecker.cpp">; 413 414def RetainCountChecker : Checker<"RetainCount">, 415 HelpText<"Check for leaks and improper reference count management">, 416 DescFile<"RetainCountChecker.cpp">; 417 418} // end "osx.cocoa" 419 420let ParentPackage = CocoaAlpha in { 421 422def ObjCDeallocChecker : Checker<"Dealloc">, 423 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">, 424 DescFile<"CheckObjCDealloc.cpp">; 425 426def InstanceVariableInvalidation : Checker<"InstanceVariableInvalidation">, 427 HelpText<"Check that the invalidatable instance variables are invalidated in the methods annotated with objc_instance_variable_invalidator">, 428 DescFile<"IvarInvalidationChecker.cpp">; 429 430def MissingInvalidationMethod : Checker<"MissingInvalidationMethod">, 431 HelpText<"Check that the invalidation methods are present in classes that contain invalidatable instance variables">, 432 DescFile<"IvarInvalidationChecker.cpp">; 433 434def DirectIvarAssignment : Checker<"DirectIvarAssignment">, 435 HelpText<"Check for direct assignments to instance variables">, 436 DescFile<"DirectIvarAssignment.cpp">; 437 438def DirectIvarAssignmentForAnnotatedFunctions : Checker<"DirectIvarAssignmentForAnnotatedFunctions">, 439 HelpText<"Check for direct assignments to instance variables in the methods annotated with objc_no_direct_instance_variable_assignment">, 440 DescFile<"DirectIvarAssignment.cpp">; 441 442def ObjCSuperCallChecker : Checker<"MissingSuperCall">, 443 HelpText<"Warn about Objective-C methods that lack a necessary call to super">, 444 DescFile<"ObjCMissingSuperCallChecker.cpp">; 445 446} // end "alpha.osx.cocoa" 447 448let ParentPackage = CoreFoundation in { 449 450def CFNumberCreateChecker : Checker<"CFNumber">, 451 HelpText<"Check for proper uses of CFNumberCreate">, 452 DescFile<"BasicObjCFoundationChecks.cpp">; 453 454def CFRetainReleaseChecker : Checker<"CFRetainRelease">, 455 HelpText<"Check for null arguments to CFRetain/CFRelease/CFMakeCollectable">, 456 DescFile<"BasicObjCFoundationChecks.cpp">; 457 458def CFErrorChecker : Checker<"CFError">, 459 HelpText<"Check usage of CFErrorRef* parameters">, 460 DescFile<"NSErrorChecker.cpp">; 461} 462 463let ParentPackage = Containers in { 464def ObjCContainersASTChecker : Checker<"PointerSizedValues">, 465 HelpText<"Warns if 'CFArray', 'CFDictionary', 'CFSet' are created with non-pointer-size values">, 466 DescFile<"ObjCContainersASTChecker.cpp">; 467 468def ObjCContainersChecker : Checker<"OutOfBounds">, 469 HelpText<"Checks for index out-of-bounds when using 'CFArray' API">, 470 DescFile<"ObjCContainersChecker.cpp">; 471 472} 473//===----------------------------------------------------------------------===// 474// Checkers for LLVM development. 475//===----------------------------------------------------------------------===// 476 477def LLVMConventionsChecker : Checker<"Conventions">, 478 InPackage<LLVM>, 479 HelpText<"Check code for LLVM codebase conventions">, 480 DescFile<"LLVMConventionsChecker.cpp">; 481 482//===----------------------------------------------------------------------===// 483// Debugging checkers (for analyzer development). 484//===----------------------------------------------------------------------===// 485 486let ParentPackage = Debug in { 487 488def DominatorsTreeDumper : Checker<"DumpDominators">, 489 HelpText<"Print the dominance tree for a given CFG">, 490 DescFile<"DebugCheckers.cpp">; 491 492def LiveVariablesDumper : Checker<"DumpLiveVars">, 493 HelpText<"Print results of live variable analysis">, 494 DescFile<"DebugCheckers.cpp">; 495 496def CFGViewer : Checker<"ViewCFG">, 497 HelpText<"View Control-Flow Graphs using GraphViz">, 498 DescFile<"DebugCheckers.cpp">; 499 500def CFGDumper : Checker<"DumpCFG">, 501 HelpText<"Display Control-Flow Graphs">, 502 DescFile<"DebugCheckers.cpp">; 503 504def CallGraphViewer : Checker<"ViewCallGraph">, 505 HelpText<"View Call Graph using GraphViz">, 506 DescFile<"DebugCheckers.cpp">; 507 508def CallGraphDumper : Checker<"DumpCallGraph">, 509 HelpText<"Display Call Graph">, 510 DescFile<"DebugCheckers.cpp">; 511 512def ConfigDumper : Checker<"ConfigDumper">, 513 HelpText<"Dump config table">, 514 DescFile<"DebugCheckers.cpp">; 515 516def TraversalDumper : Checker<"DumpTraversal">, 517 HelpText<"Print branch conditions as they are traversed by the engine">, 518 DescFile<"TraversalChecker.cpp">; 519 520def CallDumper : Checker<"DumpCalls">, 521 HelpText<"Print calls as they are traversed by the engine">, 522 DescFile<"TraversalChecker.cpp">; 523 524def AnalyzerStatsChecker : Checker<"Stats">, 525 HelpText<"Emit warnings with analyzer statistics">, 526 DescFile<"AnalyzerStatsChecker.cpp">; 527 528def TaintTesterChecker : Checker<"TaintTest">, 529 HelpText<"Mark tainted symbols as such.">, 530 DescFile<"TaintTesterChecker.cpp">; 531 532def ExprInspectionChecker : Checker<"ExprInspection">, 533 HelpText<"Check the analyzer's understanding of expressions">, 534 DescFile<"ExprInspectionChecker.cpp">; 535 536} // end "debug" 537