papi_event_name_to_code(3) - Linux man page
Name
PAPI_event_code_to_name - convert a numeric hardware event code to a name. PAPI_event_name_to_code - convert a name to a numeric hardware event code.
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_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
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.
- PAPI_ENOEVNT
- The hardware event is not available on the underlying hardware.
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);