mlir.dialects._irdl_ops_gen¶

Attributes¶

_ods_ir

Classes¶

`_Dialect`
`AllOfOp`	`irdl.all_of` defines a constraint that accepts any type or attribute that
`AnyOfOp`	`irdl.any_of` defines a constraint that accepts any type or attribute that
`AnyOp`	`irdl.any` defines a constraint that accepts any type or attribute.
`AttributeOp`	`irdl.attribute` defines a new attribute belonging to the `irdl.dialect`
`AttributesOp`	`irdl.attributes` defines the attributes of the `irdl.operation` parent
`BaseOp`	`irdl.base` defines a constraint that only accepts a single type
`CPredOp`	`irdl.c_pred` defines a constraint that is written in C++.
`DialectOp`	The `irdl.dialect` operation defines a dialect. All operations, attributes,
`IsOp`	`irdl.is` defines a constraint that only accepts a specific instance of a
`OperandsOp`	`irdl.operands` define the operands of the `irdl.operation` parent operation
`OperationOp`	`irdl.operation` defines a new operation belonging to the `irdl.dialect`
`ParametersOp`	`irdl.parameters` defines the constraints on parameters of a type or
`ParametricOp`	`irdl.parametric` defines a constraint that accepts only a single type
`RegionOp`	The irdl.region construct defines a set of characteristics
`RegionsOp`	`irdl.regions` defines the regions of an operation by accepting
`ResultsOp`	`irdl.results` define the results of the `irdl.operation` parent operation
`TypeOp`	`irdl.type` defines a new type belonging to the `irdl.dialect` parent.

Functions¶

`all_of`(→ _ods_ir)
`any_of`(→ _ods_ir)
`any`(→ _ods_ir)
`attribute`(→ AttributeOp)
`attributes_`(→ AttributesOp)
`base`(→ _ods_ir)
`c_pred`(→ _ods_ir)
`dialect`(→ DialectOp)
`is_`(→ _ods_ir)
`operands_`(→ OperandsOp)
`operation_`(→ OperationOp)
`parameters`(→ ParametersOp)
`parametric`(→ _ods_ir)
`region`(→ _ods_ir)
`regions_`(→ RegionsOp)
`results_`(→ ResultsOp)
`type_`(→ TypeOp)

Module Contents¶

mlir.dialects._irdl_ops_gen._ods_ir¶

class mlir.dialects._irdl_ops_gen._Dialect(descriptor: object)¶

Bases: _ods_ir

DIALECT_NAMESPACE = 'irdl'¶

class mlir.dialects._irdl_ops_gen.AllOfOp(args, *, results=None, loc=None, ip=None)¶

Bases: _ods_ir

irdl.all_of defines a constraint that accepts any type or attribute that satisfies all of its provided constraints.

Example:

irdl.dialect @cmath {
  irdl.type @complex_f32 {
    %0 = irdl.is i32
    %1 = irdl.is f32
    %2 = irdl.any_of(%0, %1) // is 32-bit

    %3 = irdl.is f32
    %4 = irdl.is f64
    %5 = irdl.any_of(%3, %4) // is a float

    %6 = irdl.all_of(%2, %5) // is a 32-bit float
    irdl.parameters(%6)
  }
}

The above program defines a type complex inside the dialect cmath that has one parameter that must be 32-bit long and a float (in other words, that must be f32).

OPERATION_NAME = 'irdl.all_of'¶

_ODS_REGIONS = (0, True)¶

args() → _ods_ir¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.all_of(args, *, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.AnyOfOp(args, *, results=None, loc=None, ip=None)¶

Bases: _ods_ir

irdl.any_of defines a constraint that accepts any type or attribute that satisfies at least one of its provided type constraints.

Example:

irdl.dialect @cmath {
  irdl.type @complex {
    %0 = irdl.is i32
    %1 = irdl.is i64
    %2 = irdl.is f32
    %3 = irdl.is f64
    %4 = irdl.any_of(%0, %1, %2, %3)
    irdl.parameters(%4)
  }
}

The above program defines a type complex inside the dialect cmath that has a single type parameter that can be either i32, i64, f32 or f64.

OPERATION_NAME = 'irdl.any_of'¶

_ODS_REGIONS = (0, True)¶

args() → _ods_ir¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.any_of(args, *, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.AnyOp(*, results=None, loc=None, ip=None)¶

Bases: _ods_ir

irdl.any defines a constraint that accepts any type or attribute.

Example:

irdl.dialect @cmath {
  irdl.type @complex_flexible {
    %0 = irdl.any
    irdl.parameters(%0)
  }
}

The above program defines a type complex_flexible inside the dialect cmath that has a single parameter that can be any attribute.

OPERATION_NAME = 'irdl.any'¶

_ODS_REGIONS = (0, True)¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.any(*, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.AttributeOp(sym_name, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.attribute defines a new attribute belonging to the irdl.dialect parent.

The attribute parameters can be defined with an irdl.parameters operation in the optional region.

Example:

irdl.dialect @testd {
  irdl.attribute @enum_attr {
    %0 = irdl.is "foo"
    %1 = irdl.is "bar"
    %2 = irdl.any_of(%0, %1)
    irdl.parameters(%2)
  }
}

The above program defines an enum_attr attribute inside the testd dialect. The attribute has one StringAttr parameter that should be either a "foo" or a "bar".

OPERATION_NAME = 'irdl.attribute'¶

_ODS_REGIONS = (1, True)¶

sym_name() → _ods_ir¶

body() → _ods_ir¶

mlir.dialects._irdl_ops_gen.attribute(sym_name, *, loc=None, ip=None) → AttributeOp¶

class mlir.dialects._irdl_ops_gen.AttributesOp(attributeValues, attributeValueNames, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.attributes defines the attributes of the irdl.operation parent operation definition.

In the following example, irdl.attributes defines the attributes of the attr_op operation:

irdl.dialect @example {

  irdl.operation @attr_op {
    %0 = irdl.any
    %1 = irdl.is i64
    irdl.attibutes {
      "attr1" = %0,
      "attr2" = %1
    }
  }
}

The operation will expect an arbitrary attribute “attr1” and an attribute “attr2” with value i64.

OPERATION_NAME = 'irdl.attributes'¶

_ODS_REGIONS = (0, True)¶

attributeValues() → _ods_ir¶

attributeValueNames() → _ods_ir¶

mlir.dialects._irdl_ops_gen.attributes_(attribute_values, attribute_value_names, *, loc=None, ip=None) → AttributesOp¶

class mlir.dialects._irdl_ops_gen.BaseOp(*, base_ref=None, base_name=None, results=None, loc=None, ip=None)¶

Bases: _ods_ir

irdl.base defines a constraint that only accepts a single type or attribute base, e.g. an IntegerType. The attribute base is defined either by a symbolic reference to the corresponding IRDL definition, or by the name of the base. Named bases are prefixed with ! or # respectively for types and attributes.

Example:

irdl.dialect @cmath {
  irdl.type @complex {
    %0 = irdl.base "!builtin.integer"
    irdl.parameters(%0)
  }

  irdl.type @complex_wrapper {
    %0 = irdl.base @cmath::@complex
    irdl.parameters(%0)
  }
}

The above program defines a cmath.complex type that expects a single parameter, which is a type with base name builtin.integer, which is the name of an IntegerType type. It also defines a cmath.complex_wrapper type that expects a single parameter, which is a type of base type cmath.complex.

OPERATION_NAME = 'irdl.base'¶

_ODS_REGIONS = (0, True)¶

base_ref() → _ods_ir | None¶

base_name() → _ods_ir | None¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.base(*, base_ref=None, base_name=None, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.CPredOp(pred, *, results=None, loc=None, ip=None)¶

Bases: _ods_ir

irdl.c_pred defines a constraint that is written in C++.

Dialects using this operation cannot be registered at runtime, as it relies on C++ code.

Special placeholders can be used to refer to entities in the context where this predicate is used. They serve as “hooks” to the enclosing environment. The following special placeholders are supported in constraints for an op:

$_builder will be replaced by a mlir::Builder instance.
$_op will be replaced by the current operation.
$_self will be replaced with the entity this predicate is attached to.

Compared to ODS, $_self is always of type mlir::Attribute, and types are manipulated as TypeAttr attributes.

Example:

irdl.type @op_with_attr {
  %0 = irdl.c_pred "::llvm::isa<::mlir::IntegerAttr>($_self)"
  irdl.parameters(%0)
}

In this example, @op_with_attr is defined as a type with a single parameter, which is an IntegerAttr, as constrained by the C++ predicate.

OPERATION_NAME = 'irdl.c_pred'¶

_ODS_REGIONS = (0, True)¶

pred() → _ods_ir¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.c_pred(pred, *, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.DialectOp(sym_name, *, loc=None, ip=None)¶

Bases: _ods_ir

The irdl.dialect operation defines a dialect. All operations, attributes, and types defined inside its region will be part of the dialect.

Example:

irdl.dialect @cmath {
  ...
}

The above program defines a cmath dialect.

OPERATION_NAME = 'irdl.dialect'¶

_ODS_REGIONS = (1, True)¶

sym_name() → _ods_ir¶

body() → _ods_ir¶

mlir.dialects._irdl_ops_gen.dialect(sym_name, *, loc=None, ip=None) → DialectOp¶

class mlir.dialects._irdl_ops_gen.IsOp(expected, *, results=None, loc=None, ip=None)¶

Bases: _ods_ir

irdl.is defines a constraint that only accepts a specific instance of a type or attribute.

Example:

irdl.dialect @cmath {
  irdl.type @complex_i32 {
    %0 = irdl.is i32
    irdl.parameters(%0)
  }
}

The above program defines a complex_i32 type inside the dialect cmath that can only have a i32 as its parameter.

OPERATION_NAME = 'irdl.is'¶

_ODS_REGIONS = (0, True)¶

expected() → _ods_ir¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.is_(expected, *, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.OperandsOp(args, names, variadicity, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.operands define the operands of the irdl.operation parent operation definition. Each operand is named after an identifier.

In the following example, irdl.operands defines the operands of the mul operation:

irdl.dialect @cmath {

  irdl.type @complex { /* ... */ }

  irdl.operation @mul {
    %0 = irdl.any
    %1 = irdl.parametric @cmath::@complex<%0>
    irdl.results(res: %1)
    irdl.operands(lhs: %1, rhs: %1)
  }
}

The mul operation will expect two operands of type cmath.complex, that have the same type, and return a result of the same type.

The operands can also be marked as variadic or optional:

irdl.operands(foo: %0, bar: single %1, baz: optional %2, qux: variadic %3)

Here, foo and bar are required single operands, baz is an optional operand, and qux is a variadic operand.

When more than one operand is marked as optional or variadic, the operation will expect a ‘operandSegmentSizes’ attribute that defines the number of operands in each segment.

OPERATION_NAME = 'irdl.operands'¶

_ODS_REGIONS = (0, True)¶

args() → _ods_ir¶

names() → _ods_ir¶

variadicity() → _ods_ir¶

mlir.dialects._irdl_ops_gen.operands_(args, names, variadicity, *, loc=None, ip=None) → OperandsOp¶

class mlir.dialects._irdl_ops_gen.OperationOp(sym_name, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.operation defines a new operation belonging to the irdl.dialect parent.

Operations can define constraints on their operands and results with the irdl.results and irdl.operands operations. If these operations are not present in the region, the results or operands are expected to be empty.

Example:

irdl.dialect @cmath {

  irdl.type @complex { /* ... */ }

  irdl.operation @norm {
    %0 = irdl.any
    %1 = irdl.parametric @cmath::@complex<%0>
    irdl.results(%0)
    irdl.operands(%1)
  }
}

The above program defines an operation norm inside the dialect cmath. The operation expects a single operand of base type cmath.complex, and returns a single result of the element type of the operand.

OPERATION_NAME = 'irdl.operation'¶

_ODS_REGIONS = (1, True)¶

sym_name() → _ods_ir¶

body() → _ods_ir¶

mlir.dialects._irdl_ops_gen.operation_(sym_name, *, loc=None, ip=None) → OperationOp¶

class mlir.dialects._irdl_ops_gen.ParametersOp(args, names, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.parameters defines the constraints on parameters of a type or attribute definition. Each parameter is named after an identifier.

Example:

irdl.dialect @cmath {
  irdl.type @complex {
    %0 = irdl.is i32
    %1 = irdl.is i64
    %2 = irdl.any_of(%0, %1)
    irdl.parameters(elem: %2)
  }
}

The above program defines a type complex inside the dialect cmath. The type has a single parameter elem that should be either i32 or i64.

OPERATION_NAME = 'irdl.parameters'¶

_ODS_REGIONS = (0, True)¶

args() → _ods_ir¶

names() → _ods_ir¶

mlir.dialects._irdl_ops_gen.parameters(args, names, *, loc=None, ip=None) → ParametersOp¶

class mlir.dialects._irdl_ops_gen.ParametricOp(base_type, args, *, results=None, loc=None, ip=None)¶

Bases: _ods_ir

irdl.parametric defines a constraint that accepts only a single type or attribute base. The attribute base is defined by a symbolic reference to the corresponding definition. It will additionally constraint the parameters of the type/attribute.

Example:

irdl.dialect @cmath {

  irdl.type @complex { /* ... */ }

  irdl.operation @norm {
    %0 = irdl.any
    %1 = irdl.parametric @cmath::@complex<%0>
    irdl.operands(%1)
    irdl.results(%0)
  }
}

The above program defines an operation norm inside the dialect cmath that for any T takes a cmath.complex with parameter T and returns a T.

OPERATION_NAME = 'irdl.parametric'¶

_ODS_REGIONS = (0, True)¶

args() → _ods_ir¶

base_type() → _ods_ir¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.parametric(base_type, args, *, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.RegionOp(entryBlockArgs, *, numberOfBlocks=None, constrainedArguments=None, results=None, loc=None, ip=None)¶

Bases: _ods_ir

The irdl.region construct defines a set of characteristics that a region of an operation should satify. Each region is named after an identifier.

These characteristics include constraints for the entry block arguments of the region and the total number of blocks it contains. The number of blocks must be a non-zero and non-negative integer, and it is optional by default. The set of constraints for the entry block arguments may be optional or empty. If no parentheses are provided, the set is assumed to be optional, and the arguments are not constrained in any way. If parentheses are provided with no arguments, it means that the region must have no entry block arguments

Example:

irdl.dialect @example {
  irdl.operation @op_with_regions {
      %r0 = irdl.region
      %r1 = irdl.region()
      %v0 = irdl.is i32
      %v1 = irdl.is i64
      %r2 = irdl.region(%v0, %v1)
      %r3 = irdl.region with size 3

      irdl.regions(foo: %r0, bar: %r1, baz: %r2, qux: %r3)
  }
}

The above snippet demonstrates an operation named @op_with_regions, which is constrained to have four regions.

Region foo doesn’t have any constraints on the arguments

or the number of blocks. * Region bar should have an empty set of arguments. * Region baz should have two arguments of types i32 and i64. * Region qux should contain exactly three blocks.

OPERATION_NAME = 'irdl.region'¶

_ODS_REGIONS = (0, True)¶

entryBlockArgs() → _ods_ir¶

numberOfBlocks() → _ods_ir | None¶

constrainedArguments() → bool¶

output() → _ods_ir¶

mlir.dialects._irdl_ops_gen.region(entry_block_args, *, number_of_blocks=None, constrained_arguments=None, results=None, loc=None, ip=None) → _ods_ir¶

class mlir.dialects._irdl_ops_gen.RegionsOp(args, names, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.regions defines the regions of an operation by accepting values produced by irdl.region operation as arguments. Each region has an identifier as name.

Example:

irdl.dialect @example {
  irdl.operation @op_with_regions {
    %r1 = irdl.region with size 3
    %0 = irdl.any
    %r2 = irdl.region(%0)
    irdl.regions(foo: %r1, bar: %r2)
  }
}

In the snippet above the operation is constrained to have two regions. The first region (foo) should contain three blocks. The second region (bar) should have one region with one argument.

OPERATION_NAME = 'irdl.regions'¶

_ODS_REGIONS = (0, True)¶

args() → _ods_ir¶

names() → _ods_ir¶

mlir.dialects._irdl_ops_gen.regions_(args, names, *, loc=None, ip=None) → RegionsOp¶

class mlir.dialects._irdl_ops_gen.ResultsOp(args, names, variadicity, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.results define the results of the irdl.operation parent operation definition. Each result is named after an identifier.

In the following example, irdl.results defines the results of the get_values operation:

irdl.dialect @cmath {

  irdl.type @complex { /* ... */ }

  /// Returns the real and imaginary parts of a complex number.
  irdl.operation @get_values {
    %0 = irdl.any
    %1 = irdl.parametric @cmath::@complex<%0>
    irdl.results(re: %0, im: %0)
    irdl.operands(complex: %1)
  }
}

The operation will expect one operand of the cmath.complex type, and two results that have the underlying type of the cmath.complex.

The results can also be marked as variadic or optional:

irdl.results(foo: %0, bar: single %1, baz: optional %2, qux: variadic %3)

Here, foo and bar are required single results, baz is an optional result, and qux is a variadic result.

When more than one result is marked as optional or variadic, the operation will expect a ‘resultSegmentSizes’ attribute that defines the number of results in each segment.

OPERATION_NAME = 'irdl.results'¶

_ODS_REGIONS = (0, True)¶

args() → _ods_ir¶

names() → _ods_ir¶

variadicity() → _ods_ir¶

mlir.dialects._irdl_ops_gen.results_(args, names, variadicity, *, loc=None, ip=None) → ResultsOp¶

class mlir.dialects._irdl_ops_gen.TypeOp(sym_name, *, loc=None, ip=None)¶

Bases: _ods_ir

irdl.type defines a new type belonging to the irdl.dialect parent.

The type parameters can be defined with an irdl.parameters operation in the optional region.

Example:

irdl.dialect @cmath {
  irdl.type @complex {
    %0 = irdl.is i32
    %1 = irdl.is i64
    %2 = irdl.any_of(%0, %1)
    irdl.parameters(%2)
  }
}

The above program defines a type complex inside the dialect cmath. The type has a single parameter that should be either i32 or i64.

OPERATION_NAME = 'irdl.type'¶

_ODS_REGIONS = (1, True)¶

sym_name() → _ods_ir¶

body() → _ods_ir¶

mlir.dialects._irdl_ops_gen.type_(sym_name, *, loc=None, ip=None) → TypeOp¶