(Closes #3330) MetaTransformation for OpenMPCPURoutineTrans

src/psyclone/psyGen.py

@@ -2529,6 +2529,11 @@ def validate_options(self, **kwargs):
         wrong_types = {}
         for option in kwargs:
             if option not in valid_options:
+                # This is needed to enable metatransformations where
+                # only some inherited classes have options set on
+                # superclasses
+                if option == "options":
+                    continue
                 invalid_options.append(option)
                 continue
             if valid_options[option].type is not None:

src/psyclone/psyir/transformations/metatransformations/omp_cpu_routine_trans.py

@@ -0,0 +1,112 @@
+# -----------------------------------------------------------------------------
+# BSD 3-Clause License
+#
+# Copyright (c) 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 A. B. G. Chalk, STFC Daresbury Lab
+
+'''This module contains the OpenMPCPURoutineTrans metatransformation.'''
+
+from psyclone.psyGen import Transformation
+from psyclone.psyir.nodes import (
+    Directive, Loop, Routine
+)
+from psyclone.psyir.transformations.transformation_error import (
+    TransformationError)
+from psyclone.psyir.transformations.omp_loop_trans import OMPLoopTrans
+from psyclone.psyir.transformations.maximal_omp_parallel_region_trans import (
+    MaximalOMPParallelRegionTrans)
+from psyclone.psyir.transformations.omp_minimise_sync_trans import (
+    OMPMinimiseSyncTrans)
+from psyclone.utils import transformation_documentation_wrapper
+
+
+@transformation_documentation_wrapper
+class OMPCPURoutineTrans(Transformation):
+    '''FIXME Docstring'''
+    _SUB_TRANSFORMATIONS = [OMPLoopTrans, MaximalOMPParallelRegionTrans,
+                            OMPMinimiseSyncTrans]
+
+    def validate(self, node: Routine, **kwargs):
+        '''
+        Validates the input options of the OpenMPCPURoutineTrans.
+
+        :param node: The Routine node to validate.
+        '''
+        # Validate the provided options are allowed and typed correctly.
+        self.validate_options(**kwargs)
+
+    def apply(self, node: Routine, **kwargs):
+        '''
+        Applies the OMPLoopTrans, MaximalOMPParallelRegionTrans and
+        OMPMinimiseSyncTrans to the relevant parts of the input
+        node.
+
+        :param node: The Routine node to transform
+        '''
+        self.validate(node, **kwargs)
+
+        # Split the options for the subtransformations.
+        _, loop_kwargs, maxpar_kwargs, minsync_kwargs = self.split_kwargs(
+            **kwargs
+        )
+
+        # Find all of the loops.
+        loops = node.walk(Loop)
+        for loop in loops:
+            if loop.ancestor(Directive):
+                continue  # Skip if an outer loop is already parallelised
+            try:
+                # Validate that this loop can be parallelised.
+                OMPLoopTrans.validate(self, loop, **loop_kwargs)
+                # If it is, then apply the OMPLoopTrans
+                OMPLoopTrans.apply(self, loop, **loop_kwargs)
+            except TransformationError:
+                # If we fail to parallelise a loop we just skip it.
+                continue
+
+        # Apply the maximal openMP parallel region transformation to the
+        # routine.
+        MaximalOMPParallelRegionTrans.validate(self, node.children[:],
+                                               **maxpar_kwargs)
+        MaximalOMPParallelRegionTrans.apply(self, node.children[:],
+                                            **maxpar_kwargs)
+
+        nowait = self.get_option("nowait", **kwargs)
+        # If the asynchronous option was specified, then we need to apply the
+        # OMPMinimiseSyncTrans as well.
+        if nowait:
+            OMPMinimiseSyncTrans.validate(self, node, **minsync_kwargs)
+            OMPMinimiseSyncTrans.apply(self, node, **minsync_kwargs)
+
+
+# For Sphinx AutoAPI documentation generation
+__all__ = ["OMPCPURoutineTrans"]

src/psyclone/psyir/transformations/omp_minimise_sync_trans.py

@@ -35,9 +35,7 @@
 
 '''Contains the OMPMinimiseSyncTrans.'''
 
-# TODO #2837: Once we leave python 3.8 we can use list instead of List for
-# type hints.
-from typing import List, Union
+from typing import Union
 
 from psyclone.psyGen import Transformation
 from psyclone.psyir.nodes import (
@@ -213,8 +211,8 @@ def _eliminate_adjacent_barriers(self, routine: Routine,
             if barrier.immediately_follows(barriers[i-1]):
                 barrier.detach()
 
-    def _find_dependencies(self, directives: List[Directive]) \
-            -> List[Union[Node, bool]]:
+    def _find_dependencies(self, directives: list[Directive]) \
+            -> list[Union[Node, bool]]:
         '''
         Finds the next dependencies for each of the directives provided.
 
@@ -247,8 +245,8 @@ def _find_dependencies(self, directives: List[Directive]) \
         return dependencies
 
     @staticmethod
-    def _reduce_barrier_set(required_barriers: List[Node],
-                            depending_barriers: List[List[Node]]) -> None:
+    def _reduce_barrier_set(required_barriers: list[Node],
+                            depending_barriers: list[list[Node]]) -> None:
         '''
         Reduces the depending_barriers set according to the list of
         required_barriers, i.e. if a required_barrier is present in one of
@@ -288,7 +286,7 @@ def _reduce_barrier_set(required_barriers: List[Node],
 
     @staticmethod
     def _get_max_barrier_dependency(
-            depending_barriers: List[List[Node]]) -> int:
+            depending_barriers: list[list[Node]]) -> int:
         '''
         Returns the maximum size of a sublist in the depending_barriers
         input.
@@ -302,7 +300,7 @@ def _get_max_barrier_dependency(
         '''
         return len(max(depending_barriers, key=len))
 
-    def _eliminate_barriers(self, node: Routine, directives: List[Directive],
+    def _eliminate_barriers(self, node: Routine, directives: list[Directive],
                             barrier_type: type) -> None:
         '''
         Eliminates barriers of the barrier_type in the input Routine node that