#include "mlir/Dialect/Affine/IR/AffineOps.h"
#include "mlir/Dialect/Affine/IR/AffineValueMap.h"
#include "mlir/Dialect/MemRef/IR/MemRef.h"
#include "mlir/IR/AffineExprVisitor.h"
#include "mlir/IR/IRMapping.h"
#include "mlir/IR/IntegerSet.h"
#include "mlir/IR/Matchers.h"
#include "mlir/IR/OpDefinition.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/Interfaces/ShapedOpInterfaces.h"
#include "mlir/Support/MathExtras.h"
#include "mlir/Transforms/InliningUtils.h"
#include "llvm/ADT/ScopeExit.h"
#include "llvm/ADT/SmallBitVector.h"
#include "llvm/ADT/SmallVectorExtras.h"
#include "llvm/ADT/TypeSwitch.h"
#include "llvm/Support/Debug.h"
#include <numeric>
#include <optional>
#include "mlir/Dialect/Affine/IR/AffineOpsDialect.cpp.inc"
#include "mlir/Dialect/Affine/IR/AffineOps.cpp.inc"

Classes
struct	DeduplicateAffineMinMaxExpressions< T >
	Remove duplicated expressions in affine min/max ops. More...

struct	MergeAffineMinMaxOp< T >
	Merge an affine min/max op to its consumers if its consumer is also an affine min/max op. More...

struct	CanonicalizeAffineMinMaxOpExprAndTermOrder< T >
	Canonicalize the affine map result expression order of an affine min/max operation. More...

struct	CanonicalizeSingleResultAffineMinMaxOp< T >

Macros
#define	DEBUG_TYPE "affine-ops"

#define	GET_OP_LIST

#define	GET_OP_CLASSES

Functions
static bool	remainsLegalAfterInline (Value value, Region src, Region dest, const IRMapping &mapping, function_ref< bool(Value, Region *)> legalityCheck)
	Checks if `value` known to be a legal affine dimension or symbol in `src` region remains legal if the operation that uses it is inlined into `dest` with the given value mapping. More...

static bool	remainsLegalAfterInline (ValueRange values, Region src, Region dest, const IRMapping &mapping, function_ref< bool(Value, Region *)> legalityCheck)
	Checks if all values known to be legal affine dimensions or symbols in `src` remain so if their respective users are inlined into `dest`. More...

template<typename OpTy >
static bool	remainsLegalAfterInline (OpTy op, Region src, Region dest, const IRMapping &mapping)
	Checks if an affine read or write operation remains legal after inlining from `src` to `dest`. More...

template<>
bool LLVM_ATTRIBUTE_UNUSED	remainsLegalAfterInline (AffineApplyOp op, Region src, Region dest, const IRMapping &mapping)
	Checks if an affine apply operation remains legal after inlining from `src` to `dest`. More...

template<typename AnyMemRefDefOp >
static bool	isMemRefSizeValidSymbol (AnyMemRefDefOp memrefDefOp, unsigned index, Region *region)
	Returns true if the 'index' dimension of the `memref` defined by `memrefDefOp` is a statically shaped one or defined using a valid symbol for `region`. More...

static bool	isDimOpValidSymbol (ShapedDimOpInterface dimOp, Region *region)
	Returns true if the result of the dim op is a valid symbol for `region`. More...

static bool	isValidAffineIndexOperand (Value value, Region *region)

static void	printDimAndSymbolList (Operation::operand_iterator begin, Operation::operand_iterator end, unsigned numDims, OpAsmPrinter &printer)
	Prints dimension and symbol list. More...

template<typename OpTy >
static LogicalResult	verifyDimAndSymbolIdentifiers (OpTy &op, Operation::operand_range operands, unsigned numDims)
	Utility function to verify that a set of operands are valid dimension and symbol identifiers. More...

static int64_t	getLargestKnownDivisor (AffineExpr e, ArrayRef< Value > operands)
	Returns the largest known divisor of `e`. More...

static bool	isNonNegativeBoundedBy (AffineExpr e, ArrayRef< Value > operands, int64_t k)
	Check if `e` is known to be: 0 <= `e` < `k`. More...

static bool	isQTimesDPlusR (AffineExpr e, ArrayRef< Value > operands, int64_t &div, AffineExpr &quotientTimesDiv, AffineExpr &rem)
	Check if expression `e` is of the form d*e_1 + e_2 where 0 <= e_2 < d. More...

static std::optional< int64_t >	getLowerBound (Value iv)
	Gets the constant lower bound on an `iv`. More...

static std::optional< int64_t >	getUpperBound (Value iv)
	Gets the constant upper bound on an affine.for `iv`. More...

static std::optional< int64_t >	getBoundForExpr (AffineExpr expr, unsigned numDims, unsigned numSymbols, ArrayRef< std::optional< int64_t >> constLowerBounds, ArrayRef< std::optional< int64_t >> constUpperBounds, bool isUpper)
	Get a lower or upper (depending on `isUpper`) bound for `expr` while using the constant lower and upper bounds for its inputs provided in `constLowerBounds` and `constUpperBounds`. More...

static std::optional< int64_t >	getUpperBound (AffineExpr expr, unsigned numDims, unsigned numSymbols, ArrayRef< Value > operands)
	Determine a constant upper bound for `expr` if one exists while exploiting values in `operands`. More...

static std::optional< int64_t >	getLowerBound (AffineExpr expr, unsigned numDims, unsigned numSymbols, ArrayRef< Value > operands)
	Determine a constant lower bound for `expr` if one exists while exploiting values in `operands`. More...

static void	simplifyExprAndOperands (AffineExpr &expr, unsigned numDims, unsigned numSymbols, ArrayRef< Value > operands)
	Simplify `expr` while exploiting information from the values in `operands`. More...

static void	simplifyMinOrMaxExprWithOperands (AffineMap &map, ArrayRef< Value > operands, bool isMax)
	Simplify the expressions in `map` while making use of lower or upper bounds of its operands. More...

static void LLVM_ATTRIBUTE_UNUSED	simplifyMapWithOperands (AffineMap &map, ArrayRef< Value > operands)
	Simplify the map while exploiting information on the values in `operands`. More...

static LogicalResult	replaceDimOrSym (AffineMap *map, unsigned dimOrSymbolPosition, SmallVectorImpl< Value > &dims, SmallVectorImpl< Value > &syms)
	Replace all occurrences of AffineExpr at position `pos` in `map` by the defining AffineApplyOp expression and operands. More...

static void	composeAffineMapAndOperands (AffineMap map, SmallVectorImpl< Value > operands)
	Iterate over `operands` and fold away all those produced by an AffineApplyOp iteratively. More...

static void	materializeConstants (OpBuilder &b, Location loc, ArrayRef< OpFoldResult > values, SmallVectorImpl< Operation * > &constants, SmallVectorImpl< Value > &actualValues)
	Given a list of `OpFoldResult`, build the necessary operations to populate `actualValues` with values produced by operations. More...

template<typename OpTy , typename... Args>
static std::enable_if_t< OpTy::template hasTrait< OpTrait::OneResult >), OpFoldResult >	createOrFold (OpBuilder &b, Location loc, ValueRange operands, Args &&...leadingArguments)
	Create an operation of the type provided as template argument and attempt to fold it immediately. More...

static void	composeMultiResultAffineMap (AffineMap &map, SmallVectorImpl< Value > &operands)
	Composes the given affine map with the given list of operands, pulling in the maps from any affine.apply operations that supply the operands. More...

template<typename OpTy >
static OpFoldResult	makeComposedFoldedMinMax (OpBuilder &b, Location loc, AffineMap map, ArrayRef< OpFoldResult > operands)

static Value	createFoldedComposedAffineApply (OpBuilder &b, Location loc, AffineMap map, ValueRange operandsRef)
	Fully compose map with operands and canonicalize the result. More...

template<class MapOrSet >
static void	canonicalizePromotedSymbols (MapOrSet mapOrSet, SmallVectorImpl< Value > operands)

template<class MapOrSet >
static void	canonicalizeMapOrSetAndOperands (MapOrSet mapOrSet, SmallVectorImpl< Value > operands)

static ParseResult	parseBound (bool isLower, OperationState &result, OpAsmParser &p)
	Parse a for operation loop bounds. More...

static void	printBound (AffineMapAttr boundMap, Operation::operand_range boundOperands, const char *prefix, OpAsmPrinter &p)

static LogicalResult	foldLoopBounds (AffineForOp forOp)
	Fold the constant bounds of a loop. More...

static LogicalResult	canonicalizeLoopBounds (AffineForOp forOp)
	Canonicalize the bounds of the given loop. More...

static bool	hasTrivialZeroTripCount (AffineForOp op)
	Returns true if the affine.for has zero iterations in trivial cases. More...

template<typename BoundListTy , typename LoopCreatorTy >
static void	buildAffineLoopNestImpl (OpBuilder &builder, Location loc, BoundListTy lbs, BoundListTy ubs, ArrayRef< int64_t > steps, function_ref< void(OpBuilder &, Location, ValueRange)> bodyBuilderFn, LoopCreatorTy &&loopCreatorFn)
	Builds an affine loop nest, using "loopCreatorFn" to create individual loop operations. More...

static AffineForOp	buildAffineLoopFromConstants (OpBuilder &builder, Location loc, int64_t lb, int64_t ub, int64_t step, AffineForOp::BodyBuilderFn bodyBuilderFn)
	Creates an affine loop from the bounds known to be constants. More...

static AffineForOp	buildAffineLoopFromValues (OpBuilder &builder, Location loc, Value lb, Value ub, int64_t step, AffineForOp::BodyBuilderFn bodyBuilderFn)
	Creates an affine loop from the bounds that may or may not be constants. More...

static void	composeSetAndOperands (IntegerSet &set, SmallVectorImpl< Value > &operands)
	Compose any affine.apply ops feeding into `operands` of the integer set `set` by composing the maps of such affine.apply ops with the integer set constraints. More...

static LogicalResult	verifyMemoryOpIndexing (Operation *op, AffineMapAttr mapAttr, Operation::operand_range mapOperands, MemRefType memrefType, unsigned numIndexOperands)
	Verify common indexing invariants of affine.load, affine.store, affine.vector_load and affine.vector_store. More...

template<typename T >
static LogicalResult	verifyAffineMinMaxOp (T op)

template<typename T >
static void	printAffineMinMaxOp (OpAsmPrinter &p, T op)

template<typename T >
static ParseResult	parseAffineMinMaxOp (OpAsmParser &parser, OperationState &result)

template<typename T >
static OpFoldResult	foldMinMaxOp (T op, ArrayRef< Attribute > operands)
	Fold an affine min or max operation with the given operands. More...

static LogicalResult	canonicalizeMapExprAndTermOrder (AffineMap &map)
	Canonicalize the result expression order of an affine map and return success if the order changed. More...

static LogicalResult	canonicalizeLoopBounds (AffineParallelOp op)
	Canonicalize the bounds of the given loop. More...

static void	printMinMaxBound (OpAsmPrinter &p, AffineMapAttr mapAttr, DenseIntElementsAttr group, ValueRange operands, StringRef keyword)
	Prints a lower(upper) bound of an affine parallel loop with max(min) conditions in it. More...

static ParseResult	deduplicateAndResolveOperands (OpAsmParser &parser, ArrayRef< SmallVector< OpAsmParser::UnresolvedOperand >> operands, SmallVectorImpl< Value > &uniqueOperands, SmallVectorImpl< AffineExpr > &replacements, AffineExprKind kind)
	Given a list of lists of parsed operands, populates `uniqueOperands` with unique operands. More...

static ParseResult	parseAffineMapWithMinMax (OpAsmParser &parser, OperationState &result, MinMaxKind kind)
	Parses an affine map that can contain a min/max for groups of its results, e.g., max(expr-1, expr-2), expr-3, max(expr-4, expr-5, expr-6). More...

static LogicalResult	verifyVectorMemoryOp (Operation *op, MemRefType memrefType, VectorType vectorType)
	Verify common invariants of affine.vector_load and affine.vector_store. More...

Macro Definition Documentation

◆ DEBUG_TYPE

#define DEBUG_TYPE "affine-ops"

Definition at line 32 of file AffineOps.cpp.

◆ GET_OP_CLASSES

#define GET_OP_CLASSES

Definition at line 4622 of file AffineOps.cpp.

◆ GET_OP_LIST

#define GET_OP_LIST

Function Documentation

◆ buildAffineLoopFromConstants()

static AffineForOp buildAffineLoopFromConstants	(	OpBuilder &	builder,
		Location	loc,
		int64_t	lb,
		int64_t	ub,
		int64_t	step,
		AffineForOp::BodyBuilderFn	bodyBuilderFn
	)

static

Creates an affine loop from the bounds known to be constants.

Definition at line 2747 of file AffineOps.cpp.

References mlir::OpBuilder::create().

Referenced by buildAffineLoopFromValues(), and mlir::affine::buildAffineLoopNest().

◆ buildAffineLoopFromValues()

static AffineForOp buildAffineLoopFromValues	(	OpBuilder &	builder,
		Location	loc,
		Value	lb,
		Value	ub,
		int64_t	step,
		AffineForOp::BodyBuilderFn	bodyBuilderFn
	)

static

Creates an affine loop from the bounds that may or may not be constants.

Definition at line 2756 of file AffineOps.cpp.

References buildAffineLoopFromConstants(), mlir::OpBuilder::create(), mlir::Value::getDefiningOp(), and mlir::Builder::getDimIdentityMap().

Referenced by mlir::affine::buildAffineLoopNest().

◆ buildAffineLoopNestImpl()

template<typename BoundListTy , typename LoopCreatorTy >

static void buildAffineLoopNestImpl	(	OpBuilder &	builder,
		Location	loc,
		BoundListTy	lbs,
		BoundListTy	ubs,
		ArrayRef< int64_t >	steps,
		function_ref< void(OpBuilder &, Location, ValueRange)>	bodyBuilderFn,
		LoopCreatorTy &&	loopCreatorFn
	)

static

Builds an affine loop nest, using "loopCreatorFn" to create individual loop operations.

Definition at line 2706 of file AffineOps.cpp.

References mlir::OpBuilder::create(), and mlir::OpBuilder::setInsertionPointToStart().

Referenced by mlir::affine::buildAffineLoopNest().

◆ canonicalizeLoopBounds() [1/2]

static LogicalResult canonicalizeLoopBounds ( AffineForOp forOp )

static

Canonicalize the bounds of the given loop.

Definition at line 2323 of file AffineOps.cpp.

References mlir::affine::canonicalizeMapAndOperands(), composeAffineMapAndOperands(), mlir::failure(), mlir::removeDuplicateExprs(), simplifyMinOrMaxExprWithOperands(), and mlir::success().

◆ canonicalizeLoopBounds() [2/2]

static LogicalResult canonicalizeLoopBounds ( AffineParallelOp op )

static

Canonicalize the bounds of the given loop.

Definition at line 4052 of file AffineOps.cpp.

◆ canonicalizeMapExprAndTermOrder()

static LogicalResult canonicalizeMapExprAndTermOrder ( AffineMap & map )

static

Canonicalize the result expression order of an affine map and return success if the order changed.

The function flattens the map's affine expressions to coefficient arrays and sorts them in lexicographic order. A coefficient array contains a multiplier for every dimension/symbol and a constant term. The canonicalization fails if a result expression is not pure or if the flattening requires local variables that, unlike dimensions and symbols, have no global order.

Definition at line 3562 of file AffineOps.cpp.

References mlir::failure(), mlir::AffineMap::get(), mlir::AffineMap::getContext(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumResults(), mlir::AffineMap::getNumSymbols(), mlir::AffineMap::getResult(), mlir::AffineMap::getResults(), mlir::SimpleAffineExprFlattener::operandExprStack, mlir::success(), and mlir::AffineExprVisitor< SubClass, RetTy >::walkPostOrder().

Referenced by CanonicalizeAffineMinMaxOpExprAndTermOrder< T >::matchAndRewrite().

◆ canonicalizeMapOrSetAndOperands()

template<class MapOrSet >

static void canonicalizeMapOrSetAndOperands	(	MapOrSet *	mapOrSet,
		SmallVectorImpl< Value > *	operands
	)

static

Definition at line 1484 of file AffineOps.cpp.

References mlir::AffineExpr::dyn_cast(), mlir::getAffineConstantExpr(), mlir::getAffineDimExpr(), mlir::getAffineSymbolExpr(), mlir::m_Constant(), and mlir::matchPattern().

◆ canonicalizePromotedSymbols()

template<class MapOrSet >

static void canonicalizePromotedSymbols	(	MapOrSet *	mapOrSet,
		SmallVectorImpl< Value > *	operands
	)

static

Definition at line 1441 of file AffineOps.cpp.

References mlir::getAffineDimExpr(), mlir::getAffineSymbolExpr(), and mlir::affine::isValidSymbol().

◆ composeAffineMapAndOperands()

static void composeAffineMapAndOperands	(	AffineMap *	map,
		SmallVectorImpl< Value > *	operands
	)

static

Iterate over operands and fold away all those produced by an AffineApplyOp iteratively.

Perform canonicalization of map and operands as well as AffineMap simplification. map and operands are mutated in place.

Definition at line 1125 of file AffineOps.cpp.

References mlir::affine::canonicalizeMapAndOperands(), mlir::detail::enumerate(), mlir::getAffineConstantExpr(), mlir::getAffineDimExpr(), mlir::getAffineSymbolExpr(), mlir::AffineMap::getContext(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumResults(), mlir::AffineMap::isFunctionOfDim(), mlir::AffineMap::isFunctionOfSymbol(), replaceDimOrSym(), mlir::AffineMap::replaceDimsAndSymbols(), mlir::simplifyAffineMap(), and mlir::succeeded().

Referenced by mlir::affine::AffineValueMap::canonicalize(), canonicalizeLoopBounds(), composeSetAndOperands(), mlir::affine::fullyComposeAffineMapAndOperands(), mlir::affine::makeComposedAffineApply(), and mlir::affine::makeComposedFoldedAffineApply().

◆ composeMultiResultAffineMap()

static void composeMultiResultAffineMap	(	AffineMap &	map,
		SmallVectorImpl< Value > &	operands
	)

static

Composes the given affine map with the given list of operands, pulling in the maps from any affine.apply operations that supply the operands.

Definition at line 1305 of file AffineOps.cpp.

References mlir::affine::canonicalizeMapAndOperands(), mlir::affine::fullyComposeAffineMapAndOperands(), mlir::AffineMap::get(), mlir::AffineMap::getContext(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumResults(), mlir::AffineMap::getResult(), mlir::AffineMap::getSubMap(), mlir::AffineMap::shiftDims(), and mlir::AffineMap::shiftSymbols().

Referenced by mlir::affine::makeComposedAffineMin(), and makeComposedFoldedMinMax().

◆ composeSetAndOperands()

static void composeSetAndOperands	(	IntegerSet &	set,
		SmallVectorImpl< Value > &	operands
	)

static

Compose any affine.apply ops feeding into operands of the integer set set by composing the maps of such affine.apply ops with the integer set constraints.

Definition at line 3072 of file AffineOps.cpp.

References composeAffineMapAndOperands(), mlir::AffineMap::get(), mlir::IntegerSet::get(), mlir::IntegerSet::getConstraints(), mlir::IntegerSet::getContext(), mlir::Value::getDefiningOp(), mlir::IntegerSet::getEqFlags(), mlir::AffineMap::getNumDims(), mlir::IntegerSet::getNumDims(), mlir::AffineMap::getNumSymbols(), mlir::IntegerSet::getNumSymbols(), and mlir::AffineMap::getResults().

◆ createFoldedComposedAffineApply()

static Value createFoldedComposedAffineApply	(	OpBuilder &	b,
		Location	loc,
		AffineMap	map,
		ValueRange	operandsRef
	)

static

Fully compose map with operands and canonicalize the result.

Return the createOrFold'ed AffineApply op.

Definition at line 1413 of file AffineOps.cpp.

References mlir::affine::canonicalizeMapAndOperands(), mlir::OpBuilder::createOrFold(), and mlir::affine::fullyComposeAffineMapAndOperands().

Referenced by mlir::affine::applyMapToValues().

◆ createOrFold()

template<typename OpTy , typename... Args>

static std::enable_if_t<OpTy::template hasTrait<OpTrait::OneResult>), OpFoldResult> createOrFold	(	OpBuilder &	b,
		Location	loc,
		ValueRange	operands,
		Args &&...	leadingArguments
	)

static

Create an operation of the type provided as template argument and attempt to fold it immediately.

The operation is expected to have a builder taking arbitrary leadingArguments, followed by a list of Value-typed operands. The operation is also expected to always produce a single result. Return an OpFoldResult containing the Attribute representing the folded constant if complete folding was possible and a Value produced by the created operation otherwise.

Definition at line 1241 of file AffineOps.cpp.

References mlir::OpBuilder::getListener(), mlir::m_Constant(), mlir::matchPattern(), and mlir::OpBuilder::setListener().

◆ deduplicateAndResolveOperands()

static ParseResult deduplicateAndResolveOperands	(	OpAsmParser &	parser,
		ArrayRef< SmallVector< OpAsmParser::UnresolvedOperand >>	operands,
		SmallVectorImpl< Value > &	uniqueOperands,
		SmallVectorImpl< AffineExpr > &	replacements,
		AffineExprKind	kind
	)

static

Given a list of lists of parsed operands, populates uniqueOperands with unique operands.

Also populates replacements with affine expressions of kindthat can be used to update affine maps previously accepting a operandsto acceptuniqueOperands` instead.

Definition at line 4149 of file AffineOps.cpp.

◆ foldLoopBounds()

static LogicalResult foldLoopBounds ( AffineForOp forOp )

static

Fold the constant bounds of a loop.

Definition at line 2277 of file AffineOps.cpp.

References mlir::AffineMap::constantFold(), mlir::failed(), mlir::failure(), mlir::AffineMap::getNumResults(), mlir::m_Constant(), mlir::matchPattern(), mlir::succeeded(), and mlir::success().

◆ foldMinMaxOp()

template<typename T >

static OpFoldResult foldMinMaxOp	(	T	op,
		ArrayRef< Attribute >	operands
	)

static

Fold an affine min or max operation with the given operands.

The operand list may contain nulls, which are interpreted as the operand not being a constant.

Definition at line 3399 of file AffineOps.cpp.

◆ getBoundForExpr()

static std::optional<int64_t> getBoundForExpr	(	AffineExpr	expr,
		unsigned	numDims,
		unsigned	numSymbols,
		ArrayRef< std::optional< int64_t >>	constLowerBounds,
		ArrayRef< std::optional< int64_t >>	constUpperBounds,
		bool	isUpper
	)

static

Get a lower or upper (depending on isUpper) bound for expr while using the constant lower and upper bounds for its inputs provided in constLowerBounds and constUpperBounds.

Return std::nullopt if such a bound can't be computed. This method only handles simple sum of product expressions (w.r.t constant coefficients) so as to not depend on anything heavyweight in Analysis. Expressions of the form: c0*d0 + c1*d1 + c2*s0 + ... + c_n are handled. Expressions involving floordiv, ceildiv, mod or semi-affine ones will lead std::nullopt being returned.

Definition at line 712 of file AffineOps.cpp.

References mlir::CeilDiv, mlir::ceilDiv(), mlir::AffineExpr::dyn_cast(), mlir::FloorDiv, mlir::floorDiv(), mlir::AffineConstantExpr::getValue(), mlir::Mod, mlir::mod(), mlir::SimpleAffineExprFlattener::numLocals, mlir::SimpleAffineExprFlattener::operandExprStack, and mlir::AffineExprVisitor< SubClass, RetTy >::walkPostOrder().

Referenced by getLowerBound(), getUpperBound(), and simplifyMinOrMaxExprWithOperands().

◆ getLargestKnownDivisor()

static int64_t getLargestKnownDivisor	(	AffineExpr	e,
		ArrayRef< Value >	operands
	)

static

Returns the largest known divisor of e.

Exploits information from the values in operands.

Definition at line 590 of file AffineOps.cpp.

References mlir::AffineExpr::dyn_cast(), mlir::presburger::gcd(), mlir::affine::getForInductionVarOwner(), and mlir::AffineExpr::getLargestKnownDivisor().

Referenced by isQTimesDPlusR(), and simplifyExprAndOperands().

◆ getLowerBound() [1/2]

static std::optional<int64_t> getLowerBound	(	AffineExpr	expr,
		unsigned	numDims,
		unsigned	numSymbols,
		ArrayRef< Value >	operands
	)

static

Determine a constant lower bound for expr if one exists while exploiting values in operands.

Note that the upper bound is an inclusive one. expr is guaranteed to be less than or equal to it.

Definition at line 816 of file AffineOps.cpp.

References mlir::AffineExpr::dyn_cast(), getBoundForExpr(), getLowerBound(), and getUpperBound().

◆ getLowerBound() [2/2]

static std::optional<int64_t> getLowerBound ( Value iv )

static

Gets the constant lower bound on an iv.

Definition at line 680 of file AffineOps.cpp.

References mlir::affine::getForInductionVarOwner().

Referenced by getLowerBound(), getUpperBound(), simplifyExprAndOperands(), and simplifyMinOrMaxExprWithOperands().

◆ getUpperBound() [1/2]

static std::optional<int64_t> getUpperBound	(	AffineExpr	expr,
		unsigned	numDims,
		unsigned	numSymbols,
		ArrayRef< Value >	operands
	)

static

Determine a constant upper bound for expr if one exists while exploiting values in operands.

Note that the upper bound is an inclusive one. expr is guaranteed to be less than or equal to it.

Definition at line 793 of file AffineOps.cpp.

References mlir::AffineExpr::dyn_cast(), getBoundForExpr(), getLowerBound(), and getUpperBound().

◆ getUpperBound() [2/2]

static std::optional<int64_t> getUpperBound ( Value iv )

static

Gets the constant upper bound on an affine.for iv.

Definition at line 688 of file AffineOps.cpp.

References mlir::affine::getForInductionVarOwner().

Referenced by getLowerBound(), getUpperBound(), simplifyExprAndOperands(), and simplifyMinOrMaxExprWithOperands().

◆ hasTrivialZeroTripCount()

static bool hasTrivialZeroTripCount ( AffineForOp op )

static

Returns true if the affine.for has zero iterations in trivial cases.

Definition at line 2476 of file AffineOps.cpp.

◆ isDimOpValidSymbol()

static bool isDimOpValidSymbol	(	ShapedDimOpInterface	dimOp,
		Region *	region
	)

static

Returns true if the result of the dim op is a valid symbol for region.

Definition at line 330 of file AffineOps.cpp.

References mlir::getConstantIntValue(), and mlir::affine::isTopLevelValue().

Referenced by mlir::affine::isValidSymbol().

◆ isMemRefSizeValidSymbol()

template<typename AnyMemRefDefOp >

static bool isMemRefSizeValidSymbol	(	AnyMemRefDefOp	memrefDefOp,
		unsigned	index,
		Region *	region
	)

static

Returns true if the 'index' dimension of the memref defined by memrefDefOp is a statically shaped one or defined using a valid symbol for region.

Definition at line 317 of file AffineOps.cpp.

References mlir::affine::isValidSymbol().

◆ isNonNegativeBoundedBy()

static bool isNonNegativeBoundedBy	(	AffineExpr	e,
		ArrayRef< Value >	operands,
		int64_t	k
	)

static

Check if e is known to be: 0 <= e < k.

Handles the simple cases of e being an affine dim expression or a constant.

Definition at line 628 of file AffineOps.cpp.

References mlir::AffineExpr::dyn_cast(), and mlir::affine::getForInductionVarOwner().

Referenced by isQTimesDPlusR(), and simplifyExprAndOperands().

◆ isQTimesDPlusR()

static bool isQTimesDPlusR	(	AffineExpr	e,
		ArrayRef< Value >	operands,
		int64_t &	div,
		AffineExpr &	quotientTimesDiv,
		AffineExpr &	rem
	)

static

Check if expression e is of the form d*e_1 + e_2 where 0 <= e_2 < d.

Set div to d, quotientTimesDiv to e_1 and rem to e_2 if the expression is in that form.

Definition at line 656 of file AffineOps.cpp.

References mlir::Add, mlir::AffineExpr::dyn_cast(), getLargestKnownDivisor(), and isNonNegativeBoundedBy().

Referenced by simplifyExprAndOperands().

◆ isValidAffineIndexOperand()

static bool isValidAffineIndexOperand	(	Value	value,
		Region *	region
	)

static

Definition at line 437 of file AffineOps.cpp.

References mlir::affine::isValidDim(), and mlir::affine::isValidSymbol().

Referenced by mlir::affine::AffineDmaStartOp::verifyInvariantsImpl(), and mlir::affine::AffineDmaWaitOp::verifyInvariantsImpl().

◆ makeComposedFoldedMinMax()

template<typename OpTy >

static OpFoldResult makeComposedFoldedMinMax	(	OpBuilder &	b,
		Location	loc,
		AffineMap	map,
		ArrayRef< OpFoldResult >	operands
	)

static

Definition at line 1380 of file AffineOps.cpp.

References composeMultiResultAffineMap(), mlir::Builder::getIndexType(), and materializeConstants().

◆ materializeConstants()

static void materializeConstants	(	OpBuilder &	b,
		Location	loc,
		ArrayRef< OpFoldResult >	values,
		SmallVectorImpl< Operation * > &	constants,
		SmallVectorImpl< Value > &	actualValues
	)

static

Given a list of OpFoldResult, build the necessary operations to populate actualValues with values produced by operations.

In particular, for any attribute-typed element in values, call the constant materializer associated with the Affine dialect to produce an operation. Do NOT notify the builder listener about the constant ops being created as they are intended to be removed after being folded into affine constructs; this is not suitable for use beyond the Affine dialect.

Definition at line 1203 of file AffineOps.cpp.

References mlir::Builder::getContext(), mlir::Builder::getIndexAttr(), mlir::Builder::getIndexType(), mlir::OpBuilder::getListener(), mlir::MLIRContext::getLoadedDialect(), and mlir::OpBuilder::setListener().

Referenced by mlir::affine::makeComposedFoldedAffineApply(), and makeComposedFoldedMinMax().

◆ parseAffineMapWithMinMax()

static ParseResult parseAffineMapWithMinMax	(	OpAsmParser &	parser,
		OperationState &	result,
		MinMaxKind	kind
	)

static

Parses an affine map that can contain a min/max for groups of its results, e.g., max(expr-1, expr-2), expr-3, max(expr-4, expr-5, expr-6).

Populates result attributes with the map (flat list of expressions) and the grouping (list of integers that specify how many expressions to put into each min/max) attributes. Deduplicates repeated operands.

parallel-bound ::= ( parallel-group-list ) parallel-group-list ::= parallel-group (, parallel-group-list)? parallel-group ::= simple-group | min-max-group simple-group ::= expr-of-ssa-ids min-max-group ::= ( min | max ) ( expr-of-ssa-ids-list ) expr-of-ssa-ids-list ::= expr-of-ssa-ids (, expr-of-ssa-id-list)?

Examples: (%0, min(%1 + %2, %3), %4, min(%5 floordiv 32, %6)) (%0, max(%1 - 2 * %2))

Definition at line 4196 of file AffineOps.cpp.

◆ parseAffineMinMaxOp()

template<typename T >

static ParseResult parseAffineMinMaxOp	(	OpAsmParser &	parser,
		OperationState &	result
	)

static

Definition at line 3376 of file AffineOps.cpp.

References mlir::AsmParser::addTypeToList(), mlir::OperationState::attributes, mlir::failure(), mlir::AsmParser::getBuilder(), mlir::Builder::getIndexType(), mlir::OperationState::operands, mlir::AsmParser::OptionalSquare, mlir::AsmParser::Paren, mlir::AsmParser::parseAttribute(), mlir::OpAsmParser::parseOperandList(), mlir::AsmParser::parseOptionalAttrDict(), mlir::OpAsmParser::resolveOperands(), and mlir::OperationState::types.

◆ parseBound()

static ParseResult parseBound	(	bool	isLower,
		OperationState &	result,
		OpAsmParser &	p
	)

static

◆ printAffineMinMaxOp()

template<typename T >

static void printAffineMinMaxOp	(	OpAsmPrinter &	p,
		T	op
	)

static

Definition at line 3363 of file AffineOps.cpp.

◆ printBound()

static void printBound	(	AffineMapAttr	boundMap,
		Operation::operand_range	boundOperands,
		const char *	prefix,
		OpAsmPrinter &	p
	)

static

Definition at line 2194 of file AffineOps.cpp.

References mlir::AffineExpr::dyn_cast(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumResults(), mlir::AffineMap::getNumSymbols(), mlir::AffineMap::getResult(), printDimAndSymbolList(), and mlir::OpAsmPrinter::printOperand().

◆ printDimAndSymbolList()

static void printDimAndSymbolList	(	Operation::operand_iterator	begin,
		Operation::operand_iterator	end,
		unsigned	numDims,
		OpAsmPrinter &	printer
	)

static

Prints dimension and symbol list.

Definition at line 442 of file AffineOps.cpp.

Referenced by printBound().

◆ printMinMaxBound()

static void printMinMaxBound	(	OpAsmPrinter &	p,
		AffineMapAttr	mapAttr,
		DenseIntElementsAttr	group,
		ValueRange	operands,
		StringRef	keyword
	)

static

Prints a lower(upper) bound of an affine parallel loop with max(min) conditions in it.

mapAttr is a flat list of affine expressions and group identifies which of the those expressions form max/min groups. operands are the SSA values of dimensions and symbols and keyword is either "min" or "max".

Definition at line 4081 of file AffineOps.cpp.

References mlir::get(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getResult(), mlir::AffineMap::getSliceMap(), mlir::OpAsmPrinter::printAffineExprOfSSAIds(), and mlir::OpAsmPrinter::printAffineMapOfSSAIds().

◆ remainsLegalAfterInline() [1/4]

template<>

bool LLVM_ATTRIBUTE_UNUSED remainsLegalAfterInline	(	AffineApplyOp	op,
		Region *	src,
		Region *	dest,
		const IRMapping &	mapping
	)

Checks if an affine apply operation remains legal after inlining from src to dest.

Definition at line 118 of file AffineOps.cpp.

◆ remainsLegalAfterInline() [2/4]

template<typename OpTy >

static bool remainsLegalAfterInline	(	OpTy	op,
		Region *	src,
		Region *	dest,
		const IRMapping &	mapping
	)

static

Checks if an affine read or write operation remains legal after inlining from src to dest.

Definition at line 92 of file AffineOps.cpp.

◆ remainsLegalAfterInline() [3/4]

static bool remainsLegalAfterInline	(	Value	value,
		Region *	src,
		Region *	dest,
		const IRMapping &	mapping,
		function_ref< bool(Value, Region *)>	legalityCheck
	)

static

Checks if value known to be a legal affine dimension or symbol in src region remains legal if the operation that uses it is inlined into dest with the given value mapping.

legalityCheck is either isValidDim or isValidSymbol, depending on the value being required to remain a valid dimension or symbol.

Definition at line 52 of file AffineOps.cpp.

References mlir::Value::getDefiningOp(), mlir::affine::isTopLevelValue(), mlir::IRMapping::lookup(), mlir::m_Constant(), and mlir::matchPattern().

Referenced by remainsLegalAfterInline().

◆ remainsLegalAfterInline() [4/4]

static bool remainsLegalAfterInline	(	ValueRange	values,
		Region *	src,
		Region *	dest,
		const IRMapping &	mapping,
		function_ref< bool(Value, Region *)>	legalityCheck
	)

static

Checks if all values known to be legal affine dimensions or symbols in src remain so if their respective users are inlined into dest.

Definition at line 81 of file AffineOps.cpp.

References remainsLegalAfterInline().

◆ replaceDimOrSym()

static LogicalResult replaceDimOrSym	(	AffineMap *	map,
		unsigned	dimOrSymbolPosition,
		SmallVectorImpl< Value > &	dims,
		SmallVectorImpl< Value > &	syms
	)

static

Replace all occurrences of AffineExpr at position pos in map by the defining AffineApplyOp expression and operands.

When dimOrSymbolPosition < dims.size(), AffineDimExpr@[pos] is replaced. When dimOrSymbolPosition >= dims.size(), AffineSymbolExpr@[pos - dims.size()] is replaced. Mutate map,dims and syms in place as follows:

dims and syms are only appended to.
map dim and symbols are gradually shifted to higher positions.
Old dim and sym entries are replaced by nullptr This avoids the need for any bookkeeping.

Definition at line 1077 of file AffineOps.cpp.

References mlir::affine::canonicalizeMapAndOperands(), mlir::failure(), mlir::getAffineDimExpr(), mlir::getAffineSymbolExpr(), mlir::AffineMap::getContext(), mlir::Value::getDefiningOp(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumResults(), mlir::AffineMap::getNumSymbols(), mlir::AffineMap::getResult(), mlir::AffineMap::replace(), mlir::AffineMap::shiftDims(), mlir::AffineMap::shiftSymbols(), and mlir::success().

Referenced by composeAffineMapAndOperands().

◆ simplifyExprAndOperands()

static void simplifyExprAndOperands	(	AffineExpr &	expr,
		unsigned	numDims,
		unsigned	numSymbols,
		ArrayRef< Value >	operands
	)

static

Simplify expr while exploiting information from the values in operands.

Definition at line 840 of file AffineOps.cpp.

References mlir::CeilDiv, mlir::ceilDiv(), mlir::AffineExpr::dyn_cast(), mlir::FloorDiv, mlir::floorDiv(), mlir::AffineExpr::floorDiv(), mlir::getAffineBinaryOpExpr(), mlir::getAffineConstantExpr(), mlir::AffineExpr::getContext(), mlir::AffineExpr::getKind(), getLargestKnownDivisor(), getLowerBound(), getUpperBound(), mlir::AffineConstantExpr::getValue(), isNonNegativeBoundedBy(), isQTimesDPlusR(), and mlir::Mod.

Referenced by simplifyMapWithOperands().

◆ simplifyMapWithOperands()

static void LLVM_ATTRIBUTE_UNUSED simplifyMapWithOperands	(	AffineMap &	map,
		ArrayRef< Value >	operands
	)

static

Simplify the map while exploiting information on the values in operands.

Definition at line 1054 of file AffineOps.cpp.

References mlir::AffineMap::get(), mlir::AffineMap::getContext(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumInputs(), mlir::AffineMap::getNumResults(), mlir::AffineMap::getNumSymbols(), mlir::AffineMap::getResults(), and simplifyExprAndOperands().

◆ simplifyMinOrMaxExprWithOperands()

static void simplifyMinOrMaxExprWithOperands	(	AffineMap &	map,
		ArrayRef< Value >	operands,
		bool	isMax
	)

static

Simplify the expressions in map while making use of lower or upper bounds of its operands.

If isMax is true, the map is to be treated as a max of its result expressions, and min otherwise. Eg: min (d0, d1) -> (8, 4 * d0 + d1) can be simplified to (8) if the operands are respectively lower bounded by 2 and 0 (the second expression can't be lower than 8).

Definition at line 943 of file AffineOps.cpp.

References mlir::detail::enumerate(), mlir::AffineMap::get(), mlir::getAffineConstantExpr(), getBoundForExpr(), mlir::AffineExpr::getContext(), mlir::AffineMap::getContext(), getLowerBound(), mlir::AffineMap::getNumDims(), mlir::AffineMap::getNumResults(), mlir::AffineMap::getNumSymbols(), mlir::AffineMap::getResults(), and getUpperBound().

Referenced by canonicalizeLoopBounds().

◆ verifyAffineMinMaxOp()

template<typename T >

static LogicalResult verifyAffineMinMaxOp ( T op )

static

Definition at line 3353 of file AffineOps.cpp.

◆ verifyDimAndSymbolIdentifiers()

template<typename OpTy >

static LogicalResult verifyDimAndSymbolIdentifiers	(	OpTy &	op,
		Operation::operand_range	operands,
		unsigned	numDims
	)

static

Utility function to verify that a set of operands are valid dimension and symbol identifiers.

The operands should be laid out such that the dimension operands are before the symbol operands. This function returns failure if there was an invalid operand. An operation is provided to emit any necessary errors.

Definition at line 474 of file AffineOps.cpp.

◆ verifyMemoryOpIndexing()

static LogicalResult verifyMemoryOpIndexing	(	Operation *	op,
		AffineMapAttr	mapAttr,
		Operation::operand_range	mapOperands,
		MemRefType	memrefType,
		unsigned	numIndexOperands
	)

static

Verify common indexing invariants of affine.load, affine.store, affine.vector_load and affine.vector_store.

Definition at line 3179 of file AffineOps.cpp.

◆ verifyVectorMemoryOp()

static LogicalResult verifyVectorMemoryOp	(	Operation *	op,
		MemRefType	memrefType,
		VectorType	vectorType
	)

static

Verify common invariants of affine.vector_load and affine.vector_store.

Definition at line 4485 of file AffineOps.cpp.

Classes

Macros

Functions

Macro Definition Documentation

◆ DEBUG_TYPE

◆ GET_OP_CLASSES

◆ GET_OP_LIST

Function Documentation

◆ buildAffineLoopFromConstants()

◆ buildAffineLoopFromValues()

◆ buildAffineLoopNestImpl()

◆ canonicalizeLoopBounds() [1/2]

◆ canonicalizeLoopBounds() [2/2]

◆ canonicalizeMapExprAndTermOrder()

◆ canonicalizeMapOrSetAndOperands()

◆ canonicalizePromotedSymbols()

◆ composeAffineMapAndOperands()

◆ composeMultiResultAffineMap()

◆ composeSetAndOperands()

◆ createFoldedComposedAffineApply()

◆ createOrFold()

◆ deduplicateAndResolveOperands()

◆ foldLoopBounds()

◆ foldMinMaxOp()

◆ getBoundForExpr()

◆ getLargestKnownDivisor()

◆ getLowerBound() [1/2]

◆ getLowerBound() [2/2]

◆ getUpperBound() [1/2]

◆ getUpperBound() [2/2]

◆ hasTrivialZeroTripCount()

◆ isDimOpValidSymbol()

◆ isMemRefSizeValidSymbol()

◆ isNonNegativeBoundedBy()

◆ isQTimesDPlusR()

◆ isValidAffineIndexOperand()

◆ makeComposedFoldedMinMax()

◆ materializeConstants()

◆ parseAffineMapWithMinMax()

◆ parseAffineMinMaxOp()

◆ parseBound()

◆ printAffineMinMaxOp()

◆ printBound()

◆ printDimAndSymbolList()

◆ printMinMaxBound()

◆ remainsLegalAfterInline() [1/4]

◆ remainsLegalAfterInline() [2/4]

◆ remainsLegalAfterInline() [3/4]

◆ remainsLegalAfterInline() [4/4]

◆ replaceDimOrSym()

◆ simplifyExprAndOperands()

◆ simplifyMapWithOperands()

◆ simplifyMinOrMaxExprWithOperands()

◆ verifyAffineMinMaxOp()

◆ verifyDimAndSymbolIdentifiers()

◆ verifyMemoryOpIndexing()

◆ verifyVectorMemoryOp()