PAPI_shutdown – Finish using PAPI and free all related resources. SynopsisDetailed DescriptionC Prototype: #include <papi.h> void PAPI_shutdown( void ); PAPI_shutdown() is an exit function used by the PAPI Library to free resources and shut down when certain error conditions arise. It is not necessary for the user to call this function, but doing so allows the user to…
PAPI_shlib_info_t – SynopsisData FieldsPAPI_address_map_t * map int count Detailed DescriptionAuthorGenerated automatically by Doxygen for PAPI from the source code.
PAPI_set_thr_specific – Store a pointer to a thread specific data structure. SynopsisDetailed Description@par Prototype: #include <papi.h> @n int PAPI_set_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. @param ptr…
PAPI_set_opt – Set PAPI library or event set options. SynopsisDetailed DescriptionC Interface: #include <papi.h> int PAPI_set_opt( int option, PAPI_option_t * ptr ); Parameters: option Defines the option to be set. 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_OK…
PAPI_set_multiplex – Convert a standard event set to a multiplexed event set. SynopsisDetailed DescriptionC Interface: #include <papi.h> int PAPI_set_multiplex( int EventSet ); 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_ENOCMP — The EventSet…
PAPI_set_granularity – Set the default counting granularity for eventsets bound to the cpu component. SynopsisDetailed Description@par C Prototype: #include <papi.h> @n int PAPI_set_granularity( int granularity ); @param — granularity one of the following constants as defined in the papi.h header file @arg PAPI_GRN_THR — Count each individual thread @arg PAPI_GRN_PROC — Count each individual process…
PAPI_set_domain – Set the default counting domain for new event sets bound to the cpu component. SynopsisDetailed Description@par C Prototype: #include <papi.h> @n int PAPI_set_domain( int domain ); @param domain one of the following constants as defined in the papi.h header file @arg PAPI_DOM_USER User context counted @arg PAPI_DOM_KERNEL Kernel/OS context counted @arg PAPI_DOM_OTHER Exception/transient…
PAPI_set_debug – Set the current debug level for error output from PAPI. SynopsisDetailed DescriptionC Prototype: #include <papi.h> int PAPI_set_debug( int level ); Parameters: level one of the constants shown in the table below and defined in the papi.h header file. The possible debug levels for debugging are shown below. • PAPI_QUIET Do not print anything, just return the…
PAPI_set_cmp_granularity – Set the default counting granularity for eventsets bound to the specified component. SynopsisDetailed Description@par C Prototype: #include <papi.h> @n int PAPI_set_cmp_granularity( int granularity, int cidx ); @param granularity one of the following constants as defined in the papi.h header file @arg PAPI_GRN_THR Count each individual thread @arg PAPI_GRN_PROC Count each individual process @arg…
PAPI_set_cmp_domain – Set the default counting domain for new event sets bound to the specified component. SynopsisDetailed Description@par C Prototype: #include <papi.h> @n int PAPI_set_cmp_domain( int domain, int cidx ); @param domain one of the following constants as defined in the papi.h header file @arg PAPI_DOM_USER User context counted @arg PAPI_DOM_KERNEL Kernel/OS context counted @arg…
PAPI_reset – Reset the hardware event counts in an event set. SynopsisDetailed Description@par C Prototype: #include <papi.h> @n int PAPI_reset( int EventSet ); @param EventSet an integer handle for a PAPI event set as created by PAPI_create_eventset @retval PAPI_OK @retval PAPI_ESYS A system or C library call failed inside PAPI, see the errno variable. @retval…
PAPI_remove_named_event – removes a named hardware event from a PAPI event set. SynopsisDetailed DescriptionA hardware event can be either a PAPI Preset or a native hardware event code. For a list of PAPI preset events, see PAPI_presets or run the papi_avail utility in the PAPI distribution. PAPI Presets can be passed to PAPI_query_event to see…
PAPI_remove_events – Remove an array of hardware event codes from a PAPI event set. SynopsisDetailed DescriptionA hardware event can be either a PAPI Preset or a native hardware event code. For a list of PAPI preset events, see PAPI_presets or run the papi_avail utility in the PAPI distribution. PAPI Presets can be passed to PAPI_query_event…
PAPI_remove_event – removes a hardware event from a PAPI event set. SynopsisDetailed DescriptionA hardware event can be either a PAPI Preset or a native hardware event code. For a list of PAPI preset events, see PAPI_presets or run the papi_avail utility in the PAPI distribution. PAPI Presets can be passed to PAPI_query_event to see if…
PAPI_register_thread – Notify PAPI that a thread has ‘appeared’. SynopsisDetailed DescriptionC Interface: #include <papi.h> int PAPI_register_thread (void); PAPI_register_thread() should be called when the user wants to force PAPI to initialize a thread that PAPI has not seen before. Usually this is not necessary as PAPI implicitly detects the thread when an eventset is created or…
PAPI_read_ts – Read hardware counters with a timestamp. SynopsisDetailed DescriptionC Interface: #include <papi.h> int PAPI_read_ts(int EventSet, long long *values, long long *cycles ); PAPI_read_ts() copies the counters of the indicated event set into the provided array. It also places a real-time cycle timestamp into the cycles array. The counters continue counting after the read. PAPI_read_ts() assumes an initialized PAPI…
PAPI_read_counters – Read and reset counters. SynopsisDetailed Description@par C Interface: #include <papi.h> @n int PAPI_read_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 properly added event…
PAPI_read – Read hardware counters from an event set. SynopsisDetailed DescriptionC Interface: #include <papi.h> int PAPI_read(int EventSet, long_long * values ); PAPI_read() copies the counters of the indicated event set into the provided array. The counters continue counting after the read. Note the differences between PAPI_read() and PAPI_accum(), specifically that PAPI_accum() resets the values array to zero. PAPI_read() assumes an…
PAPI_query_named_event – Query if a named PAPI event exists. SynopsisDetailed DescriptionC Interface: #include <papi.h> int PAPI_query_named_event(char *EventName); PAPI_query_named_event() asks the PAPI library if the PAPI named event can be counted on this architecture. If the event CAN be counted, the function returns PAPI_OK. If the event CANNOT be counted, the function returns an error code. This function…
PAPI_query_event – Query if PAPI event exists. SynopsisDetailed DescriptionC Interface: #include <papi.h> int PAPI_query_event(int EventCode); PAPI_query_event() asks the PAPI library if the PAPI Preset event can be counted on this architecture. If the event CAN be counted, the function returns PAPI_OK. If the event CANNOT be counted, the function returns an error code. This function also…