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/Constants.h"
19 #include "llvm/DerivedTypes.h"
20 #include "llvm/Instruction.h"
21 #include "llvm/Type.h"
25 class GetElementPtrInst;
29 /// Operator - This is a utility class that provides an abstraction for the
30 /// common functionality between Instructions and ConstantExprs.
32 class Operator : public User {
34 // Do not implement any of these. The Operator class is intended to be used
35 // as a utility, and is never itself instantiated.
36 void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
37 void *operator new(size_t s) LLVM_DELETED_FUNCTION;
38 Operator() LLVM_DELETED_FUNCTION;
41 // NOTE: Cannot use LLVM_DELETED_FUNCTION because it's not legal to delete
42 // an overridden method that's not deleted in the base class. Cannot leave
43 // this unimplemented because that leads to an ODR-violation.
47 /// getOpcode - Return the opcode for this Instruction or ConstantExpr.
49 unsigned getOpcode() const {
50 if (const Instruction *I = dyn_cast<Instruction>(this))
51 return I->getOpcode();
52 return cast<ConstantExpr>(this)->getOpcode();
55 /// getOpcode - If V is an Instruction or ConstantExpr, return its
56 /// opcode. Otherwise return UserOp1.
58 static unsigned getOpcode(const Value *V) {
59 if (const Instruction *I = dyn_cast<Instruction>(V))
60 return I->getOpcode();
61 if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
62 return CE->getOpcode();
63 return Instruction::UserOp1;
66 static inline bool classof(const Instruction *) { return true; }
67 static inline bool classof(const ConstantExpr *) { return true; }
68 static inline bool classof(const Value *V) {
69 return isa<Instruction>(V) || isa<ConstantExpr>(V);
73 /// OverflowingBinaryOperator - Utility class for integer arithmetic operators
74 /// which may exhibit overflow - Add, Sub, and Mul. It does not include SDiv,
75 /// despite that operator having the potential for overflow.
77 class OverflowingBinaryOperator : public Operator {
80 NoUnsignedWrap = (1 << 0),
81 NoSignedWrap = (1 << 1)
85 friend class BinaryOperator;
86 friend class ConstantExpr;
87 void setHasNoUnsignedWrap(bool B) {
88 SubclassOptionalData =
89 (SubclassOptionalData & ~NoUnsignedWrap) | (B * NoUnsignedWrap);
91 void setHasNoSignedWrap(bool B) {
92 SubclassOptionalData =
93 (SubclassOptionalData & ~NoSignedWrap) | (B * NoSignedWrap);
97 /// hasNoUnsignedWrap - Test whether this operation is known to never
98 /// undergo unsigned overflow, aka the nuw property.
99 bool hasNoUnsignedWrap() const {
100 return SubclassOptionalData & NoUnsignedWrap;
103 /// hasNoSignedWrap - Test whether this operation is known to never
104 /// undergo signed overflow, aka the nsw property.
105 bool hasNoSignedWrap() const {
106 return (SubclassOptionalData & NoSignedWrap) != 0;
109 static inline bool classof(const Instruction *I) {
110 return I->getOpcode() == Instruction::Add ||
111 I->getOpcode() == Instruction::Sub ||
112 I->getOpcode() == Instruction::Mul ||
113 I->getOpcode() == Instruction::Shl;
115 static inline bool classof(const ConstantExpr *CE) {
116 return CE->getOpcode() == Instruction::Add ||
117 CE->getOpcode() == Instruction::Sub ||
118 CE->getOpcode() == Instruction::Mul ||
119 CE->getOpcode() == Instruction::Shl;
121 static inline bool classof(const Value *V) {
122 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
123 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
127 /// PossiblyExactOperator - A udiv or sdiv instruction, which can be marked as
128 /// "exact", indicating that no bits are destroyed.
129 class PossiblyExactOperator : public Operator {
136 friend class BinaryOperator;
137 friend class ConstantExpr;
138 void setIsExact(bool B) {
139 SubclassOptionalData = (SubclassOptionalData & ~IsExact) | (B * IsExact);
143 /// isExact - Test whether this division is known to be exact, with
145 bool isExact() const {
146 return SubclassOptionalData & IsExact;
149 static bool isPossiblyExactOpcode(unsigned OpC) {
150 return OpC == Instruction::SDiv ||
151 OpC == Instruction::UDiv ||
152 OpC == Instruction::AShr ||
153 OpC == Instruction::LShr;
155 static inline bool classof(const ConstantExpr *CE) {
156 return isPossiblyExactOpcode(CE->getOpcode());
158 static inline bool classof(const Instruction *I) {
159 return isPossiblyExactOpcode(I->getOpcode());
161 static inline bool classof(const Value *V) {
162 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
163 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
167 /// Convenience struct for specifying and reasoning about fast-math flags.
168 class FastMathFlags {
170 friend class FPMathOperator;
172 FastMathFlags(unsigned F) : Flags(F) { }
176 UnsafeAlgebra = (1 << 0),
179 NoSignedZeros = (1 << 3),
180 AllowReciprocal = (1 << 4)
183 FastMathFlags() : Flags(0)
186 /// Whether any flag is set
187 bool any() { return Flags != 0; }
189 /// Set all the flags to false
190 void clear() { Flags = 0; }
193 bool noNaNs() { return 0 != (Flags & NoNaNs); }
194 bool noInfs() { return 0 != (Flags & NoInfs); }
195 bool noSignedZeros() { return 0 != (Flags & NoSignedZeros); }
196 bool allowReciprocal() { return 0 != (Flags & AllowReciprocal); }
197 bool unsafeAlgebra() { return 0 != (Flags & UnsafeAlgebra); }
200 void setNoNaNs() { Flags |= NoNaNs; }
201 void setNoInfs() { Flags |= NoInfs; }
202 void setNoSignedZeros() { Flags |= NoSignedZeros; }
203 void setAllowReciprocal() { Flags |= AllowReciprocal; }
204 void setUnsafeAlgebra() {
205 Flags |= UnsafeAlgebra;
209 setAllowReciprocal();
214 /// FPMathOperator - Utility class for floating point operations which can have
215 /// information about relaxed accuracy requirements attached to them.
216 class FPMathOperator : public Operator {
218 friend class Instruction;
220 void setHasUnsafeAlgebra(bool B) {
221 SubclassOptionalData =
222 (SubclassOptionalData & ~FastMathFlags::UnsafeAlgebra) |
223 (B * FastMathFlags::UnsafeAlgebra);
225 // Unsafe algebra implies all the others
229 setHasNoSignedZeros(true);
230 setHasAllowReciprocal(true);
233 void setHasNoNaNs(bool B) {
234 SubclassOptionalData =
235 (SubclassOptionalData & ~FastMathFlags::NoNaNs) |
236 (B * FastMathFlags::NoNaNs);
238 void setHasNoInfs(bool B) {
239 SubclassOptionalData =
240 (SubclassOptionalData & ~FastMathFlags::NoInfs) |
241 (B * FastMathFlags::NoInfs);
243 void setHasNoSignedZeros(bool B) {
244 SubclassOptionalData =
245 (SubclassOptionalData & ~FastMathFlags::NoSignedZeros) |
246 (B * FastMathFlags::NoSignedZeros);
248 void setHasAllowReciprocal(bool B) {
249 SubclassOptionalData =
250 (SubclassOptionalData & ~FastMathFlags::AllowReciprocal) |
251 (B * FastMathFlags::AllowReciprocal);
254 /// Convenience function for setting all the fast-math flags
255 void setFastMathFlags(FastMathFlags FMF) {
256 SubclassOptionalData |= FMF.Flags;
260 /// Test whether this operation is permitted to be
261 /// algebraically transformed, aka the 'A' fast-math property.
262 bool hasUnsafeAlgebra() const {
263 return (SubclassOptionalData & FastMathFlags::UnsafeAlgebra) != 0;
266 /// Test whether this operation's arguments and results are to be
267 /// treated as non-NaN, aka the 'N' fast-math property.
268 bool hasNoNaNs() const {
269 return (SubclassOptionalData & FastMathFlags::NoNaNs) != 0;
272 /// Test whether this operation's arguments and results are to be
273 /// treated as NoN-Inf, aka the 'I' fast-math property.
274 bool hasNoInfs() const {
275 return (SubclassOptionalData & FastMathFlags::NoInfs) != 0;
278 /// Test whether this operation can treat the sign of zero
279 /// as insignificant, aka the 'S' fast-math property.
280 bool hasNoSignedZeros() const {
281 return (SubclassOptionalData & FastMathFlags::NoSignedZeros) != 0;
284 /// Test whether this operation is permitted to use
285 /// reciprocal instead of division, aka the 'R' fast-math property.
286 bool hasAllowReciprocal() const {
287 return (SubclassOptionalData & FastMathFlags::AllowReciprocal) != 0;
290 /// Convenience function for getting all the fast-math flags
291 FastMathFlags getFastMathFlags() const {
292 return FastMathFlags(SubclassOptionalData);
295 /// \brief Get the maximum error permitted by this operation in ULPs. An
296 /// accuracy of 0.0 means that the operation should be performed with the
297 /// default precision.
298 float getFPAccuracy() const;
300 static inline bool classof(const Instruction *I) {
301 return I->getType()->isFPOrFPVectorTy();
303 static inline bool classof(const Value *V) {
304 return isa<Instruction>(V) && classof(cast<Instruction>(V));
309 /// ConcreteOperator - A helper template for defining operators for individual
311 template<typename SuperClass, unsigned Opc>
312 class ConcreteOperator : public SuperClass {
314 static inline bool classof(const Instruction *I) {
315 return I->getOpcode() == Opc;
317 static inline bool classof(const ConstantExpr *CE) {
318 return CE->getOpcode() == Opc;
320 static inline bool classof(const Value *V) {
321 return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
322 (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
327 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Add> {
330 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Sub> {
333 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Mul> {
336 : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Shl> {
341 : public ConcreteOperator<PossiblyExactOperator, Instruction::SDiv> {
344 : public ConcreteOperator<PossiblyExactOperator, Instruction::UDiv> {
347 : public ConcreteOperator<PossiblyExactOperator, Instruction::AShr> {
350 : public ConcreteOperator<PossiblyExactOperator, Instruction::LShr> {
356 : public ConcreteOperator<Operator, Instruction::GetElementPtr> {
358 IsInBounds = (1 << 0)
361 friend class GetElementPtrInst;
362 friend class ConstantExpr;
363 void setIsInBounds(bool B) {
364 SubclassOptionalData =
365 (SubclassOptionalData & ~IsInBounds) | (B * IsInBounds);
369 /// isInBounds - Test whether this is an inbounds GEP, as defined
371 bool isInBounds() const {
372 return SubclassOptionalData & IsInBounds;
375 inline op_iterator idx_begin() { return op_begin()+1; }
376 inline const_op_iterator idx_begin() const { return op_begin()+1; }
377 inline op_iterator idx_end() { return op_end(); }
378 inline const_op_iterator idx_end() const { return op_end(); }
380 Value *getPointerOperand() {
381 return getOperand(0);
383 const Value *getPointerOperand() const {
384 return getOperand(0);
386 static unsigned getPointerOperandIndex() {
387 return 0U; // get index for modifying correct operand
390 /// getPointerOperandType - Method to return the pointer operand as a
392 Type *getPointerOperandType() const {
393 return getPointerOperand()->getType();
396 /// getPointerAddressSpace - Method to return the address space of the
398 unsigned getPointerAddressSpace() const {
399 return cast<PointerType>(getPointerOperandType())->getAddressSpace();
402 unsigned getNumIndices() const { // Note: always non-negative
403 return getNumOperands() - 1;
406 bool hasIndices() const {
407 return getNumOperands() > 1;
410 /// hasAllZeroIndices - Return true if all of the indices of this GEP are
411 /// zeros. If so, the result pointer and the first operand have the same
412 /// value, just potentially different types.
413 bool hasAllZeroIndices() const {
414 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
415 if (ConstantInt *C = dyn_cast<ConstantInt>(I))
423 /// hasAllConstantIndices - Return true if all of the indices of this GEP are
424 /// constant integers. If so, the result pointer and the first operand have
425 /// a constant offset between them.
426 bool hasAllConstantIndices() const {
427 for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
428 if (!isa<ConstantInt>(I))
435 } // End llvm namespace