# -----------------------------------------------------------------------------
# BSD 3-Clause License
#
# Copyright (c) 2017-2026, Science and Technology Facilities Council.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
# Authors R. W. Ford, A. R. Porter, S. Siso and N. Nobre, STFC Daresbury Lab
# A. B. G. Chalk, V. K. Atkinson, STFC Daresbury Lab
# J. Henrichs, Bureau of Meteorology
# Modified I. Kavcic, J. G. Wallwork, O. Brunt and L. Turner, Met Office
# S. Valat, Inria / Laboratoire Jean Kuntzmann
# M. Schreiber, Univ. Grenoble Alpes / Inria / Lab. Jean Kuntzmann
# J. Dendy, Met Office
from psyclone.psyir.transformations.parallel_loop_trans import (
ParallelLoopTrans)
from psyclone.psyir.nodes import (ACCLoopDirective, PSyDataNode)
[docs]
class ACCLoopTrans(ParallelLoopTrans):
'''
Adds an OpenACC loop directive to a loop. This directive must be within
the scope of some OpenACC Parallel region (at code-generation time).
For example:
>>> from psyclone.parse.algorithm import parse
>>> from psyclone.parse.utils import ParseError
>>> from psyclone.psyGen import PSyFactory
>>> from psyclone.errors import GenerationError
>>> from psyclone.psyir.transformations import ACCLoopTrans
>>> from psyclone.transformations import ACCParallelTrans
>>> api = "gocean"
>>> ast, invokeInfo = parse(GOCEAN_SOURCE_FILE, api=api)
>>> psy = PSyFactory(api).create(invokeInfo)
>>>
>>> ltrans = ACCLoopTrans()
>>> rtrans = 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
>>> rtrans.apply(schedule)
>>>
'''
# The types of node that must be excluded from the section of PSyIR
# being transformed.
excluded_node_types = (PSyDataNode,)
def __init__(self):
# Whether to add the "independent" clause
# to the loop directive.
self._independent = True
self._sequential = False
self._gang = False
self._vector = False
super().__init__()
def __str__(self):
return "Adds an 'OpenACC loop' directive to a loop"
def _directive(self, children, collapse=None):
'''
Creates the ACCLoopDirective needed by this sub-class of
transformation.
:param children: list of child nodes of the new directive Node.
:type children: list of :py:class:`psyclone.psyir.nodes.Node`
:param int collapse: number of nested loops to collapse or None if
no collapse attribute is required.
'''
directive = ACCLoopDirective(children=children,
collapse=collapse,
independent=self._independent,
sequential=self._sequential,
gang=self._gang,
vector=self._vector)
return directive
[docs]
def apply(self, node, options=None):
'''
Apply the ACCLoop transformation to the specified node. This node
must be a Loop since this transformation corresponds to
inserting a directive immediately before a loop, e.g.:
.. code-block:: fortran
!$ACC LOOP
do ...
...
end do
At code-generation time (when lowering is called),
this node must be within (i.e. a child of) a PARALLEL region.
:param node: the supplied node to which we will apply the
Loop transformation.
:type node: :py:class:`psyclone.psyir.nodes.Loop`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]
:param int options["collapse"]: number of nested loops to collapse.
:param bool options["independent"]: whether to add the "independent"
clause to the directive (not strictly necessary within
PARALLEL regions).
:param bool options["sequential"]: whether to add the "seq" clause to
the directive.
:param bool options["gang"]: whether to add the "gang" clause to the
directive.
:param bool options["vector"]: whether to add the "vector" clause to
the directive.
'''
# Store sub-class specific options. These are used when
# creating the directive (in the _directive() method).
if not options:
options = {}
self._independent = options.get("independent", True)
self._sequential = options.get("sequential", False)
self._gang = options.get("gang", False)
self._vector = options.get("vector", False)
# Call the apply() method of the base class
super().apply(node, options)
# For Sphinx AutoAPI documentation generation
__all__ = ["ACCLoopTrans"]
