Remove test coverage added in 221067 due to it being non-portable.
[oota-llvm.git] / include / llvm / IR / Operator.h
1 //===-- llvm/Operator.h - Operator utility subclass -------------*- 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 defines various classes for working with Instructions and
11 // ConstantExprs.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_IR_OPERATOR_H
16 #define LLVM_IR_OPERATOR_H
17
18 #include "llvm/IR/Constants.h"
19 #include "llvm/IR/DataLayout.h"
20 #include "llvm/IR/DerivedTypes.h"
21 #include "llvm/IR/GetElementPtrTypeIterator.h"
22 #include "llvm/IR/Instruction.h"
23 #include "llvm/IR/Type.h"
24
25 namespace llvm {
26
27 class GetElementPtrInst;
28 class BinaryOperator;
29 class ConstantExpr;
30
31 /// This is a utility class that provides an abstraction for the common
32 /// functionality between Instructions and ConstantExprs.
33 class Operator : public User {
34 private:
35   // The Operator class is intended to be used as a utility, and is never itself
36   // instantiated.
37   void *operator new(size_t, unsigned) LLVM_DELETED_FUNCTION;
38   void *operator new(size_t s) LLVM_DELETED_FUNCTION;
39   Operator() LLVM_DELETED_FUNCTION;
40
41 protected:
42   // NOTE: Cannot use LLVM_DELETED_FUNCTION because it's not legal to delete
43   // an overridden method that's not deleted in the base class. Cannot leave
44   // this unimplemented because that leads to an ODR-violation.
45   ~Operator();
46
47 public:
48   /// 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();
53   }
54
55   /// If V is an Instruction or ConstantExpr, return its opcode.
56   /// Otherwise return UserOp1.
57   static unsigned getOpcode(const Value *V) {
58     if (const Instruction *I = dyn_cast<Instruction>(V))
59       return I->getOpcode();
60     if (const ConstantExpr *CE = dyn_cast<ConstantExpr>(V))
61       return CE->getOpcode();
62     return Instruction::UserOp1;
63   }
64
65   static inline bool classof(const Instruction *) { return true; }
66   static inline bool classof(const ConstantExpr *) { return true; }
67   static inline bool classof(const Value *V) {
68     return isa<Instruction>(V) || isa<ConstantExpr>(V);
69   }
70 };
71
72 /// Utility class for integer arithmetic operators which may exhibit overflow -
73 /// Add, Sub, and Mul. It does not include SDiv, despite that operator having
74 /// the potential for overflow.
75 class OverflowingBinaryOperator : public Operator {
76 public:
77   enum {
78     NoUnsignedWrap = (1 << 0),
79     NoSignedWrap   = (1 << 1)
80   };
81
82 private:
83   friend class BinaryOperator;
84   friend class ConstantExpr;
85   void setHasNoUnsignedWrap(bool B) {
86     SubclassOptionalData =
87       (SubclassOptionalData & ~NoUnsignedWrap) | (B * NoUnsignedWrap);
88   }
89   void setHasNoSignedWrap(bool B) {
90     SubclassOptionalData =
91       (SubclassOptionalData & ~NoSignedWrap) | (B * NoSignedWrap);
92   }
93
94 public:
95   /// Test whether this operation is known to never
96   /// undergo unsigned overflow, aka the nuw property.
97   bool hasNoUnsignedWrap() const {
98     return SubclassOptionalData & NoUnsignedWrap;
99   }
100
101   /// Test whether this operation is known to never
102   /// undergo signed overflow, aka the nsw property.
103   bool hasNoSignedWrap() const {
104     return (SubclassOptionalData & NoSignedWrap) != 0;
105   }
106
107   static inline bool classof(const Instruction *I) {
108     return I->getOpcode() == Instruction::Add ||
109            I->getOpcode() == Instruction::Sub ||
110            I->getOpcode() == Instruction::Mul ||
111            I->getOpcode() == Instruction::Shl;
112   }
113   static inline bool classof(const ConstantExpr *CE) {
114     return CE->getOpcode() == Instruction::Add ||
115            CE->getOpcode() == Instruction::Sub ||
116            CE->getOpcode() == Instruction::Mul ||
117            CE->getOpcode() == Instruction::Shl;
118   }
119   static inline bool classof(const Value *V) {
120     return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
121            (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
122   }
123 };
124
125 /// A udiv or sdiv instruction, which can be marked as "exact",
126 /// indicating that no bits are destroyed.
127 class PossiblyExactOperator : public Operator {
128 public:
129   enum {
130     IsExact = (1 << 0)
131   };
132
133 private:
134   friend class BinaryOperator;
135   friend class ConstantExpr;
136   void setIsExact(bool B) {
137     SubclassOptionalData = (SubclassOptionalData & ~IsExact) | (B * IsExact);
138   }
139
140 public:
141   /// Test whether this division is known to be exact, with zero remainder.
142   bool isExact() const {
143     return SubclassOptionalData & IsExact;
144   }
145
146   static bool isPossiblyExactOpcode(unsigned OpC) {
147     return OpC == Instruction::SDiv ||
148            OpC == Instruction::UDiv ||
149            OpC == Instruction::AShr ||
150            OpC == Instruction::LShr;
151   }
152   static inline bool classof(const ConstantExpr *CE) {
153     return isPossiblyExactOpcode(CE->getOpcode());
154   }
155   static inline bool classof(const Instruction *I) {
156     return isPossiblyExactOpcode(I->getOpcode());
157   }
158   static inline bool classof(const Value *V) {
159     return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
160            (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
161   }
162 };
163
164 /// Convenience struct for specifying and reasoning about fast-math flags.
165 class FastMathFlags {
166 private:
167   friend class FPMathOperator;
168   unsigned Flags;
169   FastMathFlags(unsigned F) : Flags(F) { }
170
171 public:
172   enum {
173     UnsafeAlgebra   = (1 << 0),
174     NoNaNs          = (1 << 1),
175     NoInfs          = (1 << 2),
176     NoSignedZeros   = (1 << 3),
177     AllowReciprocal = (1 << 4)
178   };
179
180   FastMathFlags() : Flags(0)
181   { }
182
183   /// Whether any flag is set
184   bool any() { return Flags != 0; }
185
186   /// Set all the flags to false
187   void clear() { Flags = 0; }
188
189   /// Flag queries
190   bool noNaNs()          { return 0 != (Flags & NoNaNs); }
191   bool noInfs()          { return 0 != (Flags & NoInfs); }
192   bool noSignedZeros()   { return 0 != (Flags & NoSignedZeros); }
193   bool allowReciprocal() { return 0 != (Flags & AllowReciprocal); }
194   bool unsafeAlgebra()   { return 0 != (Flags & UnsafeAlgebra); }
195
196   /// Flag setters
197   void setNoNaNs()          { Flags |= NoNaNs; }
198   void setNoInfs()          { Flags |= NoInfs; }
199   void setNoSignedZeros()   { Flags |= NoSignedZeros; }
200   void setAllowReciprocal() { Flags |= AllowReciprocal; }
201   void setUnsafeAlgebra() {
202     Flags |= UnsafeAlgebra;
203     setNoNaNs();
204     setNoInfs();
205     setNoSignedZeros();
206     setAllowReciprocal();
207   }
208
209   void operator&=(const FastMathFlags &OtherFlags) {
210     Flags &= OtherFlags.Flags;
211   }
212 };
213
214
215 /// Utility class for floating point operations which can have
216 /// information about relaxed accuracy requirements attached to them.
217 class FPMathOperator : public Operator {
218 private:
219   friend class Instruction;
220
221   void setHasUnsafeAlgebra(bool B) {
222     SubclassOptionalData =
223       (SubclassOptionalData & ~FastMathFlags::UnsafeAlgebra) |
224       (B * FastMathFlags::UnsafeAlgebra);
225
226     // Unsafe algebra implies all the others
227     if (B) {
228       setHasNoNaNs(true);
229       setHasNoInfs(true);
230       setHasNoSignedZeros(true);
231       setHasAllowReciprocal(true);
232     }
233   }
234   void setHasNoNaNs(bool B) {
235     SubclassOptionalData =
236       (SubclassOptionalData & ~FastMathFlags::NoNaNs) |
237       (B * FastMathFlags::NoNaNs);
238   }
239   void setHasNoInfs(bool B) {
240     SubclassOptionalData =
241       (SubclassOptionalData & ~FastMathFlags::NoInfs) |
242       (B * FastMathFlags::NoInfs);
243   }
244   void setHasNoSignedZeros(bool B) {
245     SubclassOptionalData =
246       (SubclassOptionalData & ~FastMathFlags::NoSignedZeros) |
247       (B * FastMathFlags::NoSignedZeros);
248   }
249   void setHasAllowReciprocal(bool B) {
250     SubclassOptionalData =
251       (SubclassOptionalData & ~FastMathFlags::AllowReciprocal) |
252       (B * FastMathFlags::AllowReciprocal);
253   }
254
255   /// Convenience function for setting multiple fast-math flags.
256   /// FMF is a mask of the bits to set.
257   void setFastMathFlags(FastMathFlags FMF) {
258     SubclassOptionalData |= FMF.Flags;
259   }
260
261   /// Convenience function for copying all fast-math flags.
262   /// All values in FMF are transferred to this operator.
263   void copyFastMathFlags(FastMathFlags FMF) {
264     SubclassOptionalData = FMF.Flags;
265   }
266
267 public:
268   /// Test whether this operation is permitted to be
269   /// algebraically transformed, aka the 'A' fast-math property.
270   bool hasUnsafeAlgebra() const {
271     return (SubclassOptionalData & FastMathFlags::UnsafeAlgebra) != 0;
272   }
273
274   /// Test whether this operation's arguments and results are to be
275   /// treated as non-NaN, aka the 'N' fast-math property.
276   bool hasNoNaNs() const {
277     return (SubclassOptionalData & FastMathFlags::NoNaNs) != 0;
278   }
279
280   /// Test whether this operation's arguments and results are to be
281   /// treated as NoN-Inf, aka the 'I' fast-math property.
282   bool hasNoInfs() const {
283     return (SubclassOptionalData & FastMathFlags::NoInfs) != 0;
284   }
285
286   /// Test whether this operation can treat the sign of zero
287   /// as insignificant, aka the 'S' fast-math property.
288   bool hasNoSignedZeros() const {
289     return (SubclassOptionalData & FastMathFlags::NoSignedZeros) != 0;
290   }
291
292   /// Test whether this operation is permitted to use
293   /// reciprocal instead of division, aka the 'R' fast-math property.
294   bool hasAllowReciprocal() const {
295     return (SubclassOptionalData & FastMathFlags::AllowReciprocal) != 0;
296   }
297
298   /// Convenience function for getting all the fast-math flags
299   FastMathFlags getFastMathFlags() const {
300     return FastMathFlags(SubclassOptionalData);
301   }
302
303   /// \brief Get the maximum error permitted by this operation in ULPs.  An
304   /// accuracy of 0.0 means that the operation should be performed with the
305   /// default precision.
306   float getFPAccuracy() const;
307
308   static inline bool classof(const Instruction *I) {
309     return I->getType()->isFPOrFPVectorTy();
310   }
311   static inline bool classof(const Value *V) {
312     return isa<Instruction>(V) && classof(cast<Instruction>(V));
313   }
314 };
315
316
317 /// A helper template for defining operators for individual opcodes.
318 template<typename SuperClass, unsigned Opc>
319 class ConcreteOperator : public SuperClass {
320 public:
321   static inline bool classof(const Instruction *I) {
322     return I->getOpcode() == Opc;
323   }
324   static inline bool classof(const ConstantExpr *CE) {
325     return CE->getOpcode() == Opc;
326   }
327   static inline bool classof(const Value *V) {
328     return (isa<Instruction>(V) && classof(cast<Instruction>(V))) ||
329            (isa<ConstantExpr>(V) && classof(cast<ConstantExpr>(V)));
330   }
331 };
332
333 class AddOperator
334   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Add> {
335 };
336 class SubOperator
337   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Sub> {
338 };
339 class MulOperator
340   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Mul> {
341 };
342 class ShlOperator
343   : public ConcreteOperator<OverflowingBinaryOperator, Instruction::Shl> {
344 };
345
346
347 class SDivOperator
348   : public ConcreteOperator<PossiblyExactOperator, Instruction::SDiv> {
349 };
350 class UDivOperator
351   : public ConcreteOperator<PossiblyExactOperator, Instruction::UDiv> {
352 };
353 class AShrOperator
354   : public ConcreteOperator<PossiblyExactOperator, Instruction::AShr> {
355 };
356 class LShrOperator
357   : public ConcreteOperator<PossiblyExactOperator, Instruction::LShr> {
358 };
359
360
361
362 class GEPOperator
363   : public ConcreteOperator<Operator, Instruction::GetElementPtr> {
364   enum {
365     IsInBounds = (1 << 0)
366   };
367
368   friend class GetElementPtrInst;
369   friend class ConstantExpr;
370   void setIsInBounds(bool B) {
371     SubclassOptionalData =
372       (SubclassOptionalData & ~IsInBounds) | (B * IsInBounds);
373   }
374
375 public:
376   /// Test whether this is an inbounds GEP, as defined by LangRef.html.
377   bool isInBounds() const {
378     return SubclassOptionalData & IsInBounds;
379   }
380
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(); }
385
386   Value *getPointerOperand() {
387     return getOperand(0);
388   }
389   const Value *getPointerOperand() const {
390     return getOperand(0);
391   }
392   static unsigned getPointerOperandIndex() {
393     return 0U;                      // get index for modifying correct operand
394   }
395
396   /// Method to return the pointer operand as a PointerType.
397   Type *getPointerOperandType() const {
398     return getPointerOperand()->getType();
399   }
400
401   /// Method to return the address space of the pointer operand.
402   unsigned getPointerAddressSpace() const {
403     return getPointerOperandType()->getPointerAddressSpace();
404   }
405
406   unsigned getNumIndices() const {  // Note: always non-negative
407     return getNumOperands() - 1;
408   }
409
410   bool hasIndices() const {
411     return getNumOperands() > 1;
412   }
413
414   /// Return true if all of the indices of this GEP are zeros.
415   /// If so, the result pointer and the first operand have the same
416   /// value, just potentially different types.
417   bool hasAllZeroIndices() const {
418     for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
419       if (ConstantInt *C = dyn_cast<ConstantInt>(I))
420         if (C->isZero())
421           continue;
422       return false;
423     }
424     return true;
425   }
426
427   /// Return true if all of the indices of this GEP are constant integers.
428   /// If so, the result pointer and the first operand have
429   /// a constant offset between them.
430   bool hasAllConstantIndices() const {
431     for (const_op_iterator I = idx_begin(), E = idx_end(); I != E; ++I) {
432       if (!isa<ConstantInt>(I))
433         return false;
434     }
435     return true;
436   }
437
438   /// \brief Accumulate the constant address offset of this GEP if possible.
439   ///
440   /// This routine accepts an APInt into which it will accumulate the constant
441   /// offset of this GEP if the GEP is in fact constant. If the GEP is not
442   /// all-constant, it returns false and the value of the offset APInt is
443   /// undefined (it is *not* preserved!). The APInt passed into this routine
444   /// must be at exactly as wide as the IntPtr type for the address space of the
445   /// base GEP pointer.
446   bool accumulateConstantOffset(const DataLayout &DL, APInt &Offset) const {
447     assert(Offset.getBitWidth() ==
448            DL.getPointerSizeInBits(getPointerAddressSpace()) &&
449            "The offset must have exactly as many bits as our pointer.");
450
451     for (gep_type_iterator GTI = gep_type_begin(this), GTE = gep_type_end(this);
452          GTI != GTE; ++GTI) {
453       ConstantInt *OpC = dyn_cast<ConstantInt>(GTI.getOperand());
454       if (!OpC)
455         return false;
456       if (OpC->isZero())
457         continue;
458
459       // Handle a struct index, which adds its field offset to the pointer.
460       if (StructType *STy = dyn_cast<StructType>(*GTI)) {
461         unsigned ElementIdx = OpC->getZExtValue();
462         const StructLayout *SL = DL.getStructLayout(STy);
463         Offset += APInt(Offset.getBitWidth(),
464                         SL->getElementOffset(ElementIdx));
465         continue;
466       }
467
468       // For array or vector indices, scale the index by the size of the type.
469       APInt Index = OpC->getValue().sextOrTrunc(Offset.getBitWidth());
470       Offset += Index * APInt(Offset.getBitWidth(),
471                               DL.getTypeAllocSize(GTI.getIndexedType()));
472     }
473     return true;
474   }
475
476 };
477
478 class PtrToIntOperator
479     : public ConcreteOperator<Operator, Instruction::PtrToInt> {
480   friend class PtrToInt;
481   friend class ConstantExpr;
482
483 public:
484   Value *getPointerOperand() {
485     return getOperand(0);
486   }
487   const Value *getPointerOperand() const {
488     return getOperand(0);
489   }
490   static unsigned getPointerOperandIndex() {
491     return 0U;                      // get index for modifying correct operand
492   }
493
494   /// Method to return the pointer operand as a PointerType.
495   Type *getPointerOperandType() const {
496     return getPointerOperand()->getType();
497   }
498
499   /// Method to return the address space of the pointer operand.
500   unsigned getPointerAddressSpace() const {
501     return cast<PointerType>(getPointerOperandType())->getAddressSpace();
502   }
503 };
504
505
506 } // End llvm namespace
507
508 #endif