NAME
PAPI_event_code_to_name, PAPI_event_name_to_code - convert a numeric hardware event code to a name, or vice versa.
CONTENTS
Synopsis
Description
Arguments
Return Values
Errors
Examples
Authors
Bugs
See Also
SYNOPSIS
C Interface
#include <papi.h>
int PAPI_event_code_to_name(int EventCode, char *EventName);
int PAPI_event_name_to_code(char *EventName, int *EventCode);
Fortran Interface
#include fpapi.h
PAPIF_event_code_to_name(C_INT EventCode, C_STRING EventName, C_INT check)
PAPIF_event_name_to_code(C_STRING EventName, C_INT EventCode, C_INT check)
DESCRIPTION
PAPI_event_code_to_name() is used to translate a 32-bit integer PAPI event code into an ASCII PAPI event name.
Either Preset event codes or Native event codes can be passed to this routine.
Native event codes and names differ from platform to platform.
PAPI_event_name_to_code() is used to translate an ASCII PAPI event name into an integer PAPI event code.
ARGUMENTS
EventName -- a string containing the event name as listed in
PAPI_presets (3)
or discussed in
PAPI_native (3)
EventCode -- the numeric code for the event
*
* Check the return values and example code.
*
RETURN VALUES
On success, these functions return
PAPI_OK.
On error, a non-zero error code is returned.
ERRORS
PAPI_EINVAL | |
One or more of the arguments is invalid.
|
PAPI_ENOTPRESET | |
The hardware event specified is not a valid PAPI preset.
|
|
EXAMPLES
int EventCode, EventSet = PAPI_NULL;
char EventCodeStr[PAPI_MAX_STR_LEN];
char EventDescr[PAPI_MAX_STR_LEN];
char EventLabel[20];
/* Convert to integer */
if (PAPI_event_name_to_code("PAPI_TOT_INS",&EventCode) != PAPI_OK)
handle_error(1);
/* Create the EventSet */
if (PAPI_create_eventset(&EventSet) != PAPI_OK)
handle_error(1);
/* Add Total Instructions Executed to our EventSet */
if (PAPI_add_event(EventSet, EventCode) != PAPI_OK)
handle_error(1);
AUTHORS
The PAPI Team. See them at the PAPI Web Site:
http://icl.cs.utk.edu/projects/papi
BUGS
These functions have no known bugs.
SEE ALSO
PAPI_presets (3),
PAPI_native (3),
PAPI_enum_events (3),
PAPI_add_event (3),
PAPI_set_opt (3),
PAPI_get_event_info (3)
PAPI Programmers Reference | PAPI_event_code_to_name (3) | November, 2003 |
|
|