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