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