PAPI_state

Langue: en

Version: September, 2004 (fedora - 01/12/10)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

PAPI_state - return the counting state of an EventSet

SYNOPSIS

C Interface 
 #include <papi.h>
 int PAPI_state (int EventSet, int *status);
Fortran Interface 
 #include fpapi.h
 PAPIF_state(C_INT EventSet, C_INT status, C_INT check)

DESCRIPTION

PAPI_state() returns the counting state of the specified event set.

ARGUEMENTS

EventSet -- an integer handle for a PAPI event set as created by PAPI_create_eventset(3)

status -- an integer containing a boolean combination of one or more of the following nonzero constants as defined in the PAPI header file papi.h:

PAPI_STOPPED EventSet is stopped
PAPI_RUNNING EventSet is running
PAPI_PAUSED EventSet temporarily disabled by the library
PAPI_NOT_INIT EventSet defined, but not initialized
PAPI_OVERFLOWING EventSet has overflowing enabled
PAPI_PROFILING EventSet has profiling enabled
PAPI_MULTIPLEXING EventSet has multiplexing enabled
PAPI_ACCUMULATING reserved for future use
PAPI_HWPROFILING reserved for future use

RETURN VALUES

On success, this function returns PAPI_OK.
 On error, a non-zero error code is returned.

ERRORS

PAPI_EINVAL
One or more of the arguments is invalid.
PAPI_ENOEVST
The EventSet specified does not exist.

EXAMPLES

 int EventSet = PAPI_NULL;
 int status = 0;  
 
 if (PAPI_create_eventset(&EventSet) != PAPI_OK)
   handle_error(1);
 
 /* Add Total Instructions Executed to our EventSet */
 
 if (PAPI_add_event(EventSet, PAPI_TOT_INS) != PAPI_OK)
   handle_error(1);
 
 /* Start counting */
 
 if (PAPI_state(EventSet, &status) != PAPI_OK)
   handle_error(1);
 
 printf("State is now %d\n",status);
 
 if (PAPI_start(EventSet) != PAPI_OK)
   handle_error(1);
 
 if (PAPI_state(EventSet, &status) != PAPI_OK)
   handle_error(1);
 
 printf("State is now %d\n",status);

BUGS

This function has no known bugs.

SEE ALSO

PAPI_start(3), PAPI_stop(3)