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