papi_query_event(3) - Linux man page

Name

PAPI_query_event - query if PAPI event exists

Synopsis

C Interface
#include <papi.h>int PAPI_query_event(int EventCode);
Fortran Interface
#include "fpapi.h"PAPIF_query_event(C_INT EventCode, C_INT check)

Description

PAPI_query_event() asks the PAPI library if the PAPI Preset event can be counted on this architecture. If the event CAN be counted, the function returns PAPI_OK. If the event CANNOT be counted, the function returns an error code. This function also can be used to check the syntax of a native event.

Arguments

EventCode -- a defined event such as PAPI_TOT_INS.

Return Values

On success, PAPI_query_event returns 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 PAPI preset is not available on the underlying hardware.

Examples

int retval;
/* Initialize the library */
retval = PAPI_library_init(PAPI_VER_CURRENT);
if (retval != PAPI_VER_CURRENT) {
  fprintf(stderr,"PAPI library init error!\n");
  exit(1); }
   
if (PAPI_query_event(PAPI_TOT_INS) != PAPI_OK) {
  fprintf(stderr,"No instruction counter? How lame.\n");
  exit(1);
  }

Bugs

These functions have no known bugs.

See Also

PAPI_preset(3), papi_native(3), papi_remove_event(3), papi_remove_events(3),

Referenced By

papi_add_event(3)