loki.transformations.field_api

A set of utility classes for dealing with FIELD API boilerplate in parallel kernels and offload regions.

Functions

`field_create_device_data`(field_ptr, scope[, ...])	Utility unction to generate a `CallStatement` corresponding to a Field API CREATE_DEVICE_DATA call.
`field_delete_device_data`(field_ptr, scope)	Utility unction to generate a `CallStatement` corresponding to a Field API DELETE_DEVICE_DATA call.
`field_get_device_data`(field_ptr, dev_ptr, ...)	Utility function to generate a `CallStatement` corresponding to a Field API `GET_DEVICE_DATA` call.
`field_get_host_data`(field_ptr, dev_ptr, ...)	Utility function to generate a `CallStatement` corresponding to a Field API `GET_HOST_DATA` call.
`field_sync_device`(field_ptr, transfer_type, ...)	Utility function to generate a `CallStatement` corresponding to a Field API `SYNC_DEVICE` call.
`field_sync_host`(field_ptr, transfer_type, scope)	Utility function to generate a `CallStatement` corresponding to a Field API `SYNC_HOST` call.
`field_wait_for_async_queue`(queue, scope)
`get_field_type`(a)	Returns the corresponding FIELD API type for an array.

Classes

`FieldAPITransferDirection`(value)	An enumeration.
`FieldAPITransferType`(value)	An enumeration.
`FieldPointerMap`(inargs, inoutargs, outargs, ...)	Helper class to map FIELD API pointers to intents and access descriptors.

class FieldAPITransferType(value)

Bases: Enum

An enumeration.

READ_ONLY = 'RDONLY'

READ_WRITE = 'RDWR'

WRITE_ONLY = 'WRONLY'

FORCE = 'FORCE'

property suffix

class FieldPointerMap(inargs, inoutargs, outargs, scope, ptr_prefix='loki_ptr_')

Bases: object

Helper class to map FIELD API pointers to intents and access descriptors.

This utility is used to store arrays passed to target kernel calls and easily access corresponding device pointers added by the transformation.

dataptr_from_array(a: Array): Returns a contiguous pointer Variable with types matching the array a.

static field_ptr_from_view(field_view): Returns a symbol for the pointer to the corresponding Field object.

property args: A tuple of all argument symbols, concatanating in/inout/out arguments

property dataptrs: Create a list of contiguous data pointer symbols

property host_to_device_calls: Returns a tuple of CallStatement for host-to-device transfers on fields.

property sync_host_calls: Returns a tuple of CallStatement for host-synchronization transfers on fields.

host_to_device_force_calls(queue=None, blk_bounds=None, offset=None): Returns a tuple of CallStatement for host-to-device force transfers on fields.

sync_host_force_calls(queue=None, blk_bounds=None, offset=None): Returns a tuple of CallStatement for host-synchronization transfers on fields.

get_field_type(a: Array) → DerivedType

Returns the corresponding FIELD API type for an array.

This function is IFS specific and assumes that the type is an array declared with one of the IFS type specifiers, e.g. KIND=JPRB

field_get_device_data(field_ptr, dev_ptr, transfer_type: FieldAPITransferType, scope: Scope, queue=None, blk_bounds=None, offset=None)

Utility function to generate a CallStatement corresponding to a Field API GET_DEVICE_DATA call.

Parameters:

field_ptr (pointer to field object) – Pointer to the field to call GET_DEVICE_DATA from.
dev_ptr (Array) – Device pointer array
transfer_type (FieldAPITransferType) – Field API transfer type to determine which GET_DEVICE_DATA method to call.
scope (Scope) – Scope of the created CallStatement
queue (integer) – QUEUE optional argument
blk_bounds (integer dimension(2) array) – BLK_BOUNDS optional argument
offset (integer) – OFFSET optional argument

field_get_host_data(field_ptr, dev_ptr, transfer_type: FieldAPITransferType, scope: Scope, queue=None, blk_bounds=None, offset=None)

Utility function to generate a CallStatement corresponding to a Field API GET_HOST_DATA call.

Parameters:

field_ptr (pointer to field object) – Pointer to the field to call GET_DEVICE_DATA from.
dev_ptr (Array) – Device pointer array
transfer_type (FieldAPITransferType) – Field API transfer type to determine which GET_HOST_DATA method to call.
scope (Scope) – Scope of the created CallStatement
queue (integer) – QUEUE optional argument
blk_bounds (integer dimension(2) array) – BLK_BOUNDS optional argument
offset (integer) – OFFSET optional argument

field_sync_device(field_ptr, transfer_type: FieldAPITransferType, scope: Scope, queue=None, blk_bounds=None, offset=None)

Utility function to generate a CallStatement corresponding to a Field API SYNC_DEVICE call.

Parameters:

field_ptr (pointer to field object) – Pointer to the field to call SYNC_HOST from.
transfer_type (FieldAPITransferType) – Field API transfer type to determine which SYNC_DEVICE method to call.
scope (Scope) – Scope of the created CallStatement
queue (integer) – QUEUE optional argument
blk_bounds (integer dimension(2) array) – BLK_BOUNDS optional argument
offset (integer) – OFFSET optional argument

field_sync_host(field_ptr, transfer_type: FieldAPITransferType, scope: Scope, queue=None, blk_bounds=None, offset=None)

Utility function to generate a CallStatement corresponding to a Field API SYNC_HOST call.

Parameters:

field_ptr (pointer to field object) – Pointer to the field to call SYNC_HOST from.
transfer_type (FieldAPITransferType) – Field API transfer type to determine which SYNC_HOST method to call.
scope (Scope) – Scope of the created CallStatement
queue (integer) – QUEUE optional argument
blk_bounds (integer dimension(2) array) – BLK_BOUNDS optional argument
offset (integer) – OFFSET optional argument

field_create_device_data(field_ptr, scope: Scope, blk_bounds=None)

Utility unction to generate a CallStatement corresponding to a Field API CREATE_DEVICE_DATA call.

Parameters:

field_ptr (pointer to field object) – Pointer to the field to call DELETE_DEVICE_DATA from.
scope (Scope) – Scope of the created CallStatement
blk_bounds (integer dimension(2) array) – BLK_BOUNDS optional argument

field_delete_device_data(field_ptr, scope)

Utility unction to generate a CallStatement corresponding to a Field API DELETE_DEVICE_DATA call.

Parameters:

field_ptr (pointer to field object) – Pointer to the field to call DELETE_DEVICE_DATA from.
scope (Scope) – Scope of the created CallStatement

field_wait_for_async_queue(queue, scope: Scope)