iron.worker.Worker Class Reference

Inheritance diagram for iron.worker.Worker:

Collaboration diagram for iron.worker.Worker:

Public Member Functions
	__init__ (self, Callable|None core_fn, list fn_args=[], PlacementTile|None placement=AnyComputeTile, bool while_true=True, int stack_size=None, str allocation_scheme=None, int trace=None, list trace_events=None)
None	place (self, Tile tile)
list[ObjectFifoHandle]	fifos (self)
list[GlobalBuffer]	buffers (self)
None	resolve (self, ir.Location|None loc=None, ir.InsertionPoint|None ip=None)
Public Member Functions inherited from iron.placeable.Placeable
PlacementTile|None	tile (self)

Public Attributes
	stack_size
	allocation_scheme
	trace
	trace_events
	core_fn
	fn_args
	link_with

Static Public Attributes
	current_core_placement

Protected Attributes
	_tile
	_while_true
	_fifos
	_buffers
	_barriers
Protected Attributes inherited from iron.placeable.Placeable
	_tile

Detailed Description

_summary_
Worker is an object that takes a `core_fn` and a set of arguments.
A Worker must be placed on a Compute Core.

This variable is the current core if resolving() within the Worker, or None otherwise.

Constructor & Destructor Documentation

__init__()

iron.worker.Worker.__init__	(		self,
		Callable | None	core_fn,
		list	fn_args = [],
		PlacementTile | None	placement = AnyComputeTile,
		bool	while_true = True,
		int	stack_size = None,
		str	allocation_scheme = None,
		int	trace = None,
		list	trace_events = None
	)

Construct a Worker

Args:
    core_fn (Callable | None): The task to run on a core. If None, a busy-loop (`while(true): pass`) core will be generated.
    fn_args (list, optional): Pointers to arguments, which should include all context the core_fn needs to run. Defaults to [].
    placement (PlacementTile | None, optional): The placement for the Worker. Defaults to AnyComputeTile.
    while_true (bool, optional): If true, will wrap the core_fn in a while(true) loop to ensure it runs until reconfiguration. Defaults to True.
    stack_size (int, optional): The stack_size in bytes to be allocated for the worker. Defaults to 1024 bytes.
    allocation_scheme (str, optional): The memory allocation scheme to use for the Worker, either 'basic-sequential' or 'bank-aware'. If None, defaults to bank-aware.
        Will override any allocation scheme set on the tile given as placement.
    trace (int, optional): If >0, enable tracing for this worker.

Raises:
    ValueError: Parameters are validated.

Reimplemented from iron.placeable.Placeable.

Member Function Documentation

buffers()

list[GlobalBuffer] iron.worker.Worker.buffers

(

self

)

Returns a list of GlobalBuffers given to the Worker via fn_args.

Returns:
    list[GlobalBuffer]: GlobalBuffers used by the Worker.

fifos()

list[ObjectFifoHandle] iron.worker.Worker.fifos

(

self

)

Returns a list of ObjectFifoHandles given to the Worker via fn_args.

Returns:
    list[ObjectFifoHandle]: ObjectFifoHandles used by the Worker.

place()

None iron.worker.Worker.place	(		self,
		Tile	tile
	)

Set the placement of the Worker.

Args:
    tile (Tile): The placement location.

Reimplemented from iron.placeable.Placeable.

resolve()

None iron.worker.Worker.resolve	(		self,
		ir.Location | None	loc = None,
		ir.InsertionPoint | None	ip = None
	)

Member Data Documentation

_barriers

iron.worker.Worker._barriers

protected

_buffers

iron.worker.Worker._buffers

protected

_fifos

iron.worker.Worker._fifos

protected

_tile

iron.worker.Worker._tile

protected

_while_true

iron.worker.Worker._while_true

protected

allocation_scheme

iron.worker.Worker.allocation_scheme

core_fn

iron.worker.Worker.core_fn

current_core_placement

iron.worker.Worker.current_core_placement

static

Initial value:

=  contextvars.ContextVar(
        "current_core_placement", default=None
    )

fn_args

iron.worker.Worker.fn_args

link_with

iron.worker.Worker.link_with

stack_size

iron.worker.Worker.stack_size

trace

iron.worker.Worker.trace

trace_events

iron.worker.Worker.trace_events

---

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

• iron/worker.py