blob: 4f40e04a43a41ca78a7f6d03a509c7c7ba4654fc [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 Kyrtzidis267aa5c2011-02-28 01:27:37 +000078def UndefinedAssignmentChecker : Checker<"UndefAssign">,
79 HelpText<"Check for assigning undefined values">,
80 DescFile<"UndefinedAssignmentChecker.cpp">;
81
Argyrios Kyrtzidiscc05d512011-02-28 01:27:33 +000082def UndefBranchChecker : Checker<"UndefBranch">,
83 HelpText<"Check for undefined branch conditions">,
84 DescFile<"UndefBranchChecker.cpp">;
85
Argyrios Kyrtzidis265c6742011-02-28 01:27:26 +000086def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
87 HelpText<"Check for blocks that capture uninitialized values">,
88 DescFile<"UndefCapturedBlockVarChecker.cpp">;
89
Argyrios Kyrtzidis180e03f2011-02-28 01:27:22 +000090def UndefResultChecker : Checker<"UndefBinOpResult">,
91 HelpText<"Check for undefined results of non-assignment binary operators">,
92 DescFile<"UndefResultChecker.cpp">;
93
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +000094def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
95 HelpText<"Evaluate functions that do not return to the caller">,
96 DescFile<"NoReturnFunctionChecker.cpp">;
97
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +000098def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
99 HelpText<"Evaluate clang builtin functions">,
100 DescFile<"BuiltinFunctionChecker.cpp">;
101
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000102def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000103 HelpText<"Check that addresses to stack memory do not escape the function">,
104 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000105
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +0000106} // end "core"
107
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000108def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000109 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000110 DescFile<"DeadStoresChecker.cpp">;
111
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000112def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000113 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000114 HelpText<"Check calls to various UNIX/Posix functions">,
115 DescFile<"UnixAPIChecker.cpp">;
116
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000117def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000118 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000119 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000120 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000121
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000122def OSAtomicChecker : Checker<"AtomicCAS">,
123 InPackage<MacOSX>,
124 HelpText<"Evaluate calls to OSAtomic functions">,
125 DescFile<"OSAtomicChecker.cpp">;
126
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000127def CFNumberCreateChecker : Checker<"CFNumber">,
128 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000129 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000130 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
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000137def LLVMConventionsChecker : Checker<"Conventions">,
138 InPackage<LLVM>,
139 HelpText<"Check code for LLVM codebase conventions">,
140 DescFile<"LLVMConventionsChecker.cpp">;
141
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000142def 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
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000157def AnalyzerStatsChecker : Checker<"Stats">,
158 InPackage<Debug>,
159 HelpText<"Emit warnings with analyzer statistics">,
160 DescFile<"AnalyzerStatsChecker.cpp">;
161
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000162//===----------------------------------------------------------------------===//
163// Hidden experimental checkers.
164//===----------------------------------------------------------------------===//
165
166let Group = AllExperimental in {
167
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000168def 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
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000174def 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
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000179def 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">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000187 DescFile<"UnreachableCodeChecker.cpp">,
188 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000189
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000190def IdempotentOperationChecker : Checker<"IdempotentOps">,
191 InPackage<CoreExperimental>,
192 HelpText<"Warn about idempotent operations">,
193 DescFile<"IdempotentOperationChecker.cpp">;
194
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000195def 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
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000215def 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
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000225def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
226 InPackage<CoreExperimental>,
227 HelpText<"Check for an out-of-bound pointer being returned to callers">,
228 DescFile<"ReturnPointerRangeChecker.cpp">;
229
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000230def ArrayBoundChecker : Checker<"ArrayBound">,
231 InPackage<CoreExperimental>,
232 HelpText<"Check for an out-of-bound pointer being returned to callers">,
233 DescFile<"ArrayBoundChecker.cpp">;
234
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000235def 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
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000240def 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
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000245def 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}