PAPI 7.1.0.0
Loading...
Searching...
No Matches
PAPI_add_named_event Class Reference

add PAPI preset or native hardware event by name to an EventSet More...

Detailed Description

C Interface:
#include <papi.h>
int PAPI_add_named_event( int EventSet, const char *EventName );

PAPI_add_named_event adds one event to a PAPI EventSet.
A hardware event can be either a PAPI preset or a native hardware event code. For a list of PAPI preset events, see PAPI_presets or run the avail test case in the PAPI distribution. PAPI presets can be passed to PAPI_query_event to see if they exist on the underlying architecture. For a list of native events available on current platform, run the papi_native_avail utility in the PAPI distribution.

Parameters
EventSetAn integer handle for a PAPI Event Set as created by PAPI_create_eventset.
EventCodeA defined event such as PAPI_TOT_INS.
Return values
Positive-IntegerThe number of consecutive elements that succeeded before the error.
PAPI_EINVALOne or more of the arguments is invalid.
PAPI_ENOINITThe PAPI library has not been initialized.
PAPI_ENOMEMInsufficient memory to complete the operation.
PAPI_ENOEVSTThe event set specified does not exist.
PAPI_EISRUNThe event set is currently counting events.
PAPI_ECNFLCTThe underlying counter hardware can not count this event and other events in the event set simultaneously.
PAPI_ENOEVNTThe PAPI preset is not available on the underlying hardware.
PAPI_EBUGInternal error, please send mail to the developers.
PAPI_EMULPASSEvent exists, but cannot be counted due to multiple passes required by hardware.
Examples:
char EventName = "PAPI_TOT_INS";
unsigned int native = 0x0;
handle_error( 1 );
// Add Total Instructions Executed to our EventSet
if ( PAPI_add_named_event( EventSet, EventName ) != PAPI_OK )
handle_error( 1 );
// Add native event PM_CYC to EventSet
if ( PAPI_add_named_event( EventSet, "PM_CYC" ) != PAPI_OK )
handle_error( 1 );
add PAPI preset or native hardware event by name to an EventSet
Create a new empty PAPI EventSet.
#define PAPI_OK
Definition: f90papi.h:73
#define PAPI_NULL
Definition: f90papi.h:78
static int EventSet
Definition: init_fini.c:8
static int native
Bug:
The vector function should take a pointer to a length argument so a proper return value can be set upon partial success.
See also
PAPI_add_event
PAPI_query_named_event
PAPI_remove_named_event

The documentation for this class was generated from the following file: