include/llvm/Support/ConstantFolder.h

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