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