Section 3: library functions
PAPI_get_cmp_opt – Get component specific PAPI options. Synopsis Detailed Description Parameters: option is an input parameter describing the course of action. Possible values are defined in papi.h and briefly described in the table below. The Fortran calls are implementations of specific options. ptr is a pointer to a structure that acts as both an input…
PAPI_flops – Simplified call to get Mflops/s (floating point operation rate), real and processor time. Synopsis Detailed Description C Interface: #include <papi.h> int PAPI_flops( float *rtime, float *ptime, long long *flpops, float *mflops ); Parameters: *rtime total realtime since the first call *ptime total process time since the first call *flpops total floating point operations…
PAPI_flips – Simplified call to get Mflips/s (floating point instruction rate), real and processor time. Synopsis Detailed Description C Interface: #include <papi.h> int PAPI_flips( float *rtime, float *ptime, long long *flpins, float *mflips ); Parameters: *rtime total realtime since the first call *ptime total process time since the first call *flpins total floating point instructions…
PAPI_exe_info_t – get the executable’s info Synopsis Data Fields char fullname [1024] PAPI_address_map_t address_info Field Documentation PAPI_address_map_t PAPI_exe_info_t::address_info executable’s address space info char PAPI_exe_info_t::fullname[1024] path + name Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_event_name_to_code – Convert a name to a numeric hardware event code. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_event_name_to_code( char * EventName, int * EventCode ); PAPI_event_name_to_code is used to translate an ASCII PAPI event name into an integer PAPI event code. @param *EventCode The numeric code for the event. @param *EventName…
PAPI_event_info_t – Synopsis Data Fields unsigned int event_code char symbol [1024] char short_descr [64] char long_descr [1024] int component_index char units [64] int location int data_type int value_type int timescope int update_type int update_freq unsigned int count unsigned int event_type char derived [64] char postfix [256] unsigned int code [12] char name [12][256] char note…
PAPI_event_code_to_name – Convert a numeric hardware event code to a name. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_event_code_to_name( int EventCode, char * EventName ); PAPI_event_code_to_name is used to translate a 32-bit integer PAPI event code into an ASCII PAPI event name. Either Preset event codes or Native event codes can be…
PAPI_epc – Simplified call to get arbitrary events per cycle, real and processor time. Synopsis Detailed Description C Interface: #include <papi.h> int PAPI_epc( int event, float *rtime, float *ptime, long long *ref, long long *core, long long *evt, float *epc ); Parameters: event event code to be measured (0 defaults to PAPI_TOT_INS) *rtime total realtime…
PAPI_enum_event – Enumerate PAPI preset or native events. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_enum_event( int * EventCode, int modifer ); Given a preset or native event code, PAPI_enum_event replaces the event code with the next available event in either the preset or native table. The modifier argument affects which events…
PAPI_enum_cmp_event – Enumerate PAPI preset or native events for a given component. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_enum_cmp_event( int *EventCode, int modifer, int cidx ); Given an event code, PAPI_enum_event replaces the event code with the next available event. The modifier argument affects which events are returned. For all platforms…
PAPI_domain_option_t – Synopsis Data Fields int def_cidx int eventset int domain Detailed Description Field Documentation int PAPI_domain_option_t::def_cidx this structure requires a component index to set default domains Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_dmem_info_t – A pointer to the following is passed to PAPI_get_dmem_info() Synopsis Data Fields long long peak long long size long long resident long long high_water_mark long long shared long long text long long library long long heap long long locked long long stack long long pagesize long long pte Author Generated automatically by Doxygen…
PAPI_disable_component_by_name – disables the named component Synopsis Detailed Description etval ENOCMP component does not exist etval ENOINIT unable to disable the component, the library has already been initialized aram component_name name of the component to disable. ar Example: int result; result = PAPI_disable_component_by_name("example"); if (result==PAPI_OK) printf("component //… PAPI_library_init(PAPI_VER_CURRENT); * PAPI_disable_component_by_name() allows the user to disable…
PAPI_disable_component – disables the specified component Synopsis Detailed Description @retval ENOCMP component does not exist @retval ENOINIT cannot disable as PAPI has already been initialized @param cidx component index of component to be disabled @par Examples: int cidx, result; cidx = PAPI_get_component_index("example"); if (cidx>=0) { result = PAPI_disable_component(cidx); if (result==PAPI_OK) printf("The example component is…
PAPI_detach – Detach PAPI event set from previously specified thread id and restore to executing thread. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_detach( int EventSet, unsigned long tid ); PAPI_detach is a wrapper function that calls PAPI_set_opt to allow PAPI to monitor performance counts on a thread other than the one…
PAPI_destroy_eventset – Empty and destroy an EventSet. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_destroy_eventset( int * EventSet ); PAPI_destroy_eventset deallocates the memory associated with an empty PAPI EventSet. Parameters: *EventSet A pointer to the integer handle for a PAPI event set as created by PAPI_create_eventset. The value pointed to by EventSet…
PAPI_debug_option_t – Synopsis Data Fields int level PAPI_debug_handler_t handler Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_create_eventset – Create a new empty PAPI EventSet. Synopsis Detailed Description @par C Interface: #include <papi.h> @n PAPI_create_eventset( int * EventSet ); PAPI_create_eventset creates a new EventSet pointed to by EventSet, which must be initialized to PAPI_NULL before calling this routine. The user may then add hardware events to the event set by calling PAPI_add_event…
PAPI_cpu_option_t – Synopsis Data Fields int eventset unsigned int cpu_num Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_component_info_t – Synopsis Data Fields char name [128] char short_name [64] char description [128] char version [64] char support_version [64] char kernel_version [64] char disabled_reason [128] int disabled int CmpIdx int num_cntrs int num_mpx_cntrs int num_preset_events int num_native_events int default_domain int available_domains int default_granularity int available_granularities int hardware_intr_sig int component_type int reserved [8] unsigned int…