1 //===---- llvm/IRBuilder.h - Builder for LLVM Instructions ------*- 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_IR_IRBUILDER_H
16 #define LLVM_IR_IRBUILDER_H
18 #include "llvm/ADT/ArrayRef.h"
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/ADT/Twine.h"
21 #include "llvm/IR/BasicBlock.h"
22 #include "llvm/IR/ConstantFolder.h"
23 #include "llvm/IR/DataLayout.h"
24 #include "llvm/IR/Instructions.h"
25 #include "llvm/IR/LLVMContext.h"
26 #include "llvm/IR/Operator.h"
27 #include "llvm/IR/ValueHandle.h"
28 #include "llvm/Support/CBindingWrapping.h"
33 /// \brief This provides the default implementation of the IRBuilder
34 /// 'InsertHelper' method that is called whenever an instruction is created by
35 /// IRBuilder and needs to be inserted.
37 /// By default, this inserts the instruction at the insertion point.
38 template <bool preserveNames = true>
39 class IRBuilderDefaultInserter {
41 void InsertHelper(Instruction *I, const Twine &Name,
42 BasicBlock *BB, BasicBlock::iterator InsertPt) const {
43 if (BB) BB->getInstList().insert(InsertPt, I);
49 /// \brief Common base class shared among various IRBuilders.
51 DebugLoc CurDbgLocation;
54 BasicBlock::iterator InsertPt;
57 MDNode *DefaultFPMathTag;
61 IRBuilderBase(LLVMContext &context, MDNode *FPMathTag = 0)
62 : Context(context), DefaultFPMathTag(FPMathTag), FMF() {
63 ClearInsertionPoint();
66 //===--------------------------------------------------------------------===//
67 // Builder configuration methods
68 //===--------------------------------------------------------------------===//
70 /// \brief Clear the insertion point: created instructions will not be
71 /// inserted into a block.
72 void ClearInsertionPoint() {
77 BasicBlock *GetInsertBlock() const { return BB; }
78 BasicBlock::iterator GetInsertPoint() const { return InsertPt; }
79 LLVMContext &getContext() const { return Context; }
81 /// \brief This specifies that created instructions should be appended to the
82 /// end of the specified block.
83 void SetInsertPoint(BasicBlock *TheBB) {
88 /// \brief This specifies that created instructions should be inserted before
89 /// the specified instruction.
90 void SetInsertPoint(Instruction *I) {
93 assert(I != BB->end() && "Can't read debug loc from end()");
94 SetCurrentDebugLocation(I->getDebugLoc());
97 /// \brief This specifies that created instructions should be inserted at the
99 void SetInsertPoint(BasicBlock *TheBB, BasicBlock::iterator IP) {
104 /// \brief Find the nearest point that dominates this use, and specify that
105 /// created instructions should be inserted at this point.
106 void SetInsertPoint(Use &U) {
107 Instruction *UseInst = cast<Instruction>(U.getUser());
108 if (PHINode *Phi = dyn_cast<PHINode>(UseInst)) {
109 BasicBlock *PredBB = Phi->getIncomingBlock(U);
110 assert(U != PredBB->getTerminator() && "critical edge not split");
111 SetInsertPoint(PredBB, PredBB->getTerminator());
114 SetInsertPoint(UseInst);
117 /// \brief Set location information used by debugging information.
118 void SetCurrentDebugLocation(const DebugLoc &L) {
122 /// \brief Get location information used by debugging information.
123 DebugLoc getCurrentDebugLocation() const { return CurDbgLocation; }
125 /// \brief If this builder has a current debug location, set it on the
126 /// specified instruction.
127 void SetInstDebugLocation(Instruction *I) const {
128 if (!CurDbgLocation.isUnknown())
129 I->setDebugLoc(CurDbgLocation);
132 /// \brief Get the return type of the current function that we're emitting
134 Type *getCurrentFunctionReturnType() const;
136 /// InsertPoint - A saved insertion point.
139 BasicBlock::iterator Point;
142 /// \brief Creates a new insertion point which doesn't point to anything.
143 InsertPoint() : Block(0) {}
145 /// \brief Creates a new insertion point at the given location.
146 InsertPoint(BasicBlock *InsertBlock, BasicBlock::iterator InsertPoint)
147 : Block(InsertBlock), Point(InsertPoint) {}
149 /// \brief Returns true if this insert point is set.
150 bool isSet() const { return (Block != 0); }
152 llvm::BasicBlock *getBlock() const { return Block; }
153 llvm::BasicBlock::iterator getPoint() const { return Point; }
156 /// \brief Returns the current insert point.
157 InsertPoint saveIP() const {
158 return InsertPoint(GetInsertBlock(), GetInsertPoint());
161 /// \brief Returns the current insert point, clearing it in the process.
162 InsertPoint saveAndClearIP() {
163 InsertPoint IP(GetInsertBlock(), GetInsertPoint());
164 ClearInsertionPoint();
168 /// \brief Sets the current insert point to a previously-saved location.
169 void restoreIP(InsertPoint IP) {
171 SetInsertPoint(IP.getBlock(), IP.getPoint());
173 ClearInsertionPoint();
176 /// \brief Get the floating point math metadata being used.
177 MDNode *getDefaultFPMathTag() const { return DefaultFPMathTag; }
179 /// \brief Get the flags to be applied to created floating point ops
180 FastMathFlags getFastMathFlags() const { return FMF; }
182 /// \brief Clear the fast-math flags.
183 void clearFastMathFlags() { FMF.clear(); }
185 /// \brief Set the floating point math metadata to be used.
186 void SetDefaultFPMathTag(MDNode *FPMathTag) { DefaultFPMathTag = FPMathTag; }
188 /// \brief Set the fast-math flags to be used with generated fp-math operators
189 void SetFastMathFlags(FastMathFlags NewFMF) { FMF = NewFMF; }
191 //===--------------------------------------------------------------------===//
193 //===--------------------------------------------------------------------===//
195 // \brief RAII object that stores the current insertion point and restores it
196 // when the object is destroyed. This includes the debug location.
197 class InsertPointGuard {
198 IRBuilderBase &Builder;
199 AssertingVH<BasicBlock> Block;
200 BasicBlock::iterator Point;
203 InsertPointGuard(const InsertPointGuard &) LLVM_DELETED_FUNCTION;
204 InsertPointGuard &operator=(const InsertPointGuard &) LLVM_DELETED_FUNCTION;
207 InsertPointGuard(IRBuilderBase &B)
208 : Builder(B), Block(B.GetInsertBlock()), Point(B.GetInsertPoint()),
209 DbgLoc(B.getCurrentDebugLocation()) {}
211 ~InsertPointGuard() {
212 Builder.restoreIP(InsertPoint(Block, Point));
213 Builder.SetCurrentDebugLocation(DbgLoc);
217 // \brief RAII object that stores the current fast math settings and restores
218 // them when the object is destroyed.
219 class FastMathFlagGuard {
220 IRBuilderBase &Builder;
224 FastMathFlagGuard(const FastMathFlagGuard &) LLVM_DELETED_FUNCTION;
225 FastMathFlagGuard &operator=(
226 const FastMathFlagGuard &) LLVM_DELETED_FUNCTION;
229 FastMathFlagGuard(IRBuilderBase &B)
230 : Builder(B), FMF(B.FMF), FPMathTag(B.DefaultFPMathTag) {}
232 ~FastMathFlagGuard() {
234 Builder.DefaultFPMathTag = FPMathTag;
238 //===--------------------------------------------------------------------===//
239 // Miscellaneous creation methods.
240 //===--------------------------------------------------------------------===//
242 /// \brief Make a new global variable with initializer type i8*
244 /// Make a new global variable with an initializer that has array of i8 type
245 /// filled in with the null terminated string value specified. The new global
246 /// variable will be marked mergable with any others of the same contents. If
247 /// Name is specified, it is the name of the global variable created.
248 Value *CreateGlobalString(StringRef Str, const Twine &Name = "");
250 /// \brief Get a constant value representing either true or false.
251 ConstantInt *getInt1(bool V) {
252 return ConstantInt::get(getInt1Ty(), V);
255 /// \brief Get the constant value for i1 true.
256 ConstantInt *getTrue() {
257 return ConstantInt::getTrue(Context);
260 /// \brief Get the constant value for i1 false.
261 ConstantInt *getFalse() {
262 return ConstantInt::getFalse(Context);
265 /// \brief Get a constant 8-bit value.
266 ConstantInt *getInt8(uint8_t C) {
267 return ConstantInt::get(getInt8Ty(), C);
270 /// \brief Get a constant 16-bit value.
271 ConstantInt *getInt16(uint16_t C) {
272 return ConstantInt::get(getInt16Ty(), C);
275 /// \brief Get a constant 32-bit value.
276 ConstantInt *getInt32(uint32_t C) {
277 return ConstantInt::get(getInt32Ty(), C);
280 /// \brief Get a constant 64-bit value.
281 ConstantInt *getInt64(uint64_t C) {
282 return ConstantInt::get(getInt64Ty(), C);
285 /// \brief Get a constant N-bit value, zero extended or truncated from
287 ConstantInt *getIntN(unsigned N, uint64_t C) {
288 return ConstantInt::get(getIntNTy(N), C);
291 /// \brief Get a constant integer value.
292 ConstantInt *getInt(const APInt &AI) {
293 return ConstantInt::get(Context, AI);
296 //===--------------------------------------------------------------------===//
297 // Type creation methods
298 //===--------------------------------------------------------------------===//
300 /// \brief Fetch the type representing a single bit
301 IntegerType *getInt1Ty() {
302 return Type::getInt1Ty(Context);
305 /// \brief Fetch the type representing an 8-bit integer.
306 IntegerType *getInt8Ty() {
307 return Type::getInt8Ty(Context);
310 /// \brief Fetch the type representing a 16-bit integer.
311 IntegerType *getInt16Ty() {
312 return Type::getInt16Ty(Context);
315 /// \brief Fetch the type representing a 32-bit integer.
316 IntegerType *getInt32Ty() {
317 return Type::getInt32Ty(Context);
320 /// \brief Fetch the type representing a 64-bit integer.
321 IntegerType *getInt64Ty() {
322 return Type::getInt64Ty(Context);
325 /// \brief Fetch the type representing an N-bit integer.
326 IntegerType *getIntNTy(unsigned N) {
327 return Type::getIntNTy(Context, N);
330 /// \brief Fetch the type representing a 32-bit floating point value.
332 return Type::getFloatTy(Context);
335 /// \brief Fetch the type representing a 64-bit floating point value.
336 Type *getDoubleTy() {
337 return Type::getDoubleTy(Context);
340 /// \brief Fetch the type representing void.
342 return Type::getVoidTy(Context);
345 /// \brief Fetch the type representing a pointer to an 8-bit integer value.
346 PointerType *getInt8PtrTy(unsigned AddrSpace = 0) {
347 return Type::getInt8PtrTy(Context, AddrSpace);
350 /// \brief Fetch the type representing a pointer to an integer value.
351 IntegerType* getIntPtrTy(const DataLayout *DL, unsigned AddrSpace = 0) {
352 return DL->getIntPtrType(Context, AddrSpace);
355 //===--------------------------------------------------------------------===//
356 // Intrinsic creation methods
357 //===--------------------------------------------------------------------===//
359 /// \brief Create and insert a memset to the specified pointer and the
362 /// If the pointer isn't an i8*, it will be converted. If a TBAA tag is
363 /// specified, it will be added to the instruction.
364 CallInst *CreateMemSet(Value *Ptr, Value *Val, uint64_t Size, unsigned Align,
365 bool isVolatile = false, MDNode *TBAATag = 0) {
366 return CreateMemSet(Ptr, Val, getInt64(Size), Align, isVolatile, TBAATag);
369 CallInst *CreateMemSet(Value *Ptr, Value *Val, Value *Size, unsigned Align,
370 bool isVolatile = false, MDNode *TBAATag = 0);
372 /// \brief Create and insert a memcpy between the specified pointers.
374 /// If the pointers aren't i8*, they will be converted. If a TBAA tag is
375 /// specified, it will be added to the instruction.
376 CallInst *CreateMemCpy(Value *Dst, Value *Src, uint64_t Size, unsigned Align,
377 bool isVolatile = false, MDNode *TBAATag = 0,
378 MDNode *TBAAStructTag = 0) {
379 return CreateMemCpy(Dst, Src, getInt64(Size), Align, isVolatile, TBAATag,
383 CallInst *CreateMemCpy(Value *Dst, Value *Src, Value *Size, unsigned Align,
384 bool isVolatile = false, MDNode *TBAATag = 0,
385 MDNode *TBAAStructTag = 0);
387 /// \brief Create and insert a memmove between the specified
390 /// If the pointers aren't i8*, they will be converted. If a TBAA tag is
391 /// specified, it will be added to the instruction.
392 CallInst *CreateMemMove(Value *Dst, Value *Src, uint64_t Size, unsigned Align,
393 bool isVolatile = false, MDNode *TBAATag = 0) {
394 return CreateMemMove(Dst, Src, getInt64(Size), Align, isVolatile, TBAATag);
397 CallInst *CreateMemMove(Value *Dst, Value *Src, Value *Size, unsigned Align,
398 bool isVolatile = false, MDNode *TBAATag = 0);
400 /// \brief Create a lifetime.start intrinsic.
402 /// If the pointer isn't i8* it will be converted.
403 CallInst *CreateLifetimeStart(Value *Ptr, ConstantInt *Size = 0);
405 /// \brief Create a lifetime.end intrinsic.
407 /// If the pointer isn't i8* it will be converted.
408 CallInst *CreateLifetimeEnd(Value *Ptr, ConstantInt *Size = 0);
411 Value *getCastedInt8PtrValue(Value *Ptr);
414 /// \brief This provides a uniform API for creating instructions and inserting
415 /// them into a basic block: either at the end of a BasicBlock, or at a specific
416 /// iterator location in a block.
418 /// Note that the builder does not expose the full generality of LLVM
419 /// instructions. For access to extra instruction properties, use the mutators
420 /// (e.g. setVolatile) on the instructions after they have been
421 /// created. Convenience state exists to specify fast-math flags and fp-math
424 /// The first template argument handles whether or not to preserve names in the
425 /// final instruction output. This defaults to on. The second template argument
426 /// specifies a class to use for creating constants. This defaults to creating
427 /// minimally folded constants. The fourth template argument allows clients to
428 /// specify custom insertion hooks that are called on every newly created
430 template<bool preserveNames = true, typename T = ConstantFolder,
431 typename Inserter = IRBuilderDefaultInserter<preserveNames> >
432 class IRBuilder : public IRBuilderBase, public Inserter {
435 IRBuilder(LLVMContext &C, const T &F, const Inserter &I = Inserter(),
436 MDNode *FPMathTag = 0)
437 : IRBuilderBase(C, FPMathTag), Inserter(I), Folder(F) {
440 explicit IRBuilder(LLVMContext &C, MDNode *FPMathTag = 0)
441 : IRBuilderBase(C, FPMathTag), Folder() {
444 explicit IRBuilder(BasicBlock *TheBB, const T &F, MDNode *FPMathTag = 0)
445 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
446 SetInsertPoint(TheBB);
449 explicit IRBuilder(BasicBlock *TheBB, MDNode *FPMathTag = 0)
450 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
451 SetInsertPoint(TheBB);
454 explicit IRBuilder(Instruction *IP, MDNode *FPMathTag = 0)
455 : IRBuilderBase(IP->getContext(), FPMathTag), Folder() {
457 SetCurrentDebugLocation(IP->getDebugLoc());
460 explicit IRBuilder(Use &U, MDNode *FPMathTag = 0)
461 : IRBuilderBase(U->getContext(), FPMathTag), Folder() {
463 SetCurrentDebugLocation(cast<Instruction>(U.getUser())->getDebugLoc());
466 IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP, const T& F,
467 MDNode *FPMathTag = 0)
468 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
469 SetInsertPoint(TheBB, IP);
472 IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP, MDNode *FPMathTag = 0)
473 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
474 SetInsertPoint(TheBB, IP);
477 /// \brief Get the constant folder being used.
478 const T &getFolder() { return Folder; }
480 /// \brief Return true if this builder is configured to actually add the
481 /// requested names to IR created through it.
482 bool isNamePreserving() const { return preserveNames; }
484 /// \brief Insert and return the specified instruction.
485 template<typename InstTy>
486 InstTy *Insert(InstTy *I, const Twine &Name = "") const {
487 this->InsertHelper(I, Name, BB, InsertPt);
488 this->SetInstDebugLocation(I);
492 /// \brief No-op overload to handle constants.
493 Constant *Insert(Constant *C, const Twine& = "") const {
497 //===--------------------------------------------------------------------===//
498 // Instruction creation methods: Terminators
499 //===--------------------------------------------------------------------===//
502 /// \brief Helper to add branch weight metadata onto an instruction.
503 /// \returns The annotated instruction.
504 template <typename InstTy>
505 InstTy *addBranchWeights(InstTy *I, MDNode *Weights) {
507 I->setMetadata(LLVMContext::MD_prof, Weights);
512 /// \brief Create a 'ret void' instruction.
513 ReturnInst *CreateRetVoid() {
514 return Insert(ReturnInst::Create(Context));
517 /// \brief Create a 'ret <val>' instruction.
518 ReturnInst *CreateRet(Value *V) {
519 return Insert(ReturnInst::Create(Context, V));
522 /// \brief Create a sequence of N insertvalue instructions,
523 /// with one Value from the retVals array each, that build a aggregate
524 /// return value one value at a time, and a ret instruction to return
525 /// the resulting aggregate value.
527 /// This is a convenience function for code that uses aggregate return values
528 /// as a vehicle for having multiple return values.
529 ReturnInst *CreateAggregateRet(Value *const *retVals, unsigned N) {
530 Value *V = UndefValue::get(getCurrentFunctionReturnType());
531 for (unsigned i = 0; i != N; ++i)
532 V = CreateInsertValue(V, retVals[i], i, "mrv");
533 return Insert(ReturnInst::Create(Context, V));
536 /// \brief Create an unconditional 'br label X' instruction.
537 BranchInst *CreateBr(BasicBlock *Dest) {
538 return Insert(BranchInst::Create(Dest));
541 /// \brief Create a conditional 'br Cond, TrueDest, FalseDest'
543 BranchInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False,
544 MDNode *BranchWeights = 0) {
545 return Insert(addBranchWeights(BranchInst::Create(True, False, Cond),
549 /// \brief Create a switch instruction with the specified value, default dest,
550 /// and with a hint for the number of cases that will be added (for efficient
552 SwitchInst *CreateSwitch(Value *V, BasicBlock *Dest, unsigned NumCases = 10,
553 MDNode *BranchWeights = 0) {
554 return Insert(addBranchWeights(SwitchInst::Create(V, Dest, NumCases),
558 /// \brief Create an indirect branch instruction with the specified address
559 /// operand, with an optional hint for the number of destinations that will be
560 /// added (for efficient allocation).
561 IndirectBrInst *CreateIndirectBr(Value *Addr, unsigned NumDests = 10) {
562 return Insert(IndirectBrInst::Create(Addr, NumDests));
565 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
566 BasicBlock *UnwindDest, const Twine &Name = "") {
567 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest,
568 ArrayRef<Value *>()),
571 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
572 BasicBlock *UnwindDest, Value *Arg1,
573 const Twine &Name = "") {
574 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Arg1),
577 InvokeInst *CreateInvoke3(Value *Callee, BasicBlock *NormalDest,
578 BasicBlock *UnwindDest, Value *Arg1,
579 Value *Arg2, Value *Arg3,
580 const Twine &Name = "") {
581 Value *Args[] = { Arg1, Arg2, Arg3 };
582 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
585 /// \brief Create an invoke instruction.
586 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
587 BasicBlock *UnwindDest, ArrayRef<Value *> Args,
588 const Twine &Name = "") {
589 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
593 ResumeInst *CreateResume(Value *Exn) {
594 return Insert(ResumeInst::Create(Exn));
597 UnreachableInst *CreateUnreachable() {
598 return Insert(new UnreachableInst(Context));
601 //===--------------------------------------------------------------------===//
602 // Instruction creation methods: Binary Operators
603 //===--------------------------------------------------------------------===//
605 BinaryOperator *CreateInsertNUWNSWBinOp(BinaryOperator::BinaryOps Opc,
606 Value *LHS, Value *RHS,
608 bool HasNUW, bool HasNSW) {
609 BinaryOperator *BO = Insert(BinaryOperator::Create(Opc, LHS, RHS), Name);
610 if (HasNUW) BO->setHasNoUnsignedWrap();
611 if (HasNSW) BO->setHasNoSignedWrap();
615 Instruction *AddFPMathAttributes(Instruction *I,
617 FastMathFlags FMF) const {
619 FPMathTag = DefaultFPMathTag;
621 I->setMetadata(LLVMContext::MD_fpmath, FPMathTag);
622 I->setFastMathFlags(FMF);
626 Value *CreateAdd(Value *LHS, Value *RHS, const Twine &Name = "",
627 bool HasNUW = false, bool HasNSW = false) {
628 if (Constant *LC = dyn_cast<Constant>(LHS))
629 if (Constant *RC = dyn_cast<Constant>(RHS))
630 return Insert(Folder.CreateAdd(LC, RC, HasNUW, HasNSW), Name);
631 return CreateInsertNUWNSWBinOp(Instruction::Add, LHS, RHS, Name,
634 Value *CreateNSWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
635 return CreateAdd(LHS, RHS, Name, false, true);
637 Value *CreateNUWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
638 return CreateAdd(LHS, RHS, Name, true, false);
640 Value *CreateFAdd(Value *LHS, Value *RHS, const Twine &Name = "",
641 MDNode *FPMathTag = 0) {
642 if (Constant *LC = dyn_cast<Constant>(LHS))
643 if (Constant *RC = dyn_cast<Constant>(RHS))
644 return Insert(Folder.CreateFAdd(LC, RC), Name);
645 return Insert(AddFPMathAttributes(BinaryOperator::CreateFAdd(LHS, RHS),
646 FPMathTag, FMF), Name);
648 Value *CreateSub(Value *LHS, Value *RHS, const Twine &Name = "",
649 bool HasNUW = false, bool HasNSW = false) {
650 if (Constant *LC = dyn_cast<Constant>(LHS))
651 if (Constant *RC = dyn_cast<Constant>(RHS))
652 return Insert(Folder.CreateSub(LC, RC, HasNUW, HasNSW), Name);
653 return CreateInsertNUWNSWBinOp(Instruction::Sub, LHS, RHS, Name,
656 Value *CreateNSWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
657 return CreateSub(LHS, RHS, Name, false, true);
659 Value *CreateNUWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
660 return CreateSub(LHS, RHS, Name, true, false);
662 Value *CreateFSub(Value *LHS, Value *RHS, const Twine &Name = "",
663 MDNode *FPMathTag = 0) {
664 if (Constant *LC = dyn_cast<Constant>(LHS))
665 if (Constant *RC = dyn_cast<Constant>(RHS))
666 return Insert(Folder.CreateFSub(LC, RC), Name);
667 return Insert(AddFPMathAttributes(BinaryOperator::CreateFSub(LHS, RHS),
668 FPMathTag, FMF), Name);
670 Value *CreateMul(Value *LHS, Value *RHS, const Twine &Name = "",
671 bool HasNUW = false, bool HasNSW = false) {
672 if (Constant *LC = dyn_cast<Constant>(LHS))
673 if (Constant *RC = dyn_cast<Constant>(RHS))
674 return Insert(Folder.CreateMul(LC, RC, HasNUW, HasNSW), Name);
675 return CreateInsertNUWNSWBinOp(Instruction::Mul, LHS, RHS, Name,
678 Value *CreateNSWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
679 return CreateMul(LHS, RHS, Name, false, true);
681 Value *CreateNUWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
682 return CreateMul(LHS, RHS, Name, true, false);
684 Value *CreateFMul(Value *LHS, Value *RHS, const Twine &Name = "",
685 MDNode *FPMathTag = 0) {
686 if (Constant *LC = dyn_cast<Constant>(LHS))
687 if (Constant *RC = dyn_cast<Constant>(RHS))
688 return Insert(Folder.CreateFMul(LC, RC), Name);
689 return Insert(AddFPMathAttributes(BinaryOperator::CreateFMul(LHS, RHS),
690 FPMathTag, FMF), Name);
692 Value *CreateUDiv(Value *LHS, Value *RHS, const Twine &Name = "",
693 bool isExact = false) {
694 if (Constant *LC = dyn_cast<Constant>(LHS))
695 if (Constant *RC = dyn_cast<Constant>(RHS))
696 return Insert(Folder.CreateUDiv(LC, RC, isExact), Name);
698 return Insert(BinaryOperator::CreateUDiv(LHS, RHS), Name);
699 return Insert(BinaryOperator::CreateExactUDiv(LHS, RHS), Name);
701 Value *CreateExactUDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
702 return CreateUDiv(LHS, RHS, Name, true);
704 Value *CreateSDiv(Value *LHS, Value *RHS, const Twine &Name = "",
705 bool isExact = false) {
706 if (Constant *LC = dyn_cast<Constant>(LHS))
707 if (Constant *RC = dyn_cast<Constant>(RHS))
708 return Insert(Folder.CreateSDiv(LC, RC, isExact), Name);
710 return Insert(BinaryOperator::CreateSDiv(LHS, RHS), Name);
711 return Insert(BinaryOperator::CreateExactSDiv(LHS, RHS), Name);
713 Value *CreateExactSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
714 return CreateSDiv(LHS, RHS, Name, true);
716 Value *CreateFDiv(Value *LHS, Value *RHS, const Twine &Name = "",
717 MDNode *FPMathTag = 0) {
718 if (Constant *LC = dyn_cast<Constant>(LHS))
719 if (Constant *RC = dyn_cast<Constant>(RHS))
720 return Insert(Folder.CreateFDiv(LC, RC), Name);
721 return Insert(AddFPMathAttributes(BinaryOperator::CreateFDiv(LHS, RHS),
722 FPMathTag, FMF), Name);
724 Value *CreateURem(Value *LHS, Value *RHS, const Twine &Name = "") {
725 if (Constant *LC = dyn_cast<Constant>(LHS))
726 if (Constant *RC = dyn_cast<Constant>(RHS))
727 return Insert(Folder.CreateURem(LC, RC), Name);
728 return Insert(BinaryOperator::CreateURem(LHS, RHS), Name);
730 Value *CreateSRem(Value *LHS, Value *RHS, const Twine &Name = "") {
731 if (Constant *LC = dyn_cast<Constant>(LHS))
732 if (Constant *RC = dyn_cast<Constant>(RHS))
733 return Insert(Folder.CreateSRem(LC, RC), Name);
734 return Insert(BinaryOperator::CreateSRem(LHS, RHS), Name);
736 Value *CreateFRem(Value *LHS, Value *RHS, const Twine &Name = "",
737 MDNode *FPMathTag = 0) {
738 if (Constant *LC = dyn_cast<Constant>(LHS))
739 if (Constant *RC = dyn_cast<Constant>(RHS))
740 return Insert(Folder.CreateFRem(LC, RC), Name);
741 return Insert(AddFPMathAttributes(BinaryOperator::CreateFRem(LHS, RHS),
742 FPMathTag, FMF), Name);
745 Value *CreateShl(Value *LHS, Value *RHS, const Twine &Name = "",
746 bool HasNUW = false, bool HasNSW = false) {
747 if (Constant *LC = dyn_cast<Constant>(LHS))
748 if (Constant *RC = dyn_cast<Constant>(RHS))
749 return Insert(Folder.CreateShl(LC, RC, HasNUW, HasNSW), Name);
750 return CreateInsertNUWNSWBinOp(Instruction::Shl, LHS, RHS, Name,
753 Value *CreateShl(Value *LHS, const APInt &RHS, const Twine &Name = "",
754 bool HasNUW = false, bool HasNSW = false) {
755 return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
758 Value *CreateShl(Value *LHS, uint64_t RHS, const Twine &Name = "",
759 bool HasNUW = false, bool HasNSW = false) {
760 return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
764 Value *CreateLShr(Value *LHS, Value *RHS, const Twine &Name = "",
765 bool isExact = false) {
766 if (Constant *LC = dyn_cast<Constant>(LHS))
767 if (Constant *RC = dyn_cast<Constant>(RHS))
768 return Insert(Folder.CreateLShr(LC, RC, isExact), Name);
770 return Insert(BinaryOperator::CreateLShr(LHS, RHS), Name);
771 return Insert(BinaryOperator::CreateExactLShr(LHS, RHS), Name);
773 Value *CreateLShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
774 bool isExact = false) {
775 return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
777 Value *CreateLShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
778 bool isExact = false) {
779 return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
782 Value *CreateAShr(Value *LHS, Value *RHS, const Twine &Name = "",
783 bool isExact = false) {
784 if (Constant *LC = dyn_cast<Constant>(LHS))
785 if (Constant *RC = dyn_cast<Constant>(RHS))
786 return Insert(Folder.CreateAShr(LC, RC, isExact), Name);
788 return Insert(BinaryOperator::CreateAShr(LHS, RHS), Name);
789 return Insert(BinaryOperator::CreateExactAShr(LHS, RHS), Name);
791 Value *CreateAShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
792 bool isExact = false) {
793 return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
795 Value *CreateAShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
796 bool isExact = false) {
797 return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
800 Value *CreateAnd(Value *LHS, Value *RHS, const Twine &Name = "") {
801 if (Constant *RC = dyn_cast<Constant>(RHS)) {
802 if (isa<ConstantInt>(RC) && cast<ConstantInt>(RC)->isAllOnesValue())
803 return LHS; // LHS & -1 -> LHS
804 if (Constant *LC = dyn_cast<Constant>(LHS))
805 return Insert(Folder.CreateAnd(LC, RC), Name);
807 return Insert(BinaryOperator::CreateAnd(LHS, RHS), Name);
809 Value *CreateAnd(Value *LHS, const APInt &RHS, const Twine &Name = "") {
810 return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
812 Value *CreateAnd(Value *LHS, uint64_t RHS, const Twine &Name = "") {
813 return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
816 Value *CreateOr(Value *LHS, Value *RHS, const Twine &Name = "") {
817 if (Constant *RC = dyn_cast<Constant>(RHS)) {
818 if (RC->isNullValue())
819 return LHS; // LHS | 0 -> LHS
820 if (Constant *LC = dyn_cast<Constant>(LHS))
821 return Insert(Folder.CreateOr(LC, RC), Name);
823 return Insert(BinaryOperator::CreateOr(LHS, RHS), Name);
825 Value *CreateOr(Value *LHS, const APInt &RHS, const Twine &Name = "") {
826 return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
828 Value *CreateOr(Value *LHS, uint64_t RHS, const Twine &Name = "") {
829 return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
832 Value *CreateXor(Value *LHS, Value *RHS, const Twine &Name = "") {
833 if (Constant *LC = dyn_cast<Constant>(LHS))
834 if (Constant *RC = dyn_cast<Constant>(RHS))
835 return Insert(Folder.CreateXor(LC, RC), Name);
836 return Insert(BinaryOperator::CreateXor(LHS, RHS), Name);
838 Value *CreateXor(Value *LHS, const APInt &RHS, const Twine &Name = "") {
839 return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
841 Value *CreateXor(Value *LHS, uint64_t RHS, const Twine &Name = "") {
842 return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
845 Value *CreateBinOp(Instruction::BinaryOps Opc,
846 Value *LHS, Value *RHS, const Twine &Name = "",
847 MDNode *FPMathTag = 0) {
848 if (Constant *LC = dyn_cast<Constant>(LHS))
849 if (Constant *RC = dyn_cast<Constant>(RHS))
850 return Insert(Folder.CreateBinOp(Opc, LC, RC), Name);
851 llvm::Instruction *BinOp = BinaryOperator::Create(Opc, LHS, RHS);
852 if (isa<FPMathOperator>(BinOp))
853 BinOp = AddFPMathAttributes(BinOp, FPMathTag, FMF);
854 return Insert(BinOp, Name);
857 Value *CreateNeg(Value *V, const Twine &Name = "",
858 bool HasNUW = false, bool HasNSW = false) {
859 if (Constant *VC = dyn_cast<Constant>(V))
860 return Insert(Folder.CreateNeg(VC, HasNUW, HasNSW), Name);
861 BinaryOperator *BO = Insert(BinaryOperator::CreateNeg(V), Name);
862 if (HasNUW) BO->setHasNoUnsignedWrap();
863 if (HasNSW) BO->setHasNoSignedWrap();
866 Value *CreateNSWNeg(Value *V, const Twine &Name = "") {
867 return CreateNeg(V, Name, false, true);
869 Value *CreateNUWNeg(Value *V, const Twine &Name = "") {
870 return CreateNeg(V, Name, true, false);
872 Value *CreateFNeg(Value *V, const Twine &Name = "", MDNode *FPMathTag = 0) {
873 if (Constant *VC = dyn_cast<Constant>(V))
874 return Insert(Folder.CreateFNeg(VC), Name);
875 return Insert(AddFPMathAttributes(BinaryOperator::CreateFNeg(V),
876 FPMathTag, FMF), Name);
878 Value *CreateNot(Value *V, const Twine &Name = "") {
879 if (Constant *VC = dyn_cast<Constant>(V))
880 return Insert(Folder.CreateNot(VC), Name);
881 return Insert(BinaryOperator::CreateNot(V), Name);
884 //===--------------------------------------------------------------------===//
885 // Instruction creation methods: Memory Instructions
886 //===--------------------------------------------------------------------===//
888 AllocaInst *CreateAlloca(Type *Ty, Value *ArraySize = 0,
889 const Twine &Name = "") {
890 return Insert(new AllocaInst(Ty, ArraySize), Name);
892 // \brief Provided to resolve 'CreateLoad(Ptr, "...")' correctly, instead of
893 // converting the string to 'bool' for the isVolatile parameter.
894 LoadInst *CreateLoad(Value *Ptr, const char *Name) {
895 return Insert(new LoadInst(Ptr), Name);
897 LoadInst *CreateLoad(Value *Ptr, const Twine &Name = "") {
898 return Insert(new LoadInst(Ptr), Name);
900 LoadInst *CreateLoad(Value *Ptr, bool isVolatile, const Twine &Name = "") {
901 return Insert(new LoadInst(Ptr, 0, isVolatile), Name);
903 StoreInst *CreateStore(Value *Val, Value *Ptr, bool isVolatile = false) {
904 return Insert(new StoreInst(Val, Ptr, isVolatile));
906 // \brief Provided to resolve 'CreateAlignedLoad(Ptr, Align, "...")'
907 // correctly, instead of converting the string to 'bool' for the isVolatile
909 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, const char *Name) {
910 LoadInst *LI = CreateLoad(Ptr, Name);
911 LI->setAlignment(Align);
914 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align,
915 const Twine &Name = "") {
916 LoadInst *LI = CreateLoad(Ptr, Name);
917 LI->setAlignment(Align);
920 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, bool isVolatile,
921 const Twine &Name = "") {
922 LoadInst *LI = CreateLoad(Ptr, isVolatile, Name);
923 LI->setAlignment(Align);
926 StoreInst *CreateAlignedStore(Value *Val, Value *Ptr, unsigned Align,
927 bool isVolatile = false) {
928 StoreInst *SI = CreateStore(Val, Ptr, isVolatile);
929 SI->setAlignment(Align);
932 FenceInst *CreateFence(AtomicOrdering Ordering,
933 SynchronizationScope SynchScope = CrossThread,
934 const Twine &Name = "") {
935 return Insert(new FenceInst(Context, Ordering, SynchScope), Name);
938 CreateAtomicCmpXchg(Value *Ptr, Value *Cmp, Value *New,
939 AtomicOrdering SuccessOrdering,
940 AtomicOrdering FailureOrdering,
941 SynchronizationScope SynchScope = CrossThread) {
942 return Insert(new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering,
943 FailureOrdering, SynchScope));
945 AtomicRMWInst *CreateAtomicRMW(AtomicRMWInst::BinOp Op, Value *Ptr, Value *Val,
946 AtomicOrdering Ordering,
947 SynchronizationScope SynchScope = CrossThread) {
948 return Insert(new AtomicRMWInst(Op, Ptr, Val, Ordering, SynchScope));
950 Value *CreateGEP(Value *Ptr, ArrayRef<Value *> IdxList,
951 const Twine &Name = "") {
952 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
953 // Every index must be constant.
955 for (i = 0, e = IdxList.size(); i != e; ++i)
956 if (!isa<Constant>(IdxList[i]))
959 return Insert(Folder.CreateGetElementPtr(PC, IdxList), Name);
961 return Insert(GetElementPtrInst::Create(Ptr, IdxList), Name);
963 Value *CreateInBoundsGEP(Value *Ptr, ArrayRef<Value *> IdxList,
964 const Twine &Name = "") {
965 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
966 // Every index must be constant.
968 for (i = 0, e = IdxList.size(); i != e; ++i)
969 if (!isa<Constant>(IdxList[i]))
972 return Insert(Folder.CreateInBoundsGetElementPtr(PC, IdxList), Name);
974 return Insert(GetElementPtrInst::CreateInBounds(Ptr, IdxList), Name);
976 Value *CreateGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
977 if (Constant *PC = dyn_cast<Constant>(Ptr))
978 if (Constant *IC = dyn_cast<Constant>(Idx))
979 return Insert(Folder.CreateGetElementPtr(PC, IC), Name);
980 return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
982 Value *CreateInBoundsGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
983 if (Constant *PC = dyn_cast<Constant>(Ptr))
984 if (Constant *IC = dyn_cast<Constant>(Idx))
985 return Insert(Folder.CreateInBoundsGetElementPtr(PC, IC), Name);
986 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
988 Value *CreateConstGEP1_32(Value *Ptr, unsigned Idx0, const Twine &Name = "") {
989 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
991 if (Constant *PC = dyn_cast<Constant>(Ptr))
992 return Insert(Folder.CreateGetElementPtr(PC, Idx), Name);
994 return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
996 Value *CreateConstInBoundsGEP1_32(Value *Ptr, unsigned Idx0,
997 const Twine &Name = "") {
998 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
1000 if (Constant *PC = dyn_cast<Constant>(Ptr))
1001 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idx), Name);
1003 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
1005 Value *CreateConstGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
1006 const Twine &Name = "") {
1008 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1009 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1012 if (Constant *PC = dyn_cast<Constant>(Ptr))
1013 return Insert(Folder.CreateGetElementPtr(PC, Idxs), Name);
1015 return Insert(GetElementPtrInst::Create(Ptr, Idxs), Name);
1017 Value *CreateConstInBoundsGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
1018 const Twine &Name = "") {
1020 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1021 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1024 if (Constant *PC = dyn_cast<Constant>(Ptr))
1025 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idxs), Name);
1027 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs), Name);
1029 Value *CreateConstGEP1_64(Value *Ptr, uint64_t Idx0, const Twine &Name = "") {
1030 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1032 if (Constant *PC = dyn_cast<Constant>(Ptr))
1033 return Insert(Folder.CreateGetElementPtr(PC, Idx), Name);
1035 return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
1037 Value *CreateConstInBoundsGEP1_64(Value *Ptr, uint64_t Idx0,
1038 const Twine &Name = "") {
1039 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1041 if (Constant *PC = dyn_cast<Constant>(Ptr))
1042 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idx), Name);
1044 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
1046 Value *CreateConstGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1047 const Twine &Name = "") {
1049 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1050 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1053 if (Constant *PC = dyn_cast<Constant>(Ptr))
1054 return Insert(Folder.CreateGetElementPtr(PC, Idxs), Name);
1056 return Insert(GetElementPtrInst::Create(Ptr, Idxs), Name);
1058 Value *CreateConstInBoundsGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1059 const Twine &Name = "") {
1061 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1062 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1065 if (Constant *PC = dyn_cast<Constant>(Ptr))
1066 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idxs), Name);
1068 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs), Name);
1070 Value *CreateStructGEP(Value *Ptr, unsigned Idx, const Twine &Name = "") {
1071 return CreateConstInBoundsGEP2_32(Ptr, 0, Idx, Name);
1074 /// \brief Same as CreateGlobalString, but return a pointer with "i8*" type
1075 /// instead of a pointer to array of i8.
1076 Value *CreateGlobalStringPtr(StringRef Str, const Twine &Name = "") {
1077 Value *gv = CreateGlobalString(Str, Name);
1078 Value *zero = ConstantInt::get(Type::getInt32Ty(Context), 0);
1079 Value *Args[] = { zero, zero };
1080 return CreateInBoundsGEP(gv, Args, Name);
1083 //===--------------------------------------------------------------------===//
1084 // Instruction creation methods: Cast/Conversion Operators
1085 //===--------------------------------------------------------------------===//
1087 Value *CreateTrunc(Value *V, Type *DestTy, const Twine &Name = "") {
1088 return CreateCast(Instruction::Trunc, V, DestTy, Name);
1090 Value *CreateZExt(Value *V, Type *DestTy, const Twine &Name = "") {
1091 return CreateCast(Instruction::ZExt, V, DestTy, Name);
1093 Value *CreateSExt(Value *V, Type *DestTy, const Twine &Name = "") {
1094 return CreateCast(Instruction::SExt, V, DestTy, Name);
1096 /// \brief Create a ZExt or Trunc from the integer value V to DestTy. Return
1097 /// the value untouched if the type of V is already DestTy.
1098 Value *CreateZExtOrTrunc(Value *V, Type *DestTy,
1099 const Twine &Name = "") {
1100 assert(V->getType()->isIntOrIntVectorTy() &&
1101 DestTy->isIntOrIntVectorTy() &&
1102 "Can only zero extend/truncate integers!");
1103 Type *VTy = V->getType();
1104 if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1105 return CreateZExt(V, DestTy, Name);
1106 if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1107 return CreateTrunc(V, DestTy, Name);
1110 /// \brief Create a SExt or Trunc from the integer value V to DestTy. Return
1111 /// the value untouched if the type of V is already DestTy.
1112 Value *CreateSExtOrTrunc(Value *V, Type *DestTy,
1113 const Twine &Name = "") {
1114 assert(V->getType()->isIntOrIntVectorTy() &&
1115 DestTy->isIntOrIntVectorTy() &&
1116 "Can only sign extend/truncate integers!");
1117 Type *VTy = V->getType();
1118 if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1119 return CreateSExt(V, DestTy, Name);
1120 if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1121 return CreateTrunc(V, DestTy, Name);
1124 Value *CreateFPToUI(Value *V, Type *DestTy, const Twine &Name = ""){
1125 return CreateCast(Instruction::FPToUI, V, DestTy, Name);
1127 Value *CreateFPToSI(Value *V, Type *DestTy, const Twine &Name = ""){
1128 return CreateCast(Instruction::FPToSI, V, DestTy, Name);
1130 Value *CreateUIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1131 return CreateCast(Instruction::UIToFP, V, DestTy, Name);
1133 Value *CreateSIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1134 return CreateCast(Instruction::SIToFP, V, DestTy, Name);
1136 Value *CreateFPTrunc(Value *V, Type *DestTy,
1137 const Twine &Name = "") {
1138 return CreateCast(Instruction::FPTrunc, V, DestTy, Name);
1140 Value *CreateFPExt(Value *V, Type *DestTy, const Twine &Name = "") {
1141 return CreateCast(Instruction::FPExt, V, DestTy, Name);
1143 Value *CreatePtrToInt(Value *V, Type *DestTy,
1144 const Twine &Name = "") {
1145 return CreateCast(Instruction::PtrToInt, V, DestTy, Name);
1147 Value *CreateIntToPtr(Value *V, Type *DestTy,
1148 const Twine &Name = "") {
1149 return CreateCast(Instruction::IntToPtr, V, DestTy, Name);
1151 Value *CreateBitCast(Value *V, Type *DestTy,
1152 const Twine &Name = "") {
1153 return CreateCast(Instruction::BitCast, V, DestTy, Name);
1155 Value *CreateAddrSpaceCast(Value *V, Type *DestTy,
1156 const Twine &Name = "") {
1157 return CreateCast(Instruction::AddrSpaceCast, V, DestTy, Name);
1159 Value *CreateZExtOrBitCast(Value *V, Type *DestTy,
1160 const Twine &Name = "") {
1161 if (V->getType() == DestTy)
1163 if (Constant *VC = dyn_cast<Constant>(V))
1164 return Insert(Folder.CreateZExtOrBitCast(VC, DestTy), Name);
1165 return Insert(CastInst::CreateZExtOrBitCast(V, DestTy), Name);
1167 Value *CreateSExtOrBitCast(Value *V, Type *DestTy,
1168 const Twine &Name = "") {
1169 if (V->getType() == DestTy)
1171 if (Constant *VC = dyn_cast<Constant>(V))
1172 return Insert(Folder.CreateSExtOrBitCast(VC, DestTy), Name);
1173 return Insert(CastInst::CreateSExtOrBitCast(V, DestTy), Name);
1175 Value *CreateTruncOrBitCast(Value *V, Type *DestTy,
1176 const Twine &Name = "") {
1177 if (V->getType() == DestTy)
1179 if (Constant *VC = dyn_cast<Constant>(V))
1180 return Insert(Folder.CreateTruncOrBitCast(VC, DestTy), Name);
1181 return Insert(CastInst::CreateTruncOrBitCast(V, DestTy), Name);
1183 Value *CreateCast(Instruction::CastOps Op, Value *V, Type *DestTy,
1184 const Twine &Name = "") {
1185 if (V->getType() == DestTy)
1187 if (Constant *VC = dyn_cast<Constant>(V))
1188 return Insert(Folder.CreateCast(Op, VC, DestTy), Name);
1189 return Insert(CastInst::Create(Op, V, DestTy), Name);
1191 Value *CreatePointerCast(Value *V, Type *DestTy,
1192 const Twine &Name = "") {
1193 if (V->getType() == DestTy)
1195 if (Constant *VC = dyn_cast<Constant>(V))
1196 return Insert(Folder.CreatePointerCast(VC, DestTy), Name);
1197 return Insert(CastInst::CreatePointerCast(V, DestTy), Name);
1199 Value *CreateIntCast(Value *V, Type *DestTy, bool isSigned,
1200 const Twine &Name = "") {
1201 if (V->getType() == DestTy)
1203 if (Constant *VC = dyn_cast<Constant>(V))
1204 return Insert(Folder.CreateIntCast(VC, DestTy, isSigned), Name);
1205 return Insert(CastInst::CreateIntegerCast(V, DestTy, isSigned), Name);
1208 // \brief Provided to resolve 'CreateIntCast(Ptr, Ptr, "...")', giving a
1209 // compile time error, instead of converting the string to bool for the
1210 // isSigned parameter.
1211 Value *CreateIntCast(Value *, Type *, const char *) LLVM_DELETED_FUNCTION;
1213 Value *CreateFPCast(Value *V, Type *DestTy, const Twine &Name = "") {
1214 if (V->getType() == DestTy)
1216 if (Constant *VC = dyn_cast<Constant>(V))
1217 return Insert(Folder.CreateFPCast(VC, DestTy), Name);
1218 return Insert(CastInst::CreateFPCast(V, DestTy), Name);
1221 //===--------------------------------------------------------------------===//
1222 // Instruction creation methods: Compare Instructions
1223 //===--------------------------------------------------------------------===//
1225 Value *CreateICmpEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1226 return CreateICmp(ICmpInst::ICMP_EQ, LHS, RHS, Name);
1228 Value *CreateICmpNE(Value *LHS, Value *RHS, const Twine &Name = "") {
1229 return CreateICmp(ICmpInst::ICMP_NE, LHS, RHS, Name);
1231 Value *CreateICmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1232 return CreateICmp(ICmpInst::ICMP_UGT, LHS, RHS, Name);
1234 Value *CreateICmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1235 return CreateICmp(ICmpInst::ICMP_UGE, LHS, RHS, Name);
1237 Value *CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
1238 return CreateICmp(ICmpInst::ICMP_ULT, LHS, RHS, Name);
1240 Value *CreateICmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
1241 return CreateICmp(ICmpInst::ICMP_ULE, LHS, RHS, Name);
1243 Value *CreateICmpSGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1244 return CreateICmp(ICmpInst::ICMP_SGT, LHS, RHS, Name);
1246 Value *CreateICmpSGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1247 return CreateICmp(ICmpInst::ICMP_SGE, LHS, RHS, Name);
1249 Value *CreateICmpSLT(Value *LHS, Value *RHS, const Twine &Name = "") {
1250 return CreateICmp(ICmpInst::ICMP_SLT, LHS, RHS, Name);
1252 Value *CreateICmpSLE(Value *LHS, Value *RHS, const Twine &Name = "") {
1253 return CreateICmp(ICmpInst::ICMP_SLE, LHS, RHS, Name);
1256 Value *CreateFCmpOEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1257 return CreateFCmp(FCmpInst::FCMP_OEQ, LHS, RHS, Name);
1259 Value *CreateFCmpOGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1260 return CreateFCmp(FCmpInst::FCMP_OGT, LHS, RHS, Name);
1262 Value *CreateFCmpOGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1263 return CreateFCmp(FCmpInst::FCMP_OGE, LHS, RHS, Name);
1265 Value *CreateFCmpOLT(Value *LHS, Value *RHS, const Twine &Name = "") {
1266 return CreateFCmp(FCmpInst::FCMP_OLT, LHS, RHS, Name);
1268 Value *CreateFCmpOLE(Value *LHS, Value *RHS, const Twine &Name = "") {
1269 return CreateFCmp(FCmpInst::FCMP_OLE, LHS, RHS, Name);
1271 Value *CreateFCmpONE(Value *LHS, Value *RHS, const Twine &Name = "") {
1272 return CreateFCmp(FCmpInst::FCMP_ONE, LHS, RHS, Name);
1274 Value *CreateFCmpORD(Value *LHS, Value *RHS, const Twine &Name = "") {
1275 return CreateFCmp(FCmpInst::FCMP_ORD, LHS, RHS, Name);
1277 Value *CreateFCmpUNO(Value *LHS, Value *RHS, const Twine &Name = "") {
1278 return CreateFCmp(FCmpInst::FCMP_UNO, LHS, RHS, Name);
1280 Value *CreateFCmpUEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1281 return CreateFCmp(FCmpInst::FCMP_UEQ, LHS, RHS, Name);
1283 Value *CreateFCmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1284 return CreateFCmp(FCmpInst::FCMP_UGT, LHS, RHS, Name);
1286 Value *CreateFCmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1287 return CreateFCmp(FCmpInst::FCMP_UGE, LHS, RHS, Name);
1289 Value *CreateFCmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
1290 return CreateFCmp(FCmpInst::FCMP_ULT, LHS, RHS, Name);
1292 Value *CreateFCmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
1293 return CreateFCmp(FCmpInst::FCMP_ULE, LHS, RHS, Name);
1295 Value *CreateFCmpUNE(Value *LHS, Value *RHS, const Twine &Name = "") {
1296 return CreateFCmp(FCmpInst::FCMP_UNE, LHS, RHS, Name);
1299 Value *CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1300 const Twine &Name = "") {
1301 if (Constant *LC = dyn_cast<Constant>(LHS))
1302 if (Constant *RC = dyn_cast<Constant>(RHS))
1303 return Insert(Folder.CreateICmp(P, LC, RC), Name);
1304 return Insert(new ICmpInst(P, LHS, RHS), Name);
1306 Value *CreateFCmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1307 const Twine &Name = "") {
1308 if (Constant *LC = dyn_cast<Constant>(LHS))
1309 if (Constant *RC = dyn_cast<Constant>(RHS))
1310 return Insert(Folder.CreateFCmp(P, LC, RC), Name);
1311 return Insert(new FCmpInst(P, LHS, RHS), Name);
1314 //===--------------------------------------------------------------------===//
1315 // Instruction creation methods: Other Instructions
1316 //===--------------------------------------------------------------------===//
1318 PHINode *CreatePHI(Type *Ty, unsigned NumReservedValues,
1319 const Twine &Name = "") {
1320 return Insert(PHINode::Create(Ty, NumReservedValues), Name);
1323 CallInst *CreateCall(Value *Callee, const Twine &Name = "") {
1324 return Insert(CallInst::Create(Callee), Name);
1326 CallInst *CreateCall(Value *Callee, Value *Arg, const Twine &Name = "") {
1327 return Insert(CallInst::Create(Callee, Arg), Name);
1329 CallInst *CreateCall2(Value *Callee, Value *Arg1, Value *Arg2,
1330 const Twine &Name = "") {
1331 Value *Args[] = { Arg1, Arg2 };
1332 return Insert(CallInst::Create(Callee, Args), Name);
1334 CallInst *CreateCall3(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1335 const Twine &Name = "") {
1336 Value *Args[] = { Arg1, Arg2, Arg3 };
1337 return Insert(CallInst::Create(Callee, Args), Name);
1339 CallInst *CreateCall4(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1340 Value *Arg4, const Twine &Name = "") {
1341 Value *Args[] = { Arg1, Arg2, Arg3, Arg4 };
1342 return Insert(CallInst::Create(Callee, Args), Name);
1344 CallInst *CreateCall5(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1345 Value *Arg4, Value *Arg5, const Twine &Name = "") {
1346 Value *Args[] = { Arg1, Arg2, Arg3, Arg4, Arg5 };
1347 return Insert(CallInst::Create(Callee, Args), Name);
1350 CallInst *CreateCall(Value *Callee, ArrayRef<Value *> Args,
1351 const Twine &Name = "") {
1352 return Insert(CallInst::Create(Callee, Args), Name);
1355 Value *CreateSelect(Value *C, Value *True, Value *False,
1356 const Twine &Name = "") {
1357 if (Constant *CC = dyn_cast<Constant>(C))
1358 if (Constant *TC = dyn_cast<Constant>(True))
1359 if (Constant *FC = dyn_cast<Constant>(False))
1360 return Insert(Folder.CreateSelect(CC, TC, FC), Name);
1361 return Insert(SelectInst::Create(C, True, False), Name);
1364 VAArgInst *CreateVAArg(Value *List, Type *Ty, const Twine &Name = "") {
1365 return Insert(new VAArgInst(List, Ty), Name);
1368 Value *CreateExtractElement(Value *Vec, Value *Idx,
1369 const Twine &Name = "") {
1370 if (Constant *VC = dyn_cast<Constant>(Vec))
1371 if (Constant *IC = dyn_cast<Constant>(Idx))
1372 return Insert(Folder.CreateExtractElement(VC, IC), Name);
1373 return Insert(ExtractElementInst::Create(Vec, Idx), Name);
1376 Value *CreateInsertElement(Value *Vec, Value *NewElt, Value *Idx,
1377 const Twine &Name = "") {
1378 if (Constant *VC = dyn_cast<Constant>(Vec))
1379 if (Constant *NC = dyn_cast<Constant>(NewElt))
1380 if (Constant *IC = dyn_cast<Constant>(Idx))
1381 return Insert(Folder.CreateInsertElement(VC, NC, IC), Name);
1382 return Insert(InsertElementInst::Create(Vec, NewElt, Idx), Name);
1385 Value *CreateShuffleVector(Value *V1, Value *V2, Value *Mask,
1386 const Twine &Name = "") {
1387 if (Constant *V1C = dyn_cast<Constant>(V1))
1388 if (Constant *V2C = dyn_cast<Constant>(V2))
1389 if (Constant *MC = dyn_cast<Constant>(Mask))
1390 return Insert(Folder.CreateShuffleVector(V1C, V2C, MC), Name);
1391 return Insert(new ShuffleVectorInst(V1, V2, Mask), Name);
1394 Value *CreateExtractValue(Value *Agg,
1395 ArrayRef<unsigned> Idxs,
1396 const Twine &Name = "") {
1397 if (Constant *AggC = dyn_cast<Constant>(Agg))
1398 return Insert(Folder.CreateExtractValue(AggC, Idxs), Name);
1399 return Insert(ExtractValueInst::Create(Agg, Idxs), Name);
1402 Value *CreateInsertValue(Value *Agg, Value *Val,
1403 ArrayRef<unsigned> Idxs,
1404 const Twine &Name = "") {
1405 if (Constant *AggC = dyn_cast<Constant>(Agg))
1406 if (Constant *ValC = dyn_cast<Constant>(Val))
1407 return Insert(Folder.CreateInsertValue(AggC, ValC, Idxs), Name);
1408 return Insert(InsertValueInst::Create(Agg, Val, Idxs), Name);
1411 LandingPadInst *CreateLandingPad(Type *Ty, Value *PersFn, unsigned NumClauses,
1412 const Twine &Name = "") {
1413 return Insert(LandingPadInst::Create(Ty, PersFn, NumClauses), Name);
1416 //===--------------------------------------------------------------------===//
1417 // Utility creation methods
1418 //===--------------------------------------------------------------------===//
1420 /// \brief Return an i1 value testing if \p Arg is null.
1421 Value *CreateIsNull(Value *Arg, const Twine &Name = "") {
1422 return CreateICmpEQ(Arg, Constant::getNullValue(Arg->getType()),
1426 /// \brief Return an i1 value testing if \p Arg is not null.
1427 Value *CreateIsNotNull(Value *Arg, const Twine &Name = "") {
1428 return CreateICmpNE(Arg, Constant::getNullValue(Arg->getType()),
1432 /// \brief Return the i64 difference between two pointer values, dividing out
1433 /// the size of the pointed-to objects.
1435 /// This is intended to implement C-style pointer subtraction. As such, the
1436 /// pointers must be appropriately aligned for their element types and
1437 /// pointing into the same object.
1438 Value *CreatePtrDiff(Value *LHS, Value *RHS, const Twine &Name = "") {
1439 assert(LHS->getType() == RHS->getType() &&
1440 "Pointer subtraction operand types must match!");
1441 PointerType *ArgType = cast<PointerType>(LHS->getType());
1442 Value *LHS_int = CreatePtrToInt(LHS, Type::getInt64Ty(Context));
1443 Value *RHS_int = CreatePtrToInt(RHS, Type::getInt64Ty(Context));
1444 Value *Difference = CreateSub(LHS_int, RHS_int);
1445 return CreateExactSDiv(Difference,
1446 ConstantExpr::getSizeOf(ArgType->getElementType()),
1450 /// \brief Return a vector value that contains \arg V broadcasted to \p
1451 /// NumElts elements.
1452 Value *CreateVectorSplat(unsigned NumElts, Value *V, const Twine &Name = "") {
1453 assert(NumElts > 0 && "Cannot splat to an empty vector!");
1455 // First insert it into an undef vector so we can shuffle it.
1456 Type *I32Ty = getInt32Ty();
1457 Value *Undef = UndefValue::get(VectorType::get(V->getType(), NumElts));
1458 V = CreateInsertElement(Undef, V, ConstantInt::get(I32Ty, 0),
1459 Name + ".splatinsert");
1461 // Shuffle the value across the desired number of elements.
1462 Value *Zeros = ConstantAggregateZero::get(VectorType::get(I32Ty, NumElts));
1463 return CreateShuffleVector(V, Undef, Zeros, Name + ".splat");
1467 // Create wrappers for C Binding types (see CBindingWrapping.h).
1468 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef)