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