#include <cassert>
#include <cstdint>
#include <functional>
#include <utility>
#include "mlir/Dialect/Arith/IR/Arith.h"
#include "mlir/Dialect/CommonFolders.h"
#include "mlir/Dialect/UB/IR/UBOps.h"
#include "mlir/IR/Builders.h"
#include "mlir/IR/BuiltinAttributeInterfaces.h"
#include "mlir/IR/BuiltinAttributes.h"
#include "mlir/IR/Matchers.h"
#include "mlir/IR/OpImplementation.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/IR/TypeUtilities.h"
#include "mlir/Support/LogicalResult.h"
#include "llvm/ADT/APFloat.h"
#include "llvm/ADT/APInt.h"
#include "llvm/ADT/APSInt.h"
#include "llvm/ADT/FloatingPointMode.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallString.h"
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/TypeSwitch.h"
#include "ArithCanonicalization.inc"
#include "mlir/Dialect/Arith/IR/ArithOps.cpp.inc"
#include "mlir/Dialect/Arith/IR/ArithOpsEnums.cpp.inc"

Classes
class	CmpFIntToFPConst

struct	SelectToExtUI

Macros
#define	GET_OP_CLASSES

Typedefs
template<typename... Types>
using	type_list = std::tuple< Types... > *

Functions
static IntegerAttr	applyToIntegerAttrs (PatternRewriter &builder, Value res, Attribute lhs, Attribute rhs, function_ref< APInt(const APInt &, const APInt &)> binFn)

static IntegerAttr	addIntegerAttrs (PatternRewriter &builder, Value res, Attribute lhs, Attribute rhs)

static IntegerAttr	subIntegerAttrs (PatternRewriter &builder, Value res, Attribute lhs, Attribute rhs)

static IntegerAttr	mulIntegerAttrs (PatternRewriter &builder, Value res, Attribute lhs, Attribute rhs)

static IntegerOverflowFlagsAttr	mergeOverflowFlags (IntegerOverflowFlagsAttr val1, IntegerOverflowFlagsAttr val2)

static llvm::RoundingMode	convertArithRoundingModeToLLVMIR (RoundingMode roundingMode)
	Equivalent to convertRoundingModeToLLVM(convertArithRoundingModeToLLVM(roundingMode)). More...

static arith::CmpIPredicateAttr	invertPredicate (arith::CmpIPredicateAttr pred)

static int64_t	getScalarOrElementWidth (Type type)

static int64_t	getScalarOrElementWidth (Value value)

static FailureOr< APInt >	getIntOrSplatIntValue (Attribute attr)

static Attribute	getBoolAttribute (Type type, bool value)

static Type	getI1SameShape (Type type)
	Return the type of the same shape (scalar, vector or tensor) containing i1. More...

static APInt	calculateUnsignedOverflow (const APInt &sum, const APInt &operand)

static Speculation::Speculatability	getDivUISpeculatability (Value divisor)
	Returns whether an unsigned division by `divisor` is speculatable. More...

static Speculation::Speculatability	getDivSISpeculatability (Value divisor)
	Returns whether a signed division by `divisor` is speculatable. More...

static APInt	signedCeilNonnegInputs (const APInt &a, const APInt &b, bool &overflow)

static Value	foldAndIofAndI (arith::AndIOp op)
	Fold `and(a, and(a, b))` to `and(a, b)` More...

template<typename... ShapedTypes, typename... ElementTypes>
static Type	getUnderlyingType (Type type, type_list< ShapedTypes... >, type_list< ElementTypes... >)
	Returns a non-null type only if the provided type is one of the allowed types or one of the allowed shaped types of the allowed types. More...

template<typename... ElementTypes>
static Type	getTypeIfLike (Type type)
	Get allowed underlying types for vectors and tensors. More...

template<typename... ElementTypes>
static Type	getTypeIfLikeOrMemRef (Type type)
	Get allowed underlying types for vectors, tensors, and memrefs. More...

static bool	hasSameEncoding (Type typeA, Type typeB)
	Return false if both types are ranked tensor with mismatching encoding. More...

static bool	areValidCastInputsAndOutputs (TypeRange inputs, TypeRange outputs)

template<typename ValType , typename Op >
static LogicalResult	verifyExtOp (Op op)

template<typename ValType , typename Op >
static LogicalResult	verifyTruncateOp (Op op)

template<template< typename > class WidthComparator, typename... ElementTypes>
static bool	checkWidthChangeCast (TypeRange inputs, TypeRange outputs)
	Validate a cast that changes the width of a type. More...

static FailureOr< APFloat >	convertFloatValue (APFloat sourceValue, const llvm::fltSemantics &targetSemantics, llvm::RoundingMode roundingMode=llvm::RoundingMode::NearestTiesToEven)
	Attempts to convert `sourceValue` to an APFloat value with `targetSemantics` and `roundingMode`, without any information loss. More...

template<typename From , typename To >
static bool	checkIntFloatCast (TypeRange inputs, TypeRange outputs)

static bool	areIndexCastCompatible (TypeRange inputs, TypeRange outputs)

static bool	applyCmpPredicateToEqualOperands (arith::CmpIPredicate predicate)
	Returns true if the predicate is true for two equal operands. More...

static std::optional< int64_t >	getIntegerWidth (Type t)

Macro Definition Documentation

◆ GET_OP_CLASSES

#define GET_OP_CLASSES

Definition at line 2645 of file ArithOps.cpp.

Typedef Documentation

◆ type_list

template<typename... Types>

using type_list = std::tuple<Types...> *

Definition at line 1223 of file ArithOps.cpp.

Function Documentation

◆ addIntegerAttrs()

static IntegerAttr addIntegerAttrs	(	PatternRewriter &	builder,
		Value	res,
		Attribute	lhs,
		Attribute	rhs
	)

static

Definition at line 52 of file ArithOps.cpp.

References applyToIntegerAttrs().

◆ applyCmpPredicateToEqualOperands()

static bool applyCmpPredicateToEqualOperands ( arith::CmpIPredicate predicate )

static

Returns true if the predicate is true for two equal operands.

Definition at line 1794 of file ArithOps.cpp.

◆ applyToIntegerAttrs()

static IntegerAttr applyToIntegerAttrs	(	PatternRewriter &	builder,
		Value	res,
		Attribute	lhs,
		Attribute	rhs,
		function_ref< APInt(const APInt &, const APInt &)>	binFn
	)

static

Definition at line 43 of file ArithOps.cpp.

References mlir::get(), and mlir::Value::getType().

Referenced by addIntegerAttrs(), mulIntegerAttrs(), and subIntegerAttrs().

◆ areIndexCastCompatible()

static bool areIndexCastCompatible	(	TypeRange	inputs,
		TypeRange	outputs
	)

static

Definition at line 1648 of file ArithOps.cpp.

References areValidCastInputsAndOutputs(), mlir::Type::isIndex(), and mlir::Type::isSignlessInteger().

◆ areValidCastInputsAndOutputs()

static bool areValidCastInputsAndOutputs	(	TypeRange	inputs,
		TypeRange	outputs
	)

static

Definition at line 1265 of file ArithOps.cpp.

References hasSameEncoding(), and mlir::verifyCompatibleShapes().

Referenced by areIndexCastCompatible(), checkIntFloatCast(), and checkWidthChangeCast().

◆ calculateUnsignedOverflow()

static APInt calculateUnsignedOverflow	(	const APInt &	sum,
		const APInt &	operand
	)

static

Definition at line 345 of file ArithOps.cpp.

References getZero().

◆ checkIntFloatCast()

template<typename From , typename To >

static bool checkIntFloatCast	(	TypeRange	inputs,
		TypeRange	outputs
	)

static

Definition at line 1546 of file ArithOps.cpp.

References areValidCastInputsAndOutputs().

◆ checkWidthChangeCast()

template<template< typename > class WidthComparator, typename... ElementTypes>

static bool checkWidthChangeCast	(	TypeRange	inputs,
		TypeRange	outputs
	)

static

Validate a cast that changes the width of a type.

Definition at line 1307 of file ArithOps.cpp.

References areValidCastInputsAndOutputs(), and getTypeIfLike().

◆ convertArithRoundingModeToLLVMIR()

static llvm::RoundingMode convertArithRoundingModeToLLVMIR ( RoundingMode roundingMode )

static

Equivalent to convertRoundingModeToLLVM(convertArithRoundingModeToLLVM(roundingMode)).

Not possible to implement as chain of calls as this would introduce a circular dependency with MLIRArithAttrToLLVMConversion and make arith depend on the LLVM dialect and on translation to LLVM.

Definition at line 109 of file ArithOps.cpp.

◆ convertFloatValue()

static FailureOr<APFloat> convertFloatValue	(	APFloat	sourceValue,
		const llvm::fltSemantics &	targetSemantics,
		llvm::RoundingMode	roundingMode = `llvm::RoundingMode::NearestTiesToEven`
	)

static

Attempts to convert sourceValue to an APFloat value with targetSemantics and roundingMode, without any information loss.

Definition at line 1322 of file ArithOps.cpp.

◆ foldAndIofAndI()

static Value foldAndIofAndI ( arith::AndIOp op )

static

Fold and(a, and(a, b)) to and(a, b)

Definition at line 840 of file ArithOps.cpp.

◆ getBoolAttribute()

static Attribute getBoolAttribute	(	Type	type,
		bool	value
	)

static

Definition at line 150 of file ArithOps.cpp.

References mlir::BoolAttr::get(), mlir::DenseElementsAttr::get(), and mlir::Type::getContext().

◆ getDivSISpeculatability()

static Speculation::Speculatability getDivSISpeculatability ( Value divisor )

static

Returns whether a signed division by divisor is speculatable.

This function conservatively assumes that all signed division by -1 are not speculatable.

Definition at line 641 of file ArithOps.cpp.

References mlir::m_IntRangeWithoutNegOneS(), mlir::m_IntRangeWithoutZeroS(), mlir::matchPattern(), mlir::Speculation::NotSpeculatable, and mlir::Speculation::Speculatable.

◆ getDivUISpeculatability()

static Speculation::Speculatability getDivUISpeculatability ( Value divisor )

static

Returns whether an unsigned division by divisor is speculatable.

Definition at line 603 of file ArithOps.cpp.

References mlir::m_IntRangeWithoutZeroU(), mlir::matchPattern(), mlir::Speculation::NotSpeculatable, and mlir::Speculation::Speculatable.

◆ getI1SameShape()

static Type getI1SameShape ( Type type )

static

Return the type of the same shape (scalar, vector or tensor) containing i1.

Definition at line 171 of file ArithOps.cpp.

References mlir::get(), and mlir::Type::getContext().

◆ getIntegerWidth()

static std::optional<int64_t> getIntegerWidth ( Type t )

static

Definition at line 1812 of file ArithOps.cpp.

◆ getIntOrSplatIntValue()

static FailureOr<APInt> getIntOrSplatIntValue ( Attribute attr )

static

Definition at line 142 of file ArithOps.cpp.

References mlir::m_ConstantInt(), and mlir::matchPattern().

◆ getScalarOrElementWidth() [1/2]

static int64_t getScalarOrElementWidth ( Type type )

static

Definition at line 130 of file ArithOps.cpp.

References mlir::getElementTypeOrSelf(), mlir::Type::getIntOrFloatBitWidth(), and mlir::Type::isIntOrFloat().

Referenced by getScalarOrElementWidth().

◆ getScalarOrElementWidth() [2/2]

static int64_t getScalarOrElementWidth ( Value value )

static

Definition at line 138 of file ArithOps.cpp.

References getScalarOrElementWidth(), and mlir::Value::getType().

◆ getTypeIfLike()

template<typename... ElementTypes>

static Type getTypeIfLike ( Type type )

static

Get allowed underlying types for vectors and tensors.

Definition at line 1243 of file ArithOps.cpp.

References getUnderlyingType().

Referenced by checkWidthChangeCast().

◆ getTypeIfLikeOrMemRef()

template<typename... ElementTypes>

static Type getTypeIfLikeOrMemRef ( Type type )

static

Get allowed underlying types for vectors, tensors, and memrefs.

Definition at line 1250 of file ArithOps.cpp.

References getUnderlyingType().

◆ getUnderlyingType()

template<typename... ShapedTypes, typename... ElementTypes>

static Type getUnderlyingType	(	Type	type,
		type_list< ShapedTypes... >	,
		type_list< ElementTypes... >
	)

static

Returns a non-null type only if the provided type is one of the allowed types or one of the allowed shaped types of the allowed types.

Returns the element type if a valid shaped type is provided.

Definition at line 1229 of file ArithOps.cpp.

References mlir::getElementTypeOrSelf().

Referenced by getTypeIfLike(), and getTypeIfLikeOrMemRef().

◆ hasSameEncoding()

static bool hasSameEncoding	(	Type	typeA,
		Type	typeB
	)

static

Return false if both types are ranked tensor with mismatching encoding.

Definition at line 1257 of file ArithOps.cpp.

Referenced by areValidCastInputsAndOutputs().

◆ invertPredicate()

static arith::CmpIPredicateAttr invertPredicate ( arith::CmpIPredicateAttr pred )

static

Definition at line 125 of file ArithOps.cpp.

References mlir::get(), and mlir::arith::invertPredicate().

◆ mergeOverflowFlags()

static IntegerOverflowFlagsAttr mergeOverflowFlags	(	IntegerOverflowFlagsAttr	val1,
		IntegerOverflowFlagsAttr	val2
	)

static

Definition at line 69 of file ArithOps.cpp.

References mlir::get().

◆ mulIntegerAttrs()

static IntegerAttr mulIntegerAttrs	(	PatternRewriter &	builder,
		Value	res,
		Attribute	lhs,
		Attribute	rhs
	)

static

Definition at line 62 of file ArithOps.cpp.

References applyToIntegerAttrs().

◆ signedCeilNonnegInputs()

static APInt signedCeilNonnegInputs	(	const APInt &	a,
		const APInt &	b,
		bool &	overflow
	)

static

Definition at line 659 of file ArithOps.cpp.

◆ subIntegerAttrs()

static IntegerAttr subIntegerAttrs	(	PatternRewriter &	builder,
		Value	res,
		Attribute	lhs,
		Attribute	rhs
	)

static

Definition at line 57 of file ArithOps.cpp.

References applyToIntegerAttrs().

◆ verifyExtOp()

template<typename ValType , typename Op >

static LogicalResult verifyExtOp ( Op op )

static

Definition at line 1279 of file ArithOps.cpp.

References mlir::OpState::emitError(), and mlir::getElementTypeOrSelf().

◆ verifyTruncateOp()

template<typename ValType , typename Op >

static LogicalResult verifyTruncateOp ( Op op )

static

Definition at line 1293 of file ArithOps.cpp.

References mlir::OpState::emitError(), and mlir::getElementTypeOrSelf().

Classes

Macros

Typedefs

Functions

Macro Definition Documentation

◆ GET_OP_CLASSES

Typedef Documentation

◆ type_list

Function Documentation

◆ addIntegerAttrs()

◆ applyCmpPredicateToEqualOperands()

◆ applyToIntegerAttrs()

◆ areIndexCastCompatible()

◆ areValidCastInputsAndOutputs()

◆ calculateUnsignedOverflow()

◆ checkIntFloatCast()

◆ checkWidthChangeCast()

◆ convertArithRoundingModeToLLVMIR()

◆ convertFloatValue()

◆ foldAndIofAndI()

◆ getBoolAttribute()

◆ getDivSISpeculatability()

◆ getDivUISpeculatability()

◆ getI1SameShape()

◆ getIntegerWidth()

◆ getIntOrSplatIntValue()

◆ getScalarOrElementWidth() [1/2]

◆ getScalarOrElementWidth() [2/2]

◆ getTypeIfLike()

◆ getTypeIfLikeOrMemRef()

◆ getUnderlyingType()

◆ hasSameEncoding()

◆ invertPredicate()

◆ mergeOverflowFlags()

◆ mulIntegerAttrs()

◆ signedCeilNonnegInputs()

◆ subIntegerAttrs()

◆ verifyExtOp()

◆ verifyTruncateOp()