#include "InstCombineInternal.h"
#include "llvm/ADT/MapVector.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Analysis/AliasAnalysis.h"
#include "llvm/Analysis/Loads.h"
#include "llvm/IR/ConstantRange.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/DebugInfoMetadata.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/LLVMContext.h"
#include "llvm/IR/MDBuilder.h"
#include "llvm/IR/PatternMatch.h"
#include "llvm/Transforms/InstCombine/InstCombiner.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
#include "llvm/Transforms/Utils/Local.h"

Include dependency graph for InstCombineLoadStoreAlloca.cpp:

Macros
#define	DEBUG_TYPE "instcombine"

Functions
	STATISTIC (NumDeadStore, "Number of dead stores eliminated")

	STATISTIC (NumGlobalCopies, "Number of allocas copied from constant global")

static bool	isOnlyCopiedFromConstantMemory (AAResults AA, Value V, MemTransferInst &TheCopy, SmallVectorImpl< Instruction > &ToDelete)
	isOnlyCopiedFromConstantGlobal - Recursively walk the uses of a (derived) pointer to an alloca. More...

static MemTransferInst *	isOnlyCopiedFromConstantMemory (AAResults AA, AllocaInst AI, SmallVectorImpl< Instruction * > &ToDelete)
	isOnlyCopiedFromConstantGlobal - Return true if the specified alloca is only modified by a copy from a constant global. More...

static bool	isDereferenceableForAllocaSize (const Value V, const AllocaInst AI, const DataLayout &DL)
	Returns true if V is dereferenceable for size of alloca. More...

static Instruction *	simplifyAllocaArraySize (InstCombinerImpl &IC, AllocaInst &AI)

static bool	isSupportedAtomicType (Type *Ty)

static StoreInst *	combineStoreToNewValue (InstCombinerImpl &IC, StoreInst &SI, Value *V)
	Combine a store to a new type. More...

static bool	isMinMaxWithLoads (Value V, Type &LoadTy)
	Returns true if instruction represent minmax pattern like: select ((cmp load V1, load V2), V1, V2). More...

static Instruction *	combineLoadToOperationType (InstCombinerImpl &IC, LoadInst &LI)
	Combine loads to match the type of their uses' value after looking through intervening bitcasts. More...

static Instruction *	unpackLoadToAggregate (InstCombinerImpl &IC, LoadInst &LI)

static bool	isObjectSizeLessThanOrEq (Value *V, uint64_t MaxSize, const DataLayout &DL)

static bool	canReplaceGEPIdxWithZero (InstCombinerImpl &IC, GetElementPtrInst GEPI, Instruction MemI, unsigned &Idx)

template<typename T >
static Instruction *	replaceGEPIdxWithZero (InstCombinerImpl &IC, Value *Ptr, T &MemI)

static bool	canSimplifyNullStoreOrGEP (StoreInst &SI)

static bool	canSimplifyNullLoadOrGEP (LoadInst &LI, Value *Op)

static Value *	likeBitCastFromVector (InstCombinerImpl &IC, Value *V)
	Look for extractelement/insertvalue sequence that acts like a bitcast. More...

static bool	combineStoreToValueType (InstCombinerImpl &IC, StoreInst &SI)
	Combine stores to match the type of value being stored. More...

static bool	unpackStoreToAggregate (InstCombinerImpl &IC, StoreInst &SI)

static bool	equivalentAddressValues (Value A, Value B)
	equivalentAddressValues - Test if A and B will obviously have the same value. More...

static bool	removeBitcastsFromLoadStoreOnMinMax (InstCombinerImpl &IC, StoreInst &SI)
	Converts store (bitcast (load (bitcast (select ...)))) to store (load (select ...)), where select is minmax: select ((cmp load V1, load V2), V1, V2). More...

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE "instcombine"

Definition at line 32 of file InstCombineLoadStoreAlloca.cpp.

Function Documentation

◆ canReplaceGEPIdxWithZero()

static bool canReplaceGEPIdxWithZero	(	InstCombinerImpl &	IC,
		GetElementPtrInst *	GEPI,
		Instruction *	MemI,
		unsigned &	Idx
	)

static

Definition at line 822 of file InstCombineLoadStoreAlloca.cpp.

References llvm::InstCombinerImpl::computeKnownBits(), DL, llvm::numbers::e, llvm::InstCombiner::getDataLayout(), llvm::GetElementPtrInst::getIndexedType(), llvm::User::getNumOperands(), llvm::User::getOperand(), llvm::GetElementPtrInst::getSourceElementType(), i, I, llvm::GetElementPtrInst::idx_begin(), llvm::ARM_PROC::IE, llvm::GetElementPtrInst::isInBounds(), llvm::KnownBits::isNonNegative(), isObjectSizeLessThanOrEq(), and llvm::Type::isSized().

Referenced by replaceGEPIdxWithZero().

◆ canSimplifyNullLoadOrGEP()

static bool canSimplifyNullLoadOrGEP	(	LoadInst &	LI,
		Value *	Op
	)

static

Definition at line 926 of file InstCombineLoadStoreAlloca.cpp.

References llvm::Instruction::getFunction(), llvm::LoadInst::getPointerAddressSpace(), and llvm::NullPointerIsDefined().

Referenced by llvm::InstCombinerImpl::visitLoadInst().

◆ canSimplifyNullStoreOrGEP()

static bool canSimplifyNullStoreOrGEP ( StoreInst & SI )

static

Definition at line 915 of file InstCombineLoadStoreAlloca.cpp.

References llvm::NullPointerIsDefined(), and SI.

Referenced by llvm::InstCombinerImpl::visitStoreInst().

◆ combineLoadToOperationType()

static Instruction* combineLoadToOperationType	(	InstCombinerImpl &	IC,
		LoadInst &	LI
	)

static

Combine loads to match the type of their uses' value after looking through intervening bitcasts.

The core idea here is that if the result of a load is used in an operation, we should load the type most conducive to that operation. For example, when loading an integer and converting that immediately to a pointer, we should instead directly load a pointer.

However, this routine must never change the width of a load or the number of loads as that would introduce a semantic change. This combine is expected to be a semantic no-op which just allows loads to more closely model the types of their consuming operations.

Currently, we also refuse to change the precise type used for an atomic load or a volatile load. This is debatable, and might be reasonable to change later. However, it is risky in case some backend or other part of LLVM is relying on the exact type loaded to select appropriate atomic operations.

Definition at line 587 of file InstCombineLoadStoreAlloca.cpp.

References assert(), llvm::InstCombinerImpl::combineLoadToNewType(), DL, llvm::InstCombinerImpl::eraseInstFromFunction(), llvm::InstCombiner::getDataLayout(), llvm::LoadInst::getPointerOperand(), llvm::Value::getType(), llvm::Value::hasOneUse(), llvm::Instruction::isAtomic(), llvm::Type::isPtrOrPtrVectorTy(), isSupportedAtomicType(), llvm::Value::isSwiftError(), llvm::LoadInst::isUnordered(), llvm::Type::isX86_AMXTy(), llvm::Value::replaceAllUsesWith(), llvm::Value::use_empty(), and llvm::Instruction::user_back().

Referenced by llvm::InstCombinerImpl::visitLoadInst().

◆ combineStoreToNewValue()

static StoreInst* combineStoreToNewValue	(	InstCombinerImpl &	IC,
		StoreInst &	SI,
		Value *	V
	)

static

Combine a store to a new type.

Returns the newly created store instruction.

Definition at line 493 of file InstCombineLoadStoreAlloca.cpp.

References assert(), llvm::InstCombiner::Builder, llvm::IRBuilderBase::CreateAlignedStore(), llvm::IRBuilderBase::CreateBitCast(), llvm::Type::getPointerTo(), llvm::Value::getType(), isSupportedAtomicType(), N, llvm::StoreInst::setAtomic(), llvm::Instruction::setMetadata(), and SI.

Referenced by combineStoreToValueType(), removeBitcastsFromLoadStoreOnMinMax(), and unpackStoreToAggregate().

◆ combineStoreToValueType()

static bool combineStoreToValueType	(	InstCombinerImpl &	IC,
		StoreInst &	SI
	)

static

Combine stores to match the type of value being stored.

The core idea here is that the memory does not have any intrinsic type and where we can we should match the type of a store to the type of value being stored.

However, this routine must never change the width of a store or the number of stores as that would introduce a semantic change. This combine is expected to be a semantic no-op which just allows stores to more closely model the types of their incoming values.

Currently, we also refuse to change the precise type used for an atomic or volatile store. This is debatable, and might be reasonable to change later. However, it is risky in case some backend or other part of LLVM is relying on the exact type stored to select appropriate atomic operations.

Returns: true if the store was successfully combined away. This indicates the caller must erase the store instruction. We have to let the caller erase the store instruction as otherwise there is no way to signal whether it was combined or not: IC.EraseInstFromFunction returns a null pointer.

Definition at line 1116 of file InstCombineLoadStoreAlloca.cpp.

References assert(), combineStoreToNewValue(), llvm::Value::getType(), isSupportedAtomicType(), llvm::Type::isX86_AMXTy(), likeBitCastFromVector(), and SI.

Referenced by llvm::InstCombinerImpl::visitStoreInst().

◆ equivalentAddressValues()

static bool equivalentAddressValues	(	Value *	A,
		Value *	B
	)

static

equivalentAddressValues - Test if A and B will obviously have the same value.

This includes recognizing that t0 and t1 will have the same value in code like this: t0 = getelementptr @a, 0, 3 store i32 0, i32* t0 t1 = getelementptr @a, 0, 3 t2 = load i32* t1

Definition at line 1266 of file InstCombineLoadStoreAlloca.cpp.

References B.

Referenced by llvm::InstCombinerImpl::visitStoreInst().

◆ isDereferenceableForAllocaSize()

static bool isDereferenceableForAllocaSize	(	const Value *	V,
		const AllocaInst *	AI,
		const DataLayout &	DL
	)

static

Returns true if V is dereferenceable for size of alloca.

Definition at line 159 of file InstCombineLoadStoreAlloca.cpp.

References Align, DL, llvm::AllocaInst::getAlignment(), llvm::AllocaInst::getAllocatedType(), llvm::AllocaInst::isArrayAllocation(), and llvm::isDereferenceableAndAlignedPointer().

Referenced by llvm::InstCombinerImpl::visitAllocaInst().

◆ isMinMaxWithLoads()

static bool isMinMaxWithLoads	(	Value *	V,
		Type *&	LoadTy
	)

static

Returns true if instruction represent minmax pattern like: select ((cmp load V1, load V2), V1, V2).

Definition at line 549 of file InstCombineLoadStoreAlloca.cpp.

References assert(), llvm::Value::getType(), llvm::Type::isPointerTy(), L2, llvm::PatternMatch::m_Cmp(), llvm::PatternMatch::m_Instruction(), llvm::PatternMatch::m_Load(), llvm::PatternMatch::m_Select(), llvm::PatternMatch::m_Specific(), llvm::PatternMatch::m_Value(), llvm::PatternMatch::match(), and llvm::InstCombiner::peekThroughBitcast().

Referenced by removeBitcastsFromLoadStoreOnMinMax().

◆ isObjectSizeLessThanOrEq()

static bool isObjectSizeLessThanOrEq	(	Value *	V,
		uint64_t	MaxSize,
		const DataLayout &	DL
	)

static

Definition at line 743 of file InstCombineLoadStoreAlloca.cpp.

References llvm::append_range(), DL, llvm::ConstantInt::getValue(), llvm::SmallPtrSetImpl< PtrType >::insert(), P, llvm::SmallVectorImpl< T >::pop_back_val(), SI, and llvm::APInt::zextOrSelf().

Referenced by canReplaceGEPIdxWithZero().

◆ isOnlyCopiedFromConstantMemory() [1/2]

static MemTransferInst* isOnlyCopiedFromConstantMemory	(	AAResults *	AA,
		AllocaInst *	AI,
		SmallVectorImpl< Instruction * > &	ToDelete
	)

static

isOnlyCopiedFromConstantGlobal - Return true if the specified alloca is only modified by a copy from a constant global.

If we can prove this, we can replace any uses of the alloca with uses of the global directly.

Definition at line 149 of file InstCombineLoadStoreAlloca.cpp.

References isOnlyCopiedFromConstantMemory().

◆ isOnlyCopiedFromConstantMemory() [2/2]

static bool isOnlyCopiedFromConstantMemory	(	AAResults *	AA,
		Value *	V,
		MemTransferInst *&	TheCopy,
		SmallVectorImpl< Instruction * > &	ToDelete
	)

static

isOnlyCopiedFromConstantGlobal - Recursively walk the uses of a (derived) pointer to an alloca.

Ignore any reads of the pointer, return false if we see any stores or other unknown uses. If we see pointer arithmetic, keep track of whether it moves the pointer (with IsOffset) but otherwise traverse the uses. If we see a memcpy/memmove that targets an unoffseted pointer to the alloca, and if the source pointer is a pointer to a constant global, we can optimize this.

Definition at line 45 of file InstCombineLoadStoreAlloca.cpp.

References assert(), llvm::SmallVectorImpl< T >::emplace_back(), GEP, I, MI, llvm::AAResults::pointsToConstantMemory(), and llvm::SmallVectorImpl< T >::pop_back_val().

Referenced by isOnlyCopiedFromConstantMemory(), and llvm::InstCombinerImpl::visitAllocaInst().

◆ isSupportedAtomicType()

static bool isSupportedAtomicType ( Type * Ty )

static

Definition at line 457 of file InstCombineLoadStoreAlloca.cpp.

References llvm::Type::isFloatingPointTy(), and llvm::Type::isIntOrPtrTy().

Referenced by llvm::InstCombinerImpl::combineLoadToNewType(), combineLoadToOperationType(), combineStoreToNewValue(), and combineStoreToValueType().

◆ likeBitCastFromVector()

static Value* likeBitCastFromVector	(	InstCombinerImpl &	IC,
		Value *	V
	)

static

Look for extractelement/insertvalue sequence that acts like a bitcast.

Returns: underlying value that was "cast", or nullptr otherwise.

For example, if we have:

%E0 = extractelement <2 x double> %U, i32 0
%V0 = insertvalue [2 x double] undef, double %E0, 0
%E1 = extractelement <2 x double> %U, i32 1
%V1 = insertvalue [2 x double] %V0, double %E1, 1

and the layout of a <2 x double> is isomorphic to a [2 x double], then V1 can be safely approximated by a conceptual "bitcast" of U. Note that U may contain non-undef values where V1 has undef.

Definition at line 1055 of file InstCombineLoadStoreAlloca.cpp.

References DL, E, llvm::InstCombiner::getDataLayout(), llvm::Value::getType(), llvm::PatternMatch::m_Undef(), llvm::PatternMatch::match(), llvm::ARM_MB::ST, and llvm::RISCVFenceField::W.

Referenced by combineStoreToValueType().