MLIR 23.0.0git
Classes | Macros | Typedefs | Functions | Variables
ArithOps.cpp File Reference
#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/UBMatchers.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/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"

Go to the source code of this file.

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 (std::optional< RoundingMode > roundingMode)
 Equivalent to convertRoundingModeToLLVM(convertArithRoundingModeToLLVM(roundingMode)).
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.
static APInt calculateUnsignedOverflow (const APInt &sum, const APInt &operand)
static Value foldDivMul (Value lhs, Value rhs, arith::IntegerOverflowFlags ovfFlags)
 Fold (a * b) / b -> a
static Speculation::Speculatability getDivUISpeculatability (Value divisor)
 Returns whether an unsigned division by divisor is speculatable.
static Speculation::Speculatability getDivSISpeculatability (Value divisor)
 Returns whether a signed division by divisor is speculatable.
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)
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.
template<typename... ElementTypes>
static Type getTypeIfLike (Type type)
 Get allowed underlying types for vectors and tensors.
template<typename... ElementTypes>
static Type getTypeIfLikeOrMemRef (Type type)
 Get allowed underlying types for vectors, tensors, and memrefs.
static bool hasSameEncoding (Type typeA, Type typeB)
 Return false if both types are ranked tensor with mismatching encoding.
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.
static FailureOr< APFloat > convertFloatValue (APFloat sourceValue, const llvm::fltSemantics &targetSemantics, llvm::RoundingMode roundingMode=kDefaultRoundingMode)
 Attempts to convert sourceValue to an APFloat value with targetSemantics and roundingMode, without any information loss.
template<typename From, typename To>
static bool checkIntFloatCast (TypeRange inputs, TypeRange outputs)
static unsigned getIndexCastWidth (Type t)
 Return the bit-width of t for the purpose of index_cast width checks.
static bool areIndexCastCompatible (TypeRange inputs, TypeRange outputs)
static bool applyCmpPredicateToEqualOperands (arith::CmpIPredicate predicate)
 Returns true if the predicate is true for two equal operands.
static std::optional< int64_t > getIntegerWidth (Type t)

Variables

static constexpr llvm::RoundingMode kDefaultRoundingMode
 Default rounding mode according to default LLVM floating-point environment.

Macro Definition Documentation

◆ GET_OP_CLASSES

#define GET_OP_CLASSES

Definition at line 3004 of file ArithOps.cpp.

Typedef Documentation

◆ type_list

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

Definition at line 1409 of file ArithOps.cpp.

Function Documentation

◆ addIntegerAttrs()

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

Definition at line 55 of file ArithOps.cpp.

References applyToIntegerAttrs(), lhs, and rhs.

◆ applyCmpPredicateToEqualOperands()

bool applyCmpPredicateToEqualOperands ( arith::CmpIPredicate predicate)
static

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

Definition at line 2136 of file ArithOps.cpp.

◆ applyToIntegerAttrs()

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

Definition at line 46 of file ArithOps.cpp.

References mlir::Value::getType(), lhs, and rhs.

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

◆ areIndexCastCompatible()

bool areIndexCastCompatible ( TypeRange inputs,
TypeRange outputs )
static

Definition at line 1962 of file ArithOps.cpp.

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

◆ areValidCastInputsAndOutputs()

bool areValidCastInputsAndOutputs ( TypeRange inputs,
TypeRange outputs )
static

Definition at line 1451 of file ArithOps.cpp.

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

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

◆ calculateUnsignedOverflow()

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

Definition at line 443 of file ArithOps.cpp.

◆ checkIntFloatCast()

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

Definition at line 1841 of file ArithOps.cpp.

References areValidCastInputsAndOutputs(), and getTypeIfLike().

◆ checkWidthChangeCast()

template<template< typename > class WidthComparator, typename... ElementTypes>
bool checkWidthChangeCast ( TypeRange inputs,
TypeRange outputs )
static

Validate a cast that changes the width of a type.

Definition at line 1493 of file ArithOps.cpp.

References areValidCastInputsAndOutputs(), and getTypeIfLike().

◆ convertArithRoundingModeToLLVMIR()

llvm::RoundingMode convertArithRoundingModeToLLVMIR ( std::optional< 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 112 of file ArithOps.cpp.

References kDefaultRoundingMode.

◆ convertFloatValue()

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

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

Definition at line 1509 of file ArithOps.cpp.

References kDefaultRoundingMode.

◆ foldAndIofAndI()

Value foldAndIofAndI ( arith::AndIOp op)
static

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

Definition at line 981 of file ArithOps.cpp.

◆ foldDivMul()

Value foldDivMul ( Value lhs,
Value rhs,
arith::IntegerOverflowFlags ovfFlags )
static

Fold (a * b) / b -> a

Definition at line 688 of file ArithOps.cpp.

References lhs, mul, and rhs.

◆ getBoolAttribute()

Attribute getBoolAttribute ( Type type,
bool value )
static

Definition at line 155 of file ArithOps.cpp.

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

◆ getDivSISpeculatability()

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 769 of file ArithOps.cpp.

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

◆ getDivUISpeculatability()

Speculation::Speculatability getDivUISpeculatability ( Value divisor)
static

Returns whether an unsigned division by divisor is speculatable.

Definition at line 727 of file ArithOps.cpp.

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

◆ getI1SameShape()

Type getI1SameShape ( Type type)
static

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

Definition at line 179 of file ArithOps.cpp.

References mlir::Type::getContext().

◆ getIndexCastWidth()

unsigned getIndexCastWidth ( Type t)
static

Return the bit-width of t for the purpose of index_cast width checks.

For vector types use the element type; index maps to its internal storage width (64 on all current targets).

Definition at line 1956 of file ArithOps.cpp.

References mlir::getElementTypeOrSelf().

◆ getIntegerWidth()

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

Definition at line 2154 of file ArithOps.cpp.

◆ getIntOrSplatIntValue()

FailureOr< APInt > getIntOrSplatIntValue ( Attribute attr)
static

Definition at line 147 of file ArithOps.cpp.

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

◆ getScalarOrElementWidth() [1/2]

int64_t getScalarOrElementWidth ( Type type)
static

Definition at line 135 of file ArithOps.cpp.

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

Referenced by getScalarOrElementWidth().

◆ getScalarOrElementWidth() [2/2]

int64_t getScalarOrElementWidth ( Value value)
static

Definition at line 143 of file ArithOps.cpp.

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

◆ getTypeIfLike()

template<typename... ElementTypes>
Type getTypeIfLike ( Type type)
static

Get allowed underlying types for vectors and tensors.

Definition at line 1429 of file ArithOps.cpp.

References getUnderlyingType().

Referenced by checkIntFloatCast(), and checkWidthChangeCast().

◆ getTypeIfLikeOrMemRef()

template<typename... ElementTypes>
Type getTypeIfLikeOrMemRef ( Type type)
static

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

Definition at line 1436 of file ArithOps.cpp.

References getUnderlyingType().

Referenced by areIndexCastCompatible().

◆ getUnderlyingType()

template<typename... ShapedTypes, typename... ElementTypes>
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 1415 of file ArithOps.cpp.

References mlir::getElementTypeOrSelf().

Referenced by getTypeIfLike(), and getTypeIfLikeOrMemRef().

◆ hasSameEncoding()

bool hasSameEncoding ( Type typeA,
Type typeB )
static

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

Definition at line 1443 of file ArithOps.cpp.

Referenced by areValidCastInputsAndOutputs().

◆ invertPredicate()

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

Definition at line 130 of file ArithOps.cpp.

References mlir::arith::invertPredicate().

◆ mergeOverflowFlags()

IntegerOverflowFlagsAttr mergeOverflowFlags ( IntegerOverflowFlagsAttr val1,
IntegerOverflowFlagsAttr val2 )
static

Definition at line 72 of file ArithOps.cpp.

◆ mulIntegerAttrs()

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

Definition at line 65 of file ArithOps.cpp.

References applyToIntegerAttrs(), lhs, and rhs.

◆ signedCeilNonnegInputs()

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

Definition at line 787 of file ArithOps.cpp.

References b.

◆ subIntegerAttrs()

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

Definition at line 60 of file ArithOps.cpp.

References applyToIntegerAttrs(), lhs, and rhs.

◆ verifyExtOp()

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

Definition at line 1465 of file ArithOps.cpp.

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

◆ verifyTruncateOp()

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

Definition at line 1479 of file ArithOps.cpp.

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

Variable Documentation

◆ kDefaultRoundingMode

llvm::RoundingMode kDefaultRoundingMode
staticconstexpr
Initial value:
=
llvm::RoundingMode::NearestTiesToEven

Default rounding mode according to default LLVM floating-point environment.

Definition at line 38 of file ArithOps.cpp.

Referenced by convertArithRoundingModeToLLVMIR(), and convertFloatValue().

Generated on for MLIR by doxygen 1.14.0