iron.runtime.dmatask.DMATask Class Reference

Inheritance diagram for iron.runtime.dmatask.DMATask:

Collaboration diagram for iron.runtime.dmatask.DMATask:

Public Member Functions
	__init__ (self, ObjectFifoHandle object_fifo, RuntimeData rt_data, TensorAccessPattern tap, RuntimeTaskGroup|None task_group=None, bool wait=False, str|None offset_parameter=None, tuple[int, int]|None packet=None)
bool	will_wait (self)
ObjectFifoHandle	fifo (self)
	task (self)
None	resolve (self, ir.Location|None loc=None, ir.InsertionPoint|None ip=None)
Public Member Functions inherited from iron.runtime.task.RuntimeTask
RuntimeTaskGroup|None	task_group (self)
Public Member Functions inherited from iron.resolvable.Resolvable
list	tiles (self)

Protected Attributes
	_object_fifo
	_rt_data
	_tap
	_wait
	_offset_parameter
	_packet
	_task
Protected Attributes inherited from iron.runtime.task.RuntimeTask
	_task_group

Constructor & Destructor Documentation

__init__()

iron.runtime.dmatask.DMATask.__init__	(		self,
		ObjectFifoHandle	object_fifo,
		RuntimeData	rt_data,
		TensorAccessPattern	tap,
		RuntimeTaskGroup | None	task_group = None,
		bool	wait = False,
		str | None	offset_parameter = None,
		tuple[int, int] | None	packet = None
	)

A RuntimeTask that will resolve to a DMA Operation.

Args:
    object_fifo (ObjectFifoHandle): The ObjectFifoHandle associated with the operation
    rt_data (RuntimeData): The Runtime buffer associated with the operation.
    tap (TensorAccessPattern): The access pattern associated with the operation.
    task_group (RuntimeTaskGroup | None, optional): The task group associated with the operation. Defaults to None.
    wait (bool, optional): Whether this task should conclude with a call to await or a call to free. Defaults to False.
    offset_parameter (str | None, optional): Name of a ScratchpadParameter whose value is used as the element offset for this DMA transfer. Defaults to None.
    packet (tuple[int, int] | None, optional): Stamp the shim DMA's
        BD with a packet header ``(pkt_type, pkt_id)``.  Pairs with
        downstream packet-switched routing (e.g. ObjectFifos
        lowered with ``--packet-sw-objFifos`` or an explicit
        :class:`PacketFlow`).  Defaults to None.

Reimplemented from iron.runtime.task.RuntimeTask.

Member Function Documentation

fifo()

ObjectFifoHandle iron.runtime.dmatask.DMATask.fifo

(

self

)

The ObjectFifoHandle associated with this task.

resolve()

None iron.runtime.dmatask.DMATask.resolve	(		self,
		ir.Location | None	loc = None,
		ir.InsertionPoint | None	ip = None
	)

Resolve the current object into one or more MLIR operations.
Should only be called within an MLIR context.

Args:
    loc (ir.Location | None, optional): Location is used by MLIR object during construction in some cases. Defaults to None.
    ip (ir.InsertionPoint | None, optional): InsertionPoint is used by MLIR object during construction in some cases. Defaults to None.

Reimplemented from iron.runtime.task.RuntimeTask.

task()

iron.runtime.dmatask.DMATask.task

(

self

)

The MLIR op generated by resolve(). This handle is used after resolution for await or free operations as
dictated by a RuntimeTaskGroup Finish operation

will_wait()

bool iron.runtime.dmatask.DMATask.will_wait

(

self

)

Whether this task should conclude with an await operation.

Member Data Documentation

_object_fifo

iron.runtime.dmatask.DMATask._object_fifo

protected

_offset_parameter

iron.runtime.dmatask.DMATask._offset_parameter

protected

_packet

iron.runtime.dmatask.DMATask._packet

protected

_rt_data

iron.runtime.dmatask.DMATask._rt_data

protected

_tap

iron.runtime.dmatask.DMATask._tap

protected

_task

iron.runtime.dmatask.DMATask._task

protected

_wait

iron.runtime.dmatask.DMATask._wait

protected

---

The documentation for this class was generated from the following file:

• iron/runtime/dmatask.py