1 //===-- llvm/Operator.h - Operator utility subclass -------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines various classes for working with Instructions and
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_OPERATOR_H
16 #define LLVM_OPERATOR_H
18 #include "llvm/Instruction.h"
19 #include "llvm/Constants.h"
23 class GetElementPtrInst;
27 /// Operator - This is a utility class that provides an abstraction for the
28 /// common functionality between Instructions and ConstantExprs.
30 class Operator : public User {
32 // Do not implement any of these. The Operator class is intended to be used
33 // as a utility, and is never itself instantiated.
34 void *operator new(size_t, unsigned);
35 void *operator new(size_t s);
40 /// getOpcode - Return the opcode for this Instruction or ConstantExpr.
42 unsigned getOpcode() const {
43 if (const Instruction *I = dyn_cast<Instruction>(this))
44 return I->getOpcode();
45 return cast<ConstantExpr>(this)->getOpcode();
48 /// getOpcode - If V is an Instruction or ConstantExpr, return its
49 /// opcode. Otherwise return UserOp1.
51 static unsigned getOpcode(const Value *V) {
52 if (const Instruction *I = dyn_cast<Instruction>(V))
53 return I->getOpcode();
54 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
55 return CE->getOpcode();
56 return Instruction::UserOp1;
59 static inline bool classof(const Operator *) { return true; }
60 static inline bool classof(const Instruction *) { return true; }
61 static inline bool classof(const ConstantExpr *) { return true; }
62 static inline bool classof(const Value *V) {
63 return isa<Instruction>(V) || isa<ConstantExpr>(V);
67 /// OverflowingBinaryOperator - Utility class for integer arithmetic operators
68 /// which may exhibit overflow - Add, Sub, and Mul. It does not include SDiv,
69 /// despite that operator having the potential for overflow.
71 class OverflowingBinaryOperator : public Operator {
74 NoUnsignedWrap = (1 << 0),
75 NoSignedWrap = (1 << 1)
79 ~OverflowingBinaryOperator(); // do not implement
81 friend class BinaryOperator;
82 friend class ConstantExpr;
83 void setHasNoUnsignedWrap(bool B) {
84 SubclassOptionalData =
85 (SubclassOptionalData & ~NoUnsignedWrap) | (B * NoUnsignedWrap);
87 void setHasNoSignedWrap(bool B) {
88 SubclassOptionalData =
89 (SubclassOptionalData & ~NoSignedWrap) | (B * NoSignedWrap);
93 /// hasNoUnsignedWrap - Test whether this operation is known to never
94 /// undergo unsigned overflow, aka the nuw property.
95 bool hasNoUnsignedWrap() const {
96 return SubclassOptionalData & NoUnsignedWrap;
99 /// hasNoSignedWrap - Test whether this operation is known to never
100 /// undergo signed overflow, aka the nsw property.
101 bool hasNoSignedWrap() const {
102 return (SubclassOptionalData & NoSignedWrap) != 0;
105 static inline bool classof(const OverflowingBinaryOperator *) { return true; }
106 static inline bool classof(const Instruction *I) {
107 return I->getOpcode() == Instruction::Add ||
108 I->getOpcode() == Instruction::Sub ||
109 I->getOpcode() == Instruction::Mul;
111 static inline bool classof(const ConstantExpr *CE) {
112 return CE->getOpcode() == Instruction::Add ||
113 CE->getOpcode() == Instruction::Sub ||
114 CE->getOpcode() == Instruction::Mul;
116 static inline bool classof(const Value *V) {
117 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
118 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
122 /// AddOperator - Utility class for integer addition operators.
124 class AddOperator : public OverflowingBinaryOperator {
125 ~AddOperator(); // do not implement
127 static inline bool classof(const AddOperator *) { return true; }
128 static inline bool classof(const Instruction *I) {
129 return I->getOpcode() == Instruction::Add;
131 static inline bool classof(const ConstantExpr *CE) {
132 return CE->getOpcode() == Instruction::Add;
134 static inline bool classof(const Value *V) {
135 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
136 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
140 /// SubOperator - Utility class for integer subtraction operators.
142 class SubOperator : public OverflowingBinaryOperator {
143 ~SubOperator(); // do not implement
145 static inline bool classof(const SubOperator *) { return true; }
146 static inline bool classof(const Instruction *I) {
147 return I->getOpcode() == Instruction::Sub;
149 static inline bool classof(const ConstantExpr *CE) {
150 return CE->getOpcode() == Instruction::Sub;
152 static inline bool classof(const Value *V) {
153 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
154 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
158 /// MulOperator - Utility class for integer multiplication operators.
160 class MulOperator : public OverflowingBinaryOperator {
161 ~MulOperator(); // do not implement
163 static inline bool classof(const MulOperator *) { return true; }
164 static inline bool classof(const Instruction *I) {
165 return I->getOpcode() == Instruction::Mul;
167 static inline bool classof(const ConstantExpr *CE) {
168 return CE->getOpcode() == Instruction::Mul;
170 static inline bool classof(const Value *V) {
171 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
172 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
176 /// SDivOperator - An Operator with opcode Instruction::SDiv.
178 class SDivOperator : public Operator {
185 ~SDivOperator(); // do not implement
187 friend class BinaryOperator;
188 friend class ConstantExpr;
189 void setIsExact(bool B) {
190 SubclassOptionalData = (SubclassOptionalData & ~IsExact) | (B * IsExact);
194 /// isExact - Test whether this division is known to be exact, with
196 bool isExact() const {
197 return SubclassOptionalData & IsExact;
200 // Methods for support type inquiry through isa, cast, and dyn_cast:
201 static inline bool classof(const SDivOperator *) { return true; }
202 static inline bool classof(const ConstantExpr *CE) {
203 return CE->getOpcode() == Instruction::SDiv;
205 static inline bool classof(const Instruction *I) {
206 return I->getOpcode() == Instruction::SDiv;
208 static inline bool classof(const Value *V) {
209 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
210 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
214 class GEPOperator : public Operator {
216 IsInBounds = (1 << 0)
219 ~GEPOperator(); // do not implement
221 friend class GetElementPtrInst;
222 friend class ConstantExpr;
223 void setIsInBounds(bool B) {
224 SubclassOptionalData =
225 (SubclassOptionalData & ~IsInBounds) | (B * IsInBounds);
229 /// isInBounds - Test whether this is an inbounds GEP, as defined
231 bool isInBounds() const {
232 return SubclassOptionalData & IsInBounds;
235 inline op_iterator idx_begin() { return op_begin()+1; }
236 inline const_op_iterator idx_begin() const { return op_begin()+1; }
237 inline op_iterator idx_end() { return op_end(); }
238 inline const_op_iterator idx_end() const { return op_end(); }
240 Value *getPointerOperand() {
241 return getOperand(0);
243 const Value *getPointerOperand() const {
244 return getOperand(0);
246 static unsigned getPointerOperandIndex() {
247 return 0U; // get index for modifying correct operand
250 /// getPointerOperandType - Method to return the pointer operand as a
252 const PointerType *getPointerOperandType() const {
253 return reinterpret_cast<const PointerType*>(getPointerOperand()->getType());
256 unsigned getNumIndices() const { // Note: always non-negative
257 return getNumOperands() - 1;
260 bool hasIndices() const {
261 return getNumOperands() > 1;
264 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
265 /// zeros. If so, the result pointer and the first operand have the same
266 /// value, just potentially different types.
267 bool hasAllZeroIndices() const {
268 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
269 if (Constant *C = dyn_cast<Constant>(I))
270 if (C->isNullValue())
277 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
278 /// constant integers. If so, the result pointer and the first operand have
279 /// a constant offset between them.
280 bool hasAllConstantIndices() const {
281 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
282 if (!isa<ConstantInt>(I))
289 // Methods for support type inquiry through isa, cast, and dyn_cast:
290 static inline bool classof(const GEPOperator *) { return true; }
291 static inline bool classof(const GetElementPtrInst *) { return true; }
292 static inline bool classof(const ConstantExpr *CE) {
293 return CE->getOpcode() == Instruction::GetElementPtr;
295 static inline bool classof(const Instruction *I) {
296 return I->getOpcode() == Instruction::GetElementPtr;
298 static inline bool classof(const Value *V) {
299 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
300 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
304 } // End llvm namespace