Attributor.cpp File Reference

#include "llvm/Transforms/IPO/Attributor.h"
#include "llvm/ADT/PointerIntPair.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/Statistic.h"
#include "llvm/Analysis/AliasAnalysis.h"
#include "llvm/Analysis/CallGraph.h"
#include "llvm/Analysis/CallGraphSCCPass.h"
#include "llvm/Analysis/InlineCost.h"
#include "llvm/Analysis/MemoryBuiltins.h"
#include "llvm/Analysis/MustExecute.h"
#include "llvm/IR/Attributes.h"
#include "llvm/IR/Constant.h"
#include "llvm/IR/ConstantFold.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/DataLayout.h"
#include "llvm/IR/GlobalValue.h"
#include "llvm/IR/GlobalVariable.h"
#include "llvm/IR/Instruction.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/ValueHandle.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/DebugCounter.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/GraphWriter.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/Transforms/Utils/BasicBlockUtils.h"
#include "llvm/Transforms/Utils/Cloning.h"
#include "llvm/Transforms/Utils/Local.h"
#include <cstdint>
#include <cassert>
#include <optional>
#include <string>

Go to the source code of this file.

Classes
struct	llvm::GraphTraits< AADepGraphNode * >
struct	llvm::GraphTraits< AADepGraph * >
struct	llvm::DOTGraphTraits< AADepGraph * >

Namespaces
namespace	llvm
	This is an optimization pass for GlobalISel generic memory operations.

Macros
#define	DEBUG_TYPE   "attributor"
#define	VERBOSE_DEBUG_TYPE   DEBUG_TYPE "-verbose"

Functions
	DEBUG_COUNTER (ManifestDBGCounter, "attributor-manifest", "Determine what attributes are manifested in the IR")
	STATISTIC (NumFnDeleted, "Number of function deleted")
	STATISTIC (NumFnWithExactDefinition, "Number of functions with exact definitions")
	STATISTIC (NumFnWithoutExactDefinition, "Number of functions without exact definitions")
	STATISTIC (NumFnShallowWrappersCreated, "Number of shallow wrappers created")
	STATISTIC (NumAttributesTimedOut, "Number of abstract attributes timed out before fixpoint")
	STATISTIC (NumAttributesValidFixpoint, "Number of abstract attributes in a valid fixpoint state")
	STATISTIC (NumAttributesManifested, "Number of abstract attributes manifested in IR")
template<bool IsLoad, typename Ty >
static bool	getPotentialCopiesOfMemoryValue (Attributor &A, Ty &I, SmallSetVector< Value *, 4 > &PotentialCopies, SmallSetVector< Instruction *, 4 > &PotentialValueOrigins, const AbstractAttribute &QueryingAA, bool &UsedAssumedInformation, bool OnlyExact)
static bool	isAssumedReadOnlyOrReadNone (Attributor &A, const IRPosition &IRP, const AbstractAttribute &QueryingAA, bool RequireReadNone, bool &IsKnown)
static bool	isPotentiallyReachable (Attributor &A, const Instruction &FromI, const Instruction *ToI, const Function &ToFn, const AbstractAttribute &QueryingAA, const AA::InstExclusionSetTy *ExclusionSet, std::function< bool(const Function &F)> GoBackwardsCB)
static bool	isEqualOrWorse (const Attribute &New, const Attribute &Old)
	Return true if New is equal or worse than Old.
static bool	addIfNotExistent (LLVMContext &Ctx, const Attribute &Attr, AttributeList &Attrs, int AttrIdx, bool ForceReplace=false)
	Return true if the information provided by Attr was added to the attribute list Attrs.
static bool	checkForAllInstructionsImpl (Attributor *A, InformationCache::OpcodeInstMapTy &OpcodeInstMap, function_ref< bool(Instruction &)> Pred, const AbstractAttribute *QueryingAA, const AAIsDead *LivenessAA, const ArrayRef< unsigned > &Opcodes, bool &UsedAssumedInformation, bool CheckBBLivenessOnly=false, bool CheckPotentiallyDead=false)
static bool	runAttributorOnFunctions (InformationCache &InfoCache, SetVector< Function * > &Functions, AnalysisGetter &AG, CallGraphUpdater &CGUpdater, bool DeleteFns, bool IsModulePass)
	}

Variables
static cl::opt< unsigned >	SetFixpointIterations ("attributor-max-iterations", cl::Hidden, cl::desc("Maximal number of fixpoint iterations."), cl::init(32))
static cl::opt< unsigned, true >	MaxInitializationChainLengthX ("attributor-max-initialization-chain-length", cl::Hidden, cl::desc("Maximal number of chained initializations (to avoid stack overflows)"), cl::location(MaxInitializationChainLength), cl::init(1024))
static cl::opt< bool >	VerifyMaxFixpointIterations ("attributor-max-iterations-verify", cl::Hidden, cl::desc("Verify that max-iterations is a tight bound for a fixpoint"), cl::init(false))
static cl::opt< bool >	AnnotateDeclarationCallSites ("attributor-annotate-decl-cs", cl::Hidden, cl::desc("Annotate call sites of function declarations."), cl::init(false))
static cl::opt< bool >	EnableHeapToStack ("enable-heap-to-stack-conversion", cl::init(true), cl::Hidden)
static cl::opt< bool >	AllowShallowWrappers ("attributor-allow-shallow-wrappers", cl::Hidden, cl::desc("Allow the Attributor to create shallow " "wrappers for non-exact definitions."), cl::init(false))
static cl::opt< bool >	AllowDeepWrapper ("attributor-allow-deep-wrappers", cl::Hidden, cl::desc("Allow the Attributor to use IP information " "derived from non-exact functions via cloning"), cl::init(false))
static cl::list< std::string >	SeedAllowList ("attributor-seed-allow-list", cl::Hidden, cl::desc("Comma seperated list of attribute names that are " "allowed to be seeded."), cl::CommaSeparated)
static cl::list< std::string >	FunctionSeedAllowList ("attributor-function-seed-allow-list", cl::Hidden, cl::desc("Comma seperated list of function names that are " "allowed to be seeded."), cl::CommaSeparated)
static cl::opt< bool >	DumpDepGraph ("attributor-dump-dep-graph", cl::Hidden, cl::desc("Dump the dependency graph to dot files."), cl::init(false))
static cl::opt< std::string >	DepGraphDotFileNamePrefix ("attributor-depgraph-dot-filename-prefix", cl::Hidden, cl::desc("The prefix used for the CallGraph dot file names."))
static cl::opt< bool >	ViewDepGraph ("attributor-view-dep-graph", cl::Hidden, cl::desc("View the dependency graph."), cl::init(false))
static cl::opt< bool >	PrintDependencies ("attributor-print-dep", cl::Hidden, cl::desc("Print attribute dependencies"), cl::init(false))
static cl::opt< bool >	EnableCallSiteSpecific ("attributor-enable-call-site-specific-deduction", cl::Hidden, cl::desc("Allow the Attributor to do call site specific analysis"), cl::init(false))
static cl::opt< bool >	PrintCallGraph ("attributor-print-call-graph", cl::Hidden, cl::desc("Print Attributor's internal call graph"), cl::init(false))
static cl::opt< bool >	SimplifyAllLoads ("attributor-simplify-all-loads", cl::Hidden, cl::desc("Try to simplify all loads."), cl::init(true))

Macro Definition Documentation

DEBUG_TYPE

#define DEBUG_TYPE   "attributor"

Definition at line 60 of file Attributor.cpp.

VERBOSE_DEBUG_TYPE

#define VERBOSE_DEBUG_TYPE   DEBUG_TYPE "-verbose"

Definition at line 61 of file Attributor.cpp.

Function Documentation

addIfNotExistent()

static bool addIfNotExistent ( LLVMContext &  Ctx, const Attribute &  Attr, AttributeList &  Attrs, int  AttrIdx, bool  ForceReplace = false  )

static

Return true if the information provided by Attr was added to the attribute list Attrs.

This is only the case if it was not already present in Attrs at the position describe by PK and AttrIdx.

Definition at line 903 of file Attributor.cpp.

References llvm::Attribute::getKindAsEnum(), llvm::Attribute::getKindAsString(), llvm::Attribute::isEnumAttribute(), isEqualOrWorse(), llvm::Attribute::isIntAttribute(), llvm::Attribute::isStringAttribute(), and llvm_unreachable.

Referenced by llvm::IRAttributeManifest::manifestAttrs().

checkForAllInstructionsImpl()

static bool checkForAllInstructionsImpl ( Attributor *  A, InformationCache::OpcodeInstMapTy &  OpcodeInstMap, function_ref< bool(Instruction &)>  Pred, const AbstractAttribute *  QueryingAA, const AAIsDead *  LivenessAA, const ArrayRef< unsigned > &  Opcodes, bool &  UsedAssumedInformation, bool  CheckBBLivenessOnly = false, bool  CheckPotentiallyDead = false  )

static

Definition at line 1875 of file Attributor.cpp.

References A, llvm::dbgs(), DEBUG_WITH_TYPE, I, llvm::IRPosition::inst(), llvm::DenseMapBase< DerivedT, KeyT, ValueT, KeyInfoT, BucketT >::lookup(), and VERBOSE_DEBUG_TYPE.

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

DEBUG_COUNTER()

DEBUG_COUNTER	(	ManifestDBGCounter	,
		"attributor-manifest"	,
		"Determine what attributes are manifested in the IR"
	)

getPotentialCopiesOfMemoryValue()

template<bool IsLoad, typename Ty >

static bool getPotentialCopiesOfMemoryValue ( Attributor &  A, Ty &  I, SmallSetVector< Value *, 4 > &  PotentialCopies, SmallSetVector< Instruction *, 4 > &  PotentialValueOrigins, const AbstractAttribute &  QueryingAA, bool &  UsedAssumedInformation, bool  OnlyExact  )

static

Definition at line 351 of file Attributor.cpp.

References A, assert(), llvm::SmallVectorTemplateCommon< T, typename >::begin(), llvm::dbgs(), DL, llvm::SmallVectorTemplateCommon< T, typename >::end(), llvm::AAPointerInfo::Access::getContent(), llvm::AA::getInitialValueForObj(), llvm::AAPointerInfo::Access::getRemoteInst(), llvm::AA::getWithType(), llvm::AAPointerInfo::Access::getWrittenValue(), I, llvm::SetVector< T, Vector, Set >::insert(), llvm::AA::Interprocedural, llvm::isAllocationFn(), llvm::isNoAliasCall(), llvm::AAPointerInfo::Access::isRead(), llvm::AAPointerInfo::Access::isWriteOrAssumption(), llvm::AAPointerInfo::Access::isWrittenValueUnknown(), llvm::AAPointerInfo::Access::isWrittenValueYetUndetermined(), LLVM_DEBUG, llvm::NullPointerIsDefined(), Ptr, llvm::SmallVectorTemplateBase< T, bool >::push_back(), SI, and llvm::IRPosition::value().

Referenced by llvm::AA::getPotentialCopiesOfStoredValue(), and llvm::AA::getPotentiallyLoadedValues().

isAssumedReadOnlyOrReadNone()

static bool isAssumedReadOnlyOrReadNone ( Attributor &  A, const IRPosition &  IRP, const AbstractAttribute &  QueryingAA, bool  RequireReadNone, bool &  IsKnown  )

static

Definition at line 567 of file Attributor.cpp.

References A, llvm::IRPosition::getPositionKind(), llvm::IRPosition::IRP_CALL_SITE, and llvm::IRPosition::IRP_FUNCTION.

Referenced by llvm::AA::isAssumedReadNone(), and llvm::AA::isAssumedReadOnly().

isEqualOrWorse()

static bool isEqualOrWorse ( const Attribute &  New, const Attribute &  Old  )

static

Return true if New is equal or worse than Old.

Definition at line 893 of file Attributor.cpp.

References llvm::Attribute::getValueAsInt(), and llvm::Attribute::isIntAttribute().

Referenced by addIfNotExistent().

isPotentiallyReachable()

static bool isPotentiallyReachable ( Attributor &  A, const Instruction &  FromI, const Instruction *  ToI, const Function &  ToFn, const AbstractAttribute &  QueryingAA, const AA::InstExclusionSetTy *  ExclusionSet, std::function< bool(const Function &F)>  GoBackwardsCB  )

static

Definition at line 609 of file Attributor.cpp.

References A, llvm::dbgs(), DEBUG_WITH_TYPE, llvm::SmallVectorBase< Size_T >::empty(), llvm::BasicBlock::front(), llvm::IRPosition::function(), llvm::Function::getEntryBlock(), llvm::Instruction::getFunction(), llvm::Value::getName(), llvm::Instruction::getNextNonDebugInstruction(), llvm::Function::hasFnAttribute(), llvm::SmallPtrSetImpl< PtrType >::insert(), llvm::GlobalValue::isDeclaration(), LLVM_DEBUG, llvm::SmallVectorImpl< T >::pop_back_val(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), llvm::SmallPtrSetImplBase::size(), llvm::SmallVectorBase< Size_T >::size(), and VERBOSE_DEBUG_TYPE.

runAttributorOnFunctions()

static bool runAttributorOnFunctions ( InformationCache &  InfoCache, SetVector< Function * > &  Functions, AnalysisGetter &  AG, CallGraphUpdater &  CGUpdater, bool  DeleteFns, bool  IsModulePass  )

static

}

---

Pass (Manager) Boilerplate

Definition at line 3580 of file Attributor.cpp.

References A, llvm::all_of(), AllowDeepWrapper, AllowShallowWrappers, assert(), llvm::CHANGED, llvm::Attributor::createShallowWrapper(), llvm::dbgs(), llvm::SetVector< T, Vector, Set >::empty(), F, llvm::Value::getName(), llvm::SetVector< T, Vector, Set >::insert(), llvm::Attributor::internalizeFunction(), llvm::GlobalValue::isInterposableLinkage(), LLVM_DEBUG, llvm::CallGraphUpdater::reanalyzeFunction(), llvm::CallGraphUpdater::replaceFunctionWith(), llvm::SetVector< T, Vector, Set >::size(), and llvm::Value::uses().

Referenced by llvm::AttributorCGSCCPass::run(), and llvm::AttributorPass::run().

STATISTIC() [1/7]

STATISTIC	(	NumAttributesManifested	,
		"Number of abstract attributes manifested in IR"
	)

STATISTIC() [2/7]

STATISTIC	(	NumAttributesTimedOut	,
		"Number of abstract attributes timed out before fixpoint"
	)

STATISTIC() [3/7]

STATISTIC	(	NumAttributesValidFixpoint	,
		"Number of abstract attributes in a valid fixpoint state"
	)

STATISTIC() [4/7]

STATISTIC	(	NumFnDeleted	,
		"Number of function deleted"
	)

STATISTIC() [5/7]

STATISTIC	(	NumFnShallowWrappersCreated	,
		"Number of shallow wrappers created"
	)

STATISTIC() [6/7]

STATISTIC	(	NumFnWithExactDefinition	,
		"Number of functions with exact definitions"
	)

STATISTIC() [7/7]

STATISTIC	(	NumFnWithoutExactDefinition	,
		"Number of functions without exact definitions"
	)

Variable Documentation

AllowDeepWrapper

cl::opt< bool > AllowDeepWrapper("attributor-allow-deep-wrappers", cl::Hidden, cl::desc("Allow the Attributor to use IP information " "derived from non-exact functions via cloning"), cl::init(false)) ( "attributor-allow-deep-wrappers"  , cl::Hidden  , cl::desc("Allow the Attributor to use IP information " "derived from non-exact functions via cloning")  , cl::init(false)    )

static

Referenced by llvm::Attributor::internalizeFunction(), and runAttributorOnFunctions().

AllowShallowWrappers

cl::opt< bool > AllowShallowWrappers("attributor-allow-shallow-wrappers", cl::Hidden, cl::desc("Allow the Attributor to create shallow " "wrappers for non-exact definitions."), cl::init(false)) ( "attributor-allow-shallow-wrappers"  , cl::Hidden  , cl::desc("Allow the Attributor to create shallow " "wrappers for non-exact definitions.")  , cl::init(false)    )

static

Referenced by runAttributorOnFunctions().

AnnotateDeclarationCallSites

cl::opt< bool > AnnotateDeclarationCallSites("attributor-annotate-decl-cs", cl::Hidden, cl::desc("Annotate call sites of function declarations."), cl::init(false)) ( "attributor-annotate-decl-cs"  , cl::Hidden  , cl::desc("Annotate call sites of function declarations.")  , cl::init(false)    )

static

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

DepGraphDotFileNamePrefix

cl::opt< std::string > DepGraphDotFileNamePrefix("attributor-depgraph-dot-filename-prefix", cl::Hidden, cl::desc("The prefix used for the CallGraph dot file names.")) ( "attributor-depgraph-dot-filename-prefix"  , cl::Hidden  , cl::desc("The prefix used for the CallGraph dot file names.")    )

static

Referenced by llvm::AADepGraph::dumpGraph().

DumpDepGraph

cl::opt< bool > DumpDepGraph("attributor-dump-dep-graph", cl::Hidden, cl::desc("Dump the dependency graph to dot files."), cl::init(false)) ( "attributor-dump-dep-graph"  , cl::Hidden  , cl::desc("Dump the dependency graph to dot files.")  , cl::init(false)    )

static

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

EnableCallSiteSpecific

cl::opt< bool > EnableCallSiteSpecific("attributor-enable-call-site-specific-deduction", cl::Hidden, cl::desc("Allow the Attributor to do call site specific analysis"), cl::init(false)) ( "attributor-enable-call-site-specific-deduction"  , cl::Hidden  , cl::desc("Allow the Attributor to do call site specific analysis")  , cl::init(false)    )

static

EnableHeapToStack

cl::opt< bool > EnableHeapToStack("enable-heap-to-stack-conversion", cl::init(true), cl::Hidden) ( "enable-heap-to-stack-conversion"  , cl::init(true)  , cl::Hidden    )

static

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

FunctionSeedAllowList

cl::list< std::string > FunctionSeedAllowList("attributor-function-seed-allow-list", cl::Hidden, cl::desc("Comma seperated list of function names that are " "allowed to be seeded."), cl::CommaSeparated) ( "attributor-function-seed-allow-list"  , cl::Hidden  , cl::desc("Comma seperated list of function names that are " "allowed to be seeded.")  , cl::CommaSeparated    )

static

MaxInitializationChainLengthX

cl::opt< unsigned, true > MaxInitializationChainLengthX("attributor-max-initialization-chain-length", cl::Hidden, cl::desc( "Maximal number of chained initializations (to avoid stack overflows)"), cl::location(MaxInitializationChainLength), cl::init(1024)) ( "attributor-max-initialization-chain-length"  , cl::Hidden  , cl::desc( "Maximal number of chained initializations (to avoid stack overflows)")  , cl::location(MaxInitializationChainLength)  , cl::init(1024)    )

static

PrintCallGraph

cl::opt< bool > PrintCallGraph("attributor-print-call-graph", cl::Hidden, cl::desc("Print Attributor's internal call graph"), cl::init(false)) ( "attributor-print-call-graph"  , cl::Hidden  , cl::desc("Print Attributor's internal call graph")  , cl::init(false)    )

static

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

PrintDependencies

cl::opt< bool > PrintDependencies("attributor-print-dep", cl::Hidden, cl::desc("Print attribute dependencies"), cl::init(false)) ( "attributor-print-dep"  , cl::Hidden  , cl::desc("Print attribute dependencies")  , cl::init(false)    )

static

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

SeedAllowList

cl::list< std::string > SeedAllowList("attributor-seed-allow-list", cl::Hidden, cl::desc("Comma seperated list of attribute names that are " "allowed to be seeded."), cl::CommaSeparated) ( "attributor-seed-allow-list"  , cl::Hidden  , cl::desc("Comma seperated list of attribute names that are " "allowed to be seeded.")  , cl::CommaSeparated    )

static

SetFixpointIterations

cl::opt< unsigned > SetFixpointIterations("attributor-max-iterations", cl::Hidden, cl::desc("Maximal number of fixpoint iterations."), cl::init(32)) ( "attributor-max-iterations"  , cl::Hidden  , cl::desc("Maximal number of fixpoint iterations.")  , cl::init(32)    )

static

Referenced by llvm::OpenMPOptCGSCCPass::run(), and llvm::OpenMPOptPass::run().

SimplifyAllLoads

cl::opt< bool > SimplifyAllLoads("attributor-simplify-all-loads", cl::Hidden, cl::desc("Try to simplify all loads."), cl::init(true)) ( "attributor-simplify-all-loads"  , cl::Hidden  , cl::desc("Try to simplify all loads.")  , cl::init(true)    )

static

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

VerifyMaxFixpointIterations

cl::opt< bool > VerifyMaxFixpointIterations("attributor-max-iterations-verify", cl::Hidden, cl::desc("Verify that max-iterations is a tight bound for a fixpoint"), cl::init(false)) ( "attributor-max-iterations-verify"  , cl::Hidden  , cl::desc("Verify that max-iterations is a tight bound for a fixpoint")  , cl::init(false)    )

static

ViewDepGraph

cl::opt< bool > ViewDepGraph("attributor-view-dep-graph", cl::Hidden, cl::desc("View the dependency graph."), cl::init(false)) ( "attributor-view-dep-graph"  , cl::Hidden  , cl::desc("View the dependency graph.")  , cl::init(false)    )

static

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