'msft' Dialect

Microsoft internal support dialect Umbrella dialect for everything needed to support Microsoft development but not thoroughly discussed. Most (if not everything) in this dialect is a candidate for generalization and re-homing.

Operation definition ¶

msft.constructs.channel (::circt::msft::ChannelOp) ¶

A pipeline-able connection

Syntax:

operation ::= `msft.constructs.channel` $input $clk $sym_name `(` $defaultStages `)` attr-dict `:` type($input)

A logical, feed-forward connection between a producer and consumer. Can be pipelined with a number of stages (cycle delay) on a per-instance basis. defaultStages is used when stages isn’t specified by a DynamicInstance. Non-resettable, for now.

Per-instance specification is not yet supported, so the default pipelining is always used.

Traits: AlwaysSpeculatableImplTrait

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

Effects: MemoryEffects::Effect{}

Attributes: ¶

Operands: ¶

Results: ¶

msft.hlc.linear (::circt::msft::LinearOp) ¶

Model of a linear datapath which can be arbitrarily pipelined

Syntax:

operation ::= `msft.hlc.linear` `clock` $clock attr-dict `:` type($outs) $datapath

Defines a feed-forward datapath which can be scheduled into a pipeline. Due to the feed-forwardness, the inner region is NOT a graph region. Internally, only combinational operations (comb, msft, hw) are allowed.

Example:

msft.module @foo(%in0 : i32, %in1 : i32, %in2 : i32, %clk : i1) -> (out: i32) -> {
  %0 = msft.hlc.linear(%a = %in0, %b = %in1, %c = %in2) clock %clk (i32, i32, i32) -> (i32) {
    %0 = comb.mul %a, %b : i32
    %1 = comb.add %0, %c : i32
    msft.output %1 : i32
  }
}

Traits: SingleBlock, SingleBlockImplicitTerminator

Operands: ¶

Results: ¶

msft.instance.dynamic (::circt::msft::DynamicInstanceOp) ¶

A module instance in the instance hierarchy

Syntax:

operation ::= `msft.instance.dynamic` custom<ImplicitInnerRef>($instanceRef) $body attr-dict

Represents an instance (as in instance in the instance hierarchy) referred to henceforth as a dynamic instance. Specified with a path through the instance hierarchy (which in the future will be replaced with an AppID). Lowers to a hw.hierpath but unlike a global ref, does not require all of the ops participating in the hierpath to contain a back pointer attribute. Allows users to efficiently add placements to a large number of dynamic instances which happen to map to a small number of static instances by bulk-adding the necessary hw.hierpath attributes.

During the lowering, moves the operations in the body to the top level and gives them the symbol of the hierpath which was created to replace the dynamic instance.

Traits: HasParent<circt::msft::InstanceHierarchyOp, circt::msft::DynamicInstanceOp>, NoTerminator

Attributes: ¶

msft.instance.hierarchy (::circt::msft::InstanceHierarchyOp) ¶

The root of an instance hierarchy

Syntax:

operation ::= `msft.instance.hierarchy` $topModuleRef ($instName^)? $body attr-dict

Models the “root” / “top” of an instance hierarchy. DynamicInstanceOps must be contained by this op. Specifies the top module and (optionally) an “instance” name in the case where there are multiple instances of a particular module in a design. (As is often the case where one isn’t producing the design’s “top” module but a subdesign.)

Traits: HasParent mlir::ModuleOp, NoTerminator

Attributes: ¶

msft.instance.verb_attr (::circt::msft::DynamicInstanceVerbatimAttrOp) ¶

Specify an arbitrary attribute attached to a dynamic instance

Syntax:

operation ::= `msft.instance.verb_attr` ($ref^)? `name` `:` $name `value` `:` $value (`path` `:` $subPath^)? attr-dict

Allows a user to specify a custom attribute name and value which is attached to a dynamic instance.

For Quartus tcl, translates to: set_instance_assignment -name $name $value -to $parent|<instance_path>

Interfaces: DynInstDataOpInterface

Attributes: ¶

msft.output (::circt::msft::OutputOp) ¶

Termination operation

Syntax:

operation ::= `msft.output` attr-dict ($operands^ `:` qualified(type($operands)))?

Traits: AlwaysSpeculatableImplTrait, ReturnLike, Terminator

Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), RegionBranchTerminatorOpInterface

Effects: MemoryEffects::Effect{}

Operands: ¶

msft.pd.location (::circt::msft::PDPhysLocationOp) ¶

Specify a location for an instance

Syntax:

operation ::= `msft.pd.location` ($ref^)? custom<PhysLoc>($loc) (`path` `:` $subPath^)? attr-dict

Used to specify a specific location on an FPGA to place a dynamic instance. Supports specifying the location of a subpath for extern modules and device primitives. Intended to live as a child of instance.dynamic initially without the ref field. The dynamic instance lowering will fill in ref with the symol of the hw.hierpath op corresponding to the lowered dynamic instance.

Interfaces: DynInstDataOpInterface

Attributes: ¶

msft.pd.physregion (::circt::msft::PDPhysRegionOp) ¶

Specify a physical region for an instance

Syntax:

operation ::= `msft.pd.physregion` ($ref^)? $physRegionRef (`path` `:` $subPath^)? attr-dict

Annotate a particular entity within an op with the region of the devices on an FPGA to which it should mapped. The physRegionRef must refer to a DeclPhysicalRegion operation.

Interfaces: DynInstDataOpInterface

Attributes: ¶

msft.pd.reg_location (::circt::msft::PDRegPhysLocationOp) ¶

Specify register locations

Syntax:

operation ::= `msft.pd.reg_location` (`ref` $ref^)? custom<ListOptionalRegLocList>($locs) attr-dict

A version of “PDPhysLocationOp” specialized for registers, which have one location per bit.

Interfaces: DynInstDataOpInterface

Attributes: ¶

msft.pe.output (::circt::msft::PEOutputOp) ¶

Set the outputs from a PE block

Syntax:

operation ::= `msft.pe.output` $output attr-dict `:` type($output)

Traits: Terminator

Operands: ¶

msft.physical_region (::circt::msft::DeclPhysicalRegionOp) ¶

Syntax:

operation ::= `msft.physical_region` $sym_name `,` $bounds attr-dict

Traits: HasParent mlir::ModuleOp

Interfaces: Symbol

Attributes: ¶

msft.systolic.array (::circt::msft::SystolicArrayOp) ¶

Model of a row/column broadcast systolic array

Note: the PE region is NOT a graph region. This was intentional since systolic arrays are entirely feed-forward.

Traits: SingleBlock, SingleBlockImplicitTerminator

Operands: ¶

Results: ¶

Attribute definition ¶

LocationVectorAttr ¶

Vector of optional locations corresponding to bits in a type

Parameters: ¶

PhysLocationAttr ¶

Descibes a physical location on a device

Annotate a particular entity within an op with the location of the device on an FPGA to which it should mapped. The coordinates in this attribute are absolute locations on the device, so if there are two instances of a module with this annotation incorrect results will be generated. How to solve this is a more general, open problem.

Parameters: ¶

PhysicalBoundsAttr ¶

Describes a rectangle bounding a physical region on a device

Describes a rectangular bound within a device. The lower and upper bounds must be specified for both the X and Y axis. The bounds are inclusive.

Parameters: ¶