← Back to branch summary

~ubuntu-branches/ubuntu/maverick/clamav/maverick-backports

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Stephen Gran, Stephen Gran, Michael Tautschnig
  • Date: 2010-04-26 21:41:18 UTC
  • mfrom: (2.1.6 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100426214118-i6lo606wnh7ywfj6
Tags: 0.96+dfsg-4
http://bugs.debian.org/579271
http://bugs.debian.org/579068
[ Stephen Gran ]
* Fixed typo in clamav-milter's postinst

[ Michael Tautschnig ]
* Fixed typo in clamav-freshclam's postinst (closes: #579271)
* Debconf translation updates
  - Portuguese (closes: #579068)

Show diffs side-by-side

added added

removed removed

Lines of Context:
libclamav/c++/llvm/include/llvm/PassSupport.h
 
1
//===- llvm/PassSupport.h - 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" Passes.  This file
 
11
// 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
// This file defines Pass registration code and classes used for it.
 
18
//
 
19
//===----------------------------------------------------------------------===//
 
20
 
 
21
#ifndef LLVM_PASS_SUPPORT_H
 
22
#define LLVM_PASS_SUPPORT_H
 
23
 
 
24
#include "Pass.h"
 
25
 
 
26
namespace llvm {
 
27
 
 
28
class TargetMachine;
 
29
 
 
30
//===---------------------------------------------------------------------------
 
31
/// PassInfo class - An instance of this class exists for every pass known by
 
32
/// the system, and can be obtained from a live Pass by calling its
 
33
/// getPassInfo() method.  These objects are set up by the RegisterPass<>
 
34
/// template, defined below.
 
35
///
 
36
class PassInfo {
 
37
public:
 
38
  typedef Pass* (*NormalCtor_t)();
 
39
 
 
40
private:
 
41
  const char      *const PassName;     // Nice name for Pass
 
42
  const char      *const PassArgument; // Command Line argument to run this pass
 
43
  const intptr_t  PassID;      
 
44
  const bool IsCFGOnlyPass;            // Pass only looks at the CFG.
 
45
  const bool IsAnalysis;               // True if an analysis pass.
 
46
  const bool IsAnalysisGroup;          // True if an analysis group.
 
47
  std::vector<const PassInfo*> ItfImpl;// Interfaces implemented by this pass
 
48
 
 
49
  NormalCtor_t NormalCtor;
 
50
 
 
51
public:
 
52
  /// PassInfo ctor - Do not call this directly, this should only be invoked
 
53
  /// through RegisterPass.
 
54
  PassInfo(const char *name, const char *arg, intptr_t pi,
 
55
           NormalCtor_t normal = 0,
 
56
           bool isCFGOnly = false, bool is_analysis = false)
 
57
    : PassName(name), PassArgument(arg), PassID(pi), 
 
58
      IsCFGOnlyPass(isCFGOnly), 
 
59
      IsAnalysis(is_analysis), IsAnalysisGroup(false), NormalCtor(normal) {
 
60
    registerPass();
 
61
  }
 
62
  /// PassInfo ctor - Do not call this directly, this should only be invoked
 
63
  /// through RegisterPass. This version is for use by analysis groups; it
 
64
  /// does not auto-register the pass.
 
65
  PassInfo(const char *name, intptr_t pi)
 
66
    : PassName(name), PassArgument(""), PassID(pi), 
 
67
      IsCFGOnlyPass(false), 
 
68
      IsAnalysis(false), IsAnalysisGroup(true), NormalCtor(0) {
 
69
  }
 
70
 
 
71
  /// getPassName - Return the friendly name for the pass, never returns null
 
72
  ///
 
73
  const char *getPassName() const { return PassName; }
 
74
 
 
75
  /// getPassArgument - Return the command line option that may be passed to
 
76
  /// 'opt' that will cause this pass to be run.  This will return null if there
 
77
  /// is no argument.
 
78
  ///
 
79
  const char *getPassArgument() const { return PassArgument; }
 
80
 
 
81
  /// getTypeInfo - Return the id object for the pass...
 
82
  /// TODO : Rename
 
83
  intptr_t getTypeInfo() const { return PassID; }
 
84
 
 
85
  /// Return true if this PassID implements the specified ID pointer.
 
86
  bool isPassID(void *IDPtr) const {
 
87
    return PassID == (intptr_t)IDPtr;
 
88
  }
 
89
  
 
90
  /// isAnalysisGroup - Return true if this is an analysis group, not a normal
 
91
  /// pass.
 
92
  ///
 
93
  bool isAnalysisGroup() const { return IsAnalysisGroup; }
 
94
  bool isAnalysis() const { return IsAnalysis; }
 
95
 
 
96
  /// isCFGOnlyPass - return true if this pass only looks at the CFG for the
 
97
  /// function.
 
98
  bool isCFGOnlyPass() const { return IsCFGOnlyPass; }
 
99
  
 
100
  /// getNormalCtor - Return a pointer to a function, that when called, creates
 
101
  /// an instance of the pass and returns it.  This pointer may be null if there
 
102
  /// is no default constructor for the pass.
 
103
  ///
 
104
  NormalCtor_t getNormalCtor() const {
 
105
    return NormalCtor;
 
106
  }
 
107
  void setNormalCtor(NormalCtor_t Ctor) {
 
108
    NormalCtor = Ctor;
 
109
  }
 
110
 
 
111
  /// createPass() - Use this method to create an instance of this pass.
 
112
  Pass *createPass() const {
 
113
    assert((!isAnalysisGroup() || NormalCtor) &&
 
114
           "No default implementation found for analysis group!");
 
115
    assert(NormalCtor &&
 
116
           "Cannot call createPass on PassInfo without default ctor!");
 
117
    return NormalCtor();
 
118
  }
 
119
 
 
120
  /// addInterfaceImplemented - This method is called when this pass is
 
121
  /// registered as a member of an analysis group with the RegisterAnalysisGroup
 
122
  /// template.
 
123
  ///
 
124
  void addInterfaceImplemented(const PassInfo *ItfPI) {
 
125
    ItfImpl.push_back(ItfPI);
 
126
  }
 
127
 
 
128
  /// getInterfacesImplemented - Return a list of all of the analysis group
 
129
  /// interfaces implemented by this pass.
 
130
  ///
 
131
  const std::vector<const PassInfo*> &getInterfacesImplemented() const {
 
132
    return ItfImpl;
 
133
  }
 
134
 
 
135
protected:
 
136
  void registerPass();
 
137
  void unregisterPass();
 
138
 
 
139
private:
 
140
  void operator=(const PassInfo &); // do not implement
 
141
  PassInfo(const PassInfo &);       // do not implement
 
142
};
 
143
 
 
144
 
 
145
template<typename PassName>
 
146
Pass *callDefaultCtor() { return new PassName(); }
 
147
 
 
148
//===---------------------------------------------------------------------------
 
149
/// RegisterPass<t> template - This template class is used to notify the system
 
150
/// that a Pass is available for use, and registers it into the internal
 
151
/// database maintained by the PassManager.  Unless this template is used, opt,
 
152
/// for example will not be able to see the pass and attempts to create the pass
 
153
/// will fail. This template is used in the follow manner (at global scope, in
 
154
/// your .cpp file):
 
155
///
 
156
/// static RegisterPass<YourPassClassName> tmp("passopt", "My Pass Name");
 
157
///
 
158
/// This statement will cause your pass to be created by calling the default
 
159
/// constructor exposed by the pass.  If you have a different constructor that
 
160
/// must be called, create a global constructor function (which takes the
 
161
/// arguments you need and returns a Pass*) and register your pass like this:
 
162
///
 
163
/// static RegisterPass<PassClassName> tmp("passopt", "My Name");
 
164
///
 
165
template<typename passName>
 
166
struct RegisterPass : public PassInfo {
 
167
 
 
168
  // Register Pass using default constructor...
 
169
  RegisterPass(const char *PassArg, const char *Name, bool CFGOnly = false,
 
170
               bool is_analysis = false)
 
171
    : PassInfo(Name, PassArg, intptr_t(&passName::ID),
 
172
               PassInfo::NormalCtor_t(callDefaultCtor<passName>),
 
173
               CFGOnly, is_analysis) {
 
174
  }
 
175
};
 
176
 
 
177
 
 
178
/// RegisterAnalysisGroup - Register a Pass as a member of an analysis _group_.
 
179
/// Analysis groups are used to define an interface (which need not derive from
 
180
/// Pass) that is required by passes to do their job.  Analysis Groups differ
 
181
/// from normal analyses because any available implementation of the group will
 
182
/// be used if it is available.
 
183
///
 
184
/// If no analysis implementing the interface is available, a default
 
185
/// implementation is created and added.  A pass registers itself as the default
 
186
/// implementation by specifying 'true' as the second template argument of this
 
187
/// class.
 
188
///
 
189
/// In addition to registering itself as an analysis group member, a pass must
 
190
/// register itself normally as well.  Passes may be members of multiple groups
 
191
/// and may still be "required" specifically by name.
 
192
///
 
193
/// The actual interface may also be registered as well (by not specifying the
 
194
/// second template argument).  The interface should be registered to associate
 
195
/// a nice name with the interface.
 
196
///
 
197
class RegisterAGBase : public PassInfo {
 
198
protected:
 
199
  RegisterAGBase(const char *Name,
 
200
                 intptr_t InterfaceID,
 
201
                 intptr_t PassID = 0,
 
202
                 bool isDefault = false);
 
203
};
 
204
 
 
205
template<typename Interface, bool Default = false>
 
206
struct RegisterAnalysisGroup : public RegisterAGBase {
 
207
  explicit RegisterAnalysisGroup(PassInfo &RPB)
 
208
    : RegisterAGBase(RPB.getPassName(),
 
209
                     intptr_t(&Interface::ID), RPB.getTypeInfo(),
 
210
                     Default) {
 
211
  }
 
212
 
 
213
  explicit RegisterAnalysisGroup(const char *Name)
 
214
    : RegisterAGBase(Name, intptr_t(&Interface::ID)) {
 
215
  }
 
216
};
 
217
 
 
218
 
 
219
 
 
220
//===---------------------------------------------------------------------------
 
221
/// PassRegistrationListener class - This class is meant to be derived from by
 
222
/// clients that are interested in which passes get registered and unregistered
 
223
/// at runtime (which can be because of the RegisterPass constructors being run
 
224
/// as the program starts up, or may be because a shared object just got
 
225
/// loaded).  Deriving from the PassRegistationListener class automatically
 
226
/// registers your object to receive callbacks indicating when passes are loaded
 
227
/// and removed.
 
228
///
 
229
struct PassRegistrationListener {
 
230
 
 
231
  /// PassRegistrationListener ctor - Add the current object to the list of
 
232
  /// PassRegistrationListeners...
 
233
  PassRegistrationListener();
 
234
 
 
235
  /// dtor - Remove object from list of listeners...
 
236
  ///
 
237
  virtual ~PassRegistrationListener();
 
238
 
 
239
  /// Callback functions - These functions are invoked whenever a pass is loaded
 
240
  /// or removed from the current executable.
 
241
  ///
 
242
  virtual void passRegistered(const PassInfo *) {}
 
243
 
 
244
  /// enumeratePasses - Iterate over the registered passes, calling the
 
245
  /// passEnumerate callback on each PassInfo object.
 
246
  ///
 
247
  void enumeratePasses();
 
248
 
 
249
  /// passEnumerate - Callback function invoked when someone calls
 
250
  /// enumeratePasses on this PassRegistrationListener object.
 
251
  ///
 
252
  virtual void passEnumerate(const PassInfo *) {}
 
253
};
 
254
 
 
255
 
 
256
} // End llvm namespace
 
257
 
 
258
#endif