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

[legend]

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

[legend]

Public Member Functions
def	__init__ (self, grainsize=None, num_tasks=None, nogroup=False, **kwargs)

def	nogroup (self)

def	validate_global_constraints (self)

def	gen_code (self, parent)

def	begin_string (self)

def	end_string (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	__eq__ (self, other)

def	coloured_name (self, colour=True)

def	node_str (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	lower_to_language_level (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)

Additional Inherited Members
Public Attributes inherited from psyclone.psyir.nodes.node.Node
	position

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

int	START_POSITION = 0

	valid_annotations = tuple()

Detailed Description

Class representing an OpenMP TASKLOOP directive in the PSyIR.

:param grainsize: The grainsize value used to specify the grainsize \
                  clause on this OpenMP directive. If this is None \
                  the grainsize clause is not applied. Default \
                  value is None.
:type grainsize: int or None.
:param num_tasks: The num_tasks value used to specify the num_tasks \
                  clause on this OpenMP directive. If this is None \
                  the num_tasks clause is not applied. Default value \
                  is None.
:type num_tasks: int or None.
:param nogroup: Whether the nogroup clause should be used for this node. \
                Default value is False
:type nogroup: bool
:param kwargs: additional keyword arguments provided to the PSyIR node.
:type kwargs: unwrapped dict.

:raises GenerationError: if this OMPTaskloopDirective has both \
                         a grainsize and num_tasks value \
                         specified.

Definition at line 1708 of file omp_directives.py.

Member Function Documentation

◆ begin_string()

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

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

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

Definition at line 1862 of file omp_directives.py.

     def begin_string(self):
         '''Returns the beginning statement of this directive, i.e.
         "omp taskloop ...". The visitor is responsible for adding the
         correct directive beginning (e.g. "!$").
  
         :returns: the beginning statement for this directive.
         :rtype: str
  
         '''
         return "omp taskloop"
  

Here is the caller graph for this function:

◆ end_string()

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

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

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

Definition at line 1873 of file omp_directives.py.

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

Here is the caller graph for this function:

◆ gen_code()

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

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

:param parent: the parent Node in the Schedule to which to add our \
               content.
:type parent: sub-class of :py:class:`psyclone.f2pygen.BaseGen`
:raises GenerationError: if this "!$omp taskloop" is not enclosed \
                         within an OMP Parallel region and an OMP \
                         Serial region.

Definition at line 1825 of file omp_directives.py.

     def gen_code(self, parent):
         '''
         Generate the f2pygen AST entries in the Schedule for this OpenMP
         taskloop directive.
  
         :param parent: the parent Node in the Schedule to which to add our \
                        content.
         :type parent: sub-class of :py:class:`psyclone.f2pygen.BaseGen`
         :raises GenerationError: if this "!$omp taskloop" is not enclosed \
                                  within an OMP Parallel region and an OMP \
                                  Serial region.
  
         '''
         self.validate_global_constraints()
  
         extra_clauses = ""
         # Find the specified clauses
         clause_list = []
         if self._grainsize is not None:
             clause_list.append(f"grainsize({self._grainsize})")
         if self._num_tasks is not None:
             clause_list.append(f"num_tasks({self._num_tasks})")
         if self._nogroup:
             clause_list.append("nogroup")
         # Generate the string containing the required clauses
         extra_clauses = ", ".join(clause_list)
  
         parent.add(DirectiveGen(parent, "omp", "begin", "taskloop",
                                 extra_clauses))
  
         self.dir_body.gen_code(parent)
  
         # make sure the directive occurs straight after the loop body
         position = parent.previous_loop()
         parent.add(DirectiveGen(parent, "omp", "end", "taskloop", ""),
                    position=["after", position])
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nogroup()

def psyclone.psyir.nodes.omp_directives.OMPTaskloopDirective.nogroup ( self )

:returns: the nogroup clause status of this node.
:rtype: bool

Definition at line 1789 of file omp_directives.py.

     def nogroup(self):
         '''
         :returns: the nogroup clause status of this node.
         :rtype: bool
         '''
         return self._nogroup
  

References psyclone.psyir.nodes.omp_directives.OMPTaskloopDirective._nogroup, and psyclone.transformations.OMPTaskloopTrans._nogroup.

◆ validate_global_constraints()

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

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

:raises GenerationError: if this OMPTaskloopDirective is not \
                         enclosed within an OpenMP serial region.
:raises GenerationError: if this OMPTaskloopDirective has two
                         Nogroup clauses as children.

Reimplemented from psyclone.psyir.nodes.node.Node.

Definition at line 1796 of file omp_directives.py.

     def validate_global_constraints(self):
         '''
         Perform validation checks that can only be done at code-generation
         time.
  
         :raises GenerationError: if this OMPTaskloopDirective is not \
                                  enclosed within an OpenMP serial region.
         :raises GenerationError: if this OMPTaskloopDirective has two
                                  Nogroup clauses as children.
         '''
         # It is only at the point of code generation that we can check for
         # correctness (given that we don't mandate the order that a user
         # can apply transformations to the code). A taskloop directive, we must
         # have an OMPSerialDirective as an ancestor back up the tree.
         if not self.ancestor(OMPSerialDirective):
             raise GenerationError(
                 "OMPTaskloopDirective must be inside an OMP Serial region "
                 "but could not find an ancestor node")
  
         # Check children are well formed.
         # _validate_child will ensure position 0 and 1 are valid.
         if len(self._children) == 3 and isinstance(self._children[1],
                                                    OMPNogroupClause):
             raise GenerationError(
                 "OMPTaskloopDirective has two Nogroup clauses as children "
                 "which is not allowed.")
  
         super().validate_global_constraints()
  

References psyclone.f2pygen.BaseGen._children, psyclone.psyir.nodes.node.Node._children, psyclone.psyir.nodes.omp_directives.OMPParallelDirective._children, and psyclone.psyir.nodes.node.Node.ancestor().

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

◆ nogroup()

◆ validate_global_constraints()