Skip to content

Comb

comb

The comb dialect provides a collection of operations that define a mid-level compiler IR for combinational logic. It is designed to be easy to analyze and transform, and be a flexible and extensible substrate that may be extended with higher level dialects mixed into it.

Up to date as of CIRCT commit 2e23cda6c2cbedb118b92fab755f1e36d80b13f5.

See external documentation.

ICMP_COMPARISON_OPERATIONS = ['eq', 'ne', 'slt', 'sle', 'sgt', 'sge', 'ult', 'ule', 'ugt', 'uge'] module-attribute

Comb = Dialect('comb', [AddOp, MulOp, DivUOp, DivSOp, ModUOp, ModSOp, ShlOp, ShrUOp, ShrSOp, SubOp, AndOp, OrOp, XorOp, ICmpOp, ParityOp, ExtractOp, ConcatOp, ReplicateOp, MuxOp]) module-attribute

TwoStateOperation

Bases: IRDLOperation, ABC

"All operations are defined in the expected way for 2-state (binary) logic. However, comb is used for operations which have extended truth table for non-2-state logic for various target languages. The two_state variable describes if we are using 2-state (binary) logic or not."

Source code in xdsl/dialects/comb.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
class TwoStateOperation(IRDLOperation, ABC):
    """
    "All operations are defined in the expected way for 2-state (binary) logic. However, comb is
    used for operations which have extended truth table for non-2-state logic for various target
    languages. The two_state variable describes if we are using 2-state (binary) logic or not."
    """

    two_state = opt_prop_def(UnitAttr, prop_name="twoState")

    def __init__(
        self: TwoStateOperation,
        *,
        operands: (
            Sequence[SSAValue | Operation | Sequence[SSAValue | Operation] | None]
            | None
        ) = None,
        result_types: Sequence[Attribute | Sequence[Attribute] | None] | None = None,
        attributes: Mapping[str, Attribute | None] | None = None,
        properties: Mapping[str, Attribute | None] | None = None,
        has_two_state_semantics: bool = False,
    ):
        local_properties = dict(properties) if properties is not None else {}
        if has_two_state_semantics:
            local_properties.update({"twoState": UnitAttr()})
        super().__init__(
            operands=operands,
            result_types=result_types,
            attributes=attributes,
            properties=local_properties,
        )

    def print_optional_two_state_keyword(self, printer: Printer):
        if self.two_state is not None:
            printer.print_string(" bin")

    @classmethod
    def parse_optional_two_state_keyword(cls, parser: Parser) -> bool:
        return parser.parse_optional_keyword("bin") is not None

two_state = opt_prop_def(UnitAttr, prop_name='twoState') class-attribute instance-attribute

__init__(*, operands: Sequence[SSAValue | Operation | Sequence[SSAValue | Operation] | None] | None = None, result_types: Sequence[Attribute | Sequence[Attribute] | None] | None = None, attributes: Mapping[str, Attribute | None] | None = None, properties: Mapping[str, Attribute | None] | None = None, has_two_state_semantics: bool = False)

Source code in xdsl/dialects/comb.py 
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
def __init__(
    self: TwoStateOperation,
    *,
    operands: (
        Sequence[SSAValue | Operation | Sequence[SSAValue | Operation] | None]
        | None
    ) = None,
    result_types: Sequence[Attribute | Sequence[Attribute] | None] | None = None,
    attributes: Mapping[str, Attribute | None] | None = None,
    properties: Mapping[str, Attribute | None] | None = None,
    has_two_state_semantics: bool = False,
):
    local_properties = dict(properties) if properties is not None else {}
    if has_two_state_semantics:
        local_properties.update({"twoState": UnitAttr()})
    super().__init__(
        operands=operands,
        result_types=result_types,
        attributes=attributes,
        properties=local_properties,
    )

print_optional_two_state_keyword(printer: Printer)

Source code in xdsl/dialects/comb.py 
87
88
89
def print_optional_two_state_keyword(self, printer: Printer):
    if self.two_state is not None:
        printer.print_string(" bin")

parse_optional_two_state_keyword(parser: Parser) -> bool classmethod

Source code in xdsl/dialects/comb.py 
91
92
93
@classmethod
def parse_optional_two_state_keyword(cls, parser: Parser) -> bool:
    return parser.parse_optional_keyword("bin") is not None

BinCombOperation

Bases: TwoStateOperation, ABC

A binary comb operation. It has two operands and one result, all of the same integer type.

Source code in xdsl/dialects/comb.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
class BinCombOperation(TwoStateOperation, ABC):
    """
    A binary comb operation. It has two operands and one
    result, all of the same integer type.
    """

    T: ClassVar = VarConstraint("T", base(IntegerType))

    lhs = operand_def(T)
    rhs = operand_def(T)
    result = result_def(T)

    def __init__(
        self,
        operand1: Operation | SSAValue,
        operand2: Operation | SSAValue,
        result_type: Attribute | None = None,
        has_two_state_semantics: bool = False,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        if result_type is None:
            result_type = SSAValue.get(operand1).type
        super().__init__(
            operands=[operand1, operand2],
            result_types=[result_type],
            has_two_state_semantics=has_two_state_semantics,
            attributes=attr_dict,
        )

    @classmethod
    def parse(cls, parser: Parser):
        has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
        lhs = parser.parse_unresolved_operand()
        parser.parse_punctuation(",")
        rhs = parser.parse_unresolved_operand()
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        result_type = parser.parse_type()
        (lhs, rhs) = parser.resolve_operands([lhs, rhs], 2 * [result_type], parser.pos)
        return cls(lhs, rhs, result_type, has_two_state_semantics, attr_dict)

    def print(self, printer: Printer):
        self.print_optional_two_state_keyword(printer)
        printer.print_string(" ")
        printer.print_ssa_value(self.lhs)
        printer.print_string(", ")
        printer.print_ssa_value(self.rhs)
        printer.print_op_attributes(self.attributes)
        printer.print_string(" : ")
        printer.print_attribute(self.result.type)

T: ClassVar = VarConstraint('T', base(IntegerType)) class-attribute instance-attribute

lhs = operand_def(T) class-attribute instance-attribute

rhs = operand_def(T) class-attribute instance-attribute

result = result_def(T) class-attribute instance-attribute

__init__(operand1: Operation | SSAValue, operand2: Operation | SSAValue, result_type: Attribute | None = None, has_two_state_semantics: bool = False, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
def __init__(
    self,
    operand1: Operation | SSAValue,
    operand2: Operation | SSAValue,
    result_type: Attribute | None = None,
    has_two_state_semantics: bool = False,
    attr_dict: dict[str, Attribute] | None = None,
):
    if result_type is None:
        result_type = SSAValue.get(operand1).type
    super().__init__(
        operands=[operand1, operand2],
        result_types=[result_type],
        has_two_state_semantics=has_two_state_semantics,
        attributes=attr_dict,
    )

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
125
126
127
128
129
130
131
132
133
134
135
@classmethod
def parse(cls, parser: Parser):
    has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
    lhs = parser.parse_unresolved_operand()
    parser.parse_punctuation(",")
    rhs = parser.parse_unresolved_operand()
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    result_type = parser.parse_type()
    (lhs, rhs) = parser.resolve_operands([lhs, rhs], 2 * [result_type], parser.pos)
    return cls(lhs, rhs, result_type, has_two_state_semantics, attr_dict)

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
137
138
139
140
141
142
143
144
145
def print(self, printer: Printer):
    self.print_optional_two_state_keyword(printer)
    printer.print_string(" ")
    printer.print_ssa_value(self.lhs)
    printer.print_string(", ")
    printer.print_ssa_value(self.rhs)
    printer.print_op_attributes(self.attributes)
    printer.print_string(" : ")
    printer.print_attribute(self.result.type)

VariadicCombOperation

Bases: TwoStateOperation, ABC

A variadic comb operation. It has a variadic number of operands, and a single result, all of the same integer type.

Source code in xdsl/dialects/comb.py 
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
class VariadicCombOperation(TwoStateOperation, ABC):
    """
    A variadic comb operation. It has a variadic number of operands, and a single
    result, all of the same integer type.
    """

    T: ClassVar = VarConstraint("T", base(IntegerType))

    inputs = var_operand_def(T)
    result = result_def(T)

    def __init__(
        self,
        input_list: Sequence[Operation | SSAValue],
        result_type: Attribute | None = None,
        has_two_state_semantics: bool = False,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        if result_type is None:
            if len(input_list) == 0:
                raise ValueError("cannot infer type from zero inputs")
            result_type = SSAValue.get(input_list[0]).type
        super().__init__(
            operands=[input_list],
            result_types=[result_type],
            has_two_state_semantics=has_two_state_semantics,
            attributes=attr_dict,
        )

    def verify_(self) -> None:
        if len(self.inputs) == 0:
            raise VerifyException("op expected 1 or more operands, but found 0")

    @classmethod
    def parse(cls, parser: Parser):
        has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
        inputs = parser.parse_comma_separated_list(
            parser.Delimiter.NONE, parser.parse_unresolved_operand
        )
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        result_type = parser.parse_type()
        inputs = parser.resolve_operands(
            inputs, len(inputs) * [result_type], parser.pos
        )
        return cls(
            input_list=inputs,
            result_type=result_type,
            has_two_state_semantics=has_two_state_semantics,
            attr_dict=attr_dict,
        )

    def print(self, printer: Printer):
        self.print_optional_two_state_keyword(printer)
        printer.print_string(" ")
        printer.print_list(self.inputs, printer.print_ssa_value)
        printer.print_op_attributes(self.attributes)
        printer.print_string(" : ")
        printer.print_attribute(self.result.type)

T: ClassVar = VarConstraint('T', base(IntegerType)) class-attribute instance-attribute

inputs = var_operand_def(T) class-attribute instance-attribute

result = result_def(T) class-attribute instance-attribute

__init__(input_list: Sequence[Operation | SSAValue], result_type: Attribute | None = None, has_two_state_semantics: bool = False, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
def __init__(
    self,
    input_list: Sequence[Operation | SSAValue],
    result_type: Attribute | None = None,
    has_two_state_semantics: bool = False,
    attr_dict: dict[str, Attribute] | None = None,
):
    if result_type is None:
        if len(input_list) == 0:
            raise ValueError("cannot infer type from zero inputs")
        result_type = SSAValue.get(input_list[0]).type
    super().__init__(
        operands=[input_list],
        result_types=[result_type],
        has_two_state_semantics=has_two_state_semantics,
        attributes=attr_dict,
    )

verify_() -> None

Source code in xdsl/dialects/comb.py 
177
178
179
def verify_(self) -> None:
    if len(self.inputs) == 0:
        raise VerifyException("op expected 1 or more operands, but found 0")

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
@classmethod
def parse(cls, parser: Parser):
    has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
    inputs = parser.parse_comma_separated_list(
        parser.Delimiter.NONE, parser.parse_unresolved_operand
    )
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    result_type = parser.parse_type()
    inputs = parser.resolve_operands(
        inputs, len(inputs) * [result_type], parser.pos
    )
    return cls(
        input_list=inputs,
        result_type=result_type,
        has_two_state_semantics=has_two_state_semantics,
        attr_dict=attr_dict,
    )

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
200
201
202
203
204
205
206
def print(self, printer: Printer):
    self.print_optional_two_state_keyword(printer)
    printer.print_string(" ")
    printer.print_list(self.inputs, printer.print_ssa_value)
    printer.print_op_attributes(self.attributes)
    printer.print_string(" : ")
    printer.print_attribute(self.result.type)

AddOp dataclass

Bases: VariadicCombOperation

Addition

Source code in xdsl/dialects/comb.py 
209
210
211
212
213
@irdl_op_definition
class AddOp(VariadicCombOperation):
    """Addition"""

    name = "comb.add"

name = 'comb.add' class-attribute instance-attribute

MulOp dataclass

Bases: VariadicCombOperation

Multiplication

Source code in xdsl/dialects/comb.py 
216
217
218
219
220
@irdl_op_definition
class MulOp(VariadicCombOperation):
    """Multiplication"""

    name = "comb.mul"

name = 'comb.mul' class-attribute instance-attribute

DivUOp dataclass

Bases: BinCombOperation

Unsigned division

Source code in xdsl/dialects/comb.py 
223
224
225
226
227
@irdl_op_definition
class DivUOp(BinCombOperation):
    """Unsigned division"""

    name = "comb.divu"

name = 'comb.divu' class-attribute instance-attribute

DivSOp dataclass

Bases: BinCombOperation

Signed division

Source code in xdsl/dialects/comb.py 
230
231
232
233
234
@irdl_op_definition
class DivSOp(BinCombOperation):
    """Signed division"""

    name = "comb.divs"

name = 'comb.divs' class-attribute instance-attribute

ModUOp dataclass

Bases: BinCombOperation

Unsigned remainder

Source code in xdsl/dialects/comb.py 
237
238
239
240
241
@irdl_op_definition
class ModUOp(BinCombOperation):
    """Unsigned remainder"""

    name = "comb.modu"

name = 'comb.modu' class-attribute instance-attribute

ModSOp dataclass

Bases: BinCombOperation

Signed remainder

Source code in xdsl/dialects/comb.py 
244
245
246
247
248
@irdl_op_definition
class ModSOp(BinCombOperation):
    """Signed remainder"""

    name = "comb.mods"

name = 'comb.mods' class-attribute instance-attribute

ShlOp dataclass

Bases: BinCombOperation

Left shift

Source code in xdsl/dialects/comb.py 
251
252
253
254
255
@irdl_op_definition
class ShlOp(BinCombOperation):
    """Left shift"""

    name = "comb.shl"

name = 'comb.shl' class-attribute instance-attribute

ShrUOp dataclass

Bases: BinCombOperation

Unsigned right shift

Source code in xdsl/dialects/comb.py 
258
259
260
261
262
@irdl_op_definition
class ShrUOp(BinCombOperation):
    """Unsigned right shift"""

    name = "comb.shru"

name = 'comb.shru' class-attribute instance-attribute

ShrSOp dataclass

Bases: BinCombOperation

Signed right shift

Source code in xdsl/dialects/comb.py 
265
266
267
268
269
@irdl_op_definition
class ShrSOp(BinCombOperation):
    """Signed right shift"""

    name = "comb.shrs"

name = 'comb.shrs' class-attribute instance-attribute

SubOp dataclass

Bases: BinCombOperation

Subtraction

Source code in xdsl/dialects/comb.py 
272
273
274
275
276
@irdl_op_definition
class SubOp(BinCombOperation):
    """Subtraction"""

    name = "comb.sub"

name = 'comb.sub' class-attribute instance-attribute

AndOp dataclass

Bases: VariadicCombOperation

Bitwise and

Source code in xdsl/dialects/comb.py 
279
280
281
282
283
@irdl_op_definition
class AndOp(VariadicCombOperation):
    """Bitwise and"""

    name = "comb.and"

name = 'comb.and' class-attribute instance-attribute

OrOp dataclass

Bases: VariadicCombOperation

Bitwise or

Source code in xdsl/dialects/comb.py 
286
287
288
289
290
@irdl_op_definition
class OrOp(VariadicCombOperation):
    """Bitwise or"""

    name = "comb.or"

name = 'comb.or' class-attribute instance-attribute

XorOp dataclass

Bases: VariadicCombOperation

Bitwise xor

Source code in xdsl/dialects/comb.py 
293
294
295
296
297
@irdl_op_definition
class XorOp(VariadicCombOperation):
    """Bitwise xor"""

    name = "comb.xor"

name = 'comb.xor' class-attribute instance-attribute

ICmpOp

Bases: TwoStateOperation, ABC

Integer comparison: A generic comparison operation, operation definitions inherit this class.

The first argument to these comparison operations is the type of comparison being performed, the following comparisons are supported:

  • equal (mnemonic: "eq"; integer value: 0)
  • not equal (mnemonic: "ne"; integer value: 1)
  • signed less than (mnemonic: "slt"; integer value: 2)
  • signed less than or equal (mnemonic: "sle"; integer value: 3)
  • signed greater than (mnemonic: "sgt"; integer value: 4)
  • signed greater than or equal (mnemonic: "sge"; integer value: 5)
  • unsigned less than (mnemonic: "ult"; integer value: 6)
  • unsigned less than or equal (mnemonic: "ule"; integer value: 7)
  • unsigned greater than (mnemonic: "ugt"; integer value: 8)
  • unsigned greater than or equal (mnemonic: "uge"; integer value: 9)
Source code in xdsl/dialects/comb.py 
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
@irdl_op_definition
class ICmpOp(TwoStateOperation, ABC):
    """Integer comparison: A generic comparison operation, operation definitions inherit this class.

    The first argument to these comparison operations is the type of comparison
    being performed, the following comparisons are supported:

    -   equal (mnemonic: `"eq"`; integer value: `0`)
    -   not equal (mnemonic: `"ne"`; integer value: `1`)
    -   signed less than (mnemonic: `"slt"`; integer value: `2`)
    -   signed less than or equal (mnemonic: `"sle"`; integer value: `3`)
    -   signed greater than (mnemonic: `"sgt"`; integer value: `4`)
    -   signed greater than or equal (mnemonic: `"sge"`; integer value: `5`)
    -   unsigned less than (mnemonic: `"ult"`; integer value: `6`)
    -   unsigned less than or equal (mnemonic: `"ule"`; integer value: `7`)
    -   unsigned greater than (mnemonic: `"ugt"`; integer value: `8`)
    -   unsigned greater than or equal (mnemonic: `"uge"`; integer value: `9`)
    """

    name = "comb.icmp"

    T: ClassVar = VarConstraint("T", base(IntegerType))

    predicate = prop_def(IntegerAttr[I64])
    lhs = operand_def(T)
    rhs = operand_def(T)
    result = result_def(IntegerType(1))

    @staticmethod
    def _get_comparison_predicate(
        mnemonic: str, comparison_operations: dict[str, int]
    ) -> int:
        if mnemonic in comparison_operations:
            return comparison_operations[mnemonic]
        else:
            raise VerifyException(f"Unknown comparison mnemonic: {mnemonic}")

    def __init__(
        self,
        operand1: Operation | SSAValue,
        operand2: Operation | SSAValue,
        arg: int | str | IntegerAttr[IntegerType],
        has_two_state_semantics: bool = False,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        operand1 = SSAValue.get(operand1)
        operand2 = SSAValue.get(operand2)

        if isinstance(arg, str):
            cmpi_comparison_operations = {
                "eq": 0,
                "ne": 1,
                "slt": 2,
                "sle": 3,
                "sgt": 4,
                "sge": 5,
                "ult": 6,
                "ule": 7,
                "ugt": 8,
                "uge": 9,
            }
            arg = ICmpOp._get_comparison_predicate(arg, cmpi_comparison_operations)
        if not isinstance(arg, IntegerAttr):
            arg = IntegerAttr(arg, 64)

        return super().__init__(
            operands=[operand1, operand2],
            result_types=[IntegerType(1)],
            attributes=attr_dict,
            properties={"predicate": arg},
            has_two_state_semantics=has_two_state_semantics,
        )

    @classmethod
    def parse(cls, parser: Parser):
        has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
        arg = parser.parse_identifier()
        operand1 = parser.parse_unresolved_operand()
        parser.parse_punctuation(",")
        operand2 = parser.parse_unresolved_operand()
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        input_type = parser.parse_type()
        (operand1, operand2) = parser.resolve_operands(
            [operand1, operand2], 2 * [input_type], parser.pos
        )
        return cls(operand1, operand2, arg, has_two_state_semantics, attr_dict)

    def print(self, printer: Printer):
        self.print_optional_two_state_keyword(printer)
        printer.print_string(" ")
        printer.print_string(ICMP_COMPARISON_OPERATIONS[self.predicate.value.data])
        printer.print_string(" ")
        printer.print_operand(self.lhs)
        printer.print_string(", ")
        printer.print_operand(self.rhs)
        printer.print_op_attributes(self.attributes)
        printer.print_string(" : ")
        printer.print_attribute(self.lhs.type)

name = 'comb.icmp' class-attribute instance-attribute

T: ClassVar = VarConstraint('T', base(IntegerType)) class-attribute instance-attribute

predicate = prop_def(IntegerAttr[I64]) class-attribute instance-attribute

lhs = operand_def(T) class-attribute instance-attribute

rhs = operand_def(T) class-attribute instance-attribute

result = result_def(IntegerType(1)) class-attribute instance-attribute

__init__(operand1: Operation | SSAValue, operand2: Operation | SSAValue, arg: int | str | IntegerAttr[IntegerType], has_two_state_semantics: bool = False, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
def __init__(
    self,
    operand1: Operation | SSAValue,
    operand2: Operation | SSAValue,
    arg: int | str | IntegerAttr[IntegerType],
    has_two_state_semantics: bool = False,
    attr_dict: dict[str, Attribute] | None = None,
):
    operand1 = SSAValue.get(operand1)
    operand2 = SSAValue.get(operand2)

    if isinstance(arg, str):
        cmpi_comparison_operations = {
            "eq": 0,
            "ne": 1,
            "slt": 2,
            "sle": 3,
            "sgt": 4,
            "sge": 5,
            "ult": 6,
            "ule": 7,
            "ugt": 8,
            "uge": 9,
        }
        arg = ICmpOp._get_comparison_predicate(arg, cmpi_comparison_operations)
    if not isinstance(arg, IntegerAttr):
        arg = IntegerAttr(arg, 64)

    return super().__init__(
        operands=[operand1, operand2],
        result_types=[IntegerType(1)],
        attributes=attr_dict,
        properties={"predicate": arg},
        has_two_state_semantics=has_two_state_semantics,
    )

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
373
374
375
376
377
378
379
380
381
382
383
384
385
386
@classmethod
def parse(cls, parser: Parser):
    has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
    arg = parser.parse_identifier()
    operand1 = parser.parse_unresolved_operand()
    parser.parse_punctuation(",")
    operand2 = parser.parse_unresolved_operand()
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    input_type = parser.parse_type()
    (operand1, operand2) = parser.resolve_operands(
        [operand1, operand2], 2 * [input_type], parser.pos
    )
    return cls(operand1, operand2, arg, has_two_state_semantics, attr_dict)

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
388
389
390
391
392
393
394
395
396
397
398
def print(self, printer: Printer):
    self.print_optional_two_state_keyword(printer)
    printer.print_string(" ")
    printer.print_string(ICMP_COMPARISON_OPERATIONS[self.predicate.value.data])
    printer.print_string(" ")
    printer.print_operand(self.lhs)
    printer.print_string(", ")
    printer.print_operand(self.rhs)
    printer.print_op_attributes(self.attributes)
    printer.print_string(" : ")
    printer.print_attribute(self.lhs.type)

ParityOp

Bases: TwoStateOperation

Parity

Source code in xdsl/dialects/comb.py 
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
@irdl_op_definition
class ParityOp(TwoStateOperation):
    """Parity"""

    name = "comb.parity"

    input = operand_def(IntegerType)
    result = result_def(IntegerType(1))

    def __init__(
        self,
        operand: Operation | SSAValue,
        has_two_state_semantics: bool = False,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        operand = SSAValue.get(operand)
        return super().__init__(
            operands=[operand],
            result_types=[operand.type],
            has_two_state_semantics=has_two_state_semantics,
            attributes=attr_dict,
        )

    @classmethod
    def parse(cls, parser: Parser):
        has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
        op = parser.parse_unresolved_operand()
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        result_type = parser.parse_type()
        op = parser.resolve_operand(op, result_type)
        return cls(op, has_two_state_semantics, attr_dict)

    def print(self, printer: Printer):
        self.print_optional_two_state_keyword(printer)
        printer.print_string(" ")
        printer.print_ssa_value(self.input)
        printer.print_op_attributes(self.attributes)
        printer.print_string(" : ")
        printer.print_attribute(self.result.type)

name = 'comb.parity' class-attribute instance-attribute

input = operand_def(IntegerType) class-attribute instance-attribute

result = result_def(IntegerType(1)) class-attribute instance-attribute

__init__(operand: Operation | SSAValue, has_two_state_semantics: bool = False, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
410
411
412
413
414
415
416
417
418
419
420
421
422
def __init__(
    self,
    operand: Operation | SSAValue,
    has_two_state_semantics: bool = False,
    attr_dict: dict[str, Attribute] | None = None,
):
    operand = SSAValue.get(operand)
    return super().__init__(
        operands=[operand],
        result_types=[operand.type],
        has_two_state_semantics=has_two_state_semantics,
        attributes=attr_dict,
    )

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
424
425
426
427
428
429
430
431
432
@classmethod
def parse(cls, parser: Parser):
    has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
    op = parser.parse_unresolved_operand()
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    result_type = parser.parse_type()
    op = parser.resolve_operand(op, result_type)
    return cls(op, has_two_state_semantics, attr_dict)

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
434
435
436
437
438
439
440
def print(self, printer: Printer):
    self.print_optional_two_state_keyword(printer)
    printer.print_string(" ")
    printer.print_ssa_value(self.input)
    printer.print_op_attributes(self.attributes)
    printer.print_string(" : ")
    printer.print_attribute(self.result.type)

ExtractOp

Bases: IRDLOperation

Extract a range of bits into a smaller value, low_bit specifies the lowest bit included. Result is the size of the value to extract.

|-----------------| input l low bit <--------> result

Source code in xdsl/dialects/comb.py 
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
@irdl_op_definition
class ExtractOp(IRDLOperation):
    """
    Extract a range of bits into a smaller value, low_bit
    specifies the lowest bit included. Result is the size
    of the value to extract.

    |-----------------|   input
           l              low bit
           <-------->     result
    """

    name = "comb.extract"

    input = operand_def(IntegerType)
    low_bit = prop_def(IntegerAttr[I32], prop_name="lowBit")
    result = result_def(IntegerType)

    def __init__(
        self,
        operand: Operation | SSAValue,
        low_bit: IntegerAttr[IntegerType],
        result_type: IntegerType,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        operand = SSAValue.get(operand)
        return super().__init__(
            operands=[operand],
            result_types=[result_type],
            properties={"lowBit": low_bit},
            attributes=attr_dict,
        )

    def verify_(self) -> None:
        assert isa(self.input.type, IntegerType)
        assert isinstance(self.result.type, IntegerType)
        if (
            self.low_bit.value.data + self.result.type.width.data
            > self.input.type.width.data + 1
        ):
            raise VerifyException(
                f"output width {self.result.type.width.data} is "
                f"too large for input of width "
                f"{self.input.type.width.data} (included low bit "
                f"is at {self.low_bit.value.data})"
            )

    @classmethod
    def parse(cls, parser: Parser):
        op = parser.parse_unresolved_operand()
        parser.parse_keyword("from")
        bit = parser.parse_integer()
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        result_type = parser.parse_function_type()
        if len(result_type.inputs.data) != 1 or len(result_type.outputs.data) != 1:
            parser.raise_error(
                "expected exactly one input and exactly one output types"
            )
        if not isa(result_type.outputs.data[0], IntegerType):
            parser.raise_error(
                f"expected output to be an integer type, got '{result_type.outputs.data[0]}'"
            )
        (op,) = parser.resolve_operands([op], result_type.inputs.data, parser.pos)
        return cls(
            op, IntegerAttr(bit, 32), result_type.outputs.data[0], attr_dict=attr_dict
        )

    def print(self, printer: Printer):
        printer.print_string(" ")
        printer.print_ssa_value(self.input)
        printer.print_string(f" from {self.low_bit.value.data}")
        printer.print_op_attributes(self.attributes)
        printer.print_string(" :  ")
        printer.print_function_type([self.input.type], [self.result.type])

name = 'comb.extract' class-attribute instance-attribute

input = operand_def(IntegerType) class-attribute instance-attribute

low_bit = prop_def(IntegerAttr[I32], prop_name='lowBit') class-attribute instance-attribute

result = result_def(IntegerType) class-attribute instance-attribute

__init__(operand: Operation | SSAValue, low_bit: IntegerAttr[IntegerType], result_type: IntegerType, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
461
462
463
464
465
466
467
468
469
470
471
472
473
474
def __init__(
    self,
    operand: Operation | SSAValue,
    low_bit: IntegerAttr[IntegerType],
    result_type: IntegerType,
    attr_dict: dict[str, Attribute] | None = None,
):
    operand = SSAValue.get(operand)
    return super().__init__(
        operands=[operand],
        result_types=[result_type],
        properties={"lowBit": low_bit},
        attributes=attr_dict,
    )

verify_() -> None

Source code in xdsl/dialects/comb.py 
476
477
478
479
480
481
482
483
484
485
486
487
488
def verify_(self) -> None:
    assert isa(self.input.type, IntegerType)
    assert isinstance(self.result.type, IntegerType)
    if (
        self.low_bit.value.data + self.result.type.width.data
        > self.input.type.width.data + 1
    ):
        raise VerifyException(
            f"output width {self.result.type.width.data} is "
            f"too large for input of width "
            f"{self.input.type.width.data} (included low bit "
            f"is at {self.low_bit.value.data})"
        )

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
@classmethod
def parse(cls, parser: Parser):
    op = parser.parse_unresolved_operand()
    parser.parse_keyword("from")
    bit = parser.parse_integer()
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    result_type = parser.parse_function_type()
    if len(result_type.inputs.data) != 1 or len(result_type.outputs.data) != 1:
        parser.raise_error(
            "expected exactly one input and exactly one output types"
        )
    if not isa(result_type.outputs.data[0], IntegerType):
        parser.raise_error(
            f"expected output to be an integer type, got '{result_type.outputs.data[0]}'"
        )
    (op,) = parser.resolve_operands([op], result_type.inputs.data, parser.pos)
    return cls(
        op, IntegerAttr(bit, 32), result_type.outputs.data[0], attr_dict=attr_dict
    )

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
511
512
513
514
515
516
517
def print(self, printer: Printer):
    printer.print_string(" ")
    printer.print_ssa_value(self.input)
    printer.print_string(f" from {self.low_bit.value.data}")
    printer.print_op_attributes(self.attributes)
    printer.print_string(" :  ")
    printer.print_function_type([self.input.type], [self.result.type])

ConcatOp

Bases: IRDLOperation

Concatenate a variadic list of operands together.

Source code in xdsl/dialects/comb.py 
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
@irdl_op_definition
class ConcatOp(IRDLOperation):
    """
    Concatenate a variadic list of operands together.
    """

    name = "comb.concat"

    inputs = var_operand_def(IntegerType)
    result = result_def(IntegerType)

    def __init__(
        self,
        ops: Sequence[SSAValue | Operation],
        target_type: IntegerType,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        return super().__init__(
            operands=[ops], result_types=[target_type], attributes=attr_dict
        )

    @staticmethod
    def from_int_values(inputs: Sequence[SSAValue]) -> ConcatOp | None:
        """
        Concatenates the provided values, in order. Returns None if the provided
        values are not integers.
        """
        sum_of_width = _get_sum_of_int_width([inp.type for inp in inputs])
        if sum_of_width is None:
            return None
        return ConcatOp(inputs, IntegerType(sum_of_width))

    def verify_(self) -> None:
        sum_of_width = _get_sum_of_int_width(self.inputs.types)
        assert sum_of_width is not None
        assert isinstance(self.result.type, IntegerType)
        if sum_of_width != self.result.type.width.data:
            raise VerifyException(
                f"Sum of integer width ({sum_of_width}) "
                f"is different from result "
                f"width ({self.result.type.width.data})"
            )

    @classmethod
    def parse(cls, parser: Parser):
        inputs = parser.parse_comma_separated_list(
            parser.Delimiter.NONE, parser.parse_unresolved_operand
        )
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        input_types = parser.parse_comma_separated_list(
            parser.Delimiter.NONE, parser.parse_type
        )
        sum_of_width = _get_sum_of_int_width(input_types)
        if sum_of_width is None:
            parser.raise_error("expected only integer types as input")
        inputs = parser.resolve_operands(inputs, input_types, parser.pos)
        return cls.create(
            operands=inputs,
            result_types=[IntegerType(sum_of_width)],
            attributes=attr_dict,
        )

    def print(self, printer: Printer):
        printer.print_string(" ")
        printer.print_list(self.inputs, printer.print_ssa_value)
        printer.print_op_attributes(self.attributes)
        printer.print_string(" : ")
        printer.print_list(self.inputs.types, printer.print_attribute)

name = 'comb.concat' class-attribute instance-attribute

inputs = var_operand_def(IntegerType) class-attribute instance-attribute

result = result_def(IntegerType) class-attribute instance-attribute

__init__(ops: Sequence[SSAValue | Operation], target_type: IntegerType, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
544
545
546
547
548
549
550
551
552
def __init__(
    self,
    ops: Sequence[SSAValue | Operation],
    target_type: IntegerType,
    attr_dict: dict[str, Attribute] | None = None,
):
    return super().__init__(
        operands=[ops], result_types=[target_type], attributes=attr_dict
    )

from_int_values(inputs: Sequence[SSAValue]) -> ConcatOp | None staticmethod

Concatenates the provided values, in order. Returns None if the provided values are not integers.

Source code in xdsl/dialects/comb.py 
554
555
556
557
558
559
560
561
562
563
@staticmethod
def from_int_values(inputs: Sequence[SSAValue]) -> ConcatOp | None:
    """
    Concatenates the provided values, in order. Returns None if the provided
    values are not integers.
    """
    sum_of_width = _get_sum_of_int_width([inp.type for inp in inputs])
    if sum_of_width is None:
        return None
    return ConcatOp(inputs, IntegerType(sum_of_width))

verify_() -> None

Source code in xdsl/dialects/comb.py 
565
566
567
568
569
570
571
572
573
574
def verify_(self) -> None:
    sum_of_width = _get_sum_of_int_width(self.inputs.types)
    assert sum_of_width is not None
    assert isinstance(self.result.type, IntegerType)
    if sum_of_width != self.result.type.width.data:
        raise VerifyException(
            f"Sum of integer width ({sum_of_width}) "
            f"is different from result "
            f"width ({self.result.type.width.data})"
        )

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
@classmethod
def parse(cls, parser: Parser):
    inputs = parser.parse_comma_separated_list(
        parser.Delimiter.NONE, parser.parse_unresolved_operand
    )
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    input_types = parser.parse_comma_separated_list(
        parser.Delimiter.NONE, parser.parse_type
    )
    sum_of_width = _get_sum_of_int_width(input_types)
    if sum_of_width is None:
        parser.raise_error("expected only integer types as input")
    inputs = parser.resolve_operands(inputs, input_types, parser.pos)
    return cls.create(
        operands=inputs,
        result_types=[IntegerType(sum_of_width)],
        attributes=attr_dict,
    )

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
596
597
598
599
600
601
def print(self, printer: Printer):
    printer.print_string(" ")
    printer.print_list(self.inputs, printer.print_ssa_value)
    printer.print_op_attributes(self.attributes)
    printer.print_string(" : ")
    printer.print_list(self.inputs.types, printer.print_attribute)

ReplicateOp

Bases: IRDLOperation

Concatenate the operand a constant number of times.

Source code in xdsl/dialects/comb.py 
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
@irdl_op_definition
class ReplicateOp(IRDLOperation):
    """
    Concatenate the operand a constant number of times.
    """

    name = "comb.replicate"

    input = operand_def(IntegerType)
    result = result_def(IntegerType)

    def __init__(
        self,
        op: SSAValue | Operation,
        target_type: IntegerType,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        return super().__init__(
            operands=[op], result_types=[target_type], attributes=attr_dict
        )

    @classmethod
    def parse(cls, parser: Parser):
        op = parser.parse_unresolved_operand()
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        fun_type = parser.parse_function_type()
        operands = parser.resolve_operands([op], fun_type.inputs.data, parser.pos)
        return cls.create(
            operands=operands, result_types=fun_type.outputs.data, attributes=attr_dict
        )

    def print(self, printer: Printer):
        printer.print_string(" ")
        printer.print_ssa_value(self.input)
        printer.print_op_attributes(self.attributes)
        printer.print_string(" : ")
        printer.print_function_type((self.input.type,), (self.result.type,))

name = 'comb.replicate' class-attribute instance-attribute

input = operand_def(IntegerType) class-attribute instance-attribute

result = result_def(IntegerType) class-attribute instance-attribute

__init__(op: SSAValue | Operation, target_type: IntegerType, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
615
616
617
618
619
620
621
622
623
def __init__(
    self,
    op: SSAValue | Operation,
    target_type: IntegerType,
    attr_dict: dict[str, Attribute] | None = None,
):
    return super().__init__(
        operands=[op], result_types=[target_type], attributes=attr_dict
    )

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
625
626
627
628
629
630
631
632
633
634
@classmethod
def parse(cls, parser: Parser):
    op = parser.parse_unresolved_operand()
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    fun_type = parser.parse_function_type()
    operands = parser.resolve_operands([op], fun_type.inputs.data, parser.pos)
    return cls.create(
        operands=operands, result_types=fun_type.outputs.data, attributes=attr_dict
    )

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
636
637
638
639
640
641
def print(self, printer: Printer):
    printer.print_string(" ")
    printer.print_ssa_value(self.input)
    printer.print_op_attributes(self.attributes)
    printer.print_string(" : ")
    printer.print_function_type((self.input.type,), (self.result.type,))

MuxOp

Bases: TwoStateOperation

Select between two values based on a condition.

Source code in xdsl/dialects/comb.py 
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
@irdl_op_definition
class MuxOp(TwoStateOperation):
    """
    Select between two values based on a condition.
    """

    name = "comb.mux"

    T: ClassVar = VarConstraint("T", base(TypeAttribute))

    cond = operand_def(IntegerType(1))
    true_value = operand_def(T)
    false_value = operand_def(T)
    result = result_def(T)

    def __init__(
        self,
        condition: Operation | SSAValue,
        true_val: Operation | SSAValue,
        false_val: Operation | SSAValue,
        has_two_state_semantics: bool = False,
        attr_dict: dict[str, Attribute] | None = None,
    ):
        operand2 = SSAValue.get(true_val)
        return super().__init__(
            operands=[condition, true_val, false_val],
            result_types=[operand2.type],
            has_two_state_semantics=has_two_state_semantics,
            attributes=attr_dict,
        )

    @classmethod
    def parse(cls, parser: Parser):
        has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
        condition = parser.parse_unresolved_operand()
        parser.parse_punctuation(",")
        true_val = parser.parse_unresolved_operand()
        parser.parse_punctuation(",")
        false_val = parser.parse_unresolved_operand()
        attr_dict = parser.parse_optional_attr_dict()
        parser.parse_punctuation(":")
        result_type = parser.parse_type()
        (condition, true_val, false_val) = parser.resolve_operands(
            [condition, true_val, false_val],
            [IntegerType(1), result_type, result_type],
            parser.pos,
        )
        return cls(condition, true_val, false_val, has_two_state_semantics, attr_dict)

    def print(self, printer: Printer):
        self.print_optional_two_state_keyword(printer)
        printer.print_string(" ")
        printer.print_operand(self.cond)
        printer.print_string(", ")
        printer.print_operand(self.true_value)
        printer.print_string(", ")
        printer.print_operand(self.false_value)
        printer.print_op_attributes(self.attributes)
        printer.print_string(" : ")
        printer.print_attribute(self.result.type)

name = 'comb.mux' class-attribute instance-attribute

T: ClassVar = VarConstraint('T', base(TypeAttribute)) class-attribute instance-attribute

cond = operand_def(IntegerType(1)) class-attribute instance-attribute

true_value = operand_def(T) class-attribute instance-attribute

false_value = operand_def(T) class-attribute instance-attribute

result = result_def(T) class-attribute instance-attribute

__init__(condition: Operation | SSAValue, true_val: Operation | SSAValue, false_val: Operation | SSAValue, has_two_state_semantics: bool = False, attr_dict: dict[str, Attribute] | None = None)

Source code in xdsl/dialects/comb.py 
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
def __init__(
    self,
    condition: Operation | SSAValue,
    true_val: Operation | SSAValue,
    false_val: Operation | SSAValue,
    has_two_state_semantics: bool = False,
    attr_dict: dict[str, Attribute] | None = None,
):
    operand2 = SSAValue.get(true_val)
    return super().__init__(
        operands=[condition, true_val, false_val],
        result_types=[operand2.type],
        has_two_state_semantics=has_two_state_semantics,
        attributes=attr_dict,
    )

parse(parser: Parser) classmethod

Source code in xdsl/dialects/comb.py 
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
@classmethod
def parse(cls, parser: Parser):
    has_two_state_semantics = cls.parse_optional_two_state_keyword(parser)
    condition = parser.parse_unresolved_operand()
    parser.parse_punctuation(",")
    true_val = parser.parse_unresolved_operand()
    parser.parse_punctuation(",")
    false_val = parser.parse_unresolved_operand()
    attr_dict = parser.parse_optional_attr_dict()
    parser.parse_punctuation(":")
    result_type = parser.parse_type()
    (condition, true_val, false_val) = parser.resolve_operands(
        [condition, true_val, false_val],
        [IntegerType(1), result_type, result_type],
        parser.pos,
    )
    return cls(condition, true_val, false_val, has_two_state_semantics, attr_dict)

print(printer: Printer)

Source code in xdsl/dialects/comb.py 
693
694
695
696
697
698
699
700
701
702
703
def print(self, printer: Printer):
    self.print_optional_two_state_keyword(printer)
    printer.print_string(" ")
    printer.print_operand(self.cond)
    printer.print_string(", ")
    printer.print_operand(self.true_value)
    printer.print_string(", ")
    printer.print_operand(self.false_value)
    printer.print_op_attributes(self.attributes)
    printer.print_string(" : ")
    printer.print_attribute(self.result.type)