Section 3: library functions
PAPI_set_domain – Set the default counting domain for new event sets bound to the cpu component. Synopsis Detailed 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_set_debug – Set the current debug level for error output from PAPI. Synopsis Detailed Description C 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…
PAPI_set_cmp_granularity – Set the default counting granularity for eventsets bound to the specified component. Synopsis Detailed 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…
PAPI_set_cmp_domain – Set the default counting domain for new event sets bound to the specified component. Synopsis Detailed 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…
PAPI_reset – Reset the hardware event counts in an event set. Synopsis Detailed 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…
PAPI_remove_named_event – removes a named hardware event from a PAPI event set. Synopsis Detailed Description A 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_events – Remove an array of hardware event codes from a PAPI event set. Synopsis Detailed Description A 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…
PAPI_remove_event – removes a hardware event from a PAPI event set. Synopsis Detailed Description A 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…
PAPI_register_thread – Notify PAPI that a thread has ‘appeared’. Synopsis Detailed Description C 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…
PAPI_read_ts – Read hardware counters with a timestamp. Synopsis Detailed Description C 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…
PAPI_read_counters – Read and reset counters. Synopsis Detailed 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…
PAPI_read – Read hardware counters from an event set. Synopsis Detailed Description C 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()…
PAPI_query_named_event – Query if a named PAPI event exists. Synopsis Detailed Description C 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….
PAPI_query_event – Query if PAPI event exists. Synopsis Detailed Description C 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…
PAPI_profil – Generate a histogram of hardware counter overflows vs. PC addresses. Synopsis Detailed Description C Interface: #include <papi.h> int PAPI_profil(void *buf, unsigned bufsiz, unsigned long offset, unsigned scale, int EventSet, int EventCode, int threshold, int flags ); Fortran Interface The profiling routines have no Fortran interface. Parameters: *buf — pointer to a buffer of bufsiz bytes in…
PAPI_preload_info_t – Synopsis Data Fields char lib_preload_env [128] char lib_preload_sep char lib_dir_env [128] char lib_dir_sep Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_perror – Produces a string on standard error, describing the last library error. Synopsis Detailed Description C Interface: #include <papi.h> void PAPI_perror( char *s ); Parameters: s — Optional message to print before the string describing the last error message. The routine PAPI_perror() produces a message on the standard error output, describing the last error encountered during a call…
PAPI_overflow – Set up an event set to begin registering overflows. Synopsis Detailed Description PAPI_overflow() marks a specific EventCode in an EventSet to generate an overflow signal after every threshold events are counted. More than one event in an event set can be used to trigger overflows. In such cases, the user must call this…
PAPI_option_t – A pointer to the following is passed to PAPI_set/get_opt() Synopsis Data Fields PAPI_preload_info_t preload PAPI_debug_option_t debug PAPI_inherit_option_t inherit PAPI_granularity_option_t granularity PAPI_granularity_option_t defgranularity PAPI_domain_option_t domain PAPI_domain_option_t defdomain PAPI_attach_option_t attach PAPI_cpu_option_t cpu PAPI_multiplex_option_t multiplex PAPI_itimer_option_t itimer PAPI_hw_info_t * hw_info PAPI_shlib_info_t * shlib_info PAPI_exe_info_t * exe_info PAPI_component_info_t * cmp_info PAPI_addr_range_option_t addr PAPI_user_defined_events_file_t events_file Author Generated automatically…
PAPI_num_hwctrs – Return the number of hardware counters on the cpu. Synopsis Detailed Description See Also: PAPI_num_cmp_hwctrs Author Generated automatically by Doxygen for PAPI from the source code.