Fix a ton of comment typos found by codespell. Patch by
[oota-llvm.git] / include / llvm / Analysis / Passes.h
1 //===-- llvm/Analysis/Passes.h - Constructors for analyses ------*- C++ -*-===//
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 //
10 // This header file defines prototypes for accessor functions that expose passes
11 // in the analysis libraries.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_ANALYSIS_PASSES_H
16 #define LLVM_ANALYSIS_PASSES_H
17
18 namespace llvm {
19   class FunctionPass;
20   class ImmutablePass;
21   class LoopPass;
22   class ModulePass;
23   class Pass;
24   class PassInfo;
25   class LibCallInfo;
26
27   //===--------------------------------------------------------------------===//
28   //
29   // createGlobalsModRefPass - This pass provides alias and mod/ref info for
30   // global values that do not have their addresses taken.
31   //
32   Pass *createGlobalsModRefPass();
33
34   //===--------------------------------------------------------------------===//
35   //
36   // createAliasDebugger - This pass helps debug clients of AA
37   //
38   Pass *createAliasDebugger();
39
40   //===--------------------------------------------------------------------===//
41   //
42   // createAliasAnalysisCounterPass - This pass counts alias queries and how the
43   // alias analysis implementation responds.
44   //
45   ModulePass *createAliasAnalysisCounterPass();
46
47   //===--------------------------------------------------------------------===//
48   //
49   // createAAEvalPass - This pass implements a simple N^2 alias analysis
50   // accuracy evaluator.
51   //
52   FunctionPass *createAAEvalPass();
53
54   //===--------------------------------------------------------------------===//
55   //
56   // createNoAAPass - This pass implements a "I don't know" alias analysis.
57   //
58   ImmutablePass *createNoAAPass();
59
60   //===--------------------------------------------------------------------===//
61   //
62   // createBasicAliasAnalysisPass - This pass implements the stateless alias
63   // analysis.
64   //
65   ImmutablePass *createBasicAliasAnalysisPass();
66
67   //===--------------------------------------------------------------------===//
68   //
69   /// createLibCallAliasAnalysisPass - Create an alias analysis pass that knows
70   /// about the semantics of a set of libcalls specified by LCI.  The newly
71   /// constructed pass takes ownership of the pointer that is provided.
72   ///
73   FunctionPass *createLibCallAliasAnalysisPass(LibCallInfo *LCI);
74
75   //===--------------------------------------------------------------------===//
76   //
77   // createScalarEvolutionAliasAnalysisPass - This pass implements a simple
78   // alias analysis using ScalarEvolution queries.
79   //
80   FunctionPass *createScalarEvolutionAliasAnalysisPass();
81
82   //===--------------------------------------------------------------------===//
83   //
84   // createTypeBasedAliasAnalysisPass - This pass implements metadata-based
85   // type-based alias analysis.
86   //
87   ImmutablePass *createTypeBasedAliasAnalysisPass();
88
89   //===--------------------------------------------------------------------===//
90   //
91   // createProfileLoaderPass - This pass loads information from a profile dump
92   // file.
93   //
94   ModulePass *createProfileLoaderPass();
95   extern char &ProfileLoaderPassID;
96
97   //===--------------------------------------------------------------------===//
98   //
99   // createNoProfileInfoPass - This pass implements the default "no profile".
100   //
101   ImmutablePass *createNoProfileInfoPass();
102
103   //===--------------------------------------------------------------------===//
104   //
105   // createProfileEstimatorPass - This pass estimates profiling information
106   // instead of loading it from a previous run.
107   //
108   FunctionPass *createProfileEstimatorPass();
109   extern char &ProfileEstimatorPassID;
110
111   //===--------------------------------------------------------------------===//
112   //
113   // createProfileVerifierPass - This pass verifies profiling information.
114   //
115   FunctionPass *createProfileVerifierPass();
116
117   //===--------------------------------------------------------------------===//
118   //
119   // createPathProfileLoaderPass - This pass loads information from a path
120   // profile dump file.
121   //
122   ModulePass *createPathProfileLoaderPass();
123   extern char &PathProfileLoaderPassID;
124
125   //===--------------------------------------------------------------------===//
126   //
127   // createNoPathProfileInfoPass - This pass implements the default
128   // "no path profile".
129   //
130   ImmutablePass *createNoPathProfileInfoPass();
131
132   //===--------------------------------------------------------------------===//
133   //
134   // createPathProfileVerifierPass - This pass verifies path profiling
135   // information.
136   //
137   ModulePass *createPathProfileVerifierPass();
138
139   //===--------------------------------------------------------------------===//
140   //
141   // createDSAAPass - This pass implements simple context sensitive alias
142   // analysis.
143   //
144   ModulePass *createDSAAPass();
145
146   //===--------------------------------------------------------------------===//
147   //
148   // createDSOptPass - This pass uses DSA to do a series of simple
149   // optimizations.
150   //
151   ModulePass *createDSOptPass();
152
153   //===--------------------------------------------------------------------===//
154   //
155   // createSteensgaardPass - This pass uses the data structure graphs to do a
156   // simple context insensitive alias analysis.
157   //
158   ModulePass *createSteensgaardPass();
159
160   //===--------------------------------------------------------------------===//
161   //
162   /// createLazyValueInfoPass - This creates an instance of the LazyValueInfo
163   /// pass.
164   FunctionPass *createLazyValueInfoPass();
165
166   //===--------------------------------------------------------------------===//
167   //
168   // createLoopDependenceAnalysisPass - This creates an instance of the
169   // LoopDependenceAnalysis pass.
170   //
171   LoopPass *createLoopDependenceAnalysisPass();
172
173   // Minor pass prototypes, allowing us to expose them through bugpoint and
174   // analyze.
175   FunctionPass *createInstCountPass();
176
177   // print debug info intrinsics in human readable form
178   FunctionPass *createDbgInfoPrinterPass();
179
180   //===--------------------------------------------------------------------===//
181   //
182   // createRegionInfoPass - This pass finds all single entry single exit regions
183   // in a function and builds the region hierarchy.
184   //
185   FunctionPass *createRegionInfoPass();
186
187   // Print module-level debug info metadata in human-readable form.
188   ModulePass *createModuleDebugInfoPrinterPass();
189
190   //===--------------------------------------------------------------------===//
191   //
192   // createMemDepPrinter - This pass exhaustively collects all memdep
193   // information and prints it with -analyze.
194   //
195   FunctionPass *createMemDepPrinter();
196 }
197
198 #endif