PAPI_event_info_t(3) PAPI PAPI_event_info_t(3)NAME
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 5.2.0.0 Tue Jun 17 2014 PAPI_event_info_t(3)
Check Out this Related Man Page
PAPI_enum_event(3) PAPI PAPI_enum_event(3)NAME
PAPI_enum_event -
Enumerate PAPI preset or native events.
SYNOPSIS Detailed Description
@par C Interface:
int PAPI_enum_event( int * EventCode, int modifer );
Given a preset or native event code, PAPI_enum_event replaces the event
code with the next available event in either the preset or native table.
The modifier argument affects which events are returned.
For all platforms and event types, a value of PAPI_ENUM_ALL (zero)
directs the function to return all possible events. @n
For preset events, a TRUE (non-zero) value currently directs the function
to return event codes only for PAPI preset events available on this platform.
This may change in the future.
For native events, the effect of the modifier argument is different on each platform.
See the discussion below for platform-specific definitions.
@param *EventCode
A defined preset or native event such as PAPI_TOT_INS.
@param modifier
Modifies the search logic. See below for full list.
For native events, each platform behaves differently.
See platform-specific documentation for details.
@retval PAPI_ENOEVNT
The next requested PAPI preset or native event is not available on
the underlying hardware.
@par Examples:
* // Scan for all supported native events on this platform
* printf( "Name Code Description0 );
* do {
* retval = PAPI_get_event_info( i, &info );
* if ( retval == PAPI_OK ) {
* printf( "%-30s 0x%-10x1s0, info.symbol, info.event_code, info.long_descr );
* }
* } while ( PAPI_enum_event( &i, PAPI_ENUM_ALL ) == PAPI_OK );
*
Generic Modifiers
The following values are implemented for preset events
o PAPI_ENUM_EVENTS -- Enumerate all (default)
o PAPI_ENUM_FIRST -- Enumerate first event (preset or native) preset/native chosen based on type of EventCode
Native Modifiers
The following values are implemented for native events
o PAPI_NTV_ENUM_UMASKS -- Given an event, iterate through possible umasks one at a time
o PAPI_NTV_ENUM_UMASK_COMBOS -- Given an event, iterate through all possible combinations of umasks. This is not implemented on
libpfm4.
Preset Modifiers
The following values are implemented for preset events
o PAPI_PRESET_ENUM_AVAIL -- enumerate only available presets
o PAPI_PRESET_ENUM_MSC -- Miscellaneous preset events
o PAPI_PRESET_ENUM_INS -- Instruction related preset events
o PAPI_PRESET_ENUM_IDL -- Stalled or Idle preset events
o PAPI_PRESET_ENUM_BR -- Branch related preset events
o PAPI_PRESET_ENUM_CND -- Conditional preset events
o PAPI_PRESET_ENUM_MEM -- Memory related preset events
o PAPI_PRESET_ENUM_CACH -- Cache related preset events
o PAPI_PRESET_ENUM_L1 -- L1 cache related preset events
o PAPI_PRESET_ENUM_L2 -- L2 cache related preset events
o PAPI_PRESET_ENUM_L3 -- L3 cache related preset events
o PAPI_PRESET_ENUM_TLB -- Translation Lookaside Buffer events
o PAPI_PRESET_ENUM_FP -- Floating Point related preset events
ITANIUM Modifiers
The following values are implemented for modifier on Itanium:
o PAPI_NTV_ENUM_IARR - Enumerate IAR (instruction address ranging) events
o PAPI_NTV_ENUM_DARR - Enumerate DAR (data address ranging) events
o PAPI_NTV_ENUM_OPCM - Enumerate OPC (opcode matching) events
o PAPI_NTV_ENUM_IEAR - Enumerate IEAR (instr event address register) events
o PAPI_NTV_ENUM_DEAR - Enumerate DEAR (data event address register) events
POWER Modifiers
The following values are implemented for POWER
o PAPI_NTV_ENUM_GROUPS - Enumerate groups to which an event belongs
See Also:
PAPI
PAPIF
PAPI_enum_cmp_event
PAPI_get_event_info
PAPI_event_name_to_code
PAPI_preset
PAPI_native
Author
Generated automatically by Doxygen for PAPI from the source code.
Version 5.2.0.0 Tue Jun 17 2014 PAPI_enum_event(3)