1 //====-- llvm/Support/TargetFolder.h - Constant folding helper -*- 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 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.
17 //===----------------------------------------------------------------------===//
19 #ifndef LLVM_SUPPORT_TARGETFOLDER_H
20 #define LLVM_SUPPORT_TARGETFOLDER_H
22 #include "llvm/Constants.h"
23 #include "llvm/InstrTypes.h"
24 #include "llvm/ADT/ArrayRef.h"
25 #include "llvm/Analysis/ConstantFolding.h"
31 /// TargetFolder - Create constants with target dependent folding.
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, TD))
44 explicit TargetFolder(const TargetData *TheTD) : TD(TheTD) {}
46 //===--------------------------------------------------------------------===//
48 //===--------------------------------------------------------------------===//
50 Constant *CreateAdd(Constant *LHS, Constant *RHS,
51 bool HasNUW = false, bool HasNSW = false) const {
52 return Fold(ConstantExpr::getAdd(LHS, RHS, HasNUW, HasNSW));
54 Constant *CreateFAdd(Constant *LHS, Constant *RHS) const {
55 return Fold(ConstantExpr::getFAdd(LHS, RHS));
57 Constant *CreateSub(Constant *LHS, Constant *RHS,
58 bool HasNUW = false, bool HasNSW = false) const {
59 return Fold(ConstantExpr::getSub(LHS, RHS, HasNUW, HasNSW));
61 Constant *CreateFSub(Constant *LHS, Constant *RHS) const {
62 return Fold(ConstantExpr::getFSub(LHS, RHS));
64 Constant *CreateMul(Constant *LHS, Constant *RHS,
65 bool HasNUW = false, bool HasNSW = false) const {
66 return Fold(ConstantExpr::getMul(LHS, RHS, HasNUW, HasNSW));
68 Constant *CreateFMul(Constant *LHS, Constant *RHS) const {
69 return Fold(ConstantExpr::getFMul(LHS, RHS));
71 Constant *CreateUDiv(Constant *LHS, Constant *RHS, bool isExact = false)const{
72 return Fold(ConstantExpr::getUDiv(LHS, RHS, isExact));
74 Constant *CreateSDiv(Constant *LHS, Constant *RHS, bool isExact = false)const{
75 return Fold(ConstantExpr::getSDiv(LHS, RHS, isExact));
77 Constant *CreateFDiv(Constant *LHS, Constant *RHS) const {
78 return Fold(ConstantExpr::getFDiv(LHS, RHS));
80 Constant *CreateURem(Constant *LHS, Constant *RHS) const {
81 return Fold(ConstantExpr::getURem(LHS, RHS));
83 Constant *CreateSRem(Constant *LHS, Constant *RHS) const {
84 return Fold(ConstantExpr::getSRem(LHS, RHS));
86 Constant *CreateFRem(Constant *LHS, Constant *RHS) const {
87 return Fold(ConstantExpr::getFRem(LHS, RHS));
89 Constant *CreateShl(Constant *LHS, Constant *RHS,
90 bool HasNUW = false, bool HasNSW = false) const {
91 return Fold(ConstantExpr::getShl(LHS, RHS, HasNUW, HasNSW));
93 Constant *CreateLShr(Constant *LHS, Constant *RHS, bool isExact = false)const{
94 return Fold(ConstantExpr::getLShr(LHS, RHS, isExact));
96 Constant *CreateAShr(Constant *LHS, Constant *RHS, bool isExact = false)const{
97 return Fold(ConstantExpr::getAShr(LHS, RHS, isExact));
99 Constant *CreateAnd(Constant *LHS, Constant *RHS) const {
100 return Fold(ConstantExpr::getAnd(LHS, RHS));
102 Constant *CreateOr(Constant *LHS, Constant *RHS) const {
103 return Fold(ConstantExpr::getOr(LHS, RHS));
105 Constant *CreateXor(Constant *LHS, Constant *RHS) const {
106 return Fold(ConstantExpr::getXor(LHS, RHS));
109 Constant *CreateBinOp(Instruction::BinaryOps Opc,
110 Constant *LHS, Constant *RHS) const {
111 return Fold(ConstantExpr::get(Opc, LHS, RHS));
114 //===--------------------------------------------------------------------===//
116 //===--------------------------------------------------------------------===//
118 Constant *CreateNeg(Constant *C,
119 bool HasNUW = false, bool HasNSW = false) const {
120 return Fold(ConstantExpr::getNeg(C, HasNUW, HasNSW));
122 Constant *CreateFNeg(Constant *C) const {
123 return Fold(ConstantExpr::getFNeg(C));
125 Constant *CreateNot(Constant *C) const {
126 return Fold(ConstantExpr::getNot(C));
129 //===--------------------------------------------------------------------===//
130 // Memory Instructions
131 //===--------------------------------------------------------------------===//
133 Constant *CreateGetElementPtr(Constant *C,
134 ArrayRef<Constant *> IdxList) const {
135 return Fold(ConstantExpr::getGetElementPtr(C, IdxList));
137 Constant *CreateGetElementPtr(Constant *C, Constant *Idx) const {
138 // This form of the function only exists to avoid ambiguous overload
139 // warnings about whether to convert Idx to ArrayRef<Constant *> or
140 // ArrayRef<Value *>.
141 return Fold(ConstantExpr::getGetElementPtr(C, Idx));
143 Constant *CreateGetElementPtr(Constant *C,
144 ArrayRef<Value *> IdxList) const {
145 return Fold(ConstantExpr::getGetElementPtr(C, IdxList));
148 Constant *CreateInBoundsGetElementPtr(Constant *C,
149 ArrayRef<Constant *> IdxList) const {
150 return Fold(ConstantExpr::getInBoundsGetElementPtr(C, IdxList));
152 Constant *CreateInBoundsGetElementPtr(Constant *C, Constant *Idx) const {
153 // This form of the function only exists to avoid ambiguous overload
154 // warnings about whether to convert Idx to ArrayRef<Constant *> or
155 // ArrayRef<Value *>.
156 return Fold(ConstantExpr::getInBoundsGetElementPtr(C, Idx));
158 Constant *CreateInBoundsGetElementPtr(Constant *C,
159 ArrayRef<Value *> IdxList) const {
160 return Fold(ConstantExpr::getInBoundsGetElementPtr(C, IdxList));
163 //===--------------------------------------------------------------------===//
164 // Cast/Conversion Operators
165 //===--------------------------------------------------------------------===//
167 Constant *CreateCast(Instruction::CastOps Op, Constant *C,
168 Type *DestTy) const {
169 if (C->getType() == DestTy)
170 return C; // avoid calling Fold
171 return Fold(ConstantExpr::getCast(Op, C, DestTy));
173 Constant *CreateIntCast(Constant *C, Type *DestTy,
174 bool isSigned) const {
175 if (C->getType() == DestTy)
176 return C; // avoid calling Fold
177 return Fold(ConstantExpr::getIntegerCast(C, DestTy, isSigned));
179 Constant *CreatePointerCast(Constant *C, Type *DestTy) const {
180 return ConstantExpr::getPointerCast(C, DestTy);
182 Constant *CreateBitCast(Constant *C, Type *DestTy) const {
183 return CreateCast(Instruction::BitCast, C, DestTy);
185 Constant *CreateIntToPtr(Constant *C, Type *DestTy) const {
186 return CreateCast(Instruction::IntToPtr, C, DestTy);
188 Constant *CreatePtrToInt(Constant *C, Type *DestTy) const {
189 return CreateCast(Instruction::PtrToInt, C, DestTy);
191 Constant *CreateZExtOrBitCast(Constant *C, Type *DestTy) const {
192 if (C->getType() == DestTy)
193 return C; // avoid calling Fold
194 return Fold(ConstantExpr::getZExtOrBitCast(C, DestTy));
196 Constant *CreateSExtOrBitCast(Constant *C, Type *DestTy) const {
197 if (C->getType() == DestTy)
198 return C; // avoid calling Fold
199 return Fold(ConstantExpr::getSExtOrBitCast(C, DestTy));
201 Constant *CreateTruncOrBitCast(Constant *C, Type *DestTy) const {
202 if (C->getType() == DestTy)
203 return C; // avoid calling Fold
204 return Fold(ConstantExpr::getTruncOrBitCast(C, DestTy));
207 //===--------------------------------------------------------------------===//
208 // Compare Instructions
209 //===--------------------------------------------------------------------===//
211 Constant *CreateICmp(CmpInst::Predicate P, Constant *LHS,
212 Constant *RHS) const {
213 return Fold(ConstantExpr::getCompare(P, LHS, RHS));
215 Constant *CreateFCmp(CmpInst::Predicate P, Constant *LHS,
216 Constant *RHS) const {
217 return Fold(ConstantExpr::getCompare(P, LHS, RHS));
220 //===--------------------------------------------------------------------===//
221 // Other Instructions
222 //===--------------------------------------------------------------------===//
224 Constant *CreateSelect(Constant *C, Constant *True, Constant *False) const {
225 return Fold(ConstantExpr::getSelect(C, True, False));
228 Constant *CreateExtractElement(Constant *Vec, Constant *Idx) const {
229 return Fold(ConstantExpr::getExtractElement(Vec, Idx));
232 Constant *CreateInsertElement(Constant *Vec, Constant *NewElt,
233 Constant *Idx) const {
234 return Fold(ConstantExpr::getInsertElement(Vec, NewElt, Idx));
237 Constant *CreateShuffleVector(Constant *V1, Constant *V2,
238 Constant *Mask) const {
239 return Fold(ConstantExpr::getShuffleVector(V1, V2, Mask));
242 Constant *CreateExtractValue(Constant *Agg,
243 ArrayRef<unsigned> IdxList) const {
244 return Fold(ConstantExpr::getExtractValue(Agg, IdxList));
247 Constant *CreateInsertValue(Constant *Agg, Constant *Val,
248 ArrayRef<unsigned> IdxList) const {
249 return Fold(ConstantExpr::getInsertValue(Agg, Val, IdxList));