Inheritance diagram for psyclone.transformations.OMPDeclareTargetTrans:

[legend]

Collaboration diagram for psyclone.transformations.OMPDeclareTargetTrans:

[legend]

Public Member Functions
def	apply (self, node, options=None)

def	validate (self, node, options=None)

Public Member Functions inherited from psyclone.psyGen.Transformation
def	name (self)

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

Detailed Description

Adds an OpenMP declare target directive to the specified routine.

For example:

>>> from psyclone.psyir.frontend.fortran import FortranReader
>>> from psyclone.psyir.nodes import Loop
>>> from psyclone.transformations import OMPDeclareTargetTrans
>>>
>>> tree = FortranReader().psyir_from_source("""
...     subroutine my_subroutine(A)
...         integer, dimension(10, 10), intent(inout) :: A
...         integer :: i
...         integer :: j
...         do i = 1, 10
...             do j = 1, 10
...                 A(i, j) = 0
...             end do
...         end do
...     end subroutine
...     """
>>> omptargettrans = OMPDeclareTargetTrans()
>>> omptargettrans.apply(tree.walk(Routine)[0])

will generate:

.. code-block:: fortran

    subroutine my_subroutine(A)
        integer, dimension(10, 10), intent(inout) :: A
        integer :: i
        integer :: j
        !$omp declare target
        do i = 1, 10
            do j = 1, 10
                A(i, j) = 0
            end do
        end do
    end subroutine

Definition at line 483 of file transformations.py.

Member Function Documentation

◆ apply()

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

 Insert an OMPDeclareTargetDirective inside the provided routine.

:param node: the PSyIR routine to insert the directive into.
:type node: :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 525 of file transformations.py.

     def apply(self, node, options=None):
         ''' Insert an OMPDeclareTargetDirective inside the provided routine.
  
         :param node: the PSyIR routine to insert the directive into.
         :type node: :py:class:`psyclone.psyir.nodes.Routine`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         '''
         self.validate(node, options)
         for child in node.children:
             if isinstance(child, OMPDeclareTargetDirective):
                 return  # The routine is already marked with OMPDeclareTarget
         node.children.insert(0, OMPDeclareTargetDirective())
  

Here is the call graph for this function:

◆ validate()

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

 Check that an OMPDeclareTargetDirective can be inserted.

: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 540 of file transformations.py.

     def validate(self, node, options=None):
         ''' Check that an OMPDeclareTargetDirective can be inserted.
  
         :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=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()

◆ validate()