NAME

PAPI_state - return the counting state of an EventSet

CONTENTS

Synopsis
Description
Arguements
Return Values
Errors
Examples
Authors
Bugs
See Also

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_STOPPEDEventSet is stopped
PAPI_RUNNINGEventSet is running
PAPI_PAUSEDEventSet temporarily disabled by the library
PAPI_NOT_INITEventSet defined, but not initialized
PAPI_OVERFLOWINGEventSet has overflowing enabled
PAPI_PROFILINGEventSet has profiling enabled
PAPI_MULTIPLEXINGEventSet has multiplexing enabled
PAPI_ACCUMULATINGreserved for future use
PAPI_HWPROFILINGreserved 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);

AUTHORS

The PAPI Team. See them at the PAPI Web Site: http://icl.cs.utk.edu/projects/papi

BUGS

This function has no known bugs.

SEE ALSO

PAPI_start (3), PAPI_stop (3)


PAPI Programmer’s Reference PAPI_state (3) November, 2003

  Innovative Computing Laboratory
2001 R&D Winner  
Contact PAPI: papi@cs.utk.edu Computer Science Department
  University of Tennessee