Do not use global typedef for MDKindID.
[oota-llvm.git] / include / llvm / Support / IRBuilder.h
1 //===---- llvm/Support/IRBuilder.h - Builder for LLVM Instrs ----*- 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 IRBuilder class, which is used as a convenient way
11 // to create LLVM instructions with a consistent and simplified interface.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #ifndef LLVM_SUPPORT_IRBUILDER_H
16 #define LLVM_SUPPORT_IRBUILDER_H
17
18 #include "llvm/Constants.h"
19 #include "llvm/Instructions.h"
20 #include "llvm/GlobalAlias.h"
21 #include "llvm/GlobalVariable.h"
22 #include "llvm/Function.h"
23 #include "llvm/Metadata.h"
24 #include "llvm/LLVMContext.h"
25 #include "llvm/ADT/Twine.h"
26 #include "llvm/Support/ConstantFolder.h"
27
28 namespace llvm {
29
30 /// IRBuilderDefaultInserter - This provides the default implementation of the
31 /// IRBuilder 'InsertHelper' method that is called whenever an instruction is
32 /// created by IRBuilder and needs to be inserted.  By default, this inserts the
33 /// instruction at the insertion point.
34 template <bool preserveNames = true>
35 class IRBuilderDefaultInserter {
36 protected:
37   void InsertHelper(Instruction *I, const Twine &Name,
38                     BasicBlock *BB, BasicBlock::iterator InsertPt) const {
39     if (BB) BB->getInstList().insert(InsertPt, I);
40     if (preserveNames)
41       I->setName(Name);
42   }
43 };
44   
45   
46 /// IRBuilder - This provides a uniform API for creating instructions and
47 /// inserting them into a basic block: either at the end of a BasicBlock, or
48 /// at a specific iterator location in a block.
49 ///
50 /// Note that the builder does not expose the full generality of LLVM
51 /// instructions.  For access to extra instruction properties, use the mutators
52 /// (e.g. setVolatile) on the instructions after they have been created.
53 /// The first template argument handles whether or not to preserve names in the
54 /// final instruction output. This defaults to on.  The second template argument
55 /// specifies a class to use for creating constants.  This defaults to creating
56 /// minimally folded constants.  The fourth template argument allows clients to
57 /// specify custom insertion hooks that are called on every newly created
58 /// insertion.
59 template<bool preserveNames = true, typename T = ConstantFolder,
60          typename Inserter = IRBuilderDefaultInserter<preserveNames> >
61 class IRBuilder : public Inserter {
62   BasicBlock *BB;
63   BasicBlock::iterator InsertPt;
64   unsigned MDKind;
65   MDNode *CurDbgLocation;
66   LLVMContext &Context;
67   T Folder;
68 public:
69   IRBuilder(LLVMContext &C, const T &F, const Inserter &I = Inserter())
70     : Inserter(I), MDKind(0), CurDbgLocation(0), Context(C), Folder(F) {
71     ClearInsertionPoint(); 
72   }
73   
74   explicit IRBuilder(LLVMContext &C) 
75     : MDKind(0), CurDbgLocation(0), Context(C), Folder(C) {
76     ClearInsertionPoint();
77   }
78   
79   explicit IRBuilder(BasicBlock *TheBB, const T &F)
80     : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()), Folder(F) {
81     SetInsertPoint(TheBB);
82   }
83   
84   explicit IRBuilder(BasicBlock *TheBB)
85     : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()), 
86       Folder(Context) {
87     SetInsertPoint(TheBB);
88   }
89   
90   IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP, const T& F)
91     : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()), Folder(F) {
92     SetInsertPoint(TheBB, IP);
93   }
94   
95   IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP)
96     : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()), 
97       Folder(Context) {
98     SetInsertPoint(TheBB, IP);
99   }
100
101   /// getFolder - Get the constant folder being used.
102   const T &getFolder() { return Folder; }
103
104   /// isNamePreserving - Return true if this builder is configured to actually
105   /// add the requested names to IR created through it.
106   bool isNamePreserving() const { return preserveNames; }
107   
108   //===--------------------------------------------------------------------===//
109   // Builder configuration methods
110   //===--------------------------------------------------------------------===//
111
112   /// ClearInsertionPoint - Clear the insertion point: created instructions will
113   /// not be inserted into a block.
114   void ClearInsertionPoint() {
115     BB = 0;
116   }
117
118   BasicBlock *GetInsertBlock() const { return BB; }
119
120   BasicBlock::iterator GetInsertPoint() const { return InsertPt; }
121
122   /// SetInsertPoint - This specifies that created instructions should be
123   /// appended to the end of the specified block.
124   void SetInsertPoint(BasicBlock *TheBB) {
125     BB = TheBB;
126     InsertPt = BB->end();
127   }
128
129   /// SetInsertPoint - This specifies that created instructions should be
130   /// inserted at the specified point.
131   void SetInsertPoint(BasicBlock *TheBB, BasicBlock::iterator IP) {
132     BB = TheBB;
133     InsertPt = IP;
134   }
135
136   /// SetCurrentDebugLocation - Set location information used by debugging
137   /// information.
138   void SetCurrentDebugLocation(MDNode *L) {
139     if (MDKind == 0) 
140       MDKind = Context.getMetadata().getMDKind("dbg");
141     if (MDKind == 0)
142       MDKind = Context.getMetadata().RegisterMDKind("dbg");
143     CurDbgLocation = L;
144   }
145
146   MDNode *getCurrentDebugLocation() const { return CurDbgLocation; }
147
148   /// SetDebugLocation -  Set location information for the given instruction.
149   void SetDebugLocation(Instruction *I) {
150     if (CurDbgLocation)
151       Context.getMetadata().setMD(MDKind, CurDbgLocation, I);
152   }
153
154   /// Insert - Insert and return the specified instruction.
155   template<typename InstTy>
156   InstTy *Insert(InstTy *I, const Twine &Name = "") const {
157     this->InsertHelper(I, Name, BB, InsertPt);
158     if (CurDbgLocation)
159       Context.getMetadata().setMD(MDKind, CurDbgLocation, I);
160     return I;
161   }
162
163   //===--------------------------------------------------------------------===//
164   // Type creation methods
165   //===--------------------------------------------------------------------===//
166
167   /// getInt1Ty - Fetch the type representing a single bit
168   const Type *getInt1Ty() {
169     return Type::getInt1Ty(Context);
170   }
171   
172   /// getInt8Ty - Fetch the type representing an 8-bit integer.
173   const Type *getInt8Ty() {
174     return Type::getInt8Ty(Context);
175   }
176   
177   /// getInt16Ty - Fetch the type representing a 16-bit integer.
178   const Type *getInt16Ty() {
179     return Type::getInt16Ty(Context);
180   }
181   
182   /// getInt32Ty - Fetch the type resepresenting a 32-bit integer.
183   const Type *getInt32Ty() {
184     return Type::getInt32Ty(Context);
185   }
186   
187   /// getInt64Ty - Fetch the type representing a 64-bit integer.
188   const Type *getInt64Ty() {
189     return Type::getInt64Ty(Context);
190   }
191
192   /// getFloatTy - Fetch the type representing a 32-bit floating point value.
193   const Type *getFloatTy() {
194     return Type::getFloatTy(Context);
195   }
196   
197   /// getDoubleTy - Fetch the type representing a 64-bit floating point value.
198   const Type *getDoubleTy() {
199     return Type::getDoubleTy(Context);
200   }
201   
202   /// getVoidTy - Fetch the type representing void.
203   const Type *getVoidTy() {
204     return Type::getVoidTy(Context);
205   }
206
207   //===--------------------------------------------------------------------===//
208   // Instruction creation methods: Terminators
209   //===--------------------------------------------------------------------===//
210
211   /// CreateRetVoid - Create a 'ret void' instruction.
212   ReturnInst *CreateRetVoid() {
213     return Insert(ReturnInst::Create(Context));
214   }
215
216   /// @verbatim
217   /// CreateRet - Create a 'ret <val>' instruction.
218   /// @endverbatim
219   ReturnInst *CreateRet(Value *V) {
220     return Insert(ReturnInst::Create(Context, V));
221   }
222
223   /// CreateAggregateRet - Create a sequence of N insertvalue instructions,
224   /// with one Value from the retVals array each, that build a aggregate
225   /// return value one value at a time, and a ret instruction to return
226   /// the resulting aggregate value. This is a convenience function for
227   /// code that uses aggregate return values as a vehicle for having
228   /// multiple return values.
229   ///
230   ReturnInst *CreateAggregateRet(Value * const* retVals, unsigned N) {
231     const Type *RetType = BB->getParent()->getReturnType();
232     Value *V = UndefValue::get(RetType);
233     for (unsigned i = 0; i != N; ++i)
234       V = CreateInsertValue(V, retVals[i], i, "mrv");
235     return Insert(ReturnInst::Create(Context, V));
236   }
237
238   /// CreateBr - Create an unconditional 'br label X' instruction.
239   BranchInst *CreateBr(BasicBlock *Dest) {
240     return Insert(BranchInst::Create(Dest));
241   }
242
243   /// CreateCondBr - Create a conditional 'br Cond, TrueDest, FalseDest'
244   /// instruction.
245   BranchInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False) {
246     return Insert(BranchInst::Create(True, False, Cond));
247   }
248
249   /// CreateSwitch - Create a switch instruction with the specified value,
250   /// default dest, and with a hint for the number of cases that will be added
251   /// (for efficient allocation).
252   SwitchInst *CreateSwitch(Value *V, BasicBlock *Dest, unsigned NumCases = 10) {
253     return Insert(SwitchInst::Create(V, Dest, NumCases));
254   }
255
256   /// CreateInvoke - Create an invoke instruction.
257   template<typename InputIterator>
258   InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
259                            BasicBlock *UnwindDest, InputIterator ArgBegin,
260                            InputIterator ArgEnd, const Twine &Name = "") {
261     return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest,
262                                      ArgBegin, ArgEnd), Name);
263   }
264
265   UnwindInst *CreateUnwind() {
266     return Insert(new UnwindInst(Context));
267   }
268
269   UnreachableInst *CreateUnreachable() {
270     return Insert(new UnreachableInst(Context));
271   }
272
273   //===--------------------------------------------------------------------===//
274   // Instruction creation methods: Binary Operators
275   //===--------------------------------------------------------------------===//
276
277   Value *CreateAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
278     if (Constant *LC = dyn_cast<Constant>(LHS))
279       if (Constant *RC = dyn_cast<Constant>(RHS))
280         return Folder.CreateAdd(LC, RC);
281     return Insert(BinaryOperator::CreateAdd(LHS, RHS), Name);
282   }
283   Value *CreateNSWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
284     if (Constant *LC = dyn_cast<Constant>(LHS))
285       if (Constant *RC = dyn_cast<Constant>(RHS))
286         return Folder.CreateNSWAdd(LC, RC);
287     return Insert(BinaryOperator::CreateNSWAdd(LHS, RHS), Name);
288   }
289   Value *CreateFAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
290     if (Constant *LC = dyn_cast<Constant>(LHS))
291       if (Constant *RC = dyn_cast<Constant>(RHS))
292         return Folder.CreateFAdd(LC, RC);
293     return Insert(BinaryOperator::CreateFAdd(LHS, RHS), Name);
294   }
295   Value *CreateSub(Value *LHS, Value *RHS, const Twine &Name = "") {
296     if (Constant *LC = dyn_cast<Constant>(LHS))
297       if (Constant *RC = dyn_cast<Constant>(RHS))
298         return Folder.CreateSub(LC, RC);
299     return Insert(BinaryOperator::CreateSub(LHS, RHS), Name);
300   }
301   Value *CreateNSWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
302     if (Constant *LC = dyn_cast<Constant>(LHS))
303       if (Constant *RC = dyn_cast<Constant>(RHS))
304         return Folder.CreateNSWSub(LC, RC);
305     return Insert(BinaryOperator::CreateNSWSub(LHS, RHS), Name);
306   }
307   Value *CreateFSub(Value *LHS, Value *RHS, const Twine &Name = "") {
308     if (Constant *LC = dyn_cast<Constant>(LHS))
309       if (Constant *RC = dyn_cast<Constant>(RHS))
310         return Folder.CreateFSub(LC, RC);
311     return Insert(BinaryOperator::CreateFSub(LHS, RHS), Name);
312   }
313   Value *CreateMul(Value *LHS, Value *RHS, const Twine &Name = "") {
314     if (Constant *LC = dyn_cast<Constant>(LHS))
315       if (Constant *RC = dyn_cast<Constant>(RHS))
316         return Folder.CreateMul(LC, RC);
317     return Insert(BinaryOperator::CreateMul(LHS, RHS), Name);
318   }
319   Value *CreateFMul(Value *LHS, Value *RHS, const Twine &Name = "") {
320     if (Constant *LC = dyn_cast<Constant>(LHS))
321       if (Constant *RC = dyn_cast<Constant>(RHS))
322         return Folder.CreateFMul(LC, RC);
323     return Insert(BinaryOperator::CreateFMul(LHS, RHS), Name);
324   }
325   Value *CreateUDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
326     if (Constant *LC = dyn_cast<Constant>(LHS))
327       if (Constant *RC = dyn_cast<Constant>(RHS))
328         return Folder.CreateUDiv(LC, RC);
329     return Insert(BinaryOperator::CreateUDiv(LHS, RHS), Name);
330   }
331   Value *CreateSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
332     if (Constant *LC = dyn_cast<Constant>(LHS))
333       if (Constant *RC = dyn_cast<Constant>(RHS))
334         return Folder.CreateSDiv(LC, RC);
335     return Insert(BinaryOperator::CreateSDiv(LHS, RHS), Name);
336   }
337   Value *CreateExactSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
338     if (Constant *LC = dyn_cast<Constant>(LHS))
339       if (Constant *RC = dyn_cast<Constant>(RHS))
340         return Folder.CreateExactSDiv(LC, RC);
341     return Insert(BinaryOperator::CreateExactSDiv(LHS, RHS), Name);
342   }
343   Value *CreateFDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
344     if (Constant *LC = dyn_cast<Constant>(LHS))
345       if (Constant *RC = dyn_cast<Constant>(RHS))
346         return Folder.CreateFDiv(LC, RC);
347     return Insert(BinaryOperator::CreateFDiv(LHS, RHS), Name);
348   }
349   Value *CreateURem(Value *LHS, Value *RHS, const Twine &Name = "") {
350     if (Constant *LC = dyn_cast<Constant>(LHS))
351       if (Constant *RC = dyn_cast<Constant>(RHS))
352         return Folder.CreateURem(LC, RC);
353     return Insert(BinaryOperator::CreateURem(LHS, RHS), Name);
354   }
355   Value *CreateSRem(Value *LHS, Value *RHS, const Twine &Name = "") {
356     if (Constant *LC = dyn_cast<Constant>(LHS))
357       if (Constant *RC = dyn_cast<Constant>(RHS))
358         return Folder.CreateSRem(LC, RC);
359     return Insert(BinaryOperator::CreateSRem(LHS, RHS), Name);
360   }
361   Value *CreateFRem(Value *LHS, Value *RHS, const Twine &Name = "") {
362     if (Constant *LC = dyn_cast<Constant>(LHS))
363       if (Constant *RC = dyn_cast<Constant>(RHS))
364         return Folder.CreateFRem(LC, RC);
365     return Insert(BinaryOperator::CreateFRem(LHS, RHS), Name);
366   }
367   Value *CreateShl(Value *LHS, Value *RHS, const Twine &Name = "") {
368     if (Constant *LC = dyn_cast<Constant>(LHS))
369       if (Constant *RC = dyn_cast<Constant>(RHS))
370         return Folder.CreateShl(LC, RC);
371     return Insert(BinaryOperator::CreateShl(LHS, RHS), Name);
372   }
373   Value *CreateLShr(Value *LHS, Value *RHS, const Twine &Name = "") {
374     if (Constant *LC = dyn_cast<Constant>(LHS))
375       if (Constant *RC = dyn_cast<Constant>(RHS))
376         return Folder.CreateLShr(LC, RC);
377     return Insert(BinaryOperator::CreateLShr(LHS, RHS), Name);
378   }
379   Value *CreateAShr(Value *LHS, Value *RHS, const Twine &Name = "") {
380     if (Constant *LC = dyn_cast<Constant>(LHS))
381       if (Constant *RC = dyn_cast<Constant>(RHS))
382         return Folder.CreateAShr(LC, RC);
383     return Insert(BinaryOperator::CreateAShr(LHS, RHS), Name);
384   }
385   Value *CreateAnd(Value *LHS, Value *RHS, const Twine &Name = "") {
386     if (Constant *LC = dyn_cast<Constant>(LHS))
387       if (Constant *RC = dyn_cast<Constant>(RHS))
388         return Folder.CreateAnd(LC, RC);
389     return Insert(BinaryOperator::CreateAnd(LHS, RHS), Name);
390   }
391   Value *CreateOr(Value *LHS, Value *RHS, const Twine &Name = "") {
392     if (Constant *LC = dyn_cast<Constant>(LHS))
393       if (Constant *RC = dyn_cast<Constant>(RHS))
394         return Folder.CreateOr(LC, RC);
395     return Insert(BinaryOperator::CreateOr(LHS, RHS), Name);
396   }
397   Value *CreateXor(Value *LHS, Value *RHS, const Twine &Name = "") {
398     if (Constant *LC = dyn_cast<Constant>(LHS))
399       if (Constant *RC = dyn_cast<Constant>(RHS))
400         return Folder.CreateXor(LC, RC);
401     return Insert(BinaryOperator::CreateXor(LHS, RHS), Name);
402   }
403
404   Value *CreateBinOp(Instruction::BinaryOps Opc,
405                      Value *LHS, Value *RHS, const Twine &Name = "") {
406     if (Constant *LC = dyn_cast<Constant>(LHS))
407       if (Constant *RC = dyn_cast<Constant>(RHS))
408         return Folder.CreateBinOp(Opc, LC, RC);
409     return Insert(BinaryOperator::Create(Opc, LHS, RHS), Name);
410   }
411
412   Value *CreateNeg(Value *V, const Twine &Name = "") {
413     if (Constant *VC = dyn_cast<Constant>(V))
414       return Folder.CreateNeg(VC);
415     return Insert(BinaryOperator::CreateNeg(V), Name);
416   }
417   Value *CreateFNeg(Value *V, const Twine &Name = "") {
418     if (Constant *VC = dyn_cast<Constant>(V))
419       return Folder.CreateFNeg(VC);
420     return Insert(BinaryOperator::CreateFNeg(V), Name);
421   }
422   Value *CreateNot(Value *V, const Twine &Name = "") {
423     if (Constant *VC = dyn_cast<Constant>(V))
424       return Folder.CreateNot(VC);
425     return Insert(BinaryOperator::CreateNot(V), Name);
426   }
427
428   //===--------------------------------------------------------------------===//
429   // Instruction creation methods: Memory Instructions
430   //===--------------------------------------------------------------------===//
431
432   MallocInst *CreateMalloc(const Type *Ty, Value *ArraySize = 0,
433                            const Twine &Name = "") {
434     return Insert(new MallocInst(Ty, ArraySize), Name);
435   }
436   AllocaInst *CreateAlloca(const Type *Ty, Value *ArraySize = 0,
437                            const Twine &Name = "") {
438     return Insert(new AllocaInst(Ty, ArraySize), Name);
439   }
440   FreeInst *CreateFree(Value *Ptr) {
441     return Insert(new FreeInst(Ptr));
442   }
443   // Provided to resolve 'CreateLoad(Ptr, "...")' correctly, instead of
444   // converting the string to 'bool' for the isVolatile parameter.
445   LoadInst *CreateLoad(Value *Ptr, const char *Name) {
446     return Insert(new LoadInst(Ptr), Name);
447   }
448   LoadInst *CreateLoad(Value *Ptr, const Twine &Name = "") {
449     return Insert(new LoadInst(Ptr), Name);
450   }
451   LoadInst *CreateLoad(Value *Ptr, bool isVolatile, const Twine &Name = "") {
452     return Insert(new LoadInst(Ptr, 0, isVolatile), Name);
453   }
454   StoreInst *CreateStore(Value *Val, Value *Ptr, bool isVolatile = false) {
455     return Insert(new StoreInst(Val, Ptr, isVolatile));
456   }
457   template<typename InputIterator>
458   Value *CreateGEP(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
459                    const Twine &Name = "") {
460     if (Constant *PC = dyn_cast<Constant>(Ptr)) {
461       // Every index must be constant.
462       InputIterator i;
463       for (i = IdxBegin; i < IdxEnd; ++i)
464         if (!isa<Constant>(*i))
465           break;
466       if (i == IdxEnd)
467         return Folder.CreateGetElementPtr(PC, &IdxBegin[0], IdxEnd - IdxBegin);
468     }
469     return Insert(GetElementPtrInst::Create(Ptr, IdxBegin, IdxEnd), Name);
470   }
471   template<typename InputIterator>
472   Value *CreateInBoundsGEP(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
473                            const Twine &Name = "") {
474     if (Constant *PC = dyn_cast<Constant>(Ptr)) {
475       // Every index must be constant.
476       InputIterator i;
477       for (i = IdxBegin; i < IdxEnd; ++i)
478         if (!isa<Constant>(*i))
479           break;
480       if (i == IdxEnd)
481         return Folder.CreateInBoundsGetElementPtr(PC,
482                                                   &IdxBegin[0],
483                                                   IdxEnd - IdxBegin);
484     }
485     return Insert(GetElementPtrInst::CreateInBounds(Ptr, IdxBegin, IdxEnd),
486                   Name);
487   }
488   Value *CreateGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
489     if (Constant *PC = dyn_cast<Constant>(Ptr))
490       if (Constant *IC = dyn_cast<Constant>(Idx))
491         return Folder.CreateGetElementPtr(PC, &IC, 1);
492     return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
493   }
494   Value *CreateInBoundsGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
495     if (Constant *PC = dyn_cast<Constant>(Ptr))
496       if (Constant *IC = dyn_cast<Constant>(Idx))
497         return Folder.CreateInBoundsGetElementPtr(PC, &IC, 1);
498     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
499   }
500   Value *CreateConstGEP1_32(Value *Ptr, unsigned Idx0, const Twine &Name = "") {
501     Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
502
503     if (Constant *PC = dyn_cast<Constant>(Ptr))
504       return Folder.CreateGetElementPtr(PC, &Idx, 1);
505
506     return Insert(GetElementPtrInst::Create(Ptr, &Idx, &Idx+1), Name);    
507   }
508   Value *CreateConstInBoundsGEP1_32(Value *Ptr, unsigned Idx0,
509                                     const Twine &Name = "") {
510     Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
511
512     if (Constant *PC = dyn_cast<Constant>(Ptr))
513       return Folder.CreateInBoundsGetElementPtr(PC, &Idx, 1);
514
515     return Insert(GetElementPtrInst::CreateInBounds(Ptr, &Idx, &Idx+1), Name);
516   }
517   Value *CreateConstGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1, 
518                     const Twine &Name = "") {
519     Value *Idxs[] = {
520       ConstantInt::get(Type::getInt32Ty(Context), Idx0),
521       ConstantInt::get(Type::getInt32Ty(Context), Idx1)
522     };
523
524     if (Constant *PC = dyn_cast<Constant>(Ptr))
525       return Folder.CreateGetElementPtr(PC, Idxs, 2);
526
527     return Insert(GetElementPtrInst::Create(Ptr, Idxs, Idxs+2), Name);    
528   }
529   Value *CreateConstInBoundsGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
530                                     const Twine &Name = "") {
531     Value *Idxs[] = {
532       ConstantInt::get(Type::getInt32Ty(Context), Idx0),
533       ConstantInt::get(Type::getInt32Ty(Context), Idx1)
534     };
535
536     if (Constant *PC = dyn_cast<Constant>(Ptr))
537       return Folder.CreateInBoundsGetElementPtr(PC, Idxs, 2);
538
539     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs, Idxs+2), Name);
540   }
541   Value *CreateConstGEP1_64(Value *Ptr, uint64_t Idx0, const Twine &Name = "") {
542     Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
543
544     if (Constant *PC = dyn_cast<Constant>(Ptr))
545       return Folder.CreateGetElementPtr(PC, &Idx, 1);
546
547     return Insert(GetElementPtrInst::Create(Ptr, &Idx, &Idx+1), Name);    
548   }
549   Value *CreateConstInBoundsGEP1_64(Value *Ptr, uint64_t Idx0,
550                                     const Twine &Name = "") {
551     Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
552
553     if (Constant *PC = dyn_cast<Constant>(Ptr))
554       return Folder.CreateInBoundsGetElementPtr(PC, &Idx, 1);
555
556     return Insert(GetElementPtrInst::CreateInBounds(Ptr, &Idx, &Idx+1), Name);
557   }
558   Value *CreateConstGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
559                     const Twine &Name = "") {
560     Value *Idxs[] = {
561       ConstantInt::get(Type::getInt64Ty(Context), Idx0),
562       ConstantInt::get(Type::getInt64Ty(Context), Idx1)
563     };
564
565     if (Constant *PC = dyn_cast<Constant>(Ptr))
566       return Folder.CreateGetElementPtr(PC, Idxs, 2);
567
568     return Insert(GetElementPtrInst::Create(Ptr, Idxs, Idxs+2), Name);    
569   }
570   Value *CreateConstInBoundsGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
571                                     const Twine &Name = "") {
572     Value *Idxs[] = {
573       ConstantInt::get(Type::getInt64Ty(Context), Idx0),
574       ConstantInt::get(Type::getInt64Ty(Context), Idx1)
575     };
576
577     if (Constant *PC = dyn_cast<Constant>(Ptr))
578       return Folder.CreateInBoundsGetElementPtr(PC, Idxs, 2);
579
580     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs, Idxs+2), Name);
581   }
582   Value *CreateStructGEP(Value *Ptr, unsigned Idx, const Twine &Name = "") {
583     return CreateConstInBoundsGEP2_32(Ptr, 0, Idx, Name);
584   }
585   Value *CreateGlobalString(const char *Str = "", const Twine &Name = "") {
586     Constant *StrConstant = ConstantArray::get(Context, Str, true);
587     Module &M = *BB->getParent()->getParent();
588     GlobalVariable *gv = new GlobalVariable(M,
589                                             StrConstant->getType(),
590                                             true,
591                                             GlobalValue::InternalLinkage,
592                                             StrConstant,
593                                             "",
594                                             0,
595                                             false);
596     gv->setName(Name);
597     return gv;
598   }
599   Value *CreateGlobalStringPtr(const char *Str = "", const Twine &Name = "") {
600     Value *gv = CreateGlobalString(Str, Name);
601     Value *zero = ConstantInt::get(Type::getInt32Ty(Context), 0);
602     Value *Args[] = { zero, zero };
603     return CreateInBoundsGEP(gv, Args, Args+2, Name);
604   }
605   //===--------------------------------------------------------------------===//
606   // Instruction creation methods: Cast/Conversion Operators
607   //===--------------------------------------------------------------------===//
608
609   Value *CreateTrunc(Value *V, const Type *DestTy, const Twine &Name = "") {
610     return CreateCast(Instruction::Trunc, V, DestTy, Name);
611   }
612   Value *CreateZExt(Value *V, const Type *DestTy, const Twine &Name = "") {
613     return CreateCast(Instruction::ZExt, V, DestTy, Name);
614   }
615   Value *CreateSExt(Value *V, const Type *DestTy, const Twine &Name = "") {
616     return CreateCast(Instruction::SExt, V, DestTy, Name);
617   }
618   Value *CreateFPToUI(Value *V, const Type *DestTy, const Twine &Name = ""){
619     return CreateCast(Instruction::FPToUI, V, DestTy, Name);
620   }
621   Value *CreateFPToSI(Value *V, const Type *DestTy, const Twine &Name = ""){
622     return CreateCast(Instruction::FPToSI, V, DestTy, Name);
623   }
624   Value *CreateUIToFP(Value *V, const Type *DestTy, const Twine &Name = ""){
625     return CreateCast(Instruction::UIToFP, V, DestTy, Name);
626   }
627   Value *CreateSIToFP(Value *V, const Type *DestTy, const Twine &Name = ""){
628     return CreateCast(Instruction::SIToFP, V, DestTy, Name);
629   }
630   Value *CreateFPTrunc(Value *V, const Type *DestTy,
631                        const Twine &Name = "") {
632     return CreateCast(Instruction::FPTrunc, V, DestTy, Name);
633   }
634   Value *CreateFPExt(Value *V, const Type *DestTy, const Twine &Name = "") {
635     return CreateCast(Instruction::FPExt, V, DestTy, Name);
636   }
637   Value *CreatePtrToInt(Value *V, const Type *DestTy,
638                         const Twine &Name = "") {
639     return CreateCast(Instruction::PtrToInt, V, DestTy, Name);
640   }
641   Value *CreateIntToPtr(Value *V, const Type *DestTy,
642                         const Twine &Name = "") {
643     return CreateCast(Instruction::IntToPtr, V, DestTy, Name);
644   }
645   Value *CreateBitCast(Value *V, const Type *DestTy,
646                        const Twine &Name = "") {
647     return CreateCast(Instruction::BitCast, V, DestTy, Name);
648   }
649   Value *CreateZExtOrBitCast(Value *V, const Type *DestTy,
650                              const Twine &Name = "") {
651     if (V->getType() == DestTy)
652       return V;
653     if (Constant *VC = dyn_cast<Constant>(V))
654       return Folder.CreateZExtOrBitCast(VC, DestTy);
655     return Insert(CastInst::CreateZExtOrBitCast(V, DestTy), Name);
656   }
657   Value *CreateSExtOrBitCast(Value *V, const Type *DestTy,
658                              const Twine &Name = "") {
659     if (V->getType() == DestTy)
660       return V;
661     if (Constant *VC = dyn_cast<Constant>(V))
662       return Folder.CreateSExtOrBitCast(VC, DestTy);
663     return Insert(CastInst::CreateSExtOrBitCast(V, DestTy), Name);
664   }
665   Value *CreateTruncOrBitCast(Value *V, const Type *DestTy,
666                               const Twine &Name = "") {
667     if (V->getType() == DestTy)
668       return V;
669     if (Constant *VC = dyn_cast<Constant>(V))
670       return Folder.CreateTruncOrBitCast(VC, DestTy);
671     return Insert(CastInst::CreateTruncOrBitCast(V, DestTy), Name);
672   }
673   Value *CreateCast(Instruction::CastOps Op, Value *V, const Type *DestTy,
674                     const Twine &Name = "") {
675     if (V->getType() == DestTy)
676       return V;
677     if (Constant *VC = dyn_cast<Constant>(V))
678       return Folder.CreateCast(Op, VC, DestTy);
679     return Insert(CastInst::Create(Op, V, DestTy), Name);
680   }
681   Value *CreatePointerCast(Value *V, const Type *DestTy,
682                            const Twine &Name = "") {
683     if (V->getType() == DestTy)
684       return V;
685     if (Constant *VC = dyn_cast<Constant>(V))
686       return Folder.CreatePointerCast(VC, DestTy);
687     return Insert(CastInst::CreatePointerCast(V, DestTy), Name);
688   }
689   Value *CreateIntCast(Value *V, const Type *DestTy, bool isSigned,
690                        const Twine &Name = "") {
691     if (V->getType() == DestTy)
692       return V;
693     if (Constant *VC = dyn_cast<Constant>(V))
694       return Folder.CreateIntCast(VC, DestTy, isSigned);
695     return Insert(CastInst::CreateIntegerCast(V, DestTy, isSigned), Name);
696   }
697   Value *CreateFPCast(Value *V, const Type *DestTy, const Twine &Name = "") {
698     if (V->getType() == DestTy)
699       return V;
700     if (Constant *VC = dyn_cast<Constant>(V))
701       return Folder.CreateFPCast(VC, DestTy);
702     return Insert(CastInst::CreateFPCast(V, DestTy), Name);
703   }
704
705   //===--------------------------------------------------------------------===//
706   // Instruction creation methods: Compare Instructions
707   //===--------------------------------------------------------------------===//
708
709   Value *CreateICmpEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
710     return CreateICmp(ICmpInst::ICMP_EQ, LHS, RHS, Name);
711   }
712   Value *CreateICmpNE(Value *LHS, Value *RHS, const Twine &Name = "") {
713     return CreateICmp(ICmpInst::ICMP_NE, LHS, RHS, Name);
714   }
715   Value *CreateICmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
716     return CreateICmp(ICmpInst::ICMP_UGT, LHS, RHS, Name);
717   }
718   Value *CreateICmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
719     return CreateICmp(ICmpInst::ICMP_UGE, LHS, RHS, Name);
720   }
721   Value *CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
722     return CreateICmp(ICmpInst::ICMP_ULT, LHS, RHS, Name);
723   }
724   Value *CreateICmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
725     return CreateICmp(ICmpInst::ICMP_ULE, LHS, RHS, Name);
726   }
727   Value *CreateICmpSGT(Value *LHS, Value *RHS, const Twine &Name = "") {
728     return CreateICmp(ICmpInst::ICMP_SGT, LHS, RHS, Name);
729   }
730   Value *CreateICmpSGE(Value *LHS, Value *RHS, const Twine &Name = "") {
731     return CreateICmp(ICmpInst::ICMP_SGE, LHS, RHS, Name);
732   }
733   Value *CreateICmpSLT(Value *LHS, Value *RHS, const Twine &Name = "") {
734     return CreateICmp(ICmpInst::ICMP_SLT, LHS, RHS, Name);
735   }
736   Value *CreateICmpSLE(Value *LHS, Value *RHS, const Twine &Name = "") {
737     return CreateICmp(ICmpInst::ICMP_SLE, LHS, RHS, Name);
738   }
739
740   Value *CreateFCmpOEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
741     return CreateFCmp(FCmpInst::FCMP_OEQ, LHS, RHS, Name);
742   }
743   Value *CreateFCmpOGT(Value *LHS, Value *RHS, const Twine &Name = "") {
744     return CreateFCmp(FCmpInst::FCMP_OGT, LHS, RHS, Name);
745   }
746   Value *CreateFCmpOGE(Value *LHS, Value *RHS, const Twine &Name = "") {
747     return CreateFCmp(FCmpInst::FCMP_OGE, LHS, RHS, Name);
748   }
749   Value *CreateFCmpOLT(Value *LHS, Value *RHS, const Twine &Name = "") {
750     return CreateFCmp(FCmpInst::FCMP_OLT, LHS, RHS, Name);
751   }
752   Value *CreateFCmpOLE(Value *LHS, Value *RHS, const Twine &Name = "") {
753     return CreateFCmp(FCmpInst::FCMP_OLE, LHS, RHS, Name);
754   }
755   Value *CreateFCmpONE(Value *LHS, Value *RHS, const Twine &Name = "") {
756     return CreateFCmp(FCmpInst::FCMP_ONE, LHS, RHS, Name);
757   }
758   Value *CreateFCmpORD(Value *LHS, Value *RHS, const Twine &Name = "") {
759     return CreateFCmp(FCmpInst::FCMP_ORD, LHS, RHS, Name);
760   }
761   Value *CreateFCmpUNO(Value *LHS, Value *RHS, const Twine &Name = "") {
762     return CreateFCmp(FCmpInst::FCMP_UNO, LHS, RHS, Name);
763   }
764   Value *CreateFCmpUEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
765     return CreateFCmp(FCmpInst::FCMP_UEQ, LHS, RHS, Name);
766   }
767   Value *CreateFCmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
768     return CreateFCmp(FCmpInst::FCMP_UGT, LHS, RHS, Name);
769   }
770   Value *CreateFCmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
771     return CreateFCmp(FCmpInst::FCMP_UGE, LHS, RHS, Name);
772   }
773   Value *CreateFCmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
774     return CreateFCmp(FCmpInst::FCMP_ULT, LHS, RHS, Name);
775   }
776   Value *CreateFCmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
777     return CreateFCmp(FCmpInst::FCMP_ULE, LHS, RHS, Name);
778   }
779   Value *CreateFCmpUNE(Value *LHS, Value *RHS, const Twine &Name = "") {
780     return CreateFCmp(FCmpInst::FCMP_UNE, LHS, RHS, Name);
781   }
782
783   Value *CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
784                     const Twine &Name = "") {
785     if (Constant *LC = dyn_cast<Constant>(LHS))
786       if (Constant *RC = dyn_cast<Constant>(RHS))
787         return Folder.CreateICmp(P, LC, RC);
788     return Insert(new ICmpInst(P, LHS, RHS), Name);
789   }
790   Value *CreateFCmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
791                     const Twine &Name = "") {
792     if (Constant *LC = dyn_cast<Constant>(LHS))
793       if (Constant *RC = dyn_cast<Constant>(RHS))
794         return Folder.CreateFCmp(P, LC, RC);
795     return Insert(new FCmpInst(P, LHS, RHS), Name);
796   }
797
798   //===--------------------------------------------------------------------===//
799   // Instruction creation methods: Other Instructions
800   //===--------------------------------------------------------------------===//
801
802   PHINode *CreatePHI(const Type *Ty, const Twine &Name = "") {
803     return Insert(PHINode::Create(Ty), Name);
804   }
805
806   CallInst *CreateCall(Value *Callee, const Twine &Name = "") {
807     return Insert(CallInst::Create(Callee), Name);
808   }
809   CallInst *CreateCall(Value *Callee, Value *Arg, const Twine &Name = "") {
810     return Insert(CallInst::Create(Callee, Arg), Name);
811   }
812   CallInst *CreateCall2(Value *Callee, Value *Arg1, Value *Arg2,
813                         const Twine &Name = "") {
814     Value *Args[] = { Arg1, Arg2 };
815     return Insert(CallInst::Create(Callee, Args, Args+2), Name);
816   }
817   CallInst *CreateCall3(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
818                         const Twine &Name = "") {
819     Value *Args[] = { Arg1, Arg2, Arg3 };
820     return Insert(CallInst::Create(Callee, Args, Args+3), Name);
821   }
822   CallInst *CreateCall4(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
823                         Value *Arg4, const Twine &Name = "") {
824     Value *Args[] = { Arg1, Arg2, Arg3, Arg4 };
825     return Insert(CallInst::Create(Callee, Args, Args+4), Name);
826   }
827
828   template<typename InputIterator>
829   CallInst *CreateCall(Value *Callee, InputIterator ArgBegin,
830                        InputIterator ArgEnd, const Twine &Name = "") {
831     return Insert(CallInst::Create(Callee, ArgBegin, ArgEnd), Name);
832   }
833
834   Value *CreateSelect(Value *C, Value *True, Value *False,
835                       const Twine &Name = "") {
836     if (Constant *CC = dyn_cast<Constant>(C))
837       if (Constant *TC = dyn_cast<Constant>(True))
838         if (Constant *FC = dyn_cast<Constant>(False))
839           return Folder.CreateSelect(CC, TC, FC);
840     return Insert(SelectInst::Create(C, True, False), Name);
841   }
842
843   VAArgInst *CreateVAArg(Value *List, const Type *Ty, const Twine &Name = "") {
844     return Insert(new VAArgInst(List, Ty), Name);
845   }
846
847   Value *CreateExtractElement(Value *Vec, Value *Idx,
848                               const Twine &Name = "") {
849     if (Constant *VC = dyn_cast<Constant>(Vec))
850       if (Constant *IC = dyn_cast<Constant>(Idx))
851         return Folder.CreateExtractElement(VC, IC);
852     return Insert(ExtractElementInst::Create(Vec, Idx), Name);
853   }
854
855   Value *CreateInsertElement(Value *Vec, Value *NewElt, Value *Idx,
856                              const Twine &Name = "") {
857     if (Constant *VC = dyn_cast<Constant>(Vec))
858       if (Constant *NC = dyn_cast<Constant>(NewElt))
859         if (Constant *IC = dyn_cast<Constant>(Idx))
860           return Folder.CreateInsertElement(VC, NC, IC);
861     return Insert(InsertElementInst::Create(Vec, NewElt, Idx), Name);
862   }
863
864   Value *CreateShuffleVector(Value *V1, Value *V2, Value *Mask,
865                              const Twine &Name = "") {
866     if (Constant *V1C = dyn_cast<Constant>(V1))
867       if (Constant *V2C = dyn_cast<Constant>(V2))
868         if (Constant *MC = dyn_cast<Constant>(Mask))
869           return Folder.CreateShuffleVector(V1C, V2C, MC);
870     return Insert(new ShuffleVectorInst(V1, V2, Mask), Name);
871   }
872
873   Value *CreateExtractValue(Value *Agg, unsigned Idx,
874                             const Twine &Name = "") {
875     if (Constant *AggC = dyn_cast<Constant>(Agg))
876       return Folder.CreateExtractValue(AggC, &Idx, 1);
877     return Insert(ExtractValueInst::Create(Agg, Idx), Name);
878   }
879
880   template<typename InputIterator>
881   Value *CreateExtractValue(Value *Agg,
882                             InputIterator IdxBegin,
883                             InputIterator IdxEnd,
884                             const Twine &Name = "") {
885     if (Constant *AggC = dyn_cast<Constant>(Agg))
886       return Folder.CreateExtractValue(AggC, IdxBegin, IdxEnd - IdxBegin);
887     return Insert(ExtractValueInst::Create(Agg, IdxBegin, IdxEnd), Name);
888   }
889
890   Value *CreateInsertValue(Value *Agg, Value *Val, unsigned Idx,
891                            const Twine &Name = "") {
892     if (Constant *AggC = dyn_cast<Constant>(Agg))
893       if (Constant *ValC = dyn_cast<Constant>(Val))
894         return Folder.CreateInsertValue(AggC, ValC, &Idx, 1);
895     return Insert(InsertValueInst::Create(Agg, Val, Idx), Name);
896   }
897
898   template<typename InputIterator>
899   Value *CreateInsertValue(Value *Agg, Value *Val,
900                            InputIterator IdxBegin,
901                            InputIterator IdxEnd,
902                            const Twine &Name = "") {
903     if (Constant *AggC = dyn_cast<Constant>(Agg))
904       if (Constant *ValC = dyn_cast<Constant>(Val))
905         return Folder.CreateInsertValue(AggC, ValC, IdxBegin, IdxEnd-IdxBegin);
906     return Insert(InsertValueInst::Create(Agg, Val, IdxBegin, IdxEnd), Name);
907   }
908
909   //===--------------------------------------------------------------------===//
910   // Utility creation methods
911   //===--------------------------------------------------------------------===//
912
913   /// CreateIsNull - Return an i1 value testing if \arg Arg is null.
914   Value *CreateIsNull(Value *Arg, const Twine &Name = "") {
915     return CreateICmpEQ(Arg, Constant::getNullValue(Arg->getType()),
916                         Name);
917   }
918
919   /// CreateIsNotNull - Return an i1 value testing if \arg Arg is not null.
920   Value *CreateIsNotNull(Value *Arg, const Twine &Name = "") {
921     return CreateICmpNE(Arg, Constant::getNullValue(Arg->getType()),
922                         Name);
923   }
924
925   /// CreatePtrDiff - Return the i64 difference between two pointer values,
926   /// dividing out the size of the pointed-to objects.  This is intended to
927   /// implement C-style pointer subtraction. As such, the pointers must be
928   /// appropriately aligned for their element types and pointing into the
929   /// same object.
930   Value *CreatePtrDiff(Value *LHS, Value *RHS, const Twine &Name = "") {
931     assert(LHS->getType() == RHS->getType() &&
932            "Pointer subtraction operand types must match!");
933     const PointerType *ArgType = cast<PointerType>(LHS->getType());
934     Value *LHS_int = CreatePtrToInt(LHS, Type::getInt64Ty(Context));
935     Value *RHS_int = CreatePtrToInt(RHS, Type::getInt64Ty(Context));
936     Value *Difference = CreateSub(LHS_int, RHS_int);
937     return CreateExactSDiv(Difference,
938                            ConstantExpr::getSizeOf(ArgType->getElementType()),
939                            Name);
940   }
941 };
942
943 }
944
945 #endif