blob: 6599b96b003038ce192d760bd49c1203dd272489 [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 Kyrtzidis265c6742011-02-28 01:27:26 +000078def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
79 HelpText<"Check for blocks that capture uninitialized values">,
80 DescFile<"UndefCapturedBlockVarChecker.cpp">;
81
Argyrios Kyrtzidis180e03f2011-02-28 01:27:22 +000082def UndefResultChecker : Checker<"UndefBinOpResult">,
83 HelpText<"Check for undefined results of non-assignment binary operators">,
84 DescFile<"UndefResultChecker.cpp">;
85
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +000086def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
87 HelpText<"Evaluate functions that do not return to the caller">,
88 DescFile<"NoReturnFunctionChecker.cpp">;
89
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +000090def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
91 HelpText<"Evaluate clang builtin functions">,
92 DescFile<"BuiltinFunctionChecker.cpp">;
93
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000094def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000095 HelpText<"Check that addresses to stack memory do not escape the function">,
96 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000097
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +000098} // end "core"
99
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000100def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000101 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000102 DescFile<"DeadStoresChecker.cpp">;
103
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000104def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000105 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000106 HelpText<"Check calls to various UNIX/Posix functions">,
107 DescFile<"UnixAPIChecker.cpp">;
108
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000109def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000110 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000111 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000112 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000113
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000114def OSAtomicChecker : Checker<"AtomicCAS">,
115 InPackage<MacOSX>,
116 HelpText<"Evaluate calls to OSAtomic functions">,
117 DescFile<"OSAtomicChecker.cpp">;
118
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000119def CFNumberCreateChecker : Checker<"CFNumber">,
120 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000121 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000122 DescFile<"BasicObjCFoundationChecks.cpp">;
123
124def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
125 InPackage<MacOSX>,
126 HelpText<"Check for null arguments to CFRetain/CFRelease">,
127 DescFile<"BasicObjCFoundationChecks.cpp">;
128
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000129def LLVMConventionsChecker : Checker<"Conventions">,
130 InPackage<LLVM>,
131 HelpText<"Check code for LLVM codebase conventions">,
132 DescFile<"LLVMConventionsChecker.cpp">;
133
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000134def LiveVariablesDumper : Checker<"DumpLiveVars">,
135 InPackage<Debug>,
136 HelpText<"Print results of live variable analysis">,
137 DescFile<"DebugCheckers.cpp">;
138
139def CFGViewer : Checker<"ViewCFG">,
140 InPackage<Debug>,
141 HelpText<"View Control-Flow Graphs using GraphViz">,
142 DescFile<"DebugCheckers.cpp">;
143
144def CFGDumper : Checker<"DumpCFG">,
145 InPackage<Debug>,
146 HelpText<"Display Control-Flow Graphs">,
147 DescFile<"DebugCheckers.cpp">;
148
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000149def AnalyzerStatsChecker : Checker<"Stats">,
150 InPackage<Debug>,
151 HelpText<"Emit warnings with analyzer statistics">,
152 DescFile<"AnalyzerStatsChecker.cpp">;
153
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000154//===----------------------------------------------------------------------===//
155// Hidden experimental checkers.
156//===----------------------------------------------------------------------===//
157
158let Group = AllExperimental in {
159
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000160def ArrayBoundCheckerV2 : Checker<"Overflow">,
161 InPackage<CoreExperimental>,
162 HelpText<"Warn about buffer overflows">,
163 DescFile<"ArrayBoundCheckerV2.cpp">,
164 Hidden; // Must be specified explicitly in order to run.
165
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000166def MallocChecker : Checker<"Malloc">,
167 InPackage<CoreExperimental>,
168 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
169 DescFile<"MallocChecker.cpp">;
170
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000171def CStringChecker : Checker<"CString">,
172 InPackage<CoreExperimental>,
173 HelpText<"Check calls to functions in <string.h>">,
174 DescFile<"CStringChecker.cpp">;
175
176def UnreachableCodeChecker : Checker<"UnreachableCode">,
177 InPackage<CoreExperimental>,
178 HelpText<"Check unreachable code">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000179 DescFile<"UnreachableCodeChecker.cpp">,
180 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000181
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000182def IdempotentOperationChecker : Checker<"IdempotentOps">,
183 InPackage<CoreExperimental>,
184 HelpText<"Warn about idempotent operations">,
185 DescFile<"IdempotentOperationChecker.cpp">;
186
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000187def CastToStructChecker : Checker<"CastToStruct">,
188 InPackage<CoreExperimental>,
189 HelpText<"Check for cast from non-struct pointer to struct pointer">,
190 DescFile<"CastToStructChecker.cpp">;
191
192def FixedAddressChecker : Checker<"FixedAddr">,
193 InPackage<CoreExperimental>,
194 HelpText<"Check for assignment of a fixed address to a pointer">,
195 DescFile<"FixedAddressChecker.cpp">;
196
197def PointerArithChecker : Checker<"PointerArithm">,
198 InPackage<CoreExperimental>,
199 HelpText<"Check for pointer arithmetic on locations other than array elements">,
200 DescFile<"PointerArithChecker">;
201
202def PointerSubChecker : Checker<"PointerSub">,
203 InPackage<CoreExperimental>,
204 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
205 DescFile<"PointerSubChecker">;
206
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000207def SizeofPointerChecker : Checker<"SizeofPtr">,
208 InPackage<CoreExperimental>,
209 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
210 DescFile<"CheckSizeofPointer.cpp">;
211
212def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
213 InPackage<CoreExperimental>,
214 HelpText<"Perform quick security checks that require no data flow">,
215 DescFile<"CheckSecuritySyntaxOnly.cpp">;
216
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000217def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
218 InPackage<CoreExperimental>,
219 HelpText<"Check for an out-of-bound pointer being returned to callers">,
220 DescFile<"ReturnPointerRangeChecker.cpp">;
221
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000222def ArrayBoundChecker : Checker<"ArrayBound">,
223 InPackage<CoreExperimental>,
224 HelpText<"Check for an out-of-bound pointer being returned to callers">,
225 DescFile<"ArrayBoundChecker.cpp">;
226
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000227def CastSizeChecker : Checker<"CastSize">,
228 InPackage<CoreExperimental>,
229 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
230 DescFile<"CastSizeChecker.cpp">;
231
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000232def ObjCDeallocChecker : Checker<"Dealloc">,
233 InPackage<CocoaExperimental>,
234 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
235 DescFile<"CheckObjCDealloc.cpp">;
236
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000237def ChrootChecker : Checker<"Chroot">,
238 InPackage<UnixExperimental>,
239 HelpText<"Check improper use of chroot">,
240 DescFile<"ChrootChecker.cpp">;
241
242def PthreadLockChecker : Checker<"PthreadLock">,
243 InPackage<UnixExperimental>,
244 HelpText<"Simple lock -> unlock checker">,
245 DescFile<"PthreadLockChecker.cpp">;
246
247def StreamChecker : Checker<"Stream">,
248 InPackage<UnixExperimental>,
249 HelpText<"Check stream handling functions">,
250 DescFile<"StreamChecker.cpp">;
251
252}