#include <cstdint>
#include <deque>
#include <llvm/Config/llvm-config.h>
#include <memory>
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/ImmutableSet.h"
#include "llvm/ADT/SmallSet.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/IR/Constants.h"
#include "llvm/IR/Function.h"
#include "llvm/IR/InstrTypes.h"
#include "llvm/IR/Instructions.h"
#include "llvm/IR/IntrinsicInst.h"
#include "llvm/IR/Type.h"
#include "llvm/IR/Value.h"
#include "llvm/IR/InstIterator.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/ErrorOr.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/MemoryBuffer.h"
#include "llvm/Support/TimeProfiler.h"
#include "llvm/Support/raw_ostream.h"
#include "llvm/IR/InlineAsm.h"
#include "ActivityAnalysis.h"
#include "Utils.h"
#include "llvm/Demangle/Demangle.h"
#include "FunctionUtils.h"
#include "LibraryFuncs.h"
#include "TypeAnalysis/TBAA.h"
#include "llvm/Analysis/ValueTracking.h"
#include <map>
#include <set>
#include <unordered_map>
#include "ActivityAnalysis.h"
#include "Dialect/Dialect.h"
#include "Interfaces/GradientUtils.h"
#include "Interfaces/Utils.h"
#include "mlir/Dialect/Func/IR/FuncOps.h"
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
#include "mlir/Dialect/LLVMIR/LLVMTypes.h"
#include "mlir/Dialect/MemRef/IR/MemRef.h"
#include "mlir/IR/BuiltinAttributes.h"
#include "mlir/IR/Matchers.h"
#include "mlir/IR/Region.h"
#include "mlir/IR/RegionKindInterface.h"
#include "mlir/IR/SymbolTable.h"
#include "mlir/Interfaces/CallInterfaces.h"
#include "mlir/Interfaces/CastInterfaces.h"
#include "mlir/Interfaces/ControlFlowInterfaces.h"
#include "mlir/Interfaces/SideEffectInterfaces.h"
#include "mlir/Interfaces/ViewLikeInterface.h"
#include "llvm/IR/Intrinsics.h"
#include "llvm/Support/ModRef.h"
#include "Interfaces/AutoDiffOpInterface.h"

Macros
#define	addAttribute addAttributeAtIndex

#define	removeAttribute removeAttributeAtIndex

#define	getAttribute getAttributeAtIndex

#define	hasAttribute hasAttributeAtIndex

Functions
cl::opt< bool >	EnzymePrintActivity ("enzyme-print-activity", cl::init(false), cl::Hidden, cl::desc("Print activity analysis algorithm"))

cl::opt< bool >	EnzymeNonmarkedGlobalsInactive ("enzyme-globals-default-inactive", cl::init(false), cl::Hidden, cl::desc("Consider all nonmarked globals to be inactive"))

cl::opt< bool >	EnzymeEmptyFnInactive ("enzyme-emptyfn-inactive", cl::init(false), cl::Hidden, cl::desc("Empty functions are considered inactive"))

cl::opt< bool >	EnzymeGlobalActivity ("enzyme-global-activity", cl::init(false), cl::Hidden, cl::desc("Enable correct global activity analysis"))

cl::opt< bool >	EnzymeDisableActivityAnalysis ("enzyme-disable-activity-analysis", cl::init(false), cl::Hidden, cl::desc("Disable activity analysis"))

cl::opt< bool >	EnzymeEnableRecursiveHypotheses ("enzyme-enable-recursive-activity", cl::init(true), cl::Hidden, cl::desc("Enable re-evaluation of activity analysis from updated results"))

cl::list< std::string >	EnzymeLoadInactiveFiles ("enzyme-load-inactive-file", llvm::cl::ZeroOrMore, llvm::cl::Hidden, llvm::cl::desc("Load additional inactive functions from file"), llvm::cl::value_desc("File Name"))

bool	isInactiveCall (CallBase &CI)
	Return whether the call is always inactive by definition.

bool	isInactiveCallInst (CallBase &CB, llvm::TargetLibraryInfo &TLI)

static void	propagateArgumentInformation (TargetLibraryInfo &TLI, CallInst &CI, llvm::function_ref< bool(Value *)> propagateFromOperand)
	Call the function propagateFromOperand on all operands of CI that could impact the activity of the call instruction.

bool	isValuePotentiallyUsedAsPointer (llvm::Value *val)

std::optional< Value >	getStored (Operation *op)

static Operation *	getFunctionFromCall (CallOpInterface iface)

static bool	isReadOnly (Operation *op)

static bool	isFunctionReturn (Operation *op)

static bool	isValuePotentiallyUsedAsPointer (Value val)

static bool	mayAllocateMemory (Operation *op)

static bool	mayReadFromMemory (Operation *op)

static bool	mayWriteToMemory (Operation *op)

static FunctionOpInterface	getFunctionIfArgument (Value value)

static std::optional< SmallVector< Value > >	getPotentialTerminatorUsers (Operation *op, Value parent)

static SmallVector< Value >	getPotentialIncomingValues (OpResult res)

static SmallVector< Value >	getPotentialIncomingValues (BlockArgument arg)

static Operation *	getAncestorInRegion (Operation op, Region region)
	Return an ancestor of `op` that resides in the given region or nullptr if there is no such ancestor.

static void	allFollowersOf (Operation op, function_ref< WalkResult(Operation )> f)
	Call `f` on all operations that may be executed after op.

Variables
static const StringSet	InactiveGlobals

const llvm::StringMap< size_t >	MPIInactiveCommAllocators

struct {

bool cached = false

SmallVector< StringRef, 128 > functionNames

SmallVector< std::unique_ptr< MemoryBuffer >, 8 > contents

}	InactiveFileCache
	Cache if a file is loaded with inactive demangled function names.

static const char *	KnownInactiveFunctionsStartingWith []

static const char *	KnownInactiveFunctionsContains []

static const std::set< std::string >	InactiveGlobals

static const std::set< std::string >	KnownInactiveFunctionInsts

static const std::set< std::string >	KnownInactiveFunctions

static const char *	DemangledKnownInactiveFunctionsStartingWith []

static const unsigned	constantIntrinsics []

constexpr bool	EnzymePrintActivity = false

Macro Definition Documentation

◆ addAttribute

#define addAttribute addAttributeAtIndex

◆ getAttribute

#define getAttribute getAttributeAtIndex

◆ hasAttribute

#define hasAttribute hasAttributeAtIndex

◆ removeAttribute

#define removeAttribute removeAttributeAtIndex

Function Documentation

◆ allFollowersOf()

static void allFollowersOf	(	Operation *	op,
		function_ref< WalkResult(Operation *)>	f )

static

Call f on all operations that may be executed after op.

Definition at line 1403 of file ActivityAnalysis.cpp.

References getAncestorInRegion().

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ EnzymeDisableActivityAnalysis()

cl::opt< bool > EnzymeDisableActivityAnalysis	(	"enzyme-disable-activity-analysis"	,
		cl::init(false)	,
		cl::Hidden	,
		cl::desc("Disable activity analysis")	)

◆ EnzymeEmptyFnInactive()

cl::opt< bool > EnzymeEmptyFnInactive	(	"enzyme-emptyfn-inactive"	,
		cl::init(false)	,
		cl::Hidden	,
		cl::desc("Empty functions are considered inactive")	)

◆ EnzymeEnableRecursiveHypotheses()

cl::opt< bool > EnzymeEnableRecursiveHypotheses	(	"enzyme-enable-recursive-activity"	,
		cl::init(true)	,
		cl::Hidden	,
		cl::desc("Enable re-evaluation of activity analysis from updated results")	)

◆ EnzymeGlobalActivity()

cl::opt< bool > EnzymeGlobalActivity	(	"enzyme-global-activity"	,
		cl::init(false)	,
		cl::Hidden	,
		cl::desc("Enable correct global activity analysis")	)

◆ EnzymeLoadInactiveFiles()

cl::list< std::string > EnzymeLoadInactiveFiles	(	"enzyme-load-inactive-file"	,
		llvm::cl::ZeroOrMore	,
		llvm::cl::Hidden	,
		llvm::cl::desc("Load additional inactive functions from file")	,
		llvm::cl::value_desc("File Name")	)

◆ EnzymeNonmarkedGlobalsInactive()

cl::opt< bool > EnzymeNonmarkedGlobalsInactive	(	"enzyme-globals-default-inactive"	,
		cl::init(false)	,
		cl::Hidden	,
		cl::desc("Consider all nonmarked globals to be inactive")	)

◆ EnzymePrintActivity()

cl::opt< bool > EnzymePrintActivity	(	"enzyme-print-activity"	,
		cl::init(false)	,
		cl::Hidden	,
		cl::desc("Print activity analysis algorithm")	)

◆ getAncestorInRegion()

static Operation * getAncestorInRegion	(	Operation *	op,
		Region *	region )

static

Return an ancestor of op that resides in the given region or nullptr if there is no such ancestor.

Definition at line 1395 of file ActivityAnalysis.cpp.

Referenced by allFollowersOf().

◆ getFunctionFromCall()

static Operation * getFunctionFromCall ( CallOpInterface iface )

static

◆ getFunctionIfArgument()

static FunctionOpInterface getFunctionIfArgument ( Value value )

static

Definition at line 1132 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ getPotentialIncomingValues() [1/2]

static SmallVector< Value > getPotentialIncomingValues ( BlockArgument arg )

static

Definition at line 1279 of file ActivityAnalysis.cpp.

◆ getPotentialIncomingValues() [2/2]

static SmallVector< Value > getPotentialIncomingValues ( OpResult res )

static

Definition at line 1214 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ getPotentialTerminatorUsers()

static std::optional< SmallVector< Value > > getPotentialTerminatorUsers	(	Operation *	op,
		Value	parent )

static

Definition at line 1148 of file ActivityAnalysis.cpp.

References isFunctionReturn().

Referenced by mlir::enzyme::ActivityAnalyzer::isValueInactiveFromUsers().

◆ getStored()

std::optional< Value > getStored ( Operation * op )

Definition at line 204 of file DataFlowActivityAnalysis.cpp.

Referenced by mlir::enzyme::DataFlowActivityAnalyzer::isInactiveOperation(), mlir::enzyme::DenseActivityAnnotationAnalysis::visitOperation(), mlir::enzyme::DenseBackwardActivityAnalysis::visitOperation(), mlir::enzyme::DenseBackwardActivityAnnotationAnalysis::visitOperation(), mlir::enzyme::DenseForwardActivityAnalysis::visitOperation(), and mlir::enzyme::PointsToPointerAnalysis::visitOperation().

◆ isFunctionReturn()

static bool isFunctionReturn ( Operation * op )

static

Definition at line 1044 of file ActivityAnalysis.cpp.

References mlir::enzyme::isFunctionReturnLike().

Referenced by getPotentialTerminatorUsers(), mlir::enzyme::ActivityAnalyzer::isValueInactiveFromUsers(), and isValuePotentiallyUsedAsPointer().

◆ isInactiveCall()

bool isInactiveCall ( CallBase & CI )

Return whether the call is always inactive by definition.

Definition at line 227 of file ActivityAnalysis.cpp.

◆ isInactiveCallInst()

bool isInactiveCallInst	(	CallBase &	CB,
		llvm::TargetLibraryInfo &	TLI )

Definition at line 677 of file ActivityAnalysis.cpp.

◆ isReadOnly()

static bool isReadOnly ( Operation * op )

static

Definition at line 474 of file ActivityAnalysis.cpp.

References isReadOnly().

Referenced by DetectPointerArgOfFn(), fixSparse_inner(), fixSparseIndices(), isReadOnly(), mlir::enzyme::ActivityAnalyzer::isReadOnly(), mlir::enzyme::ActivityAnalyzer::isValueInactiveFromUsers(), and AdjointGenerator::recursivelyHandleSubfunction().

◆ isValuePotentiallyUsedAsPointer() [1/2]

bool isValuePotentiallyUsedAsPointer ( llvm::Value * val )

Definition at line 1276 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ isValuePotentiallyUsedAsPointer() [2/2]

static bool isValuePotentiallyUsedAsPointer ( Value val )

static

Definition at line 1050 of file ActivityAnalysis.cpp.

References EnzymePrintActivity, and isFunctionReturn().

◆ mayAllocateMemory()

static bool mayAllocateMemory ( Operation * op )

static

Definition at line 1114 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ mayReadFromMemory()

static bool mayReadFromMemory ( Operation * op )

static

Definition at line 1120 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ mayWriteToMemory()

static bool mayWriteToMemory ( Operation * op )

static

Definition at line 1126 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ propagateArgumentInformation()

static void propagateArgumentInformation	(	TargetLibraryInfo &	TLI,
		CallInst &	CI,
		llvm::function_ref< bool(Value *)>	propagateFromOperand )

inlinestatic

Call the function propagateFromOperand on all operands of CI that could impact the activity of the call instruction.

Only the first argument (magnitude) of copysign is active

Definition at line 832 of file ActivityAnalysis.cpp.

Variable Documentation

◆ cached

bool cached = false

Definition at line 179 of file ActivityAnalysis.cpp.

Referenced by AdjointGenerator::handleKnownCallDerivatives(), mlir::enzyme::DataFlowActivityAnalyzer::isInactiveOperation(), mlir::enzyme::DataFlowActivityAnalyzer::isInactiveValue(), and mlir::enzyme::LoopCheckpointing< FinalClass, OpName >::reverseBinomial().

◆ constantIntrinsics

const unsigned constantIntrinsics[]

static

Definition at line 216 of file ActivityAnalysis.cpp.

◆ contents

SmallVector<std::unique_ptr<MemoryBuffer>, 8> contents

Definition at line 182 of file ActivityAnalysis.cpp.

◆ DemangledKnownInactiveFunctionsStartingWith

const char* DemangledKnownInactiveFunctionsStartingWith[]

static

Definition at line 172 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ EnzymePrintActivity

bool EnzymePrintActivity = false

constexpr

Definition at line 472 of file ActivityAnalysis.cpp.

Referenced by PreProcessCache::CloneFunctionWithReturns(), mlir::enzyme::ActivityAnalyzer::isConstantOperation(), mlir::enzyme::ActivityAnalyzer::isConstantValue(), mlir::enzyme::ActivityAnalyzer::isValueActivelyStoredOrReturned(), mlir::enzyme::ActivityAnalyzer::isValueInactiveFromUsers(), and isValuePotentiallyUsedAsPointer().

◆ functionNames

SmallVector<StringRef, 128> functionNames

Definition at line 181 of file ActivityAnalysis.cpp.

◆ [struct]

struct { ... } InactiveFileCache

Cache if a file is loaded with inactive demangled function names.

◆ InactiveGlobals [1/2]

const StringSet InactiveGlobals

static

Definition at line 117 of file ActivityAnalysis.cpp.

◆ InactiveGlobals [2/2]

const std::set<std::string> InactiveGlobals

static

Initial value:

= {
    "ompi_request_null", "ompi_mpi_double", "ompi_mpi_comm_world", "stderr",
    "stdout", "stdin", "_ZSt3cin", "_ZSt4cout", "_ZSt5wcout", "_ZSt4cerr",
    "_ZTVNSt7__cxx1115basic_stringbufIcSt11char_traitsIcESaIcEEE",
    "_ZTVSt15basic_streambufIcSt11char_traitsIcEE",
    "_ZTVSt9basic_iosIcSt11char_traitsIcEE",
    
    "_ZTVNSt7__cxx1119basic_istringstreamIcSt11char_traitsIcESaIcEEE",
    "_ZTTNSt7__cxx1119basic_istringstreamIcSt11char_traitsIcESaIcEEE",
    
    "_ZTVNSt7__cxx1119basic_ostringstreamIcSt11char_traitsIcESaIcEEE",
    "_ZTTNSt7__cxx1119basic_ostringstreamIcSt11char_traitsIcESaIcEEE",
    
    "_ZTVNSt7__cxx1118basic_stringstreamIcSt11char_traitsIcESaIcEEE",
    "_ZTTNSt7__cxx1118basic_stringstreamIcSt11char_traitsIcESaIcEEE",
    
    "_ZTTSt14basic_ifstreamIcSt11char_traitsIcEE",
    
    "_ZTTSt14basic_ofstreamIcSt11char_traitsIcEE",
    
    "_ZTVN10__cxxabiv120__si_class_type_infoE",
    "_ZTVN10__cxxabiv117__class_type_infoE",
    "_ZTVN10__cxxabiv121__vmi_class_type_infoE"}

Definition at line 39 of file ActivityAnalysis.cpp.

◆ KnownInactiveFunctionInsts

const std::set<std::string> KnownInactiveFunctionInsts

static

Initial value:

= {
    "__dynamic_cast",
    "_ZSt18_Rb_tree_decrementPKSt18_Rb_tree_node_base",
    "_ZSt18_Rb_tree_incrementPKSt18_Rb_tree_node_base",
    "_ZSt18_Rb_tree_decrementPSt18_Rb_tree_node_base",
    "_ZSt18_Rb_tree_incrementPSt18_Rb_tree_node_base",
    "jl_ptr_to_array",
    "jl_ptr_to_array_1d"}

Definition at line 81 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantOperation(), and mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ KnownInactiveFunctions

const std::set<std::string> KnownInactiveFunctions

static

Definition at line 90 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ KnownInactiveFunctionsContains

const char* KnownInactiveFunctionsContains[]

static

Initial value:

= {
    "__enzyme_float", "__enzyme_double", "__enzyme_integer",
    "__enzyme_pointer"}

Definition at line 35 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ KnownInactiveFunctionsStartingWith

const char* KnownInactiveFunctionsStartingWith[]

static

Initial value:

= {
    "f90io",
    "$ss5print",
    "_ZTv0_n24_NSoD", 
    "_ZNSt16allocator_traitsISaIdEE10deallocate",
    "_ZNSaIcED1Ev",
    "_ZNSaIcEC1Ev",
}

Definition at line 26 of file ActivityAnalysis.cpp.

Referenced by mlir::enzyme::ActivityAnalyzer::isConstantValue().

◆ MPIInactiveCommAllocators

static const std::map< std::string, size_t > MPIInactiveCommAllocators

Initial value:

= {
    {"MPI_Graph_create", 5},
    {"MPI_Comm_split", 2},
    {"MPI_Intercomm_create", 6},
    {"MPI_Comm_spawn", 6},
    {"MPI_Comm_spawn_multiple", 7},
    {"MPI_Comm_accept", 4},
    {"MPI_Comm_connect", 4},
    {"MPI_Comm_create", 2},
    {"MPI_Comm_create_group", 3},
    {"MPI_Comm_dup", 1},
    {"MPI_Comm_dup", 2},
    {"MPI_Comm_idup", 1},
    {"MPI_Comm_join", 1},
}

Definition at line 160 of file ActivityAnalysis.cpp.

Referenced by AdjointGenerator::handleKnownCallDerivatives(), AdjointGenerator::handleMPI(), and mlir::enzyme::ActivityAnalyzer::isConstantValue().

Macros

Functions

Variables

Macro Definition Documentation

◆ addAttribute

◆ getAttribute

◆ hasAttribute

◆ removeAttribute

Function Documentation

◆ allFollowersOf()

◆ EnzymeDisableActivityAnalysis()

◆ EnzymeEmptyFnInactive()

◆ EnzymeEnableRecursiveHypotheses()

◆ EnzymeGlobalActivity()

◆ EnzymeLoadInactiveFiles()

◆ EnzymeNonmarkedGlobalsInactive()

◆ EnzymePrintActivity()

◆ getAncestorInRegion()

◆ getFunctionFromCall()

◆ getFunctionIfArgument()

◆ getPotentialIncomingValues() [1/2]

◆ getPotentialIncomingValues() [2/2]

◆ getPotentialTerminatorUsers()

◆ getStored()

◆ isFunctionReturn()

◆ isInactiveCall()

◆ isInactiveCallInst()

◆ isReadOnly()

◆ isValuePotentiallyUsedAsPointer() [1/2]

◆ isValuePotentiallyUsedAsPointer() [2/2]

◆ mayAllocateMemory()

◆ mayReadFromMemory()

◆ mayWriteToMemory()

◆ propagateArgumentInformation()

Variable Documentation

◆ cached

◆ constantIntrinsics

◆ contents

◆ DemangledKnownInactiveFunctionsStartingWith

◆ EnzymePrintActivity

◆ functionNames

◆ [struct]

◆ InactiveGlobals [1/2]

◆ InactiveGlobals [2/2]

◆ KnownInactiveFunctionInsts

◆ KnownInactiveFunctions

◆ KnownInactiveFunctionsContains

◆ KnownInactiveFunctionsStartingWith

◆ MPIInactiveCommAllocators