Inheritance diagram for psyclone.transformations.ACCRoutineTrans:

[legend]

Collaboration diagram for psyclone.transformations.ACCRoutineTrans:

[legend]

Public Member Functions
def	name (self)

def	apply (self, node, options=None)

def	validate (self, node, options=None)

Public Member Functions inherited from psyclone.transformations.MarkRoutineForGPUMixin
def	validate_it_can_run_on_gpu (self, node, options)

Detailed Description

Transform a kernel or routine by adding a "!$acc routine" directive
(causing it to be compiled for the OpenACC accelerator device).
For example:

>>> from psyclone.parse.algorithm import parse
>>> from psyclone.psyGen import PSyFactory
>>> api = "gocean1.0"
>>> ast, invokeInfo = parse(GOCEAN_SOURCE_FILE, api=api)
>>> psy = PSyFactory(api).create(invokeInfo)
>>>
>>> from psyclone.transformations import ACCRoutineTrans
>>> rtrans = ACCRoutineTrans()
>>>
>>> schedule = psy.invokes.get('invoke_0').schedule
>>> # Uncomment the following line to see a text view of the schedule
>>> # print(schedule.view())
>>> kern = schedule.children[0].children[0].children[0]
>>> # Transform the kernel
>>> rtrans.apply(kern)

Definition at line 2507 of file transformations.py.

Member Function Documentation

◆ apply()

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

Add the '!$acc routine' OpenACC directive into the code of the
supplied Kernel (in a PSyKAl API such as GOcean or LFRic) or directly
in the supplied Routine.

:param node: the kernel call or routine implementation to transform.
:type node: :py:class:`psyclone.psyGen.Kern` or \
            :py:class:`psyclone.psyir.nodes.Routine`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2538 of file transformations.py.

     def apply(self, node, options=None):
         '''
         Add the '!$acc routine' OpenACC directive into the code of the
         supplied Kernel (in a PSyKAl API such as GOcean or LFRic) or directly
         in the supplied Routine.
  
         :param node: the kernel call or routine implementation to transform.
         :type node: :py:class:`psyclone.psyGen.Kern` or \
                     :py:class:`psyclone.psyir.nodes.Routine`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         '''
         # Check that we can safely apply this transformation
         self.validate(node, options)
  
         if isinstance(node, Kern):
             # Flag that the kernel has been modified
             node.modified = True
  
             # Get the schedule representing the kernel subroutine
             routine = node.get_kernel_schedule()
         else:
             routine = node
  
         # Insert the directive to the routine if it doesn't already exist
         for child in routine.children:
             if isinstance(child, ACCRoutineDirective):
                 return  # The routine is already marked with ACCRoutine
         routine.children.insert(0, ACCRoutineDirective())
  

Here is the call graph for this function:

◆ name()

def psyclone.transformations.ACCRoutineTrans.name ( self )

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

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2531 of file transformations.py.

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

Here is the caller graph for this function:

◆ validate()

def psyclone.transformations.ACCRoutineTrans.validate	(	self,
		node,
		options = `None`
	)

Perform checks that the supplied kernel or routine can be transformed.

:param node: the kernel or routine which is the target of this
    transformation.
:type node: :py:class:`psyclone.psyGen.Kern` |
            :py:class:`psyclone.psyir.nodes.Routine`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]
:param bool options["force"]: whether to allow routines with
    CodeBlocks to run on the GPU.

:raises TransformationError: if the node is not a kernel or a routine.
:raises TransformationError: if the target is a built-in kernel.
:raises TransformationError: if it is a kernel but without an
                             associated PSyIR.
:raises TransformationError: if any of the symbols in the kernel are
                             accessed via a module use statement.
:raises TransformationError: if the kernel contains any calls to other
                             routines.

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2569 of file transformations.py.

     def validate(self, node, options=None):
         '''
         Perform checks that the supplied kernel or routine can be transformed.
  
         :param node: the kernel or routine which is the target of this
             transformation.
         :type node: :py:class:`psyclone.psyGen.Kern` |
                     :py:class:`psyclone.psyir.nodes.Routine`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
         :param bool options["force"]: whether to allow routines with
             CodeBlocks to run on the GPU.
  
         :raises TransformationError: if the node is not a kernel or a routine.
         :raises TransformationError: if the target is a built-in kernel.
         :raises TransformationError: if it is a kernel but without an
                                      associated PSyIR.
         :raises TransformationError: if any of the symbols in the kernel are
                                      accessed via a module use statement.
         :raises TransformationError: if the kernel contains any calls to other
                                      routines.
         '''
         super().validate(node, options)
  
         self.validate_it_can_run_on_gpu(node, options)
  
  

References psyclone.transformations.MarkRoutineForGPUMixin.validate_it_can_run_on_gpu().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Detailed Description

Member Function Documentation

◆ apply()

◆ name()

◆ validate()