Inheritance diagram for psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective:

[legend]

Collaboration diagram for psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective:

[legend]

Public Member Functions
def	__init__ (self, **kwargs)

def	gen_code (self, parent)

def	lower_to_language_level (self)

def	begin_string (self)

def	end_string (self)

def	validate_global_constraints (self)

Public Member Functions inherited from psyclone.psyir.nodes.omp_directives.OMPParallelDirective
def	default_clause (self)

def	private_clause (self)

def	infer_sharing_attributes (self)

Public Member Functions inherited from psyclone.psyir.nodes.directive.RegionDirective
def	__init__ (self, ast=None, children=None, parent=None)

def	dir_body (self)

def	clauses (self)

def	gen_post_region_code (self, parent)

Public Member Functions inherited from psyclone.psyir.nodes.directive.Directive
def	create_data_movement_deep_copy_refs (self)

Public Member Functions inherited from psyclone.psyir.nodes.node.Node
def	__init__ (self, ast=None, children=None, parent=None, annotations=None)

def	coloured_name (self, colour=True)

def	__str__ (self)

def	ast (self)

def	ast_end (self)

def	ast (self, ast)

def	ast_end (self, ast_end)

def	annotations (self)

def	dag (self, file_name='dag', file_format='svg')

def	dag_gen (self, graph)

def	dag_name (self)

def	args (self)

def	backward_dependence (self)

def	forward_dependence (self)

def	is_valid_location (self, new_node, position="before")

def	depth (self)

def	view (self, depth=0, colour=True, indent=" ", _index=None)

def	addchild (self, child, index=None)

def	children (self)

def	children (self, my_children)

def	parent (self)

def	siblings (self)

def	has_constructor_parent (self)

def	position (self)

def	abs_position (self)

def	root (self)

def	sameParent (self, node_2)

def	walk (self, my_type, stop_type=None, depth=None)

def	get_sibling_lists (self, my_type, stop_type=None)

def	ancestor (self, my_type, excluding=None, include_self=False, limit=None, shared_with=None)

def	kernels (self)

def	following (self, routine=True)

def	preceding (self, reverse=False, routine=True)

def	immediately_precedes (self, node_2)

def	immediately_follows (self, node_1)

def	coded_kernels (self)

def	loops (self)

def	reductions (self, reprod=None)

def	is_openmp_parallel (self)

def	reference_accesses (self, var_accesses)

def	scope (self)

def	replace_with (self, node, keep_name_in_context=True)

def	pop_all_children (self)

def	detach (self)

def	copy (self)

def	debug_string (self)

def	origin_string (self)

def	update_signal (self)

def	path_from (self, ancestor)

Public Member Functions inherited from psyclone.psyir.nodes.commentable_mixin.CommentableMixin
def	preceding_comment (self)

def	preceding_comment (self, comment)

def	inline_comment (self)

def	inline_comment (self, comment)

Public Member Functions inherited from psyclone.psyir.nodes.omp_directives.OMPDoDirective
def	__init__ (self, omp_schedule="none", collapse=None, reprod=None, **kwargs)

def	__eq__ (self, other)

def	collapse (self)

def	collapse (self, value)

def	node_str (self, colour=True)

def	omp_schedule (self)

def	omp_schedule (self, value)

def	reprod (self)

def	reprod (self, value)

Additional Inherited Members
Static Public Member Functions inherited from psyclone.psyir.nodes.omp_directives.OMPParallelDirective
def	create (children=None)

Public Attributes inherited from psyclone.psyir.nodes.node.Node
	position

Public Attributes inherited from psyclone.psyir.nodes.omp_directives.OMPDoDirective
	collapse

	omp_schedule

	reprod

Static Public Attributes inherited from psyclone.psyir.nodes.node.Node
int	START_DEPTH = 0

int	START_POSITION = 0

	valid_annotations = tuple()

Detailed Description

 Class for the !$OMP PARALLEL DO directive. This inherits from
    both OMPParallelDirective (because it creates a new OpenMP
    thread-parallel region) and OMPDoDirective (because it
    causes a loop to be parallelised).

    :param kwargs: additional keyword arguments provided to the PSyIR node.
    :type kwargs: unwrapped dict.

Definition at line 2182 of file omp_directives.py.

Member Function Documentation

◆ begin_string()

def psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective.begin_string ( self )

Returns the beginning statement of this directive, i.e.
"omp parallel do ...". The visitor is responsible for adding the
correct directive beginning (e.g. "!$").

:returns: the beginning statement for this directive.
:rtype: str

Reimplemented from psyclone.psyir.nodes.omp_directives.OMPParallelDirective.

Definition at line 2315 of file omp_directives.py.

     def begin_string(self):
         '''Returns the beginning statement of this directive, i.e.
         "omp parallel do ...". The visitor is responsible for adding the
         correct directive beginning (e.g. "!$").
  
         :returns: the beginning statement for this directive.
         :rtype: str
  
         '''
         string = f"omp {self._directive_string}"
         if self._collapse:
             string += f" collapse({self._collapse})"
         string += self._reduction_string()
         return string
  

References psyclone.psyir.nodes.acc_directives.ACCLoopDirective._collapse, psyclone.psyir.nodes.omp_directives.OMPDoDirective._collapse, psyclone.psyir.nodes.omp_directives.OMPLoopDirective._collapse, and psyclone.psyir.nodes.omp_directives.OMPDoDirective._reduction_string().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end_string()

def psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective.end_string ( self )

Returns the end (or closing) statement of this directive, i.e.
"omp end parallel do". The visitor is responsible for adding the
correct directive beginning (e.g. "!$").

:returns: the end statement for this directive.
:rtype: str

Reimplemented from psyclone.psyir.nodes.omp_directives.OMPParallelDirective.

Definition at line 2330 of file omp_directives.py.

     def end_string(self):
         '''Returns the end (or closing) statement of this directive, i.e.
         "omp end parallel do". The visitor is responsible for adding the
         correct directive beginning (e.g. "!$").
  
         :returns: the end statement for this directive.
         :rtype: str
  
         '''
         return f"omp end {self._directive_string}"
  

Here is the caller graph for this function:

◆ gen_code()

def psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective.gen_code	(	self,
		parent
	)

Generate the f2pygen AST entries in the Schedule for this OpenMP
directive.

TODO #1648: Note that gen_code ignores the collapse clause but the
generated code is still valid. Since gen_code is going to be removed
and it is only used for LFRic (which does not support GPU offloading
that gets improved with the collapse clause) it will not be supported.

:param parent: the parent Node in the Schedule to which to add our \
               content.
:type parent: sub-class of :py:class:`psyclone.f2pygen.BaseGen`

Reimplemented from psyclone.psyir.nodes.omp_directives.OMPParallelDirective.

Definition at line 2227 of file omp_directives.py.

     def gen_code(self, parent):
         '''
         Generate the f2pygen AST entries in the Schedule for this OpenMP
         directive.
  
         TODO #1648: Note that gen_code ignores the collapse clause but the
         generated code is still valid. Since gen_code is going to be removed
         and it is only used for LFRic (which does not support GPU offloading
         that gets improved with the collapse clause) it will not be supported.
  
         :param parent: the parent Node in the Schedule to which to add our \
                        content.
         :type parent: sub-class of :py:class:`psyclone.f2pygen.BaseGen`
  
         '''
         # We're not doing nested parallelism so make sure that this
         # omp parallel do is not already within some parallel region
         # pylint: disable=import-outside-toplevel
         from psyclone.psyGen import zero_reduction_variables
         self.validate_global_constraints()
  
         calls = self.reductions()
         zero_reduction_variables(calls, parent)
  
         # Set default() private() and firstprivate() clauses
         # pylint: disable=protected-access
         default_str = self.children[1]._clause_string
         # pylint: enable=protected-access
         private, fprivate, need_sync = self.infer_sharing_attributes()
         private_clause = OMPPrivateClause.create(
                             sorted(private, key=lambda x: x.name))
         fprivate_clause = OMPFirstprivateClause.create(
                             sorted(fprivate, key=lambda x: x.name))
         if need_sync:
             raise GenerationError(
                 f"OMPParallelDoDirective.gen_code() does not support symbols "
                 f"that need synchronisation, but found: "
                 f"{[x.name for x in need_sync]}")
  
         private_str = ""
         fprivate_str = ""
         private_list = [child.symbol.name for child in private_clause.children]
         if private_list:
             private_str = "private(" + ",".join(private_list) + ")"
         fp_list = [child.symbol.name for child in fprivate_clause.children]
         if fp_list:
             fprivate_str = "firstprivate(" + ",".join(fp_list) + ")"
  
         # Set schedule clause
         if self._omp_schedule != "none":
             schedule_str = f"schedule({self._omp_schedule})"
         else:
             schedule_str = ""
  
         # Add directive to the f2pygen tree
         parent.add(
             DirectiveGen(
                 parent, "omp", "begin", "parallel do", ", ".join(
                     text for text in [default_str, private_str, fprivate_str,
                                       schedule_str, self._reduction_string()]
                     if text)))
  
         for child in self.dir_body:
             child.gen_code(parent)
  
         # make sure the directive occurs straight after the loop body
         position = parent.previous_loop()
         parent.add(DirectiveGen(parent, *self.end_string().split()),
                    position=["after", position])
  
         self.gen_post_region_code(parent)
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lower_to_language_level()

def psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective.lower_to_language_level ( self )

In-place construction of clauses as PSyIR constructs.
The clauses here may need to be updated if code has changed, or be
added if not yet present.

:returns: the lowered version of this node.
:rtype: :py:class:`psyclone.psyir.node.Node`

Reimplemented from psyclone.psyir.nodes.omp_directives.OMPParallelDirective.

Definition at line 2299 of file omp_directives.py.

     def lower_to_language_level(self):
         '''
         In-place construction of clauses as PSyIR constructs.
         The clauses here may need to be updated if code has changed, or be
         added if not yet present.
  
         :returns: the lowered version of this node.
         :rtype: :py:class:`psyclone.psyir.node.Node`
  
         '''
         # Calling the super() explicitly to avoid confusion
         # with the multiple-inheritance
         OMPParallelDirective.lower_to_language_level(self)
         self.addchild(OMPScheduleClause(self._omp_schedule))
         return self
  

References psyclone.psyir.nodes.omp_directives.OMPDoDirective._omp_schedule, psyclone.psyir.transformations.omp_loop_trans.OMPLoopTrans._omp_schedule, and psyclone.psyir.nodes.node.Node.addchild().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate_global_constraints()

def psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective.validate_global_constraints ( self )

Perform validation checks that can only be done at code-generation
time.

Reimplemented from psyclone.psyir.nodes.omp_directives.OMPParallelDirective.

Definition at line 2341 of file omp_directives.py.

     def validate_global_constraints(self):
         '''
         Perform validation checks that can only be done at code-generation
         time.
  
         '''
         OMPParallelDirective.validate_global_constraints(self)
  
         self._validate_single_loop()
         self._validate_collapse_value()
  
  

References psyclone.psyir.nodes.omp_directives.OMPDoDirective._validate_collapse_value(), and psyclone.psyir.nodes.omp_directives.OMPDoDirective._validate_single_loop().

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/psyir/nodes/omp_directives.py

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ begin_string()

◆ end_string()

◆ gen_code()

◆ lower_to_language_level()

◆ validate_global_constraints()