Checkers.td revision eb290caacc49587e4d3c992ba742d1916cab5350
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 UndefinedArraySubscriptChecker : Checker<"UndefArraySubscript">, 79 HelpText<"Check for undefined array subscripts">, 80 DescFile<"UndefinedArraySubscriptChecker.cpp">; 81 82def UndefinedAssignmentChecker : Checker<"UndefAssign">, 83 HelpText<"Check for assigning undefined values">, 84 DescFile<"UndefinedAssignmentChecker.cpp">; 85 86def UndefBranchChecker : Checker<"UndefBranch">, 87 HelpText<"Check for undefined branch conditions">, 88 DescFile<"UndefBranchChecker.cpp">; 89 90def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">, 91 HelpText<"Check for blocks that capture uninitialized values">, 92 DescFile<"UndefCapturedBlockVarChecker.cpp">; 93 94def UndefResultChecker : Checker<"UndefBinOpResult">, 95 HelpText<"Check for undefined results of non-assignment binary operators">, 96 DescFile<"UndefResultChecker.cpp">; 97 98def NoReturnFunctionChecker : Checker<"NoReturnFunc">, 99 HelpText<"Evaluate functions that do not return to the caller">, 100 DescFile<"NoReturnFunctionChecker.cpp">; 101 102def BuiltinFunctionChecker : Checker<"BuiltinFunc">, 103 HelpText<"Evaluate clang builtin functions">, 104 DescFile<"BuiltinFunctionChecker.cpp">; 105 106def StackAddrEscapeChecker : Checker<"StackAddrEscape">, 107 HelpText<"Check that addresses to stack memory do not escape the function">, 108 DescFile<"StackAddrEscapeChecker.cpp">; 109 110} // end "core" 111 112def DeadStoresChecker : Checker<"DeadStores">, 113 HelpText<"Check for values stored to a variables that are never read afterwards">, 114 DescFile<"DeadStoresChecker.cpp">; 115 116def UnixAPIChecker : Checker<"API">, 117 InPackage<Unix>, 118 HelpText<"Check calls to various UNIX/Posix functions">, 119 DescFile<"UnixAPIChecker.cpp">; 120 121def MacOSXAPIChecker : Checker<"API">, 122 InPackage<MacOSX>, 123 HelpText<"Check for proper uses of various Mac OS X APIs">, 124 DescFile<"MacOSXAPIChecker.cpp">; 125 126def OSAtomicChecker : Checker<"AtomicCAS">, 127 InPackage<MacOSX>, 128 HelpText<"Evaluate calls to OSAtomic functions">, 129 DescFile<"OSAtomicChecker.cpp">; 130 131def CFNumberCreateChecker : Checker<"CFNumber">, 132 InPackage<MacOSX>, 133 HelpText<"Check for proper uses of CFNumberCreate">, 134 DescFile<"BasicObjCFoundationChecks.cpp">; 135 136def CFRetainReleaseChecker : Checker<"CFRetainRelease">, 137 InPackage<MacOSX>, 138 HelpText<"Check for null arguments to CFRetain/CFRelease">, 139 DescFile<"BasicObjCFoundationChecks.cpp">; 140 141def LLVMConventionsChecker : Checker<"Conventions">, 142 InPackage<LLVM>, 143 HelpText<"Check code for LLVM codebase conventions">, 144 DescFile<"LLVMConventionsChecker.cpp">; 145 146def LiveVariablesDumper : Checker<"DumpLiveVars">, 147 InPackage<Debug>, 148 HelpText<"Print results of live variable analysis">, 149 DescFile<"DebugCheckers.cpp">; 150 151def CFGViewer : Checker<"ViewCFG">, 152 InPackage<Debug>, 153 HelpText<"View Control-Flow Graphs using GraphViz">, 154 DescFile<"DebugCheckers.cpp">; 155 156def CFGDumper : Checker<"DumpCFG">, 157 InPackage<Debug>, 158 HelpText<"Display Control-Flow Graphs">, 159 DescFile<"DebugCheckers.cpp">; 160 161def AnalyzerStatsChecker : Checker<"Stats">, 162 InPackage<Debug>, 163 HelpText<"Emit warnings with analyzer statistics">, 164 DescFile<"AnalyzerStatsChecker.cpp">; 165 166//===----------------------------------------------------------------------===// 167// Hidden experimental checkers. 168//===----------------------------------------------------------------------===// 169 170let Group = AllExperimental in { 171 172def ArrayBoundCheckerV2 : Checker<"Overflow">, 173 InPackage<CoreExperimental>, 174 HelpText<"Warn about buffer overflows">, 175 DescFile<"ArrayBoundCheckerV2.cpp">, 176 Hidden; // Must be specified explicitly in order to run. 177 178def MallocChecker : Checker<"Malloc">, 179 InPackage<CoreExperimental>, 180 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">, 181 DescFile<"MallocChecker.cpp">; 182 183def CStringChecker : Checker<"CString">, 184 InPackage<CoreExperimental>, 185 HelpText<"Check calls to functions in <string.h>">, 186 DescFile<"CStringChecker.cpp">; 187 188def UnreachableCodeChecker : Checker<"UnreachableCode">, 189 InPackage<CoreExperimental>, 190 HelpText<"Check unreachable code">, 191 DescFile<"UnreachableCodeChecker.cpp">, 192 Hidden; // Must be specified explicitly in order to run. 193 194def IdempotentOperationChecker : Checker<"IdempotentOps">, 195 InPackage<CoreExperimental>, 196 HelpText<"Warn about idempotent operations">, 197 DescFile<"IdempotentOperationChecker.cpp">; 198 199def CastToStructChecker : Checker<"CastToStruct">, 200 InPackage<CoreExperimental>, 201 HelpText<"Check for cast from non-struct pointer to struct pointer">, 202 DescFile<"CastToStructChecker.cpp">; 203 204def FixedAddressChecker : Checker<"FixedAddr">, 205 InPackage<CoreExperimental>, 206 HelpText<"Check for assignment of a fixed address to a pointer">, 207 DescFile<"FixedAddressChecker.cpp">; 208 209def PointerArithChecker : Checker<"PointerArithm">, 210 InPackage<CoreExperimental>, 211 HelpText<"Check for pointer arithmetic on locations other than array elements">, 212 DescFile<"PointerArithChecker">; 213 214def PointerSubChecker : Checker<"PointerSub">, 215 InPackage<CoreExperimental>, 216 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">, 217 DescFile<"PointerSubChecker">; 218 219def SizeofPointerChecker : Checker<"SizeofPtr">, 220 InPackage<CoreExperimental>, 221 HelpText<"Warn about unintended use of sizeof() on pointer expressions">, 222 DescFile<"CheckSizeofPointer.cpp">; 223 224def SecuritySyntaxChecker : Checker<"SecuritySyntactic">, 225 InPackage<CoreExperimental>, 226 HelpText<"Perform quick security checks that require no data flow">, 227 DescFile<"CheckSecuritySyntaxOnly.cpp">; 228 229def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">, 230 InPackage<CoreExperimental>, 231 HelpText<"Check for an out-of-bound pointer being returned to callers">, 232 DescFile<"ReturnPointerRangeChecker.cpp">; 233 234def ArrayBoundChecker : Checker<"ArrayBound">, 235 InPackage<CoreExperimental>, 236 HelpText<"Check for an out-of-bound pointer being returned to callers">, 237 DescFile<"ArrayBoundChecker.cpp">; 238 239def CastSizeChecker : Checker<"CastSize">, 240 InPackage<CoreExperimental>, 241 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">, 242 DescFile<"CastSizeChecker.cpp">; 243 244def ObjCDeallocChecker : Checker<"Dealloc">, 245 InPackage<CocoaExperimental>, 246 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">, 247 DescFile<"CheckObjCDealloc.cpp">; 248 249def ChrootChecker : Checker<"Chroot">, 250 InPackage<UnixExperimental>, 251 HelpText<"Check improper use of chroot">, 252 DescFile<"ChrootChecker.cpp">; 253 254def PthreadLockChecker : Checker<"PthreadLock">, 255 InPackage<UnixExperimental>, 256 HelpText<"Simple lock -> unlock checker">, 257 DescFile<"PthreadLockChecker.cpp">; 258 259def StreamChecker : Checker<"Stream">, 260 InPackage<UnixExperimental>, 261 HelpText<"Check stream handling functions">, 262 DescFile<"StreamChecker.cpp">; 263 264} 265