'om' Dialect

The Object Model dialect captures design intent from various domains in an object model.

For more information about the Object Model dialect, see the Object Model Dialect Rationale.

Operations

om.any_cast (::circt::om::AnyCastOp)

Cast any value to any type.

Syntax:

operation ::= `om.any_cast` $input attr-dict `:` functional-type($input, $result)

Casts any value to AnyType. This is useful for situations where a value of AnyType is needed, but a value of some concrete type is known.

In the evaluator, this is a noop, and the value of concrete type is used.

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.basepath_create (::circt::om::BasePathCreateOp)

Produce a base path value

Syntax:

operation ::= `om.basepath_create` $basePath $target attr-dict

Produces a value which represents a fragment of a hierarchical path to a target. Given a base path, extend it with the name of a module instance, to produce a new base path. The instance is identified via an NLA. Once the final verilog name of the instance is known, this op can be converted into a FrozenBasePathOp.

Example:

hw.module @Foo() -> () {
  hw.inst "bar" sym @bar @Bar() -> ()
}
hw.hierpath @Path [@Foo::@bar]
om.class @OM(%basepath: !om.basepath) {
  %0 = om.basepath_create %base @Path
}

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SymbolUserOpInterface

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

om.class (::circt::om::ClassOp)

Traits: IsolatedFromAbove, SingleBlockImplicitTerminator<ClassFieldsOp>, SingleBlock

Interfaces: ClassLike, OpAsmOpInterface, RegionKindInterface, Symbol

Attributes:

om.class.extern (::circt::om::ClassExternOp)

Traits: IsolatedFromAbove, NoTerminator

Interfaces: ClassLike, OpAsmOpInterface, RegionKindInterface, Symbol

Attributes:

om.class.fields (::circt::om::ClassFieldsOp)

Syntax:

operation ::= `om.class.fields` attr-dict ($fields^ `:` qualified(type($fields)))?

Traits: AlwaysSpeculatableImplTrait, HasParent<ClassOp>, ReturnLike, Terminator

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), RegionBranchTerminatorOpInterface

Effects: MemoryEffects::Effect{}

Operands:

om.constant (::circt::om::ConstantOp)

Syntax:

operation ::= `om.constant` $value attr-dict

Traits: AlwaysSpeculatableImplTrait, ConstantLike

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Results:

om.frozenbasepath_create (::circt::om::FrozenBasePathCreateOp)

Produce a frozen base path value

Syntax:

operation ::= `om.frozenbasepath_create` $basePath custom<BasePathString>($path) attr-dict

Produces a value which represents a fragment of a hierarchical path to a target.

Example:

om.class @OM(%basepath: !om.basepath)
  %0 = om.frozenbasepath_create %basepath "Foo/bar:Bar/baz"
}

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

om.frozenpath_create (::circt::om::FrozenPathCreateOp)

Produce a frozen path value

Syntax:

operation ::= `om.frozenpath_create` $targetKind $basePath custom<PathString>($path, $module, $ref, $field)
              attr-dict

Produces a value which represents a hierarchical path to a hardware component from a base path to a target.

Example:

om.class @OM(%basepath: !om.basepath)
  %0 = om.frozenpath_create reference %base "Foo/bar:Bar>w.a"
}

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

om.frozenpath_empty (::circt::om::FrozenEmptyPathOp)

Produce a frozen path value to nothing

Syntax:

operation ::= `om.frozenpath_empty` attr-dict

Produces a value which represents a hierarchical path to nothing.

Example:

om.class @OM()
  %0 = om.frozenpath_empty
}

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Results:

om.integer.add (::circt::om::IntegerAddOp)

Add two OMIntegerType values

Syntax:

operation ::= `om.integer.add` $lhs `,` $rhs attr-dict `:` type($result)

Perform arbitrary precision signed integer addition of two OMIntegerType values.

Example:

%2 = om.integer.add %0, %1 : !om.integer

Traits: AlwaysSpeculatableImplTrait, Commutative

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, IntegerBinaryArithmeticOp, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.integer.mul (::circt::om::IntegerMulOp)

Multiply two OMIntegerType values

Syntax:

operation ::= `om.integer.mul` $lhs `,` $rhs attr-dict `:` type($result)

Perform arbitrary prevision signed integer multiplication of two OMIntegerType values.

Example:

%2 = om.integer.mul %0, %1 : !om.integer

Traits: AlwaysSpeculatableImplTrait, Commutative

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, IntegerBinaryArithmeticOp, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.integer.shl (::circt::om::IntegerShlOp)

Shift an OMIntegerType value left by an OMIntegerType value

Syntax:

operation ::= `om.integer.shl` $lhs `,` $rhs attr-dict `:` type($result)

Perform arbitrary precision signed integer arithmetic shift left of the lhs OMIntegerType value by the rhs OMIntegerType value. The rhs value must be non-negative.

Example:

%2 = om.integer.shl %0, %1 : !om.integer

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, IntegerBinaryArithmeticOp, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.integer.shr (::circt::om::IntegerShrOp)

Shift an OMIntegerType value right by an OMIntegerType value

Syntax:

operation ::= `om.integer.shr` $lhs `,` $rhs attr-dict `:` type($result)

Perform arbitrary precision signed integer arithmetic shift right of the lhs OMIntegerType value by the rhs OMIntegerType value. The rhs value must be non-negative.

Example:

%2 = om.integer.shr %0, %1 : !om.integer

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, IntegerBinaryArithmeticOp, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.list_concat (::circt::om::ListConcatOp)

Concatenate multiple lists to produce a new list

Syntax:

operation ::= `om.list_concat` $subLists attr-dict `:` type($result)

Produces a value of list type by concatenating the provided lists.

Example:

%3 = om.list_concat %0, %1, %2 : !om.list<string>

Traits: AlwaysSpeculatableImplTrait, SameOperandsAndResultType

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.list_create (::circt::om::ListCreateOp)

Create a list of values

Creates a list from a sequence of inputs.

%list = om.list_create %a, %b, %c : !om.ref

Traits: AlwaysSpeculatableImplTrait, SameTypeOperands

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.map_create (::circt::om::MapCreateOp)

Create a map

Creates a map from a sequence of inputs.

%map = om.map_create %e1, %e2 : !om.string, i8

where %e1 and e2 have !om.tuple<!om.string, i8> and %map has !om.map<!om.string, i8> type.

Traits: AlwaysSpeculatableImplTrait, SameTypeOperands

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.object (::circt::om::ObjectOp)

Syntax:

operation ::= `om.object` $className `(` $actualParams `)`  attr-dict `:`
              functional-type($actualParams, $result)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), SymbolUserOpInterface

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

om.object.field (::circt::om::ObjectFieldOp)

Syntax:

operation ::= `om.object.field` $object `,` $fieldPath attr-dict `:` functional-type($object, $result)

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

om.path_create (::circt::om::PathCreateOp)

Produce a path value

Syntax:

operation ::= `om.path_create` $targetKind $basePath $target attr-dict

Produces a value which represents a hierarchical path to a hardware target. from a base path to a target.

Example:

hw.module @Foo() -> () {
  %wire = hw.wire sym @w: !i1
}
hw.hierpath @Path [@Foo::@w]
om.class @OM(%basepath: !om.basepath)
  %0 = om.path_create reference %basepath @Path
}

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface), SymbolUserOpInterface

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

om.path_empty (::circt::om::EmptyPathOp)

Produce a path value to nothing

Syntax:

operation ::= `om.path_empty` attr-dict

Produces a value which represents a hierarchical path to nothing.

Example:

om.class @OM()
  %0 = om.path_empty
}

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Results:

om.tuple_create (::circt::om::TupleCreateOp)

Create a tuple of values

Syntax:

operation ::= `om.tuple_create` $inputs attr-dict `:` type($inputs)

Create a tuple from a sequence of inputs.

%tuple = om.tuple_create %a, %b, %c : !om.ref, !om.string, !om.list<i32>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Operands:

Results:

om.tuple_get (::circt::om::TupleGetOp)

Extract a value from a tuple

Syntax:

operation ::= `om.tuple_get` $input `[` $index `]` attr-dict `:` type($input)

Extract a value from a tuple.

%value = om.tuple_get %a[0] : tuple<!om.ref, !om.string, !om.list<i32>>

Traits: AlwaysSpeculatableImplTrait

Interfaces: ConditionallySpeculatable, InferTypeOpInterface, NoMemoryEffect (MemoryEffectOpInterface)

Effects: MemoryEffects::Effect{}

Attributes:

Operands:

Results:

Attributes

MapAttr

An attribute that represents a string map

Syntax:

#om.map<
  mlir::Type,   # valueType
  mlir::DictionaryAttr   # elements
>

Parameters:

IntegerAttr

An attribute that represents an arbitrary integer

Syntax:

#om.integer<
  mlir::IntegerAttr   # value
>

Parameters:

ListAttr

An attribute that represents a list

Syntax:

#om.list<
  mlir::Type,   # elementType
  mlir::ArrayAttr   # elements
>

Parameters:

PathAttr

An attribute that represents an instance path

Parameters:

SymbolRefAttr

An attribute that wraps a FlatSymbolRefAttr type

Syntax:

#om.sym_ref<
  mlir::FlatSymbolRefAttr   # ref
>

Parameters:

ReferenceAttr

An attribute that wraps a #hw.innerNameRef with !om.ref type

Syntax:

#om.ref<
  circt::hw::InnerRefAttr   # innerRef
>

Parameters:

Types

BasePathType

A fragment of a path to a hardware component

Syntax: !om.basepath

ClassType

A type that represents a reference to a Class.

Syntax:

!om.class.type<
  mlir::FlatSymbolRefAttr   # className
>

Parameters:

FrozenBasePathType

A frozen fragment of a path to a hardware component

Syntax: !om.frozenbasepath

FrozenPathType

A frozen path to a hardware component

Syntax: !om.frozenpath

ListType

A type that represents a list.

Syntax:

!om.list<
  mlir::Type   # elementType
>

Parameters:

MapType

A type that represents a map. A key type must be either an integer or string type

Syntax:

!om.map<
  mlir::Type,   # keyType
  mlir::Type   # valueType
>

Parameters:

AnyType

A type that represents any valid OM type.

Syntax: !om.any

OMIntegerType

A type that represents an arbitrary width integer.

Syntax: !om.integer

PathType

A path to a hardware component

Syntax: !om.path

ReferenceType

A type that represents a reference to a hardware entity.

Syntax: !om.ref

StringType

A type that represents a string.

Syntax: !om.string

SymbolRefType

A type that represents a reference to a flat symbol reference.

Syntax: !om.sym_ref

Enums

TargetKind

Object model target kind

Cases:

'om' Dialect Docs

• Object Model Dialect Rationale