Checkers.td revision d84f422ebfde2145bce79a8fa823e3393b392994 
1//===--- 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
12//===----------------------------------------------------------------------===//
13// Packages.
14//===----------------------------------------------------------------------===//
15
16def Core : Package<"core">;
17def Cocoa : Package<"cocoa">;
18def Unix : Package<"unix">;
19def MacOSX : Package<"macosx">;
20
21def CoreExperimental : Package<"experimental">,
22  InPackage<Core>, Hidden;
23
24def CocoaExperimental : Package<"experimental">,
25  InPackage<Cocoa>, Hidden;
26
27def UnixExperimental : Package<"experimental">,
28  InPackage<Unix>, Hidden;
29
30def LLVM : Package<"llvm">;
31def Debug : Package<"debug">;
32
33//===----------------------------------------------------------------------===//
34// Groups.
35//===----------------------------------------------------------------------===//
36
37def AllExperimental : CheckerGroup<"all-experimental">,
38  Hidden;
39
40//===----------------------------------------------------------------------===//
41// Checkers.
42//===----------------------------------------------------------------------===//
43
44let ParentPackage = Cocoa in {
45
46def ObjCSelfInitChecker : Checker<"SelfInit">,
47  HelpText<"Check that 'self' is propely initialized inside an initializer method">,
48  DescFile<"ObjCSelfInitChecker.cpp">;
49
50def ObjCAtSyncChecker : Checker<"AtSync">,
51  HelpText<"Check for null pointers used as mutexes for @synchronized">,
52  DescFile<"ObjCAtSyncChecker.cpp">;
53
54def 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
62def NSAutoreleasePoolChecker : Checker<"NSAutoreleasePool">,
63  HelpText<"Warn for subpar uses of NSAutoreleasePool">,
64  DescFile<"NSAutoreleasePoolChecker.cpp">;
65
66def 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
74} // end "cocoa"
75
76let ParentPackage = Core in {
77
78def CallAndMessageChecker : Checker<"CallAndMsg">,
79  HelpText<"Check for errors of call and objc message expressions">,
80  DescFile<"CallAndMessageChecker.cpp">;
81
82def AdjustedReturnValueChecker : Checker<"AdjustRet">,
83  HelpText<"Check to see if the return value of a function call is different than the caller expects">,
84  DescFile<"AdjustedReturnValueChecker.cpp">;
85
86def AttrNonNullChecker : Checker<"AttrNonNull">,
87  HelpText<"Check for arguments declared to have nonnull attribute">,
88  DescFile<"AttrNonNullChecker.cpp">;
89
90def VLASizeChecker : Checker<"VLASize">,
91  HelpText<"Check for declarations of VLA of undefined or zero size">,
92  DescFile<"VLASizeChecker.cpp">;
93
94def DivZeroChecker : Checker<"DivZero">,
95  HelpText<"Check for division by zeros">,
96  DescFile<"DivZeroChecker.cpp">;
97
98def ReturnUndefChecker : Checker<"UndefReturn">,
99  HelpText<"Check for undefined or garbage values being returned to the caller">,
100  DescFile<"ReturnUndefChecker.cpp">;
101
102def UndefinedArraySubscriptChecker : Checker<"UndefArraySubscript">,
103  HelpText<"Check for undefined array subscripts">,
104  DescFile<"UndefinedArraySubscriptChecker.cpp">;
105
106def UndefinedAssignmentChecker : Checker<"UndefAssign">,
107  HelpText<"Check for assigning undefined values">,
108  DescFile<"UndefinedAssignmentChecker.cpp">;
109
110def UndefBranchChecker : Checker<"UndefBranch">,
111  HelpText<"Check for undefined branch conditions">,
112  DescFile<"UndefBranchChecker.cpp">;
113
114def UndefCapturedBlockVarChecker : Checker<"UndefBlockVar">,
115  HelpText<"Check for blocks that capture uninitialized values">,
116  DescFile<"UndefCapturedBlockVarChecker.cpp">;
117
118def UndefResultChecker : Checker<"UndefBinOpResult">,
119  HelpText<"Check for undefined results of non-assignment binary operators">,
120  DescFile<"UndefResultChecker.cpp">;
121
122def NoReturnFunctionChecker : Checker<"NoReturnFunc">,
123  HelpText<"Evaluate functions that do not return to the caller">,
124  DescFile<"NoReturnFunctionChecker.cpp">;
125
126def BuiltinFunctionChecker : Checker<"BuiltinFunc">,
127  HelpText<"Evaluate clang builtin functions">,
128  DescFile<"BuiltinFunctionChecker.cpp">;
129
130def StackAddrEscapeChecker : Checker<"StackAddrEscape">,
131  HelpText<"Check that addresses to stack memory do not escape the function">,
132  DescFile<"StackAddrEscapeChecker.cpp">;
133
134} // end "core"
135
136def DeadStoresChecker : Checker<"DeadStores">,
137  HelpText<"Check for values stored to a variables that are never read afterwards">,
138  DescFile<"DeadStoresChecker.cpp">;
139
140def UnixAPIChecker : Checker<"API">,
141  InPackage<Unix>,
142  HelpText<"Check calls to various UNIX/Posix functions">,
143  DescFile<"UnixAPIChecker.cpp">;
144
145def MacOSXAPIChecker : Checker<"API">,
146  InPackage<MacOSX>,
147  HelpText<"Check for proper uses of various Mac OS X APIs">,
148  DescFile<"MacOSXAPIChecker.cpp">;
149
150def OSAtomicChecker : Checker<"AtomicCAS">,
151  InPackage<MacOSX>,
152  HelpText<"Evaluate calls to OSAtomic functions">,
153  DescFile<"OSAtomicChecker.cpp">;
154
155def CFNumberCreateChecker : Checker<"CFNumber">,
156  InPackage<MacOSX>,
157  HelpText<"Check for proper uses of CFNumberCreate">,
158  DescFile<"BasicObjCFoundationChecks.cpp">;
159
160def CFRetainReleaseChecker : Checker<"CFRetainRelease">,
161  InPackage<MacOSX>,
162  HelpText<"Check for null arguments to CFRetain/CFRelease">,
163  DescFile<"BasicObjCFoundationChecks.cpp">;
164
165def LLVMConventionsChecker : Checker<"Conventions">,
166  InPackage<LLVM>,
167  HelpText<"Check code for LLVM codebase conventions">,
168  DescFile<"LLVMConventionsChecker.cpp">;
169
170def LiveVariablesDumper : Checker<"DumpLiveVars">,
171  InPackage<Debug>,
172  HelpText<"Print results of live variable analysis">,
173  DescFile<"DebugCheckers.cpp">;
174
175def CFGViewer : Checker<"ViewCFG">,
176  InPackage<Debug>,
177  HelpText<"View Control-Flow Graphs using GraphViz">,
178  DescFile<"DebugCheckers.cpp">;
179
180def CFGDumper : Checker<"DumpCFG">,
181  InPackage<Debug>,
182  HelpText<"Display Control-Flow Graphs">,
183  DescFile<"DebugCheckers.cpp">;
184
185def AnalyzerStatsChecker : Checker<"Stats">,
186  InPackage<Debug>,
187  HelpText<"Emit warnings with analyzer statistics">,
188  DescFile<"AnalyzerStatsChecker.cpp">;
189
190//===----------------------------------------------------------------------===//
191// Hidden experimental checkers.
192//===----------------------------------------------------------------------===//
193
194let Group = AllExperimental in {
195
196def ArrayBoundCheckerV2 : Checker<"Overflow">,
197  InPackage<CoreExperimental>,
198  HelpText<"Warn about buffer overflows">,
199  DescFile<"ArrayBoundCheckerV2.cpp">,
200  Hidden; // Must be specified explicitly in order to run.
201
202def MallocChecker : Checker<"Malloc">,
203  InPackage<CoreExperimental>,
204  HelpText<"Check for potential memory leaks, double free, and use-after-free problems">,
205  DescFile<"MallocChecker.cpp">;
206
207def CStringChecker : Checker<"CString">,
208  InPackage<CoreExperimental>,
209  HelpText<"Check calls to functions in <string.h>">,
210  DescFile<"CStringChecker.cpp">;
211
212def UnreachableCodeChecker : Checker<"UnreachableCode">,
213  InPackage<CoreExperimental>,
214  HelpText<"Check unreachable code">,
215  DescFile<"UnreachableCodeChecker.cpp">,
216  Hidden; // Must be specified explicitly in order to run.
217
218def IdempotentOperationChecker : Checker<"IdempotentOps">,
219  InPackage<CoreExperimental>,
220  HelpText<"Warn about idempotent operations">,
221  DescFile<"IdempotentOperationChecker.cpp">;
222
223def CastToStructChecker : Checker<"CastToStruct">,
224  InPackage<CoreExperimental>,
225  HelpText<"Check for cast from non-struct pointer to struct pointer">,
226  DescFile<"CastToStructChecker.cpp">;
227
228def FixedAddressChecker : Checker<"FixedAddr">,
229  InPackage<CoreExperimental>,
230  HelpText<"Check for assignment of a fixed address to a pointer">,
231  DescFile<"FixedAddressChecker.cpp">;
232
233def PointerArithChecker : Checker<"PointerArithm">,
234  InPackage<CoreExperimental>,
235  HelpText<"Check for pointer arithmetic on locations other than array elements">,
236  DescFile<"PointerArithChecker">;
237
238def PointerSubChecker : Checker<"PointerSub">,
239  InPackage<CoreExperimental>,
240  HelpText<"Check for pointer subtractions on two pointers pointing to different memory chunks">,
241  DescFile<"PointerSubChecker">;
242
243def SizeofPointerChecker : Checker<"SizeofPtr">,
244  InPackage<CoreExperimental>,
245  HelpText<"Warn about unintended use of sizeof() on pointer expressions">,
246  DescFile<"CheckSizeofPointer.cpp">;
247
248def SecuritySyntaxChecker : Checker<"SecuritySyntactic">,
249  InPackage<CoreExperimental>,
250  HelpText<"Perform quick security checks that require no data flow">,
251  DescFile<"CheckSecuritySyntaxOnly.cpp">;
252
253def ReturnPointerRangeChecker : Checker<"ReturnPtrRange">,
254  InPackage<CoreExperimental>,
255  HelpText<"Check for an out-of-bound pointer being returned to callers">,
256  DescFile<"ReturnPointerRangeChecker.cpp">;
257
258def ArrayBoundChecker : Checker<"ArrayBound">,
259  InPackage<CoreExperimental>,
260  HelpText<"Check for an out-of-bound pointer being returned to callers">,
261  DescFile<"ArrayBoundChecker.cpp">;
262
263def CastSizeChecker : Checker<"CastSize">,
264  InPackage<CoreExperimental>,
265  HelpText<"Check when casting a malloc'ed type T, whether the size is a multiple of the size of T">,
266  DescFile<"CastSizeChecker.cpp">;
267
268def ObjCDeallocChecker : Checker<"Dealloc">,
269  InPackage<CocoaExperimental>,
270  HelpText<"Warn about Objective-C classes that lack a correct implementation of -dealloc">,
271  DescFile<"CheckObjCDealloc.cpp">;
272
273def ChrootChecker : Checker<"Chroot">,
274  InPackage<UnixExperimental>,
275  HelpText<"Check improper use of chroot">,
276  DescFile<"ChrootChecker.cpp">;
277
278def PthreadLockChecker : Checker<"PthreadLock">,
279  InPackage<UnixExperimental>,
280  HelpText<"Simple lock -> unlock checker">,
281  DescFile<"PthreadLockChecker.cpp">;
282
283def StreamChecker : Checker<"Stream">,
284  InPackage<UnixExperimental>,
285  HelpText<"Check stream handling functions">,
286  DescFile<"StreamChecker.cpp">;
287
288}
289