blob: 26569878c6dea867efcf787c358989a1bceac178 [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 Kyrtzidis7f649d72011-02-28 01:27:46 +000078def ReturnUndefChecker : Checker<"UndefReturn">,
79 HelpText<"Check for undefined or garbage values being returned to the caller">,
80 DescFile<"ReturnUndefChecker.cpp">;
81
Argyrios Kyrtzidiseb290ca2011-02-28 01:27:41 +000082def UndefinedArraySubscriptChecker : Checker<"UndefArraySubscript">,
83 HelpText<"Check for undefined array subscripts">,
84 DescFile<"UndefinedArraySubscriptChecker.cpp">;
85
Argyrios Kyrtzidis267aa5c2011-02-28 01:27:37 +000086def UndefinedAssignmentChecker : Checker<"UndefAssign">,
87 HelpText<"Check for assigning undefined values">,
88 DescFile<"UndefinedAssignmentChecker.cpp">;
89
Argyrios Kyrtzidiscc05d512011-02-28 01:27:33 +000090def UndefBranchChecker : Checker<"UndefBranch">,
91 HelpText<"Check for undefined branch conditions">,
92 DescFile<"UndefBranchChecker.cpp">;
93
Argyrios Kyrtzidis265c6742011-02-28 01:27:26 +000094def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
95 HelpText<"Check for blocks that capture uninitialized values">,
96 DescFile<"UndefCapturedBlockVarChecker.cpp">;
97
Argyrios Kyrtzidis180e03f2011-02-28 01:27:22 +000098def UndefResultChecker : Checker<"UndefBinOpResult">,
99 HelpText<"Check for undefined results of non-assignment binary operators">,
100 DescFile<"UndefResultChecker.cpp">;
101
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +0000102def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
103 HelpText<"Evaluate functions that do not return to the caller">,
104 DescFile<"NoReturnFunctionChecker.cpp">;
105
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +0000106def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
107 HelpText<"Evaluate clang builtin functions">,
108 DescFile<"BuiltinFunctionChecker.cpp">;
109
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000110def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000111 HelpText<"Check that addresses to stack memory do not escape the function">,
112 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000113
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +0000114} // end "core"
115
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000116def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000117 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000118 DescFile<"DeadStoresChecker.cpp">;
119
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000120def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000121 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000122 HelpText<"Check calls to various UNIX/Posix functions">,
123 DescFile<"UnixAPIChecker.cpp">;
124
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000125def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000126 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000127 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000128 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000129
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000130def OSAtomicChecker : Checker<"AtomicCAS">,
131 InPackage<MacOSX>,
132 HelpText<"Evaluate calls to OSAtomic functions">,
133 DescFile<"OSAtomicChecker.cpp">;
134
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000135def CFNumberCreateChecker : Checker<"CFNumber">,
136 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000137 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000138 DescFile<"BasicObjCFoundationChecks.cpp">;
139
140def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
141 InPackage<MacOSX>,
142 HelpText<"Check for null arguments to CFRetain/CFRelease">,
143 DescFile<"BasicObjCFoundationChecks.cpp">;
144
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000145def LLVMConventionsChecker : Checker<"Conventions">,
146 InPackage<LLVM>,
147 HelpText<"Check code for LLVM codebase conventions">,
148 DescFile<"LLVMConventionsChecker.cpp">;
149
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000150def LiveVariablesDumper : Checker<"DumpLiveVars">,
151 InPackage<Debug>,
152 HelpText<"Print results of live variable analysis">,
153 DescFile<"DebugCheckers.cpp">;
154
155def CFGViewer : Checker<"ViewCFG">,
156 InPackage<Debug>,
157 HelpText<"View Control-Flow Graphs using GraphViz">,
158 DescFile<"DebugCheckers.cpp">;
159
160def CFGDumper : Checker<"DumpCFG">,
161 InPackage<Debug>,
162 HelpText<"Display Control-Flow Graphs">,
163 DescFile<"DebugCheckers.cpp">;
164
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000165def AnalyzerStatsChecker : Checker<"Stats">,
166 InPackage<Debug>,
167 HelpText<"Emit warnings with analyzer statistics">,
168 DescFile<"AnalyzerStatsChecker.cpp">;
169
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000170//===----------------------------------------------------------------------===//
171// Hidden experimental checkers.
172//===----------------------------------------------------------------------===//
173
174let Group = AllExperimental in {
175
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000176def ArrayBoundCheckerV2 : Checker<"Overflow">,
177 InPackage<CoreExperimental>,
178 HelpText<"Warn about buffer overflows">,
179 DescFile<"ArrayBoundCheckerV2.cpp">,
180 Hidden; // Must be specified explicitly in order to run.
181
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000182def MallocChecker : Checker<"Malloc">,
183 InPackage<CoreExperimental>,
184 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
185 DescFile<"MallocChecker.cpp">;
186
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000187def CStringChecker : Checker<"CString">,
188 InPackage<CoreExperimental>,
189 HelpText<"Check calls to functions in <string.h>">,
190 DescFile<"CStringChecker.cpp">;
191
192def UnreachableCodeChecker : Checker<"UnreachableCode">,
193 InPackage<CoreExperimental>,
194 HelpText<"Check unreachable code">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000195 DescFile<"UnreachableCodeChecker.cpp">,
196 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000197
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000198def IdempotentOperationChecker : Checker<"IdempotentOps">,
199 InPackage<CoreExperimental>,
200 HelpText<"Warn about idempotent operations">,
201 DescFile<"IdempotentOperationChecker.cpp">;
202
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000203def CastToStructChecker : Checker<"CastToStruct">,
204 InPackage<CoreExperimental>,
205 HelpText<"Check for cast from non-struct pointer to struct pointer">,
206 DescFile<"CastToStructChecker.cpp">;
207
208def FixedAddressChecker : Checker<"FixedAddr">,
209 InPackage<CoreExperimental>,
210 HelpText<"Check for assignment of a fixed address to a pointer">,
211 DescFile<"FixedAddressChecker.cpp">;
212
213def PointerArithChecker : Checker<"PointerArithm">,
214 InPackage<CoreExperimental>,
215 HelpText<"Check for pointer arithmetic on locations other than array elements">,
216 DescFile<"PointerArithChecker">;
217
218def PointerSubChecker : Checker<"PointerSub">,
219 InPackage<CoreExperimental>,
220 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
221 DescFile<"PointerSubChecker">;
222
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000223def SizeofPointerChecker : Checker<"SizeofPtr">,
224 InPackage<CoreExperimental>,
225 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
226 DescFile<"CheckSizeofPointer.cpp">;
227
228def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
229 InPackage<CoreExperimental>,
230 HelpText<"Perform quick security checks that require no data flow">,
231 DescFile<"CheckSecuritySyntaxOnly.cpp">;
232
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000233def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
234 InPackage<CoreExperimental>,
235 HelpText<"Check for an out-of-bound pointer being returned to callers">,
236 DescFile<"ReturnPointerRangeChecker.cpp">;
237
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000238def ArrayBoundChecker : Checker<"ArrayBound">,
239 InPackage<CoreExperimental>,
240 HelpText<"Check for an out-of-bound pointer being returned to callers">,
241 DescFile<"ArrayBoundChecker.cpp">;
242
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000243def CastSizeChecker : Checker<"CastSize">,
244 InPackage<CoreExperimental>,
245 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
246 DescFile<"CastSizeChecker.cpp">;
247
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000248def ObjCDeallocChecker : Checker<"Dealloc">,
249 InPackage<CocoaExperimental>,
250 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
251 DescFile<"CheckObjCDealloc.cpp">;
252
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000253def ChrootChecker : Checker<"Chroot">,
254 InPackage<UnixExperimental>,
255 HelpText<"Check improper use of chroot">,
256 DescFile<"ChrootChecker.cpp">;
257
258def PthreadLockChecker : Checker<"PthreadLock">,
259 InPackage<UnixExperimental>,
260 HelpText<"Simple lock -> unlock checker">,
261 DescFile<"PthreadLockChecker.cpp">;
262
263def StreamChecker : Checker<"Stream">,
264 InPackage<UnixExperimental>,
265 HelpText<"Check stream handling functions">,
266 DescFile<"StreamChecker.cpp">;
267
268}