Inheritance diagram for psyclone.transformations.ACCEnterDataTrans:

[legend]

Collaboration diagram for psyclone.transformations.ACCEnterDataTrans:

[legend]

Public Member Functions
def	__str__ (self)

def	name (self)

def	apply (self, sched, options=None)

def	validate (self, sched, options=None)

Detailed Description

Adds an OpenACC "enter data" directive to a Schedule.
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 \
    ACCEnterDataTrans, ACCLoopTrans, ACCParallelTrans
>>> dtrans = ACCEnterDataTrans()
>>> ltrans = ACCLoopTrans()
>>> ptrans = ACCParallelTrans()
>>>
>>> schedule = psy.invokes.get('invoke_0').schedule
>>> # Uncomment the following line to see a text view of the schedule
>>> # print(schedule.view())
>>>
>>> # Apply the OpenACC Loop transformation to *every* loop in the schedule
>>> for child in schedule.children[:]:
...     ltrans.apply(child)
>>>
>>> # Enclose all of these loops within a single OpenACC parallel region
>>> ptrans.apply(schedule)
>>>
>>> # Add an enter data directive
>>> dtrans.apply(schedule)
>>>
>>> # Uncomment the following line to see a text view of the schedule
>>> # print(schedule.view())

Definition at line 2389 of file transformations.py.

Member Function Documentation

◆ apply()

def psyclone.transformations.ACCEnterDataTrans.apply	(	self,
		sched,
		options = `None`
	)

Adds an OpenACC "enter data" directive to the invoke associated
with the supplied Schedule. Any fields accessed by OpenACC kernels
within this schedule will be added to this data region in
order to ensure they remain on the target device.

:param sched: schedule to which to add an "enter data" directive.
:type sched: sub-class of :py:class:`psyclone.psyir.nodes.Schedule`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2435 of file transformations.py.

     def apply(self, sched, options=None):
         # pylint: disable=arguments-renamed
         '''Adds an OpenACC "enter data" directive to the invoke associated
         with the supplied Schedule. Any fields accessed by OpenACC kernels
         within this schedule will be added to this data region in
         order to ensure they remain on the target device.
  
         :param sched: schedule to which to add an "enter data" directive.
         :type sched: sub-class of :py:class:`psyclone.psyir.nodes.Schedule`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         '''
         # Ensure that the proposed transformation is valid
         self.validate(sched, options)
  
         # pylint: disable=import-outside-toplevel
         if isinstance(sched, LFRicInvokeSchedule):
             from psyclone.dynamo0p3 import DynACCEnterDataDirective as \
                 AccEnterDataDir
         elif isinstance(sched, GOInvokeSchedule):
             from psyclone.gocean1p0 import GOACCEnterDataDirective as \
                 AccEnterDataDir
         else:
             from psyclone.psyir.nodes import ACCEnterDataDirective as \
                 AccEnterDataDir
  
         # Find the position of the first child statement of the current
         # schedule which contains an OpenACC compute construct.
         posn = 0
         directive_cls = (ACCParallelDirective, ACCKernelsDirective)
         directive = sched.walk(directive_cls, stop_type=directive_cls)
         if directive:
             current = directive[0]
             while current not in sched.children:
                 current = current.parent
             posn = sched.children.index(current)
  
         # Add the directive at the position determined above, i.e. just before
         # the first statement containing an OpenACC compute construct.
         data_dir = AccEnterDataDir(parent=sched, children=[])
         sched.addchild(data_dir, index=posn)
  

Here is the call graph for this function:

◆ name()

def psyclone.transformations.ACCEnterDataTrans.name ( self )

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

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2428 of file transformations.py.

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

Here is the caller graph for this function:

◆ validate()

def psyclone.transformations.ACCEnterDataTrans.validate	(	self,
		sched,
		options = `None`
	)

Check that we can safely apply the OpenACC enter-data transformation
to the supplied Schedule.

:param sched: Schedule to which to add an "enter data" directive.
:type sched: sub-class of :py:class:`psyclone.psyir.nodes.Schedule`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]

:raises TransformationError: if passed something that is not a \
    (subclass of) :py:class:`psyclone.psyir.nodes.Schedule`.

Reimplemented from psyclone.psyGen.Transformation.

Definition at line 2478 of file transformations.py.

     def validate(self, sched, options=None):
         # pylint: disable=arguments-differ, arguments-renamed
         '''
         Check that we can safely apply the OpenACC enter-data transformation
         to the supplied Schedule.
  
         :param sched: Schedule to which to add an "enter data" directive.
         :type sched: sub-class of :py:class:`psyclone.psyir.nodes.Schedule`
         :param options: a dictionary with options for transformations.
         :type options: Optional[Dict[str, Any]]
  
         :raises TransformationError: if passed something that is not a \
             (subclass of) :py:class:`psyclone.psyir.nodes.Schedule`.
  
         '''
         super().validate(sched, options)
  
         if not isinstance(sched, Schedule):
             raise TransformationError("Cannot apply an OpenACC enter data "
                                       "directive to something that is not a "
                                       "Schedule")
  
         # Check that we don't already have a data region of any sort
         directive_cls = (ACCDataDirective, ACCEnterDataDirective)
         if sched.walk(directive_cls, stop_type=directive_cls):
             raise TransformationError("Schedule already has an OpenACC data "
                                       "region - cannot add an enter data.")
  
  

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()