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/Function.h"
25 #include "llvm/IR/GlobalVariable.h"
26 #include "llvm/IR/Instructions.h"
27 #include "llvm/IR/LLVMContext.h"
28 #include "llvm/IR/Operator.h"
29 #include "llvm/IR/ValueHandle.h"
30 #include "llvm/Support/CBindingWrapping.h"
35 /// \brief This provides the default implementation of the IRBuilder
36 /// 'InsertHelper' method that is called whenever an instruction is created by
37 /// IRBuilder and needs to be inserted.
39 /// By default, this inserts the instruction at the insertion point.
40 template <bool preserveNames = true>
41 class IRBuilderDefaultInserter {
43 void InsertHelper(Instruction *I, const Twine &Name,
44 BasicBlock *BB, BasicBlock::iterator InsertPt) const {
45 if (BB) BB->getInstList().insert(InsertPt, I);
51 /// \brief Common base class shared among various IRBuilders.
53 DebugLoc CurDbgLocation;
56 BasicBlock::iterator InsertPt;
59 MDNode *DefaultFPMathTag;
63 IRBuilderBase(LLVMContext &context, MDNode *FPMathTag = nullptr)
64 : Context(context), DefaultFPMathTag(FPMathTag), FMF() {
65 ClearInsertionPoint();
68 //===--------------------------------------------------------------------===//
69 // Builder configuration methods
70 //===--------------------------------------------------------------------===//
72 /// \brief Clear the insertion point: created instructions will not be
73 /// inserted into a block.
74 void ClearInsertionPoint() {
79 BasicBlock *GetInsertBlock() const { return BB; }
80 BasicBlock::iterator GetInsertPoint() const { return InsertPt; }
81 LLVMContext &getContext() const { return Context; }
83 /// \brief This specifies that created instructions should be appended to the
84 /// end of the specified block.
85 void SetInsertPoint(BasicBlock *TheBB) {
90 /// \brief This specifies that created instructions should be inserted before
91 /// the specified instruction.
92 void SetInsertPoint(Instruction *I) {
95 assert(I != BB->end() && "Can't read debug loc from end()");
96 SetCurrentDebugLocation(I->getDebugLoc());
99 /// \brief This specifies that created instructions should be inserted at the
101 void SetInsertPoint(BasicBlock *TheBB, BasicBlock::iterator IP) {
104 if (IP != TheBB->end())
105 SetCurrentDebugLocation(IP->getDebugLoc());
108 /// \brief Set location information used by debugging information.
109 void SetCurrentDebugLocation(DebugLoc L) { CurDbgLocation = std::move(L); }
111 /// \brief Get location information used by debugging information.
112 const DebugLoc &getCurrentDebugLocation() const { return CurDbgLocation; }
114 /// \brief If this builder has a current debug location, set it on the
115 /// specified instruction.
116 void SetInstDebugLocation(Instruction *I) const {
118 I->setDebugLoc(CurDbgLocation);
121 /// \brief Get the return type of the current function that we're emitting
123 Type *getCurrentFunctionReturnType() const;
125 /// InsertPoint - A saved insertion point.
128 BasicBlock::iterator Point;
131 /// \brief Creates a new insertion point which doesn't point to anything.
132 InsertPoint() : Block(nullptr) {}
134 /// \brief Creates a new insertion point at the given location.
135 InsertPoint(BasicBlock *InsertBlock, BasicBlock::iterator InsertPoint)
136 : Block(InsertBlock), Point(InsertPoint) {}
138 /// \brief Returns true if this insert point is set.
139 bool isSet() const { return (Block != nullptr); }
141 llvm::BasicBlock *getBlock() const { return Block; }
142 llvm::BasicBlock::iterator getPoint() const { return Point; }
145 /// \brief Returns the current insert point.
146 InsertPoint saveIP() const {
147 return InsertPoint(GetInsertBlock(), GetInsertPoint());
150 /// \brief Returns the current insert point, clearing it in the process.
151 InsertPoint saveAndClearIP() {
152 InsertPoint IP(GetInsertBlock(), GetInsertPoint());
153 ClearInsertionPoint();
157 /// \brief Sets the current insert point to a previously-saved location.
158 void restoreIP(InsertPoint IP) {
160 SetInsertPoint(IP.getBlock(), IP.getPoint());
162 ClearInsertionPoint();
165 /// \brief Get the floating point math metadata being used.
166 MDNode *getDefaultFPMathTag() const { return DefaultFPMathTag; }
168 /// \brief Get the flags to be applied to created floating point ops
169 FastMathFlags getFastMathFlags() const { return FMF; }
171 /// \brief Clear the fast-math flags.
172 void clearFastMathFlags() { FMF.clear(); }
174 /// \brief Set the floating point math metadata to be used.
175 void SetDefaultFPMathTag(MDNode *FPMathTag) { DefaultFPMathTag = FPMathTag; }
177 /// \brief Set the fast-math flags to be used with generated fp-math operators
178 void SetFastMathFlags(FastMathFlags NewFMF) { FMF = NewFMF; }
180 //===--------------------------------------------------------------------===//
182 //===--------------------------------------------------------------------===//
184 // \brief RAII object that stores the current insertion point and restores it
185 // when the object is destroyed. This includes the debug location.
186 class InsertPointGuard {
187 IRBuilderBase &Builder;
188 AssertingVH<BasicBlock> Block;
189 BasicBlock::iterator Point;
192 InsertPointGuard(const InsertPointGuard &) = delete;
193 InsertPointGuard &operator=(const InsertPointGuard &) = delete;
196 InsertPointGuard(IRBuilderBase &B)
197 : Builder(B), Block(B.GetInsertBlock()), Point(B.GetInsertPoint()),
198 DbgLoc(B.getCurrentDebugLocation()) {}
200 ~InsertPointGuard() {
201 Builder.restoreIP(InsertPoint(Block, Point));
202 Builder.SetCurrentDebugLocation(DbgLoc);
206 // \brief RAII object that stores the current fast math settings and restores
207 // them when the object is destroyed.
208 class FastMathFlagGuard {
209 IRBuilderBase &Builder;
213 FastMathFlagGuard(const FastMathFlagGuard &) = delete;
214 FastMathFlagGuard &operator=(
215 const FastMathFlagGuard &) = delete;
218 FastMathFlagGuard(IRBuilderBase &B)
219 : Builder(B), FMF(B.FMF), FPMathTag(B.DefaultFPMathTag) {}
221 ~FastMathFlagGuard() {
223 Builder.DefaultFPMathTag = FPMathTag;
227 //===--------------------------------------------------------------------===//
228 // Miscellaneous creation methods.
229 //===--------------------------------------------------------------------===//
231 /// \brief Make a new global variable with initializer type i8*
233 /// Make a new global variable with an initializer that has array of i8 type
234 /// filled in with the null terminated string value specified. The new global
235 /// variable will be marked mergable with any others of the same contents. If
236 /// Name is specified, it is the name of the global variable created.
237 GlobalVariable *CreateGlobalString(StringRef Str, const Twine &Name = "",
238 unsigned AddressSpace = 0);
240 /// \brief Get a constant value representing either true or false.
241 ConstantInt *getInt1(bool V) {
242 return ConstantInt::get(getInt1Ty(), V);
245 /// \brief Get the constant value for i1 true.
246 ConstantInt *getTrue() {
247 return ConstantInt::getTrue(Context);
250 /// \brief Get the constant value for i1 false.
251 ConstantInt *getFalse() {
252 return ConstantInt::getFalse(Context);
255 /// \brief Get a constant 8-bit value.
256 ConstantInt *getInt8(uint8_t C) {
257 return ConstantInt::get(getInt8Ty(), C);
260 /// \brief Get a constant 16-bit value.
261 ConstantInt *getInt16(uint16_t C) {
262 return ConstantInt::get(getInt16Ty(), C);
265 /// \brief Get a constant 32-bit value.
266 ConstantInt *getInt32(uint32_t C) {
267 return ConstantInt::get(getInt32Ty(), C);
270 /// \brief Get a constant 64-bit value.
271 ConstantInt *getInt64(uint64_t C) {
272 return ConstantInt::get(getInt64Ty(), C);
275 /// \brief Get a constant N-bit value, zero extended or truncated from
277 ConstantInt *getIntN(unsigned N, uint64_t C) {
278 return ConstantInt::get(getIntNTy(N), C);
281 /// \brief Get a constant integer value.
282 ConstantInt *getInt(const APInt &AI) {
283 return ConstantInt::get(Context, AI);
286 //===--------------------------------------------------------------------===//
287 // Type creation methods
288 //===--------------------------------------------------------------------===//
290 /// \brief Fetch the type representing a single bit
291 IntegerType *getInt1Ty() {
292 return Type::getInt1Ty(Context);
295 /// \brief Fetch the type representing an 8-bit integer.
296 IntegerType *getInt8Ty() {
297 return Type::getInt8Ty(Context);
300 /// \brief Fetch the type representing a 16-bit integer.
301 IntegerType *getInt16Ty() {
302 return Type::getInt16Ty(Context);
305 /// \brief Fetch the type representing a 32-bit integer.
306 IntegerType *getInt32Ty() {
307 return Type::getInt32Ty(Context);
310 /// \brief Fetch the type representing a 64-bit integer.
311 IntegerType *getInt64Ty() {
312 return Type::getInt64Ty(Context);
315 /// \brief Fetch the type representing a 128-bit integer.
316 IntegerType *getInt128Ty() {
317 return Type::getInt128Ty(Context);
320 /// \brief Fetch the type representing an N-bit integer.
321 IntegerType *getIntNTy(unsigned N) {
322 return Type::getIntNTy(Context, N);
325 /// \brief Fetch the type representing a 16-bit floating point value.
327 return Type::getHalfTy(Context);
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. Likewise with alias.scope
364 /// and noalias tags.
365 CallInst *CreateMemSet(Value *Ptr, Value *Val, uint64_t Size, unsigned Align,
366 bool isVolatile = false, MDNode *TBAATag = nullptr,
367 MDNode *ScopeTag = nullptr,
368 MDNode *NoAliasTag = nullptr) {
369 return CreateMemSet(Ptr, Val, getInt64(Size), Align, isVolatile,
370 TBAATag, ScopeTag, NoAliasTag);
373 CallInst *CreateMemSet(Value *Ptr, Value *Val, Value *Size, unsigned Align,
374 bool isVolatile = false, MDNode *TBAATag = nullptr,
375 MDNode *ScopeTag = nullptr,
376 MDNode *NoAliasTag = nullptr);
378 /// \brief Create and insert a memcpy between the specified pointers.
380 /// If the pointers aren't i8*, they will be converted. If a TBAA tag is
381 /// specified, it will be added to the instruction. Likewise with alias.scope
382 /// and noalias tags.
383 CallInst *CreateMemCpy(Value *Dst, Value *Src, uint64_t Size, unsigned Align,
384 bool isVolatile = false, MDNode *TBAATag = nullptr,
385 MDNode *TBAAStructTag = nullptr,
386 MDNode *ScopeTag = nullptr,
387 MDNode *NoAliasTag = nullptr) {
388 return CreateMemCpy(Dst, Src, getInt64(Size), Align, isVolatile, TBAATag,
389 TBAAStructTag, ScopeTag, NoAliasTag);
392 CallInst *CreateMemCpy(Value *Dst, Value *Src, Value *Size, unsigned Align,
393 bool isVolatile = false, MDNode *TBAATag = nullptr,
394 MDNode *TBAAStructTag = nullptr,
395 MDNode *ScopeTag = nullptr,
396 MDNode *NoAliasTag = nullptr);
398 /// \brief Create and insert a memmove between the specified
401 /// If the pointers aren't i8*, they will be converted. If a TBAA tag is
402 /// specified, it will be added to the instruction. Likewise with alias.scope
403 /// and noalias tags.
404 CallInst *CreateMemMove(Value *Dst, Value *Src, uint64_t Size, unsigned Align,
405 bool isVolatile = false, MDNode *TBAATag = nullptr,
406 MDNode *ScopeTag = nullptr,
407 MDNode *NoAliasTag = nullptr) {
408 return CreateMemMove(Dst, Src, getInt64(Size), Align, isVolatile,
409 TBAATag, ScopeTag, NoAliasTag);
412 CallInst *CreateMemMove(Value *Dst, Value *Src, Value *Size, unsigned Align,
413 bool isVolatile = false, MDNode *TBAATag = nullptr,
414 MDNode *ScopeTag = nullptr,
415 MDNode *NoAliasTag = nullptr);
417 /// \brief Create a lifetime.start intrinsic.
419 /// If the pointer isn't i8* it will be converted.
420 CallInst *CreateLifetimeStart(Value *Ptr, ConstantInt *Size = nullptr);
422 /// \brief Create a lifetime.end intrinsic.
424 /// If the pointer isn't i8* it will be converted.
425 CallInst *CreateLifetimeEnd(Value *Ptr, ConstantInt *Size = nullptr);
427 /// \brief Create a call to Masked Load intrinsic
428 CallInst *CreateMaskedLoad(Value *Ptr, unsigned Align, Value *Mask,
429 Value *PassThru = 0, const Twine &Name = "");
431 /// \brief Create a call to Masked Store intrinsic
432 CallInst *CreateMaskedStore(Value *Val, Value *Ptr, unsigned Align,
435 /// \brief Create an assume intrinsic call that allows the optimizer to
436 /// assume that the provided condition will be true.
437 CallInst *CreateAssumption(Value *Cond);
439 /// \brief Create a call to the experimental.gc.statepoint intrinsic to
440 /// start a new statepoint sequence.
441 CallInst *CreateGCStatepointCall(uint64_t ID, uint32_t NumPatchBytes,
443 ArrayRef<Value *> CallArgs,
444 ArrayRef<Value *> DeoptArgs,
445 ArrayRef<Value *> GCArgs,
446 const Twine &Name = "");
448 // \brief Conveninence function for the common case when CallArgs are filled
449 // in using makeArrayRef(CS.arg_begin(), CS.arg_end()); Use needs to be
450 // .get()'ed to get the Value pointer.
451 CallInst *CreateGCStatepointCall(uint64_t ID, uint32_t NumPatchBytes,
452 Value *ActualCallee, ArrayRef<Use> CallArgs,
453 ArrayRef<Value *> DeoptArgs,
454 ArrayRef<Value *> GCArgs,
455 const Twine &Name = "");
457 /// brief Create an invoke to the experimental.gc.statepoint intrinsic to
458 /// start a new statepoint sequence.
460 CreateGCStatepointInvoke(uint64_t ID, uint32_t NumPatchBytes,
461 Value *ActualInvokee, BasicBlock *NormalDest,
462 BasicBlock *UnwindDest, ArrayRef<Value *> InvokeArgs,
463 ArrayRef<Value *> DeoptArgs,
464 ArrayRef<Value *> GCArgs, const Twine &Name = "");
466 // Conveninence function for the common case when CallArgs are filled in using
467 // makeArrayRef(CS.arg_begin(), CS.arg_end()); Use needs to be .get()'ed to
470 CreateGCStatepointInvoke(uint64_t ID, uint32_t NumPatchBytes,
471 Value *ActualInvokee, BasicBlock *NormalDest,
472 BasicBlock *UnwindDest, ArrayRef<Use> InvokeArgs,
473 ArrayRef<Value *> DeoptArgs,
474 ArrayRef<Value *> GCArgs, const Twine &Name = "");
476 /// \brief Create a call to the experimental.gc.result intrinsic to extract
477 /// the result from a call wrapped in a statepoint.
478 CallInst *CreateGCResult(Instruction *Statepoint,
480 const Twine &Name = "");
482 /// \brief Create a call to the experimental.gc.relocate intrinsics to
483 /// project the relocated value of one pointer from the statepoint.
484 CallInst *CreateGCRelocate(Instruction *Statepoint,
488 const Twine &Name = "");
491 /// \brief Create a call to a masked intrinsic with given Id.
492 /// Masked intrinsic has only one overloaded type - data type.
493 CallInst *CreateMaskedIntrinsic(Intrinsic::ID Id, ArrayRef<Value *> Ops,
494 Type *DataTy, const Twine &Name = "");
496 Value *getCastedInt8PtrValue(Value *Ptr);
499 /// \brief This provides a uniform API for creating instructions and inserting
500 /// them into a basic block: either at the end of a BasicBlock, or at a specific
501 /// iterator location in a block.
503 /// Note that the builder does not expose the full generality of LLVM
504 /// instructions. For access to extra instruction properties, use the mutators
505 /// (e.g. setVolatile) on the instructions after they have been
506 /// created. Convenience state exists to specify fast-math flags and fp-math
509 /// The first template argument handles whether or not to preserve names in the
510 /// final instruction output. This defaults to on. The second template argument
511 /// specifies a class to use for creating constants. This defaults to creating
512 /// minimally folded constants. The third template argument allows clients to
513 /// specify custom insertion hooks that are called on every newly created
515 template<bool preserveNames = true, typename T = ConstantFolder,
516 typename Inserter = IRBuilderDefaultInserter<preserveNames> >
517 class IRBuilder : public IRBuilderBase, public Inserter {
520 IRBuilder(LLVMContext &C, const T &F, const Inserter &I = Inserter(),
521 MDNode *FPMathTag = nullptr)
522 : IRBuilderBase(C, FPMathTag), Inserter(I), Folder(F) {
525 explicit IRBuilder(LLVMContext &C, MDNode *FPMathTag = nullptr)
526 : IRBuilderBase(C, FPMathTag), Folder() {
529 explicit IRBuilder(BasicBlock *TheBB, const T &F, MDNode *FPMathTag = nullptr)
530 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
531 SetInsertPoint(TheBB);
534 explicit IRBuilder(BasicBlock *TheBB, MDNode *FPMathTag = nullptr)
535 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
536 SetInsertPoint(TheBB);
539 explicit IRBuilder(Instruction *IP, MDNode *FPMathTag = nullptr)
540 : IRBuilderBase(IP->getContext(), FPMathTag), Folder() {
544 IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP, const T& F,
545 MDNode *FPMathTag = nullptr)
546 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
547 SetInsertPoint(TheBB, IP);
550 IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP,
551 MDNode *FPMathTag = nullptr)
552 : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
553 SetInsertPoint(TheBB, IP);
556 /// \brief Get the constant folder being used.
557 const T &getFolder() { return Folder; }
559 /// \brief Return true if this builder is configured to actually add the
560 /// requested names to IR created through it.
561 bool isNamePreserving() const { return preserveNames; }
563 /// \brief Insert and return the specified instruction.
564 template<typename InstTy>
565 InstTy *Insert(InstTy *I, const Twine &Name = "") const {
566 this->InsertHelper(I, Name, BB, InsertPt);
567 this->SetInstDebugLocation(I);
571 /// \brief No-op overload to handle constants.
572 Constant *Insert(Constant *C, const Twine& = "") const {
576 //===--------------------------------------------------------------------===//
577 // Instruction creation methods: Terminators
578 //===--------------------------------------------------------------------===//
581 /// \brief Helper to add branch weight metadata onto an instruction.
582 /// \returns The annotated instruction.
583 template <typename InstTy>
584 InstTy *addBranchWeights(InstTy *I, MDNode *Weights) {
586 I->setMetadata(LLVMContext::MD_prof, Weights);
591 /// \brief Create a 'ret void' instruction.
592 ReturnInst *CreateRetVoid() {
593 return Insert(ReturnInst::Create(Context));
596 /// \brief Create a 'ret <val>' instruction.
597 ReturnInst *CreateRet(Value *V) {
598 return Insert(ReturnInst::Create(Context, V));
601 /// \brief Create a sequence of N insertvalue instructions,
602 /// with one Value from the retVals array each, that build a aggregate
603 /// return value one value at a time, and a ret instruction to return
604 /// the resulting aggregate value.
606 /// This is a convenience function for code that uses aggregate return values
607 /// as a vehicle for having multiple return values.
608 ReturnInst *CreateAggregateRet(Value *const *retVals, unsigned N) {
609 Value *V = UndefValue::get(getCurrentFunctionReturnType());
610 for (unsigned i = 0; i != N; ++i)
611 V = CreateInsertValue(V, retVals[i], i, "mrv");
612 return Insert(ReturnInst::Create(Context, V));
615 /// \brief Create an unconditional 'br label X' instruction.
616 BranchInst *CreateBr(BasicBlock *Dest) {
617 return Insert(BranchInst::Create(Dest));
620 /// \brief Create a conditional 'br Cond, TrueDest, FalseDest'
622 BranchInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False,
623 MDNode *BranchWeights = nullptr) {
624 return Insert(addBranchWeights(BranchInst::Create(True, False, Cond),
628 /// \brief Create a switch instruction with the specified value, default dest,
629 /// and with a hint for the number of cases that will be added (for efficient
631 SwitchInst *CreateSwitch(Value *V, BasicBlock *Dest, unsigned NumCases = 10,
632 MDNode *BranchWeights = nullptr) {
633 return Insert(addBranchWeights(SwitchInst::Create(V, Dest, NumCases),
637 /// \brief Create an indirect branch instruction with the specified address
638 /// operand, with an optional hint for the number of destinations that will be
639 /// added (for efficient allocation).
640 IndirectBrInst *CreateIndirectBr(Value *Addr, unsigned NumDests = 10) {
641 return Insert(IndirectBrInst::Create(Addr, NumDests));
644 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
645 BasicBlock *UnwindDest, const Twine &Name = "") {
646 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, None),
649 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
650 BasicBlock *UnwindDest, Value *Arg1,
651 const Twine &Name = "") {
652 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Arg1),
655 InvokeInst *CreateInvoke3(Value *Callee, BasicBlock *NormalDest,
656 BasicBlock *UnwindDest, Value *Arg1,
657 Value *Arg2, Value *Arg3,
658 const Twine &Name = "") {
659 Value *Args[] = { Arg1, Arg2, Arg3 };
660 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
663 /// \brief Create an invoke instruction.
664 InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
665 BasicBlock *UnwindDest, ArrayRef<Value *> Args,
666 const Twine &Name = "") {
667 return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
671 ResumeInst *CreateResume(Value *Exn) {
672 return Insert(ResumeInst::Create(Exn));
675 UnreachableInst *CreateUnreachable() {
676 return Insert(new UnreachableInst(Context));
679 //===--------------------------------------------------------------------===//
680 // Instruction creation methods: Binary Operators
681 //===--------------------------------------------------------------------===//
683 BinaryOperator *CreateInsertNUWNSWBinOp(BinaryOperator::BinaryOps Opc,
684 Value *LHS, Value *RHS,
686 bool HasNUW, bool HasNSW) {
687 BinaryOperator *BO = Insert(BinaryOperator::Create(Opc, LHS, RHS), Name);
688 if (HasNUW) BO->setHasNoUnsignedWrap();
689 if (HasNSW) BO->setHasNoSignedWrap();
693 Instruction *AddFPMathAttributes(Instruction *I,
695 FastMathFlags FMF) const {
697 FPMathTag = DefaultFPMathTag;
699 I->setMetadata(LLVMContext::MD_fpmath, FPMathTag);
700 I->setFastMathFlags(FMF);
704 Value *CreateAdd(Value *LHS, Value *RHS, const Twine &Name = "",
705 bool HasNUW = false, bool HasNSW = false) {
706 if (Constant *LC = dyn_cast<Constant>(LHS))
707 if (Constant *RC = dyn_cast<Constant>(RHS))
708 return Insert(Folder.CreateAdd(LC, RC, HasNUW, HasNSW), Name);
709 return CreateInsertNUWNSWBinOp(Instruction::Add, LHS, RHS, Name,
712 Value *CreateNSWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
713 return CreateAdd(LHS, RHS, Name, false, true);
715 Value *CreateNUWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
716 return CreateAdd(LHS, RHS, Name, true, false);
718 Value *CreateFAdd(Value *LHS, Value *RHS, const Twine &Name = "",
719 MDNode *FPMathTag = nullptr) {
720 if (Constant *LC = dyn_cast<Constant>(LHS))
721 if (Constant *RC = dyn_cast<Constant>(RHS))
722 return Insert(Folder.CreateFAdd(LC, RC), Name);
723 return Insert(AddFPMathAttributes(BinaryOperator::CreateFAdd(LHS, RHS),
724 FPMathTag, FMF), Name);
726 Value *CreateSub(Value *LHS, Value *RHS, const Twine &Name = "",
727 bool HasNUW = false, bool HasNSW = false) {
728 if (Constant *LC = dyn_cast<Constant>(LHS))
729 if (Constant *RC = dyn_cast<Constant>(RHS))
730 return Insert(Folder.CreateSub(LC, RC, HasNUW, HasNSW), Name);
731 return CreateInsertNUWNSWBinOp(Instruction::Sub, LHS, RHS, Name,
734 Value *CreateNSWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
735 return CreateSub(LHS, RHS, Name, false, true);
737 Value *CreateNUWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
738 return CreateSub(LHS, RHS, Name, true, false);
740 Value *CreateFSub(Value *LHS, Value *RHS, const Twine &Name = "",
741 MDNode *FPMathTag = nullptr) {
742 if (Constant *LC = dyn_cast<Constant>(LHS))
743 if (Constant *RC = dyn_cast<Constant>(RHS))
744 return Insert(Folder.CreateFSub(LC, RC), Name);
745 return Insert(AddFPMathAttributes(BinaryOperator::CreateFSub(LHS, RHS),
746 FPMathTag, FMF), Name);
748 Value *CreateMul(Value *LHS, Value *RHS, const Twine &Name = "",
749 bool HasNUW = false, bool HasNSW = false) {
750 if (Constant *LC = dyn_cast<Constant>(LHS))
751 if (Constant *RC = dyn_cast<Constant>(RHS))
752 return Insert(Folder.CreateMul(LC, RC, HasNUW, HasNSW), Name);
753 return CreateInsertNUWNSWBinOp(Instruction::Mul, LHS, RHS, Name,
756 Value *CreateNSWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
757 return CreateMul(LHS, RHS, Name, false, true);
759 Value *CreateNUWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
760 return CreateMul(LHS, RHS, Name, true, false);
762 Value *CreateFMul(Value *LHS, Value *RHS, const Twine &Name = "",
763 MDNode *FPMathTag = nullptr) {
764 if (Constant *LC = dyn_cast<Constant>(LHS))
765 if (Constant *RC = dyn_cast<Constant>(RHS))
766 return Insert(Folder.CreateFMul(LC, RC), Name);
767 return Insert(AddFPMathAttributes(BinaryOperator::CreateFMul(LHS, RHS),
768 FPMathTag, FMF), Name);
770 Value *CreateUDiv(Value *LHS, Value *RHS, const Twine &Name = "",
771 bool isExact = false) {
772 if (Constant *LC = dyn_cast<Constant>(LHS))
773 if (Constant *RC = dyn_cast<Constant>(RHS))
774 return Insert(Folder.CreateUDiv(LC, RC, isExact), Name);
776 return Insert(BinaryOperator::CreateUDiv(LHS, RHS), Name);
777 return Insert(BinaryOperator::CreateExactUDiv(LHS, RHS), Name);
779 Value *CreateExactUDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
780 return CreateUDiv(LHS, RHS, Name, true);
782 Value *CreateSDiv(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.CreateSDiv(LC, RC, isExact), Name);
788 return Insert(BinaryOperator::CreateSDiv(LHS, RHS), Name);
789 return Insert(BinaryOperator::CreateExactSDiv(LHS, RHS), Name);
791 Value *CreateExactSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
792 return CreateSDiv(LHS, RHS, Name, true);
794 Value *CreateFDiv(Value *LHS, Value *RHS, const Twine &Name = "",
795 MDNode *FPMathTag = nullptr) {
796 if (Constant *LC = dyn_cast<Constant>(LHS))
797 if (Constant *RC = dyn_cast<Constant>(RHS))
798 return Insert(Folder.CreateFDiv(LC, RC), Name);
799 return Insert(AddFPMathAttributes(BinaryOperator::CreateFDiv(LHS, RHS),
800 FPMathTag, FMF), Name);
802 Value *CreateURem(Value *LHS, Value *RHS, const Twine &Name = "") {
803 if (Constant *LC = dyn_cast<Constant>(LHS))
804 if (Constant *RC = dyn_cast<Constant>(RHS))
805 return Insert(Folder.CreateURem(LC, RC), Name);
806 return Insert(BinaryOperator::CreateURem(LHS, RHS), Name);
808 Value *CreateSRem(Value *LHS, Value *RHS, const Twine &Name = "") {
809 if (Constant *LC = dyn_cast<Constant>(LHS))
810 if (Constant *RC = dyn_cast<Constant>(RHS))
811 return Insert(Folder.CreateSRem(LC, RC), Name);
812 return Insert(BinaryOperator::CreateSRem(LHS, RHS), Name);
814 Value *CreateFRem(Value *LHS, Value *RHS, const Twine &Name = "",
815 MDNode *FPMathTag = nullptr) {
816 if (Constant *LC = dyn_cast<Constant>(LHS))
817 if (Constant *RC = dyn_cast<Constant>(RHS))
818 return Insert(Folder.CreateFRem(LC, RC), Name);
819 return Insert(AddFPMathAttributes(BinaryOperator::CreateFRem(LHS, RHS),
820 FPMathTag, FMF), Name);
823 Value *CreateShl(Value *LHS, Value *RHS, const Twine &Name = "",
824 bool HasNUW = false, bool HasNSW = false) {
825 if (Constant *LC = dyn_cast<Constant>(LHS))
826 if (Constant *RC = dyn_cast<Constant>(RHS))
827 return Insert(Folder.CreateShl(LC, RC, HasNUW, HasNSW), Name);
828 return CreateInsertNUWNSWBinOp(Instruction::Shl, LHS, RHS, Name,
831 Value *CreateShl(Value *LHS, const APInt &RHS, const Twine &Name = "",
832 bool HasNUW = false, bool HasNSW = false) {
833 return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
836 Value *CreateShl(Value *LHS, uint64_t RHS, const Twine &Name = "",
837 bool HasNUW = false, bool HasNSW = false) {
838 return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
842 Value *CreateLShr(Value *LHS, Value *RHS, const Twine &Name = "",
843 bool isExact = false) {
844 if (Constant *LC = dyn_cast<Constant>(LHS))
845 if (Constant *RC = dyn_cast<Constant>(RHS))
846 return Insert(Folder.CreateLShr(LC, RC, isExact), Name);
848 return Insert(BinaryOperator::CreateLShr(LHS, RHS), Name);
849 return Insert(BinaryOperator::CreateExactLShr(LHS, RHS), Name);
851 Value *CreateLShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
852 bool isExact = false) {
853 return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
855 Value *CreateLShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
856 bool isExact = false) {
857 return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
860 Value *CreateAShr(Value *LHS, Value *RHS, const Twine &Name = "",
861 bool isExact = false) {
862 if (Constant *LC = dyn_cast<Constant>(LHS))
863 if (Constant *RC = dyn_cast<Constant>(RHS))
864 return Insert(Folder.CreateAShr(LC, RC, isExact), Name);
866 return Insert(BinaryOperator::CreateAShr(LHS, RHS), Name);
867 return Insert(BinaryOperator::CreateExactAShr(LHS, RHS), Name);
869 Value *CreateAShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
870 bool isExact = false) {
871 return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
873 Value *CreateAShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
874 bool isExact = false) {
875 return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
878 Value *CreateAnd(Value *LHS, Value *RHS, const Twine &Name = "") {
879 if (Constant *RC = dyn_cast<Constant>(RHS)) {
880 if (isa<ConstantInt>(RC) && cast<ConstantInt>(RC)->isAllOnesValue())
881 return LHS; // LHS & -1 -> LHS
882 if (Constant *LC = dyn_cast<Constant>(LHS))
883 return Insert(Folder.CreateAnd(LC, RC), Name);
885 return Insert(BinaryOperator::CreateAnd(LHS, RHS), Name);
887 Value *CreateAnd(Value *LHS, const APInt &RHS, const Twine &Name = "") {
888 return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
890 Value *CreateAnd(Value *LHS, uint64_t RHS, const Twine &Name = "") {
891 return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
894 Value *CreateOr(Value *LHS, Value *RHS, const Twine &Name = "") {
895 if (Constant *RC = dyn_cast<Constant>(RHS)) {
896 if (RC->isNullValue())
897 return LHS; // LHS | 0 -> LHS
898 if (Constant *LC = dyn_cast<Constant>(LHS))
899 return Insert(Folder.CreateOr(LC, RC), Name);
901 return Insert(BinaryOperator::CreateOr(LHS, RHS), Name);
903 Value *CreateOr(Value *LHS, const APInt &RHS, const Twine &Name = "") {
904 return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
906 Value *CreateOr(Value *LHS, uint64_t RHS, const Twine &Name = "") {
907 return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
910 Value *CreateXor(Value *LHS, Value *RHS, const Twine &Name = "") {
911 if (Constant *LC = dyn_cast<Constant>(LHS))
912 if (Constant *RC = dyn_cast<Constant>(RHS))
913 return Insert(Folder.CreateXor(LC, RC), Name);
914 return Insert(BinaryOperator::CreateXor(LHS, RHS), Name);
916 Value *CreateXor(Value *LHS, const APInt &RHS, const Twine &Name = "") {
917 return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
919 Value *CreateXor(Value *LHS, uint64_t RHS, const Twine &Name = "") {
920 return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
923 Value *CreateBinOp(Instruction::BinaryOps Opc,
924 Value *LHS, Value *RHS, const Twine &Name = "",
925 MDNode *FPMathTag = nullptr) {
926 if (Constant *LC = dyn_cast<Constant>(LHS))
927 if (Constant *RC = dyn_cast<Constant>(RHS))
928 return Insert(Folder.CreateBinOp(Opc, LC, RC), Name);
929 llvm::Instruction *BinOp = BinaryOperator::Create(Opc, LHS, RHS);
930 if (isa<FPMathOperator>(BinOp))
931 BinOp = AddFPMathAttributes(BinOp, FPMathTag, FMF);
932 return Insert(BinOp, Name);
935 Value *CreateNeg(Value *V, const Twine &Name = "",
936 bool HasNUW = false, bool HasNSW = false) {
937 if (Constant *VC = dyn_cast<Constant>(V))
938 return Insert(Folder.CreateNeg(VC, HasNUW, HasNSW), Name);
939 BinaryOperator *BO = Insert(BinaryOperator::CreateNeg(V), Name);
940 if (HasNUW) BO->setHasNoUnsignedWrap();
941 if (HasNSW) BO->setHasNoSignedWrap();
944 Value *CreateNSWNeg(Value *V, const Twine &Name = "") {
945 return CreateNeg(V, Name, false, true);
947 Value *CreateNUWNeg(Value *V, const Twine &Name = "") {
948 return CreateNeg(V, Name, true, false);
950 Value *CreateFNeg(Value *V, const Twine &Name = "",
951 MDNode *FPMathTag = nullptr) {
952 if (Constant *VC = dyn_cast<Constant>(V))
953 return Insert(Folder.CreateFNeg(VC), Name);
954 return Insert(AddFPMathAttributes(BinaryOperator::CreateFNeg(V),
955 FPMathTag, FMF), Name);
957 Value *CreateNot(Value *V, const Twine &Name = "") {
958 if (Constant *VC = dyn_cast<Constant>(V))
959 return Insert(Folder.CreateNot(VC), Name);
960 return Insert(BinaryOperator::CreateNot(V), Name);
963 //===--------------------------------------------------------------------===//
964 // Instruction creation methods: Memory Instructions
965 //===--------------------------------------------------------------------===//
967 AllocaInst *CreateAlloca(Type *Ty, Value *ArraySize = nullptr,
968 const Twine &Name = "") {
969 return Insert(new AllocaInst(Ty, ArraySize), Name);
971 // \brief Provided to resolve 'CreateLoad(Ptr, "...")' correctly, instead of
972 // converting the string to 'bool' for the isVolatile parameter.
973 LoadInst *CreateLoad(Value *Ptr, const char *Name) {
974 return Insert(new LoadInst(Ptr), Name);
976 LoadInst *CreateLoad(Value *Ptr, const Twine &Name = "") {
977 return Insert(new LoadInst(Ptr), Name);
979 LoadInst *CreateLoad(Type *Ty, Value *Ptr, const Twine &Name = "") {
980 return Insert(new LoadInst(Ty, Ptr), Name);
982 LoadInst *CreateLoad(Value *Ptr, bool isVolatile, const Twine &Name = "") {
983 return Insert(new LoadInst(Ptr, nullptr, isVolatile), Name);
985 StoreInst *CreateStore(Value *Val, Value *Ptr, bool isVolatile = false) {
986 return Insert(new StoreInst(Val, Ptr, isVolatile));
988 // \brief Provided to resolve 'CreateAlignedLoad(Ptr, Align, "...")'
989 // correctly, instead of converting the string to 'bool' for the isVolatile
991 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, const char *Name) {
992 LoadInst *LI = CreateLoad(Ptr, Name);
993 LI->setAlignment(Align);
996 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align,
997 const Twine &Name = "") {
998 LoadInst *LI = CreateLoad(Ptr, Name);
999 LI->setAlignment(Align);
1002 LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, bool isVolatile,
1003 const Twine &Name = "") {
1004 LoadInst *LI = CreateLoad(Ptr, isVolatile, Name);
1005 LI->setAlignment(Align);
1008 StoreInst *CreateAlignedStore(Value *Val, Value *Ptr, unsigned Align,
1009 bool isVolatile = false) {
1010 StoreInst *SI = CreateStore(Val, Ptr, isVolatile);
1011 SI->setAlignment(Align);
1014 FenceInst *CreateFence(AtomicOrdering Ordering,
1015 SynchronizationScope SynchScope = CrossThread,
1016 const Twine &Name = "") {
1017 return Insert(new FenceInst(Context, Ordering, SynchScope), Name);
1020 CreateAtomicCmpXchg(Value *Ptr, Value *Cmp, Value *New,
1021 AtomicOrdering SuccessOrdering,
1022 AtomicOrdering FailureOrdering,
1023 SynchronizationScope SynchScope = CrossThread) {
1024 return Insert(new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering,
1025 FailureOrdering, SynchScope));
1027 AtomicRMWInst *CreateAtomicRMW(AtomicRMWInst::BinOp Op, Value *Ptr, Value *Val,
1028 AtomicOrdering Ordering,
1029 SynchronizationScope SynchScope = CrossThread) {
1030 return Insert(new AtomicRMWInst(Op, Ptr, Val, Ordering, SynchScope));
1032 Value *CreateGEP(Value *Ptr, ArrayRef<Value *> IdxList,
1033 const Twine &Name = "") {
1034 return CreateGEP(nullptr, Ptr, IdxList, Name);
1036 Value *CreateGEP(Type *Ty, Value *Ptr, ArrayRef<Value *> IdxList,
1037 const Twine &Name = "") {
1038 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
1039 // Every index must be constant.
1041 for (i = 0, e = IdxList.size(); i != e; ++i)
1042 if (!isa<Constant>(IdxList[i]))
1045 return Insert(Folder.CreateGetElementPtr(Ty, PC, IdxList), Name);
1047 return Insert(GetElementPtrInst::Create(Ty, Ptr, IdxList), Name);
1049 Value *CreateInBoundsGEP(Value *Ptr, ArrayRef<Value *> IdxList,
1050 const Twine &Name = "") {
1051 return CreateInBoundsGEP(nullptr, Ptr, IdxList, Name);
1053 Value *CreateInBoundsGEP(Type *Ty, Value *Ptr, ArrayRef<Value *> IdxList,
1054 const Twine &Name = "") {
1055 if (Constant *PC = dyn_cast<Constant>(Ptr)) {
1056 // Every index must be constant.
1058 for (i = 0, e = IdxList.size(); i != e; ++i)
1059 if (!isa<Constant>(IdxList[i]))
1062 return Insert(Folder.CreateInBoundsGetElementPtr(Ty, PC, IdxList),
1065 return Insert(GetElementPtrInst::CreateInBounds(Ty, Ptr, IdxList), Name);
1067 Value *CreateGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
1068 return CreateGEP(nullptr, Ptr, Idx, Name);
1070 Value *CreateGEP(Type *Ty, Value *Ptr, Value *Idx, const Twine &Name = "") {
1071 if (Constant *PC = dyn_cast<Constant>(Ptr))
1072 if (Constant *IC = dyn_cast<Constant>(Idx))
1073 return Insert(Folder.CreateGetElementPtr(Ty, PC, IC), Name);
1074 return Insert(GetElementPtrInst::Create(Ty, Ptr, Idx), Name);
1076 Value *CreateInBoundsGEP(Type *Ty, Value *Ptr, Value *Idx,
1077 const Twine &Name = "") {
1078 if (Constant *PC = dyn_cast<Constant>(Ptr))
1079 if (Constant *IC = dyn_cast<Constant>(Idx))
1080 return Insert(Folder.CreateInBoundsGetElementPtr(Ty, PC, IC), Name);
1081 return Insert(GetElementPtrInst::CreateInBounds(Ty, Ptr, Idx), Name);
1083 Value *CreateConstGEP1_32(Value *Ptr, unsigned Idx0, const Twine &Name = "") {
1084 return CreateConstGEP1_32(nullptr, Ptr, Idx0, Name);
1086 Value *CreateConstGEP1_32(Type *Ty, Value *Ptr, unsigned Idx0,
1087 const Twine &Name = "") {
1088 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
1090 if (Constant *PC = dyn_cast<Constant>(Ptr))
1091 return Insert(Folder.CreateGetElementPtr(Ty, PC, Idx), Name);
1093 return Insert(GetElementPtrInst::Create(Ty, Ptr, Idx), Name);
1095 Value *CreateConstInBoundsGEP1_32(Type *Ty, Value *Ptr, unsigned Idx0,
1096 const Twine &Name = "") {
1097 Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
1099 if (Constant *PC = dyn_cast<Constant>(Ptr))
1100 return Insert(Folder.CreateInBoundsGetElementPtr(Ty, PC, Idx), Name);
1102 return Insert(GetElementPtrInst::CreateInBounds(Ty, Ptr, Idx), Name);
1104 Value *CreateConstGEP2_32(Type *Ty, Value *Ptr, unsigned Idx0, unsigned Idx1,
1105 const Twine &Name = "") {
1107 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1108 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1111 if (Constant *PC = dyn_cast<Constant>(Ptr))
1112 return Insert(Folder.CreateGetElementPtr(Ty, PC, Idxs), Name);
1114 return Insert(GetElementPtrInst::Create(Ty, Ptr, Idxs), Name);
1116 Value *CreateConstInBoundsGEP2_32(Type *Ty, Value *Ptr, unsigned Idx0,
1117 unsigned Idx1, const Twine &Name = "") {
1119 ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1120 ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1123 if (Constant *PC = dyn_cast<Constant>(Ptr))
1124 return Insert(Folder.CreateInBoundsGetElementPtr(Ty, PC, Idxs), Name);
1126 return Insert(GetElementPtrInst::CreateInBounds(Ty, Ptr, Idxs), Name);
1128 Value *CreateConstGEP1_64(Value *Ptr, uint64_t Idx0, const Twine &Name = "") {
1129 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1131 if (Constant *PC = dyn_cast<Constant>(Ptr))
1132 return Insert(Folder.CreateGetElementPtr(nullptr, PC, Idx), Name);
1134 return Insert(GetElementPtrInst::Create(nullptr, Ptr, Idx), Name);
1136 Value *CreateConstInBoundsGEP1_64(Value *Ptr, uint64_t Idx0,
1137 const Twine &Name = "") {
1138 Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1140 if (Constant *PC = dyn_cast<Constant>(Ptr))
1141 return Insert(Folder.CreateInBoundsGetElementPtr(nullptr, PC, Idx), Name);
1143 return Insert(GetElementPtrInst::CreateInBounds(nullptr, Ptr, Idx), Name);
1145 Value *CreateConstGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1146 const Twine &Name = "") {
1148 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1149 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1152 if (Constant *PC = dyn_cast<Constant>(Ptr))
1153 return Insert(Folder.CreateGetElementPtr(nullptr, PC, Idxs), Name);
1155 return Insert(GetElementPtrInst::Create(nullptr, Ptr, Idxs), Name);
1157 Value *CreateConstInBoundsGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1158 const Twine &Name = "") {
1160 ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1161 ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1164 if (Constant *PC = dyn_cast<Constant>(Ptr))
1165 return Insert(Folder.CreateInBoundsGetElementPtr(nullptr, PC, Idxs),
1168 return Insert(GetElementPtrInst::CreateInBounds(nullptr, Ptr, Idxs), Name);
1170 Value *CreateStructGEP(Type *Ty, Value *Ptr, unsigned Idx,
1171 const Twine &Name = "") {
1172 return CreateConstInBoundsGEP2_32(Ty, Ptr, 0, Idx, Name);
1175 /// \brief Same as CreateGlobalString, but return a pointer with "i8*" type
1176 /// instead of a pointer to array of i8.
1177 Value *CreateGlobalStringPtr(StringRef Str, const Twine &Name = "",
1178 unsigned AddressSpace = 0) {
1179 GlobalVariable *gv = CreateGlobalString(Str, Name, AddressSpace);
1180 Value *zero = ConstantInt::get(Type::getInt32Ty(Context), 0);
1181 Value *Args[] = { zero, zero };
1182 return CreateInBoundsGEP(gv->getValueType(), gv, Args, Name);
1185 //===--------------------------------------------------------------------===//
1186 // Instruction creation methods: Cast/Conversion Operators
1187 //===--------------------------------------------------------------------===//
1189 Value *CreateTrunc(Value *V, Type *DestTy, const Twine &Name = "") {
1190 return CreateCast(Instruction::Trunc, V, DestTy, Name);
1192 Value *CreateZExt(Value *V, Type *DestTy, const Twine &Name = "") {
1193 return CreateCast(Instruction::ZExt, V, DestTy, Name);
1195 Value *CreateSExt(Value *V, Type *DestTy, const Twine &Name = "") {
1196 return CreateCast(Instruction::SExt, V, DestTy, Name);
1198 /// \brief Create a ZExt or Trunc from the integer value V to DestTy. Return
1199 /// the value untouched if the type of V is already DestTy.
1200 Value *CreateZExtOrTrunc(Value *V, Type *DestTy,
1201 const Twine &Name = "") {
1202 assert(V->getType()->isIntOrIntVectorTy() &&
1203 DestTy->isIntOrIntVectorTy() &&
1204 "Can only zero extend/truncate integers!");
1205 Type *VTy = V->getType();
1206 if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1207 return CreateZExt(V, DestTy, Name);
1208 if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1209 return CreateTrunc(V, DestTy, Name);
1212 /// \brief Create a SExt or Trunc from the integer value V to DestTy. Return
1213 /// the value untouched if the type of V is already DestTy.
1214 Value *CreateSExtOrTrunc(Value *V, Type *DestTy,
1215 const Twine &Name = "") {
1216 assert(V->getType()->isIntOrIntVectorTy() &&
1217 DestTy->isIntOrIntVectorTy() &&
1218 "Can only sign extend/truncate integers!");
1219 Type *VTy = V->getType();
1220 if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1221 return CreateSExt(V, DestTy, Name);
1222 if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1223 return CreateTrunc(V, DestTy, Name);
1226 Value *CreateFPToUI(Value *V, Type *DestTy, const Twine &Name = ""){
1227 return CreateCast(Instruction::FPToUI, V, DestTy, Name);
1229 Value *CreateFPToSI(Value *V, Type *DestTy, const Twine &Name = ""){
1230 return CreateCast(Instruction::FPToSI, V, DestTy, Name);
1232 Value *CreateUIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1233 return CreateCast(Instruction::UIToFP, V, DestTy, Name);
1235 Value *CreateSIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1236 return CreateCast(Instruction::SIToFP, V, DestTy, Name);
1238 Value *CreateFPTrunc(Value *V, Type *DestTy,
1239 const Twine &Name = "") {
1240 return CreateCast(Instruction::FPTrunc, V, DestTy, Name);
1242 Value *CreateFPExt(Value *V, Type *DestTy, const Twine &Name = "") {
1243 return CreateCast(Instruction::FPExt, V, DestTy, Name);
1245 Value *CreatePtrToInt(Value *V, Type *DestTy,
1246 const Twine &Name = "") {
1247 return CreateCast(Instruction::PtrToInt, V, DestTy, Name);
1249 Value *CreateIntToPtr(Value *V, Type *DestTy,
1250 const Twine &Name = "") {
1251 return CreateCast(Instruction::IntToPtr, V, DestTy, Name);
1253 Value *CreateBitCast(Value *V, Type *DestTy,
1254 const Twine &Name = "") {
1255 return CreateCast(Instruction::BitCast, V, DestTy, Name);
1257 Value *CreateAddrSpaceCast(Value *V, Type *DestTy,
1258 const Twine &Name = "") {
1259 return CreateCast(Instruction::AddrSpaceCast, V, DestTy, Name);
1261 Value *CreateZExtOrBitCast(Value *V, Type *DestTy,
1262 const Twine &Name = "") {
1263 if (V->getType() == DestTy)
1265 if (Constant *VC = dyn_cast<Constant>(V))
1266 return Insert(Folder.CreateZExtOrBitCast(VC, DestTy), Name);
1267 return Insert(CastInst::CreateZExtOrBitCast(V, DestTy), Name);
1269 Value *CreateSExtOrBitCast(Value *V, Type *DestTy,
1270 const Twine &Name = "") {
1271 if (V->getType() == DestTy)
1273 if (Constant *VC = dyn_cast<Constant>(V))
1274 return Insert(Folder.CreateSExtOrBitCast(VC, DestTy), Name);
1275 return Insert(CastInst::CreateSExtOrBitCast(V, DestTy), Name);
1277 Value *CreateTruncOrBitCast(Value *V, Type *DestTy,
1278 const Twine &Name = "") {
1279 if (V->getType() == DestTy)
1281 if (Constant *VC = dyn_cast<Constant>(V))
1282 return Insert(Folder.CreateTruncOrBitCast(VC, DestTy), Name);
1283 return Insert(CastInst::CreateTruncOrBitCast(V, DestTy), Name);
1285 Value *CreateCast(Instruction::CastOps Op, Value *V, Type *DestTy,
1286 const Twine &Name = "") {
1287 if (V->getType() == DestTy)
1289 if (Constant *VC = dyn_cast<Constant>(V))
1290 return Insert(Folder.CreateCast(Op, VC, DestTy), Name);
1291 return Insert(CastInst::Create(Op, V, DestTy), Name);
1293 Value *CreatePointerCast(Value *V, Type *DestTy,
1294 const Twine &Name = "") {
1295 if (V->getType() == DestTy)
1297 if (Constant *VC = dyn_cast<Constant>(V))
1298 return Insert(Folder.CreatePointerCast(VC, DestTy), Name);
1299 return Insert(CastInst::CreatePointerCast(V, DestTy), Name);
1302 Value *CreatePointerBitCastOrAddrSpaceCast(Value *V, Type *DestTy,
1303 const Twine &Name = "") {
1304 if (V->getType() == DestTy)
1307 if (Constant *VC = dyn_cast<Constant>(V)) {
1308 return Insert(Folder.CreatePointerBitCastOrAddrSpaceCast(VC, DestTy),
1312 return Insert(CastInst::CreatePointerBitCastOrAddrSpaceCast(V, DestTy),
1316 Value *CreateIntCast(Value *V, Type *DestTy, bool isSigned,
1317 const Twine &Name = "") {
1318 if (V->getType() == DestTy)
1320 if (Constant *VC = dyn_cast<Constant>(V))
1321 return Insert(Folder.CreateIntCast(VC, DestTy, isSigned), Name);
1322 return Insert(CastInst::CreateIntegerCast(V, DestTy, isSigned), Name);
1325 Value *CreateBitOrPointerCast(Value *V, Type *DestTy,
1326 const Twine &Name = "") {
1327 if (V->getType() == DestTy)
1329 if (V->getType()->isPointerTy() && DestTy->isIntegerTy())
1330 return CreatePtrToInt(V, DestTy, Name);
1331 if (V->getType()->isIntegerTy() && DestTy->isPointerTy())
1332 return CreateIntToPtr(V, DestTy, Name);
1334 return CreateBitCast(V, DestTy, Name);
1337 // \brief Provided to resolve 'CreateIntCast(Ptr, Ptr, "...")', giving a
1338 // compile time error, instead of converting the string to bool for the
1339 // isSigned parameter.
1340 Value *CreateIntCast(Value *, Type *, const char *) = delete;
1342 Value *CreateFPCast(Value *V, Type *DestTy, const Twine &Name = "") {
1343 if (V->getType() == DestTy)
1345 if (Constant *VC = dyn_cast<Constant>(V))
1346 return Insert(Folder.CreateFPCast(VC, DestTy), Name);
1347 return Insert(CastInst::CreateFPCast(V, DestTy), Name);
1350 //===--------------------------------------------------------------------===//
1351 // Instruction creation methods: Compare Instructions
1352 //===--------------------------------------------------------------------===//
1354 Value *CreateICmpEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1355 return CreateICmp(ICmpInst::ICMP_EQ, LHS, RHS, Name);
1357 Value *CreateICmpNE(Value *LHS, Value *RHS, const Twine &Name = "") {
1358 return CreateICmp(ICmpInst::ICMP_NE, LHS, RHS, Name);
1360 Value *CreateICmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1361 return CreateICmp(ICmpInst::ICMP_UGT, LHS, RHS, Name);
1363 Value *CreateICmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1364 return CreateICmp(ICmpInst::ICMP_UGE, LHS, RHS, Name);
1366 Value *CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
1367 return CreateICmp(ICmpInst::ICMP_ULT, LHS, RHS, Name);
1369 Value *CreateICmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
1370 return CreateICmp(ICmpInst::ICMP_ULE, LHS, RHS, Name);
1372 Value *CreateICmpSGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1373 return CreateICmp(ICmpInst::ICMP_SGT, LHS, RHS, Name);
1375 Value *CreateICmpSGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1376 return CreateICmp(ICmpInst::ICMP_SGE, LHS, RHS, Name);
1378 Value *CreateICmpSLT(Value *LHS, Value *RHS, const Twine &Name = "") {
1379 return CreateICmp(ICmpInst::ICMP_SLT, LHS, RHS, Name);
1381 Value *CreateICmpSLE(Value *LHS, Value *RHS, const Twine &Name = "") {
1382 return CreateICmp(ICmpInst::ICMP_SLE, LHS, RHS, Name);
1385 Value *CreateFCmpOEQ(Value *LHS, Value *RHS, const Twine &Name = "",
1386 MDNode *FPMathTag = nullptr) {
1387 return CreateFCmp(FCmpInst::FCMP_OEQ, LHS, RHS, Name, FPMathTag);
1389 Value *CreateFCmpOGT(Value *LHS, Value *RHS, const Twine &Name = "",
1390 MDNode *FPMathTag = nullptr) {
1391 return CreateFCmp(FCmpInst::FCMP_OGT, LHS, RHS, Name, FPMathTag);
1393 Value *CreateFCmpOGE(Value *LHS, Value *RHS, const Twine &Name = "",
1394 MDNode *FPMathTag = nullptr) {
1395 return CreateFCmp(FCmpInst::FCMP_OGE, LHS, RHS, Name, FPMathTag);
1397 Value *CreateFCmpOLT(Value *LHS, Value *RHS, const Twine &Name = "",
1398 MDNode *FPMathTag = nullptr) {
1399 return CreateFCmp(FCmpInst::FCMP_OLT, LHS, RHS, Name, FPMathTag);
1401 Value *CreateFCmpOLE(Value *LHS, Value *RHS, const Twine &Name = "",
1402 MDNode *FPMathTag = nullptr) {
1403 return CreateFCmp(FCmpInst::FCMP_OLE, LHS, RHS, Name, FPMathTag);
1405 Value *CreateFCmpONE(Value *LHS, Value *RHS, const Twine &Name = "",
1406 MDNode *FPMathTag = nullptr) {
1407 return CreateFCmp(FCmpInst::FCMP_ONE, LHS, RHS, Name, FPMathTag);
1409 Value *CreateFCmpORD(Value *LHS, Value *RHS, const Twine &Name = "",
1410 MDNode *FPMathTag = nullptr) {
1411 return CreateFCmp(FCmpInst::FCMP_ORD, LHS, RHS, Name, FPMathTag);
1413 Value *CreateFCmpUNO(Value *LHS, Value *RHS, const Twine &Name = "",
1414 MDNode *FPMathTag = nullptr) {
1415 return CreateFCmp(FCmpInst::FCMP_UNO, LHS, RHS, Name, FPMathTag);
1417 Value *CreateFCmpUEQ(Value *LHS, Value *RHS, const Twine &Name = "",
1418 MDNode *FPMathTag = nullptr) {
1419 return CreateFCmp(FCmpInst::FCMP_UEQ, LHS, RHS, Name, FPMathTag);
1421 Value *CreateFCmpUGT(Value *LHS, Value *RHS, const Twine &Name = "",
1422 MDNode *FPMathTag = nullptr) {
1423 return CreateFCmp(FCmpInst::FCMP_UGT, LHS, RHS, Name, FPMathTag);
1425 Value *CreateFCmpUGE(Value *LHS, Value *RHS, const Twine &Name = "",
1426 MDNode *FPMathTag = nullptr) {
1427 return CreateFCmp(FCmpInst::FCMP_UGE, LHS, RHS, Name, FPMathTag);
1429 Value *CreateFCmpULT(Value *LHS, Value *RHS, const Twine &Name = "",
1430 MDNode *FPMathTag = nullptr) {
1431 return CreateFCmp(FCmpInst::FCMP_ULT, LHS, RHS, Name, FPMathTag);
1433 Value *CreateFCmpULE(Value *LHS, Value *RHS, const Twine &Name = "",
1434 MDNode *FPMathTag = nullptr) {
1435 return CreateFCmp(FCmpInst::FCMP_ULE, LHS, RHS, Name, FPMathTag);
1437 Value *CreateFCmpUNE(Value *LHS, Value *RHS, const Twine &Name = "",
1438 MDNode *FPMathTag = nullptr) {
1439 return CreateFCmp(FCmpInst::FCMP_UNE, LHS, RHS, Name, FPMathTag);
1442 Value *CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1443 const Twine &Name = "") {
1444 if (Constant *LC = dyn_cast<Constant>(LHS))
1445 if (Constant *RC = dyn_cast<Constant>(RHS))
1446 return Insert(Folder.CreateICmp(P, LC, RC), Name);
1447 return Insert(new ICmpInst(P, LHS, RHS), Name);
1449 Value *CreateFCmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1450 const Twine &Name = "", MDNode *FPMathTag = nullptr) {
1451 if (Constant *LC = dyn_cast<Constant>(LHS))
1452 if (Constant *RC = dyn_cast<Constant>(RHS))
1453 return Insert(Folder.CreateFCmp(P, LC, RC), Name);
1454 return Insert(AddFPMathAttributes(new FCmpInst(P, LHS, RHS),
1455 FPMathTag, FMF), Name);
1458 //===--------------------------------------------------------------------===//
1459 // Instruction creation methods: Other Instructions
1460 //===--------------------------------------------------------------------===//
1462 PHINode *CreatePHI(Type *Ty, unsigned NumReservedValues,
1463 const Twine &Name = "") {
1464 return Insert(PHINode::Create(Ty, NumReservedValues), Name);
1467 CallInst *CreateCall(Value *Callee, ArrayRef<Value *> Args = {},
1468 const Twine &Name = "") {
1469 return Insert(CallInst::Create(Callee, Args), Name);
1472 CallInst *CreateCall(llvm::FunctionType *FTy, Value *Callee,
1473 ArrayRef<Value *> Args, const Twine &Name = "") {
1474 return Insert(CallInst::Create(FTy, Callee, Args), Name);
1477 CallInst *CreateCall(Function *Callee, ArrayRef<Value *> Args,
1478 const Twine &Name = "") {
1479 return CreateCall(Callee->getFunctionType(), Callee, Args, Name);
1482 Value *CreateSelect(Value *C, Value *True, Value *False,
1483 const Twine &Name = "") {
1484 if (Constant *CC = dyn_cast<Constant>(C))
1485 if (Constant *TC = dyn_cast<Constant>(True))
1486 if (Constant *FC = dyn_cast<Constant>(False))
1487 return Insert(Folder.CreateSelect(CC, TC, FC), Name);
1488 return Insert(SelectInst::Create(C, True, False), Name);
1491 VAArgInst *CreateVAArg(Value *List, Type *Ty, const Twine &Name = "") {
1492 return Insert(new VAArgInst(List, Ty), Name);
1495 Value *CreateExtractElement(Value *Vec, Value *Idx,
1496 const Twine &Name = "") {
1497 if (Constant *VC = dyn_cast<Constant>(Vec))
1498 if (Constant *IC = dyn_cast<Constant>(Idx))
1499 return Insert(Folder.CreateExtractElement(VC, IC), Name);
1500 return Insert(ExtractElementInst::Create(Vec, Idx), Name);
1503 Value *CreateExtractElement(Value *Vec, uint64_t Idx,
1504 const Twine &Name = "") {
1505 return CreateExtractElement(Vec, getInt64(Idx), Name);
1508 Value *CreateInsertElement(Value *Vec, Value *NewElt, Value *Idx,
1509 const Twine &Name = "") {
1510 if (Constant *VC = dyn_cast<Constant>(Vec))
1511 if (Constant *NC = dyn_cast<Constant>(NewElt))
1512 if (Constant *IC = dyn_cast<Constant>(Idx))
1513 return Insert(Folder.CreateInsertElement(VC, NC, IC), Name);
1514 return Insert(InsertElementInst::Create(Vec, NewElt, Idx), Name);
1517 Value *CreateInsertElement(Value *Vec, Value *NewElt, uint64_t Idx,
1518 const Twine &Name = "") {
1519 return CreateInsertElement(Vec, NewElt, getInt64(Idx), Name);
1522 Value *CreateShuffleVector(Value *V1, Value *V2, Value *Mask,
1523 const Twine &Name = "") {
1524 if (Constant *V1C = dyn_cast<Constant>(V1))
1525 if (Constant *V2C = dyn_cast<Constant>(V2))
1526 if (Constant *MC = dyn_cast<Constant>(Mask))
1527 return Insert(Folder.CreateShuffleVector(V1C, V2C, MC), Name);
1528 return Insert(new ShuffleVectorInst(V1, V2, Mask), Name);
1531 Value *CreateShuffleVector(Value *V1, Value *V2, ArrayRef<int> IntMask,
1532 const Twine &Name = "") {
1533 size_t MaskSize = IntMask.size();
1534 SmallVector<Constant*, 8> MaskVec(MaskSize);
1535 for (size_t i = 0; i != MaskSize; ++i)
1536 MaskVec[i] = getInt32(IntMask[i]);
1537 Value *Mask = ConstantVector::get(MaskVec);
1538 return CreateShuffleVector(V1, V2, Mask, Name);
1541 Value *CreateExtractValue(Value *Agg,
1542 ArrayRef<unsigned> Idxs,
1543 const Twine &Name = "") {
1544 if (Constant *AggC = dyn_cast<Constant>(Agg))
1545 return Insert(Folder.CreateExtractValue(AggC, Idxs), Name);
1546 return Insert(ExtractValueInst::Create(Agg, Idxs), Name);
1549 Value *CreateInsertValue(Value *Agg, Value *Val,
1550 ArrayRef<unsigned> Idxs,
1551 const Twine &Name = "") {
1552 if (Constant *AggC = dyn_cast<Constant>(Agg))
1553 if (Constant *ValC = dyn_cast<Constant>(Val))
1554 return Insert(Folder.CreateInsertValue(AggC, ValC, Idxs), Name);
1555 return Insert(InsertValueInst::Create(Agg, Val, Idxs), Name);
1558 LandingPadInst *CreateLandingPad(Type *Ty, unsigned NumClauses,
1559 const Twine &Name = "") {
1560 return Insert(LandingPadInst::Create(Ty, NumClauses), Name);
1563 //===--------------------------------------------------------------------===//
1564 // Utility creation methods
1565 //===--------------------------------------------------------------------===//
1567 /// \brief Return an i1 value testing if \p Arg is null.
1568 Value *CreateIsNull(Value *Arg, const Twine &Name = "") {
1569 return CreateICmpEQ(Arg, Constant::getNullValue(Arg->getType()),
1573 /// \brief Return an i1 value testing if \p Arg is not null.
1574 Value *CreateIsNotNull(Value *Arg, const Twine &Name = "") {
1575 return CreateICmpNE(Arg, Constant::getNullValue(Arg->getType()),
1579 /// \brief Return the i64 difference between two pointer values, dividing out
1580 /// the size of the pointed-to objects.
1582 /// This is intended to implement C-style pointer subtraction. As such, the
1583 /// pointers must be appropriately aligned for their element types and
1584 /// pointing into the same object.
1585 Value *CreatePtrDiff(Value *LHS, Value *RHS, const Twine &Name = "") {
1586 assert(LHS->getType() == RHS->getType() &&
1587 "Pointer subtraction operand types must match!");
1588 PointerType *ArgType = cast<PointerType>(LHS->getType());
1589 Value *LHS_int = CreatePtrToInt(LHS, Type::getInt64Ty(Context));
1590 Value *RHS_int = CreatePtrToInt(RHS, Type::getInt64Ty(Context));
1591 Value *Difference = CreateSub(LHS_int, RHS_int);
1592 return CreateExactSDiv(Difference,
1593 ConstantExpr::getSizeOf(ArgType->getElementType()),
1597 /// \brief Return a vector value that contains \arg V broadcasted to \p
1598 /// NumElts elements.
1599 Value *CreateVectorSplat(unsigned NumElts, Value *V, const Twine &Name = "") {
1600 assert(NumElts > 0 && "Cannot splat to an empty vector!");
1602 // First insert it into an undef vector so we can shuffle it.
1603 Type *I32Ty = getInt32Ty();
1604 Value *Undef = UndefValue::get(VectorType::get(V->getType(), NumElts));
1605 V = CreateInsertElement(Undef, V, ConstantInt::get(I32Ty, 0),
1606 Name + ".splatinsert");
1608 // Shuffle the value across the desired number of elements.
1609 Value *Zeros = ConstantAggregateZero::get(VectorType::get(I32Ty, NumElts));
1610 return CreateShuffleVector(V, Undef, Zeros, Name + ".splat");
1613 /// \brief Return a value that has been extracted from a larger integer type.
1614 Value *CreateExtractInteger(const DataLayout &DL, Value *From,
1615 IntegerType *ExtractedTy, uint64_t Offset,
1616 const Twine &Name) {
1617 IntegerType *IntTy = cast<IntegerType>(From->getType());
1618 assert(DL.getTypeStoreSize(ExtractedTy) + Offset <=
1619 DL.getTypeStoreSize(IntTy) &&
1620 "Element extends past full value");
1621 uint64_t ShAmt = 8 * Offset;
1623 if (DL.isBigEndian())
1624 ShAmt = 8 * (DL.getTypeStoreSize(IntTy) -
1625 DL.getTypeStoreSize(ExtractedTy) - Offset);
1627 V = CreateLShr(V, ShAmt, Name + ".shift");
1629 assert(ExtractedTy->getBitWidth() <= IntTy->getBitWidth() &&
1630 "Cannot extract to a larger integer!");
1631 if (ExtractedTy != IntTy) {
1632 V = CreateTrunc(V, ExtractedTy, Name + ".trunc");
1637 /// \brief Create an assume intrinsic call that represents an alignment
1638 /// assumption on the provided pointer.
1640 /// An optional offset can be provided, and if it is provided, the offset
1641 /// must be subtracted from the provided pointer to get the pointer with the
1642 /// specified alignment.
1643 CallInst *CreateAlignmentAssumption(const DataLayout &DL, Value *PtrValue,
1645 Value *OffsetValue = nullptr) {
1646 assert(isa<PointerType>(PtrValue->getType()) &&
1647 "trying to create an alignment assumption on a non-pointer?");
1649 PointerType *PtrTy = cast<PointerType>(PtrValue->getType());
1650 Type *IntPtrTy = getIntPtrTy(DL, PtrTy->getAddressSpace());
1651 Value *PtrIntValue = CreatePtrToInt(PtrValue, IntPtrTy, "ptrint");
1653 Value *Mask = ConstantInt::get(IntPtrTy,
1654 Alignment > 0 ? Alignment - 1 : 0);
1656 bool IsOffsetZero = false;
1657 if (ConstantInt *CI = dyn_cast<ConstantInt>(OffsetValue))
1658 IsOffsetZero = CI->isZero();
1660 if (!IsOffsetZero) {
1661 if (OffsetValue->getType() != IntPtrTy)
1662 OffsetValue = CreateIntCast(OffsetValue, IntPtrTy, /*isSigned*/ true,
1664 PtrIntValue = CreateSub(PtrIntValue, OffsetValue, "offsetptr");
1668 Value *Zero = ConstantInt::get(IntPtrTy, 0);
1669 Value *MaskedPtr = CreateAnd(PtrIntValue, Mask, "maskedptr");
1670 Value *InvCond = CreateICmpEQ(MaskedPtr, Zero, "maskcond");
1672 return CreateAssumption(InvCond);
1676 // Create wrappers for C Binding types (see CBindingWrapping.h).
1677 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef)