blob: 33611dae835f5b692bb3856ac3a30e5cae218d10 [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">;
Ted Kremenekade31952011-03-12 06:14:28 +000020def DeadCode : Package<"deadcode">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000021
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000022def CoreExperimental : Package<"experimental">,
23 InPackage<Core>, Hidden;
24
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000025def CocoaExperimental : Package<"experimental">,
26 InPackage<Cocoa>, Hidden;
27
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000028def UnixExperimental : Package<"experimental">,
29 InPackage<Unix>, Hidden;
30
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000031def LLVM : Package<"llvm">;
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +000032def Debug : Package<"debug">;
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +000033
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +000034//===----------------------------------------------------------------------===//
35// Groups.
36//===----------------------------------------------------------------------===//
37
38def AllExperimental : CheckerGroup<"all-experimental">,
39 Hidden;
40
41//===----------------------------------------------------------------------===//
42// Checkers.
43//===----------------------------------------------------------------------===//
44
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000045let ParentPackage = Cocoa in {
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +000046
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +000047def ObjCSelfInitChecker : Checker<"SelfInit">,
Argyrios Kyrtzidis43dee222011-02-14 18:13:31 +000048 HelpText<"Check that 'self' is propely initialized inside an initializer method">,
49 DescFile<"ObjCSelfInitChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000050
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +000051def ObjCAtSyncChecker : Checker<"AtSync">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000052 HelpText<"Check for null pointers used as mutexes for @synchronized">,
53 DescFile<"ObjCAtSyncChecker.cpp">;
54
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +000055def NilArgChecker : Checker<"NilArg">,
56 HelpText<"Check for prohibited nil arguments to ObjC method calls">,
57 DescFile<"BasicObjCFoundationChecks.cpp">;
58
59def ClassReleaseChecker : Checker<"ClassRelease">,
60 HelpText<"Check for sending 'retain', 'release', or 'autorelease' directly to a Class">,
61 DescFile<"BasicObjCFoundationChecks.cpp">;
62
Ted Kremenekb8d545c2011-02-25 22:19:14 +000063def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
64 HelpText<"Warn for subpar uses of NSAutoreleasePool">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +000065 DescFile<"NSAutoreleasePoolChecker.cpp">;
66
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000067def ObjCMethSigsChecker : Checker<"MethodSigs">,
68 HelpText<"Warn about Objective-C method signatures with type incompatibilities">,
69 DescFile<"CheckObjCInstMethSignature.cpp">;
70
71def ObjCUnusedIvarsChecker : Checker<"UnusedIvars">,
72 HelpText<"Warn about private ivars that are never used">,
73 DescFile<"ObjCUnusedIVarsChecker.cpp">;
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +000074
75def NSErrorChecker : Checker<"NSError">,
76 HelpText<"Check usage of NSError** parameters">,
77 DescFile<"NSErrorChecker.cpp">;
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000078
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000079} // end "cocoa"
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000080
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +000081let ParentPackage = Core in {
82
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +000083def DereferenceChecker : Checker<"Deref">,
84 HelpText<"Check for null pointers at loads and stores">,
85 DescFile<"DereferenceChecker.cpp">;
86
Argyrios Kyrtzidisd84f4222011-02-28 01:28:13 +000087def CallAndMessageChecker : Checker<"CallAndMsg">,
88 HelpText<"Check for errors of call and objc message expressions">,
89 DescFile<"CallAndMessageChecker.cpp">;
90
Argyrios Kyrtzidis139ca962011-02-28 01:28:05 +000091def AdjustedReturnValueChecker : Checker<"AdjustRet">,
92 HelpText<"Check to see if the return value of a function call is different than the caller expects">,
93 DescFile<"AdjustedReturnValueChecker.cpp">;
94
Argyrios Kyrtzidisbd900762011-02-28 01:28:01 +000095def AttrNonNullChecker : Checker<"AttrNonNull">,
96 HelpText<"Check for arguments declared to have nonnull attribute">,
97 DescFile<"AttrNonNullChecker.cpp">;
98
Argyrios Kyrtzidis3ce2b482011-02-28 01:27:54 +000099def VLASizeChecker : Checker<"VLASize">,
100 HelpText<"Check for declarations of VLA of undefined or zero size">,
101 DescFile<"VLASizeChecker.cpp">;
102
Argyrios Kyrtzidis919c9b92011-02-28 01:27:50 +0000103def DivZeroChecker : Checker<"DivZero">,
104 HelpText<"Check for division by zeros">,
105 DescFile<"DivZeroChecker.cpp">;
106
Argyrios Kyrtzidis7f649d72011-02-28 01:27:46 +0000107def ReturnUndefChecker : Checker<"UndefReturn">,
108 HelpText<"Check for undefined or garbage values being returned to the caller">,
109 DescFile<"ReturnUndefChecker.cpp">;
110
Argyrios Kyrtzidiseb290ca2011-02-28 01:27:41 +0000111def UndefinedArraySubscriptChecker : Checker<"UndefArraySubscript">,
112 HelpText<"Check for undefined array subscripts">,
113 DescFile<"UndefinedArraySubscriptChecker.cpp">;
114
Argyrios Kyrtzidis267aa5c2011-02-28 01:27:37 +0000115def UndefinedAssignmentChecker : Checker<"UndefAssign">,
116 HelpText<"Check for assigning undefined values">,
117 DescFile<"UndefinedAssignmentChecker.cpp">;
118
Argyrios Kyrtzidiscc05d512011-02-28 01:27:33 +0000119def UndefBranchChecker : Checker<"UndefBranch">,
120 HelpText<"Check for undefined branch conditions">,
121 DescFile<"UndefBranchChecker.cpp">;
122
Argyrios Kyrtzidis265c6742011-02-28 01:27:26 +0000123def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
124 HelpText<"Check for blocks that capture uninitialized values">,
125 DescFile<"UndefCapturedBlockVarChecker.cpp">;
126
Argyrios Kyrtzidis180e03f2011-02-28 01:27:22 +0000127def UndefResultChecker : Checker<"UndefBinOpResult">,
128 HelpText<"Check for undefined results of non-assignment binary operators">,
129 DescFile<"UndefResultChecker.cpp">;
130
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +0000131def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
132 HelpText<"Evaluate functions that do not return to the caller">,
133 DescFile<"NoReturnFunctionChecker.cpp">;
134
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +0000135def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
136 HelpText<"Evaluate clang builtin functions">,
137 DescFile<"BuiltinFunctionChecker.cpp">;
138
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000139def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000140 HelpText<"Check that addresses to stack memory do not escape the function">,
141 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000142
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +0000143} // end "core"
144
Ted Kremenekade31952011-03-12 06:14:28 +0000145let ParentPackage = DeadCode in {
146
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000147def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000148 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000149 DescFile<"DeadStoresChecker.cpp">;
150
Ted Kremenekade31952011-03-12 06:14:28 +0000151def IdempotentOperationChecker : Checker<"IdempotentOperations">,
152 HelpText<"Warn about idempotent operations">,
153 DescFile<"IdempotentOperationChecker.cpp">;
154
155} // end DeadCode
156
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000157def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000158 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000159 HelpText<"Check calls to various UNIX/Posix functions">,
160 DescFile<"UnixAPIChecker.cpp">;
161
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000162def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000163 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000164 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000165 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000166
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000167def OSAtomicChecker : Checker<"AtomicCAS">,
168 InPackage<MacOSX>,
169 HelpText<"Evaluate calls to OSAtomic functions">,
170 DescFile<"OSAtomicChecker.cpp">;
171
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000172def CFNumberCreateChecker : Checker<"CFNumber">,
173 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000174 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000175 DescFile<"BasicObjCFoundationChecks.cpp">;
176
177def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
178 InPackage<MacOSX>,
179 HelpText<"Check for null arguments to CFRetain/CFRelease">,
180 DescFile<"BasicObjCFoundationChecks.cpp">;
181
Argyrios Kyrtzidisb3d74da2011-02-28 17:36:18 +0000182def CFErrorChecker : Checker<"CFError">,
183 InPackage<MacOSX>,
184 HelpText<"Check usage of CFErrorRef* parameters">,
185 DescFile<"NSErrorChecker.cpp">;
186
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000187def LLVMConventionsChecker : Checker<"Conventions">,
188 InPackage<LLVM>,
189 HelpText<"Check code for LLVM codebase conventions">,
190 DescFile<"LLVMConventionsChecker.cpp">;
191
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000192def LiveVariablesDumper : Checker<"DumpLiveVars">,
193 InPackage<Debug>,
194 HelpText<"Print results of live variable analysis">,
195 DescFile<"DebugCheckers.cpp">;
196
197def CFGViewer : Checker<"ViewCFG">,
198 InPackage<Debug>,
199 HelpText<"View Control-Flow Graphs using GraphViz">,
200 DescFile<"DebugCheckers.cpp">;
201
202def CFGDumper : Checker<"DumpCFG">,
203 InPackage<Debug>,
204 HelpText<"Display Control-Flow Graphs">,
205 DescFile<"DebugCheckers.cpp">;
206
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000207def AnalyzerStatsChecker : Checker<"Stats">,
208 InPackage<Debug>,
209 HelpText<"Emit warnings with analyzer statistics">,
210 DescFile<"AnalyzerStatsChecker.cpp">;
211
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000212//===----------------------------------------------------------------------===//
213// Hidden experimental checkers.
214//===----------------------------------------------------------------------===//
215
216let Group = AllExperimental in {
217
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000218def ArrayBoundCheckerV2 : Checker<"Overflow">,
219 InPackage<CoreExperimental>,
220 HelpText<"Warn about buffer overflows">,
221 DescFile<"ArrayBoundCheckerV2.cpp">,
222 Hidden; // Must be specified explicitly in order to run.
223
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000224def MallocChecker : Checker<"Malloc">,
225 InPackage<CoreExperimental>,
226 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
227 DescFile<"MallocChecker.cpp">;
228
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000229def CStringChecker : Checker<"CString">,
230 InPackage<CoreExperimental>,
231 HelpText<"Check calls to functions in <string.h>">,
232 DescFile<"CStringChecker.cpp">;
233
234def UnreachableCodeChecker : Checker<"UnreachableCode">,
235 InPackage<CoreExperimental>,
236 HelpText<"Check unreachable code">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000237 DescFile<"UnreachableCodeChecker.cpp">,
238 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000239
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000240def CastToStructChecker : Checker<"CastToStruct">,
241 InPackage<CoreExperimental>,
242 HelpText<"Check for cast from non-struct pointer to struct pointer">,
243 DescFile<"CastToStructChecker.cpp">;
244
245def FixedAddressChecker : Checker<"FixedAddr">,
246 InPackage<CoreExperimental>,
247 HelpText<"Check for assignment of a fixed address to a pointer">,
248 DescFile<"FixedAddressChecker.cpp">;
249
250def PointerArithChecker : Checker<"PointerArithm">,
251 InPackage<CoreExperimental>,
252 HelpText<"Check for pointer arithmetic on locations other than array elements">,
253 DescFile<"PointerArithChecker">;
254
255def PointerSubChecker : Checker<"PointerSub">,
256 InPackage<CoreExperimental>,
257 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
258 DescFile<"PointerSubChecker">;
259
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000260def SizeofPointerChecker : Checker<"SizeofPtr">,
261 InPackage<CoreExperimental>,
262 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
263 DescFile<"CheckSizeofPointer.cpp">;
264
265def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
266 InPackage<CoreExperimental>,
267 HelpText<"Perform quick security checks that require no data flow">,
268 DescFile<"CheckSecuritySyntaxOnly.cpp">;
269
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000270def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
271 InPackage<CoreExperimental>,
272 HelpText<"Check for an out-of-bound pointer being returned to callers">,
273 DescFile<"ReturnPointerRangeChecker.cpp">;
274
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000275def ArrayBoundChecker : Checker<"ArrayBound">,
276 InPackage<CoreExperimental>,
277 HelpText<"Check for an out-of-bound pointer being returned to callers">,
278 DescFile<"ArrayBoundChecker.cpp">;
279
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000280def CastSizeChecker : Checker<"CastSize">,
281 InPackage<CoreExperimental>,
282 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
283 DescFile<"CastSizeChecker.cpp">;
284
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000285def ObjCDeallocChecker : Checker<"Dealloc">,
286 InPackage<CocoaExperimental>,
287 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
288 DescFile<"CheckObjCDealloc.cpp">;
289
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000290def ChrootChecker : Checker<"Chroot">,
291 InPackage<UnixExperimental>,
292 HelpText<"Check improper use of chroot">,
293 DescFile<"ChrootChecker.cpp">;
294
295def PthreadLockChecker : Checker<"PthreadLock">,
296 InPackage<UnixExperimental>,
297 HelpText<"Simple lock -> unlock checker">,
298 DescFile<"PthreadLockChecker.cpp">;
299
300def StreamChecker : Checker<"Stream">,
301 InPackage<UnixExperimental>,
302 HelpText<"Check stream handling functions">,
303 DescFile<"StreamChecker.cpp">;
304
Ted Kremenekdd54de82011-03-12 02:49:15 +0000305def IteratorsChecker : Checker<"Iterators">,
306 InPackage<CoreExperimental>,
307 HelpText<"Check improper uses of STL vector iterators">,
308 DescFile<"IteratorsChecker.cpp">;
309
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000310}