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_IR_OPERATOR_H
16 #define LLVM_IR_OPERATOR_H
18 #include "llvm/IR/Constants.h"
19 #include "llvm/IR/DataLayout.h"
20 #include "llvm/IR/DerivedTypes.h"
21 #include "llvm/IR/Instruction.h"
22 #include "llvm/IR/Type.h"
23 #include "llvm/Support/GetElementPtrTypeIterator.h"
27 class GetElementPtrInst;
31 /// Operator - This is a utility class that provides an abstraction for the
32 /// common functionality between Instructions and ConstantExprs.
34 class Operator : public User {
36 // The Operator class is intended to be used as a utility, and is never itself
38 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
39 void *operator new(size_t s) LLVM_DELETED_FUNCTION;
40 Operator() LLVM_DELETED_FUNCTION;
43 // NOTE: Cannot use LLVM_DELETED_FUNCTION because it's not legal to delete
44 // an overridden method that's not deleted in the base class. Cannot leave
45 // this unimplemented because that leads to an ODR-violation.
49 /// getOpcode - Return the opcode for this Instruction or ConstantExpr.
51 unsigned getOpcode() const {
52 if (const Instruction *I = dyn_cast<Instruction>(this))
53 return I->getOpcode();
54 return cast<ConstantExpr>(this)->getOpcode();
57 /// getOpcode - If V is an Instruction or ConstantExpr, return its
58 /// opcode. Otherwise return UserOp1.
60 static unsigned getOpcode(const Value *V) {
61 if (const Instruction *I = dyn_cast<Instruction>(V))
62 return I->getOpcode();
63 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
64 return CE->getOpcode();
65 return Instruction::UserOp1;
68 static inline bool classof(const Instruction *) { return true; }
69 static inline bool classof(const ConstantExpr *) { return true; }
70 static inline bool classof(const Value *V) {
71 return isa<Instruction>(V) || isa<ConstantExpr>(V);
75 /// OverflowingBinaryOperator - Utility class for integer arithmetic operators
76 /// which may exhibit overflow - Add, Sub, and Mul. It does not include SDiv,
77 /// despite that operator having the potential for overflow.
79 class OverflowingBinaryOperator : public Operator {
82 NoUnsignedWrap = (1 << 0),
83 NoSignedWrap = (1 << 1)
87 friend class BinaryOperator;
88 friend class ConstantExpr;
89 void setHasNoUnsignedWrap(bool B) {
90 SubclassOptionalData =
91 (SubclassOptionalData & ~NoUnsignedWrap) | (B * NoUnsignedWrap);
93 void setHasNoSignedWrap(bool B) {
94 SubclassOptionalData =
95 (SubclassOptionalData & ~NoSignedWrap) | (B * NoSignedWrap);
99 /// hasNoUnsignedWrap - Test whether this operation is known to never
100 /// undergo unsigned overflow, aka the nuw property.
101 bool hasNoUnsignedWrap() const {
102 return SubclassOptionalData & NoUnsignedWrap;
105 /// hasNoSignedWrap - Test whether this operation is known to never
106 /// undergo signed overflow, aka the nsw property.
107 bool hasNoSignedWrap() const {
108 return (SubclassOptionalData & NoSignedWrap) != 0;
111 static inline bool classof(const Instruction *I) {
112 return I->getOpcode() == Instruction::Add ||
113 I->getOpcode() == Instruction::Sub ||
114 I->getOpcode() == Instruction::Mul ||
115 I->getOpcode() == Instruction::Shl;
117 static inline bool classof(const ConstantExpr *CE) {
118 return CE->getOpcode() == Instruction::Add ||
119 CE->getOpcode() == Instruction::Sub ||
120 CE->getOpcode() == Instruction::Mul ||
121 CE->getOpcode() == Instruction::Shl;
123 static inline bool classof(const Value *V) {
124 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
125 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
129 /// PossiblyExactOperator - A udiv or sdiv instruction, which can be marked as
130 /// "exact", indicating that no bits are destroyed.
131 class PossiblyExactOperator : public Operator {
138 friend class BinaryOperator;
139 friend class ConstantExpr;
140 void setIsExact(bool B) {
141 SubclassOptionalData = (SubclassOptionalData & ~IsExact) | (B * IsExact);
145 /// isExact - Test whether this division is known to be exact, with
147 bool isExact() const {
148 return SubclassOptionalData & IsExact;
151 static bool isPossiblyExactOpcode(unsigned OpC) {
152 return OpC == Instruction::SDiv ||
153 OpC == Instruction::UDiv ||
154 OpC == Instruction::AShr ||
155 OpC == Instruction::LShr;
157 static inline bool classof(const ConstantExpr *CE) {
158 return isPossiblyExactOpcode(CE->getOpcode());
160 static inline bool classof(const Instruction *I) {
161 return isPossiblyExactOpcode(I->getOpcode());
163 static inline bool classof(const Value *V) {
164 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
165 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
169 /// Convenience struct for specifying and reasoning about fast-math flags.
170 class FastMathFlags {
172 friend class FPMathOperator;
174 FastMathFlags(unsigned F) : Flags(F) { }
178 UnsafeAlgebra = (1 << 0),
181 NoSignedZeros = (1 << 3),
182 AllowReciprocal = (1 << 4)
185 FastMathFlags() : Flags(0)
188 /// Whether any flag is set
189 bool any() { return Flags != 0; }
191 /// Set all the flags to false
192 void clear() { Flags = 0; }
195 bool noNaNs() { return 0 != (Flags & NoNaNs); }
196 bool noInfs() { return 0 != (Flags & NoInfs); }
197 bool noSignedZeros() { return 0 != (Flags & NoSignedZeros); }
198 bool allowReciprocal() { return 0 != (Flags & AllowReciprocal); }
199 bool unsafeAlgebra() { return 0 != (Flags & UnsafeAlgebra); }
202 void setNoNaNs() { Flags |= NoNaNs; }
203 void setNoInfs() { Flags |= NoInfs; }
204 void setNoSignedZeros() { Flags |= NoSignedZeros; }
205 void setAllowReciprocal() { Flags |= AllowReciprocal; }
206 void setUnsafeAlgebra() {
207 Flags |= UnsafeAlgebra;
211 setAllowReciprocal();
216 /// FPMathOperator - Utility class for floating point operations which can have
217 /// information about relaxed accuracy requirements attached to them.
218 class FPMathOperator : public Operator {
220 friend class Instruction;
222 void setHasUnsafeAlgebra(bool B) {
223 SubclassOptionalData =
224 (SubclassOptionalData & ~FastMathFlags::UnsafeAlgebra) |
225 (B * FastMathFlags::UnsafeAlgebra);
227 // Unsafe algebra implies all the others
231 setHasNoSignedZeros(true);
232 setHasAllowReciprocal(true);
235 void setHasNoNaNs(bool B) {
236 SubclassOptionalData =
237 (SubclassOptionalData & ~FastMathFlags::NoNaNs) |
238 (B * FastMathFlags::NoNaNs);
240 void setHasNoInfs(bool B) {
241 SubclassOptionalData =
242 (SubclassOptionalData & ~FastMathFlags::NoInfs) |
243 (B * FastMathFlags::NoInfs);
245 void setHasNoSignedZeros(bool B) {
246 SubclassOptionalData =
247 (SubclassOptionalData & ~FastMathFlags::NoSignedZeros) |
248 (B * FastMathFlags::NoSignedZeros);
250 void setHasAllowReciprocal(bool B) {
251 SubclassOptionalData =
252 (SubclassOptionalData & ~FastMathFlags::AllowReciprocal) |
253 (B * FastMathFlags::AllowReciprocal);
256 /// Convenience function for setting all the fast-math flags
257 void setFastMathFlags(FastMathFlags FMF) {
258 SubclassOptionalData |= FMF.Flags;
262 /// Test whether this operation is permitted to be
263 /// algebraically transformed, aka the 'A' fast-math property.
264 bool hasUnsafeAlgebra() const {
265 return (SubclassOptionalData & FastMathFlags::UnsafeAlgebra) != 0;
268 /// Test whether this operation's arguments and results are to be
269 /// treated as non-NaN, aka the 'N' fast-math property.
270 bool hasNoNaNs() const {
271 return (SubclassOptionalData & FastMathFlags::NoNaNs) != 0;
274 /// Test whether this operation's arguments and results are to be
275 /// treated as NoN-Inf, aka the 'I' fast-math property.
276 bool hasNoInfs() const {
277 return (SubclassOptionalData & FastMathFlags::NoInfs) != 0;
280 /// Test whether this operation can treat the sign of zero
281 /// as insignificant, aka the 'S' fast-math property.
282 bool hasNoSignedZeros() const {
283 return (SubclassOptionalData & FastMathFlags::NoSignedZeros) != 0;
286 /// Test whether this operation is permitted to use
287 /// reciprocal instead of division, aka the 'R' fast-math property.
288 bool hasAllowReciprocal() const {
289 return (SubclassOptionalData & FastMathFlags::AllowReciprocal) != 0;
292 /// Convenience function for getting all the fast-math flags
293 FastMathFlags getFastMathFlags() const {
294 return FastMathFlags(SubclassOptionalData);
297 /// \brief Get the maximum error permitted by this operation in ULPs. An
298 /// accuracy of 0.0 means that the operation should be performed with the
299 /// default precision.
300 float getFPAccuracy() const;
302 static inline bool classof(const Instruction *I) {
303 return I->getType()->isFPOrFPVectorTy();
305 static inline bool classof(const Value *V) {
306 return isa<Instruction>(V) && classof(cast<Instruction>(V));
311 /// ConcreteOperator - A helper template for defining operators for individual
313 template<typename SuperClass, unsigned Opc>
314 class ConcreteOperator : public SuperClass {
316 static inline bool classof(const Instruction *I) {
317 return I->getOpcode() == Opc;
319 static inline bool classof(const ConstantExpr *CE) {
320 return CE->getOpcode() == Opc;
322 static inline bool classof(const Value *V) {
323 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
324 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
329 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Add> {
332 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Sub> {
335 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Mul> {
338 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Shl> {
343 : public ConcreteOperator<PossiblyExactOperator, Instruction::SDiv> {
346 : public ConcreteOperator<PossiblyExactOperator, Instruction::UDiv> {
349 : public ConcreteOperator<PossiblyExactOperator, Instruction::AShr> {
352 : public ConcreteOperator<PossiblyExactOperator, Instruction::LShr> {
358 : public ConcreteOperator<Operator, Instruction::GetElementPtr> {
360 IsInBounds = (1 << 0)
363 friend class GetElementPtrInst;
364 friend class ConstantExpr;
365 void setIsInBounds(bool B) {
366 SubclassOptionalData =
367 (SubclassOptionalData & ~IsInBounds) | (B * IsInBounds);
371 /// isInBounds - Test whether this is an inbounds GEP, as defined
373 bool isInBounds() const {
374 return SubclassOptionalData & IsInBounds;
377 inline op_iterator idx_begin() { return op_begin()+1; }
378 inline const_op_iterator idx_begin() const { return op_begin()+1; }
379 inline op_iterator idx_end() { return op_end(); }
380 inline const_op_iterator idx_end() const { return op_end(); }
382 Value *getPointerOperand() {
383 return getOperand(0);
385 const Value *getPointerOperand() const {
386 return getOperand(0);
388 static unsigned getPointerOperandIndex() {
389 return 0U; // get index for modifying correct operand
392 /// getPointerOperandType - Method to return the pointer operand as a
394 Type *getPointerOperandType() const {
395 return getPointerOperand()->getType();
398 /// getPointerAddressSpace - Method to return the address space of the
400 unsigned getPointerAddressSpace() const {
401 return cast<PointerType>(getPointerOperandType())->getAddressSpace();
404 unsigned getNumIndices() const { // Note: always non-negative
405 return getNumOperands() - 1;
408 bool hasIndices() const {
409 return getNumOperands() > 1;
412 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
413 /// zeros. If so, the result pointer and the first operand have the same
414 /// value, just potentially different types.
415 bool hasAllZeroIndices() const {
416 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
417 if (ConstantInt *C = dyn_cast<ConstantInt>(I))
425 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
426 /// constant integers. If so, the result pointer and the first operand have
427 /// a constant offset between them.
428 bool hasAllConstantIndices() const {
429 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
430 if (!isa<ConstantInt>(I))
436 /// \brief Accumulate the constant address offset of this GEP if possible.
438 /// This routine accepts an APInt into which it will accumulate the constant
439 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
440 /// all-constant, it returns false and the value of the offset APInt is
441 /// undefined (it is *not* preserved!). The APInt passed into this routine
442 /// must be at exactly as wide as the IntPtr type for the address space of the
443 /// base GEP pointer.
444 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const {
445 assert(Offset.getBitWidth() ==
446 DL.getPointerSizeInBits(getPointerAddressSpace()) &&
447 "The offset must have exactly as many bits as our pointer.");
449 for (gep_type_iterator GTI = gep_type_begin(this), GTE = gep_type_end(this);
451 ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand());
457 // Handle a struct index, which adds its field offset to the pointer.
458 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
459 unsigned ElementIdx = OpC->getZExtValue();
460 const StructLayout *SL = DL.getStructLayout(STy);
461 Offset += APInt(Offset.getBitWidth(),
462 SL->getElementOffset(ElementIdx));
466 // For array or vector indices, scale the index by the size of the type.
467 APInt Index = OpC->getValue().sextOrTrunc(Offset.getBitWidth());
468 Offset += Index * APInt(Offset.getBitWidth(),
469 DL.getTypeAllocSize(GTI.getIndexedType()));
476 } // End llvm namespace