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