Add utility routines for creating integer negation operators with NSW set.
[oota-llvm.git] / include / llvm / Support / NoFolder.h
1 //======-- llvm/Support/NoFolder.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 NoFolder class, a helper for IRBuilder.  It provides
11 // IRBuilder with a set of methods for creating unfolded constants.  This is
12 // useful for learners trying to understand how LLVM IR works, and who don't
13 // want details to be hidden by the constant folder.  For general constant
14 // creation and folding, use ConstantExpr and the routines in
15 // llvm/Analysis/ConstantFolding.h.
16 //
17 // Note: since it is not actually possible to create unfolded constants, this
18 // class returns values rather than constants.  The values do not have names,
19 // even if names were provided to IRBuilder, which may be confusing.
20 //
21 //===----------------------------------------------------------------------===//
22
23 #ifndef LLVM_SUPPORT_NOFOLDER_H
24 #define LLVM_SUPPORT_NOFOLDER_H
25
26 #include "llvm/Constants.h"
27 #include "llvm/Instructions.h"
28
29 namespace llvm {
30
31 class LLVMContext;
32
33 /// NoFolder - Create "constants" (actually, values) with no folding.
34 class NoFolder {
35 public:
36   explicit NoFolder(LLVMContext &) {}
37
38   //===--------------------------------------------------------------------===//
39   // Binary Operators
40   //===--------------------------------------------------------------------===//
41
42   Value *CreateAdd(Constant *LHS, Constant *RHS) const {
43     return BinaryOperator::CreateAdd(LHS, RHS);
44   }
45   Value *CreateNSWAdd(Constant *LHS, Constant *RHS) const {
46     return BinaryOperator::CreateNSWAdd(LHS, RHS);
47   }
48   Value *CreateFAdd(Constant *LHS, Constant *RHS) const {
49     return BinaryOperator::CreateFAdd(LHS, RHS);
50   }
51   Value *CreateSub(Constant *LHS, Constant *RHS) const {
52     return BinaryOperator::CreateSub(LHS, RHS);
53   }
54   Value *CreateNSWSub(Constant *LHS, Constant *RHS) const {
55     return BinaryOperator::CreateNSWSub(LHS, RHS);
56   }
57   Value *CreateFSub(Constant *LHS, Constant *RHS) const {
58     return BinaryOperator::CreateFSub(LHS, RHS);
59   }
60   Value *CreateMul(Constant *LHS, Constant *RHS) const {
61     return BinaryOperator::CreateMul(LHS, RHS);
62   }
63   Value *CreateFMul(Constant *LHS, Constant *RHS) const {
64     return BinaryOperator::CreateFMul(LHS, RHS);
65   }
66   Value *CreateUDiv(Constant *LHS, Constant *RHS) const {
67     return BinaryOperator::CreateUDiv(LHS, RHS);
68   }
69   Value *CreateSDiv(Constant *LHS, Constant *RHS) const {
70     return BinaryOperator::CreateSDiv(LHS, RHS);
71   }
72   Value *CreateExactSDiv(Constant *LHS, Constant *RHS) const {
73     return BinaryOperator::CreateExactSDiv(LHS, RHS);
74   }
75   Value *CreateFDiv(Constant *LHS, Constant *RHS) const {
76     return BinaryOperator::CreateFDiv(LHS, RHS);
77   }
78   Value *CreateURem(Constant *LHS, Constant *RHS) const {
79     return BinaryOperator::CreateURem(LHS, RHS);
80   }
81   Value *CreateSRem(Constant *LHS, Constant *RHS) const {
82     return BinaryOperator::CreateSRem(LHS, RHS);
83   }
84   Value *CreateFRem(Constant *LHS, Constant *RHS) const {
85     return BinaryOperator::CreateFRem(LHS, RHS);
86   }
87   Value *CreateShl(Constant *LHS, Constant *RHS) const {
88     return BinaryOperator::CreateShl(LHS, RHS);
89   }
90   Value *CreateLShr(Constant *LHS, Constant *RHS) const {
91     return BinaryOperator::CreateLShr(LHS, RHS);
92   }
93   Value *CreateAShr(Constant *LHS, Constant *RHS) const {
94     return BinaryOperator::CreateAShr(LHS, RHS);
95   }
96   Value *CreateAnd(Constant *LHS, Constant *RHS) const {
97     return BinaryOperator::CreateAnd(LHS, RHS);
98   }
99   Value *CreateOr(Constant *LHS, Constant *RHS) const {
100     return BinaryOperator::CreateOr(LHS, RHS);
101   }
102   Value *CreateXor(Constant *LHS, Constant *RHS) const {
103     return BinaryOperator::CreateXor(LHS, RHS);
104   }
105
106   Value *CreateBinOp(Instruction::BinaryOps Opc,
107                      Constant *LHS, Constant *RHS) const {
108     return BinaryOperator::Create(Opc, LHS, RHS);
109   }
110
111   //===--------------------------------------------------------------------===//
112   // Unary Operators
113   //===--------------------------------------------------------------------===//
114
115   Value *CreateNeg(Constant *C) const {
116     return BinaryOperator::CreateNeg(C);
117   }
118   Value *CreateNSWNeg(Constant *C) const {
119     return BinaryOperator::CreateNSWNeg(C);
120   }
121   Value *CreateNot(Constant *C) const {
122     return BinaryOperator::CreateNot(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   Value *CreateGetElementPtr(Constant *C, Value* const *IdxList,
134                              unsigned NumIdx) const {
135     return GetElementPtrInst::Create(C, IdxList, 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   Value *CreateInBoundsGetElementPtr(Constant *C, Value* const *IdxList,
143                                      unsigned NumIdx) const {
144     return GetElementPtrInst::CreateInBounds(C, IdxList, IdxList+NumIdx);
145   }
146
147   //===--------------------------------------------------------------------===//
148   // Cast/Conversion Operators
149   //===--------------------------------------------------------------------===//
150
151   Value *CreateCast(Instruction::CastOps Op, Constant *C,
152                     const Type *DestTy) const {
153     return CastInst::Create(Op, C, DestTy);
154   }
155   Value *CreateIntCast(Constant *C, const Type *DestTy,
156                        bool isSigned) const {
157     return CastInst::CreateIntegerCast(C, DestTy, isSigned);
158   }
159
160   //===--------------------------------------------------------------------===//
161   // Compare Instructions
162   //===--------------------------------------------------------------------===//
163
164   Value *CreateICmp(CmpInst::Predicate P, Constant *LHS, Constant *RHS) const {
165     return new ICmpInst(P, LHS, RHS);
166   }
167   Value *CreateFCmp(CmpInst::Predicate P, Constant *LHS, Constant *RHS) const {
168     return new FCmpInst(P, LHS, RHS);
169   }
170
171   //===--------------------------------------------------------------------===//
172   // Other Instructions
173   //===--------------------------------------------------------------------===//
174
175   Value *CreateSelect(Constant *C, Constant *True, Constant *False) const {
176     return SelectInst::Create(C, True, False);
177   }
178
179   Value *CreateExtractElement(Constant *Vec, Constant *Idx) const {
180     return ExtractElementInst::Create(Vec, Idx);
181   }
182
183   Value *CreateInsertElement(Constant *Vec, Constant *NewElt,
184                              Constant *Idx) const {
185     return InsertElementInst::Create(Vec, NewElt, Idx);
186   }
187
188   Value *CreateShuffleVector(Constant *V1, Constant *V2, Constant *Mask) const {
189     return new ShuffleVectorInst(V1, V2, Mask);
190   }
191
192   Value *CreateExtractValue(Constant *Agg, const unsigned *IdxList,
193                             unsigned NumIdx) const {
194     return ExtractValueInst::Create(Agg, IdxList, IdxList+NumIdx);
195   }
196
197   Value *CreateInsertValue(Constant *Agg, Constant *Val,
198                            const unsigned *IdxList, unsigned NumIdx) const {
199     return InsertValueInst::Create(Agg, Val, IdxList, IdxList+NumIdx);
200   }
201 };
202
203 }
204
205 #endif