Checkers.td revision b63d8d8f7b2d101838af992749411dd79c2ed116
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 Experimental : Package<"experimental">; 17 18def Core : Package<"core">; 19def CoreBuiltin : Package<"builtin">, InPackage<Core>; 20def CoreUninitialized : Package<"uninitialized">, InPackage<Core>; 21def CoreExperimental : Package<"core">, InPackage<Experimental>, Hidden; 22 23def Cplusplus : Package<"cplusplus">; 24def CplusplusExperimental : Package<"cplusplus">, InPackage<Experimental>, Hidden; 25 26def DeadCode : Package<"deadcode">; 27def DeadCodeExperimental : Package<"deadcode">, InPackage<Experimental>, Hidden; 28 29def Security : Package <"security">; 30def InsecureAPI : Package<"insecureAPI">, InPackage<Security>; 31def SecurityExperimental : Package<"security">, InPackage<Experimental>, Hidden; 32def Taint : Package<"taint">, InPackage<SecurityExperimental>, Hidden; 33 34def Unix : Package<"unix">; 35def UnixExperimental : Package<"unix">, InPackage<Experimental>, Hidden; 36 37def OSX : Package<"osx">; 38def OSXExperimental : Package<"osx">, InPackage<Experimental>, Hidden; 39def Cocoa : Package<"cocoa">, InPackage<OSX>; 40def CocoaExperimental : Package<"cocoa">, InPackage<OSXExperimental>, Hidden; 41def CoreFoundation : Package<"coreFoundation">, InPackage<OSX>; 42 43def LLVM : Package<"llvm">; 44def Debug : Package<"debug">; 45 46//===----------------------------------------------------------------------===// 47// Core Checkers. 48//===----------------------------------------------------------------------===// 49 50let ParentPackage = Core in { 51 52def DereferenceChecker : Checker<"NullDereference">, 53 HelpText<"Check for dereferences of null pointers">, 54 DescFile<"DereferenceChecker.cpp">; 55 56def CallAndMessageChecker : Checker<"CallAndMessage">, 57 HelpText<"Check for logical errors for function calls and Objective-C message expressions (e.g., uninitialized arguments, null function pointers)">, 58 DescFile<"CallAndMessageChecker.cpp">; 59 60def AdjustedReturnValueChecker : Checker<"AdjustedReturnValue">, 61 HelpText<"Check to see if the return value of a function call is different than the caller expects (e.g., from calls through function pointers)">, 62 DescFile<"AdjustedReturnValueChecker.cpp">; 63 64def AttrNonNullChecker : Checker<"AttributeNonNull">, 65 HelpText<"Check for null pointers passed as arguments to a function whose arguments are marked with the 'nonnull' attribute">, 66 DescFile<"AttrNonNullChecker.cpp">; 67 68def VLASizeChecker : Checker<"VLASize">, 69 HelpText<"Check for declarations of VLA of undefined or zero size">, 70 DescFile<"VLASizeChecker.cpp">; 71 72def DivZeroChecker : Checker<"DivideZero">, 73 HelpText<"Check for division by zero">, 74 DescFile<"DivZeroChecker.cpp">; 75 76def UndefResultChecker : Checker<"UndefinedBinaryOperatorResult">, 77 HelpText<"Check for undefined results of binary operators">, 78 DescFile<"UndefResultChecker.cpp">; 79 80def StackAddrEscapeChecker : Checker<"StackAddressEscape">, 81 HelpText<"Check that addresses to stack memory do not escape the function">, 82 DescFile<"StackAddrEscapeChecker.cpp">; 83 84} // end "core" 85 86let ParentPackage = CoreExperimental in { 87 88def CastSizeChecker : Checker<"CastSize">, 89 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">, 90 DescFile<"CastSizeChecker.cpp">; 91 92def CastToStructChecker : Checker<"CastToStruct">, 93 HelpText<"Check for cast from non-struct pointer to struct pointer">, 94 DescFile<"CastToStructChecker.cpp">; 95 96def FixedAddressChecker : Checker<"FixedAddr">, 97 HelpText<"Check for assignment of a fixed address to a pointer">, 98 DescFile<"FixedAddressChecker.cpp">; 99 100def PointerArithChecker : Checker<"PointerArithm">, 101 HelpText<"Check for pointer arithmetic on locations other than array elements">, 102 DescFile<"PointerArithChecker">; 103 104def PointerSubChecker : Checker<"PointerSub">, 105 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">, 106 DescFile<"PointerSubChecker">; 107 108def SizeofPointerChecker : Checker<"SizeofPtr">, 109 HelpText<"Warn about unintended use of sizeof() on pointer expressions">, 110 DescFile<"CheckSizeofPointer.cpp">; 111 112} // end "core.experimental" 113 114//===----------------------------------------------------------------------===// 115// Evaluate "builtin" functions. 116//===----------------------------------------------------------------------===// 117 118let ParentPackage = CoreBuiltin in { 119 120def NoReturnFunctionChecker : Checker<"NoReturnFunctions">, 121 HelpText<"Evaluate \"panic\" functions that are known to not return to the caller">, 122 DescFile<"NoReturnFunctionChecker.cpp">; 123 124def BuiltinFunctionChecker : Checker<"BuiltinFunctions">, 125 HelpText<"Evaluate compiler builtin functions (e.g., alloca())">, 126 DescFile<"BuiltinFunctionChecker.cpp">; 127 128} // end "core.builtin" 129 130//===----------------------------------------------------------------------===// 131// Uninitialized values checkers. 132//===----------------------------------------------------------------------===// 133 134let ParentPackage = CoreUninitialized in { 135 136def UndefinedArraySubscriptChecker : Checker<"ArraySubscript">, 137 HelpText<"Check for uninitialized values used as array subscripts">, 138 DescFile<"UndefinedArraySubscriptChecker.cpp">; 139 140def UndefinedAssignmentChecker : Checker<"Assign">, 141 HelpText<"Check for assigning uninitialized values">, 142 DescFile<"UndefinedAssignmentChecker.cpp">; 143 144def UndefBranchChecker : Checker<"Branch">, 145 HelpText<"Check for uninitialized values used as branch conditions">, 146 DescFile<"UndefBranchChecker.cpp">; 147 148def UndefCapturedBlockVarChecker : Checker<"CapturedBlockVariable">, 149 HelpText<"Check for blocks that capture uninitialized values">, 150 DescFile<"UndefCapturedBlockVarChecker.cpp">; 151 152def ReturnUndefChecker : Checker<"UndefReturn">, 153 HelpText<"Check for uninitialized values being returned to the caller">, 154 DescFile<"ReturnUndefChecker.cpp">; 155 156} // end "core.uninitialized" 157 158//===----------------------------------------------------------------------===// 159// C++ checkers. 160//===----------------------------------------------------------------------===// 161 162let ParentPackage = CplusplusExperimental in { 163 164def IteratorsChecker : Checker<"Iterators">, 165 HelpText<"Check improper uses of STL vector iterators">, 166 DescFile<"IteratorsChecker.cpp">; 167 168def VirtualCallChecker : Checker<"VirtualCall">, 169 HelpText<"Check virtual function calls during construction or destruction">, 170 DescFile<"VirtualCallChecker.cpp">; 171 172} // end: "cplusplus.experimental" 173 174//===----------------------------------------------------------------------===// 175// Deadcode checkers. 176//===----------------------------------------------------------------------===// 177 178let ParentPackage = DeadCode in { 179 180def DeadStoresChecker : Checker<"DeadStores">, 181 HelpText<"Check for values stored to variables that are never read afterwards">, 182 DescFile<"DeadStoresChecker.cpp">; 183 184def IdempotentOperationChecker : Checker<"IdempotentOperations">, 185 HelpText<"Warn about idempotent operations">, 186 DescFile<"IdempotentOperationChecker.cpp">; 187 188} // end DeadCode 189 190let ParentPackage = DeadCodeExperimental in { 191 192def UnreachableCodeChecker : Checker<"UnreachableCode">, 193 HelpText<"Check unreachable code">, 194 DescFile<"UnreachableCodeChecker.cpp">; 195 196} // end "deadcode.experimental" 197 198//===----------------------------------------------------------------------===// 199// Security checkers. 200//===----------------------------------------------------------------------===// 201 202let ParentPackage = InsecureAPI in { 203 def gets : Checker<"gets">, 204 HelpText<"Warn on uses of the 'gets' function">, 205 DescFile<"CheckSecuritySyntaxOnly.cpp">; 206 def getpw : Checker<"getpw">, 207 HelpText<"Warn on uses of the 'getpw' function">, 208 DescFile<"CheckSecuritySyntaxOnly.cpp">; 209 def mktemp : Checker<"mktemp">, 210 HelpText<"Warn on uses of the 'mktemp' function">, 211 DescFile<"CheckSecuritySyntaxOnly.cpp">; 212 def mkstemp : Checker<"mkstemp">, 213 HelpText<"Warn when 'mkstemp' is passed fewer than 6 X's in the format string">, 214 DescFile<"CheckSecuritySyntaxOnly.cpp">; 215 def rand : Checker<"rand">, 216 HelpText<"Warn on uses of the 'rand', 'random', and related functions">, 217 DescFile<"CheckSecuritySyntaxOnly.cpp">; 218 def strcpy : Checker<"strcpy">, 219 HelpText<"Warn on uses of the 'strcpy' and 'strcat' functions">, 220 DescFile<"CheckSecuritySyntaxOnly.cpp">; 221 def vfork : Checker<"vfork">, 222 HelpText<"Warn on uses of the 'vfork' function">, 223 DescFile<"CheckSecuritySyntaxOnly.cpp">; 224 def UncheckedReturn : Checker<"UncheckedReturn">, 225 HelpText<"Warn on uses of functions whose return values must be always checked">, 226 DescFile<"CheckSecuritySyntaxOnly.cpp">; 227} 228let ParentPackage = Security in { 229 def FloatLoopCounter : Checker<"FloatLoopCounter">, 230 HelpText<"Warn on using a floating point value as a loop counter (CERT: FLP30-C, FLP30-CPP)">, 231 DescFile<"CheckSecuritySyntaxOnly.cpp">; 232} 233 234let ParentPackage = SecurityExperimental in { 235 236def ArrayBoundChecker : Checker<"ArrayBound">, 237 HelpText<"Warn about buffer overflows (older checker)">, 238 DescFile<"ArrayBoundChecker.cpp">; 239 240def ArrayBoundCheckerV2 : Checker<"ArrayBoundV2">, 241 HelpText<"Warn about buffer overflows (newer checker)">, 242 DescFile<"ArrayBoundCheckerV2.cpp">; 243 244def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">, 245 HelpText<"Check for an out-of-bound pointer being returned to callers">, 246 DescFile<"ReturnPointerRangeChecker.cpp">; 247 248def MallocOverflowSecurityChecker : Checker<"MallocOverflow">, 249 HelpText<"Check for overflows in the arguments to malloc()">, 250 DescFile<"MallocOverflowSecurityChecker.cpp">; 251 252} // end "security.experimental" 253 254//===----------------------------------------------------------------------===// 255// Taint checkers. 256//===----------------------------------------------------------------------===// 257 258let ParentPackage = Taint in { 259 260def GenericTaintChecker : Checker<"TaintPropagation">, 261 HelpText<"Generate taint information used by other checkers">, 262 DescFile<"GenericTaintChecker.cpp">; 263 264} // end "experimental.security.taint" 265 266//===----------------------------------------------------------------------===// 267// Unix API checkers. 268//===----------------------------------------------------------------------===// 269 270let ParentPackage = Unix in { 271 272def UnixAPIChecker : Checker<"API">, 273 HelpText<"Check calls to various UNIX/Posix functions">, 274 DescFile<"UnixAPIChecker.cpp">; 275 276} // end "unix" 277 278let ParentPackage = UnixExperimental in { 279 280def ChrootChecker : Checker<"Chroot">, 281 HelpText<"Check improper use of chroot">, 282 DescFile<"ChrootChecker.cpp">; 283 284def CStringChecker : Checker<"CString">, 285 HelpText<"Check calls to functions in <string.h>">, 286 DescFile<"CStringChecker.cpp">; 287 288def MallocChecker : Checker<"Malloc">, 289 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">, 290 DescFile<"MallocChecker.cpp">; 291 292def MallocSizeofChecker : Checker<"MallocSizeof">, 293 HelpText<"Check for dubious malloc arguments involving sizeof">, 294 DescFile<"MallocSizeofChecker.cpp">; 295 296def PthreadLockChecker : Checker<"PthreadLock">, 297 HelpText<"Simple lock -> unlock checker">, 298 DescFile<"PthreadLockChecker.cpp">; 299 300def StreamChecker : Checker<"Stream">, 301 HelpText<"Check stream handling functions">, 302 DescFile<"StreamChecker.cpp">; 303 304} // end "unix.experimental" 305 306//===----------------------------------------------------------------------===// 307// Mac OS X, Cocoa, and Core Foundation checkers. 308//===----------------------------------------------------------------------===// 309 310let ParentPackage = OSX in { 311 312def MacOSXAPIChecker : Checker<"API">, 313 InPackage<OSX>, 314 HelpText<"Check for proper uses of various Mac OS X APIs">, 315 DescFile<"MacOSXAPIChecker.cpp">; 316 317def OSAtomicChecker : Checker<"AtomicCAS">, 318 InPackage<OSX>, 319 HelpText<"Evaluate calls to OSAtomic functions">, 320 DescFile<"OSAtomicChecker.cpp">; 321 322def MacOSKeychainAPIChecker : Checker<"SecKeychainAPI">, 323 InPackage<OSX>, 324 HelpText<"Check for proper uses of Secure Keychain APIs">, 325 DescFile<"MacOSKeychainAPIChecker.cpp">; 326 327} // end "macosx" 328 329let ParentPackage = Cocoa in { 330 331def ObjCAtSyncChecker : Checker<"AtSync">, 332 HelpText<"Check for null pointers used as mutexes for @synchronized">, 333 DescFile<"ObjCAtSyncChecker.cpp">; 334 335def NilArgChecker : Checker<"NilArg">, 336 HelpText<"Check for prohibited nil arguments to ObjC method calls">, 337 DescFile<"BasicObjCFoundationChecks.cpp">; 338 339def ClassReleaseChecker : Checker<"ClassRelease">, 340 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">, 341 DescFile<"BasicObjCFoundationChecks.cpp">; 342 343def VariadicMethodTypeChecker : Checker<"VariadicMethodTypes">, 344 HelpText<"Check for passing non-Objective-C types to variadic methods that expect " 345 "only Objective-C types">, 346 DescFile<"BasicObjCFoundationChecks.cpp">; 347 348def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">, 349 HelpText<"Warn for suboptimal uses of NSAutoreleasePool in Objective-C GC mode">, 350 DescFile<"NSAutoreleasePoolChecker.cpp">; 351 352def ObjCMethSigsChecker : Checker<"IncompatibleMethodTypes">, 353 HelpText<"Warn about Objective-C method signatures with type incompatibilities">, 354 DescFile<"CheckObjCInstMethSignature.cpp">; 355 356def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">, 357 HelpText<"Warn about private ivars that are never used">, 358 DescFile<"ObjCUnusedIVarsChecker.cpp">; 359 360def NSErrorChecker : Checker<"NSError">, 361 HelpText<"Check usage of NSError** parameters">, 362 DescFile<"NSErrorChecker.cpp">; 363 364def RetainCountChecker : Checker<"RetainCount">, 365 HelpText<"Check for leaks and improper reference count management">, 366 DescFile<"RetainCountChecker.cpp">; 367 368} // end "cocoa" 369 370let ParentPackage = CocoaExperimental in { 371 372def ObjCSelfInitChecker : Checker<"SelfInit">, 373 HelpText<"Check that 'self' is properly initialized inside an initializer method">, 374 DescFile<"ObjCSelfInitChecker.cpp">; 375 376def ObjCDeallocChecker : Checker<"Dealloc">, 377 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">, 378 DescFile<"CheckObjCDealloc.cpp">; 379 380} // end "cocoa.experimental" 381 382let ParentPackage = CoreFoundation in { 383 384def CFNumberCreateChecker : Checker<"CFNumber">, 385 HelpText<"Check for proper uses of CFNumberCreate">, 386 DescFile<"BasicObjCFoundationChecks.cpp">; 387 388def CFRetainReleaseChecker : Checker<"CFRetainRelease">, 389 HelpText<"Check for null arguments to CFRetain/CFRelease">, 390 DescFile<"BasicObjCFoundationChecks.cpp">; 391 392def CFErrorChecker : Checker<"CFError">, 393 HelpText<"Check usage of CFErrorRef* parameters">, 394 DescFile<"NSErrorChecker.cpp">; 395} 396 397//===----------------------------------------------------------------------===// 398// Checkers for LLVM development. 399//===----------------------------------------------------------------------===// 400 401def LLVMConventionsChecker : Checker<"Conventions">, 402 InPackage<LLVM>, 403 HelpText<"Check code for LLVM codebase conventions">, 404 DescFile<"LLVMConventionsChecker.cpp">; 405 406//===----------------------------------------------------------------------===// 407// Debugging checkers (for analyzer development). 408//===----------------------------------------------------------------------===// 409 410let ParentPackage = Debug in { 411 412def DominatorsTreeDumper : Checker<"DumpDominators">, 413 HelpText<"Print the dominance tree for a given CFG">, 414 DescFile<"DebugCheckers.cpp">; 415 416def LiveVariablesDumper : Checker<"DumpLiveVars">, 417 HelpText<"Print results of live variable analysis">, 418 DescFile<"DebugCheckers.cpp">; 419 420def CFGViewer : Checker<"ViewCFG">, 421 HelpText<"View Control-Flow Graphs using GraphViz">, 422 DescFile<"DebugCheckers.cpp">; 423 424def CFGDumper : Checker<"DumpCFG">, 425 HelpText<"Display Control-Flow Graphs">, 426 DescFile<"DebugCheckers.cpp">; 427 428def AnalyzerStatsChecker : Checker<"Stats">, 429 HelpText<"Emit warnings with analyzer statistics">, 430 DescFile<"AnalyzerStatsChecker.cpp">; 431 432def TaintTesterChecker : Checker<"TaintTest">, 433 HelpText<"Mark tainted symbols as such.">, 434 DescFile<"TaintTesterChecker.cpp">; 435 436} // end "debug" 437 438