| //===- NoFolder.h - Constant folding helper ---------------------*- C++ -*-===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| // |
| // This file defines the NoFolder class, a helper for IRBuilder. It provides |
| // IRBuilder with a set of methods for creating unfolded constants. This is |
| // useful for learners trying to understand how LLVM IR works, and who don't |
| // want details to be hidden by the constant folder. For general constant |
| // creation and folding, use ConstantExpr and the routines in |
| // llvm/Analysis/ConstantFolding.h. |
| // |
| // Note: since it is not actually possible to create unfolded constants, this |
| // class returns instructions rather than constants. |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #ifndef LLVM_IR_NOFOLDER_H |
| #define LLVM_IR_NOFOLDER_H |
| |
| #include "llvm/ADT/ArrayRef.h" |
| #include "llvm/IR/Constants.h" |
| #include "llvm/IR/InstrTypes.h" |
| #include "llvm/IR/Instruction.h" |
| #include "llvm/IR/Instructions.h" |
| |
| namespace llvm { |
| |
| /// NoFolder - Create "constants" (actually, instructions) with no folding. |
| class NoFolder { |
| public: |
| explicit NoFolder() = default; |
| |
| //===--------------------------------------------------------------------===// |
| // Binary Operators |
| //===--------------------------------------------------------------------===// |
| |
| Instruction *CreateAdd(Constant *LHS, Constant *RHS, |
| bool HasNUW = false, bool HasNSW = false) const { |
| BinaryOperator *BO = BinaryOperator::CreateAdd(LHS, RHS); |
| if (HasNUW) BO->setHasNoUnsignedWrap(); |
| if (HasNSW) BO->setHasNoSignedWrap(); |
| return BO; |
| } |
| |
| Instruction *CreateNSWAdd(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateNSWAdd(LHS, RHS); |
| } |
| |
| Instruction *CreateNUWAdd(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateNUWAdd(LHS, RHS); |
| } |
| |
| Instruction *CreateFAdd(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateFAdd(LHS, RHS); |
| } |
| |
| Instruction *CreateSub(Constant *LHS, Constant *RHS, |
| bool HasNUW = false, bool HasNSW = false) const { |
| BinaryOperator *BO = BinaryOperator::CreateSub(LHS, RHS); |
| if (HasNUW) BO->setHasNoUnsignedWrap(); |
| if (HasNSW) BO->setHasNoSignedWrap(); |
| return BO; |
| } |
| |
| Instruction *CreateNSWSub(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateNSWSub(LHS, RHS); |
| } |
| |
| Instruction *CreateNUWSub(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateNUWSub(LHS, RHS); |
| } |
| |
| Instruction *CreateFSub(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateFSub(LHS, RHS); |
| } |
| |
| Instruction *CreateMul(Constant *LHS, Constant *RHS, |
| bool HasNUW = false, bool HasNSW = false) const { |
| BinaryOperator *BO = BinaryOperator::CreateMul(LHS, RHS); |
| if (HasNUW) BO->setHasNoUnsignedWrap(); |
| if (HasNSW) BO->setHasNoSignedWrap(); |
| return BO; |
| } |
| |
| Instruction *CreateNSWMul(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateNSWMul(LHS, RHS); |
| } |
| |
| Instruction *CreateNUWMul(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateNUWMul(LHS, RHS); |
| } |
| |
| Instruction *CreateFMul(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateFMul(LHS, RHS); |
| } |
| |
| Instruction *CreateUDiv(Constant *LHS, Constant *RHS, |
| bool isExact = false) const { |
| if (!isExact) |
| return BinaryOperator::CreateUDiv(LHS, RHS); |
| return BinaryOperator::CreateExactUDiv(LHS, RHS); |
| } |
| |
| Instruction *CreateExactUDiv(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateExactUDiv(LHS, RHS); |
| } |
| |
| Instruction *CreateSDiv(Constant *LHS, Constant *RHS, |
| bool isExact = false) const { |
| if (!isExact) |
| return BinaryOperator::CreateSDiv(LHS, RHS); |
| return BinaryOperator::CreateExactSDiv(LHS, RHS); |
| } |
| |
| Instruction *CreateExactSDiv(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateExactSDiv(LHS, RHS); |
| } |
| |
| Instruction *CreateFDiv(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateFDiv(LHS, RHS); |
| } |
| |
| Instruction *CreateURem(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateURem(LHS, RHS); |
| } |
| |
| Instruction *CreateSRem(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateSRem(LHS, RHS); |
| } |
| |
| Instruction *CreateFRem(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateFRem(LHS, RHS); |
| } |
| |
| Instruction *CreateShl(Constant *LHS, Constant *RHS, bool HasNUW = false, |
| bool HasNSW = false) const { |
| BinaryOperator *BO = BinaryOperator::CreateShl(LHS, RHS); |
| if (HasNUW) BO->setHasNoUnsignedWrap(); |
| if (HasNSW) BO->setHasNoSignedWrap(); |
| return BO; |
| } |
| |
| Instruction *CreateLShr(Constant *LHS, Constant *RHS, |
| bool isExact = false) const { |
| if (!isExact) |
| return BinaryOperator::CreateLShr(LHS, RHS); |
| return BinaryOperator::CreateExactLShr(LHS, RHS); |
| } |
| |
| Instruction *CreateAShr(Constant *LHS, Constant *RHS, |
| bool isExact = false) const { |
| if (!isExact) |
| return BinaryOperator::CreateAShr(LHS, RHS); |
| return BinaryOperator::CreateExactAShr(LHS, RHS); |
| } |
| |
| Instruction *CreateAnd(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateAnd(LHS, RHS); |
| } |
| |
| Instruction *CreateOr(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateOr(LHS, RHS); |
| } |
| |
| Instruction *CreateXor(Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::CreateXor(LHS, RHS); |
| } |
| |
| Instruction *CreateBinOp(Instruction::BinaryOps Opc, |
| Constant *LHS, Constant *RHS) const { |
| return BinaryOperator::Create(Opc, LHS, RHS); |
| } |
| |
| //===--------------------------------------------------------------------===// |
| // Unary Operators |
| //===--------------------------------------------------------------------===// |
| |
| Instruction *CreateNeg(Constant *C, |
| bool HasNUW = false, bool HasNSW = false) const { |
| BinaryOperator *BO = BinaryOperator::CreateNeg(C); |
| if (HasNUW) BO->setHasNoUnsignedWrap(); |
| if (HasNSW) BO->setHasNoSignedWrap(); |
| return BO; |
| } |
| |
| Instruction *CreateNSWNeg(Constant *C) const { |
| return BinaryOperator::CreateNSWNeg(C); |
| } |
| |
| Instruction *CreateNUWNeg(Constant *C) const { |
| return BinaryOperator::CreateNUWNeg(C); |
| } |
| |
| Instruction *CreateFNeg(Constant *C) const { |
| return UnaryOperator::CreateFNeg(C); |
| } |
| |
| Instruction *CreateNot(Constant *C) const { |
| return BinaryOperator::CreateNot(C); |
| } |
| |
| Instruction *CreateUnOp(Instruction::UnaryOps Opc, Constant *C) const { |
| return UnaryOperator::Create(Opc, C); |
| } |
| |
| //===--------------------------------------------------------------------===// |
| // Memory Instructions |
| //===--------------------------------------------------------------------===// |
| |
| Constant *CreateGetElementPtr(Type *Ty, Constant *C, |
| ArrayRef<Constant *> IdxList) const { |
| return ConstantExpr::getGetElementPtr(Ty, C, IdxList); |
| } |
| |
| Constant *CreateGetElementPtr(Type *Ty, Constant *C, Constant *Idx) const { |
| // This form of the function only exists to avoid ambiguous overload |
| // warnings about whether to convert Idx to ArrayRef<Constant *> or |
| // ArrayRef<Value *>. |
| return ConstantExpr::getGetElementPtr(Ty, C, Idx); |
| } |
| |
| Instruction *CreateGetElementPtr(Type *Ty, Constant *C, |
| ArrayRef<Value *> IdxList) const { |
| return GetElementPtrInst::Create(Ty, C, IdxList); |
| } |
| |
| Constant *CreateInBoundsGetElementPtr(Type *Ty, Constant *C, |
| ArrayRef<Constant *> IdxList) const { |
| return ConstantExpr::getInBoundsGetElementPtr(Ty, C, IdxList); |
| } |
| |
| Constant *CreateInBoundsGetElementPtr(Type *Ty, Constant *C, |
| Constant *Idx) const { |
| // This form of the function only exists to avoid ambiguous overload |
| // warnings about whether to convert Idx to ArrayRef<Constant *> or |
| // ArrayRef<Value *>. |
| return ConstantExpr::getInBoundsGetElementPtr(Ty, C, Idx); |
| } |
| |
| Instruction *CreateInBoundsGetElementPtr(Type *Ty, Constant *C, |
| ArrayRef<Value *> IdxList) const { |
| return GetElementPtrInst::CreateInBounds(Ty, C, IdxList); |
| } |
| |
| //===--------------------------------------------------------------------===// |
| // Cast/Conversion Operators |
| //===--------------------------------------------------------------------===// |
| |
| Instruction *CreateCast(Instruction::CastOps Op, Constant *C, |
| Type *DestTy) const { |
| return CastInst::Create(Op, C, DestTy); |
| } |
| |
| Instruction *CreatePointerCast(Constant *C, Type *DestTy) const { |
| return CastInst::CreatePointerCast(C, DestTy); |
| } |
| |
| Instruction *CreateIntCast(Constant *C, Type *DestTy, |
| bool isSigned) const { |
| return CastInst::CreateIntegerCast(C, DestTy, isSigned); |
| } |
| |
| Instruction *CreateFPCast(Constant *C, Type *DestTy) const { |
| return CastInst::CreateFPCast(C, DestTy); |
| } |
| |
| Instruction *CreateBitCast(Constant *C, Type *DestTy) const { |
| return CreateCast(Instruction::BitCast, C, DestTy); |
| } |
| |
| Instruction *CreateIntToPtr(Constant *C, Type *DestTy) const { |
| return CreateCast(Instruction::IntToPtr, C, DestTy); |
| } |
| |
| Instruction *CreatePtrToInt(Constant *C, Type *DestTy) const { |
| return CreateCast(Instruction::PtrToInt, C, DestTy); |
| } |
| |
| Instruction *CreateZExtOrBitCast(Constant *C, Type *DestTy) const { |
| return CastInst::CreateZExtOrBitCast(C, DestTy); |
| } |
| |
| Instruction *CreateSExtOrBitCast(Constant *C, Type *DestTy) const { |
| return CastInst::CreateSExtOrBitCast(C, DestTy); |
| } |
| |
| Instruction *CreateTruncOrBitCast(Constant *C, Type *DestTy) const { |
| return CastInst::CreateTruncOrBitCast(C, DestTy); |
| } |
| |
| //===--------------------------------------------------------------------===// |
| // Compare Instructions |
| //===--------------------------------------------------------------------===// |
| |
| Instruction *CreateICmp(CmpInst::Predicate P, |
| Constant *LHS, Constant *RHS) const { |
| return new ICmpInst(P, LHS, RHS); |
| } |
| |
| Instruction *CreateFCmp(CmpInst::Predicate P, |
| Constant *LHS, Constant *RHS) const { |
| return new FCmpInst(P, LHS, RHS); |
| } |
| |
| //===--------------------------------------------------------------------===// |
| // Other Instructions |
| //===--------------------------------------------------------------------===// |
| |
| Instruction *CreateSelect(Constant *C, |
| Constant *True, Constant *False) const { |
| return SelectInst::Create(C, True, False); |
| } |
| |
| Instruction *CreateExtractElement(Constant *Vec, Constant *Idx) const { |
| return ExtractElementInst::Create(Vec, Idx); |
| } |
| |
| Instruction *CreateInsertElement(Constant *Vec, Constant *NewElt, |
| Constant *Idx) const { |
| return InsertElementInst::Create(Vec, NewElt, Idx); |
| } |
| |
| Instruction *CreateShuffleVector(Constant *V1, Constant *V2, |
| Constant *Mask) const { |
| return new ShuffleVectorInst(V1, V2, Mask); |
| } |
| |
| Instruction *CreateExtractValue(Constant *Agg, |
| ArrayRef<unsigned> IdxList) const { |
| return ExtractValueInst::Create(Agg, IdxList); |
| } |
| |
| Instruction *CreateInsertValue(Constant *Agg, Constant *Val, |
| ArrayRef<unsigned> IdxList) const { |
| return InsertValueInst::Create(Agg, Val, IdxList); |
| } |
| }; |
| |
| } // end namespace llvm |
| |
| #endif // LLVM_IR_NOFOLDER_H |