Data structure to hold cached (LLVM-IR) information. More...

#include "llvm/Transforms/IPO/Attributor.h"

Public Types
using	InstructionVectorTy = SmallVector<Instruction *, 8>
	A vector type to hold instructions.
using	OpcodeInstMapTy
	A map type from opcodes to instructions with this opcode.

Public Member Functions
	InformationCache (const Module &M, AnalysisGetter &AG, BumpPtrAllocator &Allocator, SetVector< Function * > *CGSCC, bool UseExplorer=true)
virtual	~InformationCache ()
OpcodeInstMapTy &	getOpcodeInstMapForFunction (const Function &F)
	Return the map that relates "interesting" opcodes with all instructions with that opcode in `F`.
InstructionVectorTy &	getReadOrWriteInstsForFunction (const Function &F)
	Return the instructions in `F` that may read or write memory.
MustBeExecutedContextExplorer *	getMustBeExecutedContextExplorer ()
	Return MustBeExecutedContextExplorer.
TargetLibraryInfo *	getTargetLibraryInfoForFunction (const Function &F)
	Return TargetLibraryInfo for function `F`.
bool	isKernel (const Function &F)
	Return true if `F` has the "kernel" function attribute.
bool	isInvolvedInMustTailCall (const Argument &Arg)
	Return true if `Arg` is involved in a must-tail call, thus the argument of the caller or callee.
bool	isOnlyUsedByAssume (const Instruction &I)
void	invalidateAnalyses ()
	Invalidates the cached analyses.
template<typename AP>
AP::Result *	getAnalysisResultForFunction (const Function &F, bool CachedOnly=false)
	Return the analysis result from a pass `AP` for function `F`.
const Module &	getModule () const
const DataLayout &	getDL () const
	Return datalayout used in the module.
const RetainedKnowledgeMap &	getKnowledgeMap () const
	Return the map conaining all the knowledge we have from llvm.assumes.
const AA::InstExclusionSetTy *	getOrCreateUniqueBlockExecutionSet (const AA::InstExclusionSetTy *BES)
	Given `BES`, return a uniqued version.
bool	stackIsAccessibleByOtherThreads ()
	Return true if the stack (llvm::Alloca) can be accessed by other threads.
bool	IsTargetGPU () const
	Return true if the target is a GPU.
LLVM_ABI ArrayRef< Function * >	getIndirectlyCallableFunctions (Attributor &A) const
	Return all functions that might be called indirectly, only valid for closed world modules (see isClosedWorldModule).
bool	isExactOrInlineable (const Function &F) const
	Return true if `F` has an exact definition or is inlineable.
LLVM_ABI std::optional< unsigned >	getFlatAddressSpace () const
	Return the flat address space if the associated target has.
virtual unsigned	getMaxAddrSpace () const

Static Public Member Functions
template<typename CBTy>
static void	foreachUse (Function &F, CBTy CB, bool LookThroughConstantExprUses=true)
	Apply `CB` to all uses of `F`.

Public Attributes
const SetVector< Function * > *const	CGSCC = nullptr
	The CG-SCC the pass is run on, or nullptr if it is a module pass.

Friends
struct	Attributor
	Give the Attributor access to the members so Attributor::identifyDefaultAbstractAttributes(...) can initialize them.

Detailed Description

Data structure to hold cached (LLVM-IR) information.

All attributes are given an InformationCache object at creation time to avoid inspection of the IR by all of them individually. This default InformationCache will hold information required by 'default' attributes, thus the ones deduced when Attributor::identifyDefaultAbstractAttributes(..) is called.

If custom abstract attributes, registered manually through Attributor::registerAA(...), need more information, especially if it is not reusable, it is advised to inherit from the InformationCache and cast the instance down in the abstract attributes.

Definition at line 1159 of file Attributor.h.

Member Typedef Documentation

◆ InstructionVectorTy

using llvm::InformationCache::InstructionVectorTy = SmallVector<Instruction *, 8>

A vector type to hold instructions.

Definition at line 1220 of file Attributor.h.

◆ OpcodeInstMapTy

using llvm::InformationCache::OpcodeInstMapTy

Initial value:

std::array<InstructionVectorTy *, Instruction::OtherOpsEnd>

A map type from opcodes to instructions with this opcode.

Definition at line 1223 of file Attributor.h.

Constructor & Destructor Documentation

◆ InformationCache()

llvm::InformationCache::InformationCache	(	const Module &	M,
		AnalysisGetter &	AG,
		BumpPtrAllocator &	Allocator,
		SetVector< Function * > *	CGSCC,
		bool	UseExplorer = true )

inline

Definition at line 1160 of file Attributor.h.

References CGSCC, and F.

◆ ~InformationCache()

virtual llvm::InformationCache::~InformationCache ( )

inlinevirtual

Definition at line 1181 of file Attributor.h.

Member Function Documentation

◆ foreachUse()

template<typename CBTy>

void llvm::InformationCache::foreachUse	(	Function &	F,
		CBTy	CB,
		bool	LookThroughConstantExprUses = true )

inlinestatic

Apply CB to all uses of F.

If LookThroughConstantExprUses is true, constant expression users are not given to CB but their uses are traversed transitively.

Definition at line 1198 of file Attributor.h.

References llvm::cast(), F, llvm::isa(), llvm::make_pointer_range(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), and llvm::SmallVectorTemplateCommon< T, typename >::size().

◆ getAnalysisResultForFunction()

template<typename AP>

AP::Result * llvm::InformationCache::getAnalysisResultForFunction	(	const Function &	F,
		bool	CachedOnly = false )

inline

Return the analysis result from a pass AP for function F.

Definition at line 1274 of file Attributor.h.

References F.

Referenced by llvm::AANonNull::isImpliedByIR(), and llvm::AA::isValidAtPosition().

◆ getDL()

const DataLayout & llvm::InformationCache::getDL ( ) const

inline

Return datalayout used in the module.

Definition at line 1282 of file Attributor.h.

◆ getFlatAddressSpace()

std::optional< unsigned > InformationCache::getFlatAddressSpace ( ) const

Return the flat address space if the associated target has.

Definition at line 3398 of file Attributor.cpp.

References IsTargetGPU().

◆ getIndirectlyCallableFunctions()

ArrayRef< Function * > InformationCache::getIndirectlyCallableFunctions ( Attributor & A ) const

Return all functions that might be called indirectly, only valid for closed world modules (see isClosedWorldModule).

Definition at line 3393 of file Attributor.cpp.

References A(), assert(), and Attributor.

◆ getKnowledgeMap()

const RetainedKnowledgeMap & llvm::InformationCache::getKnowledgeMap ( ) const

inline

Return the map conaining all the knowledge we have from llvm.assumes.

Definition at line 1285 of file Attributor.h.

Referenced by llvm::Attributor::getAttrsFromAssumes().

◆ getMaxAddrSpace()

virtual unsigned llvm::InformationCache::getMaxAddrSpace ( ) const

inlinevirtual

Definition at line 1325 of file Attributor.h.

◆ getModule()

const Module & llvm::InformationCache::getModule ( ) const

inline

Definition at line 1279 of file Attributor.h.

◆ getMustBeExecutedContextExplorer()

MustBeExecutedContextExplorer * llvm::InformationCache::getMustBeExecutedContextExplorer ( )

inline

Return MustBeExecutedContextExplorer.

Definition at line 1238 of file Attributor.h.

Referenced by llvm::Attributor::getAttrsFromAssumes().

◆ getOpcodeInstMapForFunction()

OpcodeInstMapTy & llvm::InformationCache::getOpcodeInstMapForFunction ( const Function & F )

inline

Return the map that relates "interesting" opcodes with all instructions with that opcode in F.

Definition at line 1228 of file Attributor.h.

References F.

◆ getOrCreateUniqueBlockExecutionSet()

const AA::InstExclusionSetTy * llvm::InformationCache::getOrCreateUniqueBlockExecutionSet ( const AA::InstExclusionSetTy * BES )

inline

Given BES, return a uniqued version.

Definition at line 1289 of file Attributor.h.

References assert(), llvm::SmallPtrSetImpl< PtrType >::find(), and llvm::Success.

◆ getReadOrWriteInstsForFunction()

InstructionVectorTy & llvm::InformationCache::getReadOrWriteInstsForFunction ( const Function & F )

inline

Return the instructions in F that may read or write memory.

Definition at line 1233 of file Attributor.h.

References F.

◆ getTargetLibraryInfoForFunction()

TargetLibraryInfo * llvm::InformationCache::getTargetLibraryInfoForFunction ( const Function & F )

inline

Return TargetLibraryInfo for function F.

Definition at line 1243 of file Attributor.h.

References F.

◆ invalidateAnalyses()

void llvm::InformationCache::invalidateAnalyses ( )

inline

Invalidates the cached analyses.

Valid only when using the new pass manager.

Definition at line 1270 of file Attributor.h.

◆ isExactOrInlineable()

bool llvm::InformationCache::isExactOrInlineable ( const Function & F ) const

inline

Return true if F has an exact definition or is inlineable.

This is computed once when the information of F is initialized. For functions that are not initialized yet, only the definition is checked, as InlineableFunctions is also only filled on initialization.

Definition at line 1316 of file Attributor.h.

References F.

◆ isInvolvedInMustTailCall()

bool llvm::InformationCache::isInvolvedInMustTailCall ( const Argument & Arg )

inline

Return true if Arg is involved in a must-tail call, thus the argument of the caller or callee.

Definition at line 1255 of file Attributor.h.

References llvm::Argument::getParent().

◆ isKernel()

bool llvm::InformationCache::isKernel ( const Function & F )

inline

Return true if F has the "kernel" function attribute.

Definition at line 1248 of file Attributor.h.

References F.

◆ isOnlyUsedByAssume()

bool llvm::InformationCache::isOnlyUsedByAssume ( const Instruction & I )

inline

Definition at line 1260 of file Attributor.h.

References F, and I.

◆ IsTargetGPU()

bool llvm::InformationCache::IsTargetGPU ( ) const

inline

Return true if the target is a GPU.

Definition at line 1304 of file Attributor.h.

Referenced by getFlatAddressSpace(), and stackIsAccessibleByOtherThreads().

◆ stackIsAccessibleByOtherThreads()

bool llvm::InformationCache::stackIsAccessibleByOtherThreads ( )

inline

Return true if the stack (llvm::Alloca) can be accessed by other threads.

Definition at line 1301 of file Attributor.h.

References IsTargetGPU().

Referenced by llvm::AA::isAssumedThreadLocalObject().

◆ Attributor

friend struct Attributor

friend

Give the Attributor access to the members so Attributor::identifyDefaultAbstractAttributes(...) can initialize them.

Definition at line 1412 of file Attributor.h.

References Attributor.

Referenced by Attributor, and getIndirectlyCallableFunctions().

Member Data Documentation

◆ CGSCC

const SetVector<Function *>* const llvm::InformationCache::CGSCC = nullptr

The CG-SCC the pass is run on, or nullptr if it is a module pass.

Definition at line 1217 of file Attributor.h.

Referenced by InformationCache().

The documentation for this struct was generated from the following files:

include/llvm/Transforms/IPO/Attributor.h
lib/Transforms/IPO/Attributor.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ InstructionVectorTy

◆ OpcodeInstMapTy

Constructor & Destructor Documentation

◆ InformationCache()

◆ ~InformationCache()

Member Function Documentation

◆ foreachUse()

◆ getAnalysisResultForFunction()

◆ getDL()

◆ getFlatAddressSpace()

◆ getIndirectlyCallableFunctions()

◆ getKnowledgeMap()

◆ getMaxAddrSpace()

◆ getModule()

◆ getMustBeExecutedContextExplorer()

◆ getOpcodeInstMapForFunction()

◆ getOrCreateUniqueBlockExecutionSet()

◆ getReadOrWriteInstsForFunction()

◆ getTargetLibraryInfoForFunction()

◆ invalidateAnalyses()

◆ isExactOrInlineable()

◆ isInvolvedInMustTailCall()

◆ isKernel()

◆ isOnlyUsedByAssume()

◆ IsTargetGPU()

◆ stackIsAccessibleByOtherThreads()

Friends And Related Symbol Documentation

◆ Attributor

Member Data Documentation

◆ CGSCC