Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

papi_event_info_t(3) [centos man page]

PAPI_event_info_t(3)						       PAPI						      PAPI_event_info_t(3)

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 [1024] Field Documentation unsigned int PAPI_event_info_t::code[12] array of values that further describe the event: o presets: native event_code values o native:, register values(?) int PAPI_event_info_t::component_index component this event belongs to unsigned int PAPI_event_info_t::count number of terms (usually 1) in the code and name fields o presets: these are native events o native: these are unused int PAPI_event_info_t::data_type data type returned by PAPI char PAPI_event_info_t::derived[64] name of the derived type o presets: usually NOT_DERIVED o native: empty string unsigned int PAPI_event_info_t::event_code preset (0x8xxxxxxx) or native (0x4xxxxxxx) event code unsigned int PAPI_event_info_t::event_type event type or category for preset events only int PAPI_event_info_t::location location event applies to char PAPI_event_info_t::long_descr[1024] a longer description: typically a sentence for presets, possibly a paragraph from vendor docs for native events char PAPI_event_info_t::name[12][256] < names of code terms: - presets: native event names, o native: descriptive strings for each register value(?) char PAPI_event_info_t::note[1024] an optional developer note supplied with a preset event to delineate platform specific anomalies or restrictions char PAPI_event_info_t::postfix[256] string containing postfix operations; only defined for preset events of derived type DERIVED_POSTFIX char PAPI_event_info_t::short_descr[64] a short description suitable for use as a label char PAPI_event_info_t::symbol[1024] name of the event int PAPI_event_info_t::timescope from start, etc. char PAPI_event_info_t::units[64] units event is measured in int PAPI_event_info_t::update_freq how frequently event is updated int PAPI_event_info_t::update_type how event is updated int PAPI_event_info_t::value_type sum or absolute Author Generated automatically by Doxygen for PAPI from the source code. Version Tue Jun 17 2014 PAPI_event_info_t(3)

Check Out this Related Man Page

PAPI_add_event(3)						       PAPI							 PAPI_add_event(3)

PAPI_add_event - add PAPI preset or native hardware event to an event set SYNOPSIS
Detailed Description @par C Interface: 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 a list of PAPI preset events, see PAPI_presets or run the avail test case in the PAPI distribution. PAPI presets can be passed to PAPI_query_event to see if they exist on the underlying architecture. For a list of native events available on current platform, run the papi_native_avail utility in the PAPI distribution. For the encoding of native events, see PAPI_event_name_to_code to learn how to generate native code for the supported native event on the underlying architecture. @param EventSet An integer handle for a PAPI Event Set as created by PAPI_create_eventset. @param EventCode A defined event such as PAPI_TOT_INS. @retval Positive-Integer The number of consecutive elements that succeeded before the error. @retval PAPI_EINVAL One or more of the arguments is invalid. @retval PAPI_ENOMEM Insufficient memory to complete the operation. @retval PAPI_ENOEVST The event set specified does not exist. @retval PAPI_EISRUN The event set is currently counting events. @retval PAPI_ECNFLCT The underlying counter hardware can not count this event and other events in the event set simultaneously. @retval PAPI_ENOEVNT The PAPI preset is not available on the underlying hardware. @retval PAPI_EBUG Internal error, please send mail to the developers. @par Examples: * int EventSet = PAPI_NULL; * unsigned int native = 0x0; * if ( PAPI_create_eventset( &EventSet ) != PAPI_OK ) * handle_error( 1 ); * // Add Total Instructions Executed to our EventSet * if ( PAPI_add_event( EventSet, PAPI_TOT_INS ) != PAPI_OK ) * handle_error( 1 ); * // Add native event PM_CYC to EventSet * if ( PAPI_event_name_to_code( "PM_CYC", &native ) != PAPI_OK ) * handle_error( 1 ); * if ( PAPI_add_event( EventSet, native ) != PAPI_OK ) * handle_error( 1 ); * @see PAPI_cleanup_eventset @n PAPI_destroy_eventset @n PAPI_event_code_to_name @n PAPI_remove_events @n PAPI_query_event @n PAPI_presets @n PAPI_native @n Author Generated automatically by Doxygen for PAPI from the source code. Version Tue Jun 17 2014 PAPI_add_event(3)
Man Page