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