1 //===---- llvm/Support/IRBuilder.h - Builder for LLVM Instrs ----*- 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 IRBuilder class, which is used as a convenient way
11 // to create LLVM instructions with a consistent and simplified interface.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_SUPPORT_IRBUILDER_H
16 #define LLVM_SUPPORT_IRBUILDER_H
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"
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 {
37 void InsertHelper(Instruction *I, const Twine &Name,
38 BasicBlock *BB, BasicBlock::iterator InsertPt) const {
39 if (BB) BB->getInstList().insert(InsertPt, I);
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.
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
59 template<bool preserveNames = true, typename T = ConstantFolder,
60 typename Inserter = IRBuilderDefaultInserter<preserveNames> >
61 class IRBuilder : public Inserter {
63 BasicBlock::iterator InsertPt;
65 MDNode *CurDbgLocation;
69 IRBuilder(LLVMContext &C, const T &F, const Inserter &I = Inserter())
70 : Inserter(I), MDKind(0), CurDbgLocation(0), Context(C), Folder(F) {
71 ClearInsertionPoint();
74 explicit IRBuilder(LLVMContext &C)
75 : MDKind(0), CurDbgLocation(0), Context(C), Folder(C) {
76 ClearInsertionPoint();
79 explicit IRBuilder(BasicBlock *TheBB, const T &F)
80 : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()), Folder(F) {
81 SetInsertPoint(TheBB);
84 explicit IRBuilder(BasicBlock *TheBB)
85 : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()),
87 SetInsertPoint(TheBB);
90 IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP, const T& F)
91 : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()), Folder(F) {
92 SetInsertPoint(TheBB, IP);
95 IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP)
96 : MDKind(0), CurDbgLocation(0), Context(TheBB->getContext()),
98 SetInsertPoint(TheBB, IP);
101 /// getFolder - Get the constant folder being used.
102 const T &getFolder() { return Folder; }
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; }
108 //===--------------------------------------------------------------------===//
109 // Builder configuration methods
110 //===--------------------------------------------------------------------===//
112 /// ClearInsertionPoint - Clear the insertion point: created instructions will
113 /// not be inserted into a block.
114 void ClearInsertionPoint() {
118 BasicBlock *GetInsertBlock() const { return BB; }
120 BasicBlock::iterator GetInsertPoint() const { return InsertPt; }
122 /// SetInsertPoint - This specifies that created instructions should be
123 /// appended to the end of the specified block.
124 void SetInsertPoint(BasicBlock *TheBB) {
126 InsertPt = BB->end();
129 /// SetInsertPoint - This specifies that created instructions should be
130 /// inserted at the specified point.
131 void SetInsertPoint(BasicBlock *TheBB, BasicBlock::iterator IP) {
136 /// SetCurrentDebugLocation - Set location information used by debugging
138 void SetCurrentDebugLocation(MDNode *L) {
140 MDKind = Context.getMetadata().getMDKind("dbg");
142 MDKind = Context.getMetadata().registerMDKind("dbg");
146 MDNode *getCurrentDebugLocation() const { return CurDbgLocation; }
148 /// SetDebugLocation - Set location information for the given instruction.
149 void SetDebugLocation(Instruction *I) {
151 Context.getMetadata().addMD(MDKind, CurDbgLocation, I);
154 /// SetDebugLocation - Set location information for the given instruction.
155 void SetDebugLocation(Instruction *I, MDNode *Loc) {
157 MDKind = Context.getMetadata().getMDKind("dbg");
159 MDKind = Context.getMetadata().registerMDKind("dbg");
160 Context.getMetadata().addMD(MDKind, Loc, I);
163 /// Insert - Insert and return the specified instruction.
164 template<typename InstTy>
165 InstTy *Insert(InstTy *I, const Twine &Name = "") const {
166 this->InsertHelper(I, Name, BB, InsertPt);
168 Context.getMetadata().addMD(MDKind, CurDbgLocation, I);
172 //===--------------------------------------------------------------------===//
173 // Type creation methods
174 //===--------------------------------------------------------------------===//
176 /// getInt1Ty - Fetch the type representing a single bit
177 const Type *getInt1Ty() {
178 return Type::getInt1Ty(Context);
181 /// getInt8Ty - Fetch the type representing an 8-bit integer.
182 const Type *getInt8Ty() {
183 return Type::getInt8Ty(Context);
186 /// getInt16Ty - Fetch the type representing a 16-bit integer.
187 const Type *getInt16Ty() {
188 return Type::getInt16Ty(Context);
191 /// getInt32Ty - Fetch the type resepresenting a 32-bit integer.
192 const Type *getInt32Ty() {
193 return Type::getInt32Ty(Context);
196 /// getInt64Ty - Fetch the type representing a 64-bit integer.
197 const Type *getInt64Ty() {
198 return Type::getInt64Ty(Context);
201 /// getFloatTy - Fetch the type representing a 32-bit floating point value.
202 const Type *getFloatTy() {
203 return Type::getFloatTy(Context);
206 /// getDoubleTy - Fetch the type representing a 64-bit floating point value.
207 const Type *getDoubleTy() {
208 return Type::getDoubleTy(Context);
211 /// getVoidTy - Fetch the type representing void.
212 const Type *getVoidTy() {
213 return Type::getVoidTy(Context);
216 //===--------------------------------------------------------------------===//
217 // Instruction creation methods: Terminators
218 //===--------------------------------------------------------------------===//
220 /// CreateRetVoid - Create a 'ret void' instruction.
221 ReturnInst *CreateRetVoid() {
222 return Insert(ReturnInst::Create(Context));
226 /// CreateRet - Create a 'ret <val>' instruction.
228 ReturnInst *CreateRet(Value *V) {
229 return Insert(ReturnInst::Create(Context, V));
232 /// CreateAggregateRet - Create a sequence of N insertvalue instructions,
233 /// with one Value from the retVals array each, that build a aggregate
234 /// return value one value at a time, and a ret instruction to return
235 /// the resulting aggregate value. This is a convenience function for
236 /// code that uses aggregate return values as a vehicle for having
237 /// multiple return values.
239 ReturnInst *CreateAggregateRet(Value * const* retVals, unsigned N) {
240 const Type *RetType = BB->getParent()->getReturnType();
241 Value *V = UndefValue::get(RetType);
242 for (unsigned i = 0; i != N; ++i)
243 V = CreateInsertValue(V, retVals[i], i, "mrv");
244 return Insert(ReturnInst::Create(Context, V));
247 /// CreateBr - Create an unconditional 'br label X' instruction.
248 BranchInst *CreateBr(BasicBlock *Dest) {
249 return Insert(BranchInst::Create(Dest));
252 /// CreateCondBr - Create a conditional 'br Cond, TrueDest, FalseDest'
254 BranchInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False) {
255 return Insert(BranchInst::Create(True, False, Cond));
258 /// CreateSwitch - Create a switch instruction with the specified value,
259 /// default dest, and with a hint for the number of cases that will be added
260 /// (for efficient allocation).
261 SwitchInst *CreateSwitch(Value *V, BasicBlock *Dest, unsigned NumCases = 10) {
262 return Insert(SwitchInst::Create(V, Dest, NumCases));
265 /// CreateIndirectBr - Create an indirect branch instruction with the
266 /// specified address operand, with an optional hint for the number of
267 /// destinations that will be added (for efficient allocation).
268 IndirectBrInst *CreateIndirectBr(Value *Addr, unsigned NumDests = 10) {
269 return Insert(IndirectBrInst::Create(Addr, NumDests));
272 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
273 BasicBlock *UnwindDest, const Twine &Name = "") {
274 Value *Args[] = { 0 };
275 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args,
278 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
279 BasicBlock *UnwindDest, Value *Arg1,
280 const Twine &Name = "") {
281 Value *Args[] = { Arg1 };
282 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args,
285 InvokeInst *CreateInvoke3(Value *Callee, BasicBlock *NormalDest,
286 BasicBlock *UnwindDest, Value *Arg1,
287 Value *Arg2, Value *Arg3,
288 const Twine &Name = "") {
289 Value *Args[] = { Arg1, Arg2, Arg3 };
290 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args,
293 /// CreateInvoke - Create an invoke instruction.
294 template<typename InputIterator>
295 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
296 BasicBlock *UnwindDest, InputIterator ArgBegin,
297 InputIterator ArgEnd, const Twine &Name = "") {
298 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest,
299 ArgBegin, ArgEnd), Name);
302 UnwindInst *CreateUnwind() {
303 return Insert(new UnwindInst(Context));
306 UnreachableInst *CreateUnreachable() {
307 return Insert(new UnreachableInst(Context));
310 //===--------------------------------------------------------------------===//
311 // Instruction creation methods: Binary Operators
312 //===--------------------------------------------------------------------===//
314 Value *CreateAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
315 if (Constant *LC = dyn_cast<Constant>(LHS))
316 if (Constant *RC = dyn_cast<Constant>(RHS))
317 return Folder.CreateAdd(LC, RC);
318 return Insert(BinaryOperator::CreateAdd(LHS, RHS), Name);
320 Value *CreateNSWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
321 if (Constant *LC = dyn_cast<Constant>(LHS))
322 if (Constant *RC = dyn_cast<Constant>(RHS))
323 return Folder.CreateNSWAdd(LC, RC);
324 return Insert(BinaryOperator::CreateNSWAdd(LHS, RHS), Name);
326 Value *CreateFAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
327 if (Constant *LC = dyn_cast<Constant>(LHS))
328 if (Constant *RC = dyn_cast<Constant>(RHS))
329 return Folder.CreateFAdd(LC, RC);
330 return Insert(BinaryOperator::CreateFAdd(LHS, RHS), Name);
332 Value *CreateSub(Value *LHS, Value *RHS, const Twine &Name = "") {
333 if (Constant *LC = dyn_cast<Constant>(LHS))
334 if (Constant *RC = dyn_cast<Constant>(RHS))
335 return Folder.CreateSub(LC, RC);
336 return Insert(BinaryOperator::CreateSub(LHS, RHS), Name);
338 Value *CreateNSWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
339 if (Constant *LC = dyn_cast<Constant>(LHS))
340 if (Constant *RC = dyn_cast<Constant>(RHS))
341 return Folder.CreateNSWSub(LC, RC);
342 return Insert(BinaryOperator::CreateNSWSub(LHS, RHS), Name);
344 Value *CreateFSub(Value *LHS, Value *RHS, const Twine &Name = "") {
345 if (Constant *LC = dyn_cast<Constant>(LHS))
346 if (Constant *RC = dyn_cast<Constant>(RHS))
347 return Folder.CreateFSub(LC, RC);
348 return Insert(BinaryOperator::CreateFSub(LHS, RHS), Name);
350 Value *CreateMul(Value *LHS, Value *RHS, const Twine &Name = "") {
351 if (Constant *LC = dyn_cast<Constant>(LHS))
352 if (Constant *RC = dyn_cast<Constant>(RHS))
353 return Folder.CreateMul(LC, RC);
354 return Insert(BinaryOperator::CreateMul(LHS, RHS), Name);
356 Value *CreateFMul(Value *LHS, Value *RHS, const Twine &Name = "") {
357 if (Constant *LC = dyn_cast<Constant>(LHS))
358 if (Constant *RC = dyn_cast<Constant>(RHS))
359 return Folder.CreateFMul(LC, RC);
360 return Insert(BinaryOperator::CreateFMul(LHS, RHS), Name);
362 Value *CreateUDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
363 if (Constant *LC = dyn_cast<Constant>(LHS))
364 if (Constant *RC = dyn_cast<Constant>(RHS))
365 return Folder.CreateUDiv(LC, RC);
366 return Insert(BinaryOperator::CreateUDiv(LHS, RHS), Name);
368 Value *CreateSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
369 if (Constant *LC = dyn_cast<Constant>(LHS))
370 if (Constant *RC = dyn_cast<Constant>(RHS))
371 return Folder.CreateSDiv(LC, RC);
372 return Insert(BinaryOperator::CreateSDiv(LHS, RHS), Name);
374 Value *CreateExactSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
375 if (Constant *LC = dyn_cast<Constant>(LHS))
376 if (Constant *RC = dyn_cast<Constant>(RHS))
377 return Folder.CreateExactSDiv(LC, RC);
378 return Insert(BinaryOperator::CreateExactSDiv(LHS, RHS), Name);
380 Value *CreateFDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
381 if (Constant *LC = dyn_cast<Constant>(LHS))
382 if (Constant *RC = dyn_cast<Constant>(RHS))
383 return Folder.CreateFDiv(LC, RC);
384 return Insert(BinaryOperator::CreateFDiv(LHS, RHS), Name);
386 Value *CreateURem(Value *LHS, Value *RHS, const Twine &Name = "") {
387 if (Constant *LC = dyn_cast<Constant>(LHS))
388 if (Constant *RC = dyn_cast<Constant>(RHS))
389 return Folder.CreateURem(LC, RC);
390 return Insert(BinaryOperator::CreateURem(LHS, RHS), Name);
392 Value *CreateSRem(Value *LHS, Value *RHS, const Twine &Name = "") {
393 if (Constant *LC = dyn_cast<Constant>(LHS))
394 if (Constant *RC = dyn_cast<Constant>(RHS))
395 return Folder.CreateSRem(LC, RC);
396 return Insert(BinaryOperator::CreateSRem(LHS, RHS), Name);
398 Value *CreateFRem(Value *LHS, Value *RHS, const Twine &Name = "") {
399 if (Constant *LC = dyn_cast<Constant>(LHS))
400 if (Constant *RC = dyn_cast<Constant>(RHS))
401 return Folder.CreateFRem(LC, RC);
402 return Insert(BinaryOperator::CreateFRem(LHS, RHS), Name);
404 Value *CreateShl(Value *LHS, Value *RHS, const Twine &Name = "") {
405 if (Constant *LC = dyn_cast<Constant>(LHS))
406 if (Constant *RC = dyn_cast<Constant>(RHS))
407 return Folder.CreateShl(LC, RC);
408 return Insert(BinaryOperator::CreateShl(LHS, RHS), Name);
410 Value *CreateShl(Value *LHS, uint64_t RHS, const Twine &Name = "") {
411 Constant *RHSC = ConstantInt::get(LHS->getType(), RHS);
412 if (Constant *LC = dyn_cast<Constant>(LHS))
413 return Folder.CreateShl(LC, RHSC);
414 return Insert(BinaryOperator::CreateShl(LHS, RHSC), Name);
417 Value *CreateLShr(Value *LHS, Value *RHS, const Twine &Name = "") {
418 if (Constant *LC = dyn_cast<Constant>(LHS))
419 if (Constant *RC = dyn_cast<Constant>(RHS))
420 return Folder.CreateLShr(LC, RC);
421 return Insert(BinaryOperator::CreateLShr(LHS, RHS), Name);
423 Value *CreateLShr(Value *LHS, uint64_t RHS, const Twine &Name = "") {
424 Constant *RHSC = ConstantInt::get(LHS->getType(), RHS);
425 if (Constant *LC = dyn_cast<Constant>(LHS))
426 return Folder.CreateLShr(LC, RHSC);
427 return Insert(BinaryOperator::CreateLShr(LHS, RHSC), Name);
430 Value *CreateAShr(Value *LHS, Value *RHS, const Twine &Name = "") {
431 if (Constant *LC = dyn_cast<Constant>(LHS))
432 if (Constant *RC = dyn_cast<Constant>(RHS))
433 return Folder.CreateAShr(LC, RC);
434 return Insert(BinaryOperator::CreateAShr(LHS, RHS), Name);
436 Value *CreateAShr(Value *LHS, uint64_t RHS, const Twine &Name = "") {
437 Constant *RHSC = ConstantInt::get(LHS->getType(), RHS);
438 if (Constant *LC = dyn_cast<Constant>(LHS))
439 return Folder.CreateSShr(LC, RHSC);
440 return Insert(BinaryOperator::CreateAShr(LHS, RHSC), Name);
443 Value *CreateAnd(Value *LHS, Value *RHS, const Twine &Name = "") {
444 if (Constant *RC = dyn_cast<Constant>(RHS)) {
445 if (isa<ConstantInt>(RC) && cast<ConstantInt>(RC)->isAllOnesValue())
446 return LHS; // LHS & -1 -> LHS
447 if (Constant *LC = dyn_cast<Constant>(LHS))
448 return Folder.CreateAnd(LC, RC);
450 return Insert(BinaryOperator::CreateAnd(LHS, RHS), Name);
452 Value *CreateOr(Value *LHS, Value *RHS, const Twine &Name = "") {
453 if (Constant *RC = dyn_cast<Constant>(RHS)) {
454 if (RC->isNullValue())
455 return LHS; // LHS | 0 -> LHS
456 if (Constant *LC = dyn_cast<Constant>(LHS))
457 return Folder.CreateOr(LC, RC);
459 return Insert(BinaryOperator::CreateOr(LHS, RHS), Name);
461 Value *CreateXor(Value *LHS, Value *RHS, const Twine &Name = "") {
462 if (Constant *LC = dyn_cast<Constant>(LHS))
463 if (Constant *RC = dyn_cast<Constant>(RHS))
464 return Folder.CreateXor(LC, RC);
465 return Insert(BinaryOperator::CreateXor(LHS, RHS), Name);
468 Value *CreateBinOp(Instruction::BinaryOps Opc,
469 Value *LHS, Value *RHS, const Twine &Name = "") {
470 if (Constant *LC = dyn_cast<Constant>(LHS))
471 if (Constant *RC = dyn_cast<Constant>(RHS))
472 return Folder.CreateBinOp(Opc, LC, RC);
473 return Insert(BinaryOperator::Create(Opc, LHS, RHS), Name);
476 Value *CreateNeg(Value *V, const Twine &Name = "") {
477 if (Constant *VC = dyn_cast<Constant>(V))
478 return Folder.CreateNeg(VC);
479 return Insert(BinaryOperator::CreateNeg(V), Name);
481 Value *CreateFNeg(Value *V, const Twine &Name = "") {
482 if (Constant *VC = dyn_cast<Constant>(V))
483 return Folder.CreateFNeg(VC);
484 return Insert(BinaryOperator::CreateFNeg(V), Name);
486 Value *CreateNot(Value *V, const Twine &Name = "") {
487 if (Constant *VC = dyn_cast<Constant>(V))
488 return Folder.CreateNot(VC);
489 return Insert(BinaryOperator::CreateNot(V), Name);
492 //===--------------------------------------------------------------------===//
493 // Instruction creation methods: Memory Instructions
494 //===--------------------------------------------------------------------===//
496 AllocaInst *CreateAlloca(const Type *Ty, Value *ArraySize = 0,
497 const Twine &Name = "") {
498 return Insert(new AllocaInst(Ty, ArraySize), Name);
500 // Provided to resolve 'CreateLoad(Ptr, "...")' correctly, instead of
501 // converting the string to 'bool' for the isVolatile parameter.
502 LoadInst *CreateLoad(Value *Ptr, const char *Name) {
503 return Insert(new LoadInst(Ptr), Name);
505 LoadInst *CreateLoad(Value *Ptr, const Twine &Name = "") {
506 return Insert(new LoadInst(Ptr), Name);
508 LoadInst *CreateLoad(Value *Ptr, bool isVolatile, const Twine &Name = "") {
509 return Insert(new LoadInst(Ptr, 0, isVolatile), Name);
511 StoreInst *CreateStore(Value *Val, Value *Ptr, bool isVolatile = false) {
512 return Insert(new StoreInst(Val, Ptr, isVolatile));
514 template<typename InputIterator>
515 Value *CreateGEP(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
516 const Twine &Name = "") {
517 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
518 // Every index must be constant.
520 for (i = IdxBegin; i < IdxEnd; ++i)
521 if (!isa<Constant>(*i))
524 return Folder.CreateGetElementPtr(PC, &IdxBegin[0], IdxEnd - IdxBegin);
526 return Insert(GetElementPtrInst::Create(Ptr, IdxBegin, IdxEnd), Name);
528 template<typename InputIterator>
529 Value *CreateInBoundsGEP(Value *Ptr, InputIterator IdxBegin, InputIterator IdxEnd,
530 const Twine &Name = "") {
531 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
532 // Every index must be constant.
534 for (i = IdxBegin; i < IdxEnd; ++i)
535 if (!isa<Constant>(*i))
538 return Folder.CreateInBoundsGetElementPtr(PC,
542 return Insert(GetElementPtrInst::CreateInBounds(Ptr, IdxBegin, IdxEnd),
545 Value *CreateGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
546 if (Constant *PC = dyn_cast<Constant>(Ptr))
547 if (Constant *IC = dyn_cast<Constant>(Idx))
548 return Folder.CreateGetElementPtr(PC, &IC, 1);
549 return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
551 Value *CreateInBoundsGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
552 if (Constant *PC = dyn_cast<Constant>(Ptr))
553 if (Constant *IC = dyn_cast<Constant>(Idx))
554 return Folder.CreateInBoundsGetElementPtr(PC, &IC, 1);
555 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
557 Value *CreateConstGEP1_32(Value *Ptr, unsigned Idx0, const Twine &Name = "") {
558 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
560 if (Constant *PC = dyn_cast<Constant>(Ptr))
561 return Folder.CreateGetElementPtr(PC, &Idx, 1);
563 return Insert(GetElementPtrInst::Create(Ptr, &Idx, &Idx+1), Name);
565 Value *CreateConstInBoundsGEP1_32(Value *Ptr, unsigned Idx0,
566 const Twine &Name = "") {
567 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
569 if (Constant *PC = dyn_cast<Constant>(Ptr))
570 return Folder.CreateInBoundsGetElementPtr(PC, &Idx, 1);
572 return Insert(GetElementPtrInst::CreateInBounds(Ptr, &Idx, &Idx+1), Name);
574 Value *CreateConstGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
575 const Twine &Name = "") {
577 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
578 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
581 if (Constant *PC = dyn_cast<Constant>(Ptr))
582 return Folder.CreateGetElementPtr(PC, Idxs, 2);
584 return Insert(GetElementPtrInst::Create(Ptr, Idxs, Idxs+2), Name);
586 Value *CreateConstInBoundsGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
587 const Twine &Name = "") {
589 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
590 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
593 if (Constant *PC = dyn_cast<Constant>(Ptr))
594 return Folder.CreateInBoundsGetElementPtr(PC, Idxs, 2);
596 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs, Idxs+2), Name);
598 Value *CreateConstGEP1_64(Value *Ptr, uint64_t Idx0, const Twine &Name = "") {
599 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
601 if (Constant *PC = dyn_cast<Constant>(Ptr))
602 return Folder.CreateGetElementPtr(PC, &Idx, 1);
604 return Insert(GetElementPtrInst::Create(Ptr, &Idx, &Idx+1), Name);
606 Value *CreateConstInBoundsGEP1_64(Value *Ptr, uint64_t Idx0,
607 const Twine &Name = "") {
608 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
610 if (Constant *PC = dyn_cast<Constant>(Ptr))
611 return Folder.CreateInBoundsGetElementPtr(PC, &Idx, 1);
613 return Insert(GetElementPtrInst::CreateInBounds(Ptr, &Idx, &Idx+1), Name);
615 Value *CreateConstGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
616 const Twine &Name = "") {
618 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
619 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
622 if (Constant *PC = dyn_cast<Constant>(Ptr))
623 return Folder.CreateGetElementPtr(PC, Idxs, 2);
625 return Insert(GetElementPtrInst::Create(Ptr, Idxs, Idxs+2), Name);
627 Value *CreateConstInBoundsGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
628 const Twine &Name = "") {
630 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
631 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
634 if (Constant *PC = dyn_cast<Constant>(Ptr))
635 return Folder.CreateInBoundsGetElementPtr(PC, Idxs, 2);
637 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs, Idxs+2), Name);
639 Value *CreateStructGEP(Value *Ptr, unsigned Idx, const Twine &Name = "") {
640 return CreateConstInBoundsGEP2_32(Ptr, 0, Idx, Name);
642 Value *CreateGlobalString(const char *Str = "", const Twine &Name = "") {
643 Constant *StrConstant = ConstantArray::get(Context, Str, true);
644 Module &M = *BB->getParent()->getParent();
645 GlobalVariable *gv = new GlobalVariable(M,
646 StrConstant->getType(),
648 GlobalValue::InternalLinkage,
656 Value *CreateGlobalStringPtr(const char *Str = "", const Twine &Name = "") {
657 Value *gv = CreateGlobalString(Str, Name);
658 Value *zero = ConstantInt::get(Type::getInt32Ty(Context), 0);
659 Value *Args[] = { zero, zero };
660 return CreateInBoundsGEP(gv, Args, Args+2, Name);
662 //===--------------------------------------------------------------------===//
663 // Instruction creation methods: Cast/Conversion Operators
664 //===--------------------------------------------------------------------===//
666 Value *CreateTrunc(Value *V, const Type *DestTy, const Twine &Name = "") {
667 return CreateCast(Instruction::Trunc, V, DestTy, Name);
669 Value *CreateZExt(Value *V, const Type *DestTy, const Twine &Name = "") {
670 return CreateCast(Instruction::ZExt, V, DestTy, Name);
672 Value *CreateSExt(Value *V, const Type *DestTy, const Twine &Name = "") {
673 return CreateCast(Instruction::SExt, V, DestTy, Name);
675 Value *CreateFPToUI(Value *V, const Type *DestTy, const Twine &Name = ""){
676 return CreateCast(Instruction::FPToUI, V, DestTy, Name);
678 Value *CreateFPToSI(Value *V, const Type *DestTy, const Twine &Name = ""){
679 return CreateCast(Instruction::FPToSI, V, DestTy, Name);
681 Value *CreateUIToFP(Value *V, const Type *DestTy, const Twine &Name = ""){
682 return CreateCast(Instruction::UIToFP, V, DestTy, Name);
684 Value *CreateSIToFP(Value *V, const Type *DestTy, const Twine &Name = ""){
685 return CreateCast(Instruction::SIToFP, V, DestTy, Name);
687 Value *CreateFPTrunc(Value *V, const Type *DestTy,
688 const Twine &Name = "") {
689 return CreateCast(Instruction::FPTrunc, V, DestTy, Name);
691 Value *CreateFPExt(Value *V, const Type *DestTy, const Twine &Name = "") {
692 return CreateCast(Instruction::FPExt, V, DestTy, Name);
694 Value *CreatePtrToInt(Value *V, const Type *DestTy,
695 const Twine &Name = "") {
696 return CreateCast(Instruction::PtrToInt, V, DestTy, Name);
698 Value *CreateIntToPtr(Value *V, const Type *DestTy,
699 const Twine &Name = "") {
700 return CreateCast(Instruction::IntToPtr, V, DestTy, Name);
702 Value *CreateBitCast(Value *V, const Type *DestTy,
703 const Twine &Name = "") {
704 return CreateCast(Instruction::BitCast, V, DestTy, Name);
706 Value *CreateZExtOrBitCast(Value *V, const Type *DestTy,
707 const Twine &Name = "") {
708 if (V->getType() == DestTy)
710 if (Constant *VC = dyn_cast<Constant>(V))
711 return Folder.CreateZExtOrBitCast(VC, DestTy);
712 return Insert(CastInst::CreateZExtOrBitCast(V, DestTy), Name);
714 Value *CreateSExtOrBitCast(Value *V, const Type *DestTy,
715 const Twine &Name = "") {
716 if (V->getType() == DestTy)
718 if (Constant *VC = dyn_cast<Constant>(V))
719 return Folder.CreateSExtOrBitCast(VC, DestTy);
720 return Insert(CastInst::CreateSExtOrBitCast(V, DestTy), Name);
722 Value *CreateTruncOrBitCast(Value *V, const Type *DestTy,
723 const Twine &Name = "") {
724 if (V->getType() == DestTy)
726 if (Constant *VC = dyn_cast<Constant>(V))
727 return Folder.CreateTruncOrBitCast(VC, DestTy);
728 return Insert(CastInst::CreateTruncOrBitCast(V, DestTy), Name);
730 Value *CreateCast(Instruction::CastOps Op, Value *V, const Type *DestTy,
731 const Twine &Name = "") {
732 if (V->getType() == DestTy)
734 if (Constant *VC = dyn_cast<Constant>(V))
735 return Folder.CreateCast(Op, VC, DestTy);
736 return Insert(CastInst::Create(Op, V, DestTy), Name);
738 Value *CreatePointerCast(Value *V, const Type *DestTy,
739 const Twine &Name = "") {
740 if (V->getType() == DestTy)
742 if (Constant *VC = dyn_cast<Constant>(V))
743 return Folder.CreatePointerCast(VC, DestTy);
744 return Insert(CastInst::CreatePointerCast(V, DestTy), Name);
746 Value *CreateIntCast(Value *V, const Type *DestTy, bool isSigned,
747 const Twine &Name = "") {
748 if (V->getType() == DestTy)
750 if (Constant *VC = dyn_cast<Constant>(V))
751 return Folder.CreateIntCast(VC, DestTy, isSigned);
752 return Insert(CastInst::CreateIntegerCast(V, DestTy, isSigned), Name);
755 // Provided to resolve 'CreateIntCast(Ptr, Ptr, "...")', giving a compile time
756 // error, instead of converting the string to bool for the isSigned parameter.
757 Value *CreateIntCast(Value *, const Type *, const char *); // DO NOT IMPLEMENT
759 Value *CreateFPCast(Value *V, const Type *DestTy, const Twine &Name = "") {
760 if (V->getType() == DestTy)
762 if (Constant *VC = dyn_cast<Constant>(V))
763 return Folder.CreateFPCast(VC, DestTy);
764 return Insert(CastInst::CreateFPCast(V, DestTy), Name);
767 //===--------------------------------------------------------------------===//
768 // Instruction creation methods: Compare Instructions
769 //===--------------------------------------------------------------------===//
771 Value *CreateICmpEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
772 return CreateICmp(ICmpInst::ICMP_EQ, LHS, RHS, Name);
774 Value *CreateICmpNE(Value *LHS, Value *RHS, const Twine &Name = "") {
775 return CreateICmp(ICmpInst::ICMP_NE, LHS, RHS, Name);
777 Value *CreateICmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
778 return CreateICmp(ICmpInst::ICMP_UGT, LHS, RHS, Name);
780 Value *CreateICmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
781 return CreateICmp(ICmpInst::ICMP_UGE, LHS, RHS, Name);
783 Value *CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
784 return CreateICmp(ICmpInst::ICMP_ULT, LHS, RHS, Name);
786 Value *CreateICmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
787 return CreateICmp(ICmpInst::ICMP_ULE, LHS, RHS, Name);
789 Value *CreateICmpSGT(Value *LHS, Value *RHS, const Twine &Name = "") {
790 return CreateICmp(ICmpInst::ICMP_SGT, LHS, RHS, Name);
792 Value *CreateICmpSGE(Value *LHS, Value *RHS, const Twine &Name = "") {
793 return CreateICmp(ICmpInst::ICMP_SGE, LHS, RHS, Name);
795 Value *CreateICmpSLT(Value *LHS, Value *RHS, const Twine &Name = "") {
796 return CreateICmp(ICmpInst::ICMP_SLT, LHS, RHS, Name);
798 Value *CreateICmpSLE(Value *LHS, Value *RHS, const Twine &Name = "") {
799 return CreateICmp(ICmpInst::ICMP_SLE, LHS, RHS, Name);
802 Value *CreateFCmpOEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
803 return CreateFCmp(FCmpInst::FCMP_OEQ, LHS, RHS, Name);
805 Value *CreateFCmpOGT(Value *LHS, Value *RHS, const Twine &Name = "") {
806 return CreateFCmp(FCmpInst::FCMP_OGT, LHS, RHS, Name);
808 Value *CreateFCmpOGE(Value *LHS, Value *RHS, const Twine &Name = "") {
809 return CreateFCmp(FCmpInst::FCMP_OGE, LHS, RHS, Name);
811 Value *CreateFCmpOLT(Value *LHS, Value *RHS, const Twine &Name = "") {
812 return CreateFCmp(FCmpInst::FCMP_OLT, LHS, RHS, Name);
814 Value *CreateFCmpOLE(Value *LHS, Value *RHS, const Twine &Name = "") {
815 return CreateFCmp(FCmpInst::FCMP_OLE, LHS, RHS, Name);
817 Value *CreateFCmpONE(Value *LHS, Value *RHS, const Twine &Name = "") {
818 return CreateFCmp(FCmpInst::FCMP_ONE, LHS, RHS, Name);
820 Value *CreateFCmpORD(Value *LHS, Value *RHS, const Twine &Name = "") {
821 return CreateFCmp(FCmpInst::FCMP_ORD, LHS, RHS, Name);
823 Value *CreateFCmpUNO(Value *LHS, Value *RHS, const Twine &Name = "") {
824 return CreateFCmp(FCmpInst::FCMP_UNO, LHS, RHS, Name);
826 Value *CreateFCmpUEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
827 return CreateFCmp(FCmpInst::FCMP_UEQ, LHS, RHS, Name);
829 Value *CreateFCmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
830 return CreateFCmp(FCmpInst::FCMP_UGT, LHS, RHS, Name);
832 Value *CreateFCmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
833 return CreateFCmp(FCmpInst::FCMP_UGE, LHS, RHS, Name);
835 Value *CreateFCmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
836 return CreateFCmp(FCmpInst::FCMP_ULT, LHS, RHS, Name);
838 Value *CreateFCmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
839 return CreateFCmp(FCmpInst::FCMP_ULE, LHS, RHS, Name);
841 Value *CreateFCmpUNE(Value *LHS, Value *RHS, const Twine &Name = "") {
842 return CreateFCmp(FCmpInst::FCMP_UNE, LHS, RHS, Name);
845 Value *CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
846 const Twine &Name = "") {
847 if (Constant *LC = dyn_cast<Constant>(LHS))
848 if (Constant *RC = dyn_cast<Constant>(RHS))
849 return Folder.CreateICmp(P, LC, RC);
850 return Insert(new ICmpInst(P, LHS, RHS), Name);
852 Value *CreateFCmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
853 const Twine &Name = "") {
854 if (Constant *LC = dyn_cast<Constant>(LHS))
855 if (Constant *RC = dyn_cast<Constant>(RHS))
856 return Folder.CreateFCmp(P, LC, RC);
857 return Insert(new FCmpInst(P, LHS, RHS), Name);
860 //===--------------------------------------------------------------------===//
861 // Instruction creation methods: Other Instructions
862 //===--------------------------------------------------------------------===//
864 PHINode *CreatePHI(const Type *Ty, const Twine &Name = "") {
865 return Insert(PHINode::Create(Ty), Name);
868 CallInst *CreateCall(Value *Callee, const Twine &Name = "") {
869 return Insert(CallInst::Create(Callee), Name);
871 CallInst *CreateCall(Value *Callee, Value *Arg, const Twine &Name = "") {
872 return Insert(CallInst::Create(Callee, Arg), Name);
874 CallInst *CreateCall2(Value *Callee, Value *Arg1, Value *Arg2,
875 const Twine &Name = "") {
876 Value *Args[] = { Arg1, Arg2 };
877 return Insert(CallInst::Create(Callee, Args, Args+2), Name);
879 CallInst *CreateCall3(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
880 const Twine &Name = "") {
881 Value *Args[] = { Arg1, Arg2, Arg3 };
882 return Insert(CallInst::Create(Callee, Args, Args+3), Name);
884 CallInst *CreateCall4(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
885 Value *Arg4, const Twine &Name = "") {
886 Value *Args[] = { Arg1, Arg2, Arg3, Arg4 };
887 return Insert(CallInst::Create(Callee, Args, Args+4), Name);
890 template<typename InputIterator>
891 CallInst *CreateCall(Value *Callee, InputIterator ArgBegin,
892 InputIterator ArgEnd, const Twine &Name = "") {
893 return Insert(CallInst::Create(Callee, ArgBegin, ArgEnd), Name);
896 Value *CreateSelect(Value *C, Value *True, Value *False,
897 const Twine &Name = "") {
898 if (Constant *CC = dyn_cast<Constant>(C))
899 if (Constant *TC = dyn_cast<Constant>(True))
900 if (Constant *FC = dyn_cast<Constant>(False))
901 return Folder.CreateSelect(CC, TC, FC);
902 return Insert(SelectInst::Create(C, True, False), Name);
905 VAArgInst *CreateVAArg(Value *List, const Type *Ty, const Twine &Name = "") {
906 return Insert(new VAArgInst(List, Ty), Name);
909 Value *CreateExtractElement(Value *Vec, Value *Idx,
910 const Twine &Name = "") {
911 if (Constant *VC = dyn_cast<Constant>(Vec))
912 if (Constant *IC = dyn_cast<Constant>(Idx))
913 return Folder.CreateExtractElement(VC, IC);
914 return Insert(ExtractElementInst::Create(Vec, Idx), Name);
917 Value *CreateInsertElement(Value *Vec, Value *NewElt, Value *Idx,
918 const Twine &Name = "") {
919 if (Constant *VC = dyn_cast<Constant>(Vec))
920 if (Constant *NC = dyn_cast<Constant>(NewElt))
921 if (Constant *IC = dyn_cast<Constant>(Idx))
922 return Folder.CreateInsertElement(VC, NC, IC);
923 return Insert(InsertElementInst::Create(Vec, NewElt, Idx), Name);
926 Value *CreateShuffleVector(Value *V1, Value *V2, Value *Mask,
927 const Twine &Name = "") {
928 if (Constant *V1C = dyn_cast<Constant>(V1))
929 if (Constant *V2C = dyn_cast<Constant>(V2))
930 if (Constant *MC = dyn_cast<Constant>(Mask))
931 return Folder.CreateShuffleVector(V1C, V2C, MC);
932 return Insert(new ShuffleVectorInst(V1, V2, Mask), Name);
935 Value *CreateExtractValue(Value *Agg, unsigned Idx,
936 const Twine &Name = "") {
937 if (Constant *AggC = dyn_cast<Constant>(Agg))
938 return Folder.CreateExtractValue(AggC, &Idx, 1);
939 return Insert(ExtractValueInst::Create(Agg, Idx), Name);
942 template<typename InputIterator>
943 Value *CreateExtractValue(Value *Agg,
944 InputIterator IdxBegin,
945 InputIterator IdxEnd,
946 const Twine &Name = "") {
947 if (Constant *AggC = dyn_cast<Constant>(Agg))
948 return Folder.CreateExtractValue(AggC, IdxBegin, IdxEnd - IdxBegin);
949 return Insert(ExtractValueInst::Create(Agg, IdxBegin, IdxEnd), Name);
952 Value *CreateInsertValue(Value *Agg, Value *Val, unsigned Idx,
953 const Twine &Name = "") {
954 if (Constant *AggC = dyn_cast<Constant>(Agg))
955 if (Constant *ValC = dyn_cast<Constant>(Val))
956 return Folder.CreateInsertValue(AggC, ValC, &Idx, 1);
957 return Insert(InsertValueInst::Create(Agg, Val, Idx), Name);
960 template<typename InputIterator>
961 Value *CreateInsertValue(Value *Agg, Value *Val,
962 InputIterator IdxBegin,
963 InputIterator IdxEnd,
964 const Twine &Name = "") {
965 if (Constant *AggC = dyn_cast<Constant>(Agg))
966 if (Constant *ValC = dyn_cast<Constant>(Val))
967 return Folder.CreateInsertValue(AggC, ValC, IdxBegin, IdxEnd-IdxBegin);
968 return Insert(InsertValueInst::Create(Agg, Val, IdxBegin, IdxEnd), Name);
971 //===--------------------------------------------------------------------===//
972 // Utility creation methods
973 //===--------------------------------------------------------------------===//
975 /// CreateIsNull - Return an i1 value testing if \arg Arg is null.
976 Value *CreateIsNull(Value *Arg, const Twine &Name = "") {
977 return CreateICmpEQ(Arg, Constant::getNullValue(Arg->getType()),
981 /// CreateIsNotNull - Return an i1 value testing if \arg Arg is not null.
982 Value *CreateIsNotNull(Value *Arg, const Twine &Name = "") {
983 return CreateICmpNE(Arg, Constant::getNullValue(Arg->getType()),
987 /// CreatePtrDiff - Return the i64 difference between two pointer values,
988 /// dividing out the size of the pointed-to objects. This is intended to
989 /// implement C-style pointer subtraction. As such, the pointers must be
990 /// appropriately aligned for their element types and pointing into the
992 Value *CreatePtrDiff(Value *LHS, Value *RHS, const Twine &Name = "") {
993 assert(LHS->getType() == RHS->getType() &&
994 "Pointer subtraction operand types must match!");
995 const PointerType *ArgType = cast<PointerType>(LHS->getType());
996 Value *LHS_int = CreatePtrToInt(LHS, Type::getInt64Ty(Context));
997 Value *RHS_int = CreatePtrToInt(RHS, Type::getInt64Ty(Context));
998 Value *Difference = CreateSub(LHS_int, RHS_int);
999 return CreateExactSDiv(Difference,
1000 ConstantExpr::getSizeOf(ArgType->getElementType()),