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();
214 void operator&=(const FastMathFlags &OtherFlags) {
215 Flags &= OtherFlags.Flags;
220 /// FPMathOperator - Utility class for floating point operations which can have
221 /// information about relaxed accuracy requirements attached to them.
222 class FPMathOperator : public Operator {
224 friend class Instruction;
226 void setHasUnsafeAlgebra(bool B) {
227 SubclassOptionalData =
228 (SubclassOptionalData & ~FastMathFlags::UnsafeAlgebra) |
229 (B * FastMathFlags::UnsafeAlgebra);
231 // Unsafe algebra implies all the others
235 setHasNoSignedZeros(true);
236 setHasAllowReciprocal(true);
239 void setHasNoNaNs(bool B) {
240 SubclassOptionalData =
241 (SubclassOptionalData & ~FastMathFlags::NoNaNs) |
242 (B * FastMathFlags::NoNaNs);
244 void setHasNoInfs(bool B) {
245 SubclassOptionalData =
246 (SubclassOptionalData & ~FastMathFlags::NoInfs) |
247 (B * FastMathFlags::NoInfs);
249 void setHasNoSignedZeros(bool B) {
250 SubclassOptionalData =
251 (SubclassOptionalData & ~FastMathFlags::NoSignedZeros) |
252 (B * FastMathFlags::NoSignedZeros);
254 void setHasAllowReciprocal(bool B) {
255 SubclassOptionalData =
256 (SubclassOptionalData & ~FastMathFlags::AllowReciprocal) |
257 (B * FastMathFlags::AllowReciprocal);
260 /// Convenience function for setting all the fast-math flags
261 void setFastMathFlags(FastMathFlags FMF) {
262 SubclassOptionalData |= FMF.Flags;
266 /// Test whether this operation is permitted to be
267 /// algebraically transformed, aka the 'A' fast-math property.
268 bool hasUnsafeAlgebra() const {
269 return (SubclassOptionalData & FastMathFlags::UnsafeAlgebra) != 0;
272 /// Test whether this operation's arguments and results are to be
273 /// treated as non-NaN, aka the 'N' fast-math property.
274 bool hasNoNaNs() const {
275 return (SubclassOptionalData & FastMathFlags::NoNaNs) != 0;
278 /// Test whether this operation's arguments and results are to be
279 /// treated as NoN-Inf, aka the 'I' fast-math property.
280 bool hasNoInfs() const {
281 return (SubclassOptionalData & FastMathFlags::NoInfs) != 0;
284 /// Test whether this operation can treat the sign of zero
285 /// as insignificant, aka the 'S' fast-math property.
286 bool hasNoSignedZeros() const {
287 return (SubclassOptionalData & FastMathFlags::NoSignedZeros) != 0;
290 /// Test whether this operation is permitted to use
291 /// reciprocal instead of division, aka the 'R' fast-math property.
292 bool hasAllowReciprocal() const {
293 return (SubclassOptionalData & FastMathFlags::AllowReciprocal) != 0;
296 /// Convenience function for getting all the fast-math flags
297 FastMathFlags getFastMathFlags() const {
298 return FastMathFlags(SubclassOptionalData);
301 /// \brief Get the maximum error permitted by this operation in ULPs. An
302 /// accuracy of 0.0 means that the operation should be performed with the
303 /// default precision.
304 float getFPAccuracy() const;
306 static inline bool classof(const Instruction *I) {
307 return I->getType()->isFPOrFPVectorTy();
309 static inline bool classof(const Value *V) {
310 return isa<Instruction>(V) && classof(cast<Instruction>(V));
315 /// ConcreteOperator - A helper template for defining operators for individual
317 template<typename SuperClass, unsigned Opc>
318 class ConcreteOperator : public SuperClass {
320 static inline bool classof(const Instruction *I) {
321 return I->getOpcode() == Opc;
323 static inline bool classof(const ConstantExpr *CE) {
324 return CE->getOpcode() == Opc;
326 static inline bool classof(const Value *V) {
327 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
328 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
333 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Add> {
336 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Sub> {
339 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Mul> {
342 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Shl> {
347 : public ConcreteOperator<PossiblyExactOperator, Instruction::SDiv> {
350 : public ConcreteOperator<PossiblyExactOperator, Instruction::UDiv> {
353 : public ConcreteOperator<PossiblyExactOperator, Instruction::AShr> {
356 : public ConcreteOperator<PossiblyExactOperator, Instruction::LShr> {
362 : public ConcreteOperator<Operator, Instruction::GetElementPtr> {
364 IsInBounds = (1 << 0)
367 friend class GetElementPtrInst;
368 friend class ConstantExpr;
369 void setIsInBounds(bool B) {
370 SubclassOptionalData =
371 (SubclassOptionalData & ~IsInBounds) | (B * IsInBounds);
375 /// isInBounds - Test whether this is an inbounds GEP, as defined
377 bool isInBounds() const {
378 return SubclassOptionalData & IsInBounds;
381 inline op_iterator idx_begin() { return op_begin()+1; }
382 inline const_op_iterator idx_begin() const { return op_begin()+1; }
383 inline op_iterator idx_end() { return op_end(); }
384 inline const_op_iterator idx_end() const { return op_end(); }
386 Value *getPointerOperand() {
387 return getOperand(0);
389 const Value *getPointerOperand() const {
390 return getOperand(0);
392 static unsigned getPointerOperandIndex() {
393 return 0U; // get index for modifying correct operand
396 /// getPointerOperandType - Method to return the pointer operand as a
398 Type *getPointerOperandType() const {
399 return getPointerOperand()->getType();
402 /// getPointerAddressSpace - Method to return the address space of the
404 unsigned getPointerAddressSpace() const {
405 return cast<PointerType>(getPointerOperandType())->getAddressSpace();
408 unsigned getNumIndices() const { // Note: always non-negative
409 return getNumOperands() - 1;
412 bool hasIndices() const {
413 return getNumOperands() > 1;
416 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
417 /// zeros. If so, the result pointer and the first operand have the same
418 /// value, just potentially different types.
419 bool hasAllZeroIndices() const {
420 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
421 if (ConstantInt *C = dyn_cast<ConstantInt>(I))
429 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
430 /// constant integers. If so, the result pointer and the first operand have
431 /// a constant offset between them.
432 bool hasAllConstantIndices() const {
433 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
434 if (!isa<ConstantInt>(I))
440 /// \brief Accumulate the constant address offset of this GEP if possible.
442 /// This routine accepts an APInt into which it will accumulate the constant
443 /// offset of this GEP if the GEP is in fact constant. If the GEP is not
444 /// all-constant, it returns false and the value of the offset APInt is
445 /// undefined (it is *not* preserved!). The APInt passed into this routine
446 /// must be at exactly as wide as the IntPtr type for the address space of the
447 /// base GEP pointer.
448 bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const {
449 assert(Offset.getBitWidth() ==
450 DL.getPointerSizeInBits(getPointerAddressSpace()) &&
451 "The offset must have exactly as many bits as our pointer.");
453 for (gep_type_iterator GTI = gep_type_begin(this), GTE = gep_type_end(this);
455 ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand());
461 // Handle a struct index, which adds its field offset to the pointer.
462 if (StructType *STy = dyn_cast<StructType>(*GTI)) {
463 unsigned ElementIdx = OpC->getZExtValue();
464 const StructLayout *SL = DL.getStructLayout(STy);
465 Offset += APInt(Offset.getBitWidth(),
466 SL->getElementOffset(ElementIdx));
470 // For array or vector indices, scale the index by the size of the type.
471 APInt Index = OpC->getValue().sextOrTrunc(Offset.getBitWidth());
472 Offset += Index * APInt(Offset.getBitWidth(),
473 DL.getTypeAllocSize(GTI.getIndexedType()));
480 class PtrToIntOperator
481 : public ConcreteOperator<Operator, Instruction::PtrToInt> {
482 friend class PtrToInt;
483 friend class ConstantExpr;
486 Value *getPointerOperand() {
487 return getOperand(0);
489 const Value *getPointerOperand() const {
490 return getOperand(0);
492 static unsigned getPointerOperandIndex() {
493 return 0U; // get index for modifying correct operand
496 /// getPointerOperandType - Method to return the pointer operand as a
498 Type *getPointerOperandType() const {
499 return getPointerOperand()->getType();
502 /// getPointerAddressSpace - Method to return the address space of the
504 unsigned getPointerAddressSpace() const {
505 return cast<PointerType>(getPointerOperandType())->getAddressSpace();
510 } // End llvm namespace