| //===-- CGBuilder.h - Choose IRBuilder implementation ----------*- C++ -*-===// |
| // |
| // The LLVM Compiler Infrastructure |
| // |
| // This file is distributed under the University of Illinois Open Source |
| // License. See LICENSE.TXT for details. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef LLVM_CLANG_LIB_CODEGEN_CGBUILDER_H |
| #define LLVM_CLANG_LIB_CODEGEN_CGBUILDER_H |
| |
| #include "llvm/IR/DataLayout.h" |
| #include "llvm/IR/IRBuilder.h" |
| #include "Address.h" |
| #include "CodeGenTypeCache.h" |
| |
| namespace clang { |
| namespace CodeGen { |
| |
| class CodeGenFunction; |
| |
| /// \brief This is an IRBuilder insertion helper that forwards to |
| /// CodeGenFunction::InsertHelper, which adds necessary metadata to |
| /// instructions. |
| class CGBuilderInserter : protected llvm::IRBuilderDefaultInserter { |
| public: |
| CGBuilderInserter() = default; |
| explicit CGBuilderInserter(CodeGenFunction *CGF) : CGF(CGF) {} |
| |
| protected: |
| /// \brief This forwards to CodeGenFunction::InsertHelper. |
| void InsertHelper(llvm::Instruction *I, const llvm::Twine &Name, |
| llvm::BasicBlock *BB, |
| llvm::BasicBlock::iterator InsertPt) const; |
| private: |
| CodeGenFunction *CGF = nullptr; |
| }; |
| |
| typedef CGBuilderInserter CGBuilderInserterTy; |
| |
| typedef llvm::IRBuilder<llvm::ConstantFolder, CGBuilderInserterTy> |
| CGBuilderBaseTy; |
| |
| class CGBuilderTy : public CGBuilderBaseTy { |
| /// Storing a reference to the type cache here makes it a lot easier |
| /// to build natural-feeling, target-specific IR. |
| const CodeGenTypeCache &TypeCache; |
| public: |
| CGBuilderTy(const CodeGenTypeCache &TypeCache, llvm::LLVMContext &C) |
| : CGBuilderBaseTy(C), TypeCache(TypeCache) {} |
| CGBuilderTy(const CodeGenTypeCache &TypeCache, |
| llvm::LLVMContext &C, const llvm::ConstantFolder &F, |
| const CGBuilderInserterTy &Inserter) |
| : CGBuilderBaseTy(C, F, Inserter), TypeCache(TypeCache) {} |
| CGBuilderTy(const CodeGenTypeCache &TypeCache, llvm::Instruction *I) |
| : CGBuilderBaseTy(I), TypeCache(TypeCache) {} |
| CGBuilderTy(const CodeGenTypeCache &TypeCache, llvm::BasicBlock *BB) |
| : CGBuilderBaseTy(BB), TypeCache(TypeCache) {} |
| |
| llvm::ConstantInt *getSize(CharUnits N) { |
| return llvm::ConstantInt::get(TypeCache.SizeTy, N.getQuantity()); |
| } |
| llvm::ConstantInt *getSize(uint64_t N) { |
| return llvm::ConstantInt::get(TypeCache.SizeTy, N); |
| } |
| |
| // Note that we intentionally hide the CreateLoad APIs that don't |
| // take an alignment. |
| llvm::LoadInst *CreateLoad(Address Addr, const llvm::Twine &Name = "") { |
| return CreateAlignedLoad(Addr.getPointer(), |
| Addr.getAlignment().getQuantity(), |
| Name); |
| } |
| llvm::LoadInst *CreateLoad(Address Addr, const char *Name) { |
| // This overload is required to prevent string literals from |
| // ending up in the IsVolatile overload. |
| return CreateAlignedLoad(Addr.getPointer(), |
| Addr.getAlignment().getQuantity(), |
| Name); |
| } |
| llvm::LoadInst *CreateLoad(Address Addr, bool IsVolatile, |
| const llvm::Twine &Name = "") { |
| return CreateAlignedLoad(Addr.getPointer(), |
| Addr.getAlignment().getQuantity(), |
| IsVolatile, |
| Name); |
| } |
| |
| using CGBuilderBaseTy::CreateAlignedLoad; |
| llvm::LoadInst *CreateAlignedLoad(llvm::Value *Addr, CharUnits Align, |
| const llvm::Twine &Name = "") { |
| return CreateAlignedLoad(Addr, Align.getQuantity(), Name); |
| } |
| llvm::LoadInst *CreateAlignedLoad(llvm::Value *Addr, CharUnits Align, |
| const char *Name) { |
| return CreateAlignedLoad(Addr, Align.getQuantity(), Name); |
| } |
| llvm::LoadInst *CreateAlignedLoad(llvm::Type *Ty, llvm::Value *Addr, |
| CharUnits Align, |
| const llvm::Twine &Name = "") { |
| assert(Addr->getType()->getPointerElementType() == Ty); |
| return CreateAlignedLoad(Addr, Align.getQuantity(), Name); |
| } |
| |
| // Note that we intentionally hide the CreateStore APIs that don't |
| // take an alignment. |
| llvm::StoreInst *CreateStore(llvm::Value *Val, Address Addr, |
| bool IsVolatile = false) { |
| return CreateAlignedStore(Val, Addr.getPointer(), |
| Addr.getAlignment().getQuantity(), IsVolatile); |
| } |
| |
| using CGBuilderBaseTy::CreateAlignedStore; |
| llvm::StoreInst *CreateAlignedStore(llvm::Value *Val, llvm::Value *Addr, |
| CharUnits Align, bool IsVolatile = false) { |
| return CreateAlignedStore(Val, Addr, Align.getQuantity(), IsVolatile); |
| } |
| |
| // FIXME: these "default-aligned" APIs should be removed, |
| // but I don't feel like fixing all the builtin code right now. |
| llvm::StoreInst *CreateDefaultAlignedStore(llvm::Value *Val, |
| llvm::Value *Addr, |
| bool IsVolatile = false) { |
| return CGBuilderBaseTy::CreateStore(Val, Addr, IsVolatile); |
| } |
| |
| /// Emit a load from an i1 flag variable. |
| llvm::LoadInst *CreateFlagLoad(llvm::Value *Addr, |
| const llvm::Twine &Name = "") { |
| assert(Addr->getType()->getPointerElementType() == getInt1Ty()); |
| return CreateAlignedLoad(getInt1Ty(), Addr, CharUnits::One(), Name); |
| } |
| |
| /// Emit a store to an i1 flag variable. |
| llvm::StoreInst *CreateFlagStore(bool Value, llvm::Value *Addr) { |
| assert(Addr->getType()->getPointerElementType() == getInt1Ty()); |
| return CreateAlignedStore(getInt1(Value), Addr, CharUnits::One()); |
| } |
| |
| using CGBuilderBaseTy::CreateBitCast; |
| Address CreateBitCast(Address Addr, llvm::Type *Ty, |
| const llvm::Twine &Name = "") { |
| return Address(CreateBitCast(Addr.getPointer(), Ty, Name), |
| Addr.getAlignment()); |
| } |
| |
| using CGBuilderBaseTy::CreateAddrSpaceCast; |
| Address CreateAddrSpaceCast(Address Addr, llvm::Type *Ty, |
| const llvm::Twine &Name = "") { |
| return Address(CreateAddrSpaceCast(Addr.getPointer(), Ty, Name), |
| Addr.getAlignment()); |
| } |
| |
| /// Cast the element type of the given address to a different type, |
| /// preserving information like the alignment and address space. |
| Address CreateElementBitCast(Address Addr, llvm::Type *Ty, |
| const llvm::Twine &Name = "") { |
| auto PtrTy = Ty->getPointerTo(Addr.getAddressSpace()); |
| return CreateBitCast(Addr, PtrTy, Name); |
| } |
| |
| using CGBuilderBaseTy::CreatePointerBitCastOrAddrSpaceCast; |
| Address CreatePointerBitCastOrAddrSpaceCast(Address Addr, llvm::Type *Ty, |
| const llvm::Twine &Name = "") { |
| llvm::Value *Ptr = |
| CreatePointerBitCastOrAddrSpaceCast(Addr.getPointer(), Ty, Name); |
| return Address(Ptr, Addr.getAlignment()); |
| } |
| |
| using CGBuilderBaseTy::CreateStructGEP; |
| Address CreateStructGEP(Address Addr, unsigned Index, CharUnits Offset, |
| const llvm::Twine &Name = "") { |
| return Address(CreateStructGEP(Addr.getElementType(), |
| Addr.getPointer(), Index, Name), |
| Addr.getAlignment().alignmentAtOffset(Offset)); |
| } |
| Address CreateStructGEP(Address Addr, unsigned Index, |
| const llvm::StructLayout *Layout, |
| const llvm::Twine &Name = "") { |
| auto Offset = CharUnits::fromQuantity(Layout->getElementOffset(Index)); |
| return CreateStructGEP(Addr, Index, Offset, Name); |
| } |
| |
| /// Given |
| /// %addr = [n x T]* ... |
| /// produce |
| /// %name = getelementptr inbounds %addr, i64 0, i64 index |
| /// where i64 is actually the target word size. |
| /// |
| /// This API assumes that drilling into an array like this is always |
| /// an inbounds operation. |
| /// |
| /// \param EltSize - the size of the type T in bytes |
| Address CreateConstArrayGEP(Address Addr, uint64_t Index, CharUnits EltSize, |
| const llvm::Twine &Name = "") { |
| return Address(CreateInBoundsGEP(Addr.getPointer(), |
| {getSize(CharUnits::Zero()), |
| getSize(Index)}, |
| Name), |
| Addr.getAlignment().alignmentAtOffset(Index * EltSize)); |
| } |
| |
| /// Given |
| /// %addr = T* ... |
| /// produce |
| /// %name = getelementptr inbounds %addr, i64 index |
| /// where i64 is actually the target word size. |
| /// |
| /// \param EltSize - the size of the type T in bytes |
| Address CreateConstInBoundsGEP(Address Addr, uint64_t Index, |
| CharUnits EltSize, |
| const llvm::Twine &Name = "") { |
| return Address(CreateInBoundsGEP(Addr.getElementType(), Addr.getPointer(), |
| getSize(Index), Name), |
| Addr.getAlignment().alignmentAtOffset(Index * EltSize)); |
| } |
| |
| /// Given |
| /// %addr = T* ... |
| /// produce |
| /// %name = getelementptr inbounds %addr, i64 index |
| /// where i64 is actually the target word size. |
| /// |
| /// \param EltSize - the size of the type T in bytes |
| Address CreateConstGEP(Address Addr, uint64_t Index, CharUnits EltSize, |
| const llvm::Twine &Name = "") { |
| return Address(CreateGEP(Addr.getElementType(), Addr.getPointer(), |
| getSize(Index), Name), |
| Addr.getAlignment().alignmentAtOffset(Index * EltSize)); |
| } |
| |
| /// Given a pointer to i8, adjust it by a given constant offset. |
| Address CreateConstInBoundsByteGEP(Address Addr, CharUnits Offset, |
| const llvm::Twine &Name = "") { |
| assert(Addr.getElementType() == TypeCache.Int8Ty); |
| return Address(CreateInBoundsGEP(Addr.getPointer(), getSize(Offset), Name), |
| Addr.getAlignment().alignmentAtOffset(Offset)); |
| } |
| Address CreateConstByteGEP(Address Addr, CharUnits Offset, |
| const llvm::Twine &Name = "") { |
| assert(Addr.getElementType() == TypeCache.Int8Ty); |
| return Address(CreateGEP(Addr.getPointer(), getSize(Offset), Name), |
| Addr.getAlignment().alignmentAtOffset(Offset)); |
| } |
| |
| llvm::Value *CreateConstInBoundsByteGEP(llvm::Value *Ptr, CharUnits Offset, |
| const llvm::Twine &Name = "") { |
| assert(Ptr->getType()->getPointerElementType() == TypeCache.Int8Ty); |
| return CreateInBoundsGEP(Ptr, getSize(Offset), Name); |
| } |
| llvm::Value *CreateConstByteGEP(llvm::Value *Ptr, CharUnits Offset, |
| const llvm::Twine &Name = "") { |
| assert(Ptr->getType()->getPointerElementType() == TypeCache.Int8Ty); |
| return CreateGEP(Ptr, getSize(Offset), Name); |
| } |
| |
| using CGBuilderBaseTy::CreateMemCpy; |
| llvm::CallInst *CreateMemCpy(Address Dest, Address Src, llvm::Value *Size, |
| bool IsVolatile = false) { |
| auto Align = std::min(Dest.getAlignment(), Src.getAlignment()); |
| return CreateMemCpy(Dest.getPointer(), Src.getPointer(), Size, |
| Align.getQuantity(), IsVolatile); |
| } |
| llvm::CallInst *CreateMemCpy(Address Dest, Address Src, uint64_t Size, |
| bool IsVolatile = false) { |
| auto Align = std::min(Dest.getAlignment(), Src.getAlignment()); |
| return CreateMemCpy(Dest.getPointer(), Src.getPointer(), Size, |
| Align.getQuantity(), IsVolatile); |
| } |
| |
| using CGBuilderBaseTy::CreateMemMove; |
| llvm::CallInst *CreateMemMove(Address Dest, Address Src, llvm::Value *Size, |
| bool IsVolatile = false) { |
| auto Align = std::min(Dest.getAlignment(), Src.getAlignment()); |
| return CreateMemMove(Dest.getPointer(), Src.getPointer(), Size, |
| Align.getQuantity(), IsVolatile); |
| } |
| |
| using CGBuilderBaseTy::CreateMemSet; |
| llvm::CallInst *CreateMemSet(Address Dest, llvm::Value *Value, |
| llvm::Value *Size, bool IsVolatile = false) { |
| return CreateMemSet(Dest.getPointer(), Value, Size, |
| Dest.getAlignment().getQuantity(), IsVolatile); |
| } |
| }; |
| |
| } // end namespace CodeGen |
| } // end namespace clang |
| |
| #endif |