PAPI  5.3.0.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
PAPI_get_overflow_event_index Class Reference

converts an overflow vector into an array of indexes to overflowing events More...

Detailed Description

@param EventSet
    an integer handle to a PAPI event set as created by PAPI_create_eventset
@param overflow_vector
    a vector with bits set for each counter that overflowed. 
    This vector is passed by the system to the overflow handler routine.
@param *array
    an array of indexes for events in EventSet. 
    No more than *number indexes will be stored into the array.
@param *number 
    On input the variable determines the size of the array. 
    On output the variable contains the number of indexes in the array. 

@retval PAPI_EINVAL 
    One or more of the arguments is invalid. This could occur if the overflow_vector is empty (zero), if the array or number pointers are NULL, if the value of number is less than one, or if the EventSet is empty.
@retval PAPI_ENOEVST
The EventSet specified does not exist.
@par Examples
void handler(int EventSet, void *address, long_long overflow_vector, void *context){
int Events[4], number, i;
int total = 0, retval;
printf("Overflow #%d\n Handler(%d) Overflow at %p! vector=0x%llx\n",
total, EventSet, address, overflow_vector);
total++;
number = 4;
retval = PAPI_get_overflow_event_index(EventSet,
overflow_vector, Events, &number);
if(retval == PAPI_OK)
for(i=0; i<number; i++) printf("Event index[%d] = %d", i, Events[i]);}
*
Bug:
This function may not return all overflowing events if used with software-driven overflow of multiple derived events. PAPI_get_overflow_event_index decomposes an overflow_vector into an event index array in which the first element corresponds to the least significant set bit in overflow_vector and so on. Based on overflow_vector, the user can only tell which physical counters overflowed. Using this function, the user can map overflowing counters to specific events in the event set. An array is used in this function to support the possibility of multiple simultaneous overflow events.
@see PAPI_overflow

The documentation for this class was generated from the following file: