logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

PAPI_add_named_event - add PAPI preset or native hardware event by name to an EventSet

Author

       Generated automatically by Doxygen for PAPI from the source code.

Version 7.1.0.0                                  Thu Dec 14 2023                         PAPI_add_named_event(3)

Detailed Description

CInterface:
           #include <papi.h>
           int PAPI_add_named_event(intEventSet,constchar*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.

       ParametersEventSet An integer handle for a PAPI Event Set as created by PAPI_create_eventset.
           EventCode A defined event such as PAPI_TOT_INS.

       ReturnvaluesPositive-Integer The number of consecutive elements that succeeded before the error.
           PAPI_EINVAL One or more of the arguments is invalid.
           PAPI_ENOINIT The PAPI library has not been initialized.
           PAPI_ENOMEM Insufficient memory to complete the operation.
           PAPI_ENOEVST The event set specified does not exist.
           PAPI_EISRUN The event set is currently counting events.
           PAPI_ECNFLCT The underlying counter hardware can not count this event and other events in the event
           set simultaneously.
           PAPI_ENOEVNT The PAPI preset is not available on the underlying hardware.
           PAPI_EBUG Internal error, please send mail to the developers.
           PAPI_EMULPASS Event exists, but cannot be counted due to multiple passes required by hardware.

       Examples:

           char EventName = "PAPI_TOT_INS";
           int EventSet = PAPI_NULL;
           unsigned int native = 0x0;
           if ( PAPI_create_eventset( &EventSet ) != PAPI_OK )
           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 );

       SeealsoPAPI_add_eventPAPI_query_named_eventPAPI_remove_named_event

Name

       PAPI_add_named_event - add PAPI preset or native hardware event by name to an EventSet

Synopsis

See Also