TargetFolder.h revision 36b56886974eae4f9c5ebc96befd3e7bfe5de338 
1//====- 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_ANALYSIS_TARGETFOLDER_H
20#define LLVM_ANALYSIS_TARGETFOLDER_H
21
22#include "llvm/ADT/ArrayRef.h"
23#include "llvm/Analysis/ConstantFolding.h"
24#include "llvm/IR/Constants.h"
25#include "llvm/IR/InstrTypes.h"
26
27namespace llvm {
28
29class DataLayout;
30
31/// TargetFolder - Create constants with target dependent folding.
32class TargetFolder {
33  const DataLayout *DL;
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, DL))
39        return CF;
40    return C;
41  }
42
43public:
44  explicit TargetFolder(const DataLayout *DL) : DL(DL) {}
45
46  //===--------------------------------------------------------------------===//
47  // Binary Operators
48  //===--------------------------------------------------------------------===//
49
50  Constant *CreateAdd(Constant *LHS, Constant *RHS,
51                      bool HasNUW = false, bool HasNSW = false) const {
52    return Fold(ConstantExpr::getAdd(LHS, RHS, HasNUW, HasNSW));
53  }
54  Constant *CreateFAdd(Constant *LHS, Constant *RHS) const {
55    return Fold(ConstantExpr::getFAdd(LHS, RHS));
56  }
57  Constant *CreateSub(Constant *LHS, Constant *RHS,
58                      bool HasNUW = false, bool HasNSW = false) const {
59    return Fold(ConstantExpr::getSub(LHS, RHS, HasNUW, HasNSW));
60  }
61  Constant *CreateFSub(Constant *LHS, Constant *RHS) const {
62    return Fold(ConstantExpr::getFSub(LHS, RHS));
63  }
64  Constant *CreateMul(Constant *LHS, Constant *RHS,
65                      bool HasNUW = false, bool HasNSW = false) const {
66    return Fold(ConstantExpr::getMul(LHS, RHS, HasNUW, HasNSW));
67  }
68  Constant *CreateFMul(Constant *LHS, Constant *RHS) const {
69    return Fold(ConstantExpr::getFMul(LHS, RHS));
70  }
71  Constant *CreateUDiv(Constant *LHS, Constant *RHS, bool isExact = false)const{
72    return Fold(ConstantExpr::getUDiv(LHS, RHS, isExact));
73  }
74  Constant *CreateSDiv(Constant *LHS, Constant *RHS, bool isExact = false)const{
75    return Fold(ConstantExpr::getSDiv(LHS, RHS, isExact));
76  }
77  Constant *CreateFDiv(Constant *LHS, Constant *RHS) const {
78    return Fold(ConstantExpr::getFDiv(LHS, RHS));
79  }
80  Constant *CreateURem(Constant *LHS, Constant *RHS) const {
81    return Fold(ConstantExpr::getURem(LHS, RHS));
82  }
83  Constant *CreateSRem(Constant *LHS, Constant *RHS) const {
84    return Fold(ConstantExpr::getSRem(LHS, RHS));
85  }
86  Constant *CreateFRem(Constant *LHS, Constant *RHS) const {
87    return Fold(ConstantExpr::getFRem(LHS, RHS));
88  }
89  Constant *CreateShl(Constant *LHS, Constant *RHS,
90                      bool HasNUW = false, bool HasNSW = false) const {
91    return Fold(ConstantExpr::getShl(LHS, RHS, HasNUW, HasNSW));
92  }
93  Constant *CreateLShr(Constant *LHS, Constant *RHS, bool isExact = false)const{
94    return Fold(ConstantExpr::getLShr(LHS, RHS, isExact));
95  }
96  Constant *CreateAShr(Constant *LHS, Constant *RHS, bool isExact = false)const{
97    return Fold(ConstantExpr::getAShr(LHS, RHS, isExact));
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,
119                      bool HasNUW = false, bool HasNSW = false) const {
120    return Fold(ConstantExpr::getNeg(C, HasNUW, HasNSW));
121  }
122  Constant *CreateFNeg(Constant *C) const {
123    return Fold(ConstantExpr::getFNeg(C));
124  }
125  Constant *CreateNot(Constant *C) const {
126    return Fold(ConstantExpr::getNot(C));
127  }
128
129  //===--------------------------------------------------------------------===//
130  // Memory Instructions
131  //===--------------------------------------------------------------------===//
132
133  Constant *CreateGetElementPtr(Constant *C,
134                                ArrayRef<Constant *> IdxList) const {
135    return Fold(ConstantExpr::getGetElementPtr(C, IdxList));
136  }
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));
142  }
143  Constant *CreateGetElementPtr(Constant *C,
144                                ArrayRef<Value *> IdxList) const {
145    return Fold(ConstantExpr::getGetElementPtr(C, IdxList));
146  }
147
148  Constant *CreateInBoundsGetElementPtr(Constant *C,
149                                        ArrayRef<Constant *> IdxList) const {
150    return Fold(ConstantExpr::getInBoundsGetElementPtr(C, IdxList));
151  }
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));
157  }
158  Constant *CreateInBoundsGetElementPtr(Constant *C,
159                                        ArrayRef<Value *> IdxList) const {
160    return Fold(ConstantExpr::getInBoundsGetElementPtr(C, IdxList));
161  }
162
163  //===--------------------------------------------------------------------===//
164  // Cast/Conversion Operators
165  //===--------------------------------------------------------------------===//
166
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));
172  }
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));
178  }
179  Constant *CreatePointerCast(Constant *C, Type *DestTy) const {
180    if (C->getType() == DestTy)
181      return C; // avoid calling Fold
182    return Fold(ConstantExpr::getPointerCast(C, DestTy));
183  }
184  Constant *CreateFPCast(Constant *C, Type *DestTy) const {
185    if (C->getType() == DestTy)
186      return C; // avoid calling Fold
187    return Fold(ConstantExpr::getFPCast(C, DestTy));
188  }
189  Constant *CreateBitCast(Constant *C, Type *DestTy) const {
190    return CreateCast(Instruction::BitCast, C, DestTy);
191  }
192  Constant *CreateIntToPtr(Constant *C, Type *DestTy) const {
193    return CreateCast(Instruction::IntToPtr, C, DestTy);
194  }
195  Constant *CreatePtrToInt(Constant *C, Type *DestTy) const {
196    return CreateCast(Instruction::PtrToInt, C, DestTy);
197  }
198  Constant *CreateZExtOrBitCast(Constant *C, Type *DestTy) const {
199    if (C->getType() == DestTy)
200      return C; // avoid calling Fold
201    return Fold(ConstantExpr::getZExtOrBitCast(C, DestTy));
202  }
203  Constant *CreateSExtOrBitCast(Constant *C, Type *DestTy) const {
204    if (C->getType() == DestTy)
205      return C; // avoid calling Fold
206    return Fold(ConstantExpr::getSExtOrBitCast(C, DestTy));
207  }
208  Constant *CreateTruncOrBitCast(Constant *C, Type *DestTy) const {
209    if (C->getType() == DestTy)
210      return C; // avoid calling Fold
211    return Fold(ConstantExpr::getTruncOrBitCast(C, DestTy));
212  }
213
214  //===--------------------------------------------------------------------===//
215  // Compare Instructions
216  //===--------------------------------------------------------------------===//
217
218  Constant *CreateICmp(CmpInst::Predicate P, Constant *LHS,
219                       Constant *RHS) const {
220    return Fold(ConstantExpr::getCompare(P, LHS, RHS));
221  }
222  Constant *CreateFCmp(CmpInst::Predicate P, Constant *LHS,
223                       Constant *RHS) const {
224    return Fold(ConstantExpr::getCompare(P, LHS, RHS));
225  }
226
227  //===--------------------------------------------------------------------===//
228  // Other Instructions
229  //===--------------------------------------------------------------------===//
230
231  Constant *CreateSelect(Constant *C, Constant *True, Constant *False) const {
232    return Fold(ConstantExpr::getSelect(C, True, False));
233  }
234
235  Constant *CreateExtractElement(Constant *Vec, Constant *Idx) const {
236    return Fold(ConstantExpr::getExtractElement(Vec, Idx));
237  }
238
239  Constant *CreateInsertElement(Constant *Vec, Constant *NewElt,
240                                Constant *Idx) const {
241    return Fold(ConstantExpr::getInsertElement(Vec, NewElt, Idx));
242  }
243
244  Constant *CreateShuffleVector(Constant *V1, Constant *V2,
245                                Constant *Mask) const {
246    return Fold(ConstantExpr::getShuffleVector(V1, V2, Mask));
247  }
248
249  Constant *CreateExtractValue(Constant *Agg,
250                               ArrayRef<unsigned> IdxList) const {
251    return Fold(ConstantExpr::getExtractValue(Agg, IdxList));
252  }
253
254  Constant *CreateInsertValue(Constant *Agg, Constant *Val,
255                              ArrayRef<unsigned> IdxList) const {
256    return Fold(ConstantExpr::getInsertValue(Agg, Val, IdxList));
257  }
258};
259
260}
261
262#endif
263