Section 3: library functions
PAPI_granularity_option_t – Synopsis Data Fields int def_cidx int eventset int granularity Detailed Description Field Documentation int PAPI_granularity_option_t::def_cidx this structure requires a component index to set default granularity Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_get_virt_usec – get virtual time counter values in microseconds Synopsis Detailed Description @retval PAPI_ECNFLCT If there is no master event set. This will happen if the library has not been initialized, or for threaded applications, if there has been no thread id function defined by the PAPI_thread_init function. @retval PAPI_ENOMEM For threaded applications, if there…
PAPI_get_virt_nsec – Get virtual time counter values in nanoseconds. Synopsis Detailed Description Return values: PAPI_ECNFLCT If there is no master event set. This will happen if the library has not been initialized, or for threaded applications, if there has been no thread id function defined by the PAPI_thread_init function. PAPI_ENOMEM For threaded applications, if there…
PAPI_get_virt_cyc – get virtual time counter value in clock cycles Synopsis Detailed Description @retval PAPI_ECNFLCT If there is no master event set. This will happen if the library has not been initialized, or for threaded applications, if there has been no thread id function defined by the PAPI_thread_init function. @retval PAPI_ENOMEM For threaded applications, if…
PAPI_get_thr_specific – Retrieve a pointer to a thread specific data structure. Synopsis Detailed Description @par Prototype: #include <papi.h> @n int PAPI_get_thr_specific( int tag, void **ptr ); @param tag An identifier, the value of which is either PAPI_USR1_TLS or PAPI_USR2_TLS. This identifier indicates which of several data structures associated with this thread is to be accessed….
PAPI_get_shared_lib_info – Get address info about the shared libraries used by the process. Synopsis Detailed Description In C, this function returns a pointer to a structure containing information about the shared library used by the program. There is no Fortran equivalent call. Note: This data will be incorporated into the PAPI_get_executable_info call in the future….
PAPI_get_real_usec – get real time counter value in microseconds Synopsis Detailed Description This function returns the total real time passed since some arbitrary starting point. The time is returned in microseconds. This call is equivalent to wall clock time. @par Examples: s = PAPI_get_real_cyc(); your_slow_code(); e = PAPI_get_real_cyc(); printf("Wallclock cycles: %lld ",e-s); * …
PAPI_get_real_nsec – Get real time counter value in nanoseconds. Synopsis Detailed Description This function returns the total real time passed since some arbitrary starting point. The time is returned in nanoseconds. This call is equivalent to wall clock time. See Also: PAPI_get_virt_usec PAPI_get_virt_cyc PAPI_library_init Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_get_real_cyc – get real time counter value in clock cycles Returns the total real time passed since some arbitrary starting point. The time is returned in clock cycles. This call is equivalent to wall clock time. Synopsis Detailed Description @par Examples: s = PAPI_get_real_cyc(); your_slow_code(); e = PAPI_get_real_cyc(); printf("Wallclock cycles: %lld ",e-s); * …
PAPI_get_overflow_event_index – converts an overflow vector into an array of indexes to overflowing events Synopsis Detailed Description @param EventSet an integer handle to a PAPI event set as created by PAPI_create_eventset @param overflow_vector a vector with bits set for each counter that overflowed. This vector is passed by the system to the overflow handler routine….
PAPI_get_opt – Get PAPI library or event set options. Synopsis Detailed Description C Interface: #include <papi.h> int PAPI_get_opt( int option, PAPI_option_t * ptr ); Parameters: option Defines the option to get. Possible values are briefly described in the table below. ptr Pointer to a structure determined by the selected option. See PAPI_option_t for a description of possible structures. Return values:…
PAPI_get_multiplex – Get the multiplexing status of specified event set. Synopsis Detailed Description C Interface: #include <papi.h> int PAPI_get_multiplex( int EventSet ); Fortran Interface: #include fpapi.h PAPIF_get_multiplex( C_INT EventSet, C_INT check ) Parameters: EventSet an integer handle for a PAPI event set as created by PAPI_create_eventset Return values: PAPI_OK PAPI_EINVAL One or more of the arguments is invalid, or the EventSet is already multiplexed….
PAPI_get_hardware_info – get information about the system hardware Synopsis Detailed Description In C, this function returns a pointer to a structure containing information about the hardware on which the program runs. In Fortran, the values of the structure are returned explicitly. @retval PAPI_EINVAL One or more of the arguments is invalid. @note The C structure…
PAPI_get_executable_info – Get the executable’s address space info. Synopsis Detailed Description @par C Interface: #include <papi.h> @n const PAPI_exe_info_t *PAPI_get_executable_info( void ); This function returns a pointer to a structure containing information about the current program. @param fullname Fully qualified path + filename of the executable. @param name Filename of the executable with no path…
PAPI_get_eventset_component – return index for component an eventset is assigned to Synopsis Detailed Description @retval PAPI_ENOEVST eventset does not exist @retval PAPI_ENOCMP component is invalid or does not exist @retval positive value valid component index @param EventSet EventSet for which we want to know the component index @par Examples: int cidx,eventcode; cidx = PAPI_get_eventset_component(eventset);…
PAPI_get_event_info – Get the event’s name and description info. Synopsis Detailed Description Parameters: EventCode event code (preset or native) info structure with the event information PAPI_event_info_t Return values: PAPI_EINVAL One or more of the arguments is invalid. PAPI_ENOTPRESET The PAPI preset mask was set, but the hardware event specified is not a valid PAPI preset….
PAPI_get_event_component – return component an event belongs to Synopsis Detailed Description @retval ENOCMP component does not exist @param EventCode EventCode for which we want to know the component index @par Examples: int cidx,eventcode; cidx = PAPI_get_event_component(eventcode); * PAPI_get_event_component() returns the component an event belongs to. See Also: PAPI_get_event_info Author Generated automatically by Doxygen for PAPI…
PAPI_get_dmem_info – Get information about the dynamic memory usage of the current program. Synopsis Detailed Description C Prototype: #include <papi.h> int PAPI_get_dmem_info( PAPI_dmem_info_t *dest ); Parameters: dest structure to be filled in PAPI_dmem_info_t Return values: PAPI_ECMP The funtion is not implemented for the current component. PAPI_EINVAL Any value in the structure or array may be undefined as indicated by…
PAPI_get_component_info – get information about a specific software component Synopsis Detailed Description @param cidx Component index This function returns a pointer to a structure containing detailed information about a specific software component in the PAPI library. This includes versioning information, preset and native event information, and more. For full details, see @ref PAPI_component_info_t. @par Examples:…
PAPI_get_component_index – returns the component index for the named component Synopsis Detailed Description @retval ENOCMP component does not exist @param name name of component to find index for @par Examples: int cidx; cidx = PAPI_get_component_index("cuda"); if (cidx==PAPI_OK) { printf("The CUDA component is cidx %d,cidx); } * PAPI_get_component_index() returns the component index of the named component….