Skip to content

Dialect codegen

dialect_codegen

Functions to print a Python file with the definition of a dialect, given specifications of its operations and attributes.

generate_dynamic_attr_class(class_name: str, attr: ParamAttrDef, is_type: bool = True) -> type[Attribute]

Dynamically define a type based on ParamAttrDef. This is needed to reference dynamically created attributes in operations.

Source code in xdsl/utils/dialect_codegen.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def generate_dynamic_attr_class(
    class_name: str, attr: ParamAttrDef, is_type: bool = True
) -> type[Attribute]:
    """
    Dynamically define a type based on ParamAttrDef.
    This is needed to reference dynamically created attributes in operations.
    """
    return runtime_final(
        type(
            class_name,
            (ParametrizedAttribute,) + ((TypeAttribute,) if is_type else ()),
            dict(ParametrizedAttribute.__dict__) | {"name": attr.name},
        )
    )

get_str_from_operand_or_result(name: str, operand_or_result: OperandDef | ResultDef) -> str

Get a constraint from the RangeConstraint wrapper. Build the correct definition function based on the wrapper's type.

Source code in xdsl/utils/dialect_codegen.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
def get_str_from_operand_or_result(
    name: str, operand_or_result: OperandDef | ResultDef
) -> str:
    """
    Get a constraint from the RangeConstraint wrapper.
    Build the correct definition function based on the wrapper's type.
    """
    match operand_or_result.constr:
        case SingleOf():
            inner_constr = operand_or_result.constr.constr
        case RangeOf():
            inner_constr = operand_or_result.constr.constr
        case _:
            raise NotImplementedError(
                f"Constraint type {operand_or_result.constr} not yet implemented"
            )

    match operand_or_result:
        case OptOperandDef():
            def_str = "opt_operand_def"
        case VarOperandDef():
            def_str = "var_operand_def"
        case OperandDef():
            def_str = "operand_def"
        case OptResultDef():
            def_str = "opt_result_def"
        case VarResultDef():
            def_str = "var_result_def"
        case ResultDef():
            def_str = "result_def"

    return f"{name} = {def_str}({inner_constr})"

typedef_to_class_string(class_name: str, typedef: ParamAttrDef) -> str

Generate class definition for a type.

Source code in xdsl/utils/dialect_codegen.py 
77
78
79
80
81
82
83
84
85
86
87
88
def typedef_to_class_string(class_name: str, typedef: ParamAttrDef) -> str:
    """
    Generate class definition for a type.
    """
    if typedef.parameters:
        raise NotImplementedError("Attribute parameters not yet implemented")

    return f"""
@irdl_attr_definition
class {class_name}(ParametrizedAttribute, TypeAttribute):
\tname = "{typedef.name}"
    """

attrdef_to_class_string(class_name: str, attr: ParamAttrDef) -> str

Generate class definition for an attribute.

Source code in xdsl/utils/dialect_codegen.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def attrdef_to_class_string(class_name: str, attr: ParamAttrDef) -> str:
    """
    Generate class definition for an attribute.
    """
    if attr.parameters:
        raise NotImplementedError("Attribute parameters not yet implemented")
    return f"""
@irdl_attr_definition
class {class_name}(ParametrizedAttribute):
\tname = "{attr.name}"
    """

opdef_to_class_string(class_name: str, op: OpDef) -> str

Generate class definition for an operation.

Source code in xdsl/utils/dialect_codegen.py 
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
def opdef_to_class_string(class_name: str, op: OpDef) -> str:
    """
    Generate class definition for an operation.
    """
    field_name_mapping = {
        ir_name: field_name for (field_name, (ir_name, _)) in op.accessor_names.items()
    }

    fields_description = ""

    fields_description += (
        "\n\t".join(
            [
                get_str_from_operand_or_result(name, operand_or_result)
                for name, operand_or_result in itertools.chain(op.operands, op.results)
            ]
        )
        + "\n\t"
    )

    fields_description += (
        "\n\t".join(
            [
                f"{field_name_mapping.get(name, name)} = prop_def({prop.constr}"
                + (f', prop_name="{name}"' if name in field_name_mapping else "")
                + ")"
                for name, prop in op.properties.items()
            ]
        )
        + "\n\t"
    )

    fields_description += (
        "\n\t".join(
            [
                f"{field_name_mapping.get(name, name)} = attr_def({attr.constr}"
                + (f', attr_name="{name}"' if name in field_name_mapping else "")
                + ")"
                for name, attr in op.attributes.items()
            ]
        )
        + "\n\t"
    )

    if op.traits.traits:
        fields_description += (
            f"traits = traits_def({','.join([str(t) for t in op.traits.traits])})"
            + "\n\t"
        )

    if op.options:
        fields_description += (
            f"irdl_options = ({','.join([str(opt) for opt in op.options])},)" + "\n\t"
        )

    if op.regions:
        raise NotImplementedError("Operation regions not yet implemented")
    if op.successors:
        raise NotImplementedError("Operation successors not yet implemented")

    return f"""
@irdl_op_definition
class {class_name}(IRDLOperation):
\tname = "{op.name}"
\t{fields_description}
\t{f'assembly_format = "{op.assembly_format}"' if op.assembly_format else ""}
    """

dump_dialect_pyfile(dialect_name: str, ops: Iterable[tuple[str, OpDef]] = (), *, attributes: Iterable[tuple[str, ParamAttrDef]] = (), types: Iterable[tuple[str, ParamAttrDef]] = (), out: TextIO | None = None, dialect_obj_name: str = '')

Generate a python file with a dialect comprised of given ops, attributes and types.

Source code in xdsl/utils/dialect_codegen.py 
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
def dump_dialect_pyfile(
    dialect_name: str,
    ops: Iterable[tuple[str, OpDef]] = (),
    *,
    attributes: Iterable[tuple[str, ParamAttrDef]] = (),
    types: Iterable[tuple[str, ParamAttrDef]] = (),
    out: TextIO | None = None,
    dialect_obj_name: str = "",
):
    """
    Generate a python file with a dialect comprised of given ops, attributes and types.
    """
    if not dialect_obj_name:
        dialect_obj_name = dialect_name.capitalize() + "Dialect"

    imports = """
from xdsl.dialects.builtin import *
from xdsl.ir import *
from xdsl.irdl import *
from xdsl.traits import *

# ruff: noqa: F403, F405
    """

    types_class_defs = "\n".join(
        typedef_to_class_string(class_name, attr) for class_name, attr in types
    )

    attr_class_defs = "\n".join(
        attrdef_to_class_string(class_name, attr) for class_name, attr in attributes
    )

    op_class_defs = "\n".join(
        opdef_to_class_string(class_name, op) for class_name, op in ops
    )

    op_list = ",".join(name for name, _ in ops)
    attr_list = ",".join(name for name, _ in itertools.chain(attributes, types))

    dialect_def = (
        f'{dialect_obj_name} = Dialect("{dialect_name}", [{op_list}], [{attr_list}])'
    )

    content = "\n".join(
        (
            imports,
            types_class_defs,
            attr_class_defs,
            op_class_defs,
            dialect_def,
        )
    )
    # Format output
    output = subprocess.run(
        [
            "ruff",
            "format",
            "--stdin-filename",
            f"{dialect_name}.py",
        ],
        input=content,
        capture_output=True,
        text=True,
    )

    print(output.stdout, file=out, end="")