PAPI3:PAPIF.3
From PAPIDocs
Jump to: navigation, search


Contents

NAME

  • PAPIF - Performance Application Programming Interface (Fortran)

Synopsis

#include fpapi.h call PAPIF_function_name( arg1,arg2,...,check )

Description

Fortran Calling Interface The PAPI library comes with a specific Fortran library interface. The Fortran interface covers the complete library with a few minor exceptions. Functions returning C pointers to structures, such as PAPI_get_opt(3) and PAPI_get_executable_info(3) , are either not implemented in the Fortran interface, or implemented with different calling semantics. Semantics for specific functions in the Fortran interface are documented on the equivalent C man page. For example, the semantics and functionality of PAPIF_accum are covered in the PAPI_accum(3) man page. For most architectures the following relation holds between the pseudo-types listed and Fortran variable types.

Pseuodo-type Fortran type Description
C_INT INTEGER Default Integer type
C_FLOAT REAL Default Real type
C_LONG_LONG INTEGER*8 Extended size integer
C_STRING CHARACTER*(PAPI_MAX_STR_LEN) Fortran string
C_INT FUNCTION EXTERNAL INTEGER FUNCTION Fortran function returning integer result
C_INT(*) Array of corresponding type C_TYPE(*) refers to an array of the corresponding Fortan type. The length of the array needed is context dependent. It may e.g. PAPI_MAX_HWCTRS or PAPIF_num_counters.
C_FLOAT(*) (same as above) (same as above)
C_LONG_LONG(*) (same as above) (same as above)

Array arguments must be of sufficient size to hold the input/output from/to the subroutine for predictable behavior. The array length is indicated either by the accompanying argument or by internal PAPI definitions. For details on this see the corresponding C routine. Subroutines accepting C_STRING as an argument are on most implementations capable of reading the character string length as provided by Fortran. In these implementations the string is truncated or space padded as necessary. For other implementations the length of the character array is assumed to be of sufficient size. No character string longer than PAPI_MAX_STR_LEN is returned by the PAPIF interface.

See Also

PAPI(3)