Section 3: library functions
PAPI_num_events – Return the number of events in an event set. Synopsis Detailed Description PAPI_num_events() returns the number of preset and/or native events contained in an event set. The event set should be created by PAPI_create_eventset . C Interface: #include <papi.h> int PAPI_num_events(int EventSet ); Parameters: EventSet — an integer handle for a PAPI event set created by…
PAPI_num_counters – Get the number of hardware counters available on the system. Synopsis Detailed Description @par C Interface: #include <papi.h> @n int PAPI_num_counters( void ); Postcondition: Initializes the library to PAPI_HIGH_LEVEL_INITED if necessary. Return values: PAPI_EINVAL papi.h is different from the version used to compile the PAPI library. PAPI_ENOMEM Insufficient memory to complete the operation….
PAPI_num_components – Get the number of components available on the system. Synopsis Detailed Description @return Number of components available on the system // Query the library for a component count. printf("%d components installed., PAPI_num_components() ); * Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_num_cmp_hwctrs – Return the number of hardware counters for the specified component. Synopsis Detailed Description PAPI_num_cmp_hwctrs() returns the number of counters present in the specified component. By convention, component 0 is always the cpu. On some components, especially for CPUs, the value returned is a theoretical maximum for estimation purposes only. It might not be…
PAPI_multiplex_option_t – Synopsis Data Fields int eventset int ns int flags Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_multiplex_init – Initialize multiplex support in the PAPI library. Synopsis Detailed Description PAPI_multiplex_init() enables and initializes multiplex support in the PAPI library. Multiplexing allows a user to count more events than total physical counters by time sharing the existing counters at some loss in precision. Applications that make no use of multiplexing do not need…
PAPI_mpx_info_t – Synopsis Data Fields int timer_sig int timer_num int timer_us Detailed Description Field Documentation int PAPI_mpx_info_t::timer_num Number of the itimer or POSIX 1 timer used by the multiplex timer: PAPI_ITIMER int PAPI_mpx_info_t::timer_sig Signal number used by the multiplex timer, 0 if not: PAPI_SIGNAL int PAPI_mpx_info_t::timer_us uS between switching of sets: PAPI_MPX_DEF_US Author Generated automatically…
PAPI_mh_tlb_info_t – Synopsis Data Fields int type int num_entries int page_size int associativity Detailed Description Field Documentation int PAPI_mh_tlb_info_t::type Empty, instr, data, vector, unified Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_mh_level_t – Synopsis Data Fields PAPI_mh_tlb_info_t tlb [6] PAPI_mh_cache_info_t cache [6] Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_mh_info_t – mh for mem hierarchy maybe? Synopsis Data Fields int levels PAPI_mh_level_t level [4] Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_mh_cache_info_t – Synopsis Data Fields int type int size int line_size int num_lines int associativity Detailed Description Field Documentation int PAPI_mh_cache_info_t::type Empty, instr, data, vector, trace, unified Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_lock – Lock one of two mutex variables defined in papi.h. Synopsis Detailed Description PAPI_lock() grabs access to one of the two PAPI mutex variables. This function is provided to the user to have a platform independent call to a (hopefully) efficiently implemented mutex. C Interface: #include <papi.h> void PAPI_lock(int lock); Parameters: lock — an…
PAPI_list_threads – List the registered thread ids. Synopsis Detailed Description PAPI_list_threads() returns to the caller a list of all thread IDs known to PAPI. This call assumes an initialized PAPI library. C Interface #include <papi.h> int PAPI_list_threads(PAPI_thread_id_t *tids, int * number ); Parameters: *tids — A pointer to a preallocated array. This may be NULL…
PAPI_list_events – list the events in an event set Synopsis Detailed Description List the events in an event set. PAPI_list_events() returns an array of events and a count of the total number of events in an event set. This call assumes an initialized PAPI library and a successfully created event set. C Interface #include <papi.h>…
PAPI_library_init – initialize the PAPI library. Synopsis Detailed Description @param version upon initialization, PAPI checks the argument against the internal value of PAPI_VER_CURRENT when the library was compiled. This guards against portability problems when updating the PAPI shared libraries on your system. @retval PAPI_EINVAL papi.h is different from the version used to compile the PAPI…
PAPI_itimer_option_t – Synopsis Data Fields int itimer_num int itimer_sig int ns int flags Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_is_initialized – check for initialization Synopsis Detailed Description @retval PAPI_NOT_INITED Library has not been initialized @retval PAPI_LOW_LEVEL_INITED Low level has called library init @retval PAPI_HIGH_LEVEL_INITED High level has called library init @retval PAPI_THREAD_LEVEL_INITED Threads have been inited @param version upon initialization, PAPI checks the argument against the internal value of PAPI_VER_CURRENT when the library was…
PAPI_ipc – Simplified call to get instructions per cycle, real and processor time. Synopsis Detailed Description C Interface: #include <papi.h> int PAPI_ipc( float *rtime, float *ptime, long long *ins, float *ipc ); Parameters: *rtime total realtime since the first call *ptime total process time since the first call *ins total instructions since the first call…
PAPI_inherit_option_t – Synopsis Data Fields int eventset int inherit Detailed Description Author Generated automatically by Doxygen for PAPI from the source code.
PAPI_hw_info_t – Hardware info structure. Synopsis Data Fields int ncpu int threads int cores int sockets int nnodes int totalcpus int vendor char vendor_string [128] int model char model_string [128] float revision int cpuid_family int cpuid_model int cpuid_stepping int cpu_max_mhz int cpu_min_mhz PAPI_mh_info_t mem_hierarchy int virtualized char virtual_vendor_string [128] char virtual_vendor_version [128] float mhz int…