blob: 3edc3c247a37b1ead9cd51c96e20d21da275e37e [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 Kyrtzidis139ca962011-02-28 01:28:05 +000078def AdjustedReturnValueChecker : Checker<"AdjustRet">,
79 HelpText<"Check to see if the return value of a function call is different than the caller expects">,
80 DescFile<"AdjustedReturnValueChecker.cpp">;
81
Argyrios Kyrtzidisbd900762011-02-28 01:28:01 +000082def AttrNonNullChecker : Checker<"AttrNonNull">,
83 HelpText<"Check for arguments declared to have nonnull attribute">,
84 DescFile<"AttrNonNullChecker.cpp">;
85
Argyrios Kyrtzidis3ce2b482011-02-28 01:27:54 +000086def VLASizeChecker : Checker<"VLASize">,
87 HelpText<"Check for declarations of VLA of undefined or zero size">,
88 DescFile<"VLASizeChecker.cpp">;
89
Argyrios Kyrtzidis919c9b92011-02-28 01:27:50 +000090def DivZeroChecker : Checker<"DivZero">,
91 HelpText<"Check for division by zeros">,
92 DescFile<"DivZeroChecker.cpp">;
93
Argyrios Kyrtzidis7f649d72011-02-28 01:27:46 +000094def ReturnUndefChecker : Checker<"UndefReturn">,
95 HelpText<"Check for undefined or garbage values being returned to the caller">,
96 DescFile<"ReturnUndefChecker.cpp">;
97
Argyrios Kyrtzidiseb290ca2011-02-28 01:27:41 +000098def UndefinedArraySubscriptChecker : Checker<"UndefArraySubscript">,
99 HelpText<"Check for undefined array subscripts">,
100 DescFile<"UndefinedArraySubscriptChecker.cpp">;
101
Argyrios Kyrtzidis267aa5c2011-02-28 01:27:37 +0000102def UndefinedAssignmentChecker : Checker<"UndefAssign">,
103 HelpText<"Check for assigning undefined values">,
104 DescFile<"UndefinedAssignmentChecker.cpp">;
105
Argyrios Kyrtzidiscc05d512011-02-28 01:27:33 +0000106def UndefBranchChecker : Checker<"UndefBranch">,
107 HelpText<"Check for undefined branch conditions">,
108 DescFile<"UndefBranchChecker.cpp">;
109
Argyrios Kyrtzidis265c6742011-02-28 01:27:26 +0000110def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
111 HelpText<"Check for blocks that capture uninitialized values">,
112 DescFile<"UndefCapturedBlockVarChecker.cpp">;
113
Argyrios Kyrtzidis180e03f2011-02-28 01:27:22 +0000114def UndefResultChecker : Checker<"UndefBinOpResult">,
115 HelpText<"Check for undefined results of non-assignment binary operators">,
116 DescFile<"UndefResultChecker.cpp">;
117
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +0000118def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
119 HelpText<"Evaluate functions that do not return to the caller">,
120 DescFile<"NoReturnFunctionChecker.cpp">;
121
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +0000122def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
123 HelpText<"Evaluate clang builtin functions">,
124 DescFile<"BuiltinFunctionChecker.cpp">;
125
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000126def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000127 HelpText<"Check that addresses to stack memory do not escape the function">,
128 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000129
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +0000130} // end "core"
131
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000132def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000133 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000134 DescFile<"DeadStoresChecker.cpp">;
135
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000136def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000137 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000138 HelpText<"Check calls to various UNIX/Posix functions">,
139 DescFile<"UnixAPIChecker.cpp">;
140
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000141def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000142 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000143 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000144 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000145
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000146def OSAtomicChecker : Checker<"AtomicCAS">,
147 InPackage<MacOSX>,
148 HelpText<"Evaluate calls to OSAtomic functions">,
149 DescFile<"OSAtomicChecker.cpp">;
150
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000151def CFNumberCreateChecker : Checker<"CFNumber">,
152 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000153 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000154 DescFile<"BasicObjCFoundationChecks.cpp">;
155
156def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
157 InPackage<MacOSX>,
158 HelpText<"Check for null arguments to CFRetain/CFRelease">,
159 DescFile<"BasicObjCFoundationChecks.cpp">;
160
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000161def LLVMConventionsChecker : Checker<"Conventions">,
162 InPackage<LLVM>,
163 HelpText<"Check code for LLVM codebase conventions">,
164 DescFile<"LLVMConventionsChecker.cpp">;
165
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000166def LiveVariablesDumper : Checker<"DumpLiveVars">,
167 InPackage<Debug>,
168 HelpText<"Print results of live variable analysis">,
169 DescFile<"DebugCheckers.cpp">;
170
171def CFGViewer : Checker<"ViewCFG">,
172 InPackage<Debug>,
173 HelpText<"View Control-Flow Graphs using GraphViz">,
174 DescFile<"DebugCheckers.cpp">;
175
176def CFGDumper : Checker<"DumpCFG">,
177 InPackage<Debug>,
178 HelpText<"Display Control-Flow Graphs">,
179 DescFile<"DebugCheckers.cpp">;
180
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000181def AnalyzerStatsChecker : Checker<"Stats">,
182 InPackage<Debug>,
183 HelpText<"Emit warnings with analyzer statistics">,
184 DescFile<"AnalyzerStatsChecker.cpp">;
185
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000186//===----------------------------------------------------------------------===//
187// Hidden experimental checkers.
188//===----------------------------------------------------------------------===//
189
190let Group = AllExperimental in {
191
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000192def ArrayBoundCheckerV2 : Checker<"Overflow">,
193 InPackage<CoreExperimental>,
194 HelpText<"Warn about buffer overflows">,
195 DescFile<"ArrayBoundCheckerV2.cpp">,
196 Hidden; // Must be specified explicitly in order to run.
197
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000198def MallocChecker : Checker<"Malloc">,
199 InPackage<CoreExperimental>,
200 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
201 DescFile<"MallocChecker.cpp">;
202
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000203def CStringChecker : Checker<"CString">,
204 InPackage<CoreExperimental>,
205 HelpText<"Check calls to functions in <string.h>">,
206 DescFile<"CStringChecker.cpp">;
207
208def UnreachableCodeChecker : Checker<"UnreachableCode">,
209 InPackage<CoreExperimental>,
210 HelpText<"Check unreachable code">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000211 DescFile<"UnreachableCodeChecker.cpp">,
212 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000213
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000214def IdempotentOperationChecker : Checker<"IdempotentOps">,
215 InPackage<CoreExperimental>,
216 HelpText<"Warn about idempotent operations">,
217 DescFile<"IdempotentOperationChecker.cpp">;
218
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000219def CastToStructChecker : Checker<"CastToStruct">,
220 InPackage<CoreExperimental>,
221 HelpText<"Check for cast from non-struct pointer to struct pointer">,
222 DescFile<"CastToStructChecker.cpp">;
223
224def FixedAddressChecker : Checker<"FixedAddr">,
225 InPackage<CoreExperimental>,
226 HelpText<"Check for assignment of a fixed address to a pointer">,
227 DescFile<"FixedAddressChecker.cpp">;
228
229def PointerArithChecker : Checker<"PointerArithm">,
230 InPackage<CoreExperimental>,
231 HelpText<"Check for pointer arithmetic on locations other than array elements">,
232 DescFile<"PointerArithChecker">;
233
234def PointerSubChecker : Checker<"PointerSub">,
235 InPackage<CoreExperimental>,
236 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
237 DescFile<"PointerSubChecker">;
238
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000239def SizeofPointerChecker : Checker<"SizeofPtr">,
240 InPackage<CoreExperimental>,
241 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
242 DescFile<"CheckSizeofPointer.cpp">;
243
244def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
245 InPackage<CoreExperimental>,
246 HelpText<"Perform quick security checks that require no data flow">,
247 DescFile<"CheckSecuritySyntaxOnly.cpp">;
248
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000249def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
250 InPackage<CoreExperimental>,
251 HelpText<"Check for an out-of-bound pointer being returned to callers">,
252 DescFile<"ReturnPointerRangeChecker.cpp">;
253
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000254def ArrayBoundChecker : Checker<"ArrayBound">,
255 InPackage<CoreExperimental>,
256 HelpText<"Check for an out-of-bound pointer being returned to callers">,
257 DescFile<"ArrayBoundChecker.cpp">;
258
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000259def CastSizeChecker : Checker<"CastSize">,
260 InPackage<CoreExperimental>,
261 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
262 DescFile<"CastSizeChecker.cpp">;
263
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000264def ObjCDeallocChecker : Checker<"Dealloc">,
265 InPackage<CocoaExperimental>,
266 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
267 DescFile<"CheckObjCDealloc.cpp">;
268
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000269def ChrootChecker : Checker<"Chroot">,
270 InPackage<UnixExperimental>,
271 HelpText<"Check improper use of chroot">,
272 DescFile<"ChrootChecker.cpp">;
273
274def PthreadLockChecker : Checker<"PthreadLock">,
275 InPackage<UnixExperimental>,
276 HelpText<"Simple lock -> unlock checker">,
277 DescFile<"PthreadLockChecker.cpp">;
278
279def StreamChecker : Checker<"Stream">,
280 InPackage<UnixExperimental>,
281 HelpText<"Check stream handling functions">,
282 DescFile<"StreamChecker.cpp">;
283
284}