psyclone.psyir.transformations.loop_trans.LoopTrans Class Reference

Inheritance diagram for psyclone.psyir.transformations.loop_trans.LoopTrans:

Collaboration diagram for psyclone.psyir.transformations.loop_trans.LoopTrans:

Public Member Functions
def	validate (self, node, options=None)
def	name (self)
Public Member Functions inherited from psyclone.psyGen.Transformation
def	apply (self, node, options=None)

Static Public Attributes
tuple	excluded_node_types = ()

Detailed Description

This abstract class is a base class for all transformations that act
on a Loop node. It gives access to a validate function that
makes sure that the supplied node is a Loop.
We also check that all nodes to be enclosed are valid for this
transformation - this requires that the sub-class populate the
`excluded_node_types` tuple.

Definition at line 48 of file loop_trans.py.

Member Function Documentation

name()

def psyclone.psyir.transformations.loop_trans.LoopTrans.name

(

self

)

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

Reimplemented from psyclone.psyGen.Transformation.

Reimplemented in psyclone.psyir.transformations.omp_task_trans.OMPTaskTrans.

Definition at line 133 of file loop_trans.py.

    def name(self):
        '''
        :returns: the name of this class.
        :rtype: str
        '''
        return self.__class__.__name__
 
 
# For Sphinx AutoAPI documentation generation

References psyclone.psyir.symbols.symbol.Symbol.__class__.

Here is the caller graph for this function:

validate()

def psyclone.psyir.transformations.loop_trans.LoopTrans.validate	(		self,
			node,
			options = None
	)

Checks that the supplied node is a valid target for a loop
transformation.

:param node: target PSyIR node.
:type node: subclass of :py:class:`psyclone.psyir.nodes.Node`
:param options: a dictionary with options for transformations.
:type options: Optional[Dict[str, Any]]
:param bool options["node-type-check"]: this flag controls if the \
    type of the nodes enclosed in the loop should be tested to \
    avoid including unsupported nodes in a transformation.

:raises TransformationError: if the supplied node is not a (fully- \
        formed) Loop.
:raises TransformationError: if any of the nodes within the loop are \
        of an unsupported type.
:raises TransformationError: if the loop is of 'null' type.
:raises TransformationError: if the supplied options are not a \
        dictionary.

Reimplemented from psyclone.psyGen.Transformation.

Reimplemented in psyclone.transformations.Dynamo0p3RedundantComputationTrans, psyclone.transformations.GOceanOMPLoopTrans, psyclone.transformations.Dynamo0p3OMPLoopTrans, psyclone.transformations.DynamoOMPParallelLoopTrans, psyclone.psyir.transformations.parallel_loop_trans.ParallelLoopTrans, psyclone.psyir.transformations.omp_task_trans.OMPTaskTrans, psyclone.psyir.transformations.loop_tiling_2d_trans.LoopTiling2DTrans, psyclone.psyir.transformations.loop_swap_trans.LoopSwapTrans, psyclone.psyir.transformations.hoist_loop_bound_expr_trans.HoistLoopBoundExprTrans, and psyclone.psyir.transformations.chunk_loop_trans.ChunkLoopTrans.

Definition at line 64 of file loop_trans.py.

    def validate(self, node, options=None):
        '''Checks that the supplied node is a valid target for a loop
        transformation.
 
        :param node: target PSyIR node.
        :type node: subclass of :py:class:`psyclone.psyir.nodes.Node`
        :param options: a dictionary with options for transformations.
        :type options: Optional[Dict[str, Any]]
        :param bool options["node-type-check"]: this flag controls if the \
            type of the nodes enclosed in the loop should be tested to \
            avoid including unsupported nodes in a transformation.
 
        :raises TransformationError: if the supplied node is not a (fully- \
                formed) Loop.
        :raises TransformationError: if any of the nodes within the loop are \
                of an unsupported type.
        :raises TransformationError: if the loop is of 'null' type.
        :raises TransformationError: if the supplied options are not a \
                dictionary.
 
        '''
        # pylint: disable=too-many-branches
        if not isinstance(node, Loop):
            raise TransformationError(
                f"Target of {self.name} transformation must be a sub-class of "
                f"Loop but got '{type(node).__name__}'")
 
        # The loop must be fully-formed.
        if len(node.children) != 4:
            raise TransformationError(
                f"Error in {self.name} transformation. The target loop "
                f"must have four children but found: "
                f"{[type(child).__name__ for child in node.children]}.")
 
        if not options:
            options = {}
        if not isinstance(options, dict):
            raise TransformationError(
                f"Transformation validate method 'options' argument must be a "
                f"dictionary but found '{type(options).__name__}'.")
 
        # Check that the proposed region contains only supported node types
        if options.get("node-type-check", True):
            # Stop at any instance of Kern to avoid going into the
            # actual kernels, e.g. in Nemo inlined kernels
            flat_list = [item for item in node.walk(object, stop_type=Kern)
                         if not isinstance(item, Schedule)]
            for item in flat_list:
                if isinstance(item, self.excluded_node_types):
                    raise TransformationError(
                        f"Nodes of type '{type(item).__name__}' cannot be "
                        f"enclosed by a {self.name} transformation")
 
        # Disable warning to avoid circular dependency
        # pylint: disable=import-outside-toplevel
        from psyclone.domain.common.psylayer import PSyLoop
 
        # A 'null' loop is one which exists in the PSyIR hierarchy (mainly for
        # halo-exchange logic) but does *not* correspond to an actual loop
        # in the code that is generated for the PSy layer.
 
        # TODO 1756: PSyLoop is a PSy-layer concept and 'null' is only defined
        # in LFRic. Maybe a generic transformation validation is not the best
        # place for this check.
        if isinstance(node, PSyLoop) and node.loop_type == 'null':
            raise TransformationError(
                f"Cannot apply a {self.name} transformation to a 'null' loop.")
 

References psyclone.psyir.transformations.extract_trans.ExtractTrans.excluded_node_types, psyclone.psyir.transformations.loop_swap_trans.LoopSwapTrans.excluded_node_types, psyclone.psyir.transformations.loop_trans.LoopTrans.excluded_node_types, psyclone.psyir.transformations.omp_target_trans.OMPTargetTrans.excluded_node_types, psyclone.psyir.transformations.parallel_loop_trans.ParallelLoopTrans.excluded_node_types, psyclone.psyir.transformations.profile_trans.ProfileTrans.excluded_node_types, psyclone.psyir.transformations.psy_data_trans.PSyDataTrans.excluded_node_types, psyclone.psyir.transformations.region_trans.RegionTrans.excluded_node_types, psyclone.transformations.ACCLoopTrans.excluded_node_types, psyclone.transformations.ParallelRegionTrans.excluded_node_types, psyclone.transformations.OMPSingleTrans.excluded_node_types, psyclone.transformations.OMPMasterTrans.excluded_node_types, psyclone.transformations.OMPParallelTrans.excluded_node_types, psyclone.transformations.ACCParallelTrans.excluded_node_types, psyclone.transformations.ACCKernelsTrans.excluded_node_types, and psyclone.transformations.ACCDataTrans.excluded_node_types.

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/psyir/transformations/loop_trans.py