lapi_subroutines Information

Purpose

Provides overview information about the subroutines that constitute the low-level application programming interface (LAPI).

Library

Availability Library (liblapi_r.a)

C Syntax

#include <lapi.h>
 
int lapi_subroutines(parm1, parm2...)
type1 parm1;
type2 parm2;
⋮

FORTRAN Syntax

include 'lapif.h'

LAPI_SUBROUTINES(parm1, parm2..., ierror)
TYPE1 :: parm1;
TYPE2 :: parm2;
⋮
INTEGER ierror

Description

LAPI subroutines provide a wide variety of functions that can be used efficiently and flexibly to obtain most behaviors required from any parallel programming API.

Programming with C++

LAPI subroutines provide extern "C" declarations for C++ programming.

Profiling

LAPI's profiling interface includes wrappers for each LAPI function, so you can collect data about each of the LAPI calls. See the RSCT for AIX 5L™: LAPI Programming Guide for more information.

Querying runtime values

You can find out the size (or size range) of certain parameters by calling the LAPI_Qenv subroutine with the appropriate query type. For example, call LAPI_Qenv with the LOC_ADDRTBL_SZ query type to find out the size of the address table used by the LAPI_Addr_set subroutine:

LAPI_Qenv(hndl, LOC_ADDRTBL_SZ, ret_val)

Now, if you want to register a function address using LAPI_Addr_set:

LAPI_Addr_set (hndl, addr, addr_hndl)

The value of index addr_hndl must be in the range:

1 <= addr_hndl < LOC_ADDRTBL_SZ

When used to show the size of a parameter, a comparison of values, or a range of values, valid values for the query parameter of the LAPI_Qenv subroutine appear in SMALL, BOLD capital letters. For example:

 
NUM_TASKS
 

is a shorthand notation for:

 
LAPI_Qenv(hndl, NUM_TASKS, ret_val)
 

See LAPI_Qenv subroutine for a list of the query parameter's valid values.

Parameters

Parameter definitions are listed as follows:
INPUT
parm1
Describes parm1.
INPUT/OUTPUT
This section includes all LAPI counters.
parm2
Describes parm2.
OUTPUT
Function calls are nonblocking, so counter behavior is asynchronous with respect to the function call.
ierror
Specifies a FORTRAN return code. This is always the last parameter.

Return Values

LAPI_SUCCESS
Indicates that the function call completed successfully.

Any other return values for the subroutine appear here.

For a complete list, see the RSCT for AIX 5L: LAPI Programming Guide.

For information about LAPI error messages, see RSCT: Messages.

Restrictions

Any specific restrictions for the subroutine appear here.

Also, see the RSCT for AIX 5L: LAPI Programming Guide for more information.

C Examples

Any C examples of the subroutine appear here.

FORTRAN Examples

Any FORTRAN examples of the subroutine appear here.