|
Packit |
577717 |
.TH "PAPI_enum_event" 3 "Mon Dec 18 2017" "Version 5.6.0.0" "PAPI" \" -*- nroff -*-
|
|
Packit |
577717 |
.ad l
|
|
Packit |
577717 |
.nh
|
|
Packit |
577717 |
.SH NAME
|
|
Packit |
577717 |
PAPI_enum_event \-
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
Enumerate PAPI preset or native events\&.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.SH SYNOPSIS
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.SH "Detailed Description"
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.nf
|
|
Packit |
577717 |
@par C Interface:
|
|
Packit |
577717 |
\#include <papi.h> @n
|
|
Packit |
577717 |
int PAPI_enum_event( int * EventCode, int modifer );
|
|
Packit |
577717 |
|
|
Packit |
577717 |
Given a preset or native event code, PAPI_enum_event replaces the event
|
|
Packit |
577717 |
code with the next available event in either the preset or native table.
|
|
Packit |
577717 |
The modifier argument affects which events are returned.
|
|
Packit |
577717 |
For all platforms and event types, a value of PAPI_ENUM_ALL (zero)
|
|
Packit |
577717 |
directs the function to return all possible events. @n
|
|
Packit |
577717 |
|
|
Packit |
577717 |
For preset events, a TRUE (non-zero) value currently directs the function
|
|
Packit |
577717 |
to return event codes only for PAPI preset events available on this platform.
|
|
Packit |
577717 |
This may change in the future.
|
|
Packit |
577717 |
For native events, the effect of the modifier argument is different on each platform.
|
|
Packit |
577717 |
See the discussion below for platform-specific definitions.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
@param *EventCode
|
|
Packit |
577717 |
A defined preset or native event such as PAPI_TOT_INS.
|
|
Packit |
577717 |
@param modifier
|
|
Packit |
577717 |
Modifies the search logic. See below for full list.
|
|
Packit |
577717 |
For native events, each platform behaves differently.
|
|
Packit |
577717 |
See platform-specific documentation for details.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
@retval PAPI_ENOEVNT
|
|
Packit |
577717 |
The next requested PAPI preset or native event is not available on
|
|
Packit |
577717 |
the underlying hardware.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
@par Examples:
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.fi
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.nf
|
|
Packit |
577717 |
* // Scan for all supported native events on this platform
|
|
Packit |
577717 |
* printf( "Name\t\t\t Code\t Description\n" );
|
|
Packit |
577717 |
* do {
|
|
Packit |
577717 |
* retval = PAPI_get_event_info( i, &info );
|
|
Packit |
577717 |
* if ( retval == PAPI_OK ) {
|
|
Packit |
577717 |
* printf( "%-30s %#-10x\n%s\n", info\&.symbol, info\&.event_code, info\&.long_descr );
|
|
Packit |
577717 |
* }
|
|
Packit |
577717 |
* } while ( PAPI_enum_event( &i, PAPI_ENUM_ALL ) == PAPI_OK );
|
|
Packit |
577717 |
*
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.fi
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBGeneric Modifiers\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
The following values are implemented for preset events
|
|
Packit |
577717 |
.PD 0
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_ENUM_EVENTS -- Enumerate all (default)
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_ENUM_FIRST -- Enumerate first event (preset or native) preset/native chosen based on type of EventCode
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBNative Modifiers\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
The following values are implemented for native events
|
|
Packit |
577717 |
.PD 0
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_UMASKS -- Given an event, iterate through possible umasks one at a time
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_UMASK_COMBOS -- Given an event, iterate through all possible combinations of umasks\&. This is not implemented on libpfm4\&.
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPreset Modifiers\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
The following values are implemented for preset events
|
|
Packit |
577717 |
.PD 0
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_AVAIL -- enumerate only available presets
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_MSC -- Miscellaneous preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_INS -- Instruction related preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_IDL -- Stalled or Idle preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_BR -- Branch related preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_CND -- Conditional preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_MEM -- Memory related preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_CACH -- Cache related preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_L1 -- L1 cache related preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_L2 -- L2 cache related preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_L3 -- L3 cache related preset events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_TLB -- Translation Lookaside Buffer events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_PRESET_ENUM_FP -- Floating Point related preset events
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBITANIUM Modifiers\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
The following values are implemented for modifier on Itanium:
|
|
Packit |
577717 |
.PD 0
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_IARR - Enumerate IAR (instruction address ranging) events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_DARR - Enumerate DAR (data address ranging) events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_OPCM - Enumerate OPC (opcode matching) events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_IEAR - Enumerate IEAR (instr event address register) events
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_DEAR - Enumerate DEAR (data event address register) events
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPOWER Modifiers\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
The following values are implemented for POWER
|
|
Packit |
577717 |
.PD 0
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.IP "\(bu" 2
|
|
Packit |
577717 |
PAPI_NTV_ENUM_GROUPS - Enumerate groups to which an event belongs
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBSee Also:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
PAPI
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
PAPIF
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fBPAPI_enum_cmp_event\fP
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fBPAPI_get_event_info\fP
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
\fBPAPI_event_name_to_code\fP
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
PAPI_preset
|
|
Packit |
577717 |
.br
|
|
Packit |
577717 |
PAPI_native
|
|
Packit |
577717 |
.RE
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.SH "Author"
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
Generated automatically by Doxygen for PAPI from the source code\&.
|