Inheritance diagram for psyclone.psyGen.Kern:

[legend]

Collaboration diagram for psyclone.psyGen.Kern:

Public Member Functions
def	__init__ (self, parent, call, name, ArgumentsClass, check=True)

def	args (self)

def	node_str (self, colour=True)

def	reference_accesses (self, var_accesses)

def	is_reduction (self)

def	reduction_arg (self)

def	reprod_reduction (self)

def	local_reduction_name (self)

def	zero_reduction_variable (self, parent, position=None)

def	reduction_sum_loop (self, parent)

def	arg_descriptors (self)

def	arg_descriptors (self, obj)

def	arguments (self)

def	name (self)

def	name (self, value)

def	is_coloured (self)

def	iterates_over (self)

def	local_vars (self)

def	gen_code (self, parent)

Detailed Description

Base class representing a call to a sub-program unit from within the
PSy layer. It is possible for this unit to be in-lined within the
PSy layer.

:param parent: parent of this node in the PSyIR.
:type parent: sub-class of :py:class:`psyclone.psyir.nodes.Node`
:param call: information on the call itself, as obtained by parsing \
             the Algorithm layer code.
:type call: :py:class:`psyclone.parse.algorithm.KernelCall`
:param str name: the name of the routine being called.
:param ArgumentsClass: class to create the object that holds all \
    information on the kernel arguments, as extracted from kernel \
    meta-data (and accessible here via call.ktype).
:type ArgumentsClass: type of :py:class:`psyclone.psyGen.Arguments`
:param bool check: whether to check for consistency between the \
    kernel metadata and the algorithm layer. Defaults to True.

:raises GenerationError: if any of the arguments to the call are \
                         duplicated.

Definition at line 1015 of file psyGen.py.

Member Function Documentation

◆ args()

def psyclone.psyGen.Kern.args ( self )

Return the list of arguments associated with this node. Overide the
base method and simply return our arguments.

Definition at line 1080 of file psyGen.py.

     def args(self):
         '''Return the list of arguments associated with this node. Overide the
         base method and simply return our arguments. '''
         return self.arguments.args
  

References psyclone.psyGen.Kern.arguments(), and psyclone.psyir.nodes.call.Call.arguments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_coloured()

def psyclone.psyGen.Kern.is_coloured ( self )

:returns: True if this kernel is being called from within a \
          coloured loop.
:rtype: bool

Definition at line 1329 of file psyGen.py.

     def is_coloured(self):
         '''
         :returns: True if this kernel is being called from within a \
                   coloured loop.
         :rtype: bool
         '''
         parent_loop = self.ancestor(Loop)
         while parent_loop:
             if parent_loop.loop_type == "colour":
                 return True
             parent_loop = parent_loop.ancestor(Loop)
         return False
  

References psyclone.domain.common.psylayer.psyloop.PSyLoop._iterates_over, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._iterates_over, psyclone.parse.kernel.KernelType._iterates_over, psyclone.psyGen.Kern._iterates_over, and psyclone.psyir.nodes.node.Node.ancestor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ is_reduction()

def psyclone.psyGen.Kern.is_reduction ( self )

:returns: whether this kernel/built-in contains a reduction variable.
:rtype: bool

Definition at line 1111 of file psyGen.py.

     def is_reduction(self):
         '''
         :returns: whether this kernel/built-in contains a reduction variable.
         :rtype: bool
  
         '''
         return self._reduction
  

References psyclone.psyGen.Kern._reduction, and psyclone.psyGen.BuiltIn._reduction.

◆ local_reduction_name()

def psyclone.psyGen.Kern.local_reduction_name ( self )

:returns: a local reduction variable name that is unique for the
          current reduction argument name. This is used for
          thread-local reductions with reproducible reductions.
:rtype: str

Definition at line 1145 of file psyGen.py.

     def local_reduction_name(self):
         '''
         :returns: a local reduction variable name that is unique for the
                   current reduction argument name. This is used for
                   thread-local reductions with reproducible reductions.
         :rtype: str
  
         '''
         # TODO #2381: Revisit symbol creation, now moved to the
         # Kern._reduction_reference() method, and try to associate it
         # with the PSy-layer generation or relevant transformation.
         return "l_" + self.reduction_arg.name
  

References psyclone.psyGen.Kern.reduction_arg().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name() [1/2]

def psyclone.psyGen.Kern.name ( self )

:returns: the name of the kernel.
:rtype: str

Definition at line 1313 of file psyGen.py.

     def name(self):
         '''
         :returns: the name of the kernel.
         :rtype: str
         '''
         return self._name
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, and psyclone.psyir.symbols.symbol.Symbol._name.

Here is the caller graph for this function:

◆ name() [2/2]

def psyclone.psyGen.Kern.name	(	self,
		value
	)

Set the name of the kernel.

:param str value: The name of the kernel.

Definition at line 1321 of file psyGen.py.

     def name(self, value):
         '''
         Set the name of the kernel.
  
         :param str value: The name of the kernel.
         '''
         self._name = value
  

References psyclone.domain.common.algorithm.psyir.AlgorithmInvokeCall._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata._name, psyclone.domain.gocean.kernel.psyir.GOceanKernelMetadata.GridArg._name, psyclone.domain.lfric.kernel.lfric_kernel_metadata.LFRicKernelMetadata._name, psyclone.dynamo0p3.DynFuncDescriptor03._name, psyclone.expression.NamedArg._name, psyclone.gocean1p0.GOKernelGridArgument._name, psyclone.gocean1p0.GOStencil._name, psyclone.nemo.NemoInvoke._name, psyclone.nemo.NemoPSy._name, psyclone.parse.algorithm.FileInfo._name, psyclone.parse.algorithm.InvokeCall._name, psyclone.parse.kernel.KernelProcedure._name, psyclone.parse.kernel.KernelType._name, psyclone.parse.module_info.ModuleInfo._name, psyclone.psyGen.PSy._name, psyclone.psyGen.Invoke._name, psyclone.psyGen.Kern._name, psyclone.psyGen.Argument._name, psyclone.psyir.nodes.container.Container._name, psyclone.psyir.nodes.routine.Routine._name, psyclone.psyir.symbols.symbol.Symbol._name, and psyclone.psyGen.Kern.name().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ node_str()

def psyclone.psyGen.Kern.node_str	(	self,
		colour = `True`
	)

 Returns the name of this node with (optional) control codes
to generate coloured output in a terminal that supports it.

:param bool colour: whether or not to include colour control codes.

:returns: description of this node, possibly coloured.
:rtype: str

Reimplemented in psyclone.psyGen.InlinedKern, and psyclone.psyGen.CodedKern.

Definition at line 1085 of file psyGen.py.

     def node_str(self, colour=True):
         ''' Returns the name of this node with (optional) control codes
         to generate coloured output in a terminal that supports it.
  
         :param bool colour: whether or not to include colour control codes.
  
         :returns: description of this node, possibly coloured.
         :rtype: str
         '''
         return (self.coloured_name(colour) + " " + self.name +
                 "(" + self.arguments.names + ")")
  

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reduction_arg()

def psyclone.psyGen.Kern.reduction_arg ( self )

:returns: the reduction variable if this kernel/built-in
          contains one and `None` otherwise.
:rtype: :py:class:`psyclone.psyGen.KernelArgument` or `NoneType`

Definition at line 1120 of file psyGen.py.

     def reduction_arg(self):
         '''
         :returns: the reduction variable if this kernel/built-in
                   contains one and `None` otherwise.
         :rtype: :py:class:`psyclone.psyGen.KernelArgument` or `NoneType`
  
         '''
         return self._reduction_arg
  

References psyclone.psyGen.Kern._reduction_arg.

Here is the caller graph for this function:

◆ reduction_sum_loop()

def psyclone.psyGen.Kern.reduction_sum_loop	(	self,
		parent
	)

Generate the appropriate code to place after the end parallel
region.

:param parent: the Node in the f2pygen AST to which to add new code.
:type parent: :py:class:`psyclone.f2pygen.SubroutineGen`

:raises GenerationError: for an unsupported reduction access in \
                         LFRicBuiltIn.

Definition at line 1224 of file psyGen.py.

     def reduction_sum_loop(self, parent):
         '''
         Generate the appropriate code to place after the end parallel
         region.
  
         :param parent: the Node in the f2pygen AST to which to add new code.
         :type parent: :py:class:`psyclone.f2pygen.SubroutineGen`
  
         :raises GenerationError: for an unsupported reduction access in \
                                  LFRicBuiltIn.
  
         '''
         var_name = self._reduction_arg.name
         local_var_name = self.local_reduction_name
         # A non-reproducible reduction requires a single-valued argument
         local_var_ref = self._reduction_reference().name
         # A reproducible reduction requires multi-valued argument stored
         # as a padded array separately for each thread
         if self.reprod_reduction:
             local_var_ref = FortranWriter().arrayreference_node(
                 self._reduction_reference())
         reduction_access = self._reduction_arg.access
         try:
             reduction_operator = REDUCTION_OPERATOR_MAPPING[reduction_access]
         except KeyError as err:
             api_strings = [access.api_specific_name()
                            for access in REDUCTION_OPERATOR_MAPPING]
             raise GenerationError(
                 f"Unsupported reduction access "
                 f"'{reduction_access.api_specific_name()}' found in "
                 f"LFRicBuiltIn:reduction_sum_loop(). Expected one of "
                 f"{api_strings}.") from err
         symtab = self.scope.symbol_table
         thread_idx = symtab.lookup_with_tag("omp_thread_index").name
         nthreads = symtab.lookup_with_tag("omp_num_threads").name
         do_loop = DoGen(parent, thread_idx, "1", nthreads)
         do_loop.add(AssignGen(do_loop, lhs=var_name, rhs=var_name +
                               reduction_operator + local_var_ref))
         parent.add(do_loop)
         parent.add(DeallocateGen(parent, local_var_name))
  

References psyclone.domain.lfric.lfric_kern_metadata.LFRicKernMetadata._arg_descriptors, psyclone.gocean1p0.GOKernelType1p0._arg_descriptors, psyclone.parse.kernel.KernelType._arg_descriptors, psyclone.psyGen.Kern._arg_descriptors, psyclone.psyGen.BuiltIn._arg_descriptors, psyclone.domain.lfric.lfric_kern.LFRicKern._arguments, psyclone.psyGen.Kern._arguments, psyclone.psyGen.InlinedKern._arguments, psyclone.psyGen.Kern._reduction_arg, psyclone.psyGen.Kern._reduction_reference(), psyclone.psyGen.Kern.local_reduction_name(), psyclone.psyGen.Kern.reduction_arg(), psyclone.psyGen.Kern.reprod_reduction(), psyclone.psyir.nodes.node.Node.scope(), and psyclone.psyir.symbols.symbol_table.SymbolTable.scope().

Here is the call graph for this function:

◆ reference_accesses()

def psyclone.psyGen.Kern.reference_accesses	(	self,
		var_accesses
	)

Get all variable access information. The API specific classes
add the accesses to the arguments. So the code here only calls
the baseclass, and increases the location.

:param var_accesses: VariablesAccessInfo instance that stores the \
    information about variable accesses.
:type var_accesses: \
    :py:class:`psyclone.core.VariablesAccessInfo`

Reimplemented in psyclone.gocean1p0.GOKern, psyclone.domain.lfric.lfric_kern.LFRicKern, and psyclone.domain.lfric.lfric_builtins.LFRicBuiltIn.

Definition at line 1097 of file psyGen.py.

     def reference_accesses(self, var_accesses):
         '''Get all variable access information. The API specific classes
         add the accesses to the arguments. So the code here only calls
         the baseclass, and increases the location.
  
         :param var_accesses: VariablesAccessInfo instance that stores the \
             information about variable accesses.
         :type var_accesses: \
             :py:class:`psyclone.core.VariablesAccessInfo`
         '''
         super().reference_accesses(var_accesses)
         var_accesses.next_location()
  

Here is the caller graph for this function:

◆ reprod_reduction()

def psyclone.psyGen.Kern.reprod_reduction ( self )

:returns: whether this kernel/built-in is enclosed within an OpenMP
          do loop. If so report whether it has the reproducible flag
          set. Note, this also catches OMPParallelDo Directives but
          they have reprod set to False so it is OK.
:rtype: bool

Definition at line 1130 of file psyGen.py.

     def reprod_reduction(self):
         '''
         :returns: whether this kernel/built-in is enclosed within an OpenMP
                   do loop. If so report whether it has the reproducible flag
                   set. Note, this also catches OMPParallelDo Directives but
                   they have reprod set to False so it is OK.
         :rtype: bool
  
         '''
         ancestor = self.ancestor(OMPDoDirective)
         if ancestor:
             return ancestor.reprod
         return False
  

References psyclone.psyir.nodes.node.Node.ancestor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zero_reduction_variable()

def psyclone.psyGen.Kern.zero_reduction_variable	(	self,
		parent,
		position = `None`
	)

Generate code to zero the reduction variable and to zero the local
reduction variable if one exists. The latter is used for reproducible
reductions, if specified.

:param parent: the Node in the AST to which to add new code.
:type parent: :py:class:`psyclone.psyir.nodes.Node`
:param str position: where to position the new code in the AST.

:raises GenerationError: if the variable to zero is not a scalar.
:raises GenerationError: if the reprod_pad_size (read from the \
                         configuration file) is less than 1.
:raises GenerationError: for a reduction into a scalar that is \
                         neither 'real' nor 'integer'.

Definition at line 1158 of file psyGen.py.

     def zero_reduction_variable(self, parent, position=None):
         '''
         Generate code to zero the reduction variable and to zero the local
         reduction variable if one exists. The latter is used for reproducible
         reductions, if specified.
  
         :param parent: the Node in the AST to which to add new code.
         :type parent: :py:class:`psyclone.psyir.nodes.Node`
         :param str position: where to position the new code in the AST.
  
         :raises GenerationError: if the variable to zero is not a scalar.
         :raises GenerationError: if the reprod_pad_size (read from the \
                                  configuration file) is less than 1.
         :raises GenerationError: for a reduction into a scalar that is \
                                  neither 'real' nor 'integer'.
  
         '''
         if not position:
             position = ["auto"]
         var_name = self._reduction_arg.name
         local_var_name = self.local_reduction_name
         var_arg = self._reduction_arg
         # Check for a non-scalar argument
         if not var_arg.is_scalar:
             raise GenerationError(
                 f"Kern.zero_reduction_variable() should be a scalar but "
                 f"found '{var_arg.argument_type}'.")
         # Generate the reduction variable
         var_data_type = var_arg.intrinsic_type
         if var_data_type == "real":
             data_value = "0.0"
         elif var_data_type == "integer":
             data_value = "0"
         else:
             raise GenerationError(
                 f"Kern.zero_reduction_variable() should be either a 'real' or "
                 f"an 'integer' scalar but found scalar of type "
                 f"'{var_arg.intrinsic_type}'.")
         # Retrieve the precision information (if set) and append it
         # to the initial reduction value
         if var_arg.precision:
             kind_type = var_arg.precision
             zero_sum_variable = "_".join([data_value, kind_type])
         else:
             kind_type = ""
             zero_sum_variable = data_value
         parent.add(AssignGen(parent, lhs=var_name, rhs=zero_sum_variable),
                    position=position)
         if self.reprod_reduction:
             parent.add(DeclGen(parent, datatype=var_data_type,
                                entity_decls=[local_var_name],
                                allocatable=True, kind=kind_type,
                                dimension=":,:"))
             nthreads = \
                 self.scope.symbol_table.lookup_with_tag("omp_num_threads").name
             if Config.get().reprod_pad_size < 1:
                 raise GenerationError(
                     f"REPROD_PAD_SIZE in {Config.get().filename} should be a "
                     f"positive integer, but it is set to "
                     f"'{Config.get().reprod_pad_size}'.")
             pad_size = str(Config.get().reprod_pad_size)
             parent.add(AllocateGen(parent, local_var_name + "(" + pad_size +
                                    "," + nthreads + ")"), position=position)
             parent.add(AssignGen(parent, lhs=local_var_name,
                                  rhs=zero_sum_variable), position=position)
  

References psyclone.psyGen.Kern._reduction_arg, psyclone.psyGen.Kern.local_reduction_name(), psyclone.psyGen.Kern.reprod_reduction(), psyclone.psyir.nodes.node.Node.scope(), and psyclone.psyir.symbols.symbol_table.SymbolTable.scope().

Here is the call 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/psyGen.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ args()

◆ is_coloured()

◆ is_reduction()

◆ local_reduction_name()

◆ name() [1/2]

◆ name() [2/2]

◆ node_str()

◆ reduction_arg()

◆ reduction_sum_loop()

◆ reference_accesses()

◆ reprod_reduction()

◆ zero_reduction_variable()