blob: db81af06807aa57fd508ef28bdaccfbb10d0c8c5 [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
78def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
79 HelpText<"Evaluate clang builtin functions">,
80 DescFile<"BuiltinFunctionChecker.cpp">;
81
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000082def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000083 HelpText<"Check that addresses to stack memory do not escape the function">,
84 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000085
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000086def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000087 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000088 DescFile<"DeadStoresChecker.cpp">;
89
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +000090} // end "core"
91
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +000092def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000093 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000094 HelpText<"Check calls to various UNIX/Posix functions">,
95 DescFile<"UnixAPIChecker.cpp">;
96
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +000097def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000098 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000099 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000100 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000101
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000102def OSAtomicChecker : Checker<"AtomicCAS">,
103 InPackage<MacOSX>,
104 HelpText<"Evaluate calls to OSAtomic functions">,
105 DescFile<"OSAtomicChecker.cpp">;
106
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000107def CFNumberCreateChecker : Checker<"CFNumber">,
108 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000109 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000110 DescFile<"BasicObjCFoundationChecks.cpp">;
111
112def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
113 InPackage<MacOSX>,
114 HelpText<"Check for null arguments to CFRetain/CFRelease">,
115 DescFile<"BasicObjCFoundationChecks.cpp">;
116
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000117def LLVMConventionsChecker : Checker<"Conventions">,
118 InPackage<LLVM>,
119 HelpText<"Check code for LLVM codebase conventions">,
120 DescFile<"LLVMConventionsChecker.cpp">;
121
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000122def LiveVariablesDumper : Checker<"DumpLiveVars">,
123 InPackage<Debug>,
124 HelpText<"Print results of live variable analysis">,
125 DescFile<"DebugCheckers.cpp">;
126
127def CFGViewer : Checker<"ViewCFG">,
128 InPackage<Debug>,
129 HelpText<"View Control-Flow Graphs using GraphViz">,
130 DescFile<"DebugCheckers.cpp">;
131
132def CFGDumper : Checker<"DumpCFG">,
133 InPackage<Debug>,
134 HelpText<"Display Control-Flow Graphs">,
135 DescFile<"DebugCheckers.cpp">;
136
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000137def AnalyzerStatsChecker : Checker<"Stats">,
138 InPackage<Debug>,
139 HelpText<"Emit warnings with analyzer statistics">,
140 DescFile<"AnalyzerStatsChecker.cpp">;
141
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000142//===----------------------------------------------------------------------===//
143// Hidden experimental checkers.
144//===----------------------------------------------------------------------===//
145
146let Group = AllExperimental in {
147
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000148def ArrayBoundCheckerV2 : Checker<"Overflow">,
149 InPackage<CoreExperimental>,
150 HelpText<"Warn about buffer overflows">,
151 DescFile<"ArrayBoundCheckerV2.cpp">,
152 Hidden; // Must be specified explicitly in order to run.
153
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000154def MallocChecker : Checker<"Malloc">,
155 InPackage<CoreExperimental>,
156 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
157 DescFile<"MallocChecker.cpp">;
158
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000159def CStringChecker : Checker<"CString">,
160 InPackage<CoreExperimental>,
161 HelpText<"Check calls to functions in <string.h>">,
162 DescFile<"CStringChecker.cpp">;
163
164def UnreachableCodeChecker : Checker<"UnreachableCode">,
165 InPackage<CoreExperimental>,
166 HelpText<"Check unreachable code">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000167 DescFile<"UnreachableCodeChecker.cpp">,
168 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000169
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000170def IdempotentOperationChecker : Checker<"IdempotentOps">,
171 InPackage<CoreExperimental>,
172 HelpText<"Warn about idempotent operations">,
173 DescFile<"IdempotentOperationChecker.cpp">;
174
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000175def CastToStructChecker : Checker<"CastToStruct">,
176 InPackage<CoreExperimental>,
177 HelpText<"Check for cast from non-struct pointer to struct pointer">,
178 DescFile<"CastToStructChecker.cpp">;
179
180def FixedAddressChecker : Checker<"FixedAddr">,
181 InPackage<CoreExperimental>,
182 HelpText<"Check for assignment of a fixed address to a pointer">,
183 DescFile<"FixedAddressChecker.cpp">;
184
185def PointerArithChecker : Checker<"PointerArithm">,
186 InPackage<CoreExperimental>,
187 HelpText<"Check for pointer arithmetic on locations other than array elements">,
188 DescFile<"PointerArithChecker">;
189
190def PointerSubChecker : Checker<"PointerSub">,
191 InPackage<CoreExperimental>,
192 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
193 DescFile<"PointerSubChecker">;
194
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000195def SizeofPointerChecker : Checker<"SizeofPtr">,
196 InPackage<CoreExperimental>,
197 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
198 DescFile<"CheckSizeofPointer.cpp">;
199
200def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
201 InPackage<CoreExperimental>,
202 HelpText<"Perform quick security checks that require no data flow">,
203 DescFile<"CheckSecuritySyntaxOnly.cpp">;
204
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000205def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
206 InPackage<CoreExperimental>,
207 HelpText<"Check for an out-of-bound pointer being returned to callers">,
208 DescFile<"ReturnPointerRangeChecker.cpp">;
209
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000210def ArrayBoundChecker : Checker<"ArrayBound">,
211 InPackage<CoreExperimental>,
212 HelpText<"Check for an out-of-bound pointer being returned to callers">,
213 DescFile<"ArrayBoundChecker.cpp">;
214
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000215def CastSizeChecker : Checker<"CastSize">,
216 InPackage<CoreExperimental>,
217 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
218 DescFile<"CastSizeChecker.cpp">;
219
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000220def ObjCDeallocChecker : Checker<"Dealloc">,
221 InPackage<CocoaExperimental>,
222 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
223 DescFile<"CheckObjCDealloc.cpp">;
224
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000225def ChrootChecker : Checker<"Chroot">,
226 InPackage<UnixExperimental>,
227 HelpText<"Check improper use of chroot">,
228 DescFile<"ChrootChecker.cpp">;
229
230def PthreadLockChecker : Checker<"PthreadLock">,
231 InPackage<UnixExperimental>,
232 HelpText<"Simple lock -> unlock checker">,
233 DescFile<"PthreadLockChecker.cpp">;
234
235def StreamChecker : Checker<"Stream">,
236 InPackage<UnixExperimental>,
237 HelpText<"Check stream handling functions">,
238 DescFile<"StreamChecker.cpp">;
239
240}