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