LLVM 19.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::InformationCache Struct Reference

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 = DenseMap< unsigned, InstructionVectorTy * >
 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)
 
 ~InformationCache ()
 
OpcodeInstMapTygetOpcodeInstMapForFunction (const Function &F)
 Return the map that relates "interesting" opcodes with all instructions with that opcode in F.
 
InstructionVectorTygetReadOrWriteInstsForFunction (const Function &F)
 Return the instructions in F that may read or write memory.
 
MustBeExecutedContextExplorergetMustBeExecutedContextExplorer ()
 Return MustBeExecutedContextExplorer.
 
TargetLibraryInfogetTargetLibraryInfoForFunction (const Function &F)
 Return TargetLibraryInfo for function F.
 
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) const
 
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 DataLayoutgetDL ()
 Return datalayout used in the module.
 
const RetainedKnowledgeMapgetKnowledgeMap () const
 Return the map conaining all the knowledge we have from llvm.assumes.
 
const AA::InstExclusionSetTygetOrCreateUniqueBlockExecutionSet (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 targetIsGPU ()
 Return true if the target is a GPU.
 
const ArrayRef< Function * > getIndirectlyCallableFunctions (Attributor &A) const
 Return all functions that might be called indirectly, only valid for closed world modules (see isClosedWorldModule).
 

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 1197 of file Attributor.h.

Member Typedef Documentation

◆ InstructionVectorTy

A vector type to hold instructions.

Definition at line 1258 of file Attributor.h.

◆ OpcodeInstMapTy

A map type from opcodes to instructions with this opcode.

Definition at line 1261 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 1198 of file Attributor.h.

References Allocator, F, and llvm::AnalysisGetter::getAnalysis().

◆ ~InformationCache()

llvm::InformationCache::~InformationCache ( )
inline

Definition at line 1219 of file Attributor.h.

Member Function Documentation

◆ foreachUse()

template<typename CBTy >
static 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 1236 of file Attributor.h.

References F, Idx, llvm::make_pointer_range(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::SmallVectorBase< Size_T >::size(), and llvm::Value::uses().

◆ 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 1301 of file Attributor.h.

References F, and llvm::AnalysisGetter::getAnalysis().

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

◆ getDL()

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

Return datalayout used in the module.

Definition at line 1307 of file Attributor.h.

◆ getIndirectlyCallableFunctions()

const 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 3313 of file Attributor.cpp.

References A, and assert().

◆ getKnowledgeMap()

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

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

Definition at line 1310 of file Attributor.h.

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

◆ getMustBeExecutedContextExplorer()

MustBeExecutedContextExplorer * llvm::InformationCache::getMustBeExecutedContextExplorer ( )
inline

Return MustBeExecutedContextExplorer.

Definition at line 1275 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 1265 of file Attributor.h.

References F.

Referenced by llvm::Attributor::checkForAllInstructions(), llvm::Attributor::identifyDefaultAbstractAttributes(), and llvm::Attributor::isValidFunctionSignatureRewrite().

◆ getOrCreateUniqueBlockExecutionSet()

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

Given BES, return a uniqued version.

Definition at line 1314 of file Attributor.h.

References assert(), and Success.

◆ getReadOrWriteInstsForFunction()

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

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

Definition at line 1270 of file Attributor.h.

References F.

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

◆ getTargetLibraryInfoForFunction()

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

Return TargetLibraryInfo for function F.

Definition at line 1280 of file Attributor.h.

References F, and llvm::AnalysisGetter::getAnalysis().

◆ invalidateAnalyses()

void llvm::InformationCache::invalidateAnalyses ( )
inline

Invalidates the cached analyses.

Valid only when using the new pass manager.

Definition at line 1297 of file Attributor.h.

References llvm::AnalysisGetter::invalidateAnalyses().

◆ 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 1286 of file Attributor.h.

References llvm::Argument::getParent().

◆ isOnlyUsedByAssume()

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

Definition at line 1291 of file Attributor.h.

References I.

◆ stackIsAccessibleByOtherThreads()

bool llvm::InformationCache::stackIsAccessibleByOtherThreads ( )
inline

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

Definition at line 1326 of file Attributor.h.

References targetIsGPU().

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

◆ targetIsGPU()

bool llvm::InformationCache::targetIsGPU ( )
inline

Return true if the target is a GPU.

Definition at line 1329 of file Attributor.h.

References llvm::Triple::isAMDGPU(), and llvm::Triple::isNVPTX().

Referenced by stackIsAccessibleByOtherThreads().

Friends And Related Function Documentation

◆ Attributor

friend struct Attributor
friend

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

Definition at line 1409 of file Attributor.h.

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 1255 of file Attributor.h.


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