Inheritance diagram for psyclone.transformations.ACCKernelsTrans:

[legend]

Collaboration diagram for psyclone.transformations.ACCKernelsTrans:

[legend]

Public Member Functions
def	name (self)

def	apply (self, node, options=None)

def	validate (self, nodes, options)

Public Member Functions inherited from psyclone.psyir.transformations.region_trans.RegionTrans
def	get_node_list (self, nodes)

Static Public Attributes
tuple	excluded_node_types

Static Public Attributes inherited from psyclone.psyir.transformations.region_trans.RegionTrans
tuple	excluded_node_types = ()

Detailed Description

Enclose a sub-set of nodes from a Schedule within an OpenACC kernels
region (i.e. within "!$acc kernels" ... "!$acc end kernels" directives).

For example:

>>> from psyclone.parse.algorithm import parse
>>> from psyclone.psyGen import PSyFactory
>>> api = "nemo"
>>> ast, invokeInfo = parse(NEMO_SOURCE_FILE, api=api)
>>> psy = PSyFactory(api).create(invokeInfo)
>>>
>>> from psyclone.transformations import ACCKernelsTrans
>>> ktrans = ACCKernelsTrans()
>>>
>>> schedule = psy.invokes.get('tra_adv').schedule
>>> # Uncomment the following line to see a text view of the schedule
>>> # print(schedule.view())
>>> kernels = schedule.children[9]
>>> # Transform the kernel
>>> ktrans.apply(kernels)

Definition at line 2596 of file transformations.py.

Member Function Documentation

◆ apply()

def psyclone.transformations.ACCKernelsTrans.apply	(	self,
		node,
		options = `None`
	)

Enclose the supplied list of PSyIR nodes within an OpenACC
Kernels region.

:param node: a node or list of nodes in the PSyIR to enclose.
:type node: (a list of) :py:class:`psyclone.psyir.nodes.Node`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]
:param bool options["default_present"]: whether or not the kernels \
    region should have the 'default present' attribute (indicating \
    that data is already on the accelerator). When using managed \
    memory this option should be False.

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2631 of file transformations.py.

     def apply(self, node, options=None):
         '''
         Enclose the supplied list of PSyIR nodes within an OpenACC
         Kernels region.
  
         :param node: a node or list of nodes in the PSyIR to enclose.
         :type node: (a list of) :py:class:`psyclone.psyir.nodes.Node`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
         :param bool options["default_present"]: whether or not the kernels \
             region should have the 'default present' attribute (indicating \
             that data is already on the accelerator). When using managed \
             memory this option should be False.
  
         '''
         # Ensure we are always working with a list of nodes, even if only
         # one was supplied via the `node` argument.
         node_list = self.get_node_list(node)
  
         self.validate(node_list, options)
  
         parent = node_list[0].parent
         start_index = node_list[0].position
  
         if not options:
             options = {}
         default_present = options.get("default_present", False)
  
         # Create a directive containing the nodes in node_list and insert it.
         directive = ACCKernelsDirective(
             parent=parent, children=[node.detach() for node in node_list],
             default_present=default_present)
  
         parent.children.insert(start_index, directive)
  

Here is the call graph for this function:

◆ name()

def psyclone.transformations.ACCKernelsTrans.name ( self )

:returns: the name of this transformation class.
:rtype: str

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2624 of file transformations.py.

     def name(self):
         '''
         :returns: the name of this transformation class.
         :rtype: str
         '''
         return "ACCKernelsTrans"
  

Here is the caller graph for this function:

◆ validate()

def psyclone.transformations.ACCKernelsTrans.validate	(	self,
		nodes,
		options
	)

Check that we can safely enclose the supplied node or list of nodes
within OpenACC kernels ... end kernels directives.

:param nodes: the proposed PSyIR node or nodes to enclose in the \
              kernels region.
:type nodes: (list of) :py:class:`psyclone.psyir.nodes.Node`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

:raises NotImplementedError: if the supplied Nodes belong to \
                             a GOInvokeSchedule.
:raises TransformationError: if there are no Loops within the \
                             proposed region.

Reimplemented from psyclone.psyir.transformations.region_trans.RegionTrans.

Definition at line 2666 of file transformations.py.

     def validate(self, nodes, options):
         # pylint: disable=signature-differs
         '''
         Check that we can safely enclose the supplied node or list of nodes
         within OpenACC kernels ... end kernels directives.
  
         :param nodes: the proposed PSyIR node or nodes to enclose in the \
                       kernels region.
         :type nodes: (list of) :py:class:`psyclone.psyir.nodes.Node`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         :raises NotImplementedError: if the supplied Nodes belong to \
                                      a GOInvokeSchedule.
         :raises TransformationError: if there are no Loops within the \
                                      proposed region.
  
         '''
         # Ensure we are always working with a list of nodes, even if only
         # one was supplied via the `nodes` argument.
         node_list = self.get_node_list(nodes)
  
         # Check that the front-end is valid
         sched = node_list[0].ancestor((NemoInvokeSchedule,
                                        LFRicInvokeSchedule))
         if not sched:
             raise NotImplementedError(
                 "OpenACC kernels regions are currently only supported for the "
                 "nemo and dynamo0.3 front-ends")
         super().validate(node_list, options)
  
         # Check that we have at least one loop or array range within
         # the proposed region
         for node in node_list:
             if (any(assign for assign in node.walk(Assignment)
                     if assign.is_array_assignment) or node.walk(Loop)):
                 break
         else:
             # Branch executed if loop does not exit with a break
             raise TransformationError(
                 "A kernels transformation must enclose at least one loop or "
                 "array range but none were found.")
  
  

References psyclone.psyir.transformations.region_trans.RegionTrans.get_node_list().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ excluded_node_types

tuple psyclone.transformations.ACCKernelsTrans.excluded_node_types

static

Initial value:

= (CodeBlock, Return, PSyDataNode,

psyGen.HaloExchange)

Definition at line 2620 of file transformations.py.

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

/home/docs/checkouts/readthedocs.org/user_builds/psyclone-ref/checkouts/latest/src/psyclone/transformations.py

Public Member Functions