include/llvm/Support/TargetFolder.h

   1 //====-- llvm/Support/TargetFolder.h - Constant folding helper -*- 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 the TargetFolder class, a helper for IRBuilder.
  11 // It provides IRBuilder with a set of methods for creating constants with
  12 // target dependent folding, in addition to the same target-independent
  13 // folding that the ConstantFolder class provides.  For general constant
  14 // creation and folding, use ConstantExpr and the routines in
  15 // llvm/Analysis/ConstantFolding.h.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #ifndef LLVM_SUPPORT_TARGETFOLDER_H
  20 #define LLVM_SUPPORT_TARGETFOLDER_H
  21
  22 #include "llvm/Constants.h"
  23 #include "llvm/Analysis/ConstantFolding.h"
  24
  25 namespace llvm {
  26
  27 class TargetData;
  28 class LLVMContext;
  29
  30 /// TargetFolder - Create constants with target dependent folding.
  31 class TargetFolder {
  32   const TargetData *TD;
  33   LLVMContext &Context;
  34
  35   /// Fold - Fold the constant using target specific information.
  36   Constant *Fold(Constant *C) const {
  37     if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C))
  38       if (Constant *CF = ConstantFoldConstantExpression(CE, Context, TD))
  39         return CF;
  40     return C;
  41   }
  42
  43 public:
  44   explicit TargetFolder(const TargetData *TheTD, LLVMContext &C) :
  45     TD(TheTD), Context(C) {}
  46
  47   //===--------------------------------------------------------------------===//
  48   // Binary Operators
  49   //===--------------------------------------------------------------------===//
  50
  51   Constant *CreateAdd(Constant *LHS, Constant *RHS) const {
  52     return Fold(ConstantExpr::getAdd(LHS, RHS));
  53   }
  54   Constant *CreateFAdd(Constant *LHS, Constant *RHS) const {
  55     return Fold(ConstantExpr::getFAdd(LHS, RHS));
  56   }
  57   Constant *CreateSub(Constant *LHS, Constant *RHS) const {
  58     return Fold(ConstantExpr::getSub(LHS, RHS));
  59   }
  60   Constant *CreateFSub(Constant *LHS, Constant *RHS) const {
  61     return Fold(ConstantExpr::getFSub(LHS, RHS));
  62   }
  63   Constant *CreateMul(Constant *LHS, Constant *RHS) const {
  64     return Fold(ConstantExpr::getMul(LHS, RHS));
  65   }
  66   Constant *CreateFMul(Constant *LHS, Constant *RHS) const {
  67     return Fold(ConstantExpr::getFMul(LHS, RHS));
  68   }
  69   Constant *CreateUDiv(Constant *LHS, Constant *RHS) const {
  70     return Fold(ConstantExpr::getUDiv(LHS, RHS));
  71   }
  72   Constant *CreateSDiv(Constant *LHS, Constant *RHS) const {
  73     return Fold(ConstantExpr::getSDiv(LHS, RHS));
  74   }
  75   Constant *CreateExactSDiv(Constant *LHS, Constant *RHS) const {
  76     return Fold(ConstantExpr::getExactSDiv(LHS, RHS));
  77   }
  78   Constant *CreateFDiv(Constant *LHS, Constant *RHS) const {
  79     return Fold(ConstantExpr::getFDiv(LHS, RHS));
  80   }
  81   Constant *CreateURem(Constant *LHS, Constant *RHS) const {
  82     return Fold(ConstantExpr::getURem(LHS, RHS));
  83   }
  84   Constant *CreateSRem(Constant *LHS, Constant *RHS) const {
  85     return Fold(ConstantExpr::getSRem(LHS, RHS));
  86   }
  87   Constant *CreateFRem(Constant *LHS, Constant *RHS) const {
  88     return Fold(ConstantExpr::getFRem(LHS, RHS));
  89   }
  90   Constant *CreateShl(Constant *LHS, Constant *RHS) const {
  91     return Fold(ConstantExpr::getShl(LHS, RHS));
  92   }
  93   Constant *CreateLShr(Constant *LHS, Constant *RHS) const {
  94     return Fold(ConstantExpr::getLShr(LHS, RHS));
  95   }
  96   Constant *CreateAShr(Constant *LHS, Constant *RHS) const {
  97     return Fold(ConstantExpr::getAShr(LHS, RHS));
  98   }
  99   Constant *CreateAnd(Constant *LHS, Constant *RHS) const {
 100     return Fold(ConstantExpr::getAnd(LHS, RHS));
 101   }
 102   Constant *CreateOr(Constant *LHS, Constant *RHS) const {
 103     return Fold(ConstantExpr::getOr(LHS, RHS));
 104   }
 105   Constant *CreateXor(Constant *LHS, Constant *RHS) const {
 106     return Fold(ConstantExpr::getXor(LHS, RHS));
 107   }
 108
 109   Constant *CreateBinOp(Instruction::BinaryOps Opc,
 110                         Constant *LHS, Constant *RHS) const {
 111     return Fold(ConstantExpr::get(Opc, LHS, RHS));
 112   }
 113
 114   //===--------------------------------------------------------------------===//
 115   // Unary Operators
 116   //===--------------------------------------------------------------------===//
 117
 118   Constant *CreateNeg(Constant *C) const {
 119     return Fold(ConstantExpr::getNeg(C));
 120   }
 121   Constant *CreateFNeg(Constant *C) const {
 122     return Fold(ConstantExpr::getFNeg(C));
 123   }
 124   Constant *CreateNot(Constant *C) const {
 125     return Fold(ConstantExpr::getNot(C));
 126   }
 127
 128   //===--------------------------------------------------------------------===//
 129   // Memory Instructions
 130   //===--------------------------------------------------------------------===//
 131
 132   Constant *CreateGetElementPtr(Constant *C, Constant* const *IdxList,
 133                                 unsigned NumIdx) const {
 134     return Fold(ConstantExpr::getGetElementPtr(C, IdxList, NumIdx));
 135   }
 136   Constant *CreateGetElementPtr(Constant *C, Value* const *IdxList,
 137                                 unsigned NumIdx) const {
 138     return Fold(ConstantExpr::getGetElementPtr(C, IdxList, NumIdx));
 139   }
 140
 141   //===--------------------------------------------------------------------===//
 142   // Cast/Conversion Operators
 143   //===--------------------------------------------------------------------===//
 144
 145   Constant *CreateCast(Instruction::CastOps Op, Constant *C,
 146                        const Type *DestTy) const {
 147     if (C->getType() == DestTy)
 148       return C; // avoid calling Fold
 149     return Fold(ConstantExpr::getCast(Op, C, DestTy));
 150   }
 151   Constant *CreateIntCast(Constant *C, const Type *DestTy,
 152                           bool isSigned) const {
 153     if (C->getType() == DestTy)
 154       return C; // avoid calling Fold
 155     return Fold(ConstantExpr::getIntegerCast(C, DestTy, isSigned));
 156   }
 157
 158   Constant *CreateBitCast(Constant *C, const Type *DestTy) const {
 159     return CreateCast(Instruction::BitCast, C, DestTy);
 160   }
 161   Constant *CreateIntToPtr(Constant *C, const Type *DestTy) const {
 162     return CreateCast(Instruction::IntToPtr, C, DestTy);
 163   }
 164   Constant *CreatePtrToInt(Constant *C, const Type *DestTy) const {
 165     return CreateCast(Instruction::PtrToInt, C, DestTy);
 166   }
 167   Constant *CreateTruncOrBitCast(Constant *C, const Type *DestTy) const {
 168     if (C->getType() == DestTy)
 169       return C; // avoid calling Fold
 170     return Fold(ConstantExpr::getTruncOrBitCast(C, DestTy));
 171   }
 172
 173   //===--------------------------------------------------------------------===//
 174   // Compare Instructions
 175   //===--------------------------------------------------------------------===//
 176
 177   Constant *CreateICmp(CmpInst::Predicate P, Constant *LHS,
 178                        Constant *RHS) const {
 179     return Fold(ConstantExpr::getCompare(P, LHS, RHS));
 180   }
 181   Constant *CreateFCmp(CmpInst::Predicate P, Constant *LHS,
 182                        Constant *RHS) const {
 183     return Fold(ConstantExpr::getCompare(P, LHS, RHS));
 184   }
 185
 186   //===--------------------------------------------------------------------===//
 187   // Other Instructions
 188   //===--------------------------------------------------------------------===//
 189
 190   Constant *CreateSelect(Constant *C, Constant *True, Constant *False) const {
 191     return Fold(ConstantExpr::getSelect(C, True, False));
 192   }
 193
 194   Constant *CreateExtractElement(Constant *Vec, Constant *Idx) const {
 195     return Fold(ConstantExpr::getExtractElement(Vec, Idx));
 196   }
 197
 198   Constant *CreateInsertElement(Constant *Vec, Constant *NewElt,
 199                                 Constant *Idx) const {
 200     return Fold(ConstantExpr::getInsertElement(Vec, NewElt, Idx));
 201   }
 202
 203   Constant *CreateShuffleVector(Constant *V1, Constant *V2,
 204                                 Constant *Mask) const {
 205     return Fold(ConstantExpr::getShuffleVector(V1, V2, Mask));
 206   }
 207
 208   Constant *CreateExtractValue(Constant *Agg, const unsigned *IdxList,
 209                                unsigned NumIdx) const {
 210     return Fold(ConstantExpr::getExtractValue(Agg, IdxList, NumIdx));
 211   }
 212
 213   Constant *CreateInsertValue(Constant *Agg, Constant *Val,
 214                               const unsigned *IdxList, unsigned NumIdx) const {
 215     return Fold(ConstantExpr::getInsertValue(Agg, Val, IdxList, NumIdx));
 216   }
 217 };
 218
 219 }
 220
 221 #endif