|
Packit |
577717 |
.TH "PAPI_event_code_to_name" 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_event_code_to_name \-
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
Convert a numeric hardware event code to a name\&.
|
|
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_event_code_to_name( int EventCode, char * EventName );
|
|
Packit |
577717 |
|
|
Packit |
577717 |
PAPI_event_code_to_name is used to translate a 32-bit integer PAPI event
|
|
Packit |
577717 |
code into an ASCII PAPI event name.
|
|
Packit |
577717 |
Either Preset event codes or Native event codes can be passed to this routine.
|
|
Packit |
577717 |
Native event codes and names differ from platform to platform.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
@param EventCode
|
|
Packit |
577717 |
The numeric code for the event.
|
|
Packit |
577717 |
@param *EventName
|
|
Packit |
577717 |
A string containing the event name as listed in PAPI_presets or discussed in PAPI_native.
|
|
Packit |
577717 |
|
|
Packit |
577717 |
@retval PAPI_EINVAL
|
|
Packit |
577717 |
One or more of the arguments is invalid.
|
|
Packit |
577717 |
@retval PAPI_ENOTPRESET
|
|
Packit |
577717 |
The hardware event specified is not a valid PAPI preset.
|
|
Packit |
577717 |
@retval PAPI_ENOEVNT
|
|
Packit |
577717 |
The hardware event is not available on 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 |
* int EventCode, EventSet = PAPI_NULL;
|
|
Packit |
577717 |
* int Event, number;
|
|
Packit |
577717 |
* char EventCodeStr[PAPI_MAX_STR_LEN];
|
|
Packit |
577717 |
* // Create the EventSet
|
|
Packit |
577717 |
* if ( PAPI_create_eventset( &EventSet ) != PAPI_OK )
|
|
Packit |
577717 |
* handle_error( 1 );
|
|
Packit |
577717 |
* // Add Total Instructions Executed to our EventSet
|
|
Packit |
577717 |
* if ( PAPI_add_event( EventSet, PAPI_TOT_INS ) != PAPI_OK )
|
|
Packit |
577717 |
* handle_error( 1 );
|
|
Packit |
577717 |
* number = 1;
|
|
Packit |
577717 |
* if ( PAPI_list_events( EventSet, &Event, &number ) != PAPI_OK )
|
|
Packit |
577717 |
* handle_error(1);
|
|
Packit |
577717 |
* // Convert integer code to name string
|
|
Packit |
577717 |
* if ( PAPI_event_code_to_name( Event, EventCodeStr ) != PAPI_OK )
|
|
Packit |
577717 |
* handle_error( 1 );
|
|
Packit |
577717 |
* printf( "Event Name: %s\n", EventCodeStr );
|
|
Packit |
577717 |
*
|
|
Packit |
577717 |
|
|
Packit |
577717 |
.fi
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBSee Also:\fP
|
|
Packit |
577717 |
.RS 4
|
|
Packit |
577717 |
\fBPAPI_event_name_to_code\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_remove_event\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_get_event_info\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_enum_event\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
\fBPAPI_add_event\fP
|
|
Packit |
577717 |
.PP
|
|
Packit |
577717 |
PAPI_presets
|
|
Packit |
577717 |
.PP
|
|
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\&.
|