Generated with

scair.clair

Clair is a Scala library for creating custom IRs. It provides the end-user with a way to define custom IRs packaged in a Dialect (MLIR word for DSL) using Scala syntax and then generate the IR code in a target language (currently limited to Scala).

To define a custom Dialect, the user needs to define an IR and package it into a Dialect object as shown in the code below with the Sample dialect example:

import scair.ir.*
import scair.clair.macros.*
import scair.dialects.builtin.*
import scair.dialects.cmath.*
import scair.enums.I32Enum
import fastparse.*
import scair.parse.*

/*≡≡=---=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=---=≡≡*\
||   defining a custom I32 enum attribute   ||
\*≡==----=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=----==≡*/

enum Color(name: String) extends I32Enum(name):
 case Red extends Color("red")
 case Green extends Color("green")
 case Blue extends Color("blue")

case class EnumOperation(
   val color: Color
) extends DerivedOperation["arith.enum_op"] derives OpDefs

/*≡≡=---=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=---=≡≡*\
||   defining a custom data attribute   ||
\*≡==----=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=----==≡*/

given AttributeCompanion[SampleData]:
 override def name: String = "sample"

 override def parse[$: P](using Parser) =
   "#sample<" ~ CharsWhile(_ != '>').!.map(SampleData.apply) ~ ">"

case class SampleData(val d: String)
   extends DataAttribute[String]("sample", d)

/*≡≡=---=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=---=≡≡*\
||   defining a custom attribute   ||
\*≡==----=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=----==≡*/

case class SampleAttr(
   val value: FloatType
) extends DerivedAttribute["sample.sample_attr"] derives AttrDefs

/*≡≡=---=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=---=≡≡*\
||   defining a custom type attribute   ||
\*≡==----=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=----==≡*/

case class SampleType(
   val value: FloatType
) extends DerivedAttribute["sample.sample_type"]
   with TypeAttribute derives AttrDefs

/*≡≡=---=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=---=≡≡*\
||   defining custom operations   ||
\*≡==----=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=----==≡*/

case class SampOp1(
   e1: Seq[Operand[IntegerAttr]],
   e2: Result[Attribute],
   e3: Region,
) extends DerivedOperation["sample.sampop1"] derives OpDefs

case class SampOp2(
   e1: Seq[Operand[Complex]],
   e2: Result[Attribute],
) extends DerivedOperation["sample.sampop2"] derives OpDefs

/*≡≡=---=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=---=≡≡*\
||   constraints over operation components   ||
\*≡==----=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=----==≡*/

import scair.constraints.{*, given}

type T = Var["T"]
val i32 = IntegerType(IntData(32), Signless)

case class MulIEq(
   lhs: Operand[IntegerType !> EqAttr[i32.type]],
   rhs: Operand[IntegerType !> EqAttr[i32.type]],
   result: Result[IntegerType],
) extends DerivedOperation["samplecnstr.mulieq"] derives OpDefs

case class MulIVar(
   lhs: Operand[IntegerType !> T],
   rhs: Operand[IntegerType !> T],
   result: Result[IntegerType],
) extends DerivedOperation["samplecnstr.mulivar"] derives OpDefs

/*≡≡=---=≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡=---=≡≡*\
||   packaging into a dialect   ||
\*≡==----=≡≡≡≡≡≡≡≡≡≡≡≡≡≡=----==≡*/

val Sample =
 summonDialect[(SampleAttr, SampleType, SampleData), (SampOp1, SampOp1)]

To include the defined Dialect in ScaIR, the user should put the file into the dialects directory in the scair project, and package it appropriately.

Attributes

See also: scair.dialects.cmathgen

Members list

Packages

This package contains the mirrored logic for the front-end of the Clair library.

Attributes

Type members

Classlikes

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: class Yield

class Constant

class Constant

class Return

class Load

class Poison

class Dealloc

class ReduceOp

class ReduceReturnOp

class YieldOp
Show all

Attributes

Companion: object
Supertypes: trait AttributeCompanion[T]

class Object

trait Matchable

class Any

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: AttrDefs.type

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object given_AttributeCustomParser_ComplexAttr

Attributes

Supertypes: trait ParametrizedAttribute

trait Attribute

class Object

trait Matchable

class Any
Known subtypes: class ComplexType

class DenseIntOrFPElementsAttr

class Float128Type

class Float16Type

class Float32Type

class Float64Type

class Float80Type

class FloatAttr

class IndexType

class IntegerAttr

class IntegerType

class UnrankedMemrefType

class UnrankedTensorType

class VectorType

class Complex

class ComplexAttr

class AttributeType

class RegionType

class Ptr
Show all

Attributes

Supertypes: trait Operation

trait IntrusiveNode[Operation]

trait IRNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Apply

class For

class If

class Load

class Min

class Parallel

class Store

class Yield

class AddF

class AddI

class AddUIExtendedOp

class AndI

class BitCast

class CeilDivSi

class CeilDivUi

class CmpF

class CmpI

class Constant

class DivF

class DivSI

class DivUI

class ExtF

class ExtSI

class ExtUI

class FPToSI

class FPToUI

class FloorDivSI

class IndexCast

class IndexCastUI

class MaxNumF

class MaxSI

class MaxUI

class MaximumF

class MinNumF

class MinSI

class MinUI

class MinimumF

class MulF

class MulI

class MulSIExtended

class MulUIExtended

class NegF

class OrI

class RemF

class RemSI

class RemUI

class SIToFP

class ScalingExtF

class ScalingTruncF

class SelectOp

class ShLI

class ShRSI

class ShRUI

class SubF

class SubI

class TruncF

class TruncI

class UIToFP

class XOrI

class ModuleOp

class UnrealizedConversionCastOp

class Mul

class Norm

class Abs

class Add

class Constant

class Create

class Div

class Im

class Mul

class Neg

class Re

class Sub

class Call

class CallIndirect

class Constant

class Func

class Return

class Any

class Attribute

class Attributes

class Dialect

class Operands

class Operation

class Parameters

class Results

class Type

class AggrFn

class Aggregation

class BaseTable

class CountRows

class CrossProduct

class DBAdd

class DBAnd

class DBCast

class DBCompare

class DBConstant

class DBDiv

class DBMul

class DBNot

class DBOr

class DBSub

class GetCol

class InnerJoin

class Limit

class MapOp

class Materialize

class Projection

class QueryReturn

class RelAlgQuery

class Selection

class SetResult

class Sort

class TuplesReturn

class AShr

class Add

class Alloca

class And

class Br

class Call

class CallIndirect

class CondBr

class Constant

class ExtractValue

class FAdd

class FCmp

class FDiv

class FMul

class FNeg

class FPExt

class FPToSI

class FPTrunc

class FRem

class FSub

class Func

class GetElementPtr

class ICmp

class InsertValue

class IntToPtr

class LShr

class Load

class Mul

class Or

class Poison

class PtrToInt

class Return

class SDiv

class SExt

class SIToFP

class SRem

class Select

class Shl

class Store

class Sub

class Trunc

class Unreachable

class XOr

class ZExt

class Zero

class AbsfOp

class FPowIOp

class Alloc

class Dealloc

class Dim

class Load

class Store

class Condition

class ExecuteRegionOp

class ForOp

class ForallOp

class IfOp

class InParallelOp

class IndexSwitchOp

class ParallelOp

class ReduceOp

class ReduceReturnOp

class WhileOp

class YieldOp
Show all

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: OpDefs.type

Attributes

Companion: object
Supertypes: trait OperationCompanion[T]

class Object

trait Matchable

class Any
Self type: OpDefs[T]

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: object given_OperationCustomParser_ModuleOp

object given_OperationCustomParser_Func

object given_OperationCustomParser_Func

object given_OperationCustomParser_ICmp

object given_OperationCustomParser_AbsfOp

object given_OperationCustomParser_FPowIOp
Show all

Value members

Concrete methods

In this article

Generated with