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