blob: 061030016b88c95195a64992fa1d533f1d2f7d52 [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 Kyrtzidiseb290ca2011-02-28 01:27:41 +000078def UndefinedArraySubscriptChecker : Checker<"UndefArraySubscript">,
79 HelpText<"Check for undefined array subscripts">,
80 DescFile<"UndefinedArraySubscriptChecker.cpp">;
81
Argyrios Kyrtzidis267aa5c2011-02-28 01:27:37 +000082def UndefinedAssignmentChecker : Checker<"UndefAssign">,
83 HelpText<"Check for assigning undefined values">,
84 DescFile<"UndefinedAssignmentChecker.cpp">;
85
Argyrios Kyrtzidiscc05d512011-02-28 01:27:33 +000086def UndefBranchChecker : Checker<"UndefBranch">,
87 HelpText<"Check for undefined branch conditions">,
88 DescFile<"UndefBranchChecker.cpp">;
89
Argyrios Kyrtzidis265c6742011-02-28 01:27:26 +000090def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
91 HelpText<"Check for blocks that capture uninitialized values">,
92 DescFile<"UndefCapturedBlockVarChecker.cpp">;
93
Argyrios Kyrtzidis180e03f2011-02-28 01:27:22 +000094def UndefResultChecker : Checker<"UndefBinOpResult">,
95 HelpText<"Check for undefined results of non-assignment binary operators">,
96 DescFile<"UndefResultChecker.cpp">;
97
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +000098def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
99 HelpText<"Evaluate functions that do not return to the caller">,
100 DescFile<"NoReturnFunctionChecker.cpp">;
101
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +0000102def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
103 HelpText<"Evaluate clang builtin functions">,
104 DescFile<"BuiltinFunctionChecker.cpp">;
105
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000106def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000107 HelpText<"Check that addresses to stack memory do not escape the function">,
108 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000109
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +0000110} // end "core"
111
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000112def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000113 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000114 DescFile<"DeadStoresChecker.cpp">;
115
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000116def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000117 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000118 HelpText<"Check calls to various UNIX/Posix functions">,
119 DescFile<"UnixAPIChecker.cpp">;
120
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000121def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000122 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000123 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000124 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000125
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000126def OSAtomicChecker : Checker<"AtomicCAS">,
127 InPackage<MacOSX>,
128 HelpText<"Evaluate calls to OSAtomic functions">,
129 DescFile<"OSAtomicChecker.cpp">;
130
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000131def CFNumberCreateChecker : Checker<"CFNumber">,
132 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000133 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000134 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
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000141def LLVMConventionsChecker : Checker<"Conventions">,
142 InPackage<LLVM>,
143 HelpText<"Check code for LLVM codebase conventions">,
144 DescFile<"LLVMConventionsChecker.cpp">;
145
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000146def 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
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000161def AnalyzerStatsChecker : Checker<"Stats">,
162 InPackage<Debug>,
163 HelpText<"Emit warnings with analyzer statistics">,
164 DescFile<"AnalyzerStatsChecker.cpp">;
165
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000166//===----------------------------------------------------------------------===//
167// Hidden experimental checkers.
168//===----------------------------------------------------------------------===//
169
170let Group = AllExperimental in {
171
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000172def 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
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000178def 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
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000183def 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">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000191 DescFile<"UnreachableCodeChecker.cpp">,
192 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000193
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000194def IdempotentOperationChecker : Checker<"IdempotentOps">,
195 InPackage<CoreExperimental>,
196 HelpText<"Warn about idempotent operations">,
197 DescFile<"IdempotentOperationChecker.cpp">;
198
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000199def 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
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000219def 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
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000229def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
230 InPackage<CoreExperimental>,
231 HelpText<"Check for an out-of-bound pointer being returned to callers">,
232 DescFile<"ReturnPointerRangeChecker.cpp">;
233
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000234def ArrayBoundChecker : Checker<"ArrayBound">,
235 InPackage<CoreExperimental>,
236 HelpText<"Check for an out-of-bound pointer being returned to callers">,
237 DescFile<"ArrayBoundChecker.cpp">;
238
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000239def 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
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000244def 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
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000249def 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}