Checkers.td revision 267aa5c93b1eecc1d6f2c65ed2ba1fe840a9d0fd
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 Core : Package<"core">; 17def Cocoa : Package<"cocoa">; 18def Unix : Package<"unix">; 19def MacOSX : Package<"macosx">; 20 21def CoreExperimental : Package<"experimental">, 22 InPackage<Core>, Hidden; 23 24def CocoaExperimental : Package<"experimental">, 25 InPackage<Cocoa>, Hidden; 26 27def UnixExperimental : Package<"experimental">, 28 InPackage<Unix>, Hidden; 29 30def LLVM : Package<"llvm">; 31def Debug : Package<"debug">; 32 33//===----------------------------------------------------------------------===// 34// Groups. 35//===----------------------------------------------------------------------===// 36 37def AllExperimental : CheckerGroup<"all-experimental">, 38 Hidden; 39 40//===----------------------------------------------------------------------===// 41// Checkers. 42//===----------------------------------------------------------------------===// 43 44let ParentPackage = Cocoa in { 45 46def ObjCSelfInitChecker : Checker<"SelfInit">, 47 HelpText<"Check that 'self' is propely initialized inside an initializer method">, 48 DescFile<"ObjCSelfInitChecker.cpp">; 49 50def ObjCAtSyncChecker : Checker<"AtSync">, 51 HelpText<"Check for null pointers used as mutexes for @synchronized">, 52 DescFile<"ObjCAtSyncChecker.cpp">; 53 54def NilArgChecker : Checker<"NilArg">, 55 HelpText<"Check for prohibited nil arguments to ObjC method calls">, 56 DescFile<"BasicObjCFoundationChecks.cpp">; 57 58def ClassReleaseChecker : Checker<"ClassRelease">, 59 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">, 60 DescFile<"BasicObjCFoundationChecks.cpp">; 61 62def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">, 63 HelpText<"Warn for subpar uses of NSAutoreleasePool">, 64 DescFile<"NSAutoreleasePoolChecker.cpp">; 65 66def ObjCMethSigsChecker : Checker<"MethodSigs">, 67 HelpText<"Warn about Objective-C method signatures with type incompatibilities">, 68 DescFile<"CheckObjCInstMethSignature.cpp">; 69 70def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">, 71 HelpText<"Warn about private ivars that are never used">, 72 DescFile<"ObjCUnusedIVarsChecker.cpp">; 73 74} // end "cocoa" 75 76let ParentPackage = Core in { 77 78def UndefinedAssignmentChecker : Checker<"UndefAssign">, 79 HelpText<"Check for assigning undefined values">, 80 DescFile<"UndefinedAssignmentChecker.cpp">; 81 82def UndefBranchChecker : Checker<"UndefBranch">, 83 HelpText<"Check for undefined branch conditions">, 84 DescFile<"UndefBranchChecker.cpp">; 85 86def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">, 87 HelpText<"Check for blocks that capture uninitialized values">, 88 DescFile<"UndefCapturedBlockVarChecker.cpp">; 89 90def UndefResultChecker : Checker<"UndefBinOpResult">, 91 HelpText<"Check for undefined results of non-assignment binary operators">, 92 DescFile<"UndefResultChecker.cpp">; 93 94def NoReturnFunctionChecker : Checker<"NoReturnFunc">, 95 HelpText<"Evaluate functions that do not return to the caller">, 96 DescFile<"NoReturnFunctionChecker.cpp">; 97 98def BuiltinFunctionChecker : Checker<"BuiltinFunc">, 99 HelpText<"Evaluate clang builtin functions">, 100 DescFile<"BuiltinFunctionChecker.cpp">; 101 102def StackAddrEscapeChecker : Checker<"StackAddrEscape">, 103 HelpText<"Check that addresses to stack memory do not escape the function">, 104 DescFile<"StackAddrEscapeChecker.cpp">; 105 106} // end "core" 107 108def DeadStoresChecker : Checker<"DeadStores">, 109 HelpText<"Check for values stored to a variables that are never read afterwards">, 110 DescFile<"DeadStoresChecker.cpp">; 111 112def UnixAPIChecker : Checker<"API">, 113 InPackage<Unix>, 114 HelpText<"Check calls to various UNIX/Posix functions">, 115 DescFile<"UnixAPIChecker.cpp">; 116 117def MacOSXAPIChecker : Checker<"API">, 118 InPackage<MacOSX>, 119 HelpText<"Check for proper uses of various Mac OS X APIs">, 120 DescFile<"MacOSXAPIChecker.cpp">; 121 122def OSAtomicChecker : Checker<"AtomicCAS">, 123 InPackage<MacOSX>, 124 HelpText<"Evaluate calls to OSAtomic functions">, 125 DescFile<"OSAtomicChecker.cpp">; 126 127def CFNumberCreateChecker : Checker<"CFNumber">, 128 InPackage<MacOSX>, 129 HelpText<"Check for proper uses of CFNumberCreate">, 130 DescFile<"BasicObjCFoundationChecks.cpp">; 131 132def CFRetainReleaseChecker : Checker<"CFRetainRelease">, 133 InPackage<MacOSX>, 134 HelpText<"Check for null arguments to CFRetain/CFRelease">, 135 DescFile<"BasicObjCFoundationChecks.cpp">; 136 137def LLVMConventionsChecker : Checker<"Conventions">, 138 InPackage<LLVM>, 139 HelpText<"Check code for LLVM codebase conventions">, 140 DescFile<"LLVMConventionsChecker.cpp">; 141 142def LiveVariablesDumper : Checker<"DumpLiveVars">, 143 InPackage<Debug>, 144 HelpText<"Print results of live variable analysis">, 145 DescFile<"DebugCheckers.cpp">; 146 147def CFGViewer : Checker<"ViewCFG">, 148 InPackage<Debug>, 149 HelpText<"View Control-Flow Graphs using GraphViz">, 150 DescFile<"DebugCheckers.cpp">; 151 152def CFGDumper : Checker<"DumpCFG">, 153 InPackage<Debug>, 154 HelpText<"Display Control-Flow Graphs">, 155 DescFile<"DebugCheckers.cpp">; 156 157def AnalyzerStatsChecker : Checker<"Stats">, 158 InPackage<Debug>, 159 HelpText<"Emit warnings with analyzer statistics">, 160 DescFile<"AnalyzerStatsChecker.cpp">; 161 162//===----------------------------------------------------------------------===// 163// Hidden experimental checkers. 164//===----------------------------------------------------------------------===// 165 166let Group = AllExperimental in { 167 168def ArrayBoundCheckerV2 : Checker<"Overflow">, 169 InPackage<CoreExperimental>, 170 HelpText<"Warn about buffer overflows">, 171 DescFile<"ArrayBoundCheckerV2.cpp">, 172 Hidden; // Must be specified explicitly in order to run. 173 174def MallocChecker : Checker<"Malloc">, 175 InPackage<CoreExperimental>, 176 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">, 177 DescFile<"MallocChecker.cpp">; 178 179def CStringChecker : Checker<"CString">, 180 InPackage<CoreExperimental>, 181 HelpText<"Check calls to functions in <string.h>">, 182 DescFile<"CStringChecker.cpp">; 183 184def UnreachableCodeChecker : Checker<"UnreachableCode">, 185 InPackage<CoreExperimental>, 186 HelpText<"Check unreachable code">, 187 DescFile<"UnreachableCodeChecker.cpp">, 188 Hidden; // Must be specified explicitly in order to run. 189 190def IdempotentOperationChecker : Checker<"IdempotentOps">, 191 InPackage<CoreExperimental>, 192 HelpText<"Warn about idempotent operations">, 193 DescFile<"IdempotentOperationChecker.cpp">; 194 195def CastToStructChecker : Checker<"CastToStruct">, 196 InPackage<CoreExperimental>, 197 HelpText<"Check for cast from non-struct pointer to struct pointer">, 198 DescFile<"CastToStructChecker.cpp">; 199 200def FixedAddressChecker : Checker<"FixedAddr">, 201 InPackage<CoreExperimental>, 202 HelpText<"Check for assignment of a fixed address to a pointer">, 203 DescFile<"FixedAddressChecker.cpp">; 204 205def PointerArithChecker : Checker<"PointerArithm">, 206 InPackage<CoreExperimental>, 207 HelpText<"Check for pointer arithmetic on locations other than array elements">, 208 DescFile<"PointerArithChecker">; 209 210def PointerSubChecker : Checker<"PointerSub">, 211 InPackage<CoreExperimental>, 212 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">, 213 DescFile<"PointerSubChecker">; 214 215def SizeofPointerChecker : Checker<"SizeofPtr">, 216 InPackage<CoreExperimental>, 217 HelpText<"Warn about unintended use of sizeof() on pointer expressions">, 218 DescFile<"CheckSizeofPointer.cpp">; 219 220def SecuritySyntaxChecker : Checker<"SecuritySyntactic">, 221 InPackage<CoreExperimental>, 222 HelpText<"Perform quick security checks that require no data flow">, 223 DescFile<"CheckSecuritySyntaxOnly.cpp">; 224 225def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">, 226 InPackage<CoreExperimental>, 227 HelpText<"Check for an out-of-bound pointer being returned to callers">, 228 DescFile<"ReturnPointerRangeChecker.cpp">; 229 230def ArrayBoundChecker : Checker<"ArrayBound">, 231 InPackage<CoreExperimental>, 232 HelpText<"Check for an out-of-bound pointer being returned to callers">, 233 DescFile<"ArrayBoundChecker.cpp">; 234 235def CastSizeChecker : Checker<"CastSize">, 236 InPackage<CoreExperimental>, 237 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">, 238 DescFile<"CastSizeChecker.cpp">; 239 240def ObjCDeallocChecker : Checker<"Dealloc">, 241 InPackage<CocoaExperimental>, 242 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">, 243 DescFile<"CheckObjCDealloc.cpp">; 244 245def ChrootChecker : Checker<"Chroot">, 246 InPackage<UnixExperimental>, 247 HelpText<"Check improper use of chroot">, 248 DescFile<"ChrootChecker.cpp">; 249 250def PthreadLockChecker : Checker<"PthreadLock">, 251 InPackage<UnixExperimental>, 252 HelpText<"Simple lock -> unlock checker">, 253 DescFile<"PthreadLockChecker.cpp">; 254 255def StreamChecker : Checker<"Stream">, 256 InPackage<UnixExperimental>, 257 HelpText<"Check stream handling functions">, 258 DescFile<"StreamChecker.cpp">; 259 260} 261