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 = nullptr)
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(nullptr) {}
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 != nullptr); }
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 = nullptr) {
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 = nullptr);
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 = nullptr,
378 MDNode *TBAAStructTag = nullptr) {
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 = nullptr,
385 MDNode *TBAAStructTag = nullptr);
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 = nullptr) {
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 = nullptr);
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 = nullptr);
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 = nullptr);
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 = nullptr)
437 : IRBuilderBase(C, FPMathTag), Inserter(I), Folder(F) {
440 explicit IRBuilder(LLVMContext &C, MDNode *FPMathTag = nullptr)
441 : IRBuilderBase(C, FPMathTag), Folder() {
444 explicit IRBuilder(BasicBlock *TheBB, const T &F, MDNode *FPMathTag = nullptr)
445 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
446 SetInsertPoint(TheBB);
449 explicit IRBuilder(BasicBlock *TheBB, MDNode *FPMathTag = nullptr)
450 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
451 SetInsertPoint(TheBB);
454 explicit IRBuilder(Instruction *IP, MDNode *FPMathTag = nullptr)
455 : IRBuilderBase(IP->getContext(), FPMathTag), Folder() {
457 SetCurrentDebugLocation(IP->getDebugLoc());
460 explicit IRBuilder(Use &U, MDNode *FPMathTag = nullptr)
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 = nullptr)
468 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
469 SetInsertPoint(TheBB, IP);
472 IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP,
473 MDNode *FPMathTag = nullptr)
474 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
475 SetInsertPoint(TheBB, IP);
478 /// \brief Get the constant folder being used.
479 const T &getFolder() { return Folder; }
481 /// \brief Return true if this builder is configured to actually add the
482 /// requested names to IR created through it.
483 bool isNamePreserving() const { return preserveNames; }
485 /// \brief Insert and return the specified instruction.
486 template<typename InstTy>
487 InstTy *Insert(InstTy *I, const Twine &Name = "") const {
488 this->InsertHelper(I, Name, BB, InsertPt);
489 this->SetInstDebugLocation(I);
493 /// \brief No-op overload to handle constants.
494 Constant *Insert(Constant *C, const Twine& = "") const {
498 //===--------------------------------------------------------------------===//
499 // Instruction creation methods: Terminators
500 //===--------------------------------------------------------------------===//
503 /// \brief Helper to add branch weight metadata onto an instruction.
504 /// \returns The annotated instruction.
505 template <typename InstTy>
506 InstTy *addBranchWeights(InstTy *I, MDNode *Weights) {
508 I->setMetadata(LLVMContext::MD_prof, Weights);
513 /// \brief Create a 'ret void' instruction.
514 ReturnInst *CreateRetVoid() {
515 return Insert(ReturnInst::Create(Context));
518 /// \brief Create a 'ret <val>' instruction.
519 ReturnInst *CreateRet(Value *V) {
520 return Insert(ReturnInst::Create(Context, V));
523 /// \brief Create a sequence of N insertvalue instructions,
524 /// with one Value from the retVals array each, that build a aggregate
525 /// return value one value at a time, and a ret instruction to return
526 /// the resulting aggregate value.
528 /// This is a convenience function for code that uses aggregate return values
529 /// as a vehicle for having multiple return values.
530 ReturnInst *CreateAggregateRet(Value *const *retVals, unsigned N) {
531 Value *V = UndefValue::get(getCurrentFunctionReturnType());
532 for (unsigned i = 0; i != N; ++i)
533 V = CreateInsertValue(V, retVals[i], i, "mrv");
534 return Insert(ReturnInst::Create(Context, V));
537 /// \brief Create an unconditional 'br label X' instruction.
538 BranchInst *CreateBr(BasicBlock *Dest) {
539 return Insert(BranchInst::Create(Dest));
542 /// \brief Create a conditional 'br Cond, TrueDest, FalseDest'
544 BranchInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False,
545 MDNode *BranchWeights = nullptr) {
546 return Insert(addBranchWeights(BranchInst::Create(True, False, Cond),
550 /// \brief Create a switch instruction with the specified value, default dest,
551 /// and with a hint for the number of cases that will be added (for efficient
553 SwitchInst *CreateSwitch(Value *V, BasicBlock *Dest, unsigned NumCases = 10,
554 MDNode *BranchWeights = nullptr) {
555 return Insert(addBranchWeights(SwitchInst::Create(V, Dest, NumCases),
559 /// \brief Create an indirect branch instruction with the specified address
560 /// operand, with an optional hint for the number of destinations that will be
561 /// added (for efficient allocation).
562 IndirectBrInst *CreateIndirectBr(Value *Addr, unsigned NumDests = 10) {
563 return Insert(IndirectBrInst::Create(Addr, NumDests));
566 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
567 BasicBlock *UnwindDest, const Twine &Name = "") {
568 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest,
569 ArrayRef<Value *>()),
572 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
573 BasicBlock *UnwindDest, Value *Arg1,
574 const Twine &Name = "") {
575 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Arg1),
578 InvokeInst *CreateInvoke3(Value *Callee, BasicBlock *NormalDest,
579 BasicBlock *UnwindDest, Value *Arg1,
580 Value *Arg2, Value *Arg3,
581 const Twine &Name = "") {
582 Value *Args[] = { Arg1, Arg2, Arg3 };
583 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
586 /// \brief Create an invoke instruction.
587 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
588 BasicBlock *UnwindDest, ArrayRef<Value *> Args,
589 const Twine &Name = "") {
590 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
594 ResumeInst *CreateResume(Value *Exn) {
595 return Insert(ResumeInst::Create(Exn));
598 UnreachableInst *CreateUnreachable() {
599 return Insert(new UnreachableInst(Context));
602 //===--------------------------------------------------------------------===//
603 // Instruction creation methods: Binary Operators
604 //===--------------------------------------------------------------------===//
606 BinaryOperator *CreateInsertNUWNSWBinOp(BinaryOperator::BinaryOps Opc,
607 Value *LHS, Value *RHS,
609 bool HasNUW, bool HasNSW) {
610 BinaryOperator *BO = Insert(BinaryOperator::Create(Opc, LHS, RHS), Name);
611 if (HasNUW) BO->setHasNoUnsignedWrap();
612 if (HasNSW) BO->setHasNoSignedWrap();
616 Instruction *AddFPMathAttributes(Instruction *I,
618 FastMathFlags FMF) const {
620 FPMathTag = DefaultFPMathTag;
622 I->setMetadata(LLVMContext::MD_fpmath, FPMathTag);
623 I->setFastMathFlags(FMF);
627 Value *CreateAdd(Value *LHS, Value *RHS, const Twine &Name = "",
628 bool HasNUW = false, bool HasNSW = false) {
629 if (Constant *LC = dyn_cast<Constant>(LHS))
630 if (Constant *RC = dyn_cast<Constant>(RHS))
631 return Insert(Folder.CreateAdd(LC, RC, HasNUW, HasNSW), Name);
632 return CreateInsertNUWNSWBinOp(Instruction::Add, LHS, RHS, Name,
635 Value *CreateNSWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
636 return CreateAdd(LHS, RHS, Name, false, true);
638 Value *CreateNUWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
639 return CreateAdd(LHS, RHS, Name, true, false);
641 Value *CreateFAdd(Value *LHS, Value *RHS, const Twine &Name = "",
642 MDNode *FPMathTag = nullptr) {
643 if (Constant *LC = dyn_cast<Constant>(LHS))
644 if (Constant *RC = dyn_cast<Constant>(RHS))
645 return Insert(Folder.CreateFAdd(LC, RC), Name);
646 return Insert(AddFPMathAttributes(BinaryOperator::CreateFAdd(LHS, RHS),
647 FPMathTag, FMF), Name);
649 Value *CreateSub(Value *LHS, Value *RHS, const Twine &Name = "",
650 bool HasNUW = false, bool HasNSW = false) {
651 if (Constant *LC = dyn_cast<Constant>(LHS))
652 if (Constant *RC = dyn_cast<Constant>(RHS))
653 return Insert(Folder.CreateSub(LC, RC, HasNUW, HasNSW), Name);
654 return CreateInsertNUWNSWBinOp(Instruction::Sub, LHS, RHS, Name,
657 Value *CreateNSWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
658 return CreateSub(LHS, RHS, Name, false, true);
660 Value *CreateNUWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
661 return CreateSub(LHS, RHS, Name, true, false);
663 Value *CreateFSub(Value *LHS, Value *RHS, const Twine &Name = "",
664 MDNode *FPMathTag = nullptr) {
665 if (Constant *LC = dyn_cast<Constant>(LHS))
666 if (Constant *RC = dyn_cast<Constant>(RHS))
667 return Insert(Folder.CreateFSub(LC, RC), Name);
668 return Insert(AddFPMathAttributes(BinaryOperator::CreateFSub(LHS, RHS),
669 FPMathTag, FMF), Name);
671 Value *CreateMul(Value *LHS, Value *RHS, const Twine &Name = "",
672 bool HasNUW = false, bool HasNSW = false) {
673 if (Constant *LC = dyn_cast<Constant>(LHS))
674 if (Constant *RC = dyn_cast<Constant>(RHS))
675 return Insert(Folder.CreateMul(LC, RC, HasNUW, HasNSW), Name);
676 return CreateInsertNUWNSWBinOp(Instruction::Mul, LHS, RHS, Name,
679 Value *CreateNSWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
680 return CreateMul(LHS, RHS, Name, false, true);
682 Value *CreateNUWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
683 return CreateMul(LHS, RHS, Name, true, false);
685 Value *CreateFMul(Value *LHS, Value *RHS, const Twine &Name = "",
686 MDNode *FPMathTag = nullptr) {
687 if (Constant *LC = dyn_cast<Constant>(LHS))
688 if (Constant *RC = dyn_cast<Constant>(RHS))
689 return Insert(Folder.CreateFMul(LC, RC), Name);
690 return Insert(AddFPMathAttributes(BinaryOperator::CreateFMul(LHS, RHS),
691 FPMathTag, FMF), Name);
693 Value *CreateUDiv(Value *LHS, Value *RHS, const Twine &Name = "",
694 bool isExact = false) {
695 if (Constant *LC = dyn_cast<Constant>(LHS))
696 if (Constant *RC = dyn_cast<Constant>(RHS))
697 return Insert(Folder.CreateUDiv(LC, RC, isExact), Name);
699 return Insert(BinaryOperator::CreateUDiv(LHS, RHS), Name);
700 return Insert(BinaryOperator::CreateExactUDiv(LHS, RHS), Name);
702 Value *CreateExactUDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
703 return CreateUDiv(LHS, RHS, Name, true);
705 Value *CreateSDiv(Value *LHS, Value *RHS, const Twine &Name = "",
706 bool isExact = false) {
707 if (Constant *LC = dyn_cast<Constant>(LHS))
708 if (Constant *RC = dyn_cast<Constant>(RHS))
709 return Insert(Folder.CreateSDiv(LC, RC, isExact), Name);
711 return Insert(BinaryOperator::CreateSDiv(LHS, RHS), Name);
712 return Insert(BinaryOperator::CreateExactSDiv(LHS, RHS), Name);
714 Value *CreateExactSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
715 return CreateSDiv(LHS, RHS, Name, true);
717 Value *CreateFDiv(Value *LHS, Value *RHS, const Twine &Name = "",
718 MDNode *FPMathTag = nullptr) {
719 if (Constant *LC = dyn_cast<Constant>(LHS))
720 if (Constant *RC = dyn_cast<Constant>(RHS))
721 return Insert(Folder.CreateFDiv(LC, RC), Name);
722 return Insert(AddFPMathAttributes(BinaryOperator::CreateFDiv(LHS, RHS),
723 FPMathTag, FMF), Name);
725 Value *CreateURem(Value *LHS, Value *RHS, const Twine &Name = "") {
726 if (Constant *LC = dyn_cast<Constant>(LHS))
727 if (Constant *RC = dyn_cast<Constant>(RHS))
728 return Insert(Folder.CreateURem(LC, RC), Name);
729 return Insert(BinaryOperator::CreateURem(LHS, RHS), Name);
731 Value *CreateSRem(Value *LHS, Value *RHS, const Twine &Name = "") {
732 if (Constant *LC = dyn_cast<Constant>(LHS))
733 if (Constant *RC = dyn_cast<Constant>(RHS))
734 return Insert(Folder.CreateSRem(LC, RC), Name);
735 return Insert(BinaryOperator::CreateSRem(LHS, RHS), Name);
737 Value *CreateFRem(Value *LHS, Value *RHS, const Twine &Name = "",
738 MDNode *FPMathTag = nullptr) {
739 if (Constant *LC = dyn_cast<Constant>(LHS))
740 if (Constant *RC = dyn_cast<Constant>(RHS))
741 return Insert(Folder.CreateFRem(LC, RC), Name);
742 return Insert(AddFPMathAttributes(BinaryOperator::CreateFRem(LHS, RHS),
743 FPMathTag, FMF), Name);
746 Value *CreateShl(Value *LHS, Value *RHS, const Twine &Name = "",
747 bool HasNUW = false, bool HasNSW = false) {
748 if (Constant *LC = dyn_cast<Constant>(LHS))
749 if (Constant *RC = dyn_cast<Constant>(RHS))
750 return Insert(Folder.CreateShl(LC, RC, HasNUW, HasNSW), Name);
751 return CreateInsertNUWNSWBinOp(Instruction::Shl, LHS, RHS, Name,
754 Value *CreateShl(Value *LHS, const APInt &RHS, const Twine &Name = "",
755 bool HasNUW = false, bool HasNSW = false) {
756 return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
759 Value *CreateShl(Value *LHS, uint64_t RHS, const Twine &Name = "",
760 bool HasNUW = false, bool HasNSW = false) {
761 return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
765 Value *CreateLShr(Value *LHS, Value *RHS, const Twine &Name = "",
766 bool isExact = false) {
767 if (Constant *LC = dyn_cast<Constant>(LHS))
768 if (Constant *RC = dyn_cast<Constant>(RHS))
769 return Insert(Folder.CreateLShr(LC, RC, isExact), Name);
771 return Insert(BinaryOperator::CreateLShr(LHS, RHS), Name);
772 return Insert(BinaryOperator::CreateExactLShr(LHS, RHS), Name);
774 Value *CreateLShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
775 bool isExact = false) {
776 return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
778 Value *CreateLShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
779 bool isExact = false) {
780 return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
783 Value *CreateAShr(Value *LHS, Value *RHS, const Twine &Name = "",
784 bool isExact = false) {
785 if (Constant *LC = dyn_cast<Constant>(LHS))
786 if (Constant *RC = dyn_cast<Constant>(RHS))
787 return Insert(Folder.CreateAShr(LC, RC, isExact), Name);
789 return Insert(BinaryOperator::CreateAShr(LHS, RHS), Name);
790 return Insert(BinaryOperator::CreateExactAShr(LHS, RHS), Name);
792 Value *CreateAShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
793 bool isExact = false) {
794 return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
796 Value *CreateAShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
797 bool isExact = false) {
798 return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
801 Value *CreateAnd(Value *LHS, Value *RHS, const Twine &Name = "") {
802 if (Constant *RC = dyn_cast<Constant>(RHS)) {
803 if (isa<ConstantInt>(RC) && cast<ConstantInt>(RC)->isAllOnesValue())
804 return LHS; // LHS & -1 -> LHS
805 if (Constant *LC = dyn_cast<Constant>(LHS))
806 return Insert(Folder.CreateAnd(LC, RC), Name);
808 return Insert(BinaryOperator::CreateAnd(LHS, RHS), Name);
810 Value *CreateAnd(Value *LHS, const APInt &RHS, const Twine &Name = "") {
811 return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
813 Value *CreateAnd(Value *LHS, uint64_t RHS, const Twine &Name = "") {
814 return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
817 Value *CreateOr(Value *LHS, Value *RHS, const Twine &Name = "") {
818 if (Constant *RC = dyn_cast<Constant>(RHS)) {
819 if (RC->isNullValue())
820 return LHS; // LHS | 0 -> LHS
821 if (Constant *LC = dyn_cast<Constant>(LHS))
822 return Insert(Folder.CreateOr(LC, RC), Name);
824 return Insert(BinaryOperator::CreateOr(LHS, RHS), Name);
826 Value *CreateOr(Value *LHS, const APInt &RHS, const Twine &Name = "") {
827 return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
829 Value *CreateOr(Value *LHS, uint64_t RHS, const Twine &Name = "") {
830 return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
833 Value *CreateXor(Value *LHS, Value *RHS, const Twine &Name = "") {
834 if (Constant *LC = dyn_cast<Constant>(LHS))
835 if (Constant *RC = dyn_cast<Constant>(RHS))
836 return Insert(Folder.CreateXor(LC, RC), Name);
837 return Insert(BinaryOperator::CreateXor(LHS, RHS), Name);
839 Value *CreateXor(Value *LHS, const APInt &RHS, const Twine &Name = "") {
840 return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
842 Value *CreateXor(Value *LHS, uint64_t RHS, const Twine &Name = "") {
843 return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
846 Value *CreateBinOp(Instruction::BinaryOps Opc,
847 Value *LHS, Value *RHS, const Twine &Name = "",
848 MDNode *FPMathTag = nullptr) {
849 if (Constant *LC = dyn_cast<Constant>(LHS))
850 if (Constant *RC = dyn_cast<Constant>(RHS))
851 return Insert(Folder.CreateBinOp(Opc, LC, RC), Name);
852 llvm::Instruction *BinOp = BinaryOperator::Create(Opc, LHS, RHS);
853 if (isa<FPMathOperator>(BinOp))
854 BinOp = AddFPMathAttributes(BinOp, FPMathTag, FMF);
855 return Insert(BinOp, Name);
858 Value *CreateNeg(Value *V, const Twine &Name = "",
859 bool HasNUW = false, bool HasNSW = false) {
860 if (Constant *VC = dyn_cast<Constant>(V))
861 return Insert(Folder.CreateNeg(VC, HasNUW, HasNSW), Name);
862 BinaryOperator *BO = Insert(BinaryOperator::CreateNeg(V), Name);
863 if (HasNUW) BO->setHasNoUnsignedWrap();
864 if (HasNSW) BO->setHasNoSignedWrap();
867 Value *CreateNSWNeg(Value *V, const Twine &Name = "") {
868 return CreateNeg(V, Name, false, true);
870 Value *CreateNUWNeg(Value *V, const Twine &Name = "") {
871 return CreateNeg(V, Name, true, false);
873 Value *CreateFNeg(Value *V, const Twine &Name = "",
874 MDNode *FPMathTag = nullptr) {
875 if (Constant *VC = dyn_cast<Constant>(V))
876 return Insert(Folder.CreateFNeg(VC), Name);
877 return Insert(AddFPMathAttributes(BinaryOperator::CreateFNeg(V),
878 FPMathTag, FMF), Name);
880 Value *CreateNot(Value *V, const Twine &Name = "") {
881 if (Constant *VC = dyn_cast<Constant>(V))
882 return Insert(Folder.CreateNot(VC), Name);
883 return Insert(BinaryOperator::CreateNot(V), Name);
886 //===--------------------------------------------------------------------===//
887 // Instruction creation methods: Memory Instructions
888 //===--------------------------------------------------------------------===//
890 AllocaInst *CreateAlloca(Type *Ty, Value *ArraySize = nullptr,
891 const Twine &Name = "") {
892 return Insert(new AllocaInst(Ty, ArraySize), Name);
894 // \brief Provided to resolve 'CreateLoad(Ptr, "...")' correctly, instead of
895 // converting the string to 'bool' for the isVolatile parameter.
896 LoadInst *CreateLoad(Value *Ptr, const char *Name) {
897 return Insert(new LoadInst(Ptr), Name);
899 LoadInst *CreateLoad(Value *Ptr, const Twine &Name = "") {
900 return Insert(new LoadInst(Ptr), Name);
902 LoadInst *CreateLoad(Value *Ptr, bool isVolatile, const Twine &Name = "") {
903 return Insert(new LoadInst(Ptr, nullptr, isVolatile), Name);
905 StoreInst *CreateStore(Value *Val, Value *Ptr, bool isVolatile = false) {
906 return Insert(new StoreInst(Val, Ptr, isVolatile));
908 // \brief Provided to resolve 'CreateAlignedLoad(Ptr, Align, "...")'
909 // correctly, instead of converting the string to 'bool' for the isVolatile
911 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, const char *Name) {
912 LoadInst *LI = CreateLoad(Ptr, Name);
913 LI->setAlignment(Align);
916 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align,
917 const Twine &Name = "") {
918 LoadInst *LI = CreateLoad(Ptr, Name);
919 LI->setAlignment(Align);
922 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, bool isVolatile,
923 const Twine &Name = "") {
924 LoadInst *LI = CreateLoad(Ptr, isVolatile, Name);
925 LI->setAlignment(Align);
928 StoreInst *CreateAlignedStore(Value *Val, Value *Ptr, unsigned Align,
929 bool isVolatile = false) {
930 StoreInst *SI = CreateStore(Val, Ptr, isVolatile);
931 SI->setAlignment(Align);
934 FenceInst *CreateFence(AtomicOrdering Ordering,
935 SynchronizationScope SynchScope = CrossThread,
936 const Twine &Name = "") {
937 return Insert(new FenceInst(Context, Ordering, SynchScope), Name);
940 CreateAtomicCmpXchg(Value *Ptr, Value *Cmp, Value *New,
941 AtomicOrdering SuccessOrdering,
942 AtomicOrdering FailureOrdering,
943 SynchronizationScope SynchScope = CrossThread) {
944 return Insert(new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering,
945 FailureOrdering, SynchScope));
947 AtomicRMWInst *CreateAtomicRMW(AtomicRMWInst::BinOp Op, Value *Ptr, Value *Val,
948 AtomicOrdering Ordering,
949 SynchronizationScope SynchScope = CrossThread) {
950 return Insert(new AtomicRMWInst(Op, Ptr, Val, Ordering, SynchScope));
952 Value *CreateGEP(Value *Ptr, ArrayRef<Value *> IdxList,
953 const Twine &Name = "") {
954 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
955 // Every index must be constant.
957 for (i = 0, e = IdxList.size(); i != e; ++i)
958 if (!isa<Constant>(IdxList[i]))
961 return Insert(Folder.CreateGetElementPtr(PC, IdxList), Name);
963 return Insert(GetElementPtrInst::Create(Ptr, IdxList), Name);
965 Value *CreateInBoundsGEP(Value *Ptr, ArrayRef<Value *> IdxList,
966 const Twine &Name = "") {
967 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
968 // Every index must be constant.
970 for (i = 0, e = IdxList.size(); i != e; ++i)
971 if (!isa<Constant>(IdxList[i]))
974 return Insert(Folder.CreateInBoundsGetElementPtr(PC, IdxList), Name);
976 return Insert(GetElementPtrInst::CreateInBounds(Ptr, IdxList), Name);
978 Value *CreateGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
979 if (Constant *PC = dyn_cast<Constant>(Ptr))
980 if (Constant *IC = dyn_cast<Constant>(Idx))
981 return Insert(Folder.CreateGetElementPtr(PC, IC), Name);
982 return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
984 Value *CreateInBoundsGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
985 if (Constant *PC = dyn_cast<Constant>(Ptr))
986 if (Constant *IC = dyn_cast<Constant>(Idx))
987 return Insert(Folder.CreateInBoundsGetElementPtr(PC, IC), Name);
988 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
990 Value *CreateConstGEP1_32(Value *Ptr, unsigned Idx0, const Twine &Name = "") {
991 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
993 if (Constant *PC = dyn_cast<Constant>(Ptr))
994 return Insert(Folder.CreateGetElementPtr(PC, Idx), Name);
996 return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
998 Value *CreateConstInBoundsGEP1_32(Value *Ptr, unsigned Idx0,
999 const Twine &Name = "") {
1000 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
1002 if (Constant *PC = dyn_cast<Constant>(Ptr))
1003 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idx), Name);
1005 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
1007 Value *CreateConstGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
1008 const Twine &Name = "") {
1010 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1011 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1014 if (Constant *PC = dyn_cast<Constant>(Ptr))
1015 return Insert(Folder.CreateGetElementPtr(PC, Idxs), Name);
1017 return Insert(GetElementPtrInst::Create(Ptr, Idxs), Name);
1019 Value *CreateConstInBoundsGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
1020 const Twine &Name = "") {
1022 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1023 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1026 if (Constant *PC = dyn_cast<Constant>(Ptr))
1027 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idxs), Name);
1029 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs), Name);
1031 Value *CreateConstGEP1_64(Value *Ptr, uint64_t Idx0, const Twine &Name = "") {
1032 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1034 if (Constant *PC = dyn_cast<Constant>(Ptr))
1035 return Insert(Folder.CreateGetElementPtr(PC, Idx), Name);
1037 return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
1039 Value *CreateConstInBoundsGEP1_64(Value *Ptr, uint64_t Idx0,
1040 const Twine &Name = "") {
1041 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1043 if (Constant *PC = dyn_cast<Constant>(Ptr))
1044 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idx), Name);
1046 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
1048 Value *CreateConstGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1049 const Twine &Name = "") {
1051 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1052 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1055 if (Constant *PC = dyn_cast<Constant>(Ptr))
1056 return Insert(Folder.CreateGetElementPtr(PC, Idxs), Name);
1058 return Insert(GetElementPtrInst::Create(Ptr, Idxs), Name);
1060 Value *CreateConstInBoundsGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1061 const Twine &Name = "") {
1063 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1064 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1067 if (Constant *PC = dyn_cast<Constant>(Ptr))
1068 return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idxs), Name);
1070 return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs), Name);
1072 Value *CreateStructGEP(Value *Ptr, unsigned Idx, const Twine &Name = "") {
1073 return CreateConstInBoundsGEP2_32(Ptr, 0, Idx, Name);
1076 /// \brief Same as CreateGlobalString, but return a pointer with "i8*" type
1077 /// instead of a pointer to array of i8.
1078 Value *CreateGlobalStringPtr(StringRef Str, const Twine &Name = "") {
1079 Value *gv = CreateGlobalString(Str, Name);
1080 Value *zero = ConstantInt::get(Type::getInt32Ty(Context), 0);
1081 Value *Args[] = { zero, zero };
1082 return CreateInBoundsGEP(gv, Args, Name);
1085 //===--------------------------------------------------------------------===//
1086 // Instruction creation methods: Cast/Conversion Operators
1087 //===--------------------------------------------------------------------===//
1089 Value *CreateTrunc(Value *V, Type *DestTy, const Twine &Name = "") {
1090 return CreateCast(Instruction::Trunc, V, DestTy, Name);
1092 Value *CreateZExt(Value *V, Type *DestTy, const Twine &Name = "") {
1093 return CreateCast(Instruction::ZExt, V, DestTy, Name);
1095 Value *CreateSExt(Value *V, Type *DestTy, const Twine &Name = "") {
1096 return CreateCast(Instruction::SExt, V, DestTy, Name);
1098 /// \brief Create a ZExt or Trunc from the integer value V to DestTy. Return
1099 /// the value untouched if the type of V is already DestTy.
1100 Value *CreateZExtOrTrunc(Value *V, Type *DestTy,
1101 const Twine &Name = "") {
1102 assert(V->getType()->isIntOrIntVectorTy() &&
1103 DestTy->isIntOrIntVectorTy() &&
1104 "Can only zero extend/truncate integers!");
1105 Type *VTy = V->getType();
1106 if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1107 return CreateZExt(V, DestTy, Name);
1108 if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1109 return CreateTrunc(V, DestTy, Name);
1112 /// \brief Create a SExt or Trunc from the integer value V to DestTy. Return
1113 /// the value untouched if the type of V is already DestTy.
1114 Value *CreateSExtOrTrunc(Value *V, Type *DestTy,
1115 const Twine &Name = "") {
1116 assert(V->getType()->isIntOrIntVectorTy() &&
1117 DestTy->isIntOrIntVectorTy() &&
1118 "Can only sign extend/truncate integers!");
1119 Type *VTy = V->getType();
1120 if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1121 return CreateSExt(V, DestTy, Name);
1122 if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1123 return CreateTrunc(V, DestTy, Name);
1126 Value *CreateFPToUI(Value *V, Type *DestTy, const Twine &Name = ""){
1127 return CreateCast(Instruction::FPToUI, V, DestTy, Name);
1129 Value *CreateFPToSI(Value *V, Type *DestTy, const Twine &Name = ""){
1130 return CreateCast(Instruction::FPToSI, V, DestTy, Name);
1132 Value *CreateUIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1133 return CreateCast(Instruction::UIToFP, V, DestTy, Name);
1135 Value *CreateSIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1136 return CreateCast(Instruction::SIToFP, V, DestTy, Name);
1138 Value *CreateFPTrunc(Value *V, Type *DestTy,
1139 const Twine &Name = "") {
1140 return CreateCast(Instruction::FPTrunc, V, DestTy, Name);
1142 Value *CreateFPExt(Value *V, Type *DestTy, const Twine &Name = "") {
1143 return CreateCast(Instruction::FPExt, V, DestTy, Name);
1145 Value *CreatePtrToInt(Value *V, Type *DestTy,
1146 const Twine &Name = "") {
1147 return CreateCast(Instruction::PtrToInt, V, DestTy, Name);
1149 Value *CreateIntToPtr(Value *V, Type *DestTy,
1150 const Twine &Name = "") {
1151 return CreateCast(Instruction::IntToPtr, V, DestTy, Name);
1153 Value *CreateBitCast(Value *V, Type *DestTy,
1154 const Twine &Name = "") {
1155 return CreateCast(Instruction::BitCast, V, DestTy, Name);
1157 Value *CreateAddrSpaceCast(Value *V, Type *DestTy,
1158 const Twine &Name = "") {
1159 return CreateCast(Instruction::AddrSpaceCast, V, DestTy, Name);
1161 Value *CreateZExtOrBitCast(Value *V, Type *DestTy,
1162 const Twine &Name = "") {
1163 if (V->getType() == DestTy)
1165 if (Constant *VC = dyn_cast<Constant>(V))
1166 return Insert(Folder.CreateZExtOrBitCast(VC, DestTy), Name);
1167 return Insert(CastInst::CreateZExtOrBitCast(V, DestTy), Name);
1169 Value *CreateSExtOrBitCast(Value *V, Type *DestTy,
1170 const Twine &Name = "") {
1171 if (V->getType() == DestTy)
1173 if (Constant *VC = dyn_cast<Constant>(V))
1174 return Insert(Folder.CreateSExtOrBitCast(VC, DestTy), Name);
1175 return Insert(CastInst::CreateSExtOrBitCast(V, DestTy), Name);
1177 Value *CreateTruncOrBitCast(Value *V, Type *DestTy,
1178 const Twine &Name = "") {
1179 if (V->getType() == DestTy)
1181 if (Constant *VC = dyn_cast<Constant>(V))
1182 return Insert(Folder.CreateTruncOrBitCast(VC, DestTy), Name);
1183 return Insert(CastInst::CreateTruncOrBitCast(V, DestTy), Name);
1185 Value *CreateCast(Instruction::CastOps Op, Value *V, Type *DestTy,
1186 const Twine &Name = "") {
1187 if (V->getType() == DestTy)
1189 if (Constant *VC = dyn_cast<Constant>(V))
1190 return Insert(Folder.CreateCast(Op, VC, DestTy), Name);
1191 return Insert(CastInst::Create(Op, V, DestTy), Name);
1193 Value *CreatePointerCast(Value *V, Type *DestTy,
1194 const Twine &Name = "") {
1195 if (V->getType() == DestTy)
1197 if (Constant *VC = dyn_cast<Constant>(V))
1198 return Insert(Folder.CreatePointerCast(VC, DestTy), Name);
1199 return Insert(CastInst::CreatePointerCast(V, DestTy), Name);
1201 Value *CreateIntCast(Value *V, Type *DestTy, bool isSigned,
1202 const Twine &Name = "") {
1203 if (V->getType() == DestTy)
1205 if (Constant *VC = dyn_cast<Constant>(V))
1206 return Insert(Folder.CreateIntCast(VC, DestTy, isSigned), Name);
1207 return Insert(CastInst::CreateIntegerCast(V, DestTy, isSigned), Name);
1210 // \brief Provided to resolve 'CreateIntCast(Ptr, Ptr, "...")', giving a
1211 // compile time error, instead of converting the string to bool for the
1212 // isSigned parameter.
1213 Value *CreateIntCast(Value *, Type *, const char *) LLVM_DELETED_FUNCTION;
1215 Value *CreateFPCast(Value *V, Type *DestTy, const Twine &Name = "") {
1216 if (V->getType() == DestTy)
1218 if (Constant *VC = dyn_cast<Constant>(V))
1219 return Insert(Folder.CreateFPCast(VC, DestTy), Name);
1220 return Insert(CastInst::CreateFPCast(V, DestTy), Name);
1223 //===--------------------------------------------------------------------===//
1224 // Instruction creation methods: Compare Instructions
1225 //===--------------------------------------------------------------------===//
1227 Value *CreateICmpEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1228 return CreateICmp(ICmpInst::ICMP_EQ, LHS, RHS, Name);
1230 Value *CreateICmpNE(Value *LHS, Value *RHS, const Twine &Name = "") {
1231 return CreateICmp(ICmpInst::ICMP_NE, LHS, RHS, Name);
1233 Value *CreateICmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1234 return CreateICmp(ICmpInst::ICMP_UGT, LHS, RHS, Name);
1236 Value *CreateICmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1237 return CreateICmp(ICmpInst::ICMP_UGE, LHS, RHS, Name);
1239 Value *CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
1240 return CreateICmp(ICmpInst::ICMP_ULT, LHS, RHS, Name);
1242 Value *CreateICmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
1243 return CreateICmp(ICmpInst::ICMP_ULE, LHS, RHS, Name);
1245 Value *CreateICmpSGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1246 return CreateICmp(ICmpInst::ICMP_SGT, LHS, RHS, Name);
1248 Value *CreateICmpSGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1249 return CreateICmp(ICmpInst::ICMP_SGE, LHS, RHS, Name);
1251 Value *CreateICmpSLT(Value *LHS, Value *RHS, const Twine &Name = "") {
1252 return CreateICmp(ICmpInst::ICMP_SLT, LHS, RHS, Name);
1254 Value *CreateICmpSLE(Value *LHS, Value *RHS, const Twine &Name = "") {
1255 return CreateICmp(ICmpInst::ICMP_SLE, LHS, RHS, Name);
1258 Value *CreateFCmpOEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1259 return CreateFCmp(FCmpInst::FCMP_OEQ, LHS, RHS, Name);
1261 Value *CreateFCmpOGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1262 return CreateFCmp(FCmpInst::FCMP_OGT, LHS, RHS, Name);
1264 Value *CreateFCmpOGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1265 return CreateFCmp(FCmpInst::FCMP_OGE, LHS, RHS, Name);
1267 Value *CreateFCmpOLT(Value *LHS, Value *RHS, const Twine &Name = "") {
1268 return CreateFCmp(FCmpInst::FCMP_OLT, LHS, RHS, Name);
1270 Value *CreateFCmpOLE(Value *LHS, Value *RHS, const Twine &Name = "") {
1271 return CreateFCmp(FCmpInst::FCMP_OLE, LHS, RHS, Name);
1273 Value *CreateFCmpONE(Value *LHS, Value *RHS, const Twine &Name = "") {
1274 return CreateFCmp(FCmpInst::FCMP_ONE, LHS, RHS, Name);
1276 Value *CreateFCmpORD(Value *LHS, Value *RHS, const Twine &Name = "") {
1277 return CreateFCmp(FCmpInst::FCMP_ORD, LHS, RHS, Name);
1279 Value *CreateFCmpUNO(Value *LHS, Value *RHS, const Twine &Name = "") {
1280 return CreateFCmp(FCmpInst::FCMP_UNO, LHS, RHS, Name);
1282 Value *CreateFCmpUEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1283 return CreateFCmp(FCmpInst::FCMP_UEQ, LHS, RHS, Name);
1285 Value *CreateFCmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1286 return CreateFCmp(FCmpInst::FCMP_UGT, LHS, RHS, Name);
1288 Value *CreateFCmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1289 return CreateFCmp(FCmpInst::FCMP_UGE, LHS, RHS, Name);
1291 Value *CreateFCmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
1292 return CreateFCmp(FCmpInst::FCMP_ULT, LHS, RHS, Name);
1294 Value *CreateFCmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
1295 return CreateFCmp(FCmpInst::FCMP_ULE, LHS, RHS, Name);
1297 Value *CreateFCmpUNE(Value *LHS, Value *RHS, const Twine &Name = "") {
1298 return CreateFCmp(FCmpInst::FCMP_UNE, LHS, RHS, Name);
1301 Value *CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1302 const Twine &Name = "") {
1303 if (Constant *LC = dyn_cast<Constant>(LHS))
1304 if (Constant *RC = dyn_cast<Constant>(RHS))
1305 return Insert(Folder.CreateICmp(P, LC, RC), Name);
1306 return Insert(new ICmpInst(P, LHS, RHS), Name);
1308 Value *CreateFCmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1309 const Twine &Name = "") {
1310 if (Constant *LC = dyn_cast<Constant>(LHS))
1311 if (Constant *RC = dyn_cast<Constant>(RHS))
1312 return Insert(Folder.CreateFCmp(P, LC, RC), Name);
1313 return Insert(new FCmpInst(P, LHS, RHS), Name);
1316 //===--------------------------------------------------------------------===//
1317 // Instruction creation methods: Other Instructions
1318 //===--------------------------------------------------------------------===//
1320 PHINode *CreatePHI(Type *Ty, unsigned NumReservedValues,
1321 const Twine &Name = "") {
1322 return Insert(PHINode::Create(Ty, NumReservedValues), Name);
1325 CallInst *CreateCall(Value *Callee, const Twine &Name = "") {
1326 return Insert(CallInst::Create(Callee), Name);
1328 CallInst *CreateCall(Value *Callee, Value *Arg, const Twine &Name = "") {
1329 return Insert(CallInst::Create(Callee, Arg), Name);
1331 CallInst *CreateCall2(Value *Callee, Value *Arg1, Value *Arg2,
1332 const Twine &Name = "") {
1333 Value *Args[] = { Arg1, Arg2 };
1334 return Insert(CallInst::Create(Callee, Args), Name);
1336 CallInst *CreateCall3(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1337 const Twine &Name = "") {
1338 Value *Args[] = { Arg1, Arg2, Arg3 };
1339 return Insert(CallInst::Create(Callee, Args), Name);
1341 CallInst *CreateCall4(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1342 Value *Arg4, const Twine &Name = "") {
1343 Value *Args[] = { Arg1, Arg2, Arg3, Arg4 };
1344 return Insert(CallInst::Create(Callee, Args), Name);
1346 CallInst *CreateCall5(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1347 Value *Arg4, Value *Arg5, const Twine &Name = "") {
1348 Value *Args[] = { Arg1, Arg2, Arg3, Arg4, Arg5 };
1349 return Insert(CallInst::Create(Callee, Args), Name);
1352 CallInst *CreateCall(Value *Callee, ArrayRef<Value *> Args,
1353 const Twine &Name = "") {
1354 return Insert(CallInst::Create(Callee, Args), Name);
1357 Value *CreateSelect(Value *C, Value *True, Value *False,
1358 const Twine &Name = "") {
1359 if (Constant *CC = dyn_cast<Constant>(C))
1360 if (Constant *TC = dyn_cast<Constant>(True))
1361 if (Constant *FC = dyn_cast<Constant>(False))
1362 return Insert(Folder.CreateSelect(CC, TC, FC), Name);
1363 return Insert(SelectInst::Create(C, True, False), Name);
1366 VAArgInst *CreateVAArg(Value *List, Type *Ty, const Twine &Name = "") {
1367 return Insert(new VAArgInst(List, Ty), Name);
1370 Value *CreateExtractElement(Value *Vec, Value *Idx,
1371 const Twine &Name = "") {
1372 if (Constant *VC = dyn_cast<Constant>(Vec))
1373 if (Constant *IC = dyn_cast<Constant>(Idx))
1374 return Insert(Folder.CreateExtractElement(VC, IC), Name);
1375 return Insert(ExtractElementInst::Create(Vec, Idx), Name);
1378 Value *CreateInsertElement(Value *Vec, Value *NewElt, Value *Idx,
1379 const Twine &Name = "") {
1380 if (Constant *VC = dyn_cast<Constant>(Vec))
1381 if (Constant *NC = dyn_cast<Constant>(NewElt))
1382 if (Constant *IC = dyn_cast<Constant>(Idx))
1383 return Insert(Folder.CreateInsertElement(VC, NC, IC), Name);
1384 return Insert(InsertElementInst::Create(Vec, NewElt, Idx), Name);
1387 Value *CreateShuffleVector(Value *V1, Value *V2, Value *Mask,
1388 const Twine &Name = "") {
1389 if (Constant *V1C = dyn_cast<Constant>(V1))
1390 if (Constant *V2C = dyn_cast<Constant>(V2))
1391 if (Constant *MC = dyn_cast<Constant>(Mask))
1392 return Insert(Folder.CreateShuffleVector(V1C, V2C, MC), Name);
1393 return Insert(new ShuffleVectorInst(V1, V2, Mask), Name);
1396 Value *CreateExtractValue(Value *Agg,
1397 ArrayRef<unsigned> Idxs,
1398 const Twine &Name = "") {
1399 if (Constant *AggC = dyn_cast<Constant>(Agg))
1400 return Insert(Folder.CreateExtractValue(AggC, Idxs), Name);
1401 return Insert(ExtractValueInst::Create(Agg, Idxs), Name);
1404 Value *CreateInsertValue(Value *Agg, Value *Val,
1405 ArrayRef<unsigned> Idxs,
1406 const Twine &Name = "") {
1407 if (Constant *AggC = dyn_cast<Constant>(Agg))
1408 if (Constant *ValC = dyn_cast<Constant>(Val))
1409 return Insert(Folder.CreateInsertValue(AggC, ValC, Idxs), Name);
1410 return Insert(InsertValueInst::Create(Agg, Val, Idxs), Name);
1413 LandingPadInst *CreateLandingPad(Type *Ty, Value *PersFn, unsigned NumClauses,
1414 const Twine &Name = "") {
1415 return Insert(LandingPadInst::Create(Ty, PersFn, NumClauses), Name);
1418 //===--------------------------------------------------------------------===//
1419 // Utility creation methods
1420 //===--------------------------------------------------------------------===//
1422 /// \brief Return an i1 value testing if \p Arg is null.
1423 Value *CreateIsNull(Value *Arg, const Twine &Name = "") {
1424 return CreateICmpEQ(Arg, Constant::getNullValue(Arg->getType()),
1428 /// \brief Return an i1 value testing if \p Arg is not null.
1429 Value *CreateIsNotNull(Value *Arg, const Twine &Name = "") {
1430 return CreateICmpNE(Arg, Constant::getNullValue(Arg->getType()),
1434 /// \brief Return the i64 difference between two pointer values, dividing out
1435 /// the size of the pointed-to objects.
1437 /// This is intended to implement C-style pointer subtraction. As such, the
1438 /// pointers must be appropriately aligned for their element types and
1439 /// pointing into the same object.
1440 Value *CreatePtrDiff(Value *LHS, Value *RHS, const Twine &Name = "") {
1441 assert(LHS->getType() == RHS->getType() &&
1442 "Pointer subtraction operand types must match!");
1443 PointerType *ArgType = cast<PointerType>(LHS->getType());
1444 Value *LHS_int = CreatePtrToInt(LHS, Type::getInt64Ty(Context));
1445 Value *RHS_int = CreatePtrToInt(RHS, Type::getInt64Ty(Context));
1446 Value *Difference = CreateSub(LHS_int, RHS_int);
1447 return CreateExactSDiv(Difference,
1448 ConstantExpr::getSizeOf(ArgType->getElementType()),
1452 /// \brief Return a vector value that contains \arg V broadcasted to \p
1453 /// NumElts elements.
1454 Value *CreateVectorSplat(unsigned NumElts, Value *V, const Twine &Name = "") {
1455 assert(NumElts > 0 && "Cannot splat to an empty vector!");
1457 // First insert it into an undef vector so we can shuffle it.
1458 Type *I32Ty = getInt32Ty();
1459 Value *Undef = UndefValue::get(VectorType::get(V->getType(), NumElts));
1460 V = CreateInsertElement(Undef, V, ConstantInt::get(I32Ty, 0),
1461 Name + ".splatinsert");
1463 // Shuffle the value across the desired number of elements.
1464 Value *Zeros = ConstantAggregateZero::get(VectorType::get(I32Ty, NumElts));
1465 return CreateShuffleVector(V, Undef, Zeros, Name + ".splat");
1469 // Create wrappers for C Binding types (see CBindingWrapping.h).
1470 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef)