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