Section 3: library functions
PAPI_cleanup_eventset – Empty and destroy an EventSet. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_cleanup_eventset( int EventSet ); PAPI_cleanup_eventset removes all events from a PAPI event set and turns off profiling and overflow for all events in the EventSet. This can not be called if the EventSet is not stopped. Parameters: EventSet…
PAPI_attach_option_t – Synopsis Data Fields int eventset unsigned long tid Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_attach – Attach PAPI event set to the specified thread id. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_attach( int EventSet, unsigned long tid ); PAPI_attach is a wrapper function that calls PAPI_set_opt to allow PAPI to monitor performance counts on a thread other than the one currently executing. This is sometimes…
PAPI_assign_eventset_component – Assign a component index to an existing but empty EventSet. Synopsis Detailed Description @par C Interface: #include <papi.h> @n PAPI_assign_eventset_component( int EventSet, int cidx ); @param EventSet An integer identifier for an existing EventSet. @param cidx An integer identifier for a component. By convention, component 0 is always the cpu component. @retval PAPI_ENOCMP…
PAPI_all_thr_spec_t – Synopsis Data Fields int num PAPI_thread_id_t * id void ** data Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_address_map_t – get the executable’s address space info Synopsis Data Fields char name [1024] caddr_t text_start caddr_t text_end caddr_t data_start caddr_t data_end caddr_t bss_start caddr_t bss_end Field Documentation caddr_t PAPI_address_map_t::bss_end End address of program bss segment caddr_t PAPI_address_map_t::bss_start Start address of program bss segment caddr_t PAPI_address_map_t::data_end End address of program data segment caddr_t PAPI_address_map_t::data_start Start…
PAPI_addr_range_option_t – address range specification for range restricted counting if both are zero, range is disabled Synopsis Data Fields int eventset caddr_t start caddr_t end int start_off int end_off Field Documentation caddr_t PAPI_addr_range_option_t::end user requested end address of an address range int PAPI_addr_range_option_t::end_off hardware specified offset from end address int PAPI_addr_range_option_t::eventset eventset to restrict caddr_t…
PAPI_add_named_event – add PAPI preset or native hardware event by name to an EventSet Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_add_named_event( int EventSet, char *EventName ); PAPI_add_named_event adds one event to a PAPI EventSet. @n A hardware event can be either a PAPI preset or a native hardware event code. For…
PAPI_add_events – add multiple PAPI presets or native hardware events to an event set Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_add_events( int EventSet, int * EventCodes, int number ); PAPI_add_event adds one event to a PAPI Event Set. PAPI_add_events does the same, but for an array of events. @n A hardware…
PAPI_add_event – add PAPI preset or native hardware event to an event set Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_add_event( int EventSet, int EventCode ); PAPI_add_event adds one event to a PAPI Event Set. @n A hardware event can be either a PAPI preset or a native hardware event code. For…
PAPI_accum_counters – Accumulate and reset counters. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_accum_counters( long long *values, int array_len ); Parameters: *values an array to hold the counter values of the counting events arry_len the number of items in the *events array Precondition: These calls assume an initialized PAPI library and a…
PAPI_accum – Accumulate and reset counters in an EventSet. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_accum( int EventSet, long_long * values ); These calls assume an initialized PAPI library and a properly added event set. PAPI_accum adds the counters of the indicated event set into the array values. The counters are…
PAPIF_write – Write counter values into counters. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_write( C_INT EventSet, C_LONG_LONG(*) values, C_INT check ) See Also: PAPI_write Author Generated automatically by Doxygen for PAPI from the source code.
PAPIF_unregister_thread – Notify PAPI that a thread has ‘disappeared’. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_unregister_thread( C_INT check ) See Also: PAPI_unregister_thread Author Generated automatically by Doxygen for PAPI from the source code.
PAPIF_unlock – Unlock one of the mutex variables defined in papi.h. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_unlock( C_INT lock ) See Also: PAPI_unlock Author Generated automatically by Doxygen for PAPI from the source code.
PAPIF_thread_init – Initialize thread support in the PAPI library. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_thread_init( C_INT FUNCTION handle, C_INT check ) See Also: PAPI_thread_init Author Generated automatically by Doxygen for PAPI from the source code.
PAPIF_thread_id – Get the thread identifier of the current thread. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_thread_id( C_INT id ) See Also: PAPI_thread_id Author Generated automatically by Doxygen for PAPI from the source code.
PAPIF_stop_counters – Stop counting hardware events and reset values to zero. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_stop_counters( C_LONG_LONG(*) values, C_INT array_len, C_INT check ) See Also: PAPI_stop_counters Author Generated automatically by Doxygen for PAPI from the source code.
PAPIF_stop – Stop counting hardware events in an EventSet. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_stop( C_INT EventSet, C_LONG_LONG(*) values, C_INT check ) See Also: PAPI_stop Author Generated automatically by Doxygen for PAPI from the source code.
PAPIF_state – Return the counting state of an EventSet. Synopsis Detailed Description Fortran Interface: #include ‘fpapi.h’ PAPIF_state(C_INT EventSet, C_INT status, C_INT check ) See Also: PAPI_state Author Generated automatically by Doxygen for PAPI from the source code.