IRBuilder.h

Go to the documentation of this file.

//===- llvm/IRBuilder.h - Builder for LLVM Instructions ---------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines the IRBuilder class, which is used as a convenient way
// to create LLVM instructions with a consistent and simplified interface.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_IR_IRBUILDER_H
#define LLVM_IR_IRBUILDER_H
 
#include "llvm-c/Types.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/Twine.h"
#include "llvm/IR/BasicBlock.h"
#include "llvm/IR/Constant.h"
#include "llvm/IR/ConstantFolder.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/DebugLoc.h"
#include "llvm/IR/DerivedTypes.h"
#include "llvm/IR/FPEnv.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/InstrTypes.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/Intrinsics.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Operator.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Value.h"
#include "llvm/IR/ValueHandle.h"
#include "llvm/Support/AtomicOrdering.h"
#include "llvm/Support/CBindingWrapping.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Compiler.h"
#include <cassert>
#include <cstdint>
#include <functional>
#include <optional>
#include <utility>
 
namespace llvm {
 
class APInt;
class Use;
 
/// This provides the default implementation of the IRBuilder
/// 'InsertHelper' method that is called whenever an instruction is created by
/// IRBuilder and needs to be inserted.
///
/// By default, this inserts the instruction at the insertion point.
class IRBuilderDefaultInserter {
public:
  void InsertHelper(Instruction *I, const Twine &Name,
                    BasicBlock::iterator InsertPt) const {
    if (InsertPt.isValid())
      I->insertInto(InsertPt.getNodeParent(), InsertPt);
    I->setName(Name);
  }
};
 
/// Provides an 'InsertHelper' that calls a user-provided callback after
/// performing the default insertion.
class IRBuilderCallbackInserter : public IRBuilderDefaultInserter {
  std::function<void(Instruction *)> Callback;
 
public:
  IRBuilderCallbackInserter(std::function<void(Instruction *)> Callback)
      : Callback(std::move(Callback)) {}
 
  void InsertHelper(Instruction *I, const Twine &Name,
                    BasicBlock::iterator InsertPt) const {
    IRBuilderDefaultInserter::InsertHelper(I, Name, InsertPt);
    Callback(I);
  }
};
 
/// This provides a helper for copying FMF from an instruction or setting
/// specified flags.
class FMFSource {
  std::optional<FastMathFlags> FMF;
 
public:
  FMFSource() = default;
  FMFSource(Instruction *Source) {
    if (Source)
      FMF = Source->getFastMathFlags();
  }
  FMFSource(FastMathFlags FMF) : FMF(FMF) {}
  FastMathFlags get(FastMathFlags Default) const {
    return FMF.value_or(Default);
  }
  /// Intersect the FMF from two instructions.
  static FMFSource intersect(Value *A, Value *B) {
    return FMFSource(cast<FPMathOperator>(A)->getFastMathFlags() &
                     cast<FPMathOperator>(B)->getFastMathFlags());
  }
};
 
/// Common base class shared among various IRBuilders.
class IRBuilderBase {
  /// The DebugLoc that will be applied to instructions inserted by this
  /// builder.
  DebugLoc StoredDL;
 
protected:
  using InsertFn = void (*)(const IRBuilderBase &, Instruction *, const Twine &,
                            BasicBlock::iterator);
 
  BasicBlock::iterator InsertPt;
  LLVMContext &Context;
  const IRBuilderFolder &Folder;
  InsertFn InsertCB;
 
  MDNode *DefaultFPMathTag = nullptr;
  FastMathFlags FMF;
 
  bool IsFPConstrained = false;
  fp::ExceptionBehavior DefaultConstrainedExcept = fp::ebStrict;
  RoundingMode DefaultConstrainedRounding = RoundingMode::Dynamic;
 
  ArrayRef<OperandBundleDef> DefaultOperandBundles;
 
  IRBuilderBase(LLVMContext &context, const IRBuilderFolder &Folder,
                InsertFn InsertCB)
      : Context(context), Folder(Folder), InsertCB(InsertCB) {
    ClearInsertionPoint();
  }
 
public:
  // IRBuilderBase contains references to IRBuilder members and is not safe
  // to copy.
  IRBuilderBase(const IRBuilderBase &) = delete;
 
  /// Insert and return the specified instruction.
  template<typename InstTy>
  InstTy *Insert(InstTy *I, const Twine &Name = "") const {
    InsertCB(*this, I, Name, InsertPt);
    SetInstDebugLocation(I);
    return I;
  }
 
  /// No-op overload to handle constants.
  Constant *Insert(Constant *C, const Twine& = "") const {
    return C;
  }
 
  Value *Insert(Value *V, const Twine &Name = "") const {
    if (Instruction *I = dyn_cast<Instruction>(V))
      return Insert(I, Name);
    assert(isa<Constant>(V));
    return V;
  }
 
  //===--------------------------------------------------------------------===//
  // Builder configuration methods
  //===--------------------------------------------------------------------===//
 
  /// Clear the insertion point: created instructions will not be
  /// inserted into a block.
  void ClearInsertionPoint() { InsertPt = BasicBlock::iterator(); }
 
  BasicBlock *GetInsertBlock() const {
    return InsertPt.isValid() ? InsertPt.getNodeParent() : nullptr;
  }
  BasicBlock::iterator GetInsertPoint() const { return InsertPt; }
  LLVMContext &getContext() const { return Context; }
 
  /// Get data layout. Requires that an insertion point is set and connected
  /// to a module.
  const DataLayout &getDataLayout() const {
    assert(InsertPt.isValid() &&
           "Must have insertion point to get data layout");
    return InsertPt.getNodeParent()->getDataLayout();
  }
 
  /// Get the module. Requires that an insertion point is set and connected
  /// to a module.
  Module *getModule() const {
    assert(InsertPt.isValid() && "Must have insertion point to get module");
    return InsertPt.getNodeParent()->getModule();
  }
 
  /// This specifies that created instructions should be appended to the
  /// end of the specified block.
  void SetInsertPoint(BasicBlock *TheBB) { InsertPt = TheBB->end(); }
 
  /// This specifies that created instructions should be inserted before
  /// the specified instruction.
  void SetInsertPoint(Instruction *I) {
    InsertPt = I->getIterator();
    SetCurrentDebugLocation(I->getDebugLoc());
  }
 
  /// This specifies that created instructions should be inserted at the
  /// specified point.
  [[deprecated("Use the overload without BasicBlock argument instead")]]
  void SetInsertPoint(BasicBlock *TheBB, BasicBlock::iterator IP) {
    SetInsertPoint(IP);
  }
 
  /// This specifies that created instructions should be inserted at
  /// the specified point.
  void SetInsertPoint(BasicBlock::iterator IP) {
    InsertPt = IP;
    if (IP != IP.getNodeParent()->end())
      SetCurrentDebugLocation(IP->getDebugLoc());
  }
 
  /// This specifies that created instructions should inserted at the beginning
  /// end of the specified function, but after already existing static alloca
  /// instructions that are at the start.
  void SetInsertPointPastAllocas(Function *F) {
    InsertPt = F->getEntryBlock().getFirstNonPHIOrAlloca();
  }
 
  /// Set location information used by debugging information.
  void SetCurrentDebugLocation(const DebugLoc &L) {
    // For !dbg metadata attachments, we use DebugLoc instead of the raw MDNode
    // to include optional introspection data for use in Debugify.
    StoredDL = L;
  }
 
  /// Set location information used by debugging information.
  void SetCurrentDebugLocation(DebugLoc &&L) {
    // For !dbg metadata attachments, we use DebugLoc instead of the raw MDNode
    // to include optional introspection data for use in Debugify.
    StoredDL = std::move(L);
  }
 
  /// Get location information used by debugging information.
  LLVM_ABI DebugLoc getCurrentDebugLocation() const;
 
  /// If this builder has a current debug location, set it on the
  /// specified instruction.
  LLVM_ABI void SetInstDebugLocation(Instruction *I) const;
 
  /// Get the return type of the current function that we're emitting
  /// into.
  LLVM_ABI Type *getCurrentFunctionReturnType() const;
 
  /// InsertPoint - A saved insertion point.
  using InsertPoint = BasicBlock::iterator;
 
  /// Returns the current insert point.
  InsertPoint saveIP() const { return GetInsertPoint(); }
 
  /// Returns the current insert point, clearing it in the process.
  InsertPoint saveAndClearIP() {
    InsertPoint IP(GetInsertPoint());
    ClearInsertionPoint();
    return IP;
  }
 
  /// Sets the current insert point to a previously-saved location.
  void restoreIP(InsertPoint IP) {
    if (IP.isValid())
      SetInsertPoint(IP);
    else
      ClearInsertionPoint();
  }
 
  /// Get the floating point math metadata being used.
  MDNode *getDefaultFPMathTag() const { return DefaultFPMathTag; }
 
  /// Get the flags to be applied to created floating point ops
  FastMathFlags getFastMathFlags() const { return FMF; }
 
  FastMathFlags &getFastMathFlags() { return FMF; }
 
  /// Clear the fast-math flags.
  void clearFastMathFlags() { FMF.clear(); }
 
  /// Set the floating point math metadata to be used.
  void setDefaultFPMathTag(MDNode *FPMathTag) { DefaultFPMathTag = FPMathTag; }
 
  /// Set the fast-math flags to be used with generated fp-math operators
  void setFastMathFlags(FastMathFlags NewFMF) { FMF = NewFMF; }
 
  /// Enable/Disable use of constrained floating point math. When
  /// enabled the CreateF<op>() calls instead create constrained
  /// floating point intrinsic calls. Fast math flags are unaffected
  /// by this setting.
  void setIsFPConstrained(bool IsCon) { IsFPConstrained = IsCon; }
 
  /// Query for the use of constrained floating point math
  bool getIsFPConstrained() { return IsFPConstrained; }
 
  /// Set the exception handling to be used with constrained floating point
  void setDefaultConstrainedExcept(fp::ExceptionBehavior NewExcept) {
#ifndef NDEBUG
    std::optional<StringRef> ExceptStr =
        convertExceptionBehaviorToStr(NewExcept);
    assert(ExceptStr && "Garbage strict exception behavior!");
#endif
    DefaultConstrainedExcept = NewExcept;
  }
 
  /// Set the rounding mode handling to be used with constrained floating point
  void setDefaultConstrainedRounding(RoundingMode NewRounding) {
#ifndef NDEBUG
    std::optional<StringRef> RoundingStr =
        convertRoundingModeToStr(NewRounding);
    assert(RoundingStr && "Garbage strict rounding mode!");
#endif
    DefaultConstrainedRounding = NewRounding;
  }
 
  /// Get the exception handling used with constrained floating point
  fp::ExceptionBehavior getDefaultConstrainedExcept() {
    return DefaultConstrainedExcept;
  }
 
  /// Get the rounding mode handling used with constrained floating point
  RoundingMode getDefaultConstrainedRounding() {
    return DefaultConstrainedRounding;
  }
 
  void setConstrainedFPFunctionAttr() {
    BasicBlock *BB = GetInsertBlock();
    assert(BB && "Must have a basic block to set any function attributes!");
 
    Function *F = BB->getParent();
    if (!F->hasFnAttribute(Attribute::StrictFP)) {
      F->addFnAttr(Attribute::StrictFP);
    }
  }
 
  void setConstrainedFPCallAttr(CallBase *I) {
    I->addFnAttr(Attribute::StrictFP);
  }
 
  void setDefaultOperandBundles(ArrayRef<OperandBundleDef> OpBundles) {
    DefaultOperandBundles = OpBundles;
  }
 
  //===--------------------------------------------------------------------===//
  // RAII helpers.
  //===--------------------------------------------------------------------===//
 
  // RAII object that stores the current insertion point and restores it
  // when the object is destroyed. This includes the debug location.
  class InsertPointGuard {
    IRBuilderBase &Builder;
    BasicBlock::iterator Point;
    DebugLoc DbgLoc;
 
  public:
    InsertPointGuard(IRBuilderBase &B)
        : Builder(B), Point(B.GetInsertPoint()),
          DbgLoc(B.getCurrentDebugLocation()) {}
 
    InsertPointGuard(const InsertPointGuard &) = delete;
    InsertPointGuard &operator=(const InsertPointGuard &) = delete;
 
    ~InsertPointGuard() {
      Builder.restoreIP(Point);
      Builder.SetCurrentDebugLocation(DbgLoc);
    }
  };
 
  // RAII object that stores the current fast math settings and restores
  // them when the object is destroyed.
  class FastMathFlagGuard {
    IRBuilderBase &Builder;
    FastMathFlags FMF;
    MDNode *FPMathTag;
    bool IsFPConstrained;
    fp::ExceptionBehavior DefaultConstrainedExcept;
    RoundingMode DefaultConstrainedRounding;
 
  public:
    FastMathFlagGuard(IRBuilderBase &B)
        : Builder(B), FMF(B.FMF), FPMathTag(B.DefaultFPMathTag),
          IsFPConstrained(B.IsFPConstrained),
          DefaultConstrainedExcept(B.DefaultConstrainedExcept),
          DefaultConstrainedRounding(B.DefaultConstrainedRounding) {}
 
    FastMathFlagGuard(const FastMathFlagGuard &) = delete;
    FastMathFlagGuard &operator=(const FastMathFlagGuard &) = delete;
 
    ~FastMathFlagGuard() {
      Builder.FMF = FMF;
      Builder.DefaultFPMathTag = FPMathTag;
      Builder.IsFPConstrained = IsFPConstrained;
      Builder.DefaultConstrainedExcept = DefaultConstrainedExcept;
      Builder.DefaultConstrainedRounding = DefaultConstrainedRounding;
    }
  };
 
  // RAII object that stores the current default operand bundles and restores
  // them when the object is destroyed.
  class OperandBundlesGuard {
    IRBuilderBase &Builder;
    ArrayRef<OperandBundleDef> DefaultOperandBundles;
 
  public:
    OperandBundlesGuard(IRBuilderBase &B)
        : Builder(B), DefaultOperandBundles(B.DefaultOperandBundles) {}
 
    OperandBundlesGuard(const OperandBundlesGuard &) = delete;
    OperandBundlesGuard &operator=(const OperandBundlesGuard &) = delete;
 
    ~OperandBundlesGuard() {
      Builder.DefaultOperandBundles = DefaultOperandBundles;
    }
  };
 
 
  //===--------------------------------------------------------------------===//
  // Miscellaneous creation methods.
  //===--------------------------------------------------------------------===//
 
  /// Make a new global variable with initializer type i8*
  ///
  /// Make a new global variable with an initializer that has array of i8 type
  /// filled in with the null terminated string value specified.  The new global
  /// variable will be marked mergable with any others of the same contents.  If
  /// Name is specified, it is the name of the global variable created.
  ///
  /// If no module is given via \p M, it is take from the insertion point basic
  /// block.
  LLVM_ABI GlobalVariable *CreateGlobalString(StringRef Str,
                                              const Twine &Name = "",
                                              unsigned AddressSpace = 0,
                                              Module *M = nullptr,
                                              bool AddNull = true);
 
  /// Get a constant value representing either true or false.
  ConstantInt *getInt1(bool V) {
    return ConstantInt::get(getInt1Ty(), V);
  }
 
  /// Get the constant value for i1 true.
  ConstantInt *getTrue() {
    return ConstantInt::getTrue(Context);
  }
 
  /// Get the constant value for i1 false.
  ConstantInt *getFalse() {
    return ConstantInt::getFalse(Context);
  }
 
  /// Get a constant 8-bit value.
  ConstantInt *getInt8(uint8_t C) {
    return ConstantInt::get(getInt8Ty(), C);
  }
 
  /// Get a constant 16-bit value.
  ConstantInt *getInt16(uint16_t C) {
    return ConstantInt::get(getInt16Ty(), C);
  }
 
  /// Get a constant 32-bit value.
  ConstantInt *getInt32(uint32_t C) {
    return ConstantInt::get(getInt32Ty(), C);
  }
 
  /// Get a constant 64-bit value.
  ConstantInt *getInt64(uint64_t C) {
    return ConstantInt::get(getInt64Ty(), C);
  }
 
  /// Get a constant N-bit value, zero extended from a 64-bit value.
  ConstantInt *getIntN(unsigned N, uint64_t C) {
    return ConstantInt::get(getIntNTy(N), C);
  }
 
  /// Get a constant integer value.
  ConstantInt *getInt(const APInt &AI) {
    return ConstantInt::get(Context, AI);
  }
 
  //===--------------------------------------------------------------------===//
  // Type creation methods
  //===--------------------------------------------------------------------===//
 
  /// Fetch the type representing an 8-bit byte.
  ByteType *getByte8Ty() { return Type::getByte8Ty(Context); }
 
  /// Fetch the type representing a 16-bit byte.
  ByteType *getByte16Ty() { return Type::getByte16Ty(Context); }
 
  /// Fetch the type representing a 32-bit byte.
  ByteType *getByte32Ty() { return Type::getByte32Ty(Context); }
 
  /// Fetch the type representing a 64-bit byte.
  ByteType *getByte64Ty() { return Type::getByte64Ty(Context); }
 
  /// Fetch the type representing a 128-bit byte.
  ByteType *getByte128Ty() { return Type::getByte128Ty(Context); }
 
  /// Fetch the type representing an N-bit byte.
  ByteType *getByteNTy(unsigned N) { return Type::getByteNTy(Context, N); }
 
  /// Fetch the type representing a single bit
  IntegerType *getInt1Ty() {
    return Type::getInt1Ty(Context);
  }
 
  /// Fetch the type representing an 8-bit integer.
  IntegerType *getInt8Ty() {
    return Type::getInt8Ty(Context);
  }
 
  /// Fetch the type representing a 16-bit integer.
  IntegerType *getInt16Ty() {
    return Type::getInt16Ty(Context);
  }
 
  /// Fetch the type representing a 32-bit integer.
  IntegerType *getInt32Ty() {
    return Type::getInt32Ty(Context);
  }
 
  /// Fetch the type representing a 64-bit integer.
  IntegerType *getInt64Ty() {
    return Type::getInt64Ty(Context);
  }
 
  /// Fetch the type representing a 128-bit integer.
  IntegerType *getInt128Ty() { return Type::getInt128Ty(Context); }
 
  /// Fetch the type representing an N-bit integer.
  IntegerType *getIntNTy(unsigned N) {
    return Type::getIntNTy(Context, N);
  }
 
  /// Fetch the type representing a 16-bit floating point value.
  Type *getHalfTy() {
    return Type::getHalfTy(Context);
  }
 
  /// Fetch the type representing a 16-bit brain floating point value.
  Type *getBFloatTy() {
    return Type::getBFloatTy(Context);
  }
 
  /// Fetch the type representing a 32-bit floating point value.
  Type *getFloatTy() {
    return Type::getFloatTy(Context);
  }
 
  /// Fetch the type representing a 64-bit floating point value.
  Type *getDoubleTy() {
    return Type::getDoubleTy(Context);
  }
 
  /// Fetch the type representing void.
  Type *getVoidTy() {
    return Type::getVoidTy(Context);
  }
 
  /// Fetch the type representing a pointer.
  PointerType *getPtrTy(unsigned AddrSpace = 0) {
    return PointerType::get(Context, AddrSpace);
  }
 
  /// Fetch the type of a byte with size at least as big as that of a
  /// pointer in the given address space.
  ByteType *getBytePtrTy(const DataLayout &DL, unsigned AddrSpace = 0) {
    return DL.getBytePtrType(Context, AddrSpace);
  }
 
  /// Fetch the type of an integer with size at least as big as that of a
  /// pointer in the given address space.
  IntegerType *getIntPtrTy(const DataLayout &DL, unsigned AddrSpace = 0) {
    return DL.getIntPtrType(Context, AddrSpace);
  }
 
  /// Fetch the type of an integer that should be used to index GEP operations
  /// within AddressSpace.
  IntegerType *getIndexTy(const DataLayout &DL, unsigned AddrSpace) {
    return DL.getIndexType(Context, AddrSpace);
  }
 
  //===--------------------------------------------------------------------===//
  // Intrinsic creation methods
  //===--------------------------------------------------------------------===//
 
  /// Create and insert a memset to the specified pointer and the
  /// specified value.
  ///
  /// If the pointer isn't an i8*, it will be converted. If alias metadata is
  /// specified, it will be added to the instruction.
  CallInst *CreateMemSet(Value *Ptr, Value *Val, uint64_t Size,
                         MaybeAlign Align, bool isVolatile = false,
                         const AAMDNodes &AAInfo = AAMDNodes()) {
    return CreateMemSet(Ptr, Val, getInt64(Size), Align, isVolatile, AAInfo);
  }
 
  LLVM_ABI CallInst *CreateMemSet(Value *Ptr, Value *Val, Value *Size,
                                  MaybeAlign Align, bool isVolatile = false,
                                  const AAMDNodes &AAInfo = AAMDNodes());
 
  LLVM_ABI CallInst *CreateMemSetInline(Value *Dst, MaybeAlign DstAlign,
                                        Value *Val, Value *Size,
                                        bool IsVolatile = false,
                                        const AAMDNodes &AAInfo = AAMDNodes());
 
  /// Create and insert an element unordered-atomic memset of the region of
  /// memory starting at the given pointer to the given value.
  ///
  /// If the pointer isn't an i8*, it will be converted. If alias metadata is
  /// specified, it will be added to the instruction.
  CallInst *
  CreateElementUnorderedAtomicMemSet(Value *Ptr, Value *Val, uint64_t Size,
                                     Align Alignment, uint32_t ElementSize,
                                     const AAMDNodes &AAInfo = AAMDNodes()) {
    return CreateElementUnorderedAtomicMemSet(
        Ptr, Val, getInt64(Size), Align(Alignment), ElementSize, AAInfo);
  }
 
  LLVM_ABI CallInst *CreateMalloc(Type *IntPtrTy, Value *AllocSize,
                                  Value *ArraySize,
                                  ArrayRef<OperandBundleDef> OpB,
                                  Function *MallocF = nullptr,
                                  const Twine &Name = "");
 
  /// CreateMalloc - Generate the IR for a call to malloc:
  /// 1. Compute the malloc call's argument as AllocSize, possibly multiplied
  ///    by the array size if the array size is not constant 1.
  /// 2. Call malloc with that argument.
  LLVM_ABI CallInst *CreateMalloc(Type *IntPtrTy, Value *AllocSize,
                                  Value *ArraySize, Function *MallocF = nullptr,
                                  const Twine &Name = "");
  /// Generate the IR for a call to the builtin free function.
  LLVM_ABI CallInst *CreateFree(Value *Source,
                                ArrayRef<OperandBundleDef> Bundles = {});
 
  LLVM_ABI CallInst *
  CreateElementUnorderedAtomicMemSet(Value *Ptr, Value *Val, Value *Size,
                                     Align Alignment, uint32_t ElementSize,
                                     const AAMDNodes &AAInfo = AAMDNodes());
 
  /// Create and insert a memcpy between the specified pointers.
  ///
  /// If the pointers aren't i8*, they will be converted.  If alias metadata is
  /// specified, it will be added to the instruction.
  /// and noalias tags.
  CallInst *CreateMemCpy(Value *Dst, MaybeAlign DstAlign, Value *Src,
                         MaybeAlign SrcAlign, uint64_t Size,
                         bool isVolatile = false,
                         const AAMDNodes &AAInfo = AAMDNodes()) {
    return CreateMemCpy(Dst, DstAlign, Src, SrcAlign, getInt64(Size),
                        isVolatile, AAInfo);
  }
 
  LLVM_ABI CallInst *
  CreateMemTransferInst(Intrinsic::ID IntrID, Value *Dst, MaybeAlign DstAlign,
                        Value *Src, MaybeAlign SrcAlign, Value *Size,
                        bool isVolatile = false,
                        const AAMDNodes &AAInfo = AAMDNodes());
 
  CallInst *CreateMemCpy(Value *Dst, MaybeAlign DstAlign, Value *Src,
                         MaybeAlign SrcAlign, Value *Size,
                         bool isVolatile = false,
                         const AAMDNodes &AAInfo = AAMDNodes()) {
    return CreateMemTransferInst(Intrinsic::memcpy, Dst, DstAlign, Src,
                                 SrcAlign, Size, isVolatile, AAInfo);
  }
 
  CallInst *CreateMemCpyInline(Value *Dst, MaybeAlign DstAlign, Value *Src,
                               MaybeAlign SrcAlign, Value *Size,
                               bool isVolatile = false,
                               const AAMDNodes &AAInfo = AAMDNodes()) {
    return CreateMemTransferInst(Intrinsic::memcpy_inline, Dst, DstAlign, Src,
                                 SrcAlign, Size, isVolatile, AAInfo);
  }
 
  /// Create and insert an element unordered-atomic memcpy between the
  /// specified pointers.
  ///
  /// DstAlign/SrcAlign are the alignments of the Dst/Src pointers,
  /// respectively.
  ///
  /// If the pointers aren't i8*, they will be converted.  If alias metadata is
  /// specified, it will be added to the instruction.
  LLVM_ABI CallInst *CreateElementUnorderedAtomicMemCpy(
      Value *Dst, Align DstAlign, Value *Src, Align SrcAlign, Value *Size,
      uint32_t ElementSize, const AAMDNodes &AAInfo = AAMDNodes());
 
  CallInst *CreateMemMove(Value *Dst, MaybeAlign DstAlign, Value *Src,
                          MaybeAlign SrcAlign, uint64_t Size,
                          bool isVolatile = false,
                          const AAMDNodes &AAInfo = AAMDNodes()) {
    return CreateMemMove(Dst, DstAlign, Src, SrcAlign, getInt64(Size),
                         isVolatile, AAInfo);
  }
 
  CallInst *CreateMemMove(Value *Dst, MaybeAlign DstAlign, Value *Src,
                          MaybeAlign SrcAlign, Value *Size,
                          bool isVolatile = false,
                          const AAMDNodes &AAInfo = AAMDNodes()) {
    return CreateMemTransferInst(Intrinsic::memmove, Dst, DstAlign, Src,
                                 SrcAlign, Size, isVolatile, AAInfo);
  }
 
  /// \brief Create and insert an element unordered-atomic memmove between the
  /// specified pointers.
  ///
  /// DstAlign/SrcAlign are the alignments of the Dst/Src pointers,
  /// respectively.
  ///
  /// If the pointers aren't i8*, they will be converted.  If alias metadata is
  /// specified, it will be added to the instruction.
  LLVM_ABI CallInst *CreateElementUnorderedAtomicMemMove(
      Value *Dst, Align DstAlign, Value *Src, Align SrcAlign, Value *Size,
      uint32_t ElementSize, const AAMDNodes &AAInfo = AAMDNodes());
 
private:
  Value *getReductionIntrinsic(Intrinsic::ID ID, Value *Src);
 
public:
  /// Create a sequential vector fadd reduction intrinsic of the source vector.
  /// The first parameter is a scalar accumulator value. An unordered reduction
  /// can be created by adding the reassoc fast-math flag to the resulting
  /// sequential reduction.
  LLVM_ABI Value *CreateFAddReduce(Value *Acc, Value *Src);
 
  /// Create a sequential vector fmul reduction intrinsic of the source vector.
  /// The first parameter is a scalar accumulator value. An unordered reduction
  /// can be created by adding the reassoc fast-math flag to the resulting
  /// sequential reduction.
  LLVM_ABI Value *CreateFMulReduce(Value *Acc, Value *Src);
 
  /// Create a vector int add reduction intrinsic of the source vector.
  LLVM_ABI Value *CreateAddReduce(Value *Src);
 
  /// Create a vector int mul reduction intrinsic of the source vector.
  LLVM_ABI Value *CreateMulReduce(Value *Src);
 
  /// Create a vector int AND reduction intrinsic of the source vector.
  LLVM_ABI Value *CreateAndReduce(Value *Src);
 
  /// Create a vector int OR reduction intrinsic of the source vector.
  LLVM_ABI Value *CreateOrReduce(Value *Src);
 
  /// Create a vector int XOR reduction intrinsic of the source vector.
  LLVM_ABI Value *CreateXorReduce(Value *Src);
 
  /// Create a vector integer max reduction intrinsic of the source
  /// vector.
  LLVM_ABI Value *CreateIntMaxReduce(Value *Src, bool IsSigned = false);
 
  /// Create a vector integer min reduction intrinsic of the source
  /// vector.
  LLVM_ABI Value *CreateIntMinReduce(Value *Src, bool IsSigned = false);
 
  /// Create a vector float max reduction intrinsic of the source
  /// vector.
  LLVM_ABI Value *CreateFPMaxReduce(Value *Src);
 
  /// Create a vector float min reduction intrinsic of the source
  /// vector.
  LLVM_ABI Value *CreateFPMinReduce(Value *Src);
 
  /// Create a vector float maximum reduction intrinsic of the source
  /// vector. This variant follows the NaN and signed zero semantic of
  /// llvm.maximum intrinsic.
  LLVM_ABI Value *CreateFPMaximumReduce(Value *Src);
 
  /// Create a vector float minimum reduction intrinsic of the source
  /// vector. This variant follows the NaN and signed zero semantic of
  /// llvm.minimum intrinsic.
  LLVM_ABI Value *CreateFPMinimumReduce(Value *Src);
 
  /// Create a vector float maximum reduction intrinsic of the source
  /// vector. This variant follows the NaN and signed zero semantic of
  /// llvm.maximumnum intrinsic.
  LLVM_ABI Value *CreateFPMaximumNumReduce(Value *Src);
 
  /// Create a vector float minimum reduction intrinsic of the source
  /// vector. This variant follows the NaN and signed zero semantic of
  /// llvm.minimumnum intrinsic.
  LLVM_ABI Value *CreateFPMinimumNumReduce(Value *Src);
 
  /// Create a lifetime.start intrinsic.
  LLVM_ABI CallInst *CreateLifetimeStart(Value *Ptr);
 
  /// Create a lifetime.end intrinsic.
  LLVM_ABI CallInst *CreateLifetimeEnd(Value *Ptr);
 
  /// Create a call to invariant.start intrinsic.
  ///
  /// If the pointer isn't i8* it will be converted.
  LLVM_ABI CallInst *CreateInvariantStart(Value *Ptr,
                                          ConstantInt *Size = nullptr);
 
  /// Create a call to llvm.threadlocal.address intrinsic.
  LLVM_ABI CallInst *CreateThreadLocalAddress(Value *Ptr);
 
  /// Create a call to Masked Load intrinsic
  LLVM_ABI CallInst *CreateMaskedLoad(Type *Ty, Value *Ptr, Align Alignment,
                                      Value *Mask, Value *PassThru = nullptr,
                                      const Twine &Name = "");
 
  /// Create a call to Masked Store intrinsic
  LLVM_ABI CallInst *CreateMaskedStore(Value *Val, Value *Ptr, Align Alignment,
                                       Value *Mask);
 
  /// Create a call to Masked Gather intrinsic
  LLVM_ABI CallInst *CreateMaskedGather(Type *Ty, Value *Ptrs, Align Alignment,
                                        Value *Mask = nullptr,
                                        Value *PassThru = nullptr,
                                        const Twine &Name = "");
 
  /// Create a call to Masked Scatter intrinsic
  LLVM_ABI CallInst *CreateMaskedScatter(Value *Val, Value *Ptrs,
                                         Align Alignment,
                                         Value *Mask = nullptr);
 
  /// Create a call to Masked Expand Load intrinsic
  LLVM_ABI CallInst *CreateMaskedExpandLoad(Type *Ty, Value *Ptr,
                                            MaybeAlign Align,
                                            Value *Mask = nullptr,
                                            Value *PassThru = nullptr,
                                            const Twine &Name = "");
 
  /// Create a call to Masked Compress Store intrinsic
  LLVM_ABI CallInst *CreateMaskedCompressStore(Value *Val, Value *Ptr,
                                               MaybeAlign Align,
                                               Value *Mask = nullptr);
 
  /// Return an all true boolean vector (mask) with \p NumElts lanes.
  Value *getAllOnesMask(ElementCount NumElts) {
    VectorType *VTy = VectorType::get(Type::getInt1Ty(Context), NumElts);
    return Constant::getAllOnesValue(VTy);
  }
 
  /// Create an assume intrinsic call that allows the optimizer to
  /// assume that the provided condition will be true.
  LLVM_ABI CallInst *CreateAssumption(Value *Cond);
 
  /// Create an assume intrinsic call that allows the optimizer to
  /// assume that the provided operand bundles hold.
  LLVM_ABI CallInst *CreateAssumption(ArrayRef<OperandBundleDef> OpBundles);
 
  /// Create a llvm.experimental.noalias.scope.decl intrinsic call.
  LLVM_ABI Instruction *CreateNoAliasScopeDeclaration(Value *Scope);
  Instruction *CreateNoAliasScopeDeclaration(MDNode *ScopeTag) {
    return CreateNoAliasScopeDeclaration(
        MetadataAsValue::get(Context, ScopeTag));
  }
 
  /// Create a call to the experimental.gc.statepoint intrinsic to
  /// start a new statepoint sequence.
  LLVM_ABI CallInst *CreateGCStatepointCall(
      uint64_t ID, uint32_t NumPatchBytes, FunctionCallee ActualCallee,
      ArrayRef<Value *> CallArgs, std::optional<ArrayRef<Value *>> DeoptArgs,
      ArrayRef<Value *> GCArgs, const Twine &Name = "");
 
  /// Create a call to the experimental.gc.statepoint intrinsic to
  /// start a new statepoint sequence.
  LLVM_ABI CallInst *
  CreateGCStatepointCall(uint64_t ID, uint32_t NumPatchBytes,
                         FunctionCallee ActualCallee, uint32_t Flags,
                         ArrayRef<Value *> CallArgs,
                         std::optional<ArrayRef<Use>> TransitionArgs,
                         std::optional<ArrayRef<Use>> DeoptArgs,
                         ArrayRef<Value *> GCArgs, const Twine &Name = "");
 
  /// Conveninence function for the common case when CallArgs are filled
  /// in using ArrayRef(CS.arg_begin(), CS.arg_end()); Use needs to be
  /// .get()'ed to get the Value pointer.
  LLVM_ABI CallInst *
  CreateGCStatepointCall(uint64_t ID, uint32_t NumPatchBytes,
                         FunctionCallee ActualCallee, ArrayRef<Use> CallArgs,
                         std::optional<ArrayRef<Value *>> DeoptArgs,
                         ArrayRef<Value *> GCArgs, const Twine &Name = "");
 
  /// Create an invoke to the experimental.gc.statepoint intrinsic to
  /// start a new statepoint sequence.
  LLVM_ABI InvokeInst *
  CreateGCStatepointInvoke(uint64_t ID, uint32_t NumPatchBytes,
                           FunctionCallee ActualInvokee, BasicBlock *NormalDest,
                           BasicBlock *UnwindDest, ArrayRef<Value *> InvokeArgs,
                           std::optional<ArrayRef<Value *>> DeoptArgs,
                           ArrayRef<Value *> GCArgs, const Twine &Name = "");
 
  /// Create an invoke to the experimental.gc.statepoint intrinsic to
  /// start a new statepoint sequence.
  LLVM_ABI InvokeInst *CreateGCStatepointInvoke(
      uint64_t ID, uint32_t NumPatchBytes, FunctionCallee ActualInvokee,
      BasicBlock *NormalDest, BasicBlock *UnwindDest, uint32_t Flags,
      ArrayRef<Value *> InvokeArgs, std::optional<ArrayRef<Use>> TransitionArgs,
      std::optional<ArrayRef<Use>> DeoptArgs, ArrayRef<Value *> GCArgs,
      const Twine &Name = "");
 
  // Convenience function for the common case when CallArgs are filled in using
  // ArrayRef(CS.arg_begin(), CS.arg_end()); Use needs to be .get()'ed to
  // get the Value *.
  LLVM_ABI InvokeInst *
  CreateGCStatepointInvoke(uint64_t ID, uint32_t NumPatchBytes,
                           FunctionCallee ActualInvokee, BasicBlock *NormalDest,
                           BasicBlock *UnwindDest, ArrayRef<Use> InvokeArgs,
                           std::optional<ArrayRef<Value *>> DeoptArgs,
                           ArrayRef<Value *> GCArgs, const Twine &Name = "");
 
  /// Create a call to the experimental.gc.result intrinsic to extract
  /// the result from a call wrapped in a statepoint.
  LLVM_ABI CallInst *CreateGCResult(Instruction *Statepoint, Type *ResultType,
                                    const Twine &Name = "");
 
  /// Create a call to the experimental.gc.relocate intrinsics to
  /// project the relocated value of one pointer from the statepoint.
  LLVM_ABI CallInst *CreateGCRelocate(Instruction *Statepoint, int BaseOffset,
                                      int DerivedOffset, Type *ResultType,
                                      const Twine &Name = "");
 
  /// Create a call to the experimental.gc.pointer.base intrinsic to get the
  /// base pointer for the specified derived pointer.
  LLVM_ABI CallInst *CreateGCGetPointerBase(Value *DerivedPtr,
                                            const Twine &Name = "");
 
  /// Create a call to the experimental.gc.get.pointer.offset intrinsic to get
  /// the offset of the specified derived pointer from its base.
  LLVM_ABI CallInst *CreateGCGetPointerOffset(Value *DerivedPtr,
                                              const Twine &Name = "");
 
  /// Create a call to llvm.vscale.<Ty>().
  Value *CreateVScale(Type *Ty, const Twine &Name = "") {
    return CreateIntrinsic(Intrinsic::vscale, {Ty}, {}, {}, Name);
  }
 
  /// Create an expression which evaluates to the number of elements in \p EC
  /// at runtime. This can result in poison if type \p Ty is not big enough to
  /// hold the value.
  LLVM_ABI Value *CreateElementCount(Type *Ty, ElementCount EC);
 
  /// Create an expression which evaluates to the number of units in \p Size
  /// at runtime. This works for both units of bits and bytes. This can result
  /// in poison if type \p Ty is not big enough to hold the value.
  LLVM_ABI Value *CreateTypeSize(Type *Ty, TypeSize Size);
 
  /// Get allocation size of an alloca as a runtime Value* (handles both static
  /// and dynamic allocas and vscale factor).
  LLVM_ABI Value *CreateAllocationSize(Type *DestTy, AllocaInst *AI);
 
  /// Creates a vector of type \p DstType with the linear sequence <0, 1, ...>
  LLVM_ABI Value *CreateStepVector(Type *DstType, const Twine &Name = "");
 
  /// Create a call to intrinsic \p ID with 1 operand which is mangled on its
  /// type.
  LLVM_ABI Value *CreateUnaryIntrinsic(Intrinsic::ID ID, Value *Op,
                                       FMFSource FMFSource = {},
                                       const Twine &Name = "");
 
  /// Create a call to intrinsic \p ID with 2 operands which is mangled on the
  /// first type.
  LLVM_ABI Value *CreateBinaryIntrinsic(Intrinsic::ID ID, Value *LHS,
                                        Value *RHS, FMFSource FMFSource = {},
                                        const Twine &Name = "");
 
  /// Create a call to intrinsic \p ID with \p Args, mangled using
  /// \p OverloadTypes. If \p FMFSource is provided, copy fast-math-flags from
  /// that instruction to the intrinsic. It is guaranteed not to fold.
  LLVM_ABI CallInst *CreateIntrinsicWithoutFolding(
      Intrinsic::ID ID, ArrayRef<Type *> OverloadTypes, ArrayRef<Value *> Args,
      FMFSource FMFSource = {}, const Twine &Name = "",
      ArrayRef<OperandBundleDef> OpBundles = {});
 
  /// Create a call to intrinsic \p ID with \p RetTy and \p Args. If
  /// \p FMFSource is provided, copy fast-math-flags from that instruction to
  /// the intrinsic. It is guaranteed not to fold.
  LLVM_ABI CallInst *CreateIntrinsicWithoutFolding(Type *RetTy,
                                                   Intrinsic::ID ID,
                                                   ArrayRef<Value *> Args,
                                                   FMFSource FMFSource = {},
                                                   const Twine &Name = "");
 
  /// Create a call to non-overloaded intrinsic \p ID with \p Args. If
  /// \p FMFSource is provided, copy fast-math-flags from that instruction to
  /// the intrinsic. It is guranteed not to fold.
  CallInst *CreateIntrinsicWithoutFolding(Intrinsic::ID ID,
                                          ArrayRef<Value *> Args,
                                          FMFSource FMFSource = {},
                                          const Twine &Name = "") {
    return CreateIntrinsicWithoutFolding(ID, /*Types=*/{}, Args, FMFSource,
                                         Name);
  }
 
  /// Variant to create a possibly constant-folded intrinsic. An optional \p
  /// SetFn is called if the intrinsic doesn't fold, and can be used to set
  /// things like attributes.
  LLVM_ABI Value *CreateIntrinsic(
      Intrinsic::ID ID, ArrayRef<Type *> OverloadTypes, ArrayRef<Value *> Args,
      FMFSource FMFSource = {}, const Twine &Name = "",
      ArrayRef<OperandBundleDef> OpBundles = {},
      function_ref<void(CallInst *)> SetFn = [](CallInst *) {});
 
  /// Variant to create a possibly constant-folded intrinsic. An optional \p
  /// SetFn is called if the intrinsic doesn't fold, and can be used to set
  /// things like attributes.
  LLVM_ABI Value *CreateIntrinsic(
      Type *RetTy, Intrinsic::ID ID, ArrayRef<Value *> Args,
      FMFSource FMFSource = {}, const Twine &Name = "",
      function_ref<void(CallInst *)> SetFn = [](CallInst *) {});
 
  /// Variant to create a possibly constant-folded intrinsic. An optional \p
  /// SetFn is called if the intrinsic doesn't fold, and can be used to set
  /// things like attributes.
  Value *CreateIntrinsic(
      Intrinsic::ID ID, ArrayRef<Value *> Args, FMFSource FMFSource = {},
      const Twine &Name = "",
      function_ref<void(CallInst *)> SetFn = [](CallInst *) {}) {
    return CreateIntrinsic(ID, /*Types=*/{}, Args, FMFSource, Name, {}, SetFn);
  }
 
  /// Create call to the fabs intrinsic.
  Value *CreateFAbs(Value *V, FMFSource FMFSource = {},
                    const Twine &Name = "") {
    return CreateUnaryIntrinsic(Intrinsic::fabs, V, FMFSource, Name);
  }
 
  /// Create call to the minnum intrinsic.
  Value *CreateMinNum(Value *LHS, Value *RHS, FMFSource FMFSource = {},
                      const Twine &Name = "") {
    if (IsFPConstrained) {
      return CreateConstrainedFPUnroundedBinOp(
          Intrinsic::experimental_constrained_minnum, LHS, RHS, FMFSource,
          Name);
    }
 
    return CreateBinaryIntrinsic(Intrinsic::minnum, LHS, RHS, FMFSource, Name);
  }
 
  /// Create call to the maxnum intrinsic.
  Value *CreateMaxNum(Value *LHS, Value *RHS, FMFSource FMFSource = {},
                      const Twine &Name = "") {
    if (IsFPConstrained) {
      return CreateConstrainedFPUnroundedBinOp(
          Intrinsic::experimental_constrained_maxnum, LHS, RHS, FMFSource,
          Name);
    }
 
    return CreateBinaryIntrinsic(Intrinsic::maxnum, LHS, RHS, FMFSource, Name);
  }
 
  /// Create call to the minimum intrinsic.
  Value *CreateMinimum(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateBinaryIntrinsic(Intrinsic::minimum, LHS, RHS, nullptr, Name);
  }
 
  /// Create call to the maximum intrinsic.
  Value *CreateMaximum(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateBinaryIntrinsic(Intrinsic::maximum, LHS, RHS, nullptr, Name);
  }
 
  /// Create call to the minimumnum intrinsic.
  Value *CreateMinimumNum(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateBinaryIntrinsic(Intrinsic::minimumnum, LHS, RHS, nullptr,
                                 Name);
  }
 
  /// Create call to the maximum intrinsic.
  Value *CreateMaximumNum(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateBinaryIntrinsic(Intrinsic::maximumnum, LHS, RHS, nullptr,
                                 Name);
  }
 
  /// Create call to the copysign intrinsic.
  Value *CreateCopySign(Value *LHS, Value *RHS, FMFSource FMFSource = {},
                        const Twine &Name = "") {
    return CreateBinaryIntrinsic(Intrinsic::copysign, LHS, RHS, FMFSource,
                                 Name);
  }
 
  /// Create call to the ldexp intrinsic.
  Value *CreateLdexp(Value *Src, Value *Exp, FMFSource FMFSource = {},
                     const Twine &Name = "") {
    assert(!IsFPConstrained && "TODO: Support strictfp");
    return CreateIntrinsic(Intrinsic::ldexp, {Src->getType(), Exp->getType()},
                           {Src, Exp}, FMFSource, Name);
  }
 
  /// Create call to the fma intrinsic.
  Value *CreateFMA(Value *Factor1, Value *Factor2, Value *Summand,
                   FMFSource FMFSource = {}, const Twine &Name = "") {
    if (IsFPConstrained) {
      return CreateConstrainedFPIntrinsic(
          Intrinsic::experimental_constrained_fma, {Factor1->getType()},
          {Factor1, Factor2, Summand}, FMFSource, Name);
    }
 
    return CreateIntrinsic(Intrinsic::fma, {Factor1->getType()},
                           {Factor1, Factor2, Summand}, FMFSource, Name);
  }
 
  /// Create a call to the arithmetic_fence intrinsic.
  Value *CreateArithmeticFence(Value *Val, Type *DstType,
                               const Twine &Name = "") {
    return CreateIntrinsic(Intrinsic::arithmetic_fence, DstType, Val, nullptr,
                           Name);
  }
 
  /// Create a call to the vector.extract intrinsic.
  Value *CreateExtractVector(Type *DstType, Value *SrcVec, Value *Idx,
                             const Twine &Name = "") {
    return CreateIntrinsic(Intrinsic::vector_extract,
                           {DstType, SrcVec->getType()}, {SrcVec, Idx}, nullptr,
                           Name);
  }
 
  /// Create a call to the vector.extract intrinsic.
  Value *CreateExtractVector(Type *DstType, Value *SrcVec, uint64_t Idx,
                             const Twine &Name = "") {
    return CreateExtractVector(DstType, SrcVec, getInt64(Idx), Name);
  }
 
  /// Create a call to the vector.insert intrinsic.
  Value *CreateInsertVector(Type *DstType, Value *SrcVec, Value *SubVec,
                            Value *Idx, const Twine &Name = "") {
    return CreateIntrinsic(Intrinsic::vector_insert,
                           {DstType, SubVec->getType()}, {SrcVec, SubVec, Idx},
                           nullptr, Name);
  }
 
  /// Create a call to the vector.extract intrinsic.
  Value *CreateInsertVector(Type *DstType, Value *SrcVec, Value *SubVec,
                            uint64_t Idx, const Twine &Name = "") {
    return CreateInsertVector(DstType, SrcVec, SubVec, getInt64(Idx), Name);
  }
 
  /// Create a call to llvm.stacksave
  CallInst *CreateStackSave(const Twine &Name = "") {
    const DataLayout &DL = getDataLayout();
    return CreateIntrinsicWithoutFolding(Intrinsic::stacksave,
                                         {DL.getAllocaPtrType(Context)}, {},
                                         nullptr, Name);
  }
 
  /// Create a call to llvm.stackrestore
  CallInst *CreateStackRestore(Value *Ptr, const Twine &Name = "") {
    return CreateIntrinsicWithoutFolding(
        Intrinsic::stackrestore, {Ptr->getType()}, {Ptr}, nullptr, Name);
  }
 
  /// Create a call to llvm.experimental_cttz_elts
  Value *CreateCountTrailingZeroElems(Type *ResTy, Value *Mask,
                                      bool ZeroIsPoison = true,
                                      const Twine &Name = "") {
    return CreateIntrinsic(Intrinsic::experimental_cttz_elts,
                           {ResTy, Mask->getType()},
                           {Mask, getInt1(ZeroIsPoison)}, nullptr, Name);
  }
 
private:
  /// Create a call to a masked intrinsic with given Id.
  CallInst *CreateMaskedIntrinsic(Intrinsic::ID Id, ArrayRef<Value *> Ops,
                                  ArrayRef<Type *> OverloadedTypes,
                                  const Twine &Name = "");
 
  //===--------------------------------------------------------------------===//
  // Instruction creation methods: Terminators
  //===--------------------------------------------------------------------===//
 
private:
  /// Helper to add branch weight and unpredictable metadata onto an
  /// instruction.
  /// \returns The annotated instruction.
  template <typename InstTy>
  InstTy *addBranchMetadata(InstTy *I, MDNode *Weights, MDNode *Unpredictable) {
    if (Weights)
      I->setMetadata(LLVMContext::MD_prof, Weights);
    if (Unpredictable)
      I->setMetadata(LLVMContext::MD_unpredictable, Unpredictable);
    return I;
  }
 
public:
  /// Create a 'ret void' instruction.
  ReturnInst *CreateRetVoid() {
    return Insert(ReturnInst::Create(Context));
  }
 
  /// Create a 'ret <val>' instruction.
  ReturnInst *CreateRet(Value *V) {
    return Insert(ReturnInst::Create(Context, V));
  }
 
  /// Create a sequence of N insertvalue instructions, with one Value from the
  /// RetVals array each, that build a aggregate return value one value at a
  /// time, and a ret instruction to return the resulting aggregate value.
  ///
  /// This is a convenience function for code that uses aggregate return values
  /// as a vehicle for having multiple return values.
  ReturnInst *CreateAggregateRet(ArrayRef<Value *> RetVals) {
    Value *V = PoisonValue::get(getCurrentFunctionReturnType());
    for (size_t i = 0, N = RetVals.size(); i != N; ++i)
      V = CreateInsertValue(V, RetVals[i], i, "mrv");
    return Insert(ReturnInst::Create(Context, V));
  }
 
  /// Create an unconditional 'br label X' instruction.
  UncondBrInst *CreateBr(BasicBlock *Dest) {
    return Insert(UncondBrInst::Create(Dest));
  }
 
  /// Create a conditional 'br Cond, TrueDest, FalseDest'
  /// instruction.
  CondBrInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False,
                           MDNode *BranchWeights = nullptr,
                           MDNode *Unpredictable = nullptr) {
    return Insert(addBranchMetadata(CondBrInst::Create(Cond, True, False),
                                    BranchWeights, Unpredictable));
  }
 
  /// Create a conditional 'br Cond, TrueDest, FalseDest'
  /// instruction. Copy branch meta data if available.
  CondBrInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False,
                           Instruction *MDSrc) {
    CondBrInst *Br = CondBrInst::Create(Cond, True, False);
    if (MDSrc) {
      unsigned WL[4] = {LLVMContext::MD_prof, LLVMContext::MD_unpredictable,
                        LLVMContext::MD_make_implicit, LLVMContext::MD_dbg};
      Br->copyMetadata(*MDSrc, WL);
    }
    return Insert(Br);
  }
 
  /// Create a switch instruction with the specified value, default dest,
  /// and with a hint for the number of cases that will be added (for efficient
  /// allocation).
  SwitchInst *CreateSwitch(Value *V, BasicBlock *Dest, unsigned NumCases = 10,
                           MDNode *BranchWeights = nullptr,
                           MDNode *Unpredictable = nullptr) {
    return Insert(addBranchMetadata(SwitchInst::Create(V, Dest, NumCases),
                                    BranchWeights, Unpredictable));
  }
 
  /// Create an indirect branch instruction with the specified address
  /// operand, with an optional hint for the number of destinations that will be
  /// added (for efficient allocation).
  IndirectBrInst *CreateIndirectBr(Value *Addr, unsigned NumDests = 10) {
    return Insert(IndirectBrInst::Create(Addr, NumDests));
  }
 
  /// Create an invoke instruction.
  InvokeInst *CreateInvoke(FunctionType *Ty, Value *Callee,
                           BasicBlock *NormalDest, BasicBlock *UnwindDest,
                           ArrayRef<Value *> Args,
                           ArrayRef<OperandBundleDef> OpBundles,
                           const Twine &Name = "") {
    InvokeInst *II =
        InvokeInst::Create(Ty, Callee, NormalDest, UnwindDest, Args, OpBundles);
    if (IsFPConstrained)
      setConstrainedFPCallAttr(II);
    return Insert(II, Name);
  }
  InvokeInst *CreateInvoke(FunctionType *Ty, Value *Callee,
                           BasicBlock *NormalDest, BasicBlock *UnwindDest,
                           ArrayRef<Value *> Args = {},
                           const Twine &Name = "") {
    InvokeInst *II =
        InvokeInst::Create(Ty, Callee, NormalDest, UnwindDest, Args);
    if (IsFPConstrained)
      setConstrainedFPCallAttr(II);
    return Insert(II, Name);
  }
 
  InvokeInst *CreateInvoke(FunctionCallee Callee, BasicBlock *NormalDest,
                           BasicBlock *UnwindDest, ArrayRef<Value *> Args,
                           ArrayRef<OperandBundleDef> OpBundles,
                           const Twine &Name = "") {
    return CreateInvoke(Callee.getFunctionType(), Callee.getCallee(),
                        NormalDest, UnwindDest, Args, OpBundles, Name);
  }
 
  InvokeInst *CreateInvoke(FunctionCallee Callee, BasicBlock *NormalDest,
                           BasicBlock *UnwindDest, ArrayRef<Value *> Args = {},
                           const Twine &Name = "") {
    return CreateInvoke(Callee.getFunctionType(), Callee.getCallee(),
                        NormalDest, UnwindDest, Args, Name);
  }
 
  /// \brief Create a callbr instruction.
  CallBrInst *CreateCallBr(FunctionType *Ty, Value *Callee,
                           BasicBlock *DefaultDest,
                           ArrayRef<BasicBlock *> IndirectDests,
                           ArrayRef<Value *> Args = {},
                           const Twine &Name = "") {
    return Insert(CallBrInst::Create(Ty, Callee, DefaultDest, IndirectDests,
                                     Args), Name);
  }
  CallBrInst *CreateCallBr(FunctionType *Ty, Value *Callee,
                           BasicBlock *DefaultDest,
                           ArrayRef<BasicBlock *> IndirectDests,
                           ArrayRef<Value *> Args,
                           ArrayRef<OperandBundleDef> OpBundles,
                           const Twine &Name = "") {
    return Insert(
        CallBrInst::Create(Ty, Callee, DefaultDest, IndirectDests, Args,
                           OpBundles), Name);
  }
 
  CallBrInst *CreateCallBr(FunctionCallee Callee, BasicBlock *DefaultDest,
                           ArrayRef<BasicBlock *> IndirectDests,
                           ArrayRef<Value *> Args = {},
                           const Twine &Name = "") {
    return CreateCallBr(Callee.getFunctionType(), Callee.getCallee(),
                        DefaultDest, IndirectDests, Args, Name);
  }
  CallBrInst *CreateCallBr(FunctionCallee Callee, BasicBlock *DefaultDest,
                           ArrayRef<BasicBlock *> IndirectDests,
                           ArrayRef<Value *> Args,
                           ArrayRef<OperandBundleDef> OpBundles,
                           const Twine &Name = "") {
    return CreateCallBr(Callee.getFunctionType(), Callee.getCallee(),
                        DefaultDest, IndirectDests, Args, Name);
  }
 
  ResumeInst *CreateResume(Value *Exn) {
    return Insert(ResumeInst::Create(Exn));
  }
 
  CleanupReturnInst *CreateCleanupRet(CleanupPadInst *CleanupPad,
                                      BasicBlock *UnwindBB = nullptr) {
    return Insert(CleanupReturnInst::Create(CleanupPad, UnwindBB));
  }
 
  CatchSwitchInst *CreateCatchSwitch(Value *ParentPad, BasicBlock *UnwindBB,
                                     unsigned NumHandlers,
                                     const Twine &Name = "") {
    return Insert(CatchSwitchInst::Create(ParentPad, UnwindBB, NumHandlers),
                  Name);
  }
 
  CatchPadInst *CreateCatchPad(Value *ParentPad, ArrayRef<Value *> Args,
                               const Twine &Name = "") {
    return Insert(CatchPadInst::Create(ParentPad, Args), Name);
  }
 
  CleanupPadInst *CreateCleanupPad(Value *ParentPad,
                                   ArrayRef<Value *> Args = {},
                                   const Twine &Name = "") {
    return Insert(CleanupPadInst::Create(ParentPad, Args), Name);
  }
 
  CatchReturnInst *CreateCatchRet(CatchPadInst *CatchPad, BasicBlock *BB) {
    return Insert(CatchReturnInst::Create(CatchPad, BB));
  }
 
  UnreachableInst *CreateUnreachable() {
    return Insert(new UnreachableInst(Context));
  }
 
  //===--------------------------------------------------------------------===//
  // Instruction creation methods: Binary Operators
  //===--------------------------------------------------------------------===//
private:
  BinaryOperator *CreateInsertNUWNSWBinOp(BinaryOperator::BinaryOps Opc,
                                          Value *LHS, Value *RHS,
                                          const Twine &Name,
                                          bool HasNUW, bool HasNSW) {
    BinaryOperator *BO = Insert(BinaryOperator::Create(Opc, LHS, RHS), Name);
    if (HasNUW) BO->setHasNoUnsignedWrap();
    if (HasNSW) BO->setHasNoSignedWrap();
    return BO;
  }
 
  Instruction *setFPAttrs(Instruction *I, MDNode *FPMD,
                          FastMathFlags FMF) const {
    if (!FPMD)
      FPMD = DefaultFPMathTag;
    if (FPMD)
      I->setMetadata(LLVMContext::MD_fpmath, FPMD);
    I->setFastMathFlags(FMF);
    return I;
  }
 
  Value *getConstrainedFPRounding(std::optional<RoundingMode> Rounding) {
    RoundingMode UseRounding = DefaultConstrainedRounding;
 
    if (Rounding)
      UseRounding = *Rounding;
 
    std::optional<StringRef> RoundingStr =
        convertRoundingModeToStr(UseRounding);
    assert(RoundingStr && "Garbage strict rounding mode!");
    auto *RoundingMDS = MDString::get(Context, *RoundingStr);
 
    return MetadataAsValue::get(Context, RoundingMDS);
  }
 
  Value *getConstrainedFPExcept(std::optional<fp::ExceptionBehavior> Except) {
    std::optional<StringRef> ExceptStr = convertExceptionBehaviorToStr(
        Except.value_or(DefaultConstrainedExcept));
    assert(ExceptStr && "Garbage strict exception behavior!");
    auto *ExceptMDS = MDString::get(Context, *ExceptStr);
 
    return MetadataAsValue::get(Context, ExceptMDS);
  }
 
  Value *getConstrainedFPPredicate(CmpInst::Predicate Predicate) {
    assert(CmpInst::isFPPredicate(Predicate) &&
           Predicate != CmpInst::FCMP_FALSE &&
           Predicate != CmpInst::FCMP_TRUE &&
           "Invalid constrained FP comparison predicate!");
 
    StringRef PredicateStr = CmpInst::getPredicateName(Predicate);
    auto *PredicateMDS = MDString::get(Context, PredicateStr);
 
    return MetadataAsValue::get(Context, PredicateMDS);
  }
 
public:
  Value *CreateAdd(Value *LHS, Value *RHS, const Twine &Name = "",
                   bool HasNUW = false, bool HasNSW = false) {
    if (Value *V =
            Folder.FoldNoWrapBinOp(Instruction::Add, LHS, RHS, HasNUW, HasNSW))
      return V;
    return CreateInsertNUWNSWBinOp(Instruction::Add, LHS, RHS, Name, HasNUW,
                                   HasNSW);
  }
 
  Value *CreateNSWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateAdd(LHS, RHS, Name, false, true);
  }
 
  Value *CreateNUWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateAdd(LHS, RHS, Name, true, false);
  }
 
  Value *CreateSub(Value *LHS, Value *RHS, const Twine &Name = "",
                   bool HasNUW = false, bool HasNSW = false) {
    if (Value *V =
            Folder.FoldNoWrapBinOp(Instruction::Sub, LHS, RHS, HasNUW, HasNSW))
      return V;
    return CreateInsertNUWNSWBinOp(Instruction::Sub, LHS, RHS, Name, HasNUW,
                                   HasNSW);
  }
 
  Value *CreateNSWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateSub(LHS, RHS, Name, false, true);
  }
 
  Value *CreateNUWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateSub(LHS, RHS, Name, true, false);
  }
 
  Value *CreateMul(Value *LHS, Value *RHS, const Twine &Name = "",
                   bool HasNUW = false, bool HasNSW = false) {
    if (Value *V =
            Folder.FoldNoWrapBinOp(Instruction::Mul, LHS, RHS, HasNUW, HasNSW))
      return V;
    return CreateInsertNUWNSWBinOp(Instruction::Mul, LHS, RHS, Name, HasNUW,
                                   HasNSW);
  }
 
  Value *CreateNSWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateMul(LHS, RHS, Name, false, true);
  }
 
  Value *CreateNUWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateMul(LHS, RHS, Name, true, false);
  }
 
  Value *CreateUDiv(Value *LHS, Value *RHS, const Twine &Name = "",
                    bool isExact = false) {
    if (Value *V = Folder.FoldExactBinOp(Instruction::UDiv, LHS, RHS, isExact))
      return V;
    if (!isExact)
      return Insert(BinaryOperator::CreateUDiv(LHS, RHS), Name);
    return Insert(BinaryOperator::CreateExactUDiv(LHS, RHS), Name);
  }
 
  Value *CreateExactUDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateUDiv(LHS, RHS, Name, true);
  }
 
  Value *CreateSDiv(Value *LHS, Value *RHS, const Twine &Name = "",
                    bool isExact = false) {
    if (Value *V = Folder.FoldExactBinOp(Instruction::SDiv, LHS, RHS, isExact))
      return V;
    if (!isExact)
      return Insert(BinaryOperator::CreateSDiv(LHS, RHS), Name);
    return Insert(BinaryOperator::CreateExactSDiv(LHS, RHS), Name);
  }
 
  Value *CreateExactSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateSDiv(LHS, RHS, Name, true);
  }
 
  Value *CreateURem(Value *LHS, Value *RHS, const Twine &Name = "") {
    if (Value *V = Folder.FoldBinOp(Instruction::URem, LHS, RHS))
      return V;
    return Insert(BinaryOperator::CreateURem(LHS, RHS), Name);
  }
 
  Value *CreateSRem(Value *LHS, Value *RHS, const Twine &Name = "") {
    if (Value *V = Folder.FoldBinOp(Instruction::SRem, LHS, RHS))
      return V;
    return Insert(BinaryOperator::CreateSRem(LHS, RHS), Name);
  }
 
  Value *CreateShl(Value *LHS, Value *RHS, const Twine &Name = "",
                   bool HasNUW = false, bool HasNSW = false) {
    if (Value *V =
            Folder.FoldNoWrapBinOp(Instruction::Shl, LHS, RHS, HasNUW, HasNSW))
      return V;
    return CreateInsertNUWNSWBinOp(Instruction::Shl, LHS, RHS, Name,
                                   HasNUW, HasNSW);
  }
 
  Value *CreateShl(Value *LHS, const APInt &RHS, const Twine &Name = "",
                   bool HasNUW = false, bool HasNSW = false) {
    return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
                     HasNUW, HasNSW);
  }
 
  Value *CreateShl(Value *LHS, uint64_t RHS, const Twine &Name = "",
                   bool HasNUW = false, bool HasNSW = false) {
    return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
                     HasNUW, HasNSW);
  }
 
  Value *CreateLShr(Value *LHS, Value *RHS, const Twine &Name = "",
                    bool isExact = false) {
    if (Value *V = Folder.FoldExactBinOp(Instruction::LShr, LHS, RHS, isExact))
      return V;
    if (!isExact)
      return Insert(BinaryOperator::CreateLShr(LHS, RHS), Name);
    return Insert(BinaryOperator::CreateExactLShr(LHS, RHS), Name);
  }
 
  Value *CreateLShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
                    bool isExact = false) {
    return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
  }
 
  Value *CreateLShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
                    bool isExact = false) {
    return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
  }
 
  Value *CreateAShr(Value *LHS, Value *RHS, const Twine &Name = "",
                    bool isExact = false) {
    if (Value *V = Folder.FoldExactBinOp(Instruction::AShr, LHS, RHS, isExact))
      return V;
    if (!isExact)
      return Insert(BinaryOperator::CreateAShr(LHS, RHS), Name);
    return Insert(BinaryOperator::CreateExactAShr(LHS, RHS), Name);
  }
 
  Value *CreateAShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
                    bool isExact = false) {
    return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
  }
 
  Value *CreateAShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
                    bool isExact = false) {
    return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
  }
 
  Value *CreateAnd(Value *LHS, Value *RHS, const Twine &Name = "") {
    if (auto *V = Folder.FoldBinOp(Instruction::And, LHS, RHS))
      return V;
    return Insert(BinaryOperator::CreateAnd(LHS, RHS), Name);
  }
 
  Value *CreateAnd(Value *LHS, const APInt &RHS, const Twine &Name = "") {
    return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
  }
 
  Value *CreateAnd(Value *LHS, uint64_t RHS, const Twine &Name = "") {
    return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
  }
 
  Value *CreateAnd(ArrayRef<Value*> Ops) {
    assert(!Ops.empty());
    Value *Accum = Ops[0];
    for (unsigned i = 1; i < Ops.size(); i++)
      Accum = CreateAnd(Accum, Ops[i]);
    return Accum;
  }
 
  Value *CreateOr(Value *LHS, Value *RHS, const Twine &Name = "",
                  bool IsDisjoint = false) {
    if (auto *V = Folder.FoldBinOp(Instruction::Or, LHS, RHS))
      return V;
    return Insert(
        IsDisjoint ? BinaryOperator::CreateDisjoint(Instruction::Or, LHS, RHS)
                   : BinaryOperator::CreateOr(LHS, RHS),
        Name);
  }
 
  Value *CreateOr(Value *LHS, const APInt &RHS, const Twine &Name = "") {
    return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
  }
 
  Value *CreateOr(Value *LHS, uint64_t RHS, const Twine &Name = "") {
    return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
  }
 
  Value *CreateOr(ArrayRef<Value*> Ops) {
    assert(!Ops.empty());
    Value *Accum = Ops[0];
    for (unsigned i = 1; i < Ops.size(); i++)
      Accum = CreateOr(Accum, Ops[i]);
    return Accum;
  }
 
  Value *CreateDisjointOr(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateOr(LHS, RHS, Name, true);
  }
 
  Value *CreateXor(Value *LHS, Value *RHS, const Twine &Name = "") {
    if (Value *V = Folder.FoldBinOp(Instruction::Xor, LHS, RHS))
      return V;
    return Insert(BinaryOperator::CreateXor(LHS, RHS), Name);
  }
 
  Value *CreateXor(Value *LHS, const APInt &RHS, const Twine &Name = "") {
    return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
  }
 
  Value *CreateXor(Value *LHS, uint64_t RHS, const Twine &Name = "") {
    return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
  }
 
  Value *CreateFAdd(Value *L, Value *R, const Twine &Name = "",
                    MDNode *FPMD = nullptr) {
    return CreateFAddFMF(L, R, {}, Name, FPMD);
  }
 
  Value *CreateFAddFMF(Value *L, Value *R, FMFSource FMFSource,
                       const Twine &Name = "", MDNode *FPMD = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPBinOp(Intrinsic::experimental_constrained_fadd,
                                      L, R, FMFSource, Name, FPMD);
 
    if (Value *V =
            Folder.FoldBinOpFMF(Instruction::FAdd, L, R, FMFSource.get(FMF)))
      return V;
    Instruction *I =
        setFPAttrs(BinaryOperator::CreateFAdd(L, R), FPMD, FMFSource.get(FMF));
    return Insert(I, Name);
  }
 
  Value *CreateFSub(Value *L, Value *R, const Twine &Name = "",
                    MDNode *FPMD = nullptr) {
    return CreateFSubFMF(L, R, {}, Name, FPMD);
  }
 
  Value *CreateFSubFMF(Value *L, Value *R, FMFSource FMFSource,
                       const Twine &Name = "", MDNode *FPMD = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPBinOp(Intrinsic::experimental_constrained_fsub,
                                      L, R, FMFSource, Name, FPMD);
 
    if (Value *V =
            Folder.FoldBinOpFMF(Instruction::FSub, L, R, FMFSource.get(FMF)))
      return V;
    Instruction *I =
        setFPAttrs(BinaryOperator::CreateFSub(L, R), FPMD, FMFSource.get(FMF));
    return Insert(I, Name);
  }
 
  Value *CreateFMul(Value *L, Value *R, const Twine &Name = "",
                    MDNode *FPMD = nullptr) {
    return CreateFMulFMF(L, R, {}, Name, FPMD);
  }
 
  Value *CreateFMulFMF(Value *L, Value *R, FMFSource FMFSource,
                       const Twine &Name = "", MDNode *FPMD = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPBinOp(Intrinsic::experimental_constrained_fmul,
                                      L, R, FMFSource, Name, FPMD);
 
    if (Value *V =
            Folder.FoldBinOpFMF(Instruction::FMul, L, R, FMFSource.get(FMF)))
      return V;
    Instruction *I =
        setFPAttrs(BinaryOperator::CreateFMul(L, R), FPMD, FMFSource.get(FMF));
    return Insert(I, Name);
  }
 
  Value *CreateFDiv(Value *L, Value *R, const Twine &Name = "",
                    MDNode *FPMD = nullptr) {
    return CreateFDivFMF(L, R, {}, Name, FPMD);
  }
 
  Value *CreateFDivFMF(Value *L, Value *R, FMFSource FMFSource,
                       const Twine &Name = "", MDNode *FPMD = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPBinOp(Intrinsic::experimental_constrained_fdiv,
                                      L, R, FMFSource, Name, FPMD);
 
    if (Value *V =
            Folder.FoldBinOpFMF(Instruction::FDiv, L, R, FMFSource.get(FMF)))
      return V;
    Instruction *I =
        setFPAttrs(BinaryOperator::CreateFDiv(L, R), FPMD, FMFSource.get(FMF));
    return Insert(I, Name);
  }
 
  Value *CreateFRem(Value *L, Value *R, const Twine &Name = "",
                    MDNode *FPMD = nullptr) {
    return CreateFRemFMF(L, R, {}, Name, FPMD);
  }
 
  Value *CreateFRemFMF(Value *L, Value *R, FMFSource FMFSource,
                       const Twine &Name = "", MDNode *FPMD = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPBinOp(Intrinsic::experimental_constrained_frem,
                                      L, R, FMFSource, Name, FPMD);
 
    if (Value *V =
            Folder.FoldBinOpFMF(Instruction::FRem, L, R, FMFSource.get(FMF)))
      return V;
    Instruction *I =
        setFPAttrs(BinaryOperator::CreateFRem(L, R), FPMD, FMFSource.get(FMF));
    return Insert(I, Name);
  }
 
  Value *CreateBinOp(Instruction::BinaryOps Opc,
                     Value *LHS, Value *RHS, const Twine &Name = "",
                     MDNode *FPMathTag = nullptr) {
    return CreateBinOpFMF(Opc, LHS, RHS, {}, Name, FPMathTag);
  }
 
  Value *CreateBinOpFMF(Instruction::BinaryOps Opc, Value *LHS, Value *RHS,
                        FMFSource FMFSource, const Twine &Name = "",
                        MDNode *FPMathTag = nullptr) {
    if (Value *V = Folder.FoldBinOpFMF(Opc, LHS, RHS, FMFSource.get(FMF)))
      return V;
    Instruction *BinOp = BinaryOperator::Create(Opc, LHS, RHS);
    if (isa<FPMathOperator>(BinOp))
      setFPAttrs(BinOp, FPMathTag, FMFSource.get(FMF));
    return Insert(BinOp, Name);
  }
 
  Value *CreateNoWrapBinOp(Instruction::BinaryOps Opc, Value *LHS, Value *RHS,
                           bool IsNUW, bool IsNSW, const Twine &Name = "") {
    if (Value *V = Folder.FoldNoWrapBinOp(Opc, LHS, RHS, IsNUW, IsNSW))
      return V;
    Instruction *BinOp = BinaryOperator::Create(Opc, LHS, RHS);
    if (IsNUW)
      BinOp->setHasNoUnsignedWrap(IsNUW);
    if (IsNSW)
      BinOp->setHasNoSignedWrap(IsNSW);
    return Insert(BinOp, Name);
  }
 
  Value *CreateExactBinOp(Instruction::BinaryOps Opc, Value *LHS, Value *RHS,
                          bool IsExact, const Twine &Name = "") {
    if (Value *V = Folder.FoldExactBinOp(Opc, LHS, RHS, IsExact))
      return V;
    Instruction *BinOp = BinaryOperator::Create(Opc, LHS, RHS);
    if (IsExact)
      BinOp->setIsExact(IsExact);
    return Insert(BinOp, Name);
  }
 
  Value *CreateLogicalAnd(Value *Cond1, Value *Cond2, const Twine &Name = "",
                          Instruction *MDFrom = nullptr) {
    assert(Cond2->getType()->isIntOrIntVectorTy(1));
    return CreateSelect(Cond1, Cond2,
                        ConstantInt::getNullValue(Cond2->getType()), Name,
                        MDFrom);
  }
 
  Value *CreateLogicalOr(Value *Cond1, Value *Cond2, const Twine &Name = "",
                         Instruction *MDFrom = nullptr) {
    assert(Cond2->getType()->isIntOrIntVectorTy(1));
    return CreateSelect(Cond1, ConstantInt::getAllOnesValue(Cond2->getType()),
                        Cond2, Name, MDFrom);
  }
 
  Value *CreateLogicalOp(Instruction::BinaryOps Opc, Value *Cond1, Value *Cond2,
                         const Twine &Name = "",
                         Instruction *MDFrom = nullptr) {
    switch (Opc) {
    case Instruction::And:
      return CreateLogicalAnd(Cond1, Cond2, Name, MDFrom);
    case Instruction::Or:
      return CreateLogicalOr(Cond1, Cond2, Name, MDFrom);
    default:
      break;
    }
    llvm_unreachable("Not a logical operation.");
  }
 
  // NOTE: this is sequential, non-commutative, ordered reduction!
  Value *CreateLogicalOr(ArrayRef<Value *> Ops) {
    assert(!Ops.empty());
    Value *Accum = Ops[0];
    for (unsigned i = 1; i < Ops.size(); i++)
      Accum = CreateLogicalOr(Accum, Ops[i]);
    return Accum;
  }
 
  /// This function is like @ref CreateIntrinsic for constrained fp
  /// intrinsics. It sets the rounding mode and exception behavior of
  /// the created intrinsic call according to \p Rounding and \p
  /// Except and it sets \p FPMathTag as the 'fpmath' metadata, using
  /// defaults if a value equals nullopt/null.
  LLVM_ABI CallInst *CreateConstrainedFPIntrinsic(
      Intrinsic::ID ID, ArrayRef<Type *> Types, ArrayRef<Value *> Args,
      FMFSource FMFSource, const Twine &Name, MDNode *FPMathTag = nullptr,
      std::optional<RoundingMode> Rounding = std::nullopt,
      std::optional<fp::ExceptionBehavior> Except = std::nullopt);
 
  LLVM_ABI CallInst *CreateConstrainedFPBinOp(
      Intrinsic::ID ID, Value *L, Value *R, FMFSource FMFSource = {},
      const Twine &Name = "", MDNode *FPMathTag = nullptr,
      std::optional<RoundingMode> Rounding = std::nullopt,
      std::optional<fp::ExceptionBehavior> Except = std::nullopt);
 
  LLVM_ABI CallInst *CreateConstrainedFPUnroundedBinOp(
      Intrinsic::ID ID, Value *L, Value *R, FMFSource FMFSource = {},
      const Twine &Name = "", MDNode *FPMathTag = nullptr,
      std::optional<fp::ExceptionBehavior> Except = std::nullopt);
 
  Value *CreateNeg(Value *V, const Twine &Name = "", bool HasNSW = false) {
    return CreateSub(Constant::getNullValue(V->getType()), V, Name,
                     /*HasNUW=*/0, HasNSW);
  }
 
  Value *CreateNSWNeg(Value *V, const Twine &Name = "") {
    return CreateNeg(V, Name, /*HasNSW=*/true);
  }
 
  Value *CreateFNeg(Value *V, const Twine &Name = "",
                    MDNode *FPMathTag = nullptr) {
    return CreateFNegFMF(V, {}, Name, FPMathTag);
  }
 
  Value *CreateFNegFMF(Value *V, FMFSource FMFSource, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    if (Value *Res =
            Folder.FoldUnOpFMF(Instruction::FNeg, V, FMFSource.get(FMF)))
      return Res;
    return Insert(
        setFPAttrs(UnaryOperator::CreateFNeg(V), FPMathTag, FMFSource.get(FMF)),
        Name);
  }
 
  Value *CreateNot(Value *V, const Twine &Name = "") {
    return CreateXor(V, Constant::getAllOnesValue(V->getType()), Name);
  }
 
  Value *CreateUnOp(Instruction::UnaryOps Opc,
                    Value *V, const Twine &Name = "",
                    MDNode *FPMathTag = nullptr) {
    return CreateUnOpFMF(Opc, V, {}, Name, FPMathTag);
  }
 
  Value *CreateUnOpFMF(Instruction::UnaryOps Opc, Value *V, FMFSource FMFSource,
                       const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    if (Value *Res = Folder.FoldUnOpFMF(Opc, V, FMFSource.get(FMF)))
      return Res;
    Instruction *UnOp = UnaryOperator::Create(Opc, V);
    if (isa<FPMathOperator>(UnOp))
      setFPAttrs(UnOp, FPMathTag, FMFSource.get(FMF));
    return Insert(UnOp, Name);
  }
 
  /// Create either a UnaryOperator or BinaryOperator depending on \p Opc.
  /// Correct number of operands must be passed accordingly.
  LLVM_ABI Value *CreateNAryOp(unsigned Opc, ArrayRef<Value *> Ops,
                               const Twine &Name = "",
                               MDNode *FPMathTag = nullptr);
 
  //===--------------------------------------------------------------------===//
  // Instruction creation methods: Memory Instructions
  //===--------------------------------------------------------------------===//
 
  AllocaInst *CreateAlloca(Type *Ty, unsigned AddrSpace,
                           Value *ArraySize = nullptr, const Twine &Name = "") {
    const DataLayout &DL = getDataLayout();
    Align AllocaAlign = DL.getPrefTypeAlign(Ty);
    return Insert(new AllocaInst(Ty, AddrSpace, ArraySize, AllocaAlign), Name);
  }
 
  AllocaInst *CreateAlloca(Type *Ty, Value *ArraySize = nullptr,
                           const Twine &Name = "") {
    const DataLayout &DL = getDataLayout();
    Align AllocaAlign = DL.getPrefTypeAlign(Ty);
    unsigned AddrSpace = DL.getAllocaAddrSpace();
    return Insert(new AllocaInst(Ty, AddrSpace, ArraySize, AllocaAlign), Name);
  }
 
  CallInst *CreateStructuredAlloca(Type *BaseType, const Twine &Name = "") {
    const DataLayout &DL = getDataLayout();
    PointerType *PtrTy = DL.getAllocaPtrType(Context);
    auto *Output = CreateIntrinsicWithoutFolding(Intrinsic::structured_alloca,
                                                 {PtrTy}, {}, {}, Name);
    Output->addRetAttr(
        Attribute::get(getContext(), Attribute::ElementType, BaseType));
    return Output;
  }
 
  /// Provided to resolve 'CreateLoad(Ty, Ptr, "...")' correctly, instead of
  /// converting the string to 'bool' for the isVolatile parameter.
  LoadInst *CreateLoad(Type *Ty, Value *Ptr, const char *Name) {
    return CreateAlignedLoad(Ty, Ptr, MaybeAlign(), Name);
  }
  LoadInst *CreateLoad(Type *Ty, Value *Ptr, const Twine &Name = "") {
    return CreateAlignedLoad(Ty, Ptr, MaybeAlign(), Name);
  }
 
  LoadInst *CreateLoad(Type *Ty, Value *Ptr, bool isVolatile,
                       const Twine &Name = "") {
    return CreateAlignedLoad(Ty, Ptr, MaybeAlign(), isVolatile, Name);
  }
 
  LoadInst *CreateLoad(Type *Ty, Value *Ptr,
                       const LoadStoreInstProperties &Props,
                       const Twine &Name = "") {
    return Insert(new LoadInst(Ty, Ptr, Twine(), Props), Name);
  }
 
  StoreInst *CreateStore(Value *Val, Value *Ptr, bool isVolatile = false) {
    return CreateAlignedStore(Val, Ptr, MaybeAlign(), isVolatile);
  }
 
  StoreInst *CreateStore(Value *Val, Value *Ptr,
                         const LoadStoreInstProperties &Props) {
    return Insert(new StoreInst(Val, Ptr, Props));
  }
 
  LoadInst *CreateAlignedLoad(Type *Ty, Value *Ptr, MaybeAlign Align,
                              const char *Name) {
    return CreateAlignedLoad(Ty, Ptr, Align, /*isVolatile*/false, Name);
  }
 
  LoadInst *CreateAlignedLoad(Type *Ty, Value *Ptr, MaybeAlign Align,
                              const Twine &Name = "") {
    return CreateAlignedLoad(Ty, Ptr, Align, /*isVolatile*/false, Name);
  }
 
  LoadInst *CreateAlignedLoad(Type *Ty, Value *Ptr, MaybeAlign Align,
                              bool isVolatile, const Twine &Name = "") {
    if (!Align) {
      const DataLayout &DL = getDataLayout();
      Align = DL.getABITypeAlign(Ty);
    }
    return Insert(new LoadInst(Ty, Ptr, Twine(), isVolatile, *Align), Name);
  }
 
  StoreInst *CreateAlignedStore(Value *Val, Value *Ptr, MaybeAlign Align,
                                bool isVolatile = false) {
    if (!Align) {
      const DataLayout &DL = getDataLayout();
      Align = DL.getABITypeAlign(Val->getType());
    }
    return Insert(new StoreInst(Val, Ptr, isVolatile, *Align));
  }
  FenceInst *CreateFence(AtomicOrdering Ordering,
                         SyncScope::ID SSID = SyncScope::System,
                         const Twine &Name = "") {
    return Insert(new FenceInst(Context, Ordering, SSID), Name);
  }
 
  AtomicCmpXchgInst *
  CreateAtomicCmpXchg(Value *Ptr, Value *Cmp, Value *New, MaybeAlign Align,
                      AtomicOrdering SuccessOrdering,
                      AtomicOrdering FailureOrdering,
                      SyncScope::ID SSID = SyncScope::System) {
    if (!Align) {
      const DataLayout &DL = getDataLayout();
      Align = llvm::Align(DL.getTypeStoreSize(New->getType()));
    }
 
    return Insert(new AtomicCmpXchgInst(Ptr, Cmp, New, *Align, SuccessOrdering,
                                        FailureOrdering, SSID));
  }
 
  AtomicRMWInst *CreateAtomicRMW(AtomicRMWInst::BinOp Op, Value *Ptr,
                                 Value *Val, MaybeAlign Align,
                                 AtomicOrdering Ordering,
                                 SyncScope::ID SSID = SyncScope::System,
                                 bool Elementwise = false) {
    if (!Align) {
      const DataLayout &DL = getDataLayout();
      Align = llvm::Align(DL.getTypeStoreSize(Val->getType()));
    }
 
    return Insert(
        new AtomicRMWInst(Op, Ptr, Val, *Align, Ordering, SSID, Elementwise));
  }
 
  Value *CreateStructuredGEP(Type *BaseType, Value *PtrBase,
                             ArrayRef<Value *> Indices,
                             const Twine &Name = "") {
    SmallVector<Value *> Args;
    Args.push_back(PtrBase);
    llvm::append_range(Args, Indices);
 
    return CreateIntrinsic(
        Intrinsic::structured_gep, {PtrBase->getType()}, Args, {}, Name, {},
        [&](CallInst *Output) {
          Output->addParamAttr(
              0,
              Attribute::get(getContext(), Attribute::ElementType, BaseType));
        });
  }
 
  Value *CreateGEP(Type *Ty, Value *Ptr, ArrayRef<Value *> IdxList,
                   const Twine &Name = "",
                   GEPNoWrapFlags NW = GEPNoWrapFlags::none()) {
    if (auto *V = Folder.FoldGEP(getDataLayout(), Ty, Ptr, IdxList, NW))
      return V;
    return Insert(GetElementPtrInst::Create(Ty, Ptr, IdxList, NW), Name);
  }
 
  Value *CreateInBoundsGEP(Type *Ty, Value *Ptr, ArrayRef<Value *> IdxList,
                           const Twine &Name = "") {
    return CreateGEP(Ty, Ptr, IdxList, Name, GEPNoWrapFlags::inBounds());
  }
 
  Value *CreateConstGEP1_32(Type *Ty, Value *Ptr, unsigned Idx0,
                            const Twine &Name = "") {
    Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
    return CreateGEP(Ty, Ptr, Idx, Name, GEPNoWrapFlags::none());
  }
 
  Value *CreateConstInBoundsGEP1_32(Type *Ty, Value *Ptr, unsigned Idx0,
                                    const Twine &Name = "") {
    Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
    return CreateGEP(Ty, Ptr, Idx, Name, GEPNoWrapFlags::inBounds());
  }
 
  Value *CreateConstGEP2_32(Type *Ty, Value *Ptr, unsigned Idx0, unsigned Idx1,
                            const Twine &Name = "",
                            GEPNoWrapFlags NWFlags = GEPNoWrapFlags::none()) {
    Value *Idxs[] = {
      ConstantInt::get(Type::getInt32Ty(Context), Idx0),
      ConstantInt::get(Type::getInt32Ty(Context), Idx1)
    };
    return CreateGEP(Ty, Ptr, Idxs, Name, NWFlags);
  }
 
  Value *CreateConstInBoundsGEP2_32(Type *Ty, Value *Ptr, unsigned Idx0,
                                    unsigned Idx1, const Twine &Name = "") {
    Value *Idxs[] = {
      ConstantInt::get(Type::getInt32Ty(Context), Idx0),
      ConstantInt::get(Type::getInt32Ty(Context), Idx1)
    };
    return CreateGEP(Ty, Ptr, Idxs, Name, GEPNoWrapFlags::inBounds());
  }
 
  Value *CreateConstGEP1_64(Type *Ty, Value *Ptr, uint64_t Idx0,
                            const Twine &Name = "") {
    Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
    return CreateGEP(Ty, Ptr, Idx, Name, GEPNoWrapFlags::none());
  }
 
  Value *CreateConstInBoundsGEP1_64(Type *Ty, Value *Ptr, uint64_t Idx0,
                                    const Twine &Name = "") {
    Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
    return CreateGEP(Ty, Ptr, Idx, Name, GEPNoWrapFlags::inBounds());
  }
 
  Value *CreateConstGEP2_64(Type *Ty, Value *Ptr, uint64_t Idx0, uint64_t Idx1,
                            const Twine &Name = "") {
    Value *Idxs[] = {
      ConstantInt::get(Type::getInt64Ty(Context), Idx0),
      ConstantInt::get(Type::getInt64Ty(Context), Idx1)
    };
    return CreateGEP(Ty, Ptr, Idxs, Name, GEPNoWrapFlags::none());
  }
 
  Value *CreateConstInBoundsGEP2_64(Type *Ty, Value *Ptr, uint64_t Idx0,
                                    uint64_t Idx1, const Twine &Name = "") {
    Value *Idxs[] = {
      ConstantInt::get(Type::getInt64Ty(Context), Idx0),
      ConstantInt::get(Type::getInt64Ty(Context), Idx1)
    };
    return CreateGEP(Ty, Ptr, Idxs, Name, GEPNoWrapFlags::inBounds());
  }
 
  Value *CreateStructGEP(Type *Ty, Value *Ptr, unsigned Idx,
                         const Twine &Name = "") {
    GEPNoWrapFlags NWFlags =
        GEPNoWrapFlags::inBounds() | GEPNoWrapFlags::noUnsignedWrap();
    return CreateConstGEP2_32(Ty, Ptr, 0, Idx, Name, NWFlags);
  }
 
  Value *CreatePtrAdd(Value *Ptr, Value *Offset, const Twine &Name = "",
                      GEPNoWrapFlags NW = GEPNoWrapFlags::none()) {
    return CreateGEP(getInt8Ty(), Ptr, Offset, Name, NW);
  }
 
  Value *CreateInBoundsPtrAdd(Value *Ptr, Value *Offset,
                              const Twine &Name = "") {
    return CreateGEP(getInt8Ty(), Ptr, Offset, Name,
                     GEPNoWrapFlags::inBounds());
  }
 
  /// Create a ptradd with an unsigned constant offset. The offset must fit into
  /// the unsigned index type.
  Value *
  CreatePtrAddWithUnsignedOffset(Value *Ptr, uint64_t Offset,
                                 const Twine &Name = "",
                                 GEPNoWrapFlags NW = GEPNoWrapFlags::none()) {
    Type *IdxTy = getDataLayout().getIndexType(Ptr->getType());
    return CreatePtrAdd(Ptr, ConstantInt::get(IdxTy, Offset), Name, NW);
  }
 
  /// Create a ptradd with a signed constant offset. The offset must fit into
  /// the signed index type.
  Value *
  CreatePtrAddWithSignedOffset(Value *Ptr, int64_t Offset,
                               const Twine &Name = "",
                               GEPNoWrapFlags NW = GEPNoWrapFlags::none()) {
    Type *IdxTy = getDataLayout().getIndexType(Ptr->getType());
    return CreatePtrAdd(Ptr, ConstantInt::getSigned(IdxTy, Offset), Name, NW);
  }
 
  /// Create a ptradd where the offset is sign-extended or truncated to the
  /// index type. Offset must match the vector-ness of the base pointer.
  Value *
  CreatePtrAddWithSExtOrTrunc(Value *Ptr, Value *Offset, const Twine &Name = "",
                              GEPNoWrapFlags NW = GEPNoWrapFlags::none()) {
    Type *IdxTy = getDataLayout().getIndexType(Ptr->getType());
    return CreatePtrAdd(Ptr, CreateSExtOrTrunc(Offset, IdxTy), Name, NW);
  }
 
  /// Create a ptradd where the offset is zero-extended or truncated to the
  /// index type. Offset must match the vector-ness of the base pointer.
  Value *
  CreatePtrAddWithZExtOrTrunc(Value *Ptr, Value *Offset, const Twine &Name = "",
                              GEPNoWrapFlags NW = GEPNoWrapFlags::none()) {
    Type *IdxTy = getDataLayout().getIndexType(Ptr->getType());
    return CreatePtrAdd(Ptr, CreateZExtOrTrunc(Offset, IdxTy), Name, NW);
  }
 
  //===--------------------------------------------------------------------===//
  // Instruction creation methods: Cast/Conversion Operators
  //===--------------------------------------------------------------------===//
 
  Value *CreateTrunc(Value *V, Type *DestTy, const Twine &Name = "",
                     bool IsNUW = false, bool IsNSW = false) {
    if (V->getType() == DestTy)
      return V;
    if (Value *Folded = Folder.FoldCast(Instruction::Trunc, V, DestTy))
      return Folded;
    Instruction *I = CastInst::Create(Instruction::Trunc, V, DestTy);
    if (IsNUW)
      I->setHasNoUnsignedWrap();
    if (IsNSW)
      I->setHasNoSignedWrap();
    return Insert(I, Name);
  }
 
  Value *CreateZExt(Value *V, Type *DestTy, const Twine &Name = "",
                    bool IsNonNeg = false) {
    if (V->getType() == DestTy)
      return V;
    if (Value *Folded = Folder.FoldCast(Instruction::ZExt, V, DestTy))
      return Folded;
    Instruction *I = Insert(new ZExtInst(V, DestTy), Name);
    if (IsNonNeg)
      I->setNonNeg();
    return I;
  }
 
  Value *CreateSExt(Value *V, Type *DestTy, const Twine &Name = "") {
    return CreateCast(Instruction::SExt, V, DestTy, Name);
  }
 
  /// Create a ZExt or Trunc from the integer value V to DestTy. Return
  /// the value untouched if the type of V is already DestTy.
  Value *CreateZExtOrTrunc(Value *V, Type *DestTy,
                           const Twine &Name = "") {
    assert(V->getType()->isIntOrIntVectorTy() &&
           DestTy->isIntOrIntVectorTy() &&
           "Can only zero extend/truncate integers!");
    Type *VTy = V->getType();
    if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
      return CreateZExt(V, DestTy, Name);
    if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
      return CreateTrunc(V, DestTy, Name);
    return V;
  }
 
  /// Create a SExt or Trunc from the integer value V to DestTy. Return
  /// the value untouched if the type of V is already DestTy.
  Value *CreateSExtOrTrunc(Value *V, Type *DestTy,
                           const Twine &Name = "") {
    assert(V->getType()->isIntOrIntVectorTy() &&
           DestTy->isIntOrIntVectorTy() &&
           "Can only sign extend/truncate integers!");
    Type *VTy = V->getType();
    if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
      return CreateSExt(V, DestTy, Name);
    if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
      return CreateTrunc(V, DestTy, Name);
    return V;
  }
 
  Value *CreateFPToUI(Value *V, Type *DestTy, const Twine &Name = "") {
    if (IsFPConstrained)
      return CreateConstrainedFPCast(Intrinsic::experimental_constrained_fptoui,
                                     V, DestTy, nullptr, Name);
    return CreateCast(Instruction::FPToUI, V, DestTy, Name);
  }
 
  Value *CreateFPToSI(Value *V, Type *DestTy, const Twine &Name = "") {
    if (IsFPConstrained)
      return CreateConstrainedFPCast(Intrinsic::experimental_constrained_fptosi,
                                     V, DestTy, nullptr, Name);
    return CreateCast(Instruction::FPToSI, V, DestTy, Name);
  }
 
  Value *CreateUIToFP(Value *V, Type *DestTy, const Twine &Name = "",
                      bool IsNonNeg = false, MDNode *FPMathTag = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPCast(Intrinsic::experimental_constrained_uitofp,
                                     V, DestTy, nullptr, Name);
    Value *Val = CreateCast(Instruction::UIToFP, V, DestTy, Name, FPMathTag);
    if (auto *I = dyn_cast<Instruction>(Val))
      if (IsNonNeg)
        I->setNonNeg();
    return Val;
  }
 
  Value *CreateSIToFP(Value *V, Type *DestTy, const Twine &Name = "",
                      MDNode *FPMathTag = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPCast(Intrinsic::experimental_constrained_sitofp,
                                     V, DestTy, nullptr, Name);
    return CreateCast(Instruction::SIToFP, V, DestTy, Name, FPMathTag);
  }
 
  Value *CreateFPTrunc(Value *V, Type *DestTy, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFPTruncFMF(V, DestTy, {}, Name, FPMathTag);
  }
 
  Value *CreateFPTruncFMF(Value *V, Type *DestTy, FMFSource FMFSource,
                          const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPCast(
          Intrinsic::experimental_constrained_fptrunc, V, DestTy, FMFSource,
          Name, FPMathTag);
    return CreateCast(Instruction::FPTrunc, V, DestTy, Name, FPMathTag,
                      FMFSource);
  }
 
  Value *CreateFPExt(Value *V, Type *DestTy, const Twine &Name = "",
                     MDNode *FPMathTag = nullptr) {
    return CreateFPExtFMF(V, DestTy, {}, Name, FPMathTag);
  }
 
  Value *CreateFPExtFMF(Value *V, Type *DestTy, FMFSource FMFSource,
                        const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    if (IsFPConstrained)
      return CreateConstrainedFPCast(Intrinsic::experimental_constrained_fpext,
                                     V, DestTy, FMFSource, Name, FPMathTag);
    return CreateCast(Instruction::FPExt, V, DestTy, Name, FPMathTag,
                      FMFSource);
  }
  Value *CreatePtrToAddr(Value *V, const Twine &Name = "") {
    return CreateCast(Instruction::PtrToAddr, V,
                      getDataLayout().getAddressType(V->getType()), Name);
  }
  Value *CreatePtrToInt(Value *V, Type *DestTy,
                        const Twine &Name = "") {
    return CreateCast(Instruction::PtrToInt, V, DestTy, Name);
  }
 
  Value *CreateIntToPtr(Value *V, Type *DestTy,
                        const Twine &Name = "") {
    return CreateCast(Instruction::IntToPtr, V, DestTy, Name);
  }
 
  Value *CreateBitCast(Value *V, Type *DestTy,
                       const Twine &Name = "") {
    return CreateCast(Instruction::BitCast, V, DestTy, Name);
  }
 
  Value *CreateAddrSpaceCast(Value *V, Type *DestTy, const Twine &Name = "",
                             bool IsNonNull = false) {
    if (V->getType() == DestTy)
      return V;
    if (Value *Folded = Folder.FoldCast(Instruction::AddrSpaceCast, V, DestTy))
      return Folded;
    Instruction *I = Insert(new AddrSpaceCastInst(V, DestTy), Name);
    if (IsNonNull)
      cast<AddrSpaceCastInst>(I)->setNonNull();
    return I;
  }
 
  Value *CreateZExtOrBitCast(Value *V, Type *DestTy, const Twine &Name = "") {
    Instruction::CastOps CastOp =
        V->getType()->getScalarSizeInBits() == DestTy->getScalarSizeInBits()
            ? Instruction::BitCast
            : Instruction::ZExt;
    return CreateCast(CastOp, V, DestTy, Name);
  }
 
  Value *CreateSExtOrBitCast(Value *V, Type *DestTy, const Twine &Name = "") {
    Instruction::CastOps CastOp =
        V->getType()->getScalarSizeInBits() == DestTy->getScalarSizeInBits()
            ? Instruction::BitCast
            : Instruction::SExt;
    return CreateCast(CastOp, V, DestTy, Name);
  }
 
  Value *CreateTruncOrBitCast(Value *V, Type *DestTy, const Twine &Name = "") {
    Instruction::CastOps CastOp =
        V->getType()->getScalarSizeInBits() == DestTy->getScalarSizeInBits()
            ? Instruction::BitCast
            : Instruction::Trunc;
    return CreateCast(CastOp, V, DestTy, Name);
  }
 
  Value *CreateCast(Instruction::CastOps Op, Value *V, Type *DestTy,
                    const Twine &Name = "", MDNode *FPMathTag = nullptr,
                    FMFSource FMFSource = {}) {
    if (V->getType() == DestTy)
      return V;
    if (Value *Folded = Folder.FoldCast(Op, V, DestTy))
      return Folded;
    Instruction *Cast = CastInst::Create(Op, V, DestTy);
    if (isa<FPMathOperator>(Cast))
      setFPAttrs(Cast, FPMathTag, FMFSource.get(FMF));
    return Insert(Cast, Name);
  }
 
  Value *CreatePointerCast(Value *V, Type *DestTy,
                           const Twine &Name = "") {
    if (V->getType() == DestTy)
      return V;
    if (auto *VC = dyn_cast<Constant>(V))
      return Insert(Folder.CreatePointerCast(VC, DestTy), Name);
    return Insert(CastInst::CreatePointerCast(V, DestTy), Name);
  }
 
  // With opaque pointers enabled, this can be substituted with
  // CreateAddrSpaceCast.
  // TODO: Replace uses of this method and remove the method itself.
  Value *CreatePointerBitCastOrAddrSpaceCast(Value *V, Type *DestTy,
                                             const Twine &Name = "") {
    if (V->getType() == DestTy)
      return V;
 
    if (auto *VC = dyn_cast<Constant>(V)) {
      return Insert(Folder.CreatePointerBitCastOrAddrSpaceCast(VC, DestTy),
                    Name);
    }
 
    return Insert(CastInst::CreatePointerBitCastOrAddrSpaceCast(V, DestTy),
                  Name);
  }
 
  Value *CreateIntCast(Value *V, Type *DestTy, bool isSigned,
                       const Twine &Name = "") {
    Instruction::CastOps CastOp =
        V->getType()->getScalarSizeInBits() > DestTy->getScalarSizeInBits()
            ? Instruction::Trunc
            : (isSigned ? Instruction::SExt : Instruction::ZExt);
    return CreateCast(CastOp, V, DestTy, Name);
  }
 
  Value *CreateBitOrPointerCast(Value *V, Type *DestTy,
                                const Twine &Name = "") {
    if (V->getType() == DestTy)
      return V;
    if (V->getType()->isPtrOrPtrVectorTy() && DestTy->isIntOrIntVectorTy())
      return CreatePtrToInt(V, DestTy, Name);
    if (V->getType()->isIntOrIntVectorTy() && DestTy->isPtrOrPtrVectorTy())
      return CreateIntToPtr(V, DestTy, Name);
 
    return CreateBitCast(V, DestTy, Name);
  }
 
  Value *CreateFPCast(Value *V, Type *DestTy, const Twine &Name = "",
                      MDNode *FPMathTag = nullptr) {
    Instruction::CastOps CastOp =
        V->getType()->getScalarSizeInBits() > DestTy->getScalarSizeInBits()
            ? Instruction::FPTrunc
            : Instruction::FPExt;
    return CreateCast(CastOp, V, DestTy, Name, FPMathTag);
  }
 
  LLVM_ABI CallInst *CreateConstrainedFPCast(
      Intrinsic::ID ID, Value *V, Type *DestTy, FMFSource FMFSource = {},
      const Twine &Name = "", MDNode *FPMathTag = nullptr,
      std::optional<RoundingMode> Rounding = std::nullopt,
      std::optional<fp::ExceptionBehavior> Except = std::nullopt);
 
  // Provided to resolve 'CreateIntCast(Ptr, Ptr, "...")', giving a
  // compile time error, instead of converting the string to bool for the
  // isSigned parameter.
  Value *CreateIntCast(Value *, Type *, const char *) = delete;
 
  /// Cast between aggregate types that must have identical structure but may
  /// differ in their leaf types. The leaf values are recursively extracted,
  /// casted, and then reinserted into a value of type DestTy. The leaf types
  /// must be castable using a bitcast or ptrcast, because signedness is
  /// not specified.
  LLVM_ABI Value *CreateAggregateCast(Value *V, Type *DestTy);
 
  /// Create a chain of casts to convert V to NewTy, preserving the bit pattern
  /// of V. This may involve multiple casts (e.g., ptr -> i64 -> <2 x i32>).
  /// The created cast instructions are inserted into the current basic block.
  /// If no casts are needed, V is returned.
  LLVM_ABI Value *CreateBitPreservingCastChain(const DataLayout &DL, Value *V,
                                               Type *NewTy);
 
  //===--------------------------------------------------------------------===//
  // Instruction creation methods: Compare Instructions
  //===--------------------------------------------------------------------===//
 
  Value *CreateICmpEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_EQ, LHS, RHS, Name);
  }
 
  Value *CreateICmpNE(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_NE, LHS, RHS, Name);
  }
 
  Value *CreateICmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_UGT, LHS, RHS, Name);
  }
 
  Value *CreateICmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_UGE, LHS, RHS, Name);
  }
 
  Value *CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_ULT, LHS, RHS, Name);
  }
 
  Value *CreateICmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_ULE, LHS, RHS, Name);
  }
 
  Value *CreateICmpSGT(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_SGT, LHS, RHS, Name);
  }
 
  Value *CreateICmpSGE(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_SGE, LHS, RHS, Name);
  }
 
  Value *CreateICmpSLT(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_SLT, LHS, RHS, Name);
  }
 
  Value *CreateICmpSLE(Value *LHS, Value *RHS, const Twine &Name = "") {
    return CreateICmp(ICmpInst::ICMP_SLE, LHS, RHS, Name);
  }
 
  Value *CreateFCmpOEQ(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_OEQ, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpOGT(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_OGT, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpOGE(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_OGE, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpOLT(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_OLT, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpOLE(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_OLE, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpONE(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_ONE, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpORD(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_ORD, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpUNO(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_UNO, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpUEQ(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_UEQ, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpUGT(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_UGT, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpUGE(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_UGE, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpULT(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_ULT, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpULE(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_ULE, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateFCmpUNE(Value *LHS, Value *RHS, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmp(FCmpInst::FCMP_UNE, LHS, RHS, Name, FPMathTag);
  }
 
  Value *CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
                    const Twine &Name = "") {
    if (auto *V = Folder.FoldCmp(P, LHS, RHS))
      return V;
    return Insert(new ICmpInst(P, LHS, RHS), Name);
  }
 
  // Create a quiet floating-point comparison (i.e. one that raises an FP
  // exception only in the case where an input is a signaling NaN).
  // Note that this differs from CreateFCmpS only if IsFPConstrained is true.
  Value *CreateFCmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
                    const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    return CreateFCmpHelper(P, LHS, RHS, Name, FPMathTag, {}, false);
  }
 
  // Create a quiet floating-point comparison (i.e. one that raises an FP
  // exception only in the case where an input is a signaling NaN).
  // Note that this differs from CreateFCmpS only if IsFPConstrained is true.
  Value *CreateFCmpFMF(CmpInst::Predicate P, Value *LHS, Value *RHS,
                       FMFSource FMFSource, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateFCmpHelper(P, LHS, RHS, Name, FPMathTag, FMFSource, false);
  }
 
  Value *CreateCmp(CmpInst::Predicate Pred, Value *LHS, Value *RHS,
                   const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    return CmpInst::isFPPredicate(Pred)
               ? CreateFCmp(Pred, LHS, RHS, Name, FPMathTag)
               : CreateICmp(Pred, LHS, RHS, Name);
  }
 
  // Create a signaling floating-point comparison (i.e. one that raises an FP
  // exception whenever an input is any NaN, signaling or quiet).
  // Note that this differs from CreateFCmp only if IsFPConstrained is true.
  Value *CreateFCmpS(CmpInst::Predicate P, Value *LHS, Value *RHS,
                     const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    return CreateFCmpHelper(P, LHS, RHS, Name, FPMathTag, {}, true);
  }
 
private:
  // Helper routine to create either a signaling or a quiet FP comparison.
  LLVM_ABI Value *CreateFCmpHelper(CmpInst::Predicate P, Value *LHS, Value *RHS,
                                   const Twine &Name, MDNode *FPMathTag,
                                   FMFSource FMFSource, bool IsSignaling);
 
public:
  LLVM_ABI CallInst *CreateConstrainedFPCmp(
      Intrinsic::ID ID, CmpInst::Predicate P, Value *L, Value *R,
      const Twine &Name = "",
      std::optional<fp::ExceptionBehavior> Except = std::nullopt);
 
  //===--------------------------------------------------------------------===//
  // Instruction creation methods: Other Instructions
  //===--------------------------------------------------------------------===//
 
  PHINode *CreatePHI(Type *Ty, unsigned NumReservedValues,
                     const Twine &Name = "") {
    PHINode *Phi = PHINode::Create(Ty, NumReservedValues);
    if (isa<FPMathOperator>(Phi))
      setFPAttrs(Phi, nullptr /* MDNode* */, FMF);
    return Insert(Phi, Name);
  }
 
private:
  CallInst *createCallHelper(Function *Callee, ArrayRef<Value *> Ops,
                             const Twine &Name = "", FMFSource FMFSource = {},
                             ArrayRef<OperandBundleDef> OpBundles = {});
 
public:
  CallInst *CreateCall(FunctionType *FTy, Value *Callee,
                       ArrayRef<Value *> Args = {}, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    CallInst *CI = CallInst::Create(FTy, Callee, Args, DefaultOperandBundles);
    if (IsFPConstrained)
      setConstrainedFPCallAttr(CI);
    if (isa<FPMathOperator>(CI))
      setFPAttrs(CI, FPMathTag, FMF);
    return Insert(CI, Name);
  }
 
  CallInst *CreateCall(FunctionType *FTy, Value *Callee, ArrayRef<Value *> Args,
                       FMFSource FMFSource, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateCall(FTy, Callee, Args, DefaultOperandBundles, FMFSource, Name,
                      FPMathTag);
  }
 
  CallInst *CreateCall(FunctionType *FTy, Value *Callee, ArrayRef<Value *> Args,
                       ArrayRef<OperandBundleDef> OpBundles,
                       const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    CallInst *CI = CallInst::Create(FTy, Callee, Args, OpBundles);
    if (IsFPConstrained)
      setConstrainedFPCallAttr(CI);
    if (isa<FPMathOperator>(CI))
      setFPAttrs(CI, FPMathTag, FMF);
    return Insert(CI, Name);
  }
 
  CallInst *CreateCall(FunctionType *FTy, Value *Callee, ArrayRef<Value *> Args,
                       ArrayRef<OperandBundleDef> OpBundles,
                       FMFSource FMFSource, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    CallInst *CI = CallInst::Create(FTy, Callee, Args, OpBundles);
    if (IsFPConstrained)
      setConstrainedFPCallAttr(CI);
    if (isa<FPMathOperator>(CI))
      setFPAttrs(CI, FPMathTag, FMFSource.get(FMF));
    return Insert(CI, Name);
  }
 
  CallInst *CreateCall(FunctionCallee Callee, ArrayRef<Value *> Args = {},
                       const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    return CreateCall(Callee.getFunctionType(), Callee.getCallee(), Args, Name,
                      FPMathTag);
  }
 
  CallInst *CreateCall(FunctionCallee Callee, ArrayRef<Value *> Args,
                       FMFSource FMFSource, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateCall(Callee.getFunctionType(), Callee.getCallee(), Args,
                      FMFSource, Name, FPMathTag);
  }
 
  CallInst *CreateCall(FunctionCallee Callee, ArrayRef<Value *> Args,
                       ArrayRef<OperandBundleDef> OpBundles,
                       const Twine &Name = "", MDNode *FPMathTag = nullptr) {
    return CreateCall(Callee.getFunctionType(), Callee.getCallee(), Args,
                      OpBundles, Name, FPMathTag);
  }
 
  CallInst *CreateCall(FunctionCallee Callee, ArrayRef<Value *> Args,
                       ArrayRef<OperandBundleDef> OpBundles,
                       FMFSource FMFSource, const Twine &Name = "",
                       MDNode *FPMathTag = nullptr) {
    return CreateCall(Callee.getFunctionType(), Callee.getCallee(), Args,
                      OpBundles, FMFSource, Name, FPMathTag);
  }
 
  LLVM_ABI CallInst *CreateConstrainedFPCall(
      Function *Callee, ArrayRef<Value *> Args, const Twine &Name = "",
      std::optional<RoundingMode> Rounding = std::nullopt,
      std::optional<fp::ExceptionBehavior> Except = std::nullopt);
 
  LLVM_ABI Value *CreateSelectWithUnknownProfile(Value *C, Value *True,
                                                 Value *False,
                                                 StringRef PassName,
                                                 const Twine &Name = "");
 
  LLVM_ABI Value *CreateSelectFMFWithUnknownProfile(Value *C, Value *True,
                                                    Value *False,
                                                    FMFSource FMFSource,
                                                    StringRef PassName,
                                                    const Twine &Name = "");
 
  LLVM_ABI Value *CreateSelect(Value *C, Value *True, Value *False,
                               const Twine &Name = "",
                               Instruction *MDFrom = nullptr);
  LLVM_ABI Value *CreateSelectFMF(Value *C, Value *True, Value *False,
                                  FMFSource FMFSource, const Twine &Name = "",
                                  Instruction *MDFrom = nullptr);
 
  VAArgInst *CreateVAArg(Value *List, Type *Ty, const Twine &Name = "") {
    return Insert(new VAArgInst(List, Ty), Name);
  }
 
  Value *CreateExtractElement(Value *Vec, Value *Idx,
                              const Twine &Name = "") {
    if (Value *V = Folder.FoldExtractElement(Vec, Idx))
      return V;
    return Insert(ExtractElementInst::Create(Vec, Idx), Name);
  }
 
  Value *CreateExtractElement(Value *Vec, uint64_t Idx,
                              const Twine &Name = "") {
    return CreateExtractElement(Vec, getInt64(Idx), Name);
  }
 
  Value *CreateInsertElement(Type *VecTy, Value *NewElt, Value *Idx,
                             const Twine &Name = "") {
    return CreateInsertElement(PoisonValue::get(VecTy), NewElt, Idx, Name);
  }
 
  Value *CreateInsertElement(Type *VecTy, Value *NewElt, uint64_t Idx,
                             const Twine &Name = "") {
    return CreateInsertElement(PoisonValue::get(VecTy), NewElt, Idx, Name);
  }
 
  Value *CreateInsertElement(Value *Vec, Value *NewElt, Value *Idx,
                             const Twine &Name = "") {
    if (Value *V = Folder.FoldInsertElement(Vec, NewElt, Idx))
      return V;
    return Insert(InsertElementInst::Create(Vec, NewElt, Idx), Name);
  }
 
  Value *CreateInsertElement(Value *Vec, Value *NewElt, uint64_t Idx,
                             const Twine &Name = "") {
    return CreateInsertElement(Vec, NewElt, getInt64(Idx), Name);
  }
 
  Value *CreateShuffleVector(Value *V1, Value *V2, Value *Mask,
                             const Twine &Name = "") {
    SmallVector<int, 16> IntMask;
    ShuffleVectorInst::getShuffleMask(cast<Constant>(Mask), IntMask);
    return CreateShuffleVector(V1, V2, IntMask, Name);
  }
 
  /// See class ShuffleVectorInst for a description of the mask representation.
  Value *CreateShuffleVector(Value *V1, Value *V2, ArrayRef<int> Mask,
                             const Twine &Name = "") {
    if (Value *V = Folder.FoldShuffleVector(V1, V2, Mask))
      return V;
    return Insert(new ShuffleVectorInst(V1, V2, Mask), Name);
  }
 
  /// Create a unary shuffle. The second vector operand of the IR instruction
  /// is poison.
  Value *CreateShuffleVector(Value *V, ArrayRef<int> Mask,
                             const Twine &Name = "") {
    return CreateShuffleVector(V, PoisonValue::get(V->getType()), Mask, Name);
  }
 
  LLVM_ABI Value *CreateVectorInterleave(ArrayRef<Value *> Ops,
                                         const Twine &Name = "");
 
  Value *CreateExtractValue(Value *Agg, ArrayRef<unsigned> Idxs,
                            const Twine &Name = "") {
    if (auto *V = Folder.FoldExtractValue(Agg, Idxs))
      return V;
    return Insert(ExtractValueInst::Create(Agg, Idxs), Name);
  }
 
  Value *CreateInsertValue(Value *Agg, Value *Val, ArrayRef<unsigned> Idxs,
                           const Twine &Name = "") {
    if (auto *V = Folder.FoldInsertValue(Agg, Val, Idxs))
      return V;
    return Insert(InsertValueInst::Create(Agg, Val, Idxs), Name);
  }
 
  LandingPadInst *CreateLandingPad(Type *Ty, unsigned NumClauses,
                                   const Twine &Name = "") {
    return Insert(LandingPadInst::Create(Ty, NumClauses), Name);
  }
 
  Value *CreateFreeze(Value *V, const Twine &Name = "") {
    return Insert(new FreezeInst(V), Name);
  }
 
  Value *CreateBitInsert(Value *Base, Value *Val, Value *Offset,
                         const Twine &Name = "") {
    if (Value *V = Folder.FoldBitInsert(Base, Val, Offset))
      return V;
    return Insert(BitInsertInst::Create(Base, Val, Offset), Name);
  }
 
  Value *CreateBitExtract(Type *Ty, Value *Src, Value *Offset,
                          const Twine &Name = "") {
    if (Value *V = Folder.FoldBitExtract(Ty, Src, Offset))
      return V;
    return Insert(BitExtractInst::Create(Ty, Src, Offset), Name);
  }
 
  //===--------------------------------------------------------------------===//
  // Utility creation methods
  //===--------------------------------------------------------------------===//
 
  /// Return a boolean value testing if \p Arg == 0.
  Value *CreateIsNull(Value *Arg, const Twine &Name = "") {
    return CreateICmpEQ(Arg, Constant::getNullValue(Arg->getType()), Name);
  }
 
  /// Return a boolean value testing if \p Arg != 0.
  Value *CreateIsNotNull(Value *Arg, const Twine &Name = "") {
    return CreateICmpNE(Arg, Constant::getNullValue(Arg->getType()), Name);
  }
 
  /// Return a boolean value testing if \p Arg < 0.
  Value *CreateIsNeg(Value *Arg, const Twine &Name = "") {
    return CreateICmpSLT(Arg, ConstantInt::getNullValue(Arg->getType()), Name);
  }
 
  /// Return a boolean value testing if \p Arg > -1.
  Value *CreateIsNotNeg(Value *Arg, const Twine &Name = "") {
    return CreateICmpSGT(Arg, ConstantInt::getAllOnesValue(Arg->getType()),
                         Name);
  }
 
  /// Return the difference between two pointer values. The returned value
  /// type is the address type of the pointers.
  LLVM_ABI Value *CreatePtrDiff(Value *LHS, Value *RHS, const Twine &Name = "",
                                bool IsNUW = false);
 
  /// Return the difference between two pointer values, dividing out the size
  /// of the pointed-to objects. The returned value type is the address type
  /// of the pointers.
  ///
  /// This is intended to implement C-style pointer subtraction. As such, the
  /// pointers must be appropriately aligned for their element types and
  /// pointing into the same object.
  LLVM_ABI Value *CreatePtrDiff(Type *ElemTy, Value *LHS, Value *RHS,
                                const Twine &Name = "");
 
  /// Create a launder.invariant.group intrinsic call. If Ptr type is
  /// different from pointer to i8, it's casted to pointer to i8 in the same
  /// address space before call and casted back to Ptr type after call.
  LLVM_ABI Value *CreateLaunderInvariantGroup(Value *Ptr);
 
  /// Return a vector value that contains the vector V reversed
  LLVM_ABI Value *CreateVectorReverse(Value *V, const Twine &Name = "");
 
  /// Create a vector.splice.left intrinsic call, or a shufflevector that
  /// produces the same result if the result type is a fixed-length vector and
  /// \p Offset is a constant.
  LLVM_ABI Value *CreateVectorSpliceLeft(Value *V1, Value *V2, Value *Offset,
                                         const Twine &Name = "");
 
  Value *CreateVectorSpliceLeft(Value *V1, Value *V2, uint32_t Offset,
                                const Twine &Name = "") {
    return CreateVectorSpliceLeft(V1, V2, getInt32(Offset), Name);
  }
 
  /// Create a vector.splice.right intrinsic call, or a shufflevector that
  /// produces the same result if the result type is a fixed-length vector and
  /// \p Offset is a constant.
  LLVM_ABI Value *CreateVectorSpliceRight(Value *V1, Value *V2, Value *Offset,
                                          const Twine &Name = "");
 
  Value *CreateVectorSpliceRight(Value *V1, Value *V2, uint32_t Offset,
                                 const Twine &Name = "") {
    return CreateVectorSpliceRight(V1, V2, getInt32(Offset), Name);
  }
 
  /// Return a vector value that contains \arg V broadcasted to \p
  /// NumElts elements.
  LLVM_ABI Value *CreateVectorSplat(unsigned NumElts, Value *V,
                                    const Twine &Name = "");
 
  /// Return a vector value that contains \arg V broadcasted to \p
  /// EC elements.
  LLVM_ABI Value *CreateVectorSplat(ElementCount EC, Value *V,
                                    const Twine &Name = "");
 
  LLVM_ABI Value *CreatePreserveArrayAccessIndex(Type *ElTy, Value *Base,
                                                 unsigned Dimension,
                                                 unsigned LastIndex,
                                                 MDNode *DbgInfo);
 
  LLVM_ABI Value *CreatePreserveUnionAccessIndex(Value *Base,
                                                 unsigned FieldIndex,
                                                 MDNode *DbgInfo);
 
  LLVM_ABI Value *CreatePreserveStructAccessIndex(Type *ElTy, Value *Base,
                                                  unsigned Index,
                                                  unsigned FieldIndex,
                                                  MDNode *DbgInfo);
 
  LLVM_ABI Value *createIsFPClass(Value *FPNum, unsigned Test);
 
private:
  /// Helper function that creates an assume intrinsic call that
  /// represents an alignment assumption on the provided pointer \p PtrValue
  /// with offset \p OffsetValue and alignment value \p AlignValue.
  CallInst *CreateAlignmentAssumptionHelper(const DataLayout &DL,
                                            Value *PtrValue, Value *AlignValue,
                                            Value *OffsetValue);
 
public:
  /// Create an assume intrinsic call that represents an alignment
  /// assumption on the provided pointer.
  ///
  /// An optional offset can be provided, and if it is provided, the offset
  /// must be subtracted from the provided pointer to get the pointer with the
  /// specified alignment.
  LLVM_ABI CallInst *CreateAlignmentAssumption(const DataLayout &DL,
                                               Value *PtrValue,
                                               uint64_t Alignment,
                                               Value *OffsetValue = nullptr);
 
  /// Create an assume intrinsic call that represents an alignment
  /// assumption on the provided pointer.
  ///
  /// An optional offset can be provided, and if it is provided, the offset
  /// must be subtracted from the provided pointer to get the pointer with the
  /// specified alignment.
  ///
  /// This overload handles the condition where the Alignment is dependent
  /// on an existing value rather than a static value.
  LLVM_ABI CallInst *CreateAlignmentAssumption(const DataLayout &DL,
                                               Value *PtrValue,
                                               Value *Alignment,
                                               Value *OffsetValue = nullptr);
 
  /// Create an assume intrinsic call that represents a dereferencable
  /// assumption on the provided pointer.
  LLVM_ABI CallInst *CreateDereferenceableAssumption(Value *PtrValue,
                                                     Value *SizeValue);
 
  /// Create an assume intrinsic call that represents a nonnull assumption on
  /// the provided pointer.
  LLVM_ABI CallInst *CreateNonnullAssumption(Value *PtrValue);
};
 
/// This provides a uniform API for creating instructions and inserting
/// them into a basic block: either at the end of a BasicBlock, or at a specific
/// iterator location in a block.
///
/// Note that the builder does not expose the full generality of LLVM
/// instructions.  For access to extra instruction properties, use the mutators
/// (e.g. setVolatile) on the instructions after they have been
/// created. Convenience state exists to specify fast-math flags and fp-math
/// tags.
///
/// The first template argument specifies a class to use for creating constants.
/// This defaults to creating minimally folded constants.  The second template
/// argument allows clients to specify custom insertion hooks that are called on
/// every newly created insertion.
template <typename FolderTy = ConstantFolder,
          typename InserterTy = IRBuilderDefaultInserter>
class IRBuilder : public IRBuilderBase {
private:
  FolderTy Folder;
  InserterTy Inserter;
 
  static void CallInsertHelper(const IRBuilderBase &IRB, Instruction *I,
                               const Twine &Name,
                               BasicBlock::iterator InsertPt) {
    static_cast<const IRBuilder *>(&IRB)->Inserter.InsertHelper(I, Name,
                                                                InsertPt);
  }
 
public:
  [[deprecated("Use the overload taking Module instead")]]
  IRBuilder(LLVMContext &C, FolderTy Folder, InserterTy Inserter)
      : IRBuilderBase(C, this->Folder, CallInsertHelper), Folder(Folder),
        Inserter(Inserter) {}
 
  [[deprecated("Use the overload taking Module instead")]]
  IRBuilder(LLVMContext &C, FolderTy Folder)
      : IRBuilderBase(C, this->Folder, CallInsertHelper), Folder(Folder) {}
 
  [[deprecated("Use the overload taking Module instead")]]
  explicit IRBuilder(LLVMContext &C)
      : IRBuilderBase(C, this->Folder, CallInsertHelper) {}
 
  IRBuilder(Module &M, FolderTy Folder, InserterTy Inserter)
      : IRBuilderBase(M.getContext(), this->Folder, CallInsertHelper),
        Folder(Folder), Inserter(Inserter) {}
 
  IRBuilder(Module &M, FolderTy Folder)
      : IRBuilderBase(M.getContext(), this->Folder, CallInsertHelper),
        Folder(Folder) {}
 
  explicit IRBuilder(Module &M)
      : IRBuilderBase(M.getContext(), this->Folder, CallInsertHelper) {}
 
  explicit IRBuilder(BasicBlock *TheBB, FolderTy Folder)
      : IRBuilderBase(TheBB->getContext(), this->Folder, CallInsertHelper),
        Folder(Folder) {
    SetInsertPoint(TheBB);
  }
 
  explicit IRBuilder(BasicBlock *TheBB)
      : IRBuilderBase(TheBB->getContext(), this->Folder, CallInsertHelper) {
    SetInsertPoint(TheBB);
  }
 
  explicit IRBuilder(Instruction *IP)
      : IRBuilderBase(IP->getContext(), this->Folder, CallInsertHelper) {
    SetInsertPoint(IP);
  }
 
  [[deprecated("Use the overload without BasicBlock argument instead")]]
  IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP, FolderTy Folder)
      : IRBuilderBase(TheBB->getContext(), this->Folder, CallInsertHelper),
        Folder(Folder) {
    SetInsertPoint(IP);
  }
 
  [[deprecated("Use the overload without BasicBlock argument instead")]]
  IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP)
      : IRBuilderBase(TheBB->getContext(), this->Folder, CallInsertHelper) {
    SetInsertPoint(IP);
  }
 
  IRBuilder(BasicBlock::iterator IP, FolderTy Folder, InserterTy Inserter)
      : IRBuilderBase(IP.getNodeParent()->getContext(), this->Folder,
                      CallInsertHelper),
        Folder(Folder), Inserter(Inserter) {
    SetInsertPoint(IP);
  }
 
  IRBuilder(BasicBlock::iterator IP, FolderTy Folder)
      : IRBuilderBase(IP.getNodeParent()->getContext(), this->Folder,
                      CallInsertHelper),
        Folder(Folder) {
    SetInsertPoint(IP);
  }
 
  explicit IRBuilder(BasicBlock::iterator IP)
      : IRBuilderBase(IP.getNodeParent()->getContext(), this->Folder,
                      CallInsertHelper) {
    SetInsertPoint(IP);
  }
 
  /// Avoid copying the full IRBuilder. Prefer using InsertPointGuard
  /// or FastMathFlagGuard instead.
  IRBuilder(const IRBuilder &) = delete;
 
  InserterTy &getInserter() { return Inserter; }
  const InserterTy &getInserter() const { return Inserter; }
};
 
template <typename FolderTy, typename InserterTy>
IRBuilder(LLVMContext &, FolderTy, InserterTy)
    -> IRBuilder<FolderTy, InserterTy>;
IRBuilder(LLVMContext &) -> IRBuilder<>;
template <typename FolderTy, typename InserterTy>
IRBuilder(Module &, FolderTy, InserterTy) -> IRBuilder<FolderTy, InserterTy>;
template <typename FolderTy>
IRBuilder(Module &, FolderTy) -> IRBuilder<FolderTy>;
IRBuilder(Module &) -> IRBuilder<>;
template <typename FolderTy>
IRBuilder(BasicBlock *, FolderTy) -> IRBuilder<FolderTy>;
IRBuilder(BasicBlock *) -> IRBuilder<>;
IRBuilder(Instruction *) -> IRBuilder<>;
template <typename FolderTy>
IRBuilder(BasicBlock *, BasicBlock::iterator, FolderTy) -> IRBuilder<FolderTy>;
IRBuilder(BasicBlock *, BasicBlock::iterator) -> IRBuilder<>;
template <typename FolderTy, typename InserterTy>
IRBuilder(BasicBlock::iterator, FolderTy, InserterTy)
    -> IRBuilder<FolderTy, InserterTy>;
template <typename FolderTy>
IRBuilder(BasicBlock::iterator, FolderTy) -> IRBuilder<FolderTy>;
IRBuilder(BasicBlock::iterator) -> IRBuilder<>;
 
/// Unwrap C API builder reference.
LLVM_ABI IRBuilder<> *unwrap(LLVMBuilderRef Ref);
 
} // end namespace llvm
 
#endif // LLVM_IR_IRBUILDER_H