blob: 1a2205fd5b69fd08cb46da599c1d0f83971ed8ac [file] [log] [blame]
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +00001//===--- 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
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000012//===----------------------------------------------------------------------===//
13// Packages.
14//===----------------------------------------------------------------------===//
15
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000016def Core : Package<"core">;
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +000017def Cocoa : Package<"cocoa">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000018def Unix : Package<"unix">;
19def MacOSX : Package<"macosx">;
20
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000021def CoreExperimental : Package<"experimental">,
22 InPackage<Core>, Hidden;
23
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000024def CocoaExperimental : Package<"experimental">,
25 InPackage<Cocoa>, Hidden;
26
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000027def UnixExperimental : Package<"experimental">,
28 InPackage<Unix>, Hidden;
29
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000030def LLVM : Package<"llvm">;
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +000031def Debug : Package<"debug">;
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000032
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000033//===----------------------------------------------------------------------===//
34// Groups.
35//===----------------------------------------------------------------------===//
36
37def AllExperimental : CheckerGroup<"all-experimental">,
38 Hidden;
39
40//===----------------------------------------------------------------------===//
41// Checkers.
42//===----------------------------------------------------------------------===//
43
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000044let ParentPackage = Cocoa in {
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +000045
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +000046def ObjCSelfInitChecker : Checker<"SelfInit">,
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +000047 HelpText<"Check that 'self' is propely initialized inside an initializer method">,
48 DescFile<"ObjCSelfInitChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000049
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +000050def ObjCAtSyncChecker : Checker<"AtSync">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000051 HelpText<"Check for null pointers used as mutexes for @synchronized">,
52 DescFile<"ObjCAtSyncChecker.cpp">;
53
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +000054def 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
Ted Kremenekb8d545c2011-02-25 22:19:14 +000062def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
63 HelpText<"Warn for subpar uses of NSAutoreleasePool">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +000064 DescFile<"NSAutoreleasePoolChecker.cpp">;
65
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000066def 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
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000074} // end "cocoa"
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000075
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +000076let ParentPackage = Core in {
77
Argyrios Kyrtzidiscc05d512011-02-28 01:27:33 +000078def UndefBranchChecker : Checker<"UndefBranch">,
79 HelpText<"Check for undefined branch conditions">,
80 DescFile<"UndefBranchChecker.cpp">;
81
Argyrios Kyrtzidis265c6742011-02-28 01:27:26 +000082def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
83 HelpText<"Check for blocks that capture uninitialized values">,
84 DescFile<"UndefCapturedBlockVarChecker.cpp">;
85
Argyrios Kyrtzidis180e03f2011-02-28 01:27:22 +000086def UndefResultChecker : Checker<"UndefBinOpResult">,
87 HelpText<"Check for undefined results of non-assignment binary operators">,
88 DescFile<"UndefResultChecker.cpp">;
89
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +000090def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
91 HelpText<"Evaluate functions that do not return to the caller">,
92 DescFile<"NoReturnFunctionChecker.cpp">;
93
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +000094def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
95 HelpText<"Evaluate clang builtin functions">,
96 DescFile<"BuiltinFunctionChecker.cpp">;
97
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000098def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000099 HelpText<"Check that addresses to stack memory do not escape the function">,
100 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000101
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +0000102} // end "core"
103
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000104def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000105 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000106 DescFile<"DeadStoresChecker.cpp">;
107
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000108def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000109 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000110 HelpText<"Check calls to various UNIX/Posix functions">,
111 DescFile<"UnixAPIChecker.cpp">;
112
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000113def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000114 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000115 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000116 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000117
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000118def OSAtomicChecker : Checker<"AtomicCAS">,
119 InPackage<MacOSX>,
120 HelpText<"Evaluate calls to OSAtomic functions">,
121 DescFile<"OSAtomicChecker.cpp">;
122
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000123def CFNumberCreateChecker : Checker<"CFNumber">,
124 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000125 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000126 DescFile<"BasicObjCFoundationChecks.cpp">;
127
128def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
129 InPackage<MacOSX>,
130 HelpText<"Check for null arguments to CFRetain/CFRelease">,
131 DescFile<"BasicObjCFoundationChecks.cpp">;
132
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000133def LLVMConventionsChecker : Checker<"Conventions">,
134 InPackage<LLVM>,
135 HelpText<"Check code for LLVM codebase conventions">,
136 DescFile<"LLVMConventionsChecker.cpp">;
137
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000138def LiveVariablesDumper : Checker<"DumpLiveVars">,
139 InPackage<Debug>,
140 HelpText<"Print results of live variable analysis">,
141 DescFile<"DebugCheckers.cpp">;
142
143def CFGViewer : Checker<"ViewCFG">,
144 InPackage<Debug>,
145 HelpText<"View Control-Flow Graphs using GraphViz">,
146 DescFile<"DebugCheckers.cpp">;
147
148def CFGDumper : Checker<"DumpCFG">,
149 InPackage<Debug>,
150 HelpText<"Display Control-Flow Graphs">,
151 DescFile<"DebugCheckers.cpp">;
152
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000153def AnalyzerStatsChecker : Checker<"Stats">,
154 InPackage<Debug>,
155 HelpText<"Emit warnings with analyzer statistics">,
156 DescFile<"AnalyzerStatsChecker.cpp">;
157
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000158//===----------------------------------------------------------------------===//
159// Hidden experimental checkers.
160//===----------------------------------------------------------------------===//
161
162let Group = AllExperimental in {
163
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000164def ArrayBoundCheckerV2 : Checker<"Overflow">,
165 InPackage<CoreExperimental>,
166 HelpText<"Warn about buffer overflows">,
167 DescFile<"ArrayBoundCheckerV2.cpp">,
168 Hidden; // Must be specified explicitly in order to run.
169
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000170def MallocChecker : Checker<"Malloc">,
171 InPackage<CoreExperimental>,
172 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
173 DescFile<"MallocChecker.cpp">;
174
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000175def CStringChecker : Checker<"CString">,
176 InPackage<CoreExperimental>,
177 HelpText<"Check calls to functions in <string.h>">,
178 DescFile<"CStringChecker.cpp">;
179
180def UnreachableCodeChecker : Checker<"UnreachableCode">,
181 InPackage<CoreExperimental>,
182 HelpText<"Check unreachable code">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000183 DescFile<"UnreachableCodeChecker.cpp">,
184 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000185
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000186def IdempotentOperationChecker : Checker<"IdempotentOps">,
187 InPackage<CoreExperimental>,
188 HelpText<"Warn about idempotent operations">,
189 DescFile<"IdempotentOperationChecker.cpp">;
190
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000191def CastToStructChecker : Checker<"CastToStruct">,
192 InPackage<CoreExperimental>,
193 HelpText<"Check for cast from non-struct pointer to struct pointer">,
194 DescFile<"CastToStructChecker.cpp">;
195
196def FixedAddressChecker : Checker<"FixedAddr">,
197 InPackage<CoreExperimental>,
198 HelpText<"Check for assignment of a fixed address to a pointer">,
199 DescFile<"FixedAddressChecker.cpp">;
200
201def PointerArithChecker : Checker<"PointerArithm">,
202 InPackage<CoreExperimental>,
203 HelpText<"Check for pointer arithmetic on locations other than array elements">,
204 DescFile<"PointerArithChecker">;
205
206def PointerSubChecker : Checker<"PointerSub">,
207 InPackage<CoreExperimental>,
208 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
209 DescFile<"PointerSubChecker">;
210
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000211def SizeofPointerChecker : Checker<"SizeofPtr">,
212 InPackage<CoreExperimental>,
213 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
214 DescFile<"CheckSizeofPointer.cpp">;
215
216def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
217 InPackage<CoreExperimental>,
218 HelpText<"Perform quick security checks that require no data flow">,
219 DescFile<"CheckSecuritySyntaxOnly.cpp">;
220
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000221def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
222 InPackage<CoreExperimental>,
223 HelpText<"Check for an out-of-bound pointer being returned to callers">,
224 DescFile<"ReturnPointerRangeChecker.cpp">;
225
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000226def ArrayBoundChecker : Checker<"ArrayBound">,
227 InPackage<CoreExperimental>,
228 HelpText<"Check for an out-of-bound pointer being returned to callers">,
229 DescFile<"ArrayBoundChecker.cpp">;
230
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000231def CastSizeChecker : Checker<"CastSize">,
232 InPackage<CoreExperimental>,
233 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
234 DescFile<"CastSizeChecker.cpp">;
235
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000236def ObjCDeallocChecker : Checker<"Dealloc">,
237 InPackage<CocoaExperimental>,
238 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
239 DescFile<"CheckObjCDealloc.cpp">;
240
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000241def ChrootChecker : Checker<"Chroot">,
242 InPackage<UnixExperimental>,
243 HelpText<"Check improper use of chroot">,
244 DescFile<"ChrootChecker.cpp">;
245
246def PthreadLockChecker : Checker<"PthreadLock">,
247 InPackage<UnixExperimental>,
248 HelpText<"Simple lock -> unlock checker">,
249 DescFile<"PthreadLockChecker.cpp">;
250
251def StreamChecker : Checker<"Stream">,
252 InPackage<UnixExperimental>,
253 HelpText<"Check stream handling functions">,
254 DescFile<"StreamChecker.cpp">;
255
256}