NAME

PAPI_read, PAPI_accum - read hardware events, accumulate and reset hardware events from an event set

CONTENTS

Synopsis
Description
Arguments
Return Values
Errors
Examples
Authors
Bugs
See Also

SYNOPSIS

C Interface

#include <papi.h> 

int PAPI_read(int EventSet, long_long *values); 

int PAPI_accum(int EventSet, long_long *values); 

Fortran Interface

#include fpapi.h 

PAPIF_read(C_INT EventSet, C_LONG_LONG(*) values, C_INT check) 

PAPIF_accum(C_INT EventSet, C_LONG_LONG(*) values, C_INT check) 

DESCRIPTION

PAPI_read() copies the counters of the indicated event set into the array values. The counters continue counting after the read.

PAPI_accum() adds the counters of the indicated event set into the array values. The counters are zeroed and continue counting after the operation. NOTE:

ARGUMENTS

EventSet -- an integer handle for a PAPI Event Set as created by PAPI_create_eventset (3)

*values -- an array to hold the counter values of the counting events

RETURN VALUES

On success, these functions return PAPI_OK.
On error, a non-zero error code is returned.

ERRORS

PAPI_EINVAL
  One or more of the arguments is invalid.
PAPI_ESYS
  A system or C library call failed inside PAPI, see the errno variable.
PAPI_ENOEVST
  The event set specified does not exist.

EXAMPLES


  int EventSet = PAPI_NULL;
  unsigned int native = 0x0;
  long_long values[1] = (long_long) 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_start(EventSet) != PAPI_OK) handle_error(1);

poorly_tuned_function();

if (PAPI_accum(EventSet, values) != PAPI_OK) handle_error(1);

printf("%lld\n",values[0]);

poorly_tuned_function();

if (PAPI_stop(EventSet, values) != PAPI_OK) handle_error(1);

printf("%lld\n",values[0]);

AUTHORS

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

BUGS

These functions have no known bugs.

SEE ALSO

PAPI_add_event (3), PAPI_reset (3), PAPI_set_opt (3), PAPI_remove_event (3), PAPI_cleanup_eventset (3), PAPI_destroy_eventset (3),


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

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