psyclone.psyGen.Invoke Class Reference

Inheritance diagram for psyclone.psyGen.Invoke:

Public Member Functions
def	__init__ (self, alg_invocation, idx, schedule_class, invokes, reserved_names=None)
def	__str__ (self)
def	invokes (self)
def	name (self)
def	alg_unique_args (self)
def	psy_unique_vars (self)
def	psy_unique_var_names (self)
def	schedule (self)
def	schedule (self, obj)
def	unique_declarations (self, argument_types, access=None, intrinsic_type=None)
def	first_access (self, arg_name)
def	unique_declns_by_intent (self, argument_types, intrinsic_type=None)
def	gen (self)
def	gen_code (self, parent)

Detailed Description

Manage an individual invoke call.

:param alg_invocation: metadata from the parsed code capturing \
                       information for this Invoke instance.
:type alg_invocation: :py:class:`psyclone.parse.algorithm.InvokeCall`
:param int idx: position/index of this invoke call in the subroutine. \
                If not None, this number is added to the name ("invoke\_").
:param schedule_class: the schedule class to create for this invoke.
:type schedule_class: :py:class:`psyclone.psyGen.InvokeSchedule`
:param invokes: the Invokes instance that contains this Invoke \
                instance.
:type invokes: :py:class:`psyclone.psyGen.Invokes`
:param reserved_names: optional list of reserved names, i.e. names that \
                       should not be used e.g. as a PSyclone-created \
                       variable name.
:type reserved_names: list of str

Definition at line 367 of file psyGen.py.

Constructor & Destructor Documentation

__init__()

def psyclone.psyGen.Invoke.__init__	(		self,
			alg_invocation,
			idx,
			schedule_class,
			invokes,
			reserved_names = None
	)

Construct an invoke object.

Definition at line 386 of file psyGen.py.

                 reserved_names=None):
        '''Construct an invoke object.'''
 
        self._invokes = invokes
        self._name = "invoke"
        self._alg_unique_args = []
 
        if alg_invocation is None and idx is None:
            return
 
        # create a name for the call if one does not already exist
        if alg_invocation.name is not None:
            # In Python2 unicode strings must be converted to str()
            self._name = str(alg_invocation.name)
        elif len(alg_invocation.kcalls) == 1 and \
                alg_invocation.kcalls[0].type == "kernelCall":
            # use the name of the kernel call with the position appended.
            # Appended position is needed in case we have two separate invokes
            # in the same algorithm code containing the same (single) kernel
            self._name = "invoke_" + str(idx) + "_" + \
                alg_invocation.kcalls[0].ktype.name
        else:
            # use the position of the invoke
            self._name = "invoke_" + str(idx)
 
        if not reserved_names:
            reserved_names = []
 
        # Get a reference to the parent container, if any
        container = None
        if self.invokes:
            container = self.invokes.psy.container
 
        # create the schedule
        self._schedule = schedule_class(self._name, alg_invocation.kcalls,
                                        reserved_names, parent=container)
 
        # Add the new Schedule to the top-level PSy Container
        if container:
            container.addchild(self._schedule)
 
        # let the schedule have access to me
        self._schedule.invoke = self
 
        # extract the argument list for the algorithm call and psy
        # layer subroutine.
        self._alg_unique_args = []
        self._psy_unique_vars = []
        tmp_arg_names = []
        for call in self.schedule.kernels():
            for arg in call.arguments.args:
                if arg.text is not None:
                    if arg.text not in self._alg_unique_args:
                        self._alg_unique_args.append(arg.text)
                    if arg.name not in tmp_arg_names:
                        tmp_arg_names.append(arg.name)
                        self._psy_unique_vars.append(arg)
                else:
                    # literals have no name
                    pass
 
        # work out the unique dofs required in this subroutine
        self._dofs = {}
        for kern_call in self._schedule.coded_kernels():
            dofs = kern_call.arguments.dofs
            for dof in dofs:
                if dof not in self._dofs:
                    # Only keep the first occurrence for the moment. We will
                    # need to change this logic at some point as we need to
                    # cope with writes determining the dofs that are used.
                    self._dofs[dof] = [kern_call, dofs[dof][0]]
 

References psyclone.psyGen.Invoke._alg_unique_args, psyclone.dynamo0p3.DynKernelArguments._dofs, psyclone.gocean1p0.GOKernelArguments._dofs, psyclone.psyGen.Invoke._dofs, psyclone.dynamo0p3.DynamoPSy._invokes, psyclone.gocean1p0.GOPSy._invokes, psyclone.nemo.NemoInvoke._invokes, psyclone.nemo.NemoPSy._invokes, psyclone.psyGen.PSy._invokes, psyclone.psyGen.Invoke._invokes, 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, psyclone.psyGen.Invoke._psy_unique_vars, psyclone.domain.lfric.lfric_invoke.LFRicInvoke._schedule, psyclone.dynamo0p3.DynMeshes._schedule, psyclone.gocean1p0.GOInvoke._schedule, psyclone.nemo.NemoInvoke._schedule, psyclone.psyGen.Invoke._schedule, psyclone.psyir.nodes.omp_clauses.OMPScheduleClause._schedule, psyclone.psyGen.PSy.invokes(), psyclone.psyGen.Invoke.invokes(), psyclone.psyGen.Invoke.schedule(), and psyclone.psyir.nodes.omp_clauses.OMPScheduleClause.schedule.

Here is the call graph for this function:

Member Function Documentation

first_access()

def psyclone.psyGen.Invoke.first_access	(		self,
			arg_name
	)

 Returns the first argument with the specified name passed to
a kernel in our schedule 

Definition at line 561 of file psyGen.py.

    def first_access(self, arg_name):
        ''' Returns the first argument with the specified name passed to
        a kernel in our schedule '''
        for call in self.schedule.kernels():
            for arg in call.arguments.args:
                if arg.text is not None:
                    if arg.declaration_name == arg_name:
                        return arg
        raise GenerationError(f"Failed to find any kernel argument with name "
                              f"'{arg_name}'")
 

References psyclone.psyGen.Invoke.schedule(), and psyclone.psyir.nodes.omp_clauses.OMPScheduleClause.schedule.

Here is the call graph for this function:

Here is the caller graph for this function:

gen_code()

def psyclone.psyGen.Invoke.gen_code	(		self,
			parent
	)

Generates invocation code (the subroutine called by the associated
invoke call in the algorithm layer). This consists of the PSy
invocation subroutine and the declaration of its arguments.

:param parent: the node in the generated AST to which to add content.
:type parent: :py:class:`psyclone.f2pygen.ModuleGen`

Reimplemented in psyclone.gocean1p0.GOInvoke, and psyclone.domain.lfric.lfric_invoke.LFRicInvoke.

Definition at line 653 of file psyGen.py.

    def gen_code(self, parent):
        '''
        Generates invocation code (the subroutine called by the associated
        invoke call in the algorithm layer). This consists of the PSy
        invocation subroutine and the declaration of its arguments.
 
        :param parent: the node in the generated AST to which to add content.
        :type parent: :py:class:`psyclone.f2pygen.ModuleGen`
 
        '''
 
 

Here is the caller graph for this function:

invokes()

def psyclone.psyGen.Invoke.invokes

(

self

)

:returns: the Invokes instance that contains this instance.
:rtype: :py:class`psyclone.psyGen.Invokes`

Definition at line 464 of file psyGen.py.

    def invokes(self):
        '''
        :returns: the Invokes instance that contains this instance.
        :rtype: :py:class`psyclone.psyGen.Invokes`
 
        '''
        return self._invokes
 

References psyclone.psyGen.Invoke._alg_unique_args, psyclone.dynamo0p3.DynamoPSy._invokes, psyclone.gocean1p0.GOPSy._invokes, psyclone.nemo.NemoInvoke._invokes, psyclone.nemo.NemoPSy._invokes, psyclone.psyGen.PSy._invokes, psyclone.psyGen.Invoke._invokes, 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, psyclone.psyGen.Invoke._psy_unique_vars, psyclone.domain.lfric.lfric_invoke.LFRicInvoke._schedule, psyclone.dynamo0p3.DynMeshes._schedule, psyclone.gocean1p0.GOInvoke._schedule, psyclone.nemo.NemoInvoke._schedule, psyclone.psyGen.Invoke._schedule, and psyclone.psyir.nodes.omp_clauses.OMPScheduleClause._schedule.

Here is the caller graph for this function:

unique_declarations()

def psyclone.psyGen.Invoke.unique_declarations	(		self,
			argument_types,
			access = None,
			intrinsic_type = None
	)

Returns a list of all required declarations for the specified
API argument types. If access is supplied (e.g. "write") then
only declarations with that access are returned. If an intrinsic
type is supplied then only declarations with that intrinsic type
are returned.

:param argument_types: the types of the kernel argument for the \
                       particular API.
:type argument_types: list of str
:param access: optional AccessType that the declaration should have.
:type access: :py:class:`psyclone.core.access_type.AccessType`
:param intrinsic_type: optional intrinsic type of argument data.
:type intrinsic_type: str

:returns: a list of all declared kernel arguments.
:rtype: list of :py:class:`psyclone.psyGen.KernelArgument`

:raises InternalError: if at least one kernel argument type is \
                       not valid for the particular API.
:raises InternalError: if an invalid access is specified.
:raises InternalError: if an invalid intrinsic type is specified.

Definition at line 499 of file psyGen.py.

                            intrinsic_type=None):
        '''
        Returns a list of all required declarations for the specified
        API argument types. If access is supplied (e.g. "write") then
        only declarations with that access are returned. If an intrinsic
        type is supplied then only declarations with that intrinsic type
        are returned.
 
        :param argument_types: the types of the kernel argument for the \
                               particular API.
        :type argument_types: list of str
        :param access: optional AccessType that the declaration should have.
        :type access: :py:class:`psyclone.core.access_type.AccessType`
        :param intrinsic_type: optional intrinsic type of argument data.
        :type intrinsic_type: str
 
        :returns: a list of all declared kernel arguments.
        :rtype: list of :py:class:`psyclone.psyGen.KernelArgument`
 
        :raises InternalError: if at least one kernel argument type is \
                               not valid for the particular API.
        :raises InternalError: if an invalid access is specified.
        :raises InternalError: if an invalid intrinsic type is specified.
 
        '''
        # First check for invalid argument types, access and intrinsic type
        const = Config.get().api_conf().get_constants()
        if any(argtype not in const.VALID_ARG_TYPE_NAMES for
               argtype in argument_types):
            raise InternalError(
                f"Invoke.unique_declarations() called with at least one "
                f"invalid argument type. Expected one of "
                f"{const.VALID_ARG_TYPE_NAMES} but found {argument_types}.")
 
        if access and not isinstance(access, AccessType):
            raise InternalError(
                f"Invoke.unique_declarations() called with an invalid "
                f"access type. Type is '{access}' instead of AccessType.")
 
        if (intrinsic_type and intrinsic_type not in
                const.VALID_INTRINSIC_TYPES):
            raise InternalError(
                f"Invoke.unique_declarations() called with an invalid "
                f"intrinsic argument data type. Expected one of "
                f"{const.VALID_INTRINSIC_TYPES} but found '{intrinsic_type}'.")
 
        # Initialise dictionary of kernel arguments to get the
        # argument list from
        declarations = OrderedDict()
        # Find unique kernel arguments using their declaration names
        for call in self.schedule.kernels():
            for arg in call.arguments.args:
                if not intrinsic_type or arg.intrinsic_type == intrinsic_type:
                    if not access or arg.access == access:
                        if arg.text is not None:
                            if arg.argument_type in argument_types:
                                test_name = arg.declaration_name
                                if test_name not in declarations:
                                    declarations[test_name] = arg
        return list(declarations.values())
 

References psyclone.psyGen.Invoke.schedule(), and psyclone.psyir.nodes.omp_clauses.OMPScheduleClause.schedule.

Here is the call graph for this function:

Here is the caller graph for this function:

unique_declns_by_intent()

def psyclone.psyGen.Invoke.unique_declns_by_intent	(		self,
			argument_types,
			intrinsic_type = None
	)

Returns a dictionary listing all required declarations for each
type of intent ('inout', 'out' and 'in').

:param argument_types: the types of the kernel argument for the \
                       particular API for which the intent is required.
:type argument_types: list of str
:param intrinsic_type: optional intrinsic type of argument data.
:type intrinsic_type: str

:returns: dictionary containing 'intent' keys holding the kernel \
          arguments as values for each type of intent.
:rtype: dict of :py:class:`psyclone.psyGen.KernelArgument`

:raises InternalError: if at least one kernel argument type is \
                       not valid for the particular API.
:raises InternalError: if an invalid intrinsic type is specified.

Definition at line 572 of file psyGen.py.

    def unique_declns_by_intent(self, argument_types, intrinsic_type=None):
        '''
        Returns a dictionary listing all required declarations for each
        type of intent ('inout', 'out' and 'in').
 
        :param argument_types: the types of the kernel argument for the \
                               particular API for which the intent is required.
        :type argument_types: list of str
        :param intrinsic_type: optional intrinsic type of argument data.
        :type intrinsic_type: str
 
        :returns: dictionary containing 'intent' keys holding the kernel \
                  arguments as values for each type of intent.
        :rtype: dict of :py:class:`psyclone.psyGen.KernelArgument`
 
        :raises InternalError: if at least one kernel argument type is \
                               not valid for the particular API.
        :raises InternalError: if an invalid intrinsic type is specified.
 
        '''
        # First check for invalid argument types and intrinsic type
        const = Config.get().api_conf().get_constants()
        if any(argtype not in const.VALID_ARG_TYPE_NAMES for
               argtype in argument_types):
            raise InternalError(
                f"Invoke.unique_declns_by_intent() called with at least one "
                f"invalid argument type. Expected one of "
                f"{const.VALID_ARG_TYPE_NAMES} but found {argument_types}.")
 
        if (intrinsic_type and intrinsic_type not in
                const.VALID_INTRINSIC_TYPES):
            raise InternalError(
                f"Invoke.unique_declns_by_intent() called with an invalid "
                f"intrinsic argument data type. Expected one of "
                f"{const.VALID_INTRINSIC_TYPES} but found '{intrinsic_type}'.")
 
        # We will return a dictionary containing as many lists
        # as there are types of intent
        declns = {}
        for intent in FORTRAN_INTENT_NAMES:
            declns[intent] = []
 
        for arg in self.unique_declarations(argument_types,
                                            intrinsic_type=intrinsic_type):
            first_arg = self.first_access(arg.declaration_name)
            if first_arg.access in [AccessType.WRITE, AccessType.SUM]:
                # If the first access is a write then the intent is
                # out irrespective of any other accesses. Note,
                # sum_args behave as if they are write_args from the
                # PSy-layer's perspective.
                declns["out"].append(arg)
                continue
            # if all accesses are read, then the intent is in,
            # otherwise the intent is inout (as we have already
            # dealt with intent out).
            read_only = True
            for call in self.schedule.kernels():
                for tmp_arg in call.arguments.args:
                    if tmp_arg.text is not None and \
                       tmp_arg.declaration_name == arg.declaration_name:
                        if tmp_arg.access != AccessType.READ:
                            # readwrite_args behave in the
                            # same way as inc_args from the
                            # perspective of intents
                            read_only = False
                            break
                if not read_only:
                    break
            if read_only:
                declns["in"].append(arg)
            else:
                declns["inout"].append(arg)
        return declns
 

References psyclone.psyGen.Invoke.first_access(), psyclone.psyir.nodes.acc_directives.ACCDataDirective.gen_code(), psyclone.domain.lfric.lfric_invoke.LFRicInvoke.gen_code(), psyclone.domain.lfric.lfric_loop.LFRicLoop.gen_code(), psyclone.dynamo0p3.DynGlobalSum.gen_code(), psyclone.dynamo0p3.LFRicHaloExchange.gen_code(), psyclone.gocean1p0.GOInvokes.gen_code(), psyclone.gocean1p0.GOInvoke.gen_code(), psyclone.gocean1p0.GOLoop.gen_code(), psyclone.psyGen.Invokes.gen_code(), psyclone.psyGen.Invoke.gen_code(), psyclone.psyGen.InvokeSchedule.gen_code(), psyclone.psyGen.Kern.gen_code(), psyclone.psyir.nodes.acc_directives.ACCRoutineDirective.gen_code(), psyclone.psyir.nodes.acc_directives.ACCEnterDataDirective.gen_code(), psyclone.psyir.nodes.acc_directives.ACCParallelDirective.gen_code(), psyclone.psyir.nodes.acc_directives.ACCLoopDirective.gen_code(), psyclone.psyir.nodes.acc_directives.ACCKernelsDirective.gen_code(), psyclone.psyir.nodes.assignment.Assignment.gen_code(), psyclone.psyir.nodes.extract_node.ExtractNode.gen_code(), psyclone.psyir.nodes.loop.Loop.gen_code(), psyclone.psyir.nodes.omp_directives.OMPDeclareTargetDirective.gen_code(), psyclone.psyir.nodes.omp_directives.OMPTaskwaitDirective.gen_code(), psyclone.psyir.nodes.omp_directives.OMPSingleDirective.gen_code(), psyclone.psyir.nodes.omp_directives.OMPMasterDirective.gen_code(), psyclone.psyir.nodes.omp_directives.OMPParallelDirective.gen_code(), psyclone.psyir.nodes.omp_directives.OMPTaskloopDirective.gen_code(), psyclone.psyir.nodes.omp_directives.OMPDoDirective.gen_code(), psyclone.psyir.nodes.omp_directives.OMPParallelDoDirective.gen_code(), psyclone.psyir.nodes.schedule.Schedule.gen_code(), psyclone.psyir.nodes.psy_data_node.PSyDataNode.gen_code(), psyclone.psyGen.Invoke.schedule(), psyclone.psyir.nodes.omp_clauses.OMPScheduleClause.schedule, and psyclone.psyGen.Invoke.unique_declarations().

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