Skip to content

Ops

ops

RISCV = Dialect('riscv', [AddiOp, SltiOp, SltiuOp, AndiOp, OriOp, XoriOp, SlliOp, SrliOp, SraiOp, LuiOp, AuipcOp, MVOp, SeqzOp, SnezOp, ZextBOp, ZextWOp, SextWOp, AddOp, SltOp, SltuOp, AndOp, OrOp, XorOp, SllOp, SrlOp, SubOp, SraOp, NopOp, JalOp, JOp, JalrOp, ReturnOp, BeqOp, BneOp, BltOp, BgeOp, BltuOp, BgeuOp, LbOp, LbuOp, LhOp, LhuOp, LwOp, SbOp, ShOp, SwOp, CsrrwOp, CsrrsOp, CsrrcOp, CsrrwiOp, CsrrsiOp, CsrrciOp, MulOp, MulhOp, MulhsuOp, MulhuOp, DivOp, DivuOp, RemOp, RemuOp, RolOp, RorOp, RemuwOp, SrliwOp, SraiwOp, AddwOp, SubwOp, SllwOp, SrlwOp, SrawOp, RemwOp, MulwOp, DivwOp, DivuwOp, CZeroEqzOp, CZeroNezOp, BclrOp, BextOp, BinvOp, BsetOp, RolwOp, RorwOp, AddUwOp, Sh1addOp, Sh2addOp, Sh3addOp, Sh1addUwOp, Sh2addUwOp, Sh3addUwOp, SextBOp, SextHOp, ZextHOp, AndnOp, OrnOp, XnorOp, MaxOp, MaxUOp, MinOp, MinUOp, BclrIOp, BextIOp, BsetIOp, BinvIOp, RoriOp, RoriwOp, SlliUwOp, EcallOp, LabelOp, DirectiveOp, AssemblySectionOp, EbreakOp, WfiOp, CustomAssemblyInstructionOp, CommentOp, GetFloatRegisterOp, FMVOp, FMAddSOp, FMSubSOp, FNMSubSOp, FNMAddSOp, FAddSOp, FSubSOp, FMulSOp, FDivSOp, FSqrtSOp, FSgnJSOp, FSgnJNSOp, FSgnJXSOp, FMinSOp, FMaxSOp, FCvtWSOp, FCvtWuSOp, FMvXWOp, FeqSOp, FltSOp, FleSOp, FClassSOp, FCvtSWOp, FCvtSWuOp, FMvWXOp, FLwOp, FSwOp, FMAddDOp, FMSubDOp, FAddDOp, FSubDOp, FMulDOp, FDivDOp, FMinDOp, FMaxDOp, FCvtDWOp, FCvtDWuOp, FLdOp, FSdOp, FMvDOp, VFAddSOp, VFMulSOp, ParallelMovOp], [IntRegisterType, FloatRegisterType, LabelAttr, FastMathFlagsAttr]) module-attribute

AddiOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
105
106
107
108
109
110
111
112
113
114
115
116
class AddiOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            AddImmediateConstant,
            AddImmediateZero,
        )

        return (
            AddImmediateZero(),
            AddImmediateConstant(),
        )

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
106
107
108
109
110
111
112
113
114
115
116
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        AddImmediateConstant,
        AddImmediateZero,
    )

    return (
        AddImmediateZero(),
        AddImmediateConstant(),
    )

AddiOp dataclass

Bases: RdRsImmIntegerOperation

Adds the sign-extended 12-bit immediate to register rs1. Arithmetic overflow is ignored and the result is simply the low XLEN bits of the result.

x[rd] = x[rs1] + sext(immediate)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
119
120
121
122
123
124
125
126
127
128
129
130
131
132
@irdl_op_definition
class AddiOp(RdRsImmIntegerOperation):
    """
    Adds the sign-extended 12-bit immediate to register rs1.
    Arithmetic overflow is ignored and the result is simply the low XLEN bits of the result.

    x[rd] = x[rs1] + sext(immediate)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#addi).
    """

    name = "riscv.addi"

    traits = traits_def(AlwaysSpeculatable(), AddiOpHasCanonicalizationPatternsTrait())

name = 'riscv.addi' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable(), AddiOpHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

SltiOp dataclass

Bases: RdRsImmIntegerOperation

Place the value 1 in register rd if register rs1 is less than the sign-extended immediate when both are treated as signed numbers, else 0 is written to rd.

x[rd] = x[rs1] <s sext(immediate)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
135
136
137
138
139
140
141
142
143
144
145
146
@irdl_op_definition
class SltiOp(RdRsImmIntegerOperation):
    """
    Place the value 1 in register rd if register rs1 is less than the sign-extended
    immediate when both are treated as signed numbers, else 0 is written to rd.

    x[rd] = x[rs1] <s sext(immediate)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#slti).
    """

    name = "riscv.slti"

name = 'riscv.slti' class-attribute instance-attribute

SltiuOp dataclass

Bases: RdRsImmIntegerOperation

Place the value 1 in register rd if register rs1 is less than the immediate when both are treated as unsigned numbers, else 0 is written to rd.

x[rd] = x[rs1] <u sext(immediate)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
149
150
151
152
153
154
155
156
157
158
159
160
@irdl_op_definition
class SltiuOp(RdRsImmIntegerOperation):
    """
    Place the value 1 in register rd if register rs1 is less than the immediate when
    both are treated as unsigned numbers, else 0 is written to rd.

    x[rd] = x[rs1] <u sext(immediate)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sltiu).
    """

    name = "riscv.sltiu"

name = 'riscv.sltiu' class-attribute instance-attribute

AndiOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
163
164
165
166
167
168
169
170
171
172
173
174
class AndiOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            AndiImmediate,
            AndiZero,
        )

        return (
            AndiImmediate(),
            AndiZero(),
        )

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
164
165
166
167
168
169
170
171
172
173
174
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        AndiImmediate,
        AndiZero,
    )

    return (
        AndiImmediate(),
        AndiZero(),
    )

AndiOp dataclass

Bases: RdRsImmIntegerOperation

Performs bitwise AND on register rs1 and the sign-extended 12-bit immediate and place the result in rd.

x[rd] = x[rs1] & sext(immediate)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
177
178
179
180
181
182
183
184
185
186
187
188
189
@irdl_op_definition
class AndiOp(RdRsImmIntegerOperation):
    """
    Performs bitwise AND on register rs1 and the sign-extended 12-bit
    immediate and place the result in rd.

    x[rd] = x[rs1] & sext(immediate)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#andi).
    """

    name = "riscv.andi"
    traits = traits_def(AndiOpHasCanonicalizationPatternsTrait())

name = 'riscv.andi' class-attribute instance-attribute

traits = traits_def(AndiOpHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

OriOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
192
193
194
195
196
197
198
199
200
class OriOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            OriImmediate,
            OriImmediateZero,
        )

        return (OriImmediate(), OriImmediateZero())

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
193
194
195
196
197
198
199
200
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        OriImmediate,
        OriImmediateZero,
    )

    return (OriImmediate(), OriImmediateZero())

OriOp dataclass

Bases: RdRsImmIntegerOperation

Performs bitwise OR on register rs1 and the sign-extended 12-bit immediate and place the result in rd.

x[rd] = x[rs1] | sext(immediate)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
203
204
205
206
207
208
209
210
211
212
213
214
215
@irdl_op_definition
class OriOp(RdRsImmIntegerOperation):
    """
    Performs bitwise OR on register rs1 and the sign-extended 12-bit immediate and place
    the result in rd.

    x[rd] = x[rs1] | sext(immediate)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#ori).
    """

    name = "riscv.ori"
    traits = traits_def(OriOpHasCanonicalizationPatternsTrait())

name = 'riscv.ori' class-attribute instance-attribute

traits = traits_def(OriOpHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

XoriOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
218
219
220
221
222
223
224
225
226
class XoriOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            XoriImmediate,
            XoriSelfInverse,
        )

        return (XoriSelfInverse(), XoriImmediate())

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
219
220
221
222
223
224
225
226
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        XoriImmediate,
        XoriSelfInverse,
    )

    return (XoriSelfInverse(), XoriImmediate())

XoriOp dataclass

Bases: RdRsImmIntegerOperation

Performs bitwise XOR on register rs1 and the sign-extended 12-bit immediate and place the result in rd.

x[rd] = x[rs1] ^ sext(immediate)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
229
230
231
232
233
234
235
236
237
238
239
240
241
@irdl_op_definition
class XoriOp(RdRsImmIntegerOperation):
    """
    Performs bitwise XOR on register rs1 and the sign-extended 12-bit immediate and place
    the result in rd.

    x[rd] = x[rs1] ^ sext(immediate)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#xori).
    """

    name = "riscv.xori"
    traits = traits_def(XoriOpHasCanonicalizationPatternsTrait())

name = 'riscv.xori' class-attribute instance-attribute

traits = traits_def(XoriOpHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

SlliOp dataclass

Bases: RdRsImmShiftOperation

Performs logical left shift on the value in register rs1 by the shift amount held in the lower 5 bits of the immediate.

x[rd] = x[rs1] << shamt

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
@irdl_op_definition
class SlliOp(RdRsImmShiftOperation):
    """
    Performs logical left shift on the value in register rs1 by the shift amount
    held in the lower 5 bits of the immediate.

    x[rd] = x[rs1] << shamt

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#slli).
    """

    name = "riscv.slli"

    def py_operation(self, rs1: IntegerAttr[I32]) -> IntegerAttr[I32]:
        return IntegerAttr(rs1.value.data << self.immediate.value.data, i32)

name = 'riscv.slli' class-attribute instance-attribute

py_operation(rs1: IntegerAttr[I32]) -> IntegerAttr[I32]

Source code in xdsl/dialects/riscv/ops.py
257
258
def py_operation(self, rs1: IntegerAttr[I32]) -> IntegerAttr[I32]:
    return IntegerAttr(rs1.value.data << self.immediate.value.data, i32)

SrliOp dataclass

Bases: RdRsImmShiftOperation

Performs logical right shift on the value in register rs1 by the shift amount held in the lower 5 bits of the immediate.

x[rd] = x[rs1] >>u shamt

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
@irdl_op_definition
class SrliOp(RdRsImmShiftOperation):
    """
    Performs logical right shift on the value in register rs1 by the shift amount held
    in the lower 5 bits of the immediate.

    x[rd] = x[rs1] >>u shamt

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#srli).
    """

    name = "riscv.srli"

    def py_operation(self, rs1: IntegerAttr[I32]) -> IntegerAttr[I32]:
        return IntegerAttr(
            (rs1.value.data % 0x100000000) >> self.immediate.value.data, i32
        )

name = 'riscv.srli' class-attribute instance-attribute

py_operation(rs1: IntegerAttr[I32]) -> IntegerAttr[I32]

Source code in xdsl/dialects/riscv/ops.py
274
275
276
277
def py_operation(self, rs1: IntegerAttr[I32]) -> IntegerAttr[I32]:
    return IntegerAttr(
        (rs1.value.data % 0x100000000) >> self.immediate.value.data, i32
    )

SraiOp dataclass

Bases: RdRsImmShiftOperation

Performs arithmetic right shift on the value in register rs1 by the shift amount held in the lower 5 bits of the immediate.

x[rd] = x[rs1] >>s shamt

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
@irdl_op_definition
class SraiOp(RdRsImmShiftOperation):
    """
    Performs arithmetic right shift on the value in register rs1 by the shift amount
    held in the lower 5 bits of the immediate.

    x[rd] = x[rs1] >>s shamt

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#srai).
    """

    name = "riscv.srai"

    def py_operation(self, rs1: IntegerAttr[I32]) -> IntegerAttr[I32]:
        return IntegerAttr(rs1.value.data >> self.immediate.value.data, i32)

name = 'riscv.srai' class-attribute instance-attribute

py_operation(rs1: IntegerAttr[I32]) -> IntegerAttr[I32]

Source code in xdsl/dialects/riscv/ops.py
293
294
def py_operation(self, rs1: IntegerAttr[I32]) -> IntegerAttr[I32]:
    return IntegerAttr(rs1.value.data >> self.immediate.value.data, i32)

AddiwOp dataclass

Bases: RdRsImmIntegerOperation

Adds the sign-extended 12-bit immediate to register rs1 and produces the proper sign-extension of a 32-bit result in rd. Overflows are ignored and the result is the low 32 bits of the result sign-extended to 64 bits.

x[rd] = sext((x[rs1] + sext(immediate))[31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
@irdl_op_definition
class AddiwOp(RdRsImmIntegerOperation):
    """
    Adds the sign-extended 12-bit immediate to register rs1 and produces the proper sign-extension of a 32-bit result in rd.
    Overflows are ignored and the result is the low 32 bits of the result sign-extended to 64 bits.
    ```
    x[rd] = sext((x[rs1] + sext(immediate))[31:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rv64i.html#addiw).
    """

    name = "riscv.addiw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.addiw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SlliwOp dataclass

Bases: RdRsImmShiftOperation

Performs logical left shift on the 32-bit of value in register rs1 by the shift amount held in the lower 5 bits of the immediate.

x[rd] = sext((x[rs1] << shamt)[31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
314
315
316
317
318
319
320
321
322
323
324
325
326
327
@irdl_op_definition
class SlliwOp(RdRsImmShiftOperation):
    """
    Performs logical left shift on the 32-bit of value in register rs1 by the
    shift amount held in the lower 5 bits of the immediate.
    ```
    x[rd] = sext((x[rs1] << shamt)[31:0])
    ```
    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#slliw).
    """

    name = "riscv.slliw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.slliw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SrliwOp dataclass

Bases: RdRsImmShiftOperation

Performs logical right shift on the 32-bit of value in register rs1 by the shift amount held in the lower 5 bits of the immediate.

x[rd] = sext(x[rs1][31:0] >>u shamt)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
@irdl_op_definition
class SrliwOp(RdRsImmShiftOperation):
    """
    Performs logical right shift on the 32-bit of value in register rs1 by the shift amount held in the
    lower 5 bits of the immediate.
    ```
    x[rd] = sext(x[rs1][31:0] >>u shamt)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#srliw).
    """

    name = "riscv.srliw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.srliw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SraiwOp dataclass

Bases: RdRsImmIntegerOperation

Performs arithmetic right shift on the 32-bit of value in register rs1 by the shift amount held in the lower 5 bits of the immediate.

x[rd] = sext(x[rs1][31:0] >>s shamt)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
@irdl_op_definition
class SraiwOp(RdRsImmIntegerOperation):
    """
    Performs arithmetic right shift on the 32-bit of value in register rs1 by the shift amount held
    in the lower 5 bits of the immediate.
    ```
    x[rd] = sext(x[rs1][31:0] >>s shamt)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sraiw).
    """

    name = "riscv.sraiw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sraiw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

AddwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Adds the 32-bit of registers rs1 and 32-bit of register rs2 and stores the result in rd. Arithmetic overflow is ignored and the low 32-bits of the result is sign-extended to 64-bits and written to the destination register.

x[rd] = sext((x[rs1] + x[rs2])[31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
@irdl_op_definition
class AddwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Adds the 32-bit of registers rs1 and 32-bit of register rs2 and stores the result in rd.
    Arithmetic overflow is ignored and the low 32-bits of the result is sign-extended to 64-bits and
    written to the destination register.
    ```
    x[rd] = sext((x[rs1] + x[rs2])[31:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#addw).
    """

    name = "riscv.addw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.addw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SubwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Subtract the 32-bit of registers rs1 and 32-bit of register rs2 and stores the result in rd. Arithmetic overflow is ignored and the low 32-bits of the result is sign-extended to 64-bits and written to the destination register.

x[rd] = sext((x[rs1] - x[rs2])[31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
@irdl_op_definition
class SubwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Subtract the 32-bit of registers rs1 and 32-bit of register rs2 and stores the result in rd.
    Arithmetic overflow is ignored and the low 32-bits of the result is sign-extended to 64-bits
    and written to the destination register.
    ```
    x[rd] = sext((x[rs1] - x[rs2])[31:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#subw).
    """

    name = "riscv.subw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.subw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SllwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs logical left shift on the low 32-bits value in register rs1 by the shift amount held in the lower 5 bits of register rs2 and produce 32-bit results and written to the destination register rd.

x[rd] = sext((x[rs1] << x[rs2][4:0])[31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
@irdl_op_definition
class SllwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs logical left shift on the low 32-bits value in register rs1 by the shift amount held
    in the lower 5 bits of register rs2 and produce 32-bit results and written to the destination register rd.
    ```
    x[rd] = sext((x[rs1] << x[rs2][4:0])[31:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sllw).
    """

    name = "riscv.sllw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sllw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SrlwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs logical right shift on the low 32-bits value in register rs1 by the shift amount held in the lower 5 bits of register rs2 and produce 32-bit results and written to the destination register rd.

x[rd] = sext(x[rs1][31:0] >>u x[rs2][4:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
@irdl_op_definition
class SrlwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs logical right shift on the low 32-bits value in register rs1 by the shift amount held
    in the lower 5 bits of register rs2 and produce 32-bit results and written to the destination
    register rd.
    ```
    x[rd] = sext(x[rs1][31:0] >>u x[rs2][4:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#srlw).
    """

    name = "riscv.srlw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.srlw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SrawOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs arithmetic right shift on the low 32-bits value in register rs1 by the shift amount held in the lower 5 bits of register rs2 and produce 32-bit results and written to the destination register rd.

x[rd] = sext(x[rs1][31:0] >>s x[rs2][4:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
@irdl_op_definition
class SrawOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs arithmetic right shift on the low 32-bits value in register rs1 by the shift amount held in the lower
    5 bits of register rs2 and produce 32-bit results and written to the destination register rd.
    ```
    x[rd] = sext(x[rs1][31:0] >>s x[rs2][4:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sraw).
    """

    name = "riscv.sraw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sraw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

LuiOp dataclass

Bases: RdImmIntegerOperation

Build 32-bit constants and uses the U-type format. LUI places the U-immediate value in the top 20 bits of the destination register rd, filling in the lowest 12 bits with zeros.

x[rd] = sext(immediate[31:12] << 12)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
452
453
454
455
456
457
458
459
460
461
462
463
@irdl_op_definition
class LuiOp(RdImmIntegerOperation):
    """
    Build 32-bit constants and uses the U-type format. LUI places the U-immediate value
    in the top 20 bits of the destination register rd, filling in the lowest 12 bits with zeros.

    x[rd] = sext(immediate[31:12] << 12)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#lui).
    """

    name = "riscv.lui"

name = 'riscv.lui' class-attribute instance-attribute

AuipcOp dataclass

Bases: RdImmIntegerOperation

Build pc-relative addresses and uses the U-type format. AUIPC forms a 32-bit offset from the 20-bit U-immediate, filling in the lowest 12 bits with zeros, adds this offset to the pc, then places the result in register rd.

x[rd] = pc + sext(immediate[31:12] << 12)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
466
467
468
469
470
471
472
473
474
475
476
477
478
@irdl_op_definition
class AuipcOp(RdImmIntegerOperation):
    """
    Build pc-relative addresses and uses the U-type format. AUIPC forms a 32-bit offset
    from the 20-bit U-immediate, filling in the lowest 12 bits with zeros, adds this
    offset to the pc, then places the result in register rd.

    x[rd] = pc + sext(immediate[31:12] << 12)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#auipc).
    """

    name = "riscv.auipc"

name = 'riscv.auipc' class-attribute instance-attribute

MVHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
481
482
483
484
485
486
487
488
class MVHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            RemoveRedundantMv,
        )

        return (RemoveRedundantMv(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
482
483
484
485
486
487
488
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        RemoveRedundantMv,
    )

    return (RemoveRedundantMv(),)

MVOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

A pseudo instruction to copy contents of one int register to another.

Equivalent to addi rd, rs, 0

Source code in xdsl/dialects/riscv/ops.py
491
492
493
494
495
496
497
498
499
500
501
502
503
504
@irdl_op_definition
class MVOp(RdRsIntegerOperation[IntRegisterType]):
    """
    A pseudo instruction to copy contents of one int register to another.

    Equivalent to `addi rd, rs, 0`
    """

    name = "riscv.mv"

    traits = traits_def(
        AlwaysSpeculatable(),
        MVHasCanonicalizationPatternsTrait(),
    )

name = 'riscv.mv' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable(), MVHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

SeqzOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

A pseudo instruction that sets the destination register to 1 if the source register is equal to zero.

Equivalent to `sltiu rd, rs, 1

Source code in xdsl/dialects/riscv/ops.py
507
508
509
510
511
512
513
514
515
@irdl_op_definition
class SeqzOp(RdRsIntegerOperation[IntRegisterType]):
    """
    A pseudo instruction that sets the destination register to 1 if the source register is equal to zero.

    Equivalent to `sltiu rd, rs, 1
    """

    name = "riscv.seqz"

name = 'riscv.seqz' class-attribute instance-attribute

SnezOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

A pseudo instruction that sets the destination register to 1 if the source register is not equal to zero.

Equivalent to sltu rd, x0, rs1

Source code in xdsl/dialects/riscv/ops.py
518
519
520
521
522
523
524
525
526
@irdl_op_definition
class SnezOp(RdRsIntegerOperation[IntRegisterType]):
    """
    A pseudo instruction that sets the destination register to 1 if the source register is not equal to zero.

    Equivalent to `sltu rd, x0, rs1 `
    """

    name = "riscv.snez"

name = 'riscv.snez' class-attribute instance-attribute

ZextBOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

A pseudo instruction that zero-extends the least-significant byte of the source to XLEN by copying the into all of the bits more significant than 31.

Equivalent to andi rd, rs1, 255

Source code in xdsl/dialects/riscv/ops.py
529
530
531
532
533
534
535
536
537
538
539
540
@irdl_op_definition
class ZextBOp(RdRsIntegerOperation[IntRegisterType]):
    """
    A pseudo instruction that zero-extends the least-significant byte of the source to XLEN by copying the
    into all of the bits more significant than 31.

    Equivalent to `andi rd, rs1, 255`
    """

    name = "riscv.zext.b"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.zext.b' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

ZextWOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

A pseudo instruction that zero-extends the least-significant word of the source to XLEN by inserting 0’s into all of the bits more significant than 31.

Equivalent to add.uw rd, rs1, 0

See external documentation

Source code in xdsl/dialects/riscv/ops.py
543
544
545
546
547
548
549
550
551
552
553
554
555
556
@irdl_op_definition
class ZextWOp(RdRsIntegerOperation[IntRegisterType]):
    """
    A pseudo instruction that zero-extends the least-significant word of the source to XLEN by inserting 0’s
    into all of the bits more significant than 31.

    Equivalent to `add.uw rd, rs1, 0`

    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-add_uw)
    """

    name = "riscv.zext.w"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.zext.w' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SextWOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

A pseudo instruction that writes the sign-extension of the lower 32 bits of register rs1 into register rd.

Equivalent to addiw rd, rs, 0

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
559
560
561
562
563
564
565
566
567
568
569
570
571
@irdl_op_definition
class SextWOp(RdRsIntegerOperation[IntRegisterType]):
    """
    A pseudo instruction that writes the sign-extension of the lower 32 bits of register rs1 into register rd.

    Equivalent to `addiw rd, rs, 0 `

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/#_addiw).
    """

    name = "riscv.sext.w"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sext.w' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FMVHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
574
575
576
577
578
579
class FMVHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import RemoveRedundantFMv

        return (RemoveRedundantFMv(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
575
576
577
578
579
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import RemoveRedundantFMv

    return (RemoveRedundantFMv(),)

FMVOp dataclass

Bases: RdRsFloatOperation[FloatRegisterType]

A pseudo instruction to copy contents of one float register to another.

Equivalent to fsgnj.s rd, rs, rs.

Both clang and gcc emit fsw rs, 0(x); flw rd, 0(x) to copy floats, possibly because storing and loading bits from memory is a lower overhead in practice than reasoning about floating-point values.

Source code in xdsl/dialects/riscv/ops.py
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
@irdl_op_definition
class FMVOp(RdRsFloatOperation[FloatRegisterType]):
    """
    A pseudo instruction to copy contents of one float register to another.

    Equivalent to `fsgnj.s rd, rs, rs`.

    Both clang and gcc emit `fsw rs, 0(x); flw rd, 0(x)` to copy floats, possibly because
    storing and loading bits from memory is a lower overhead in practice than reasoning
    about floating-point values.
    """

    name = "riscv.fmv.s"

    traits = traits_def(
        AlwaysSpeculatable(),
        FMVHasCanonicalizationPatternsTrait(),
    )

name = 'riscv.fmv.s' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable(), FMVHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

AddOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
605
606
607
608
609
610
611
612
613
class AddOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            AddImmediates,
            AdditionOfSameVariablesToMultiplyByTwo,
        )

        return (AddImmediates(), AdditionOfSameVariablesToMultiplyByTwo())

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
606
607
608
609
610
611
612
613
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        AddImmediates,
        AdditionOfSameVariablesToMultiplyByTwo,
    )

    return (AddImmediates(), AdditionOfSameVariablesToMultiplyByTwo())

AddOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Adds the registers rs1 and rs2 and stores the result in rd. Arithmetic overflow is ignored and the result is simply the low XLEN bits of the result.

x[rd] = x[rs1] + x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
@irdl_op_definition
class AddOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Adds the registers rs1 and rs2 and stores the result in rd.
    Arithmetic overflow is ignored and the result is simply the low XLEN bits of the result.

    ```
    x[rd] = x[rs1] + x[rs2]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#add).
    """

    name = "riscv.add"

    traits = traits_def(
        AlwaysSpeculatable(),
        AddOpHasCanonicalizationPatternsTrait(),
    )

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

traits = traits_def(AlwaysSpeculatable(), AddOpHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

SltOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Place the value 1 in register rd if register rs1 is less than register rs2 when both are treated as signed numbers, else 0 is written to rd.

x[rd] = x[rs1] <s x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
637
638
639
640
641
642
643
644
645
646
647
648
@irdl_op_definition
class SltOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Place the value 1 in register rd if register rs1 is less than register rs2 when both
    are treated as signed numbers, else 0 is written to rd.

    x[rd] = x[rs1] <s x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#slt).
    """

    name = "riscv.slt"

name = 'riscv.slt' class-attribute instance-attribute

SltuOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Place the value 1 in register rd if register rs1 is less than register rs2 when both are treated as unsigned numbers, else 0 is written to rd.

x[rd] = x[rs1] <u x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
651
652
653
654
655
656
657
658
659
660
661
662
@irdl_op_definition
class SltuOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Place the value 1 in register rd if register rs1 is less than register rs2 when both
    are treated as unsigned numbers, else 0 is written to rd.

    x[rd] = x[rs1] <u x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sltu).
    """

    name = "riscv.sltu"

name = 'riscv.sltu' class-attribute instance-attribute

BitwiseAndHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
665
666
667
668
669
670
671
672
673
class BitwiseAndHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            BitwiseAndBySelf,
            BitwiseAndByZero,
        )

        return (BitwiseAndByZero(), BitwiseAndBySelf())

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
666
667
668
669
670
671
672
673
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        BitwiseAndBySelf,
        BitwiseAndByZero,
    )

    return (BitwiseAndByZero(), BitwiseAndBySelf())

AndOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs bitwise AND on registers rs1 and rs2 and place the result in rd.

x[rd] = x[rs1] & x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
676
677
678
679
680
681
682
683
684
685
686
687
688
@irdl_op_definition
class AndOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs bitwise AND on registers rs1 and rs2 and place the result in rd.

    x[rd] = x[rs1] & x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#and).
    """

    name = "riscv.and"

    traits = traits_def(BitwiseAndHasCanonicalizationPatternsTrait())

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

traits = traits_def(BitwiseAndHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

BitwiseOrHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
691
692
693
694
695
696
697
698
699
class BitwiseOrHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            BitwiseOrBySelf,
            BitwiseOrByZero,
        )

        return (BitwiseOrByZero(), BitwiseOrBySelf())

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
692
693
694
695
696
697
698
699
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        BitwiseOrBySelf,
        BitwiseOrByZero,
    )

    return (BitwiseOrByZero(), BitwiseOrBySelf())

OrOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs bitwise OR on registers rs1 and rs2 and place the result in rd.

x[rd] = x[rs1] | x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
702
703
704
705
706
707
708
709
710
711
712
713
714
@irdl_op_definition
class OrOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs bitwise OR on registers rs1 and rs2 and place the result in rd.

    x[rd] = x[rs1] | x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#or).
    """

    name = "riscv.or"

    traits = traits_def(BitwiseOrHasCanonicalizationPatternsTrait())

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

traits = traits_def(BitwiseOrHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

BitwiseXorHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
717
718
719
720
721
722
723
724
725
class BitwiseXorHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            BitwiseXorByZero,
            XorBySelf,
        )

        return (XorBySelf(), BitwiseXorByZero())

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
718
719
720
721
722
723
724
725
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        BitwiseXorByZero,
        XorBySelf,
    )

    return (XorBySelf(), BitwiseXorByZero())

XorOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs bitwise XOR on registers rs1 and rs2 and place the result in rd.

x[rd] = x[rs1] ^ x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
728
729
730
731
732
733
734
735
736
737
738
739
740
@irdl_op_definition
class XorOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs bitwise XOR on registers rs1 and rs2 and place the result in rd.

    x[rd] = x[rs1] ^ x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#xor).
    """

    name = "riscv.xor"

    traits = traits_def(BitwiseXorHasCanonicalizationPatternsTrait())

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

traits = traits_def(BitwiseXorHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

SllOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs logical left shift on the value in register rs1 by the shift amount held in the lower 5 bits of register rs2.

x[rd] = x[rs1] << x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
743
744
745
746
747
748
749
750
751
752
753
754
@irdl_op_definition
class SllOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs logical left shift on the value in register rs1 by the shift amount
    held in the lower 5 bits of register rs2.

    x[rd] = x[rs1] << x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sll).
    """

    name = "riscv.sll"

name = 'riscv.sll' class-attribute instance-attribute

SrlOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Logical right shift on the value in register rs1 by the shift amount held in the lower 5 bits of register rs2.

x[rd] = x[rs1] >>u x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
757
758
759
760
761
762
763
764
765
766
767
768
@irdl_op_definition
class SrlOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Logical right shift on the value in register rs1 by the shift amount held
    in the lower 5 bits of register rs2.

    x[rd] = x[rs1] >>u x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#srl).
    """

    name = "riscv.srl"

name = 'riscv.srl' class-attribute instance-attribute

SubOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
771
772
773
774
775
776
777
778
779
780
class SubOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            SubAddi,
            SubBySelf,
            SubImmediates,
        )

        return (SubImmediates(), SubAddi(), SubBySelf())

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
772
773
774
775
776
777
778
779
780
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        SubAddi,
        SubBySelf,
        SubImmediates,
    )

    return (SubImmediates(), SubAddi(), SubBySelf())

SubOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Subtracts the registers rs1 and rs2 and stores the result in rd. Arithmetic overflow is ignored and the result is simply the low XLEN bits of the result.

x[rd] = x[rs1] - x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
783
784
785
786
787
788
789
790
791
792
793
794
795
796
@irdl_op_definition
class SubOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Subtracts the registers rs1 and rs2 and stores the result in rd.
    Arithmetic overflow is ignored and the result is simply the low XLEN bits of the result.

    x[rd] = x[rs1] - x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sub).
    """

    name = "riscv.sub"

    traits = traits_def(SubOpHasCanonicalizationPatternsTrait())

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

traits = traits_def(SubOpHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

SraOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs arithmetic right shift on the value in register rs1 by the shift amount held in the lower 5 bits of register rs2.

x[rd] = x[rs1] >>s x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
799
800
801
802
803
804
805
806
807
808
809
810
@irdl_op_definition
class SraOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs arithmetic right shift on the value in register rs1 by the shift amount held
    in the lower 5 bits of register rs2.

    x[rd] = x[rs1] >>s x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sub).
    """

    name = "riscv.sra"

name = 'riscv.sra' class-attribute instance-attribute

NopOp dataclass

Bases: NullaryOperation

Does not change any user-visible state, except for advancing the pc register. Canonical nop is encoded as addi x0, x0, 0.

Source code in xdsl/dialects/riscv/ops.py
813
814
815
816
817
818
819
820
@irdl_op_definition
class NopOp(NullaryOperation):
    """
    Does not change any user-visible state, except for advancing the pc register.
    Canonical nop is encoded as addi x0, x0, 0.
    """

    name = "riscv.nop"

name = 'riscv.nop' class-attribute instance-attribute

JalOp dataclass

Bases: RdImmJumpOperation

Jump to address and place return address in rd.

jal mylabel is a pseudoinstruction for jal ra, mylabel

x[rd] = pc+4; pc += sext(offset)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
830
831
832
833
834
835
836
837
838
839
840
841
842
@irdl_op_definition
class JalOp(RdImmJumpOperation):
    """
    Jump to address and place return address in rd.

    jal mylabel is a pseudoinstruction for jal ra, mylabel

    x[rd] = pc+4; pc += sext(offset)

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#jal).
    """

    name = "riscv.jal"

name = 'riscv.jal' class-attribute instance-attribute

JOp

Bases: RdImmJumpOperation

A pseudo-instruction, for unconditional jumps you don't expect to return from. Is equivalent to JalOp with rd = x0. Used to be a part of the spec, removed in 2.0.

Source code in xdsl/dialects/riscv/ops.py
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
@irdl_op_definition
class JOp(RdImmJumpOperation):
    """
    A pseudo-instruction, for unconditional jumps you don't expect to return from.
    Is equivalent to JalOp with `rd` = `x0`.
    Used to be a part of the spec, removed in 2.0.
    """

    name = "riscv.j"

    def __init__(
        self,
        immediate: int | IntegerAttr[SI20] | str | LabelAttr,
        *,
        comment: str | StringAttr | None = None,
    ):
        super().__init__(immediate, rd=Registers.ZERO, comment=comment)

    def assembly_line_args(self) -> tuple[AssemblyInstructionArg, ...]:
        # J op is a special case of JalOp with zero return register
        return (self.immediate,)

name = 'riscv.j' class-attribute instance-attribute

__init__(immediate: int | IntegerAttr[SI20] | str | LabelAttr, *, comment: str | StringAttr | None = None)

Source code in xdsl/dialects/riscv/ops.py
855
856
857
858
859
860
861
def __init__(
    self,
    immediate: int | IntegerAttr[SI20] | str | LabelAttr,
    *,
    comment: str | StringAttr | None = None,
):
    super().__init__(immediate, rd=Registers.ZERO, comment=comment)

assembly_line_args() -> tuple[AssemblyInstructionArg, ...]

Source code in xdsl/dialects/riscv/ops.py
863
864
865
def assembly_line_args(self) -> tuple[AssemblyInstructionArg, ...]:
    # J op is a special case of JalOp with zero return register
    return (self.immediate,)

JalrOp dataclass

Bases: RdRsImmJumpOperation

Jump to address and place return address in rd.

t = pc+4
pc = (x[rs1] + sext(offset)) & ~1
x[rd] = t

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
@irdl_op_definition
class JalrOp(RdRsImmJumpOperation):
    """
    Jump to address and place return address in rd.

    ```C
    t = pc+4
    pc = (x[rs1] + sext(offset)) & ~1
    x[rd] = t
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#jalr).
    """

    name = "riscv.jalr"

name = 'riscv.jalr' class-attribute instance-attribute

ReturnOp dataclass

Bases: NullaryOperation

Pseudo-op for returning from subroutine.

Equivalent to jalr x0, x1, 0

Source code in xdsl/dialects/riscv/ops.py
885
886
887
888
889
890
891
892
893
894
895
@irdl_op_definition
class ReturnOp(NullaryOperation):
    """
    Pseudo-op for returning from subroutine.

    Equivalent to `jalr x0, x1, 0`
    """

    name = "riscv.ret"

    traits = traits_def(IsTerminator())

name = 'riscv.ret' class-attribute instance-attribute

traits = traits_def(IsTerminator()) class-attribute instance-attribute

BeqOp dataclass

Bases: RsRsOffIntegerOperation

Take the branch if registers rs1 and rs2 are equal.

if (x[rs1] == x[rs2]) pc += sext(offset)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
901
902
903
904
905
906
907
908
909
910
911
912
913
@irdl_op_definition
class BeqOp(RsRsOffIntegerOperation):
    """
    Take the branch if registers rs1 and rs2 are equal.

    ```C
    if (x[rs1] == x[rs2]) pc += sext(offset)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#beq).
    """

    name = "riscv.beq"

name = 'riscv.beq' class-attribute instance-attribute

BneOp dataclass

Bases: RsRsOffIntegerOperation

Take the branch if registers rs1 and rs2 are not equal.

if (x[rs1] != x[rs2]) pc += sext(offset)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
916
917
918
919
920
921
922
923
924
925
926
927
928
@irdl_op_definition
class BneOp(RsRsOffIntegerOperation):
    """
    Take the branch if registers rs1 and rs2 are not equal.

    ```C
    if (x[rs1] != x[rs2]) pc += sext(offset)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#bne).
    """

    name = "riscv.bne"

name = 'riscv.bne' class-attribute instance-attribute

BltOp dataclass

Bases: RsRsOffIntegerOperation

Take the branch if registers rs1 is less than rs2, using signed comparison.

if (x[rs1] <s x[rs2]) pc += sext(offset)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
931
932
933
934
935
936
937
938
939
940
941
942
943
@irdl_op_definition
class BltOp(RsRsOffIntegerOperation):
    """
    Take the branch if registers rs1 is less than rs2, using signed comparison.

    ```C
    if (x[rs1] <s x[rs2]) pc += sext(offset)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#blt).
    """

    name = "riscv.blt"

name = 'riscv.blt' class-attribute instance-attribute

BgeOp dataclass

Bases: RsRsOffIntegerOperation

Take the branch if registers rs1 is greater than or equal to rs2, using signed comparison.

if (x[rs1] >=s x[rs2]) pc += sext(offset)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
946
947
948
949
950
951
952
953
954
955
956
957
958
@irdl_op_definition
class BgeOp(RsRsOffIntegerOperation):
    """
    Take the branch if registers rs1 is greater than or equal to rs2, using signed comparison.

    ```C
    if (x[rs1] >=s x[rs2]) pc += sext(offset)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#bge).
    """

    name = "riscv.bge"

name = 'riscv.bge' class-attribute instance-attribute

BltuOp dataclass

Bases: RsRsOffIntegerOperation

Take the branch if registers rs1 is less than rs2, using unsigned comparison.

if (x[rs1] <u x[rs2]) pc += sext(offset)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
961
962
963
964
965
966
967
968
969
970
971
972
973
@irdl_op_definition
class BltuOp(RsRsOffIntegerOperation):
    """
    Take the branch if registers rs1 is less than rs2, using unsigned comparison.

    ```C
    if (x[rs1] <u x[rs2]) pc += sext(offset)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#bltu).
    """

    name = "riscv.bltu"

name = 'riscv.bltu' class-attribute instance-attribute

BgeuOp dataclass

Bases: RsRsOffIntegerOperation

Take the branch if registers rs1 is greater than or equal to rs2, using unsigned comparison.

if (x[rs1] >=u x[rs2]) pc += sext(offset)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
976
977
978
979
980
981
982
983
984
985
986
987
988
@irdl_op_definition
class BgeuOp(RsRsOffIntegerOperation):
    """
    Take the branch if registers rs1 is greater than or equal to rs2, using unsigned comparison.

    ```C
    if (x[rs1] >=u x[rs2]) pc += sext(offset)
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#bgeu).
    """

    name = "riscv.bgeu"

name = 'riscv.bgeu' class-attribute instance-attribute

LbOp dataclass

Bases: RdRsImmIntegerOperation

Loads a 8-bit value from memory and sign-extends this to XLEN bits before storing it in register rd.

x[rd] = sext(M[x[rs1] + sext(offset)][7:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
@irdl_op_definition
class LbOp(RdRsImmIntegerOperation):
    """
    Loads a 8-bit value from memory and sign-extends this to XLEN bits before
    storing it in register rd.

    ```C
    x[rd] = sext(M[x[rs1] + sext(offset)][7:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#lb).
    """

    name = "riscv.lb"

    traits = traits_def(MemoryReadEffect())

name = 'riscv.lb' class-attribute instance-attribute

traits = traits_def(MemoryReadEffect()) class-attribute instance-attribute

LbuOp dataclass

Bases: RdRsImmIntegerOperation

Loads a 8-bit value from memory and zero-extends this to XLEN bits before storing it in register rd.

x[rd] = M[x[rs1] + sext(offset)][7:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
@irdl_op_definition
class LbuOp(RdRsImmIntegerOperation):
    """
    Loads a 8-bit value from memory and zero-extends this to XLEN bits before
    storing it in register rd.

    ```C
    x[rd] = M[x[rs1] + sext(offset)][7:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#lbu).
    """

    name = "riscv.lbu"

    traits = traits_def(MemoryReadEffect())

name = 'riscv.lbu' class-attribute instance-attribute

traits = traits_def(MemoryReadEffect()) class-attribute instance-attribute

LhOp dataclass

Bases: RdRsImmIntegerOperation

Loads a 16-bit value from memory and sign-extends this to XLEN bits before storing it in register rd.

x[rd] = sext(M[x[rs1] + sext(offset)][15:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
@irdl_op_definition
class LhOp(RdRsImmIntegerOperation):
    """
    Loads a 16-bit value from memory and sign-extends this to XLEN bits before
    storing it in register rd.

    ```C
    x[rd] = sext(M[x[rs1] + sext(offset)][15:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#lh).
    """

    name = "riscv.lh"

    traits = traits_def(MemoryReadEffect())

name = 'riscv.lh' class-attribute instance-attribute

traits = traits_def(MemoryReadEffect()) class-attribute instance-attribute

LhuOp dataclass

Bases: RdRsImmIntegerOperation

Loads a 16-bit value from memory and zero-extends this to XLEN bits before storing it in register rd.

x[rd] = M[x[rs1] + sext(offset)][15:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
@irdl_op_definition
class LhuOp(RdRsImmIntegerOperation):
    """
    Loads a 16-bit value from memory and zero-extends this to XLEN bits before
    storing it in register rd.

    ```C
    x[rd] = M[x[rs1] + sext(offset)][15:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#lhu).
    """

    name = "riscv.lhu"

    traits = traits_def(MemoryReadEffect())

name = 'riscv.lhu' class-attribute instance-attribute

traits = traits_def(MemoryReadEffect()) class-attribute instance-attribute

LwOpHasCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
1068
1069
1070
1071
1072
1073
1074
1075
class LwOpHasCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            LoadWordWithKnownOffset,
        )

        return (LoadWordWithKnownOffset(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
1069
1070
1071
1072
1073
1074
1075
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        LoadWordWithKnownOffset,
    )

    return (LoadWordWithKnownOffset(),)

LwOp dataclass

Bases: RdRsImmIntegerOperation

Loads a 32-bit value from memory and sign-extends this to XLEN bits before storing it in register rd.

x[rd] = sext(M[x[rs1] + sext(offset)][31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
@irdl_op_definition
class LwOp(RdRsImmIntegerOperation):
    """
    Loads a 32-bit value from memory and sign-extends this to XLEN bits before
    storing it in register rd.

    ```C
    x[rd] = sext(M[x[rs1] + sext(offset)][31:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#lw).
    """

    name = "riscv.lw"

    traits = traits_def(LwOpHasCanonicalizationPatternTrait(), MemoryReadEffect())

    def assembly_line(self) -> str | None:
        instruction_name = self.assembly_instruction_name()
        value = assembly_arg_str(self.rd)
        imm = assembly_arg_str(self.immediate)
        offset = assembly_arg_str(self.rs1)
        return AssemblyPrinter.assembly_line(
            instruction_name, f"{value}, {imm}({offset})", self.comment
        )

name = 'riscv.lw' class-attribute instance-attribute

traits = traits_def(LwOpHasCanonicalizationPatternTrait(), MemoryReadEffect()) class-attribute instance-attribute

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
1095
1096
1097
1098
1099
1100
1101
1102
def assembly_line(self) -> str | None:
    instruction_name = self.assembly_instruction_name()
    value = assembly_arg_str(self.rd)
    imm = assembly_arg_str(self.immediate)
    offset = assembly_arg_str(self.rs1)
    return AssemblyPrinter.assembly_line(
        instruction_name, f"{value}, {imm}({offset})", self.comment
    )

SbOp dataclass

Bases: RsRsImmIntegerOperation

Store 8-bit, values from the low bits of register rs2 to memory.

M[x[rs1] + sext(offset)] = x[rs2][7:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
@irdl_op_definition
class SbOp(RsRsImmIntegerOperation):
    """
    Store 8-bit, values from the low bits of register rs2 to memory.

    ```C
    M[x[rs1] + sext(offset)] = x[rs2][7:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sb).
    """

    name = "riscv.sb"

name = 'riscv.sb' class-attribute instance-attribute

ShOp dataclass

Bases: RsRsImmIntegerOperation

Store 16-bit, values from the low bits of register rs2 to memory.

M[x[rs1] + sext(offset)] = x[rs2][15:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
@irdl_op_definition
class ShOp(RsRsImmIntegerOperation):
    """
    Store 16-bit, values from the low bits of register rs2 to memory.

    ```C
    M[x[rs1] + sext(offset)] = x[rs2][15:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sh).

    """

    name = "riscv.sh"

name = 'riscv.sh' class-attribute instance-attribute

SwOpHasCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
1136
1137
1138
1139
1140
1141
1142
1143
class SwOpHasCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            StoreWordWithKnownOffset,
        )

        return (StoreWordWithKnownOffset(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
1137
1138
1139
1140
1141
1142
1143
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        StoreWordWithKnownOffset,
    )

    return (StoreWordWithKnownOffset(),)

SwOp dataclass

Bases: RsRsImmIntegerOperation

Store 32-bit, values from the low bits of register rs2 to memory.

M[x[rs1] + sext(offset)] = x[rs2][31:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
@irdl_op_definition
class SwOp(RsRsImmIntegerOperation):
    """
    Store 32-bit, values from the low bits of register rs2 to memory.

    ```C
    M[x[rs1] + sext(offset)] = x[rs2][31:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#sw).
    """

    name = "riscv.sw"

    traits = traits_def(SwOpHasCanonicalizationPatternTrait())

    def assembly_line(self) -> str | None:
        instruction_name = self.assembly_instruction_name()
        value = assembly_arg_str(self.rs2)
        imm = assembly_arg_str(self.immediate)
        offset = assembly_arg_str(self.rs1)
        return AssemblyPrinter.assembly_line(
            instruction_name, f"{value}, {imm}({offset})", self.comment
        )

name = 'riscv.sw' class-attribute instance-attribute

traits = traits_def(SwOpHasCanonicalizationPatternTrait()) class-attribute instance-attribute

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
1162
1163
1164
1165
1166
1167
1168
1169
def assembly_line(self) -> str | None:
    instruction_name = self.assembly_instruction_name()
    value = assembly_arg_str(self.rs2)
    imm = assembly_arg_str(self.immediate)
    offset = assembly_arg_str(self.rs1)
    return AssemblyPrinter.assembly_line(
        instruction_name, f"{value}, {imm}({offset})", self.comment
    )

CsrrwOp dataclass

Bases: CsrReadWriteOperation

Atomically swaps values in the CSRs and integer registers. CSRRW reads the old value of the CSR, zero-extends the value to XLEN bits, then writes it to integer register rd. The initial value in rs1 is written to the CSR. If the 'writeonly' attribute evaluates to False, then the instruction shall not read the CSR and shall not cause any of the side effects that might occur on a CSR read; in this case rd must be allocated to x0.

t = CSRs[csr]; CSRs[csr] = x[rs1]; x[rd] = t

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
@irdl_op_definition
class CsrrwOp(CsrReadWriteOperation):
    """
    Atomically swaps values in the CSRs and integer registers.
    CSRRW reads the old value of the CSR, zero-extends the value to XLEN bits,
    then writes it to integer register rd. The initial value in rs1 is written
    to the CSR. If the 'writeonly' attribute evaluates to False, then the
    instruction shall not read the CSR and shall not cause any of the side effects
    that might occur on a CSR read; in this case rd *must be allocated to x0*.

    t = CSRs[csr]; CSRs[csr] = x[rs1]; x[rd] = t

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#csrrw).
    """

    name = "riscv.csrrw"

name = 'riscv.csrrw' class-attribute instance-attribute

CsrrsOp dataclass

Bases: CsrBitwiseOperation

Reads the value of the CSR, zero-extends the value to XLEN bits, and writes it to integer register rd. The initial value in integer register rs1 is treated as a bit mask that specifies bit positions to be set in the CSR. Any bit that is high in rs1 will cause the corresponding bit to be set in the CSR, if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might have side effects when written).

If the 'readonly' attribute evaluates to True, then the instruction will not write to the CSR at all, and so shall not cause any of the side effects that might otherwise occur on a CSR write, such as raising illegal instruction exceptions on accesses to read-only CSRs. Note that if rs1 specifies a register holding a zero value other than x0, the instruction will still attempt to write the unmodified value back to the CSR and will cause any attendant side effects.

t = CSRs[csr]; CSRs[csr] = t | x[rs1]; x[rd] = t

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
@irdl_op_definition
class CsrrsOp(CsrBitwiseOperation):
    """
    Reads the value of the CSR, zero-extends the value to XLEN bits, and writes
    it to integer register rd. The initial value in integer register rs1 is treated
    as a bit mask that specifies bit positions to be set in the CSR.
    Any bit that is high in rs1 will cause the corresponding bit to be set in the CSR,
    if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might
    have side effects when written).

    If the 'readonly' attribute evaluates to True, then the instruction will not write
    to the CSR at all, and so shall not cause any of the side effects that might otherwise
    occur on a CSR write, such as raising illegal instruction exceptions on accesses to
    read-only CSRs. Note that if rs1 specifies a register holding a zero value other than x0,
    the instruction will still attempt to write the unmodified value back to the CSR and will
    cause any attendant side effects.

    t = CSRs[csr]; CSRs[csr] = t | x[rs1]; x[rd] = t

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#csrrs).
    """

    name = "riscv.csrrs"

name = 'riscv.csrrs' class-attribute instance-attribute

CsrrcOp dataclass

Bases: CsrBitwiseOperation

Reads the value of the CSR, zero-extends the value to XLEN bits, and writes it to integer register rd. The initial value in integer register rs1 is treated as a bit mask that specifies bit positions to be cleared in the CSR. Any bit that is high in rs1 will cause the corresponding bit to be cleared in the CSR, if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might have side effects when written).

If the 'readonly' attribute evaluates to True, then the instruction will not write to the CSR at all, and so shall not cause any of the side effects that might otherwise occur on a CSR write, such as raising illegal instruction exceptions on accesses to read-only CSRs. Note that if rs1 specifies a register holding a zero value other than x0, the instruction will still attempt to write the unmodified value back to the CSR and will cause any attendant side effects.

t = CSRs[csr]; CSRs[csr] = t &~x[rs1]; x[rd] = t

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
@irdl_op_definition
class CsrrcOp(CsrBitwiseOperation):
    """
    Reads the value of the CSR, zero-extends the value to XLEN bits, and writes
    it to integer register rd. The initial value in integer register rs1 is treated
    as a bit mask that specifies bit positions to be cleared in the CSR.
    Any bit that is high in rs1 will cause the corresponding bit to be cleared in the CSR,
    if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might
    have side effects when written).

    If the 'readonly' attribute evaluates to True, then the instruction will not write
    to the CSR at all, and so shall not cause any of the side effects that might otherwise
    occur on a CSR write, such as raising illegal instruction exceptions on accesses to
    read-only CSRs. Note that if rs1 specifies a register holding a zero value other than x0,
    the instruction will still attempt to write the unmodified value back to the CSR and will
    cause any attendant side effects.

    t = CSRs[csr]; CSRs[csr] = t &~x[rs1]; x[rd] = t

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#csrrc).
    """

    name = "riscv.csrrc"

name = 'riscv.csrrc' class-attribute instance-attribute

CsrrwiOp dataclass

Bases: CsrReadWriteImmOperation

Update the CSR using an XLEN-bit value obtained by zero-extending the 'immediate' attribute. If the 'writeonly' attribute evaluates to False, then the instruction shall not read the CSR and shall not cause any of the side effects that might occur on a CSR read; in this case rd must be allocated to x0.

x[rd] = CSRs[csr]; CSRs[csr] = zimm

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
@irdl_op_definition
class CsrrwiOp(CsrReadWriteImmOperation):
    """
    Update the CSR using an XLEN-bit value obtained by zero-extending the
    'immediate' attribute.
    If the 'writeonly' attribute evaluates to False, then the
    instruction shall not read the CSR and shall not cause any of the side effects
    that might occur on a CSR read; in this case rd *must be allocated to x0*.

    x[rd] = CSRs[csr]; CSRs[csr] = zimm

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#csrrwi).
    """

    name = "riscv.csrrwi"

name = 'riscv.csrrwi' class-attribute instance-attribute

CsrrsiOp dataclass

Bases: CsrBitwiseImmOperation

Reads the value of the CSR, zero-extends the value to XLEN bits, and writes it to integer register rd. The value in the 'immediate' attribute is treated as a bit mask that specifies bit positions to be set in the CSR. Any bit that is high in it will cause the corresponding bit to be set in the CSR, if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might have side effects when written).

If the 'immediate' attribute value is zero, then the instruction will not write to the CSR at all, and so shall not cause any of the side effects that might otherwise occur on a CSR write, such as raising illegal instruction exceptions on accesses to read-only CSRs.

t = CSRs[csr]; CSRs[csr] = t | zimm; x[rd] = t

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
@irdl_op_definition
class CsrrsiOp(CsrBitwiseImmOperation):
    """
    Reads the value of the CSR, zero-extends the value to XLEN bits, and writes
    it to integer register rd. The value in the 'immediate' attribute is treated
    as a bit mask that specifies bit positions to be set in the CSR.
    Any bit that is high in it will cause the corresponding bit to be set in the CSR,
    if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might
    have side effects when written).

    If the 'immediate' attribute value is zero, then the instruction will not write
    to the CSR at all, and so shall not cause any of the side effects that might otherwise
    occur on a CSR write, such as raising illegal instruction exceptions on accesses to
    read-only CSRs.

    t = CSRs[csr]; CSRs[csr] = t | zimm; x[rd] = t

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#csrrsi).
    """

    name = "riscv.csrrsi"

name = 'riscv.csrrsi' class-attribute instance-attribute

CsrrciOp dataclass

Bases: CsrBitwiseImmOperation

Reads the value of the CSR, zero-extends the value to XLEN bits, and writes it to integer register rd. The value in the 'immediate' attribute is treated as a bit mask that specifies bit positions to be cleared in the CSR. Any bit that is high in rs1 will cause the corresponding bit to be cleared in the CSR, if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might have side effects when written).

If the 'immediate' attribute value is zero, then the instruction will not write to the CSR at all, and so shall not cause any of the side effects that might otherwise occur on a CSR write, such as raising illegal instruction exceptions on accesses to read-only CSRs.

t = CSRs[csr]; CSRs[csr] = t &~zimm; x[rd] = t

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
@irdl_op_definition
class CsrrciOp(CsrBitwiseImmOperation):
    """
    Reads the value of the CSR, zero-extends the value to XLEN bits, and writes
    it to integer register rd.  The value in the 'immediate' attribute is treated
    as a bit mask that specifies bit positions to be cleared in the CSR.
    Any bit that is high in rs1 will cause the corresponding bit to be cleared in the CSR,
    if that CSR bit is writable. Other bits in the CSR are unaffected (though CSRs might
    have side effects when written).

    If the 'immediate' attribute value is zero, then the instruction will not write
    to the CSR at all, and so shall not cause any of the side effects that might otherwise
    occur on a CSR write, such as raising illegal instruction exceptions on accesses to
    read-only CSRs.

    t = CSRs[csr]; CSRs[csr] = t &~zimm; x[rd] = t

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#csrrci).
    """

    name = "riscv.csrrci"

name = 'riscv.csrrci' class-attribute instance-attribute

MulOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
1315
1316
1317
1318
1319
1320
1321
1322
class MulOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            MultiplyImmediates,
        )

        return (MultiplyImmediates(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
1316
1317
1318
1319
1320
1321
1322
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        MultiplyImmediates,
    )

    return (MultiplyImmediates(),)

MulOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs an XLEN-bit × XLEN-bit multiplication of signed rs1 by signed rs2 and places the lower XLEN bits in the destination register. x[rd] = x[rs1] * x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
@irdl_op_definition
class MulOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs an XLEN-bit × XLEN-bit multiplication of signed rs1 by signed rs2
    and places the lower XLEN bits in the destination register.
    x[rd] = x[rs1] * x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvi.html#add).
    """

    name = "riscv.mul"

    traits = traits_def(MulOpHasCanonicalizationPatternsTrait(), AlwaysSpeculatable())

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

traits = traits_def(MulOpHasCanonicalizationPatternsTrait(), AlwaysSpeculatable()) class-attribute instance-attribute

MulhOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs an XLEN-bit × XLEN-bit multiplication of signed rs1 by signed rs2 and places the upper XLEN bits in the destination register. x[rd] = (x[rs1] s×s x[rs2]) >>s XLEN

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
@irdl_op_definition
class MulhOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs an XLEN-bit × XLEN-bit multiplication of signed rs1 by signed rs2
    and places the upper XLEN bits in the destination register.
    x[rd] = (x[rs1] s×s x[rs2]) >>s XLEN

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#mulh).
    """

    name = "riscv.mulh"

name = 'riscv.mulh' class-attribute instance-attribute

MulhsuOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs an XLEN-bit × XLEN-bit multiplication of signed rs1 by unsigned rs2 and places the upper XLEN bits in the destination register. x[rd] = (x[rs1] s × x[rs2]) >>s XLEN

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
@irdl_op_definition
class MulhsuOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs an XLEN-bit × XLEN-bit multiplication of signed rs1 by unsigned rs2
    and places the upper XLEN bits in the destination register.
    x[rd] = (x[rs1] s × x[rs2]) >>s XLEN

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#mulhsu).
    """

    name = "riscv.mulhsu"

name = 'riscv.mulhsu' class-attribute instance-attribute

MulhuOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs an XLEN-bit × XLEN-bit multiplication of unsigned rs1 by unsigned rs2 and places the upper XLEN bits in the destination register. x[rd] = (x[rs1] u × x[rs2]) >>u XLEN

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
@irdl_op_definition
class MulhuOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs an XLEN-bit × XLEN-bit multiplication of unsigned rs1 by unsigned rs2
    and places the upper XLEN bits in the destination register.
    x[rd] = (x[rs1] u × x[rs2]) >>u XLEN

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#mulhu).
    """

    name = "riscv.mulhu"

name = 'riscv.mulhu' class-attribute instance-attribute

MulwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs an 32-bit × 32-bit multiplication of signed rs1 by signed rs2.

x[rd] = (x[rs1] s × x[rs2]) >>s XLEN

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
@irdl_op_definition
class MulwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs an 32-bit × 32-bit multiplication of signed rs1 by signed rs2.
    ```
    x[rd] = (x[rs1] s × x[rs2]) >>s XLEN
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#mulw).
    """

    name = "riscv.mulw"

name = 'riscv.mulw' class-attribute instance-attribute

DivOpHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
1393
1394
1395
1396
1397
1398
1399
1400
class DivOpHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            DivideByOneIdentity,
        )

        return (DivideByOneIdentity(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
1394
1395
1396
1397
1398
1399
1400
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        DivideByOneIdentity,
    )

    return (DivideByOneIdentity(),)

DivOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an XLEN bits by XLEN bits signed integer division of rs1 by rs2, rounding towards zero. x[rd] = x[rs1] /s x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
@irdl_op_definition
class DivOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an XLEN bits by XLEN bits signed integer division of rs1 by rs2,
    rounding towards zero.
    x[rd] = x[rs1] /s x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#div).
    """

    name = "riscv.div"
    traits = traits_def(DivOpHasCanonicalizationPatternsTrait(), AlwaysSpeculatable())

name = 'riscv.div' class-attribute instance-attribute

traits = traits_def(DivOpHasCanonicalizationPatternsTrait(), AlwaysSpeculatable()) class-attribute instance-attribute

DivuOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an XLEN bits by XLEN bits unsigned integer division of rs1 by rs2, rounding towards zero. x[rd] = x[rs1] /u x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
@irdl_op_definition
class DivuOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an XLEN bits by XLEN bits unsigned integer division of rs1 by rs2,
    rounding towards zero.
    x[rd] = x[rs1] /u x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#divu).
    """

    name = "riscv.divu"

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

DivuwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an 32 bits by 32 bits unsigned integer division of rs1 by rs2.

x[rd] = sext(x[rs1][31:0] /u x[rs2][31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
@irdl_op_definition
class DivuwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an 32 bits by 32 bits unsigned integer division of rs1 by rs2.
    ```
    x[rd] = sext(x[rs1][31:0] /u x[rs2][31:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rv64m.html#divuw).
    """

    name = "riscv.divuw"

name = 'riscv.divuw' class-attribute instance-attribute

DivwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an 32 bits by 32 bits signed integer division of rs1 by rs2.

x[rd] = sext(x[rs1][31:0] /s x[rs2][31:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
@irdl_op_definition
class DivwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an 32 bits by 32 bits signed integer division of rs1 by rs2.
    ```
    x[rd] = sext(x[rs1][31:0] /s x[rs2][31:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#divw).
    """

    name = "riscv.divw"

name = 'riscv.divw' class-attribute instance-attribute

RemOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an XLEN bits by XLEN bits signed integer reminder of rs1 by rs2. x[rd] = x[rs1] %s x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
@irdl_op_definition
class RemOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an XLEN bits by XLEN bits signed integer reminder of rs1 by rs2.
    x[rd] = x[rs1] %s x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#rem).
    """

    name = "riscv.rem"

name = 'riscv.rem' class-attribute instance-attribute

RemuOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an XLEN bits by XLEN bits unsigned integer reminder of rs1 by rs2. x[rd] = x[rs1] %u x[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
@irdl_op_definition
class RemuOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an XLEN bits by XLEN bits unsigned integer reminder of rs1 by rs2.
    x[rd] = x[rs1] %u x[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvm.html#remu).
    """

    name = "riscv.remu"

name = 'riscv.remu' class-attribute instance-attribute

RemuwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an 32 bits by 32 bits unsigned integer reminder of rs1 by rs2.

x[rd] = sext(x[rs1][31:0] %u x[rs2][31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
@irdl_op_definition
class RemuwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an 32 bits by 32 bits unsigned integer reminder of rs1 by rs2.
    ```
    x[rd] = sext(x[rs1][31:0] %u x[rs2][31:0])
    ```
    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rv64m.html#remuw).
    """

    name = "riscv.remuw"

name = 'riscv.remuw' class-attribute instance-attribute

RemwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Perform an 32 bits by 32 bits signed integer reminder of rs1 by rs2.

x[rd] = sext(x[rs1][31:0] %s x[rs2][31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
@irdl_op_definition
class RemwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Perform an 32 bits by 32 bits signed integer reminder of rs1 by rs2.
    ```
    x[rd] = sext(x[rs1][31:0] %s x[rs2][31:0])
    ```
    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rv64m.html#remw).
    """

    name = "riscv.remw"

name = 'riscv.remw' class-attribute instance-attribute

RolOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs a rotate left of rs1 by the amount in least-significant log2(XLEN) bits of rs2.

let shamt = if   xlen == 32
                then x[rs2][4..0]
                else x[rs2][5..0];
let result = (x[rs1] << shamt) | (x[rs2] >> (xlen - shamt));
x[rd] = result;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
@irdl_op_definition
class RolOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs a rotate left of rs1 by the amount in least-significant log2(XLEN) bits of rs2.
    ```
    let shamt = if   xlen == 32
                    then x[rs2][4..0]
                    else x[rs2][5..0];
    let result = (x[rs1] << shamt) | (x[rs2] >> (xlen - shamt));
    x[rd] = result;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-rol).
    """

    name = "riscv.rol"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.rol' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

RorOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Performs a rotate right of rs1 by the amount in least-significant log2(XLEN) bits of rs2.

let shamt = if   xlen == 32
            then x[rs2][4..0]
            else x[rs2][5..0];
let result = (x[rs1] >> shamt) | (x[rs2] << (xlen - shamt));
x[rd] = result;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
@irdl_op_definition
class RorOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Performs a rotate right of rs1 by the amount in least-significant log2(XLEN) bits of rs2.
    ```
    let shamt = if   xlen == 32
                then x[rs2][4..0]
                else x[rs2][5..0];
    let result = (x[rs1] >> shamt) | (x[rs2] << (xlen - shamt));
    x[rd] = result;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-ror).
    """

    name = "riscv.ror"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.ror' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SextHOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

This instruction sign-extends the least-significant halfword in rs to XLEN by copying the most-significant bit in the halfword (i.e., bit 15) to all of the more-significant bits.

x[rd] = EXTS(x[rs][15..0]);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
@irdl_op_definition
class SextHOp(RdRsIntegerOperation[IntRegisterType]):
    """
    This instruction sign-extends the least-significant halfword in rs to XLEN by copying the
    most-significant bit in the halfword (i.e., bit 15) to all of the more-significant bits.
    ```
    x[rd] = EXTS(x[rs][15..0]);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sext_h).
    """

    name = "riscv.sext.h"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sext.h' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

ZextHOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

This instruction zero-extends the least-significant halfword of the source to XLEN by inserting 0’s into all of the bits more significant than 15.

x[rd] = EXTZ(x[rs][15..0]);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
@irdl_op_definition
class ZextHOp(RdRsIntegerOperation[IntRegisterType]):
    """
    This instruction zero-extends the least-significant halfword of the source to XLEN by inserting
    0’s into all of the bits more significant than 15.
    ```
    x[rd] = EXTZ(x[rs][15..0]);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-zext_h).
    """

    name = "riscv.zext.h"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.zext.h' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SextBOp dataclass

Bases: RdRsIntegerOperation[IntRegisterType]

This instruction sign-extends the least-significant byte in the source to XLEN by copying the most-significant bit in the byte (i.e., bit 7) to all of the more-significant bits.

X[rd] = EXTS(X[rs][7..0]);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
@irdl_op_definition
class SextBOp(RdRsIntegerOperation[IntRegisterType]):
    """
    This instruction sign-extends the least-significant byte in the source to XLEN by copying
    the most-significant bit in the byte (i.e., bit 7) to all of the more-significant bits.
    ```
    X[rd] = EXTS(X[rs][7..0]);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sext_b).
    """

    name = "riscv.sext.b"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sext.b' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BclrOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns rs1 with a single bit cleared at the index specified in rs2. The index is read from the lower log2(XLEN) bits of rs2.

let index = X(rs2) & (XLEN - 1);
X(rd) = X(rs1) & ~(1 << index)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
@irdl_op_definition
class BclrOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns rs1 with a single bit cleared at the index specified in rs2.
    The index is read from the lower log2(XLEN) bits of rs2.
    ```
    let index = X(rs2) & (XLEN - 1);
    X(rd) = X(rs1) & ~(1 << index)
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-bclr).
    """

    name = "riscv.bclr"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.bclr' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BclrIOp dataclass

Bases: RdRsImmBitManipOperation

This instruction returns rs1 with a single bit cleared at the index specified in shamt. The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding to shamt[5]=1 are reserved.

let index = shamt & (XLEN - 1);
X(rd) = X(rs1) & ~(1 << index)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
@irdl_op_definition
class BclrIOp(RdRsImmBitManipOperation):
    """
    This instruction returns rs1 with a single bit cleared at the index specified in shamt.
    The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding
    to shamt[5]=1 are reserved.
    ```
    let index = shamt & (XLEN - 1);
    X(rd) = X(rs1) & ~(1 << index)
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-bclri).
    """

    name = "riscv.bclri"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.bclri' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BextOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns a single bit extracted from rs1 at the index specified in rs2. The index is read from the lower log2(XLEN) bits of rs2.

let index = X(rs2) & (XLEN - 1);
X(rd) = (X(rs1) >> index) & 1;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
@irdl_op_definition
class BextOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns a single bit extracted from rs1 at the index specified in rs2.
    The index is read from the lower log2(XLEN) bits of rs2.
    ```
    let index = X(rs2) & (XLEN - 1);
    X(rd) = (X(rs1) >> index) & 1;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-bext).
    """

    name = "riscv.bext"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.bext' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BextIOp dataclass

Bases: RdRsImmBitManipOperation

This instruction returns a single bit extracted from rs1 at the index specified in rs2. The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding to shamt[5]=1 are reserved.

let index = shamt & (XLEN - 1);
X(rd) = (X(rs1) >> index) & 1;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
@irdl_op_definition
class BextIOp(RdRsImmBitManipOperation):
    """
    This instruction returns a single bit extracted from rs1 at the index specified in rs2.
    The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding
    to shamt[5]=1 are reserved.
    ```
    let index = shamt & (XLEN - 1);
    X(rd) = (X(rs1) >> index) & 1;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-bexti).
    """

    name = "riscv.bexti"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.bexti' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BinvOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns rs1 with a single bit inverted at the index specified in shamt. The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding to shamt[5]=1 are reserved.

let index = shamt & (XLEN - 1);
X(rd) = X(rs1) ^ (1 << index)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
@irdl_op_definition
class BinvOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns rs1 with a single bit inverted at the index specified in shamt.
    The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings
    corresponding to shamt[5]=1 are reserved.
    ```
    let index = shamt & (XLEN - 1);
    X(rd) = X(rs1) ^ (1 << index)
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-binvi).
    """

    name = "riscv.binv"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.binv' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BinvIOp dataclass

Bases: RdRsImmBitManipOperation

This instruction returns rs1 with a single bit cleared at the index specified in shamt. The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding to shamt[5]=1 are reserved.

let index = shamt & (XLEN - 1);
x[rd] = x[rs1] & ~(1 << index)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
@irdl_op_definition
class BinvIOp(RdRsImmBitManipOperation):
    """
    This instruction returns rs1 with a single bit cleared at the index specified in shamt. The index
    is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding
    to shamt[5]=1 are reserved.
    ```
    let index = shamt & (XLEN - 1);
    x[rd] = x[rs1] & ~(1 << index)
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-binvi).
    """

    name = "riscv.binvi"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.binvi' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BsetOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns rs1 with a single bit set at the index specified in rs2. The index is read from the lower log2(XLEN) bits of rs2.

let index = X(rs2) & (XLEN - 1);
X(rd) = X(rs1) | (1 << index)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
@irdl_op_definition
class BsetOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns rs1 with a single bit set at the index specified in rs2.
    The index is read from the lower log2(XLEN) bits of rs2.
    ```
    let index = X(rs2) & (XLEN - 1);
    X(rd) = X(rs1) | (1 << index)
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-bset).
    """

    name = "riscv.bset"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.bset' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

BsetIOp dataclass

Bases: RdRsImmBitManipOperation

This instruction returns rs1 with a single bit set at the index specified in shamt. The index is read from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding to shamt[5]=1 are reserved.

let index = shamt & (XLEN - 1);
x[rd] = x[rs1] | (1 << index)

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
@irdl_op_definition
class BsetIOp(RdRsImmBitManipOperation):
    """
    This instruction returns rs1 with a single bit set at the index specified in shamt. The index is read
    from the lower log2(XLEN) bits of shamt. For RV32, the encodings corresponding
    to shamt[5]=1 are reserved.
    ```
    let index = shamt & (XLEN - 1);
    x[rd] = x[rs1] | (1 << index)
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-bseti).
    """

    name = "riscv.bseti"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.bseti' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

RolwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs a rotate left on the least-significant word of rs1 by the amount in least-significant 5 bits of rs2. The resulting word value is sign-extended by copying bit 31 to all of the more-significant bits.

let rs1 = EXTZ(X(rs1)[31..0])
let shamt = X(rs2)[4..0];
let result = (rs1 << shamt) | (rs1 >> (32 - shamt));
X(rd) = EXTS(result);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
@irdl_op_definition
class RolwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs a rotate left on the least-significant word of rs1 by the amount in
    least-significant 5 bits of rs2. The resulting word value is sign-extended by copying bit 31
    to all of the more-significant bits.
    ```
    let rs1 = EXTZ(X(rs1)[31..0])
    let shamt = X(rs2)[4..0];
    let result = (rs1 << shamt) | (rs1 >> (32 - shamt));
    X(rd) = EXTS(result);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-rolw).
    """

    name = "riscv.rolw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.rolw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

RorwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs a rotate right on the least-significant word of rs1 by the amount in least-significant 5 bits of rs2. The resultant word is sign-extended by copying bit 31 to all of the more-significant bits.

let rs1 = EXTZ(X(rs1)[31..0])
let shamt = X(rs2)[4..0];
let result = (rs1 >> shamt) | (rs1 << (32 - shamt));
X(rd) = EXTS(result);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
@irdl_op_definition
class RorwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs a rotate right on the least-significant word of rs1 by the amount in
    least-significant 5 bits of rs2. The resultant word is sign-extended by copying bit 31 to all of
    the more-significant bits.
    ```
    let rs1 = EXTZ(X(rs1)[31..0])
    let shamt = X(rs2)[4..0];
    let result = (rs1 >> shamt) | (rs1 << (32 - shamt));
    X(rd) = EXTS(result);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-rorw).
    """

    name = "riscv.rorw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.rorw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

RoriOp dataclass

Bases: RdRsImmBitManipOperation

This instruction performs a rotate right of rs1 by the amount in the least-significant log2(XLEN) bits of shamt. For RV32, the encodings corresponding to shamt[5]=1 are reserved.

let shamt = if   xlen == 32
                then shamt[4..0]
                else shamt[5..0];
let result = (X(rs1) >> shamt) | (X(rs2) << (xlen - shamt));
X(rd) = result;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
@irdl_op_definition
class RoriOp(RdRsImmBitManipOperation):
    """
    This instruction performs a rotate right of rs1 by the amount in the least-significant
    log2(XLEN) bits of shamt. For RV32, the encodings corresponding to shamt[5]=1 are reserved.
    ```
    let shamt = if   xlen == 32
                    then shamt[4..0]
                    else shamt[5..0];
    let result = (X(rs1) >> shamt) | (X(rs2) << (xlen - shamt));
    X(rd) = result;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-rori).
    """

    name = "riscv.rori"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.rori' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

RoriwOp dataclass

Bases: RdRsImmBitManipOperation

This instruction performs a rotate right on the least-significant word of rs1 by the amount in the least-significant log2(XLEN) bits of shamt. The resulting word value is sign-extended by copying bit 31 to all of the more-significant bits.

let rs1 = EXTZ(X(rs1)[31..0];
let result = (rs1 >> shamt[4..0]) | (X(rs1) << (32 - shamt[4..0]));
X(rd) = EXTS(result[31..0]);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
@irdl_op_definition
class RoriwOp(RdRsImmBitManipOperation):
    """
    This instruction performs a rotate right on the least-significant word of rs1 by the amount in
    the least-significant log2(XLEN) bits of shamt. The resulting word value is sign-extended by
    copying bit 31 to all of the more-significant bits.
    ```
    let rs1 = EXTZ(X(rs1)[31..0];
    let result = (rs1 >> shamt[4..0]) | (X(rs1) << (32 - shamt[4..0]));
    X(rd) = EXTS(result[31..0]);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-roriw).
    """

    name = "riscv.roriw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.roriw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

AddUwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs an XLEN-wide addition between rs2 and the zero-extended least-significant word of rs1.

let base = X(rs2);
let index = EXTZ(X(rs1)[31..0]);
X(rd) = base + index;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
@irdl_op_definition
class AddUwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs an XLEN-wide addition between rs2 and the zero-extended least-significant
    word of rs1.
    ```
    let base = X(rs2);
    let index = EXTZ(X(rs1)[31..0]);
    X(rd) = base + index;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-add_uw).
    """

    name = "riscv.add.uw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.add.uw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

Sh1addOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction shifts rs1 to the left by 1 bit and adds it to rs2.

X(rd) = X(rs2) + (X(rs1) << 1);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
@irdl_op_definition
class Sh1addOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction shifts rs1 to the left by 1 bit and adds it to rs2.
    ```
    X(rd) = X(rs2) + (X(rs1) << 1);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sh1add).
    """

    name = "riscv.sh1add"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sh1add' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

Sh2addOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction shifts rs1 to the left by 2 places and adds it to rs2.

X(rd) = X(rs2) + (X(rs1) << 2);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
@irdl_op_definition
class Sh2addOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction shifts rs1 to the left by 2 places and adds it to rs2.
    ```
    X(rd) = X(rs2) + (X(rs1) << 2);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sh2add).
    """

    name = "riscv.sh2add"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sh2add' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

Sh3addOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction shifts rs1 to the left by 2 places and adds it to rs2.

X(rd) = X(rs2) + (X(rs1) << 3);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
@irdl_op_definition
class Sh3addOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction shifts rs1 to the left by 2 places and adds it to rs2.
    ```
    X(rd) = X(rs2) + (X(rs1) << 3);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sh3add).
    """

    name = "riscv.sh3add"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sh3add' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

Sh1addUwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs an XLEN-wide addition of two addends. The first addend is rs2. The second addend is the unsigned value formed by extracting the least-significant word of rs1 and shifting it left by 1 place.

let base = x[rs2];
let index = EXTZ(x[rs1][31..0]);
x[rd] = base + (index << 1);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
@irdl_op_definition
class Sh1addUwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs an XLEN-wide addition of two addends. The first addend is rs2.
    The second addend is the unsigned value formed by extracting the least-significant word of
    rs1 and shifting it left by 1 place.

    ```
    let base = x[rs2];
    let index = EXTZ(x[rs1][31..0]);
    x[rd] = base + (index << 1);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sh1add_uw).
    """

    name = "riscv.sh1add.uw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sh1add.uw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

Sh2addUwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs an XLEN-wide addition of two addends. The first addend is rs2. The second addend is the unsigned value formed by extracting the least-significant word of rs1 and shifting it left by 2 places.

let base = x[rs2];
let index = EXTZ(x[rs1][31..0]);
x[rd] = base + (index << 2);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
@irdl_op_definition
class Sh2addUwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs an XLEN-wide addition of two addends. The first addend is rs2.
    The second addend is the unsigned value formed by extracting the least-significant word of rs1
    and shifting it left by 2 places.
    ```
    let base = x[rs2];
    let index = EXTZ(x[rs1][31..0]);
    x[rd] = base + (index << 2);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sh2add_uw).
    """

    name = "riscv.sh2add.uw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sh2add.uw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

Sh3addUwOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs an XLEN-wide addition of two addends. The first addend is rs2. The second addend is the unsigned value formed by extracting the least-significant word of rs1 and shifting it left by 3 places.

let base = x[rs2];
let index = EXTZ(x[rs1][31..0]);
x[rd] = base + (index << 3);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
@irdl_op_definition
class Sh3addUwOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs an XLEN-wide addition of two addends. The first addend is rs2.
    The second addend is the unsigned value formed by extracting the least-significant word of rs1
    and shifting it left by 3 places.

    ```
    let base = x[rs2];
    let index = EXTZ(x[rs1][31..0]);
    x[rd] = base + (index << 3);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-sh3add_uw).
    """

    name = "riscv.sh3add.uw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.sh3add.uw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

SlliUwOp dataclass

Bases: RdRsImmBitManipOperation

This instruction takes the least-significant word of rs1, zero-extends it, and shifts it left by the immediate.

x[rd] = (EXTZ(x[rs][31..0]) << shamt);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
@irdl_op_definition
class SlliUwOp(RdRsImmBitManipOperation):
    """
    This instruction takes the least-significant word of rs1, zero-extends it,
    and shifts it left by the immediate.
    ```
    x[rd] = (EXTZ(x[rs][31..0]) << shamt);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-slli_uw).
    """

    name = "riscv.slli.uw"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.slli.uw' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

AndnOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs the bitwise logical AND operation between rs1 and the bitwise inversion of rs2.

X(rd) = X(rs1) & ~X(rs2);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
@irdl_op_definition
class AndnOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs the bitwise logical AND operation between rs1 and the bitwise inversion of rs2.
    ```
    X(rd) = X(rs1) & ~X(rs2);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-andn).
    """

    name = "riscv.andn"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.andn' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

OrnOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs the bitwise logical OR operation between rs1 and the bitwise inversion of rs2.

X(rd) = X(rs1) | ~X(rs2);

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
@irdl_op_definition
class OrnOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs the bitwise logical OR operation between rs1 and the bitwise inversion of rs2.
    ```
    X(rd) = X(rs1) | ~X(rs2);
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-orn).
    """

    name = "riscv.orn"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.orn' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

XnorOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction performs the bit-wise exclusive-NOR operation on rs1 and rs2.

X(rd) = ~(X(rs1) ^ X(rs2));

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
@irdl_op_definition
class XnorOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction performs the bit-wise exclusive-NOR operation on rs1 and rs2.
    ```
    X(rd) = ~(X(rs1) ^ X(rs2));
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-xnor).
    """

    name = "riscv.xnor"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.xnor' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

MaxOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns the larger of two signed integers.

let rs1_val = X(rs1);
let rs2_val = X(rs2);

let result = if   rs1_val <_s rs2_val
                then rs2_val
                else rs1_val;
X(rd) = result;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
@irdl_op_definition
class MaxOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns the larger of two signed integers.
    ```
    let rs1_val = X(rs1);
    let rs2_val = X(rs2);

    let result = if   rs1_val <_s rs2_val
                    then rs2_val
                    else rs1_val;
    X(rd) = result;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-max).
    """

    name = "riscv.max"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.max' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

MaxUOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns the larger of two unsigned integers.

let rs1_val = X(rs1);
let rs2_val = X(rs2);
let result = if   rs1_val <_u rs2_val
             then rs2_val
         else rs1_val;
X(rd) = result;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
@irdl_op_definition
class MaxUOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns the larger of two unsigned integers.
    ```
    let rs1_val = X(rs1);
    let rs2_val = X(rs2);
    let result = if   rs1_val <_u rs2_val
                 then rs2_val
             else rs1_val;
    X(rd) = result;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-maxu).
    """

    name = "riscv.maxu"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.maxu' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

MinOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns the smaller of two signed integers.

let rs1_val = X(rs1);
let rs2_val = X(rs2);
let result = if   rs1_val <_s rs2_val
             then rs1_val
         else rs2_val;
X(rd) = result;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
@irdl_op_definition
class MinOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns the smaller of two signed integers.
    ```
    let rs1_val = X(rs1);
    let rs2_val = X(rs2);
    let result = if   rs1_val <_s rs2_val
                 then rs1_val
             else rs2_val;
    X(rd) = result;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-min).
    """

    name = "riscv.min"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.min' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

MinUOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

This instruction returns the smaller of two unsigned integers.

let rs1_val = X(rs1);
let rs2_val = X(rs2);
let result = if   rs1_val <_u rs2_val
                then rs1_val
                else rs2_val;
X(rd) = result;

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
@irdl_op_definition
class MinUOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    This instruction returns the smaller of two unsigned integers.
    ```
    let rs1_val = X(rs1);
    let rs2_val = X(rs2);
    let result = if   rs1_val <_u rs2_val
                    then rs1_val
                    else rs2_val;
    X(rd) = result;
    ```
    See external [documentation](https://five-embeddev.com/riscv-bitmanip/1.0.0/bitmanip.html#insns-minu).
    """

    name = "riscv.minu"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.minu' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

CZeroEqzOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Moves zero to a register rd, if the condition rs2 is equal to zero, otherwise moves rs1 to rd.

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2090
2091
2092
2093
2094
2095
2096
2097
2098
@irdl_op_definition
class CZeroEqzOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Moves zero to a register rd, if the condition rs2 is equal to zero, otherwise moves rs1 to rd.

    See external [documentation](https://github.com/riscvarchive/riscv-zicond/blob/main/zicondops.adoc).
    """

    name = "riscv.czero.eqz"

name = 'riscv.czero.eqz' class-attribute instance-attribute

CZeroNezOp dataclass

Bases: RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]

Moves zero to a register rd, if the condition rs2 is nonzero, otherwise moves rs1 to rd.

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2101
2102
2103
2104
2105
2106
2107
2108
2109
@irdl_op_definition
class CZeroNezOp(RdRsRsIntegerOperation[IntRegisterType, IntRegisterType]):
    """
    Moves zero to a register rd, if the condition rs2 is nonzero, otherwise moves rs1 to rd.

    See external [documentation](https://github.com/riscvarchive/riscv-zicond/blob/main/zicondops.adoc).
    """

    name = "riscv.czero.nez"

name = 'riscv.czero.nez' class-attribute instance-attribute

LiOpHasCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
2118
2119
2120
2121
2122
2123
2124
2125
class LiOpHasCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            LoadImmediate0,
        )

        return (LoadImmediate0(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
2119
2120
2121
2122
2123
2124
2125
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        LoadImmediate0,
    )

    return (LoadImmediate0(),)

EcallOp dataclass

Bases: NullaryOperation

The ECALL instruction is used to make a request to the supporting execution environment, which is usually an operating system. The ABI for the system will define how parameters for the environment request are passed, but usually these will be in defined locations in the integer register file.

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
@irdl_op_definition
class EcallOp(NullaryOperation):
    """
    The ECALL instruction is used to make a request to the supporting execution
    environment, which is usually an operating system.
    The ABI for the system will define how parameters for the environment
    request are passed, but usually these will be in defined locations in the
    integer register file.

    See external [documentation](https://github.com/riscv/riscv-isa-manual/releases/download/Ratified-IMAFDQC/riscv-spec-20191213.pdf).
    """

    name = "riscv.ecall"

name = 'riscv.ecall' class-attribute instance-attribute

LabelOp

Bases: RISCVCustomFormatOperation, RISCVAsmOperation, RISCVRegallocOperation

The label operation is used to emit text labels (e.g. loop:) that are used as branch, unconditional jump targets and symbol offsets.

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
@irdl_op_definition
class LabelOp(RISCVCustomFormatOperation, RISCVAsmOperation, RISCVRegallocOperation):
    """
    The label operation is used to emit text labels (e.g. loop:) that are used
    as branch, unconditional jump targets and symbol offsets.

    See external [documentation](https://github.com/riscv-non-isa/riscv-asm-manual/blob/master/riscv-asm.md#labels).
    """

    name = "riscv.label"
    label = attr_def(LabelAttr)
    comment = opt_attr_def(StringAttr)

    def __init__(
        self,
        label: str | LabelAttr,
        *,
        comment: str | StringAttr | None = None,
    ):
        if isinstance(label, str):
            label = LabelAttr(label)
        if isinstance(comment, str):
            comment = StringAttr(comment)

        super().__init__(
            attributes={
                "label": label,
                "comment": comment,
            },
        )

    def assembly_line(self) -> str | None:
        return AssemblyPrinter.append_comment(f"{self.label.data}:", self.comment)

    @classmethod
    def custom_parse_attributes(cls, parser: Parser) -> dict[str, Attribute]:
        attributes = dict[str, Attribute]()
        attributes["label"] = LabelAttr(parser.parse_str_literal("Expected label"))
        return attributes

    def custom_print_attributes(self, printer: Printer) -> AbstractSet[str]:
        printer.print_string(" ")
        printer.print_string_literal(self.label.data)
        return {"label"}

    def print_op_type(self, printer: Printer) -> None:
        return

    @classmethod
    def parse_op_type(
        cls, parser: Parser
    ) -> tuple[Sequence[Attribute], Sequence[Attribute]]:
        return (), ()

name = 'riscv.label' class-attribute instance-attribute

label = attr_def(LabelAttr) class-attribute instance-attribute

comment = opt_attr_def(StringAttr) class-attribute instance-attribute

__init__(label: str | LabelAttr, *, comment: str | StringAttr | None = None)

Source code in xdsl/dialects/riscv/ops.py
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
def __init__(
    self,
    label: str | LabelAttr,
    *,
    comment: str | StringAttr | None = None,
):
    if isinstance(label, str):
        label = LabelAttr(label)
    if isinstance(comment, str):
        comment = StringAttr(comment)

    super().__init__(
        attributes={
            "label": label,
            "comment": comment,
        },
    )

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
2174
2175
def assembly_line(self) -> str | None:
    return AssemblyPrinter.append_comment(f"{self.label.data}:", self.comment)

custom_parse_attributes(parser: Parser) -> dict[str, Attribute] classmethod

Source code in xdsl/dialects/riscv/ops.py
2177
2178
2179
2180
2181
@classmethod
def custom_parse_attributes(cls, parser: Parser) -> dict[str, Attribute]:
    attributes = dict[str, Attribute]()
    attributes["label"] = LabelAttr(parser.parse_str_literal("Expected label"))
    return attributes

custom_print_attributes(printer: Printer) -> AbstractSet[str]

Source code in xdsl/dialects/riscv/ops.py
2183
2184
2185
2186
def custom_print_attributes(self, printer: Printer) -> AbstractSet[str]:
    printer.print_string(" ")
    printer.print_string_literal(self.label.data)
    return {"label"}

print_op_type(printer: Printer) -> None

Source code in xdsl/dialects/riscv/ops.py
2188
2189
def print_op_type(self, printer: Printer) -> None:
    return

parse_op_type(parser: Parser) -> tuple[Sequence[Attribute], Sequence[Attribute]] classmethod

Source code in xdsl/dialects/riscv/ops.py
2191
2192
2193
2194
2195
@classmethod
def parse_op_type(
    cls, parser: Parser
) -> tuple[Sequence[Attribute], Sequence[Attribute]]:
    return (), ()

DirectiveOp

Bases: RISCVCustomFormatOperation, RISCVAsmOperation, RISCVRegallocOperation

The directive operation is used to emit assembler directives (e.g. .word; .equ; etc.) without any associated region of assembly code. A more complete list of directives can be found here:

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
@irdl_op_definition
class DirectiveOp(
    RISCVCustomFormatOperation, RISCVAsmOperation, RISCVRegallocOperation
):
    """
    The directive operation is used to emit assembler directives (e.g. .word; .equ; etc.)
    without any associated region of assembly code.
    A more complete list of directives can be found here:

    See external [documentation](https://github.com/riscv-non-isa/riscv-asm-manual/blob/master/riscv-asm.md#pseudo-ops).
    """

    name = "riscv.directive"
    directive = attr_def(StringAttr)
    value = opt_attr_def(StringAttr)

    def __init__(
        self,
        directive: str | StringAttr,
        value: str | StringAttr | None,
    ):
        if isinstance(directive, str):
            directive = StringAttr(directive)
        if isinstance(value, str):
            value = StringAttr(value)

        super().__init__(
            attributes={
                "directive": directive,
                "value": value,
            }
        )

    def assembly_line(self) -> str | None:
        if self.value is not None and self.value.data:
            arg_str = assembly_arg_str(self.value.data)
        else:
            arg_str = ""

        return AssemblyPrinter.assembly_line(
            self.directive.data, arg_str, is_indented=False
        )

    @classmethod
    def custom_parse_attributes(cls, parser: Parser) -> dict[str, Attribute]:
        attributes = dict[str, Attribute]()
        attributes["directive"] = StringAttr(
            parser.parse_str_literal("Expected directive")
        )
        if (value := parser.parse_optional_str_literal()) is not None:
            attributes["value"] = StringAttr(value)
        return attributes

    def custom_print_attributes(self, printer: Printer) -> AbstractSet[str]:
        printer.print_string(" ")
        printer.print_string_literal(self.directive.data)
        if self.value is not None:
            printer.print_string(" ")
            printer.print_string_literal(self.value.data)
        return {"directive", "value"}

    def print_op_type(self, printer: Printer) -> None:
        return

    @classmethod
    def parse_op_type(
        cls, parser: Parser
    ) -> tuple[Sequence[Attribute], Sequence[Attribute]]:
        return (), ()

name = 'riscv.directive' class-attribute instance-attribute

directive = attr_def(StringAttr) class-attribute instance-attribute

value = opt_attr_def(StringAttr) class-attribute instance-attribute

__init__(directive: str | StringAttr, value: str | StringAttr | None)

Source code in xdsl/dialects/riscv/ops.py
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
def __init__(
    self,
    directive: str | StringAttr,
    value: str | StringAttr | None,
):
    if isinstance(directive, str):
        directive = StringAttr(directive)
    if isinstance(value, str):
        value = StringAttr(value)

    super().__init__(
        attributes={
            "directive": directive,
            "value": value,
        }
    )

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
2231
2232
2233
2234
2235
2236
2237
2238
2239
def assembly_line(self) -> str | None:
    if self.value is not None and self.value.data:
        arg_str = assembly_arg_str(self.value.data)
    else:
        arg_str = ""

    return AssemblyPrinter.assembly_line(
        self.directive.data, arg_str, is_indented=False
    )

custom_parse_attributes(parser: Parser) -> dict[str, Attribute] classmethod

Source code in xdsl/dialects/riscv/ops.py
2241
2242
2243
2244
2245
2246
2247
2248
2249
@classmethod
def custom_parse_attributes(cls, parser: Parser) -> dict[str, Attribute]:
    attributes = dict[str, Attribute]()
    attributes["directive"] = StringAttr(
        parser.parse_str_literal("Expected directive")
    )
    if (value := parser.parse_optional_str_literal()) is not None:
        attributes["value"] = StringAttr(value)
    return attributes

custom_print_attributes(printer: Printer) -> AbstractSet[str]

Source code in xdsl/dialects/riscv/ops.py
2251
2252
2253
2254
2255
2256
2257
def custom_print_attributes(self, printer: Printer) -> AbstractSet[str]:
    printer.print_string(" ")
    printer.print_string_literal(self.directive.data)
    if self.value is not None:
        printer.print_string(" ")
        printer.print_string_literal(self.value.data)
    return {"directive", "value"}

print_op_type(printer: Printer) -> None

Source code in xdsl/dialects/riscv/ops.py
2259
2260
def print_op_type(self, printer: Printer) -> None:
    return

parse_op_type(parser: Parser) -> tuple[Sequence[Attribute], Sequence[Attribute]] classmethod

Source code in xdsl/dialects/riscv/ops.py
2262
2263
2264
2265
2266
@classmethod
def parse_op_type(
    cls, parser: Parser
) -> tuple[Sequence[Attribute], Sequence[Attribute]]:
    return (), ()

AssemblySectionOp

Bases: IRDLOperation, AssemblyPrintable

The directive operation is used to emit assembler directives (e.g. .text; .data; etc.) with the scope of a section.

A more complete list of directives can be found here:

See external documentation.

This operation can have nested operations, corresponding to a section of the assembly.

Source code in xdsl/dialects/riscv/ops.py
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
@irdl_op_definition
class AssemblySectionOp(IRDLOperation, AssemblyPrintable):
    """
    The directive operation is used to emit assembler directives (e.g. .text; .data; etc.)
    with the scope of a section.

    A more complete list of directives can be found here:

    See external [documentation](https://github.com/riscv-non-isa/riscv-asm-manual/blob/master/riscv-asm.md#pseudo-ops).

    This operation can have nested operations, corresponding to a section of the assembly.
    """

    name = "riscv.assembly_section"
    directive = attr_def(StringAttr)
    data = region_def("single_block")

    traits = traits_def(NoTerminator(), IsolatedFromAbove())

    def __init__(
        self,
        directive: str | StringAttr,
        region: Region | None = None,
    ):
        if isinstance(directive, str):
            directive = StringAttr(directive)
        if region is None:
            region = Region(Block())

        super().__init__(
            regions=[region],
            attributes={
                "directive": directive,
            },
        )

    @classmethod
    def parse(cls, parser: Parser) -> AssemblySectionOp:
        directive = parser.parse_str_literal()
        attr_dict = parser.parse_optional_attr_dict_with_keyword(("directive",))
        region = parser.parse_optional_region()

        if region is None:
            region = Region(Block())
        section = AssemblySectionOp(directive, region)
        if attr_dict is not None:
            section.attributes |= attr_dict.data

        return section

    def print(self, printer: Printer) -> None:
        printer.print_string(" ")
        printer.print_string_literal(self.directive.data)
        printer.print_op_attributes(
            self.attributes, reserved_attr_names=("directive",), print_keyword=True
        )
        printer.print_string(" ")
        if self.data.block.ops:
            printer.print_region(self.data)

    def print_assembly(self, printer: AssemblyPrinter) -> None:
        printer.emit_section(self.directive.data)

name = 'riscv.assembly_section' class-attribute instance-attribute

directive = attr_def(StringAttr) class-attribute instance-attribute

data = region_def('single_block') class-attribute instance-attribute

traits = traits_def(NoTerminator(), IsolatedFromAbove()) class-attribute instance-attribute

__init__(directive: str | StringAttr, region: Region | None = None)

Source code in xdsl/dialects/riscv/ops.py
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
def __init__(
    self,
    directive: str | StringAttr,
    region: Region | None = None,
):
    if isinstance(directive, str):
        directive = StringAttr(directive)
    if region is None:
        region = Region(Block())

    super().__init__(
        regions=[region],
        attributes={
            "directive": directive,
        },
    )

parse(parser: Parser) -> AssemblySectionOp classmethod

Source code in xdsl/dialects/riscv/ops.py
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
@classmethod
def parse(cls, parser: Parser) -> AssemblySectionOp:
    directive = parser.parse_str_literal()
    attr_dict = parser.parse_optional_attr_dict_with_keyword(("directive",))
    region = parser.parse_optional_region()

    if region is None:
        region = Region(Block())
    section = AssemblySectionOp(directive, region)
    if attr_dict is not None:
        section.attributes |= attr_dict.data

    return section

print(printer: Printer) -> None

Source code in xdsl/dialects/riscv/ops.py
2319
2320
2321
2322
2323
2324
2325
2326
2327
def print(self, printer: Printer) -> None:
    printer.print_string(" ")
    printer.print_string_literal(self.directive.data)
    printer.print_op_attributes(
        self.attributes, reserved_attr_names=("directive",), print_keyword=True
    )
    printer.print_string(" ")
    if self.data.block.ops:
        printer.print_region(self.data)

print_assembly(printer: AssemblyPrinter) -> None

Source code in xdsl/dialects/riscv/ops.py
2329
2330
def print_assembly(self, printer: AssemblyPrinter) -> None:
    printer.emit_section(self.directive.data)

CustomAssemblyInstructionOp

Bases: RISCVCustomFormatOperation, RISCVInstruction

An instruction with unspecified semantics, that can be printed during assembly emission.

During assembly emission, the results are printed before the operands:

s0 = rv32.GetRegisterOp(Registers.s0).res
s1 = rv32.GetRegisterOp(Registers.s1).res
rs2 = riscv.Registers.s2
rs3 = riscv.Registers.s3
op = CustomAssemblyInstructionOp("my_instr", (s0, s1), (rs2, rs3))

op.assembly_line()   # "my_instr s2, s3, s0, s1"
Source code in xdsl/dialects/riscv/ops.py
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
@irdl_op_definition
class CustomAssemblyInstructionOp(RISCVCustomFormatOperation, RISCVInstruction):
    """
    An instruction with unspecified semantics, that can be printed during assembly
    emission.

    During assembly emission, the results are printed before the operands:

    ``` python
    s0 = rv32.GetRegisterOp(Registers.s0).res
    s1 = rv32.GetRegisterOp(Registers.s1).res
    rs2 = riscv.Registers.s2
    rs3 = riscv.Registers.s3
    op = CustomAssemblyInstructionOp("my_instr", (s0, s1), (rs2, rs3))

    op.assembly_line()   # "my_instr s2, s3, s0, s1"
    ```
    """

    name = "riscv.custom_assembly_instruction"
    inputs = var_operand_def()
    outputs = var_result_def()
    instruction_name = attr_def(StringAttr)
    comment = opt_attr_def(StringAttr)

    def __init__(
        self,
        instruction_name: str | StringAttr,
        inputs: Sequence[SSAValue],
        result_types: Sequence[Attribute],
        *,
        comment: str | StringAttr | None = None,
    ):
        if isinstance(instruction_name, str):
            instruction_name = StringAttr(instruction_name)
        if isinstance(comment, str):
            comment = StringAttr(comment)

        super().__init__(
            operands=[inputs],
            result_types=[result_types],
            attributes={
                "instruction_name": instruction_name,
                "comment": comment,
            },
        )

    def assembly_instruction_name(self) -> str:
        return self.instruction_name.data

    def assembly_line_args(self) -> tuple[AssemblyInstructionArg, ...]:
        return *self.results, *self.operands

name = 'riscv.custom_assembly_instruction' class-attribute instance-attribute

inputs = var_operand_def() class-attribute instance-attribute

outputs = var_result_def() class-attribute instance-attribute

instruction_name = attr_def(StringAttr) class-attribute instance-attribute

comment = opt_attr_def(StringAttr) class-attribute instance-attribute

__init__(instruction_name: str | StringAttr, inputs: Sequence[SSAValue], result_types: Sequence[Attribute], *, comment: str | StringAttr | None = None)

Source code in xdsl/dialects/riscv/ops.py
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
def __init__(
    self,
    instruction_name: str | StringAttr,
    inputs: Sequence[SSAValue],
    result_types: Sequence[Attribute],
    *,
    comment: str | StringAttr | None = None,
):
    if isinstance(instruction_name, str):
        instruction_name = StringAttr(instruction_name)
    if isinstance(comment, str):
        comment = StringAttr(comment)

    super().__init__(
        operands=[inputs],
        result_types=[result_types],
        attributes={
            "instruction_name": instruction_name,
            "comment": comment,
        },
    )

assembly_instruction_name() -> str

Source code in xdsl/dialects/riscv/ops.py
2380
2381
def assembly_instruction_name(self) -> str:
    return self.instruction_name.data

assembly_line_args() -> tuple[AssemblyInstructionArg, ...]

Source code in xdsl/dialects/riscv/ops.py
2383
2384
def assembly_line_args(self) -> tuple[AssemblyInstructionArg, ...]:
    return *self.results, *self.operands

CommentOp

Bases: RISCVCustomFormatOperation, RISCVAsmOperation, RISCVRegallocOperation

Source code in xdsl/dialects/riscv/ops.py
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
@irdl_op_definition
class CommentOp(RISCVCustomFormatOperation, RISCVAsmOperation, RISCVRegallocOperation):
    name = "riscv.comment"
    comment = attr_def(StringAttr)

    def __init__(self, comment: str | StringAttr):
        if isinstance(comment, str):
            comment = StringAttr(comment)

        super().__init__(
            attributes={
                "comment": comment,
            },
        )

    def assembly_line(self) -> str | None:
        return f"    # {self.comment.data}"

name = 'riscv.comment' class-attribute instance-attribute

comment = attr_def(StringAttr) class-attribute instance-attribute

__init__(comment: str | StringAttr)

Source code in xdsl/dialects/riscv/ops.py
2392
2393
2394
2395
2396
2397
2398
2399
2400
def __init__(self, comment: str | StringAttr):
    if isinstance(comment, str):
        comment = StringAttr(comment)

    super().__init__(
        attributes={
            "comment": comment,
        },
    )

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
2402
2403
def assembly_line(self) -> str | None:
    return f"    # {self.comment.data}"

EbreakOp dataclass

Bases: NullaryOperation

The EBREAK instruction is used by debuggers to cause control to be transferred back to a debugging environment.

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
@irdl_op_definition
class EbreakOp(NullaryOperation):
    """
    The EBREAK instruction is used by debuggers to cause control to be
    transferred back to a debugging environment.

    See external [documentation](https://github.com/riscv/riscv-isa-manual/releases/download/Ratified-IMAFDQC/riscv-spec-20191213.pdf).
    """

    name = "riscv.ebreak"

name = 'riscv.ebreak' class-attribute instance-attribute

WfiOp dataclass

Bases: NullaryOperation

The Wait for Interrupt instruction (WFI) provides a hint to the implementation that the current hart can be stalled until an interrupt might need servicing.

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
@irdl_op_definition
class WfiOp(NullaryOperation):
    """
    The Wait for Interrupt instruction (WFI) provides a hint to the
    implementation that the current hart can be stalled until an
    interrupt might need servicing.

    See external [documentation](https://github.com/riscv/riscv-isa-manual/releases/download/Priv-v1.12/riscv-privileged-20211203.pdf).
    """

    name = "riscv.wfi"

name = 'riscv.wfi' class-attribute instance-attribute

GetFloatRegisterOp dataclass

Bases: GetAnyRegisterOperation[FloatRegisterType]

Source code in xdsl/dialects/riscv/ops.py
2436
2437
2438
@irdl_op_definition
class GetFloatRegisterOp(GetAnyRegisterOperation[FloatRegisterType]):
    name = "riscv.get_float_register"

name = 'riscv.get_float_register' class-attribute instance-attribute

ParallelMovOp

Bases: RISCVRegallocOperation

Source code in xdsl/dialects/riscv/ops.py
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
@irdl_op_definition
class ParallelMovOp(RISCVRegallocOperation):
    _L: ClassVar = IntVarConstraint("L", AnyInt())

    name = "riscv.parallel_mov"
    inputs = var_operand_def(RangeOf(RISCVRegisterType).of_length(_L))
    outputs: VarOpResult[RISCVRegisterType] = var_result_def(
        RangeOf(RISCVRegisterType).of_length(_L)
    )
    input_widths = prop_def(DenseArrayBase.constr(i32))
    free_registers = opt_prop_def(ArrayAttr[RISCVRegisterType])

    assembly_format = (
        "$inputs $input_widths attr-dict `:` functional-type($inputs, $outputs)"
    )
    irdl_options = (ParsePropInAttrDict(),)

    def __init__(
        self,
        inputs: Sequence[SSAValue],
        outputs: Sequence[RISCVRegisterType],
        input_widths: DenseArrayBase[I32],
        free_registers: ArrayAttr[RISCVRegisterType] | None = None,
    ):
        super().__init__(
            operands=(inputs,),
            result_types=(outputs,),
            properties={"input_widths": input_widths, "free_registers": free_registers},
        )

    def verify_(self) -> None:
        if len(self.inputs) != len(self.input_widths):
            raise VerifyException(
                "incorrect length for input_widths. "
                "Expected {len(self.inputs)}, found {len(self.input_widths)}."
            )

        input_types = cast(Sequence[RISCVRegisterType], self.inputs.types)
        output_types = cast(Sequence[RISCVRegisterType], self.outputs.types)

        # Check type of register type matches for input and output
        for input_type, output_type in zip(input_types, output_types, strict=True):
            if type(input_type) is not type(output_type):
                raise VerifyException("Input type must match output type.")

        # Check outputs are distinct if allocated and not ZERO
        filtered_outputs = tuple(
            i for i in output_types if i.is_allocated and i != Registers.ZERO
        )
        if len(filtered_outputs) != len(set(filtered_outputs)):
            raise VerifyException("Outputs must be unallocated or distinct.")

name = 'riscv.parallel_mov' class-attribute instance-attribute

inputs = var_operand_def(RangeOf(RISCVRegisterType).of_length(_L)) class-attribute instance-attribute

outputs: VarOpResult[RISCVRegisterType] = var_result_def(RangeOf(RISCVRegisterType).of_length(_L)) class-attribute instance-attribute

input_widths = prop_def(DenseArrayBase.constr(i32)) class-attribute instance-attribute

free_registers = opt_prop_def(ArrayAttr[RISCVRegisterType]) class-attribute instance-attribute

assembly_format = '$inputs $input_widths attr-dict `:` functional-type($inputs, $outputs)' class-attribute instance-attribute

irdl_options = (ParsePropInAttrDict(),) class-attribute instance-attribute

__init__(inputs: Sequence[SSAValue], outputs: Sequence[RISCVRegisterType], input_widths: DenseArrayBase[I32], free_registers: ArrayAttr[RISCVRegisterType] | None = None)

Source code in xdsl/dialects/riscv/ops.py
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
def __init__(
    self,
    inputs: Sequence[SSAValue],
    outputs: Sequence[RISCVRegisterType],
    input_widths: DenseArrayBase[I32],
    free_registers: ArrayAttr[RISCVRegisterType] | None = None,
):
    super().__init__(
        operands=(inputs,),
        result_types=(outputs,),
        properties={"input_widths": input_widths, "free_registers": free_registers},
    )

verify_() -> None

Source code in xdsl/dialects/riscv/ops.py
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
def verify_(self) -> None:
    if len(self.inputs) != len(self.input_widths):
        raise VerifyException(
            "incorrect length for input_widths. "
            "Expected {len(self.inputs)}, found {len(self.input_widths)}."
        )

    input_types = cast(Sequence[RISCVRegisterType], self.inputs.types)
    output_types = cast(Sequence[RISCVRegisterType], self.outputs.types)

    # Check type of register type matches for input and output
    for input_type, output_type in zip(input_types, output_types, strict=True):
        if type(input_type) is not type(output_type):
            raise VerifyException("Input type must match output type.")

    # Check outputs are distinct if allocated and not ZERO
    filtered_outputs = tuple(
        i for i in output_types if i.is_allocated and i != Registers.ZERO
    )
    if len(filtered_outputs) != len(set(filtered_outputs)):
        raise VerifyException("Outputs must be unallocated or distinct.")

FMAddSOp dataclass

Bases: RdRsRsRsFloatOperation

Perform single-precision fused multiply addition.

f[rd] = f[rs1]×f[rs2]+f[rs3]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
@irdl_op_definition
class FMAddSOp(RdRsRsRsFloatOperation):
    """
    Perform single-precision fused multiply addition.

    ```C
    f[rd] = f[rs1]×f[rs2]+f[rs3]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmadd-s).
    """

    name = "riscv.fmadd.s"

name = 'riscv.fmadd.s' class-attribute instance-attribute

FMSubSOp dataclass

Bases: RdRsRsRsFloatOperation

Perform single-precision fused multiply substraction.

f[rd] = f[rs1]×f[rs2]+f[rs3]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
@irdl_op_definition
class FMSubSOp(RdRsRsRsFloatOperation):
    """
    Perform single-precision fused multiply substraction.

    ```C
    f[rd] = f[rs1]×f[rs2]+f[rs3]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmsub-s).
    """

    name = "riscv.fmsub.s"

name = 'riscv.fmsub.s' class-attribute instance-attribute

FNMSubSOp dataclass

Bases: RdRsRsRsFloatOperation

Perform single-precision fused multiply substraction.

f[rd] = -f[rs1]×f[rs2]+f[rs3]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
@irdl_op_definition
class FNMSubSOp(RdRsRsRsFloatOperation):
    """
    Perform single-precision fused multiply substraction.

    ```C
    f[rd] = -f[rs1]×f[rs2]+f[rs3]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fnmsub-s).
    """

    name = "riscv.fnmsub.s"

name = 'riscv.fnmsub.s' class-attribute instance-attribute

FNMAddSOp dataclass

Bases: RdRsRsRsFloatOperation

Perform single-precision fused multiply addition.

f[rd] = -f[rs1]×f[rs2]-f[rs3]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
@irdl_op_definition
class FNMAddSOp(RdRsRsRsFloatOperation):
    """
    Perform single-precision fused multiply addition.

    ```C
    f[rd] = -f[rs1]×f[rs2]-f[rs3]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fnmadd-s).
    """

    name = "riscv.fnmadd.s"

name = 'riscv.fnmadd.s' class-attribute instance-attribute

FAddSOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform single-precision floating-point addition.

f[rd] = f[rs1]+f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
@irdl_op_definition
class FAddSOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform single-precision floating-point addition.

    ```C
    f[rd] = f[rs1]+f[rs2]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fadd-s).
    """

    name = "riscv.fadd.s"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fadd.s' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FSubSOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform single-precision floating-point substraction.

f[rd] = f[rs1]-f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
@irdl_op_definition
class FSubSOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform single-precision floating-point substraction.

    ```C
    f[rd] = f[rs1]-f[rs2]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsub-s).
    """

    name = "riscv.fsub.s"

name = 'riscv.fsub.s' class-attribute instance-attribute

FMulSOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform single-precision floating-point multiplication.

f[rd] = f[rs1]×f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
@irdl_op_definition
class FMulSOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform single-precision floating-point multiplication.

    ```C
    f[rd] = f[rs1]×f[rs2]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmul-s).
    """

    name = "riscv.fmul.s"

name = 'riscv.fmul.s' class-attribute instance-attribute

FDivSOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform single-precision floating-point division.

f[rd] = f[rs1] / f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
@irdl_op_definition
class FDivSOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform single-precision floating-point division.

    ```C
    f[rd] = f[rs1] / f[rs2]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fdiv-s).
    """

    name = "riscv.fdiv.s"

name = 'riscv.fdiv.s' class-attribute instance-attribute

FSqrtSOp dataclass

Bases: RdRsFloatOperation[FloatRegisterType]

Perform single-precision floating-point square root.

f[rd] = sqrt(f[rs1])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
@irdl_op_definition
class FSqrtSOp(RdRsFloatOperation[FloatRegisterType]):
    """
    Perform single-precision floating-point square root.

    ```C
    f[rd] = sqrt(f[rs1])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsqrt-s).
    """

    name = "riscv.fsqrt.s"

name = 'riscv.fsqrt.s' class-attribute instance-attribute

FSgnJSOp dataclass

Bases: RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]

Produce a result that takes all bits except the sign bit from rs1. The result’s sign bit is rs2’s sign bit.

f[rd] = {f[rs2][31], f[rs1][30:0]}

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
@irdl_op_definition
class FSgnJSOp(RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]):
    """
    Produce a result that takes all bits except the sign bit from rs1.
    The result’s sign bit is rs2’s sign bit.

    ```C
    f[rd] = {f[rs2][31], f[rs1][30:0]}
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsgnj.s).
    """

    name = "riscv.fsgnj.s"

name = 'riscv.fsgnj.s' class-attribute instance-attribute

FSgnJNSOp dataclass

Bases: RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]

Produce a result that takes all bits except the sign bit from rs1. The result’s sign bit is opposite of rs2’s sign bit.

f[rd] = {~f[rs2][31], f[rs1][30:0]}

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
@irdl_op_definition
class FSgnJNSOp(RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]):
    """
    Produce a result that takes all bits except the sign bit from rs1.
    The result’s sign bit is opposite of rs2’s sign bit.

    ```C
    f[rd] = {~f[rs2][31], f[rs1][30:0]}
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsgnjn.s).
    """

    name = "riscv.fsgnjn.s"

name = 'riscv.fsgnjn.s' class-attribute instance-attribute

FSgnJXSOp dataclass

Bases: RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]

Produce a result that takes all bits except the sign bit from rs1. The result’s sign bit is XOR of sign bit of rs1 and rs2.

f[rd] = {f[rs1][31] ^ f[rs2][31], f[rs1][30:0]}

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
@irdl_op_definition
class FSgnJXSOp(RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]):
    """
    Produce a result that takes all bits except the sign bit from rs1.
    The result’s sign bit is XOR of sign bit of rs1 and rs2.

    ```C
    f[rd] = {f[rs1][31] ^ f[rs2][31], f[rs1][30:0]}
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsgnjx.s).
    """

    name = "riscv.fsgnjx.s"

name = 'riscv.fsgnjx.s' class-attribute instance-attribute

FMinSOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Write the smaller of single precision data in rs1 and rs2 to rd.

f[rd] = min(f[rs1], f[rs2])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
@irdl_op_definition
class FMinSOp(RdRsRsFloatOperationWithFastMath):
    """
    Write the smaller of single precision data in rs1 and rs2 to rd.

    ```C
    f[rd] = min(f[rs1], f[rs2])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmin-s).
    """

    name = "riscv.fmin.s"

name = 'riscv.fmin.s' class-attribute instance-attribute

FMaxSOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Write the larger of single precision data in rs1 and rs2 to rd.

f[rd] = max(f[rs1], f[rs2])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
@irdl_op_definition
class FMaxSOp(RdRsRsFloatOperationWithFastMath):
    """
    Write the larger of single precision data in rs1 and rs2 to rd.

    ```C
    f[rd] = max(f[rs1], f[rs2])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmax-s).
    """

    name = "riscv.fmax.s"

name = 'riscv.fmax.s' class-attribute instance-attribute

FCvtWSOp dataclass

Bases: RdRsIntegerOperation[FloatRegisterType]

Convert a floating-point number in floating-point register rs1 to a signed 32-bit in integer register rd.

x[rd] = sext(s32_{f32}(f[rs1]))

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
@irdl_op_definition
class FCvtWSOp(RdRsIntegerOperation[FloatRegisterType]):
    """
    Convert a floating-point number in floating-point register rs1 to a signed 32-bit in integer register rd.

    ```C
    x[rd] = sext(s32_{f32}(f[rs1]))
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fcvt.w.s).
    """

    name = "riscv.fcvt.w.s"

name = 'riscv.fcvt.w.s' class-attribute instance-attribute

FCvtWuSOp dataclass

Bases: RdRsIntegerOperation[FloatRegisterType]

Convert a floating-point number in floating-point register rs1 to a signed 32-bit in unsigned integer register rd.

x[rd] = sext(u32_{f32}(f[rs1]))

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
@irdl_op_definition
class FCvtWuSOp(RdRsIntegerOperation[FloatRegisterType]):
    """
    Convert a floating-point number in floating-point register rs1 to a signed 32-bit in unsigned integer register rd.

    ```C
    x[rd] = sext(u32_{f32}(f[rs1]))
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fcvt.wu.s).
    """

    name = "riscv.fcvt.wu.s"

name = 'riscv.fcvt.wu.s' class-attribute instance-attribute

FMvXWOp dataclass

Bases: RdRsIntegerOperation[FloatRegisterType]

Move the single-precision value in floating-point register rs1 represented in IEEE 754-2008 encoding to the lower 32 bits of integer register rd.

x[rd] = sext(f[rs1][31:0])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
@irdl_op_definition
class FMvXWOp(RdRsIntegerOperation[FloatRegisterType]):
    """
    Move the single-precision value in floating-point register rs1 represented in IEEE
    754-2008 encoding to the lower 32 bits of integer register rd.

    ```C
    x[rd] = sext(f[rs1][31:0])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmv.x.w).
    """

    name = "riscv.fmv.x.w"

name = 'riscv.fmv.x.w' class-attribute instance-attribute

FeqSOp dataclass

Bases: RdRsRsFloatFloatIntegerOperationWithFastMath

Performs a quiet equal comparison between floating-point registers rs1 and rs2 and record the Boolean result in integer register rd. Only signaling NaN inputs cause an Invalid Operation exception. The result is 0 if either operand is NaN.

x[rd] = f[rs1] == f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
@irdl_op_definition
class FeqSOp(RdRsRsFloatFloatIntegerOperationWithFastMath):
    """
    Performs a quiet equal comparison between floating-point registers rs1 and rs2 and
    record the Boolean result in integer register rd.
    Only signaling NaN inputs cause an Invalid Operation exception.
    The result is 0 if either operand is NaN.

    x[rd] = f[rs1] == f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#feq.s).
    """

    name = "riscv.feq.s"

name = 'riscv.feq.s' class-attribute instance-attribute

FltSOp dataclass

Bases: RdRsRsFloatFloatIntegerOperationWithFastMath

Performs a quiet less comparison between floating-point registers rs1 and rs2 and record the Boolean result in integer register rd. Only signaling NaN inputs cause an Invalid Operation exception. The result is 0 if either operand is NaN.

x[rd] = f[rs1] < f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
@irdl_op_definition
class FltSOp(RdRsRsFloatFloatIntegerOperationWithFastMath):
    """
    Performs a quiet less comparison between floating-point registers rs1 and rs2 and
    record the Boolean result in integer register rd.
    Only signaling NaN inputs cause an Invalid Operation exception.
    The result is 0 if either operand is NaN.

    x[rd] = f[rs1] < f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#flt.s).
    """

    name = "riscv.flt.s"

name = 'riscv.flt.s' class-attribute instance-attribute

FleSOp dataclass

Bases: RdRsRsFloatFloatIntegerOperationWithFastMath

Performs a quiet less or equal comparison between floating-point registers rs1 and rs2 and record the Boolean result in integer register rd. Only signaling NaN inputs cause an Invalid Operation exception. The result is 0 if either operand is NaN.

x[rd] = f[rs1] <= f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
@irdl_op_definition
class FleSOp(RdRsRsFloatFloatIntegerOperationWithFastMath):
    """
    Performs a quiet less or equal comparison between floating-point registers rs1 and
    rs2 and record the Boolean result in integer register rd.
    Only signaling NaN inputs cause an Invalid Operation exception.
    The result is 0 if either operand is NaN.

    x[rd] = f[rs1] <= f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fle.s).
    """

    name = "riscv.fle.s"

name = 'riscv.fle.s' class-attribute instance-attribute

FClassSOp dataclass

Bases: RdRsIntegerOperation[FloatRegisterType]

Examines the value in floating-point register rs1 and writes to integer register rd a 10-bit mask that indicates the class of the floating-point number. The format of the mask is described in [classify table]_. The corresponding bit in rd will be set if the property is true and clear otherwise. All other bits in rd are cleared. Note that exactly one bit in rd will be set.

x[rd] = classifys(f[rs1])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
@irdl_op_definition
class FClassSOp(RdRsIntegerOperation[FloatRegisterType]):
    """
    Examines the value in floating-point register rs1 and writes to integer register rd
    a 10-bit mask that indicates the class of the floating-point number.
    The format of the mask is described in [classify table]_.
    The corresponding bit in rd will be set if the property is true and clear otherwise.
    All other bits in rd are cleared. Note that exactly one bit in rd will be set.

    x[rd] = classifys(f[rs1])

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fclass.s).
    """

    name = "riscv.fclass.s"

name = 'riscv.fclass.s' class-attribute instance-attribute

FCvtSWOp dataclass

Bases: RdRsFloatOperation[IntRegisterType]

Converts a 32-bit signed integer, in integer register rs1 into a floating-point number in floating-point register rd.

f[rd] = f32_{s32}(x[rs1])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
@irdl_op_definition
class FCvtSWOp(RdRsFloatOperation[IntRegisterType]):
    """
    Converts a 32-bit signed integer, in integer register rs1 into a floating-point number in floating-point register rd.

    ```C
    f[rd] = f32_{s32}(x[rs1])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fcvt.s.w).
    """

    name = "riscv.fcvt.s.w"

name = 'riscv.fcvt.s.w' class-attribute instance-attribute

FCvtSWuOp dataclass

Bases: RdRsFloatOperation[IntRegisterType]

Converts a 32-bit unsigned integer, in integer register rs1 into a floating-point number in floating-point register rd.

f[rd] = f32_{u32}(x[rs1])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
@irdl_op_definition
class FCvtSWuOp(RdRsFloatOperation[IntRegisterType]):
    """
    Converts a 32-bit unsigned integer, in integer register rs1 into a floating-point
    number in floating-point register rd.

    ```C
    f[rd] = f32_{u32}(x[rs1])
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fcvt.s.wu).
    """

    name = "riscv.fcvt.s.wu"

name = 'riscv.fcvt.s.wu' class-attribute instance-attribute

FMvWXOp dataclass

Bases: RdRsFloatOperation[IntRegisterType]

Move the single-precision value encoded in IEEE 754-2008 standard encoding from the lower 32 bits of integer register rs1 to the floating-point register rd.

f[rd] = x[rs1][31:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
@irdl_op_definition
class FMvWXOp(RdRsFloatOperation[IntRegisterType]):
    """
    Move the single-precision value encoded in IEEE 754-2008 standard encoding from the
    lower 32 bits of integer register rs1 to the floating-point register rd.

    ```C
    f[rd] = x[rs1][31:0]
    ```


    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmv.w.x).
    """

    name = "riscv.fmv.w.x"

name = 'riscv.fmv.w.x' class-attribute instance-attribute

FLwOpHasCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
2873
2874
2875
2876
2877
2878
2879
2880
class FLwOpHasCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            LoadFloatWordWithKnownOffset,
        )

        return (LoadFloatWordWithKnownOffset(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
2874
2875
2876
2877
2878
2879
2880
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        LoadFloatWordWithKnownOffset,
    )

    return (LoadFloatWordWithKnownOffset(),)

FLwOp dataclass

Bases: RdRsImmFloatOperation

Load a single-precision value from memory into floating-point register rd.

f[rd] = M[x[rs1] + sext(offset)][31:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
@irdl_op_definition
class FLwOp(RdRsImmFloatOperation):
    """
    Load a single-precision value from memory into floating-point register rd.

    ```C
    f[rd] = M[x[rs1] + sext(offset)][31:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#flw).
    """

    name = "riscv.flw"

    traits = traits_def(FLwOpHasCanonicalizationPatternTrait(), MemoryReadEffect())

    def assembly_line(self) -> str | None:
        instruction_name = self.assembly_instruction_name()
        value = assembly_arg_str(self.rd)
        imm = assembly_arg_str(self.immediate)
        offset = assembly_arg_str(self.rs1)
        return AssemblyPrinter.assembly_line(
            instruction_name, f"{value}, {imm}({offset})", self.comment
        )

name = 'riscv.flw' class-attribute instance-attribute

traits = traits_def(FLwOpHasCanonicalizationPatternTrait(), MemoryReadEffect()) class-attribute instance-attribute

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
2899
2900
2901
2902
2903
2904
2905
2906
def assembly_line(self) -> str | None:
    instruction_name = self.assembly_instruction_name()
    value = assembly_arg_str(self.rd)
    imm = assembly_arg_str(self.immediate)
    offset = assembly_arg_str(self.rs1)
    return AssemblyPrinter.assembly_line(
        instruction_name, f"{value}, {imm}({offset})", self.comment
    )

FSwOpHasCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
2909
2910
2911
2912
2913
2914
2915
2916
class FSwOpHasCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            StoreFloatWordWithKnownOffset,
        )

        return (StoreFloatWordWithKnownOffset(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
2910
2911
2912
2913
2914
2915
2916
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        StoreFloatWordWithKnownOffset,
    )

    return (StoreFloatWordWithKnownOffset(),)

FSwOp dataclass

Bases: RsRsImmFloatOperation

Store a single-precision value from floating-point register rs2 to memory.

M[x[rs1] + offset] = f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
@irdl_op_definition
class FSwOp(RsRsImmFloatOperation):
    """
    Store a single-precision value from floating-point register rs2 to memory.

    M[x[rs1] + offset] = f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsw).
    """

    name = "riscv.fsw"

    traits = traits_def(FSwOpHasCanonicalizationPatternTrait(), MemoryWriteEffect())

    def assembly_line(self) -> str | None:
        instruction_name = self.assembly_instruction_name()
        value = assembly_arg_str(self.rs2)
        imm = assembly_arg_str(self.immediate)
        offset = assembly_arg_str(self.rs1)
        return AssemblyPrinter.assembly_line(
            instruction_name, f"{value}, {imm}({offset})", self.comment
        )

name = 'riscv.fsw' class-attribute instance-attribute

traits = traits_def(FSwOpHasCanonicalizationPatternTrait(), MemoryWriteEffect()) class-attribute instance-attribute

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
2933
2934
2935
2936
2937
2938
2939
2940
def assembly_line(self) -> str | None:
    instruction_name = self.assembly_instruction_name()
    value = assembly_arg_str(self.rs2)
    imm = assembly_arg_str(self.immediate)
    offset = assembly_arg_str(self.rs1)
    return AssemblyPrinter.assembly_line(
        instruction_name, f"{value}, {imm}({offset})", self.comment
    )

FMAddDOp dataclass

Bases: RdRsRsRsFloatOperation

Perform double-precision fused multiply addition.

f[rd] = f[rs1]×f[rs2]+f[rs3]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
@irdl_op_definition
class FMAddDOp(RdRsRsRsFloatOperation):
    """
    Perform double-precision fused multiply addition.

    f[rd] = f[rs1]×f[rs2]+f[rs3]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmadd-d).
    """

    name = "riscv.fmadd.d"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fmadd.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FMSubDOp dataclass

Bases: RdRsRsRsFloatOperation

Perform double-precision fused multiply substraction.

f[rd] = f[rs1]×f[rs2]+f[rs3]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
@irdl_op_definition
class FMSubDOp(RdRsRsRsFloatOperation):
    """
    Perform double-precision fused multiply substraction.

    f[rd] = f[rs1]×f[rs2]+f[rs3]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmsub-d).
    """

    name = "riscv.fmsub.d"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fmsub.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FuseMultiplyAddDCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
2978
2979
2980
2981
2982
2983
2984
2985
class FuseMultiplyAddDCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            FuseMultiplyAddD,
        )

        return (FuseMultiplyAddD(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
2979
2980
2981
2982
2983
2984
2985
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        FuseMultiplyAddD,
    )

    return (FuseMultiplyAddD(),)

FAddDOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform double-precision floating-point addition.

f[rd] = f[rs1]+f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
@irdl_op_definition
class FAddDOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform double-precision floating-point addition.

    f[rd] = f[rs1]+f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fadd-d).
    """

    name = "riscv.fadd.d"

    traits = traits_def(
        AlwaysSpeculatable(),
        FuseMultiplyAddDCanonicalizationPatternTrait(),
    )

name = 'riscv.fadd.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable(), FuseMultiplyAddDCanonicalizationPatternTrait()) class-attribute instance-attribute

FSubDOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform double-precision floating-point substraction.

f[rd] = f[rs1]-f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
@irdl_op_definition
class FSubDOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform double-precision floating-point substraction.

    f[rd] = f[rs1]-f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsub-d).
    """

    name = "riscv.fsub.d"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fsub.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FMulDOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform double-precision floating-point multiplication.

f[rd] = f[rs1]×f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
@irdl_op_definition
class FMulDOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform double-precision floating-point multiplication.

    f[rd] = f[rs1]×f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmul-d).
    """

    name = "riscv.fmul.d"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fmul.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FDivDOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Perform double-precision floating-point division.

f[rd] = f[rs1] / f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
@irdl_op_definition
class FDivDOp(RdRsRsFloatOperationWithFastMath):
    """
    Perform double-precision floating-point division.

    f[rd] = f[rs1] / f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fdiv-d).
    """

    name = "riscv.fdiv.d"

name = 'riscv.fdiv.d' class-attribute instance-attribute

FLdOpHasCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
3049
3050
3051
3052
3053
3054
3055
3056
class FLdOpHasCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            LoadDoubleWithKnownOffset,
        )

        return (LoadDoubleWithKnownOffset(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
3050
3051
3052
3053
3054
3055
3056
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        LoadDoubleWithKnownOffset,
    )

    return (LoadDoubleWithKnownOffset(),)

FMinDOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Write the smaller of double precision data in rs1 and rs2 to rd.

f[rd] = min(f[rs1], f[rs2])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
@irdl_op_definition
class FMinDOp(RdRsRsFloatOperationWithFastMath):
    """
    Write the smaller of double precision data in rs1 and rs2 to rd.

    f[rd] = min(f[rs1], f[rs2])

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmin-d).
    """

    name = "riscv.fmin.d"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fmin.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FMaxDOp dataclass

Bases: RdRsRsFloatOperationWithFastMath

Write the larger of single precision data in rs1 and rs2 to rd.

f[rd] = max(f[rs1], f[rs2])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
@irdl_op_definition
class FMaxDOp(RdRsRsFloatOperationWithFastMath):
    """
    Write the larger of single precision data in rs1 and rs2 to rd.

    f[rd] = max(f[rs1], f[rs2])

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fmax-d).
    """

    name = "riscv.fmax.d"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fmax.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FCvtDWOp dataclass

Bases: RdRsFloatOperation[IntRegisterType]

Converts a 32-bit signed integer, in integer register rs1 into a double-precision floating-point number in floating-point register rd.

x[rd] = sext(s32_{f64}(f[rs1]))

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
@irdl_op_definition
class FCvtDWOp(RdRsFloatOperation[IntRegisterType]):
    """
    Converts a 32-bit signed integer, in integer register rs1 into a double-precision
    floating-point number in floating-point register rd.

    x[rd] = sext(s32_{f64}(f[rs1]))

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fcvt-d-w).
    """

    name = "riscv.fcvt.d.w"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fcvt.d.w' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FCvtDWuOp dataclass

Bases: RdRsFloatOperation[IntRegisterType]

Converts a 32-bit unsigned integer, in integer register rs1 into a double-precision floating-point number in floating-point register rd.

f[rd] = f64_{u32}(x[rs1])

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
@irdl_op_definition
class FCvtDWuOp(RdRsFloatOperation[IntRegisterType]):
    """
    Converts a 32-bit unsigned integer, in integer register rs1 into a double-precision
    floating-point number in floating-point register rd.

    f[rd] = f64_{u32}(x[rs1])

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fcvt-d-wu).
    """

    name = "riscv.fcvt.d.wu"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.fcvt.d.wu' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

FLdOp dataclass

Bases: RdRsImmFloatOperation

Load a double-precision value from memory into floating-point register rd.

f[rd] = M[x[rs1] + sext(offset)][63:0]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
@irdl_op_definition
class FLdOp(RdRsImmFloatOperation):
    """
    Load a double-precision value from memory into floating-point register rd.

    ```C
    f[rd] = M[x[rs1] + sext(offset)][63:0]
    ```

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fld).
    """

    name = "riscv.fld"

    traits = traits_def(FLdOpHasCanonicalizationPatternTrait(), MemoryReadEffect())

    def assembly_line(self) -> str | None:
        instruction_name = self.assembly_instruction_name()
        value = assembly_arg_str(self.rd)
        imm = assembly_arg_str(self.immediate)
        offset = assembly_arg_str(self.rs1)
        if isinstance(self.immediate, LabelAttr):
            return AssemblyPrinter.assembly_line(
                instruction_name, f"{value}, {imm}, {offset}", self.comment
            )
        else:
            return AssemblyPrinter.assembly_line(
                instruction_name, f"{value}, {imm}({offset})", self.comment
            )

name = 'riscv.fld' class-attribute instance-attribute

traits = traits_def(FLdOpHasCanonicalizationPatternTrait(), MemoryReadEffect()) class-attribute instance-attribute

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
def assembly_line(self) -> str | None:
    instruction_name = self.assembly_instruction_name()
    value = assembly_arg_str(self.rd)
    imm = assembly_arg_str(self.immediate)
    offset = assembly_arg_str(self.rs1)
    if isinstance(self.immediate, LabelAttr):
        return AssemblyPrinter.assembly_line(
            instruction_name, f"{value}, {imm}, {offset}", self.comment
        )
    else:
        return AssemblyPrinter.assembly_line(
            instruction_name, f"{value}, {imm}({offset})", self.comment
        )

FSdOpHasCanonicalizationPatternTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
3152
3153
3154
3155
3156
3157
3158
3159
class FSdOpHasCanonicalizationPatternTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import (
            StoreDoubleWithKnownOffset,
        )

        return (StoreDoubleWithKnownOffset(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
3153
3154
3155
3156
3157
3158
3159
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import (
        StoreDoubleWithKnownOffset,
    )

    return (StoreDoubleWithKnownOffset(),)

FSdOp dataclass

Bases: RsRsImmFloatOperation

Store a double-precision value from floating-point register rs2 to memory.

M[x[rs1] + offset] = f[rs2]

See external documentation.

Source code in xdsl/dialects/riscv/ops.py
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
@irdl_op_definition
class FSdOp(RsRsImmFloatOperation):
    """
    Store a double-precision value from floating-point register rs2 to memory.

    M[x[rs1] + offset] = f[rs2]

    See external [documentation](https://msyksphinz-self.github.io/riscv-isadoc/html/rvfd.html#fsw).
    """

    name = "riscv.fsd"

    traits = traits_def(FSdOpHasCanonicalizationPatternTrait(), MemoryWriteEffect())

    def assembly_line(self) -> str | None:
        instruction_name = self.assembly_instruction_name()
        value = assembly_arg_str(self.rs2)
        imm = assembly_arg_str(self.immediate)
        offset = assembly_arg_str(self.rs1)
        return AssemblyPrinter.assembly_line(
            instruction_name, f"{value}, {imm}({offset})", self.comment
        )

name = 'riscv.fsd' class-attribute instance-attribute

traits = traits_def(FSdOpHasCanonicalizationPatternTrait(), MemoryWriteEffect()) class-attribute instance-attribute

assembly_line() -> str | None

Source code in xdsl/dialects/riscv/ops.py
3176
3177
3178
3179
3180
3181
3182
3183
def assembly_line(self) -> str | None:
    instruction_name = self.assembly_instruction_name()
    value = assembly_arg_str(self.rs2)
    imm = assembly_arg_str(self.immediate)
    offset = assembly_arg_str(self.rs1)
    return AssemblyPrinter.assembly_line(
        instruction_name, f"{value}, {imm}({offset})", self.comment
    )

FMvDHasCanonicalizationPatternsTrait dataclass

Bases: HasCanonicalizationPatternsTrait

Source code in xdsl/dialects/riscv/ops.py
3186
3187
3188
3189
3190
3191
class FMvDHasCanonicalizationPatternsTrait(HasCanonicalizationPatternsTrait):
    @classmethod
    def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
        from xdsl.transforms.canonicalization_patterns.riscv import RemoveRedundantFMvD

        return (RemoveRedundantFMvD(),)

get_canonicalization_patterns() -> tuple[RewritePattern, ...] classmethod

Source code in xdsl/dialects/riscv/ops.py
3187
3188
3189
3190
3191
@classmethod
def get_canonicalization_patterns(cls) -> tuple[RewritePattern, ...]:
    from xdsl.transforms.canonicalization_patterns.riscv import RemoveRedundantFMvD

    return (RemoveRedundantFMvD(),)

FMvDOp dataclass

Bases: RdRsFloatOperation[FloatRegisterType]

A pseudo instruction to copy 64 bits of one float register to another.

Equivalent to fsgnj.d rd, rs, rs.

Source code in xdsl/dialects/riscv/ops.py
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
@irdl_op_definition
class FMvDOp(RdRsFloatOperation[FloatRegisterType]):
    """
    A pseudo instruction to copy 64 bits of one float register to another.

    Equivalent to `fsgnj.d rd, rs, rs`.
    """

    name = "riscv.fmv.d"

    traits = traits_def(
        AlwaysSpeculatable(),
        FMvDHasCanonicalizationPatternsTrait(),
    )

name = 'riscv.fmv.d' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable(), FMvDHasCanonicalizationPatternsTrait()) class-attribute instance-attribute

VFAddSOp dataclass

Bases: RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]

Perform a pointwise single-precision floating-point addition over vectors.

If the registers used are FloatRegisterType, they must be 64-bit wide, and contain two 32-bit single-precision floating point values.

Source code in xdsl/dialects/riscv/ops.py
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
@irdl_op_definition
class VFAddSOp(RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]):
    """
    Perform a pointwise single-precision floating-point addition over vectors.

    If the registers used are FloatRegisterType, they must be 64-bit wide, and contain two
    32-bit single-precision floating point values.
    """

    name = "riscv.vfadd.s"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.vfadd.s' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute

VFMulSOp dataclass

Bases: RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]

Perform a pointwise single-precision floating-point multiplication over vectors.

If the registers used are FloatRegisterType, they must be 64-bit wide, and contain two 32-bit single-precision floating point values.

Source code in xdsl/dialects/riscv/ops.py
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
@irdl_op_definition
class VFMulSOp(RdRsRsFloatOperation[FloatRegisterType, FloatRegisterType]):
    """
    Perform a pointwise single-precision floating-point multiplication over vectors.

    If the registers used are FloatRegisterType, they must be 64-bit wide, and contain two
    32-bit single-precision floating point values.
    """

    name = "riscv.vfmul.s"

    traits = traits_def(AlwaysSpeculatable())

name = 'riscv.vfmul.s' class-attribute instance-attribute

traits = traits_def(AlwaysSpeculatable()) class-attribute instance-attribute