include/llvm/IR/IRBuilder.h

   1 //===---- llvm/IRBuilder.h - Builder for LLVM Instructions ------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file defines the IRBuilder class, which is used as a convenient way
  11 // to create LLVM instructions with a consistent and simplified interface.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_IR_IRBUILDER_H
  16 #define LLVM_IR_IRBUILDER_H
  17
  18 #include "llvm/ADT/ArrayRef.h"
  19 #include "llvm/ADT/StringRef.h"
  20 #include "llvm/ADT/Twine.h"
  21 #include "llvm/IR/BasicBlock.h"
  22 #include "llvm/IR/ConstantFolder.h"
  23 #include "llvm/IR/DataLayout.h"
  24 #include "llvm/IR/Instructions.h"
  25 #include "llvm/IR/LLVMContext.h"
  26 #include "llvm/IR/Operator.h"
  27 #include "llvm/IR/ValueHandle.h"
  28 #include "llvm/Support/CBindingWrapping.h"
  29
  30 namespace llvm {
  31   class MDNode;
  32
  33 /// \brief This provides the default implementation of the IRBuilder
  34 /// 'InsertHelper' method that is called whenever an instruction is created by
  35 /// IRBuilder and needs to be inserted.
  36 ///
  37 /// By default, this inserts the instruction at the insertion point.
  38 template <bool preserveNames = true>
  39 class IRBuilderDefaultInserter {
  40 protected:
  41   void InsertHelper(Instruction *I, const Twine &Name,
  42                     BasicBlock *BB, BasicBlock::iterator InsertPt) const {
  43     if (BB) BB->getInstList().insert(InsertPt, I);
  44     if (preserveNames)
  45       I->setName(Name);
  46   }
  47 };
  48
  49 /// \brief Common base class shared among various IRBuilders.
  50 class IRBuilderBase {
  51   DebugLoc CurDbgLocation;
  52 protected:
  53   BasicBlock *BB;
  54   BasicBlock::iterator InsertPt;
  55   LLVMContext &Context;
  56
  57   MDNode *DefaultFPMathTag;
  58   FastMathFlags FMF;
  59 public:
  60
  61   IRBuilderBase(LLVMContext &context, MDNode *FPMathTag = nullptr)
  62     : Context(context), DefaultFPMathTag(FPMathTag), FMF() {
  63     ClearInsertionPoint();
  64   }
  65
  66   //===--------------------------------------------------------------------===//
  67   // Builder configuration methods
  68   //===--------------------------------------------------------------------===//
  69
  70   /// \brief Clear the insertion point: created instructions will not be
  71   /// inserted into a block.
  72   void ClearInsertionPoint() {
  73     BB = nullptr;
  74     InsertPt = nullptr;
  75   }
  76
  77   BasicBlock *GetInsertBlock() const { return BB; }
  78   BasicBlock::iterator GetInsertPoint() const { return InsertPt; }
  79   LLVMContext &getContext() const { return Context; }
  80
  81   /// \brief This specifies that created instructions should be appended to the
  82   /// end of the specified block.
  83   void SetInsertPoint(BasicBlock *TheBB) {
  84     BB = TheBB;
  85     InsertPt = BB->end();
  86   }
  87
  88   /// \brief This specifies that created instructions should be inserted before
  89   /// the specified instruction.
  90   void SetInsertPoint(Instruction *I) {
  91     BB = I->getParent();
  92     InsertPt = I;
  93     assert(I != BB->end() && "Can't read debug loc from end()");
  94     SetCurrentDebugLocation(I->getDebugLoc());
  95   }
  96
  97   /// \brief This specifies that created instructions should be inserted at the
  98   /// specified point.
  99   void SetInsertPoint(BasicBlock *TheBB, BasicBlock::iterator IP) {
 100     BB = TheBB;
 101     InsertPt = IP;
 102   }
 103
 104   /// \brief Find the nearest point that dominates this use, and specify that
 105   /// created instructions should be inserted at this point.
 106   void SetInsertPoint(Use &U) {
 107     Instruction *UseInst = cast<Instruction>(U.getUser());
 108     if (PHINode *Phi = dyn_cast<PHINode>(UseInst)) {
 109       BasicBlock *PredBB = Phi->getIncomingBlock(U);
 110       assert(U != PredBB->getTerminator() && "critical edge not split");
 111       SetInsertPoint(PredBB, PredBB->getTerminator());
 112       return;
 113     }
 114     SetInsertPoint(UseInst);
 115   }
 116
 117   /// \brief Set location information used by debugging information.
 118   void SetCurrentDebugLocation(const DebugLoc &L) {
 119     CurDbgLocation = L;
 120   }
 121
 122   /// \brief Get location information used by debugging information.
 123   DebugLoc getCurrentDebugLocation() const { return CurDbgLocation; }
 124
 125   /// \brief If this builder has a current debug location, set it on the
 126   /// specified instruction.
 127   void SetInstDebugLocation(Instruction *I) const {
 128     if (!CurDbgLocation.isUnknown())
 129       I->setDebugLoc(CurDbgLocation);
 130   }
 131
 132   /// \brief Get the return type of the current function that we're emitting
 133   /// into.
 134   Type *getCurrentFunctionReturnType() const;
 135
 136   /// InsertPoint - A saved insertion point.
 137   class InsertPoint {
 138     BasicBlock *Block;
 139     BasicBlock::iterator Point;
 140
 141   public:
 142     /// \brief Creates a new insertion point which doesn't point to anything.
 143     InsertPoint() : Block(nullptr) {}
 144
 145     /// \brief Creates a new insertion point at the given location.
 146     InsertPoint(BasicBlock *InsertBlock, BasicBlock::iterator InsertPoint)
 147       : Block(InsertBlock), Point(InsertPoint) {}
 148
 149     /// \brief Returns true if this insert point is set.
 150     bool isSet() const { return (Block != nullptr); }
 151
 152     llvm::BasicBlock *getBlock() const { return Block; }
 153     llvm::BasicBlock::iterator getPoint() const { return Point; }
 154   };
 155
 156   /// \brief Returns the current insert point.
 157   InsertPoint saveIP() const {
 158     return InsertPoint(GetInsertBlock(), GetInsertPoint());
 159   }
 160
 161   /// \brief Returns the current insert point, clearing it in the process.
 162   InsertPoint saveAndClearIP() {
 163     InsertPoint IP(GetInsertBlock(), GetInsertPoint());
 164     ClearInsertionPoint();
 165     return IP;
 166   }
 167
 168   /// \brief Sets the current insert point to a previously-saved location.
 169   void restoreIP(InsertPoint IP) {
 170     if (IP.isSet())
 171       SetInsertPoint(IP.getBlock(), IP.getPoint());
 172     else
 173       ClearInsertionPoint();
 174   }
 175
 176   /// \brief Get the floating point math metadata being used.
 177   MDNode *getDefaultFPMathTag() const { return DefaultFPMathTag; }
 178
 179   /// \brief Get the flags to be applied to created floating point ops
 180   FastMathFlags getFastMathFlags() const { return FMF; }
 181
 182   /// \brief Clear the fast-math flags.
 183   void clearFastMathFlags() { FMF.clear(); }
 184
 185   /// \brief Set the floating point math metadata to be used.
 186   void SetDefaultFPMathTag(MDNode *FPMathTag) { DefaultFPMathTag = FPMathTag; }
 187
 188   /// \brief Set the fast-math flags to be used with generated fp-math operators
 189   void SetFastMathFlags(FastMathFlags NewFMF) { FMF = NewFMF; }
 190
 191   //===--------------------------------------------------------------------===//
 192   // RAII helpers.
 193   //===--------------------------------------------------------------------===//
 194
 195   // \brief RAII object that stores the current insertion point and restores it
 196   // when the object is destroyed. This includes the debug location.
 197   class InsertPointGuard {
 198     IRBuilderBase &Builder;
 199     AssertingVH<BasicBlock> Block;
 200     BasicBlock::iterator Point;
 201     DebugLoc DbgLoc;
 202
 203     InsertPointGuard(const InsertPointGuard &) LLVM_DELETED_FUNCTION;
 204     InsertPointGuard &operator=(const InsertPointGuard &) LLVM_DELETED_FUNCTION;
 205
 206   public:
 207     InsertPointGuard(IRBuilderBase &B)
 208         : Builder(B), Block(B.GetInsertBlock()), Point(B.GetInsertPoint()),
 209           DbgLoc(B.getCurrentDebugLocation()) {}
 210
 211     ~InsertPointGuard() {
 212       Builder.restoreIP(InsertPoint(Block, Point));
 213       Builder.SetCurrentDebugLocation(DbgLoc);
 214     }
 215   };
 216
 217   // \brief RAII object that stores the current fast math settings and restores
 218   // them when the object is destroyed.
 219   class FastMathFlagGuard {
 220     IRBuilderBase &Builder;
 221     FastMathFlags FMF;
 222     MDNode *FPMathTag;
 223
 224     FastMathFlagGuard(const FastMathFlagGuard &) LLVM_DELETED_FUNCTION;
 225     FastMathFlagGuard &operator=(
 226         const FastMathFlagGuard &) LLVM_DELETED_FUNCTION;
 227
 228   public:
 229     FastMathFlagGuard(IRBuilderBase &B)
 230         : Builder(B), FMF(B.FMF), FPMathTag(B.DefaultFPMathTag) {}
 231
 232     ~FastMathFlagGuard() {
 233       Builder.FMF = FMF;
 234       Builder.DefaultFPMathTag = FPMathTag;
 235     }
 236   };
 237
 238   //===--------------------------------------------------------------------===//
 239   // Miscellaneous creation methods.
 240   //===--------------------------------------------------------------------===//
 241
 242   /// \brief Make a new global variable with initializer type i8*
 243   ///
 244   /// Make a new global variable with an initializer that has array of i8 type
 245   /// filled in with the null terminated string value specified.  The new global
 246   /// variable will be marked mergable with any others of the same contents.  If
 247   /// Name is specified, it is the name of the global variable created.
 248   Value *CreateGlobalString(StringRef Str, const Twine &Name = "");
 249
 250   /// \brief Get a constant value representing either true or false.
 251   ConstantInt *getInt1(bool V) {
 252     return ConstantInt::get(getInt1Ty(), V);
 253   }
 254
 255   /// \brief Get the constant value for i1 true.
 256   ConstantInt *getTrue() {
 257     return ConstantInt::getTrue(Context);
 258   }
 259
 260   /// \brief Get the constant value for i1 false.
 261   ConstantInt *getFalse() {
 262     return ConstantInt::getFalse(Context);
 263   }
 264
 265   /// \brief Get a constant 8-bit value.
 266   ConstantInt *getInt8(uint8_t C) {
 267     return ConstantInt::get(getInt8Ty(), C);
 268   }
 269
 270   /// \brief Get a constant 16-bit value.
 271   ConstantInt *getInt16(uint16_t C) {
 272     return ConstantInt::get(getInt16Ty(), C);
 273   }
 274
 275   /// \brief Get a constant 32-bit value.
 276   ConstantInt *getInt32(uint32_t C) {
 277     return ConstantInt::get(getInt32Ty(), C);
 278   }
 279
 280   /// \brief Get a constant 64-bit value.
 281   ConstantInt *getInt64(uint64_t C) {
 282     return ConstantInt::get(getInt64Ty(), C);
 283   }
 284
 285   /// \brief Get a constant N-bit value, zero extended or truncated from
 286   /// a 64-bit value.
 287   ConstantInt *getIntN(unsigned N, uint64_t C) {
 288     return ConstantInt::get(getIntNTy(N), C);
 289   }
 290
 291   /// \brief Get a constant integer value.
 292   ConstantInt *getInt(const APInt &AI) {
 293     return ConstantInt::get(Context, AI);
 294   }
 295
 296   //===--------------------------------------------------------------------===//
 297   // Type creation methods
 298   //===--------------------------------------------------------------------===//
 299
 300   /// \brief Fetch the type representing a single bit
 301   IntegerType *getInt1Ty() {
 302     return Type::getInt1Ty(Context);
 303   }
 304
 305   /// \brief Fetch the type representing an 8-bit integer.
 306   IntegerType *getInt8Ty() {
 307     return Type::getInt8Ty(Context);
 308   }
 309
 310   /// \brief Fetch the type representing a 16-bit integer.
 311   IntegerType *getInt16Ty() {
 312     return Type::getInt16Ty(Context);
 313   }
 314
 315   /// \brief Fetch the type representing a 32-bit integer.
 316   IntegerType *getInt32Ty() {
 317     return Type::getInt32Ty(Context);
 318   }
 319
 320   /// \brief Fetch the type representing a 64-bit integer.
 321   IntegerType *getInt64Ty() {
 322     return Type::getInt64Ty(Context);
 323   }
 324
 325   /// \brief Fetch the type representing an N-bit integer.
 326   IntegerType *getIntNTy(unsigned N) {
 327     return Type::getIntNTy(Context, N);
 328   }
 329
 330   /// \brief Fetch the type representing a 16-bit floating point value.
 331   Type *getHalfTy() {
 332     return Type::getHalfTy(Context);
 333   }
 334
 335   /// \brief Fetch the type representing a 32-bit floating point value.
 336   Type *getFloatTy() {
 337     return Type::getFloatTy(Context);
 338   }
 339
 340   /// \brief Fetch the type representing a 64-bit floating point value.
 341   Type *getDoubleTy() {
 342     return Type::getDoubleTy(Context);
 343   }
 344
 345   /// \brief Fetch the type representing void.
 346   Type *getVoidTy() {
 347     return Type::getVoidTy(Context);
 348   }
 349
 350   /// \brief Fetch the type representing a pointer to an 8-bit integer value.
 351   PointerType *getInt8PtrTy(unsigned AddrSpace = 0) {
 352     return Type::getInt8PtrTy(Context, AddrSpace);
 353   }
 354
 355   /// \brief Fetch the type representing a pointer to an integer value.
 356   IntegerType* getIntPtrTy(const DataLayout *DL, unsigned AddrSpace = 0) {
 357     return DL->getIntPtrType(Context, AddrSpace);
 358   }
 359
 360   //===--------------------------------------------------------------------===//
 361   // Intrinsic creation methods
 362   //===--------------------------------------------------------------------===//
 363
 364   /// \brief Create and insert a memset to the specified pointer and the
 365   /// specified value.
 366   ///
 367   /// If the pointer isn't an i8*, it will be converted. If a TBAA tag is
 368   /// specified, it will be added to the instruction. Likewise with alias.scope
 369   /// and noalias tags.
 370   CallInst *CreateMemSet(Value *Ptr, Value *Val, uint64_t Size, unsigned Align,
 371                          bool isVolatile = false, MDNode *TBAATag = nullptr,
 372                          MDNode *ScopeTag = nullptr,
 373                          MDNode *NoAliasTag = nullptr) {
 374     return CreateMemSet(Ptr, Val, getInt64(Size), Align, isVolatile,
 375                         TBAATag, ScopeTag, NoAliasTag);
 376   }
 377
 378   CallInst *CreateMemSet(Value *Ptr, Value *Val, Value *Size, unsigned Align,
 379                          bool isVolatile = false, MDNode *TBAATag = nullptr,
 380                          MDNode *ScopeTag = nullptr,
 381                          MDNode *NoAliasTag = nullptr);
 382
 383   /// \brief Create and insert a memcpy between the specified pointers.
 384   ///
 385   /// If the pointers aren't i8*, they will be converted.  If a TBAA tag is
 386   /// specified, it will be added to the instruction. Likewise with alias.scope
 387   /// and noalias tags.
 388   CallInst *CreateMemCpy(Value *Dst, Value *Src, uint64_t Size, unsigned Align,
 389                          bool isVolatile = false, MDNode *TBAATag = nullptr,
 390                          MDNode *TBAAStructTag = nullptr,
 391                          MDNode *ScopeTag = nullptr,
 392                          MDNode *NoAliasTag = nullptr) {
 393     return CreateMemCpy(Dst, Src, getInt64(Size), Align, isVolatile, TBAATag,
 394                         TBAAStructTag, ScopeTag, NoAliasTag);
 395   }
 396
 397   CallInst *CreateMemCpy(Value *Dst, Value *Src, Value *Size, unsigned Align,
 398                          bool isVolatile = false, MDNode *TBAATag = nullptr,
 399                          MDNode *TBAAStructTag = nullptr,
 400                          MDNode *ScopeTag = nullptr,
 401                          MDNode *NoAliasTag = nullptr);
 402
 403   /// \brief Create and insert a memmove between the specified
 404   /// pointers.
 405   ///
 406   /// If the pointers aren't i8*, they will be converted.  If a TBAA tag is
 407   /// specified, it will be added to the instruction. Likewise with alias.scope
 408   /// and noalias tags.
 409   CallInst *CreateMemMove(Value *Dst, Value *Src, uint64_t Size, unsigned Align,
 410                           bool isVolatile = false, MDNode *TBAATag = nullptr,
 411                           MDNode *ScopeTag = nullptr,
 412                           MDNode *NoAliasTag = nullptr) {
 413     return CreateMemMove(Dst, Src, getInt64(Size), Align, isVolatile,
 414                          TBAATag, ScopeTag, NoAliasTag);
 415   }
 416
 417   CallInst *CreateMemMove(Value *Dst, Value *Src, Value *Size, unsigned Align,
 418                           bool isVolatile = false, MDNode *TBAATag = nullptr,
 419                           MDNode *ScopeTag = nullptr,
 420                           MDNode *NoAliasTag = nullptr);
 421
 422   /// \brief Create a lifetime.start intrinsic.
 423   ///
 424   /// If the pointer isn't i8* it will be converted.
 425   CallInst *CreateLifetimeStart(Value *Ptr, ConstantInt *Size = nullptr);
 426
 427   /// \brief Create a lifetime.end intrinsic.
 428   ///
 429   /// If the pointer isn't i8* it will be converted.
 430   CallInst *CreateLifetimeEnd(Value *Ptr, ConstantInt *Size = nullptr);
 431
 432 private:
 433   Value *getCastedInt8PtrValue(Value *Ptr);
 434 };
 435
 436 /// \brief This provides a uniform API for creating instructions and inserting
 437 /// them into a basic block: either at the end of a BasicBlock, or at a specific
 438 /// iterator location in a block.
 439 ///
 440 /// Note that the builder does not expose the full generality of LLVM
 441 /// instructions.  For access to extra instruction properties, use the mutators
 442 /// (e.g. setVolatile) on the instructions after they have been
 443 /// created. Convenience state exists to specify fast-math flags and fp-math
 444 /// tags.
 445 ///
 446 /// The first template argument handles whether or not to preserve names in the
 447 /// final instruction output. This defaults to on.  The second template argument
 448 /// specifies a class to use for creating constants.  This defaults to creating
 449 /// minimally folded constants.  The third template argument allows clients to
 450 /// specify custom insertion hooks that are called on every newly created
 451 /// insertion.
 452 template<bool preserveNames = true, typename T = ConstantFolder,
 453          typename Inserter = IRBuilderDefaultInserter<preserveNames> >
 454 class IRBuilder : public IRBuilderBase, public Inserter {
 455   T Folder;
 456 public:
 457   IRBuilder(LLVMContext &C, const T &F, const Inserter &I = Inserter(),
 458             MDNode *FPMathTag = nullptr)
 459     : IRBuilderBase(C, FPMathTag), Inserter(I), Folder(F) {
 460   }
 461
 462   explicit IRBuilder(LLVMContext &C, MDNode *FPMathTag = nullptr)
 463     : IRBuilderBase(C, FPMathTag), Folder() {
 464   }
 465
 466   explicit IRBuilder(BasicBlock *TheBB, const T &F, MDNode *FPMathTag = nullptr)
 467     : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
 468     SetInsertPoint(TheBB);
 469   }
 470
 471   explicit IRBuilder(BasicBlock *TheBB, MDNode *FPMathTag = nullptr)
 472     : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
 473     SetInsertPoint(TheBB);
 474   }
 475
 476   explicit IRBuilder(Instruction *IP, MDNode *FPMathTag = nullptr)
 477     : IRBuilderBase(IP->getContext(), FPMathTag), Folder() {
 478     SetInsertPoint(IP);
 479     SetCurrentDebugLocation(IP->getDebugLoc());
 480   }
 481
 482   explicit IRBuilder(Use &U, MDNode *FPMathTag = nullptr)
 483     : IRBuilderBase(U->getContext(), FPMathTag), Folder() {
 484     SetInsertPoint(U);
 485     SetCurrentDebugLocation(cast<Instruction>(U.getUser())->getDebugLoc());
 486   }
 487
 488   IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP, const T& F,
 489             MDNode *FPMathTag = nullptr)
 490     : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder(F) {
 491     SetInsertPoint(TheBB, IP);
 492   }
 493
 494   IRBuilder(BasicBlock *TheBB, BasicBlock::iterator IP,
 495             MDNode *FPMathTag = nullptr)
 496     : IRBuilderBase(TheBB->getContext(), FPMathTag), Folder() {
 497     SetInsertPoint(TheBB, IP);
 498   }
 499
 500   /// \brief Get the constant folder being used.
 501   const T &getFolder() { return Folder; }
 502
 503   /// \brief Return true if this builder is configured to actually add the
 504   /// requested names to IR created through it.
 505   bool isNamePreserving() const { return preserveNames; }
 506
 507   /// \brief Insert and return the specified instruction.
 508   template<typename InstTy>
 509   InstTy *Insert(InstTy *I, const Twine &Name = "") const {
 510     this->InsertHelper(I, Name, BB, InsertPt);
 511     this->SetInstDebugLocation(I);
 512     return I;
 513   }
 514
 515   /// \brief No-op overload to handle constants.
 516   Constant *Insert(Constant *C, const Twine& = "") const {
 517     return C;
 518   }
 519
 520   //===--------------------------------------------------------------------===//
 521   // Instruction creation methods: Terminators
 522   //===--------------------------------------------------------------------===//
 523
 524 private:
 525   /// \brief Helper to add branch weight metadata onto an instruction.
 526   /// \returns The annotated instruction.
 527   template <typename InstTy>
 528   InstTy *addBranchWeights(InstTy *I, MDNode *Weights) {
 529     if (Weights)
 530       I->setMetadata(LLVMContext::MD_prof, Weights);
 531     return I;
 532   }
 533
 534 public:
 535   /// \brief Create a 'ret void' instruction.
 536   ReturnInst *CreateRetVoid() {
 537     return Insert(ReturnInst::Create(Context));
 538   }
 539
 540   /// \brief Create a 'ret <val>' instruction.
 541   ReturnInst *CreateRet(Value *V) {
 542     return Insert(ReturnInst::Create(Context, V));
 543   }
 544
 545   /// \brief Create a sequence of N insertvalue instructions,
 546   /// with one Value from the retVals array each, that build a aggregate
 547   /// return value one value at a time, and a ret instruction to return
 548   /// the resulting aggregate value.
 549   ///
 550   /// This is a convenience function for code that uses aggregate return values
 551   /// as a vehicle for having multiple return values.
 552   ReturnInst *CreateAggregateRet(Value *const *retVals, unsigned N) {
 553     Value *V = UndefValue::get(getCurrentFunctionReturnType());
 554     for (unsigned i = 0; i != N; ++i)
 555       V = CreateInsertValue(V, retVals[i], i, "mrv");
 556     return Insert(ReturnInst::Create(Context, V));
 557   }
 558
 559   /// \brief Create an unconditional 'br label X' instruction.
 560   BranchInst *CreateBr(BasicBlock *Dest) {
 561     return Insert(BranchInst::Create(Dest));
 562   }
 563
 564   /// \brief Create a conditional 'br Cond, TrueDest, FalseDest'
 565   /// instruction.
 566   BranchInst *CreateCondBr(Value *Cond, BasicBlock *True, BasicBlock *False,
 567                            MDNode *BranchWeights = nullptr) {
 568     return Insert(addBranchWeights(BranchInst::Create(True, False, Cond),
 569                                    BranchWeights));
 570   }
 571
 572   /// \brief Create a switch instruction with the specified value, default dest,
 573   /// and with a hint for the number of cases that will be added (for efficient
 574   /// allocation).
 575   SwitchInst *CreateSwitch(Value *V, BasicBlock *Dest, unsigned NumCases = 10,
 576                            MDNode *BranchWeights = nullptr) {
 577     return Insert(addBranchWeights(SwitchInst::Create(V, Dest, NumCases),
 578                                    BranchWeights));
 579   }
 580
 581   /// \brief Create an indirect branch instruction with the specified address
 582   /// operand, with an optional hint for the number of destinations that will be
 583   /// added (for efficient allocation).
 584   IndirectBrInst *CreateIndirectBr(Value *Addr, unsigned NumDests = 10) {
 585     return Insert(IndirectBrInst::Create(Addr, NumDests));
 586   }
 587
 588   InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
 589                            BasicBlock *UnwindDest, const Twine &Name = "") {
 590     return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, None),
 591                   Name);
 592   }
 593   InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
 594                            BasicBlock *UnwindDest, Value *Arg1,
 595                            const Twine &Name = "") {
 596     return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Arg1),
 597                   Name);
 598   }
 599   InvokeInst *CreateInvoke3(Value *Callee, BasicBlock *NormalDest,
 600                             BasicBlock *UnwindDest, Value *Arg1,
 601                             Value *Arg2, Value *Arg3,
 602                             const Twine &Name = "") {
 603     Value *Args[] = { Arg1, Arg2, Arg3 };
 604     return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
 605                   Name);
 606   }
 607   /// \brief Create an invoke instruction.
 608   InvokeInst *CreateInvoke(Value *Callee, BasicBlock *NormalDest,
 609                            BasicBlock *UnwindDest, ArrayRef<Value *> Args,
 610                            const Twine &Name = "") {
 611     return Insert(InvokeInst::Create(Callee, NormalDest, UnwindDest, Args),
 612                   Name);
 613   }
 614
 615   ResumeInst *CreateResume(Value *Exn) {
 616     return Insert(ResumeInst::Create(Exn));
 617   }
 618
 619   UnreachableInst *CreateUnreachable() {
 620     return Insert(new UnreachableInst(Context));
 621   }
 622
 623   //===--------------------------------------------------------------------===//
 624   // Instruction creation methods: Binary Operators
 625   //===--------------------------------------------------------------------===//
 626 private:
 627   BinaryOperator *CreateInsertNUWNSWBinOp(BinaryOperator::BinaryOps Opc,
 628                                           Value *LHS, Value *RHS,
 629                                           const Twine &Name,
 630                                           bool HasNUW, bool HasNSW) {
 631     BinaryOperator *BO = Insert(BinaryOperator::Create(Opc, LHS, RHS), Name);
 632     if (HasNUW) BO->setHasNoUnsignedWrap();
 633     if (HasNSW) BO->setHasNoSignedWrap();
 634     return BO;
 635   }
 636
 637   Instruction *AddFPMathAttributes(Instruction *I,
 638                                    MDNode *FPMathTag,
 639                                    FastMathFlags FMF) const {
 640     if (!FPMathTag)
 641       FPMathTag = DefaultFPMathTag;
 642     if (FPMathTag)
 643       I->setMetadata(LLVMContext::MD_fpmath, FPMathTag);
 644     I->setFastMathFlags(FMF);
 645     return I;
 646   }
 647 public:
 648   Value *CreateAdd(Value *LHS, Value *RHS, const Twine &Name = "",
 649                    bool HasNUW = false, bool HasNSW = false) {
 650     if (Constant *LC = dyn_cast<Constant>(LHS))
 651       if (Constant *RC = dyn_cast<Constant>(RHS))
 652         return Insert(Folder.CreateAdd(LC, RC, HasNUW, HasNSW), Name);
 653     return CreateInsertNUWNSWBinOp(Instruction::Add, LHS, RHS, Name,
 654                                    HasNUW, HasNSW);
 655   }
 656   Value *CreateNSWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
 657     return CreateAdd(LHS, RHS, Name, false, true);
 658   }
 659   Value *CreateNUWAdd(Value *LHS, Value *RHS, const Twine &Name = "") {
 660     return CreateAdd(LHS, RHS, Name, true, false);
 661   }
 662   Value *CreateFAdd(Value *LHS, Value *RHS, const Twine &Name = "",
 663                     MDNode *FPMathTag = nullptr) {
 664     if (Constant *LC = dyn_cast<Constant>(LHS))
 665       if (Constant *RC = dyn_cast<Constant>(RHS))
 666         return Insert(Folder.CreateFAdd(LC, RC), Name);
 667     return Insert(AddFPMathAttributes(BinaryOperator::CreateFAdd(LHS, RHS),
 668                                       FPMathTag, FMF), Name);
 669   }
 670   Value *CreateSub(Value *LHS, Value *RHS, const Twine &Name = "",
 671                    bool HasNUW = false, bool HasNSW = false) {
 672     if (Constant *LC = dyn_cast<Constant>(LHS))
 673       if (Constant *RC = dyn_cast<Constant>(RHS))
 674         return Insert(Folder.CreateSub(LC, RC, HasNUW, HasNSW), Name);
 675     return CreateInsertNUWNSWBinOp(Instruction::Sub, LHS, RHS, Name,
 676                                    HasNUW, HasNSW);
 677   }
 678   Value *CreateNSWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
 679     return CreateSub(LHS, RHS, Name, false, true);
 680   }
 681   Value *CreateNUWSub(Value *LHS, Value *RHS, const Twine &Name = "") {
 682     return CreateSub(LHS, RHS, Name, true, false);
 683   }
 684   Value *CreateFSub(Value *LHS, Value *RHS, const Twine &Name = "",
 685                     MDNode *FPMathTag = nullptr) {
 686     if (Constant *LC = dyn_cast<Constant>(LHS))
 687       if (Constant *RC = dyn_cast<Constant>(RHS))
 688         return Insert(Folder.CreateFSub(LC, RC), Name);
 689     return Insert(AddFPMathAttributes(BinaryOperator::CreateFSub(LHS, RHS),
 690                                       FPMathTag, FMF), Name);
 691   }
 692   Value *CreateMul(Value *LHS, Value *RHS, const Twine &Name = "",
 693                    bool HasNUW = false, bool HasNSW = false) {
 694     if (Constant *LC = dyn_cast<Constant>(LHS))
 695       if (Constant *RC = dyn_cast<Constant>(RHS))
 696         return Insert(Folder.CreateMul(LC, RC, HasNUW, HasNSW), Name);
 697     return CreateInsertNUWNSWBinOp(Instruction::Mul, LHS, RHS, Name,
 698                                    HasNUW, HasNSW);
 699   }
 700   Value *CreateNSWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
 701     return CreateMul(LHS, RHS, Name, false, true);
 702   }
 703   Value *CreateNUWMul(Value *LHS, Value *RHS, const Twine &Name = "") {
 704     return CreateMul(LHS, RHS, Name, true, false);
 705   }
 706   Value *CreateFMul(Value *LHS, Value *RHS, const Twine &Name = "",
 707                     MDNode *FPMathTag = nullptr) {
 708     if (Constant *LC = dyn_cast<Constant>(LHS))
 709       if (Constant *RC = dyn_cast<Constant>(RHS))
 710         return Insert(Folder.CreateFMul(LC, RC), Name);
 711     return Insert(AddFPMathAttributes(BinaryOperator::CreateFMul(LHS, RHS),
 712                                       FPMathTag, FMF), Name);
 713   }
 714   Value *CreateUDiv(Value *LHS, Value *RHS, const Twine &Name = "",
 715                     bool isExact = false) {
 716     if (Constant *LC = dyn_cast<Constant>(LHS))
 717       if (Constant *RC = dyn_cast<Constant>(RHS))
 718         return Insert(Folder.CreateUDiv(LC, RC, isExact), Name);
 719     if (!isExact)
 720       return Insert(BinaryOperator::CreateUDiv(LHS, RHS), Name);
 721     return Insert(BinaryOperator::CreateExactUDiv(LHS, RHS), Name);
 722   }
 723   Value *CreateExactUDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
 724     return CreateUDiv(LHS, RHS, Name, true);
 725   }
 726   Value *CreateSDiv(Value *LHS, Value *RHS, const Twine &Name = "",
 727                     bool isExact = false) {
 728     if (Constant *LC = dyn_cast<Constant>(LHS))
 729       if (Constant *RC = dyn_cast<Constant>(RHS))
 730         return Insert(Folder.CreateSDiv(LC, RC, isExact), Name);
 731     if (!isExact)
 732       return Insert(BinaryOperator::CreateSDiv(LHS, RHS), Name);
 733     return Insert(BinaryOperator::CreateExactSDiv(LHS, RHS), Name);
 734   }
 735   Value *CreateExactSDiv(Value *LHS, Value *RHS, const Twine &Name = "") {
 736     return CreateSDiv(LHS, RHS, Name, true);
 737   }
 738   Value *CreateFDiv(Value *LHS, Value *RHS, const Twine &Name = "",
 739                     MDNode *FPMathTag = nullptr) {
 740     if (Constant *LC = dyn_cast<Constant>(LHS))
 741       if (Constant *RC = dyn_cast<Constant>(RHS))
 742         return Insert(Folder.CreateFDiv(LC, RC), Name);
 743     return Insert(AddFPMathAttributes(BinaryOperator::CreateFDiv(LHS, RHS),
 744                                       FPMathTag, FMF), Name);
 745   }
 746   Value *CreateURem(Value *LHS, Value *RHS, const Twine &Name = "") {
 747     if (Constant *LC = dyn_cast<Constant>(LHS))
 748       if (Constant *RC = dyn_cast<Constant>(RHS))
 749         return Insert(Folder.CreateURem(LC, RC), Name);
 750     return Insert(BinaryOperator::CreateURem(LHS, RHS), Name);
 751   }
 752   Value *CreateSRem(Value *LHS, Value *RHS, const Twine &Name = "") {
 753     if (Constant *LC = dyn_cast<Constant>(LHS))
 754       if (Constant *RC = dyn_cast<Constant>(RHS))
 755         return Insert(Folder.CreateSRem(LC, RC), Name);
 756     return Insert(BinaryOperator::CreateSRem(LHS, RHS), Name);
 757   }
 758   Value *CreateFRem(Value *LHS, Value *RHS, const Twine &Name = "",
 759                     MDNode *FPMathTag = nullptr) {
 760     if (Constant *LC = dyn_cast<Constant>(LHS))
 761       if (Constant *RC = dyn_cast<Constant>(RHS))
 762         return Insert(Folder.CreateFRem(LC, RC), Name);
 763     return Insert(AddFPMathAttributes(BinaryOperator::CreateFRem(LHS, RHS),
 764                                       FPMathTag, FMF), Name);
 765   }
 766
 767   Value *CreateShl(Value *LHS, Value *RHS, const Twine &Name = "",
 768                    bool HasNUW = false, bool HasNSW = false) {
 769     if (Constant *LC = dyn_cast<Constant>(LHS))
 770       if (Constant *RC = dyn_cast<Constant>(RHS))
 771         return Insert(Folder.CreateShl(LC, RC, HasNUW, HasNSW), Name);
 772     return CreateInsertNUWNSWBinOp(Instruction::Shl, LHS, RHS, Name,
 773                                    HasNUW, HasNSW);
 774   }
 775   Value *CreateShl(Value *LHS, const APInt &RHS, const Twine &Name = "",
 776                    bool HasNUW = false, bool HasNSW = false) {
 777     return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
 778                      HasNUW, HasNSW);
 779   }
 780   Value *CreateShl(Value *LHS, uint64_t RHS, const Twine &Name = "",
 781                    bool HasNUW = false, bool HasNSW = false) {
 782     return CreateShl(LHS, ConstantInt::get(LHS->getType(), RHS), Name,
 783                      HasNUW, HasNSW);
 784   }
 785
 786   Value *CreateLShr(Value *LHS, Value *RHS, const Twine &Name = "",
 787                     bool isExact = false) {
 788     if (Constant *LC = dyn_cast<Constant>(LHS))
 789       if (Constant *RC = dyn_cast<Constant>(RHS))
 790         return Insert(Folder.CreateLShr(LC, RC, isExact), Name);
 791     if (!isExact)
 792       return Insert(BinaryOperator::CreateLShr(LHS, RHS), Name);
 793     return Insert(BinaryOperator::CreateExactLShr(LHS, RHS), Name);
 794   }
 795   Value *CreateLShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
 796                     bool isExact = false) {
 797     return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
 798   }
 799   Value *CreateLShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
 800                     bool isExact = false) {
 801     return CreateLShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
 802   }
 803
 804   Value *CreateAShr(Value *LHS, Value *RHS, const Twine &Name = "",
 805                     bool isExact = false) {
 806     if (Constant *LC = dyn_cast<Constant>(LHS))
 807       if (Constant *RC = dyn_cast<Constant>(RHS))
 808         return Insert(Folder.CreateAShr(LC, RC, isExact), Name);
 809     if (!isExact)
 810       return Insert(BinaryOperator::CreateAShr(LHS, RHS), Name);
 811     return Insert(BinaryOperator::CreateExactAShr(LHS, RHS), Name);
 812   }
 813   Value *CreateAShr(Value *LHS, const APInt &RHS, const Twine &Name = "",
 814                     bool isExact = false) {
 815     return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
 816   }
 817   Value *CreateAShr(Value *LHS, uint64_t RHS, const Twine &Name = "",
 818                     bool isExact = false) {
 819     return CreateAShr(LHS, ConstantInt::get(LHS->getType(), RHS), Name,isExact);
 820   }
 821
 822   Value *CreateAnd(Value *LHS, Value *RHS, const Twine &Name = "") {
 823     if (Constant *RC = dyn_cast<Constant>(RHS)) {
 824       if (isa<ConstantInt>(RC) && cast<ConstantInt>(RC)->isAllOnesValue())
 825         return LHS;  // LHS & -1 -> LHS
 826       if (Constant *LC = dyn_cast<Constant>(LHS))
 827         return Insert(Folder.CreateAnd(LC, RC), Name);
 828     }
 829     return Insert(BinaryOperator::CreateAnd(LHS, RHS), Name);
 830   }
 831   Value *CreateAnd(Value *LHS, const APInt &RHS, const Twine &Name = "") {
 832     return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
 833   }
 834   Value *CreateAnd(Value *LHS, uint64_t RHS, const Twine &Name = "") {
 835     return CreateAnd(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
 836   }
 837
 838   Value *CreateOr(Value *LHS, Value *RHS, const Twine &Name = "") {
 839     if (Constant *RC = dyn_cast<Constant>(RHS)) {
 840       if (RC->isNullValue())
 841         return LHS;  // LHS | 0 -> LHS
 842       if (Constant *LC = dyn_cast<Constant>(LHS))
 843         return Insert(Folder.CreateOr(LC, RC), Name);
 844     }
 845     return Insert(BinaryOperator::CreateOr(LHS, RHS), Name);
 846   }
 847   Value *CreateOr(Value *LHS, const APInt &RHS, const Twine &Name = "") {
 848     return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
 849   }
 850   Value *CreateOr(Value *LHS, uint64_t RHS, const Twine &Name = "") {
 851     return CreateOr(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
 852   }
 853
 854   Value *CreateXor(Value *LHS, Value *RHS, const Twine &Name = "") {
 855     if (Constant *LC = dyn_cast<Constant>(LHS))
 856       if (Constant *RC = dyn_cast<Constant>(RHS))
 857         return Insert(Folder.CreateXor(LC, RC), Name);
 858     return Insert(BinaryOperator::CreateXor(LHS, RHS), Name);
 859   }
 860   Value *CreateXor(Value *LHS, const APInt &RHS, const Twine &Name = "") {
 861     return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
 862   }
 863   Value *CreateXor(Value *LHS, uint64_t RHS, const Twine &Name = "") {
 864     return CreateXor(LHS, ConstantInt::get(LHS->getType(), RHS), Name);
 865   }
 866
 867   Value *CreateBinOp(Instruction::BinaryOps Opc,
 868                      Value *LHS, Value *RHS, const Twine &Name = "",
 869                      MDNode *FPMathTag = nullptr) {
 870     if (Constant *LC = dyn_cast<Constant>(LHS))
 871       if (Constant *RC = dyn_cast<Constant>(RHS))
 872         return Insert(Folder.CreateBinOp(Opc, LC, RC), Name);
 873     llvm::Instruction *BinOp = BinaryOperator::Create(Opc, LHS, RHS);
 874     if (isa<FPMathOperator>(BinOp))
 875       BinOp = AddFPMathAttributes(BinOp, FPMathTag, FMF);
 876     return Insert(BinOp, Name);
 877   }
 878
 879   Value *CreateNeg(Value *V, const Twine &Name = "",
 880                    bool HasNUW = false, bool HasNSW = false) {
 881     if (Constant *VC = dyn_cast<Constant>(V))
 882       return Insert(Folder.CreateNeg(VC, HasNUW, HasNSW), Name);
 883     BinaryOperator *BO = Insert(BinaryOperator::CreateNeg(V), Name);
 884     if (HasNUW) BO->setHasNoUnsignedWrap();
 885     if (HasNSW) BO->setHasNoSignedWrap();
 886     return BO;
 887   }
 888   Value *CreateNSWNeg(Value *V, const Twine &Name = "") {
 889     return CreateNeg(V, Name, false, true);
 890   }
 891   Value *CreateNUWNeg(Value *V, const Twine &Name = "") {
 892     return CreateNeg(V, Name, true, false);
 893   }
 894   Value *CreateFNeg(Value *V, const Twine &Name = "",
 895                     MDNode *FPMathTag = nullptr) {
 896     if (Constant *VC = dyn_cast<Constant>(V))
 897       return Insert(Folder.CreateFNeg(VC), Name);
 898     return Insert(AddFPMathAttributes(BinaryOperator::CreateFNeg(V),
 899                                       FPMathTag, FMF), Name);
 900   }
 901   Value *CreateNot(Value *V, const Twine &Name = "") {
 902     if (Constant *VC = dyn_cast<Constant>(V))
 903       return Insert(Folder.CreateNot(VC), Name);
 904     return Insert(BinaryOperator::CreateNot(V), Name);
 905   }
 906
 907   //===--------------------------------------------------------------------===//
 908   // Instruction creation methods: Memory Instructions
 909   //===--------------------------------------------------------------------===//
 910
 911   AllocaInst *CreateAlloca(Type *Ty, Value *ArraySize = nullptr,
 912                            const Twine &Name = "") {
 913     return Insert(new AllocaInst(Ty, ArraySize), Name);
 914   }
 915   // \brief Provided to resolve 'CreateLoad(Ptr, "...")' correctly, instead of
 916   // converting the string to 'bool' for the isVolatile parameter.
 917   LoadInst *CreateLoad(Value *Ptr, const char *Name) {
 918     return Insert(new LoadInst(Ptr), Name);
 919   }
 920   LoadInst *CreateLoad(Value *Ptr, const Twine &Name = "") {
 921     return Insert(new LoadInst(Ptr), Name);
 922   }
 923   LoadInst *CreateLoad(Value *Ptr, bool isVolatile, const Twine &Name = "") {
 924     return Insert(new LoadInst(Ptr, nullptr, isVolatile), Name);
 925   }
 926   StoreInst *CreateStore(Value *Val, Value *Ptr, bool isVolatile = false) {
 927     return Insert(new StoreInst(Val, Ptr, isVolatile));
 928   }
 929   // \brief Provided to resolve 'CreateAlignedLoad(Ptr, Align, "...")'
 930   // correctly, instead of converting the string to 'bool' for the isVolatile
 931   // parameter.
 932   LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, const char *Name) {
 933     LoadInst *LI = CreateLoad(Ptr, Name);
 934     LI->setAlignment(Align);
 935     return LI;
 936   }
 937   LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align,
 938                               const Twine &Name = "") {
 939     LoadInst *LI = CreateLoad(Ptr, Name);
 940     LI->setAlignment(Align);
 941     return LI;
 942   }
 943   LoadInst *CreateAlignedLoad(Value *Ptr, unsigned Align, bool isVolatile,
 944                               const Twine &Name = "") {
 945     LoadInst *LI = CreateLoad(Ptr, isVolatile, Name);
 946     LI->setAlignment(Align);
 947     return LI;
 948   }
 949   StoreInst *CreateAlignedStore(Value *Val, Value *Ptr, unsigned Align,
 950                                 bool isVolatile = false) {
 951     StoreInst *SI = CreateStore(Val, Ptr, isVolatile);
 952     SI->setAlignment(Align);
 953     return SI;
 954   }
 955   FenceInst *CreateFence(AtomicOrdering Ordering,
 956                          SynchronizationScope SynchScope = CrossThread,
 957                          const Twine &Name = "") {
 958     return Insert(new FenceInst(Context, Ordering, SynchScope), Name);
 959   }
 960   AtomicCmpXchgInst *
 961   CreateAtomicCmpXchg(Value *Ptr, Value *Cmp, Value *New,
 962                       AtomicOrdering SuccessOrdering,
 963                       AtomicOrdering FailureOrdering,
 964                       SynchronizationScope SynchScope = CrossThread) {
 965     return Insert(new AtomicCmpXchgInst(Ptr, Cmp, New, SuccessOrdering,
 966                                         FailureOrdering, SynchScope));
 967   }
 968   AtomicRMWInst *CreateAtomicRMW(AtomicRMWInst::BinOp Op, Value *Ptr, Value *Val,
 969                                  AtomicOrdering Ordering,
 970                                SynchronizationScope SynchScope = CrossThread) {
 971     return Insert(new AtomicRMWInst(Op, Ptr, Val, Ordering, SynchScope));
 972   }
 973   Value *CreateGEP(Value *Ptr, ArrayRef<Value *> IdxList,
 974                    const Twine &Name = "") {
 975     if (Constant *PC = dyn_cast<Constant>(Ptr)) {
 976       // Every index must be constant.
 977       size_t i, e;
 978       for (i = 0, e = IdxList.size(); i != e; ++i)
 979         if (!isa<Constant>(IdxList[i]))
 980           break;
 981       if (i == e)
 982         return Insert(Folder.CreateGetElementPtr(PC, IdxList), Name);
 983     }
 984     return Insert(GetElementPtrInst::Create(Ptr, IdxList), Name);
 985   }
 986   Value *CreateInBoundsGEP(Value *Ptr, ArrayRef<Value *> IdxList,
 987                            const Twine &Name = "") {
 988     if (Constant *PC = dyn_cast<Constant>(Ptr)) {
 989       // Every index must be constant.
 990       size_t i, e;
 991       for (i = 0, e = IdxList.size(); i != e; ++i)
 992         if (!isa<Constant>(IdxList[i]))
 993           break;
 994       if (i == e)
 995         return Insert(Folder.CreateInBoundsGetElementPtr(PC, IdxList), Name);
 996     }
 997     return Insert(GetElementPtrInst::CreateInBounds(Ptr, IdxList), Name);
 998   }
 999   Value *CreateGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
1000     if (Constant *PC = dyn_cast<Constant>(Ptr))
1001       if (Constant *IC = dyn_cast<Constant>(Idx))
1002         return Insert(Folder.CreateGetElementPtr(PC, IC), Name);
1003     return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
1004   }
1005   Value *CreateInBoundsGEP(Value *Ptr, Value *Idx, const Twine &Name = "") {
1006     if (Constant *PC = dyn_cast<Constant>(Ptr))
1007       if (Constant *IC = dyn_cast<Constant>(Idx))
1008         return Insert(Folder.CreateInBoundsGetElementPtr(PC, IC), Name);
1009     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
1010   }
1011   Value *CreateConstGEP1_32(Value *Ptr, unsigned Idx0, const Twine &Name = "") {
1012     Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
1013
1014     if (Constant *PC = dyn_cast<Constant>(Ptr))
1015       return Insert(Folder.CreateGetElementPtr(PC, Idx), Name);
1016
1017     return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
1018   }
1019   Value *CreateConstInBoundsGEP1_32(Value *Ptr, unsigned Idx0,
1020                                     const Twine &Name = "") {
1021     Value *Idx = ConstantInt::get(Type::getInt32Ty(Context), Idx0);
1022
1023     if (Constant *PC = dyn_cast<Constant>(Ptr))
1024       return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idx), Name);
1025
1026     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
1027   }
1028   Value *CreateConstGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
1029                     const Twine &Name = "") {
1030     Value *Idxs[] = {
1031       ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1032       ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1033     };
1034
1035     if (Constant *PC = dyn_cast<Constant>(Ptr))
1036       return Insert(Folder.CreateGetElementPtr(PC, Idxs), Name);
1037
1038     return Insert(GetElementPtrInst::Create(Ptr, Idxs), Name);
1039   }
1040   Value *CreateConstInBoundsGEP2_32(Value *Ptr, unsigned Idx0, unsigned Idx1,
1041                                     const Twine &Name = "") {
1042     Value *Idxs[] = {
1043       ConstantInt::get(Type::getInt32Ty(Context), Idx0),
1044       ConstantInt::get(Type::getInt32Ty(Context), Idx1)
1045     };
1046
1047     if (Constant *PC = dyn_cast<Constant>(Ptr))
1048       return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idxs), Name);
1049
1050     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs), Name);
1051   }
1052   Value *CreateConstGEP1_64(Value *Ptr, uint64_t Idx0, const Twine &Name = "") {
1053     Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1054
1055     if (Constant *PC = dyn_cast<Constant>(Ptr))
1056       return Insert(Folder.CreateGetElementPtr(PC, Idx), Name);
1057
1058     return Insert(GetElementPtrInst::Create(Ptr, Idx), Name);
1059   }
1060   Value *CreateConstInBoundsGEP1_64(Value *Ptr, uint64_t Idx0,
1061                                     const Twine &Name = "") {
1062     Value *Idx = ConstantInt::get(Type::getInt64Ty(Context), Idx0);
1063
1064     if (Constant *PC = dyn_cast<Constant>(Ptr))
1065       return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idx), Name);
1066
1067     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idx), Name);
1068   }
1069   Value *CreateConstGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1070                     const Twine &Name = "") {
1071     Value *Idxs[] = {
1072       ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1073       ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1074     };
1075
1076     if (Constant *PC = dyn_cast<Constant>(Ptr))
1077       return Insert(Folder.CreateGetElementPtr(PC, Idxs), Name);
1078
1079     return Insert(GetElementPtrInst::Create(Ptr, Idxs), Name);
1080   }
1081   Value *CreateConstInBoundsGEP2_64(Value *Ptr, uint64_t Idx0, uint64_t Idx1,
1082                                     const Twine &Name = "") {
1083     Value *Idxs[] = {
1084       ConstantInt::get(Type::getInt64Ty(Context), Idx0),
1085       ConstantInt::get(Type::getInt64Ty(Context), Idx1)
1086     };
1087
1088     if (Constant *PC = dyn_cast<Constant>(Ptr))
1089       return Insert(Folder.CreateInBoundsGetElementPtr(PC, Idxs), Name);
1090
1091     return Insert(GetElementPtrInst::CreateInBounds(Ptr, Idxs), Name);
1092   }
1093   Value *CreateStructGEP(Value *Ptr, unsigned Idx, const Twine &Name = "") {
1094     return CreateConstInBoundsGEP2_32(Ptr, 0, Idx, Name);
1095   }
1096
1097   /// \brief Same as CreateGlobalString, but return a pointer with "i8*" type
1098   /// instead of a pointer to array of i8.
1099   Value *CreateGlobalStringPtr(StringRef Str, const Twine &Name = "") {
1100     Value *gv = CreateGlobalString(Str, Name);
1101     Value *zero = ConstantInt::get(Type::getInt32Ty(Context), 0);
1102     Value *Args[] = { zero, zero };
1103     return CreateInBoundsGEP(gv, Args, Name);
1104   }
1105
1106   //===--------------------------------------------------------------------===//
1107   // Instruction creation methods: Cast/Conversion Operators
1108   //===--------------------------------------------------------------------===//
1109
1110   Value *CreateTrunc(Value *V, Type *DestTy, const Twine &Name = "") {
1111     return CreateCast(Instruction::Trunc, V, DestTy, Name);
1112   }
1113   Value *CreateZExt(Value *V, Type *DestTy, const Twine &Name = "") {
1114     return CreateCast(Instruction::ZExt, V, DestTy, Name);
1115   }
1116   Value *CreateSExt(Value *V, Type *DestTy, const Twine &Name = "") {
1117     return CreateCast(Instruction::SExt, V, DestTy, Name);
1118   }
1119   /// \brief Create a ZExt or Trunc from the integer value V to DestTy. Return
1120   /// the value untouched if the type of V is already DestTy.
1121   Value *CreateZExtOrTrunc(Value *V, Type *DestTy,
1122                            const Twine &Name = "") {
1123     assert(V->getType()->isIntOrIntVectorTy() &&
1124            DestTy->isIntOrIntVectorTy() &&
1125            "Can only zero extend/truncate integers!");
1126     Type *VTy = V->getType();
1127     if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1128       return CreateZExt(V, DestTy, Name);
1129     if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1130       return CreateTrunc(V, DestTy, Name);
1131     return V;
1132   }
1133   /// \brief Create a SExt or Trunc from the integer value V to DestTy. Return
1134   /// the value untouched if the type of V is already DestTy.
1135   Value *CreateSExtOrTrunc(Value *V, Type *DestTy,
1136                            const Twine &Name = "") {
1137     assert(V->getType()->isIntOrIntVectorTy() &&
1138            DestTy->isIntOrIntVectorTy() &&
1139            "Can only sign extend/truncate integers!");
1140     Type *VTy = V->getType();
1141     if (VTy->getScalarSizeInBits() < DestTy->getScalarSizeInBits())
1142       return CreateSExt(V, DestTy, Name);
1143     if (VTy->getScalarSizeInBits() > DestTy->getScalarSizeInBits())
1144       return CreateTrunc(V, DestTy, Name);
1145     return V;
1146   }
1147   Value *CreateFPToUI(Value *V, Type *DestTy, const Twine &Name = ""){
1148     return CreateCast(Instruction::FPToUI, V, DestTy, Name);
1149   }
1150   Value *CreateFPToSI(Value *V, Type *DestTy, const Twine &Name = ""){
1151     return CreateCast(Instruction::FPToSI, V, DestTy, Name);
1152   }
1153   Value *CreateUIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1154     return CreateCast(Instruction::UIToFP, V, DestTy, Name);
1155   }
1156   Value *CreateSIToFP(Value *V, Type *DestTy, const Twine &Name = ""){
1157     return CreateCast(Instruction::SIToFP, V, DestTy, Name);
1158   }
1159   Value *CreateFPTrunc(Value *V, Type *DestTy,
1160                        const Twine &Name = "") {
1161     return CreateCast(Instruction::FPTrunc, V, DestTy, Name);
1162   }
1163   Value *CreateFPExt(Value *V, Type *DestTy, const Twine &Name = "") {
1164     return CreateCast(Instruction::FPExt, V, DestTy, Name);
1165   }
1166   Value *CreatePtrToInt(Value *V, Type *DestTy,
1167                         const Twine &Name = "") {
1168     return CreateCast(Instruction::PtrToInt, V, DestTy, Name);
1169   }
1170   Value *CreateIntToPtr(Value *V, Type *DestTy,
1171                         const Twine &Name = "") {
1172     return CreateCast(Instruction::IntToPtr, V, DestTy, Name);
1173   }
1174   Value *CreateBitCast(Value *V, Type *DestTy,
1175                        const Twine &Name = "") {
1176     return CreateCast(Instruction::BitCast, V, DestTy, Name);
1177   }
1178   Value *CreateAddrSpaceCast(Value *V, Type *DestTy,
1179                              const Twine &Name = "") {
1180     return CreateCast(Instruction::AddrSpaceCast, V, DestTy, Name);
1181   }
1182   Value *CreateZExtOrBitCast(Value *V, Type *DestTy,
1183                              const Twine &Name = "") {
1184     if (V->getType() == DestTy)
1185       return V;
1186     if (Constant *VC = dyn_cast<Constant>(V))
1187       return Insert(Folder.CreateZExtOrBitCast(VC, DestTy), Name);
1188     return Insert(CastInst::CreateZExtOrBitCast(V, DestTy), Name);
1189   }
1190   Value *CreateSExtOrBitCast(Value *V, Type *DestTy,
1191                              const Twine &Name = "") {
1192     if (V->getType() == DestTy)
1193       return V;
1194     if (Constant *VC = dyn_cast<Constant>(V))
1195       return Insert(Folder.CreateSExtOrBitCast(VC, DestTy), Name);
1196     return Insert(CastInst::CreateSExtOrBitCast(V, DestTy), Name);
1197   }
1198   Value *CreateTruncOrBitCast(Value *V, Type *DestTy,
1199                               const Twine &Name = "") {
1200     if (V->getType() == DestTy)
1201       return V;
1202     if (Constant *VC = dyn_cast<Constant>(V))
1203       return Insert(Folder.CreateTruncOrBitCast(VC, DestTy), Name);
1204     return Insert(CastInst::CreateTruncOrBitCast(V, DestTy), Name);
1205   }
1206   Value *CreateCast(Instruction::CastOps Op, Value *V, Type *DestTy,
1207                     const Twine &Name = "") {
1208     if (V->getType() == DestTy)
1209       return V;
1210     if (Constant *VC = dyn_cast<Constant>(V))
1211       return Insert(Folder.CreateCast(Op, VC, DestTy), Name);
1212     return Insert(CastInst::Create(Op, V, DestTy), Name);
1213   }
1214   Value *CreatePointerCast(Value *V, Type *DestTy,
1215                            const Twine &Name = "") {
1216     if (V->getType() == DestTy)
1217       return V;
1218     if (Constant *VC = dyn_cast<Constant>(V))
1219       return Insert(Folder.CreatePointerCast(VC, DestTy), Name);
1220     return Insert(CastInst::CreatePointerCast(V, DestTy), Name);
1221   }
1222
1223   Value *CreatePointerBitCastOrAddrSpaceCast(Value *V, Type *DestTy,
1224                                              const Twine &Name = "") {
1225     if (V->getType() == DestTy)
1226       return V;
1227
1228     if (Constant *VC = dyn_cast<Constant>(V)) {
1229       return Insert(Folder.CreatePointerBitCastOrAddrSpaceCast(VC, DestTy),
1230                     Name);
1231     }
1232
1233     return Insert(CastInst::CreatePointerBitCastOrAddrSpaceCast(V, DestTy),
1234                   Name);
1235   }
1236
1237   Value *CreateIntCast(Value *V, Type *DestTy, bool isSigned,
1238                        const Twine &Name = "") {
1239     if (V->getType() == DestTy)
1240       return V;
1241     if (Constant *VC = dyn_cast<Constant>(V))
1242       return Insert(Folder.CreateIntCast(VC, DestTy, isSigned), Name);
1243     return Insert(CastInst::CreateIntegerCast(V, DestTy, isSigned), Name);
1244   }
1245 private:
1246   // \brief Provided to resolve 'CreateIntCast(Ptr, Ptr, "...")', giving a
1247   // compile time error, instead of converting the string to bool for the
1248   // isSigned parameter.
1249   Value *CreateIntCast(Value *, Type *, const char *) LLVM_DELETED_FUNCTION;
1250 public:
1251   Value *CreateFPCast(Value *V, Type *DestTy, const Twine &Name = "") {
1252     if (V->getType() == DestTy)
1253       return V;
1254     if (Constant *VC = dyn_cast<Constant>(V))
1255       return Insert(Folder.CreateFPCast(VC, DestTy), Name);
1256     return Insert(CastInst::CreateFPCast(V, DestTy), Name);
1257   }
1258
1259   //===--------------------------------------------------------------------===//
1260   // Instruction creation methods: Compare Instructions
1261   //===--------------------------------------------------------------------===//
1262
1263   Value *CreateICmpEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1264     return CreateICmp(ICmpInst::ICMP_EQ, LHS, RHS, Name);
1265   }
1266   Value *CreateICmpNE(Value *LHS, Value *RHS, const Twine &Name = "") {
1267     return CreateICmp(ICmpInst::ICMP_NE, LHS, RHS, Name);
1268   }
1269   Value *CreateICmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1270     return CreateICmp(ICmpInst::ICMP_UGT, LHS, RHS, Name);
1271   }
1272   Value *CreateICmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1273     return CreateICmp(ICmpInst::ICMP_UGE, LHS, RHS, Name);
1274   }
1275   Value *CreateICmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
1276     return CreateICmp(ICmpInst::ICMP_ULT, LHS, RHS, Name);
1277   }
1278   Value *CreateICmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
1279     return CreateICmp(ICmpInst::ICMP_ULE, LHS, RHS, Name);
1280   }
1281   Value *CreateICmpSGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1282     return CreateICmp(ICmpInst::ICMP_SGT, LHS, RHS, Name);
1283   }
1284   Value *CreateICmpSGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1285     return CreateICmp(ICmpInst::ICMP_SGE, LHS, RHS, Name);
1286   }
1287   Value *CreateICmpSLT(Value *LHS, Value *RHS, const Twine &Name = "") {
1288     return CreateICmp(ICmpInst::ICMP_SLT, LHS, RHS, Name);
1289   }
1290   Value *CreateICmpSLE(Value *LHS, Value *RHS, const Twine &Name = "") {
1291     return CreateICmp(ICmpInst::ICMP_SLE, LHS, RHS, Name);
1292   }
1293
1294   Value *CreateFCmpOEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1295     return CreateFCmp(FCmpInst::FCMP_OEQ, LHS, RHS, Name);
1296   }
1297   Value *CreateFCmpOGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1298     return CreateFCmp(FCmpInst::FCMP_OGT, LHS, RHS, Name);
1299   }
1300   Value *CreateFCmpOGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1301     return CreateFCmp(FCmpInst::FCMP_OGE, LHS, RHS, Name);
1302   }
1303   Value *CreateFCmpOLT(Value *LHS, Value *RHS, const Twine &Name = "") {
1304     return CreateFCmp(FCmpInst::FCMP_OLT, LHS, RHS, Name);
1305   }
1306   Value *CreateFCmpOLE(Value *LHS, Value *RHS, const Twine &Name = "") {
1307     return CreateFCmp(FCmpInst::FCMP_OLE, LHS, RHS, Name);
1308   }
1309   Value *CreateFCmpONE(Value *LHS, Value *RHS, const Twine &Name = "") {
1310     return CreateFCmp(FCmpInst::FCMP_ONE, LHS, RHS, Name);
1311   }
1312   Value *CreateFCmpORD(Value *LHS, Value *RHS, const Twine &Name = "") {
1313     return CreateFCmp(FCmpInst::FCMP_ORD, LHS, RHS, Name);
1314   }
1315   Value *CreateFCmpUNO(Value *LHS, Value *RHS, const Twine &Name = "") {
1316     return CreateFCmp(FCmpInst::FCMP_UNO, LHS, RHS, Name);
1317   }
1318   Value *CreateFCmpUEQ(Value *LHS, Value *RHS, const Twine &Name = "") {
1319     return CreateFCmp(FCmpInst::FCMP_UEQ, LHS, RHS, Name);
1320   }
1321   Value *CreateFCmpUGT(Value *LHS, Value *RHS, const Twine &Name = "") {
1322     return CreateFCmp(FCmpInst::FCMP_UGT, LHS, RHS, Name);
1323   }
1324   Value *CreateFCmpUGE(Value *LHS, Value *RHS, const Twine &Name = "") {
1325     return CreateFCmp(FCmpInst::FCMP_UGE, LHS, RHS, Name);
1326   }
1327   Value *CreateFCmpULT(Value *LHS, Value *RHS, const Twine &Name = "") {
1328     return CreateFCmp(FCmpInst::FCMP_ULT, LHS, RHS, Name);
1329   }
1330   Value *CreateFCmpULE(Value *LHS, Value *RHS, const Twine &Name = "") {
1331     return CreateFCmp(FCmpInst::FCMP_ULE, LHS, RHS, Name);
1332   }
1333   Value *CreateFCmpUNE(Value *LHS, Value *RHS, const Twine &Name = "") {
1334     return CreateFCmp(FCmpInst::FCMP_UNE, LHS, RHS, Name);
1335   }
1336
1337   Value *CreateICmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1338                     const Twine &Name = "") {
1339     if (Constant *LC = dyn_cast<Constant>(LHS))
1340       if (Constant *RC = dyn_cast<Constant>(RHS))
1341         return Insert(Folder.CreateICmp(P, LC, RC), Name);
1342     return Insert(new ICmpInst(P, LHS, RHS), Name);
1343   }
1344   Value *CreateFCmp(CmpInst::Predicate P, Value *LHS, Value *RHS,
1345                     const Twine &Name = "") {
1346     if (Constant *LC = dyn_cast<Constant>(LHS))
1347       if (Constant *RC = dyn_cast<Constant>(RHS))
1348         return Insert(Folder.CreateFCmp(P, LC, RC), Name);
1349     return Insert(new FCmpInst(P, LHS, RHS), Name);
1350   }
1351
1352   //===--------------------------------------------------------------------===//
1353   // Instruction creation methods: Other Instructions
1354   //===--------------------------------------------------------------------===//
1355
1356   PHINode *CreatePHI(Type *Ty, unsigned NumReservedValues,
1357                      const Twine &Name = "") {
1358     return Insert(PHINode::Create(Ty, NumReservedValues), Name);
1359   }
1360
1361   CallInst *CreateCall(Value *Callee, const Twine &Name = "") {
1362     return Insert(CallInst::Create(Callee), Name);
1363   }
1364   CallInst *CreateCall(Value *Callee, Value *Arg, const Twine &Name = "") {
1365     return Insert(CallInst::Create(Callee, Arg), Name);
1366   }
1367   CallInst *CreateCall2(Value *Callee, Value *Arg1, Value *Arg2,
1368                         const Twine &Name = "") {
1369     Value *Args[] = { Arg1, Arg2 };
1370     return Insert(CallInst::Create(Callee, Args), Name);
1371   }
1372   CallInst *CreateCall3(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1373                         const Twine &Name = "") {
1374     Value *Args[] = { Arg1, Arg2, Arg3 };
1375     return Insert(CallInst::Create(Callee, Args), Name);
1376   }
1377   CallInst *CreateCall4(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1378                         Value *Arg4, const Twine &Name = "") {
1379     Value *Args[] = { Arg1, Arg2, Arg3, Arg4 };
1380     return Insert(CallInst::Create(Callee, Args), Name);
1381   }
1382   CallInst *CreateCall5(Value *Callee, Value *Arg1, Value *Arg2, Value *Arg3,
1383                         Value *Arg4, Value *Arg5, const Twine &Name = "") {
1384     Value *Args[] = { Arg1, Arg2, Arg3, Arg4, Arg5 };
1385     return Insert(CallInst::Create(Callee, Args), Name);
1386   }
1387
1388   CallInst *CreateCall(Value *Callee, ArrayRef<Value *> Args,
1389                        const Twine &Name = "") {
1390     return Insert(CallInst::Create(Callee, Args), Name);
1391   }
1392
1393   Value *CreateSelect(Value *C, Value *True, Value *False,
1394                       const Twine &Name = "") {
1395     if (Constant *CC = dyn_cast<Constant>(C))
1396       if (Constant *TC = dyn_cast<Constant>(True))
1397         if (Constant *FC = dyn_cast<Constant>(False))
1398           return Insert(Folder.CreateSelect(CC, TC, FC), Name);
1399     return Insert(SelectInst::Create(C, True, False), Name);
1400   }
1401
1402   VAArgInst *CreateVAArg(Value *List, Type *Ty, const Twine &Name = "") {
1403     return Insert(new VAArgInst(List, Ty), Name);
1404   }
1405
1406   Value *CreateExtractElement(Value *Vec, Value *Idx,
1407                               const Twine &Name = "") {
1408     if (Constant *VC = dyn_cast<Constant>(Vec))
1409       if (Constant *IC = dyn_cast<Constant>(Idx))
1410         return Insert(Folder.CreateExtractElement(VC, IC), Name);
1411     return Insert(ExtractElementInst::Create(Vec, Idx), Name);
1412   }
1413
1414   Value *CreateInsertElement(Value *Vec, Value *NewElt, Value *Idx,
1415                              const Twine &Name = "") {
1416     if (Constant *VC = dyn_cast<Constant>(Vec))
1417       if (Constant *NC = dyn_cast<Constant>(NewElt))
1418         if (Constant *IC = dyn_cast<Constant>(Idx))
1419           return Insert(Folder.CreateInsertElement(VC, NC, IC), Name);
1420     return Insert(InsertElementInst::Create(Vec, NewElt, Idx), Name);
1421   }
1422
1423   Value *CreateShuffleVector(Value *V1, Value *V2, Value *Mask,
1424                              const Twine &Name = "") {
1425     if (Constant *V1C = dyn_cast<Constant>(V1))
1426       if (Constant *V2C = dyn_cast<Constant>(V2))
1427         if (Constant *MC = dyn_cast<Constant>(Mask))
1428           return Insert(Folder.CreateShuffleVector(V1C, V2C, MC), Name);
1429     return Insert(new ShuffleVectorInst(V1, V2, Mask), Name);
1430   }
1431
1432   Value *CreateExtractValue(Value *Agg,
1433                             ArrayRef<unsigned> Idxs,
1434                             const Twine &Name = "") {
1435     if (Constant *AggC = dyn_cast<Constant>(Agg))
1436       return Insert(Folder.CreateExtractValue(AggC, Idxs), Name);
1437     return Insert(ExtractValueInst::Create(Agg, Idxs), Name);
1438   }
1439
1440   Value *CreateInsertValue(Value *Agg, Value *Val,
1441                            ArrayRef<unsigned> Idxs,
1442                            const Twine &Name = "") {
1443     if (Constant *AggC = dyn_cast<Constant>(Agg))
1444       if (Constant *ValC = dyn_cast<Constant>(Val))
1445         return Insert(Folder.CreateInsertValue(AggC, ValC, Idxs), Name);
1446     return Insert(InsertValueInst::Create(Agg, Val, Idxs), Name);
1447   }
1448
1449   LandingPadInst *CreateLandingPad(Type *Ty, Value *PersFn, unsigned NumClauses,
1450                                    const Twine &Name = "") {
1451     return Insert(LandingPadInst::Create(Ty, PersFn, NumClauses), Name);
1452   }
1453
1454   //===--------------------------------------------------------------------===//
1455   // Utility creation methods
1456   //===--------------------------------------------------------------------===//
1457
1458   /// \brief Return an i1 value testing if \p Arg is null.
1459   Value *CreateIsNull(Value *Arg, const Twine &Name = "") {
1460     return CreateICmpEQ(Arg, Constant::getNullValue(Arg->getType()),
1461                         Name);
1462   }
1463
1464   /// \brief Return an i1 value testing if \p Arg is not null.
1465   Value *CreateIsNotNull(Value *Arg, const Twine &Name = "") {
1466     return CreateICmpNE(Arg, Constant::getNullValue(Arg->getType()),
1467                         Name);
1468   }
1469
1470   /// \brief Return the i64 difference between two pointer values, dividing out
1471   /// the size of the pointed-to objects.
1472   ///
1473   /// This is intended to implement C-style pointer subtraction. As such, the
1474   /// pointers must be appropriately aligned for their element types and
1475   /// pointing into the same object.
1476   Value *CreatePtrDiff(Value *LHS, Value *RHS, const Twine &Name = "") {
1477     assert(LHS->getType() == RHS->getType() &&
1478            "Pointer subtraction operand types must match!");
1479     PointerType *ArgType = cast<PointerType>(LHS->getType());
1480     Value *LHS_int = CreatePtrToInt(LHS, Type::getInt64Ty(Context));
1481     Value *RHS_int = CreatePtrToInt(RHS, Type::getInt64Ty(Context));
1482     Value *Difference = CreateSub(LHS_int, RHS_int);
1483     return CreateExactSDiv(Difference,
1484                            ConstantExpr::getSizeOf(ArgType->getElementType()),
1485                            Name);
1486   }
1487
1488   /// \brief Return a vector value that contains \arg V broadcasted to \p
1489   /// NumElts elements.
1490   Value *CreateVectorSplat(unsigned NumElts, Value *V, const Twine &Name = "") {
1491     assert(NumElts > 0 && "Cannot splat to an empty vector!");
1492
1493     // First insert it into an undef vector so we can shuffle it.
1494     Type *I32Ty = getInt32Ty();
1495     Value *Undef = UndefValue::get(VectorType::get(V->getType(), NumElts));
1496     V = CreateInsertElement(Undef, V, ConstantInt::get(I32Ty, 0),
1497                             Name + ".splatinsert");
1498
1499     // Shuffle the value across the desired number of elements.
1500     Value *Zeros = ConstantAggregateZero::get(VectorType::get(I32Ty, NumElts));
1501     return CreateShuffleVector(V, Undef, Zeros, Name + ".splat");
1502   }
1503
1504   /// \brief Return a value that has been extracted from a larger integer type.
1505   Value *CreateExtractInteger(const DataLayout &DL, Value *From,
1506                               IntegerType *ExtractedTy, uint64_t Offset,
1507                               const Twine &Name) {
1508     IntegerType *IntTy = cast<IntegerType>(From->getType());
1509     assert(DL.getTypeStoreSize(ExtractedTy) + Offset <=
1510                DL.getTypeStoreSize(IntTy) &&
1511            "Element extends past full value");
1512     uint64_t ShAmt = 8 * Offset;
1513     Value *V = From;
1514     if (DL.isBigEndian())
1515       ShAmt = 8 * (DL.getTypeStoreSize(IntTy) -
1516                    DL.getTypeStoreSize(ExtractedTy) - Offset);
1517     if (ShAmt) {
1518       V = CreateLShr(V, ShAmt, Name + ".shift");
1519     }
1520     assert(ExtractedTy->getBitWidth() <= IntTy->getBitWidth() &&
1521            "Cannot extract to a larger integer!");
1522     if (ExtractedTy != IntTy) {
1523       V = CreateTrunc(V, ExtractedTy, Name + ".trunc");
1524     }
1525     return V;
1526   }
1527 };
1528
1529 // Create wrappers for C Binding types (see CBindingWrapping.h).
1530 DEFINE_SIMPLE_CONVERSION_FUNCTIONS(IRBuilder<>, LLVMBuilderRef)
1531
1532 }
1533
1534 #endif