blob: 7438a640568d7c8be40add185da4b8e1ebfb554a [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 Kyrtzidis180e03f2011-02-28 01:27:22 +000078def UndefResultChecker : Checker<"UndefBinOpResult">,
79 HelpText<"Check for undefined results of non-assignment binary operators">,
80 DescFile<"UndefResultChecker.cpp">;
81
Argyrios Kyrtzidis3267d952011-02-28 01:27:17 +000082def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
83 HelpText<"Evaluate functions that do not return to the caller">,
84 DescFile<"NoReturnFunctionChecker.cpp">;
85
Argyrios Kyrtzidis10348702011-02-28 01:27:07 +000086def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
87 HelpText<"Evaluate clang builtin functions">,
88 DescFile<"BuiltinFunctionChecker.cpp">;
89
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000090def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000091 HelpText<"Check that addresses to stack memory do not escape the function">,
92 DescFile<"StackAddrEscapeChecker.cpp">;
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +000093
Argyrios Kyrtzidisa676d502011-02-28 01:27:12 +000094} // end "core"
95
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000096def DeadStoresChecker : Checker<"DeadStores">,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +000097 HelpText<"Check for values stored to a variables that are never read afterwards">,
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +000098 DescFile<"DeadStoresChecker.cpp">;
99
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000100def UnixAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000101 InPackage<Unix>,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000102 HelpText<"Check calls to various UNIX/Posix functions">,
103 DescFile<"UnixAPIChecker.cpp">;
104
Argyrios Kyrtzidis26c05b12011-02-15 07:42:38 +0000105def MacOSXAPIChecker : Checker<"API">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000106 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000107 HelpText<"Check for proper uses of various Mac OS X APIs">,
Argyrios Kyrtzidis027a6ab2011-02-15 07:42:33 +0000108 DescFile<"MacOSXAPIChecker.cpp">;
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000109
Argyrios Kyrtzidisf0293662011-02-28 01:27:02 +0000110def OSAtomicChecker : Checker<"AtomicCAS">,
111 InPackage<MacOSX>,
112 HelpText<"Evaluate calls to OSAtomic functions">,
113 DescFile<"OSAtomicChecker.cpp">;
114
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000115def CFNumberCreateChecker : Checker<"CFNumber">,
116 InPackage<MacOSX>,
Ted Kremenekf5d2ef42011-02-25 22:00:43 +0000117 HelpText<"Check for proper uses of CFNumberCreate">,
Argyrios Kyrtzidis0b1ba622011-02-16 01:40:52 +0000118 DescFile<"BasicObjCFoundationChecks.cpp">;
119
120def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
121 InPackage<MacOSX>,
122 HelpText<"Check for null arguments to CFRetain/CFRelease">,
123 DescFile<"BasicObjCFoundationChecks.cpp">;
124
Argyrios Kyrtzidis9fb94742011-02-17 21:39:24 +0000125def LLVMConventionsChecker : Checker<"Conventions">,
126 InPackage<LLVM>,
127 HelpText<"Check code for LLVM codebase conventions">,
128 DescFile<"LLVMConventionsChecker.cpp">;
129
Argyrios Kyrtzidis2d67b902011-02-17 21:39:39 +0000130def LiveVariablesDumper : Checker<"DumpLiveVars">,
131 InPackage<Debug>,
132 HelpText<"Print results of live variable analysis">,
133 DescFile<"DebugCheckers.cpp">;
134
135def CFGViewer : Checker<"ViewCFG">,
136 InPackage<Debug>,
137 HelpText<"View Control-Flow Graphs using GraphViz">,
138 DescFile<"DebugCheckers.cpp">;
139
140def CFGDumper : Checker<"DumpCFG">,
141 InPackage<Debug>,
142 HelpText<"Display Control-Flow Graphs">,
143 DescFile<"DebugCheckers.cpp">;
144
Argyrios Kyrtzidis58f2e7c2011-02-28 01:26:50 +0000145def AnalyzerStatsChecker : Checker<"Stats">,
146 InPackage<Debug>,
147 HelpText<"Emit warnings with analyzer statistics">,
148 DescFile<"AnalyzerStatsChecker.cpp">;
149
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000150//===----------------------------------------------------------------------===//
151// Hidden experimental checkers.
152//===----------------------------------------------------------------------===//
153
154let Group = AllExperimental in {
155
Argyrios Kyrtzidis05357012011-02-28 01:26:57 +0000156def ArrayBoundCheckerV2 : Checker<"Overflow">,
157 InPackage<CoreExperimental>,
158 HelpText<"Warn about buffer overflows">,
159 DescFile<"ArrayBoundCheckerV2.cpp">,
160 Hidden; // Must be specified explicitly in order to run.
161
Argyrios Kyrtzidis312dbec2011-02-28 01:26:35 +0000162def MallocChecker : Checker<"Malloc">,
163 InPackage<CoreExperimental>,
164 HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
165 DescFile<"MallocChecker.cpp">;
166
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000167def CStringChecker : Checker<"CString">,
168 InPackage<CoreExperimental>,
169 HelpText<"Check calls to functions in <string.h>">,
170 DescFile<"CStringChecker.cpp">;
171
172def UnreachableCodeChecker : Checker<"UnreachableCode">,
173 InPackage<CoreExperimental>,
174 HelpText<"Check unreachable code">,
Argyrios Kyrtzidis08099ad2011-02-24 21:42:52 +0000175 DescFile<"UnreachableCodeChecker.cpp">,
176 Hidden; // Must be specified explicitly in order to run.
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000177
Argyrios Kyrtzidisc9f2e0f2011-02-15 22:55:14 +0000178def IdempotentOperationChecker : Checker<"IdempotentOps">,
179 InPackage<CoreExperimental>,
180 HelpText<"Warn about idempotent operations">,
181 DescFile<"IdempotentOperationChecker.cpp">;
182
Argyrios Kyrtzidis23ade502011-02-15 22:55:20 +0000183def CastToStructChecker : Checker<"CastToStruct">,
184 InPackage<CoreExperimental>,
185 HelpText<"Check for cast from non-struct pointer to struct pointer">,
186 DescFile<"CastToStructChecker.cpp">;
187
188def FixedAddressChecker : Checker<"FixedAddr">,
189 InPackage<CoreExperimental>,
190 HelpText<"Check for assignment of a fixed address to a pointer">,
191 DescFile<"FixedAddressChecker.cpp">;
192
193def PointerArithChecker : Checker<"PointerArithm">,
194 InPackage<CoreExperimental>,
195 HelpText<"Check for pointer arithmetic on locations other than array elements">,
196 DescFile<"PointerArithChecker">;
197
198def PointerSubChecker : Checker<"PointerSub">,
199 InPackage<CoreExperimental>,
200 HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
201 DescFile<"PointerSubChecker">;
202
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000203def SizeofPointerChecker : Checker<"SizeofPtr">,
204 InPackage<CoreExperimental>,
205 HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
206 DescFile<"CheckSizeofPointer.cpp">;
207
208def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
209 InPackage<CoreExperimental>,
210 HelpText<"Perform quick security checks that require no data flow">,
211 DescFile<"CheckSecuritySyntaxOnly.cpp">;
212
Argyrios Kyrtzidis69355792011-02-24 08:41:57 +0000213def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
214 InPackage<CoreExperimental>,
215 HelpText<"Check for an out-of-bound pointer being returned to callers">,
216 DescFile<"ReturnPointerRangeChecker.cpp">;
217
Argyrios Kyrtzidis8be5b3a2011-02-24 08:42:12 +0000218def ArrayBoundChecker : Checker<"ArrayBound">,
219 InPackage<CoreExperimental>,
220 HelpText<"Check for an out-of-bound pointer being returned to callers">,
221 DescFile<"ArrayBoundChecker.cpp">;
222
Argyrios Kyrtzidis0d6b0c02011-02-24 21:42:49 +0000223def CastSizeChecker : Checker<"CastSize">,
224 InPackage<CoreExperimental>,
225 HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
226 DescFile<"CastSizeChecker.cpp">;
227
Argyrios Kyrtzidis7dd445e2011-02-17 21:39:33 +0000228def ObjCDeallocChecker : Checker<"Dealloc">,
229 InPackage<CocoaExperimental>,
230 HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
231 DescFile<"CheckObjCDealloc.cpp">;
232
Argyrios Kyrtzidisa0decc92011-02-15 21:25:03 +0000233def ChrootChecker : Checker<"Chroot">,
234 InPackage<UnixExperimental>,
235 HelpText<"Check improper use of chroot">,
236 DescFile<"ChrootChecker.cpp">;
237
238def PthreadLockChecker : Checker<"PthreadLock">,
239 InPackage<UnixExperimental>,
240 HelpText<"Simple lock -> unlock checker">,
241 DescFile<"PthreadLockChecker.cpp">;
242
243def StreamChecker : Checker<"Stream">,
244 InPackage<UnixExperimental>,
245 HelpText<"Check stream handling functions">,
246 DescFile<"StreamChecker.cpp">;
247
248}