← Back to branch summary

~ubuntu-branches/ubuntu/feisty/clamav/feisty

« back to all changes in this revision

Viewing changes to libclamav/c++/llvm/include/llvm/PassAnalysisSupport.h

  • Committer: Bazaar Package Importer
  • Author(s): Kees Cook
  • Date: 2007-02-20 10:33:44 UTC
  • mto: This revision was merged to the branch mainline in revision 16.
  • Revision ID: james.westby@ubuntu.com-20070220103344-zgcu2psnx9d98fpa
Tags: upstream-0.90
Import upstream version 0.90

Show diffs side-by-side

added added

removed removed

Lines of Context:
libclamav/c++/llvm/include/llvm/PassAnalysisSupport.h
1
 
//===- llvm/PassAnalysisSupport.h - Analysis Pass Support code --*- 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 file defines stuff that is used to define and "use" Analysis Passes.
11
 
// This file is automatically #included by Pass.h, so:
12
 
//
13
 
//           NO .CPP FILES SHOULD INCLUDE THIS FILE DIRECTLY
14
 
//
15
 
// Instead, #include Pass.h
16
 
//
17
 
//===----------------------------------------------------------------------===//
18
 
 
19
 
#ifndef LLVM_PASS_ANALYSIS_SUPPORT_H
20
 
#define LLVM_PASS_ANALYSIS_SUPPORT_H
21
 
 
22
 
#include "llvm/ADT/SmallVector.h"
23
 
#include "llvm/ADT/StringRef.h"
24
 
#include <vector>
25
 
 
26
 
namespace llvm {
27
 
 
28
 
//===----------------------------------------------------------------------===//
29
 
// AnalysisUsage - Represent the analysis usage information of a pass.  This
30
 
// tracks analyses that the pass REQUIRES (must be available when the pass
31
 
// runs), REQUIRES TRANSITIVE (must be available throughout the lifetime of the
32
 
// pass), and analyses that the pass PRESERVES (the pass does not invalidate the
33
 
// results of these analyses).  This information is provided by a pass to the
34
 
// Pass infrastructure through the getAnalysisUsage virtual function.
35
 
//
36
 
class AnalysisUsage {
37
 
public:
38
 
  typedef SmallVector<AnalysisID, 32> VectorType;
39
 
 
40
 
private:
41
 
  // Sets of analyses required and preserved by a pass
42
 
  VectorType Required, RequiredTransitive, Preserved;
43
 
  bool PreservesAll;
44
 
 
45
 
public:
46
 
  AnalysisUsage() : PreservesAll(false) {}
47
 
 
48
 
  // addRequired - Add the specified ID to the required set of the usage info
49
 
  // for a pass.
50
 
  //
51
 
  AnalysisUsage &addRequiredID(const void *ID);
52
 
  AnalysisUsage &addRequiredID(char &ID);
53
 
  template<class PassClass>
54
 
  AnalysisUsage &addRequired() {
55
 
    return addRequiredID(PassClass::ID);
56
 
  }
57
 
 
58
 
  AnalysisUsage &addRequiredTransitiveID(char &ID);
59
 
  template<class PassClass>
60
 
  AnalysisUsage &addRequiredTransitive() {
61
 
    return addRequiredTransitiveID(PassClass::ID);
62
 
  }
63
 
 
64
 
  // addPreserved - Add the specified ID to the set of analyses preserved by
65
 
  // this pass
66
 
  //
67
 
  AnalysisUsage &addPreservedID(const void *ID) {
68
 
    Preserved.push_back(ID);
69
 
    return *this;
70
 
  }
71
 
  AnalysisUsage &addPreservedID(char &ID) {
72
 
    Preserved.push_back(&ID);
73
 
    return *this;
74
 
  }
75
 
 
76
 
  // addPreserved - Add the specified Pass class to the set of analyses
77
 
  // preserved by this pass.
78
 
  //
79
 
  template<class PassClass>
80
 
  AnalysisUsage &addPreserved() {
81
 
    Preserved.push_back(&PassClass::ID);
82
 
    return *this;
83
 
  }
84
 
 
85
 
  // addPreserved - Add the Pass with the specified argument string to the set
86
 
  // of analyses preserved by this pass. If no such Pass exists, do nothing.
87
 
  // This can be useful when a pass is trivially preserved, but may not be
88
 
  // linked in. Be careful about spelling!
89
 
  //
90
 
  AnalysisUsage &addPreserved(StringRef Arg);
91
 
 
92
 
  // setPreservesAll - Set by analyses that do not transform their input at all
93
 
  void setPreservesAll() { PreservesAll = true; }
94
 
  bool getPreservesAll() const { return PreservesAll; }
95
 
 
96
 
  /// setPreservesCFG - This function should be called by the pass, iff they do
97
 
  /// not:
98
 
  ///
99
 
  ///  1. Add or remove basic blocks from the function
100
 
  ///  2. Modify terminator instructions in any way.
101
 
  ///
102
 
  /// This function annotates the AnalysisUsage info object to say that analyses
103
 
  /// that only depend on the CFG are preserved by this pass.
104
 
  ///
105
 
  void setPreservesCFG();
106
 
 
107
 
  const VectorType &getRequiredSet() const { return Required; }
108
 
  const VectorType &getRequiredTransitiveSet() const {
109
 
    return RequiredTransitive;
110
 
  }
111
 
  const VectorType &getPreservedSet() const { return Preserved; }
112
 
};
113
 
 
114
 
//===----------------------------------------------------------------------===//
115
 
// AnalysisResolver - Simple interface used by Pass objects to pull all
116
 
// analysis information out of pass manager that is responsible to manage
117
 
// the pass.
118
 
//
119
 
class PMDataManager;
120
 
class AnalysisResolver {
121
 
private:
122
 
  AnalysisResolver();  // DO NOT IMPLEMENT
123
 
 
124
 
public:
125
 
  explicit AnalysisResolver(PMDataManager &P) : PM(P) { }
126
 
  
127
 
  inline PMDataManager &getPMDataManager() { return PM; }
128
 
 
129
 
  // Find pass that is implementing PI.
130
 
  Pass *findImplPass(AnalysisID PI) {
131
 
    Pass *ResultPass = 0;
132
 
    for (unsigned i = 0; i < AnalysisImpls.size() ; ++i) {
133
 
      if (AnalysisImpls[i].first == PI) {
134
 
        ResultPass = AnalysisImpls[i].second;
135
 
        break;
136
 
      }
137
 
    }
138
 
    return ResultPass;
139
 
  }
140
 
 
141
 
  // Find pass that is implementing PI. Initialize pass for Function F.
142
 
  Pass *findImplPass(Pass *P, AnalysisID PI, Function &F);
143
 
 
144
 
  void addAnalysisImplsPair(AnalysisID PI, Pass *P) {
145
 
    std::pair<AnalysisID, Pass*> pir = std::make_pair(PI,P);
146
 
    AnalysisImpls.push_back(pir);
147
 
  }
148
 
 
149
 
  /// clearAnalysisImpls - Clear cache that is used to connect a pass to the
150
 
  /// the analysis (PassInfo).
151
 
  void clearAnalysisImpls() {
152
 
    AnalysisImpls.clear();
153
 
  }
154
 
 
155
 
  // getAnalysisIfAvailable - Return analysis result or null if it doesn't exist
156
 
  Pass *getAnalysisIfAvailable(AnalysisID ID, bool Direction) const;
157
 
 
158
 
private:
159
 
  // AnalysisImpls - This keeps track of which passes implements the interfaces
160
 
  // that are required by the current pass (to implement getAnalysis()).
161
 
  std::vector<std::pair<AnalysisID, Pass*> > AnalysisImpls;
162
 
 
163
 
  // PassManager that is used to resolve analysis info
164
 
  PMDataManager &PM;
165
 
};
166
 
 
167
 
/// getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to
168
 
/// get analysis information that might be around, for example to update it.
169
 
/// This is different than getAnalysis in that it can fail (if the analysis
170
 
/// results haven't been computed), so should only be used if you can handle
171
 
/// the case when the analysis is not available.  This method is often used by
172
 
/// transformation APIs to update analysis results for a pass automatically as
173
 
/// the transform is performed.
174
 
///
175
 
template<typename AnalysisType>
176
 
AnalysisType *Pass::getAnalysisIfAvailable() const {
177
 
  assert(Resolver && "Pass not resident in a PassManager object!");
178
 
 
179
 
  const void *PI = &AnalysisType::ID;
180
 
 
181
 
  Pass *ResultPass = Resolver->getAnalysisIfAvailable(PI, true);
182
 
  if (ResultPass == 0) return 0;
183
 
 
184
 
  // Because the AnalysisType may not be a subclass of pass (for
185
 
  // AnalysisGroups), we use getAdjustedAnalysisPointer here to potentially
186
 
  // adjust the return pointer (because the class may multiply inherit, once
187
 
  // from pass, once from AnalysisType).
188
 
  return (AnalysisType*)ResultPass->getAdjustedAnalysisPointer(PI);
189
 
}
190
 
 
191
 
/// getAnalysis<AnalysisType>() - This function is used by subclasses to get
192
 
/// to the analysis information that they claim to use by overriding the
193
 
/// getAnalysisUsage function.
194
 
///
195
 
template<typename AnalysisType>
196
 
AnalysisType &Pass::getAnalysis() const {
197
 
  assert(Resolver && "Pass has not been inserted into a PassManager object!");
198
 
  return getAnalysisID<AnalysisType>(&AnalysisType::ID);
199
 
}
200
 
 
201
 
template<typename AnalysisType>
202
 
AnalysisType &Pass::getAnalysisID(AnalysisID PI) const {
203
 
  assert(PI && "getAnalysis for unregistered pass!");
204
 
  assert(Resolver&&"Pass has not been inserted into a PassManager object!");
205
 
  // PI *must* appear in AnalysisImpls.  Because the number of passes used
206
 
  // should be a small number, we just do a linear search over a (dense)
207
 
  // vector.
208
 
  Pass *ResultPass = Resolver->findImplPass(PI);
209
 
  assert (ResultPass && 
210
 
          "getAnalysis*() called on an analysis that was not "
211
 
          "'required' by pass!");
212
 
 
213
 
  // Because the AnalysisType may not be a subclass of pass (for
214
 
  // AnalysisGroups), we use getAdjustedAnalysisPointer here to potentially
215
 
  // adjust the return pointer (because the class may multiply inherit, once
216
 
  // from pass, once from AnalysisType).
217
 
  return *(AnalysisType*)ResultPass->getAdjustedAnalysisPointer(PI);
218
 
}
219
 
 
220
 
/// getAnalysis<AnalysisType>() - This function is used by subclasses to get
221
 
/// to the analysis information that they claim to use by overriding the
222
 
/// getAnalysisUsage function.
223
 
///
224
 
template<typename AnalysisType>
225
 
AnalysisType &Pass::getAnalysis(Function &F) {
226
 
  assert(Resolver &&"Pass has not been inserted into a PassManager object!");
227
 
 
228
 
  return getAnalysisID<AnalysisType>(&AnalysisType::ID, F);
229
 
}
230
 
 
231
 
template<typename AnalysisType>
232
 
AnalysisType &Pass::getAnalysisID(AnalysisID PI, Function &F) {
233
 
  assert(PI && "getAnalysis for unregistered pass!");
234
 
  assert(Resolver && "Pass has not been inserted into a PassManager object!");
235
 
  // PI *must* appear in AnalysisImpls.  Because the number of passes used
236
 
  // should be a small number, we just do a linear search over a (dense)
237
 
  // vector.
238
 
  Pass *ResultPass = Resolver->findImplPass(this, PI, F);
239
 
  assert(ResultPass && "Unable to find requested analysis info");
240
 
  
241
 
  // Because the AnalysisType may not be a subclass of pass (for
242
 
  // AnalysisGroups), we use getAdjustedAnalysisPointer here to potentially
243
 
  // adjust the return pointer (because the class may multiply inherit, once
244
 
  // from pass, once from AnalysisType).
245
 
  return *(AnalysisType*)ResultPass->getAdjustedAnalysisPointer(PI);
246
 
}
247
 
 
248
 
} // End llvm namespace
249
 
 
250
 
#endif