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