LLVM  9.0.0svn
ConstantFolder.h
Go to the documentation of this file.
1 //===- ConstantFolder.h - Constant folding helper ---------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file defines the ConstantFolder class, a helper for IRBuilder.
10 // It provides IRBuilder with a set of methods for creating constants
11 // with minimal folding. For general constant creation and folding,
12 // use ConstantExpr and the routines in llvm/Analysis/ConstantFolding.h.
13 //
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_IR_CONSTANTFOLDER_H
17 #define LLVM_IR_CONSTANTFOLDER_H
18 
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/IR/Constants.h"
21 #include "llvm/IR/InstrTypes.h"
22 #include "llvm/IR/Instruction.h"
23 
24 namespace llvm {
25 
26 /// ConstantFolder - Create constants with minimum, target independent, folding.
28 public:
29  explicit ConstantFolder() = default;
30 
31  //===--------------------------------------------------------------------===//
32  // Binary Operators
33  //===--------------------------------------------------------------------===//
34 
36  bool HasNUW = false, bool HasNSW = false) const {
37  return ConstantExpr::getAdd(LHS, RHS, HasNUW, HasNSW);
38  }
39 
40  Constant *CreateFAdd(Constant *LHS, Constant *RHS) const {
41  return ConstantExpr::getFAdd(LHS, RHS);
42  }
43 
45  bool HasNUW = false, bool HasNSW = false) const {
46  return ConstantExpr::getSub(LHS, RHS, HasNUW, HasNSW);
47  }
48 
49  Constant *CreateFSub(Constant *LHS, Constant *RHS) const {
50  return ConstantExpr::getFSub(LHS, RHS);
51  }
52 
54  bool HasNUW = false, bool HasNSW = false) const {
55  return ConstantExpr::getMul(LHS, RHS, HasNUW, HasNSW);
56  }
57 
58  Constant *CreateFMul(Constant *LHS, Constant *RHS) const {
59  return ConstantExpr::getFMul(LHS, RHS);
60  }
61 
63  bool isExact = false) const {
64  return ConstantExpr::getUDiv(LHS, RHS, isExact);
65  }
66 
68  bool isExact = false) const {
69  return ConstantExpr::getSDiv(LHS, RHS, isExact);
70  }
71 
72  Constant *CreateFDiv(Constant *LHS, Constant *RHS) const {
73  return ConstantExpr::getFDiv(LHS, RHS);
74  }
75 
76  Constant *CreateURem(Constant *LHS, Constant *RHS) const {
77  return ConstantExpr::getURem(LHS, RHS);
78  }
79 
80  Constant *CreateSRem(Constant *LHS, Constant *RHS) const {
81  return ConstantExpr::getSRem(LHS, RHS);
82  }
83 
84  Constant *CreateFRem(Constant *LHS, Constant *RHS) const {
85  return ConstantExpr::getFRem(LHS, RHS);
86  }
87 
89  bool HasNUW = false, bool HasNSW = false) const {
90  return ConstantExpr::getShl(LHS, RHS, HasNUW, HasNSW);
91  }
92 
94  bool isExact = false) const {
95  return ConstantExpr::getLShr(LHS, RHS, isExact);
96  }
97 
99  bool isExact = false) const {
100  return ConstantExpr::getAShr(LHS, RHS, isExact);
101  }
102 
103  Constant *CreateAnd(Constant *LHS, Constant *RHS) const {
104  return ConstantExpr::getAnd(LHS, RHS);
105  }
106 
107  Constant *CreateOr(Constant *LHS, Constant *RHS) const {
108  return ConstantExpr::getOr(LHS, RHS);
109  }
110 
111  Constant *CreateXor(Constant *LHS, Constant *RHS) const {
112  return ConstantExpr::getXor(LHS, RHS);
113  }
114 
116  Constant *LHS, Constant *RHS) const {
117  return ConstantExpr::get(Opc, LHS, RHS);
118  }
119 
120  //===--------------------------------------------------------------------===//
121  // Unary Operators
122  //===--------------------------------------------------------------------===//
123 
125  bool HasNUW = false, bool HasNSW = false) const {
126  return ConstantExpr::getNeg(C, HasNUW, HasNSW);
127  }
128 
130  return ConstantExpr::getFNeg(C);
131  }
132 
134  return ConstantExpr::getNot(C);
135  }
136 
137  //===--------------------------------------------------------------------===//
138  // Memory Instructions
139  //===--------------------------------------------------------------------===//
140 
142  ArrayRef<Constant *> IdxList) const {
143  return ConstantExpr::getGetElementPtr(Ty, C, IdxList);
144  }
145 
147  // This form of the function only exists to avoid ambiguous overload
148  // warnings about whether to convert Idx to ArrayRef<Constant *> or
149  // ArrayRef<Value *>.
150  return ConstantExpr::getGetElementPtr(Ty, C, Idx);
151  }
152 
154  ArrayRef<Value *> IdxList) const {
155  return ConstantExpr::getGetElementPtr(Ty, C, IdxList);
156  }
157 
159  ArrayRef<Constant *> IdxList) const {
160  return ConstantExpr::getInBoundsGetElementPtr(Ty, C, IdxList);
161  }
162 
164  Constant *Idx) const {
165  // This form of the function only exists to avoid ambiguous overload
166  // warnings about whether to convert Idx to ArrayRef<Constant *> or
167  // ArrayRef<Value *>.
168  return ConstantExpr::getInBoundsGetElementPtr(Ty, C, Idx);
169  }
170 
172  ArrayRef<Value *> IdxList) const {
173  return ConstantExpr::getInBoundsGetElementPtr(Ty, C, IdxList);
174  }
175 
176  //===--------------------------------------------------------------------===//
177  // Cast/Conversion Operators
178  //===--------------------------------------------------------------------===//
179 
181  Type *DestTy) const {
182  return ConstantExpr::getCast(Op, C, DestTy);
183  }
184 
186  return ConstantExpr::getPointerCast(C, DestTy);
187  }
188 
190  Type *DestTy) const {
192  }
193 
195  bool isSigned) const {
196  return ConstantExpr::getIntegerCast(C, DestTy, isSigned);
197  }
198 
199  Constant *CreateFPCast(Constant *C, Type *DestTy) const {
200  return ConstantExpr::getFPCast(C, DestTy);
201  }
202 
203  Constant *CreateBitCast(Constant *C, Type *DestTy) const {
204  return CreateCast(Instruction::BitCast, C, DestTy);
205  }
206 
207  Constant *CreateIntToPtr(Constant *C, Type *DestTy) const {
208  return CreateCast(Instruction::IntToPtr, C, DestTy);
209  }
210 
211  Constant *CreatePtrToInt(Constant *C, Type *DestTy) const {
212  return CreateCast(Instruction::PtrToInt, C, DestTy);
213  }
214 
216  return ConstantExpr::getZExtOrBitCast(C, DestTy);
217  }
218 
220  return ConstantExpr::getSExtOrBitCast(C, DestTy);
221  }
222 
224  return ConstantExpr::getTruncOrBitCast(C, DestTy);
225  }
226 
227  //===--------------------------------------------------------------------===//
228  // Compare Instructions
229  //===--------------------------------------------------------------------===//
230 
232  Constant *RHS) const {
233  return ConstantExpr::getCompare(P, LHS, RHS);
234  }
235 
237  Constant *RHS) const {
238  return ConstantExpr::getCompare(P, LHS, RHS);
239  }
240 
241  //===--------------------------------------------------------------------===//
242  // Other Instructions
243  //===--------------------------------------------------------------------===//
244 
245  Constant *CreateSelect(Constant *C, Constant *True, Constant *False) const {
246  return ConstantExpr::getSelect(C, True, False);
247  }
248 
250  return ConstantExpr::getExtractElement(Vec, Idx);
251  }
252 
254  Constant *Idx) const {
255  return ConstantExpr::getInsertElement(Vec, NewElt, Idx);
256  }
257 
259  Constant *Mask) const {
260  return ConstantExpr::getShuffleVector(V1, V2, Mask);
261  }
262 
264  ArrayRef<unsigned> IdxList) const {
265  return ConstantExpr::getExtractValue(Agg, IdxList);
266  }
267 
269  ArrayRef<unsigned> IdxList) const {
270  return ConstantExpr::getInsertValue(Agg, Val, IdxList);
271  }
272 };
273 
274 } // end namespace llvm
275 
276 #endif // LLVM_IR_CONSTANTFOLDER_H
uint64_t CallInst * C
Constant * CreateSDiv(Constant *LHS, Constant *RHS, bool isExact=false) const
static Constant * getFAdd(Constant *C1, Constant *C2)
Definition: Constants.cpp:2244
Constant * CreateFNeg(Constant *C) const
static Constant * getPointerBitCastOrAddrSpaceCast(Constant *C, Type *Ty)
Create a BitCast or AddrSpaceCast for a pointer type depending on the address space.
Definition: Constants.cpp:1601
This class represents lattice values for constants.
Definition: AllocatorList.h:23
static Constant * getGetElementPtr(Type *Ty, Constant *C, ArrayRef< Constant *> IdxList, bool InBounds=false, Optional< unsigned > InRangeIndex=None, Type *OnlyIfReducedTy=nullptr)
Getelementptr form.
Definition: Constants.h:1153
Constant * CreateLShr(Constant *LHS, Constant *RHS, bool isExact=false) const
Constant * CreateBitCast(Constant *C, Type *DestTy) const
Constant * CreateFCmp(CmpInst::Predicate P, Constant *LHS, Constant *RHS) const
Constant * CreateIntCast(Constant *C, Type *DestTy, bool isSigned) const
Constant * CreateShl(Constant *LHS, Constant *RHS, bool HasNUW=false, bool HasNSW=false) const
static Constant * getExtractElement(Constant *Vec, Constant *Idx, Type *OnlyIfReducedTy=nullptr)
Definition: Constants.cpp:2102
Constant * CreateNot(Constant *C) const
Constant * CreateInBoundsGetElementPtr(Type *Ty, Constant *C, Constant *Idx) const
Constant * CreateICmp(CmpInst::Predicate P, Constant *LHS, Constant *RHS) const
Constant * CreatePtrToInt(Constant *C, Type *DestTy) const
static Constant * getCompare(unsigned short pred, Constant *C1, Constant *C2, bool OnlyIfReduced=false)
Return an ICmp or FCmp comparison operator constant expression.
Definition: Constants.cpp:1955
static Constant * getSub(Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
Definition: Constants.cpp:2248
Constant * CreateIntToPtr(Constant *C, Type *DestTy) const
Constant * CreateFRem(Constant *LHS, Constant *RHS) const
Constant * CreateSelect(Constant *C, Constant *True, Constant *False) const
static Constant * getInsertElement(Constant *Vec, Constant *Elt, Constant *Idx, Type *OnlyIfReducedTy=nullptr)
Definition: Constants.cpp:2124
static Constant * getAdd(Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
Definition: Constants.cpp:2237
static Constant * getFMul(Constant *C1, Constant *C2)
Definition: Constants.cpp:2266
static Constant * getIntegerCast(Constant *C, Type *Ty, bool isSigned)
Create a ZExt, Bitcast or Trunc for integer -> integer casts.
Definition: Constants.cpp:1612
Constant * CreateCast(Instruction::CastOps Op, Constant *C, Type *DestTy) const
Constant * CreateInBoundsGetElementPtr(Type *Ty, Constant *C, ArrayRef< Value *> IdxList) const
static Constant * getLShr(Constant *C1, Constant *C2, bool isExact=false)
Definition: Constants.cpp:2315
Constant * CreatePointerBitCastOrAddrSpaceCast(Constant *C, Type *DestTy) const
static Constant * getFPCast(Constant *C, Type *Ty)
Create a FPExt, Bitcast or FPTrunc for fp -> fp casts.
Definition: Constants.cpp:1624
static Constant * getAShr(Constant *C1, Constant *C2, bool isExact=false)
Definition: Constants.cpp:2320
Constant * CreateSExtOrBitCast(Constant *C, Type *DestTy) const
static Constant * getSelect(Constant *C, Constant *V1, Constant *V2, Type *OnlyIfReducedTy=nullptr)
Select constant expr.
Definition: Constants.cpp:1977
Constant * CreateExtractElement(Constant *Vec, Constant *Idx) const
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
ConstantFolder - Create constants with minimum, target independent, folding.
Constant * CreateGetElementPtr(Type *Ty, Constant *C, Constant *Idx) const
static Constant * getUDiv(Constant *C1, Constant *C2, bool isExact=false)
Definition: Constants.cpp:2270
Constant * CreateFDiv(Constant *LHS, Constant *RHS) const
static Constant * getFDiv(Constant *C1, Constant *C2)
Definition: Constants.cpp:2280
Constant * CreateFAdd(Constant *LHS, Constant *RHS) const
Constant * CreateInsertValue(Constant *Agg, Constant *Val, ArrayRef< unsigned > IdxList) const
static Constant * getInsertValue(Constant *Agg, Constant *Val, ArrayRef< unsigned > Idxs, Type *OnlyIfReducedTy=nullptr)
Definition: Constants.cpp:2170
Constant * CreateSub(Constant *LHS, Constant *RHS, bool HasNUW=false, bool HasNSW=false) const
#define P(N)
static Constant * getFNeg(Constant *C)
Definition: Constants.cpp:2225
static Constant * getFRem(Constant *C1, Constant *C2)
Definition: Constants.cpp:2292
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
This is an important base class in LLVM.
Definition: Constant.h:41
This file contains the declarations for the subclasses of Constant, which represent the different fla...
static Constant * getAnd(Constant *C1, Constant *C2)
Definition: Constants.cpp:2296
static Constant * getSExtOrBitCast(Constant *C, Type *Ty)
Definition: Constants.cpp:1574
static Constant * getShuffleVector(Constant *V1, Constant *V2, Constant *Mask, Type *OnlyIfReducedTy=nullptr)
Definition: Constants.cpp:2147
Constant * CreateZExtOrBitCast(Constant *C, Type *DestTy) const
Predicate
This enumeration lists the possible predicates for CmpInst subclasses.
Definition: InstrTypes.h:646
static Constant * getNot(Constant *C)
Definition: Constants.cpp:2231
Constant * CreateTruncOrBitCast(Constant *C, Type *DestTy) const
Constant * CreateFSub(Constant *LHS, Constant *RHS) const
Constant * CreateExtractValue(Constant *Agg, ArrayRef< unsigned > IdxList) const
static Constant * getPointerCast(Constant *C, Type *Ty)
Create a BitCast, AddrSpaceCast, or a PtrToInt cast constant expression.
Definition: Constants.cpp:1586
Constant * CreateGetElementPtr(Type *Ty, Constant *C, ArrayRef< Constant *> IdxList) const
Constant * CreateOr(Constant *LHS, Constant *RHS) const
static Constant * getSDiv(Constant *C1, Constant *C2, bool isExact=false)
Definition: Constants.cpp:2275
Constant * CreateBinOp(Instruction::BinaryOps Opc, Constant *LHS, Constant *RHS) const
Constant * CreateFPCast(Constant *C, Type *DestTy) const
Constant * CreateFMul(Constant *LHS, Constant *RHS) const
Constant * CreateAnd(Constant *LHS, Constant *RHS) const
Constant * CreateNeg(Constant *C, bool HasNUW=false, bool HasNSW=false) const
static Constant * getCast(unsigned ops, Constant *C, Type *Ty, bool OnlyIfReduced=false)
Convenience function for getting a Cast operation.
Definition: Constants.cpp:1529
static Constant * getZExtOrBitCast(Constant *C, Type *Ty)
Definition: Constants.cpp:1568
Constant * CreateSRem(Constant *LHS, Constant *RHS) const
static Constant * getFSub(Constant *C1, Constant *C2)
Definition: Constants.cpp:2255
static Constant * getTruncOrBitCast(Constant *C, Type *Ty)
Definition: Constants.cpp:1580
static Constant * getNeg(Constant *C, bool HasNUW=false, bool HasNSW=false)
Definition: Constants.cpp:2218
Constant * CreateInsertElement(Constant *Vec, Constant *NewElt, Constant *Idx) const
Constant * CreatePointerCast(Constant *C, Type *DestTy) const
Constant * CreateGetElementPtr(Type *Ty, Constant *C, ArrayRef< Value *> IdxList) const
Constant * CreateAShr(Constant *LHS, Constant *RHS, bool isExact=false) const
static Constant * getInBoundsGetElementPtr(Type *Ty, Constant *C, ArrayRef< Constant *> IdxList)
Create an "inbounds" getelementptr.
Definition: Constants.h:1180
static Constant * getOr(Constant *C1, Constant *C2)
Definition: Constants.cpp:2300
Constant * CreateInBoundsGetElementPtr(Type *Ty, Constant *C, ArrayRef< Constant *> IdxList) const
static Constant * getShl(Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
Definition: Constants.cpp:2308
Constant * CreateMul(Constant *LHS, Constant *RHS, bool HasNUW=false, bool HasNSW=false) const
Constant * CreateAdd(Constant *LHS, Constant *RHS, bool HasNUW=false, bool HasNSW=false) const
ConstantFolder()=default
static Constant * getSRem(Constant *C1, Constant *C2)
Definition: Constants.cpp:2288
Constant * CreateURem(Constant *LHS, Constant *RHS) const
static Constant * getURem(Constant *C1, Constant *C2)
Definition: Constants.cpp:2284
std::underlying_type< E >::type Mask()
Get a bitmask with 1s in all places up to the high-order bit of E&#39;s largest value.
Definition: BitmaskEnum.h:80
Constant * CreateUDiv(Constant *LHS, Constant *RHS, bool isExact=false) const
static Constant * getExtractValue(Constant *Agg, ArrayRef< unsigned > Idxs, Type *OnlyIfReducedTy=nullptr)
Definition: Constants.cpp:2194
Constant * CreateXor(Constant *LHS, Constant *RHS) const
static Constant * getMul(Constant *C1, Constant *C2, bool HasNUW=false, bool HasNSW=false)
Definition: Constants.cpp:2259
Constant * CreateShuffleVector(Constant *V1, Constant *V2, Constant *Mask) const
static Constant * getXor(Constant *C1, Constant *C2)
Definition: Constants.cpp:2304
static Constant * get(unsigned Opcode, Constant *C1, unsigned Flags=0, Type *OnlyIfReducedTy=nullptr)
get - Return a unary operator constant expression, folding if possible.
Definition: Constants.cpp:1805