~louis/ubuntu/trusty/clamav/lp799623_fix_logrotate

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Scott Kitterman
  • Date: 2010-03-12 11:30:04 UTC
  • mfrom: (0.41.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20100312113004-b0fop4bkycszdd0z
Tags: 0.96~rc1+dfsg-0ubuntu1
* New upstream RC - FFE (LP: #537636):
  - Add OfficialDatabaseOnly option to clamav-base.postinst.in
  - Add LocalSocketGroup option to clamav-base.postinst.in
  - Add LocalSocketMode option to clamav-base.postinst.in
  - Add CrossFilesystems option to clamav-base.postinst.in
  - Add ClamukoScannerCount option to clamav-base.postinst.in
  - Add BytecodeSecurity opiton to clamav-base.postinst.in
  - Add DetectionStatsHostID option to clamav-freshclam.postinst.in
  - Add Bytecode option to clamav-freshclam.postinst.in
  - Add MilterSocketGroup option to clamav-milter.postinst.in
  - Add MilterSocketMode option to clamav-milter.postinst.in
  - Add ReportHostname option to clamav-milter.postinst.in
  - Bump libclamav SO version to 6.1.0 in libclamav6.install
  - Drop clamdmon from clamav.examples (no longer shipped by upstream)
  - Drop libclamav.a from libclamav-dev.install (not built by upstream)
  - Update SO version for lintian override for libclamav6
  - Add new Bytecode Testing Tool, usr/bin/clambc, to clamav.install
  - Add build-depends on python and python-setuptools for new test suite
  - Update debian/copyright for the embedded copy of llvm (using the system
    llvm is not currently feasible)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
//===-- llvm/Constant.h - Constant class definition -------------*- 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 contains the declaration of the Constant class.
 
11
//
 
12
//===----------------------------------------------------------------------===//
 
13
 
 
14
#ifndef LLVM_CONSTANT_H
 
15
#define LLVM_CONSTANT_H
 
16
 
 
17
#include "llvm/User.h"
 
18
 
 
19
namespace llvm {
 
20
  class APInt;
 
21
 
 
22
  template<typename T> class SmallVectorImpl;
 
23
  class LLVMContext;
 
24
 
 
25
/// This is an important base class in LLVM. It provides the common facilities
 
26
/// of all constant values in an LLVM program. A constant is a value that is
 
27
/// immutable at runtime. Functions are constants because their address is
 
28
/// immutable. Same with global variables. 
 
29
/// 
 
30
/// All constants share the capabilities provided in this class. All constants
 
31
/// can have a null value. They can have an operand list. Constants can be
 
32
/// simple (integer and floating point values), complex (arrays and structures),
 
33
/// or expression based (computations yielding a constant value composed of 
 
34
/// only certain operators and other constant values).
 
35
/// 
 
36
/// Note that Constants are immutable (once created they never change) 
 
37
/// and are fully shared by structural equivalence.  This means that two 
 
38
/// structurally equivalent constants will always have the same address.  
 
39
/// Constants are created on demand as needed and never deleted: thus clients 
 
40
/// don't have to worry about the lifetime of the objects.
 
41
/// @brief LLVM Constant Representation
 
42
class Constant : public User {
 
43
  void operator=(const Constant &);     // Do not implement
 
44
  Constant(const Constant &);           // Do not implement
 
45
  
 
46
protected:
 
47
  Constant(const Type *ty, ValueTy vty, Use *Ops, unsigned NumOps)
 
48
    : User(ty, vty, Ops, NumOps) {}
 
49
 
 
50
  void destroyConstantImpl();
 
51
  
 
52
  void setOperand(unsigned i, Value *V) {
 
53
    User::setOperand(i, V);
 
54
  }
 
55
public:
 
56
  /// isNullValue - Return true if this is the value that would be returned by
 
57
  /// getNullValue.
 
58
  virtual bool isNullValue() const = 0;
 
59
 
 
60
  /// isNegativeZeroValue - Return true if the value is what would be returned 
 
61
  /// by getZeroValueForNegation.
 
62
  virtual bool isNegativeZeroValue() const { return isNullValue(); }
 
63
 
 
64
  /// canTrap - Return true if evaluation of this constant could trap.  This is
 
65
  /// true for things like constant expressions that could divide by zero.
 
66
  bool canTrap() const;
 
67
 
 
68
  /// isConstantUsed - Return true if the constant has users other than constant
 
69
  /// exprs and other dangling things.
 
70
  bool isConstantUsed() const;
 
71
  
 
72
  enum PossibleRelocationsTy {
 
73
    NoRelocation = 0,
 
74
    LocalRelocation = 1,
 
75
    GlobalRelocations = 2
 
76
  };
 
77
  
 
78
  /// getRelocationInfo - This method classifies the entry according to
 
79
  /// whether or not it may generate a relocation entry.  This must be
 
80
  /// conservative, so if it might codegen to a relocatable entry, it should say
 
81
  /// so.  The return values are:
 
82
  /// 
 
83
  ///  NoRelocation: This constant pool entry is guaranteed to never have a
 
84
  ///     relocation applied to it (because it holds a simple constant like
 
85
  ///     '4').
 
86
  ///  LocalRelocation: This entry has relocations, but the entries are
 
87
  ///     guaranteed to be resolvable by the static linker, so the dynamic
 
88
  ///     linker will never see them.
 
89
  ///  GlobalRelocations: This entry may have arbitrary relocations.
 
90
  ///
 
91
  /// FIXME: This really should not be in VMCore.
 
92
  PossibleRelocationsTy getRelocationInfo() const;
 
93
  
 
94
  // Specialize get/setOperand for Users as their operands are always
 
95
  // constants or BasicBlocks as well.
 
96
  User *getOperand(unsigned i) {
 
97
    return static_cast<User*>(User::getOperand(i));
 
98
  }
 
99
  const User *getOperand(unsigned i) const {
 
100
    return static_cast<const User*>(User::getOperand(i));
 
101
  }
 
102
  
 
103
  /// getVectorElements - This method, which is only valid on constant of vector
 
104
  /// type, returns the elements of the vector in the specified smallvector.
 
105
  /// This handles breaking down a vector undef into undef elements, etc.  For
 
106
  /// constant exprs and other cases we can't handle, we return an empty vector.
 
107
  void getVectorElements(SmallVectorImpl<Constant*> &Elts) const;
 
108
 
 
109
  /// destroyConstant - Called if some element of this constant is no longer
 
110
  /// valid.  At this point only other constants may be on the use_list for this
 
111
  /// constant.  Any constants on our Use list must also be destroy'd.  The
 
112
  /// implementation must be sure to remove the constant from the list of
 
113
  /// available cached constants.  Implementations should call
 
114
  /// destroyConstantImpl as the last thing they do, to destroy all users and
 
115
  /// delete this.
 
116
  virtual void destroyConstant() { assert(0 && "Not reached!"); }
 
117
 
 
118
  //// Methods for support type inquiry through isa, cast, and dyn_cast:
 
119
  static inline bool classof(const Constant *) { return true; }
 
120
  static inline bool classof(const GlobalValue *) { return true; }
 
121
  static inline bool classof(const Value *V) {
 
122
    return V->getValueID() >= ConstantFirstVal &&
 
123
           V->getValueID() <= ConstantLastVal;
 
124
  }
 
125
 
 
126
  /// replaceUsesOfWithOnConstant - This method is a special form of
 
127
  /// User::replaceUsesOfWith (which does not work on constants) that does work
 
128
  /// on constants.  Basically this method goes through the trouble of building
 
129
  /// a new constant that is equivalent to the current one, with all uses of
 
130
  /// From replaced with uses of To.  After this construction is completed, all
 
131
  /// of the users of 'this' are replaced to use the new constant, and then
 
132
  /// 'this' is deleted.  In general, you should not call this method, instead,
 
133
  /// use Value::replaceAllUsesWith, which automatically dispatches to this
 
134
  /// method as needed.
 
135
  ///
 
136
  virtual void replaceUsesOfWithOnConstant(Value *, Value *, Use *) {
 
137
    // Provide a default implementation for constants (like integers) that
 
138
    // cannot use any other values.  This cannot be called at runtime, but needs
 
139
    // to be here to avoid link errors.
 
140
    assert(getNumOperands() == 0 && "replaceUsesOfWithOnConstant must be "
 
141
           "implemented for all constants that have operands!");
 
142
    assert(0 && "Constants that do not have operands cannot be using 'From'!");
 
143
  }
 
144
  
 
145
  static Constant* getNullValue(const Type* Ty);
 
146
  
 
147
  /// @returns the value for an integer constant of the given type that has all
 
148
  /// its bits set to true.
 
149
  /// @brief Get the all ones value
 
150
  static Constant* getAllOnesValue(const Type* Ty);
 
151
 
 
152
  /// getIntegerValue - Return the value for an integer or pointer constant,
 
153
  /// or a vector thereof, with the given scalar value.
 
154
  static Constant* getIntegerValue(const Type* Ty, const APInt &V);
 
155
};
 
156
 
 
157
} // End llvm namespace
 
158
 
 
159
#endif